blob: 7212cf66d67b245c7d945f6ca4e586e9b0fc0803 [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**
drh6aa5f152009-08-19 15:57:07 +000096** The SQLITE_VERSION_NUMBER is an integer that is computed as
97** follows:
98**
99** <blockquote><pre>
100** SQLITE_VERSION_NUMBER = X*1000000 + Y*1000 + Z
101** </pre></blockquote>
102**
drh47baebc2009-08-14 16:01:24 +0000103** Since version 3.6.18, SQLite source code has been stored in the
drh6aa5f152009-08-19 15:57:07 +0000104** <a href="http://www.fossil-scm.org/">fossil configuration management
105** system</a>. The SQLITE_SOURCE_ID
drh47baebc2009-08-14 16:01:24 +0000106** macro is a string which identifies a particular check-in of SQLite
107** within its configuration management system. The string contains the
108** date and time of the check-in (UTC) and an SHA1 hash of the entire
109** source tree.
110**
drh6aa5f152009-08-19 15:57:07 +0000111** See also: [sqlite3_libversion()],
112** [sqlite3_libversion_number()], and [sqlite3_sourceid()].
drh33c1be32008-01-30 16:16:14 +0000113**
drh8b39db12009-02-18 18:37:58 +0000114** Requirements: [H10011] [H10014]
danielk197799ba19e2005-02-05 07:33:34 +0000115*/
drh47baebc2009-08-14 16:01:24 +0000116#define SQLITE_VERSION "--VERS--"
117#define SQLITE_VERSION_NUMBER --VERSION-NUMBER--
118#define SQLITE_SOURCE_ID "--SOURCE-ID--"
drhb86ccfb2003-01-28 23:13:10 +0000119
120/*
drh9a247912008-07-22 18:45:08 +0000121** CAPI3REF: Run-Time Library Version Numbers {H10020} <S60100>
drh33c1be32008-01-30 16:16:14 +0000122** KEYWORDS: sqlite3_version
drh6ed48bf2007-06-14 20:57:18 +0000123**
drh47baebc2009-08-14 16:01:24 +0000124** These interfaces provide the same information as the [SQLITE_VERSION],
125** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] #defines in the header,
126** but are associated with the library instead of the header file. Cautious
drh6aa5f152009-08-19 15:57:07 +0000127** programmers might include an assert in their application to verify that
mihailim362cc832008-06-21 06:16:42 +0000128** sqlite3_libversion_number() always returns the value
drh6aa5f152009-08-19 15:57:07 +0000129** [SQLITE_VERSION_NUMBER] and thus insure that the application is
130** compiled with matching library and header files.
131**
132** <blockquote><pre>
133** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER );
134** </pre></blockquote>
drh6ed48bf2007-06-14 20:57:18 +0000135**
drh33c1be32008-01-30 16:16:14 +0000136** The sqlite3_libversion() function returns the same information as is
137** in the sqlite3_version[] string constant. The function is provided
138** for use in DLLs since DLL users usually do not have direct access to string
drh47baebc2009-08-14 16:01:24 +0000139** constants within the DLL. Similarly, the sqlite3_sourceid() function
140** returns the same information as is in the [SQLITE_SOURCE_ID] #define of
141** the header file.
drh33c1be32008-01-30 16:16:14 +0000142**
drh8b39db12009-02-18 18:37:58 +0000143** Requirements: [H10021] [H10022] [H10023]
drhb217a572000-08-22 13:40:18 +0000144*/
drh73be5012007-08-08 12:11:21 +0000145SQLITE_EXTERN const char sqlite3_version[];
drha3f70cb2004-09-30 14:24:50 +0000146const char *sqlite3_libversion(void);
drh47baebc2009-08-14 16:01:24 +0000147const char *sqlite3_sourceid(void);
danielk197799ba19e2005-02-05 07:33:34 +0000148int sqlite3_libversion_number(void);
149
150/*
drh9a247912008-07-22 18:45:08 +0000151** CAPI3REF: Test To See If The Library Is Threadsafe {H10100} <S60100>
drhb67e8bf2007-08-30 20:09:48 +0000152**
drh33c1be32008-01-30 16:16:14 +0000153** SQLite can be compiled with or without mutexes. When
drh6aa5f152009-08-19 15:57:07 +0000154** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes
drhafacce02008-09-02 21:35:03 +0000155** are enabled and SQLite is threadsafe. When the
156** [SQLITE_THREADSAFE] macro is 0,
drh33c1be32008-01-30 16:16:14 +0000157** the mutexes are omitted. Without the mutexes, it is not safe
mihailim362cc832008-06-21 06:16:42 +0000158** to use SQLite concurrently from more than one thread.
drhb67e8bf2007-08-30 20:09:48 +0000159**
mihailim362cc832008-06-21 06:16:42 +0000160** Enabling mutexes incurs a measurable performance penalty.
drh33c1be32008-01-30 16:16:14 +0000161** So if speed is of utmost importance, it makes sense to disable
162** the mutexes. But for maximum safety, mutexes should be enabled.
163** The default behavior is for mutexes to be enabled.
164**
drh6aa5f152009-08-19 15:57:07 +0000165** This interface can be used by an application to make sure that the
drh33c1be32008-01-30 16:16:14 +0000166** version of SQLite that it is linking against was compiled with
drh4766b292008-06-26 02:53:02 +0000167** the desired setting of the [SQLITE_THREADSAFE] macro.
168**
169** This interface only reports on the compile-time mutex setting
170** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with
171** SQLITE_THREADSAFE=1 then mutexes are enabled by default but
172** can be fully or partially disabled using a call to [sqlite3_config()]
173** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD],
174** or [SQLITE_CONFIG_MUTEX]. The return value of this function shows
175** only the default compile-time setting, not any run-time changes
176** to that setting.
drh33c1be32008-01-30 16:16:14 +0000177**
drhafacce02008-09-02 21:35:03 +0000178** See the [threading mode] documentation for additional information.
179**
drh8b39db12009-02-18 18:37:58 +0000180** Requirements: [H10101] [H10102]
drhb67e8bf2007-08-30 20:09:48 +0000181*/
182int sqlite3_threadsafe(void);
183
184/*
drh9cd29642008-07-23 00:52:55 +0000185** CAPI3REF: Database Connection Handle {H12000} <S40200>
drha06f17f2008-05-11 11:07:06 +0000186** KEYWORDS: {database connection} {database connections}
drh6ed48bf2007-06-14 20:57:18 +0000187**
mihailim362cc832008-06-21 06:16:42 +0000188** Each open SQLite database is represented by a pointer to an instance of
189** the opaque structure named "sqlite3". It is useful to think of an sqlite3
drh8bacf972007-08-25 16:21:29 +0000190** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and
mihailim362cc832008-06-21 06:16:42 +0000191** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()]
192** is its destructor. There are many other interfaces (such as
193** [sqlite3_prepare_v2()], [sqlite3_create_function()], and
194** [sqlite3_busy_timeout()] to name but three) that are methods on an
195** sqlite3 object.
drh75897232000-05-29 14:26:00 +0000196*/
drh9bb575f2004-09-06 17:24:11 +0000197typedef struct sqlite3 sqlite3;
danielk197765904932004-05-26 06:18:37 +0000198
drh75897232000-05-29 14:26:00 +0000199/*
drh9cd29642008-07-23 00:52:55 +0000200** CAPI3REF: 64-Bit Integer Types {H10200} <S10110>
drh33c1be32008-01-30 16:16:14 +0000201** KEYWORDS: sqlite_int64 sqlite_uint64
drh6ed48bf2007-06-14 20:57:18 +0000202**
drh33c1be32008-01-30 16:16:14 +0000203** Because there is no cross-platform way to specify 64-bit integer types
drhfddfa2d2007-12-05 18:05:16 +0000204** SQLite includes typedefs for 64-bit signed and unsigned integers.
drh6ed48bf2007-06-14 20:57:18 +0000205**
mihailim362cc832008-06-21 06:16:42 +0000206** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions.
207** The sqlite_int64 and sqlite_uint64 types are supported for backwards
208** compatibility only.
drh33c1be32008-01-30 16:16:14 +0000209**
drh8b39db12009-02-18 18:37:58 +0000210** Requirements: [H10201] [H10202]
drhefad9992004-06-22 12:13:55 +0000211*/
drh27436af2006-03-28 23:57:17 +0000212#ifdef SQLITE_INT64_TYPE
drh9b8f4472006-04-04 01:54:55 +0000213 typedef SQLITE_INT64_TYPE sqlite_int64;
drh27436af2006-03-28 23:57:17 +0000214 typedef unsigned SQLITE_INT64_TYPE sqlite_uint64;
215#elif defined(_MSC_VER) || defined(__BORLANDC__)
drhefad9992004-06-22 12:13:55 +0000216 typedef __int64 sqlite_int64;
drh1211de32004-07-26 12:24:22 +0000217 typedef unsigned __int64 sqlite_uint64;
drhefad9992004-06-22 12:13:55 +0000218#else
219 typedef long long int sqlite_int64;
drh1211de32004-07-26 12:24:22 +0000220 typedef unsigned long long int sqlite_uint64;
drhefad9992004-06-22 12:13:55 +0000221#endif
drh6d2069d2007-08-14 01:58:53 +0000222typedef sqlite_int64 sqlite3_int64;
223typedef sqlite_uint64 sqlite3_uint64;
drhefad9992004-06-22 12:13:55 +0000224
drhb37df7b2005-10-13 02:09:49 +0000225/*
226** If compiling for a processor that lacks floating point support,
mihailim362cc832008-06-21 06:16:42 +0000227** substitute integer for floating-point.
drhb37df7b2005-10-13 02:09:49 +0000228*/
229#ifdef SQLITE_OMIT_FLOATING_POINT
drh6d2069d2007-08-14 01:58:53 +0000230# define double sqlite3_int64
drhb37df7b2005-10-13 02:09:49 +0000231#endif
drhefad9992004-06-22 12:13:55 +0000232
233/*
drh9cd29642008-07-23 00:52:55 +0000234** CAPI3REF: Closing A Database Connection {H12010} <S30100><S40200>
drh75897232000-05-29 14:26:00 +0000235**
mihailim362cc832008-06-21 06:16:42 +0000236** This routine is the destructor for the [sqlite3] object.
drh33c1be32008-01-30 16:16:14 +0000237**
mihailim362cc832008-06-21 06:16:42 +0000238** Applications should [sqlite3_finalize | finalize] all [prepared statements]
mihailim15194222008-06-22 09:55:14 +0000239** and [sqlite3_blob_close | close] all [BLOB handles] associated with
mihailim362cc832008-06-21 06:16:42 +0000240** the [sqlite3] object prior to attempting to close the object.
241** The [sqlite3_next_stmt()] interface can be used to locate all
242** [prepared statements] associated with a [database connection] if desired.
243** Typical code might look like this:
drh33c1be32008-01-30 16:16:14 +0000244**
drh55b0cf02008-06-19 17:54:33 +0000245** <blockquote><pre>
246** sqlite3_stmt *pStmt;
247** while( (pStmt = sqlite3_next_stmt(db, 0))!=0 ){
248** &nbsp; sqlite3_finalize(pStmt);
249** }
250** </pre></blockquote>
251**
mihailim362cc832008-06-21 06:16:42 +0000252** If [sqlite3_close()] is invoked while a transaction is open,
drh55b0cf02008-06-19 17:54:33 +0000253** the transaction is automatically rolled back.
drh33c1be32008-01-30 16:16:14 +0000254**
drh8b39db12009-02-18 18:37:58 +0000255** The C parameter to [sqlite3_close(C)] must be either a NULL
256** pointer or an [sqlite3] object pointer obtained
257** from [sqlite3_open()], [sqlite3_open16()], or
258** [sqlite3_open_v2()], and not previously closed.
drh33c1be32008-01-30 16:16:14 +0000259**
drh8b39db12009-02-18 18:37:58 +0000260** Requirements:
261** [H12011] [H12012] [H12013] [H12014] [H12015] [H12019]
drh75897232000-05-29 14:26:00 +0000262*/
danielk1977f9d64d22004-06-19 08:18:07 +0000263int sqlite3_close(sqlite3 *);
drh75897232000-05-29 14:26:00 +0000264
265/*
266** The type for a callback function.
drh6ed48bf2007-06-14 20:57:18 +0000267** This is legacy and deprecated. It is included for historical
268** compatibility and is not documented.
drh75897232000-05-29 14:26:00 +0000269*/
drh12057d52004-09-06 17:34:12 +0000270typedef int (*sqlite3_callback)(void*,int,char**, char**);
drh75897232000-05-29 14:26:00 +0000271
272/*
drh9cd29642008-07-23 00:52:55 +0000273** CAPI3REF: One-Step Query Execution Interface {H12100} <S10000>
drh6ed48bf2007-06-14 20:57:18 +0000274**
mihailim362cc832008-06-21 06:16:42 +0000275** The sqlite3_exec() interface is a convenient way of running one or more
276** SQL statements without having to write a lot of C code. The UTF-8 encoded
277** SQL statements are passed in as the second parameter to sqlite3_exec().
278** The statements are evaluated one by one until either an error or
279** an interrupt is encountered, or until they are all done. The 3rd parameter
280** is an optional callback that is invoked once for each row of any query
281** results produced by the SQL statements. The 5th parameter tells where
drh33c1be32008-01-30 16:16:14 +0000282** to write any error messages.
drh75897232000-05-29 14:26:00 +0000283**
drh35c61902008-05-20 15:44:30 +0000284** The error message passed back through the 5th parameter is held
285** in memory obtained from [sqlite3_malloc()]. To avoid a memory leak,
286** the calling application should call [sqlite3_free()] on any error
287** message returned through the 5th parameter when it has finished using
288** the error message.
289**
290** If the SQL statement in the 2nd parameter is NULL or an empty string
mihailim362cc832008-06-21 06:16:42 +0000291** or a string containing only whitespace and comments, then no SQL
292** statements are evaluated and the database is not changed.
drh35c61902008-05-20 15:44:30 +0000293**
drh33c1be32008-01-30 16:16:14 +0000294** The sqlite3_exec() interface is implemented in terms of
295** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()].
drh35c61902008-05-20 15:44:30 +0000296** The sqlite3_exec() routine does nothing to the database that cannot be done
drh33c1be32008-01-30 16:16:14 +0000297** by [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()].
drh75897232000-05-29 14:26:00 +0000298**
drh8b39db12009-02-18 18:37:58 +0000299** The first parameter to [sqlite3_exec()] must be an valid and open
300** [database connection].
mihailima3f64902008-06-21 13:35:56 +0000301**
drh8b39db12009-02-18 18:37:58 +0000302** The database connection must not be closed while
303** [sqlite3_exec()] is running.
drh75897232000-05-29 14:26:00 +0000304**
drh8b39db12009-02-18 18:37:58 +0000305** The calling function should use [sqlite3_free()] to free
306** the memory that *errmsg is left pointing at once the error
307** message is no longer needed.
drh75897232000-05-29 14:26:00 +0000308**
drh8b39db12009-02-18 18:37:58 +0000309** The SQL statement text in the 2nd parameter to [sqlite3_exec()]
310** must remain unchanged while [sqlite3_exec()] is running.
drhf50bebf2008-05-19 23:51:55 +0000311**
drh8b39db12009-02-18 18:37:58 +0000312** Requirements:
313** [H12101] [H12102] [H12104] [H12105] [H12107] [H12110] [H12113] [H12116]
314** [H12119] [H12122] [H12125] [H12131] [H12134] [H12137] [H12138]
drh75897232000-05-29 14:26:00 +0000315*/
danielk19776f8a5032004-05-10 10:34:51 +0000316int sqlite3_exec(
drh6ed48bf2007-06-14 20:57:18 +0000317 sqlite3*, /* An open database */
shane236ce972008-05-30 15:35:30 +0000318 const char *sql, /* SQL to be evaluated */
drh6ed48bf2007-06-14 20:57:18 +0000319 int (*callback)(void*,int,char**,char**), /* Callback function */
320 void *, /* 1st argument to callback */
321 char **errmsg /* Error msg written here */
drh75897232000-05-29 14:26:00 +0000322);
323
drh58b95762000-06-02 01:17:37 +0000324/*
drhb25f9d82008-07-23 15:40:06 +0000325** CAPI3REF: Result Codes {H10210} <S10700>
drh33c1be32008-01-30 16:16:14 +0000326** KEYWORDS: SQLITE_OK {error code} {error codes}
mihailimefc8e8a2008-06-21 16:47:09 +0000327** KEYWORDS: {result code} {result codes}
drh6ed48bf2007-06-14 20:57:18 +0000328**
329** Many SQLite functions return an integer result code from the set shown
drh33c1be32008-01-30 16:16:14 +0000330** here in order to indicates success or failure.
drh6ed48bf2007-06-14 20:57:18 +0000331**
drh4766b292008-06-26 02:53:02 +0000332** New error codes may be added in future versions of SQLite.
333**
drh6ed48bf2007-06-14 20:57:18 +0000334** See also: [SQLITE_IOERR_READ | extended result codes]
drh58b95762000-06-02 01:17:37 +0000335*/
drh717e6402001-09-27 03:22:32 +0000336#define SQLITE_OK 0 /* Successful result */
drh15b9a152006-01-31 20:49:13 +0000337/* beginning-of-error-codes */
drh717e6402001-09-27 03:22:32 +0000338#define SQLITE_ERROR 1 /* SQL error or missing database */
drh89e0dde2007-12-12 12:25:21 +0000339#define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */
drh717e6402001-09-27 03:22:32 +0000340#define SQLITE_PERM 3 /* Access permission denied */
341#define SQLITE_ABORT 4 /* Callback routine requested an abort */
342#define SQLITE_BUSY 5 /* The database file is locked */
343#define SQLITE_LOCKED 6 /* A table in the database is locked */
344#define SQLITE_NOMEM 7 /* A malloc() failed */
345#define SQLITE_READONLY 8 /* Attempt to write a readonly database */
drh24cd67e2004-05-10 16:18:47 +0000346#define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/
drh717e6402001-09-27 03:22:32 +0000347#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */
348#define SQLITE_CORRUPT 11 /* The database disk image is malformed */
drh2db0bbc2005-08-11 02:10:18 +0000349#define SQLITE_NOTFOUND 12 /* NOT USED. Table or record not found */
drh717e6402001-09-27 03:22:32 +0000350#define SQLITE_FULL 13 /* Insertion failed because database is full */
351#define SQLITE_CANTOPEN 14 /* Unable to open the database file */
drh4f0ee682007-03-30 20:43:40 +0000352#define SQLITE_PROTOCOL 15 /* NOT USED. Database lock protocol error */
drh24cd67e2004-05-10 16:18:47 +0000353#define SQLITE_EMPTY 16 /* Database is empty */
drh717e6402001-09-27 03:22:32 +0000354#define SQLITE_SCHEMA 17 /* The database schema changed */
drhc797d4d2007-05-08 01:08:49 +0000355#define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */
danielk19776eb91d22007-09-21 04:27:02 +0000356#define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */
drh8aff1012001-12-22 14:49:24 +0000357#define SQLITE_MISMATCH 20 /* Data type mismatch */
drh247be432002-05-10 05:44:55 +0000358#define SQLITE_MISUSE 21 /* Library used incorrectly */
drh8766c342002-11-09 00:33:15 +0000359#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */
drhed6c8672003-01-12 18:02:16 +0000360#define SQLITE_AUTH 23 /* Authorization denied */
drh1c2d8412003-03-31 00:30:47 +0000361#define SQLITE_FORMAT 24 /* Auxiliary database format error */
danielk19776f8a5032004-05-10 10:34:51 +0000362#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */
drhc602f9a2004-02-12 19:01:04 +0000363#define SQLITE_NOTADB 26 /* File opened that is not a database file */
danielk19776f8a5032004-05-10 10:34:51 +0000364#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */
365#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */
drh15b9a152006-01-31 20:49:13 +0000366/* end-of-error-codes */
drh717e6402001-09-27 03:22:32 +0000367
drhaf9ff332002-01-16 21:00:27 +0000368/*
drhb25f9d82008-07-23 15:40:06 +0000369** CAPI3REF: Extended Result Codes {H10220} <S10700>
drh33c1be32008-01-30 16:16:14 +0000370** KEYWORDS: {extended error code} {extended error codes}
mihailimefc8e8a2008-06-21 16:47:09 +0000371** KEYWORDS: {extended result code} {extended result codes}
drh4ac285a2006-09-15 07:28:50 +0000372**
drh6ed48bf2007-06-14 20:57:18 +0000373** In its default configuration, SQLite API routines return one of 26 integer
mihailim362cc832008-06-21 06:16:42 +0000374** [SQLITE_OK | result codes]. However, experience has shown that many of
375** these result codes are too coarse-grained. They do not provide as
drhf5befa02007-12-06 02:42:07 +0000376** much information about problems as programmers might like. In an effort to
drh6ed48bf2007-06-14 20:57:18 +0000377** address this, newer versions of SQLite (version 3.3.8 and later) include
378** support for additional result codes that provide more detailed information
drh33c1be32008-01-30 16:16:14 +0000379** about errors. The extended result codes are enabled or disabled
mihailim362cc832008-06-21 06:16:42 +0000380** on a per database connection basis using the
381** [sqlite3_extended_result_codes()] API.
mihailima3f64902008-06-21 13:35:56 +0000382**
drh33c1be32008-01-30 16:16:14 +0000383** Some of the available extended result codes are listed here.
384** One may expect the number of extended result codes will be expand
385** over time. Software that uses extended result codes should expect
386** to see new result codes in future releases of SQLite.
drh4ac285a2006-09-15 07:28:50 +0000387**
388** The SQLITE_OK result code will never be extended. It will always
389** be exactly zero.
drh4ac285a2006-09-15 07:28:50 +0000390*/
danielk1977861f7452008-06-05 11:39:11 +0000391#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8))
392#define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8))
393#define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8))
394#define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8))
395#define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8))
396#define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8))
397#define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8))
398#define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8))
399#define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8))
400#define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8))
401#define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8))
402#define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8))
403#define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8))
404#define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8))
aswift5b1a2562008-08-22 00:22:35 +0000405#define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8))
aswiftaebf4132008-11-21 00:10:35 +0000406#define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8))
407#define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8))
danielk1977404ca072009-03-16 13:19:36 +0000408#define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8) )
409
drh4ac285a2006-09-15 07:28:50 +0000410/*
drh9cd29642008-07-23 00:52:55 +0000411** CAPI3REF: Flags For File Open Operations {H10230} <H11120> <H12700>
drh6d2069d2007-08-14 01:58:53 +0000412**
mlcreechb2799412008-03-07 03:20:31 +0000413** These bit values are intended for use in the
drh33c1be32008-01-30 16:16:14 +0000414** 3rd parameter to the [sqlite3_open_v2()] interface and
415** in the 4th parameter to the xOpen method of the
drhd84f9462007-08-15 11:28:56 +0000416** [sqlite3_vfs] object.
drh6d2069d2007-08-14 01:58:53 +0000417*/
shane089b0a42009-05-14 03:21:28 +0000418#define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */
419#define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */
420#define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */
421#define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */
422#define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */
423#define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */
424#define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */
425#define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */
426#define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */
427#define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */
428#define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */
429#define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */
430#define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */
431#define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */
drh6d2069d2007-08-14 01:58:53 +0000432
433/*
drh9cd29642008-07-23 00:52:55 +0000434** CAPI3REF: Device Characteristics {H10240} <H11120>
drh6d2069d2007-08-14 01:58:53 +0000435**
drh33c1be32008-01-30 16:16:14 +0000436** The xDeviceCapabilities method of the [sqlite3_io_methods]
drhfddfa2d2007-12-05 18:05:16 +0000437** object returns an integer which is a vector of the these
drh6d2069d2007-08-14 01:58:53 +0000438** bit values expressing I/O characteristics of the mass storage
439** device that holds the file that the [sqlite3_io_methods]
drh33c1be32008-01-30 16:16:14 +0000440** refers to.
drh6d2069d2007-08-14 01:58:53 +0000441**
drh33c1be32008-01-30 16:16:14 +0000442** The SQLITE_IOCAP_ATOMIC property means that all writes of
443** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
drh6d2069d2007-08-14 01:58:53 +0000444** mean that writes of blocks that are nnn bytes in size and
445** are aligned to an address which is an integer multiple of
drh33c1be32008-01-30 16:16:14 +0000446** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
drh6d2069d2007-08-14 01:58:53 +0000447** that when data is appended to a file, the data is appended
448** first then the size of the file is extended, never the other
drh33c1be32008-01-30 16:16:14 +0000449** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
drh6d2069d2007-08-14 01:58:53 +0000450** information is written to disk in the same order as calls
451** to xWrite().
452*/
453#define SQLITE_IOCAP_ATOMIC 0x00000001
454#define SQLITE_IOCAP_ATOMIC512 0x00000002
455#define SQLITE_IOCAP_ATOMIC1K 0x00000004
456#define SQLITE_IOCAP_ATOMIC2K 0x00000008
457#define SQLITE_IOCAP_ATOMIC4K 0x00000010
458#define SQLITE_IOCAP_ATOMIC8K 0x00000020
459#define SQLITE_IOCAP_ATOMIC16K 0x00000040
460#define SQLITE_IOCAP_ATOMIC32K 0x00000080
461#define SQLITE_IOCAP_ATOMIC64K 0x00000100
462#define SQLITE_IOCAP_SAFE_APPEND 0x00000200
463#define SQLITE_IOCAP_SEQUENTIAL 0x00000400
464
465/*
drhb25f9d82008-07-23 15:40:06 +0000466** CAPI3REF: File Locking Levels {H10250} <H11120> <H11310>
drh6d2069d2007-08-14 01:58:53 +0000467**
drh33c1be32008-01-30 16:16:14 +0000468** SQLite uses one of these integer values as the second
drh6d2069d2007-08-14 01:58:53 +0000469** argument to calls it makes to the xLock() and xUnlock() methods
drh33c1be32008-01-30 16:16:14 +0000470** of an [sqlite3_io_methods] object.
drh6d2069d2007-08-14 01:58:53 +0000471*/
472#define SQLITE_LOCK_NONE 0
473#define SQLITE_LOCK_SHARED 1
474#define SQLITE_LOCK_RESERVED 2
475#define SQLITE_LOCK_PENDING 3
476#define SQLITE_LOCK_EXCLUSIVE 4
477
478/*
drh9cd29642008-07-23 00:52:55 +0000479** CAPI3REF: Synchronization Type Flags {H10260} <H11120>
drh6d2069d2007-08-14 01:58:53 +0000480**
drh33c1be32008-01-30 16:16:14 +0000481** When SQLite invokes the xSync() method of an
mlcreechb2799412008-03-07 03:20:31 +0000482** [sqlite3_io_methods] object it uses a combination of
drhfddfa2d2007-12-05 18:05:16 +0000483** these integer values as the second argument.
drh6d2069d2007-08-14 01:58:53 +0000484**
drh33c1be32008-01-30 16:16:14 +0000485** When the SQLITE_SYNC_DATAONLY flag is used, it means that the
drh6d2069d2007-08-14 01:58:53 +0000486** sync operation only needs to flush data to mass storage. Inode
drheb0d6292009-04-04 14:04:58 +0000487** information need not be flushed. If the lower four bits of the flag
488** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics.
489** If the lower four bits equal SQLITE_SYNC_FULL, that means
shane7ba429a2008-11-10 17:08:49 +0000490** to use Mac OS X style fullsync instead of fsync().
drh6d2069d2007-08-14 01:58:53 +0000491*/
drh6d2069d2007-08-14 01:58:53 +0000492#define SQLITE_SYNC_NORMAL 0x00002
493#define SQLITE_SYNC_FULL 0x00003
494#define SQLITE_SYNC_DATAONLY 0x00010
495
drh6d2069d2007-08-14 01:58:53 +0000496/*
drh9cd29642008-07-23 00:52:55 +0000497** CAPI3REF: OS Interface Open File Handle {H11110} <S20110>
drh6d2069d2007-08-14 01:58:53 +0000498**
drh6aa5f152009-08-19 15:57:07 +0000499** An [sqlite3_file] object represents an open file in the
500** [sqlite3_vfs | OS interface layer]. Individual OS interface
501** implementations will
drh6d2069d2007-08-14 01:58:53 +0000502** want to subclass this object by appending additional fields
drh4ff7fa02007-09-01 18:17:21 +0000503** for their own use. The pMethods entry is a pointer to an
drhd84f9462007-08-15 11:28:56 +0000504** [sqlite3_io_methods] object that defines methods for performing
505** I/O operations on the open file.
drh6d2069d2007-08-14 01:58:53 +0000506*/
507typedef struct sqlite3_file sqlite3_file;
508struct sqlite3_file {
drh153c62c2007-08-24 03:51:33 +0000509 const struct sqlite3_io_methods *pMethods; /* Methods for an open file */
drh6d2069d2007-08-14 01:58:53 +0000510};
511
512/*
drh9cd29642008-07-23 00:52:55 +0000513** CAPI3REF: OS Interface File Virtual Methods Object {H11120} <S20110>
drh6d2069d2007-08-14 01:58:53 +0000514**
drh4766b292008-06-26 02:53:02 +0000515** Every file opened by the [sqlite3_vfs] xOpen method populates an
516** [sqlite3_file] object (or, more commonly, a subclass of the
517** [sqlite3_file] object) with a pointer to an instance of this object.
518** This object defines the methods used to perform various operations
519** against the open file represented by the [sqlite3_file] object.
drhd84f9462007-08-15 11:28:56 +0000520**
drh9afedcc2009-06-19 22:50:31 +0000521** If the xOpen method sets the sqlite3_file.pMethods element
522** to a non-NULL pointer, then the sqlite3_io_methods.xClose method
523** may be invoked even if the xOpen reported that it failed. The
524** only way to prevent a call to xClose following a failed xOpen
525** is for the xOpen to set the sqlite3_file.pMethods element to NULL.
526**
drhfddfa2d2007-12-05 18:05:16 +0000527** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or
528** [SQLITE_SYNC_FULL]. The first choice is the normal fsync().
shane7ba429a2008-11-10 17:08:49 +0000529** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY]
mihailim362cc832008-06-21 06:16:42 +0000530** flag may be ORed in to indicate that only the data of the file
531** and not its inode needs to be synced.
mihailima3f64902008-06-21 13:35:56 +0000532**
drhd84f9462007-08-15 11:28:56 +0000533** The integer values to xLock() and xUnlock() are one of
drh4ff7fa02007-09-01 18:17:21 +0000534** <ul>
535** <li> [SQLITE_LOCK_NONE],
drh79491ab2007-09-04 12:00:00 +0000536** <li> [SQLITE_LOCK_SHARED],
drh4ff7fa02007-09-01 18:17:21 +0000537** <li> [SQLITE_LOCK_RESERVED],
538** <li> [SQLITE_LOCK_PENDING], or
539** <li> [SQLITE_LOCK_EXCLUSIVE].
540** </ul>
mihailima3f64902008-06-21 13:35:56 +0000541** xLock() increases the lock. xUnlock() decreases the lock.
mihailim362cc832008-06-21 06:16:42 +0000542** The xCheckReservedLock() method checks whether any database connection,
543** either in this process or in some other process, is holding a RESERVED,
drhd84f9462007-08-15 11:28:56 +0000544** PENDING, or EXCLUSIVE lock on the file. It returns true
mihailim362cc832008-06-21 06:16:42 +0000545** if such a lock exists and false otherwise.
mihailima3f64902008-06-21 13:35:56 +0000546**
drhcc6bb3e2007-08-31 16:11:35 +0000547** The xFileControl() method is a generic interface that allows custom
548** VFS implementations to directly control an open file using the
mihailim362cc832008-06-21 06:16:42 +0000549** [sqlite3_file_control()] interface. The second "op" argument is an
mihailima3f64902008-06-21 13:35:56 +0000550** integer opcode. The third argument is a generic pointer intended to
mihailim362cc832008-06-21 06:16:42 +0000551** point to a structure that may contain arguments or space in which to
drhcc6bb3e2007-08-31 16:11:35 +0000552** write return values. Potential uses for xFileControl() might be
553** functions to enable blocking locks with timeouts, to change the
554** locking strategy (for example to use dot-file locks), to inquire
drh9e33c2c2007-08-31 18:34:59 +0000555** about the status of a lock, or to break stale locks. The SQLite
mihailima3f64902008-06-21 13:35:56 +0000556** core reserves all opcodes less than 100 for its own use.
drh4ff7fa02007-09-01 18:17:21 +0000557** A [SQLITE_FCNTL_LOCKSTATE | list of opcodes] less than 100 is available.
mihailim362cc832008-06-21 06:16:42 +0000558** Applications that define a custom xFileControl method should use opcodes
drh9e33c2c2007-08-31 18:34:59 +0000559** greater than 100 to avoid conflicts.
drhd84f9462007-08-15 11:28:56 +0000560**
561** The xSectorSize() method returns the sector size of the
562** device that underlies the file. The sector size is the
563** minimum write that can be performed without disturbing
564** other bytes in the file. The xDeviceCharacteristics()
565** method returns a bit vector describing behaviors of the
566** underlying device:
567**
568** <ul>
drh4ff7fa02007-09-01 18:17:21 +0000569** <li> [SQLITE_IOCAP_ATOMIC]
570** <li> [SQLITE_IOCAP_ATOMIC512]
571** <li> [SQLITE_IOCAP_ATOMIC1K]
572** <li> [SQLITE_IOCAP_ATOMIC2K]
573** <li> [SQLITE_IOCAP_ATOMIC4K]
574** <li> [SQLITE_IOCAP_ATOMIC8K]
575** <li> [SQLITE_IOCAP_ATOMIC16K]
576** <li> [SQLITE_IOCAP_ATOMIC32K]
577** <li> [SQLITE_IOCAP_ATOMIC64K]
578** <li> [SQLITE_IOCAP_SAFE_APPEND]
579** <li> [SQLITE_IOCAP_SEQUENTIAL]
drhd84f9462007-08-15 11:28:56 +0000580** </ul>
581**
582** The SQLITE_IOCAP_ATOMIC property means that all writes of
583** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
584** mean that writes of blocks that are nnn bytes in size and
585** are aligned to an address which is an integer multiple of
586** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
587** that when data is appended to a file, the data is appended
588** first then the size of the file is extended, never the other
589** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
590** information is written to disk in the same order as calls
591** to xWrite().
drh4c17c3f2008-11-07 00:06:18 +0000592**
593** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill
594** in the unread portions of the buffer with zeros. A VFS that
595** fails to zero-fill short reads might seem to work. However,
596** failure to zero-fill short reads will eventually lead to
597** database corruption.
drh6d2069d2007-08-14 01:58:53 +0000598*/
599typedef struct sqlite3_io_methods sqlite3_io_methods;
600struct sqlite3_io_methods {
601 int iVersion;
602 int (*xClose)(sqlite3_file*);
drh79491ab2007-09-04 12:00:00 +0000603 int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst);
604 int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst);
605 int (*xTruncate)(sqlite3_file*, sqlite3_int64 size);
drh6d2069d2007-08-14 01:58:53 +0000606 int (*xSync)(sqlite3_file*, int flags);
drh79491ab2007-09-04 12:00:00 +0000607 int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize);
drh6d2069d2007-08-14 01:58:53 +0000608 int (*xLock)(sqlite3_file*, int);
609 int (*xUnlock)(sqlite3_file*, int);
danielk1977861f7452008-06-05 11:39:11 +0000610 int (*xCheckReservedLock)(sqlite3_file*, int *pResOut);
drhcc6bb3e2007-08-31 16:11:35 +0000611 int (*xFileControl)(sqlite3_file*, int op, void *pArg);
drh6d2069d2007-08-14 01:58:53 +0000612 int (*xSectorSize)(sqlite3_file*);
613 int (*xDeviceCharacteristics)(sqlite3_file*);
614 /* Additional methods may be added in future releases */
615};
616
617/*
drh9cd29642008-07-23 00:52:55 +0000618** CAPI3REF: Standard File Control Opcodes {H11310} <S30800>
drh9e33c2c2007-08-31 18:34:59 +0000619**
620** These integer constants are opcodes for the xFileControl method
mihailim362cc832008-06-21 06:16:42 +0000621** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()]
drh9e33c2c2007-08-31 18:34:59 +0000622** interface.
623**
drh33c1be32008-01-30 16:16:14 +0000624** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This
mlcreechb2799412008-03-07 03:20:31 +0000625** opcode causes the xFileControl method to write the current state of
drh9e33c2c2007-08-31 18:34:59 +0000626** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED],
627** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE])
drh33c1be32008-01-30 16:16:14 +0000628** into an integer that the pArg argument points to. This capability
drh9e33c2c2007-08-31 18:34:59 +0000629** is used during testing and only needs to be supported when SQLITE_TEST
630** is defined.
631*/
632#define SQLITE_FCNTL_LOCKSTATE 1
aswiftaebf4132008-11-21 00:10:35 +0000633#define SQLITE_GET_LOCKPROXYFILE 2
634#define SQLITE_SET_LOCKPROXYFILE 3
635#define SQLITE_LAST_ERRNO 4
drh9e33c2c2007-08-31 18:34:59 +0000636
637/*
drh9cd29642008-07-23 00:52:55 +0000638** CAPI3REF: Mutex Handle {H17110} <S20130>
drh6d2069d2007-08-14 01:58:53 +0000639**
drhd84f9462007-08-15 11:28:56 +0000640** The mutex module within SQLite defines [sqlite3_mutex] to be an
drh33c1be32008-01-30 16:16:14 +0000641** abstract type for a mutex object. The SQLite core never looks
642** at the internal representation of an [sqlite3_mutex]. It only
drhd84f9462007-08-15 11:28:56 +0000643** deals with pointers to the [sqlite3_mutex] object.
drh6bdec4a2007-08-16 19:40:16 +0000644**
645** Mutexes are created using [sqlite3_mutex_alloc()].
drh6d2069d2007-08-14 01:58:53 +0000646*/
647typedef struct sqlite3_mutex sqlite3_mutex;
648
649/*
drh9cd29642008-07-23 00:52:55 +0000650** CAPI3REF: OS Interface Object {H11140} <S20100>
drh6d2069d2007-08-14 01:58:53 +0000651**
mihailim362cc832008-06-21 06:16:42 +0000652** An instance of the sqlite3_vfs object defines the interface between
653** the SQLite core and the underlying operating system. The "vfs"
drhd84f9462007-08-15 11:28:56 +0000654** in the name of the object stands for "virtual file system".
drh6d2069d2007-08-14 01:58:53 +0000655**
mihailim362cc832008-06-21 06:16:42 +0000656** The value of the iVersion field is initially 1 but may be larger in
657** future versions of SQLite. Additional fields may be appended to this
drh4766b292008-06-26 02:53:02 +0000658** object when the iVersion value is increased. Note that the structure
659** of the sqlite3_vfs object changes in the transaction between
660** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not
661** modified.
drh6bdec4a2007-08-16 19:40:16 +0000662**
drh4ff7fa02007-09-01 18:17:21 +0000663** The szOsFile field is the size of the subclassed [sqlite3_file]
drhd84f9462007-08-15 11:28:56 +0000664** structure used by this VFS. mxPathname is the maximum length of
665** a pathname in this VFS.
666**
drhb4d58ae2008-02-21 20:17:06 +0000667** Registered sqlite3_vfs objects are kept on a linked list formed by
drh79491ab2007-09-04 12:00:00 +0000668** the pNext pointer. The [sqlite3_vfs_register()]
669** and [sqlite3_vfs_unregister()] interfaces manage this list
670** in a thread-safe way. The [sqlite3_vfs_find()] interface
drh4766b292008-06-26 02:53:02 +0000671** searches the list. Neither the application code nor the VFS
672** implementation should use the pNext pointer.
drhd84f9462007-08-15 11:28:56 +0000673**
mihailima3f64902008-06-21 13:35:56 +0000674** The pNext field is the only field in the sqlite3_vfs
drh1cc8c442007-08-24 16:08:29 +0000675** structure that SQLite will ever modify. SQLite will only access
676** or modify this field while holding a particular static mutex.
677** The application should never modify anything within the sqlite3_vfs
678** object once the object has been registered.
679**
drhd84f9462007-08-15 11:28:56 +0000680** The zName field holds the name of the VFS module. The name must
681** be unique across all VFS modules.
682**
drh032ca702008-12-10 11:44:30 +0000683** SQLite will guarantee that the zFilename parameter to xOpen
drh4766b292008-06-26 02:53:02 +0000684** is either a NULL pointer or string obtained
685** from xFullPathname(). SQLite further guarantees that
686** the string will be valid and unchanged until xClose() is
drh9afedcc2009-06-19 22:50:31 +0000687** called. Because of the previous sentence,
drh4766b292008-06-26 02:53:02 +0000688** the [sqlite3_file] can safely store a pointer to the
drh6d2069d2007-08-14 01:58:53 +0000689** filename if it needs to remember the filename for some reason.
drh4766b292008-06-26 02:53:02 +0000690** If the zFilename parameter is xOpen is a NULL pointer then xOpen
drh9afedcc2009-06-19 22:50:31 +0000691** must invent its own temporary name for the file. Whenever the
drh4766b292008-06-26 02:53:02 +0000692** xFilename parameter is NULL it will also be the case that the
693** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE].
drhd84f9462007-08-15 11:28:56 +0000694**
drh032ca702008-12-10 11:44:30 +0000695** The flags argument to xOpen() includes all bits set in
drhf5befa02007-12-06 02:42:07 +0000696** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()]
697** or [sqlite3_open16()] is used, then flags includes at least
drh032ca702008-12-10 11:44:30 +0000698** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE].
drh6d2069d2007-08-14 01:58:53 +0000699** If xOpen() opens a file read-only then it sets *pOutFlags to
mihailim362cc832008-06-21 06:16:42 +0000700** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set.
701**
drh032ca702008-12-10 11:44:30 +0000702** SQLite will also add one of the following flags to the xOpen()
drh6d2069d2007-08-14 01:58:53 +0000703** call, depending on the object being opened:
mihailim362cc832008-06-21 06:16:42 +0000704**
drh6d2069d2007-08-14 01:58:53 +0000705** <ul>
706** <li> [SQLITE_OPEN_MAIN_DB]
707** <li> [SQLITE_OPEN_MAIN_JOURNAL]
708** <li> [SQLITE_OPEN_TEMP_DB]
709** <li> [SQLITE_OPEN_TEMP_JOURNAL]
drh33f4e022007-09-03 15:19:34 +0000710** <li> [SQLITE_OPEN_TRANSIENT_DB]
drh6d2069d2007-08-14 01:58:53 +0000711** <li> [SQLITE_OPEN_SUBJOURNAL]
712** <li> [SQLITE_OPEN_MASTER_JOURNAL]
drh032ca702008-12-10 11:44:30 +0000713** </ul>
drhd84f9462007-08-15 11:28:56 +0000714**
drh6d2069d2007-08-14 01:58:53 +0000715** The file I/O implementation can use the object type flags to
mihailim362cc832008-06-21 06:16:42 +0000716** change the way it deals with files. For example, an application
mlcreechb2799412008-03-07 03:20:31 +0000717** that does not care about crash recovery or rollback might make
718** the open of a journal file a no-op. Writes to this journal would
mihailim362cc832008-06-21 06:16:42 +0000719** also be no-ops, and any attempt to read the journal would return
720** SQLITE_IOERR. Or the implementation might recognize that a database
721** file will be doing page-aligned sector reads and writes in a random
mlcreechb2799412008-03-07 03:20:31 +0000722** order and set up its I/O subsystem accordingly.
mihailim362cc832008-06-21 06:16:42 +0000723**
724** SQLite might also add one of the following flags to the xOpen method:
725**
drh6d2069d2007-08-14 01:58:53 +0000726** <ul>
727** <li> [SQLITE_OPEN_DELETEONCLOSE]
728** <li> [SQLITE_OPEN_EXCLUSIVE]
729** </ul>
mihailim362cc832008-06-21 06:16:42 +0000730**
drh032ca702008-12-10 11:44:30 +0000731** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be
732** deleted when it is closed. The [SQLITE_OPEN_DELETEONCLOSE]
mihailim362cc832008-06-21 06:16:42 +0000733** will be set for TEMP databases, journals and for subjournals.
mihailim04bcc002008-06-22 10:21:27 +0000734**
shane089b0a42009-05-14 03:21:28 +0000735** The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction
736** with the [SQLITE_OPEN_CREATE] flag, which are both directly
737** analogous to the O_EXCL and O_CREAT flags of the POSIX open()
738** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the
739** SQLITE_OPEN_CREATE, is used to indicate that file should always
740** be created, and that it is an error if it already exists.
741** It is <i>not</i> used to indicate the file should be opened
742** for exclusive access.
mihailim362cc832008-06-21 06:16:42 +0000743**
drh032ca702008-12-10 11:44:30 +0000744** At least szOsFile bytes of memory are allocated by SQLite
mihailim362cc832008-06-21 06:16:42 +0000745** to hold the [sqlite3_file] structure passed as the third
drh032ca702008-12-10 11:44:30 +0000746** argument to xOpen. The xOpen method does not have to
drh9afedcc2009-06-19 22:50:31 +0000747** allocate the structure; it should just fill it in. Note that
748** the xOpen method must set the sqlite3_file.pMethods to either
749** a valid [sqlite3_io_methods] object or to NULL. xOpen must do
750** this even if the open fails. SQLite expects that the sqlite3_file.pMethods
751** element will be valid after xOpen returns regardless of the success
752** or failure of the xOpen call.
mihailim362cc832008-06-21 06:16:42 +0000753**
drh032ca702008-12-10 11:44:30 +0000754** The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS]
mihailim362cc832008-06-21 06:16:42 +0000755** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to
756** test whether a file is readable and writable, or [SQLITE_ACCESS_READ]
drh032ca702008-12-10 11:44:30 +0000757** to test whether a file is at least readable. The file can be a
drh6d2069d2007-08-14 01:58:53 +0000758** directory.
mihailim362cc832008-06-21 06:16:42 +0000759**
drh032ca702008-12-10 11:44:30 +0000760** SQLite will always allocate at least mxPathname+1 bytes for the
761** output buffer xFullPathname. The exact size of the output buffer
762** is also passed as a parameter to both methods. If the output buffer
mihailim362cc832008-06-21 06:16:42 +0000763** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is
764** handled as a fatal error by SQLite, vfs implementations should endeavor
765** to prevent this by setting mxPathname to a sufficiently large value.
766**
drhd84f9462007-08-15 11:28:56 +0000767** The xRandomness(), xSleep(), and xCurrentTime() interfaces
768** are not strictly a part of the filesystem, but they are
769** included in the VFS structure for completeness.
drh6d2069d2007-08-14 01:58:53 +0000770** The xRandomness() function attempts to return nBytes bytes
771** of good-quality randomness into zOut. The return value is
mihailim362cc832008-06-21 06:16:42 +0000772** the actual number of bytes of randomness obtained.
773** The xSleep() method causes the calling thread to sleep for at
drhd84f9462007-08-15 11:28:56 +0000774** least the number of microseconds given. The xCurrentTime()
mihailim362cc832008-06-21 06:16:42 +0000775** method returns a Julian Day Number for the current date and time.
drh032ca702008-12-10 11:44:30 +0000776**
drh6d2069d2007-08-14 01:58:53 +0000777*/
drhd84f9462007-08-15 11:28:56 +0000778typedef struct sqlite3_vfs sqlite3_vfs;
779struct sqlite3_vfs {
drh6d2069d2007-08-14 01:58:53 +0000780 int iVersion; /* Structure version number */
781 int szOsFile; /* Size of subclassed sqlite3_file */
drh6d2069d2007-08-14 01:58:53 +0000782 int mxPathname; /* Maximum file pathname length */
drhd84f9462007-08-15 11:28:56 +0000783 sqlite3_vfs *pNext; /* Next registered VFS */
drhd84f9462007-08-15 11:28:56 +0000784 const char *zName; /* Name of this virtual file system */
drh1cc8c442007-08-24 16:08:29 +0000785 void *pAppData; /* Pointer to application-specific data */
drh153c62c2007-08-24 03:51:33 +0000786 int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*,
drh6d2069d2007-08-14 01:58:53 +0000787 int flags, int *pOutFlags);
drh153c62c2007-08-24 03:51:33 +0000788 int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir);
danielk1977861f7452008-06-05 11:39:11 +0000789 int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut);
danielk1977adfb9b02007-09-17 07:02:56 +0000790 int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut);
drh153c62c2007-08-24 03:51:33 +0000791 void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename);
792 void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg);
drh1875f7a2008-12-08 18:19:17 +0000793 void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void);
drh153c62c2007-08-24 03:51:33 +0000794 void (*xDlClose)(sqlite3_vfs*, void*);
795 int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut);
796 int (*xSleep)(sqlite3_vfs*, int microseconds);
797 int (*xCurrentTime)(sqlite3_vfs*, double*);
danielk1977bcb97fe2008-06-06 15:49:29 +0000798 int (*xGetLastError)(sqlite3_vfs*, int, char *);
drhd84f9462007-08-15 11:28:56 +0000799 /* New fields may be appended in figure versions. The iVersion
drh6d2069d2007-08-14 01:58:53 +0000800 ** value will increment whenever this happens. */
801};
802
drh50d3f902007-08-27 21:10:36 +0000803/*
drh9cd29642008-07-23 00:52:55 +0000804** CAPI3REF: Flags for the xAccess VFS method {H11190} <H11140>
drh50d3f902007-08-27 21:10:36 +0000805**
drh032ca702008-12-10 11:44:30 +0000806** These integer constants can be used as the third parameter to
drhfddfa2d2007-12-05 18:05:16 +0000807** the xAccess method of an [sqlite3_vfs] object. {END} They determine
mihailim04bcc002008-06-22 10:21:27 +0000808** what kind of permissions the xAccess method is looking for.
drh032ca702008-12-10 11:44:30 +0000809** With SQLITE_ACCESS_EXISTS, the xAccess method
mihailim04bcc002008-06-22 10:21:27 +0000810** simply checks whether the file exists.
drh032ca702008-12-10 11:44:30 +0000811** With SQLITE_ACCESS_READWRITE, the xAccess method
mihailim04bcc002008-06-22 10:21:27 +0000812** checks whether the file is both readable and writable.
drh032ca702008-12-10 11:44:30 +0000813** With SQLITE_ACCESS_READ, the xAccess method
mihailim04bcc002008-06-22 10:21:27 +0000814** checks whether the file is readable.
drh50d3f902007-08-27 21:10:36 +0000815*/
danielk1977b4b47412007-08-17 15:53:36 +0000816#define SQLITE_ACCESS_EXISTS 0
817#define SQLITE_ACCESS_READWRITE 1
drh50d3f902007-08-27 21:10:36 +0000818#define SQLITE_ACCESS_READ 2
danielk1977b4b47412007-08-17 15:53:36 +0000819
drh6d2069d2007-08-14 01:58:53 +0000820/*
drh9cd29642008-07-23 00:52:55 +0000821** CAPI3REF: Initialize The SQLite Library {H10130} <S20000><S30100>
drh673299b2008-06-09 21:57:22 +0000822**
drhcb041342008-06-12 00:07:29 +0000823** The sqlite3_initialize() routine initializes the
drh4766b292008-06-26 02:53:02 +0000824** SQLite library. The sqlite3_shutdown() routine
drhcb041342008-06-12 00:07:29 +0000825** deallocates any resources that were allocated by sqlite3_initialize().
drh673299b2008-06-09 21:57:22 +0000826**
drhcb041342008-06-12 00:07:29 +0000827** A call to sqlite3_initialize() is an "effective" call if it is
828** the first time sqlite3_initialize() is invoked during the lifetime of
829** the process, or if it is the first time sqlite3_initialize() is invoked
830** following a call to sqlite3_shutdown(). Only an effective call
831** of sqlite3_initialize() does any initialization. All other calls
drh4766b292008-06-26 02:53:02 +0000832** are harmless no-ops.
drhcb041342008-06-12 00:07:29 +0000833**
drhd1a24402009-04-19 12:23:58 +0000834** A call to sqlite3_shutdown() is an "effective" call if it is the first
835** call to sqlite3_shutdown() since the last sqlite3_initialize(). Only
836** an effective call to sqlite3_shutdown() does any deinitialization.
837** All other calls to sqlite3_shutdown() are harmless no-ops.
838**
drhcb041342008-06-12 00:07:29 +0000839** Among other things, sqlite3_initialize() shall invoke
drh55b0cf02008-06-19 17:54:33 +0000840** sqlite3_os_init(). Similarly, sqlite3_shutdown()
841** shall invoke sqlite3_os_end().
drh673299b2008-06-09 21:57:22 +0000842**
drhadfae6c2008-10-10 17:26:35 +0000843** The sqlite3_initialize() routine returns [SQLITE_OK] on success.
drhce5a5a02008-06-10 17:41:44 +0000844** If for some reason, sqlite3_initialize() is unable to initialize
845** the library (perhaps it is unable to allocate a needed resource such
drhadfae6c2008-10-10 17:26:35 +0000846** as a mutex) it returns an [error code] other than [SQLITE_OK].
drh673299b2008-06-09 21:57:22 +0000847**
drhce5a5a02008-06-10 17:41:44 +0000848** The sqlite3_initialize() routine is called internally by many other
drhcb041342008-06-12 00:07:29 +0000849** SQLite interfaces so that an application usually does not need to
drhce5a5a02008-06-10 17:41:44 +0000850** invoke sqlite3_initialize() directly. For example, [sqlite3_open()]
851** calls sqlite3_initialize() so the SQLite library will be automatically
852** initialized when [sqlite3_open()] is called if it has not be initialized
drhadfae6c2008-10-10 17:26:35 +0000853** already. However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT]
drhcb041342008-06-12 00:07:29 +0000854** compile-time option, then the automatic calls to sqlite3_initialize()
855** are omitted and the application must call sqlite3_initialize() directly
856** prior to using any other SQLite interface. For maximum portability,
857** it is recommended that applications always invoke sqlite3_initialize()
858** directly prior to using any other SQLite interface. Future releases
859** of SQLite may require this. In other words, the behavior exhibited
drhadfae6c2008-10-10 17:26:35 +0000860** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the
drhcb041342008-06-12 00:07:29 +0000861** default behavior in some future release of SQLite.
drh673299b2008-06-09 21:57:22 +0000862**
drhcb041342008-06-12 00:07:29 +0000863** The sqlite3_os_init() routine does operating-system specific
864** initialization of the SQLite library. The sqlite3_os_end()
865** routine undoes the effect of sqlite3_os_init(). Typical tasks
866** performed by these routines include allocation or deallocation
867** of static resources, initialization of global variables,
868** setting up a default [sqlite3_vfs] module, or setting up
mihailima3f64902008-06-21 13:35:56 +0000869** a default configuration using [sqlite3_config()].
drh673299b2008-06-09 21:57:22 +0000870**
drhcb041342008-06-12 00:07:29 +0000871** The application should never invoke either sqlite3_os_init()
872** or sqlite3_os_end() directly. The application should only invoke
873** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init()
mihailima3f64902008-06-21 13:35:56 +0000874** interface is called automatically by sqlite3_initialize() and
drhcb041342008-06-12 00:07:29 +0000875** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate
876** implementations for sqlite3_os_init() and sqlite3_os_end()
shane7c7c3112009-08-17 15:31:23 +0000877** are built into SQLite when it is compiled for Unix, Windows, or OS/2.
drh6aa5f152009-08-19 15:57:07 +0000878** When [custom builds | built for other platforms]
879** (using the [SQLITE_OS_OTHER=1] compile-time
drhcb041342008-06-12 00:07:29 +0000880** option) the application must supply a suitable implementation for
881** sqlite3_os_init() and sqlite3_os_end(). An application-supplied
882** implementation of sqlite3_os_init() or sqlite3_os_end()
drhadfae6c2008-10-10 17:26:35 +0000883** must return [SQLITE_OK] on success and some other [error code] upon
drhcb041342008-06-12 00:07:29 +0000884** failure.
drh673299b2008-06-09 21:57:22 +0000885*/
drhce5a5a02008-06-10 17:41:44 +0000886int sqlite3_initialize(void);
drh673299b2008-06-09 21:57:22 +0000887int sqlite3_shutdown(void);
drhcb041342008-06-12 00:07:29 +0000888int sqlite3_os_init(void);
889int sqlite3_os_end(void);
drh673299b2008-06-09 21:57:22 +0000890
drhce5a5a02008-06-10 17:41:44 +0000891/*
drhadfae6c2008-10-10 17:26:35 +0000892** CAPI3REF: Configuring The SQLite Library {H14100} <S20000><S30200>
drhd5a68d32008-08-04 13:44:57 +0000893** EXPERIMENTAL
drhce5a5a02008-06-10 17:41:44 +0000894**
895** The sqlite3_config() interface is used to make global configuration
896** changes to SQLite in order to tune SQLite to the specific needs of
897** the application. The default configuration is recommended for most
898** applications and so this routine is usually not necessary. It is
899** provided to support rare applications with unusual needs.
900**
901** The sqlite3_config() interface is not threadsafe. The application
902** must insure that no other SQLite interfaces are invoked by other
903** threads while sqlite3_config() is running. Furthermore, sqlite3_config()
904** may only be invoked prior to library initialization using
905** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()].
906** Note, however, that sqlite3_config() can be called as part of the
drh40257ff2008-06-13 18:24:27 +0000907** implementation of an application-defined [sqlite3_os_init()].
drhce5a5a02008-06-10 17:41:44 +0000908**
909** The first argument to sqlite3_config() is an integer
910** [SQLITE_CONFIG_SINGLETHREAD | configuration option] that determines
911** what property of SQLite is to be configured. Subsequent arguments
912** vary depending on the [SQLITE_CONFIG_SINGLETHREAD | configuration option]
913** in the first argument.
914**
drhadfae6c2008-10-10 17:26:35 +0000915** When a configuration option is set, sqlite3_config() returns [SQLITE_OK].
mihailima3f64902008-06-21 13:35:56 +0000916** If the option is unknown or SQLite is unable to set the option
drh40257ff2008-06-13 18:24:27 +0000917** then this routine returns a non-zero [error code].
drhadfae6c2008-10-10 17:26:35 +0000918**
drh8b39db12009-02-18 18:37:58 +0000919** Requirements:
920** [H14103] [H14106] [H14120] [H14123] [H14126] [H14129] [H14132] [H14135]
921** [H14138] [H14141] [H14144] [H14147] [H14150] [H14153] [H14156] [H14159]
922** [H14162] [H14165] [H14168]
drhce5a5a02008-06-10 17:41:44 +0000923*/
shanea79c3cc2008-08-11 17:27:01 +0000924SQLITE_EXPERIMENTAL int sqlite3_config(int, ...);
drhce5a5a02008-06-10 17:41:44 +0000925
926/*
drhf8cecda2008-10-10 23:48:25 +0000927** CAPI3REF: Configure database connections {H14200} <S20000>
drhd5a68d32008-08-04 13:44:57 +0000928** EXPERIMENTAL
drh633e6d52008-07-28 19:34:53 +0000929**
930** The sqlite3_db_config() interface is used to make configuration
drh2462e322008-07-31 14:47:54 +0000931** changes to a [database connection]. The interface is similar to
932** [sqlite3_config()] except that the changes apply to a single
933** [database connection] (specified in the first argument). The
934** sqlite3_db_config() interface can only be used immediately after
935** the database connection is created using [sqlite3_open()],
936** [sqlite3_open16()], or [sqlite3_open_v2()].
937**
938** The second argument to sqlite3_db_config(D,V,...) is the
939** configuration verb - an integer code that indicates what
940** aspect of the [database connection] is being configured.
drhe9d1c722008-08-04 20:13:26 +0000941** The only choice for this value is [SQLITE_DBCONFIG_LOOKASIDE].
drh2462e322008-07-31 14:47:54 +0000942** New verbs are likely to be added in future releases of SQLite.
drhe9d1c722008-08-04 20:13:26 +0000943** Additional arguments depend on the verb.
drhf8cecda2008-10-10 23:48:25 +0000944**
drh8b39db12009-02-18 18:37:58 +0000945** Requirements:
946** [H14203] [H14206] [H14209] [H14212] [H14215]
drh633e6d52008-07-28 19:34:53 +0000947*/
shanea79c3cc2008-08-11 17:27:01 +0000948SQLITE_EXPERIMENTAL int sqlite3_db_config(sqlite3*, int op, ...);
drh633e6d52008-07-28 19:34:53 +0000949
950/*
drh9cd29642008-07-23 00:52:55 +0000951** CAPI3REF: Memory Allocation Routines {H10155} <S20120>
drhd5a68d32008-08-04 13:44:57 +0000952** EXPERIMENTAL
drhfec00ea2008-06-14 16:56:21 +0000953**
954** An instance of this object defines the interface between SQLite
mihailima3f64902008-06-21 13:35:56 +0000955** and low-level memory allocation routines.
drhfec00ea2008-06-14 16:56:21 +0000956**
957** This object is used in only one place in the SQLite interface.
958** A pointer to an instance of this object is the argument to
drh4766b292008-06-26 02:53:02 +0000959** [sqlite3_config()] when the configuration option is
drh6aa5f152009-08-19 15:57:07 +0000960** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC].
961** By creating an instance of this object
962** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC])
963** during configuration, an application can specify an alternative
964** memory allocation subsystem for SQLite to use for all of its
965** dynamic memory needs.
drhfec00ea2008-06-14 16:56:21 +0000966**
drh6aa5f152009-08-19 15:57:07 +0000967** Note that SQLite comes with several [built-in memory allocators]
968** that are perfectly adequate for the overwhelming majority of applications
drhfec00ea2008-06-14 16:56:21 +0000969** and that this object is only useful to a tiny minority of applications
970** with specialized memory allocation requirements. This object is
971** also used during testing of SQLite in order to specify an alternative
972** memory allocator that simulates memory out-of-memory conditions in
973** order to verify that SQLite recovers gracefully from such
974** conditions.
975**
drh6aa5f152009-08-19 15:57:07 +0000976** The xMalloc and xFree methods must work like the
977** malloc() and free() functions from the standard C library.
978** The xRealloc method must work like realloc() from the standard C library
979** with the exception that if the second argument to xRealloc is zero,
980** xRealloc must be a no-op - it must not perform any allocation or
981** deallocation. SQLite guaranteeds that the second argument to
982** xRealloc is always a value returned by a prior call to xRoundup.
983** And so in cases where xRoundup always returns a positive number,
984** xRealloc can perform exactly as the standard library realloc() and
985** still be in compliance with this specification.
drhfec00ea2008-06-14 16:56:21 +0000986**
987** xSize should return the allocated size of a memory allocation
988** previously obtained from xMalloc or xRealloc. The allocated size
989** is always at least as big as the requested size but may be larger.
990**
991** The xRoundup method returns what would be the allocated size of
992** a memory allocation given a particular requested size. Most memory
993** allocators round up memory allocations at least to the next multiple
mihailima3f64902008-06-21 13:35:56 +0000994** of 8. Some allocators round up to a larger multiple or to a power of 2.
drh6aa5f152009-08-19 15:57:07 +0000995** Every memory allocation request coming in through [sqlite3_malloc()]
996** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0,
997** that causes the corresponding memory allocation to fail.
drhe5ae5732008-06-15 02:51:47 +0000998**
drhfec00ea2008-06-14 16:56:21 +0000999** The xInit method initializes the memory allocator. (For example,
1000** it might allocate any require mutexes or initialize internal data
1001** structures. The xShutdown method is invoked (indirectly) by
1002** [sqlite3_shutdown()] and should deallocate any resources acquired
1003** by xInit. The pAppData pointer is used as the only parameter to
1004** xInit and xShutdown.
drh9ac06502009-08-17 13:42:29 +00001005**
1006** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes
1007** the xInit method, so the xInit method need not be threadsafe. The
1008** xShutdown method is only called from [sqlite3_shutdown()] so it does
drh6aa5f152009-08-19 15:57:07 +00001009** not need to be threadsafe either. For all other methods, SQLite
1010** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the
1011** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which
1012** it is by default) and so the methods are automatically serialized.
1013** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other
1014** methods must be threadsafe or else make their own arrangements for
1015** serialization.
drh9ac06502009-08-17 13:42:29 +00001016**
1017** SQLite will never invoke xInit() more than once without an intervening
1018** call to xShutdown().
drhfec00ea2008-06-14 16:56:21 +00001019*/
1020typedef struct sqlite3_mem_methods sqlite3_mem_methods;
1021struct sqlite3_mem_methods {
1022 void *(*xMalloc)(int); /* Memory allocation function */
1023 void (*xFree)(void*); /* Free a prior allocation */
1024 void *(*xRealloc)(void*,int); /* Resize an allocation */
1025 int (*xSize)(void*); /* Return the size of an allocation */
1026 int (*xRoundup)(int); /* Round up request size to allocation size */
1027 int (*xInit)(void*); /* Initialize the memory allocator */
1028 void (*xShutdown)(void*); /* Deinitialize the memory allocator */
1029 void *pAppData; /* Argument to xInit() and xShutdown() */
1030};
1031
1032/*
drh9cd29642008-07-23 00:52:55 +00001033** CAPI3REF: Configuration Options {H10160} <S20000>
drhd5a68d32008-08-04 13:44:57 +00001034** EXPERIMENTAL
drhce5a5a02008-06-10 17:41:44 +00001035**
1036** These constants are the available integer configuration options that
1037** can be passed as the first argument to the [sqlite3_config()] interface.
mihailima3f64902008-06-21 13:35:56 +00001038**
drha911abe2008-07-16 13:29:51 +00001039** New configuration options may be added in future releases of SQLite.
1040** Existing configuration options might be discontinued. Applications
1041** should check the return code from [sqlite3_config()] to make sure that
1042** the call worked. The [sqlite3_config()] interface will return a
1043** non-zero [error code] if a discontinued or unsupported configuration option
1044** is invoked.
1045**
drhce5a5a02008-06-10 17:41:44 +00001046** <dl>
1047** <dt>SQLITE_CONFIG_SINGLETHREAD</dt>
1048** <dd>There are no arguments to this option. This option disables
1049** all mutexing and puts SQLite into a mode where it can only be used
1050** by a single thread.</dd>
1051**
1052** <dt>SQLITE_CONFIG_MULTITHREAD</dt>
1053** <dd>There are no arguments to this option. This option disables
1054** mutexing on [database connection] and [prepared statement] objects.
1055** The application is responsible for serializing access to
1056** [database connections] and [prepared statements]. But other mutexes
1057** are enabled so that SQLite will be safe to use in a multi-threaded
drhafacce02008-09-02 21:35:03 +00001058** environment as long as no two threads attempt to use the same
1059** [database connection] at the same time. See the [threading mode]
1060** documentation for additional information.</dd>
drhce5a5a02008-06-10 17:41:44 +00001061**
1062** <dt>SQLITE_CONFIG_SERIALIZED</dt>
1063** <dd>There are no arguments to this option. This option enables
1064** all mutexes including the recursive
1065** mutexes on [database connection] and [prepared statement] objects.
1066** In this mode (which is the default when SQLite is compiled with
drh4766b292008-06-26 02:53:02 +00001067** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access
drhce5a5a02008-06-10 17:41:44 +00001068** to [database connections] and [prepared statements] so that the
1069** application is free to use the same [database connection] or the
drh31d38cf2008-07-12 20:35:08 +00001070** same [prepared statement] in different threads at the same time.
drhafacce02008-09-02 21:35:03 +00001071** See the [threading mode] documentation for additional information.</dd>
drhce5a5a02008-06-10 17:41:44 +00001072**
1073** <dt>SQLITE_CONFIG_MALLOC</dt>
drhfec00ea2008-06-14 16:56:21 +00001074** <dd>This option takes a single argument which is a pointer to an
mihailimdb4f2ad2008-06-21 11:20:48 +00001075** instance of the [sqlite3_mem_methods] structure. The argument specifies
1076** alternative low-level memory allocation routines to be used in place of
drhfec00ea2008-06-14 16:56:21 +00001077** the memory allocation routines built into SQLite.</dd>
drhce5a5a02008-06-10 17:41:44 +00001078**
drh33589792008-06-18 13:27:46 +00001079** <dt>SQLITE_CONFIG_GETMALLOC</dt>
1080** <dd>This option takes a single argument which is a pointer to an
1081** instance of the [sqlite3_mem_methods] structure. The [sqlite3_mem_methods]
1082** structure is filled with the currently defined memory allocation routines.
1083** This option can be used to overload the default memory allocation
1084** routines with a wrapper that simulations memory allocation failure or
1085** tracks memory usage, for example.</dd>
1086**
drhfec00ea2008-06-14 16:56:21 +00001087** <dt>SQLITE_CONFIG_MEMSTATUS</dt>
danielk197795c232d2008-07-28 05:22:35 +00001088** <dd>This option takes single argument of type int, interpreted as a
1089** boolean, which enables or disables the collection of memory allocation
1090** statistics. When disabled, the following SQLite interfaces become
1091** non-operational:
drhce5a5a02008-06-10 17:41:44 +00001092** <ul>
1093** <li> [sqlite3_memory_used()]
1094** <li> [sqlite3_memory_highwater()]
1095** <li> [sqlite3_soft_heap_limit()]
drh0a60a382008-07-31 17:16:05 +00001096** <li> [sqlite3_status()]
drhce5a5a02008-06-10 17:41:44 +00001097** </ul>
1098** </dd>
drh33589792008-06-18 13:27:46 +00001099**
1100** <dt>SQLITE_CONFIG_SCRATCH</dt>
1101** <dd>This option specifies a static memory buffer that SQLite can use for
drh6860da02009-06-09 19:53:58 +00001102** scratch memory. There are three arguments: A pointer an 8-byte
1103** aligned memory buffer from which the scrach allocations will be
1104** drawn, the size of each scratch allocation (sz),
1105** and the maximum number of scratch allocations (N). The sz
drh0a60a382008-07-31 17:16:05 +00001106** argument must be a multiple of 16. The sz parameter should be a few bytes
drh6860da02009-06-09 19:53:58 +00001107** larger than the actual scratch space required due to internal overhead.
1108** The first argument should pointer to an 8-byte aligned buffer
1109** of at least sz*N bytes of memory.
drh33589792008-06-18 13:27:46 +00001110** SQLite will use no more than one scratch buffer at once per thread, so
mihailimdb4f2ad2008-06-21 11:20:48 +00001111** N should be set to the expected maximum number of threads. The sz
drh33589792008-06-18 13:27:46 +00001112** parameter should be 6 times the size of the largest database page size.
1113** Scratch buffers are used as part of the btree balance operation. If
1114** The btree balancer needs additional memory beyond what is provided by
1115** scratch buffers or if no scratch buffer space is specified, then SQLite
mihailimdb4f2ad2008-06-21 11:20:48 +00001116** goes to [sqlite3_malloc()] to obtain the memory it needs.</dd>
drh33589792008-06-18 13:27:46 +00001117**
1118** <dt>SQLITE_CONFIG_PAGECACHE</dt>
1119** <dd>This option specifies a static memory buffer that SQLite can use for
drh21614742008-11-18 19:18:08 +00001120** the database page cache with the default page cache implemenation.
1121** This configuration should not be used if an application-define page
1122** cache implementation is loaded using the SQLITE_CONFIG_PCACHE option.
drh6860da02009-06-09 19:53:58 +00001123** There are three arguments to this option: A pointer to 8-byte aligned
mihailimdb4f2ad2008-06-21 11:20:48 +00001124** memory, the size of each page buffer (sz), and the number of pages (N).
drh6860da02009-06-09 19:53:58 +00001125** The sz argument should be the size of the largest database page
1126** (a power of two between 512 and 32768) plus a little extra for each
1127** page header. The page header size is 20 to 40 bytes depending on
1128** the host architecture. It is harmless, apart from the wasted memory,
1129** to make sz a little too large. The first
drh0a60a382008-07-31 17:16:05 +00001130** argument should point to an allocation of at least sz*N bytes of memory.
mihailimdb4f2ad2008-06-21 11:20:48 +00001131** SQLite will use the memory provided by the first argument to satisfy its
1132** memory needs for the first N pages that it adds to cache. If additional
1133** page cache memory is needed beyond what is provided by this option, then
drh0a60a382008-07-31 17:16:05 +00001134** SQLite goes to [sqlite3_malloc()] for the additional storage space.
1135** The implementation might use one or more of the N buffers to hold
drh6860da02009-06-09 19:53:58 +00001136** memory accounting information. The pointer in the first argument must
1137** be aligned to an 8-byte boundary or subsequent behavior of SQLite
1138** will be undefined.</dd>
drh33589792008-06-18 13:27:46 +00001139**
1140** <dt>SQLITE_CONFIG_HEAP</dt>
1141** <dd>This option specifies a static memory buffer that SQLite will use
1142** for all of its dynamic memory allocation needs beyond those provided
1143** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE].
drh6860da02009-06-09 19:53:58 +00001144** There are three arguments: An 8-byte aligned pointer to the memory,
1145** the number of bytes in the memory buffer, and the minimum allocation size.
1146** If the first pointer (the memory pointer) is NULL, then SQLite reverts
drh8a42cbd2008-07-10 18:13:42 +00001147** to using its default memory allocator (the system malloc() implementation),
1148** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. If the
1149** memory pointer is not NULL and either [SQLITE_ENABLE_MEMSYS3] or
1150** [SQLITE_ENABLE_MEMSYS5] are defined, then the alternative memory
drh39bf74a2009-06-09 18:02:10 +00001151** allocator is engaged to handle all of SQLites memory allocation needs.
1152** The first pointer (the memory pointer) must be aligned to an 8-byte
drh6860da02009-06-09 19:53:58 +00001153** boundary or subsequent behavior of SQLite will be undefined.</dd>
drh33589792008-06-18 13:27:46 +00001154**
1155** <dt>SQLITE_CONFIG_MUTEX</dt>
1156** <dd>This option takes a single argument which is a pointer to an
mihailimdb4f2ad2008-06-21 11:20:48 +00001157** instance of the [sqlite3_mutex_methods] structure. The argument specifies
drh33589792008-06-18 13:27:46 +00001158** alternative low-level mutex routines to be used in place
1159** the mutex routines built into SQLite.</dd>
1160**
drh584ff182008-07-14 18:38:17 +00001161** <dt>SQLITE_CONFIG_GETMUTEX</dt>
drh33589792008-06-18 13:27:46 +00001162** <dd>This option takes a single argument which is a pointer to an
1163** instance of the [sqlite3_mutex_methods] structure. The
1164** [sqlite3_mutex_methods]
1165** structure is filled with the currently defined mutex routines.
1166** This option can be used to overload the default mutex allocation
1167** routines with a wrapper used to track mutex usage for performance
1168** profiling or testing, for example.</dd>
drh633e6d52008-07-28 19:34:53 +00001169**
1170** <dt>SQLITE_CONFIG_LOOKASIDE</dt>
1171** <dd>This option takes two arguments that determine the default
drh6aa5f152009-08-19 15:57:07 +00001172** memory allocation lookaside optimization. The first argument is the
drh633e6d52008-07-28 19:34:53 +00001173** size of each lookaside buffer slot and the second is the number of
drh6aa5f152009-08-19 15:57:07 +00001174** slots allocated to each database connection. This option sets the
1175** <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE]
1176** verb to [sqlite3_db_config()] can be used to change the lookaside
1177** configuration on individual connections.</dd>
drh633e6d52008-07-28 19:34:53 +00001178**
drh21614742008-11-18 19:18:08 +00001179** <dt>SQLITE_CONFIG_PCACHE</dt>
1180** <dd>This option takes a single argument which is a pointer to
1181** an [sqlite3_pcache_methods] object. This object specifies the interface
1182** to a custom page cache implementation. SQLite makes a copy of the
1183** object and uses it for page cache memory allocations.</dd>
1184**
1185** <dt>SQLITE_CONFIG_GETPCACHE</dt>
1186** <dd>This option takes a single argument which is a pointer to an
1187** [sqlite3_pcache_methods] object. SQLite copies of the current
1188** page cache implementation into that object.</dd>
1189**
drh633e6d52008-07-28 19:34:53 +00001190** </dl>
mihailima3f64902008-06-21 13:35:56 +00001191*/
drh40257ff2008-06-13 18:24:27 +00001192#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */
1193#define SQLITE_CONFIG_MULTITHREAD 2 /* nil */
1194#define SQLITE_CONFIG_SERIALIZED 3 /* nil */
drhfec00ea2008-06-14 16:56:21 +00001195#define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */
drh33589792008-06-18 13:27:46 +00001196#define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */
1197#define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */
1198#define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */
1199#define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */
1200#define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */
1201#define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */
1202#define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */
shane2479de32008-11-10 18:05:35 +00001203/* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */
drh633e6d52008-07-28 19:34:53 +00001204#define SQLITE_CONFIG_LOOKASIDE 13 /* int int */
danielk1977bc2ca9e2008-11-13 14:28:28 +00001205#define SQLITE_CONFIG_PCACHE 14 /* sqlite3_pcache_methods* */
1206#define SQLITE_CONFIG_GETPCACHE 15 /* sqlite3_pcache_methods* */
danielk19772d340812008-07-24 08:20:40 +00001207
drhe9d1c722008-08-04 20:13:26 +00001208/*
1209** CAPI3REF: Configuration Options {H10170} <S20000>
1210** EXPERIMENTAL
1211**
1212** These constants are the available integer configuration options that
1213** can be passed as the second argument to the [sqlite3_db_config()] interface.
1214**
1215** New configuration options may be added in future releases of SQLite.
1216** Existing configuration options might be discontinued. Applications
1217** should check the return code from [sqlite3_db_config()] to make sure that
1218** the call worked. The [sqlite3_db_config()] interface will return a
1219** non-zero [error code] if a discontinued or unsupported configuration option
1220** is invoked.
1221**
1222** <dl>
1223** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt>
1224** <dd>This option takes three additional arguments that determine the
1225** [lookaside memory allocator] configuration for the [database connection].
1226** The first argument (the third parameter to [sqlite3_db_config()] is a
drh6aa5f152009-08-19 15:57:07 +00001227** pointer to an memory buffer to use for lookaside memory.
drh6860da02009-06-09 19:53:58 +00001228** The first argument may be NULL in which case SQLite will allocate the
1229** lookaside buffer itself using [sqlite3_malloc()]. The second argument is the
drhe9d1c722008-08-04 20:13:26 +00001230** size of each lookaside buffer slot and the third argument is the number of
1231** slots. The size of the buffer in the first argument must be greater than
drh6aa5f152009-08-19 15:57:07 +00001232** or equal to the product of the second and third arguments. The buffer
1233** must be aligned to an 8-byte boundary. If the second argument is not
1234** a multiple of 8, it is internally rounded down to the next smaller
1235** multiple of 8. See also: [SQLITE_CONFIG_LOOKASIDE]</dd>
drhe9d1c722008-08-04 20:13:26 +00001236**
1237** </dl>
1238*/
1239#define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */
1240
drhce5a5a02008-06-10 17:41:44 +00001241
drh673299b2008-06-09 21:57:22 +00001242/*
drhb25f9d82008-07-23 15:40:06 +00001243** CAPI3REF: Enable Or Disable Extended Result Codes {H12200} <S10700>
drh6ed48bf2007-06-14 20:57:18 +00001244**
drh33c1be32008-01-30 16:16:14 +00001245** The sqlite3_extended_result_codes() routine enables or disables the
mihailimefc8e8a2008-06-21 16:47:09 +00001246** [extended result codes] feature of SQLite. The extended result
1247** codes are disabled by default for historical compatibility considerations.
drh6ed48bf2007-06-14 20:57:18 +00001248**
drh8b39db12009-02-18 18:37:58 +00001249** Requirements:
1250** [H12201] [H12202]
drh4ac285a2006-09-15 07:28:50 +00001251*/
1252int sqlite3_extended_result_codes(sqlite3*, int onoff);
1253
1254/*
drh9cd29642008-07-23 00:52:55 +00001255** CAPI3REF: Last Insert Rowid {H12220} <S10700>
drh6ed48bf2007-06-14 20:57:18 +00001256**
drh33c1be32008-01-30 16:16:14 +00001257** Each entry in an SQLite table has a unique 64-bit signed
drh49c3d572008-12-15 22:51:38 +00001258** integer key called the [ROWID | "rowid"]. The rowid is always available
drhfddfa2d2007-12-05 18:05:16 +00001259** as an undeclared column named ROWID, OID, or _ROWID_ as long as those
drh33c1be32008-01-30 16:16:14 +00001260** names are not also used by explicitly declared columns. If
drh49c3d572008-12-15 22:51:38 +00001261** the table has a column of type [INTEGER PRIMARY KEY] then that column
mlcreechb2799412008-03-07 03:20:31 +00001262** is another alias for the rowid.
drh6ed48bf2007-06-14 20:57:18 +00001263**
drh49c3d572008-12-15 22:51:38 +00001264** This routine returns the [rowid] of the most recent
drhf8cecda2008-10-10 23:48:25 +00001265** successful [INSERT] into the database from the [database connection]
1266** in the first argument. If no successful [INSERT]s
mihailimdb4f2ad2008-06-21 11:20:48 +00001267** have ever occurred on that database connection, zero is returned.
drh6ed48bf2007-06-14 20:57:18 +00001268**
drh49c3d572008-12-15 22:51:38 +00001269** If an [INSERT] occurs within a trigger, then the [rowid] of the inserted
mihailimdb4f2ad2008-06-21 11:20:48 +00001270** row is returned by this routine as long as the trigger is running.
1271** But once the trigger terminates, the value returned by this routine
1272** reverts to the last value inserted before the trigger fired.
drhe30f4422007-08-21 16:15:55 +00001273**
drhf8cecda2008-10-10 23:48:25 +00001274** An [INSERT] that fails due to a constraint violation is not a
1275** successful [INSERT] and does not change the value returned by this
drh33c1be32008-01-30 16:16:14 +00001276** routine. Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK,
drhdc1d9f12007-10-27 16:25:16 +00001277** and INSERT OR ABORT make no changes to the return value of this
mihailimdb4f2ad2008-06-21 11:20:48 +00001278** routine when their insertion fails. When INSERT OR REPLACE
drhdc1d9f12007-10-27 16:25:16 +00001279** encounters a constraint violation, it does not fail. The
1280** INSERT continues to completion after deleting rows that caused
1281** the constraint problem so INSERT OR REPLACE will always change
mihailimdb4f2ad2008-06-21 11:20:48 +00001282** the return value of this interface.
drhdc1d9f12007-10-27 16:25:16 +00001283**
drhf8cecda2008-10-10 23:48:25 +00001284** For the purposes of this routine, an [INSERT] is considered to
drh33c1be32008-01-30 16:16:14 +00001285** be successful even if it is subsequently rolled back.
1286**
drh8b39db12009-02-18 18:37:58 +00001287** Requirements:
1288** [H12221] [H12223]
drh33c1be32008-01-30 16:16:14 +00001289**
drh8b39db12009-02-18 18:37:58 +00001290** If a separate thread performs a new [INSERT] on the same
1291** database connection while the [sqlite3_last_insert_rowid()]
1292** function is running and thus changes the last insert [rowid],
1293** then the value returned by [sqlite3_last_insert_rowid()] is
1294** unpredictable and might not equal either the old or the new
1295** last insert [rowid].
drhaf9ff332002-01-16 21:00:27 +00001296*/
drh6d2069d2007-08-14 01:58:53 +00001297sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*);
drhaf9ff332002-01-16 21:00:27 +00001298
drhc8d30ac2002-04-12 10:08:59 +00001299/*
drh9cd29642008-07-23 00:52:55 +00001300** CAPI3REF: Count The Number Of Rows Modified {H12240} <S10600>
drh6ed48bf2007-06-14 20:57:18 +00001301**
drh33c1be32008-01-30 16:16:14 +00001302** This function returns the number of database rows that were changed
drhfddfa2d2007-12-05 18:05:16 +00001303** or inserted or deleted by the most recently completed SQL statement
mihailimdb4f2ad2008-06-21 11:20:48 +00001304** on the [database connection] specified by the first parameter.
drhf8cecda2008-10-10 23:48:25 +00001305** Only changes that are directly specified by the [INSERT], [UPDATE],
1306** or [DELETE] statement are counted. Auxiliary changes caused by
drh33c1be32008-01-30 16:16:14 +00001307** triggers are not counted. Use the [sqlite3_total_changes()] function
drh6ed48bf2007-06-14 20:57:18 +00001308** to find the total number of changes including changes caused by triggers.
1309**
drhd9c20d72009-04-29 14:33:44 +00001310** Changes to a view that are simulated by an [INSTEAD OF trigger]
1311** are not counted. Only real table changes are counted.
1312**
mlcreechb2799412008-03-07 03:20:31 +00001313** A "row change" is a change to a single row of a single table
drh33c1be32008-01-30 16:16:14 +00001314** caused by an INSERT, DELETE, or UPDATE statement. Rows that
drhd9c20d72009-04-29 14:33:44 +00001315** are changed as side effects of [REPLACE] constraint resolution,
1316** rollback, ABORT processing, [DROP TABLE], or by any other
drh33c1be32008-01-30 16:16:14 +00001317** mechanisms do not count as direct row changes.
1318**
1319** A "trigger context" is a scope of execution that begins and
drhd9c20d72009-04-29 14:33:44 +00001320** ends with the script of a [CREATE TRIGGER | trigger].
1321** Most SQL statements are
drh33c1be32008-01-30 16:16:14 +00001322** evaluated outside of any trigger. This is the "top level"
1323** trigger context. If a trigger fires from the top level, a
1324** new trigger context is entered for the duration of that one
1325** trigger. Subtriggers create subcontexts for their duration.
1326**
1327** Calling [sqlite3_exec()] or [sqlite3_step()] recursively does
1328** not create a new trigger context.
1329**
1330** This function returns the number of direct row changes in the
1331** most recent INSERT, UPDATE, or DELETE statement within the same
1332** trigger context.
1333**
mihailimdb4f2ad2008-06-21 11:20:48 +00001334** Thus, when called from the top level, this function returns the
drh33c1be32008-01-30 16:16:14 +00001335** number of changes in the most recent INSERT, UPDATE, or DELETE
mihailimdb4f2ad2008-06-21 11:20:48 +00001336** that also occurred at the top level. Within the body of a trigger,
1337** the sqlite3_changes() interface can be called to find the number of
drh930cc582007-03-28 13:07:40 +00001338** changes in the most recently completed INSERT, UPDATE, or DELETE
drhf5befa02007-12-06 02:42:07 +00001339** statement within the body of the same trigger.
mihailimdb4f2ad2008-06-21 11:20:48 +00001340** However, the number returned does not include changes
1341** caused by subtriggers since those have their own context.
drhc8d30ac2002-04-12 10:08:59 +00001342**
drhd9c20d72009-04-29 14:33:44 +00001343** See also the [sqlite3_total_changes()] interface and the
1344** [count_changes pragma].
drhe30f4422007-08-21 16:15:55 +00001345**
drh8b39db12009-02-18 18:37:58 +00001346** Requirements:
1347** [H12241] [H12243]
drh33c1be32008-01-30 16:16:14 +00001348**
drh8b39db12009-02-18 18:37:58 +00001349** If a separate thread makes changes on the same database connection
1350** while [sqlite3_changes()] is running then the value returned
1351** is unpredictable and not meaningful.
drhc8d30ac2002-04-12 10:08:59 +00001352*/
danielk1977f9d64d22004-06-19 08:18:07 +00001353int sqlite3_changes(sqlite3*);
drhc8d30ac2002-04-12 10:08:59 +00001354
rdcf146a772004-02-25 22:51:06 +00001355/*
drh9cd29642008-07-23 00:52:55 +00001356** CAPI3REF: Total Number Of Rows Modified {H12260} <S10600>
mihailimdb4f2ad2008-06-21 11:20:48 +00001357**
drhd9c20d72009-04-29 14:33:44 +00001358** This function returns the number of row changes caused by [INSERT],
1359** [UPDATE] or [DELETE] statements since the [database connection] was opened.
1360** The count includes all changes from all
1361** [CREATE TRIGGER | trigger] contexts. However,
1362** the count does not include changes used to implement [REPLACE] constraints,
1363** do rollbacks or ABORT processing, or [DROP TABLE] processing. The
drh4fb08662009-05-22 01:02:26 +00001364** count does not include rows of views that fire an [INSTEAD OF trigger],
1365** though if the INSTEAD OF trigger makes changes of its own, those changes
1366** are counted.
mihailimdb4f2ad2008-06-21 11:20:48 +00001367** The changes are counted as soon as the statement that makes them is
1368** completed (when the statement handle is passed to [sqlite3_reset()] or
drh33c1be32008-01-30 16:16:14 +00001369** [sqlite3_finalize()]).
drh6ed48bf2007-06-14 20:57:18 +00001370**
drhd9c20d72009-04-29 14:33:44 +00001371** See also the [sqlite3_changes()] interface and the
1372** [count_changes pragma].
drh33c1be32008-01-30 16:16:14 +00001373**
drh8b39db12009-02-18 18:37:58 +00001374** Requirements:
1375** [H12261] [H12263]
mihailimdb4f2ad2008-06-21 11:20:48 +00001376**
drh8b39db12009-02-18 18:37:58 +00001377** If a separate thread makes changes on the same database connection
1378** while [sqlite3_total_changes()] is running then the value
1379** returned is unpredictable and not meaningful.
rdcf146a772004-02-25 22:51:06 +00001380*/
danielk1977b28af712004-06-21 06:50:26 +00001381int sqlite3_total_changes(sqlite3*);
1382
drh6ed48bf2007-06-14 20:57:18 +00001383/*
drh9cd29642008-07-23 00:52:55 +00001384** CAPI3REF: Interrupt A Long-Running Query {H12270} <S30500>
drh6ed48bf2007-06-14 20:57:18 +00001385**
drh33c1be32008-01-30 16:16:14 +00001386** This function causes any pending database operation to abort and
1387** return at its earliest opportunity. This routine is typically
mihailimebe796c2008-06-21 20:11:17 +00001388** called in response to a user action such as pressing "Cancel"
drh4c504392000-10-16 22:06:40 +00001389** or Ctrl-C where the user wants a long query operation to halt
1390** immediately.
drh930cc582007-03-28 13:07:40 +00001391**
drh33c1be32008-01-30 16:16:14 +00001392** It is safe to call this routine from a thread different from the
1393** thread that is currently running the database operation. But it
mihailimdb4f2ad2008-06-21 11:20:48 +00001394** is not safe to call this routine with a [database connection] that
drh871f6ca2007-08-14 18:03:14 +00001395** is closed or might close before sqlite3_interrupt() returns.
drh6ed48bf2007-06-14 20:57:18 +00001396**
mihailimdb4f2ad2008-06-21 11:20:48 +00001397** If an SQL operation is very nearly finished at the time when
1398** sqlite3_interrupt() is called, then it might not have an opportunity
1399** to be interrupted and might continue to completion.
1400**
1401** An SQL operation that is interrupted will return [SQLITE_INTERRUPT].
1402** If the interrupted SQL operation is an INSERT, UPDATE, or DELETE
1403** that is inside an explicit transaction, then the entire transaction
1404** will be rolled back automatically.
1405**
drhd2b68432009-04-20 12:31:46 +00001406** The sqlite3_interrupt(D) call is in effect until all currently running
1407** SQL statements on [database connection] D complete. Any new SQL statements
1408** that are started after the sqlite3_interrupt() call and before the
1409** running statements reaches zero are interrupted as if they had been
1410** running prior to the sqlite3_interrupt() call. New SQL statements
1411** that are started after the running statement count reaches zero are
1412** not effected by the sqlite3_interrupt().
1413** A call to sqlite3_interrupt(D) that occurs when there are no running
1414** SQL statements is a no-op and has no effect on SQL statements
1415** that are started after the sqlite3_interrupt() call returns.
drh33c1be32008-01-30 16:16:14 +00001416**
drh8b39db12009-02-18 18:37:58 +00001417** Requirements:
1418** [H12271] [H12272]
drh33c1be32008-01-30 16:16:14 +00001419**
drh8b39db12009-02-18 18:37:58 +00001420** If the database connection closes while [sqlite3_interrupt()]
1421** is running then bad things will likely happen.
drh4c504392000-10-16 22:06:40 +00001422*/
danielk1977f9d64d22004-06-19 08:18:07 +00001423void sqlite3_interrupt(sqlite3*);
drh4c504392000-10-16 22:06:40 +00001424
drh6ed48bf2007-06-14 20:57:18 +00001425/*
drh9cd29642008-07-23 00:52:55 +00001426** CAPI3REF: Determine If An SQL Statement Is Complete {H10510} <S70200>
drh75897232000-05-29 14:26:00 +00001427**
drh709915d2009-04-28 04:46:41 +00001428** These routines are useful during command-line input to determine if the
1429** currently entered text seems to form a complete SQL statement or
drhf5befa02007-12-06 02:42:07 +00001430** if additional input is needed before sending the text into
drh709915d2009-04-28 04:46:41 +00001431** SQLite for parsing. These routines return 1 if the input string
drhfddfa2d2007-12-05 18:05:16 +00001432** appears to be a complete SQL statement. A statement is judged to be
drh709915d2009-04-28 04:46:41 +00001433** complete if it ends with a semicolon token and is not a prefix of a
1434** well-formed CREATE TRIGGER statement. Semicolons that are embedded within
drh33c1be32008-01-30 16:16:14 +00001435** string literals or quoted identifier names or comments are not
1436** independent tokens (they are part of the token in which they are
drh709915d2009-04-28 04:46:41 +00001437** embedded) and thus do not count as a statement terminator. Whitespace
1438** and comments that follow the final semicolon are ignored.
1439**
1440** These routines return 0 if the statement is incomplete. If a
1441** memory allocation fails, then SQLITE_NOMEM is returned.
drh33c1be32008-01-30 16:16:14 +00001442**
mihailimdb4f2ad2008-06-21 11:20:48 +00001443** These routines do not parse the SQL statements thus
1444** will not detect syntactically incorrect SQL.
drhfddfa2d2007-12-05 18:05:16 +00001445**
drh709915d2009-04-28 04:46:41 +00001446** If SQLite has not been initialized using [sqlite3_initialize()] prior
1447** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked
1448** automatically by sqlite3_complete16(). If that initialization fails,
1449** then the return value from sqlite3_complete16() will be non-zero
1450** regardless of whether or not the input SQL is complete.
1451**
drh8b39db12009-02-18 18:37:58 +00001452** Requirements: [H10511] [H10512]
drh33c1be32008-01-30 16:16:14 +00001453**
drh8b39db12009-02-18 18:37:58 +00001454** The input to [sqlite3_complete()] must be a zero-terminated
1455** UTF-8 string.
drh33c1be32008-01-30 16:16:14 +00001456**
drh8b39db12009-02-18 18:37:58 +00001457** The input to [sqlite3_complete16()] must be a zero-terminated
1458** UTF-16 string in native byte order.
drh75897232000-05-29 14:26:00 +00001459*/
danielk19776f8a5032004-05-10 10:34:51 +00001460int sqlite3_complete(const char *sql);
danielk197761de0d12004-05-27 23:56:16 +00001461int sqlite3_complete16(const void *sql);
drh75897232000-05-29 14:26:00 +00001462
drh2dfbbca2000-07-28 14:32:48 +00001463/*
drh9cd29642008-07-23 00:52:55 +00001464** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors {H12310} <S40400>
drh6ed48bf2007-06-14 20:57:18 +00001465**
mihailimdb4f2ad2008-06-21 11:20:48 +00001466** This routine sets a callback function that might be invoked whenever
1467** an attempt is made to open a database table that another thread
1468** or process has locked.
1469**
1470** If the busy callback is NULL, then [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED]
1471** is returned immediately upon encountering the lock. If the busy callback
1472** is not NULL, then the callback will be invoked with two arguments.
1473**
1474** The first argument to the handler is a copy of the void* pointer which
1475** is the third argument to sqlite3_busy_handler(). The second argument to
1476** the handler callback is the number of times that the busy handler has
1477** been invoked for this locking event. If the
drh6ed48bf2007-06-14 20:57:18 +00001478** busy callback returns 0, then no additional attempts are made to
1479** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned.
drh33c1be32008-01-30 16:16:14 +00001480** If the callback returns non-zero, then another attempt
drhfddfa2d2007-12-05 18:05:16 +00001481** is made to open the database for reading and the cycle repeats.
drh2dfbbca2000-07-28 14:32:48 +00001482**
mihailimdb4f2ad2008-06-21 11:20:48 +00001483** The presence of a busy handler does not guarantee that it will be invoked
1484** when there is lock contention. If SQLite determines that invoking the busy
1485** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY]
1486** or [SQLITE_IOERR_BLOCKED] instead of invoking the busy handler.
drh86939b52007-01-10 12:54:51 +00001487** Consider a scenario where one process is holding a read lock that
1488** it is trying to promote to a reserved lock and
1489** a second process is holding a reserved lock that it is trying
1490** to promote to an exclusive lock. The first process cannot proceed
1491** because it is blocked by the second and the second process cannot
1492** proceed because it is blocked by the first. If both processes
drhf5befa02007-12-06 02:42:07 +00001493** invoke the busy handlers, neither will make any progress. Therefore,
drh6ed48bf2007-06-14 20:57:18 +00001494** SQLite returns [SQLITE_BUSY] for the first process, hoping that this
drh86939b52007-01-10 12:54:51 +00001495** will induce the first process to release its read lock and allow
1496** the second process to proceed.
1497**
drh33c1be32008-01-30 16:16:14 +00001498** The default busy callback is NULL.
drh2dfbbca2000-07-28 14:32:48 +00001499**
drh33c1be32008-01-30 16:16:14 +00001500** The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED]
drhfddfa2d2007-12-05 18:05:16 +00001501** when SQLite is in the middle of a large transaction where all the
drh33c1be32008-01-30 16:16:14 +00001502** changes will not fit into the in-memory cache. SQLite will
drh6ed48bf2007-06-14 20:57:18 +00001503** already hold a RESERVED lock on the database file, but it needs
1504** to promote this lock to EXCLUSIVE so that it can spill cache
1505** pages into the database file without harm to concurrent
drh33c1be32008-01-30 16:16:14 +00001506** readers. If it is unable to promote the lock, then the in-memory
drh6ed48bf2007-06-14 20:57:18 +00001507** cache will be left in an inconsistent state and so the error
1508** code is promoted from the relatively benign [SQLITE_BUSY] to
drh33c1be32008-01-30 16:16:14 +00001509** the more severe [SQLITE_IOERR_BLOCKED]. This error code promotion
1510** forces an automatic rollback of the changes. See the
mihailimdb4f2ad2008-06-21 11:20:48 +00001511** <a href="/cvstrac/wiki?p=CorruptionFollowingBusyError">
drh6ed48bf2007-06-14 20:57:18 +00001512** CorruptionFollowingBusyError</a> wiki page for a discussion of why
1513** this is important.
mihailimdb4f2ad2008-06-21 11:20:48 +00001514**
1515** There can only be a single busy handler defined for each
1516** [database connection]. Setting a new busy handler clears any
1517** previously set handler. Note that calling [sqlite3_busy_timeout()]
1518** will also set or clear the busy handler.
drhd677b3d2007-08-20 22:48:41 +00001519**
drhc8075422008-09-10 13:09:23 +00001520** The busy callback should not take any actions which modify the
1521** database connection that invoked the busy handler. Any such actions
1522** result in undefined behavior.
1523**
drh8b39db12009-02-18 18:37:58 +00001524** Requirements:
1525** [H12311] [H12312] [H12314] [H12316] [H12318]
drh33c1be32008-01-30 16:16:14 +00001526**
drh8b39db12009-02-18 18:37:58 +00001527** A busy handler must not close the database connection
1528** or [prepared statement] that invoked the busy handler.
drh2dfbbca2000-07-28 14:32:48 +00001529*/
danielk1977f9d64d22004-06-19 08:18:07 +00001530int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*);
drh2dfbbca2000-07-28 14:32:48 +00001531
1532/*
drhb25f9d82008-07-23 15:40:06 +00001533** CAPI3REF: Set A Busy Timeout {H12340} <S40410>
drh6ed48bf2007-06-14 20:57:18 +00001534**
mihailimdb4f2ad2008-06-21 11:20:48 +00001535** This routine sets a [sqlite3_busy_handler | busy handler] that sleeps
1536** for a specified amount of time when a table is locked. The handler
1537** will sleep multiple times until at least "ms" milliseconds of sleeping
drh9a247912008-07-22 18:45:08 +00001538** have accumulated. {H12343} After "ms" milliseconds of sleeping,
mihailimdb4f2ad2008-06-21 11:20:48 +00001539** the handler returns 0 which causes [sqlite3_step()] to return
1540** [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED].
drh2dfbbca2000-07-28 14:32:48 +00001541**
drh33c1be32008-01-30 16:16:14 +00001542** Calling this routine with an argument less than or equal to zero
drh2dfbbca2000-07-28 14:32:48 +00001543** turns off all busy handlers.
drh6ed48bf2007-06-14 20:57:18 +00001544**
mihailimdb4f2ad2008-06-21 11:20:48 +00001545** There can only be a single busy handler for a particular
1546** [database connection] any any given moment. If another busy handler
1547** was defined (using [sqlite3_busy_handler()]) prior to calling
drh6ed48bf2007-06-14 20:57:18 +00001548** this routine, that other busy handler is cleared.
drh33c1be32008-01-30 16:16:14 +00001549**
drh8b39db12009-02-18 18:37:58 +00001550** Requirements:
1551** [H12341] [H12343] [H12344]
drh2dfbbca2000-07-28 14:32:48 +00001552*/
danielk1977f9d64d22004-06-19 08:18:07 +00001553int sqlite3_busy_timeout(sqlite3*, int ms);
drh2dfbbca2000-07-28 14:32:48 +00001554
drhe3710332000-09-29 13:30:53 +00001555/*
drh9cd29642008-07-23 00:52:55 +00001556** CAPI3REF: Convenience Routines For Running Queries {H12370} <S10000>
drh6ed48bf2007-06-14 20:57:18 +00001557**
drh33c1be32008-01-30 16:16:14 +00001558** Definition: A <b>result table</b> is memory data structure created by the
1559** [sqlite3_get_table()] interface. A result table records the
1560** complete query results from one or more queries.
drha18c5682000-10-08 22:20:57 +00001561**
drh33c1be32008-01-30 16:16:14 +00001562** The table conceptually has a number of rows and columns. But
1563** these numbers are not part of the result table itself. These
1564** numbers are obtained separately. Let N be the number of rows
1565** and M be the number of columns.
1566**
mihailimdb4f2ad2008-06-21 11:20:48 +00001567** A result table is an array of pointers to zero-terminated UTF-8 strings.
1568** There are (N+1)*M elements in the array. The first M pointers point
1569** to zero-terminated strings that contain the names of the columns.
1570** The remaining entries all point to query results. NULL values result
1571** in NULL pointers. All other values are in their UTF-8 zero-terminated
1572** string representation as returned by [sqlite3_column_text()].
drh33c1be32008-01-30 16:16:14 +00001573**
mihailimdb4f2ad2008-06-21 11:20:48 +00001574** A result table might consist of one or more memory allocations.
drh33c1be32008-01-30 16:16:14 +00001575** It is not safe to pass a result table directly to [sqlite3_free()].
1576** A result table should be deallocated using [sqlite3_free_table()].
1577**
1578** As an example of the result table format, suppose a query result
1579** is as follows:
drha18c5682000-10-08 22:20:57 +00001580**
drh8bacf972007-08-25 16:21:29 +00001581** <blockquote><pre>
drha18c5682000-10-08 22:20:57 +00001582** Name | Age
1583** -----------------------
1584** Alice | 43
1585** Bob | 28
1586** Cindy | 21
drh8bacf972007-08-25 16:21:29 +00001587** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001588**
drh33c1be32008-01-30 16:16:14 +00001589** There are two column (M==2) and three rows (N==3). Thus the
1590** result table has 8 entries. Suppose the result table is stored
1591** in an array names azResult. Then azResult holds this content:
drha18c5682000-10-08 22:20:57 +00001592**
drh8bacf972007-08-25 16:21:29 +00001593** <blockquote><pre>
1594** azResult&#91;0] = "Name";
1595** azResult&#91;1] = "Age";
1596** azResult&#91;2] = "Alice";
1597** azResult&#91;3] = "43";
1598** azResult&#91;4] = "Bob";
1599** azResult&#91;5] = "28";
1600** azResult&#91;6] = "Cindy";
1601** azResult&#91;7] = "21";
1602** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001603**
drh33c1be32008-01-30 16:16:14 +00001604** The sqlite3_get_table() function evaluates one or more
1605** semicolon-separated SQL statements in the zero-terminated UTF-8
1606** string of its 2nd parameter. It returns a result table to the
1607** pointer given in its 3rd parameter.
drha18c5682000-10-08 22:20:57 +00001608**
mihailimdb4f2ad2008-06-21 11:20:48 +00001609** After the calling function has finished using the result, it should
1610** pass the pointer to the result table to sqlite3_free_table() in order to
1611** release the memory that was malloced. Because of the way the
drh33c1be32008-01-30 16:16:14 +00001612** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling
mihailimdb4f2ad2008-06-21 11:20:48 +00001613** function must not try to call [sqlite3_free()] directly. Only
drh33c1be32008-01-30 16:16:14 +00001614** [sqlite3_free_table()] is able to release the memory properly and safely.
drhe3710332000-09-29 13:30:53 +00001615**
drh33c1be32008-01-30 16:16:14 +00001616** The sqlite3_get_table() interface is implemented as a wrapper around
1617** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access
1618** to any internal data structures of SQLite. It uses only the public
1619** interface defined here. As a consequence, errors that occur in the
1620** wrapper layer outside of the internal [sqlite3_exec()] call are not
mihailimdb4f2ad2008-06-21 11:20:48 +00001621** reflected in subsequent calls to [sqlite3_errcode()] or [sqlite3_errmsg()].
drh33c1be32008-01-30 16:16:14 +00001622**
drh8b39db12009-02-18 18:37:58 +00001623** Requirements:
1624** [H12371] [H12373] [H12374] [H12376] [H12379] [H12382]
drhe3710332000-09-29 13:30:53 +00001625*/
danielk19776f8a5032004-05-10 10:34:51 +00001626int sqlite3_get_table(
drhcf538f42008-06-27 14:51:52 +00001627 sqlite3 *db, /* An open database */
1628 const char *zSql, /* SQL to be evaluated */
1629 char ***pazResult, /* Results of the query */
1630 int *pnRow, /* Number of result rows written here */
1631 int *pnColumn, /* Number of result columns written here */
1632 char **pzErrmsg /* Error msg written here */
drhe3710332000-09-29 13:30:53 +00001633);
danielk19776f8a5032004-05-10 10:34:51 +00001634void sqlite3_free_table(char **result);
drhe3710332000-09-29 13:30:53 +00001635
drha18c5682000-10-08 22:20:57 +00001636/*
drh9cd29642008-07-23 00:52:55 +00001637** CAPI3REF: Formatted String Printing Functions {H17400} <S70000><S20000>
drh6ed48bf2007-06-14 20:57:18 +00001638**
shane7c7c3112009-08-17 15:31:23 +00001639** These routines are work-alikes of the "printf()" family of functions
drh6ed48bf2007-06-14 20:57:18 +00001640** from the standard C library.
1641**
drh33c1be32008-01-30 16:16:14 +00001642** The sqlite3_mprintf() and sqlite3_vmprintf() routines write their
drh6d2069d2007-08-14 01:58:53 +00001643** results into memory obtained from [sqlite3_malloc()].
drh33c1be32008-01-30 16:16:14 +00001644** The strings returned by these two routines should be
mihailim04bcc002008-06-22 10:21:27 +00001645** released by [sqlite3_free()]. Both routines return a
drh6ed48bf2007-06-14 20:57:18 +00001646** NULL pointer if [sqlite3_malloc()] is unable to allocate enough
1647** memory to hold the resulting string.
1648**
drh33c1be32008-01-30 16:16:14 +00001649** In sqlite3_snprintf() routine is similar to "snprintf()" from
drh6ed48bf2007-06-14 20:57:18 +00001650** the standard C library. The result is written into the
1651** buffer supplied as the second parameter whose size is given by
drh33c1be32008-01-30 16:16:14 +00001652** the first parameter. Note that the order of the
drh6ed48bf2007-06-14 20:57:18 +00001653** first two parameters is reversed from snprintf(). This is an
1654** historical accident that cannot be fixed without breaking
drh33c1be32008-01-30 16:16:14 +00001655** backwards compatibility. Note also that sqlite3_snprintf()
drh6ed48bf2007-06-14 20:57:18 +00001656** returns a pointer to its buffer instead of the number of
drh33c1be32008-01-30 16:16:14 +00001657** characters actually written into the buffer. We admit that
drh6ed48bf2007-06-14 20:57:18 +00001658** the number of characters written would be a more useful return
1659** value but we cannot change the implementation of sqlite3_snprintf()
1660** now without breaking compatibility.
1661**
drh33c1be32008-01-30 16:16:14 +00001662** As long as the buffer size is greater than zero, sqlite3_snprintf()
1663** guarantees that the buffer is always zero-terminated. The first
drh6ed48bf2007-06-14 20:57:18 +00001664** parameter "n" is the total size of the buffer, including space for
drh33c1be32008-01-30 16:16:14 +00001665** the zero terminator. So the longest string that can be completely
drh6ed48bf2007-06-14 20:57:18 +00001666** written will be n-1 characters.
1667**
1668** These routines all implement some additional formatting
drh4f26d6c2004-05-26 23:25:30 +00001669** options that are useful for constructing SQL statements.
shane26b34032008-05-23 17:21:09 +00001670** All of the usual printf() formatting options apply. In addition, there
drh153c62c2007-08-24 03:51:33 +00001671** is are "%q", "%Q", and "%z" options.
drh6ed48bf2007-06-14 20:57:18 +00001672**
drh33c1be32008-01-30 16:16:14 +00001673** The %q option works like %s in that it substitutes a null-terminated
drh66b89c82000-11-28 20:47:17 +00001674** string from the argument list. But %q also doubles every '\'' character.
drh33c1be32008-01-30 16:16:14 +00001675** %q is designed for use inside a string literal. By doubling each '\''
drh66b89c82000-11-28 20:47:17 +00001676** character it escapes that character and allows it to be inserted into
drha18c5682000-10-08 22:20:57 +00001677** the string.
1678**
mihailimdb4f2ad2008-06-21 11:20:48 +00001679** For example, assume the string variable zText contains text as follows:
drha18c5682000-10-08 22:20:57 +00001680**
drh6ed48bf2007-06-14 20:57:18 +00001681** <blockquote><pre>
1682** char *zText = "It's a happy day!";
1683** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001684**
drh6ed48bf2007-06-14 20:57:18 +00001685** One can use this text in an SQL statement as follows:
drha18c5682000-10-08 22:20:57 +00001686**
drh6ed48bf2007-06-14 20:57:18 +00001687** <blockquote><pre>
1688** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText);
1689** sqlite3_exec(db, zSQL, 0, 0, 0);
1690** sqlite3_free(zSQL);
1691** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001692**
1693** Because the %q format string is used, the '\'' character in zText
1694** is escaped and the SQL generated is as follows:
1695**
drh6ed48bf2007-06-14 20:57:18 +00001696** <blockquote><pre>
1697** INSERT INTO table1 VALUES('It''s a happy day!')
1698** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001699**
1700** This is correct. Had we used %s instead of %q, the generated SQL
1701** would have looked like this:
1702**
drh6ed48bf2007-06-14 20:57:18 +00001703** <blockquote><pre>
1704** INSERT INTO table1 VALUES('It's a happy day!');
1705** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001706**
mihailimdb4f2ad2008-06-21 11:20:48 +00001707** This second example is an SQL syntax error. As a general rule you should
1708** always use %q instead of %s when inserting text into a string literal.
drh6ed48bf2007-06-14 20:57:18 +00001709**
drh33c1be32008-01-30 16:16:14 +00001710** The %Q option works like %q except it also adds single quotes around
mihailimdb4f2ad2008-06-21 11:20:48 +00001711** the outside of the total string. Additionally, if the parameter in the
1712** argument list is a NULL pointer, %Q substitutes the text "NULL" (without
mihailim04bcc002008-06-22 10:21:27 +00001713** single quotes) in place of the %Q option. So, for example, one could say:
drh6ed48bf2007-06-14 20:57:18 +00001714**
1715** <blockquote><pre>
1716** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText);
1717** sqlite3_exec(db, zSQL, 0, 0, 0);
1718** sqlite3_free(zSQL);
1719** </pre></blockquote>
1720**
1721** The code above will render a correct SQL statement in the zSQL
1722** variable even if the zText variable is a NULL pointer.
drh153c62c2007-08-24 03:51:33 +00001723**
drh33c1be32008-01-30 16:16:14 +00001724** The "%z" formatting option works exactly like "%s" with the
drh153c62c2007-08-24 03:51:33 +00001725** addition that after the string has been read and copied into
drhfddfa2d2007-12-05 18:05:16 +00001726** the result, [sqlite3_free()] is called on the input string. {END}
drh33c1be32008-01-30 16:16:14 +00001727**
drh8b39db12009-02-18 18:37:58 +00001728** Requirements:
1729** [H17403] [H17406] [H17407]
drha18c5682000-10-08 22:20:57 +00001730*/
danielk19776f8a5032004-05-10 10:34:51 +00001731char *sqlite3_mprintf(const char*,...);
1732char *sqlite3_vmprintf(const char*, va_list);
drhfeac5f82004-08-01 00:10:45 +00001733char *sqlite3_snprintf(int,char*,const char*, ...);
drh5191b7e2002-03-08 02:12:00 +00001734
drh28dd4792006-06-26 21:35:44 +00001735/*
drh9cd29642008-07-23 00:52:55 +00001736** CAPI3REF: Memory Allocation Subsystem {H17300} <S20000>
drhd84f9462007-08-15 11:28:56 +00001737**
drh33c1be32008-01-30 16:16:14 +00001738** The SQLite core uses these three routines for all of its own
1739** internal memory allocation needs. "Core" in the previous sentence
drhf5befa02007-12-06 02:42:07 +00001740** does not include operating-system specific VFS implementation. The
shane26b34032008-05-23 17:21:09 +00001741** Windows VFS uses native malloc() and free() for some operations.
drhd64621d2007-11-05 17:54:17 +00001742**
drh33c1be32008-01-30 16:16:14 +00001743** The sqlite3_malloc() routine returns a pointer to a block
drhfddfa2d2007-12-05 18:05:16 +00001744** of memory at least N bytes in length, where N is the parameter.
drh33c1be32008-01-30 16:16:14 +00001745** If sqlite3_malloc() is unable to obtain sufficient free
1746** memory, it returns a NULL pointer. If the parameter N to
drhfddfa2d2007-12-05 18:05:16 +00001747** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns
1748** a NULL pointer.
1749**
drh33c1be32008-01-30 16:16:14 +00001750** Calling sqlite3_free() with a pointer previously returned
drhfddfa2d2007-12-05 18:05:16 +00001751** by sqlite3_malloc() or sqlite3_realloc() releases that memory so
drh33c1be32008-01-30 16:16:14 +00001752** that it might be reused. The sqlite3_free() routine is
drhfddfa2d2007-12-05 18:05:16 +00001753** a no-op if is called with a NULL pointer. Passing a NULL pointer
drh33c1be32008-01-30 16:16:14 +00001754** to sqlite3_free() is harmless. After being freed, memory
drhfddfa2d2007-12-05 18:05:16 +00001755** should neither be read nor written. Even reading previously freed
1756** memory might result in a segmentation fault or other severe error.
drh33c1be32008-01-30 16:16:14 +00001757** Memory corruption, a segmentation fault, or other severe error
drhfddfa2d2007-12-05 18:05:16 +00001758** might result if sqlite3_free() is called with a non-NULL pointer that
drh7b228b32008-10-17 15:10:37 +00001759** was not obtained from sqlite3_malloc() or sqlite3_realloc().
drhfddfa2d2007-12-05 18:05:16 +00001760**
drh33c1be32008-01-30 16:16:14 +00001761** The sqlite3_realloc() interface attempts to resize a
drhfddfa2d2007-12-05 18:05:16 +00001762** prior memory allocation to be at least N bytes, where N is the
1763** second parameter. The memory allocation to be resized is the first
drh33c1be32008-01-30 16:16:14 +00001764** parameter. If the first parameter to sqlite3_realloc()
drhfddfa2d2007-12-05 18:05:16 +00001765** is a NULL pointer then its behavior is identical to calling
1766** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc().
drh33c1be32008-01-30 16:16:14 +00001767** If the second parameter to sqlite3_realloc() is zero or
drhfddfa2d2007-12-05 18:05:16 +00001768** negative then the behavior is exactly the same as calling
1769** sqlite3_free(P) where P is the first parameter to sqlite3_realloc().
mihailimdb4f2ad2008-06-21 11:20:48 +00001770** sqlite3_realloc() returns a pointer to a memory allocation
drhfddfa2d2007-12-05 18:05:16 +00001771** of at least N bytes in size or NULL if sufficient memory is unavailable.
drh33c1be32008-01-30 16:16:14 +00001772** If M is the size of the prior allocation, then min(N,M) bytes
drhfddfa2d2007-12-05 18:05:16 +00001773** of the prior allocation are copied into the beginning of buffer returned
1774** by sqlite3_realloc() and the prior allocation is freed.
drh33c1be32008-01-30 16:16:14 +00001775** If sqlite3_realloc() returns NULL, then the prior allocation
drhfddfa2d2007-12-05 18:05:16 +00001776** is not freed.
1777**
drh33c1be32008-01-30 16:16:14 +00001778** The memory returned by sqlite3_malloc() and sqlite3_realloc()
drhf5befa02007-12-06 02:42:07 +00001779** is always aligned to at least an 8 byte boundary. {END}
1780**
mihailimdb4f2ad2008-06-21 11:20:48 +00001781** The default implementation of the memory allocation subsystem uses
1782** the malloc(), realloc() and free() provided by the standard C library.
drh9a247912008-07-22 18:45:08 +00001783** {H17382} However, if SQLite is compiled with the
mihailimdb4f2ad2008-06-21 11:20:48 +00001784** SQLITE_MEMORY_SIZE=<i>NNN</i> C preprocessor macro (where <i>NNN</i>
1785** is an integer), then SQLite create a static array of at least
1786** <i>NNN</i> bytes in size and uses that array for all of its dynamic
1787** memory allocation needs. {END} Additional memory allocator options
1788** may be added in future releases.
drhd64621d2007-11-05 17:54:17 +00001789**
1790** In SQLite version 3.5.0 and 3.5.1, it was possible to define
1791** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in
1792** implementation of these routines to be omitted. That capability
mihailimdb4f2ad2008-06-21 11:20:48 +00001793** is no longer provided. Only built-in memory allocators can be used.
drh8bacf972007-08-25 16:21:29 +00001794**
shane26b34032008-05-23 17:21:09 +00001795** The Windows OS interface layer calls
drh8bacf972007-08-25 16:21:29 +00001796** the system malloc() and free() directly when converting
1797** filenames between the UTF-8 encoding used by SQLite
shane26b34032008-05-23 17:21:09 +00001798** and whatever filename encoding is used by the particular Windows
drh8bacf972007-08-25 16:21:29 +00001799** installation. Memory allocation errors are detected, but
1800** they are reported back as [SQLITE_CANTOPEN] or
1801** [SQLITE_IOERR] rather than [SQLITE_NOMEM].
drh33c1be32008-01-30 16:16:14 +00001802**
drh8b39db12009-02-18 18:37:58 +00001803** Requirements:
1804** [H17303] [H17304] [H17305] [H17306] [H17310] [H17312] [H17315] [H17318]
1805** [H17321] [H17322] [H17323]
drh33c1be32008-01-30 16:16:14 +00001806**
drh8b39db12009-02-18 18:37:58 +00001807** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()]
1808** must be either NULL or else pointers obtained from a prior
1809** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have
1810** not yet been released.
drh33c1be32008-01-30 16:16:14 +00001811**
drh8b39db12009-02-18 18:37:58 +00001812** The application must not read or write any part of
1813** a block of memory after it has been released using
1814** [sqlite3_free()] or [sqlite3_realloc()].
drh28dd4792006-06-26 21:35:44 +00001815*/
drhf3a65f72007-08-22 20:18:21 +00001816void *sqlite3_malloc(int);
1817void *sqlite3_realloc(void*, int);
drh28dd4792006-06-26 21:35:44 +00001818void sqlite3_free(void*);
1819
drh5191b7e2002-03-08 02:12:00 +00001820/*
drh9cd29642008-07-23 00:52:55 +00001821** CAPI3REF: Memory Allocator Statistics {H17370} <S30210>
drhd84f9462007-08-15 11:28:56 +00001822**
drh33c1be32008-01-30 16:16:14 +00001823** SQLite provides these two interfaces for reporting on the status
1824** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()]
mihailimdb4f2ad2008-06-21 11:20:48 +00001825** routines, which form the built-in memory allocation subsystem.
drhd84f9462007-08-15 11:28:56 +00001826**
drh8b39db12009-02-18 18:37:58 +00001827** Requirements:
1828** [H17371] [H17373] [H17374] [H17375]
drhd84f9462007-08-15 11:28:56 +00001829*/
drh153c62c2007-08-24 03:51:33 +00001830sqlite3_int64 sqlite3_memory_used(void);
1831sqlite3_int64 sqlite3_memory_highwater(int resetFlag);
drhd84f9462007-08-15 11:28:56 +00001832
1833/*
drh9cd29642008-07-23 00:52:55 +00001834** CAPI3REF: Pseudo-Random Number Generator {H17390} <S20000>
drh2fa18682008-03-19 14:15:34 +00001835**
1836** SQLite contains a high-quality pseudo-random number generator (PRNG) used to
drh49c3d572008-12-15 22:51:38 +00001837** select random [ROWID | ROWIDs] when inserting new records into a table that
1838** already uses the largest possible [ROWID]. The PRNG is also used for
drh2fa18682008-03-19 14:15:34 +00001839** the build-in random() and randomblob() SQL functions. This interface allows
shane26b34032008-05-23 17:21:09 +00001840** applications to access the same PRNG for other purposes.
drh2fa18682008-03-19 14:15:34 +00001841**
1842** A call to this routine stores N bytes of randomness into buffer P.
1843**
1844** The first time this routine is invoked (either internally or by
1845** the application) the PRNG is seeded using randomness obtained
1846** from the xRandomness method of the default [sqlite3_vfs] object.
1847** On all subsequent invocations, the pseudo-randomness is generated
1848** internally and without recourse to the [sqlite3_vfs] xRandomness
1849** method.
1850**
drh8b39db12009-02-18 18:37:58 +00001851** Requirements:
1852** [H17392]
drh2fa18682008-03-19 14:15:34 +00001853*/
1854void sqlite3_randomness(int N, void *P);
1855
1856/*
drh9cd29642008-07-23 00:52:55 +00001857** CAPI3REF: Compile-Time Authorization Callbacks {H12500} <S70100>
drhfddfa2d2007-12-05 18:05:16 +00001858**
drh33c1be32008-01-30 16:16:14 +00001859** This routine registers a authorizer callback with a particular
drhf47ce562008-03-20 18:00:49 +00001860** [database connection], supplied in the first argument.
drh6ed48bf2007-06-14 20:57:18 +00001861** The authorizer callback is invoked as SQL statements are being compiled
1862** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()],
drh33c1be32008-01-30 16:16:14 +00001863** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. At various
drh6ed48bf2007-06-14 20:57:18 +00001864** points during the compilation process, as logic is being created
1865** to perform various actions, the authorizer callback is invoked to
drhf5befa02007-12-06 02:42:07 +00001866** see if those actions are allowed. The authorizer callback should
drhf47ce562008-03-20 18:00:49 +00001867** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the
drh6ed48bf2007-06-14 20:57:18 +00001868** specific action but allow the SQL statement to continue to be
1869** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be
mihailima3f64902008-06-21 13:35:56 +00001870** rejected with an error. If the authorizer callback returns
drhf5befa02007-12-06 02:42:07 +00001871** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY]
mihailima3f64902008-06-21 13:35:56 +00001872** then the [sqlite3_prepare_v2()] or equivalent call that triggered
drh33c1be32008-01-30 16:16:14 +00001873** the authorizer will fail with an error message.
drh6ed48bf2007-06-14 20:57:18 +00001874**
drhf5befa02007-12-06 02:42:07 +00001875** When the callback returns [SQLITE_OK], that means the operation
drh33c1be32008-01-30 16:16:14 +00001876** requested is ok. When the callback returns [SQLITE_DENY], the
drhf5befa02007-12-06 02:42:07 +00001877** [sqlite3_prepare_v2()] or equivalent call that triggered the
drh33c1be32008-01-30 16:16:14 +00001878** authorizer will fail with an error message explaining that
drh959b5302009-04-30 15:59:56 +00001879** access is denied.
drh6ed48bf2007-06-14 20:57:18 +00001880**
mihailima3f64902008-06-21 13:35:56 +00001881** The first parameter to the authorizer callback is a copy of the third
1882** parameter to the sqlite3_set_authorizer() interface. The second parameter
1883** to the callback is an integer [SQLITE_COPY | action code] that specifies
1884** the particular action to be authorized. The third through sixth parameters
1885** to the callback are zero-terminated strings that contain additional
1886** details about the action to be authorized.
drh6ed48bf2007-06-14 20:57:18 +00001887**
drh959b5302009-04-30 15:59:56 +00001888** If the action code is [SQLITE_READ]
1889** and the callback returns [SQLITE_IGNORE] then the
1890** [prepared statement] statement is constructed to substitute
1891** a NULL value in place of the table column that would have
1892** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE]
1893** return can be used to deny an untrusted user access to individual
1894** columns of a table.
1895** If the action code is [SQLITE_DELETE] and the callback returns
1896** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the
1897** [truncate optimization] is disabled and all rows are deleted individually.
1898**
drhf47ce562008-03-20 18:00:49 +00001899** An authorizer is used when [sqlite3_prepare | preparing]
mihailimebe796c2008-06-21 20:11:17 +00001900** SQL statements from an untrusted source, to ensure that the SQL statements
1901** do not try to access data they are not allowed to see, or that they do not
1902** try to execute malicious statements that damage the database. For
drh6ed48bf2007-06-14 20:57:18 +00001903** example, an application may allow a user to enter arbitrary
1904** SQL queries for evaluation by a database. But the application does
1905** not want the user to be able to make arbitrary changes to the
1906** database. An authorizer could then be put in place while the
drhf47ce562008-03-20 18:00:49 +00001907** user-entered SQL is being [sqlite3_prepare | prepared] that
1908** disallows everything except [SELECT] statements.
1909**
1910** Applications that need to process SQL from untrusted sources
1911** might also consider lowering resource limits using [sqlite3_limit()]
1912** and limiting database size using the [max_page_count] [PRAGMA]
1913** in addition to using an authorizer.
drh6ed48bf2007-06-14 20:57:18 +00001914**
drh33c1be32008-01-30 16:16:14 +00001915** Only a single authorizer can be in place on a database connection
drh6ed48bf2007-06-14 20:57:18 +00001916** at a time. Each call to sqlite3_set_authorizer overrides the
drh33c1be32008-01-30 16:16:14 +00001917** previous call. Disable the authorizer by installing a NULL callback.
1918** The authorizer is disabled by default.
drh6ed48bf2007-06-14 20:57:18 +00001919**
drhc8075422008-09-10 13:09:23 +00001920** The authorizer callback must not do anything that will modify
1921** the database connection that invoked the authorizer callback.
1922** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
1923** database connections for the meaning of "modify" in this paragraph.
1924**
drh7b37c5d2008-08-12 14:51:29 +00001925** When [sqlite3_prepare_v2()] is used to prepare a statement, the
shane7c7c3112009-08-17 15:31:23 +00001926** statement might be re-prepared during [sqlite3_step()] due to a
drh7b37c5d2008-08-12 14:51:29 +00001927** schema change. Hence, the application should ensure that the
1928** correct authorizer callback remains in place during the [sqlite3_step()].
1929**
mihailima3f64902008-06-21 13:35:56 +00001930** Note that the authorizer callback is invoked only during
drh33c1be32008-01-30 16:16:14 +00001931** [sqlite3_prepare()] or its variants. Authorization is not
drh959b5302009-04-30 15:59:56 +00001932** performed during statement evaluation in [sqlite3_step()], unless
1933** as stated in the previous paragraph, sqlite3_step() invokes
1934** sqlite3_prepare_v2() to reprepare a statement after a schema change.
drh33c1be32008-01-30 16:16:14 +00001935**
drh8b39db12009-02-18 18:37:58 +00001936** Requirements:
1937** [H12501] [H12502] [H12503] [H12504] [H12505] [H12506] [H12507] [H12510]
1938** [H12511] [H12512] [H12520] [H12521] [H12522]
drhed6c8672003-01-12 18:02:16 +00001939*/
danielk19776f8a5032004-05-10 10:34:51 +00001940int sqlite3_set_authorizer(
danielk1977f9d64d22004-06-19 08:18:07 +00001941 sqlite3*,
drhe22a3342003-04-22 20:30:37 +00001942 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
drhe5f9c642003-01-13 23:27:31 +00001943 void *pUserData
drhed6c8672003-01-12 18:02:16 +00001944);
1945
1946/*
drh9cd29642008-07-23 00:52:55 +00001947** CAPI3REF: Authorizer Return Codes {H12590} <H12500>
drh6ed48bf2007-06-14 20:57:18 +00001948**
1949** The [sqlite3_set_authorizer | authorizer callback function] must
1950** return either [SQLITE_OK] or one of these two constants in order
1951** to signal SQLite whether or not the action is permitted. See the
1952** [sqlite3_set_authorizer | authorizer documentation] for additional
1953** information.
1954*/
1955#define SQLITE_DENY 1 /* Abort the SQL statement with an error */
1956#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
1957
1958/*
drh9cd29642008-07-23 00:52:55 +00001959** CAPI3REF: Authorizer Action Codes {H12550} <H12500>
drh6ed48bf2007-06-14 20:57:18 +00001960**
1961** The [sqlite3_set_authorizer()] interface registers a callback function
mihailima3f64902008-06-21 13:35:56 +00001962** that is invoked to authorize certain SQL statement actions. The
drh6ed48bf2007-06-14 20:57:18 +00001963** second parameter to the callback is an integer code that specifies
1964** what action is being authorized. These are the integer action codes that
drh33c1be32008-01-30 16:16:14 +00001965** the authorizer callback may be passed.
drh6ed48bf2007-06-14 20:57:18 +00001966**
mihailima3f64902008-06-21 13:35:56 +00001967** These action code values signify what kind of operation is to be
drh33c1be32008-01-30 16:16:14 +00001968** authorized. The 3rd and 4th parameters to the authorization
drhf5befa02007-12-06 02:42:07 +00001969** callback function will be parameters or NULL depending on which of these
drh33c1be32008-01-30 16:16:14 +00001970** codes is used as the second parameter. The 5th parameter to the
mihailima3f64902008-06-21 13:35:56 +00001971** authorizer callback is the name of the database ("main", "temp",
drh33c1be32008-01-30 16:16:14 +00001972** etc.) if applicable. The 6th parameter to the authorizer callback
drh5cf590c2003-04-24 01:45:04 +00001973** is the name of the inner-most trigger or view that is responsible for
mihailima3f64902008-06-21 13:35:56 +00001974** the access attempt or NULL if this access attempt is directly from
drh6ed48bf2007-06-14 20:57:18 +00001975** top-level SQL code.
drh33c1be32008-01-30 16:16:14 +00001976**
drh8b39db12009-02-18 18:37:58 +00001977** Requirements:
1978** [H12551] [H12552] [H12553] [H12554]
drhed6c8672003-01-12 18:02:16 +00001979*/
drh6ed48bf2007-06-14 20:57:18 +00001980/******************************************* 3rd ************ 4th ***********/
drhe5f9c642003-01-13 23:27:31 +00001981#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */
1982#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */
1983#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */
1984#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +00001985#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00001986#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */
drh77ad4e42003-01-14 02:49:27 +00001987#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00001988#define SQLITE_CREATE_VIEW 8 /* View Name NULL */
1989#define SQLITE_DELETE 9 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +00001990#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00001991#define SQLITE_DROP_TABLE 11 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +00001992#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00001993#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +00001994#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00001995#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */
drh77ad4e42003-01-14 02:49:27 +00001996#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00001997#define SQLITE_DROP_VIEW 17 /* View Name NULL */
1998#define SQLITE_INSERT 18 /* Table Name NULL */
1999#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */
2000#define SQLITE_READ 20 /* Table Name Column Name */
2001#define SQLITE_SELECT 21 /* NULL NULL */
danielk1977ab9b7032008-12-30 06:24:58 +00002002#define SQLITE_TRANSACTION 22 /* Operation NULL */
drhe5f9c642003-01-13 23:27:31 +00002003#define SQLITE_UPDATE 23 /* Table Name Column Name */
drh81e293b2003-06-06 19:00:42 +00002004#define SQLITE_ATTACH 24 /* Filename NULL */
2005#define SQLITE_DETACH 25 /* Database Name NULL */
danielk19771c8c23c2004-11-12 15:53:37 +00002006#define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */
danielk19771d54df82004-11-23 15:41:16 +00002007#define SQLITE_REINDEX 27 /* Index Name NULL */
drhe6e04962005-07-23 02:17:03 +00002008#define SQLITE_ANALYZE 28 /* Table Name NULL */
danielk1977f1a381e2006-06-16 08:01:02 +00002009#define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */
2010#define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */
drh2e904c52008-11-10 23:54:05 +00002011#define SQLITE_FUNCTION 31 /* NULL Function Name */
danielk1977ab9b7032008-12-30 06:24:58 +00002012#define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */
drh6ed48bf2007-06-14 20:57:18 +00002013#define SQLITE_COPY 0 /* No longer used */
drhed6c8672003-01-12 18:02:16 +00002014
2015/*
drh9cd29642008-07-23 00:52:55 +00002016** CAPI3REF: Tracing And Profiling Functions {H12280} <S60400>
drhd5a68d32008-08-04 13:44:57 +00002017** EXPERIMENTAL
drh6ed48bf2007-06-14 20:57:18 +00002018**
2019** These routines register callback functions that can be used for
2020** tracing and profiling the execution of SQL statements.
drhfddfa2d2007-12-05 18:05:16 +00002021**
drh33c1be32008-01-30 16:16:14 +00002022** The callback function registered by sqlite3_trace() is invoked at
2023** various times when an SQL statement is being run by [sqlite3_step()].
2024** The callback returns a UTF-8 rendering of the SQL statement text
2025** as the statement first begins executing. Additional callbacks occur
shane26b34032008-05-23 17:21:09 +00002026** as each triggered subprogram is entered. The callbacks for triggers
drh33c1be32008-01-30 16:16:14 +00002027** contain a UTF-8 SQL comment that identifies the trigger.
mihailima3f64902008-06-21 13:35:56 +00002028**
drh33c1be32008-01-30 16:16:14 +00002029** The callback function registered by sqlite3_profile() is invoked
2030** as each SQL statement finishes. The profile callback contains
2031** the original statement text and an estimate of wall-clock time
2032** of how long that statement took to run.
drh19e2d372005-08-29 23:00:03 +00002033**
drh8b39db12009-02-18 18:37:58 +00002034** Requirements:
2035** [H12281] [H12282] [H12283] [H12284] [H12285] [H12287] [H12288] [H12289]
2036** [H12290]
drh18de4822003-01-16 16:28:53 +00002037*/
shanea79c3cc2008-08-11 17:27:01 +00002038SQLITE_EXPERIMENTAL void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*);
2039SQLITE_EXPERIMENTAL void *sqlite3_profile(sqlite3*,
drh6d2069d2007-08-14 01:58:53 +00002040 void(*xProfile)(void*,const char*,sqlite3_uint64), void*);
drh18de4822003-01-16 16:28:53 +00002041
danielk1977348bb5d2003-10-18 09:37:26 +00002042/*
drh9cd29642008-07-23 00:52:55 +00002043** CAPI3REF: Query Progress Callbacks {H12910} <S60400>
drh6ed48bf2007-06-14 20:57:18 +00002044**
drh33c1be32008-01-30 16:16:14 +00002045** This routine configures a callback function - the
drhfddfa2d2007-12-05 18:05:16 +00002046** progress callback - that is invoked periodically during long
2047** running calls to [sqlite3_exec()], [sqlite3_step()] and
mihailima3f64902008-06-21 13:35:56 +00002048** [sqlite3_get_table()]. An example use for this
drh6ed48bf2007-06-14 20:57:18 +00002049** interface is to keep a GUI updated during a large query.
danielk1977348bb5d2003-10-18 09:37:26 +00002050**
shane236ce972008-05-30 15:35:30 +00002051** If the progress callback returns non-zero, the operation is
drh33c1be32008-01-30 16:16:14 +00002052** interrupted. This feature can be used to implement a
drhc8075422008-09-10 13:09:23 +00002053** "Cancel" button on a GUI progress dialog box.
2054**
2055** The progress handler must not do anything that will modify
2056** the database connection that invoked the progress handler.
2057** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
2058** database connections for the meaning of "modify" in this paragraph.
danielk1977348bb5d2003-10-18 09:37:26 +00002059**
drh8b39db12009-02-18 18:37:58 +00002060** Requirements:
2061** [H12911] [H12912] [H12913] [H12914] [H12915] [H12916] [H12917] [H12918]
drh33c1be32008-01-30 16:16:14 +00002062**
danielk1977348bb5d2003-10-18 09:37:26 +00002063*/
danielk1977f9d64d22004-06-19 08:18:07 +00002064void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
danielk1977348bb5d2003-10-18 09:37:26 +00002065
drhaa940ea2004-01-15 02:44:03 +00002066/*
drh9cd29642008-07-23 00:52:55 +00002067** CAPI3REF: Opening A New Database Connection {H12700} <S40200>
drhaa940ea2004-01-15 02:44:03 +00002068**
mihailima3f64902008-06-21 13:35:56 +00002069** These routines open an SQLite database file whose name is given by the
2070** filename argument. The filename argument is interpreted as UTF-8 for
2071** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte
2072** order for sqlite3_open16(). A [database connection] handle is usually
2073** returned in *ppDb, even if an error occurs. The only exception is that
2074** if SQLite is unable to allocate memory to hold the [sqlite3] object,
2075** a NULL will be written into *ppDb instead of a pointer to the [sqlite3]
2076** object. If the database is opened (and/or created) successfully, then
mihailimefc8e8a2008-06-21 16:47:09 +00002077** [SQLITE_OK] is returned. Otherwise an [error code] is returned. The
mihailima3f64902008-06-21 13:35:56 +00002078** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain
drh4f26d6c2004-05-26 23:25:30 +00002079** an English language description of the error.
drh22fbcb82004-02-01 01:22:50 +00002080**
drh33c1be32008-01-30 16:16:14 +00002081** The default encoding for the database will be UTF-8 if
mihailima3f64902008-06-21 13:35:56 +00002082** sqlite3_open() or sqlite3_open_v2() is called and
2083** UTF-16 in the native byte order if sqlite3_open16() is used.
danielk197765904932004-05-26 06:18:37 +00002084**
drh33c1be32008-01-30 16:16:14 +00002085** Whether or not an error occurs when it is opened, resources
mihailima3f64902008-06-21 13:35:56 +00002086** associated with the [database connection] handle should be released by
2087** passing it to [sqlite3_close()] when it is no longer required.
drh6d2069d2007-08-14 01:58:53 +00002088**
mihailima3f64902008-06-21 13:35:56 +00002089** The sqlite3_open_v2() interface works like sqlite3_open()
shane26b34032008-05-23 17:21:09 +00002090** except that it accepts two additional parameters for additional control
danielk19779a6284c2008-07-10 17:52:49 +00002091** over the new database connection. The flags parameter can take one of
2092** the following three values, optionally combined with the
drhafacce02008-09-02 21:35:03 +00002093** [SQLITE_OPEN_NOMUTEX] or [SQLITE_OPEN_FULLMUTEX] flags:
drh6d2069d2007-08-14 01:58:53 +00002094**
mihailima3f64902008-06-21 13:35:56 +00002095** <dl>
2096** <dt>[SQLITE_OPEN_READONLY]</dt>
2097** <dd>The database is opened in read-only mode. If the database does not
2098** already exist, an error is returned.</dd>
drh6d2069d2007-08-14 01:58:53 +00002099**
mihailima3f64902008-06-21 13:35:56 +00002100** <dt>[SQLITE_OPEN_READWRITE]</dt>
2101** <dd>The database is opened for reading and writing if possible, or reading
2102** only if the file is write protected by the operating system. In either
2103** case the database must already exist, otherwise an error is returned.</dd>
drh9da9d962007-08-28 15:47:44 +00002104**
mihailima3f64902008-06-21 13:35:56 +00002105** <dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt>
2106** <dd>The database is opened for reading and writing, and is creates it if
2107** it does not already exist. This is the behavior that is always used for
2108** sqlite3_open() and sqlite3_open16().</dd>
2109** </dl>
2110**
2111** If the 3rd parameter to sqlite3_open_v2() is not one of the
danielk19779a6284c2008-07-10 17:52:49 +00002112** combinations shown above or one of the combinations shown above combined
drhafacce02008-09-02 21:35:03 +00002113** with the [SQLITE_OPEN_NOMUTEX] or [SQLITE_OPEN_FULLMUTEX] flags,
2114** then the behavior is undefined.
danielk19779a6284c2008-07-10 17:52:49 +00002115**
drhafacce02008-09-02 21:35:03 +00002116** If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection
2117** opens in the multi-thread [threading mode] as long as the single-thread
2118** mode has not been set at compile-time or start-time. If the
2119** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens
2120** in the serialized [threading mode] unless single-thread was
2121** previously selected at compile-time or start-time.
drhd9b97cf2008-04-10 13:38:17 +00002122**
mihailima3f64902008-06-21 13:35:56 +00002123** If the filename is ":memory:", then a private, temporary in-memory database
2124** is created for the connection. This in-memory database will vanish when
2125** the database connection is closed. Future versions of SQLite might
2126** make use of additional special filenames that begin with the ":" character.
2127** It is recommended that when a database filename actually does begin with
2128** a ":" character you should prefix the filename with a pathname such as
2129** "./" to avoid ambiguity.
drh6d2069d2007-08-14 01:58:53 +00002130**
mihailima3f64902008-06-21 13:35:56 +00002131** If the filename is an empty string, then a private, temporary
drh33c1be32008-01-30 16:16:14 +00002132** on-disk database will be created. This private database will be
drh3f3b6352007-09-03 20:32:45 +00002133** automatically deleted as soon as the database connection is closed.
2134**
drh33c1be32008-01-30 16:16:14 +00002135** The fourth parameter to sqlite3_open_v2() is the name of the
mihailima3f64902008-06-21 13:35:56 +00002136** [sqlite3_vfs] object that defines the operating system interface that
2137** the new database connection should use. If the fourth parameter is
2138** a NULL pointer then the default [sqlite3_vfs] object is used.
drh6ed48bf2007-06-14 20:57:18 +00002139**
shane26b34032008-05-23 17:21:09 +00002140** <b>Note to Windows users:</b> The encoding used for the filename argument
mihailima3f64902008-06-21 13:35:56 +00002141** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever
drh9da9d962007-08-28 15:47:44 +00002142** codepage is currently defined. Filenames containing international
2143** characters must be converted to UTF-8 prior to passing them into
mihailima3f64902008-06-21 13:35:56 +00002144** sqlite3_open() or sqlite3_open_v2().
drh33c1be32008-01-30 16:16:14 +00002145**
drh8b39db12009-02-18 18:37:58 +00002146** Requirements:
2147** [H12701] [H12702] [H12703] [H12704] [H12706] [H12707] [H12709] [H12711]
2148** [H12712] [H12713] [H12714] [H12717] [H12719] [H12721] [H12723]
danielk197765904932004-05-26 06:18:37 +00002149*/
2150int sqlite3_open(
2151 const char *filename, /* Database filename (UTF-8) */
danielk19774f057f92004-06-08 00:02:33 +00002152 sqlite3 **ppDb /* OUT: SQLite db handle */
danielk197765904932004-05-26 06:18:37 +00002153);
danielk197765904932004-05-26 06:18:37 +00002154int sqlite3_open16(
2155 const void *filename, /* Database filename (UTF-16) */
danielk19774f057f92004-06-08 00:02:33 +00002156 sqlite3 **ppDb /* OUT: SQLite db handle */
danielk197765904932004-05-26 06:18:37 +00002157);
drh6d2069d2007-08-14 01:58:53 +00002158int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00002159 const char *filename, /* Database filename (UTF-8) */
drh6d2069d2007-08-14 01:58:53 +00002160 sqlite3 **ppDb, /* OUT: SQLite db handle */
2161 int flags, /* Flags */
drhd84f9462007-08-15 11:28:56 +00002162 const char *zVfs /* Name of VFS module to use */
drh6d2069d2007-08-14 01:58:53 +00002163);
danielk1977295ba552004-05-19 10:34:51 +00002164
danielk197765904932004-05-26 06:18:37 +00002165/*
drh9cd29642008-07-23 00:52:55 +00002166** CAPI3REF: Error Codes And Messages {H12800} <S60200>
drh6ed48bf2007-06-14 20:57:18 +00002167**
mihailimefc8e8a2008-06-21 16:47:09 +00002168** The sqlite3_errcode() interface returns the numeric [result code] or
2169** [extended result code] for the most recent failed sqlite3_* API call
2170** associated with a [database connection]. If a prior API call failed
2171** but the most recent API call succeeded, the return value from
drh99dfe5e2008-10-30 15:03:15 +00002172** sqlite3_errcode() is undefined. The sqlite3_extended_errcode()
2173** interface is the same except that it always returns the
2174** [extended result code] even when extended result codes are
2175** disabled.
drh6ed48bf2007-06-14 20:57:18 +00002176**
drh33c1be32008-01-30 16:16:14 +00002177** The sqlite3_errmsg() and sqlite3_errmsg16() return English-language
mihailimebe796c2008-06-21 20:11:17 +00002178** text that describes the error, as either UTF-8 or UTF-16 respectively.
drh33c1be32008-01-30 16:16:14 +00002179** Memory to hold the error message string is managed internally.
mihailimefc8e8a2008-06-21 16:47:09 +00002180** The application does not need to worry about freeing the result.
mlcreech27358862008-03-01 23:34:46 +00002181** However, the error string might be overwritten or deallocated by
drh33c1be32008-01-30 16:16:14 +00002182** subsequent calls to other SQLite interface functions.
danielk197765904932004-05-26 06:18:37 +00002183**
drh2838b472008-11-04 14:48:22 +00002184** When the serialized [threading mode] is in use, it might be the
2185** case that a second error occurs on a separate thread in between
2186** the time of the first error and the call to these interfaces.
2187** When that happens, the second error will be reported since these
2188** interfaces always report the most recent result. To avoid
2189** this, each thread can obtain exclusive use of the [database connection] D
2190** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning
2191** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after
2192** all calls to the interfaces listed here are completed.
2193**
drhd55d57e2008-07-07 17:53:07 +00002194** If an interface fails with SQLITE_MISUSE, that means the interface
2195** was invoked incorrectly by the application. In that case, the
2196** error code and message may or may not be set.
2197**
drh8b39db12009-02-18 18:37:58 +00002198** Requirements:
2199** [H12801] [H12802] [H12803] [H12807] [H12808] [H12809]
danielk197765904932004-05-26 06:18:37 +00002200*/
2201int sqlite3_errcode(sqlite3 *db);
drh99dfe5e2008-10-30 15:03:15 +00002202int sqlite3_extended_errcode(sqlite3 *db);
danielk197765904932004-05-26 06:18:37 +00002203const char *sqlite3_errmsg(sqlite3*);
danielk197765904932004-05-26 06:18:37 +00002204const void *sqlite3_errmsg16(sqlite3*);
2205
2206/*
drh9cd29642008-07-23 00:52:55 +00002207** CAPI3REF: SQL Statement Object {H13000} <H13010>
drh33c1be32008-01-30 16:16:14 +00002208** KEYWORDS: {prepared statement} {prepared statements}
drh6ed48bf2007-06-14 20:57:18 +00002209**
mihailimefc8e8a2008-06-21 16:47:09 +00002210** An instance of this object represents a single SQL statement.
2211** This object is variously known as a "prepared statement" or a
drh6ed48bf2007-06-14 20:57:18 +00002212** "compiled SQL statement" or simply as a "statement".
mihailimefc8e8a2008-06-21 16:47:09 +00002213**
drh6ed48bf2007-06-14 20:57:18 +00002214** The life of a statement object goes something like this:
2215**
2216** <ol>
2217** <li> Create the object using [sqlite3_prepare_v2()] or a related
2218** function.
mihailimefc8e8a2008-06-21 16:47:09 +00002219** <li> Bind values to [host parameters] using the sqlite3_bind_*()
2220** interfaces.
drh6ed48bf2007-06-14 20:57:18 +00002221** <li> Run the SQL by calling [sqlite3_step()] one or more times.
2222** <li> Reset the statement using [sqlite3_reset()] then go back
2223** to step 2. Do this zero or more times.
2224** <li> Destroy the object using [sqlite3_finalize()].
2225** </ol>
2226**
2227** Refer to documentation on individual methods above for additional
2228** information.
danielk197765904932004-05-26 06:18:37 +00002229*/
danielk1977fc57d7b2004-05-26 02:04:57 +00002230typedef struct sqlite3_stmt sqlite3_stmt;
2231
danielk1977e3209e42004-05-20 01:40:18 +00002232/*
drh9cd29642008-07-23 00:52:55 +00002233** CAPI3REF: Run-time Limits {H12760} <S20600>
drhcaa639f2008-03-20 00:32:20 +00002234**
2235** This interface allows the size of various constructs to be limited
2236** on a connection by connection basis. The first parameter is the
2237** [database connection] whose limit is to be set or queried. The
2238** second parameter is one of the [limit categories] that define a
2239** class of constructs to be size limited. The third parameter is the
2240** new limit for that construct. The function returns the old limit.
2241**
2242** If the new limit is a negative number, the limit is unchanged.
drhae1a8802009-02-11 15:04:40 +00002243** For the limit category of SQLITE_LIMIT_XYZ there is a
2244** [limits | hard upper bound]
2245** set by a compile-time C preprocessor macro named
2246** [limits | SQLITE_MAX_XYZ].
drhf47ce562008-03-20 18:00:49 +00002247** (The "_LIMIT_" in the name is changed to "_MAX_".)
2248** Attempts to increase a limit above its hard upper bound are
2249** silently truncated to the hard upper limit.
drhcaa639f2008-03-20 00:32:20 +00002250**
drhbb4957f2008-03-20 14:03:29 +00002251** Run time limits are intended for use in applications that manage
2252** both their own internal database and also databases that are controlled
2253** by untrusted external sources. An example application might be a
drh46f33ef2009-02-11 15:23:35 +00002254** web browser that has its own databases for storing history and
shane26b34032008-05-23 17:21:09 +00002255** separate databases controlled by JavaScript applications downloaded
shane236ce972008-05-30 15:35:30 +00002256** off the Internet. The internal databases can be given the
drhbb4957f2008-03-20 14:03:29 +00002257** large, default limits. Databases managed by external sources can
2258** be given much smaller limits designed to prevent a denial of service
mihailimefc8e8a2008-06-21 16:47:09 +00002259** attack. Developers might also want to use the [sqlite3_set_authorizer()]
drhf47ce562008-03-20 18:00:49 +00002260** interface to further control untrusted SQL. The size of the database
2261** created by an untrusted script can be contained using the
2262** [max_page_count] [PRAGMA].
drhbb4957f2008-03-20 14:03:29 +00002263**
drha911abe2008-07-16 13:29:51 +00002264** New run-time limit categories may be added in future releases.
drhcaa639f2008-03-20 00:32:20 +00002265**
drh8b39db12009-02-18 18:37:58 +00002266** Requirements:
2267** [H12762] [H12766] [H12769]
drhcaa639f2008-03-20 00:32:20 +00002268*/
2269int sqlite3_limit(sqlite3*, int id, int newVal);
2270
2271/*
drh9cd29642008-07-23 00:52:55 +00002272** CAPI3REF: Run-Time Limit Categories {H12790} <H12760>
drhcaa639f2008-03-20 00:32:20 +00002273** KEYWORDS: {limit category} {limit categories}
mihailimefc8e8a2008-06-21 16:47:09 +00002274**
drh46f33ef2009-02-11 15:23:35 +00002275** These constants define various performance limits
2276** that can be lowered at run-time using [sqlite3_limit()].
2277** The synopsis of the meanings of the various limits is shown below.
2278** Additional information is available at [limits | Limits in SQLite].
drhbb4957f2008-03-20 14:03:29 +00002279**
2280** <dl>
2281** <dt>SQLITE_LIMIT_LENGTH</dt>
mihailimefc8e8a2008-06-21 16:47:09 +00002282** <dd>The maximum size of any string or BLOB or table row.<dd>
drhbb4957f2008-03-20 14:03:29 +00002283**
2284** <dt>SQLITE_LIMIT_SQL_LENGTH</dt>
2285** <dd>The maximum length of an SQL statement.</dd>
2286**
2287** <dt>SQLITE_LIMIT_COLUMN</dt>
2288** <dd>The maximum number of columns in a table definition or in the
drh46f33ef2009-02-11 15:23:35 +00002289** result set of a [SELECT] or the maximum number of columns in an index
drhbb4957f2008-03-20 14:03:29 +00002290** or in an ORDER BY or GROUP BY clause.</dd>
2291**
2292** <dt>SQLITE_LIMIT_EXPR_DEPTH</dt>
2293** <dd>The maximum depth of the parse tree on any expression.</dd>
2294**
2295** <dt>SQLITE_LIMIT_COMPOUND_SELECT</dt>
2296** <dd>The maximum number of terms in a compound SELECT statement.</dd>
2297**
2298** <dt>SQLITE_LIMIT_VDBE_OP</dt>
2299** <dd>The maximum number of instructions in a virtual machine program
2300** used to implement an SQL statement.</dd>
2301**
2302** <dt>SQLITE_LIMIT_FUNCTION_ARG</dt>
2303** <dd>The maximum number of arguments on a function.</dd>
2304**
2305** <dt>SQLITE_LIMIT_ATTACHED</dt>
drh46f33ef2009-02-11 15:23:35 +00002306** <dd>The maximum number of [ATTACH | attached databases].</dd>
drhbb4957f2008-03-20 14:03:29 +00002307**
drhbb4957f2008-03-20 14:03:29 +00002308** <dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt>
drh46f33ef2009-02-11 15:23:35 +00002309** <dd>The maximum length of the pattern argument to the [LIKE] or
2310** [GLOB] operators.</dd>
drhbb4957f2008-03-20 14:03:29 +00002311**
2312** <dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt>
2313** <dd>The maximum number of variables in an SQL statement that can
2314** be bound.</dd>
2315** </dl>
drhcaa639f2008-03-20 00:32:20 +00002316*/
2317#define SQLITE_LIMIT_LENGTH 0
2318#define SQLITE_LIMIT_SQL_LENGTH 1
2319#define SQLITE_LIMIT_COLUMN 2
2320#define SQLITE_LIMIT_EXPR_DEPTH 3
2321#define SQLITE_LIMIT_COMPOUND_SELECT 4
2322#define SQLITE_LIMIT_VDBE_OP 5
2323#define SQLITE_LIMIT_FUNCTION_ARG 6
2324#define SQLITE_LIMIT_ATTACHED 7
drhb1a6c3c2008-03-20 16:30:17 +00002325#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8
2326#define SQLITE_LIMIT_VARIABLE_NUMBER 9
drhcaa639f2008-03-20 00:32:20 +00002327
2328/*
drh9cd29642008-07-23 00:52:55 +00002329** CAPI3REF: Compiling An SQL Statement {H13010} <S10000>
mihailimefc8e8a2008-06-21 16:47:09 +00002330** KEYWORDS: {SQL statement compiler}
danielk197765904932004-05-26 06:18:37 +00002331**
drh6ed48bf2007-06-14 20:57:18 +00002332** To execute an SQL query, it must first be compiled into a byte-code
mihailimefc8e8a2008-06-21 16:47:09 +00002333** program using one of these routines.
drh6ed48bf2007-06-14 20:57:18 +00002334**
mihailimefc8e8a2008-06-21 16:47:09 +00002335** The first argument, "db", is a [database connection] obtained from a
drh860e0772009-04-02 18:32:26 +00002336** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or
2337** [sqlite3_open16()]. The database connection must not have been closed.
mihailimefc8e8a2008-06-21 16:47:09 +00002338**
2339** The second argument, "zSql", is the statement to be compiled, encoded
drh6ed48bf2007-06-14 20:57:18 +00002340** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2()
mihailimefc8e8a2008-06-21 16:47:09 +00002341** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2()
mihailim04bcc002008-06-22 10:21:27 +00002342** use UTF-16.
drh21f06722007-07-19 12:41:39 +00002343**
mihailimefc8e8a2008-06-21 16:47:09 +00002344** If the nByte argument is less than zero, then zSql is read up to the
2345** first zero terminator. If nByte is non-negative, then it is the maximum
2346** number of bytes read from zSql. When nByte is non-negative, the
2347** zSql string ends at either the first '\000' or '\u0000' character or
drhb08c2a72008-04-16 00:28:13 +00002348** the nByte-th byte, whichever comes first. If the caller knows
danielk19773a2c8c82008-04-03 14:36:25 +00002349** that the supplied string is nul-terminated, then there is a small
mihailimefc8e8a2008-06-21 16:47:09 +00002350** performance advantage to be gained by passing an nByte parameter that
2351** is equal to the number of bytes in the input string <i>including</i>
mihailim04bcc002008-06-22 10:21:27 +00002352** the nul-terminator bytes.
danielk197765904932004-05-26 06:18:37 +00002353**
drh860e0772009-04-02 18:32:26 +00002354** If pzTail is not NULL then *pzTail is made to point to the first byte
2355** past the end of the first SQL statement in zSql. These routines only
2356** compile the first statement in zSql, so *pzTail is left pointing to
2357** what remains uncompiled.
danielk197765904932004-05-26 06:18:37 +00002358**
drh33c1be32008-01-30 16:16:14 +00002359** *ppStmt is left pointing to a compiled [prepared statement] that can be
mihailimefc8e8a2008-06-21 16:47:09 +00002360** executed using [sqlite3_step()]. If there is an error, *ppStmt is set
2361** to NULL. If the input text contains no SQL (if the input is an empty
2362** string or a comment) then *ppStmt is set to NULL.
drh860e0772009-04-02 18:32:26 +00002363** The calling procedure is responsible for deleting the compiled
mihailimefc8e8a2008-06-21 16:47:09 +00002364** SQL statement using [sqlite3_finalize()] after it has finished with it.
drh860e0772009-04-02 18:32:26 +00002365** ppStmt may not be NULL.
danielk197765904932004-05-26 06:18:37 +00002366**
mihailimefc8e8a2008-06-21 16:47:09 +00002367** On success, [SQLITE_OK] is returned, otherwise an [error code] is returned.
drh6ed48bf2007-06-14 20:57:18 +00002368**
2369** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are
2370** recommended for all new programs. The two older interfaces are retained
2371** for backwards compatibility, but their use is discouraged.
drh33c1be32008-01-30 16:16:14 +00002372** In the "v2" interfaces, the prepared statement
mihailimefc8e8a2008-06-21 16:47:09 +00002373** that is returned (the [sqlite3_stmt] object) contains a copy of the
mihailim04bcc002008-06-22 10:21:27 +00002374** original SQL text. This causes the [sqlite3_step()] interface to
drh6ed48bf2007-06-14 20:57:18 +00002375** behave a differently in two ways:
2376**
2377** <ol>
drh33c1be32008-01-30 16:16:14 +00002378** <li>
drh6ed48bf2007-06-14 20:57:18 +00002379** If the database schema changes, instead of returning [SQLITE_SCHEMA] as it
2380** always used to do, [sqlite3_step()] will automatically recompile the SQL
drh33c1be32008-01-30 16:16:14 +00002381** statement and try to run it again. If the schema has changed in
drhfddfa2d2007-12-05 18:05:16 +00002382** a way that makes the statement no longer valid, [sqlite3_step()] will still
mihailimefc8e8a2008-06-21 16:47:09 +00002383** return [SQLITE_SCHEMA]. But unlike the legacy behavior, [SQLITE_SCHEMA] is
2384** now a fatal error. Calling [sqlite3_prepare_v2()] again will not make the
drh33c1be32008-01-30 16:16:14 +00002385** error go away. Note: use [sqlite3_errmsg()] to find the text
mihailim04bcc002008-06-22 10:21:27 +00002386** of the parsing error that results in an [SQLITE_SCHEMA] return.
drh6ed48bf2007-06-14 20:57:18 +00002387** </li>
2388**
2389** <li>
mihailimefc8e8a2008-06-21 16:47:09 +00002390** When an error occurs, [sqlite3_step()] will return one of the detailed
2391** [error codes] or [extended error codes]. The legacy behavior was that
2392** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code
2393** and you would have to make a second call to [sqlite3_reset()] in order
2394** to find the underlying cause of the problem. With the "v2" prepare
2395** interfaces, the underlying reason for the error is returned immediately.
drh6ed48bf2007-06-14 20:57:18 +00002396** </li>
2397** </ol>
drh33c1be32008-01-30 16:16:14 +00002398**
drh8b39db12009-02-18 18:37:58 +00002399** Requirements:
2400** [H13011] [H13012] [H13013] [H13014] [H13015] [H13016] [H13019] [H13021]
drh33c1be32008-01-30 16:16:14 +00002401**
danielk197765904932004-05-26 06:18:37 +00002402*/
2403int sqlite3_prepare(
2404 sqlite3 *db, /* Database handle */
2405 const char *zSql, /* SQL statement, UTF-8 encoded */
drh21f06722007-07-19 12:41:39 +00002406 int nByte, /* Maximum length of zSql in bytes. */
danielk197765904932004-05-26 06:18:37 +00002407 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2408 const char **pzTail /* OUT: Pointer to unused portion of zSql */
2409);
drh6ed48bf2007-06-14 20:57:18 +00002410int sqlite3_prepare_v2(
2411 sqlite3 *db, /* Database handle */
2412 const char *zSql, /* SQL statement, UTF-8 encoded */
drh21f06722007-07-19 12:41:39 +00002413 int nByte, /* Maximum length of zSql in bytes. */
drh6ed48bf2007-06-14 20:57:18 +00002414 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2415 const char **pzTail /* OUT: Pointer to unused portion of zSql */
2416);
danielk197765904932004-05-26 06:18:37 +00002417int sqlite3_prepare16(
2418 sqlite3 *db, /* Database handle */
2419 const void *zSql, /* SQL statement, UTF-16 encoded */
drh21f06722007-07-19 12:41:39 +00002420 int nByte, /* Maximum length of zSql in bytes. */
danielk197765904932004-05-26 06:18:37 +00002421 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2422 const void **pzTail /* OUT: Pointer to unused portion of zSql */
2423);
drhb900aaf2006-11-09 00:24:53 +00002424int sqlite3_prepare16_v2(
2425 sqlite3 *db, /* Database handle */
2426 const void *zSql, /* SQL statement, UTF-16 encoded */
drh21f06722007-07-19 12:41:39 +00002427 int nByte, /* Maximum length of zSql in bytes. */
drhb900aaf2006-11-09 00:24:53 +00002428 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2429 const void **pzTail /* OUT: Pointer to unused portion of zSql */
2430);
2431
2432/*
drh25ef8f12008-10-02 14:33:56 +00002433** CAPI3REF: Retrieving Statement SQL {H13100} <H13000>
danielk1977d0e2a852007-11-14 06:48:48 +00002434**
mihailimefc8e8a2008-06-21 16:47:09 +00002435** This interface can be used to retrieve a saved copy of the original
2436** SQL text used to create a [prepared statement] if that statement was
2437** compiled using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()].
danielk1977d0e2a852007-11-14 06:48:48 +00002438**
drh8b39db12009-02-18 18:37:58 +00002439** Requirements:
2440** [H13101] [H13102] [H13103]
danielk1977d0e2a852007-11-14 06:48:48 +00002441*/
2442const char *sqlite3_sql(sqlite3_stmt *pStmt);
2443
2444/*
drhb25f9d82008-07-23 15:40:06 +00002445** CAPI3REF: Dynamically Typed Value Object {H15000} <S20200>
drhaa28e142008-03-18 13:47:20 +00002446** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value}
drh6ed48bf2007-06-14 20:57:18 +00002447**
drh33c1be32008-01-30 16:16:14 +00002448** SQLite uses the sqlite3_value object to represent all values
mihailimefc8e8a2008-06-21 16:47:09 +00002449** that can be stored in a database table. SQLite uses dynamic typing
2450** for the values it stores. Values stored in sqlite3_value objects
2451** can be integers, floating point values, strings, BLOBs, or NULL.
drhaa28e142008-03-18 13:47:20 +00002452**
2453** An sqlite3_value object may be either "protected" or "unprotected".
2454** Some interfaces require a protected sqlite3_value. Other interfaces
2455** will accept either a protected or an unprotected sqlite3_value.
mihailimefc8e8a2008-06-21 16:47:09 +00002456** Every interface that accepts sqlite3_value arguments specifies
drhaa28e142008-03-18 13:47:20 +00002457** whether or not it requires a protected sqlite3_value.
2458**
2459** The terms "protected" and "unprotected" refer to whether or not
2460** a mutex is held. A internal mutex is held for a protected
2461** sqlite3_value object but no mutex is held for an unprotected
2462** sqlite3_value object. If SQLite is compiled to be single-threaded
drh4766b292008-06-26 02:53:02 +00002463** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0)
drh4ead1482008-06-26 18:16:05 +00002464** or if SQLite is run in one of reduced mutex modes
2465** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD]
mihailimefc8e8a2008-06-21 16:47:09 +00002466** then there is no distinction between protected and unprotected
2467** sqlite3_value objects and they can be used interchangeably. However,
2468** for maximum code portability it is recommended that applications
2469** still make the distinction between between protected and unprotected
drh4ead1482008-06-26 18:16:05 +00002470** sqlite3_value objects even when not strictly required.
drhaa28e142008-03-18 13:47:20 +00002471**
2472** The sqlite3_value objects that are passed as parameters into the
mihailimefc8e8a2008-06-21 16:47:09 +00002473** implementation of [application-defined SQL functions] are protected.
drhaa28e142008-03-18 13:47:20 +00002474** The sqlite3_value object returned by
2475** [sqlite3_column_value()] is unprotected.
2476** Unprotected sqlite3_value objects may only be used with
mihailimefc8e8a2008-06-21 16:47:09 +00002477** [sqlite3_result_value()] and [sqlite3_bind_value()].
drhce5a5a02008-06-10 17:41:44 +00002478** The [sqlite3_value_blob | sqlite3_value_type()] family of
2479** interfaces require protected sqlite3_value objects.
drhf4479502004-05-27 03:12:53 +00002480*/
drhf4479502004-05-27 03:12:53 +00002481typedef struct Mem sqlite3_value;
2482
2483/*
drhb25f9d82008-07-23 15:40:06 +00002484** CAPI3REF: SQL Function Context Object {H16001} <S20200>
drh4f26d6c2004-05-26 23:25:30 +00002485**
drh6ed48bf2007-06-14 20:57:18 +00002486** The context in which an SQL function executes is stored in an
mihailimefc8e8a2008-06-21 16:47:09 +00002487** sqlite3_context object. A pointer to an sqlite3_context object
2488** is always first parameter to [application-defined SQL functions].
2489** The application-defined SQL function implementation will pass this
2490** pointer through into calls to [sqlite3_result_int | sqlite3_result()],
2491** [sqlite3_aggregate_context()], [sqlite3_user_data()],
2492** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()],
2493** and/or [sqlite3_set_auxdata()].
drh6ed48bf2007-06-14 20:57:18 +00002494*/
2495typedef struct sqlite3_context sqlite3_context;
2496
2497/*
drhb25f9d82008-07-23 15:40:06 +00002498** CAPI3REF: Binding Values To Prepared Statements {H13500} <S70300>
mihailimefc8e8a2008-06-21 16:47:09 +00002499** KEYWORDS: {host parameter} {host parameters} {host parameter name}
mihailimebe796c2008-06-21 20:11:17 +00002500** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding}
drh6ed48bf2007-06-14 20:57:18 +00002501**
mihailimefc8e8a2008-06-21 16:47:09 +00002502** In the SQL strings input to [sqlite3_prepare_v2()] and its variants,
drhaff46972009-02-12 17:07:34 +00002503** literals may be replaced by a [parameter] in one of these forms:
drh6ed48bf2007-06-14 20:57:18 +00002504**
2505** <ul>
2506** <li> ?
2507** <li> ?NNN
drh33c1be32008-01-30 16:16:14 +00002508** <li> :VVV
2509** <li> @VVV
drh6ed48bf2007-06-14 20:57:18 +00002510** <li> $VVV
2511** </ul>
2512**
2513** In the parameter forms shown above NNN is an integer literal,
mihailimefc8e8a2008-06-21 16:47:09 +00002514** and VVV is an alpha-numeric parameter name. The values of these
2515** parameters (also called "host parameter names" or "SQL parameters")
drh6ed48bf2007-06-14 20:57:18 +00002516** can be set using the sqlite3_bind_*() routines defined here.
2517**
mihailimefc8e8a2008-06-21 16:47:09 +00002518** The first argument to the sqlite3_bind_*() routines is always
2519** a pointer to the [sqlite3_stmt] object returned from
2520** [sqlite3_prepare_v2()] or its variants.
2521**
2522** The second argument is the index of the SQL parameter to be set.
2523** The leftmost SQL parameter has an index of 1. When the same named
2524** SQL parameter is used more than once, second and subsequent
2525** occurrences have the same index as the first occurrence.
drh33c1be32008-01-30 16:16:14 +00002526** The index for named parameters can be looked up using the
danielk1977c001fc32008-06-24 09:52:39 +00002527** [sqlite3_bind_parameter_index()] API if desired. The index
drhf5befa02007-12-06 02:42:07 +00002528** for "?NNN" parameters is the value of NNN.
drh4ead1482008-06-26 18:16:05 +00002529** The NNN value must be between 1 and the [sqlite3_limit()]
2530** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999).
drh6ed48bf2007-06-14 20:57:18 +00002531**
drh33c1be32008-01-30 16:16:14 +00002532** The third argument is the value to bind to the parameter.
drh6ed48bf2007-06-14 20:57:18 +00002533**
mihailimefc8e8a2008-06-21 16:47:09 +00002534** In those routines that have a fourth argument, its value is the
2535** number of bytes in the parameter. To be clear: the value is the
2536** number of <u>bytes</u> in the value, not the number of characters.
drh6ed48bf2007-06-14 20:57:18 +00002537** If the fourth parameter is negative, the length of the string is
shane26b34032008-05-23 17:21:09 +00002538** the number of bytes up to the first zero terminator.
drh4f26d6c2004-05-26 23:25:30 +00002539**
drh930cc582007-03-28 13:07:40 +00002540** The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and
drh900dfba2004-07-21 15:21:36 +00002541** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or
drh33c1be32008-01-30 16:16:14 +00002542** string after SQLite has finished with it. If the fifth argument is
2543** the special value [SQLITE_STATIC], then SQLite assumes that the
drhfddfa2d2007-12-05 18:05:16 +00002544** information is in static, unmanaged space and does not need to be freed.
drh33c1be32008-01-30 16:16:14 +00002545** If the fifth argument has the value [SQLITE_TRANSIENT], then
drhfddfa2d2007-12-05 18:05:16 +00002546** SQLite makes its own private copy of the data immediately, before
drh33c1be32008-01-30 16:16:14 +00002547** the sqlite3_bind_*() routine returns.
drh4f26d6c2004-05-26 23:25:30 +00002548**
drh33c1be32008-01-30 16:16:14 +00002549** The sqlite3_bind_zeroblob() routine binds a BLOB of length N that
mihailimefc8e8a2008-06-21 16:47:09 +00002550** is filled with zeroes. A zeroblob uses a fixed amount of memory
2551** (just an integer to hold its size) while it is being processed.
shane26b34032008-05-23 17:21:09 +00002552** Zeroblobs are intended to serve as placeholders for BLOBs whose
mihailimefc8e8a2008-06-21 16:47:09 +00002553** content is later written using
2554** [sqlite3_blob_open | incremental BLOB I/O] routines.
2555** A negative value for the zeroblob results in a zero-length BLOB.
drh6ed48bf2007-06-14 20:57:18 +00002556**
drh33c1be32008-01-30 16:16:14 +00002557** The sqlite3_bind_*() routines must be called after
drh6ed48bf2007-06-14 20:57:18 +00002558** [sqlite3_prepare_v2()] (and its variants) or [sqlite3_reset()] and
drh33c1be32008-01-30 16:16:14 +00002559** before [sqlite3_step()].
drh6ed48bf2007-06-14 20:57:18 +00002560** Bindings are not cleared by the [sqlite3_reset()] routine.
drh33c1be32008-01-30 16:16:14 +00002561** Unbound parameters are interpreted as NULL.
drh6ed48bf2007-06-14 20:57:18 +00002562**
drh33c1be32008-01-30 16:16:14 +00002563** These routines return [SQLITE_OK] on success or an error code if
2564** anything goes wrong. [SQLITE_RANGE] is returned if the parameter
shane26b34032008-05-23 17:21:09 +00002565** index is out of range. [SQLITE_NOMEM] is returned if malloc() fails.
drh33c1be32008-01-30 16:16:14 +00002566** [SQLITE_MISUSE] might be returned if these routines are called on a
drhfddfa2d2007-12-05 18:05:16 +00002567** virtual machine that is the wrong state or which has already been finalized.
drh33c1be32008-01-30 16:16:14 +00002568** Detection of misuse is unreliable. Applications should not depend
2569** on SQLITE_MISUSE returns. SQLITE_MISUSE is intended to indicate a
2570** a logic error in the application. Future versions of SQLite might
2571** panic rather than return SQLITE_MISUSE.
2572**
2573** See also: [sqlite3_bind_parameter_count()],
mihailimefc8e8a2008-06-21 16:47:09 +00002574** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()].
drh33c1be32008-01-30 16:16:14 +00002575**
drh8b39db12009-02-18 18:37:58 +00002576** Requirements:
2577** [H13506] [H13509] [H13512] [H13515] [H13518] [H13521] [H13524] [H13527]
2578** [H13530] [H13533] [H13536] [H13539] [H13542] [H13545] [H13548] [H13551]
drh33c1be32008-01-30 16:16:14 +00002579**
drh4f26d6c2004-05-26 23:25:30 +00002580*/
danielk1977d8123362004-06-12 09:25:12 +00002581int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*));
drhf4479502004-05-27 03:12:53 +00002582int sqlite3_bind_double(sqlite3_stmt*, int, double);
2583int sqlite3_bind_int(sqlite3_stmt*, int, int);
drh6d2069d2007-08-14 01:58:53 +00002584int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64);
drhf4479502004-05-27 03:12:53 +00002585int sqlite3_bind_null(sqlite3_stmt*, int);
danielk1977d8123362004-06-12 09:25:12 +00002586int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*));
2587int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*));
drhf4479502004-05-27 03:12:53 +00002588int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);
drhb026e052007-05-02 01:34:31 +00002589int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n);
drh4f26d6c2004-05-26 23:25:30 +00002590
2591/*
drhb25f9d82008-07-23 15:40:06 +00002592** CAPI3REF: Number Of SQL Parameters {H13600} <S70300>
drh6ed48bf2007-06-14 20:57:18 +00002593**
mihailimefc8e8a2008-06-21 16:47:09 +00002594** This routine can be used to find the number of [SQL parameters]
2595** in a [prepared statement]. SQL parameters are tokens of the
drh33c1be32008-01-30 16:16:14 +00002596** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as
shane26b34032008-05-23 17:21:09 +00002597** placeholders for values that are [sqlite3_bind_blob | bound]
drh33c1be32008-01-30 16:16:14 +00002598** to the parameters at a later time.
drh605264d2007-08-21 15:13:19 +00002599**
mihailim1c492652008-06-21 18:02:16 +00002600** This routine actually returns the index of the largest (rightmost)
mihailimefc8e8a2008-06-21 16:47:09 +00002601** parameter. For all forms except ?NNN, this will correspond to the
2602** number of unique parameters. If parameters of the ?NNN are used,
2603** there may be gaps in the list.
drh33c1be32008-01-30 16:16:14 +00002604**
2605** See also: [sqlite3_bind_blob|sqlite3_bind()],
2606** [sqlite3_bind_parameter_name()], and
2607** [sqlite3_bind_parameter_index()].
2608**
drh8b39db12009-02-18 18:37:58 +00002609** Requirements:
2610** [H13601]
drh75f6a032004-07-15 14:15:00 +00002611*/
2612int sqlite3_bind_parameter_count(sqlite3_stmt*);
2613
2614/*
drhb25f9d82008-07-23 15:40:06 +00002615** CAPI3REF: Name Of A Host Parameter {H13620} <S70300>
drh6ed48bf2007-06-14 20:57:18 +00002616**
drh33c1be32008-01-30 16:16:14 +00002617** This routine returns a pointer to the name of the n-th
mihailimefc8e8a2008-06-21 16:47:09 +00002618** [SQL parameter] in a [prepared statement].
drhe1b3e802008-04-27 22:29:01 +00002619** SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA"
2620** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA"
2621** respectively.
2622** In other words, the initial ":" or "$" or "@" or "?"
drh33c1be32008-01-30 16:16:14 +00002623** is included as part of the name.
mihailimefc8e8a2008-06-21 16:47:09 +00002624** Parameters of the form "?" without a following integer have no name
2625** and are also referred to as "anonymous parameters".
drh6ed48bf2007-06-14 20:57:18 +00002626**
drh33c1be32008-01-30 16:16:14 +00002627** The first host parameter has an index of 1, not 0.
drh6ed48bf2007-06-14 20:57:18 +00002628**
drh33c1be32008-01-30 16:16:14 +00002629** If the value n is out of range or if the n-th parameter is
2630** nameless, then NULL is returned. The returned string is
mihailimefc8e8a2008-06-21 16:47:09 +00002631** always in UTF-8 encoding even if the named parameter was
drhfddfa2d2007-12-05 18:05:16 +00002632** originally specified as UTF-16 in [sqlite3_prepare16()] or
2633** [sqlite3_prepare16_v2()].
drh33c1be32008-01-30 16:16:14 +00002634**
2635** See also: [sqlite3_bind_blob|sqlite3_bind()],
2636** [sqlite3_bind_parameter_count()], and
2637** [sqlite3_bind_parameter_index()].
2638**
drh8b39db12009-02-18 18:37:58 +00002639** Requirements:
2640** [H13621]
drh895d7472004-08-20 16:02:39 +00002641*/
2642const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int);
2643
2644/*
drhb25f9d82008-07-23 15:40:06 +00002645** CAPI3REF: Index Of A Parameter With A Given Name {H13640} <S70300>
drh6ed48bf2007-06-14 20:57:18 +00002646**
drh33c1be32008-01-30 16:16:14 +00002647** Return the index of an SQL parameter given its name. The
2648** index value returned is suitable for use as the second
2649** parameter to [sqlite3_bind_blob|sqlite3_bind()]. A zero
2650** is returned if no matching parameter is found. The parameter
2651** name must be given in UTF-8 even if the original statement
2652** was prepared from UTF-16 text using [sqlite3_prepare16_v2()].
2653**
2654** See also: [sqlite3_bind_blob|sqlite3_bind()],
2655** [sqlite3_bind_parameter_count()], and
2656** [sqlite3_bind_parameter_index()].
2657**
drh8b39db12009-02-18 18:37:58 +00002658** Requirements:
2659** [H13641]
drhfa6bc002004-09-07 16:19:52 +00002660*/
2661int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName);
2662
2663/*
drhb25f9d82008-07-23 15:40:06 +00002664** CAPI3REF: Reset All Bindings On A Prepared Statement {H13660} <S70300>
drh6ed48bf2007-06-14 20:57:18 +00002665**
mihailimefc8e8a2008-06-21 16:47:09 +00002666** Contrary to the intuition of many, [sqlite3_reset()] does not reset
2667** the [sqlite3_bind_blob | bindings] on a [prepared statement].
2668** Use this routine to reset all host parameters to NULL.
drh33c1be32008-01-30 16:16:14 +00002669**
drh8b39db12009-02-18 18:37:58 +00002670** Requirements:
2671** [H13661]
danielk1977600dd0b2005-01-20 01:14:23 +00002672*/
2673int sqlite3_clear_bindings(sqlite3_stmt*);
2674
2675/*
drh9cd29642008-07-23 00:52:55 +00002676** CAPI3REF: Number Of Columns In A Result Set {H13710} <S10700>
drh6ed48bf2007-06-14 20:57:18 +00002677**
mihailimefc8e8a2008-06-21 16:47:09 +00002678** Return the number of columns in the result set returned by the
2679** [prepared statement]. This routine returns 0 if pStmt is an SQL
drh4ead1482008-06-26 18:16:05 +00002680** statement that does not return data (for example an [UPDATE]).
drh33c1be32008-01-30 16:16:14 +00002681**
drh8b39db12009-02-18 18:37:58 +00002682** Requirements:
2683** [H13711]
danielk197765904932004-05-26 06:18:37 +00002684*/
2685int sqlite3_column_count(sqlite3_stmt *pStmt);
2686
2687/*
drh9cd29642008-07-23 00:52:55 +00002688** CAPI3REF: Column Names In A Result Set {H13720} <S10700>
drh6ed48bf2007-06-14 20:57:18 +00002689**
drh33c1be32008-01-30 16:16:14 +00002690** These routines return the name assigned to a particular column
drh4ead1482008-06-26 18:16:05 +00002691** in the result set of a [SELECT] statement. The sqlite3_column_name()
mihailimefc8e8a2008-06-21 16:47:09 +00002692** interface returns a pointer to a zero-terminated UTF-8 string
drhf5befa02007-12-06 02:42:07 +00002693** and sqlite3_column_name16() returns a pointer to a zero-terminated
mihailimefc8e8a2008-06-21 16:47:09 +00002694** UTF-16 string. The first parameter is the [prepared statement]
drh4ead1482008-06-26 18:16:05 +00002695** that implements the [SELECT] statement. The second parameter is the
mihailimefc8e8a2008-06-21 16:47:09 +00002696** column number. The leftmost column is number 0.
drh6ed48bf2007-06-14 20:57:18 +00002697**
mihailimefc8e8a2008-06-21 16:47:09 +00002698** The returned string pointer is valid until either the [prepared statement]
2699** is destroyed by [sqlite3_finalize()] or until the next call to
2700** sqlite3_column_name() or sqlite3_column_name16() on the same column.
drh4a50aac2007-08-23 02:47:53 +00002701**
drh33c1be32008-01-30 16:16:14 +00002702** If sqlite3_malloc() fails during the processing of either routine
drh4a50aac2007-08-23 02:47:53 +00002703** (for example during a conversion from UTF-8 to UTF-16) then a
2704** NULL pointer is returned.
drh33c1be32008-01-30 16:16:14 +00002705**
2706** The name of a result column is the value of the "AS" clause for
2707** that column, if there is an AS clause. If there is no AS clause
2708** then the name of the column is unspecified and may change from
2709** one release of SQLite to the next.
2710**
drh8b39db12009-02-18 18:37:58 +00002711** Requirements:
2712** [H13721] [H13723] [H13724] [H13725] [H13726] [H13727]
danielk197765904932004-05-26 06:18:37 +00002713*/
drh6ed48bf2007-06-14 20:57:18 +00002714const char *sqlite3_column_name(sqlite3_stmt*, int N);
2715const void *sqlite3_column_name16(sqlite3_stmt*, int N);
danielk197765904932004-05-26 06:18:37 +00002716
2717/*
drh9cd29642008-07-23 00:52:55 +00002718** CAPI3REF: Source Of Data In A Query Result {H13740} <S10700>
drh6ed48bf2007-06-14 20:57:18 +00002719**
drh33c1be32008-01-30 16:16:14 +00002720** These routines provide a means to determine what column of what
drh4ead1482008-06-26 18:16:05 +00002721** table in which database a result of a [SELECT] statement comes from.
drh33c1be32008-01-30 16:16:14 +00002722** The name of the database or table or column can be returned as
mihailimebe796c2008-06-21 20:11:17 +00002723** either a UTF-8 or UTF-16 string. The _database_ routines return
drhbf2564f2007-06-21 15:25:05 +00002724** the database name, the _table_ routines return the table name, and
drh33c1be32008-01-30 16:16:14 +00002725** the origin_ routines return the column name.
mihailim1c492652008-06-21 18:02:16 +00002726** The returned string is valid until the [prepared statement] is destroyed
2727** using [sqlite3_finalize()] or until the same information is requested
drhbf2564f2007-06-21 15:25:05 +00002728** again in a different encoding.
2729**
drh33c1be32008-01-30 16:16:14 +00002730** The names returned are the original un-aliased names of the
drhbf2564f2007-06-21 15:25:05 +00002731** database, table, and column.
drh6ed48bf2007-06-14 20:57:18 +00002732**
drh33c1be32008-01-30 16:16:14 +00002733** The first argument to the following calls is a [prepared statement].
mihailim1c492652008-06-21 18:02:16 +00002734** These functions return information about the Nth column returned by
danielk1977955de522006-02-10 02:27:42 +00002735** the statement, where N is the second function argument.
2736**
mihailim1c492652008-06-21 18:02:16 +00002737** If the Nth column returned by the statement is an expression or
2738** subquery and is not a column value, then all of these functions return
2739** NULL. These routine might also return NULL if a memory allocation error
2740** occurs. Otherwise, they return the name of the attached database, table
2741** and column that query result column was extracted from.
danielk1977955de522006-02-10 02:27:42 +00002742**
drh33c1be32008-01-30 16:16:14 +00002743** As with all other SQLite APIs, those postfixed with "16" return
drhfddfa2d2007-12-05 18:05:16 +00002744** UTF-16 encoded strings, the other functions return UTF-8. {END}
danielk19774b1ae992006-02-10 03:06:10 +00002745**
mihailim1c492652008-06-21 18:02:16 +00002746** These APIs are only available if the library was compiled with the
drh4ead1482008-06-26 18:16:05 +00002747** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined.
drh32bc3f62007-08-21 20:25:39 +00002748**
drh4766b292008-06-26 02:53:02 +00002749** {A13751}
drh32bc3f62007-08-21 20:25:39 +00002750** If two or more threads call one or more of these routines against the same
2751** prepared statement and column at the same time then the results are
2752** undefined.
drh33c1be32008-01-30 16:16:14 +00002753**
drh8b39db12009-02-18 18:37:58 +00002754** Requirements:
2755** [H13741] [H13742] [H13743] [H13744] [H13745] [H13746] [H13748]
drh33c1be32008-01-30 16:16:14 +00002756**
drh8b39db12009-02-18 18:37:58 +00002757** If two or more threads call one or more
2758** [sqlite3_column_database_name | column metadata interfaces]
2759** for the same [prepared statement] and result column
2760** at the same time then the results are undefined.
danielk1977955de522006-02-10 02:27:42 +00002761*/
2762const char *sqlite3_column_database_name(sqlite3_stmt*,int);
2763const void *sqlite3_column_database_name16(sqlite3_stmt*,int);
2764const char *sqlite3_column_table_name(sqlite3_stmt*,int);
2765const void *sqlite3_column_table_name16(sqlite3_stmt*,int);
2766const char *sqlite3_column_origin_name(sqlite3_stmt*,int);
2767const void *sqlite3_column_origin_name16(sqlite3_stmt*,int);
2768
2769/*
drh9cd29642008-07-23 00:52:55 +00002770** CAPI3REF: Declared Datatype Of A Query Result {H13760} <S10700>
drh6ed48bf2007-06-14 20:57:18 +00002771**
mihailim1c492652008-06-21 18:02:16 +00002772** The first parameter is a [prepared statement].
drh4ead1482008-06-26 18:16:05 +00002773** If this statement is a [SELECT] statement and the Nth column of the
2774** returned result set of that [SELECT] is a table column (not an
drh6ed48bf2007-06-14 20:57:18 +00002775** expression or subquery) then the declared type of the table
drh33c1be32008-01-30 16:16:14 +00002776** column is returned. If the Nth column of the result set is an
drh6ed48bf2007-06-14 20:57:18 +00002777** expression or subquery, then a NULL pointer is returned.
mihailim1c492652008-06-21 18:02:16 +00002778** The returned string is always UTF-8 encoded. {END}
2779**
2780** For example, given the database schema:
danielk197765904932004-05-26 06:18:37 +00002781**
2782** CREATE TABLE t1(c1 VARIANT);
2783**
mihailim1c492652008-06-21 18:02:16 +00002784** and the following statement to be compiled:
danielk197765904932004-05-26 06:18:37 +00002785**
danielk1977955de522006-02-10 02:27:42 +00002786** SELECT c1 + 1, c1 FROM t1;
danielk197765904932004-05-26 06:18:37 +00002787**
mihailim1c492652008-06-21 18:02:16 +00002788** this routine would return the string "VARIANT" for the second result
2789** column (i==1), and a NULL pointer for the first result column (i==0).
drh6ed48bf2007-06-14 20:57:18 +00002790**
2791** SQLite uses dynamic run-time typing. So just because a column
2792** is declared to contain a particular type does not mean that the
2793** data stored in that column is of the declared type. SQLite is
2794** strongly typed, but the typing is dynamic not static. Type
2795** is associated with individual values, not with the containers
2796** used to hold those values.
drh33c1be32008-01-30 16:16:14 +00002797**
drh8b39db12009-02-18 18:37:58 +00002798** Requirements:
2799** [H13761] [H13762] [H13763]
danielk197765904932004-05-26 06:18:37 +00002800*/
drh33c1be32008-01-30 16:16:14 +00002801const char *sqlite3_column_decltype(sqlite3_stmt*,int);
danielk197765904932004-05-26 06:18:37 +00002802const void *sqlite3_column_decltype16(sqlite3_stmt*,int);
2803
mihailimebe796c2008-06-21 20:11:17 +00002804/*
drh9cd29642008-07-23 00:52:55 +00002805** CAPI3REF: Evaluate An SQL Statement {H13200} <S10000>
danielk1977106bb232004-05-21 10:08:53 +00002806**
mihailim1c492652008-06-21 18:02:16 +00002807** After a [prepared statement] has been prepared using either
2808** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy
2809** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function
2810** must be called one or more times to evaluate the statement.
danielk1977106bb232004-05-21 10:08:53 +00002811**
mihailim1c492652008-06-21 18:02:16 +00002812** The details of the behavior of the sqlite3_step() interface depend
drh6ed48bf2007-06-14 20:57:18 +00002813** on whether the statement was prepared using the newer "v2" interface
2814** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy
2815** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the
2816** new "v2" interface is recommended for new applications but the legacy
2817** interface will continue to be supported.
danielk1977106bb232004-05-21 10:08:53 +00002818**
mihailimebe796c2008-06-21 20:11:17 +00002819** In the legacy interface, the return value will be either [SQLITE_BUSY],
drh6ed48bf2007-06-14 20:57:18 +00002820** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE].
mihailim1c492652008-06-21 18:02:16 +00002821** With the "v2" interface, any of the other [result codes] or
2822** [extended result codes] might be returned as well.
drh6ed48bf2007-06-14 20:57:18 +00002823**
2824** [SQLITE_BUSY] means that the database engine was unable to acquire the
drh4ead1482008-06-26 18:16:05 +00002825** database locks it needs to do its job. If the statement is a [COMMIT]
drh6ed48bf2007-06-14 20:57:18 +00002826** or occurs outside of an explicit transaction, then you can retry the
drh4ead1482008-06-26 18:16:05 +00002827** statement. If the statement is not a [COMMIT] and occurs within a
drh6ed48bf2007-06-14 20:57:18 +00002828** explicit transaction then you should rollback the transaction before
2829** continuing.
2830**
2831** [SQLITE_DONE] means that the statement has finished executing
danielk1977106bb232004-05-21 10:08:53 +00002832** successfully. sqlite3_step() should not be called again on this virtual
drh6ed48bf2007-06-14 20:57:18 +00002833** machine without first calling [sqlite3_reset()] to reset the virtual
2834** machine back to its initial state.
danielk1977106bb232004-05-21 10:08:53 +00002835**
mihailim1c492652008-06-21 18:02:16 +00002836** If the SQL statement being executed returns any data, then [SQLITE_ROW]
2837** is returned each time a new row of data is ready for processing by the
2838** caller. The values may be accessed using the [column access functions].
drh6ed48bf2007-06-14 20:57:18 +00002839** sqlite3_step() is called again to retrieve the next row of data.
mihailim1c492652008-06-21 18:02:16 +00002840**
drh6ed48bf2007-06-14 20:57:18 +00002841** [SQLITE_ERROR] means that a run-time error (such as a constraint
danielk1977106bb232004-05-21 10:08:53 +00002842** violation) has occurred. sqlite3_step() should not be called again on
drh6ed48bf2007-06-14 20:57:18 +00002843** the VM. More information may be found by calling [sqlite3_errmsg()].
mihailim1c492652008-06-21 18:02:16 +00002844** With the legacy interface, a more specific error code (for example,
drh6ed48bf2007-06-14 20:57:18 +00002845** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth)
2846** can be obtained by calling [sqlite3_reset()] on the
drh33c1be32008-01-30 16:16:14 +00002847** [prepared statement]. In the "v2" interface,
drh6ed48bf2007-06-14 20:57:18 +00002848** the more specific error code is returned directly by sqlite3_step().
danielk1977106bb232004-05-21 10:08:53 +00002849**
drh6ed48bf2007-06-14 20:57:18 +00002850** [SQLITE_MISUSE] means that the this routine was called inappropriately.
drh33c1be32008-01-30 16:16:14 +00002851** Perhaps it was called on a [prepared statement] that has
mihailim1c492652008-06-21 18:02:16 +00002852** already been [sqlite3_finalize | finalized] or on one that had
drh6ed48bf2007-06-14 20:57:18 +00002853** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could
2854** be the case that the same database connection is being used by two or
2855** more threads at the same moment in time.
2856**
mihailim1c492652008-06-21 18:02:16 +00002857** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step()
2858** API always returns a generic error code, [SQLITE_ERROR], following any
2859** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call
2860** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the
2861** specific [error codes] that better describes the error.
drh6ed48bf2007-06-14 20:57:18 +00002862** We admit that this is a goofy design. The problem has been fixed
2863** with the "v2" interface. If you prepare all of your SQL statements
2864** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead
mihailim1c492652008-06-21 18:02:16 +00002865** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces,
2866** then the more specific [error codes] are returned directly
drh6ed48bf2007-06-14 20:57:18 +00002867** by sqlite3_step(). The use of the "v2" interface is recommended.
drh33c1be32008-01-30 16:16:14 +00002868**
drh8b39db12009-02-18 18:37:58 +00002869** Requirements:
2870** [H13202] [H15304] [H15306] [H15308] [H15310]
danielk1977106bb232004-05-21 10:08:53 +00002871*/
danielk197717240fd2004-05-26 00:07:25 +00002872int sqlite3_step(sqlite3_stmt*);
danielk1977106bb232004-05-21 10:08:53 +00002873
danielk1977106bb232004-05-21 10:08:53 +00002874/*
drh9cd29642008-07-23 00:52:55 +00002875** CAPI3REF: Number of columns in a result set {H13770} <S10700>
drh6ed48bf2007-06-14 20:57:18 +00002876**
mihailim1c492652008-06-21 18:02:16 +00002877** Returns the number of values in the current row of the result set.
danielk1977106bb232004-05-21 10:08:53 +00002878**
drh8b39db12009-02-18 18:37:58 +00002879** Requirements:
2880** [H13771] [H13772]
danielk1977106bb232004-05-21 10:08:53 +00002881*/
danielk197793d46752004-05-23 13:30:58 +00002882int sqlite3_data_count(sqlite3_stmt *pStmt);
danielk19774adee202004-05-08 08:23:19 +00002883
drh4f26d6c2004-05-26 23:25:30 +00002884/*
drhb25f9d82008-07-23 15:40:06 +00002885** CAPI3REF: Fundamental Datatypes {H10265} <S10110><S10120>
drh33c1be32008-01-30 16:16:14 +00002886** KEYWORDS: SQLITE_TEXT
drh6ed48bf2007-06-14 20:57:18 +00002887**
drh9a247912008-07-22 18:45:08 +00002888** {H10266} Every value in SQLite has one of five fundamental datatypes:
drh6ed48bf2007-06-14 20:57:18 +00002889**
2890** <ul>
2891** <li> 64-bit signed integer
2892** <li> 64-bit IEEE floating point number
2893** <li> string
2894** <li> BLOB
2895** <li> NULL
drhfddfa2d2007-12-05 18:05:16 +00002896** </ul> {END}
drh6ed48bf2007-06-14 20:57:18 +00002897**
2898** These constants are codes for each of those types.
2899**
2900** Note that the SQLITE_TEXT constant was also used in SQLite version 2
2901** for a completely different meaning. Software that links against both
mihailim1c492652008-06-21 18:02:16 +00002902** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not
drh6ed48bf2007-06-14 20:57:18 +00002903** SQLITE_TEXT.
drh4f26d6c2004-05-26 23:25:30 +00002904*/
drh9c054832004-05-31 18:51:57 +00002905#define SQLITE_INTEGER 1
2906#define SQLITE_FLOAT 2
drh9c054832004-05-31 18:51:57 +00002907#define SQLITE_BLOB 4
2908#define SQLITE_NULL 5
drh1e284f42004-10-06 15:52:01 +00002909#ifdef SQLITE_TEXT
2910# undef SQLITE_TEXT
2911#else
2912# define SQLITE_TEXT 3
2913#endif
2914#define SQLITE3_TEXT 3
2915
2916/*
drh9cd29642008-07-23 00:52:55 +00002917** CAPI3REF: Result Values From A Query {H13800} <S10700>
mihailim1c492652008-06-21 18:02:16 +00002918** KEYWORDS: {column access functions}
drh6ed48bf2007-06-14 20:57:18 +00002919**
drh33c1be32008-01-30 16:16:14 +00002920** These routines form the "result set query" interface.
2921**
mihailim1c492652008-06-21 18:02:16 +00002922** These routines return information about a single column of the current
2923** result row of a query. In every case the first argument is a pointer
2924** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*]
2925** that was returned from [sqlite3_prepare_v2()] or one of its variants)
2926** and the second argument is the index of the column for which information
2927** should be returned. The leftmost column of the result set has the index 0.
danielk1977106bb232004-05-21 10:08:53 +00002928**
mihailim1c492652008-06-21 18:02:16 +00002929** If the SQL statement does not currently point to a valid row, or if the
2930** column index is out of range, the result is undefined.
drh32bc3f62007-08-21 20:25:39 +00002931** These routines may only be called when the most recent call to
2932** [sqlite3_step()] has returned [SQLITE_ROW] and neither
mihailim1c492652008-06-21 18:02:16 +00002933** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently.
drh32bc3f62007-08-21 20:25:39 +00002934** If any of these routines are called after [sqlite3_reset()] or
2935** [sqlite3_finalize()] or after [sqlite3_step()] has returned
2936** something other than [SQLITE_ROW], the results are undefined.
2937** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()]
2938** are called from a different thread while any of these routines
mihailim1c492652008-06-21 18:02:16 +00002939** are pending, then the results are undefined.
drh6ed48bf2007-06-14 20:57:18 +00002940**
mihailim1c492652008-06-21 18:02:16 +00002941** The sqlite3_column_type() routine returns the
drh6ed48bf2007-06-14 20:57:18 +00002942** [SQLITE_INTEGER | datatype code] for the initial data type
2943** of the result column. The returned value is one of [SQLITE_INTEGER],
2944** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value
2945** returned by sqlite3_column_type() is only meaningful if no type
2946** conversions have occurred as described below. After a type conversion,
2947** the value returned by sqlite3_column_type() is undefined. Future
2948** versions of SQLite may change the behavior of sqlite3_column_type()
2949** following a type conversion.
2950**
mihailim1c492652008-06-21 18:02:16 +00002951** If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes()
drh6ed48bf2007-06-14 20:57:18 +00002952** routine returns the number of bytes in that BLOB or string.
mihailimebe796c2008-06-21 20:11:17 +00002953** If the result is a UTF-16 string, then sqlite3_column_bytes() converts
drh6ed48bf2007-06-14 20:57:18 +00002954** the string to UTF-8 and then returns the number of bytes.
2955** If the result is a numeric value then sqlite3_column_bytes() uses
mihailimebe796c2008-06-21 20:11:17 +00002956** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns
drh6ed48bf2007-06-14 20:57:18 +00002957** the number of bytes in that string.
2958** The value returned does not include the zero terminator at the end
2959** of the string. For clarity: the value returned is the number of
2960** bytes in the string, not the number of characters.
2961**
drhc0b3abb2007-09-04 12:18:41 +00002962** Strings returned by sqlite3_column_text() and sqlite3_column_text16(),
drh33c1be32008-01-30 16:16:14 +00002963** even empty strings, are always zero terminated. The return
mihailim04bcc002008-06-22 10:21:27 +00002964** value from sqlite3_column_blob() for a zero-length BLOB is an arbitrary
drhc0b3abb2007-09-04 12:18:41 +00002965** pointer, possibly even a NULL pointer.
2966**
drh6ed48bf2007-06-14 20:57:18 +00002967** The sqlite3_column_bytes16() routine is similar to sqlite3_column_bytes()
mihailim1c492652008-06-21 18:02:16 +00002968** but leaves the result in UTF-16 in native byte order instead of UTF-8.
drh6ed48bf2007-06-14 20:57:18 +00002969** The zero terminator is not included in this count.
drh4f26d6c2004-05-26 23:25:30 +00002970**
drhaa28e142008-03-18 13:47:20 +00002971** The object returned by [sqlite3_column_value()] is an
2972** [unprotected sqlite3_value] object. An unprotected sqlite3_value object
2973** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()].
2974** If the [unprotected sqlite3_value] object returned by
2975** [sqlite3_column_value()] is used in any other way, including calls
mihailim1c492652008-06-21 18:02:16 +00002976** to routines like [sqlite3_value_int()], [sqlite3_value_text()],
2977** or [sqlite3_value_bytes()], then the behavior is undefined.
drhaa28e142008-03-18 13:47:20 +00002978**
drh4f26d6c2004-05-26 23:25:30 +00002979** These routines attempt to convert the value where appropriate. For
2980** example, if the internal representation is FLOAT and a text result
mihailim1c492652008-06-21 18:02:16 +00002981** is requested, [sqlite3_snprintf()] is used internally to perform the
2982** conversion automatically. The following table details the conversions
2983** that are applied:
drh4f26d6c2004-05-26 23:25:30 +00002984**
drh6ed48bf2007-06-14 20:57:18 +00002985** <blockquote>
2986** <table border="1">
drh8bacf972007-08-25 16:21:29 +00002987** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion
drh4f26d6c2004-05-26 23:25:30 +00002988**
drh6ed48bf2007-06-14 20:57:18 +00002989** <tr><td> NULL <td> INTEGER <td> Result is 0
2990** <tr><td> NULL <td> FLOAT <td> Result is 0.0
2991** <tr><td> NULL <td> TEXT <td> Result is NULL pointer
2992** <tr><td> NULL <td> BLOB <td> Result is NULL pointer
2993** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float
2994** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer
mihailim1c492652008-06-21 18:02:16 +00002995** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT
drh6ed48bf2007-06-14 20:57:18 +00002996** <tr><td> FLOAT <td> INTEGER <td> Convert from float to integer
2997** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float
2998** <tr><td> FLOAT <td> BLOB <td> Same as FLOAT->TEXT
2999** <tr><td> TEXT <td> INTEGER <td> Use atoi()
3000** <tr><td> TEXT <td> FLOAT <td> Use atof()
3001** <tr><td> TEXT <td> BLOB <td> No change
3002** <tr><td> BLOB <td> INTEGER <td> Convert to TEXT then use atoi()
3003** <tr><td> BLOB <td> FLOAT <td> Convert to TEXT then use atof()
3004** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed
3005** </table>
3006** </blockquote>
drh4f26d6c2004-05-26 23:25:30 +00003007**
drh6ed48bf2007-06-14 20:57:18 +00003008** The table above makes reference to standard C library functions atoi()
3009** and atof(). SQLite does not really use these functions. It has its
shane26b34032008-05-23 17:21:09 +00003010** own equivalent internal routines. The atoi() and atof() names are
drh6ed48bf2007-06-14 20:57:18 +00003011** used in the table for brevity and because they are familiar to most
3012** C programmers.
3013**
3014** Note that when type conversions occur, pointers returned by prior
3015** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or
mihailim1c492652008-06-21 18:02:16 +00003016** sqlite3_column_text16() may be invalidated.
drh6ed48bf2007-06-14 20:57:18 +00003017** Type conversions and pointer invalidations might occur
3018** in the following cases:
3019**
3020** <ul>
mihailim1c492652008-06-21 18:02:16 +00003021** <li> The initial content is a BLOB and sqlite3_column_text() or
3022** sqlite3_column_text16() is called. A zero-terminator might
3023** need to be added to the string.</li>
3024** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or
3025** sqlite3_column_text16() is called. The content must be converted
3026** to UTF-16.</li>
3027** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or
3028** sqlite3_column_text() is called. The content must be converted
3029** to UTF-8.</li>
drh6ed48bf2007-06-14 20:57:18 +00003030** </ul>
3031**
3032** Conversions between UTF-16be and UTF-16le are always done in place and do
3033** not invalidate a prior pointer, though of course the content of the buffer
3034** that the prior pointer points to will have been modified. Other kinds
mihailim1c492652008-06-21 18:02:16 +00003035** of conversion are done in place when it is possible, but sometimes they
3036** are not possible and in those cases prior pointers are invalidated.
drh6ed48bf2007-06-14 20:57:18 +00003037**
3038** The safest and easiest to remember policy is to invoke these routines
3039** in one of the following ways:
3040**
mihailim1c492652008-06-21 18:02:16 +00003041** <ul>
drh6ed48bf2007-06-14 20:57:18 +00003042** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li>
3043** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li>
3044** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li>
mihailim1c492652008-06-21 18:02:16 +00003045** </ul>
drh6ed48bf2007-06-14 20:57:18 +00003046**
mihailim1c492652008-06-21 18:02:16 +00003047** In other words, you should call sqlite3_column_text(),
3048** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result
3049** into the desired format, then invoke sqlite3_column_bytes() or
3050** sqlite3_column_bytes16() to find the size of the result. Do not mix calls
3051** to sqlite3_column_text() or sqlite3_column_blob() with calls to
3052** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16()
3053** with calls to sqlite3_column_bytes().
drh32bc3f62007-08-21 20:25:39 +00003054**
3055** The pointers returned are valid until a type conversion occurs as
3056** described above, or until [sqlite3_step()] or [sqlite3_reset()] or
3057** [sqlite3_finalize()] is called. The memory space used to hold strings
mihailim04bcc002008-06-22 10:21:27 +00003058** and BLOBs is freed automatically. Do <b>not</b> pass the pointers returned
mihailim1c492652008-06-21 18:02:16 +00003059** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into
drh32bc3f62007-08-21 20:25:39 +00003060** [sqlite3_free()].
drh4a50aac2007-08-23 02:47:53 +00003061**
3062** If a memory allocation error occurs during the evaluation of any
3063** of these routines, a default value is returned. The default value
3064** is either the integer 0, the floating point number 0.0, or a NULL
3065** pointer. Subsequent calls to [sqlite3_errcode()] will return
3066** [SQLITE_NOMEM].
drh21ac7f92008-01-31 12:26:49 +00003067**
drh8b39db12009-02-18 18:37:58 +00003068** Requirements:
3069** [H13803] [H13806] [H13809] [H13812] [H13815] [H13818] [H13821] [H13824]
3070** [H13827] [H13830]
danielk1977106bb232004-05-21 10:08:53 +00003071*/
drhf4479502004-05-27 03:12:53 +00003072const void *sqlite3_column_blob(sqlite3_stmt*, int iCol);
3073int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
3074int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
3075double sqlite3_column_double(sqlite3_stmt*, int iCol);
3076int sqlite3_column_int(sqlite3_stmt*, int iCol);
drh6d2069d2007-08-14 01:58:53 +00003077sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol);
drhf4479502004-05-27 03:12:53 +00003078const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol);
3079const void *sqlite3_column_text16(sqlite3_stmt*, int iCol);
drh4f26d6c2004-05-26 23:25:30 +00003080int sqlite3_column_type(sqlite3_stmt*, int iCol);
drh4be8b512006-06-13 23:51:34 +00003081sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol);
danielk19774adee202004-05-08 08:23:19 +00003082
danielk197765904932004-05-26 06:18:37 +00003083/*
drhb25f9d82008-07-23 15:40:06 +00003084** CAPI3REF: Destroy A Prepared Statement Object {H13300} <S70300><S30100>
drh6ed48bf2007-06-14 20:57:18 +00003085**
mihailimebe796c2008-06-21 20:11:17 +00003086** The sqlite3_finalize() function is called to delete a [prepared statement].
3087** If the statement was executed successfully or not executed at all, then
3088** SQLITE_OK is returned. If execution of the statement failed then an
3089** [error code] or [extended error code] is returned.
danielk197765904932004-05-26 06:18:37 +00003090**
3091** This routine can be called at any point during the execution of the
mihailimebe796c2008-06-21 20:11:17 +00003092** [prepared statement]. If the virtual machine has not
drh6ed48bf2007-06-14 20:57:18 +00003093** completed execution when this routine is called, that is like
mihailimebe796c2008-06-21 20:11:17 +00003094** encountering an error or an [sqlite3_interrupt | interrupt].
3095** Incomplete updates may be rolled back and transactions canceled,
3096** depending on the circumstances, and the
drh33c1be32008-01-30 16:16:14 +00003097** [error code] returned will be [SQLITE_ABORT].
3098**
drh8b39db12009-02-18 18:37:58 +00003099** Requirements:
3100** [H11302] [H11304]
danielk197765904932004-05-26 06:18:37 +00003101*/
3102int sqlite3_finalize(sqlite3_stmt *pStmt);
3103
3104/*
drh9cd29642008-07-23 00:52:55 +00003105** CAPI3REF: Reset A Prepared Statement Object {H13330} <S70300>
drh6ed48bf2007-06-14 20:57:18 +00003106**
mihailimebe796c2008-06-21 20:11:17 +00003107** The sqlite3_reset() function is called to reset a [prepared statement]
3108** object back to its initial state, ready to be re-executed.
danielk197765904932004-05-26 06:18:37 +00003109** Any SQL statement variables that had values bound to them using
drh6ed48bf2007-06-14 20:57:18 +00003110** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values.
3111** Use [sqlite3_clear_bindings()] to reset the bindings.
drh33c1be32008-01-30 16:16:14 +00003112**
drh9a247912008-07-22 18:45:08 +00003113** {H11332} The [sqlite3_reset(S)] interface resets the [prepared statement] S
drh33c1be32008-01-30 16:16:14 +00003114** back to the beginning of its program.
3115**
drh9a247912008-07-22 18:45:08 +00003116** {H11334} If the most recent call to [sqlite3_step(S)] for the
drh33c1be32008-01-30 16:16:14 +00003117** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE],
3118** or if [sqlite3_step(S)] has never before been called on S,
3119** then [sqlite3_reset(S)] returns [SQLITE_OK].
3120**
drh9a247912008-07-22 18:45:08 +00003121** {H11336} If the most recent call to [sqlite3_step(S)] for the
drh33c1be32008-01-30 16:16:14 +00003122** [prepared statement] S indicated an error, then
3123** [sqlite3_reset(S)] returns an appropriate [error code].
3124**
drh9a247912008-07-22 18:45:08 +00003125** {H11338} The [sqlite3_reset(S)] interface does not change the values
mihailimebe796c2008-06-21 20:11:17 +00003126** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S.
danielk197765904932004-05-26 06:18:37 +00003127*/
3128int sqlite3_reset(sqlite3_stmt *pStmt);
3129
3130/*
drh9cd29642008-07-23 00:52:55 +00003131** CAPI3REF: Create Or Redefine SQL Functions {H16100} <S20200>
mihailimefc8e8a2008-06-21 16:47:09 +00003132** KEYWORDS: {function creation routines}
3133** KEYWORDS: {application-defined SQL function}
3134** KEYWORDS: {application-defined SQL functions}
drh6ed48bf2007-06-14 20:57:18 +00003135**
mihailimebe796c2008-06-21 20:11:17 +00003136** These two functions (collectively known as "function creation routines")
3137** are used to add SQL functions or aggregates or to redefine the behavior
3138** of existing SQL functions or aggregates. The only difference between the
3139** two is that the second parameter, the name of the (scalar) function or
3140** aggregate, is encoded in UTF-8 for sqlite3_create_function() and UTF-16
3141** for sqlite3_create_function16().
danielk197765904932004-05-26 06:18:37 +00003142**
drh1c3cfc62008-03-08 12:37:30 +00003143** The first parameter is the [database connection] to which the SQL
mihailimebe796c2008-06-21 20:11:17 +00003144** function is to be added. If a single program uses more than one database
3145** connection internally, then SQL functions must be added individually to
3146** each database connection.
danielk197765904932004-05-26 06:18:37 +00003147**
mihailimebe796c2008-06-21 20:11:17 +00003148** The second parameter is the name of the SQL function to be created or
3149** redefined. The length of the name is limited to 255 bytes, exclusive of
3150** the zero-terminator. Note that the name length limit is in bytes, not
drh6ed48bf2007-06-14 20:57:18 +00003151** characters. Any attempt to create a function with a longer name
mihailimebe796c2008-06-21 20:11:17 +00003152** will result in [SQLITE_ERROR] being returned.
drh6ed48bf2007-06-14 20:57:18 +00003153**
drhc8075422008-09-10 13:09:23 +00003154** The third parameter (nArg)
3155** is the number of arguments that the SQL function or
drh97602f82009-05-24 11:07:49 +00003156** aggregate takes. If this parameter is -1, then the SQL function or
3157** aggregate may take any number of arguments between 0 and the limit
3158** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third
drh09943b52009-05-24 21:59:27 +00003159** parameter is less than -1 or greater than 127 then the behavior is
3160** undefined.
danielk197765904932004-05-26 06:18:37 +00003161**
mihailimebe796c2008-06-21 20:11:17 +00003162** The fourth parameter, eTextRep, specifies what
drh6ed48bf2007-06-14 20:57:18 +00003163** [SQLITE_UTF8 | text encoding] this SQL function prefers for
3164** its parameters. Any SQL function implementation should be able to work
3165** work with UTF-8, UTF-16le, or UTF-16be. But some implementations may be
drh6aa5f152009-08-19 15:57:07 +00003166** more efficient with one encoding than another. An application may
drh6d2069d2007-08-14 01:58:53 +00003167** invoke sqlite3_create_function() or sqlite3_create_function16() multiple
drh6ed48bf2007-06-14 20:57:18 +00003168** times with the same function but with different values of eTextRep.
3169** When multiple implementations of the same function are available, SQLite
3170** will pick the one that involves the least amount of data conversion.
mihailimebe796c2008-06-21 20:11:17 +00003171** If there is only a single implementation which does not care what text
3172** encoding is used, then the fourth argument should be [SQLITE_ANY].
drh6ed48bf2007-06-14 20:57:18 +00003173**
mihailimebe796c2008-06-21 20:11:17 +00003174** The fifth parameter is an arbitrary pointer. The implementation of the
3175** function can gain access to this pointer using [sqlite3_user_data()].
danielk1977d02eb1f2004-06-06 09:44:03 +00003176**
danielk197765904932004-05-26 06:18:37 +00003177** The seventh, eighth and ninth parameters, xFunc, xStep and xFinal, are
mihailimebe796c2008-06-21 20:11:17 +00003178** pointers to C-language functions that implement the SQL function or
3179** aggregate. A scalar SQL function requires an implementation of the xFunc
3180** callback only, NULL pointers should be passed as the xStep and xFinal
3181** parameters. An aggregate SQL function requires an implementation of xStep
3182** and xFinal and NULL should be passed for xFunc. To delete an existing
3183** SQL function or aggregate, pass NULL for all three function callbacks.
drh6ed48bf2007-06-14 20:57:18 +00003184**
3185** It is permitted to register multiple implementations of the same
3186** functions with the same name but with either differing numbers of
shane26b34032008-05-23 17:21:09 +00003187** arguments or differing preferred text encodings. SQLite will use
drh6aa5f152009-08-19 15:57:07 +00003188** the implementation that most closely matches the way in which the
drhc8075422008-09-10 13:09:23 +00003189** SQL function is used. A function implementation with a non-negative
3190** nArg parameter is a better match than a function implementation with
3191** a negative nArg. A function where the preferred text encoding
3192** matches the database encoding is a better
3193** match than a function where the encoding is different.
3194** A function where the encoding difference is between UTF16le and UTF16be
3195** is a closer match than a function where the encoding difference is
3196** between UTF8 and UTF16.
3197**
3198** Built-in functions may be overloaded by new application-defined functions.
3199** The first application-defined function with a given name overrides all
3200** built-in functions in the same [database connection] with the same name.
3201** Subsequent application-defined functions of the same name only override
3202** prior application-defined functions that are an exact match for the
3203** number of parameters and preferred encoding.
3204**
3205** An application-defined function is permitted to call other
3206** SQLite interfaces. However, such calls must not
3207** close the database connection nor finalize or reset the prepared
3208** statement in which the function is running.
drh21ac7f92008-01-31 12:26:49 +00003209**
drh8b39db12009-02-18 18:37:58 +00003210** Requirements:
drh09943b52009-05-24 21:59:27 +00003211** [H16103] [H16106] [H16109] [H16112] [H16118] [H16121] [H16127]
drh8b39db12009-02-18 18:37:58 +00003212** [H16130] [H16133] [H16136] [H16139] [H16142]
danielk197765904932004-05-26 06:18:37 +00003213*/
3214int sqlite3_create_function(
drh33c1be32008-01-30 16:16:14 +00003215 sqlite3 *db,
danielk197765904932004-05-26 06:18:37 +00003216 const char *zFunctionName,
3217 int nArg,
3218 int eTextRep,
drh33c1be32008-01-30 16:16:14 +00003219 void *pApp,
danielk197765904932004-05-26 06:18:37 +00003220 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
3221 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
3222 void (*xFinal)(sqlite3_context*)
3223);
3224int sqlite3_create_function16(
drh33c1be32008-01-30 16:16:14 +00003225 sqlite3 *db,
danielk197765904932004-05-26 06:18:37 +00003226 const void *zFunctionName,
3227 int nArg,
3228 int eTextRep,
drh33c1be32008-01-30 16:16:14 +00003229 void *pApp,
danielk197765904932004-05-26 06:18:37 +00003230 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
3231 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
3232 void (*xFinal)(sqlite3_context*)
3233);
3234
3235/*
drh9cd29642008-07-23 00:52:55 +00003236** CAPI3REF: Text Encodings {H10267} <S50200> <H16100>
drh6ed48bf2007-06-14 20:57:18 +00003237**
3238** These constant define integer codes that represent the various
3239** text encodings supported by SQLite.
danielk197765904932004-05-26 06:18:37 +00003240*/
drh6ed48bf2007-06-14 20:57:18 +00003241#define SQLITE_UTF8 1
3242#define SQLITE_UTF16LE 2
3243#define SQLITE_UTF16BE 3
3244#define SQLITE_UTF16 4 /* Use native byte order */
3245#define SQLITE_ANY 5 /* sqlite3_create_function only */
3246#define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */
danielk197765904932004-05-26 06:18:37 +00003247
danielk19770ffba6b2004-05-24 09:10:10 +00003248/*
drhd5a68d32008-08-04 13:44:57 +00003249** CAPI3REF: Deprecated Functions
3250** DEPRECATED
drh6ed48bf2007-06-14 20:57:18 +00003251**
drhd5a68d32008-08-04 13:44:57 +00003252** These functions are [deprecated]. In order to maintain
3253** backwards compatibility with older code, these functions continue
3254** to be supported. However, new applications should avoid
drh6ed48bf2007-06-14 20:57:18 +00003255** the use of these functions. To help encourage people to avoid
shane7ba429a2008-11-10 17:08:49 +00003256** using these functions, we are not going to tell you what they do.
drh6ed48bf2007-06-14 20:57:18 +00003257*/
shaneeec556d2008-10-12 00:27:53 +00003258#ifndef SQLITE_OMIT_DEPRECATED
shanea79c3cc2008-08-11 17:27:01 +00003259SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*);
3260SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*);
3261SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*);
3262SQLITE_DEPRECATED int sqlite3_global_recover(void);
3263SQLITE_DEPRECATED void sqlite3_thread_cleanup(void);
3264SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),void*,sqlite3_int64);
shaneeec556d2008-10-12 00:27:53 +00003265#endif
drh6ed48bf2007-06-14 20:57:18 +00003266
3267/*
drh9cd29642008-07-23 00:52:55 +00003268** CAPI3REF: Obtaining SQL Function Parameter Values {H15100} <S20200>
drh6ed48bf2007-06-14 20:57:18 +00003269**
3270** The C-language implementation of SQL functions and aggregates uses
3271** this set of interface routines to access the parameter values on
3272** the function or aggregate.
3273**
3274** The xFunc (for scalar functions) or xStep (for aggregates) parameters
3275** to [sqlite3_create_function()] and [sqlite3_create_function16()]
3276** define callbacks that implement the SQL functions and aggregates.
3277** The 4th parameter to these callbacks is an array of pointers to
drhaa28e142008-03-18 13:47:20 +00003278** [protected sqlite3_value] objects. There is one [sqlite3_value] object for
drh6ed48bf2007-06-14 20:57:18 +00003279** each parameter to the SQL function. These routines are used to
3280** extract values from the [sqlite3_value] objects.
3281**
drhaa28e142008-03-18 13:47:20 +00003282** These routines work only with [protected sqlite3_value] objects.
3283** Any attempt to use these routines on an [unprotected sqlite3_value]
3284** object results in undefined behavior.
3285**
mihailim1c492652008-06-21 18:02:16 +00003286** These routines work just like the corresponding [column access functions]
3287** except that these routines take a single [protected sqlite3_value] object
3288** pointer instead of a [sqlite3_stmt*] pointer and an integer column number.
drh6ed48bf2007-06-14 20:57:18 +00003289**
mihailimebe796c2008-06-21 20:11:17 +00003290** The sqlite3_value_text16() interface extracts a UTF-16 string
drh6ed48bf2007-06-14 20:57:18 +00003291** in the native byte-order of the host machine. The
3292** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces
mihailimebe796c2008-06-21 20:11:17 +00003293** extract UTF-16 strings as big-endian and little-endian respectively.
drh6ed48bf2007-06-14 20:57:18 +00003294**
3295** The sqlite3_value_numeric_type() interface attempts to apply
3296** numeric affinity to the value. This means that an attempt is
3297** made to convert the value to an integer or floating point. If
drhf5befa02007-12-06 02:42:07 +00003298** such a conversion is possible without loss of information (in other
mihailimebe796c2008-06-21 20:11:17 +00003299** words, if the value is a string that looks like a number)
3300** then the conversion is performed. Otherwise no conversion occurs.
3301** The [SQLITE_INTEGER | datatype] after conversion is returned.
drh6ed48bf2007-06-14 20:57:18 +00003302**
mihailimebe796c2008-06-21 20:11:17 +00003303** Please pay particular attention to the fact that the pointer returned
3304** from [sqlite3_value_blob()], [sqlite3_value_text()], or
drh6ed48bf2007-06-14 20:57:18 +00003305** [sqlite3_value_text16()] can be invalidated by a subsequent call to
drh6d2069d2007-08-14 01:58:53 +00003306** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()],
mihailimebe796c2008-06-21 20:11:17 +00003307** or [sqlite3_value_text16()].
drhe53831d2007-08-17 01:14:38 +00003308**
3309** These routines must be called from the same thread as
drhaa28e142008-03-18 13:47:20 +00003310** the SQL function that supplied the [sqlite3_value*] parameters.
drhf5befa02007-12-06 02:42:07 +00003311**
drh8b39db12009-02-18 18:37:58 +00003312** Requirements:
3313** [H15103] [H15106] [H15109] [H15112] [H15115] [H15118] [H15121] [H15124]
3314** [H15127] [H15130] [H15133] [H15136]
danielk19770ffba6b2004-05-24 09:10:10 +00003315*/
drhf4479502004-05-27 03:12:53 +00003316const void *sqlite3_value_blob(sqlite3_value*);
3317int sqlite3_value_bytes(sqlite3_value*);
3318int sqlite3_value_bytes16(sqlite3_value*);
3319double sqlite3_value_double(sqlite3_value*);
3320int sqlite3_value_int(sqlite3_value*);
drh6d2069d2007-08-14 01:58:53 +00003321sqlite3_int64 sqlite3_value_int64(sqlite3_value*);
drhf4479502004-05-27 03:12:53 +00003322const unsigned char *sqlite3_value_text(sqlite3_value*);
3323const void *sqlite3_value_text16(sqlite3_value*);
danielk1977d8123362004-06-12 09:25:12 +00003324const void *sqlite3_value_text16le(sqlite3_value*);
3325const void *sqlite3_value_text16be(sqlite3_value*);
danielk197793d46752004-05-23 13:30:58 +00003326int sqlite3_value_type(sqlite3_value*);
drh29d72102006-02-09 22:13:41 +00003327int sqlite3_value_numeric_type(sqlite3_value*);
danielk19770ffba6b2004-05-24 09:10:10 +00003328
3329/*
drh9cd29642008-07-23 00:52:55 +00003330** CAPI3REF: Obtain Aggregate Function Context {H16210} <S20200>
drh6ed48bf2007-06-14 20:57:18 +00003331**
3332** The implementation of aggregate SQL functions use this routine to allocate
mihailimebe796c2008-06-21 20:11:17 +00003333** a structure for storing their state.
3334**
3335** The first time the sqlite3_aggregate_context() routine is called for a
3336** particular aggregate, SQLite allocates nBytes of memory, zeroes out that
3337** memory, and returns a pointer to it. On second and subsequent calls to
3338** sqlite3_aggregate_context() for the same aggregate function index,
3339** the same buffer is returned. The implementation of the aggregate can use
3340** the returned buffer to accumulate data.
danielk19770ae8b832004-05-25 12:05:56 +00003341**
drhafc91042008-02-21 02:09:45 +00003342** SQLite automatically frees the allocated buffer when the aggregate
3343** query concludes.
drh6ed48bf2007-06-14 20:57:18 +00003344**
mihailimebe796c2008-06-21 20:11:17 +00003345** The first parameter should be a copy of the
3346** [sqlite3_context | SQL function context] that is the first parameter
3347** to the callback routine that implements the aggregate function.
drhe53831d2007-08-17 01:14:38 +00003348**
3349** This routine must be called from the same thread in which
drh605264d2007-08-21 15:13:19 +00003350** the aggregate SQL function is running.
drhafc91042008-02-21 02:09:45 +00003351**
drh8b39db12009-02-18 18:37:58 +00003352** Requirements:
3353** [H16211] [H16213] [H16215] [H16217]
danielk19770ae8b832004-05-25 12:05:56 +00003354*/
drh4f26d6c2004-05-26 23:25:30 +00003355void *sqlite3_aggregate_context(sqlite3_context*, int nBytes);
danielk19777e18c252004-05-25 11:47:24 +00003356
3357/*
drh9cd29642008-07-23 00:52:55 +00003358** CAPI3REF: User Data For Functions {H16240} <S20200>
drh6ed48bf2007-06-14 20:57:18 +00003359**
drhafc91042008-02-21 02:09:45 +00003360** The sqlite3_user_data() interface returns a copy of
drhf5befa02007-12-06 02:42:07 +00003361** the pointer that was the pUserData parameter (the 5th parameter)
shane26b34032008-05-23 17:21:09 +00003362** of the [sqlite3_create_function()]
drhf5befa02007-12-06 02:42:07 +00003363** and [sqlite3_create_function16()] routines that originally
3364** registered the application defined function. {END}
drhe53831d2007-08-17 01:14:38 +00003365**
drhafc91042008-02-21 02:09:45 +00003366** This routine must be called from the same thread in which
drhf5befa02007-12-06 02:42:07 +00003367** the application-defined function is running.
drhafc91042008-02-21 02:09:45 +00003368**
drh8b39db12009-02-18 18:37:58 +00003369** Requirements:
3370** [H16243]
danielk19777e18c252004-05-25 11:47:24 +00003371*/
3372void *sqlite3_user_data(sqlite3_context*);
3373
3374/*
drhb25f9d82008-07-23 15:40:06 +00003375** CAPI3REF: Database Connection For Functions {H16250} <S60600><S20200>
drhfa4a4b92008-03-19 21:45:51 +00003376**
3377** The sqlite3_context_db_handle() interface returns a copy of
3378** the pointer to the [database connection] (the 1st parameter)
shane26b34032008-05-23 17:21:09 +00003379** of the [sqlite3_create_function()]
drhfa4a4b92008-03-19 21:45:51 +00003380** and [sqlite3_create_function16()] routines that originally
3381** registered the application defined function.
3382**
drh8b39db12009-02-18 18:37:58 +00003383** Requirements:
3384** [H16253]
drhfa4a4b92008-03-19 21:45:51 +00003385*/
3386sqlite3 *sqlite3_context_db_handle(sqlite3_context*);
3387
3388/*
drh9cd29642008-07-23 00:52:55 +00003389** CAPI3REF: Function Auxiliary Data {H16270} <S20200>
drh6ed48bf2007-06-14 20:57:18 +00003390**
3391** The following two functions may be used by scalar SQL functions to
mihailimebe796c2008-06-21 20:11:17 +00003392** associate metadata with argument values. If the same value is passed to
drh6ed48bf2007-06-14 20:57:18 +00003393** multiple invocations of the same SQL function during query execution, under
mihailimebe796c2008-06-21 20:11:17 +00003394** some circumstances the associated metadata may be preserved. This may
danielk1977682f68b2004-06-05 10:22:17 +00003395** be used, for example, to add a regular-expression matching scalar
3396** function. The compiled version of the regular expression is stored as
mihailimebe796c2008-06-21 20:11:17 +00003397** metadata associated with the SQL value passed as the regular expression
drh6ed48bf2007-06-14 20:57:18 +00003398** pattern. The compiled regular expression can be reused on multiple
3399** invocations of the same function so that the original pattern string
3400** does not need to be recompiled on each invocation.
danielk1977682f68b2004-06-05 10:22:17 +00003401**
mihailimebe796c2008-06-21 20:11:17 +00003402** The sqlite3_get_auxdata() interface returns a pointer to the metadata
drhf5befa02007-12-06 02:42:07 +00003403** associated by the sqlite3_set_auxdata() function with the Nth argument
mihailimebe796c2008-06-21 20:11:17 +00003404** value to the application-defined function. If no metadata has been ever
3405** been set for the Nth argument of the function, or if the corresponding
3406** function parameter has changed since the meta-data was set,
3407** then sqlite3_get_auxdata() returns a NULL pointer.
danielk1977682f68b2004-06-05 10:22:17 +00003408**
mihailimebe796c2008-06-21 20:11:17 +00003409** The sqlite3_set_auxdata() interface saves the metadata
3410** pointed to by its 3rd parameter as the metadata for the N-th
drhafc91042008-02-21 02:09:45 +00003411** argument of the application-defined function. Subsequent
drhf5befa02007-12-06 02:42:07 +00003412** calls to sqlite3_get_auxdata() might return this data, if it has
mihailimebe796c2008-06-21 20:11:17 +00003413** not been destroyed.
3414** If it is not NULL, SQLite will invoke the destructor
drhf5befa02007-12-06 02:42:07 +00003415** function given by the 4th parameter to sqlite3_set_auxdata() on
mihailimebe796c2008-06-21 20:11:17 +00003416** the metadata when the corresponding function parameter changes
drhafc91042008-02-21 02:09:45 +00003417** or when the SQL statement completes, whichever comes first.
3418**
mihailimebe796c2008-06-21 20:11:17 +00003419** SQLite is free to call the destructor and drop metadata on any
3420** parameter of any function at any time. The only guarantee is that
3421** the destructor will be called before the metadata is dropped.
danielk1977682f68b2004-06-05 10:22:17 +00003422**
mihailimebe796c2008-06-21 20:11:17 +00003423** In practice, metadata is preserved between function calls for
danielk1977682f68b2004-06-05 10:22:17 +00003424** expressions that are constant at compile time. This includes literal
3425** values and SQL variables.
drhe53831d2007-08-17 01:14:38 +00003426**
drhb21c8cd2007-08-21 19:33:56 +00003427** These routines must be called from the same thread in which
3428** the SQL function is running.
drhafc91042008-02-21 02:09:45 +00003429**
drh8b39db12009-02-18 18:37:58 +00003430** Requirements:
3431** [H16272] [H16274] [H16276] [H16277] [H16278] [H16279]
danielk1977682f68b2004-06-05 10:22:17 +00003432*/
drhf5befa02007-12-06 02:42:07 +00003433void *sqlite3_get_auxdata(sqlite3_context*, int N);
3434void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*));
danielk1977682f68b2004-06-05 10:22:17 +00003435
drha2854222004-06-17 19:04:17 +00003436
3437/*
drhb25f9d82008-07-23 15:40:06 +00003438** CAPI3REF: Constants Defining Special Destructor Behavior {H10280} <S30100>
drh6ed48bf2007-06-14 20:57:18 +00003439**
mihailimebe796c2008-06-21 20:11:17 +00003440** These are special values for the destructor that is passed in as the
drh6ed48bf2007-06-14 20:57:18 +00003441** final argument to routines like [sqlite3_result_blob()]. If the destructor
drha2854222004-06-17 19:04:17 +00003442** argument is SQLITE_STATIC, it means that the content pointer is constant
mihailimebe796c2008-06-21 20:11:17 +00003443** and will never change. It does not need to be destroyed. The
drha2854222004-06-17 19:04:17 +00003444** SQLITE_TRANSIENT value means that the content will likely change in
3445** the near future and that SQLite should make its own private copy of
3446** the content before returning.
drh6c9121a2007-01-26 00:51:43 +00003447**
3448** The typedef is necessary to work around problems in certain
3449** C++ compilers. See ticket #2191.
drha2854222004-06-17 19:04:17 +00003450*/
drh6c9121a2007-01-26 00:51:43 +00003451typedef void (*sqlite3_destructor_type)(void*);
3452#define SQLITE_STATIC ((sqlite3_destructor_type)0)
3453#define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1)
danielk1977d8123362004-06-12 09:25:12 +00003454
danielk1977682f68b2004-06-05 10:22:17 +00003455/*
drh9cd29642008-07-23 00:52:55 +00003456** CAPI3REF: Setting The Result Of An SQL Function {H16400} <S20200>
drh6ed48bf2007-06-14 20:57:18 +00003457**
3458** These routines are used by the xFunc or xFinal callbacks that
3459** implement SQL functions and aggregates. See
3460** [sqlite3_create_function()] and [sqlite3_create_function16()]
3461** for additional information.
3462**
mihailimebe796c2008-06-21 20:11:17 +00003463** These functions work very much like the [parameter binding] family of
3464** functions used to bind values to host parameters in prepared statements.
3465** Refer to the [SQL parameter] documentation for additional information.
drh6ed48bf2007-06-14 20:57:18 +00003466**
drhafc91042008-02-21 02:09:45 +00003467** The sqlite3_result_blob() interface sets the result from
mihailimebe796c2008-06-21 20:11:17 +00003468** an application-defined function to be the BLOB whose content is pointed
drhf5befa02007-12-06 02:42:07 +00003469** to by the second parameter and which is N bytes long where N is the
mihailimebe796c2008-06-21 20:11:17 +00003470** third parameter.
3471**
shane26b34032008-05-23 17:21:09 +00003472** The sqlite3_result_zeroblob() interfaces set the result of
mihailimebe796c2008-06-21 20:11:17 +00003473** the application-defined function to be a BLOB containing all zero
drhf5befa02007-12-06 02:42:07 +00003474** bytes and N bytes in size, where N is the value of the 2nd parameter.
drh6ed48bf2007-06-14 20:57:18 +00003475**
drhafc91042008-02-21 02:09:45 +00003476** The sqlite3_result_double() interface sets the result from
mihailimebe796c2008-06-21 20:11:17 +00003477** an application-defined function to be a floating point value specified
drhf5befa02007-12-06 02:42:07 +00003478** by its 2nd argument.
drhe53831d2007-08-17 01:14:38 +00003479**
drhafc91042008-02-21 02:09:45 +00003480** The sqlite3_result_error() and sqlite3_result_error16() functions
drhf5befa02007-12-06 02:42:07 +00003481** cause the implemented SQL function to throw an exception.
drhafc91042008-02-21 02:09:45 +00003482** SQLite uses the string pointed to by the
drhf5befa02007-12-06 02:42:07 +00003483** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16()
drhafc91042008-02-21 02:09:45 +00003484** as the text of an error message. SQLite interprets the error
mihailimebe796c2008-06-21 20:11:17 +00003485** message string from sqlite3_result_error() as UTF-8. SQLite
3486** interprets the string from sqlite3_result_error16() as UTF-16 in native
drhafc91042008-02-21 02:09:45 +00003487** byte order. If the third parameter to sqlite3_result_error()
drhf5befa02007-12-06 02:42:07 +00003488** or sqlite3_result_error16() is negative then SQLite takes as the error
3489** message all text up through the first zero character.
drhafc91042008-02-21 02:09:45 +00003490** If the third parameter to sqlite3_result_error() or
drhf5befa02007-12-06 02:42:07 +00003491** sqlite3_result_error16() is non-negative then SQLite takes that many
3492** bytes (not characters) from the 2nd parameter as the error message.
drhafc91042008-02-21 02:09:45 +00003493** The sqlite3_result_error() and sqlite3_result_error16()
mihailimebe796c2008-06-21 20:11:17 +00003494** routines make a private copy of the error message text before
drhafc91042008-02-21 02:09:45 +00003495** they return. Hence, the calling function can deallocate or
drhf5befa02007-12-06 02:42:07 +00003496** modify the text after they return without harm.
drh69544ec2008-02-06 14:11:34 +00003497** The sqlite3_result_error_code() function changes the error code
3498** returned by SQLite as a result of an error in a function. By default,
drh00e087b2008-04-10 17:14:07 +00003499** the error code is SQLITE_ERROR. A subsequent call to sqlite3_result_error()
3500** or sqlite3_result_error16() resets the error code to SQLITE_ERROR.
drhf5befa02007-12-06 02:42:07 +00003501**
mihailimebe796c2008-06-21 20:11:17 +00003502** The sqlite3_result_toobig() interface causes SQLite to throw an error
3503** indicating that a string or BLOB is to long to represent.
3504**
3505** The sqlite3_result_nomem() interface causes SQLite to throw an error
3506** indicating that a memory allocation failed.
drhf5befa02007-12-06 02:42:07 +00003507**
drhafc91042008-02-21 02:09:45 +00003508** The sqlite3_result_int() interface sets the return value
drhf5befa02007-12-06 02:42:07 +00003509** of the application-defined function to be the 32-bit signed integer
3510** value given in the 2nd argument.
drhafc91042008-02-21 02:09:45 +00003511** The sqlite3_result_int64() interface sets the return value
drhf5befa02007-12-06 02:42:07 +00003512** of the application-defined function to be the 64-bit signed integer
3513** value given in the 2nd argument.
3514**
drhafc91042008-02-21 02:09:45 +00003515** The sqlite3_result_null() interface sets the return value
drhf5befa02007-12-06 02:42:07 +00003516** of the application-defined function to be NULL.
3517**
mihailimebe796c2008-06-21 20:11:17 +00003518** The sqlite3_result_text(), sqlite3_result_text16(),
drhf5befa02007-12-06 02:42:07 +00003519** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces
3520** set the return value of the application-defined function to be
3521** a text string which is represented as UTF-8, UTF-16 native byte order,
3522** UTF-16 little endian, or UTF-16 big endian, respectively.
drhafc91042008-02-21 02:09:45 +00003523** SQLite takes the text result from the application from
drhf5befa02007-12-06 02:42:07 +00003524** the 2nd parameter of the sqlite3_result_text* interfaces.
drhafc91042008-02-21 02:09:45 +00003525** If the 3rd parameter to the sqlite3_result_text* interfaces
mihailimebe796c2008-06-21 20:11:17 +00003526** is negative, then SQLite takes result text from the 2nd parameter
drhf5befa02007-12-06 02:42:07 +00003527** through the first zero character.
drhafc91042008-02-21 02:09:45 +00003528** If the 3rd parameter to the sqlite3_result_text* interfaces
drhf5befa02007-12-06 02:42:07 +00003529** is non-negative, then as many bytes (not characters) of the text
3530** pointed to by the 2nd parameter are taken as the application-defined
3531** function result.
drhafc91042008-02-21 02:09:45 +00003532** If the 4th parameter to the sqlite3_result_text* interfaces
drhf5befa02007-12-06 02:42:07 +00003533** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that
mihailimebe796c2008-06-21 20:11:17 +00003534** function as the destructor on the text or BLOB result when it has
drhf5befa02007-12-06 02:42:07 +00003535** finished using that result.
drh9e42f8a2009-08-13 20:15:29 +00003536** If the 4th parameter to the sqlite3_result_text* interfaces or to
mihailimebe796c2008-06-21 20:11:17 +00003537** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite
3538** assumes that the text or BLOB result is in constant space and does not
drh9e42f8a2009-08-13 20:15:29 +00003539** copy the content of the parameter nor call a destructor on the content
3540** when it has finished using that result.
drhafc91042008-02-21 02:09:45 +00003541** If the 4th parameter to the sqlite3_result_text* interfaces
drhf5befa02007-12-06 02:42:07 +00003542** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT
3543** then SQLite makes a copy of the result into space obtained from
3544** from [sqlite3_malloc()] before it returns.
3545**
drhafc91042008-02-21 02:09:45 +00003546** The sqlite3_result_value() interface sets the result of
drhaa28e142008-03-18 13:47:20 +00003547** the application-defined function to be a copy the
3548** [unprotected sqlite3_value] object specified by the 2nd parameter. The
drhf5befa02007-12-06 02:42:07 +00003549** sqlite3_result_value() interface makes a copy of the [sqlite3_value]
mihailimebe796c2008-06-21 20:11:17 +00003550** so that the [sqlite3_value] specified in the parameter may change or
drhf5befa02007-12-06 02:42:07 +00003551** be deallocated after sqlite3_result_value() returns without harm.
drhaa28e142008-03-18 13:47:20 +00003552** A [protected sqlite3_value] object may always be used where an
3553** [unprotected sqlite3_value] object is required, so either
3554** kind of [sqlite3_value] object can be used with this interface.
drhf5befa02007-12-06 02:42:07 +00003555**
mihailimebe796c2008-06-21 20:11:17 +00003556** If these routines are called from within the different thread
shane26b34032008-05-23 17:21:09 +00003557** than the one containing the application-defined function that received
drhf5befa02007-12-06 02:42:07 +00003558** the [sqlite3_context] pointer, the results are undefined.
drhafc91042008-02-21 02:09:45 +00003559**
drh8b39db12009-02-18 18:37:58 +00003560** Requirements:
3561** [H16403] [H16406] [H16409] [H16412] [H16415] [H16418] [H16421] [H16424]
3562** [H16427] [H16430] [H16433] [H16436] [H16439] [H16442] [H16445] [H16448]
3563** [H16451] [H16454] [H16457] [H16460] [H16463]
danielk19777e18c252004-05-25 11:47:24 +00003564*/
danielk1977d8123362004-06-12 09:25:12 +00003565void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*));
drh4f26d6c2004-05-26 23:25:30 +00003566void sqlite3_result_double(sqlite3_context*, double);
danielk19777e18c252004-05-25 11:47:24 +00003567void sqlite3_result_error(sqlite3_context*, const char*, int);
3568void sqlite3_result_error16(sqlite3_context*, const void*, int);
drh6ed48bf2007-06-14 20:57:18 +00003569void sqlite3_result_error_toobig(sqlite3_context*);
danielk1977a1644fd2007-08-29 12:31:25 +00003570void sqlite3_result_error_nomem(sqlite3_context*);
drh69544ec2008-02-06 14:11:34 +00003571void sqlite3_result_error_code(sqlite3_context*, int);
drh4f26d6c2004-05-26 23:25:30 +00003572void sqlite3_result_int(sqlite3_context*, int);
drh6d2069d2007-08-14 01:58:53 +00003573void sqlite3_result_int64(sqlite3_context*, sqlite3_int64);
drh4f26d6c2004-05-26 23:25:30 +00003574void sqlite3_result_null(sqlite3_context*);
danielk1977d8123362004-06-12 09:25:12 +00003575void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*));
3576void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*));
3577void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*));
3578void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*));
drh4f26d6c2004-05-26 23:25:30 +00003579void sqlite3_result_value(sqlite3_context*, sqlite3_value*);
drhb026e052007-05-02 01:34:31 +00003580void sqlite3_result_zeroblob(sqlite3_context*, int n);
drhf9b596e2004-05-26 16:54:42 +00003581
drh52619df2004-06-11 17:48:02 +00003582/*
drh9cd29642008-07-23 00:52:55 +00003583** CAPI3REF: Define New Collating Sequences {H16600} <S20300>
drh6ed48bf2007-06-14 20:57:18 +00003584**
3585** These functions are used to add new collation sequences to the
mihailimebe796c2008-06-21 20:11:17 +00003586** [database connection] specified as the first argument.
danielk19777cedc8d2004-06-10 10:50:08 +00003587**
3588** The name of the new collation sequence is specified as a UTF-8 string
drh6ed48bf2007-06-14 20:57:18 +00003589** for sqlite3_create_collation() and sqlite3_create_collation_v2()
drhafc91042008-02-21 02:09:45 +00003590** and a UTF-16 string for sqlite3_create_collation16(). In all cases
drh6ed48bf2007-06-14 20:57:18 +00003591** the name is passed as the second function argument.
danielk19777cedc8d2004-06-10 10:50:08 +00003592**
drh4145f832007-10-12 18:30:12 +00003593** The third argument may be one of the constants [SQLITE_UTF8],
drh51c7d862009-04-27 18:46:06 +00003594** [SQLITE_UTF16LE], or [SQLITE_UTF16BE], indicating that the user-supplied
danielk19777cedc8d2004-06-10 10:50:08 +00003595** routine expects to be passed pointers to strings encoded using UTF-8,
mihailimebe796c2008-06-21 20:11:17 +00003596** UTF-16 little-endian, or UTF-16 big-endian, respectively. The
drh51c7d862009-04-27 18:46:06 +00003597** third argument might also be [SQLITE_UTF16] to indicate that the routine
3598** expects pointers to be UTF-16 strings in the native byte order, or the
3599** argument can be [SQLITE_UTF16_ALIGNED] if the
drh4145f832007-10-12 18:30:12 +00003600** the routine expects pointers to 16-bit word aligned strings
drh51c7d862009-04-27 18:46:06 +00003601** of UTF-16 in the native byte order.
danielk19777cedc8d2004-06-10 10:50:08 +00003602**
3603** A pointer to the user supplied routine must be passed as the fifth
drhafc91042008-02-21 02:09:45 +00003604** argument. If it is NULL, this is the same as deleting the collation
drhf5befa02007-12-06 02:42:07 +00003605** sequence (so that SQLite cannot call it anymore).
mihailimebe796c2008-06-21 20:11:17 +00003606** Each time the application supplied function is invoked, it is passed
3607** as its first parameter a copy of the void* passed as the fourth argument
3608** to sqlite3_create_collation() or sqlite3_create_collation16().
danielk19777cedc8d2004-06-10 10:50:08 +00003609**
drhf5befa02007-12-06 02:42:07 +00003610** The remaining arguments to the application-supplied routine are two strings,
drh33c1be32008-01-30 16:16:14 +00003611** each represented by a (length, data) pair and encoded in the encoding
danielk19777cedc8d2004-06-10 10:50:08 +00003612** that was passed as the third argument when the collation sequence was
mihailim04bcc002008-06-22 10:21:27 +00003613** registered. {END} The application defined collation routine should
mihailimebe796c2008-06-21 20:11:17 +00003614** return negative, zero or positive if the first string is less than,
3615** equal to, or greater than the second string. i.e. (STRING1 - STRING2).
drh6ed48bf2007-06-14 20:57:18 +00003616**
3617** The sqlite3_create_collation_v2() works like sqlite3_create_collation()
shane26b34032008-05-23 17:21:09 +00003618** except that it takes an extra argument which is a destructor for
drhafc91042008-02-21 02:09:45 +00003619** the collation. The destructor is called when the collation is
drh6ed48bf2007-06-14 20:57:18 +00003620** destroyed and is passed a copy of the fourth parameter void* pointer
drhf5befa02007-12-06 02:42:07 +00003621** of the sqlite3_create_collation_v2().
mihailimebe796c2008-06-21 20:11:17 +00003622** Collations are destroyed when they are overridden by later calls to the
3623** collation creation functions or when the [database connection] is closed
3624** using [sqlite3_close()].
drhafc91042008-02-21 02:09:45 +00003625**
drh51c7d862009-04-27 18:46:06 +00003626** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()].
3627**
drh8b39db12009-02-18 18:37:58 +00003628** Requirements:
3629** [H16603] [H16604] [H16606] [H16609] [H16612] [H16615] [H16618] [H16621]
3630** [H16624] [H16627] [H16630]
danielk19777cedc8d2004-06-10 10:50:08 +00003631*/
danielk19770202b292004-06-09 09:55:16 +00003632int sqlite3_create_collation(
3633 sqlite3*,
3634 const char *zName,
danielk19777cedc8d2004-06-10 10:50:08 +00003635 int eTextRep,
danielk19770202b292004-06-09 09:55:16 +00003636 void*,
3637 int(*xCompare)(void*,int,const void*,int,const void*)
3638);
drh6ed48bf2007-06-14 20:57:18 +00003639int sqlite3_create_collation_v2(
3640 sqlite3*,
3641 const char *zName,
3642 int eTextRep,
3643 void*,
3644 int(*xCompare)(void*,int,const void*,int,const void*),
3645 void(*xDestroy)(void*)
3646);
danielk19770202b292004-06-09 09:55:16 +00003647int sqlite3_create_collation16(
3648 sqlite3*,
mihailimbda2e622008-06-23 11:23:14 +00003649 const void *zName,
danielk19777cedc8d2004-06-10 10:50:08 +00003650 int eTextRep,
danielk19770202b292004-06-09 09:55:16 +00003651 void*,
3652 int(*xCompare)(void*,int,const void*,int,const void*)
3653);
3654
danielk19777cedc8d2004-06-10 10:50:08 +00003655/*
drh9cd29642008-07-23 00:52:55 +00003656** CAPI3REF: Collation Needed Callbacks {H16700} <S20300>
danielk1977a393c032007-05-07 14:58:53 +00003657**
danielk19777cedc8d2004-06-10 10:50:08 +00003658** To avoid having to register all collation sequences before a database
3659** can be used, a single callback function may be registered with the
mihailimdc884822008-06-22 08:58:50 +00003660** [database connection] to be called whenever an undefined collation
3661** sequence is required.
danielk19777cedc8d2004-06-10 10:50:08 +00003662**
3663** If the function is registered using the sqlite3_collation_needed() API,
3664** then it is passed the names of undefined collation sequences as strings
drh9a247912008-07-22 18:45:08 +00003665** encoded in UTF-8. {H16703} If sqlite3_collation_needed16() is used,
mihailimdc884822008-06-22 08:58:50 +00003666** the names are passed as UTF-16 in machine native byte order.
3667** A call to either function replaces any existing callback.
danielk19777cedc8d2004-06-10 10:50:08 +00003668**
drhafc91042008-02-21 02:09:45 +00003669** When the callback is invoked, the first argument passed is a copy
danielk19777cedc8d2004-06-10 10:50:08 +00003670** of the second argument to sqlite3_collation_needed() or
drhafc91042008-02-21 02:09:45 +00003671** sqlite3_collation_needed16(). The second argument is the database
mihailimdc884822008-06-22 08:58:50 +00003672** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE],
3673** or [SQLITE_UTF16LE], indicating the most desirable form of the collation
3674** sequence function required. The fourth parameter is the name of the
drhafc91042008-02-21 02:09:45 +00003675** required collation sequence.
danielk19777cedc8d2004-06-10 10:50:08 +00003676**
drh6ed48bf2007-06-14 20:57:18 +00003677** The callback function should register the desired collation using
3678** [sqlite3_create_collation()], [sqlite3_create_collation16()], or
3679** [sqlite3_create_collation_v2()].
drhafc91042008-02-21 02:09:45 +00003680**
drh8b39db12009-02-18 18:37:58 +00003681** Requirements:
3682** [H16702] [H16704] [H16706]
danielk19777cedc8d2004-06-10 10:50:08 +00003683*/
3684int sqlite3_collation_needed(
3685 sqlite3*,
3686 void*,
3687 void(*)(void*,sqlite3*,int eTextRep,const char*)
3688);
3689int sqlite3_collation_needed16(
3690 sqlite3*,
3691 void*,
3692 void(*)(void*,sqlite3*,int eTextRep,const void*)
3693);
3694
drh2011d5f2004-07-22 02:40:37 +00003695/*
3696** Specify the key for an encrypted database. This routine should be
3697** called right after sqlite3_open().
3698**
3699** The code to implement this API is not available in the public release
3700** of SQLite.
3701*/
3702int sqlite3_key(
3703 sqlite3 *db, /* Database to be rekeyed */
3704 const void *pKey, int nKey /* The key */
3705);
3706
3707/*
3708** Change the key on an open database. If the current database is not
3709** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the
3710** database is decrypted.
3711**
3712** The code to implement this API is not available in the public release
3713** of SQLite.
3714*/
3715int sqlite3_rekey(
3716 sqlite3 *db, /* Database to be rekeyed */
3717 const void *pKey, int nKey /* The new key */
3718);
danielk19770202b292004-06-09 09:55:16 +00003719
drhab3f9fe2004-08-14 17:10:10 +00003720/*
drhb25f9d82008-07-23 15:40:06 +00003721** CAPI3REF: Suspend Execution For A Short Time {H10530} <S40410>
drh6ed48bf2007-06-14 20:57:18 +00003722**
mihailimdc884822008-06-22 08:58:50 +00003723** The sqlite3_sleep() function causes the current thread to suspend execution
drhfddfa2d2007-12-05 18:05:16 +00003724** for at least a number of milliseconds specified in its parameter.
danielk1977600dd0b2005-01-20 01:14:23 +00003725**
mihailimdc884822008-06-22 08:58:50 +00003726** If the operating system does not support sleep requests with
3727** millisecond time resolution, then the time will be rounded up to
3728** the nearest second. The number of milliseconds of sleep actually
danielk1977600dd0b2005-01-20 01:14:23 +00003729** requested from the operating system is returned.
drh8bacf972007-08-25 16:21:29 +00003730**
drhafc91042008-02-21 02:09:45 +00003731** SQLite implements this interface by calling the xSleep()
3732** method of the default [sqlite3_vfs] object.
3733**
drh8b39db12009-02-18 18:37:58 +00003734** Requirements: [H10533] [H10536]
danielk1977600dd0b2005-01-20 01:14:23 +00003735*/
3736int sqlite3_sleep(int);
3737
3738/*
drhb25f9d82008-07-23 15:40:06 +00003739** CAPI3REF: Name Of The Folder Holding Temporary Files {H10310} <S20000>
drhd89bd002005-01-22 03:03:54 +00003740**
drh6ed48bf2007-06-14 20:57:18 +00003741** If this global variable is made to point to a string which is
shane26b34032008-05-23 17:21:09 +00003742** the name of a folder (a.k.a. directory), then all temporary files
drhab3f9fe2004-08-14 17:10:10 +00003743** created by SQLite will be placed in that directory. If this variable
mihailimdc884822008-06-22 08:58:50 +00003744** is a NULL pointer, then SQLite performs a search for an appropriate
3745** temporary file directory.
drhab3f9fe2004-08-14 17:10:10 +00003746**
drh1a25f112009-04-06 15:55:03 +00003747** It is not safe to read or modify this variable in more than one
3748** thread at a time. It is not safe to read or modify this variable
3749** if a [database connection] is being used at the same time in a separate
3750** thread.
3751** It is intended that this variable be set once
drh4ff7fa02007-09-01 18:17:21 +00003752** as part of process initialization and before any SQLite interface
drh1a25f112009-04-06 15:55:03 +00003753** routines have been called and that this variable remain unchanged
3754** thereafter.
3755**
3756** The [temp_store_directory pragma] may modify this variable and cause
3757** it to point to memory obtained from [sqlite3_malloc]. Furthermore,
3758** the [temp_store_directory pragma] always assumes that any string
3759** that this variable points to is held in memory obtained from
3760** [sqlite3_malloc] and the pragma may attempt to free that memory
3761** using [sqlite3_free].
3762** Hence, if this variable is modified directly, either it should be
3763** made NULL or made to point to memory obtained from [sqlite3_malloc]
3764** or else the use of the [temp_store_directory pragma] should be avoided.
drhab3f9fe2004-08-14 17:10:10 +00003765*/
drh73be5012007-08-08 12:11:21 +00003766SQLITE_EXTERN char *sqlite3_temp_directory;
drhab3f9fe2004-08-14 17:10:10 +00003767
danielk19776b456a22005-03-21 04:04:02 +00003768/*
drh9cd29642008-07-23 00:52:55 +00003769** CAPI3REF: Test For Auto-Commit Mode {H12930} <S60200>
mihailim15194222008-06-22 09:55:14 +00003770** KEYWORDS: {autocommit mode}
danielk19776b456a22005-03-21 04:04:02 +00003771**
shane26b34032008-05-23 17:21:09 +00003772** The sqlite3_get_autocommit() interface returns non-zero or
drhf5befa02007-12-06 02:42:07 +00003773** zero if the given database connection is or is not in autocommit mode,
mihailim04bcc002008-06-22 10:21:27 +00003774** respectively. Autocommit mode is on by default.
mihailimdc884822008-06-22 08:58:50 +00003775** Autocommit mode is disabled by a [BEGIN] statement.
shane26b34032008-05-23 17:21:09 +00003776** Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK].
drhe30f4422007-08-21 16:15:55 +00003777**
drh7c3472a2007-10-03 20:15:28 +00003778** If certain kinds of errors occur on a statement within a multi-statement
mihailimdc884822008-06-22 08:58:50 +00003779** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR],
drh7c3472a2007-10-03 20:15:28 +00003780** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the
drh33c1be32008-01-30 16:16:14 +00003781** transaction might be rolled back automatically. The only way to
mihailimdc884822008-06-22 08:58:50 +00003782** find out whether SQLite automatically rolled back the transaction after
drh33c1be32008-01-30 16:16:14 +00003783** an error is to use this function.
drh7c3472a2007-10-03 20:15:28 +00003784**
drh8b39db12009-02-18 18:37:58 +00003785** If another thread changes the autocommit status of the database
3786** connection while this routine is running, then the return value
3787** is undefined.
drh33c1be32008-01-30 16:16:14 +00003788**
drh8b39db12009-02-18 18:37:58 +00003789** Requirements: [H12931] [H12932] [H12933] [H12934]
drh3e1d8e62005-05-26 16:23:34 +00003790*/
3791int sqlite3_get_autocommit(sqlite3*);
3792
drh51942bc2005-06-12 22:01:42 +00003793/*
drhb25f9d82008-07-23 15:40:06 +00003794** CAPI3REF: Find The Database Handle Of A Prepared Statement {H13120} <S60600>
drh6ed48bf2007-06-14 20:57:18 +00003795**
mihailimdc884822008-06-22 08:58:50 +00003796** The sqlite3_db_handle interface returns the [database connection] handle
drh62b5d2d2009-02-03 18:47:22 +00003797** to which a [prepared statement] belongs. The [database connection]
3798** returned by sqlite3_db_handle is the same [database connection] that was the first argument
mihailimdc884822008-06-22 08:58:50 +00003799** to the [sqlite3_prepare_v2()] call (or its variants) that was used to
3800** create the statement in the first place.
drhafc91042008-02-21 02:09:45 +00003801**
drh8b39db12009-02-18 18:37:58 +00003802** Requirements: [H13123]
drh51942bc2005-06-12 22:01:42 +00003803*/
3804sqlite3 *sqlite3_db_handle(sqlite3_stmt*);
drh3e1d8e62005-05-26 16:23:34 +00003805
drhbb5a9c32008-06-19 02:52:25 +00003806/*
drhb25f9d82008-07-23 15:40:06 +00003807** CAPI3REF: Find the next prepared statement {H13140} <S60600>
drhbb5a9c32008-06-19 02:52:25 +00003808**
mihailimdc884822008-06-22 08:58:50 +00003809** This interface returns a pointer to the next [prepared statement] after
3810** pStmt associated with the [database connection] pDb. If pStmt is NULL
3811** then this interface returns a pointer to the first prepared statement
3812** associated with the database connection pDb. If no prepared statement
3813** satisfies the conditions of this routine, it returns NULL.
drhbb5a9c32008-06-19 02:52:25 +00003814**
drh8b39db12009-02-18 18:37:58 +00003815** The [database connection] pointer D in a call to
3816** [sqlite3_next_stmt(D,S)] must refer to an open database
3817** connection and in particular must not be a NULL pointer.
drhbb5a9c32008-06-19 02:52:25 +00003818**
drh8b39db12009-02-18 18:37:58 +00003819** Requirements: [H13143] [H13146] [H13149] [H13152]
drhbb5a9c32008-06-19 02:52:25 +00003820*/
3821sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt);
3822
drhb37df7b2005-10-13 02:09:49 +00003823/*
drh9cd29642008-07-23 00:52:55 +00003824** CAPI3REF: Commit And Rollback Notification Callbacks {H12950} <S60400>
drh6ed48bf2007-06-14 20:57:18 +00003825**
drhafc91042008-02-21 02:09:45 +00003826** The sqlite3_commit_hook() interface registers a callback
drhabda6112009-05-14 22:37:47 +00003827** function to be invoked whenever a transaction is [COMMIT | committed].
drhafc91042008-02-21 02:09:45 +00003828** Any callback set by a previous call to sqlite3_commit_hook()
drhf5befa02007-12-06 02:42:07 +00003829** for the same database connection is overridden.
drhafc91042008-02-21 02:09:45 +00003830** The sqlite3_rollback_hook() interface registers a callback
drhabda6112009-05-14 22:37:47 +00003831** function to be invoked whenever a transaction is [ROLLBACK | rolled back].
drhafc91042008-02-21 02:09:45 +00003832** Any callback set by a previous call to sqlite3_commit_hook()
drhf5befa02007-12-06 02:42:07 +00003833** for the same database connection is overridden.
mihailimdc884822008-06-22 08:58:50 +00003834** The pArg argument is passed through to the callback.
3835** If the callback on a commit hook function returns non-zero,
3836** then the commit is converted into a rollback.
drh6ed48bf2007-06-14 20:57:18 +00003837**
drhafc91042008-02-21 02:09:45 +00003838** If another function was previously registered, its
drhf5befa02007-12-06 02:42:07 +00003839** pArg value is returned. Otherwise NULL is returned.
drh6ed48bf2007-06-14 20:57:18 +00003840**
drhc8075422008-09-10 13:09:23 +00003841** The callback implementation must not do anything that will modify
3842** the database connection that invoked the callback. Any actions
3843** to modify the database connection must be deferred until after the
3844** completion of the [sqlite3_step()] call that triggered the commit
3845** or rollback hook in the first place.
3846** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
3847** database connections for the meaning of "modify" in this paragraph.
3848**
drhafc91042008-02-21 02:09:45 +00003849** Registering a NULL function disables the callback.
drh6ed48bf2007-06-14 20:57:18 +00003850**
drhabda6112009-05-14 22:37:47 +00003851** When the commit hook callback routine returns zero, the [COMMIT]
3852** operation is allowed to continue normally. If the commit hook
3853** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK].
3854** The rollback hook is invoked on a rollback that results from a commit
3855** hook returning non-zero, just as it would be with any other rollback.
3856**
mihailimdc884822008-06-22 08:58:50 +00003857** For the purposes of this API, a transaction is said to have been
drh6ed48bf2007-06-14 20:57:18 +00003858** rolled back if an explicit "ROLLBACK" statement is executed, or
drhf5befa02007-12-06 02:42:07 +00003859** an error or constraint causes an implicit rollback to occur.
drhafc91042008-02-21 02:09:45 +00003860** The rollback callback is not invoked if a transaction is
drhf5befa02007-12-06 02:42:07 +00003861** automatically rolled back because the database connection is closed.
drhafc91042008-02-21 02:09:45 +00003862** The rollback callback is not invoked if a transaction is
drhf5befa02007-12-06 02:42:07 +00003863** rolled back because a commit callback returned non-zero.
drhafc91042008-02-21 02:09:45 +00003864** <todo> Check on this </todo>
drh6ed48bf2007-06-14 20:57:18 +00003865**
drhabda6112009-05-14 22:37:47 +00003866** See also the [sqlite3_update_hook()] interface.
3867**
drh8b39db12009-02-18 18:37:58 +00003868** Requirements:
3869** [H12951] [H12952] [H12953] [H12954] [H12955]
3870** [H12961] [H12962] [H12963] [H12964]
drh6ed48bf2007-06-14 20:57:18 +00003871*/
3872void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
3873void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);
3874
3875/*
drh9cd29642008-07-23 00:52:55 +00003876** CAPI3REF: Data Change Notification Callbacks {H12970} <S60400>
drh6ed48bf2007-06-14 20:57:18 +00003877**
mihailimdc884822008-06-22 08:58:50 +00003878** The sqlite3_update_hook() interface registers a callback function
3879** with the [database connection] identified by the first argument
3880** to be invoked whenever a row is updated, inserted or deleted.
3881** Any callback set by a previous call to this function
3882** for the same database connection is overridden.
danielk197794eb6a12005-12-15 15:22:08 +00003883**
mihailimdc884822008-06-22 08:58:50 +00003884** The second argument is a pointer to the function to invoke when a
3885** row is updated, inserted or deleted.
3886** The first argument to the callback is a copy of the third argument
3887** to sqlite3_update_hook().
3888** The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE],
3889** or [SQLITE_UPDATE], depending on the operation that caused the callback
3890** to be invoked.
3891** The third and fourth arguments to the callback contain pointers to the
3892** database and table name containing the affected row.
drh49c3d572008-12-15 22:51:38 +00003893** The final callback parameter is the [rowid] of the row.
3894** In the case of an update, this is the [rowid] after the update takes place.
danielk197794eb6a12005-12-15 15:22:08 +00003895**
drhafc91042008-02-21 02:09:45 +00003896** The update hook is not invoked when internal system tables are
danielk197794eb6a12005-12-15 15:22:08 +00003897** modified (i.e. sqlite_master and sqlite_sequence).
danielk197771fd80b2005-12-16 06:54:01 +00003898**
drhabda6112009-05-14 22:37:47 +00003899** In the current implementation, the update hook
3900** is not invoked when duplication rows are deleted because of an
3901** [ON CONFLICT | ON CONFLICT REPLACE] clause. Nor is the update hook
3902** invoked when rows are deleted using the [truncate optimization].
3903** The exceptions defined in this paragraph might change in a future
3904** release of SQLite.
3905**
drhc8075422008-09-10 13:09:23 +00003906** The update hook implementation must not do anything that will modify
3907** the database connection that invoked the update hook. Any actions
3908** to modify the database connection must be deferred until after the
3909** completion of the [sqlite3_step()] call that triggered the update hook.
3910** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
3911** database connections for the meaning of "modify" in this paragraph.
3912**
drhafc91042008-02-21 02:09:45 +00003913** If another function was previously registered, its pArg value
3914** is returned. Otherwise NULL is returned.
3915**
drhabda6112009-05-14 22:37:47 +00003916** See also the [sqlite3_commit_hook()] and [sqlite3_rollback_hook()]
3917** interfaces.
3918**
drh8b39db12009-02-18 18:37:58 +00003919** Requirements:
3920** [H12971] [H12973] [H12975] [H12977] [H12979] [H12981] [H12983] [H12986]
danielk197794eb6a12005-12-15 15:22:08 +00003921*/
danielk197771fd80b2005-12-16 06:54:01 +00003922void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00003923 sqlite3*,
drh6d2069d2007-08-14 01:58:53 +00003924 void(*)(void *,int ,char const *,char const *,sqlite3_int64),
danielk197794eb6a12005-12-15 15:22:08 +00003925 void*
3926);
danielk197713a68c32005-12-15 10:11:30 +00003927
danielk1977f3f06bb2005-12-16 15:24:28 +00003928/*
drh9cd29642008-07-23 00:52:55 +00003929** CAPI3REF: Enable Or Disable Shared Pager Cache {H10330} <S30900>
drhe33b0ed2009-08-06 17:40:45 +00003930** KEYWORDS: {shared cache}
danielk1977f3f06bb2005-12-16 15:24:28 +00003931**
drh6ed48bf2007-06-14 20:57:18 +00003932** This routine enables or disables the sharing of the database cache
mihailimdc884822008-06-22 08:58:50 +00003933** and schema data structures between [database connection | connections]
3934** to the same database. Sharing is enabled if the argument is true
3935** and disabled if the argument is false.
danielk1977f3f06bb2005-12-16 15:24:28 +00003936**
drhaff46972009-02-12 17:07:34 +00003937** Cache sharing is enabled and disabled for an entire process.
mihailimdc884822008-06-22 08:58:50 +00003938** This is a change as of SQLite version 3.5.0. In prior versions of SQLite,
3939** sharing was enabled or disabled for each thread separately.
drh6ed48bf2007-06-14 20:57:18 +00003940**
drhe30f4422007-08-21 16:15:55 +00003941** The cache sharing mode set by this interface effects all subsequent
3942** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()].
drhafc91042008-02-21 02:09:45 +00003943** Existing database connections continue use the sharing mode
3944** that was in effect at the time they were opened.
drh6ed48bf2007-06-14 20:57:18 +00003945**
mihailimdc884822008-06-22 08:58:50 +00003946** Virtual tables cannot be used with a shared cache. When shared
drh4ff7fa02007-09-01 18:17:21 +00003947** cache is enabled, the [sqlite3_create_module()] API used to register
drhafc91042008-02-21 02:09:45 +00003948** virtual tables will always return an error.
drh6ed48bf2007-06-14 20:57:18 +00003949**
mihailimdc884822008-06-22 08:58:50 +00003950** This routine returns [SQLITE_OK] if shared cache was enabled or disabled
3951** successfully. An [error code] is returned otherwise.
drh6ed48bf2007-06-14 20:57:18 +00003952**
drhafc91042008-02-21 02:09:45 +00003953** Shared cache is disabled by default. But this might change in
drh4ff7fa02007-09-01 18:17:21 +00003954** future releases of SQLite. Applications that care about shared
3955** cache setting should set it explicitly.
drhafc91042008-02-21 02:09:45 +00003956**
drhaff46972009-02-12 17:07:34 +00003957** See Also: [SQLite Shared-Cache Mode]
3958**
drh8b39db12009-02-18 18:37:58 +00003959** Requirements: [H10331] [H10336] [H10337] [H10339]
danielk1977aef0bf62005-12-30 16:28:01 +00003960*/
3961int sqlite3_enable_shared_cache(int);
3962
3963/*
drh9cd29642008-07-23 00:52:55 +00003964** CAPI3REF: Attempt To Free Heap Memory {H17340} <S30220>
drh6ed48bf2007-06-14 20:57:18 +00003965**
mihailim04bcc002008-06-22 10:21:27 +00003966** The sqlite3_release_memory() interface attempts to free N bytes
3967** of heap memory by deallocating non-essential memory allocations
3968** held by the database library. {END} Memory used to cache database
3969** pages to improve performance is an example of non-essential memory.
3970** sqlite3_release_memory() returns the number of bytes actually freed,
3971** which might be more or less than the amount requested.
drhafc91042008-02-21 02:09:45 +00003972**
drh8b39db12009-02-18 18:37:58 +00003973** Requirements: [H17341] [H17342]
danielk197752622822006-01-09 09:59:49 +00003974*/
3975int sqlite3_release_memory(int);
3976
3977/*
drh9cd29642008-07-23 00:52:55 +00003978** CAPI3REF: Impose A Limit On Heap Size {H17350} <S30220>
drh6ed48bf2007-06-14 20:57:18 +00003979**
mihailimdc884822008-06-22 08:58:50 +00003980** The sqlite3_soft_heap_limit() interface places a "soft" limit
3981** on the amount of heap memory that may be allocated by SQLite.
3982** If an internal allocation is requested that would exceed the
3983** soft heap limit, [sqlite3_release_memory()] is invoked one or
3984** more times to free up some space before the allocation is performed.
danielk197752622822006-01-09 09:59:49 +00003985**
mihailimdc884822008-06-22 08:58:50 +00003986** The limit is called "soft", because if [sqlite3_release_memory()]
3987** cannot free sufficient memory to prevent the limit from being exceeded,
drhe30f4422007-08-21 16:15:55 +00003988** the memory is allocated anyway and the current operation proceeds.
drh6ed48bf2007-06-14 20:57:18 +00003989**
3990** A negative or zero value for N means that there is no soft heap limit and
drhe30f4422007-08-21 16:15:55 +00003991** [sqlite3_release_memory()] will only be called when memory is exhausted.
drhafc91042008-02-21 02:09:45 +00003992** The default value for the soft heap limit is zero.
drh6ed48bf2007-06-14 20:57:18 +00003993**
mihailim15194222008-06-22 09:55:14 +00003994** SQLite makes a best effort to honor the soft heap limit.
shane26b34032008-05-23 17:21:09 +00003995** But if the soft heap limit cannot be honored, execution will
mihailimdc884822008-06-22 08:58:50 +00003996** continue without error or notification. This is why the limit is
drh6ed48bf2007-06-14 20:57:18 +00003997** called a "soft" limit. It is advisory only.
3998**
drhe30f4422007-08-21 16:15:55 +00003999** Prior to SQLite version 3.5.0, this routine only constrained the memory
4000** allocated by a single thread - the same thread in which this routine
4001** runs. Beginning with SQLite version 3.5.0, the soft heap limit is
drhafc91042008-02-21 02:09:45 +00004002** applied to all threads. The value specified for the soft heap limit
4003** is an upper bound on the total memory allocation for all threads. In
drh8bacf972007-08-25 16:21:29 +00004004** version 3.5.0 there is no mechanism for limiting the heap usage for
4005** individual threads.
drhafc91042008-02-21 02:09:45 +00004006**
drh8b39db12009-02-18 18:37:58 +00004007** Requirements:
4008** [H16351] [H16352] [H16353] [H16354] [H16355] [H16358]
danielk197752622822006-01-09 09:59:49 +00004009*/
drhd2d4a6b2006-01-10 15:18:27 +00004010void sqlite3_soft_heap_limit(int);
danielk197752622822006-01-09 09:59:49 +00004011
4012/*
drh9cd29642008-07-23 00:52:55 +00004013** CAPI3REF: Extract Metadata About A Column Of A Table {H12850} <S60300>
drh6ed48bf2007-06-14 20:57:18 +00004014**
mihailimdc884822008-06-22 08:58:50 +00004015** This routine returns metadata about a specific column of a specific
4016** database table accessible using the [database connection] handle
4017** passed as the first function argument.
danielk1977deb802c2006-02-09 13:43:28 +00004018**
mihailimdc884822008-06-22 08:58:50 +00004019** The column is identified by the second, third and fourth parameters to
danielk1977deb802c2006-02-09 13:43:28 +00004020** this function. The second parameter is either the name of the database
4021** (i.e. "main", "temp" or an attached database) containing the specified
4022** table or NULL. If it is NULL, then all attached databases are searched
mihailimdc884822008-06-22 08:58:50 +00004023** for the table using the same algorithm used by the database engine to
danielk1977deb802c2006-02-09 13:43:28 +00004024** resolve unqualified table references.
4025**
mihailimdc884822008-06-22 08:58:50 +00004026** The third and fourth parameters to this function are the table and column
4027** name of the desired column, respectively. Neither of these parameters
danielk1977deb802c2006-02-09 13:43:28 +00004028** may be NULL.
4029**
mihailimdc884822008-06-22 08:58:50 +00004030** Metadata is returned by writing to the memory locations passed as the 5th
4031** and subsequent parameters to this function. Any of these arguments may be
4032** NULL, in which case the corresponding element of metadata is omitted.
mihailim15194222008-06-22 09:55:14 +00004033**
mihailimdc884822008-06-22 08:58:50 +00004034** <blockquote>
4035** <table border="1">
4036** <tr><th> Parameter <th> Output<br>Type <th> Description
danielk1977deb802c2006-02-09 13:43:28 +00004037**
mihailimdc884822008-06-22 08:58:50 +00004038** <tr><td> 5th <td> const char* <td> Data type
4039** <tr><td> 6th <td> const char* <td> Name of default collation sequence
4040** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint
4041** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY
drh49c3d572008-12-15 22:51:38 +00004042** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT]
mihailimdc884822008-06-22 08:58:50 +00004043** </table>
4044** </blockquote>
danielk1977deb802c2006-02-09 13:43:28 +00004045**
mihailimdc884822008-06-22 08:58:50 +00004046** The memory pointed to by the character pointers returned for the
4047** declaration type and collation sequence is valid only until the next
4048** call to any SQLite API function.
danielk1977deb802c2006-02-09 13:43:28 +00004049**
mihailimdc884822008-06-22 08:58:50 +00004050** If the specified table is actually a view, an [error code] is returned.
danielk1977deb802c2006-02-09 13:43:28 +00004051**
mihailimdc884822008-06-22 08:58:50 +00004052** If the specified column is "rowid", "oid" or "_rowid_" and an
drh49c3d572008-12-15 22:51:38 +00004053** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output
danielk1977deb802c2006-02-09 13:43:28 +00004054** parameters are set for the explicitly declared column. If there is no
drh49c3d572008-12-15 22:51:38 +00004055** explicitly declared [INTEGER PRIMARY KEY] column, then the output
mihailimdc884822008-06-22 08:58:50 +00004056** parameters are set as follows:
danielk1977deb802c2006-02-09 13:43:28 +00004057**
drh6ed48bf2007-06-14 20:57:18 +00004058** <pre>
danielk1977deb802c2006-02-09 13:43:28 +00004059** data type: "INTEGER"
4060** collation sequence: "BINARY"
4061** not null: 0
4062** primary key: 1
4063** auto increment: 0
drh6ed48bf2007-06-14 20:57:18 +00004064** </pre>
danielk1977deb802c2006-02-09 13:43:28 +00004065**
4066** This function may load one or more schemas from database files. If an
4067** error occurs during this process, or if the requested table or column
mihailimdc884822008-06-22 08:58:50 +00004068** cannot be found, an [error code] is returned and an error message left
4069** in the [database connection] (to be retrieved using sqlite3_errmsg()).
danielk19774b1ae992006-02-10 03:06:10 +00004070**
4071** This API is only available if the library was compiled with the
drh4ead1482008-06-26 18:16:05 +00004072** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined.
danielk1977deb802c2006-02-09 13:43:28 +00004073*/
4074int sqlite3_table_column_metadata(
4075 sqlite3 *db, /* Connection handle */
4076 const char *zDbName, /* Database name or NULL */
4077 const char *zTableName, /* Table name */
4078 const char *zColumnName, /* Column name */
4079 char const **pzDataType, /* OUTPUT: Declared data type */
4080 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
4081 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
4082 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh98c94802007-10-01 13:50:31 +00004083 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00004084);
4085
4086/*
drh9cd29642008-07-23 00:52:55 +00004087** CAPI3REF: Load An Extension {H12600} <S20500>
drh1e397f82006-06-08 15:28:43 +00004088**
mihailimdc884822008-06-22 08:58:50 +00004089** This interface loads an SQLite extension library from the named file.
drh1e397f82006-06-08 15:28:43 +00004090**
drh9a247912008-07-22 18:45:08 +00004091** {H12601} The sqlite3_load_extension() interface attempts to load an
mihailimdc884822008-06-22 08:58:50 +00004092** SQLite extension library contained in the file zFile.
drh1e397f82006-06-08 15:28:43 +00004093**
drh9a247912008-07-22 18:45:08 +00004094** {H12602} The entry point is zProc.
mihailimdc884822008-06-22 08:58:50 +00004095**
drh9a247912008-07-22 18:45:08 +00004096** {H12603} zProc may be 0, in which case the name of the entry point
mihailimdc884822008-06-22 08:58:50 +00004097** defaults to "sqlite3_extension_init".
4098**
drh9a247912008-07-22 18:45:08 +00004099** {H12604} The sqlite3_load_extension() interface shall return
mihailimdc884822008-06-22 08:58:50 +00004100** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.
4101**
drh9a247912008-07-22 18:45:08 +00004102** {H12605} If an error occurs and pzErrMsg is not 0, then the
mihailim421dfca2008-06-22 16:35:48 +00004103** [sqlite3_load_extension()] interface shall attempt to
4104** fill *pzErrMsg with error message text stored in memory
4105** obtained from [sqlite3_malloc()]. {END} The calling function
4106** should free this memory by calling [sqlite3_free()].
4107**
drh9a247912008-07-22 18:45:08 +00004108** {H12606} Extension loading must be enabled using
mihailimdc884822008-06-22 08:58:50 +00004109** [sqlite3_enable_load_extension()] prior to calling this API,
4110** otherwise an error will be returned.
drh1e397f82006-06-08 15:28:43 +00004111*/
4112int sqlite3_load_extension(
4113 sqlite3 *db, /* Load the extension into this database connection */
4114 const char *zFile, /* Name of the shared library containing extension */
4115 const char *zProc, /* Entry point. Derived from zFile if 0 */
4116 char **pzErrMsg /* Put error message here if not 0 */
4117);
4118
4119/*
drh9cd29642008-07-23 00:52:55 +00004120** CAPI3REF: Enable Or Disable Extension Loading {H12620} <S20500>
drh6ed48bf2007-06-14 20:57:18 +00004121**
drhc2e87a32006-06-27 15:16:14 +00004122** So as not to open security holes in older applications that are
drh6ed48bf2007-06-14 20:57:18 +00004123** unprepared to deal with extension loading, and as a means of disabling
mihailimdc884822008-06-22 08:58:50 +00004124** extension loading while evaluating user-entered SQL, the following API
4125** is provided to turn the [sqlite3_load_extension()] mechanism on and off.
drhc2e87a32006-06-27 15:16:14 +00004126**
mihailimdc884822008-06-22 08:58:50 +00004127** Extension loading is off by default. See ticket #1863.
4128**
drh9a247912008-07-22 18:45:08 +00004129** {H12621} Call the sqlite3_enable_load_extension() routine with onoff==1
mihailimdc884822008-06-22 08:58:50 +00004130** to turn extension loading on and call it with onoff==0 to turn
4131** it back off again.
4132**
drh9a247912008-07-22 18:45:08 +00004133** {H12622} Extension loading is off by default.
drhc2e87a32006-06-27 15:16:14 +00004134*/
4135int sqlite3_enable_load_extension(sqlite3 *db, int onoff);
4136
4137/*
drh9cd29642008-07-23 00:52:55 +00004138** CAPI3REF: Automatically Load An Extensions {H12640} <S20500>
drh9eff6162006-06-12 21:59:13 +00004139**
drh1409be62006-08-23 20:07:20 +00004140** This API can be invoked at program startup in order to register
4141** one or more statically linked extensions that will be available
mihailim04bcc002008-06-22 10:21:27 +00004142** to all new [database connections]. {END}
mihailimdc884822008-06-22 08:58:50 +00004143**
4144** This routine stores a pointer to the extension in an array that is
4145** obtained from [sqlite3_malloc()]. If you run a memory leak checker
4146** on your program and it reports a leak because of this array, invoke
4147** [sqlite3_reset_auto_extension()] prior to shutdown to free the memory.
4148**
drh9a247912008-07-22 18:45:08 +00004149** {H12641} This function registers an extension entry point that is
mihailimdc884822008-06-22 08:58:50 +00004150** automatically invoked whenever a new [database connection]
4151** is opened using [sqlite3_open()], [sqlite3_open16()],
4152** or [sqlite3_open_v2()].
4153**
drh9a247912008-07-22 18:45:08 +00004154** {H12642} Duplicate extensions are detected so calling this routine
mihailimdc884822008-06-22 08:58:50 +00004155** multiple times with the same extension is harmless.
4156**
drh9a247912008-07-22 18:45:08 +00004157** {H12643} This routine stores a pointer to the extension in an array
mihailimdc884822008-06-22 08:58:50 +00004158** that is obtained from [sqlite3_malloc()].
4159**
drh9a247912008-07-22 18:45:08 +00004160** {H12644} Automatic extensions apply across all threads.
drh1409be62006-08-23 20:07:20 +00004161*/
drh1875f7a2008-12-08 18:19:17 +00004162int sqlite3_auto_extension(void (*xEntryPoint)(void));
drh1409be62006-08-23 20:07:20 +00004163
drh1409be62006-08-23 20:07:20 +00004164/*
drh9cd29642008-07-23 00:52:55 +00004165** CAPI3REF: Reset Automatic Extension Loading {H12660} <S20500>
drh1409be62006-08-23 20:07:20 +00004166**
mihailim04bcc002008-06-22 10:21:27 +00004167** This function disables all previously registered automatic
4168** extensions. {END} It undoes the effect of all prior
4169** [sqlite3_auto_extension()] calls.
drh6ed48bf2007-06-14 20:57:18 +00004170**
drh9a247912008-07-22 18:45:08 +00004171** {H12661} This function disables all previously registered
mihailimdc884822008-06-22 08:58:50 +00004172** automatic extensions.
4173**
drh9a247912008-07-22 18:45:08 +00004174** {H12662} This function disables automatic extensions in all threads.
drh1409be62006-08-23 20:07:20 +00004175*/
4176void sqlite3_reset_auto_extension(void);
4177
drh1409be62006-08-23 20:07:20 +00004178/*
4179****** EXPERIMENTAL - subject to change without notice **************
4180**
drh9eff6162006-06-12 21:59:13 +00004181** The interface to the virtual-table mechanism is currently considered
4182** to be experimental. The interface might change in incompatible ways.
4183** If this is a problem for you, do not use the interface at this time.
4184**
shane26b34032008-05-23 17:21:09 +00004185** When the virtual-table mechanism stabilizes, we will declare the
drh9eff6162006-06-12 21:59:13 +00004186** interface fixed, support it indefinitely, and remove this comment.
4187*/
4188
4189/*
4190** Structures used by the virtual table interface
drhe09daa92006-06-10 13:29:31 +00004191*/
4192typedef struct sqlite3_vtab sqlite3_vtab;
4193typedef struct sqlite3_index_info sqlite3_index_info;
4194typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor;
4195typedef struct sqlite3_module sqlite3_module;
drh9eff6162006-06-12 21:59:13 +00004196
4197/*
drh9cd29642008-07-23 00:52:55 +00004198** CAPI3REF: Virtual Table Object {H18000} <S20400>
drh9cff9dc2009-04-13 14:43:40 +00004199** KEYWORDS: sqlite3_module {virtual table module}
drhd5a68d32008-08-04 13:44:57 +00004200** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004201**
drh9cff9dc2009-04-13 14:43:40 +00004202** This structure, sometimes called a a "virtual table module",
4203** defines the implementation of a [virtual tables].
4204** This structure consists mostly of methods for the module.
mihailim15194222008-06-22 09:55:14 +00004205**
drh9cff9dc2009-04-13 14:43:40 +00004206** A virtual table module is created by filling in a persistent
4207** instance of this structure and passing a pointer to that instance
4208** to [sqlite3_create_module()] or [sqlite3_create_module_v2()].
4209** The registration remains valid until it is replaced by a different
4210** module or until the [database connection] closes. The content
4211** of this structure must not change while it is registered with
4212** any database connection.
drh9eff6162006-06-12 21:59:13 +00004213*/
drhe09daa92006-06-10 13:29:31 +00004214struct sqlite3_module {
4215 int iVersion;
danielk19779da9d472006-06-14 06:58:15 +00004216 int (*xCreate)(sqlite3*, void *pAux,
drhe4102962006-09-11 00:34:22 +00004217 int argc, const char *const*argv,
drh4ca8aac2006-09-10 17:31:58 +00004218 sqlite3_vtab **ppVTab, char**);
danielk19779da9d472006-06-14 06:58:15 +00004219 int (*xConnect)(sqlite3*, void *pAux,
drhe4102962006-09-11 00:34:22 +00004220 int argc, const char *const*argv,
drh4ca8aac2006-09-10 17:31:58 +00004221 sqlite3_vtab **ppVTab, char**);
drhe09daa92006-06-10 13:29:31 +00004222 int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*);
4223 int (*xDisconnect)(sqlite3_vtab *pVTab);
4224 int (*xDestroy)(sqlite3_vtab *pVTab);
4225 int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor);
4226 int (*xClose)(sqlite3_vtab_cursor*);
drh4be8b512006-06-13 23:51:34 +00004227 int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr,
drhe09daa92006-06-10 13:29:31 +00004228 int argc, sqlite3_value **argv);
4229 int (*xNext)(sqlite3_vtab_cursor*);
danielk1977a298e902006-06-22 09:53:48 +00004230 int (*xEof)(sqlite3_vtab_cursor*);
drhe09daa92006-06-10 13:29:31 +00004231 int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int);
drh6d2069d2007-08-14 01:58:53 +00004232 int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid);
4233 int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *);
drhe09daa92006-06-10 13:29:31 +00004234 int (*xBegin)(sqlite3_vtab *pVTab);
4235 int (*xSync)(sqlite3_vtab *pVTab);
4236 int (*xCommit)(sqlite3_vtab *pVTab);
4237 int (*xRollback)(sqlite3_vtab *pVTab);
drhb7f6f682006-07-08 17:06:43 +00004238 int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName,
drhe94b0c32006-07-08 18:09:15 +00004239 void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),
4240 void **ppArg);
danielk1977182c4ba2007-06-27 15:53:34 +00004241 int (*xRename)(sqlite3_vtab *pVtab, const char *zNew);
drhe09daa92006-06-10 13:29:31 +00004242};
drh9eff6162006-06-12 21:59:13 +00004243
4244/*
drh9cd29642008-07-23 00:52:55 +00004245** CAPI3REF: Virtual Table Indexing Information {H18100} <S20400>
drhb4d58ae2008-02-21 20:17:06 +00004246** KEYWORDS: sqlite3_index_info
drhd5a68d32008-08-04 13:44:57 +00004247** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004248**
drh9eff6162006-06-12 21:59:13 +00004249** The sqlite3_index_info structure and its substructures is used to
drh9cff9dc2009-04-13 14:43:40 +00004250** pass information into and receive the reply from the [xBestIndex]
4251** method of a [virtual table module]. The fields under **Inputs** are the
drh9eff6162006-06-12 21:59:13 +00004252** inputs to xBestIndex and are read-only. xBestIndex inserts its
4253** results into the **Outputs** fields.
4254**
mihailim15194222008-06-22 09:55:14 +00004255** The aConstraint[] array records WHERE clause constraints of the form:
drh9eff6162006-06-12 21:59:13 +00004256**
mihailim15194222008-06-22 09:55:14 +00004257** <pre>column OP expr</pre>
drh9eff6162006-06-12 21:59:13 +00004258**
mihailim15194222008-06-22 09:55:14 +00004259** where OP is =, &lt;, &lt;=, &gt;, or &gt;=. The particular operator is
4260** stored in aConstraint[].op. The index of the column is stored in
drh9eff6162006-06-12 21:59:13 +00004261** aConstraint[].iColumn. aConstraint[].usable is TRUE if the
4262** expr on the right-hand side can be evaluated (and thus the constraint
4263** is usable) and false if it cannot.
4264**
4265** The optimizer automatically inverts terms of the form "expr OP column"
drh98c94802007-10-01 13:50:31 +00004266** and makes other simplifications to the WHERE clause in an attempt to
drh9eff6162006-06-12 21:59:13 +00004267** get as many WHERE clause terms into the form shown above as possible.
4268** The aConstraint[] array only reports WHERE clause terms in the correct
4269** form that refer to the particular virtual table being queried.
4270**
4271** Information about the ORDER BY clause is stored in aOrderBy[].
4272** Each term of aOrderBy records a column of the ORDER BY clause.
4273**
drh9cff9dc2009-04-13 14:43:40 +00004274** The [xBestIndex] method must fill aConstraintUsage[] with information
danielk19775fac9f82006-06-13 14:16:58 +00004275** about what parameters to pass to xFilter. If argvIndex>0 then
drh9eff6162006-06-12 21:59:13 +00004276** the right-hand side of the corresponding aConstraint[] is evaluated
4277** and becomes the argvIndex-th entry in argv. If aConstraintUsage[].omit
4278** is true, then the constraint is assumed to be fully handled by the
4279** virtual table and is not checked again by SQLite.
4280**
drh9cff9dc2009-04-13 14:43:40 +00004281** The idxNum and idxPtr values are recorded and passed into the
4282** [xFilter] method.
4283** [sqlite3_free()] is used to free idxPtr if and only iff
4284** needToFreeIdxPtr is true.
drh9eff6162006-06-12 21:59:13 +00004285**
drh9cff9dc2009-04-13 14:43:40 +00004286** The orderByConsumed means that output from [xFilter]/[xNext] will occur in
drh9eff6162006-06-12 21:59:13 +00004287** the correct order to satisfy the ORDER BY clause so that no separate
4288** sorting step is required.
4289**
4290** The estimatedCost value is an estimate of the cost of doing the
4291** particular lookup. A full scan of a table with N entries should have
4292** a cost of N. A binary search of a table of N entries should have a
4293** cost of approximately log(N).
4294*/
drhe09daa92006-06-10 13:29:31 +00004295struct sqlite3_index_info {
4296 /* Inputs */
drh6cca08c2007-09-21 12:43:16 +00004297 int nConstraint; /* Number of entries in aConstraint */
4298 struct sqlite3_index_constraint {
drh9eff6162006-06-12 21:59:13 +00004299 int iColumn; /* Column on left-hand side of constraint */
4300 unsigned char op; /* Constraint operator */
4301 unsigned char usable; /* True if this constraint is usable */
4302 int iTermOffset; /* Used internally - xBestIndex should ignore */
drh6cca08c2007-09-21 12:43:16 +00004303 } *aConstraint; /* Table of WHERE clause constraints */
4304 int nOrderBy; /* Number of terms in the ORDER BY clause */
4305 struct sqlite3_index_orderby {
drh9eff6162006-06-12 21:59:13 +00004306 int iColumn; /* Column number */
4307 unsigned char desc; /* True for DESC. False for ASC. */
drh6cca08c2007-09-21 12:43:16 +00004308 } *aOrderBy; /* The ORDER BY clause */
drhe09daa92006-06-10 13:29:31 +00004309 /* Outputs */
drh9eff6162006-06-12 21:59:13 +00004310 struct sqlite3_index_constraint_usage {
4311 int argvIndex; /* if >0, constraint is part of argv to xFilter */
4312 unsigned char omit; /* Do not code a test for this constraint */
drh6cca08c2007-09-21 12:43:16 +00004313 } *aConstraintUsage;
drh4be8b512006-06-13 23:51:34 +00004314 int idxNum; /* Number used to identify the index */
4315 char *idxStr; /* String, possibly obtained from sqlite3_malloc */
4316 int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */
drh9eff6162006-06-12 21:59:13 +00004317 int orderByConsumed; /* True if output is already ordered */
4318 double estimatedCost; /* Estimated cost of using this index */
drhe09daa92006-06-10 13:29:31 +00004319};
drh9eff6162006-06-12 21:59:13 +00004320#define SQLITE_INDEX_CONSTRAINT_EQ 2
4321#define SQLITE_INDEX_CONSTRAINT_GT 4
4322#define SQLITE_INDEX_CONSTRAINT_LE 8
4323#define SQLITE_INDEX_CONSTRAINT_LT 16
4324#define SQLITE_INDEX_CONSTRAINT_GE 32
4325#define SQLITE_INDEX_CONSTRAINT_MATCH 64
4326
4327/*
drh9cd29642008-07-23 00:52:55 +00004328** CAPI3REF: Register A Virtual Table Implementation {H18200} <S20400>
drhd5a68d32008-08-04 13:44:57 +00004329** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004330**
drh9cff9dc2009-04-13 14:43:40 +00004331** This routine is used to register a new [virtual table module] name.
4332** Module names must be registered before
4333** creating a new [virtual table] using the module, or before using a
4334** preexisting [virtual table] for the module.
mihailim15194222008-06-22 09:55:14 +00004335**
drh9cff9dc2009-04-13 14:43:40 +00004336** The module name is registered on the [database connection] specified
4337** by the first parameter. The name of the module is given by the
4338** second parameter. The third parameter is a pointer to
4339** the implementation of the [virtual table module]. The fourth
4340** parameter is an arbitrary client data pointer that is passed through
4341** into the [xCreate] and [xConnect] methods of the virtual table module
4342** when a new virtual table is be being created or reinitialized.
4343**
4344** This interface has exactly the same effect as calling
4345** [sqlite3_create_module_v2()] with a NULL client data destructor.
drh9eff6162006-06-12 21:59:13 +00004346*/
shanea79c3cc2008-08-11 17:27:01 +00004347SQLITE_EXPERIMENTAL int sqlite3_create_module(
drh9eff6162006-06-12 21:59:13 +00004348 sqlite3 *db, /* SQLite connection to register module with */
4349 const char *zName, /* Name of the module */
drh9cff9dc2009-04-13 14:43:40 +00004350 const sqlite3_module *p, /* Methods for the module */
4351 void *pClientData /* Client data for xCreate/xConnect */
drhb9bb7c12006-06-11 23:41:55 +00004352);
drhe09daa92006-06-10 13:29:31 +00004353
drh9eff6162006-06-12 21:59:13 +00004354/*
drh9cd29642008-07-23 00:52:55 +00004355** CAPI3REF: Register A Virtual Table Implementation {H18210} <S20400>
drhd5a68d32008-08-04 13:44:57 +00004356** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004357**
drh9cff9dc2009-04-13 14:43:40 +00004358** This routine is identical to the [sqlite3_create_module()] method,
4359** except that it has an extra parameter to specify
4360** a destructor function for the client data pointer. SQLite will
4361** invoke the destructor function (if it is not NULL) when SQLite
4362** no longer needs the pClientData pointer.
danielk1977832a58a2007-06-22 15:21:15 +00004363*/
shanea79c3cc2008-08-11 17:27:01 +00004364SQLITE_EXPERIMENTAL int sqlite3_create_module_v2(
danielk1977832a58a2007-06-22 15:21:15 +00004365 sqlite3 *db, /* SQLite connection to register module with */
4366 const char *zName, /* Name of the module */
drh9cff9dc2009-04-13 14:43:40 +00004367 const sqlite3_module *p, /* Methods for the module */
4368 void *pClientData, /* Client data for xCreate/xConnect */
danielk1977832a58a2007-06-22 15:21:15 +00004369 void(*xDestroy)(void*) /* Module destructor function */
4370);
4371
4372/*
drh9cd29642008-07-23 00:52:55 +00004373** CAPI3REF: Virtual Table Instance Object {H18010} <S20400>
drhb4d58ae2008-02-21 20:17:06 +00004374** KEYWORDS: sqlite3_vtab
drhd5a68d32008-08-04 13:44:57 +00004375** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004376**
drh9cff9dc2009-04-13 14:43:40 +00004377** Every [virtual table module] implementation uses a subclass
4378** of the following structure to describe a particular instance
4379** of the [virtual table]. Each subclass will
mihailim15194222008-06-22 09:55:14 +00004380** be tailored to the specific needs of the module implementation.
4381** The purpose of this superclass is to define certain fields that are
4382** common to all module implementations.
drhfe1368e2006-09-10 17:08:29 +00004383**
4384** Virtual tables methods can set an error message by assigning a
mihailim15194222008-06-22 09:55:14 +00004385** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should
4386** take care that any prior string is freed by a call to [sqlite3_free()]
drhfe1368e2006-09-10 17:08:29 +00004387** prior to assigning a new string to zErrMsg. After the error message
4388** is delivered up to the client application, the string will be automatically
drh9cff9dc2009-04-13 14:43:40 +00004389** freed by sqlite3_free() and the zErrMsg field will be zeroed.
drh9eff6162006-06-12 21:59:13 +00004390*/
4391struct sqlite3_vtab {
drha967e882006-06-13 01:04:52 +00004392 const sqlite3_module *pModule; /* The module for this virtual table */
danielk1977595a5232009-07-24 17:58:53 +00004393 int nRef; /* NO LONGER USED */
drh4ca8aac2006-09-10 17:31:58 +00004394 char *zErrMsg; /* Error message from sqlite3_mprintf() */
drh9eff6162006-06-12 21:59:13 +00004395 /* Virtual table implementations will typically add additional fields */
4396};
4397
drhb4d58ae2008-02-21 20:17:06 +00004398/*
drh9cd29642008-07-23 00:52:55 +00004399** CAPI3REF: Virtual Table Cursor Object {H18020} <S20400>
drh9cff9dc2009-04-13 14:43:40 +00004400** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor}
drhd5a68d32008-08-04 13:44:57 +00004401** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004402**
drh9cff9dc2009-04-13 14:43:40 +00004403** Every [virtual table module] implementation uses a subclass of the
4404** following structure to describe cursors that point into the
4405** [virtual table] and are used
drh9eff6162006-06-12 21:59:13 +00004406** to loop through the virtual table. Cursors are created using the
drh9cff9dc2009-04-13 14:43:40 +00004407** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed
4408** by the [sqlite3_module.xClose | xClose] method. Cussors are used
4409** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods
4410** of the module. Each module implementation will define
drh9eff6162006-06-12 21:59:13 +00004411** the content of a cursor structure to suit its own needs.
4412**
4413** This superclass exists in order to define fields of the cursor that
4414** are common to all implementations.
4415*/
4416struct sqlite3_vtab_cursor {
4417 sqlite3_vtab *pVtab; /* Virtual table of this cursor */
4418 /* Virtual table implementations will typically add additional fields */
4419};
4420
4421/*
drh9cd29642008-07-23 00:52:55 +00004422** CAPI3REF: Declare The Schema Of A Virtual Table {H18280} <S20400>
drhd5a68d32008-08-04 13:44:57 +00004423** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004424**
drh9cff9dc2009-04-13 14:43:40 +00004425** The [xCreate] and [xConnect] methods of a
4426** [virtual table module] call this interface
drh9eff6162006-06-12 21:59:13 +00004427** to declare the format (the names and datatypes of the columns) of
4428** the virtual tables they implement.
4429*/
drh9cff9dc2009-04-13 14:43:40 +00004430SQLITE_EXPERIMENTAL int sqlite3_declare_vtab(sqlite3*, const char *zSQL);
drhe09daa92006-06-10 13:29:31 +00004431
4432/*
drh9cd29642008-07-23 00:52:55 +00004433** CAPI3REF: Overload A Function For A Virtual Table {H18300} <S20400>
drhd5a68d32008-08-04 13:44:57 +00004434** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004435**
drhb7481e72006-09-16 21:45:14 +00004436** Virtual tables can provide alternative implementations of functions
drh9cff9dc2009-04-13 14:43:40 +00004437** using the [xFindFunction] method of the [virtual table module].
4438** But global versions of those functions
drhb7481e72006-09-16 21:45:14 +00004439** must exist in order to be overloaded.
4440**
4441** This API makes sure a global version of a function with a particular
4442** name and number of parameters exists. If no such function exists
4443** before this API is called, a new function is created. The implementation
4444** of the new function always causes an exception to be thrown. So
4445** the new function is not good for anything by itself. Its only
shane26b34032008-05-23 17:21:09 +00004446** purpose is to be a placeholder function that can be overloaded
drh9cff9dc2009-04-13 14:43:40 +00004447** by a [virtual table].
drhb7481e72006-09-16 21:45:14 +00004448*/
shanea79c3cc2008-08-11 17:27:01 +00004449SQLITE_EXPERIMENTAL int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg);
drhb7481e72006-09-16 21:45:14 +00004450
4451/*
drh9eff6162006-06-12 21:59:13 +00004452** The interface to the virtual-table mechanism defined above (back up
4453** to a comment remarkably similar to this one) is currently considered
4454** to be experimental. The interface might change in incompatible ways.
4455** If this is a problem for you, do not use the interface at this time.
4456**
drh98c94802007-10-01 13:50:31 +00004457** When the virtual-table mechanism stabilizes, we will declare the
drh9eff6162006-06-12 21:59:13 +00004458** interface fixed, support it indefinitely, and remove this comment.
4459**
4460****** EXPERIMENTAL - subject to change without notice **************
4461*/
4462
danielk19778cbadb02007-05-03 16:31:26 +00004463/*
drh9cd29642008-07-23 00:52:55 +00004464** CAPI3REF: A Handle To An Open BLOB {H17800} <S30230>
mihailim15194222008-06-22 09:55:14 +00004465** KEYWORDS: {BLOB handle} {BLOB handles}
drh6ed48bf2007-06-14 20:57:18 +00004466**
drhb4d58ae2008-02-21 20:17:06 +00004467** An instance of this object represents an open BLOB on which
mihailim1c492652008-06-21 18:02:16 +00004468** [sqlite3_blob_open | incremental BLOB I/O] can be performed.
mihailim15194222008-06-22 09:55:14 +00004469** Objects of this type are created by [sqlite3_blob_open()]
4470** and destroyed by [sqlite3_blob_close()].
drh6ed48bf2007-06-14 20:57:18 +00004471** The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces
mihailim15194222008-06-22 09:55:14 +00004472** can be used to read or write small subsections of the BLOB.
4473** The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes.
danielk19778cbadb02007-05-03 16:31:26 +00004474*/
danielk1977b4e9af92007-05-01 17:49:49 +00004475typedef struct sqlite3_blob sqlite3_blob;
4476
danielk19778cbadb02007-05-03 16:31:26 +00004477/*
drh9cd29642008-07-23 00:52:55 +00004478** CAPI3REF: Open A BLOB For Incremental I/O {H17810} <S30230>
drh6ed48bf2007-06-14 20:57:18 +00004479**
mihailim04bcc002008-06-22 10:21:27 +00004480** This interfaces opens a [BLOB handle | handle] to the BLOB located
drhf84ddc12008-03-24 12:51:46 +00004481** in row iRow, column zColumn, table zTable in database zDb;
mihailim15194222008-06-22 09:55:14 +00004482** in other words, the same BLOB that would be selected by:
danielk19778cbadb02007-05-03 16:31:26 +00004483**
drh6ed48bf2007-06-14 20:57:18 +00004484** <pre>
drh49c3d572008-12-15 22:51:38 +00004485** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow;
drhf5befa02007-12-06 02:42:07 +00004486** </pre> {END}
danielk19778cbadb02007-05-03 16:31:26 +00004487**
drh554b3832009-05-17 12:07:47 +00004488** If the flags parameter is non-zero, then the BLOB is opened for read
mihailim15194222008-06-22 09:55:14 +00004489** and write access. If it is zero, the BLOB is opened for read access.
danielk19778cbadb02007-05-03 16:31:26 +00004490**
drhf84ddc12008-03-24 12:51:46 +00004491** Note that the database name is not the filename that contains
4492** the database but rather the symbolic name of the database that
4493** is assigned when the database is connected using [ATTACH].
mihailim15194222008-06-22 09:55:14 +00004494** For the main database file, the database name is "main".
4495** For TEMP tables, the database name is "temp".
drhf84ddc12008-03-24 12:51:46 +00004496**
mihailim15194222008-06-22 09:55:14 +00004497** On success, [SQLITE_OK] is returned and the new [BLOB handle] is written
drhabda6112009-05-14 22:37:47 +00004498** to *ppBlob. Otherwise an [error code] is returned and *ppBlob is set
4499** to be a null pointer.
mihailim15194222008-06-22 09:55:14 +00004500** This function sets the [database connection] error code and message
drhabda6112009-05-14 22:37:47 +00004501** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()] and related
4502** functions. Note that the *ppBlob variable is always initialized in a
4503** way that makes it safe to invoke [sqlite3_blob_close()] on *ppBlob
4504** regardless of the success or failure of this routine.
mihailim15194222008-06-22 09:55:14 +00004505**
drh9de1b352008-06-26 15:04:57 +00004506** If the row that a BLOB handle points to is modified by an
4507** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects
4508** then the BLOB handle is marked as "expired".
4509** This is true if any column of the row is changed, even a column
4510** other than the one the BLOB handle is open on.
4511** Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for
4512** a expired BLOB handle fail with an return code of [SQLITE_ABORT].
4513** Changes written into a BLOB prior to the BLOB expiring are not
4514** rollback by the expiration of the BLOB. Such changes will eventually
4515** commit if the transaction continues to completion.
4516**
drhabda6112009-05-14 22:37:47 +00004517** Use the [sqlite3_blob_bytes()] interface to determine the size of
4518** the opened blob. The size of a blob may not be changed by this
drh9e42f8a2009-08-13 20:15:29 +00004519** interface. Use the [UPDATE] SQL command to change the size of a
drhabda6112009-05-14 22:37:47 +00004520** blob.
4521**
4522** The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces
4523** and the built-in [zeroblob] SQL function can be used, if desired,
4524** to create an empty, zero-filled blob in which to read or write using
4525** this interface.
4526**
4527** To avoid a resource leak, every open [BLOB handle] should eventually
4528** be released by a call to [sqlite3_blob_close()].
4529**
drh8b39db12009-02-18 18:37:58 +00004530** Requirements:
4531** [H17813] [H17814] [H17816] [H17819] [H17821] [H17824]
danielk19778cbadb02007-05-03 16:31:26 +00004532*/
danielk1977b4e9af92007-05-01 17:49:49 +00004533int sqlite3_blob_open(
4534 sqlite3*,
4535 const char *zDb,
4536 const char *zTable,
4537 const char *zColumn,
drh6d2069d2007-08-14 01:58:53 +00004538 sqlite3_int64 iRow,
danielk1977b4e9af92007-05-01 17:49:49 +00004539 int flags,
4540 sqlite3_blob **ppBlob
4541);
4542
danielk19778cbadb02007-05-03 16:31:26 +00004543/*
drh9cd29642008-07-23 00:52:55 +00004544** CAPI3REF: Close A BLOB Handle {H17830} <S30230>
drh6ed48bf2007-06-14 20:57:18 +00004545**
mihailim15194222008-06-22 09:55:14 +00004546** Closes an open [BLOB handle].
drh2dd62be2007-12-04 13:22:43 +00004547**
drhb4d58ae2008-02-21 20:17:06 +00004548** Closing a BLOB shall cause the current transaction to commit
drhf5befa02007-12-06 02:42:07 +00004549** if there are no other BLOBs, no pending prepared statements, and the
mihailim15194222008-06-22 09:55:14 +00004550** database connection is in [autocommit mode].
drhb4d58ae2008-02-21 20:17:06 +00004551** If any writes were made to the BLOB, they might be held in cache
drhabda6112009-05-14 22:37:47 +00004552** until the close operation if they will fit.
mihailim15194222008-06-22 09:55:14 +00004553**
drhf5befa02007-12-06 02:42:07 +00004554** Closing the BLOB often forces the changes
drh2dd62be2007-12-04 13:22:43 +00004555** out to disk and so if any I/O errors occur, they will likely occur
drhabda6112009-05-14 22:37:47 +00004556** at the time when the BLOB is closed. Any errors that occur during
drh2dd62be2007-12-04 13:22:43 +00004557** closing are reported as a non-zero return value.
4558**
drhb4d58ae2008-02-21 20:17:06 +00004559** The BLOB is closed unconditionally. Even if this routine returns
drh2dd62be2007-12-04 13:22:43 +00004560** an error code, the BLOB is still closed.
drhb4d58ae2008-02-21 20:17:06 +00004561**
drhabda6112009-05-14 22:37:47 +00004562** Calling this routine with a null pointer (which as would be returned
4563** by failed call to [sqlite3_blob_open()]) is a harmless no-op.
4564**
drh8b39db12009-02-18 18:37:58 +00004565** Requirements:
4566** [H17833] [H17836] [H17839]
danielk19778cbadb02007-05-03 16:31:26 +00004567*/
danielk1977b4e9af92007-05-01 17:49:49 +00004568int sqlite3_blob_close(sqlite3_blob *);
4569
danielk19778cbadb02007-05-03 16:31:26 +00004570/*
drh9cd29642008-07-23 00:52:55 +00004571** CAPI3REF: Return The Size Of An Open BLOB {H17840} <S30230>
drh6ed48bf2007-06-14 20:57:18 +00004572**
drhabda6112009-05-14 22:37:47 +00004573** Returns the size in bytes of the BLOB accessible via the
4574** successfully opened [BLOB handle] in its only argument. The
4575** incremental blob I/O routines can only read or overwriting existing
4576** blob content; they cannot change the size of a blob.
4577**
4578** This routine only works on a [BLOB handle] which has been created
4579** by a prior successful call to [sqlite3_blob_open()] and which has not
4580** been closed by [sqlite3_blob_close()]. Passing any other pointer in
4581** to this routine results in undefined and probably undesirable behavior.
drhb4d58ae2008-02-21 20:17:06 +00004582**
drh8b39db12009-02-18 18:37:58 +00004583** Requirements:
4584** [H17843]
danielk19778cbadb02007-05-03 16:31:26 +00004585*/
danielk1977b4e9af92007-05-01 17:49:49 +00004586int sqlite3_blob_bytes(sqlite3_blob *);
4587
drh9eff6162006-06-12 21:59:13 +00004588/*
drh9cd29642008-07-23 00:52:55 +00004589** CAPI3REF: Read Data From A BLOB Incrementally {H17850} <S30230>
drh6ed48bf2007-06-14 20:57:18 +00004590**
mihailim15194222008-06-22 09:55:14 +00004591** This function is used to read data from an open [BLOB handle] into a
4592** caller-supplied buffer. N bytes of data are copied into buffer Z
4593** from the open BLOB, starting at offset iOffset.
danielk19778cbadb02007-05-03 16:31:26 +00004594**
mihailim15194222008-06-22 09:55:14 +00004595** If offset iOffset is less than N bytes from the end of the BLOB,
drhb4d58ae2008-02-21 20:17:06 +00004596** [SQLITE_ERROR] is returned and no data is read. If N or iOffset is
mihailim15194222008-06-22 09:55:14 +00004597** less than zero, [SQLITE_ERROR] is returned and no data is read.
drhabda6112009-05-14 22:37:47 +00004598** The size of the blob (and hence the maximum value of N+iOffset)
4599** can be determined using the [sqlite3_blob_bytes()] interface.
drhf5befa02007-12-06 02:42:07 +00004600**
drh9de1b352008-06-26 15:04:57 +00004601** An attempt to read from an expired [BLOB handle] fails with an
4602** error code of [SQLITE_ABORT].
4603**
mihailim15194222008-06-22 09:55:14 +00004604** On success, SQLITE_OK is returned.
4605** Otherwise, an [error code] or an [extended error code] is returned.
drhb4d58ae2008-02-21 20:17:06 +00004606**
drhabda6112009-05-14 22:37:47 +00004607** This routine only works on a [BLOB handle] which has been created
4608** by a prior successful call to [sqlite3_blob_open()] and which has not
4609** been closed by [sqlite3_blob_close()]. Passing any other pointer in
4610** to this routine results in undefined and probably undesirable behavior.
4611**
4612** See also: [sqlite3_blob_write()].
4613**
drh8b39db12009-02-18 18:37:58 +00004614** Requirements:
4615** [H17853] [H17856] [H17859] [H17862] [H17863] [H17865] [H17868]
danielk19778cbadb02007-05-03 16:31:26 +00004616*/
drhb4d58ae2008-02-21 20:17:06 +00004617int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset);
danielk19778cbadb02007-05-03 16:31:26 +00004618
4619/*
drh9cd29642008-07-23 00:52:55 +00004620** CAPI3REF: Write Data Into A BLOB Incrementally {H17870} <S30230>
drh6ed48bf2007-06-14 20:57:18 +00004621**
mihailim15194222008-06-22 09:55:14 +00004622** This function is used to write data into an open [BLOB handle] from a
4623** caller-supplied buffer. N bytes of data are copied from the buffer Z
4624** into the open BLOB, starting at offset iOffset.
danielk19778cbadb02007-05-03 16:31:26 +00004625**
mihailim15194222008-06-22 09:55:14 +00004626** If the [BLOB handle] passed as the first argument was not opened for
4627** writing (the flags parameter to [sqlite3_blob_open()] was zero),
4628** this function returns [SQLITE_READONLY].
danielk19778cbadb02007-05-03 16:31:26 +00004629**
mihailim15194222008-06-22 09:55:14 +00004630** This function may only modify the contents of the BLOB; it is
4631** not possible to increase the size of a BLOB using this API.
4632** If offset iOffset is less than N bytes from the end of the BLOB,
4633** [SQLITE_ERROR] is returned and no data is written. If N is
drhf5befa02007-12-06 02:42:07 +00004634** less than zero [SQLITE_ERROR] is returned and no data is written.
drhabda6112009-05-14 22:37:47 +00004635** The size of the BLOB (and hence the maximum value of N+iOffset)
4636** can be determined using the [sqlite3_blob_bytes()] interface.
danielk19778cbadb02007-05-03 16:31:26 +00004637**
drh9de1b352008-06-26 15:04:57 +00004638** An attempt to write to an expired [BLOB handle] fails with an
4639** error code of [SQLITE_ABORT]. Writes to the BLOB that occurred
4640** before the [BLOB handle] expired are not rolled back by the
4641** expiration of the handle, though of course those changes might
4642** have been overwritten by the statement that expired the BLOB handle
4643** or by other independent statements.
4644**
mihailim15194222008-06-22 09:55:14 +00004645** On success, SQLITE_OK is returned.
4646** Otherwise, an [error code] or an [extended error code] is returned.
drhb4d58ae2008-02-21 20:17:06 +00004647**
drhabda6112009-05-14 22:37:47 +00004648** This routine only works on a [BLOB handle] which has been created
4649** by a prior successful call to [sqlite3_blob_open()] and which has not
4650** been closed by [sqlite3_blob_close()]. Passing any other pointer in
4651** to this routine results in undefined and probably undesirable behavior.
4652**
4653** See also: [sqlite3_blob_read()].
4654**
drh8b39db12009-02-18 18:37:58 +00004655** Requirements:
4656** [H17873] [H17874] [H17875] [H17876] [H17877] [H17879] [H17882] [H17885]
4657** [H17888]
danielk19778cbadb02007-05-03 16:31:26 +00004658*/
4659int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset);
4660
drhd84f9462007-08-15 11:28:56 +00004661/*
drh9cd29642008-07-23 00:52:55 +00004662** CAPI3REF: Virtual File System Objects {H11200} <S20100>
drhd84f9462007-08-15 11:28:56 +00004663**
4664** A virtual filesystem (VFS) is an [sqlite3_vfs] object
4665** that SQLite uses to interact
drhb4d58ae2008-02-21 20:17:06 +00004666** with the underlying operating system. Most SQLite builds come with a
drhd84f9462007-08-15 11:28:56 +00004667** single default VFS that is appropriate for the host computer.
4668** New VFSes can be registered and existing VFSes can be unregistered.
4669** The following interfaces are provided.
4670**
mihailim15194222008-06-22 09:55:14 +00004671** The sqlite3_vfs_find() interface returns a pointer to a VFS given its name.
4672** Names are case sensitive.
drhb4d58ae2008-02-21 20:17:06 +00004673** Names are zero-terminated UTF-8 strings.
mihailim15194222008-06-22 09:55:14 +00004674** If there is no match, a NULL pointer is returned.
4675** If zVfsName is NULL then the default VFS is returned.
drhd84f9462007-08-15 11:28:56 +00004676**
drhb4d58ae2008-02-21 20:17:06 +00004677** New VFSes are registered with sqlite3_vfs_register().
4678** Each new VFS becomes the default VFS if the makeDflt flag is set.
4679** The same VFS can be registered multiple times without injury.
4680** To make an existing VFS into the default VFS, register it again
4681** with the makeDflt flag set. If two different VFSes with the
4682** same name are registered, the behavior is undefined. If a
drhb6f5cf32007-08-28 15:21:45 +00004683** VFS is registered with a name that is NULL or an empty string,
4684** then the behavior is undefined.
mihailim15194222008-06-22 09:55:14 +00004685**
drhb4d58ae2008-02-21 20:17:06 +00004686** Unregister a VFS with the sqlite3_vfs_unregister() interface.
4687** If the default VFS is unregistered, another VFS is chosen as
drhd84f9462007-08-15 11:28:56 +00004688** the default. The choice for the new VFS is arbitrary.
drhb4d58ae2008-02-21 20:17:06 +00004689**
drh8b39db12009-02-18 18:37:58 +00004690** Requirements:
4691** [H11203] [H11206] [H11209] [H11212] [H11215] [H11218]
drhd84f9462007-08-15 11:28:56 +00004692*/
drhd677b3d2007-08-20 22:48:41 +00004693sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName);
drhd677b3d2007-08-20 22:48:41 +00004694int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);
4695int sqlite3_vfs_unregister(sqlite3_vfs*);
drhd84f9462007-08-15 11:28:56 +00004696
4697/*
drh9cd29642008-07-23 00:52:55 +00004698** CAPI3REF: Mutexes {H17000} <S20000>
drhd84f9462007-08-15 11:28:56 +00004699**
4700** The SQLite core uses these routines for thread
danielk19774a9d1f62008-06-19 08:51:23 +00004701** synchronization. Though they are intended for internal
drhd84f9462007-08-15 11:28:56 +00004702** use by SQLite, code that links against SQLite is
4703** permitted to use any of these routines.
4704**
mihailim15194222008-06-22 09:55:14 +00004705** The SQLite source code contains multiple implementations
drh8bacf972007-08-25 16:21:29 +00004706** of these mutex routines. An appropriate implementation
4707** is selected automatically at compile-time. The following
4708** implementations are available in the SQLite core:
drhd84f9462007-08-15 11:28:56 +00004709**
4710** <ul>
drhc7ce76a2007-08-30 14:10:30 +00004711** <li> SQLITE_MUTEX_OS2
drhd84f9462007-08-15 11:28:56 +00004712** <li> SQLITE_MUTEX_PTHREAD
drhc7ce76a2007-08-30 14:10:30 +00004713** <li> SQLITE_MUTEX_W32
drhd84f9462007-08-15 11:28:56 +00004714** <li> SQLITE_MUTEX_NOOP
drhd84f9462007-08-15 11:28:56 +00004715** </ul>
4716**
mihailim15194222008-06-22 09:55:14 +00004717** The SQLITE_MUTEX_NOOP implementation is a set of routines
4718** that does no real locking and is appropriate for use in
drhc7ce76a2007-08-30 14:10:30 +00004719** a single-threaded application. The SQLITE_MUTEX_OS2,
4720** SQLITE_MUTEX_PTHREAD, and SQLITE_MUTEX_W32 implementations
shane26b34032008-05-23 17:21:09 +00004721** are appropriate for use on OS/2, Unix, and Windows.
mihailim15194222008-06-22 09:55:14 +00004722**
drh8bacf972007-08-25 16:21:29 +00004723** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor
4724** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex
danielk19774a9d1f62008-06-19 08:51:23 +00004725** implementation is included with the library. In this case the
4726** application must supply a custom mutex implementation using the
4727** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function
mihailim15194222008-06-22 09:55:14 +00004728** before calling sqlite3_initialize() or any other public sqlite3_
danielk19774a9d1f62008-06-19 08:51:23 +00004729** function that calls sqlite3_initialize().
drhcb041342008-06-12 00:07:29 +00004730**
drh9a247912008-07-22 18:45:08 +00004731** {H17011} The sqlite3_mutex_alloc() routine allocates a new
4732** mutex and returns a pointer to it. {H17012} If it returns NULL
4733** that means that a mutex could not be allocated. {H17013} SQLite
4734** will unwind its stack and return an error. {H17014} The argument
drh6bdec4a2007-08-16 19:40:16 +00004735** to sqlite3_mutex_alloc() is one of these integer constants:
4736**
4737** <ul>
4738** <li> SQLITE_MUTEX_FAST
4739** <li> SQLITE_MUTEX_RECURSIVE
4740** <li> SQLITE_MUTEX_STATIC_MASTER
4741** <li> SQLITE_MUTEX_STATIC_MEM
drh86f8c192007-08-22 00:39:19 +00004742** <li> SQLITE_MUTEX_STATIC_MEM2
drh6bdec4a2007-08-16 19:40:16 +00004743** <li> SQLITE_MUTEX_STATIC_PRNG
danielk19779f61c2f2007-08-27 17:27:49 +00004744** <li> SQLITE_MUTEX_STATIC_LRU
danielk1977dfb316d2008-03-26 18:34:43 +00004745** <li> SQLITE_MUTEX_STATIC_LRU2
mihailim04bcc002008-06-22 10:21:27 +00004746** </ul>
drh6bdec4a2007-08-16 19:40:16 +00004747**
drh9a247912008-07-22 18:45:08 +00004748** {H17015} The first two constants cause sqlite3_mutex_alloc() to create
drh6bdec4a2007-08-16 19:40:16 +00004749** a new mutex. The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
drhf5befa02007-12-06 02:42:07 +00004750** is used but not necessarily so when SQLITE_MUTEX_FAST is used. {END}
drh6bdec4a2007-08-16 19:40:16 +00004751** The mutex implementation does not need to make a distinction
4752** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
drh9a247912008-07-22 18:45:08 +00004753** not want to. {H17016} But SQLite will only request a recursive mutex in
drhf5befa02007-12-06 02:42:07 +00004754** cases where it really needs one. {END} If a faster non-recursive mutex
drh6bdec4a2007-08-16 19:40:16 +00004755** implementation is available on the host platform, the mutex subsystem
4756** might return such a mutex in response to SQLITE_MUTEX_FAST.
4757**
drh9a247912008-07-22 18:45:08 +00004758** {H17017} The other allowed parameters to sqlite3_mutex_alloc() each return
shane7c7c3112009-08-17 15:31:23 +00004759** a pointer to a static preexisting mutex. {END} Six static mutexes are
drh6bdec4a2007-08-16 19:40:16 +00004760** used by the current version of SQLite. Future versions of SQLite
4761** may add additional static mutexes. Static mutexes are for internal
4762** use by SQLite only. Applications that use SQLite mutexes should
4763** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
4764** SQLITE_MUTEX_RECURSIVE.
4765**
drh9a247912008-07-22 18:45:08 +00004766** {H17018} Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
drh6bdec4a2007-08-16 19:40:16 +00004767** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
drh9a247912008-07-22 18:45:08 +00004768** returns a different mutex on every call. {H17034} But for the static
drh6bdec4a2007-08-16 19:40:16 +00004769** mutex types, the same mutex is returned on every call that has
mihailim04bcc002008-06-22 10:21:27 +00004770** the same type number.
drhd84f9462007-08-15 11:28:56 +00004771**
drh9a247912008-07-22 18:45:08 +00004772** {H17019} The sqlite3_mutex_free() routine deallocates a previously
4773** allocated dynamic mutex. {H17020} SQLite is careful to deallocate every
drh4766b292008-06-26 02:53:02 +00004774** dynamic mutex that it allocates. {A17021} The dynamic mutexes must not be in
4775** use when they are deallocated. {A17022} Attempting to deallocate a static
drh9a247912008-07-22 18:45:08 +00004776** mutex results in undefined behavior. {H17023} SQLite never deallocates
drhf5befa02007-12-06 02:42:07 +00004777** a static mutex. {END}
drhd84f9462007-08-15 11:28:56 +00004778**
drh6bdec4a2007-08-16 19:40:16 +00004779** The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
drh9a247912008-07-22 18:45:08 +00004780** to enter a mutex. {H17024} If another thread is already within the mutex,
drh6bdec4a2007-08-16 19:40:16 +00004781** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
drh9a247912008-07-22 18:45:08 +00004782** SQLITE_BUSY. {H17025} The sqlite3_mutex_try() interface returns [SQLITE_OK]
4783** upon successful entry. {H17026} Mutexes created using
drhf5befa02007-12-06 02:42:07 +00004784** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread.
drh9a247912008-07-22 18:45:08 +00004785** {H17027} In such cases the,
drh6bdec4a2007-08-16 19:40:16 +00004786** mutex must be exited an equal number of times before another thread
drh4766b292008-06-26 02:53:02 +00004787** can enter. {A17028} If the same thread tries to enter any other
drhf5befa02007-12-06 02:42:07 +00004788** kind of mutex more than once, the behavior is undefined.
drh9a247912008-07-22 18:45:08 +00004789** {H17029} SQLite will never exhibit
drhcb041342008-06-12 00:07:29 +00004790** such behavior in its own use of mutexes.
drhd84f9462007-08-15 11:28:56 +00004791**
mihailim15194222008-06-22 09:55:14 +00004792** Some systems (for example, Windows 95) do not support the operation
4793** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try()
drh9a247912008-07-22 18:45:08 +00004794** will always return SQLITE_BUSY. {H17030} The SQLite core only ever uses
drhcb041342008-06-12 00:07:29 +00004795** sqlite3_mutex_try() as an optimization so this is acceptable behavior.
drhca49cba2007-09-04 22:31:36 +00004796**
drh9a247912008-07-22 18:45:08 +00004797** {H17031} The sqlite3_mutex_leave() routine exits a mutex that was
drh4766b292008-06-26 02:53:02 +00004798** previously entered by the same thread. {A17032} The behavior
drh8bacf972007-08-25 16:21:29 +00004799** is undefined if the mutex is not currently entered by the
drh9a247912008-07-22 18:45:08 +00004800** calling thread or is not currently allocated. {H17033} SQLite will
drhf5befa02007-12-06 02:42:07 +00004801** never do either. {END}
drh8bacf972007-08-25 16:21:29 +00004802**
drh40257ff2008-06-13 18:24:27 +00004803** If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or
4804** sqlite3_mutex_leave() is a NULL pointer, then all three routines
4805** behave as no-ops.
4806**
drh8bacf972007-08-25 16:21:29 +00004807** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()].
4808*/
4809sqlite3_mutex *sqlite3_mutex_alloc(int);
4810void sqlite3_mutex_free(sqlite3_mutex*);
4811void sqlite3_mutex_enter(sqlite3_mutex*);
4812int sqlite3_mutex_try(sqlite3_mutex*);
4813void sqlite3_mutex_leave(sqlite3_mutex*);
4814
drh56a40a82008-06-18 13:47:03 +00004815/*
drh9cd29642008-07-23 00:52:55 +00004816** CAPI3REF: Mutex Methods Object {H17120} <S20130>
drhd5a68d32008-08-04 13:44:57 +00004817** EXPERIMENTAL
drh56a40a82008-06-18 13:47:03 +00004818**
4819** An instance of this structure defines the low-level routines
danielk19774a9d1f62008-06-19 08:51:23 +00004820** used to allocate and use mutexes.
4821**
4822** Usually, the default mutex implementations provided by SQLite are
mihailim15194222008-06-22 09:55:14 +00004823** sufficient, however the user has the option of substituting a custom
4824** implementation for specialized deployments or systems for which SQLite
danielk19774a9d1f62008-06-19 08:51:23 +00004825** does not provide a suitable implementation. In this case, the user
4826** creates and populates an instance of this structure to pass
mihailim15194222008-06-22 09:55:14 +00004827** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option.
danielk19774a9d1f62008-06-19 08:51:23 +00004828** Additionally, an instance of this structure can be used as an
4829** output variable when querying the system for the current mutex
4830** implementation, using the [SQLITE_CONFIG_GETMUTEX] option.
4831**
4832** The xMutexInit method defined by this structure is invoked as
4833** part of system initialization by the sqlite3_initialize() function.
drh9a247912008-07-22 18:45:08 +00004834** {H17001} The xMutexInit routine shall be called by SQLite once for each
mihailim15194222008-06-22 09:55:14 +00004835** effective call to [sqlite3_initialize()].
danielk19774a9d1f62008-06-19 08:51:23 +00004836**
4837** The xMutexEnd method defined by this structure is invoked as
4838** part of system shutdown by the sqlite3_shutdown() function. The
4839** implementation of this method is expected to release all outstanding
4840** resources obtained by the mutex methods implementation, especially
drh9a247912008-07-22 18:45:08 +00004841** those obtained by the xMutexInit method. {H17003} The xMutexEnd()
mihailim15194222008-06-22 09:55:14 +00004842** interface shall be invoked once for each call to [sqlite3_shutdown()].
danielk19774a9d1f62008-06-19 08:51:23 +00004843**
4844** The remaining seven methods defined by this structure (xMutexAlloc,
4845** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and
4846** xMutexNotheld) implement the following interfaces (respectively):
drh56a40a82008-06-18 13:47:03 +00004847**
4848** <ul>
danielk19774a9d1f62008-06-19 08:51:23 +00004849** <li> [sqlite3_mutex_alloc()] </li>
4850** <li> [sqlite3_mutex_free()] </li>
4851** <li> [sqlite3_mutex_enter()] </li>
4852** <li> [sqlite3_mutex_try()] </li>
4853** <li> [sqlite3_mutex_leave()] </li>
4854** <li> [sqlite3_mutex_held()] </li>
4855** <li> [sqlite3_mutex_notheld()] </li>
drh56a40a82008-06-18 13:47:03 +00004856** </ul>
danielk19774a9d1f62008-06-19 08:51:23 +00004857**
4858** The only difference is that the public sqlite3_XXX functions enumerated
4859** above silently ignore any invocations that pass a NULL pointer instead
4860** of a valid mutex handle. The implementations of the methods defined
4861** by this structure are not required to handle this case, the results
4862** of passing a NULL pointer instead of a valid mutex handle are undefined
4863** (i.e. it is acceptable to provide an implementation that segfaults if
4864** it is passed a NULL pointer).
drh9ac06502009-08-17 13:42:29 +00004865**
4866** The xMutexInit() method must be threadsafe. It must be harmless to
4867** invoke xMutexInit() mutiple times within the same process and without
4868** intervening calls to xMutexEnd(). Second and subsequent calls to
4869** xMutexInit() must be no-ops.
4870**
4871** xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()]
4872** and its associates). Similarly, xMutexAlloc() must not use SQLite memory
4873** allocation for a static mutex. However xMutexAlloc() may use SQLite
4874** memory allocation for a fast or recursive mutex.
4875**
4876** SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is
4877** called, but only if the prior call to xMutexInit returned SQLITE_OK.
4878** If xMutexInit fails in any way, it is expected to clean up after itself
4879** prior to returning.
drh56a40a82008-06-18 13:47:03 +00004880*/
danielk19776d2ab0e2008-06-17 17:21:18 +00004881typedef struct sqlite3_mutex_methods sqlite3_mutex_methods;
4882struct sqlite3_mutex_methods {
4883 int (*xMutexInit)(void);
danielk19774a9d1f62008-06-19 08:51:23 +00004884 int (*xMutexEnd)(void);
danielk19776d2ab0e2008-06-17 17:21:18 +00004885 sqlite3_mutex *(*xMutexAlloc)(int);
4886 void (*xMutexFree)(sqlite3_mutex *);
4887 void (*xMutexEnter)(sqlite3_mutex *);
4888 int (*xMutexTry)(sqlite3_mutex *);
4889 void (*xMutexLeave)(sqlite3_mutex *);
danielk19776d2ab0e2008-06-17 17:21:18 +00004890 int (*xMutexHeld)(sqlite3_mutex *);
4891 int (*xMutexNotheld)(sqlite3_mutex *);
4892};
4893
drh8bacf972007-08-25 16:21:29 +00004894/*
drh9cd29642008-07-23 00:52:55 +00004895** CAPI3REF: Mutex Verification Routines {H17080} <S20130> <S30800>
drhd677b3d2007-08-20 22:48:41 +00004896**
4897** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines
drh9a247912008-07-22 18:45:08 +00004898** are intended for use inside assert() statements. {H17081} The SQLite core
drhf77a2ff2007-08-25 14:49:36 +00004899** never uses these routines except inside an assert() and applications
drh9a247912008-07-22 18:45:08 +00004900** are advised to follow the lead of the core. {H17082} The core only
drh8bacf972007-08-25 16:21:29 +00004901** provides implementations for these routines when it is compiled
drh4766b292008-06-26 02:53:02 +00004902** with the SQLITE_DEBUG flag. {A17087} External mutex implementations
drh8bacf972007-08-25 16:21:29 +00004903** are only required to provide these routines if SQLITE_DEBUG is
4904** defined and if NDEBUG is not defined.
4905**
drh9a247912008-07-22 18:45:08 +00004906** {H17083} These routines should return true if the mutex in their argument
mihailim04bcc002008-06-22 10:21:27 +00004907** is held or not held, respectively, by the calling thread.
drh8bacf972007-08-25 16:21:29 +00004908**
drhfddfa2d2007-12-05 18:05:16 +00004909** {X17084} The implementation is not required to provided versions of these
mihailim04bcc002008-06-22 10:21:27 +00004910** routines that actually work. If the implementation does not provide working
4911** versions of these routines, it should at least provide stubs that always
4912** return true so that one does not get spurious assertion failures.
drhd677b3d2007-08-20 22:48:41 +00004913**
drh9a247912008-07-22 18:45:08 +00004914** {H17085} If the argument to sqlite3_mutex_held() is a NULL pointer then
drhfddfa2d2007-12-05 18:05:16 +00004915** the routine should return 1. {END} This seems counter-intuitive since
drhd677b3d2007-08-20 22:48:41 +00004916** clearly the mutex cannot be held if it does not exist. But the
4917** the reason the mutex does not exist is because the build is not
4918** using mutexes. And we do not want the assert() containing the
4919** call to sqlite3_mutex_held() to fail, so a non-zero return is
drh9a247912008-07-22 18:45:08 +00004920** the appropriate thing to do. {H17086} The sqlite3_mutex_notheld()
drhd677b3d2007-08-20 22:48:41 +00004921** interface should also return 1 when given a NULL pointer.
drhd84f9462007-08-15 11:28:56 +00004922*/
drhd677b3d2007-08-20 22:48:41 +00004923int sqlite3_mutex_held(sqlite3_mutex*);
4924int sqlite3_mutex_notheld(sqlite3_mutex*);
drh32bc3f62007-08-21 20:25:39 +00004925
4926/*
drh9cd29642008-07-23 00:52:55 +00004927** CAPI3REF: Mutex Types {H17001} <H17000>
drh32bc3f62007-08-21 20:25:39 +00004928**
drhd5a68d32008-08-04 13:44:57 +00004929** The [sqlite3_mutex_alloc()] interface takes a single argument
mihailim04bcc002008-06-22 10:21:27 +00004930** which is one of these integer constants.
drhd5a68d32008-08-04 13:44:57 +00004931**
4932** The set of static mutexes may change from one SQLite release to the
4933** next. Applications that override the built-in mutex logic must be
4934** prepared to accommodate additional static mutexes.
drh32bc3f62007-08-21 20:25:39 +00004935*/
drh6bdec4a2007-08-16 19:40:16 +00004936#define SQLITE_MUTEX_FAST 0
4937#define SQLITE_MUTEX_RECURSIVE 1
4938#define SQLITE_MUTEX_STATIC_MASTER 2
drh86f8c192007-08-22 00:39:19 +00004939#define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */
drh7555d8e2009-03-20 13:15:30 +00004940#define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */
4941#define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */
drh86f8c192007-08-22 00:39:19 +00004942#define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */
danielk19779f61c2f2007-08-27 17:27:49 +00004943#define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */
danielk1977dfb316d2008-03-26 18:34:43 +00004944#define SQLITE_MUTEX_STATIC_LRU2 7 /* lru page list */
drh6d2069d2007-08-14 01:58:53 +00004945
drhcc6bb3e2007-08-31 16:11:35 +00004946/*
drh4413d0e2008-11-04 13:46:27 +00004947** CAPI3REF: Retrieve the mutex for a database connection {H17002} <H17000>
4948**
4949** This interface returns a pointer the [sqlite3_mutex] object that
4950** serializes access to the [database connection] given in the argument
4951** when the [threading mode] is Serialized.
4952** If the [threading mode] is Single-thread or Multi-thread then this
4953** routine returns a NULL pointer.
4954*/
4955sqlite3_mutex *sqlite3_db_mutex(sqlite3*);
4956
4957/*
drh9cd29642008-07-23 00:52:55 +00004958** CAPI3REF: Low-Level Control Of Database Files {H11300} <S30800>
drhcc6bb3e2007-08-31 16:11:35 +00004959**
drh9a247912008-07-22 18:45:08 +00004960** {H11301} The [sqlite3_file_control()] interface makes a direct call to the
drhcc6bb3e2007-08-31 16:11:35 +00004961** xFileControl method for the [sqlite3_io_methods] object associated
drh9a247912008-07-22 18:45:08 +00004962** with a particular database identified by the second argument. {H11302} The
drhcc6bb3e2007-08-31 16:11:35 +00004963** name of the database is the name assigned to the database by the
4964** <a href="lang_attach.html">ATTACH</a> SQL command that opened the
drh9a247912008-07-22 18:45:08 +00004965** database. {H11303} To control the main database file, use the name "main"
4966** or a NULL pointer. {H11304} The third and fourth parameters to this routine
drhcc6bb3e2007-08-31 16:11:35 +00004967** are passed directly through to the second and third parameters of
drh9a247912008-07-22 18:45:08 +00004968** the xFileControl method. {H11305} The return value of the xFileControl
drhcc6bb3e2007-08-31 16:11:35 +00004969** method becomes the return value of this routine.
4970**
drh9a247912008-07-22 18:45:08 +00004971** {H11306} If the second parameter (zDbName) does not match the name of any
4972** open database file, then SQLITE_ERROR is returned. {H11307} This error
drhcc6bb3e2007-08-31 16:11:35 +00004973** code is not remembered and will not be recalled by [sqlite3_errcode()]
drh4766b292008-06-26 02:53:02 +00004974** or [sqlite3_errmsg()]. {A11308} The underlying xFileControl method might
4975** also return SQLITE_ERROR. {A11309} There is no way to distinguish between
drhcc6bb3e2007-08-31 16:11:35 +00004976** an incorrect zDbName and an SQLITE_ERROR return from the underlying
drhfddfa2d2007-12-05 18:05:16 +00004977** xFileControl method. {END}
drh4ff7fa02007-09-01 18:17:21 +00004978**
4979** See also: [SQLITE_FCNTL_LOCKSTATE]
drhcc6bb3e2007-08-31 16:11:35 +00004980*/
4981int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*);
drh6d2069d2007-08-14 01:58:53 +00004982
danielk19778cbadb02007-05-03 16:31:26 +00004983/*
drh9cd29642008-07-23 00:52:55 +00004984** CAPI3REF: Testing Interface {H11400} <S30800>
drhed13d982008-01-31 14:43:24 +00004985**
4986** The sqlite3_test_control() interface is used to read out internal
4987** state of SQLite and to inject faults into SQLite for testing
shane26b34032008-05-23 17:21:09 +00004988** purposes. The first parameter is an operation code that determines
drhed13d982008-01-31 14:43:24 +00004989** the number, meaning, and operation of all subsequent parameters.
4990**
4991** This interface is not for use by applications. It exists solely
4992** for verifying the correct operation of the SQLite library. Depending
4993** on how the SQLite library is compiled, this interface might not exist.
4994**
4995** The details of the operation codes, their meanings, the parameters
4996** they take, and what they do are all subject to change without notice.
4997** Unlike most of the SQLite API, this function is not guaranteed to
4998** operate consistently from one release to the next.
4999*/
5000int sqlite3_test_control(int op, ...);
5001
5002/*
drh9cd29642008-07-23 00:52:55 +00005003** CAPI3REF: Testing Interface Operation Codes {H11410} <H11400>
drhed13d982008-01-31 14:43:24 +00005004**
5005** These constants are the valid operation code parameters used
5006** as the first argument to [sqlite3_test_control()].
5007**
shane26b34032008-05-23 17:21:09 +00005008** These parameters and their meanings are subject to change
drhed13d982008-01-31 14:43:24 +00005009** without notice. These values are for testing purposes only.
5010** Applications should not use any of these parameters or the
5011** [sqlite3_test_control()] interface.
5012*/
drh2fa18682008-03-19 14:15:34 +00005013#define SQLITE_TESTCTRL_PRNG_SAVE 5
5014#define SQLITE_TESTCTRL_PRNG_RESTORE 6
5015#define SQLITE_TESTCTRL_PRNG_RESET 7
drh3088d592008-03-21 16:45:47 +00005016#define SQLITE_TESTCTRL_BITVEC_TEST 8
danielk1977d09414c2008-06-19 18:17:49 +00005017#define SQLITE_TESTCTRL_FAULT_INSTALL 9
danielk19772d1d86f2008-06-20 14:59:51 +00005018#define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10
drhc7a3bb92009-02-05 16:31:45 +00005019#define SQLITE_TESTCTRL_PENDING_BYTE 11
drhf3af63f2009-05-09 18:59:42 +00005020#define SQLITE_TESTCTRL_ASSERT 12
5021#define SQLITE_TESTCTRL_ALWAYS 13
drhc046e3e2009-07-15 11:26:44 +00005022#define SQLITE_TESTCTRL_RESERVE 14
drhed13d982008-01-31 14:43:24 +00005023
drhf7141992008-06-19 00:16:08 +00005024/*
drh9cd29642008-07-23 00:52:55 +00005025** CAPI3REF: SQLite Runtime Status {H17200} <S60200>
drhd5a68d32008-08-04 13:44:57 +00005026** EXPERIMENTAL
drhf7141992008-06-19 00:16:08 +00005027**
mihailim15194222008-06-22 09:55:14 +00005028** This interface is used to retrieve runtime status information
drhf7141992008-06-19 00:16:08 +00005029** about the preformance of SQLite, and optionally to reset various
5030** highwater marks. The first argument is an integer code for
5031** the specific parameter to measure. Recognized integer codes
5032** are of the form [SQLITE_STATUS_MEMORY_USED | SQLITE_STATUS_...].
5033** The current value of the parameter is returned into *pCurrent.
5034** The highest recorded value is returned in *pHighwater. If the
5035** resetFlag is true, then the highest record value is reset after
5036** *pHighwater is written. Some parameters do not record the highest
5037** value. For those parameters
5038** nothing is written into *pHighwater and the resetFlag is ignored.
5039** Other parameters record only the highwater mark and not the current
5040** value. For these latter parameters nothing is written into *pCurrent.
5041**
5042** This routine returns SQLITE_OK on success and a non-zero
5043** [error code] on failure.
5044**
drh6aa5f152009-08-19 15:57:07 +00005045** This routine is threadsafe but is not atomic. This routine can be
drhf7141992008-06-19 00:16:08 +00005046** called while other threads are running the same or different SQLite
5047** interfaces. However the values returned in *pCurrent and
5048** *pHighwater reflect the status of SQLite at different points in time
5049** and it is possible that another thread might change the parameter
5050** in between the times when *pCurrent and *pHighwater are written.
5051**
drh2462e322008-07-31 14:47:54 +00005052** See also: [sqlite3_db_status()]
drhf7141992008-06-19 00:16:08 +00005053*/
shanea79c3cc2008-08-11 17:27:01 +00005054SQLITE_EXPERIMENTAL int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag);
drh2462e322008-07-31 14:47:54 +00005055
danielk1977075c23a2008-09-01 18:34:20 +00005056
drhf7141992008-06-19 00:16:08 +00005057/*
drh9cd29642008-07-23 00:52:55 +00005058** CAPI3REF: Status Parameters {H17250} <H17200>
drhd5a68d32008-08-04 13:44:57 +00005059** EXPERIMENTAL
drhf7141992008-06-19 00:16:08 +00005060**
5061** These integer constants designate various run-time status parameters
5062** that can be returned by [sqlite3_status()].
5063**
5064** <dl>
5065** <dt>SQLITE_STATUS_MEMORY_USED</dt>
5066** <dd>This parameter is the current amount of memory checked out
mihailim15194222008-06-22 09:55:14 +00005067** using [sqlite3_malloc()], either directly or indirectly. The
drhf7141992008-06-19 00:16:08 +00005068** figure includes calls made to [sqlite3_malloc()] by the application
5069** and internal memory usage by the SQLite library. Scratch memory
5070** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache
5071** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in
5072** this parameter. The amount returned is the sum of the allocation
mihailim15194222008-06-22 09:55:14 +00005073** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>
drhf7141992008-06-19 00:16:08 +00005074**
drhe50135e2008-08-05 17:53:22 +00005075** <dt>SQLITE_STATUS_MALLOC_SIZE</dt>
5076** <dd>This parameter records the largest memory allocation request
5077** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their
5078** internal equivalents). Only the value returned in the
5079** *pHighwater parameter to [sqlite3_status()] is of interest.
5080** The value written into the *pCurrent parameter is undefined.</dd>
5081**
drhf7141992008-06-19 00:16:08 +00005082** <dt>SQLITE_STATUS_PAGECACHE_USED</dt>
5083** <dd>This parameter returns the number of pages used out of the
drhe50135e2008-08-05 17:53:22 +00005084** [pagecache memory allocator] that was configured using
5085** [SQLITE_CONFIG_PAGECACHE]. The
drhf7141992008-06-19 00:16:08 +00005086** value returned is in pages, not in bytes.</dd>
5087**
5088** <dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt>
5089** <dd>This parameter returns the number of bytes of page cache
5090** allocation which could not be statisfied by the [SQLITE_CONFIG_PAGECACHE]
drhe50135e2008-08-05 17:53:22 +00005091** buffer and where forced to overflow to [sqlite3_malloc()]. The
5092** returned value includes allocations that overflowed because they
5093** where too large (they were larger than the "sz" parameter to
5094** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because
5095** no space was left in the page cache.</dd>
5096**
5097** <dt>SQLITE_STATUS_PAGECACHE_SIZE</dt>
5098** <dd>This parameter records the largest memory allocation request
5099** handed to [pagecache memory allocator]. Only the value returned in the
5100** *pHighwater parameter to [sqlite3_status()] is of interest.
5101** The value written into the *pCurrent parameter is undefined.</dd>
drhf7141992008-06-19 00:16:08 +00005102**
5103** <dt>SQLITE_STATUS_SCRATCH_USED</dt>
5104** <dd>This parameter returns the number of allocations used out of the
drhe50135e2008-08-05 17:53:22 +00005105** [scratch memory allocator] configured using
drhf7141992008-06-19 00:16:08 +00005106** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not
drhe50135e2008-08-05 17:53:22 +00005107** in bytes. Since a single thread may only have one scratch allocation
drhf7141992008-06-19 00:16:08 +00005108** outstanding at time, this parameter also reports the number of threads
5109** using scratch memory at the same time.</dd>
5110**
drh71f48622008-07-13 03:55:03 +00005111** <dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt>
drhf7141992008-06-19 00:16:08 +00005112** <dd>This parameter returns the number of bytes of scratch memory
5113** allocation which could not be statisfied by the [SQLITE_CONFIG_SCRATCH]
drhe50135e2008-08-05 17:53:22 +00005114** buffer and where forced to overflow to [sqlite3_malloc()]. The values
5115** returned include overflows because the requested allocation was too
5116** larger (that is, because the requested allocation was larger than the
5117** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer
5118** slots were available.
5119** </dd>
drhf7141992008-06-19 00:16:08 +00005120**
drhe50135e2008-08-05 17:53:22 +00005121** <dt>SQLITE_STATUS_SCRATCH_SIZE</dt>
drhf7141992008-06-19 00:16:08 +00005122** <dd>This parameter records the largest memory allocation request
drhe50135e2008-08-05 17:53:22 +00005123** handed to [scratch memory allocator]. Only the value returned in the
5124** *pHighwater parameter to [sqlite3_status()] is of interest.
5125** The value written into the *pCurrent parameter is undefined.</dd>
drhec424a52008-07-25 15:39:03 +00005126**
5127** <dt>SQLITE_STATUS_PARSER_STACK</dt>
5128** <dd>This parameter records the deepest parser stack. It is only
drh0a60a382008-07-31 17:16:05 +00005129** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>
drhf7141992008-06-19 00:16:08 +00005130** </dl>
5131**
5132** New status parameters may be added from time to time.
5133*/
5134#define SQLITE_STATUS_MEMORY_USED 0
5135#define SQLITE_STATUS_PAGECACHE_USED 1
5136#define SQLITE_STATUS_PAGECACHE_OVERFLOW 2
5137#define SQLITE_STATUS_SCRATCH_USED 3
5138#define SQLITE_STATUS_SCRATCH_OVERFLOW 4
5139#define SQLITE_STATUS_MALLOC_SIZE 5
drhec424a52008-07-25 15:39:03 +00005140#define SQLITE_STATUS_PARSER_STACK 6
drhe50135e2008-08-05 17:53:22 +00005141#define SQLITE_STATUS_PAGECACHE_SIZE 7
5142#define SQLITE_STATUS_SCRATCH_SIZE 8
drhf7141992008-06-19 00:16:08 +00005143
drh633e6d52008-07-28 19:34:53 +00005144/*
drhd1d38482008-10-07 23:46:38 +00005145** CAPI3REF: Database Connection Status {H17500} <S60200>
5146** EXPERIMENTAL
5147**
5148** This interface is used to retrieve runtime status information
5149** about a single [database connection]. The first argument is the
5150** database connection object to be interrogated. The second argument
5151** is the parameter to interrogate. Currently, the only allowed value
5152** for the second parameter is [SQLITE_DBSTATUS_LOOKASIDE_USED].
5153** Additional options will likely appear in future releases of SQLite.
5154**
5155** The current value of the requested parameter is written into *pCur
5156** and the highest instantaneous value is written into *pHiwtr. If
5157** the resetFlg is true, then the highest instantaneous value is
5158** reset back down to the current value.
5159**
5160** See also: [sqlite3_status()] and [sqlite3_stmt_status()].
5161*/
5162SQLITE_EXPERIMENTAL int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg);
5163
5164/*
5165** CAPI3REF: Status Parameters for database connections {H17520} <H17500>
drhd5a68d32008-08-04 13:44:57 +00005166** EXPERIMENTAL
drh633e6d52008-07-28 19:34:53 +00005167**
drh6aa5f152009-08-19 15:57:07 +00005168** These constants are the available integer "verbs" that can be passed as
5169** the second argument to the [sqlite3_db_status()] interface.
5170**
5171** New verbs may be added in future releases of SQLite. Existing verbs
5172** might be discontinued. Applications should check the return code from
5173** [sqlite3_db_status()] to make sure that the call worked.
5174** The [sqlite3_db_status()] interface will return a non-zero error code
5175** if a discontinued or unsupported verb is invoked.
drh633e6d52008-07-28 19:34:53 +00005176**
5177** <dl>
5178** <dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt>
5179** <dd>This parameter returns the number of lookaside memory slots currently
5180** checked out.</dd>
5181** </dl>
5182*/
5183#define SQLITE_DBSTATUS_LOOKASIDE_USED 0
drhed13d982008-01-31 14:43:24 +00005184
drhd1d38482008-10-07 23:46:38 +00005185
5186/*
5187** CAPI3REF: Prepared Statement Status {H17550} <S60200>
5188** EXPERIMENTAL
5189**
5190** Each prepared statement maintains various
5191** [SQLITE_STMTSTATUS_SORT | counters] that measure the number
5192** of times it has performed specific operations. These counters can
5193** be used to monitor the performance characteristics of the prepared
5194** statements. For example, if the number of table steps greatly exceeds
5195** the number of table searches or result rows, that would tend to indicate
5196** that the prepared statement is using a full table scan rather than
5197** an index.
5198**
5199** This interface is used to retrieve and reset counter values from
5200** a [prepared statement]. The first argument is the prepared statement
5201** object to be interrogated. The second argument
5202** is an integer code for a specific [SQLITE_STMTSTATUS_SORT | counter]
5203** to be interrogated.
5204** The current value of the requested counter is returned.
5205** If the resetFlg is true, then the counter is reset to zero after this
5206** interface call returns.
5207**
5208** See also: [sqlite3_status()] and [sqlite3_db_status()].
5209*/
5210SQLITE_EXPERIMENTAL int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg);
5211
5212/*
5213** CAPI3REF: Status Parameters for prepared statements {H17570} <H17550>
5214** EXPERIMENTAL
5215**
5216** These preprocessor macros define integer codes that name counter
5217** values associated with the [sqlite3_stmt_status()] interface.
5218** The meanings of the various counters are as follows:
5219**
5220** <dl>
5221** <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt>
5222** <dd>This is the number of times that SQLite has stepped forward in
5223** a table as part of a full table scan. Large numbers for this counter
5224** may indicate opportunities for performance improvement through
5225** careful use of indices.</dd>
5226**
5227** <dt>SQLITE_STMTSTATUS_SORT</dt>
5228** <dd>This is the number of sort operations that have occurred.
5229** A non-zero value in this counter may indicate an opportunity to
5230** improvement performance through careful use of indices.</dd>
5231**
5232** </dl>
5233*/
5234#define SQLITE_STMTSTATUS_FULLSCAN_STEP 1
5235#define SQLITE_STMTSTATUS_SORT 2
5236
drhed13d982008-01-31 14:43:24 +00005237/*
drh21614742008-11-18 19:18:08 +00005238** CAPI3REF: Custom Page Cache Object
5239** EXPERIMENTAL
5240**
danielk1977bc2ca9e2008-11-13 14:28:28 +00005241** The sqlite3_pcache type is opaque. It is implemented by
5242** the pluggable module. The SQLite core has no knowledge of
5243** its size or internal structure and never deals with the
5244** sqlite3_pcache object except by holding and passing pointers
5245** to the object.
drh21614742008-11-18 19:18:08 +00005246**
5247** See [sqlite3_pcache_methods] for additional information.
danielk1977bc2ca9e2008-11-13 14:28:28 +00005248*/
5249typedef struct sqlite3_pcache sqlite3_pcache;
5250
5251/*
drh21614742008-11-18 19:18:08 +00005252** CAPI3REF: Application Defined Page Cache.
danielk1977bc2ca9e2008-11-13 14:28:28 +00005253** EXPERIMENTAL
5254**
drh21614742008-11-18 19:18:08 +00005255** The [sqlite3_config]([SQLITE_CONFIG_PCACHE], ...) interface can
danielk1977bc2ca9e2008-11-13 14:28:28 +00005256** register an alternative page cache implementation by passing in an
5257** instance of the sqlite3_pcache_methods structure. The majority of the
shane7c7c3112009-08-17 15:31:23 +00005258** heap memory used by SQLite is used by the page cache to cache data read
danielk1977bc2ca9e2008-11-13 14:28:28 +00005259** from, or ready to be written to, the database file. By implementing a
5260** custom page cache using this API, an application can control more
shane7c7c3112009-08-17 15:31:23 +00005261** precisely the amount of memory consumed by SQLite, the way in which
danielk1977bc2ca9e2008-11-13 14:28:28 +00005262** said memory is allocated and released, and the policies used to
5263** determine exactly which parts of a database file are cached and for
5264** how long.
5265**
shane7c7c3112009-08-17 15:31:23 +00005266** The contents of the structure are copied to an internal buffer by SQLite
danielk1977bc2ca9e2008-11-13 14:28:28 +00005267** within the call to [sqlite3_config].
5268**
drh21614742008-11-18 19:18:08 +00005269** The xInit() method is called once for each call to [sqlite3_initialize()]
danielk1977bc2ca9e2008-11-13 14:28:28 +00005270** (usually only once during the lifetime of the process). It is passed
5271** a copy of the sqlite3_pcache_methods.pArg value. It can be used to set
5272** up global structures and mutexes required by the custom page cache
shane7c7c3112009-08-17 15:31:23 +00005273** implementation.
5274**
5275** The xShutdown() method is called from within [sqlite3_shutdown()],
5276** if the application invokes this API. It can be used to clean up
5277** any outstanding resources before process shutdown, if required.
5278**
5279** SQLite holds a [SQLITE_MUTEX_RECURSIVE] mutex when it invokes
5280** the xInit method, so the xInit method need not be threadsafe. The
5281** xShutdown method is only called from [sqlite3_shutdown()] so it does
5282** not need to be threadsafe either. All other methods must be threadsafe
5283** in multithreaded applications.
5284**
5285** SQLite will never invoke xInit() more than once without an intervening
5286** call to xShutdown().
danielk1977bc2ca9e2008-11-13 14:28:28 +00005287**
5288** The xCreate() method is used to construct a new cache instance. The
5289** first parameter, szPage, is the size in bytes of the pages that must
5290** be allocated by the cache. szPage will not be a power of two. The
5291** second argument, bPurgeable, is true if the cache being created will
5292** be used to cache database pages read from a file stored on disk, or
5293** false if it is used for an in-memory database. The cache implementation
5294** does not have to do anything special based on the value of bPurgeable,
5295** it is purely advisory.
5296**
5297** The xCachesize() method may be called at any time by SQLite to set the
5298** suggested maximum cache-size (number of pages stored by) the cache
5299** instance passed as the first argument. This is the value configured using
drh21614742008-11-18 19:18:08 +00005300** the SQLite "[PRAGMA cache_size]" command. As with the bPurgeable parameter,
danielk1977bc2ca9e2008-11-13 14:28:28 +00005301** the implementation is not required to do anything special with this
5302** value, it is advisory only.
5303**
5304** The xPagecount() method should return the number of pages currently
5305** stored in the cache supplied as an argument.
5306**
5307** The xFetch() method is used to fetch a page and return a pointer to it.
5308** A 'page', in this context, is a buffer of szPage bytes aligned at an
5309** 8-byte boundary. The page to be fetched is determined by the key. The
5310** mimimum key value is 1. After it has been retrieved using xFetch, the page
5311** is considered to be pinned.
5312**
5313** If the requested page is already in the page cache, then a pointer to
5314** the cached buffer should be returned with its contents intact. If the
5315** page is not already in the cache, then the expected behaviour of the
5316** cache is determined by the value of the createFlag parameter passed
5317** to xFetch, according to the following table:
5318**
5319** <table border=1 width=85% align=center>
5320** <tr><th>createFlag<th>Expected Behaviour
5321** <tr><td>0<td>NULL should be returned. No new cache entry is created.
5322** <tr><td>1<td>If createFlag is set to 1, this indicates that
5323** SQLite is holding pinned pages that can be unpinned
5324** by writing their contents to the database file (a
5325** relatively expensive operation). In this situation the
5326** cache implementation has two choices: it can return NULL,
5327** in which case SQLite will attempt to unpin one or more
5328** pages before re-requesting the same page, or it can
5329** allocate a new page and return a pointer to it. If a new
danielk1977e1fd5082009-01-23 16:45:00 +00005330** page is allocated, then the first sizeof(void*) bytes of
5331** it (at least) must be zeroed before it is returned.
danielk1977bc2ca9e2008-11-13 14:28:28 +00005332** <tr><td>2<td>If createFlag is set to 2, then SQLite is not holding any
5333** pinned pages associated with the specific cache passed
5334** as the first argument to xFetch() that can be unpinned. The
5335** cache implementation should attempt to allocate a new
danielk1977e1fd5082009-01-23 16:45:00 +00005336** cache entry and return a pointer to it. Again, the first
5337** sizeof(void*) bytes of the page should be zeroed before
5338** it is returned. If the xFetch() method returns NULL when
5339** createFlag==2, SQLite assumes that a memory allocation
5340** failed and returns SQLITE_NOMEM to the user.
danielk1977bc2ca9e2008-11-13 14:28:28 +00005341** </table>
5342**
5343** xUnpin() is called by SQLite with a pointer to a currently pinned page
5344** as its second argument. If the third parameter, discard, is non-zero,
5345** then the page should be evicted from the cache. In this case SQLite
5346** assumes that the next time the page is retrieved from the cache using
5347** the xFetch() method, it will be zeroed. If the discard parameter is
5348** zero, then the page is considered to be unpinned. The cache implementation
5349** may choose to reclaim (free or recycle) unpinned pages at any time.
5350** SQLite assumes that next time the page is retrieved from the cache
5351** it will either be zeroed, or contain the same data that it did when it
5352** was unpinned.
5353**
5354** The cache is not required to perform any reference counting. A single
5355** call to xUnpin() unpins the page regardless of the number of prior calls
5356** to xFetch().
5357**
5358** The xRekey() method is used to change the key value associated with the
5359** page passed as the second argument from oldKey to newKey. If the cache
drhb232c232008-11-19 01:20:26 +00005360** previously contains an entry associated with newKey, it should be
5361** discarded. Any prior cache entry associated with newKey is guaranteed not
5362** to be pinned.
danielk1977bc2ca9e2008-11-13 14:28:28 +00005363**
5364** When SQLite calls the xTruncate() method, the cache must discard all
5365** existing cache entries with page numbers (keys) greater than or equal
5366** to the value of the iLimit parameter passed to xTruncate(). If any
5367** of these pages are pinned, they are implicitly unpinned, meaning that
5368** they can be safely discarded.
5369**
5370** The xDestroy() method is used to delete a cache allocated by xCreate().
5371** All resources associated with the specified cache should be freed. After
drh21614742008-11-18 19:18:08 +00005372** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*]
danielk1977bc2ca9e2008-11-13 14:28:28 +00005373** handle invalid, and will not use it with any other sqlite3_pcache_methods
5374** functions.
5375*/
5376typedef struct sqlite3_pcache_methods sqlite3_pcache_methods;
5377struct sqlite3_pcache_methods {
5378 void *pArg;
5379 int (*xInit)(void*);
5380 void (*xShutdown)(void*);
5381 sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable);
5382 void (*xCachesize)(sqlite3_pcache*, int nCachesize);
5383 int (*xPagecount)(sqlite3_pcache*);
5384 void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
5385 void (*xUnpin)(sqlite3_pcache*, void*, int discard);
5386 void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey);
5387 void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);
5388 void (*xDestroy)(sqlite3_pcache*);
5389};
5390
5391/*
drh27b3b842009-02-03 18:25:13 +00005392** CAPI3REF: Online Backup Object
5393** EXPERIMENTAL
5394**
5395** The sqlite3_backup object records state information about an ongoing
5396** online backup operation. The sqlite3_backup object is created by
5397** a call to [sqlite3_backup_init()] and is destroyed by a call to
5398** [sqlite3_backup_finish()].
drh52224a72009-02-10 13:41:42 +00005399**
5400** See Also: [Using the SQLite Online Backup API]
drh27b3b842009-02-03 18:25:13 +00005401*/
5402typedef struct sqlite3_backup sqlite3_backup;
5403
5404/*
danielk197704103022009-02-03 16:51:24 +00005405** CAPI3REF: Online Backup API.
5406** EXPERIMENTAL
5407**
5408** This API is used to overwrite the contents of one database with that
5409** of another. It is useful either for creating backups of databases or
5410** for copying in-memory databases to or from persistent files.
5411**
drh52224a72009-02-10 13:41:42 +00005412** See Also: [Using the SQLite Online Backup API]
5413**
danielk197704103022009-02-03 16:51:24 +00005414** Exclusive access is required to the destination database for the
5415** duration of the operation. However the source database is only
5416** read-locked while it is actually being read, it is not locked
5417** continuously for the entire operation. Thus, the backup may be
5418** performed on a live database without preventing other users from
5419** writing to the database for an extended period of time.
5420**
5421** To perform a backup operation:
5422** <ol>
drh62b5d2d2009-02-03 18:47:22 +00005423** <li><b>sqlite3_backup_init()</b> is called once to initialize the
5424** backup,
5425** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer
danielk197704103022009-02-03 16:51:24 +00005426** the data between the two databases, and finally
drh62b5d2d2009-02-03 18:47:22 +00005427** <li><b>sqlite3_backup_finish()</b> is called to release all resources
danielk197704103022009-02-03 16:51:24 +00005428** associated with the backup operation.
5429** </ol>
5430** There should be exactly one call to sqlite3_backup_finish() for each
5431** successful call to sqlite3_backup_init().
5432**
5433** <b>sqlite3_backup_init()</b>
5434**
5435** The first two arguments passed to [sqlite3_backup_init()] are the database
5436** handle associated with the destination database and the database name
5437** used to attach the destination database to the handle. The database name
5438** is "main" for the main database, "temp" for the temporary database, or
drh62b5d2d2009-02-03 18:47:22 +00005439** the name specified as part of the [ATTACH] statement if the destination is
danielk197704103022009-02-03 16:51:24 +00005440** an attached database. The third and fourth arguments passed to
drh62b5d2d2009-02-03 18:47:22 +00005441** sqlite3_backup_init() identify the [database connection]
5442** and database name used
danielk197704103022009-02-03 16:51:24 +00005443** to access the source database. The values passed for the source and
drh62b5d2d2009-02-03 18:47:22 +00005444** destination [database connection] parameters must not be the same.
danielk197704103022009-02-03 16:51:24 +00005445**
5446** If an error occurs within sqlite3_backup_init(), then NULL is returned
drh62b5d2d2009-02-03 18:47:22 +00005447** and an error code and error message written into the [database connection]
danielk197704103022009-02-03 16:51:24 +00005448** passed as the first argument. They may be retrieved using the
drh62b5d2d2009-02-03 18:47:22 +00005449** [sqlite3_errcode()], [sqlite3_errmsg()], and [sqlite3_errmsg16()] functions.
drh27b3b842009-02-03 18:25:13 +00005450** Otherwise, if successful, a pointer to an [sqlite3_backup] object is
5451** returned. This pointer may be used with the sqlite3_backup_step() and
danielk197704103022009-02-03 16:51:24 +00005452** sqlite3_backup_finish() functions to perform the specified backup
5453** operation.
5454**
5455** <b>sqlite3_backup_step()</b>
5456**
5457** Function [sqlite3_backup_step()] is used to copy up to nPage pages between
5458** the source and destination databases, where nPage is the value of the
danielk197703ab0352009-02-06 05:59:44 +00005459** second parameter passed to sqlite3_backup_step(). If nPage is a negative
5460** value, all remaining source pages are copied. If the required pages are
danielk197704103022009-02-03 16:51:24 +00005461** succesfully copied, but there are still more pages to copy before the
drh62b5d2d2009-02-03 18:47:22 +00005462** backup is complete, it returns [SQLITE_OK]. If no error occured and there
5463** are no more pages to copy, then [SQLITE_DONE] is returned. If an error
5464** occurs, then an SQLite error code is returned. As well as [SQLITE_OK] and
5465** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY],
5466** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an
5467** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code.
danielk197704103022009-02-03 16:51:24 +00005468**
5469** As well as the case where the destination database file was opened for
drh62b5d2d2009-02-03 18:47:22 +00005470** read-only access, sqlite3_backup_step() may return [SQLITE_READONLY] if
danielk197704103022009-02-03 16:51:24 +00005471** the destination is an in-memory database with a different page size
5472** from the source database.
5473**
5474** If sqlite3_backup_step() cannot obtain a required file-system lock, then
drh62b5d2d2009-02-03 18:47:22 +00005475** the [sqlite3_busy_handler | busy-handler function]
5476** is invoked (if one is specified). If the
danielk197704103022009-02-03 16:51:24 +00005477** busy-handler returns non-zero before the lock is available, then
drh62b5d2d2009-02-03 18:47:22 +00005478** [SQLITE_BUSY] is returned to the caller. In this case the call to
5479** sqlite3_backup_step() can be retried later. If the source
5480** [database connection]
danielk197704103022009-02-03 16:51:24 +00005481** is being used to write to the source database when sqlite3_backup_step()
drh62b5d2d2009-02-03 18:47:22 +00005482** is called, then [SQLITE_LOCKED] is returned immediately. Again, in this
danielk197704103022009-02-03 16:51:24 +00005483** case the call to sqlite3_backup_step() can be retried later on. If
drh62b5d2d2009-02-03 18:47:22 +00005484** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or
5485** [SQLITE_READONLY] is returned, then
danielk197704103022009-02-03 16:51:24 +00005486** there is no point in retrying the call to sqlite3_backup_step(). These
5487** errors are considered fatal. At this point the application must accept
5488** that the backup operation has failed and pass the backup operation handle
5489** to the sqlite3_backup_finish() to release associated resources.
5490**
5491** Following the first call to sqlite3_backup_step(), an exclusive lock is
5492** obtained on the destination file. It is not released until either
5493** sqlite3_backup_finish() is called or the backup operation is complete
drh62b5d2d2009-02-03 18:47:22 +00005494** and sqlite3_backup_step() returns [SQLITE_DONE]. Additionally, each time
5495** a call to sqlite3_backup_step() is made a [shared lock] is obtained on
danielk197704103022009-02-03 16:51:24 +00005496** the source database file. This lock is released before the
5497** sqlite3_backup_step() call returns. Because the source database is not
5498** locked between calls to sqlite3_backup_step(), it may be modified mid-way
5499** through the backup procedure. If the source database is modified by an
5500** external process or via a database connection other than the one being
5501** used by the backup operation, then the backup will be transparently
5502** restarted by the next call to sqlite3_backup_step(). If the source
5503** database is modified by the using the same database connection as is used
5504** by the backup operation, then the backup database is transparently
5505** updated at the same time.
5506**
5507** <b>sqlite3_backup_finish()</b>
5508**
drh62b5d2d2009-02-03 18:47:22 +00005509** Once sqlite3_backup_step() has returned [SQLITE_DONE], or when the
drh27b3b842009-02-03 18:25:13 +00005510** application wishes to abandon the backup operation, the [sqlite3_backup]
5511** object should be passed to sqlite3_backup_finish(). This releases all
danielk197704103022009-02-03 16:51:24 +00005512** resources associated with the backup operation. If sqlite3_backup_step()
drh62b5d2d2009-02-03 18:47:22 +00005513** has not yet returned [SQLITE_DONE], then any active write-transaction on the
drh27b3b842009-02-03 18:25:13 +00005514** destination database is rolled back. The [sqlite3_backup] object is invalid
danielk197704103022009-02-03 16:51:24 +00005515** and may not be used following a call to sqlite3_backup_finish().
5516**
drh62b5d2d2009-02-03 18:47:22 +00005517** The value returned by sqlite3_backup_finish is [SQLITE_OK] if no error
5518** occurred, regardless or whether or not sqlite3_backup_step() was called
danielk197704103022009-02-03 16:51:24 +00005519** a sufficient number of times to complete the backup operation. Or, if
5520** an out-of-memory condition or IO error occured during a call to
drh62b5d2d2009-02-03 18:47:22 +00005521** sqlite3_backup_step() then [SQLITE_NOMEM] or an
5522** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] error code
danielk197704103022009-02-03 16:51:24 +00005523** is returned. In this case the error code and an error message are
drh62b5d2d2009-02-03 18:47:22 +00005524** written to the destination [database connection].
danielk197704103022009-02-03 16:51:24 +00005525**
drh62b5d2d2009-02-03 18:47:22 +00005526** A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step() is
5527** not a permanent error and does not affect the return value of
danielk197704103022009-02-03 16:51:24 +00005528** sqlite3_backup_finish().
5529**
5530** <b>sqlite3_backup_remaining(), sqlite3_backup_pagecount()</b>
5531**
5532** Each call to sqlite3_backup_step() sets two values stored internally
drh27b3b842009-02-03 18:25:13 +00005533** by an [sqlite3_backup] object. The number of pages still to be backed
danielk197704103022009-02-03 16:51:24 +00005534** up, which may be queried by sqlite3_backup_remaining(), and the total
5535** number of pages in the source database file, which may be queried by
5536** sqlite3_backup_pagecount().
5537**
5538** The values returned by these functions are only updated by
5539** sqlite3_backup_step(). If the source database is modified during a backup
5540** operation, then the values are not updated to account for any extra
5541** pages that need to be updated or the size of the source database file
5542** changing.
5543**
5544** <b>Concurrent Usage of Database Handles</b>
5545**
drh62b5d2d2009-02-03 18:47:22 +00005546** The source [database connection] may be used by the application for other
danielk197704103022009-02-03 16:51:24 +00005547** purposes while a backup operation is underway or being initialized.
5548** If SQLite is compiled and configured to support threadsafe database
5549** connections, then the source database connection may be used concurrently
5550** from within other threads.
5551**
5552** However, the application must guarantee that the destination database
5553** connection handle is not passed to any other API (by any thread) after
5554** sqlite3_backup_init() is called and before the corresponding call to
5555** sqlite3_backup_finish(). Unfortunately SQLite does not currently check
drh62b5d2d2009-02-03 18:47:22 +00005556** for this, if the application does use the destination [database connection]
danielk197704103022009-02-03 16:51:24 +00005557** for some other purpose during a backup operation, things may appear to
drh662c58c2009-02-03 21:13:07 +00005558** work correctly but in fact be subtly malfunctioning. Use of the
5559** destination database connection while a backup is in progress might
5560** also cause a mutex deadlock.
danielk197704103022009-02-03 16:51:24 +00005561**
drh62b5d2d2009-02-03 18:47:22 +00005562** Furthermore, if running in [shared cache mode], the application must
danielk197704103022009-02-03 16:51:24 +00005563** guarantee that the shared cache used by the destination database
5564** is not accessed while the backup is running. In practice this means
5565** that the application must guarantee that the file-system file being
5566** backed up to is not accessed by any connection within the process,
5567** not just the specific connection that was passed to sqlite3_backup_init().
5568**
drh27b3b842009-02-03 18:25:13 +00005569** The [sqlite3_backup] object itself is partially threadsafe. Multiple
danielk197704103022009-02-03 16:51:24 +00005570** threads may safely make multiple concurrent calls to sqlite3_backup_step().
5571** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount()
5572** APIs are not strictly speaking threadsafe. If they are invoked at the
5573** same time as another thread is invoking sqlite3_backup_step() it is
5574** possible that they return invalid values.
5575*/
danielk197704103022009-02-03 16:51:24 +00005576sqlite3_backup *sqlite3_backup_init(
5577 sqlite3 *pDest, /* Destination database handle */
5578 const char *zDestName, /* Destination database name */
5579 sqlite3 *pSource, /* Source database handle */
5580 const char *zSourceName /* Source database name */
5581);
5582int sqlite3_backup_step(sqlite3_backup *p, int nPage);
5583int sqlite3_backup_finish(sqlite3_backup *p);
5584int sqlite3_backup_remaining(sqlite3_backup *p);
5585int sqlite3_backup_pagecount(sqlite3_backup *p);
5586
5587/*
danielk1977404ca072009-03-16 13:19:36 +00005588** CAPI3REF: Unlock Notification
5589** EXPERIMENTAL
5590**
5591** When running in shared-cache mode, a database operation may fail with
drh89487472009-03-16 13:37:02 +00005592** an [SQLITE_LOCKED] error if the required locks on the shared-cache or
danielk1977404ca072009-03-16 13:19:36 +00005593** individual tables within the shared-cache cannot be obtained. See
5594** [SQLite Shared-Cache Mode] for a description of shared-cache locking.
5595** This API may be used to register a callback that SQLite will invoke
5596** when the connection currently holding the required lock relinquishes it.
5597** This API is only available if the library was compiled with the
drh89487472009-03-16 13:37:02 +00005598** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined.
danielk1977404ca072009-03-16 13:19:36 +00005599**
5600** See Also: [Using the SQLite Unlock Notification Feature].
5601**
5602** Shared-cache locks are released when a database connection concludes
5603** its current transaction, either by committing it or rolling it back.
5604**
5605** When a connection (known as the blocked connection) fails to obtain a
5606** shared-cache lock and SQLITE_LOCKED is returned to the caller, the
5607** identity of the database connection (the blocking connection) that
5608** has locked the required resource is stored internally. After an
5609** application receives an SQLITE_LOCKED error, it may call the
5610** sqlite3_unlock_notify() method with the blocked connection handle as
5611** the first argument to register for a callback that will be invoked
5612** when the blocking connections current transaction is concluded. The
5613** callback is invoked from within the [sqlite3_step] or [sqlite3_close]
5614** call that concludes the blocking connections transaction.
5615**
5616** If sqlite3_unlock_notify() is called in a multi-threaded application,
5617** there is a chance that the blocking connection will have already
5618** concluded its transaction by the time sqlite3_unlock_notify() is invoked.
5619** If this happens, then the specified callback is invoked immediately,
5620** from within the call to sqlite3_unlock_notify().
5621**
5622** If the blocked connection is attempting to obtain a write-lock on a
5623** shared-cache table, and more than one other connection currently holds
5624** a read-lock on the same table, then SQLite arbitrarily selects one of
5625** the other connections to use as the blocking connection.
5626**
5627** There may be at most one unlock-notify callback registered by a
5628** blocked connection. If sqlite3_unlock_notify() is called when the
5629** blocked connection already has a registered unlock-notify callback,
5630** then the new callback replaces the old. If sqlite3_unlock_notify() is
5631** called with a NULL pointer as its second argument, then any existing
5632** unlock-notify callback is cancelled. The blocked connections
5633** unlock-notify callback may also be canceled by closing the blocked
5634** connection using [sqlite3_close()].
5635**
5636** The unlock-notify callback is not reentrant. If an application invokes
5637** any sqlite3_xxx API functions from within an unlock-notify callback, a
5638** crash or deadlock may be the result.
5639**
5640** Unless deadlock is detected (see below), sqlite3_unlock_notify() always
5641** returns SQLITE_OK.
5642**
5643** <b>Callback Invocation Details</b>
5644**
5645** When an unlock-notify callback is registered, the application provides a
5646** single void* pointer that is passed to the callback when it is invoked.
5647** However, the signature of the callback function allows SQLite to pass
5648** it an array of void* context pointers. The first argument passed to
5649** an unlock-notify callback is a pointer to an array of void* pointers,
5650** and the second is the number of entries in the array.
5651**
5652** When a blocking connections transaction is concluded, there may be
5653** more than one blocked connection that has registered for an unlock-notify
5654** callback. If two or more such blocked connections have specified the
5655** same callback function, then instead of invoking the callback function
5656** multiple times, it is invoked once with the set of void* context pointers
5657** specified by the blocked connections bundled together into an array.
5658** This gives the application an opportunity to prioritize any actions
5659** related to the set of unblocked database connections.
5660**
5661** <b>Deadlock Detection</b>
5662**
5663** Assuming that after registering for an unlock-notify callback a
5664** database waits for the callback to be issued before taking any further
5665** action (a reasonable assumption), then using this API may cause the
5666** application to deadlock. For example, if connection X is waiting for
5667** connection Y's transaction to be concluded, and similarly connection
5668** Y is waiting on connection X's transaction, then neither connection
5669** will proceed and the system may remain deadlocked indefinitely.
5670**
5671** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock
5672** detection. If a given call to sqlite3_unlock_notify() would put the
5673** system in a deadlocked state, then SQLITE_LOCKED is returned and no
5674** unlock-notify callback is registered. The system is said to be in
5675** a deadlocked state if connection A has registered for an unlock-notify
5676** callback on the conclusion of connection B's transaction, and connection
5677** B has itself registered for an unlock-notify callback when connection
5678** A's transaction is concluded. Indirect deadlock is also detected, so
5679** the system is also considered to be deadlocked if connection B has
5680** registered for an unlock-notify callback on the conclusion of connection
5681** C's transaction, where connection C is waiting on connection A. Any
5682** number of levels of indirection are allowed.
5683**
5684** <b>The "DROP TABLE" Exception</b>
5685**
5686** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost
5687** always appropriate to call sqlite3_unlock_notify(). There is however,
5688** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement,
5689** SQLite checks if there are any currently executing SELECT statements
5690** that belong to the same connection. If there are, SQLITE_LOCKED is
5691** returned. In this case there is no "blocking connection", so invoking
5692** sqlite3_unlock_notify() results in the unlock-notify callback being
5693** invoked immediately. If the application then re-attempts the "DROP TABLE"
5694** or "DROP INDEX" query, an infinite loop might be the result.
5695**
5696** One way around this problem is to check the extended error code returned
5697** by an sqlite3_step() call. If there is a blocking connection, then the
5698** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in
5699** the special "DROP TABLE/INDEX" case, the extended error code is just
5700** SQLITE_LOCKED.
5701*/
5702int sqlite3_unlock_notify(
5703 sqlite3 *pBlocked, /* Waiting connection */
5704 void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */
5705 void *pNotifyArg /* Argument to pass to xNotify */
5706);
5707
danielk1977ee0484c2009-07-28 16:44:26 +00005708
5709/*
5710** CAPI3REF: String Comparison
5711** EXPERIMENTAL
5712**
5713** The [sqlite3_strnicmp()] API allows applications and extensions to
5714** compare the contents of two buffers containing UTF-8 strings in a
5715** case-indendent fashion, using the same definition of case independence
5716** that SQLite uses internally when comparing identifiers.
5717*/
5718int sqlite3_strnicmp(const char *, const char *, int);
5719
danielk1977404ca072009-03-16 13:19:36 +00005720/*
drhb37df7b2005-10-13 02:09:49 +00005721** Undo the hack that converts floating point types to integer for
5722** builds on processors without floating point support.
5723*/
5724#ifdef SQLITE_OMIT_FLOATING_POINT
5725# undef double
5726#endif
5727
drh382c0242001-10-06 16:33:02 +00005728#ifdef __cplusplus
5729} /* End of the 'extern "C"' block */
5730#endif
danielk19774adee202004-05-08 08:23:19 +00005731#endif