sqlite3.h revision ebc6b24ff37b903195b37f143a5791c9f02be8df
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/* 467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Add the ability to override 'extern' 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 517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 52a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#ifndef SQLITE_API 53a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori# define SQLITE_API 54a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#endif 55a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 56a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 58a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These no-op macros are used in front of interfaces to mark those 59a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces as either deprecated or experimental. New applications 60a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** should not use deprecated interfaces - they are support for backwards 61a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** compatibility only. Application writers should be aware that 62a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** experimental interfaces are subject to change in point releases. 63a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 64a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These macros used to resolve to various kinds of compiler magic that 65a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** would generate warning messages when they were used. But that 66a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** compiler magic ended up generating such a flurry of bug reports 67a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that we have taken it all out and gone back to using simple 68a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** noop macros. 69a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 70a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_DEPRECATED 71a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_EXPERIMENTAL 72a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 73a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 74a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Ensure these symbols were not defined by some previous header file. 757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#ifdef SQLITE_VERSION 777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project# undef SQLITE_VERSION 787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#endif 797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#ifdef SQLITE_VERSION_NUMBER 807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project# undef SQLITE_VERSION_NUMBER 817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#endif 827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 84a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Compile-Time Library Version Numbers 85a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 86a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header 87a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** evaluates to a string literal that is the SQLite version in the 88a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** format "X.Y.Z" where X is the major version number (always 3 for 89a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite3) and Y is the minor version number and Z is the release number.)^ 90a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer 91a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z are the same 92a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** numbers used in [SQLITE_VERSION].)^ 93a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The SQLITE_VERSION_NUMBER for any given release of SQLite will also 94a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** be larger than the release from which it is derived. Either Y will 95a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** be held constant and Z will be incremented or else Y will be incremented 96a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and Z will be reset to zero. 97a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 98a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Since version 3.6.18, SQLite source code has been stored in the 99a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <a href="http://www.fossil-scm.org/">Fossil configuration management 100a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** system</a>. ^The SQLITE_SOURCE_ID macro evalutes to 101a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a string which identifies a particular check-in of SQLite 102a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** within its configuration management system. ^The SQLITE_SOURCE_ID 103a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** string contains the date and time of the check-in (UTC) and an SHA1 104a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** hash of the entire source tree. 105a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 106a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also: [sqlite3_libversion()], 107a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_libversion_number()], [sqlite3_sourceid()], 108a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite_version()] and [sqlite_source_id()]. 1097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 11071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_VERSION "3.7.0" 11171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_VERSION_NUMBER 3007000 112ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori#define SQLITE_SOURCE_ID "2010-07-07 14:45:41 8eefc287265443ec043bdab629597e79c9d22006" 1137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 1147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 115a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Run-Time Library Version Numbers 11671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** KEYWORDS: sqlite3_version, sqlite3_sourceid 1177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 118a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These interfaces provide the same information as the [SQLITE_VERSION], 119a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros 120a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** but are associated with the library instead of the header file. ^(Cautious 121a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** programmers might include assert() statements in their application to 122a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** verify that values returned by these interfaces match the macros in 123a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the header, and thus insure that the application is 124a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** compiled with matching library and header files. 1257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 126a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <blockquote><pre> 127a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER ); 128a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** assert( strcmp(sqlite3_sourceid(),SQLITE_SOURCE_ID)==0 ); 129a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 ); 130a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </pre></blockquote>)^ 131a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 132a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION] 133a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** macro. ^The sqlite3_libversion() function returns a pointer to the 134a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the sqlite3_version[] string constant. The sqlite3_libversion() 135a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function is provided for use in DLLs since DLL users usually do not have 136a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** direct access to string constants within the DLL. ^The 137a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_libversion_number() function returns an integer equal to 13871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [SQLITE_VERSION_NUMBER]. ^The sqlite3_sourceid() function returns 13971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** a pointer to a string constant whose value is the same as the 14071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [SQLITE_SOURCE_ID] C preprocessor macro. 141a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 142a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also: [sqlite_version()] and [sqlite_source_id()]. 1437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 144a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API SQLITE_EXTERN const char sqlite3_version[]; 145a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const char *sqlite3_libversion(void); 146a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const char *sqlite3_sourceid(void); 147a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_libversion_number(void); 1487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 1497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 15071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** CAPI3REF: Run-Time Library Compilation Options Diagnostics 15171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 15271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The sqlite3_compileoption_used() function returns 0 or 1 15371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** indicating whether the specified option was defined at 15471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** compile time. ^The SQLITE_ prefix may be omitted from the 15571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** option name passed to sqlite3_compileoption_used(). 15671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 15771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The sqlite3_compileoption_get() function allows interating 15871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** over the list of options that were defined at compile time by 15971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** returning the N-th compile time option string. ^If N is out of range, 16071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** sqlite3_compileoption_get() returns a NULL pointer. ^The SQLITE_ 16171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** prefix is omitted from any strings returned by 16271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** sqlite3_compileoption_get(). 16371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 16471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^Support for the diagnostic functions sqlite3_compileoption_used() 16571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** and sqlite3_compileoption_get() may be omitted by specifing the 16671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time. 16771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 16871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** See also: SQL functions [sqlite_compileoption_used()] and 16971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [sqlite_compileoption_get()] and the [compile_options pragma]. 17071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori*/ 17171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS 17271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_compileoption_used(const char *zOptName); 17371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API const char *sqlite3_compileoption_get(int N); 17471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#endif 17571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 17671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori/* 177a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Test To See If The Library Is Threadsafe 178a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 179a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_threadsafe() function returns zero if and only if 180a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite was compiled mutexing code omitted due to the 181a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_THREADSAFE] compile-time option being set to 0. 1827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLite can be compiled with or without mutexes. When 184a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes 185a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are enabled and SQLite is threadsafe. When the 186a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_THREADSAFE] macro is 0, 1877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the mutexes are omitted. Without the mutexes, it is not safe 188a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to use SQLite concurrently from more than one thread. 1897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 190a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Enabling mutexes incurs a measurable performance penalty. 1917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** So if speed is of utmost importance, it makes sense to disable 1927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the mutexes. But for maximum safety, mutexes should be enabled. 193a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The default behavior is for mutexes to be enabled. 1947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 195a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This interface can be used by an application to make sure that the 1967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** version of SQLite that it is linking against was compiled with 197a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the desired setting of the [SQLITE_THREADSAFE] macro. 198a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 199a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This interface only reports on the compile-time mutex setting 200a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with 201a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but 202a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can be fully or partially disabled using a call to [sqlite3_config()] 203a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD], 204a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [SQLITE_CONFIG_MUTEX]. ^(The return value of the 205a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_threadsafe() function shows only the compile-time setting of 206a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** thread safety, not any run-time changes to that setting made by 207a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_config(). In other words, the return value from sqlite3_threadsafe() 208a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is unchanged by calls to sqlite3_config().)^ 209a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 210a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See the [threading mode] documentation for additional information. 2117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 212a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_threadsafe(void); 2137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 2147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 215a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Database Connection Handle 2167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** KEYWORDS: {database connection} {database connections} 2177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 218a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Each open SQLite database is represented by a pointer to an instance of 219a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the opaque structure named "sqlite3". It is useful to think of an sqlite3 2207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and 221a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()] 222a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is its destructor. There are many other interfaces (such as 223a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_prepare_v2()], [sqlite3_create_function()], and 224a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_busy_timeout()] to name but three) that are methods on an 225a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3 object. 2267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3 sqlite3; 2287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 2297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 230a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: 64-Bit Integer Types 2317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** KEYWORDS: sqlite_int64 sqlite_uint64 2327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Because there is no cross-platform way to specify 64-bit integer types 2347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLite includes typedefs for 64-bit signed and unsigned integers. 2357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 236a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions. 237a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite_int64 and sqlite_uint64 types are supported for backwards 238a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** compatibility only. 2397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 240a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_int64 and sqlite_int64 types can store integer values 241a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** between -9223372036854775808 and +9223372036854775807 inclusive. ^The 242a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_uint64 and sqlite_uint64 types can store integer values 243a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** between 0 and +18446744073709551615 inclusive. 2447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#ifdef SQLITE_INT64_TYPE 2467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project typedef SQLITE_INT64_TYPE sqlite_int64; 2477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project typedef unsigned SQLITE_INT64_TYPE sqlite_uint64; 2487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#elif defined(_MSC_VER) || defined(__BORLANDC__) 2497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project typedef __int64 sqlite_int64; 2507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project typedef unsigned __int64 sqlite_uint64; 2517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#else 2527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project typedef long long int sqlite_int64; 2537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project typedef unsigned long long int sqlite_uint64; 2547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#endif 2557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef sqlite_int64 sqlite3_int64; 2567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef sqlite_uint64 sqlite3_uint64; 2577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 2587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If compiling for a processor that lacks floating point support, 260a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** substitute integer for floating-point. 2617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#ifdef SQLITE_OMIT_FLOATING_POINT 2637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project# define double sqlite3_int64 2647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#endif 2657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 2667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 267a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Closing A Database Connection 268a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 269a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_close() routine is the destructor for the [sqlite3] object. 270a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Calls to sqlite3_close() return SQLITE_OK if the [sqlite3] object is 271a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** successfullly destroyed and all associated resources are deallocated. 272a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 273a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Applications must [sqlite3_finalize | finalize] all [prepared statements] 274a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and [sqlite3_blob_close | close] all [BLOB handles] associated with 275a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [sqlite3] object prior to attempting to close the object. ^If 276a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_close() is called on a [database connection] that still has 277a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** outstanding [prepared statements] or [BLOB handles], then it returns 278a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_BUSY. 279a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 280a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If [sqlite3_close()] is invoked while a transaction is open, 281a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the transaction is automatically rolled back. 282a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 283a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The C parameter to [sqlite3_close(C)] must be either a NULL 284a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pointer or an [sqlite3] object pointer obtained 285a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from [sqlite3_open()], [sqlite3_open16()], or 286a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_open_v2()], and not previously closed. 287a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Calling sqlite3_close() with a NULL pointer argument is a 288a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** harmless no-op. 2897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 290a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_close(sqlite3 *); 2917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 2927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The type for a callback function. 2947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** This is legacy and deprecated. It is included for historical 2957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** compatibility and is not documented. 2967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef int (*sqlite3_callback)(void*,int,char**, char**); 2987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 2997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 300a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: One-Step Query Execution Interface 301a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 302a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_exec() interface is a convenience wrapper around 303a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()], 304a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that allows an application to run multiple statements of SQL 305a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** without having to use a lot of C code. 306a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 307a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded, 308a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** semicolon-separate SQL statements passed into its 2nd argument, 309a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in the context of the [database connection] passed in as its 1st 310a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** argument. ^If the callback function of the 3rd argument to 311a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_exec() is not NULL, then it is invoked for each result row 312a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** coming out of the evaluated SQL statements. ^The 4th argument to 313a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to sqlite3_exec() is relayed through to the 1st argument of each 314a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** callback invocation. ^If the callback pointer to sqlite3_exec() 315a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is NULL, then no callback is ever invoked and result rows are 316a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ignored. 317a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 318a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If an error occurs while evaluating the SQL statements passed into 319a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_exec(), then execution of the current statement stops and 320a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** subsequent statements are skipped. ^If the 5th parameter to sqlite3_exec() 321a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not NULL then any error message is written into memory obtained 322a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from [sqlite3_malloc()] and passed back through the 5th parameter. 323a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** To avoid memory leaks, the application should invoke [sqlite3_free()] 324a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on error message strings returned through the 5th parameter of 325a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of sqlite3_exec() after the error message string is no longer needed. 326a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors 327a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** occur, then sqlite3_exec() sets the pointer in its 5th parameter to 328a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** NULL before returning. 329a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 330a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec() 331a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routine returns SQLITE_ABORT without invoking the callback again and 332a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** without running any subsequent SQL statements. 333a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 334a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The 2nd argument to the sqlite3_exec() callback function is the 335a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** number of columns in the result. ^The 3rd argument to the sqlite3_exec() 336a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** callback is an array of pointers to strings obtained as if from 337a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_column_text()], one for each column. ^If an element of a 338a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** result row is NULL then the corresponding string pointer for the 339a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_exec() callback is a NULL pointer. ^The 4th argument to the 340a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_exec() callback is an array of pointers to strings where each 341a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** entry represents the name of corresponding result column as obtained 342a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from [sqlite3_column_name()]. 343a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 344a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer 345a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to an empty string, or a pointer that contains only whitespace and/or 346a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL comments, then no SQL statements are evaluated and the database 347a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not changed. 348a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 349a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Restrictions: 3507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 351a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <ul> 352a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> The application must insure that the 1st parameter to sqlite3_exec() 353a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is a valid and open [database connection]. 354a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> The application must not close [database connection] specified by 355a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running. 356a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> The application must not modify the SQL statement text passed into 357a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running. 358a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ul> 3597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 360a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_exec( 3617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, /* An open database */ 362a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori const char *sql, /* SQL to be evaluated */ 3637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*callback)(void*,int,char**,char**), /* Callback function */ 3647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void *, /* 1st argument to callback */ 3657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project char **errmsg /* Error msg written here */ 3667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 3677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 3687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 369a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Result Codes 3707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** KEYWORDS: SQLITE_OK {error code} {error codes} 371a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {result code} {result codes} 3727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Many SQLite functions return an integer result code from the set shown 3747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** here in order to indicates success or failure. 3757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 376a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** New error codes may be added in future versions of SQLite. 377a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** See also: [SQLITE_IOERR_READ | extended result codes] 3797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_OK 0 /* Successful result */ 3817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* beginning-of-error-codes */ 3827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ERROR 1 /* SQL error or missing database */ 3837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */ 3847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_PERM 3 /* Access permission denied */ 3857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ABORT 4 /* Callback routine requested an abort */ 3867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_BUSY 5 /* The database file is locked */ 3877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LOCKED 6 /* A table in the database is locked */ 3887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_NOMEM 7 /* A malloc() failed */ 3897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_READONLY 8 /* Attempt to write a readonly database */ 3907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/ 3917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */ 3927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CORRUPT 11 /* The database disk image is malformed */ 3937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_NOTFOUND 12 /* NOT USED. Table or record not found */ 3947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_FULL 13 /* Insertion failed because database is full */ 3957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CANTOPEN 14 /* Unable to open the database file */ 39671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_PROTOCOL 15 /* Database lock protocol error */ 3977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_EMPTY 16 /* Database is empty */ 3987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_SCHEMA 17 /* The database schema changed */ 3997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */ 4007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */ 4017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MISMATCH 20 /* Data type mismatch */ 4027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MISUSE 21 /* Library used incorrectly */ 4037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */ 4047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_AUTH 23 /* Authorization denied */ 4057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_FORMAT 24 /* Auxiliary database format error */ 4067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */ 4077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_NOTADB 26 /* File opened that is not a database file */ 4087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */ 4097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */ 4107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* end-of-error-codes */ 4117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 4127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 413a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Extended Result Codes 4147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** KEYWORDS: {extended error code} {extended error codes} 415a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {extended result code} {extended result codes} 4167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** In its default configuration, SQLite API routines return one of 26 integer 418a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_OK | result codes]. However, experience has shown that many of 419a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** these result codes are too coarse-grained. They do not provide as 4207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** much information about problems as programmers might like. In an effort to 4217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** address this, newer versions of SQLite (version 3.3.8 and later) include 4227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** support for additional result codes that provide more detailed information 4237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** about errors. The extended result codes are enabled or disabled 424a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on a per database connection basis using the 425a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_extended_result_codes()] API. 426a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Some of the available extended result codes are listed here. 4287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** One may expect the number of extended result codes will be expand 4297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** over time. Software that uses extended result codes should expect 4307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to see new result codes in future releases of SQLite. 4317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The SQLITE_OK result code will never be extended. It will always 4337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** be exactly zero. 4347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 435a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8)) 436a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8)) 437a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8)) 438a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8)) 439a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8)) 440a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8)) 441a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8)) 442a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8)) 443a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8)) 444a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8)) 445a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8)) 446a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8)) 447a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8)) 448a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8)) 449a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8)) 450a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8)) 451a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8)) 45271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_IOERR_SHMOPEN (SQLITE_IOERR | (18<<8)) 45371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_IOERR_SHMSIZE (SQLITE_IOERR | (19<<8)) 45471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR | (20<<8)) 45571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8)) 45671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_BUSY_RECOVERY (SQLITE_BUSY | (1<<8)) 45771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN | (1<<8)) 4587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 4597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 460a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Flags For File Open Operations 4617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These bit values are intended for use in the 4637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3rd parameter to the [sqlite3_open_v2()] interface and 4647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** in the 4th parameter to the xOpen method of the 4657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_vfs] object. 4667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 467a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */ 468a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */ 469a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */ 470a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */ 471a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */ 47271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */ 473a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */ 474a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */ 475a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */ 476a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */ 477a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */ 478a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */ 479a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */ 480a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */ 481a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */ 482a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */ 483a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */ 4847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 4857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 486a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Device Characteristics 4877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The xDeviceCapabilities method of the [sqlite3_io_methods] 4897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** object returns an integer which is a vector of the these 4907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** bit values expressing I/O characteristics of the mass storage 4917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** device that holds the file that the [sqlite3_io_methods] 4927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** refers to. 4937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The SQLITE_IOCAP_ATOMIC property means that all writes of 4957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values 4967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** mean that writes of blocks that are nnn bytes in size and 4977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** are aligned to an address which is an integer multiple of 4987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means 4997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** that when data is appended to a file, the data is appended 5007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** first then the size of the file is extended, never the other 5017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** way around. The SQLITE_IOCAP_SEQUENTIAL property means that 5027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** information is written to disk in the same order as calls 5037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to xWrite(). 5047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 505176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC 0x00000001 506176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC512 0x00000002 507176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC1K 0x00000004 508176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC2K 0x00000008 509176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC4K 0x00000010 510176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC8K 0x00000020 511176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC16K 0x00000040 512176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC32K 0x00000080 513176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC64K 0x00000100 514176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_SAFE_APPEND 0x00000200 515176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_SEQUENTIAL 0x00000400 516176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800 5177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 5187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 519a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: File Locking Levels 5207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLite uses one of these integer values as the second 5227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** argument to calls it makes to the xLock() and xUnlock() methods 5237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of an [sqlite3_io_methods] object. 5247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 5257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LOCK_NONE 0 5267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LOCK_SHARED 1 5277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LOCK_RESERVED 2 5287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LOCK_PENDING 3 5297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LOCK_EXCLUSIVE 4 5307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 5317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 532a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Synchronization Type Flags 5337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** When SQLite invokes the xSync() method of an 5357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_io_methods] object it uses a combination of 5367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** these integer values as the second argument. 5377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** When the SQLITE_SYNC_DATAONLY flag is used, it means that the 5397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sync operation only needs to flush data to mass storage. Inode 540a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** information need not be flushed. If the lower four bits of the flag 541a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics. 542a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If the lower four bits equal SQLITE_SYNC_FULL, that means 543a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to use Mac OS X style fullsync instead of fsync(). 5447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 5457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_SYNC_NORMAL 0x00002 5467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_SYNC_FULL 0x00003 5477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_SYNC_DATAONLY 0x00010 5487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 5497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 550a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: OS Interface Open File Handle 5517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 552a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** An [sqlite3_file] object represents an open file in the 553a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_vfs | OS interface layer]. Individual OS interface 554a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementations will 5557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** want to subclass this object by appending additional fields 5567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for their own use. The pMethods entry is a pointer to an 5577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_io_methods] object that defines methods for performing 5587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** I/O operations on the open file. 5597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 5607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_file sqlite3_file; 5617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projectstruct sqlite3_file { 5627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const struct sqlite3_io_methods *pMethods; /* Methods for an open file */ 5637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project}; 5647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 5657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 566a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: OS Interface File Virtual Methods Object 567a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 568a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Every file opened by the [sqlite3_vfs] xOpen method populates an 569a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_file] object (or, more commonly, a subclass of the 570a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_file] object) with a pointer to an instance of this object. 571a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This object defines the methods used to perform various operations 572a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** against the open file represented by the [sqlite3_file] object. 5737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 574a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If the xOpen method sets the sqlite3_file.pMethods element 575a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to a non-NULL pointer, then the sqlite3_io_methods.xClose method 576a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** may be invoked even if the xOpen reported that it failed. The 577a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** only way to prevent a call to xClose following a failed xOpen 578a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is for the xOpen to set the sqlite3_file.pMethods element to NULL. 5797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or 5817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_SYNC_FULL]. The first choice is the normal fsync(). 582a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY] 583a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** flag may be ORed in to indicate that only the data of the file 584a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and not its inode needs to be synced. 585a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The integer values to xLock() and xUnlock() are one of 5877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 5887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_LOCK_NONE], 5897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_LOCK_SHARED], 5907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_LOCK_RESERVED], 5917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_LOCK_PENDING], or 5927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_LOCK_EXCLUSIVE]. 5937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </ul> 594a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xLock() increases the lock. xUnlock() decreases the lock. 595a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The xCheckReservedLock() method checks whether any database connection, 596a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** either in this process or in some other process, is holding a RESERVED, 5977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** PENDING, or EXCLUSIVE lock on the file. It returns true 598a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** if such a lock exists and false otherwise. 599a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The xFileControl() method is a generic interface that allows custom 6017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** VFS implementations to directly control an open file using the 602a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_file_control()] interface. The second "op" argument is an 603a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** integer opcode. The third argument is a generic pointer intended to 604a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** point to a structure that may contain arguments or space in which to 6057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** write return values. Potential uses for xFileControl() might be 6067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** functions to enable blocking locks with timeouts, to change the 6077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** locking strategy (for example to use dot-file locks), to inquire 6087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** about the status of a lock, or to break stale locks. The SQLite 609a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** core reserves all opcodes less than 100 for its own use. 6107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** A [SQLITE_FCNTL_LOCKSTATE | list of opcodes] less than 100 is available. 611a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Applications that define a custom xFileControl method should use opcodes 6127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** greater than 100 to avoid conflicts. 6137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The xSectorSize() method returns the sector size of the 6157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** device that underlies the file. The sector size is the 6167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** minimum write that can be performed without disturbing 6177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** other bytes in the file. The xDeviceCharacteristics() 6187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** method returns a bit vector describing behaviors of the 6197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** underlying device: 6207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 6227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC] 6237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC512] 6247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC1K] 6257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC2K] 6267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC4K] 6277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC8K] 6287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC16K] 6297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC32K] 6307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC64K] 6317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_SAFE_APPEND] 6327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_SEQUENTIAL] 6337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </ul> 6347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The SQLITE_IOCAP_ATOMIC property means that all writes of 6367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values 6377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** mean that writes of blocks that are nnn bytes in size and 6387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** are aligned to an address which is an integer multiple of 6397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means 6407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** that when data is appended to a file, the data is appended 6417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** first then the size of the file is extended, never the other 6427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** way around. The SQLITE_IOCAP_SEQUENTIAL property means that 6437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** information is written to disk in the same order as calls 6447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to xWrite(). 645a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 646a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill 647a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in the unread portions of the buffer with zeros. A VFS that 648a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** fails to zero-fill short reads might seem to work. However, 649a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** failure to zero-fill short reads will eventually lead to 650a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database corruption. 6517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 6527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_io_methods sqlite3_io_methods; 6537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projectstruct sqlite3_io_methods { 6547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int iVersion; 6557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xClose)(sqlite3_file*); 6567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst); 6577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst); 6587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xTruncate)(sqlite3_file*, sqlite3_int64 size); 6597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xSync)(sqlite3_file*, int flags); 6607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize); 6617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xLock)(sqlite3_file*, int); 6627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xUnlock)(sqlite3_file*, int); 663a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xCheckReservedLock)(sqlite3_file*, int *pResOut); 6647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xFileControl)(sqlite3_file*, int op, void *pArg); 6657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xSectorSize)(sqlite3_file*); 6667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xDeviceCharacteristics)(sqlite3_file*); 66771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori /* Methods above are valid for version 1 */ 66871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori int (*xShmOpen)(sqlite3_file*); 66971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori int (*xShmLock)(sqlite3_file*, int offset, int n, int flags); 67071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori int (*xShmMap)(sqlite3_file*, int iPage, int pgsz, int, void volatile**); 67171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori void (*xShmBarrier)(sqlite3_file*); 67271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori int (*xShmClose)(sqlite3_file*, int deleteFlag); 67371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori /* Methods above are valid for version 2 */ 6747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project /* Additional methods may be added in future releases */ 6757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project}; 6767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 6777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 678a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Standard File Control Opcodes 6797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These integer constants are opcodes for the xFileControl method 681a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()] 6827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface. 6837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This 6857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** opcode causes the xFileControl method to write the current state of 6867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED], 6877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE]) 6887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** into an integer that the pArg argument points to. This capability 6897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is used during testing and only needs to be supported when SQLITE_TEST 6907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is defined. 69171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 69271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS 69371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** layer a hint of how large the database file will grow to be during the 69471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** current transaction. This hint is not guaranteed to be accurate but it 69571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** is often close. The underlying VFS might choose to preallocate database 69671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** file space based on this hint in order to help writes to the database 69771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** file run faster. 6987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 6997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_FCNTL_LOCKSTATE 1 700a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_GET_LOCKPROXYFILE 2 701a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_SET_LOCKPROXYFILE 3 702a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_LAST_ERRNO 4 70371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_FCNTL_SIZE_HINT 5 7047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 7057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 706a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Mutex Handle 7077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 7087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The mutex module within SQLite defines [sqlite3_mutex] to be an 7097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** abstract type for a mutex object. The SQLite core never looks 7107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** at the internal representation of an [sqlite3_mutex]. It only 7117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** deals with pointers to the [sqlite3_mutex] object. 7127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 7137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Mutexes are created using [sqlite3_mutex_alloc()]. 7147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 7157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_mutex sqlite3_mutex; 7167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 7177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 718a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: OS Interface Object 7197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 720a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** An instance of the sqlite3_vfs object defines the interface between 721a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the SQLite core and the underlying operating system. The "vfs" 7227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** in the name of the object stands for "virtual file system". 7237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 724a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The value of the iVersion field is initially 1 but may be larger in 725a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** future versions of SQLite. Additional fields may be appended to this 726a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** object when the iVersion value is increased. Note that the structure 727a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the sqlite3_vfs object changes in the transaction between 728a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not 729a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** modified. 7307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 7317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The szOsFile field is the size of the subclassed [sqlite3_file] 7327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** structure used by this VFS. mxPathname is the maximum length of 7337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a pathname in this VFS. 7347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 7357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Registered sqlite3_vfs objects are kept on a linked list formed by 7367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the pNext pointer. The [sqlite3_vfs_register()] 7377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and [sqlite3_vfs_unregister()] interfaces manage this list 7387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** in a thread-safe way. The [sqlite3_vfs_find()] interface 739a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** searches the list. Neither the application code nor the VFS 740a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation should use the pNext pointer. 7417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 742a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The pNext field is the only field in the sqlite3_vfs 7437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** structure that SQLite will ever modify. SQLite will only access 7447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or modify this field while holding a particular static mutex. 7457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The application should never modify anything within the sqlite3_vfs 7467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** object once the object has been registered. 7477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 7487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The zName field holds the name of the VFS module. The name must 7497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** be unique across all VFS modules. 7507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 751a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite will guarantee that the zFilename parameter to xOpen 752a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is either a NULL pointer or string obtained 753a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from xFullPathname(). SQLite further guarantees that 754a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the string will be valid and unchanged until xClose() is 755a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** called. Because of the previous sentence, 756a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [sqlite3_file] can safely store a pointer to the 7577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** filename if it needs to remember the filename for some reason. 758a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If the zFilename parameter is xOpen is a NULL pointer then xOpen 759a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** must invent its own temporary name for the file. Whenever the 760a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xFilename parameter is NULL it will also be the case that the 761a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE]. 7627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 763a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The flags argument to xOpen() includes all bits set in 7647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()] 7657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or [sqlite3_open16()] is used, then flags includes at least 766a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. 7677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If xOpen() opens a file read-only then it sets *pOutFlags to 768a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set. 769a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 770a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite will also add one of the following flags to the xOpen() 7717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** call, depending on the object being opened: 772a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 7747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_MAIN_DB] 7757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_MAIN_JOURNAL] 7767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_TEMP_DB] 7777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_TEMP_JOURNAL] 7787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_TRANSIENT_DB] 7797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_SUBJOURNAL] 7807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_MASTER_JOURNAL] 781a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ul> 7827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 7837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The file I/O implementation can use the object type flags to 784a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** change the way it deals with files. For example, an application 7857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** that does not care about crash recovery or rollback might make 7867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the open of a journal file a no-op. Writes to this journal would 787a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** also be no-ops, and any attempt to read the journal would return 788a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_IOERR. Or the implementation might recognize that a database 789a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** file will be doing page-aligned sector reads and writes in a random 7907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** order and set up its I/O subsystem accordingly. 791a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 792a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite might also add one of the following flags to the xOpen method: 793a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 7947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 7957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_DELETEONCLOSE] 7967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_EXCLUSIVE] 7977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </ul> 798a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 799a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be 800a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** deleted when it is closed. The [SQLITE_OPEN_DELETEONCLOSE] 801a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will be set for TEMP databases, journals and for subjournals. 802a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 803a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction 804a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with the [SQLITE_OPEN_CREATE] flag, which are both directly 805a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** analogous to the O_EXCL and O_CREAT flags of the POSIX open() 806a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the 807a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_OPEN_CREATE, is used to indicate that file should always 808a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** be created, and that it is an error if it already exists. 809a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** It is <i>not</i> used to indicate the file should be opened 810a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for exclusive access. 811a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 812a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** At least szOsFile bytes of memory are allocated by SQLite 813a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to hold the [sqlite3_file] structure passed as the third 814a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** argument to xOpen. The xOpen method does not have to 815a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocate the structure; it should just fill it in. Note that 816a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the xOpen method must set the sqlite3_file.pMethods to either 817a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a valid [sqlite3_io_methods] object or to NULL. xOpen must do 818a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** this even if the open fails. SQLite expects that the sqlite3_file.pMethods 819a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** element will be valid after xOpen returns regardless of the success 820a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or failure of the xOpen call. 821a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 822a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS] 823a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to 824a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** test whether a file is readable and writable, or [SQLITE_ACCESS_READ] 825a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to test whether a file is at least readable. The file can be a 8267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** directory. 827a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 828a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite will always allocate at least mxPathname+1 bytes for the 829a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** output buffer xFullPathname. The exact size of the output buffer 830a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is also passed as a parameter to both methods. If the output buffer 831a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is 832a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** handled as a fatal error by SQLite, vfs implementations should endeavor 833a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to prevent this by setting mxPathname to a sufficiently large value. 834a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 835ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64() 836ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** interfaces are not strictly a part of the filesystem, but they are 8377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** included in the VFS structure for completeness. 8387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The xRandomness() function attempts to return nBytes bytes 8397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of good-quality randomness into zOut. The return value is 840a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the actual number of bytes of randomness obtained. 841a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The xSleep() method causes the calling thread to sleep for at 8427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** least the number of microseconds given. The xCurrentTime() 843ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** method returns a Julian Day Number for the current date and time as 844ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** a floating point value. 845ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** The xCurrentTimeInt64() method returns, as an integer, the Julian 846ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** Day Number multipled by 86400000 (the number of milliseconds in 847ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** a 24-hour day). 848ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** ^SQLite will use the xCurrentTimeInt64() method to get the current 849ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** date and time if that method is available (if iVersion is 2 or 850ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** greater and the function pointer is not NULL) and will fall back 851ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** to xCurrentTime() if xCurrentTimeInt64() is unavailable. 8527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 8537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_vfs sqlite3_vfs; 8547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projectstruct sqlite3_vfs { 85571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori int iVersion; /* Structure version number (currently 2) */ 8567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int szOsFile; /* Size of subclassed sqlite3_file */ 8577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int mxPathname; /* Maximum file pathname length */ 8587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_vfs *pNext; /* Next registered VFS */ 8597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zName; /* Name of this virtual file system */ 8607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void *pAppData; /* Pointer to application-specific data */ 8617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*, 8627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int flags, int *pOutFlags); 8637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir); 864a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut); 8657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut); 8667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename); 8677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg); 868a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void); 8697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xDlClose)(sqlite3_vfs*, void*); 8707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut); 8717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xSleep)(sqlite3_vfs*, int microseconds); 8727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xCurrentTime)(sqlite3_vfs*, double*); 873a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xGetLastError)(sqlite3_vfs*, int, char *); 87471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori /* 87571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori ** The methods above are in version 1 of the sqlite_vfs object 87671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori ** definition. Those that follow are added in version 2 or later 87771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori */ 87871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori int (*xCurrentTimeInt64)(sqlite3_vfs*, sqlite3_int64*); 87971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori /* 88071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori ** The methods above are in versions 1 and 2 of the sqlite_vfs object. 88171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori ** New fields may be appended in figure versions. The iVersion 88271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori ** value will increment whenever this happens. 88371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori */ 8847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project}; 8857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 8867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 887a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Flags for the xAccess VFS method 888a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 889a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These integer constants can be used as the third parameter to 890a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the xAccess method of an [sqlite3_vfs] object. They determine 891a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** what kind of permissions the xAccess method is looking for. 892a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** With SQLITE_ACCESS_EXISTS, the xAccess method 893a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** simply checks whether the file exists. 894a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** With SQLITE_ACCESS_READWRITE, the xAccess method 895a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** checks whether the file is both readable and writable. 896a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** With SQLITE_ACCESS_READ, the xAccess method 897a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** checks whether the file is readable. 8987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 8997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ACCESS_EXISTS 0 9007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ACCESS_READWRITE 1 9017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ACCESS_READ 2 9027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 9037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 90471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** CAPI3REF: Flags for the xShmLock VFS method 90571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 90671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** These integer constants define the various locking operations 90771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** allowed by the xShmLock method of [sqlite3_io_methods]. The 90871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** following are the only legal combinations of flags to the 90971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** xShmLock method: 91071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 91171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <ul> 91271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <li> SQLITE_SHM_LOCK | SQLITE_SHM_SHARED 91371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <li> SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE 91471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED 91571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE 91671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** </ul> 91771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 91871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as 91971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** was given no the corresponding lock. 92071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 92171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** The xShmLock method can transition between unlocked and SHARED or 92271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** between unlocked and EXCLUSIVE. It cannot transition between SHARED 92371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** and EXCLUSIVE. 92471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori*/ 92571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_SHM_UNLOCK 1 92671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_SHM_LOCK 2 92771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_SHM_SHARED 4 92871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_SHM_EXCLUSIVE 8 92971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 93071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori/* 93171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** CAPI3REF: Maximum xShmLock index 93271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 93371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** The xShmLock method on [sqlite3_io_methods] may use values 93471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** between 0 and this upper bound as its "offset" argument. 93571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** The SQLite core will never attempt to acquire or release a 93671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** lock outside of this range 93771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori*/ 93871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_SHM_NLOCK 8 93971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 94071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 94171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori/* 942a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Initialize The SQLite Library 943a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 944a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_initialize() routine initializes the 945a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite library. ^The sqlite3_shutdown() routine 946a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** deallocates any resources that were allocated by sqlite3_initialize(). 947a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These routines are designed to aid in process initialization and 948a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** shutdown on embedded systems. Workstation applications using 949a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite normally do not need to invoke either of these routines. 950a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 951a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A call to sqlite3_initialize() is an "effective" call if it is 952a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the first time sqlite3_initialize() is invoked during the lifetime of 953a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the process, or if it is the first time sqlite3_initialize() is invoked 954a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** following a call to sqlite3_shutdown(). ^(Only an effective call 955a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of sqlite3_initialize() does any initialization. All other calls 956a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are harmless no-ops.)^ 957a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 958a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A call to sqlite3_shutdown() is an "effective" call if it is the first 959a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** call to sqlite3_shutdown() since the last sqlite3_initialize(). ^(Only 960a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an effective call to sqlite3_shutdown() does any deinitialization. 961a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^ 962a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 963a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown() 964a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not. The sqlite3_shutdown() interface must only be called from a 965a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** single thread. All open [database connections] must be closed and all 966a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** other SQLite resources must be deallocated prior to invoking 967a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_shutdown(). 968a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 969a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Among other things, ^sqlite3_initialize() will invoke 970a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_os_init(). Similarly, ^sqlite3_shutdown() 971a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will invoke sqlite3_os_end(). 972a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 973a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success. 974a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If for some reason, sqlite3_initialize() is unable to initialize 975a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the library (perhaps it is unable to allocate a needed resource such 976a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** as a mutex) it returns an [error code] other than [SQLITE_OK]. 977a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 978a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_initialize() routine is called internally by many other 979a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite interfaces so that an application usually does not need to 980a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** invoke sqlite3_initialize() directly. For example, [sqlite3_open()] 981a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** calls sqlite3_initialize() so the SQLite library will be automatically 982a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** initialized when [sqlite3_open()] is called if it has not be initialized 983a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT] 984a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** compile-time option, then the automatic calls to sqlite3_initialize() 985a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are omitted and the application must call sqlite3_initialize() directly 986a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** prior to using any other SQLite interface. For maximum portability, 987a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it is recommended that applications always invoke sqlite3_initialize() 988a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** directly prior to using any other SQLite interface. Future releases 989a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of SQLite may require this. In other words, the behavior exhibited 990a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the 991a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** default behavior in some future release of SQLite. 992a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 993a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_os_init() routine does operating-system specific 994a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** initialization of the SQLite library. The sqlite3_os_end() 995a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routine undoes the effect of sqlite3_os_init(). Typical tasks 996a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** performed by these routines include allocation or deallocation 997a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of static resources, initialization of global variables, 998a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** setting up a default [sqlite3_vfs] module, or setting up 999a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a default configuration using [sqlite3_config()]. 1000a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1001a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The application should never invoke either sqlite3_os_init() 1002a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or sqlite3_os_end() directly. The application should only invoke 1003a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init() 1004a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interface is called automatically by sqlite3_initialize() and 1005a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate 1006a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementations for sqlite3_os_init() and sqlite3_os_end() 1007a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are built into SQLite when it is compiled for Unix, Windows, or OS/2. 1008a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When [custom builds | built for other platforms] 1009a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (using the [SQLITE_OS_OTHER=1] compile-time 1010a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** option) the application must supply a suitable implementation for 1011a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_os_init() and sqlite3_os_end(). An application-supplied 1012a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation of sqlite3_os_init() or sqlite3_os_end() 1013a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** must return [SQLITE_OK] on success and some other [error code] upon 1014a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** failure. 1015a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 1016a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_initialize(void); 1017a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_shutdown(void); 1018a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_os_init(void); 1019a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_os_end(void); 1020a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1021a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 1022a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Configuring The SQLite Library 1023a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1024a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_config() interface is used to make global configuration 1025a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** changes to SQLite in order to tune SQLite to the specific needs of 1026a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the application. The default configuration is recommended for most 1027a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** applications and so this routine is usually not necessary. It is 1028a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** provided to support rare applications with unusual needs. 1029a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1030a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_config() interface is not threadsafe. The application 1031a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** must insure that no other SQLite interfaces are invoked by other 1032a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** threads while sqlite3_config() is running. Furthermore, sqlite3_config() 1033a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** may only be invoked prior to library initialization using 1034a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()]. 1035a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_config() is called after [sqlite3_initialize()] and before 1036a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_shutdown()] then it will return SQLITE_MISUSE. 1037a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Note, however, that ^sqlite3_config() can be called as part of the 1038a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation of an application-defined [sqlite3_os_init()]. 1039a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1040a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The first argument to sqlite3_config() is an integer 1041a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_CONFIG_SINGLETHREAD | configuration option] that determines 1042a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** what property of SQLite is to be configured. Subsequent arguments 1043a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** vary depending on the [SQLITE_CONFIG_SINGLETHREAD | configuration option] 1044a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in the first argument. 1045a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1046a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK]. 1047a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the option is unknown or SQLite is unable to set the option 1048a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then this routine returns a non-zero [error code]. 1049a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 105071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_config(int, ...); 1051a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1052a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 1053a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Configure database connections 1054a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1055a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_db_config() interface is used to make configuration 1056a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** changes to a [database connection]. The interface is similar to 1057a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] except that the changes apply to a single 1058a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection] (specified in the first argument). The 1059a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_db_config() interface should only be used immediately after 1060a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the database connection is created using [sqlite3_open()], 1061a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_open16()], or [sqlite3_open_v2()]. 1062a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1063a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The second argument to sqlite3_db_config(D,V,...) is the 1064a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** configuration verb - an integer code that indicates what 1065a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** aspect of the [database connection] is being configured. 1066a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The only choice for this value is [SQLITE_DBCONFIG_LOOKASIDE]. 1067a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** New verbs are likely to be added in future releases of SQLite. 1068a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Additional arguments depend on the verb. 1069a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1070a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if 1071a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the call is considered successful. 1072a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 107371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_db_config(sqlite3*, int op, ...); 1074a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1075a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 1076a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Memory Allocation Routines 1077a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1078a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** An instance of this object defines the interface between SQLite 1079a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and low-level memory allocation routines. 1080a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1081a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This object is used in only one place in the SQLite interface. 1082a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A pointer to an instance of this object is the argument to 1083a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] when the configuration option is 1084a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC]. 1085a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** By creating an instance of this object 1086a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC]) 1087a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** during configuration, an application can specify an alternative 1088a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory allocation subsystem for SQLite to use for all of its 1089a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** dynamic memory needs. 1090a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1091a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Note that SQLite comes with several [built-in memory allocators] 1092a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that are perfectly adequate for the overwhelming majority of applications 1093a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and that this object is only useful to a tiny minority of applications 1094a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with specialized memory allocation requirements. This object is 1095a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** also used during testing of SQLite in order to specify an alternative 1096a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory allocator that simulates memory out-of-memory conditions in 1097a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** order to verify that SQLite recovers gracefully from such 1098a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** conditions. 1099a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1100a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The xMalloc and xFree methods must work like the 1101a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** malloc() and free() functions from the standard C library. 1102a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The xRealloc method must work like realloc() from the standard C library 1103a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with the exception that if the second argument to xRealloc is zero, 1104a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xRealloc must be a no-op - it must not perform any allocation or 1105a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** deallocation. ^SQLite guarantees that the second argument to 1106a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xRealloc is always a value returned by a prior call to xRoundup. 1107a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** And so in cases where xRoundup always returns a positive number, 1108a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xRealloc can perform exactly as the standard library realloc() and 1109a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** still be in compliance with this specification. 1110a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1111a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xSize should return the allocated size of a memory allocation 1112a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** previously obtained from xMalloc or xRealloc. The allocated size 1113a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is always at least as big as the requested size but may be larger. 1114a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1115a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The xRoundup method returns what would be the allocated size of 1116a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a memory allocation given a particular requested size. Most memory 1117a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocators round up memory allocations at least to the next multiple 1118a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of 8. Some allocators round up to a larger multiple or to a power of 2. 1119a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Every memory allocation request coming in through [sqlite3_malloc()] 1120a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0, 1121a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that causes the corresponding memory allocation to fail. 1122a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1123a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The xInit method initializes the memory allocator. (For example, 1124a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it might allocate any require mutexes or initialize internal data 1125a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** structures. The xShutdown method is invoked (indirectly) by 1126a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_shutdown()] and should deallocate any resources acquired 1127a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by xInit. The pAppData pointer is used as the only parameter to 1128a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xInit and xShutdown. 1129a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1130a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes 1131a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the xInit method, so the xInit method need not be threadsafe. The 1132a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xShutdown method is only called from [sqlite3_shutdown()] so it does 1133a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not need to be threadsafe either. For all other methods, SQLite 1134a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the 1135a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which 1136a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it is by default) and so the methods are automatically serialized. 1137a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other 1138a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** methods must be threadsafe or else make their own arrangements for 1139a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** serialization. 1140a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1141a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite will never invoke xInit() more than once without an intervening 1142a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** call to xShutdown(). 1143a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 1144a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noritypedef struct sqlite3_mem_methods sqlite3_mem_methods; 1145a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noristruct sqlite3_mem_methods { 1146a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *(*xMalloc)(int); /* Memory allocation function */ 1147a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xFree)(void*); /* Free a prior allocation */ 1148a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *(*xRealloc)(void*,int); /* Resize an allocation */ 1149a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xSize)(void*); /* Return the size of an allocation */ 1150a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xRoundup)(int); /* Round up request size to allocation size */ 1151a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xInit)(void*); /* Initialize the memory allocator */ 1152a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xShutdown)(void*); /* Deinitialize the memory allocator */ 1153a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *pAppData; /* Argument to xInit() and xShutdown() */ 1154a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori}; 1155a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1156a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 1157a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Configuration Options 1158a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1159a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These constants are the available integer configuration options that 1160a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can be passed as the first argument to the [sqlite3_config()] interface. 1161a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1162a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** New configuration options may be added in future releases of SQLite. 1163a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Existing configuration options might be discontinued. Applications 1164a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** should check the return code from [sqlite3_config()] to make sure that 1165a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the call worked. The [sqlite3_config()] interface will return a 1166a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** non-zero [error code] if a discontinued or unsupported configuration option 1167a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is invoked. 1168a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1169a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dl> 1170a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dt>SQLITE_CONFIG_SINGLETHREAD</dt> 1171a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>There are no arguments to this option. ^This option sets the 1172a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [threading mode] to Single-thread. In other words, it disables 1173a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** all mutexing and puts SQLite into a mode where it can only be used 1174a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by a single thread. ^If SQLite is compiled with 1175a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1176a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it is not possible to change the [threading mode] from its default 1177a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value of Single-thread and so [sqlite3_config()] will return 1178a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD 1179a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** configuration option.</dd> 1180a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1181a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dt>SQLITE_CONFIG_MULTITHREAD</dt> 1182a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>There are no arguments to this option. ^This option sets the 1183a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [threading mode] to Multi-thread. In other words, it disables 1184a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** mutexing on [database connection] and [prepared statement] objects. 1185a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The application is responsible for serializing access to 1186a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connections] and [prepared statements]. But other mutexes 1187a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are enabled so that SQLite will be safe to use in a multi-threaded 1188a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** environment as long as no two threads attempt to use the same 1189a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection] at the same time. ^If SQLite is compiled with 1190a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1191a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it is not possible to set the Multi-thread [threading mode] and 1192a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] will return [SQLITE_ERROR] if called with the 1193a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_CONFIG_MULTITHREAD configuration option.</dd> 1194a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1195a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dt>SQLITE_CONFIG_SERIALIZED</dt> 1196a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>There are no arguments to this option. ^This option sets the 1197a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [threading mode] to Serialized. In other words, this option enables 1198a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** all mutexes including the recursive 1199a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** mutexes on [database connection] and [prepared statement] objects. 1200a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** In this mode (which is the default when SQLite is compiled with 1201a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access 1202a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to [database connections] and [prepared statements] so that the 1203a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** application is free to use the same [database connection] or the 1204a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** same [prepared statement] in different threads at the same time. 1205a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If SQLite is compiled with 1206a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1207a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it is not possible to set the Serialized [threading mode] and 1208a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] will return [SQLITE_ERROR] if called with the 1209a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_CONFIG_SERIALIZED configuration option.</dd> 1210a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1211a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dt>SQLITE_CONFIG_MALLOC</dt> 1212a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^(This option takes a single argument which is a pointer to an 1213a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** instance of the [sqlite3_mem_methods] structure. The argument specifies 1214a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** alternative low-level memory allocation routines to be used in place of 1215a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the memory allocation routines built into SQLite.)^ ^SQLite makes 1216a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** its own private copy of the content of the [sqlite3_mem_methods] structure 1217a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** before the [sqlite3_config()] call returns.</dd> 1218a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1219a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dt>SQLITE_CONFIG_GETMALLOC</dt> 1220a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^(This option takes a single argument which is a pointer to an 1221a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** instance of the [sqlite3_mem_methods] structure. The [sqlite3_mem_methods] 1222a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** structure is filled with the currently defined memory allocation routines.)^ 1223a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This option can be used to overload the default memory allocation 1224a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routines with a wrapper that simulations memory allocation failure or 1225a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** tracks memory usage, for example. </dd> 1226a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1227a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dt>SQLITE_CONFIG_MEMSTATUS</dt> 1228a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^This option takes single argument of type int, interpreted as a 1229a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** boolean, which enables or disables the collection of memory allocation 1230a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** statistics. ^(When memory allocation statistics are disabled, the 1231a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** following SQLite interfaces become non-operational: 1232a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <ul> 1233a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_memory_used()] 1234a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_memory_highwater()] 1235a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_soft_heap_limit()] 1236a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_status()] 1237a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ul>)^ 1238a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Memory allocation statistics are enabled by default unless SQLite is 1239a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory 1240a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocation statistics are disabled by default. 1241a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dd> 1242a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1243a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dt>SQLITE_CONFIG_SCRATCH</dt> 1244a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^This option specifies a static memory buffer that SQLite can use for 1245a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** scratch memory. There are three arguments: A pointer an 8-byte 1246a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** aligned memory buffer from which the scrach allocations will be 1247a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** drawn, the size of each scratch allocation (sz), 1248a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and the maximum number of scratch allocations (N). The sz 1249a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** argument must be a multiple of 16. The sz parameter should be a few bytes 1250a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** larger than the actual scratch space required due to internal overhead. 1251a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The first argument must be a pointer to an 8-byte aligned buffer 1252a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of at least sz*N bytes of memory. 1253a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite will use no more than one scratch buffer per thread. So 1254a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** N should be set to the expected maximum number of threads. ^SQLite will 1255a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** never require a scratch buffer that is more than 6 times the database 1256a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** page size. ^If SQLite needs needs additional scratch memory beyond 1257a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** what is provided by this configuration option, then 1258a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_malloc()] will be used to obtain the memory needed.</dd> 1259a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1260a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dt>SQLITE_CONFIG_PAGECACHE</dt> 1261a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^This option specifies a static memory buffer that SQLite can use for 1262a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the database page cache with the default page cache implemenation. 1263a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This configuration should not be used if an application-define page 1264a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** cache implementation is loaded using the SQLITE_CONFIG_PCACHE option. 1265a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** There are three arguments to this option: A pointer to 8-byte aligned 1266a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory, the size of each page buffer (sz), and the number of pages (N). 1267a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sz argument should be the size of the largest database page 1268a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (a power of two between 512 and 32768) plus a little extra for each 1269a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** page header. ^The page header size is 20 to 40 bytes depending on 1270a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the host architecture. ^It is harmless, apart from the wasted memory, 1271a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to make sz a little too large. The first 1272a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** argument should point to an allocation of at least sz*N bytes of memory. 1273a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite will use the memory provided by the first argument to satisfy its 1274a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory needs for the first N pages that it adds to cache. ^If additional 1275a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** page cache memory is needed beyond what is provided by this option, then 1276a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite goes to [sqlite3_malloc()] for the additional storage space. 1277a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The implementation might use one or more of the N buffers to hold 1278a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory accounting information. The pointer in the first argument must 1279a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** be aligned to an 8-byte boundary or subsequent behavior of SQLite 1280a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will be undefined.</dd> 1281a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1282a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dt>SQLITE_CONFIG_HEAP</dt> 1283a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^This option specifies a static memory buffer that SQLite will use 1284a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for all of its dynamic memory allocation needs beyond those provided 1285a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE]. 1286a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** There are three arguments: An 8-byte aligned pointer to the memory, 1287a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the number of bytes in the memory buffer, and the minimum allocation size. 1288a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts 1289a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to using its default memory allocator (the system malloc() implementation), 1290a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the 1291a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory pointer is not NULL and either [SQLITE_ENABLE_MEMSYS3] or 1292a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_ENABLE_MEMSYS5] are defined, then the alternative memory 1293a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocator is engaged to handle all of SQLites memory allocation needs. 1294a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The first pointer (the memory pointer) must be aligned to an 8-byte 1295a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** boundary or subsequent behavior of SQLite will be undefined.</dd> 1296a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1297a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dt>SQLITE_CONFIG_MUTEX</dt> 1298a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^(This option takes a single argument which is a pointer to an 1299a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** instance of the [sqlite3_mutex_methods] structure. The argument specifies 1300a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** alternative low-level mutex routines to be used in place 1301a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the mutex routines built into SQLite.)^ ^SQLite makes a copy of the 1302a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** content of the [sqlite3_mutex_methods] structure before the call to 1303a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] returns. ^If SQLite is compiled with 1304a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1305a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the entire mutexing subsystem is omitted from the build and hence calls to 1306a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will 1307a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** return [SQLITE_ERROR].</dd> 1308a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1309a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dt>SQLITE_CONFIG_GETMUTEX</dt> 1310a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^(This option takes a single argument which is a pointer to an 1311a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** instance of the [sqlite3_mutex_methods] structure. The 1312a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_mutex_methods] 1313a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** structure is filled with the currently defined mutex routines.)^ 1314a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This option can be used to overload the default mutex allocation 1315a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routines with a wrapper used to track mutex usage for performance 1316a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** profiling or testing, for example. ^If SQLite is compiled with 1317a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1318a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the entire mutexing subsystem is omitted from the build and hence calls to 1319a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will 1320a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** return [SQLITE_ERROR].</dd> 1321a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1322a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dt>SQLITE_CONFIG_LOOKASIDE</dt> 1323a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^(This option takes two arguments that determine the default 1324a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory allocation for the lookaside memory allocator on each 1325a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection]. The first argument is the 1326a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** size of each lookaside buffer slot and the second is the number of 1327a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** slots allocated to each database connection.)^ ^(This option sets the 1328a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE] 1329a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** verb to [sqlite3_db_config()] can be used to change the lookaside 1330a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** configuration on individual connections.)^ </dd> 1331a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1332a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dt>SQLITE_CONFIG_PCACHE</dt> 1333a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^(This option takes a single argument which is a pointer to 1334a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an [sqlite3_pcache_methods] object. This object specifies the interface 1335a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to a custom page cache implementation.)^ ^SQLite makes a copy of the 1336a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** object and uses it for page cache memory allocations.</dd> 1337a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1338a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dt>SQLITE_CONFIG_GETPCACHE</dt> 1339a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^(This option takes a single argument which is a pointer to an 1340a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_pcache_methods] object. SQLite copies of the current 1341a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** page cache implementation into that object.)^ </dd> 1342a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 134371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <dt>SQLITE_CONFIG_LOG</dt> 134471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <dd> ^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a 134571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** function with a call signature of void(*)(void*,int,const char*), 134671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** and a pointer to void. ^If the function pointer is not NULL, it is 134771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** invoked by [sqlite3_log()] to process each logging event. ^If the 134871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op. 134971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is 135071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** passed through as the first parameter to the application-defined logger 135171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** function whenever that function is invoked. ^The second parameter to 135271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** the logger function is a copy of the first parameter to the corresponding 135371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [sqlite3_log()] call and is intended to be a [result code] or an 135471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [extended result code]. ^The third parameter passed to the logger is 135571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** log message after formatting via [sqlite3_snprintf()]. 135671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** The SQLite logging interface is not reentrant; the logger function 135771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** supplied by the application must not invoke any SQLite interface. 135871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** In a multi-threaded application, the application-defined logger 135971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** function must be threadsafe. </dd> 136071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 1361a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dl> 1362a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 1363a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */ 1364a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_MULTITHREAD 2 /* nil */ 1365a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_SERIALIZED 3 /* nil */ 1366a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */ 1367a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */ 1368a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */ 1369a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */ 1370a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */ 1371a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */ 1372a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */ 1373a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */ 1374a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */ 1375a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_LOOKASIDE 13 /* int int */ 1376a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_PCACHE 14 /* sqlite3_pcache_methods* */ 1377a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_GETPCACHE 15 /* sqlite3_pcache_methods* */ 1378aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori#define SQLITE_CONFIG_LOG 16 /* xFunc, void* */ 1379a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1380a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 138171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** CAPI3REF: Database Connection Configuration Options 13827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1383a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These constants are the available integer configuration options that 1384a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can be passed as the second argument to the [sqlite3_db_config()] interface. 13857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1386a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** New configuration options may be added in future releases of SQLite. 1387a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Existing configuration options might be discontinued. Applications 1388a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** should check the return code from [sqlite3_db_config()] to make sure that 1389a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the call worked. ^The [sqlite3_db_config()] interface will return a 1390a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** non-zero [error code] if a discontinued or unsupported configuration option 1391a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is invoked. 1392a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1393a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dl> 1394a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt> 1395a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^This option takes three additional arguments that determine the 1396a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [lookaside memory allocator] configuration for the [database connection]. 1397a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first argument (the third parameter to [sqlite3_db_config()] is a 1398a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pointer to an memory buffer to use for lookaside memory. 1399a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb 1400a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** may be NULL in which case SQLite will allocate the 1401a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the 1402a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** size of each lookaside buffer slot. ^The third argument is the number of 1403a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** slots. The size of the buffer in the first argument must be greater than 1404a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or equal to the product of the second and third arguments. The buffer 1405a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** must be aligned to an 8-byte boundary. ^If the second argument to 1406a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally 1407a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** rounded down to the next smaller 1408a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** multiple of 8. See also: [SQLITE_CONFIG_LOOKASIDE]</dd> 14097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1410a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dl> 1411a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 1412a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */ 1413a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1414a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1415a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 1416a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Enable Or Disable Extended Result Codes 14177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1418a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_extended_result_codes() routine enables or disables the 1419a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [extended result codes] feature of SQLite. ^The extended result 1420a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** codes are disabled by default for historical compatibility. 14217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 1422a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_extended_result_codes(sqlite3*, int onoff); 14237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 14247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1425a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Last Insert Rowid 14267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1427a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Each entry in an SQLite table has a unique 64-bit signed 1428a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** integer key called the [ROWID | "rowid"]. ^The rowid is always available 14297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** as an undeclared column named ROWID, OID, or _ROWID_ as long as those 1430a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** names are not also used by explicitly declared columns. ^If 1431a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the table has a column of type [INTEGER PRIMARY KEY] then that column 14327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is another alias for the rowid. 14337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1434a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This routine returns the [rowid] of the most recent 1435a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** successful [INSERT] into the database from the [database connection] 1436a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in the first argument. ^If no successful [INSERT]s 1437a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** have ever occurred on that database connection, zero is returned. 14387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1439a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(If an [INSERT] occurs within a trigger, then the [rowid] of the inserted 1440a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** row is returned by this routine as long as the trigger is running. 1441a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** But once the trigger terminates, the value returned by this routine 1442a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** reverts to the last value inserted before the trigger fired.)^ 14437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1444a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^An [INSERT] that fails due to a constraint violation is not a 1445a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** successful [INSERT] and does not change the value returned by this 1446a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK, 14477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and INSERT OR ABORT make no changes to the return value of this 1448a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routine when their insertion fails. ^(When INSERT OR REPLACE 14497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** encounters a constraint violation, it does not fail. The 14507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** INSERT continues to completion after deleting rows that caused 14517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the constraint problem so INSERT OR REPLACE will always change 1452a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the return value of this interface.)^ 14537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1454a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^For the purposes of this routine, an [INSERT] is considered to 14557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** be successful even if it is subsequently rolled back. 14567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1457a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This function is accessible to SQL statements via the 1458a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [last_insert_rowid() SQL function]. 14597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1460a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If a separate thread performs a new [INSERT] on the same 1461a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database connection while the [sqlite3_last_insert_rowid()] 1462a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function is running and thus changes the last insert [rowid], 1463a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the value returned by [sqlite3_last_insert_rowid()] is 1464a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** unpredictable and might not equal either the old or the new 1465a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** last insert [rowid]. 14667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 1467a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*); 14687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 14697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1470a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Count The Number Of Rows Modified 14717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1472a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This function returns the number of database rows that were changed 14737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or inserted or deleted by the most recently completed SQL statement 1474a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on the [database connection] specified by the first parameter. 1475a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Only changes that are directly specified by the [INSERT], [UPDATE], 1476a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [DELETE] statement are counted. Auxiliary changes caused by 1477a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** triggers or [foreign key actions] are not counted.)^ Use the 1478a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_total_changes()] function to find the total number of changes 1479a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** including changes caused by triggers and foreign key actions. 14807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1481a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Changes to a view that are simulated by an [INSTEAD OF trigger] 1482a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are not counted. Only real table changes are counted. 1483a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1484a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(A "row change" is a change to a single row of a single table 14857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** caused by an INSERT, DELETE, or UPDATE statement. Rows that 1486a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are changed as side effects of [REPLACE] constraint resolution, 1487a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** rollback, ABORT processing, [DROP TABLE], or by any other 1488a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** mechanisms do not count as direct row changes.)^ 14897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 14907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** A "trigger context" is a scope of execution that begins and 1491a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ends with the script of a [CREATE TRIGGER | trigger]. 1492a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Most SQL statements are 14937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** evaluated outside of any trigger. This is the "top level" 14947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** trigger context. If a trigger fires from the top level, a 14957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** new trigger context is entered for the duration of that one 14967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** trigger. Subtriggers create subcontexts for their duration. 14977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1498a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Calling [sqlite3_exec()] or [sqlite3_step()] recursively does 14997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** not create a new trigger context. 15007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1501a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This function returns the number of direct row changes in the 15027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** most recent INSERT, UPDATE, or DELETE statement within the same 15037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** trigger context. 15047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1505a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Thus, when called from the top level, this function returns the 15067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** number of changes in the most recent INSERT, UPDATE, or DELETE 1507a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that also occurred at the top level. ^(Within the body of a trigger, 1508a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the sqlite3_changes() interface can be called to find the number of 15097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** changes in the most recently completed INSERT, UPDATE, or DELETE 15107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** statement within the body of the same trigger. 1511a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** However, the number returned does not include changes 1512a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** caused by subtriggers since those have their own context.)^ 15137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1514a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also the [sqlite3_total_changes()] interface, the 1515a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [count_changes pragma], and the [changes() SQL function]. 15167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1517a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If a separate thread makes changes on the same database connection 1518a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** while [sqlite3_changes()] is running then the value returned 1519a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is unpredictable and not meaningful. 1520a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 1521a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_changes(sqlite3*); 1522a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1523a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 1524a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Total Number Of Rows Modified 1525a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1526a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This function returns the number of row changes caused by [INSERT], 1527a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [UPDATE] or [DELETE] statements since the [database connection] was opened. 1528a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The count returned by sqlite3_total_changes() includes all changes 1529a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from all [CREATE TRIGGER | trigger] contexts and changes made by 1530a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [foreign key actions]. However, 1531a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the count does not include changes used to implement [REPLACE] constraints, 1532a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** do rollbacks or ABORT processing, or [DROP TABLE] processing. The 1533a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** count does not include rows of views that fire an [INSTEAD OF trigger], 1534a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** though if the INSTEAD OF trigger makes changes of its own, those changes 1535a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are counted.)^ 1536a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_total_changes() function counts the changes as soon as 1537a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the statement that makes them is completed (when the statement handle 1538a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is passed to [sqlite3_reset()] or [sqlite3_finalize()]). 1539a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1540a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also the [sqlite3_changes()] interface, the 1541a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [count_changes pragma], and the [total_changes() SQL function]. 1542a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1543a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If a separate thread makes changes on the same database connection 1544a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** while [sqlite3_total_changes()] is running then the value 1545a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned is unpredictable and not meaningful. 15467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 1547a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_total_changes(sqlite3*); 15487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 15497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1550a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Interrupt A Long-Running Query 15517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1552a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This function causes any pending database operation to abort and 15537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** return at its earliest opportunity. This routine is typically 15547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** called in response to a user action such as pressing "Cancel" 15557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or Ctrl-C where the user wants a long query operation to halt 15567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** immediately. 15577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1558a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^It is safe to call this routine from a thread different from the 15597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** thread that is currently running the database operation. But it 1560a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not safe to call this routine with a [database connection] that 15617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is closed or might close before sqlite3_interrupt() returns. 15627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1563a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If an SQL operation is very nearly finished at the time when 1564a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_interrupt() is called, then it might not have an opportunity 1565a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to be interrupted and might continue to completion. 1566a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1567a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT]. 1568a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE 1569a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that is inside an explicit transaction, then the entire transaction 1570a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will be rolled back automatically. 1571a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1572a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_interrupt(D) call is in effect until all currently running 1573a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL statements on [database connection] D complete. ^Any new SQL statements 1574a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that are started after the sqlite3_interrupt() call and before the 1575a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** running statements reaches zero are interrupted as if they had been 1576a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** running prior to the sqlite3_interrupt() call. ^New SQL statements 1577a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that are started after the running statement count reaches zero are 1578a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not effected by the sqlite3_interrupt(). 1579a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A call to sqlite3_interrupt(D) that occurs when there are no running 1580a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL statements is a no-op and has no effect on SQL statements 1581a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that are started after the sqlite3_interrupt() call returns. 1582a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1583a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If the database connection closes while [sqlite3_interrupt()] 1584a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is running then bad things will likely happen. 15857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 1586a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_interrupt(sqlite3*); 15877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 15887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1589a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Determine If An SQL Statement Is Complete 15907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1591a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These routines are useful during command-line input to determine if the 1592a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** currently entered text seems to form a complete SQL statement or 15937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** if additional input is needed before sending the text into 1594a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite for parsing. ^These routines return 1 if the input string 1595a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** appears to be a complete SQL statement. ^A statement is judged to be 1596a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** complete if it ends with a semicolon token and is not a prefix of a 1597a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within 15987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** string literals or quoted identifier names or comments are not 15997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** independent tokens (they are part of the token in which they are 1600a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** embedded) and thus do not count as a statement terminator. ^Whitespace 1601a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and comments that follow the final semicolon are ignored. 16027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1603a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines return 0 if the statement is incomplete. ^If a 1604a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory allocation fails, then SQLITE_NOMEM is returned. 16057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1606a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines do not parse the SQL statements thus 1607a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will not detect syntactically incorrect SQL. 16087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1609a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior 1610a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked 1611a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** automatically by sqlite3_complete16(). If that initialization fails, 1612a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the return value from sqlite3_complete16() will be non-zero 1613a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** regardless of whether or not the input SQL is complete.)^ 16147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1615a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The input to [sqlite3_complete()] must be a zero-terminated 1616a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** UTF-8 string. 16177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1618a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The input to [sqlite3_complete16()] must be a zero-terminated 1619a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** UTF-16 string in native byte order. 16207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 1621a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_complete(const char *sql); 1622a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_complete16(const void *sql); 16237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 16247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1625a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors 1626a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1627a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This routine sets a callback function that might be invoked whenever 1628a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an attempt is made to open a database table that another thread 1629a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or process has locked. 16307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1631a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the busy callback is NULL, then [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] 1632a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is returned immediately upon encountering the lock. ^If the busy callback 1633a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not NULL, then the callback might be invoked with two arguments. 1634a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1635a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first argument to the busy handler is a copy of the void* pointer which 1636a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is the third argument to sqlite3_busy_handler(). ^The second argument to 1637a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the busy handler callback is the number of times that the busy handler has 1638a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** been invoked for this locking event. ^If the 16397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** busy callback returns 0, then no additional attempts are made to 16407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned. 1641a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the callback returns non-zero, then another attempt 16427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is made to open the database for reading and the cycle repeats. 16437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1644a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The presence of a busy handler does not guarantee that it will be invoked 1645a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** when there is lock contention. ^If SQLite determines that invoking the busy 1646a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY] 1647a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [SQLITE_IOERR_BLOCKED] instead of invoking the busy handler. 16487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Consider a scenario where one process is holding a read lock that 16497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** it is trying to promote to a reserved lock and 16507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a second process is holding a reserved lock that it is trying 16517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to promote to an exclusive lock. The first process cannot proceed 16527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** because it is blocked by the second and the second process cannot 16537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** proceed because it is blocked by the first. If both processes 16547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** invoke the busy handlers, neither will make any progress. Therefore, 16557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLite returns [SQLITE_BUSY] for the first process, hoping that this 16567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** will induce the first process to release its read lock and allow 16577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the second process to proceed. 16587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1659a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The default busy callback is NULL. 16607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1661a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED] 16627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** when SQLite is in the middle of a large transaction where all the 16637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** changes will not fit into the in-memory cache. SQLite will 16647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** already hold a RESERVED lock on the database file, but it needs 16657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to promote this lock to EXCLUSIVE so that it can spill cache 16667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** pages into the database file without harm to concurrent 1667a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** readers. ^If it is unable to promote the lock, then the in-memory 16687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** cache will be left in an inconsistent state and so the error 16697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** code is promoted from the relatively benign [SQLITE_BUSY] to 1670a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the more severe [SQLITE_IOERR_BLOCKED]. ^This error code promotion 16717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** forces an automatic rollback of the changes. See the 1672a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <a href="/cvstrac/wiki?p=CorruptionFollowingBusyError"> 16737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** CorruptionFollowingBusyError</a> wiki page for a discussion of why 16747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** this is important. 16757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1676a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(There can only be a single busy handler defined for each 1677a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection]. Setting a new busy handler clears any 1678a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()] 1679a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will also set or clear the busy handler. 16807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1681a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The busy callback should not take any actions which modify the 1682a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database connection that invoked the busy handler. Any such actions 1683a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** result in undefined behavior. 1684a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1685a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A busy handler must not close the database connection 1686a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [prepared statement] that invoked the busy handler. 16877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 1688a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*); 16897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 16907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1691a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Set A Busy Timeout 16927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1693a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps 1694a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for a specified amount of time when a table is locked. ^The handler 1695a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will sleep multiple times until at least "ms" milliseconds of sleeping 1696a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** have accumulated. ^After at least "ms" milliseconds of sleeping, 1697a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the handler returns 0 which causes [sqlite3_step()] to return 1698a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED]. 16997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1700a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Calling this routine with an argument less than or equal to zero 17017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** turns off all busy handlers. 17027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1703a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(There can only be a single busy handler for a particular 1704a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection] any any given moment. If another busy handler 1705a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** was defined (using [sqlite3_busy_handler()]) prior to calling 1706a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** this routine, that other busy handler is cleared.)^ 17077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 1708a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms); 17097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 17107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1711a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Convenience Routines For Running Queries 17127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 17137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Definition: A <b>result table</b> is memory data structure created by the 17147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_get_table()] interface. A result table records the 17157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** complete query results from one or more queries. 17167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 17177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The table conceptually has a number of rows and columns. But 17187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** these numbers are not part of the result table itself. These 17197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** numbers are obtained separately. Let N be the number of rows 17207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and M be the number of columns. 17217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1722a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A result table is an array of pointers to zero-terminated UTF-8 strings. 1723a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** There are (N+1)*M elements in the array. The first M pointers point 1724a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to zero-terminated strings that contain the names of the columns. 1725a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The remaining entries all point to query results. NULL values result 1726a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in NULL pointers. All other values are in their UTF-8 zero-terminated 1727a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** string representation as returned by [sqlite3_column_text()]. 17287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1729a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A result table might consist of one or more memory allocations. 17307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** It is not safe to pass a result table directly to [sqlite3_free()]. 17317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** A result table should be deallocated using [sqlite3_free_table()]. 17327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 17337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** As an example of the result table format, suppose a query result 17347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is as follows: 17357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 17367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote><pre> 17377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Name | Age 17387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** ----------------------- 17397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Alice | 43 17407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Bob | 28 17417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Cindy | 21 17427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </pre></blockquote> 17437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 17447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** There are two column (M==2) and three rows (N==3). Thus the 17457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** result table has 8 entries. Suppose the result table is stored 17467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** in an array names azResult. Then azResult holds this content: 17477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 17487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote><pre> 17497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[0] = "Name"; 17507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[1] = "Age"; 17517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[2] = "Alice"; 17527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[3] = "43"; 17537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[4] = "Bob"; 17547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[5] = "28"; 17557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[6] = "Cindy"; 17567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[7] = "21"; 17577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </pre></blockquote> 17587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1759a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_get_table() function evaluates one or more 17607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** semicolon-separated SQL statements in the zero-terminated UTF-8 1761a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** string of its 2nd parameter and returns a result table to the 17627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** pointer given in its 3rd parameter. 17637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1764a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** After the application has finished with the result from sqlite3_get_table(), 1765a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it should pass the result table pointer to sqlite3_free_table() in order to 1766a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** release the memory that was malloced. Because of the way the 17677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling 1768a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function must not try to call [sqlite3_free()] directly. Only 17697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_free_table()] is able to release the memory properly and safely. 17707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1771a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The sqlite3_get_table() interface is implemented as a wrapper around 17727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access 17737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to any internal data structures of SQLite. It uses only the public 17747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface defined here. As a consequence, errors that occur in the 17757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** wrapper layer outside of the internal [sqlite3_exec()] call are not 17767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** reflected in subsequent calls to [sqlite3_errcode()] or 1777a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_errmsg()].)^ 1778a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 1779a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_get_table( 1780a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori sqlite3 *db, /* An open database */ 1781a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori const char *zSql, /* SQL to be evaluated */ 1782a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori char ***pazResult, /* Results of the query */ 1783a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int *pnRow, /* Number of result rows written here */ 1784a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int *pnColumn, /* Number of result columns written here */ 1785a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori char **pzErrmsg /* Error msg written here */ 17867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 1787a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_free_table(char **result); 17887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 17897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1790a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Formatted String Printing Functions 17917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1792a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These routines are work-alikes of the "printf()" family of functions 17937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** from the standard C library. 17947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1795a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their 17967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** results into memory obtained from [sqlite3_malloc()]. 17977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The strings returned by these two routines should be 1798a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** released by [sqlite3_free()]. ^Both routines return a 17997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** NULL pointer if [sqlite3_malloc()] is unable to allocate enough 18007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** memory to hold the resulting string. 18017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1802a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(In sqlite3_snprintf() routine is similar to "snprintf()" from 18037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the standard C library. The result is written into the 18047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** buffer supplied as the second parameter whose size is given by 18057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the first parameter. Note that the order of the 1806a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** first two parameters is reversed from snprintf().)^ This is an 18077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** historical accident that cannot be fixed without breaking 1808a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** backwards compatibility. ^(Note also that sqlite3_snprintf() 18097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** returns a pointer to its buffer instead of the number of 1810a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** characters actually written into the buffer.)^ We admit that 18117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the number of characters written would be a more useful return 18127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** value but we cannot change the implementation of sqlite3_snprintf() 18137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** now without breaking compatibility. 18147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1815a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^As long as the buffer size is greater than zero, sqlite3_snprintf() 1816a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** guarantees that the buffer is always zero-terminated. ^The first 18177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** parameter "n" is the total size of the buffer, including space for 18187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the zero terminator. So the longest string that can be completely 18197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** written will be n-1 characters. 18207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 18217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These routines all implement some additional formatting 18227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** options that are useful for constructing SQL statements. 1823a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** All of the usual printf() formatting options apply. In addition, there 18247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is are "%q", "%Q", and "%z" options. 18257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1826a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The %q option works like %s in that it substitutes a null-terminated 18277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** string from the argument list. But %q also doubles every '\'' character. 1828a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** %q is designed for use inside a string literal.)^ By doubling each '\'' 18297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** character it escapes that character and allows it to be inserted into 18307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the string. 18317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1832a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** For example, assume the string variable zText contains text as follows: 18337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 18347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote><pre> 18357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** char *zText = "It's a happy day!"; 18367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </pre></blockquote> 18377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 18387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** One can use this text in an SQL statement as follows: 18397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 18407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote><pre> 18417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText); 18427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_exec(db, zSQL, 0, 0, 0); 18437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_free(zSQL); 18447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </pre></blockquote> 18457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 18467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Because the %q format string is used, the '\'' character in zText 18477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is escaped and the SQL generated is as follows: 18487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 18497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote><pre> 18507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** INSERT INTO table1 VALUES('It''s a happy day!') 18517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </pre></blockquote> 18527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 18537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** This is correct. Had we used %s instead of %q, the generated SQL 18547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** would have looked like this: 18557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 18567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote><pre> 18577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** INSERT INTO table1 VALUES('It's a happy day!'); 18587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </pre></blockquote> 18597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1860a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This second example is an SQL syntax error. As a general rule you should 1861a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** always use %q instead of %s when inserting text into a string literal. 18627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1863a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The %Q option works like %q except it also adds single quotes around 1864a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the outside of the total string. Additionally, if the parameter in the 1865a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** argument list is a NULL pointer, %Q substitutes the text "NULL" (without 1866a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** single quotes).)^ So, for example, one could say: 18677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 18687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote><pre> 18697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText); 18707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_exec(db, zSQL, 0, 0, 0); 18717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_free(zSQL); 18727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </pre></blockquote> 18737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 18747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The code above will render a correct SQL statement in the zSQL 18757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** variable even if the zText variable is a NULL pointer. 18767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1877a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The "%z" formatting option works like "%s" but with the 18787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** addition that after the string has been read and copied into 1879a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the result, [sqlite3_free()] is called on the input string.)^ 18807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 1881a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API char *sqlite3_mprintf(const char*,...); 1882a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API char *sqlite3_vmprintf(const char*, va_list); 1883a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API char *sqlite3_snprintf(int,char*,const char*, ...); 18847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 18857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1886a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Memory Allocation Subsystem 18877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1888a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The SQLite core uses these three routines for all of its own 18897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** internal memory allocation needs. "Core" in the previous sentence 18907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** does not include operating-system specific VFS implementation. The 1891a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Windows VFS uses native malloc() and free() for some operations. 18927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1893a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_malloc() routine returns a pointer to a block 18947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of memory at least N bytes in length, where N is the parameter. 1895a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_malloc() is unable to obtain sufficient free 1896a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory, it returns a NULL pointer. ^If the parameter N to 18977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns 18987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a NULL pointer. 18997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1900a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Calling sqlite3_free() with a pointer previously returned 19017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** by sqlite3_malloc() or sqlite3_realloc() releases that memory so 1902a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that it might be reused. ^The sqlite3_free() routine is 19037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a no-op if is called with a NULL pointer. Passing a NULL pointer 19047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to sqlite3_free() is harmless. After being freed, memory 19057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** should neither be read nor written. Even reading previously freed 19067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** memory might result in a segmentation fault or other severe error. 19077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Memory corruption, a segmentation fault, or other severe error 19087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** might result if sqlite3_free() is called with a non-NULL pointer that 1909a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** was not obtained from sqlite3_malloc() or sqlite3_realloc(). 19107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1911a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The sqlite3_realloc() interface attempts to resize a 19127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** prior memory allocation to be at least N bytes, where N is the 19137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** second parameter. The memory allocation to be resized is the first 1914a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter.)^ ^ If the first parameter to sqlite3_realloc() 19157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is a NULL pointer then its behavior is identical to calling 19167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc(). 1917a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the second parameter to sqlite3_realloc() is zero or 19187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** negative then the behavior is exactly the same as calling 19197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_free(P) where P is the first parameter to sqlite3_realloc(). 1920a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^sqlite3_realloc() returns a pointer to a memory allocation 19217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of at least N bytes in size or NULL if sufficient memory is unavailable. 1922a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If M is the size of the prior allocation, then min(N,M) bytes 19237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of the prior allocation are copied into the beginning of buffer returned 19247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** by sqlite3_realloc() and the prior allocation is freed. 1925a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_realloc() returns NULL, then the prior allocation 19267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is not freed. 19277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1928a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The memory returned by sqlite3_malloc() and sqlite3_realloc() 1929a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is always aligned to at least an 8 byte boundary. 19307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 19317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** In SQLite version 3.5.0 and 3.5.1, it was possible to define 19327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in 19337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** implementation of these routines to be omitted. That capability 1934a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is no longer provided. Only built-in memory allocators can be used. 19357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1936a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The Windows OS interface layer calls 19377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the system malloc() and free() directly when converting 19387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** filenames between the UTF-8 encoding used by SQLite 1939a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and whatever filename encoding is used by the particular Windows 19407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** installation. Memory allocation errors are detected, but 19417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** they are reported back as [SQLITE_CANTOPEN] or 19427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_IOERR] rather than [SQLITE_NOMEM]. 19437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1944a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()] 1945a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** must be either NULL or else pointers obtained from a prior 1946a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have 1947a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not yet been released. 19487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1949a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The application must not read or write any part of 1950a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a block of memory after it has been released using 1951a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_free()] or [sqlite3_realloc()]. 19527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 1953a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void *sqlite3_malloc(int); 1954a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void *sqlite3_realloc(void*, int); 1955a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_free(void*); 19567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 19577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1958a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Memory Allocator Statistics 19597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 19607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLite provides these two interfaces for reporting on the status 19617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()] 1962a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routines, which form the built-in memory allocation subsystem. 1963a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1964a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_memory_used()] routine returns the number of bytes 1965a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of memory currently outstanding (malloced but not freed). 1966a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_memory_highwater()] routine returns the maximum 1967a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value of [sqlite3_memory_used()] since the high-water mark 1968a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** was last reset. ^The values returned by [sqlite3_memory_used()] and 1969a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_memory_highwater()] include any overhead 1970a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** added by SQLite in its implementation of [sqlite3_malloc()], 1971a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** but not overhead added by the any underlying system library 1972a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routines that [sqlite3_malloc()] may call. 1973a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1974a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The memory high-water mark is reset to the current value of 1975a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_memory_used()] if and only if the parameter to 1976a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_memory_highwater()] is true. ^The value returned 1977a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by [sqlite3_memory_highwater(1)] is the high-water mark 1978a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** prior to the reset. 19797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 1980a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3_int64 sqlite3_memory_used(void); 1981a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag); 19827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 19837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1984a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Pseudo-Random Number Generator 19857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 19867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLite contains a high-quality pseudo-random number generator (PRNG) used to 1987a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** select random [ROWID | ROWIDs] when inserting new records into a table that 1988a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** already uses the largest possible [ROWID]. The PRNG is also used for 19897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the build-in random() and randomblob() SQL functions. This interface allows 1990a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** applications to access the same PRNG for other purposes. 19917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1992a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A call to this routine stores N bytes of randomness into buffer P. 19937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1994a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first time this routine is invoked (either internally or by 19957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the application) the PRNG is seeded using randomness obtained 19967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** from the xRandomness method of the default [sqlite3_vfs] object. 1997a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^On all subsequent invocations, the pseudo-randomness is generated 19987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** internally and without recourse to the [sqlite3_vfs] xRandomness 19997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** method. 20007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2001a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_randomness(int N, void *P); 20027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 20037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2004a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Compile-Time Authorization Callbacks 20057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2006a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This routine registers a authorizer callback with a particular 20077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [database connection], supplied in the first argument. 2008a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The authorizer callback is invoked as SQL statements are being compiled 20097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()], 2010a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. ^At various 20117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** points during the compilation process, as logic is being created 20127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to perform various actions, the authorizer callback is invoked to 2013a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** see if those actions are allowed. ^The authorizer callback should 20147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the 20157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** specific action but allow the SQL statement to continue to be 20167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be 2017a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** rejected with an error. ^If the authorizer callback returns 20187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY] 2019a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the [sqlite3_prepare_v2()] or equivalent call that triggered 20207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the authorizer will fail with an error message. 20217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 20227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** When the callback returns [SQLITE_OK], that means the operation 2023a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** requested is ok. ^When the callback returns [SQLITE_DENY], the 20247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_prepare_v2()] or equivalent call that triggered the 20257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** authorizer will fail with an error message explaining that 2026a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** access is denied. 2027a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2028a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first parameter to the authorizer callback is a copy of the third 2029a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter to the sqlite3_set_authorizer() interface. ^The second parameter 2030a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the callback is an integer [SQLITE_COPY | action code] that specifies 2031a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the particular action to be authorized. ^The third through sixth parameters 2032a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the callback are zero-terminated strings that contain additional 2033a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** details about the action to be authorized. 2034a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2035a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the action code is [SQLITE_READ] 20367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and the callback returns [SQLITE_IGNORE] then the 20377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [prepared statement] statement is constructed to substitute 20387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a NULL value in place of the table column that would have 20397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE] 20407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** return can be used to deny an untrusted user access to individual 20417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** columns of a table. 2042a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the action code is [SQLITE_DELETE] and the callback returns 2043a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the 2044a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [truncate optimization] is disabled and all rows are deleted individually. 20457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 20467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** An authorizer is used when [sqlite3_prepare | preparing] 2047a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL statements from an untrusted source, to ensure that the SQL statements 2048a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** do not try to access data they are not allowed to see, or that they do not 2049a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** try to execute malicious statements that damage the database. For 20507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** example, an application may allow a user to enter arbitrary 20517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQL queries for evaluation by a database. But the application does 20527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** not want the user to be able to make arbitrary changes to the 20537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** database. An authorizer could then be put in place while the 20547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** user-entered SQL is being [sqlite3_prepare | prepared] that 20557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** disallows everything except [SELECT] statements. 20567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 20577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Applications that need to process SQL from untrusted sources 20587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** might also consider lowering resource limits using [sqlite3_limit()] 20597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and limiting database size using the [max_page_count] [PRAGMA] 20607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** in addition to using an authorizer. 20617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2062a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Only a single authorizer can be in place on a database connection 20637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** at a time. Each call to sqlite3_set_authorizer overrides the 2064a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** previous call.)^ ^Disable the authorizer by installing a NULL callback. 20657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The authorizer is disabled by default. 20667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2067a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The authorizer callback must not do anything that will modify 2068a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the database connection that invoked the authorizer callback. 2069a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 2070a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database connections for the meaning of "modify" in this paragraph. 20717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2072a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the 2073a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** statement might be re-prepared during [sqlite3_step()] due to a 2074a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** schema change. Hence, the application should ensure that the 2075a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** correct authorizer callback remains in place during the [sqlite3_step()]. 20767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2077a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Note that the authorizer callback is invoked only during 2078a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_prepare()] or its variants. Authorization is not 2079a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** performed during statement evaluation in [sqlite3_step()], unless 2080a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** as stated in the previous paragraph, sqlite3_step() invokes 2081a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_prepare_v2() to reprepare a statement after a schema change. 20827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2083a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_set_authorizer( 20847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 20857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xAuth)(void*,int,const char*,const char*,const char*,const char*), 20867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void *pUserData 20877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 20887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 20897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2090a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Authorizer Return Codes 20917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 20927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The [sqlite3_set_authorizer | authorizer callback function] must 20937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** return either [SQLITE_OK] or one of these two constants in order 20947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to signal SQLite whether or not the action is permitted. See the 20957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_set_authorizer | authorizer documentation] for additional 20967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** information. 20977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 20987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DENY 1 /* Abort the SQL statement with an error */ 20997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */ 21007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 21017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2102a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Authorizer Action Codes 21037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 21047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The [sqlite3_set_authorizer()] interface registers a callback function 2105a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that is invoked to authorize certain SQL statement actions. The 21067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** second parameter to the callback is an integer code that specifies 21077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** what action is being authorized. These are the integer action codes that 21087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the authorizer callback may be passed. 21097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2110a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These action code values signify what kind of operation is to be 21117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** authorized. The 3rd and 4th parameters to the authorization 21127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** callback function will be parameters or NULL depending on which of these 2113a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** codes is used as the second parameter. ^(The 5th parameter to the 2114a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** authorizer callback is the name of the database ("main", "temp", 2115a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** etc.) if applicable.)^ ^The 6th parameter to the authorizer callback 21167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is the name of the inner-most trigger or view that is responsible for 2117a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the access attempt or NULL if this access attempt is directly from 21187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** top-level SQL code. 21197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 21207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/******************************************* 3rd ************ 4th ***********/ 21217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */ 21227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */ 21237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */ 21247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */ 21257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */ 21267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */ 21277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */ 21287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_VIEW 8 /* View Name NULL */ 21297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DELETE 9 /* Table Name NULL */ 21307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */ 21317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_TABLE 11 /* Table Name NULL */ 21327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */ 21337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */ 21347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */ 21357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */ 21367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */ 21377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_VIEW 17 /* View Name NULL */ 21387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INSERT 18 /* Table Name NULL */ 21397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */ 21407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_READ 20 /* Table Name Column Name */ 21417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_SELECT 21 /* NULL NULL */ 2142a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TRANSACTION 22 /* Operation NULL */ 21437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_UPDATE 23 /* Table Name Column Name */ 21447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ATTACH 24 /* Filename NULL */ 21457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DETACH 25 /* Database Name NULL */ 21467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */ 21477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_REINDEX 27 /* Index Name NULL */ 21487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ANALYZE 28 /* Table Name NULL */ 21497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */ 21507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */ 2151a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_FUNCTION 31 /* NULL Function Name */ 2152a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */ 21537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_COPY 0 /* No longer used */ 21547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 21557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2156a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Tracing And Profiling Functions 21577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 21587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These routines register callback functions that can be used for 21597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** tracing and profiling the execution of SQL statements. 21607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2161a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The callback function registered by sqlite3_trace() is invoked at 21627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** various times when an SQL statement is being run by [sqlite3_step()]. 2163a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the 2164a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL statement text as the statement first begins executing. 2165a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Additional sqlite3_trace() callbacks might occur 2166a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** as each triggered subprogram is entered. The callbacks for triggers 2167a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** contain a UTF-8 SQL comment that identifies the trigger.)^ 2168a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2169a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The callback function registered by sqlite3_profile() is invoked 2170a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** as each SQL statement finishes. ^The profile callback contains 21717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the original statement text and an estimate of wall-clock time 21727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of how long that statement took to run. 21737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 217471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*); 2175a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API SQLITE_EXPERIMENTAL void *sqlite3_profile(sqlite3*, 21767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void(*xProfile)(void*,const char*,sqlite3_uint64), void*); 21777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 21787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2179a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Query Progress Callbacks 21807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2181a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This routine configures a callback function - the 21827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** progress callback - that is invoked periodically during long 21837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** running calls to [sqlite3_exec()], [sqlite3_step()] and 2184a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_get_table()]. An example use for this 21857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface is to keep a GUI updated during a large query. 21867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2187a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the progress callback returns non-zero, the operation is 21887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interrupted. This feature can be used to implement a 2189a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** "Cancel" button on a GUI progress dialog box. 21907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2191a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The progress handler must not do anything that will modify 2192a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the database connection that invoked the progress handler. 2193a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 2194a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database connections for the meaning of "modify" in this paragraph. 21957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 21967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2197a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*); 21987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 21997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2200a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Opening A New Database Connection 2201a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2202a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines open an SQLite database file whose name is given by the 2203a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** filename argument. ^The filename argument is interpreted as UTF-8 for 2204a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte 2205a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** order for sqlite3_open16(). ^(A [database connection] handle is usually 2206a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned in *ppDb, even if an error occurs. The only exception is that 2207a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** if SQLite is unable to allocate memory to hold the [sqlite3] object, 2208a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a NULL will be written into *ppDb instead of a pointer to the [sqlite3] 2209a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** object.)^ ^(If the database is opened (and/or created) successfully, then 2210a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The 2211a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain 2212a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an English language description of the error following a failure of any 2213a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the sqlite3_open() routines. 2214a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2215a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The default encoding for the database will be UTF-8 if 2216a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_open() or sqlite3_open_v2() is called and 2217a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** UTF-16 in the native byte order if sqlite3_open16() is used. 22187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 22197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Whether or not an error occurs when it is opened, resources 2220a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** associated with the [database connection] handle should be released by 2221a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** passing it to [sqlite3_close()] when it is no longer required. 22227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2223a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_open_v2() interface works like sqlite3_open() 2224a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** except that it accepts two additional parameters for additional control 2225a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** over the new database connection. ^(The flags parameter to 2226a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_open_v2() can take one of 2227a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the following three values, optionally combined with the 2228a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], [SQLITE_OPEN_SHAREDCACHE], 2229a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and/or [SQLITE_OPEN_PRIVATECACHE] flags:)^ 22307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2231a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dl> 2232a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>[SQLITE_OPEN_READONLY]</dt> 2233a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The database is opened in read-only mode. If the database does not 2234a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** already exist, an error is returned.</dd>)^ 2235a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2236a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>[SQLITE_OPEN_READWRITE]</dt> 2237a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The database is opened for reading and writing if possible, or reading 2238a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** only if the file is write protected by the operating system. In either 2239a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** case the database must already exist, otherwise an error is returned.</dd>)^ 2240a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2241a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt> 2242a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The database is opened for reading and writing, and is creates it if 2243a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it does not already exist. This is the behavior that is always used for 2244a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_open() and sqlite3_open16().</dd>)^ 2245a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dl> 2246a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2247a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If the 3rd parameter to sqlite3_open_v2() is not one of the 2248a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** combinations shown above or one of the combinations shown above combined 2249a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with the [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], 2250a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_OPEN_SHAREDCACHE] and/or [SQLITE_OPEN_SHAREDCACHE] flags, 2251a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the behavior is undefined. 22527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2253a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection 2254a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** opens in the multi-thread [threading mode] as long as the single-thread 2255a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** mode has not been set at compile-time or start-time. ^If the 2256a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens 2257a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in the serialized [threading mode] unless single-thread was 2258a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** previously selected at compile-time or start-time. 2259a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [SQLITE_OPEN_SHAREDCACHE] flag causes the database connection to be 2260a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** eligible to use [shared cache mode], regardless of whether or not shared 2261a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** cache is enabled using [sqlite3_enable_shared_cache()]. ^The 2262a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_OPEN_PRIVATECACHE] flag causes the database connection to not 2263a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** participate in [shared cache mode] even if it is enabled. 2264a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2265a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the filename is ":memory:", then a private, temporary in-memory database 2266a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is created for the connection. ^This in-memory database will vanish when 2267a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the database connection is closed. Future versions of SQLite might 2268a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** make use of additional special filenames that begin with the ":" character. 2269a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** It is recommended that when a database filename actually does begin with 2270a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a ":" character you should prefix the filename with a pathname such as 2271a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** "./" to avoid ambiguity. 2272a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2273a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the filename is an empty string, then a private, temporary 2274a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on-disk database will be created. ^This private database will be 22757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** automatically deleted as soon as the database connection is closed. 22767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2277a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The fourth parameter to sqlite3_open_v2() is the name of the 2278a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_vfs] object that defines the operating system interface that 2279a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the new database connection should use. ^If the fourth parameter is 2280a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a NULL pointer then the default [sqlite3_vfs] object is used. 22817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2282a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <b>Note to Windows users:</b> The encoding used for the filename argument 2283a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever 22847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** codepage is currently defined. Filenames containing international 22857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** characters must be converted to UTF-8 prior to passing them into 2286a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_open() or sqlite3_open_v2(). 22877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2288a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_open( 22897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *filename, /* Database filename (UTF-8) */ 22907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 **ppDb /* OUT: SQLite db handle */ 22917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 2292a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_open16( 22937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void *filename, /* Database filename (UTF-16) */ 22947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 **ppDb /* OUT: SQLite db handle */ 22957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 2296a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_open_v2( 22977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *filename, /* Database filename (UTF-8) */ 22987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 **ppDb, /* OUT: SQLite db handle */ 22997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int flags, /* Flags */ 23007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zVfs /* Name of VFS module to use */ 23017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 23027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 23037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2304a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Error Codes And Messages 2305a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2306a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_errcode() interface returns the numeric [result code] or 2307a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [extended result code] for the most recent failed sqlite3_* API call 2308a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** associated with a [database connection]. If a prior API call failed 2309a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** but the most recent API call succeeded, the return value from 2310a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_errcode() is undefined. ^The sqlite3_extended_errcode() 2311a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interface is the same except that it always returns the 2312a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [extended result code] even when extended result codes are 2313a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** disabled. 2314a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2315a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language 2316a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** text that describes the error, as either UTF-8 or UTF-16 respectively. 2317a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Memory to hold the error message string is managed internally. 2318a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The application does not need to worry about freeing the result. 23197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** However, the error string might be overwritten or deallocated by 2320a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** subsequent calls to other SQLite interface functions.)^ 2321a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2322a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When the serialized [threading mode] is in use, it might be the 2323a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** case that a second error occurs on a separate thread in between 2324a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the time of the first error and the call to these interfaces. 2325a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When that happens, the second error will be reported since these 2326a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces always report the most recent result. To avoid 2327a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** this, each thread can obtain exclusive use of the [database connection] D 2328a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning 2329a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after 2330a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** all calls to the interfaces listed here are completed. 2331a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2332a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If an interface fails with SQLITE_MISUSE, that means the interface 2333a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** was invoked incorrectly by the application. In that case, the 2334a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** error code and message may or may not be set. 23357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2336a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_errcode(sqlite3 *db); 2337a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_extended_errcode(sqlite3 *db); 2338a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const char *sqlite3_errmsg(sqlite3*); 2339a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_errmsg16(sqlite3*); 23407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 23417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2342a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: SQL Statement Object 23437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** KEYWORDS: {prepared statement} {prepared statements} 23447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2345a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** An instance of this object represents a single SQL statement. 2346a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This object is variously known as a "prepared statement" or a 23477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** "compiled SQL statement" or simply as a "statement". 2348a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 23497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The life of a statement object goes something like this: 23507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 23517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ol> 23527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> Create the object using [sqlite3_prepare_v2()] or a related 23537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** function. 2354a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> Bind values to [host parameters] using the sqlite3_bind_*() 2355a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces. 23567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> Run the SQL by calling [sqlite3_step()] one or more times. 23577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> Reset the statement using [sqlite3_reset()] then go back 23587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to step 2. Do this zero or more times. 23597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> Destroy the object using [sqlite3_finalize()]. 23607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </ol> 23617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 23627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Refer to documentation on individual methods above for additional 23637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** information. 23647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 23657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_stmt sqlite3_stmt; 23667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 23677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2368a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Run-time Limits 23697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2370a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This interface allows the size of various constructs to be limited 23717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** on a connection by connection basis. The first parameter is the 23727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [database connection] whose limit is to be set or queried. The 23737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** second parameter is one of the [limit categories] that define a 23747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** class of constructs to be size limited. The third parameter is the 2375a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** new limit for that construct. The function returns the old limit.)^ 2376a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2377a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the new limit is a negative number, the limit is unchanged. 2378a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(For the limit category of SQLITE_LIMIT_XYZ there is a 2379a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [limits | hard upper bound] 2380a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** set by a compile-time C preprocessor macro named 2381a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [limits | SQLITE_MAX_XYZ]. 2382a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (The "_LIMIT_" in the name is changed to "_MAX_".))^ 2383a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Attempts to increase a limit above its hard upper bound are 2384a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** silently truncated to the hard upper bound. 2385a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2386a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Run-time limits are intended for use in applications that manage 23877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** both their own internal database and also databases that are controlled 23887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** by untrusted external sources. An example application might be a 2389a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** web browser that has its own databases for storing history and 2390a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** separate databases controlled by JavaScript applications downloaded 2391a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** off the Internet. The internal databases can be given the 23927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** large, default limits. Databases managed by external sources can 23937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** be given much smaller limits designed to prevent a denial of service 2394a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** attack. Developers might also want to use the [sqlite3_set_authorizer()] 23957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface to further control untrusted SQL. The size of the database 23967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** created by an untrusted script can be contained using the 23977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [max_page_count] [PRAGMA]. 23987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2399a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** New run-time limit categories may be added in future releases. 24007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2401a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal); 24027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 24037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2404a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Run-Time Limit Categories 2405a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {limit category} {*limit categories} 2406a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2407a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These constants define various performance limits 2408a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that can be lowered at run-time using [sqlite3_limit()]. 2409a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The synopsis of the meanings of the various limits is shown below. 2410a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Additional information is available at [limits | Limits in SQLite]. 24117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 24127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <dl> 2413a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_LIMIT_LENGTH</dt> 2414a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The maximum size of any string or BLOB or table row.<dd>)^ 24157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2416a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_LIMIT_SQL_LENGTH</dt> 2417a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The maximum length of an SQL statement, in bytes.</dd>)^ 24187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2419a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_LIMIT_COLUMN</dt> 24207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <dd>The maximum number of columns in a table definition or in the 2421a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** result set of a [SELECT] or the maximum number of columns in an index 2422a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or in an ORDER BY or GROUP BY clause.</dd>)^ 24237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2424a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_LIMIT_EXPR_DEPTH</dt> 2425a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The maximum depth of the parse tree on any expression.</dd>)^ 24267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2427a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_LIMIT_COMPOUND_SELECT</dt> 2428a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^ 24297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2430a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_LIMIT_VDBE_OP</dt> 24317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <dd>The maximum number of instructions in a virtual machine program 2432a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** used to implement an SQL statement.</dd>)^ 24337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2434a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt> 2435a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The maximum number of arguments on a function.</dd>)^ 24367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2437a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_LIMIT_ATTACHED</dt> 2438a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The maximum number of [ATTACH | attached databases].)^</dd> 24397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2440a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt> 2441a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The maximum length of the pattern argument to the [LIKE] or 2442a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [GLOB] operators.</dd>)^ 24437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2444a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt> 24457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <dd>The maximum number of variables in an SQL statement that can 2446a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** be bound.</dd>)^ 2447a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2448a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt> 2449a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The maximum depth of recursion for triggers.</dd>)^ 24507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </dl> 24517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 24527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_LENGTH 0 24537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_SQL_LENGTH 1 24547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_COLUMN 2 24557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_EXPR_DEPTH 3 24567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_COMPOUND_SELECT 4 24577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_VDBE_OP 5 24587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_FUNCTION_ARG 6 24597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_ATTACHED 7 24607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8 24617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_VARIABLE_NUMBER 9 2462a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_LIMIT_TRIGGER_DEPTH 10 24637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 24647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2465a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Compiling An SQL Statement 2466a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {SQL statement compiler} 24677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 24687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** To execute an SQL query, it must first be compiled into a byte-code 2469a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** program using one of these routines. 24707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2471a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The first argument, "db", is a [database connection] obtained from a 2472a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or 2473a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_open16()]. The database connection must not have been closed. 2474a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2475a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The second argument, "zSql", is the statement to be compiled, encoded 24767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2() 2477a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2() 2478a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** use UTF-16. 2479a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2480a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the nByte argument is less than zero, then zSql is read up to the 2481a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** first zero terminator. ^If nByte is non-negative, then it is the maximum 2482a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** number of bytes read from zSql. ^When nByte is non-negative, the 2483a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** zSql string ends at either the first '\000' or '\u0000' character or 24847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the nByte-th byte, whichever comes first. If the caller knows 24857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** that the supplied string is nul-terminated, then there is a small 2486a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** performance advantage to be gained by passing an nByte parameter that 2487a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is equal to the number of bytes in the input string <i>including</i> 2488a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the nul-terminator bytes. 2489a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2490a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If pzTail is not NULL then *pzTail is made to point to the first byte 2491a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** past the end of the first SQL statement in zSql. These routines only 2492a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** compile the first statement in zSql, so *pzTail is left pointing to 2493a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** what remains uncompiled. 2494a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2495a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^*ppStmt is left pointing to a compiled [prepared statement] that can be 2496a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set 2497a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to NULL. ^If the input text contains no SQL (if the input is an empty 2498a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** string or a comment) then *ppStmt is set to NULL. 2499a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The calling procedure is responsible for deleting the compiled 2500a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL statement using [sqlite3_finalize()] after it has finished with it. 2501a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ppStmt may not be NULL. 2502a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2503a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK]; 2504a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** otherwise an [error code] is returned. 25057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 25067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are 25077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** recommended for all new programs. The two older interfaces are retained 25087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for backwards compatibility, but their use is discouraged. 2509a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^In the "v2" interfaces, the prepared statement 2510a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that is returned (the [sqlite3_stmt] object) contains a copy of the 2511a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** original SQL text. This causes the [sqlite3_step()] interface to 2512a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** behave differently in three ways: 25137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 25147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ol> 25157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> 2516a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it 25177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** always used to do, [sqlite3_step()] will automatically recompile the SQL 2518a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** statement and try to run it again. ^If the schema has changed in 25197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a way that makes the statement no longer valid, [sqlite3_step()] will still 2520a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** return [SQLITE_SCHEMA]. But unlike the legacy behavior, [SQLITE_SCHEMA] is 2521a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** now a fatal error. Calling [sqlite3_prepare_v2()] again will not make the 25227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** error go away. Note: use [sqlite3_errmsg()] to find the text 2523a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the parsing error that results in an [SQLITE_SCHEMA] return. 25247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </li> 25257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 25267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> 2527a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^When an error occurs, [sqlite3_step()] will return one of the detailed 2528a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [error codes] or [extended error codes]. ^The legacy behavior was that 2529a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code 2530a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and the application would have to make a second call to [sqlite3_reset()] 2531a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in order to find the underlying cause of the problem. With the "v2" prepare 2532a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces, the underlying reason for the error is returned immediately. 25337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </li> 25347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2535a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> 2536a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the value of a [parameter | host parameter] in the WHERE clause might 2537a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** change the query plan for a statement, then the statement may be 2538a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** automatically recompiled (as if there had been a schema change) on the first 2539a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_step()] call following any change to the 2540a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_bind_text | bindings] of the [parameter]. 2541a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </li> 2542a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ol> 25437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2544a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_prepare( 25457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Database handle */ 25467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zSql, /* SQL statement, UTF-8 encoded */ 25477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nByte, /* Maximum length of zSql in bytes. */ 25487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 25497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char **pzTail /* OUT: Pointer to unused portion of zSql */ 25507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 2551a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_prepare_v2( 25527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Database handle */ 25537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zSql, /* SQL statement, UTF-8 encoded */ 25547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nByte, /* Maximum length of zSql in bytes. */ 25557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 25567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char **pzTail /* OUT: Pointer to unused portion of zSql */ 25577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 2558a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_prepare16( 25597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Database handle */ 25607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void *zSql, /* SQL statement, UTF-16 encoded */ 25617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nByte, /* Maximum length of zSql in bytes. */ 25627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 25637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void **pzTail /* OUT: Pointer to unused portion of zSql */ 25647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 2565a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_prepare16_v2( 25667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Database handle */ 25677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void *zSql, /* SQL statement, UTF-16 encoded */ 25687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nByte, /* Maximum length of zSql in bytes. */ 25697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 25707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void **pzTail /* OUT: Pointer to unused portion of zSql */ 25717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 25727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 25737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2574a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Retrieving Statement SQL 25757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2576a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This interface can be used to retrieve a saved copy of the original 2577a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL text used to create a [prepared statement] if that statement was 2578a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** compiled using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()]. 25797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2580a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt); 25817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 25827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2583a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Dynamically Typed Value Object 25847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value} 25857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 25867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLite uses the sqlite3_value object to represent all values 2587a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that can be stored in a database table. SQLite uses dynamic typing 2588a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for the values it stores. ^Values stored in sqlite3_value objects 2589a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can be integers, floating point values, strings, BLOBs, or NULL. 25907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 25917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** An sqlite3_value object may be either "protected" or "unprotected". 25927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Some interfaces require a protected sqlite3_value. Other interfaces 25937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** will accept either a protected or an unprotected sqlite3_value. 2594a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Every interface that accepts sqlite3_value arguments specifies 25957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** whether or not it requires a protected sqlite3_value. 25967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 25977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The terms "protected" and "unprotected" refer to whether or not 25987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a mutex is held. A internal mutex is held for a protected 25997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_value object but no mutex is held for an unprotected 26007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_value object. If SQLite is compiled to be single-threaded 2601a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0) 2602a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or if SQLite is run in one of reduced mutex modes 2603a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD] 2604a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then there is no distinction between protected and unprotected 2605a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_value objects and they can be used interchangeably. However, 2606a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for maximum code portability it is recommended that applications 2607a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** still make the distinction between between protected and unprotected 2608a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_value objects even when not strictly required. 2609a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2610a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_value objects that are passed as parameters into the 2611a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation of [application-defined SQL functions] are protected. 2612a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_value object returned by 26137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_column_value()] is unprotected. 26147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Unprotected sqlite3_value objects may only be used with 2615a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_result_value()] and [sqlite3_bind_value()]. 2616a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [sqlite3_value_blob | sqlite3_value_type()] family of 2617a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces require protected sqlite3_value objects. 26187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 26197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct Mem sqlite3_value; 26207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 26217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2622a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: SQL Function Context Object 26237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 26247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The context in which an SQL function executes is stored in an 2625a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_context object. ^A pointer to an sqlite3_context object 2626a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is always first parameter to [application-defined SQL functions]. 2627a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The application-defined SQL function implementation will pass this 2628a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pointer through into calls to [sqlite3_result_int | sqlite3_result()], 2629a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_aggregate_context()], [sqlite3_user_data()], 2630a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()], 2631a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and/or [sqlite3_set_auxdata()]. 26327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 26337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_context sqlite3_context; 26347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 26357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2636a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Binding Values To Prepared Statements 2637a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {host parameter} {host parameters} {host parameter name} 2638a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding} 26397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2640a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants, 2641a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** literals may be replaced by a [parameter] that matches one of following 2642a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** templates: 26437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 26447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 26457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> ? 26467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> ?NNN 26477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> :VVV 26487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> @VVV 26497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> $VVV 26507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </ul> 26517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2652a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** In the templates above, NNN represents an integer literal, 2653a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and VVV represents an alphanumeric identifer.)^ ^The values of these 2654a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameters (also called "host parameter names" or "SQL parameters") 26557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** can be set using the sqlite3_bind_*() routines defined here. 26567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2657a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first argument to the sqlite3_bind_*() routines is always 2658a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a pointer to the [sqlite3_stmt] object returned from 2659a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_prepare_v2()] or its variants. 2660a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2661a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The second argument is the index of the SQL parameter to be set. 2662a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The leftmost SQL parameter has an index of 1. ^When the same named 2663a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL parameter is used more than once, second and subsequent 2664a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** occurrences have the same index as the first occurrence. 2665a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The index for named parameters can be looked up using the 2666a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_bind_parameter_index()] API if desired. ^The index 26677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for "?NNN" parameters is the value of NNN. 2668a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The NNN value must be between 1 and the [sqlite3_limit()] 2669a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999). 26707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2671a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The third argument is the value to bind to the parameter. 26727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2673a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(In those routines that have a fourth argument, its value is the 2674a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** number of bytes in the parameter. To be clear: the value is the 2675a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** number of <u>bytes</u> in the value, not the number of characters.)^ 2676a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the fourth parameter is negative, the length of the string is 2677a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the number of bytes up to the first zero terminator. 26787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2679a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and 26807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or 2681a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** string after SQLite has finished with it. ^If the fifth argument is 26827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the special value [SQLITE_STATIC], then SQLite assumes that the 26837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** information is in static, unmanaged space and does not need to be freed. 2684a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the fifth argument has the value [SQLITE_TRANSIENT], then 26857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLite makes its own private copy of the data immediately, before 26867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the sqlite3_bind_*() routine returns. 26877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2688a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that 2689a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is filled with zeroes. ^A zeroblob uses a fixed amount of memory 2690a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (just an integer to hold its size) while it is being processed. 2691a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Zeroblobs are intended to serve as placeholders for BLOBs whose 2692a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** content is later written using 2693a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_blob_open | incremental BLOB I/O] routines. 2694a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A negative value for the zeroblob results in a zero-length BLOB. 2695a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2696a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer 2697a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for the [prepared statement] or with a prepared statement for which 2698a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_step()] has been called more recently than [sqlite3_reset()], 2699a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_() 2700a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routine is passed a [prepared statement] that has been finalized, the 2701a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** result is undefined and probably harmful. 2702a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2703a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Bindings are not cleared by the [sqlite3_reset()] routine. 2704a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Unbound parameters are interpreted as NULL. 2705a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2706a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an 2707a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [error code] if anything goes wrong. 2708a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^[SQLITE_RANGE] is returned if the parameter 2709a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails. 27107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 27117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** See also: [sqlite3_bind_parameter_count()], 2712a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()]. 2713a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 2714a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*)); 2715a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_bind_double(sqlite3_stmt*, int, double); 2716a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int); 2717a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64); 2718a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_bind_null(sqlite3_stmt*, int); 2719a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*)); 2720a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*)); 2721a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*); 2722a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n); 2723a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 2724a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 2725a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Number Of SQL Parameters 27267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2727a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This routine can be used to find the number of [SQL parameters] 2728a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in a [prepared statement]. SQL parameters are tokens of the 27297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as 2730a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** placeholders for values that are [sqlite3_bind_blob | bound] 27317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to the parameters at a later time. 27327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2733a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This routine actually returns the index of the largest (rightmost) 2734a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter. For all forms except ?NNN, this will correspond to the 2735a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** number of unique parameters. If parameters of the ?NNN form are used, 2736a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** there may be gaps in the list.)^ 27377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 27387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** See also: [sqlite3_bind_blob|sqlite3_bind()], 27397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_bind_parameter_name()], and 27407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_bind_parameter_index()]. 27417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2742a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt*); 27437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 27447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2745a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Name Of A Host Parameter 27467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2747a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_bind_parameter_name(P,N) interface returns 2748a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the name of the N-th [SQL parameter] in the [prepared statement] P. 2749a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA" 27507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA" 27517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** respectively. 27527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** In other words, the initial ":" or "$" or "@" or "?" 2753a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is included as part of the name.)^ 2754a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Parameters of the form "?" without a following integer have no name 2755a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and are referred to as "nameless" or "anonymous parameters". 27567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2757a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first host parameter has an index of 1, not 0. 27587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2759a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the value N is out of range or if the N-th parameter is 2760a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** nameless, then NULL is returned. ^The returned string is 2761a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** always in UTF-8 encoding even if the named parameter was 27627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** originally specified as UTF-16 in [sqlite3_prepare16()] or 27637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_prepare16_v2()]. 27647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 27657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** See also: [sqlite3_bind_blob|sqlite3_bind()], 27667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_bind_parameter_count()], and 27677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_bind_parameter_index()]. 27687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2769a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int); 27707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 27717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2772a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Index Of A Parameter With A Given Name 27737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2774a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Return the index of an SQL parameter given its name. ^The 27757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** index value returned is suitable for use as the second 2776a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter to [sqlite3_bind_blob|sqlite3_bind()]. ^A zero 2777a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is returned if no matching parameter is found. ^The parameter 27787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** name must be given in UTF-8 even if the original statement 27797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** was prepared from UTF-16 text using [sqlite3_prepare16_v2()]. 27807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 27817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** See also: [sqlite3_bind_blob|sqlite3_bind()], 27827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_bind_parameter_count()], and 27837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_bind_parameter_index()]. 27847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2785a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName); 27867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 27877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2788a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Reset All Bindings On A Prepared Statement 27897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2790a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset 2791a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [sqlite3_bind_blob | bindings] on a [prepared statement]. 2792a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Use this routine to reset all host parameters to NULL. 27937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2794a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*); 27957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 27967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2797a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Number Of Columns In A Result Set 27987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2799a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Return the number of columns in the result set returned by the 2800a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [prepared statement]. ^This routine returns 0 if pStmt is an SQL 2801a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** statement that does not return data (for example an [UPDATE]). 28027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2803a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt); 28047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 28057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2806a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Column Names In A Result Set 28077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2808a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines return the name assigned to a particular column 2809a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in the result set of a [SELECT] statement. ^The sqlite3_column_name() 2810a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interface returns a pointer to a zero-terminated UTF-8 string 28117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and sqlite3_column_name16() returns a pointer to a zero-terminated 2812a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** UTF-16 string. ^The first parameter is the [prepared statement] 2813a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that implements the [SELECT] statement. ^The second parameter is the 2814a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** column number. ^The leftmost column is number 0. 28157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2816a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The returned string pointer is valid until either the [prepared statement] 2817a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is destroyed by [sqlite3_finalize()] or until the next call to 2818a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_name() or sqlite3_column_name16() on the same column. 28197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2820a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_malloc() fails during the processing of either routine 28217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** (for example during a conversion from UTF-8 to UTF-16) then a 28227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** NULL pointer is returned. 28237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2824a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The name of a result column is the value of the "AS" clause for 28257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** that column, if there is an AS clause. If there is no AS clause 28267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** then the name of the column is unspecified and may change from 28277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** one release of SQLite to the next. 28287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2829a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const char *sqlite3_column_name(sqlite3_stmt*, int N); 2830a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_column_name16(sqlite3_stmt*, int N); 28317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 28327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2833a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Source Of Data In A Query Result 28347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2835a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines provide a means to determine the database, table, and 2836a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** table column that is the origin of a particular result column in 2837a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SELECT] statement. 2838a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The name of the database or table or column can be returned as 2839a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** either a UTF-8 or UTF-16 string. ^The _database_ routines return 28407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the database name, the _table_ routines return the table name, and 28417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the origin_ routines return the column name. 2842a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The returned string is valid until the [prepared statement] is destroyed 2843a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** using [sqlite3_finalize()] or until the same information is requested 28447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** again in a different encoding. 28457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2846a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The names returned are the original un-aliased names of the 28477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** database, table, and column. 28487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2849a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first argument to these interfaces is a [prepared statement]. 2850a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These functions return information about the Nth result column returned by 28517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the statement, where N is the second function argument. 2852a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The left-most column is column 0 for these routines. 28537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2854a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the Nth column returned by the statement is an expression or 2855a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** subquery and is not a column value, then all of these functions return 2856a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** NULL. ^These routine might also return NULL if a memory allocation error 2857a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** occurs. ^Otherwise, they return the name of the attached database, table, 2858a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or column that query result column was extracted from. 28597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2860a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^As with all other SQLite APIs, those whose names end with "16" return 2861a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** UTF-16 encoded strings and the other functions return UTF-8. 28627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2863a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These APIs are only available if the library was compiled with the 2864a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol. 28657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 28667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If two or more threads call one or more of these routines against the same 28677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** prepared statement and column at the same time then the results are 28687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** undefined. 28697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2870a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If two or more threads call one or more 2871a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_column_database_name | column metadata interfaces] 2872a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for the same [prepared statement] and result column 2873a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** at the same time then the results are undefined. 2874a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 2875a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const char *sqlite3_column_database_name(sqlite3_stmt*,int); 2876a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_column_database_name16(sqlite3_stmt*,int); 2877a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const char *sqlite3_column_table_name(sqlite3_stmt*,int); 2878a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_column_table_name16(sqlite3_stmt*,int); 2879a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const char *sqlite3_column_origin_name(sqlite3_stmt*,int); 2880a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_column_origin_name16(sqlite3_stmt*,int); 2881a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 2882a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 2883a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Declared Datatype Of A Query Result 2884a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2885a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The first parameter is a [prepared statement]. 2886a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If this statement is a [SELECT] statement and the Nth column of the 2887a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned result set of that [SELECT] is a table column (not an 28887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** expression or subquery) then the declared type of the table 2889a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** column is returned.)^ ^If the Nth column of the result set is an 28907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** expression or subquery, then a NULL pointer is returned. 2891a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The returned string is always UTF-8 encoded. 2892a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2893a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(For example, given the database schema: 28947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 28957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** CREATE TABLE t1(c1 VARIANT); 28967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2897a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and the following statement to be compiled: 28987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 28997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SELECT c1 + 1, c1 FROM t1; 29007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2901a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** this routine would return the string "VARIANT" for the second result 2902a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** column (i==1), and a NULL pointer for the first result column (i==0).)^ 29037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2904a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite uses dynamic run-time typing. ^So just because a column 29057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is declared to contain a particular type does not mean that the 29067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** data stored in that column is of the declared type. SQLite is 2907a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** strongly typed, but the typing is dynamic not static. ^Type 29087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is associated with individual values, not with the containers 29097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** used to hold those values. 2910a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 2911a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const char *sqlite3_column_decltype(sqlite3_stmt*,int); 2912a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_column_decltype16(sqlite3_stmt*,int); 2913a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 2914a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 2915a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Evaluate An SQL Statement 2916a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2917a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** After a [prepared statement] has been prepared using either 2918a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy 2919a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function 2920a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** must be called one or more times to evaluate the statement. 29217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2922a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The details of the behavior of the sqlite3_step() interface depend 29237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** on whether the statement was prepared using the newer "v2" interface 29247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy 29257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the 29267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** new "v2" interface is recommended for new applications but the legacy 29277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface will continue to be supported. 29287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2929a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^In the legacy interface, the return value will be either [SQLITE_BUSY], 29307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE]. 2931a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^With the "v2" interface, any of the other [result codes] or 2932a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [extended result codes] might be returned as well. 29337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2934a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^[SQLITE_BUSY] means that the database engine was unable to acquire the 2935a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database locks it needs to do its job. ^If the statement is a [COMMIT] 29367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or occurs outside of an explicit transaction, then you can retry the 2937a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** statement. If the statement is not a [COMMIT] and occurs within a 29387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** explicit transaction then you should rollback the transaction before 29397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** continuing. 29407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2941a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^[SQLITE_DONE] means that the statement has finished executing 29427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** successfully. sqlite3_step() should not be called again on this virtual 29437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** machine without first calling [sqlite3_reset()] to reset the virtual 29447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** machine back to its initial state. 29457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2946a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the SQL statement being executed returns any data, then [SQLITE_ROW] 2947a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is returned each time a new row of data is ready for processing by the 2948a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** caller. The values may be accessed using the [column access functions]. 29497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_step() is called again to retrieve the next row of data. 2950a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2951a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^[SQLITE_ERROR] means that a run-time error (such as a constraint 29527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** violation) has occurred. sqlite3_step() should not be called again on 29537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the VM. More information may be found by calling [sqlite3_errmsg()]. 2954a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^With the legacy interface, a more specific error code (for example, 29557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth) 29567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** can be obtained by calling [sqlite3_reset()] on the 2957a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [prepared statement]. ^In the "v2" interface, 29587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the more specific error code is returned directly by sqlite3_step(). 29597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 29607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_MISUSE] means that the this routine was called inappropriately. 29617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Perhaps it was called on a [prepared statement] that has 2962a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** already been [sqlite3_finalize | finalized] or on one that had 29637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could 29647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** be the case that the same database connection is being used by two or 29657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** more threads at the same moment in time. 29667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 296771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** For all versions of SQLite up to and including 3.6.23.1, it was required 296871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** after sqlite3_step() returned anything other than [SQLITE_ROW] that 296971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [sqlite3_reset()] be called before any subsequent invocation of 297071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** sqlite3_step(). Failure to invoke [sqlite3_reset()] in this way would 297171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** result in an [SQLITE_MISUSE] return from sqlite3_step(). But after 297271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** version 3.6.23.1, sqlite3_step() began calling [sqlite3_reset()] 297371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** automatically in this circumstance rather than returning [SQLITE_MISUSE]. 297471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 2975a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step() 2976a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** API always returns a generic error code, [SQLITE_ERROR], following any 2977a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call 2978a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the 2979a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** specific [error codes] that better describes the error. 29807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** We admit that this is a goofy design. The problem has been fixed 29817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** with the "v2" interface. If you prepare all of your SQL statements 29827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead 2983a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces, 2984a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the more specific [error codes] are returned directly 29857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** by sqlite3_step(). The use of the "v2" interface is recommended. 29867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2987a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_step(sqlite3_stmt*); 29887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 29897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2990a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Number of columns in a result set 29917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2992a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_data_count(P) the number of columns in the 2993a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the result set of [prepared statement] P. 29947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2995a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt); 29967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 29977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2998a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Fundamental Datatypes 29997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** KEYWORDS: SQLITE_TEXT 30007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3001a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Every value in SQLite has one of five fundamental datatypes: 30027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 30037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 30047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> 64-bit signed integer 30057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> 64-bit IEEE floating point number 30067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> string 30077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> BLOB 30087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> NULL 3009a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ul>)^ 30107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 30117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These constants are codes for each of those types. 30127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 30137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Note that the SQLITE_TEXT constant was also used in SQLite version 2 30147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for a completely different meaning. Software that links against both 3015a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not 30167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLITE_TEXT. 30177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 30187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INTEGER 1 30197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_FLOAT 2 30207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_BLOB 4 30217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_NULL 5 30227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#ifdef SQLITE_TEXT 30237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project# undef SQLITE_TEXT 30247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#else 30257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project# define SQLITE_TEXT 3 30267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#endif 30277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE3_TEXT 3 30287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 30297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3030a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Result Values From A Query 3031a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {column access functions} 3032a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3033a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These routines form the "result set" interface. 3034a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3035a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines return information about a single column of the current 3036a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** result row of a query. ^In every case the first argument is a pointer 3037a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*] 3038a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that was returned from [sqlite3_prepare_v2()] or one of its variants) 3039a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and the second argument is the index of the column for which information 3040a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** should be returned. ^The leftmost column of the result set has the index 0. 3041a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The number of columns in the result can be determined using 3042a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_column_count()]. 3043a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3044a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If the SQL statement does not currently point to a valid row, or if the 3045a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** column index is out of range, the result is undefined. 30467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These routines may only be called when the most recent call to 30477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_step()] has returned [SQLITE_ROW] and neither 3048a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently. 30497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If any of these routines are called after [sqlite3_reset()] or 30507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_finalize()] or after [sqlite3_step()] has returned 30517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** something other than [SQLITE_ROW], the results are undefined. 30527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()] 30537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** are called from a different thread while any of these routines 3054a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are pending, then the results are undefined. 30557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3056a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_column_type() routine returns the 30577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_INTEGER | datatype code] for the initial data type 3058a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the result column. ^The returned value is one of [SQLITE_INTEGER], 30597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value 30607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** returned by sqlite3_column_type() is only meaningful if no type 30617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** conversions have occurred as described below. After a type conversion, 30627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the value returned by sqlite3_column_type() is undefined. Future 30637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** versions of SQLite may change the behavior of sqlite3_column_type() 30647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** following a type conversion. 30657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3066a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes() 30677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** routine returns the number of bytes in that BLOB or string. 3068a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts 30697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the string to UTF-8 and then returns the number of bytes. 3070a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the result is a numeric value then sqlite3_column_bytes() uses 30717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns 30727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the number of bytes in that string. 3073a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The value returned does not include the zero terminator at the end 3074a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the string. ^For clarity: the value returned is the number of 30757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** bytes in the string, not the number of characters. 30767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3077a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(), 3078a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** even empty strings, are always zero terminated. ^The return 3079a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value from sqlite3_column_blob() for a zero-length BLOB is an arbitrary 30807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** pointer, possibly even a NULL pointer. 30817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3082a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_column_bytes16() routine is similar to sqlite3_column_bytes() 3083a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** but leaves the result in UTF-16 in native byte order instead of UTF-8. 3084a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The zero terminator is not included in this count. 30857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3086a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The object returned by [sqlite3_column_value()] is an 30877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [unprotected sqlite3_value] object. An unprotected sqlite3_value object 30887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()]. 30897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If the [unprotected sqlite3_value] object returned by 30907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_column_value()] is used in any other way, including calls 3091a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to routines like [sqlite3_value_int()], [sqlite3_value_text()], 3092a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [sqlite3_value_bytes()], then the behavior is undefined. 30937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3094a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These routines attempt to convert the value where appropriate. ^For 30957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** example, if the internal representation is FLOAT and a text result 3096a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is requested, [sqlite3_snprintf()] is used internally to perform the 3097a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** conversion automatically. ^(The following table details the conversions 3098a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that are applied: 30997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 31007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote> 31017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <table border="1"> 31027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion 31037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 31047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> NULL <td> INTEGER <td> Result is 0 31057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> NULL <td> FLOAT <td> Result is 0.0 31067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> NULL <td> TEXT <td> Result is NULL pointer 31077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> NULL <td> BLOB <td> Result is NULL pointer 31087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float 31097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer 3110a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT 31117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> FLOAT <td> INTEGER <td> Convert from float to integer 31127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float 31137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> FLOAT <td> BLOB <td> Same as FLOAT->TEXT 31147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> TEXT <td> INTEGER <td> Use atoi() 31157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> TEXT <td> FLOAT <td> Use atof() 31167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> TEXT <td> BLOB <td> No change 31177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> BLOB <td> INTEGER <td> Convert to TEXT then use atoi() 31187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> BLOB <td> FLOAT <td> Convert to TEXT then use atof() 31197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed 31207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </table> 3121a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </blockquote>)^ 31227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 31237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The table above makes reference to standard C library functions atoi() 31247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and atof(). SQLite does not really use these functions. It has its 3125a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** own equivalent internal routines. The atoi() and atof() names are 31267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** used in the table for brevity and because they are familiar to most 31277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** C programmers. 31287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3129a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Note that when type conversions occur, pointers returned by prior 31307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or 3131a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_text16() may be invalidated. 3132a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Type conversions and pointer invalidations might occur 31337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** in the following cases: 31347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 31357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 3136a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> The initial content is a BLOB and sqlite3_column_text() or 3137a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_text16() is called. A zero-terminator might 3138a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** need to be added to the string.</li> 3139a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or 3140a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_text16() is called. The content must be converted 3141a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to UTF-16.</li> 3142a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or 3143a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_text() is called. The content must be converted 3144a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to UTF-8.</li> 3145a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ul>)^ 3146a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3147a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Conversions between UTF-16be and UTF-16le are always done in place and do 31487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** not invalidate a prior pointer, though of course the content of the buffer 31497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** that the prior pointer points to will have been modified. Other kinds 3150a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of conversion are done in place when it is possible, but sometimes they 3151a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are not possible and in those cases prior pointers are invalidated. 31527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3153a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The safest and easiest to remember policy is to invoke these routines 31547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** in one of the following ways: 31557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3156a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <ul> 31577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li> 31587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li> 31597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li> 3160a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ul>)^ 31617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3162a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** In other words, you should call sqlite3_column_text(), 3163a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result 3164a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** into the desired format, then invoke sqlite3_column_bytes() or 3165a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_bytes16() to find the size of the result. Do not mix calls 3166a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to sqlite3_column_text() or sqlite3_column_blob() with calls to 3167a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16() 3168a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with calls to sqlite3_column_bytes(). 31697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3170a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The pointers returned are valid until a type conversion occurs as 31717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** described above, or until [sqlite3_step()] or [sqlite3_reset()] or 3172a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_finalize()] is called. ^The memory space used to hold strings 3173a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and BLOBs is freed automatically. Do <b>not</b> pass the pointers returned 3174a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into 31757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_free()]. 31767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3177a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(If a memory allocation error occurs during the evaluation of any 31787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of these routines, a default value is returned. The default value 31797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is either the integer 0, the floating point number 0.0, or a NULL 31807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** pointer. Subsequent calls to [sqlite3_errcode()] will return 3181a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_NOMEM].)^ 3182a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 3183a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_column_blob(sqlite3_stmt*, int iCol); 3184a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol); 3185a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol); 3186a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol); 3187a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol); 3188a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol); 3189a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol); 3190a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_column_text16(sqlite3_stmt*, int iCol); 3191a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol); 3192a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol); 3193a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 3194a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 3195a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Destroy A Prepared Statement Object 31967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3197a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_finalize() function is called to delete a [prepared statement]. 3198a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the statement was executed successfully or not executed at all, then 3199a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_OK is returned. ^If execution of the statement failed then an 3200a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [error code] or [extended error code] is returned. 32017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3202a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This routine can be called at any point during the execution of the 3203a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [prepared statement]. ^If the virtual machine has not 3204a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** completed execution when this routine is called, that is like 3205a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** encountering an error or an [sqlite3_interrupt | interrupt]. 3206a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Incomplete updates may be rolled back and transactions canceled, 3207a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** depending on the circumstances, and the 3208a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [error code] returned will be [SQLITE_ABORT]. 32097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3210a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt); 32117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 32127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3213a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Reset A Prepared Statement Object 32147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3215a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_reset() function is called to reset a [prepared statement] 3216a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** object back to its initial state, ready to be re-executed. 3217a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Any SQL statement variables that had values bound to them using 32187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values. 32197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Use [sqlite3_clear_bindings()] to reset the bindings. 32207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3221a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S 3222a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** back to the beginning of its program. 32237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3224a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the most recent call to [sqlite3_step(S)] for the 3225a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE], 3226a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or if [sqlite3_step(S)] has never before been called on S, 3227a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then [sqlite3_reset(S)] returns [SQLITE_OK]. 32287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3229a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the most recent call to [sqlite3_step(S)] for the 3230a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [prepared statement] S indicated an error, then 3231a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_reset(S)] returns an appropriate [error code]. 32327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3233a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_reset(S)] interface does not change the values 3234a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S. 32357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3236a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt); 32377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 32387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3239a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Create Or Redefine SQL Functions 3240a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {function creation routines} 3241a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {application-defined SQL function} 3242a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {application-defined SQL functions} 3243a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3244a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These two functions (collectively known as "function creation routines") 3245a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are used to add SQL functions or aggregates or to redefine the behavior 3246a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of existing SQL functions or aggregates. The only difference between the 3247a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** two is that the second parameter, the name of the (scalar) function or 3248a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** aggregate, is encoded in UTF-8 for sqlite3_create_function() and UTF-16 3249a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for sqlite3_create_function16(). 3250a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3251a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first parameter is the [database connection] to which the SQL 3252a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function is to be added. ^If an application uses more than one database 3253a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** connection then application-defined SQL functions must be added 3254a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to each database connection separately. 3255a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3256a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The second parameter is the name of the SQL function to be created or 3257a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** redefined. ^The length of the name is limited to 255 bytes, exclusive of 3258a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the zero-terminator. Note that the name length limit is in bytes, not 3259a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** characters. ^Any attempt to create a function with a longer name 3260a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will result in [SQLITE_ERROR] being returned. 3261a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3262a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The third parameter (nArg) 3263a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is the number of arguments that the SQL function or 3264a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** aggregate takes. ^If this parameter is -1, then the SQL function or 3265a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** aggregate may take any number of arguments between 0 and the limit 3266a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third 3267a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter is less than -1 or greater than 127 then the behavior is 3268a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** undefined. 32697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3270a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The fourth parameter, eTextRep, specifies what 32717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_UTF8 | text encoding] this SQL function prefers for 32727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** its parameters. Any SQL function implementation should be able to work 32737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** work with UTF-8, UTF-16le, or UTF-16be. But some implementations may be 3274a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** more efficient with one encoding than another. ^An application may 32757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** invoke sqlite3_create_function() or sqlite3_create_function16() multiple 32767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** times with the same function but with different values of eTextRep. 3277a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^When multiple implementations of the same function are available, SQLite 32787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** will pick the one that involves the least amount of data conversion. 3279a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If there is only a single implementation which does not care what text 3280a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** encoding is used, then the fourth argument should be [SQLITE_ANY]. 32817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3282a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The fifth parameter is an arbitrary pointer. The implementation of the 3283a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function can gain access to this pointer using [sqlite3_user_data()].)^ 32847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 32857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The seventh, eighth and ninth parameters, xFunc, xStep and xFinal, are 3286a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pointers to C-language functions that implement the SQL function or 3287a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** aggregate. ^A scalar SQL function requires an implementation of the xFunc 3288a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** callback only; NULL pointers should be passed as the xStep and xFinal 3289a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameters. ^An aggregate SQL function requires an implementation of xStep 3290a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and xFinal and NULL should be passed for xFunc. ^To delete an existing 3291a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL function or aggregate, pass NULL for all three function callbacks. 3292a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3293a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^It is permitted to register multiple implementations of the same 32947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** functions with the same name but with either differing numbers of 3295a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** arguments or differing preferred text encodings. ^SQLite will use 3296a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the implementation that most closely matches the way in which the 3297a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL function is used. ^A function implementation with a non-negative 3298a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** nArg parameter is a better match than a function implementation with 3299a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a negative nArg. ^A function where the preferred text encoding 3300a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** matches the database encoding is a better 3301a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** match than a function where the encoding is different. 3302a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A function where the encoding difference is between UTF16le and UTF16be 3303a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is a closer match than a function where the encoding difference is 3304a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** between UTF8 and UTF16. 3305a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3306a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Built-in functions may be overloaded by new application-defined functions. 3307a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first application-defined function with a given name overrides all 3308a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** built-in functions in the same [database connection] with the same name. 3309a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Subsequent application-defined functions of the same name only override 3310a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** prior application-defined functions that are an exact match for the 3311a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** number of parameters and preferred encoding. 3312a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3313a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^An application-defined function is permitted to call other 3314a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite interfaces. However, such calls must not 3315a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** close the database connection nor finalize or reset the prepared 3316a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** statement in which the function is running. 3317a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 3318a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_create_function( 33197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, 33207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zFunctionName, 33217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nArg, 33227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int eTextRep, 33237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void *pApp, 33247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xFunc)(sqlite3_context*,int,sqlite3_value**), 33257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xStep)(sqlite3_context*,int,sqlite3_value**), 33267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xFinal)(sqlite3_context*) 33277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 3328a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_create_function16( 33297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, 33307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void *zFunctionName, 33317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nArg, 33327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int eTextRep, 33337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void *pApp, 33347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xFunc)(sqlite3_context*,int,sqlite3_value**), 33357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xStep)(sqlite3_context*,int,sqlite3_value**), 33367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xFinal)(sqlite3_context*) 33377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 33387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 33397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3340a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Text Encodings 33417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 33427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These constant define integer codes that represent the various 33437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** text encodings supported by SQLite. 33447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 33457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_UTF8 1 33467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_UTF16LE 2 33477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_UTF16BE 3 33487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_UTF16 4 /* Use native byte order */ 33497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ANY 5 /* sqlite3_create_function only */ 33507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */ 33517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 33527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3353a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Deprecated Functions 3354a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** DEPRECATED 33557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3356a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These functions are [deprecated]. In order to maintain 3357a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** backwards compatibility with older code, these functions continue 3358a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to be supported. However, new applications should avoid 33597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the use of these functions. To help encourage people to avoid 3360a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** using these functions, we are not going to tell you what they do. 33617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3362a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#ifndef SQLITE_OMIT_DEPRECATED 3363a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*); 3364a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*); 3365a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*); 3366a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void); 3367a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API SQLITE_DEPRECATED void sqlite3_thread_cleanup(void); 3368a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),void*,sqlite3_int64); 3369a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#endif 33707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 33717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3372a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Obtaining SQL Function Parameter Values 33737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 33747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The C-language implementation of SQL functions and aggregates uses 33757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** this set of interface routines to access the parameter values on 33767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the function or aggregate. 33777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 33787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The xFunc (for scalar functions) or xStep (for aggregates) parameters 33797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to [sqlite3_create_function()] and [sqlite3_create_function16()] 33807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** define callbacks that implement the SQL functions and aggregates. 33817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The 4th parameter to these callbacks is an array of pointers to 33827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [protected sqlite3_value] objects. There is one [sqlite3_value] object for 33837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** each parameter to the SQL function. These routines are used to 33847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** extract values from the [sqlite3_value] objects. 33857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 33867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These routines work only with [protected sqlite3_value] objects. 33877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Any attempt to use these routines on an [unprotected sqlite3_value] 33887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** object results in undefined behavior. 33897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3390a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines work just like the corresponding [column access functions] 3391a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** except that these routines take a single [protected sqlite3_value] object 3392a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pointer instead of a [sqlite3_stmt*] pointer and an integer column number. 33937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3394a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_value_text16() interface extracts a UTF-16 string 3395a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in the native byte-order of the host machine. ^The 33967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces 3397a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** extract UTF-16 strings as big-endian and little-endian respectively. 33987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3399a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The sqlite3_value_numeric_type() interface attempts to apply 34007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** numeric affinity to the value. This means that an attempt is 34017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** made to convert the value to an integer or floating point. If 34027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** such a conversion is possible without loss of information (in other 3403a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** words, if the value is a string that looks like a number) 3404a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the conversion is performed. Otherwise no conversion occurs. 3405a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [SQLITE_INTEGER | datatype] after conversion is returned.)^ 34067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3407a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Please pay particular attention to the fact that the pointer returned 3408a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from [sqlite3_value_blob()], [sqlite3_value_text()], or 34097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_value_text16()] can be invalidated by a subsequent call to 34107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()], 3411a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [sqlite3_value_text16()]. 34127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 34137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These routines must be called from the same thread as 34147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the SQL function that supplied the [sqlite3_value*] parameters. 3415a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 3416a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_value_blob(sqlite3_value*); 3417a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_value_bytes(sqlite3_value*); 3418a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_value_bytes16(sqlite3_value*); 3419a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API double sqlite3_value_double(sqlite3_value*); 3420a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_value_int(sqlite3_value*); 3421a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value*); 3422a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value*); 3423a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_value_text16(sqlite3_value*); 3424a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_value_text16le(sqlite3_value*); 3425a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_value_text16be(sqlite3_value*); 3426a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_value_type(sqlite3_value*); 3427a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_value_numeric_type(sqlite3_value*); 3428a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 3429a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 3430a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Obtain Aggregate Function Context 3431a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3432a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Implementions of aggregate SQL functions use this 3433a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routine to allocate memory for storing their state. 3434a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3435a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first time the sqlite3_aggregate_context(C,N) routine is called 3436a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for a particular aggregate function, SQLite 3437a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocates N of memory, zeroes out that memory, and returns a pointer 3438a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the new memory. ^On second and subsequent calls to 3439a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_aggregate_context() for the same aggregate function instance, 3440a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the same buffer is returned. Sqlite3_aggregate_context() is normally 3441a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** called once for each invocation of the xStep callback and then one 3442a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** last time when the xFinal callback is invoked. ^(When no rows match 3443a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an aggregate query, the xStep() callback of the aggregate function 3444a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation is never called and xFinal() is called exactly once. 3445a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** In those cases, sqlite3_aggregate_context() might be called for the 3446a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** first time from within xFinal().)^ 3447a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3448a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer if N is 3449a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** less than or equal to zero or if a memory allocate error occurs. 3450a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3451a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is 3452a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** determined by the N parameter on first successful call. Changing the 3453a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value of N in subsequent call to sqlite3_aggregate_context() within 3454a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the same aggregate function instance will not resize the memory 3455a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocation.)^ 3456a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3457a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite automatically frees the memory allocated by 3458a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_aggregate_context() when the aggregate query concludes. 3459a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3460a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The first parameter must be a copy of the 3461a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_context | SQL function context] that is the first parameter 3462a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the xStep or xFinal callback routine that implements the aggregate 34637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** function. 34647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 34657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** This routine must be called from the same thread in which 34667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the aggregate SQL function is running. 34677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3468a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void *sqlite3_aggregate_context(sqlite3_context*, int nBytes); 34697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 34707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3471a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: User Data For Functions 34727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3473a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_user_data() interface returns a copy of 34747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the pointer that was the pUserData parameter (the 5th parameter) 3475a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the [sqlite3_create_function()] 34767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and [sqlite3_create_function16()] routines that originally 3477a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** registered the application defined function. 34787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 34797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** This routine must be called from the same thread in which 34807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the application-defined function is running. 34817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3482a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void *sqlite3_user_data(sqlite3_context*); 34837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 34847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3485a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Database Connection For Functions 34867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3487a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_context_db_handle() interface returns a copy of 34887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the pointer to the [database connection] (the 1st parameter) 3489a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the [sqlite3_create_function()] 34907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and [sqlite3_create_function16()] routines that originally 34917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** registered the application defined function. 34927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3493a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_context*); 34947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 34957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3496a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Function Auxiliary Data 34977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 34987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The following two functions may be used by scalar SQL functions to 3499a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** associate metadata with argument values. If the same value is passed to 35007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** multiple invocations of the same SQL function during query execution, under 3501a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** some circumstances the associated metadata may be preserved. This may 35027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** be used, for example, to add a regular-expression matching scalar 35037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** function. The compiled version of the regular expression is stored as 3504a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** metadata associated with the SQL value passed as the regular expression 35057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** pattern. The compiled regular expression can be reused on multiple 35067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** invocations of the same function so that the original pattern string 35077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** does not need to be recompiled on each invocation. 35087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3509a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_get_auxdata() interface returns a pointer to the metadata 35107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** associated by the sqlite3_set_auxdata() function with the Nth argument 3511a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value to the application-defined function. ^If no metadata has been ever 3512a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** been set for the Nth argument of the function, or if the corresponding 3513a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function parameter has changed since the meta-data was set, 3514a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then sqlite3_get_auxdata() returns a NULL pointer. 3515a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3516a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_set_auxdata() interface saves the metadata 3517a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pointed to by its 3rd parameter as the metadata for the N-th 35187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** argument of the application-defined function. Subsequent 35197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** calls to sqlite3_get_auxdata() might return this data, if it has 3520a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not been destroyed. 3521a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If it is not NULL, SQLite will invoke the destructor 35227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** function given by the 4th parameter to sqlite3_set_auxdata() on 3523a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the metadata when the corresponding function parameter changes 35247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or when the SQL statement completes, whichever comes first. 35257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3526a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite is free to call the destructor and drop metadata on any 3527a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter of any function at any time. ^The only guarantee is that 3528a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the destructor will be called before the metadata is dropped. 35297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3530a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(In practice, metadata is preserved between function calls for 35317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** expressions that are constant at compile time. This includes literal 3532a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** values and [parameters].)^ 35337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 35347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These routines must be called from the same thread in which 35357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the SQL function is running. 35367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3537a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void *sqlite3_get_auxdata(sqlite3_context*, int N); 3538a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*)); 35397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 35407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 35417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3542a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Constants Defining Special Destructor Behavior 35437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3544a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These are special values for the destructor that is passed in as the 3545a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** final argument to routines like [sqlite3_result_blob()]. ^If the destructor 35467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** argument is SQLITE_STATIC, it means that the content pointer is constant 3547a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and will never change. It does not need to be destroyed. ^The 35487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLITE_TRANSIENT value means that the content will likely change in 35497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the near future and that SQLite should make its own private copy of 35507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the content before returning. 35517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 35527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The typedef is necessary to work around problems in certain 35537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** C++ compilers. See ticket #2191. 35547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 35557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef void (*sqlite3_destructor_type)(void*); 35567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_STATIC ((sqlite3_destructor_type)0) 35577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1) 35587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 35597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3560a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Setting The Result Of An SQL Function 35617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 35627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These routines are used by the xFunc or xFinal callbacks that 35637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** implement SQL functions and aggregates. See 35647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_create_function()] and [sqlite3_create_function16()] 35657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for additional information. 35667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3567a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These functions work very much like the [parameter binding] family of 3568a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** functions used to bind values to host parameters in prepared statements. 3569a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Refer to the [SQL parameter] documentation for additional information. 35707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3571a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_blob() interface sets the result from 3572a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an application-defined function to be the BLOB whose content is pointed 35737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to by the second parameter and which is N bytes long where N is the 3574a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** third parameter. 3575a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3576a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_zeroblob() interfaces set the result of 3577a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the application-defined function to be a BLOB containing all zero 35787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** bytes and N bytes in size, where N is the value of the 2nd parameter. 35797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3580a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_double() interface sets the result from 3581a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an application-defined function to be a floating point value specified 35827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** by its 2nd argument. 35837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3584a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_error() and sqlite3_result_error16() functions 35857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** cause the implemented SQL function to throw an exception. 3586a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite uses the string pointed to by the 35877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16() 3588a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** as the text of an error message. ^SQLite interprets the error 3589a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** message string from sqlite3_result_error() as UTF-8. ^SQLite 3590a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interprets the string from sqlite3_result_error16() as UTF-16 in native 3591a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** byte order. ^If the third parameter to sqlite3_result_error() 35927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or sqlite3_result_error16() is negative then SQLite takes as the error 35937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** message all text up through the first zero character. 3594a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the third parameter to sqlite3_result_error() or 35957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_result_error16() is non-negative then SQLite takes that many 35967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** bytes (not characters) from the 2nd parameter as the error message. 3597a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_error() and sqlite3_result_error16() 3598a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routines make a private copy of the error message text before 35997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** they return. Hence, the calling function can deallocate or 36007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** modify the text after they return without harm. 3601a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_error_code() function changes the error code 3602a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned by SQLite as a result of an error in a function. ^By default, 3603a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error() 36047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or sqlite3_result_error16() resets the error code to SQLITE_ERROR. 36057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3606a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_toobig() interface causes SQLite to throw an error 3607a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** indicating that a string or BLOB is too long to represent. 3608a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3609a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_nomem() interface causes SQLite to throw an error 3610a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** indicating that a memory allocation failed. 36117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3612a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_int() interface sets the return value 36137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of the application-defined function to be the 32-bit signed integer 36147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** value given in the 2nd argument. 3615a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_int64() interface sets the return value 36167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of the application-defined function to be the 64-bit signed integer 36177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** value given in the 2nd argument. 36187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3619a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_null() interface sets the return value 36207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of the application-defined function to be NULL. 36217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3622a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_text(), sqlite3_result_text16(), 36237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces 36247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** set the return value of the application-defined function to be 36257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a text string which is represented as UTF-8, UTF-16 native byte order, 36267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** UTF-16 little endian, or UTF-16 big endian, respectively. 3627a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite takes the text result from the application from 36287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the 2nd parameter of the sqlite3_result_text* interfaces. 3629a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the 3rd parameter to the sqlite3_result_text* interfaces 3630a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is negative, then SQLite takes result text from the 2nd parameter 36317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** through the first zero character. 3632a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the 3rd parameter to the sqlite3_result_text* interfaces 36337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is non-negative, then as many bytes (not characters) of the text 36347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** pointed to by the 2nd parameter are taken as the application-defined 36357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** function result. 3636a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the 4th parameter to the sqlite3_result_text* interfaces 36377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that 3638a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function as the destructor on the text or BLOB result when it has 36397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** finished using that result. 3640a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the 4th parameter to the sqlite3_result_text* interfaces or to 3641a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite 3642a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** assumes that the text or BLOB result is in constant space and does not 3643a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** copy the content of the parameter nor call a destructor on the content 3644a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** when it has finished using that result. 3645a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the 4th parameter to the sqlite3_result_text* interfaces 36467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT 36477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** then SQLite makes a copy of the result into space obtained from 36487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** from [sqlite3_malloc()] before it returns. 36497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3650a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_value() interface sets the result of 36517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the application-defined function to be a copy the 3652a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The 36537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_result_value() interface makes a copy of the [sqlite3_value] 3654a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** so that the [sqlite3_value] specified in the parameter may change or 36557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** be deallocated after sqlite3_result_value() returns without harm. 3656a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A [protected sqlite3_value] object may always be used where an 36577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [unprotected sqlite3_value] object is required, so either 36587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** kind of [sqlite3_value] object can be used with this interface. 36597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3660a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If these routines are called from within the different thread 3661a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** than the one containing the application-defined function that received 36627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the [sqlite3_context] pointer, the results are undefined. 3663a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 3664a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*)); 3665a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_double(sqlite3_context*, double); 3666a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_error(sqlite3_context*, const char*, int); 3667a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_error16(sqlite3_context*, const void*, int); 3668a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_error_toobig(sqlite3_context*); 3669a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_error_nomem(sqlite3_context*); 3670a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_error_code(sqlite3_context*, int); 3671a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_int(sqlite3_context*, int); 3672a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64); 3673a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_null(sqlite3_context*); 3674a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*)); 3675a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*)); 3676a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*)); 3677a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*)); 3678a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_value(sqlite3_context*, sqlite3_value*); 3679a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n); 3680a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 3681a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 3682a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Define New Collating Sequences 36837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 36847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These functions are used to add new collation sequences to the 3685a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection] specified as the first argument. 36867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3687a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The name of the new collation sequence is specified as a UTF-8 string 36887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for sqlite3_create_collation() and sqlite3_create_collation_v2() 3689a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and a UTF-16 string for sqlite3_create_collation16(). ^In all cases 36907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the name is passed as the second function argument. 36917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3692a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The third argument may be one of the constants [SQLITE_UTF8], 3693a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_UTF16LE], or [SQLITE_UTF16BE], indicating that the user-supplied 36947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** routine expects to be passed pointers to strings encoded using UTF-8, 3695a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** UTF-16 little-endian, or UTF-16 big-endian, respectively. ^The 3696a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** third argument might also be [SQLITE_UTF16] to indicate that the routine 3697a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** expects pointers to be UTF-16 strings in the native byte order, or the 3698a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** argument can be [SQLITE_UTF16_ALIGNED] if the 36997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the routine expects pointers to 16-bit word aligned strings 3700a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of UTF-16 in the native byte order. 37017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 37027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** A pointer to the user supplied routine must be passed as the fifth 3703a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** argument. ^If it is NULL, this is the same as deleting the collation 37047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sequence (so that SQLite cannot call it anymore). 3705a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Each time the application supplied function is invoked, it is passed 3706a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** as its first parameter a copy of the void* passed as the fourth argument 3707a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to sqlite3_create_collation() or sqlite3_create_collation16(). 37087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3709a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The remaining arguments to the application-supplied routine are two strings, 37107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** each represented by a (length, data) pair and encoded in the encoding 37117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** that was passed as the third argument when the collation sequence was 3712a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** registered. The application defined collation routine should 3713a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** return negative, zero or positive if the first string is less than, 3714a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** equal to, or greater than the second string. i.e. (STRING1 - STRING2). 3715a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3716a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation() 3717a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** except that it takes an extra argument which is a destructor for 3718a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the collation. ^The destructor is called when the collation is 37197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** destroyed and is passed a copy of the fourth parameter void* pointer 37207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of the sqlite3_create_collation_v2(). 3721a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Collations are destroyed when they are overridden by later calls to the 3722a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** collation creation functions or when the [database connection] is closed 3723a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** using [sqlite3_close()]. 37247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3725a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()]. 37267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3727a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_create_collation( 37287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 37297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zName, 37307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int eTextRep, 37317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void*, 37327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int(*xCompare)(void*,int,const void*,int,const void*) 37337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 3734a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_create_collation_v2( 37357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 37367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zName, 37377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int eTextRep, 37387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void*, 37397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int(*xCompare)(void*,int,const void*,int,const void*), 37407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void(*xDestroy)(void*) 37417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 3742a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_create_collation16( 37437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 3744a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori const void *zName, 37457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int eTextRep, 37467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void*, 37477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int(*xCompare)(void*,int,const void*,int,const void*) 37487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 37497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 37507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3751a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Collation Needed Callbacks 37527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3753a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^To avoid having to register all collation sequences before a database 37547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** can be used, a single callback function may be registered with the 3755a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection] to be invoked whenever an undefined collation 3756a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sequence is required. 37577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3758a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the function is registered using the sqlite3_collation_needed() API, 37597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** then it is passed the names of undefined collation sequences as strings 3760a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** encoded in UTF-8. ^If sqlite3_collation_needed16() is used, 3761a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the names are passed as UTF-16 in machine native byte order. 3762a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A call to either function replaces the existing collation-needed callback. 37637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3764a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(When the callback is invoked, the first argument passed is a copy 37657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of the second argument to sqlite3_collation_needed() or 37667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_collation_needed16(). The second argument is the database 3767a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE], 3768a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [SQLITE_UTF16LE], indicating the most desirable form of the collation 3769a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sequence function required. The fourth parameter is the name of the 3770a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** required collation sequence.)^ 37717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 37727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The callback function should register the desired collation using 37737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_create_collation()], [sqlite3_create_collation16()], or 37747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_create_collation_v2()]. 37757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3776a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_collation_needed( 37777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 37787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void*, 37797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void(*)(void*,sqlite3*,int eTextRep,const char*) 37807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 3781a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_collation_needed16( 37827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 37837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void*, 37847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void(*)(void*,sqlite3*,int eTextRep,const void*) 37857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 37867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 378771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#ifdef SQLITE_HAS_CODEC 37887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 37897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Specify the key for an encrypted database. This routine should be 37907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** called right after sqlite3_open(). 37917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 37927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The code to implement this API is not available in the public release 37937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of SQLite. 37947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3795a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_key( 37967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Database to be rekeyed */ 37977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void *pKey, int nKey /* The key */ 37987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 37997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 38007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 38017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Change the key on an open database. If the current database is not 38027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the 38037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** database is decrypted. 38047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 38057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The code to implement this API is not available in the public release 38067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of SQLite. 38077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3808a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_rekey( 38097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Database to be rekeyed */ 38107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void *pKey, int nKey /* The new key */ 38117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 38127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 38137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 381471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** Specify the activation key for a SEE database. Unless 381571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** activated, none of the SEE routines will work. 381671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori*/ 381771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API void sqlite3_activate_see( 381871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori const char *zPassPhrase /* Activation phrase */ 381971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori); 382071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#endif 382171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 382271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#ifdef SQLITE_ENABLE_CEROD 382371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori/* 382471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** Specify the activation key for a CEROD database. Unless 382571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** activated, none of the CEROD routines will work. 382671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori*/ 382771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API void sqlite3_activate_cerod( 382871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori const char *zPassPhrase /* Activation phrase */ 382971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori); 383071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#endif 383171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 383271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori/* 3833a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Suspend Execution For A Short Time 38347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3835a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_sleep() function causes the current thread to suspend execution 38367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for at least a number of milliseconds specified in its parameter. 38377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3838a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the operating system does not support sleep requests with 3839a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** millisecond time resolution, then the time will be rounded up to 3840a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the nearest second. ^The number of milliseconds of sleep actually 38417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** requested from the operating system is returned. 38427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3843a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite implements this interface by calling the xSleep() 38447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** method of the default [sqlite3_vfs] object. 38457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3846a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_sleep(int); 38477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 38487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3849a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Name Of The Folder Holding Temporary Files 3850a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3851a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(If this global variable is made to point to a string which is 3852a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the name of a folder (a.k.a. directory), then all temporary files 3853a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** created by SQLite when using a built-in [sqlite3_vfs | VFS] 3854a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will be placed in that directory.)^ ^If this variable 3855a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is a NULL pointer, then SQLite performs a search for an appropriate 3856a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** temporary file directory. 3857a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3858a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** It is not safe to read or modify this variable in more than one 3859a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** thread at a time. It is not safe to read or modify this variable 3860a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** if a [database connection] is being used at the same time in a separate 3861a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** thread. 3862a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** It is intended that this variable be set once 38637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** as part of process initialization and before any SQLite interface 3864a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routines have been called and that this variable remain unchanged 3865a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** thereafter. 3866a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3867a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [temp_store_directory pragma] may modify this variable and cause 3868a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore, 3869a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [temp_store_directory pragma] always assumes that any string 3870a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that this variable points to is held in memory obtained from 3871a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_malloc] and the pragma may attempt to free that memory 3872a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** using [sqlite3_free]. 3873a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Hence, if this variable is modified directly, either it should be 3874a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** made NULL or made to point to memory obtained from [sqlite3_malloc] 3875a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or else the use of the [temp_store_directory pragma] should be avoided. 38767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3877a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory; 38787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 38797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3880a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Test For Auto-Commit Mode 3881a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {autocommit mode} 38827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3883a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_get_autocommit() interface returns non-zero or 38847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** zero if the given database connection is or is not in autocommit mode, 3885a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** respectively. ^Autocommit mode is on by default. 3886a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Autocommit mode is disabled by a [BEGIN] statement. 3887a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK]. 38887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 38897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If certain kinds of errors occur on a statement within a multi-statement 3890a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR], 38917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the 38927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** transaction might be rolled back automatically. The only way to 3893a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** find out whether SQLite automatically rolled back the transaction after 38947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** an error is to use this function. 38957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3896a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If another thread changes the autocommit status of the database 3897a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** connection while this routine is running, then the return value 3898a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is undefined. 38997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3900a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_get_autocommit(sqlite3*); 39017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 39027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3903a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Find The Database Handle Of A Prepared Statement 3904a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3905a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_db_handle interface returns the [database connection] handle 3906a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to which a [prepared statement] belongs. ^The [database connection] 3907a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned by sqlite3_db_handle is the same [database connection] 3908a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that was the first argument 3909a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the [sqlite3_prepare_v2()] call (or its variants) that was used to 3910a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** create the statement in the first place. 3911a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 3912a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*); 3913a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 3914a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 3915a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Find the next prepared statement 39167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3917a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This interface returns a pointer to the next [prepared statement] after 3918a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pStmt associated with the [database connection] pDb. ^If pStmt is NULL 3919a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then this interface returns a pointer to the first prepared statement 3920a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** associated with the database connection pDb. ^If no prepared statement 3921a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** satisfies the conditions of this routine, it returns NULL. 39227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3923a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [database connection] pointer D in a call to 3924a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_next_stmt(D,S)] must refer to an open database 3925a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** connection and in particular must not be a NULL pointer. 39267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3927a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt); 39287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 39297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3930a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Commit And Rollback Notification Callbacks 39317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3932a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_commit_hook() interface registers a callback 3933a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function to be invoked whenever a transaction is [COMMIT | committed]. 3934a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Any callback set by a previous call to sqlite3_commit_hook() 39357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for the same database connection is overridden. 3936a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_rollback_hook() interface registers a callback 3937a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function to be invoked whenever a transaction is [ROLLBACK | rolled back]. 3938a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Any callback set by a previous call to sqlite3_rollback_hook() 39397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for the same database connection is overridden. 3940a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The pArg argument is passed through to the callback. 3941a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the callback on a commit hook function returns non-zero, 3942a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the commit is converted into a rollback. 3943a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3944a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions 3945a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** return the P argument from the previous call of the same function 3946a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on the same [database connection] D, or NULL for 3947a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the first call for each function on D. 3948a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3949a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The callback implementation must not do anything that will modify 3950a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the database connection that invoked the callback. Any actions 3951a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to modify the database connection must be deferred until after the 3952a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** completion of the [sqlite3_step()] call that triggered the commit 3953a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or rollback hook in the first place. 3954a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 3955a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database connections for the meaning of "modify" in this paragraph. 3956a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3957a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Registering a NULL function disables the callback. 3958a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3959a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^When the commit hook callback routine returns zero, the [COMMIT] 3960a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** operation is allowed to continue normally. ^If the commit hook 3961a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK]. 3962a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The rollback hook is invoked on a rollback that results from a commit 3963a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** hook returning non-zero, just as it would be with any other rollback. 3964a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3965a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^For the purposes of this API, a transaction is said to have been 39667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** rolled back if an explicit "ROLLBACK" statement is executed, or 39677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** an error or constraint causes an implicit rollback to occur. 3968a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The rollback callback is not invoked if a transaction is 39697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** automatically rolled back because the database connection is closed. 39707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3971a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also the [sqlite3_update_hook()] interface. 39727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3973a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*); 3974a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*); 39757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 39767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3977a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Data Change Notification Callbacks 39787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3979a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_update_hook() interface registers a callback function 3980a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with the [database connection] identified by the first argument 3981a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to be invoked whenever a row is updated, inserted or deleted. 3982a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Any callback set by a previous call to this function 3983a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for the same database connection is overridden. 39847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3985a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The second argument is a pointer to the function to invoke when a 3986a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** row is updated, inserted or deleted. 3987a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first argument to the callback is a copy of the third argument 3988a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to sqlite3_update_hook(). 3989a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE], 3990a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [SQLITE_UPDATE], depending on the operation that caused the callback 3991a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to be invoked. 3992a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The third and fourth arguments to the callback contain pointers to the 3993a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database and table name containing the affected row. 3994a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The final callback parameter is the [rowid] of the row. 3995a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^In the case of an update, this is the [rowid] after the update takes place. 3996a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3997a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The update hook is not invoked when internal system tables are 3998a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** modified (i.e. sqlite_master and sqlite_sequence).)^ 3999a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4000a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^In the current implementation, the update hook 4001a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not invoked when duplication rows are deleted because of an 4002a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook 4003a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** invoked when rows are deleted using the [truncate optimization]. 4004a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The exceptions defined in this paragraph might change in a future 4005a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** release of SQLite. 4006a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4007a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The update hook implementation must not do anything that will modify 4008a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the database connection that invoked the update hook. Any actions 4009a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to modify the database connection must be deferred until after the 4010a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** completion of the [sqlite3_step()] call that triggered the update hook. 4011a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 4012a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database connections for the meaning of "modify" in this paragraph. 4013a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4014a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_update_hook(D,C,P) function 4015a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returns the P argument from the previous call 4016a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on the same [database connection] D, or NULL for 4017a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the first call on D. 4018a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4019a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also the [sqlite3_commit_hook()] and [sqlite3_rollback_hook()] 4020a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces. 40217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4022a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void *sqlite3_update_hook( 40237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 40247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void(*)(void *,int ,char const *,char const *,sqlite3_int64), 40257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void* 40267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 40277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 40287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4029a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Enable Or Disable Shared Pager Cache 4030a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {shared cache} 40317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4032a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This routine enables or disables the sharing of the database cache 4033a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and schema data structures between [database connection | connections] 4034a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the same database. Sharing is enabled if the argument is true 4035a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and disabled if the argument is false.)^ 40367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4037a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Cache sharing is enabled and disabled for an entire process. 4038a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This is a change as of SQLite version 3.5.0. In prior versions of SQLite, 4039a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sharing was enabled or disabled for each thread separately. 40407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4041a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The cache sharing mode set by this interface effects all subsequent 40427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()]. 40437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Existing database connections continue use the sharing mode 4044a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that was in effect at the time they were opened.)^ 40457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4046a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled 4047a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** successfully. An [error code] is returned otherwise.)^ 40487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4049a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Shared cache is disabled by default. But this might change in 40507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** future releases of SQLite. Applications that care about shared 40517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** cache setting should set it explicitly. 40527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4053a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See Also: [SQLite Shared-Cache Mode] 40547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4055a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_enable_shared_cache(int); 40567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 40577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4058a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Attempt To Free Heap Memory 4059a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4060a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_release_memory() interface attempts to free N bytes 4061a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of heap memory by deallocating non-essential memory allocations 4062a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** held by the database library. Memory used to cache database 4063a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pages to improve performance is an example of non-essential memory. 4064a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^sqlite3_release_memory() returns the number of bytes actually freed, 4065a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** which might be more or less than the amount requested. 40667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4067a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_release_memory(int); 40687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 40697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4070a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Impose A Limit On Heap Size 40717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4072a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_soft_heap_limit() interface places a "soft" limit 4073a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on the amount of heap memory that may be allocated by SQLite. 4074a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If an internal allocation is requested that would exceed the 4075a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** soft heap limit, [sqlite3_release_memory()] is invoked one or 4076a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** more times to free up some space before the allocation is performed. 40777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4078a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The limit is called "soft" because if [sqlite3_release_memory()] 4079a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** cannot free sufficient memory to prevent the limit from being exceeded, 40807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the memory is allocated anyway and the current operation proceeds. 40817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4082a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A negative or zero value for N means that there is no soft heap limit and 40837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_release_memory()] will only be called when memory is exhausted. 4084a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The default value for the soft heap limit is zero. 40857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4086a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(SQLite makes a best effort to honor the soft heap limit. 4087a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** But if the soft heap limit cannot be honored, execution will 4088a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** continue without error or notification.)^ This is why the limit is 40897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** called a "soft" limit. It is advisory only. 40907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 40917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Prior to SQLite version 3.5.0, this routine only constrained the memory 40927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** allocated by a single thread - the same thread in which this routine 40937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** runs. Beginning with SQLite version 3.5.0, the soft heap limit is 40947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** applied to all threads. The value specified for the soft heap limit 40957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is an upper bound on the total memory allocation for all threads. In 40967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** version 3.5.0 there is no mechanism for limiting the heap usage for 40977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** individual threads. 40987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4099a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_soft_heap_limit(int); 41007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 41017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4102a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Extract Metadata About A Column Of A Table 41037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4104a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This routine returns metadata about a specific column of a specific 4105a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database table accessible using the [database connection] handle 4106a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** passed as the first function argument. 41077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4108a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The column is identified by the second, third and fourth parameters to 4109a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** this function. ^The second parameter is either the name of the database 4110a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (i.e. "main", "temp", or an attached database) containing the specified 4111a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** table or NULL. ^If it is NULL, then all attached databases are searched 4112a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for the table using the same algorithm used by the database engine to 41137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** resolve unqualified table references. 41147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4115a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The third and fourth parameters to this function are the table and column 4116a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** name of the desired column, respectively. Neither of these parameters 41177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** may be NULL. 41187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4119a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Metadata is returned by writing to the memory locations passed as the 5th 4120a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and subsequent parameters to this function. ^Any of these arguments may be 4121a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** NULL, in which case the corresponding element of metadata is omitted. 41227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4123a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<blockquote> 4124a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <table border="1"> 4125a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><th> Parameter <th> Output<br>Type <th> Description 41267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4127a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 5th <td> const char* <td> Data type 4128a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 6th <td> const char* <td> Name of default collation sequence 4129a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint 4130a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY 4131a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT] 4132a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </table> 4133a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </blockquote>)^ 41347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4135a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The memory pointed to by the character pointers returned for the 4136a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** declaration type and collation sequence is valid only until the next 4137a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** call to any SQLite API function. 41387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4139a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the specified table is actually a view, an [error code] is returned. 41407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4141a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the specified column is "rowid", "oid" or "_rowid_" and an 4142a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output 4143a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameters are set for the explicitly declared column. ^(If there is no 4144a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** explicitly declared [INTEGER PRIMARY KEY] column, then the output 4145a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameters are set as follows: 41467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 41477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <pre> 41487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** data type: "INTEGER" 41497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** collation sequence: "BINARY" 41507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** not null: 0 41517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** primary key: 1 41527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** auto increment: 0 4153a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </pre>)^ 41547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4155a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This function may load one or more schemas from database files. If an 41567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** error occurs during this process, or if the requested table or column 4157a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** cannot be found, an [error code] is returned and an error message left 4158a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in the [database connection] (to be retrieved using sqlite3_errmsg()).)^ 41597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4160a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This API is only available if the library was compiled with the 4161a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined. 41627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4163a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_table_column_metadata( 41647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Connection handle */ 41657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zDbName, /* Database name or NULL */ 41667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zTableName, /* Table name */ 41677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zColumnName, /* Column name */ 41687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project char const **pzDataType, /* OUTPUT: Declared data type */ 41697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project char const **pzCollSeq, /* OUTPUT: Collation sequence name */ 41707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */ 41717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int *pPrimaryKey, /* OUTPUT: True if column part of PK */ 41727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int *pAutoinc /* OUTPUT: True if column is auto-increment */ 41737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 41747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 41757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4176a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Load An Extension 4177a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4178a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This interface loads an SQLite extension library from the named file. 41797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4180a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_load_extension() interface attempts to load an 4181a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite extension library contained in the file zFile. 41827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4183a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The entry point is zProc. 4184a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^zProc may be 0, in which case the name of the entry point 4185a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** defaults to "sqlite3_extension_init". 4186a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_load_extension() interface returns 4187a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong. 4188a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If an error occurs and pzErrMsg is not 0, then the 4189a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_load_extension()] interface shall attempt to 4190a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** fill *pzErrMsg with error message text stored in memory 4191a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** obtained from [sqlite3_malloc()]. The calling function 4192a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** should free this memory by calling [sqlite3_free()]. 41937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4194a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Extension loading must be enabled using 4195a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_enable_load_extension()] prior to calling this API, 4196a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** otherwise an error will be returned. 41977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4198a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also the [load_extension() SQL function]. 41997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4200a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_load_extension( 42017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Load the extension into this database connection */ 42027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zFile, /* Name of the shared library containing extension */ 42037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zProc, /* Entry point. Derived from zFile if 0 */ 42047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project char **pzErrMsg /* Put error message here if not 0 */ 42057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 42067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 42077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4208a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Enable Or Disable Extension Loading 42097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4210a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^So as not to open security holes in older applications that are 42117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** unprepared to deal with extension loading, and as a means of disabling 4212a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** extension loading while evaluating user-entered SQL, the following API 4213a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is provided to turn the [sqlite3_load_extension()] mechanism on and off. 42147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4215a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Extension loading is off by default. See ticket #1863. 4216a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Call the sqlite3_enable_load_extension() routine with onoff==1 4217a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to turn extension loading on and call it with onoff==0 to turn 4218a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it back off again. 42197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4220a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff); 42217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 42227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4223a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Automatically Load An Extensions 42247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4225a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This API can be invoked at program startup in order to register 42267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** one or more statically linked extensions that will be available 4227a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to all new [database connections]. 4228a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4229a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This routine stores a pointer to the extension entry point 4230a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in an array that is obtained from [sqlite3_malloc()]. That memory 4231a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is deallocated by [sqlite3_reset_auto_extension()].)^ 4232a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4233a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This function registers an extension entry point that is 4234a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** automatically invoked whenever a new [database connection] 4235a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is opened using [sqlite3_open()], [sqlite3_open16()], 4236a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [sqlite3_open_v2()]. 4237a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Duplicate extensions are detected so calling this routine 4238a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** multiple times with the same extension is harmless. 4239a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Automatic extensions apply across all threads. 42407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4241a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_auto_extension(void (*xEntryPoint)(void)); 42427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 42437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4244a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Reset Automatic Extension Loading 42457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4246a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This function disables all previously registered automatic 4247a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** extensions. It undoes the effect of all prior 4248a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_auto_extension()] calls.)^ 42497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4250a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This function disables automatic extensions in all threads. 42517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4252a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_reset_auto_extension(void); 42537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 42547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 42557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The interface to the virtual-table mechanism is currently considered 42567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to be experimental. The interface might change in incompatible ways. 42577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If this is a problem for you, do not use the interface at this time. 42587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4259a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When the virtual-table mechanism stabilizes, we will declare the 42607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface fixed, support it indefinitely, and remove this comment. 42617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 42627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 42637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 42647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Structures used by the virtual table interface 42657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 42667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_vtab sqlite3_vtab; 42677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_index_info sqlite3_index_info; 42687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor; 42697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_module sqlite3_module; 42707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 42717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4272a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Virtual Table Object 4273a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: sqlite3_module {virtual table module} 4274a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4275a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This structure, sometimes called a a "virtual table module", 4276a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** defines the implementation of a [virtual tables]. 4277a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This structure consists mostly of methods for the module. 4278a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4279a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A virtual table module is created by filling in a persistent 4280a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** instance of this structure and passing a pointer to that instance 4281a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to [sqlite3_create_module()] or [sqlite3_create_module_v2()]. 4282a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The registration remains valid until it is replaced by a different 4283a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** module or until the [database connection] closes. The content 4284a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of this structure must not change while it is registered with 4285a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** any database connection. 42867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 42877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projectstruct sqlite3_module { 42887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int iVersion; 42897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xCreate)(sqlite3*, void *pAux, 42907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int argc, const char *const*argv, 42917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_vtab **ppVTab, char**); 42927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xConnect)(sqlite3*, void *pAux, 42937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int argc, const char *const*argv, 42947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_vtab **ppVTab, char**); 42957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*); 42967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xDisconnect)(sqlite3_vtab *pVTab); 42977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xDestroy)(sqlite3_vtab *pVTab); 42987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor); 42997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xClose)(sqlite3_vtab_cursor*); 43007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr, 43017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int argc, sqlite3_value **argv); 43027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xNext)(sqlite3_vtab_cursor*); 43037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xEof)(sqlite3_vtab_cursor*); 43047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int); 43057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid); 43067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *); 43077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xBegin)(sqlite3_vtab *pVTab); 43087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xSync)(sqlite3_vtab *pVTab); 43097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xCommit)(sqlite3_vtab *pVTab); 43107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xRollback)(sqlite3_vtab *pVTab); 43117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName, 43127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), 43137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void **ppArg); 43147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xRename)(sqlite3_vtab *pVtab, const char *zNew); 43157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project}; 43167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 43177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4318a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Virtual Table Indexing Information 43197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** KEYWORDS: sqlite3_index_info 43207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 43217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The sqlite3_index_info structure and its substructures is used to 4322a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pass information into and receive the reply from the [xBestIndex] 4323a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** method of a [virtual table module]. The fields under **Inputs** are the 43247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** inputs to xBestIndex and are read-only. xBestIndex inserts its 43257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** results into the **Outputs** fields. 43267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4327a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The aConstraint[] array records WHERE clause constraints of the form: 43287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4329a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <pre>column OP expr</pre> 43307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4331a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** where OP is =, <, <=, >, or >=.)^ ^(The particular operator is 4332a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** stored in aConstraint[].op.)^ ^(The index of the column is stored in 4333a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the 43347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** expr on the right-hand side can be evaluated (and thus the constraint 4335a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is usable) and false if it cannot.)^ 43367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4337a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The optimizer automatically inverts terms of the form "expr OP column" 43387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and makes other simplifications to the WHERE clause in an attempt to 43397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** get as many WHERE clause terms into the form shown above as possible. 4340a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The aConstraint[] array only reports WHERE clause terms that are 4341a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** relevant to the particular virtual table being queried. 43427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4343a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Information about the ORDER BY clause is stored in aOrderBy[]. 4344a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Each term of aOrderBy records a column of the ORDER BY clause. 43457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4346a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [xBestIndex] method must fill aConstraintUsage[] with information 4347a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** about what parameters to pass to xFilter. ^If argvIndex>0 then 43487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the right-hand side of the corresponding aConstraint[] is evaluated 4349a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit 43507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is true, then the constraint is assumed to be fully handled by the 4351a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** virtual table and is not checked again by SQLite.)^ 43527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4353a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The idxNum and idxPtr values are recorded and passed into the 4354a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [xFilter] method. 4355a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^[sqlite3_free()] is used to free idxPtr if and only if 4356a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** needToFreeIdxPtr is true. 43577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4358a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in 43597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the correct order to satisfy the ORDER BY clause so that no separate 43607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sorting step is required. 43617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4362a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The estimatedCost value is an estimate of the cost of doing the 43637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** particular lookup. A full scan of a table with N entries should have 43647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a cost of N. A binary search of a table of N entries should have a 43657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** cost of approximately log(N). 43667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 43677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projectstruct sqlite3_index_info { 43687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project /* Inputs */ 43697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nConstraint; /* Number of entries in aConstraint */ 43707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project struct sqlite3_index_constraint { 43717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int iColumn; /* Column on left-hand side of constraint */ 43727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project unsigned char op; /* Constraint operator */ 43737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project unsigned char usable; /* True if this constraint is usable */ 43747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int iTermOffset; /* Used internally - xBestIndex should ignore */ 43757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project } *aConstraint; /* Table of WHERE clause constraints */ 43767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nOrderBy; /* Number of terms in the ORDER BY clause */ 43777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project struct sqlite3_index_orderby { 43787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int iColumn; /* Column number */ 43797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project unsigned char desc; /* True for DESC. False for ASC. */ 43807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project } *aOrderBy; /* The ORDER BY clause */ 43817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project /* Outputs */ 43827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project struct sqlite3_index_constraint_usage { 43837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int argvIndex; /* if >0, constraint is part of argv to xFilter */ 43847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project unsigned char omit; /* Do not code a test for this constraint */ 43857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project } *aConstraintUsage; 43867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int idxNum; /* Number used to identify the index */ 43877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project char *idxStr; /* String, possibly obtained from sqlite3_malloc */ 43887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ 43897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int orderByConsumed; /* True if output is already ordered */ 43907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project double estimatedCost; /* Estimated cost of using this index */ 43917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project}; 43927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INDEX_CONSTRAINT_EQ 2 43937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INDEX_CONSTRAINT_GT 4 43947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INDEX_CONSTRAINT_LE 8 43957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INDEX_CONSTRAINT_LT 16 43967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INDEX_CONSTRAINT_GE 32 43977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INDEX_CONSTRAINT_MATCH 64 43987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 43997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4400a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Register A Virtual Table Implementation 4401a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4402a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines are used to register a new [virtual table module] name. 4403a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Module names must be registered before 4404a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** creating a new [virtual table] using the module and before using a 4405a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** preexisting [virtual table] for the module. 4406a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4407a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The module name is registered on the [database connection] specified 4408a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by the first parameter. ^The name of the module is given by the 4409a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** second parameter. ^The third parameter is a pointer to 4410a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the implementation of the [virtual table module]. ^The fourth 4411a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter is an arbitrary client data pointer that is passed through 4412a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** into the [xCreate] and [xConnect] methods of the virtual table module 4413a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** when a new virtual table is be being created or reinitialized. 4414a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4415a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_create_module_v2() interface has a fifth parameter which 4416a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is a pointer to a destructor for the pClientData. ^SQLite will 4417a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** invoke the destructor function (if it is not NULL) when SQLite 4418a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** no longer needs the pClientData pointer. ^The sqlite3_create_module() 4419a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interface is equivalent to sqlite3_create_module_v2() with a NULL 4420a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** destructor. 44217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 442271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_create_module( 44237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* SQLite connection to register module with */ 44247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zName, /* Name of the module */ 4425a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori const sqlite3_module *p, /* Methods for the module */ 4426a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *pClientData /* Client data for xCreate/xConnect */ 44277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 442871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_create_module_v2( 44297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* SQLite connection to register module with */ 44307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zName, /* Name of the module */ 4431a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori const sqlite3_module *p, /* Methods for the module */ 4432a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *pClientData, /* Client data for xCreate/xConnect */ 44337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void(*xDestroy)(void*) /* Module destructor function */ 44347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 44357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 44367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4437a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Virtual Table Instance Object 44387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** KEYWORDS: sqlite3_vtab 4439a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4440a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Every [virtual table module] implementation uses a subclass 4441a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of this object to describe a particular instance 4442a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the [virtual table]. Each subclass will 4443a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** be tailored to the specific needs of the module implementation. 4444a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The purpose of this superclass is to define certain fields that are 4445a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** common to all module implementations. 4446a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4447a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Virtual tables methods can set an error message by assigning a 4448a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should 4449a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** take care that any prior string is freed by a call to [sqlite3_free()] 4450a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** prior to assigning a new string to zErrMsg. ^After the error message 44517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is delivered up to the client application, the string will be automatically 4452a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** freed by sqlite3_free() and the zErrMsg field will be zeroed. 44537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 44547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projectstruct sqlite3_vtab { 44557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const sqlite3_module *pModule; /* The module for this virtual table */ 4456a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int nRef; /* NO LONGER USED */ 44577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project char *zErrMsg; /* Error message from sqlite3_mprintf() */ 44587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project /* Virtual table implementations will typically add additional fields */ 44597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project}; 44607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 44617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4462a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Virtual Table Cursor Object 4463a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor} 44647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4465a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Every [virtual table module] implementation uses a subclass of the 4466a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** following structure to describe cursors that point into the 4467a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [virtual table] and are used 44687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to loop through the virtual table. Cursors are created using the 4469a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed 4470a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by the [sqlite3_module.xClose | xClose] method. Cursors are used 4471a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods 4472a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the module. Each module implementation will define 44737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the content of a cursor structure to suit its own needs. 44747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 44757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** This superclass exists in order to define fields of the cursor that 44767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** are common to all implementations. 44777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 44787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projectstruct sqlite3_vtab_cursor { 44797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_vtab *pVtab; /* Virtual table of this cursor */ 44807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project /* Virtual table implementations will typically add additional fields */ 44817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project}; 44827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 44837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4484a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Declare The Schema Of A Virtual Table 44857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4486a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [xCreate] and [xConnect] methods of a 4487a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [virtual table module] call this interface 44887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to declare the format (the names and datatypes of the columns) of 44897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the virtual tables they implement. 44907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 449171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_declare_vtab(sqlite3*, const char *zSQL); 44927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 44937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4494a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Overload A Function For A Virtual Table 44957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4496a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Virtual tables can provide alternative implementations of functions 4497a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** using the [xFindFunction] method of the [virtual table module]. 4498a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** But global versions of those functions 4499a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** must exist in order to be overloaded.)^ 45007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4501a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This API makes sure a global version of a function with a particular 45027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** name and number of parameters exists. If no such function exists 4503a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** before this API is called, a new function is created.)^ ^The implementation 45047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of the new function always causes an exception to be thrown. So 45057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the new function is not good for anything by itself. Its only 4506a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** purpose is to be a placeholder function that can be overloaded 4507a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by a [virtual table]. 45087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 450971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg); 45107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 45117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 45127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The interface to the virtual-table mechanism defined above (back up 45137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to a comment remarkably similar to this one) is currently considered 45147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to be experimental. The interface might change in incompatible ways. 45157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If this is a problem for you, do not use the interface at this time. 45167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 45177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** When the virtual-table mechanism stabilizes, we will declare the 45187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface fixed, support it indefinitely, and remove this comment. 45197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 45207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 45217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4522a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: A Handle To An Open BLOB 4523a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {BLOB handle} {BLOB handles} 45247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 45257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** An instance of this object represents an open BLOB on which 4526a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_blob_open | incremental BLOB I/O] can be performed. 4527a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Objects of this type are created by [sqlite3_blob_open()] 4528a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and destroyed by [sqlite3_blob_close()]. 4529a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces 4530a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can be used to read or write small subsections of the BLOB. 4531a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes. 45327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 45337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_blob sqlite3_blob; 45347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 45357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4536a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Open A BLOB For Incremental I/O 45377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4538a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located 45397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** in row iRow, column zColumn, table zTable in database zDb; 4540a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in other words, the same BLOB that would be selected by: 45417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 45427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <pre> 4543a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow; 4544a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </pre>)^ 45457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4546a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the flags parameter is non-zero, then the BLOB is opened for read 4547a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and write access. ^If it is zero, the BLOB is opened for read access. 4548a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^It is not possible to open a column that is part of an index or primary 4549a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** key for writing. ^If [foreign key constraints] are enabled, it is 4550a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not possible to open a column that is part of a [child key] for writing. 45517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4552a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Note that the database name is not the filename that contains 45537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the database but rather the symbolic name of the database that 4554a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** appears after the AS keyword when the database is connected using [ATTACH]. 4555a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^For the main database file, the database name is "main". 4556a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^For TEMP tables, the database name is "temp". 4557a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4558a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is written 4559a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to *ppBlob. Otherwise an [error code] is returned and *ppBlob is set 4560a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to be a null pointer.)^ 4561a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This function sets the [database connection] error code and message 4562a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()] and related 4563a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** functions. ^Note that the *ppBlob variable is always initialized in a 4564a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** way that makes it safe to invoke [sqlite3_blob_close()] on *ppBlob 4565a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** regardless of the success or failure of this routine. 4566a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4567a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(If the row that a BLOB handle points to is modified by an 4568a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects 4569a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the BLOB handle is marked as "expired". 4570a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This is true if any column of the row is changed, even a column 4571a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** other than the one the BLOB handle is open on.)^ 4572a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for 4573a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a expired BLOB handle fail with an return code of [SQLITE_ABORT]. 4574a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Changes written into a BLOB prior to the BLOB expiring are not 4575a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** rolled back by the expiration of the BLOB. Such changes will eventually 4576a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** commit if the transaction continues to completion.)^ 4577a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4578a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Use the [sqlite3_blob_bytes()] interface to determine the size of 4579a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the opened blob. ^The size of a blob may not be changed by this 4580a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interface. Use the [UPDATE] SQL command to change the size of a 4581a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** blob. 4582a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4583a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces 4584a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and the built-in [zeroblob] SQL function can be used, if desired, 4585a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to create an empty, zero-filled blob in which to read or write using 4586a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** this interface. 4587a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4588a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** To avoid a resource leak, every open [BLOB handle] should eventually 4589a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** be released by a call to [sqlite3_blob_close()]. 45907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4591a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_blob_open( 45927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 45937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zDb, 45947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zTable, 45957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zColumn, 45967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_int64 iRow, 45977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int flags, 45987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_blob **ppBlob 45997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 46007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 46017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4602a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Close A BLOB Handle 46037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4604a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Closes an open [BLOB handle]. 46057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4606a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Closing a BLOB shall cause the current transaction to commit 46077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** if there are no other BLOBs, no pending prepared statements, and the 4608a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database connection is in [autocommit mode]. 4609a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If any writes were made to the BLOB, they might be held in cache 4610a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** until the close operation if they will fit. 46117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4612a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Closing the BLOB often forces the changes 4613a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** out to disk and so if any I/O errors occur, they will likely occur 4614a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** at the time when the BLOB is closed. Any errors that occur during 4615a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** closing are reported as a non-zero return value.)^ 46167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4617a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The BLOB is closed unconditionally. Even if this routine returns 4618a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an error code, the BLOB is still closed.)^ 46197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4620a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Calling this routine with a null pointer (such as would be returned 4621a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by a failed call to [sqlite3_blob_open()]) is a harmless no-op. 46227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4623a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_blob_close(sqlite3_blob *); 46247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 46257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4626a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Return The Size Of An Open BLOB 46277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4628a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Returns the size in bytes of the BLOB accessible via the 4629a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** successfully opened [BLOB handle] in its only argument. ^The 4630a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** incremental blob I/O routines can only read or overwriting existing 4631a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** blob content; they cannot change the size of a blob. 46327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4633a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This routine only works on a [BLOB handle] which has been created 4634a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by a prior successful call to [sqlite3_blob_open()] and which has not 4635a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** been closed by [sqlite3_blob_close()]. Passing any other pointer in 4636a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to this routine results in undefined and probably undesirable behavior. 46377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4638a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_blob_bytes(sqlite3_blob *); 46397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 46407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4641a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Read Data From A BLOB Incrementally 46427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4643a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This function is used to read data from an open [BLOB handle] into a 4644a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** caller-supplied buffer. N bytes of data are copied into buffer Z 4645a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from the open BLOB, starting at offset iOffset.)^ 46467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4647a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If offset iOffset is less than N bytes from the end of the BLOB, 4648a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_ERROR] is returned and no data is read. ^If N or iOffset is 4649a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** less than zero, [SQLITE_ERROR] is returned and no data is read. 4650a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The size of the blob (and hence the maximum value of N+iOffset) 4651a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can be determined using the [sqlite3_blob_bytes()] interface. 46527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4653a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^An attempt to read from an expired [BLOB handle] fails with an 4654a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** error code of [SQLITE_ABORT]. 46557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4656a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(On success, sqlite3_blob_read() returns SQLITE_OK. 4657a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Otherwise, an [error code] or an [extended error code] is returned.)^ 46587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4659a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This routine only works on a [BLOB handle] which has been created 4660a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by a prior successful call to [sqlite3_blob_open()] and which has not 4661a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** been closed by [sqlite3_blob_close()]. Passing any other pointer in 4662a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to this routine results in undefined and probably undesirable behavior. 46637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4664a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also: [sqlite3_blob_write()]. 46657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4666a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset); 46677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 46687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4669a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Write Data Into A BLOB Incrementally 46707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4671a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This function is used to write data into an open [BLOB handle] from a 4672a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** caller-supplied buffer. ^N bytes of data are copied from the buffer Z 4673a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** into the open BLOB, starting at offset iOffset. 46747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4675a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the [BLOB handle] passed as the first argument was not opened for 4676a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** writing (the flags parameter to [sqlite3_blob_open()] was zero), 4677a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** this function returns [SQLITE_READONLY]. 46787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4679a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This function may only modify the contents of the BLOB; it is 4680a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not possible to increase the size of a BLOB using this API. 4681a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If offset iOffset is less than N bytes from the end of the BLOB, 4682a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_ERROR] is returned and no data is written. ^If N is 46837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** less than zero [SQLITE_ERROR] is returned and no data is written. 4684a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The size of the BLOB (and hence the maximum value of N+iOffset) 4685a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can be determined using the [sqlite3_blob_bytes()] interface. 46867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4687a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^An attempt to write to an expired [BLOB handle] fails with an 4688a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred 4689a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** before the [BLOB handle] expired are not rolled back by the 4690a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** expiration of the handle, though of course those changes might 4691a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** have been overwritten by the statement that expired the BLOB handle 4692a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or by other independent statements. 46937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4694a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(On success, sqlite3_blob_write() returns SQLITE_OK. 4695a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Otherwise, an [error code] or an [extended error code] is returned.)^ 46967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4697a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This routine only works on a [BLOB handle] which has been created 4698a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by a prior successful call to [sqlite3_blob_open()] and which has not 4699a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** been closed by [sqlite3_blob_close()]. Passing any other pointer in 4700a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to this routine results in undefined and probably undesirable behavior. 47017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4702a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also: [sqlite3_blob_read()]. 47037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4704a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset); 47057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 47067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4707a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Virtual File System Objects 47087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 47097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** A virtual filesystem (VFS) is an [sqlite3_vfs] object 47107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** that SQLite uses to interact 47117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** with the underlying operating system. Most SQLite builds come with a 47127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** single default VFS that is appropriate for the host computer. 47137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** New VFSes can be registered and existing VFSes can be unregistered. 47147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The following interfaces are provided. 47157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4716a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name. 4717a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Names are case sensitive. 4718a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Names are zero-terminated UTF-8 strings. 4719a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If there is no match, a NULL pointer is returned. 4720a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If zVfsName is NULL then the default VFS is returned. 4721a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4722a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^New VFSes are registered with sqlite3_vfs_register(). 4723a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Each new VFS becomes the default VFS if the makeDflt flag is set. 4724a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The same VFS can be registered multiple times without injury. 4725a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^To make an existing VFS into the default VFS, register it again 47267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** with the makeDflt flag set. If two different VFSes with the 47277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** same name are registered, the behavior is undefined. If a 47287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** VFS is registered with a name that is NULL or an empty string, 47297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** then the behavior is undefined. 47307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4731a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Unregister a VFS with the sqlite3_vfs_unregister() interface. 4732a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(If the default VFS is unregistered, another VFS is chosen as 4733a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the default. The choice for the new VFS is arbitrary.)^ 47347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4735a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName); 4736a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt); 4737a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*); 47387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 47397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4740a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Mutexes 47417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 47427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The SQLite core uses these routines for thread 4743a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** synchronization. Though they are intended for internal 47447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** use by SQLite, code that links against SQLite is 47457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** permitted to use any of these routines. 47467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4747a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The SQLite source code contains multiple implementations 47487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of these mutex routines. An appropriate implementation 4749a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is selected automatically at compile-time. ^(The following 47507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** implementations are available in the SQLite core: 47517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 47527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 47537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_OS2 47547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_PTHREAD 47557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_W32 47567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_NOOP 4757a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ul>)^ 47587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4759a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The SQLITE_MUTEX_NOOP implementation is a set of routines 4760a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that does no real locking and is appropriate for use in 4761a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a single-threaded application. ^The SQLITE_MUTEX_OS2, 47627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLITE_MUTEX_PTHREAD, and SQLITE_MUTEX_W32 implementations 4763a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are appropriate for use on OS/2, Unix, and Windows. 4764a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4765a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor 47667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex 4767a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation is included with the library. In this case the 4768a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** application must supply a custom mutex implementation using the 4769a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function 4770a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** before calling sqlite3_initialize() or any other public sqlite3_ 4771a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function that calls sqlite3_initialize().)^ 4772a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4773a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_mutex_alloc() routine allocates a new 4774a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** mutex and returns a pointer to it. ^If it returns NULL 4775a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that means that a mutex could not be allocated. ^SQLite 4776a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will unwind its stack and return an error. ^(The argument 47777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to sqlite3_mutex_alloc() is one of these integer constants: 47787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 47797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 47807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_FAST 47817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_RECURSIVE 47827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_STATIC_MASTER 47837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_STATIC_MEM 47847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_STATIC_MEM2 47857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_STATIC_PRNG 47867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_STATIC_LRU 47877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_STATIC_LRU2 4788a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ul>)^ 47897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4790a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) 4791a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** cause sqlite3_mutex_alloc() to create 4792a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE 4793a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is used but not necessarily so when SQLITE_MUTEX_FAST is used. 47947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The mutex implementation does not need to make a distinction 47957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does 4796a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not want to. ^SQLite will only request a recursive mutex in 4797a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** cases where it really needs one. ^If a faster non-recursive mutex 47987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** implementation is available on the host platform, the mutex subsystem 47997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** might return such a mutex in response to SQLITE_MUTEX_FAST. 48007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4801a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other 4802a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return 4803a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a pointer to a static preexisting mutex. ^Six static mutexes are 48047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** used by the current version of SQLite. Future versions of SQLite 48057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** may add additional static mutexes. Static mutexes are for internal 48067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** use by SQLite only. Applications that use SQLite mutexes should 48077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or 48087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLITE_MUTEX_RECURSIVE. 48097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4810a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST 48117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc() 4812a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returns a different mutex on every call. ^But for the static 48137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** mutex types, the same mutex is returned on every call that has 4814a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the same type number. 48157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4816a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_mutex_free() routine deallocates a previously 4817a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocated dynamic mutex. ^SQLite is careful to deallocate every 4818a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** dynamic mutex that it allocates. The dynamic mutexes must not be in 4819a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** use when they are deallocated. Attempting to deallocate a static 4820a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** mutex results in undefined behavior. ^SQLite never deallocates 4821a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a static mutex. 48227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4823a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt 4824a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to enter a mutex. ^If another thread is already within the mutex, 48257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return 4826a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK] 4827a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** upon successful entry. ^(Mutexes created using 48287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread. 4829a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** In such cases the, 48307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** mutex must be exited an equal number of times before another thread 4831a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can enter.)^ ^(If the same thread tries to enter any other 48327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** kind of mutex more than once, the behavior is undefined. 4833a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite will never exhibit 4834a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** such behavior in its own use of mutexes.)^ 48357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4836a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Some systems (for example, Windows 95) do not support the operation 4837a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try() 4838a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will always return SQLITE_BUSY. The SQLite core only ever uses 4839a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_mutex_try() as an optimization so this is acceptable behavior.)^ 48407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4841a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_mutex_leave() routine exits a mutex that was 4842a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** previously entered by the same thread. ^(The behavior 48437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is undefined if the mutex is not currently entered by the 4844a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** calling thread or is not currently allocated. SQLite will 4845a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** never do either.)^ 4846a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4847a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or 4848a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_mutex_leave() is a NULL pointer, then all three routines 4849a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** behave as no-ops. 48507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 48517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()]. 48527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4853a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int); 4854a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_mutex_free(sqlite3_mutex*); 4855a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_mutex_enter(sqlite3_mutex*); 4856a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_mutex_try(sqlite3_mutex*); 4857a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*); 48587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 48597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4860a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Mutex Methods Object 4861a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4862a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** An instance of this structure defines the low-level routines 4863a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** used to allocate and use mutexes. 4864a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4865a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Usually, the default mutex implementations provided by SQLite are 4866a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sufficient, however the user has the option of substituting a custom 4867a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation for specialized deployments or systems for which SQLite 4868a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** does not provide a suitable implementation. In this case, the user 4869a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** creates and populates an instance of this structure to pass 4870a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option. 4871a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Additionally, an instance of this structure can be used as an 4872a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** output variable when querying the system for the current mutex 4873a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation, using the [SQLITE_CONFIG_GETMUTEX] option. 4874a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4875a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The xMutexInit method defined by this structure is invoked as 4876a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** part of system initialization by the sqlite3_initialize() function. 4877a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The xMutexInit routine is calle by SQLite exactly once for each 4878a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** effective call to [sqlite3_initialize()]. 4879a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4880a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The xMutexEnd method defined by this structure is invoked as 4881a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** part of system shutdown by the sqlite3_shutdown() function. The 4882a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation of this method is expected to release all outstanding 4883a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** resources obtained by the mutex methods implementation, especially 4884a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** those obtained by the xMutexInit method. ^The xMutexEnd() 4885a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interface is invoked exactly once for each call to [sqlite3_shutdown()]. 4886a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4887a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The remaining seven methods defined by this structure (xMutexAlloc, 4888a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and 4889a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xMutexNotheld) implement the following interfaces (respectively): 4890a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4891a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <ul> 4892a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_mutex_alloc()] </li> 4893a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_mutex_free()] </li> 4894a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_mutex_enter()] </li> 4895a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_mutex_try()] </li> 4896a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_mutex_leave()] </li> 4897a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_mutex_held()] </li> 4898a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_mutex_notheld()] </li> 4899a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ul>)^ 4900a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4901a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The only difference is that the public sqlite3_XXX functions enumerated 4902a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** above silently ignore any invocations that pass a NULL pointer instead 4903a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of a valid mutex handle. The implementations of the methods defined 4904a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by this structure are not required to handle this case, the results 4905a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of passing a NULL pointer instead of a valid mutex handle are undefined 4906a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (i.e. it is acceptable to provide an implementation that segfaults if 4907a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it is passed a NULL pointer). 4908a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4909a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The xMutexInit() method must be threadsafe. ^It must be harmless to 4910a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** invoke xMutexInit() mutiple times within the same process and without 4911a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** intervening calls to xMutexEnd(). Second and subsequent calls to 4912a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xMutexInit() must be no-ops. 4913a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4914a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()] 4915a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and its associates). ^Similarly, xMutexAlloc() must not use SQLite memory 4916a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocation for a static mutex. ^However xMutexAlloc() may use SQLite 4917a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory allocation for a fast or recursive mutex. 4918a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4919a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is 4920a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** called, but only if the prior call to xMutexInit returned SQLITE_OK. 4921a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If xMutexInit fails in any way, it is expected to clean up after itself 4922a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** prior to returning. 4923a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 4924a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noritypedef struct sqlite3_mutex_methods sqlite3_mutex_methods; 4925a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noristruct sqlite3_mutex_methods { 4926a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xMutexInit)(void); 4927a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xMutexEnd)(void); 4928a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori sqlite3_mutex *(*xMutexAlloc)(int); 4929a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xMutexFree)(sqlite3_mutex *); 4930a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xMutexEnter)(sqlite3_mutex *); 4931a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xMutexTry)(sqlite3_mutex *); 4932a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xMutexLeave)(sqlite3_mutex *); 4933a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xMutexHeld)(sqlite3_mutex *); 4934a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xMutexNotheld)(sqlite3_mutex *); 4935a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori}; 4936a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 4937a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 4938a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Mutex Verification Routines 49397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 49407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines 4941a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are intended for use inside assert() statements. ^The SQLite core 49427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** never uses these routines except inside an assert() and applications 4943a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are advised to follow the lead of the core. ^The SQLite core only 49447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** provides implementations for these routines when it is compiled 4945a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with the SQLITE_DEBUG flag. ^External mutex implementations 49467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** are only required to provide these routines if SQLITE_DEBUG is 49477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** defined and if NDEBUG is not defined. 49487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4949a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines should return true if the mutex in their argument 4950a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is held or not held, respectively, by the calling thread. 49517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4952a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The implementation is not required to provided versions of these 4953a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routines that actually work. If the implementation does not provide working 4954a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** versions of these routines, it should at least provide stubs that always 4955a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** return true so that one does not get spurious assertion failures. 49567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4957a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the argument to sqlite3_mutex_held() is a NULL pointer then 4958a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the routine should return 1. This seems counter-intuitive since 49597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** clearly the mutex cannot be held if it does not exist. But the 49607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the reason the mutex does not exist is because the build is not 49617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** using mutexes. And we do not want the assert() containing the 49627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** call to sqlite3_mutex_held() to fail, so a non-zero return is 4963a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the appropriate thing to do. ^The sqlite3_mutex_notheld() 49647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface should also return 1 when given a NULL pointer. 49657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4966a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#ifndef NDEBUG 4967a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_mutex_held(sqlite3_mutex*); 4968a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*); 4969a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#endif 49707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 49717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4972a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Mutex Types 4973a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4974a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [sqlite3_mutex_alloc()] interface takes a single argument 4975a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** which is one of these integer constants. 49767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4977a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The set of static mutexes may change from one SQLite release to the 4978a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** next. Applications that override the built-in mutex logic must be 4979a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** prepared to accommodate additional static mutexes. 49807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 49817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MUTEX_FAST 0 49827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MUTEX_RECURSIVE 1 49837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MUTEX_STATIC_MASTER 2 49847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */ 4985a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */ 4986a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */ 49877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */ 49887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */ 49897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MUTEX_STATIC_LRU2 7 /* lru page list */ 49907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 49917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4992a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Retrieve the mutex for a database connection 49937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4994a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This interface returns a pointer the [sqlite3_mutex] object that 4995a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** serializes access to the [database connection] given in the argument 4996a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** when the [threading mode] is Serialized. 4997a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the [threading mode] is Single-thread or Multi-thread then this 4998a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routine returns a NULL pointer. 4999a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 5000a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*); 5001a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5002a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 5003a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Low-Level Control Of Database Files 5004a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5005a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_file_control()] interface makes a direct call to the 50067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** xFileControl method for the [sqlite3_io_methods] object associated 5007a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with a particular database identified by the second argument. ^The 5008a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** name of the database "main" for the main database or "temp" for the 5009a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** TEMP database, or the name that appears after the AS keyword for 5010a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** databases that are added using the [ATTACH] SQL command. 5011a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A NULL pointer can be used in place of "main" to refer to the 5012a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** main database file. 5013a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The third and fourth parameters to this routine 50147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** are passed directly through to the second and third parameters of 5015a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the xFileControl method. ^The return value of the xFileControl 50167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** method becomes the return value of this routine. 50177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5018a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the second parameter (zDbName) does not match the name of any 5019a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** open database file, then SQLITE_ERROR is returned. ^This error 50207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** code is not remembered and will not be recalled by [sqlite3_errcode()] 5021a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [sqlite3_errmsg()]. The underlying xFileControl method might 5022a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** also return SQLITE_ERROR. There is no way to distinguish between 50237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** an incorrect zDbName and an SQLITE_ERROR return from the underlying 5024a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xFileControl method. 50257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 50267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** See also: [SQLITE_FCNTL_LOCKSTATE] 50277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 5028a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*); 50297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 50307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5031a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Testing Interface 50327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5033a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_test_control() interface is used to read out internal 50347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** state of SQLite and to inject faults into SQLite for testing 5035a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** purposes. ^The first parameter is an operation code that determines 50367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the number, meaning, and operation of all subsequent parameters. 50377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 50387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** This interface is not for use by applications. It exists solely 50397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for verifying the correct operation of the SQLite library. Depending 50407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** on how the SQLite library is compiled, this interface might not exist. 50417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 50427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The details of the operation codes, their meanings, the parameters 50437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** they take, and what they do are all subject to change without notice. 50447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Unlike most of the SQLite API, this function is not guaranteed to 50457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** operate consistently from one release to the next. 50467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 5047a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_test_control(int op, ...); 50487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 50497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5050a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Testing Interface Operation Codes 50517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 50527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These constants are the valid operation code parameters used 50537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** as the first argument to [sqlite3_test_control()]. 50547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5055a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These parameters and their meanings are subject to change 50567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** without notice. These values are for testing purposes only. 50577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Applications should not use any of these parameters or the 50587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_test_control()] interface. 50597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 5060a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_FIRST 5 50617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_TESTCTRL_PRNG_SAVE 5 50627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_TESTCTRL_PRNG_RESTORE 6 50637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_TESTCTRL_PRNG_RESET 7 50647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_TESTCTRL_BITVEC_TEST 8 5065a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_FAULT_INSTALL 9 5066a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10 5067a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_PENDING_BYTE 11 5068a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_ASSERT 12 5069a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_ALWAYS 13 5070a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_RESERVE 14 5071a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_OPTIMIZATIONS 15 5072a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_ISKEYWORD 16 507371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_TESTCTRL_PGHDRSZ 17 507471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_TESTCTRL_LAST 17 5075a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5076a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 5077a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: SQLite Runtime Status 5078a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5079a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This interface is used to retrieve runtime status information 5080a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** about the preformance of SQLite, and optionally to reset various 5081a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** highwater marks. ^The first argument is an integer code for 5082a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the specific parameter to measure. ^(Recognized integer codes 5083a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are of the form [SQLITE_STATUS_MEMORY_USED | SQLITE_STATUS_...].)^ 5084a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The current value of the parameter is returned into *pCurrent. 5085a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The highest recorded value is returned in *pHighwater. ^If the 5086a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** resetFlag is true, then the highest record value is reset after 5087a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** *pHighwater is written. ^(Some parameters do not record the highest 5088a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value. For those parameters 5089a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** nothing is written into *pHighwater and the resetFlag is ignored.)^ 5090a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Other parameters record only the highwater mark and not the current 5091a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value. For these latter parameters nothing is written into *pCurrent.)^ 5092a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5093a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a 5094a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** non-zero [error code] on failure. 5095a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5096a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This routine is threadsafe but is not atomic. This routine can be 5097a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** called while other threads are running the same or different SQLite 5098a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces. However the values returned in *pCurrent and 5099a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** *pHighwater reflect the status of SQLite at different points in time 5100a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and it is possible that another thread might change the parameter 5101a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in between the times when *pCurrent and *pHighwater are written. 5102a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5103a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also: [sqlite3_db_status()] 5104a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 510571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag); 5106a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5107a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5108a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 5109a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Status Parameters 5110a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5111a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These integer constants designate various run-time status parameters 5112a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that can be returned by [sqlite3_status()]. 5113a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5114a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dl> 5115a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_STATUS_MEMORY_USED</dt> 5116a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter is the current amount of memory checked out 5117a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** using [sqlite3_malloc()], either directly or indirectly. The 5118a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** figure includes calls made to [sqlite3_malloc()] by the application 5119a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and internal memory usage by the SQLite library. Scratch memory 5120a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache 5121a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in 5122a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** this parameter. The amount returned is the sum of the allocation 5123a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^ 5124a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5125a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt> 5126a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter records the largest memory allocation request 5127a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their 5128a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** internal equivalents). Only the value returned in the 5129a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** *pHighwater parameter to [sqlite3_status()] is of interest. 5130a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The value written into the *pCurrent parameter is undefined.</dd>)^ 5131a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5132a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt> 5133a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter returns the number of pages used out of the 5134a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [pagecache memory allocator] that was configured using 5135a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_CONFIG_PAGECACHE]. The 5136a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value returned is in pages, not in bytes.</dd>)^ 5137a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5138a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt> 5139a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter returns the number of bytes of page cache 5140a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocation which could not be statisfied by the [SQLITE_CONFIG_PAGECACHE] 5141a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** buffer and where forced to overflow to [sqlite3_malloc()]. The 5142a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned value includes allocations that overflowed because they 5143a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** where too large (they were larger than the "sz" parameter to 5144a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because 5145a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** no space was left in the page cache.</dd>)^ 5146a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5147a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt> 5148a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter records the largest memory allocation request 5149a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** handed to [pagecache memory allocator]. Only the value returned in the 5150a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** *pHighwater parameter to [sqlite3_status()] is of interest. 5151a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The value written into the *pCurrent parameter is undefined.</dd>)^ 5152a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5153a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_STATUS_SCRATCH_USED</dt> 5154a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter returns the number of allocations used out of the 5155a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [scratch memory allocator] configured using 5156a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not 5157a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in bytes. Since a single thread may only have one scratch allocation 5158a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** outstanding at time, this parameter also reports the number of threads 5159a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** using scratch memory at the same time.</dd>)^ 5160a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5161a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt> 5162a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter returns the number of bytes of scratch memory 5163a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocation which could not be statisfied by the [SQLITE_CONFIG_SCRATCH] 5164a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** buffer and where forced to overflow to [sqlite3_malloc()]. The values 5165a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned include overflows because the requested allocation was too 5166a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** larger (that is, because the requested allocation was larger than the 5167a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer 5168a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** slots were available. 5169a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dd>)^ 5170a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5171a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_STATUS_SCRATCH_SIZE</dt> 5172a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter records the largest memory allocation request 5173a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** handed to [scratch memory allocator]. Only the value returned in the 5174a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** *pHighwater parameter to [sqlite3_status()] is of interest. 5175a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The value written into the *pCurrent parameter is undefined.</dd>)^ 5176a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5177a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_STATUS_PARSER_STACK</dt> 5178a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter records the deepest parser stack. It is only 5179a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^ 5180a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dl> 5181a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5182a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** New status parameters may be added from time to time. 5183a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 5184a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_MEMORY_USED 0 5185a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_PAGECACHE_USED 1 5186a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_PAGECACHE_OVERFLOW 2 5187a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_SCRATCH_USED 3 5188a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_SCRATCH_OVERFLOW 4 5189a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_MALLOC_SIZE 5 5190a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_PARSER_STACK 6 5191a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_PAGECACHE_SIZE 7 5192a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_SCRATCH_SIZE 8 5193a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5194a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 5195a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Database Connection Status 5196a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5197a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This interface is used to retrieve runtime status information 5198a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** about a single [database connection]. ^The first argument is the 5199a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database connection object to be interrogated. ^The second argument 520071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** is an integer constant, taken from the set of 520171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [SQLITE_DBSTATUS_LOOKASIDE_USED | SQLITE_DBSTATUS_*] macros, that 520271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** determiness the parameter to interrogate. The set of 520371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [SQLITE_DBSTATUS_LOOKASIDE_USED | SQLITE_DBSTATUS_*] macros is likely 520471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** to grow in future releases of SQLite. 5205a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5206a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The current value of the requested parameter is written into *pCur 5207a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and the highest instantaneous value is written into *pHiwtr. ^If 5208a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the resetFlg is true, then the highest instantaneous value is 5209a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** reset back down to the current value. 5210a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5211a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also: [sqlite3_status()] and [sqlite3_stmt_status()]. 5212a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 521371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg); 5214a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5215a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 5216a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Status Parameters for database connections 5217a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5218a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These constants are the available integer "verbs" that can be passed as 5219a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the second argument to the [sqlite3_db_status()] interface. 5220a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5221a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** New verbs may be added in future releases of SQLite. Existing verbs 5222a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** might be discontinued. Applications should check the return code from 5223a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_db_status()] to make sure that the call worked. 5224a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [sqlite3_db_status()] interface will return a non-zero error code 5225a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** if a discontinued or unsupported verb is invoked. 5226a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5227a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dl> 5228a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt> 5229a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter returns the number of lookaside memory slots currently 5230a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** checked out.</dd>)^ 523171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 523271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <dt>SQLITE_DBSTATUS_CACHE_USED</dt> 523371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <dd>^This parameter returns the approximate number of of bytes of heap 523471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** memory used by all pager caches associated with the database connection. 523571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0. 523671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** checked out.</dd>)^ 5237a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dl> 5238a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 5239a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_DBSTATUS_LOOKASIDE_USED 0 524071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_DBSTATUS_CACHE_USED 1 524171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_DBSTATUS_MAX 1 /* Largest defined DBSTATUS */ 5242a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5243a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5244a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 5245a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Prepared Statement Status 5246a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5247a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Each prepared statement maintains various 5248a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_STMTSTATUS_SORT | counters] that measure the number 5249a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of times it has performed specific operations.)^ These counters can 5250a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** be used to monitor the performance characteristics of the prepared 5251a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** statements. For example, if the number of table steps greatly exceeds 5252a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the number of table searches or result rows, that would tend to indicate 5253a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that the prepared statement is using a full table scan rather than 5254a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an index. 5255a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5256a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This interface is used to retrieve and reset counter values from 5257a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a [prepared statement]. The first argument is the prepared statement 5258a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** object to be interrogated. The second argument 5259a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is an integer code for a specific [SQLITE_STMTSTATUS_SORT | counter] 5260a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to be interrogated.)^ 5261a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The current value of the requested counter is returned. 5262a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the resetFlg is true, then the counter is reset to zero after this 5263a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interface call returns. 5264a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5265a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also: [sqlite3_status()] and [sqlite3_db_status()]. 5266a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 526771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg); 5268a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5269a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 5270a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Status Parameters for prepared statements 5271a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5272a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These preprocessor macros define integer codes that name counter 5273a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** values associated with the [sqlite3_stmt_status()] interface. 5274a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The meanings of the various counters are as follows: 5275a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5276a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dl> 5277a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt> 5278a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>^This is the number of times that SQLite has stepped forward in 5279a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a table as part of a full table scan. Large numbers for this counter 5280a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** may indicate opportunities for performance improvement through 5281a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** careful use of indices.</dd> 5282a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5283a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dt>SQLITE_STMTSTATUS_SORT</dt> 5284a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>^This is the number of sort operations that have occurred. 5285a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A non-zero value in this counter may indicate an opportunity to 5286a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** improvement performance through careful use of indices.</dd> 5287a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 528871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt> 528971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <dd>^This is the number of rows inserted into transient indices that 529071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** were created automatically in order to help joins run faster. 529171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** A non-zero value in this counter may indicate an opportunity to 529271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** improvement performance by adding permanent indices that do not 529371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** need to be reinitialized each time the statement is run.</dd> 529471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 5295a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dl> 5296a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 5297a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STMTSTATUS_FULLSCAN_STEP 1 5298a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STMTSTATUS_SORT 2 529971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_STMTSTATUS_AUTOINDEX 3 5300a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5301a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 5302a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Custom Page Cache Object 5303a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5304a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_pcache type is opaque. It is implemented by 5305a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the pluggable module. The SQLite core has no knowledge of 5306a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** its size or internal structure and never deals with the 5307a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_pcache object except by holding and passing pointers 5308a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the object. 5309a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5310a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See [sqlite3_pcache_methods] for additional information. 5311a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 5312a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noritypedef struct sqlite3_pcache sqlite3_pcache; 5313a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5314a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 5315a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Application Defined Page Cache. 5316a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {page cache} 5317a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5318a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE], ...) interface can 5319a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** register an alternative page cache implementation by passing in an 5320a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** instance of the sqlite3_pcache_methods structure.)^ The majority of the 5321a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** heap memory used by SQLite is used by the page cache to cache data read 5322a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from, or ready to be written to, the database file. By implementing a 5323a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** custom page cache using this API, an application can control more 5324a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** precisely the amount of memory consumed by SQLite, the way in which 5325a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that memory is allocated and released, and the policies used to 5326a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** determine exactly which parts of a database file are cached and for 5327a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** how long. 5328a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5329a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The contents of the sqlite3_pcache_methods structure are copied to an 5330a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** internal buffer by SQLite within the call to [sqlite3_config]. Hence 5331a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the application may discard the parameter after the call to 5332a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] returns.)^ 5333a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5334a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The xInit() method is called once for each call to [sqlite3_initialize()] 5335a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (usually only once during the lifetime of the process). ^(The xInit() 5336a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** method is passed a copy of the sqlite3_pcache_methods.pArg value.)^ 5337a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The xInit() method can set up up global structures and/or any mutexes 5338a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** required by the custom page cache implementation. 5339a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5340a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The xShutdown() method is called from within [sqlite3_shutdown()], 5341a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** if the application invokes this API. It can be used to clean up 5342a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** any outstanding resources before process shutdown, if required. 5343a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5344a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite holds a [SQLITE_MUTEX_RECURSIVE] mutex when it invokes 5345a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the xInit method, so the xInit method need not be threadsafe. ^The 5346a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xShutdown method is only called from [sqlite3_shutdown()] so it does 5347a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not need to be threadsafe either. All other methods must be threadsafe 5348a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in multithreaded applications. 5349a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5350a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite will never invoke xInit() more than once without an intervening 5351a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** call to xShutdown(). 5352a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5353a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The xCreate() method is used to construct a new cache instance. SQLite 5354a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will typically create one cache instance for each open database file, 5355a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** though this is not guaranteed. ^The 5356a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** first parameter, szPage, is the size in bytes of the pages that must 5357a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** be allocated by the cache. ^szPage will not be a power of two. ^szPage 5358a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will the page size of the database file that is to be cached plus an 5359a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** increment (here called "R") of about 100 or 200. ^SQLite will use the 5360a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** extra R bytes on each page to store metadata about the underlying 5361a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database page on disk. The value of R depends 5362a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on the SQLite version, the target platform, and how SQLite was compiled. 5363a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^R is constant for a particular build of SQLite. ^The second argument to 5364a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xCreate(), bPurgeable, is true if the cache being created will 5365a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** be used to cache database pages of a file stored on disk, or 5366a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** false if it is used for an in-memory database. ^The cache implementation 5367a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** does not have to do anything special based with the value of bPurgeable; 5368a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will 5369a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** never invoke xUnpin() except to deliberately delete a page. 5370a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^In other words, a cache created with bPurgeable set to false will 5371a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** never contain any unpinned pages. 5372a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5373a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The xCachesize() method may be called at any time by SQLite to set the 5374a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** suggested maximum cache-size (number of pages stored by) the cache 5375a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** instance passed as the first argument. This is the value configured using 5376a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the SQLite "[PRAGMA cache_size]" command.)^ ^As with the bPurgeable 5377a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter, the implementation is not required to do anything with this 5378a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value; it is advisory only. 5379a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5380a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The xPagecount() method should return the number of pages currently 5381a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** stored in the cache. 5382a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5383a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The xFetch() method is used to fetch a page and return a pointer to it. 5384a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A 'page', in this context, is a buffer of szPage bytes aligned at an 5385a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 8-byte boundary. ^The page to be fetched is determined by the key. ^The 5386a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** mimimum key value is 1. After it has been retrieved using xFetch, the page 5387a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is considered to be "pinned". 5388a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5389a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the requested page is already in the page cache, then the page cache 5390a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation must return a pointer to the page buffer with its content 5391a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** intact. ^(If the requested page is not already in the cache, then the 5392a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** behavior of the cache implementation is determined by the value of the 5393a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** createFlag parameter passed to xFetch, according to the following table: 5394a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5395a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <table border=1 width=85% align=center> 5396a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><th> createFlag <th> Behaviour when page is not already in cache 5397a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 0 <td> Do not allocate a new page. Return NULL. 5398a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so. 5399a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Otherwise return NULL. 5400a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 2 <td> Make every effort to allocate a new page. Only return 5401a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** NULL if allocating a new page is effectively impossible. 5402a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </table>)^ 5403a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5404a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite will normally invoke xFetch() with a createFlag of 0 or 1. If 5405a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a call to xFetch() with createFlag==1 returns NULL, then SQLite will 5406a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** attempt to unpin one or more cache pages by spilling the content of 5407a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pinned pages to disk and synching the operating system disk cache. After 5408a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** attempting to unpin pages, the xFetch() method will be invoked again with 5409a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a createFlag of 2. 5410a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5411a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^xUnpin() is called by SQLite with a pointer to a currently pinned page 5412a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** as its second argument. ^(If the third parameter, discard, is non-zero, 5413a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the page should be evicted from the cache. In this case SQLite 5414a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** assumes that the next time the page is retrieved from the cache using 5415a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the xFetch() method, it will be zeroed.)^ ^If the discard parameter is 5416a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** zero, then the page is considered to be unpinned. ^The cache implementation 5417a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** may choose to evict unpinned pages at any time. 5418a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5419a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The cache is not required to perform any reference counting. A single 5420a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** call to xUnpin() unpins the page regardless of the number of prior calls 5421a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to xFetch().)^ 5422a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5423a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The xRekey() method is used to change the key value associated with the 5424a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** page passed as the second argument from oldKey to newKey. ^If the cache 5425a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** previously contains an entry associated with newKey, it should be 5426a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** discarded. ^Any prior cache entry associated with newKey is guaranteed not 5427a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to be pinned. 5428a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5429a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^When SQLite calls the xTruncate() method, the cache must discard all 5430a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** existing cache entries with page numbers (keys) greater than or equal 5431a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the value of the iLimit parameter passed to xTruncate(). ^If any 5432a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of these pages are pinned, they are implicitly unpinned, meaning that 5433a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** they can be safely discarded. 5434a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5435a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The xDestroy() method is used to delete a cache allocated by xCreate(). 5436a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** All resources associated with the specified cache should be freed. ^After 5437a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*] 5438a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** handle invalid, and will not use it with any other sqlite3_pcache_methods 5439a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** functions. 5440a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 5441a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noritypedef struct sqlite3_pcache_methods sqlite3_pcache_methods; 5442a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noristruct sqlite3_pcache_methods { 5443a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *pArg; 5444a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xInit)(void*); 5445a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xShutdown)(void*); 5446a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable); 5447a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xCachesize)(sqlite3_pcache*, int nCachesize); 5448a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xPagecount)(sqlite3_pcache*); 5449a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); 5450a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xUnpin)(sqlite3_pcache*, void*, int discard); 5451a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey); 5452a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); 5453a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xDestroy)(sqlite3_pcache*); 5454a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori}; 5455a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5456a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 5457a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Online Backup Object 5458a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5459a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_backup object records state information about an ongoing 5460a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** online backup operation. ^The sqlite3_backup object is created by 5461a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a call to [sqlite3_backup_init()] and is destroyed by a call to 5462a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_backup_finish()]. 5463a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5464a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See Also: [Using the SQLite Online Backup API] 5465a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 5466a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noritypedef struct sqlite3_backup sqlite3_backup; 5467a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5468a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 5469a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Online Backup API. 5470a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5471a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The backup API copies the content of one database into another. 5472a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** It is useful either for creating backups of databases or 5473a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for copying in-memory databases to or from persistent files. 5474a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5475a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See Also: [Using the SQLite Online Backup API] 5476a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5477a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Exclusive access is required to the destination database for the 5478a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** duration of the operation. ^However the source database is only 5479a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** read-locked while it is actually being read; it is not locked 5480a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** continuously for the entire backup operation. ^Thus, the backup may be 5481a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** performed on a live source database without preventing other users from 5482a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** reading or writing to the source database while the backup is underway. 5483a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5484a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(To perform a backup operation: 5485a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <ol> 5486a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li><b>sqlite3_backup_init()</b> is called once to initialize the 5487a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** backup, 5488a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer 5489a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the data between the two databases, and finally 5490a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li><b>sqlite3_backup_finish()</b> is called to release all resources 5491a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** associated with the backup operation. 5492a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ol>)^ 5493a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** There should be exactly one call to sqlite3_backup_finish() for each 5494a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** successful call to sqlite3_backup_init(). 5495a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5496a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <b>sqlite3_backup_init()</b> 5497a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5498a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the 5499a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection] associated with the destination database 5500a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and the database name, respectively. 5501a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The database name is "main" for the main database, "temp" for the 5502a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** temporary database, or the name specified after the AS keyword in 5503a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an [ATTACH] statement for an attached database. 5504a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The S and M arguments passed to 5505a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_init(D,N,S,M) identify the [database connection] 5506a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and database name of the source database, respectively. 5507a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The source and destination [database connections] (parameters S and D) 5508a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** must be different or else sqlite3_backup_init(D,N,S,M) will file with 5509a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an error. 5510a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5511a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is 5512a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned and an error code and error message are store3d in the 5513a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** destination [database connection] D. 5514a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The error code and message for the failed call to sqlite3_backup_init() 5515a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or 5516a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_errmsg16()] functions. 5517a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A successful call to sqlite3_backup_init() returns a pointer to an 5518a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_backup] object. 5519a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and 5520a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_finish() functions to perform the specified backup 5521a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** operation. 5522a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5523a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <b>sqlite3_backup_step()</b> 5524a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5525a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Function sqlite3_backup_step(B,N) will copy up to N pages between 5526a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the source and destination databases specified by [sqlite3_backup] object B. 5527a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If N is negative, all remaining source pages are copied. 5528a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_backup_step(B,N) successfully copies N pages and there 5529a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are still more pages to be copied, then the function resturns [SQLITE_OK]. 5530a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages 5531a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from source to destination, then it returns [SQLITE_DONE]. 5532a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If an error occurs while running sqlite3_backup_step(B,N), 5533a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then an [error code] is returned. ^As well as [SQLITE_OK] and 5534a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY], 5535a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an 5536a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code. 5537a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 553871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^(The sqlite3_backup_step() might return [SQLITE_READONLY] if 553971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <ol> 554071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <li> the destination database was opened read-only, or 554171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <li> the destination database is using write-ahead-log journaling 554271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** and the destination and source page sizes differ, or 554371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <li> The destination database is an in-memory database and the 554471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** destination and source page sizes differ. 554571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** </ol>)^ 5546a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5547a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then 5548a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [sqlite3_busy_handler | busy-handler function] 5549a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is invoked (if one is specified). ^If the 5550a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** busy-handler returns non-zero before the lock is available, then 5551a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_BUSY] is returned to the caller. ^In this case the call to 5552a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_step() can be retried later. ^If the source 5553a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection] 5554a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is being used to write to the source database when sqlite3_backup_step() 5555a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this 5556a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** case the call to sqlite3_backup_step() can be retried later on. ^(If 5557a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or 5558a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_READONLY] is returned, then 5559a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** there is no point in retrying the call to sqlite3_backup_step(). These 5560a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** errors are considered fatal.)^ The application must accept 5561a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that the backup operation has failed and pass the backup operation handle 5562a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the sqlite3_backup_finish() to release associated resources. 5563a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5564a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first call to sqlite3_backup_step() obtains an exclusive lock 5565a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on the destination file. ^The exclusive lock is not released until either 5566a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_finish() is called or the backup operation is complete 5567a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and sqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to 5568a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_step() obtains a [shared lock] on the source database that 5569a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** lasts for the duration of the sqlite3_backup_step() call. 5570a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Because the source database is not locked between calls to 5571a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_step(), the source database may be modified mid-way 5572a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** through the backup process. ^If the source database is modified by an 5573a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** external process or via a database connection other than the one being 5574a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** used by the backup operation, then the backup will be automatically 5575a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** restarted by the next call to sqlite3_backup_step(). ^If the source 5576a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database is modified by the using the same database connection as is used 5577a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by the backup operation, then the backup database is automatically 5578a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** updated at the same time. 5579a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5580a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <b>sqlite3_backup_finish()</b> 5581a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5582a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the 5583a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** application wishes to abandon the backup operation, the application 5584a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish(). 5585a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_backup_finish() interfaces releases all 5586a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** resources associated with the [sqlite3_backup] object. 5587a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any 5588a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** active write-transaction on the destination database is rolled back. 5589a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [sqlite3_backup] object is invalid 5590a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and may not be used following a call to sqlite3_backup_finish(). 5591a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5592a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no 5593a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_step() errors occurred, regardless or whether or not 5594a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_step() completed. 5595a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If an out-of-memory condition or IO error occurred during any prior 5596a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_step() call on the same [sqlite3_backup] object, then 5597a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_finish() returns the corresponding [error code]. 5598a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5599a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step() 5600a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not a permanent error and does not affect the return value of 5601a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_finish(). 5602a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5603a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <b>sqlite3_backup_remaining(), sqlite3_backup_pagecount()</b> 5604a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5605a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Each call to sqlite3_backup_step() sets two values inside 5606a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [sqlite3_backup] object: the number of pages still to be backed 5607a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** up and the total number of pages in the source databae file. 5608a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_backup_remaining() and sqlite3_backup_pagecount() interfaces 5609a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** retrieve these two values, respectively. 5610a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5611a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The values returned by these functions are only updated by 5612a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_step(). ^If the source database is modified during a backup 5613a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** operation, then the values are not updated to account for any extra 5614a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pages that need to be updated or the size of the source database file 5615a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** changing. 5616a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5617a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <b>Concurrent Usage of Database Handles</b> 5618a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5619a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The source [database connection] may be used by the application for other 5620a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** purposes while a backup operation is underway or being initialized. 5621a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If SQLite is compiled and configured to support threadsafe database 5622a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** connections, then the source database connection may be used concurrently 5623a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from within other threads. 5624a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5625a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** However, the application must guarantee that the destination 5626a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection] is not passed to any other API (by any thread) after 5627a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_init() is called and before the corresponding call to 5628a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_finish(). SQLite does not currently check to see 5629a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** if the application incorrectly accesses the destination [database connection] 5630a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and so no error code is reported, but the operations may malfunction 5631a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** nevertheless. Use of the destination database connection while a 5632a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** backup is in progress might also also cause a mutex deadlock. 5633a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5634a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If running in [shared cache mode], the application must 5635a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** guarantee that the shared cache used by the destination database 5636a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not accessed while the backup is running. In practice this means 5637a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that the application must guarantee that the disk file being 5638a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** backed up to is not accessed by any connection within the process, 5639a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not just the specific connection that was passed to sqlite3_backup_init(). 5640a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5641a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [sqlite3_backup] object itself is partially threadsafe. Multiple 5642a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** threads may safely make multiple concurrent calls to sqlite3_backup_step(). 5643a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount() 5644a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** APIs are not strictly speaking threadsafe. If they are invoked at the 5645a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** same time as another thread is invoking sqlite3_backup_step() it is 5646a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** possible that they return invalid values. 5647a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 5648a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3_backup *sqlite3_backup_init( 5649a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori sqlite3 *pDest, /* Destination database handle */ 5650a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori const char *zDestName, /* Destination database name */ 5651a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori sqlite3 *pSource, /* Source database handle */ 5652a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori const char *zSourceName /* Source database name */ 5653a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori); 5654a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_backup_step(sqlite3_backup *p, int nPage); 5655a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_backup_finish(sqlite3_backup *p); 5656a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_backup_remaining(sqlite3_backup *p); 5657a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p); 5658a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5659a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 5660a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Unlock Notification 5661a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5662a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^When running in shared-cache mode, a database operation may fail with 5663a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an [SQLITE_LOCKED] error if the required locks on the shared-cache or 5664a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** individual tables within the shared-cache cannot be obtained. See 5665a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLite Shared-Cache Mode] for a description of shared-cache locking. 5666a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This API may be used to register a callback that SQLite will invoke 5667a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** when the connection currently holding the required lock relinquishes it. 5668a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This API is only available if the library was compiled with the 5669a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined. 5670a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5671a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See Also: [Using the SQLite Unlock Notification Feature]. 5672a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5673a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Shared-cache locks are released when a database connection concludes 5674a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** its current transaction, either by committing it or rolling it back. 5675a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5676a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^When a connection (known as the blocked connection) fails to obtain a 5677a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** shared-cache lock and SQLITE_LOCKED is returned to the caller, the 5678a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** identity of the database connection (the blocking connection) that 5679a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** has locked the required resource is stored internally. ^After an 5680a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** application receives an SQLITE_LOCKED error, it may call the 5681a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_unlock_notify() method with the blocked connection handle as 5682a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the first argument to register for a callback that will be invoked 5683a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** when the blocking connections current transaction is concluded. ^The 5684a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** callback is invoked from within the [sqlite3_step] or [sqlite3_close] 5685a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** call that concludes the blocking connections transaction. 5686a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5687a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(If sqlite3_unlock_notify() is called in a multi-threaded application, 5688a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** there is a chance that the blocking connection will have already 5689a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** concluded its transaction by the time sqlite3_unlock_notify() is invoked. 5690a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If this happens, then the specified callback is invoked immediately, 5691a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from within the call to sqlite3_unlock_notify().)^ 5692a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5693a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the blocked connection is attempting to obtain a write-lock on a 5694a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** shared-cache table, and more than one other connection currently holds 5695a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a read-lock on the same table, then SQLite arbitrarily selects one of 5696a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the other connections to use as the blocking connection. 5697a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5698a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(There may be at most one unlock-notify callback registered by a 5699a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** blocked connection. If sqlite3_unlock_notify() is called when the 5700a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** blocked connection already has a registered unlock-notify callback, 5701a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is 5702a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** called with a NULL pointer as its second argument, then any existing 5703a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** unlock-notify callback is cancelled. ^The blocked connections 5704a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** unlock-notify callback may also be canceled by closing the blocked 5705a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** connection using [sqlite3_close()]. 5706a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5707a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The unlock-notify callback is not reentrant. If an application invokes 5708a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** any sqlite3_xxx API functions from within an unlock-notify callback, a 5709a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** crash or deadlock may be the result. 5710a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5711a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Unless deadlock is detected (see below), sqlite3_unlock_notify() always 5712a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returns SQLITE_OK. 5713a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5714a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <b>Callback Invocation Details</b> 5715a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5716a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When an unlock-notify callback is registered, the application provides a 5717a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** single void* pointer that is passed to the callback when it is invoked. 5718a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** However, the signature of the callback function allows SQLite to pass 5719a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it an array of void* context pointers. The first argument passed to 5720a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an unlock-notify callback is a pointer to an array of void* pointers, 5721a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and the second is the number of entries in the array. 5722a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5723a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When a blocking connections transaction is concluded, there may be 5724a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** more than one blocked connection that has registered for an unlock-notify 5725a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** callback. ^If two or more such blocked connections have specified the 5726a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** same callback function, then instead of invoking the callback function 5727a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** multiple times, it is invoked once with the set of void* context pointers 5728a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** specified by the blocked connections bundled together into an array. 5729a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This gives the application an opportunity to prioritize any actions 5730a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** related to the set of unblocked database connections. 5731a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5732a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <b>Deadlock Detection</b> 5733a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5734a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Assuming that after registering for an unlock-notify callback a 5735a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database waits for the callback to be issued before taking any further 5736a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** action (a reasonable assumption), then using this API may cause the 5737a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** application to deadlock. For example, if connection X is waiting for 5738a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** connection Y's transaction to be concluded, and similarly connection 5739a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Y is waiting on connection X's transaction, then neither connection 5740a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will proceed and the system may remain deadlocked indefinitely. 5741a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5742a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock 5743a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** detection. ^If a given call to sqlite3_unlock_notify() would put the 5744a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** system in a deadlocked state, then SQLITE_LOCKED is returned and no 5745a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** unlock-notify callback is registered. The system is said to be in 5746a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a deadlocked state if connection A has registered for an unlock-notify 5747a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** callback on the conclusion of connection B's transaction, and connection 5748a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** B has itself registered for an unlock-notify callback when connection 5749a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A's transaction is concluded. ^Indirect deadlock is also detected, so 5750a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the system is also considered to be deadlocked if connection B has 5751a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** registered for an unlock-notify callback on the conclusion of connection 5752a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** C's transaction, where connection C is waiting on connection A. ^Any 5753a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** number of levels of indirection are allowed. 5754a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5755a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <b>The "DROP TABLE" Exception</b> 5756a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5757a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost 5758a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** always appropriate to call sqlite3_unlock_notify(). There is however, 5759a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement, 5760a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite checks if there are any currently executing SELECT statements 5761a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that belong to the same connection. If there are, SQLITE_LOCKED is 5762a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned. In this case there is no "blocking connection", so invoking 5763a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_unlock_notify() results in the unlock-notify callback being 5764a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** invoked immediately. If the application then re-attempts the "DROP TABLE" 5765a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or "DROP INDEX" query, an infinite loop might be the result. 5766a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5767a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** One way around this problem is to check the extended error code returned 5768a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by an sqlite3_step() call. ^(If there is a blocking connection, then the 5769a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in 5770a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the special "DROP TABLE/INDEX" case, the extended error code is just 5771a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_LOCKED.)^ 5772a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 5773a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_unlock_notify( 5774a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori sqlite3 *pBlocked, /* Waiting connection */ 5775a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */ 5776a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *pNotifyArg /* Argument to pass to xNotify */ 5777a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori); 5778a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5779a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5780a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 5781a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: String Comparison 5782a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5783a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_strnicmp()] API allows applications and extensions to 5784a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** compare the contents of two buffers containing UTF-8 strings in a 5785a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** case-indendent fashion, using the same definition of case independence 5786a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that SQLite uses internally when comparing identifiers. 5787a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 5788a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_strnicmp(const char *, const char *, int); 57897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 5790aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori/* 5791aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** CAPI3REF: Error Logging Interface 5792aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** 5793aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** ^The [sqlite3_log()] interface writes a message into the error log 579471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()]. 579571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^If logging is enabled, the zFormat string and subsequent arguments are 579671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** used with [sqlite3_snprintf()] to generate the final output string. 5797aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** 5798aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** The sqlite3_log() interface is intended for use by extensions such as 5799aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** virtual tables, collating functions, and SQL functions. While there is 5800aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** nothing to prevent an application from calling sqlite3_log(), doing so 5801aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** is considered bad form. 5802ebcc71fd53ce7cf46aff607df2d4bff793837176Vasu Nori** 580371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** The zFormat string must not be NULL. 580471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 5805ebcc71fd53ce7cf46aff607df2d4bff793837176Vasu Nori** To avoid deadlocks and other threading problems, the sqlite3_log() routine 5806ebcc71fd53ce7cf46aff607df2d4bff793837176Vasu Nori** will not use dynamically allocated memory. The log message is stored in 5807ebcc71fd53ce7cf46aff607df2d4bff793837176Vasu Nori** a fixed-length buffer on the stack. If the log message is longer than 5808ebcc71fd53ce7cf46aff607df2d4bff793837176Vasu Nori** a few hundred characters, it will be truncated to the length of the 5809ebcc71fd53ce7cf46aff607df2d4bff793837176Vasu Nori** buffer. 5810aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori*/ 5811aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu NoriSQLITE_API void sqlite3_log(int iErrCode, const char *zFormat, ...); 5812ebcc71fd53ce7cf46aff607df2d4bff793837176Vasu Nori 58137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 581471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** CAPI3REF: Write-Ahead Log Commit Hook 581571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 581671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The [sqlite3_wal_hook()] function is used to register a callback that 581771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** will be invoked each time a database connection commits data to a 581871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [write-ahead log] (i.e. whenever a transaction is committed in 581971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [journal_mode | journal_mode=WAL mode]). 582071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 582171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The callback is invoked by SQLite after the commit has taken place and 582271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** the associated write-lock on the database released, so the implementation 582371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** may read, write or [checkpoint] the database as required. 582471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 582571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The first parameter passed to the callback function when it is invoked 582671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** is a copy of the third parameter passed to sqlite3_wal_hook() when 582771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** registering the callback. ^The second is a copy of the database handle. 582871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The third parameter is the name of the database that was written to - 582971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** either "main" or the name of an [ATTACH]-ed database. ^The fourth parameter 583071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** is the number of pages currently in the write-ahead log file, 583171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** including those that were just committed. 583271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 583371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** The callback function should normally return [SQLITE_OK]. ^If an error 583471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** code is returned, that error will propagate back up through the 583571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** SQLite code base to cause the statement that provoked the callback 583671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** to report an error, though the commit will have still occurred. If the 583771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value 583871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** that does not correspond to any valid SQLite error code, the results 583971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** are undefined. 584071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 584171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** A single database handle may have at most a single write-ahead log callback 584271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any 584371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** previously registered write-ahead log callback. ^Note that the 584471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [sqlite3_wal_autocheckpoint()] interface and the 584571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will 584671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** those overwrite any prior [sqlite3_wal_hook()] settings. 584771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori*/ 584871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API void *sqlite3_wal_hook( 584971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori sqlite3*, 585071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori int(*)(void *,sqlite3*,const char*,int), 585171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori void* 585271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori); 585371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 585471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori/* 585571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** CAPI3REF: Configure an auto-checkpoint 585671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 585771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around 585871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [sqlite3_wal_hook()] that causes any database on [database connection] D 585971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** to automatically [checkpoint] 586071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** after committing a transaction if there are N or 586171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** more frames in the [write-ahead log] file. ^Passing zero or 586271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** a negative value as the nFrame parameter disables automatic 586371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** checkpoints entirely. 586471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 586571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The callback registered by this function replaces any existing callback 586671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** registered using [sqlite3_wal_hook()]. ^Likewise, registering a callback 586771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism 586871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** configured by this function. 58697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 587071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The [wal_autocheckpoint pragma] can be used to invoke this interface 587171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** from SQL. 587271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 587371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^Every new [database connection] defaults to having the auto-checkpoint 587471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** enabled with a threshold of 1000 pages. The use of this interface 587571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** is only necessary if the default setting is found to be suboptimal 587671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** for a particular application. 58777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 587871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db, int N); 587971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 588071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori/* 588171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** CAPI3REF: Checkpoint a database 588271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 588371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The [sqlite3_wal_checkpoint(D,X)] interface causes database named X 588471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** on [database connection] D to be [checkpointed]. ^If X is NULL or an 588571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** empty string, then a checkpoint is run on all databases of 588671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** connection D. ^If the database connection D is not in 588771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [WAL | write-ahead log mode] then this interface is a harmless no-op. 588871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 588971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The [wal_checkpoint pragma] can be used to invoke this interface 589071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** from SQL. ^The [sqlite3_wal_autocheckpoint()] interface and the 589171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [wal_autocheckpoint pragma] can be used to cause this interface to be 589271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** run whenever the WAL reaches a certain size threshold. 589371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori*/ 589471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb); 589571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 58967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 58977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Undo the hack that converts floating point types to integer for 58987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** builds on processors without floating point support. 58997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 59007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#ifdef SQLITE_OMIT_FLOATING_POINT 59017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project# undef double 59027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#endif 59037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 59047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#ifdef __cplusplus 59057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project} /* End of the 'extern "C"' block */ 59067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#endif 59077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#endif 5908a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5909