blob: 874364c12720bf5a1fced74065bf96399e60827a [file] [log] [blame]
drh75897232000-05-29 14:26:00 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drh75897232000-05-29 14:26:00 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drh75897232000-05-29 14:26:00 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
drh75897232000-05-29 14:26:00 +000010**
11*************************************************************************
drhb19a2bc2001-09-16 00:13:26 +000012** This header file defines the interface that the SQLite library
drh6ed48bf2007-06-14 20:57:18 +000013** presents to client programs. If a C-function, structure, datatype,
14** or constant definition does not appear in this file, then it is
15** not a published API of SQLite, is subject to change without
16** notice, and should not be referenced by programs that use SQLite.
drh75897232000-05-29 14:26:00 +000017**
drh6ed48bf2007-06-14 20:57:18 +000018** Some of the definitions that are in this file are marked as
19** "experimental". Experimental interfaces are normally new
mihailima3f64902008-06-21 13:35:56 +000020** features recently added to SQLite. We do not anticipate changes
shane7c7c3112009-08-17 15:31:23 +000021** to experimental interfaces but reserve the right to make minor changes
22** if experience from use "in the wild" suggest such changes are prudent.
drh6ed48bf2007-06-14 20:57:18 +000023**
24** The official C-language API documentation for SQLite is derived
25** from comments in this file. This file is the authoritative source
26** on how SQLite interfaces are suppose to operate.
27**
28** The name of this file under configuration management is "sqlite.h.in".
29** The makefile makes some minor changes to this file (such as inserting
30** the version number) and changes its name to "sqlite3.h" as
31** part of the build process.
drh75897232000-05-29 14:26:00 +000032*/
drh12057d52004-09-06 17:34:12 +000033#ifndef _SQLITE3_H_
34#define _SQLITE3_H_
drha18c5682000-10-08 22:20:57 +000035#include <stdarg.h> /* Needed for the definition of va_list */
drh75897232000-05-29 14:26:00 +000036
37/*
drh382c0242001-10-06 16:33:02 +000038** Make sure we can call this stuff from C++.
39*/
40#ifdef __cplusplus
41extern "C" {
42#endif
43
drh6d2069d2007-08-14 01:58:53 +000044
drh382c0242001-10-06 16:33:02 +000045/*
drh73be5012007-08-08 12:11:21 +000046** Add the ability to override 'extern'
47*/
48#ifndef SQLITE_EXTERN
49# define SQLITE_EXTERN extern
50#endif
51
52/*
drh4d6618f2008-09-22 17:54:46 +000053** These no-op macros are used in front of interfaces to mark those
54** interfaces as either deprecated or experimental. New applications
shane7c7c3112009-08-17 15:31:23 +000055** should not use deprecated interfaces - they are support for backwards
drh4d6618f2008-09-22 17:54:46 +000056** compatibility only. Application writers should be aware that
57** experimental interfaces are subject to change in point releases.
58**
59** These macros used to resolve to various kinds of compiler magic that
60** would generate warning messages when they were used. But that
61** compiler magic ended up generating such a flurry of bug reports
62** that we have taken it all out and gone back to using simple
63** noop macros.
shanea79c3cc2008-08-11 17:27:01 +000064*/
drh4d6618f2008-09-22 17:54:46 +000065#define SQLITE_DEPRECATED
66#define SQLITE_EXPERIMENTAL
shanea79c3cc2008-08-11 17:27:01 +000067
68/*
mihailim362cc832008-06-21 06:16:42 +000069** Ensure these symbols were not defined by some previous header file.
drhb86ccfb2003-01-28 23:13:10 +000070*/
drh1e284f42004-10-06 15:52:01 +000071#ifdef SQLITE_VERSION
72# undef SQLITE_VERSION
drh1e284f42004-10-06 15:52:01 +000073#endif
drh6ed48bf2007-06-14 20:57:18 +000074#ifdef SQLITE_VERSION_NUMBER
75# undef SQLITE_VERSION_NUMBER
76#endif
danielk197799ba19e2005-02-05 07:33:34 +000077
78/*
drhb25f9d82008-07-23 15:40:06 +000079** CAPI3REF: Compile-Time Library Version Numbers {H10010} <S60100>
drh6ed48bf2007-06-14 20:57:18 +000080**
drh33c1be32008-01-30 16:16:14 +000081** The SQLITE_VERSION and SQLITE_VERSION_NUMBER #defines in
82** the sqlite3.h file specify the version of SQLite with which
83** that header file is associated.
danielk197799ba19e2005-02-05 07:33:34 +000084**
drh7663e362008-02-14 23:24:16 +000085** The "version" of SQLite is a string of the form "X.Y.Z".
drh33c1be32008-01-30 16:16:14 +000086** The phrase "alpha" or "beta" might be appended after the Z.
87** The X value is major version number always 3 in SQLite3.
mihailim362cc832008-06-21 06:16:42 +000088** The X value only changes when backwards compatibility is
89** broken and we intend to never break backwards compatibility.
90** The Y value is the minor version number and only changes when
drh6ed48bf2007-06-14 20:57:18 +000091** there are major feature enhancements that are forwards compatible
mihailim362cc832008-06-21 06:16:42 +000092** but not backwards compatible.
93** The Z value is the release number and is incremented with
94** each release but resets back to 0 whenever Y is incremented.
drh6ed48bf2007-06-14 20:57:18 +000095**
drh47baebc2009-08-14 16:01:24 +000096** Since version 3.6.18, SQLite source code has been stored in the
97** "fossil" configuration management system. The SQLITE_SOURCE_ID
98** macro is a string which identifies a particular check-in of SQLite
99** within its configuration management system. The string contains the
100** date and time of the check-in (UTC) and an SHA1 hash of the entire
101** source tree.
102**
drh6ed48bf2007-06-14 20:57:18 +0000103** See also: [sqlite3_libversion()] and [sqlite3_libversion_number()].
drh33c1be32008-01-30 16:16:14 +0000104**
drh8b39db12009-02-18 18:37:58 +0000105** Requirements: [H10011] [H10014]
danielk197799ba19e2005-02-05 07:33:34 +0000106*/
drh47baebc2009-08-14 16:01:24 +0000107#define SQLITE_VERSION "--VERS--"
108#define SQLITE_VERSION_NUMBER --VERSION-NUMBER--
109#define SQLITE_SOURCE_ID "--SOURCE-ID--"
drhb86ccfb2003-01-28 23:13:10 +0000110
111/*
drh9a247912008-07-22 18:45:08 +0000112** CAPI3REF: Run-Time Library Version Numbers {H10020} <S60100>
drh33c1be32008-01-30 16:16:14 +0000113** KEYWORDS: sqlite3_version
drh6ed48bf2007-06-14 20:57:18 +0000114**
drh47baebc2009-08-14 16:01:24 +0000115** These interfaces provide the same information as the [SQLITE_VERSION],
116** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] #defines in the header,
117** but are associated with the library instead of the header file. Cautious
118** programmers might include a check in their application to verify that
mihailim362cc832008-06-21 06:16:42 +0000119** sqlite3_libversion_number() always returns the value
drhfddfa2d2007-12-05 18:05:16 +0000120** [SQLITE_VERSION_NUMBER].
drh6ed48bf2007-06-14 20:57:18 +0000121**
drh33c1be32008-01-30 16:16:14 +0000122** The sqlite3_libversion() function returns the same information as is
123** in the sqlite3_version[] string constant. The function is provided
124** for use in DLLs since DLL users usually do not have direct access to string
drh47baebc2009-08-14 16:01:24 +0000125** constants within the DLL. Similarly, the sqlite3_sourceid() function
126** returns the same information as is in the [SQLITE_SOURCE_ID] #define of
127** the header file.
drh33c1be32008-01-30 16:16:14 +0000128**
drh8b39db12009-02-18 18:37:58 +0000129** Requirements: [H10021] [H10022] [H10023]
drhb217a572000-08-22 13:40:18 +0000130*/
drh73be5012007-08-08 12:11:21 +0000131SQLITE_EXTERN const char sqlite3_version[];
drha3f70cb2004-09-30 14:24:50 +0000132const char *sqlite3_libversion(void);
drh47baebc2009-08-14 16:01:24 +0000133const char *sqlite3_sourceid(void);
danielk197799ba19e2005-02-05 07:33:34 +0000134int sqlite3_libversion_number(void);
135
136/*
drh9a247912008-07-22 18:45:08 +0000137** CAPI3REF: Test To See If The Library Is Threadsafe {H10100} <S60100>
drhb67e8bf2007-08-30 20:09:48 +0000138**
drh33c1be32008-01-30 16:16:14 +0000139** SQLite can be compiled with or without mutexes. When
drhafacce02008-09-02 21:35:03 +0000140** the [SQLITE_THREADSAFE] C preprocessor macro 1 or 2, mutexes
141** are enabled and SQLite is threadsafe. When the
142** [SQLITE_THREADSAFE] macro is 0,
drh33c1be32008-01-30 16:16:14 +0000143** the mutexes are omitted. Without the mutexes, it is not safe
mihailim362cc832008-06-21 06:16:42 +0000144** to use SQLite concurrently from more than one thread.
drhb67e8bf2007-08-30 20:09:48 +0000145**
mihailim362cc832008-06-21 06:16:42 +0000146** Enabling mutexes incurs a measurable performance penalty.
drh33c1be32008-01-30 16:16:14 +0000147** So if speed is of utmost importance, it makes sense to disable
148** the mutexes. But for maximum safety, mutexes should be enabled.
149** The default behavior is for mutexes to be enabled.
150**
151** This interface can be used by a program to make sure that the
152** version of SQLite that it is linking against was compiled with
drh4766b292008-06-26 02:53:02 +0000153** the desired setting of the [SQLITE_THREADSAFE] macro.
154**
155** This interface only reports on the compile-time mutex setting
156** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with
157** SQLITE_THREADSAFE=1 then mutexes are enabled by default but
158** can be fully or partially disabled using a call to [sqlite3_config()]
159** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD],
160** or [SQLITE_CONFIG_MUTEX]. The return value of this function shows
161** only the default compile-time setting, not any run-time changes
162** to that setting.
drh33c1be32008-01-30 16:16:14 +0000163**
drhafacce02008-09-02 21:35:03 +0000164** See the [threading mode] documentation for additional information.
165**
drh8b39db12009-02-18 18:37:58 +0000166** Requirements: [H10101] [H10102]
drhb67e8bf2007-08-30 20:09:48 +0000167*/
168int sqlite3_threadsafe(void);
169
170/*
drh9cd29642008-07-23 00:52:55 +0000171** CAPI3REF: Database Connection Handle {H12000} <S40200>
drha06f17f2008-05-11 11:07:06 +0000172** KEYWORDS: {database connection} {database connections}
drh6ed48bf2007-06-14 20:57:18 +0000173**
mihailim362cc832008-06-21 06:16:42 +0000174** Each open SQLite database is represented by a pointer to an instance of
175** the opaque structure named "sqlite3". It is useful to think of an sqlite3
drh8bacf972007-08-25 16:21:29 +0000176** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and
mihailim362cc832008-06-21 06:16:42 +0000177** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()]
178** is its destructor. There are many other interfaces (such as
179** [sqlite3_prepare_v2()], [sqlite3_create_function()], and
180** [sqlite3_busy_timeout()] to name but three) that are methods on an
181** sqlite3 object.
drh75897232000-05-29 14:26:00 +0000182*/
drh9bb575f2004-09-06 17:24:11 +0000183typedef struct sqlite3 sqlite3;
danielk197765904932004-05-26 06:18:37 +0000184
drh75897232000-05-29 14:26:00 +0000185/*
drh9cd29642008-07-23 00:52:55 +0000186** CAPI3REF: 64-Bit Integer Types {H10200} <S10110>
drh33c1be32008-01-30 16:16:14 +0000187** KEYWORDS: sqlite_int64 sqlite_uint64
drh6ed48bf2007-06-14 20:57:18 +0000188**
drh33c1be32008-01-30 16:16:14 +0000189** Because there is no cross-platform way to specify 64-bit integer types
drhfddfa2d2007-12-05 18:05:16 +0000190** SQLite includes typedefs for 64-bit signed and unsigned integers.
drh6ed48bf2007-06-14 20:57:18 +0000191**
mihailim362cc832008-06-21 06:16:42 +0000192** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions.
193** The sqlite_int64 and sqlite_uint64 types are supported for backwards
194** compatibility only.
drh33c1be32008-01-30 16:16:14 +0000195**
drh8b39db12009-02-18 18:37:58 +0000196** Requirements: [H10201] [H10202]
drhefad9992004-06-22 12:13:55 +0000197*/
drh27436af2006-03-28 23:57:17 +0000198#ifdef SQLITE_INT64_TYPE
drh9b8f4472006-04-04 01:54:55 +0000199 typedef SQLITE_INT64_TYPE sqlite_int64;
drh27436af2006-03-28 23:57:17 +0000200 typedef unsigned SQLITE_INT64_TYPE sqlite_uint64;
201#elif defined(_MSC_VER) || defined(__BORLANDC__)
drhefad9992004-06-22 12:13:55 +0000202 typedef __int64 sqlite_int64;
drh1211de32004-07-26 12:24:22 +0000203 typedef unsigned __int64 sqlite_uint64;
drhefad9992004-06-22 12:13:55 +0000204#else
205 typedef long long int sqlite_int64;
drh1211de32004-07-26 12:24:22 +0000206 typedef unsigned long long int sqlite_uint64;
drhefad9992004-06-22 12:13:55 +0000207#endif
drh6d2069d2007-08-14 01:58:53 +0000208typedef sqlite_int64 sqlite3_int64;
209typedef sqlite_uint64 sqlite3_uint64;
drhefad9992004-06-22 12:13:55 +0000210
drhb37df7b2005-10-13 02:09:49 +0000211/*
212** If compiling for a processor that lacks floating point support,
mihailim362cc832008-06-21 06:16:42 +0000213** substitute integer for floating-point.
drhb37df7b2005-10-13 02:09:49 +0000214*/
215#ifdef SQLITE_OMIT_FLOATING_POINT
drh6d2069d2007-08-14 01:58:53 +0000216# define double sqlite3_int64
drhb37df7b2005-10-13 02:09:49 +0000217#endif
drhefad9992004-06-22 12:13:55 +0000218
219/*
drh9cd29642008-07-23 00:52:55 +0000220** CAPI3REF: Closing A Database Connection {H12010} <S30100><S40200>
drh75897232000-05-29 14:26:00 +0000221**
mihailim362cc832008-06-21 06:16:42 +0000222** This routine is the destructor for the [sqlite3] object.
drh33c1be32008-01-30 16:16:14 +0000223**
mihailim362cc832008-06-21 06:16:42 +0000224** Applications should [sqlite3_finalize | finalize] all [prepared statements]
mihailim15194222008-06-22 09:55:14 +0000225** and [sqlite3_blob_close | close] all [BLOB handles] associated with
mihailim362cc832008-06-21 06:16:42 +0000226** the [sqlite3] object prior to attempting to close the object.
227** The [sqlite3_next_stmt()] interface can be used to locate all
228** [prepared statements] associated with a [database connection] if desired.
229** Typical code might look like this:
drh33c1be32008-01-30 16:16:14 +0000230**
drh55b0cf02008-06-19 17:54:33 +0000231** <blockquote><pre>
232** sqlite3_stmt *pStmt;
233** while( (pStmt = sqlite3_next_stmt(db, 0))!=0 ){
234** &nbsp; sqlite3_finalize(pStmt);
235** }
236** </pre></blockquote>
237**
mihailim362cc832008-06-21 06:16:42 +0000238** If [sqlite3_close()] is invoked while a transaction is open,
drh55b0cf02008-06-19 17:54:33 +0000239** the transaction is automatically rolled back.
drh33c1be32008-01-30 16:16:14 +0000240**
drh8b39db12009-02-18 18:37:58 +0000241** The C parameter to [sqlite3_close(C)] must be either a NULL
242** pointer or an [sqlite3] object pointer obtained
243** from [sqlite3_open()], [sqlite3_open16()], or
244** [sqlite3_open_v2()], and not previously closed.
drh33c1be32008-01-30 16:16:14 +0000245**
drh8b39db12009-02-18 18:37:58 +0000246** Requirements:
247** [H12011] [H12012] [H12013] [H12014] [H12015] [H12019]
drh75897232000-05-29 14:26:00 +0000248*/
danielk1977f9d64d22004-06-19 08:18:07 +0000249int sqlite3_close(sqlite3 *);
drh75897232000-05-29 14:26:00 +0000250
251/*
252** The type for a callback function.
drh6ed48bf2007-06-14 20:57:18 +0000253** This is legacy and deprecated. It is included for historical
254** compatibility and is not documented.
drh75897232000-05-29 14:26:00 +0000255*/
drh12057d52004-09-06 17:34:12 +0000256typedef int (*sqlite3_callback)(void*,int,char**, char**);
drh75897232000-05-29 14:26:00 +0000257
258/*
drh9cd29642008-07-23 00:52:55 +0000259** CAPI3REF: One-Step Query Execution Interface {H12100} <S10000>
drh6ed48bf2007-06-14 20:57:18 +0000260**
mihailim362cc832008-06-21 06:16:42 +0000261** The sqlite3_exec() interface is a convenient way of running one or more
262** SQL statements without having to write a lot of C code. The UTF-8 encoded
263** SQL statements are passed in as the second parameter to sqlite3_exec().
264** The statements are evaluated one by one until either an error or
265** an interrupt is encountered, or until they are all done. The 3rd parameter
266** is an optional callback that is invoked once for each row of any query
267** results produced by the SQL statements. The 5th parameter tells where
drh33c1be32008-01-30 16:16:14 +0000268** to write any error messages.
drh75897232000-05-29 14:26:00 +0000269**
drh35c61902008-05-20 15:44:30 +0000270** The error message passed back through the 5th parameter is held
271** in memory obtained from [sqlite3_malloc()]. To avoid a memory leak,
272** the calling application should call [sqlite3_free()] on any error
273** message returned through the 5th parameter when it has finished using
274** the error message.
275**
276** If the SQL statement in the 2nd parameter is NULL or an empty string
mihailim362cc832008-06-21 06:16:42 +0000277** or a string containing only whitespace and comments, then no SQL
278** statements are evaluated and the database is not changed.
drh35c61902008-05-20 15:44:30 +0000279**
drh33c1be32008-01-30 16:16:14 +0000280** The sqlite3_exec() interface is implemented in terms of
281** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()].
drh35c61902008-05-20 15:44:30 +0000282** The sqlite3_exec() routine does nothing to the database that cannot be done
drh33c1be32008-01-30 16:16:14 +0000283** by [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()].
drh75897232000-05-29 14:26:00 +0000284**
drh8b39db12009-02-18 18:37:58 +0000285** The first parameter to [sqlite3_exec()] must be an valid and open
286** [database connection].
mihailima3f64902008-06-21 13:35:56 +0000287**
drh8b39db12009-02-18 18:37:58 +0000288** The database connection must not be closed while
289** [sqlite3_exec()] is running.
drh75897232000-05-29 14:26:00 +0000290**
drh8b39db12009-02-18 18:37:58 +0000291** The calling function should use [sqlite3_free()] to free
292** the memory that *errmsg is left pointing at once the error
293** message is no longer needed.
drh75897232000-05-29 14:26:00 +0000294**
drh8b39db12009-02-18 18:37:58 +0000295** The SQL statement text in the 2nd parameter to [sqlite3_exec()]
296** must remain unchanged while [sqlite3_exec()] is running.
drhf50bebf2008-05-19 23:51:55 +0000297**
drh8b39db12009-02-18 18:37:58 +0000298** Requirements:
299** [H12101] [H12102] [H12104] [H12105] [H12107] [H12110] [H12113] [H12116]
300** [H12119] [H12122] [H12125] [H12131] [H12134] [H12137] [H12138]
drh75897232000-05-29 14:26:00 +0000301*/
danielk19776f8a5032004-05-10 10:34:51 +0000302int sqlite3_exec(
drh6ed48bf2007-06-14 20:57:18 +0000303 sqlite3*, /* An open database */
shane236ce972008-05-30 15:35:30 +0000304 const char *sql, /* SQL to be evaluated */
drh6ed48bf2007-06-14 20:57:18 +0000305 int (*callback)(void*,int,char**,char**), /* Callback function */
306 void *, /* 1st argument to callback */
307 char **errmsg /* Error msg written here */
drh75897232000-05-29 14:26:00 +0000308);
309
drh58b95762000-06-02 01:17:37 +0000310/*
drhb25f9d82008-07-23 15:40:06 +0000311** CAPI3REF: Result Codes {H10210} <S10700>
drh33c1be32008-01-30 16:16:14 +0000312** KEYWORDS: SQLITE_OK {error code} {error codes}
mihailimefc8e8a2008-06-21 16:47:09 +0000313** KEYWORDS: {result code} {result codes}
drh6ed48bf2007-06-14 20:57:18 +0000314**
315** Many SQLite functions return an integer result code from the set shown
drh33c1be32008-01-30 16:16:14 +0000316** here in order to indicates success or failure.
drh6ed48bf2007-06-14 20:57:18 +0000317**
drh4766b292008-06-26 02:53:02 +0000318** New error codes may be added in future versions of SQLite.
319**
drh6ed48bf2007-06-14 20:57:18 +0000320** See also: [SQLITE_IOERR_READ | extended result codes]
drh58b95762000-06-02 01:17:37 +0000321*/
drh717e6402001-09-27 03:22:32 +0000322#define SQLITE_OK 0 /* Successful result */
drh15b9a152006-01-31 20:49:13 +0000323/* beginning-of-error-codes */
drh717e6402001-09-27 03:22:32 +0000324#define SQLITE_ERROR 1 /* SQL error or missing database */
drh89e0dde2007-12-12 12:25:21 +0000325#define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */
drh717e6402001-09-27 03:22:32 +0000326#define SQLITE_PERM 3 /* Access permission denied */
327#define SQLITE_ABORT 4 /* Callback routine requested an abort */
328#define SQLITE_BUSY 5 /* The database file is locked */
329#define SQLITE_LOCKED 6 /* A table in the database is locked */
330#define SQLITE_NOMEM 7 /* A malloc() failed */
331#define SQLITE_READONLY 8 /* Attempt to write a readonly database */
drh24cd67e2004-05-10 16:18:47 +0000332#define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/
drh717e6402001-09-27 03:22:32 +0000333#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */
334#define SQLITE_CORRUPT 11 /* The database disk image is malformed */
drh2db0bbc2005-08-11 02:10:18 +0000335#define SQLITE_NOTFOUND 12 /* NOT USED. Table or record not found */
drh717e6402001-09-27 03:22:32 +0000336#define SQLITE_FULL 13 /* Insertion failed because database is full */
337#define SQLITE_CANTOPEN 14 /* Unable to open the database file */
drh4f0ee682007-03-30 20:43:40 +0000338#define SQLITE_PROTOCOL 15 /* NOT USED. Database lock protocol error */
drh24cd67e2004-05-10 16:18:47 +0000339#define SQLITE_EMPTY 16 /* Database is empty */
drh717e6402001-09-27 03:22:32 +0000340#define SQLITE_SCHEMA 17 /* The database schema changed */
drhc797d4d2007-05-08 01:08:49 +0000341#define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */
danielk19776eb91d22007-09-21 04:27:02 +0000342#define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */
drh8aff1012001-12-22 14:49:24 +0000343#define SQLITE_MISMATCH 20 /* Data type mismatch */
drh247be432002-05-10 05:44:55 +0000344#define SQLITE_MISUSE 21 /* Library used incorrectly */
drh8766c342002-11-09 00:33:15 +0000345#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */
drhed6c8672003-01-12 18:02:16 +0000346#define SQLITE_AUTH 23 /* Authorization denied */
drh1c2d8412003-03-31 00:30:47 +0000347#define SQLITE_FORMAT 24 /* Auxiliary database format error */
danielk19776f8a5032004-05-10 10:34:51 +0000348#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */
drhc602f9a2004-02-12 19:01:04 +0000349#define SQLITE_NOTADB 26 /* File opened that is not a database file */
danielk19776f8a5032004-05-10 10:34:51 +0000350#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */
351#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */
drh15b9a152006-01-31 20:49:13 +0000352/* end-of-error-codes */
drh717e6402001-09-27 03:22:32 +0000353
drhaf9ff332002-01-16 21:00:27 +0000354/*
drhb25f9d82008-07-23 15:40:06 +0000355** CAPI3REF: Extended Result Codes {H10220} <S10700>
drh33c1be32008-01-30 16:16:14 +0000356** KEYWORDS: {extended error code} {extended error codes}
mihailimefc8e8a2008-06-21 16:47:09 +0000357** KEYWORDS: {extended result code} {extended result codes}
drh4ac285a2006-09-15 07:28:50 +0000358**
drh6ed48bf2007-06-14 20:57:18 +0000359** In its default configuration, SQLite API routines return one of 26 integer
mihailim362cc832008-06-21 06:16:42 +0000360** [SQLITE_OK | result codes]. However, experience has shown that many of
361** these result codes are too coarse-grained. They do not provide as
drhf5befa02007-12-06 02:42:07 +0000362** much information about problems as programmers might like. In an effort to
drh6ed48bf2007-06-14 20:57:18 +0000363** address this, newer versions of SQLite (version 3.3.8 and later) include
364** support for additional result codes that provide more detailed information
drh33c1be32008-01-30 16:16:14 +0000365** about errors. The extended result codes are enabled or disabled
mihailim362cc832008-06-21 06:16:42 +0000366** on a per database connection basis using the
367** [sqlite3_extended_result_codes()] API.
mihailima3f64902008-06-21 13:35:56 +0000368**
drh33c1be32008-01-30 16:16:14 +0000369** Some of the available extended result codes are listed here.
370** One may expect the number of extended result codes will be expand
371** over time. Software that uses extended result codes should expect
372** to see new result codes in future releases of SQLite.
drh4ac285a2006-09-15 07:28:50 +0000373**
374** The SQLITE_OK result code will never be extended. It will always
375** be exactly zero.
drh4ac285a2006-09-15 07:28:50 +0000376*/
danielk1977861f7452008-06-05 11:39:11 +0000377#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8))
378#define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8))
379#define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8))
380#define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8))
381#define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8))
382#define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8))
383#define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8))
384#define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8))
385#define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8))
386#define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8))
387#define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8))
388#define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8))
389#define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8))
390#define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8))
aswift5b1a2562008-08-22 00:22:35 +0000391#define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8))
aswiftaebf4132008-11-21 00:10:35 +0000392#define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8))
393#define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8))
danielk1977404ca072009-03-16 13:19:36 +0000394#define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8) )
395
drh4ac285a2006-09-15 07:28:50 +0000396/*
drh9cd29642008-07-23 00:52:55 +0000397** CAPI3REF: Flags For File Open Operations {H10230} <H11120> <H12700>
drh6d2069d2007-08-14 01:58:53 +0000398**
mlcreechb2799412008-03-07 03:20:31 +0000399** These bit values are intended for use in the
drh33c1be32008-01-30 16:16:14 +0000400** 3rd parameter to the [sqlite3_open_v2()] interface and
401** in the 4th parameter to the xOpen method of the
drhd84f9462007-08-15 11:28:56 +0000402** [sqlite3_vfs] object.
drh6d2069d2007-08-14 01:58:53 +0000403*/
shane089b0a42009-05-14 03:21:28 +0000404#define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */
405#define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */
406#define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */
407#define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */
408#define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */
409#define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */
410#define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */
411#define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */
412#define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */
413#define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */
414#define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */
415#define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */
416#define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */
417#define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */
drh6d2069d2007-08-14 01:58:53 +0000418
419/*
drh9cd29642008-07-23 00:52:55 +0000420** CAPI3REF: Device Characteristics {H10240} <H11120>
drh6d2069d2007-08-14 01:58:53 +0000421**
drh33c1be32008-01-30 16:16:14 +0000422** The xDeviceCapabilities method of the [sqlite3_io_methods]
drhfddfa2d2007-12-05 18:05:16 +0000423** object returns an integer which is a vector of the these
drh6d2069d2007-08-14 01:58:53 +0000424** bit values expressing I/O characteristics of the mass storage
425** device that holds the file that the [sqlite3_io_methods]
drh33c1be32008-01-30 16:16:14 +0000426** refers to.
drh6d2069d2007-08-14 01:58:53 +0000427**
drh33c1be32008-01-30 16:16:14 +0000428** The SQLITE_IOCAP_ATOMIC property means that all writes of
429** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
drh6d2069d2007-08-14 01:58:53 +0000430** mean that writes of blocks that are nnn bytes in size and
431** are aligned to an address which is an integer multiple of
drh33c1be32008-01-30 16:16:14 +0000432** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
drh6d2069d2007-08-14 01:58:53 +0000433** that when data is appended to a file, the data is appended
434** first then the size of the file is extended, never the other
drh33c1be32008-01-30 16:16:14 +0000435** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
drh6d2069d2007-08-14 01:58:53 +0000436** information is written to disk in the same order as calls
437** to xWrite().
438*/
439#define SQLITE_IOCAP_ATOMIC 0x00000001
440#define SQLITE_IOCAP_ATOMIC512 0x00000002
441#define SQLITE_IOCAP_ATOMIC1K 0x00000004
442#define SQLITE_IOCAP_ATOMIC2K 0x00000008
443#define SQLITE_IOCAP_ATOMIC4K 0x00000010
444#define SQLITE_IOCAP_ATOMIC8K 0x00000020
445#define SQLITE_IOCAP_ATOMIC16K 0x00000040
446#define SQLITE_IOCAP_ATOMIC32K 0x00000080
447#define SQLITE_IOCAP_ATOMIC64K 0x00000100
448#define SQLITE_IOCAP_SAFE_APPEND 0x00000200
449#define SQLITE_IOCAP_SEQUENTIAL 0x00000400
450
451/*
drhb25f9d82008-07-23 15:40:06 +0000452** CAPI3REF: File Locking Levels {H10250} <H11120> <H11310>
drh6d2069d2007-08-14 01:58:53 +0000453**
drh33c1be32008-01-30 16:16:14 +0000454** SQLite uses one of these integer values as the second
drh6d2069d2007-08-14 01:58:53 +0000455** argument to calls it makes to the xLock() and xUnlock() methods
drh33c1be32008-01-30 16:16:14 +0000456** of an [sqlite3_io_methods] object.
drh6d2069d2007-08-14 01:58:53 +0000457*/
458#define SQLITE_LOCK_NONE 0
459#define SQLITE_LOCK_SHARED 1
460#define SQLITE_LOCK_RESERVED 2
461#define SQLITE_LOCK_PENDING 3
462#define SQLITE_LOCK_EXCLUSIVE 4
463
464/*
drh9cd29642008-07-23 00:52:55 +0000465** CAPI3REF: Synchronization Type Flags {H10260} <H11120>
drh6d2069d2007-08-14 01:58:53 +0000466**
drh33c1be32008-01-30 16:16:14 +0000467** When SQLite invokes the xSync() method of an
mlcreechb2799412008-03-07 03:20:31 +0000468** [sqlite3_io_methods] object it uses a combination of
drhfddfa2d2007-12-05 18:05:16 +0000469** these integer values as the second argument.
drh6d2069d2007-08-14 01:58:53 +0000470**
drh33c1be32008-01-30 16:16:14 +0000471** When the SQLITE_SYNC_DATAONLY flag is used, it means that the
drh6d2069d2007-08-14 01:58:53 +0000472** sync operation only needs to flush data to mass storage. Inode
drheb0d6292009-04-04 14:04:58 +0000473** information need not be flushed. If the lower four bits of the flag
474** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics.
475** If the lower four bits equal SQLITE_SYNC_FULL, that means
shane7ba429a2008-11-10 17:08:49 +0000476** to use Mac OS X style fullsync instead of fsync().
drh6d2069d2007-08-14 01:58:53 +0000477*/
drh6d2069d2007-08-14 01:58:53 +0000478#define SQLITE_SYNC_NORMAL 0x00002
479#define SQLITE_SYNC_FULL 0x00003
480#define SQLITE_SYNC_DATAONLY 0x00010
481
drh6d2069d2007-08-14 01:58:53 +0000482/*
drh9cd29642008-07-23 00:52:55 +0000483** CAPI3REF: OS Interface Open File Handle {H11110} <S20110>
drh6d2069d2007-08-14 01:58:53 +0000484**
485** An [sqlite3_file] object represents an open file in the OS
486** interface layer. Individual OS interface implementations will
487** want to subclass this object by appending additional fields
drh4ff7fa02007-09-01 18:17:21 +0000488** for their own use. The pMethods entry is a pointer to an
drhd84f9462007-08-15 11:28:56 +0000489** [sqlite3_io_methods] object that defines methods for performing
490** I/O operations on the open file.
drh6d2069d2007-08-14 01:58:53 +0000491*/
492typedef struct sqlite3_file sqlite3_file;
493struct sqlite3_file {
drh153c62c2007-08-24 03:51:33 +0000494 const struct sqlite3_io_methods *pMethods; /* Methods for an open file */
drh6d2069d2007-08-14 01:58:53 +0000495};
496
497/*
drh9cd29642008-07-23 00:52:55 +0000498** CAPI3REF: OS Interface File Virtual Methods Object {H11120} <S20110>
drh6d2069d2007-08-14 01:58:53 +0000499**
drh4766b292008-06-26 02:53:02 +0000500** Every file opened by the [sqlite3_vfs] xOpen method populates an
501** [sqlite3_file] object (or, more commonly, a subclass of the
502** [sqlite3_file] object) with a pointer to an instance of this object.
503** This object defines the methods used to perform various operations
504** against the open file represented by the [sqlite3_file] object.
drhd84f9462007-08-15 11:28:56 +0000505**
drh9afedcc2009-06-19 22:50:31 +0000506** If the xOpen method sets the sqlite3_file.pMethods element
507** to a non-NULL pointer, then the sqlite3_io_methods.xClose method
508** may be invoked even if the xOpen reported that it failed. The
509** only way to prevent a call to xClose following a failed xOpen
510** is for the xOpen to set the sqlite3_file.pMethods element to NULL.
511**
drhfddfa2d2007-12-05 18:05:16 +0000512** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or
513** [SQLITE_SYNC_FULL]. The first choice is the normal fsync().
shane7ba429a2008-11-10 17:08:49 +0000514** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY]
mihailim362cc832008-06-21 06:16:42 +0000515** flag may be ORed in to indicate that only the data of the file
516** and not its inode needs to be synced.
mihailima3f64902008-06-21 13:35:56 +0000517**
drhd84f9462007-08-15 11:28:56 +0000518** The integer values to xLock() and xUnlock() are one of
drh4ff7fa02007-09-01 18:17:21 +0000519** <ul>
520** <li> [SQLITE_LOCK_NONE],
drh79491ab2007-09-04 12:00:00 +0000521** <li> [SQLITE_LOCK_SHARED],
drh4ff7fa02007-09-01 18:17:21 +0000522** <li> [SQLITE_LOCK_RESERVED],
523** <li> [SQLITE_LOCK_PENDING], or
524** <li> [SQLITE_LOCK_EXCLUSIVE].
525** </ul>
mihailima3f64902008-06-21 13:35:56 +0000526** xLock() increases the lock. xUnlock() decreases the lock.
mihailim362cc832008-06-21 06:16:42 +0000527** The xCheckReservedLock() method checks whether any database connection,
528** either in this process or in some other process, is holding a RESERVED,
drhd84f9462007-08-15 11:28:56 +0000529** PENDING, or EXCLUSIVE lock on the file. It returns true
mihailim362cc832008-06-21 06:16:42 +0000530** if such a lock exists and false otherwise.
mihailima3f64902008-06-21 13:35:56 +0000531**
drhcc6bb3e2007-08-31 16:11:35 +0000532** The xFileControl() method is a generic interface that allows custom
533** VFS implementations to directly control an open file using the
mihailim362cc832008-06-21 06:16:42 +0000534** [sqlite3_file_control()] interface. The second "op" argument is an
mihailima3f64902008-06-21 13:35:56 +0000535** integer opcode. The third argument is a generic pointer intended to
mihailim362cc832008-06-21 06:16:42 +0000536** point to a structure that may contain arguments or space in which to
drhcc6bb3e2007-08-31 16:11:35 +0000537** write return values. Potential uses for xFileControl() might be
538** functions to enable blocking locks with timeouts, to change the
539** locking strategy (for example to use dot-file locks), to inquire
drh9e33c2c2007-08-31 18:34:59 +0000540** about the status of a lock, or to break stale locks. The SQLite
mihailima3f64902008-06-21 13:35:56 +0000541** core reserves all opcodes less than 100 for its own use.
drh4ff7fa02007-09-01 18:17:21 +0000542** A [SQLITE_FCNTL_LOCKSTATE | list of opcodes] less than 100 is available.
mihailim362cc832008-06-21 06:16:42 +0000543** Applications that define a custom xFileControl method should use opcodes
drh9e33c2c2007-08-31 18:34:59 +0000544** greater than 100 to avoid conflicts.
drhd84f9462007-08-15 11:28:56 +0000545**
546** The xSectorSize() method returns the sector size of the
547** device that underlies the file. The sector size is the
548** minimum write that can be performed without disturbing
549** other bytes in the file. The xDeviceCharacteristics()
550** method returns a bit vector describing behaviors of the
551** underlying device:
552**
553** <ul>
drh4ff7fa02007-09-01 18:17:21 +0000554** <li> [SQLITE_IOCAP_ATOMIC]
555** <li> [SQLITE_IOCAP_ATOMIC512]
556** <li> [SQLITE_IOCAP_ATOMIC1K]
557** <li> [SQLITE_IOCAP_ATOMIC2K]
558** <li> [SQLITE_IOCAP_ATOMIC4K]
559** <li> [SQLITE_IOCAP_ATOMIC8K]
560** <li> [SQLITE_IOCAP_ATOMIC16K]
561** <li> [SQLITE_IOCAP_ATOMIC32K]
562** <li> [SQLITE_IOCAP_ATOMIC64K]
563** <li> [SQLITE_IOCAP_SAFE_APPEND]
564** <li> [SQLITE_IOCAP_SEQUENTIAL]
drhd84f9462007-08-15 11:28:56 +0000565** </ul>
566**
567** The SQLITE_IOCAP_ATOMIC property means that all writes of
568** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
569** mean that writes of blocks that are nnn bytes in size and
570** are aligned to an address which is an integer multiple of
571** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
572** that when data is appended to a file, the data is appended
573** first then the size of the file is extended, never the other
574** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
575** information is written to disk in the same order as calls
576** to xWrite().
drh4c17c3f2008-11-07 00:06:18 +0000577**
578** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill
579** in the unread portions of the buffer with zeros. A VFS that
580** fails to zero-fill short reads might seem to work. However,
581** failure to zero-fill short reads will eventually lead to
582** database corruption.
drh6d2069d2007-08-14 01:58:53 +0000583*/
584typedef struct sqlite3_io_methods sqlite3_io_methods;
585struct sqlite3_io_methods {
586 int iVersion;
587 int (*xClose)(sqlite3_file*);
drh79491ab2007-09-04 12:00:00 +0000588 int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst);
589 int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst);
590 int (*xTruncate)(sqlite3_file*, sqlite3_int64 size);
drh6d2069d2007-08-14 01:58:53 +0000591 int (*xSync)(sqlite3_file*, int flags);
drh79491ab2007-09-04 12:00:00 +0000592 int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize);
drh6d2069d2007-08-14 01:58:53 +0000593 int (*xLock)(sqlite3_file*, int);
594 int (*xUnlock)(sqlite3_file*, int);
danielk1977861f7452008-06-05 11:39:11 +0000595 int (*xCheckReservedLock)(sqlite3_file*, int *pResOut);
drhcc6bb3e2007-08-31 16:11:35 +0000596 int (*xFileControl)(sqlite3_file*, int op, void *pArg);
drh6d2069d2007-08-14 01:58:53 +0000597 int (*xSectorSize)(sqlite3_file*);
598 int (*xDeviceCharacteristics)(sqlite3_file*);
599 /* Additional methods may be added in future releases */
600};
601
602/*
drh9cd29642008-07-23 00:52:55 +0000603** CAPI3REF: Standard File Control Opcodes {H11310} <S30800>
drh9e33c2c2007-08-31 18:34:59 +0000604**
605** These integer constants are opcodes for the xFileControl method
mihailim362cc832008-06-21 06:16:42 +0000606** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()]
drh9e33c2c2007-08-31 18:34:59 +0000607** interface.
608**
drh33c1be32008-01-30 16:16:14 +0000609** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This
mlcreechb2799412008-03-07 03:20:31 +0000610** opcode causes the xFileControl method to write the current state of
drh9e33c2c2007-08-31 18:34:59 +0000611** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED],
612** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE])
drh33c1be32008-01-30 16:16:14 +0000613** into an integer that the pArg argument points to. This capability
drh9e33c2c2007-08-31 18:34:59 +0000614** is used during testing and only needs to be supported when SQLITE_TEST
615** is defined.
616*/
617#define SQLITE_FCNTL_LOCKSTATE 1
aswiftaebf4132008-11-21 00:10:35 +0000618#define SQLITE_GET_LOCKPROXYFILE 2
619#define SQLITE_SET_LOCKPROXYFILE 3
620#define SQLITE_LAST_ERRNO 4
drh9e33c2c2007-08-31 18:34:59 +0000621
622/*
drh9cd29642008-07-23 00:52:55 +0000623** CAPI3REF: Mutex Handle {H17110} <S20130>
drh6d2069d2007-08-14 01:58:53 +0000624**
drhd84f9462007-08-15 11:28:56 +0000625** The mutex module within SQLite defines [sqlite3_mutex] to be an
drh33c1be32008-01-30 16:16:14 +0000626** abstract type for a mutex object. The SQLite core never looks
627** at the internal representation of an [sqlite3_mutex]. It only
drhd84f9462007-08-15 11:28:56 +0000628** deals with pointers to the [sqlite3_mutex] object.
drh6bdec4a2007-08-16 19:40:16 +0000629**
630** Mutexes are created using [sqlite3_mutex_alloc()].
drh6d2069d2007-08-14 01:58:53 +0000631*/
632typedef struct sqlite3_mutex sqlite3_mutex;
633
634/*
drh9cd29642008-07-23 00:52:55 +0000635** CAPI3REF: OS Interface Object {H11140} <S20100>
drh6d2069d2007-08-14 01:58:53 +0000636**
mihailim362cc832008-06-21 06:16:42 +0000637** An instance of the sqlite3_vfs object defines the interface between
638** the SQLite core and the underlying operating system. The "vfs"
drhd84f9462007-08-15 11:28:56 +0000639** in the name of the object stands for "virtual file system".
drh6d2069d2007-08-14 01:58:53 +0000640**
mihailim362cc832008-06-21 06:16:42 +0000641** The value of the iVersion field is initially 1 but may be larger in
642** future versions of SQLite. Additional fields may be appended to this
drh4766b292008-06-26 02:53:02 +0000643** object when the iVersion value is increased. Note that the structure
644** of the sqlite3_vfs object changes in the transaction between
645** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not
646** modified.
drh6bdec4a2007-08-16 19:40:16 +0000647**
drh4ff7fa02007-09-01 18:17:21 +0000648** The szOsFile field is the size of the subclassed [sqlite3_file]
drhd84f9462007-08-15 11:28:56 +0000649** structure used by this VFS. mxPathname is the maximum length of
650** a pathname in this VFS.
651**
drhb4d58ae2008-02-21 20:17:06 +0000652** Registered sqlite3_vfs objects are kept on a linked list formed by
drh79491ab2007-09-04 12:00:00 +0000653** the pNext pointer. The [sqlite3_vfs_register()]
654** and [sqlite3_vfs_unregister()] interfaces manage this list
655** in a thread-safe way. The [sqlite3_vfs_find()] interface
drh4766b292008-06-26 02:53:02 +0000656** searches the list. Neither the application code nor the VFS
657** implementation should use the pNext pointer.
drhd84f9462007-08-15 11:28:56 +0000658**
mihailima3f64902008-06-21 13:35:56 +0000659** The pNext field is the only field in the sqlite3_vfs
drh1cc8c442007-08-24 16:08:29 +0000660** structure that SQLite will ever modify. SQLite will only access
661** or modify this field while holding a particular static mutex.
662** The application should never modify anything within the sqlite3_vfs
663** object once the object has been registered.
664**
drhd84f9462007-08-15 11:28:56 +0000665** The zName field holds the name of the VFS module. The name must
666** be unique across all VFS modules.
667**
drh032ca702008-12-10 11:44:30 +0000668** SQLite will guarantee that the zFilename parameter to xOpen
drh4766b292008-06-26 02:53:02 +0000669** is either a NULL pointer or string obtained
670** from xFullPathname(). SQLite further guarantees that
671** the string will be valid and unchanged until xClose() is
drh9afedcc2009-06-19 22:50:31 +0000672** called. Because of the previous sentence,
drh4766b292008-06-26 02:53:02 +0000673** the [sqlite3_file] can safely store a pointer to the
drh6d2069d2007-08-14 01:58:53 +0000674** filename if it needs to remember the filename for some reason.
drh4766b292008-06-26 02:53:02 +0000675** If the zFilename parameter is xOpen is a NULL pointer then xOpen
drh9afedcc2009-06-19 22:50:31 +0000676** must invent its own temporary name for the file. Whenever the
drh4766b292008-06-26 02:53:02 +0000677** xFilename parameter is NULL it will also be the case that the
678** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE].
drhd84f9462007-08-15 11:28:56 +0000679**
drh032ca702008-12-10 11:44:30 +0000680** The flags argument to xOpen() includes all bits set in
drhf5befa02007-12-06 02:42:07 +0000681** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()]
682** or [sqlite3_open16()] is used, then flags includes at least
drh032ca702008-12-10 11:44:30 +0000683** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE].
drh6d2069d2007-08-14 01:58:53 +0000684** If xOpen() opens a file read-only then it sets *pOutFlags to
mihailim362cc832008-06-21 06:16:42 +0000685** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set.
686**
drh032ca702008-12-10 11:44:30 +0000687** SQLite will also add one of the following flags to the xOpen()
drh6d2069d2007-08-14 01:58:53 +0000688** call, depending on the object being opened:
mihailim362cc832008-06-21 06:16:42 +0000689**
drh6d2069d2007-08-14 01:58:53 +0000690** <ul>
691** <li> [SQLITE_OPEN_MAIN_DB]
692** <li> [SQLITE_OPEN_MAIN_JOURNAL]
693** <li> [SQLITE_OPEN_TEMP_DB]
694** <li> [SQLITE_OPEN_TEMP_JOURNAL]
drh33f4e022007-09-03 15:19:34 +0000695** <li> [SQLITE_OPEN_TRANSIENT_DB]
drh6d2069d2007-08-14 01:58:53 +0000696** <li> [SQLITE_OPEN_SUBJOURNAL]
697** <li> [SQLITE_OPEN_MASTER_JOURNAL]
drh032ca702008-12-10 11:44:30 +0000698** </ul>
drhd84f9462007-08-15 11:28:56 +0000699**
drh6d2069d2007-08-14 01:58:53 +0000700** The file I/O implementation can use the object type flags to
mihailim362cc832008-06-21 06:16:42 +0000701** change the way it deals with files. For example, an application
mlcreechb2799412008-03-07 03:20:31 +0000702** that does not care about crash recovery or rollback might make
703** the open of a journal file a no-op. Writes to this journal would
mihailim362cc832008-06-21 06:16:42 +0000704** also be no-ops, and any attempt to read the journal would return
705** SQLITE_IOERR. Or the implementation might recognize that a database
706** file will be doing page-aligned sector reads and writes in a random
mlcreechb2799412008-03-07 03:20:31 +0000707** order and set up its I/O subsystem accordingly.
mihailim362cc832008-06-21 06:16:42 +0000708**
709** SQLite might also add one of the following flags to the xOpen method:
710**
drh6d2069d2007-08-14 01:58:53 +0000711** <ul>
712** <li> [SQLITE_OPEN_DELETEONCLOSE]
713** <li> [SQLITE_OPEN_EXCLUSIVE]
714** </ul>
mihailim362cc832008-06-21 06:16:42 +0000715**
drh032ca702008-12-10 11:44:30 +0000716** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be
717** deleted when it is closed. The [SQLITE_OPEN_DELETEONCLOSE]
mihailim362cc832008-06-21 06:16:42 +0000718** will be set for TEMP databases, journals and for subjournals.
mihailim04bcc002008-06-22 10:21:27 +0000719**
shane089b0a42009-05-14 03:21:28 +0000720** The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction
721** with the [SQLITE_OPEN_CREATE] flag, which are both directly
722** analogous to the O_EXCL and O_CREAT flags of the POSIX open()
723** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the
724** SQLITE_OPEN_CREATE, is used to indicate that file should always
725** be created, and that it is an error if it already exists.
726** It is <i>not</i> used to indicate the file should be opened
727** for exclusive access.
mihailim362cc832008-06-21 06:16:42 +0000728**
drh032ca702008-12-10 11:44:30 +0000729** At least szOsFile bytes of memory are allocated by SQLite
mihailim362cc832008-06-21 06:16:42 +0000730** to hold the [sqlite3_file] structure passed as the third
drh032ca702008-12-10 11:44:30 +0000731** argument to xOpen. The xOpen method does not have to
drh9afedcc2009-06-19 22:50:31 +0000732** allocate the structure; it should just fill it in. Note that
733** the xOpen method must set the sqlite3_file.pMethods to either
734** a valid [sqlite3_io_methods] object or to NULL. xOpen must do
735** this even if the open fails. SQLite expects that the sqlite3_file.pMethods
736** element will be valid after xOpen returns regardless of the success
737** or failure of the xOpen call.
mihailim362cc832008-06-21 06:16:42 +0000738**
drh032ca702008-12-10 11:44:30 +0000739** The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS]
mihailim362cc832008-06-21 06:16:42 +0000740** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to
741** test whether a file is readable and writable, or [SQLITE_ACCESS_READ]
drh032ca702008-12-10 11:44:30 +0000742** to test whether a file is at least readable. The file can be a
drh6d2069d2007-08-14 01:58:53 +0000743** directory.
mihailim362cc832008-06-21 06:16:42 +0000744**
drh032ca702008-12-10 11:44:30 +0000745** SQLite will always allocate at least mxPathname+1 bytes for the
746** output buffer xFullPathname. The exact size of the output buffer
747** is also passed as a parameter to both methods. If the output buffer
mihailim362cc832008-06-21 06:16:42 +0000748** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is
749** handled as a fatal error by SQLite, vfs implementations should endeavor
750** to prevent this by setting mxPathname to a sufficiently large value.
751**
drhd84f9462007-08-15 11:28:56 +0000752** The xRandomness(), xSleep(), and xCurrentTime() interfaces
753** are not strictly a part of the filesystem, but they are
754** included in the VFS structure for completeness.
drh6d2069d2007-08-14 01:58:53 +0000755** The xRandomness() function attempts to return nBytes bytes
756** of good-quality randomness into zOut. The return value is
mihailim362cc832008-06-21 06:16:42 +0000757** the actual number of bytes of randomness obtained.
758** The xSleep() method causes the calling thread to sleep for at
drhd84f9462007-08-15 11:28:56 +0000759** least the number of microseconds given. The xCurrentTime()
mihailim362cc832008-06-21 06:16:42 +0000760** method returns a Julian Day Number for the current date and time.
drh032ca702008-12-10 11:44:30 +0000761**
drh6d2069d2007-08-14 01:58:53 +0000762*/
drhd84f9462007-08-15 11:28:56 +0000763typedef struct sqlite3_vfs sqlite3_vfs;
764struct sqlite3_vfs {
drh6d2069d2007-08-14 01:58:53 +0000765 int iVersion; /* Structure version number */
766 int szOsFile; /* Size of subclassed sqlite3_file */
drh6d2069d2007-08-14 01:58:53 +0000767 int mxPathname; /* Maximum file pathname length */
drhd84f9462007-08-15 11:28:56 +0000768 sqlite3_vfs *pNext; /* Next registered VFS */
drhd84f9462007-08-15 11:28:56 +0000769 const char *zName; /* Name of this virtual file system */
drh1cc8c442007-08-24 16:08:29 +0000770 void *pAppData; /* Pointer to application-specific data */
drh153c62c2007-08-24 03:51:33 +0000771 int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*,
drh6d2069d2007-08-14 01:58:53 +0000772 int flags, int *pOutFlags);
drh153c62c2007-08-24 03:51:33 +0000773 int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir);
danielk1977861f7452008-06-05 11:39:11 +0000774 int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut);
danielk1977adfb9b02007-09-17 07:02:56 +0000775 int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut);
drh153c62c2007-08-24 03:51:33 +0000776 void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename);
777 void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg);
drh1875f7a2008-12-08 18:19:17 +0000778 void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void);
drh153c62c2007-08-24 03:51:33 +0000779 void (*xDlClose)(sqlite3_vfs*, void*);
780 int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut);
781 int (*xSleep)(sqlite3_vfs*, int microseconds);
782 int (*xCurrentTime)(sqlite3_vfs*, double*);
danielk1977bcb97fe2008-06-06 15:49:29 +0000783 int (*xGetLastError)(sqlite3_vfs*, int, char *);
drhd84f9462007-08-15 11:28:56 +0000784 /* New fields may be appended in figure versions. The iVersion
drh6d2069d2007-08-14 01:58:53 +0000785 ** value will increment whenever this happens. */
786};
787
drh50d3f902007-08-27 21:10:36 +0000788/*
drh9cd29642008-07-23 00:52:55 +0000789** CAPI3REF: Flags for the xAccess VFS method {H11190} <H11140>
drh50d3f902007-08-27 21:10:36 +0000790**
drh032ca702008-12-10 11:44:30 +0000791** These integer constants can be used as the third parameter to
drhfddfa2d2007-12-05 18:05:16 +0000792** the xAccess method of an [sqlite3_vfs] object. {END} They determine
mihailim04bcc002008-06-22 10:21:27 +0000793** what kind of permissions the xAccess method is looking for.
drh032ca702008-12-10 11:44:30 +0000794** With SQLITE_ACCESS_EXISTS, the xAccess method
mihailim04bcc002008-06-22 10:21:27 +0000795** simply checks whether the file exists.
drh032ca702008-12-10 11:44:30 +0000796** With SQLITE_ACCESS_READWRITE, the xAccess method
mihailim04bcc002008-06-22 10:21:27 +0000797** checks whether the file is both readable and writable.
drh032ca702008-12-10 11:44:30 +0000798** With SQLITE_ACCESS_READ, the xAccess method
mihailim04bcc002008-06-22 10:21:27 +0000799** checks whether the file is readable.
drh50d3f902007-08-27 21:10:36 +0000800*/
danielk1977b4b47412007-08-17 15:53:36 +0000801#define SQLITE_ACCESS_EXISTS 0
802#define SQLITE_ACCESS_READWRITE 1
drh50d3f902007-08-27 21:10:36 +0000803#define SQLITE_ACCESS_READ 2
danielk1977b4b47412007-08-17 15:53:36 +0000804
drh6d2069d2007-08-14 01:58:53 +0000805/*
drh9cd29642008-07-23 00:52:55 +0000806** CAPI3REF: Initialize The SQLite Library {H10130} <S20000><S30100>
drh673299b2008-06-09 21:57:22 +0000807**
drhcb041342008-06-12 00:07:29 +0000808** The sqlite3_initialize() routine initializes the
drh4766b292008-06-26 02:53:02 +0000809** SQLite library. The sqlite3_shutdown() routine
drhcb041342008-06-12 00:07:29 +0000810** deallocates any resources that were allocated by sqlite3_initialize().
drh673299b2008-06-09 21:57:22 +0000811**
drhcb041342008-06-12 00:07:29 +0000812** A call to sqlite3_initialize() is an "effective" call if it is
813** the first time sqlite3_initialize() is invoked during the lifetime of
814** the process, or if it is the first time sqlite3_initialize() is invoked
815** following a call to sqlite3_shutdown(). Only an effective call
816** of sqlite3_initialize() does any initialization. All other calls
drh4766b292008-06-26 02:53:02 +0000817** are harmless no-ops.
drhcb041342008-06-12 00:07:29 +0000818**
drhd1a24402009-04-19 12:23:58 +0000819** A call to sqlite3_shutdown() is an "effective" call if it is the first
820** call to sqlite3_shutdown() since the last sqlite3_initialize(). Only
821** an effective call to sqlite3_shutdown() does any deinitialization.
822** All other calls to sqlite3_shutdown() are harmless no-ops.
823**
drhcb041342008-06-12 00:07:29 +0000824** Among other things, sqlite3_initialize() shall invoke
drh55b0cf02008-06-19 17:54:33 +0000825** sqlite3_os_init(). Similarly, sqlite3_shutdown()
826** shall invoke sqlite3_os_end().
drh673299b2008-06-09 21:57:22 +0000827**
drhadfae6c2008-10-10 17:26:35 +0000828** The sqlite3_initialize() routine returns [SQLITE_OK] on success.
drhce5a5a02008-06-10 17:41:44 +0000829** If for some reason, sqlite3_initialize() is unable to initialize
830** the library (perhaps it is unable to allocate a needed resource such
drhadfae6c2008-10-10 17:26:35 +0000831** as a mutex) it returns an [error code] other than [SQLITE_OK].
drh673299b2008-06-09 21:57:22 +0000832**
drhce5a5a02008-06-10 17:41:44 +0000833** The sqlite3_initialize() routine is called internally by many other
drhcb041342008-06-12 00:07:29 +0000834** SQLite interfaces so that an application usually does not need to
drhce5a5a02008-06-10 17:41:44 +0000835** invoke sqlite3_initialize() directly. For example, [sqlite3_open()]
836** calls sqlite3_initialize() so the SQLite library will be automatically
837** initialized when [sqlite3_open()] is called if it has not be initialized
drhadfae6c2008-10-10 17:26:35 +0000838** already. However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT]
drhcb041342008-06-12 00:07:29 +0000839** compile-time option, then the automatic calls to sqlite3_initialize()
840** are omitted and the application must call sqlite3_initialize() directly
841** prior to using any other SQLite interface. For maximum portability,
842** it is recommended that applications always invoke sqlite3_initialize()
843** directly prior to using any other SQLite interface. Future releases
844** of SQLite may require this. In other words, the behavior exhibited
drhadfae6c2008-10-10 17:26:35 +0000845** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the
drhcb041342008-06-12 00:07:29 +0000846** default behavior in some future release of SQLite.
drh673299b2008-06-09 21:57:22 +0000847**
drhcb041342008-06-12 00:07:29 +0000848** The sqlite3_os_init() routine does operating-system specific
849** initialization of the SQLite library. The sqlite3_os_end()
850** routine undoes the effect of sqlite3_os_init(). Typical tasks
851** performed by these routines include allocation or deallocation
852** of static resources, initialization of global variables,
853** setting up a default [sqlite3_vfs] module, or setting up
mihailima3f64902008-06-21 13:35:56 +0000854** a default configuration using [sqlite3_config()].
drh673299b2008-06-09 21:57:22 +0000855**
drhcb041342008-06-12 00:07:29 +0000856** The application should never invoke either sqlite3_os_init()
857** or sqlite3_os_end() directly. The application should only invoke
858** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init()
mihailima3f64902008-06-21 13:35:56 +0000859** interface is called automatically by sqlite3_initialize() and
drhcb041342008-06-12 00:07:29 +0000860** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate
861** implementations for sqlite3_os_init() and sqlite3_os_end()
shane7c7c3112009-08-17 15:31:23 +0000862** are built into SQLite when it is compiled for Unix, Windows, or OS/2.
drhadfae6c2008-10-10 17:26:35 +0000863** When built for other platforms (using the [SQLITE_OS_OTHER=1] compile-time
drhcb041342008-06-12 00:07:29 +0000864** option) the application must supply a suitable implementation for
865** sqlite3_os_init() and sqlite3_os_end(). An application-supplied
866** implementation of sqlite3_os_init() or sqlite3_os_end()
drhadfae6c2008-10-10 17:26:35 +0000867** must return [SQLITE_OK] on success and some other [error code] upon
drhcb041342008-06-12 00:07:29 +0000868** failure.
drh673299b2008-06-09 21:57:22 +0000869*/
drhce5a5a02008-06-10 17:41:44 +0000870int sqlite3_initialize(void);
drh673299b2008-06-09 21:57:22 +0000871int sqlite3_shutdown(void);
drhcb041342008-06-12 00:07:29 +0000872int sqlite3_os_init(void);
873int sqlite3_os_end(void);
drh673299b2008-06-09 21:57:22 +0000874
drhce5a5a02008-06-10 17:41:44 +0000875/*
drhadfae6c2008-10-10 17:26:35 +0000876** CAPI3REF: Configuring The SQLite Library {H14100} <S20000><S30200>
drhd5a68d32008-08-04 13:44:57 +0000877** EXPERIMENTAL
drhce5a5a02008-06-10 17:41:44 +0000878**
879** The sqlite3_config() interface is used to make global configuration
880** changes to SQLite in order to tune SQLite to the specific needs of
881** the application. The default configuration is recommended for most
882** applications and so this routine is usually not necessary. It is
883** provided to support rare applications with unusual needs.
884**
885** The sqlite3_config() interface is not threadsafe. The application
886** must insure that no other SQLite interfaces are invoked by other
887** threads while sqlite3_config() is running. Furthermore, sqlite3_config()
888** may only be invoked prior to library initialization using
889** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()].
890** Note, however, that sqlite3_config() can be called as part of the
drh40257ff2008-06-13 18:24:27 +0000891** implementation of an application-defined [sqlite3_os_init()].
drhce5a5a02008-06-10 17:41:44 +0000892**
893** The first argument to sqlite3_config() is an integer
894** [SQLITE_CONFIG_SINGLETHREAD | configuration option] that determines
895** what property of SQLite is to be configured. Subsequent arguments
896** vary depending on the [SQLITE_CONFIG_SINGLETHREAD | configuration option]
897** in the first argument.
898**
drhadfae6c2008-10-10 17:26:35 +0000899** When a configuration option is set, sqlite3_config() returns [SQLITE_OK].
mihailima3f64902008-06-21 13:35:56 +0000900** If the option is unknown or SQLite is unable to set the option
drh40257ff2008-06-13 18:24:27 +0000901** then this routine returns a non-zero [error code].
drhadfae6c2008-10-10 17:26:35 +0000902**
drh8b39db12009-02-18 18:37:58 +0000903** Requirements:
904** [H14103] [H14106] [H14120] [H14123] [H14126] [H14129] [H14132] [H14135]
905** [H14138] [H14141] [H14144] [H14147] [H14150] [H14153] [H14156] [H14159]
906** [H14162] [H14165] [H14168]
drhce5a5a02008-06-10 17:41:44 +0000907*/
shanea79c3cc2008-08-11 17:27:01 +0000908SQLITE_EXPERIMENTAL int sqlite3_config(int, ...);
drhce5a5a02008-06-10 17:41:44 +0000909
910/*
drhf8cecda2008-10-10 23:48:25 +0000911** CAPI3REF: Configure database connections {H14200} <S20000>
drhd5a68d32008-08-04 13:44:57 +0000912** EXPERIMENTAL
drh633e6d52008-07-28 19:34:53 +0000913**
914** The sqlite3_db_config() interface is used to make configuration
drh2462e322008-07-31 14:47:54 +0000915** changes to a [database connection]. The interface is similar to
916** [sqlite3_config()] except that the changes apply to a single
917** [database connection] (specified in the first argument). The
918** sqlite3_db_config() interface can only be used immediately after
919** the database connection is created using [sqlite3_open()],
920** [sqlite3_open16()], or [sqlite3_open_v2()].
921**
922** The second argument to sqlite3_db_config(D,V,...) is the
923** configuration verb - an integer code that indicates what
924** aspect of the [database connection] is being configured.
drhe9d1c722008-08-04 20:13:26 +0000925** The only choice for this value is [SQLITE_DBCONFIG_LOOKASIDE].
drh2462e322008-07-31 14:47:54 +0000926** New verbs are likely to be added in future releases of SQLite.
drhe9d1c722008-08-04 20:13:26 +0000927** Additional arguments depend on the verb.
drhf8cecda2008-10-10 23:48:25 +0000928**
drh8b39db12009-02-18 18:37:58 +0000929** Requirements:
930** [H14203] [H14206] [H14209] [H14212] [H14215]
drh633e6d52008-07-28 19:34:53 +0000931*/
shanea79c3cc2008-08-11 17:27:01 +0000932SQLITE_EXPERIMENTAL int sqlite3_db_config(sqlite3*, int op, ...);
drh633e6d52008-07-28 19:34:53 +0000933
934/*
drh9cd29642008-07-23 00:52:55 +0000935** CAPI3REF: Memory Allocation Routines {H10155} <S20120>
drhd5a68d32008-08-04 13:44:57 +0000936** EXPERIMENTAL
drhfec00ea2008-06-14 16:56:21 +0000937**
938** An instance of this object defines the interface between SQLite
mihailima3f64902008-06-21 13:35:56 +0000939** and low-level memory allocation routines.
drhfec00ea2008-06-14 16:56:21 +0000940**
941** This object is used in only one place in the SQLite interface.
942** A pointer to an instance of this object is the argument to
drh4766b292008-06-26 02:53:02 +0000943** [sqlite3_config()] when the configuration option is
drhfec00ea2008-06-14 16:56:21 +0000944** [SQLITE_CONFIG_MALLOC]. By creating an instance of this object
drh4766b292008-06-26 02:53:02 +0000945** and passing it to [sqlite3_config()] during configuration, an
drhfec00ea2008-06-14 16:56:21 +0000946** application can specify an alternative memory allocation subsystem
947** for SQLite to use for all of its dynamic memory needs.
948**
949** Note that SQLite comes with a built-in memory allocator that is
950** perfectly adequate for the overwhelming majority of applications
951** and that this object is only useful to a tiny minority of applications
952** with specialized memory allocation requirements. This object is
953** also used during testing of SQLite in order to specify an alternative
954** memory allocator that simulates memory out-of-memory conditions in
955** order to verify that SQLite recovers gracefully from such
956** conditions.
957**
drh4766b292008-06-26 02:53:02 +0000958** The xMalloc, xFree, and xRealloc methods must work like the
drhfec00ea2008-06-14 16:56:21 +0000959** malloc(), free(), and realloc() functions from the standard library.
960**
961** xSize should return the allocated size of a memory allocation
962** previously obtained from xMalloc or xRealloc. The allocated size
963** is always at least as big as the requested size but may be larger.
964**
965** The xRoundup method returns what would be the allocated size of
966** a memory allocation given a particular requested size. Most memory
967** allocators round up memory allocations at least to the next multiple
mihailima3f64902008-06-21 13:35:56 +0000968** of 8. Some allocators round up to a larger multiple or to a power of 2.
drhe5ae5732008-06-15 02:51:47 +0000969**
drhfec00ea2008-06-14 16:56:21 +0000970** The xInit method initializes the memory allocator. (For example,
971** it might allocate any require mutexes or initialize internal data
972** structures. The xShutdown method is invoked (indirectly) by
973** [sqlite3_shutdown()] and should deallocate any resources acquired
974** by xInit. The pAppData pointer is used as the only parameter to
975** xInit and xShutdown.
drh9ac06502009-08-17 13:42:29 +0000976**
977** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes
978** the xInit method, so the xInit method need not be threadsafe. The
979** xShutdown method is only called from [sqlite3_shutdown()] so it does
980** not need to be threadsafe either. All other methods must be threadsafe
981** in multithreaded applications.
982**
983** SQLite will never invoke xInit() more than once without an intervening
984** call to xShutdown().
drhfec00ea2008-06-14 16:56:21 +0000985*/
986typedef struct sqlite3_mem_methods sqlite3_mem_methods;
987struct sqlite3_mem_methods {
988 void *(*xMalloc)(int); /* Memory allocation function */
989 void (*xFree)(void*); /* Free a prior allocation */
990 void *(*xRealloc)(void*,int); /* Resize an allocation */
991 int (*xSize)(void*); /* Return the size of an allocation */
992 int (*xRoundup)(int); /* Round up request size to allocation size */
993 int (*xInit)(void*); /* Initialize the memory allocator */
994 void (*xShutdown)(void*); /* Deinitialize the memory allocator */
995 void *pAppData; /* Argument to xInit() and xShutdown() */
996};
997
998/*
drh9cd29642008-07-23 00:52:55 +0000999** CAPI3REF: Configuration Options {H10160} <S20000>
drhd5a68d32008-08-04 13:44:57 +00001000** EXPERIMENTAL
drhce5a5a02008-06-10 17:41:44 +00001001**
1002** These constants are the available integer configuration options that
1003** can be passed as the first argument to the [sqlite3_config()] interface.
mihailima3f64902008-06-21 13:35:56 +00001004**
drha911abe2008-07-16 13:29:51 +00001005** New configuration options may be added in future releases of SQLite.
1006** Existing configuration options might be discontinued. Applications
1007** should check the return code from [sqlite3_config()] to make sure that
1008** the call worked. The [sqlite3_config()] interface will return a
1009** non-zero [error code] if a discontinued or unsupported configuration option
1010** is invoked.
1011**
drhce5a5a02008-06-10 17:41:44 +00001012** <dl>
1013** <dt>SQLITE_CONFIG_SINGLETHREAD</dt>
1014** <dd>There are no arguments to this option. This option disables
1015** all mutexing and puts SQLite into a mode where it can only be used
1016** by a single thread.</dd>
1017**
1018** <dt>SQLITE_CONFIG_MULTITHREAD</dt>
1019** <dd>There are no arguments to this option. This option disables
1020** mutexing on [database connection] and [prepared statement] objects.
1021** The application is responsible for serializing access to
1022** [database connections] and [prepared statements]. But other mutexes
1023** are enabled so that SQLite will be safe to use in a multi-threaded
drhafacce02008-09-02 21:35:03 +00001024** environment as long as no two threads attempt to use the same
1025** [database connection] at the same time. See the [threading mode]
1026** documentation for additional information.</dd>
drhce5a5a02008-06-10 17:41:44 +00001027**
1028** <dt>SQLITE_CONFIG_SERIALIZED</dt>
1029** <dd>There are no arguments to this option. This option enables
1030** all mutexes including the recursive
1031** mutexes on [database connection] and [prepared statement] objects.
1032** In this mode (which is the default when SQLite is compiled with
drh4766b292008-06-26 02:53:02 +00001033** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access
drhce5a5a02008-06-10 17:41:44 +00001034** to [database connections] and [prepared statements] so that the
1035** application is free to use the same [database connection] or the
drh31d38cf2008-07-12 20:35:08 +00001036** same [prepared statement] in different threads at the same time.
drhafacce02008-09-02 21:35:03 +00001037** See the [threading mode] documentation for additional information.</dd>
drhce5a5a02008-06-10 17:41:44 +00001038**
1039** <dt>SQLITE_CONFIG_MALLOC</dt>
drhfec00ea2008-06-14 16:56:21 +00001040** <dd>This option takes a single argument which is a pointer to an
mihailimdb4f2ad2008-06-21 11:20:48 +00001041** instance of the [sqlite3_mem_methods] structure. The argument specifies
1042** alternative low-level memory allocation routines to be used in place of
drhfec00ea2008-06-14 16:56:21 +00001043** the memory allocation routines built into SQLite.</dd>
drhce5a5a02008-06-10 17:41:44 +00001044**
drh33589792008-06-18 13:27:46 +00001045** <dt>SQLITE_CONFIG_GETMALLOC</dt>
1046** <dd>This option takes a single argument which is a pointer to an
1047** instance of the [sqlite3_mem_methods] structure. The [sqlite3_mem_methods]
1048** structure is filled with the currently defined memory allocation routines.
1049** This option can be used to overload the default memory allocation
1050** routines with a wrapper that simulations memory allocation failure or
1051** tracks memory usage, for example.</dd>
1052**
drhfec00ea2008-06-14 16:56:21 +00001053** <dt>SQLITE_CONFIG_MEMSTATUS</dt>
danielk197795c232d2008-07-28 05:22:35 +00001054** <dd>This option takes single argument of type int, interpreted as a
1055** boolean, which enables or disables the collection of memory allocation
1056** statistics. When disabled, the following SQLite interfaces become
1057** non-operational:
drhce5a5a02008-06-10 17:41:44 +00001058** <ul>
1059** <li> [sqlite3_memory_used()]
1060** <li> [sqlite3_memory_highwater()]
1061** <li> [sqlite3_soft_heap_limit()]
drh0a60a382008-07-31 17:16:05 +00001062** <li> [sqlite3_status()]
drhce5a5a02008-06-10 17:41:44 +00001063** </ul>
1064** </dd>
drh33589792008-06-18 13:27:46 +00001065**
1066** <dt>SQLITE_CONFIG_SCRATCH</dt>
1067** <dd>This option specifies a static memory buffer that SQLite can use for
drh6860da02009-06-09 19:53:58 +00001068** scratch memory. There are three arguments: A pointer an 8-byte
1069** aligned memory buffer from which the scrach allocations will be
1070** drawn, the size of each scratch allocation (sz),
1071** and the maximum number of scratch allocations (N). The sz
drh0a60a382008-07-31 17:16:05 +00001072** argument must be a multiple of 16. The sz parameter should be a few bytes
drh6860da02009-06-09 19:53:58 +00001073** larger than the actual scratch space required due to internal overhead.
1074** The first argument should pointer to an 8-byte aligned buffer
1075** of at least sz*N bytes of memory.
drh33589792008-06-18 13:27:46 +00001076** SQLite will use no more than one scratch buffer at once per thread, so
mihailimdb4f2ad2008-06-21 11:20:48 +00001077** N should be set to the expected maximum number of threads. The sz
drh33589792008-06-18 13:27:46 +00001078** parameter should be 6 times the size of the largest database page size.
1079** Scratch buffers are used as part of the btree balance operation. If
1080** The btree balancer needs additional memory beyond what is provided by
1081** scratch buffers or if no scratch buffer space is specified, then SQLite
mihailimdb4f2ad2008-06-21 11:20:48 +00001082** goes to [sqlite3_malloc()] to obtain the memory it needs.</dd>
drh33589792008-06-18 13:27:46 +00001083**
1084** <dt>SQLITE_CONFIG_PAGECACHE</dt>
1085** <dd>This option specifies a static memory buffer that SQLite can use for
drh21614742008-11-18 19:18:08 +00001086** the database page cache with the default page cache implemenation.
1087** This configuration should not be used if an application-define page
1088** cache implementation is loaded using the SQLITE_CONFIG_PCACHE option.
drh6860da02009-06-09 19:53:58 +00001089** There are three arguments to this option: A pointer to 8-byte aligned
mihailimdb4f2ad2008-06-21 11:20:48 +00001090** memory, the size of each page buffer (sz), and the number of pages (N).
drh6860da02009-06-09 19:53:58 +00001091** The sz argument should be the size of the largest database page
1092** (a power of two between 512 and 32768) plus a little extra for each
1093** page header. The page header size is 20 to 40 bytes depending on
1094** the host architecture. It is harmless, apart from the wasted memory,
1095** to make sz a little too large. The first
drh0a60a382008-07-31 17:16:05 +00001096** argument should point to an allocation of at least sz*N bytes of memory.
mihailimdb4f2ad2008-06-21 11:20:48 +00001097** SQLite will use the memory provided by the first argument to satisfy its
1098** memory needs for the first N pages that it adds to cache. If additional
1099** page cache memory is needed beyond what is provided by this option, then
drh0a60a382008-07-31 17:16:05 +00001100** SQLite goes to [sqlite3_malloc()] for the additional storage space.
1101** The implementation might use one or more of the N buffers to hold
drh6860da02009-06-09 19:53:58 +00001102** memory accounting information. The pointer in the first argument must
1103** be aligned to an 8-byte boundary or subsequent behavior of SQLite
1104** will be undefined.</dd>
drh33589792008-06-18 13:27:46 +00001105**
1106** <dt>SQLITE_CONFIG_HEAP</dt>
1107** <dd>This option specifies a static memory buffer that SQLite will use
1108** for all of its dynamic memory allocation needs beyond those provided
1109** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE].
drh6860da02009-06-09 19:53:58 +00001110** There are three arguments: An 8-byte aligned pointer to the memory,
1111** the number of bytes in the memory buffer, and the minimum allocation size.
1112** If the first pointer (the memory pointer) is NULL, then SQLite reverts
drh8a42cbd2008-07-10 18:13:42 +00001113** to using its default memory allocator (the system malloc() implementation),
1114** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. If the
1115** memory pointer is not NULL and either [SQLITE_ENABLE_MEMSYS3] or
1116** [SQLITE_ENABLE_MEMSYS5] are defined, then the alternative memory
drh39bf74a2009-06-09 18:02:10 +00001117** allocator is engaged to handle all of SQLites memory allocation needs.
1118** The first pointer (the memory pointer) must be aligned to an 8-byte
drh6860da02009-06-09 19:53:58 +00001119** boundary or subsequent behavior of SQLite will be undefined.</dd>
drh33589792008-06-18 13:27:46 +00001120**
1121** <dt>SQLITE_CONFIG_MUTEX</dt>
1122** <dd>This option takes a single argument which is a pointer to an
mihailimdb4f2ad2008-06-21 11:20:48 +00001123** instance of the [sqlite3_mutex_methods] structure. The argument specifies
drh33589792008-06-18 13:27:46 +00001124** alternative low-level mutex routines to be used in place
1125** the mutex routines built into SQLite.</dd>
1126**
drh584ff182008-07-14 18:38:17 +00001127** <dt>SQLITE_CONFIG_GETMUTEX</dt>
drh33589792008-06-18 13:27:46 +00001128** <dd>This option takes a single argument which is a pointer to an
1129** instance of the [sqlite3_mutex_methods] structure. The
1130** [sqlite3_mutex_methods]
1131** structure is filled with the currently defined mutex routines.
1132** This option can be used to overload the default mutex allocation
1133** routines with a wrapper used to track mutex usage for performance
1134** profiling or testing, for example.</dd>
drh633e6d52008-07-28 19:34:53 +00001135**
1136** <dt>SQLITE_CONFIG_LOOKASIDE</dt>
1137** <dd>This option takes two arguments that determine the default
1138** memory allcation lookaside optimization. The first argument is the
1139** size of each lookaside buffer slot and the second is the number of
1140** slots allocated to each database connection.</dd>
1141**
drh21614742008-11-18 19:18:08 +00001142** <dt>SQLITE_CONFIG_PCACHE</dt>
1143** <dd>This option takes a single argument which is a pointer to
1144** an [sqlite3_pcache_methods] object. This object specifies the interface
1145** to a custom page cache implementation. SQLite makes a copy of the
1146** object and uses it for page cache memory allocations.</dd>
1147**
1148** <dt>SQLITE_CONFIG_GETPCACHE</dt>
1149** <dd>This option takes a single argument which is a pointer to an
1150** [sqlite3_pcache_methods] object. SQLite copies of the current
1151** page cache implementation into that object.</dd>
1152**
drh633e6d52008-07-28 19:34:53 +00001153** </dl>
mihailima3f64902008-06-21 13:35:56 +00001154*/
drh40257ff2008-06-13 18:24:27 +00001155#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */
1156#define SQLITE_CONFIG_MULTITHREAD 2 /* nil */
1157#define SQLITE_CONFIG_SERIALIZED 3 /* nil */
drhfec00ea2008-06-14 16:56:21 +00001158#define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */
drh33589792008-06-18 13:27:46 +00001159#define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */
1160#define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */
1161#define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */
1162#define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */
1163#define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */
1164#define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */
1165#define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */
shane2479de32008-11-10 18:05:35 +00001166/* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */
drh633e6d52008-07-28 19:34:53 +00001167#define SQLITE_CONFIG_LOOKASIDE 13 /* int int */
danielk1977bc2ca9e2008-11-13 14:28:28 +00001168#define SQLITE_CONFIG_PCACHE 14 /* sqlite3_pcache_methods* */
1169#define SQLITE_CONFIG_GETPCACHE 15 /* sqlite3_pcache_methods* */
danielk19772d340812008-07-24 08:20:40 +00001170
drhe9d1c722008-08-04 20:13:26 +00001171/*
1172** CAPI3REF: Configuration Options {H10170} <S20000>
1173** EXPERIMENTAL
1174**
1175** These constants are the available integer configuration options that
1176** can be passed as the second argument to the [sqlite3_db_config()] interface.
1177**
1178** New configuration options may be added in future releases of SQLite.
1179** Existing configuration options might be discontinued. Applications
1180** should check the return code from [sqlite3_db_config()] to make sure that
1181** the call worked. The [sqlite3_db_config()] interface will return a
1182** non-zero [error code] if a discontinued or unsupported configuration option
1183** is invoked.
1184**
1185** <dl>
1186** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt>
1187** <dd>This option takes three additional arguments that determine the
1188** [lookaside memory allocator] configuration for the [database connection].
1189** The first argument (the third parameter to [sqlite3_db_config()] is a
drh6860da02009-06-09 19:53:58 +00001190** pointer to an 8-byte aligned memory buffer to use for lookaside memory.
1191** The first argument may be NULL in which case SQLite will allocate the
1192** lookaside buffer itself using [sqlite3_malloc()]. The second argument is the
drhe9d1c722008-08-04 20:13:26 +00001193** size of each lookaside buffer slot and the third argument is the number of
1194** slots. The size of the buffer in the first argument must be greater than
1195** or equal to the product of the second and third arguments.</dd>
1196**
1197** </dl>
1198*/
1199#define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */
1200
drhce5a5a02008-06-10 17:41:44 +00001201
drh673299b2008-06-09 21:57:22 +00001202/*
drhb25f9d82008-07-23 15:40:06 +00001203** CAPI3REF: Enable Or Disable Extended Result Codes {H12200} <S10700>
drh6ed48bf2007-06-14 20:57:18 +00001204**
drh33c1be32008-01-30 16:16:14 +00001205** The sqlite3_extended_result_codes() routine enables or disables the
mihailimefc8e8a2008-06-21 16:47:09 +00001206** [extended result codes] feature of SQLite. The extended result
1207** codes are disabled by default for historical compatibility considerations.
drh6ed48bf2007-06-14 20:57:18 +00001208**
drh8b39db12009-02-18 18:37:58 +00001209** Requirements:
1210** [H12201] [H12202]
drh4ac285a2006-09-15 07:28:50 +00001211*/
1212int sqlite3_extended_result_codes(sqlite3*, int onoff);
1213
1214/*
drh9cd29642008-07-23 00:52:55 +00001215** CAPI3REF: Last Insert Rowid {H12220} <S10700>
drh6ed48bf2007-06-14 20:57:18 +00001216**
drh33c1be32008-01-30 16:16:14 +00001217** Each entry in an SQLite table has a unique 64-bit signed
drh49c3d572008-12-15 22:51:38 +00001218** integer key called the [ROWID | "rowid"]. The rowid is always available
drhfddfa2d2007-12-05 18:05:16 +00001219** as an undeclared column named ROWID, OID, or _ROWID_ as long as those
drh33c1be32008-01-30 16:16:14 +00001220** names are not also used by explicitly declared columns. If
drh49c3d572008-12-15 22:51:38 +00001221** the table has a column of type [INTEGER PRIMARY KEY] then that column
mlcreechb2799412008-03-07 03:20:31 +00001222** is another alias for the rowid.
drh6ed48bf2007-06-14 20:57:18 +00001223**
drh49c3d572008-12-15 22:51:38 +00001224** This routine returns the [rowid] of the most recent
drhf8cecda2008-10-10 23:48:25 +00001225** successful [INSERT] into the database from the [database connection]
1226** in the first argument. If no successful [INSERT]s
mihailimdb4f2ad2008-06-21 11:20:48 +00001227** have ever occurred on that database connection, zero is returned.
drh6ed48bf2007-06-14 20:57:18 +00001228**
drh49c3d572008-12-15 22:51:38 +00001229** If an [INSERT] occurs within a trigger, then the [rowid] of the inserted
mihailimdb4f2ad2008-06-21 11:20:48 +00001230** row is returned by this routine as long as the trigger is running.
1231** But once the trigger terminates, the value returned by this routine
1232** reverts to the last value inserted before the trigger fired.
drhe30f4422007-08-21 16:15:55 +00001233**
drhf8cecda2008-10-10 23:48:25 +00001234** An [INSERT] that fails due to a constraint violation is not a
1235** successful [INSERT] and does not change the value returned by this
drh33c1be32008-01-30 16:16:14 +00001236** routine. Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK,
drhdc1d9f12007-10-27 16:25:16 +00001237** and INSERT OR ABORT make no changes to the return value of this
mihailimdb4f2ad2008-06-21 11:20:48 +00001238** routine when their insertion fails. When INSERT OR REPLACE
drhdc1d9f12007-10-27 16:25:16 +00001239** encounters a constraint violation, it does not fail. The
1240** INSERT continues to completion after deleting rows that caused
1241** the constraint problem so INSERT OR REPLACE will always change
mihailimdb4f2ad2008-06-21 11:20:48 +00001242** the return value of this interface.
drhdc1d9f12007-10-27 16:25:16 +00001243**
drhf8cecda2008-10-10 23:48:25 +00001244** For the purposes of this routine, an [INSERT] is considered to
drh33c1be32008-01-30 16:16:14 +00001245** be successful even if it is subsequently rolled back.
1246**
drh8b39db12009-02-18 18:37:58 +00001247** Requirements:
1248** [H12221] [H12223]
drh33c1be32008-01-30 16:16:14 +00001249**
drh8b39db12009-02-18 18:37:58 +00001250** If a separate thread performs a new [INSERT] on the same
1251** database connection while the [sqlite3_last_insert_rowid()]
1252** function is running and thus changes the last insert [rowid],
1253** then the value returned by [sqlite3_last_insert_rowid()] is
1254** unpredictable and might not equal either the old or the new
1255** last insert [rowid].
drhaf9ff332002-01-16 21:00:27 +00001256*/
drh6d2069d2007-08-14 01:58:53 +00001257sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*);
drhaf9ff332002-01-16 21:00:27 +00001258
drhc8d30ac2002-04-12 10:08:59 +00001259/*
drh9cd29642008-07-23 00:52:55 +00001260** CAPI3REF: Count The Number Of Rows Modified {H12240} <S10600>
drh6ed48bf2007-06-14 20:57:18 +00001261**
drh33c1be32008-01-30 16:16:14 +00001262** This function returns the number of database rows that were changed
drhfddfa2d2007-12-05 18:05:16 +00001263** or inserted or deleted by the most recently completed SQL statement
mihailimdb4f2ad2008-06-21 11:20:48 +00001264** on the [database connection] specified by the first parameter.
drhf8cecda2008-10-10 23:48:25 +00001265** Only changes that are directly specified by the [INSERT], [UPDATE],
1266** or [DELETE] statement are counted. Auxiliary changes caused by
drh33c1be32008-01-30 16:16:14 +00001267** triggers are not counted. Use the [sqlite3_total_changes()] function
drh6ed48bf2007-06-14 20:57:18 +00001268** to find the total number of changes including changes caused by triggers.
1269**
drhd9c20d72009-04-29 14:33:44 +00001270** Changes to a view that are simulated by an [INSTEAD OF trigger]
1271** are not counted. Only real table changes are counted.
1272**
mlcreechb2799412008-03-07 03:20:31 +00001273** A "row change" is a change to a single row of a single table
drh33c1be32008-01-30 16:16:14 +00001274** caused by an INSERT, DELETE, or UPDATE statement. Rows that
drhd9c20d72009-04-29 14:33:44 +00001275** are changed as side effects of [REPLACE] constraint resolution,
1276** rollback, ABORT processing, [DROP TABLE], or by any other
drh33c1be32008-01-30 16:16:14 +00001277** mechanisms do not count as direct row changes.
1278**
1279** A "trigger context" is a scope of execution that begins and
drhd9c20d72009-04-29 14:33:44 +00001280** ends with the script of a [CREATE TRIGGER | trigger].
1281** Most SQL statements are
drh33c1be32008-01-30 16:16:14 +00001282** evaluated outside of any trigger. This is the "top level"
1283** trigger context. If a trigger fires from the top level, a
1284** new trigger context is entered for the duration of that one
1285** trigger. Subtriggers create subcontexts for their duration.
1286**
1287** Calling [sqlite3_exec()] or [sqlite3_step()] recursively does
1288** not create a new trigger context.
1289**
1290** This function returns the number of direct row changes in the
1291** most recent INSERT, UPDATE, or DELETE statement within the same
1292** trigger context.
1293**
mihailimdb4f2ad2008-06-21 11:20:48 +00001294** Thus, when called from the top level, this function returns the
drh33c1be32008-01-30 16:16:14 +00001295** number of changes in the most recent INSERT, UPDATE, or DELETE
mihailimdb4f2ad2008-06-21 11:20:48 +00001296** that also occurred at the top level. Within the body of a trigger,
1297** the sqlite3_changes() interface can be called to find the number of
drh930cc582007-03-28 13:07:40 +00001298** changes in the most recently completed INSERT, UPDATE, or DELETE
drhf5befa02007-12-06 02:42:07 +00001299** statement within the body of the same trigger.
mihailimdb4f2ad2008-06-21 11:20:48 +00001300** However, the number returned does not include changes
1301** caused by subtriggers since those have their own context.
drhc8d30ac2002-04-12 10:08:59 +00001302**
drhd9c20d72009-04-29 14:33:44 +00001303** See also the [sqlite3_total_changes()] interface and the
1304** [count_changes pragma].
drhe30f4422007-08-21 16:15:55 +00001305**
drh8b39db12009-02-18 18:37:58 +00001306** Requirements:
1307** [H12241] [H12243]
drh33c1be32008-01-30 16:16:14 +00001308**
drh8b39db12009-02-18 18:37:58 +00001309** If a separate thread makes changes on the same database connection
1310** while [sqlite3_changes()] is running then the value returned
1311** is unpredictable and not meaningful.
drhc8d30ac2002-04-12 10:08:59 +00001312*/
danielk1977f9d64d22004-06-19 08:18:07 +00001313int sqlite3_changes(sqlite3*);
drhc8d30ac2002-04-12 10:08:59 +00001314
rdcf146a772004-02-25 22:51:06 +00001315/*
drh9cd29642008-07-23 00:52:55 +00001316** CAPI3REF: Total Number Of Rows Modified {H12260} <S10600>
mihailimdb4f2ad2008-06-21 11:20:48 +00001317**
drhd9c20d72009-04-29 14:33:44 +00001318** This function returns the number of row changes caused by [INSERT],
1319** [UPDATE] or [DELETE] statements since the [database connection] was opened.
1320** The count includes all changes from all
1321** [CREATE TRIGGER | trigger] contexts. However,
1322** the count does not include changes used to implement [REPLACE] constraints,
1323** do rollbacks or ABORT processing, or [DROP TABLE] processing. The
drh4fb08662009-05-22 01:02:26 +00001324** count does not include rows of views that fire an [INSTEAD OF trigger],
1325** though if the INSTEAD OF trigger makes changes of its own, those changes
1326** are counted.
mihailimdb4f2ad2008-06-21 11:20:48 +00001327** The changes are counted as soon as the statement that makes them is
1328** completed (when the statement handle is passed to [sqlite3_reset()] or
drh33c1be32008-01-30 16:16:14 +00001329** [sqlite3_finalize()]).
drh6ed48bf2007-06-14 20:57:18 +00001330**
drhd9c20d72009-04-29 14:33:44 +00001331** See also the [sqlite3_changes()] interface and the
1332** [count_changes pragma].
drh33c1be32008-01-30 16:16:14 +00001333**
drh8b39db12009-02-18 18:37:58 +00001334** Requirements:
1335** [H12261] [H12263]
mihailimdb4f2ad2008-06-21 11:20:48 +00001336**
drh8b39db12009-02-18 18:37:58 +00001337** If a separate thread makes changes on the same database connection
1338** while [sqlite3_total_changes()] is running then the value
1339** returned is unpredictable and not meaningful.
rdcf146a772004-02-25 22:51:06 +00001340*/
danielk1977b28af712004-06-21 06:50:26 +00001341int sqlite3_total_changes(sqlite3*);
1342
drh6ed48bf2007-06-14 20:57:18 +00001343/*
drh9cd29642008-07-23 00:52:55 +00001344** CAPI3REF: Interrupt A Long-Running Query {H12270} <S30500>
drh6ed48bf2007-06-14 20:57:18 +00001345**
drh33c1be32008-01-30 16:16:14 +00001346** This function causes any pending database operation to abort and
1347** return at its earliest opportunity. This routine is typically
mihailimebe796c2008-06-21 20:11:17 +00001348** called in response to a user action such as pressing "Cancel"
drh4c504392000-10-16 22:06:40 +00001349** or Ctrl-C where the user wants a long query operation to halt
1350** immediately.
drh930cc582007-03-28 13:07:40 +00001351**
drh33c1be32008-01-30 16:16:14 +00001352** It is safe to call this routine from a thread different from the
1353** thread that is currently running the database operation. But it
mihailimdb4f2ad2008-06-21 11:20:48 +00001354** is not safe to call this routine with a [database connection] that
drh871f6ca2007-08-14 18:03:14 +00001355** is closed or might close before sqlite3_interrupt() returns.
drh6ed48bf2007-06-14 20:57:18 +00001356**
mihailimdb4f2ad2008-06-21 11:20:48 +00001357** If an SQL operation is very nearly finished at the time when
1358** sqlite3_interrupt() is called, then it might not have an opportunity
1359** to be interrupted and might continue to completion.
1360**
1361** An SQL operation that is interrupted will return [SQLITE_INTERRUPT].
1362** If the interrupted SQL operation is an INSERT, UPDATE, or DELETE
1363** that is inside an explicit transaction, then the entire transaction
1364** will be rolled back automatically.
1365**
drhd2b68432009-04-20 12:31:46 +00001366** The sqlite3_interrupt(D) call is in effect until all currently running
1367** SQL statements on [database connection] D complete. Any new SQL statements
1368** that are started after the sqlite3_interrupt() call and before the
1369** running statements reaches zero are interrupted as if they had been
1370** running prior to the sqlite3_interrupt() call. New SQL statements
1371** that are started after the running statement count reaches zero are
1372** not effected by the sqlite3_interrupt().
1373** A call to sqlite3_interrupt(D) that occurs when there are no running
1374** SQL statements is a no-op and has no effect on SQL statements
1375** that are started after the sqlite3_interrupt() call returns.
drh33c1be32008-01-30 16:16:14 +00001376**
drh8b39db12009-02-18 18:37:58 +00001377** Requirements:
1378** [H12271] [H12272]
drh33c1be32008-01-30 16:16:14 +00001379**
drh8b39db12009-02-18 18:37:58 +00001380** If the database connection closes while [sqlite3_interrupt()]
1381** is running then bad things will likely happen.
drh4c504392000-10-16 22:06:40 +00001382*/
danielk1977f9d64d22004-06-19 08:18:07 +00001383void sqlite3_interrupt(sqlite3*);
drh4c504392000-10-16 22:06:40 +00001384
drh6ed48bf2007-06-14 20:57:18 +00001385/*
drh9cd29642008-07-23 00:52:55 +00001386** CAPI3REF: Determine If An SQL Statement Is Complete {H10510} <S70200>
drh75897232000-05-29 14:26:00 +00001387**
drh709915d2009-04-28 04:46:41 +00001388** These routines are useful during command-line input to determine if the
1389** currently entered text seems to form a complete SQL statement or
drhf5befa02007-12-06 02:42:07 +00001390** if additional input is needed before sending the text into
drh709915d2009-04-28 04:46:41 +00001391** SQLite for parsing. These routines return 1 if the input string
drhfddfa2d2007-12-05 18:05:16 +00001392** appears to be a complete SQL statement. A statement is judged to be
drh709915d2009-04-28 04:46:41 +00001393** complete if it ends with a semicolon token and is not a prefix of a
1394** well-formed CREATE TRIGGER statement. Semicolons that are embedded within
drh33c1be32008-01-30 16:16:14 +00001395** string literals or quoted identifier names or comments are not
1396** independent tokens (they are part of the token in which they are
drh709915d2009-04-28 04:46:41 +00001397** embedded) and thus do not count as a statement terminator. Whitespace
1398** and comments that follow the final semicolon are ignored.
1399**
1400** These routines return 0 if the statement is incomplete. If a
1401** memory allocation fails, then SQLITE_NOMEM is returned.
drh33c1be32008-01-30 16:16:14 +00001402**
mihailimdb4f2ad2008-06-21 11:20:48 +00001403** These routines do not parse the SQL statements thus
1404** will not detect syntactically incorrect SQL.
drhfddfa2d2007-12-05 18:05:16 +00001405**
drh709915d2009-04-28 04:46:41 +00001406** If SQLite has not been initialized using [sqlite3_initialize()] prior
1407** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked
1408** automatically by sqlite3_complete16(). If that initialization fails,
1409** then the return value from sqlite3_complete16() will be non-zero
1410** regardless of whether or not the input SQL is complete.
1411**
drh8b39db12009-02-18 18:37:58 +00001412** Requirements: [H10511] [H10512]
drh33c1be32008-01-30 16:16:14 +00001413**
drh8b39db12009-02-18 18:37:58 +00001414** The input to [sqlite3_complete()] must be a zero-terminated
1415** UTF-8 string.
drh33c1be32008-01-30 16:16:14 +00001416**
drh8b39db12009-02-18 18:37:58 +00001417** The input to [sqlite3_complete16()] must be a zero-terminated
1418** UTF-16 string in native byte order.
drh75897232000-05-29 14:26:00 +00001419*/
danielk19776f8a5032004-05-10 10:34:51 +00001420int sqlite3_complete(const char *sql);
danielk197761de0d12004-05-27 23:56:16 +00001421int sqlite3_complete16(const void *sql);
drh75897232000-05-29 14:26:00 +00001422
drh2dfbbca2000-07-28 14:32:48 +00001423/*
drh9cd29642008-07-23 00:52:55 +00001424** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors {H12310} <S40400>
drh6ed48bf2007-06-14 20:57:18 +00001425**
mihailimdb4f2ad2008-06-21 11:20:48 +00001426** This routine sets a callback function that might be invoked whenever
1427** an attempt is made to open a database table that another thread
1428** or process has locked.
1429**
1430** If the busy callback is NULL, then [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED]
1431** is returned immediately upon encountering the lock. If the busy callback
1432** is not NULL, then the callback will be invoked with two arguments.
1433**
1434** The first argument to the handler is a copy of the void* pointer which
1435** is the third argument to sqlite3_busy_handler(). The second argument to
1436** the handler callback is the number of times that the busy handler has
1437** been invoked for this locking event. If the
drh6ed48bf2007-06-14 20:57:18 +00001438** busy callback returns 0, then no additional attempts are made to
1439** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned.
drh33c1be32008-01-30 16:16:14 +00001440** If the callback returns non-zero, then another attempt
drhfddfa2d2007-12-05 18:05:16 +00001441** is made to open the database for reading and the cycle repeats.
drh2dfbbca2000-07-28 14:32:48 +00001442**
mihailimdb4f2ad2008-06-21 11:20:48 +00001443** The presence of a busy handler does not guarantee that it will be invoked
1444** when there is lock contention. If SQLite determines that invoking the busy
1445** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY]
1446** or [SQLITE_IOERR_BLOCKED] instead of invoking the busy handler.
drh86939b52007-01-10 12:54:51 +00001447** Consider a scenario where one process is holding a read lock that
1448** it is trying to promote to a reserved lock and
1449** a second process is holding a reserved lock that it is trying
1450** to promote to an exclusive lock. The first process cannot proceed
1451** because it is blocked by the second and the second process cannot
1452** proceed because it is blocked by the first. If both processes
drhf5befa02007-12-06 02:42:07 +00001453** invoke the busy handlers, neither will make any progress. Therefore,
drh6ed48bf2007-06-14 20:57:18 +00001454** SQLite returns [SQLITE_BUSY] for the first process, hoping that this
drh86939b52007-01-10 12:54:51 +00001455** will induce the first process to release its read lock and allow
1456** the second process to proceed.
1457**
drh33c1be32008-01-30 16:16:14 +00001458** The default busy callback is NULL.
drh2dfbbca2000-07-28 14:32:48 +00001459**
drh33c1be32008-01-30 16:16:14 +00001460** The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED]
drhfddfa2d2007-12-05 18:05:16 +00001461** when SQLite is in the middle of a large transaction where all the
drh33c1be32008-01-30 16:16:14 +00001462** changes will not fit into the in-memory cache. SQLite will
drh6ed48bf2007-06-14 20:57:18 +00001463** already hold a RESERVED lock on the database file, but it needs
1464** to promote this lock to EXCLUSIVE so that it can spill cache
1465** pages into the database file without harm to concurrent
drh33c1be32008-01-30 16:16:14 +00001466** readers. If it is unable to promote the lock, then the in-memory
drh6ed48bf2007-06-14 20:57:18 +00001467** cache will be left in an inconsistent state and so the error
1468** code is promoted from the relatively benign [SQLITE_BUSY] to
drh33c1be32008-01-30 16:16:14 +00001469** the more severe [SQLITE_IOERR_BLOCKED]. This error code promotion
1470** forces an automatic rollback of the changes. See the
mihailimdb4f2ad2008-06-21 11:20:48 +00001471** <a href="/cvstrac/wiki?p=CorruptionFollowingBusyError">
drh6ed48bf2007-06-14 20:57:18 +00001472** CorruptionFollowingBusyError</a> wiki page for a discussion of why
1473** this is important.
mihailimdb4f2ad2008-06-21 11:20:48 +00001474**
1475** There can only be a single busy handler defined for each
1476** [database connection]. Setting a new busy handler clears any
1477** previously set handler. Note that calling [sqlite3_busy_timeout()]
1478** will also set or clear the busy handler.
drhd677b3d2007-08-20 22:48:41 +00001479**
drhc8075422008-09-10 13:09:23 +00001480** The busy callback should not take any actions which modify the
1481** database connection that invoked the busy handler. Any such actions
1482** result in undefined behavior.
1483**
drh8b39db12009-02-18 18:37:58 +00001484** Requirements:
1485** [H12311] [H12312] [H12314] [H12316] [H12318]
drh33c1be32008-01-30 16:16:14 +00001486**
drh8b39db12009-02-18 18:37:58 +00001487** A busy handler must not close the database connection
1488** or [prepared statement] that invoked the busy handler.
drh2dfbbca2000-07-28 14:32:48 +00001489*/
danielk1977f9d64d22004-06-19 08:18:07 +00001490int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*);
drh2dfbbca2000-07-28 14:32:48 +00001491
1492/*
drhb25f9d82008-07-23 15:40:06 +00001493** CAPI3REF: Set A Busy Timeout {H12340} <S40410>
drh6ed48bf2007-06-14 20:57:18 +00001494**
mihailimdb4f2ad2008-06-21 11:20:48 +00001495** This routine sets a [sqlite3_busy_handler | busy handler] that sleeps
1496** for a specified amount of time when a table is locked. The handler
1497** will sleep multiple times until at least "ms" milliseconds of sleeping
drh9a247912008-07-22 18:45:08 +00001498** have accumulated. {H12343} After "ms" milliseconds of sleeping,
mihailimdb4f2ad2008-06-21 11:20:48 +00001499** the handler returns 0 which causes [sqlite3_step()] to return
1500** [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED].
drh2dfbbca2000-07-28 14:32:48 +00001501**
drh33c1be32008-01-30 16:16:14 +00001502** Calling this routine with an argument less than or equal to zero
drh2dfbbca2000-07-28 14:32:48 +00001503** turns off all busy handlers.
drh6ed48bf2007-06-14 20:57:18 +00001504**
mihailimdb4f2ad2008-06-21 11:20:48 +00001505** There can only be a single busy handler for a particular
1506** [database connection] any any given moment. If another busy handler
1507** was defined (using [sqlite3_busy_handler()]) prior to calling
drh6ed48bf2007-06-14 20:57:18 +00001508** this routine, that other busy handler is cleared.
drh33c1be32008-01-30 16:16:14 +00001509**
drh8b39db12009-02-18 18:37:58 +00001510** Requirements:
1511** [H12341] [H12343] [H12344]
drh2dfbbca2000-07-28 14:32:48 +00001512*/
danielk1977f9d64d22004-06-19 08:18:07 +00001513int sqlite3_busy_timeout(sqlite3*, int ms);
drh2dfbbca2000-07-28 14:32:48 +00001514
drhe3710332000-09-29 13:30:53 +00001515/*
drh9cd29642008-07-23 00:52:55 +00001516** CAPI3REF: Convenience Routines For Running Queries {H12370} <S10000>
drh6ed48bf2007-06-14 20:57:18 +00001517**
drh33c1be32008-01-30 16:16:14 +00001518** Definition: A <b>result table</b> is memory data structure created by the
1519** [sqlite3_get_table()] interface. A result table records the
1520** complete query results from one or more queries.
drha18c5682000-10-08 22:20:57 +00001521**
drh33c1be32008-01-30 16:16:14 +00001522** The table conceptually has a number of rows and columns. But
1523** these numbers are not part of the result table itself. These
1524** numbers are obtained separately. Let N be the number of rows
1525** and M be the number of columns.
1526**
mihailimdb4f2ad2008-06-21 11:20:48 +00001527** A result table is an array of pointers to zero-terminated UTF-8 strings.
1528** There are (N+1)*M elements in the array. The first M pointers point
1529** to zero-terminated strings that contain the names of the columns.
1530** The remaining entries all point to query results. NULL values result
1531** in NULL pointers. All other values are in their UTF-8 zero-terminated
1532** string representation as returned by [sqlite3_column_text()].
drh33c1be32008-01-30 16:16:14 +00001533**
mihailimdb4f2ad2008-06-21 11:20:48 +00001534** A result table might consist of one or more memory allocations.
drh33c1be32008-01-30 16:16:14 +00001535** It is not safe to pass a result table directly to [sqlite3_free()].
1536** A result table should be deallocated using [sqlite3_free_table()].
1537**
1538** As an example of the result table format, suppose a query result
1539** is as follows:
drha18c5682000-10-08 22:20:57 +00001540**
drh8bacf972007-08-25 16:21:29 +00001541** <blockquote><pre>
drha18c5682000-10-08 22:20:57 +00001542** Name | Age
1543** -----------------------
1544** Alice | 43
1545** Bob | 28
1546** Cindy | 21
drh8bacf972007-08-25 16:21:29 +00001547** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001548**
drh33c1be32008-01-30 16:16:14 +00001549** There are two column (M==2) and three rows (N==3). Thus the
1550** result table has 8 entries. Suppose the result table is stored
1551** in an array names azResult. Then azResult holds this content:
drha18c5682000-10-08 22:20:57 +00001552**
drh8bacf972007-08-25 16:21:29 +00001553** <blockquote><pre>
1554** azResult&#91;0] = "Name";
1555** azResult&#91;1] = "Age";
1556** azResult&#91;2] = "Alice";
1557** azResult&#91;3] = "43";
1558** azResult&#91;4] = "Bob";
1559** azResult&#91;5] = "28";
1560** azResult&#91;6] = "Cindy";
1561** azResult&#91;7] = "21";
1562** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001563**
drh33c1be32008-01-30 16:16:14 +00001564** The sqlite3_get_table() function evaluates one or more
1565** semicolon-separated SQL statements in the zero-terminated UTF-8
1566** string of its 2nd parameter. It returns a result table to the
1567** pointer given in its 3rd parameter.
drha18c5682000-10-08 22:20:57 +00001568**
mihailimdb4f2ad2008-06-21 11:20:48 +00001569** After the calling function has finished using the result, it should
1570** pass the pointer to the result table to sqlite3_free_table() in order to
1571** release the memory that was malloced. Because of the way the
drh33c1be32008-01-30 16:16:14 +00001572** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling
mihailimdb4f2ad2008-06-21 11:20:48 +00001573** function must not try to call [sqlite3_free()] directly. Only
drh33c1be32008-01-30 16:16:14 +00001574** [sqlite3_free_table()] is able to release the memory properly and safely.
drhe3710332000-09-29 13:30:53 +00001575**
drh33c1be32008-01-30 16:16:14 +00001576** The sqlite3_get_table() interface is implemented as a wrapper around
1577** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access
1578** to any internal data structures of SQLite. It uses only the public
1579** interface defined here. As a consequence, errors that occur in the
1580** wrapper layer outside of the internal [sqlite3_exec()] call are not
mihailimdb4f2ad2008-06-21 11:20:48 +00001581** reflected in subsequent calls to [sqlite3_errcode()] or [sqlite3_errmsg()].
drh33c1be32008-01-30 16:16:14 +00001582**
drh8b39db12009-02-18 18:37:58 +00001583** Requirements:
1584** [H12371] [H12373] [H12374] [H12376] [H12379] [H12382]
drhe3710332000-09-29 13:30:53 +00001585*/
danielk19776f8a5032004-05-10 10:34:51 +00001586int sqlite3_get_table(
drhcf538f42008-06-27 14:51:52 +00001587 sqlite3 *db, /* An open database */
1588 const char *zSql, /* SQL to be evaluated */
1589 char ***pazResult, /* Results of the query */
1590 int *pnRow, /* Number of result rows written here */
1591 int *pnColumn, /* Number of result columns written here */
1592 char **pzErrmsg /* Error msg written here */
drhe3710332000-09-29 13:30:53 +00001593);
danielk19776f8a5032004-05-10 10:34:51 +00001594void sqlite3_free_table(char **result);
drhe3710332000-09-29 13:30:53 +00001595
drha18c5682000-10-08 22:20:57 +00001596/*
drh9cd29642008-07-23 00:52:55 +00001597** CAPI3REF: Formatted String Printing Functions {H17400} <S70000><S20000>
drh6ed48bf2007-06-14 20:57:18 +00001598**
shane7c7c3112009-08-17 15:31:23 +00001599** These routines are work-alikes of the "printf()" family of functions
drh6ed48bf2007-06-14 20:57:18 +00001600** from the standard C library.
1601**
drh33c1be32008-01-30 16:16:14 +00001602** The sqlite3_mprintf() and sqlite3_vmprintf() routines write their
drh6d2069d2007-08-14 01:58:53 +00001603** results into memory obtained from [sqlite3_malloc()].
drh33c1be32008-01-30 16:16:14 +00001604** The strings returned by these two routines should be
mihailim04bcc002008-06-22 10:21:27 +00001605** released by [sqlite3_free()]. Both routines return a
drh6ed48bf2007-06-14 20:57:18 +00001606** NULL pointer if [sqlite3_malloc()] is unable to allocate enough
1607** memory to hold the resulting string.
1608**
drh33c1be32008-01-30 16:16:14 +00001609** In sqlite3_snprintf() routine is similar to "snprintf()" from
drh6ed48bf2007-06-14 20:57:18 +00001610** the standard C library. The result is written into the
1611** buffer supplied as the second parameter whose size is given by
drh33c1be32008-01-30 16:16:14 +00001612** the first parameter. Note that the order of the
drh6ed48bf2007-06-14 20:57:18 +00001613** first two parameters is reversed from snprintf(). This is an
1614** historical accident that cannot be fixed without breaking
drh33c1be32008-01-30 16:16:14 +00001615** backwards compatibility. Note also that sqlite3_snprintf()
drh6ed48bf2007-06-14 20:57:18 +00001616** returns a pointer to its buffer instead of the number of
drh33c1be32008-01-30 16:16:14 +00001617** characters actually written into the buffer. We admit that
drh6ed48bf2007-06-14 20:57:18 +00001618** the number of characters written would be a more useful return
1619** value but we cannot change the implementation of sqlite3_snprintf()
1620** now without breaking compatibility.
1621**
drh33c1be32008-01-30 16:16:14 +00001622** As long as the buffer size is greater than zero, sqlite3_snprintf()
1623** guarantees that the buffer is always zero-terminated. The first
drh6ed48bf2007-06-14 20:57:18 +00001624** parameter "n" is the total size of the buffer, including space for
drh33c1be32008-01-30 16:16:14 +00001625** the zero terminator. So the longest string that can be completely
drh6ed48bf2007-06-14 20:57:18 +00001626** written will be n-1 characters.
1627**
1628** These routines all implement some additional formatting
drh4f26d6c2004-05-26 23:25:30 +00001629** options that are useful for constructing SQL statements.
shane26b34032008-05-23 17:21:09 +00001630** All of the usual printf() formatting options apply. In addition, there
drh153c62c2007-08-24 03:51:33 +00001631** is are "%q", "%Q", and "%z" options.
drh6ed48bf2007-06-14 20:57:18 +00001632**
drh33c1be32008-01-30 16:16:14 +00001633** The %q option works like %s in that it substitutes a null-terminated
drh66b89c82000-11-28 20:47:17 +00001634** string from the argument list. But %q also doubles every '\'' character.
drh33c1be32008-01-30 16:16:14 +00001635** %q is designed for use inside a string literal. By doubling each '\''
drh66b89c82000-11-28 20:47:17 +00001636** character it escapes that character and allows it to be inserted into
drha18c5682000-10-08 22:20:57 +00001637** the string.
1638**
mihailimdb4f2ad2008-06-21 11:20:48 +00001639** For example, assume the string variable zText contains text as follows:
drha18c5682000-10-08 22:20:57 +00001640**
drh6ed48bf2007-06-14 20:57:18 +00001641** <blockquote><pre>
1642** char *zText = "It's a happy day!";
1643** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001644**
drh6ed48bf2007-06-14 20:57:18 +00001645** One can use this text in an SQL statement as follows:
drha18c5682000-10-08 22:20:57 +00001646**
drh6ed48bf2007-06-14 20:57:18 +00001647** <blockquote><pre>
1648** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText);
1649** sqlite3_exec(db, zSQL, 0, 0, 0);
1650** sqlite3_free(zSQL);
1651** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001652**
1653** Because the %q format string is used, the '\'' character in zText
1654** is escaped and the SQL generated is as follows:
1655**
drh6ed48bf2007-06-14 20:57:18 +00001656** <blockquote><pre>
1657** INSERT INTO table1 VALUES('It''s a happy day!')
1658** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001659**
1660** This is correct. Had we used %s instead of %q, the generated SQL
1661** would have looked like this:
1662**
drh6ed48bf2007-06-14 20:57:18 +00001663** <blockquote><pre>
1664** INSERT INTO table1 VALUES('It's a happy day!');
1665** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001666**
mihailimdb4f2ad2008-06-21 11:20:48 +00001667** This second example is an SQL syntax error. As a general rule you should
1668** always use %q instead of %s when inserting text into a string literal.
drh6ed48bf2007-06-14 20:57:18 +00001669**
drh33c1be32008-01-30 16:16:14 +00001670** The %Q option works like %q except it also adds single quotes around
mihailimdb4f2ad2008-06-21 11:20:48 +00001671** the outside of the total string. Additionally, if the parameter in the
1672** argument list is a NULL pointer, %Q substitutes the text "NULL" (without
mihailim04bcc002008-06-22 10:21:27 +00001673** single quotes) in place of the %Q option. So, for example, one could say:
drh6ed48bf2007-06-14 20:57:18 +00001674**
1675** <blockquote><pre>
1676** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText);
1677** sqlite3_exec(db, zSQL, 0, 0, 0);
1678** sqlite3_free(zSQL);
1679** </pre></blockquote>
1680**
1681** The code above will render a correct SQL statement in the zSQL
1682** variable even if the zText variable is a NULL pointer.
drh153c62c2007-08-24 03:51:33 +00001683**
drh33c1be32008-01-30 16:16:14 +00001684** The "%z" formatting option works exactly like "%s" with the
drh153c62c2007-08-24 03:51:33 +00001685** addition that after the string has been read and copied into
drhfddfa2d2007-12-05 18:05:16 +00001686** the result, [sqlite3_free()] is called on the input string. {END}
drh33c1be32008-01-30 16:16:14 +00001687**
drh8b39db12009-02-18 18:37:58 +00001688** Requirements:
1689** [H17403] [H17406] [H17407]
drha18c5682000-10-08 22:20:57 +00001690*/
danielk19776f8a5032004-05-10 10:34:51 +00001691char *sqlite3_mprintf(const char*,...);
1692char *sqlite3_vmprintf(const char*, va_list);
drhfeac5f82004-08-01 00:10:45 +00001693char *sqlite3_snprintf(int,char*,const char*, ...);
drh5191b7e2002-03-08 02:12:00 +00001694
drh28dd4792006-06-26 21:35:44 +00001695/*
drh9cd29642008-07-23 00:52:55 +00001696** CAPI3REF: Memory Allocation Subsystem {H17300} <S20000>
drhd84f9462007-08-15 11:28:56 +00001697**
drh33c1be32008-01-30 16:16:14 +00001698** The SQLite core uses these three routines for all of its own
1699** internal memory allocation needs. "Core" in the previous sentence
drhf5befa02007-12-06 02:42:07 +00001700** does not include operating-system specific VFS implementation. The
shane26b34032008-05-23 17:21:09 +00001701** Windows VFS uses native malloc() and free() for some operations.
drhd64621d2007-11-05 17:54:17 +00001702**
drh33c1be32008-01-30 16:16:14 +00001703** The sqlite3_malloc() routine returns a pointer to a block
drhfddfa2d2007-12-05 18:05:16 +00001704** of memory at least N bytes in length, where N is the parameter.
drh33c1be32008-01-30 16:16:14 +00001705** If sqlite3_malloc() is unable to obtain sufficient free
1706** memory, it returns a NULL pointer. If the parameter N to
drhfddfa2d2007-12-05 18:05:16 +00001707** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns
1708** a NULL pointer.
1709**
drh33c1be32008-01-30 16:16:14 +00001710** Calling sqlite3_free() with a pointer previously returned
drhfddfa2d2007-12-05 18:05:16 +00001711** by sqlite3_malloc() or sqlite3_realloc() releases that memory so
drh33c1be32008-01-30 16:16:14 +00001712** that it might be reused. The sqlite3_free() routine is
drhfddfa2d2007-12-05 18:05:16 +00001713** a no-op if is called with a NULL pointer. Passing a NULL pointer
drh33c1be32008-01-30 16:16:14 +00001714** to sqlite3_free() is harmless. After being freed, memory
drhfddfa2d2007-12-05 18:05:16 +00001715** should neither be read nor written. Even reading previously freed
1716** memory might result in a segmentation fault or other severe error.
drh33c1be32008-01-30 16:16:14 +00001717** Memory corruption, a segmentation fault, or other severe error
drhfddfa2d2007-12-05 18:05:16 +00001718** might result if sqlite3_free() is called with a non-NULL pointer that
drh7b228b32008-10-17 15:10:37 +00001719** was not obtained from sqlite3_malloc() or sqlite3_realloc().
drhfddfa2d2007-12-05 18:05:16 +00001720**
drh33c1be32008-01-30 16:16:14 +00001721** The sqlite3_realloc() interface attempts to resize a
drhfddfa2d2007-12-05 18:05:16 +00001722** prior memory allocation to be at least N bytes, where N is the
1723** second parameter. The memory allocation to be resized is the first
drh33c1be32008-01-30 16:16:14 +00001724** parameter. If the first parameter to sqlite3_realloc()
drhfddfa2d2007-12-05 18:05:16 +00001725** is a NULL pointer then its behavior is identical to calling
1726** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc().
drh33c1be32008-01-30 16:16:14 +00001727** If the second parameter to sqlite3_realloc() is zero or
drhfddfa2d2007-12-05 18:05:16 +00001728** negative then the behavior is exactly the same as calling
1729** sqlite3_free(P) where P is the first parameter to sqlite3_realloc().
mihailimdb4f2ad2008-06-21 11:20:48 +00001730** sqlite3_realloc() returns a pointer to a memory allocation
drhfddfa2d2007-12-05 18:05:16 +00001731** of at least N bytes in size or NULL if sufficient memory is unavailable.
drh33c1be32008-01-30 16:16:14 +00001732** If M is the size of the prior allocation, then min(N,M) bytes
drhfddfa2d2007-12-05 18:05:16 +00001733** of the prior allocation are copied into the beginning of buffer returned
1734** by sqlite3_realloc() and the prior allocation is freed.
drh33c1be32008-01-30 16:16:14 +00001735** If sqlite3_realloc() returns NULL, then the prior allocation
drhfddfa2d2007-12-05 18:05:16 +00001736** is not freed.
1737**
drh33c1be32008-01-30 16:16:14 +00001738** The memory returned by sqlite3_malloc() and sqlite3_realloc()
drhf5befa02007-12-06 02:42:07 +00001739** is always aligned to at least an 8 byte boundary. {END}
1740**
mihailimdb4f2ad2008-06-21 11:20:48 +00001741** The default implementation of the memory allocation subsystem uses
1742** the malloc(), realloc() and free() provided by the standard C library.
drh9a247912008-07-22 18:45:08 +00001743** {H17382} However, if SQLite is compiled with the
mihailimdb4f2ad2008-06-21 11:20:48 +00001744** SQLITE_MEMORY_SIZE=<i>NNN</i> C preprocessor macro (where <i>NNN</i>
1745** is an integer), then SQLite create a static array of at least
1746** <i>NNN</i> bytes in size and uses that array for all of its dynamic
1747** memory allocation needs. {END} Additional memory allocator options
1748** may be added in future releases.
drhd64621d2007-11-05 17:54:17 +00001749**
1750** In SQLite version 3.5.0 and 3.5.1, it was possible to define
1751** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in
1752** implementation of these routines to be omitted. That capability
mihailimdb4f2ad2008-06-21 11:20:48 +00001753** is no longer provided. Only built-in memory allocators can be used.
drh8bacf972007-08-25 16:21:29 +00001754**
shane26b34032008-05-23 17:21:09 +00001755** The Windows OS interface layer calls
drh8bacf972007-08-25 16:21:29 +00001756** the system malloc() and free() directly when converting
1757** filenames between the UTF-8 encoding used by SQLite
shane26b34032008-05-23 17:21:09 +00001758** and whatever filename encoding is used by the particular Windows
drh8bacf972007-08-25 16:21:29 +00001759** installation. Memory allocation errors are detected, but
1760** they are reported back as [SQLITE_CANTOPEN] or
1761** [SQLITE_IOERR] rather than [SQLITE_NOMEM].
drh33c1be32008-01-30 16:16:14 +00001762**
drh8b39db12009-02-18 18:37:58 +00001763** Requirements:
1764** [H17303] [H17304] [H17305] [H17306] [H17310] [H17312] [H17315] [H17318]
1765** [H17321] [H17322] [H17323]
drh33c1be32008-01-30 16:16:14 +00001766**
drh8b39db12009-02-18 18:37:58 +00001767** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()]
1768** must be either NULL or else pointers obtained from a prior
1769** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have
1770** not yet been released.
drh33c1be32008-01-30 16:16:14 +00001771**
drh8b39db12009-02-18 18:37:58 +00001772** The application must not read or write any part of
1773** a block of memory after it has been released using
1774** [sqlite3_free()] or [sqlite3_realloc()].
drh28dd4792006-06-26 21:35:44 +00001775*/
drhf3a65f72007-08-22 20:18:21 +00001776void *sqlite3_malloc(int);
1777void *sqlite3_realloc(void*, int);
drh28dd4792006-06-26 21:35:44 +00001778void sqlite3_free(void*);
1779
drh5191b7e2002-03-08 02:12:00 +00001780/*
drh9cd29642008-07-23 00:52:55 +00001781** CAPI3REF: Memory Allocator Statistics {H17370} <S30210>
drhd84f9462007-08-15 11:28:56 +00001782**
drh33c1be32008-01-30 16:16:14 +00001783** SQLite provides these two interfaces for reporting on the status
1784** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()]
mihailimdb4f2ad2008-06-21 11:20:48 +00001785** routines, which form the built-in memory allocation subsystem.
drhd84f9462007-08-15 11:28:56 +00001786**
drh8b39db12009-02-18 18:37:58 +00001787** Requirements:
1788** [H17371] [H17373] [H17374] [H17375]
drhd84f9462007-08-15 11:28:56 +00001789*/
drh153c62c2007-08-24 03:51:33 +00001790sqlite3_int64 sqlite3_memory_used(void);
1791sqlite3_int64 sqlite3_memory_highwater(int resetFlag);
drhd84f9462007-08-15 11:28:56 +00001792
1793/*
drh9cd29642008-07-23 00:52:55 +00001794** CAPI3REF: Pseudo-Random Number Generator {H17390} <S20000>
drh2fa18682008-03-19 14:15:34 +00001795**
1796** SQLite contains a high-quality pseudo-random number generator (PRNG) used to
drh49c3d572008-12-15 22:51:38 +00001797** select random [ROWID | ROWIDs] when inserting new records into a table that
1798** already uses the largest possible [ROWID]. The PRNG is also used for
drh2fa18682008-03-19 14:15:34 +00001799** the build-in random() and randomblob() SQL functions. This interface allows
shane26b34032008-05-23 17:21:09 +00001800** applications to access the same PRNG for other purposes.
drh2fa18682008-03-19 14:15:34 +00001801**
1802** A call to this routine stores N bytes of randomness into buffer P.
1803**
1804** The first time this routine is invoked (either internally or by
1805** the application) the PRNG is seeded using randomness obtained
1806** from the xRandomness method of the default [sqlite3_vfs] object.
1807** On all subsequent invocations, the pseudo-randomness is generated
1808** internally and without recourse to the [sqlite3_vfs] xRandomness
1809** method.
1810**
drh8b39db12009-02-18 18:37:58 +00001811** Requirements:
1812** [H17392]
drh2fa18682008-03-19 14:15:34 +00001813*/
1814void sqlite3_randomness(int N, void *P);
1815
1816/*
drh9cd29642008-07-23 00:52:55 +00001817** CAPI3REF: Compile-Time Authorization Callbacks {H12500} <S70100>
drhfddfa2d2007-12-05 18:05:16 +00001818**
drh33c1be32008-01-30 16:16:14 +00001819** This routine registers a authorizer callback with a particular
drhf47ce562008-03-20 18:00:49 +00001820** [database connection], supplied in the first argument.
drh6ed48bf2007-06-14 20:57:18 +00001821** The authorizer callback is invoked as SQL statements are being compiled
1822** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()],
drh33c1be32008-01-30 16:16:14 +00001823** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. At various
drh6ed48bf2007-06-14 20:57:18 +00001824** points during the compilation process, as logic is being created
1825** to perform various actions, the authorizer callback is invoked to
drhf5befa02007-12-06 02:42:07 +00001826** see if those actions are allowed. The authorizer callback should
drhf47ce562008-03-20 18:00:49 +00001827** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the
drh6ed48bf2007-06-14 20:57:18 +00001828** specific action but allow the SQL statement to continue to be
1829** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be
mihailima3f64902008-06-21 13:35:56 +00001830** rejected with an error. If the authorizer callback returns
drhf5befa02007-12-06 02:42:07 +00001831** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY]
mihailima3f64902008-06-21 13:35:56 +00001832** then the [sqlite3_prepare_v2()] or equivalent call that triggered
drh33c1be32008-01-30 16:16:14 +00001833** the authorizer will fail with an error message.
drh6ed48bf2007-06-14 20:57:18 +00001834**
drhf5befa02007-12-06 02:42:07 +00001835** When the callback returns [SQLITE_OK], that means the operation
drh33c1be32008-01-30 16:16:14 +00001836** requested is ok. When the callback returns [SQLITE_DENY], the
drhf5befa02007-12-06 02:42:07 +00001837** [sqlite3_prepare_v2()] or equivalent call that triggered the
drh33c1be32008-01-30 16:16:14 +00001838** authorizer will fail with an error message explaining that
drh959b5302009-04-30 15:59:56 +00001839** access is denied.
drh6ed48bf2007-06-14 20:57:18 +00001840**
mihailima3f64902008-06-21 13:35:56 +00001841** The first parameter to the authorizer callback is a copy of the third
1842** parameter to the sqlite3_set_authorizer() interface. The second parameter
1843** to the callback is an integer [SQLITE_COPY | action code] that specifies
1844** the particular action to be authorized. The third through sixth parameters
1845** to the callback are zero-terminated strings that contain additional
1846** details about the action to be authorized.
drh6ed48bf2007-06-14 20:57:18 +00001847**
drh959b5302009-04-30 15:59:56 +00001848** If the action code is [SQLITE_READ]
1849** and the callback returns [SQLITE_IGNORE] then the
1850** [prepared statement] statement is constructed to substitute
1851** a NULL value in place of the table column that would have
1852** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE]
1853** return can be used to deny an untrusted user access to individual
1854** columns of a table.
1855** If the action code is [SQLITE_DELETE] and the callback returns
1856** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the
1857** [truncate optimization] is disabled and all rows are deleted individually.
1858**
drhf47ce562008-03-20 18:00:49 +00001859** An authorizer is used when [sqlite3_prepare | preparing]
mihailimebe796c2008-06-21 20:11:17 +00001860** SQL statements from an untrusted source, to ensure that the SQL statements
1861** do not try to access data they are not allowed to see, or that they do not
1862** try to execute malicious statements that damage the database. For
drh6ed48bf2007-06-14 20:57:18 +00001863** example, an application may allow a user to enter arbitrary
1864** SQL queries for evaluation by a database. But the application does
1865** not want the user to be able to make arbitrary changes to the
1866** database. An authorizer could then be put in place while the
drhf47ce562008-03-20 18:00:49 +00001867** user-entered SQL is being [sqlite3_prepare | prepared] that
1868** disallows everything except [SELECT] statements.
1869**
1870** Applications that need to process SQL from untrusted sources
1871** might also consider lowering resource limits using [sqlite3_limit()]
1872** and limiting database size using the [max_page_count] [PRAGMA]
1873** in addition to using an authorizer.
drh6ed48bf2007-06-14 20:57:18 +00001874**
drh33c1be32008-01-30 16:16:14 +00001875** Only a single authorizer can be in place on a database connection
drh6ed48bf2007-06-14 20:57:18 +00001876** at a time. Each call to sqlite3_set_authorizer overrides the
drh33c1be32008-01-30 16:16:14 +00001877** previous call. Disable the authorizer by installing a NULL callback.
1878** The authorizer is disabled by default.
drh6ed48bf2007-06-14 20:57:18 +00001879**
drhc8075422008-09-10 13:09:23 +00001880** The authorizer callback must not do anything that will modify
1881** the database connection that invoked the authorizer callback.
1882** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
1883** database connections for the meaning of "modify" in this paragraph.
1884**
drh7b37c5d2008-08-12 14:51:29 +00001885** When [sqlite3_prepare_v2()] is used to prepare a statement, the
shane7c7c3112009-08-17 15:31:23 +00001886** statement might be re-prepared during [sqlite3_step()] due to a
drh7b37c5d2008-08-12 14:51:29 +00001887** schema change. Hence, the application should ensure that the
1888** correct authorizer callback remains in place during the [sqlite3_step()].
1889**
mihailima3f64902008-06-21 13:35:56 +00001890** Note that the authorizer callback is invoked only during
drh33c1be32008-01-30 16:16:14 +00001891** [sqlite3_prepare()] or its variants. Authorization is not
drh959b5302009-04-30 15:59:56 +00001892** performed during statement evaluation in [sqlite3_step()], unless
1893** as stated in the previous paragraph, sqlite3_step() invokes
1894** sqlite3_prepare_v2() to reprepare a statement after a schema change.
drh33c1be32008-01-30 16:16:14 +00001895**
drh8b39db12009-02-18 18:37:58 +00001896** Requirements:
1897** [H12501] [H12502] [H12503] [H12504] [H12505] [H12506] [H12507] [H12510]
1898** [H12511] [H12512] [H12520] [H12521] [H12522]
drhed6c8672003-01-12 18:02:16 +00001899*/
danielk19776f8a5032004-05-10 10:34:51 +00001900int sqlite3_set_authorizer(
danielk1977f9d64d22004-06-19 08:18:07 +00001901 sqlite3*,
drhe22a3342003-04-22 20:30:37 +00001902 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
drhe5f9c642003-01-13 23:27:31 +00001903 void *pUserData
drhed6c8672003-01-12 18:02:16 +00001904);
1905
1906/*
drh9cd29642008-07-23 00:52:55 +00001907** CAPI3REF: Authorizer Return Codes {H12590} <H12500>
drh6ed48bf2007-06-14 20:57:18 +00001908**
1909** The [sqlite3_set_authorizer | authorizer callback function] must
1910** return either [SQLITE_OK] or one of these two constants in order
1911** to signal SQLite whether or not the action is permitted. See the
1912** [sqlite3_set_authorizer | authorizer documentation] for additional
1913** information.
1914*/
1915#define SQLITE_DENY 1 /* Abort the SQL statement with an error */
1916#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
1917
1918/*
drh9cd29642008-07-23 00:52:55 +00001919** CAPI3REF: Authorizer Action Codes {H12550} <H12500>
drh6ed48bf2007-06-14 20:57:18 +00001920**
1921** The [sqlite3_set_authorizer()] interface registers a callback function
mihailima3f64902008-06-21 13:35:56 +00001922** that is invoked to authorize certain SQL statement actions. The
drh6ed48bf2007-06-14 20:57:18 +00001923** second parameter to the callback is an integer code that specifies
1924** what action is being authorized. These are the integer action codes that
drh33c1be32008-01-30 16:16:14 +00001925** the authorizer callback may be passed.
drh6ed48bf2007-06-14 20:57:18 +00001926**
mihailima3f64902008-06-21 13:35:56 +00001927** These action code values signify what kind of operation is to be
drh33c1be32008-01-30 16:16:14 +00001928** authorized. The 3rd and 4th parameters to the authorization
drhf5befa02007-12-06 02:42:07 +00001929** callback function will be parameters or NULL depending on which of these
drh33c1be32008-01-30 16:16:14 +00001930** codes is used as the second parameter. The 5th parameter to the
mihailima3f64902008-06-21 13:35:56 +00001931** authorizer callback is the name of the database ("main", "temp",
drh33c1be32008-01-30 16:16:14 +00001932** etc.) if applicable. The 6th parameter to the authorizer callback
drh5cf590c2003-04-24 01:45:04 +00001933** is the name of the inner-most trigger or view that is responsible for
mihailima3f64902008-06-21 13:35:56 +00001934** the access attempt or NULL if this access attempt is directly from
drh6ed48bf2007-06-14 20:57:18 +00001935** top-level SQL code.
drh33c1be32008-01-30 16:16:14 +00001936**
drh8b39db12009-02-18 18:37:58 +00001937** Requirements:
1938** [H12551] [H12552] [H12553] [H12554]
drhed6c8672003-01-12 18:02:16 +00001939*/
drh6ed48bf2007-06-14 20:57:18 +00001940/******************************************* 3rd ************ 4th ***********/
drhe5f9c642003-01-13 23:27:31 +00001941#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */
1942#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */
1943#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */
1944#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +00001945#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00001946#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */
drh77ad4e42003-01-14 02:49:27 +00001947#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00001948#define SQLITE_CREATE_VIEW 8 /* View Name NULL */
1949#define SQLITE_DELETE 9 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +00001950#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00001951#define SQLITE_DROP_TABLE 11 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +00001952#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00001953#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +00001954#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00001955#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */
drh77ad4e42003-01-14 02:49:27 +00001956#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00001957#define SQLITE_DROP_VIEW 17 /* View Name NULL */
1958#define SQLITE_INSERT 18 /* Table Name NULL */
1959#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */
1960#define SQLITE_READ 20 /* Table Name Column Name */
1961#define SQLITE_SELECT 21 /* NULL NULL */
danielk1977ab9b7032008-12-30 06:24:58 +00001962#define SQLITE_TRANSACTION 22 /* Operation NULL */
drhe5f9c642003-01-13 23:27:31 +00001963#define SQLITE_UPDATE 23 /* Table Name Column Name */
drh81e293b2003-06-06 19:00:42 +00001964#define SQLITE_ATTACH 24 /* Filename NULL */
1965#define SQLITE_DETACH 25 /* Database Name NULL */
danielk19771c8c23c2004-11-12 15:53:37 +00001966#define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */
danielk19771d54df82004-11-23 15:41:16 +00001967#define SQLITE_REINDEX 27 /* Index Name NULL */
drhe6e04962005-07-23 02:17:03 +00001968#define SQLITE_ANALYZE 28 /* Table Name NULL */
danielk1977f1a381e2006-06-16 08:01:02 +00001969#define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */
1970#define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */
drh2e904c52008-11-10 23:54:05 +00001971#define SQLITE_FUNCTION 31 /* NULL Function Name */
danielk1977ab9b7032008-12-30 06:24:58 +00001972#define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */
drh6ed48bf2007-06-14 20:57:18 +00001973#define SQLITE_COPY 0 /* No longer used */
drhed6c8672003-01-12 18:02:16 +00001974
1975/*
drh9cd29642008-07-23 00:52:55 +00001976** CAPI3REF: Tracing And Profiling Functions {H12280} <S60400>
drhd5a68d32008-08-04 13:44:57 +00001977** EXPERIMENTAL
drh6ed48bf2007-06-14 20:57:18 +00001978**
1979** These routines register callback functions that can be used for
1980** tracing and profiling the execution of SQL statements.
drhfddfa2d2007-12-05 18:05:16 +00001981**
drh33c1be32008-01-30 16:16:14 +00001982** The callback function registered by sqlite3_trace() is invoked at
1983** various times when an SQL statement is being run by [sqlite3_step()].
1984** The callback returns a UTF-8 rendering of the SQL statement text
1985** as the statement first begins executing. Additional callbacks occur
shane26b34032008-05-23 17:21:09 +00001986** as each triggered subprogram is entered. The callbacks for triggers
drh33c1be32008-01-30 16:16:14 +00001987** contain a UTF-8 SQL comment that identifies the trigger.
mihailima3f64902008-06-21 13:35:56 +00001988**
drh33c1be32008-01-30 16:16:14 +00001989** The callback function registered by sqlite3_profile() is invoked
1990** as each SQL statement finishes. The profile callback contains
1991** the original statement text and an estimate of wall-clock time
1992** of how long that statement took to run.
drh19e2d372005-08-29 23:00:03 +00001993**
drh8b39db12009-02-18 18:37:58 +00001994** Requirements:
1995** [H12281] [H12282] [H12283] [H12284] [H12285] [H12287] [H12288] [H12289]
1996** [H12290]
drh18de4822003-01-16 16:28:53 +00001997*/
shanea79c3cc2008-08-11 17:27:01 +00001998SQLITE_EXPERIMENTAL void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*);
1999SQLITE_EXPERIMENTAL void *sqlite3_profile(sqlite3*,
drh6d2069d2007-08-14 01:58:53 +00002000 void(*xProfile)(void*,const char*,sqlite3_uint64), void*);
drh18de4822003-01-16 16:28:53 +00002001
danielk1977348bb5d2003-10-18 09:37:26 +00002002/*
drh9cd29642008-07-23 00:52:55 +00002003** CAPI3REF: Query Progress Callbacks {H12910} <S60400>
drh6ed48bf2007-06-14 20:57:18 +00002004**
drh33c1be32008-01-30 16:16:14 +00002005** This routine configures a callback function - the
drhfddfa2d2007-12-05 18:05:16 +00002006** progress callback - that is invoked periodically during long
2007** running calls to [sqlite3_exec()], [sqlite3_step()] and
mihailima3f64902008-06-21 13:35:56 +00002008** [sqlite3_get_table()]. An example use for this
drh6ed48bf2007-06-14 20:57:18 +00002009** interface is to keep a GUI updated during a large query.
danielk1977348bb5d2003-10-18 09:37:26 +00002010**
shane236ce972008-05-30 15:35:30 +00002011** If the progress callback returns non-zero, the operation is
drh33c1be32008-01-30 16:16:14 +00002012** interrupted. This feature can be used to implement a
drhc8075422008-09-10 13:09:23 +00002013** "Cancel" button on a GUI progress dialog box.
2014**
2015** The progress handler must not do anything that will modify
2016** the database connection that invoked the progress handler.
2017** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
2018** database connections for the meaning of "modify" in this paragraph.
danielk1977348bb5d2003-10-18 09:37:26 +00002019**
drh8b39db12009-02-18 18:37:58 +00002020** Requirements:
2021** [H12911] [H12912] [H12913] [H12914] [H12915] [H12916] [H12917] [H12918]
drh33c1be32008-01-30 16:16:14 +00002022**
danielk1977348bb5d2003-10-18 09:37:26 +00002023*/
danielk1977f9d64d22004-06-19 08:18:07 +00002024void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
danielk1977348bb5d2003-10-18 09:37:26 +00002025
drhaa940ea2004-01-15 02:44:03 +00002026/*
drh9cd29642008-07-23 00:52:55 +00002027** CAPI3REF: Opening A New Database Connection {H12700} <S40200>
drhaa940ea2004-01-15 02:44:03 +00002028**
mihailima3f64902008-06-21 13:35:56 +00002029** These routines open an SQLite database file whose name is given by the
2030** filename argument. The filename argument is interpreted as UTF-8 for
2031** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte
2032** order for sqlite3_open16(). A [database connection] handle is usually
2033** returned in *ppDb, even if an error occurs. The only exception is that
2034** if SQLite is unable to allocate memory to hold the [sqlite3] object,
2035** a NULL will be written into *ppDb instead of a pointer to the [sqlite3]
2036** object. If the database is opened (and/or created) successfully, then
mihailimefc8e8a2008-06-21 16:47:09 +00002037** [SQLITE_OK] is returned. Otherwise an [error code] is returned. The
mihailima3f64902008-06-21 13:35:56 +00002038** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain
drh4f26d6c2004-05-26 23:25:30 +00002039** an English language description of the error.
drh22fbcb82004-02-01 01:22:50 +00002040**
drh33c1be32008-01-30 16:16:14 +00002041** The default encoding for the database will be UTF-8 if
mihailima3f64902008-06-21 13:35:56 +00002042** sqlite3_open() or sqlite3_open_v2() is called and
2043** UTF-16 in the native byte order if sqlite3_open16() is used.
danielk197765904932004-05-26 06:18:37 +00002044**
drh33c1be32008-01-30 16:16:14 +00002045** Whether or not an error occurs when it is opened, resources
mihailima3f64902008-06-21 13:35:56 +00002046** associated with the [database connection] handle should be released by
2047** passing it to [sqlite3_close()] when it is no longer required.
drh6d2069d2007-08-14 01:58:53 +00002048**
mihailima3f64902008-06-21 13:35:56 +00002049** The sqlite3_open_v2() interface works like sqlite3_open()
shane26b34032008-05-23 17:21:09 +00002050** except that it accepts two additional parameters for additional control
danielk19779a6284c2008-07-10 17:52:49 +00002051** over the new database connection. The flags parameter can take one of
2052** the following three values, optionally combined with the
drhafacce02008-09-02 21:35:03 +00002053** [SQLITE_OPEN_NOMUTEX] or [SQLITE_OPEN_FULLMUTEX] flags:
drh6d2069d2007-08-14 01:58:53 +00002054**
mihailima3f64902008-06-21 13:35:56 +00002055** <dl>
2056** <dt>[SQLITE_OPEN_READONLY]</dt>
2057** <dd>The database is opened in read-only mode. If the database does not
2058** already exist, an error is returned.</dd>
drh6d2069d2007-08-14 01:58:53 +00002059**
mihailima3f64902008-06-21 13:35:56 +00002060** <dt>[SQLITE_OPEN_READWRITE]</dt>
2061** <dd>The database is opened for reading and writing if possible, or reading
2062** only if the file is write protected by the operating system. In either
2063** case the database must already exist, otherwise an error is returned.</dd>
drh9da9d962007-08-28 15:47:44 +00002064**
mihailima3f64902008-06-21 13:35:56 +00002065** <dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt>
2066** <dd>The database is opened for reading and writing, and is creates it if
2067** it does not already exist. This is the behavior that is always used for
2068** sqlite3_open() and sqlite3_open16().</dd>
2069** </dl>
2070**
2071** If the 3rd parameter to sqlite3_open_v2() is not one of the
danielk19779a6284c2008-07-10 17:52:49 +00002072** combinations shown above or one of the combinations shown above combined
drhafacce02008-09-02 21:35:03 +00002073** with the [SQLITE_OPEN_NOMUTEX] or [SQLITE_OPEN_FULLMUTEX] flags,
2074** then the behavior is undefined.
danielk19779a6284c2008-07-10 17:52:49 +00002075**
drhafacce02008-09-02 21:35:03 +00002076** If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection
2077** opens in the multi-thread [threading mode] as long as the single-thread
2078** mode has not been set at compile-time or start-time. If the
2079** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens
2080** in the serialized [threading mode] unless single-thread was
2081** previously selected at compile-time or start-time.
drhd9b97cf2008-04-10 13:38:17 +00002082**
mihailima3f64902008-06-21 13:35:56 +00002083** If the filename is ":memory:", then a private, temporary in-memory database
2084** is created for the connection. This in-memory database will vanish when
2085** the database connection is closed. Future versions of SQLite might
2086** make use of additional special filenames that begin with the ":" character.
2087** It is recommended that when a database filename actually does begin with
2088** a ":" character you should prefix the filename with a pathname such as
2089** "./" to avoid ambiguity.
drh6d2069d2007-08-14 01:58:53 +00002090**
mihailima3f64902008-06-21 13:35:56 +00002091** If the filename is an empty string, then a private, temporary
drh33c1be32008-01-30 16:16:14 +00002092** on-disk database will be created. This private database will be
drh3f3b6352007-09-03 20:32:45 +00002093** automatically deleted as soon as the database connection is closed.
2094**
drh33c1be32008-01-30 16:16:14 +00002095** The fourth parameter to sqlite3_open_v2() is the name of the
mihailima3f64902008-06-21 13:35:56 +00002096** [sqlite3_vfs] object that defines the operating system interface that
2097** the new database connection should use. If the fourth parameter is
2098** a NULL pointer then the default [sqlite3_vfs] object is used.
drh6ed48bf2007-06-14 20:57:18 +00002099**
shane26b34032008-05-23 17:21:09 +00002100** <b>Note to Windows users:</b> The encoding used for the filename argument
mihailima3f64902008-06-21 13:35:56 +00002101** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever
drh9da9d962007-08-28 15:47:44 +00002102** codepage is currently defined. Filenames containing international
2103** characters must be converted to UTF-8 prior to passing them into
mihailima3f64902008-06-21 13:35:56 +00002104** sqlite3_open() or sqlite3_open_v2().
drh33c1be32008-01-30 16:16:14 +00002105**
drh8b39db12009-02-18 18:37:58 +00002106** Requirements:
2107** [H12701] [H12702] [H12703] [H12704] [H12706] [H12707] [H12709] [H12711]
2108** [H12712] [H12713] [H12714] [H12717] [H12719] [H12721] [H12723]
danielk197765904932004-05-26 06:18:37 +00002109*/
2110int sqlite3_open(
2111 const char *filename, /* Database filename (UTF-8) */
danielk19774f057f92004-06-08 00:02:33 +00002112 sqlite3 **ppDb /* OUT: SQLite db handle */
danielk197765904932004-05-26 06:18:37 +00002113);
danielk197765904932004-05-26 06:18:37 +00002114int sqlite3_open16(
2115 const void *filename, /* Database filename (UTF-16) */
danielk19774f057f92004-06-08 00:02:33 +00002116 sqlite3 **ppDb /* OUT: SQLite db handle */
danielk197765904932004-05-26 06:18:37 +00002117);
drh6d2069d2007-08-14 01:58:53 +00002118int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00002119 const char *filename, /* Database filename (UTF-8) */
drh6d2069d2007-08-14 01:58:53 +00002120 sqlite3 **ppDb, /* OUT: SQLite db handle */
2121 int flags, /* Flags */
drhd84f9462007-08-15 11:28:56 +00002122 const char *zVfs /* Name of VFS module to use */
drh6d2069d2007-08-14 01:58:53 +00002123);
danielk1977295ba552004-05-19 10:34:51 +00002124
danielk197765904932004-05-26 06:18:37 +00002125/*
drh9cd29642008-07-23 00:52:55 +00002126** CAPI3REF: Error Codes And Messages {H12800} <S60200>
drh6ed48bf2007-06-14 20:57:18 +00002127**
mihailimefc8e8a2008-06-21 16:47:09 +00002128** The sqlite3_errcode() interface returns the numeric [result code] or
2129** [extended result code] for the most recent failed sqlite3_* API call
2130** associated with a [database connection]. If a prior API call failed
2131** but the most recent API call succeeded, the return value from
drh99dfe5e2008-10-30 15:03:15 +00002132** sqlite3_errcode() is undefined. The sqlite3_extended_errcode()
2133** interface is the same except that it always returns the
2134** [extended result code] even when extended result codes are
2135** disabled.
drh6ed48bf2007-06-14 20:57:18 +00002136**
drh33c1be32008-01-30 16:16:14 +00002137** The sqlite3_errmsg() and sqlite3_errmsg16() return English-language
mihailimebe796c2008-06-21 20:11:17 +00002138** text that describes the error, as either UTF-8 or UTF-16 respectively.
drh33c1be32008-01-30 16:16:14 +00002139** Memory to hold the error message string is managed internally.
mihailimefc8e8a2008-06-21 16:47:09 +00002140** The application does not need to worry about freeing the result.
mlcreech27358862008-03-01 23:34:46 +00002141** However, the error string might be overwritten or deallocated by
drh33c1be32008-01-30 16:16:14 +00002142** subsequent calls to other SQLite interface functions.
danielk197765904932004-05-26 06:18:37 +00002143**
drh2838b472008-11-04 14:48:22 +00002144** When the serialized [threading mode] is in use, it might be the
2145** case that a second error occurs on a separate thread in between
2146** the time of the first error and the call to these interfaces.
2147** When that happens, the second error will be reported since these
2148** interfaces always report the most recent result. To avoid
2149** this, each thread can obtain exclusive use of the [database connection] D
2150** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning
2151** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after
2152** all calls to the interfaces listed here are completed.
2153**
drhd55d57e2008-07-07 17:53:07 +00002154** If an interface fails with SQLITE_MISUSE, that means the interface
2155** was invoked incorrectly by the application. In that case, the
2156** error code and message may or may not be set.
2157**
drh8b39db12009-02-18 18:37:58 +00002158** Requirements:
2159** [H12801] [H12802] [H12803] [H12807] [H12808] [H12809]
danielk197765904932004-05-26 06:18:37 +00002160*/
2161int sqlite3_errcode(sqlite3 *db);
drh99dfe5e2008-10-30 15:03:15 +00002162int sqlite3_extended_errcode(sqlite3 *db);
danielk197765904932004-05-26 06:18:37 +00002163const char *sqlite3_errmsg(sqlite3*);
danielk197765904932004-05-26 06:18:37 +00002164const void *sqlite3_errmsg16(sqlite3*);
2165
2166/*
drh9cd29642008-07-23 00:52:55 +00002167** CAPI3REF: SQL Statement Object {H13000} <H13010>
drh33c1be32008-01-30 16:16:14 +00002168** KEYWORDS: {prepared statement} {prepared statements}
drh6ed48bf2007-06-14 20:57:18 +00002169**
mihailimefc8e8a2008-06-21 16:47:09 +00002170** An instance of this object represents a single SQL statement.
2171** This object is variously known as a "prepared statement" or a
drh6ed48bf2007-06-14 20:57:18 +00002172** "compiled SQL statement" or simply as a "statement".
mihailimefc8e8a2008-06-21 16:47:09 +00002173**
drh6ed48bf2007-06-14 20:57:18 +00002174** The life of a statement object goes something like this:
2175**
2176** <ol>
2177** <li> Create the object using [sqlite3_prepare_v2()] or a related
2178** function.
mihailimefc8e8a2008-06-21 16:47:09 +00002179** <li> Bind values to [host parameters] using the sqlite3_bind_*()
2180** interfaces.
drh6ed48bf2007-06-14 20:57:18 +00002181** <li> Run the SQL by calling [sqlite3_step()] one or more times.
2182** <li> Reset the statement using [sqlite3_reset()] then go back
2183** to step 2. Do this zero or more times.
2184** <li> Destroy the object using [sqlite3_finalize()].
2185** </ol>
2186**
2187** Refer to documentation on individual methods above for additional
2188** information.
danielk197765904932004-05-26 06:18:37 +00002189*/
danielk1977fc57d7b2004-05-26 02:04:57 +00002190typedef struct sqlite3_stmt sqlite3_stmt;
2191
danielk1977e3209e42004-05-20 01:40:18 +00002192/*
drh9cd29642008-07-23 00:52:55 +00002193** CAPI3REF: Run-time Limits {H12760} <S20600>
drhcaa639f2008-03-20 00:32:20 +00002194**
2195** This interface allows the size of various constructs to be limited
2196** on a connection by connection basis. The first parameter is the
2197** [database connection] whose limit is to be set or queried. The
2198** second parameter is one of the [limit categories] that define a
2199** class of constructs to be size limited. The third parameter is the
2200** new limit for that construct. The function returns the old limit.
2201**
2202** If the new limit is a negative number, the limit is unchanged.
drhae1a8802009-02-11 15:04:40 +00002203** For the limit category of SQLITE_LIMIT_XYZ there is a
2204** [limits | hard upper bound]
2205** set by a compile-time C preprocessor macro named
2206** [limits | SQLITE_MAX_XYZ].
drhf47ce562008-03-20 18:00:49 +00002207** (The "_LIMIT_" in the name is changed to "_MAX_".)
2208** Attempts to increase a limit above its hard upper bound are
2209** silently truncated to the hard upper limit.
drhcaa639f2008-03-20 00:32:20 +00002210**
drhbb4957f2008-03-20 14:03:29 +00002211** Run time limits are intended for use in applications that manage
2212** both their own internal database and also databases that are controlled
2213** by untrusted external sources. An example application might be a
drh46f33ef2009-02-11 15:23:35 +00002214** web browser that has its own databases for storing history and
shane26b34032008-05-23 17:21:09 +00002215** separate databases controlled by JavaScript applications downloaded
shane236ce972008-05-30 15:35:30 +00002216** off the Internet. The internal databases can be given the
drhbb4957f2008-03-20 14:03:29 +00002217** large, default limits. Databases managed by external sources can
2218** be given much smaller limits designed to prevent a denial of service
mihailimefc8e8a2008-06-21 16:47:09 +00002219** attack. Developers might also want to use the [sqlite3_set_authorizer()]
drhf47ce562008-03-20 18:00:49 +00002220** interface to further control untrusted SQL. The size of the database
2221** created by an untrusted script can be contained using the
2222** [max_page_count] [PRAGMA].
drhbb4957f2008-03-20 14:03:29 +00002223**
drha911abe2008-07-16 13:29:51 +00002224** New run-time limit categories may be added in future releases.
drhcaa639f2008-03-20 00:32:20 +00002225**
drh8b39db12009-02-18 18:37:58 +00002226** Requirements:
2227** [H12762] [H12766] [H12769]
drhcaa639f2008-03-20 00:32:20 +00002228*/
2229int sqlite3_limit(sqlite3*, int id, int newVal);
2230
2231/*
drh9cd29642008-07-23 00:52:55 +00002232** CAPI3REF: Run-Time Limit Categories {H12790} <H12760>
drhcaa639f2008-03-20 00:32:20 +00002233** KEYWORDS: {limit category} {limit categories}
mihailimefc8e8a2008-06-21 16:47:09 +00002234**
drh46f33ef2009-02-11 15:23:35 +00002235** These constants define various performance limits
2236** that can be lowered at run-time using [sqlite3_limit()].
2237** The synopsis of the meanings of the various limits is shown below.
2238** Additional information is available at [limits | Limits in SQLite].
drhbb4957f2008-03-20 14:03:29 +00002239**
2240** <dl>
2241** <dt>SQLITE_LIMIT_LENGTH</dt>
mihailimefc8e8a2008-06-21 16:47:09 +00002242** <dd>The maximum size of any string or BLOB or table row.<dd>
drhbb4957f2008-03-20 14:03:29 +00002243**
2244** <dt>SQLITE_LIMIT_SQL_LENGTH</dt>
2245** <dd>The maximum length of an SQL statement.</dd>
2246**
2247** <dt>SQLITE_LIMIT_COLUMN</dt>
2248** <dd>The maximum number of columns in a table definition or in the
drh46f33ef2009-02-11 15:23:35 +00002249** result set of a [SELECT] or the maximum number of columns in an index
drhbb4957f2008-03-20 14:03:29 +00002250** or in an ORDER BY or GROUP BY clause.</dd>
2251**
2252** <dt>SQLITE_LIMIT_EXPR_DEPTH</dt>
2253** <dd>The maximum depth of the parse tree on any expression.</dd>
2254**
2255** <dt>SQLITE_LIMIT_COMPOUND_SELECT</dt>
2256** <dd>The maximum number of terms in a compound SELECT statement.</dd>
2257**
2258** <dt>SQLITE_LIMIT_VDBE_OP</dt>
2259** <dd>The maximum number of instructions in a virtual machine program
2260** used to implement an SQL statement.</dd>
2261**
2262** <dt>SQLITE_LIMIT_FUNCTION_ARG</dt>
2263** <dd>The maximum number of arguments on a function.</dd>
2264**
2265** <dt>SQLITE_LIMIT_ATTACHED</dt>
drh46f33ef2009-02-11 15:23:35 +00002266** <dd>The maximum number of [ATTACH | attached databases].</dd>
drhbb4957f2008-03-20 14:03:29 +00002267**
drhbb4957f2008-03-20 14:03:29 +00002268** <dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt>
drh46f33ef2009-02-11 15:23:35 +00002269** <dd>The maximum length of the pattern argument to the [LIKE] or
2270** [GLOB] operators.</dd>
drhbb4957f2008-03-20 14:03:29 +00002271**
2272** <dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt>
2273** <dd>The maximum number of variables in an SQL statement that can
2274** be bound.</dd>
2275** </dl>
drhcaa639f2008-03-20 00:32:20 +00002276*/
2277#define SQLITE_LIMIT_LENGTH 0
2278#define SQLITE_LIMIT_SQL_LENGTH 1
2279#define SQLITE_LIMIT_COLUMN 2
2280#define SQLITE_LIMIT_EXPR_DEPTH 3
2281#define SQLITE_LIMIT_COMPOUND_SELECT 4
2282#define SQLITE_LIMIT_VDBE_OP 5
2283#define SQLITE_LIMIT_FUNCTION_ARG 6
2284#define SQLITE_LIMIT_ATTACHED 7
drhb1a6c3c2008-03-20 16:30:17 +00002285#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8
2286#define SQLITE_LIMIT_VARIABLE_NUMBER 9
drhcaa639f2008-03-20 00:32:20 +00002287
2288/*
drh9cd29642008-07-23 00:52:55 +00002289** CAPI3REF: Compiling An SQL Statement {H13010} <S10000>
mihailimefc8e8a2008-06-21 16:47:09 +00002290** KEYWORDS: {SQL statement compiler}
danielk197765904932004-05-26 06:18:37 +00002291**
drh6ed48bf2007-06-14 20:57:18 +00002292** To execute an SQL query, it must first be compiled into a byte-code
mihailimefc8e8a2008-06-21 16:47:09 +00002293** program using one of these routines.
drh6ed48bf2007-06-14 20:57:18 +00002294**
mihailimefc8e8a2008-06-21 16:47:09 +00002295** The first argument, "db", is a [database connection] obtained from a
drh860e0772009-04-02 18:32:26 +00002296** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or
2297** [sqlite3_open16()]. The database connection must not have been closed.
mihailimefc8e8a2008-06-21 16:47:09 +00002298**
2299** The second argument, "zSql", is the statement to be compiled, encoded
drh6ed48bf2007-06-14 20:57:18 +00002300** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2()
mihailimefc8e8a2008-06-21 16:47:09 +00002301** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2()
mihailim04bcc002008-06-22 10:21:27 +00002302** use UTF-16.
drh21f06722007-07-19 12:41:39 +00002303**
mihailimefc8e8a2008-06-21 16:47:09 +00002304** If the nByte argument is less than zero, then zSql is read up to the
2305** first zero terminator. If nByte is non-negative, then it is the maximum
2306** number of bytes read from zSql. When nByte is non-negative, the
2307** zSql string ends at either the first '\000' or '\u0000' character or
drhb08c2a72008-04-16 00:28:13 +00002308** the nByte-th byte, whichever comes first. If the caller knows
danielk19773a2c8c82008-04-03 14:36:25 +00002309** that the supplied string is nul-terminated, then there is a small
mihailimefc8e8a2008-06-21 16:47:09 +00002310** performance advantage to be gained by passing an nByte parameter that
2311** is equal to the number of bytes in the input string <i>including</i>
mihailim04bcc002008-06-22 10:21:27 +00002312** the nul-terminator bytes.
danielk197765904932004-05-26 06:18:37 +00002313**
drh860e0772009-04-02 18:32:26 +00002314** If pzTail is not NULL then *pzTail is made to point to the first byte
2315** past the end of the first SQL statement in zSql. These routines only
2316** compile the first statement in zSql, so *pzTail is left pointing to
2317** what remains uncompiled.
danielk197765904932004-05-26 06:18:37 +00002318**
drh33c1be32008-01-30 16:16:14 +00002319** *ppStmt is left pointing to a compiled [prepared statement] that can be
mihailimefc8e8a2008-06-21 16:47:09 +00002320** executed using [sqlite3_step()]. If there is an error, *ppStmt is set
2321** to NULL. If the input text contains no SQL (if the input is an empty
2322** string or a comment) then *ppStmt is set to NULL.
drh860e0772009-04-02 18:32:26 +00002323** The calling procedure is responsible for deleting the compiled
mihailimefc8e8a2008-06-21 16:47:09 +00002324** SQL statement using [sqlite3_finalize()] after it has finished with it.
drh860e0772009-04-02 18:32:26 +00002325** ppStmt may not be NULL.
danielk197765904932004-05-26 06:18:37 +00002326**
mihailimefc8e8a2008-06-21 16:47:09 +00002327** On success, [SQLITE_OK] is returned, otherwise an [error code] is returned.
drh6ed48bf2007-06-14 20:57:18 +00002328**
2329** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are
2330** recommended for all new programs. The two older interfaces are retained
2331** for backwards compatibility, but their use is discouraged.
drh33c1be32008-01-30 16:16:14 +00002332** In the "v2" interfaces, the prepared statement
mihailimefc8e8a2008-06-21 16:47:09 +00002333** that is returned (the [sqlite3_stmt] object) contains a copy of the
mihailim04bcc002008-06-22 10:21:27 +00002334** original SQL text. This causes the [sqlite3_step()] interface to
drh6ed48bf2007-06-14 20:57:18 +00002335** behave a differently in two ways:
2336**
2337** <ol>
drh33c1be32008-01-30 16:16:14 +00002338** <li>
drh6ed48bf2007-06-14 20:57:18 +00002339** If the database schema changes, instead of returning [SQLITE_SCHEMA] as it
2340** always used to do, [sqlite3_step()] will automatically recompile the SQL
drh33c1be32008-01-30 16:16:14 +00002341** statement and try to run it again. If the schema has changed in
drhfddfa2d2007-12-05 18:05:16 +00002342** a way that makes the statement no longer valid, [sqlite3_step()] will still
mihailimefc8e8a2008-06-21 16:47:09 +00002343** return [SQLITE_SCHEMA]. But unlike the legacy behavior, [SQLITE_SCHEMA] is
2344** now a fatal error. Calling [sqlite3_prepare_v2()] again will not make the
drh33c1be32008-01-30 16:16:14 +00002345** error go away. Note: use [sqlite3_errmsg()] to find the text
mihailim04bcc002008-06-22 10:21:27 +00002346** of the parsing error that results in an [SQLITE_SCHEMA] return.
drh6ed48bf2007-06-14 20:57:18 +00002347** </li>
2348**
2349** <li>
mihailimefc8e8a2008-06-21 16:47:09 +00002350** When an error occurs, [sqlite3_step()] will return one of the detailed
2351** [error codes] or [extended error codes]. The legacy behavior was that
2352** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code
2353** and you would have to make a second call to [sqlite3_reset()] in order
2354** to find the underlying cause of the problem. With the "v2" prepare
2355** interfaces, the underlying reason for the error is returned immediately.
drh6ed48bf2007-06-14 20:57:18 +00002356** </li>
2357** </ol>
drh33c1be32008-01-30 16:16:14 +00002358**
drh8b39db12009-02-18 18:37:58 +00002359** Requirements:
2360** [H13011] [H13012] [H13013] [H13014] [H13015] [H13016] [H13019] [H13021]
drh33c1be32008-01-30 16:16:14 +00002361**
danielk197765904932004-05-26 06:18:37 +00002362*/
2363int sqlite3_prepare(
2364 sqlite3 *db, /* Database handle */
2365 const char *zSql, /* SQL statement, UTF-8 encoded */
drh21f06722007-07-19 12:41:39 +00002366 int nByte, /* Maximum length of zSql in bytes. */
danielk197765904932004-05-26 06:18:37 +00002367 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2368 const char **pzTail /* OUT: Pointer to unused portion of zSql */
2369);
drh6ed48bf2007-06-14 20:57:18 +00002370int sqlite3_prepare_v2(
2371 sqlite3 *db, /* Database handle */
2372 const char *zSql, /* SQL statement, UTF-8 encoded */
drh21f06722007-07-19 12:41:39 +00002373 int nByte, /* Maximum length of zSql in bytes. */
drh6ed48bf2007-06-14 20:57:18 +00002374 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2375 const char **pzTail /* OUT: Pointer to unused portion of zSql */
2376);
danielk197765904932004-05-26 06:18:37 +00002377int sqlite3_prepare16(
2378 sqlite3 *db, /* Database handle */
2379 const void *zSql, /* SQL statement, UTF-16 encoded */
drh21f06722007-07-19 12:41:39 +00002380 int nByte, /* Maximum length of zSql in bytes. */
danielk197765904932004-05-26 06:18:37 +00002381 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2382 const void **pzTail /* OUT: Pointer to unused portion of zSql */
2383);
drhb900aaf2006-11-09 00:24:53 +00002384int sqlite3_prepare16_v2(
2385 sqlite3 *db, /* Database handle */
2386 const void *zSql, /* SQL statement, UTF-16 encoded */
drh21f06722007-07-19 12:41:39 +00002387 int nByte, /* Maximum length of zSql in bytes. */
drhb900aaf2006-11-09 00:24:53 +00002388 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2389 const void **pzTail /* OUT: Pointer to unused portion of zSql */
2390);
2391
2392/*
drh25ef8f12008-10-02 14:33:56 +00002393** CAPI3REF: Retrieving Statement SQL {H13100} <H13000>
danielk1977d0e2a852007-11-14 06:48:48 +00002394**
mihailimefc8e8a2008-06-21 16:47:09 +00002395** This interface can be used to retrieve a saved copy of the original
2396** SQL text used to create a [prepared statement] if that statement was
2397** compiled using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()].
danielk1977d0e2a852007-11-14 06:48:48 +00002398**
drh8b39db12009-02-18 18:37:58 +00002399** Requirements:
2400** [H13101] [H13102] [H13103]
danielk1977d0e2a852007-11-14 06:48:48 +00002401*/
2402const char *sqlite3_sql(sqlite3_stmt *pStmt);
2403
2404/*
drhb25f9d82008-07-23 15:40:06 +00002405** CAPI3REF: Dynamically Typed Value Object {H15000} <S20200>
drhaa28e142008-03-18 13:47:20 +00002406** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value}
drh6ed48bf2007-06-14 20:57:18 +00002407**
drh33c1be32008-01-30 16:16:14 +00002408** SQLite uses the sqlite3_value object to represent all values
mihailimefc8e8a2008-06-21 16:47:09 +00002409** that can be stored in a database table. SQLite uses dynamic typing
2410** for the values it stores. Values stored in sqlite3_value objects
2411** can be integers, floating point values, strings, BLOBs, or NULL.
drhaa28e142008-03-18 13:47:20 +00002412**
2413** An sqlite3_value object may be either "protected" or "unprotected".
2414** Some interfaces require a protected sqlite3_value. Other interfaces
2415** will accept either a protected or an unprotected sqlite3_value.
mihailimefc8e8a2008-06-21 16:47:09 +00002416** Every interface that accepts sqlite3_value arguments specifies
drhaa28e142008-03-18 13:47:20 +00002417** whether or not it requires a protected sqlite3_value.
2418**
2419** The terms "protected" and "unprotected" refer to whether or not
2420** a mutex is held. A internal mutex is held for a protected
2421** sqlite3_value object but no mutex is held for an unprotected
2422** sqlite3_value object. If SQLite is compiled to be single-threaded
drh4766b292008-06-26 02:53:02 +00002423** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0)
drh4ead1482008-06-26 18:16:05 +00002424** or if SQLite is run in one of reduced mutex modes
2425** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD]
mihailimefc8e8a2008-06-21 16:47:09 +00002426** then there is no distinction between protected and unprotected
2427** sqlite3_value objects and they can be used interchangeably. However,
2428** for maximum code portability it is recommended that applications
2429** still make the distinction between between protected and unprotected
drh4ead1482008-06-26 18:16:05 +00002430** sqlite3_value objects even when not strictly required.
drhaa28e142008-03-18 13:47:20 +00002431**
2432** The sqlite3_value objects that are passed as parameters into the
mihailimefc8e8a2008-06-21 16:47:09 +00002433** implementation of [application-defined SQL functions] are protected.
drhaa28e142008-03-18 13:47:20 +00002434** The sqlite3_value object returned by
2435** [sqlite3_column_value()] is unprotected.
2436** Unprotected sqlite3_value objects may only be used with
mihailimefc8e8a2008-06-21 16:47:09 +00002437** [sqlite3_result_value()] and [sqlite3_bind_value()].
drhce5a5a02008-06-10 17:41:44 +00002438** The [sqlite3_value_blob | sqlite3_value_type()] family of
2439** interfaces require protected sqlite3_value objects.
drhf4479502004-05-27 03:12:53 +00002440*/
drhf4479502004-05-27 03:12:53 +00002441typedef struct Mem sqlite3_value;
2442
2443/*
drhb25f9d82008-07-23 15:40:06 +00002444** CAPI3REF: SQL Function Context Object {H16001} <S20200>
drh4f26d6c2004-05-26 23:25:30 +00002445**
drh6ed48bf2007-06-14 20:57:18 +00002446** The context in which an SQL function executes is stored in an
mihailimefc8e8a2008-06-21 16:47:09 +00002447** sqlite3_context object. A pointer to an sqlite3_context object
2448** is always first parameter to [application-defined SQL functions].
2449** The application-defined SQL function implementation will pass this
2450** pointer through into calls to [sqlite3_result_int | sqlite3_result()],
2451** [sqlite3_aggregate_context()], [sqlite3_user_data()],
2452** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()],
2453** and/or [sqlite3_set_auxdata()].
drh6ed48bf2007-06-14 20:57:18 +00002454*/
2455typedef struct sqlite3_context sqlite3_context;
2456
2457/*
drhb25f9d82008-07-23 15:40:06 +00002458** CAPI3REF: Binding Values To Prepared Statements {H13500} <S70300>
mihailimefc8e8a2008-06-21 16:47:09 +00002459** KEYWORDS: {host parameter} {host parameters} {host parameter name}
mihailimebe796c2008-06-21 20:11:17 +00002460** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding}
drh6ed48bf2007-06-14 20:57:18 +00002461**
mihailimefc8e8a2008-06-21 16:47:09 +00002462** In the SQL strings input to [sqlite3_prepare_v2()] and its variants,
drhaff46972009-02-12 17:07:34 +00002463** literals may be replaced by a [parameter] in one of these forms:
drh6ed48bf2007-06-14 20:57:18 +00002464**
2465** <ul>
2466** <li> ?
2467** <li> ?NNN
drh33c1be32008-01-30 16:16:14 +00002468** <li> :VVV
2469** <li> @VVV
drh6ed48bf2007-06-14 20:57:18 +00002470** <li> $VVV
2471** </ul>
2472**
2473** In the parameter forms shown above NNN is an integer literal,
mihailimefc8e8a2008-06-21 16:47:09 +00002474** and VVV is an alpha-numeric parameter name. The values of these
2475** parameters (also called "host parameter names" or "SQL parameters")
drh6ed48bf2007-06-14 20:57:18 +00002476** can be set using the sqlite3_bind_*() routines defined here.
2477**
mihailimefc8e8a2008-06-21 16:47:09 +00002478** The first argument to the sqlite3_bind_*() routines is always
2479** a pointer to the [sqlite3_stmt] object returned from
2480** [sqlite3_prepare_v2()] or its variants.
2481**
2482** The second argument is the index of the SQL parameter to be set.
2483** The leftmost SQL parameter has an index of 1. When the same named
2484** SQL parameter is used more than once, second and subsequent
2485** occurrences have the same index as the first occurrence.
drh33c1be32008-01-30 16:16:14 +00002486** The index for named parameters can be looked up using the
danielk1977c001fc32008-06-24 09:52:39 +00002487** [sqlite3_bind_parameter_index()] API if desired. The index
drhf5befa02007-12-06 02:42:07 +00002488** for "?NNN" parameters is the value of NNN.
drh4ead1482008-06-26 18:16:05 +00002489** The NNN value must be between 1 and the [sqlite3_limit()]
2490** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999).
drh6ed48bf2007-06-14 20:57:18 +00002491**
drh33c1be32008-01-30 16:16:14 +00002492** The third argument is the value to bind to the parameter.
drh6ed48bf2007-06-14 20:57:18 +00002493**
mihailimefc8e8a2008-06-21 16:47:09 +00002494** In those routines that have a fourth argument, its value is the
2495** number of bytes in the parameter. To be clear: the value is the
2496** number of <u>bytes</u> in the value, not the number of characters.
drh6ed48bf2007-06-14 20:57:18 +00002497** If the fourth parameter is negative, the length of the string is
shane26b34032008-05-23 17:21:09 +00002498** the number of bytes up to the first zero terminator.
drh4f26d6c2004-05-26 23:25:30 +00002499**
drh930cc582007-03-28 13:07:40 +00002500** The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and
drh900dfba2004-07-21 15:21:36 +00002501** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or
drh33c1be32008-01-30 16:16:14 +00002502** string after SQLite has finished with it. If the fifth argument is
2503** the special value [SQLITE_STATIC], then SQLite assumes that the
drhfddfa2d2007-12-05 18:05:16 +00002504** information is in static, unmanaged space and does not need to be freed.
drh33c1be32008-01-30 16:16:14 +00002505** If the fifth argument has the value [SQLITE_TRANSIENT], then
drhfddfa2d2007-12-05 18:05:16 +00002506** SQLite makes its own private copy of the data immediately, before
drh33c1be32008-01-30 16:16:14 +00002507** the sqlite3_bind_*() routine returns.
drh4f26d6c2004-05-26 23:25:30 +00002508**
drh33c1be32008-01-30 16:16:14 +00002509** The sqlite3_bind_zeroblob() routine binds a BLOB of length N that
mihailimefc8e8a2008-06-21 16:47:09 +00002510** is filled with zeroes. A zeroblob uses a fixed amount of memory
2511** (just an integer to hold its size) while it is being processed.
shane26b34032008-05-23 17:21:09 +00002512** Zeroblobs are intended to serve as placeholders for BLOBs whose
mihailimefc8e8a2008-06-21 16:47:09 +00002513** content is later written using
2514** [sqlite3_blob_open | incremental BLOB I/O] routines.
2515** A negative value for the zeroblob results in a zero-length BLOB.
drh6ed48bf2007-06-14 20:57:18 +00002516**
drh33c1be32008-01-30 16:16:14 +00002517** The sqlite3_bind_*() routines must be called after
drh6ed48bf2007-06-14 20:57:18 +00002518** [sqlite3_prepare_v2()] (and its variants) or [sqlite3_reset()] and
drh33c1be32008-01-30 16:16:14 +00002519** before [sqlite3_step()].
drh6ed48bf2007-06-14 20:57:18 +00002520** Bindings are not cleared by the [sqlite3_reset()] routine.
drh33c1be32008-01-30 16:16:14 +00002521** Unbound parameters are interpreted as NULL.
drh6ed48bf2007-06-14 20:57:18 +00002522**
drh33c1be32008-01-30 16:16:14 +00002523** These routines return [SQLITE_OK] on success or an error code if
2524** anything goes wrong. [SQLITE_RANGE] is returned if the parameter
shane26b34032008-05-23 17:21:09 +00002525** index is out of range. [SQLITE_NOMEM] is returned if malloc() fails.
drh33c1be32008-01-30 16:16:14 +00002526** [SQLITE_MISUSE] might be returned if these routines are called on a
drhfddfa2d2007-12-05 18:05:16 +00002527** virtual machine that is the wrong state or which has already been finalized.
drh33c1be32008-01-30 16:16:14 +00002528** Detection of misuse is unreliable. Applications should not depend
2529** on SQLITE_MISUSE returns. SQLITE_MISUSE is intended to indicate a
2530** a logic error in the application. Future versions of SQLite might
2531** panic rather than return SQLITE_MISUSE.
2532**
2533** See also: [sqlite3_bind_parameter_count()],
mihailimefc8e8a2008-06-21 16:47:09 +00002534** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()].
drh33c1be32008-01-30 16:16:14 +00002535**
drh8b39db12009-02-18 18:37:58 +00002536** Requirements:
2537** [H13506] [H13509] [H13512] [H13515] [H13518] [H13521] [H13524] [H13527]
2538** [H13530] [H13533] [H13536] [H13539] [H13542] [H13545] [H13548] [H13551]
drh33c1be32008-01-30 16:16:14 +00002539**
drh4f26d6c2004-05-26 23:25:30 +00002540*/
danielk1977d8123362004-06-12 09:25:12 +00002541int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*));
drhf4479502004-05-27 03:12:53 +00002542int sqlite3_bind_double(sqlite3_stmt*, int, double);
2543int sqlite3_bind_int(sqlite3_stmt*, int, int);
drh6d2069d2007-08-14 01:58:53 +00002544int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64);
drhf4479502004-05-27 03:12:53 +00002545int sqlite3_bind_null(sqlite3_stmt*, int);
danielk1977d8123362004-06-12 09:25:12 +00002546int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*));
2547int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*));
drhf4479502004-05-27 03:12:53 +00002548int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);
drhb026e052007-05-02 01:34:31 +00002549int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n);
drh4f26d6c2004-05-26 23:25:30 +00002550
2551/*
drhb25f9d82008-07-23 15:40:06 +00002552** CAPI3REF: Number Of SQL Parameters {H13600} <S70300>
drh6ed48bf2007-06-14 20:57:18 +00002553**
mihailimefc8e8a2008-06-21 16:47:09 +00002554** This routine can be used to find the number of [SQL parameters]
2555** in a [prepared statement]. SQL parameters are tokens of the
drh33c1be32008-01-30 16:16:14 +00002556** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as
shane26b34032008-05-23 17:21:09 +00002557** placeholders for values that are [sqlite3_bind_blob | bound]
drh33c1be32008-01-30 16:16:14 +00002558** to the parameters at a later time.
drh605264d2007-08-21 15:13:19 +00002559**
mihailim1c492652008-06-21 18:02:16 +00002560** This routine actually returns the index of the largest (rightmost)
mihailimefc8e8a2008-06-21 16:47:09 +00002561** parameter. For all forms except ?NNN, this will correspond to the
2562** number of unique parameters. If parameters of the ?NNN are used,
2563** there may be gaps in the list.
drh33c1be32008-01-30 16:16:14 +00002564**
2565** See also: [sqlite3_bind_blob|sqlite3_bind()],
2566** [sqlite3_bind_parameter_name()], and
2567** [sqlite3_bind_parameter_index()].
2568**
drh8b39db12009-02-18 18:37:58 +00002569** Requirements:
2570** [H13601]
drh75f6a032004-07-15 14:15:00 +00002571*/
2572int sqlite3_bind_parameter_count(sqlite3_stmt*);
2573
2574/*
drhb25f9d82008-07-23 15:40:06 +00002575** CAPI3REF: Name Of A Host Parameter {H13620} <S70300>
drh6ed48bf2007-06-14 20:57:18 +00002576**
drh33c1be32008-01-30 16:16:14 +00002577** This routine returns a pointer to the name of the n-th
mihailimefc8e8a2008-06-21 16:47:09 +00002578** [SQL parameter] in a [prepared statement].
drhe1b3e802008-04-27 22:29:01 +00002579** SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA"
2580** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA"
2581** respectively.
2582** In other words, the initial ":" or "$" or "@" or "?"
drh33c1be32008-01-30 16:16:14 +00002583** is included as part of the name.
mihailimefc8e8a2008-06-21 16:47:09 +00002584** Parameters of the form "?" without a following integer have no name
2585** and are also referred to as "anonymous parameters".
drh6ed48bf2007-06-14 20:57:18 +00002586**
drh33c1be32008-01-30 16:16:14 +00002587** The first host parameter has an index of 1, not 0.
drh6ed48bf2007-06-14 20:57:18 +00002588**
drh33c1be32008-01-30 16:16:14 +00002589** If the value n is out of range or if the n-th parameter is
2590** nameless, then NULL is returned. The returned string is
mihailimefc8e8a2008-06-21 16:47:09 +00002591** always in UTF-8 encoding even if the named parameter was
drhfddfa2d2007-12-05 18:05:16 +00002592** originally specified as UTF-16 in [sqlite3_prepare16()] or
2593** [sqlite3_prepare16_v2()].
drh33c1be32008-01-30 16:16:14 +00002594**
2595** See also: [sqlite3_bind_blob|sqlite3_bind()],
2596** [sqlite3_bind_parameter_count()], and
2597** [sqlite3_bind_parameter_index()].
2598**
drh8b39db12009-02-18 18:37:58 +00002599** Requirements:
2600** [H13621]
drh895d7472004-08-20 16:02:39 +00002601*/
2602const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int);
2603
2604/*
drhb25f9d82008-07-23 15:40:06 +00002605** CAPI3REF: Index Of A Parameter With A Given Name {H13640} <S70300>
drh6ed48bf2007-06-14 20:57:18 +00002606**
drh33c1be32008-01-30 16:16:14 +00002607** Return the index of an SQL parameter given its name. The
2608** index value returned is suitable for use as the second
2609** parameter to [sqlite3_bind_blob|sqlite3_bind()]. A zero
2610** is returned if no matching parameter is found. The parameter
2611** name must be given in UTF-8 even if the original statement
2612** was prepared from UTF-16 text using [sqlite3_prepare16_v2()].
2613**
2614** See also: [sqlite3_bind_blob|sqlite3_bind()],
2615** [sqlite3_bind_parameter_count()], and
2616** [sqlite3_bind_parameter_index()].
2617**
drh8b39db12009-02-18 18:37:58 +00002618** Requirements:
2619** [H13641]
drhfa6bc002004-09-07 16:19:52 +00002620*/
2621int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName);
2622
2623/*
drhb25f9d82008-07-23 15:40:06 +00002624** CAPI3REF: Reset All Bindings On A Prepared Statement {H13660} <S70300>
drh6ed48bf2007-06-14 20:57:18 +00002625**
mihailimefc8e8a2008-06-21 16:47:09 +00002626** Contrary to the intuition of many, [sqlite3_reset()] does not reset
2627** the [sqlite3_bind_blob | bindings] on a [prepared statement].
2628** Use this routine to reset all host parameters to NULL.
drh33c1be32008-01-30 16:16:14 +00002629**
drh8b39db12009-02-18 18:37:58 +00002630** Requirements:
2631** [H13661]
danielk1977600dd0b2005-01-20 01:14:23 +00002632*/
2633int sqlite3_clear_bindings(sqlite3_stmt*);
2634
2635/*
drh9cd29642008-07-23 00:52:55 +00002636** CAPI3REF: Number Of Columns In A Result Set {H13710} <S10700>
drh6ed48bf2007-06-14 20:57:18 +00002637**
mihailimefc8e8a2008-06-21 16:47:09 +00002638** Return the number of columns in the result set returned by the
2639** [prepared statement]. This routine returns 0 if pStmt is an SQL
drh4ead1482008-06-26 18:16:05 +00002640** statement that does not return data (for example an [UPDATE]).
drh33c1be32008-01-30 16:16:14 +00002641**
drh8b39db12009-02-18 18:37:58 +00002642** Requirements:
2643** [H13711]
danielk197765904932004-05-26 06:18:37 +00002644*/
2645int sqlite3_column_count(sqlite3_stmt *pStmt);
2646
2647/*
drh9cd29642008-07-23 00:52:55 +00002648** CAPI3REF: Column Names In A Result Set {H13720} <S10700>
drh6ed48bf2007-06-14 20:57:18 +00002649**
drh33c1be32008-01-30 16:16:14 +00002650** These routines return the name assigned to a particular column
drh4ead1482008-06-26 18:16:05 +00002651** in the result set of a [SELECT] statement. The sqlite3_column_name()
mihailimefc8e8a2008-06-21 16:47:09 +00002652** interface returns a pointer to a zero-terminated UTF-8 string
drhf5befa02007-12-06 02:42:07 +00002653** and sqlite3_column_name16() returns a pointer to a zero-terminated
mihailimefc8e8a2008-06-21 16:47:09 +00002654** UTF-16 string. The first parameter is the [prepared statement]
drh4ead1482008-06-26 18:16:05 +00002655** that implements the [SELECT] statement. The second parameter is the
mihailimefc8e8a2008-06-21 16:47:09 +00002656** column number. The leftmost column is number 0.
drh6ed48bf2007-06-14 20:57:18 +00002657**
mihailimefc8e8a2008-06-21 16:47:09 +00002658** The returned string pointer is valid until either the [prepared statement]
2659** is destroyed by [sqlite3_finalize()] or until the next call to
2660** sqlite3_column_name() or sqlite3_column_name16() on the same column.
drh4a50aac2007-08-23 02:47:53 +00002661**
drh33c1be32008-01-30 16:16:14 +00002662** If sqlite3_malloc() fails during the processing of either routine
drh4a50aac2007-08-23 02:47:53 +00002663** (for example during a conversion from UTF-8 to UTF-16) then a
2664** NULL pointer is returned.
drh33c1be32008-01-30 16:16:14 +00002665**
2666** The name of a result column is the value of the "AS" clause for
2667** that column, if there is an AS clause. If there is no AS clause
2668** then the name of the column is unspecified and may change from
2669** one release of SQLite to the next.
2670**
drh8b39db12009-02-18 18:37:58 +00002671** Requirements:
2672** [H13721] [H13723] [H13724] [H13725] [H13726] [H13727]
danielk197765904932004-05-26 06:18:37 +00002673*/
drh6ed48bf2007-06-14 20:57:18 +00002674const char *sqlite3_column_name(sqlite3_stmt*, int N);
2675const void *sqlite3_column_name16(sqlite3_stmt*, int N);
danielk197765904932004-05-26 06:18:37 +00002676
2677/*
drh9cd29642008-07-23 00:52:55 +00002678** CAPI3REF: Source Of Data In A Query Result {H13740} <S10700>
drh6ed48bf2007-06-14 20:57:18 +00002679**
drh33c1be32008-01-30 16:16:14 +00002680** These routines provide a means to determine what column of what
drh4ead1482008-06-26 18:16:05 +00002681** table in which database a result of a [SELECT] statement comes from.
drh33c1be32008-01-30 16:16:14 +00002682** The name of the database or table or column can be returned as
mihailimebe796c2008-06-21 20:11:17 +00002683** either a UTF-8 or UTF-16 string. The _database_ routines return
drhbf2564f2007-06-21 15:25:05 +00002684** the database name, the _table_ routines return the table name, and
drh33c1be32008-01-30 16:16:14 +00002685** the origin_ routines return the column name.
mihailim1c492652008-06-21 18:02:16 +00002686** The returned string is valid until the [prepared statement] is destroyed
2687** using [sqlite3_finalize()] or until the same information is requested
drhbf2564f2007-06-21 15:25:05 +00002688** again in a different encoding.
2689**
drh33c1be32008-01-30 16:16:14 +00002690** The names returned are the original un-aliased names of the
drhbf2564f2007-06-21 15:25:05 +00002691** database, table, and column.
drh6ed48bf2007-06-14 20:57:18 +00002692**
drh33c1be32008-01-30 16:16:14 +00002693** The first argument to the following calls is a [prepared statement].
mihailim1c492652008-06-21 18:02:16 +00002694** These functions return information about the Nth column returned by
danielk1977955de522006-02-10 02:27:42 +00002695** the statement, where N is the second function argument.
2696**
mihailim1c492652008-06-21 18:02:16 +00002697** If the Nth column returned by the statement is an expression or
2698** subquery and is not a column value, then all of these functions return
2699** NULL. These routine might also return NULL if a memory allocation error
2700** occurs. Otherwise, they return the name of the attached database, table
2701** and column that query result column was extracted from.
danielk1977955de522006-02-10 02:27:42 +00002702**
drh33c1be32008-01-30 16:16:14 +00002703** As with all other SQLite APIs, those postfixed with "16" return
drhfddfa2d2007-12-05 18:05:16 +00002704** UTF-16 encoded strings, the other functions return UTF-8. {END}
danielk19774b1ae992006-02-10 03:06:10 +00002705**
mihailim1c492652008-06-21 18:02:16 +00002706** These APIs are only available if the library was compiled with the
drh4ead1482008-06-26 18:16:05 +00002707** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined.
drh32bc3f62007-08-21 20:25:39 +00002708**
drh4766b292008-06-26 02:53:02 +00002709** {A13751}
drh32bc3f62007-08-21 20:25:39 +00002710** If two or more threads call one or more of these routines against the same
2711** prepared statement and column at the same time then the results are
2712** undefined.
drh33c1be32008-01-30 16:16:14 +00002713**
drh8b39db12009-02-18 18:37:58 +00002714** Requirements:
2715** [H13741] [H13742] [H13743] [H13744] [H13745] [H13746] [H13748]
drh33c1be32008-01-30 16:16:14 +00002716**
drh8b39db12009-02-18 18:37:58 +00002717** If two or more threads call one or more
2718** [sqlite3_column_database_name | column metadata interfaces]
2719** for the same [prepared statement] and result column
2720** at the same time then the results are undefined.
danielk1977955de522006-02-10 02:27:42 +00002721*/
2722const char *sqlite3_column_database_name(sqlite3_stmt*,int);
2723const void *sqlite3_column_database_name16(sqlite3_stmt*,int);
2724const char *sqlite3_column_table_name(sqlite3_stmt*,int);
2725const void *sqlite3_column_table_name16(sqlite3_stmt*,int);
2726const char *sqlite3_column_origin_name(sqlite3_stmt*,int);
2727const void *sqlite3_column_origin_name16(sqlite3_stmt*,int);
2728
2729/*
drh9cd29642008-07-23 00:52:55 +00002730** CAPI3REF: Declared Datatype Of A Query Result {H13760} <S10700>
drh6ed48bf2007-06-14 20:57:18 +00002731**
mihailim1c492652008-06-21 18:02:16 +00002732** The first parameter is a [prepared statement].
drh4ead1482008-06-26 18:16:05 +00002733** If this statement is a [SELECT] statement and the Nth column of the
2734** returned result set of that [SELECT] is a table column (not an
drh6ed48bf2007-06-14 20:57:18 +00002735** expression or subquery) then the declared type of the table
drh33c1be32008-01-30 16:16:14 +00002736** column is returned. If the Nth column of the result set is an
drh6ed48bf2007-06-14 20:57:18 +00002737** expression or subquery, then a NULL pointer is returned.
mihailim1c492652008-06-21 18:02:16 +00002738** The returned string is always UTF-8 encoded. {END}
2739**
2740** For example, given the database schema:
danielk197765904932004-05-26 06:18:37 +00002741**
2742** CREATE TABLE t1(c1 VARIANT);
2743**
mihailim1c492652008-06-21 18:02:16 +00002744** and the following statement to be compiled:
danielk197765904932004-05-26 06:18:37 +00002745**
danielk1977955de522006-02-10 02:27:42 +00002746** SELECT c1 + 1, c1 FROM t1;
danielk197765904932004-05-26 06:18:37 +00002747**
mihailim1c492652008-06-21 18:02:16 +00002748** this routine would return the string "VARIANT" for the second result
2749** column (i==1), and a NULL pointer for the first result column (i==0).
drh6ed48bf2007-06-14 20:57:18 +00002750**
2751** SQLite uses dynamic run-time typing. So just because a column
2752** is declared to contain a particular type does not mean that the
2753** data stored in that column is of the declared type. SQLite is
2754** strongly typed, but the typing is dynamic not static. Type
2755** is associated with individual values, not with the containers
2756** used to hold those values.
drh33c1be32008-01-30 16:16:14 +00002757**
drh8b39db12009-02-18 18:37:58 +00002758** Requirements:
2759** [H13761] [H13762] [H13763]
danielk197765904932004-05-26 06:18:37 +00002760*/
drh33c1be32008-01-30 16:16:14 +00002761const char *sqlite3_column_decltype(sqlite3_stmt*,int);
danielk197765904932004-05-26 06:18:37 +00002762const void *sqlite3_column_decltype16(sqlite3_stmt*,int);
2763
mihailimebe796c2008-06-21 20:11:17 +00002764/*
drh9cd29642008-07-23 00:52:55 +00002765** CAPI3REF: Evaluate An SQL Statement {H13200} <S10000>
danielk1977106bb232004-05-21 10:08:53 +00002766**
mihailim1c492652008-06-21 18:02:16 +00002767** After a [prepared statement] has been prepared using either
2768** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy
2769** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function
2770** must be called one or more times to evaluate the statement.
danielk1977106bb232004-05-21 10:08:53 +00002771**
mihailim1c492652008-06-21 18:02:16 +00002772** The details of the behavior of the sqlite3_step() interface depend
drh6ed48bf2007-06-14 20:57:18 +00002773** on whether the statement was prepared using the newer "v2" interface
2774** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy
2775** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the
2776** new "v2" interface is recommended for new applications but the legacy
2777** interface will continue to be supported.
danielk1977106bb232004-05-21 10:08:53 +00002778**
mihailimebe796c2008-06-21 20:11:17 +00002779** In the legacy interface, the return value will be either [SQLITE_BUSY],
drh6ed48bf2007-06-14 20:57:18 +00002780** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE].
mihailim1c492652008-06-21 18:02:16 +00002781** With the "v2" interface, any of the other [result codes] or
2782** [extended result codes] might be returned as well.
drh6ed48bf2007-06-14 20:57:18 +00002783**
2784** [SQLITE_BUSY] means that the database engine was unable to acquire the
drh4ead1482008-06-26 18:16:05 +00002785** database locks it needs to do its job. If the statement is a [COMMIT]
drh6ed48bf2007-06-14 20:57:18 +00002786** or occurs outside of an explicit transaction, then you can retry the
drh4ead1482008-06-26 18:16:05 +00002787** statement. If the statement is not a [COMMIT] and occurs within a
drh6ed48bf2007-06-14 20:57:18 +00002788** explicit transaction then you should rollback the transaction before
2789** continuing.
2790**
2791** [SQLITE_DONE] means that the statement has finished executing
danielk1977106bb232004-05-21 10:08:53 +00002792** successfully. sqlite3_step() should not be called again on this virtual
drh6ed48bf2007-06-14 20:57:18 +00002793** machine without first calling [sqlite3_reset()] to reset the virtual
2794** machine back to its initial state.
danielk1977106bb232004-05-21 10:08:53 +00002795**
mihailim1c492652008-06-21 18:02:16 +00002796** If the SQL statement being executed returns any data, then [SQLITE_ROW]
2797** is returned each time a new row of data is ready for processing by the
2798** caller. The values may be accessed using the [column access functions].
drh6ed48bf2007-06-14 20:57:18 +00002799** sqlite3_step() is called again to retrieve the next row of data.
mihailim1c492652008-06-21 18:02:16 +00002800**
drh6ed48bf2007-06-14 20:57:18 +00002801** [SQLITE_ERROR] means that a run-time error (such as a constraint
danielk1977106bb232004-05-21 10:08:53 +00002802** violation) has occurred. sqlite3_step() should not be called again on
drh6ed48bf2007-06-14 20:57:18 +00002803** the VM. More information may be found by calling [sqlite3_errmsg()].
mihailim1c492652008-06-21 18:02:16 +00002804** With the legacy interface, a more specific error code (for example,
drh6ed48bf2007-06-14 20:57:18 +00002805** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth)
2806** can be obtained by calling [sqlite3_reset()] on the
drh33c1be32008-01-30 16:16:14 +00002807** [prepared statement]. In the "v2" interface,
drh6ed48bf2007-06-14 20:57:18 +00002808** the more specific error code is returned directly by sqlite3_step().
danielk1977106bb232004-05-21 10:08:53 +00002809**
drh6ed48bf2007-06-14 20:57:18 +00002810** [SQLITE_MISUSE] means that the this routine was called inappropriately.
drh33c1be32008-01-30 16:16:14 +00002811** Perhaps it was called on a [prepared statement] that has
mihailim1c492652008-06-21 18:02:16 +00002812** already been [sqlite3_finalize | finalized] or on one that had
drh6ed48bf2007-06-14 20:57:18 +00002813** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could
2814** be the case that the same database connection is being used by two or
2815** more threads at the same moment in time.
2816**
mihailim1c492652008-06-21 18:02:16 +00002817** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step()
2818** API always returns a generic error code, [SQLITE_ERROR], following any
2819** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call
2820** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the
2821** specific [error codes] that better describes the error.
drh6ed48bf2007-06-14 20:57:18 +00002822** We admit that this is a goofy design. The problem has been fixed
2823** with the "v2" interface. If you prepare all of your SQL statements
2824** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead
mihailim1c492652008-06-21 18:02:16 +00002825** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces,
2826** then the more specific [error codes] are returned directly
drh6ed48bf2007-06-14 20:57:18 +00002827** by sqlite3_step(). The use of the "v2" interface is recommended.
drh33c1be32008-01-30 16:16:14 +00002828**
drh8b39db12009-02-18 18:37:58 +00002829** Requirements:
2830** [H13202] [H15304] [H15306] [H15308] [H15310]
danielk1977106bb232004-05-21 10:08:53 +00002831*/
danielk197717240fd2004-05-26 00:07:25 +00002832int sqlite3_step(sqlite3_stmt*);
danielk1977106bb232004-05-21 10:08:53 +00002833
danielk1977106bb232004-05-21 10:08:53 +00002834/*
drh9cd29642008-07-23 00:52:55 +00002835** CAPI3REF: Number of columns in a result set {H13770} <S10700>
drh6ed48bf2007-06-14 20:57:18 +00002836**
mihailim1c492652008-06-21 18:02:16 +00002837** Returns the number of values in the current row of the result set.
danielk1977106bb232004-05-21 10:08:53 +00002838**
drh8b39db12009-02-18 18:37:58 +00002839** Requirements:
2840** [H13771] [H13772]
danielk1977106bb232004-05-21 10:08:53 +00002841*/
danielk197793d46752004-05-23 13:30:58 +00002842int sqlite3_data_count(sqlite3_stmt *pStmt);
danielk19774adee202004-05-08 08:23:19 +00002843
drh4f26d6c2004-05-26 23:25:30 +00002844/*
drhb25f9d82008-07-23 15:40:06 +00002845** CAPI3REF: Fundamental Datatypes {H10265} <S10110><S10120>
drh33c1be32008-01-30 16:16:14 +00002846** KEYWORDS: SQLITE_TEXT
drh6ed48bf2007-06-14 20:57:18 +00002847**
drh9a247912008-07-22 18:45:08 +00002848** {H10266} Every value in SQLite has one of five fundamental datatypes:
drh6ed48bf2007-06-14 20:57:18 +00002849**
2850** <ul>
2851** <li> 64-bit signed integer
2852** <li> 64-bit IEEE floating point number
2853** <li> string
2854** <li> BLOB
2855** <li> NULL
drhfddfa2d2007-12-05 18:05:16 +00002856** </ul> {END}
drh6ed48bf2007-06-14 20:57:18 +00002857**
2858** These constants are codes for each of those types.
2859**
2860** Note that the SQLITE_TEXT constant was also used in SQLite version 2
2861** for a completely different meaning. Software that links against both
mihailim1c492652008-06-21 18:02:16 +00002862** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not
drh6ed48bf2007-06-14 20:57:18 +00002863** SQLITE_TEXT.
drh4f26d6c2004-05-26 23:25:30 +00002864*/
drh9c054832004-05-31 18:51:57 +00002865#define SQLITE_INTEGER 1
2866#define SQLITE_FLOAT 2
drh9c054832004-05-31 18:51:57 +00002867#define SQLITE_BLOB 4
2868#define SQLITE_NULL 5
drh1e284f42004-10-06 15:52:01 +00002869#ifdef SQLITE_TEXT
2870# undef SQLITE_TEXT
2871#else
2872# define SQLITE_TEXT 3
2873#endif
2874#define SQLITE3_TEXT 3
2875
2876/*
drh9cd29642008-07-23 00:52:55 +00002877** CAPI3REF: Result Values From A Query {H13800} <S10700>
mihailim1c492652008-06-21 18:02:16 +00002878** KEYWORDS: {column access functions}
drh6ed48bf2007-06-14 20:57:18 +00002879**
drh33c1be32008-01-30 16:16:14 +00002880** These routines form the "result set query" interface.
2881**
mihailim1c492652008-06-21 18:02:16 +00002882** These routines return information about a single column of the current
2883** result row of a query. In every case the first argument is a pointer
2884** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*]
2885** that was returned from [sqlite3_prepare_v2()] or one of its variants)
2886** and the second argument is the index of the column for which information
2887** should be returned. The leftmost column of the result set has the index 0.
danielk1977106bb232004-05-21 10:08:53 +00002888**
mihailim1c492652008-06-21 18:02:16 +00002889** If the SQL statement does not currently point to a valid row, or if the
2890** column index is out of range, the result is undefined.
drh32bc3f62007-08-21 20:25:39 +00002891** These routines may only be called when the most recent call to
2892** [sqlite3_step()] has returned [SQLITE_ROW] and neither
mihailim1c492652008-06-21 18:02:16 +00002893** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently.
drh32bc3f62007-08-21 20:25:39 +00002894** If any of these routines are called after [sqlite3_reset()] or
2895** [sqlite3_finalize()] or after [sqlite3_step()] has returned
2896** something other than [SQLITE_ROW], the results are undefined.
2897** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()]
2898** are called from a different thread while any of these routines
mihailim1c492652008-06-21 18:02:16 +00002899** are pending, then the results are undefined.
drh6ed48bf2007-06-14 20:57:18 +00002900**
mihailim1c492652008-06-21 18:02:16 +00002901** The sqlite3_column_type() routine returns the
drh6ed48bf2007-06-14 20:57:18 +00002902** [SQLITE_INTEGER | datatype code] for the initial data type
2903** of the result column. The returned value is one of [SQLITE_INTEGER],
2904** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value
2905** returned by sqlite3_column_type() is only meaningful if no type
2906** conversions have occurred as described below. After a type conversion,
2907** the value returned by sqlite3_column_type() is undefined. Future
2908** versions of SQLite may change the behavior of sqlite3_column_type()
2909** following a type conversion.
2910**
mihailim1c492652008-06-21 18:02:16 +00002911** If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes()
drh6ed48bf2007-06-14 20:57:18 +00002912** routine returns the number of bytes in that BLOB or string.
mihailimebe796c2008-06-21 20:11:17 +00002913** If the result is a UTF-16 string, then sqlite3_column_bytes() converts
drh6ed48bf2007-06-14 20:57:18 +00002914** the string to UTF-8 and then returns the number of bytes.
2915** If the result is a numeric value then sqlite3_column_bytes() uses
mihailimebe796c2008-06-21 20:11:17 +00002916** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns
drh6ed48bf2007-06-14 20:57:18 +00002917** the number of bytes in that string.
2918** The value returned does not include the zero terminator at the end
2919** of the string. For clarity: the value returned is the number of
2920** bytes in the string, not the number of characters.
2921**
drhc0b3abb2007-09-04 12:18:41 +00002922** Strings returned by sqlite3_column_text() and sqlite3_column_text16(),
drh33c1be32008-01-30 16:16:14 +00002923** even empty strings, are always zero terminated. The return
mihailim04bcc002008-06-22 10:21:27 +00002924** value from sqlite3_column_blob() for a zero-length BLOB is an arbitrary
drhc0b3abb2007-09-04 12:18:41 +00002925** pointer, possibly even a NULL pointer.
2926**
drh6ed48bf2007-06-14 20:57:18 +00002927** The sqlite3_column_bytes16() routine is similar to sqlite3_column_bytes()
mihailim1c492652008-06-21 18:02:16 +00002928** but leaves the result in UTF-16 in native byte order instead of UTF-8.
drh6ed48bf2007-06-14 20:57:18 +00002929** The zero terminator is not included in this count.
drh4f26d6c2004-05-26 23:25:30 +00002930**
drhaa28e142008-03-18 13:47:20 +00002931** The object returned by [sqlite3_column_value()] is an
2932** [unprotected sqlite3_value] object. An unprotected sqlite3_value object
2933** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()].
2934** If the [unprotected sqlite3_value] object returned by
2935** [sqlite3_column_value()] is used in any other way, including calls
mihailim1c492652008-06-21 18:02:16 +00002936** to routines like [sqlite3_value_int()], [sqlite3_value_text()],
2937** or [sqlite3_value_bytes()], then the behavior is undefined.
drhaa28e142008-03-18 13:47:20 +00002938**
drh4f26d6c2004-05-26 23:25:30 +00002939** These routines attempt to convert the value where appropriate. For
2940** example, if the internal representation is FLOAT and a text result
mihailim1c492652008-06-21 18:02:16 +00002941** is requested, [sqlite3_snprintf()] is used internally to perform the
2942** conversion automatically. The following table details the conversions
2943** that are applied:
drh4f26d6c2004-05-26 23:25:30 +00002944**
drh6ed48bf2007-06-14 20:57:18 +00002945** <blockquote>
2946** <table border="1">
drh8bacf972007-08-25 16:21:29 +00002947** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion
drh4f26d6c2004-05-26 23:25:30 +00002948**
drh6ed48bf2007-06-14 20:57:18 +00002949** <tr><td> NULL <td> INTEGER <td> Result is 0
2950** <tr><td> NULL <td> FLOAT <td> Result is 0.0
2951** <tr><td> NULL <td> TEXT <td> Result is NULL pointer
2952** <tr><td> NULL <td> BLOB <td> Result is NULL pointer
2953** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float
2954** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer
mihailim1c492652008-06-21 18:02:16 +00002955** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT
drh6ed48bf2007-06-14 20:57:18 +00002956** <tr><td> FLOAT <td> INTEGER <td> Convert from float to integer
2957** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float
2958** <tr><td> FLOAT <td> BLOB <td> Same as FLOAT->TEXT
2959** <tr><td> TEXT <td> INTEGER <td> Use atoi()
2960** <tr><td> TEXT <td> FLOAT <td> Use atof()
2961** <tr><td> TEXT <td> BLOB <td> No change
2962** <tr><td> BLOB <td> INTEGER <td> Convert to TEXT then use atoi()
2963** <tr><td> BLOB <td> FLOAT <td> Convert to TEXT then use atof()
2964** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed
2965** </table>
2966** </blockquote>
drh4f26d6c2004-05-26 23:25:30 +00002967**
drh6ed48bf2007-06-14 20:57:18 +00002968** The table above makes reference to standard C library functions atoi()
2969** and atof(). SQLite does not really use these functions. It has its
shane26b34032008-05-23 17:21:09 +00002970** own equivalent internal routines. The atoi() and atof() names are
drh6ed48bf2007-06-14 20:57:18 +00002971** used in the table for brevity and because they are familiar to most
2972** C programmers.
2973**
2974** Note that when type conversions occur, pointers returned by prior
2975** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or
mihailim1c492652008-06-21 18:02:16 +00002976** sqlite3_column_text16() may be invalidated.
drh6ed48bf2007-06-14 20:57:18 +00002977** Type conversions and pointer invalidations might occur
2978** in the following cases:
2979**
2980** <ul>
mihailim1c492652008-06-21 18:02:16 +00002981** <li> The initial content is a BLOB and sqlite3_column_text() or
2982** sqlite3_column_text16() is called. A zero-terminator might
2983** need to be added to the string.</li>
2984** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or
2985** sqlite3_column_text16() is called. The content must be converted
2986** to UTF-16.</li>
2987** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or
2988** sqlite3_column_text() is called. The content must be converted
2989** to UTF-8.</li>
drh6ed48bf2007-06-14 20:57:18 +00002990** </ul>
2991**
2992** Conversions between UTF-16be and UTF-16le are always done in place and do
2993** not invalidate a prior pointer, though of course the content of the buffer
2994** that the prior pointer points to will have been modified. Other kinds
mihailim1c492652008-06-21 18:02:16 +00002995** of conversion are done in place when it is possible, but sometimes they
2996** are not possible and in those cases prior pointers are invalidated.
drh6ed48bf2007-06-14 20:57:18 +00002997**
2998** The safest and easiest to remember policy is to invoke these routines
2999** in one of the following ways:
3000**
mihailim1c492652008-06-21 18:02:16 +00003001** <ul>
drh6ed48bf2007-06-14 20:57:18 +00003002** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li>
3003** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li>
3004** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li>
mihailim1c492652008-06-21 18:02:16 +00003005** </ul>
drh6ed48bf2007-06-14 20:57:18 +00003006**
mihailim1c492652008-06-21 18:02:16 +00003007** In other words, you should call sqlite3_column_text(),
3008** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result
3009** into the desired format, then invoke sqlite3_column_bytes() or
3010** sqlite3_column_bytes16() to find the size of the result. Do not mix calls
3011** to sqlite3_column_text() or sqlite3_column_blob() with calls to
3012** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16()
3013** with calls to sqlite3_column_bytes().
drh32bc3f62007-08-21 20:25:39 +00003014**
3015** The pointers returned are valid until a type conversion occurs as
3016** described above, or until [sqlite3_step()] or [sqlite3_reset()] or
3017** [sqlite3_finalize()] is called. The memory space used to hold strings
mihailim04bcc002008-06-22 10:21:27 +00003018** and BLOBs is freed automatically. Do <b>not</b> pass the pointers returned
mihailim1c492652008-06-21 18:02:16 +00003019** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into
drh32bc3f62007-08-21 20:25:39 +00003020** [sqlite3_free()].
drh4a50aac2007-08-23 02:47:53 +00003021**
3022** If a memory allocation error occurs during the evaluation of any
3023** of these routines, a default value is returned. The default value
3024** is either the integer 0, the floating point number 0.0, or a NULL
3025** pointer. Subsequent calls to [sqlite3_errcode()] will return
3026** [SQLITE_NOMEM].
drh21ac7f92008-01-31 12:26:49 +00003027**
drh8b39db12009-02-18 18:37:58 +00003028** Requirements:
3029** [H13803] [H13806] [H13809] [H13812] [H13815] [H13818] [H13821] [H13824]
3030** [H13827] [H13830]
danielk1977106bb232004-05-21 10:08:53 +00003031*/
drhf4479502004-05-27 03:12:53 +00003032const void *sqlite3_column_blob(sqlite3_stmt*, int iCol);
3033int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
3034int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
3035double sqlite3_column_double(sqlite3_stmt*, int iCol);
3036int sqlite3_column_int(sqlite3_stmt*, int iCol);
drh6d2069d2007-08-14 01:58:53 +00003037sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol);
drhf4479502004-05-27 03:12:53 +00003038const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol);
3039const void *sqlite3_column_text16(sqlite3_stmt*, int iCol);
drh4f26d6c2004-05-26 23:25:30 +00003040int sqlite3_column_type(sqlite3_stmt*, int iCol);
drh4be8b512006-06-13 23:51:34 +00003041sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol);
danielk19774adee202004-05-08 08:23:19 +00003042
danielk197765904932004-05-26 06:18:37 +00003043/*
drhb25f9d82008-07-23 15:40:06 +00003044** CAPI3REF: Destroy A Prepared Statement Object {H13300} <S70300><S30100>
drh6ed48bf2007-06-14 20:57:18 +00003045**
mihailimebe796c2008-06-21 20:11:17 +00003046** The sqlite3_finalize() function is called to delete a [prepared statement].
3047** If the statement was executed successfully or not executed at all, then
3048** SQLITE_OK is returned. If execution of the statement failed then an
3049** [error code] or [extended error code] is returned.
danielk197765904932004-05-26 06:18:37 +00003050**
3051** This routine can be called at any point during the execution of the
mihailimebe796c2008-06-21 20:11:17 +00003052** [prepared statement]. If the virtual machine has not
drh6ed48bf2007-06-14 20:57:18 +00003053** completed execution when this routine is called, that is like
mihailimebe796c2008-06-21 20:11:17 +00003054** encountering an error or an [sqlite3_interrupt | interrupt].
3055** Incomplete updates may be rolled back and transactions canceled,
3056** depending on the circumstances, and the
drh33c1be32008-01-30 16:16:14 +00003057** [error code] returned will be [SQLITE_ABORT].
3058**
drh8b39db12009-02-18 18:37:58 +00003059** Requirements:
3060** [H11302] [H11304]
danielk197765904932004-05-26 06:18:37 +00003061*/
3062int sqlite3_finalize(sqlite3_stmt *pStmt);
3063
3064/*
drh9cd29642008-07-23 00:52:55 +00003065** CAPI3REF: Reset A Prepared Statement Object {H13330} <S70300>
drh6ed48bf2007-06-14 20:57:18 +00003066**
mihailimebe796c2008-06-21 20:11:17 +00003067** The sqlite3_reset() function is called to reset a [prepared statement]
3068** object back to its initial state, ready to be re-executed.
danielk197765904932004-05-26 06:18:37 +00003069** Any SQL statement variables that had values bound to them using
drh6ed48bf2007-06-14 20:57:18 +00003070** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values.
3071** Use [sqlite3_clear_bindings()] to reset the bindings.
drh33c1be32008-01-30 16:16:14 +00003072**
drh9a247912008-07-22 18:45:08 +00003073** {H11332} The [sqlite3_reset(S)] interface resets the [prepared statement] S
drh33c1be32008-01-30 16:16:14 +00003074** back to the beginning of its program.
3075**
drh9a247912008-07-22 18:45:08 +00003076** {H11334} If the most recent call to [sqlite3_step(S)] for the
drh33c1be32008-01-30 16:16:14 +00003077** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE],
3078** or if [sqlite3_step(S)] has never before been called on S,
3079** then [sqlite3_reset(S)] returns [SQLITE_OK].
3080**
drh9a247912008-07-22 18:45:08 +00003081** {H11336} If the most recent call to [sqlite3_step(S)] for the
drh33c1be32008-01-30 16:16:14 +00003082** [prepared statement] S indicated an error, then
3083** [sqlite3_reset(S)] returns an appropriate [error code].
3084**
drh9a247912008-07-22 18:45:08 +00003085** {H11338} The [sqlite3_reset(S)] interface does not change the values
mihailimebe796c2008-06-21 20:11:17 +00003086** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S.
danielk197765904932004-05-26 06:18:37 +00003087*/
3088int sqlite3_reset(sqlite3_stmt *pStmt);
3089
3090/*
drh9cd29642008-07-23 00:52:55 +00003091** CAPI3REF: Create Or Redefine SQL Functions {H16100} <S20200>
mihailimefc8e8a2008-06-21 16:47:09 +00003092** KEYWORDS: {function creation routines}
3093** KEYWORDS: {application-defined SQL function}
3094** KEYWORDS: {application-defined SQL functions}
drh6ed48bf2007-06-14 20:57:18 +00003095**
mihailimebe796c2008-06-21 20:11:17 +00003096** These two functions (collectively known as "function creation routines")
3097** are used to add SQL functions or aggregates or to redefine the behavior
3098** of existing SQL functions or aggregates. The only difference between the
3099** two is that the second parameter, the name of the (scalar) function or
3100** aggregate, is encoded in UTF-8 for sqlite3_create_function() and UTF-16
3101** for sqlite3_create_function16().
danielk197765904932004-05-26 06:18:37 +00003102**
drh1c3cfc62008-03-08 12:37:30 +00003103** The first parameter is the [database connection] to which the SQL
mihailimebe796c2008-06-21 20:11:17 +00003104** function is to be added. If a single program uses more than one database
3105** connection internally, then SQL functions must be added individually to
3106** each database connection.
danielk197765904932004-05-26 06:18:37 +00003107**
mihailimebe796c2008-06-21 20:11:17 +00003108** The second parameter is the name of the SQL function to be created or
3109** redefined. The length of the name is limited to 255 bytes, exclusive of
3110** the zero-terminator. Note that the name length limit is in bytes, not
drh6ed48bf2007-06-14 20:57:18 +00003111** characters. Any attempt to create a function with a longer name
mihailimebe796c2008-06-21 20:11:17 +00003112** will result in [SQLITE_ERROR] being returned.
drh6ed48bf2007-06-14 20:57:18 +00003113**
drhc8075422008-09-10 13:09:23 +00003114** The third parameter (nArg)
3115** is the number of arguments that the SQL function or
drh97602f82009-05-24 11:07:49 +00003116** aggregate takes. If this parameter is -1, then the SQL function or
3117** aggregate may take any number of arguments between 0 and the limit
3118** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third
drh09943b52009-05-24 21:59:27 +00003119** parameter is less than -1 or greater than 127 then the behavior is
3120** undefined.
danielk197765904932004-05-26 06:18:37 +00003121**
mihailimebe796c2008-06-21 20:11:17 +00003122** The fourth parameter, eTextRep, specifies what
drh6ed48bf2007-06-14 20:57:18 +00003123** [SQLITE_UTF8 | text encoding] this SQL function prefers for
3124** its parameters. Any SQL function implementation should be able to work
3125** work with UTF-8, UTF-16le, or UTF-16be. But some implementations may be
3126** more efficient with one encoding than another. It is allowed to
drh6d2069d2007-08-14 01:58:53 +00003127** invoke sqlite3_create_function() or sqlite3_create_function16() multiple
drh6ed48bf2007-06-14 20:57:18 +00003128** times with the same function but with different values of eTextRep.
3129** When multiple implementations of the same function are available, SQLite
3130** will pick the one that involves the least amount of data conversion.
mihailimebe796c2008-06-21 20:11:17 +00003131** If there is only a single implementation which does not care what text
3132** encoding is used, then the fourth argument should be [SQLITE_ANY].
drh6ed48bf2007-06-14 20:57:18 +00003133**
mihailimebe796c2008-06-21 20:11:17 +00003134** The fifth parameter is an arbitrary pointer. The implementation of the
3135** function can gain access to this pointer using [sqlite3_user_data()].
danielk1977d02eb1f2004-06-06 09:44:03 +00003136**
danielk197765904932004-05-26 06:18:37 +00003137** The seventh, eighth and ninth parameters, xFunc, xStep and xFinal, are
mihailimebe796c2008-06-21 20:11:17 +00003138** pointers to C-language functions that implement the SQL function or
3139** aggregate. A scalar SQL function requires an implementation of the xFunc
3140** callback only, NULL pointers should be passed as the xStep and xFinal
3141** parameters. An aggregate SQL function requires an implementation of xStep
3142** and xFinal and NULL should be passed for xFunc. To delete an existing
3143** SQL function or aggregate, pass NULL for all three function callbacks.
drh6ed48bf2007-06-14 20:57:18 +00003144**
3145** It is permitted to register multiple implementations of the same
3146** functions with the same name but with either differing numbers of
shane26b34032008-05-23 17:21:09 +00003147** arguments or differing preferred text encodings. SQLite will use
drh6ed48bf2007-06-14 20:57:18 +00003148** the implementation most closely matches the way in which the
drhc8075422008-09-10 13:09:23 +00003149** SQL function is used. A function implementation with a non-negative
3150** nArg parameter is a better match than a function implementation with
3151** a negative nArg. A function where the preferred text encoding
3152** matches the database encoding is a better
3153** match than a function where the encoding is different.
3154** A function where the encoding difference is between UTF16le and UTF16be
3155** is a closer match than a function where the encoding difference is
3156** between UTF8 and UTF16.
3157**
3158** Built-in functions may be overloaded by new application-defined functions.
3159** The first application-defined function with a given name overrides all
3160** built-in functions in the same [database connection] with the same name.
3161** Subsequent application-defined functions of the same name only override
3162** prior application-defined functions that are an exact match for the
3163** number of parameters and preferred encoding.
3164**
3165** An application-defined function is permitted to call other
3166** SQLite interfaces. However, such calls must not
3167** close the database connection nor finalize or reset the prepared
3168** statement in which the function is running.
drh21ac7f92008-01-31 12:26:49 +00003169**
drh8b39db12009-02-18 18:37:58 +00003170** Requirements:
drh09943b52009-05-24 21:59:27 +00003171** [H16103] [H16106] [H16109] [H16112] [H16118] [H16121] [H16127]
drh8b39db12009-02-18 18:37:58 +00003172** [H16130] [H16133] [H16136] [H16139] [H16142]
danielk197765904932004-05-26 06:18:37 +00003173*/
3174int sqlite3_create_function(
drh33c1be32008-01-30 16:16:14 +00003175 sqlite3 *db,
danielk197765904932004-05-26 06:18:37 +00003176 const char *zFunctionName,
3177 int nArg,
3178 int eTextRep,
drh33c1be32008-01-30 16:16:14 +00003179 void *pApp,
danielk197765904932004-05-26 06:18:37 +00003180 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
3181 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
3182 void (*xFinal)(sqlite3_context*)
3183);
3184int sqlite3_create_function16(
drh33c1be32008-01-30 16:16:14 +00003185 sqlite3 *db,
danielk197765904932004-05-26 06:18:37 +00003186 const void *zFunctionName,
3187 int nArg,
3188 int eTextRep,
drh33c1be32008-01-30 16:16:14 +00003189 void *pApp,
danielk197765904932004-05-26 06:18:37 +00003190 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
3191 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
3192 void (*xFinal)(sqlite3_context*)
3193);
3194
3195/*
drh9cd29642008-07-23 00:52:55 +00003196** CAPI3REF: Text Encodings {H10267} <S50200> <H16100>
drh6ed48bf2007-06-14 20:57:18 +00003197**
3198** These constant define integer codes that represent the various
3199** text encodings supported by SQLite.
danielk197765904932004-05-26 06:18:37 +00003200*/
drh6ed48bf2007-06-14 20:57:18 +00003201#define SQLITE_UTF8 1
3202#define SQLITE_UTF16LE 2
3203#define SQLITE_UTF16BE 3
3204#define SQLITE_UTF16 4 /* Use native byte order */
3205#define SQLITE_ANY 5 /* sqlite3_create_function only */
3206#define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */
danielk197765904932004-05-26 06:18:37 +00003207
danielk19770ffba6b2004-05-24 09:10:10 +00003208/*
drhd5a68d32008-08-04 13:44:57 +00003209** CAPI3REF: Deprecated Functions
3210** DEPRECATED
drh6ed48bf2007-06-14 20:57:18 +00003211**
drhd5a68d32008-08-04 13:44:57 +00003212** These functions are [deprecated]. In order to maintain
3213** backwards compatibility with older code, these functions continue
3214** to be supported. However, new applications should avoid
drh6ed48bf2007-06-14 20:57:18 +00003215** the use of these functions. To help encourage people to avoid
shane7ba429a2008-11-10 17:08:49 +00003216** using these functions, we are not going to tell you what they do.
drh6ed48bf2007-06-14 20:57:18 +00003217*/
shaneeec556d2008-10-12 00:27:53 +00003218#ifndef SQLITE_OMIT_DEPRECATED
shanea79c3cc2008-08-11 17:27:01 +00003219SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*);
3220SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*);
3221SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*);
3222SQLITE_DEPRECATED int sqlite3_global_recover(void);
3223SQLITE_DEPRECATED void sqlite3_thread_cleanup(void);
3224SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),void*,sqlite3_int64);
shaneeec556d2008-10-12 00:27:53 +00003225#endif
drh6ed48bf2007-06-14 20:57:18 +00003226
3227/*
drh9cd29642008-07-23 00:52:55 +00003228** CAPI3REF: Obtaining SQL Function Parameter Values {H15100} <S20200>
drh6ed48bf2007-06-14 20:57:18 +00003229**
3230** The C-language implementation of SQL functions and aggregates uses
3231** this set of interface routines to access the parameter values on
3232** the function or aggregate.
3233**
3234** The xFunc (for scalar functions) or xStep (for aggregates) parameters
3235** to [sqlite3_create_function()] and [sqlite3_create_function16()]
3236** define callbacks that implement the SQL functions and aggregates.
3237** The 4th parameter to these callbacks is an array of pointers to
drhaa28e142008-03-18 13:47:20 +00003238** [protected sqlite3_value] objects. There is one [sqlite3_value] object for
drh6ed48bf2007-06-14 20:57:18 +00003239** each parameter to the SQL function. These routines are used to
3240** extract values from the [sqlite3_value] objects.
3241**
drhaa28e142008-03-18 13:47:20 +00003242** These routines work only with [protected sqlite3_value] objects.
3243** Any attempt to use these routines on an [unprotected sqlite3_value]
3244** object results in undefined behavior.
3245**
mihailim1c492652008-06-21 18:02:16 +00003246** These routines work just like the corresponding [column access functions]
3247** except that these routines take a single [protected sqlite3_value] object
3248** pointer instead of a [sqlite3_stmt*] pointer and an integer column number.
drh6ed48bf2007-06-14 20:57:18 +00003249**
mihailimebe796c2008-06-21 20:11:17 +00003250** The sqlite3_value_text16() interface extracts a UTF-16 string
drh6ed48bf2007-06-14 20:57:18 +00003251** in the native byte-order of the host machine. The
3252** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces
mihailimebe796c2008-06-21 20:11:17 +00003253** extract UTF-16 strings as big-endian and little-endian respectively.
drh6ed48bf2007-06-14 20:57:18 +00003254**
3255** The sqlite3_value_numeric_type() interface attempts to apply
3256** numeric affinity to the value. This means that an attempt is
3257** made to convert the value to an integer or floating point. If
drhf5befa02007-12-06 02:42:07 +00003258** such a conversion is possible without loss of information (in other
mihailimebe796c2008-06-21 20:11:17 +00003259** words, if the value is a string that looks like a number)
3260** then the conversion is performed. Otherwise no conversion occurs.
3261** The [SQLITE_INTEGER | datatype] after conversion is returned.
drh6ed48bf2007-06-14 20:57:18 +00003262**
mihailimebe796c2008-06-21 20:11:17 +00003263** Please pay particular attention to the fact that the pointer returned
3264** from [sqlite3_value_blob()], [sqlite3_value_text()], or
drh6ed48bf2007-06-14 20:57:18 +00003265** [sqlite3_value_text16()] can be invalidated by a subsequent call to
drh6d2069d2007-08-14 01:58:53 +00003266** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()],
mihailimebe796c2008-06-21 20:11:17 +00003267** or [sqlite3_value_text16()].
drhe53831d2007-08-17 01:14:38 +00003268**
3269** These routines must be called from the same thread as
drhaa28e142008-03-18 13:47:20 +00003270** the SQL function that supplied the [sqlite3_value*] parameters.
drhf5befa02007-12-06 02:42:07 +00003271**
drh8b39db12009-02-18 18:37:58 +00003272** Requirements:
3273** [H15103] [H15106] [H15109] [H15112] [H15115] [H15118] [H15121] [H15124]
3274** [H15127] [H15130] [H15133] [H15136]
danielk19770ffba6b2004-05-24 09:10:10 +00003275*/
drhf4479502004-05-27 03:12:53 +00003276const void *sqlite3_value_blob(sqlite3_value*);
3277int sqlite3_value_bytes(sqlite3_value*);
3278int sqlite3_value_bytes16(sqlite3_value*);
3279double sqlite3_value_double(sqlite3_value*);
3280int sqlite3_value_int(sqlite3_value*);
drh6d2069d2007-08-14 01:58:53 +00003281sqlite3_int64 sqlite3_value_int64(sqlite3_value*);
drhf4479502004-05-27 03:12:53 +00003282const unsigned char *sqlite3_value_text(sqlite3_value*);
3283const void *sqlite3_value_text16(sqlite3_value*);
danielk1977d8123362004-06-12 09:25:12 +00003284const void *sqlite3_value_text16le(sqlite3_value*);
3285const void *sqlite3_value_text16be(sqlite3_value*);
danielk197793d46752004-05-23 13:30:58 +00003286int sqlite3_value_type(sqlite3_value*);
drh29d72102006-02-09 22:13:41 +00003287int sqlite3_value_numeric_type(sqlite3_value*);
danielk19770ffba6b2004-05-24 09:10:10 +00003288
3289/*
drh9cd29642008-07-23 00:52:55 +00003290** CAPI3REF: Obtain Aggregate Function Context {H16210} <S20200>
drh6ed48bf2007-06-14 20:57:18 +00003291**
3292** The implementation of aggregate SQL functions use this routine to allocate
mihailimebe796c2008-06-21 20:11:17 +00003293** a structure for storing their state.
3294**
3295** The first time the sqlite3_aggregate_context() routine is called for a
3296** particular aggregate, SQLite allocates nBytes of memory, zeroes out that
3297** memory, and returns a pointer to it. On second and subsequent calls to
3298** sqlite3_aggregate_context() for the same aggregate function index,
3299** the same buffer is returned. The implementation of the aggregate can use
3300** the returned buffer to accumulate data.
danielk19770ae8b832004-05-25 12:05:56 +00003301**
drhafc91042008-02-21 02:09:45 +00003302** SQLite automatically frees the allocated buffer when the aggregate
3303** query concludes.
drh6ed48bf2007-06-14 20:57:18 +00003304**
mihailimebe796c2008-06-21 20:11:17 +00003305** The first parameter should be a copy of the
3306** [sqlite3_context | SQL function context] that is the first parameter
3307** to the callback routine that implements the aggregate function.
drhe53831d2007-08-17 01:14:38 +00003308**
3309** This routine must be called from the same thread in which
drh605264d2007-08-21 15:13:19 +00003310** the aggregate SQL function is running.
drhafc91042008-02-21 02:09:45 +00003311**
drh8b39db12009-02-18 18:37:58 +00003312** Requirements:
3313** [H16211] [H16213] [H16215] [H16217]
danielk19770ae8b832004-05-25 12:05:56 +00003314*/
drh4f26d6c2004-05-26 23:25:30 +00003315void *sqlite3_aggregate_context(sqlite3_context*, int nBytes);
danielk19777e18c252004-05-25 11:47:24 +00003316
3317/*
drh9cd29642008-07-23 00:52:55 +00003318** CAPI3REF: User Data For Functions {H16240} <S20200>
drh6ed48bf2007-06-14 20:57:18 +00003319**
drhafc91042008-02-21 02:09:45 +00003320** The sqlite3_user_data() interface returns a copy of
drhf5befa02007-12-06 02:42:07 +00003321** the pointer that was the pUserData parameter (the 5th parameter)
shane26b34032008-05-23 17:21:09 +00003322** of the [sqlite3_create_function()]
drhf5befa02007-12-06 02:42:07 +00003323** and [sqlite3_create_function16()] routines that originally
3324** registered the application defined function. {END}
drhe53831d2007-08-17 01:14:38 +00003325**
drhafc91042008-02-21 02:09:45 +00003326** This routine must be called from the same thread in which
drhf5befa02007-12-06 02:42:07 +00003327** the application-defined function is running.
drhafc91042008-02-21 02:09:45 +00003328**
drh8b39db12009-02-18 18:37:58 +00003329** Requirements:
3330** [H16243]
danielk19777e18c252004-05-25 11:47:24 +00003331*/
3332void *sqlite3_user_data(sqlite3_context*);
3333
3334/*
drhb25f9d82008-07-23 15:40:06 +00003335** CAPI3REF: Database Connection For Functions {H16250} <S60600><S20200>
drhfa4a4b92008-03-19 21:45:51 +00003336**
3337** The sqlite3_context_db_handle() interface returns a copy of
3338** the pointer to the [database connection] (the 1st parameter)
shane26b34032008-05-23 17:21:09 +00003339** of the [sqlite3_create_function()]
drhfa4a4b92008-03-19 21:45:51 +00003340** and [sqlite3_create_function16()] routines that originally
3341** registered the application defined function.
3342**
drh8b39db12009-02-18 18:37:58 +00003343** Requirements:
3344** [H16253]
drhfa4a4b92008-03-19 21:45:51 +00003345*/
3346sqlite3 *sqlite3_context_db_handle(sqlite3_context*);
3347
3348/*
drh9cd29642008-07-23 00:52:55 +00003349** CAPI3REF: Function Auxiliary Data {H16270} <S20200>
drh6ed48bf2007-06-14 20:57:18 +00003350**
3351** The following two functions may be used by scalar SQL functions to
mihailimebe796c2008-06-21 20:11:17 +00003352** associate metadata with argument values. If the same value is passed to
drh6ed48bf2007-06-14 20:57:18 +00003353** multiple invocations of the same SQL function during query execution, under
mihailimebe796c2008-06-21 20:11:17 +00003354** some circumstances the associated metadata may be preserved. This may
danielk1977682f68b2004-06-05 10:22:17 +00003355** be used, for example, to add a regular-expression matching scalar
3356** function. The compiled version of the regular expression is stored as
mihailimebe796c2008-06-21 20:11:17 +00003357** metadata associated with the SQL value passed as the regular expression
drh6ed48bf2007-06-14 20:57:18 +00003358** pattern. The compiled regular expression can be reused on multiple
3359** invocations of the same function so that the original pattern string
3360** does not need to be recompiled on each invocation.
danielk1977682f68b2004-06-05 10:22:17 +00003361**
mihailimebe796c2008-06-21 20:11:17 +00003362** The sqlite3_get_auxdata() interface returns a pointer to the metadata
drhf5befa02007-12-06 02:42:07 +00003363** associated by the sqlite3_set_auxdata() function with the Nth argument
mihailimebe796c2008-06-21 20:11:17 +00003364** value to the application-defined function. If no metadata has been ever
3365** been set for the Nth argument of the function, or if the corresponding
3366** function parameter has changed since the meta-data was set,
3367** then sqlite3_get_auxdata() returns a NULL pointer.
danielk1977682f68b2004-06-05 10:22:17 +00003368**
mihailimebe796c2008-06-21 20:11:17 +00003369** The sqlite3_set_auxdata() interface saves the metadata
3370** pointed to by its 3rd parameter as the metadata for the N-th
drhafc91042008-02-21 02:09:45 +00003371** argument of the application-defined function. Subsequent
drhf5befa02007-12-06 02:42:07 +00003372** calls to sqlite3_get_auxdata() might return this data, if it has
mihailimebe796c2008-06-21 20:11:17 +00003373** not been destroyed.
3374** If it is not NULL, SQLite will invoke the destructor
drhf5befa02007-12-06 02:42:07 +00003375** function given by the 4th parameter to sqlite3_set_auxdata() on
mihailimebe796c2008-06-21 20:11:17 +00003376** the metadata when the corresponding function parameter changes
drhafc91042008-02-21 02:09:45 +00003377** or when the SQL statement completes, whichever comes first.
3378**
mihailimebe796c2008-06-21 20:11:17 +00003379** SQLite is free to call the destructor and drop metadata on any
3380** parameter of any function at any time. The only guarantee is that
3381** the destructor will be called before the metadata is dropped.
danielk1977682f68b2004-06-05 10:22:17 +00003382**
mihailimebe796c2008-06-21 20:11:17 +00003383** In practice, metadata is preserved between function calls for
danielk1977682f68b2004-06-05 10:22:17 +00003384** expressions that are constant at compile time. This includes literal
3385** values and SQL variables.
drhe53831d2007-08-17 01:14:38 +00003386**
drhb21c8cd2007-08-21 19:33:56 +00003387** These routines must be called from the same thread in which
3388** the SQL function is running.
drhafc91042008-02-21 02:09:45 +00003389**
drh8b39db12009-02-18 18:37:58 +00003390** Requirements:
3391** [H16272] [H16274] [H16276] [H16277] [H16278] [H16279]
danielk1977682f68b2004-06-05 10:22:17 +00003392*/
drhf5befa02007-12-06 02:42:07 +00003393void *sqlite3_get_auxdata(sqlite3_context*, int N);
3394void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*));
danielk1977682f68b2004-06-05 10:22:17 +00003395
drha2854222004-06-17 19:04:17 +00003396
3397/*
drhb25f9d82008-07-23 15:40:06 +00003398** CAPI3REF: Constants Defining Special Destructor Behavior {H10280} <S30100>
drh6ed48bf2007-06-14 20:57:18 +00003399**
mihailimebe796c2008-06-21 20:11:17 +00003400** These are special values for the destructor that is passed in as the
drh6ed48bf2007-06-14 20:57:18 +00003401** final argument to routines like [sqlite3_result_blob()]. If the destructor
drha2854222004-06-17 19:04:17 +00003402** argument is SQLITE_STATIC, it means that the content pointer is constant
mihailimebe796c2008-06-21 20:11:17 +00003403** and will never change. It does not need to be destroyed. The
drha2854222004-06-17 19:04:17 +00003404** SQLITE_TRANSIENT value means that the content will likely change in
3405** the near future and that SQLite should make its own private copy of
3406** the content before returning.
drh6c9121a2007-01-26 00:51:43 +00003407**
3408** The typedef is necessary to work around problems in certain
3409** C++ compilers. See ticket #2191.
drha2854222004-06-17 19:04:17 +00003410*/
drh6c9121a2007-01-26 00:51:43 +00003411typedef void (*sqlite3_destructor_type)(void*);
3412#define SQLITE_STATIC ((sqlite3_destructor_type)0)
3413#define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1)
danielk1977d8123362004-06-12 09:25:12 +00003414
danielk1977682f68b2004-06-05 10:22:17 +00003415/*
drh9cd29642008-07-23 00:52:55 +00003416** CAPI3REF: Setting The Result Of An SQL Function {H16400} <S20200>
drh6ed48bf2007-06-14 20:57:18 +00003417**
3418** These routines are used by the xFunc or xFinal callbacks that
3419** implement SQL functions and aggregates. See
3420** [sqlite3_create_function()] and [sqlite3_create_function16()]
3421** for additional information.
3422**
mihailimebe796c2008-06-21 20:11:17 +00003423** These functions work very much like the [parameter binding] family of
3424** functions used to bind values to host parameters in prepared statements.
3425** Refer to the [SQL parameter] documentation for additional information.
drh6ed48bf2007-06-14 20:57:18 +00003426**
drhafc91042008-02-21 02:09:45 +00003427** The sqlite3_result_blob() interface sets the result from
mihailimebe796c2008-06-21 20:11:17 +00003428** an application-defined function to be the BLOB whose content is pointed
drhf5befa02007-12-06 02:42:07 +00003429** to by the second parameter and which is N bytes long where N is the
mihailimebe796c2008-06-21 20:11:17 +00003430** third parameter.
3431**
shane26b34032008-05-23 17:21:09 +00003432** The sqlite3_result_zeroblob() interfaces set the result of
mihailimebe796c2008-06-21 20:11:17 +00003433** the application-defined function to be a BLOB containing all zero
drhf5befa02007-12-06 02:42:07 +00003434** bytes and N bytes in size, where N is the value of the 2nd parameter.
drh6ed48bf2007-06-14 20:57:18 +00003435**
drhafc91042008-02-21 02:09:45 +00003436** The sqlite3_result_double() interface sets the result from
mihailimebe796c2008-06-21 20:11:17 +00003437** an application-defined function to be a floating point value specified
drhf5befa02007-12-06 02:42:07 +00003438** by its 2nd argument.
drhe53831d2007-08-17 01:14:38 +00003439**
drhafc91042008-02-21 02:09:45 +00003440** The sqlite3_result_error() and sqlite3_result_error16() functions
drhf5befa02007-12-06 02:42:07 +00003441** cause the implemented SQL function to throw an exception.
drhafc91042008-02-21 02:09:45 +00003442** SQLite uses the string pointed to by the
drhf5befa02007-12-06 02:42:07 +00003443** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16()
drhafc91042008-02-21 02:09:45 +00003444** as the text of an error message. SQLite interprets the error
mihailimebe796c2008-06-21 20:11:17 +00003445** message string from sqlite3_result_error() as UTF-8. SQLite
3446** interprets the string from sqlite3_result_error16() as UTF-16 in native
drhafc91042008-02-21 02:09:45 +00003447** byte order. If the third parameter to sqlite3_result_error()
drhf5befa02007-12-06 02:42:07 +00003448** or sqlite3_result_error16() is negative then SQLite takes as the error
3449** message all text up through the first zero character.
drhafc91042008-02-21 02:09:45 +00003450** If the third parameter to sqlite3_result_error() or
drhf5befa02007-12-06 02:42:07 +00003451** sqlite3_result_error16() is non-negative then SQLite takes that many
3452** bytes (not characters) from the 2nd parameter as the error message.
drhafc91042008-02-21 02:09:45 +00003453** The sqlite3_result_error() and sqlite3_result_error16()
mihailimebe796c2008-06-21 20:11:17 +00003454** routines make a private copy of the error message text before
drhafc91042008-02-21 02:09:45 +00003455** they return. Hence, the calling function can deallocate or
drhf5befa02007-12-06 02:42:07 +00003456** modify the text after they return without harm.
drh69544ec2008-02-06 14:11:34 +00003457** The sqlite3_result_error_code() function changes the error code
3458** returned by SQLite as a result of an error in a function. By default,
drh00e087b2008-04-10 17:14:07 +00003459** the error code is SQLITE_ERROR. A subsequent call to sqlite3_result_error()
3460** or sqlite3_result_error16() resets the error code to SQLITE_ERROR.
drhf5befa02007-12-06 02:42:07 +00003461**
mihailimebe796c2008-06-21 20:11:17 +00003462** The sqlite3_result_toobig() interface causes SQLite to throw an error
3463** indicating that a string or BLOB is to long to represent.
3464**
3465** The sqlite3_result_nomem() interface causes SQLite to throw an error
3466** indicating that a memory allocation failed.
drhf5befa02007-12-06 02:42:07 +00003467**
drhafc91042008-02-21 02:09:45 +00003468** The sqlite3_result_int() interface sets the return value
drhf5befa02007-12-06 02:42:07 +00003469** of the application-defined function to be the 32-bit signed integer
3470** value given in the 2nd argument.
drhafc91042008-02-21 02:09:45 +00003471** The sqlite3_result_int64() interface sets the return value
drhf5befa02007-12-06 02:42:07 +00003472** of the application-defined function to be the 64-bit signed integer
3473** value given in the 2nd argument.
3474**
drhafc91042008-02-21 02:09:45 +00003475** The sqlite3_result_null() interface sets the return value
drhf5befa02007-12-06 02:42:07 +00003476** of the application-defined function to be NULL.
3477**
mihailimebe796c2008-06-21 20:11:17 +00003478** The sqlite3_result_text(), sqlite3_result_text16(),
drhf5befa02007-12-06 02:42:07 +00003479** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces
3480** set the return value of the application-defined function to be
3481** a text string which is represented as UTF-8, UTF-16 native byte order,
3482** UTF-16 little endian, or UTF-16 big endian, respectively.
drhafc91042008-02-21 02:09:45 +00003483** SQLite takes the text result from the application from
drhf5befa02007-12-06 02:42:07 +00003484** the 2nd parameter of the sqlite3_result_text* interfaces.
drhafc91042008-02-21 02:09:45 +00003485** If the 3rd parameter to the sqlite3_result_text* interfaces
mihailimebe796c2008-06-21 20:11:17 +00003486** is negative, then SQLite takes result text from the 2nd parameter
drhf5befa02007-12-06 02:42:07 +00003487** through the first zero character.
drhafc91042008-02-21 02:09:45 +00003488** If the 3rd parameter to the sqlite3_result_text* interfaces
drhf5befa02007-12-06 02:42:07 +00003489** is non-negative, then as many bytes (not characters) of the text
3490** pointed to by the 2nd parameter are taken as the application-defined
3491** function result.
drhafc91042008-02-21 02:09:45 +00003492** If the 4th parameter to the sqlite3_result_text* interfaces
drhf5befa02007-12-06 02:42:07 +00003493** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that
mihailimebe796c2008-06-21 20:11:17 +00003494** function as the destructor on the text or BLOB result when it has
drhf5befa02007-12-06 02:42:07 +00003495** finished using that result.
drh9e42f8a2009-08-13 20:15:29 +00003496** If the 4th parameter to the sqlite3_result_text* interfaces or to
mihailimebe796c2008-06-21 20:11:17 +00003497** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite
3498** assumes that the text or BLOB result is in constant space and does not
drh9e42f8a2009-08-13 20:15:29 +00003499** copy the content of the parameter nor call a destructor on the content
3500** when it has finished using that result.
drhafc91042008-02-21 02:09:45 +00003501** If the 4th parameter to the sqlite3_result_text* interfaces
drhf5befa02007-12-06 02:42:07 +00003502** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT
3503** then SQLite makes a copy of the result into space obtained from
3504** from [sqlite3_malloc()] before it returns.
3505**
drhafc91042008-02-21 02:09:45 +00003506** The sqlite3_result_value() interface sets the result of
drhaa28e142008-03-18 13:47:20 +00003507** the application-defined function to be a copy the
3508** [unprotected sqlite3_value] object specified by the 2nd parameter. The
drhf5befa02007-12-06 02:42:07 +00003509** sqlite3_result_value() interface makes a copy of the [sqlite3_value]
mihailimebe796c2008-06-21 20:11:17 +00003510** so that the [sqlite3_value] specified in the parameter may change or
drhf5befa02007-12-06 02:42:07 +00003511** be deallocated after sqlite3_result_value() returns without harm.
drhaa28e142008-03-18 13:47:20 +00003512** A [protected sqlite3_value] object may always be used where an
3513** [unprotected sqlite3_value] object is required, so either
3514** kind of [sqlite3_value] object can be used with this interface.
drhf5befa02007-12-06 02:42:07 +00003515**
mihailimebe796c2008-06-21 20:11:17 +00003516** If these routines are called from within the different thread
shane26b34032008-05-23 17:21:09 +00003517** than the one containing the application-defined function that received
drhf5befa02007-12-06 02:42:07 +00003518** the [sqlite3_context] pointer, the results are undefined.
drhafc91042008-02-21 02:09:45 +00003519**
drh8b39db12009-02-18 18:37:58 +00003520** Requirements:
3521** [H16403] [H16406] [H16409] [H16412] [H16415] [H16418] [H16421] [H16424]
3522** [H16427] [H16430] [H16433] [H16436] [H16439] [H16442] [H16445] [H16448]
3523** [H16451] [H16454] [H16457] [H16460] [H16463]
danielk19777e18c252004-05-25 11:47:24 +00003524*/
danielk1977d8123362004-06-12 09:25:12 +00003525void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*));
drh4f26d6c2004-05-26 23:25:30 +00003526void sqlite3_result_double(sqlite3_context*, double);
danielk19777e18c252004-05-25 11:47:24 +00003527void sqlite3_result_error(sqlite3_context*, const char*, int);
3528void sqlite3_result_error16(sqlite3_context*, const void*, int);
drh6ed48bf2007-06-14 20:57:18 +00003529void sqlite3_result_error_toobig(sqlite3_context*);
danielk1977a1644fd2007-08-29 12:31:25 +00003530void sqlite3_result_error_nomem(sqlite3_context*);
drh69544ec2008-02-06 14:11:34 +00003531void sqlite3_result_error_code(sqlite3_context*, int);
drh4f26d6c2004-05-26 23:25:30 +00003532void sqlite3_result_int(sqlite3_context*, int);
drh6d2069d2007-08-14 01:58:53 +00003533void sqlite3_result_int64(sqlite3_context*, sqlite3_int64);
drh4f26d6c2004-05-26 23:25:30 +00003534void sqlite3_result_null(sqlite3_context*);
danielk1977d8123362004-06-12 09:25:12 +00003535void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*));
3536void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*));
3537void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*));
3538void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*));
drh4f26d6c2004-05-26 23:25:30 +00003539void sqlite3_result_value(sqlite3_context*, sqlite3_value*);
drhb026e052007-05-02 01:34:31 +00003540void sqlite3_result_zeroblob(sqlite3_context*, int n);
drhf9b596e2004-05-26 16:54:42 +00003541
drh52619df2004-06-11 17:48:02 +00003542/*
drh9cd29642008-07-23 00:52:55 +00003543** CAPI3REF: Define New Collating Sequences {H16600} <S20300>
drh6ed48bf2007-06-14 20:57:18 +00003544**
3545** These functions are used to add new collation sequences to the
mihailimebe796c2008-06-21 20:11:17 +00003546** [database connection] specified as the first argument.
danielk19777cedc8d2004-06-10 10:50:08 +00003547**
3548** The name of the new collation sequence is specified as a UTF-8 string
drh6ed48bf2007-06-14 20:57:18 +00003549** for sqlite3_create_collation() and sqlite3_create_collation_v2()
drhafc91042008-02-21 02:09:45 +00003550** and a UTF-16 string for sqlite3_create_collation16(). In all cases
drh6ed48bf2007-06-14 20:57:18 +00003551** the name is passed as the second function argument.
danielk19777cedc8d2004-06-10 10:50:08 +00003552**
drh4145f832007-10-12 18:30:12 +00003553** The third argument may be one of the constants [SQLITE_UTF8],
drh51c7d862009-04-27 18:46:06 +00003554** [SQLITE_UTF16LE], or [SQLITE_UTF16BE], indicating that the user-supplied
danielk19777cedc8d2004-06-10 10:50:08 +00003555** routine expects to be passed pointers to strings encoded using UTF-8,
mihailimebe796c2008-06-21 20:11:17 +00003556** UTF-16 little-endian, or UTF-16 big-endian, respectively. The
drh51c7d862009-04-27 18:46:06 +00003557** third argument might also be [SQLITE_UTF16] to indicate that the routine
3558** expects pointers to be UTF-16 strings in the native byte order, or the
3559** argument can be [SQLITE_UTF16_ALIGNED] if the
drh4145f832007-10-12 18:30:12 +00003560** the routine expects pointers to 16-bit word aligned strings
drh51c7d862009-04-27 18:46:06 +00003561** of UTF-16 in the native byte order.
danielk19777cedc8d2004-06-10 10:50:08 +00003562**
3563** A pointer to the user supplied routine must be passed as the fifth
drhafc91042008-02-21 02:09:45 +00003564** argument. If it is NULL, this is the same as deleting the collation
drhf5befa02007-12-06 02:42:07 +00003565** sequence (so that SQLite cannot call it anymore).
mihailimebe796c2008-06-21 20:11:17 +00003566** Each time the application supplied function is invoked, it is passed
3567** as its first parameter a copy of the void* passed as the fourth argument
3568** to sqlite3_create_collation() or sqlite3_create_collation16().
danielk19777cedc8d2004-06-10 10:50:08 +00003569**
drhf5befa02007-12-06 02:42:07 +00003570** The remaining arguments to the application-supplied routine are two strings,
drh33c1be32008-01-30 16:16:14 +00003571** each represented by a (length, data) pair and encoded in the encoding
danielk19777cedc8d2004-06-10 10:50:08 +00003572** that was passed as the third argument when the collation sequence was
mihailim04bcc002008-06-22 10:21:27 +00003573** registered. {END} The application defined collation routine should
mihailimebe796c2008-06-21 20:11:17 +00003574** return negative, zero or positive if the first string is less than,
3575** equal to, or greater than the second string. i.e. (STRING1 - STRING2).
drh6ed48bf2007-06-14 20:57:18 +00003576**
3577** The sqlite3_create_collation_v2() works like sqlite3_create_collation()
shane26b34032008-05-23 17:21:09 +00003578** except that it takes an extra argument which is a destructor for
drhafc91042008-02-21 02:09:45 +00003579** the collation. The destructor is called when the collation is
drh6ed48bf2007-06-14 20:57:18 +00003580** destroyed and is passed a copy of the fourth parameter void* pointer
drhf5befa02007-12-06 02:42:07 +00003581** of the sqlite3_create_collation_v2().
mihailimebe796c2008-06-21 20:11:17 +00003582** Collations are destroyed when they are overridden by later calls to the
3583** collation creation functions or when the [database connection] is closed
3584** using [sqlite3_close()].
drhafc91042008-02-21 02:09:45 +00003585**
drh51c7d862009-04-27 18:46:06 +00003586** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()].
3587**
drh8b39db12009-02-18 18:37:58 +00003588** Requirements:
3589** [H16603] [H16604] [H16606] [H16609] [H16612] [H16615] [H16618] [H16621]
3590** [H16624] [H16627] [H16630]
danielk19777cedc8d2004-06-10 10:50:08 +00003591*/
danielk19770202b292004-06-09 09:55:16 +00003592int sqlite3_create_collation(
3593 sqlite3*,
3594 const char *zName,
danielk19777cedc8d2004-06-10 10:50:08 +00003595 int eTextRep,
danielk19770202b292004-06-09 09:55:16 +00003596 void*,
3597 int(*xCompare)(void*,int,const void*,int,const void*)
3598);
drh6ed48bf2007-06-14 20:57:18 +00003599int sqlite3_create_collation_v2(
3600 sqlite3*,
3601 const char *zName,
3602 int eTextRep,
3603 void*,
3604 int(*xCompare)(void*,int,const void*,int,const void*),
3605 void(*xDestroy)(void*)
3606);
danielk19770202b292004-06-09 09:55:16 +00003607int sqlite3_create_collation16(
3608 sqlite3*,
mihailimbda2e622008-06-23 11:23:14 +00003609 const void *zName,
danielk19777cedc8d2004-06-10 10:50:08 +00003610 int eTextRep,
danielk19770202b292004-06-09 09:55:16 +00003611 void*,
3612 int(*xCompare)(void*,int,const void*,int,const void*)
3613);
3614
danielk19777cedc8d2004-06-10 10:50:08 +00003615/*
drh9cd29642008-07-23 00:52:55 +00003616** CAPI3REF: Collation Needed Callbacks {H16700} <S20300>
danielk1977a393c032007-05-07 14:58:53 +00003617**
danielk19777cedc8d2004-06-10 10:50:08 +00003618** To avoid having to register all collation sequences before a database
3619** can be used, a single callback function may be registered with the
mihailimdc884822008-06-22 08:58:50 +00003620** [database connection] to be called whenever an undefined collation
3621** sequence is required.
danielk19777cedc8d2004-06-10 10:50:08 +00003622**
3623** If the function is registered using the sqlite3_collation_needed() API,
3624** then it is passed the names of undefined collation sequences as strings
drh9a247912008-07-22 18:45:08 +00003625** encoded in UTF-8. {H16703} If sqlite3_collation_needed16() is used,
mihailimdc884822008-06-22 08:58:50 +00003626** the names are passed as UTF-16 in machine native byte order.
3627** A call to either function replaces any existing callback.
danielk19777cedc8d2004-06-10 10:50:08 +00003628**
drhafc91042008-02-21 02:09:45 +00003629** When the callback is invoked, the first argument passed is a copy
danielk19777cedc8d2004-06-10 10:50:08 +00003630** of the second argument to sqlite3_collation_needed() or
drhafc91042008-02-21 02:09:45 +00003631** sqlite3_collation_needed16(). The second argument is the database
mihailimdc884822008-06-22 08:58:50 +00003632** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE],
3633** or [SQLITE_UTF16LE], indicating the most desirable form of the collation
3634** sequence function required. The fourth parameter is the name of the
drhafc91042008-02-21 02:09:45 +00003635** required collation sequence.
danielk19777cedc8d2004-06-10 10:50:08 +00003636**
drh6ed48bf2007-06-14 20:57:18 +00003637** The callback function should register the desired collation using
3638** [sqlite3_create_collation()], [sqlite3_create_collation16()], or
3639** [sqlite3_create_collation_v2()].
drhafc91042008-02-21 02:09:45 +00003640**
drh8b39db12009-02-18 18:37:58 +00003641** Requirements:
3642** [H16702] [H16704] [H16706]
danielk19777cedc8d2004-06-10 10:50:08 +00003643*/
3644int sqlite3_collation_needed(
3645 sqlite3*,
3646 void*,
3647 void(*)(void*,sqlite3*,int eTextRep,const char*)
3648);
3649int sqlite3_collation_needed16(
3650 sqlite3*,
3651 void*,
3652 void(*)(void*,sqlite3*,int eTextRep,const void*)
3653);
3654
drh2011d5f2004-07-22 02:40:37 +00003655/*
3656** Specify the key for an encrypted database. This routine should be
3657** called right after sqlite3_open().
3658**
3659** The code to implement this API is not available in the public release
3660** of SQLite.
3661*/
3662int sqlite3_key(
3663 sqlite3 *db, /* Database to be rekeyed */
3664 const void *pKey, int nKey /* The key */
3665);
3666
3667/*
3668** Change the key on an open database. If the current database is not
3669** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the
3670** database is decrypted.
3671**
3672** The code to implement this API is not available in the public release
3673** of SQLite.
3674*/
3675int sqlite3_rekey(
3676 sqlite3 *db, /* Database to be rekeyed */
3677 const void *pKey, int nKey /* The new key */
3678);
danielk19770202b292004-06-09 09:55:16 +00003679
drhab3f9fe2004-08-14 17:10:10 +00003680/*
drhb25f9d82008-07-23 15:40:06 +00003681** CAPI3REF: Suspend Execution For A Short Time {H10530} <S40410>
drh6ed48bf2007-06-14 20:57:18 +00003682**
mihailimdc884822008-06-22 08:58:50 +00003683** The sqlite3_sleep() function causes the current thread to suspend execution
drhfddfa2d2007-12-05 18:05:16 +00003684** for at least a number of milliseconds specified in its parameter.
danielk1977600dd0b2005-01-20 01:14:23 +00003685**
mihailimdc884822008-06-22 08:58:50 +00003686** If the operating system does not support sleep requests with
3687** millisecond time resolution, then the time will be rounded up to
3688** the nearest second. The number of milliseconds of sleep actually
danielk1977600dd0b2005-01-20 01:14:23 +00003689** requested from the operating system is returned.
drh8bacf972007-08-25 16:21:29 +00003690**
drhafc91042008-02-21 02:09:45 +00003691** SQLite implements this interface by calling the xSleep()
3692** method of the default [sqlite3_vfs] object.
3693**
drh8b39db12009-02-18 18:37:58 +00003694** Requirements: [H10533] [H10536]
danielk1977600dd0b2005-01-20 01:14:23 +00003695*/
3696int sqlite3_sleep(int);
3697
3698/*
drhb25f9d82008-07-23 15:40:06 +00003699** CAPI3REF: Name Of The Folder Holding Temporary Files {H10310} <S20000>
drhd89bd002005-01-22 03:03:54 +00003700**
drh6ed48bf2007-06-14 20:57:18 +00003701** If this global variable is made to point to a string which is
shane26b34032008-05-23 17:21:09 +00003702** the name of a folder (a.k.a. directory), then all temporary files
drhab3f9fe2004-08-14 17:10:10 +00003703** created by SQLite will be placed in that directory. If this variable
mihailimdc884822008-06-22 08:58:50 +00003704** is a NULL pointer, then SQLite performs a search for an appropriate
3705** temporary file directory.
drhab3f9fe2004-08-14 17:10:10 +00003706**
drh1a25f112009-04-06 15:55:03 +00003707** It is not safe to read or modify this variable in more than one
3708** thread at a time. It is not safe to read or modify this variable
3709** if a [database connection] is being used at the same time in a separate
3710** thread.
3711** It is intended that this variable be set once
drh4ff7fa02007-09-01 18:17:21 +00003712** as part of process initialization and before any SQLite interface
drh1a25f112009-04-06 15:55:03 +00003713** routines have been called and that this variable remain unchanged
3714** thereafter.
3715**
3716** The [temp_store_directory pragma] may modify this variable and cause
3717** it to point to memory obtained from [sqlite3_malloc]. Furthermore,
3718** the [temp_store_directory pragma] always assumes that any string
3719** that this variable points to is held in memory obtained from
3720** [sqlite3_malloc] and the pragma may attempt to free that memory
3721** using [sqlite3_free].
3722** Hence, if this variable is modified directly, either it should be
3723** made NULL or made to point to memory obtained from [sqlite3_malloc]
3724** or else the use of the [temp_store_directory pragma] should be avoided.
drhab3f9fe2004-08-14 17:10:10 +00003725*/
drh73be5012007-08-08 12:11:21 +00003726SQLITE_EXTERN char *sqlite3_temp_directory;
drhab3f9fe2004-08-14 17:10:10 +00003727
danielk19776b456a22005-03-21 04:04:02 +00003728/*
drh9cd29642008-07-23 00:52:55 +00003729** CAPI3REF: Test For Auto-Commit Mode {H12930} <S60200>
mihailim15194222008-06-22 09:55:14 +00003730** KEYWORDS: {autocommit mode}
danielk19776b456a22005-03-21 04:04:02 +00003731**
shane26b34032008-05-23 17:21:09 +00003732** The sqlite3_get_autocommit() interface returns non-zero or
drhf5befa02007-12-06 02:42:07 +00003733** zero if the given database connection is or is not in autocommit mode,
mihailim04bcc002008-06-22 10:21:27 +00003734** respectively. Autocommit mode is on by default.
mihailimdc884822008-06-22 08:58:50 +00003735** Autocommit mode is disabled by a [BEGIN] statement.
shane26b34032008-05-23 17:21:09 +00003736** Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK].
drhe30f4422007-08-21 16:15:55 +00003737**
drh7c3472a2007-10-03 20:15:28 +00003738** If certain kinds of errors occur on a statement within a multi-statement
mihailimdc884822008-06-22 08:58:50 +00003739** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR],
drh7c3472a2007-10-03 20:15:28 +00003740** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the
drh33c1be32008-01-30 16:16:14 +00003741** transaction might be rolled back automatically. The only way to
mihailimdc884822008-06-22 08:58:50 +00003742** find out whether SQLite automatically rolled back the transaction after
drh33c1be32008-01-30 16:16:14 +00003743** an error is to use this function.
drh7c3472a2007-10-03 20:15:28 +00003744**
drh8b39db12009-02-18 18:37:58 +00003745** If another thread changes the autocommit status of the database
3746** connection while this routine is running, then the return value
3747** is undefined.
drh33c1be32008-01-30 16:16:14 +00003748**
drh8b39db12009-02-18 18:37:58 +00003749** Requirements: [H12931] [H12932] [H12933] [H12934]
drh3e1d8e62005-05-26 16:23:34 +00003750*/
3751int sqlite3_get_autocommit(sqlite3*);
3752
drh51942bc2005-06-12 22:01:42 +00003753/*
drhb25f9d82008-07-23 15:40:06 +00003754** CAPI3REF: Find The Database Handle Of A Prepared Statement {H13120} <S60600>
drh6ed48bf2007-06-14 20:57:18 +00003755**
mihailimdc884822008-06-22 08:58:50 +00003756** The sqlite3_db_handle interface returns the [database connection] handle
drh62b5d2d2009-02-03 18:47:22 +00003757** to which a [prepared statement] belongs. The [database connection]
3758** returned by sqlite3_db_handle is the same [database connection] that was the first argument
mihailimdc884822008-06-22 08:58:50 +00003759** to the [sqlite3_prepare_v2()] call (or its variants) that was used to
3760** create the statement in the first place.
drhafc91042008-02-21 02:09:45 +00003761**
drh8b39db12009-02-18 18:37:58 +00003762** Requirements: [H13123]
drh51942bc2005-06-12 22:01:42 +00003763*/
3764sqlite3 *sqlite3_db_handle(sqlite3_stmt*);
drh3e1d8e62005-05-26 16:23:34 +00003765
drhbb5a9c32008-06-19 02:52:25 +00003766/*
drhb25f9d82008-07-23 15:40:06 +00003767** CAPI3REF: Find the next prepared statement {H13140} <S60600>
drhbb5a9c32008-06-19 02:52:25 +00003768**
mihailimdc884822008-06-22 08:58:50 +00003769** This interface returns a pointer to the next [prepared statement] after
3770** pStmt associated with the [database connection] pDb. If pStmt is NULL
3771** then this interface returns a pointer to the first prepared statement
3772** associated with the database connection pDb. If no prepared statement
3773** satisfies the conditions of this routine, it returns NULL.
drhbb5a9c32008-06-19 02:52:25 +00003774**
drh8b39db12009-02-18 18:37:58 +00003775** The [database connection] pointer D in a call to
3776** [sqlite3_next_stmt(D,S)] must refer to an open database
3777** connection and in particular must not be a NULL pointer.
drhbb5a9c32008-06-19 02:52:25 +00003778**
drh8b39db12009-02-18 18:37:58 +00003779** Requirements: [H13143] [H13146] [H13149] [H13152]
drhbb5a9c32008-06-19 02:52:25 +00003780*/
3781sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt);
3782
drhb37df7b2005-10-13 02:09:49 +00003783/*
drh9cd29642008-07-23 00:52:55 +00003784** CAPI3REF: Commit And Rollback Notification Callbacks {H12950} <S60400>
drh6ed48bf2007-06-14 20:57:18 +00003785**
drhafc91042008-02-21 02:09:45 +00003786** The sqlite3_commit_hook() interface registers a callback
drhabda6112009-05-14 22:37:47 +00003787** function to be invoked whenever a transaction is [COMMIT | committed].
drhafc91042008-02-21 02:09:45 +00003788** Any callback set by a previous call to sqlite3_commit_hook()
drhf5befa02007-12-06 02:42:07 +00003789** for the same database connection is overridden.
drhafc91042008-02-21 02:09:45 +00003790** The sqlite3_rollback_hook() interface registers a callback
drhabda6112009-05-14 22:37:47 +00003791** function to be invoked whenever a transaction is [ROLLBACK | rolled back].
drhafc91042008-02-21 02:09:45 +00003792** Any callback set by a previous call to sqlite3_commit_hook()
drhf5befa02007-12-06 02:42:07 +00003793** for the same database connection is overridden.
mihailimdc884822008-06-22 08:58:50 +00003794** The pArg argument is passed through to the callback.
3795** If the callback on a commit hook function returns non-zero,
3796** then the commit is converted into a rollback.
drh6ed48bf2007-06-14 20:57:18 +00003797**
drhafc91042008-02-21 02:09:45 +00003798** If another function was previously registered, its
drhf5befa02007-12-06 02:42:07 +00003799** pArg value is returned. Otherwise NULL is returned.
drh6ed48bf2007-06-14 20:57:18 +00003800**
drhc8075422008-09-10 13:09:23 +00003801** The callback implementation must not do anything that will modify
3802** the database connection that invoked the callback. Any actions
3803** to modify the database connection must be deferred until after the
3804** completion of the [sqlite3_step()] call that triggered the commit
3805** or rollback hook in the first place.
3806** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
3807** database connections for the meaning of "modify" in this paragraph.
3808**
drhafc91042008-02-21 02:09:45 +00003809** Registering a NULL function disables the callback.
drh6ed48bf2007-06-14 20:57:18 +00003810**
drhabda6112009-05-14 22:37:47 +00003811** When the commit hook callback routine returns zero, the [COMMIT]
3812** operation is allowed to continue normally. If the commit hook
3813** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK].
3814** The rollback hook is invoked on a rollback that results from a commit
3815** hook returning non-zero, just as it would be with any other rollback.
3816**
mihailimdc884822008-06-22 08:58:50 +00003817** For the purposes of this API, a transaction is said to have been
drh6ed48bf2007-06-14 20:57:18 +00003818** rolled back if an explicit "ROLLBACK" statement is executed, or
drhf5befa02007-12-06 02:42:07 +00003819** an error or constraint causes an implicit rollback to occur.
drhafc91042008-02-21 02:09:45 +00003820** The rollback callback is not invoked if a transaction is
drhf5befa02007-12-06 02:42:07 +00003821** automatically rolled back because the database connection is closed.
drhafc91042008-02-21 02:09:45 +00003822** The rollback callback is not invoked if a transaction is
drhf5befa02007-12-06 02:42:07 +00003823** rolled back because a commit callback returned non-zero.
drhafc91042008-02-21 02:09:45 +00003824** <todo> Check on this </todo>
drh6ed48bf2007-06-14 20:57:18 +00003825**
drhabda6112009-05-14 22:37:47 +00003826** See also the [sqlite3_update_hook()] interface.
3827**
drh8b39db12009-02-18 18:37:58 +00003828** Requirements:
3829** [H12951] [H12952] [H12953] [H12954] [H12955]
3830** [H12961] [H12962] [H12963] [H12964]
drh6ed48bf2007-06-14 20:57:18 +00003831*/
3832void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
3833void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);
3834
3835/*
drh9cd29642008-07-23 00:52:55 +00003836** CAPI3REF: Data Change Notification Callbacks {H12970} <S60400>
drh6ed48bf2007-06-14 20:57:18 +00003837**
mihailimdc884822008-06-22 08:58:50 +00003838** The sqlite3_update_hook() interface registers a callback function
3839** with the [database connection] identified by the first argument
3840** to be invoked whenever a row is updated, inserted or deleted.
3841** Any callback set by a previous call to this function
3842** for the same database connection is overridden.
danielk197794eb6a12005-12-15 15:22:08 +00003843**
mihailimdc884822008-06-22 08:58:50 +00003844** The second argument is a pointer to the function to invoke when a
3845** row is updated, inserted or deleted.
3846** The first argument to the callback is a copy of the third argument
3847** to sqlite3_update_hook().
3848** The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE],
3849** or [SQLITE_UPDATE], depending on the operation that caused the callback
3850** to be invoked.
3851** The third and fourth arguments to the callback contain pointers to the
3852** database and table name containing the affected row.
drh49c3d572008-12-15 22:51:38 +00003853** The final callback parameter is the [rowid] of the row.
3854** In the case of an update, this is the [rowid] after the update takes place.
danielk197794eb6a12005-12-15 15:22:08 +00003855**
drhafc91042008-02-21 02:09:45 +00003856** The update hook is not invoked when internal system tables are
danielk197794eb6a12005-12-15 15:22:08 +00003857** modified (i.e. sqlite_master and sqlite_sequence).
danielk197771fd80b2005-12-16 06:54:01 +00003858**
drhabda6112009-05-14 22:37:47 +00003859** In the current implementation, the update hook
3860** is not invoked when duplication rows are deleted because of an
3861** [ON CONFLICT | ON CONFLICT REPLACE] clause. Nor is the update hook
3862** invoked when rows are deleted using the [truncate optimization].
3863** The exceptions defined in this paragraph might change in a future
3864** release of SQLite.
3865**
drhc8075422008-09-10 13:09:23 +00003866** The update hook implementation must not do anything that will modify
3867** the database connection that invoked the update hook. Any actions
3868** to modify the database connection must be deferred until after the
3869** completion of the [sqlite3_step()] call that triggered the update hook.
3870** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
3871** database connections for the meaning of "modify" in this paragraph.
3872**
drhafc91042008-02-21 02:09:45 +00003873** If another function was previously registered, its pArg value
3874** is returned. Otherwise NULL is returned.
3875**
drhabda6112009-05-14 22:37:47 +00003876** See also the [sqlite3_commit_hook()] and [sqlite3_rollback_hook()]
3877** interfaces.
3878**
drh8b39db12009-02-18 18:37:58 +00003879** Requirements:
3880** [H12971] [H12973] [H12975] [H12977] [H12979] [H12981] [H12983] [H12986]
danielk197794eb6a12005-12-15 15:22:08 +00003881*/
danielk197771fd80b2005-12-16 06:54:01 +00003882void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00003883 sqlite3*,
drh6d2069d2007-08-14 01:58:53 +00003884 void(*)(void *,int ,char const *,char const *,sqlite3_int64),
danielk197794eb6a12005-12-15 15:22:08 +00003885 void*
3886);
danielk197713a68c32005-12-15 10:11:30 +00003887
danielk1977f3f06bb2005-12-16 15:24:28 +00003888/*
drh9cd29642008-07-23 00:52:55 +00003889** CAPI3REF: Enable Or Disable Shared Pager Cache {H10330} <S30900>
drhe33b0ed2009-08-06 17:40:45 +00003890** KEYWORDS: {shared cache}
danielk1977f3f06bb2005-12-16 15:24:28 +00003891**
drh6ed48bf2007-06-14 20:57:18 +00003892** This routine enables or disables the sharing of the database cache
mihailimdc884822008-06-22 08:58:50 +00003893** and schema data structures between [database connection | connections]
3894** to the same database. Sharing is enabled if the argument is true
3895** and disabled if the argument is false.
danielk1977f3f06bb2005-12-16 15:24:28 +00003896**
drhaff46972009-02-12 17:07:34 +00003897** Cache sharing is enabled and disabled for an entire process.
mihailimdc884822008-06-22 08:58:50 +00003898** This is a change as of SQLite version 3.5.0. In prior versions of SQLite,
3899** sharing was enabled or disabled for each thread separately.
drh6ed48bf2007-06-14 20:57:18 +00003900**
drhe30f4422007-08-21 16:15:55 +00003901** The cache sharing mode set by this interface effects all subsequent
3902** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()].
drhafc91042008-02-21 02:09:45 +00003903** Existing database connections continue use the sharing mode
3904** that was in effect at the time they were opened.
drh6ed48bf2007-06-14 20:57:18 +00003905**
mihailimdc884822008-06-22 08:58:50 +00003906** Virtual tables cannot be used with a shared cache. When shared
drh4ff7fa02007-09-01 18:17:21 +00003907** cache is enabled, the [sqlite3_create_module()] API used to register
drhafc91042008-02-21 02:09:45 +00003908** virtual tables will always return an error.
drh6ed48bf2007-06-14 20:57:18 +00003909**
mihailimdc884822008-06-22 08:58:50 +00003910** This routine returns [SQLITE_OK] if shared cache was enabled or disabled
3911** successfully. An [error code] is returned otherwise.
drh6ed48bf2007-06-14 20:57:18 +00003912**
drhafc91042008-02-21 02:09:45 +00003913** Shared cache is disabled by default. But this might change in
drh4ff7fa02007-09-01 18:17:21 +00003914** future releases of SQLite. Applications that care about shared
3915** cache setting should set it explicitly.
drhafc91042008-02-21 02:09:45 +00003916**
drhaff46972009-02-12 17:07:34 +00003917** See Also: [SQLite Shared-Cache Mode]
3918**
drh8b39db12009-02-18 18:37:58 +00003919** Requirements: [H10331] [H10336] [H10337] [H10339]
danielk1977aef0bf62005-12-30 16:28:01 +00003920*/
3921int sqlite3_enable_shared_cache(int);
3922
3923/*
drh9cd29642008-07-23 00:52:55 +00003924** CAPI3REF: Attempt To Free Heap Memory {H17340} <S30220>
drh6ed48bf2007-06-14 20:57:18 +00003925**
mihailim04bcc002008-06-22 10:21:27 +00003926** The sqlite3_release_memory() interface attempts to free N bytes
3927** of heap memory by deallocating non-essential memory allocations
3928** held by the database library. {END} Memory used to cache database
3929** pages to improve performance is an example of non-essential memory.
3930** sqlite3_release_memory() returns the number of bytes actually freed,
3931** which might be more or less than the amount requested.
drhafc91042008-02-21 02:09:45 +00003932**
drh8b39db12009-02-18 18:37:58 +00003933** Requirements: [H17341] [H17342]
danielk197752622822006-01-09 09:59:49 +00003934*/
3935int sqlite3_release_memory(int);
3936
3937/*
drh9cd29642008-07-23 00:52:55 +00003938** CAPI3REF: Impose A Limit On Heap Size {H17350} <S30220>
drh6ed48bf2007-06-14 20:57:18 +00003939**
mihailimdc884822008-06-22 08:58:50 +00003940** The sqlite3_soft_heap_limit() interface places a "soft" limit
3941** on the amount of heap memory that may be allocated by SQLite.
3942** If an internal allocation is requested that would exceed the
3943** soft heap limit, [sqlite3_release_memory()] is invoked one or
3944** more times to free up some space before the allocation is performed.
danielk197752622822006-01-09 09:59:49 +00003945**
mihailimdc884822008-06-22 08:58:50 +00003946** The limit is called "soft", because if [sqlite3_release_memory()]
3947** cannot free sufficient memory to prevent the limit from being exceeded,
drhe30f4422007-08-21 16:15:55 +00003948** the memory is allocated anyway and the current operation proceeds.
drh6ed48bf2007-06-14 20:57:18 +00003949**
3950** A negative or zero value for N means that there is no soft heap limit and
drhe30f4422007-08-21 16:15:55 +00003951** [sqlite3_release_memory()] will only be called when memory is exhausted.
drhafc91042008-02-21 02:09:45 +00003952** The default value for the soft heap limit is zero.
drh6ed48bf2007-06-14 20:57:18 +00003953**
mihailim15194222008-06-22 09:55:14 +00003954** SQLite makes a best effort to honor the soft heap limit.
shane26b34032008-05-23 17:21:09 +00003955** But if the soft heap limit cannot be honored, execution will
mihailimdc884822008-06-22 08:58:50 +00003956** continue without error or notification. This is why the limit is
drh6ed48bf2007-06-14 20:57:18 +00003957** called a "soft" limit. It is advisory only.
3958**
drhe30f4422007-08-21 16:15:55 +00003959** Prior to SQLite version 3.5.0, this routine only constrained the memory
3960** allocated by a single thread - the same thread in which this routine
3961** runs. Beginning with SQLite version 3.5.0, the soft heap limit is
drhafc91042008-02-21 02:09:45 +00003962** applied to all threads. The value specified for the soft heap limit
3963** is an upper bound on the total memory allocation for all threads. In
drh8bacf972007-08-25 16:21:29 +00003964** version 3.5.0 there is no mechanism for limiting the heap usage for
3965** individual threads.
drhafc91042008-02-21 02:09:45 +00003966**
drh8b39db12009-02-18 18:37:58 +00003967** Requirements:
3968** [H16351] [H16352] [H16353] [H16354] [H16355] [H16358]
danielk197752622822006-01-09 09:59:49 +00003969*/
drhd2d4a6b2006-01-10 15:18:27 +00003970void sqlite3_soft_heap_limit(int);
danielk197752622822006-01-09 09:59:49 +00003971
3972/*
drh9cd29642008-07-23 00:52:55 +00003973** CAPI3REF: Extract Metadata About A Column Of A Table {H12850} <S60300>
drh6ed48bf2007-06-14 20:57:18 +00003974**
mihailimdc884822008-06-22 08:58:50 +00003975** This routine returns metadata about a specific column of a specific
3976** database table accessible using the [database connection] handle
3977** passed as the first function argument.
danielk1977deb802c2006-02-09 13:43:28 +00003978**
mihailimdc884822008-06-22 08:58:50 +00003979** The column is identified by the second, third and fourth parameters to
danielk1977deb802c2006-02-09 13:43:28 +00003980** this function. The second parameter is either the name of the database
3981** (i.e. "main", "temp" or an attached database) containing the specified
3982** table or NULL. If it is NULL, then all attached databases are searched
mihailimdc884822008-06-22 08:58:50 +00003983** for the table using the same algorithm used by the database engine to
danielk1977deb802c2006-02-09 13:43:28 +00003984** resolve unqualified table references.
3985**
mihailimdc884822008-06-22 08:58:50 +00003986** The third and fourth parameters to this function are the table and column
3987** name of the desired column, respectively. Neither of these parameters
danielk1977deb802c2006-02-09 13:43:28 +00003988** may be NULL.
3989**
mihailimdc884822008-06-22 08:58:50 +00003990** Metadata is returned by writing to the memory locations passed as the 5th
3991** and subsequent parameters to this function. Any of these arguments may be
3992** NULL, in which case the corresponding element of metadata is omitted.
mihailim15194222008-06-22 09:55:14 +00003993**
mihailimdc884822008-06-22 08:58:50 +00003994** <blockquote>
3995** <table border="1">
3996** <tr><th> Parameter <th> Output<br>Type <th> Description
danielk1977deb802c2006-02-09 13:43:28 +00003997**
mihailimdc884822008-06-22 08:58:50 +00003998** <tr><td> 5th <td> const char* <td> Data type
3999** <tr><td> 6th <td> const char* <td> Name of default collation sequence
4000** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint
4001** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY
drh49c3d572008-12-15 22:51:38 +00004002** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT]
mihailimdc884822008-06-22 08:58:50 +00004003** </table>
4004** </blockquote>
danielk1977deb802c2006-02-09 13:43:28 +00004005**
mihailimdc884822008-06-22 08:58:50 +00004006** The memory pointed to by the character pointers returned for the
4007** declaration type and collation sequence is valid only until the next
4008** call to any SQLite API function.
danielk1977deb802c2006-02-09 13:43:28 +00004009**
mihailimdc884822008-06-22 08:58:50 +00004010** If the specified table is actually a view, an [error code] is returned.
danielk1977deb802c2006-02-09 13:43:28 +00004011**
mihailimdc884822008-06-22 08:58:50 +00004012** If the specified column is "rowid", "oid" or "_rowid_" and an
drh49c3d572008-12-15 22:51:38 +00004013** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output
danielk1977deb802c2006-02-09 13:43:28 +00004014** parameters are set for the explicitly declared column. If there is no
drh49c3d572008-12-15 22:51:38 +00004015** explicitly declared [INTEGER PRIMARY KEY] column, then the output
mihailimdc884822008-06-22 08:58:50 +00004016** parameters are set as follows:
danielk1977deb802c2006-02-09 13:43:28 +00004017**
drh6ed48bf2007-06-14 20:57:18 +00004018** <pre>
danielk1977deb802c2006-02-09 13:43:28 +00004019** data type: "INTEGER"
4020** collation sequence: "BINARY"
4021** not null: 0
4022** primary key: 1
4023** auto increment: 0
drh6ed48bf2007-06-14 20:57:18 +00004024** </pre>
danielk1977deb802c2006-02-09 13:43:28 +00004025**
4026** This function may load one or more schemas from database files. If an
4027** error occurs during this process, or if the requested table or column
mihailimdc884822008-06-22 08:58:50 +00004028** cannot be found, an [error code] is returned and an error message left
4029** in the [database connection] (to be retrieved using sqlite3_errmsg()).
danielk19774b1ae992006-02-10 03:06:10 +00004030**
4031** This API is only available if the library was compiled with the
drh4ead1482008-06-26 18:16:05 +00004032** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined.
danielk1977deb802c2006-02-09 13:43:28 +00004033*/
4034int sqlite3_table_column_metadata(
4035 sqlite3 *db, /* Connection handle */
4036 const char *zDbName, /* Database name or NULL */
4037 const char *zTableName, /* Table name */
4038 const char *zColumnName, /* Column name */
4039 char const **pzDataType, /* OUTPUT: Declared data type */
4040 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
4041 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
4042 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh98c94802007-10-01 13:50:31 +00004043 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00004044);
4045
4046/*
drh9cd29642008-07-23 00:52:55 +00004047** CAPI3REF: Load An Extension {H12600} <S20500>
drh1e397f82006-06-08 15:28:43 +00004048**
mihailimdc884822008-06-22 08:58:50 +00004049** This interface loads an SQLite extension library from the named file.
drh1e397f82006-06-08 15:28:43 +00004050**
drh9a247912008-07-22 18:45:08 +00004051** {H12601} The sqlite3_load_extension() interface attempts to load an
mihailimdc884822008-06-22 08:58:50 +00004052** SQLite extension library contained in the file zFile.
drh1e397f82006-06-08 15:28:43 +00004053**
drh9a247912008-07-22 18:45:08 +00004054** {H12602} The entry point is zProc.
mihailimdc884822008-06-22 08:58:50 +00004055**
drh9a247912008-07-22 18:45:08 +00004056** {H12603} zProc may be 0, in which case the name of the entry point
mihailimdc884822008-06-22 08:58:50 +00004057** defaults to "sqlite3_extension_init".
4058**
drh9a247912008-07-22 18:45:08 +00004059** {H12604} The sqlite3_load_extension() interface shall return
mihailimdc884822008-06-22 08:58:50 +00004060** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.
4061**
drh9a247912008-07-22 18:45:08 +00004062** {H12605} If an error occurs and pzErrMsg is not 0, then the
mihailim421dfca2008-06-22 16:35:48 +00004063** [sqlite3_load_extension()] interface shall attempt to
4064** fill *pzErrMsg with error message text stored in memory
4065** obtained from [sqlite3_malloc()]. {END} The calling function
4066** should free this memory by calling [sqlite3_free()].
4067**
drh9a247912008-07-22 18:45:08 +00004068** {H12606} Extension loading must be enabled using
mihailimdc884822008-06-22 08:58:50 +00004069** [sqlite3_enable_load_extension()] prior to calling this API,
4070** otherwise an error will be returned.
drh1e397f82006-06-08 15:28:43 +00004071*/
4072int sqlite3_load_extension(
4073 sqlite3 *db, /* Load the extension into this database connection */
4074 const char *zFile, /* Name of the shared library containing extension */
4075 const char *zProc, /* Entry point. Derived from zFile if 0 */
4076 char **pzErrMsg /* Put error message here if not 0 */
4077);
4078
4079/*
drh9cd29642008-07-23 00:52:55 +00004080** CAPI3REF: Enable Or Disable Extension Loading {H12620} <S20500>
drh6ed48bf2007-06-14 20:57:18 +00004081**
drhc2e87a32006-06-27 15:16:14 +00004082** So as not to open security holes in older applications that are
drh6ed48bf2007-06-14 20:57:18 +00004083** unprepared to deal with extension loading, and as a means of disabling
mihailimdc884822008-06-22 08:58:50 +00004084** extension loading while evaluating user-entered SQL, the following API
4085** is provided to turn the [sqlite3_load_extension()] mechanism on and off.
drhc2e87a32006-06-27 15:16:14 +00004086**
mihailimdc884822008-06-22 08:58:50 +00004087** Extension loading is off by default. See ticket #1863.
4088**
drh9a247912008-07-22 18:45:08 +00004089** {H12621} Call the sqlite3_enable_load_extension() routine with onoff==1
mihailimdc884822008-06-22 08:58:50 +00004090** to turn extension loading on and call it with onoff==0 to turn
4091** it back off again.
4092**
drh9a247912008-07-22 18:45:08 +00004093** {H12622} Extension loading is off by default.
drhc2e87a32006-06-27 15:16:14 +00004094*/
4095int sqlite3_enable_load_extension(sqlite3 *db, int onoff);
4096
4097/*
drh9cd29642008-07-23 00:52:55 +00004098** CAPI3REF: Automatically Load An Extensions {H12640} <S20500>
drh9eff6162006-06-12 21:59:13 +00004099**
drh1409be62006-08-23 20:07:20 +00004100** This API can be invoked at program startup in order to register
4101** one or more statically linked extensions that will be available
mihailim04bcc002008-06-22 10:21:27 +00004102** to all new [database connections]. {END}
mihailimdc884822008-06-22 08:58:50 +00004103**
4104** This routine stores a pointer to the extension in an array that is
4105** obtained from [sqlite3_malloc()]. If you run a memory leak checker
4106** on your program and it reports a leak because of this array, invoke
4107** [sqlite3_reset_auto_extension()] prior to shutdown to free the memory.
4108**
drh9a247912008-07-22 18:45:08 +00004109** {H12641} This function registers an extension entry point that is
mihailimdc884822008-06-22 08:58:50 +00004110** automatically invoked whenever a new [database connection]
4111** is opened using [sqlite3_open()], [sqlite3_open16()],
4112** or [sqlite3_open_v2()].
4113**
drh9a247912008-07-22 18:45:08 +00004114** {H12642} Duplicate extensions are detected so calling this routine
mihailimdc884822008-06-22 08:58:50 +00004115** multiple times with the same extension is harmless.
4116**
drh9a247912008-07-22 18:45:08 +00004117** {H12643} This routine stores a pointer to the extension in an array
mihailimdc884822008-06-22 08:58:50 +00004118** that is obtained from [sqlite3_malloc()].
4119**
drh9a247912008-07-22 18:45:08 +00004120** {H12644} Automatic extensions apply across all threads.
drh1409be62006-08-23 20:07:20 +00004121*/
drh1875f7a2008-12-08 18:19:17 +00004122int sqlite3_auto_extension(void (*xEntryPoint)(void));
drh1409be62006-08-23 20:07:20 +00004123
drh1409be62006-08-23 20:07:20 +00004124/*
drh9cd29642008-07-23 00:52:55 +00004125** CAPI3REF: Reset Automatic Extension Loading {H12660} <S20500>
drh1409be62006-08-23 20:07:20 +00004126**
mihailim04bcc002008-06-22 10:21:27 +00004127** This function disables all previously registered automatic
4128** extensions. {END} It undoes the effect of all prior
4129** [sqlite3_auto_extension()] calls.
drh6ed48bf2007-06-14 20:57:18 +00004130**
drh9a247912008-07-22 18:45:08 +00004131** {H12661} This function disables all previously registered
mihailimdc884822008-06-22 08:58:50 +00004132** automatic extensions.
4133**
drh9a247912008-07-22 18:45:08 +00004134** {H12662} This function disables automatic extensions in all threads.
drh1409be62006-08-23 20:07:20 +00004135*/
4136void sqlite3_reset_auto_extension(void);
4137
drh1409be62006-08-23 20:07:20 +00004138/*
4139****** EXPERIMENTAL - subject to change without notice **************
4140**
drh9eff6162006-06-12 21:59:13 +00004141** The interface to the virtual-table mechanism is currently considered
4142** to be experimental. The interface might change in incompatible ways.
4143** If this is a problem for you, do not use the interface at this time.
4144**
shane26b34032008-05-23 17:21:09 +00004145** When the virtual-table mechanism stabilizes, we will declare the
drh9eff6162006-06-12 21:59:13 +00004146** interface fixed, support it indefinitely, and remove this comment.
4147*/
4148
4149/*
4150** Structures used by the virtual table interface
drhe09daa92006-06-10 13:29:31 +00004151*/
4152typedef struct sqlite3_vtab sqlite3_vtab;
4153typedef struct sqlite3_index_info sqlite3_index_info;
4154typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor;
4155typedef struct sqlite3_module sqlite3_module;
drh9eff6162006-06-12 21:59:13 +00004156
4157/*
drh9cd29642008-07-23 00:52:55 +00004158** CAPI3REF: Virtual Table Object {H18000} <S20400>
drh9cff9dc2009-04-13 14:43:40 +00004159** KEYWORDS: sqlite3_module {virtual table module}
drhd5a68d32008-08-04 13:44:57 +00004160** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004161**
drh9cff9dc2009-04-13 14:43:40 +00004162** This structure, sometimes called a a "virtual table module",
4163** defines the implementation of a [virtual tables].
4164** This structure consists mostly of methods for the module.
mihailim15194222008-06-22 09:55:14 +00004165**
drh9cff9dc2009-04-13 14:43:40 +00004166** A virtual table module is created by filling in a persistent
4167** instance of this structure and passing a pointer to that instance
4168** to [sqlite3_create_module()] or [sqlite3_create_module_v2()].
4169** The registration remains valid until it is replaced by a different
4170** module or until the [database connection] closes. The content
4171** of this structure must not change while it is registered with
4172** any database connection.
drh9eff6162006-06-12 21:59:13 +00004173*/
drhe09daa92006-06-10 13:29:31 +00004174struct sqlite3_module {
4175 int iVersion;
danielk19779da9d472006-06-14 06:58:15 +00004176 int (*xCreate)(sqlite3*, void *pAux,
drhe4102962006-09-11 00:34:22 +00004177 int argc, const char *const*argv,
drh4ca8aac2006-09-10 17:31:58 +00004178 sqlite3_vtab **ppVTab, char**);
danielk19779da9d472006-06-14 06:58:15 +00004179 int (*xConnect)(sqlite3*, void *pAux,
drhe4102962006-09-11 00:34:22 +00004180 int argc, const char *const*argv,
drh4ca8aac2006-09-10 17:31:58 +00004181 sqlite3_vtab **ppVTab, char**);
drhe09daa92006-06-10 13:29:31 +00004182 int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*);
4183 int (*xDisconnect)(sqlite3_vtab *pVTab);
4184 int (*xDestroy)(sqlite3_vtab *pVTab);
4185 int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor);
4186 int (*xClose)(sqlite3_vtab_cursor*);
drh4be8b512006-06-13 23:51:34 +00004187 int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr,
drhe09daa92006-06-10 13:29:31 +00004188 int argc, sqlite3_value **argv);
4189 int (*xNext)(sqlite3_vtab_cursor*);
danielk1977a298e902006-06-22 09:53:48 +00004190 int (*xEof)(sqlite3_vtab_cursor*);
drhe09daa92006-06-10 13:29:31 +00004191 int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int);
drh6d2069d2007-08-14 01:58:53 +00004192 int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid);
4193 int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *);
drhe09daa92006-06-10 13:29:31 +00004194 int (*xBegin)(sqlite3_vtab *pVTab);
4195 int (*xSync)(sqlite3_vtab *pVTab);
4196 int (*xCommit)(sqlite3_vtab *pVTab);
4197 int (*xRollback)(sqlite3_vtab *pVTab);
drhb7f6f682006-07-08 17:06:43 +00004198 int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName,
drhe94b0c32006-07-08 18:09:15 +00004199 void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),
4200 void **ppArg);
danielk1977182c4ba2007-06-27 15:53:34 +00004201 int (*xRename)(sqlite3_vtab *pVtab, const char *zNew);
drhe09daa92006-06-10 13:29:31 +00004202};
drh9eff6162006-06-12 21:59:13 +00004203
4204/*
drh9cd29642008-07-23 00:52:55 +00004205** CAPI3REF: Virtual Table Indexing Information {H18100} <S20400>
drhb4d58ae2008-02-21 20:17:06 +00004206** KEYWORDS: sqlite3_index_info
drhd5a68d32008-08-04 13:44:57 +00004207** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004208**
drh9eff6162006-06-12 21:59:13 +00004209** The sqlite3_index_info structure and its substructures is used to
drh9cff9dc2009-04-13 14:43:40 +00004210** pass information into and receive the reply from the [xBestIndex]
4211** method of a [virtual table module]. The fields under **Inputs** are the
drh9eff6162006-06-12 21:59:13 +00004212** inputs to xBestIndex and are read-only. xBestIndex inserts its
4213** results into the **Outputs** fields.
4214**
mihailim15194222008-06-22 09:55:14 +00004215** The aConstraint[] array records WHERE clause constraints of the form:
drh9eff6162006-06-12 21:59:13 +00004216**
mihailim15194222008-06-22 09:55:14 +00004217** <pre>column OP expr</pre>
drh9eff6162006-06-12 21:59:13 +00004218**
mihailim15194222008-06-22 09:55:14 +00004219** where OP is =, &lt;, &lt;=, &gt;, or &gt;=. The particular operator is
4220** stored in aConstraint[].op. The index of the column is stored in
drh9eff6162006-06-12 21:59:13 +00004221** aConstraint[].iColumn. aConstraint[].usable is TRUE if the
4222** expr on the right-hand side can be evaluated (and thus the constraint
4223** is usable) and false if it cannot.
4224**
4225** The optimizer automatically inverts terms of the form "expr OP column"
drh98c94802007-10-01 13:50:31 +00004226** and makes other simplifications to the WHERE clause in an attempt to
drh9eff6162006-06-12 21:59:13 +00004227** get as many WHERE clause terms into the form shown above as possible.
4228** The aConstraint[] array only reports WHERE clause terms in the correct
4229** form that refer to the particular virtual table being queried.
4230**
4231** Information about the ORDER BY clause is stored in aOrderBy[].
4232** Each term of aOrderBy records a column of the ORDER BY clause.
4233**
drh9cff9dc2009-04-13 14:43:40 +00004234** The [xBestIndex] method must fill aConstraintUsage[] with information
danielk19775fac9f82006-06-13 14:16:58 +00004235** about what parameters to pass to xFilter. If argvIndex>0 then
drh9eff6162006-06-12 21:59:13 +00004236** the right-hand side of the corresponding aConstraint[] is evaluated
4237** and becomes the argvIndex-th entry in argv. If aConstraintUsage[].omit
4238** is true, then the constraint is assumed to be fully handled by the
4239** virtual table and is not checked again by SQLite.
4240**
drh9cff9dc2009-04-13 14:43:40 +00004241** The idxNum and idxPtr values are recorded and passed into the
4242** [xFilter] method.
4243** [sqlite3_free()] is used to free idxPtr if and only iff
4244** needToFreeIdxPtr is true.
drh9eff6162006-06-12 21:59:13 +00004245**
drh9cff9dc2009-04-13 14:43:40 +00004246** The orderByConsumed means that output from [xFilter]/[xNext] will occur in
drh9eff6162006-06-12 21:59:13 +00004247** the correct order to satisfy the ORDER BY clause so that no separate
4248** sorting step is required.
4249**
4250** The estimatedCost value is an estimate of the cost of doing the
4251** particular lookup. A full scan of a table with N entries should have
4252** a cost of N. A binary search of a table of N entries should have a
4253** cost of approximately log(N).
4254*/
drhe09daa92006-06-10 13:29:31 +00004255struct sqlite3_index_info {
4256 /* Inputs */
drh6cca08c2007-09-21 12:43:16 +00004257 int nConstraint; /* Number of entries in aConstraint */
4258 struct sqlite3_index_constraint {
drh9eff6162006-06-12 21:59:13 +00004259 int iColumn; /* Column on left-hand side of constraint */
4260 unsigned char op; /* Constraint operator */
4261 unsigned char usable; /* True if this constraint is usable */
4262 int iTermOffset; /* Used internally - xBestIndex should ignore */
drh6cca08c2007-09-21 12:43:16 +00004263 } *aConstraint; /* Table of WHERE clause constraints */
4264 int nOrderBy; /* Number of terms in the ORDER BY clause */
4265 struct sqlite3_index_orderby {
drh9eff6162006-06-12 21:59:13 +00004266 int iColumn; /* Column number */
4267 unsigned char desc; /* True for DESC. False for ASC. */
drh6cca08c2007-09-21 12:43:16 +00004268 } *aOrderBy; /* The ORDER BY clause */
drhe09daa92006-06-10 13:29:31 +00004269 /* Outputs */
drh9eff6162006-06-12 21:59:13 +00004270 struct sqlite3_index_constraint_usage {
4271 int argvIndex; /* if >0, constraint is part of argv to xFilter */
4272 unsigned char omit; /* Do not code a test for this constraint */
drh6cca08c2007-09-21 12:43:16 +00004273 } *aConstraintUsage;
drh4be8b512006-06-13 23:51:34 +00004274 int idxNum; /* Number used to identify the index */
4275 char *idxStr; /* String, possibly obtained from sqlite3_malloc */
4276 int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */
drh9eff6162006-06-12 21:59:13 +00004277 int orderByConsumed; /* True if output is already ordered */
4278 double estimatedCost; /* Estimated cost of using this index */
drhe09daa92006-06-10 13:29:31 +00004279};
drh9eff6162006-06-12 21:59:13 +00004280#define SQLITE_INDEX_CONSTRAINT_EQ 2
4281#define SQLITE_INDEX_CONSTRAINT_GT 4
4282#define SQLITE_INDEX_CONSTRAINT_LE 8
4283#define SQLITE_INDEX_CONSTRAINT_LT 16
4284#define SQLITE_INDEX_CONSTRAINT_GE 32
4285#define SQLITE_INDEX_CONSTRAINT_MATCH 64
4286
4287/*
drh9cd29642008-07-23 00:52:55 +00004288** CAPI3REF: Register A Virtual Table Implementation {H18200} <S20400>
drhd5a68d32008-08-04 13:44:57 +00004289** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004290**
drh9cff9dc2009-04-13 14:43:40 +00004291** This routine is used to register a new [virtual table module] name.
4292** Module names must be registered before
4293** creating a new [virtual table] using the module, or before using a
4294** preexisting [virtual table] for the module.
mihailim15194222008-06-22 09:55:14 +00004295**
drh9cff9dc2009-04-13 14:43:40 +00004296** The module name is registered on the [database connection] specified
4297** by the first parameter. The name of the module is given by the
4298** second parameter. The third parameter is a pointer to
4299** the implementation of the [virtual table module]. The fourth
4300** parameter is an arbitrary client data pointer that is passed through
4301** into the [xCreate] and [xConnect] methods of the virtual table module
4302** when a new virtual table is be being created or reinitialized.
4303**
4304** This interface has exactly the same effect as calling
4305** [sqlite3_create_module_v2()] with a NULL client data destructor.
drh9eff6162006-06-12 21:59:13 +00004306*/
shanea79c3cc2008-08-11 17:27:01 +00004307SQLITE_EXPERIMENTAL int sqlite3_create_module(
drh9eff6162006-06-12 21:59:13 +00004308 sqlite3 *db, /* SQLite connection to register module with */
4309 const char *zName, /* Name of the module */
drh9cff9dc2009-04-13 14:43:40 +00004310 const sqlite3_module *p, /* Methods for the module */
4311 void *pClientData /* Client data for xCreate/xConnect */
drhb9bb7c12006-06-11 23:41:55 +00004312);
drhe09daa92006-06-10 13:29:31 +00004313
drh9eff6162006-06-12 21:59:13 +00004314/*
drh9cd29642008-07-23 00:52:55 +00004315** CAPI3REF: Register A Virtual Table Implementation {H18210} <S20400>
drhd5a68d32008-08-04 13:44:57 +00004316** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004317**
drh9cff9dc2009-04-13 14:43:40 +00004318** This routine is identical to the [sqlite3_create_module()] method,
4319** except that it has an extra parameter to specify
4320** a destructor function for the client data pointer. SQLite will
4321** invoke the destructor function (if it is not NULL) when SQLite
4322** no longer needs the pClientData pointer.
danielk1977832a58a2007-06-22 15:21:15 +00004323*/
shanea79c3cc2008-08-11 17:27:01 +00004324SQLITE_EXPERIMENTAL int sqlite3_create_module_v2(
danielk1977832a58a2007-06-22 15:21:15 +00004325 sqlite3 *db, /* SQLite connection to register module with */
4326 const char *zName, /* Name of the module */
drh9cff9dc2009-04-13 14:43:40 +00004327 const sqlite3_module *p, /* Methods for the module */
4328 void *pClientData, /* Client data for xCreate/xConnect */
danielk1977832a58a2007-06-22 15:21:15 +00004329 void(*xDestroy)(void*) /* Module destructor function */
4330);
4331
4332/*
drh9cd29642008-07-23 00:52:55 +00004333** CAPI3REF: Virtual Table Instance Object {H18010} <S20400>
drhb4d58ae2008-02-21 20:17:06 +00004334** KEYWORDS: sqlite3_vtab
drhd5a68d32008-08-04 13:44:57 +00004335** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004336**
drh9cff9dc2009-04-13 14:43:40 +00004337** Every [virtual table module] implementation uses a subclass
4338** of the following structure to describe a particular instance
4339** of the [virtual table]. Each subclass will
mihailim15194222008-06-22 09:55:14 +00004340** be tailored to the specific needs of the module implementation.
4341** The purpose of this superclass is to define certain fields that are
4342** common to all module implementations.
drhfe1368e2006-09-10 17:08:29 +00004343**
4344** Virtual tables methods can set an error message by assigning a
mihailim15194222008-06-22 09:55:14 +00004345** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should
4346** take care that any prior string is freed by a call to [sqlite3_free()]
drhfe1368e2006-09-10 17:08:29 +00004347** prior to assigning a new string to zErrMsg. After the error message
4348** is delivered up to the client application, the string will be automatically
drh9cff9dc2009-04-13 14:43:40 +00004349** freed by sqlite3_free() and the zErrMsg field will be zeroed.
drh9eff6162006-06-12 21:59:13 +00004350*/
4351struct sqlite3_vtab {
drha967e882006-06-13 01:04:52 +00004352 const sqlite3_module *pModule; /* The module for this virtual table */
danielk1977595a5232009-07-24 17:58:53 +00004353 int nRef; /* NO LONGER USED */
drh4ca8aac2006-09-10 17:31:58 +00004354 char *zErrMsg; /* Error message from sqlite3_mprintf() */
drh9eff6162006-06-12 21:59:13 +00004355 /* Virtual table implementations will typically add additional fields */
4356};
4357
drhb4d58ae2008-02-21 20:17:06 +00004358/*
drh9cd29642008-07-23 00:52:55 +00004359** CAPI3REF: Virtual Table Cursor Object {H18020} <S20400>
drh9cff9dc2009-04-13 14:43:40 +00004360** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor}
drhd5a68d32008-08-04 13:44:57 +00004361** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004362**
drh9cff9dc2009-04-13 14:43:40 +00004363** Every [virtual table module] implementation uses a subclass of the
4364** following structure to describe cursors that point into the
4365** [virtual table] and are used
drh9eff6162006-06-12 21:59:13 +00004366** to loop through the virtual table. Cursors are created using the
drh9cff9dc2009-04-13 14:43:40 +00004367** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed
4368** by the [sqlite3_module.xClose | xClose] method. Cussors are used
4369** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods
4370** of the module. Each module implementation will define
drh9eff6162006-06-12 21:59:13 +00004371** the content of a cursor structure to suit its own needs.
4372**
4373** This superclass exists in order to define fields of the cursor that
4374** are common to all implementations.
4375*/
4376struct sqlite3_vtab_cursor {
4377 sqlite3_vtab *pVtab; /* Virtual table of this cursor */
4378 /* Virtual table implementations will typically add additional fields */
4379};
4380
4381/*
drh9cd29642008-07-23 00:52:55 +00004382** CAPI3REF: Declare The Schema Of A Virtual Table {H18280} <S20400>
drhd5a68d32008-08-04 13:44:57 +00004383** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004384**
drh9cff9dc2009-04-13 14:43:40 +00004385** The [xCreate] and [xConnect] methods of a
4386** [virtual table module] call this interface
drh9eff6162006-06-12 21:59:13 +00004387** to declare the format (the names and datatypes of the columns) of
4388** the virtual tables they implement.
4389*/
drh9cff9dc2009-04-13 14:43:40 +00004390SQLITE_EXPERIMENTAL int sqlite3_declare_vtab(sqlite3*, const char *zSQL);
drhe09daa92006-06-10 13:29:31 +00004391
4392/*
drh9cd29642008-07-23 00:52:55 +00004393** CAPI3REF: Overload A Function For A Virtual Table {H18300} <S20400>
drhd5a68d32008-08-04 13:44:57 +00004394** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004395**
drhb7481e72006-09-16 21:45:14 +00004396** Virtual tables can provide alternative implementations of functions
drh9cff9dc2009-04-13 14:43:40 +00004397** using the [xFindFunction] method of the [virtual table module].
4398** But global versions of those functions
drhb7481e72006-09-16 21:45:14 +00004399** must exist in order to be overloaded.
4400**
4401** This API makes sure a global version of a function with a particular
4402** name and number of parameters exists. If no such function exists
4403** before this API is called, a new function is created. The implementation
4404** of the new function always causes an exception to be thrown. So
4405** the new function is not good for anything by itself. Its only
shane26b34032008-05-23 17:21:09 +00004406** purpose is to be a placeholder function that can be overloaded
drh9cff9dc2009-04-13 14:43:40 +00004407** by a [virtual table].
drhb7481e72006-09-16 21:45:14 +00004408*/
shanea79c3cc2008-08-11 17:27:01 +00004409SQLITE_EXPERIMENTAL int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg);
drhb7481e72006-09-16 21:45:14 +00004410
4411/*
drh9eff6162006-06-12 21:59:13 +00004412** The interface to the virtual-table mechanism defined above (back up
4413** to a comment remarkably similar to this one) is currently considered
4414** to be experimental. The interface might change in incompatible ways.
4415** If this is a problem for you, do not use the interface at this time.
4416**
drh98c94802007-10-01 13:50:31 +00004417** When the virtual-table mechanism stabilizes, we will declare the
drh9eff6162006-06-12 21:59:13 +00004418** interface fixed, support it indefinitely, and remove this comment.
4419**
4420****** EXPERIMENTAL - subject to change without notice **************
4421*/
4422
danielk19778cbadb02007-05-03 16:31:26 +00004423/*
drh9cd29642008-07-23 00:52:55 +00004424** CAPI3REF: A Handle To An Open BLOB {H17800} <S30230>
mihailim15194222008-06-22 09:55:14 +00004425** KEYWORDS: {BLOB handle} {BLOB handles}
drh6ed48bf2007-06-14 20:57:18 +00004426**
drhb4d58ae2008-02-21 20:17:06 +00004427** An instance of this object represents an open BLOB on which
mihailim1c492652008-06-21 18:02:16 +00004428** [sqlite3_blob_open | incremental BLOB I/O] can be performed.
mihailim15194222008-06-22 09:55:14 +00004429** Objects of this type are created by [sqlite3_blob_open()]
4430** and destroyed by [sqlite3_blob_close()].
drh6ed48bf2007-06-14 20:57:18 +00004431** The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces
mihailim15194222008-06-22 09:55:14 +00004432** can be used to read or write small subsections of the BLOB.
4433** The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes.
danielk19778cbadb02007-05-03 16:31:26 +00004434*/
danielk1977b4e9af92007-05-01 17:49:49 +00004435typedef struct sqlite3_blob sqlite3_blob;
4436
danielk19778cbadb02007-05-03 16:31:26 +00004437/*
drh9cd29642008-07-23 00:52:55 +00004438** CAPI3REF: Open A BLOB For Incremental I/O {H17810} <S30230>
drh6ed48bf2007-06-14 20:57:18 +00004439**
mihailim04bcc002008-06-22 10:21:27 +00004440** This interfaces opens a [BLOB handle | handle] to the BLOB located
drhf84ddc12008-03-24 12:51:46 +00004441** in row iRow, column zColumn, table zTable in database zDb;
mihailim15194222008-06-22 09:55:14 +00004442** in other words, the same BLOB that would be selected by:
danielk19778cbadb02007-05-03 16:31:26 +00004443**
drh6ed48bf2007-06-14 20:57:18 +00004444** <pre>
drh49c3d572008-12-15 22:51:38 +00004445** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow;
drhf5befa02007-12-06 02:42:07 +00004446** </pre> {END}
danielk19778cbadb02007-05-03 16:31:26 +00004447**
drh554b3832009-05-17 12:07:47 +00004448** If the flags parameter is non-zero, then the BLOB is opened for read
mihailim15194222008-06-22 09:55:14 +00004449** and write access. If it is zero, the BLOB is opened for read access.
danielk19778cbadb02007-05-03 16:31:26 +00004450**
drhf84ddc12008-03-24 12:51:46 +00004451** Note that the database name is not the filename that contains
4452** the database but rather the symbolic name of the database that
4453** is assigned when the database is connected using [ATTACH].
mihailim15194222008-06-22 09:55:14 +00004454** For the main database file, the database name is "main".
4455** For TEMP tables, the database name is "temp".
drhf84ddc12008-03-24 12:51:46 +00004456**
mihailim15194222008-06-22 09:55:14 +00004457** On success, [SQLITE_OK] is returned and the new [BLOB handle] is written
drhabda6112009-05-14 22:37:47 +00004458** to *ppBlob. Otherwise an [error code] is returned and *ppBlob is set
4459** to be a null pointer.
mihailim15194222008-06-22 09:55:14 +00004460** This function sets the [database connection] error code and message
drhabda6112009-05-14 22:37:47 +00004461** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()] and related
4462** functions. Note that the *ppBlob variable is always initialized in a
4463** way that makes it safe to invoke [sqlite3_blob_close()] on *ppBlob
4464** regardless of the success or failure of this routine.
mihailim15194222008-06-22 09:55:14 +00004465**
drh9de1b352008-06-26 15:04:57 +00004466** If the row that a BLOB handle points to is modified by an
4467** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects
4468** then the BLOB handle is marked as "expired".
4469** This is true if any column of the row is changed, even a column
4470** other than the one the BLOB handle is open on.
4471** Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for
4472** a expired BLOB handle fail with an return code of [SQLITE_ABORT].
4473** Changes written into a BLOB prior to the BLOB expiring are not
4474** rollback by the expiration of the BLOB. Such changes will eventually
4475** commit if the transaction continues to completion.
4476**
drhabda6112009-05-14 22:37:47 +00004477** Use the [sqlite3_blob_bytes()] interface to determine the size of
4478** the opened blob. The size of a blob may not be changed by this
drh9e42f8a2009-08-13 20:15:29 +00004479** interface. Use the [UPDATE] SQL command to change the size of a
drhabda6112009-05-14 22:37:47 +00004480** blob.
4481**
4482** The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces
4483** and the built-in [zeroblob] SQL function can be used, if desired,
4484** to create an empty, zero-filled blob in which to read or write using
4485** this interface.
4486**
4487** To avoid a resource leak, every open [BLOB handle] should eventually
4488** be released by a call to [sqlite3_blob_close()].
4489**
drh8b39db12009-02-18 18:37:58 +00004490** Requirements:
4491** [H17813] [H17814] [H17816] [H17819] [H17821] [H17824]
danielk19778cbadb02007-05-03 16:31:26 +00004492*/
danielk1977b4e9af92007-05-01 17:49:49 +00004493int sqlite3_blob_open(
4494 sqlite3*,
4495 const char *zDb,
4496 const char *zTable,
4497 const char *zColumn,
drh6d2069d2007-08-14 01:58:53 +00004498 sqlite3_int64 iRow,
danielk1977b4e9af92007-05-01 17:49:49 +00004499 int flags,
4500 sqlite3_blob **ppBlob
4501);
4502
danielk19778cbadb02007-05-03 16:31:26 +00004503/*
drh9cd29642008-07-23 00:52:55 +00004504** CAPI3REF: Close A BLOB Handle {H17830} <S30230>
drh6ed48bf2007-06-14 20:57:18 +00004505**
mihailim15194222008-06-22 09:55:14 +00004506** Closes an open [BLOB handle].
drh2dd62be2007-12-04 13:22:43 +00004507**
drhb4d58ae2008-02-21 20:17:06 +00004508** Closing a BLOB shall cause the current transaction to commit
drhf5befa02007-12-06 02:42:07 +00004509** if there are no other BLOBs, no pending prepared statements, and the
mihailim15194222008-06-22 09:55:14 +00004510** database connection is in [autocommit mode].
drhb4d58ae2008-02-21 20:17:06 +00004511** If any writes were made to the BLOB, they might be held in cache
drhabda6112009-05-14 22:37:47 +00004512** until the close operation if they will fit.
mihailim15194222008-06-22 09:55:14 +00004513**
drhf5befa02007-12-06 02:42:07 +00004514** Closing the BLOB often forces the changes
drh2dd62be2007-12-04 13:22:43 +00004515** out to disk and so if any I/O errors occur, they will likely occur
drhabda6112009-05-14 22:37:47 +00004516** at the time when the BLOB is closed. Any errors that occur during
drh2dd62be2007-12-04 13:22:43 +00004517** closing are reported as a non-zero return value.
4518**
drhb4d58ae2008-02-21 20:17:06 +00004519** The BLOB is closed unconditionally. Even if this routine returns
drh2dd62be2007-12-04 13:22:43 +00004520** an error code, the BLOB is still closed.
drhb4d58ae2008-02-21 20:17:06 +00004521**
drhabda6112009-05-14 22:37:47 +00004522** Calling this routine with a null pointer (which as would be returned
4523** by failed call to [sqlite3_blob_open()]) is a harmless no-op.
4524**
drh8b39db12009-02-18 18:37:58 +00004525** Requirements:
4526** [H17833] [H17836] [H17839]
danielk19778cbadb02007-05-03 16:31:26 +00004527*/
danielk1977b4e9af92007-05-01 17:49:49 +00004528int sqlite3_blob_close(sqlite3_blob *);
4529
danielk19778cbadb02007-05-03 16:31:26 +00004530/*
drh9cd29642008-07-23 00:52:55 +00004531** CAPI3REF: Return The Size Of An Open BLOB {H17840} <S30230>
drh6ed48bf2007-06-14 20:57:18 +00004532**
drhabda6112009-05-14 22:37:47 +00004533** Returns the size in bytes of the BLOB accessible via the
4534** successfully opened [BLOB handle] in its only argument. The
4535** incremental blob I/O routines can only read or overwriting existing
4536** blob content; they cannot change the size of a blob.
4537**
4538** This routine only works on a [BLOB handle] which has been created
4539** by a prior successful call to [sqlite3_blob_open()] and which has not
4540** been closed by [sqlite3_blob_close()]. Passing any other pointer in
4541** to this routine results in undefined and probably undesirable behavior.
drhb4d58ae2008-02-21 20:17:06 +00004542**
drh8b39db12009-02-18 18:37:58 +00004543** Requirements:
4544** [H17843]
danielk19778cbadb02007-05-03 16:31:26 +00004545*/
danielk1977b4e9af92007-05-01 17:49:49 +00004546int sqlite3_blob_bytes(sqlite3_blob *);
4547
drh9eff6162006-06-12 21:59:13 +00004548/*
drh9cd29642008-07-23 00:52:55 +00004549** CAPI3REF: Read Data From A BLOB Incrementally {H17850} <S30230>
drh6ed48bf2007-06-14 20:57:18 +00004550**
mihailim15194222008-06-22 09:55:14 +00004551** This function is used to read data from an open [BLOB handle] into a
4552** caller-supplied buffer. N bytes of data are copied into buffer Z
4553** from the open BLOB, starting at offset iOffset.
danielk19778cbadb02007-05-03 16:31:26 +00004554**
mihailim15194222008-06-22 09:55:14 +00004555** If offset iOffset is less than N bytes from the end of the BLOB,
drhb4d58ae2008-02-21 20:17:06 +00004556** [SQLITE_ERROR] is returned and no data is read. If N or iOffset is
mihailim15194222008-06-22 09:55:14 +00004557** less than zero, [SQLITE_ERROR] is returned and no data is read.
drhabda6112009-05-14 22:37:47 +00004558** The size of the blob (and hence the maximum value of N+iOffset)
4559** can be determined using the [sqlite3_blob_bytes()] interface.
drhf5befa02007-12-06 02:42:07 +00004560**
drh9de1b352008-06-26 15:04:57 +00004561** An attempt to read from an expired [BLOB handle] fails with an
4562** error code of [SQLITE_ABORT].
4563**
mihailim15194222008-06-22 09:55:14 +00004564** On success, SQLITE_OK is returned.
4565** Otherwise, an [error code] or an [extended error code] is returned.
drhb4d58ae2008-02-21 20:17:06 +00004566**
drhabda6112009-05-14 22:37:47 +00004567** This routine only works on a [BLOB handle] which has been created
4568** by a prior successful call to [sqlite3_blob_open()] and which has not
4569** been closed by [sqlite3_blob_close()]. Passing any other pointer in
4570** to this routine results in undefined and probably undesirable behavior.
4571**
4572** See also: [sqlite3_blob_write()].
4573**
drh8b39db12009-02-18 18:37:58 +00004574** Requirements:
4575** [H17853] [H17856] [H17859] [H17862] [H17863] [H17865] [H17868]
danielk19778cbadb02007-05-03 16:31:26 +00004576*/
drhb4d58ae2008-02-21 20:17:06 +00004577int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset);
danielk19778cbadb02007-05-03 16:31:26 +00004578
4579/*
drh9cd29642008-07-23 00:52:55 +00004580** CAPI3REF: Write Data Into A BLOB Incrementally {H17870} <S30230>
drh6ed48bf2007-06-14 20:57:18 +00004581**
mihailim15194222008-06-22 09:55:14 +00004582** This function is used to write data into an open [BLOB handle] from a
4583** caller-supplied buffer. N bytes of data are copied from the buffer Z
4584** into the open BLOB, starting at offset iOffset.
danielk19778cbadb02007-05-03 16:31:26 +00004585**
mihailim15194222008-06-22 09:55:14 +00004586** If the [BLOB handle] passed as the first argument was not opened for
4587** writing (the flags parameter to [sqlite3_blob_open()] was zero),
4588** this function returns [SQLITE_READONLY].
danielk19778cbadb02007-05-03 16:31:26 +00004589**
mihailim15194222008-06-22 09:55:14 +00004590** This function may only modify the contents of the BLOB; it is
4591** not possible to increase the size of a BLOB using this API.
4592** If offset iOffset is less than N bytes from the end of the BLOB,
4593** [SQLITE_ERROR] is returned and no data is written. If N is
drhf5befa02007-12-06 02:42:07 +00004594** less than zero [SQLITE_ERROR] is returned and no data is written.
drhabda6112009-05-14 22:37:47 +00004595** The size of the BLOB (and hence the maximum value of N+iOffset)
4596** can be determined using the [sqlite3_blob_bytes()] interface.
danielk19778cbadb02007-05-03 16:31:26 +00004597**
drh9de1b352008-06-26 15:04:57 +00004598** An attempt to write to an expired [BLOB handle] fails with an
4599** error code of [SQLITE_ABORT]. Writes to the BLOB that occurred
4600** before the [BLOB handle] expired are not rolled back by the
4601** expiration of the handle, though of course those changes might
4602** have been overwritten by the statement that expired the BLOB handle
4603** or by other independent statements.
4604**
mihailim15194222008-06-22 09:55:14 +00004605** On success, SQLITE_OK is returned.
4606** Otherwise, an [error code] or an [extended error code] is returned.
drhb4d58ae2008-02-21 20:17:06 +00004607**
drhabda6112009-05-14 22:37:47 +00004608** This routine only works on a [BLOB handle] which has been created
4609** by a prior successful call to [sqlite3_blob_open()] and which has not
4610** been closed by [sqlite3_blob_close()]. Passing any other pointer in
4611** to this routine results in undefined and probably undesirable behavior.
4612**
4613** See also: [sqlite3_blob_read()].
4614**
drh8b39db12009-02-18 18:37:58 +00004615** Requirements:
4616** [H17873] [H17874] [H17875] [H17876] [H17877] [H17879] [H17882] [H17885]
4617** [H17888]
danielk19778cbadb02007-05-03 16:31:26 +00004618*/
4619int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset);
4620
drhd84f9462007-08-15 11:28:56 +00004621/*
drh9cd29642008-07-23 00:52:55 +00004622** CAPI3REF: Virtual File System Objects {H11200} <S20100>
drhd84f9462007-08-15 11:28:56 +00004623**
4624** A virtual filesystem (VFS) is an [sqlite3_vfs] object
4625** that SQLite uses to interact
drhb4d58ae2008-02-21 20:17:06 +00004626** with the underlying operating system. Most SQLite builds come with a
drhd84f9462007-08-15 11:28:56 +00004627** single default VFS that is appropriate for the host computer.
4628** New VFSes can be registered and existing VFSes can be unregistered.
4629** The following interfaces are provided.
4630**
mihailim15194222008-06-22 09:55:14 +00004631** The sqlite3_vfs_find() interface returns a pointer to a VFS given its name.
4632** Names are case sensitive.
drhb4d58ae2008-02-21 20:17:06 +00004633** Names are zero-terminated UTF-8 strings.
mihailim15194222008-06-22 09:55:14 +00004634** If there is no match, a NULL pointer is returned.
4635** If zVfsName is NULL then the default VFS is returned.
drhd84f9462007-08-15 11:28:56 +00004636**
drhb4d58ae2008-02-21 20:17:06 +00004637** New VFSes are registered with sqlite3_vfs_register().
4638** Each new VFS becomes the default VFS if the makeDflt flag is set.
4639** The same VFS can be registered multiple times without injury.
4640** To make an existing VFS into the default VFS, register it again
4641** with the makeDflt flag set. If two different VFSes with the
4642** same name are registered, the behavior is undefined. If a
drhb6f5cf32007-08-28 15:21:45 +00004643** VFS is registered with a name that is NULL or an empty string,
4644** then the behavior is undefined.
mihailim15194222008-06-22 09:55:14 +00004645**
drhb4d58ae2008-02-21 20:17:06 +00004646** Unregister a VFS with the sqlite3_vfs_unregister() interface.
4647** If the default VFS is unregistered, another VFS is chosen as
drhd84f9462007-08-15 11:28:56 +00004648** the default. The choice for the new VFS is arbitrary.
drhb4d58ae2008-02-21 20:17:06 +00004649**
drh8b39db12009-02-18 18:37:58 +00004650** Requirements:
4651** [H11203] [H11206] [H11209] [H11212] [H11215] [H11218]
drhd84f9462007-08-15 11:28:56 +00004652*/
drhd677b3d2007-08-20 22:48:41 +00004653sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName);
drhd677b3d2007-08-20 22:48:41 +00004654int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);
4655int sqlite3_vfs_unregister(sqlite3_vfs*);
drhd84f9462007-08-15 11:28:56 +00004656
4657/*
drh9cd29642008-07-23 00:52:55 +00004658** CAPI3REF: Mutexes {H17000} <S20000>
drhd84f9462007-08-15 11:28:56 +00004659**
4660** The SQLite core uses these routines for thread
danielk19774a9d1f62008-06-19 08:51:23 +00004661** synchronization. Though they are intended for internal
drhd84f9462007-08-15 11:28:56 +00004662** use by SQLite, code that links against SQLite is
4663** permitted to use any of these routines.
4664**
mihailim15194222008-06-22 09:55:14 +00004665** The SQLite source code contains multiple implementations
drh8bacf972007-08-25 16:21:29 +00004666** of these mutex routines. An appropriate implementation
4667** is selected automatically at compile-time. The following
4668** implementations are available in the SQLite core:
drhd84f9462007-08-15 11:28:56 +00004669**
4670** <ul>
drhc7ce76a2007-08-30 14:10:30 +00004671** <li> SQLITE_MUTEX_OS2
drhd84f9462007-08-15 11:28:56 +00004672** <li> SQLITE_MUTEX_PTHREAD
drhc7ce76a2007-08-30 14:10:30 +00004673** <li> SQLITE_MUTEX_W32
drhd84f9462007-08-15 11:28:56 +00004674** <li> SQLITE_MUTEX_NOOP
drhd84f9462007-08-15 11:28:56 +00004675** </ul>
4676**
mihailim15194222008-06-22 09:55:14 +00004677** The SQLITE_MUTEX_NOOP implementation is a set of routines
4678** that does no real locking and is appropriate for use in
drhc7ce76a2007-08-30 14:10:30 +00004679** a single-threaded application. The SQLITE_MUTEX_OS2,
4680** SQLITE_MUTEX_PTHREAD, and SQLITE_MUTEX_W32 implementations
shane26b34032008-05-23 17:21:09 +00004681** are appropriate for use on OS/2, Unix, and Windows.
mihailim15194222008-06-22 09:55:14 +00004682**
drh8bacf972007-08-25 16:21:29 +00004683** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor
4684** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex
danielk19774a9d1f62008-06-19 08:51:23 +00004685** implementation is included with the library. In this case the
4686** application must supply a custom mutex implementation using the
4687** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function
mihailim15194222008-06-22 09:55:14 +00004688** before calling sqlite3_initialize() or any other public sqlite3_
danielk19774a9d1f62008-06-19 08:51:23 +00004689** function that calls sqlite3_initialize().
drhcb041342008-06-12 00:07:29 +00004690**
drh9a247912008-07-22 18:45:08 +00004691** {H17011} The sqlite3_mutex_alloc() routine allocates a new
4692** mutex and returns a pointer to it. {H17012} If it returns NULL
4693** that means that a mutex could not be allocated. {H17013} SQLite
4694** will unwind its stack and return an error. {H17014} The argument
drh6bdec4a2007-08-16 19:40:16 +00004695** to sqlite3_mutex_alloc() is one of these integer constants:
4696**
4697** <ul>
4698** <li> SQLITE_MUTEX_FAST
4699** <li> SQLITE_MUTEX_RECURSIVE
4700** <li> SQLITE_MUTEX_STATIC_MASTER
4701** <li> SQLITE_MUTEX_STATIC_MEM
drh86f8c192007-08-22 00:39:19 +00004702** <li> SQLITE_MUTEX_STATIC_MEM2
drh6bdec4a2007-08-16 19:40:16 +00004703** <li> SQLITE_MUTEX_STATIC_PRNG
danielk19779f61c2f2007-08-27 17:27:49 +00004704** <li> SQLITE_MUTEX_STATIC_LRU
danielk1977dfb316d2008-03-26 18:34:43 +00004705** <li> SQLITE_MUTEX_STATIC_LRU2
mihailim04bcc002008-06-22 10:21:27 +00004706** </ul>
drh6bdec4a2007-08-16 19:40:16 +00004707**
drh9a247912008-07-22 18:45:08 +00004708** {H17015} The first two constants cause sqlite3_mutex_alloc() to create
drh6bdec4a2007-08-16 19:40:16 +00004709** a new mutex. The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
drhf5befa02007-12-06 02:42:07 +00004710** is used but not necessarily so when SQLITE_MUTEX_FAST is used. {END}
drh6bdec4a2007-08-16 19:40:16 +00004711** The mutex implementation does not need to make a distinction
4712** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
drh9a247912008-07-22 18:45:08 +00004713** not want to. {H17016} But SQLite will only request a recursive mutex in
drhf5befa02007-12-06 02:42:07 +00004714** cases where it really needs one. {END} If a faster non-recursive mutex
drh6bdec4a2007-08-16 19:40:16 +00004715** implementation is available on the host platform, the mutex subsystem
4716** might return such a mutex in response to SQLITE_MUTEX_FAST.
4717**
drh9a247912008-07-22 18:45:08 +00004718** {H17017} The other allowed parameters to sqlite3_mutex_alloc() each return
shane7c7c3112009-08-17 15:31:23 +00004719** a pointer to a static preexisting mutex. {END} Six static mutexes are
drh6bdec4a2007-08-16 19:40:16 +00004720** used by the current version of SQLite. Future versions of SQLite
4721** may add additional static mutexes. Static mutexes are for internal
4722** use by SQLite only. Applications that use SQLite mutexes should
4723** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
4724** SQLITE_MUTEX_RECURSIVE.
4725**
drh9a247912008-07-22 18:45:08 +00004726** {H17018} Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
drh6bdec4a2007-08-16 19:40:16 +00004727** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
drh9a247912008-07-22 18:45:08 +00004728** returns a different mutex on every call. {H17034} But for the static
drh6bdec4a2007-08-16 19:40:16 +00004729** mutex types, the same mutex is returned on every call that has
mihailim04bcc002008-06-22 10:21:27 +00004730** the same type number.
drhd84f9462007-08-15 11:28:56 +00004731**
drh9a247912008-07-22 18:45:08 +00004732** {H17019} The sqlite3_mutex_free() routine deallocates a previously
4733** allocated dynamic mutex. {H17020} SQLite is careful to deallocate every
drh4766b292008-06-26 02:53:02 +00004734** dynamic mutex that it allocates. {A17021} The dynamic mutexes must not be in
4735** use when they are deallocated. {A17022} Attempting to deallocate a static
drh9a247912008-07-22 18:45:08 +00004736** mutex results in undefined behavior. {H17023} SQLite never deallocates
drhf5befa02007-12-06 02:42:07 +00004737** a static mutex. {END}
drhd84f9462007-08-15 11:28:56 +00004738**
drh6bdec4a2007-08-16 19:40:16 +00004739** The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
drh9a247912008-07-22 18:45:08 +00004740** to enter a mutex. {H17024} If another thread is already within the mutex,
drh6bdec4a2007-08-16 19:40:16 +00004741** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
drh9a247912008-07-22 18:45:08 +00004742** SQLITE_BUSY. {H17025} The sqlite3_mutex_try() interface returns [SQLITE_OK]
4743** upon successful entry. {H17026} Mutexes created using
drhf5befa02007-12-06 02:42:07 +00004744** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread.
drh9a247912008-07-22 18:45:08 +00004745** {H17027} In such cases the,
drh6bdec4a2007-08-16 19:40:16 +00004746** mutex must be exited an equal number of times before another thread
drh4766b292008-06-26 02:53:02 +00004747** can enter. {A17028} If the same thread tries to enter any other
drhf5befa02007-12-06 02:42:07 +00004748** kind of mutex more than once, the behavior is undefined.
drh9a247912008-07-22 18:45:08 +00004749** {H17029} SQLite will never exhibit
drhcb041342008-06-12 00:07:29 +00004750** such behavior in its own use of mutexes.
drhd84f9462007-08-15 11:28:56 +00004751**
mihailim15194222008-06-22 09:55:14 +00004752** Some systems (for example, Windows 95) do not support the operation
4753** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try()
drh9a247912008-07-22 18:45:08 +00004754** will always return SQLITE_BUSY. {H17030} The SQLite core only ever uses
drhcb041342008-06-12 00:07:29 +00004755** sqlite3_mutex_try() as an optimization so this is acceptable behavior.
drhca49cba2007-09-04 22:31:36 +00004756**
drh9a247912008-07-22 18:45:08 +00004757** {H17031} The sqlite3_mutex_leave() routine exits a mutex that was
drh4766b292008-06-26 02:53:02 +00004758** previously entered by the same thread. {A17032} The behavior
drh8bacf972007-08-25 16:21:29 +00004759** is undefined if the mutex is not currently entered by the
drh9a247912008-07-22 18:45:08 +00004760** calling thread or is not currently allocated. {H17033} SQLite will
drhf5befa02007-12-06 02:42:07 +00004761** never do either. {END}
drh8bacf972007-08-25 16:21:29 +00004762**
drh40257ff2008-06-13 18:24:27 +00004763** If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or
4764** sqlite3_mutex_leave() is a NULL pointer, then all three routines
4765** behave as no-ops.
4766**
drh8bacf972007-08-25 16:21:29 +00004767** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()].
4768*/
4769sqlite3_mutex *sqlite3_mutex_alloc(int);
4770void sqlite3_mutex_free(sqlite3_mutex*);
4771void sqlite3_mutex_enter(sqlite3_mutex*);
4772int sqlite3_mutex_try(sqlite3_mutex*);
4773void sqlite3_mutex_leave(sqlite3_mutex*);
4774
drh56a40a82008-06-18 13:47:03 +00004775/*
drh9cd29642008-07-23 00:52:55 +00004776** CAPI3REF: Mutex Methods Object {H17120} <S20130>
drhd5a68d32008-08-04 13:44:57 +00004777** EXPERIMENTAL
drh56a40a82008-06-18 13:47:03 +00004778**
4779** An instance of this structure defines the low-level routines
danielk19774a9d1f62008-06-19 08:51:23 +00004780** used to allocate and use mutexes.
4781**
4782** Usually, the default mutex implementations provided by SQLite are
mihailim15194222008-06-22 09:55:14 +00004783** sufficient, however the user has the option of substituting a custom
4784** implementation for specialized deployments or systems for which SQLite
danielk19774a9d1f62008-06-19 08:51:23 +00004785** does not provide a suitable implementation. In this case, the user
4786** creates and populates an instance of this structure to pass
mihailim15194222008-06-22 09:55:14 +00004787** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option.
danielk19774a9d1f62008-06-19 08:51:23 +00004788** Additionally, an instance of this structure can be used as an
4789** output variable when querying the system for the current mutex
4790** implementation, using the [SQLITE_CONFIG_GETMUTEX] option.
4791**
4792** The xMutexInit method defined by this structure is invoked as
4793** part of system initialization by the sqlite3_initialize() function.
drh9a247912008-07-22 18:45:08 +00004794** {H17001} The xMutexInit routine shall be called by SQLite once for each
mihailim15194222008-06-22 09:55:14 +00004795** effective call to [sqlite3_initialize()].
danielk19774a9d1f62008-06-19 08:51:23 +00004796**
4797** The xMutexEnd method defined by this structure is invoked as
4798** part of system shutdown by the sqlite3_shutdown() function. The
4799** implementation of this method is expected to release all outstanding
4800** resources obtained by the mutex methods implementation, especially
drh9a247912008-07-22 18:45:08 +00004801** those obtained by the xMutexInit method. {H17003} The xMutexEnd()
mihailim15194222008-06-22 09:55:14 +00004802** interface shall be invoked once for each call to [sqlite3_shutdown()].
danielk19774a9d1f62008-06-19 08:51:23 +00004803**
4804** The remaining seven methods defined by this structure (xMutexAlloc,
4805** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and
4806** xMutexNotheld) implement the following interfaces (respectively):
drh56a40a82008-06-18 13:47:03 +00004807**
4808** <ul>
danielk19774a9d1f62008-06-19 08:51:23 +00004809** <li> [sqlite3_mutex_alloc()] </li>
4810** <li> [sqlite3_mutex_free()] </li>
4811** <li> [sqlite3_mutex_enter()] </li>
4812** <li> [sqlite3_mutex_try()] </li>
4813** <li> [sqlite3_mutex_leave()] </li>
4814** <li> [sqlite3_mutex_held()] </li>
4815** <li> [sqlite3_mutex_notheld()] </li>
drh56a40a82008-06-18 13:47:03 +00004816** </ul>
danielk19774a9d1f62008-06-19 08:51:23 +00004817**
4818** The only difference is that the public sqlite3_XXX functions enumerated
4819** above silently ignore any invocations that pass a NULL pointer instead
4820** of a valid mutex handle. The implementations of the methods defined
4821** by this structure are not required to handle this case, the results
4822** of passing a NULL pointer instead of a valid mutex handle are undefined
4823** (i.e. it is acceptable to provide an implementation that segfaults if
4824** it is passed a NULL pointer).
drh9ac06502009-08-17 13:42:29 +00004825**
4826** The xMutexInit() method must be threadsafe. It must be harmless to
4827** invoke xMutexInit() mutiple times within the same process and without
4828** intervening calls to xMutexEnd(). Second and subsequent calls to
4829** xMutexInit() must be no-ops.
4830**
4831** xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()]
4832** and its associates). Similarly, xMutexAlloc() must not use SQLite memory
4833** allocation for a static mutex. However xMutexAlloc() may use SQLite
4834** memory allocation for a fast or recursive mutex.
4835**
4836** SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is
4837** called, but only if the prior call to xMutexInit returned SQLITE_OK.
4838** If xMutexInit fails in any way, it is expected to clean up after itself
4839** prior to returning.
drh56a40a82008-06-18 13:47:03 +00004840*/
danielk19776d2ab0e2008-06-17 17:21:18 +00004841typedef struct sqlite3_mutex_methods sqlite3_mutex_methods;
4842struct sqlite3_mutex_methods {
4843 int (*xMutexInit)(void);
danielk19774a9d1f62008-06-19 08:51:23 +00004844 int (*xMutexEnd)(void);
danielk19776d2ab0e2008-06-17 17:21:18 +00004845 sqlite3_mutex *(*xMutexAlloc)(int);
4846 void (*xMutexFree)(sqlite3_mutex *);
4847 void (*xMutexEnter)(sqlite3_mutex *);
4848 int (*xMutexTry)(sqlite3_mutex *);
4849 void (*xMutexLeave)(sqlite3_mutex *);
danielk19776d2ab0e2008-06-17 17:21:18 +00004850 int (*xMutexHeld)(sqlite3_mutex *);
4851 int (*xMutexNotheld)(sqlite3_mutex *);
4852};
4853
drh8bacf972007-08-25 16:21:29 +00004854/*
drh9cd29642008-07-23 00:52:55 +00004855** CAPI3REF: Mutex Verification Routines {H17080} <S20130> <S30800>
drhd677b3d2007-08-20 22:48:41 +00004856**
4857** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines
drh9a247912008-07-22 18:45:08 +00004858** are intended for use inside assert() statements. {H17081} The SQLite core
drhf77a2ff2007-08-25 14:49:36 +00004859** never uses these routines except inside an assert() and applications
drh9a247912008-07-22 18:45:08 +00004860** are advised to follow the lead of the core. {H17082} The core only
drh8bacf972007-08-25 16:21:29 +00004861** provides implementations for these routines when it is compiled
drh4766b292008-06-26 02:53:02 +00004862** with the SQLITE_DEBUG flag. {A17087} External mutex implementations
drh8bacf972007-08-25 16:21:29 +00004863** are only required to provide these routines if SQLITE_DEBUG is
4864** defined and if NDEBUG is not defined.
4865**
drh9a247912008-07-22 18:45:08 +00004866** {H17083} These routines should return true if the mutex in their argument
mihailim04bcc002008-06-22 10:21:27 +00004867** is held or not held, respectively, by the calling thread.
drh8bacf972007-08-25 16:21:29 +00004868**
drhfddfa2d2007-12-05 18:05:16 +00004869** {X17084} The implementation is not required to provided versions of these
mihailim04bcc002008-06-22 10:21:27 +00004870** routines that actually work. If the implementation does not provide working
4871** versions of these routines, it should at least provide stubs that always
4872** return true so that one does not get spurious assertion failures.
drhd677b3d2007-08-20 22:48:41 +00004873**
drh9a247912008-07-22 18:45:08 +00004874** {H17085} If the argument to sqlite3_mutex_held() is a NULL pointer then
drhfddfa2d2007-12-05 18:05:16 +00004875** the routine should return 1. {END} This seems counter-intuitive since
drhd677b3d2007-08-20 22:48:41 +00004876** clearly the mutex cannot be held if it does not exist. But the
4877** the reason the mutex does not exist is because the build is not
4878** using mutexes. And we do not want the assert() containing the
4879** call to sqlite3_mutex_held() to fail, so a non-zero return is
drh9a247912008-07-22 18:45:08 +00004880** the appropriate thing to do. {H17086} The sqlite3_mutex_notheld()
drhd677b3d2007-08-20 22:48:41 +00004881** interface should also return 1 when given a NULL pointer.
drhd84f9462007-08-15 11:28:56 +00004882*/
drhd677b3d2007-08-20 22:48:41 +00004883int sqlite3_mutex_held(sqlite3_mutex*);
4884int sqlite3_mutex_notheld(sqlite3_mutex*);
drh32bc3f62007-08-21 20:25:39 +00004885
4886/*
drh9cd29642008-07-23 00:52:55 +00004887** CAPI3REF: Mutex Types {H17001} <H17000>
drh32bc3f62007-08-21 20:25:39 +00004888**
drhd5a68d32008-08-04 13:44:57 +00004889** The [sqlite3_mutex_alloc()] interface takes a single argument
mihailim04bcc002008-06-22 10:21:27 +00004890** which is one of these integer constants.
drhd5a68d32008-08-04 13:44:57 +00004891**
4892** The set of static mutexes may change from one SQLite release to the
4893** next. Applications that override the built-in mutex logic must be
4894** prepared to accommodate additional static mutexes.
drh32bc3f62007-08-21 20:25:39 +00004895*/
drh6bdec4a2007-08-16 19:40:16 +00004896#define SQLITE_MUTEX_FAST 0
4897#define SQLITE_MUTEX_RECURSIVE 1
4898#define SQLITE_MUTEX_STATIC_MASTER 2
drh86f8c192007-08-22 00:39:19 +00004899#define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */
drh7555d8e2009-03-20 13:15:30 +00004900#define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */
4901#define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */
drh86f8c192007-08-22 00:39:19 +00004902#define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */
danielk19779f61c2f2007-08-27 17:27:49 +00004903#define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */
danielk1977dfb316d2008-03-26 18:34:43 +00004904#define SQLITE_MUTEX_STATIC_LRU2 7 /* lru page list */
drh6d2069d2007-08-14 01:58:53 +00004905
drhcc6bb3e2007-08-31 16:11:35 +00004906/*
drh4413d0e2008-11-04 13:46:27 +00004907** CAPI3REF: Retrieve the mutex for a database connection {H17002} <H17000>
4908**
4909** This interface returns a pointer the [sqlite3_mutex] object that
4910** serializes access to the [database connection] given in the argument
4911** when the [threading mode] is Serialized.
4912** If the [threading mode] is Single-thread or Multi-thread then this
4913** routine returns a NULL pointer.
4914*/
4915sqlite3_mutex *sqlite3_db_mutex(sqlite3*);
4916
4917/*
drh9cd29642008-07-23 00:52:55 +00004918** CAPI3REF: Low-Level Control Of Database Files {H11300} <S30800>
drhcc6bb3e2007-08-31 16:11:35 +00004919**
drh9a247912008-07-22 18:45:08 +00004920** {H11301} The [sqlite3_file_control()] interface makes a direct call to the
drhcc6bb3e2007-08-31 16:11:35 +00004921** xFileControl method for the [sqlite3_io_methods] object associated
drh9a247912008-07-22 18:45:08 +00004922** with a particular database identified by the second argument. {H11302} The
drhcc6bb3e2007-08-31 16:11:35 +00004923** name of the database is the name assigned to the database by the
4924** <a href="lang_attach.html">ATTACH</a> SQL command that opened the
drh9a247912008-07-22 18:45:08 +00004925** database. {H11303} To control the main database file, use the name "main"
4926** or a NULL pointer. {H11304} The third and fourth parameters to this routine
drhcc6bb3e2007-08-31 16:11:35 +00004927** are passed directly through to the second and third parameters of
drh9a247912008-07-22 18:45:08 +00004928** the xFileControl method. {H11305} The return value of the xFileControl
drhcc6bb3e2007-08-31 16:11:35 +00004929** method becomes the return value of this routine.
4930**
drh9a247912008-07-22 18:45:08 +00004931** {H11306} If the second parameter (zDbName) does not match the name of any
4932** open database file, then SQLITE_ERROR is returned. {H11307} This error
drhcc6bb3e2007-08-31 16:11:35 +00004933** code is not remembered and will not be recalled by [sqlite3_errcode()]
drh4766b292008-06-26 02:53:02 +00004934** or [sqlite3_errmsg()]. {A11308} The underlying xFileControl method might
4935** also return SQLITE_ERROR. {A11309} There is no way to distinguish between
drhcc6bb3e2007-08-31 16:11:35 +00004936** an incorrect zDbName and an SQLITE_ERROR return from the underlying
drhfddfa2d2007-12-05 18:05:16 +00004937** xFileControl method. {END}
drh4ff7fa02007-09-01 18:17:21 +00004938**
4939** See also: [SQLITE_FCNTL_LOCKSTATE]
drhcc6bb3e2007-08-31 16:11:35 +00004940*/
4941int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*);
drh6d2069d2007-08-14 01:58:53 +00004942
danielk19778cbadb02007-05-03 16:31:26 +00004943/*
drh9cd29642008-07-23 00:52:55 +00004944** CAPI3REF: Testing Interface {H11400} <S30800>
drhed13d982008-01-31 14:43:24 +00004945**
4946** The sqlite3_test_control() interface is used to read out internal
4947** state of SQLite and to inject faults into SQLite for testing
shane26b34032008-05-23 17:21:09 +00004948** purposes. The first parameter is an operation code that determines
drhed13d982008-01-31 14:43:24 +00004949** the number, meaning, and operation of all subsequent parameters.
4950**
4951** This interface is not for use by applications. It exists solely
4952** for verifying the correct operation of the SQLite library. Depending
4953** on how the SQLite library is compiled, this interface might not exist.
4954**
4955** The details of the operation codes, their meanings, the parameters
4956** they take, and what they do are all subject to change without notice.
4957** Unlike most of the SQLite API, this function is not guaranteed to
4958** operate consistently from one release to the next.
4959*/
4960int sqlite3_test_control(int op, ...);
4961
4962/*
drh9cd29642008-07-23 00:52:55 +00004963** CAPI3REF: Testing Interface Operation Codes {H11410} <H11400>
drhed13d982008-01-31 14:43:24 +00004964**
4965** These constants are the valid operation code parameters used
4966** as the first argument to [sqlite3_test_control()].
4967**
shane26b34032008-05-23 17:21:09 +00004968** These parameters and their meanings are subject to change
drhed13d982008-01-31 14:43:24 +00004969** without notice. These values are for testing purposes only.
4970** Applications should not use any of these parameters or the
4971** [sqlite3_test_control()] interface.
4972*/
drh2fa18682008-03-19 14:15:34 +00004973#define SQLITE_TESTCTRL_PRNG_SAVE 5
4974#define SQLITE_TESTCTRL_PRNG_RESTORE 6
4975#define SQLITE_TESTCTRL_PRNG_RESET 7
drh3088d592008-03-21 16:45:47 +00004976#define SQLITE_TESTCTRL_BITVEC_TEST 8
danielk1977d09414c2008-06-19 18:17:49 +00004977#define SQLITE_TESTCTRL_FAULT_INSTALL 9
danielk19772d1d86f2008-06-20 14:59:51 +00004978#define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10
drhc7a3bb92009-02-05 16:31:45 +00004979#define SQLITE_TESTCTRL_PENDING_BYTE 11
drhf3af63f2009-05-09 18:59:42 +00004980#define SQLITE_TESTCTRL_ASSERT 12
4981#define SQLITE_TESTCTRL_ALWAYS 13
drhc046e3e2009-07-15 11:26:44 +00004982#define SQLITE_TESTCTRL_RESERVE 14
drhed13d982008-01-31 14:43:24 +00004983
drhf7141992008-06-19 00:16:08 +00004984/*
drh9cd29642008-07-23 00:52:55 +00004985** CAPI3REF: SQLite Runtime Status {H17200} <S60200>
drhd5a68d32008-08-04 13:44:57 +00004986** EXPERIMENTAL
drhf7141992008-06-19 00:16:08 +00004987**
mihailim15194222008-06-22 09:55:14 +00004988** This interface is used to retrieve runtime status information
drhf7141992008-06-19 00:16:08 +00004989** about the preformance of SQLite, and optionally to reset various
4990** highwater marks. The first argument is an integer code for
4991** the specific parameter to measure. Recognized integer codes
4992** are of the form [SQLITE_STATUS_MEMORY_USED | SQLITE_STATUS_...].
4993** The current value of the parameter is returned into *pCurrent.
4994** The highest recorded value is returned in *pHighwater. If the
4995** resetFlag is true, then the highest record value is reset after
4996** *pHighwater is written. Some parameters do not record the highest
4997** value. For those parameters
4998** nothing is written into *pHighwater and the resetFlag is ignored.
4999** Other parameters record only the highwater mark and not the current
5000** value. For these latter parameters nothing is written into *pCurrent.
5001**
5002** This routine returns SQLITE_OK on success and a non-zero
5003** [error code] on failure.
5004**
5005** This routine is threadsafe but is not atomic. This routine can
5006** called while other threads are running the same or different SQLite
5007** interfaces. However the values returned in *pCurrent and
5008** *pHighwater reflect the status of SQLite at different points in time
5009** and it is possible that another thread might change the parameter
5010** in between the times when *pCurrent and *pHighwater are written.
5011**
drh2462e322008-07-31 14:47:54 +00005012** See also: [sqlite3_db_status()]
drhf7141992008-06-19 00:16:08 +00005013*/
shanea79c3cc2008-08-11 17:27:01 +00005014SQLITE_EXPERIMENTAL int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag);
drh2462e322008-07-31 14:47:54 +00005015
danielk1977075c23a2008-09-01 18:34:20 +00005016
drhf7141992008-06-19 00:16:08 +00005017/*
drh9cd29642008-07-23 00:52:55 +00005018** CAPI3REF: Status Parameters {H17250} <H17200>
drhd5a68d32008-08-04 13:44:57 +00005019** EXPERIMENTAL
drhf7141992008-06-19 00:16:08 +00005020**
5021** These integer constants designate various run-time status parameters
5022** that can be returned by [sqlite3_status()].
5023**
5024** <dl>
5025** <dt>SQLITE_STATUS_MEMORY_USED</dt>
5026** <dd>This parameter is the current amount of memory checked out
mihailim15194222008-06-22 09:55:14 +00005027** using [sqlite3_malloc()], either directly or indirectly. The
drhf7141992008-06-19 00:16:08 +00005028** figure includes calls made to [sqlite3_malloc()] by the application
5029** and internal memory usage by the SQLite library. Scratch memory
5030** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache
5031** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in
5032** this parameter. The amount returned is the sum of the allocation
mihailim15194222008-06-22 09:55:14 +00005033** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>
drhf7141992008-06-19 00:16:08 +00005034**
drhe50135e2008-08-05 17:53:22 +00005035** <dt>SQLITE_STATUS_MALLOC_SIZE</dt>
5036** <dd>This parameter records the largest memory allocation request
5037** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their
5038** internal equivalents). Only the value returned in the
5039** *pHighwater parameter to [sqlite3_status()] is of interest.
5040** The value written into the *pCurrent parameter is undefined.</dd>
5041**
drhf7141992008-06-19 00:16:08 +00005042** <dt>SQLITE_STATUS_PAGECACHE_USED</dt>
5043** <dd>This parameter returns the number of pages used out of the
drhe50135e2008-08-05 17:53:22 +00005044** [pagecache memory allocator] that was configured using
5045** [SQLITE_CONFIG_PAGECACHE]. The
drhf7141992008-06-19 00:16:08 +00005046** value returned is in pages, not in bytes.</dd>
5047**
5048** <dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt>
5049** <dd>This parameter returns the number of bytes of page cache
5050** allocation which could not be statisfied by the [SQLITE_CONFIG_PAGECACHE]
drhe50135e2008-08-05 17:53:22 +00005051** buffer and where forced to overflow to [sqlite3_malloc()]. The
5052** returned value includes allocations that overflowed because they
5053** where too large (they were larger than the "sz" parameter to
5054** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because
5055** no space was left in the page cache.</dd>
5056**
5057** <dt>SQLITE_STATUS_PAGECACHE_SIZE</dt>
5058** <dd>This parameter records the largest memory allocation request
5059** handed to [pagecache memory allocator]. Only the value returned in the
5060** *pHighwater parameter to [sqlite3_status()] is of interest.
5061** The value written into the *pCurrent parameter is undefined.</dd>
drhf7141992008-06-19 00:16:08 +00005062**
5063** <dt>SQLITE_STATUS_SCRATCH_USED</dt>
5064** <dd>This parameter returns the number of allocations used out of the
drhe50135e2008-08-05 17:53:22 +00005065** [scratch memory allocator] configured using
drhf7141992008-06-19 00:16:08 +00005066** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not
drhe50135e2008-08-05 17:53:22 +00005067** in bytes. Since a single thread may only have one scratch allocation
drhf7141992008-06-19 00:16:08 +00005068** outstanding at time, this parameter also reports the number of threads
5069** using scratch memory at the same time.</dd>
5070**
drh71f48622008-07-13 03:55:03 +00005071** <dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt>
drhf7141992008-06-19 00:16:08 +00005072** <dd>This parameter returns the number of bytes of scratch memory
5073** allocation which could not be statisfied by the [SQLITE_CONFIG_SCRATCH]
drhe50135e2008-08-05 17:53:22 +00005074** buffer and where forced to overflow to [sqlite3_malloc()]. The values
5075** returned include overflows because the requested allocation was too
5076** larger (that is, because the requested allocation was larger than the
5077** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer
5078** slots were available.
5079** </dd>
drhf7141992008-06-19 00:16:08 +00005080**
drhe50135e2008-08-05 17:53:22 +00005081** <dt>SQLITE_STATUS_SCRATCH_SIZE</dt>
drhf7141992008-06-19 00:16:08 +00005082** <dd>This parameter records the largest memory allocation request
drhe50135e2008-08-05 17:53:22 +00005083** handed to [scratch memory allocator]. Only the value returned in the
5084** *pHighwater parameter to [sqlite3_status()] is of interest.
5085** The value written into the *pCurrent parameter is undefined.</dd>
drhec424a52008-07-25 15:39:03 +00005086**
5087** <dt>SQLITE_STATUS_PARSER_STACK</dt>
5088** <dd>This parameter records the deepest parser stack. It is only
drh0a60a382008-07-31 17:16:05 +00005089** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>
drhf7141992008-06-19 00:16:08 +00005090** </dl>
5091**
5092** New status parameters may be added from time to time.
5093*/
5094#define SQLITE_STATUS_MEMORY_USED 0
5095#define SQLITE_STATUS_PAGECACHE_USED 1
5096#define SQLITE_STATUS_PAGECACHE_OVERFLOW 2
5097#define SQLITE_STATUS_SCRATCH_USED 3
5098#define SQLITE_STATUS_SCRATCH_OVERFLOW 4
5099#define SQLITE_STATUS_MALLOC_SIZE 5
drhec424a52008-07-25 15:39:03 +00005100#define SQLITE_STATUS_PARSER_STACK 6
drhe50135e2008-08-05 17:53:22 +00005101#define SQLITE_STATUS_PAGECACHE_SIZE 7
5102#define SQLITE_STATUS_SCRATCH_SIZE 8
drhf7141992008-06-19 00:16:08 +00005103
drh633e6d52008-07-28 19:34:53 +00005104/*
drhd1d38482008-10-07 23:46:38 +00005105** CAPI3REF: Database Connection Status {H17500} <S60200>
5106** EXPERIMENTAL
5107**
5108** This interface is used to retrieve runtime status information
5109** about a single [database connection]. The first argument is the
5110** database connection object to be interrogated. The second argument
5111** is the parameter to interrogate. Currently, the only allowed value
5112** for the second parameter is [SQLITE_DBSTATUS_LOOKASIDE_USED].
5113** Additional options will likely appear in future releases of SQLite.
5114**
5115** The current value of the requested parameter is written into *pCur
5116** and the highest instantaneous value is written into *pHiwtr. If
5117** the resetFlg is true, then the highest instantaneous value is
5118** reset back down to the current value.
5119**
5120** See also: [sqlite3_status()] and [sqlite3_stmt_status()].
5121*/
5122SQLITE_EXPERIMENTAL int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg);
5123
5124/*
5125** CAPI3REF: Status Parameters for database connections {H17520} <H17500>
drhd5a68d32008-08-04 13:44:57 +00005126** EXPERIMENTAL
drh633e6d52008-07-28 19:34:53 +00005127**
5128** Status verbs for [sqlite3_db_status()].
5129**
5130** <dl>
5131** <dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt>
5132** <dd>This parameter returns the number of lookaside memory slots currently
5133** checked out.</dd>
5134** </dl>
5135*/
5136#define SQLITE_DBSTATUS_LOOKASIDE_USED 0
drhed13d982008-01-31 14:43:24 +00005137
drhd1d38482008-10-07 23:46:38 +00005138
5139/*
5140** CAPI3REF: Prepared Statement Status {H17550} <S60200>
5141** EXPERIMENTAL
5142**
5143** Each prepared statement maintains various
5144** [SQLITE_STMTSTATUS_SORT | counters] that measure the number
5145** of times it has performed specific operations. These counters can
5146** be used to monitor the performance characteristics of the prepared
5147** statements. For example, if the number of table steps greatly exceeds
5148** the number of table searches or result rows, that would tend to indicate
5149** that the prepared statement is using a full table scan rather than
5150** an index.
5151**
5152** This interface is used to retrieve and reset counter values from
5153** a [prepared statement]. The first argument is the prepared statement
5154** object to be interrogated. The second argument
5155** is an integer code for a specific [SQLITE_STMTSTATUS_SORT | counter]
5156** to be interrogated.
5157** The current value of the requested counter is returned.
5158** If the resetFlg is true, then the counter is reset to zero after this
5159** interface call returns.
5160**
5161** See also: [sqlite3_status()] and [sqlite3_db_status()].
5162*/
5163SQLITE_EXPERIMENTAL int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg);
5164
5165/*
5166** CAPI3REF: Status Parameters for prepared statements {H17570} <H17550>
5167** EXPERIMENTAL
5168**
5169** These preprocessor macros define integer codes that name counter
5170** values associated with the [sqlite3_stmt_status()] interface.
5171** The meanings of the various counters are as follows:
5172**
5173** <dl>
5174** <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt>
5175** <dd>This is the number of times that SQLite has stepped forward in
5176** a table as part of a full table scan. Large numbers for this counter
5177** may indicate opportunities for performance improvement through
5178** careful use of indices.</dd>
5179**
5180** <dt>SQLITE_STMTSTATUS_SORT</dt>
5181** <dd>This is the number of sort operations that have occurred.
5182** A non-zero value in this counter may indicate an opportunity to
5183** improvement performance through careful use of indices.</dd>
5184**
5185** </dl>
5186*/
5187#define SQLITE_STMTSTATUS_FULLSCAN_STEP 1
5188#define SQLITE_STMTSTATUS_SORT 2
5189
drhed13d982008-01-31 14:43:24 +00005190/*
drh21614742008-11-18 19:18:08 +00005191** CAPI3REF: Custom Page Cache Object
5192** EXPERIMENTAL
5193**
danielk1977bc2ca9e2008-11-13 14:28:28 +00005194** The sqlite3_pcache type is opaque. It is implemented by
5195** the pluggable module. The SQLite core has no knowledge of
5196** its size or internal structure and never deals with the
5197** sqlite3_pcache object except by holding and passing pointers
5198** to the object.
drh21614742008-11-18 19:18:08 +00005199**
5200** See [sqlite3_pcache_methods] for additional information.
danielk1977bc2ca9e2008-11-13 14:28:28 +00005201*/
5202typedef struct sqlite3_pcache sqlite3_pcache;
5203
5204/*
drh21614742008-11-18 19:18:08 +00005205** CAPI3REF: Application Defined Page Cache.
danielk1977bc2ca9e2008-11-13 14:28:28 +00005206** EXPERIMENTAL
5207**
drh21614742008-11-18 19:18:08 +00005208** The [sqlite3_config]([SQLITE_CONFIG_PCACHE], ...) interface can
danielk1977bc2ca9e2008-11-13 14:28:28 +00005209** register an alternative page cache implementation by passing in an
5210** instance of the sqlite3_pcache_methods structure. The majority of the
shane7c7c3112009-08-17 15:31:23 +00005211** heap memory used by SQLite is used by the page cache to cache data read
danielk1977bc2ca9e2008-11-13 14:28:28 +00005212** from, or ready to be written to, the database file. By implementing a
5213** custom page cache using this API, an application can control more
shane7c7c3112009-08-17 15:31:23 +00005214** precisely the amount of memory consumed by SQLite, the way in which
danielk1977bc2ca9e2008-11-13 14:28:28 +00005215** said memory is allocated and released, and the policies used to
5216** determine exactly which parts of a database file are cached and for
5217** how long.
5218**
shane7c7c3112009-08-17 15:31:23 +00005219** The contents of the structure are copied to an internal buffer by SQLite
danielk1977bc2ca9e2008-11-13 14:28:28 +00005220** within the call to [sqlite3_config].
5221**
drh21614742008-11-18 19:18:08 +00005222** The xInit() method is called once for each call to [sqlite3_initialize()]
danielk1977bc2ca9e2008-11-13 14:28:28 +00005223** (usually only once during the lifetime of the process). It is passed
5224** a copy of the sqlite3_pcache_methods.pArg value. It can be used to set
5225** up global structures and mutexes required by the custom page cache
shane7c7c3112009-08-17 15:31:23 +00005226** implementation.
5227**
5228** The xShutdown() method is called from within [sqlite3_shutdown()],
5229** if the application invokes this API. It can be used to clean up
5230** any outstanding resources before process shutdown, if required.
5231**
5232** SQLite holds a [SQLITE_MUTEX_RECURSIVE] mutex when it invokes
5233** the xInit method, so the xInit method need not be threadsafe. The
5234** xShutdown method is only called from [sqlite3_shutdown()] so it does
5235** not need to be threadsafe either. All other methods must be threadsafe
5236** in multithreaded applications.
5237**
5238** SQLite will never invoke xInit() more than once without an intervening
5239** call to xShutdown().
danielk1977bc2ca9e2008-11-13 14:28:28 +00005240**
5241** The xCreate() method is used to construct a new cache instance. The
5242** first parameter, szPage, is the size in bytes of the pages that must
5243** be allocated by the cache. szPage will not be a power of two. The
5244** second argument, bPurgeable, is true if the cache being created will
5245** be used to cache database pages read from a file stored on disk, or
5246** false if it is used for an in-memory database. The cache implementation
5247** does not have to do anything special based on the value of bPurgeable,
5248** it is purely advisory.
5249**
5250** The xCachesize() method may be called at any time by SQLite to set the
5251** suggested maximum cache-size (number of pages stored by) the cache
5252** instance passed as the first argument. This is the value configured using
drh21614742008-11-18 19:18:08 +00005253** the SQLite "[PRAGMA cache_size]" command. As with the bPurgeable parameter,
danielk1977bc2ca9e2008-11-13 14:28:28 +00005254** the implementation is not required to do anything special with this
5255** value, it is advisory only.
5256**
5257** The xPagecount() method should return the number of pages currently
5258** stored in the cache supplied as an argument.
5259**
5260** The xFetch() method is used to fetch a page and return a pointer to it.
5261** A 'page', in this context, is a buffer of szPage bytes aligned at an
5262** 8-byte boundary. The page to be fetched is determined by the key. The
5263** mimimum key value is 1. After it has been retrieved using xFetch, the page
5264** is considered to be pinned.
5265**
5266** If the requested page is already in the page cache, then a pointer to
5267** the cached buffer should be returned with its contents intact. If the
5268** page is not already in the cache, then the expected behaviour of the
5269** cache is determined by the value of the createFlag parameter passed
5270** to xFetch, according to the following table:
5271**
5272** <table border=1 width=85% align=center>
5273** <tr><th>createFlag<th>Expected Behaviour
5274** <tr><td>0<td>NULL should be returned. No new cache entry is created.
5275** <tr><td>1<td>If createFlag is set to 1, this indicates that
5276** SQLite is holding pinned pages that can be unpinned
5277** by writing their contents to the database file (a
5278** relatively expensive operation). In this situation the
5279** cache implementation has two choices: it can return NULL,
5280** in which case SQLite will attempt to unpin one or more
5281** pages before re-requesting the same page, or it can
5282** allocate a new page and return a pointer to it. If a new
danielk1977e1fd5082009-01-23 16:45:00 +00005283** page is allocated, then the first sizeof(void*) bytes of
5284** it (at least) must be zeroed before it is returned.
danielk1977bc2ca9e2008-11-13 14:28:28 +00005285** <tr><td>2<td>If createFlag is set to 2, then SQLite is not holding any
5286** pinned pages associated with the specific cache passed
5287** as the first argument to xFetch() that can be unpinned. The
5288** cache implementation should attempt to allocate a new
danielk1977e1fd5082009-01-23 16:45:00 +00005289** cache entry and return a pointer to it. Again, the first
5290** sizeof(void*) bytes of the page should be zeroed before
5291** it is returned. If the xFetch() method returns NULL when
5292** createFlag==2, SQLite assumes that a memory allocation
5293** failed and returns SQLITE_NOMEM to the user.
danielk1977bc2ca9e2008-11-13 14:28:28 +00005294** </table>
5295**
5296** xUnpin() is called by SQLite with a pointer to a currently pinned page
5297** as its second argument. If the third parameter, discard, is non-zero,
5298** then the page should be evicted from the cache. In this case SQLite
5299** assumes that the next time the page is retrieved from the cache using
5300** the xFetch() method, it will be zeroed. If the discard parameter is
5301** zero, then the page is considered to be unpinned. The cache implementation
5302** may choose to reclaim (free or recycle) unpinned pages at any time.
5303** SQLite assumes that next time the page is retrieved from the cache
5304** it will either be zeroed, or contain the same data that it did when it
5305** was unpinned.
5306**
5307** The cache is not required to perform any reference counting. A single
5308** call to xUnpin() unpins the page regardless of the number of prior calls
5309** to xFetch().
5310**
5311** The xRekey() method is used to change the key value associated with the
5312** page passed as the second argument from oldKey to newKey. If the cache
drhb232c232008-11-19 01:20:26 +00005313** previously contains an entry associated with newKey, it should be
5314** discarded. Any prior cache entry associated with newKey is guaranteed not
5315** to be pinned.
danielk1977bc2ca9e2008-11-13 14:28:28 +00005316**
5317** When SQLite calls the xTruncate() method, the cache must discard all
5318** existing cache entries with page numbers (keys) greater than or equal
5319** to the value of the iLimit parameter passed to xTruncate(). If any
5320** of these pages are pinned, they are implicitly unpinned, meaning that
5321** they can be safely discarded.
5322**
5323** The xDestroy() method is used to delete a cache allocated by xCreate().
5324** All resources associated with the specified cache should be freed. After
drh21614742008-11-18 19:18:08 +00005325** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*]
danielk1977bc2ca9e2008-11-13 14:28:28 +00005326** handle invalid, and will not use it with any other sqlite3_pcache_methods
5327** functions.
5328*/
5329typedef struct sqlite3_pcache_methods sqlite3_pcache_methods;
5330struct sqlite3_pcache_methods {
5331 void *pArg;
5332 int (*xInit)(void*);
5333 void (*xShutdown)(void*);
5334 sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable);
5335 void (*xCachesize)(sqlite3_pcache*, int nCachesize);
5336 int (*xPagecount)(sqlite3_pcache*);
5337 void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
5338 void (*xUnpin)(sqlite3_pcache*, void*, int discard);
5339 void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey);
5340 void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);
5341 void (*xDestroy)(sqlite3_pcache*);
5342};
5343
5344/*
drh27b3b842009-02-03 18:25:13 +00005345** CAPI3REF: Online Backup Object
5346** EXPERIMENTAL
5347**
5348** The sqlite3_backup object records state information about an ongoing
5349** online backup operation. The sqlite3_backup object is created by
5350** a call to [sqlite3_backup_init()] and is destroyed by a call to
5351** [sqlite3_backup_finish()].
drh52224a72009-02-10 13:41:42 +00005352**
5353** See Also: [Using the SQLite Online Backup API]
drh27b3b842009-02-03 18:25:13 +00005354*/
5355typedef struct sqlite3_backup sqlite3_backup;
5356
5357/*
danielk197704103022009-02-03 16:51:24 +00005358** CAPI3REF: Online Backup API.
5359** EXPERIMENTAL
5360**
5361** This API is used to overwrite the contents of one database with that
5362** of another. It is useful either for creating backups of databases or
5363** for copying in-memory databases to or from persistent files.
5364**
drh52224a72009-02-10 13:41:42 +00005365** See Also: [Using the SQLite Online Backup API]
5366**
danielk197704103022009-02-03 16:51:24 +00005367** Exclusive access is required to the destination database for the
5368** duration of the operation. However the source database is only
5369** read-locked while it is actually being read, it is not locked
5370** continuously for the entire operation. Thus, the backup may be
5371** performed on a live database without preventing other users from
5372** writing to the database for an extended period of time.
5373**
5374** To perform a backup operation:
5375** <ol>
drh62b5d2d2009-02-03 18:47:22 +00005376** <li><b>sqlite3_backup_init()</b> is called once to initialize the
5377** backup,
5378** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer
danielk197704103022009-02-03 16:51:24 +00005379** the data between the two databases, and finally
drh62b5d2d2009-02-03 18:47:22 +00005380** <li><b>sqlite3_backup_finish()</b> is called to release all resources
danielk197704103022009-02-03 16:51:24 +00005381** associated with the backup operation.
5382** </ol>
5383** There should be exactly one call to sqlite3_backup_finish() for each
5384** successful call to sqlite3_backup_init().
5385**
5386** <b>sqlite3_backup_init()</b>
5387**
5388** The first two arguments passed to [sqlite3_backup_init()] are the database
5389** handle associated with the destination database and the database name
5390** used to attach the destination database to the handle. The database name
5391** is "main" for the main database, "temp" for the temporary database, or
drh62b5d2d2009-02-03 18:47:22 +00005392** the name specified as part of the [ATTACH] statement if the destination is
danielk197704103022009-02-03 16:51:24 +00005393** an attached database. The third and fourth arguments passed to
drh62b5d2d2009-02-03 18:47:22 +00005394** sqlite3_backup_init() identify the [database connection]
5395** and database name used
danielk197704103022009-02-03 16:51:24 +00005396** to access the source database. The values passed for the source and
drh62b5d2d2009-02-03 18:47:22 +00005397** destination [database connection] parameters must not be the same.
danielk197704103022009-02-03 16:51:24 +00005398**
5399** If an error occurs within sqlite3_backup_init(), then NULL is returned
drh62b5d2d2009-02-03 18:47:22 +00005400** and an error code and error message written into the [database connection]
danielk197704103022009-02-03 16:51:24 +00005401** passed as the first argument. They may be retrieved using the
drh62b5d2d2009-02-03 18:47:22 +00005402** [sqlite3_errcode()], [sqlite3_errmsg()], and [sqlite3_errmsg16()] functions.
drh27b3b842009-02-03 18:25:13 +00005403** Otherwise, if successful, a pointer to an [sqlite3_backup] object is
5404** returned. This pointer may be used with the sqlite3_backup_step() and
danielk197704103022009-02-03 16:51:24 +00005405** sqlite3_backup_finish() functions to perform the specified backup
5406** operation.
5407**
5408** <b>sqlite3_backup_step()</b>
5409**
5410** Function [sqlite3_backup_step()] is used to copy up to nPage pages between
5411** the source and destination databases, where nPage is the value of the
danielk197703ab0352009-02-06 05:59:44 +00005412** second parameter passed to sqlite3_backup_step(). If nPage is a negative
5413** value, all remaining source pages are copied. If the required pages are
danielk197704103022009-02-03 16:51:24 +00005414** succesfully copied, but there are still more pages to copy before the
drh62b5d2d2009-02-03 18:47:22 +00005415** backup is complete, it returns [SQLITE_OK]. If no error occured and there
5416** are no more pages to copy, then [SQLITE_DONE] is returned. If an error
5417** occurs, then an SQLite error code is returned. As well as [SQLITE_OK] and
5418** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY],
5419** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an
5420** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code.
danielk197704103022009-02-03 16:51:24 +00005421**
5422** As well as the case where the destination database file was opened for
drh62b5d2d2009-02-03 18:47:22 +00005423** read-only access, sqlite3_backup_step() may return [SQLITE_READONLY] if
danielk197704103022009-02-03 16:51:24 +00005424** the destination is an in-memory database with a different page size
5425** from the source database.
5426**
5427** If sqlite3_backup_step() cannot obtain a required file-system lock, then
drh62b5d2d2009-02-03 18:47:22 +00005428** the [sqlite3_busy_handler | busy-handler function]
5429** is invoked (if one is specified). If the
danielk197704103022009-02-03 16:51:24 +00005430** busy-handler returns non-zero before the lock is available, then
drh62b5d2d2009-02-03 18:47:22 +00005431** [SQLITE_BUSY] is returned to the caller. In this case the call to
5432** sqlite3_backup_step() can be retried later. If the source
5433** [database connection]
danielk197704103022009-02-03 16:51:24 +00005434** is being used to write to the source database when sqlite3_backup_step()
drh62b5d2d2009-02-03 18:47:22 +00005435** is called, then [SQLITE_LOCKED] is returned immediately. Again, in this
danielk197704103022009-02-03 16:51:24 +00005436** case the call to sqlite3_backup_step() can be retried later on. If
drh62b5d2d2009-02-03 18:47:22 +00005437** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or
5438** [SQLITE_READONLY] is returned, then
danielk197704103022009-02-03 16:51:24 +00005439** there is no point in retrying the call to sqlite3_backup_step(). These
5440** errors are considered fatal. At this point the application must accept
5441** that the backup operation has failed and pass the backup operation handle
5442** to the sqlite3_backup_finish() to release associated resources.
5443**
5444** Following the first call to sqlite3_backup_step(), an exclusive lock is
5445** obtained on the destination file. It is not released until either
5446** sqlite3_backup_finish() is called or the backup operation is complete
drh62b5d2d2009-02-03 18:47:22 +00005447** and sqlite3_backup_step() returns [SQLITE_DONE]. Additionally, each time
5448** a call to sqlite3_backup_step() is made a [shared lock] is obtained on
danielk197704103022009-02-03 16:51:24 +00005449** the source database file. This lock is released before the
5450** sqlite3_backup_step() call returns. Because the source database is not
5451** locked between calls to sqlite3_backup_step(), it may be modified mid-way
5452** through the backup procedure. If the source database is modified by an
5453** external process or via a database connection other than the one being
5454** used by the backup operation, then the backup will be transparently
5455** restarted by the next call to sqlite3_backup_step(). If the source
5456** database is modified by the using the same database connection as is used
5457** by the backup operation, then the backup database is transparently
5458** updated at the same time.
5459**
5460** <b>sqlite3_backup_finish()</b>
5461**
drh62b5d2d2009-02-03 18:47:22 +00005462** Once sqlite3_backup_step() has returned [SQLITE_DONE], or when the
drh27b3b842009-02-03 18:25:13 +00005463** application wishes to abandon the backup operation, the [sqlite3_backup]
5464** object should be passed to sqlite3_backup_finish(). This releases all
danielk197704103022009-02-03 16:51:24 +00005465** resources associated with the backup operation. If sqlite3_backup_step()
drh62b5d2d2009-02-03 18:47:22 +00005466** has not yet returned [SQLITE_DONE], then any active write-transaction on the
drh27b3b842009-02-03 18:25:13 +00005467** destination database is rolled back. The [sqlite3_backup] object is invalid
danielk197704103022009-02-03 16:51:24 +00005468** and may not be used following a call to sqlite3_backup_finish().
5469**
drh62b5d2d2009-02-03 18:47:22 +00005470** The value returned by sqlite3_backup_finish is [SQLITE_OK] if no error
5471** occurred, regardless or whether or not sqlite3_backup_step() was called
danielk197704103022009-02-03 16:51:24 +00005472** a sufficient number of times to complete the backup operation. Or, if
5473** an out-of-memory condition or IO error occured during a call to
drh62b5d2d2009-02-03 18:47:22 +00005474** sqlite3_backup_step() then [SQLITE_NOMEM] or an
5475** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] error code
danielk197704103022009-02-03 16:51:24 +00005476** is returned. In this case the error code and an error message are
drh62b5d2d2009-02-03 18:47:22 +00005477** written to the destination [database connection].
danielk197704103022009-02-03 16:51:24 +00005478**
drh62b5d2d2009-02-03 18:47:22 +00005479** A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step() is
5480** not a permanent error and does not affect the return value of
danielk197704103022009-02-03 16:51:24 +00005481** sqlite3_backup_finish().
5482**
5483** <b>sqlite3_backup_remaining(), sqlite3_backup_pagecount()</b>
5484**
5485** Each call to sqlite3_backup_step() sets two values stored internally
drh27b3b842009-02-03 18:25:13 +00005486** by an [sqlite3_backup] object. The number of pages still to be backed
danielk197704103022009-02-03 16:51:24 +00005487** up, which may be queried by sqlite3_backup_remaining(), and the total
5488** number of pages in the source database file, which may be queried by
5489** sqlite3_backup_pagecount().
5490**
5491** The values returned by these functions are only updated by
5492** sqlite3_backup_step(). If the source database is modified during a backup
5493** operation, then the values are not updated to account for any extra
5494** pages that need to be updated or the size of the source database file
5495** changing.
5496**
5497** <b>Concurrent Usage of Database Handles</b>
5498**
drh62b5d2d2009-02-03 18:47:22 +00005499** The source [database connection] may be used by the application for other
danielk197704103022009-02-03 16:51:24 +00005500** purposes while a backup operation is underway or being initialized.
5501** If SQLite is compiled and configured to support threadsafe database
5502** connections, then the source database connection may be used concurrently
5503** from within other threads.
5504**
5505** However, the application must guarantee that the destination database
5506** connection handle is not passed to any other API (by any thread) after
5507** sqlite3_backup_init() is called and before the corresponding call to
5508** sqlite3_backup_finish(). Unfortunately SQLite does not currently check
drh62b5d2d2009-02-03 18:47:22 +00005509** for this, if the application does use the destination [database connection]
danielk197704103022009-02-03 16:51:24 +00005510** for some other purpose during a backup operation, things may appear to
drh662c58c2009-02-03 21:13:07 +00005511** work correctly but in fact be subtly malfunctioning. Use of the
5512** destination database connection while a backup is in progress might
5513** also cause a mutex deadlock.
danielk197704103022009-02-03 16:51:24 +00005514**
drh62b5d2d2009-02-03 18:47:22 +00005515** Furthermore, if running in [shared cache mode], the application must
danielk197704103022009-02-03 16:51:24 +00005516** guarantee that the shared cache used by the destination database
5517** is not accessed while the backup is running. In practice this means
5518** that the application must guarantee that the file-system file being
5519** backed up to is not accessed by any connection within the process,
5520** not just the specific connection that was passed to sqlite3_backup_init().
5521**
drh27b3b842009-02-03 18:25:13 +00005522** The [sqlite3_backup] object itself is partially threadsafe. Multiple
danielk197704103022009-02-03 16:51:24 +00005523** threads may safely make multiple concurrent calls to sqlite3_backup_step().
5524** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount()
5525** APIs are not strictly speaking threadsafe. If they are invoked at the
5526** same time as another thread is invoking sqlite3_backup_step() it is
5527** possible that they return invalid values.
5528*/
danielk197704103022009-02-03 16:51:24 +00005529sqlite3_backup *sqlite3_backup_init(
5530 sqlite3 *pDest, /* Destination database handle */
5531 const char *zDestName, /* Destination database name */
5532 sqlite3 *pSource, /* Source database handle */
5533 const char *zSourceName /* Source database name */
5534);
5535int sqlite3_backup_step(sqlite3_backup *p, int nPage);
5536int sqlite3_backup_finish(sqlite3_backup *p);
5537int sqlite3_backup_remaining(sqlite3_backup *p);
5538int sqlite3_backup_pagecount(sqlite3_backup *p);
5539
5540/*
danielk1977404ca072009-03-16 13:19:36 +00005541** CAPI3REF: Unlock Notification
5542** EXPERIMENTAL
5543**
5544** When running in shared-cache mode, a database operation may fail with
drh89487472009-03-16 13:37:02 +00005545** an [SQLITE_LOCKED] error if the required locks on the shared-cache or
danielk1977404ca072009-03-16 13:19:36 +00005546** individual tables within the shared-cache cannot be obtained. See
5547** [SQLite Shared-Cache Mode] for a description of shared-cache locking.
5548** This API may be used to register a callback that SQLite will invoke
5549** when the connection currently holding the required lock relinquishes it.
5550** This API is only available if the library was compiled with the
drh89487472009-03-16 13:37:02 +00005551** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined.
danielk1977404ca072009-03-16 13:19:36 +00005552**
5553** See Also: [Using the SQLite Unlock Notification Feature].
5554**
5555** Shared-cache locks are released when a database connection concludes
5556** its current transaction, either by committing it or rolling it back.
5557**
5558** When a connection (known as the blocked connection) fails to obtain a
5559** shared-cache lock and SQLITE_LOCKED is returned to the caller, the
5560** identity of the database connection (the blocking connection) that
5561** has locked the required resource is stored internally. After an
5562** application receives an SQLITE_LOCKED error, it may call the
5563** sqlite3_unlock_notify() method with the blocked connection handle as
5564** the first argument to register for a callback that will be invoked
5565** when the blocking connections current transaction is concluded. The
5566** callback is invoked from within the [sqlite3_step] or [sqlite3_close]
5567** call that concludes the blocking connections transaction.
5568**
5569** If sqlite3_unlock_notify() is called in a multi-threaded application,
5570** there is a chance that the blocking connection will have already
5571** concluded its transaction by the time sqlite3_unlock_notify() is invoked.
5572** If this happens, then the specified callback is invoked immediately,
5573** from within the call to sqlite3_unlock_notify().
5574**
5575** If the blocked connection is attempting to obtain a write-lock on a
5576** shared-cache table, and more than one other connection currently holds
5577** a read-lock on the same table, then SQLite arbitrarily selects one of
5578** the other connections to use as the blocking connection.
5579**
5580** There may be at most one unlock-notify callback registered by a
5581** blocked connection. If sqlite3_unlock_notify() is called when the
5582** blocked connection already has a registered unlock-notify callback,
5583** then the new callback replaces the old. If sqlite3_unlock_notify() is
5584** called with a NULL pointer as its second argument, then any existing
5585** unlock-notify callback is cancelled. The blocked connections
5586** unlock-notify callback may also be canceled by closing the blocked
5587** connection using [sqlite3_close()].
5588**
5589** The unlock-notify callback is not reentrant. If an application invokes
5590** any sqlite3_xxx API functions from within an unlock-notify callback, a
5591** crash or deadlock may be the result.
5592**
5593** Unless deadlock is detected (see below), sqlite3_unlock_notify() always
5594** returns SQLITE_OK.
5595**
5596** <b>Callback Invocation Details</b>
5597**
5598** When an unlock-notify callback is registered, the application provides a
5599** single void* pointer that is passed to the callback when it is invoked.
5600** However, the signature of the callback function allows SQLite to pass
5601** it an array of void* context pointers. The first argument passed to
5602** an unlock-notify callback is a pointer to an array of void* pointers,
5603** and the second is the number of entries in the array.
5604**
5605** When a blocking connections transaction is concluded, there may be
5606** more than one blocked connection that has registered for an unlock-notify
5607** callback. If two or more such blocked connections have specified the
5608** same callback function, then instead of invoking the callback function
5609** multiple times, it is invoked once with the set of void* context pointers
5610** specified by the blocked connections bundled together into an array.
5611** This gives the application an opportunity to prioritize any actions
5612** related to the set of unblocked database connections.
5613**
5614** <b>Deadlock Detection</b>
5615**
5616** Assuming that after registering for an unlock-notify callback a
5617** database waits for the callback to be issued before taking any further
5618** action (a reasonable assumption), then using this API may cause the
5619** application to deadlock. For example, if connection X is waiting for
5620** connection Y's transaction to be concluded, and similarly connection
5621** Y is waiting on connection X's transaction, then neither connection
5622** will proceed and the system may remain deadlocked indefinitely.
5623**
5624** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock
5625** detection. If a given call to sqlite3_unlock_notify() would put the
5626** system in a deadlocked state, then SQLITE_LOCKED is returned and no
5627** unlock-notify callback is registered. The system is said to be in
5628** a deadlocked state if connection A has registered for an unlock-notify
5629** callback on the conclusion of connection B's transaction, and connection
5630** B has itself registered for an unlock-notify callback when connection
5631** A's transaction is concluded. Indirect deadlock is also detected, so
5632** the system is also considered to be deadlocked if connection B has
5633** registered for an unlock-notify callback on the conclusion of connection
5634** C's transaction, where connection C is waiting on connection A. Any
5635** number of levels of indirection are allowed.
5636**
5637** <b>The "DROP TABLE" Exception</b>
5638**
5639** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost
5640** always appropriate to call sqlite3_unlock_notify(). There is however,
5641** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement,
5642** SQLite checks if there are any currently executing SELECT statements
5643** that belong to the same connection. If there are, SQLITE_LOCKED is
5644** returned. In this case there is no "blocking connection", so invoking
5645** sqlite3_unlock_notify() results in the unlock-notify callback being
5646** invoked immediately. If the application then re-attempts the "DROP TABLE"
5647** or "DROP INDEX" query, an infinite loop might be the result.
5648**
5649** One way around this problem is to check the extended error code returned
5650** by an sqlite3_step() call. If there is a blocking connection, then the
5651** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in
5652** the special "DROP TABLE/INDEX" case, the extended error code is just
5653** SQLITE_LOCKED.
5654*/
5655int sqlite3_unlock_notify(
5656 sqlite3 *pBlocked, /* Waiting connection */
5657 void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */
5658 void *pNotifyArg /* Argument to pass to xNotify */
5659);
5660
danielk1977ee0484c2009-07-28 16:44:26 +00005661
5662/*
5663** CAPI3REF: String Comparison
5664** EXPERIMENTAL
5665**
5666** The [sqlite3_strnicmp()] API allows applications and extensions to
5667** compare the contents of two buffers containing UTF-8 strings in a
5668** case-indendent fashion, using the same definition of case independence
5669** that SQLite uses internally when comparing identifiers.
5670*/
5671int sqlite3_strnicmp(const char *, const char *, int);
5672
danielk1977404ca072009-03-16 13:19:36 +00005673/*
drhb37df7b2005-10-13 02:09:49 +00005674** Undo the hack that converts floating point types to integer for
5675** builds on processors without floating point support.
5676*/
5677#ifdef SQLITE_OMIT_FLOATING_POINT
5678# undef double
5679#endif
5680
drh382c0242001-10-06 16:33:02 +00005681#ifdef __cplusplus
5682} /* End of the 'extern "C"' block */
5683#endif
danielk19774adee202004-05-08 08:23:19 +00005684#endif