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 100de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** system</a>. ^The SQLITE_SOURCE_ID macro evaluates 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*/ 110c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown#define SQLITE_VERSION "3.7.11" 111c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown#define SQLITE_VERSION_NUMBER 3007011 112c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown#define SQLITE_SOURCE_ID "2012-03-20 11:35:50 00bb9c9ce4f465e6ac321ced2a9d0062dc364669" 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** 157de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The sqlite3_compileoption_get() function allows iterating 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() 165de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** and sqlite3_compileoption_get() may be omitted by specifying 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 18090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** SQLite was compiled with 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 271de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** successfully 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 31390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 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 37490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** here in order to indicate success or failure. 3757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 376a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** New error codes may be added in future versions of SQLite. 377a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 37890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** See also: [SQLITE_IOERR_READ | extended result codes], 37990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_vtab_on_conflict()] [SQLITE_ROLLBACK | result codes]. 3807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_OK 0 /* Successful result */ 3827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* beginning-of-error-codes */ 3837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ERROR 1 /* SQL error or missing database */ 3847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */ 3857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_PERM 3 /* Access permission denied */ 3867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ABORT 4 /* Callback routine requested an abort */ 3877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_BUSY 5 /* The database file is locked */ 3887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LOCKED 6 /* A table in the database is locked */ 3897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_NOMEM 7 /* A malloc() failed */ 3907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_READONLY 8 /* Attempt to write a readonly database */ 3917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/ 3927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */ 3937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CORRUPT 11 /* The database disk image is malformed */ 39490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_NOTFOUND 12 /* Unknown opcode in sqlite3_file_control() */ 3957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_FULL 13 /* Insertion failed because database is full */ 3967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CANTOPEN 14 /* Unable to open the database file */ 39771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_PROTOCOL 15 /* Database lock protocol error */ 3987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_EMPTY 16 /* Database is empty */ 3997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_SCHEMA 17 /* The database schema changed */ 4007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */ 4017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */ 4027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MISMATCH 20 /* Data type mismatch */ 4037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MISUSE 21 /* Library used incorrectly */ 4047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */ 4057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_AUTH 23 /* Authorization denied */ 4067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_FORMAT 24 /* Auxiliary database format error */ 4077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */ 4087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_NOTADB 26 /* File opened that is not a database file */ 4097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */ 4107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */ 4117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* end-of-error-codes */ 4127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 4137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 414a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Extended Result Codes 4157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** KEYWORDS: {extended error code} {extended error codes} 416a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {extended result code} {extended result codes} 4177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** In its default configuration, SQLite API routines return one of 26 integer 419a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_OK | result codes]. However, experience has shown that many of 420a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** these result codes are too coarse-grained. They do not provide as 4217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** much information about problems as programmers might like. In an effort to 4227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** address this, newer versions of SQLite (version 3.3.8 and later) include 4237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** support for additional result codes that provide more detailed information 4247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** about errors. The extended result codes are enabled or disabled 425a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on a per database connection basis using the 426a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_extended_result_codes()] API. 427a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Some of the available extended result codes are listed here. 4297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** One may expect the number of extended result codes will be expand 4307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** over time. Software that uses extended result codes should expect 4317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to see new result codes in future releases of SQLite. 4327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The SQLITE_OK result code will never be extended. It will always 4347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** be exactly zero. 4357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 436a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8)) 437a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8)) 438a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8)) 439a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8)) 440a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8)) 441a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8)) 442a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8)) 443a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8)) 444a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8)) 445a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8)) 446a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8)) 447a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8)) 448a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8)) 449a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8)) 450a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8)) 451a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8)) 452a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8)) 45371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_IOERR_SHMOPEN (SQLITE_IOERR | (18<<8)) 45471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_IOERR_SHMSIZE (SQLITE_IOERR | (19<<8)) 45571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR | (20<<8)) 45690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_IOERR_SHMMAP (SQLITE_IOERR | (21<<8)) 45790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_IOERR_SEEK (SQLITE_IOERR | (22<<8)) 45871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8)) 45971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_BUSY_RECOVERY (SQLITE_BUSY | (1<<8)) 46071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN | (1<<8)) 46190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_CORRUPT_VTAB (SQLITE_CORRUPT | (1<<8)) 46290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_READONLY_RECOVERY (SQLITE_READONLY | (1<<8)) 46390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_READONLY_CANTLOCK (SQLITE_READONLY | (2<<8)) 464c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown#define SQLITE_ABORT_ROLLBACK (SQLITE_ABORT | (2<<8)) 4657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 4667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 467a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Flags For File Open Operations 4687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These bit values are intended for use in the 4707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3rd parameter to the [sqlite3_open_v2()] interface and 47190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** in the 4th parameter to the [sqlite3_vfs.xOpen] method. 4727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 473a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */ 474a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */ 475a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */ 476a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */ 477a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */ 47871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */ 47990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_OPEN_URI 0x00000040 /* Ok for sqlite3_open_v2() */ 480a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */ 481a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */ 482a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */ 483a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */ 484a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */ 485a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */ 486a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */ 487a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */ 488a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */ 489a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */ 490a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */ 491de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori#define SQLITE_OPEN_WAL 0x00080000 /* VFS only */ 4927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 49390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* Reserved: 0x00F00000 */ 49490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 4957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 496a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Device Characteristics 4977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 498de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The xDeviceCharacteristics method of the [sqlite3_io_methods] 4997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** object returns an integer which is a vector of the these 5007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** bit values expressing I/O characteristics of the mass storage 5017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** device that holds the file that the [sqlite3_io_methods] 5027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** refers to. 5037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The SQLITE_IOCAP_ATOMIC property means that all writes of 5057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values 5067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** mean that writes of blocks that are nnn bytes in size and 5077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** are aligned to an address which is an integer multiple of 5087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means 5097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** that when data is appended to a file, the data is appended 5107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** first then the size of the file is extended, never the other 5117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** way around. The SQLITE_IOCAP_SEQUENTIAL property means that 5127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** information is written to disk in the same order as calls 51390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** to xWrite(). The SQLITE_IOCAP_POWERSAFE_OVERWRITE property means that 51490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** after reboot following a crash or power loss, the only bytes in a 51590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** file that were written at the application level might have changed 51690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** and that adjacent bytes, even bytes within the same sector are 51790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** guaranteed to be unchanged. 5187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 519176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC 0x00000001 520176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC512 0x00000002 521176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC1K 0x00000004 522176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC2K 0x00000008 523176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC4K 0x00000010 524176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC8K 0x00000020 525176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC16K 0x00000040 526176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC32K 0x00000080 527176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_ATOMIC64K 0x00000100 528176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_SAFE_APPEND 0x00000200 529176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_SEQUENTIAL 0x00000400 530176bf03af2edfb2a45b66dcb5daf822cc50c499eVasu Nori#define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800 53190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_IOCAP_POWERSAFE_OVERWRITE 0x00001000 5327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 5337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 534a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: File Locking Levels 5357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLite uses one of these integer values as the second 5377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** argument to calls it makes to the xLock() and xUnlock() methods 5387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of an [sqlite3_io_methods] object. 5397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 5407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LOCK_NONE 0 5417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LOCK_SHARED 1 5427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LOCK_RESERVED 2 5437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LOCK_PENDING 3 5447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LOCK_EXCLUSIVE 4 5457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 5467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 547a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Synchronization Type Flags 5487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** When SQLite invokes the xSync() method of an 5507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_io_methods] object it uses a combination of 5517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** these integer values as the second argument. 5527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** When the SQLITE_SYNC_DATAONLY flag is used, it means that the 5547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sync operation only needs to flush data to mass storage. Inode 555a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** information need not be flushed. If the lower four bits of the flag 556a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics. 557a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If the lower four bits equal SQLITE_SYNC_FULL, that means 558a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to use Mac OS X style fullsync instead of fsync(). 55995c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** 56095c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags 56195c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL 56295c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** settings. The [synchronous pragma] determines when calls to the 56395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** xSync VFS method occur and applies uniformly across all platforms. 56495c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how 56595c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** energetic or rigorous or forceful the sync operations are and 56695c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** only make a difference on Mac OSX for the default SQLite code. 56795c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** (Third-party VFS implementations might also make the distinction 56895c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the 56995c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** operating systems natively supported by SQLite, only Mac OSX 57095c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** cares about the difference.) 5717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 5727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_SYNC_NORMAL 0x00002 5737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_SYNC_FULL 0x00003 5747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_SYNC_DATAONLY 0x00010 5757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 5767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 577a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: OS Interface Open File Handle 5787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 579a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** An [sqlite3_file] object represents an open file in the 580a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_vfs | OS interface layer]. Individual OS interface 581a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementations will 5827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** want to subclass this object by appending additional fields 5837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for their own use. The pMethods entry is a pointer to an 5847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_io_methods] object that defines methods for performing 5857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** I/O operations on the open file. 5867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 5877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_file sqlite3_file; 5887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projectstruct sqlite3_file { 5897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const struct sqlite3_io_methods *pMethods; /* Methods for an open file */ 5907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project}; 5917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 5927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 593a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: OS Interface File Virtual Methods Object 594a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 59590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Every file opened by the [sqlite3_vfs.xOpen] method populates an 596a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_file] object (or, more commonly, a subclass of the 597a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_file] object) with a pointer to an instance of this object. 598a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This object defines the methods used to perform various operations 599a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** against the open file represented by the [sqlite3_file] object. 6007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 60190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element 602a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to a non-NULL pointer, then the sqlite3_io_methods.xClose method 60390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed. The 60490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen] 60590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is for the [sqlite3_vfs.xOpen] to set the sqlite3_file.pMethods element 60690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** to NULL. 6077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or 6097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_SYNC_FULL]. The first choice is the normal fsync(). 610a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY] 611a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** flag may be ORed in to indicate that only the data of the file 612a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and not its inode needs to be synced. 613a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The integer values to xLock() and xUnlock() are one of 6157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 6167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_LOCK_NONE], 6177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_LOCK_SHARED], 6187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_LOCK_RESERVED], 6197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_LOCK_PENDING], or 6207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_LOCK_EXCLUSIVE]. 6217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </ul> 622a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xLock() increases the lock. xUnlock() decreases the lock. 623a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The xCheckReservedLock() method checks whether any database connection, 624a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** either in this process or in some other process, is holding a RESERVED, 6257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** PENDING, or EXCLUSIVE lock on the file. It returns true 626a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** if such a lock exists and false otherwise. 627a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The xFileControl() method is a generic interface that allows custom 6297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** VFS implementations to directly control an open file using the 630a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_file_control()] interface. The second "op" argument is an 631a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** integer opcode. The third argument is a generic pointer intended to 632a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** point to a structure that may contain arguments or space in which to 6337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** write return values. Potential uses for xFileControl() might be 6347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** functions to enable blocking locks with timeouts, to change the 6357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** locking strategy (for example to use dot-file locks), to inquire 6367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** about the status of a lock, or to break stale locks. The SQLite 637a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** core reserves all opcodes less than 100 for its own use. 6387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** A [SQLITE_FCNTL_LOCKSTATE | list of opcodes] less than 100 is available. 639a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Applications that define a custom xFileControl method should use opcodes 64090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** greater than 100 to avoid conflicts. VFS implementations should 64190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** return [SQLITE_NOTFOUND] for file control opcodes that they do not 64290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** recognize. 6437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The xSectorSize() method returns the sector size of the 6457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** device that underlies the file. The sector size is the 6467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** minimum write that can be performed without disturbing 6477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** other bytes in the file. The xDeviceCharacteristics() 6487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** method returns a bit vector describing behaviors of the 6497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** underlying device: 6507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 6527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC] 6537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC512] 6547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC1K] 6557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC2K] 6567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC4K] 6577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC8K] 6587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC16K] 6597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC32K] 6607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_ATOMIC64K] 6617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_SAFE_APPEND] 6627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_IOCAP_SEQUENTIAL] 6637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </ul> 6647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 6657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The SQLITE_IOCAP_ATOMIC property means that all writes of 6667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values 6677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** mean that writes of blocks that are nnn bytes in size and 6687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** are aligned to an address which is an integer multiple of 6697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means 6707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** that when data is appended to a file, the data is appended 6717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** first then the size of the file is extended, never the other 6727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** way around. The SQLITE_IOCAP_SEQUENTIAL property means that 6737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** information is written to disk in the same order as calls 6747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to xWrite(). 675a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 676a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill 677a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in the unread portions of the buffer with zeros. A VFS that 678a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** fails to zero-fill short reads might seem to work. However, 679a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** failure to zero-fill short reads will eventually lead to 680a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database corruption. 6817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 6827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_io_methods sqlite3_io_methods; 6837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projectstruct sqlite3_io_methods { 6847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int iVersion; 6857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xClose)(sqlite3_file*); 6867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst); 6877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst); 6887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xTruncate)(sqlite3_file*, sqlite3_int64 size); 6897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xSync)(sqlite3_file*, int flags); 6907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize); 6917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xLock)(sqlite3_file*, int); 6927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xUnlock)(sqlite3_file*, int); 693a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xCheckReservedLock)(sqlite3_file*, int *pResOut); 6947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xFileControl)(sqlite3_file*, int op, void *pArg); 6957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xSectorSize)(sqlite3_file*); 6967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xDeviceCharacteristics)(sqlite3_file*); 69771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori /* Methods above are valid for version 1 */ 698de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, void volatile**); 69971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori int (*xShmLock)(sqlite3_file*, int offset, int n, int flags); 70071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori void (*xShmBarrier)(sqlite3_file*); 701de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori int (*xShmUnmap)(sqlite3_file*, int deleteFlag); 70271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori /* Methods above are valid for version 2 */ 7037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project /* Additional methods may be added in future releases */ 7047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project}; 7057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 7067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 707a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Standard File Control Opcodes 7087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 7097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These integer constants are opcodes for the xFileControl method 710a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()] 7117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface. 7127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 7137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This 7147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** opcode causes the xFileControl method to write the current state of 7157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED], 7167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE]) 7177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** into an integer that the pArg argument points to. This capability 7187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is used during testing and only needs to be supported when SQLITE_TEST 7197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is defined. 720c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** <ul> 721c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** <li>[[SQLITE_FCNTL_SIZE_HINT]] 72271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS 72371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** layer a hint of how large the database file will grow to be during the 72471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** current transaction. This hint is not guaranteed to be accurate but it 72571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** is often close. The underlying VFS might choose to preallocate database 72671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** file space based on this hint in order to help writes to the database 72771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** file run faster. 728de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 729c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** <li>[[SQLITE_FCNTL_CHUNK_SIZE]] 730de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS 731de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** extends and truncates the database file in chunks of a size specified 732de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** by the user. The fourth argument to [sqlite3_file_control()] should 733de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** point to an integer (type int) containing the new chunk-size to use 734de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** for the nominated database. Allocating database file space in large 735de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** chunks (say 1MB at a time), may reduce file-system fragmentation and 736de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** improve performance on some systems. 73790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 738c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** <li>[[SQLITE_FCNTL_FILE_POINTER]] 73990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer 74090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** to the [sqlite3_file] object associated with a particular database 74190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** connection. See the [sqlite3_file_control()] documentation for 74290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** additional information. 74390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 744c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** <li>[[SQLITE_FCNTL_SYNC_OMITTED]] 74590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^(The [SQLITE_FCNTL_SYNC_OMITTED] opcode is generated internally by 74690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** SQLite and sent to all VFSes in place of a call to the xSync method 74790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** when the database connection has [PRAGMA synchronous] set to OFF.)^ 74890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Some specialized VFSes need this signal in order to operate correctly 74990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** when [PRAGMA synchronous | PRAGMA synchronous=OFF] is set, but most 75090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** VFSes do not need this signal and should silently ignore this opcode. 75190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Applications should not call [sqlite3_file_control()] with this 75290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** opcode as doing so may disrupt the operation of the specialized VFSes 75390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** that do require it. 75490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 755c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** <li>[[SQLITE_FCNTL_WIN32_AV_RETRY]] 75690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The [SQLITE_FCNTL_WIN32_AV_RETRY] opcode is used to configure automatic 75790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** retry counts and intervals for certain disk I/O operations for the 75890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** windows [VFS] in order to provide robustness in the presence of 75990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** anti-virus programs. By default, the windows VFS will retry file read, 76090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** file write, and file delete operations up to 10 times, with a delay 76190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** of 25 milliseconds before the first retry and with the delay increasing 76290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** by an additional 25 milliseconds with each subsequent retry. This 76390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** opcode allows these two values (10 retries and 25 milliseconds of delay) 76490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** to be adjusted. The values are changed for all database connections 76590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** within the same process. The argument is a pointer to an array of two 76690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** integers where the first integer i the new retry count and the second 76790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** integer is the delay. If either integer is negative, then the setting 76890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is not changed but instead the prior value of that setting is written 76990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** into the array entry, allowing the current retry settings to be 77090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** interrogated. The zDbName parameter is ignored. 77190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 772c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** <li>[[SQLITE_FCNTL_PERSIST_WAL]] 77390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The [SQLITE_FCNTL_PERSIST_WAL] opcode is used to set or query the 77490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** persistent [WAL | Write AHead Log] setting. By default, the auxiliary 77590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** write ahead log and shared memory files used for transaction control 77690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** are automatically deleted when the latest connection to the database 77790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** closes. Setting persistent WAL mode causes those files to persist after 77890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** close. Persisting the files is useful when other processes that do not 77990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** have write permission on the directory containing the database file want 78090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** to read the database file, as the WAL and shared memory files must exist 78190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** in order for the database to be readable. The fourth parameter to 78290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_file_control()] for this opcode should be a pointer to an integer. 78390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** That integer is 0 to disable persistent WAL mode or 1 to enable persistent 78490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** WAL mode. If the integer is -1, then it is overwritten with the current 78590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** WAL persistence setting. 78690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 787c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** <li>[[SQLITE_FCNTL_POWERSAFE_OVERWRITE]] 78890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The [SQLITE_FCNTL_POWERSAFE_OVERWRITE] opcode is used to set or query the 78990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** persistent "powersafe-overwrite" or "PSOW" setting. The PSOW setting 79090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** determines the [SQLITE_IOCAP_POWERSAFE_OVERWRITE] bit of the 79190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** xDeviceCharacteristics methods. The fourth parameter to 79290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_file_control()] for this opcode should be a pointer to an integer. 79390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** That integer is 0 to disable zero-damage mode or 1 to enable zero-damage 79490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** mode. If the integer is -1, then it is overwritten with the current 79590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** zero-damage mode setting. 79690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 797c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** <li>[[SQLITE_FCNTL_OVERWRITE]] 79890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The [SQLITE_FCNTL_OVERWRITE] opcode is invoked by SQLite after opening 79990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** a write transaction to indicate that, unless it is rolled back for some 80090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** reason, the entire database file will be overwritten by the current 80190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** transaction. This is used by VACUUM operations. 80290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 803c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** <li>[[SQLITE_FCNTL_VFSNAME]] 80490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of 80590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** all [VFSes] in the VFS stack. The names are of all VFS shims and the 80690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** final bottom-level VFS are written into memory obtained from 80790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_malloc()] and the result is stored in the char* variable 80890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** that the fourth parameter of [sqlite3_file_control()] points to. 80990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The caller is responsible for freeing the memory when done. As with 81090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** all file-control actions, there is no guarantee that this will actually 81190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** do anything. Callers should initialize the char* variable to a NULL 81290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** pointer in case this file-control is not implemented. This file-control 81390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is intended for diagnostic use only. 814c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** 815c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** <li>[[SQLITE_FCNTL_PRAGMA]] 816c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA] 817c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** file control is sent to the open [sqlite3_file] object corresponding 818c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** to the database file to which the pragma statement refers. ^The argument 819c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** to the [SQLITE_FCNTL_PRAGMA] file control is an array of 820c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** pointers to strings (char**) in which the second element of the array 821c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** is the name of the pragma and the third element is the argument to the 822c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** pragma or NULL if the pragma has no argument. ^The handler for an 823c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** [SQLITE_FCNTL_PRAGMA] file control can optionally make the first element 824c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** of the char** argument point to a string obtained from [sqlite3_mprintf()] 825c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** or the equivalent and that string will become the result of the pragma or 826c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** the error message if the pragma fails. ^If the 827c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal 828c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** [PRAGMA] processing continues. ^If the [SQLITE_FCNTL_PRAGMA] 829c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** file control returns [SQLITE_OK], then the parser assumes that the 830c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** VFS has handled the PRAGMA itself and the parser generates a no-op 831c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** prepared statement. ^If the [SQLITE_FCNTL_PRAGMA] file control returns 832c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** any result code other than [SQLITE_OK] or [SQLITE_NOTFOUND], that means 833c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** that the VFS encountered an error while handling the [PRAGMA] and the 834c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** compilation of the PRAGMA fails with an error. ^The [SQLITE_FCNTL_PRAGMA] 835c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** file control occurs at the beginning of pragma statement analysis and so 836c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** it is able to override built-in [PRAGMA] statements. 837c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** </ul> 83890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 83990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_FCNTL_LOCKSTATE 1 84090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_GET_LOCKPROXYFILE 2 84190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_SET_LOCKPROXYFILE 3 84290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_LAST_ERRNO 4 84390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_FCNTL_SIZE_HINT 5 84490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_FCNTL_CHUNK_SIZE 6 84590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_FCNTL_FILE_POINTER 7 84690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_FCNTL_SYNC_OMITTED 8 84790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_FCNTL_WIN32_AV_RETRY 9 84890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_FCNTL_PERSIST_WAL 10 84990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_FCNTL_OVERWRITE 11 85090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_FCNTL_VFSNAME 12 85190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_FCNTL_POWERSAFE_OVERWRITE 13 852c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown#define SQLITE_FCNTL_PRAGMA 14 8537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 8547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 855a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Mutex Handle 8567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 8577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The mutex module within SQLite defines [sqlite3_mutex] to be an 8587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** abstract type for a mutex object. The SQLite core never looks 8597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** at the internal representation of an [sqlite3_mutex]. It only 8607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** deals with pointers to the [sqlite3_mutex] object. 8617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 8627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Mutexes are created using [sqlite3_mutex_alloc()]. 8637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 8647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_mutex sqlite3_mutex; 8657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 8667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 867a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: OS Interface Object 8687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 869a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** An instance of the sqlite3_vfs object defines the interface between 870a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the SQLite core and the underlying operating system. The "vfs" 87190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** in the name of the object stands for "virtual file system". See 87290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the [VFS | VFS documentation] for further information. 8737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 874a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The value of the iVersion field is initially 1 but may be larger in 875a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** future versions of SQLite. Additional fields may be appended to this 876a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** object when the iVersion value is increased. Note that the structure 877a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the sqlite3_vfs object changes in the transaction between 878a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not 879a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** modified. 8807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 8817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The szOsFile field is the size of the subclassed [sqlite3_file] 8827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** structure used by this VFS. mxPathname is the maximum length of 8837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a pathname in this VFS. 8847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 8857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Registered sqlite3_vfs objects are kept on a linked list formed by 8867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the pNext pointer. The [sqlite3_vfs_register()] 8877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and [sqlite3_vfs_unregister()] interfaces manage this list 8887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** in a thread-safe way. The [sqlite3_vfs_find()] interface 889a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** searches the list. Neither the application code nor the VFS 890a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation should use the pNext pointer. 8917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 892a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The pNext field is the only field in the sqlite3_vfs 8937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** structure that SQLite will ever modify. SQLite will only access 8947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or modify this field while holding a particular static mutex. 8957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The application should never modify anything within the sqlite3_vfs 8967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** object once the object has been registered. 8977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 8987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The zName field holds the name of the VFS module. The name must 8997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** be unique across all VFS modules. 9007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 90190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[sqlite3_vfs.xOpen]] 902de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^SQLite guarantees that the zFilename parameter to xOpen 903a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is either a NULL pointer or string obtained 904de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** from xFullPathname() with an optional suffix added. 905de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^If a suffix is added to the zFilename parameter, it will 906de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** consist of a single "-" character followed by no more than 90790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 11 alphanumeric and/or "-" characters. 908de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^SQLite further guarantees that 909a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the string will be valid and unchanged until xClose() is 910a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** called. Because of the previous sentence, 911a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [sqlite3_file] can safely store a pointer to the 9127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** filename if it needs to remember the filename for some reason. 913de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** If the zFilename parameter to xOpen is a NULL pointer then xOpen 914de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** must invent its own temporary name for the file. ^Whenever the 915a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xFilename parameter is NULL it will also be the case that the 916a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE]. 9177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 918a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The flags argument to xOpen() includes all bits set in 9197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()] 9207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or [sqlite3_open16()] is used, then flags includes at least 921a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. 9227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If xOpen() opens a file read-only then it sets *pOutFlags to 923a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set. 924a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 925de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^(SQLite will also add one of the following flags to the xOpen() 9267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** call, depending on the object being opened: 927a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 9287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 9297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_MAIN_DB] 9307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_MAIN_JOURNAL] 9317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_TEMP_DB] 9327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_TEMP_JOURNAL] 9337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_TRANSIENT_DB] 9347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_SUBJOURNAL] 9357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_MASTER_JOURNAL] 936de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> [SQLITE_OPEN_WAL] 937de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** </ul>)^ 9387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 9397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The file I/O implementation can use the object type flags to 940a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** change the way it deals with files. For example, an application 9417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** that does not care about crash recovery or rollback might make 9427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the open of a journal file a no-op. Writes to this journal would 943a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** also be no-ops, and any attempt to read the journal would return 944a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_IOERR. Or the implementation might recognize that a database 945a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** file will be doing page-aligned sector reads and writes in a random 9467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** order and set up its I/O subsystem accordingly. 947a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 948a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite might also add one of the following flags to the xOpen method: 949a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 9507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 9517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_DELETEONCLOSE] 9527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> [SQLITE_OPEN_EXCLUSIVE] 9537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </ul> 954a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 955a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be 956de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** deleted when it is closed. ^The [SQLITE_OPEN_DELETEONCLOSE] 957de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** will be set for TEMP databases and their journals, transient 958de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** databases, and subjournals. 959a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 960de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction 961a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with the [SQLITE_OPEN_CREATE] flag, which are both directly 962a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** analogous to the O_EXCL and O_CREAT flags of the POSIX open() 963a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the 964a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_OPEN_CREATE, is used to indicate that file should always 965a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** be created, and that it is an error if it already exists. 966a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** It is <i>not</i> used to indicate the file should be opened 967a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for exclusive access. 968a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 969de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^At least szOsFile bytes of memory are allocated by SQLite 970a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to hold the [sqlite3_file] structure passed as the third 971a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** argument to xOpen. The xOpen method does not have to 972a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocate the structure; it should just fill it in. Note that 973a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the xOpen method must set the sqlite3_file.pMethods to either 974a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a valid [sqlite3_io_methods] object or to NULL. xOpen must do 975a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** this even if the open fails. SQLite expects that the sqlite3_file.pMethods 976a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** element will be valid after xOpen returns regardless of the success 977a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or failure of the xOpen call. 978a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 97990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[sqlite3_vfs.xAccess]] 980de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS] 981a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to 982a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** test whether a file is readable and writable, or [SQLITE_ACCESS_READ] 983a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to test whether a file is at least readable. The file can be a 9847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** directory. 985a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 986de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^SQLite will always allocate at least mxPathname+1 bytes for the 987a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** output buffer xFullPathname. The exact size of the output buffer 988a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is also passed as a parameter to both methods. If the output buffer 989a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is 990a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** handled as a fatal error by SQLite, vfs implementations should endeavor 991a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to prevent this by setting mxPathname to a sufficiently large value. 992a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 993ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64() 994ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** interfaces are not strictly a part of the filesystem, but they are 9957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** included in the VFS structure for completeness. 9967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The xRandomness() function attempts to return nBytes bytes 9977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of good-quality randomness into zOut. The return value is 998a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the actual number of bytes of randomness obtained. 999a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The xSleep() method causes the calling thread to sleep for at 1000de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** least the number of microseconds given. ^The xCurrentTime() 1001ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** method returns a Julian Day Number for the current date and time as 1002ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** a floating point value. 1003de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The xCurrentTimeInt64() method returns, as an integer, the Julian 100490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Day Number multiplied by 86400000 (the number of milliseconds in 1005ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** a 24-hour day). 1006ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** ^SQLite will use the xCurrentTimeInt64() method to get the current 1007ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** date and time if that method is available (if iVersion is 2 or 1008ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** greater and the function pointer is not NULL) and will fall back 1009ebc6b24ff37b903195b37f143a5791c9f02be8dfVasu Nori** to xCurrentTime() if xCurrentTimeInt64() is unavailable. 101090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 101190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces 101290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** are not used by the SQLite core. These optional interfaces are provided 101390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** by some VFSes to facilitate testing of the VFS code. By overriding 101490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** system calls with functions under its control, a test program can 101590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** simulate faults and error conditions that would otherwise be difficult 101690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** or impossible to induce. The set of system calls that can be overridden 101790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** varies from one VFS to another, and from one version of the same VFS to the 101890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** next. Applications that use these interfaces must be prepared for any 101990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** or all of these interfaces to be NULL or for their behavior to change 102090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** from one release to the next. Applications must not attempt to access 102190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** any of these methods if the iVersion of the VFS is less than 3. 10227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 10237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_vfs sqlite3_vfs; 102490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Browntypedef void (*sqlite3_syscall_ptr)(void); 10257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projectstruct sqlite3_vfs { 102690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown int iVersion; /* Structure version number (currently 3) */ 10277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int szOsFile; /* Size of subclassed sqlite3_file */ 10287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int mxPathname; /* Maximum file pathname length */ 10297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_vfs *pNext; /* Next registered VFS */ 10307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zName; /* Name of this virtual file system */ 10317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void *pAppData; /* Pointer to application-specific data */ 10327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*, 10337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int flags, int *pOutFlags); 10347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir); 1035a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut); 10367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut); 10377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename); 10387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg); 1039a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void); 10407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xDlClose)(sqlite3_vfs*, void*); 10417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut); 10427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xSleep)(sqlite3_vfs*, int microseconds); 10437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xCurrentTime)(sqlite3_vfs*, double*); 1044a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xGetLastError)(sqlite3_vfs*, int, char *); 104571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori /* 104671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori ** The methods above are in version 1 of the sqlite_vfs object 104771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori ** definition. Those that follow are added in version 2 or later 104871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori */ 104971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori int (*xCurrentTimeInt64)(sqlite3_vfs*, sqlite3_int64*); 105071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori /* 105171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori ** The methods above are in versions 1 and 2 of the sqlite_vfs object. 105290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown ** Those below are for version 3 and greater. 105390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown */ 105490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown int (*xSetSystemCall)(sqlite3_vfs*, const char *zName, sqlite3_syscall_ptr); 105590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown sqlite3_syscall_ptr (*xGetSystemCall)(sqlite3_vfs*, const char *zName); 105690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown const char *(*xNextSystemCall)(sqlite3_vfs*, const char *zName); 105790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown /* 105890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown ** The methods above are in versions 1 through 3 of the sqlite_vfs object. 105971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori ** New fields may be appended in figure versions. The iVersion 106071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori ** value will increment whenever this happens. 106171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori */ 10627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project}; 10637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 10647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1065a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Flags for the xAccess VFS method 1066a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1067a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These integer constants can be used as the third parameter to 1068a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the xAccess method of an [sqlite3_vfs] object. They determine 1069a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** what kind of permissions the xAccess method is looking for. 1070a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** With SQLITE_ACCESS_EXISTS, the xAccess method 1071a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** simply checks whether the file exists. 1072a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** With SQLITE_ACCESS_READWRITE, the xAccess method 1073de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** checks whether the named directory is both readable and writable 1074de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** (in other words, if files can be added, removed, and renamed within 1075de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the directory). 1076de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The SQLITE_ACCESS_READWRITE constant is currently used only by the 1077de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [temp_store_directory pragma], though this could change in a future 1078de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** release of SQLite. 1079a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** With SQLITE_ACCESS_READ, the xAccess method 1080de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** checks whether the file is readable. The SQLITE_ACCESS_READ constant is 1081de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** currently unused, though it might be used in a future release of 1082de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** SQLite. 10837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 10847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ACCESS_EXISTS 0 1085de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori#define SQLITE_ACCESS_READWRITE 1 /* Used by PRAGMA temp_store_directory */ 1086de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori#define SQLITE_ACCESS_READ 2 /* Unused */ 10877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 10887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 108971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** CAPI3REF: Flags for the xShmLock VFS method 109071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 109171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** These integer constants define the various locking operations 109271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** allowed by the xShmLock method of [sqlite3_io_methods]. The 109371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** following are the only legal combinations of flags to the 109471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** xShmLock method: 109571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 109671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <ul> 109771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <li> SQLITE_SHM_LOCK | SQLITE_SHM_SHARED 109871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <li> SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE 109971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED 110071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE 110171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** </ul> 110271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 110371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as 110471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** was given no the corresponding lock. 110571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 110671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** The xShmLock method can transition between unlocked and SHARED or 110771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** between unlocked and EXCLUSIVE. It cannot transition between SHARED 110871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** and EXCLUSIVE. 110971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori*/ 111071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_SHM_UNLOCK 1 111171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_SHM_LOCK 2 111271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_SHM_SHARED 4 111371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_SHM_EXCLUSIVE 8 111471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 111571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori/* 111671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** CAPI3REF: Maximum xShmLock index 111771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 111871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** The xShmLock method on [sqlite3_io_methods] may use values 111971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** between 0 and this upper bound as its "offset" argument. 112071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** The SQLite core will never attempt to acquire or release a 112171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** lock outside of this range 112271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori*/ 112371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_SHM_NLOCK 8 112471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 112571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 112671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori/* 1127a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Initialize The SQLite Library 1128a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1129a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_initialize() routine initializes the 1130a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite library. ^The sqlite3_shutdown() routine 1131a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** deallocates any resources that were allocated by sqlite3_initialize(). 1132a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These routines are designed to aid in process initialization and 1133a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** shutdown on embedded systems. Workstation applications using 1134a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite normally do not need to invoke either of these routines. 1135a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1136a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A call to sqlite3_initialize() is an "effective" call if it is 1137a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the first time sqlite3_initialize() is invoked during the lifetime of 1138a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the process, or if it is the first time sqlite3_initialize() is invoked 1139a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** following a call to sqlite3_shutdown(). ^(Only an effective call 1140a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of sqlite3_initialize() does any initialization. All other calls 1141a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are harmless no-ops.)^ 1142a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1143a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A call to sqlite3_shutdown() is an "effective" call if it is the first 1144a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** call to sqlite3_shutdown() since the last sqlite3_initialize(). ^(Only 1145a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an effective call to sqlite3_shutdown() does any deinitialization. 1146a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^ 1147a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1148a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown() 1149a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not. The sqlite3_shutdown() interface must only be called from a 1150a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** single thread. All open [database connections] must be closed and all 1151a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** other SQLite resources must be deallocated prior to invoking 1152a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_shutdown(). 1153a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1154a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Among other things, ^sqlite3_initialize() will invoke 1155a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_os_init(). Similarly, ^sqlite3_shutdown() 1156a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will invoke sqlite3_os_end(). 1157a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1158a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success. 1159a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If for some reason, sqlite3_initialize() is unable to initialize 1160a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the library (perhaps it is unable to allocate a needed resource such 1161a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** as a mutex) it returns an [error code] other than [SQLITE_OK]. 1162a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1163a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_initialize() routine is called internally by many other 1164a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite interfaces so that an application usually does not need to 1165a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** invoke sqlite3_initialize() directly. For example, [sqlite3_open()] 1166a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** calls sqlite3_initialize() so the SQLite library will be automatically 1167a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** initialized when [sqlite3_open()] is called if it has not be initialized 1168a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT] 1169a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** compile-time option, then the automatic calls to sqlite3_initialize() 1170a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are omitted and the application must call sqlite3_initialize() directly 1171a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** prior to using any other SQLite interface. For maximum portability, 1172a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it is recommended that applications always invoke sqlite3_initialize() 1173a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** directly prior to using any other SQLite interface. Future releases 1174a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of SQLite may require this. In other words, the behavior exhibited 1175a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the 1176a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** default behavior in some future release of SQLite. 1177a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1178a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_os_init() routine does operating-system specific 1179a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** initialization of the SQLite library. The sqlite3_os_end() 1180a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routine undoes the effect of sqlite3_os_init(). Typical tasks 1181a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** performed by these routines include allocation or deallocation 1182a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of static resources, initialization of global variables, 1183a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** setting up a default [sqlite3_vfs] module, or setting up 1184a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a default configuration using [sqlite3_config()]. 1185a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1186a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The application should never invoke either sqlite3_os_init() 1187a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or sqlite3_os_end() directly. The application should only invoke 1188a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init() 1189a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interface is called automatically by sqlite3_initialize() and 1190a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate 1191a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementations for sqlite3_os_init() and sqlite3_os_end() 1192a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are built into SQLite when it is compiled for Unix, Windows, or OS/2. 1193a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When [custom builds | built for other platforms] 1194a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (using the [SQLITE_OS_OTHER=1] compile-time 1195a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** option) the application must supply a suitable implementation for 1196a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_os_init() and sqlite3_os_end(). An application-supplied 1197a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation of sqlite3_os_init() or sqlite3_os_end() 1198a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** must return [SQLITE_OK] on success and some other [error code] upon 1199a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** failure. 1200a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 1201a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_initialize(void); 1202a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_shutdown(void); 1203a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_os_init(void); 1204a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_os_end(void); 1205a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1206a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 1207a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Configuring The SQLite Library 1208a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1209a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_config() interface is used to make global configuration 1210a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** changes to SQLite in order to tune SQLite to the specific needs of 1211a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the application. The default configuration is recommended for most 1212a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** applications and so this routine is usually not necessary. It is 1213a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** provided to support rare applications with unusual needs. 1214a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1215a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_config() interface is not threadsafe. The application 1216a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** must insure that no other SQLite interfaces are invoked by other 1217a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** threads while sqlite3_config() is running. Furthermore, sqlite3_config() 1218a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** may only be invoked prior to library initialization using 1219a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()]. 1220a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_config() is called after [sqlite3_initialize()] and before 1221a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_shutdown()] then it will return SQLITE_MISUSE. 1222a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Note, however, that ^sqlite3_config() can be called as part of the 1223a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation of an application-defined [sqlite3_os_init()]. 1224a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1225a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The first argument to sqlite3_config() is an integer 122690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [configuration option] that determines 1227a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** what property of SQLite is to be configured. Subsequent arguments 122890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** vary depending on the [configuration option] 1229a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in the first argument. 1230a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1231a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK]. 1232a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the option is unknown or SQLite is unable to set the option 1233a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then this routine returns a non-zero [error code]. 1234a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 123571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_config(int, ...); 1236a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1237a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 1238a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Configure database connections 1239a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1240a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_db_config() interface is used to make configuration 1241a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** changes to a [database connection]. The interface is similar to 1242a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] except that the changes apply to a single 124390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [database connection] (specified in the first argument). 1244a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1245a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The second argument to sqlite3_db_config(D,V,...) is the 124690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code 124790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** that indicates what aspect of the [database connection] is being configured. 124890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Subsequent arguments vary depending on the configuration verb. 1249a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1250a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if 1251a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the call is considered successful. 1252a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 125371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_db_config(sqlite3*, int op, ...); 1254a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1255a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 1256a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Memory Allocation Routines 1257a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1258a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** An instance of this object defines the interface between SQLite 1259a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and low-level memory allocation routines. 1260a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1261a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This object is used in only one place in the SQLite interface. 1262a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A pointer to an instance of this object is the argument to 1263a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] when the configuration option is 1264a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC]. 1265a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** By creating an instance of this object 1266a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC]) 1267a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** during configuration, an application can specify an alternative 1268a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory allocation subsystem for SQLite to use for all of its 1269a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** dynamic memory needs. 1270a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1271a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Note that SQLite comes with several [built-in memory allocators] 1272a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that are perfectly adequate for the overwhelming majority of applications 1273a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and that this object is only useful to a tiny minority of applications 1274a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with specialized memory allocation requirements. This object is 1275a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** also used during testing of SQLite in order to specify an alternative 1276a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory allocator that simulates memory out-of-memory conditions in 1277a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** order to verify that SQLite recovers gracefully from such 1278a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** conditions. 1279a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 128090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The xMalloc, xRealloc, and xFree methods must work like the 128190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** malloc(), realloc() and free() functions from the standard C library. 128290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^SQLite guarantees that the second argument to 1283a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xRealloc is always a value returned by a prior call to xRoundup. 1284a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1285a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xSize should return the allocated size of a memory allocation 1286a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** previously obtained from xMalloc or xRealloc. The allocated size 1287a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is always at least as big as the requested size but may be larger. 1288a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1289a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The xRoundup method returns what would be the allocated size of 1290a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a memory allocation given a particular requested size. Most memory 1291a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocators round up memory allocations at least to the next multiple 1292a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of 8. Some allocators round up to a larger multiple or to a power of 2. 1293a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Every memory allocation request coming in through [sqlite3_malloc()] 1294a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0, 1295a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that causes the corresponding memory allocation to fail. 1296a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1297a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The xInit method initializes the memory allocator. (For example, 1298a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it might allocate any require mutexes or initialize internal data 1299a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** structures. The xShutdown method is invoked (indirectly) by 1300a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_shutdown()] and should deallocate any resources acquired 1301a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by xInit. The pAppData pointer is used as the only parameter to 1302a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xInit and xShutdown. 1303a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1304a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes 1305a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the xInit method, so the xInit method need not be threadsafe. The 1306a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xShutdown method is only called from [sqlite3_shutdown()] so it does 1307a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not need to be threadsafe either. For all other methods, SQLite 1308a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the 1309a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which 1310a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it is by default) and so the methods are automatically serialized. 1311a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other 1312a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** methods must be threadsafe or else make their own arrangements for 1313a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** serialization. 1314a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1315a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite will never invoke xInit() more than once without an intervening 1316a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** call to xShutdown(). 1317a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 1318a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noritypedef struct sqlite3_mem_methods sqlite3_mem_methods; 1319a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noristruct sqlite3_mem_methods { 1320a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *(*xMalloc)(int); /* Memory allocation function */ 1321a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xFree)(void*); /* Free a prior allocation */ 1322a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *(*xRealloc)(void*,int); /* Resize an allocation */ 1323a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xSize)(void*); /* Return the size of an allocation */ 1324a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xRoundup)(int); /* Round up request size to allocation size */ 1325a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xInit)(void*); /* Initialize the memory allocator */ 1326a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xShutdown)(void*); /* Deinitialize the memory allocator */ 1327a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *pAppData; /* Argument to xInit() and xShutdown() */ 1328a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori}; 1329a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1330a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 1331a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Configuration Options 133290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** KEYWORDS: {configuration option} 1333a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1334a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These constants are the available integer configuration options that 1335a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can be passed as the first argument to the [sqlite3_config()] interface. 1336a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1337a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** New configuration options may be added in future releases of SQLite. 1338a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Existing configuration options might be discontinued. Applications 1339a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** should check the return code from [sqlite3_config()] to make sure that 1340a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the call worked. The [sqlite3_config()] interface will return a 1341a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** non-zero [error code] if a discontinued or unsupported configuration option 1342a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is invoked. 1343a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1344a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dl> 134590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_SINGLETHREAD]] <dt>SQLITE_CONFIG_SINGLETHREAD</dt> 1346a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>There are no arguments to this option. ^This option sets the 1347a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [threading mode] to Single-thread. In other words, it disables 1348a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** all mutexing and puts SQLite into a mode where it can only be used 1349a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by a single thread. ^If SQLite is compiled with 1350a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1351a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it is not possible to change the [threading mode] from its default 1352a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value of Single-thread and so [sqlite3_config()] will return 1353a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD 1354a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** configuration option.</dd> 1355a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 135690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_MULTITHREAD]] <dt>SQLITE_CONFIG_MULTITHREAD</dt> 1357a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>There are no arguments to this option. ^This option sets the 1358a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [threading mode] to Multi-thread. In other words, it disables 1359a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** mutexing on [database connection] and [prepared statement] objects. 1360a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The application is responsible for serializing access to 1361a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connections] and [prepared statements]. But other mutexes 1362a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are enabled so that SQLite will be safe to use in a multi-threaded 1363a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** environment as long as no two threads attempt to use the same 1364a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection] at the same time. ^If SQLite is compiled with 1365a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1366a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it is not possible to set the Multi-thread [threading mode] and 1367a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] will return [SQLITE_ERROR] if called with the 1368a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_CONFIG_MULTITHREAD configuration option.</dd> 1369a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 137090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_SERIALIZED]] <dt>SQLITE_CONFIG_SERIALIZED</dt> 1371a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>There are no arguments to this option. ^This option sets the 1372a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [threading mode] to Serialized. In other words, this option enables 1373a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** all mutexes including the recursive 1374a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** mutexes on [database connection] and [prepared statement] objects. 1375a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** In this mode (which is the default when SQLite is compiled with 1376a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access 1377a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to [database connections] and [prepared statements] so that the 1378a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** application is free to use the same [database connection] or the 1379a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** same [prepared statement] in different threads at the same time. 1380a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If SQLite is compiled with 1381a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1382a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it is not possible to set the Serialized [threading mode] and 1383a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] will return [SQLITE_ERROR] if called with the 1384a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_CONFIG_SERIALIZED configuration option.</dd> 1385a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 138690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_MALLOC]] <dt>SQLITE_CONFIG_MALLOC</dt> 1387a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^(This option takes a single argument which is a pointer to an 1388a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** instance of the [sqlite3_mem_methods] structure. The argument specifies 1389a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** alternative low-level memory allocation routines to be used in place of 1390a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the memory allocation routines built into SQLite.)^ ^SQLite makes 1391a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** its own private copy of the content of the [sqlite3_mem_methods] structure 1392a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** before the [sqlite3_config()] call returns.</dd> 1393a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 139490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_GETMALLOC]] <dt>SQLITE_CONFIG_GETMALLOC</dt> 1395a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^(This option takes a single argument which is a pointer to an 1396a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** instance of the [sqlite3_mem_methods] structure. The [sqlite3_mem_methods] 1397a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** structure is filled with the currently defined memory allocation routines.)^ 1398a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This option can be used to overload the default memory allocation 1399a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routines with a wrapper that simulations memory allocation failure or 1400a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** tracks memory usage, for example. </dd> 1401a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 140290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_MEMSTATUS]] <dt>SQLITE_CONFIG_MEMSTATUS</dt> 1403a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^This option takes single argument of type int, interpreted as a 1404a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** boolean, which enables or disables the collection of memory allocation 1405a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** statistics. ^(When memory allocation statistics are disabled, the 1406a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** following SQLite interfaces become non-operational: 1407a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <ul> 1408a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_memory_used()] 1409a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_memory_highwater()] 1410de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> [sqlite3_soft_heap_limit64()] 1411a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_status()] 1412a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ul>)^ 1413a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Memory allocation statistics are enabled by default unless SQLite is 1414a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory 1415a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocation statistics are disabled by default. 1416a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dd> 1417a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 141890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_SCRATCH]] <dt>SQLITE_CONFIG_SCRATCH</dt> 1419a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^This option specifies a static memory buffer that SQLite can use for 1420a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** scratch memory. There are three arguments: A pointer an 8-byte 142190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** aligned memory buffer from which the scratch allocations will be 1422a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** drawn, the size of each scratch allocation (sz), 1423a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and the maximum number of scratch allocations (N). The sz 1424de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** argument must be a multiple of 16. 1425a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The first argument must be a pointer to an 8-byte aligned buffer 1426a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of at least sz*N bytes of memory. 1427de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^SQLite will use no more than two scratch buffers per thread. So 1428de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** N should be set to twice the expected maximum number of threads. 1429de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^SQLite will never require a scratch buffer that is more than 6 1430de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** times the database page size. ^If SQLite needs needs additional 1431de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** scratch memory beyond what is provided by this configuration option, then 1432a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_malloc()] will be used to obtain the memory needed.</dd> 1433a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 143490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt> 1435a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^This option specifies a static memory buffer that SQLite can use for 143690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the database page cache with the default page cache implementation. 1437a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This configuration should not be used if an application-define page 143890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** cache implementation is loaded using the SQLITE_CONFIG_PCACHE2 option. 1439a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** There are three arguments to this option: A pointer to 8-byte aligned 1440a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory, the size of each page buffer (sz), and the number of pages (N). 1441a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sz argument should be the size of the largest database page 1442a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (a power of two between 512 and 32768) plus a little extra for each 1443a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** page header. ^The page header size is 20 to 40 bytes depending on 1444a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the host architecture. ^It is harmless, apart from the wasted memory, 1445a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to make sz a little too large. The first 1446a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** argument should point to an allocation of at least sz*N bytes of memory. 1447a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite will use the memory provided by the first argument to satisfy its 1448a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory needs for the first N pages that it adds to cache. ^If additional 1449a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** page cache memory is needed beyond what is provided by this option, then 1450a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite goes to [sqlite3_malloc()] for the additional storage space. 1451de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The pointer in the first argument must 1452a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** be aligned to an 8-byte boundary or subsequent behavior of SQLite 1453a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will be undefined.</dd> 1454a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 145590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt> 1456a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^This option specifies a static memory buffer that SQLite will use 1457a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for all of its dynamic memory allocation needs beyond those provided 1458a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE]. 1459a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** There are three arguments: An 8-byte aligned pointer to the memory, 1460a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the number of bytes in the memory buffer, and the minimum allocation size. 1461a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts 1462a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to using its default memory allocator (the system malloc() implementation), 1463a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the 1464a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory pointer is not NULL and either [SQLITE_ENABLE_MEMSYS3] or 1465a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_ENABLE_MEMSYS5] are defined, then the alternative memory 1466a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocator is engaged to handle all of SQLites memory allocation needs. 1467a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The first pointer (the memory pointer) must be aligned to an 8-byte 146890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** boundary or subsequent behavior of SQLite will be undefined. 146990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The minimum allocation size is capped at 2**12. Reasonable values 147090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** for the minimum allocation size are 2**5 through 2**8.</dd> 1471a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 147290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_MUTEX]] <dt>SQLITE_CONFIG_MUTEX</dt> 1473a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^(This option takes a single argument which is a pointer to an 1474a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** instance of the [sqlite3_mutex_methods] structure. The argument specifies 1475a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** alternative low-level mutex routines to be used in place 1476a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the mutex routines built into SQLite.)^ ^SQLite makes a copy of the 1477a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** content of the [sqlite3_mutex_methods] structure before the call to 1478a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] returns. ^If SQLite is compiled with 1479a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1480a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the entire mutexing subsystem is omitted from the build and hence calls to 1481a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will 1482a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** return [SQLITE_ERROR].</dd> 1483a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 148490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_GETMUTEX]] <dt>SQLITE_CONFIG_GETMUTEX</dt> 1485a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^(This option takes a single argument which is a pointer to an 1486a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** instance of the [sqlite3_mutex_methods] structure. The 1487a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_mutex_methods] 1488a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** structure is filled with the currently defined mutex routines.)^ 1489a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This option can be used to overload the default mutex allocation 1490a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routines with a wrapper used to track mutex usage for performance 1491a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** profiling or testing, for example. ^If SQLite is compiled with 1492a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1493a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the entire mutexing subsystem is omitted from the build and hence calls to 1494a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will 1495a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** return [SQLITE_ERROR].</dd> 1496a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 149790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_LOOKASIDE]] <dt>SQLITE_CONFIG_LOOKASIDE</dt> 1498a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^(This option takes two arguments that determine the default 1499a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory allocation for the lookaside memory allocator on each 1500a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection]. The first argument is the 1501a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** size of each lookaside buffer slot and the second is the number of 1502a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** slots allocated to each database connection.)^ ^(This option sets the 1503a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE] 1504a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** verb to [sqlite3_db_config()] can be used to change the lookaside 1505a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** configuration on individual connections.)^ </dd> 1506a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 150790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_PCACHE2]] <dt>SQLITE_CONFIG_PCACHE2</dt> 1508a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^(This option takes a single argument which is a pointer to 150990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** an [sqlite3_pcache_methods2] object. This object specifies the interface 1510a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to a custom page cache implementation.)^ ^SQLite makes a copy of the 1511a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** object and uses it for page cache memory allocations.</dd> 1512a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 151390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_GETPCACHE2]] <dt>SQLITE_CONFIG_GETPCACHE2</dt> 1514a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^(This option takes a single argument which is a pointer to an 151590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_pcache_methods2] object. SQLite copies of the current 1516a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** page cache implementation into that object.)^ </dd> 1517a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 151890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_LOG]] <dt>SQLITE_CONFIG_LOG</dt> 151971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <dd> ^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a 152071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** function with a call signature of void(*)(void*,int,const char*), 152171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** and a pointer to void. ^If the function pointer is not NULL, it is 152271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** invoked by [sqlite3_log()] to process each logging event. ^If the 152371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op. 152471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is 152571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** passed through as the first parameter to the application-defined logger 152671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** function whenever that function is invoked. ^The second parameter to 152771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** the logger function is a copy of the first parameter to the corresponding 152871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [sqlite3_log()] call and is intended to be a [result code] or an 152971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [extended result code]. ^The third parameter passed to the logger is 153071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** log message after formatting via [sqlite3_snprintf()]. 153171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** The SQLite logging interface is not reentrant; the logger function 153271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** supplied by the application must not invoke any SQLite interface. 153371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** In a multi-threaded application, the application-defined logger 153471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** function must be threadsafe. </dd> 153571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 153690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_URI]] <dt>SQLITE_CONFIG_URI 153790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd> This option takes a single argument of type int. If non-zero, then 153890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** URI handling is globally enabled. If the parameter is zero, then URI handling 153990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is globally disabled. If URI handling is globally enabled, all filenames 154090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** passed to [sqlite3_open()], [sqlite3_open_v2()], [sqlite3_open16()] or 154190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** specified as part of [ATTACH] commands are interpreted as URIs, regardless 154290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** of whether or not the [SQLITE_OPEN_URI] flag is set when the database 154390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** connection is opened. If it is globally disabled, filenames are 154490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the 154590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** database connection is opened. By default, URI handling is globally 154690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** disabled. The default value may be changed by compiling with the 154790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SQLITE_USE_URI] symbol defined. 154890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 154990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_CONFIG_PCACHE]] [[SQLITE_CONFIG_GETPCACHE]] 155090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dt>SQLITE_CONFIG_PCACHE and SQLITE_CONFNIG_GETPCACHE 155190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd> These options are obsolete and should not be used by new code. 155290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** They are retained for backwards compatibility but are now no-ops. 1553a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dl> 1554a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 1555a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */ 1556a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_MULTITHREAD 2 /* nil */ 1557a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_SERIALIZED 3 /* nil */ 1558a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */ 1559a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */ 1560a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */ 1561a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */ 1562a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */ 1563a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */ 1564a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */ 1565a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */ 1566a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */ 1567a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_CONFIG_LOOKASIDE 13 /* int int */ 156890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_CONFIG_PCACHE 14 /* no-op */ 156990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_CONFIG_GETPCACHE 15 /* no-op */ 1570aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori#define SQLITE_CONFIG_LOG 16 /* xFunc, void* */ 157190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_CONFIG_URI 17 /* int */ 157290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_CONFIG_PCACHE2 18 /* sqlite3_pcache_methods2* */ 157390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_CONFIG_GETPCACHE2 19 /* sqlite3_pcache_methods2* */ 1574a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1575a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 157671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** CAPI3REF: Database Connection Configuration Options 15777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1578a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These constants are the available integer configuration options that 1579a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can be passed as the second argument to the [sqlite3_db_config()] interface. 15807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1581a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** New configuration options may be added in future releases of SQLite. 1582a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Existing configuration options might be discontinued. Applications 1583a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** should check the return code from [sqlite3_db_config()] to make sure that 1584a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the call worked. ^The [sqlite3_db_config()] interface will return a 1585a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** non-zero [error code] if a discontinued or unsupported configuration option 1586a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is invoked. 1587a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1588a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dl> 1589a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt> 1590a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd> ^This option takes three additional arguments that determine the 1591a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [lookaside memory allocator] configuration for the [database connection]. 1592a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first argument (the third parameter to [sqlite3_db_config()] is a 159390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** pointer to a memory buffer to use for lookaside memory. 1594a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb 1595a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** may be NULL in which case SQLite will allocate the 1596a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the 1597a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** size of each lookaside buffer slot. ^The third argument is the number of 1598a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** slots. The size of the buffer in the first argument must be greater than 1599a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or equal to the product of the second and third arguments. The buffer 1600a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** must be aligned to an 8-byte boundary. ^If the second argument to 1601a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally 1602de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** rounded down to the next smaller multiple of 8. ^(The lookaside memory 1603de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** configuration for a database connection can only be changed when that 1604de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** connection is not currently using lookaside memory, or in other words 1605de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** when the "current value" returned by 1606de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [sqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero. 1607de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** Any attempt to change the lookaside memory configuration when lookaside 1608de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** memory is in use leaves the configuration unchanged and returns 1609de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [SQLITE_BUSY].)^</dd> 16107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 161190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dt>SQLITE_DBCONFIG_ENABLE_FKEY</dt> 161290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd> ^This option is used to enable or disable the enforcement of 161390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [foreign key constraints]. There should be two additional arguments. 161490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The first argument is an integer which is 0 to disable FK enforcement, 161590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** positive to enable FK enforcement or negative to leave FK enforcement 161690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** unchanged. The second parameter is a pointer to an integer into which 161790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is written 0 or 1 to indicate whether FK enforcement is off or on 161890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** following this call. The second parameter may be a NULL pointer, in 161990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** which case the FK enforcement setting is not reported back. </dd> 162090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 162190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dt>SQLITE_DBCONFIG_ENABLE_TRIGGER</dt> 162290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd> ^This option is used to enable or disable [CREATE TRIGGER | triggers]. 162390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** There should be two additional arguments. 162490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The first argument is an integer which is 0 to disable triggers, 162590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** positive to enable triggers or negative to leave the setting unchanged. 162690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The second parameter is a pointer to an integer into which 162790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is written 0 or 1 to indicate whether triggers are disabled or enabled 162890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** following this call. The second parameter may be a NULL pointer, in 162990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** which case the trigger setting is not reported back. </dd> 163090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 1631a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dl> 1632a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 163390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */ 163490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */ 163590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */ 1636a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1637a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1638a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 1639a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Enable Or Disable Extended Result Codes 16407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1641a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_extended_result_codes() routine enables or disables the 1642a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [extended result codes] feature of SQLite. ^The extended result 1643a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** codes are disabled by default for historical compatibility. 16447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 1645a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_extended_result_codes(sqlite3*, int onoff); 16467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 16477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1648a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Last Insert Rowid 16497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1650a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Each entry in an SQLite table has a unique 64-bit signed 1651a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** integer key called the [ROWID | "rowid"]. ^The rowid is always available 16527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** as an undeclared column named ROWID, OID, or _ROWID_ as long as those 1653a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** names are not also used by explicitly declared columns. ^If 1654a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the table has a column of type [INTEGER PRIMARY KEY] then that column 16557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is another alias for the rowid. 16567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1657a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This routine returns the [rowid] of the most recent 1658a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** successful [INSERT] into the database from the [database connection] 165990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** in the first argument. ^As of SQLite version 3.7.7, this routines 166090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** records the last insert rowid of both ordinary tables and [virtual tables]. 166190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^If no successful [INSERT]s 1662a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** have ever occurred on that database connection, zero is returned. 16637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 166490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^(If an [INSERT] occurs within a trigger or within a [virtual table] 166590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** method, then this routine will return the [rowid] of the inserted 166690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** row as long as the trigger or virtual table method is running. 166790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** But once the trigger or virtual table method ends, the value returned 166890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** by this routine reverts to what it was before the trigger or virtual 166990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** table method began.)^ 16707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1671a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^An [INSERT] that fails due to a constraint violation is not a 1672a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** successful [INSERT] and does not change the value returned by this 1673a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK, 16747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and INSERT OR ABORT make no changes to the return value of this 1675a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routine when their insertion fails. ^(When INSERT OR REPLACE 16767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** encounters a constraint violation, it does not fail. The 16777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** INSERT continues to completion after deleting rows that caused 16787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the constraint problem so INSERT OR REPLACE will always change 1679a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the return value of this interface.)^ 16807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1681a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^For the purposes of this routine, an [INSERT] is considered to 16827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** be successful even if it is subsequently rolled back. 16837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1684a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This function is accessible to SQL statements via the 1685a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [last_insert_rowid() SQL function]. 16867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1687a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If a separate thread performs a new [INSERT] on the same 1688a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database connection while the [sqlite3_last_insert_rowid()] 1689a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function is running and thus changes the last insert [rowid], 1690a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the value returned by [sqlite3_last_insert_rowid()] is 1691a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** unpredictable and might not equal either the old or the new 1692a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** last insert [rowid]. 16937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 1694a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*); 16957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 16967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1697a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Count The Number Of Rows Modified 16987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1699a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This function returns the number of database rows that were changed 17007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or inserted or deleted by the most recently completed SQL statement 1701a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on the [database connection] specified by the first parameter. 1702a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Only changes that are directly specified by the [INSERT], [UPDATE], 1703a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [DELETE] statement are counted. Auxiliary changes caused by 1704a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** triggers or [foreign key actions] are not counted.)^ Use the 1705a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_total_changes()] function to find the total number of changes 1706a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** including changes caused by triggers and foreign key actions. 17077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1708a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Changes to a view that are simulated by an [INSTEAD OF trigger] 1709a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are not counted. Only real table changes are counted. 1710a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1711a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(A "row change" is a change to a single row of a single table 17127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** caused by an INSERT, DELETE, or UPDATE statement. Rows that 1713a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are changed as side effects of [REPLACE] constraint resolution, 1714a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** rollback, ABORT processing, [DROP TABLE], or by any other 1715a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** mechanisms do not count as direct row changes.)^ 17167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 17177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** A "trigger context" is a scope of execution that begins and 1718a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ends with the script of a [CREATE TRIGGER | trigger]. 1719a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Most SQL statements are 17207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** evaluated outside of any trigger. This is the "top level" 17217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** trigger context. If a trigger fires from the top level, a 17227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** new trigger context is entered for the duration of that one 17237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** trigger. Subtriggers create subcontexts for their duration. 17247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1725a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Calling [sqlite3_exec()] or [sqlite3_step()] recursively does 17267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** not create a new trigger context. 17277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1728a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This function returns the number of direct row changes in the 17297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** most recent INSERT, UPDATE, or DELETE statement within the same 17307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** trigger context. 17317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1732a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Thus, when called from the top level, this function returns the 17337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** number of changes in the most recent INSERT, UPDATE, or DELETE 1734a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that also occurred at the top level. ^(Within the body of a trigger, 1735a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the sqlite3_changes() interface can be called to find the number of 17367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** changes in the most recently completed INSERT, UPDATE, or DELETE 17377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** statement within the body of the same trigger. 1738a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** However, the number returned does not include changes 1739a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** caused by subtriggers since those have their own context.)^ 17407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1741a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also the [sqlite3_total_changes()] interface, the 1742a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [count_changes pragma], and the [changes() SQL function]. 17437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1744a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If a separate thread makes changes on the same database connection 1745a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** while [sqlite3_changes()] is running then the value returned 1746a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is unpredictable and not meaningful. 1747a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 1748a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_changes(sqlite3*); 1749a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 1750a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 1751a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Total Number Of Rows Modified 1752a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1753a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This function returns the number of row changes caused by [INSERT], 1754a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [UPDATE] or [DELETE] statements since the [database connection] was opened. 1755a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The count returned by sqlite3_total_changes() includes all changes 1756a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from all [CREATE TRIGGER | trigger] contexts and changes made by 1757a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [foreign key actions]. However, 1758a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the count does not include changes used to implement [REPLACE] constraints, 1759a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** do rollbacks or ABORT processing, or [DROP TABLE] processing. The 1760a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** count does not include rows of views that fire an [INSTEAD OF trigger], 1761a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** though if the INSTEAD OF trigger makes changes of its own, those changes 1762a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are counted.)^ 1763a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_total_changes() function counts the changes as soon as 1764a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the statement that makes them is completed (when the statement handle 1765a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is passed to [sqlite3_reset()] or [sqlite3_finalize()]). 1766a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1767a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also the [sqlite3_changes()] interface, the 1768a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [count_changes pragma], and the [total_changes() SQL function]. 1769a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1770a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If a separate thread makes changes on the same database connection 1771a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** while [sqlite3_total_changes()] is running then the value 1772a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned is unpredictable and not meaningful. 17737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 1774a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_total_changes(sqlite3*); 17757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 17767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1777a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Interrupt A Long-Running Query 17787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1779a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This function causes any pending database operation to abort and 17807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** return at its earliest opportunity. This routine is typically 17817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** called in response to a user action such as pressing "Cancel" 17827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or Ctrl-C where the user wants a long query operation to halt 17837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** immediately. 17847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1785a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^It is safe to call this routine from a thread different from the 17867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** thread that is currently running the database operation. But it 1787a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not safe to call this routine with a [database connection] that 17887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is closed or might close before sqlite3_interrupt() returns. 17897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1790a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If an SQL operation is very nearly finished at the time when 1791a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_interrupt() is called, then it might not have an opportunity 1792a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to be interrupted and might continue to completion. 1793a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1794a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT]. 1795a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE 1796a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that is inside an explicit transaction, then the entire transaction 1797a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will be rolled back automatically. 1798a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1799a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_interrupt(D) call is in effect until all currently running 1800a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL statements on [database connection] D complete. ^Any new SQL statements 1801a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that are started after the sqlite3_interrupt() call and before the 1802a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** running statements reaches zero are interrupted as if they had been 1803a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** running prior to the sqlite3_interrupt() call. ^New SQL statements 1804a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that are started after the running statement count reaches zero are 1805a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not effected by the sqlite3_interrupt(). 1806a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A call to sqlite3_interrupt(D) that occurs when there are no running 1807a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL statements is a no-op and has no effect on SQL statements 1808a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that are started after the sqlite3_interrupt() call returns. 1809a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1810a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If the database connection closes while [sqlite3_interrupt()] 1811a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is running then bad things will likely happen. 18127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 1813a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_interrupt(sqlite3*); 18147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 18157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1816a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Determine If An SQL Statement Is Complete 18177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1818a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These routines are useful during command-line input to determine if the 1819a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** currently entered text seems to form a complete SQL statement or 18207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** if additional input is needed before sending the text into 1821a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite for parsing. ^These routines return 1 if the input string 1822a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** appears to be a complete SQL statement. ^A statement is judged to be 1823a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** complete if it ends with a semicolon token and is not a prefix of a 1824a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within 18257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** string literals or quoted identifier names or comments are not 18267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** independent tokens (they are part of the token in which they are 1827a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** embedded) and thus do not count as a statement terminator. ^Whitespace 1828a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and comments that follow the final semicolon are ignored. 18297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1830a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines return 0 if the statement is incomplete. ^If a 1831a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory allocation fails, then SQLITE_NOMEM is returned. 18327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1833a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines do not parse the SQL statements thus 1834a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will not detect syntactically incorrect SQL. 18357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1836a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior 1837a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked 1838a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** automatically by sqlite3_complete16(). If that initialization fails, 1839a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the return value from sqlite3_complete16() will be non-zero 1840a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** regardless of whether or not the input SQL is complete.)^ 18417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1842a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The input to [sqlite3_complete()] must be a zero-terminated 1843a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** UTF-8 string. 18447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1845a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The input to [sqlite3_complete16()] must be a zero-terminated 1846a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** UTF-16 string in native byte order. 18477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 1848a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_complete(const char *sql); 1849a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_complete16(const void *sql); 18507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 18517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1852a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors 1853a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1854a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This routine sets a callback function that might be invoked whenever 1855a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an attempt is made to open a database table that another thread 1856a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or process has locked. 18577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1858a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the busy callback is NULL, then [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] 1859a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is returned immediately upon encountering the lock. ^If the busy callback 1860a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not NULL, then the callback might be invoked with two arguments. 1861a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1862a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first argument to the busy handler is a copy of the void* pointer which 1863a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is the third argument to sqlite3_busy_handler(). ^The second argument to 1864a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the busy handler callback is the number of times that the busy handler has 1865a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** been invoked for this locking event. ^If the 18667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** busy callback returns 0, then no additional attempts are made to 18677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned. 1868a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the callback returns non-zero, then another attempt 18697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is made to open the database for reading and the cycle repeats. 18707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1871a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The presence of a busy handler does not guarantee that it will be invoked 1872a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** when there is lock contention. ^If SQLite determines that invoking the busy 1873a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY] 1874a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [SQLITE_IOERR_BLOCKED] instead of invoking the busy handler. 18757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Consider a scenario where one process is holding a read lock that 18767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** it is trying to promote to a reserved lock and 18777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a second process is holding a reserved lock that it is trying 18787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to promote to an exclusive lock. The first process cannot proceed 18797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** because it is blocked by the second and the second process cannot 18807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** proceed because it is blocked by the first. If both processes 18817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** invoke the busy handlers, neither will make any progress. Therefore, 18827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLite returns [SQLITE_BUSY] for the first process, hoping that this 18837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** will induce the first process to release its read lock and allow 18847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the second process to proceed. 18857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1886a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The default busy callback is NULL. 18877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1888a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED] 18897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** when SQLite is in the middle of a large transaction where all the 18907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** changes will not fit into the in-memory cache. SQLite will 18917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** already hold a RESERVED lock on the database file, but it needs 18927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to promote this lock to EXCLUSIVE so that it can spill cache 18937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** pages into the database file without harm to concurrent 1894a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** readers. ^If it is unable to promote the lock, then the in-memory 18957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** cache will be left in an inconsistent state and so the error 18967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** code is promoted from the relatively benign [SQLITE_BUSY] to 1897a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the more severe [SQLITE_IOERR_BLOCKED]. ^This error code promotion 18987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** forces an automatic rollback of the changes. See the 1899a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <a href="/cvstrac/wiki?p=CorruptionFollowingBusyError"> 19007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** CorruptionFollowingBusyError</a> wiki page for a discussion of why 19017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** this is important. 19027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1903a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(There can only be a single busy handler defined for each 1904a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection]. Setting a new busy handler clears any 1905a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()] 1906a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will also set or clear the busy handler. 19077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1908a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The busy callback should not take any actions which modify the 1909a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database connection that invoked the busy handler. Any such actions 1910a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** result in undefined behavior. 1911a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 1912a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A busy handler must not close the database connection 1913a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [prepared statement] that invoked the busy handler. 19147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 1915a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*); 19167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 19177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1918a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Set A Busy Timeout 19197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1920a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps 1921a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for a specified amount of time when a table is locked. ^The handler 1922a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will sleep multiple times until at least "ms" milliseconds of sleeping 1923a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** have accumulated. ^After at least "ms" milliseconds of sleeping, 1924a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the handler returns 0 which causes [sqlite3_step()] to return 1925a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED]. 19267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1927a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Calling this routine with an argument less than or equal to zero 19287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** turns off all busy handlers. 19297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1930a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(There can only be a single busy handler for a particular 1931a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection] any any given moment. If another busy handler 1932a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** was defined (using [sqlite3_busy_handler()]) prior to calling 1933a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** this routine, that other busy handler is cleared.)^ 19347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 1935a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms); 19367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 19377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 1938a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Convenience Routines For Running Queries 19397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 194095c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** This is a legacy interface that is preserved for backwards compatibility. 194195c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** Use of this interface is not recommended. 194295c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** 19437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Definition: A <b>result table</b> is memory data structure created by the 19447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_get_table()] interface. A result table records the 19457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** complete query results from one or more queries. 19467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 19477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The table conceptually has a number of rows and columns. But 19487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** these numbers are not part of the result table itself. These 19497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** numbers are obtained separately. Let N be the number of rows 19507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and M be the number of columns. 19517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1952a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A result table is an array of pointers to zero-terminated UTF-8 strings. 1953a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** There are (N+1)*M elements in the array. The first M pointers point 1954a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to zero-terminated strings that contain the names of the columns. 1955a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The remaining entries all point to query results. NULL values result 1956a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in NULL pointers. All other values are in their UTF-8 zero-terminated 1957a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** string representation as returned by [sqlite3_column_text()]. 19587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1959a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A result table might consist of one or more memory allocations. 19607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** It is not safe to pass a result table directly to [sqlite3_free()]. 19617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** A result table should be deallocated using [sqlite3_free_table()]. 19627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 196395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^(As an example of the result table format, suppose a query result 19647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is as follows: 19657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 19667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote><pre> 19677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Name | Age 19687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** ----------------------- 19697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Alice | 43 19707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Bob | 28 19717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Cindy | 21 19727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </pre></blockquote> 19737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 19747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** There are two column (M==2) and three rows (N==3). Thus the 19757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** result table has 8 entries. Suppose the result table is stored 19767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** in an array names azResult. Then azResult holds this content: 19777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 19787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote><pre> 19797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[0] = "Name"; 19807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[1] = "Age"; 19817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[2] = "Alice"; 19827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[3] = "43"; 19837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[4] = "Bob"; 19847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[5] = "28"; 19857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[6] = "Cindy"; 19867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** azResult[7] = "21"; 198795c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** </pre></blockquote>)^ 19887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1989a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_get_table() function evaluates one or more 19907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** semicolon-separated SQL statements in the zero-terminated UTF-8 1991a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** string of its 2nd parameter and returns a result table to the 19927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** pointer given in its 3rd parameter. 19937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 1994a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** After the application has finished with the result from sqlite3_get_table(), 199595c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** it must pass the result table pointer to sqlite3_free_table() in order to 1996a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** release the memory that was malloced. Because of the way the 19977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling 1998a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function must not try to call [sqlite3_free()] directly. Only 19997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_free_table()] is able to release the memory properly and safely. 20007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 200195c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** The sqlite3_get_table() interface is implemented as a wrapper around 20027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access 20037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to any internal data structures of SQLite. It uses only the public 20047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface defined here. As a consequence, errors that occur in the 20057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** wrapper layer outside of the internal [sqlite3_exec()] call are not 20067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** reflected in subsequent calls to [sqlite3_errcode()] or 200795c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** [sqlite3_errmsg()]. 2008a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 2009a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_get_table( 2010a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori sqlite3 *db, /* An open database */ 2011a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori const char *zSql, /* SQL to be evaluated */ 2012a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori char ***pazResult, /* Results of the query */ 2013a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int *pnRow, /* Number of result rows written here */ 2014a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int *pnColumn, /* Number of result columns written here */ 2015a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori char **pzErrmsg /* Error msg written here */ 20167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 2017a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_free_table(char **result); 20187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 20197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2020a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Formatted String Printing Functions 20217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2022a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These routines are work-alikes of the "printf()" family of functions 20237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** from the standard C library. 20247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2025a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their 20267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** results into memory obtained from [sqlite3_malloc()]. 20277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The strings returned by these two routines should be 2028a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** released by [sqlite3_free()]. ^Both routines return a 20297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** NULL pointer if [sqlite3_malloc()] is unable to allocate enough 20307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** memory to hold the resulting string. 20317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 203290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from 20337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the standard C library. The result is written into the 20347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** buffer supplied as the second parameter whose size is given by 20357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the first parameter. Note that the order of the 2036a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** first two parameters is reversed from snprintf().)^ This is an 20377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** historical accident that cannot be fixed without breaking 2038a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** backwards compatibility. ^(Note also that sqlite3_snprintf() 20397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** returns a pointer to its buffer instead of the number of 2040a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** characters actually written into the buffer.)^ We admit that 20417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the number of characters written would be a more useful return 20427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** value but we cannot change the implementation of sqlite3_snprintf() 20437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** now without breaking compatibility. 20447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2045a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^As long as the buffer size is greater than zero, sqlite3_snprintf() 2046a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** guarantees that the buffer is always zero-terminated. ^The first 20477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** parameter "n" is the total size of the buffer, including space for 20487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the zero terminator. So the longest string that can be completely 20497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** written will be n-1 characters. 20507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 205190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf(). 205290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 20537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These routines all implement some additional formatting 20547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** options that are useful for constructing SQL statements. 2055a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** All of the usual printf() formatting options apply. In addition, there 20567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is are "%q", "%Q", and "%z" options. 20577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 205890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^(The %q option works like %s in that it substitutes a nul-terminated 20597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** string from the argument list. But %q also doubles every '\'' character. 2060a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** %q is designed for use inside a string literal.)^ By doubling each '\'' 20617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** character it escapes that character and allows it to be inserted into 20627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the string. 20637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2064a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** For example, assume the string variable zText contains text as follows: 20657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 20667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote><pre> 20677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** char *zText = "It's a happy day!"; 20687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </pre></blockquote> 20697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 20707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** One can use this text in an SQL statement as follows: 20717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 20727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote><pre> 20737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText); 20747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_exec(db, zSQL, 0, 0, 0); 20757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_free(zSQL); 20767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </pre></blockquote> 20777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 20787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Because the %q format string is used, the '\'' character in zText 20797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is escaped and the SQL generated is as follows: 20807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 20817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote><pre> 20827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** INSERT INTO table1 VALUES('It''s a happy day!') 20837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </pre></blockquote> 20847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 20857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** This is correct. Had we used %s instead of %q, the generated SQL 20867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** would have looked like this: 20877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 20887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote><pre> 20897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** INSERT INTO table1 VALUES('It's a happy day!'); 20907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </pre></blockquote> 20917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2092a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This second example is an SQL syntax error. As a general rule you should 2093a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** always use %q instead of %s when inserting text into a string literal. 20947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2095a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The %Q option works like %q except it also adds single quotes around 2096a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the outside of the total string. Additionally, if the parameter in the 2097a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** argument list is a NULL pointer, %Q substitutes the text "NULL" (without 2098a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** single quotes).)^ So, for example, one could say: 20997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 21007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote><pre> 21017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText); 21027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_exec(db, zSQL, 0, 0, 0); 21037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_free(zSQL); 21047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </pre></blockquote> 21057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 21067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The code above will render a correct SQL statement in the zSQL 21077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** variable even if the zText variable is a NULL pointer. 21087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2109a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The "%z" formatting option works like "%s" but with the 21107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** addition that after the string has been read and copied into 2111a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the result, [sqlite3_free()] is called on the input string.)^ 21127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2113a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API char *sqlite3_mprintf(const char*,...); 2114a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API char *sqlite3_vmprintf(const char*, va_list); 2115a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API char *sqlite3_snprintf(int,char*,const char*, ...); 211690ed05d921d6ed7f12012d9786d53f57fafee51aJeff BrownSQLITE_API char *sqlite3_vsnprintf(int,char*,const char*, va_list); 21177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 21187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2119a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Memory Allocation Subsystem 21207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2121a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The SQLite core uses these three routines for all of its own 21227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** internal memory allocation needs. "Core" in the previous sentence 21237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** does not include operating-system specific VFS implementation. The 2124a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Windows VFS uses native malloc() and free() for some operations. 21257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2126a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_malloc() routine returns a pointer to a block 21277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of memory at least N bytes in length, where N is the parameter. 2128a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_malloc() is unable to obtain sufficient free 2129a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory, it returns a NULL pointer. ^If the parameter N to 21307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns 21317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a NULL pointer. 21327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2133a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Calling sqlite3_free() with a pointer previously returned 21347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** by sqlite3_malloc() or sqlite3_realloc() releases that memory so 2135a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that it might be reused. ^The sqlite3_free() routine is 21367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a no-op if is called with a NULL pointer. Passing a NULL pointer 21377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to sqlite3_free() is harmless. After being freed, memory 21387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** should neither be read nor written. Even reading previously freed 21397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** memory might result in a segmentation fault or other severe error. 21407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Memory corruption, a segmentation fault, or other severe error 21417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** might result if sqlite3_free() is called with a non-NULL pointer that 2142a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** was not obtained from sqlite3_malloc() or sqlite3_realloc(). 21437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2144a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The sqlite3_realloc() interface attempts to resize a 21457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** prior memory allocation to be at least N bytes, where N is the 21467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** second parameter. The memory allocation to be resized is the first 2147a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter.)^ ^ If the first parameter to sqlite3_realloc() 21487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is a NULL pointer then its behavior is identical to calling 21497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc(). 2150a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the second parameter to sqlite3_realloc() is zero or 21517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** negative then the behavior is exactly the same as calling 21527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_free(P) where P is the first parameter to sqlite3_realloc(). 2153a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^sqlite3_realloc() returns a pointer to a memory allocation 21547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of at least N bytes in size or NULL if sufficient memory is unavailable. 2155a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If M is the size of the prior allocation, then min(N,M) bytes 21567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of the prior allocation are copied into the beginning of buffer returned 21577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** by sqlite3_realloc() and the prior allocation is freed. 2158a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_realloc() returns NULL, then the prior allocation 21597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is not freed. 21607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2161a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The memory returned by sqlite3_malloc() and sqlite3_realloc() 2162de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** is always aligned to at least an 8 byte boundary, or to a 2163de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time 2164de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** option is used. 21657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 21667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** In SQLite version 3.5.0 and 3.5.1, it was possible to define 21677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in 21687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** implementation of these routines to be omitted. That capability 2169a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is no longer provided. Only built-in memory allocators can be used. 21707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2171a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The Windows OS interface layer calls 21727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the system malloc() and free() directly when converting 21737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** filenames between the UTF-8 encoding used by SQLite 2174a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and whatever filename encoding is used by the particular Windows 21757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** installation. Memory allocation errors are detected, but 21767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** they are reported back as [SQLITE_CANTOPEN] or 21777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_IOERR] rather than [SQLITE_NOMEM]. 21787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2179a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()] 2180a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** must be either NULL or else pointers obtained from a prior 2181a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have 2182a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not yet been released. 21837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2184a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The application must not read or write any part of 2185a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a block of memory after it has been released using 2186a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_free()] or [sqlite3_realloc()]. 21877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2188a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void *sqlite3_malloc(int); 2189a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void *sqlite3_realloc(void*, int); 2190a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_free(void*); 21917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 21927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2193a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Memory Allocator Statistics 21947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 21957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLite provides these two interfaces for reporting on the status 21967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()] 2197a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routines, which form the built-in memory allocation subsystem. 2198a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2199a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_memory_used()] routine returns the number of bytes 2200a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of memory currently outstanding (malloced but not freed). 2201a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_memory_highwater()] routine returns the maximum 2202a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value of [sqlite3_memory_used()] since the high-water mark 2203a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** was last reset. ^The values returned by [sqlite3_memory_used()] and 2204a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_memory_highwater()] include any overhead 2205a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** added by SQLite in its implementation of [sqlite3_malloc()], 2206a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** but not overhead added by the any underlying system library 2207a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routines that [sqlite3_malloc()] may call. 2208a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2209a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The memory high-water mark is reset to the current value of 2210a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_memory_used()] if and only if the parameter to 2211a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_memory_highwater()] is true. ^The value returned 2212a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by [sqlite3_memory_highwater(1)] is the high-water mark 2213a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** prior to the reset. 22147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2215a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3_int64 sqlite3_memory_used(void); 2216a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag); 22177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 22187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2219a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Pseudo-Random Number Generator 22207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 22217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLite contains a high-quality pseudo-random number generator (PRNG) used to 2222a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** select random [ROWID | ROWIDs] when inserting new records into a table that 2223a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** already uses the largest possible [ROWID]. The PRNG is also used for 22247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the build-in random() and randomblob() SQL functions. This interface allows 2225a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** applications to access the same PRNG for other purposes. 22267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2227a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A call to this routine stores N bytes of randomness into buffer P. 22287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2229a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first time this routine is invoked (either internally or by 22307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the application) the PRNG is seeded using randomness obtained 22317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** from the xRandomness method of the default [sqlite3_vfs] object. 2232a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^On all subsequent invocations, the pseudo-randomness is generated 22337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** internally and without recourse to the [sqlite3_vfs] xRandomness 22347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** method. 22357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2236a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_randomness(int N, void *P); 22377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 22387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2239a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Compile-Time Authorization Callbacks 22407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 224190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^This routine registers an authorizer callback with a particular 22427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [database connection], supplied in the first argument. 2243a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The authorizer callback is invoked as SQL statements are being compiled 22447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()], 2245a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. ^At various 22467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** points during the compilation process, as logic is being created 22477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to perform various actions, the authorizer callback is invoked to 2248a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** see if those actions are allowed. ^The authorizer callback should 22497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the 22507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** specific action but allow the SQL statement to continue to be 22517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be 2252a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** rejected with an error. ^If the authorizer callback returns 22537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY] 2254a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the [sqlite3_prepare_v2()] or equivalent call that triggered 22557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the authorizer will fail with an error message. 22567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 22577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** When the callback returns [SQLITE_OK], that means the operation 2258a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** requested is ok. ^When the callback returns [SQLITE_DENY], the 22597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_prepare_v2()] or equivalent call that triggered the 22607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** authorizer will fail with an error message explaining that 2261a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** access is denied. 2262a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2263a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first parameter to the authorizer callback is a copy of the third 2264a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter to the sqlite3_set_authorizer() interface. ^The second parameter 2265a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the callback is an integer [SQLITE_COPY | action code] that specifies 2266a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the particular action to be authorized. ^The third through sixth parameters 2267a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the callback are zero-terminated strings that contain additional 2268a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** details about the action to be authorized. 2269a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2270a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the action code is [SQLITE_READ] 22717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and the callback returns [SQLITE_IGNORE] then the 22727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [prepared statement] statement is constructed to substitute 22737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a NULL value in place of the table column that would have 22747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE] 22757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** return can be used to deny an untrusted user access to individual 22767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** columns of a table. 2277a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the action code is [SQLITE_DELETE] and the callback returns 2278a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the 2279a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [truncate optimization] is disabled and all rows are deleted individually. 22807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 22817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** An authorizer is used when [sqlite3_prepare | preparing] 2282a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL statements from an untrusted source, to ensure that the SQL statements 2283a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** do not try to access data they are not allowed to see, or that they do not 2284a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** try to execute malicious statements that damage the database. For 22857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** example, an application may allow a user to enter arbitrary 22867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQL queries for evaluation by a database. But the application does 22877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** not want the user to be able to make arbitrary changes to the 22887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** database. An authorizer could then be put in place while the 22897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** user-entered SQL is being [sqlite3_prepare | prepared] that 22907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** disallows everything except [SELECT] statements. 22917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 22927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Applications that need to process SQL from untrusted sources 22937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** might also consider lowering resource limits using [sqlite3_limit()] 22947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and limiting database size using the [max_page_count] [PRAGMA] 22957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** in addition to using an authorizer. 22967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2297a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Only a single authorizer can be in place on a database connection 22987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** at a time. Each call to sqlite3_set_authorizer overrides the 2299a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** previous call.)^ ^Disable the authorizer by installing a NULL callback. 23007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The authorizer is disabled by default. 23017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2302a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The authorizer callback must not do anything that will modify 2303a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the database connection that invoked the authorizer callback. 2304a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 2305a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database connections for the meaning of "modify" in this paragraph. 23067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2307a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the 2308a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** statement might be re-prepared during [sqlite3_step()] due to a 2309a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** schema change. Hence, the application should ensure that the 2310a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** correct authorizer callback remains in place during the [sqlite3_step()]. 23117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2312a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Note that the authorizer callback is invoked only during 2313a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_prepare()] or its variants. Authorization is not 2314a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** performed during statement evaluation in [sqlite3_step()], unless 2315a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** as stated in the previous paragraph, sqlite3_step() invokes 2316a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_prepare_v2() to reprepare a statement after a schema change. 23177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2318a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_set_authorizer( 23197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 23207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xAuth)(void*,int,const char*,const char*,const char*,const char*), 23217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void *pUserData 23227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 23237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 23247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2325a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Authorizer Return Codes 23267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 23277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The [sqlite3_set_authorizer | authorizer callback function] must 23287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** return either [SQLITE_OK] or one of these two constants in order 23297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to signal SQLite whether or not the action is permitted. See the 23307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_set_authorizer | authorizer documentation] for additional 23317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** information. 233290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 233390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Note that SQLITE_IGNORE is also used as a [SQLITE_ROLLBACK | return code] 233490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** from the [sqlite3_vtab_on_conflict()] interface. 23357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 23367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DENY 1 /* Abort the SQL statement with an error */ 23377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */ 23387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 23397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2340a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Authorizer Action Codes 23417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 23427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The [sqlite3_set_authorizer()] interface registers a callback function 2343a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that is invoked to authorize certain SQL statement actions. The 23447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** second parameter to the callback is an integer code that specifies 23457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** what action is being authorized. These are the integer action codes that 23467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the authorizer callback may be passed. 23477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2348a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These action code values signify what kind of operation is to be 23497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** authorized. The 3rd and 4th parameters to the authorization 23507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** callback function will be parameters or NULL depending on which of these 2351a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** codes is used as the second parameter. ^(The 5th parameter to the 2352a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** authorizer callback is the name of the database ("main", "temp", 2353a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** etc.) if applicable.)^ ^The 6th parameter to the authorizer callback 23547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is the name of the inner-most trigger or view that is responsible for 2355a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the access attempt or NULL if this access attempt is directly from 23567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** top-level SQL code. 23577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 23587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/******************************************* 3rd ************ 4th ***********/ 23597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */ 23607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */ 23617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */ 23627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */ 23637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */ 23647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */ 23657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */ 23667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_VIEW 8 /* View Name NULL */ 23677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DELETE 9 /* Table Name NULL */ 23687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */ 23697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_TABLE 11 /* Table Name NULL */ 23707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */ 23717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */ 23727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */ 23737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */ 23747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */ 23757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_VIEW 17 /* View Name NULL */ 23767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INSERT 18 /* Table Name NULL */ 23777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */ 23787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_READ 20 /* Table Name Column Name */ 23797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_SELECT 21 /* NULL NULL */ 2380a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TRANSACTION 22 /* Operation NULL */ 23817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_UPDATE 23 /* Table Name Column Name */ 23827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ATTACH 24 /* Filename NULL */ 23837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DETACH 25 /* Database Name NULL */ 23847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */ 23857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_REINDEX 27 /* Index Name NULL */ 23867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ANALYZE 28 /* Table Name NULL */ 23877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */ 23887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */ 2389a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_FUNCTION 31 /* NULL Function Name */ 2390a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */ 23917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_COPY 0 /* No longer used */ 23927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 23937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2394a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Tracing And Profiling Functions 23957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 23967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These routines register callback functions that can be used for 23977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** tracing and profiling the execution of SQL statements. 23987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2399a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The callback function registered by sqlite3_trace() is invoked at 24007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** various times when an SQL statement is being run by [sqlite3_step()]. 2401a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the 2402a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL statement text as the statement first begins executing. 2403a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Additional sqlite3_trace() callbacks might occur 2404a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** as each triggered subprogram is entered. The callbacks for triggers 2405a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** contain a UTF-8 SQL comment that identifies the trigger.)^ 2406a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2407a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The callback function registered by sqlite3_profile() is invoked 2408a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** as each SQL statement finishes. ^The profile callback contains 24097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the original statement text and an estimate of wall-clock time 2410de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** of how long that statement took to run. ^The profile callback 2411de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** time is in units of nanoseconds, however the current implementation 2412de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** is only capable of millisecond resolution so the six least significant 2413de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** digits in the time are meaningless. Future versions of SQLite 2414de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** might provide greater resolution on the profiler callback. The 2415de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** sqlite3_profile() function is considered experimental and is 2416de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** subject to change in future versions of SQLite. 24177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 241871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*); 2419a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API SQLITE_EXPERIMENTAL void *sqlite3_profile(sqlite3*, 24207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void(*xProfile)(void*,const char*,sqlite3_uint64), void*); 24217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 24227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2423a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Query Progress Callbacks 24247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2425de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback 2426de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** function X to be invoked periodically during long running calls to 2427de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [sqlite3_exec()], [sqlite3_step()] and [sqlite3_get_table()] for 2428de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** database connection D. An example use for this 24297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface is to keep a GUI updated during a large query. 24307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2431de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The parameter P is passed through as the only parameter to the 2432de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** callback function X. ^The parameter N is the number of 2433de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [virtual machine instructions] that are evaluated between successive 2434de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** invocations of the callback X. 2435de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 2436de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^Only a single progress handler may be defined at one time per 2437de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [database connection]; setting a new progress handler cancels the 2438de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** old one. ^Setting parameter X to NULL disables the progress handler. 2439de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The progress handler is also disabled by setting N to a value less 2440de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** than 1. 2441de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 2442a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the progress callback returns non-zero, the operation is 24437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interrupted. This feature can be used to implement a 2444a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** "Cancel" button on a GUI progress dialog box. 24457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2446de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The progress handler callback must not do anything that will modify 2447a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the database connection that invoked the progress handler. 2448a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 2449a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database connections for the meaning of "modify" in this paragraph. 24507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 24517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2452a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*); 24537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 24547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2455a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Opening A New Database Connection 2456a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 245790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^These routines open an SQLite database file as specified by the 2458a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** filename argument. ^The filename argument is interpreted as UTF-8 for 2459a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte 2460a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** order for sqlite3_open16(). ^(A [database connection] handle is usually 2461a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned in *ppDb, even if an error occurs. The only exception is that 2462a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** if SQLite is unable to allocate memory to hold the [sqlite3] object, 2463a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a NULL will be written into *ppDb instead of a pointer to the [sqlite3] 2464a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** object.)^ ^(If the database is opened (and/or created) successfully, then 2465a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The 2466a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain 2467a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an English language description of the error following a failure of any 2468a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the sqlite3_open() routines. 2469a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2470a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The default encoding for the database will be UTF-8 if 2471a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_open() or sqlite3_open_v2() is called and 2472a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** UTF-16 in the native byte order if sqlite3_open16() is used. 24737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 24747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Whether or not an error occurs when it is opened, resources 2475a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** associated with the [database connection] handle should be released by 2476a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** passing it to [sqlite3_close()] when it is no longer required. 24777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2478a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_open_v2() interface works like sqlite3_open() 2479a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** except that it accepts two additional parameters for additional control 2480a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** over the new database connection. ^(The flags parameter to 2481a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_open_v2() can take one of 2482a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the following three values, optionally combined with the 2483a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], [SQLITE_OPEN_SHAREDCACHE], 248490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SQLITE_OPEN_PRIVATECACHE], and/or [SQLITE_OPEN_URI] flags:)^ 24857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2486a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dl> 2487a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>[SQLITE_OPEN_READONLY]</dt> 2488a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The database is opened in read-only mode. If the database does not 2489a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** already exist, an error is returned.</dd>)^ 2490a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2491a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>[SQLITE_OPEN_READWRITE]</dt> 2492a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The database is opened for reading and writing if possible, or reading 2493a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** only if the file is write protected by the operating system. In either 2494a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** case the database must already exist, otherwise an error is returned.</dd>)^ 2495a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2496a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt> 249790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd>The database is opened for reading and writing, and is created if 2498a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it does not already exist. This is the behavior that is always used for 2499a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_open() and sqlite3_open16().</dd>)^ 2500a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dl> 2501a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2502a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If the 3rd parameter to sqlite3_open_v2() is not one of the 250390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** combinations shown above optionally combined with other 250490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SQLITE_OPEN_READONLY | SQLITE_OPEN_* bits] 2505a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the behavior is undefined. 25067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2507a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection 2508a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** opens in the multi-thread [threading mode] as long as the single-thread 2509a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** mode has not been set at compile-time or start-time. ^If the 2510a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens 2511a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in the serialized [threading mode] unless single-thread was 2512a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** previously selected at compile-time or start-time. 2513a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [SQLITE_OPEN_SHAREDCACHE] flag causes the database connection to be 2514a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** eligible to use [shared cache mode], regardless of whether or not shared 2515a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** cache is enabled using [sqlite3_enable_shared_cache()]. ^The 2516a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_OPEN_PRIVATECACHE] flag causes the database connection to not 2517a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** participate in [shared cache mode] even if it is enabled. 2518a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 251990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The fourth parameter to sqlite3_open_v2() is the name of the 252090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_vfs] object that defines the operating system interface that 252190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the new database connection should use. ^If the fourth parameter is 252290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** a NULL pointer then the default [sqlite3_vfs] object is used. 252390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 2524a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the filename is ":memory:", then a private, temporary in-memory database 2525a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is created for the connection. ^This in-memory database will vanish when 2526a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the database connection is closed. Future versions of SQLite might 2527a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** make use of additional special filenames that begin with the ":" character. 2528a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** It is recommended that when a database filename actually does begin with 2529a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a ":" character you should prefix the filename with a pathname such as 2530a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** "./" to avoid ambiguity. 2531a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2532a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the filename is an empty string, then a private, temporary 2533a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on-disk database will be created. ^This private database will be 25347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** automatically deleted as soon as the database connection is closed. 25357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 253690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[URI filenames in sqlite3_open()]] <h3>URI Filenames</h3> 253790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 253890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^If [URI filename] interpretation is enabled, and the filename argument 253990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** begins with "file:", then the filename is interpreted as a URI. ^URI 254090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is 254190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** set in the fourth argument to sqlite3_open_v2(), or if it has 254290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** been enabled globally using the [SQLITE_CONFIG_URI] option with the 254390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option. 254490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** As of SQLite version 3.7.7, URI filename interpretation is turned off 254590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** by default, but future releases of SQLite might enable URI filename 254690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** interpretation by default. See "[URI filenames]" for additional 254790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** information. 254890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 254990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** URI filenames are parsed according to RFC 3986. ^If the URI contains an 255090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** authority, then it must be either an empty string or the string 255190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** "localhost". ^If the authority is not an empty string or "localhost", an 255290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** error is returned to the caller. ^The fragment component of a URI, if 255390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** present, is ignored. 255490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 255590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^SQLite uses the path component of the URI as the name of the disk file 255690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** which contains the database. ^If the path begins with a '/' character, 255790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** then it is interpreted as an absolute path. ^If the path does not begin 255890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** with a '/' (meaning that the authority section is omitted from the URI) 255990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** then the path is interpreted as a relative path. 256090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^On windows, the first component of an absolute path 256190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is a drive specification (e.g. "C:"). 256290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 256390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[core URI query parameters]] 256490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The query component of a URI may contain parameters that are interpreted 256590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** either by SQLite itself, or by a [VFS | custom VFS implementation]. 256690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** SQLite interprets the following three query parameters: 256790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 256890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <ul> 256990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <li> <b>vfs</b>: ^The "vfs" parameter may be used to specify the name of 257090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** a VFS object that provides the operating system interface that should 257190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** be used to access the database file on disk. ^If this option is set to 257290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** an empty string the default VFS object is used. ^Specifying an unknown 257390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** VFS is an error. ^If sqlite3_open_v2() is used and the vfs option is 257490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** present, then the VFS specified by the option takes precedence over 257590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the value passed as the fourth parameter to sqlite3_open_v2(). 257690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 257790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw" or 257890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** "rwc". Attempting to set it to any other value is an error)^. 257990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^If "ro" is specified, then the database is opened for read-only 258090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the 258190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** third argument to sqlite3_prepare_v2(). ^If the mode option is set to 258290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** "rw", then the database is opened for read-write (but not create) 258390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had 258490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** been set. ^Value "rwc" is equivalent to setting both 258590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE. ^If sqlite3_open_v2() is 258690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** used, it is an error to specify a value for the mode parameter that is 258790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** less restrictive than that specified by the flags passed as the third 258890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** parameter. 258990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 259090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <li> <b>cache</b>: ^The cache parameter may be set to either "shared" or 259190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** "private". ^Setting it to "shared" is equivalent to setting the 259290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to 259390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** sqlite3_open_v2(). ^Setting the cache parameter to "private" is 259490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit. 259590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^If sqlite3_open_v2() is used and the "cache" parameter is present in 259690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** a URI filename, its value overrides any behaviour requested by setting 259790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** SQLITE_OPEN_PRIVATECACHE or SQLITE_OPEN_SHAREDCACHE flag. 259890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** </ul> 259990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 260090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^Specifying an unknown parameter in the query component of a URI is not an 260190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** error. Future versions of SQLite might understand additional query 260290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** parameters. See "[query parameters with special meaning to SQLite]" for 260390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** additional information. 260490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 260590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[URI filename examples]] <h3>URI filename examples</h3> 260690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 260790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <table border="1" align=center cellpadding=5> 260890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <tr><th> URI filenames <th> Results 260990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <tr><td> file:data.db <td> 261090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Open the file "data.db" in the current directory. 261190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <tr><td> file:/home/fred/data.db<br> 261290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** file:///home/fred/data.db <br> 261390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** file://localhost/home/fred/data.db <br> <td> 261490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Open the database file "/home/fred/data.db". 261590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <tr><td> file://darkstar/home/fred/data.db <td> 261690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** An error. "darkstar" is not a recognized authority. 261790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <tr><td style="white-space:nowrap"> 261890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db 261990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <td> Windows only: Open the file "data.db" on fred's desktop on drive 262090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** C:. Note that the %20 escaping in this example is not strictly 262190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** necessary - space characters can be used literally 262290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** in URI filenames. 262390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <tr><td> file:data.db?mode=ro&cache=private <td> 262490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Open file "data.db" in the current directory for read-only access. 262590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Regardless of whether or not shared-cache mode is enabled by 262690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** default, use a private cache. 262790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <tr><td> file:/home/fred/data.db?vfs=unix-nolock <td> 262890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Open file "/home/fred/data.db". Use the special VFS "unix-nolock". 262990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <tr><td> file:data.db?mode=readonly <td> 263090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** An error. "readonly" is not a valid option for the "mode" parameter. 263190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** </table> 263290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 263390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^URI hexadecimal escape sequences (%HH) are supported within the path and 263490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** query components of a URI. A hexadecimal escape sequence consists of a 263590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** percent sign - "%" - followed by exactly two hexadecimal digits 263690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** specifying an octet value. ^Before the path or query components of a 263790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** URI filename are interpreted, they are encoded using UTF-8 and all 263890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** hexadecimal escape sequences replaced by a single byte containing the 263990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** corresponding octet. If this process generates an invalid UTF-8 encoding, 264090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the results are undefined. 26417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2642a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <b>Note to Windows users:</b> The encoding used for the filename argument 2643a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever 26447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** codepage is currently defined. Filenames containing international 26457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** characters must be converted to UTF-8 prior to passing them into 2646a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_open() or sqlite3_open_v2(). 26477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2648a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_open( 26497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *filename, /* Database filename (UTF-8) */ 26507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 **ppDb /* OUT: SQLite db handle */ 26517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 2652a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_open16( 26537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void *filename, /* Database filename (UTF-16) */ 26547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 **ppDb /* OUT: SQLite db handle */ 26557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 2656a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_open_v2( 26577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *filename, /* Database filename (UTF-8) */ 26587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 **ppDb, /* OUT: SQLite db handle */ 26597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int flags, /* Flags */ 26607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zVfs /* Name of VFS module to use */ 26617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 26627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 26637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 266490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CAPI3REF: Obtain Values For URI Parameters 266590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 266690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** These are utility routines, useful to VFS implementations, that check 266790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** to see if a database file was a URI that contained a specific query 266890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** parameter, and if so obtains the value of that query parameter. 266990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 267090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** If F is the database filename pointer passed into the xOpen() method of 267190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** a VFS implementation when the flags parameter to xOpen() has one or 267290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** more of the [SQLITE_OPEN_URI] or [SQLITE_OPEN_MAIN_DB] bits set and 267390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** P is the name of the query parameter, then 267490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** sqlite3_uri_parameter(F,P) returns the value of the P 267590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** parameter if it exists or a NULL pointer if P does not appear as a 267690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** query parameter on F. If P is a query parameter of F 267790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** has no explicit value, then sqlite3_uri_parameter(F,P) returns 267890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** a pointer to an empty string. 267990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 268090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean 268190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** parameter and returns true (1) or false (0) according to the value 2682c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** of P. The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the 2683c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** value of query parameter P is one of "yes", "true", or "on" in any 2684c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** case or if the value begins with a non-zero number. The 2685c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of 2686c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** query parameter P is one of "no", "false", or "off" in any case or 2687c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** if the value begins with a numeric zero. If P is not a query 2688c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** parameter on F or if the value of P is does not match any of the 2689c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** above, then sqlite3_uri_boolean(F,P,B) returns (B!=0). 269090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 269190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a 269290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 64-bit signed integer and returns that integer, or D if P does not 269390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** exist. If the value of P is something other than an integer, then 269490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** zero is returned. 269590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 269690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and 269790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** sqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and 269890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is not a database file pathname pointer that SQLite passed into the xOpen 269990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** VFS method, then the behavior of this routine is undefined and probably 270090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** undesirable. 270190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 270290ed05d921d6ed7f12012d9786d53f57fafee51aJeff BrownSQLITE_API const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam); 270390ed05d921d6ed7f12012d9786d53f57fafee51aJeff BrownSQLITE_API int sqlite3_uri_boolean(const char *zFile, const char *zParam, int bDefault); 270490ed05d921d6ed7f12012d9786d53f57fafee51aJeff BrownSQLITE_API sqlite3_int64 sqlite3_uri_int64(const char*, const char*, sqlite3_int64); 270590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 270690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 270790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 2708a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Error Codes And Messages 2709a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2710a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_errcode() interface returns the numeric [result code] or 2711a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [extended result code] for the most recent failed sqlite3_* API call 2712a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** associated with a [database connection]. If a prior API call failed 2713a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** but the most recent API call succeeded, the return value from 2714a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_errcode() is undefined. ^The sqlite3_extended_errcode() 2715a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interface is the same except that it always returns the 2716a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [extended result code] even when extended result codes are 2717a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** disabled. 2718a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2719a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language 2720a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** text that describes the error, as either UTF-8 or UTF-16 respectively. 2721a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Memory to hold the error message string is managed internally. 2722a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The application does not need to worry about freeing the result. 27237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** However, the error string might be overwritten or deallocated by 2724a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** subsequent calls to other SQLite interface functions.)^ 2725a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2726a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When the serialized [threading mode] is in use, it might be the 2727a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** case that a second error occurs on a separate thread in between 2728a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the time of the first error and the call to these interfaces. 2729a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When that happens, the second error will be reported since these 2730a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces always report the most recent result. To avoid 2731a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** this, each thread can obtain exclusive use of the [database connection] D 2732a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning 2733a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after 2734a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** all calls to the interfaces listed here are completed. 2735a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2736a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If an interface fails with SQLITE_MISUSE, that means the interface 2737a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** was invoked incorrectly by the application. In that case, the 2738a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** error code and message may or may not be set. 27397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2740a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_errcode(sqlite3 *db); 2741a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_extended_errcode(sqlite3 *db); 2742a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const char *sqlite3_errmsg(sqlite3*); 2743a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_errmsg16(sqlite3*); 27447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 27457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2746a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: SQL Statement Object 27477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** KEYWORDS: {prepared statement} {prepared statements} 27487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2749a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** An instance of this object represents a single SQL statement. 2750a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This object is variously known as a "prepared statement" or a 27517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** "compiled SQL statement" or simply as a "statement". 2752a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 27537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The life of a statement object goes something like this: 27547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 27557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ol> 27567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> Create the object using [sqlite3_prepare_v2()] or a related 27577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** function. 2758a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> Bind values to [host parameters] using the sqlite3_bind_*() 2759a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces. 27607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> Run the SQL by calling [sqlite3_step()] one or more times. 27617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> Reset the statement using [sqlite3_reset()] then go back 27627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to step 2. Do this zero or more times. 27637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> Destroy the object using [sqlite3_finalize()]. 27647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </ol> 27657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 27667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Refer to documentation on individual methods above for additional 27677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** information. 27687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 27697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_stmt sqlite3_stmt; 27707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 27717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2772a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Run-time Limits 27737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2774a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This interface allows the size of various constructs to be limited 27757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** on a connection by connection basis. The first parameter is the 27767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [database connection] whose limit is to be set or queried. The 27777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** second parameter is one of the [limit categories] that define a 27787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** class of constructs to be size limited. The third parameter is the 2779de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** new limit for that construct.)^ 2780a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2781a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the new limit is a negative number, the limit is unchanged. 2782de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a 2783a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [limits | hard upper bound] 2784de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** set at compile-time by a C preprocessor macro called 2785de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [limits | SQLITE_MAX_<i>NAME</i>]. 2786a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (The "_LIMIT_" in the name is changed to "_MAX_".))^ 2787a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Attempts to increase a limit above its hard upper bound are 2788a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** silently truncated to the hard upper bound. 2789a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2790de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^Regardless of whether or not the limit was changed, the 2791de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [sqlite3_limit()] interface returns the prior value of the limit. 2792de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^Hence, to find the current value of a limit without changing it, 2793de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** simply invoke this interface with the third parameter set to -1. 2794de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 2795a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Run-time limits are intended for use in applications that manage 27967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** both their own internal database and also databases that are controlled 27977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** by untrusted external sources. An example application might be a 2798a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** web browser that has its own databases for storing history and 2799a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** separate databases controlled by JavaScript applications downloaded 2800a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** off the Internet. The internal databases can be given the 28017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** large, default limits. Databases managed by external sources can 28027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** be given much smaller limits designed to prevent a denial of service 2803a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** attack. Developers might also want to use the [sqlite3_set_authorizer()] 28047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface to further control untrusted SQL. The size of the database 28057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** created by an untrusted script can be contained using the 28067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [max_page_count] [PRAGMA]. 28077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2808a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** New run-time limit categories may be added in future releases. 28097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2810a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal); 28117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 28127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2813a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Run-Time Limit Categories 2814a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {limit category} {*limit categories} 2815a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2816a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These constants define various performance limits 2817a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that can be lowered at run-time using [sqlite3_limit()]. 2818a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The synopsis of the meanings of the various limits is shown below. 2819a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Additional information is available at [limits | Limits in SQLite]. 28207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 28217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <dl> 282290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_LIMIT_LENGTH]] ^(<dt>SQLITE_LIMIT_LENGTH</dt> 2823de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^ 28247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 282590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_LIMIT_SQL_LENGTH]] ^(<dt>SQLITE_LIMIT_SQL_LENGTH</dt> 2826a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The maximum length of an SQL statement, in bytes.</dd>)^ 28277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 282890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_LIMIT_COLUMN]] ^(<dt>SQLITE_LIMIT_COLUMN</dt> 28297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <dd>The maximum number of columns in a table definition or in the 2830a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** result set of a [SELECT] or the maximum number of columns in an index 2831a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or in an ORDER BY or GROUP BY clause.</dd>)^ 28327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 283390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_LIMIT_EXPR_DEPTH]] ^(<dt>SQLITE_LIMIT_EXPR_DEPTH</dt> 2834a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The maximum depth of the parse tree on any expression.</dd>)^ 28357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 283690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_LIMIT_COMPOUND_SELECT]] ^(<dt>SQLITE_LIMIT_COMPOUND_SELECT</dt> 2837a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^ 28387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 283990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_LIMIT_VDBE_OP]] ^(<dt>SQLITE_LIMIT_VDBE_OP</dt> 28407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <dd>The maximum number of instructions in a virtual machine program 2841de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** used to implement an SQL statement. This limit is not currently 2842de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** enforced, though that might be added in some future release of 2843de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** SQLite.</dd>)^ 28447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 284590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_LIMIT_FUNCTION_ARG]] ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt> 2846a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The maximum number of arguments on a function.</dd>)^ 28477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 284890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_LIMIT_ATTACHED]] ^(<dt>SQLITE_LIMIT_ATTACHED</dt> 2849a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The maximum number of [ATTACH | attached databases].)^</dd> 28507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 285190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]] 2852a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt> 2853a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The maximum length of the pattern argument to the [LIKE] or 2854a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [GLOB] operators.</dd>)^ 28557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 285690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_LIMIT_VARIABLE_NUMBER]] 2857a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt> 2858de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <dd>The maximum index number of any [parameter] in an SQL statement.)^ 2859a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 286090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_LIMIT_TRIGGER_DEPTH]] ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt> 2861a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>The maximum depth of recursion for triggers.</dd>)^ 28627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </dl> 28637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 28647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_LENGTH 0 28657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_SQL_LENGTH 1 28667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_COLUMN 2 28677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_EXPR_DEPTH 3 28687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_COMPOUND_SELECT 4 28697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_VDBE_OP 5 28707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_FUNCTION_ARG 6 28717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_ATTACHED 7 28727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8 28737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_LIMIT_VARIABLE_NUMBER 9 2874a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_LIMIT_TRIGGER_DEPTH 10 28757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 28767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2877a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Compiling An SQL Statement 2878a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {SQL statement compiler} 28797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 28807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** To execute an SQL query, it must first be compiled into a byte-code 2881a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** program using one of these routines. 28827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2883a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The first argument, "db", is a [database connection] obtained from a 2884a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or 2885a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_open16()]. The database connection must not have been closed. 2886a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2887a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The second argument, "zSql", is the statement to be compiled, encoded 28887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2() 2889a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2() 2890a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** use UTF-16. 2891a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2892a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the nByte argument is less than zero, then zSql is read up to the 2893a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** first zero terminator. ^If nByte is non-negative, then it is the maximum 2894a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** number of bytes read from zSql. ^When nByte is non-negative, the 2895a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** zSql string ends at either the first '\000' or '\u0000' character or 28967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the nByte-th byte, whichever comes first. If the caller knows 28977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** that the supplied string is nul-terminated, then there is a small 2898a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** performance advantage to be gained by passing an nByte parameter that 2899a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is equal to the number of bytes in the input string <i>including</i> 290090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the nul-terminator bytes as this saves SQLite from having to 290190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** make a copy of the input string. 2902a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2903a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If pzTail is not NULL then *pzTail is made to point to the first byte 2904a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** past the end of the first SQL statement in zSql. These routines only 2905a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** compile the first statement in zSql, so *pzTail is left pointing to 2906a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** what remains uncompiled. 2907a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2908a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^*ppStmt is left pointing to a compiled [prepared statement] that can be 2909a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set 2910a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to NULL. ^If the input text contains no SQL (if the input is an empty 2911a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** string or a comment) then *ppStmt is set to NULL. 2912a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The calling procedure is responsible for deleting the compiled 2913a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL statement using [sqlite3_finalize()] after it has finished with it. 2914a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ppStmt may not be NULL. 2915a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 2916a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK]; 2917a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** otherwise an [error code] is returned. 29187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 29197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are 29207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** recommended for all new programs. The two older interfaces are retained 29217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for backwards compatibility, but their use is discouraged. 2922a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^In the "v2" interfaces, the prepared statement 2923a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that is returned (the [sqlite3_stmt] object) contains a copy of the 2924a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** original SQL text. This causes the [sqlite3_step()] interface to 2925a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** behave differently in three ways: 29267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 29277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ol> 29287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> 2929a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it 29307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** always used to do, [sqlite3_step()] will automatically recompile the SQL 2931de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** statement and try to run it again. 29327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </li> 29337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 29347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> 2935a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^When an error occurs, [sqlite3_step()] will return one of the detailed 2936a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [error codes] or [extended error codes]. ^The legacy behavior was that 2937a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code 2938a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and the application would have to make a second call to [sqlite3_reset()] 2939a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in order to find the underlying cause of the problem. With the "v2" prepare 2940a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces, the underlying reason for the error is returned immediately. 29417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </li> 29427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2943a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> 2944de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^If the specific value bound to [parameter | host parameter] in the 2945de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** WHERE clause might influence the choice of query plan for a statement, 2946de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** then the statement will be automatically recompiled, as if there had been 2947de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** a schema change, on the first [sqlite3_step()] call following any change 2948de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** to the [sqlite3_bind_text | bindings] of that [parameter]. 2949de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The specific value of WHERE-clause [parameter] might influence the 2950de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** choice of query plan if the parameter is the left-hand side of a [LIKE] 2951de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** or [GLOB] operator or if the parameter is compared to an indexed column 295290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** and the [SQLITE_ENABLE_STAT3] compile-time option is enabled. 2953de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the 2954a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </li> 2955a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ol> 29567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2957a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_prepare( 29587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Database handle */ 29597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zSql, /* SQL statement, UTF-8 encoded */ 29607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nByte, /* Maximum length of zSql in bytes. */ 29617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 29627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char **pzTail /* OUT: Pointer to unused portion of zSql */ 29637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 2964a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_prepare_v2( 29657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Database handle */ 29667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zSql, /* SQL statement, UTF-8 encoded */ 29677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nByte, /* Maximum length of zSql in bytes. */ 29687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 29697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char **pzTail /* OUT: Pointer to unused portion of zSql */ 29707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 2971a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_prepare16( 29727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Database handle */ 29737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void *zSql, /* SQL statement, UTF-16 encoded */ 29747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nByte, /* Maximum length of zSql in bytes. */ 29757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 29767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void **pzTail /* OUT: Pointer to unused portion of zSql */ 29777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 2978a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_prepare16_v2( 29797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Database handle */ 29807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void *zSql, /* SQL statement, UTF-16 encoded */ 29817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nByte, /* Maximum length of zSql in bytes. */ 29827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 29837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void **pzTail /* OUT: Pointer to unused portion of zSql */ 29847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 29857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 29867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 2987a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Retrieving Statement SQL 29887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2989a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This interface can be used to retrieve a saved copy of the original 2990a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL text used to create a [prepared statement] if that statement was 2991a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** compiled using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()]. 29927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 2993a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt); 29947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 29957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 299695c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** CAPI3REF: Determine If An SQL Statement Writes The Database 299795c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** 299895c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if 299990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** and only if the [prepared statement] X makes no direct changes to 300090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the content of the database file. 300190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 300290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Note that [application-defined SQL functions] or 300390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [virtual tables] might change the database indirectly as a side effect. 300490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^(For example, if an application defines a function "eval()" that 300590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** calls [sqlite3_exec()], then the following SQL statement would 300690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** change the database file through side-effects: 300790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 300890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <blockquote><pre> 300990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** SELECT eval('DELETE FROM t1') FROM t2; 301090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** </pre></blockquote> 301190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 301290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** But because the [SELECT] statement does not change the database file 301390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** directly, sqlite3_stmt_readonly() would still return true.)^ 301490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 301590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK], 301690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true, 301790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** since the statements themselves do not actually modify the database but 301890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** rather they control the timing of when other statements modify the 301990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** database. ^The [ATTACH] and [DETACH] statements also cause 302090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** sqlite3_stmt_readonly() to return true since, while those statements 302190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** change the configuration of a database connection, they do not make 302290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** changes to the content of the database files on disk. 302395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori*/ 302495c34edce550d0869113085e0cd1b6b09e8fe38bVasu NoriSQLITE_API int sqlite3_stmt_readonly(sqlite3_stmt *pStmt); 302595c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori 302695c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori/* 302790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CAPI3REF: Determine If A Prepared Statement Has Been Reset 302890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 302990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The sqlite3_stmt_busy(S) interface returns true (non-zero) if the 303090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [prepared statement] S has been stepped at least once using 303190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_step(S)] but has not run to completion and/or has not 303290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** been reset using [sqlite3_reset(S)]. ^The sqlite3_stmt_busy(S) 303390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** interface returns false if S is a NULL pointer. If S is not a 303490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** NULL pointer and is not a pointer to a valid [prepared statement] 303590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** object, then the behavior is undefined and probably undesirable. 303690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 303790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** This interface can be used in combination [sqlite3_next_stmt()] 303890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** to locate all prepared statements associated with a database 303990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** connection that are in need of being reset. This can be used, 304090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** for example, in diagnostic routines to search for prepared 304190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** statements that are holding a transaction open. 304290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 304390ed05d921d6ed7f12012d9786d53f57fafee51aJeff BrownSQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*); 304490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 304590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 3046a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Dynamically Typed Value Object 30477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value} 30487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 30497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLite uses the sqlite3_value object to represent all values 3050a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that can be stored in a database table. SQLite uses dynamic typing 3051a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for the values it stores. ^Values stored in sqlite3_value objects 3052a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can be integers, floating point values, strings, BLOBs, or NULL. 30537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 30547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** An sqlite3_value object may be either "protected" or "unprotected". 30557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Some interfaces require a protected sqlite3_value. Other interfaces 30567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** will accept either a protected or an unprotected sqlite3_value. 3057a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Every interface that accepts sqlite3_value arguments specifies 30587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** whether or not it requires a protected sqlite3_value. 30597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 30607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The terms "protected" and "unprotected" refer to whether or not 306190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** a mutex is held. An internal mutex is held for a protected 30627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_value object but no mutex is held for an unprotected 30637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_value object. If SQLite is compiled to be single-threaded 3064a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0) 3065a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or if SQLite is run in one of reduced mutex modes 3066a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD] 3067a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then there is no distinction between protected and unprotected 3068a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_value objects and they can be used interchangeably. However, 3069a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for maximum code portability it is recommended that applications 3070de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** still make the distinction between protected and unprotected 3071a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_value objects even when not strictly required. 3072a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3073a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_value objects that are passed as parameters into the 3074a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation of [application-defined SQL functions] are protected. 3075a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_value object returned by 30767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_column_value()] is unprotected. 30777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Unprotected sqlite3_value objects may only be used with 3078a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_result_value()] and [sqlite3_bind_value()]. 3079a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [sqlite3_value_blob | sqlite3_value_type()] family of 3080a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces require protected sqlite3_value objects. 30817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 30827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct Mem sqlite3_value; 30837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 30847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3085a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: SQL Function Context Object 30867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 30877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The context in which an SQL function executes is stored in an 3088a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_context object. ^A pointer to an sqlite3_context object 3089a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is always first parameter to [application-defined SQL functions]. 3090a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The application-defined SQL function implementation will pass this 3091a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pointer through into calls to [sqlite3_result_int | sqlite3_result()], 3092a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_aggregate_context()], [sqlite3_user_data()], 3093a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()], 3094a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and/or [sqlite3_set_auxdata()]. 30957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 30967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_context sqlite3_context; 30977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 30987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3099a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Binding Values To Prepared Statements 3100a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {host parameter} {host parameters} {host parameter name} 3101a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding} 31027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3103a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants, 3104a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** literals may be replaced by a [parameter] that matches one of following 3105a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** templates: 31067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 31077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 31087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> ? 31097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> ?NNN 31107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> :VVV 31117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> @VVV 31127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> $VVV 31137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </ul> 31147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3115a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** In the templates above, NNN represents an integer literal, 3116de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** and VVV represents an alphanumeric identifier.)^ ^The values of these 3117a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameters (also called "host parameter names" or "SQL parameters") 31187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** can be set using the sqlite3_bind_*() routines defined here. 31197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3120a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first argument to the sqlite3_bind_*() routines is always 3121a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a pointer to the [sqlite3_stmt] object returned from 3122a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_prepare_v2()] or its variants. 3123a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3124a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The second argument is the index of the SQL parameter to be set. 3125a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The leftmost SQL parameter has an index of 1. ^When the same named 3126a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL parameter is used more than once, second and subsequent 3127a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** occurrences have the same index as the first occurrence. 3128a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The index for named parameters can be looked up using the 3129a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_bind_parameter_index()] API if desired. ^The index 31307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for "?NNN" parameters is the value of NNN. 3131a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The NNN value must be between 1 and the [sqlite3_limit()] 3132a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999). 31337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3134a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The third argument is the value to bind to the parameter. 31357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3136a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(In those routines that have a fourth argument, its value is the 3137a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** number of bytes in the parameter. To be clear: the value is the 3138a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** number of <u>bytes</u> in the value, not the number of characters.)^ 3139a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the fourth parameter is negative, the length of the string is 3140a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the number of bytes up to the first zero terminator. 314190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** If a non-negative fourth parameter is provided to sqlite3_bind_text() 314290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** or sqlite3_bind_text16() then that parameter must be the byte offset 314390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** where the NUL terminator would occur assuming the string were NUL 314490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** terminated. If any NUL characters occur at byte offsets less than 314590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the value of the fourth parameter then the resulting string value will 314690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** contain embedded NULs. The result of expressions involving strings 314790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** with embedded NULs is undefined. 31487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3149a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and 31507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or 315195c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** string after SQLite has finished with it. ^The destructor is called 315295c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** to dispose of the BLOB or string even if the call to sqlite3_bind_blob(), 315395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** sqlite3_bind_text(), or sqlite3_bind_text16() fails. 315495c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^If the fifth argument is 31557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the special value [SQLITE_STATIC], then SQLite assumes that the 31567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** information is in static, unmanaged space and does not need to be freed. 3157a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the fifth argument has the value [SQLITE_TRANSIENT], then 31587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLite makes its own private copy of the data immediately, before 31597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the sqlite3_bind_*() routine returns. 31607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3161a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that 3162a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is filled with zeroes. ^A zeroblob uses a fixed amount of memory 3163a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (just an integer to hold its size) while it is being processed. 3164a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Zeroblobs are intended to serve as placeholders for BLOBs whose 3165a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** content is later written using 3166a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_blob_open | incremental BLOB I/O] routines. 3167a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A negative value for the zeroblob results in a zero-length BLOB. 3168a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3169a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer 3170a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for the [prepared statement] or with a prepared statement for which 3171a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_step()] has been called more recently than [sqlite3_reset()], 3172a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_() 3173a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routine is passed a [prepared statement] that has been finalized, the 3174a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** result is undefined and probably harmful. 3175a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3176a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Bindings are not cleared by the [sqlite3_reset()] routine. 3177a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Unbound parameters are interpreted as NULL. 3178a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3179a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an 3180a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [error code] if anything goes wrong. 3181a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^[SQLITE_RANGE] is returned if the parameter 3182a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails. 31837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 31847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** See also: [sqlite3_bind_parameter_count()], 3185a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()]. 3186a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 3187a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*)); 3188a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_bind_double(sqlite3_stmt*, int, double); 3189a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int); 3190a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64); 3191a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_bind_null(sqlite3_stmt*, int); 3192a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*)); 3193a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*)); 3194a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*); 3195a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n); 3196a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 3197a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 3198a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Number Of SQL Parameters 31997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3200a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This routine can be used to find the number of [SQL parameters] 3201a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in a [prepared statement]. SQL parameters are tokens of the 32027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as 3203a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** placeholders for values that are [sqlite3_bind_blob | bound] 32047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to the parameters at a later time. 32057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3206a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This routine actually returns the index of the largest (rightmost) 3207a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter. For all forms except ?NNN, this will correspond to the 3208a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** number of unique parameters. If parameters of the ?NNN form are used, 3209a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** there may be gaps in the list.)^ 32107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 32117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** See also: [sqlite3_bind_blob|sqlite3_bind()], 32127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_bind_parameter_name()], and 32137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_bind_parameter_index()]. 32147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3215a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt*); 32167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 32177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3218a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Name Of A Host Parameter 32197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3220a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_bind_parameter_name(P,N) interface returns 3221a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the name of the N-th [SQL parameter] in the [prepared statement] P. 3222a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA" 32237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA" 32247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** respectively. 32257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** In other words, the initial ":" or "$" or "@" or "?" 3226a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is included as part of the name.)^ 3227a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Parameters of the form "?" without a following integer have no name 3228a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and are referred to as "nameless" or "anonymous parameters". 32297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3230a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first host parameter has an index of 1, not 0. 32317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3232a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the value N is out of range or if the N-th parameter is 3233a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** nameless, then NULL is returned. ^The returned string is 3234a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** always in UTF-8 encoding even if the named parameter was 32357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** originally specified as UTF-16 in [sqlite3_prepare16()] or 32367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_prepare16_v2()]. 32377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 32387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** See also: [sqlite3_bind_blob|sqlite3_bind()], 32397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_bind_parameter_count()], and 32407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_bind_parameter_index()]. 32417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3242a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int); 32437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 32447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3245a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Index Of A Parameter With A Given Name 32467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3247a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Return the index of an SQL parameter given its name. ^The 32487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** index value returned is suitable for use as the second 3249a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter to [sqlite3_bind_blob|sqlite3_bind()]. ^A zero 3250a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is returned if no matching parameter is found. ^The parameter 32517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** name must be given in UTF-8 even if the original statement 32527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** was prepared from UTF-16 text using [sqlite3_prepare16_v2()]. 32537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 32547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** See also: [sqlite3_bind_blob|sqlite3_bind()], 32557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_bind_parameter_count()], and 32567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_bind_parameter_index()]. 32577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3258a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName); 32597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 32607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3261a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Reset All Bindings On A Prepared Statement 32627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3263a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset 3264a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [sqlite3_bind_blob | bindings] on a [prepared statement]. 3265a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Use this routine to reset all host parameters to NULL. 32667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3267a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*); 32687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 32697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3270a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Number Of Columns In A Result Set 32717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3272a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Return the number of columns in the result set returned by the 3273a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [prepared statement]. ^This routine returns 0 if pStmt is an SQL 3274a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** statement that does not return data (for example an [UPDATE]). 3275de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 3276de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** See also: [sqlite3_data_count()] 32777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3278a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt); 32797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 32807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3281a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Column Names In A Result Set 32827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3283a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines return the name assigned to a particular column 3284a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in the result set of a [SELECT] statement. ^The sqlite3_column_name() 3285a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interface returns a pointer to a zero-terminated UTF-8 string 32867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and sqlite3_column_name16() returns a pointer to a zero-terminated 3287a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** UTF-16 string. ^The first parameter is the [prepared statement] 3288a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that implements the [SELECT] statement. ^The second parameter is the 3289a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** column number. ^The leftmost column is number 0. 32907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3291a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The returned string pointer is valid until either the [prepared statement] 329290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is destroyed by [sqlite3_finalize()] or until the statement is automatically 329390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** reprepared by the first call to [sqlite3_step()] for a particular run 329490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** or until the next call to 3295a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_name() or sqlite3_column_name16() on the same column. 32967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3297a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_malloc() fails during the processing of either routine 32987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** (for example during a conversion from UTF-8 to UTF-16) then a 32997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** NULL pointer is returned. 33007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3301a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The name of a result column is the value of the "AS" clause for 33027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** that column, if there is an AS clause. If there is no AS clause 33037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** then the name of the column is unspecified and may change from 33047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** one release of SQLite to the next. 33057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3306a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const char *sqlite3_column_name(sqlite3_stmt*, int N); 3307a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_column_name16(sqlite3_stmt*, int N); 33087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 33097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3310a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Source Of Data In A Query Result 33117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3312a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines provide a means to determine the database, table, and 3313a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** table column that is the origin of a particular result column in 3314a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SELECT] statement. 3315a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The name of the database or table or column can be returned as 3316a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** either a UTF-8 or UTF-16 string. ^The _database_ routines return 33177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the database name, the _table_ routines return the table name, and 33187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the origin_ routines return the column name. 3319a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The returned string is valid until the [prepared statement] is destroyed 332090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** using [sqlite3_finalize()] or until the statement is automatically 332190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** reprepared by the first call to [sqlite3_step()] for a particular run 332290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** or until the same information is requested 33237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** again in a different encoding. 33247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3325a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The names returned are the original un-aliased names of the 33267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** database, table, and column. 33277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3328a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first argument to these interfaces is a [prepared statement]. 3329a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These functions return information about the Nth result column returned by 33307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the statement, where N is the second function argument. 3331a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The left-most column is column 0 for these routines. 33327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3333a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the Nth column returned by the statement is an expression or 3334a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** subquery and is not a column value, then all of these functions return 3335a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** NULL. ^These routine might also return NULL if a memory allocation error 3336a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** occurs. ^Otherwise, they return the name of the attached database, table, 3337a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or column that query result column was extracted from. 33387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3339a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^As with all other SQLite APIs, those whose names end with "16" return 3340a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** UTF-16 encoded strings and the other functions return UTF-8. 33417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3342a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These APIs are only available if the library was compiled with the 3343a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol. 33447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 33457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If two or more threads call one or more of these routines against the same 33467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** prepared statement and column at the same time then the results are 33477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** undefined. 33487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3349a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If two or more threads call one or more 3350a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_column_database_name | column metadata interfaces] 3351a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for the same [prepared statement] and result column 3352a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** at the same time then the results are undefined. 3353a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 3354a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const char *sqlite3_column_database_name(sqlite3_stmt*,int); 3355a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_column_database_name16(sqlite3_stmt*,int); 3356a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const char *sqlite3_column_table_name(sqlite3_stmt*,int); 3357a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_column_table_name16(sqlite3_stmt*,int); 3358a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const char *sqlite3_column_origin_name(sqlite3_stmt*,int); 3359a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_column_origin_name16(sqlite3_stmt*,int); 3360a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 3361a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 3362a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Declared Datatype Of A Query Result 3363a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3364a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The first parameter is a [prepared statement]. 3365a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If this statement is a [SELECT] statement and the Nth column of the 3366a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned result set of that [SELECT] is a table column (not an 33677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** expression or subquery) then the declared type of the table 3368a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** column is returned.)^ ^If the Nth column of the result set is an 33697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** expression or subquery, then a NULL pointer is returned. 3370a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The returned string is always UTF-8 encoded. 3371a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3372a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(For example, given the database schema: 33737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 33747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** CREATE TABLE t1(c1 VARIANT); 33757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3376a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and the following statement to be compiled: 33777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 33787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SELECT c1 + 1, c1 FROM t1; 33797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3380a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** this routine would return the string "VARIANT" for the second result 3381a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** column (i==1), and a NULL pointer for the first result column (i==0).)^ 33827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3383a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite uses dynamic run-time typing. ^So just because a column 33847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is declared to contain a particular type does not mean that the 33857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** data stored in that column is of the declared type. SQLite is 3386a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** strongly typed, but the typing is dynamic not static. ^Type 33877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is associated with individual values, not with the containers 33887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** used to hold those values. 3389a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 3390a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const char *sqlite3_column_decltype(sqlite3_stmt*,int); 3391a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_column_decltype16(sqlite3_stmt*,int); 3392a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 3393a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 3394a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Evaluate An SQL Statement 3395a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3396a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** After a [prepared statement] has been prepared using either 3397a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy 3398a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function 3399a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** must be called one or more times to evaluate the statement. 34007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3401a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The details of the behavior of the sqlite3_step() interface depend 34027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** on whether the statement was prepared using the newer "v2" interface 34037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy 34047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the 34057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** new "v2" interface is recommended for new applications but the legacy 34067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface will continue to be supported. 34077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3408a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^In the legacy interface, the return value will be either [SQLITE_BUSY], 34097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE]. 3410a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^With the "v2" interface, any of the other [result codes] or 3411a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [extended result codes] might be returned as well. 34127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3413a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^[SQLITE_BUSY] means that the database engine was unable to acquire the 3414a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database locks it needs to do its job. ^If the statement is a [COMMIT] 34157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or occurs outside of an explicit transaction, then you can retry the 341690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** statement. If the statement is not a [COMMIT] and occurs within an 34177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** explicit transaction then you should rollback the transaction before 34187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** continuing. 34197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3420a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^[SQLITE_DONE] means that the statement has finished executing 34217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** successfully. sqlite3_step() should not be called again on this virtual 34227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** machine without first calling [sqlite3_reset()] to reset the virtual 34237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** machine back to its initial state. 34247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3425a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the SQL statement being executed returns any data, then [SQLITE_ROW] 3426a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is returned each time a new row of data is ready for processing by the 3427a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** caller. The values may be accessed using the [column access functions]. 34287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_step() is called again to retrieve the next row of data. 3429a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3430a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^[SQLITE_ERROR] means that a run-time error (such as a constraint 34317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** violation) has occurred. sqlite3_step() should not be called again on 34327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the VM. More information may be found by calling [sqlite3_errmsg()]. 3433a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^With the legacy interface, a more specific error code (for example, 34347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth) 34357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** can be obtained by calling [sqlite3_reset()] on the 3436a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [prepared statement]. ^In the "v2" interface, 34377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the more specific error code is returned directly by sqlite3_step(). 34387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 34397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_MISUSE] means that the this routine was called inappropriately. 34407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Perhaps it was called on a [prepared statement] that has 3441a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** already been [sqlite3_finalize | finalized] or on one that had 34427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could 34437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** be the case that the same database connection is being used by two or 34447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** more threads at the same moment in time. 34457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 344690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** For all versions of SQLite up to and including 3.6.23.1, a call to 344790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_reset()] was required after sqlite3_step() returned anything 344890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** other than [SQLITE_ROW] before any subsequent invocation of 344990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** sqlite3_step(). Failure to reset the prepared statement using 345090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from 345190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** sqlite3_step(). But after version 3.6.23.1, sqlite3_step() began 345290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** calling [sqlite3_reset()] automatically in this circumstance rather 345390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** than returning [SQLITE_MISUSE]. This is not considered a compatibility 345490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** break because any application that ever receives an SQLITE_MISUSE error 345590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is broken by definition. The [SQLITE_OMIT_AUTORESET] compile-time option 345690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** can be used to restore the legacy behavior. 345771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 3458a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step() 3459a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** API always returns a generic error code, [SQLITE_ERROR], following any 3460a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call 3461a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the 3462a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** specific [error codes] that better describes the error. 34637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** We admit that this is a goofy design. The problem has been fixed 34647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** with the "v2" interface. If you prepare all of your SQL statements 34657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead 3466a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces, 3467a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the more specific [error codes] are returned directly 34687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** by sqlite3_step(). The use of the "v2" interface is recommended. 34697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3470a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_step(sqlite3_stmt*); 34717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 34727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3473a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Number of columns in a result set 34747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3475de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The sqlite3_data_count(P) interface returns the number of columns in the 3476de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** current row of the result set of [prepared statement] P. 3477de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^If prepared statement P does not have results ready to return 3478de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** (via calls to the [sqlite3_column_int | sqlite3_column_*()] of 3479de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** interfaces) then sqlite3_data_count(P) returns 0. 3480de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer. 348190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The sqlite3_data_count(P) routine returns 0 if the previous call to 348290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_step](P) returned [SQLITE_DONE]. ^The sqlite3_data_count(P) 348390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** will return non-zero if previous call to [sqlite3_step](P) returned 348490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SQLITE_ROW], except in the case of the [PRAGMA incremental_vacuum] 348590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** where it always returns zero since each step of that multi-step 348690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** pragma returns 0 columns of data. 3487de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 3488de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** See also: [sqlite3_column_count()] 34897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3490a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt); 34917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 34927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3493a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Fundamental Datatypes 34947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** KEYWORDS: SQLITE_TEXT 34957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3496a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Every value in SQLite has one of five fundamental datatypes: 34977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 34987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 34997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> 64-bit signed integer 35007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> 64-bit IEEE floating point number 35017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> string 35027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> BLOB 35037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> NULL 3504a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ul>)^ 35057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 35067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These constants are codes for each of those types. 35077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 35087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Note that the SQLITE_TEXT constant was also used in SQLite version 2 35097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for a completely different meaning. Software that links against both 3510a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not 35117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLITE_TEXT. 35127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 35137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INTEGER 1 35147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_FLOAT 2 35157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_BLOB 4 35167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_NULL 5 35177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#ifdef SQLITE_TEXT 35187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project# undef SQLITE_TEXT 35197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#else 35207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project# define SQLITE_TEXT 3 35217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#endif 35227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE3_TEXT 3 35237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 35247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3525a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Result Values From A Query 3526a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {column access functions} 3527a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3528a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These routines form the "result set" interface. 3529a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3530a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines return information about a single column of the current 3531a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** result row of a query. ^In every case the first argument is a pointer 3532a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*] 3533a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that was returned from [sqlite3_prepare_v2()] or one of its variants) 3534a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and the second argument is the index of the column for which information 3535a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** should be returned. ^The leftmost column of the result set has the index 0. 3536a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The number of columns in the result can be determined using 3537a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_column_count()]. 3538a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3539a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If the SQL statement does not currently point to a valid row, or if the 3540a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** column index is out of range, the result is undefined. 35417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These routines may only be called when the most recent call to 35427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_step()] has returned [SQLITE_ROW] and neither 3543a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently. 35447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If any of these routines are called after [sqlite3_reset()] or 35457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_finalize()] or after [sqlite3_step()] has returned 35467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** something other than [SQLITE_ROW], the results are undefined. 35477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()] 35487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** are called from a different thread while any of these routines 3549a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are pending, then the results are undefined. 35507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3551a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_column_type() routine returns the 35527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_INTEGER | datatype code] for the initial data type 3553a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the result column. ^The returned value is one of [SQLITE_INTEGER], 35547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value 35557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** returned by sqlite3_column_type() is only meaningful if no type 35567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** conversions have occurred as described below. After a type conversion, 35577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the value returned by sqlite3_column_type() is undefined. Future 35587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** versions of SQLite may change the behavior of sqlite3_column_type() 35597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** following a type conversion. 35607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3561a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes() 35627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** routine returns the number of bytes in that BLOB or string. 3563a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts 35647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the string to UTF-8 and then returns the number of bytes. 3565a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the result is a numeric value then sqlite3_column_bytes() uses 35667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns 35677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the number of bytes in that string. 3568de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^If the result is NULL, then sqlite3_column_bytes() returns zero. 3569de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 3570de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^If the result is a BLOB or UTF-16 string then the sqlite3_column_bytes16() 3571de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** routine returns the number of bytes in that BLOB or string. 3572de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^If the result is a UTF-8 string, then sqlite3_column_bytes16() converts 3573de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the string to UTF-16 and then returns the number of bytes. 3574de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^If the result is a numeric value then sqlite3_column_bytes16() uses 3575de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [sqlite3_snprintf()] to convert that value to a UTF-16 string and returns 3576de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the number of bytes in that string. 3577de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^If the result is NULL, then sqlite3_column_bytes16() returns zero. 3578de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 3579de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The values returned by [sqlite3_column_bytes()] and 3580de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [sqlite3_column_bytes16()] do not include the zero terminators at the end 3581de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** of the string. ^For clarity: the values returned by 3582de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of 35837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** bytes in the string, not the number of characters. 35847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3585a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(), 358690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** even empty strings, are always zero-terminated. ^The return 3587de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer. 35887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3589a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The object returned by [sqlite3_column_value()] is an 35907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [unprotected sqlite3_value] object. An unprotected sqlite3_value object 35917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()]. 35927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If the [unprotected sqlite3_value] object returned by 35937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_column_value()] is used in any other way, including calls 3594a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to routines like [sqlite3_value_int()], [sqlite3_value_text()], 3595a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [sqlite3_value_bytes()], then the behavior is undefined. 35967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3597a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These routines attempt to convert the value where appropriate. ^For 35987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** example, if the internal representation is FLOAT and a text result 3599a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is requested, [sqlite3_snprintf()] is used internally to perform the 3600a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** conversion automatically. ^(The following table details the conversions 3601a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that are applied: 36027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 36037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <blockquote> 36047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <table border="1"> 36057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion 36067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 36077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> NULL <td> INTEGER <td> Result is 0 36087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> NULL <td> FLOAT <td> Result is 0.0 36097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> NULL <td> TEXT <td> Result is NULL pointer 36107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> NULL <td> BLOB <td> Result is NULL pointer 36117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float 36127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer 3613a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT 36147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> FLOAT <td> INTEGER <td> Convert from float to integer 36157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float 36167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> FLOAT <td> BLOB <td> Same as FLOAT->TEXT 36177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> TEXT <td> INTEGER <td> Use atoi() 36187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> TEXT <td> FLOAT <td> Use atof() 36197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> TEXT <td> BLOB <td> No change 36207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> BLOB <td> INTEGER <td> Convert to TEXT then use atoi() 36217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> BLOB <td> FLOAT <td> Convert to TEXT then use atof() 36227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed 36237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** </table> 3624a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </blockquote>)^ 36257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 36267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The table above makes reference to standard C library functions atoi() 36277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and atof(). SQLite does not really use these functions. It has its 3628a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** own equivalent internal routines. The atoi() and atof() names are 36297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** used in the table for brevity and because they are familiar to most 36307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** C programmers. 36317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3632de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** Note that when type conversions occur, pointers returned by prior 36337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or 3634a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_text16() may be invalidated. 3635de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** Type conversions and pointer invalidations might occur 36367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** in the following cases: 36377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 36387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 3639a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> The initial content is a BLOB and sqlite3_column_text() or 3640a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_text16() is called. A zero-terminator might 3641a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** need to be added to the string.</li> 3642a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or 3643a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_text16() is called. The content must be converted 3644a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to UTF-16.</li> 3645a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or 3646a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_text() is called. The content must be converted 3647a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to UTF-8.</li> 3648de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** </ul> 3649a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3650a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Conversions between UTF-16be and UTF-16le are always done in place and do 36517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** not invalidate a prior pointer, though of course the content of the buffer 3652de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** that the prior pointer references will have been modified. Other kinds 3653a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of conversion are done in place when it is possible, but sometimes they 3654a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are not possible and in those cases prior pointers are invalidated. 36557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3656de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The safest and easiest to remember policy is to invoke these routines 36577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** in one of the following ways: 36587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3659a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <ul> 36607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li> 36617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li> 36627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li> 3663de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** </ul> 36647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3665a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** In other words, you should call sqlite3_column_text(), 3666a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result 3667a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** into the desired format, then invoke sqlite3_column_bytes() or 3668a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_bytes16() to find the size of the result. Do not mix calls 3669a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to sqlite3_column_text() or sqlite3_column_blob() with calls to 3670a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16() 3671a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with calls to sqlite3_column_bytes(). 36727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3673a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The pointers returned are valid until a type conversion occurs as 36747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** described above, or until [sqlite3_step()] or [sqlite3_reset()] or 3675a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_finalize()] is called. ^The memory space used to hold strings 3676a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and BLOBs is freed automatically. Do <b>not</b> pass the pointers returned 3677a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into 36787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_free()]. 36797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3680a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(If a memory allocation error occurs during the evaluation of any 36817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of these routines, a default value is returned. The default value 36827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is either the integer 0, the floating point number 0.0, or a NULL 36837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** pointer. Subsequent calls to [sqlite3_errcode()] will return 3684a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_NOMEM].)^ 3685a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 3686a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_column_blob(sqlite3_stmt*, int iCol); 3687a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol); 3688a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol); 3689a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol); 3690a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol); 3691a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol); 3692a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol); 3693a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_column_text16(sqlite3_stmt*, int iCol); 3694a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol); 3695a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol); 3696a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 3697a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 3698a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Destroy A Prepared Statement Object 36997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3700a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_finalize() function is called to delete a [prepared statement]. 370190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^If the most recent evaluation of the statement encountered no errors 370295c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** or if the statement is never been evaluated, then sqlite3_finalize() returns 370395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** SQLITE_OK. ^If the most recent evaluation of statement S failed, then 370495c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** sqlite3_finalize(S) returns the appropriate [error code] or 370595c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** [extended error code]. 370695c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** 370795c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^The sqlite3_finalize(S) routine can be called at any point during 370895c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** the life cycle of [prepared statement] S: 370995c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** before statement S is ever evaluated, after 371095c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** one or more calls to [sqlite3_reset()], or after any call 371195c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** to [sqlite3_step()] regardless of whether or not the statement has 371295c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** completed execution. 371395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** 371495c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^Invoking sqlite3_finalize() on a NULL pointer is a harmless no-op. 371595c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** 371695c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** The application must finalize every [prepared statement] in order to avoid 371795c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** resource leaks. It is a grievous error for the application to try to use 371895c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** a prepared statement after it has been finalized. Any use of a prepared 371995c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** statement after it has been finalized can result in undefined and 372095c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** undesirable behavior such as segfaults and heap corruption. 37217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3722a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt); 37237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 37247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3725a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Reset A Prepared Statement Object 37267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3727a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_reset() function is called to reset a [prepared statement] 3728a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** object back to its initial state, ready to be re-executed. 3729a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Any SQL statement variables that had values bound to them using 37307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values. 37317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Use [sqlite3_clear_bindings()] to reset the bindings. 37327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3733a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S 3734a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** back to the beginning of its program. 37357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3736a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the most recent call to [sqlite3_step(S)] for the 3737a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE], 3738a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or if [sqlite3_step(S)] has never before been called on S, 3739a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then [sqlite3_reset(S)] returns [SQLITE_OK]. 37407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3741a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the most recent call to [sqlite3_step(S)] for the 3742a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [prepared statement] S indicated an error, then 3743a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_reset(S)] returns an appropriate [error code]. 37447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3745a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_reset(S)] interface does not change the values 3746a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S. 37477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3748a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt); 37497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 37507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3751a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Create Or Redefine SQL Functions 3752a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {function creation routines} 3753a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {application-defined SQL function} 3754a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {application-defined SQL functions} 3755a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3756de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^These functions (collectively known as "function creation routines") 3757a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are used to add SQL functions or aggregates or to redefine the behavior 3758de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** of existing SQL functions or aggregates. The only differences between 3759de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** these routines are the text encoding expected for 376090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the second parameter (the name of the function being created) 3761de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** and the presence or absence of a destructor callback for 3762de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the application data pointer. 3763a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3764a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first parameter is the [database connection] to which the SQL 3765a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function is to be added. ^If an application uses more than one database 3766a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** connection then application-defined SQL functions must be added 3767a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to each database connection separately. 3768a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3769de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The second parameter is the name of the SQL function to be created or 3770de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** redefined. ^The length of the name is limited to 255 bytes in a UTF-8 3771de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** representation, exclusive of the zero-terminator. ^Note that the name 3772de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes. 3773de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^Any attempt to create a function with a longer name 3774de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** will result in [SQLITE_MISUSE] being returned. 3775a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3776a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The third parameter (nArg) 3777a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is the number of arguments that the SQL function or 3778a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** aggregate takes. ^If this parameter is -1, then the SQL function or 3779a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** aggregate may take any number of arguments between 0 and the limit 3780a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third 3781a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter is less than -1 or greater than 127 then the behavior is 3782a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** undefined. 37837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3784de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The fourth parameter, eTextRep, specifies what 37857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_UTF8 | text encoding] this SQL function prefers for 3786de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** its parameters. Every SQL function implementation must be able to work 3787de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** with UTF-8, UTF-16le, or UTF-16be. But some implementations may be 3788a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** more efficient with one encoding than another. ^An application may 37897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** invoke sqlite3_create_function() or sqlite3_create_function16() multiple 37907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** times with the same function but with different values of eTextRep. 3791a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^When multiple implementations of the same function are available, SQLite 37927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** will pick the one that involves the least amount of data conversion. 3793a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If there is only a single implementation which does not care what text 3794a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** encoding is used, then the fourth argument should be [SQLITE_ANY]. 37957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3796a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The fifth parameter is an arbitrary pointer. The implementation of the 3797a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function can gain access to this pointer using [sqlite3_user_data()].)^ 37987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 379990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The sixth, seventh and eighth parameters, xFunc, xStep and xFinal, are 3800a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pointers to C-language functions that implement the SQL function or 3801a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** aggregate. ^A scalar SQL function requires an implementation of the xFunc 3802de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** callback only; NULL pointers must be passed as the xStep and xFinal 3803a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameters. ^An aggregate SQL function requires an implementation of xStep 3804de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing 380590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** SQL function or aggregate, pass NULL pointers for all three function 3806de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** callbacks. 3807de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 380890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^(If the ninth parameter to sqlite3_create_function_v2() is not NULL, 380995c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** then it is destructor for the application data pointer. 381095c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** The destructor is invoked when the function is deleted, either by being 381195c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** overloaded or when the database connection closes.)^ 381295c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^The destructor is also invoked if the call to 381395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** sqlite3_create_function_v2() fails. 381495c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^When the destructor callback of the tenth parameter is invoked, it 381595c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** is passed a single argument which is a copy of the application data 381695c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** pointer which was the fifth parameter to sqlite3_create_function_v2(). 3817a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3818a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^It is permitted to register multiple implementations of the same 38197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** functions with the same name but with either differing numbers of 3820a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** arguments or differing preferred text encodings. ^SQLite will use 3821a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the implementation that most closely matches the way in which the 3822a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQL function is used. ^A function implementation with a non-negative 3823a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** nArg parameter is a better match than a function implementation with 3824a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a negative nArg. ^A function where the preferred text encoding 3825a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** matches the database encoding is a better 3826a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** match than a function where the encoding is different. 3827a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A function where the encoding difference is between UTF16le and UTF16be 3828a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is a closer match than a function where the encoding difference is 3829a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** between UTF8 and UTF16. 3830a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3831a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Built-in functions may be overloaded by new application-defined functions. 3832a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3833a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^An application-defined function is permitted to call other 3834a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite interfaces. However, such calls must not 3835a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** close the database connection nor finalize or reset the prepared 3836a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** statement in which the function is running. 3837a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 3838a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_create_function( 38397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, 38407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zFunctionName, 38417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nArg, 38427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int eTextRep, 38437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void *pApp, 38447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xFunc)(sqlite3_context*,int,sqlite3_value**), 38457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xStep)(sqlite3_context*,int,sqlite3_value**), 38467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xFinal)(sqlite3_context*) 38477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 3848a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_create_function16( 38497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, 38507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void *zFunctionName, 38517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nArg, 38527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int eTextRep, 38537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void *pApp, 38547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xFunc)(sqlite3_context*,int,sqlite3_value**), 38557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xStep)(sqlite3_context*,int,sqlite3_value**), 38567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (*xFinal)(sqlite3_context*) 38577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 3858de2b3240539802d409a25760d5cec9d4ebfd6686Vasu NoriSQLITE_API int sqlite3_create_function_v2( 3859de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori sqlite3 *db, 3860de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori const char *zFunctionName, 3861de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori int nArg, 3862de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori int eTextRep, 3863de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void *pApp, 3864de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void (*xFunc)(sqlite3_context*,int,sqlite3_value**), 3865de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void (*xStep)(sqlite3_context*,int,sqlite3_value**), 3866de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void (*xFinal)(sqlite3_context*), 3867de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void(*xDestroy)(void*) 3868de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori); 38697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 38707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3871a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Text Encodings 38727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 38737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These constant define integer codes that represent the various 38747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** text encodings supported by SQLite. 38757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 38767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_UTF8 1 38777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_UTF16LE 2 38787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_UTF16BE 3 38797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_UTF16 4 /* Use native byte order */ 38807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_ANY 5 /* sqlite3_create_function only */ 38817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */ 38827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 38837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3884a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Deprecated Functions 3885a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** DEPRECATED 38867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3887a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These functions are [deprecated]. In order to maintain 3888a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** backwards compatibility with older code, these functions continue 3889a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to be supported. However, new applications should avoid 38907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the use of these functions. To help encourage people to avoid 3891a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** using these functions, we are not going to tell you what they do. 38927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3893a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#ifndef SQLITE_OMIT_DEPRECATED 3894a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*); 3895a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*); 3896a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*); 3897a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void); 3898a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API SQLITE_DEPRECATED void sqlite3_thread_cleanup(void); 3899a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),void*,sqlite3_int64); 3900a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#endif 39017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 39027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 3903a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Obtaining SQL Function Parameter Values 39047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 39057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The C-language implementation of SQL functions and aggregates uses 39067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** this set of interface routines to access the parameter values on 39077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the function or aggregate. 39087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 39097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The xFunc (for scalar functions) or xStep (for aggregates) parameters 39107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to [sqlite3_create_function()] and [sqlite3_create_function16()] 39117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** define callbacks that implement the SQL functions and aggregates. 391290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The 3rd parameter to these callbacks is an array of pointers to 39137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [protected sqlite3_value] objects. There is one [sqlite3_value] object for 39147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** each parameter to the SQL function. These routines are used to 39157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** extract values from the [sqlite3_value] objects. 39167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 39177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These routines work only with [protected sqlite3_value] objects. 39187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Any attempt to use these routines on an [unprotected sqlite3_value] 39197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** object results in undefined behavior. 39207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3921a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines work just like the corresponding [column access functions] 3922a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** except that these routines take a single [protected sqlite3_value] object 3923a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pointer instead of a [sqlite3_stmt*] pointer and an integer column number. 39247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3925a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_value_text16() interface extracts a UTF-16 string 3926a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in the native byte-order of the host machine. ^The 39277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces 3928a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** extract UTF-16 strings as big-endian and little-endian respectively. 39297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3930a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The sqlite3_value_numeric_type() interface attempts to apply 39317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** numeric affinity to the value. This means that an attempt is 39327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** made to convert the value to an integer or floating point. If 39337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** such a conversion is possible without loss of information (in other 3934a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** words, if the value is a string that looks like a number) 3935a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the conversion is performed. Otherwise no conversion occurs. 3936a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [SQLITE_INTEGER | datatype] after conversion is returned.)^ 39377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 3938a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Please pay particular attention to the fact that the pointer returned 3939a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from [sqlite3_value_blob()], [sqlite3_value_text()], or 39407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_value_text16()] can be invalidated by a subsequent call to 39417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()], 3942a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [sqlite3_value_text16()]. 39437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 39447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These routines must be called from the same thread as 39457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the SQL function that supplied the [sqlite3_value*] parameters. 3946a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 3947a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_value_blob(sqlite3_value*); 3948a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_value_bytes(sqlite3_value*); 3949a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_value_bytes16(sqlite3_value*); 3950a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API double sqlite3_value_double(sqlite3_value*); 3951a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_value_int(sqlite3_value*); 3952a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value*); 3953a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value*); 3954a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_value_text16(sqlite3_value*); 3955a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_value_text16le(sqlite3_value*); 3956a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API const void *sqlite3_value_text16be(sqlite3_value*); 3957a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_value_type(sqlite3_value*); 3958a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_value_numeric_type(sqlite3_value*); 3959a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 3960a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 3961a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Obtain Aggregate Function Context 3962a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3963de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** Implementations of aggregate SQL functions use this 3964a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routine to allocate memory for storing their state. 3965a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3966a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first time the sqlite3_aggregate_context(C,N) routine is called 3967a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for a particular aggregate function, SQLite 3968a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocates N of memory, zeroes out that memory, and returns a pointer 3969a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the new memory. ^On second and subsequent calls to 3970a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_aggregate_context() for the same aggregate function instance, 3971a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the same buffer is returned. Sqlite3_aggregate_context() is normally 3972a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** called once for each invocation of the xStep callback and then one 3973a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** last time when the xFinal callback is invoked. ^(When no rows match 3974a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an aggregate query, the xStep() callback of the aggregate function 3975a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation is never called and xFinal() is called exactly once. 3976a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** In those cases, sqlite3_aggregate_context() might be called for the 3977a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** first time from within xFinal().)^ 3978a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3979a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer if N is 3980a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** less than or equal to zero or if a memory allocate error occurs. 3981a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3982a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is 3983a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** determined by the N parameter on first successful call. Changing the 3984a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value of N in subsequent call to sqlite3_aggregate_context() within 3985a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the same aggregate function instance will not resize the memory 3986a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocation.)^ 3987a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3988a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite automatically frees the memory allocated by 3989a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_aggregate_context() when the aggregate query concludes. 3990a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 3991a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The first parameter must be a copy of the 3992a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_context | SQL function context] that is the first parameter 3993a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the xStep or xFinal callback routine that implements the aggregate 39947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** function. 39957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 39967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** This routine must be called from the same thread in which 39977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the aggregate SQL function is running. 39987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 3999a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void *sqlite3_aggregate_context(sqlite3_context*, int nBytes); 40007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 40017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4002a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: User Data For Functions 40037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4004a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_user_data() interface returns a copy of 40057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the pointer that was the pUserData parameter (the 5th parameter) 4006a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the [sqlite3_create_function()] 40077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and [sqlite3_create_function16()] routines that originally 4008a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** registered the application defined function. 40097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 40107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** This routine must be called from the same thread in which 40117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the application-defined function is running. 40127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4013a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void *sqlite3_user_data(sqlite3_context*); 40147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 40157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4016a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Database Connection For Functions 40177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4018a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_context_db_handle() interface returns a copy of 40197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the pointer to the [database connection] (the 1st parameter) 4020a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the [sqlite3_create_function()] 40217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and [sqlite3_create_function16()] routines that originally 40227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** registered the application defined function. 40237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4024a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_context*); 40257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 40267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4027a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Function Auxiliary Data 40287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 40297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The following two functions may be used by scalar SQL functions to 4030a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** associate metadata with argument values. If the same value is passed to 40317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** multiple invocations of the same SQL function during query execution, under 4032a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** some circumstances the associated metadata may be preserved. This may 40337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** be used, for example, to add a regular-expression matching scalar 40347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** function. The compiled version of the regular expression is stored as 4035a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** metadata associated with the SQL value passed as the regular expression 40367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** pattern. The compiled regular expression can be reused on multiple 40377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** invocations of the same function so that the original pattern string 40387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** does not need to be recompiled on each invocation. 40397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4040a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_get_auxdata() interface returns a pointer to the metadata 40417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** associated by the sqlite3_set_auxdata() function with the Nth argument 4042a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value to the application-defined function. ^If no metadata has been ever 4043a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** been set for the Nth argument of the function, or if the corresponding 4044a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function parameter has changed since the meta-data was set, 4045a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then sqlite3_get_auxdata() returns a NULL pointer. 4046a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4047a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_set_auxdata() interface saves the metadata 4048a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pointed to by its 3rd parameter as the metadata for the N-th 40497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** argument of the application-defined function. Subsequent 40507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** calls to sqlite3_get_auxdata() might return this data, if it has 4051a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not been destroyed. 4052a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If it is not NULL, SQLite will invoke the destructor 40537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** function given by the 4th parameter to sqlite3_set_auxdata() on 4054a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the metadata when the corresponding function parameter changes 40557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or when the SQL statement completes, whichever comes first. 40567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4057a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite is free to call the destructor and drop metadata on any 4058a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter of any function at any time. ^The only guarantee is that 4059a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the destructor will be called before the metadata is dropped. 40607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4061a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(In practice, metadata is preserved between function calls for 40627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** expressions that are constant at compile time. This includes literal 4063a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** values and [parameters].)^ 40647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 40657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These routines must be called from the same thread in which 40667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the SQL function is running. 40677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4068a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void *sqlite3_get_auxdata(sqlite3_context*, int N); 4069a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*)); 40707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 40717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 40727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4073a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Constants Defining Special Destructor Behavior 40747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4075a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These are special values for the destructor that is passed in as the 4076a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** final argument to routines like [sqlite3_result_blob()]. ^If the destructor 40777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** argument is SQLITE_STATIC, it means that the content pointer is constant 4078a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and will never change. It does not need to be destroyed. ^The 40797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLITE_TRANSIENT value means that the content will likely change in 40807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the near future and that SQLite should make its own private copy of 40817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the content before returning. 40827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 40837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The typedef is necessary to work around problems in certain 40847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** C++ compilers. See ticket #2191. 40857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 40867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef void (*sqlite3_destructor_type)(void*); 40877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_STATIC ((sqlite3_destructor_type)0) 40887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1) 40897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 40907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4091a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Setting The Result Of An SQL Function 40927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 40937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These routines are used by the xFunc or xFinal callbacks that 40947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** implement SQL functions and aggregates. See 40957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_create_function()] and [sqlite3_create_function16()] 40967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for additional information. 40977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4098a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These functions work very much like the [parameter binding] family of 4099a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** functions used to bind values to host parameters in prepared statements. 4100a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Refer to the [SQL parameter] documentation for additional information. 41017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4102a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_blob() interface sets the result from 4103a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an application-defined function to be the BLOB whose content is pointed 41047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to by the second parameter and which is N bytes long where N is the 4105a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** third parameter. 4106a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4107a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_zeroblob() interfaces set the result of 4108a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the application-defined function to be a BLOB containing all zero 41097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** bytes and N bytes in size, where N is the value of the 2nd parameter. 41107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4111a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_double() interface sets the result from 4112a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an application-defined function to be a floating point value specified 41137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** by its 2nd argument. 41147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4115a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_error() and sqlite3_result_error16() functions 41167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** cause the implemented SQL function to throw an exception. 4117a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite uses the string pointed to by the 41187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16() 4119a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** as the text of an error message. ^SQLite interprets the error 4120a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** message string from sqlite3_result_error() as UTF-8. ^SQLite 4121a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interprets the string from sqlite3_result_error16() as UTF-16 in native 4122a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** byte order. ^If the third parameter to sqlite3_result_error() 41237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or sqlite3_result_error16() is negative then SQLite takes as the error 41247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** message all text up through the first zero character. 4125a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the third parameter to sqlite3_result_error() or 41267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_result_error16() is non-negative then SQLite takes that many 41277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** bytes (not characters) from the 2nd parameter as the error message. 4128a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_error() and sqlite3_result_error16() 4129a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routines make a private copy of the error message text before 41307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** they return. Hence, the calling function can deallocate or 41317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** modify the text after they return without harm. 4132a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_error_code() function changes the error code 4133a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned by SQLite as a result of an error in a function. ^By default, 4134a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error() 41357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or sqlite3_result_error16() resets the error code to SQLITE_ERROR. 41367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4137a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_toobig() interface causes SQLite to throw an error 4138a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** indicating that a string or BLOB is too long to represent. 4139a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4140a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_nomem() interface causes SQLite to throw an error 4141a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** indicating that a memory allocation failed. 41427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4143a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_int() interface sets the return value 41447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of the application-defined function to be the 32-bit signed integer 41457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** value given in the 2nd argument. 4146a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_int64() interface sets the return value 41477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of the application-defined function to be the 64-bit signed integer 41487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** value given in the 2nd argument. 41497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4150a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_null() interface sets the return value 41517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of the application-defined function to be NULL. 41527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4153a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_text(), sqlite3_result_text16(), 41547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces 41557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** set the return value of the application-defined function to be 41567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a text string which is represented as UTF-8, UTF-16 native byte order, 41577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** UTF-16 little endian, or UTF-16 big endian, respectively. 4158a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite takes the text result from the application from 41597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the 2nd parameter of the sqlite3_result_text* interfaces. 4160a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the 3rd parameter to the sqlite3_result_text* interfaces 4161a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is negative, then SQLite takes result text from the 2nd parameter 41627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** through the first zero character. 4163a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the 3rd parameter to the sqlite3_result_text* interfaces 41647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is non-negative, then as many bytes (not characters) of the text 41657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** pointed to by the 2nd parameter are taken as the application-defined 416690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** function result. If the 3rd parameter is non-negative, then it 416790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** must be the byte offset into the string where the NUL terminator would 416890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** appear if the string where NUL terminated. If any NUL characters occur 416990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** in the string at a byte offset that is less than the value of the 3rd 417090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** parameter, then the resulting string will contain embedded NULs and the 417190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** result of expressions operating on strings with embedded NULs is undefined. 4172a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the 4th parameter to the sqlite3_result_text* interfaces 41737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that 4174a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function as the destructor on the text or BLOB result when it has 41757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** finished using that result. 4176a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the 4th parameter to the sqlite3_result_text* interfaces or to 4177a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite 4178a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** assumes that the text or BLOB result is in constant space and does not 4179a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** copy the content of the parameter nor call a destructor on the content 4180a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** when it has finished using that result. 4181a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the 4th parameter to the sqlite3_result_text* interfaces 41827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT 41837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** then SQLite makes a copy of the result into space obtained from 41847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** from [sqlite3_malloc()] before it returns. 41857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4186a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_result_value() interface sets the result of 41877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the application-defined function to be a copy the 4188a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The 41897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_result_value() interface makes a copy of the [sqlite3_value] 4190a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** so that the [sqlite3_value] specified in the parameter may change or 41917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** be deallocated after sqlite3_result_value() returns without harm. 4192a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A [protected sqlite3_value] object may always be used where an 41937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [unprotected sqlite3_value] object is required, so either 41947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** kind of [sqlite3_value] object can be used with this interface. 41957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4196a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If these routines are called from within the different thread 4197a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** than the one containing the application-defined function that received 41987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the [sqlite3_context] pointer, the results are undefined. 4199a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 4200a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*)); 4201a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_double(sqlite3_context*, double); 4202a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_error(sqlite3_context*, const char*, int); 4203a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_error16(sqlite3_context*, const void*, int); 4204a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_error_toobig(sqlite3_context*); 4205a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_error_nomem(sqlite3_context*); 4206a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_error_code(sqlite3_context*, int); 4207a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_int(sqlite3_context*, int); 4208a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64); 4209a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_null(sqlite3_context*); 4210a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*)); 4211a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*)); 4212a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*)); 4213a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*)); 4214a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_value(sqlite3_context*, sqlite3_value*); 4215a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n); 4216a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 4217a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 4218a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Define New Collating Sequences 42197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4220de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^These functions add, remove, or modify a [collation] associated 4221de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** with the [database connection] specified as the first argument. 42227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4223de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The name of the collation is a UTF-8 string 42247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for sqlite3_create_collation() and sqlite3_create_collation_v2() 4225de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** and a UTF-16 string in native byte order for sqlite3_create_collation16(). 4226de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^Collation names that compare equal according to [sqlite3_strnicmp()] are 4227de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** considered to be the same name. 4228de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 4229de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^(The third argument (eTextRep) must be one of the constants: 4230de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <ul> 4231de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> [SQLITE_UTF8], 4232de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> [SQLITE_UTF16LE], 4233de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> [SQLITE_UTF16BE], 4234de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> [SQLITE_UTF16], or 4235de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> [SQLITE_UTF16_ALIGNED]. 4236de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** </ul>)^ 4237de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The eTextRep argument determines the encoding of strings passed 4238de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** to the collating function callback, xCallback. 4239de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep 4240de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** force strings to be UTF16 with native byte order. 4241de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin 4242de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** on an even byte address. 4243de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 424490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The fourth argument, pArg, is an application data pointer that is passed 4245de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** through as the first argument to the collating function callback. 4246de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 4247de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The fifth argument, xCallback, is a pointer to the collating function. 4248de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^Multiple collating functions can be registered using the same name but 4249de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** with different eTextRep parameters and SQLite will use whichever 4250de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** function requires the least amount of data transformation. 4251de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^If the xCallback argument is NULL then the collating function is 4252de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** deleted. ^When all collating functions having the same name are deleted, 4253de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** that collation is no longer usable. 4254de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 4255de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The collating function callback is invoked with a copy of the pArg 4256de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** application data pointer and with two strings in the encoding specified 4257de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** by the eTextRep argument. The collating function must return an 4258de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** integer that is negative, zero, or positive 4259de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** if the first string is less than, equal to, or greater than the second, 426090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** respectively. A collating function must always return the same answer 4261de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** given the same inputs. If two or more collating functions are registered 4262de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** to the same collation name (using different eTextRep values) then all 4263de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** must give an equivalent answer when invoked with equivalent strings. 4264de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The collating function must obey the following properties for all 4265de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** strings A, B, and C: 4266de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 4267de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <ol> 4268de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> If A==B then B==A. 4269de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> If A==B and B==C then A==C. 4270de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> If A<B THEN B>A. 4271de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> If A<B and B<C then A<C. 4272de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** </ol> 4273de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 4274de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** If a collating function fails any of the above constraints and that 4275de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** collating function is registered and used, then the behavior of SQLite 4276de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** is undefined. 4277a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4278a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation() 4279de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** with the addition that the xDestroy callback is invoked on pArg when 4280de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the collating function is deleted. 4281de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^Collating functions are deleted when they are overridden by later 4282de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** calls to the collation creation functions or when the 4283de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [database connection] is closed using [sqlite3_close()]. 42847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 428595c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^The xDestroy callback is <u>not</u> called if the 428695c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** sqlite3_create_collation_v2() function fails. Applications that invoke 428795c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should 428895c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** check the return code and dispose of the application data pointer 428995c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** themselves rather than expecting SQLite to deal with it for them. 429095c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** This is different from every other SQLite interface. The inconsistency 429195c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** is unfortunate but cannot be changed without breaking backwards 429295c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** compatibility. 429395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** 4294a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()]. 42957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4296a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_create_collation( 42977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 42987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zName, 42997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int eTextRep, 4300de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void *pArg, 43017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int(*xCompare)(void*,int,const void*,int,const void*) 43027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 4303a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_create_collation_v2( 43047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 43057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zName, 43067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int eTextRep, 4307de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void *pArg, 43087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int(*xCompare)(void*,int,const void*,int,const void*), 43097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void(*xDestroy)(void*) 43107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 4311a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_create_collation16( 43127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 4313a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori const void *zName, 43147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int eTextRep, 4315de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void *pArg, 43167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int(*xCompare)(void*,int,const void*,int,const void*) 43177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 43187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 43197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4320a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Collation Needed Callbacks 43217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4322a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^To avoid having to register all collation sequences before a database 43237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** can be used, a single callback function may be registered with the 4324a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection] to be invoked whenever an undefined collation 4325a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sequence is required. 43267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4327a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the function is registered using the sqlite3_collation_needed() API, 43287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** then it is passed the names of undefined collation sequences as strings 4329a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** encoded in UTF-8. ^If sqlite3_collation_needed16() is used, 4330a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the names are passed as UTF-16 in machine native byte order. 4331a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A call to either function replaces the existing collation-needed callback. 43327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4333a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(When the callback is invoked, the first argument passed is a copy 43347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of the second argument to sqlite3_collation_needed() or 43357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_collation_needed16(). The second argument is the database 4336a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE], 4337a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [SQLITE_UTF16LE], indicating the most desirable form of the collation 4338a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sequence function required. The fourth parameter is the name of the 4339a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** required collation sequence.)^ 43407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 43417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The callback function should register the desired collation using 43427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_create_collation()], [sqlite3_create_collation16()], or 43437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_create_collation_v2()]. 43447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4345a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_collation_needed( 43467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 43477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void*, 43487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void(*)(void*,sqlite3*,int eTextRep,const char*) 43497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 4350a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_collation_needed16( 43517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 43527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void*, 43537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void(*)(void*,sqlite3*,int eTextRep,const void*) 43547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 43557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 435671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#ifdef SQLITE_HAS_CODEC 43577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 43587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Specify the key for an encrypted database. This routine should be 43597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** called right after sqlite3_open(). 43607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 43617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The code to implement this API is not available in the public release 43627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of SQLite. 43637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4364a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_key( 43657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Database to be rekeyed */ 43667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void *pKey, int nKey /* The key */ 43677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 43687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 43697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 43707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Change the key on an open database. If the current database is not 43717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the 43727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** database is decrypted. 43737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 43747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The code to implement this API is not available in the public release 43757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of SQLite. 43767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4377a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_rekey( 43787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Database to be rekeyed */ 43797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const void *pKey, int nKey /* The new key */ 43807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 43817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 43827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 438371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** Specify the activation key for a SEE database. Unless 438471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** activated, none of the SEE routines will work. 438571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori*/ 438671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API void sqlite3_activate_see( 438771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori const char *zPassPhrase /* Activation phrase */ 438871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori); 438971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#endif 439071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 439171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#ifdef SQLITE_ENABLE_CEROD 439271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori/* 439371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** Specify the activation key for a CEROD database. Unless 439471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** activated, none of the CEROD routines will work. 439571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori*/ 439671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API void sqlite3_activate_cerod( 439771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori const char *zPassPhrase /* Activation phrase */ 439871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori); 439971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#endif 440071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 440171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori/* 4402a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Suspend Execution For A Short Time 44037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4404de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The sqlite3_sleep() function causes the current thread to suspend execution 44057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for at least a number of milliseconds specified in its parameter. 44067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4407de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** If the operating system does not support sleep requests with 4408a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** millisecond time resolution, then the time will be rounded up to 4409de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the nearest second. The number of milliseconds of sleep actually 44107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** requested from the operating system is returned. 44117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4412a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite implements this interface by calling the xSleep() 4413de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** method of the default [sqlite3_vfs] object. If the xSleep() method 4414de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** of the default VFS is not implemented correctly, or not implemented at 4415de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** all, then the behavior of sqlite3_sleep() may deviate from the description 4416de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** in the previous paragraphs. 44177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4418a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_sleep(int); 44197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 44207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4421a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Name Of The Folder Holding Temporary Files 4422a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4423a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(If this global variable is made to point to a string which is 4424a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the name of a folder (a.k.a. directory), then all temporary files 4425a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** created by SQLite when using a built-in [sqlite3_vfs | VFS] 4426a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will be placed in that directory.)^ ^If this variable 4427a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is a NULL pointer, then SQLite performs a search for an appropriate 4428a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** temporary file directory. 4429a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4430a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** It is not safe to read or modify this variable in more than one 4431a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** thread at a time. It is not safe to read or modify this variable 4432a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** if a [database connection] is being used at the same time in a separate 4433a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** thread. 4434a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** It is intended that this variable be set once 44357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** as part of process initialization and before any SQLite interface 4436a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routines have been called and that this variable remain unchanged 4437a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** thereafter. 4438a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4439a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [temp_store_directory pragma] may modify this variable and cause 4440a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore, 4441a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [temp_store_directory pragma] always assumes that any string 4442a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that this variable points to is held in memory obtained from 4443a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_malloc] and the pragma may attempt to free that memory 4444a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** using [sqlite3_free]. 4445a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Hence, if this variable is modified directly, either it should be 4446a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** made NULL or made to point to memory obtained from [sqlite3_malloc] 4447a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or else the use of the [temp_store_directory pragma] should be avoided. 44487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4449a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory; 44507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 44517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4452a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Test For Auto-Commit Mode 4453a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {autocommit mode} 44547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4455a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_get_autocommit() interface returns non-zero or 44567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** zero if the given database connection is or is not in autocommit mode, 4457a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** respectively. ^Autocommit mode is on by default. 4458a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Autocommit mode is disabled by a [BEGIN] statement. 4459a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK]. 44607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 44617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If certain kinds of errors occur on a statement within a multi-statement 4462a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR], 44637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the 44647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** transaction might be rolled back automatically. The only way to 4465a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** find out whether SQLite automatically rolled back the transaction after 44667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** an error is to use this function. 44677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4468a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If another thread changes the autocommit status of the database 4469a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** connection while this routine is running, then the return value 4470a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is undefined. 44717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4472a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_get_autocommit(sqlite3*); 44737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 44747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4475a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Find The Database Handle Of A Prepared Statement 4476a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4477a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_db_handle interface returns the [database connection] handle 4478a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to which a [prepared statement] belongs. ^The [database connection] 4479a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned by sqlite3_db_handle is the same [database connection] 4480a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that was the first argument 4481a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the [sqlite3_prepare_v2()] call (or its variants) that was used to 4482a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** create the statement in the first place. 4483a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 4484a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*); 4485a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 4486a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 448790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CAPI3REF: Return The Filename For A Database Connection 448890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 448990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The sqlite3_db_filename(D,N) interface returns a pointer to a filename 449090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** associated with database N of connection D. ^The main database file 449190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** has the name "main". If there is no attached database N on the database 449290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** connection D, or if database N is a temporary or in-memory database, then 449390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** a NULL pointer is returned. 449490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 449590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The filename returned by this function is the output of the 449690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** xFullPathname method of the [VFS]. ^In other words, the filename 449790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** will be an absolute pathname, even if the filename used 449890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** to open the database originally was a URI or relative pathname. 449990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 450090ed05d921d6ed7f12012d9786d53f57fafee51aJeff BrownSQLITE_API const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName); 450190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 450290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 4503c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** CAPI3REF: Determine if a database is read-only 4504c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** 4505c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** ^The sqlite3_db_readonly(D,N) interface returns 1 if the database N 4506c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** of connection D is read-only, 0 if it is read/write, or -1 if N is not 4507c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** the name of a database on connection D. 4508c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown*/ 4509c82acac4e67711e8d9289b572d334298aeb5d806Jeff BrownSQLITE_API int sqlite3_db_readonly(sqlite3 *db, const char *zDbName); 4510c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown 4511c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown/* 4512a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Find the next prepared statement 45137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4514a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This interface returns a pointer to the next [prepared statement] after 4515a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pStmt associated with the [database connection] pDb. ^If pStmt is NULL 4516a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then this interface returns a pointer to the first prepared statement 4517a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** associated with the database connection pDb. ^If no prepared statement 4518a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** satisfies the conditions of this routine, it returns NULL. 45197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4520a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [database connection] pointer D in a call to 4521a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_next_stmt(D,S)] must refer to an open database 4522a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** connection and in particular must not be a NULL pointer. 45237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4524a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt); 45257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 45267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4527a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Commit And Rollback Notification Callbacks 45287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4529a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_commit_hook() interface registers a callback 4530a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function to be invoked whenever a transaction is [COMMIT | committed]. 4531a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Any callback set by a previous call to sqlite3_commit_hook() 45327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for the same database connection is overridden. 4533a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_rollback_hook() interface registers a callback 4534a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function to be invoked whenever a transaction is [ROLLBACK | rolled back]. 4535a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Any callback set by a previous call to sqlite3_rollback_hook() 45367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for the same database connection is overridden. 4537a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The pArg argument is passed through to the callback. 4538a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the callback on a commit hook function returns non-zero, 4539a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the commit is converted into a rollback. 4540a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4541a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions 4542a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** return the P argument from the previous call of the same function 4543a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on the same [database connection] D, or NULL for 4544a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the first call for each function on D. 4545a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 454690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The commit and rollback hook callbacks are not reentrant. 4547a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The callback implementation must not do anything that will modify 4548a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the database connection that invoked the callback. Any actions 4549a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to modify the database connection must be deferred until after the 4550a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** completion of the [sqlite3_step()] call that triggered the commit 4551a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or rollback hook in the first place. 455290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Note that running any other SQL statements, including SELECT statements, 455390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** or merely calling [sqlite3_prepare_v2()] and [sqlite3_step()] will modify 455490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the database connections for the meaning of "modify" in this paragraph. 4555a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4556a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Registering a NULL function disables the callback. 4557a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4558a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^When the commit hook callback routine returns zero, the [COMMIT] 4559a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** operation is allowed to continue normally. ^If the commit hook 4560a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK]. 4561a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The rollback hook is invoked on a rollback that results from a commit 4562a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** hook returning non-zero, just as it would be with any other rollback. 4563a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4564a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^For the purposes of this API, a transaction is said to have been 45657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** rolled back if an explicit "ROLLBACK" statement is executed, or 45667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** an error or constraint causes an implicit rollback to occur. 4567a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The rollback callback is not invoked if a transaction is 45687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** automatically rolled back because the database connection is closed. 45697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4570a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also the [sqlite3_update_hook()] interface. 45717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4572a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*); 4573a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*); 45747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 45757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4576a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Data Change Notification Callbacks 45777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4578a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_update_hook() interface registers a callback function 4579a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with the [database connection] identified by the first argument 4580a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to be invoked whenever a row is updated, inserted or deleted. 4581a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Any callback set by a previous call to this function 4582a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for the same database connection is overridden. 45837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4584a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The second argument is a pointer to the function to invoke when a 4585a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** row is updated, inserted or deleted. 4586a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first argument to the callback is a copy of the third argument 4587a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to sqlite3_update_hook(). 4588a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE], 4589a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [SQLITE_UPDATE], depending on the operation that caused the callback 4590a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to be invoked. 4591a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The third and fourth arguments to the callback contain pointers to the 4592a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database and table name containing the affected row. 4593a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The final callback parameter is the [rowid] of the row. 4594a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^In the case of an update, this is the [rowid] after the update takes place. 4595a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4596a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The update hook is not invoked when internal system tables are 4597a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** modified (i.e. sqlite_master and sqlite_sequence).)^ 4598a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4599a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^In the current implementation, the update hook 4600a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not invoked when duplication rows are deleted because of an 4601a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook 4602a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** invoked when rows are deleted using the [truncate optimization]. 4603a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The exceptions defined in this paragraph might change in a future 4604a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** release of SQLite. 4605a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4606a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The update hook implementation must not do anything that will modify 4607a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the database connection that invoked the update hook. Any actions 4608a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to modify the database connection must be deferred until after the 4609a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** completion of the [sqlite3_step()] call that triggered the update hook. 4610a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 4611a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database connections for the meaning of "modify" in this paragraph. 4612a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4613a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_update_hook(D,C,P) function 4614a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returns the P argument from the previous call 4615a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on the same [database connection] D, or NULL for 4616a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the first call on D. 4617a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4618a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also the [sqlite3_commit_hook()] and [sqlite3_rollback_hook()] 4619a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces. 46207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4621a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void *sqlite3_update_hook( 46227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 46237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void(*)(void *,int ,char const *,char const *,sqlite3_int64), 46247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void* 46257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 46267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 46277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4628a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Enable Or Disable Shared Pager Cache 4629a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {shared cache} 46307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4631a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This routine enables or disables the sharing of the database cache 4632a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and schema data structures between [database connection | connections] 4633a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the same database. Sharing is enabled if the argument is true 4634a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and disabled if the argument is false.)^ 46357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4636a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Cache sharing is enabled and disabled for an entire process. 4637a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This is a change as of SQLite version 3.5.0. In prior versions of SQLite, 4638a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sharing was enabled or disabled for each thread separately. 46397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4640a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The cache sharing mode set by this interface effects all subsequent 46417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()]. 46427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Existing database connections continue use the sharing mode 4643a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that was in effect at the time they were opened.)^ 46447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4645a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled 4646a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** successfully. An [error code] is returned otherwise.)^ 46477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4648a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Shared cache is disabled by default. But this might change in 46497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** future releases of SQLite. Applications that care about shared 46507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** cache setting should set it explicitly. 46517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4652a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See Also: [SQLite Shared-Cache Mode] 46537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4654a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_enable_shared_cache(int); 46557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 46567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4657a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Attempt To Free Heap Memory 4658a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4659a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_release_memory() interface attempts to free N bytes 4660a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of heap memory by deallocating non-essential memory allocations 4661a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** held by the database library. Memory used to cache database 4662a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pages to improve performance is an example of non-essential memory. 4663a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^sqlite3_release_memory() returns the number of bytes actually freed, 4664a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** which might be more or less than the amount requested. 4665de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The sqlite3_release_memory() routine is a no-op returning zero 4666de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT]. 466790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 466890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** See also: [sqlite3_db_release_memory()] 46697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4670a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_release_memory(int); 46717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 46727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 467390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CAPI3REF: Free Memory Used By A Database Connection 467490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 467590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The sqlite3_db_release_memory(D) interface attempts to free as much heap 467690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** memory as possible from database connection D. Unlike the 467790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_release_memory()] interface, this interface is effect even 467890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** when then [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is 467990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** omitted. 468090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 468190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** See also: [sqlite3_release_memory()] 468290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 468390ed05d921d6ed7f12012d9786d53f57fafee51aJeff BrownSQLITE_API int sqlite3_db_release_memory(sqlite3*); 468490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 468590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 4686a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Impose A Limit On Heap Size 46877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4688de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the 4689de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** soft limit on the amount of heap memory that may be allocated by SQLite. 4690de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^SQLite strives to keep heap memory utilization below the soft heap 4691de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** limit by reducing the number of pages held in the page cache 4692de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** as heap memory usages approaches the limit. 4693de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The soft heap limit is "soft" because even though SQLite strives to stay 4694de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** below the limit, it will exceed the limit rather than generate 4695de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** an [SQLITE_NOMEM] error. In other words, the soft heap limit 4696de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** is advisory only. 46977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4698de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The return value from sqlite3_soft_heap_limit64() is the size of 469990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the soft heap limit prior to the call, or negative in the case of an 470090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** error. ^If the argument N is negative 4701de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** then no change is made to the soft heap limit. Hence, the current 4702de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** size of the soft heap limit can be determined by invoking 4703de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** sqlite3_soft_heap_limit64() with a negative argument. 47047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4705de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^If the argument N is zero then the soft heap limit is disabled. 47067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4707de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^(The soft heap limit is not enforced in the current implementation 4708de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** if one or more of following conditions are true: 47097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4710de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <ul> 4711de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> The soft heap limit is set to zero. 4712de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> Memory accounting is disabled using a combination of the 4713de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and 4714de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option. 471590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <li> An alternative page cache implementation is specified using 471690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_config]([SQLITE_CONFIG_PCACHE2],...). 4717de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <li> The page cache allocates from its own memory pool supplied 4718de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than 4719de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** from the heap. 4720de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** </ul>)^ 4721de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 4722de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** Beginning with SQLite version 3.7.3, the soft heap limit is enforced 4723de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** regardless of whether or not the [SQLITE_ENABLE_MEMORY_MANAGEMENT] 4724de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** compile-time option is invoked. With [SQLITE_ENABLE_MEMORY_MANAGEMENT], 4725de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the soft heap limit is enforced on every memory allocation. Without 4726de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [SQLITE_ENABLE_MEMORY_MANAGEMENT], the soft heap limit is only enforced 4727de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** when memory is allocated by the page cache. Testing suggests that because 4728de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the page cache is the predominate memory user in SQLite, most 4729de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** applications will achieve adequate soft heap limit enforcement without 4730de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the use of [SQLITE_ENABLE_MEMORY_MANAGEMENT]. 4731de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 4732de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The circumstances under which SQLite will enforce the soft heap limit may 4733de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** changes in future releases of SQLite. 47347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4735de2b3240539802d409a25760d5cec9d4ebfd6686Vasu NoriSQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N); 4736de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 4737de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori/* 4738de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** CAPI3REF: Deprecated Soft Heap Limit Interface 4739de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** DEPRECATED 4740de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 4741de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** This is a deprecated version of the [sqlite3_soft_heap_limit64()] 4742de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** interface. This routine is provided for historical compatibility 4743de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** only. All new applications should use the 4744de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [sqlite3_soft_heap_limit64()] interface rather than this one. 4745de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori*/ 4746de2b3240539802d409a25760d5cec9d4ebfd6686Vasu NoriSQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_limit(int N); 4747de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 47487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 47497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4750a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Extract Metadata About A Column Of A Table 47517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4752a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This routine returns metadata about a specific column of a specific 4753a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database table accessible using the [database connection] handle 4754a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** passed as the first function argument. 47557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4756a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The column is identified by the second, third and fourth parameters to 4757a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** this function. ^The second parameter is either the name of the database 4758a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (i.e. "main", "temp", or an attached database) containing the specified 4759a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** table or NULL. ^If it is NULL, then all attached databases are searched 4760a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for the table using the same algorithm used by the database engine to 47617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** resolve unqualified table references. 47627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4763a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The third and fourth parameters to this function are the table and column 4764a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** name of the desired column, respectively. Neither of these parameters 47657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** may be NULL. 47667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4767a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Metadata is returned by writing to the memory locations passed as the 5th 4768a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and subsequent parameters to this function. ^Any of these arguments may be 4769a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** NULL, in which case the corresponding element of metadata is omitted. 47707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4771a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<blockquote> 4772a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <table border="1"> 4773a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><th> Parameter <th> Output<br>Type <th> Description 47747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4775a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 5th <td> const char* <td> Data type 4776a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 6th <td> const char* <td> Name of default collation sequence 4777a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint 4778a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY 4779a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT] 4780a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </table> 4781a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </blockquote>)^ 47827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4783a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The memory pointed to by the character pointers returned for the 4784a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** declaration type and collation sequence is valid only until the next 4785a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** call to any SQLite API function. 47867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4787a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the specified table is actually a view, an [error code] is returned. 47887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4789a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the specified column is "rowid", "oid" or "_rowid_" and an 4790a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output 4791a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameters are set for the explicitly declared column. ^(If there is no 4792a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** explicitly declared [INTEGER PRIMARY KEY] column, then the output 4793a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameters are set as follows: 47947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 47957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <pre> 47967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** data type: "INTEGER" 47977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** collation sequence: "BINARY" 47987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** not null: 0 47997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** primary key: 1 48007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** auto increment: 0 4801a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </pre>)^ 48027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4803a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This function may load one or more schemas from database files. If an 48047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** error occurs during this process, or if the requested table or column 4805a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** cannot be found, an [error code] is returned and an error message left 4806a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in the [database connection] (to be retrieved using sqlite3_errmsg()).)^ 48077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4808a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This API is only available if the library was compiled with the 4809a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined. 48107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4811a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_table_column_metadata( 48127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Connection handle */ 48137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zDbName, /* Database name or NULL */ 48147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zTableName, /* Table name */ 48157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zColumnName, /* Column name */ 48167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project char const **pzDataType, /* OUTPUT: Declared data type */ 48177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project char const **pzCollSeq, /* OUTPUT: Collation sequence name */ 48187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */ 48197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int *pPrimaryKey, /* OUTPUT: True if column part of PK */ 48207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int *pAutoinc /* OUTPUT: True if column is auto-increment */ 48217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 48227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 48237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4824a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Load An Extension 4825a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4826a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This interface loads an SQLite extension library from the named file. 48277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4828a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_load_extension() interface attempts to load an 4829a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite extension library contained in the file zFile. 48307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4831a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The entry point is zProc. 4832a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^zProc may be 0, in which case the name of the entry point 4833a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** defaults to "sqlite3_extension_init". 4834a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_load_extension() interface returns 4835a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong. 4836a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If an error occurs and pzErrMsg is not 0, then the 4837a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_load_extension()] interface shall attempt to 4838a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** fill *pzErrMsg with error message text stored in memory 4839a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** obtained from [sqlite3_malloc()]. The calling function 4840a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** should free this memory by calling [sqlite3_free()]. 48417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4842a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Extension loading must be enabled using 4843a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_enable_load_extension()] prior to calling this API, 4844a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** otherwise an error will be returned. 48457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4846a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also the [load_extension() SQL function]. 48477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4848a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_load_extension( 48497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* Load the extension into this database connection */ 48507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zFile, /* Name of the shared library containing extension */ 48517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zProc, /* Entry point. Derived from zFile if 0 */ 48527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project char **pzErrMsg /* Put error message here if not 0 */ 48537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 48547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 48557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4856a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Enable Or Disable Extension Loading 48577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4858a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^So as not to open security holes in older applications that are 48597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** unprepared to deal with extension loading, and as a means of disabling 4860a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** extension loading while evaluating user-entered SQL, the following API 4861a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is provided to turn the [sqlite3_load_extension()] mechanism on and off. 48627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4863a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Extension loading is off by default. See ticket #1863. 4864a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Call the sqlite3_enable_load_extension() routine with onoff==1 4865a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to turn extension loading on and call it with onoff==0 to turn 4866a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it back off again. 48677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4868a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff); 48697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 48707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4871de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** CAPI3REF: Automatically Load Statically Linked Extensions 4872de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 4873de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^This interface causes the xEntryPoint() function to be invoked for 4874de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** each new [database connection] that is created. The idea here is that 4875de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** xEntryPoint() is the entry point for a statically linked SQLite extension 4876de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** that is to be automatically loaded into all new database connections. 4877de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 4878de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^(Even though the function prototype shows that xEntryPoint() takes 4879de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** no arguments and returns void, SQLite invokes xEntryPoint() with three 4880de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** arguments and expects and integer result as if the signature of the 4881de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** entry point where as follows: 4882de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 4883de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <blockquote><pre> 4884de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** int xEntryPoint( 4885de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** sqlite3 *db, 4886de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** const char **pzErrMsg, 4887de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** const struct sqlite3_api_routines *pThunk 4888de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ); 4889de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** </pre></blockquote>)^ 48907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4891de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** If the xEntryPoint routine encounters an error, it should make *pzErrMsg 4892de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** point to an appropriate error message (obtained from [sqlite3_mprintf()]) 4893de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg 4894de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** is NULL before calling the xEntryPoint(). ^SQLite will invoke 4895de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any 4896de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()], 4897de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail. 4898a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4899de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^Calling sqlite3_auto_extension(X) with an entry point X that is already 4900de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** on the list of automatic extensions is a harmless no-op. ^No entry point 4901de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** will be called more than once for each database connection that is opened. 4902a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4903de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** See also: [sqlite3_reset_auto_extension()]. 49047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4905a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_auto_extension(void (*xEntryPoint)(void)); 49067790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 49077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4908a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Reset Automatic Extension Loading 49097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4910de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^This interface disables all automatic extensions previously 4911de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** registered using [sqlite3_auto_extension()]. 49127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 4913a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_reset_auto_extension(void); 49147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 49157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 49167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The interface to the virtual-table mechanism is currently considered 49177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to be experimental. The interface might change in incompatible ways. 49187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If this is a problem for you, do not use the interface at this time. 49197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4920a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When the virtual-table mechanism stabilizes, we will declare the 49217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface fixed, support it indefinitely, and remove this comment. 49227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 49237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 49247790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 49257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Structures used by the virtual table interface 49267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 49277790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_vtab sqlite3_vtab; 49287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_index_info sqlite3_index_info; 49297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor; 49307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_module sqlite3_module; 49317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 49327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4933a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Virtual Table Object 4934a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: sqlite3_module {virtual table module} 4935a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 493690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** This structure, sometimes called a "virtual table module", 4937a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** defines the implementation of a [virtual tables]. 4938a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This structure consists mostly of methods for the module. 4939a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 4940a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A virtual table module is created by filling in a persistent 4941a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** instance of this structure and passing a pointer to that instance 4942a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to [sqlite3_create_module()] or [sqlite3_create_module_v2()]. 4943a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The registration remains valid until it is replaced by a different 4944a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** module or until the [database connection] closes. The content 4945a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of this structure must not change while it is registered with 4946a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** any database connection. 49477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 49487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projectstruct sqlite3_module { 49497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int iVersion; 49507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xCreate)(sqlite3*, void *pAux, 49517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int argc, const char *const*argv, 49527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_vtab **ppVTab, char**); 49537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xConnect)(sqlite3*, void *pAux, 49547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int argc, const char *const*argv, 49557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_vtab **ppVTab, char**); 49567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*); 49577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xDisconnect)(sqlite3_vtab *pVTab); 49587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xDestroy)(sqlite3_vtab *pVTab); 49597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor); 49607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xClose)(sqlite3_vtab_cursor*); 49617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr, 49627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int argc, sqlite3_value **argv); 49637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xNext)(sqlite3_vtab_cursor*); 49647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xEof)(sqlite3_vtab_cursor*); 49657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int); 49667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid); 49677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *); 49687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xBegin)(sqlite3_vtab *pVTab); 49697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xSync)(sqlite3_vtab *pVTab); 49707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xCommit)(sqlite3_vtab *pVTab); 49717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xRollback)(sqlite3_vtab *pVTab); 49727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName, 49737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), 49747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void **ppArg); 49757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int (*xRename)(sqlite3_vtab *pVtab, const char *zNew); 497690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown /* The methods above are in version 1 of the sqlite_module object. Those 497790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown ** below are for version 2 and greater. */ 497890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown int (*xSavepoint)(sqlite3_vtab *pVTab, int); 497990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown int (*xRelease)(sqlite3_vtab *pVTab, int); 498090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown int (*xRollbackTo)(sqlite3_vtab *pVTab, int); 49817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project}; 49827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 49837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 4984a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Virtual Table Indexing Information 49857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** KEYWORDS: sqlite3_index_info 49867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4987de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The sqlite3_index_info structure and its substructures is used as part 4988de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** of the [virtual table] interface to 4989a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pass information into and receive the reply from the [xBestIndex] 4990a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** method of a [virtual table module]. The fields under **Inputs** are the 49917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** inputs to xBestIndex and are read-only. xBestIndex inserts its 49927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** results into the **Outputs** fields. 49937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4994a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The aConstraint[] array records WHERE clause constraints of the form: 49957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4996de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <blockquote>column OP expr</blockquote> 49977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 4998a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** where OP is =, <, <=, >, or >=.)^ ^(The particular operator is 4999de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** stored in aConstraint[].op using one of the 5000de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [SQLITE_INDEX_CONSTRAINT_EQ | SQLITE_INDEX_CONSTRAINT_ values].)^ 5001de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^(The index of the column is stored in 5002a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the 50037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** expr on the right-hand side can be evaluated (and thus the constraint 5004a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is usable) and false if it cannot.)^ 50057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5006a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The optimizer automatically inverts terms of the form "expr OP column" 50077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** and makes other simplifications to the WHERE clause in an attempt to 50087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** get as many WHERE clause terms into the form shown above as possible. 5009a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The aConstraint[] array only reports WHERE clause terms that are 5010a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** relevant to the particular virtual table being queried. 50117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5012a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Information about the ORDER BY clause is stored in aOrderBy[]. 5013a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Each term of aOrderBy records a column of the ORDER BY clause. 50147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5015a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [xBestIndex] method must fill aConstraintUsage[] with information 5016a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** about what parameters to pass to xFilter. ^If argvIndex>0 then 50177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the right-hand side of the corresponding aConstraint[] is evaluated 5018a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit 50197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is true, then the constraint is assumed to be fully handled by the 5020a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** virtual table and is not checked again by SQLite.)^ 50217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5022a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The idxNum and idxPtr values are recorded and passed into the 5023a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [xFilter] method. 5024a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^[sqlite3_free()] is used to free idxPtr if and only if 5025a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** needToFreeIdxPtr is true. 50267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5027a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in 50287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the correct order to satisfy the ORDER BY clause so that no separate 50297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sorting step is required. 50307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5031a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The estimatedCost value is an estimate of the cost of doing the 50327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** particular lookup. A full scan of a table with N entries should have 50337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** a cost of N. A binary search of a table of N entries should have a 50347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** cost of approximately log(N). 50357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 50367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projectstruct sqlite3_index_info { 50377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project /* Inputs */ 50387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nConstraint; /* Number of entries in aConstraint */ 50397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project struct sqlite3_index_constraint { 50407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int iColumn; /* Column on left-hand side of constraint */ 50417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project unsigned char op; /* Constraint operator */ 50427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project unsigned char usable; /* True if this constraint is usable */ 50437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int iTermOffset; /* Used internally - xBestIndex should ignore */ 50447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project } *aConstraint; /* Table of WHERE clause constraints */ 50457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int nOrderBy; /* Number of terms in the ORDER BY clause */ 50467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project struct sqlite3_index_orderby { 50477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int iColumn; /* Column number */ 50487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project unsigned char desc; /* True for DESC. False for ASC. */ 50497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project } *aOrderBy; /* The ORDER BY clause */ 50507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project /* Outputs */ 50517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project struct sqlite3_index_constraint_usage { 50527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int argvIndex; /* if >0, constraint is part of argv to xFilter */ 50537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project unsigned char omit; /* Do not code a test for this constraint */ 50547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project } *aConstraintUsage; 50557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int idxNum; /* Number used to identify the index */ 50567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project char *idxStr; /* String, possibly obtained from sqlite3_malloc */ 50577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ 50587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int orderByConsumed; /* True if output is already ordered */ 50597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project double estimatedCost; /* Estimated cost of using this index */ 50607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project}; 5061de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 5062de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori/* 5063de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** CAPI3REF: Virtual Table Constraint Operator Codes 5064de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 5065de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** These macros defined the allowed values for the 5066de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [sqlite3_index_info].aConstraint[].op field. Each value represents 5067de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** an operator that is part of a constraint term in the wHERE clause of 5068de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** a query that uses a [virtual table]. 5069de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori*/ 50707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INDEX_CONSTRAINT_EQ 2 50717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INDEX_CONSTRAINT_GT 4 50727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INDEX_CONSTRAINT_LE 8 50737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INDEX_CONSTRAINT_LT 16 50747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INDEX_CONSTRAINT_GE 32 50757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_INDEX_CONSTRAINT_MATCH 64 50767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 50777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5078a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Register A Virtual Table Implementation 5079a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5080a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines are used to register a new [virtual table module] name. 5081a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Module names must be registered before 5082a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** creating a new [virtual table] using the module and before using a 5083a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** preexisting [virtual table] for the module. 5084a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5085a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The module name is registered on the [database connection] specified 5086a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by the first parameter. ^The name of the module is given by the 5087a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** second parameter. ^The third parameter is a pointer to 5088a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the implementation of the [virtual table module]. ^The fourth 5089a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter is an arbitrary client data pointer that is passed through 5090a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** into the [xCreate] and [xConnect] methods of the virtual table module 5091a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** when a new virtual table is be being created or reinitialized. 5092a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5093a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_create_module_v2() interface has a fifth parameter which 5094a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is a pointer to a destructor for the pClientData. ^SQLite will 5095a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** invoke the destructor function (if it is not NULL) when SQLite 509695c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** no longer needs the pClientData pointer. ^The destructor will also 509795c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** be invoked if the call to sqlite3_create_module_v2() fails. 509895c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^The sqlite3_create_module() 5099a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interface is equivalent to sqlite3_create_module_v2() with a NULL 5100a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** destructor. 51017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 510271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_create_module( 51037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* SQLite connection to register module with */ 51047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zName, /* Name of the module */ 5105a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori const sqlite3_module *p, /* Methods for the module */ 5106a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *pClientData /* Client data for xCreate/xConnect */ 51077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 510871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_create_module_v2( 51097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3 *db, /* SQLite connection to register module with */ 51107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zName, /* Name of the module */ 5111a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori const sqlite3_module *p, /* Methods for the module */ 5112a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *pClientData, /* Client data for xCreate/xConnect */ 51137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project void(*xDestroy)(void*) /* Module destructor function */ 51147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 51157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 51167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5117a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Virtual Table Instance Object 51187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** KEYWORDS: sqlite3_vtab 5119a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5120a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Every [virtual table module] implementation uses a subclass 5121a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of this object to describe a particular instance 5122a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the [virtual table]. Each subclass will 5123a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** be tailored to the specific needs of the module implementation. 5124a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The purpose of this superclass is to define certain fields that are 5125a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** common to all module implementations. 5126a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5127a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Virtual tables methods can set an error message by assigning a 5128a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should 5129a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** take care that any prior string is freed by a call to [sqlite3_free()] 5130a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** prior to assigning a new string to zErrMsg. ^After the error message 51317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is delivered up to the client application, the string will be automatically 5132a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** freed by sqlite3_free() and the zErrMsg field will be zeroed. 51337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 51347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projectstruct sqlite3_vtab { 51357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const sqlite3_module *pModule; /* The module for this virtual table */ 5136a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int nRef; /* NO LONGER USED */ 51377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project char *zErrMsg; /* Error message from sqlite3_mprintf() */ 51387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project /* Virtual table implementations will typically add additional fields */ 51397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project}; 51407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 51417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5142a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Virtual Table Cursor Object 5143a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor} 51447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5145a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Every [virtual table module] implementation uses a subclass of the 5146a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** following structure to describe cursors that point into the 5147a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [virtual table] and are used 51487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to loop through the virtual table. Cursors are created using the 5149a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed 5150a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by the [sqlite3_module.xClose | xClose] method. Cursors are used 5151a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods 5152a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of the module. Each module implementation will define 51537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the content of a cursor structure to suit its own needs. 51547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 51557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** This superclass exists in order to define fields of the cursor that 51567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** are common to all implementations. 51577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 51587790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projectstruct sqlite3_vtab_cursor { 51597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_vtab *pVtab; /* Virtual table of this cursor */ 51607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project /* Virtual table implementations will typically add additional fields */ 51617790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project}; 51627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 51637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5164a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Declare The Schema Of A Virtual Table 51657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5166a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [xCreate] and [xConnect] methods of a 5167a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [virtual table module] call this interface 51687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to declare the format (the names and datatypes of the columns) of 51697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the virtual tables they implement. 51707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 517171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_declare_vtab(sqlite3*, const char *zSQL); 51727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 51737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5174a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Overload A Function For A Virtual Table 51757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5176a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Virtual tables can provide alternative implementations of functions 5177a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** using the [xFindFunction] method of the [virtual table module]. 5178a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** But global versions of those functions 5179a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** must exist in order to be overloaded.)^ 51807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5181a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This API makes sure a global version of a function with a particular 51827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** name and number of parameters exists. If no such function exists 5183a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** before this API is called, a new function is created.)^ ^The implementation 51847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of the new function always causes an exception to be thrown. So 51857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the new function is not good for anything by itself. Its only 5186a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** purpose is to be a placeholder function that can be overloaded 5187a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by a [virtual table]. 51887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 518971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg); 51907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 51917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 51927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The interface to the virtual-table mechanism defined above (back up 51937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to a comment remarkably similar to this one) is currently considered 51947790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to be experimental. The interface might change in incompatible ways. 51957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** If this is a problem for you, do not use the interface at this time. 51967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 51977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** When the virtual-table mechanism stabilizes, we will declare the 51987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface fixed, support it indefinitely, and remove this comment. 51997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 52007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 52017790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5202a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: A Handle To An Open BLOB 5203a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {BLOB handle} {BLOB handles} 52047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 52057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** An instance of this object represents an open BLOB on which 5206a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_blob_open | incremental BLOB I/O] can be performed. 5207a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Objects of this type are created by [sqlite3_blob_open()] 5208a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and destroyed by [sqlite3_blob_close()]. 5209a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces 5210a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can be used to read or write small subsections of the BLOB. 5211a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes. 52127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 52137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Projecttypedef struct sqlite3_blob sqlite3_blob; 52147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 52157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5216a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Open A BLOB For Incremental I/O 52177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5218a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located 52197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** in row iRow, column zColumn, table zTable in database zDb; 5220a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in other words, the same BLOB that would be selected by: 52217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 52227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <pre> 5223a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow; 5224a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </pre>)^ 52257790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5226a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the flags parameter is non-zero, then the BLOB is opened for read 5227a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and write access. ^If it is zero, the BLOB is opened for read access. 5228a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^It is not possible to open a column that is part of an index or primary 5229a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** key for writing. ^If [foreign key constraints] are enabled, it is 5230a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not possible to open a column that is part of a [child key] for writing. 52317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5232a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Note that the database name is not the filename that contains 52337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the database but rather the symbolic name of the database that 5234a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** appears after the AS keyword when the database is connected using [ATTACH]. 5235a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^For the main database file, the database name is "main". 5236a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^For TEMP tables, the database name is "temp". 5237a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5238a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is written 5239a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to *ppBlob. Otherwise an [error code] is returned and *ppBlob is set 5240a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to be a null pointer.)^ 5241a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This function sets the [database connection] error code and message 5242a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()] and related 5243a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** functions. ^Note that the *ppBlob variable is always initialized in a 5244a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** way that makes it safe to invoke [sqlite3_blob_close()] on *ppBlob 5245a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** regardless of the success or failure of this routine. 5246a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5247a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(If the row that a BLOB handle points to is modified by an 5248a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects 5249a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the BLOB handle is marked as "expired". 5250a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This is true if any column of the row is changed, even a column 5251a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** other than the one the BLOB handle is open on.)^ 5252a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for 525390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** an expired BLOB handle fail with a return code of [SQLITE_ABORT]. 5254a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Changes written into a BLOB prior to the BLOB expiring are not 5255a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** rolled back by the expiration of the BLOB. Such changes will eventually 5256a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** commit if the transaction continues to completion.)^ 5257a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5258a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Use the [sqlite3_blob_bytes()] interface to determine the size of 5259a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the opened blob. ^The size of a blob may not be changed by this 5260a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interface. Use the [UPDATE] SQL command to change the size of a 5261a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** blob. 5262a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5263a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces 5264a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and the built-in [zeroblob] SQL function can be used, if desired, 5265a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to create an empty, zero-filled blob in which to read or write using 5266a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** this interface. 5267a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5268a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** To avoid a resource leak, every open [BLOB handle] should eventually 5269a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** be released by a call to [sqlite3_blob_close()]. 52707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 5271a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_blob_open( 52727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3*, 52737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zDb, 52747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zTable, 52757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project const char *zColumn, 52767790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_int64 iRow, 52777790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project int flags, 52787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project sqlite3_blob **ppBlob 52797790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project); 52807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 52817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 528295c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** CAPI3REF: Move a BLOB Handle to a New Row 528395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** 528495c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^This function is used to move an existing blob handle so that it points 528595c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** to a different row of the same database table. ^The new row is identified 528695c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** by the rowid value passed as the second argument. Only the row can be 528795c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** changed. ^The database, table and column on which the blob handle is open 528895c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** remain the same. Moving an existing blob handle to a new row can be 528995c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** faster than closing the existing handle and opening a new one. 529095c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** 529195c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] - 529295c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** it must exist and there must be either a blob or text value stored in 529395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** the nominated column.)^ ^If the new row is not present in the table, or if 529495c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** it does not contain a blob or text value, or if another error occurs, an 529595c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** SQLite error code is returned and the blob handle is considered aborted. 529695c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^All subsequent calls to [sqlite3_blob_read()], [sqlite3_blob_write()] or 529795c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** [sqlite3_blob_reopen()] on an aborted blob handle immediately return 529895c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** SQLITE_ABORT. ^Calling [sqlite3_blob_bytes()] on an aborted blob handle 529995c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** always returns zero. 530095c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** 530195c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^This function sets the database handle error code and message. 530295c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori*/ 530395c34edce550d0869113085e0cd1b6b09e8fe38bVasu NoriSQLITE_API SQLITE_EXPERIMENTAL int sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64); 530495c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori 530595c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori/* 5306a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Close A BLOB Handle 53077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5308a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Closes an open [BLOB handle]. 53097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5310a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Closing a BLOB shall cause the current transaction to commit 53117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** if there are no other BLOBs, no pending prepared statements, and the 5312a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database connection is in [autocommit mode]. 5313a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If any writes were made to the BLOB, they might be held in cache 5314a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** until the close operation if they will fit. 53157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5316a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Closing the BLOB often forces the changes 5317a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** out to disk and so if any I/O errors occur, they will likely occur 5318a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** at the time when the BLOB is closed. Any errors that occur during 5319a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** closing are reported as a non-zero return value.)^ 53207790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5321a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The BLOB is closed unconditionally. Even if this routine returns 5322a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an error code, the BLOB is still closed.)^ 53237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5324a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Calling this routine with a null pointer (such as would be returned 5325a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by a failed call to [sqlite3_blob_open()]) is a harmless no-op. 53267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 5327a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_blob_close(sqlite3_blob *); 53287790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 53297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5330a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Return The Size Of An Open BLOB 53317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5332a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Returns the size in bytes of the BLOB accessible via the 5333a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** successfully opened [BLOB handle] in its only argument. ^The 5334a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** incremental blob I/O routines can only read or overwriting existing 5335a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** blob content; they cannot change the size of a blob. 53367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5337a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This routine only works on a [BLOB handle] which has been created 5338a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by a prior successful call to [sqlite3_blob_open()] and which has not 5339a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** been closed by [sqlite3_blob_close()]. Passing any other pointer in 5340a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to this routine results in undefined and probably undesirable behavior. 53417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 5342a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_blob_bytes(sqlite3_blob *); 53437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 53447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5345a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Read Data From A BLOB Incrementally 53467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5347a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This function is used to read data from an open [BLOB handle] into a 5348a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** caller-supplied buffer. N bytes of data are copied into buffer Z 5349a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from the open BLOB, starting at offset iOffset.)^ 53507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5351a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If offset iOffset is less than N bytes from the end of the BLOB, 5352a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_ERROR] is returned and no data is read. ^If N or iOffset is 5353a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** less than zero, [SQLITE_ERROR] is returned and no data is read. 5354a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The size of the blob (and hence the maximum value of N+iOffset) 5355a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can be determined using the [sqlite3_blob_bytes()] interface. 53567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5357a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^An attempt to read from an expired [BLOB handle] fails with an 5358a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** error code of [SQLITE_ABORT]. 53597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5360a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(On success, sqlite3_blob_read() returns SQLITE_OK. 5361a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Otherwise, an [error code] or an [extended error code] is returned.)^ 53627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5363a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This routine only works on a [BLOB handle] which has been created 5364a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by a prior successful call to [sqlite3_blob_open()] and which has not 5365a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** been closed by [sqlite3_blob_close()]. Passing any other pointer in 5366a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to this routine results in undefined and probably undesirable behavior. 53677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5368a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also: [sqlite3_blob_write()]. 53697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 5370a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset); 53717790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 53727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5373a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Write Data Into A BLOB Incrementally 53747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5375a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This function is used to write data into an open [BLOB handle] from a 5376a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** caller-supplied buffer. ^N bytes of data are copied from the buffer Z 5377a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** into the open BLOB, starting at offset iOffset. 53787790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5379a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the [BLOB handle] passed as the first argument was not opened for 5380a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** writing (the flags parameter to [sqlite3_blob_open()] was zero), 5381a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** this function returns [SQLITE_READONLY]. 53827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5383a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This function may only modify the contents of the BLOB; it is 5384a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not possible to increase the size of a BLOB using this API. 5385a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If offset iOffset is less than N bytes from the end of the BLOB, 5386a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_ERROR] is returned and no data is written. ^If N is 53877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** less than zero [SQLITE_ERROR] is returned and no data is written. 5388a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The size of the BLOB (and hence the maximum value of N+iOffset) 5389a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can be determined using the [sqlite3_blob_bytes()] interface. 53907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5391a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^An attempt to write to an expired [BLOB handle] fails with an 5392a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred 5393a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** before the [BLOB handle] expired are not rolled back by the 5394a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** expiration of the handle, though of course those changes might 5395a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** have been overwritten by the statement that expired the BLOB handle 5396a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or by other independent statements. 53977790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5398a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(On success, sqlite3_blob_write() returns SQLITE_OK. 5399a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Otherwise, an [error code] or an [extended error code] is returned.)^ 54007790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5401a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This routine only works on a [BLOB handle] which has been created 5402a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by a prior successful call to [sqlite3_blob_open()] and which has not 5403a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** been closed by [sqlite3_blob_close()]. Passing any other pointer in 5404a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to this routine results in undefined and probably undesirable behavior. 54057790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5406a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also: [sqlite3_blob_read()]. 54077790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 5408a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset); 54097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 54107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5411a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Virtual File System Objects 54127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 54137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** A virtual filesystem (VFS) is an [sqlite3_vfs] object 54147790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** that SQLite uses to interact 54157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** with the underlying operating system. Most SQLite builds come with a 54167790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** single default VFS that is appropriate for the host computer. 54177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** New VFSes can be registered and existing VFSes can be unregistered. 54187790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The following interfaces are provided. 54197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5420a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name. 5421a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Names are case sensitive. 5422a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Names are zero-terminated UTF-8 strings. 5423a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If there is no match, a NULL pointer is returned. 5424a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If zVfsName is NULL then the default VFS is returned. 5425a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5426a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^New VFSes are registered with sqlite3_vfs_register(). 5427a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Each new VFS becomes the default VFS if the makeDflt flag is set. 5428a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The same VFS can be registered multiple times without injury. 5429a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^To make an existing VFS into the default VFS, register it again 54307790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** with the makeDflt flag set. If two different VFSes with the 54317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** same name are registered, the behavior is undefined. If a 54327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** VFS is registered with a name that is NULL or an empty string, 54337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** then the behavior is undefined. 54347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5435a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Unregister a VFS with the sqlite3_vfs_unregister() interface. 5436a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(If the default VFS is unregistered, another VFS is chosen as 5437a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the default. The choice for the new VFS is arbitrary.)^ 54387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 5439a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName); 5440a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt); 5441a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*); 54427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 54437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5444a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Mutexes 54457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 54467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The SQLite core uses these routines for thread 5447a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** synchronization. Though they are intended for internal 54487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** use by SQLite, code that links against SQLite is 54497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** permitted to use any of these routines. 54507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5451a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The SQLite source code contains multiple implementations 54527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** of these mutex routines. An appropriate implementation 5453a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is selected automatically at compile-time. ^(The following 54547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** implementations are available in the SQLite core: 54557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 54567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 54577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_OS2 545890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <li> SQLITE_MUTEX_PTHREADS 54597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_W32 54607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_NOOP 5461a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ul>)^ 54627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5463a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The SQLITE_MUTEX_NOOP implementation is a set of routines 5464a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that does no real locking and is appropriate for use in 5465a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a single-threaded application. ^The SQLITE_MUTEX_OS2, 546690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** SQLITE_MUTEX_PTHREADS, and SQLITE_MUTEX_W32 implementations 5467a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are appropriate for use on OS/2, Unix, and Windows. 5468a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5469a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor 54707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex 5471a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation is included with the library. In this case the 5472a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** application must supply a custom mutex implementation using the 5473a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function 5474a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** before calling sqlite3_initialize() or any other public sqlite3_ 5475a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** function that calls sqlite3_initialize().)^ 5476a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5477a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_mutex_alloc() routine allocates a new 5478a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** mutex and returns a pointer to it. ^If it returns NULL 5479a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that means that a mutex could not be allocated. ^SQLite 5480a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will unwind its stack and return an error. ^(The argument 54817790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** to sqlite3_mutex_alloc() is one of these integer constants: 54827790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 54837790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <ul> 54847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_FAST 54857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_RECURSIVE 54867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_STATIC_MASTER 54877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_STATIC_MEM 54887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_STATIC_MEM2 54897790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_STATIC_PRNG 54907790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_STATIC_LRU 54917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** <li> SQLITE_MUTEX_STATIC_LRU2 5492a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ul>)^ 54937790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5494a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) 5495a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** cause sqlite3_mutex_alloc() to create 5496a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE 5497a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is used but not necessarily so when SQLITE_MUTEX_FAST is used. 54987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The mutex implementation does not need to make a distinction 54997790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does 5500a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not want to. ^SQLite will only request a recursive mutex in 5501a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** cases where it really needs one. ^If a faster non-recursive mutex 55027790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** implementation is available on the host platform, the mutex subsystem 55037790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** might return such a mutex in response to SQLITE_MUTEX_FAST. 55047790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5505a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other 5506a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return 5507a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a pointer to a static preexisting mutex. ^Six static mutexes are 55087790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** used by the current version of SQLite. Future versions of SQLite 55097790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** may add additional static mutexes. Static mutexes are for internal 55107790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** use by SQLite only. Applications that use SQLite mutexes should 55117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or 55127790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLITE_MUTEX_RECURSIVE. 55137790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5514a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST 55157790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc() 5516a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returns a different mutex on every call. ^But for the static 55177790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** mutex types, the same mutex is returned on every call that has 5518a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the same type number. 55197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5520a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_mutex_free() routine deallocates a previously 5521a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocated dynamic mutex. ^SQLite is careful to deallocate every 5522a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** dynamic mutex that it allocates. The dynamic mutexes must not be in 5523a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** use when they are deallocated. Attempting to deallocate a static 5524a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** mutex results in undefined behavior. ^SQLite never deallocates 5525a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a static mutex. 55267790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5527a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt 5528a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to enter a mutex. ^If another thread is already within the mutex, 55297790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return 5530a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK] 5531a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** upon successful entry. ^(Mutexes created using 55327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread. 5533a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** In such cases the, 55347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** mutex must be exited an equal number of times before another thread 5535a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can enter.)^ ^(If the same thread tries to enter any other 55367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** kind of mutex more than once, the behavior is undefined. 5537a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite will never exhibit 5538a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** such behavior in its own use of mutexes.)^ 55397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5540a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Some systems (for example, Windows 95) do not support the operation 5541a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try() 5542a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will always return SQLITE_BUSY. The SQLite core only ever uses 5543a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_mutex_try() as an optimization so this is acceptable behavior.)^ 55447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5545a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_mutex_leave() routine exits a mutex that was 5546a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** previously entered by the same thread. ^(The behavior 55477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** is undefined if the mutex is not currently entered by the 5548a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** calling thread or is not currently allocated. SQLite will 5549a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** never do either.)^ 5550a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5551a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or 5552a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_mutex_leave() is a NULL pointer, then all three routines 5553a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** behave as no-ops. 55547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 55557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()]. 55567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 5557a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int); 5558a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_mutex_free(sqlite3_mutex*); 5559a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_mutex_enter(sqlite3_mutex*); 5560a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_mutex_try(sqlite3_mutex*); 5561a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*); 55627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 55637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5564a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Mutex Methods Object 5565a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5566a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** An instance of this structure defines the low-level routines 5567a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** used to allocate and use mutexes. 5568a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5569a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Usually, the default mutex implementations provided by SQLite are 5570a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sufficient, however the user has the option of substituting a custom 5571a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation for specialized deployments or systems for which SQLite 5572a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** does not provide a suitable implementation. In this case, the user 5573a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** creates and populates an instance of this structure to pass 5574a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option. 5575a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Additionally, an instance of this structure can be used as an 5576a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** output variable when querying the system for the current mutex 5577a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation, using the [SQLITE_CONFIG_GETMUTEX] option. 5578a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5579a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The xMutexInit method defined by this structure is invoked as 5580a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** part of system initialization by the sqlite3_initialize() function. 5581de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The xMutexInit routine is called by SQLite exactly once for each 5582a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** effective call to [sqlite3_initialize()]. 5583a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5584a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The xMutexEnd method defined by this structure is invoked as 5585a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** part of system shutdown by the sqlite3_shutdown() function. The 5586a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation of this method is expected to release all outstanding 5587a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** resources obtained by the mutex methods implementation, especially 5588a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** those obtained by the xMutexInit method. ^The xMutexEnd() 5589a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interface is invoked exactly once for each call to [sqlite3_shutdown()]. 5590a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5591a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The remaining seven methods defined by this structure (xMutexAlloc, 5592a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and 5593a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xMutexNotheld) implement the following interfaces (respectively): 5594a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5595a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <ul> 5596a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_mutex_alloc()] </li> 5597a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_mutex_free()] </li> 5598a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_mutex_enter()] </li> 5599a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_mutex_try()] </li> 5600a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_mutex_leave()] </li> 5601a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_mutex_held()] </li> 5602a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li> [sqlite3_mutex_notheld()] </li> 5603a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ul>)^ 5604a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5605a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The only difference is that the public sqlite3_XXX functions enumerated 5606a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** above silently ignore any invocations that pass a NULL pointer instead 5607a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of a valid mutex handle. The implementations of the methods defined 5608a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by this structure are not required to handle this case, the results 5609a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of passing a NULL pointer instead of a valid mutex handle are undefined 5610a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (i.e. it is acceptable to provide an implementation that segfaults if 5611a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it is passed a NULL pointer). 5612a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5613a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The xMutexInit() method must be threadsafe. ^It must be harmless to 5614de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** invoke xMutexInit() multiple times within the same process and without 5615a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** intervening calls to xMutexEnd(). Second and subsequent calls to 5616a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xMutexInit() must be no-ops. 5617a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5618a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()] 5619a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and its associates). ^Similarly, xMutexAlloc() must not use SQLite memory 5620a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** allocation for a static mutex. ^However xMutexAlloc() may use SQLite 5621a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory allocation for a fast or recursive mutex. 5622a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5623a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is 5624a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** called, but only if the prior call to xMutexInit returned SQLITE_OK. 5625a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If xMutexInit fails in any way, it is expected to clean up after itself 5626a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** prior to returning. 5627a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 5628a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noritypedef struct sqlite3_mutex_methods sqlite3_mutex_methods; 5629a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noristruct sqlite3_mutex_methods { 5630a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xMutexInit)(void); 5631a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xMutexEnd)(void); 5632a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori sqlite3_mutex *(*xMutexAlloc)(int); 5633a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xMutexFree)(sqlite3_mutex *); 5634a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xMutexEnter)(sqlite3_mutex *); 5635a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xMutexTry)(sqlite3_mutex *); 5636a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xMutexLeave)(sqlite3_mutex *); 5637a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xMutexHeld)(sqlite3_mutex *); 5638a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xMutexNotheld)(sqlite3_mutex *); 5639a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori}; 5640a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5641a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 5642a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Mutex Verification Routines 56437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 56447790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines 5645a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are intended for use inside assert() statements. ^The SQLite core 56467790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** never uses these routines except inside an assert() and applications 5647a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** are advised to follow the lead of the core. ^The SQLite core only 56487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** provides implementations for these routines when it is compiled 5649a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with the SQLITE_DEBUG flag. ^External mutex implementations 56507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** are only required to provide these routines if SQLITE_DEBUG is 56517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** defined and if NDEBUG is not defined. 56527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5653a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^These routines should return true if the mutex in their argument 5654a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is held or not held, respectively, by the calling thread. 56557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 565690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The implementation is not required to provide versions of these 5657a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routines that actually work. If the implementation does not provide working 5658a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** versions of these routines, it should at least provide stubs that always 5659a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** return true so that one does not get spurious assertion failures. 56607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5661a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the argument to sqlite3_mutex_held() is a NULL pointer then 5662a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the routine should return 1. This seems counter-intuitive since 566390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** clearly the mutex cannot be held if it does not exist. But 56647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the reason the mutex does not exist is because the build is not 56657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** using mutexes. And we do not want the assert() containing the 56667790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** call to sqlite3_mutex_held() to fail, so a non-zero return is 5667a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the appropriate thing to do. ^The sqlite3_mutex_notheld() 56687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** interface should also return 1 when given a NULL pointer. 56697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 5670a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#ifndef NDEBUG 5671a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_mutex_held(sqlite3_mutex*); 5672a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*); 5673a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#endif 56747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 56757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5676a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Mutex Types 5677a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5678a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [sqlite3_mutex_alloc()] interface takes a single argument 5679a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** which is one of these integer constants. 56807790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5681a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The set of static mutexes may change from one SQLite release to the 5682a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** next. Applications that override the built-in mutex logic must be 5683a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** prepared to accommodate additional static mutexes. 56847790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 56857790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MUTEX_FAST 0 56867790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MUTEX_RECURSIVE 1 56877790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MUTEX_STATIC_MASTER 2 56887790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */ 5689a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */ 5690a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */ 56917790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */ 56927790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */ 569390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */ 569490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */ 56957790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 56967790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5697a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Retrieve the mutex for a database connection 56987790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5699a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This interface returns a pointer the [sqlite3_mutex] object that 5700a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** serializes access to the [database connection] given in the argument 5701a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** when the [threading mode] is Serialized. 5702a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the [threading mode] is Single-thread or Multi-thread then this 5703a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** routine returns a NULL pointer. 5704a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 5705a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*); 5706a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5707a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 5708a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Low-Level Control Of Database Files 5709a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5710a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_file_control()] interface makes a direct call to the 57117790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** xFileControl method for the [sqlite3_io_methods] object associated 5712a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** with a particular database identified by the second argument. ^The 571395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** name of the database is "main" for the main database or "temp" for the 5714a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** TEMP database, or the name that appears after the AS keyword for 5715a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** databases that are added using the [ATTACH] SQL command. 5716a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A NULL pointer can be used in place of "main" to refer to the 5717a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** main database file. 5718a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The third and fourth parameters to this routine 57197790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** are passed directly through to the second and third parameters of 5720a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the xFileControl method. ^The return value of the xFileControl 57217790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** method becomes the return value of this routine. 57227790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 572395c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** ^The SQLITE_FCNTL_FILE_POINTER value for the op parameter causes 572495c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** a pointer to the underlying [sqlite3_file] object to be written into 572595c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** the space pointed to by the 4th parameter. ^The SQLITE_FCNTL_FILE_POINTER 572695c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** case is a short-circuit path which does not actually invoke the 572795c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** underlying sqlite3_io_methods.xFileControl method. 572895c34edce550d0869113085e0cd1b6b09e8fe38bVasu Nori** 5729a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the second parameter (zDbName) does not match the name of any 5730a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** open database file, then SQLITE_ERROR is returned. ^This error 57317790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** code is not remembered and will not be recalled by [sqlite3_errcode()] 5732a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or [sqlite3_errmsg()]. The underlying xFileControl method might 5733a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** also return SQLITE_ERROR. There is no way to distinguish between 57347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** an incorrect zDbName and an SQLITE_ERROR return from the underlying 5735a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xFileControl method. 57367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 57377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** See also: [SQLITE_FCNTL_LOCKSTATE] 57387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 5739a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*); 57407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 57417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5742a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Testing Interface 57437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5744a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_test_control() interface is used to read out internal 57457790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** state of SQLite and to inject faults into SQLite for testing 5746a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** purposes. ^The first parameter is an operation code that determines 57477790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** the number, meaning, and operation of all subsequent parameters. 57487790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 57497790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** This interface is not for use by applications. It exists solely 57507790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** for verifying the correct operation of the SQLite library. Depending 57517790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** on how the SQLite library is compiled, this interface might not exist. 57527790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 57537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** The details of the operation codes, their meanings, the parameters 57547790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** they take, and what they do are all subject to change without notice. 57557790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Unlike most of the SQLite API, this function is not guaranteed to 57567790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** operate consistently from one release to the next. 57577790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 5758a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_test_control(int op, ...); 57597790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 57607790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 5761a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Testing Interface Operation Codes 57627790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 57637790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** These constants are the valid operation code parameters used 57647790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** as the first argument to [sqlite3_test_control()]. 57657790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 5766a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These parameters and their meanings are subject to change 57677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** without notice. These values are for testing purposes only. 57687790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Applications should not use any of these parameters or the 57697790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** [sqlite3_test_control()] interface. 57707790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 5771a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_FIRST 5 57727790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_TESTCTRL_PRNG_SAVE 5 57737790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_TESTCTRL_PRNG_RESTORE 6 57747790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_TESTCTRL_PRNG_RESET 7 57757790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#define SQLITE_TESTCTRL_BITVEC_TEST 8 5776a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_FAULT_INSTALL 9 5777a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10 5778a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_PENDING_BYTE 11 5779a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_ASSERT 12 5780a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_ALWAYS 13 5781a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_RESERVE 14 5782a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_OPTIMIZATIONS 15 5783a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_TESTCTRL_ISKEYWORD 16 578490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_TESTCTRL_SCRATCHMALLOC 17 578590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_TESTCTRL_LOCALTIME_FAULT 18 578690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_TESTCTRL_EXPLAIN_STMT 19 578790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_TESTCTRL_LAST 19 5788a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5789a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 5790a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: SQLite Runtime Status 5791a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5792a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This interface is used to retrieve runtime status information 5793de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** about the performance of SQLite, and optionally to reset various 5794a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** highwater marks. ^The first argument is an integer code for 5795a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the specific parameter to measure. ^(Recognized integer codes 579690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** are of the form [status parameters | SQLITE_STATUS_...].)^ 5797a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The current value of the parameter is returned into *pCurrent. 5798a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The highest recorded value is returned in *pHighwater. ^If the 5799a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** resetFlag is true, then the highest record value is reset after 5800a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** *pHighwater is written. ^(Some parameters do not record the highest 5801a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value. For those parameters 5802a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** nothing is written into *pHighwater and the resetFlag is ignored.)^ 5803a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Other parameters record only the highwater mark and not the current 5804a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value. For these latter parameters nothing is written into *pCurrent.)^ 5805a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5806de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The sqlite3_status() routine returns SQLITE_OK on success and a 5807a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** non-zero [error code] on failure. 5808a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5809a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This routine is threadsafe but is not atomic. This routine can be 5810a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** called while other threads are running the same or different SQLite 5811a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interfaces. However the values returned in *pCurrent and 5812a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** *pHighwater reflect the status of SQLite at different points in time 5813a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and it is possible that another thread might change the parameter 5814a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in between the times when *pCurrent and *pHighwater are written. 5815a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5816a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also: [sqlite3_db_status()] 5817a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 581871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag); 5819a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5820a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5821a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 5822a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Status Parameters 582390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** KEYWORDS: {status parameters} 5824a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5825a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These integer constants designate various run-time status parameters 5826a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that can be returned by [sqlite3_status()]. 5827a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5828a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dl> 582990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STATUS_MEMORY_USED]] ^(<dt>SQLITE_STATUS_MEMORY_USED</dt> 5830a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter is the current amount of memory checked out 5831a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** using [sqlite3_malloc()], either directly or indirectly. The 5832a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** figure includes calls made to [sqlite3_malloc()] by the application 5833a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and internal memory usage by the SQLite library. Scratch memory 5834a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache 5835a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in 5836a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** this parameter. The amount returned is the sum of the allocation 5837a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^ 5838a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 583990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STATUS_MALLOC_SIZE]] ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt> 5840a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter records the largest memory allocation request 5841a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their 5842a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** internal equivalents). Only the value returned in the 5843a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** *pHighwater parameter to [sqlite3_status()] is of interest. 5844a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The value written into the *pCurrent parameter is undefined.</dd>)^ 5845a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 584690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STATUS_MALLOC_COUNT]] ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt> 584790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd>This parameter records the number of separate memory allocations 584890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** currently checked out.</dd>)^ 5849de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 585090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STATUS_PAGECACHE_USED]] ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt> 5851a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter returns the number of pages used out of the 5852a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [pagecache memory allocator] that was configured using 5853a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_CONFIG_PAGECACHE]. The 5854a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value returned is in pages, not in bytes.</dd>)^ 5855a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 585690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]] 5857a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt> 5858a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter returns the number of bytes of page cache 5859de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE] 5860a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** buffer and where forced to overflow to [sqlite3_malloc()]. The 5861a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned value includes allocations that overflowed because they 5862a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** where too large (they were larger than the "sz" parameter to 5863a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because 5864a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** no space was left in the page cache.</dd>)^ 5865a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 586690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt> 5867a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter records the largest memory allocation request 5868a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** handed to [pagecache memory allocator]. Only the value returned in the 5869a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** *pHighwater parameter to [sqlite3_status()] is of interest. 5870a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The value written into the *pCurrent parameter is undefined.</dd>)^ 5871a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 587290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STATUS_SCRATCH_USED]] ^(<dt>SQLITE_STATUS_SCRATCH_USED</dt> 5873a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter returns the number of allocations used out of the 5874a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [scratch memory allocator] configured using 5875a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not 5876a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in bytes. Since a single thread may only have one scratch allocation 5877a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** outstanding at time, this parameter also reports the number of threads 5878a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** using scratch memory at the same time.</dd>)^ 5879a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 588090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt> 5881a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter returns the number of bytes of scratch memory 5882de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** allocation which could not be satisfied by the [SQLITE_CONFIG_SCRATCH] 5883a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** buffer and where forced to overflow to [sqlite3_malloc()]. The values 5884a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned include overflows because the requested allocation was too 5885a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** larger (that is, because the requested allocation was larger than the 5886a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer 5887a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** slots were available. 5888a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dd>)^ 5889a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 589090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STATUS_SCRATCH_SIZE]] ^(<dt>SQLITE_STATUS_SCRATCH_SIZE</dt> 5891a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter records the largest memory allocation request 5892a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** handed to [scratch memory allocator]. Only the value returned in the 5893a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** *pHighwater parameter to [sqlite3_status()] is of interest. 5894a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The value written into the *pCurrent parameter is undefined.</dd>)^ 5895a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 589690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt> 5897a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter records the deepest parser stack. It is only 5898a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^ 5899a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dl> 5900a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5901a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** New status parameters may be added from time to time. 5902a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 5903a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_MEMORY_USED 0 5904a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_PAGECACHE_USED 1 5905a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_PAGECACHE_OVERFLOW 2 5906a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_SCRATCH_USED 3 5907a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_SCRATCH_OVERFLOW 4 5908a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_MALLOC_SIZE 5 5909a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_PARSER_STACK 6 5910a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_PAGECACHE_SIZE 7 5911a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STATUS_SCRATCH_SIZE 8 5912de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori#define SQLITE_STATUS_MALLOC_COUNT 9 5913a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5914a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 5915a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Database Connection Status 5916a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5917a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This interface is used to retrieve runtime status information 5918a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** about a single [database connection]. ^The first argument is the 5919a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database connection object to be interrogated. ^The second argument 592071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** is an integer constant, taken from the set of 592190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SQLITE_DBSTATUS options], that 5922de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** determines the parameter to interrogate. The set of 592390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SQLITE_DBSTATUS options] is likely 592471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** to grow in future releases of SQLite. 5925a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5926a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The current value of the requested parameter is written into *pCur 5927a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and the highest instantaneous value is written into *pHiwtr. ^If 5928a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the resetFlg is true, then the highest instantaneous value is 5929a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** reset back down to the current value. 5930a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5931de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a 5932de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** non-zero [error code] on failure. 5933de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 5934a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also: [sqlite3_status()] and [sqlite3_stmt_status()]. 5935a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 593671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg); 5937a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 5938a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 5939a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Status Parameters for database connections 594090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** KEYWORDS: {SQLITE_DBSTATUS options} 5941a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5942a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These constants are the available integer "verbs" that can be passed as 5943a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the second argument to the [sqlite3_db_status()] interface. 5944a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5945a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** New verbs may be added in future releases of SQLite. Existing verbs 5946a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** might be discontinued. Applications should check the return code from 5947a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_db_status()] to make sure that the call worked. 5948a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [sqlite3_db_status()] interface will return a non-zero error code 5949a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** if a discontinued or unsupported verb is invoked. 5950a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 5951a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dl> 595290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_DBSTATUS_LOOKASIDE_USED]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt> 5953a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>This parameter returns the number of lookaside memory slots currently 5954a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** checked out.</dd>)^ 595571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 595690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt> 595790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd>This parameter returns the number malloc attempts that were 595890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** satisfied using lookaside memory. Only the high-water value is meaningful; 595990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the current value is always zero.)^ 596090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 596190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE]] 596290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt> 596390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd>This parameter returns the number malloc attempts that might have 596490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** been satisfied using lookaside memory but failed due to the amount of 596590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** memory requested being larger than the lookaside slot size. 596690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Only the high-water value is meaningful; 596790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the current value is always zero.)^ 596890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 596990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL]] 597090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt> 597190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd>This parameter returns the number malloc attempts that might have 597290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** been satisfied using lookaside memory but failed due to all lookaside 597390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** memory already being in use. 597490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Only the high-water value is meaningful; 597590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the current value is always zero.)^ 597690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 597790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_DBSTATUS_CACHE_USED]] ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt> 5978de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <dd>This parameter returns the approximate number of of bytes of heap 5979de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** memory used by all pager caches associated with the database connection.)^ 598071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0. 5981de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 598290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt> 5983de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <dd>This parameter returns the approximate number of of bytes of heap 5984de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** memory used to store the schema for all databases associated 5985de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** with the connection - main, temp, and any [ATTACH]-ed databases.)^ 5986de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The full amount of memory used by the schemas is reported, even if the 5987de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** schema memory is shared with other database connections due to 5988de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** [shared cache mode] being enabled. 5989de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0. 5990de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 599190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_DBSTATUS_STMT_USED]] ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt> 5992de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** <dd>This parameter returns the approximate number of of bytes of heap 5993de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** and lookaside memory used by all prepared statements associated with 5994de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the database connection.)^ 5995de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0. 5996de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** </dd> 599790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 599890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_DBSTATUS_CACHE_HIT]] ^(<dt>SQLITE_DBSTATUS_CACHE_HIT</dt> 599990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd>This parameter returns the number of pager cache hits that have 600090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT 600190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is always 0. 600290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** </dd> 600390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 600490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_DBSTATUS_CACHE_MISS]] ^(<dt>SQLITE_DBSTATUS_CACHE_MISS</dt> 600590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd>This parameter returns the number of pager cache misses that have 600690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS 600790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is always 0. 600890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** </dd> 6009a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dl> 6010a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 601190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBSTATUS_LOOKASIDE_USED 0 601290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBSTATUS_CACHE_USED 1 601390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBSTATUS_SCHEMA_USED 2 601490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBSTATUS_STMT_USED 3 601590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBSTATUS_LOOKASIDE_HIT 4 601690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE 5 601790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6 601890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBSTATUS_CACHE_HIT 7 601990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBSTATUS_CACHE_MISS 8 602090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_DBSTATUS_MAX 8 /* Largest defined DBSTATUS */ 6021a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6022a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6023a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 6024a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Prepared Statement Status 6025a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6026a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(Each prepared statement maintains various 602790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SQLITE_STMTSTATUS counters] that measure the number 6028a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of times it has performed specific operations.)^ These counters can 6029a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** be used to monitor the performance characteristics of the prepared 6030a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** statements. For example, if the number of table steps greatly exceeds 6031a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the number of table searches or result rows, that would tend to indicate 6032a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that the prepared statement is using a full table scan rather than 6033a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an index. 6034a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6035a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(This interface is used to retrieve and reset counter values from 6036a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a [prepared statement]. The first argument is the prepared statement 6037a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** object to be interrogated. The second argument 603890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is an integer code for a specific [SQLITE_STMTSTATUS counter] 6039a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to be interrogated.)^ 6040a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The current value of the requested counter is returned. 6041a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the resetFlg is true, then the counter is reset to zero after this 6042a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** interface call returns. 6043a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6044a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See also: [sqlite3_status()] and [sqlite3_db_status()]. 6045a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 604671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg); 6047a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6048a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 6049a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Status Parameters for prepared statements 605090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** KEYWORDS: {SQLITE_STMTSTATUS counter} {SQLITE_STMTSTATUS counters} 6051a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6052a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** These preprocessor macros define integer codes that name counter 6053a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** values associated with the [sqlite3_stmt_status()] interface. 6054a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The meanings of the various counters are as follows: 6055a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6056a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dl> 605790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]] <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt> 6058a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>^This is the number of times that SQLite has stepped forward in 6059a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a table as part of a full table scan. Large numbers for this counter 6060a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** may indicate opportunities for performance improvement through 6061a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** careful use of indices.</dd> 6062a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 606390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STMTSTATUS_SORT]] <dt>SQLITE_STMTSTATUS_SORT</dt> 6064a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <dd>^This is the number of sort operations that have occurred. 6065a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A non-zero value in this counter may indicate an opportunity to 6066a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** improvement performance through careful use of indices.</dd> 6067a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 606890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[SQLITE_STMTSTATUS_AUTOINDEX]] <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt> 606971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <dd>^This is the number of rows inserted into transient indices that 607071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** were created automatically in order to help joins run faster. 607171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** A non-zero value in this counter may indicate an opportunity to 607271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** improvement performance by adding permanent indices that do not 607371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** need to be reinitialized each time the statement is run.</dd> 6074a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </dl> 6075a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 6076a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STMTSTATUS_FULLSCAN_STEP 1 6077a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori#define SQLITE_STMTSTATUS_SORT 2 607871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori#define SQLITE_STMTSTATUS_AUTOINDEX 3 6079a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6080a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 6081a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Custom Page Cache Object 6082a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6083a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_pcache type is opaque. It is implemented by 6084a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the pluggable module. The SQLite core has no knowledge of 6085a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** its size or internal structure and never deals with the 6086a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_pcache object except by holding and passing pointers 6087a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the object. 6088a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 608990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** See [sqlite3_pcache_methods2] for additional information. 6090a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 6091a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noritypedef struct sqlite3_pcache sqlite3_pcache; 6092a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6093a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 609490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CAPI3REF: Custom Page Cache Object 609590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 609690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The sqlite3_pcache_page object represents a single page in the 609790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** page cache. The page cache will allocate instances of this 609890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** object. Various methods of the page cache use pointers to instances 609990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** of this object as parameters or as their return value. 610090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 610190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** See [sqlite3_pcache_methods2] for additional information. 610290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 610390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Browntypedef struct sqlite3_pcache_page sqlite3_pcache_page; 610490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brownstruct sqlite3_pcache_page { 610590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown void *pBuf; /* The content of the page */ 610690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown void *pExtra; /* Extra information associated with the page */ 610790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown}; 610890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 610990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 6110a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Application Defined Page Cache. 6111a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** KEYWORDS: {page cache} 6112a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 611390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE2], ...) interface can 6114a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** register an alternative page cache implementation by passing in an 611590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** instance of the sqlite3_pcache_methods2 structure.)^ 6116de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** In many applications, most of the heap memory allocated by 6117de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** SQLite is used for the page cache. 6118de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** By implementing a 6119de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** custom page cache using this API, an application can better control 6120de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the amount of memory consumed by SQLite, the way in which 6121a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that memory is allocated and released, and the policies used to 6122a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** determine exactly which parts of a database file are cached and for 6123a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** how long. 6124a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6125de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The alternative page cache mechanism is an 6126de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** extreme measure that is only needed by the most demanding applications. 6127de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The built-in page cache is recommended for most uses. 6128de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 612990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^(The contents of the sqlite3_pcache_methods2 structure are copied to an 6130a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** internal buffer by SQLite within the call to [sqlite3_config]. Hence 6131a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the application may discard the parameter after the call to 6132a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_config()] returns.)^ 6133a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 613490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[the xInit() page cache method]] 6135de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^(The xInit() method is called once for each effective 6136de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** call to [sqlite3_initialize()])^ 6137a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** (usually only once during the lifetime of the process). ^(The xInit() 613890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** method is passed a copy of the sqlite3_pcache_methods2.pArg value.)^ 6139de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The intent of the xInit() method is to set up global data structures 6140a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** required by the custom page cache implementation. 6141de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^(If the xInit() method is NULL, then the 6142de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** built-in default page cache is used instead of the application defined 6143de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** page cache.)^ 6144a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 614590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[the xShutdown() page cache method]] 6146de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The xShutdown() method is called by [sqlite3_shutdown()]. 6147de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** It can be used to clean up 6148a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** any outstanding resources before process shutdown, if required. 6149de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^The xShutdown() method may be NULL. 6150a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6151de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^SQLite automatically serializes calls to the xInit method, 6152de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** so the xInit method need not be threadsafe. ^The 6153a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** xShutdown method is only called from [sqlite3_shutdown()] so it does 6154a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not need to be threadsafe either. All other methods must be threadsafe 6155a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** in multithreaded applications. 6156a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6157a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^SQLite will never invoke xInit() more than once without an intervening 6158a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** call to xShutdown(). 6159a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 616090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[the xCreate() page cache methods]] 6161de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^SQLite invokes the xCreate() method to construct a new cache instance. 6162de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** SQLite will typically create one cache instance for each open database file, 6163a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** though this is not guaranteed. ^The 6164a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** first parameter, szPage, is the size in bytes of the pages that must 616590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** be allocated by the cache. ^szPage will always a power of two. ^The 616690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** second parameter szExtra is a number of bytes of extra storage 616790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** associated with each page cache entry. ^The szExtra parameter will 616890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** a number less than 250. SQLite will use the 616990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** extra szExtra bytes on each page to store metadata about the underlying 617090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** database page on disk. The value passed into szExtra depends 6171a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on the SQLite version, the target platform, and how SQLite was compiled. 617290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The third argument to xCreate(), bPurgeable, is true if the cache being 617390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** created will be used to cache database pages of a file stored on disk, or 6174de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** false if it is used for an in-memory database. The cache implementation 6175a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** does not have to do anything special based with the value of bPurgeable; 6176a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will 6177a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** never invoke xUnpin() except to deliberately delete a page. 6178de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^In other words, calls to xUnpin() on a cache with bPurgeable set to 6179de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** false will always have the "discard" flag set to true. 6180de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^Hence, a cache created with bPurgeable false will 6181a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** never contain any unpinned pages. 6182a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 618390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[the xCachesize() page cache method]] 6184a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(The xCachesize() method may be called at any time by SQLite to set the 6185a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** suggested maximum cache-size (number of pages stored by) the cache 6186a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** instance passed as the first argument. This is the value configured using 6187de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable 6188a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** parameter, the implementation is not required to do anything with this 6189a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** value; it is advisory only. 6190a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 619190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[the xPagecount() page cache methods]] 6192de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The xPagecount() method must return the number of pages currently 6193de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** stored in the cache, both pinned and unpinned. 6194a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 619590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[the xFetch() page cache methods]] 6196de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The xFetch() method locates a page in the cache and returns a pointer to 619790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** an sqlite3_pcache_page object associated with that page, or a NULL pointer. 619890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The pBuf element of the returned sqlite3_pcache_page object will be a 619990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** pointer to a buffer of szPage bytes used to store the content of a 620090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** single database page. The pExtra element of sqlite3_pcache_page will be 620190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** a pointer to the szExtra bytes of extra storage that SQLite has requested 620290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** for each entry in the page cache. 620390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 620490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The page to be fetched is determined by the key. ^The minimum key value 620590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is 1. After it has been retrieved using xFetch, the page is considered 620690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** to be "pinned". 6207a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6208de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** If the requested page is already in the page cache, then the page cache 6209a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** implementation must return a pointer to the page buffer with its content 6210de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** intact. If the requested page is not already in the cache, then the 621190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** cache implementation should use the value of the createFlag 6212de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** parameter to help it determined what action to take: 6213a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6214a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <table border=1 width=85% align=center> 6215a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><th> createFlag <th> Behaviour when page is not already in cache 6216a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 0 <td> Do not allocate a new page. Return NULL. 6217a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so. 6218a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Otherwise return NULL. 6219a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <tr><td> 2 <td> Make every effort to allocate a new page. Only return 6220a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** NULL if allocating a new page is effectively impossible. 6221de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** </table> 6222a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6223de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite 6224de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** will only use a createFlag of 2 after a prior call with a createFlag of 1 6225de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** failed.)^ In between the to xFetch() calls, SQLite may 6226a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** attempt to unpin one or more cache pages by spilling the content of 6227de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** pinned pages to disk and synching the operating system disk cache. 6228a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 622990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[the xUnpin() page cache method]] 6230a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^xUnpin() is called by SQLite with a pointer to a currently pinned page 6231de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** as its second argument. If the third parameter, discard, is non-zero, 6232de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** then the page must be evicted from the cache. 6233de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** ^If the discard parameter is 6234de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** zero, then the page may be discarded or retained at the discretion of 6235de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** page cache implementation. ^The page cache implementation 6236a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** may choose to evict unpinned pages at any time. 6237a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6238de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The cache must not perform any reference counting. A single 6239a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** call to xUnpin() unpins the page regardless of the number of prior calls 6240de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** to xFetch(). 6241a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 624290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[the xRekey() page cache methods]] 6243de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The xRekey() method is used to change the key value associated with the 6244de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** page passed as the second argument. If the cache 6245de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** previously contains an entry associated with newKey, it must be 6246a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** discarded. ^Any prior cache entry associated with newKey is guaranteed not 6247a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to be pinned. 6248a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6249de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** When SQLite calls the xTruncate() method, the cache must discard all 6250a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** existing cache entries with page numbers (keys) greater than or equal 6251de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** to the value of the iLimit parameter passed to xTruncate(). If any 6252a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** of these pages are pinned, they are implicitly unpinned, meaning that 6253a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** they can be safely discarded. 6254a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 625590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[the xDestroy() page cache method]] 6256a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The xDestroy() method is used to delete a cache allocated by xCreate(). 6257a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** All resources associated with the specified cache should be freed. ^After 6258a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*] 625990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** handle invalid, and will not use it with any other sqlite3_pcache_methods2 6260a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** functions. 626190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 626290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[the xShrink() page cache method]] 626390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^SQLite invokes the xShrink() method when it wants the page cache to 626490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** free up as much of heap memory as possible. The page cache implementation 626590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is not obligated to free any memory, but well-behaved implementations should 626690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** do their best. 626790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 626890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Browntypedef struct sqlite3_pcache_methods2 sqlite3_pcache_methods2; 626990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brownstruct sqlite3_pcache_methods2 { 627090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown int iVersion; 627190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown void *pArg; 627290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown int (*xInit)(void*); 627390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown void (*xShutdown)(void*); 627490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown sqlite3_pcache *(*xCreate)(int szPage, int szExtra, int bPurgeable); 627590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown void (*xCachesize)(sqlite3_pcache*, int nCachesize); 627690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown int (*xPagecount)(sqlite3_pcache*); 627790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown sqlite3_pcache_page *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); 627890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown void (*xUnpin)(sqlite3_pcache*, sqlite3_pcache_page*, int discard); 627990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown void (*xRekey)(sqlite3_pcache*, sqlite3_pcache_page*, 628090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown unsigned oldKey, unsigned newKey); 628190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); 628290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown void (*xDestroy)(sqlite3_pcache*); 628390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown void (*xShrink)(sqlite3_pcache*); 628490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown}; 628590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 628690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 628790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** This is the obsolete pcache_methods object that has now been replaced 628890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** by sqlite3_pcache_methods2. This object is not used by SQLite. It is 628990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** retained in the header file for backwards compatibility only. 6290a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 6291a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noritypedef struct sqlite3_pcache_methods sqlite3_pcache_methods; 6292a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noristruct sqlite3_pcache_methods { 6293a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *pArg; 6294a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xInit)(void*); 6295a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xShutdown)(void*); 6296a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable); 6297a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xCachesize)(sqlite3_pcache*, int nCachesize); 6298a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori int (*xPagecount)(sqlite3_pcache*); 6299a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); 6300a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xUnpin)(sqlite3_pcache*, void*, int discard); 6301a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey); 6302a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); 6303a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xDestroy)(sqlite3_pcache*); 6304a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori}; 6305a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 630690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 6307a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 6308a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Online Backup Object 6309a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6310a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_backup object records state information about an ongoing 6311a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** online backup operation. ^The sqlite3_backup object is created by 6312a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a call to [sqlite3_backup_init()] and is destroyed by a call to 6313a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_backup_finish()]. 6314a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6315a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See Also: [Using the SQLite Online Backup API] 6316a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 6317a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Noritypedef struct sqlite3_backup sqlite3_backup; 6318a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6319a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 6320a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Online Backup API. 6321a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6322a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The backup API copies the content of one database into another. 6323a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** It is useful either for creating backups of databases or 6324a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** for copying in-memory databases to or from persistent files. 6325a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6326a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See Also: [Using the SQLite Online Backup API] 6327a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 632890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^SQLite holds a write transaction open on the destination database file 632990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** for the duration of the backup operation. 633090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^The source database is read-locked only while it is being read; 633190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** it is not locked continuously for the entire backup operation. 633290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ^Thus, the backup may be performed on a live source database without 633390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** preventing other database connections from 6334a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** reading or writing to the source database while the backup is underway. 6335a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6336a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(To perform a backup operation: 6337a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <ol> 6338a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li><b>sqlite3_backup_init()</b> is called once to initialize the 6339a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** backup, 6340a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer 6341a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the data between the two databases, and finally 6342a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <li><b>sqlite3_backup_finish()</b> is called to release all resources 6343a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** associated with the backup operation. 6344a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** </ol>)^ 6345a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** There should be exactly one call to sqlite3_backup_finish() for each 6346a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** successful call to sqlite3_backup_init(). 6347a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 634890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[sqlite3_backup_init()]] <b>sqlite3_backup_init()</b> 6349a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6350a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the 6351a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection] associated with the destination database 6352a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and the database name, respectively. 6353a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The database name is "main" for the main database, "temp" for the 6354a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** temporary database, or the name specified after the AS keyword in 6355a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an [ATTACH] statement for an attached database. 6356a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The S and M arguments passed to 6357a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_init(D,N,S,M) identify the [database connection] 6358a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and database name of the source database, respectively. 6359a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The source and destination [database connections] (parameters S and D) 636090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** must be different or else sqlite3_backup_init(D,N,S,M) will fail with 6361a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an error. 6362a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6363a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is 636490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** returned and an error code and error message are stored in the 6365a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** destination [database connection] D. 6366a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The error code and message for the failed call to sqlite3_backup_init() 6367a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or 6368a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_errmsg16()] functions. 6369a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A successful call to sqlite3_backup_init() returns a pointer to an 6370a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [sqlite3_backup] object. 6371a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and 6372a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_finish() functions to perform the specified backup 6373a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** operation. 6374a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 637590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[sqlite3_backup_step()]] <b>sqlite3_backup_step()</b> 6376a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6377a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Function sqlite3_backup_step(B,N) will copy up to N pages between 6378a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the source and destination databases specified by [sqlite3_backup] object B. 6379a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If N is negative, all remaining source pages are copied. 6380a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_backup_step(B,N) successfully copies N pages and there 638190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** are still more pages to be copied, then the function returns [SQLITE_OK]. 6382a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages 6383a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from source to destination, then it returns [SQLITE_DONE]. 6384a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If an error occurs while running sqlite3_backup_step(B,N), 6385a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then an [error code] is returned. ^As well as [SQLITE_OK] and 6386a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY], 6387a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an 6388a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code. 6389a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 639071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^(The sqlite3_backup_step() might return [SQLITE_READONLY] if 639171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <ol> 639271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <li> the destination database was opened read-only, or 639371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** <li> the destination database is using write-ahead-log journaling 639471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** and the destination and source page sizes differ, or 639590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <li> the destination database is an in-memory database and the 639671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** destination and source page sizes differ. 639771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** </ol>)^ 6398a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6399a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then 6400a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [sqlite3_busy_handler | busy-handler function] 6401a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is invoked (if one is specified). ^If the 6402a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** busy-handler returns non-zero before the lock is available, then 6403a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_BUSY] is returned to the caller. ^In this case the call to 6404a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_step() can be retried later. ^If the source 6405a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection] 6406a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is being used to write to the source database when sqlite3_backup_step() 6407a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this 6408a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** case the call to sqlite3_backup_step() can be retried later on. ^(If 6409a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or 6410a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_READONLY] is returned, then 6411a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** there is no point in retrying the call to sqlite3_backup_step(). These 6412a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** errors are considered fatal.)^ The application must accept 6413a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that the backup operation has failed and pass the backup operation handle 6414a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** to the sqlite3_backup_finish() to release associated resources. 6415a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6416a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The first call to sqlite3_backup_step() obtains an exclusive lock 6417a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** on the destination file. ^The exclusive lock is not released until either 6418a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_finish() is called or the backup operation is complete 6419a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and sqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to 6420a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_step() obtains a [shared lock] on the source database that 6421a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** lasts for the duration of the sqlite3_backup_step() call. 6422a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Because the source database is not locked between calls to 6423a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_step(), the source database may be modified mid-way 6424a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** through the backup process. ^If the source database is modified by an 6425a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** external process or via a database connection other than the one being 6426a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** used by the backup operation, then the backup will be automatically 6427a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** restarted by the next call to sqlite3_backup_step(). ^If the source 6428a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database is modified by the using the same database connection as is used 6429a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by the backup operation, then the backup database is automatically 6430a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** updated at the same time. 6431a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 643290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[sqlite3_backup_finish()]] <b>sqlite3_backup_finish()</b> 6433a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6434a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the 6435a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** application wishes to abandon the backup operation, the application 6436a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish(). 6437a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The sqlite3_backup_finish() interfaces releases all 6438a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** resources associated with the [sqlite3_backup] object. 6439a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any 6440a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** active write-transaction on the destination database is rolled back. 6441a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [sqlite3_backup] object is invalid 6442a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and may not be used following a call to sqlite3_backup_finish(). 6443a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6444a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no 6445a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_step() errors occurred, regardless or whether or not 6446a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_step() completed. 6447a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If an out-of-memory condition or IO error occurred during any prior 6448a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_step() call on the same [sqlite3_backup] object, then 6449a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_finish() returns the corresponding [error code]. 6450a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6451a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step() 6452a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not a permanent error and does not affect the return value of 6453a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_finish(). 6454a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 645590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [[sqlite3_backup__remaining()]] [[sqlite3_backup_pagecount()]] 645690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <b>sqlite3_backup_remaining() and sqlite3_backup_pagecount()</b> 6457a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6458a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Each call to sqlite3_backup_step() sets two values inside 6459a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the [sqlite3_backup] object: the number of pages still to be backed 6460de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** up and the total number of pages in the source database file. 6461a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The sqlite3_backup_remaining() and sqlite3_backup_pagecount() interfaces 6462a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** retrieve these two values, respectively. 6463a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6464a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The values returned by these functions are only updated by 6465a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_step(). ^If the source database is modified during a backup 6466a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** operation, then the values are not updated to account for any extra 6467a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** pages that need to be updated or the size of the source database file 6468a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** changing. 6469a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6470a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <b>Concurrent Usage of Database Handles</b> 6471a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6472a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^The source [database connection] may be used by the application for other 6473a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** purposes while a backup operation is underway or being initialized. 6474a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If SQLite is compiled and configured to support threadsafe database 6475a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** connections, then the source database connection may be used concurrently 6476a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from within other threads. 6477a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6478a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** However, the application must guarantee that the destination 6479a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [database connection] is not passed to any other API (by any thread) after 6480a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_init() is called and before the corresponding call to 6481a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_backup_finish(). SQLite does not currently check to see 6482a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** if the application incorrectly accesses the destination [database connection] 6483a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and so no error code is reported, but the operations may malfunction 6484a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** nevertheless. Use of the destination database connection while a 6485a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** backup is in progress might also also cause a mutex deadlock. 6486a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6487a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If running in [shared cache mode], the application must 6488a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** guarantee that the shared cache used by the destination database 6489a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** is not accessed while the backup is running. In practice this means 6490a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that the application must guarantee that the disk file being 6491a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** backed up to is not accessed by any connection within the process, 6492a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** not just the specific connection that was passed to sqlite3_backup_init(). 6493a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6494a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The [sqlite3_backup] object itself is partially threadsafe. Multiple 6495a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** threads may safely make multiple concurrent calls to sqlite3_backup_step(). 6496a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount() 6497a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** APIs are not strictly speaking threadsafe. If they are invoked at the 6498a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** same time as another thread is invoking sqlite3_backup_step() it is 6499a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** possible that they return invalid values. 6500a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 6501a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API sqlite3_backup *sqlite3_backup_init( 6502a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori sqlite3 *pDest, /* Destination database handle */ 6503a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori const char *zDestName, /* Destination database name */ 6504a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori sqlite3 *pSource, /* Source database handle */ 6505a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori const char *zSourceName /* Source database name */ 6506a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori); 6507a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_backup_step(sqlite3_backup *p, int nPage); 6508a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_backup_finish(sqlite3_backup *p); 6509a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_backup_remaining(sqlite3_backup *p); 6510a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p); 6511a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6512a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 6513a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: Unlock Notification 6514a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6515a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^When running in shared-cache mode, a database operation may fail with 6516a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an [SQLITE_LOCKED] error if the required locks on the shared-cache or 6517a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** individual tables within the shared-cache cannot be obtained. See 6518a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLite Shared-Cache Mode] for a description of shared-cache locking. 6519a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This API may be used to register a callback that SQLite will invoke 6520a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** when the connection currently holding the required lock relinquishes it. 6521a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^This API is only available if the library was compiled with the 6522a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined. 6523a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6524a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** See Also: [Using the SQLite Unlock Notification Feature]. 6525a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6526a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Shared-cache locks are released when a database connection concludes 6527a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** its current transaction, either by committing it or rolling it back. 6528a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6529a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^When a connection (known as the blocked connection) fails to obtain a 6530a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** shared-cache lock and SQLITE_LOCKED is returned to the caller, the 6531a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** identity of the database connection (the blocking connection) that 6532a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** has locked the required resource is stored internally. ^After an 6533a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** application receives an SQLITE_LOCKED error, it may call the 6534a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_unlock_notify() method with the blocked connection handle as 6535a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the first argument to register for a callback that will be invoked 6536a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** when the blocking connections current transaction is concluded. ^The 6537a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** callback is invoked from within the [sqlite3_step] or [sqlite3_close] 6538a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** call that concludes the blocking connections transaction. 6539a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6540a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(If sqlite3_unlock_notify() is called in a multi-threaded application, 6541a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** there is a chance that the blocking connection will have already 6542a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** concluded its transaction by the time sqlite3_unlock_notify() is invoked. 6543a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** If this happens, then the specified callback is invoked immediately, 6544a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** from within the call to sqlite3_unlock_notify().)^ 6545a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6546a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^If the blocked connection is attempting to obtain a write-lock on a 6547a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** shared-cache table, and more than one other connection currently holds 6548a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a read-lock on the same table, then SQLite arbitrarily selects one of 6549a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the other connections to use as the blocking connection. 6550a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6551a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^(There may be at most one unlock-notify callback registered by a 6552a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** blocked connection. If sqlite3_unlock_notify() is called when the 6553a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** blocked connection already has a registered unlock-notify callback, 6554a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is 6555a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** called with a NULL pointer as its second argument, then any existing 6556de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** unlock-notify callback is canceled. ^The blocked connections 6557a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** unlock-notify callback may also be canceled by closing the blocked 6558a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** connection using [sqlite3_close()]. 6559a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6560a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** The unlock-notify callback is not reentrant. If an application invokes 6561a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** any sqlite3_xxx API functions from within an unlock-notify callback, a 6562a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** crash or deadlock may be the result. 6563a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6564a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** ^Unless deadlock is detected (see below), sqlite3_unlock_notify() always 6565a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returns SQLITE_OK. 6566a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6567a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <b>Callback Invocation Details</b> 6568a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6569a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When an unlock-notify callback is registered, the application provides a 6570a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** single void* pointer that is passed to the callback when it is invoked. 6571a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** However, the signature of the callback function allows SQLite to pass 6572a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** it an array of void* context pointers. The first argument passed to 6573a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** an unlock-notify callback is a pointer to an array of void* pointers, 6574a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** and the second is the number of entries in the array. 6575a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6576a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When a blocking connections transaction is concluded, there may be 6577a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** more than one blocked connection that has registered for an unlock-notify 6578a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** callback. ^If two or more such blocked connections have specified the 6579a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** same callback function, then instead of invoking the callback function 6580a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** multiple times, it is invoked once with the set of void* context pointers 6581a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** specified by the blocked connections bundled together into an array. 6582a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** This gives the application an opportunity to prioritize any actions 6583a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** related to the set of unblocked database connections. 6584a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6585a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <b>Deadlock Detection</b> 6586a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6587a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Assuming that after registering for an unlock-notify callback a 6588a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** database waits for the callback to be issued before taking any further 6589a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** action (a reasonable assumption), then using this API may cause the 6590a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** application to deadlock. For example, if connection X is waiting for 6591a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** connection Y's transaction to be concluded, and similarly connection 6592a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** Y is waiting on connection X's transaction, then neither connection 6593a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** will proceed and the system may remain deadlocked indefinitely. 6594a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6595a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock 6596a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** detection. ^If a given call to sqlite3_unlock_notify() would put the 6597a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** system in a deadlocked state, then SQLITE_LOCKED is returned and no 6598a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** unlock-notify callback is registered. The system is said to be in 6599a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** a deadlocked state if connection A has registered for an unlock-notify 6600a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** callback on the conclusion of connection B's transaction, and connection 6601a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** B has itself registered for an unlock-notify callback when connection 6602a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** A's transaction is concluded. ^Indirect deadlock is also detected, so 6603a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the system is also considered to be deadlocked if connection B has 6604a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** registered for an unlock-notify callback on the conclusion of connection 6605a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** C's transaction, where connection C is waiting on connection A. ^Any 6606a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** number of levels of indirection are allowed. 6607a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6608a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** <b>The "DROP TABLE" Exception</b> 6609a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6610a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost 6611a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** always appropriate to call sqlite3_unlock_notify(). There is however, 6612a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement, 6613a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLite checks if there are any currently executing SELECT statements 6614a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** that belong to the same connection. If there are, SQLITE_LOCKED is 6615a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** returned. In this case there is no "blocking connection", so invoking 6616a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** sqlite3_unlock_notify() results in the unlock-notify callback being 6617a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** invoked immediately. If the application then re-attempts the "DROP TABLE" 6618a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** or "DROP INDEX" query, an infinite loop might be the result. 6619a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6620a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** One way around this problem is to check the extended error code returned 6621a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** by an sqlite3_step() call. ^(If there is a blocking connection, then the 6622a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in 6623a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** the special "DROP TABLE/INDEX" case, the extended error code is just 6624a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** SQLITE_LOCKED.)^ 6625a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 6626a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_unlock_notify( 6627a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori sqlite3 *pBlocked, /* Waiting connection */ 6628a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */ 6629a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori void *pNotifyArg /* Argument to pass to xNotify */ 6630a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori); 6631a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6632a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6633a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori/* 6634a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** CAPI3REF: String Comparison 6635a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori** 6636c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** ^The [sqlite3_stricmp()] and [sqlite3_strnicmp()] APIs allow applications 6637c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** and extensions to compare the contents of two buffers containing UTF-8 6638c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** strings in a case-independent fashion, using the same definition of "case 6639c82acac4e67711e8d9289b572d334298aeb5d806Jeff Brown** independence" that SQLite uses internally when comparing identifiers. 6640a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori*/ 6641c82acac4e67711e8d9289b572d334298aeb5d806Jeff BrownSQLITE_API int sqlite3_stricmp(const char *, const char *); 6642a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu NoriSQLITE_API int sqlite3_strnicmp(const char *, const char *, int); 66437790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 6644aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori/* 6645aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** CAPI3REF: Error Logging Interface 6646aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** 6647aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** ^The [sqlite3_log()] interface writes a message into the error log 664871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()]. 664971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^If logging is enabled, the zFormat string and subsequent arguments are 665071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** used with [sqlite3_snprintf()] to generate the final output string. 6651aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** 6652aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** The sqlite3_log() interface is intended for use by extensions such as 6653aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** virtual tables, collating functions, and SQL functions. While there is 6654aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** nothing to prevent an application from calling sqlite3_log(), doing so 6655aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori** is considered bad form. 6656ebcc71fd53ce7cf46aff607df2d4bff793837176Vasu Nori** 665771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** The zFormat string must not be NULL. 665871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 6659ebcc71fd53ce7cf46aff607df2d4bff793837176Vasu Nori** To avoid deadlocks and other threading problems, the sqlite3_log() routine 6660ebcc71fd53ce7cf46aff607df2d4bff793837176Vasu Nori** will not use dynamically allocated memory. The log message is stored in 6661ebcc71fd53ce7cf46aff607df2d4bff793837176Vasu Nori** a fixed-length buffer on the stack. If the log message is longer than 6662ebcc71fd53ce7cf46aff607df2d4bff793837176Vasu Nori** a few hundred characters, it will be truncated to the length of the 6663ebcc71fd53ce7cf46aff607df2d4bff793837176Vasu Nori** buffer. 6664aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu Nori*/ 6665aae12b8a5af3a1ac77382b067d9ebb350fbd0644Vasu NoriSQLITE_API void sqlite3_log(int iErrCode, const char *zFormat, ...); 6666ebcc71fd53ce7cf46aff607df2d4bff793837176Vasu Nori 66677790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 666871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** CAPI3REF: Write-Ahead Log Commit Hook 666971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 667071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The [sqlite3_wal_hook()] function is used to register a callback that 667171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** will be invoked each time a database connection commits data to a 667271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [write-ahead log] (i.e. whenever a transaction is committed in 667371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [journal_mode | journal_mode=WAL mode]). 667471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 667571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The callback is invoked by SQLite after the commit has taken place and 667671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** the associated write-lock on the database released, so the implementation 667771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** may read, write or [checkpoint] the database as required. 667871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 667971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The first parameter passed to the callback function when it is invoked 668071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** is a copy of the third parameter passed to sqlite3_wal_hook() when 668171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** registering the callback. ^The second is a copy of the database handle. 668271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The third parameter is the name of the database that was written to - 668371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** either "main" or the name of an [ATTACH]-ed database. ^The fourth parameter 668471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** is the number of pages currently in the write-ahead log file, 668571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** including those that were just committed. 668671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 668771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** The callback function should normally return [SQLITE_OK]. ^If an error 668871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** code is returned, that error will propagate back up through the 668971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** SQLite code base to cause the statement that provoked the callback 669071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** to report an error, though the commit will have still occurred. If the 669171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value 669271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** that does not correspond to any valid SQLite error code, the results 669371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** are undefined. 669471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 669571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** A single database handle may have at most a single write-ahead log callback 669671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any 669771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** previously registered write-ahead log callback. ^Note that the 669871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [sqlite3_wal_autocheckpoint()] interface and the 669971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will 670071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** those overwrite any prior [sqlite3_wal_hook()] settings. 670171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori*/ 670271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API void *sqlite3_wal_hook( 670371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori sqlite3*, 670471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori int(*)(void *,sqlite3*,const char*,int), 670571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori void* 670671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori); 670771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 670871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori/* 670971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** CAPI3REF: Configure an auto-checkpoint 671071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 671171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around 671271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [sqlite3_wal_hook()] that causes any database on [database connection] D 671371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** to automatically [checkpoint] 671471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** after committing a transaction if there are N or 671571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** more frames in the [write-ahead log] file. ^Passing zero or 671671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** a negative value as the nFrame parameter disables automatic 671771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** checkpoints entirely. 671871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 671971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The callback registered by this function replaces any existing callback 672071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** registered using [sqlite3_wal_hook()]. ^Likewise, registering a callback 672171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism 672271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** configured by this function. 67237790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** 672471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The [wal_autocheckpoint pragma] can be used to invoke this interface 672571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** from SQL. 672671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 672771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^Every new [database connection] defaults to having the auto-checkpoint 672890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT] 672990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** pages. The use of this interface 673071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** is only necessary if the default setting is found to be suboptimal 673171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** for a particular application. 67327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 673371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db, int N); 673471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 673571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori/* 673671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** CAPI3REF: Checkpoint a database 673771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 673871504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The [sqlite3_wal_checkpoint(D,X)] interface causes database named X 673971504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** on [database connection] D to be [checkpointed]. ^If X is NULL or an 674071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** empty string, then a checkpoint is run on all databases of 674171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** connection D. ^If the database connection D is not in 674271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [WAL | write-ahead log mode] then this interface is a harmless no-op. 674371504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** 674471504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** ^The [wal_checkpoint pragma] can be used to invoke this interface 674571504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** from SQL. ^The [sqlite3_wal_autocheckpoint()] interface and the 674671504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** [wal_autocheckpoint pragma] can be used to cause this interface to be 674771504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori** run whenever the WAL reaches a certain size threshold. 674890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 674990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** See also: [sqlite3_wal_checkpoint_v2()] 675071504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori*/ 675171504cf29d6d55df7d2aac17ecb160f7e5470553Vasu NoriSQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb); 675271504cf29d6d55df7d2aac17ecb160f7e5470553Vasu Nori 67537790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project/* 675490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CAPI3REF: Checkpoint a database 675590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 675690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Run a checkpoint operation on WAL database zDb attached to database 675790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** handle db. The specific operation is determined by the value of the 675890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** eMode parameter: 675990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 676090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dl> 676190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dt>SQLITE_CHECKPOINT_PASSIVE<dd> 676290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Checkpoint as many frames as possible without waiting for any database 676390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** readers or writers to finish. Sync the db file if all frames in the log 676490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** are checkpointed. This mode is the same as calling 676590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** sqlite3_wal_checkpoint(). The busy-handler callback is never invoked. 676690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 676790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dt>SQLITE_CHECKPOINT_FULL<dd> 676890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** This mode blocks (calls the busy-handler callback) until there is no 676990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** database writer and all readers are reading from the most recent database 677090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** snapshot. It then checkpoints all frames in the log file and syncs the 677190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** database file. This call blocks database writers while it is running, 677290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** but not database readers. 677390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 677490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dt>SQLITE_CHECKPOINT_RESTART<dd> 677590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** This mode works the same way as SQLITE_CHECKPOINT_FULL, except after 677690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** checkpointing the log file it blocks (calls the busy-handler callback) 677790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** until all readers are reading from the database file only. This ensures 677890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** that the next client to write to the database file restarts the log file 677990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** from the beginning. This call blocks database writers while it is running, 678090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** but not database readers. 678190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** </dl> 678290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 678390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** If pnLog is not NULL, then *pnLog is set to the total number of frames in 678490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the log file before returning. If pnCkpt is not NULL, then *pnCkpt is set to 678590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the total number of checkpointed frames (including any that were already 678690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** checkpointed when this function is called). *pnLog and *pnCkpt may be 678790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** populated even if sqlite3_wal_checkpoint_v2() returns other than SQLITE_OK. 678890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** If no values are available because of an error, they are both set to -1 678990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** before returning to communicate this to the caller. 679090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 679190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** All calls obtain an exclusive "checkpoint" lock on the database file. If 679290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** any other process is running a checkpoint operation at the same time, the 679390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** lock cannot be obtained and SQLITE_BUSY is returned. Even if there is a 679490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** busy-handler configured, it will not be invoked in this case. 679590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 679690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** The SQLITE_CHECKPOINT_FULL and RESTART modes also obtain the exclusive 679790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** "writer" lock on the database file. If the writer lock cannot be obtained 679890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** immediately, and a busy-handler is configured, it is invoked and the writer 679990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** lock retried until either the busy-handler returns 0 or the lock is 680090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** successfully obtained. The busy-handler is also invoked while waiting for 680190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** database readers as described above. If the busy-handler returns 0 before 680290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** the writer lock is obtained or while waiting for database readers, the 680390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** checkpoint operation proceeds from that point in the same way as 680490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** SQLITE_CHECKPOINT_PASSIVE - checkpointing as many frames as possible 680590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** without blocking any further. SQLITE_BUSY is returned in this case. 680690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 680790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** If parameter zDb is NULL or points to a zero length string, then the 680890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** specified operation is attempted on all WAL databases. In this case the 680990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** values written to output parameters *pnLog and *pnCkpt are undefined. If 681090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** an SQLITE_BUSY error is encountered when processing one or more of the 681190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** attached WAL databases, the operation is still attempted on any remaining 681290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** attached databases and SQLITE_BUSY is returned to the caller. If any other 681390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** error occurs while processing an attached database, processing is abandoned 681490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** and the error code returned to the caller immediately. If no error 681590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** (SQLITE_BUSY or otherwise) is encountered while processing the attached 681690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** databases, SQLITE_OK is returned. 681790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 681890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** If database zDb is the name of an attached database that is not in WAL 681990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** mode, SQLITE_OK is returned and both *pnLog and *pnCkpt set to -1. If 682090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** zDb is not NULL (or a zero length string) and is not the name of any 682190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** attached database, SQLITE_ERROR is returned to the caller. 682290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 682390ed05d921d6ed7f12012d9786d53f57fafee51aJeff BrownSQLITE_API int sqlite3_wal_checkpoint_v2( 682490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown sqlite3 *db, /* Database handle */ 682590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown const char *zDb, /* Name of attached database (or NULL) */ 682690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown int eMode, /* SQLITE_CHECKPOINT_* value */ 682790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown int *pnLog, /* OUT: Size of WAL log in frames */ 682890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown int *pnCkpt /* OUT: Total number of frames checkpointed */ 682990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown); 683090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 683190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 683290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CAPI3REF: Checkpoint operation parameters 683390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 683490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** These constants can be used as the 3rd parameter to 683590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_wal_checkpoint_v2()]. See the [sqlite3_wal_checkpoint_v2()] 683690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** documentation for additional information about the meaning and use of 683790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** each of these values. 683890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 683990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_CHECKPOINT_PASSIVE 0 684090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_CHECKPOINT_FULL 1 684190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_CHECKPOINT_RESTART 2 684290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 684390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 684490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CAPI3REF: Virtual Table Interface Configuration 684590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 684690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** This function may be called by either the [xConnect] or [xCreate] method 684790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** of a [virtual table] implementation to configure 684890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** various facets of the virtual table interface. 684990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 685090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** If this interface is invoked outside the context of an xConnect or 685190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** xCreate virtual table method then the behavior is undefined. 685290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 685390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** At present, there is only one option that may be configured using 685490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** this function. (See [SQLITE_VTAB_CONSTRAINT_SUPPORT].) Further options 685590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** may be added in the future. 685690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 685790ed05d921d6ed7f12012d9786d53f57fafee51aJeff BrownSQLITE_API int sqlite3_vtab_config(sqlite3*, int op, ...); 685890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 685990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 686090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CAPI3REF: Virtual Table Configuration Options 686190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 686290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** These macros define the various options to the 686390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_vtab_config()] interface that [virtual table] implementations 686490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** can use to customize and optimize their behavior. 686590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 686690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dl> 686790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dt>SQLITE_VTAB_CONSTRAINT_SUPPORT 686890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** <dd>Calls of the form 686990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_vtab_config](db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported, 687090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** where X is an integer. If X is zero, then the [virtual table] whose 687190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [xCreate] or [xConnect] method invoked [sqlite3_vtab_config()] does not 687290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** support constraints. In this configuration (which is the default) if 687390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** a call to the [xUpdate] method returns [SQLITE_CONSTRAINT], then the entire 687490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** statement is rolled back as if [ON CONFLICT | OR ABORT] had been 687590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** specified as part of the users SQL statement, regardless of the actual 687690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** ON CONFLICT mode specified. 687790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 687890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** If X is non-zero, then the virtual table implementation guarantees 687990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** that if [xUpdate] returns [SQLITE_CONSTRAINT], it will do so before 688090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** any modifications to internal or persistent data structures have been made. 688190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** If the [ON CONFLICT] mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite 688290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is able to roll back a statement or database transaction, and abandon 688390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** or continue processing the current SQL statement as appropriate. 688490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** If the ON CONFLICT mode is REPLACE and the [xUpdate] method returns 688590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SQLITE_CONSTRAINT], SQLite handles this as if the ON CONFLICT mode 688690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** had been ABORT. 688790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 688890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Virtual table implementations that are required to handle OR REPLACE 688990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** must do so within the [xUpdate] method. If a call to the 689090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [sqlite3_vtab_on_conflict()] function indicates that the current ON 689190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CONFLICT policy is REPLACE, the virtual table implementation should 689290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** silently replace the appropriate rows within the xUpdate callback and 689390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** return SQLITE_OK. Or, if this is not possible, it may return 689490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT 689590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** constraint handling. 689690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** </dl> 689790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 689890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_VTAB_CONSTRAINT_SUPPORT 1 689990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 690090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 690190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CAPI3REF: Determine The Virtual Table Conflict Policy 690290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 690390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** This function may only be called from within a call to the [xUpdate] method 690490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** of a [virtual table] implementation for an INSERT or UPDATE operation. ^The 690590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** value returned is one of [SQLITE_ROLLBACK], [SQLITE_IGNORE], [SQLITE_FAIL], 690690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SQLITE_ABORT], or [SQLITE_REPLACE], according to the [ON CONFLICT] mode 690790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** of the SQL statement that triggered the call to the [xUpdate] method of the 690890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [virtual table]. 690990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 691090ed05d921d6ed7f12012d9786d53f57fafee51aJeff BrownSQLITE_API int sqlite3_vtab_on_conflict(sqlite3 *); 691190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 691290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 691390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** CAPI3REF: Conflict resolution modes 691490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 691590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** These constants are returned by [sqlite3_vtab_on_conflict()] to 691690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** inform a [virtual table] implementation what the [ON CONFLICT] mode 691790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** is for the SQL statement being evaluated. 691890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** 691990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** Note that the [SQLITE_IGNORE] constant is also used as a potential 692090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** return value from the [sqlite3_set_authorizer()] callback and that 692190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown** [SQLITE_ABORT] is also a [result code]. 692290ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown*/ 692390ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_ROLLBACK 1 692490ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* #define SQLITE_IGNORE 2 // Also used by sqlite3_authorizer() callback */ 692590ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_FAIL 3 692690ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* #define SQLITE_ABORT 4 // Also an error code */ 692790ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown#define SQLITE_REPLACE 5 692890ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 692990ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 693090ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown 693190ed05d921d6ed7f12012d9786d53f57fafee51aJeff Brown/* 69327790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** Undo the hack that converts floating point types to integer for 69337790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project** builds on processors without floating point support. 69347790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project*/ 69357790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#ifdef SQLITE_OMIT_FLOATING_POINT 69367790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project# undef double 69377790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#endif 69387790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project 69397790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#ifdef __cplusplus 69407790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project} /* End of the 'extern "C"' block */ 69417790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#endif 69427790ef5367fe6731048c3e3a1c067f94b321cb4dThe Android Open Source Project#endif 6943a4356a0ea71404ae414a07eafd7b95b91cc88c8cVasu Nori 6944de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori/* 6945de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 2010 August 30 6946de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 6947de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** The author disclaims copyright to this source code. In place of 6948de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** a legal notice, here is a blessing: 6949de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 6950de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** May you do good and not evil. 6951de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** May you find forgiveness for yourself and forgive others. 6952de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** May you share freely, never taking more than you give. 6953de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 6954de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori************************************************************************* 6955de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori*/ 6956de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 6957de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori#ifndef _SQLITE3RTREE_H_ 6958de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori#define _SQLITE3RTREE_H_ 6959de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 6960de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 6961de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori#ifdef __cplusplus 6962de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Noriextern "C" { 6963de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori#endif 6964de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 6965de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Noritypedef struct sqlite3_rtree_geometry sqlite3_rtree_geometry; 6966de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 6967de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori/* 6968de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** Register a geometry callback named zGeom that can be used as part of an 6969de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** R-Tree geometry query as follows: 6970de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** 6971de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zGeom(... params ...) 6972de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori*/ 6973de2b3240539802d409a25760d5cec9d4ebfd6686Vasu NoriSQLITE_API int sqlite3_rtree_geometry_callback( 6974de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori sqlite3 *db, 6975de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori const char *zGeom, 6976de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori int (*xGeom)(sqlite3_rtree_geometry *, int nCoord, double *aCoord, int *pRes), 6977de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void *pContext 6978de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori); 6979de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 6980de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 6981de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori/* 6982de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** A pointer to a structure of the following type is passed as the first 6983de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori** argument to callbacks registered using rtree_geometry_callback(). 6984de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori*/ 6985de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Noristruct sqlite3_rtree_geometry { 6986de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void *pContext; /* Copy of pContext passed to s_r_g_c() */ 6987de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori int nParam; /* Size of array aParam[] */ 6988de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori double *aParam; /* Parameters passed to SQL geom function */ 6989de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void *pUser; /* Callback implementation user data */ 6990de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori void (*xDelUser)(void *); /* Called by SQLite to clean up pUser */ 6991de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori}; 6992de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 6993de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 6994de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori#ifdef __cplusplus 6995de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori} /* end of the 'extern "C"' block */ 6996de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori#endif 6997de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 6998de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori#endif /* ifndef _SQLITE3RTREE_H_ */ 6999de2b3240539802d409a25760d5cec9d4ebfd6686Vasu Nori 7000