1563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 2563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2001 September 15 3563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The author disclaims copyright to this source code. In place of 5563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** a legal notice, here is a blessing: 6563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 7563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** May you do good and not evil. 8563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** May you find forgiveness for yourself and forgive others. 9563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** May you share freely, never taking more than you give. 10563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 11563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark************************************************************************* 12563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** This header file defines the interface that the SQLite library 13563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** presents to client programs. If a C-function, structure, datatype, 14563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** or constant definition does not appear in this file, then it is 15563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** not a published API of SQLite, is subject to change without 16563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** notice, and should not be referenced by programs that use SQLite. 17563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 18563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Some of the definitions that are in this file are marked as 19563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** "experimental". Experimental interfaces are normally new 20dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** features recently added to SQLite. We do not anticipate changes 21563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** to experimental interfaces but reserve to make minor changes if 22563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** experience from use "in the wild" suggest such changes are prudent. 23563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 24563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The official C-language API documentation for SQLite is derived 25563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** from comments in this file. This file is the authoritative source 26563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** on how SQLite interfaces are suppose to operate. 27563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 28563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The name of this file under configuration management is "sqlite.h.in". 29563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The makefile makes some minor changes to this file (such as inserting 30563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the version number) and changes its name to "sqlite3.h" as 31563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** part of the build process. 32563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 33dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** @(#) $Id: sqlite.h.in,v 1.436 2009/03/20 13:15:30 drh Exp $ 34563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 35563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#ifndef _SQLITE3_H_ 36563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define _SQLITE3_H_ 37563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#include <stdarg.h> /* Needed for the definition of va_list */ 38563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 39563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 40563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Make sure we can call this stuff from C++. 41563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 42563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#ifdef __cplusplus 43563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkextern "C" { 44563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#endif 45563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 46dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 47dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 48dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Add the ability to override 'extern' 49dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 50dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#ifndef SQLITE_EXTERN 51dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block# define SQLITE_EXTERN extern 52dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#endif 53dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 54dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 55dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These no-op macros are used in front of interfaces to mark those 56dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** interfaces as either deprecated or experimental. New applications 57dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** should not use deprecated intrfaces - they are support for backwards 58dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** compatibility only. Application writers should be aware that 59dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** experimental interfaces are subject to change in point releases. 60dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 61dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These macros used to resolve to various kinds of compiler magic that 62dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** would generate warning messages when they were used. But that 63dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** compiler magic ended up generating such a flurry of bug reports 64dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that we have taken it all out and gone back to using simple 65dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** noop macros. 66dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 67dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_DEPRECATED 68dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_EXPERIMENTAL 69dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 70563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 71dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Ensure these symbols were not defined by some previous header file. 72563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 73563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#ifdef SQLITE_VERSION 74563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark# undef SQLITE_VERSION 75563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#endif 76563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#ifdef SQLITE_VERSION_NUMBER 77563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark# undef SQLITE_VERSION_NUMBER 78563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#endif 79563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 80563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 81dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Compile-Time Library Version Numbers {H10010} <S60100> 82dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 83dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The SQLITE_VERSION and SQLITE_VERSION_NUMBER #defines in 84dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the sqlite3.h file specify the version of SQLite with which 85dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that header file is associated. 86dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 87dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The "version" of SQLite is a string of the form "X.Y.Z". 88dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The phrase "alpha" or "beta" might be appended after the Z. 89dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The X value is major version number always 3 in SQLite3. 90dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The X value only changes when backwards compatibility is 91dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** broken and we intend to never break backwards compatibility. 92dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The Y value is the minor version number and only changes when 93563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** there are major feature enhancements that are forwards compatible 94dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** but not backwards compatible. 95dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The Z value is the release number and is incremented with 96dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** each release but resets back to 0 whenever Y is incremented. 97563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 98563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** See also: [sqlite3_libversion()] and [sqlite3_libversion_number()]. 99dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 100dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: [H10011] [H10014] 101563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 102dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_VERSION "3.6.12" 103dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_VERSION_NUMBER 3006012 104563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 105563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 106dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Run-Time Library Version Numbers {H10020} <S60100> 107dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: sqlite3_version 108dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 109dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These features provide the same information as the [SQLITE_VERSION] 110dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and [SQLITE_VERSION_NUMBER] #defines in the header, but are associated 111dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** with the library instead of the header file. Cautious programmers might 112dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** include a check in their application to verify that 113dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_libversion_number() always returns the value 114dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_VERSION_NUMBER]. 115dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 116dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_libversion() function returns the same information as is 117dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** in the sqlite3_version[] string constant. The function is provided 118dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for use in DLLs since DLL users usually do not have direct access to string 119563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** constants within the DLL. 120dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 121dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: [H10021] [H10022] [H10023] 122563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 123dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve BlockSQLITE_EXTERN const char sqlite3_version[]; 124563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkconst char *sqlite3_libversion(void); 125563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_libversion_number(void); 126563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 127563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 128dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Test To See If The Library Is Threadsafe {H10100} <S60100> 129dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 130dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite can be compiled with or without mutexes. When 131dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the [SQLITE_THREADSAFE] C preprocessor macro 1 or 2, mutexes 132dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** are enabled and SQLite is threadsafe. When the 133dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_THREADSAFE] macro is 0, 134dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the mutexes are omitted. Without the mutexes, it is not safe 135dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to use SQLite concurrently from more than one thread. 136dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 137dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Enabling mutexes incurs a measurable performance penalty. 138dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** So if speed is of utmost importance, it makes sense to disable 139dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the mutexes. But for maximum safety, mutexes should be enabled. 140dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The default behavior is for mutexes to be enabled. 141dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 142dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This interface can be used by a program to make sure that the 143dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** version of SQLite that it is linking against was compiled with 144dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the desired setting of the [SQLITE_THREADSAFE] macro. 145dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 146dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This interface only reports on the compile-time mutex setting 147dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with 148dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLITE_THREADSAFE=1 then mutexes are enabled by default but 149dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** can be fully or partially disabled using a call to [sqlite3_config()] 150dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD], 151dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or [SQLITE_CONFIG_MUTEX]. The return value of this function shows 152dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** only the default compile-time setting, not any run-time changes 153dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to that setting. 154dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 155dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** See the [threading mode] documentation for additional information. 156dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 157dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: [H10101] [H10102] 158563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 159dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_threadsafe(void); 160563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 161dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 162dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Database Connection Handle {H12000} <S40200> 163dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: {database connection} {database connections} 164dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 165dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Each open SQLite database is represented by a pointer to an instance of 166dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the opaque structure named "sqlite3". It is useful to think of an sqlite3 167dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and 168dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()] 169dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is its destructor. There are many other interfaces (such as 170dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_prepare_v2()], [sqlite3_create_function()], and 171dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_busy_timeout()] to name but three) that are methods on an 172dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3 object. 173dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 174dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocktypedef struct sqlite3 sqlite3; 175563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 176563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 177dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: 64-Bit Integer Types {H10200} <S10110> 178dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: sqlite_int64 sqlite_uint64 179563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 180dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Because there is no cross-platform way to specify 64-bit integer types 181dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite includes typedefs for 64-bit signed and unsigned integers. 182563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 183dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions. 184dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite_int64 and sqlite_uint64 types are supported for backwards 185dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** compatibility only. 186dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 187dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: [H10201] [H10202] 188563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 189563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#ifdef SQLITE_INT64_TYPE 190563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark typedef SQLITE_INT64_TYPE sqlite_int64; 191563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark typedef unsigned SQLITE_INT64_TYPE sqlite_uint64; 192563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#elif defined(_MSC_VER) || defined(__BORLANDC__) 193563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark typedef __int64 sqlite_int64; 194563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark typedef unsigned __int64 sqlite_uint64; 195563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#else 196563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark typedef long long int sqlite_int64; 197563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark typedef unsigned long long int sqlite_uint64; 198563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#endif 199dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocktypedef sqlite_int64 sqlite3_int64; 200dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocktypedef sqlite_uint64 sqlite3_uint64; 201563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 202563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 203563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** If compiling for a processor that lacks floating point support, 204dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** substitute integer for floating-point. 205563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 206563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#ifdef SQLITE_OMIT_FLOATING_POINT 207dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block# define double sqlite3_int64 208563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#endif 209563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 210563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 211dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Closing A Database Connection {H12010} <S30100><S40200> 212dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 213dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This routine is the destructor for the [sqlite3] object. 214563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 215dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Applications should [sqlite3_finalize | finalize] all [prepared statements] 216dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and [sqlite3_blob_close | close] all [BLOB handles] associated with 217dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the [sqlite3] object prior to attempting to close the object. 218dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The [sqlite3_next_stmt()] interface can be used to locate all 219dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [prepared statements] associated with a [database connection] if desired. 220dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Typical code might look like this: 221563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 222dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <blockquote><pre> 223dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_stmt *pStmt; 224dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** while( (pStmt = sqlite3_next_stmt(db, 0))!=0 ){ 225dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_finalize(pStmt); 226dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** } 227dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </pre></blockquote> 228dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 229dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If [sqlite3_close()] is invoked while a transaction is open, 230dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the transaction is automatically rolled back. 231dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 232dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The C parameter to [sqlite3_close(C)] must be either a NULL 233dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** pointer or an [sqlite3] object pointer obtained 234dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** from [sqlite3_open()], [sqlite3_open16()], or 235dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_open_v2()], and not previously closed. 236dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 237dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 238dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12011] [H12012] [H12013] [H12014] [H12015] [H12019] 239563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 240563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_close(sqlite3 *); 241563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 242563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 243563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The type for a callback function. 244563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** This is legacy and deprecated. It is included for historical 245563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** compatibility and is not documented. 246563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 247563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarktypedef int (*sqlite3_callback)(void*,int,char**, char**); 248563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 249563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 250dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: One-Step Query Execution Interface {H12100} <S10000> 251dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 252dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_exec() interface is a convenient way of running one or more 253dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQL statements without having to write a lot of C code. The UTF-8 encoded 254dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQL statements are passed in as the second parameter to sqlite3_exec(). 255dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The statements are evaluated one by one until either an error or 256dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** an interrupt is encountered, or until they are all done. The 3rd parameter 257dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is an optional callback that is invoked once for each row of any query 258dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** results produced by the SQL statements. The 5th parameter tells where 259dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to write any error messages. 260dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 261dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The error message passed back through the 5th parameter is held 262dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** in memory obtained from [sqlite3_malloc()]. To avoid a memory leak, 263dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the calling application should call [sqlite3_free()] on any error 264dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** message returned through the 5th parameter when it has finished using 265dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the error message. 266dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 267dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the SQL statement in the 2nd parameter is NULL or an empty string 268dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or a string containing only whitespace and comments, then no SQL 269dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** statements are evaluated and the database is not changed. 270dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 271dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_exec() interface is implemented in terms of 272dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()]. 273dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_exec() routine does nothing to the database that cannot be done 274dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** by [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()]. 275dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 276dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The first parameter to [sqlite3_exec()] must be an valid and open 277dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [database connection]. 278dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 279dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The database connection must not be closed while 280dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_exec()] is running. 281dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 282dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The calling function should use [sqlite3_free()] to free 283dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the memory that *errmsg is left pointing at once the error 284dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** message is no longer needed. 285dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 286dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The SQL statement text in the 2nd parameter to [sqlite3_exec()] 287dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** must remain unchanged while [sqlite3_exec()] is running. 288dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 289dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 290dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12101] [H12102] [H12104] [H12105] [H12107] [H12110] [H12113] [H12116] 291dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12119] [H12122] [H12125] [H12131] [H12134] [H12137] [H12138] 292563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 293563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_exec( 294563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3*, /* An open database */ 295dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block const char *sql, /* SQL to be evaluated */ 296563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int (*callback)(void*,int,char**,char**), /* Callback function */ 297563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark void *, /* 1st argument to callback */ 298563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark char **errmsg /* Error msg written here */ 299563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 300563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 301563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 302dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Result Codes {H10210} <S10700> 303dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: SQLITE_OK {error code} {error codes} 304dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: {result code} {result codes} 305563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 306563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Many SQLite functions return an integer result code from the set shown 307dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** here in order to indicates success or failure. 308563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 309dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** New error codes may be added in future versions of SQLite. 310563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 311563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** See also: [SQLITE_IOERR_READ | extended result codes] 312563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 313563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_OK 0 /* Successful result */ 314563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* beginning-of-error-codes */ 315563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_ERROR 1 /* SQL error or missing database */ 316dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */ 317563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_PERM 3 /* Access permission denied */ 318563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_ABORT 4 /* Callback routine requested an abort */ 319563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_BUSY 5 /* The database file is locked */ 320563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_LOCKED 6 /* A table in the database is locked */ 321563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_NOMEM 7 /* A malloc() failed */ 322563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_READONLY 8 /* Attempt to write a readonly database */ 323563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/ 324563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */ 325563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_CORRUPT 11 /* The database disk image is malformed */ 326563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_NOTFOUND 12 /* NOT USED. Table or record not found */ 327563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_FULL 13 /* Insertion failed because database is full */ 328563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_CANTOPEN 14 /* Unable to open the database file */ 329563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_PROTOCOL 15 /* NOT USED. Database lock protocol error */ 330563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_EMPTY 16 /* Database is empty */ 331563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_SCHEMA 17 /* The database schema changed */ 332563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */ 333dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */ 334563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_MISMATCH 20 /* Data type mismatch */ 335563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_MISUSE 21 /* Library used incorrectly */ 336563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */ 337563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_AUTH 23 /* Authorization denied */ 338563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_FORMAT 24 /* Auxiliary database format error */ 339563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */ 340563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_NOTADB 26 /* File opened that is not a database file */ 341563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */ 342563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */ 343563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* end-of-error-codes */ 344563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 345563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 346dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Extended Result Codes {H10220} <S10700> 347dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: {extended error code} {extended error codes} 348dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: {extended result code} {extended result codes} 349563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 350563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** In its default configuration, SQLite API routines return one of 26 integer 351dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_OK | result codes]. However, experience has shown that many of 352dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** these result codes are too coarse-grained. They do not provide as 353dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** much information about problems as programmers might like. In an effort to 354563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** address this, newer versions of SQLite (version 3.3.8 and later) include 355563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** support for additional result codes that provide more detailed information 356dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** about errors. The extended result codes are enabled or disabled 357dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** on a per database connection basis using the 358dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_extended_result_codes()] API. 359dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 360dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Some of the available extended result codes are listed here. 361dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** One may expect the number of extended result codes will be expand 362563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** over time. Software that uses extended result codes should expect 363563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** to see new result codes in future releases of SQLite. 364563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 365563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The SQLITE_OK result code will never be extended. It will always 366563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** be exactly zero. 367563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 368dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8)) 369dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8)) 370dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8)) 371dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8)) 372dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8)) 373dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8)) 374dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8)) 375dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8)) 376dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8)) 377dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8)) 378dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8)) 379dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8)) 380dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8)) 381dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8)) 382dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8)) 383dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8)) 384dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8)) 385dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 386dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8) ) 387dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 388dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 389dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Flags For File Open Operations {H10230} <H11120> <H12700> 390dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 391dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These bit values are intended for use in the 392dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3rd parameter to the [sqlite3_open_v2()] interface and 393dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** in the 4th parameter to the xOpen method of the 394dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_vfs] object. 395563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 396dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_OPEN_READONLY 0x00000001 397dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_OPEN_READWRITE 0x00000002 398dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_OPEN_CREATE 0x00000004 399dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_OPEN_DELETEONCLOSE 0x00000008 400dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_OPEN_EXCLUSIVE 0x00000010 401dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_OPEN_AUTOPROXY 0x00000020 402dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_OPEN_MAIN_DB 0x00000100 403dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_OPEN_TEMP_DB 0x00000200 404dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_OPEN_TRANSIENT_DB 0x00000400 405dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 406dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 407dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_OPEN_SUBJOURNAL 0x00002000 408dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 409dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_OPEN_NOMUTEX 0x00008000 410dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_OPEN_FULLMUTEX 0x00010000 411563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 412563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 413dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Device Characteristics {H10240} <H11120> 414dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 415dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The xDeviceCapabilities method of the [sqlite3_io_methods] 416dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** object returns an integer which is a vector of the these 417dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** bit values expressing I/O characteristics of the mass storage 418dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** device that holds the file that the [sqlite3_io_methods] 419dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** refers to. 420dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 421dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The SQLITE_IOCAP_ATOMIC property means that all writes of 422dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values 423dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** mean that writes of blocks that are nnn bytes in size and 424dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** are aligned to an address which is an integer multiple of 425dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means 426dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that when data is appended to a file, the data is appended 427dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** first then the size of the file is extended, never the other 428dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** way around. The SQLITE_IOCAP_SEQUENTIAL property means that 429dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** information is written to disk in the same order as calls 430dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to xWrite(). 431dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 432dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOCAP_ATOMIC 0x00000001 433dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOCAP_ATOMIC512 0x00000002 434dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOCAP_ATOMIC1K 0x00000004 435dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOCAP_ATOMIC2K 0x00000008 436dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOCAP_ATOMIC4K 0x00000010 437dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOCAP_ATOMIC8K 0x00000020 438dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOCAP_ATOMIC16K 0x00000040 439dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOCAP_ATOMIC32K 0x00000080 440dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOCAP_ATOMIC64K 0x00000100 441dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOCAP_SAFE_APPEND 0x00000200 442dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_IOCAP_SEQUENTIAL 0x00000400 443dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 444dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 445dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: File Locking Levels {H10250} <H11120> <H11310> 446dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 447dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite uses one of these integer values as the second 448dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** argument to calls it makes to the xLock() and xUnlock() methods 449dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of an [sqlite3_io_methods] object. 450dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 451dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_LOCK_NONE 0 452dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_LOCK_SHARED 1 453dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_LOCK_RESERVED 2 454dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_LOCK_PENDING 3 455dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_LOCK_EXCLUSIVE 4 456dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 457dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 458dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Synchronization Type Flags {H10260} <H11120> 459dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 460dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** When SQLite invokes the xSync() method of an 461dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_io_methods] object it uses a combination of 462dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** these integer values as the second argument. 463563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 464dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** When the SQLITE_SYNC_DATAONLY flag is used, it means that the 465dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sync operation only needs to flush data to mass storage. Inode 466dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** information need not be flushed. The SQLITE_SYNC_NORMAL flag means 467dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to use normal fsync() semantics. The SQLITE_SYNC_FULL flag means 468dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to use Mac OS X style fullsync instead of fsync(). 469dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 470dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_SYNC_NORMAL 0x00002 471dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_SYNC_FULL 0x00003 472dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_SYNC_DATAONLY 0x00010 473dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 474dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 475dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: OS Interface Open File Handle {H11110} <S20110> 476dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 477dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** An [sqlite3_file] object represents an open file in the OS 478dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** interface layer. Individual OS interface implementations will 479dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** want to subclass this object by appending additional fields 480dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for their own use. The pMethods entry is a pointer to an 481dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_io_methods] object that defines methods for performing 482dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** I/O operations on the open file. 483dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 484dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocktypedef struct sqlite3_file sqlite3_file; 485dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockstruct sqlite3_file { 486dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block const struct sqlite3_io_methods *pMethods; /* Methods for an open file */ 487dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block}; 488dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 489dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 490dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: OS Interface File Virtual Methods Object {H11120} <S20110> 491dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 492dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Every file opened by the [sqlite3_vfs] xOpen method populates an 493dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_file] object (or, more commonly, a subclass of the 494dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_file] object) with a pointer to an instance of this object. 495dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This object defines the methods used to perform various operations 496dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** against the open file represented by the [sqlite3_file] object. 497dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 498dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or 499dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_SYNC_FULL]. The first choice is the normal fsync(). 500dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY] 501dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** flag may be ORed in to indicate that only the data of the file 502dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and not its inode needs to be synced. 503dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 504dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The integer values to xLock() and xUnlock() are one of 505dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <ul> 506dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_LOCK_NONE], 507dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_LOCK_SHARED], 508dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_LOCK_RESERVED], 509dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_LOCK_PENDING], or 510dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_LOCK_EXCLUSIVE]. 511dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </ul> 512dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** xLock() increases the lock. xUnlock() decreases the lock. 513dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The xCheckReservedLock() method checks whether any database connection, 514dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** either in this process or in some other process, is holding a RESERVED, 515dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** PENDING, or EXCLUSIVE lock on the file. It returns true 516dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** if such a lock exists and false otherwise. 517dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 518dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The xFileControl() method is a generic interface that allows custom 519dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** VFS implementations to directly control an open file using the 520dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_file_control()] interface. The second "op" argument is an 521dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** integer opcode. The third argument is a generic pointer intended to 522dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** point to a structure that may contain arguments or space in which to 523dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** write return values. Potential uses for xFileControl() might be 524dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** functions to enable blocking locks with timeouts, to change the 525dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** locking strategy (for example to use dot-file locks), to inquire 526dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** about the status of a lock, or to break stale locks. The SQLite 527dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** core reserves all opcodes less than 100 for its own use. 528dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** A [SQLITE_FCNTL_LOCKSTATE | list of opcodes] less than 100 is available. 529dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Applications that define a custom xFileControl method should use opcodes 530dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** greater than 100 to avoid conflicts. 531dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 532dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The xSectorSize() method returns the sector size of the 533dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** device that underlies the file. The sector size is the 534dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** minimum write that can be performed without disturbing 535dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** other bytes in the file. The xDeviceCharacteristics() 536dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** method returns a bit vector describing behaviors of the 537dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** underlying device: 538dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 539dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <ul> 540dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_IOCAP_ATOMIC] 541dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_IOCAP_ATOMIC512] 542dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_IOCAP_ATOMIC1K] 543dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_IOCAP_ATOMIC2K] 544dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_IOCAP_ATOMIC4K] 545dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_IOCAP_ATOMIC8K] 546dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_IOCAP_ATOMIC16K] 547dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_IOCAP_ATOMIC32K] 548dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_IOCAP_ATOMIC64K] 549dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_IOCAP_SAFE_APPEND] 550dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_IOCAP_SEQUENTIAL] 551dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </ul> 552dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 553dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The SQLITE_IOCAP_ATOMIC property means that all writes of 554dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values 555dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** mean that writes of blocks that are nnn bytes in size and 556dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** are aligned to an address which is an integer multiple of 557dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means 558dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that when data is appended to a file, the data is appended 559dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** first then the size of the file is extended, never the other 560dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** way around. The SQLITE_IOCAP_SEQUENTIAL property means that 561dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** information is written to disk in the same order as calls 562dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to xWrite(). 563dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 564dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill 565dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** in the unread portions of the buffer with zeros. A VFS that 566dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** fails to zero-fill short reads might seem to work. However, 567dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** failure to zero-fill short reads will eventually lead to 568dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** database corruption. 569dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 570dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocktypedef struct sqlite3_io_methods sqlite3_io_methods; 571dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockstruct sqlite3_io_methods { 572dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int iVersion; 573dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xClose)(sqlite3_file*); 574dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst); 575dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst); 576dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xTruncate)(sqlite3_file*, sqlite3_int64 size); 577dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xSync)(sqlite3_file*, int flags); 578dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize); 579dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xLock)(sqlite3_file*, int); 580dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xUnlock)(sqlite3_file*, int); 581dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xCheckReservedLock)(sqlite3_file*, int *pResOut); 582dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xFileControl)(sqlite3_file*, int op, void *pArg); 583dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xSectorSize)(sqlite3_file*); 584dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xDeviceCharacteristics)(sqlite3_file*); 585dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block /* Additional methods may be added in future releases */ 586dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block}; 587dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 588dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 589dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Standard File Control Opcodes {H11310} <S30800> 590dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 591dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These integer constants are opcodes for the xFileControl method 592dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()] 593dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** interface. 594dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 595dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This 596dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** opcode causes the xFileControl method to write the current state of 597dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED], 598dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE]) 599dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** into an integer that the pArg argument points to. This capability 600dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is used during testing and only needs to be supported when SQLITE_TEST 601dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is defined. 602dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 603dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_FCNTL_LOCKSTATE 1 604dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_GET_LOCKPROXYFILE 2 605dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_SET_LOCKPROXYFILE 3 606dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_LAST_ERRNO 4 607dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 608dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 609dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Mutex Handle {H17110} <S20130> 610dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 611dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The mutex module within SQLite defines [sqlite3_mutex] to be an 612dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** abstract type for a mutex object. The SQLite core never looks 613dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** at the internal representation of an [sqlite3_mutex]. It only 614dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** deals with pointers to the [sqlite3_mutex] object. 615dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 616dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Mutexes are created using [sqlite3_mutex_alloc()]. 617dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 618dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocktypedef struct sqlite3_mutex sqlite3_mutex; 619dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 620dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 621dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: OS Interface Object {H11140} <S20100> 622dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 623dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** An instance of the sqlite3_vfs object defines the interface between 624dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the SQLite core and the underlying operating system. The "vfs" 625dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** in the name of the object stands for "virtual file system". 626dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 627dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The value of the iVersion field is initially 1 but may be larger in 628dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** future versions of SQLite. Additional fields may be appended to this 629dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** object when the iVersion value is increased. Note that the structure 630dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of the sqlite3_vfs object changes in the transaction between 631dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not 632dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** modified. 633dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 634dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The szOsFile field is the size of the subclassed [sqlite3_file] 635dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** structure used by this VFS. mxPathname is the maximum length of 636dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a pathname in this VFS. 637dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 638dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Registered sqlite3_vfs objects are kept on a linked list formed by 639dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the pNext pointer. The [sqlite3_vfs_register()] 640dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and [sqlite3_vfs_unregister()] interfaces manage this list 641dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** in a thread-safe way. The [sqlite3_vfs_find()] interface 642dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** searches the list. Neither the application code nor the VFS 643dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** implementation should use the pNext pointer. 644dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 645dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The pNext field is the only field in the sqlite3_vfs 646dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** structure that SQLite will ever modify. SQLite will only access 647dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or modify this field while holding a particular static mutex. 648dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The application should never modify anything within the sqlite3_vfs 649dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** object once the object has been registered. 650dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 651dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The zName field holds the name of the VFS module. The name must 652dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** be unique across all VFS modules. 653dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 654dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite will guarantee that the zFilename parameter to xOpen 655dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is either a NULL pointer or string obtained 656dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** from xFullPathname(). SQLite further guarantees that 657dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the string will be valid and unchanged until xClose() is 658dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** called. Because of the previous sentense, 659dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the [sqlite3_file] can safely store a pointer to the 660dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** filename if it needs to remember the filename for some reason. 661dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the zFilename parameter is xOpen is a NULL pointer then xOpen 662dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** must invite its own temporary name for the file. Whenever the 663dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** xFilename parameter is NULL it will also be the case that the 664dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE]. 665dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 666dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The flags argument to xOpen() includes all bits set in 667dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()] 668dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or [sqlite3_open16()] is used, then flags includes at least 669dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. 670dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If xOpen() opens a file read-only then it sets *pOutFlags to 671dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set. 672dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 673dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite will also add one of the following flags to the xOpen() 674dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** call, depending on the object being opened: 675dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 676dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <ul> 677dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_OPEN_MAIN_DB] 678dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_OPEN_MAIN_JOURNAL] 679dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_OPEN_TEMP_DB] 680dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_OPEN_TEMP_JOURNAL] 681dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_OPEN_TRANSIENT_DB] 682dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_OPEN_SUBJOURNAL] 683dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_OPEN_MASTER_JOURNAL] 684dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </ul> 685dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 686dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The file I/O implementation can use the object type flags to 687dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** change the way it deals with files. For example, an application 688dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that does not care about crash recovery or rollback might make 689dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the open of a journal file a no-op. Writes to this journal would 690dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** also be no-ops, and any attempt to read the journal would return 691dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLITE_IOERR. Or the implementation might recognize that a database 692dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** file will be doing page-aligned sector reads and writes in a random 693dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** order and set up its I/O subsystem accordingly. 694dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 695dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite might also add one of the following flags to the xOpen method: 696dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 697dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <ul> 698dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_OPEN_DELETEONCLOSE] 699dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [SQLITE_OPEN_EXCLUSIVE] 700dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </ul> 701dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 702dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be 703dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** deleted when it is closed. The [SQLITE_OPEN_DELETEONCLOSE] 704dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** will be set for TEMP databases, journals and for subjournals. 705dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 706dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The [SQLITE_OPEN_EXCLUSIVE] flag means the file should be opened 707dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for exclusive access. This flag is set for all files except 708dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for the main database file. 709dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 710dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** At least szOsFile bytes of memory are allocated by SQLite 711dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to hold the [sqlite3_file] structure passed as the third 712dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** argument to xOpen. The xOpen method does not have to 713dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** allocate the structure; it should just fill it in. 714dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 715dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS] 716dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to 717dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** test whether a file is readable and writable, or [SQLITE_ACCESS_READ] 718dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to test whether a file is at least readable. The file can be a 719dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** directory. 720dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 721dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite will always allocate at least mxPathname+1 bytes for the 722dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** output buffer xFullPathname. The exact size of the output buffer 723dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is also passed as a parameter to both methods. If the output buffer 724dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is 725dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** handled as a fatal error by SQLite, vfs implementations should endeavor 726dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to prevent this by setting mxPathname to a sufficiently large value. 727dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 728dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The xRandomness(), xSleep(), and xCurrentTime() interfaces 729dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** are not strictly a part of the filesystem, but they are 730dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** included in the VFS structure for completeness. 731dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The xRandomness() function attempts to return nBytes bytes 732dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of good-quality randomness into zOut. The return value is 733dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the actual number of bytes of randomness obtained. 734dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The xSleep() method causes the calling thread to sleep for at 735dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** least the number of microseconds given. The xCurrentTime() 736dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** method returns a Julian Day Number for the current date and time. 737dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 738dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 739dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocktypedef struct sqlite3_vfs sqlite3_vfs; 740dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockstruct sqlite3_vfs { 741dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int iVersion; /* Structure version number */ 742dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int szOsFile; /* Size of subclassed sqlite3_file */ 743dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int mxPathname; /* Maximum file pathname length */ 744dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block sqlite3_vfs *pNext; /* Next registered VFS */ 745dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block const char *zName; /* Name of this virtual file system */ 746dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void *pAppData; /* Pointer to application-specific data */ 747dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*, 748dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int flags, int *pOutFlags); 749dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir); 750dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut); 751dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut); 752dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename); 753dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg); 754dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void); 755dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void (*xDlClose)(sqlite3_vfs*, void*); 756dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut); 757dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xSleep)(sqlite3_vfs*, int microseconds); 758dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xCurrentTime)(sqlite3_vfs*, double*); 759dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xGetLastError)(sqlite3_vfs*, int, char *); 760dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block /* New fields may be appended in figure versions. The iVersion 761dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block ** value will increment whenever this happens. */ 762dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block}; 763dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 764dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 765dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Flags for the xAccess VFS method {H11190} <H11140> 766dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 767dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These integer constants can be used as the third parameter to 768dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the xAccess method of an [sqlite3_vfs] object. {END} They determine 769dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** what kind of permissions the xAccess method is looking for. 770dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** With SQLITE_ACCESS_EXISTS, the xAccess method 771dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** simply checks whether the file exists. 772dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** With SQLITE_ACCESS_READWRITE, the xAccess method 773dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** checks whether the file is both readable and writable. 774dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** With SQLITE_ACCESS_READ, the xAccess method 775dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** checks whether the file is readable. 776dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 777dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_ACCESS_EXISTS 0 778dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_ACCESS_READWRITE 1 779dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_ACCESS_READ 2 780dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 781dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 782dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Initialize The SQLite Library {H10130} <S20000><S30100> 783dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 784dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_initialize() routine initializes the 785dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite library. The sqlite3_shutdown() routine 786dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** deallocates any resources that were allocated by sqlite3_initialize(). 787dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 788dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** A call to sqlite3_initialize() is an "effective" call if it is 789dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the first time sqlite3_initialize() is invoked during the lifetime of 790dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the process, or if it is the first time sqlite3_initialize() is invoked 791dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** following a call to sqlite3_shutdown(). Only an effective call 792dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of sqlite3_initialize() does any initialization. All other calls 793dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** are harmless no-ops. 794dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 795dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Among other things, sqlite3_initialize() shall invoke 796dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_os_init(). Similarly, sqlite3_shutdown() 797dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** shall invoke sqlite3_os_end(). 798dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 799dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_initialize() routine returns [SQLITE_OK] on success. 800dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If for some reason, sqlite3_initialize() is unable to initialize 801dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the library (perhaps it is unable to allocate a needed resource such 802dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** as a mutex) it returns an [error code] other than [SQLITE_OK]. 803dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 804dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_initialize() routine is called internally by many other 805dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite interfaces so that an application usually does not need to 806dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** invoke sqlite3_initialize() directly. For example, [sqlite3_open()] 807dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** calls sqlite3_initialize() so the SQLite library will be automatically 808dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** initialized when [sqlite3_open()] is called if it has not be initialized 809dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** already. However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT] 810dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** compile-time option, then the automatic calls to sqlite3_initialize() 811dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** are omitted and the application must call sqlite3_initialize() directly 812dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** prior to using any other SQLite interface. For maximum portability, 813dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** it is recommended that applications always invoke sqlite3_initialize() 814dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** directly prior to using any other SQLite interface. Future releases 815dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of SQLite may require this. In other words, the behavior exhibited 816dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the 817dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** default behavior in some future release of SQLite. 818dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 819dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_os_init() routine does operating-system specific 820dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** initialization of the SQLite library. The sqlite3_os_end() 821dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** routine undoes the effect of sqlite3_os_init(). Typical tasks 822dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** performed by these routines include allocation or deallocation 823dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of static resources, initialization of global variables, 824dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** setting up a default [sqlite3_vfs] module, or setting up 825dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a default configuration using [sqlite3_config()]. 826dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 827dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The application should never invoke either sqlite3_os_init() 828dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or sqlite3_os_end() directly. The application should only invoke 829dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init() 830dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** interface is called automatically by sqlite3_initialize() and 831dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate 832dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** implementations for sqlite3_os_init() and sqlite3_os_end() 833dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** are built into SQLite when it is compiled for unix, windows, or os/2. 834dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** When built for other platforms (using the [SQLITE_OS_OTHER=1] compile-time 835dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** option) the application must supply a suitable implementation for 836dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_os_init() and sqlite3_os_end(). An application-supplied 837dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** implementation of sqlite3_os_init() or sqlite3_os_end() 838dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** must return [SQLITE_OK] on success and some other [error code] upon 839dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** failure. 840dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 841dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_initialize(void); 842dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_shutdown(void); 843dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_os_init(void); 844dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_os_end(void); 845dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 846dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 847dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Configuring The SQLite Library {H14100} <S20000><S30200> 848dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 849dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 850dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_config() interface is used to make global configuration 851dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** changes to SQLite in order to tune SQLite to the specific needs of 852dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the application. The default configuration is recommended for most 853dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** applications and so this routine is usually not necessary. It is 854dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** provided to support rare applications with unusual needs. 855dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 856dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_config() interface is not threadsafe. The application 857dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** must insure that no other SQLite interfaces are invoked by other 858dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** threads while sqlite3_config() is running. Furthermore, sqlite3_config() 859dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** may only be invoked prior to library initialization using 860dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()]. 861dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Note, however, that sqlite3_config() can be called as part of the 862dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** implementation of an application-defined [sqlite3_os_init()]. 863dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 864dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The first argument to sqlite3_config() is an integer 865dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_CONFIG_SINGLETHREAD | configuration option] that determines 866dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** what property of SQLite is to be configured. Subsequent arguments 867dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** vary depending on the [SQLITE_CONFIG_SINGLETHREAD | configuration option] 868dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** in the first argument. 869dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 870dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** When a configuration option is set, sqlite3_config() returns [SQLITE_OK]. 871dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the option is unknown or SQLite is unable to set the option 872dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** then this routine returns a non-zero [error code]. 873dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 874dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 875dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H14103] [H14106] [H14120] [H14123] [H14126] [H14129] [H14132] [H14135] 876dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H14138] [H14141] [H14144] [H14147] [H14150] [H14153] [H14156] [H14159] 877dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H14162] [H14165] [H14168] 878dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 879dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve BlockSQLITE_EXPERIMENTAL int sqlite3_config(int, ...); 880dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 881dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 882dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Configure database connections {H14200} <S20000> 883dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 884dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 885dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_db_config() interface is used to make configuration 886dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** changes to a [database connection]. The interface is similar to 887dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_config()] except that the changes apply to a single 888dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [database connection] (specified in the first argument). The 889dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_db_config() interface can only be used immediately after 890dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the database connection is created using [sqlite3_open()], 891dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_open16()], or [sqlite3_open_v2()]. 892dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 893dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The second argument to sqlite3_db_config(D,V,...) is the 894dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** configuration verb - an integer code that indicates what 895dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** aspect of the [database connection] is being configured. 896dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The only choice for this value is [SQLITE_DBCONFIG_LOOKASIDE]. 897dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** New verbs are likely to be added in future releases of SQLite. 898dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Additional arguments depend on the verb. 899dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 900dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 901dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H14203] [H14206] [H14209] [H14212] [H14215] 902dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 903dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve BlockSQLITE_EXPERIMENTAL int sqlite3_db_config(sqlite3*, int op, ...); 904dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 905dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 906dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Memory Allocation Routines {H10155} <S20120> 907dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 908dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 909dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** An instance of this object defines the interface between SQLite 910dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and low-level memory allocation routines. 911dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 912dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This object is used in only one place in the SQLite interface. 913dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** A pointer to an instance of this object is the argument to 914dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_config()] when the configuration option is 915dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_CONFIG_MALLOC]. By creating an instance of this object 916dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and passing it to [sqlite3_config()] during configuration, an 917dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** application can specify an alternative memory allocation subsystem 918dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for SQLite to use for all of its dynamic memory needs. 919dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 920dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Note that SQLite comes with a built-in memory allocator that is 921dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** perfectly adequate for the overwhelming majority of applications 922dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and that this object is only useful to a tiny minority of applications 923dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** with specialized memory allocation requirements. This object is 924dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** also used during testing of SQLite in order to specify an alternative 925dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** memory allocator that simulates memory out-of-memory conditions in 926dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** order to verify that SQLite recovers gracefully from such 927dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** conditions. 928dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 929dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The xMalloc, xFree, and xRealloc methods must work like the 930dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** malloc(), free(), and realloc() functions from the standard library. 931dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 932dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** xSize should return the allocated size of a memory allocation 933dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** previously obtained from xMalloc or xRealloc. The allocated size 934dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is always at least as big as the requested size but may be larger. 935dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 936dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The xRoundup method returns what would be the allocated size of 937dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a memory allocation given a particular requested size. Most memory 938dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** allocators round up memory allocations at least to the next multiple 939dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of 8. Some allocators round up to a larger multiple or to a power of 2. 940dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 941dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The xInit method initializes the memory allocator. (For example, 942dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** it might allocate any require mutexes or initialize internal data 943dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** structures. The xShutdown method is invoked (indirectly) by 944dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_shutdown()] and should deallocate any resources acquired 945dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** by xInit. The pAppData pointer is used as the only parameter to 946dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** xInit and xShutdown. 947dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 948dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocktypedef struct sqlite3_mem_methods sqlite3_mem_methods; 949dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockstruct sqlite3_mem_methods { 950dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void *(*xMalloc)(int); /* Memory allocation function */ 951dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void (*xFree)(void*); /* Free a prior allocation */ 952dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void *(*xRealloc)(void*,int); /* Resize an allocation */ 953dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xSize)(void*); /* Return the size of an allocation */ 954dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xRoundup)(int); /* Round up request size to allocation size */ 955dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xInit)(void*); /* Initialize the memory allocator */ 956dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void (*xShutdown)(void*); /* Deinitialize the memory allocator */ 957dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void *pAppData; /* Argument to xInit() and xShutdown() */ 958dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block}; 959dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 960dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 961dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Configuration Options {H10160} <S20000> 962dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 963dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 964dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These constants are the available integer configuration options that 965dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** can be passed as the first argument to the [sqlite3_config()] interface. 966dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 967dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** New configuration options may be added in future releases of SQLite. 968dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Existing configuration options might be discontinued. Applications 969dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** should check the return code from [sqlite3_config()] to make sure that 970dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the call worked. The [sqlite3_config()] interface will return a 971dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** non-zero [error code] if a discontinued or unsupported configuration option 972dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is invoked. 973dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 974dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dl> 975dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_CONFIG_SINGLETHREAD</dt> 976dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>There are no arguments to this option. This option disables 977dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** all mutexing and puts SQLite into a mode where it can only be used 978dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** by a single thread.</dd> 979dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 980dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_CONFIG_MULTITHREAD</dt> 981dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>There are no arguments to this option. This option disables 982dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** mutexing on [database connection] and [prepared statement] objects. 983dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The application is responsible for serializing access to 984dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [database connections] and [prepared statements]. But other mutexes 985dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** are enabled so that SQLite will be safe to use in a multi-threaded 986dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** environment as long as no two threads attempt to use the same 987dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [database connection] at the same time. See the [threading mode] 988dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** documentation for additional information.</dd> 989dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 990dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_CONFIG_SERIALIZED</dt> 991dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>There are no arguments to this option. This option enables 992dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** all mutexes including the recursive 993dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** mutexes on [database connection] and [prepared statement] objects. 994dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** In this mode (which is the default when SQLite is compiled with 995dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access 996dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to [database connections] and [prepared statements] so that the 997dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** application is free to use the same [database connection] or the 998dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** same [prepared statement] in different threads at the same time. 999dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** See the [threading mode] documentation for additional information.</dd> 1000dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1001dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_CONFIG_MALLOC</dt> 1002dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This option takes a single argument which is a pointer to an 1003dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** instance of the [sqlite3_mem_methods] structure. The argument specifies 1004dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** alternative low-level memory allocation routines to be used in place of 1005dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the memory allocation routines built into SQLite.</dd> 1006dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1007dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_CONFIG_GETMALLOC</dt> 1008dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This option takes a single argument which is a pointer to an 1009dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** instance of the [sqlite3_mem_methods] structure. The [sqlite3_mem_methods] 1010dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** structure is filled with the currently defined memory allocation routines. 1011dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This option can be used to overload the default memory allocation 1012dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** routines with a wrapper that simulations memory allocation failure or 1013dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** tracks memory usage, for example.</dd> 1014dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1015dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_CONFIG_MEMSTATUS</dt> 1016dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This option takes single argument of type int, interpreted as a 1017dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** boolean, which enables or disables the collection of memory allocation 1018dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** statistics. When disabled, the following SQLite interfaces become 1019dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** non-operational: 1020dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <ul> 1021dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [sqlite3_memory_used()] 1022dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [sqlite3_memory_highwater()] 1023dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [sqlite3_soft_heap_limit()] 1024dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [sqlite3_status()] 1025dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </ul> 1026dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </dd> 1027dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1028dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_CONFIG_SCRATCH</dt> 1029dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This option specifies a static memory buffer that SQLite can use for 1030dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** scratch memory. There are three arguments: A pointer to the memory, the 1031dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** size of each scratch buffer (sz), and the number of buffers (N). The sz 1032dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** argument must be a multiple of 16. The sz parameter should be a few bytes 1033dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** larger than the actual scratch space required due internal overhead. 1034dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The first 1035dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** argument should point to an allocation of at least sz*N bytes of memory. 1036dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite will use no more than one scratch buffer at once per thread, so 1037dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** N should be set to the expected maximum number of threads. The sz 1038dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** parameter should be 6 times the size of the largest database page size. 1039dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Scratch buffers are used as part of the btree balance operation. If 1040dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The btree balancer needs additional memory beyond what is provided by 1041dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** scratch buffers or if no scratch buffer space is specified, then SQLite 1042dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** goes to [sqlite3_malloc()] to obtain the memory it needs.</dd> 1043dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1044dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_CONFIG_PAGECACHE</dt> 1045dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This option specifies a static memory buffer that SQLite can use for 1046dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the database page cache with the default page cache implemenation. 1047dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This configuration should not be used if an application-define page 1048dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** cache implementation is loaded using the SQLITE_CONFIG_PCACHE option. 1049dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** There are three arguments to this option: A pointer to the 1050dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** memory, the size of each page buffer (sz), and the number of pages (N). 1051dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sz argument must be a power of two between 512 and 32768. The first 1052dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** argument should point to an allocation of at least sz*N bytes of memory. 1053dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite will use the memory provided by the first argument to satisfy its 1054dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** memory needs for the first N pages that it adds to cache. If additional 1055dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** page cache memory is needed beyond what is provided by this option, then 1056dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite goes to [sqlite3_malloc()] for the additional storage space. 1057dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The implementation might use one or more of the N buffers to hold 1058dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** memory accounting information. </dd> 1059dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1060dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_CONFIG_HEAP</dt> 1061dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This option specifies a static memory buffer that SQLite will use 1062dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for all of its dynamic memory allocation needs beyond those provided 1063dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE]. 1064dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** There are three arguments: A pointer to the memory, the number of 1065dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** bytes in the memory buffer, and the minimum allocation size. If 1066dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the first pointer (the memory pointer) is NULL, then SQLite reverts 1067dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to using its default memory allocator (the system malloc() implementation), 1068dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. If the 1069dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** memory pointer is not NULL and either [SQLITE_ENABLE_MEMSYS3] or 1070dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_ENABLE_MEMSYS5] are defined, then the alternative memory 1071dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** allocator is engaged to handle all of SQLites memory allocation needs.</dd> 1072dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1073dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_CONFIG_MUTEX</dt> 1074dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This option takes a single argument which is a pointer to an 1075dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** instance of the [sqlite3_mutex_methods] structure. The argument specifies 1076dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** alternative low-level mutex routines to be used in place 1077dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the mutex routines built into SQLite.</dd> 1078dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1079dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_CONFIG_GETMUTEX</dt> 1080dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This option takes a single argument which is a pointer to an 1081dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** instance of the [sqlite3_mutex_methods] structure. The 1082dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_mutex_methods] 1083dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** structure is filled with the currently defined mutex routines. 1084dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This option can be used to overload the default mutex allocation 1085dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** routines with a wrapper used to track mutex usage for performance 1086dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** profiling or testing, for example.</dd> 1087dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1088dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_CONFIG_LOOKASIDE</dt> 1089dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This option takes two arguments that determine the default 1090dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** memory allcation lookaside optimization. The first argument is the 1091dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** size of each lookaside buffer slot and the second is the number of 1092dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** slots allocated to each database connection.</dd> 1093dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1094dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_CONFIG_PCACHE</dt> 1095dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This option takes a single argument which is a pointer to 1096dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** an [sqlite3_pcache_methods] object. This object specifies the interface 1097dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to a custom page cache implementation. SQLite makes a copy of the 1098dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** object and uses it for page cache memory allocations.</dd> 1099dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1100dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_CONFIG_GETPCACHE</dt> 1101dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This option takes a single argument which is a pointer to an 1102dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_pcache_methods] object. SQLite copies of the current 1103dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** page cache implementation into that object.</dd> 1104dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1105dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </dl> 1106dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 1107dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */ 1108dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_CONFIG_MULTITHREAD 2 /* nil */ 1109dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_CONFIG_SERIALIZED 3 /* nil */ 1110dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */ 1111dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */ 1112dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */ 1113dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */ 1114dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */ 1115dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */ 1116dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */ 1117dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */ 1118dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */ 1119dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_CONFIG_LOOKASIDE 13 /* int int */ 1120dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_CONFIG_PCACHE 14 /* sqlite3_pcache_methods* */ 1121dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_CONFIG_GETPCACHE 15 /* sqlite3_pcache_methods* */ 1122dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 1123dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 1124dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Configuration Options {H10170} <S20000> 1125dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 1126dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1127dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These constants are the available integer configuration options that 1128dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** can be passed as the second argument to the [sqlite3_db_config()] interface. 1129dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1130dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** New configuration options may be added in future releases of SQLite. 1131dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Existing configuration options might be discontinued. Applications 1132dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** should check the return code from [sqlite3_db_config()] to make sure that 1133dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the call worked. The [sqlite3_db_config()] interface will return a 1134dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** non-zero [error code] if a discontinued or unsupported configuration option 1135dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is invoked. 1136dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1137dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dl> 1138dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt> 1139dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This option takes three additional arguments that determine the 1140dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [lookaside memory allocator] configuration for the [database connection]. 1141dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The first argument (the third parameter to [sqlite3_db_config()] is a 1142dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** pointer to a memory buffer to use for lookaside memory. The first 1143dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** argument may be NULL in which case SQLite will allocate the lookaside 1144dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** buffer itself using [sqlite3_malloc()]. The second argument is the 1145dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** size of each lookaside buffer slot and the third argument is the number of 1146dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** slots. The size of the buffer in the first argument must be greater than 1147dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or equal to the product of the second and third arguments.</dd> 1148dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1149dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </dl> 1150dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 1151dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */ 1152dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 1153dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 1154dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 1155dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Enable Or Disable Extended Result Codes {H12200} <S10700> 1156563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1157dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_extended_result_codes() routine enables or disables the 1158dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [extended result codes] feature of SQLite. The extended result 1159dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** codes are disabled by default for historical compatibility considerations. 1160563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1161dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 1162dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12201] [H12202] 1163563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 1164dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_extended_result_codes(sqlite3*, int onoff); 1165dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 1166dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 1167dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Last Insert Rowid {H12220} <S10700> 1168dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1169dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Each entry in an SQLite table has a unique 64-bit signed 1170dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** integer key called the [ROWID | "rowid"]. The rowid is always available 1171dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** as an undeclared column named ROWID, OID, or _ROWID_ as long as those 1172dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** names are not also used by explicitly declared columns. If 1173dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the table has a column of type [INTEGER PRIMARY KEY] then that column 1174dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is another alias for the rowid. 1175dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1176dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This routine returns the [rowid] of the most recent 1177dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** successful [INSERT] into the database from the [database connection] 1178dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** in the first argument. If no successful [INSERT]s 1179dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** have ever occurred on that database connection, zero is returned. 1180dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1181dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If an [INSERT] occurs within a trigger, then the [rowid] of the inserted 1182dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** row is returned by this routine as long as the trigger is running. 1183dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** But once the trigger terminates, the value returned by this routine 1184dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** reverts to the last value inserted before the trigger fired. 1185dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1186dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** An [INSERT] that fails due to a constraint violation is not a 1187dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** successful [INSERT] and does not change the value returned by this 1188dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** routine. Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK, 1189dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and INSERT OR ABORT make no changes to the return value of this 1190dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** routine when their insertion fails. When INSERT OR REPLACE 1191dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** encounters a constraint violation, it does not fail. The 1192dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** INSERT continues to completion after deleting rows that caused 1193dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the constraint problem so INSERT OR REPLACE will always change 1194dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the return value of this interface. 1195dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1196dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** For the purposes of this routine, an [INSERT] is considered to 1197dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** be successful even if it is subsequently rolled back. 1198dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1199dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 1200dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12221] [H12223] 1201dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1202dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If a separate thread performs a new [INSERT] on the same 1203dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** database connection while the [sqlite3_last_insert_rowid()] 1204dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** function is running and thus changes the last insert [rowid], 1205dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** then the value returned by [sqlite3_last_insert_rowid()] is 1206dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** unpredictable and might not equal either the old or the new 1207dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** last insert [rowid]. 1208dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 1209dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocksqlite3_int64 sqlite3_last_insert_rowid(sqlite3*); 1210563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 1211563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 1212dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Count The Number Of Rows Modified {H12240} <S10600> 1213563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1214563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** This function returns the number of database rows that were changed 1215dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or inserted or deleted by the most recently completed SQL statement 1216dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** on the [database connection] specified by the first parameter. 1217dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Only changes that are directly specified by the [INSERT], [UPDATE], 1218dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or [DELETE] statement are counted. Auxiliary changes caused by 1219dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** triggers are not counted. Use the [sqlite3_total_changes()] function 1220563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** to find the total number of changes including changes caused by triggers. 1221563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1222dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** A "row change" is a change to a single row of a single table 1223dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** caused by an INSERT, DELETE, or UPDATE statement. Rows that 1224dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** are changed as side effects of REPLACE constraint resolution, 1225dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** rollback, ABORT processing, DROP TABLE, or by any other 1226dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** mechanisms do not count as direct row changes. 1227dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1228dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** A "trigger context" is a scope of execution that begins and 1229dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** ends with the script of a trigger. Most SQL statements are 1230dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** evaluated outside of any trigger. This is the "top level" 1231dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** trigger context. If a trigger fires from the top level, a 1232dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** new trigger context is entered for the duration of that one 1233dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** trigger. Subtriggers create subcontexts for their duration. 1234dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1235dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Calling [sqlite3_exec()] or [sqlite3_step()] recursively does 1236dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** not create a new trigger context. 1237dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1238dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This function returns the number of direct row changes in the 1239dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** most recent INSERT, UPDATE, or DELETE statement within the same 1240dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** trigger context. 1241dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1242dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Thus, when called from the top level, this function returns the 1243dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** number of changes in the most recent INSERT, UPDATE, or DELETE 1244dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that also occurred at the top level. Within the body of a trigger, 1245dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the sqlite3_changes() interface can be called to find the number of 1246563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** changes in the most recently completed INSERT, UPDATE, or DELETE 1247dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** statement within the body of the same trigger. 1248dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** However, the number returned does not include changes 1249dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** caused by subtriggers since those have their own context. 1250563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1251563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** SQLite implements the command "DELETE FROM table" without a WHERE clause 1252dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** by dropping and recreating the table. Doing so is much faster than going 1253dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** through and deleting individual elements from the table. Because of this 1254dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** optimization, the deletions in "DELETE FROM table" are not row changes and 1255dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** will not be counted by the sqlite3_changes() or [sqlite3_total_changes()] 1256dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** functions, regardless of the number of elements that were originally 1257dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** in the table. To get an accurate count of the number of rows deleted, use 1258dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** "DELETE FROM table WHERE 1" instead. Or recompile using the 1259dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_OMIT_TRUNCATE_OPTIMIZATION] compile-time option to disable the 1260dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** optimization on all queries. 1261dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1262dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 1263dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12241] [H12243] 1264dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1265dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If a separate thread makes changes on the same database connection 1266dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** while [sqlite3_changes()] is running then the value returned 1267dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is unpredictable and not meaningful. 1268563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 1269563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_changes(sqlite3*); 1270563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 1271563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 1272dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Total Number Of Rows Modified {H12260} <S10600> 1273563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1274dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This function returns the number of row changes caused by INSERT, 1275dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** UPDATE or DELETE statements since the [database connection] was opened. 1276dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The count includes all changes from all trigger contexts. However, 1277dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the count does not include changes used to implement REPLACE constraints, 1278dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** do rollbacks or ABORT processing, or DROP table processing. 1279dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The changes are counted as soon as the statement that makes them is 1280dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** completed (when the statement handle is passed to [sqlite3_reset()] or 1281dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_finalize()]). 1282563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1283563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** SQLite implements the command "DELETE FROM table" without a WHERE clause 1284563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** by dropping and recreating the table. (This is much faster than going 1285dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** through and deleting individual elements from the table.) Because of this 1286dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** optimization, the deletions in "DELETE FROM table" are not row changes and 1287dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** will not be counted by the sqlite3_changes() or [sqlite3_total_changes()] 1288dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** functions, regardless of the number of elements that were originally 1289dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** in the table. To get an accurate count of the number of rows deleted, use 1290dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** "DELETE FROM table WHERE 1" instead. Or recompile using the 1291dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_OMIT_TRUNCATE_OPTIMIZATION] compile-time option to disable the 1292dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** optimization on all queries. 1293dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1294dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** See also the [sqlite3_changes()] interface. 1295dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1296dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 1297dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12261] [H12263] 1298dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1299dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If a separate thread makes changes on the same database connection 1300dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** while [sqlite3_total_changes()] is running then the value 1301dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** returned is unpredictable and not meaningful. 1302563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 1303563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_total_changes(sqlite3*); 1304563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 1305563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 1306dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Interrupt A Long-Running Query {H12270} <S30500> 1307563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1308563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** This function causes any pending database operation to abort and 1309dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** return at its earliest opportunity. This routine is typically 1310563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** called in response to a user action such as pressing "Cancel" 1311563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** or Ctrl-C where the user wants a long query operation to halt 1312563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** immediately. 1313563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1314563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** It is safe to call this routine from a thread different from the 1315dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** thread that is currently running the database operation. But it 1316dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is not safe to call this routine with a [database connection] that 1317dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is closed or might close before sqlite3_interrupt() returns. 1318dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1319dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If an SQL operation is very nearly finished at the time when 1320dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_interrupt() is called, then it might not have an opportunity 1321dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to be interrupted and might continue to completion. 1322563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1323dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** An SQL operation that is interrupted will return [SQLITE_INTERRUPT]. 1324dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the interrupted SQL operation is an INSERT, UPDATE, or DELETE 1325dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that is inside an explicit transaction, then the entire transaction 1326dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** will be rolled back automatically. 1327dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1328dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** A call to sqlite3_interrupt() has no effect on SQL statements 1329dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that are started after sqlite3_interrupt() returns. 1330dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1331dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 1332dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12271] [H12272] 1333dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1334dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the database connection closes while [sqlite3_interrupt()] 1335dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is running then bad things will likely happen. 1336563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 1337563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid sqlite3_interrupt(sqlite3*); 1338563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 1339563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 1340dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Determine If An SQL Statement Is Complete {H10510} <S70200> 1341563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1342563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** These routines are useful for command-line input to determine if the 1343dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** currently entered text seems to form complete a SQL statement or 1344dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** if additional input is needed before sending the text into 1345dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite for parsing. These routines return true if the input string 1346dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** appears to be a complete SQL statement. A statement is judged to be 1347dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** complete if it ends with a semicolon token and is not a fragment of a 1348dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CREATE TRIGGER statement. Semicolons that are embedded within 1349dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** string literals or quoted identifier names or comments are not 1350dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** independent tokens (they are part of the token in which they are 1351dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** embedded) and thus do not count as a statement terminator. 1352dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1353dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These routines do not parse the SQL statements thus 1354dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** will not detect syntactically incorrect SQL. 1355dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1356dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: [H10511] [H10512] 1357dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1358dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The input to [sqlite3_complete()] must be a zero-terminated 1359dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** UTF-8 string. 1360dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1361dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The input to [sqlite3_complete16()] must be a zero-terminated 1362dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** UTF-16 string in native byte order. 1363563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 1364563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_complete(const char *sql); 1365563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_complete16(const void *sql); 1366563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 1367563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 1368dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors {H12310} <S40400> 1369dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1370dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This routine sets a callback function that might be invoked whenever 1371dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** an attempt is made to open a database table that another thread 1372dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or process has locked. 1373dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1374dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the busy callback is NULL, then [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] 1375dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is returned immediately upon encountering the lock. If the busy callback 1376dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is not NULL, then the callback will be invoked with two arguments. 1377dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1378dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The first argument to the handler is a copy of the void* pointer which 1379dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is the third argument to sqlite3_busy_handler(). The second argument to 1380dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the handler callback is the number of times that the busy handler has 1381dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** been invoked for this locking event. If the 1382563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** busy callback returns 0, then no additional attempts are made to 1383563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned. 1384dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the callback returns non-zero, then another attempt 1385dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is made to open the database for reading and the cycle repeats. 1386563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1387dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The presence of a busy handler does not guarantee that it will be invoked 1388dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** when there is lock contention. If SQLite determines that invoking the busy 1389dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY] 1390dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or [SQLITE_IOERR_BLOCKED] instead of invoking the busy handler. 1391563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Consider a scenario where one process is holding a read lock that 1392563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** it is trying to promote to a reserved lock and 1393563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** a second process is holding a reserved lock that it is trying 1394563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** to promote to an exclusive lock. The first process cannot proceed 1395563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** because it is blocked by the second and the second process cannot 1396563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** proceed because it is blocked by the first. If both processes 1397563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** invoke the busy handlers, neither will make any progress. Therefore, 1398563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** SQLite returns [SQLITE_BUSY] for the first process, hoping that this 1399563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** will induce the first process to release its read lock and allow 1400563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the second process to proceed. 1401563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1402563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The default busy callback is NULL. 1403563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1404dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED] 1405dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** when SQLite is in the middle of a large transaction where all the 1406563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** changes will not fit into the in-memory cache. SQLite will 1407563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** already hold a RESERVED lock on the database file, but it needs 1408563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** to promote this lock to EXCLUSIVE so that it can spill cache 1409563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** pages into the database file without harm to concurrent 1410563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** readers. If it is unable to promote the lock, then the in-memory 1411563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** cache will be left in an inconsistent state and so the error 1412563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** code is promoted from the relatively benign [SQLITE_BUSY] to 1413563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the more severe [SQLITE_IOERR_BLOCKED]. This error code promotion 1414dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** forces an automatic rollback of the changes. See the 1415dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <a href="/cvstrac/wiki?p=CorruptionFollowingBusyError"> 1416563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** CorruptionFollowingBusyError</a> wiki page for a discussion of why 1417563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** this is important. 1418dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1419dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** There can only be a single busy handler defined for each 1420dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [database connection]. Setting a new busy handler clears any 1421dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** previously set handler. Note that calling [sqlite3_busy_timeout()] 1422dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** will also set or clear the busy handler. 1423dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1424dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The busy callback should not take any actions which modify the 1425dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** database connection that invoked the busy handler. Any such actions 1426dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** result in undefined behavior. 1427dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1428dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 1429dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12311] [H12312] [H12314] [H12316] [H12318] 1430dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1431dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** A busy handler must not close the database connection 1432dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or [prepared statement] that invoked the busy handler. 1433563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 1434563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*); 1435563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 1436563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 1437dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Set A Busy Timeout {H12340} <S40410> 1438563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1439dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This routine sets a [sqlite3_busy_handler | busy handler] that sleeps 1440dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for a specified amount of time when a table is locked. The handler 1441dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** will sleep multiple times until at least "ms" milliseconds of sleeping 1442dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** have accumulated. {H12343} After "ms" milliseconds of sleeping, 1443dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the handler returns 0 which causes [sqlite3_step()] to return 1444dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED]. 1445563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1446563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Calling this routine with an argument less than or equal to zero 1447563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** turns off all busy handlers. 1448563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1449dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** There can only be a single busy handler for a particular 1450dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [database connection] any any given moment. If another busy handler 1451dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** was defined (using [sqlite3_busy_handler()]) prior to calling 1452563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** this routine, that other busy handler is cleared. 1453dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1454dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 1455dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12341] [H12343] [H12344] 1456563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 1457563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_busy_timeout(sqlite3*, int ms); 1458563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 1459563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 1460dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Convenience Routines For Running Queries {H12370} <S10000> 1461563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1462dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Definition: A <b>result table</b> is memory data structure created by the 1463dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_get_table()] interface. A result table records the 1464dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** complete query results from one or more queries. 1465563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1466dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The table conceptually has a number of rows and columns. But 1467dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** these numbers are not part of the result table itself. These 1468dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** numbers are obtained separately. Let N be the number of rows 1469dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and M be the number of columns. 1470563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1471dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** A result table is an array of pointers to zero-terminated UTF-8 strings. 1472dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** There are (N+1)*M elements in the array. The first M pointers point 1473dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to zero-terminated strings that contain the names of the columns. 1474dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The remaining entries all point to query results. NULL values result 1475dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** in NULL pointers. All other values are in their UTF-8 zero-terminated 1476dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** string representation as returned by [sqlite3_column_text()]. 1477dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1478dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** A result table might consist of one or more memory allocations. 1479dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** It is not safe to pass a result table directly to [sqlite3_free()]. 1480dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** A result table should be deallocated using [sqlite3_free_table()]. 1481dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1482dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** As an example of the result table format, suppose a query result 1483dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is as follows: 1484dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1485dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <blockquote><pre> 1486563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Name | Age 1487563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** ----------------------- 1488563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Alice | 43 1489563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Bob | 28 1490563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Cindy | 21 1491dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </pre></blockquote> 1492563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1493dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** There are two column (M==2) and three rows (N==3). Thus the 1494dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** result table has 8 entries. Suppose the result table is stored 1495dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** in an array names azResult. Then azResult holds this content: 1496563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1497dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <blockquote><pre> 1498dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** azResult[0] = "Name"; 1499dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** azResult[1] = "Age"; 1500dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** azResult[2] = "Alice"; 1501dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** azResult[3] = "43"; 1502dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** azResult[4] = "Bob"; 1503dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** azResult[5] = "28"; 1504dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** azResult[6] = "Cindy"; 1505dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** azResult[7] = "21"; 1506dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </pre></blockquote> 1507563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1508dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_get_table() function evaluates one or more 1509dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** semicolon-separated SQL statements in the zero-terminated UTF-8 1510dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** string of its 2nd parameter. It returns a result table to the 1511dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** pointer given in its 3rd parameter. 1512dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1513dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** After the calling function has finished using the result, it should 1514dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** pass the pointer to the result table to sqlite3_free_table() in order to 1515dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** release the memory that was malloced. Because of the way the 1516dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling 1517dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** function must not try to call [sqlite3_free()] directly. Only 1518dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_free_table()] is able to release the memory properly and safely. 1519dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1520dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_get_table() interface is implemented as a wrapper around 1521dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access 1522dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to any internal data structures of SQLite. It uses only the public 1523dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** interface defined here. As a consequence, errors that occur in the 1524dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** wrapper layer outside of the internal [sqlite3_exec()] call are not 1525dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** reflected in subsequent calls to [sqlite3_errcode()] or [sqlite3_errmsg()]. 1526dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1527dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 1528dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12371] [H12373] [H12374] [H12376] [H12379] [H12382] 1529563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 1530563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_get_table( 1531dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block sqlite3 *db, /* An open database */ 1532dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block const char *zSql, /* SQL to be evaluated */ 1533dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block char ***pazResult, /* Results of the query */ 1534dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int *pnRow, /* Number of result rows written here */ 1535dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int *pnColumn, /* Number of result columns written here */ 1536dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block char **pzErrmsg /* Error msg written here */ 1537563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 1538563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid sqlite3_free_table(char **result); 1539563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 1540563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 1541dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Formatted String Printing Functions {H17400} <S70000><S20000> 1542563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1543563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** These routines are workalikes of the "printf()" family of functions 1544563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** from the standard C library. 1545563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1546563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The sqlite3_mprintf() and sqlite3_vmprintf() routines write their 1547dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** results into memory obtained from [sqlite3_malloc()]. 1548563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The strings returned by these two routines should be 1549563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** released by [sqlite3_free()]. Both routines return a 1550563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** NULL pointer if [sqlite3_malloc()] is unable to allocate enough 1551563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** memory to hold the resulting string. 1552563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1553563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** In sqlite3_snprintf() routine is similar to "snprintf()" from 1554563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the standard C library. The result is written into the 1555563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** buffer supplied as the second parameter whose size is given by 1556dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the first parameter. Note that the order of the 1557563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** first two parameters is reversed from snprintf(). This is an 1558563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** historical accident that cannot be fixed without breaking 1559563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** backwards compatibility. Note also that sqlite3_snprintf() 1560563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** returns a pointer to its buffer instead of the number of 1561563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** characters actually written into the buffer. We admit that 1562563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the number of characters written would be a more useful return 1563563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** value but we cannot change the implementation of sqlite3_snprintf() 1564563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** now without breaking compatibility. 1565563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1566563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** As long as the buffer size is greater than zero, sqlite3_snprintf() 1567563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** guarantees that the buffer is always zero-terminated. The first 1568563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** parameter "n" is the total size of the buffer, including space for 1569563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the zero terminator. So the longest string that can be completely 1570563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** written will be n-1 characters. 1571563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1572563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** These routines all implement some additional formatting 1573563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** options that are useful for constructing SQL statements. 1574dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** All of the usual printf() formatting options apply. In addition, there 1575dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is are "%q", "%Q", and "%z" options. 1576563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1577563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The %q option works like %s in that it substitutes a null-terminated 1578563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** string from the argument list. But %q also doubles every '\'' character. 1579563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** %q is designed for use inside a string literal. By doubling each '\'' 1580563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** character it escapes that character and allows it to be inserted into 1581563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the string. 1582563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1583dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** For example, assume the string variable zText contains text as follows: 1584563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1585563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <blockquote><pre> 1586563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** char *zText = "It's a happy day!"; 1587563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** </pre></blockquote> 1588563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1589563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** One can use this text in an SQL statement as follows: 1590563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1591563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <blockquote><pre> 1592563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText); 1593563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** sqlite3_exec(db, zSQL, 0, 0, 0); 1594563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** sqlite3_free(zSQL); 1595563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** </pre></blockquote> 1596563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1597563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Because the %q format string is used, the '\'' character in zText 1598563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** is escaped and the SQL generated is as follows: 1599563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1600563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <blockquote><pre> 1601563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** INSERT INTO table1 VALUES('It''s a happy day!') 1602563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** </pre></blockquote> 1603563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1604563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** This is correct. Had we used %s instead of %q, the generated SQL 1605563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** would have looked like this: 1606563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1607563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <blockquote><pre> 1608563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** INSERT INTO table1 VALUES('It's a happy day!'); 1609563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** </pre></blockquote> 1610563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1611dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This second example is an SQL syntax error. As a general rule you should 1612dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** always use %q instead of %s when inserting text into a string literal. 1613563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1614563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The %Q option works like %q except it also adds single quotes around 1615dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the outside of the total string. Additionally, if the parameter in the 1616dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** argument list is a NULL pointer, %Q substitutes the text "NULL" (without 1617dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** single quotes) in place of the %Q option. So, for example, one could say: 1618563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1619563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <blockquote><pre> 1620563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText); 1621563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** sqlite3_exec(db, zSQL, 0, 0, 0); 1622563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** sqlite3_free(zSQL); 1623563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** </pre></blockquote> 1624563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1625563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The code above will render a correct SQL statement in the zSQL 1626563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** variable even if the zText variable is a NULL pointer. 1627dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1628dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The "%z" formatting option works exactly like "%s" with the 1629dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** addition that after the string has been read and copied into 1630dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the result, [sqlite3_free()] is called on the input string. {END} 1631dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1632dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 1633dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H17403] [H17406] [H17407] 1634563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 1635563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkchar *sqlite3_mprintf(const char*,...); 1636563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkchar *sqlite3_vmprintf(const char*, va_list); 1637563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkchar *sqlite3_snprintf(int,char*,const char*, ...); 1638563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 1639563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 1640dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Memory Allocation Subsystem {H17300} <S20000> 1641dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1642dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The SQLite core uses these three routines for all of its own 1643dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** internal memory allocation needs. "Core" in the previous sentence 1644dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** does not include operating-system specific VFS implementation. The 1645dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Windows VFS uses native malloc() and free() for some operations. 1646dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1647dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_malloc() routine returns a pointer to a block 1648dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of memory at least N bytes in length, where N is the parameter. 1649dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If sqlite3_malloc() is unable to obtain sufficient free 1650dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** memory, it returns a NULL pointer. If the parameter N to 1651dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns 1652dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a NULL pointer. 1653dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1654dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Calling sqlite3_free() with a pointer previously returned 1655dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** by sqlite3_malloc() or sqlite3_realloc() releases that memory so 1656dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that it might be reused. The sqlite3_free() routine is 1657dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a no-op if is called with a NULL pointer. Passing a NULL pointer 1658dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to sqlite3_free() is harmless. After being freed, memory 1659dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** should neither be read nor written. Even reading previously freed 1660dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** memory might result in a segmentation fault or other severe error. 1661dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Memory corruption, a segmentation fault, or other severe error 1662dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** might result if sqlite3_free() is called with a non-NULL pointer that 1663dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** was not obtained from sqlite3_malloc() or sqlite3_realloc(). 1664dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1665dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_realloc() interface attempts to resize a 1666dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** prior memory allocation to be at least N bytes, where N is the 1667dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** second parameter. The memory allocation to be resized is the first 1668dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** parameter. If the first parameter to sqlite3_realloc() 1669dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is a NULL pointer then its behavior is identical to calling 1670dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc(). 1671dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the second parameter to sqlite3_realloc() is zero or 1672dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** negative then the behavior is exactly the same as calling 1673dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_free(P) where P is the first parameter to sqlite3_realloc(). 1674dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_realloc() returns a pointer to a memory allocation 1675dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of at least N bytes in size or NULL if sufficient memory is unavailable. 1676dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If M is the size of the prior allocation, then min(N,M) bytes 1677dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of the prior allocation are copied into the beginning of buffer returned 1678dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** by sqlite3_realloc() and the prior allocation is freed. 1679dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If sqlite3_realloc() returns NULL, then the prior allocation 1680dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is not freed. 1681dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1682dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The memory returned by sqlite3_malloc() and sqlite3_realloc() 1683dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is always aligned to at least an 8 byte boundary. {END} 1684dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1685dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The default implementation of the memory allocation subsystem uses 1686dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the malloc(), realloc() and free() provided by the standard C library. 1687dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H17382} However, if SQLite is compiled with the 1688dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLITE_MEMORY_SIZE=<i>NNN</i> C preprocessor macro (where <i>NNN</i> 1689dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is an integer), then SQLite create a static array of at least 1690dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <i>NNN</i> bytes in size and uses that array for all of its dynamic 1691dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** memory allocation needs. {END} Additional memory allocator options 1692dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** may be added in future releases. 1693dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1694dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** In SQLite version 3.5.0 and 3.5.1, it was possible to define 1695dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in 1696dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** implementation of these routines to be omitted. That capability 1697dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is no longer provided. Only built-in memory allocators can be used. 1698dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1699dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The Windows OS interface layer calls 1700dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the system malloc() and free() directly when converting 1701dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** filenames between the UTF-8 encoding used by SQLite 1702dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and whatever filename encoding is used by the particular Windows 1703dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** installation. Memory allocation errors are detected, but 1704dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** they are reported back as [SQLITE_CANTOPEN] or 1705dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_IOERR] rather than [SQLITE_NOMEM]. 1706dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1707dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 1708dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H17303] [H17304] [H17305] [H17306] [H17310] [H17312] [H17315] [H17318] 1709dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H17321] [H17322] [H17323] 1710dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1711dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()] 1712dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** must be either NULL or else pointers obtained from a prior 1713dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have 1714dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** not yet been released. 1715dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1716dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The application must not read or write any part of 1717dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a block of memory after it has been released using 1718dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_free()] or [sqlite3_realloc()]. 1719563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 1720563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid *sqlite3_malloc(int); 1721563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid *sqlite3_realloc(void*, int); 1722563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid sqlite3_free(void*); 1723563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 1724563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 1725dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Memory Allocator Statistics {H17370} <S30210> 1726dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1727dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite provides these two interfaces for reporting on the status 1728dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()] 1729dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** routines, which form the built-in memory allocation subsystem. 1730dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1731dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 1732dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H17371] [H17373] [H17374] [H17375] 1733dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 1734dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocksqlite3_int64 sqlite3_memory_used(void); 1735dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocksqlite3_int64 sqlite3_memory_highwater(int resetFlag); 1736dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 1737dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 1738dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Pseudo-Random Number Generator {H17390} <S20000> 1739dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1740dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite contains a high-quality pseudo-random number generator (PRNG) used to 1741dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** select random [ROWID | ROWIDs] when inserting new records into a table that 1742dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** already uses the largest possible [ROWID]. The PRNG is also used for 1743dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the build-in random() and randomblob() SQL functions. This interface allows 1744dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** applications to access the same PRNG for other purposes. 1745dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1746dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** A call to this routine stores N bytes of randomness into buffer P. 1747dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1748dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The first time this routine is invoked (either internally or by 1749dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the application) the PRNG is seeded using randomness obtained 1750dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** from the xRandomness method of the default [sqlite3_vfs] object. 1751dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** On all subsequent invocations, the pseudo-randomness is generated 1752dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** internally and without recourse to the [sqlite3_vfs] xRandomness 1753dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** method. 1754dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1755dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 1756dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H17392] 1757dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 1758dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockvoid sqlite3_randomness(int N, void *P); 1759dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 1760dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 1761dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Compile-Time Authorization Callbacks {H12500} <S70100> 1762dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1763dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This routine registers a authorizer callback with a particular 1764dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [database connection], supplied in the first argument. 1765563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The authorizer callback is invoked as SQL statements are being compiled 1766563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()], 1767563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. At various 1768563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** points during the compilation process, as logic is being created 1769563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** to perform various actions, the authorizer callback is invoked to 1770563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** see if those actions are allowed. The authorizer callback should 1771dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the 1772563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** specific action but allow the SQL statement to continue to be 1773563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be 1774dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** rejected with an error. If the authorizer callback returns 1775dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY] 1776dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** then the [sqlite3_prepare_v2()] or equivalent call that triggered 1777dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the authorizer will fail with an error message. 1778dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1779dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** When the callback returns [SQLITE_OK], that means the operation 1780dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** requested is ok. When the callback returns [SQLITE_DENY], the 1781dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_prepare_v2()] or equivalent call that triggered the 1782dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** authorizer will fail with an error message explaining that 1783dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** access is denied. If the authorizer code is [SQLITE_READ] 1784dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and the callback returns [SQLITE_IGNORE] then the 1785dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [prepared statement] statement is constructed to substitute 1786dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a NULL value in place of the table column that would have 1787dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE] 1788dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** return can be used to deny an untrusted user access to individual 1789dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** columns of a table. 1790dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1791dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The first parameter to the authorizer callback is a copy of the third 1792dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** parameter to the sqlite3_set_authorizer() interface. The second parameter 1793dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to the callback is an integer [SQLITE_COPY | action code] that specifies 1794dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the particular action to be authorized. The third through sixth parameters 1795dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to the callback are zero-terminated strings that contain additional 1796563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** details about the action to be authorized. 1797563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1798dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** An authorizer is used when [sqlite3_prepare | preparing] 1799dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQL statements from an untrusted source, to ensure that the SQL statements 1800dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** do not try to access data they are not allowed to see, or that they do not 1801dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** try to execute malicious statements that damage the database. For 1802563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** example, an application may allow a user to enter arbitrary 1803563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** SQL queries for evaluation by a database. But the application does 1804563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** not want the user to be able to make arbitrary changes to the 1805563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** database. An authorizer could then be put in place while the 1806dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** user-entered SQL is being [sqlite3_prepare | prepared] that 1807dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** disallows everything except [SELECT] statements. 1808dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1809dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Applications that need to process SQL from untrusted sources 1810dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** might also consider lowering resource limits using [sqlite3_limit()] 1811dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and limiting database size using the [max_page_count] [PRAGMA] 1812dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** in addition to using an authorizer. 1813563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1814563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Only a single authorizer can be in place on a database connection 1815563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** at a time. Each call to sqlite3_set_authorizer overrides the 1816dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** previous call. Disable the authorizer by installing a NULL callback. 1817dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The authorizer is disabled by default. 1818dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1819dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The authorizer callback must not do anything that will modify 1820dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the database connection that invoked the authorizer callback. 1821dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 1822dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** database connections for the meaning of "modify" in this paragraph. 1823563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1824dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** When [sqlite3_prepare_v2()] is used to prepare a statement, the 1825dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** statement might be reprepared during [sqlite3_step()] due to a 1826dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** schema change. Hence, the application should ensure that the 1827dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** correct authorizer callback remains in place during the [sqlite3_step()]. 1828dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1829dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Note that the authorizer callback is invoked only during 1830563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** [sqlite3_prepare()] or its variants. Authorization is not 1831563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** performed during statement evaluation in [sqlite3_step()]. 1832dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1833dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 1834dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12501] [H12502] [H12503] [H12504] [H12505] [H12506] [H12507] [H12510] 1835dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12511] [H12512] [H12520] [H12521] [H12522] 1836563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 1837563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_set_authorizer( 1838563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3*, 1839563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int (*xAuth)(void*,int,const char*,const char*,const char*,const char*), 1840563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark void *pUserData 1841563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 1842563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 1843563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 1844dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Authorizer Return Codes {H12590} <H12500> 1845563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1846563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The [sqlite3_set_authorizer | authorizer callback function] must 1847563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** return either [SQLITE_OK] or one of these two constants in order 1848563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** to signal SQLite whether or not the action is permitted. See the 1849563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** [sqlite3_set_authorizer | authorizer documentation] for additional 1850563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** information. 1851563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 1852563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_DENY 1 /* Abort the SQL statement with an error */ 1853563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */ 1854563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 1855563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 1856dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Authorizer Action Codes {H12550} <H12500> 1857563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1858563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The [sqlite3_set_authorizer()] interface registers a callback function 1859dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that is invoked to authorize certain SQL statement actions. The 1860563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** second parameter to the callback is an integer code that specifies 1861563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** what action is being authorized. These are the integer action codes that 1862563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the authorizer callback may be passed. 1863563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1864dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These action code values signify what kind of operation is to be 1865dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** authorized. The 3rd and 4th parameters to the authorization 1866dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** callback function will be parameters or NULL depending on which of these 1867563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** codes is used as the second parameter. The 5th parameter to the 1868dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** authorizer callback is the name of the database ("main", "temp", 1869563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** etc.) if applicable. The 6th parameter to the authorizer callback 1870563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** is the name of the inner-most trigger or view that is responsible for 1871dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the access attempt or NULL if this access attempt is directly from 1872563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** top-level SQL code. 1873dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1874dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 1875dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12551] [H12552] [H12553] [H12554] 1876563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 1877563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/******************************************* 3rd ************ 4th ***********/ 1878563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */ 1879563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */ 1880563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */ 1881563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */ 1882563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */ 1883563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */ 1884563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */ 1885563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_CREATE_VIEW 8 /* View Name NULL */ 1886563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_DELETE 9 /* Table Name NULL */ 1887563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */ 1888563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_DROP_TABLE 11 /* Table Name NULL */ 1889563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */ 1890563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */ 1891563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */ 1892563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */ 1893563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */ 1894563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_DROP_VIEW 17 /* View Name NULL */ 1895563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_INSERT 18 /* Table Name NULL */ 1896563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */ 1897563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_READ 20 /* Table Name Column Name */ 1898563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_SELECT 21 /* NULL NULL */ 1899dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_TRANSACTION 22 /* Operation NULL */ 1900563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_UPDATE 23 /* Table Name Column Name */ 1901563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_ATTACH 24 /* Filename NULL */ 1902563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_DETACH 25 /* Database Name NULL */ 1903563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */ 1904563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_REINDEX 27 /* Index Name NULL */ 1905563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_ANALYZE 28 /* Table Name NULL */ 1906563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */ 1907563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */ 1908dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_FUNCTION 31 /* NULL Function Name */ 1909dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */ 1910563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_COPY 0 /* No longer used */ 1911563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 1912563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 1913dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Tracing And Profiling Functions {H12280} <S60400> 1914dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 1915563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1916563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** These routines register callback functions that can be used for 1917563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** tracing and profiling the execution of SQL statements. 1918dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1919dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The callback function registered by sqlite3_trace() is invoked at 1920dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** various times when an SQL statement is being run by [sqlite3_step()]. 1921dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The callback returns a UTF-8 rendering of the SQL statement text 1922dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** as the statement first begins executing. Additional callbacks occur 1923dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** as each triggered subprogram is entered. The callbacks for triggers 1924dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** contain a UTF-8 SQL comment that identifies the trigger. 1925dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1926563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The callback function registered by sqlite3_profile() is invoked 1927dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** as each SQL statement finishes. The profile callback contains 1928dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the original statement text and an estimate of wall-clock time 1929dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of how long that statement took to run. 1930563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1931dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 1932dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12281] [H12282] [H12283] [H12284] [H12285] [H12287] [H12288] [H12289] 1933dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12290] 1934563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 1935dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve BlockSQLITE_EXPERIMENTAL void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*); 1936dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve BlockSQLITE_EXPERIMENTAL void *sqlite3_profile(sqlite3*, 1937dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void(*xProfile)(void*,const char*,sqlite3_uint64), void*); 1938563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 1939563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 1940dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Query Progress Callbacks {H12910} <S60400> 1941563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1942dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This routine configures a callback function - the 1943dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** progress callback - that is invoked periodically during long 1944dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** running calls to [sqlite3_exec()], [sqlite3_step()] and 1945dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_get_table()]. An example use for this 1946563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** interface is to keep a GUI updated during a large query. 1947563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1948dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the progress callback returns non-zero, the operation is 1949dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** interrupted. This feature can be used to implement a 1950dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** "Cancel" button on a GUI progress dialog box. 1951dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1952dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The progress handler must not do anything that will modify 1953dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the database connection that invoked the progress handler. 1954dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 1955dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** database connections for the meaning of "modify" in this paragraph. 1956dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1957dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 1958dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12911] [H12912] [H12913] [H12914] [H12915] [H12916] [H12917] [H12918] 1959563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1960563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 1961563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*); 1962563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 1963563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 1964dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Opening A New Database Connection {H12700} <S40200> 1965dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1966dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These routines open an SQLite database file whose name is given by the 1967dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** filename argument. The filename argument is interpreted as UTF-8 for 1968dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte 1969dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** order for sqlite3_open16(). A [database connection] handle is usually 1970dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** returned in *ppDb, even if an error occurs. The only exception is that 1971dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** if SQLite is unable to allocate memory to hold the [sqlite3] object, 1972dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a NULL will be written into *ppDb instead of a pointer to the [sqlite3] 1973dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** object. If the database is opened (and/or created) successfully, then 1974dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_OK] is returned. Otherwise an [error code] is returned. The 1975dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain 1976563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** an English language description of the error. 1977563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 1978dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The default encoding for the database will be UTF-8 if 1979dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_open() or sqlite3_open_v2() is called and 1980dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** UTF-16 in the native byte order if sqlite3_open16() is used. 1981dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1982dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Whether or not an error occurs when it is opened, resources 1983dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** associated with the [database connection] handle should be released by 1984dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** passing it to [sqlite3_close()] when it is no longer required. 1985dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1986dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_open_v2() interface works like sqlite3_open() 1987dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** except that it accepts two additional parameters for additional control 1988dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** over the new database connection. The flags parameter can take one of 1989dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the following three values, optionally combined with the 1990dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_OPEN_NOMUTEX] or [SQLITE_OPEN_FULLMUTEX] flags: 1991dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1992dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dl> 1993dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>[SQLITE_OPEN_READONLY]</dt> 1994dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>The database is opened in read-only mode. If the database does not 1995dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** already exist, an error is returned.</dd> 1996dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 1997dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>[SQLITE_OPEN_READWRITE]</dt> 1998dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>The database is opened for reading and writing if possible, or reading 1999dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** only if the file is write protected by the operating system. In either 2000dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** case the database must already exist, otherwise an error is returned.</dd> 2001dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2002dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt> 2003dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>The database is opened for reading and writing, and is creates it if 2004dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** it does not already exist. This is the behavior that is always used for 2005dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_open() and sqlite3_open16().</dd> 2006dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </dl> 2007dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2008dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the 3rd parameter to sqlite3_open_v2() is not one of the 2009dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** combinations shown above or one of the combinations shown above combined 2010dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** with the [SQLITE_OPEN_NOMUTEX] or [SQLITE_OPEN_FULLMUTEX] flags, 2011dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** then the behavior is undefined. 2012dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2013dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection 2014dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** opens in the multi-thread [threading mode] as long as the single-thread 2015dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** mode has not been set at compile-time or start-time. If the 2016dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens 2017dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** in the serialized [threading mode] unless single-thread was 2018dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** previously selected at compile-time or start-time. 2019dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2020dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the filename is ":memory:", then a private, temporary in-memory database 2021dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is created for the connection. This in-memory database will vanish when 2022dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the database connection is closed. Future versions of SQLite might 2023dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** make use of additional special filenames that begin with the ":" character. 2024dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** It is recommended that when a database filename actually does begin with 2025dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a ":" character you should prefix the filename with a pathname such as 2026dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** "./" to avoid ambiguity. 2027dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2028dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the filename is an empty string, then a private, temporary 2029dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** on-disk database will be created. This private database will be 2030dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** automatically deleted as soon as the database connection is closed. 2031dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2032dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The fourth parameter to sqlite3_open_v2() is the name of the 2033dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_vfs] object that defines the operating system interface that 2034dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the new database connection should use. If the fourth parameter is 2035dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a NULL pointer then the default [sqlite3_vfs] object is used. 2036dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2037dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <b>Note to Windows users:</b> The encoding used for the filename argument 2038dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever 2039dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** codepage is currently defined. Filenames containing international 2040dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** characters must be converted to UTF-8 prior to passing them into 2041dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_open() or sqlite3_open_v2(). 2042dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2043dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 2044dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12701] [H12702] [H12703] [H12704] [H12706] [H12707] [H12709] [H12711] 2045dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12712] [H12713] [H12714] [H12717] [H12719] [H12721] [H12723] 2046563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 2047563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_open( 2048563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const char *filename, /* Database filename (UTF-8) */ 2049563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3 **ppDb /* OUT: SQLite db handle */ 2050563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 2051563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_open16( 2052563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const void *filename, /* Database filename (UTF-16) */ 2053563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3 **ppDb /* OUT: SQLite db handle */ 2054563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 2055dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_open_v2( 2056dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block const char *filename, /* Database filename (UTF-8) */ 2057dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block sqlite3 **ppDb, /* OUT: SQLite db handle */ 2058dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int flags, /* Flags */ 2059dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block const char *zVfs /* Name of VFS module to use */ 2060dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block); 2061563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 2062563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 2063dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Error Codes And Messages {H12800} <S60200> 2064dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2065dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_errcode() interface returns the numeric [result code] or 2066dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [extended result code] for the most recent failed sqlite3_* API call 2067dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** associated with a [database connection]. If a prior API call failed 2068dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** but the most recent API call succeeded, the return value from 2069dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_errcode() is undefined. The sqlite3_extended_errcode() 2070dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** interface is the same except that it always returns the 2071dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [extended result code] even when extended result codes are 2072dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** disabled. 2073dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2074dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_errmsg() and sqlite3_errmsg16() return English-language 2075dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** text that describes the error, as either UTF-8 or UTF-16 respectively. 2076dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Memory to hold the error message string is managed internally. 2077dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The application does not need to worry about freeing the result. 2078dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** However, the error string might be overwritten or deallocated by 2079dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** subsequent calls to other SQLite interface functions. 2080dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2081dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** When the serialized [threading mode] is in use, it might be the 2082dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** case that a second error occurs on a separate thread in between 2083dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the time of the first error and the call to these interfaces. 2084dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** When that happens, the second error will be reported since these 2085dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** interfaces always report the most recent result. To avoid 2086dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** this, each thread can obtain exclusive use of the [database connection] D 2087dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning 2088dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after 2089dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** all calls to the interfaces listed here are completed. 2090dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2091dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If an interface fails with SQLITE_MISUSE, that means the interface 2092dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** was invoked incorrectly by the application. In that case, the 2093dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** error code and message may or may not be set. 2094dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2095dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 2096dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12801] [H12802] [H12803] [H12807] [H12808] [H12809] 2097563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 2098563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_errcode(sqlite3 *db); 2099dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_extended_errcode(sqlite3 *db); 2100563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkconst char *sqlite3_errmsg(sqlite3*); 2101563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkconst void *sqlite3_errmsg16(sqlite3*); 2102563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 2103563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 2104dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: SQL Statement Object {H13000} <H13010> 2105dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: {prepared statement} {prepared statements} 2106563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2107dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** An instance of this object represents a single SQL statement. 2108dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This object is variously known as a "prepared statement" or a 2109563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** "compiled SQL statement" or simply as a "statement". 2110dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2111563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The life of a statement object goes something like this: 2112563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2113563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <ol> 2114563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <li> Create the object using [sqlite3_prepare_v2()] or a related 2115563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** function. 2116dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> Bind values to [host parameters] using the sqlite3_bind_*() 2117dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** interfaces. 2118563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <li> Run the SQL by calling [sqlite3_step()] one or more times. 2119563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <li> Reset the statement using [sqlite3_reset()] then go back 2120563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** to step 2. Do this zero or more times. 2121563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <li> Destroy the object using [sqlite3_finalize()]. 2122563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** </ol> 2123563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2124563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Refer to documentation on individual methods above for additional 2125563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** information. 2126563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 2127563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarktypedef struct sqlite3_stmt sqlite3_stmt; 2128563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 2129563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 2130dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Run-time Limits {H12760} <S20600> 2131dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2132dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This interface allows the size of various constructs to be limited 2133dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** on a connection by connection basis. The first parameter is the 2134dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [database connection] whose limit is to be set or queried. The 2135dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** second parameter is one of the [limit categories] that define a 2136dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** class of constructs to be size limited. The third parameter is the 2137dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** new limit for that construct. The function returns the old limit. 2138dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2139dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the new limit is a negative number, the limit is unchanged. 2140dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** For the limit category of SQLITE_LIMIT_XYZ there is a 2141dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [limits | hard upper bound] 2142dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** set by a compile-time C preprocessor macro named 2143dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [limits | SQLITE_MAX_XYZ]. 2144dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** (The "_LIMIT_" in the name is changed to "_MAX_".) 2145dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Attempts to increase a limit above its hard upper bound are 2146dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** silently truncated to the hard upper limit. 2147dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2148dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Run time limits are intended for use in applications that manage 2149dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** both their own internal database and also databases that are controlled 2150dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** by untrusted external sources. An example application might be a 2151dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** web browser that has its own databases for storing history and 2152dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** separate databases controlled by JavaScript applications downloaded 2153dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** off the Internet. The internal databases can be given the 2154dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** large, default limits. Databases managed by external sources can 2155dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** be given much smaller limits designed to prevent a denial of service 2156dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** attack. Developers might also want to use the [sqlite3_set_authorizer()] 2157dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** interface to further control untrusted SQL. The size of the database 2158dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** created by an untrusted script can be contained using the 2159dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [max_page_count] [PRAGMA]. 2160dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2161dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** New run-time limit categories may be added in future releases. 2162dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2163dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 2164dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12762] [H12766] [H12769] 2165dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 2166dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_limit(sqlite3*, int id, int newVal); 2167dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 2168dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 2169dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Run-Time Limit Categories {H12790} <H12760> 2170dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: {limit category} {limit categories} 2171dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2172dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These constants define various performance limits 2173dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that can be lowered at run-time using [sqlite3_limit()]. 2174dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The synopsis of the meanings of the various limits is shown below. 2175dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Additional information is available at [limits | Limits in SQLite]. 2176dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2177dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dl> 2178dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_LIMIT_LENGTH</dt> 2179dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>The maximum size of any string or BLOB or table row.<dd> 2180dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2181dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_LIMIT_SQL_LENGTH</dt> 2182dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>The maximum length of an SQL statement.</dd> 2183dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2184dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_LIMIT_COLUMN</dt> 2185dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>The maximum number of columns in a table definition or in the 2186dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** result set of a [SELECT] or the maximum number of columns in an index 2187dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or in an ORDER BY or GROUP BY clause.</dd> 2188dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2189dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_LIMIT_EXPR_DEPTH</dt> 2190dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>The maximum depth of the parse tree on any expression.</dd> 2191dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2192dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_LIMIT_COMPOUND_SELECT</dt> 2193dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>The maximum number of terms in a compound SELECT statement.</dd> 2194dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2195dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_LIMIT_VDBE_OP</dt> 2196dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>The maximum number of instructions in a virtual machine program 2197dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** used to implement an SQL statement.</dd> 2198dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2199dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_LIMIT_FUNCTION_ARG</dt> 2200dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>The maximum number of arguments on a function.</dd> 2201dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2202dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_LIMIT_ATTACHED</dt> 2203dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>The maximum number of [ATTACH | attached databases].</dd> 2204dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2205dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt> 2206dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>The maximum length of the pattern argument to the [LIKE] or 2207dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [GLOB] operators.</dd> 2208dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2209dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt> 2210dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>The maximum number of variables in an SQL statement that can 2211dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** be bound.</dd> 2212dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </dl> 2213dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 2214dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_LIMIT_LENGTH 0 2215dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_LIMIT_SQL_LENGTH 1 2216dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_LIMIT_COLUMN 2 2217dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_LIMIT_EXPR_DEPTH 3 2218dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_LIMIT_COMPOUND_SELECT 4 2219dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_LIMIT_VDBE_OP 5 2220dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_LIMIT_FUNCTION_ARG 6 2221dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_LIMIT_ATTACHED 7 2222dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8 2223dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_LIMIT_VARIABLE_NUMBER 9 2224dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 2225dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 2226dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Compiling An SQL Statement {H13010} <S10000> 2227dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: {SQL statement compiler} 2228563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2229563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** To execute an SQL query, it must first be compiled into a byte-code 2230dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** program using one of these routines. 2231563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2232dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The first argument, "db", is a [database connection] obtained from a 2233dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** prior call to [sqlite3_open()], [sqlite3_open_v2()] or [sqlite3_open16()]. 2234dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2235dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The second argument, "zSql", is the statement to be compiled, encoded 2236563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2() 2237dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2() 2238dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** use UTF-16. 2239dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2240dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the nByte argument is less than zero, then zSql is read up to the 2241dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** first zero terminator. If nByte is non-negative, then it is the maximum 2242dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** number of bytes read from zSql. When nByte is non-negative, the 2243dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** zSql string ends at either the first '\000' or '\u0000' character or 2244dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the nByte-th byte, whichever comes first. If the caller knows 2245dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that the supplied string is nul-terminated, then there is a small 2246dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** performance advantage to be gained by passing an nByte parameter that 2247dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is equal to the number of bytes in the input string <i>including</i> 2248dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the nul-terminator bytes. 2249dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2250dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** *pzTail is made to point to the first byte past the end of the 2251dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** first SQL statement in zSql. These routines only compile the first 2252dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** statement in zSql, so *pzTail is left pointing to what remains 2253dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** uncompiled. 2254dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2255dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** *ppStmt is left pointing to a compiled [prepared statement] that can be 2256dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** executed using [sqlite3_step()]. If there is an error, *ppStmt is set 2257dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to NULL. If the input text contains no SQL (if the input is an empty 2258dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** string or a comment) then *ppStmt is set to NULL. 2259dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {A13018} The calling procedure is responsible for deleting the compiled 2260dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQL statement using [sqlite3_finalize()] after it has finished with it. 2261dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2262dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** On success, [SQLITE_OK] is returned, otherwise an [error code] is returned. 2263563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2264563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are 2265563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** recommended for all new programs. The two older interfaces are retained 2266563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** for backwards compatibility, but their use is discouraged. 2267563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** In the "v2" interfaces, the prepared statement 2268dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that is returned (the [sqlite3_stmt] object) contains a copy of the 2269563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** original SQL text. This causes the [sqlite3_step()] interface to 2270563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** behave a differently in two ways: 2271563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2272563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <ol> 2273563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <li> 2274563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** If the database schema changes, instead of returning [SQLITE_SCHEMA] as it 2275563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** always used to do, [sqlite3_step()] will automatically recompile the SQL 2276dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** statement and try to run it again. If the schema has changed in 2277dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a way that makes the statement no longer valid, [sqlite3_step()] will still 2278563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** return [SQLITE_SCHEMA]. But unlike the legacy behavior, [SQLITE_SCHEMA] is 2279563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** now a fatal error. Calling [sqlite3_prepare_v2()] again will not make the 2280dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** error go away. Note: use [sqlite3_errmsg()] to find the text 2281dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of the parsing error that results in an [SQLITE_SCHEMA] return. 2282563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** </li> 2283563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2284563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <li> 2285dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** When an error occurs, [sqlite3_step()] will return one of the detailed 2286dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [error codes] or [extended error codes]. The legacy behavior was that 2287dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code 2288dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and you would have to make a second call to [sqlite3_reset()] in order 2289dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to find the underlying cause of the problem. With the "v2" prepare 2290dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** interfaces, the underlying reason for the error is returned immediately. 2291563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** </li> 2292563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** </ol> 2293dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2294dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 2295dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H13011] [H13012] [H13013] [H13014] [H13015] [H13016] [H13019] [H13021] 2296dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2297563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 2298563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_prepare( 2299563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3 *db, /* Database handle */ 2300563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const char *zSql, /* SQL statement, UTF-8 encoded */ 2301dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int nByte, /* Maximum length of zSql in bytes. */ 2302563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 2303563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const char **pzTail /* OUT: Pointer to unused portion of zSql */ 2304563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 2305563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_prepare_v2( 2306563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3 *db, /* Database handle */ 2307563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const char *zSql, /* SQL statement, UTF-8 encoded */ 2308dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int nByte, /* Maximum length of zSql in bytes. */ 2309563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 2310563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const char **pzTail /* OUT: Pointer to unused portion of zSql */ 2311563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 2312563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_prepare16( 2313563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3 *db, /* Database handle */ 2314563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const void *zSql, /* SQL statement, UTF-16 encoded */ 2315dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int nByte, /* Maximum length of zSql in bytes. */ 2316563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 2317563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const void **pzTail /* OUT: Pointer to unused portion of zSql */ 2318563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 2319563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_prepare16_v2( 2320563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3 *db, /* Database handle */ 2321563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const void *zSql, /* SQL statement, UTF-16 encoded */ 2322dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int nByte, /* Maximum length of zSql in bytes. */ 2323563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 2324563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const void **pzTail /* OUT: Pointer to unused portion of zSql */ 2325563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 2326563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 2327563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 2328dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Retrieving Statement SQL {H13100} <H13000> 2329563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2330dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This interface can be used to retrieve a saved copy of the original 2331dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQL text used to create a [prepared statement] if that statement was 2332dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** compiled using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()]. 2333dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2334dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 2335dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H13101] [H13102] [H13103] 2336dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 2337dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockconst char *sqlite3_sql(sqlite3_stmt *pStmt); 2338dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 2339dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 2340dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Dynamically Typed Value Object {H15000} <S20200> 2341dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value} 2342dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2343dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite uses the sqlite3_value object to represent all values 2344dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that can be stored in a database table. SQLite uses dynamic typing 2345dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for the values it stores. Values stored in sqlite3_value objects 2346dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** can be integers, floating point values, strings, BLOBs, or NULL. 2347dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2348dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** An sqlite3_value object may be either "protected" or "unprotected". 2349dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Some interfaces require a protected sqlite3_value. Other interfaces 2350dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** will accept either a protected or an unprotected sqlite3_value. 2351dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Every interface that accepts sqlite3_value arguments specifies 2352dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** whether or not it requires a protected sqlite3_value. 2353dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2354dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The terms "protected" and "unprotected" refer to whether or not 2355dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a mutex is held. A internal mutex is held for a protected 2356dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_value object but no mutex is held for an unprotected 2357dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_value object. If SQLite is compiled to be single-threaded 2358dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0) 2359dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or if SQLite is run in one of reduced mutex modes 2360dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD] 2361dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** then there is no distinction between protected and unprotected 2362dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_value objects and they can be used interchangeably. However, 2363dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for maximum code portability it is recommended that applications 2364dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** still make the distinction between between protected and unprotected 2365dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_value objects even when not strictly required. 2366dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2367dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_value objects that are passed as parameters into the 2368dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** implementation of [application-defined SQL functions] are protected. 2369dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_value object returned by 2370dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_column_value()] is unprotected. 2371dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Unprotected sqlite3_value objects may only be used with 2372dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_result_value()] and [sqlite3_bind_value()]. 2373dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The [sqlite3_value_blob | sqlite3_value_type()] family of 2374dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** interfaces require protected sqlite3_value objects. 2375563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 2376563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarktypedef struct Mem sqlite3_value; 2377563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 2378563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 2379dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: SQL Function Context Object {H16001} <S20200> 2380563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2381563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The context in which an SQL function executes is stored in an 2382dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_context object. A pointer to an sqlite3_context object 2383dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is always first parameter to [application-defined SQL functions]. 2384dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The application-defined SQL function implementation will pass this 2385dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** pointer through into calls to [sqlite3_result_int | sqlite3_result()], 2386dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_aggregate_context()], [sqlite3_user_data()], 2387dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()], 2388dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and/or [sqlite3_set_auxdata()]. 2389563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 2390563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarktypedef struct sqlite3_context sqlite3_context; 2391563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 2392563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 2393dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Binding Values To Prepared Statements {H13500} <S70300> 2394dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: {host parameter} {host parameters} {host parameter name} 2395dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding} 2396563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2397563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** In the SQL strings input to [sqlite3_prepare_v2()] and its variants, 2398dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** literals may be replaced by a [parameter] in one of these forms: 2399563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2400563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <ul> 2401563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <li> ? 2402563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <li> ?NNN 2403dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> :VVV 2404dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> @VVV 2405563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <li> $VVV 2406563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** </ul> 2407563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2408563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** In the parameter forms shown above NNN is an integer literal, 2409dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and VVV is an alpha-numeric parameter name. The values of these 2410dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** parameters (also called "host parameter names" or "SQL parameters") 2411563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** can be set using the sqlite3_bind_*() routines defined here. 2412563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2413dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The first argument to the sqlite3_bind_*() routines is always 2414dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a pointer to the [sqlite3_stmt] object returned from 2415dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_prepare_v2()] or its variants. 2416dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2417dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The second argument is the index of the SQL parameter to be set. 2418dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The leftmost SQL parameter has an index of 1. When the same named 2419dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQL parameter is used more than once, second and subsequent 2420dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** occurrences have the same index as the first occurrence. 2421dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The index for named parameters can be looked up using the 2422dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_bind_parameter_index()] API if desired. The index 2423dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for "?NNN" parameters is the value of NNN. 2424dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The NNN value must be between 1 and the [sqlite3_limit()] 2425dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999). 2426563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2427563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The third argument is the value to bind to the parameter. 2428563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2429dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** In those routines that have a fourth argument, its value is the 2430dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** number of bytes in the parameter. To be clear: the value is the 2431dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** number of <u>bytes</u> in the value, not the number of characters. 2432563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** If the fourth parameter is negative, the length of the string is 2433dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the number of bytes up to the first zero terminator. 2434563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2435563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and 2436563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or 2437dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** string after SQLite has finished with it. If the fifth argument is 2438dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the special value [SQLITE_STATIC], then SQLite assumes that the 2439dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** information is in static, unmanaged space and does not need to be freed. 2440dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the fifth argument has the value [SQLITE_TRANSIENT], then 2441dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite makes its own private copy of the data immediately, before 2442dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the sqlite3_bind_*() routine returns. 2443dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2444dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_bind_zeroblob() routine binds a BLOB of length N that 2445dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is filled with zeroes. A zeroblob uses a fixed amount of memory 2446dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** (just an integer to hold its size) while it is being processed. 2447dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Zeroblobs are intended to serve as placeholders for BLOBs whose 2448dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** content is later written using 2449dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_blob_open | incremental BLOB I/O] routines. 2450dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** A negative value for the zeroblob results in a zero-length BLOB. 2451563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2452563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The sqlite3_bind_*() routines must be called after 2453563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** [sqlite3_prepare_v2()] (and its variants) or [sqlite3_reset()] and 2454563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** before [sqlite3_step()]. 2455563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Bindings are not cleared by the [sqlite3_reset()] routine. 2456563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Unbound parameters are interpreted as NULL. 2457563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2458563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** These routines return [SQLITE_OK] on success or an error code if 2459563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** anything goes wrong. [SQLITE_RANGE] is returned if the parameter 2460dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** index is out of range. [SQLITE_NOMEM] is returned if malloc() fails. 2461dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_MISUSE] might be returned if these routines are called on a 2462dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** virtual machine that is the wrong state or which has already been finalized. 2463dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Detection of misuse is unreliable. Applications should not depend 2464dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** on SQLITE_MISUSE returns. SQLITE_MISUSE is intended to indicate a 2465dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a logic error in the application. Future versions of SQLite might 2466dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** panic rather than return SQLITE_MISUSE. 2467dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2468dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** See also: [sqlite3_bind_parameter_count()], 2469dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()]. 2470dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2471dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 2472dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H13506] [H13509] [H13512] [H13515] [H13518] [H13521] [H13524] [H13527] 2473dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H13530] [H13533] [H13536] [H13539] [H13542] [H13545] [H13548] [H13551] 2474dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2475563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 2476563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*)); 2477563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_bind_double(sqlite3_stmt*, int, double); 2478563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_bind_int(sqlite3_stmt*, int, int); 2479dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64); 2480563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_bind_null(sqlite3_stmt*, int); 2481563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*)); 2482563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*)); 2483563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*); 2484563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n); 2485563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 2486563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 2487dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Number Of SQL Parameters {H13600} <S70300> 2488563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2489dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This routine can be used to find the number of [SQL parameters] 2490dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** in a [prepared statement]. SQL parameters are tokens of the 2491dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as 2492dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** placeholders for values that are [sqlite3_bind_blob | bound] 2493dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to the parameters at a later time. 2494dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2495dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This routine actually returns the index of the largest (rightmost) 2496dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** parameter. For all forms except ?NNN, this will correspond to the 2497dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** number of unique parameters. If parameters of the ?NNN are used, 2498dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** there may be gaps in the list. 2499dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2500dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** See also: [sqlite3_bind_blob|sqlite3_bind()], 2501dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_bind_parameter_name()], and 2502dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_bind_parameter_index()]. 2503dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2504dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 2505dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H13601] 2506563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 2507563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_bind_parameter_count(sqlite3_stmt*); 2508563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 2509563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 2510dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Name Of A Host Parameter {H13620} <S70300> 2511dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2512dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This routine returns a pointer to the name of the n-th 2513dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQL parameter] in a [prepared statement]. 2514dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA" 2515dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA" 2516dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** respectively. 2517dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** In other words, the initial ":" or "$" or "@" or "?" 2518563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** is included as part of the name. 2519dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Parameters of the form "?" without a following integer have no name 2520dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and are also referred to as "anonymous parameters". 2521563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2522dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The first host parameter has an index of 1, not 0. 2523563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2524dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the value n is out of range or if the n-th parameter is 2525dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** nameless, then NULL is returned. The returned string is 2526dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** always in UTF-8 encoding even if the named parameter was 2527dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** originally specified as UTF-16 in [sqlite3_prepare16()] or 2528dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_prepare16_v2()]. 2529dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2530dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** See also: [sqlite3_bind_blob|sqlite3_bind()], 2531dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_bind_parameter_count()], and 2532dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_bind_parameter_index()]. 2533dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2534dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 2535dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H13621] 2536563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 2537563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkconst char *sqlite3_bind_parameter_name(sqlite3_stmt*, int); 2538563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 2539563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 2540dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Index Of A Parameter With A Given Name {H13640} <S70300> 2541dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2542dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Return the index of an SQL parameter given its name. The 2543dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** index value returned is suitable for use as the second 2544dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** parameter to [sqlite3_bind_blob|sqlite3_bind()]. A zero 2545dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is returned if no matching parameter is found. The parameter 2546dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** name must be given in UTF-8 even if the original statement 2547dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** was prepared from UTF-16 text using [sqlite3_prepare16_v2()]. 2548563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2549dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** See also: [sqlite3_bind_blob|sqlite3_bind()], 2550dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_bind_parameter_count()], and 2551dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_bind_parameter_index()]. 2552dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2553dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 2554dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H13641] 2555563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 2556563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName); 2557563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 2558563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 2559dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Reset All Bindings On A Prepared Statement {H13660} <S70300> 2560dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2561dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Contrary to the intuition of many, [sqlite3_reset()] does not reset 2562dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the [sqlite3_bind_blob | bindings] on a [prepared statement]. 2563dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Use this routine to reset all host parameters to NULL. 2564563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2565dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 2566dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H13661] 2567563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 2568563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_clear_bindings(sqlite3_stmt*); 2569563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 2570563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 2571dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Number Of Columns In A Result Set {H13710} <S10700> 2572563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2573dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Return the number of columns in the result set returned by the 2574dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [prepared statement]. This routine returns 0 if pStmt is an SQL 2575dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** statement that does not return data (for example an [UPDATE]). 2576dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2577dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 2578dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H13711] 2579563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 2580563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_column_count(sqlite3_stmt *pStmt); 2581563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 2582563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 2583dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Column Names In A Result Set {H13720} <S10700> 2584563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2585563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** These routines return the name assigned to a particular column 2586dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** in the result set of a [SELECT] statement. The sqlite3_column_name() 2587dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** interface returns a pointer to a zero-terminated UTF-8 string 2588dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and sqlite3_column_name16() returns a pointer to a zero-terminated 2589dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** UTF-16 string. The first parameter is the [prepared statement] 2590dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that implements the [SELECT] statement. The second parameter is the 2591dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** column number. The leftmost column is number 0. 2592dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2593dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The returned string pointer is valid until either the [prepared statement] 2594dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is destroyed by [sqlite3_finalize()] or until the next call to 2595dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_column_name() or sqlite3_column_name16() on the same column. 2596dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2597dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If sqlite3_malloc() fails during the processing of either routine 2598dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** (for example during a conversion from UTF-8 to UTF-16) then a 2599dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** NULL pointer is returned. 2600dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2601dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The name of a result column is the value of the "AS" clause for 2602dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that column, if there is an AS clause. If there is no AS clause 2603dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** then the name of the column is unspecified and may change from 2604dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** one release of SQLite to the next. 2605dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2606dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 2607dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H13721] [H13723] [H13724] [H13725] [H13726] [H13727] 2608563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 2609563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkconst char *sqlite3_column_name(sqlite3_stmt*, int N); 2610563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkconst void *sqlite3_column_name16(sqlite3_stmt*, int N); 2611563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 2612563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 2613dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Source Of Data In A Query Result {H13740} <S10700> 2614563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2615563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** These routines provide a means to determine what column of what 2616dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** table in which database a result of a [SELECT] statement comes from. 2617563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The name of the database or table or column can be returned as 2618dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** either a UTF-8 or UTF-16 string. The _database_ routines return 2619dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the database name, the _table_ routines return the table name, and 2620dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the origin_ routines return the column name. 2621dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The returned string is valid until the [prepared statement] is destroyed 2622dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** using [sqlite3_finalize()] or until the same information is requested 2623dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** again in a different encoding. 2624dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2625dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The names returned are the original un-aliased names of the 2626dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** database, table, and column. 2627dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2628dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The first argument to the following calls is a [prepared statement]. 2629dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These functions return information about the Nth column returned by 2630563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the statement, where N is the second function argument. 2631563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2632dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the Nth column returned by the statement is an expression or 2633dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** subquery and is not a column value, then all of these functions return 2634dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** NULL. These routine might also return NULL if a memory allocation error 2635dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** occurs. Otherwise, they return the name of the attached database, table 2636dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and column that query result column was extracted from. 2637dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2638dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** As with all other SQLite APIs, those postfixed with "16" return 2639dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** UTF-16 encoded strings, the other functions return UTF-8. {END} 2640563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2641dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These APIs are only available if the library was compiled with the 2642dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined. 2643563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2644dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {A13751} 2645dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If two or more threads call one or more of these routines against the same 2646dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** prepared statement and column at the same time then the results are 2647dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** undefined. 2648dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2649dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 2650dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H13741] [H13742] [H13743] [H13744] [H13745] [H13746] [H13748] 2651dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2652dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If two or more threads call one or more 2653dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_column_database_name | column metadata interfaces] 2654dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for the same [prepared statement] and result column 2655dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** at the same time then the results are undefined. 2656563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 2657563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkconst char *sqlite3_column_database_name(sqlite3_stmt*,int); 2658563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkconst void *sqlite3_column_database_name16(sqlite3_stmt*,int); 2659563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkconst char *sqlite3_column_table_name(sqlite3_stmt*,int); 2660563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkconst void *sqlite3_column_table_name16(sqlite3_stmt*,int); 2661563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkconst char *sqlite3_column_origin_name(sqlite3_stmt*,int); 2662563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkconst void *sqlite3_column_origin_name16(sqlite3_stmt*,int); 2663563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 2664563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 2665dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Declared Datatype Of A Query Result {H13760} <S10700> 2666563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2667dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The first parameter is a [prepared statement]. 2668dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If this statement is a [SELECT] statement and the Nth column of the 2669dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** returned result set of that [SELECT] is a table column (not an 2670563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** expression or subquery) then the declared type of the table 2671dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** column is returned. If the Nth column of the result set is an 2672563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** expression or subquery, then a NULL pointer is returned. 2673dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The returned string is always UTF-8 encoded. {END} 2674dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2675dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** For example, given the database schema: 2676563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2677563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** CREATE TABLE t1(c1 VARIANT); 2678563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2679dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and the following statement to be compiled: 2680563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2681563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** SELECT c1 + 1, c1 FROM t1; 2682563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2683dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** this routine would return the string "VARIANT" for the second result 2684dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** column (i==1), and a NULL pointer for the first result column (i==0). 2685563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2686563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** SQLite uses dynamic run-time typing. So just because a column 2687563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** is declared to contain a particular type does not mean that the 2688563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** data stored in that column is of the declared type. SQLite is 2689563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** strongly typed, but the typing is dynamic not static. Type 2690563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** is associated with individual values, not with the containers 2691563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** used to hold those values. 2692dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2693dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 2694dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H13761] [H13762] [H13763] 2695563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 2696dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockconst char *sqlite3_column_decltype(sqlite3_stmt*,int); 2697563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkconst void *sqlite3_column_decltype16(sqlite3_stmt*,int); 2698563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 2699dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 2700dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Evaluate An SQL Statement {H13200} <S10000> 2701563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2702dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** After a [prepared statement] has been prepared using either 2703dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy 2704dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function 2705dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** must be called one or more times to evaluate the statement. 2706563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2707dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The details of the behavior of the sqlite3_step() interface depend 2708563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** on whether the statement was prepared using the newer "v2" interface 2709563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy 2710563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the 2711563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** new "v2" interface is recommended for new applications but the legacy 2712563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** interface will continue to be supported. 2713563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2714dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** In the legacy interface, the return value will be either [SQLITE_BUSY], 2715563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE]. 2716dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** With the "v2" interface, any of the other [result codes] or 2717dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [extended result codes] might be returned as well. 2718563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2719563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** [SQLITE_BUSY] means that the database engine was unable to acquire the 2720dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** database locks it needs to do its job. If the statement is a [COMMIT] 2721563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** or occurs outside of an explicit transaction, then you can retry the 2722dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** statement. If the statement is not a [COMMIT] and occurs within a 2723563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** explicit transaction then you should rollback the transaction before 2724563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** continuing. 2725563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2726563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** [SQLITE_DONE] means that the statement has finished executing 2727563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** successfully. sqlite3_step() should not be called again on this virtual 2728563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** machine without first calling [sqlite3_reset()] to reset the virtual 2729563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** machine back to its initial state. 2730563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2731dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the SQL statement being executed returns any data, then [SQLITE_ROW] 2732dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is returned each time a new row of data is ready for processing by the 2733dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** caller. The values may be accessed using the [column access functions]. 2734563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** sqlite3_step() is called again to retrieve the next row of data. 2735dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2736563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** [SQLITE_ERROR] means that a run-time error (such as a constraint 2737563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** violation) has occurred. sqlite3_step() should not be called again on 2738563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the VM. More information may be found by calling [sqlite3_errmsg()]. 2739dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** With the legacy interface, a more specific error code (for example, 2740563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth) 2741563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** can be obtained by calling [sqlite3_reset()] on the 2742dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [prepared statement]. In the "v2" interface, 2743563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the more specific error code is returned directly by sqlite3_step(). 2744563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2745563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** [SQLITE_MISUSE] means that the this routine was called inappropriately. 2746dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Perhaps it was called on a [prepared statement] that has 2747dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** already been [sqlite3_finalize | finalized] or on one that had 2748563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could 2749563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** be the case that the same database connection is being used by two or 2750563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** more threads at the same moment in time. 2751563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2752dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step() 2753dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** API always returns a generic error code, [SQLITE_ERROR], following any 2754dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call 2755dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the 2756dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** specific [error codes] that better describes the error. 2757563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** We admit that this is a goofy design. The problem has been fixed 2758563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** with the "v2" interface. If you prepare all of your SQL statements 2759563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead 2760dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces, 2761dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** then the more specific [error codes] are returned directly 2762563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** by sqlite3_step(). The use of the "v2" interface is recommended. 2763dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2764dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 2765dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H13202] [H15304] [H15306] [H15308] [H15310] 2766563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 2767563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_step(sqlite3_stmt*); 2768563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 2769563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 2770dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Number of columns in a result set {H13770} <S10700> 2771563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2772dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Returns the number of values in the current row of the result set. 2773563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2774dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 2775dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H13771] [H13772] 2776563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 2777563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_data_count(sqlite3_stmt *pStmt); 2778563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 2779563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 2780dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Fundamental Datatypes {H10265} <S10110><S10120> 2781dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: SQLITE_TEXT 2782563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2783dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H10266} Every value in SQLite has one of five fundamental datatypes: 2784563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2785563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <ul> 2786563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <li> 64-bit signed integer 2787563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <li> 64-bit IEEE floating point number 2788563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <li> string 2789563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <li> BLOB 2790563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <li> NULL 2791dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </ul> {END} 2792563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2793563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** These constants are codes for each of those types. 2794563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2795563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Note that the SQLITE_TEXT constant was also used in SQLite version 2 2796563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** for a completely different meaning. Software that links against both 2797dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not 2798563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** SQLITE_TEXT. 2799563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 2800563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_INTEGER 1 2801563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_FLOAT 2 2802563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_BLOB 4 2803563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_NULL 5 2804563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#ifdef SQLITE_TEXT 2805563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark# undef SQLITE_TEXT 2806563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#else 2807563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark# define SQLITE_TEXT 3 2808563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#endif 2809563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE3_TEXT 3 2810563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 2811563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 2812dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Result Values From A Query {H13800} <S10700> 2813dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: {column access functions} 2814dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2815dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These routines form the "result set query" interface. 2816dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2817dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These routines return information about a single column of the current 2818dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** result row of a query. In every case the first argument is a pointer 2819dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*] 2820dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that was returned from [sqlite3_prepare_v2()] or one of its variants) 2821dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and the second argument is the index of the column for which information 2822dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** should be returned. The leftmost column of the result set has the index 0. 2823dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2824dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the SQL statement does not currently point to a valid row, or if the 2825dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** column index is out of range, the result is undefined. 2826dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These routines may only be called when the most recent call to 2827dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_step()] has returned [SQLITE_ROW] and neither 2828dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently. 2829dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If any of these routines are called after [sqlite3_reset()] or 2830dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_finalize()] or after [sqlite3_step()] has returned 2831dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** something other than [SQLITE_ROW], the results are undefined. 2832dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()] 2833dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** are called from a different thread while any of these routines 2834dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** are pending, then the results are undefined. 2835dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2836dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_column_type() routine returns the 2837563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** [SQLITE_INTEGER | datatype code] for the initial data type 2838563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** of the result column. The returned value is one of [SQLITE_INTEGER], 2839563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value 2840563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** returned by sqlite3_column_type() is only meaningful if no type 2841563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** conversions have occurred as described below. After a type conversion, 2842563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the value returned by sqlite3_column_type() is undefined. Future 2843563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** versions of SQLite may change the behavior of sqlite3_column_type() 2844563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** following a type conversion. 2845563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2846dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes() 2847563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** routine returns the number of bytes in that BLOB or string. 2848563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** If the result is a UTF-16 string, then sqlite3_column_bytes() converts 2849563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the string to UTF-8 and then returns the number of bytes. 2850563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** If the result is a numeric value then sqlite3_column_bytes() uses 2851563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns 2852563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the number of bytes in that string. 2853563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The value returned does not include the zero terminator at the end 2854563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** of the string. For clarity: the value returned is the number of 2855563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** bytes in the string, not the number of characters. 2856563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2857dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Strings returned by sqlite3_column_text() and sqlite3_column_text16(), 2858dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** even empty strings, are always zero terminated. The return 2859dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** value from sqlite3_column_blob() for a zero-length BLOB is an arbitrary 2860dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** pointer, possibly even a NULL pointer. 2861dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2862563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The sqlite3_column_bytes16() routine is similar to sqlite3_column_bytes() 2863dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** but leaves the result in UTF-16 in native byte order instead of UTF-8. 2864563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The zero terminator is not included in this count. 2865563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2866dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The object returned by [sqlite3_column_value()] is an 2867dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [unprotected sqlite3_value] object. An unprotected sqlite3_value object 2868dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()]. 2869dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the [unprotected sqlite3_value] object returned by 2870dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_column_value()] is used in any other way, including calls 2871dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to routines like [sqlite3_value_int()], [sqlite3_value_text()], 2872dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or [sqlite3_value_bytes()], then the behavior is undefined. 2873dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2874563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** These routines attempt to convert the value where appropriate. For 2875563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** example, if the internal representation is FLOAT and a text result 2876dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is requested, [sqlite3_snprintf()] is used internally to perform the 2877dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** conversion automatically. The following table details the conversions 2878dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that are applied: 2879563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2880563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <blockquote> 2881563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <table border="1"> 2882dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion 2883563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2884563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <tr><td> NULL <td> INTEGER <td> Result is 0 2885563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <tr><td> NULL <td> FLOAT <td> Result is 0.0 2886563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <tr><td> NULL <td> TEXT <td> Result is NULL pointer 2887563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <tr><td> NULL <td> BLOB <td> Result is NULL pointer 2888563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float 2889563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer 2890dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT 2891563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <tr><td> FLOAT <td> INTEGER <td> Convert from float to integer 2892563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float 2893563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <tr><td> FLOAT <td> BLOB <td> Same as FLOAT->TEXT 2894563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <tr><td> TEXT <td> INTEGER <td> Use atoi() 2895563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <tr><td> TEXT <td> FLOAT <td> Use atof() 2896563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <tr><td> TEXT <td> BLOB <td> No change 2897563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <tr><td> BLOB <td> INTEGER <td> Convert to TEXT then use atoi() 2898563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <tr><td> BLOB <td> FLOAT <td> Convert to TEXT then use atof() 2899563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed 2900563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** </table> 2901563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** </blockquote> 2902563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2903563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The table above makes reference to standard C library functions atoi() 2904563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** and atof(). SQLite does not really use these functions. It has its 2905dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** own equivalent internal routines. The atoi() and atof() names are 2906563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** used in the table for brevity and because they are familiar to most 2907563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** C programmers. 2908563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2909563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Note that when type conversions occur, pointers returned by prior 2910563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or 2911dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_column_text16() may be invalidated. 2912563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Type conversions and pointer invalidations might occur 2913563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** in the following cases: 2914563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2915563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <ul> 2916dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> The initial content is a BLOB and sqlite3_column_text() or 2917dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_column_text16() is called. A zero-terminator might 2918dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** need to be added to the string.</li> 2919dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or 2920dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_column_text16() is called. The content must be converted 2921dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to UTF-16.</li> 2922dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or 2923dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_column_text() is called. The content must be converted 2924dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to UTF-8.</li> 2925563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** </ul> 2926563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2927563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Conversions between UTF-16be and UTF-16le are always done in place and do 2928563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** not invalidate a prior pointer, though of course the content of the buffer 2929563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** that the prior pointer points to will have been modified. Other kinds 2930dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of conversion are done in place when it is possible, but sometimes they 2931dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** are not possible and in those cases prior pointers are invalidated. 2932563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2933563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The safest and easiest to remember policy is to invoke these routines 2934563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** in one of the following ways: 2935563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2936dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <ul> 2937563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li> 2938563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li> 2939563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li> 2940dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </ul> 2941563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2942dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** In other words, you should call sqlite3_column_text(), 2943dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result 2944dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** into the desired format, then invoke sqlite3_column_bytes() or 2945dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_column_bytes16() to find the size of the result. Do not mix calls 2946dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to sqlite3_column_text() or sqlite3_column_blob() with calls to 2947dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16() 2948dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** with calls to sqlite3_column_bytes(). 2949dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2950dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The pointers returned are valid until a type conversion occurs as 2951dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** described above, or until [sqlite3_step()] or [sqlite3_reset()] or 2952dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_finalize()] is called. The memory space used to hold strings 2953dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and BLOBs is freed automatically. Do <b>not</b> pass the pointers returned 2954dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into 2955dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_free()]. 2956dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2957dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If a memory allocation error occurs during the evaluation of any 2958dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of these routines, a default value is returned. The default value 2959dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is either the integer 0, the floating point number 0.0, or a NULL 2960dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** pointer. Subsequent calls to [sqlite3_errcode()] will return 2961dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_NOMEM]. 2962dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2963dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 2964dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H13803] [H13806] [H13809] [H13812] [H13815] [H13818] [H13821] [H13824] 2965dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H13827] [H13830] 2966563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 2967563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkconst void *sqlite3_column_blob(sqlite3_stmt*, int iCol); 2968563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_column_bytes(sqlite3_stmt*, int iCol); 2969563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_column_bytes16(sqlite3_stmt*, int iCol); 2970563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkdouble sqlite3_column_double(sqlite3_stmt*, int iCol); 2971563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_column_int(sqlite3_stmt*, int iCol); 2972dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocksqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol); 2973563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkconst unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol); 2974563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkconst void *sqlite3_column_text16(sqlite3_stmt*, int iCol); 2975563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_column_type(sqlite3_stmt*, int iCol); 2976563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarksqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol); 2977563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 2978563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 2979dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Destroy A Prepared Statement Object {H13300} <S70300><S30100> 2980563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2981dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_finalize() function is called to delete a [prepared statement]. 2982dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the statement was executed successfully or not executed at all, then 2983dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLITE_OK is returned. If execution of the statement failed then an 2984dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [error code] or [extended error code] is returned. 2985563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 2986563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** This routine can be called at any point during the execution of the 2987dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [prepared statement]. If the virtual machine has not 2988563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** completed execution when this routine is called, that is like 2989dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** encountering an error or an [sqlite3_interrupt | interrupt]. 2990dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Incomplete updates may be rolled back and transactions canceled, 2991dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** depending on the circumstances, and the 2992dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [error code] returned will be [SQLITE_ABORT]. 2993dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2994dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 2995dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H11302] [H11304] 2996563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 2997563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_finalize(sqlite3_stmt *pStmt); 2998563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 2999563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3000dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Reset A Prepared Statement Object {H13330} <S70300> 3001563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3002dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_reset() function is called to reset a [prepared statement] 3003dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** object back to its initial state, ready to be re-executed. 3004563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Any SQL statement variables that had values bound to them using 3005563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values. 3006563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Use [sqlite3_clear_bindings()] to reset the bindings. 3007dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3008dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H11332} The [sqlite3_reset(S)] interface resets the [prepared statement] S 3009dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** back to the beginning of its program. 3010dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3011dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H11334} If the most recent call to [sqlite3_step(S)] for the 3012dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE], 3013dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or if [sqlite3_step(S)] has never before been called on S, 3014dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** then [sqlite3_reset(S)] returns [SQLITE_OK]. 3015dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3016dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H11336} If the most recent call to [sqlite3_step(S)] for the 3017dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [prepared statement] S indicated an error, then 3018dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_reset(S)] returns an appropriate [error code]. 3019dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3020dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H11338} The [sqlite3_reset(S)] interface does not change the values 3021dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S. 3022563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3023563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_reset(sqlite3_stmt *pStmt); 3024563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3025563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3026dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Create Or Redefine SQL Functions {H16100} <S20200> 3027dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: {function creation routines} 3028dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: {application-defined SQL function} 3029dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: {application-defined SQL functions} 3030dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3031dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These two functions (collectively known as "function creation routines") 3032dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** are used to add SQL functions or aggregates or to redefine the behavior 3033dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of existing SQL functions or aggregates. The only difference between the 3034dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** two is that the second parameter, the name of the (scalar) function or 3035dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** aggregate, is encoded in UTF-8 for sqlite3_create_function() and UTF-16 3036dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for sqlite3_create_function16(). 3037dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3038dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The first parameter is the [database connection] to which the SQL 3039dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** function is to be added. If a single program uses more than one database 3040dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** connection internally, then SQL functions must be added individually to 3041dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** each database connection. 3042dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3043dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The second parameter is the name of the SQL function to be created or 3044dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** redefined. The length of the name is limited to 255 bytes, exclusive of 3045dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the zero-terminator. Note that the name length limit is in bytes, not 3046563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** characters. Any attempt to create a function with a longer name 3047dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** will result in [SQLITE_ERROR] being returned. 3048563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3049dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The third parameter (nArg) 3050dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is the number of arguments that the SQL function or 3051563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** aggregate takes. If this parameter is negative, then the SQL function or 3052563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** aggregate may take any number of arguments. 3053563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3054dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The fourth parameter, eTextRep, specifies what 3055563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** [SQLITE_UTF8 | text encoding] this SQL function prefers for 3056563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** its parameters. Any SQL function implementation should be able to work 3057563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** work with UTF-8, UTF-16le, or UTF-16be. But some implementations may be 3058563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** more efficient with one encoding than another. It is allowed to 3059dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** invoke sqlite3_create_function() or sqlite3_create_function16() multiple 3060563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** times with the same function but with different values of eTextRep. 3061563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** When multiple implementations of the same function are available, SQLite 3062563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** will pick the one that involves the least amount of data conversion. 3063dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If there is only a single implementation which does not care what text 3064dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** encoding is used, then the fourth argument should be [SQLITE_ANY]. 3065563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3066dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The fifth parameter is an arbitrary pointer. The implementation of the 3067dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** function can gain access to this pointer using [sqlite3_user_data()]. 3068563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3069563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The seventh, eighth and ninth parameters, xFunc, xStep and xFinal, are 3070dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** pointers to C-language functions that implement the SQL function or 3071dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** aggregate. A scalar SQL function requires an implementation of the xFunc 3072dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** callback only, NULL pointers should be passed as the xStep and xFinal 3073dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** parameters. An aggregate SQL function requires an implementation of xStep 3074dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and xFinal and NULL should be passed for xFunc. To delete an existing 3075dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQL function or aggregate, pass NULL for all three function callbacks. 3076563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3077563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** It is permitted to register multiple implementations of the same 3078563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** functions with the same name but with either differing numbers of 3079dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** arguments or differing preferred text encodings. SQLite will use 3080563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the implementation most closely matches the way in which the 3081dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQL function is used. A function implementation with a non-negative 3082dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** nArg parameter is a better match than a function implementation with 3083dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a negative nArg. A function where the preferred text encoding 3084dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** matches the database encoding is a better 3085dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** match than a function where the encoding is different. 3086dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** A function where the encoding difference is between UTF16le and UTF16be 3087dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is a closer match than a function where the encoding difference is 3088dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** between UTF8 and UTF16. 3089dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3090dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Built-in functions may be overloaded by new application-defined functions. 3091dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The first application-defined function with a given name overrides all 3092dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** built-in functions in the same [database connection] with the same name. 3093dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Subsequent application-defined functions of the same name only override 3094dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** prior application-defined functions that are an exact match for the 3095dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** number of parameters and preferred encoding. 3096dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3097dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** An application-defined function is permitted to call other 3098dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite interfaces. However, such calls must not 3099dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** close the database connection nor finalize or reset the prepared 3100dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** statement in which the function is running. 3101dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3102dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 3103dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H16103] [H16106] [H16109] [H16112] [H16118] [H16121] [H16124] [H16127] 3104dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H16130] [H16133] [H16136] [H16139] [H16142] 3105563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3106563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_create_function( 3107dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block sqlite3 *db, 3108563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const char *zFunctionName, 3109563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int nArg, 3110563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int eTextRep, 3111dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void *pApp, 3112563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark void (*xFunc)(sqlite3_context*,int,sqlite3_value**), 3113563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark void (*xStep)(sqlite3_context*,int,sqlite3_value**), 3114563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark void (*xFinal)(sqlite3_context*) 3115563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 3116563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_create_function16( 3117dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block sqlite3 *db, 3118563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const void *zFunctionName, 3119563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int nArg, 3120563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int eTextRep, 3121dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void *pApp, 3122563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark void (*xFunc)(sqlite3_context*,int,sqlite3_value**), 3123563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark void (*xStep)(sqlite3_context*,int,sqlite3_value**), 3124563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark void (*xFinal)(sqlite3_context*) 3125563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 3126563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3127563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3128dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Text Encodings {H10267} <S50200> <H16100> 3129563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3130563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** These constant define integer codes that represent the various 3131563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** text encodings supported by SQLite. 3132563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3133563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_UTF8 1 3134563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_UTF16LE 2 3135563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_UTF16BE 3 3136563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_UTF16 4 /* Use native byte order */ 3137563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_ANY 5 /* sqlite3_create_function only */ 3138563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */ 3139563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3140563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3141dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Deprecated Functions 3142dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** DEPRECATED 3143563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3144dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These functions are [deprecated]. In order to maintain 3145dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** backwards compatibility with older code, these functions continue 3146dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to be supported. However, new applications should avoid 3147563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the use of these functions. To help encourage people to avoid 3148dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** using these functions, we are not going to tell you what they do. 3149563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3150dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#ifndef SQLITE_OMIT_DEPRECATED 3151dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve BlockSQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*); 3152dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve BlockSQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*); 3153dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve BlockSQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*); 3154dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve BlockSQLITE_DEPRECATED int sqlite3_global_recover(void); 3155dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve BlockSQLITE_DEPRECATED void sqlite3_thread_cleanup(void); 3156dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve BlockSQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),void*,sqlite3_int64); 3157dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#endif 3158563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3159563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3160dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Obtaining SQL Function Parameter Values {H15100} <S20200> 3161563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3162563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The C-language implementation of SQL functions and aggregates uses 3163563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** this set of interface routines to access the parameter values on 3164563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the function or aggregate. 3165563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3166563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The xFunc (for scalar functions) or xStep (for aggregates) parameters 3167563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** to [sqlite3_create_function()] and [sqlite3_create_function16()] 3168563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** define callbacks that implement the SQL functions and aggregates. 3169563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The 4th parameter to these callbacks is an array of pointers to 3170dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [protected sqlite3_value] objects. There is one [sqlite3_value] object for 3171563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** each parameter to the SQL function. These routines are used to 3172563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** extract values from the [sqlite3_value] objects. 3173563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3174dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These routines work only with [protected sqlite3_value] objects. 3175dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Any attempt to use these routines on an [unprotected sqlite3_value] 3176dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** object results in undefined behavior. 3177dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3178dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These routines work just like the corresponding [column access functions] 3179dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** except that these routines take a single [protected sqlite3_value] object 3180dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** pointer instead of a [sqlite3_stmt*] pointer and an integer column number. 3181563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3182dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_value_text16() interface extracts a UTF-16 string 3183563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** in the native byte-order of the host machine. The 3184563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces 3185dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** extract UTF-16 strings as big-endian and little-endian respectively. 3186563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3187563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The sqlite3_value_numeric_type() interface attempts to apply 3188563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** numeric affinity to the value. This means that an attempt is 3189563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** made to convert the value to an integer or floating point. If 3190dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** such a conversion is possible without loss of information (in other 3191dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** words, if the value is a string that looks like a number) 3192dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** then the conversion is performed. Otherwise no conversion occurs. 3193dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The [SQLITE_INTEGER | datatype] after conversion is returned. 3194563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3195dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Please pay particular attention to the fact that the pointer returned 3196dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** from [sqlite3_value_blob()], [sqlite3_value_text()], or 3197563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** [sqlite3_value_text16()] can be invalidated by a subsequent call to 3198dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()], 3199dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or [sqlite3_value_text16()]. 3200dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3201dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These routines must be called from the same thread as 3202dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the SQL function that supplied the [sqlite3_value*] parameters. 3203dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3204dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 3205dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H15103] [H15106] [H15109] [H15112] [H15115] [H15118] [H15121] [H15124] 3206dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H15127] [H15130] [H15133] [H15136] 3207563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3208563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkconst void *sqlite3_value_blob(sqlite3_value*); 3209563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_value_bytes(sqlite3_value*); 3210563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_value_bytes16(sqlite3_value*); 3211563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkdouble sqlite3_value_double(sqlite3_value*); 3212563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_value_int(sqlite3_value*); 3213dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocksqlite3_int64 sqlite3_value_int64(sqlite3_value*); 3214563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkconst unsigned char *sqlite3_value_text(sqlite3_value*); 3215563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkconst void *sqlite3_value_text16(sqlite3_value*); 3216563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkconst void *sqlite3_value_text16le(sqlite3_value*); 3217563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkconst void *sqlite3_value_text16be(sqlite3_value*); 3218563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_value_type(sqlite3_value*); 3219563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_value_numeric_type(sqlite3_value*); 3220563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3221563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3222dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Obtain Aggregate Function Context {H16210} <S20200> 3223563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3224563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The implementation of aggregate SQL functions use this routine to allocate 3225dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a structure for storing their state. 3226563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3227dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The first time the sqlite3_aggregate_context() routine is called for a 3228dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** particular aggregate, SQLite allocates nBytes of memory, zeroes out that 3229dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** memory, and returns a pointer to it. On second and subsequent calls to 3230dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_aggregate_context() for the same aggregate function index, 3231dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the same buffer is returned. The implementation of the aggregate can use 3232dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the returned buffer to accumulate data. 3233dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3234dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite automatically frees the allocated buffer when the aggregate 3235563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** query concludes. 3236563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3237dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The first parameter should be a copy of the 3238dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_context | SQL function context] that is the first parameter 3239dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to the callback routine that implements the aggregate function. 3240dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3241dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This routine must be called from the same thread in which 3242dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the aggregate SQL function is running. 3243dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3244dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 3245dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H16211] [H16213] [H16215] [H16217] 3246563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3247563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid *sqlite3_aggregate_context(sqlite3_context*, int nBytes); 3248563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3249563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3250dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: User Data For Functions {H16240} <S20200> 3251dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3252dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_user_data() interface returns a copy of 3253dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the pointer that was the pUserData parameter (the 5th parameter) 3254dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of the [sqlite3_create_function()] 3255dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and [sqlite3_create_function16()] routines that originally 3256dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** registered the application defined function. {END} 3257dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3258dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This routine must be called from the same thread in which 3259dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the application-defined function is running. 3260563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3261dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 3262dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H16243] 3263563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3264563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid *sqlite3_user_data(sqlite3_context*); 3265563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3266563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3267dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Database Connection For Functions {H16250} <S60600><S20200> 3268dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3269dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_context_db_handle() interface returns a copy of 3270dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the pointer to the [database connection] (the 1st parameter) 3271dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of the [sqlite3_create_function()] 3272dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and [sqlite3_create_function16()] routines that originally 3273dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** registered the application defined function. 3274dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3275dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 3276dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H16253] 3277dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 3278dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocksqlite3 *sqlite3_context_db_handle(sqlite3_context*); 3279dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 3280dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 3281dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Function Auxiliary Data {H16270} <S20200> 3282563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3283563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The following two functions may be used by scalar SQL functions to 3284dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** associate metadata with argument values. If the same value is passed to 3285563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** multiple invocations of the same SQL function during query execution, under 3286dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** some circumstances the associated metadata may be preserved. This may 3287563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** be used, for example, to add a regular-expression matching scalar 3288563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** function. The compiled version of the regular expression is stored as 3289dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** metadata associated with the SQL value passed as the regular expression 3290563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** pattern. The compiled regular expression can be reused on multiple 3291563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** invocations of the same function so that the original pattern string 3292563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** does not need to be recompiled on each invocation. 3293563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3294dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_get_auxdata() interface returns a pointer to the metadata 3295dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** associated by the sqlite3_set_auxdata() function with the Nth argument 3296dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** value to the application-defined function. If no metadata has been ever 3297dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** been set for the Nth argument of the function, or if the corresponding 3298dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** function parameter has changed since the meta-data was set, 3299dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** then sqlite3_get_auxdata() returns a NULL pointer. 3300dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3301dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_set_auxdata() interface saves the metadata 3302dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** pointed to by its 3rd parameter as the metadata for the N-th 3303dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** argument of the application-defined function. Subsequent 3304dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** calls to sqlite3_get_auxdata() might return this data, if it has 3305dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** not been destroyed. 3306dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If it is not NULL, SQLite will invoke the destructor 3307dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** function given by the 4th parameter to sqlite3_set_auxdata() on 3308dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the metadata when the corresponding function parameter changes 3309dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or when the SQL statement completes, whichever comes first. 3310dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3311dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite is free to call the destructor and drop metadata on any 3312dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** parameter of any function at any time. The only guarantee is that 3313dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the destructor will be called before the metadata is dropped. 3314dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3315dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** In practice, metadata is preserved between function calls for 3316563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** expressions that are constant at compile time. This includes literal 3317563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** values and SQL variables. 3318dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3319dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These routines must be called from the same thread in which 3320dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the SQL function is running. 3321dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3322dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 3323dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H16272] [H16274] [H16276] [H16277] [H16278] [H16279] 3324563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3325dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockvoid *sqlite3_get_auxdata(sqlite3_context*, int N); 3326dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockvoid sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*)); 3327563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3328563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3329563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3330dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Constants Defining Special Destructor Behavior {H10280} <S30100> 3331563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3332dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These are special values for the destructor that is passed in as the 3333563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** final argument to routines like [sqlite3_result_blob()]. If the destructor 3334563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** argument is SQLITE_STATIC, it means that the content pointer is constant 3335dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and will never change. It does not need to be destroyed. The 3336563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** SQLITE_TRANSIENT value means that the content will likely change in 3337563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the near future and that SQLite should make its own private copy of 3338563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the content before returning. 3339563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3340563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The typedef is necessary to work around problems in certain 3341563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** C++ compilers. See ticket #2191. 3342563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3343563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarktypedef void (*sqlite3_destructor_type)(void*); 3344563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_STATIC ((sqlite3_destructor_type)0) 3345563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1) 3346563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3347563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3348dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Setting The Result Of An SQL Function {H16400} <S20200> 3349563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3350563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** These routines are used by the xFunc or xFinal callbacks that 3351563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** implement SQL functions and aggregates. See 3352563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** [sqlite3_create_function()] and [sqlite3_create_function16()] 3353563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** for additional information. 3354563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3355dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These functions work very much like the [parameter binding] family of 3356dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** functions used to bind values to host parameters in prepared statements. 3357dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Refer to the [SQL parameter] documentation for additional information. 3358563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3359dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_result_blob() interface sets the result from 3360dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** an application-defined function to be the BLOB whose content is pointed 3361dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to by the second parameter and which is N bytes long where N is the 3362dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** third parameter. 3363dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3364dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_result_zeroblob() interfaces set the result of 3365dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the application-defined function to be a BLOB containing all zero 3366dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** bytes and N bytes in size, where N is the value of the 2nd parameter. 3367dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3368dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_result_double() interface sets the result from 3369dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** an application-defined function to be a floating point value specified 3370dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** by its 2nd argument. 3371563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3372dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_result_error() and sqlite3_result_error16() functions 3373dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** cause the implemented SQL function to throw an exception. 3374dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite uses the string pointed to by the 3375dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16() 3376dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** as the text of an error message. SQLite interprets the error 3377dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** message string from sqlite3_result_error() as UTF-8. SQLite 3378dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** interprets the string from sqlite3_result_error16() as UTF-16 in native 3379dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** byte order. If the third parameter to sqlite3_result_error() 3380dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or sqlite3_result_error16() is negative then SQLite takes as the error 3381dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** message all text up through the first zero character. 3382dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the third parameter to sqlite3_result_error() or 3383dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_result_error16() is non-negative then SQLite takes that many 3384dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** bytes (not characters) from the 2nd parameter as the error message. 3385dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_result_error() and sqlite3_result_error16() 3386dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** routines make a private copy of the error message text before 3387dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** they return. Hence, the calling function can deallocate or 3388dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** modify the text after they return without harm. 3389dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_result_error_code() function changes the error code 3390dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** returned by SQLite as a result of an error in a function. By default, 3391dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the error code is SQLITE_ERROR. A subsequent call to sqlite3_result_error() 3392dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or sqlite3_result_error16() resets the error code to SQLITE_ERROR. 3393dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3394dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_result_toobig() interface causes SQLite to throw an error 3395dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** indicating that a string or BLOB is to long to represent. 3396dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3397dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_result_nomem() interface causes SQLite to throw an error 3398dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** indicating that a memory allocation failed. 3399dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3400dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_result_int() interface sets the return value 3401dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of the application-defined function to be the 32-bit signed integer 3402dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** value given in the 2nd argument. 3403dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_result_int64() interface sets the return value 3404dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of the application-defined function to be the 64-bit signed integer 3405dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** value given in the 2nd argument. 3406dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3407dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_result_null() interface sets the return value 3408dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of the application-defined function to be NULL. 3409dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3410dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_result_text(), sqlite3_result_text16(), 3411dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces 3412dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** set the return value of the application-defined function to be 3413dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a text string which is represented as UTF-8, UTF-16 native byte order, 3414dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** UTF-16 little endian, or UTF-16 big endian, respectively. 3415dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite takes the text result from the application from 3416dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the 2nd parameter of the sqlite3_result_text* interfaces. 3417dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the 3rd parameter to the sqlite3_result_text* interfaces 3418dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is negative, then SQLite takes result text from the 2nd parameter 3419dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** through the first zero character. 3420dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the 3rd parameter to the sqlite3_result_text* interfaces 3421dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is non-negative, then as many bytes (not characters) of the text 3422dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** pointed to by the 2nd parameter are taken as the application-defined 3423dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** function result. 3424dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the 4th parameter to the sqlite3_result_text* interfaces 3425dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that 3426dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** function as the destructor on the text or BLOB result when it has 3427dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** finished using that result. 3428dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the 4th parameter to the sqlite3_result_text* interfaces or 3429dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite 3430dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** assumes that the text or BLOB result is in constant space and does not 3431dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** copy the it or call a destructor when it has finished using that result. 3432dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the 4th parameter to the sqlite3_result_text* interfaces 3433dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT 3434dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** then SQLite makes a copy of the result into space obtained from 3435dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** from [sqlite3_malloc()] before it returns. 3436dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3437dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_result_value() interface sets the result of 3438dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the application-defined function to be a copy the 3439dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [unprotected sqlite3_value] object specified by the 2nd parameter. The 3440dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_result_value() interface makes a copy of the [sqlite3_value] 3441dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** so that the [sqlite3_value] specified in the parameter may change or 3442dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** be deallocated after sqlite3_result_value() returns without harm. 3443dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** A [protected sqlite3_value] object may always be used where an 3444dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [unprotected sqlite3_value] object is required, so either 3445dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** kind of [sqlite3_value] object can be used with this interface. 3446dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3447dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If these routines are called from within the different thread 3448dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** than the one containing the application-defined function that received 3449dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the [sqlite3_context] pointer, the results are undefined. 3450dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3451dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 3452dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H16403] [H16406] [H16409] [H16412] [H16415] [H16418] [H16421] [H16424] 3453dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H16427] [H16430] [H16433] [H16436] [H16439] [H16442] [H16445] [H16448] 3454dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H16451] [H16454] [H16457] [H16460] [H16463] 3455563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3456563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*)); 3457563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid sqlite3_result_double(sqlite3_context*, double); 3458563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid sqlite3_result_error(sqlite3_context*, const char*, int); 3459563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid sqlite3_result_error16(sqlite3_context*, const void*, int); 3460563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid sqlite3_result_error_toobig(sqlite3_context*); 3461dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockvoid sqlite3_result_error_nomem(sqlite3_context*); 3462dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockvoid sqlite3_result_error_code(sqlite3_context*, int); 3463563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid sqlite3_result_int(sqlite3_context*, int); 3464dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockvoid sqlite3_result_int64(sqlite3_context*, sqlite3_int64); 3465563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid sqlite3_result_null(sqlite3_context*); 3466563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*)); 3467563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*)); 3468563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*)); 3469563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*)); 3470563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid sqlite3_result_value(sqlite3_context*, sqlite3_value*); 3471563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid sqlite3_result_zeroblob(sqlite3_context*, int n); 3472563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3473563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3474dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Define New Collating Sequences {H16600} <S20300> 3475563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3476563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** These functions are used to add new collation sequences to the 3477dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [database connection] specified as the first argument. 3478563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3479563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The name of the new collation sequence is specified as a UTF-8 string 3480563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** for sqlite3_create_collation() and sqlite3_create_collation_v2() 3481dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and a UTF-16 string for sqlite3_create_collation16(). In all cases 3482563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the name is passed as the second function argument. 3483563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3484dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The third argument may be one of the constants [SQLITE_UTF8], 3485563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** [SQLITE_UTF16LE] or [SQLITE_UTF16BE], indicating that the user-supplied 3486563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** routine expects to be passed pointers to strings encoded using UTF-8, 3487dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** UTF-16 little-endian, or UTF-16 big-endian, respectively. The 3488dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** third argument might also be [SQLITE_UTF16_ALIGNED] to indicate that 3489dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the routine expects pointers to 16-bit word aligned strings 3490dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of UTF-16 in the native byte order of the host computer. 3491563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3492563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** A pointer to the user supplied routine must be passed as the fifth 3493dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** argument. If it is NULL, this is the same as deleting the collation 3494dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sequence (so that SQLite cannot call it anymore). 3495dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Each time the application supplied function is invoked, it is passed 3496dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** as its first parameter a copy of the void* passed as the fourth argument 3497dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to sqlite3_create_collation() or sqlite3_create_collation16(). 3498dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3499dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The remaining arguments to the application-supplied routine are two strings, 3500dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** each represented by a (length, data) pair and encoded in the encoding 3501563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** that was passed as the third argument when the collation sequence was 3502dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** registered. {END} The application defined collation routine should 3503dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** return negative, zero or positive if the first string is less than, 3504dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** equal to, or greater than the second string. i.e. (STRING1 - STRING2). 3505563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3506563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The sqlite3_create_collation_v2() works like sqlite3_create_collation() 3507dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** except that it takes an extra argument which is a destructor for 3508563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the collation. The destructor is called when the collation is 3509563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** destroyed and is passed a copy of the fourth parameter void* pointer 3510dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of the sqlite3_create_collation_v2(). 3511dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Collations are destroyed when they are overridden by later calls to the 3512dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** collation creation functions or when the [database connection] is closed 3513dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** using [sqlite3_close()]. 3514dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3515dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 3516dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H16603] [H16604] [H16606] [H16609] [H16612] [H16615] [H16618] [H16621] 3517dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H16624] [H16627] [H16630] 3518563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3519563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_create_collation( 3520563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3*, 3521563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const char *zName, 3522563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int eTextRep, 3523563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark void*, 3524563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int(*xCompare)(void*,int,const void*,int,const void*) 3525563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 3526563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_create_collation_v2( 3527563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3*, 3528563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const char *zName, 3529563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int eTextRep, 3530563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark void*, 3531563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int(*xCompare)(void*,int,const void*,int,const void*), 3532563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark void(*xDestroy)(void*) 3533563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 3534563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_create_collation16( 3535563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3*, 3536dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block const void *zName, 3537563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int eTextRep, 3538563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark void*, 3539563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int(*xCompare)(void*,int,const void*,int,const void*) 3540563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 3541563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3542563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3543dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Collation Needed Callbacks {H16700} <S20300> 3544563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3545563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** To avoid having to register all collation sequences before a database 3546563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** can be used, a single callback function may be registered with the 3547dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [database connection] to be called whenever an undefined collation 3548dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sequence is required. 3549563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3550563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** If the function is registered using the sqlite3_collation_needed() API, 3551563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** then it is passed the names of undefined collation sequences as strings 3552dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** encoded in UTF-8. {H16703} If sqlite3_collation_needed16() is used, 3553dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the names are passed as UTF-16 in machine native byte order. 3554dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** A call to either function replaces any existing callback. 3555563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3556563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** When the callback is invoked, the first argument passed is a copy 3557563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** of the second argument to sqlite3_collation_needed() or 3558dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_collation_needed16(). The second argument is the database 3559dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE], 3560dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or [SQLITE_UTF16LE], indicating the most desirable form of the collation 3561dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sequence function required. The fourth parameter is the name of the 3562563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** required collation sequence. 3563563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3564563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The callback function should register the desired collation using 3565563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** [sqlite3_create_collation()], [sqlite3_create_collation16()], or 3566563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** [sqlite3_create_collation_v2()]. 3567dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3568dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 3569dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H16702] [H16704] [H16706] 3570563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3571563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_collation_needed( 3572563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3*, 3573563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark void*, 3574563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark void(*)(void*,sqlite3*,int eTextRep,const char*) 3575563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 3576563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_collation_needed16( 3577563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3*, 3578563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark void*, 3579563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark void(*)(void*,sqlite3*,int eTextRep,const void*) 3580563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 3581563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3582563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3583563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Specify the key for an encrypted database. This routine should be 3584563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** called right after sqlite3_open(). 3585563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3586563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The code to implement this API is not available in the public release 3587563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** of SQLite. 3588563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3589563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_key( 3590563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3 *db, /* Database to be rekeyed */ 3591563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const void *pKey, int nKey /* The key */ 3592563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 3593563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3594563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3595563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Change the key on an open database. If the current database is not 3596563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the 3597563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** database is decrypted. 3598563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3599563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The code to implement this API is not available in the public release 3600563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** of SQLite. 3601563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3602563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_rekey( 3603563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3 *db, /* Database to be rekeyed */ 3604563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const void *pKey, int nKey /* The new key */ 3605563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 3606563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3607563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3608dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Suspend Execution For A Short Time {H10530} <S40410> 3609563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3610dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_sleep() function causes the current thread to suspend execution 3611dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for at least a number of milliseconds specified in its parameter. 3612563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3613dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the operating system does not support sleep requests with 3614dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** millisecond time resolution, then the time will be rounded up to 3615dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the nearest second. The number of milliseconds of sleep actually 3616563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** requested from the operating system is returned. 3617dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3618dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite implements this interface by calling the xSleep() 3619dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** method of the default [sqlite3_vfs] object. 3620dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3621dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: [H10533] [H10536] 3622563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3623563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_sleep(int); 3624563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3625563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3626dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Name Of The Folder Holding Temporary Files {H10310} <S20000> 3627563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3628563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** If this global variable is made to point to a string which is 3629dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the name of a folder (a.k.a. directory), then all temporary files 3630563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** created by SQLite will be placed in that directory. If this variable 3631dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is a NULL pointer, then SQLite performs a search for an appropriate 3632dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** temporary file directory. 3633563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3634dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** It is not safe to modify this variable once a [database connection] 3635dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** has been opened. It is intended that this variable be set once 3636dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** as part of process initialization and before any SQLite interface 3637dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** routines have been call and remain unchanged thereafter. 3638563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3639dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve BlockSQLITE_EXTERN char *sqlite3_temp_directory; 3640563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3641563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3642dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Test For Auto-Commit Mode {H12930} <S60200> 3643dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: {autocommit mode} 3644dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3645dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_get_autocommit() interface returns non-zero or 3646dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** zero if the given database connection is or is not in autocommit mode, 3647dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** respectively. Autocommit mode is on by default. 3648dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Autocommit mode is disabled by a [BEGIN] statement. 3649dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK]. 3650dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3651dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If certain kinds of errors occur on a statement within a multi-statement 3652dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR], 3653dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the 3654dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** transaction might be rolled back automatically. The only way to 3655dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** find out whether SQLite automatically rolled back the transaction after 3656dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** an error is to use this function. 3657dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3658dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If another thread changes the autocommit status of the database 3659dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** connection while this routine is running, then the return value 3660dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is undefined. 3661dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3662dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: [H12931] [H12932] [H12933] [H12934] 3663563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3664563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_get_autocommit(sqlite3*); 3665563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3666563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3667dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Find The Database Handle Of A Prepared Statement {H13120} <S60600> 3668563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3669dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_db_handle interface returns the [database connection] handle 3670dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to which a [prepared statement] belongs. The [database connection] 3671dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** returned by sqlite3_db_handle is the same [database connection] that was the first argument 3672dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to the [sqlite3_prepare_v2()] call (or its variants) that was used to 3673dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** create the statement in the first place. 3674dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3675dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: [H13123] 3676563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3677563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarksqlite3 *sqlite3_db_handle(sqlite3_stmt*); 3678563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3679563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3680dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Find the next prepared statement {H13140} <S60600> 3681563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3682dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This interface returns a pointer to the next [prepared statement] after 3683dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** pStmt associated with the [database connection] pDb. If pStmt is NULL 3684dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** then this interface returns a pointer to the first prepared statement 3685dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** associated with the database connection pDb. If no prepared statement 3686dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** satisfies the conditions of this routine, it returns NULL. 3687563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3688dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The [database connection] pointer D in a call to 3689dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_next_stmt(D,S)] must refer to an open database 3690dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** connection and in particular must not be a NULL pointer. 3691dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3692dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: [H13143] [H13146] [H13149] [H13152] 3693dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 3694dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocksqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt); 3695dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 3696dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 3697dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Commit And Rollback Notification Callbacks {H12950} <S60400> 3698dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3699dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_commit_hook() interface registers a callback 3700dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** function to be invoked whenever a transaction is committed. 3701dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Any callback set by a previous call to sqlite3_commit_hook() 3702dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for the same database connection is overridden. 3703dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_rollback_hook() interface registers a callback 3704dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** function to be invoked whenever a transaction is committed. 3705dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Any callback set by a previous call to sqlite3_commit_hook() 3706dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for the same database connection is overridden. 3707dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The pArg argument is passed through to the callback. 3708dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the callback on a commit hook function returns non-zero, 3709dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** then the commit is converted into a rollback. 3710dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3711dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If another function was previously registered, its 3712dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** pArg value is returned. Otherwise NULL is returned. 3713dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3714dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The callback implementation must not do anything that will modify 3715dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the database connection that invoked the callback. Any actions 3716dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to modify the database connection must be deferred until after the 3717dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** completion of the [sqlite3_step()] call that triggered the commit 3718dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or rollback hook in the first place. 3719dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 3720dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** database connections for the meaning of "modify" in this paragraph. 3721563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3722563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Registering a NULL function disables the callback. 3723563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3724dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** For the purposes of this API, a transaction is said to have been 3725563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** rolled back if an explicit "ROLLBACK" statement is executed, or 3726dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** an error or constraint causes an implicit rollback to occur. 3727dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The rollback callback is not invoked if a transaction is 3728dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** automatically rolled back because the database connection is closed. 3729dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The rollback callback is not invoked if a transaction is 3730dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** rolled back because a commit callback returned non-zero. 3731dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <todo> Check on this </todo> 3732dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3733dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 3734dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12951] [H12952] [H12953] [H12954] [H12955] 3735dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12961] [H12962] [H12963] [H12964] 3736563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3737563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*); 3738563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*); 3739563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3740563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3741dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Data Change Notification Callbacks {H12970} <S60400> 3742dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3743dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_update_hook() interface registers a callback function 3744dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** with the [database connection] identified by the first argument 3745dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to be invoked whenever a row is updated, inserted or deleted. 3746dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Any callback set by a previous call to this function 3747dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for the same database connection is overridden. 3748dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3749dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The second argument is a pointer to the function to invoke when a 3750dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** row is updated, inserted or deleted. 3751dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The first argument to the callback is a copy of the third argument 3752dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to sqlite3_update_hook(). 3753dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE], 3754dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or [SQLITE_UPDATE], depending on the operation that caused the callback 3755dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to be invoked. 3756dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The third and fourth arguments to the callback contain pointers to the 3757dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** database and table name containing the affected row. 3758dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The final callback parameter is the [rowid] of the row. 3759dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** In the case of an update, this is the [rowid] after the update takes place. 3760563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3761563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The update hook is not invoked when internal system tables are 3762563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** modified (i.e. sqlite_master and sqlite_sequence). 3763563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3764dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The update hook implementation must not do anything that will modify 3765dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the database connection that invoked the update hook. Any actions 3766dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to modify the database connection must be deferred until after the 3767dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** completion of the [sqlite3_step()] call that triggered the update hook. 3768dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 3769dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** database connections for the meaning of "modify" in this paragraph. 3770dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3771dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If another function was previously registered, its pArg value 3772dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is returned. Otherwise NULL is returned. 3773dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3774dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 3775dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H12971] [H12973] [H12975] [H12977] [H12979] [H12981] [H12983] [H12986] 3776563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3777563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid *sqlite3_update_hook( 3778563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3*, 3779dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void(*)(void *,int ,char const *,char const *,sqlite3_int64), 3780563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark void* 3781563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 3782563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3783563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3784dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Enable Or Disable Shared Pager Cache {H10330} <S30900> 3785dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: {shared cache} {shared cache mode} 3786563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3787563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** This routine enables or disables the sharing of the database cache 3788dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and schema data structures between [database connection | connections] 3789dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to the same database. Sharing is enabled if the argument is true 3790dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and disabled if the argument is false. 3791dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3792dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Cache sharing is enabled and disabled for an entire process. 3793dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This is a change as of SQLite version 3.5.0. In prior versions of SQLite, 3794dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sharing was enabled or disabled for each thread separately. 3795dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3796dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The cache sharing mode set by this interface effects all subsequent 3797dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()]. 3798dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Existing database connections continue use the sharing mode 3799dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that was in effect at the time they were opened. 3800563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3801563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Virtual tables cannot be used with a shared cache. When shared 3802dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** cache is enabled, the [sqlite3_create_module()] API used to register 3803563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** virtual tables will always return an error. 3804563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3805dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This routine returns [SQLITE_OK] if shared cache was enabled or disabled 3806dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** successfully. An [error code] is returned otherwise. 3807dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3808dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Shared cache is disabled by default. But this might change in 3809dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** future releases of SQLite. Applications that care about shared 3810dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** cache setting should set it explicitly. 3811dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3812dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** See Also: [SQLite Shared-Cache Mode] 3813563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3814dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: [H10331] [H10336] [H10337] [H10339] 3815563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3816563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_enable_shared_cache(int); 3817563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3818563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3819dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Attempt To Free Heap Memory {H17340} <S30220> 3820563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3821dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_release_memory() interface attempts to free N bytes 3822dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of heap memory by deallocating non-essential memory allocations 3823dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** held by the database library. {END} Memory used to cache database 3824dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** pages to improve performance is an example of non-essential memory. 3825dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_release_memory() returns the number of bytes actually freed, 3826dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** which might be more or less than the amount requested. 3827563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3828dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: [H17341] [H17342] 3829563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3830563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_release_memory(int); 3831563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3832563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3833dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Impose A Limit On Heap Size {H17350} <S30220> 3834563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3835dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_soft_heap_limit() interface places a "soft" limit 3836dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** on the amount of heap memory that may be allocated by SQLite. 3837dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If an internal allocation is requested that would exceed the 3838dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** soft heap limit, [sqlite3_release_memory()] is invoked one or 3839dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** more times to free up some space before the allocation is performed. 3840563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3841dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The limit is called "soft", because if [sqlite3_release_memory()] 3842dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** cannot free sufficient memory to prevent the limit from being exceeded, 3843dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the memory is allocated anyway and the current operation proceeds. 3844563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3845563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** A negative or zero value for N means that there is no soft heap limit and 3846dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_release_memory()] will only be called when memory is exhausted. 3847563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The default value for the soft heap limit is zero. 3848563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3849dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite makes a best effort to honor the soft heap limit. 3850dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** But if the soft heap limit cannot be honored, execution will 3851dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** continue without error or notification. This is why the limit is 3852563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** called a "soft" limit. It is advisory only. 3853563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3854dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Prior to SQLite version 3.5.0, this routine only constrained the memory 3855dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** allocated by a single thread - the same thread in which this routine 3856dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** runs. Beginning with SQLite version 3.5.0, the soft heap limit is 3857dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** applied to all threads. The value specified for the soft heap limit 3858dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is an upper bound on the total memory allocation for all threads. In 3859dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** version 3.5.0 there is no mechanism for limiting the heap usage for 3860dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** individual threads. 3861563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3862dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 3863dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H16351] [H16352] [H16353] [H16354] [H16355] [H16358] 3864563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3865dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockvoid sqlite3_soft_heap_limit(int); 3866563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3867563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3868dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Extract Metadata About A Column Of A Table {H12850} <S60300> 3869563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3870dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This routine returns metadata about a specific column of a specific 3871dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** database table accessible using the [database connection] handle 3872dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** passed as the first function argument. 3873563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3874dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The column is identified by the second, third and fourth parameters to 3875563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** this function. The second parameter is either the name of the database 3876563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** (i.e. "main", "temp" or an attached database) containing the specified 3877563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** table or NULL. If it is NULL, then all attached databases are searched 3878dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for the table using the same algorithm used by the database engine to 3879563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** resolve unqualified table references. 3880563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3881dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The third and fourth parameters to this function are the table and column 3882dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** name of the desired column, respectively. Neither of these parameters 3883563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** may be NULL. 3884563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3885dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Metadata is returned by writing to the memory locations passed as the 5th 3886dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and subsequent parameters to this function. Any of these arguments may be 3887dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** NULL, in which case the corresponding element of metadata is omitted. 3888563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3889dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <blockquote> 3890dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <table border="1"> 3891dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <tr><th> Parameter <th> Output<br>Type <th> Description 3892563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3893dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <tr><td> 5th <td> const char* <td> Data type 3894dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <tr><td> 6th <td> const char* <td> Name of default collation sequence 3895dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint 3896dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY 3897dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT] 3898dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </table> 3899dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </blockquote> 3900563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3901dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The memory pointed to by the character pointers returned for the 3902dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** declaration type and collation sequence is valid only until the next 3903dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** call to any SQLite API function. 3904563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3905dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the specified table is actually a view, an [error code] is returned. 3906563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3907dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the specified column is "rowid", "oid" or "_rowid_" and an 3908dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output 3909563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** parameters are set for the explicitly declared column. If there is no 3910dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** explicitly declared [INTEGER PRIMARY KEY] column, then the output 3911dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** parameters are set as follows: 3912563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3913563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <pre> 3914563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** data type: "INTEGER" 3915563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** collation sequence: "BINARY" 3916563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** not null: 0 3917563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** primary key: 1 3918563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** auto increment: 0 3919563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** </pre> 3920563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3921563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** This function may load one or more schemas from database files. If an 3922563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** error occurs during this process, or if the requested table or column 3923dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** cannot be found, an [error code] is returned and an error message left 3924dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** in the [database connection] (to be retrieved using sqlite3_errmsg()). 3925563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3926563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** This API is only available if the library was compiled with the 3927dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined. 3928563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3929563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_table_column_metadata( 3930563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3 *db, /* Connection handle */ 3931563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const char *zDbName, /* Database name or NULL */ 3932563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const char *zTableName, /* Table name */ 3933563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const char *zColumnName, /* Column name */ 3934563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark char const **pzDataType, /* OUTPUT: Declared data type */ 3935563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark char const **pzCollSeq, /* OUTPUT: Collation sequence name */ 3936563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */ 3937563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int *pPrimaryKey, /* OUTPUT: True if column part of PK */ 3938dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int *pAutoinc /* OUTPUT: True if column is auto-increment */ 3939563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 3940563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3941563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3942dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Load An Extension {H12600} <S20500> 3943dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3944dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This interface loads an SQLite extension library from the named file. 3945dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3946dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H12601} The sqlite3_load_extension() interface attempts to load an 3947dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite extension library contained in the file zFile. 3948563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3949dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H12602} The entry point is zProc. 3950563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3951dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H12603} zProc may be 0, in which case the name of the entry point 3952dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** defaults to "sqlite3_extension_init". 3953563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3954dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H12604} The sqlite3_load_extension() interface shall return 3955dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong. 3956563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3957dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H12605} If an error occurs and pzErrMsg is not 0, then the 3958dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_load_extension()] interface shall attempt to 3959dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** fill *pzErrMsg with error message text stored in memory 3960dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** obtained from [sqlite3_malloc()]. {END} The calling function 3961dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** should free this memory by calling [sqlite3_free()]. 3962dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3963dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H12606} Extension loading must be enabled using 3964dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_enable_load_extension()] prior to calling this API, 3965dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** otherwise an error will be returned. 3966563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3967563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_load_extension( 3968563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3 *db, /* Load the extension into this database connection */ 3969563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const char *zFile, /* Name of the shared library containing extension */ 3970563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const char *zProc, /* Entry point. Derived from zFile if 0 */ 3971563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark char **pzErrMsg /* Put error message here if not 0 */ 3972563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 3973563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3974563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3975dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Enable Or Disable Extension Loading {H12620} <S20500> 3976563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3977563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** So as not to open security holes in older applications that are 3978563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** unprepared to deal with extension loading, and as a means of disabling 3979dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** extension loading while evaluating user-entered SQL, the following API 3980dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is provided to turn the [sqlite3_load_extension()] mechanism on and off. 3981dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3982dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Extension loading is off by default. See ticket #1863. 3983563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3984dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H12621} Call the sqlite3_enable_load_extension() routine with onoff==1 3985dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to turn extension loading on and call it with onoff==0 to turn 3986dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** it back off again. 3987dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 3988dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H12622} Extension loading is off by default. 3989563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 3990563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_enable_load_extension(sqlite3 *db, int onoff); 3991563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 3992563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 3993dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Automatically Load An Extensions {H12640} <S20500> 3994563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3995563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** This API can be invoked at program startup in order to register 3996563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** one or more statically linked extensions that will be available 3997dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to all new [database connections]. {END} 3998563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 3999dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This routine stores a pointer to the extension in an array that is 4000dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** obtained from [sqlite3_malloc()]. If you run a memory leak checker 4001dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** on your program and it reports a leak because of this array, invoke 4002dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_reset_auto_extension()] prior to shutdown to free the memory. 4003563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4004dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H12641} This function registers an extension entry point that is 4005dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** automatically invoked whenever a new [database connection] 4006dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is opened using [sqlite3_open()], [sqlite3_open16()], 4007dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or [sqlite3_open_v2()]. 4008563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4009dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H12642} Duplicate extensions are detected so calling this routine 4010dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** multiple times with the same extension is harmless. 4011563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4012dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H12643} This routine stores a pointer to the extension in an array 4013dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that is obtained from [sqlite3_malloc()]. 4014dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4015dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H12644} Automatic extensions apply across all threads. 4016563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 4017dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_auto_extension(void (*xEntryPoint)(void)); 4018563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 4019563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 4020dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Reset Automatic Extension Loading {H12660} <S20500> 4021563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4022dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This function disables all previously registered automatic 4023dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** extensions. {END} It undoes the effect of all prior 4024dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_auto_extension()] calls. 4025563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4026dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H12661} This function disables all previously registered 4027dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** automatic extensions. 4028563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4029dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H12662} This function disables automatic extensions in all threads. 4030563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 4031563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkvoid sqlite3_reset_auto_extension(void); 4032563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 4033563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 4034563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark****** EXPERIMENTAL - subject to change without notice ************** 4035563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4036563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The interface to the virtual-table mechanism is currently considered 4037563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** to be experimental. The interface might change in incompatible ways. 4038563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** If this is a problem for you, do not use the interface at this time. 4039563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4040dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** When the virtual-table mechanism stabilizes, we will declare the 4041563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** interface fixed, support it indefinitely, and remove this comment. 4042563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 4043563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 4044563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 4045563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Structures used by the virtual table interface 4046563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 4047563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarktypedef struct sqlite3_vtab sqlite3_vtab; 4048563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarktypedef struct sqlite3_index_info sqlite3_index_info; 4049563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarktypedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor; 4050563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarktypedef struct sqlite3_module sqlite3_module; 4051563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 4052563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 4053dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Virtual Table Object {H18000} <S20400> 4054dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: sqlite3_module 4055dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 4056dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4057563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** A module is a class of virtual tables. Each module is defined 4058563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** by an instance of the following structure. This structure consists 4059563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** mostly of methods for the module. 4060dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4061dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This interface is experimental and is subject to change or 4062dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** removal in future releases of SQLite. 4063563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 4064563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkstruct sqlite3_module { 4065563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int iVersion; 4066563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int (*xCreate)(sqlite3*, void *pAux, 4067563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int argc, const char *const*argv, 4068563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3_vtab **ppVTab, char**); 4069563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int (*xConnect)(sqlite3*, void *pAux, 4070563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int argc, const char *const*argv, 4071563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3_vtab **ppVTab, char**); 4072563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*); 4073563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int (*xDisconnect)(sqlite3_vtab *pVTab); 4074563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int (*xDestroy)(sqlite3_vtab *pVTab); 4075563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor); 4076563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int (*xClose)(sqlite3_vtab_cursor*); 4077563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr, 4078563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int argc, sqlite3_value **argv); 4079563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int (*xNext)(sqlite3_vtab_cursor*); 4080563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int (*xEof)(sqlite3_vtab_cursor*); 4081563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int); 4082dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid); 4083dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *); 4084563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int (*xBegin)(sqlite3_vtab *pVTab); 4085563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int (*xSync)(sqlite3_vtab *pVTab); 4086563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int (*xCommit)(sqlite3_vtab *pVTab); 4087563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int (*xRollback)(sqlite3_vtab *pVTab); 4088563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName, 4089563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), 4090563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark void **ppArg); 4091dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xRename)(sqlite3_vtab *pVtab, const char *zNew); 4092563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark}; 4093563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 4094563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 4095dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Virtual Table Indexing Information {H18100} <S20400> 4096dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: sqlite3_index_info 4097dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 4098dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4099563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The sqlite3_index_info structure and its substructures is used to 4100563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** pass information into and receive the reply from the xBestIndex 4101563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** method of an sqlite3_module. The fields under **Inputs** are the 4102563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** inputs to xBestIndex and are read-only. xBestIndex inserts its 4103563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** results into the **Outputs** fields. 4104563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4105dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The aConstraint[] array records WHERE clause constraints of the form: 4106563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4107dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <pre>column OP expr</pre> 4108563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4109dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** where OP is =, <, <=, >, or >=. The particular operator is 4110dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** stored in aConstraint[].op. The index of the column is stored in 4111563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** aConstraint[].iColumn. aConstraint[].usable is TRUE if the 4112563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** expr on the right-hand side can be evaluated (and thus the constraint 4113563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** is usable) and false if it cannot. 4114563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4115563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The optimizer automatically inverts terms of the form "expr OP column" 4116dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and makes other simplifications to the WHERE clause in an attempt to 4117563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** get as many WHERE clause terms into the form shown above as possible. 4118563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The aConstraint[] array only reports WHERE clause terms in the correct 4119563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** form that refer to the particular virtual table being queried. 4120563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4121563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Information about the ORDER BY clause is stored in aOrderBy[]. 4122563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Each term of aOrderBy records a column of the ORDER BY clause. 4123563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4124563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The xBestIndex method must fill aConstraintUsage[] with information 4125563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** about what parameters to pass to xFilter. If argvIndex>0 then 4126563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the right-hand side of the corresponding aConstraint[] is evaluated 4127563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** and becomes the argvIndex-th entry in argv. If aConstraintUsage[].omit 4128563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** is true, then the constraint is assumed to be fully handled by the 4129563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** virtual table and is not checked again by SQLite. 4130563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4131563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The idxNum and idxPtr values are recorded and passed into xFilter. 4132563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** sqlite3_free() is used to free idxPtr if needToFreeIdxPtr is true. 4133563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4134563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The orderByConsumed means that output from xFilter will occur in 4135563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the correct order to satisfy the ORDER BY clause so that no separate 4136563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** sorting step is required. 4137563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4138563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The estimatedCost value is an estimate of the cost of doing the 4139563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** particular lookup. A full scan of a table with N entries should have 4140563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** a cost of N. A binary search of a table of N entries should have a 4141563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** cost of approximately log(N). 4142dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4143dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This interface is experimental and is subject to change or 4144dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** removal in future releases of SQLite. 4145563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 4146563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkstruct sqlite3_index_info { 4147563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark /* Inputs */ 4148dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int nConstraint; /* Number of entries in aConstraint */ 4149dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block struct sqlite3_index_constraint { 4150563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int iColumn; /* Column on left-hand side of constraint */ 4151563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark unsigned char op; /* Constraint operator */ 4152563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark unsigned char usable; /* True if this constraint is usable */ 4153563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int iTermOffset; /* Used internally - xBestIndex should ignore */ 4154dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block } *aConstraint; /* Table of WHERE clause constraints */ 4155dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int nOrderBy; /* Number of terms in the ORDER BY clause */ 4156dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block struct sqlite3_index_orderby { 4157563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int iColumn; /* Column number */ 4158563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark unsigned char desc; /* True for DESC. False for ASC. */ 4159dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block } *aOrderBy; /* The ORDER BY clause */ 4160563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark /* Outputs */ 4161563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark struct sqlite3_index_constraint_usage { 4162563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int argvIndex; /* if >0, constraint is part of argv to xFilter */ 4163563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark unsigned char omit; /* Do not code a test for this constraint */ 4164dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block } *aConstraintUsage; 4165563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int idxNum; /* Number used to identify the index */ 4166563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark char *idxStr; /* String, possibly obtained from sqlite3_malloc */ 4167563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ 4168563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int orderByConsumed; /* True if output is already ordered */ 4169563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark double estimatedCost; /* Estimated cost of using this index */ 4170563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark}; 4171563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_INDEX_CONSTRAINT_EQ 2 4172563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_INDEX_CONSTRAINT_GT 4 4173563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_INDEX_CONSTRAINT_LE 8 4174563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_INDEX_CONSTRAINT_LT 16 4175563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_INDEX_CONSTRAINT_GE 32 4176563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#define SQLITE_INDEX_CONSTRAINT_MATCH 64 4177563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 4178563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 4179dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Register A Virtual Table Implementation {H18200} <S20400> 4180dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 4181dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4182dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This routine is used to register a new module name with a 4183dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [database connection]. Module names must be registered before 4184dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** creating new virtual tables on the module, or before using 4185dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** preexisting virtual tables of the module. 4186dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4187dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This interface is experimental and is subject to change or 4188dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** removal in future releases of SQLite. 4189563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 4190dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve BlockSQLITE_EXPERIMENTAL int sqlite3_create_module( 4191563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3 *db, /* SQLite connection to register module with */ 4192563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const char *zName, /* Name of the module */ 4193563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const sqlite3_module *, /* Methods for the module */ 4194563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark void * /* Client data for xCreate/xConnect */ 4195563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 4196563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 4197563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 4198dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Register A Virtual Table Implementation {H18210} <S20400> 4199dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 4200dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4201dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This routine is identical to the [sqlite3_create_module()] method above, 4202dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** except that it allows a destructor function to be specified. It is 4203dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** even more experimental than the rest of the virtual tables API. 4204dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 4205dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve BlockSQLITE_EXPERIMENTAL int sqlite3_create_module_v2( 4206dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block sqlite3 *db, /* SQLite connection to register module with */ 4207dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block const char *zName, /* Name of the module */ 4208dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block const sqlite3_module *, /* Methods for the module */ 4209dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void *, /* Client data for xCreate/xConnect */ 4210dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void(*xDestroy)(void*) /* Module destructor function */ 4211dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block); 4212dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 4213dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 4214dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Virtual Table Instance Object {H18010} <S20400> 4215dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: sqlite3_vtab 4216dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 4217dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4218563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Every module implementation uses a subclass of the following structure 4219563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** to describe a particular instance of the module. Each subclass will 4220dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** be tailored to the specific needs of the module implementation. 4221dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The purpose of this superclass is to define certain fields that are 4222dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** common to all module implementations. 4223563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4224563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Virtual tables methods can set an error message by assigning a 4225dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should 4226dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** take care that any prior string is freed by a call to [sqlite3_free()] 4227563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** prior to assigning a new string to zErrMsg. After the error message 4228563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** is delivered up to the client application, the string will be automatically 4229563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** freed by sqlite3_free() and the zErrMsg field will be zeroed. Note 4230563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** that sqlite3_mprintf() and sqlite3_free() are used on the zErrMsg field 4231563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** since virtual tables are commonly implemented in loadable extensions which 4232563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** do not have access to sqlite3MPrintf() or sqlite3Free(). 4233dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4234dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This interface is experimental and is subject to change or 4235dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** removal in future releases of SQLite. 4236563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 4237563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkstruct sqlite3_vtab { 4238563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const sqlite3_module *pModule; /* The module for this virtual table */ 4239563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int nRef; /* Used internally */ 4240563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark char *zErrMsg; /* Error message from sqlite3_mprintf() */ 4241563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark /* Virtual table implementations will typically add additional fields */ 4242563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark}; 4243563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 4244dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 4245dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Virtual Table Cursor Object {H18020} <S20400> 4246dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: sqlite3_vtab_cursor 4247dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 4248dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4249dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Every module implementation uses a subclass of the following structure 4250563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** to describe cursors that point into the virtual table and are used 4251563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** to loop through the virtual table. Cursors are created using the 4252563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** xOpen method of the module. Each module implementation will define 4253563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the content of a cursor structure to suit its own needs. 4254563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4255563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** This superclass exists in order to define fields of the cursor that 4256563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** are common to all implementations. 4257dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4258dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This interface is experimental and is subject to change or 4259dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** removal in future releases of SQLite. 4260563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 4261563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkstruct sqlite3_vtab_cursor { 4262563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3_vtab *pVtab; /* Virtual table of this cursor */ 4263563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark /* Virtual table implementations will typically add additional fields */ 4264563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark}; 4265563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 4266563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 4267dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Declare The Schema Of A Virtual Table {H18280} <S20400> 4268dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 4269dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4270563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The xCreate and xConnect methods of a module use the following API 4271563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** to declare the format (the names and datatypes of the columns) of 4272563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the virtual tables they implement. 4273dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4274dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This interface is experimental and is subject to change or 4275dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** removal in future releases of SQLite. 4276563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 4277dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve BlockSQLITE_EXPERIMENTAL int sqlite3_declare_vtab(sqlite3*, const char *zCreateTable); 4278563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 4279563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 4280dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Overload A Function For A Virtual Table {H18300} <S20400> 4281dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 4282dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4283563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Virtual tables can provide alternative implementations of functions 4284563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** using the xFindFunction method. But global versions of those functions 4285563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** must exist in order to be overloaded. 4286563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4287563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** This API makes sure a global version of a function with a particular 4288563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** name and number of parameters exists. If no such function exists 4289563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** before this API is called, a new function is created. The implementation 4290563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** of the new function always causes an exception to be thrown. So 4291563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** the new function is not good for anything by itself. Its only 4292dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** purpose is to be a placeholder function that can be overloaded 4293563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** by virtual tables. 4294563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4295563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** This API should be considered part of the virtual table interface, 4296563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** which is experimental and subject to change. 4297563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 4298dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve BlockSQLITE_EXPERIMENTAL int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg); 4299563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 4300563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 4301563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The interface to the virtual-table mechanism defined above (back up 4302563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** to a comment remarkably similar to this one) is currently considered 4303563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** to be experimental. The interface might change in incompatible ways. 4304563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** If this is a problem for you, do not use the interface at this time. 4305563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4306dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** When the virtual-table mechanism stabilizes, we will declare the 4307563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** interface fixed, support it indefinitely, and remove this comment. 4308563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4309563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark****** EXPERIMENTAL - subject to change without notice ************** 4310563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 4311563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 4312563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 4313dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: A Handle To An Open BLOB {H17800} <S30230> 4314dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** KEYWORDS: {BLOB handle} {BLOB handles} 4315563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4316dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** An instance of this object represents an open BLOB on which 4317dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_blob_open | incremental BLOB I/O] can be performed. 4318dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Objects of this type are created by [sqlite3_blob_open()] 4319dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and destroyed by [sqlite3_blob_close()]. 4320563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces 4321dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** can be used to read or write small subsections of the BLOB. 4322dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes. 4323563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 4324563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarktypedef struct sqlite3_blob sqlite3_blob; 4325563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 4326563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 4327dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Open A BLOB For Incremental I/O {H17810} <S30230> 4328563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4329dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This interfaces opens a [BLOB handle | handle] to the BLOB located 4330dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** in row iRow, column zColumn, table zTable in database zDb; 4331dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** in other words, the same BLOB that would be selected by: 4332563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4333563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** <pre> 4334dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow; 4335dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </pre> {END} 4336dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4337dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the flags parameter is non-zero, the the BLOB is opened for read 4338dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and write access. If it is zero, the BLOB is opened for read access. 4339dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4340dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Note that the database name is not the filename that contains 4341dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the database but rather the symbolic name of the database that 4342dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is assigned when the database is connected using [ATTACH]. 4343dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** For the main database file, the database name is "main". 4344dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** For TEMP tables, the database name is "temp". 4345dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4346dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** On success, [SQLITE_OK] is returned and the new [BLOB handle] is written 4347dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to *ppBlob. Otherwise an [error code] is returned and any value written 4348dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to *ppBlob should not be used by the caller. 4349dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This function sets the [database connection] error code and message 4350563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()]. 4351dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4352dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the row that a BLOB handle points to is modified by an 4353dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects 4354dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** then the BLOB handle is marked as "expired". 4355dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This is true if any column of the row is changed, even a column 4356dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** other than the one the BLOB handle is open on. 4357dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for 4358dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a expired BLOB handle fail with an return code of [SQLITE_ABORT]. 4359dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Changes written into a BLOB prior to the BLOB expiring are not 4360dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** rollback by the expiration of the BLOB. Such changes will eventually 4361dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** commit if the transaction continues to completion. 4362dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4363dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 4364dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H17813] [H17814] [H17816] [H17819] [H17821] [H17824] 4365563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 4366563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_blob_open( 4367563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3*, 4368563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const char *zDb, 4369563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const char *zTable, 4370563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark const char *zColumn, 4371dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block sqlite3_int64 iRow, 4372563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark int flags, 4373563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark sqlite3_blob **ppBlob 4374563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark); 4375563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 4376563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 4377dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Close A BLOB Handle {H17830} <S30230> 4378dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4379dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Closes an open [BLOB handle]. 4380dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4381dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Closing a BLOB shall cause the current transaction to commit 4382dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** if there are no other BLOBs, no pending prepared statements, and the 4383dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** database connection is in [autocommit mode]. 4384dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If any writes were made to the BLOB, they might be held in cache 4385dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** until the close operation if they will fit. {END} 4386dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4387dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Closing the BLOB often forces the changes 4388dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** out to disk and so if any I/O errors occur, they will likely occur 4389dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** at the time when the BLOB is closed. {H17833} Any errors that occur during 4390dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** closing are reported as a non-zero return value. 4391dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4392dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The BLOB is closed unconditionally. Even if this routine returns 4393dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** an error code, the BLOB is still closed. 4394563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4395dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 4396dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H17833] [H17836] [H17839] 4397563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 4398563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_blob_close(sqlite3_blob *); 4399563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 4400563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 4401dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Return The Size Of An Open BLOB {H17840} <S30230> 4402563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4403dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Returns the size in bytes of the BLOB accessible via the open 4404dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** []BLOB handle] in its only argument. 4405dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4406dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 4407dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H17843] 4408563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 4409563af33bc48281d19dce701398dbb88cb54fd7ecCary Clarkint sqlite3_blob_bytes(sqlite3_blob *); 4410563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 4411563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 4412dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Read Data From A BLOB Incrementally {H17850} <S30230> 4413dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4414dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This function is used to read data from an open [BLOB handle] into a 4415dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** caller-supplied buffer. N bytes of data are copied into buffer Z 4416dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** from the open BLOB, starting at offset iOffset. 4417dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4418dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If offset iOffset is less than N bytes from the end of the BLOB, 4419dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_ERROR] is returned and no data is read. If N or iOffset is 4420dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** less than zero, [SQLITE_ERROR] is returned and no data is read. 4421dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4422dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** An attempt to read from an expired [BLOB handle] fails with an 4423dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** error code of [SQLITE_ABORT]. 4424dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4425dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** On success, SQLITE_OK is returned. 4426dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Otherwise, an [error code] or an [extended error code] is returned. 4427dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4428dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 4429dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H17853] [H17856] [H17859] [H17862] [H17863] [H17865] [H17868] 4430dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 4431dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset); 4432dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 4433dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 4434dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Write Data Into A BLOB Incrementally {H17870} <S30230> 4435dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4436dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This function is used to write data into an open [BLOB handle] from a 4437dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** caller-supplied buffer. N bytes of data are copied from the buffer Z 4438dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** into the open BLOB, starting at offset iOffset. 4439dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4440dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the [BLOB handle] passed as the first argument was not opened for 4441dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** writing (the flags parameter to [sqlite3_blob_open()] was zero), 4442dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** this function returns [SQLITE_READONLY]. 4443dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4444dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This function may only modify the contents of the BLOB; it is 4445dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** not possible to increase the size of a BLOB using this API. 4446dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If offset iOffset is less than N bytes from the end of the BLOB, 4447dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_ERROR] is returned and no data is written. If N is 4448dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** less than zero [SQLITE_ERROR] is returned and no data is written. 4449dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4450dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** An attempt to write to an expired [BLOB handle] fails with an 4451dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** error code of [SQLITE_ABORT]. Writes to the BLOB that occurred 4452dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** before the [BLOB handle] expired are not rolled back by the 4453dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** expiration of the handle, though of course those changes might 4454dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** have been overwritten by the statement that expired the BLOB handle 4455dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or by other independent statements. 4456dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4457dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** On success, SQLITE_OK is returned. 4458dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Otherwise, an [error code] or an [extended error code] is returned. 4459dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4460dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 4461dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H17873] [H17874] [H17875] [H17876] [H17877] [H17879] [H17882] [H17885] 4462dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H17888] 4463dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 4464dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset); 4465dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 4466dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 4467dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Virtual File System Objects {H11200} <S20100> 4468dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4469dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** A virtual filesystem (VFS) is an [sqlite3_vfs] object 4470dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that SQLite uses to interact 4471dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** with the underlying operating system. Most SQLite builds come with a 4472dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** single default VFS that is appropriate for the host computer. 4473dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** New VFSes can be registered and existing VFSes can be unregistered. 4474dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The following interfaces are provided. 4475dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4476dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_vfs_find() interface returns a pointer to a VFS given its name. 4477dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Names are case sensitive. 4478dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Names are zero-terminated UTF-8 strings. 4479dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If there is no match, a NULL pointer is returned. 4480dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If zVfsName is NULL then the default VFS is returned. 4481dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4482dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** New VFSes are registered with sqlite3_vfs_register(). 4483dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Each new VFS becomes the default VFS if the makeDflt flag is set. 4484dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The same VFS can be registered multiple times without injury. 4485dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** To make an existing VFS into the default VFS, register it again 4486dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** with the makeDflt flag set. If two different VFSes with the 4487dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** same name are registered, the behavior is undefined. If a 4488dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** VFS is registered with a name that is NULL or an empty string, 4489dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** then the behavior is undefined. 4490dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4491dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Unregister a VFS with the sqlite3_vfs_unregister() interface. 4492dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the default VFS is unregistered, another VFS is chosen as 4493dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the default. The choice for the new VFS is arbitrary. 4494dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4495dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Requirements: 4496dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [H11203] [H11206] [H11209] [H11212] [H11215] [H11218] 4497dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 4498dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocksqlite3_vfs *sqlite3_vfs_find(const char *zVfsName); 4499dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_vfs_register(sqlite3_vfs*, int makeDflt); 4500dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_vfs_unregister(sqlite3_vfs*); 4501dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 4502dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 4503dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Mutexes {H17000} <S20000> 4504dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4505dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The SQLite core uses these routines for thread 4506dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** synchronization. Though they are intended for internal 4507dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** use by SQLite, code that links against SQLite is 4508dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** permitted to use any of these routines. 4509dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4510dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The SQLite source code contains multiple implementations 4511dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of these mutex routines. An appropriate implementation 4512dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is selected automatically at compile-time. The following 4513dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** implementations are available in the SQLite core: 4514dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4515dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <ul> 4516dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> SQLITE_MUTEX_OS2 4517dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> SQLITE_MUTEX_PTHREAD 4518dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> SQLITE_MUTEX_W32 4519dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> SQLITE_MUTEX_NOOP 4520dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </ul> 4521563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4522dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The SQLITE_MUTEX_NOOP implementation is a set of routines 4523dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that does no real locking and is appropriate for use in 4524dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a single-threaded application. The SQLITE_MUTEX_OS2, 4525dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLITE_MUTEX_PTHREAD, and SQLITE_MUTEX_W32 implementations 4526dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** are appropriate for use on OS/2, Unix, and Windows. 4527dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4528dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor 4529dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex 4530dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** implementation is included with the library. In this case the 4531dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** application must supply a custom mutex implementation using the 4532dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function 4533dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** before calling sqlite3_initialize() or any other public sqlite3_ 4534dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** function that calls sqlite3_initialize(). 4535dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4536dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H17011} The sqlite3_mutex_alloc() routine allocates a new 4537dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** mutex and returns a pointer to it. {H17012} If it returns NULL 4538dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that means that a mutex could not be allocated. {H17013} SQLite 4539dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** will unwind its stack and return an error. {H17014} The argument 4540dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to sqlite3_mutex_alloc() is one of these integer constants: 4541563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4542dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <ul> 4543dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> SQLITE_MUTEX_FAST 4544dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> SQLITE_MUTEX_RECURSIVE 4545dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> SQLITE_MUTEX_STATIC_MASTER 4546dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> SQLITE_MUTEX_STATIC_MEM 4547dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> SQLITE_MUTEX_STATIC_MEM2 4548dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> SQLITE_MUTEX_STATIC_PRNG 4549dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> SQLITE_MUTEX_STATIC_LRU 4550dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> SQLITE_MUTEX_STATIC_LRU2 4551dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </ul> 4552dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4553dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H17015} The first two constants cause sqlite3_mutex_alloc() to create 4554dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a new mutex. The new mutex is recursive when SQLITE_MUTEX_RECURSIVE 4555dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is used but not necessarily so when SQLITE_MUTEX_FAST is used. {END} 4556dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The mutex implementation does not need to make a distinction 4557dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does 4558dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** not want to. {H17016} But SQLite will only request a recursive mutex in 4559dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** cases where it really needs one. {END} If a faster non-recursive mutex 4560dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** implementation is available on the host platform, the mutex subsystem 4561dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** might return such a mutex in response to SQLITE_MUTEX_FAST. 4562dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4563dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H17017} The other allowed parameters to sqlite3_mutex_alloc() each return 4564dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a pointer to a static preexisting mutex. {END} Four static mutexes are 4565dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** used by the current version of SQLite. Future versions of SQLite 4566dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** may add additional static mutexes. Static mutexes are for internal 4567dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** use by SQLite only. Applications that use SQLite mutexes should 4568dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or 4569dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLITE_MUTEX_RECURSIVE. 4570dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4571dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H17018} Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST 4572dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc() 4573dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** returns a different mutex on every call. {H17034} But for the static 4574dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** mutex types, the same mutex is returned on every call that has 4575dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the same type number. 4576dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4577dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H17019} The sqlite3_mutex_free() routine deallocates a previously 4578dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** allocated dynamic mutex. {H17020} SQLite is careful to deallocate every 4579dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** dynamic mutex that it allocates. {A17021} The dynamic mutexes must not be in 4580dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** use when they are deallocated. {A17022} Attempting to deallocate a static 4581dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** mutex results in undefined behavior. {H17023} SQLite never deallocates 4582dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a static mutex. {END} 4583dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4584dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt 4585dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to enter a mutex. {H17024} If another thread is already within the mutex, 4586dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return 4587dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLITE_BUSY. {H17025} The sqlite3_mutex_try() interface returns [SQLITE_OK] 4588dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** upon successful entry. {H17026} Mutexes created using 4589dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread. 4590dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H17027} In such cases the, 4591dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** mutex must be exited an equal number of times before another thread 4592dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** can enter. {A17028} If the same thread tries to enter any other 4593dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** kind of mutex more than once, the behavior is undefined. 4594dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H17029} SQLite will never exhibit 4595dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** such behavior in its own use of mutexes. 4596dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4597dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Some systems (for example, Windows 95) do not support the operation 4598dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try() 4599dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** will always return SQLITE_BUSY. {H17030} The SQLite core only ever uses 4600dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_mutex_try() as an optimization so this is acceptable behavior. 4601dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4602dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H17031} The sqlite3_mutex_leave() routine exits a mutex that was 4603dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** previously entered by the same thread. {A17032} The behavior 4604dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is undefined if the mutex is not currently entered by the 4605dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** calling thread or is not currently allocated. {H17033} SQLite will 4606dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** never do either. {END} 4607dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4608dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or 4609dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_mutex_leave() is a NULL pointer, then all three routines 4610dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** behave as no-ops. 4611dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4612dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()]. 4613563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 4614dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocksqlite3_mutex *sqlite3_mutex_alloc(int); 4615dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockvoid sqlite3_mutex_free(sqlite3_mutex*); 4616dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockvoid sqlite3_mutex_enter(sqlite3_mutex*); 4617dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_mutex_try(sqlite3_mutex*); 4618dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockvoid sqlite3_mutex_leave(sqlite3_mutex*); 4619563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 4620563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 4621dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Mutex Methods Object {H17120} <S20130> 4622dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 4623dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4624dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** An instance of this structure defines the low-level routines 4625dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** used to allocate and use mutexes. 4626dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4627dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Usually, the default mutex implementations provided by SQLite are 4628dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sufficient, however the user has the option of substituting a custom 4629dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** implementation for specialized deployments or systems for which SQLite 4630dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** does not provide a suitable implementation. In this case, the user 4631dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** creates and populates an instance of this structure to pass 4632dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option. 4633dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Additionally, an instance of this structure can be used as an 4634dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** output variable when querying the system for the current mutex 4635dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** implementation, using the [SQLITE_CONFIG_GETMUTEX] option. 4636dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4637dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The xMutexInit method defined by this structure is invoked as 4638dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** part of system initialization by the sqlite3_initialize() function. 4639dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H17001} The xMutexInit routine shall be called by SQLite once for each 4640dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** effective call to [sqlite3_initialize()]. 4641dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4642dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The xMutexEnd method defined by this structure is invoked as 4643dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** part of system shutdown by the sqlite3_shutdown() function. The 4644dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** implementation of this method is expected to release all outstanding 4645dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** resources obtained by the mutex methods implementation, especially 4646dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** those obtained by the xMutexInit method. {H17003} The xMutexEnd() 4647dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** interface shall be invoked once for each call to [sqlite3_shutdown()]. 4648dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4649dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The remaining seven methods defined by this structure (xMutexAlloc, 4650dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and 4651dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** xMutexNotheld) implement the following interfaces (respectively): 4652dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4653dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <ul> 4654dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [sqlite3_mutex_alloc()] </li> 4655dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [sqlite3_mutex_free()] </li> 4656dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [sqlite3_mutex_enter()] </li> 4657dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [sqlite3_mutex_try()] </li> 4658dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [sqlite3_mutex_leave()] </li> 4659dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [sqlite3_mutex_held()] </li> 4660dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li> [sqlite3_mutex_notheld()] </li> 4661dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </ul> 4662563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4663dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The only difference is that the public sqlite3_XXX functions enumerated 4664dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** above silently ignore any invocations that pass a NULL pointer instead 4665dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of a valid mutex handle. The implementations of the methods defined 4666dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** by this structure are not required to handle this case, the results 4667dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of passing a NULL pointer instead of a valid mutex handle are undefined 4668dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** (i.e. it is acceptable to provide an implementation that segfaults if 4669dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** it is passed a NULL pointer). 4670dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 4671dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocktypedef struct sqlite3_mutex_methods sqlite3_mutex_methods; 4672dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockstruct sqlite3_mutex_methods { 4673dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xMutexInit)(void); 4674dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xMutexEnd)(void); 4675dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block sqlite3_mutex *(*xMutexAlloc)(int); 4676dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void (*xMutexFree)(sqlite3_mutex *); 4677dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void (*xMutexEnter)(sqlite3_mutex *); 4678dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xMutexTry)(sqlite3_mutex *); 4679dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void (*xMutexLeave)(sqlite3_mutex *); 4680dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xMutexHeld)(sqlite3_mutex *); 4681dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xMutexNotheld)(sqlite3_mutex *); 4682dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block}; 4683dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 4684dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 4685dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Mutex Verification Routines {H17080} <S20130> <S30800> 4686dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4687dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines 4688dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** are intended for use inside assert() statements. {H17081} The SQLite core 4689dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** never uses these routines except inside an assert() and applications 4690dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** are advised to follow the lead of the core. {H17082} The core only 4691dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** provides implementations for these routines when it is compiled 4692dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** with the SQLITE_DEBUG flag. {A17087} External mutex implementations 4693dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** are only required to provide these routines if SQLITE_DEBUG is 4694dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** defined and if NDEBUG is not defined. 4695dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4696dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H17083} These routines should return true if the mutex in their argument 4697dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is held or not held, respectively, by the calling thread. 4698dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4699dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {X17084} The implementation is not required to provided versions of these 4700dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** routines that actually work. If the implementation does not provide working 4701dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** versions of these routines, it should at least provide stubs that always 4702dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** return true so that one does not get spurious assertion failures. 4703dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4704dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H17085} If the argument to sqlite3_mutex_held() is a NULL pointer then 4705dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the routine should return 1. {END} This seems counter-intuitive since 4706dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** clearly the mutex cannot be held if it does not exist. But the 4707dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the reason the mutex does not exist is because the build is not 4708dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** using mutexes. And we do not want the assert() containing the 4709dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** call to sqlite3_mutex_held() to fail, so a non-zero return is 4710dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the appropriate thing to do. {H17086} The sqlite3_mutex_notheld() 4711dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** interface should also return 1 when given a NULL pointer. 4712dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 4713dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_mutex_held(sqlite3_mutex*); 4714dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_mutex_notheld(sqlite3_mutex*); 4715dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 4716dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 4717dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Mutex Types {H17001} <H17000> 4718563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4719dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The [sqlite3_mutex_alloc()] interface takes a single argument 4720dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** which is one of these integer constants. 4721563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4722dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The set of static mutexes may change from one SQLite release to the 4723dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** next. Applications that override the built-in mutex logic must be 4724dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** prepared to accommodate additional static mutexes. 4725dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 4726dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_MUTEX_FAST 0 4727dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_MUTEX_RECURSIVE 1 4728dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_MUTEX_STATIC_MASTER 2 4729dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */ 4730dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */ 4731dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */ 4732dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */ 4733dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */ 4734dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_MUTEX_STATIC_LRU2 7 /* lru page list */ 4735dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 4736dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 4737dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Retrieve the mutex for a database connection {H17002} <H17000> 4738563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** 4739dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This interface returns a pointer the [sqlite3_mutex] object that 4740dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** serializes access to the [database connection] given in the argument 4741dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** when the [threading mode] is Serialized. 4742dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the [threading mode] is Single-thread or Multi-thread then this 4743dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** routine returns a NULL pointer. 4744563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 4745dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocksqlite3_mutex *sqlite3_db_mutex(sqlite3*); 4746dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 4747dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 4748dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Low-Level Control Of Database Files {H11300} <S30800> 4749dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4750dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H11301} The [sqlite3_file_control()] interface makes a direct call to the 4751dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** xFileControl method for the [sqlite3_io_methods] object associated 4752dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** with a particular database identified by the second argument. {H11302} The 4753dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** name of the database is the name assigned to the database by the 4754dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <a href="lang_attach.html">ATTACH</a> SQL command that opened the 4755dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** database. {H11303} To control the main database file, use the name "main" 4756dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or a NULL pointer. {H11304} The third and fourth parameters to this routine 4757dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** are passed directly through to the second and third parameters of 4758dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the xFileControl method. {H11305} The return value of the xFileControl 4759dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** method becomes the return value of this routine. 4760dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4761dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** {H11306} If the second parameter (zDbName) does not match the name of any 4762dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** open database file, then SQLITE_ERROR is returned. {H11307} This error 4763dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** code is not remembered and will not be recalled by [sqlite3_errcode()] 4764dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or [sqlite3_errmsg()]. {A11308} The underlying xFileControl method might 4765dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** also return SQLITE_ERROR. {A11309} There is no way to distinguish between 4766dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** an incorrect zDbName and an SQLITE_ERROR return from the underlying 4767dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** xFileControl method. {END} 4768dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4769dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** See also: [SQLITE_FCNTL_LOCKSTATE] 4770dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 4771dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*); 4772dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 4773dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 4774dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Testing Interface {H11400} <S30800> 4775dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4776dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_test_control() interface is used to read out internal 4777dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** state of SQLite and to inject faults into SQLite for testing 4778dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** purposes. The first parameter is an operation code that determines 4779dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the number, meaning, and operation of all subsequent parameters. 4780dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4781dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This interface is not for use by applications. It exists solely 4782dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for verifying the correct operation of the SQLite library. Depending 4783dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** on how the SQLite library is compiled, this interface might not exist. 4784dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4785dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The details of the operation codes, their meanings, the parameters 4786dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** they take, and what they do are all subject to change without notice. 4787dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Unlike most of the SQLite API, this function is not guaranteed to 4788dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** operate consistently from one release to the next. 4789dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 4790dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_test_control(int op, ...); 4791dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 4792dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 4793dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Testing Interface Operation Codes {H11410} <H11400> 4794dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4795dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These constants are the valid operation code parameters used 4796dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** as the first argument to [sqlite3_test_control()]. 4797dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4798dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These parameters and their meanings are subject to change 4799dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** without notice. These values are for testing purposes only. 4800dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Applications should not use any of these parameters or the 4801dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_test_control()] interface. 4802dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 4803dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_TESTCTRL_PRNG_SAVE 5 4804dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_TESTCTRL_PRNG_RESTORE 6 4805dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_TESTCTRL_PRNG_RESET 7 4806dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_TESTCTRL_BITVEC_TEST 8 4807dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_TESTCTRL_FAULT_INSTALL 9 4808dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10 4809dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_TESTCTRL_PENDING_BYTE 11 4810dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 4811dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 4812dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: SQLite Runtime Status {H17200} <S60200> 4813dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 4814dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4815dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This interface is used to retrieve runtime status information 4816dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** about the preformance of SQLite, and optionally to reset various 4817dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** highwater marks. The first argument is an integer code for 4818dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the specific parameter to measure. Recognized integer codes 4819dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** are of the form [SQLITE_STATUS_MEMORY_USED | SQLITE_STATUS_...]. 4820dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The current value of the parameter is returned into *pCurrent. 4821dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The highest recorded value is returned in *pHighwater. If the 4822dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** resetFlag is true, then the highest record value is reset after 4823dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** *pHighwater is written. Some parameters do not record the highest 4824dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** value. For those parameters 4825dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** nothing is written into *pHighwater and the resetFlag is ignored. 4826dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Other parameters record only the highwater mark and not the current 4827dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** value. For these latter parameters nothing is written into *pCurrent. 4828dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4829dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This routine returns SQLITE_OK on success and a non-zero 4830dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [error code] on failure. 4831dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4832dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This routine is threadsafe but is not atomic. This routine can 4833dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** called while other threads are running the same or different SQLite 4834dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** interfaces. However the values returned in *pCurrent and 4835dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** *pHighwater reflect the status of SQLite at different points in time 4836dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and it is possible that another thread might change the parameter 4837dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** in between the times when *pCurrent and *pHighwater are written. 4838dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4839dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** See also: [sqlite3_db_status()] 4840dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 4841dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve BlockSQLITE_EXPERIMENTAL int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag); 4842dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 4843dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 4844dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 4845dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Status Parameters {H17250} <H17200> 4846dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 4847dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4848dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These integer constants designate various run-time status parameters 4849dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that can be returned by [sqlite3_status()]. 4850dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4851dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dl> 4852dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_STATUS_MEMORY_USED</dt> 4853dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This parameter is the current amount of memory checked out 4854dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** using [sqlite3_malloc()], either directly or indirectly. The 4855dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** figure includes calls made to [sqlite3_malloc()] by the application 4856dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and internal memory usage by the SQLite library. Scratch memory 4857dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache 4858dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in 4859dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** this parameter. The amount returned is the sum of the allocation 4860dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd> 4861dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4862dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_STATUS_MALLOC_SIZE</dt> 4863dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This parameter records the largest memory allocation request 4864dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their 4865dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** internal equivalents). Only the value returned in the 4866dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** *pHighwater parameter to [sqlite3_status()] is of interest. 4867dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The value written into the *pCurrent parameter is undefined.</dd> 4868dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4869dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_STATUS_PAGECACHE_USED</dt> 4870dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This parameter returns the number of pages used out of the 4871dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [pagecache memory allocator] that was configured using 4872dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_CONFIG_PAGECACHE]. The 4873dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** value returned is in pages, not in bytes.</dd> 4874dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4875dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt> 4876dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This parameter returns the number of bytes of page cache 4877dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** allocation which could not be statisfied by the [SQLITE_CONFIG_PAGECACHE] 4878dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** buffer and where forced to overflow to [sqlite3_malloc()]. The 4879dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** returned value includes allocations that overflowed because they 4880dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** where too large (they were larger than the "sz" parameter to 4881dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because 4882dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** no space was left in the page cache.</dd> 4883dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4884dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_STATUS_PAGECACHE_SIZE</dt> 4885dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This parameter records the largest memory allocation request 4886dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** handed to [pagecache memory allocator]. Only the value returned in the 4887dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** *pHighwater parameter to [sqlite3_status()] is of interest. 4888dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The value written into the *pCurrent parameter is undefined.</dd> 4889dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4890dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_STATUS_SCRATCH_USED</dt> 4891dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This parameter returns the number of allocations used out of the 4892dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [scratch memory allocator] configured using 4893dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not 4894dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** in bytes. Since a single thread may only have one scratch allocation 4895dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** outstanding at time, this parameter also reports the number of threads 4896dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** using scratch memory at the same time.</dd> 4897dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4898dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt> 4899dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This parameter returns the number of bytes of scratch memory 4900dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** allocation which could not be statisfied by the [SQLITE_CONFIG_SCRATCH] 4901dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** buffer and where forced to overflow to [sqlite3_malloc()]. The values 4902dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** returned include overflows because the requested allocation was too 4903dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** larger (that is, because the requested allocation was larger than the 4904dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer 4905dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** slots were available. 4906dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </dd> 4907dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4908dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_STATUS_SCRATCH_SIZE</dt> 4909dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This parameter records the largest memory allocation request 4910dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** handed to [scratch memory allocator]. Only the value returned in the 4911dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** *pHighwater parameter to [sqlite3_status()] is of interest. 4912dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The value written into the *pCurrent parameter is undefined.</dd> 4913dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4914dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_STATUS_PARSER_STACK</dt> 4915dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This parameter records the deepest parser stack. It is only 4916dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd> 4917dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </dl> 4918dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4919dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** New status parameters may be added from time to time. 4920dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 4921dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_STATUS_MEMORY_USED 0 4922dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_STATUS_PAGECACHE_USED 1 4923dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_STATUS_PAGECACHE_OVERFLOW 2 4924dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_STATUS_SCRATCH_USED 3 4925dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_STATUS_SCRATCH_OVERFLOW 4 4926dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_STATUS_MALLOC_SIZE 5 4927dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_STATUS_PARSER_STACK 6 4928dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_STATUS_PAGECACHE_SIZE 7 4929dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_STATUS_SCRATCH_SIZE 8 4930dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 4931dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 4932dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Database Connection Status {H17500} <S60200> 4933dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 4934dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4935dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This interface is used to retrieve runtime status information 4936dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** about a single [database connection]. The first argument is the 4937dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** database connection object to be interrogated. The second argument 4938dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is the parameter to interrogate. Currently, the only allowed value 4939dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for the second parameter is [SQLITE_DBSTATUS_LOOKASIDE_USED]. 4940dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Additional options will likely appear in future releases of SQLite. 4941dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4942dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The current value of the requested parameter is written into *pCur 4943dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and the highest instantaneous value is written into *pHiwtr. If 4944dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the resetFlg is true, then the highest instantaneous value is 4945dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** reset back down to the current value. 4946dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4947dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** See also: [sqlite3_status()] and [sqlite3_stmt_status()]. 4948dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 4949dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve BlockSQLITE_EXPERIMENTAL int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg); 4950dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 4951dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 4952dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Status Parameters for database connections {H17520} <H17500> 4953dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 4954dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4955dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Status verbs for [sqlite3_db_status()]. 4956dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4957dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dl> 4958dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt> 4959dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This parameter returns the number of lookaside memory slots currently 4960dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** checked out.</dd> 4961dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </dl> 4962dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 4963dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_DBSTATUS_LOOKASIDE_USED 0 4964dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 4965dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 4966dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 4967dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Prepared Statement Status {H17550} <S60200> 4968dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 4969dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4970dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Each prepared statement maintains various 4971dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_STMTSTATUS_SORT | counters] that measure the number 4972dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of times it has performed specific operations. These counters can 4973dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** be used to monitor the performance characteristics of the prepared 4974dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** statements. For example, if the number of table steps greatly exceeds 4975dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the number of table searches or result rows, that would tend to indicate 4976dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that the prepared statement is using a full table scan rather than 4977dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** an index. 4978dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4979dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This interface is used to retrieve and reset counter values from 4980dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a [prepared statement]. The first argument is the prepared statement 4981dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** object to be interrogated. The second argument 4982dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is an integer code for a specific [SQLITE_STMTSTATUS_SORT | counter] 4983dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to be interrogated. 4984dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The current value of the requested counter is returned. 4985dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the resetFlg is true, then the counter is reset to zero after this 4986dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** interface call returns. 4987dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4988dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** See also: [sqlite3_status()] and [sqlite3_db_status()]. 4989dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 4990dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve BlockSQLITE_EXPERIMENTAL int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg); 4991dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 4992dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 4993dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Status Parameters for prepared statements {H17570} <H17550> 4994dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 4995dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 4996dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** These preprocessor macros define integer codes that name counter 4997dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** values associated with the [sqlite3_stmt_status()] interface. 4998dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The meanings of the various counters are as follows: 4999dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5000dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dl> 5001dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt> 5002dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This is the number of times that SQLite has stepped forward in 5003dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a table as part of a full table scan. Large numbers for this counter 5004dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** may indicate opportunities for performance improvement through 5005dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** careful use of indices.</dd> 5006dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5007dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dt>SQLITE_STMTSTATUS_SORT</dt> 5008dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <dd>This is the number of sort operations that have occurred. 5009dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** A non-zero value in this counter may indicate an opportunity to 5010dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** improvement performance through careful use of indices.</dd> 5011dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5012dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </dl> 5013dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 5014dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_STMTSTATUS_FULLSCAN_STEP 1 5015dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block#define SQLITE_STMTSTATUS_SORT 2 5016dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 5017dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 5018dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Custom Page Cache Object 5019dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 5020dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5021dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_pcache type is opaque. It is implemented by 5022dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the pluggable module. The SQLite core has no knowledge of 5023dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** its size or internal structure and never deals with the 5024dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_pcache object except by holding and passing pointers 5025dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to the object. 5026dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5027dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** See [sqlite3_pcache_methods] for additional information. 5028dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 5029dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocktypedef struct sqlite3_pcache sqlite3_pcache; 5030dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 5031dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 5032dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Application Defined Page Cache. 5033dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 5034dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5035dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The [sqlite3_config]([SQLITE_CONFIG_PCACHE], ...) interface can 5036dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** register an alternative page cache implementation by passing in an 5037dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** instance of the sqlite3_pcache_methods structure. The majority of the 5038dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** heap memory used by sqlite is used by the page cache to cache data read 5039dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** from, or ready to be written to, the database file. By implementing a 5040dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** custom page cache using this API, an application can control more 5041dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** precisely the amount of memory consumed by sqlite, the way in which 5042dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** said memory is allocated and released, and the policies used to 5043dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** determine exactly which parts of a database file are cached and for 5044dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** how long. 5045dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5046dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The contents of the structure are copied to an internal buffer by sqlite 5047dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** within the call to [sqlite3_config]. 5048dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5049dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The xInit() method is called once for each call to [sqlite3_initialize()] 5050dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** (usually only once during the lifetime of the process). It is passed 5051dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a copy of the sqlite3_pcache_methods.pArg value. It can be used to set 5052dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** up global structures and mutexes required by the custom page cache 5053dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** implementation. The xShutdown() method is called from within 5054dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_shutdown()], if the application invokes this API. It can be used 5055dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to clean up any outstanding resources before process shutdown, if required. 5056dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5057dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The xCreate() method is used to construct a new cache instance. The 5058dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** first parameter, szPage, is the size in bytes of the pages that must 5059dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** be allocated by the cache. szPage will not be a power of two. The 5060dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** second argument, bPurgeable, is true if the cache being created will 5061dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** be used to cache database pages read from a file stored on disk, or 5062dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** false if it is used for an in-memory database. The cache implementation 5063dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** does not have to do anything special based on the value of bPurgeable, 5064dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** it is purely advisory. 5065dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5066dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The xCachesize() method may be called at any time by SQLite to set the 5067dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** suggested maximum cache-size (number of pages stored by) the cache 5068dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** instance passed as the first argument. This is the value configured using 5069dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the SQLite "[PRAGMA cache_size]" command. As with the bPurgeable parameter, 5070dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the implementation is not required to do anything special with this 5071dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** value, it is advisory only. 5072dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5073dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The xPagecount() method should return the number of pages currently 5074dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** stored in the cache supplied as an argument. 5075dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5076dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The xFetch() method is used to fetch a page and return a pointer to it. 5077dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** A 'page', in this context, is a buffer of szPage bytes aligned at an 5078dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 8-byte boundary. The page to be fetched is determined by the key. The 5079dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** mimimum key value is 1. After it has been retrieved using xFetch, the page 5080dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is considered to be pinned. 5081dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5082dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the requested page is already in the page cache, then a pointer to 5083dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the cached buffer should be returned with its contents intact. If the 5084dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** page is not already in the cache, then the expected behaviour of the 5085dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** cache is determined by the value of the createFlag parameter passed 5086dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to xFetch, according to the following table: 5087dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5088dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <table border=1 width=85% align=center> 5089dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <tr><th>createFlag<th>Expected Behaviour 5090dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <tr><td>0<td>NULL should be returned. No new cache entry is created. 5091dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <tr><td>1<td>If createFlag is set to 1, this indicates that 5092dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite is holding pinned pages that can be unpinned 5093dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** by writing their contents to the database file (a 5094dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** relatively expensive operation). In this situation the 5095dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** cache implementation has two choices: it can return NULL, 5096dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** in which case SQLite will attempt to unpin one or more 5097dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** pages before re-requesting the same page, or it can 5098dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** allocate a new page and return a pointer to it. If a new 5099dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** page is allocated, then the first sizeof(void*) bytes of 5100dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** it (at least) must be zeroed before it is returned. 5101dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <tr><td>2<td>If createFlag is set to 2, then SQLite is not holding any 5102dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** pinned pages associated with the specific cache passed 5103dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** as the first argument to xFetch() that can be unpinned. The 5104dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** cache implementation should attempt to allocate a new 5105dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** cache entry and return a pointer to it. Again, the first 5106dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sizeof(void*) bytes of the page should be zeroed before 5107dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** it is returned. If the xFetch() method returns NULL when 5108dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** createFlag==2, SQLite assumes that a memory allocation 5109dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** failed and returns SQLITE_NOMEM to the user. 5110dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </table> 5111dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5112dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** xUnpin() is called by SQLite with a pointer to a currently pinned page 5113dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** as its second argument. If the third parameter, discard, is non-zero, 5114dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** then the page should be evicted from the cache. In this case SQLite 5115dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** assumes that the next time the page is retrieved from the cache using 5116dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the xFetch() method, it will be zeroed. If the discard parameter is 5117dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** zero, then the page is considered to be unpinned. The cache implementation 5118dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** may choose to reclaim (free or recycle) unpinned pages at any time. 5119dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite assumes that next time the page is retrieved from the cache 5120dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** it will either be zeroed, or contain the same data that it did when it 5121dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** was unpinned. 5122dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5123dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The cache is not required to perform any reference counting. A single 5124dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** call to xUnpin() unpins the page regardless of the number of prior calls 5125dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to xFetch(). 5126dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5127dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The xRekey() method is used to change the key value associated with the 5128dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** page passed as the second argument from oldKey to newKey. If the cache 5129dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** previously contains an entry associated with newKey, it should be 5130dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** discarded. Any prior cache entry associated with newKey is guaranteed not 5131dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to be pinned. 5132dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5133dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** When SQLite calls the xTruncate() method, the cache must discard all 5134dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** existing cache entries with page numbers (keys) greater than or equal 5135dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to the value of the iLimit parameter passed to xTruncate(). If any 5136dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of these pages are pinned, they are implicitly unpinned, meaning that 5137dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** they can be safely discarded. 5138dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5139dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The xDestroy() method is used to delete a cache allocated by xCreate(). 5140dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** All resources associated with the specified cache should be freed. After 5141dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*] 5142dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** handle invalid, and will not use it with any other sqlite3_pcache_methods 5143dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** functions. 5144dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 5145dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocktypedef struct sqlite3_pcache_methods sqlite3_pcache_methods; 5146dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockstruct sqlite3_pcache_methods { 5147dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void *pArg; 5148dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xInit)(void*); 5149dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void (*xShutdown)(void*); 5150dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable); 5151dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void (*xCachesize)(sqlite3_pcache*, int nCachesize); 5152dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block int (*xPagecount)(sqlite3_pcache*); 5153dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); 5154dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void (*xUnpin)(sqlite3_pcache*, void*, int discard); 5155dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey); 5156dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); 5157dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void (*xDestroy)(sqlite3_pcache*); 5158dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block}; 5159dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 5160dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 5161dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Online Backup Object 5162dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 5163dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5164dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The sqlite3_backup object records state information about an ongoing 5165dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** online backup operation. The sqlite3_backup object is created by 5166dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a call to [sqlite3_backup_init()] and is destroyed by a call to 5167dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_backup_finish()]. 5168dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5169dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** See Also: [Using the SQLite Online Backup API] 5170dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 5171dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocktypedef struct sqlite3_backup sqlite3_backup; 5172dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 5173dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 5174dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Online Backup API. 5175dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 5176dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5177dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This API is used to overwrite the contents of one database with that 5178dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** of another. It is useful either for creating backups of databases or 5179dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for copying in-memory databases to or from persistent files. 5180dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5181dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** See Also: [Using the SQLite Online Backup API] 5182dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5183dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Exclusive access is required to the destination database for the 5184dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** duration of the operation. However the source database is only 5185dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** read-locked while it is actually being read, it is not locked 5186dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** continuously for the entire operation. Thus, the backup may be 5187dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** performed on a live database without preventing other users from 5188dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** writing to the database for an extended period of time. 5189dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5190dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** To perform a backup operation: 5191dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <ol> 5192dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li><b>sqlite3_backup_init()</b> is called once to initialize the 5193dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** backup, 5194dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer 5195dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the data between the two databases, and finally 5196dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <li><b>sqlite3_backup_finish()</b> is called to release all resources 5197dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** associated with the backup operation. 5198dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** </ol> 5199dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** There should be exactly one call to sqlite3_backup_finish() for each 5200dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** successful call to sqlite3_backup_init(). 5201dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5202dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <b>sqlite3_backup_init()</b> 5203dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5204dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The first two arguments passed to [sqlite3_backup_init()] are the database 5205dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** handle associated with the destination database and the database name 5206dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** used to attach the destination database to the handle. The database name 5207dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is "main" for the main database, "temp" for the temporary database, or 5208dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the name specified as part of the [ATTACH] statement if the destination is 5209dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** an attached database. The third and fourth arguments passed to 5210dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_backup_init() identify the [database connection] 5211dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and database name used 5212dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to access the source database. The values passed for the source and 5213dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** destination [database connection] parameters must not be the same. 5214dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5215dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If an error occurs within sqlite3_backup_init(), then NULL is returned 5216dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and an error code and error message written into the [database connection] 5217dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** passed as the first argument. They may be retrieved using the 5218dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [sqlite3_errcode()], [sqlite3_errmsg()], and [sqlite3_errmsg16()] functions. 5219dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Otherwise, if successful, a pointer to an [sqlite3_backup] object is 5220dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** returned. This pointer may be used with the sqlite3_backup_step() and 5221dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_backup_finish() functions to perform the specified backup 5222dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** operation. 5223dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5224dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <b>sqlite3_backup_step()</b> 5225dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5226dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Function [sqlite3_backup_step()] is used to copy up to nPage pages between 5227dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the source and destination databases, where nPage is the value of the 5228dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** second parameter passed to sqlite3_backup_step(). If nPage is a negative 5229dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** value, all remaining source pages are copied. If the required pages are 5230dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** succesfully copied, but there are still more pages to copy before the 5231dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** backup is complete, it returns [SQLITE_OK]. If no error occured and there 5232dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** are no more pages to copy, then [SQLITE_DONE] is returned. If an error 5233dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** occurs, then an SQLite error code is returned. As well as [SQLITE_OK] and 5234dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY], 5235dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an 5236dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code. 5237dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5238dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** As well as the case where the destination database file was opened for 5239dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** read-only access, sqlite3_backup_step() may return [SQLITE_READONLY] if 5240dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the destination is an in-memory database with a different page size 5241dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** from the source database. 5242dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5243dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If sqlite3_backup_step() cannot obtain a required file-system lock, then 5244dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the [sqlite3_busy_handler | busy-handler function] 5245dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is invoked (if one is specified). If the 5246dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** busy-handler returns non-zero before the lock is available, then 5247dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_BUSY] is returned to the caller. In this case the call to 5248dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_backup_step() can be retried later. If the source 5249dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [database connection] 5250dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is being used to write to the source database when sqlite3_backup_step() 5251dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is called, then [SQLITE_LOCKED] is returned immediately. Again, in this 5252dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** case the call to sqlite3_backup_step() can be retried later on. If 5253dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or 5254dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_READONLY] is returned, then 5255dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** there is no point in retrying the call to sqlite3_backup_step(). These 5256dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** errors are considered fatal. At this point the application must accept 5257dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that the backup operation has failed and pass the backup operation handle 5258dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** to the sqlite3_backup_finish() to release associated resources. 5259dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5260dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Following the first call to sqlite3_backup_step(), an exclusive lock is 5261dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** obtained on the destination file. It is not released until either 5262dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_backup_finish() is called or the backup operation is complete 5263dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and sqlite3_backup_step() returns [SQLITE_DONE]. Additionally, each time 5264dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a call to sqlite3_backup_step() is made a [shared lock] is obtained on 5265dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the source database file. This lock is released before the 5266dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_backup_step() call returns. Because the source database is not 5267dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** locked between calls to sqlite3_backup_step(), it may be modified mid-way 5268dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** through the backup procedure. If the source database is modified by an 5269dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** external process or via a database connection other than the one being 5270dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** used by the backup operation, then the backup will be transparently 5271dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** restarted by the next call to sqlite3_backup_step(). If the source 5272dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** database is modified by the using the same database connection as is used 5273dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** by the backup operation, then the backup database is transparently 5274dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** updated at the same time. 5275dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5276dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <b>sqlite3_backup_finish()</b> 5277dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5278dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Once sqlite3_backup_step() has returned [SQLITE_DONE], or when the 5279dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** application wishes to abandon the backup operation, the [sqlite3_backup] 5280dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** object should be passed to sqlite3_backup_finish(). This releases all 5281dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** resources associated with the backup operation. If sqlite3_backup_step() 5282dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** has not yet returned [SQLITE_DONE], then any active write-transaction on the 5283dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** destination database is rolled back. The [sqlite3_backup] object is invalid 5284dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and may not be used following a call to sqlite3_backup_finish(). 5285dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5286dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The value returned by sqlite3_backup_finish is [SQLITE_OK] if no error 5287dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** occurred, regardless or whether or not sqlite3_backup_step() was called 5288dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a sufficient number of times to complete the backup operation. Or, if 5289dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** an out-of-memory condition or IO error occured during a call to 5290dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_backup_step() then [SQLITE_NOMEM] or an 5291dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] error code 5292dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is returned. In this case the error code and an error message are 5293dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** written to the destination [database connection]. 5294dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5295dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step() is 5296dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** not a permanent error and does not affect the return value of 5297dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_backup_finish(). 5298dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5299dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <b>sqlite3_backup_remaining(), sqlite3_backup_pagecount()</b> 5300dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5301dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Each call to sqlite3_backup_step() sets two values stored internally 5302dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** by an [sqlite3_backup] object. The number of pages still to be backed 5303dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** up, which may be queried by sqlite3_backup_remaining(), and the total 5304dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** number of pages in the source database file, which may be queried by 5305dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_backup_pagecount(). 5306dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5307dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The values returned by these functions are only updated by 5308dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_backup_step(). If the source database is modified during a backup 5309dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** operation, then the values are not updated to account for any extra 5310dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** pages that need to be updated or the size of the source database file 5311dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** changing. 5312dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5313dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <b>Concurrent Usage of Database Handles</b> 5314dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5315dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The source [database connection] may be used by the application for other 5316dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** purposes while a backup operation is underway or being initialized. 5317dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If SQLite is compiled and configured to support threadsafe database 5318dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** connections, then the source database connection may be used concurrently 5319dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** from within other threads. 5320dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5321dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** However, the application must guarantee that the destination database 5322dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** connection handle is not passed to any other API (by any thread) after 5323dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_backup_init() is called and before the corresponding call to 5324dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_backup_finish(). Unfortunately SQLite does not currently check 5325dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for this, if the application does use the destination [database connection] 5326dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** for some other purpose during a backup operation, things may appear to 5327dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** work correctly but in fact be subtly malfunctioning. Use of the 5328dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** destination database connection while a backup is in progress might 5329dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** also cause a mutex deadlock. 5330dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5331dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Furthermore, if running in [shared cache mode], the application must 5332dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** guarantee that the shared cache used by the destination database 5333dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** is not accessed while the backup is running. In practice this means 5334dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that the application must guarantee that the file-system file being 5335dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** backed up to is not accessed by any connection within the process, 5336dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** not just the specific connection that was passed to sqlite3_backup_init(). 5337dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5338dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The [sqlite3_backup] object itself is partially threadsafe. Multiple 5339dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** threads may safely make multiple concurrent calls to sqlite3_backup_step(). 5340dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount() 5341dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** APIs are not strictly speaking threadsafe. If they are invoked at the 5342dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** same time as another thread is invoking sqlite3_backup_step() it is 5343dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** possible that they return invalid values. 5344dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 5345dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blocksqlite3_backup *sqlite3_backup_init( 5346dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block sqlite3 *pDest, /* Destination database handle */ 5347dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block const char *zDestName, /* Destination database name */ 5348dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block sqlite3 *pSource, /* Source database handle */ 5349dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block const char *zSourceName /* Source database name */ 5350dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block); 5351dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_backup_step(sqlite3_backup *p, int nPage); 5352dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_backup_finish(sqlite3_backup *p); 5353dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_backup_remaining(sqlite3_backup *p); 5354dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_backup_pagecount(sqlite3_backup *p); 5355dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block 5356dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block/* 5357dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** CAPI3REF: Unlock Notification 5358dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** EXPERIMENTAL 5359dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5360dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** When running in shared-cache mode, a database operation may fail with 5361dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** an [SQLITE_LOCKED] error if the required locks on the shared-cache or 5362dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** individual tables within the shared-cache cannot be obtained. See 5363dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLite Shared-Cache Mode] for a description of shared-cache locking. 5364dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This API may be used to register a callback that SQLite will invoke 5365dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** when the connection currently holding the required lock relinquishes it. 5366dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This API is only available if the library was compiled with the 5367dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined. 5368dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5369dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** See Also: [Using the SQLite Unlock Notification Feature]. 5370dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5371dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Shared-cache locks are released when a database connection concludes 5372dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** its current transaction, either by committing it or rolling it back. 5373dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5374dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** When a connection (known as the blocked connection) fails to obtain a 5375dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** shared-cache lock and SQLITE_LOCKED is returned to the caller, the 5376dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** identity of the database connection (the blocking connection) that 5377dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** has locked the required resource is stored internally. After an 5378dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** application receives an SQLITE_LOCKED error, it may call the 5379dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_unlock_notify() method with the blocked connection handle as 5380dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the first argument to register for a callback that will be invoked 5381dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** when the blocking connections current transaction is concluded. The 5382dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** callback is invoked from within the [sqlite3_step] or [sqlite3_close] 5383dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** call that concludes the blocking connections transaction. 5384dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5385dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If sqlite3_unlock_notify() is called in a multi-threaded application, 5386dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** there is a chance that the blocking connection will have already 5387dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** concluded its transaction by the time sqlite3_unlock_notify() is invoked. 5388dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If this happens, then the specified callback is invoked immediately, 5389dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** from within the call to sqlite3_unlock_notify(). 5390dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5391dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** If the blocked connection is attempting to obtain a write-lock on a 5392dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** shared-cache table, and more than one other connection currently holds 5393dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a read-lock on the same table, then SQLite arbitrarily selects one of 5394dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the other connections to use as the blocking connection. 5395dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5396dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** There may be at most one unlock-notify callback registered by a 5397dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** blocked connection. If sqlite3_unlock_notify() is called when the 5398dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** blocked connection already has a registered unlock-notify callback, 5399dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** then the new callback replaces the old. If sqlite3_unlock_notify() is 5400dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** called with a NULL pointer as its second argument, then any existing 5401dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** unlock-notify callback is cancelled. The blocked connections 5402dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** unlock-notify callback may also be canceled by closing the blocked 5403dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** connection using [sqlite3_close()]. 5404dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5405dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** The unlock-notify callback is not reentrant. If an application invokes 5406dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** any sqlite3_xxx API functions from within an unlock-notify callback, a 5407dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** crash or deadlock may be the result. 5408dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5409dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Unless deadlock is detected (see below), sqlite3_unlock_notify() always 5410dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** returns SQLITE_OK. 5411dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5412dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <b>Callback Invocation Details</b> 5413dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5414dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** When an unlock-notify callback is registered, the application provides a 5415dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** single void* pointer that is passed to the callback when it is invoked. 5416dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** However, the signature of the callback function allows SQLite to pass 5417dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** it an array of void* context pointers. The first argument passed to 5418dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** an unlock-notify callback is a pointer to an array of void* pointers, 5419dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** and the second is the number of entries in the array. 5420dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5421dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** When a blocking connections transaction is concluded, there may be 5422dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** more than one blocked connection that has registered for an unlock-notify 5423dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** callback. If two or more such blocked connections have specified the 5424dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** same callback function, then instead of invoking the callback function 5425dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** multiple times, it is invoked once with the set of void* context pointers 5426dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** specified by the blocked connections bundled together into an array. 5427dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** This gives the application an opportunity to prioritize any actions 5428dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** related to the set of unblocked database connections. 5429dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5430dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <b>Deadlock Detection</b> 5431dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5432dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Assuming that after registering for an unlock-notify callback a 5433dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** database waits for the callback to be issued before taking any further 5434dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** action (a reasonable assumption), then using this API may cause the 5435dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** application to deadlock. For example, if connection X is waiting for 5436dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** connection Y's transaction to be concluded, and similarly connection 5437dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** Y is waiting on connection X's transaction, then neither connection 5438dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** will proceed and the system may remain deadlocked indefinitely. 5439dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5440dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock 5441dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** detection. If a given call to sqlite3_unlock_notify() would put the 5442dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** system in a deadlocked state, then SQLITE_LOCKED is returned and no 5443dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** unlock-notify callback is registered. The system is said to be in 5444dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** a deadlocked state if connection A has registered for an unlock-notify 5445dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** callback on the conclusion of connection B's transaction, and connection 5446dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** B has itself registered for an unlock-notify callback when connection 5447dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** A's transaction is concluded. Indirect deadlock is also detected, so 5448dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the system is also considered to be deadlocked if connection B has 5449dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** registered for an unlock-notify callback on the conclusion of connection 5450dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** C's transaction, where connection C is waiting on connection A. Any 5451dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** number of levels of indirection are allowed. 5452dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5453dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** <b>The "DROP TABLE" Exception</b> 5454dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5455dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost 5456dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** always appropriate to call sqlite3_unlock_notify(). There is however, 5457dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement, 5458dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLite checks if there are any currently executing SELECT statements 5459dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** that belong to the same connection. If there are, SQLITE_LOCKED is 5460dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** returned. In this case there is no "blocking connection", so invoking 5461dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** sqlite3_unlock_notify() results in the unlock-notify callback being 5462dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** invoked immediately. If the application then re-attempts the "DROP TABLE" 5463dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** or "DROP INDEX" query, an infinite loop might be the result. 5464dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** 5465dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** One way around this problem is to check the extended error code returned 5466dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** by an sqlite3_step() call. If there is a blocking connection, then the 5467dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in 5468dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** the special "DROP TABLE/INDEX" case, the extended error code is just 5469dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block** SQLITE_LOCKED. 5470dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block*/ 5471dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Blockint sqlite3_unlock_notify( 5472dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block sqlite3 *pBlocked, /* Waiting connection */ 5473dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */ 5474dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block void *pNotifyArg /* Argument to pass to xNotify */ 5475dcc8cf2e65d1aa555cce12431a16547e66b469eeSteve Block); 5476563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 5477563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark/* 5478563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** Undo the hack that converts floating point types to integer for 5479563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark** builds on processors without floating point support. 5480563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark*/ 5481563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#ifdef SQLITE_OMIT_FLOATING_POINT 5482563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark# undef double 5483563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#endif 5484563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark 5485563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#ifdef __cplusplus 5486563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark} /* End of the 'extern "C"' block */ 5487563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#endif 5488563af33bc48281d19dce701398dbb88cb54fd7ecCary Clark#endif 5489