blob: ea46093eee746cbc3e9f720f15626b710b2d7e5c [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
20** features recently added to SQLite. We do not anticipate changes
21** to experimental interfaces but reserve to make minor changes if
22** experience from use "in the wild" suggest such changes are prudent.
23**
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.
32**
drhfec00ea2008-06-14 16:56:21 +000033** @(#) $Id: sqlite.h.in,v 1.327 2008/06/14 16:56:23 drh Exp $
drh75897232000-05-29 14:26:00 +000034*/
drh12057d52004-09-06 17:34:12 +000035#ifndef _SQLITE3_H_
36#define _SQLITE3_H_
drha18c5682000-10-08 22:20:57 +000037#include <stdarg.h> /* Needed for the definition of va_list */
drh75897232000-05-29 14:26:00 +000038
39/*
drh382c0242001-10-06 16:33:02 +000040** Make sure we can call this stuff from C++.
41*/
42#ifdef __cplusplus
43extern "C" {
44#endif
45
drh6d2069d2007-08-14 01:58:53 +000046
drh382c0242001-10-06 16:33:02 +000047/*
drh73be5012007-08-08 12:11:21 +000048** Add the ability to override 'extern'
49*/
50#ifndef SQLITE_EXTERN
51# define SQLITE_EXTERN extern
52#endif
53
54/*
drh6ed48bf2007-06-14 20:57:18 +000055** Make sure these symbols where not defined by some previous header
56** file.
drhb86ccfb2003-01-28 23:13:10 +000057*/
drh1e284f42004-10-06 15:52:01 +000058#ifdef SQLITE_VERSION
59# undef SQLITE_VERSION
drh1e284f42004-10-06 15:52:01 +000060#endif
drh6ed48bf2007-06-14 20:57:18 +000061#ifdef SQLITE_VERSION_NUMBER
62# undef SQLITE_VERSION_NUMBER
63#endif
danielk197799ba19e2005-02-05 07:33:34 +000064
65/*
drhfddfa2d2007-12-05 18:05:16 +000066** CAPI3REF: Compile-Time Library Version Numbers {F10010}
drh6ed48bf2007-06-14 20:57:18 +000067**
drh33c1be32008-01-30 16:16:14 +000068** The SQLITE_VERSION and SQLITE_VERSION_NUMBER #defines in
69** the sqlite3.h file specify the version of SQLite with which
70** that header file is associated.
danielk197799ba19e2005-02-05 07:33:34 +000071**
drh7663e362008-02-14 23:24:16 +000072** The "version" of SQLite is a string of the form "X.Y.Z".
drh33c1be32008-01-30 16:16:14 +000073** The phrase "alpha" or "beta" might be appended after the Z.
74** The X value is major version number always 3 in SQLite3.
75** The X value only changes when backwards compatibility is
76** broken and we intend to never break
77** backwards compatibility. The Y value is the minor version
78** number and only changes when
drh6ed48bf2007-06-14 20:57:18 +000079** there are major feature enhancements that are forwards compatible
drh33c1be32008-01-30 16:16:14 +000080** but not backwards compatible. The Z value is release number
81** and is incremented with
drh6ed48bf2007-06-14 20:57:18 +000082** each release but resets back to 0 when Y is incremented.
83**
drh6ed48bf2007-06-14 20:57:18 +000084** See also: [sqlite3_libversion()] and [sqlite3_libversion_number()].
drh33c1be32008-01-30 16:16:14 +000085**
86** INVARIANTS:
87**
88** {F10011} The SQLITE_VERSION #define in the sqlite3.h header file
89** evaluates to a string literal that is the SQLite version
90** with which the header file is associated.
91**
92** {F10014} The SQLITE_VERSION_NUMBER #define resolves to an integer
93** with the value (X*1000000 + Y*1000 + Z) where X, Y, and
94** Z are the major version, minor version, and release number.
danielk197799ba19e2005-02-05 07:33:34 +000095*/
drh6ed48bf2007-06-14 20:57:18 +000096#define SQLITE_VERSION "--VERS--"
drhb4d58ae2008-02-21 20:17:06 +000097#define SQLITE_VERSION_NUMBER --VERSION-NUMBER--
drhb86ccfb2003-01-28 23:13:10 +000098
99/*
drhfddfa2d2007-12-05 18:05:16 +0000100** CAPI3REF: Run-Time Library Version Numbers {F10020}
drh33c1be32008-01-30 16:16:14 +0000101** KEYWORDS: sqlite3_version
drh6ed48bf2007-06-14 20:57:18 +0000102**
drh33c1be32008-01-30 16:16:14 +0000103** These features provide the same information as the [SQLITE_VERSION]
104** and [SQLITE_VERSION_NUMBER] #defines in the header, but are associated
105** with the library instead of the header file. Cautious programmers might
drhfddfa2d2007-12-05 18:05:16 +0000106** include a check in their application to verify that
107** sqlite3_libversion_number() always returns the value
108** [SQLITE_VERSION_NUMBER].
drh6ed48bf2007-06-14 20:57:18 +0000109**
drh33c1be32008-01-30 16:16:14 +0000110** The sqlite3_libversion() function returns the same information as is
111** in the sqlite3_version[] string constant. The function is provided
112** for use in DLLs since DLL users usually do not have direct access to string
drhfddfa2d2007-12-05 18:05:16 +0000113** constants within the DLL.
drh33c1be32008-01-30 16:16:14 +0000114**
115** INVARIANTS:
116**
117** {F10021} The [sqlite3_libversion_number()] interface returns an integer
118** equal to [SQLITE_VERSION_NUMBER].
119**
120** {F10022} The [sqlite3_version] string constant contains the text of the
121** [SQLITE_VERSION] string.
122**
123** {F10023} The [sqlite3_libversion()] function returns
124** a pointer to the [sqlite3_version] string constant.
drhb217a572000-08-22 13:40:18 +0000125*/
drh73be5012007-08-08 12:11:21 +0000126SQLITE_EXTERN const char sqlite3_version[];
drha3f70cb2004-09-30 14:24:50 +0000127const char *sqlite3_libversion(void);
danielk197799ba19e2005-02-05 07:33:34 +0000128int sqlite3_libversion_number(void);
129
130/*
drhfddfa2d2007-12-05 18:05:16 +0000131** CAPI3REF: Test To See If The Library Is Threadsafe {F10100}
drhb67e8bf2007-08-30 20:09:48 +0000132**
drh33c1be32008-01-30 16:16:14 +0000133** SQLite can be compiled with or without mutexes. When
134** the SQLITE_THREADSAFE C preprocessor macro is true, mutexes
mlcreechb2799412008-03-07 03:20:31 +0000135** are enabled and SQLite is threadsafe. When that macro is false,
drh33c1be32008-01-30 16:16:14 +0000136** the mutexes are omitted. Without the mutexes, it is not safe
137** to use SQLite from more than one thread.
drhb67e8bf2007-08-30 20:09:48 +0000138**
drh33c1be32008-01-30 16:16:14 +0000139** There is a measurable performance penalty for enabling mutexes.
140** So if speed is of utmost importance, it makes sense to disable
141** the mutexes. But for maximum safety, mutexes should be enabled.
142** The default behavior is for mutexes to be enabled.
143**
144** This interface can be used by a program to make sure that the
145** version of SQLite that it is linking against was compiled with
146** the desired setting of the SQLITE_THREADSAFE macro.
147**
148** INVARIANTS:
149**
150** {F10101} The [sqlite3_threadsafe()] function returns nonzero if
151** SQLite was compiled with its mutexes enabled or zero
152** if SQLite was compiled with mutexes disabled.
drhb67e8bf2007-08-30 20:09:48 +0000153*/
154int sqlite3_threadsafe(void);
155
drh673299b2008-06-09 21:57:22 +0000156
drhb67e8bf2007-08-30 20:09:48 +0000157/*
drhfddfa2d2007-12-05 18:05:16 +0000158** CAPI3REF: Database Connection Handle {F12000}
drha06f17f2008-05-11 11:07:06 +0000159** KEYWORDS: {database connection} {database connections}
drh6ed48bf2007-06-14 20:57:18 +0000160**
161** Each open SQLite database is represented by pointer to an instance of the
162** opaque structure named "sqlite3". It is useful to think of an sqlite3
drh8bacf972007-08-25 16:21:29 +0000163** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and
164** [sqlite3_open_v2()] interfaces are its constructors
165** and [sqlite3_close()] is its destructor. There are many other interfaces
166** (such as [sqlite3_prepare_v2()], [sqlite3_create_function()], and
167** [sqlite3_busy_timeout()] to name but three) that are methods on this
drh6ed48bf2007-06-14 20:57:18 +0000168** object.
drh75897232000-05-29 14:26:00 +0000169*/
drh9bb575f2004-09-06 17:24:11 +0000170typedef struct sqlite3 sqlite3;
danielk197765904932004-05-26 06:18:37 +0000171
drh75897232000-05-29 14:26:00 +0000172
173/*
drhfddfa2d2007-12-05 18:05:16 +0000174** CAPI3REF: 64-Bit Integer Types {F10200}
drh33c1be32008-01-30 16:16:14 +0000175** KEYWORDS: sqlite_int64 sqlite_uint64
drh6ed48bf2007-06-14 20:57:18 +0000176**
drh33c1be32008-01-30 16:16:14 +0000177** Because there is no cross-platform way to specify 64-bit integer types
drhfddfa2d2007-12-05 18:05:16 +0000178** SQLite includes typedefs for 64-bit signed and unsigned integers.
drh6ed48bf2007-06-14 20:57:18 +0000179**
drhfddfa2d2007-12-05 18:05:16 +0000180** The sqlite3_int64 and sqlite3_uint64 are the preferred type
181** definitions. The sqlite_int64 and sqlite_uint64 types are
182** supported for backwards compatibility only.
drh33c1be32008-01-30 16:16:14 +0000183**
184** INVARIANTS:
185**
186** {F10201} The [sqlite_int64] and [sqlite3_int64] types specify a
187** 64-bit signed integer.
188**
189** {F10202} The [sqlite_uint64] and [sqlite3_uint64] types specify
190** a 64-bit unsigned integer.
drhefad9992004-06-22 12:13:55 +0000191*/
drh27436af2006-03-28 23:57:17 +0000192#ifdef SQLITE_INT64_TYPE
drh9b8f4472006-04-04 01:54:55 +0000193 typedef SQLITE_INT64_TYPE sqlite_int64;
drh27436af2006-03-28 23:57:17 +0000194 typedef unsigned SQLITE_INT64_TYPE sqlite_uint64;
195#elif defined(_MSC_VER) || defined(__BORLANDC__)
drhefad9992004-06-22 12:13:55 +0000196 typedef __int64 sqlite_int64;
drh1211de32004-07-26 12:24:22 +0000197 typedef unsigned __int64 sqlite_uint64;
drhefad9992004-06-22 12:13:55 +0000198#else
199 typedef long long int sqlite_int64;
drh1211de32004-07-26 12:24:22 +0000200 typedef unsigned long long int sqlite_uint64;
drhefad9992004-06-22 12:13:55 +0000201#endif
drh6d2069d2007-08-14 01:58:53 +0000202typedef sqlite_int64 sqlite3_int64;
203typedef sqlite_uint64 sqlite3_uint64;
drhefad9992004-06-22 12:13:55 +0000204
drhb37df7b2005-10-13 02:09:49 +0000205/*
206** If compiling for a processor that lacks floating point support,
207** substitute integer for floating-point
208*/
209#ifdef SQLITE_OMIT_FLOATING_POINT
drh6d2069d2007-08-14 01:58:53 +0000210# define double sqlite3_int64
drhb37df7b2005-10-13 02:09:49 +0000211#endif
drhefad9992004-06-22 12:13:55 +0000212
213/*
drhfddfa2d2007-12-05 18:05:16 +0000214** CAPI3REF: Closing A Database Connection {F12010}
drh75897232000-05-29 14:26:00 +0000215**
drh33c1be32008-01-30 16:16:14 +0000216** This routine is the destructor for the [sqlite3] object.
217**
218** Applications should [sqlite3_finalize | finalize] all
219** [prepared statements] and
220** [sqlite3_blob_close | close] all [sqlite3_blob | BLOBs]
221** associated with the [sqlite3] object prior
222** to attempting to close the [sqlite3] object.
223**
224** <todo>What happens to pending transactions? Are they
225** rolled back, or abandoned?</todo>
226**
227** INVARIANTS:
228**
229** {F12011} The [sqlite3_close()] interface destroys an [sqlite3] object
230** allocated by a prior call to [sqlite3_open()],
231** [sqlite3_open16()], or [sqlite3_open_v2()].
232**
233** {F12012} The [sqlite3_close()] function releases all memory used by the
234** connection and closes all open files.
danielk197796d81f92004-06-19 03:33:57 +0000235**
drhf5befa02007-12-06 02:42:07 +0000236** {F12013} If the database connection contains
drh33c1be32008-01-30 16:16:14 +0000237** [prepared statements] that have not been
238** finalized by [sqlite3_finalize()], then [sqlite3_close()]
239** returns [SQLITE_BUSY] and leaves the connection open.
drhe30f4422007-08-21 16:15:55 +0000240**
drh33c1be32008-01-30 16:16:14 +0000241** {F12014} Giving sqlite3_close() a NULL pointer is a harmless no-op.
242**
243** LIMITATIONS:
244**
245** {U12015} The parameter to [sqlite3_close()] must be an [sqlite3] object
246** pointer previously obtained from [sqlite3_open()] or the
247** equivalent, or NULL.
248**
249** {U12016} The parameter to [sqlite3_close()] must not have been previously
250** closed.
drh75897232000-05-29 14:26:00 +0000251*/
danielk1977f9d64d22004-06-19 08:18:07 +0000252int sqlite3_close(sqlite3 *);
drh75897232000-05-29 14:26:00 +0000253
254/*
255** The type for a callback function.
drh6ed48bf2007-06-14 20:57:18 +0000256** This is legacy and deprecated. It is included for historical
257** compatibility and is not documented.
drh75897232000-05-29 14:26:00 +0000258*/
drh12057d52004-09-06 17:34:12 +0000259typedef int (*sqlite3_callback)(void*,int,char**, char**);
drh75897232000-05-29 14:26:00 +0000260
261/*
drhfddfa2d2007-12-05 18:05:16 +0000262** CAPI3REF: One-Step Query Execution Interface {F12100}
drh6ed48bf2007-06-14 20:57:18 +0000263**
drh33c1be32008-01-30 16:16:14 +0000264** The sqlite3_exec() interface is a convenient way of running
265** one or more SQL statements without a lot of C code. The
266** SQL statements are passed in as the second parameter to
267** sqlite3_exec(). The statements are evaluated one by one
268** until either an error or an interrupt is encountered or
269** until they are all done. The 3rd parameter is an optional
270** callback that is invoked once for each row of any query results
271** produced by the SQL statements. The 5th parameter tells where
272** to write any error messages.
drh75897232000-05-29 14:26:00 +0000273**
drh35c61902008-05-20 15:44:30 +0000274** The error message passed back through the 5th parameter is held
275** in memory obtained from [sqlite3_malloc()]. To avoid a memory leak,
276** the calling application should call [sqlite3_free()] on any error
277** message returned through the 5th parameter when it has finished using
278** the error message.
279**
280** If the SQL statement in the 2nd parameter is NULL or an empty string
281** or a string containing only whitespace and comments, then SQL
282** statements are evaluated and the database is unchanged.
283**
drh33c1be32008-01-30 16:16:14 +0000284** The sqlite3_exec() interface is implemented in terms of
285** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()].
drh35c61902008-05-20 15:44:30 +0000286** The sqlite3_exec() routine does nothing to the database that cannot be done
drh33c1be32008-01-30 16:16:14 +0000287** by [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()].
drh75897232000-05-29 14:26:00 +0000288**
drh33c1be32008-01-30 16:16:14 +0000289** INVARIANTS:
290**
drhf50bebf2008-05-19 23:51:55 +0000291** {F12101} A successful invocation of [sqlite3_exec(D,S,C,A,E)]
292** shall evaluate all of the UTF-8 encoded, semicolon-separated,
293** SQL statements in the zero-terminated string S within the
294** context of the D [database connection].
drh75897232000-05-29 14:26:00 +0000295**
drh35c61902008-05-20 15:44:30 +0000296** {F12102} If the S parameter to [sqlite3_exec(D,S,C,A,E)] is NULL then
297** the actions of the interface shall be the same as if the
298** S parameter where an empty string.
drh75897232000-05-29 14:26:00 +0000299**
shane26b34032008-05-23 17:21:09 +0000300** {F12104} The return value of [sqlite3_exec()] shall be [SQLITE_OK] if all
drhf50bebf2008-05-19 23:51:55 +0000301** SQL statements run successfully and to completion.
302**
303** {F12105} The return value of [sqlite3_exec()] shall be an appropriate
drh35c61902008-05-20 15:44:30 +0000304** non-zero [error code] if any SQL statement fails.
drh4dd022a2007-12-01 19:23:19 +0000305**
drh33c1be32008-01-30 16:16:14 +0000306** {F12107} If one or more of the SQL statements handed to [sqlite3_exec()]
307** return results and the 3rd parameter is not NULL, then
drhf50bebf2008-05-19 23:51:55 +0000308** the callback function specified by the 3rd parameter shall be
drh33c1be32008-01-30 16:16:14 +0000309** invoked once for each row of result.
drhb19a2bc2001-09-16 00:13:26 +0000310**
drh33c1be32008-01-30 16:16:14 +0000311** {F12110} If the callback returns a non-zero value then [sqlite3_exec()]
shane0c6844e2008-05-21 15:01:21 +0000312** shall abort the SQL statement it is currently evaluating,
drh33c1be32008-01-30 16:16:14 +0000313** skip all subsequent SQL statements, and return [SQLITE_ABORT].
drhf50bebf2008-05-19 23:51:55 +0000314**
drh35c61902008-05-20 15:44:30 +0000315** {F12113} The [sqlite3_exec()] routine shall pass its 4th parameter through
drh33c1be32008-01-30 16:16:14 +0000316** as the 1st parameter of the callback.
317**
318** {F12116} The [sqlite3_exec()] routine sets the 2nd parameter of its
319** callback to be the number of columns in the current row of
320** result.
321**
322** {F12119} The [sqlite3_exec()] routine sets the 3rd parameter of its
323** callback to be an array of pointers to strings holding the
324** values for each column in the current result set row as
325** obtained from [sqlite3_column_text()].
326**
327** {F12122} The [sqlite3_exec()] routine sets the 4th parameter of its
328** callback to be an array of pointers to strings holding the
329** names of result columns as obtained from [sqlite3_column_name()].
330**
331** {F12125} If the 3rd parameter to [sqlite3_exec()] is NULL then
332** [sqlite3_exec()] never invokes a callback. All query
333** results are silently discarded.
334**
drh33c1be32008-01-30 16:16:14 +0000335** {F12131} If an error occurs while parsing or evaluating any of the SQL
drhf50bebf2008-05-19 23:51:55 +0000336** handed in the S parameter of [sqlite3_exec(D,S,C,A,E)] and if
drh35c61902008-05-20 15:44:30 +0000337** the E parameter is not NULL, then [sqlite3_exec()] shall store
338** in *E an appropriate error message written into memory obtained
drhf50bebf2008-05-19 23:51:55 +0000339** from [sqlite3_malloc()].
drh33c1be32008-01-30 16:16:14 +0000340**
drh35c61902008-05-20 15:44:30 +0000341** {F12134} The [sqlite3_exec(D,S,C,A,E)] routine shall set the value of
342** *E to NULL if E is not NULL and there are no errors.
drh33c1be32008-01-30 16:16:14 +0000343**
drh35c61902008-05-20 15:44:30 +0000344** {F12137} The [sqlite3_exec(D,S,C,A,E)] function shall set the error code
345** and message accessible via [sqlite3_errcode()],
346** [sqlite3_errmsg()], and [sqlite3_errmsg16()].
drh33c1be32008-01-30 16:16:14 +0000347**
drh35c61902008-05-20 15:44:30 +0000348** {F12138} If the S parameter to [sqlite3_exec(D,S,C,A,E)] is a null or empty
349** string or contains nothing other than whitespace, comments, and/or
drhf50bebf2008-05-19 23:51:55 +0000350** semicolons, then results of [sqlite3_errcode()],
351** [sqlite3_errmsg()], and [sqlite3_errmsg16()]
352** shall reset to indicate no errors.
353**
drh33c1be32008-01-30 16:16:14 +0000354** LIMITATIONS:
355**
356** {U12141} The first parameter to [sqlite3_exec()] must be an valid and open
357** [database connection].
358**
359** {U12142} The database connection must not be closed while
360** [sqlite3_exec()] is running.
361**
drh35c61902008-05-20 15:44:30 +0000362** {U12143} The calling function should use [sqlite3_free()] to free
drh33c1be32008-01-30 16:16:14 +0000363** the memory that *errmsg is left pointing at once the error
364** message is no longer needed.
365**
366** {U12145} The SQL statement text in the 2nd parameter to [sqlite3_exec()]
367** must remain unchanged while [sqlite3_exec()] is running.
drh75897232000-05-29 14:26:00 +0000368*/
danielk19776f8a5032004-05-10 10:34:51 +0000369int sqlite3_exec(
drh6ed48bf2007-06-14 20:57:18 +0000370 sqlite3*, /* An open database */
shane236ce972008-05-30 15:35:30 +0000371 const char *sql, /* SQL to be evaluated */
drh6ed48bf2007-06-14 20:57:18 +0000372 int (*callback)(void*,int,char**,char**), /* Callback function */
373 void *, /* 1st argument to callback */
374 char **errmsg /* Error msg written here */
drh75897232000-05-29 14:26:00 +0000375);
376
drh58b95762000-06-02 01:17:37 +0000377/*
drhfddfa2d2007-12-05 18:05:16 +0000378** CAPI3REF: Result Codes {F10210}
drh33c1be32008-01-30 16:16:14 +0000379** KEYWORDS: SQLITE_OK {error code} {error codes}
drh6ed48bf2007-06-14 20:57:18 +0000380**
381** Many SQLite functions return an integer result code from the set shown
drh33c1be32008-01-30 16:16:14 +0000382** here in order to indicates success or failure.
drh6ed48bf2007-06-14 20:57:18 +0000383**
384** See also: [SQLITE_IOERR_READ | extended result codes]
drh58b95762000-06-02 01:17:37 +0000385*/
drh717e6402001-09-27 03:22:32 +0000386#define SQLITE_OK 0 /* Successful result */
drh15b9a152006-01-31 20:49:13 +0000387/* beginning-of-error-codes */
drh717e6402001-09-27 03:22:32 +0000388#define SQLITE_ERROR 1 /* SQL error or missing database */
drh89e0dde2007-12-12 12:25:21 +0000389#define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */
drh717e6402001-09-27 03:22:32 +0000390#define SQLITE_PERM 3 /* Access permission denied */
391#define SQLITE_ABORT 4 /* Callback routine requested an abort */
392#define SQLITE_BUSY 5 /* The database file is locked */
393#define SQLITE_LOCKED 6 /* A table in the database is locked */
394#define SQLITE_NOMEM 7 /* A malloc() failed */
395#define SQLITE_READONLY 8 /* Attempt to write a readonly database */
drh24cd67e2004-05-10 16:18:47 +0000396#define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/
drh717e6402001-09-27 03:22:32 +0000397#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */
398#define SQLITE_CORRUPT 11 /* The database disk image is malformed */
drh2db0bbc2005-08-11 02:10:18 +0000399#define SQLITE_NOTFOUND 12 /* NOT USED. Table or record not found */
drh717e6402001-09-27 03:22:32 +0000400#define SQLITE_FULL 13 /* Insertion failed because database is full */
401#define SQLITE_CANTOPEN 14 /* Unable to open the database file */
drh4f0ee682007-03-30 20:43:40 +0000402#define SQLITE_PROTOCOL 15 /* NOT USED. Database lock protocol error */
drh24cd67e2004-05-10 16:18:47 +0000403#define SQLITE_EMPTY 16 /* Database is empty */
drh717e6402001-09-27 03:22:32 +0000404#define SQLITE_SCHEMA 17 /* The database schema changed */
drhc797d4d2007-05-08 01:08:49 +0000405#define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */
danielk19776eb91d22007-09-21 04:27:02 +0000406#define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */
drh8aff1012001-12-22 14:49:24 +0000407#define SQLITE_MISMATCH 20 /* Data type mismatch */
drh247be432002-05-10 05:44:55 +0000408#define SQLITE_MISUSE 21 /* Library used incorrectly */
drh8766c342002-11-09 00:33:15 +0000409#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */
drhed6c8672003-01-12 18:02:16 +0000410#define SQLITE_AUTH 23 /* Authorization denied */
drh1c2d8412003-03-31 00:30:47 +0000411#define SQLITE_FORMAT 24 /* Auxiliary database format error */
danielk19776f8a5032004-05-10 10:34:51 +0000412#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */
drhc602f9a2004-02-12 19:01:04 +0000413#define SQLITE_NOTADB 26 /* File opened that is not a database file */
danielk19776f8a5032004-05-10 10:34:51 +0000414#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */
415#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */
drh15b9a152006-01-31 20:49:13 +0000416/* end-of-error-codes */
drh717e6402001-09-27 03:22:32 +0000417
drhaf9ff332002-01-16 21:00:27 +0000418/*
drhfddfa2d2007-12-05 18:05:16 +0000419** CAPI3REF: Extended Result Codes {F10220}
drh33c1be32008-01-30 16:16:14 +0000420** KEYWORDS: {extended error code} {extended error codes}
421** KEYWORDS: {extended result codes}
drh4ac285a2006-09-15 07:28:50 +0000422**
drh6ed48bf2007-06-14 20:57:18 +0000423** In its default configuration, SQLite API routines return one of 26 integer
drhf5befa02007-12-06 02:42:07 +0000424** [SQLITE_OK | result codes]. However, experience has shown that
drh6ed48bf2007-06-14 20:57:18 +0000425** many of these result codes are too course-grained. They do not provide as
drhf5befa02007-12-06 02:42:07 +0000426** much information about problems as programmers might like. In an effort to
drh6ed48bf2007-06-14 20:57:18 +0000427** address this, newer versions of SQLite (version 3.3.8 and later) include
428** support for additional result codes that provide more detailed information
drh33c1be32008-01-30 16:16:14 +0000429** about errors. The extended result codes are enabled or disabled
drhfddfa2d2007-12-05 18:05:16 +0000430** for each database connection using the [sqlite3_extended_result_codes()]
drh33c1be32008-01-30 16:16:14 +0000431** API.
drh6ed48bf2007-06-14 20:57:18 +0000432**
drh33c1be32008-01-30 16:16:14 +0000433** Some of the available extended result codes are listed here.
434** One may expect the number of extended result codes will be expand
435** over time. Software that uses extended result codes should expect
436** to see new result codes in future releases of SQLite.
drh4ac285a2006-09-15 07:28:50 +0000437**
438** The SQLITE_OK result code will never be extended. It will always
439** be exactly zero.
drh33c1be32008-01-30 16:16:14 +0000440**
441** INVARIANTS:
442**
443** {F10223} The symbolic name for an extended result code always contains
444** a related primary result code as a prefix.
445**
446** {F10224} Primary result code names contain a single "_" character.
447**
448** {F10225} Extended result code names contain two or more "_" characters.
449**
450** {F10226} The numeric value of an extended result code contains the
mlcreechb2799412008-03-07 03:20:31 +0000451** numeric value of its corresponding primary result code in
drh33c1be32008-01-30 16:16:14 +0000452** its least significant 8 bits.
drh4ac285a2006-09-15 07:28:50 +0000453*/
danielk1977861f7452008-06-05 11:39:11 +0000454#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8))
455#define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8))
456#define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8))
457#define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8))
458#define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8))
459#define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8))
460#define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8))
461#define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8))
462#define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8))
463#define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8))
464#define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8))
465#define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8))
466#define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8))
467#define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8))
drh4ac285a2006-09-15 07:28:50 +0000468
469/*
drhfddfa2d2007-12-05 18:05:16 +0000470** CAPI3REF: Flags For File Open Operations {F10230}
drh6d2069d2007-08-14 01:58:53 +0000471**
mlcreechb2799412008-03-07 03:20:31 +0000472** These bit values are intended for use in the
drh33c1be32008-01-30 16:16:14 +0000473** 3rd parameter to the [sqlite3_open_v2()] interface and
474** in the 4th parameter to the xOpen method of the
drhd84f9462007-08-15 11:28:56 +0000475** [sqlite3_vfs] object.
drh6d2069d2007-08-14 01:58:53 +0000476*/
477#define SQLITE_OPEN_READONLY 0x00000001
478#define SQLITE_OPEN_READWRITE 0x00000002
479#define SQLITE_OPEN_CREATE 0x00000004
480#define SQLITE_OPEN_DELETEONCLOSE 0x00000008
481#define SQLITE_OPEN_EXCLUSIVE 0x00000010
482#define SQLITE_OPEN_MAIN_DB 0x00000100
483#define SQLITE_OPEN_TEMP_DB 0x00000200
drh33f4e022007-09-03 15:19:34 +0000484#define SQLITE_OPEN_TRANSIENT_DB 0x00000400
485#define SQLITE_OPEN_MAIN_JOURNAL 0x00000800
486#define SQLITE_OPEN_TEMP_JOURNAL 0x00001000
487#define SQLITE_OPEN_SUBJOURNAL 0x00002000
488#define SQLITE_OPEN_MASTER_JOURNAL 0x00004000
drh6d2069d2007-08-14 01:58:53 +0000489
490/*
drhfddfa2d2007-12-05 18:05:16 +0000491** CAPI3REF: Device Characteristics {F10240}
drh6d2069d2007-08-14 01:58:53 +0000492**
drh33c1be32008-01-30 16:16:14 +0000493** The xDeviceCapabilities method of the [sqlite3_io_methods]
drhfddfa2d2007-12-05 18:05:16 +0000494** object returns an integer which is a vector of the these
drh6d2069d2007-08-14 01:58:53 +0000495** bit values expressing I/O characteristics of the mass storage
496** device that holds the file that the [sqlite3_io_methods]
drh33c1be32008-01-30 16:16:14 +0000497** refers to.
drh6d2069d2007-08-14 01:58:53 +0000498**
drh33c1be32008-01-30 16:16:14 +0000499** The SQLITE_IOCAP_ATOMIC property means that all writes of
500** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
drh6d2069d2007-08-14 01:58:53 +0000501** mean that writes of blocks that are nnn bytes in size and
502** are aligned to an address which is an integer multiple of
drh33c1be32008-01-30 16:16:14 +0000503** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
drh6d2069d2007-08-14 01:58:53 +0000504** that when data is appended to a file, the data is appended
505** first then the size of the file is extended, never the other
drh33c1be32008-01-30 16:16:14 +0000506** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
drh6d2069d2007-08-14 01:58:53 +0000507** information is written to disk in the same order as calls
508** to xWrite().
509*/
510#define SQLITE_IOCAP_ATOMIC 0x00000001
511#define SQLITE_IOCAP_ATOMIC512 0x00000002
512#define SQLITE_IOCAP_ATOMIC1K 0x00000004
513#define SQLITE_IOCAP_ATOMIC2K 0x00000008
514#define SQLITE_IOCAP_ATOMIC4K 0x00000010
515#define SQLITE_IOCAP_ATOMIC8K 0x00000020
516#define SQLITE_IOCAP_ATOMIC16K 0x00000040
517#define SQLITE_IOCAP_ATOMIC32K 0x00000080
518#define SQLITE_IOCAP_ATOMIC64K 0x00000100
519#define SQLITE_IOCAP_SAFE_APPEND 0x00000200
520#define SQLITE_IOCAP_SEQUENTIAL 0x00000400
521
522/*
drhfddfa2d2007-12-05 18:05:16 +0000523** CAPI3REF: File Locking Levels {F10250}
drh6d2069d2007-08-14 01:58:53 +0000524**
drh33c1be32008-01-30 16:16:14 +0000525** SQLite uses one of these integer values as the second
drh6d2069d2007-08-14 01:58:53 +0000526** argument to calls it makes to the xLock() and xUnlock() methods
drh33c1be32008-01-30 16:16:14 +0000527** of an [sqlite3_io_methods] object.
drh6d2069d2007-08-14 01:58:53 +0000528*/
529#define SQLITE_LOCK_NONE 0
530#define SQLITE_LOCK_SHARED 1
531#define SQLITE_LOCK_RESERVED 2
532#define SQLITE_LOCK_PENDING 3
533#define SQLITE_LOCK_EXCLUSIVE 4
534
535/*
drhfddfa2d2007-12-05 18:05:16 +0000536** CAPI3REF: Synchronization Type Flags {F10260}
drh6d2069d2007-08-14 01:58:53 +0000537**
drh33c1be32008-01-30 16:16:14 +0000538** When SQLite invokes the xSync() method of an
mlcreechb2799412008-03-07 03:20:31 +0000539** [sqlite3_io_methods] object it uses a combination of
drhfddfa2d2007-12-05 18:05:16 +0000540** these integer values as the second argument.
drh6d2069d2007-08-14 01:58:53 +0000541**
drh33c1be32008-01-30 16:16:14 +0000542** When the SQLITE_SYNC_DATAONLY flag is used, it means that the
drh6d2069d2007-08-14 01:58:53 +0000543** sync operation only needs to flush data to mass storage. Inode
mlcreechb2799412008-03-07 03:20:31 +0000544** information need not be flushed. The SQLITE_SYNC_NORMAL flag means
drh33c1be32008-01-30 16:16:14 +0000545** to use normal fsync() semantics. The SQLITE_SYNC_FULL flag means
danielk1977c16d4632007-08-30 14:49:58 +0000546** to use Mac OS-X style fullsync instead of fsync().
drh6d2069d2007-08-14 01:58:53 +0000547*/
drh6d2069d2007-08-14 01:58:53 +0000548#define SQLITE_SYNC_NORMAL 0x00002
549#define SQLITE_SYNC_FULL 0x00003
550#define SQLITE_SYNC_DATAONLY 0x00010
551
552
553/*
drhfddfa2d2007-12-05 18:05:16 +0000554** CAPI3REF: OS Interface Open File Handle {F11110}
drh6d2069d2007-08-14 01:58:53 +0000555**
556** An [sqlite3_file] object represents an open file in the OS
557** interface layer. Individual OS interface implementations will
558** want to subclass this object by appending additional fields
drh4ff7fa02007-09-01 18:17:21 +0000559** for their own use. The pMethods entry is a pointer to an
drhd84f9462007-08-15 11:28:56 +0000560** [sqlite3_io_methods] object that defines methods for performing
561** I/O operations on the open file.
drh6d2069d2007-08-14 01:58:53 +0000562*/
563typedef struct sqlite3_file sqlite3_file;
564struct sqlite3_file {
drh153c62c2007-08-24 03:51:33 +0000565 const struct sqlite3_io_methods *pMethods; /* Methods for an open file */
drh6d2069d2007-08-14 01:58:53 +0000566};
567
568/*
drhfddfa2d2007-12-05 18:05:16 +0000569** CAPI3REF: OS Interface File Virtual Methods Object {F11120}
drh6d2069d2007-08-14 01:58:53 +0000570**
drhfddfa2d2007-12-05 18:05:16 +0000571** Every file opened by the [sqlite3_vfs] xOpen method contains a pointer to
mlcreechb2799412008-03-07 03:20:31 +0000572** an instance of this object. This object defines the
drh6d2069d2007-08-14 01:58:53 +0000573** methods used to perform various operations against the open file.
drhd84f9462007-08-15 11:28:56 +0000574**
drhfddfa2d2007-12-05 18:05:16 +0000575** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or
576** [SQLITE_SYNC_FULL]. The first choice is the normal fsync().
577* The second choice is an
578** OS-X style fullsync. The SQLITE_SYNC_DATA flag may be ORed in to
579** indicate that only the data of the file and not its inode needs to be
580** synced.
drhd84f9462007-08-15 11:28:56 +0000581**
582** The integer values to xLock() and xUnlock() are one of
drh4ff7fa02007-09-01 18:17:21 +0000583** <ul>
584** <li> [SQLITE_LOCK_NONE],
drh79491ab2007-09-04 12:00:00 +0000585** <li> [SQLITE_LOCK_SHARED],
drh4ff7fa02007-09-01 18:17:21 +0000586** <li> [SQLITE_LOCK_RESERVED],
587** <li> [SQLITE_LOCK_PENDING], or
588** <li> [SQLITE_LOCK_EXCLUSIVE].
589** </ul>
590** xLock() increases the lock. xUnlock() decreases the lock.
drhd84f9462007-08-15 11:28:56 +0000591** The xCheckReservedLock() method looks
592** to see if any database connection, either in this
593** process or in some other process, is holding an RESERVED,
594** PENDING, or EXCLUSIVE lock on the file. It returns true
595** if such a lock exists and false if not.
596**
drhcc6bb3e2007-08-31 16:11:35 +0000597** The xFileControl() method is a generic interface that allows custom
598** VFS implementations to directly control an open file using the
drh4ff7fa02007-09-01 18:17:21 +0000599** [sqlite3_file_control()] interface. The second "op" argument
600** is an integer opcode. The third
drhcc6bb3e2007-08-31 16:11:35 +0000601** argument is a generic pointer which is intended to be a pointer
602** to a structure that may contain arguments or space in which to
603** write return values. Potential uses for xFileControl() might be
604** functions to enable blocking locks with timeouts, to change the
605** locking strategy (for example to use dot-file locks), to inquire
drh9e33c2c2007-08-31 18:34:59 +0000606** about the status of a lock, or to break stale locks. The SQLite
drh4ff7fa02007-09-01 18:17:21 +0000607** core reserves opcodes less than 100 for its own use.
608** A [SQLITE_FCNTL_LOCKSTATE | list of opcodes] less than 100 is available.
609** Applications that define a custom xFileControl method should use opcodes
drh9e33c2c2007-08-31 18:34:59 +0000610** greater than 100 to avoid conflicts.
drhd84f9462007-08-15 11:28:56 +0000611**
612** The xSectorSize() method returns the sector size of the
613** device that underlies the file. The sector size is the
614** minimum write that can be performed without disturbing
615** other bytes in the file. The xDeviceCharacteristics()
616** method returns a bit vector describing behaviors of the
617** underlying device:
618**
619** <ul>
drh4ff7fa02007-09-01 18:17:21 +0000620** <li> [SQLITE_IOCAP_ATOMIC]
621** <li> [SQLITE_IOCAP_ATOMIC512]
622** <li> [SQLITE_IOCAP_ATOMIC1K]
623** <li> [SQLITE_IOCAP_ATOMIC2K]
624** <li> [SQLITE_IOCAP_ATOMIC4K]
625** <li> [SQLITE_IOCAP_ATOMIC8K]
626** <li> [SQLITE_IOCAP_ATOMIC16K]
627** <li> [SQLITE_IOCAP_ATOMIC32K]
628** <li> [SQLITE_IOCAP_ATOMIC64K]
629** <li> [SQLITE_IOCAP_SAFE_APPEND]
630** <li> [SQLITE_IOCAP_SEQUENTIAL]
drhd84f9462007-08-15 11:28:56 +0000631** </ul>
632**
633** The SQLITE_IOCAP_ATOMIC property means that all writes of
634** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
635** mean that writes of blocks that are nnn bytes in size and
636** are aligned to an address which is an integer multiple of
637** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
638** that when data is appended to a file, the data is appended
639** first then the size of the file is extended, never the other
640** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
641** information is written to disk in the same order as calls
642** to xWrite().
drh6d2069d2007-08-14 01:58:53 +0000643*/
644typedef struct sqlite3_io_methods sqlite3_io_methods;
645struct sqlite3_io_methods {
646 int iVersion;
647 int (*xClose)(sqlite3_file*);
drh79491ab2007-09-04 12:00:00 +0000648 int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst);
649 int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst);
650 int (*xTruncate)(sqlite3_file*, sqlite3_int64 size);
drh6d2069d2007-08-14 01:58:53 +0000651 int (*xSync)(sqlite3_file*, int flags);
drh79491ab2007-09-04 12:00:00 +0000652 int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize);
drh6d2069d2007-08-14 01:58:53 +0000653 int (*xLock)(sqlite3_file*, int);
654 int (*xUnlock)(sqlite3_file*, int);
danielk1977861f7452008-06-05 11:39:11 +0000655 int (*xCheckReservedLock)(sqlite3_file*, int *pResOut);
drhcc6bb3e2007-08-31 16:11:35 +0000656 int (*xFileControl)(sqlite3_file*, int op, void *pArg);
drh6d2069d2007-08-14 01:58:53 +0000657 int (*xSectorSize)(sqlite3_file*);
658 int (*xDeviceCharacteristics)(sqlite3_file*);
659 /* Additional methods may be added in future releases */
660};
661
662/*
drhfddfa2d2007-12-05 18:05:16 +0000663** CAPI3REF: Standard File Control Opcodes {F11310}
drh9e33c2c2007-08-31 18:34:59 +0000664**
665** These integer constants are opcodes for the xFileControl method
666** of the [sqlite3_io_methods] object and to the [sqlite3_file_control()]
667** interface.
668**
drh33c1be32008-01-30 16:16:14 +0000669** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This
mlcreechb2799412008-03-07 03:20:31 +0000670** opcode causes the xFileControl method to write the current state of
drh9e33c2c2007-08-31 18:34:59 +0000671** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED],
672** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE])
drh33c1be32008-01-30 16:16:14 +0000673** into an integer that the pArg argument points to. This capability
drh9e33c2c2007-08-31 18:34:59 +0000674** is used during testing and only needs to be supported when SQLITE_TEST
675** is defined.
676*/
677#define SQLITE_FCNTL_LOCKSTATE 1
678
679/*
drhfddfa2d2007-12-05 18:05:16 +0000680** CAPI3REF: Mutex Handle {F17110}
drh6d2069d2007-08-14 01:58:53 +0000681**
drhd84f9462007-08-15 11:28:56 +0000682** The mutex module within SQLite defines [sqlite3_mutex] to be an
drh33c1be32008-01-30 16:16:14 +0000683** abstract type for a mutex object. The SQLite core never looks
684** at the internal representation of an [sqlite3_mutex]. It only
drhd84f9462007-08-15 11:28:56 +0000685** deals with pointers to the [sqlite3_mutex] object.
drh6bdec4a2007-08-16 19:40:16 +0000686**
687** Mutexes are created using [sqlite3_mutex_alloc()].
drh6d2069d2007-08-14 01:58:53 +0000688*/
689typedef struct sqlite3_mutex sqlite3_mutex;
690
691/*
drhfddfa2d2007-12-05 18:05:16 +0000692** CAPI3REF: OS Interface Object {F11140}
drh6d2069d2007-08-14 01:58:53 +0000693**
drhd84f9462007-08-15 11:28:56 +0000694** An instance of this object defines the interface between the
695** SQLite core and the underlying operating system. The "vfs"
696** in the name of the object stands for "virtual file system".
drh6d2069d2007-08-14 01:58:53 +0000697**
698** The iVersion field is initially 1 but may be larger for future
drh6bdec4a2007-08-16 19:40:16 +0000699** versions of SQLite. Additional fields may be appended to this
700** object when the iVersion value is increased.
701**
drh4ff7fa02007-09-01 18:17:21 +0000702** The szOsFile field is the size of the subclassed [sqlite3_file]
drhd84f9462007-08-15 11:28:56 +0000703** structure used by this VFS. mxPathname is the maximum length of
704** a pathname in this VFS.
705**
drhb4d58ae2008-02-21 20:17:06 +0000706** Registered sqlite3_vfs objects are kept on a linked list formed by
drh79491ab2007-09-04 12:00:00 +0000707** the pNext pointer. The [sqlite3_vfs_register()]
708** and [sqlite3_vfs_unregister()] interfaces manage this list
709** in a thread-safe way. The [sqlite3_vfs_find()] interface
drh153c62c2007-08-24 03:51:33 +0000710** searches the list.
drhd84f9462007-08-15 11:28:56 +0000711**
mlcreechb2799412008-03-07 03:20:31 +0000712** The pNext field is the only field in the sqlite3_vfs
drh1cc8c442007-08-24 16:08:29 +0000713** structure that SQLite will ever modify. SQLite will only access
714** or modify this field while holding a particular static mutex.
715** The application should never modify anything within the sqlite3_vfs
716** object once the object has been registered.
717**
drhd84f9462007-08-15 11:28:56 +0000718** The zName field holds the name of the VFS module. The name must
719** be unique across all VFS modules.
720**
drhf5befa02007-12-06 02:42:07 +0000721** {F11141} SQLite will guarantee that the zFilename string passed to
drh6d2069d2007-08-14 01:58:53 +0000722** xOpen() is a full pathname as generated by xFullPathname() and
723** that the string will be valid and unchanged until xClose() is
drhf5befa02007-12-06 02:42:07 +0000724** called. {END} So the [sqlite3_file] can store a pointer to the
drh6d2069d2007-08-14 01:58:53 +0000725** filename if it needs to remember the filename for some reason.
drhd84f9462007-08-15 11:28:56 +0000726**
drhf5befa02007-12-06 02:42:07 +0000727** {F11142} The flags argument to xOpen() includes all bits set in
728** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()]
729** or [sqlite3_open16()] is used, then flags includes at least
730** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. {END}
drh6d2069d2007-08-14 01:58:53 +0000731** If xOpen() opens a file read-only then it sets *pOutFlags to
drh4ff7fa02007-09-01 18:17:21 +0000732** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be
drh6d2069d2007-08-14 01:58:53 +0000733** set.
734**
drhf5befa02007-12-06 02:42:07 +0000735** {F11143} SQLite will also add one of the following flags to the xOpen()
drh6d2069d2007-08-14 01:58:53 +0000736** call, depending on the object being opened:
737**
738** <ul>
739** <li> [SQLITE_OPEN_MAIN_DB]
740** <li> [SQLITE_OPEN_MAIN_JOURNAL]
741** <li> [SQLITE_OPEN_TEMP_DB]
742** <li> [SQLITE_OPEN_TEMP_JOURNAL]
drh33f4e022007-09-03 15:19:34 +0000743** <li> [SQLITE_OPEN_TRANSIENT_DB]
drh6d2069d2007-08-14 01:58:53 +0000744** <li> [SQLITE_OPEN_SUBJOURNAL]
745** <li> [SQLITE_OPEN_MASTER_JOURNAL]
drhf5befa02007-12-06 02:42:07 +0000746** </ul> {END}
drhd84f9462007-08-15 11:28:56 +0000747**
drh6d2069d2007-08-14 01:58:53 +0000748** The file I/O implementation can use the object type flags to
749** changes the way it deals with files. For example, an application
mlcreechb2799412008-03-07 03:20:31 +0000750** that does not care about crash recovery or rollback might make
751** the open of a journal file a no-op. Writes to this journal would
752** also be no-ops, and any attempt to read the journal would return
753** SQLITE_IOERR. Or the implementation might recognize that a database
754** file will be doing page-aligned sector reads and writes in a random
755** order and set up its I/O subsystem accordingly.
drh6d2069d2007-08-14 01:58:53 +0000756**
drh33c1be32008-01-30 16:16:14 +0000757** SQLite might also add one of the following flags to the xOpen
drh6d2069d2007-08-14 01:58:53 +0000758** method:
759**
760** <ul>
761** <li> [SQLITE_OPEN_DELETEONCLOSE]
762** <li> [SQLITE_OPEN_EXCLUSIVE]
763** </ul>
764**
drhf5befa02007-12-06 02:42:07 +0000765** {F11145} The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be
766** deleted when it is closed. {F11146} The [SQLITE_OPEN_DELETEONCLOSE]
767** will be set for TEMP databases, journals and for subjournals.
768** {F11147} The [SQLITE_OPEN_EXCLUSIVE] flag means the file should be opened
drh6d2069d2007-08-14 01:58:53 +0000769** for exclusive access. This flag is set for all files except
drhf5befa02007-12-06 02:42:07 +0000770** for the main database file. {END}
drh6d2069d2007-08-14 01:58:53 +0000771**
mlcreechb2799412008-03-07 03:20:31 +0000772** {F11148} At least szOsFile bytes of memory are allocated by SQLite
drhf5befa02007-12-06 02:42:07 +0000773** to hold the [sqlite3_file] structure passed as the third
774** argument to xOpen. {END} The xOpen method does not have to
775** allocate the structure; it should just fill it in.
drh6d2069d2007-08-14 01:58:53 +0000776**
drhf5befa02007-12-06 02:42:07 +0000777** {F11149} The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS]
shane26b34032008-05-23 17:21:09 +0000778** to test for the existence of a file,
drh4ff7fa02007-09-01 18:17:21 +0000779** or [SQLITE_ACCESS_READWRITE] to test to see
780** if a file is readable and writable, or [SQLITE_ACCESS_READ]
drhf5befa02007-12-06 02:42:07 +0000781** to test to see if a file is at least readable. {END} The file can be a
drh6d2069d2007-08-14 01:58:53 +0000782** directory.
783**
mlcreechb2799412008-03-07 03:20:31 +0000784** {F11150} SQLite will always allocate at least mxPathname+1 bytes for
danielk197717b90b52008-06-06 11:11:25 +0000785** the output buffer xFullPathname. {F11151} The exact
danielk1977adfb9b02007-09-17 07:02:56 +0000786** size of the output buffer is also passed as a parameter to both
shane26b34032008-05-23 17:21:09 +0000787** methods. {END} If the output buffer is not large enough, [SQLITE_CANTOPEN]
danielk1977adfb9b02007-09-17 07:02:56 +0000788** should be returned. As this is handled as a fatal error by SQLite,
drhf5befa02007-12-06 02:42:07 +0000789** vfs implementations should endeavor to prevent this by setting
danielk1977adfb9b02007-09-17 07:02:56 +0000790** mxPathname to a sufficiently large value.
drh6d2069d2007-08-14 01:58:53 +0000791**
drhd84f9462007-08-15 11:28:56 +0000792** The xRandomness(), xSleep(), and xCurrentTime() interfaces
793** are not strictly a part of the filesystem, but they are
794** included in the VFS structure for completeness.
drh6d2069d2007-08-14 01:58:53 +0000795** The xRandomness() function attempts to return nBytes bytes
796** of good-quality randomness into zOut. The return value is
drh4ff7fa02007-09-01 18:17:21 +0000797** the actual number of bytes of randomness obtained. The
mlcreechb2799412008-03-07 03:20:31 +0000798** xSleep() method causes the calling thread to sleep for at
drhd84f9462007-08-15 11:28:56 +0000799** least the number of microseconds given. The xCurrentTime()
800** method returns a Julian Day Number for the current date and
801** time.
drh6d2069d2007-08-14 01:58:53 +0000802*/
drhd84f9462007-08-15 11:28:56 +0000803typedef struct sqlite3_vfs sqlite3_vfs;
804struct sqlite3_vfs {
drh6d2069d2007-08-14 01:58:53 +0000805 int iVersion; /* Structure version number */
806 int szOsFile; /* Size of subclassed sqlite3_file */
drh6d2069d2007-08-14 01:58:53 +0000807 int mxPathname; /* Maximum file pathname length */
drhd84f9462007-08-15 11:28:56 +0000808 sqlite3_vfs *pNext; /* Next registered VFS */
drhd84f9462007-08-15 11:28:56 +0000809 const char *zName; /* Name of this virtual file system */
drh1cc8c442007-08-24 16:08:29 +0000810 void *pAppData; /* Pointer to application-specific data */
drh153c62c2007-08-24 03:51:33 +0000811 int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*,
drh6d2069d2007-08-14 01:58:53 +0000812 int flags, int *pOutFlags);
drh153c62c2007-08-24 03:51:33 +0000813 int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir);
danielk1977861f7452008-06-05 11:39:11 +0000814 int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut);
danielk1977adfb9b02007-09-17 07:02:56 +0000815 int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut);
drh153c62c2007-08-24 03:51:33 +0000816 void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename);
817 void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg);
818 void *(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol);
819 void (*xDlClose)(sqlite3_vfs*, void*);
820 int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut);
821 int (*xSleep)(sqlite3_vfs*, int microseconds);
822 int (*xCurrentTime)(sqlite3_vfs*, double*);
danielk1977bcb97fe2008-06-06 15:49:29 +0000823 int (*xGetLastError)(sqlite3_vfs*, int, char *);
drhd84f9462007-08-15 11:28:56 +0000824 /* New fields may be appended in figure versions. The iVersion
drh6d2069d2007-08-14 01:58:53 +0000825 ** value will increment whenever this happens. */
826};
827
drh50d3f902007-08-27 21:10:36 +0000828/*
drhf5befa02007-12-06 02:42:07 +0000829** CAPI3REF: Flags for the xAccess VFS method {F11190}
drh50d3f902007-08-27 21:10:36 +0000830**
drhf5befa02007-12-06 02:42:07 +0000831** {F11191} These integer constants can be used as the third parameter to
drhfddfa2d2007-12-05 18:05:16 +0000832** the xAccess method of an [sqlite3_vfs] object. {END} They determine
mlcreechb2799412008-03-07 03:20:31 +0000833** what kind of permissions the xAccess method is
shane26b34032008-05-23 17:21:09 +0000834** looking for. {F11192} With [SQLITE_ACCESS_EXISTS], the xAccess method
drhf5befa02007-12-06 02:42:07 +0000835** simply checks to see if the file exists. {F11193} With
drhfddfa2d2007-12-05 18:05:16 +0000836** SQLITE_ACCESS_READWRITE, the xAccess method checks to see
drhf5befa02007-12-06 02:42:07 +0000837** if the file is both readable and writable. {F11194} With
drhfddfa2d2007-12-05 18:05:16 +0000838** SQLITE_ACCESS_READ the xAccess method
drh50d3f902007-08-27 21:10:36 +0000839** checks to see if the file is readable.
840*/
danielk1977b4b47412007-08-17 15:53:36 +0000841#define SQLITE_ACCESS_EXISTS 0
842#define SQLITE_ACCESS_READWRITE 1
drh50d3f902007-08-27 21:10:36 +0000843#define SQLITE_ACCESS_READ 2
danielk1977b4b47412007-08-17 15:53:36 +0000844
drh6d2069d2007-08-14 01:58:53 +0000845/*
drhce5a5a02008-06-10 17:41:44 +0000846** CAPI3REF: Initialize The SQLite Library {F10130}
drh673299b2008-06-09 21:57:22 +0000847**
drhcb041342008-06-12 00:07:29 +0000848** The sqlite3_initialize() routine initializes the
849** SQLite library prior to use. The sqlite3_shutdown() routine
850** deallocates any resources that were allocated by sqlite3_initialize().
drh673299b2008-06-09 21:57:22 +0000851**
drhcb041342008-06-12 00:07:29 +0000852** A call to sqlite3_initialize() is an "effective" call if it is
853** the first time sqlite3_initialize() is invoked during the lifetime of
854** the process, or if it is the first time sqlite3_initialize() is invoked
855** following a call to sqlite3_shutdown(). Only an effective call
856** of sqlite3_initialize() does any initialization. All other calls
857** are harmless no-ops. In other words,
858** the sqlite3_initialize() routine may be called multiple times
drhce5a5a02008-06-10 17:41:44 +0000859** without consequence. Second and subsequent evaluations of
860** sqlite3_initialize() are no-ops. The sqlite3_initialize() routine
861** only works the first time it is called for a process, or the first
862** time it is called after sqlite3_shutdown(). In all other cases,
drhcb041342008-06-12 00:07:29 +0000863** sqlite3_initialize() returns SQLITE_OK without doing any real work.
864**
865** Among other things, sqlite3_initialize() shall invoke
866** [sqlite3_mutex_init()] and sqlite3_os_init(). Similarly, sqlite3_shutdown()
867** shall invoke [sqlite3_mutex_end()] and sqlite3_os_end().
drh673299b2008-06-09 21:57:22 +0000868**
869** The sqlite3_initialize() routine returns SQLITE_OK on success.
drhce5a5a02008-06-10 17:41:44 +0000870** If for some reason, sqlite3_initialize() is unable to initialize
871** the library (perhaps it is unable to allocate a needed resource such
872** as a mutex) it returns an [error code] other than SQLITE_OK.
drh673299b2008-06-09 21:57:22 +0000873**
drhce5a5a02008-06-10 17:41:44 +0000874** The sqlite3_initialize() routine is called internally by many other
drhcb041342008-06-12 00:07:29 +0000875** SQLite interfaces so that an application usually does not need to
drhce5a5a02008-06-10 17:41:44 +0000876** invoke sqlite3_initialize() directly. For example, [sqlite3_open()]
877** calls sqlite3_initialize() so the SQLite library will be automatically
878** initialized when [sqlite3_open()] is called if it has not be initialized
drhcb041342008-06-12 00:07:29 +0000879** already. However, if SQLite is compiled with the SQLITE_OMIT_AUTOINIT
880** compile-time option, then the automatic calls to sqlite3_initialize()
881** are omitted and the application must call sqlite3_initialize() directly
882** prior to using any other SQLite interface. For maximum portability,
883** it is recommended that applications always invoke sqlite3_initialize()
884** directly prior to using any other SQLite interface. Future releases
885** of SQLite may require this. In other words, the behavior exhibited
886** when SQLite is compiled with SQLITE_OMIT_AUTOINIT might become the
887** default behavior in some future release of SQLite.
drh673299b2008-06-09 21:57:22 +0000888**
drhcb041342008-06-12 00:07:29 +0000889** The sqlite3_os_init() routine does operating-system specific
890** initialization of the SQLite library. The sqlite3_os_end()
891** routine undoes the effect of sqlite3_os_init(). Typical tasks
892** performed by these routines include allocation or deallocation
893** of static resources, initialization of global variables,
894** setting up a default [sqlite3_vfs] module, or setting up
895** a default configuration using [sqlite3_config()].
drh673299b2008-06-09 21:57:22 +0000896**
drhcb041342008-06-12 00:07:29 +0000897** The application should never invoke either sqlite3_os_init()
898** or sqlite3_os_end() directly. The application should only invoke
899** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init()
900** interface is called automatically by sqlite3_initialize() and
901** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate
902** implementations for sqlite3_os_init() and sqlite3_os_end()
903** are built into SQLite when it is compiled for unix, windows, or os/2.
904** When built for other platforms (using the SQLITE_OS_OTHER=1 compile-time
905** option) the application must supply a suitable implementation for
906** sqlite3_os_init() and sqlite3_os_end(). An application-supplied
907** implementation of sqlite3_os_init() or sqlite3_os_end()
908** must return SQLITE_OK on success and some other [error code] upon
909** failure.
drh673299b2008-06-09 21:57:22 +0000910*/
drhce5a5a02008-06-10 17:41:44 +0000911int sqlite3_initialize(void);
drh673299b2008-06-09 21:57:22 +0000912int sqlite3_shutdown(void);
drhcb041342008-06-12 00:07:29 +0000913int sqlite3_os_init(void);
914int sqlite3_os_end(void);
drh673299b2008-06-09 21:57:22 +0000915
drhce5a5a02008-06-10 17:41:44 +0000916/*
917** CAPI3REF: Configuring The SQLite Library {F10145}
918**
919** The sqlite3_config() interface is used to make global configuration
920** changes to SQLite in order to tune SQLite to the specific needs of
921** the application. The default configuration is recommended for most
922** applications and so this routine is usually not necessary. It is
923** provided to support rare applications with unusual needs.
924**
925** The sqlite3_config() interface is not threadsafe. The application
926** must insure that no other SQLite interfaces are invoked by other
927** threads while sqlite3_config() is running. Furthermore, sqlite3_config()
928** may only be invoked prior to library initialization using
929** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()].
930** Note, however, that sqlite3_config() can be called as part of the
drh40257ff2008-06-13 18:24:27 +0000931** implementation of an application-defined [sqlite3_os_init()].
drhce5a5a02008-06-10 17:41:44 +0000932**
933** The first argument to sqlite3_config() is an integer
934** [SQLITE_CONFIG_SINGLETHREAD | configuration option] that determines
935** what property of SQLite is to be configured. Subsequent arguments
936** vary depending on the [SQLITE_CONFIG_SINGLETHREAD | configuration option]
937** in the first argument.
938**
939** When a configuration option is set, sqlite3_config() returns SQLITE_OK.
drh40257ff2008-06-13 18:24:27 +0000940** If the option is unknown or SQLite is unable to set the option
941** then this routine returns a non-zero [error code].
drhce5a5a02008-06-10 17:41:44 +0000942*/
943int sqlite3_config(int, ...);
944
945/*
drhfec00ea2008-06-14 16:56:21 +0000946** CAPI3REF: Memory Allocation Routines {F10155}
947**
948** An instance of this object defines the interface between SQLite
949** and low-level memory allocation routines.
950**
951** This object is used in only one place in the SQLite interface.
952** A pointer to an instance of this object is the argument to
953** [sqlite3_config] when the configuration option is
954** [SQLITE_CONFIG_MALLOC]. By creating an instance of this object
955** and passing it to [sqlite3_config] during configuration, an
956** application can specify an alternative memory allocation subsystem
957** for SQLite to use for all of its dynamic memory needs.
958**
959** Note that SQLite comes with a built-in memory allocator that is
960** perfectly adequate for the overwhelming majority of applications
961** and that this object is only useful to a tiny minority of applications
962** with specialized memory allocation requirements. This object is
963** also used during testing of SQLite in order to specify an alternative
964** memory allocator that simulates memory out-of-memory conditions in
965** order to verify that SQLite recovers gracefully from such
966** conditions.
967**
968** The xMalloc, xFree, and xRealloc methods should work like the
969** malloc(), free(), and realloc() functions from the standard library.
970**
971** xSize should return the allocated size of a memory allocation
972** previously obtained from xMalloc or xRealloc. The allocated size
973** is always at least as big as the requested size but may be larger.
974**
975** The xRoundup method returns what would be the allocated size of
976** a memory allocation given a particular requested size. Most memory
977** allocators round up memory allocations at least to the next multiple
978** of 8. Some round up to a larger multiple or to a power of 2.
979**
980** The xInit method initializes the memory allocator. (For example,
981** it might allocate any require mutexes or initialize internal data
982** structures. The xShutdown method is invoked (indirectly) by
983** [sqlite3_shutdown()] and should deallocate any resources acquired
984** by xInit. The pAppData pointer is used as the only parameter to
985** xInit and xShutdown.
986*/
987typedef struct sqlite3_mem_methods sqlite3_mem_methods;
988struct sqlite3_mem_methods {
989 void *(*xMalloc)(int); /* Memory allocation function */
990 void (*xFree)(void*); /* Free a prior allocation */
991 void *(*xRealloc)(void*,int); /* Resize an allocation */
992 int (*xSize)(void*); /* Return the size of an allocation */
993 int (*xRoundup)(int); /* Round up request size to allocation size */
994 int (*xInit)(void*); /* Initialize the memory allocator */
995 void (*xShutdown)(void*); /* Deinitialize the memory allocator */
996 void *pAppData; /* Argument to xInit() and xShutdown() */
997};
998
999/*
drhce5a5a02008-06-10 17:41:44 +00001000** CAPI3REF: Configuration Options {F10160}
1001**
1002** These constants are the available integer configuration options that
1003** can be passed as the first argument to the [sqlite3_config()] interface.
1004**
1005** <dl>
1006** <dt>SQLITE_CONFIG_SINGLETHREAD</dt>
1007** <dd>There are no arguments to this option. This option disables
1008** all mutexing and puts SQLite into a mode where it can only be used
1009** by a single thread.</dd>
1010**
1011** <dt>SQLITE_CONFIG_MULTITHREAD</dt>
1012** <dd>There are no arguments to this option. This option disables
1013** mutexing on [database connection] and [prepared statement] objects.
1014** The application is responsible for serializing access to
1015** [database connections] and [prepared statements]. But other mutexes
1016** are enabled so that SQLite will be safe to use in a multi-threaded
1017** environment.</dd>
1018**
1019** <dt>SQLITE_CONFIG_SERIALIZED</dt>
1020** <dd>There are no arguments to this option. This option enables
1021** all mutexes including the recursive
1022** mutexes on [database connection] and [prepared statement] objects.
1023** In this mode (which is the default when SQLite is compiled with
1024** SQLITE_THREADSAFE=1) the SQLite library will itself serialize access
1025** to [database connections] and [prepared statements] so that the
1026** application is free to use the same [database connection] or the
1027** same [prepared statement] in different threads at the same time.</dd>
1028**
1029** <dt>SQLITE_CONFIG_MALLOC</dt>
drhfec00ea2008-06-14 16:56:21 +00001030** <dd>This option takes a single argument which is a pointer to an
1031** instance of the [sqlite3_mem_methods] structure. The argument specifics
1032** alternative low-level memory allocation routines to be used in place
1033** the memory allocation routines built into SQLite.</dd>
drhce5a5a02008-06-10 17:41:44 +00001034**
drhfec00ea2008-06-14 16:56:21 +00001035** <dt>SQLITE_CONFIG_MEMSTATUS</dt>
drhce5a5a02008-06-10 17:41:44 +00001036** <dd>This option takes single boolean argument which enables or disables
1037** the collection of memory allocation statistics. When disabled, the
1038** following SQLite interfaces become non-operational:
1039** <ul>
1040** <li> [sqlite3_memory_used()]
1041** <li> [sqlite3_memory_highwater()]
1042** <li> [sqlite3_soft_heap_limit()]
drh40257ff2008-06-13 18:24:27 +00001043** <li> sqlite3_memory_status()
drhce5a5a02008-06-10 17:41:44 +00001044** </ul>
1045** </dd>
1046** </dl>
1047*/
drh40257ff2008-06-13 18:24:27 +00001048#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */
1049#define SQLITE_CONFIG_MULTITHREAD 2 /* nil */
1050#define SQLITE_CONFIG_SERIALIZED 3 /* nil */
drhfec00ea2008-06-14 16:56:21 +00001051#define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */
1052#define SQLITE_CONFIG_MEMSTATUS 5 /* boolean */
drhce5a5a02008-06-10 17:41:44 +00001053
1054/* These options are to be added later. Currently unused and undocumented. */
drh40257ff2008-06-13 18:24:27 +00001055#define SQLITE_CONFIG_HEAP 6 /* void*, int64, min, max, tmp */
drhce5a5a02008-06-10 17:41:44 +00001056
drh673299b2008-06-09 21:57:22 +00001057
1058/*
drhfddfa2d2007-12-05 18:05:16 +00001059** CAPI3REF: Enable Or Disable Extended Result Codes {F12200}
drh6ed48bf2007-06-14 20:57:18 +00001060**
drh33c1be32008-01-30 16:16:14 +00001061** The sqlite3_extended_result_codes() routine enables or disables the
1062** [SQLITE_IOERR_READ | extended result codes] feature of SQLite.
1063** The extended result codes are disabled by default for historical
1064** compatibility.
drh6ed48bf2007-06-14 20:57:18 +00001065**
drh33c1be32008-01-30 16:16:14 +00001066** INVARIANTS:
1067**
drh282c8e52008-05-20 18:43:38 +00001068** {F12201} Each new [database connection] shall have the
drh33c1be32008-01-30 16:16:14 +00001069** [extended result codes] feature
1070** disabled by default.
1071**
drh282c8e52008-05-20 18:43:38 +00001072** {F12202} The [sqlite3_extended_result_codes(D,F)] interface shall enable
drh33c1be32008-01-30 16:16:14 +00001073** [extended result codes] for the
1074** [database connection] D if the F parameter
1075** is true, or disable them if F is false.
drh4ac285a2006-09-15 07:28:50 +00001076*/
1077int sqlite3_extended_result_codes(sqlite3*, int onoff);
1078
1079/*
drhfddfa2d2007-12-05 18:05:16 +00001080** CAPI3REF: Last Insert Rowid {F12220}
drh6ed48bf2007-06-14 20:57:18 +00001081**
drh33c1be32008-01-30 16:16:14 +00001082** Each entry in an SQLite table has a unique 64-bit signed
1083** integer key called the "rowid". The rowid is always available
drhfddfa2d2007-12-05 18:05:16 +00001084** as an undeclared column named ROWID, OID, or _ROWID_ as long as those
drh33c1be32008-01-30 16:16:14 +00001085** names are not also used by explicitly declared columns. If
drhfddfa2d2007-12-05 18:05:16 +00001086** the table has a column of type INTEGER PRIMARY KEY then that column
mlcreechb2799412008-03-07 03:20:31 +00001087** is another alias for the rowid.
drh6ed48bf2007-06-14 20:57:18 +00001088**
drh33c1be32008-01-30 16:16:14 +00001089** This routine returns the rowid of the most recent
drhfddfa2d2007-12-05 18:05:16 +00001090** successful INSERT into the database from the database connection
drh33c1be32008-01-30 16:16:14 +00001091** shown in the first argument. If no successful inserts
drhfddfa2d2007-12-05 18:05:16 +00001092** have ever occurred on this database connection, zero is returned.
drh6ed48bf2007-06-14 20:57:18 +00001093**
drh33c1be32008-01-30 16:16:14 +00001094** If an INSERT occurs within a trigger, then the rowid of the
drh6ed48bf2007-06-14 20:57:18 +00001095** inserted row is returned by this routine as long as the trigger
drh33c1be32008-01-30 16:16:14 +00001096** is running. But once the trigger terminates, the value returned
drh6ed48bf2007-06-14 20:57:18 +00001097** by this routine reverts to the last value inserted before the
1098** trigger fired.
drhe30f4422007-08-21 16:15:55 +00001099**
drh33c1be32008-01-30 16:16:14 +00001100** An INSERT that fails due to a constraint violation is not a
drhdc1d9f12007-10-27 16:25:16 +00001101** successful insert and does not change the value returned by this
drh33c1be32008-01-30 16:16:14 +00001102** routine. Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK,
drhdc1d9f12007-10-27 16:25:16 +00001103** and INSERT OR ABORT make no changes to the return value of this
drh33c1be32008-01-30 16:16:14 +00001104** routine when their insertion fails. When INSERT OR REPLACE
drhdc1d9f12007-10-27 16:25:16 +00001105** encounters a constraint violation, it does not fail. The
1106** INSERT continues to completion after deleting rows that caused
1107** the constraint problem so INSERT OR REPLACE will always change
drhfddfa2d2007-12-05 18:05:16 +00001108** the return value of this interface.
drhdc1d9f12007-10-27 16:25:16 +00001109**
drh33c1be32008-01-30 16:16:14 +00001110** For the purposes of this routine, an insert is considered to
1111** be successful even if it is subsequently rolled back.
1112**
1113** INVARIANTS:
1114**
1115** {F12221} The [sqlite3_last_insert_rowid()] function returns the
1116** rowid of the most recent successful insert done
1117** on the same database connection and within the same
drh282c8e52008-05-20 18:43:38 +00001118** or higher level trigger context, or zero if there have
1119** been no qualifying inserts.
drh33c1be32008-01-30 16:16:14 +00001120**
1121** {F12223} The [sqlite3_last_insert_rowid()] function returns
1122** same value when called from the same trigger context
1123** immediately before and after a ROLLBACK.
1124**
1125** LIMITATIONS:
1126**
mlcreechb2799412008-03-07 03:20:31 +00001127** {U12232} If a separate thread does a new insert on the same
drh33c1be32008-01-30 16:16:14 +00001128** database connection while the [sqlite3_last_insert_rowid()]
1129** function is running and thus changes the last insert rowid,
1130** then the value returned by [sqlite3_last_insert_rowid()] is
1131** unpredictable and might not equal either the old or the new
1132** last insert rowid.
drhaf9ff332002-01-16 21:00:27 +00001133*/
drh6d2069d2007-08-14 01:58:53 +00001134sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*);
drhaf9ff332002-01-16 21:00:27 +00001135
drhc8d30ac2002-04-12 10:08:59 +00001136/*
drhfddfa2d2007-12-05 18:05:16 +00001137** CAPI3REF: Count The Number Of Rows Modified {F12240}
drh6ed48bf2007-06-14 20:57:18 +00001138**
drh33c1be32008-01-30 16:16:14 +00001139** This function returns the number of database rows that were changed
drhfddfa2d2007-12-05 18:05:16 +00001140** or inserted or deleted by the most recently completed SQL statement
drh33c1be32008-01-30 16:16:14 +00001141** on the connection specified by the first parameter. Only
drh930cc582007-03-28 13:07:40 +00001142** changes that are directly specified by the INSERT, UPDATE, or
1143** DELETE statement are counted. Auxiliary changes caused by
drh33c1be32008-01-30 16:16:14 +00001144** triggers are not counted. Use the [sqlite3_total_changes()] function
drh6ed48bf2007-06-14 20:57:18 +00001145** to find the total number of changes including changes caused by triggers.
1146**
mlcreechb2799412008-03-07 03:20:31 +00001147** A "row change" is a change to a single row of a single table
drh33c1be32008-01-30 16:16:14 +00001148** caused by an INSERT, DELETE, or UPDATE statement. Rows that
1149** are changed as side effects of REPLACE constraint resolution,
1150** rollback, ABORT processing, DROP TABLE, or by any other
1151** mechanisms do not count as direct row changes.
1152**
1153** A "trigger context" is a scope of execution that begins and
1154** ends with the script of a trigger. Most SQL statements are
1155** evaluated outside of any trigger. This is the "top level"
1156** trigger context. If a trigger fires from the top level, a
1157** new trigger context is entered for the duration of that one
1158** trigger. Subtriggers create subcontexts for their duration.
1159**
1160** Calling [sqlite3_exec()] or [sqlite3_step()] recursively does
1161** not create a new trigger context.
1162**
1163** This function returns the number of direct row changes in the
1164** most recent INSERT, UPDATE, or DELETE statement within the same
1165** trigger context.
1166**
1167** So when called from the top level, this function returns the
1168** number of changes in the most recent INSERT, UPDATE, or DELETE
1169** that also occurred at the top level.
1170** Within the body of a trigger, the sqlite3_changes() interface
drhf5befa02007-12-06 02:42:07 +00001171** can be called to find the number of
drh930cc582007-03-28 13:07:40 +00001172** changes in the most recently completed INSERT, UPDATE, or DELETE
drhf5befa02007-12-06 02:42:07 +00001173** statement within the body of the same trigger.
drh33c1be32008-01-30 16:16:14 +00001174** However, the number returned does not include in changes
1175** caused by subtriggers since they have their own context.
drhc8d30ac2002-04-12 10:08:59 +00001176**
drh33c1be32008-01-30 16:16:14 +00001177** SQLite implements the command "DELETE FROM table" without
drhfddfa2d2007-12-05 18:05:16 +00001178** a WHERE clause by dropping and recreating the table. (This is much
1179** faster than going through and deleting individual elements from the
drh33c1be32008-01-30 16:16:14 +00001180** table.) Because of this optimization, the deletions in
1181** "DELETE FROM table" are not row changes and will not be counted
1182** by the sqlite3_changes() or [sqlite3_total_changes()] functions.
1183** To get an accurate count of the number of rows deleted, use
drhc8d30ac2002-04-12 10:08:59 +00001184** "DELETE FROM table WHERE 1" instead.
drhe30f4422007-08-21 16:15:55 +00001185**
drh33c1be32008-01-30 16:16:14 +00001186** INVARIANTS:
1187**
drhe63b2c22008-05-21 13:44:13 +00001188** {F12241} The [sqlite3_changes()] function shall return the number of
drh33c1be32008-01-30 16:16:14 +00001189** row changes caused by the most recent INSERT, UPDATE,
1190** or DELETE statement on the same database connection and
drhe63b2c22008-05-21 13:44:13 +00001191** within the same or higher trigger context, or zero if there have
drh33c1be32008-01-30 16:16:14 +00001192** not been any qualifying row changes.
1193**
drhe63b2c22008-05-21 13:44:13 +00001194** {F12243} Statements of the form "DELETE FROM tablename" with no
1195** WHERE clause shall cause subsequent calls to
1196** [sqlite3_changes()] to return zero, regardless of the
1197** number of rows originally in the table.
1198**
drh33c1be32008-01-30 16:16:14 +00001199** LIMITATIONS:
1200**
1201** {U12252} If a separate thread makes changes on the same database connection
1202** while [sqlite3_changes()] is running then the value returned
shane26b34032008-05-23 17:21:09 +00001203** is unpredictable and not meaningful.
drhc8d30ac2002-04-12 10:08:59 +00001204*/
danielk1977f9d64d22004-06-19 08:18:07 +00001205int sqlite3_changes(sqlite3*);
drhc8d30ac2002-04-12 10:08:59 +00001206
rdcf146a772004-02-25 22:51:06 +00001207/*
drhfddfa2d2007-12-05 18:05:16 +00001208** CAPI3REF: Total Number Of Rows Modified {F12260}
drh6ed48bf2007-06-14 20:57:18 +00001209***
drh33c1be32008-01-30 16:16:14 +00001210** This function returns the number of row changes caused
1211** by INSERT, UPDATE or DELETE statements since the database handle
1212** was opened. The count includes all changes from all trigger
1213** contexts. But the count does not include changes used to
1214** implement REPLACE constraints, do rollbacks or ABORT processing,
1215** or DROP table processing.
1216** The changes
drhfddfa2d2007-12-05 18:05:16 +00001217** are counted as soon as the statement that makes them is completed
1218** (when the statement handle is passed to [sqlite3_reset()] or
drh33c1be32008-01-30 16:16:14 +00001219** [sqlite3_finalize()]).
drh6ed48bf2007-06-14 20:57:18 +00001220**
drh33c1be32008-01-30 16:16:14 +00001221** SQLite implements the command "DELETE FROM table" without
drhf5befa02007-12-06 02:42:07 +00001222** a WHERE clause by dropping and recreating the table. (This is much
1223** faster than going
mlcreechb2799412008-03-07 03:20:31 +00001224** through and deleting individual elements from the table.) Because of
rdcf146a772004-02-25 22:51:06 +00001225** this optimization, the change count for "DELETE FROM table" will be
1226** zero regardless of the number of elements that were originally in the
1227** table. To get an accurate count of the number of rows deleted, use
1228** "DELETE FROM table WHERE 1" instead.
drhe30f4422007-08-21 16:15:55 +00001229**
drh33c1be32008-01-30 16:16:14 +00001230** See also the [sqlite3_changes()] interface.
1231**
1232** INVARIANTS:
1233**
1234** {F12261} The [sqlite3_total_changes()] returns the total number
1235** of row changes caused by INSERT, UPDATE, and/or DELETE
1236** statements on the same [database connection], in any
1237** trigger context, since the database connection was
1238** created.
1239**
drhe63b2c22008-05-21 13:44:13 +00001240** {F12263} Statements of the form "DELETE FROM tablename" with no
1241** WHERE clause shall not change the value returned
1242** by [sqlite3_total_changes()]
1243**
drh33c1be32008-01-30 16:16:14 +00001244** LIMITATIONS:
1245**
1246** {U12264} If a separate thread makes changes on the same database connection
1247** while [sqlite3_total_changes()] is running then the value
shane26b34032008-05-23 17:21:09 +00001248** returned is unpredictable and not meaningful.
rdcf146a772004-02-25 22:51:06 +00001249*/
danielk1977b28af712004-06-21 06:50:26 +00001250int sqlite3_total_changes(sqlite3*);
1251
drh6ed48bf2007-06-14 20:57:18 +00001252/*
drhfddfa2d2007-12-05 18:05:16 +00001253** CAPI3REF: Interrupt A Long-Running Query {F12270}
drh6ed48bf2007-06-14 20:57:18 +00001254**
drh33c1be32008-01-30 16:16:14 +00001255** This function causes any pending database operation to abort and
1256** return at its earliest opportunity. This routine is typically
drh66b89c82000-11-28 20:47:17 +00001257** called in response to a user action such as pressing "Cancel"
drh4c504392000-10-16 22:06:40 +00001258** or Ctrl-C where the user wants a long query operation to halt
1259** immediately.
drh930cc582007-03-28 13:07:40 +00001260**
drh33c1be32008-01-30 16:16:14 +00001261** It is safe to call this routine from a thread different from the
1262** thread that is currently running the database operation. But it
drh871f6ca2007-08-14 18:03:14 +00001263** is not safe to call this routine with a database connection that
1264** is closed or might close before sqlite3_interrupt() returns.
drh6ed48bf2007-06-14 20:57:18 +00001265**
drhf5befa02007-12-06 02:42:07 +00001266** If an SQL is very nearly finished at the time when sqlite3_interrupt()
1267** is called, then it might not have an opportunity to be interrupted.
1268** It might continue to completion.
drh33c1be32008-01-30 16:16:14 +00001269** An SQL operation that is interrupted will return
1270** [SQLITE_INTERRUPT]. If the interrupted SQL operation is an
drhf5befa02007-12-06 02:42:07 +00001271** INSERT, UPDATE, or DELETE that is inside an explicit transaction,
1272** then the entire transaction will be rolled back automatically.
drh33c1be32008-01-30 16:16:14 +00001273** A call to sqlite3_interrupt() has no effect on SQL statements
drhf5befa02007-12-06 02:42:07 +00001274** that are started after sqlite3_interrupt() returns.
drh33c1be32008-01-30 16:16:14 +00001275**
1276** INVARIANTS:
1277**
1278** {F12271} The [sqlite3_interrupt()] interface will force all running
1279** SQL statements associated with the same database connection
1280** to halt after processing at most one additional row of
1281** data.
1282**
1283** {F12272} Any SQL statement that is interrupted by [sqlite3_interrupt()]
1284** will return [SQLITE_INTERRUPT].
1285**
1286** LIMITATIONS:
1287**
1288** {U12279} If the database connection closes while [sqlite3_interrupt()]
1289** is running then bad things will likely happen.
drh4c504392000-10-16 22:06:40 +00001290*/
danielk1977f9d64d22004-06-19 08:18:07 +00001291void sqlite3_interrupt(sqlite3*);
drh4c504392000-10-16 22:06:40 +00001292
drh6ed48bf2007-06-14 20:57:18 +00001293/*
drhfddfa2d2007-12-05 18:05:16 +00001294** CAPI3REF: Determine If An SQL Statement Is Complete {F10510}
drh75897232000-05-29 14:26:00 +00001295**
drh6ed48bf2007-06-14 20:57:18 +00001296** These routines are useful for command-line input to determine if the
drhf5befa02007-12-06 02:42:07 +00001297** currently entered text seems to form complete a SQL statement or
1298** if additional input is needed before sending the text into
drhfddfa2d2007-12-05 18:05:16 +00001299** SQLite for parsing. These routines return true if the input string
1300** appears to be a complete SQL statement. A statement is judged to be
drh33c1be32008-01-30 16:16:14 +00001301** complete if it ends with a semicolon token and is not a fragment of a
1302** CREATE TRIGGER statement. Semicolons that are embedded within
1303** string literals or quoted identifier names or comments are not
1304** independent tokens (they are part of the token in which they are
1305** embedded) and thus do not count as a statement terminator.
1306**
1307** These routines do not parse the SQL and
drhf5befa02007-12-06 02:42:07 +00001308** so will not detect syntactically incorrect SQL.
drhfddfa2d2007-12-05 18:05:16 +00001309**
drh33c1be32008-01-30 16:16:14 +00001310** INVARIANTS:
1311**
1312** {F10511} The sqlite3_complete() and sqlite3_complete16() functions
1313** return true (non-zero) if and only if the last
1314** non-whitespace token in their input is a semicolon that
1315** is not in between the BEGIN and END of a CREATE TRIGGER
1316** statement.
1317**
1318** LIMITATIONS:
1319**
1320** {U10512} The input to sqlite3_complete() must be a zero-terminated
1321** UTF-8 string.
1322**
1323** {U10513} The input to sqlite3_complete16() must be a zero-terminated
1324** UTF-16 string in native byte order.
drh75897232000-05-29 14:26:00 +00001325*/
danielk19776f8a5032004-05-10 10:34:51 +00001326int sqlite3_complete(const char *sql);
danielk197761de0d12004-05-27 23:56:16 +00001327int sqlite3_complete16(const void *sql);
drh75897232000-05-29 14:26:00 +00001328
drh2dfbbca2000-07-28 14:32:48 +00001329/*
drhfddfa2d2007-12-05 18:05:16 +00001330** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors {F12310}
drh6ed48bf2007-06-14 20:57:18 +00001331**
drh33c1be32008-01-30 16:16:14 +00001332** This routine identifies a callback function that might be
drhfddfa2d2007-12-05 18:05:16 +00001333** invoked whenever an attempt is made to open a database table
drh6ed48bf2007-06-14 20:57:18 +00001334** that another thread or process has locked.
drh33c1be32008-01-30 16:16:14 +00001335** If the busy callback is NULL, then [SQLITE_BUSY]
drhf5befa02007-12-06 02:42:07 +00001336** or [SQLITE_IOERR_BLOCKED]
drh6ed48bf2007-06-14 20:57:18 +00001337** is returned immediately upon encountering the lock.
drh33c1be32008-01-30 16:16:14 +00001338** If the busy callback is not NULL, then the
1339** callback will be invoked with two arguments. The
drh86939b52007-01-10 12:54:51 +00001340** first argument to the handler is a copy of the void* pointer which
drh33c1be32008-01-30 16:16:14 +00001341** is the third argument to this routine. The second argument to
drh86939b52007-01-10 12:54:51 +00001342** the handler is the number of times that the busy handler has
drh33c1be32008-01-30 16:16:14 +00001343** been invoked for this locking event. If the
drh6ed48bf2007-06-14 20:57:18 +00001344** busy callback returns 0, then no additional attempts are made to
1345** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned.
drh33c1be32008-01-30 16:16:14 +00001346** If the callback returns non-zero, then another attempt
drhfddfa2d2007-12-05 18:05:16 +00001347** is made to open the database for reading and the cycle repeats.
drh2dfbbca2000-07-28 14:32:48 +00001348**
drhf5befa02007-12-06 02:42:07 +00001349** The presence of a busy handler does not guarantee that
drh33c1be32008-01-30 16:16:14 +00001350** it will be invoked when there is lock contention.
drh86939b52007-01-10 12:54:51 +00001351** If SQLite determines that invoking the busy handler could result in
drhf5befa02007-12-06 02:42:07 +00001352** a deadlock, it will go ahead and return [SQLITE_BUSY] or
1353** [SQLITE_IOERR_BLOCKED] instead of invoking the
drh33c1be32008-01-30 16:16:14 +00001354** busy handler.
drh86939b52007-01-10 12:54:51 +00001355** Consider a scenario where one process is holding a read lock that
1356** it is trying to promote to a reserved lock and
1357** a second process is holding a reserved lock that it is trying
1358** to promote to an exclusive lock. The first process cannot proceed
1359** because it is blocked by the second and the second process cannot
1360** proceed because it is blocked by the first. If both processes
drhf5befa02007-12-06 02:42:07 +00001361** invoke the busy handlers, neither will make any progress. Therefore,
drh6ed48bf2007-06-14 20:57:18 +00001362** SQLite returns [SQLITE_BUSY] for the first process, hoping that this
drh86939b52007-01-10 12:54:51 +00001363** will induce the first process to release its read lock and allow
1364** the second process to proceed.
1365**
drh33c1be32008-01-30 16:16:14 +00001366** The default busy callback is NULL.
drh2dfbbca2000-07-28 14:32:48 +00001367**
drh33c1be32008-01-30 16:16:14 +00001368** The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED]
drhfddfa2d2007-12-05 18:05:16 +00001369** when SQLite is in the middle of a large transaction where all the
drh33c1be32008-01-30 16:16:14 +00001370** changes will not fit into the in-memory cache. SQLite will
drh6ed48bf2007-06-14 20:57:18 +00001371** already hold a RESERVED lock on the database file, but it needs
1372** to promote this lock to EXCLUSIVE so that it can spill cache
1373** pages into the database file without harm to concurrent
drh33c1be32008-01-30 16:16:14 +00001374** readers. If it is unable to promote the lock, then the in-memory
drh6ed48bf2007-06-14 20:57:18 +00001375** cache will be left in an inconsistent state and so the error
1376** code is promoted from the relatively benign [SQLITE_BUSY] to
drh33c1be32008-01-30 16:16:14 +00001377** the more severe [SQLITE_IOERR_BLOCKED]. This error code promotion
1378** forces an automatic rollback of the changes. See the
drh6ed48bf2007-06-14 20:57:18 +00001379** <a href="http://www.sqlite.org/cvstrac/wiki?p=CorruptionFollowingBusyError">
1380** CorruptionFollowingBusyError</a> wiki page for a discussion of why
1381** this is important.
1382**
drh33c1be32008-01-30 16:16:14 +00001383** There can only be a single busy handler defined for each database
drhfddfa2d2007-12-05 18:05:16 +00001384** connection. Setting a new busy handler clears any previous one.
drh33c1be32008-01-30 16:16:14 +00001385** Note that calling [sqlite3_busy_timeout()] will also set or clear
drh6ed48bf2007-06-14 20:57:18 +00001386** the busy handler.
drhd677b3d2007-08-20 22:48:41 +00001387**
drh33c1be32008-01-30 16:16:14 +00001388** INVARIANTS:
1389**
1390** {F12311} The [sqlite3_busy_handler()] function replaces the busy handler
1391** callback in the database connection identified by the 1st
1392** parameter with a new busy handler identified by the 2nd and 3rd
1393** parameters.
1394**
1395** {F12312} The default busy handler for new database connections is NULL.
1396**
shane26b34032008-05-23 17:21:09 +00001397** {F12314} When two or more database connection share a [sqlite3_enable_shared_cache | common cache],
drh33c1be32008-01-30 16:16:14 +00001398** the busy handler for the database connection currently using
1399** the cache is invoked when the cache encounters a lock.
1400**
1401** {F12316} If a busy handler callback returns zero, then the SQLite
1402** interface that provoked the locking event will return
1403** [SQLITE_BUSY].
1404**
shane26b34032008-05-23 17:21:09 +00001405** {F12318} SQLite will invokes the busy handler with two arguments which
drh33c1be32008-01-30 16:16:14 +00001406** are a copy of the pointer supplied by the 3rd parameter to
1407** [sqlite3_busy_handler()] and a count of the number of prior
1408** invocations of the busy handler for the same locking event.
1409**
1410** LIMITATIONS:
1411**
1412** {U12319} A busy handler should not call close the database connection
1413** or prepared statement that invoked the busy handler.
drh2dfbbca2000-07-28 14:32:48 +00001414*/
danielk1977f9d64d22004-06-19 08:18:07 +00001415int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*);
drh2dfbbca2000-07-28 14:32:48 +00001416
1417/*
drhfddfa2d2007-12-05 18:05:16 +00001418** CAPI3REF: Set A Busy Timeout {F12340}
drh6ed48bf2007-06-14 20:57:18 +00001419**
drh33c1be32008-01-30 16:16:14 +00001420** This routine sets a [sqlite3_busy_handler | busy handler]
drhf5befa02007-12-06 02:42:07 +00001421** that sleeps for a while when a
drh33c1be32008-01-30 16:16:14 +00001422** table is locked. The handler will sleep multiple times until
drhfddfa2d2007-12-05 18:05:16 +00001423** at least "ms" milliseconds of sleeping have been done. {F12343} After
drh6ed48bf2007-06-14 20:57:18 +00001424** "ms" milliseconds of sleeping, the handler returns 0 which
1425** causes [sqlite3_step()] to return [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED].
drh2dfbbca2000-07-28 14:32:48 +00001426**
drh33c1be32008-01-30 16:16:14 +00001427** Calling this routine with an argument less than or equal to zero
drh2dfbbca2000-07-28 14:32:48 +00001428** turns off all busy handlers.
drh6ed48bf2007-06-14 20:57:18 +00001429**
drh33c1be32008-01-30 16:16:14 +00001430** There can only be a single busy handler for a particular database
drh6ed48bf2007-06-14 20:57:18 +00001431** connection. If another busy handler was defined
1432** (using [sqlite3_busy_handler()]) prior to calling
1433** this routine, that other busy handler is cleared.
drh33c1be32008-01-30 16:16:14 +00001434**
1435** INVARIANTS:
1436**
1437** {F12341} The [sqlite3_busy_timeout()] function overrides any prior
1438** [sqlite3_busy_timeout()] or [sqlite3_busy_handler()] setting
1439** on the same database connection.
1440**
1441** {F12343} If the 2nd parameter to [sqlite3_busy_timeout()] is less than
1442** or equal to zero, then the busy handler is cleared so that
1443** all subsequent locking events immediately return [SQLITE_BUSY].
1444**
1445** {F12344} If the 2nd parameter to [sqlite3_busy_timeout()] is a positive
1446** number N, then a busy handler is set that repeatedly calls
1447** the xSleep() method in the VFS interface until either the
1448** lock clears or until the cumulative sleep time reported back
1449** by xSleep() exceeds N milliseconds.
drh2dfbbca2000-07-28 14:32:48 +00001450*/
danielk1977f9d64d22004-06-19 08:18:07 +00001451int sqlite3_busy_timeout(sqlite3*, int ms);
drh2dfbbca2000-07-28 14:32:48 +00001452
drhe3710332000-09-29 13:30:53 +00001453/*
drhfddfa2d2007-12-05 18:05:16 +00001454** CAPI3REF: Convenience Routines For Running Queries {F12370}
drh6ed48bf2007-06-14 20:57:18 +00001455**
drh33c1be32008-01-30 16:16:14 +00001456** Definition: A <b>result table</b> is memory data structure created by the
1457** [sqlite3_get_table()] interface. A result table records the
1458** complete query results from one or more queries.
drha18c5682000-10-08 22:20:57 +00001459**
drh33c1be32008-01-30 16:16:14 +00001460** The table conceptually has a number of rows and columns. But
1461** these numbers are not part of the result table itself. These
1462** numbers are obtained separately. Let N be the number of rows
1463** and M be the number of columns.
1464**
1465** A result table is an array of pointers to zero-terminated
1466** UTF-8 strings. There are (N+1)*M elements in the array.
1467** The first M pointers point to zero-terminated strings that
1468** contain the names of the columns.
1469** The remaining entries all point to query results. NULL
1470** values are give a NULL pointer. All other values are in
1471** their UTF-8 zero-terminated string representation as returned by
1472** [sqlite3_column_text()].
1473**
1474** A result table might consists of one or more memory allocations.
1475** It is not safe to pass a result table directly to [sqlite3_free()].
1476** A result table should be deallocated using [sqlite3_free_table()].
1477**
1478** As an example of the result table format, suppose a query result
1479** is as follows:
drha18c5682000-10-08 22:20:57 +00001480**
drh8bacf972007-08-25 16:21:29 +00001481** <blockquote><pre>
drha18c5682000-10-08 22:20:57 +00001482** Name | Age
1483** -----------------------
1484** Alice | 43
1485** Bob | 28
1486** Cindy | 21
drh8bacf972007-08-25 16:21:29 +00001487** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001488**
drh33c1be32008-01-30 16:16:14 +00001489** There are two column (M==2) and three rows (N==3). Thus the
1490** result table has 8 entries. Suppose the result table is stored
1491** in an array names azResult. Then azResult holds this content:
drha18c5682000-10-08 22:20:57 +00001492**
drh8bacf972007-08-25 16:21:29 +00001493** <blockquote><pre>
1494** azResult&#91;0] = "Name";
1495** azResult&#91;1] = "Age";
1496** azResult&#91;2] = "Alice";
1497** azResult&#91;3] = "43";
1498** azResult&#91;4] = "Bob";
1499** azResult&#91;5] = "28";
1500** azResult&#91;6] = "Cindy";
1501** azResult&#91;7] = "21";
1502** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001503**
drh33c1be32008-01-30 16:16:14 +00001504** The sqlite3_get_table() function evaluates one or more
1505** semicolon-separated SQL statements in the zero-terminated UTF-8
1506** string of its 2nd parameter. It returns a result table to the
1507** pointer given in its 3rd parameter.
drha18c5682000-10-08 22:20:57 +00001508**
drh33c1be32008-01-30 16:16:14 +00001509** After the calling function has finished using the result, it should
1510** pass the pointer to the result table to sqlite3_free_table() in order to
shane26b34032008-05-23 17:21:09 +00001511** release the memory that was malloced. Because of the way the
drh33c1be32008-01-30 16:16:14 +00001512** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling
1513** function must not try to call [sqlite3_free()] directly. Only
1514** [sqlite3_free_table()] is able to release the memory properly and safely.
drhe3710332000-09-29 13:30:53 +00001515**
drh33c1be32008-01-30 16:16:14 +00001516** The sqlite3_get_table() interface is implemented as a wrapper around
1517** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access
1518** to any internal data structures of SQLite. It uses only the public
1519** interface defined here. As a consequence, errors that occur in the
1520** wrapper layer outside of the internal [sqlite3_exec()] call are not
1521** reflected in subsequent calls to [sqlite3_errcode()] or
1522** [sqlite3_errmsg()].
1523**
1524** INVARIANTS:
1525**
1526** {F12371} If a [sqlite3_get_table()] fails a memory allocation, then
1527** it frees the result table under construction, aborts the
1528** query in process, skips any subsequent queries, sets the
1529** *resultp output pointer to NULL and returns [SQLITE_NOMEM].
1530**
1531** {F12373} If the ncolumn parameter to [sqlite3_get_table()] is not NULL
1532** then [sqlite3_get_table()] write the number of columns in the
1533** result set of the query into *ncolumn if the query is
1534** successful (if the function returns SQLITE_OK).
1535**
1536** {F12374} If the nrow parameter to [sqlite3_get_table()] is not NULL
1537** then [sqlite3_get_table()] write the number of rows in the
1538** result set of the query into *nrow if the query is
1539** successful (if the function returns SQLITE_OK).
1540**
drh21ac7f92008-01-31 12:26:49 +00001541** {F12376} The [sqlite3_get_table()] function sets its *ncolumn value
drh33c1be32008-01-30 16:16:14 +00001542** to the number of columns in the result set of the query in the
1543** sql parameter, or to zero if the query in sql has an empty
1544** result set.
drhe3710332000-09-29 13:30:53 +00001545*/
danielk19776f8a5032004-05-10 10:34:51 +00001546int sqlite3_get_table(
drh33c1be32008-01-30 16:16:14 +00001547 sqlite3*, /* An open database */
1548 const char *sql, /* SQL to be evaluated */
1549 char ***pResult, /* Results of the query */
1550 int *nrow, /* Number of result rows written here */
1551 int *ncolumn, /* Number of result columns written here */
1552 char **errmsg /* Error msg written here */
drhe3710332000-09-29 13:30:53 +00001553);
danielk19776f8a5032004-05-10 10:34:51 +00001554void sqlite3_free_table(char **result);
drhe3710332000-09-29 13:30:53 +00001555
drha18c5682000-10-08 22:20:57 +00001556/*
drhfddfa2d2007-12-05 18:05:16 +00001557** CAPI3REF: Formatted String Printing Functions {F17400}
drh6ed48bf2007-06-14 20:57:18 +00001558**
1559** These routines are workalikes of the "printf()" family of functions
1560** from the standard C library.
1561**
drh33c1be32008-01-30 16:16:14 +00001562** The sqlite3_mprintf() and sqlite3_vmprintf() routines write their
drh6d2069d2007-08-14 01:58:53 +00001563** results into memory obtained from [sqlite3_malloc()].
drh33c1be32008-01-30 16:16:14 +00001564** The strings returned by these two routines should be
1565** released by [sqlite3_free()]. Both routines return a
drh6ed48bf2007-06-14 20:57:18 +00001566** NULL pointer if [sqlite3_malloc()] is unable to allocate enough
1567** memory to hold the resulting string.
1568**
drh33c1be32008-01-30 16:16:14 +00001569** In sqlite3_snprintf() routine is similar to "snprintf()" from
drh6ed48bf2007-06-14 20:57:18 +00001570** the standard C library. The result is written into the
1571** buffer supplied as the second parameter whose size is given by
drh33c1be32008-01-30 16:16:14 +00001572** the first parameter. Note that the order of the
drh6ed48bf2007-06-14 20:57:18 +00001573** first two parameters is reversed from snprintf(). This is an
1574** historical accident that cannot be fixed without breaking
drh33c1be32008-01-30 16:16:14 +00001575** backwards compatibility. Note also that sqlite3_snprintf()
drh6ed48bf2007-06-14 20:57:18 +00001576** returns a pointer to its buffer instead of the number of
drh33c1be32008-01-30 16:16:14 +00001577** characters actually written into the buffer. We admit that
drh6ed48bf2007-06-14 20:57:18 +00001578** the number of characters written would be a more useful return
1579** value but we cannot change the implementation of sqlite3_snprintf()
1580** now without breaking compatibility.
1581**
drh33c1be32008-01-30 16:16:14 +00001582** As long as the buffer size is greater than zero, sqlite3_snprintf()
1583** guarantees that the buffer is always zero-terminated. The first
drh6ed48bf2007-06-14 20:57:18 +00001584** parameter "n" is the total size of the buffer, including space for
drh33c1be32008-01-30 16:16:14 +00001585** the zero terminator. So the longest string that can be completely
drh6ed48bf2007-06-14 20:57:18 +00001586** written will be n-1 characters.
1587**
1588** These routines all implement some additional formatting
drh4f26d6c2004-05-26 23:25:30 +00001589** options that are useful for constructing SQL statements.
shane26b34032008-05-23 17:21:09 +00001590** All of the usual printf() formatting options apply. In addition, there
drh153c62c2007-08-24 03:51:33 +00001591** is are "%q", "%Q", and "%z" options.
drh6ed48bf2007-06-14 20:57:18 +00001592**
drh33c1be32008-01-30 16:16:14 +00001593** The %q option works like %s in that it substitutes a null-terminated
drh66b89c82000-11-28 20:47:17 +00001594** string from the argument list. But %q also doubles every '\'' character.
drh33c1be32008-01-30 16:16:14 +00001595** %q is designed for use inside a string literal. By doubling each '\''
drh66b89c82000-11-28 20:47:17 +00001596** character it escapes that character and allows it to be inserted into
drha18c5682000-10-08 22:20:57 +00001597** the string.
1598**
1599** For example, so some string variable contains text as follows:
1600**
drh6ed48bf2007-06-14 20:57:18 +00001601** <blockquote><pre>
1602** char *zText = "It's a happy day!";
1603** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001604**
drh6ed48bf2007-06-14 20:57:18 +00001605** One can use this text in an SQL statement as follows:
drha18c5682000-10-08 22:20:57 +00001606**
drh6ed48bf2007-06-14 20:57:18 +00001607** <blockquote><pre>
1608** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText);
1609** sqlite3_exec(db, zSQL, 0, 0, 0);
1610** sqlite3_free(zSQL);
1611** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001612**
1613** Because the %q format string is used, the '\'' character in zText
1614** is escaped and the SQL generated is as follows:
1615**
drh6ed48bf2007-06-14 20:57:18 +00001616** <blockquote><pre>
1617** INSERT INTO table1 VALUES('It''s a happy day!')
1618** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001619**
1620** This is correct. Had we used %s instead of %q, the generated SQL
1621** would have looked like this:
1622**
drh6ed48bf2007-06-14 20:57:18 +00001623** <blockquote><pre>
1624** INSERT INTO table1 VALUES('It's a happy day!');
1625** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001626**
1627** This second example is an SQL syntax error. As a general rule you
1628** should always use %q instead of %s when inserting text into a string
1629** literal.
drh6ed48bf2007-06-14 20:57:18 +00001630**
drh33c1be32008-01-30 16:16:14 +00001631** The %Q option works like %q except it also adds single quotes around
drh6ed48bf2007-06-14 20:57:18 +00001632** the outside of the total string. Or if the parameter in the argument
1633** list is a NULL pointer, %Q substitutes the text "NULL" (without single
drhfddfa2d2007-12-05 18:05:16 +00001634** quotes) in place of the %Q option. {END} So, for example, one could say:
drh6ed48bf2007-06-14 20:57:18 +00001635**
1636** <blockquote><pre>
1637** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText);
1638** sqlite3_exec(db, zSQL, 0, 0, 0);
1639** sqlite3_free(zSQL);
1640** </pre></blockquote>
1641**
1642** The code above will render a correct SQL statement in the zSQL
1643** variable even if the zText variable is a NULL pointer.
drh153c62c2007-08-24 03:51:33 +00001644**
drh33c1be32008-01-30 16:16:14 +00001645** The "%z" formatting option works exactly like "%s" with the
drh153c62c2007-08-24 03:51:33 +00001646** addition that after the string has been read and copied into
drhfddfa2d2007-12-05 18:05:16 +00001647** the result, [sqlite3_free()] is called on the input string. {END}
drh33c1be32008-01-30 16:16:14 +00001648**
1649** INVARIANTS:
1650**
1651** {F17403} The [sqlite3_mprintf()] and [sqlite3_vmprintf()] interfaces
1652** return either pointers to zero-terminated UTF-8 strings held in
1653** memory obtained from [sqlite3_malloc()] or NULL pointers if
1654** a call to [sqlite3_malloc()] fails.
1655**
1656** {F17406} The [sqlite3_snprintf()] interface writes a zero-terminated
1657** UTF-8 string into the buffer pointed to by the second parameter
1658** provided that the first parameter is greater than zero.
1659**
1660** {F17407} The [sqlite3_snprintf()] interface does not writes slots of
1661** its output buffer (the second parameter) outside the range
1662** of 0 through N-1 (where N is the first parameter)
1663** regardless of the length of the string
1664** requested by the format specification.
1665**
drha18c5682000-10-08 22:20:57 +00001666*/
danielk19776f8a5032004-05-10 10:34:51 +00001667char *sqlite3_mprintf(const char*,...);
1668char *sqlite3_vmprintf(const char*, va_list);
drhfeac5f82004-08-01 00:10:45 +00001669char *sqlite3_snprintf(int,char*,const char*, ...);
drh5191b7e2002-03-08 02:12:00 +00001670
drh28dd4792006-06-26 21:35:44 +00001671/*
drhfddfa2d2007-12-05 18:05:16 +00001672** CAPI3REF: Memory Allocation Subsystem {F17300}
drhd84f9462007-08-15 11:28:56 +00001673**
drh33c1be32008-01-30 16:16:14 +00001674** The SQLite core uses these three routines for all of its own
1675** internal memory allocation needs. "Core" in the previous sentence
drhf5befa02007-12-06 02:42:07 +00001676** does not include operating-system specific VFS implementation. The
shane26b34032008-05-23 17:21:09 +00001677** Windows VFS uses native malloc() and free() for some operations.
drhd64621d2007-11-05 17:54:17 +00001678**
drh33c1be32008-01-30 16:16:14 +00001679** The sqlite3_malloc() routine returns a pointer to a block
drhfddfa2d2007-12-05 18:05:16 +00001680** of memory at least N bytes in length, where N is the parameter.
drh33c1be32008-01-30 16:16:14 +00001681** If sqlite3_malloc() is unable to obtain sufficient free
1682** memory, it returns a NULL pointer. If the parameter N to
drhfddfa2d2007-12-05 18:05:16 +00001683** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns
1684** a NULL pointer.
1685**
drh33c1be32008-01-30 16:16:14 +00001686** Calling sqlite3_free() with a pointer previously returned
drhfddfa2d2007-12-05 18:05:16 +00001687** by sqlite3_malloc() or sqlite3_realloc() releases that memory so
drh33c1be32008-01-30 16:16:14 +00001688** that it might be reused. The sqlite3_free() routine is
drhfddfa2d2007-12-05 18:05:16 +00001689** a no-op if is called with a NULL pointer. Passing a NULL pointer
drh33c1be32008-01-30 16:16:14 +00001690** to sqlite3_free() is harmless. After being freed, memory
drhfddfa2d2007-12-05 18:05:16 +00001691** should neither be read nor written. Even reading previously freed
1692** memory might result in a segmentation fault or other severe error.
drh33c1be32008-01-30 16:16:14 +00001693** Memory corruption, a segmentation fault, or other severe error
drhfddfa2d2007-12-05 18:05:16 +00001694** might result if sqlite3_free() is called with a non-NULL pointer that
1695** was not obtained from sqlite3_malloc() or sqlite3_free().
1696**
drh33c1be32008-01-30 16:16:14 +00001697** The sqlite3_realloc() interface attempts to resize a
drhfddfa2d2007-12-05 18:05:16 +00001698** prior memory allocation to be at least N bytes, where N is the
1699** second parameter. The memory allocation to be resized is the first
drh33c1be32008-01-30 16:16:14 +00001700** parameter. If the first parameter to sqlite3_realloc()
drhfddfa2d2007-12-05 18:05:16 +00001701** is a NULL pointer then its behavior is identical to calling
1702** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc().
drh33c1be32008-01-30 16:16:14 +00001703** If the second parameter to sqlite3_realloc() is zero or
drhfddfa2d2007-12-05 18:05:16 +00001704** negative then the behavior is exactly the same as calling
1705** sqlite3_free(P) where P is the first parameter to sqlite3_realloc().
drh33c1be32008-01-30 16:16:14 +00001706** Sqlite3_realloc() returns a pointer to a memory allocation
drhfddfa2d2007-12-05 18:05:16 +00001707** of at least N bytes in size or NULL if sufficient memory is unavailable.
drh33c1be32008-01-30 16:16:14 +00001708** If M is the size of the prior allocation, then min(N,M) bytes
drhfddfa2d2007-12-05 18:05:16 +00001709** of the prior allocation are copied into the beginning of buffer returned
1710** by sqlite3_realloc() and the prior allocation is freed.
drh33c1be32008-01-30 16:16:14 +00001711** If sqlite3_realloc() returns NULL, then the prior allocation
drhfddfa2d2007-12-05 18:05:16 +00001712** is not freed.
1713**
drh33c1be32008-01-30 16:16:14 +00001714** The memory returned by sqlite3_malloc() and sqlite3_realloc()
drhf5befa02007-12-06 02:42:07 +00001715** is always aligned to at least an 8 byte boundary. {END}
1716**
drh33c1be32008-01-30 16:16:14 +00001717** The default implementation
drhd84f9462007-08-15 11:28:56 +00001718** of the memory allocation subsystem uses the malloc(), realloc()
drhfddfa2d2007-12-05 18:05:16 +00001719** and free() provided by the standard C library. {F17382} However, if
drhd84f9462007-08-15 11:28:56 +00001720** SQLite is compiled with the following C preprocessor macro
1721**
drhd64621d2007-11-05 17:54:17 +00001722** <blockquote> SQLITE_MEMORY_SIZE=<i>NNN</i> </blockquote>
drhd84f9462007-08-15 11:28:56 +00001723**
drhd64621d2007-11-05 17:54:17 +00001724** where <i>NNN</i> is an integer, then SQLite create a static
1725** array of at least <i>NNN</i> bytes in size and use that array
drhfddfa2d2007-12-05 18:05:16 +00001726** for all of its dynamic memory allocation needs. {END} Additional
1727** memory allocator options may be added in future releases.
drhd64621d2007-11-05 17:54:17 +00001728**
1729** In SQLite version 3.5.0 and 3.5.1, it was possible to define
1730** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in
1731** implementation of these routines to be omitted. That capability
1732** is no longer provided. Only built-in memory allocators can be
1733** used.
drh8bacf972007-08-25 16:21:29 +00001734**
shane26b34032008-05-23 17:21:09 +00001735** The Windows OS interface layer calls
drh8bacf972007-08-25 16:21:29 +00001736** the system malloc() and free() directly when converting
1737** filenames between the UTF-8 encoding used by SQLite
shane26b34032008-05-23 17:21:09 +00001738** and whatever filename encoding is used by the particular Windows
drh8bacf972007-08-25 16:21:29 +00001739** installation. Memory allocation errors are detected, but
1740** they are reported back as [SQLITE_CANTOPEN] or
1741** [SQLITE_IOERR] rather than [SQLITE_NOMEM].
drh33c1be32008-01-30 16:16:14 +00001742**
1743** INVARIANTS:
1744**
1745** {F17303} The [sqlite3_malloc(N)] interface returns either a pointer to
1746** newly checked-out block of at least N bytes of memory
1747** that is 8-byte aligned,
1748** or it returns NULL if it is unable to fulfill the request.
1749**
1750** {F17304} The [sqlite3_malloc(N)] interface returns a NULL pointer if
1751** N is less than or equal to zero.
1752**
1753** {F17305} The [sqlite3_free(P)] interface releases memory previously
1754** returned from [sqlite3_malloc()] or [sqlite3_realloc()],
1755** making it available for reuse.
1756**
1757** {F17306} A call to [sqlite3_free(NULL)] is a harmless no-op.
1758**
1759** {F17310} A call to [sqlite3_realloc(0,N)] is equivalent to a call
1760** to [sqlite3_malloc(N)].
1761**
1762** {F17312} A call to [sqlite3_realloc(P,0)] is equivalent to a call
1763** to [sqlite3_free(P)].
1764**
1765** {F17315} The SQLite core uses [sqlite3_malloc()], [sqlite3_realloc()],
1766** and [sqlite3_free()] for all of its memory allocation and
1767** deallocation needs.
1768**
1769** {F17318} The [sqlite3_realloc(P,N)] interface returns either a pointer
1770** to a block of checked-out memory of at least N bytes in size
1771** that is 8-byte aligned, or a NULL pointer.
1772**
1773** {F17321} When [sqlite3_realloc(P,N)] returns a non-NULL pointer, it first
1774** copies the first K bytes of content from P into the newly allocated
shane26b34032008-05-23 17:21:09 +00001775** where K is the lesser of N and the size of the buffer P.
drh33c1be32008-01-30 16:16:14 +00001776**
1777** {F17322} When [sqlite3_realloc(P,N)] returns a non-NULL pointer, it first
1778** releases the buffer P.
1779**
1780** {F17323} When [sqlite3_realloc(P,N)] returns NULL, the buffer P is
1781** not modified or released.
1782**
1783** LIMITATIONS:
1784**
1785** {U17350} The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()]
1786** must be either NULL or else a pointer obtained from a prior
1787** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that has
1788** not been released.
1789**
1790** {U17351} The application must not read or write any part of
1791** a block of memory after it has been released using
1792** [sqlite3_free()] or [sqlite3_realloc()].
1793**
drh28dd4792006-06-26 21:35:44 +00001794*/
drhf3a65f72007-08-22 20:18:21 +00001795void *sqlite3_malloc(int);
1796void *sqlite3_realloc(void*, int);
drh28dd4792006-06-26 21:35:44 +00001797void sqlite3_free(void*);
1798
drh5191b7e2002-03-08 02:12:00 +00001799/*
drhfddfa2d2007-12-05 18:05:16 +00001800** CAPI3REF: Memory Allocator Statistics {F17370}
drhd84f9462007-08-15 11:28:56 +00001801**
drh33c1be32008-01-30 16:16:14 +00001802** SQLite provides these two interfaces for reporting on the status
1803** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()]
1804** the memory allocation subsystem included within the SQLite.
drhd84f9462007-08-15 11:28:56 +00001805**
drh33c1be32008-01-30 16:16:14 +00001806** INVARIANTS:
1807**
1808** {F17371} The [sqlite3_memory_used()] routine returns the
1809** number of bytes of memory currently outstanding
1810** (malloced but not freed).
1811**
1812** {F17373} The [sqlite3_memory_highwater()] routine returns the maximum
1813** value of [sqlite3_memory_used()]
shane26b34032008-05-23 17:21:09 +00001814** since the high-water mark was last reset.
drh33c1be32008-01-30 16:16:14 +00001815**
1816** {F17374} The values returned by [sqlite3_memory_used()] and
1817** [sqlite3_memory_highwater()] include any overhead
1818** added by SQLite in its implementation of [sqlite3_malloc()],
1819** but not overhead added by the any underlying system library
1820** routines that [sqlite3_malloc()] may call.
1821**
shane26b34032008-05-23 17:21:09 +00001822** {F17375} The memory high-water mark is reset to the current value of
drh33c1be32008-01-30 16:16:14 +00001823** [sqlite3_memory_used()] if and only if the parameter to
1824** [sqlite3_memory_highwater()] is true. The value returned
shane26b34032008-05-23 17:21:09 +00001825** by [sqlite3_memory_highwater(1)] is the high-water mark
drh33c1be32008-01-30 16:16:14 +00001826** prior to the reset.
drhd84f9462007-08-15 11:28:56 +00001827*/
drh153c62c2007-08-24 03:51:33 +00001828sqlite3_int64 sqlite3_memory_used(void);
1829sqlite3_int64 sqlite3_memory_highwater(int resetFlag);
drhd84f9462007-08-15 11:28:56 +00001830
1831/*
drh2fa18682008-03-19 14:15:34 +00001832** CAPI3REF: Pseudo-Random Number Generator {F17390}
1833**
1834** SQLite contains a high-quality pseudo-random number generator (PRNG) used to
1835** select random ROWIDs when inserting new records into a table that
1836** already uses the largest possible ROWID. The PRNG is also used for
1837** the build-in random() and randomblob() SQL functions. This interface allows
shane26b34032008-05-23 17:21:09 +00001838** applications to access the same PRNG for other purposes.
drh2fa18682008-03-19 14:15:34 +00001839**
1840** A call to this routine stores N bytes of randomness into buffer P.
1841**
1842** The first time this routine is invoked (either internally or by
1843** the application) the PRNG is seeded using randomness obtained
1844** from the xRandomness method of the default [sqlite3_vfs] object.
1845** On all subsequent invocations, the pseudo-randomness is generated
1846** internally and without recourse to the [sqlite3_vfs] xRandomness
1847** method.
1848**
1849** INVARIANTS:
1850**
1851** {F17392} The [sqlite3_randomness(N,P)] interface writes N bytes of
1852** high-quality pseudo-randomness into buffer P.
1853*/
1854void sqlite3_randomness(int N, void *P);
1855
1856/*
drhfddfa2d2007-12-05 18:05:16 +00001857** CAPI3REF: Compile-Time Authorization Callbacks {F12500}
1858**
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
drh33c1be32008-01-30 16:16:14 +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]
1872** then [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
1879** access is denied. If the authorizer code is [SQLITE_READ]
drhf47ce562008-03-20 18:00:49 +00001880** and the callback returns [SQLITE_IGNORE] then the
1881** [prepared statement] statement is constructed to substitute
1882** a NULL value in place of the table column that would have
drh33c1be32008-01-30 16:16:14 +00001883** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE]
1884** return can be used to deny an untrusted user access to individual
1885** columns of a table.
drh6ed48bf2007-06-14 20:57:18 +00001886**
drh33c1be32008-01-30 16:16:14 +00001887** The first parameter to the authorizer callback is a copy of
drh6ed48bf2007-06-14 20:57:18 +00001888** the third parameter to the sqlite3_set_authorizer() interface.
drh33c1be32008-01-30 16:16:14 +00001889** The second parameter to the callback is an integer
drh6ed48bf2007-06-14 20:57:18 +00001890** [SQLITE_COPY | action code] that specifies the particular action
drh33c1be32008-01-30 16:16:14 +00001891** to be authorized. The third through sixth
drhfddfa2d2007-12-05 18:05:16 +00001892** parameters to the callback are zero-terminated strings that contain
drh33c1be32008-01-30 16:16:14 +00001893** additional details about the action to be authorized.
drh6ed48bf2007-06-14 20:57:18 +00001894**
drhf47ce562008-03-20 18:00:49 +00001895** An authorizer is used when [sqlite3_prepare | preparing]
1896** SQL statements from an untrusted
drh6ed48bf2007-06-14 20:57:18 +00001897** source, to ensure that the SQL statements do not try to access data
1898** that they are not allowed to see, or that they do not try to
1899** execute malicious statements that damage the database. For
1900** example, an application may allow a user to enter arbitrary
1901** SQL queries for evaluation by a database. But the application does
1902** not want the user to be able to make arbitrary changes to the
1903** database. An authorizer could then be put in place while the
drhf47ce562008-03-20 18:00:49 +00001904** user-entered SQL is being [sqlite3_prepare | prepared] that
1905** disallows everything except [SELECT] statements.
1906**
1907** Applications that need to process SQL from untrusted sources
1908** might also consider lowering resource limits using [sqlite3_limit()]
1909** and limiting database size using the [max_page_count] [PRAGMA]
1910** in addition to using an authorizer.
drh6ed48bf2007-06-14 20:57:18 +00001911**
drh33c1be32008-01-30 16:16:14 +00001912** Only a single authorizer can be in place on a database connection
drh6ed48bf2007-06-14 20:57:18 +00001913** at a time. Each call to sqlite3_set_authorizer overrides the
drh33c1be32008-01-30 16:16:14 +00001914** previous call. Disable the authorizer by installing a NULL callback.
1915** The authorizer is disabled by default.
drh6ed48bf2007-06-14 20:57:18 +00001916**
1917** Note that the authorizer callback is invoked only during
drh33c1be32008-01-30 16:16:14 +00001918** [sqlite3_prepare()] or its variants. Authorization is not
1919** performed during statement evaluation in [sqlite3_step()].
1920**
1921** INVARIANTS:
1922**
1923** {F12501} The [sqlite3_set_authorizer(D,...)] interface registers a
1924** authorizer callback with database connection D.
1925**
1926** {F12502} The authorizer callback is invoked as SQL statements are
1927** being compiled
1928**
1929** {F12503} If the authorizer callback returns any value other than
1930** [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY] then
1931** the [sqlite3_prepare_v2()] or equivalent call that caused
1932** the authorizer callback to run shall fail with an
1933** [SQLITE_ERROR] error code and an appropriate error message.
1934**
1935** {F12504} When the authorizer callback returns [SQLITE_OK], the operation
1936** described is coded normally.
1937**
1938** {F12505} When the authorizer callback returns [SQLITE_DENY], the
1939** [sqlite3_prepare_v2()] or equivalent call that caused the
1940** authorizer callback to run shall fail
1941** with an [SQLITE_ERROR] error code and an error message
1942** explaining that access is denied.
1943**
1944** {F12506} If the authorizer code (the 2nd parameter to the authorizer
1945** callback) is [SQLITE_READ] and the authorizer callback returns
1946** [SQLITE_IGNORE] then the prepared statement is constructed to
1947** insert a NULL value in place of the table column that would have
1948** been read if [SQLITE_OK] had been returned.
1949**
1950** {F12507} If the authorizer code (the 2nd parameter to the authorizer
1951** callback) is anything other than [SQLITE_READ], then
1952** a return of [SQLITE_IGNORE] has the same effect as [SQLITE_DENY].
1953**
1954** {F12510} The first parameter to the authorizer callback is a copy of
1955** the third parameter to the [sqlite3_set_authorizer()] interface.
1956**
1957** {F12511} The second parameter to the callback is an integer
1958** [SQLITE_COPY | action code] that specifies the particular action
1959** to be authorized.
1960**
1961** {F12512} The third through sixth parameters to the callback are
1962** zero-terminated strings that contain
1963** additional details about the action to be authorized.
1964**
1965** {F12520} Each call to [sqlite3_set_authorizer()] overrides the
1966** any previously installed authorizer.
1967**
1968** {F12521} A NULL authorizer means that no authorization
1969** callback is invoked.
1970**
1971** {F12522} The default authorizer is NULL.
drhed6c8672003-01-12 18:02:16 +00001972*/
danielk19776f8a5032004-05-10 10:34:51 +00001973int sqlite3_set_authorizer(
danielk1977f9d64d22004-06-19 08:18:07 +00001974 sqlite3*,
drhe22a3342003-04-22 20:30:37 +00001975 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
drhe5f9c642003-01-13 23:27:31 +00001976 void *pUserData
drhed6c8672003-01-12 18:02:16 +00001977);
1978
1979/*
drhf5befa02007-12-06 02:42:07 +00001980** CAPI3REF: Authorizer Return Codes {F12590}
drh6ed48bf2007-06-14 20:57:18 +00001981**
1982** The [sqlite3_set_authorizer | authorizer callback function] must
1983** return either [SQLITE_OK] or one of these two constants in order
1984** to signal SQLite whether or not the action is permitted. See the
1985** [sqlite3_set_authorizer | authorizer documentation] for additional
1986** information.
1987*/
1988#define SQLITE_DENY 1 /* Abort the SQL statement with an error */
1989#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
1990
1991/*
drhf5befa02007-12-06 02:42:07 +00001992** CAPI3REF: Authorizer Action Codes {F12550}
drh6ed48bf2007-06-14 20:57:18 +00001993**
1994** The [sqlite3_set_authorizer()] interface registers a callback function
drh33c1be32008-01-30 16:16:14 +00001995** that is invoked to authorizer certain SQL statement actions. The
drh6ed48bf2007-06-14 20:57:18 +00001996** second parameter to the callback is an integer code that specifies
1997** what action is being authorized. These are the integer action codes that
drh33c1be32008-01-30 16:16:14 +00001998** the authorizer callback may be passed.
drh6ed48bf2007-06-14 20:57:18 +00001999**
2000** These action code values signify what kind of operation is to be
drh33c1be32008-01-30 16:16:14 +00002001** authorized. The 3rd and 4th parameters to the authorization
drhf5befa02007-12-06 02:42:07 +00002002** callback function will be parameters or NULL depending on which of these
drh33c1be32008-01-30 16:16:14 +00002003** codes is used as the second parameter. The 5th parameter to the
drh6ed48bf2007-06-14 20:57:18 +00002004** authorizer callback is the name of the database ("main", "temp",
drh33c1be32008-01-30 16:16:14 +00002005** etc.) if applicable. The 6th parameter to the authorizer callback
drh5cf590c2003-04-24 01:45:04 +00002006** is the name of the inner-most trigger or view that is responsible for
2007** the access attempt or NULL if this access attempt is directly from
drh6ed48bf2007-06-14 20:57:18 +00002008** top-level SQL code.
drh33c1be32008-01-30 16:16:14 +00002009**
2010** INVARIANTS:
2011**
2012** {F12551} The second parameter to an
shane26b34032008-05-23 17:21:09 +00002013** [sqlite3_set_authorizer | authorizer callback] is always an integer
drh33c1be32008-01-30 16:16:14 +00002014** [SQLITE_COPY | authorizer code] that specifies what action
2015** is being authorized.
2016**
2017** {F12552} The 3rd and 4th parameters to the
2018** [sqlite3_set_authorizer | authorization callback function]
2019** will be parameters or NULL depending on which
2020** [SQLITE_COPY | authorizer code] is used as the second parameter.
2021**
2022** {F12553} The 5th parameter to the
2023** [sqlite3_set_authorizer | authorizer callback] is the name
2024** of the database (example: "main", "temp", etc.) if applicable.
2025**
2026** {F12554} The 6th parameter to the
2027** [sqlite3_set_authorizer | authorizer callback] is the name
2028** of the inner-most trigger or view that is responsible for
2029** the access attempt or NULL if this access attempt is directly from
2030** top-level SQL code.
drhed6c8672003-01-12 18:02:16 +00002031*/
drh6ed48bf2007-06-14 20:57:18 +00002032/******************************************* 3rd ************ 4th ***********/
drhe5f9c642003-01-13 23:27:31 +00002033#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */
2034#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */
2035#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */
2036#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +00002037#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00002038#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */
drh77ad4e42003-01-14 02:49:27 +00002039#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00002040#define SQLITE_CREATE_VIEW 8 /* View Name NULL */
2041#define SQLITE_DELETE 9 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +00002042#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00002043#define SQLITE_DROP_TABLE 11 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +00002044#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00002045#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +00002046#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00002047#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */
drh77ad4e42003-01-14 02:49:27 +00002048#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00002049#define SQLITE_DROP_VIEW 17 /* View Name NULL */
2050#define SQLITE_INSERT 18 /* Table Name NULL */
2051#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */
2052#define SQLITE_READ 20 /* Table Name Column Name */
2053#define SQLITE_SELECT 21 /* NULL NULL */
2054#define SQLITE_TRANSACTION 22 /* NULL NULL */
2055#define SQLITE_UPDATE 23 /* Table Name Column Name */
drh81e293b2003-06-06 19:00:42 +00002056#define SQLITE_ATTACH 24 /* Filename NULL */
2057#define SQLITE_DETACH 25 /* Database Name NULL */
danielk19771c8c23c2004-11-12 15:53:37 +00002058#define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */
danielk19771d54df82004-11-23 15:41:16 +00002059#define SQLITE_REINDEX 27 /* Index Name NULL */
drhe6e04962005-07-23 02:17:03 +00002060#define SQLITE_ANALYZE 28 /* Table Name NULL */
danielk1977f1a381e2006-06-16 08:01:02 +00002061#define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */
2062#define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */
drh5169bbc2006-08-24 14:59:45 +00002063#define SQLITE_FUNCTION 31 /* Function Name NULL */
drh6ed48bf2007-06-14 20:57:18 +00002064#define SQLITE_COPY 0 /* No longer used */
drhed6c8672003-01-12 18:02:16 +00002065
2066/*
drhf5befa02007-12-06 02:42:07 +00002067** CAPI3REF: Tracing And Profiling Functions {F12280}
drh6ed48bf2007-06-14 20:57:18 +00002068**
2069** These routines register callback functions that can be used for
2070** tracing and profiling the execution of SQL statements.
drhfddfa2d2007-12-05 18:05:16 +00002071**
drh33c1be32008-01-30 16:16:14 +00002072** The callback function registered by sqlite3_trace() is invoked at
2073** various times when an SQL statement is being run by [sqlite3_step()].
2074** The callback returns a UTF-8 rendering of the SQL statement text
2075** as the statement first begins executing. Additional callbacks occur
shane26b34032008-05-23 17:21:09 +00002076** as each triggered subprogram is entered. The callbacks for triggers
drh33c1be32008-01-30 16:16:14 +00002077** contain a UTF-8 SQL comment that identifies the trigger.
2078**
2079** The callback function registered by sqlite3_profile() is invoked
2080** as each SQL statement finishes. The profile callback contains
2081** the original statement text and an estimate of wall-clock time
2082** of how long that statement took to run.
drh19e2d372005-08-29 23:00:03 +00002083**
2084** The sqlite3_profile() API is currently considered experimental and
drh33c1be32008-01-30 16:16:14 +00002085** is subject to change or removal in a future release.
2086**
2087** The trigger reporting feature of the trace callback is considered
2088** experimental and is subject to change or removal in future releases.
2089** Future versions of SQLite might also add new trace callback
2090** invocations.
2091**
2092** INVARIANTS:
2093**
2094** {F12281} The callback function registered by [sqlite3_trace()] is
2095** whenever an SQL statement first begins to execute and
2096** whenever a trigger subprogram first begins to run.
2097**
2098** {F12282} Each call to [sqlite3_trace()] overrides the previously
2099** registered trace callback.
2100**
2101** {F12283} A NULL trace callback disables tracing.
2102**
2103** {F12284} The first argument to the trace callback is a copy of
2104** the pointer which was the 3rd argument to [sqlite3_trace()].
2105**
2106** {F12285} The second argument to the trace callback is a
2107** zero-terminated UTF8 string containing the original text
2108** of the SQL statement as it was passed into [sqlite3_prepare_v2()]
2109** or the equivalent, or an SQL comment indicating the beginning
2110** of a trigger subprogram.
2111**
2112** {F12287} The callback function registered by [sqlite3_profile()] is invoked
2113** as each SQL statement finishes.
2114**
2115** {F12288} The first parameter to the profile callback is a copy of
2116** the 3rd parameter to [sqlite3_profile()].
2117**
2118** {F12289} The second parameter to the profile callback is a
2119** zero-terminated UTF-8 string that contains the complete text of
2120** the SQL statement as it was processed by [sqlite3_prepare_v2()]
2121** or the equivalent.
2122**
2123** {F12290} The third parameter to the profile callback is an estimate
2124** of the number of nanoseconds of wall-clock time required to
2125** run the SQL statement from start to finish.
drh18de4822003-01-16 16:28:53 +00002126*/
danielk1977f9d64d22004-06-19 08:18:07 +00002127void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*);
drh19e2d372005-08-29 23:00:03 +00002128void *sqlite3_profile(sqlite3*,
drh6d2069d2007-08-14 01:58:53 +00002129 void(*xProfile)(void*,const char*,sqlite3_uint64), void*);
drh18de4822003-01-16 16:28:53 +00002130
danielk1977348bb5d2003-10-18 09:37:26 +00002131/*
drhfddfa2d2007-12-05 18:05:16 +00002132** CAPI3REF: Query Progress Callbacks {F12910}
drh6ed48bf2007-06-14 20:57:18 +00002133**
drh33c1be32008-01-30 16:16:14 +00002134** This routine configures a callback function - the
drhfddfa2d2007-12-05 18:05:16 +00002135** progress callback - that is invoked periodically during long
2136** running calls to [sqlite3_exec()], [sqlite3_step()] and
drh33c1be32008-01-30 16:16:14 +00002137** [sqlite3_get_table()]. An example use for this
drh6ed48bf2007-06-14 20:57:18 +00002138** interface is to keep a GUI updated during a large query.
danielk1977348bb5d2003-10-18 09:37:26 +00002139**
shane236ce972008-05-30 15:35:30 +00002140** If the progress callback returns non-zero, the operation is
drh33c1be32008-01-30 16:16:14 +00002141** interrupted. This feature can be used to implement a
2142** "Cancel" button on a GUI dialog box.
danielk1977348bb5d2003-10-18 09:37:26 +00002143**
drh33c1be32008-01-30 16:16:14 +00002144** INVARIANTS:
2145**
2146** {F12911} The callback function registered by [sqlite3_progress_handler()]
2147** is invoked periodically during long running calls to
2148** [sqlite3_step()].
2149**
2150** {F12912} The progress callback is invoked once for every N virtual
2151** machine opcodes, where N is the second argument to
2152** the [sqlite3_progress_handler()] call that registered
2153** the callback. <todo>What if N is less than 1?</todo>
2154**
2155** {F12913} The progress callback itself is identified by the third
2156** argument to [sqlite3_progress_handler()].
2157**
2158** {F12914} The fourth argument [sqlite3_progress_handler()] is a
2159*** void pointer passed to the progress callback
2160** function each time it is invoked.
2161**
2162** {F12915} If a call to [sqlite3_step()] results in fewer than
2163** N opcodes being executed,
2164** then the progress callback is never invoked. {END}
danielk1977348bb5d2003-10-18 09:37:26 +00002165**
drh33c1be32008-01-30 16:16:14 +00002166** {F12916} Every call to [sqlite3_progress_handler()]
shane26b34032008-05-23 17:21:09 +00002167** overwrites any previously registered progress handler.
drh33c1be32008-01-30 16:16:14 +00002168**
2169** {F12917} If the progress handler callback is NULL then no progress
2170** handler is invoked.
danielk1977348bb5d2003-10-18 09:37:26 +00002171**
drhfddfa2d2007-12-05 18:05:16 +00002172** {F12918} If the progress callback returns a result other than 0, then
drh33c1be32008-01-30 16:16:14 +00002173** the behavior is a if [sqlite3_interrupt()] had been called.
danielk1977348bb5d2003-10-18 09:37:26 +00002174*/
danielk1977f9d64d22004-06-19 08:18:07 +00002175void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
danielk1977348bb5d2003-10-18 09:37:26 +00002176
drhaa940ea2004-01-15 02:44:03 +00002177/*
drhfddfa2d2007-12-05 18:05:16 +00002178** CAPI3REF: Opening A New Database Connection {F12700}
drhaa940ea2004-01-15 02:44:03 +00002179**
drh33c1be32008-01-30 16:16:14 +00002180** These routines open an SQLite database file whose name
drhfddfa2d2007-12-05 18:05:16 +00002181** is given by the filename argument.
drh33c1be32008-01-30 16:16:14 +00002182** The filename argument is interpreted as UTF-8
drhfddfa2d2007-12-05 18:05:16 +00002183** for [sqlite3_open()] and [sqlite3_open_v2()] and as UTF-16
drh9da9d962007-08-28 15:47:44 +00002184** in the native byte order for [sqlite3_open16()].
drh33c1be32008-01-30 16:16:14 +00002185** An [sqlite3*] handle is usually returned in *ppDb, even
2186** if an error occurs. The only exception is if SQLite is unable
drhfddfa2d2007-12-05 18:05:16 +00002187** to allocate memory to hold the [sqlite3] object, a NULL will
drh33c1be32008-01-30 16:16:14 +00002188** be written into *ppDb instead of a pointer to the [sqlite3] object.
2189** If the database is opened (and/or created)
2190** successfully, then [SQLITE_OK] is returned. Otherwise an
2191** error code is returned. The
drh6d2069d2007-08-14 01:58:53 +00002192** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain
drh4f26d6c2004-05-26 23:25:30 +00002193** an English language description of the error.
drh22fbcb82004-02-01 01:22:50 +00002194**
drh33c1be32008-01-30 16:16:14 +00002195** The default encoding for the database will be UTF-8 if
drh9da9d962007-08-28 15:47:44 +00002196** [sqlite3_open()] or [sqlite3_open_v2()] is called and
drhfddfa2d2007-12-05 18:05:16 +00002197** UTF-16 in the native byte order if [sqlite3_open16()] is used.
danielk197765904932004-05-26 06:18:37 +00002198**
drh33c1be32008-01-30 16:16:14 +00002199** Whether or not an error occurs when it is opened, resources
drhfddfa2d2007-12-05 18:05:16 +00002200** associated with the [sqlite3*] handle should be released by passing it
2201** to [sqlite3_close()] when it is no longer required.
drh6d2069d2007-08-14 01:58:53 +00002202**
drh33c1be32008-01-30 16:16:14 +00002203** The [sqlite3_open_v2()] interface works like [sqlite3_open()]
shane26b34032008-05-23 17:21:09 +00002204** except that it accepts two additional parameters for additional control
drh33c1be32008-01-30 16:16:14 +00002205** over the new database connection. The flags parameter can be
drhfddfa2d2007-12-05 18:05:16 +00002206** one of:
drh6d2069d2007-08-14 01:58:53 +00002207**
2208** <ol>
2209** <li> [SQLITE_OPEN_READONLY]
2210** <li> [SQLITE_OPEN_READWRITE]
2211** <li> [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]
2212** </ol>
2213**
drh33c1be32008-01-30 16:16:14 +00002214** The first value opens the database read-only.
2215** If the database does not previously exist, an error is returned.
2216** The second option opens
drh9da9d962007-08-28 15:47:44 +00002217** the database for reading and writing if possible, or reading only if
drh33c1be32008-01-30 16:16:14 +00002218** if the file is write protected. In either case the database
2219** must already exist or an error is returned. The third option
drhfddfa2d2007-12-05 18:05:16 +00002220** opens the database for reading and writing and creates it if it does
drh33c1be32008-01-30 16:16:14 +00002221** not already exist.
drh9da9d962007-08-28 15:47:44 +00002222** The third options is behavior that is always used for [sqlite3_open()]
2223** and [sqlite3_open16()].
2224**
drh1cceeb92008-04-19 14:06:28 +00002225** If the 3rd parameter to [sqlite3_open_v2()] is not one of the
drhd9b97cf2008-04-10 13:38:17 +00002226** combinations shown above then the behavior is undefined.
2227**
drh33c1be32008-01-30 16:16:14 +00002228** If the filename is ":memory:", then an private
2229** in-memory database is created for the connection. This in-memory
2230** database will vanish when the database connection is closed. Future
drh9da9d962007-08-28 15:47:44 +00002231** version of SQLite might make use of additional special filenames
2232** that begin with the ":" character. It is recommended that
2233** when a database filename really does begin with
2234** ":" that you prefix the filename with a pathname like "./" to
2235** avoid ambiguity.
drh6d2069d2007-08-14 01:58:53 +00002236**
drh33c1be32008-01-30 16:16:14 +00002237** If the filename is an empty string, then a private temporary
2238** on-disk database will be created. This private database will be
drh3f3b6352007-09-03 20:32:45 +00002239** automatically deleted as soon as the database connection is closed.
2240**
drh33c1be32008-01-30 16:16:14 +00002241** The fourth parameter to sqlite3_open_v2() is the name of the
drhd84f9462007-08-15 11:28:56 +00002242** [sqlite3_vfs] object that defines the operating system
drh33c1be32008-01-30 16:16:14 +00002243** interface that the new database connection should use. If the
drh9da9d962007-08-28 15:47:44 +00002244** fourth parameter is a NULL pointer then the default [sqlite3_vfs]
drh33c1be32008-01-30 16:16:14 +00002245** object is used.
drh6ed48bf2007-06-14 20:57:18 +00002246**
shane26b34032008-05-23 17:21:09 +00002247** <b>Note to Windows users:</b> The encoding used for the filename argument
drh9da9d962007-08-28 15:47:44 +00002248** of [sqlite3_open()] and [sqlite3_open_v2()] must be UTF-8, not whatever
2249** codepage is currently defined. Filenames containing international
2250** characters must be converted to UTF-8 prior to passing them into
2251** [sqlite3_open()] or [sqlite3_open_v2()].
drh33c1be32008-01-30 16:16:14 +00002252**
2253** INVARIANTS:
2254**
2255** {F12701} The [sqlite3_open()], [sqlite3_open16()], and
2256** [sqlite3_open_v2()] interfaces create a new
2257** [database connection] associated with
2258** the database file given in their first parameter.
2259**
2260** {F12702} The filename argument is interpreted as UTF-8
2261** for [sqlite3_open()] and [sqlite3_open_v2()] and as UTF-16
2262** in the native byte order for [sqlite3_open16()].
2263**
2264** {F12703} A successful invocation of [sqlite3_open()], [sqlite3_open16()],
2265** or [sqlite3_open_v2()] writes a pointer to a new
2266** [database connection] into *ppDb.
2267**
2268** {F12704} The [sqlite3_open()], [sqlite3_open16()], and
2269** [sqlite3_open_v2()] interfaces return [SQLITE_OK] upon success,
2270** or an appropriate [error code] on failure.
2271**
2272** {F12706} The default text encoding for a new database created using
2273** [sqlite3_open()] or [sqlite3_open_v2()] will be UTF-8.
2274**
2275** {F12707} The default text encoding for a new database created using
2276** [sqlite3_open16()] will be UTF-16.
2277**
2278** {F12709} The [sqlite3_open(F,D)] interface is equivalent to
2279** [sqlite3_open_v2(F,D,G,0)] where the G parameter is
2280** [SQLITE_OPEN_READWRITE]|[SQLITE_OPEN_CREATE].
2281**
2282** {F12711} If the G parameter to [sqlite3_open_v2(F,D,G,V)] contains the
2283** bit value [SQLITE_OPEN_READONLY] then the database is opened
2284** for reading only.
2285**
2286** {F12712} If the G parameter to [sqlite3_open_v2(F,D,G,V)] contains the
2287** bit value [SQLITE_OPEN_READWRITE] then the database is opened
2288** reading and writing if possible, or for reading only if the
2289** file is write protected by the operating system.
2290**
2291** {F12713} If the G parameter to [sqlite3_open(v2(F,D,G,V)] omits the
2292** bit value [SQLITE_OPEN_CREATE] and the database does not
2293** previously exist, an error is returned.
2294**
2295** {F12714} If the G parameter to [sqlite3_open(v2(F,D,G,V)] contains the
2296** bit value [SQLITE_OPEN_CREATE] and the database does not
2297** previously exist, then an attempt is made to create and
2298** initialize the database.
2299**
2300** {F12717} If the filename argument to [sqlite3_open()], [sqlite3_open16()],
2301** or [sqlite3_open_v2()] is ":memory:", then an private,
2302** ephemeral, in-memory database is created for the connection.
2303** <todo>Is SQLITE_OPEN_CREATE|SQLITE_OPEN_READWRITE required
2304** in sqlite3_open_v2()?</todo>
2305**
drhafc91042008-02-21 02:09:45 +00002306** {F12719} If the filename is NULL or an empty string, then a private,
shane26b34032008-05-23 17:21:09 +00002307** ephemeral on-disk database will be created.
drh33c1be32008-01-30 16:16:14 +00002308** <todo>Is SQLITE_OPEN_CREATE|SQLITE_OPEN_READWRITE required
2309** in sqlite3_open_v2()?</todo>
2310**
2311** {F12721} The [database connection] created by
2312** [sqlite3_open_v2(F,D,G,V)] will use the
2313** [sqlite3_vfs] object identified by the V parameter, or
2314** the default [sqlite3_vfs] object is V is a NULL pointer.
shane0c6844e2008-05-21 15:01:21 +00002315**
2316** {F12723} Two [database connection | database connections] will share a common cache
2317** if both were opened with the same VFS
2318** while [sqlite3_enable_shared_cache | shared cache mode was enabled] and
2319** if both filenames compare equal using memcmp()
2320** after having been processed by the [sqlite3_vfs | xFullPathname] method of
2321** the VFS.
2322**
danielk197765904932004-05-26 06:18:37 +00002323*/
2324int sqlite3_open(
2325 const char *filename, /* Database filename (UTF-8) */
danielk19774f057f92004-06-08 00:02:33 +00002326 sqlite3 **ppDb /* OUT: SQLite db handle */
danielk197765904932004-05-26 06:18:37 +00002327);
danielk197765904932004-05-26 06:18:37 +00002328int sqlite3_open16(
2329 const void *filename, /* Database filename (UTF-16) */
danielk19774f057f92004-06-08 00:02:33 +00002330 sqlite3 **ppDb /* OUT: SQLite db handle */
danielk197765904932004-05-26 06:18:37 +00002331);
drh6d2069d2007-08-14 01:58:53 +00002332int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00002333 const char *filename, /* Database filename (UTF-8) */
drh6d2069d2007-08-14 01:58:53 +00002334 sqlite3 **ppDb, /* OUT: SQLite db handle */
2335 int flags, /* Flags */
drhd84f9462007-08-15 11:28:56 +00002336 const char *zVfs /* Name of VFS module to use */
drh6d2069d2007-08-14 01:58:53 +00002337);
danielk1977295ba552004-05-19 10:34:51 +00002338
danielk197765904932004-05-26 06:18:37 +00002339/*
drhfddfa2d2007-12-05 18:05:16 +00002340** CAPI3REF: Error Codes And Messages {F12800}
drh6ed48bf2007-06-14 20:57:18 +00002341**
drh33c1be32008-01-30 16:16:14 +00002342** The sqlite3_errcode() interface returns the numeric
drh6ed48bf2007-06-14 20:57:18 +00002343** [SQLITE_OK | result code] or [SQLITE_IOERR_READ | extended result code]
2344** for the most recent failed sqlite3_* API call associated
drh33c1be32008-01-30 16:16:14 +00002345** with [sqlite3] handle 'db'. If a prior API call failed but the
drh6ed48bf2007-06-14 20:57:18 +00002346** most recent API call succeeded, the return value from sqlite3_errcode()
drh33c1be32008-01-30 16:16:14 +00002347** is undefined.
drh6ed48bf2007-06-14 20:57:18 +00002348**
drh33c1be32008-01-30 16:16:14 +00002349** The sqlite3_errmsg() and sqlite3_errmsg16() return English-language
drh6ed48bf2007-06-14 20:57:18 +00002350** text that describes the error, as either UTF8 or UTF16 respectively.
drh33c1be32008-01-30 16:16:14 +00002351** Memory to hold the error message string is managed internally.
2352** The application does not need to worry with freeing the result.
mlcreech27358862008-03-01 23:34:46 +00002353** However, the error string might be overwritten or deallocated by
drh33c1be32008-01-30 16:16:14 +00002354** subsequent calls to other SQLite interface functions.
danielk197765904932004-05-26 06:18:37 +00002355**
drh33c1be32008-01-30 16:16:14 +00002356** INVARIANTS:
danielk197765904932004-05-26 06:18:37 +00002357**
drh33c1be32008-01-30 16:16:14 +00002358** {F12801} The [sqlite3_errcode(D)] interface returns the numeric
2359** [SQLITE_OK | result code] or
2360** [SQLITE_IOERR_READ | extended result code]
drhb4d58ae2008-02-21 20:17:06 +00002361** for the most recently failed interface call associated
2362** with [database connection] D.
drh33c1be32008-01-30 16:16:14 +00002363**
2364** {F12803} The [sqlite3_errmsg(D)] and [sqlite3_errmsg16(D)]
2365** interfaces return English-language text that describes
2366** the error in the mostly recently failed interface call,
2367** encoded as either UTF8 or UTF16 respectively.
2368**
drhb4d58ae2008-02-21 20:17:06 +00002369** {F12807} The strings returned by [sqlite3_errmsg()] and [sqlite3_errmsg16()]
2370** are valid until the next SQLite interface call.
drh33c1be32008-01-30 16:16:14 +00002371**
2372** {F12808} Calls to API routines that do not return an error code
2373** (example: [sqlite3_data_count()]) do not
2374** change the error code or message returned by
2375** [sqlite3_errcode()], [sqlite3_errmsg()], or [sqlite3_errmsg16()].
2376**
2377** {F12809} Interfaces that are not associated with a specific
2378** [database connection] (examples:
2379** [sqlite3_mprintf()] or [sqlite3_enable_shared_cache()]
2380** do not change the values returned by
2381** [sqlite3_errcode()], [sqlite3_errmsg()], or [sqlite3_errmsg16()].
danielk197765904932004-05-26 06:18:37 +00002382*/
2383int sqlite3_errcode(sqlite3 *db);
danielk197765904932004-05-26 06:18:37 +00002384const char *sqlite3_errmsg(sqlite3*);
danielk197765904932004-05-26 06:18:37 +00002385const void *sqlite3_errmsg16(sqlite3*);
2386
2387/*
drhfddfa2d2007-12-05 18:05:16 +00002388** CAPI3REF: SQL Statement Object {F13000}
drh33c1be32008-01-30 16:16:14 +00002389** KEYWORDS: {prepared statement} {prepared statements}
drh6ed48bf2007-06-14 20:57:18 +00002390**
shane26b34032008-05-23 17:21:09 +00002391** An instance of this object represents a single SQL statement. This
drhf5befa02007-12-06 02:42:07 +00002392** object is variously known as a "prepared statement" or a
drh6ed48bf2007-06-14 20:57:18 +00002393** "compiled SQL statement" or simply as a "statement".
2394**
2395** The life of a statement object goes something like this:
2396**
2397** <ol>
2398** <li> Create the object using [sqlite3_prepare_v2()] or a related
2399** function.
2400** <li> Bind values to host parameters using
2401** [sqlite3_bind_blob | sqlite3_bind_* interfaces].
2402** <li> Run the SQL by calling [sqlite3_step()] one or more times.
2403** <li> Reset the statement using [sqlite3_reset()] then go back
2404** to step 2. Do this zero or more times.
2405** <li> Destroy the object using [sqlite3_finalize()].
2406** </ol>
2407**
2408** Refer to documentation on individual methods above for additional
2409** information.
danielk197765904932004-05-26 06:18:37 +00002410*/
danielk1977fc57d7b2004-05-26 02:04:57 +00002411typedef struct sqlite3_stmt sqlite3_stmt;
2412
danielk1977e3209e42004-05-20 01:40:18 +00002413/*
drhcaa639f2008-03-20 00:32:20 +00002414** CAPI3REF: Run-time Limits {F12760}
2415**
2416** This interface allows the size of various constructs to be limited
2417** on a connection by connection basis. The first parameter is the
2418** [database connection] whose limit is to be set or queried. The
2419** second parameter is one of the [limit categories] that define a
2420** class of constructs to be size limited. The third parameter is the
2421** new limit for that construct. The function returns the old limit.
2422**
2423** If the new limit is a negative number, the limit is unchanged.
drhf47ce562008-03-20 18:00:49 +00002424** For the limit category of SQLITE_LIMIT_XYZ there is a hard upper
2425** bound set by a compile-time C-preprocess macro named SQLITE_MAX_XYZ.
2426** (The "_LIMIT_" in the name is changed to "_MAX_".)
2427** Attempts to increase a limit above its hard upper bound are
2428** silently truncated to the hard upper limit.
drhcaa639f2008-03-20 00:32:20 +00002429**
drhbb4957f2008-03-20 14:03:29 +00002430** Run time limits are intended for use in applications that manage
2431** both their own internal database and also databases that are controlled
2432** by untrusted external sources. An example application might be a
2433** webbrowser that has its own databases for storing history and
shane26b34032008-05-23 17:21:09 +00002434** separate databases controlled by JavaScript applications downloaded
shane236ce972008-05-30 15:35:30 +00002435** off the Internet. The internal databases can be given the
drhbb4957f2008-03-20 14:03:29 +00002436** large, default limits. Databases managed by external sources can
2437** be given much smaller limits designed to prevent a denial of service
drhf47ce562008-03-20 18:00:49 +00002438** attach. Developers might also want to use the [sqlite3_set_authorizer()]
2439** interface to further control untrusted SQL. The size of the database
2440** created by an untrusted script can be contained using the
2441** [max_page_count] [PRAGMA].
drhbb4957f2008-03-20 14:03:29 +00002442**
drhcaa639f2008-03-20 00:32:20 +00002443** This interface is currently considered experimental and is subject
2444** to change or removal without prior notice.
2445**
2446** INVARIANTS:
2447**
drhf47ce562008-03-20 18:00:49 +00002448** {F12762} A successful call to [sqlite3_limit(D,C,V)] where V is
drhcaa639f2008-03-20 00:32:20 +00002449** positive changes the
drhbb4957f2008-03-20 14:03:29 +00002450** limit on the size of construct C in [database connection] D
shane26b34032008-05-23 17:21:09 +00002451** to the lesser of V and the hard upper bound on the size
drhcaa639f2008-03-20 00:32:20 +00002452** of C that is set at compile-time.
2453**
drhcaa639f2008-03-20 00:32:20 +00002454** {F12766} A successful call to [sqlite3_limit(D,C,V)] where V is negative
2455** leaves the state of [database connection] D unchanged.
2456**
2457** {F12769} A successful call to [sqlite3_limit(D,C,V)] returns the
2458** value of the limit on the size of construct C in
drhbb4957f2008-03-20 14:03:29 +00002459** in [database connection] D as it was prior to the call.
drhcaa639f2008-03-20 00:32:20 +00002460*/
2461int sqlite3_limit(sqlite3*, int id, int newVal);
2462
2463/*
2464** CAPI3REF: Run-Time Limit Categories {F12790}
2465** KEYWORDS: {limit category} {limit categories}
2466**
2467** These constants define various aspects of a [database connection]
2468** that can be limited in size by calls to [sqlite3_limit()].
drhbb4957f2008-03-20 14:03:29 +00002469** The meanings of the various limits are as follows:
2470**
2471** <dl>
2472** <dt>SQLITE_LIMIT_LENGTH</dt>
2473** <dd>The maximum size of any
2474** string or blob or table row.<dd>
2475**
2476** <dt>SQLITE_LIMIT_SQL_LENGTH</dt>
2477** <dd>The maximum length of an SQL statement.</dd>
2478**
2479** <dt>SQLITE_LIMIT_COLUMN</dt>
2480** <dd>The maximum number of columns in a table definition or in the
2481** result set of a SELECT or the maximum number of columns in an index
2482** or in an ORDER BY or GROUP BY clause.</dd>
2483**
2484** <dt>SQLITE_LIMIT_EXPR_DEPTH</dt>
2485** <dd>The maximum depth of the parse tree on any expression.</dd>
2486**
2487** <dt>SQLITE_LIMIT_COMPOUND_SELECT</dt>
2488** <dd>The maximum number of terms in a compound SELECT statement.</dd>
2489**
2490** <dt>SQLITE_LIMIT_VDBE_OP</dt>
2491** <dd>The maximum number of instructions in a virtual machine program
2492** used to implement an SQL statement.</dd>
2493**
2494** <dt>SQLITE_LIMIT_FUNCTION_ARG</dt>
2495** <dd>The maximum number of arguments on a function.</dd>
2496**
2497** <dt>SQLITE_LIMIT_ATTACHED</dt>
2498** <dd>The maximum number of attached databases.</dd>
2499**
drhbb4957f2008-03-20 14:03:29 +00002500** <dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt>
2501** <dd>The maximum length of the pattern argument to the LIKE or
2502** GLOB operators.</dd>
2503**
2504** <dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt>
2505** <dd>The maximum number of variables in an SQL statement that can
2506** be bound.</dd>
2507** </dl>
drhcaa639f2008-03-20 00:32:20 +00002508*/
2509#define SQLITE_LIMIT_LENGTH 0
2510#define SQLITE_LIMIT_SQL_LENGTH 1
2511#define SQLITE_LIMIT_COLUMN 2
2512#define SQLITE_LIMIT_EXPR_DEPTH 3
2513#define SQLITE_LIMIT_COMPOUND_SELECT 4
2514#define SQLITE_LIMIT_VDBE_OP 5
2515#define SQLITE_LIMIT_FUNCTION_ARG 6
2516#define SQLITE_LIMIT_ATTACHED 7
drhb1a6c3c2008-03-20 16:30:17 +00002517#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8
2518#define SQLITE_LIMIT_VARIABLE_NUMBER 9
drhcaa639f2008-03-20 00:32:20 +00002519
2520/*
drhfddfa2d2007-12-05 18:05:16 +00002521** CAPI3REF: Compiling An SQL Statement {F13010}
danielk197765904932004-05-26 06:18:37 +00002522**
drh6ed48bf2007-06-14 20:57:18 +00002523** To execute an SQL query, it must first be compiled into a byte-code
2524** program using one of these routines.
2525**
drh33c1be32008-01-30 16:16:14 +00002526** The first argument "db" is an [database connection]
drh4ff7fa02007-09-01 18:17:21 +00002527** obtained from a prior call to [sqlite3_open()], [sqlite3_open_v2()]
drh33c1be32008-01-30 16:16:14 +00002528** or [sqlite3_open16()].
drh6ed48bf2007-06-14 20:57:18 +00002529** The second argument "zSql" is the statement to be compiled, encoded
2530** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2()
2531** interfaces uses UTF-8 and sqlite3_prepare16() and sqlite3_prepare16_v2()
drhfddfa2d2007-12-05 18:05:16 +00002532** use UTF-16. {END}
drh21f06722007-07-19 12:41:39 +00002533**
drh33c1be32008-01-30 16:16:14 +00002534** If the nByte argument is less
drhfddfa2d2007-12-05 18:05:16 +00002535** than zero, then zSql is read up to the first zero terminator.
drh33c1be32008-01-30 16:16:14 +00002536** If nByte is non-negative, then it is the maximum number of
drh21f06722007-07-19 12:41:39 +00002537** bytes read from zSql. When nByte is non-negative, the
drhf5befa02007-12-06 02:42:07 +00002538** zSql string ends at either the first '\000' or '\u0000' character or
drhb08c2a72008-04-16 00:28:13 +00002539** the nByte-th byte, whichever comes first. If the caller knows
danielk19773a2c8c82008-04-03 14:36:25 +00002540** that the supplied string is nul-terminated, then there is a small
2541** performance advantage to be had by passing an nByte parameter that
2542** is equal to the number of bytes in the input string <i>including</i>
2543** the nul-terminator bytes.{END}
danielk197765904932004-05-26 06:18:37 +00002544**
drh33c1be32008-01-30 16:16:14 +00002545** *pzTail is made to point to the first byte past the end of the
shane26b34032008-05-23 17:21:09 +00002546** first SQL statement in zSql. These routines only compile the first
drhf5befa02007-12-06 02:42:07 +00002547** statement in zSql, so *pzTail is left pointing to what remains
drh33c1be32008-01-30 16:16:14 +00002548** uncompiled.
danielk197765904932004-05-26 06:18:37 +00002549**
drh33c1be32008-01-30 16:16:14 +00002550** *ppStmt is left pointing to a compiled [prepared statement] that can be
drh17eaae72008-03-03 18:47:28 +00002551** executed using [sqlite3_step()]. Or if there is an error, *ppStmt is
drh33c1be32008-01-30 16:16:14 +00002552** set to NULL. If the input text contains no SQL (if the input
drhfddfa2d2007-12-05 18:05:16 +00002553** is and empty string or a comment) then *ppStmt is set to NULL.
2554** {U13018} The calling procedure is responsible for deleting the
2555** compiled SQL statement
drh6ed48bf2007-06-14 20:57:18 +00002556** using [sqlite3_finalize()] after it has finished with it.
danielk197765904932004-05-26 06:18:37 +00002557**
drh33c1be32008-01-30 16:16:14 +00002558** On success, [SQLITE_OK] is returned. Otherwise an
2559** [error code] is returned.
drh6ed48bf2007-06-14 20:57:18 +00002560**
2561** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are
2562** recommended for all new programs. The two older interfaces are retained
2563** for backwards compatibility, but their use is discouraged.
drh33c1be32008-01-30 16:16:14 +00002564** In the "v2" interfaces, the prepared statement
drh6ed48bf2007-06-14 20:57:18 +00002565** that is returned (the [sqlite3_stmt] object) contains a copy of the
drhfddfa2d2007-12-05 18:05:16 +00002566** original SQL text. {END} This causes the [sqlite3_step()] interface to
drh6ed48bf2007-06-14 20:57:18 +00002567** behave a differently in two ways:
2568**
2569** <ol>
drh33c1be32008-01-30 16:16:14 +00002570** <li>
drh6ed48bf2007-06-14 20:57:18 +00002571** If the database schema changes, instead of returning [SQLITE_SCHEMA] as it
2572** always used to do, [sqlite3_step()] will automatically recompile the SQL
drh33c1be32008-01-30 16:16:14 +00002573** statement and try to run it again. If the schema has changed in
drhfddfa2d2007-12-05 18:05:16 +00002574** a way that makes the statement no longer valid, [sqlite3_step()] will still
drh33c1be32008-01-30 16:16:14 +00002575** return [SQLITE_SCHEMA]. But unlike the legacy behavior,
2576** [SQLITE_SCHEMA] is now a fatal error. Calling
drhfddfa2d2007-12-05 18:05:16 +00002577** [sqlite3_prepare_v2()] again will not make the
drh33c1be32008-01-30 16:16:14 +00002578** error go away. Note: use [sqlite3_errmsg()] to find the text
drhfddfa2d2007-12-05 18:05:16 +00002579** of the parsing error that results in an [SQLITE_SCHEMA] return. {END}
drh6ed48bf2007-06-14 20:57:18 +00002580** </li>
2581**
2582** <li>
drh33c1be32008-01-30 16:16:14 +00002583** When an error occurs,
drh6ed48bf2007-06-14 20:57:18 +00002584** [sqlite3_step()] will return one of the detailed
drh33c1be32008-01-30 16:16:14 +00002585** [error codes] or [extended error codes].
drh6ed48bf2007-06-14 20:57:18 +00002586** The legacy behavior was that [sqlite3_step()] would only return a generic
2587** [SQLITE_ERROR] result code and you would have to make a second call to
2588** [sqlite3_reset()] in order to find the underlying cause of the problem.
2589** With the "v2" prepare interfaces, the underlying reason for the error is
drh33c1be32008-01-30 16:16:14 +00002590** returned immediately.
drh6ed48bf2007-06-14 20:57:18 +00002591** </li>
2592** </ol>
drh33c1be32008-01-30 16:16:14 +00002593**
2594** INVARIANTS:
2595**
2596** {F13011} The [sqlite3_prepare(db,zSql,...)] and
2597** [sqlite3_prepare_v2(db,zSql,...)] interfaces interpret the
2598** text in their zSql parameter as UTF-8.
2599**
2600** {F13012} The [sqlite3_prepare16(db,zSql,...)] and
2601** [sqlite3_prepare16_v2(db,zSql,...)] interfaces interpret the
2602** text in their zSql parameter as UTF-16 in the native byte order.
2603**
2604** {F13013} If the nByte argument to [sqlite3_prepare_v2(db,zSql,nByte,...)]
2605** and its variants is less than zero, then SQL text is
2606** read from zSql is read up to the first zero terminator.
2607**
2608** {F13014} If the nByte argument to [sqlite3_prepare_v2(db,zSql,nByte,...)]
drhb08c2a72008-04-16 00:28:13 +00002609** and its variants is non-negative, then at most nBytes bytes
drh33c1be32008-01-30 16:16:14 +00002610** SQL text is read from zSql.
2611**
2612** {F13015} In [sqlite3_prepare_v2(db,zSql,N,P,pzTail)] and its variants
2613** if the zSql input text contains more than one SQL statement
2614** and pzTail is not NULL, then *pzTail is made to point to the
2615** first byte past the end of the first SQL statement in zSql.
2616** <todo>What does *pzTail point to if there is one statement?</todo>
2617**
2618** {F13016} A successful call to [sqlite3_prepare_v2(db,zSql,N,ppStmt,...)]
2619** or one of its variants writes into *ppStmt a pointer to a new
2620** [prepared statement] or a pointer to NULL
2621** if zSql contains nothing other than whitespace or comments.
2622**
2623** {F13019} The [sqlite3_prepare_v2()] interface and its variants return
2624** [SQLITE_OK] or an appropriate [error code] upon failure.
drh17eaae72008-03-03 18:47:28 +00002625**
2626** {F13021} Before [sqlite3_prepare(db,zSql,nByte,ppStmt,pzTail)] or its
2627** variants returns an error (any value other than [SQLITE_OK])
2628** it first sets *ppStmt to NULL.
danielk197765904932004-05-26 06:18:37 +00002629*/
2630int sqlite3_prepare(
2631 sqlite3 *db, /* Database handle */
2632 const char *zSql, /* SQL statement, UTF-8 encoded */
drh21f06722007-07-19 12:41:39 +00002633 int nByte, /* Maximum length of zSql in bytes. */
danielk197765904932004-05-26 06:18:37 +00002634 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2635 const char **pzTail /* OUT: Pointer to unused portion of zSql */
2636);
drh6ed48bf2007-06-14 20:57:18 +00002637int sqlite3_prepare_v2(
2638 sqlite3 *db, /* Database handle */
2639 const char *zSql, /* SQL statement, UTF-8 encoded */
drh21f06722007-07-19 12:41:39 +00002640 int nByte, /* Maximum length of zSql in bytes. */
drh6ed48bf2007-06-14 20:57:18 +00002641 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2642 const char **pzTail /* OUT: Pointer to unused portion of zSql */
2643);
danielk197765904932004-05-26 06:18:37 +00002644int sqlite3_prepare16(
2645 sqlite3 *db, /* Database handle */
2646 const void *zSql, /* SQL statement, UTF-16 encoded */
drh21f06722007-07-19 12:41:39 +00002647 int nByte, /* Maximum length of zSql in bytes. */
danielk197765904932004-05-26 06:18:37 +00002648 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2649 const void **pzTail /* OUT: Pointer to unused portion of zSql */
2650);
drhb900aaf2006-11-09 00:24:53 +00002651int sqlite3_prepare16_v2(
2652 sqlite3 *db, /* Database handle */
2653 const void *zSql, /* SQL statement, UTF-16 encoded */
drh21f06722007-07-19 12:41:39 +00002654 int nByte, /* Maximum length of zSql in bytes. */
drhb900aaf2006-11-09 00:24:53 +00002655 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2656 const void **pzTail /* OUT: Pointer to unused portion of zSql */
2657);
2658
2659/*
drhfddfa2d2007-12-05 18:05:16 +00002660** CAPIREF: Retrieving Statement SQL {F13100}
danielk1977d0e2a852007-11-14 06:48:48 +00002661**
shane26b34032008-05-23 17:21:09 +00002662** This interface can be used to retrieve a saved copy of the original
drh33c1be32008-01-30 16:16:14 +00002663** SQL text used to create a [prepared statement].
danielk1977d0e2a852007-11-14 06:48:48 +00002664**
drh33c1be32008-01-30 16:16:14 +00002665** INVARIANTS:
2666**
2667** {F13101} If the [prepared statement] passed as
2668** the an argument to [sqlite3_sql()] was compiled
2669** compiled using either [sqlite3_prepare_v2()] or
2670** [sqlite3_prepare16_v2()],
2671** then [sqlite3_sql()] function returns a pointer to a
2672** zero-terminated string containing a UTF-8 rendering
2673** of the original SQL statement.
2674**
2675** {F13102} If the [prepared statement] passed as
2676** the an argument to [sqlite3_sql()] was compiled
2677** compiled using either [sqlite3_prepare()] or
2678** [sqlite3_prepare16()],
2679** then [sqlite3_sql()] function returns a NULL pointer.
2680**
2681** {F13103} The string returned by [sqlite3_sql(S)] is valid until the
2682** [prepared statement] S is deleted using [sqlite3_finalize(S)].
danielk1977d0e2a852007-11-14 06:48:48 +00002683*/
2684const char *sqlite3_sql(sqlite3_stmt *pStmt);
2685
2686/*
drhfddfa2d2007-12-05 18:05:16 +00002687** CAPI3REF: Dynamically Typed Value Object {F15000}
drhaa28e142008-03-18 13:47:20 +00002688** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value}
drh6ed48bf2007-06-14 20:57:18 +00002689**
drh33c1be32008-01-30 16:16:14 +00002690** SQLite uses the sqlite3_value object to represent all values
drhaa28e142008-03-18 13:47:20 +00002691** that can be stored in a database table.
drhf5befa02007-12-06 02:42:07 +00002692** SQLite uses dynamic typing for the values it stores.
drh33c1be32008-01-30 16:16:14 +00002693** Values stored in sqlite3_value objects can be
drhf5befa02007-12-06 02:42:07 +00002694** be integers, floating point values, strings, BLOBs, or NULL.
drhaa28e142008-03-18 13:47:20 +00002695**
2696** An sqlite3_value object may be either "protected" or "unprotected".
2697** Some interfaces require a protected sqlite3_value. Other interfaces
2698** will accept either a protected or an unprotected sqlite3_value.
2699** Every interface that accepts sqlite3_value arguments specifies
2700** whether or not it requires a protected sqlite3_value.
2701**
2702** The terms "protected" and "unprotected" refer to whether or not
2703** a mutex is held. A internal mutex is held for a protected
2704** sqlite3_value object but no mutex is held for an unprotected
2705** sqlite3_value object. If SQLite is compiled to be single-threaded
2706** (with SQLITE_THREADSAFE=0 and with [sqlite3_threadsafe()] returning 0)
2707** then there is no distinction between
2708** protected and unprotected sqlite3_value objects and they can be
shane26b34032008-05-23 17:21:09 +00002709** used interchangeable. However, for maximum code portability it
drhaa28e142008-03-18 13:47:20 +00002710** is recommended that applications make the distinction between
2711** between protected and unprotected sqlite3_value objects even if
2712** they are single threaded.
2713**
2714** The sqlite3_value objects that are passed as parameters into the
drhce5a5a02008-06-10 17:41:44 +00002715** implementation of
2716** [sqlite3_create_function | application-defined SQL functions]
2717** are protected.
drhaa28e142008-03-18 13:47:20 +00002718** The sqlite3_value object returned by
2719** [sqlite3_column_value()] is unprotected.
2720** Unprotected sqlite3_value objects may only be used with
drhce5a5a02008-06-10 17:41:44 +00002721** [sqlite3_result_value()] and [sqlite3_bind_value()].
2722** The [sqlite3_value_blob | sqlite3_value_type()] family of
2723** interfaces require protected sqlite3_value objects.
drhf4479502004-05-27 03:12:53 +00002724*/
drhf4479502004-05-27 03:12:53 +00002725typedef struct Mem sqlite3_value;
2726
2727/*
drhfddfa2d2007-12-05 18:05:16 +00002728** CAPI3REF: SQL Function Context Object {F16001}
drh4f26d6c2004-05-26 23:25:30 +00002729**
drh6ed48bf2007-06-14 20:57:18 +00002730** The context in which an SQL function executes is stored in an
drh33c1be32008-01-30 16:16:14 +00002731** sqlite3_context object. A pointer to an sqlite3_context
drhce5a5a02008-06-10 17:41:44 +00002732** object is always first parameter to
2733** [sqlite3_create_function | application-defined SQL functions].
2734** The applicationed-defined SQL function implementation will pass this
2735** pointer through into calls to
2736** [sqlite3_result_int | sqlite3_result()],
2737** [sqlite3_aggregate_context()],
2738** [sqlite3_user_data()],
2739** [sqlite3_context_db_handle()],
2740** [sqlite3_get_auxdata()], and/or [sqlite3_set_auxdata()].
drh6ed48bf2007-06-14 20:57:18 +00002741*/
2742typedef struct sqlite3_context sqlite3_context;
2743
2744/*
drhfddfa2d2007-12-05 18:05:16 +00002745** CAPI3REF: Binding Values To Prepared Statements {F13500}
drh6ed48bf2007-06-14 20:57:18 +00002746**
drh33c1be32008-01-30 16:16:14 +00002747** In the SQL strings input to [sqlite3_prepare_v2()] and its
drhf5befa02007-12-06 02:42:07 +00002748** variants, literals may be replace by a parameter in one
drhfddfa2d2007-12-05 18:05:16 +00002749** of these forms:
drh6ed48bf2007-06-14 20:57:18 +00002750**
2751** <ul>
2752** <li> ?
2753** <li> ?NNN
drh33c1be32008-01-30 16:16:14 +00002754** <li> :VVV
2755** <li> @VVV
drh6ed48bf2007-06-14 20:57:18 +00002756** <li> $VVV
2757** </ul>
2758**
2759** In the parameter forms shown above NNN is an integer literal,
drh33c1be32008-01-30 16:16:14 +00002760** VVV alpha-numeric parameter name.
2761** The values of these parameters (also called "host parameter names"
2762** or "SQL parameters")
drh6ed48bf2007-06-14 20:57:18 +00002763** can be set using the sqlite3_bind_*() routines defined here.
2764**
drh33c1be32008-01-30 16:16:14 +00002765** The first argument to the sqlite3_bind_*() routines always
drhfddfa2d2007-12-05 18:05:16 +00002766** is a pointer to the [sqlite3_stmt] object returned from
drh33c1be32008-01-30 16:16:14 +00002767** [sqlite3_prepare_v2()] or its variants. The second
2768** argument is the index of the parameter to be set. The
2769** first parameter has an index of 1. When the same named
drhfddfa2d2007-12-05 18:05:16 +00002770** parameter is used more than once, second and subsequent
2771** occurrences have the same index as the first occurrence.
drh33c1be32008-01-30 16:16:14 +00002772** The index for named parameters can be looked up using the
2773** [sqlite3_bind_parameter_name()] API if desired. The index
drhf5befa02007-12-06 02:42:07 +00002774** for "?NNN" parameters is the value of NNN.
drh33c1be32008-01-30 16:16:14 +00002775** The NNN value must be between 1 and the compile-time
2776** parameter SQLITE_MAX_VARIABLE_NUMBER (default value: 999).
drh6ed48bf2007-06-14 20:57:18 +00002777**
drh33c1be32008-01-30 16:16:14 +00002778** The third argument is the value to bind to the parameter.
drh6ed48bf2007-06-14 20:57:18 +00002779**
drh33c1be32008-01-30 16:16:14 +00002780** In those
drh6ed48bf2007-06-14 20:57:18 +00002781** routines that have a fourth argument, its value is the number of bytes
drh33c1be32008-01-30 16:16:14 +00002782** in the parameter. To be clear: the value is the number of <u>bytes</u>
drhb08c2a72008-04-16 00:28:13 +00002783** in the value, not the number of characters.
drh6ed48bf2007-06-14 20:57:18 +00002784** If the fourth parameter is negative, the length of the string is
shane26b34032008-05-23 17:21:09 +00002785** the number of bytes up to the first zero terminator.
drh4f26d6c2004-05-26 23:25:30 +00002786**
drh930cc582007-03-28 13:07:40 +00002787** The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and
drh900dfba2004-07-21 15:21:36 +00002788** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or
drh33c1be32008-01-30 16:16:14 +00002789** string after SQLite has finished with it. If the fifth argument is
2790** the special value [SQLITE_STATIC], then SQLite assumes that the
drhfddfa2d2007-12-05 18:05:16 +00002791** information is in static, unmanaged space and does not need to be freed.
drh33c1be32008-01-30 16:16:14 +00002792** If the fifth argument has the value [SQLITE_TRANSIENT], then
drhfddfa2d2007-12-05 18:05:16 +00002793** SQLite makes its own private copy of the data immediately, before
drh33c1be32008-01-30 16:16:14 +00002794** the sqlite3_bind_*() routine returns.
drh4f26d6c2004-05-26 23:25:30 +00002795**
drh33c1be32008-01-30 16:16:14 +00002796** The sqlite3_bind_zeroblob() routine binds a BLOB of length N that
2797** is filled with zeros. A zeroblob uses a fixed amount of memory
2798** (just an integer to hold it size) while it is being processed.
shane26b34032008-05-23 17:21:09 +00002799** Zeroblobs are intended to serve as placeholders for BLOBs whose
drh6ed48bf2007-06-14 20:57:18 +00002800** content is later written using
drh33c1be32008-01-30 16:16:14 +00002801** [sqlite3_blob_open | increment BLOB I/O] routines. A negative
2802** value for the zeroblob results in a zero-length BLOB.
drh6ed48bf2007-06-14 20:57:18 +00002803**
drh33c1be32008-01-30 16:16:14 +00002804** The sqlite3_bind_*() routines must be called after
drh6ed48bf2007-06-14 20:57:18 +00002805** [sqlite3_prepare_v2()] (and its variants) or [sqlite3_reset()] and
drh33c1be32008-01-30 16:16:14 +00002806** before [sqlite3_step()].
drh6ed48bf2007-06-14 20:57:18 +00002807** Bindings are not cleared by the [sqlite3_reset()] routine.
drh33c1be32008-01-30 16:16:14 +00002808** Unbound parameters are interpreted as NULL.
drh6ed48bf2007-06-14 20:57:18 +00002809**
drh33c1be32008-01-30 16:16:14 +00002810** These routines return [SQLITE_OK] on success or an error code if
2811** anything goes wrong. [SQLITE_RANGE] is returned if the parameter
shane26b34032008-05-23 17:21:09 +00002812** index is out of range. [SQLITE_NOMEM] is returned if malloc() fails.
drh33c1be32008-01-30 16:16:14 +00002813** [SQLITE_MISUSE] might be returned if these routines are called on a
drhfddfa2d2007-12-05 18:05:16 +00002814** virtual machine that is the wrong state or which has already been finalized.
drh33c1be32008-01-30 16:16:14 +00002815** Detection of misuse is unreliable. Applications should not depend
2816** on SQLITE_MISUSE returns. SQLITE_MISUSE is intended to indicate a
2817** a logic error in the application. Future versions of SQLite might
2818** panic rather than return SQLITE_MISUSE.
2819**
2820** See also: [sqlite3_bind_parameter_count()],
2821** [sqlite3_bind_parameter_name()], and
2822** [sqlite3_bind_parameter_index()].
2823**
2824** INVARIANTS:
2825**
2826** {F13506} The [sqlite3_prepare | SQL statement compiler] recognizes
2827** tokens of the forms "?", "?NNN", "$VVV", ":VVV", and "@VVV"
2828** as SQL parameters, where NNN is any sequence of one or more
2829** digits and where VVV is any sequence of one or more
2830** alphanumeric characters or "::" optionally followed by
2831** a string containing no spaces and contained within parentheses.
2832**
2833** {F13509} The initial value of an SQL parameter is NULL.
2834**
2835** {F13512} The index of an "?" SQL parameter is one larger than the
2836** largest index of SQL parameter to the left, or 1 if
2837** the "?" is the leftmost SQL parameter.
2838**
2839** {F13515} The index of an "?NNN" SQL parameter is the integer NNN.
2840**
2841** {F13518} The index of an ":VVV", "$VVV", or "@VVV" SQL parameter is
shane26b34032008-05-23 17:21:09 +00002842** the same as the index of leftmost occurrences of the same
drh33c1be32008-01-30 16:16:14 +00002843** parameter, or one more than the largest index over all
shane26b34032008-05-23 17:21:09 +00002844** parameters to the left if this is the first occurrence
drh33c1be32008-01-30 16:16:14 +00002845** of this parameter, or 1 if this is the leftmost parameter.
2846**
2847** {F13521} The [sqlite3_prepare | SQL statement compiler] fail with
2848** an [SQLITE_RANGE] error if the index of an SQL parameter
2849** is less than 1 or greater than SQLITE_MAX_VARIABLE_NUMBER.
2850**
2851** {F13524} Calls to [sqlite3_bind_text | sqlite3_bind(S,N,V,...)]
2852** associate the value V with all SQL parameters having an
2853** index of N in the [prepared statement] S.
2854**
2855** {F13527} Calls to [sqlite3_bind_text | sqlite3_bind(S,N,...)]
2856** override prior calls with the same values of S and N.
2857**
2858** {F13530} Bindings established by [sqlite3_bind_text | sqlite3_bind(S,...)]
2859** persist across calls to [sqlite3_reset(S)].
2860**
2861** {F13533} In calls to [sqlite3_bind_blob(S,N,V,L,D)],
2862** [sqlite3_bind_text(S,N,V,L,D)], or
2863** [sqlite3_bind_text16(S,N,V,L,D)] SQLite binds the first L
2864** bytes of the blob or string pointed to by V, when L
2865** is non-negative.
2866**
2867** {F13536} In calls to [sqlite3_bind_text(S,N,V,L,D)] or
2868** [sqlite3_bind_text16(S,N,V,L,D)] SQLite binds characters
2869** from V through the first zero character when L is negative.
2870**
2871** {F13539} In calls to [sqlite3_bind_blob(S,N,V,L,D)],
2872** [sqlite3_bind_text(S,N,V,L,D)], or
2873** [sqlite3_bind_text16(S,N,V,L,D)] when D is the special
2874** constant [SQLITE_STATIC], SQLite assumes that the value V
2875** is held in static unmanaged space that will not change
2876** during the lifetime of the binding.
2877**
2878** {F13542} In calls to [sqlite3_bind_blob(S,N,V,L,D)],
2879** [sqlite3_bind_text(S,N,V,L,D)], or
2880** [sqlite3_bind_text16(S,N,V,L,D)] when D is the special
2881** constant [SQLITE_TRANSIENT], the routine makes a
2882** private copy of V value before it returns.
2883**
2884** {F13545} In calls to [sqlite3_bind_blob(S,N,V,L,D)],
2885** [sqlite3_bind_text(S,N,V,L,D)], or
2886** [sqlite3_bind_text16(S,N,V,L,D)] when D is a pointer to
2887** a function, SQLite invokes that function to destroy the
2888** V value after it has finished using the V value.
2889**
2890** {F13548} In calls to [sqlite3_bind_zeroblob(S,N,V,L)] the value bound
2891** is a blob of L bytes, or a zero-length blob if L is negative.
drhaa28e142008-03-18 13:47:20 +00002892**
2893** {F13551} In calls to [sqlite3_bind_value(S,N,V)] the V argument may
2894** be either a [protected sqlite3_value] object or an
2895** [unprotected sqlite3_value] object.
drh4f26d6c2004-05-26 23:25:30 +00002896*/
danielk1977d8123362004-06-12 09:25:12 +00002897int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*));
drhf4479502004-05-27 03:12:53 +00002898int sqlite3_bind_double(sqlite3_stmt*, int, double);
2899int sqlite3_bind_int(sqlite3_stmt*, int, int);
drh6d2069d2007-08-14 01:58:53 +00002900int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64);
drhf4479502004-05-27 03:12:53 +00002901int sqlite3_bind_null(sqlite3_stmt*, int);
danielk1977d8123362004-06-12 09:25:12 +00002902int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*));
2903int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*));
drhf4479502004-05-27 03:12:53 +00002904int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);
drhb026e052007-05-02 01:34:31 +00002905int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n);
drh4f26d6c2004-05-26 23:25:30 +00002906
2907/*
drh33c1be32008-01-30 16:16:14 +00002908** CAPI3REF: Number Of SQL Parameters {F13600}
drh6ed48bf2007-06-14 20:57:18 +00002909**
drh33c1be32008-01-30 16:16:14 +00002910** This routine can be used to find the number of SQL parameters
2911** in a prepared statement. SQL parameters are tokens of the
2912** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as
shane26b34032008-05-23 17:21:09 +00002913** placeholders for values that are [sqlite3_bind_blob | bound]
drh33c1be32008-01-30 16:16:14 +00002914** to the parameters at a later time.
drh605264d2007-08-21 15:13:19 +00002915**
drh33c1be32008-01-30 16:16:14 +00002916** This routine actually returns the index of the largest parameter.
2917** For all forms except ?NNN, this will correspond to the number of
2918** unique parameters. If parameters of the ?NNN are used, there may
2919** be gaps in the list.
2920**
2921** See also: [sqlite3_bind_blob|sqlite3_bind()],
2922** [sqlite3_bind_parameter_name()], and
2923** [sqlite3_bind_parameter_index()].
2924**
2925** INVARIANTS:
2926**
2927** {F13601} The [sqlite3_bind_parameter_count(S)] interface returns
2928** the largest index of all SQL parameters in the
2929** [prepared statement] S, or 0 if S
2930** contains no SQL parameters.
drh75f6a032004-07-15 14:15:00 +00002931*/
2932int sqlite3_bind_parameter_count(sqlite3_stmt*);
2933
2934/*
drhfddfa2d2007-12-05 18:05:16 +00002935** CAPI3REF: Name Of A Host Parameter {F13620}
drh6ed48bf2007-06-14 20:57:18 +00002936**
drh33c1be32008-01-30 16:16:14 +00002937** This routine returns a pointer to the name of the n-th
2938** SQL parameter in a [prepared statement].
drhe1b3e802008-04-27 22:29:01 +00002939** SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA"
2940** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA"
2941** respectively.
2942** In other words, the initial ":" or "$" or "@" or "?"
drh33c1be32008-01-30 16:16:14 +00002943** is included as part of the name.
drhe1b3e802008-04-27 22:29:01 +00002944** Parameters of the form "?" without a following integer have no name.
drh6ed48bf2007-06-14 20:57:18 +00002945**
drh33c1be32008-01-30 16:16:14 +00002946** The first host parameter has an index of 1, not 0.
drh6ed48bf2007-06-14 20:57:18 +00002947**
drh33c1be32008-01-30 16:16:14 +00002948** If the value n is out of range or if the n-th parameter is
2949** nameless, then NULL is returned. The returned string is
drhfddfa2d2007-12-05 18:05:16 +00002950** always in the UTF-8 encoding even if the named parameter was
2951** originally specified as UTF-16 in [sqlite3_prepare16()] or
2952** [sqlite3_prepare16_v2()].
drh33c1be32008-01-30 16:16:14 +00002953**
2954** See also: [sqlite3_bind_blob|sqlite3_bind()],
2955** [sqlite3_bind_parameter_count()], and
2956** [sqlite3_bind_parameter_index()].
2957**
2958** INVARIANTS:
2959**
2960** {F13621} The [sqlite3_bind_parameter_name(S,N)] interface returns
2961** a UTF-8 rendering of the name of the SQL parameter in
2962** [prepared statement] S having index N, or
2963** NULL if there is no SQL parameter with index N or if the
drhe1b3e802008-04-27 22:29:01 +00002964** parameter with index N is an anonymous parameter "?".
drh895d7472004-08-20 16:02:39 +00002965*/
2966const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int);
2967
2968/*
drhfddfa2d2007-12-05 18:05:16 +00002969** CAPI3REF: Index Of A Parameter With A Given Name {F13640}
drh6ed48bf2007-06-14 20:57:18 +00002970**
drh33c1be32008-01-30 16:16:14 +00002971** Return the index of an SQL parameter given its name. The
2972** index value returned is suitable for use as the second
2973** parameter to [sqlite3_bind_blob|sqlite3_bind()]. A zero
2974** is returned if no matching parameter is found. The parameter
2975** name must be given in UTF-8 even if the original statement
2976** was prepared from UTF-16 text using [sqlite3_prepare16_v2()].
2977**
2978** See also: [sqlite3_bind_blob|sqlite3_bind()],
2979** [sqlite3_bind_parameter_count()], and
2980** [sqlite3_bind_parameter_index()].
2981**
2982** INVARIANTS:
2983**
2984** {F13641} The [sqlite3_bind_parameter_index(S,N)] interface returns
2985** the index of SQL parameter in [prepared statement]
2986** S whose name matches the UTF-8 string N, or 0 if there is
2987** no match.
drhfa6bc002004-09-07 16:19:52 +00002988*/
2989int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName);
2990
2991/*
drhfddfa2d2007-12-05 18:05:16 +00002992** CAPI3REF: Reset All Bindings On A Prepared Statement {F13660}
drh6ed48bf2007-06-14 20:57:18 +00002993**
drh33c1be32008-01-30 16:16:14 +00002994** Contrary to the intuition of many, [sqlite3_reset()] does not
drh6ed48bf2007-06-14 20:57:18 +00002995** reset the [sqlite3_bind_blob | bindings] on a
drh33c1be32008-01-30 16:16:14 +00002996** [prepared statement]. Use this routine to
drh6ed48bf2007-06-14 20:57:18 +00002997** reset all host parameters to NULL.
drh33c1be32008-01-30 16:16:14 +00002998**
2999** INVARIANTS:
3000**
3001** {F13661} The [sqlite3_clear_bindings(S)] interface resets all
3002** SQL parameter bindings in [prepared statement] S
3003** back to NULL.
danielk1977600dd0b2005-01-20 01:14:23 +00003004*/
3005int sqlite3_clear_bindings(sqlite3_stmt*);
3006
3007/*
drhfddfa2d2007-12-05 18:05:16 +00003008** CAPI3REF: Number Of Columns In A Result Set {F13710}
drh6ed48bf2007-06-14 20:57:18 +00003009**
drh33c1be32008-01-30 16:16:14 +00003010** Return the number of columns in the result set returned by the
3011** [prepared statement]. This routine returns 0
drh6ed48bf2007-06-14 20:57:18 +00003012** if pStmt is an SQL statement that does not return data (for
3013** example an UPDATE).
drh33c1be32008-01-30 16:16:14 +00003014**
3015** INVARIANTS:
3016**
3017** {F13711} The [sqlite3_column_count(S)] interface returns the number of
3018** columns in the result set generated by the
3019** [prepared statement] S, or 0 if S does not generate
3020** a result set.
danielk197765904932004-05-26 06:18:37 +00003021*/
3022int sqlite3_column_count(sqlite3_stmt *pStmt);
3023
3024/*
drhfddfa2d2007-12-05 18:05:16 +00003025** CAPI3REF: Column Names In A Result Set {F13720}
drh6ed48bf2007-06-14 20:57:18 +00003026**
drh33c1be32008-01-30 16:16:14 +00003027** These routines return the name assigned to a particular column
3028** in the result set of a SELECT statement. The sqlite3_column_name()
drhf5befa02007-12-06 02:42:07 +00003029** interface returns a pointer to a zero-terminated UTF8 string
3030** and sqlite3_column_name16() returns a pointer to a zero-terminated
drh33c1be32008-01-30 16:16:14 +00003031** UTF16 string. The first parameter is the
3032** [prepared statement] that implements the SELECT statement.
drh6ed48bf2007-06-14 20:57:18 +00003033** The second parameter is the column number. The left-most column is
3034** number 0.
3035**
drh33c1be32008-01-30 16:16:14 +00003036** The returned string pointer is valid until either the
3037** [prepared statement] is destroyed by [sqlite3_finalize()]
drh6ed48bf2007-06-14 20:57:18 +00003038** or until the next call sqlite3_column_name() or sqlite3_column_name16()
3039** on the same column.
drh4a50aac2007-08-23 02:47:53 +00003040**
drh33c1be32008-01-30 16:16:14 +00003041** If sqlite3_malloc() fails during the processing of either routine
drh4a50aac2007-08-23 02:47:53 +00003042** (for example during a conversion from UTF-8 to UTF-16) then a
3043** NULL pointer is returned.
drh33c1be32008-01-30 16:16:14 +00003044**
3045** The name of a result column is the value of the "AS" clause for
3046** that column, if there is an AS clause. If there is no AS clause
3047** then the name of the column is unspecified and may change from
3048** one release of SQLite to the next.
3049**
3050** INVARIANTS:
3051**
3052** {F13721} A successful invocation of the [sqlite3_column_name(S,N)]
3053** interface returns the name
3054** of the Nth column (where 0 is the left-most column) for the
3055** result set of [prepared statement] S as a
3056** zero-terminated UTF-8 string.
3057**
3058** {F13723} A successful invocation of the [sqlite3_column_name16(S,N)]
3059** interface returns the name
3060** of the Nth column (where 0 is the left-most column) for the
3061** result set of [prepared statement] S as a
3062** zero-terminated UTF-16 string in the native byte order.
3063**
3064** {F13724} The [sqlite3_column_name()] and [sqlite3_column_name16()]
3065** interfaces return a NULL pointer if they are unable to
shane26b34032008-05-23 17:21:09 +00003066** allocate memory to hold their normal return strings.
drh33c1be32008-01-30 16:16:14 +00003067**
3068** {F13725} If the N parameter to [sqlite3_column_name(S,N)] or
3069** [sqlite3_column_name16(S,N)] is out of range, then the
shane26b34032008-05-23 17:21:09 +00003070** interfaces return a NULL pointer.
drh33c1be32008-01-30 16:16:14 +00003071**
3072** {F13726} The strings returned by [sqlite3_column_name(S,N)] and
3073** [sqlite3_column_name16(S,N)] are valid until the next
3074** call to either routine with the same S and N parameters
3075** or until [sqlite3_finalize(S)] is called.
3076**
3077** {F13727} When a result column of a [SELECT] statement contains
shane26b34032008-05-23 17:21:09 +00003078** an AS clause, the name of that column is the identifier
drh33c1be32008-01-30 16:16:14 +00003079** to the right of the AS keyword.
danielk197765904932004-05-26 06:18:37 +00003080*/
drh6ed48bf2007-06-14 20:57:18 +00003081const char *sqlite3_column_name(sqlite3_stmt*, int N);
3082const void *sqlite3_column_name16(sqlite3_stmt*, int N);
danielk197765904932004-05-26 06:18:37 +00003083
3084/*
drhfddfa2d2007-12-05 18:05:16 +00003085** CAPI3REF: Source Of Data In A Query Result {F13740}
drh6ed48bf2007-06-14 20:57:18 +00003086**
drh33c1be32008-01-30 16:16:14 +00003087** These routines provide a means to determine what column of what
drh6ed48bf2007-06-14 20:57:18 +00003088** table in which database a result of a SELECT statement comes from.
drh33c1be32008-01-30 16:16:14 +00003089** The name of the database or table or column can be returned as
3090** either a UTF8 or UTF16 string. The _database_ routines return
drhbf2564f2007-06-21 15:25:05 +00003091** the database name, the _table_ routines return the table name, and
drh33c1be32008-01-30 16:16:14 +00003092** the origin_ routines return the column name.
drhbf2564f2007-06-21 15:25:05 +00003093** The returned string is valid until
drh33c1be32008-01-30 16:16:14 +00003094** the [prepared statement] is destroyed using
drh6ed48bf2007-06-14 20:57:18 +00003095** [sqlite3_finalize()] or until the same information is requested
drhbf2564f2007-06-21 15:25:05 +00003096** again in a different encoding.
3097**
drh33c1be32008-01-30 16:16:14 +00003098** The names returned are the original un-aliased names of the
drhbf2564f2007-06-21 15:25:05 +00003099** database, table, and column.
drh6ed48bf2007-06-14 20:57:18 +00003100**
drh33c1be32008-01-30 16:16:14 +00003101** The first argument to the following calls is a [prepared statement].
3102** These functions return information about the Nth column returned by
danielk1977955de522006-02-10 02:27:42 +00003103** the statement, where N is the second function argument.
3104**
drh33c1be32008-01-30 16:16:14 +00003105** If the Nth column returned by the statement is an expression
drh6ed48bf2007-06-14 20:57:18 +00003106** or subquery and is not a column value, then all of these functions
drh33c1be32008-01-30 16:16:14 +00003107** return NULL. These routine might also return NULL if a memory
3108** allocation error occurs. Otherwise, they return the
drh6ed48bf2007-06-14 20:57:18 +00003109** name of the attached database, table and column that query result
3110** column was extracted from.
danielk1977955de522006-02-10 02:27:42 +00003111**
drh33c1be32008-01-30 16:16:14 +00003112** As with all other SQLite APIs, those postfixed with "16" return
drhfddfa2d2007-12-05 18:05:16 +00003113** UTF-16 encoded strings, the other functions return UTF-8. {END}
danielk19774b1ae992006-02-10 03:06:10 +00003114**
3115** These APIs are only available if the library was compiled with the
3116** SQLITE_ENABLE_COLUMN_METADATA preprocessor symbol defined.
drh32bc3f62007-08-21 20:25:39 +00003117**
drhfddfa2d2007-12-05 18:05:16 +00003118** {U13751}
drh32bc3f62007-08-21 20:25:39 +00003119** If two or more threads call one or more of these routines against the same
3120** prepared statement and column at the same time then the results are
3121** undefined.
drh33c1be32008-01-30 16:16:14 +00003122**
3123** INVARIANTS:
3124**
3125** {F13741} The [sqlite3_column_database_name(S,N)] interface returns either
3126** the UTF-8 zero-terminated name of the database from which the
3127** Nth result column of [prepared statement] S
shane26b34032008-05-23 17:21:09 +00003128** is extracted, or NULL if the Nth column of S is a
drh33c1be32008-01-30 16:16:14 +00003129** general expression or if unable to allocate memory
3130** to store the name.
3131**
3132** {F13742} The [sqlite3_column_database_name16(S,N)] interface returns either
3133** the UTF-16 native byte order
3134** zero-terminated name of the database from which the
3135** Nth result column of [prepared statement] S
shane26b34032008-05-23 17:21:09 +00003136** is extracted, or NULL if the Nth column of S is a
drh33c1be32008-01-30 16:16:14 +00003137** general expression or if unable to allocate memory
3138** to store the name.
3139**
3140** {F13743} The [sqlite3_column_table_name(S,N)] interface returns either
3141** the UTF-8 zero-terminated name of the table from which the
3142** Nth result column of [prepared statement] S
shane26b34032008-05-23 17:21:09 +00003143** is extracted, or NULL if the Nth column of S is a
drh33c1be32008-01-30 16:16:14 +00003144** general expression or if unable to allocate memory
3145** to store the name.
3146**
3147** {F13744} The [sqlite3_column_table_name16(S,N)] interface returns either
3148** the UTF-16 native byte order
3149** zero-terminated name of the table from which the
3150** Nth result column of [prepared statement] S
shane26b34032008-05-23 17:21:09 +00003151** is extracted, or NULL if the Nth column of S is a
drh33c1be32008-01-30 16:16:14 +00003152** general expression or if unable to allocate memory
3153** to store the name.
3154**
3155** {F13745} The [sqlite3_column_origin_name(S,N)] interface returns either
3156** the UTF-8 zero-terminated name of the table column from which the
3157** Nth result column of [prepared statement] S
shane26b34032008-05-23 17:21:09 +00003158** is extracted, or NULL if the Nth column of S is a
drh33c1be32008-01-30 16:16:14 +00003159** general expression or if unable to allocate memory
3160** to store the name.
3161**
3162** {F13746} The [sqlite3_column_origin_name16(S,N)] interface returns either
3163** the UTF-16 native byte order
3164** zero-terminated name of the table column from which the
3165** Nth result column of [prepared statement] S
shane26b34032008-05-23 17:21:09 +00003166** is extracted, or NULL if the Nth column of S is a
drh33c1be32008-01-30 16:16:14 +00003167** general expression or if unable to allocate memory
3168** to store the name.
3169**
3170** {F13748} The return values from
3171** [sqlite3_column_database_name|column metadata interfaces]
3172** are valid
3173** for the lifetime of the [prepared statement]
3174** or until the encoding is changed by another metadata
3175** interface call for the same prepared statement and column.
3176**
3177** LIMITATIONS:
3178**
3179** {U13751} If two or more threads call one or more
3180** [sqlite3_column_database_name|column metadata interfaces]
3181** the same [prepared statement] and result column
3182** at the same time then the results are undefined.
danielk1977955de522006-02-10 02:27:42 +00003183*/
3184const char *sqlite3_column_database_name(sqlite3_stmt*,int);
3185const void *sqlite3_column_database_name16(sqlite3_stmt*,int);
3186const char *sqlite3_column_table_name(sqlite3_stmt*,int);
3187const void *sqlite3_column_table_name16(sqlite3_stmt*,int);
3188const char *sqlite3_column_origin_name(sqlite3_stmt*,int);
3189const void *sqlite3_column_origin_name16(sqlite3_stmt*,int);
3190
3191/*
drhfddfa2d2007-12-05 18:05:16 +00003192** CAPI3REF: Declared Datatype Of A Query Result {F13760}
drh6ed48bf2007-06-14 20:57:18 +00003193**
drh33c1be32008-01-30 16:16:14 +00003194** The first parameter is a [prepared statement].
3195** If this statement is a SELECT statement and the Nth column of the
drhf5befa02007-12-06 02:42:07 +00003196** returned result set of that SELECT is a table column (not an
drh6ed48bf2007-06-14 20:57:18 +00003197** expression or subquery) then the declared type of the table
drh33c1be32008-01-30 16:16:14 +00003198** column is returned. If the Nth column of the result set is an
drh6ed48bf2007-06-14 20:57:18 +00003199** expression or subquery, then a NULL pointer is returned.
drh33c1be32008-01-30 16:16:14 +00003200** The returned string is always UTF-8 encoded. {END}
drhfddfa2d2007-12-05 18:05:16 +00003201** For example, in the database schema:
danielk197765904932004-05-26 06:18:37 +00003202**
3203** CREATE TABLE t1(c1 VARIANT);
3204**
3205** And the following statement compiled:
3206**
danielk1977955de522006-02-10 02:27:42 +00003207** SELECT c1 + 1, c1 FROM t1;
danielk197765904932004-05-26 06:18:37 +00003208**
3209** Then this routine would return the string "VARIANT" for the second
3210** result column (i==1), and a NULL pointer for the first result column
3211** (i==0).
drh6ed48bf2007-06-14 20:57:18 +00003212**
3213** SQLite uses dynamic run-time typing. So just because a column
3214** is declared to contain a particular type does not mean that the
3215** data stored in that column is of the declared type. SQLite is
3216** strongly typed, but the typing is dynamic not static. Type
3217** is associated with individual values, not with the containers
3218** used to hold those values.
drh33c1be32008-01-30 16:16:14 +00003219**
3220** INVARIANTS:
3221**
3222** {F13761} A successful call to [sqlite3_column_decltype(S,N)]
3223** returns a zero-terminated UTF-8 string containing the
3224** the declared datatype of the table column that appears
3225** as the Nth column (numbered from 0) of the result set to the
3226** [prepared statement] S.
3227**
3228** {F13762} A successful call to [sqlite3_column_decltype16(S,N)]
3229** returns a zero-terminated UTF-16 native byte order string
3230** containing the declared datatype of the table column that appears
3231** as the Nth column (numbered from 0) of the result set to the
3232** [prepared statement] S.
3233**
3234** {F13763} If N is less than 0 or N is greater than or equal to
3235** the number of columns in [prepared statement] S
3236** or if the Nth column of S is an expression or subquery rather
3237** than a table column or if a memory allocation failure
3238** occurs during encoding conversions, then
3239** calls to [sqlite3_column_decltype(S,N)] or
3240** [sqlite3_column_decltype16(S,N)] return NULL.
danielk197765904932004-05-26 06:18:37 +00003241*/
drh33c1be32008-01-30 16:16:14 +00003242const char *sqlite3_column_decltype(sqlite3_stmt*,int);
danielk197765904932004-05-26 06:18:37 +00003243const void *sqlite3_column_decltype16(sqlite3_stmt*,int);
3244
danielk1977106bb232004-05-21 10:08:53 +00003245/*
drhfddfa2d2007-12-05 18:05:16 +00003246** CAPI3REF: Evaluate An SQL Statement {F13200}
danielk1977106bb232004-05-21 10:08:53 +00003247**
drh33c1be32008-01-30 16:16:14 +00003248** After an [prepared statement] has been prepared with a call
drh6ed48bf2007-06-14 20:57:18 +00003249** to either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or to one of
3250** the legacy interfaces [sqlite3_prepare()] or [sqlite3_prepare16()],
3251** then this function must be called one or more times to evaluate the
3252** statement.
danielk1977106bb232004-05-21 10:08:53 +00003253**
drh6ed48bf2007-06-14 20:57:18 +00003254** The details of the behavior of this sqlite3_step() interface depend
3255** on whether the statement was prepared using the newer "v2" interface
3256** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy
3257** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the
3258** new "v2" interface is recommended for new applications but the legacy
3259** interface will continue to be supported.
danielk1977106bb232004-05-21 10:08:53 +00003260**
drhc3dbded2008-05-12 12:39:55 +00003261** In the legacy interface, the return value will be either [SQLITE_BUSY],
drh6ed48bf2007-06-14 20:57:18 +00003262** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE].
3263** With the "v2" interface, any of the other [SQLITE_OK | result code]
3264** or [SQLITE_IOERR_READ | extended result code] might be returned as
3265** well.
3266**
3267** [SQLITE_BUSY] means that the database engine was unable to acquire the
3268** database locks it needs to do its job. If the statement is a COMMIT
3269** or occurs outside of an explicit transaction, then you can retry the
3270** statement. If the statement is not a COMMIT and occurs within a
3271** explicit transaction then you should rollback the transaction before
3272** continuing.
3273**
3274** [SQLITE_DONE] means that the statement has finished executing
danielk1977106bb232004-05-21 10:08:53 +00003275** successfully. sqlite3_step() should not be called again on this virtual
drh6ed48bf2007-06-14 20:57:18 +00003276** machine without first calling [sqlite3_reset()] to reset the virtual
3277** machine back to its initial state.
danielk1977106bb232004-05-21 10:08:53 +00003278**
3279** If the SQL statement being executed returns any data, then
drh6ed48bf2007-06-14 20:57:18 +00003280** [SQLITE_ROW] is returned each time a new row of data is ready
danielk1977106bb232004-05-21 10:08:53 +00003281** for processing by the caller. The values may be accessed using
drh6ed48bf2007-06-14 20:57:18 +00003282** the [sqlite3_column_int | column access functions].
3283** sqlite3_step() is called again to retrieve the next row of data.
danielk1977106bb232004-05-21 10:08:53 +00003284**
drh6ed48bf2007-06-14 20:57:18 +00003285** [SQLITE_ERROR] means that a run-time error (such as a constraint
danielk1977106bb232004-05-21 10:08:53 +00003286** violation) has occurred. sqlite3_step() should not be called again on
drh6ed48bf2007-06-14 20:57:18 +00003287** the VM. More information may be found by calling [sqlite3_errmsg()].
3288** With the legacy interface, a more specific error code (example:
3289** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth)
3290** can be obtained by calling [sqlite3_reset()] on the
drh33c1be32008-01-30 16:16:14 +00003291** [prepared statement]. In the "v2" interface,
drh6ed48bf2007-06-14 20:57:18 +00003292** the more specific error code is returned directly by sqlite3_step().
danielk1977106bb232004-05-21 10:08:53 +00003293**
drh6ed48bf2007-06-14 20:57:18 +00003294** [SQLITE_MISUSE] means that the this routine was called inappropriately.
drh33c1be32008-01-30 16:16:14 +00003295** Perhaps it was called on a [prepared statement] that has
drh6ed48bf2007-06-14 20:57:18 +00003296** already been [sqlite3_finalize | finalized] or on one that had
3297** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could
3298** be the case that the same database connection is being used by two or
3299** more threads at the same moment in time.
3300**
3301** <b>Goofy Interface Alert:</b>
3302** In the legacy interface,
3303** the sqlite3_step() API always returns a generic error code,
3304** [SQLITE_ERROR], following any error other than [SQLITE_BUSY]
3305** and [SQLITE_MISUSE]. You must call [sqlite3_reset()] or
3306** [sqlite3_finalize()] in order to find one of the specific
drh33c1be32008-01-30 16:16:14 +00003307** [error codes] that better describes the error.
drh6ed48bf2007-06-14 20:57:18 +00003308** We admit that this is a goofy design. The problem has been fixed
3309** with the "v2" interface. If you prepare all of your SQL statements
3310** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead
3311** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()], then the
drh33c1be32008-01-30 16:16:14 +00003312** more specific [error codes] are returned directly
drh6ed48bf2007-06-14 20:57:18 +00003313** by sqlite3_step(). The use of the "v2" interface is recommended.
drh33c1be32008-01-30 16:16:14 +00003314**
3315** INVARIANTS:
3316**
3317** {F13202} If [prepared statement] S is ready to be
3318** run, then [sqlite3_step(S)] advances that prepared statement
3319** until to completion or until it is ready to return another
3320** row of the result set or an interrupt or run-time error occurs.
3321**
3322** {F15304} When a call to [sqlite3_step(S)] causes the
3323** [prepared statement] S to run to completion,
3324** the function returns [SQLITE_DONE].
3325**
3326** {F15306} When a call to [sqlite3_step(S)] stops because it is ready
3327** to return another row of the result set, it returns
3328** [SQLITE_ROW].
3329**
3330** {F15308} If a call to [sqlite3_step(S)] encounters an
3331** [sqlite3_interrupt|interrupt] or a run-time error,
shane26b34032008-05-23 17:21:09 +00003332** it returns an appropriate error code that is not one of
drh33c1be32008-01-30 16:16:14 +00003333** [SQLITE_OK], [SQLITE_ROW], or [SQLITE_DONE].
3334**
3335** {F15310} If an [sqlite3_interrupt|interrupt] or run-time error
3336** occurs during a call to [sqlite3_step(S)]
3337** for a [prepared statement] S created using
3338** legacy interfaces [sqlite3_prepare()] or
3339** [sqlite3_prepare16()] then the function returns either
3340** [SQLITE_ERROR], [SQLITE_BUSY], or [SQLITE_MISUSE].
danielk1977106bb232004-05-21 10:08:53 +00003341*/
danielk197717240fd2004-05-26 00:07:25 +00003342int sqlite3_step(sqlite3_stmt*);
danielk1977106bb232004-05-21 10:08:53 +00003343
danielk1977106bb232004-05-21 10:08:53 +00003344/*
drhfddfa2d2007-12-05 18:05:16 +00003345** CAPI3REF: Number of columns in a result set {F13770}
drh6ed48bf2007-06-14 20:57:18 +00003346**
danielk1977106bb232004-05-21 10:08:53 +00003347** Return the number of values in the current row of the result set.
3348**
drh33c1be32008-01-30 16:16:14 +00003349** INVARIANTS:
3350**
3351** {F13771} After a call to [sqlite3_step(S)] that returns
3352** [SQLITE_ROW], the [sqlite3_data_count(S)] routine
3353** will return the same value as the
3354** [sqlite3_column_count(S)] function.
3355**
3356** {F13772} After [sqlite3_step(S)] has returned any value other than
3357** [SQLITE_ROW] or before [sqlite3_step(S)] has been
3358** called on the [prepared statement] for
3359** the first time since it was [sqlite3_prepare|prepared]
3360** or [sqlite3_reset|reset], the [sqlite3_data_count(S)]
3361** routine returns zero.
danielk1977106bb232004-05-21 10:08:53 +00003362*/
danielk197793d46752004-05-23 13:30:58 +00003363int sqlite3_data_count(sqlite3_stmt *pStmt);
danielk19774adee202004-05-08 08:23:19 +00003364
drh4f26d6c2004-05-26 23:25:30 +00003365/*
drhf5befa02007-12-06 02:42:07 +00003366** CAPI3REF: Fundamental Datatypes {F10265}
drh33c1be32008-01-30 16:16:14 +00003367** KEYWORDS: SQLITE_TEXT
drh6ed48bf2007-06-14 20:57:18 +00003368**
drhf5befa02007-12-06 02:42:07 +00003369** {F10266}Every value in SQLite has one of five fundamental datatypes:
drh6ed48bf2007-06-14 20:57:18 +00003370**
3371** <ul>
3372** <li> 64-bit signed integer
3373** <li> 64-bit IEEE floating point number
3374** <li> string
3375** <li> BLOB
3376** <li> NULL
drhfddfa2d2007-12-05 18:05:16 +00003377** </ul> {END}
drh6ed48bf2007-06-14 20:57:18 +00003378**
3379** These constants are codes for each of those types.
3380**
3381** Note that the SQLITE_TEXT constant was also used in SQLite version 2
3382** for a completely different meaning. Software that links against both
3383** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT not
3384** SQLITE_TEXT.
drh4f26d6c2004-05-26 23:25:30 +00003385*/
drh9c054832004-05-31 18:51:57 +00003386#define SQLITE_INTEGER 1
3387#define SQLITE_FLOAT 2
drh9c054832004-05-31 18:51:57 +00003388#define SQLITE_BLOB 4
3389#define SQLITE_NULL 5
drh1e284f42004-10-06 15:52:01 +00003390#ifdef SQLITE_TEXT
3391# undef SQLITE_TEXT
3392#else
3393# define SQLITE_TEXT 3
3394#endif
3395#define SQLITE3_TEXT 3
3396
3397/*
drhfddfa2d2007-12-05 18:05:16 +00003398** CAPI3REF: Results Values From A Query {F13800}
drh6ed48bf2007-06-14 20:57:18 +00003399**
drh33c1be32008-01-30 16:16:14 +00003400** These routines form the "result set query" interface.
3401**
drh32bc3f62007-08-21 20:25:39 +00003402** These routines return information about
3403** a single column of the current result row of a query. In every
drh6ed48bf2007-06-14 20:57:18 +00003404** case the first argument is a pointer to the
drh33c1be32008-01-30 16:16:14 +00003405** [prepared statement] that is being
drh32bc3f62007-08-21 20:25:39 +00003406** evaluated (the [sqlite3_stmt*] that was returned from
drh6ed48bf2007-06-14 20:57:18 +00003407** [sqlite3_prepare_v2()] or one of its variants) and
drh4f26d6c2004-05-26 23:25:30 +00003408** the second argument is the index of the column for which information
drh32bc3f62007-08-21 20:25:39 +00003409** should be returned. The left-most column of the result set
3410** has an index of 0.
danielk1977106bb232004-05-21 10:08:53 +00003411**
drh4f26d6c2004-05-26 23:25:30 +00003412** If the SQL statement is not currently point to a valid row, or if the
drh32bc3f62007-08-21 20:25:39 +00003413** the column index is out of range, the result is undefined.
3414** These routines may only be called when the most recent call to
3415** [sqlite3_step()] has returned [SQLITE_ROW] and neither
3416** [sqlite3_reset()] nor [sqlite3_finalize()] has been call subsequently.
3417** If any of these routines are called after [sqlite3_reset()] or
3418** [sqlite3_finalize()] or after [sqlite3_step()] has returned
3419** something other than [SQLITE_ROW], the results are undefined.
3420** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()]
3421** are called from a different thread while any of these routines
3422** are pending, then the results are undefined.
drh6ed48bf2007-06-14 20:57:18 +00003423**
3424** The sqlite3_column_type() routine returns
3425** [SQLITE_INTEGER | datatype code] for the initial data type
3426** of the result column. The returned value is one of [SQLITE_INTEGER],
3427** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value
3428** returned by sqlite3_column_type() is only meaningful if no type
3429** conversions have occurred as described below. After a type conversion,
3430** the value returned by sqlite3_column_type() is undefined. Future
3431** versions of SQLite may change the behavior of sqlite3_column_type()
3432** following a type conversion.
3433**
drh6ed48bf2007-06-14 20:57:18 +00003434** If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes()
3435** routine returns the number of bytes in that BLOB or string.
3436** If the result is a UTF-16 string, then sqlite3_column_bytes() converts
3437** the string to UTF-8 and then returns the number of bytes.
3438** If the result is a numeric value then sqlite3_column_bytes() uses
3439** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns
3440** the number of bytes in that string.
3441** The value returned does not include the zero terminator at the end
3442** of the string. For clarity: the value returned is the number of
3443** bytes in the string, not the number of characters.
3444**
drhc0b3abb2007-09-04 12:18:41 +00003445** Strings returned by sqlite3_column_text() and sqlite3_column_text16(),
drh33c1be32008-01-30 16:16:14 +00003446** even empty strings, are always zero terminated. The return
drhc0b3abb2007-09-04 12:18:41 +00003447** value from sqlite3_column_blob() for a zero-length blob is an arbitrary
3448** pointer, possibly even a NULL pointer.
3449**
drh6ed48bf2007-06-14 20:57:18 +00003450** The sqlite3_column_bytes16() routine is similar to sqlite3_column_bytes()
drh33c1be32008-01-30 16:16:14 +00003451** but leaves the result in UTF-16 in native byte order instead of UTF-8.
drh6ed48bf2007-06-14 20:57:18 +00003452** The zero terminator is not included in this count.
drh4f26d6c2004-05-26 23:25:30 +00003453**
drhaa28e142008-03-18 13:47:20 +00003454** The object returned by [sqlite3_column_value()] is an
3455** [unprotected sqlite3_value] object. An unprotected sqlite3_value object
3456** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()].
3457** If the [unprotected sqlite3_value] object returned by
3458** [sqlite3_column_value()] is used in any other way, including calls
3459** to routines like
3460** [sqlite3_value_int()], [sqlite3_value_text()], or [sqlite3_value_bytes()],
3461** then the behavior is undefined.
3462**
drh4f26d6c2004-05-26 23:25:30 +00003463** These routines attempt to convert the value where appropriate. For
3464** example, if the internal representation is FLOAT and a text result
drh6ed48bf2007-06-14 20:57:18 +00003465** is requested, [sqlite3_snprintf()] is used internally to do the conversion
drh4f26d6c2004-05-26 23:25:30 +00003466** automatically. The following table details the conversions that
3467** are applied:
3468**
drh6ed48bf2007-06-14 20:57:18 +00003469** <blockquote>
3470** <table border="1">
drh8bacf972007-08-25 16:21:29 +00003471** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion
drh4f26d6c2004-05-26 23:25:30 +00003472**
drh6ed48bf2007-06-14 20:57:18 +00003473** <tr><td> NULL <td> INTEGER <td> Result is 0
3474** <tr><td> NULL <td> FLOAT <td> Result is 0.0
3475** <tr><td> NULL <td> TEXT <td> Result is NULL pointer
3476** <tr><td> NULL <td> BLOB <td> Result is NULL pointer
3477** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float
3478** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer
3479** <tr><td> INTEGER <td> BLOB <td> Same as for INTEGER->TEXT
3480** <tr><td> FLOAT <td> INTEGER <td> Convert from float to integer
3481** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float
3482** <tr><td> FLOAT <td> BLOB <td> Same as FLOAT->TEXT
3483** <tr><td> TEXT <td> INTEGER <td> Use atoi()
3484** <tr><td> TEXT <td> FLOAT <td> Use atof()
3485** <tr><td> TEXT <td> BLOB <td> No change
3486** <tr><td> BLOB <td> INTEGER <td> Convert to TEXT then use atoi()
3487** <tr><td> BLOB <td> FLOAT <td> Convert to TEXT then use atof()
3488** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed
3489** </table>
3490** </blockquote>
drh4f26d6c2004-05-26 23:25:30 +00003491**
drh6ed48bf2007-06-14 20:57:18 +00003492** The table above makes reference to standard C library functions atoi()
3493** and atof(). SQLite does not really use these functions. It has its
shane26b34032008-05-23 17:21:09 +00003494** own equivalent internal routines. The atoi() and atof() names are
drh6ed48bf2007-06-14 20:57:18 +00003495** used in the table for brevity and because they are familiar to most
3496** C programmers.
3497**
3498** Note that when type conversions occur, pointers returned by prior
3499** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or
3500** sqlite3_column_text16() may be invalidated.
3501** Type conversions and pointer invalidations might occur
3502** in the following cases:
3503**
3504** <ul>
3505** <li><p> The initial content is a BLOB and sqlite3_column_text()
3506** or sqlite3_column_text16() is called. A zero-terminator might
3507** need to be added to the string.</p></li>
3508**
3509** <li><p> The initial content is UTF-8 text and sqlite3_column_bytes16() or
3510** sqlite3_column_text16() is called. The content must be converted
3511** to UTF-16.</p></li>
3512**
3513** <li><p> The initial content is UTF-16 text and sqlite3_column_bytes() or
3514** sqlite3_column_text() is called. The content must be converted
3515** to UTF-8.</p></li>
3516** </ul>
3517**
3518** Conversions between UTF-16be and UTF-16le are always done in place and do
3519** not invalidate a prior pointer, though of course the content of the buffer
3520** that the prior pointer points to will have been modified. Other kinds
3521** of conversion are done in place when it is possible, but sometime it is
3522** not possible and in those cases prior pointers are invalidated.
3523**
3524** The safest and easiest to remember policy is to invoke these routines
3525** in one of the following ways:
3526**
3527** <ul>
3528** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li>
3529** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li>
3530** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li>
3531** </ul>
3532**
3533** In other words, you should call sqlite3_column_text(), sqlite3_column_blob(),
3534** or sqlite3_column_text16() first to force the result into the desired
3535** format, then invoke sqlite3_column_bytes() or sqlite3_column_bytes16() to
3536** find the size of the result. Do not mix call to sqlite3_column_text() or
3537** sqlite3_column_blob() with calls to sqlite3_column_bytes16(). And do not
3538** mix calls to sqlite3_column_text16() with calls to sqlite3_column_bytes().
drh32bc3f62007-08-21 20:25:39 +00003539**
3540** The pointers returned are valid until a type conversion occurs as
3541** described above, or until [sqlite3_step()] or [sqlite3_reset()] or
3542** [sqlite3_finalize()] is called. The memory space used to hold strings
3543** and blobs is freed automatically. Do <b>not</b> pass the pointers returned
drh79491ab2007-09-04 12:00:00 +00003544** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into
drh32bc3f62007-08-21 20:25:39 +00003545** [sqlite3_free()].
drh4a50aac2007-08-23 02:47:53 +00003546**
3547** If a memory allocation error occurs during the evaluation of any
3548** of these routines, a default value is returned. The default value
3549** is either the integer 0, the floating point number 0.0, or a NULL
3550** pointer. Subsequent calls to [sqlite3_errcode()] will return
3551** [SQLITE_NOMEM].
drh21ac7f92008-01-31 12:26:49 +00003552**
3553** INVARIANTS:
3554**
3555** {F13803} The [sqlite3_column_blob(S,N)] interface converts the
3556** Nth column in the current row of the result set for
drh414025d2008-01-31 16:36:40 +00003557** [prepared statement] S into a blob and then returns a
drh21ac7f92008-01-31 12:26:49 +00003558** pointer to the converted value.
3559**
3560** {F13806} The [sqlite3_column_bytes(S,N)] interface returns the
3561** number of bytes in the blob or string (exclusive of the
3562** zero terminator on the string) that was returned by the
3563** most recent call to [sqlite3_column_blob(S,N)] or
3564** [sqlite3_column_text(S,N)].
3565**
3566** {F13809} The [sqlite3_column_bytes16(S,N)] interface returns the
3567** number of bytes in the string (exclusive of the
3568** zero terminator on the string) that was returned by the
3569** most recent call to [sqlite3_column_text16(S,N)].
3570**
3571** {F13812} The [sqlite3_column_double(S,N)] interface converts the
3572** Nth column in the current row of the result set for
drh414025d2008-01-31 16:36:40 +00003573** [prepared statement] S into a floating point value and
drh21ac7f92008-01-31 12:26:49 +00003574** returns a copy of that value.
3575**
3576** {F13815} The [sqlite3_column_int(S,N)] interface converts the
3577** Nth column in the current row of the result set for
drhafc91042008-02-21 02:09:45 +00003578** [prepared statement] S into a 64-bit signed integer and
3579** returns the lower 32 bits of that integer.
drh21ac7f92008-01-31 12:26:49 +00003580**
3581** {F13818} The [sqlite3_column_int64(S,N)] interface converts the
3582** Nth column in the current row of the result set for
drh414025d2008-01-31 16:36:40 +00003583** [prepared statement] S into a 64-bit signed integer and
drh21ac7f92008-01-31 12:26:49 +00003584** returns a copy of that integer.
3585**
3586** {F13821} The [sqlite3_column_text(S,N)] interface converts the
3587** Nth column in the current row of the result set for
drh414025d2008-01-31 16:36:40 +00003588** [prepared statement] S into a zero-terminated UTF-8
drh21ac7f92008-01-31 12:26:49 +00003589** string and returns a pointer to that string.
3590**
3591** {F13824} The [sqlite3_column_text16(S,N)] interface converts the
3592** Nth column in the current row of the result set for
drh414025d2008-01-31 16:36:40 +00003593** [prepared statement] S into a zero-terminated 2-byte
drh21ac7f92008-01-31 12:26:49 +00003594** aligned UTF-16 native byte order
3595** string and returns a pointer to that string.
3596**
3597** {F13827} The [sqlite3_column_type(S,N)] interface returns
drh414025d2008-01-31 16:36:40 +00003598** one of [SQLITE_NULL], [SQLITE_INTEGER], [SQLITE_FLOAT],
drh21ac7f92008-01-31 12:26:49 +00003599** [SQLITE_TEXT], or [SQLITE_BLOB] as appropriate for
3600** the Nth column in the current row of the result set for
drh414025d2008-01-31 16:36:40 +00003601** [prepared statement] S.
drh21ac7f92008-01-31 12:26:49 +00003602**
3603** {F13830} The [sqlite3_column_value(S,N)] interface returns a
drhaa28e142008-03-18 13:47:20 +00003604** pointer to an [unprotected sqlite3_value] object for the
drh21ac7f92008-01-31 12:26:49 +00003605** Nth column in the current row of the result set for
drh414025d2008-01-31 16:36:40 +00003606** [prepared statement] S.
danielk1977106bb232004-05-21 10:08:53 +00003607*/
drhf4479502004-05-27 03:12:53 +00003608const void *sqlite3_column_blob(sqlite3_stmt*, int iCol);
3609int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
3610int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
3611double sqlite3_column_double(sqlite3_stmt*, int iCol);
3612int sqlite3_column_int(sqlite3_stmt*, int iCol);
drh6d2069d2007-08-14 01:58:53 +00003613sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol);
drhf4479502004-05-27 03:12:53 +00003614const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol);
3615const void *sqlite3_column_text16(sqlite3_stmt*, int iCol);
drh4f26d6c2004-05-26 23:25:30 +00003616int sqlite3_column_type(sqlite3_stmt*, int iCol);
drh4be8b512006-06-13 23:51:34 +00003617sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol);
danielk19774adee202004-05-08 08:23:19 +00003618
danielk197765904932004-05-26 06:18:37 +00003619/*
drhfddfa2d2007-12-05 18:05:16 +00003620** CAPI3REF: Destroy A Prepared Statement Object {F13300}
drh6ed48bf2007-06-14 20:57:18 +00003621**
3622** The sqlite3_finalize() function is called to delete a
drh33c1be32008-01-30 16:16:14 +00003623** [prepared statement]. If the statement was
drh6ed48bf2007-06-14 20:57:18 +00003624** executed successfully, or not executed at all, then SQLITE_OK is returned.
3625** If execution of the statement failed then an
drh33c1be32008-01-30 16:16:14 +00003626** [error code] or [extended error code]
drh6ed48bf2007-06-14 20:57:18 +00003627** is returned.
danielk197765904932004-05-26 06:18:37 +00003628**
3629** This routine can be called at any point during the execution of the
drh33c1be32008-01-30 16:16:14 +00003630** [prepared statement]. If the virtual machine has not
drh6ed48bf2007-06-14 20:57:18 +00003631** completed execution when this routine is called, that is like
3632** encountering an error or an interrupt. (See [sqlite3_interrupt()].)
shane236ce972008-05-30 15:35:30 +00003633** Incomplete updates may be rolled back and transactions canceled,
drh6ed48bf2007-06-14 20:57:18 +00003634** depending on the circumstances, and the
drh33c1be32008-01-30 16:16:14 +00003635** [error code] returned will be [SQLITE_ABORT].
3636**
3637** INVARIANTS:
3638**
3639** {F11302} The [sqlite3_finalize(S)] interface destroys the
3640** [prepared statement] S and releases all
3641** memory and file resources held by that object.
3642**
3643** {F11304} If the most recent call to [sqlite3_step(S)] for the
3644** [prepared statement] S returned an error,
3645** then [sqlite3_finalize(S)] returns that same error.
danielk197765904932004-05-26 06:18:37 +00003646*/
3647int sqlite3_finalize(sqlite3_stmt *pStmt);
3648
3649/*
drhfddfa2d2007-12-05 18:05:16 +00003650** CAPI3REF: Reset A Prepared Statement Object {F13330}
drh6ed48bf2007-06-14 20:57:18 +00003651**
3652** The sqlite3_reset() function is called to reset a
drh33c1be32008-01-30 16:16:14 +00003653** [prepared statement] object.
drh85b623f2007-12-13 21:54:09 +00003654** back to its initial state, ready to be re-executed.
danielk197765904932004-05-26 06:18:37 +00003655** Any SQL statement variables that had values bound to them using
drh6ed48bf2007-06-14 20:57:18 +00003656** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values.
3657** Use [sqlite3_clear_bindings()] to reset the bindings.
drh33c1be32008-01-30 16:16:14 +00003658**
3659** {F11332} The [sqlite3_reset(S)] interface resets the [prepared statement] S
3660** back to the beginning of its program.
3661**
3662** {F11334} If the most recent call to [sqlite3_step(S)] for
3663** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE],
3664** or if [sqlite3_step(S)] has never before been called on S,
3665** then [sqlite3_reset(S)] returns [SQLITE_OK].
3666**
3667** {F11336} If the most recent call to [sqlite3_step(S)] for
3668** [prepared statement] S indicated an error, then
3669** [sqlite3_reset(S)] returns an appropriate [error code].
3670**
3671** {F11338} The [sqlite3_reset(S)] interface does not change the values
3672** of any [sqlite3_bind_blob|bindings] on [prepared statement] S.
danielk197765904932004-05-26 06:18:37 +00003673*/
3674int sqlite3_reset(sqlite3_stmt *pStmt);
3675
3676/*
drhfddfa2d2007-12-05 18:05:16 +00003677** CAPI3REF: Create Or Redefine SQL Functions {F16100}
drh21ac7f92008-01-31 12:26:49 +00003678** KEYWORDS: {function creation routines}
drh6ed48bf2007-06-14 20:57:18 +00003679**
drh21ac7f92008-01-31 12:26:49 +00003680** These two functions (collectively known as
3681** "function creation routines") are used to add SQL functions or aggregates
drh6ed48bf2007-06-14 20:57:18 +00003682** or to redefine the behavior of existing SQL functions or aggregates. The
danielk197765904932004-05-26 06:18:37 +00003683** difference only between the two is that the second parameter, the
3684** name of the (scalar) function or aggregate, is encoded in UTF-8 for
3685** sqlite3_create_function() and UTF-16 for sqlite3_create_function16().
3686**
drh1c3cfc62008-03-08 12:37:30 +00003687** The first parameter is the [database connection] to which the SQL
3688** function is to be added. If a single
3689** program uses more than one [database connection] internally, then SQL
3690** functions must be added individually to each [database connection].
danielk197765904932004-05-26 06:18:37 +00003691**
drh6ed48bf2007-06-14 20:57:18 +00003692** The second parameter is the name of the SQL function to be created
3693** or redefined.
3694** The length of the name is limited to 255 bytes, exclusive of the
3695** zero-terminator. Note that the name length limit is in bytes, not
3696** characters. Any attempt to create a function with a longer name
3697** will result in an SQLITE_ERROR error.
3698**
3699** The third parameter is the number of arguments that the SQL function or
3700** aggregate takes. If this parameter is negative, then the SQL function or
danielk197765904932004-05-26 06:18:37 +00003701** aggregate may take any number of arguments.
3702**
drh6ed48bf2007-06-14 20:57:18 +00003703** The fourth parameter, eTextRep, specifies what
3704** [SQLITE_UTF8 | text encoding] this SQL function prefers for
3705** its parameters. Any SQL function implementation should be able to work
3706** work with UTF-8, UTF-16le, or UTF-16be. But some implementations may be
3707** more efficient with one encoding than another. It is allowed to
drh6d2069d2007-08-14 01:58:53 +00003708** invoke sqlite3_create_function() or sqlite3_create_function16() multiple
drh6ed48bf2007-06-14 20:57:18 +00003709** times with the same function but with different values of eTextRep.
3710** When multiple implementations of the same function are available, SQLite
3711** will pick the one that involves the least amount of data conversion.
3712** If there is only a single implementation which does not care what
3713** text encoding is used, then the fourth argument should be
3714** [SQLITE_ANY].
3715**
3716** The fifth parameter is an arbitrary pointer. The implementation
3717** of the function can gain access to this pointer using
drh6d2069d2007-08-14 01:58:53 +00003718** [sqlite3_user_data()].
danielk1977d02eb1f2004-06-06 09:44:03 +00003719**
danielk197765904932004-05-26 06:18:37 +00003720** The seventh, eighth and ninth parameters, xFunc, xStep and xFinal, are
drh6ed48bf2007-06-14 20:57:18 +00003721** pointers to C-language functions that implement the SQL
3722** function or aggregate. A scalar SQL function requires an implementation of
danielk197765904932004-05-26 06:18:37 +00003723** the xFunc callback only, NULL pointers should be passed as the xStep
drh6ed48bf2007-06-14 20:57:18 +00003724** and xFinal parameters. An aggregate SQL function requires an implementation
3725** of xStep and xFinal and NULL should be passed for xFunc. To delete an
3726** existing SQL function or aggregate, pass NULL for all three function
shane26b34032008-05-23 17:21:09 +00003727** callbacks.
drh6ed48bf2007-06-14 20:57:18 +00003728**
3729** It is permitted to register multiple implementations of the same
3730** functions with the same name but with either differing numbers of
shane26b34032008-05-23 17:21:09 +00003731** arguments or differing preferred text encodings. SQLite will use
drh6ed48bf2007-06-14 20:57:18 +00003732** the implementation most closely matches the way in which the
3733** SQL function is used.
drh21ac7f92008-01-31 12:26:49 +00003734**
3735** INVARIANTS:
3736**
3737** {F16103} The [sqlite3_create_function16()] interface behaves exactly
3738** like [sqlite3_create_function()] in every way except that it
3739** interprets the zFunctionName argument as
3740** zero-terminated UTF-16 native byte order instead of as a
3741** zero-terminated UTF-8.
3742**
drhafc91042008-02-21 02:09:45 +00003743** {F16106} A successful invocation of
3744** the [sqlite3_create_function(D,X,N,E,...)] interface registers
3745** or replaces callback functions in [database connection] D
3746** used to implement the SQL function named X with N parameters
shane26b34032008-05-23 17:21:09 +00003747** and having a preferred text encoding of E.
drhafc91042008-02-21 02:09:45 +00003748**
3749** {F16109} A successful call to [sqlite3_create_function(D,X,N,E,P,F,S,L)]
3750** replaces the P, F, S, and L values from any prior calls with
3751** the same D, X, N, and E values.
3752**
3753** {F16112} The [sqlite3_create_function(D,X,...)] interface fails with
3754** a return code of [SQLITE_ERROR] if the SQL function name X is
3755** longer than 255 bytes exclusive of the zero terminator.
3756**
3757** {F16118} Either F must be NULL and S and L are non-NULL or else F
3758** is non-NULL and S and L are NULL, otherwise
3759** [sqlite3_create_function(D,X,N,E,P,F,S,L)] returns [SQLITE_ERROR].
3760**
3761** {F16121} The [sqlite3_create_function(D,...)] interface fails with an
3762** error code of [SQLITE_BUSY] if there exist [prepared statements]
3763** associated with the [database connection] D.
3764**
3765** {F16124} The [sqlite3_create_function(D,X,N,...)] interface fails with an
3766** error code of [SQLITE_ERROR] if parameter N (specifying the number
3767** of arguments to the SQL function being registered) is less
3768** than -1 or greater than 127.
3769**
3770** {F16127} When N is non-negative, the [sqlite3_create_function(D,X,N,...)]
3771** interface causes callbacks to be invoked for the SQL function
3772** named X when the number of arguments to the SQL function is
3773** exactly N.
3774**
3775** {F16130} When N is -1, the [sqlite3_create_function(D,X,N,...)]
3776** interface causes callbacks to be invoked for the SQL function
3777** named X with any number of arguments.
3778**
3779** {F16133} When calls to [sqlite3_create_function(D,X,N,...)]
3780** specify multiple implementations of the same function X
3781** and when one implementation has N>=0 and the other has N=(-1)
3782** the implementation with a non-zero N is preferred.
3783**
3784** {F16136} When calls to [sqlite3_create_function(D,X,N,E,...)]
3785** specify multiple implementations of the same function X with
3786** the same number of arguments N but with different
3787** encodings E, then the implementation where E matches the
3788** database encoding is preferred.
3789**
3790** {F16139} For an aggregate SQL function created using
3791** [sqlite3_create_function(D,X,N,E,P,0,S,L)] the finializer
3792** function L will always be invoked exactly once if the
3793** step function S is called one or more times.
drhaa28e142008-03-18 13:47:20 +00003794**
3795** {F16142} When SQLite invokes either the xFunc or xStep function of
3796** an application-defined SQL function or aggregate created
3797** by [sqlite3_create_function()] or [sqlite3_create_function16()],
3798** then the array of [sqlite3_value] objects passed as the
3799** third parameter are always [protected sqlite3_value] objects.
danielk197765904932004-05-26 06:18:37 +00003800*/
3801int sqlite3_create_function(
drh33c1be32008-01-30 16:16:14 +00003802 sqlite3 *db,
danielk197765904932004-05-26 06:18:37 +00003803 const char *zFunctionName,
3804 int nArg,
3805 int eTextRep,
drh33c1be32008-01-30 16:16:14 +00003806 void *pApp,
danielk197765904932004-05-26 06:18:37 +00003807 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
3808 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
3809 void (*xFinal)(sqlite3_context*)
3810);
3811int sqlite3_create_function16(
drh33c1be32008-01-30 16:16:14 +00003812 sqlite3 *db,
danielk197765904932004-05-26 06:18:37 +00003813 const void *zFunctionName,
3814 int nArg,
3815 int eTextRep,
drh33c1be32008-01-30 16:16:14 +00003816 void *pApp,
danielk197765904932004-05-26 06:18:37 +00003817 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
3818 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
3819 void (*xFinal)(sqlite3_context*)
3820);
3821
3822/*
drhf5befa02007-12-06 02:42:07 +00003823** CAPI3REF: Text Encodings {F10267}
drh6ed48bf2007-06-14 20:57:18 +00003824**
3825** These constant define integer codes that represent the various
3826** text encodings supported by SQLite.
danielk197765904932004-05-26 06:18:37 +00003827*/
drh6ed48bf2007-06-14 20:57:18 +00003828#define SQLITE_UTF8 1
3829#define SQLITE_UTF16LE 2
3830#define SQLITE_UTF16BE 3
3831#define SQLITE_UTF16 4 /* Use native byte order */
3832#define SQLITE_ANY 5 /* sqlite3_create_function only */
3833#define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */
danielk197765904932004-05-26 06:18:37 +00003834
danielk19770ffba6b2004-05-24 09:10:10 +00003835/*
drh6ed48bf2007-06-14 20:57:18 +00003836** CAPI3REF: Obsolete Functions
3837**
3838** These functions are all now obsolete. In order to maintain
3839** backwards compatibility with older code, we continue to support
3840** these functions. However, new development projects should avoid
3841** the use of these functions. To help encourage people to avoid
3842** using these functions, we are not going to tell you want they do.
3843*/
3844int sqlite3_aggregate_count(sqlite3_context*);
3845int sqlite3_expired(sqlite3_stmt*);
3846int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*);
3847int sqlite3_global_recover(void);
drhe30f4422007-08-21 16:15:55 +00003848void sqlite3_thread_cleanup(void);
drhd64621d2007-11-05 17:54:17 +00003849int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),void*,sqlite3_int64);
drh6ed48bf2007-06-14 20:57:18 +00003850
3851/*
drhfddfa2d2007-12-05 18:05:16 +00003852** CAPI3REF: Obtaining SQL Function Parameter Values {F15100}
drh6ed48bf2007-06-14 20:57:18 +00003853**
3854** The C-language implementation of SQL functions and aggregates uses
3855** this set of interface routines to access the parameter values on
3856** the function or aggregate.
3857**
3858** The xFunc (for scalar functions) or xStep (for aggregates) parameters
3859** to [sqlite3_create_function()] and [sqlite3_create_function16()]
3860** define callbacks that implement the SQL functions and aggregates.
3861** The 4th parameter to these callbacks is an array of pointers to
drhaa28e142008-03-18 13:47:20 +00003862** [protected sqlite3_value] objects. There is one [sqlite3_value] object for
drh6ed48bf2007-06-14 20:57:18 +00003863** each parameter to the SQL function. These routines are used to
3864** extract values from the [sqlite3_value] objects.
3865**
drhaa28e142008-03-18 13:47:20 +00003866** These routines work only with [protected sqlite3_value] objects.
3867** Any attempt to use these routines on an [unprotected sqlite3_value]
3868** object results in undefined behavior.
3869**
drh6ed48bf2007-06-14 20:57:18 +00003870** These routines work just like the corresponding
3871** [sqlite3_column_blob | sqlite3_column_* routines] except that
drhaa28e142008-03-18 13:47:20 +00003872** these routines take a single [protected sqlite3_value] object pointer
shane26b34032008-05-23 17:21:09 +00003873** instead of a [sqlite3_stmt*] pointer and an integer column number.
drh6ed48bf2007-06-14 20:57:18 +00003874**
3875** The sqlite3_value_text16() interface extracts a UTF16 string
3876** in the native byte-order of the host machine. The
3877** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces
3878** extract UTF16 strings as big-endian and little-endian respectively.
3879**
3880** The sqlite3_value_numeric_type() interface attempts to apply
3881** numeric affinity to the value. This means that an attempt is
3882** made to convert the value to an integer or floating point. If
drhf5befa02007-12-06 02:42:07 +00003883** such a conversion is possible without loss of information (in other
3884** words if the value is a string that looks like a number)
3885** then the conversion is done. Otherwise no conversion occurs. The
drh6ed48bf2007-06-14 20:57:18 +00003886** [SQLITE_INTEGER | datatype] after conversion is returned.
3887**
3888** Please pay particular attention to the fact that the pointer that
3889** is returned from [sqlite3_value_blob()], [sqlite3_value_text()], or
3890** [sqlite3_value_text16()] can be invalidated by a subsequent call to
drh6d2069d2007-08-14 01:58:53 +00003891** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()],
drh6ed48bf2007-06-14 20:57:18 +00003892** or [sqlite3_value_text16()].
drhe53831d2007-08-17 01:14:38 +00003893**
3894** These routines must be called from the same thread as
drhaa28e142008-03-18 13:47:20 +00003895** the SQL function that supplied the [sqlite3_value*] parameters.
drhf5befa02007-12-06 02:42:07 +00003896**
drhafc91042008-02-21 02:09:45 +00003897**
3898** INVARIANTS:
3899**
3900** {F15103} The [sqlite3_value_blob(V)] interface converts the
drhaa28e142008-03-18 13:47:20 +00003901** [protected sqlite3_value] object V into a blob and then returns a
drhafc91042008-02-21 02:09:45 +00003902** pointer to the converted value.
3903**
3904** {F15106} The [sqlite3_value_bytes(V)] interface returns the
3905** number of bytes in the blob or string (exclusive of the
3906** zero terminator on the string) that was returned by the
3907** most recent call to [sqlite3_value_blob(V)] or
3908** [sqlite3_value_text(V)].
3909**
3910** {F15109} The [sqlite3_value_bytes16(V)] interface returns the
3911** number of bytes in the string (exclusive of the
3912** zero terminator on the string) that was returned by the
3913** most recent call to [sqlite3_value_text16(V)],
3914** [sqlite3_value_text16be(V)], or [sqlite3_value_text16le(V)].
3915**
3916** {F15112} The [sqlite3_value_double(V)] interface converts the
drhaa28e142008-03-18 13:47:20 +00003917** [protected sqlite3_value] object V into a floating point value and
drhafc91042008-02-21 02:09:45 +00003918** returns a copy of that value.
3919**
3920** {F15115} The [sqlite3_value_int(V)] interface converts the
drhaa28e142008-03-18 13:47:20 +00003921** [protected sqlite3_value] object V into a 64-bit signed integer and
drhafc91042008-02-21 02:09:45 +00003922** returns the lower 32 bits of that integer.
3923**
3924** {F15118} The [sqlite3_value_int64(V)] interface converts the
drhaa28e142008-03-18 13:47:20 +00003925** [protected sqlite3_value] object V into a 64-bit signed integer and
drhafc91042008-02-21 02:09:45 +00003926** returns a copy of that integer.
3927**
3928** {F15121} The [sqlite3_value_text(V)] interface converts the
drhaa28e142008-03-18 13:47:20 +00003929** [protected sqlite3_value] object V into a zero-terminated UTF-8
drhafc91042008-02-21 02:09:45 +00003930** string and returns a pointer to that string.
3931**
3932** {F15124} The [sqlite3_value_text16(V)] interface converts the
drhaa28e142008-03-18 13:47:20 +00003933** [protected sqlite3_value] object V into a zero-terminated 2-byte
drhafc91042008-02-21 02:09:45 +00003934** aligned UTF-16 native byte order
3935** string and returns a pointer to that string.
3936**
3937** {F15127} The [sqlite3_value_text16be(V)] interface converts the
drhaa28e142008-03-18 13:47:20 +00003938** [protected sqlite3_value] object V into a zero-terminated 2-byte
drhafc91042008-02-21 02:09:45 +00003939** aligned UTF-16 big-endian
3940** string and returns a pointer to that string.
3941**
3942** {F15130} The [sqlite3_value_text16le(V)] interface converts the
drhaa28e142008-03-18 13:47:20 +00003943** [protected sqlite3_value] object V into a zero-terminated 2-byte
drhafc91042008-02-21 02:09:45 +00003944** aligned UTF-16 little-endian
3945** string and returns a pointer to that string.
3946**
3947** {F15133} The [sqlite3_value_type(V)] interface returns
3948** one of [SQLITE_NULL], [SQLITE_INTEGER], [SQLITE_FLOAT],
3949** [SQLITE_TEXT], or [SQLITE_BLOB] as appropriate for
3950** the [sqlite3_value] object V.
3951**
3952** {F15136} The [sqlite3_value_numeric_type(V)] interface converts
drhaa28e142008-03-18 13:47:20 +00003953** the [protected sqlite3_value] object V into either an integer or
drhafc91042008-02-21 02:09:45 +00003954** a floating point value if it can do so without loss of
3955** information, and returns one of [SQLITE_NULL],
3956** [SQLITE_INTEGER], [SQLITE_FLOAT], [SQLITE_TEXT], or
3957** [SQLITE_BLOB] as appropriate for
drhaa28e142008-03-18 13:47:20 +00003958** the [protected sqlite3_value] object V after the conversion attempt.
danielk19770ffba6b2004-05-24 09:10:10 +00003959*/
drhf4479502004-05-27 03:12:53 +00003960const void *sqlite3_value_blob(sqlite3_value*);
3961int sqlite3_value_bytes(sqlite3_value*);
3962int sqlite3_value_bytes16(sqlite3_value*);
3963double sqlite3_value_double(sqlite3_value*);
3964int sqlite3_value_int(sqlite3_value*);
drh6d2069d2007-08-14 01:58:53 +00003965sqlite3_int64 sqlite3_value_int64(sqlite3_value*);
drhf4479502004-05-27 03:12:53 +00003966const unsigned char *sqlite3_value_text(sqlite3_value*);
3967const void *sqlite3_value_text16(sqlite3_value*);
danielk1977d8123362004-06-12 09:25:12 +00003968const void *sqlite3_value_text16le(sqlite3_value*);
3969const void *sqlite3_value_text16be(sqlite3_value*);
danielk197793d46752004-05-23 13:30:58 +00003970int sqlite3_value_type(sqlite3_value*);
drh29d72102006-02-09 22:13:41 +00003971int sqlite3_value_numeric_type(sqlite3_value*);
danielk19770ffba6b2004-05-24 09:10:10 +00003972
3973/*
drhfddfa2d2007-12-05 18:05:16 +00003974** CAPI3REF: Obtain Aggregate Function Context {F16210}
drh6ed48bf2007-06-14 20:57:18 +00003975**
3976** The implementation of aggregate SQL functions use this routine to allocate
drhf5befa02007-12-06 02:42:07 +00003977** a structure for storing their state.
drhafc91042008-02-21 02:09:45 +00003978** The first time the sqlite3_aggregate_context() routine is
drhf5befa02007-12-06 02:42:07 +00003979** is called for a particular aggregate, SQLite allocates nBytes of memory
3980** zeros that memory, and returns a pointer to it.
drhafc91042008-02-21 02:09:45 +00003981** On second and subsequent calls to sqlite3_aggregate_context()
3982** for the same aggregate function index, the same buffer is returned.
drhf5befa02007-12-06 02:42:07 +00003983** The implementation
danielk19770ae8b832004-05-25 12:05:56 +00003984** of the aggregate can use the returned buffer to accumulate data.
3985**
drhafc91042008-02-21 02:09:45 +00003986** SQLite automatically frees the allocated buffer when the aggregate
3987** query concludes.
drh6ed48bf2007-06-14 20:57:18 +00003988**
3989** The first parameter should be a copy of the
3990** [sqlite3_context | SQL function context] that is the first
3991** parameter to the callback routine that implements the aggregate
3992** function.
drhe53831d2007-08-17 01:14:38 +00003993**
3994** This routine must be called from the same thread in which
drh605264d2007-08-21 15:13:19 +00003995** the aggregate SQL function is running.
drhafc91042008-02-21 02:09:45 +00003996**
3997** INVARIANTS:
3998**
3999** {F16211} The first invocation of [sqlite3_aggregate_context(C,N)] for
4000** a particular instance of an aggregate function (for a particular
4001** context C) causes SQLite to allocation N bytes of memory,
shane26b34032008-05-23 17:21:09 +00004002** zero that memory, and return a pointer to the allocated
drhafc91042008-02-21 02:09:45 +00004003** memory.
4004**
4005** {F16213} If a memory allocation error occurs during
4006** [sqlite3_aggregate_context(C,N)] then the function returns 0.
4007**
4008** {F16215} Second and subsequent invocations of
4009** [sqlite3_aggregate_context(C,N)] for the same context pointer C
4010** ignore the N parameter and return a pointer to the same
4011** block of memory returned by the first invocation.
4012**
4013** {F16217} The memory allocated by [sqlite3_aggregate_context(C,N)] is
4014** automatically freed on the next call to [sqlite3_reset()]
4015** or [sqlite3_finalize()] for the [prepared statement] containing
4016** the aggregate function associated with context C.
danielk19770ae8b832004-05-25 12:05:56 +00004017*/
drh4f26d6c2004-05-26 23:25:30 +00004018void *sqlite3_aggregate_context(sqlite3_context*, int nBytes);
danielk19777e18c252004-05-25 11:47:24 +00004019
4020/*
drhfddfa2d2007-12-05 18:05:16 +00004021** CAPI3REF: User Data For Functions {F16240}
drh6ed48bf2007-06-14 20:57:18 +00004022**
drhafc91042008-02-21 02:09:45 +00004023** The sqlite3_user_data() interface returns a copy of
drhf5befa02007-12-06 02:42:07 +00004024** the pointer that was the pUserData parameter (the 5th parameter)
shane26b34032008-05-23 17:21:09 +00004025** of the [sqlite3_create_function()]
drhf5befa02007-12-06 02:42:07 +00004026** and [sqlite3_create_function16()] routines that originally
4027** registered the application defined function. {END}
drhe53831d2007-08-17 01:14:38 +00004028**
drhafc91042008-02-21 02:09:45 +00004029** This routine must be called from the same thread in which
drhf5befa02007-12-06 02:42:07 +00004030** the application-defined function is running.
drhafc91042008-02-21 02:09:45 +00004031**
4032** INVARIANTS:
4033**
4034** {F16243} The [sqlite3_user_data(C)] interface returns a copy of the
4035** P pointer from the [sqlite3_create_function(D,X,N,E,P,F,S,L)]
4036** or [sqlite3_create_function16(D,X,N,E,P,F,S,L)] call that
4037** registered the SQL function associated with
4038** [sqlite3_context] C.
danielk19777e18c252004-05-25 11:47:24 +00004039*/
4040void *sqlite3_user_data(sqlite3_context*);
4041
4042/*
drhfa4a4b92008-03-19 21:45:51 +00004043** CAPI3REF: Database Connection For Functions {F16250}
4044**
4045** The sqlite3_context_db_handle() interface returns a copy of
4046** the pointer to the [database connection] (the 1st parameter)
shane26b34032008-05-23 17:21:09 +00004047** of the [sqlite3_create_function()]
drhfa4a4b92008-03-19 21:45:51 +00004048** and [sqlite3_create_function16()] routines that originally
4049** registered the application defined function.
4050**
4051** INVARIANTS:
4052**
4053** {F16253} The [sqlite3_context_db_handle(C)] interface returns a copy of the
4054** D pointer from the [sqlite3_create_function(D,X,N,E,P,F,S,L)]
4055** or [sqlite3_create_function16(D,X,N,E,P,F,S,L)] call that
4056** registered the SQL function associated with
4057** [sqlite3_context] C.
4058*/
4059sqlite3 *sqlite3_context_db_handle(sqlite3_context*);
4060
4061/*
drhfddfa2d2007-12-05 18:05:16 +00004062** CAPI3REF: Function Auxiliary Data {F16270}
drh6ed48bf2007-06-14 20:57:18 +00004063**
4064** The following two functions may be used by scalar SQL functions to
danielk1977682f68b2004-06-05 10:22:17 +00004065** associate meta-data with argument values. If the same value is passed to
drh6ed48bf2007-06-14 20:57:18 +00004066** multiple invocations of the same SQL function during query execution, under
danielk1977682f68b2004-06-05 10:22:17 +00004067** some circumstances the associated meta-data may be preserved. This may
4068** be used, for example, to add a regular-expression matching scalar
4069** function. The compiled version of the regular expression is stored as
4070** meta-data associated with the SQL value passed as the regular expression
drh6ed48bf2007-06-14 20:57:18 +00004071** pattern. The compiled regular expression can be reused on multiple
4072** invocations of the same function so that the original pattern string
4073** does not need to be recompiled on each invocation.
danielk1977682f68b2004-06-05 10:22:17 +00004074**
drh6ed48bf2007-06-14 20:57:18 +00004075** The sqlite3_get_auxdata() interface returns a pointer to the meta-data
drhf5befa02007-12-06 02:42:07 +00004076** associated by the sqlite3_set_auxdata() function with the Nth argument
4077** value to the application-defined function.
drhafc91042008-02-21 02:09:45 +00004078** If no meta-data has been ever been set for the Nth
shane26b34032008-05-23 17:21:09 +00004079** argument of the function, or if the corresponding function parameter
drhf5befa02007-12-06 02:42:07 +00004080** has changed since the meta-data was set, then sqlite3_get_auxdata()
4081** returns a NULL pointer.
danielk1977682f68b2004-06-05 10:22:17 +00004082**
drhafc91042008-02-21 02:09:45 +00004083** The sqlite3_set_auxdata() interface saves the meta-data
drhf5befa02007-12-06 02:42:07 +00004084** pointed to by its 3rd parameter as the meta-data for the N-th
drhafc91042008-02-21 02:09:45 +00004085** argument of the application-defined function. Subsequent
drhf5befa02007-12-06 02:42:07 +00004086** calls to sqlite3_get_auxdata() might return this data, if it has
4087** not been destroyed.
drhafc91042008-02-21 02:09:45 +00004088** If it is not NULL, SQLite will invoke the destructor
drhf5befa02007-12-06 02:42:07 +00004089** function given by the 4th parameter to sqlite3_set_auxdata() on
4090** the meta-data when the corresponding function parameter changes
drhafc91042008-02-21 02:09:45 +00004091** or when the SQL statement completes, whichever comes first.
4092**
4093** SQLite is free to call the destructor and drop meta-data on
4094** any parameter of any function at any time. The only guarantee
4095** is that the destructor will be called before the metadata is
4096** dropped.
danielk1977682f68b2004-06-05 10:22:17 +00004097**
4098** In practice, meta-data is preserved between function calls for
4099** expressions that are constant at compile time. This includes literal
4100** values and SQL variables.
drhe53831d2007-08-17 01:14:38 +00004101**
drhb21c8cd2007-08-21 19:33:56 +00004102** These routines must be called from the same thread in which
4103** the SQL function is running.
drhafc91042008-02-21 02:09:45 +00004104**
4105** INVARIANTS:
4106**
4107** {F16272} The [sqlite3_get_auxdata(C,N)] interface returns a pointer
4108** to metadata associated with the Nth parameter of the SQL function
4109** whose context is C, or NULL if there is no metadata associated
4110** with that parameter.
4111**
4112** {F16274} The [sqlite3_set_auxdata(C,N,P,D)] interface assigns a metadata
4113** pointer P to the Nth parameter of the SQL function with context
4114** C.
4115**
4116** {F16276} SQLite will invoke the destructor D with a single argument
4117** which is the metadata pointer P following a call to
4118** [sqlite3_set_auxdata(C,N,P,D)] when SQLite ceases to hold
4119** the metadata.
4120**
4121** {F16277} SQLite ceases to hold metadata for an SQL function parameter
4122** when the value of that parameter changes.
4123**
4124** {F16278} When [sqlite3_set_auxdata(C,N,P,D)] is invoked, the destructor
4125** is called for any prior metadata associated with the same function
4126** context C and parameter N.
4127**
4128** {F16279} SQLite will call destructors for any metadata it is holding
4129** in a particular [prepared statement] S when either
4130** [sqlite3_reset(S)] or [sqlite3_finalize(S)] is called.
danielk1977682f68b2004-06-05 10:22:17 +00004131*/
drhf5befa02007-12-06 02:42:07 +00004132void *sqlite3_get_auxdata(sqlite3_context*, int N);
4133void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*));
danielk1977682f68b2004-06-05 10:22:17 +00004134
drha2854222004-06-17 19:04:17 +00004135
4136/*
drhfddfa2d2007-12-05 18:05:16 +00004137** CAPI3REF: Constants Defining Special Destructor Behavior {F10280}
drh6ed48bf2007-06-14 20:57:18 +00004138**
drha2854222004-06-17 19:04:17 +00004139** These are special value for the destructor that is passed in as the
drh6ed48bf2007-06-14 20:57:18 +00004140** final argument to routines like [sqlite3_result_blob()]. If the destructor
drha2854222004-06-17 19:04:17 +00004141** argument is SQLITE_STATIC, it means that the content pointer is constant
4142** and will never change. It does not need to be destroyed. The
4143** SQLITE_TRANSIENT value means that the content will likely change in
4144** the near future and that SQLite should make its own private copy of
4145** the content before returning.
drh6c9121a2007-01-26 00:51:43 +00004146**
4147** The typedef is necessary to work around problems in certain
4148** C++ compilers. See ticket #2191.
drha2854222004-06-17 19:04:17 +00004149*/
drh6c9121a2007-01-26 00:51:43 +00004150typedef void (*sqlite3_destructor_type)(void*);
4151#define SQLITE_STATIC ((sqlite3_destructor_type)0)
4152#define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1)
danielk1977d8123362004-06-12 09:25:12 +00004153
danielk1977682f68b2004-06-05 10:22:17 +00004154/*
drhfddfa2d2007-12-05 18:05:16 +00004155** CAPI3REF: Setting The Result Of An SQL Function {F16400}
drh6ed48bf2007-06-14 20:57:18 +00004156**
4157** These routines are used by the xFunc or xFinal callbacks that
4158** implement SQL functions and aggregates. See
4159** [sqlite3_create_function()] and [sqlite3_create_function16()]
4160** for additional information.
4161**
4162** These functions work very much like the
4163** [sqlite3_bind_blob | sqlite3_bind_*] family of functions used
4164** to bind values to host parameters in prepared statements.
4165** Refer to the
4166** [sqlite3_bind_blob | sqlite3_bind_* documentation] for
4167** additional information.
4168**
drhafc91042008-02-21 02:09:45 +00004169** The sqlite3_result_blob() interface sets the result from
drhf5befa02007-12-06 02:42:07 +00004170** an application defined function to be the BLOB whose content is pointed
4171** to by the second parameter and which is N bytes long where N is the
4172** third parameter.
shane26b34032008-05-23 17:21:09 +00004173** The sqlite3_result_zeroblob() interfaces set the result of
drhf5befa02007-12-06 02:42:07 +00004174** the application defined function to be a BLOB containing all zero
4175** bytes and N bytes in size, where N is the value of the 2nd parameter.
drh6ed48bf2007-06-14 20:57:18 +00004176**
drhafc91042008-02-21 02:09:45 +00004177** The sqlite3_result_double() interface sets the result from
drhf5befa02007-12-06 02:42:07 +00004178** an application defined function to be a floating point value specified
4179** by its 2nd argument.
drhe53831d2007-08-17 01:14:38 +00004180**
drhafc91042008-02-21 02:09:45 +00004181** The sqlite3_result_error() and sqlite3_result_error16() functions
drhf5befa02007-12-06 02:42:07 +00004182** cause the implemented SQL function to throw an exception.
drhafc91042008-02-21 02:09:45 +00004183** SQLite uses the string pointed to by the
drhf5befa02007-12-06 02:42:07 +00004184** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16()
drhafc91042008-02-21 02:09:45 +00004185** as the text of an error message. SQLite interprets the error
4186** message string from sqlite3_result_error() as UTF8. SQLite
drhf5befa02007-12-06 02:42:07 +00004187** interprets the string from sqlite3_result_error16() as UTF16 in native
drhafc91042008-02-21 02:09:45 +00004188** byte order. If the third parameter to sqlite3_result_error()
drhf5befa02007-12-06 02:42:07 +00004189** or sqlite3_result_error16() is negative then SQLite takes as the error
4190** message all text up through the first zero character.
drhafc91042008-02-21 02:09:45 +00004191** If the third parameter to sqlite3_result_error() or
drhf5befa02007-12-06 02:42:07 +00004192** sqlite3_result_error16() is non-negative then SQLite takes that many
4193** bytes (not characters) from the 2nd parameter as the error message.
drhafc91042008-02-21 02:09:45 +00004194** The sqlite3_result_error() and sqlite3_result_error16()
drhf5befa02007-12-06 02:42:07 +00004195** routines make a copy private copy of the error message text before
drhafc91042008-02-21 02:09:45 +00004196** they return. Hence, the calling function can deallocate or
drhf5befa02007-12-06 02:42:07 +00004197** modify the text after they return without harm.
drh69544ec2008-02-06 14:11:34 +00004198** The sqlite3_result_error_code() function changes the error code
4199** returned by SQLite as a result of an error in a function. By default,
drh00e087b2008-04-10 17:14:07 +00004200** the error code is SQLITE_ERROR. A subsequent call to sqlite3_result_error()
4201** or sqlite3_result_error16() resets the error code to SQLITE_ERROR.
drhf5befa02007-12-06 02:42:07 +00004202**
drhafc91042008-02-21 02:09:45 +00004203** The sqlite3_result_toobig() interface causes SQLite
drhf5befa02007-12-06 02:42:07 +00004204** to throw an error indicating that a string or BLOB is to long
drhafc91042008-02-21 02:09:45 +00004205** to represent. The sqlite3_result_nomem() interface
drhf5befa02007-12-06 02:42:07 +00004206** causes SQLite to throw an exception indicating that the a
4207** memory allocation failed.
4208**
drhafc91042008-02-21 02:09:45 +00004209** The sqlite3_result_int() interface sets the return value
drhf5befa02007-12-06 02:42:07 +00004210** of the application-defined function to be the 32-bit signed integer
4211** value given in the 2nd argument.
drhafc91042008-02-21 02:09:45 +00004212** The sqlite3_result_int64() interface sets the return value
drhf5befa02007-12-06 02:42:07 +00004213** of the application-defined function to be the 64-bit signed integer
4214** value given in the 2nd argument.
4215**
drhafc91042008-02-21 02:09:45 +00004216** The sqlite3_result_null() interface sets the return value
drhf5befa02007-12-06 02:42:07 +00004217** of the application-defined function to be NULL.
4218**
drhafc91042008-02-21 02:09:45 +00004219** The sqlite3_result_text(), sqlite3_result_text16(),
drhf5befa02007-12-06 02:42:07 +00004220** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces
4221** set the return value of the application-defined function to be
4222** a text string which is represented as UTF-8, UTF-16 native byte order,
4223** UTF-16 little endian, or UTF-16 big endian, respectively.
drhafc91042008-02-21 02:09:45 +00004224** SQLite takes the text result from the application from
drhf5befa02007-12-06 02:42:07 +00004225** the 2nd parameter of the sqlite3_result_text* interfaces.
drhafc91042008-02-21 02:09:45 +00004226** If the 3rd parameter to the sqlite3_result_text* interfaces
drhf5befa02007-12-06 02:42:07 +00004227** is negative, then SQLite takes result text from the 2nd parameter
4228** through the first zero character.
drhafc91042008-02-21 02:09:45 +00004229** If the 3rd parameter to the sqlite3_result_text* interfaces
drhf5befa02007-12-06 02:42:07 +00004230** is non-negative, then as many bytes (not characters) of the text
4231** pointed to by the 2nd parameter are taken as the application-defined
4232** function result.
drhafc91042008-02-21 02:09:45 +00004233** If the 4th parameter to the sqlite3_result_text* interfaces
drhf5befa02007-12-06 02:42:07 +00004234** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that
4235** function as the destructor on the text or blob result when it has
4236** finished using that result.
drhafc91042008-02-21 02:09:45 +00004237** If the 4th parameter to the sqlite3_result_text* interfaces
drhf5befa02007-12-06 02:42:07 +00004238** or sqlite3_result_blob is the special constant SQLITE_STATIC, then
4239** SQLite assumes that the text or blob result is constant space and
4240** does not copy the space or call a destructor when it has
4241** finished using that result.
drhafc91042008-02-21 02:09:45 +00004242** If the 4th parameter to the sqlite3_result_text* interfaces
drhf5befa02007-12-06 02:42:07 +00004243** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT
4244** then SQLite makes a copy of the result into space obtained from
4245** from [sqlite3_malloc()] before it returns.
4246**
drhafc91042008-02-21 02:09:45 +00004247** The sqlite3_result_value() interface sets the result of
drhaa28e142008-03-18 13:47:20 +00004248** the application-defined function to be a copy the
4249** [unprotected sqlite3_value] object specified by the 2nd parameter. The
drhf5befa02007-12-06 02:42:07 +00004250** sqlite3_result_value() interface makes a copy of the [sqlite3_value]
4251** so that [sqlite3_value] specified in the parameter may change or
4252** be deallocated after sqlite3_result_value() returns without harm.
drhaa28e142008-03-18 13:47:20 +00004253** A [protected sqlite3_value] object may always be used where an
4254** [unprotected sqlite3_value] object is required, so either
4255** kind of [sqlite3_value] object can be used with this interface.
drhf5befa02007-12-06 02:42:07 +00004256**
drhafc91042008-02-21 02:09:45 +00004257** If these routines are called from within the different thread
shane26b34032008-05-23 17:21:09 +00004258** than the one containing the application-defined function that received
drhf5befa02007-12-06 02:42:07 +00004259** the [sqlite3_context] pointer, the results are undefined.
drhafc91042008-02-21 02:09:45 +00004260**
4261** INVARIANTS:
4262**
4263** {F16403} The default return value from any SQL function is NULL.
4264**
4265** {F16406} The [sqlite3_result_blob(C,V,N,D)] interface changes the
4266** return value of function C to be a blob that is N bytes
4267** in length and with content pointed to by V.
4268**
4269** {F16409} The [sqlite3_result_double(C,V)] interface changes the
4270** return value of function C to be the floating point value V.
4271**
4272** {F16412} The [sqlite3_result_error(C,V,N)] interface changes the return
4273** value of function C to be an exception with error code
4274** [SQLITE_ERROR] and a UTF8 error message copied from V up to the
4275** first zero byte or until N bytes are read if N is positive.
4276**
4277** {F16415} The [sqlite3_result_error16(C,V,N)] interface changes the return
4278** value of function C to be an exception with error code
4279** [SQLITE_ERROR] and a UTF16 native byte order error message
4280** copied from V up to the first zero terminator or until N bytes
4281** are read if N is positive.
4282**
4283** {F16418} The [sqlite3_result_error_toobig(C)] interface changes the return
4284** value of the function C to be an exception with error code
4285** [SQLITE_TOOBIG] and an appropriate error message.
4286**
4287** {F16421} The [sqlite3_result_error_nomem(C)] interface changes the return
4288** value of the function C to be an exception with error code
4289** [SQLITE_NOMEM] and an appropriate error message.
4290**
4291** {F16424} The [sqlite3_result_error_code(C,E)] interface changes the return
4292** value of the function C to be an exception with error code E.
4293** The error message text is unchanged.
4294**
4295** {F16427} The [sqlite3_result_int(C,V)] interface changes the
4296** return value of function C to be the 32-bit integer value V.
4297**
4298** {F16430} The [sqlite3_result_int64(C,V)] interface changes the
4299** return value of function C to be the 64-bit integer value V.
4300**
4301** {F16433} The [sqlite3_result_null(C)] interface changes the
4302** return value of function C to be NULL.
4303**
4304** {F16436} The [sqlite3_result_text(C,V,N,D)] interface changes the
4305** return value of function C to be the UTF8 string
drha95174b2008-04-17 17:03:25 +00004306** V up to the first zero if N is negative
drhb08c2a72008-04-16 00:28:13 +00004307** or the first N bytes of V if N is non-negative.
drhafc91042008-02-21 02:09:45 +00004308**
4309** {F16439} The [sqlite3_result_text16(C,V,N,D)] interface changes the
4310** return value of function C to be the UTF16 native byte order
drhb08c2a72008-04-16 00:28:13 +00004311** string V up to the first zero if N is
4312** negative or the first N bytes of V if N is non-negative.
drhafc91042008-02-21 02:09:45 +00004313**
4314** {F16442} The [sqlite3_result_text16be(C,V,N,D)] interface changes the
4315** return value of function C to be the UTF16 big-endian
drhb08c2a72008-04-16 00:28:13 +00004316** string V up to the first zero if N is
4317** is negative or the first N bytes or V if N is non-negative.
drhafc91042008-02-21 02:09:45 +00004318**
4319** {F16445} The [sqlite3_result_text16le(C,V,N,D)] interface changes the
4320** return value of function C to be the UTF16 little-endian
drhb08c2a72008-04-16 00:28:13 +00004321** string V up to the first zero if N is
4322** negative or the first N bytes of V if N is non-negative.
drhafc91042008-02-21 02:09:45 +00004323**
4324** {F16448} The [sqlite3_result_value(C,V)] interface changes the
drhaa28e142008-03-18 13:47:20 +00004325** return value of function C to be [unprotected sqlite3_value]
4326** object V.
drhafc91042008-02-21 02:09:45 +00004327**
4328** {F16451} The [sqlite3_result_zeroblob(C,N)] interface changes the
4329** return value of function C to be an N-byte blob of all zeros.
4330**
4331** {F16454} The [sqlite3_result_error()] and [sqlite3_result_error16()]
4332** interfaces make a copy of their error message strings before
4333** returning.
4334**
4335** {F16457} If the D destructor parameter to [sqlite3_result_blob(C,V,N,D)],
4336** [sqlite3_result_text(C,V,N,D)], [sqlite3_result_text16(C,V,N,D)],
4337** [sqlite3_result_text16be(C,V,N,D)], or
4338** [sqlite3_result_text16le(C,V,N,D)] is the constant [SQLITE_STATIC]
4339** then no destructor is ever called on the pointer V and SQLite
4340** assumes that V is immutable.
4341**
4342** {F16460} If the D destructor parameter to [sqlite3_result_blob(C,V,N,D)],
4343** [sqlite3_result_text(C,V,N,D)], [sqlite3_result_text16(C,V,N,D)],
4344** [sqlite3_result_text16be(C,V,N,D)], or
4345** [sqlite3_result_text16le(C,V,N,D)] is the constant
4346** [SQLITE_TRANSIENT] then the interfaces makes a copy of the
4347** content of V and retains the copy.
4348**
4349** {F16463} If the D destructor parameter to [sqlite3_result_blob(C,V,N,D)],
4350** [sqlite3_result_text(C,V,N,D)], [sqlite3_result_text16(C,V,N,D)],
4351** [sqlite3_result_text16be(C,V,N,D)], or
4352** [sqlite3_result_text16le(C,V,N,D)] is some value other than
4353** the constants [SQLITE_STATIC] and [SQLITE_TRANSIENT] then
4354** SQLite will invoke the destructor D with V as its only argument
4355** when it has finished with the V value.
danielk19777e18c252004-05-25 11:47:24 +00004356*/
danielk1977d8123362004-06-12 09:25:12 +00004357void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*));
drh4f26d6c2004-05-26 23:25:30 +00004358void sqlite3_result_double(sqlite3_context*, double);
danielk19777e18c252004-05-25 11:47:24 +00004359void sqlite3_result_error(sqlite3_context*, const char*, int);
4360void sqlite3_result_error16(sqlite3_context*, const void*, int);
drh6ed48bf2007-06-14 20:57:18 +00004361void sqlite3_result_error_toobig(sqlite3_context*);
danielk1977a1644fd2007-08-29 12:31:25 +00004362void sqlite3_result_error_nomem(sqlite3_context*);
drh69544ec2008-02-06 14:11:34 +00004363void sqlite3_result_error_code(sqlite3_context*, int);
drh4f26d6c2004-05-26 23:25:30 +00004364void sqlite3_result_int(sqlite3_context*, int);
drh6d2069d2007-08-14 01:58:53 +00004365void sqlite3_result_int64(sqlite3_context*, sqlite3_int64);
drh4f26d6c2004-05-26 23:25:30 +00004366void sqlite3_result_null(sqlite3_context*);
danielk1977d8123362004-06-12 09:25:12 +00004367void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*));
4368void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*));
4369void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*));
4370void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*));
drh4f26d6c2004-05-26 23:25:30 +00004371void sqlite3_result_value(sqlite3_context*, sqlite3_value*);
drhb026e052007-05-02 01:34:31 +00004372void sqlite3_result_zeroblob(sqlite3_context*, int n);
drhf9b596e2004-05-26 16:54:42 +00004373
drh52619df2004-06-11 17:48:02 +00004374/*
drhfddfa2d2007-12-05 18:05:16 +00004375** CAPI3REF: Define New Collating Sequences {F16600}
drh6ed48bf2007-06-14 20:57:18 +00004376**
4377** These functions are used to add new collation sequences to the
4378** [sqlite3*] handle specified as the first argument.
danielk19777cedc8d2004-06-10 10:50:08 +00004379**
4380** The name of the new collation sequence is specified as a UTF-8 string
drh6ed48bf2007-06-14 20:57:18 +00004381** for sqlite3_create_collation() and sqlite3_create_collation_v2()
drhafc91042008-02-21 02:09:45 +00004382** and a UTF-16 string for sqlite3_create_collation16(). In all cases
drh6ed48bf2007-06-14 20:57:18 +00004383** the name is passed as the second function argument.
danielk19777cedc8d2004-06-10 10:50:08 +00004384**
drh4145f832007-10-12 18:30:12 +00004385** The third argument may be one of the constants [SQLITE_UTF8],
drh6ed48bf2007-06-14 20:57:18 +00004386** [SQLITE_UTF16LE] or [SQLITE_UTF16BE], indicating that the user-supplied
danielk19777cedc8d2004-06-10 10:50:08 +00004387** routine expects to be passed pointers to strings encoded using UTF-8,
drhafc91042008-02-21 02:09:45 +00004388** UTF-16 little-endian or UTF-16 big-endian respectively. The
drh4145f832007-10-12 18:30:12 +00004389** third argument might also be [SQLITE_UTF16_ALIGNED] to indicate that
4390** the routine expects pointers to 16-bit word aligned strings
4391** of UTF16 in the native byte order of the host computer.
danielk19777cedc8d2004-06-10 10:50:08 +00004392**
4393** A pointer to the user supplied routine must be passed as the fifth
drhafc91042008-02-21 02:09:45 +00004394** argument. If it is NULL, this is the same as deleting the collation
drhf5befa02007-12-06 02:42:07 +00004395** sequence (so that SQLite cannot call it anymore).
drhafc91042008-02-21 02:09:45 +00004396** Each time the application
danielk19777cedc8d2004-06-10 10:50:08 +00004397** supplied function is invoked, it is passed a copy of the void* passed as
4398** the fourth argument to sqlite3_create_collation() or
4399** sqlite3_create_collation16() as its first parameter.
4400**
drhf5befa02007-12-06 02:42:07 +00004401** The remaining arguments to the application-supplied routine are two strings,
drh33c1be32008-01-30 16:16:14 +00004402** each represented by a (length, data) pair and encoded in the encoding
danielk19777cedc8d2004-06-10 10:50:08 +00004403** that was passed as the third argument when the collation sequence was
drhf5befa02007-12-06 02:42:07 +00004404** registered. {END} The application defined collation routine should
4405** return negative, zero or positive if
danielk19777cedc8d2004-06-10 10:50:08 +00004406** the first string is less than, equal to, or greater than the second
4407** string. i.e. (STRING1 - STRING2).
drh6ed48bf2007-06-14 20:57:18 +00004408**
4409** The sqlite3_create_collation_v2() works like sqlite3_create_collation()
shane26b34032008-05-23 17:21:09 +00004410** except that it takes an extra argument which is a destructor for
drhafc91042008-02-21 02:09:45 +00004411** the collation. The destructor is called when the collation is
drh6ed48bf2007-06-14 20:57:18 +00004412** destroyed and is passed a copy of the fourth parameter void* pointer
drhf5befa02007-12-06 02:42:07 +00004413** of the sqlite3_create_collation_v2().
drhafc91042008-02-21 02:09:45 +00004414** Collations are destroyed when
drh6ed48bf2007-06-14 20:57:18 +00004415** they are overridden by later calls to the collation creation functions
4416** or when the [sqlite3*] database handle is closed using [sqlite3_close()].
drhafc91042008-02-21 02:09:45 +00004417**
4418** INVARIANTS:
4419**
4420** {F16603} A successful call to the
4421** [sqlite3_create_collation_v2(B,X,E,P,F,D)] interface
4422** registers function F as the comparison function used to
4423** implement collation X on [database connection] B for
4424** databases having encoding E.
4425**
4426** {F16604} SQLite understands the X parameter to
4427** [sqlite3_create_collation_v2(B,X,E,P,F,D)] as a zero-terminated
4428** UTF-8 string in which case is ignored for ASCII characters and
4429** is significant for non-ASCII characters.
4430**
4431** {F16606} Successive calls to [sqlite3_create_collation_v2(B,X,E,P,F,D)]
4432** with the same values for B, X, and E, override prior values
4433** of P, F, and D.
4434**
4435** {F16609} The destructor D in [sqlite3_create_collation_v2(B,X,E,P,F,D)]
4436** is not NULL then it is called with argument P when the
4437** collating function is dropped by SQLite.
4438**
4439** {F16612} A collating function is dropped when it is overloaded.
4440**
4441** {F16615} A collating function is dropped when the database connection
4442** is closed using [sqlite3_close()].
4443**
4444** {F16618} The pointer P in [sqlite3_create_collation_v2(B,X,E,P,F,D)]
4445** is passed through as the first parameter to the comparison
4446** function F for all subsequent invocations of F.
4447**
4448** {F16621} A call to [sqlite3_create_collation(B,X,E,P,F)] is exactly
4449** the same as a call to [sqlite3_create_collation_v2()] with
4450** the same parameters and a NULL destructor.
4451**
4452** {F16624} Following a [sqlite3_create_collation_v2(B,X,E,P,F,D)],
4453** SQLite uses the comparison function F for all text comparison
4454** operations on [database connection] B on text values that
4455** use the collating sequence name X.
4456**
4457** {F16627} The [sqlite3_create_collation16(B,X,E,P,F)] works the same
4458** as [sqlite3_create_collation(B,X,E,P,F)] except that the
4459** collation name X is understood as UTF-16 in native byte order
4460** instead of UTF-8.
4461**
4462** {F16630} When multiple comparison functions are available for the same
4463** collating sequence, SQLite chooses the one whose text encoding
4464** requires the least amount of conversion from the default
4465** text encoding of the database.
danielk19777cedc8d2004-06-10 10:50:08 +00004466*/
danielk19770202b292004-06-09 09:55:16 +00004467int sqlite3_create_collation(
4468 sqlite3*,
4469 const char *zName,
danielk19777cedc8d2004-06-10 10:50:08 +00004470 int eTextRep,
danielk19770202b292004-06-09 09:55:16 +00004471 void*,
4472 int(*xCompare)(void*,int,const void*,int,const void*)
4473);
drh6ed48bf2007-06-14 20:57:18 +00004474int sqlite3_create_collation_v2(
4475 sqlite3*,
4476 const char *zName,
4477 int eTextRep,
4478 void*,
4479 int(*xCompare)(void*,int,const void*,int,const void*),
4480 void(*xDestroy)(void*)
4481);
danielk19770202b292004-06-09 09:55:16 +00004482int sqlite3_create_collation16(
4483 sqlite3*,
4484 const char *zName,
danielk19777cedc8d2004-06-10 10:50:08 +00004485 int eTextRep,
danielk19770202b292004-06-09 09:55:16 +00004486 void*,
4487 int(*xCompare)(void*,int,const void*,int,const void*)
4488);
4489
danielk19777cedc8d2004-06-10 10:50:08 +00004490/*
drhfddfa2d2007-12-05 18:05:16 +00004491** CAPI3REF: Collation Needed Callbacks {F16700}
danielk1977a393c032007-05-07 14:58:53 +00004492**
danielk19777cedc8d2004-06-10 10:50:08 +00004493** To avoid having to register all collation sequences before a database
4494** can be used, a single callback function may be registered with the
4495** database handle to be called whenever an undefined collation sequence is
4496** required.
4497**
4498** If the function is registered using the sqlite3_collation_needed() API,
4499** then it is passed the names of undefined collation sequences as strings
drhf5befa02007-12-06 02:42:07 +00004500** encoded in UTF-8. {F16703} If sqlite3_collation_needed16() is used, the names
drhafc91042008-02-21 02:09:45 +00004501** are passed as UTF-16 in machine native byte order. A call to either
danielk19777cedc8d2004-06-10 10:50:08 +00004502** function replaces any existing callback.
4503**
drhafc91042008-02-21 02:09:45 +00004504** When the callback is invoked, the first argument passed is a copy
danielk19777cedc8d2004-06-10 10:50:08 +00004505** of the second argument to sqlite3_collation_needed() or
drhafc91042008-02-21 02:09:45 +00004506** sqlite3_collation_needed16(). The second argument is the database
4507** handle. The third argument is one of [SQLITE_UTF8],
drhf5befa02007-12-06 02:42:07 +00004508** [SQLITE_UTF16BE], or [SQLITE_UTF16LE], indicating the most
4509** desirable form of the collation sequence function required.
drhafc91042008-02-21 02:09:45 +00004510** The fourth parameter is the name of the
4511** required collation sequence.
danielk19777cedc8d2004-06-10 10:50:08 +00004512**
drh6ed48bf2007-06-14 20:57:18 +00004513** The callback function should register the desired collation using
4514** [sqlite3_create_collation()], [sqlite3_create_collation16()], or
4515** [sqlite3_create_collation_v2()].
drhafc91042008-02-21 02:09:45 +00004516**
4517** INVARIANTS:
4518**
4519** {F16702} A successful call to [sqlite3_collation_needed(D,P,F)]
4520** or [sqlite3_collation_needed16(D,P,F)] causes
4521** the [database connection] D to invoke callback F with first
4522** parameter P whenever it needs a comparison function for a
4523** collating sequence that it does not know about.
4524**
4525** {F16704} Each successful call to [sqlite3_collation_needed()] or
4526** [sqlite3_collation_needed16()] overrides the callback registered
4527** on the same [database connection] by prior calls to either
4528** interface.
4529**
4530** {F16706} The name of the requested collating function passed in the
4531** 4th parameter to the callback is in UTF-8 if the callback
4532** was registered using [sqlite3_collation_needed()] and
4533** is in UTF-16 native byte order if the callback was
4534** registered using [sqlite3_collation_needed16()].
4535**
4536**
danielk19777cedc8d2004-06-10 10:50:08 +00004537*/
4538int sqlite3_collation_needed(
4539 sqlite3*,
4540 void*,
4541 void(*)(void*,sqlite3*,int eTextRep,const char*)
4542);
4543int sqlite3_collation_needed16(
4544 sqlite3*,
4545 void*,
4546 void(*)(void*,sqlite3*,int eTextRep,const void*)
4547);
4548
drh2011d5f2004-07-22 02:40:37 +00004549/*
4550** Specify the key for an encrypted database. This routine should be
4551** called right after sqlite3_open().
4552**
4553** The code to implement this API is not available in the public release
4554** of SQLite.
4555*/
4556int sqlite3_key(
4557 sqlite3 *db, /* Database to be rekeyed */
4558 const void *pKey, int nKey /* The key */
4559);
4560
4561/*
4562** Change the key on an open database. If the current database is not
4563** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the
4564** database is decrypted.
4565**
4566** The code to implement this API is not available in the public release
4567** of SQLite.
4568*/
4569int sqlite3_rekey(
4570 sqlite3 *db, /* Database to be rekeyed */
4571 const void *pKey, int nKey /* The new key */
4572);
danielk19770202b292004-06-09 09:55:16 +00004573
drhab3f9fe2004-08-14 17:10:10 +00004574/*
drhfddfa2d2007-12-05 18:05:16 +00004575** CAPI3REF: Suspend Execution For A Short Time {F10530}
drh6ed48bf2007-06-14 20:57:18 +00004576**
drhafc91042008-02-21 02:09:45 +00004577** The sqlite3_sleep() function
drhf5befa02007-12-06 02:42:07 +00004578** causes the current thread to suspend execution
drhfddfa2d2007-12-05 18:05:16 +00004579** for at least a number of milliseconds specified in its parameter.
danielk1977600dd0b2005-01-20 01:14:23 +00004580**
drhafc91042008-02-21 02:09:45 +00004581** If the operating system does not support sleep requests with
drh6ed48bf2007-06-14 20:57:18 +00004582** millisecond time resolution, then the time will be rounded up to
drhafc91042008-02-21 02:09:45 +00004583** the nearest second. The number of milliseconds of sleep actually
danielk1977600dd0b2005-01-20 01:14:23 +00004584** requested from the operating system is returned.
drh8bacf972007-08-25 16:21:29 +00004585**
drhafc91042008-02-21 02:09:45 +00004586** SQLite implements this interface by calling the xSleep()
4587** method of the default [sqlite3_vfs] object.
4588**
4589** INVARIANTS:
4590**
4591** {F10533} The [sqlite3_sleep(M)] interface invokes the xSleep
4592** method of the default [sqlite3_vfs|VFS] in order to
4593** suspend execution of the current thread for at least
4594** M milliseconds.
4595**
4596** {F10536} The [sqlite3_sleep(M)] interface returns the number of
4597** milliseconds of sleep actually requested of the operating
4598** system, which might be larger than the parameter M.
danielk1977600dd0b2005-01-20 01:14:23 +00004599*/
4600int sqlite3_sleep(int);
4601
4602/*
drhfddfa2d2007-12-05 18:05:16 +00004603** CAPI3REF: Name Of The Folder Holding Temporary Files {F10310}
drhd89bd002005-01-22 03:03:54 +00004604**
drh6ed48bf2007-06-14 20:57:18 +00004605** If this global variable is made to point to a string which is
shane26b34032008-05-23 17:21:09 +00004606** the name of a folder (a.k.a. directory), then all temporary files
drhab3f9fe2004-08-14 17:10:10 +00004607** created by SQLite will be placed in that directory. If this variable
4608** is NULL pointer, then SQLite does a search for an appropriate temporary
4609** file directory.
4610**
drh4ff7fa02007-09-01 18:17:21 +00004611** It is not safe to modify this variable once a database connection
4612** has been opened. It is intended that this variable be set once
4613** as part of process initialization and before any SQLite interface
4614** routines have been call and remain unchanged thereafter.
drhab3f9fe2004-08-14 17:10:10 +00004615*/
drh73be5012007-08-08 12:11:21 +00004616SQLITE_EXTERN char *sqlite3_temp_directory;
drhab3f9fe2004-08-14 17:10:10 +00004617
danielk19776b456a22005-03-21 04:04:02 +00004618/*
drhfddfa2d2007-12-05 18:05:16 +00004619** CAPI3REF: Test To See If The Database Is In Auto-Commit Mode {F12930}
danielk19776b456a22005-03-21 04:04:02 +00004620**
shane26b34032008-05-23 17:21:09 +00004621** The sqlite3_get_autocommit() interface returns non-zero or
drhf5befa02007-12-06 02:42:07 +00004622** zero if the given database connection is or is not in autocommit mode,
drh33c1be32008-01-30 16:16:14 +00004623** respectively. Autocommit mode is on
4624** by default. Autocommit mode is disabled by a [BEGIN] statement.
shane26b34032008-05-23 17:21:09 +00004625** Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK].
drhe30f4422007-08-21 16:15:55 +00004626**
drh7c3472a2007-10-03 20:15:28 +00004627** If certain kinds of errors occur on a statement within a multi-statement
4628** transactions (errors including [SQLITE_FULL], [SQLITE_IOERR],
4629** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the
drh33c1be32008-01-30 16:16:14 +00004630** transaction might be rolled back automatically. The only way to
drh7c3472a2007-10-03 20:15:28 +00004631** find out if SQLite automatically rolled back the transaction after
drh33c1be32008-01-30 16:16:14 +00004632** an error is to use this function.
drh7c3472a2007-10-03 20:15:28 +00004633**
drh33c1be32008-01-30 16:16:14 +00004634** INVARIANTS:
4635**
drhafc91042008-02-21 02:09:45 +00004636** {F12931} The [sqlite3_get_autocommit(D)] interface returns non-zero or
4637** zero if the [database connection] D is or is not in autocommit
drh33c1be32008-01-30 16:16:14 +00004638** mode, respectively.
4639**
4640** {F12932} Autocommit mode is on by default.
4641**
4642** {F12933} Autocommit mode is disabled by a successful [BEGIN] statement.
4643**
4644** {F12934} Autocommit mode is enabled by a successful [COMMIT] or [ROLLBACK]
4645** statement.
4646**
4647**
4648** LIMITATIONS:
4649***
drhf5befa02007-12-06 02:42:07 +00004650** {U12936} If another thread changes the autocommit status of the database
drh33c1be32008-01-30 16:16:14 +00004651** connection while this routine is running, then the return value
4652** is undefined.
drh3e1d8e62005-05-26 16:23:34 +00004653*/
4654int sqlite3_get_autocommit(sqlite3*);
4655
drh51942bc2005-06-12 22:01:42 +00004656/*
drhfddfa2d2007-12-05 18:05:16 +00004657** CAPI3REF: Find The Database Handle Of A Prepared Statement {F13120}
drh6ed48bf2007-06-14 20:57:18 +00004658**
drhafc91042008-02-21 02:09:45 +00004659** The sqlite3_db_handle interface
drhf5befa02007-12-06 02:42:07 +00004660** returns the [sqlite3*] database handle to which a
drh33c1be32008-01-30 16:16:14 +00004661** [prepared statement] belongs.
drhafc91042008-02-21 02:09:45 +00004662** The database handle returned by sqlite3_db_handle
drhf5befa02007-12-06 02:42:07 +00004663** is the same database handle that was
drh6ed48bf2007-06-14 20:57:18 +00004664** the first argument to the [sqlite3_prepare_v2()] or its variants
4665** that was used to create the statement in the first place.
drhafc91042008-02-21 02:09:45 +00004666**
4667** INVARIANTS:
4668**
4669** {F13123} The [sqlite3_db_handle(S)] interface returns a pointer
4670** to the [database connection] associated with
4671** [prepared statement] S.
drh51942bc2005-06-12 22:01:42 +00004672*/
4673sqlite3 *sqlite3_db_handle(sqlite3_stmt*);
drh3e1d8e62005-05-26 16:23:34 +00004674
drh6ed48bf2007-06-14 20:57:18 +00004675
drhb37df7b2005-10-13 02:09:49 +00004676/*
drhfddfa2d2007-12-05 18:05:16 +00004677** CAPI3REF: Commit And Rollback Notification Callbacks {F12950}
drh6ed48bf2007-06-14 20:57:18 +00004678**
drhafc91042008-02-21 02:09:45 +00004679** The sqlite3_commit_hook() interface registers a callback
drhf5befa02007-12-06 02:42:07 +00004680** function to be invoked whenever a transaction is committed.
drhafc91042008-02-21 02:09:45 +00004681** Any callback set by a previous call to sqlite3_commit_hook()
drhf5befa02007-12-06 02:42:07 +00004682** for the same database connection is overridden.
drhafc91042008-02-21 02:09:45 +00004683** The sqlite3_rollback_hook() interface registers a callback
drhf5befa02007-12-06 02:42:07 +00004684** function to be invoked whenever a transaction is committed.
drhafc91042008-02-21 02:09:45 +00004685** Any callback set by a previous call to sqlite3_commit_hook()
drhf5befa02007-12-06 02:42:07 +00004686** for the same database connection is overridden.
drhafc91042008-02-21 02:09:45 +00004687** The pArg argument is passed through
4688** to the callback. If the callback on a commit hook function
drh6ed48bf2007-06-14 20:57:18 +00004689** returns non-zero, then the commit is converted into a rollback.
4690**
drhafc91042008-02-21 02:09:45 +00004691** If another function was previously registered, its
drhf5befa02007-12-06 02:42:07 +00004692** pArg value is returned. Otherwise NULL is returned.
drh6ed48bf2007-06-14 20:57:18 +00004693**
drhafc91042008-02-21 02:09:45 +00004694** Registering a NULL function disables the callback.
drh6ed48bf2007-06-14 20:57:18 +00004695**
drhafc91042008-02-21 02:09:45 +00004696** For the purposes of this API, a transaction is said to have been
drh6ed48bf2007-06-14 20:57:18 +00004697** rolled back if an explicit "ROLLBACK" statement is executed, or
drhf5befa02007-12-06 02:42:07 +00004698** an error or constraint causes an implicit rollback to occur.
drhafc91042008-02-21 02:09:45 +00004699** The rollback callback is not invoked if a transaction is
drhf5befa02007-12-06 02:42:07 +00004700** automatically rolled back because the database connection is closed.
drhafc91042008-02-21 02:09:45 +00004701** The rollback callback is not invoked if a transaction is
drhf5befa02007-12-06 02:42:07 +00004702** rolled back because a commit callback returned non-zero.
drhafc91042008-02-21 02:09:45 +00004703** <todo> Check on this </todo>
drh6ed48bf2007-06-14 20:57:18 +00004704**
4705** These are experimental interfaces and are subject to change.
drhafc91042008-02-21 02:09:45 +00004706**
4707** INVARIANTS:
4708**
4709** {F12951} The [sqlite3_commit_hook(D,F,P)] interface registers the
4710** callback function F to be invoked with argument P whenever
4711** a transaction commits on [database connection] D.
4712**
4713** {F12952} The [sqlite3_commit_hook(D,F,P)] interface returns the P
4714** argument from the previous call with the same
4715** [database connection ] D , or NULL on the first call
4716** for a particular [database connection] D.
4717**
4718** {F12953} Each call to [sqlite3_commit_hook()] overwrites the callback
4719** registered by prior calls.
4720**
4721** {F12954} If the F argument to [sqlite3_commit_hook(D,F,P)] is NULL
shane236ce972008-05-30 15:35:30 +00004722** then the commit hook callback is canceled and no callback
drhafc91042008-02-21 02:09:45 +00004723** is invoked when a transaction commits.
4724**
4725** {F12955} If the commit callback returns non-zero then the commit is
4726** converted into a rollback.
4727**
4728** {F12961} The [sqlite3_rollback_hook(D,F,P)] interface registers the
4729** callback function F to be invoked with argument P whenever
4730** a transaction rolls back on [database connection] D.
4731**
4732** {F12962} The [sqlite3_rollback_hook(D,F,P)] interface returns the P
4733** argument from the previous call with the same
4734** [database connection ] D , or NULL on the first call
4735** for a particular [database connection] D.
4736**
4737** {F12963} Each call to [sqlite3_rollback_hook()] overwrites the callback
4738** registered by prior calls.
4739**
4740** {F12964} If the F argument to [sqlite3_rollback_hook(D,F,P)] is NULL
shane236ce972008-05-30 15:35:30 +00004741** then the rollback hook callback is canceled and no callback
drhafc91042008-02-21 02:09:45 +00004742** is invoked when a transaction rolls back.
drh6ed48bf2007-06-14 20:57:18 +00004743*/
4744void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
4745void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);
4746
4747/*
drhfddfa2d2007-12-05 18:05:16 +00004748** CAPI3REF: Data Change Notification Callbacks {F12970}
drh6ed48bf2007-06-14 20:57:18 +00004749**
drhafc91042008-02-21 02:09:45 +00004750** The sqlite3_update_hook() interface
drhf5befa02007-12-06 02:42:07 +00004751** registers a callback function with the database connection identified by the
danielk197794eb6a12005-12-15 15:22:08 +00004752** first argument to be invoked whenever a row is updated, inserted or deleted.
drhafc91042008-02-21 02:09:45 +00004753** Any callback set by a previous call to this function for the same
danielk197794eb6a12005-12-15 15:22:08 +00004754** database connection is overridden.
4755**
drhafc91042008-02-21 02:09:45 +00004756** The second argument is a pointer to the function to invoke when a
drhf5befa02007-12-06 02:42:07 +00004757** row is updated, inserted or deleted.
drhafc91042008-02-21 02:09:45 +00004758** The first argument to the callback is
drhf5befa02007-12-06 02:42:07 +00004759** a copy of the third argument to sqlite3_update_hook().
drhafc91042008-02-21 02:09:45 +00004760** The second callback
drhf5befa02007-12-06 02:42:07 +00004761** argument is one of [SQLITE_INSERT], [SQLITE_DELETE] or [SQLITE_UPDATE],
4762** depending on the operation that caused the callback to be invoked.
drhafc91042008-02-21 02:09:45 +00004763** The third and
danielk197794eb6a12005-12-15 15:22:08 +00004764** fourth arguments to the callback contain pointers to the database and
drhf5befa02007-12-06 02:42:07 +00004765** table name containing the affected row.
drhafc91042008-02-21 02:09:45 +00004766** The final callback parameter is
drhf5befa02007-12-06 02:42:07 +00004767** the rowid of the row.
drhafc91042008-02-21 02:09:45 +00004768** In the case of an update, this is the rowid after
danielk197794eb6a12005-12-15 15:22:08 +00004769** the update takes place.
4770**
drhafc91042008-02-21 02:09:45 +00004771** The update hook is not invoked when internal system tables are
danielk197794eb6a12005-12-15 15:22:08 +00004772** modified (i.e. sqlite_master and sqlite_sequence).
danielk197771fd80b2005-12-16 06:54:01 +00004773**
drhafc91042008-02-21 02:09:45 +00004774** If another function was previously registered, its pArg value
4775** is returned. Otherwise NULL is returned.
4776**
4777** INVARIANTS:
4778**
4779** {F12971} The [sqlite3_update_hook(D,F,P)] interface causes callback
4780** function F to be invoked with first parameter P whenever
4781** a table row is modified, inserted, or deleted on
4782** [database connection] D.
4783**
4784** {F12973} The [sqlite3_update_hook(D,F,P)] interface returns the value
4785** of P for the previous call on the same [database connection] D,
4786** or NULL for the first call.
4787**
4788** {F12975} If the update hook callback F in [sqlite3_update_hook(D,F,P)]
4789** is NULL then the no update callbacks are made.
4790**
4791** {F12977} Each call to [sqlite3_update_hook(D,F,P)] overrides prior calls
4792** to the same interface on the same [database connection] D.
4793**
4794** {F12979} The update hook callback is not invoked when internal system
4795** tables such as sqlite_master and sqlite_sequence are modified.
4796**
4797** {F12981} The second parameter to the update callback
4798** is one of [SQLITE_INSERT], [SQLITE_DELETE] or [SQLITE_UPDATE],
4799** depending on the operation that caused the callback to be invoked.
4800**
4801** {F12983} The third and fourth arguments to the callback contain pointers
4802** to zero-terminated UTF-8 strings which are the names of the
4803** database and table that is being updated.
4804
4805** {F12985} The final callback parameter is the rowid of the row after
4806** the change occurs.
danielk197794eb6a12005-12-15 15:22:08 +00004807*/
danielk197771fd80b2005-12-16 06:54:01 +00004808void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00004809 sqlite3*,
drh6d2069d2007-08-14 01:58:53 +00004810 void(*)(void *,int ,char const *,char const *,sqlite3_int64),
danielk197794eb6a12005-12-15 15:22:08 +00004811 void*
4812);
danielk197713a68c32005-12-15 10:11:30 +00004813
danielk1977f3f06bb2005-12-16 15:24:28 +00004814/*
drhfddfa2d2007-12-05 18:05:16 +00004815** CAPI3REF: Enable Or Disable Shared Pager Cache {F10330}
danielk1977f3f06bb2005-12-16 15:24:28 +00004816**
drh6ed48bf2007-06-14 20:57:18 +00004817** This routine enables or disables the sharing of the database cache
4818** and schema data structures between connections to the same database.
4819** Sharing is enabled if the argument is true and disabled if the argument
4820** is false.
danielk1977f3f06bb2005-12-16 15:24:28 +00004821**
drhafc91042008-02-21 02:09:45 +00004822** Cache sharing is enabled and disabled
drhf5befa02007-12-06 02:42:07 +00004823** for an entire process. {END} This is a change as of SQLite version 3.5.0.
4824** In prior versions of SQLite, sharing was
drhe30f4422007-08-21 16:15:55 +00004825** enabled or disabled for each thread separately.
drh6ed48bf2007-06-14 20:57:18 +00004826**
drhe30f4422007-08-21 16:15:55 +00004827** The cache sharing mode set by this interface effects all subsequent
4828** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()].
drhafc91042008-02-21 02:09:45 +00004829** Existing database connections continue use the sharing mode
4830** that was in effect at the time they were opened.
drh6ed48bf2007-06-14 20:57:18 +00004831**
drhafc91042008-02-21 02:09:45 +00004832** Virtual tables cannot be used with a shared cache. When shared
drh4ff7fa02007-09-01 18:17:21 +00004833** cache is enabled, the [sqlite3_create_module()] API used to register
drhafc91042008-02-21 02:09:45 +00004834** virtual tables will always return an error.
drh6ed48bf2007-06-14 20:57:18 +00004835**
drhafc91042008-02-21 02:09:45 +00004836** This routine returns [SQLITE_OK] if shared cache was
4837** enabled or disabled successfully. An [error code]
4838** is returned otherwise.
drh6ed48bf2007-06-14 20:57:18 +00004839**
drhafc91042008-02-21 02:09:45 +00004840** Shared cache is disabled by default. But this might change in
drh4ff7fa02007-09-01 18:17:21 +00004841** future releases of SQLite. Applications that care about shared
4842** cache setting should set it explicitly.
drhafc91042008-02-21 02:09:45 +00004843**
4844** INVARIANTS:
4845**
4846** {F10331} A successful invocation of [sqlite3_enable_shared_cache(B)]
4847** will enable or disable shared cache mode for any subsequently
4848** created [database connection] in the same process.
4849**
4850** {F10336} When shared cache is enabled, the [sqlite3_create_module()]
4851** interface will always return an error.
4852**
4853** {F10337} The [sqlite3_enable_shared_cache(B)] interface returns
4854** [SQLITE_OK] if shared cache was enabled or disabled successfully.
4855**
4856** {F10339} Shared cache is disabled by default.
danielk1977aef0bf62005-12-30 16:28:01 +00004857*/
4858int sqlite3_enable_shared_cache(int);
4859
4860/*
drhfddfa2d2007-12-05 18:05:16 +00004861** CAPI3REF: Attempt To Free Heap Memory {F17340}
drh6ed48bf2007-06-14 20:57:18 +00004862**
drhafc91042008-02-21 02:09:45 +00004863** The sqlite3_release_memory() interface attempts to
drhf5befa02007-12-06 02:42:07 +00004864** free N bytes of heap memory by deallocating non-essential memory
shane26b34032008-05-23 17:21:09 +00004865** allocations held by the database library. {END} Memory used
drhf5befa02007-12-06 02:42:07 +00004866** to cache database pages to improve performance is an example of
drhafc91042008-02-21 02:09:45 +00004867** non-essential memory. Sqlite3_release_memory() returns
drhf5befa02007-12-06 02:42:07 +00004868** the number of bytes actually freed, which might be more or less
4869** than the amount requested.
drhafc91042008-02-21 02:09:45 +00004870**
4871** INVARIANTS:
4872**
4873** {F17341} The [sqlite3_release_memory(N)] interface attempts to
4874** free N bytes of heap memory by deallocating non-essential
shane26b34032008-05-23 17:21:09 +00004875** memory allocations held by the database library.
drhafc91042008-02-21 02:09:45 +00004876**
4877** {F16342} The [sqlite3_release_memory(N)] returns the number
4878** of bytes actually freed, which might be more or less
4879** than the amount requested.
danielk197752622822006-01-09 09:59:49 +00004880*/
4881int sqlite3_release_memory(int);
4882
4883/*
drhfddfa2d2007-12-05 18:05:16 +00004884** CAPI3REF: Impose A Limit On Heap Size {F17350}
drh6ed48bf2007-06-14 20:57:18 +00004885**
drhafc91042008-02-21 02:09:45 +00004886** The sqlite3_soft_heap_limit() interface
drhf5befa02007-12-06 02:42:07 +00004887** places a "soft" limit on the amount of heap memory that may be allocated
drhafc91042008-02-21 02:09:45 +00004888** by SQLite. If an internal allocation is requested
drhf5befa02007-12-06 02:42:07 +00004889** that would exceed the soft heap limit, [sqlite3_release_memory()] is
drhe30f4422007-08-21 16:15:55 +00004890** invoked one or more times to free up some space before the allocation
drhafc91042008-02-21 02:09:45 +00004891** is made.
danielk197752622822006-01-09 09:59:49 +00004892**
drhafc91042008-02-21 02:09:45 +00004893** The limit is called "soft", because if
drhf5befa02007-12-06 02:42:07 +00004894** [sqlite3_release_memory()] cannot
drhe30f4422007-08-21 16:15:55 +00004895** free sufficient memory to prevent the limit from being exceeded,
4896** the memory is allocated anyway and the current operation proceeds.
drh6ed48bf2007-06-14 20:57:18 +00004897**
4898** A negative or zero value for N means that there is no soft heap limit and
drhe30f4422007-08-21 16:15:55 +00004899** [sqlite3_release_memory()] will only be called when memory is exhausted.
drhafc91042008-02-21 02:09:45 +00004900** The default value for the soft heap limit is zero.
drh6ed48bf2007-06-14 20:57:18 +00004901**
drhf5befa02007-12-06 02:42:07 +00004902** SQLite makes a best effort to honor the soft heap limit.
shane26b34032008-05-23 17:21:09 +00004903** But if the soft heap limit cannot be honored, execution will
drhafc91042008-02-21 02:09:45 +00004904** continue without error or notification. This is why the limit is
drh6ed48bf2007-06-14 20:57:18 +00004905** called a "soft" limit. It is advisory only.
4906**
drhe30f4422007-08-21 16:15:55 +00004907** Prior to SQLite version 3.5.0, this routine only constrained the memory
4908** allocated by a single thread - the same thread in which this routine
4909** runs. Beginning with SQLite version 3.5.0, the soft heap limit is
drhafc91042008-02-21 02:09:45 +00004910** applied to all threads. The value specified for the soft heap limit
4911** is an upper bound on the total memory allocation for all threads. In
drh8bacf972007-08-25 16:21:29 +00004912** version 3.5.0 there is no mechanism for limiting the heap usage for
4913** individual threads.
drhafc91042008-02-21 02:09:45 +00004914**
4915** INVARIANTS:
4916**
4917** {F16351} The [sqlite3_soft_heap_limit(N)] interface places a soft limit
4918** of N bytes on the amount of heap memory that may be allocated
4919** using [sqlite3_malloc()] or [sqlite3_realloc()] at any point
4920** in time.
4921**
4922** {F16352} If a call to [sqlite3_malloc()] or [sqlite3_realloc()] would
4923** cause the total amount of allocated memory to exceed the
4924** soft heap limit, then [sqlite3_release_memory()] is invoked
4925** in an attempt to reduce the memory usage prior to proceeding
4926** with the memory allocation attempt.
4927**
4928** {F16353} Calls to [sqlite3_malloc()] or [sqlite3_realloc()] that trigger
4929** attempts to reduce memory usage through the soft heap limit
4930** mechanism continue even if the attempt to reduce memory
4931** usage is unsuccessful.
4932**
4933** {F16354} A negative or zero value for N in a call to
4934** [sqlite3_soft_heap_limit(N)] means that there is no soft
4935** heap limit and [sqlite3_release_memory()] will only be
4936** called when memory is completely exhausted.
4937**
4938** {F16355} The default value for the soft heap limit is zero.
4939**
4940** {F16358} Each call to [sqlite3_soft_heap_limit(N)] overrides the
4941** values set by all prior calls.
danielk197752622822006-01-09 09:59:49 +00004942*/
drhd2d4a6b2006-01-10 15:18:27 +00004943void sqlite3_soft_heap_limit(int);
danielk197752622822006-01-09 09:59:49 +00004944
4945/*
drhfddfa2d2007-12-05 18:05:16 +00004946** CAPI3REF: Extract Metadata About A Column Of A Table {F12850}
drh6ed48bf2007-06-14 20:57:18 +00004947**
4948** This routine
4949** returns meta-data about a specific column of a specific database
danielk1977deb802c2006-02-09 13:43:28 +00004950** table accessible using the connection handle passed as the first function
4951** argument.
4952**
4953** The column is identified by the second, third and fourth parameters to
4954** this function. The second parameter is either the name of the database
4955** (i.e. "main", "temp" or an attached database) containing the specified
4956** table or NULL. If it is NULL, then all attached databases are searched
4957** for the table using the same algorithm as the database engine uses to
4958** resolve unqualified table references.
4959**
4960** The third and fourth parameters to this function are the table and column
4961** name of the desired column, respectively. Neither of these parameters
4962** may be NULL.
4963**
4964** Meta information is returned by writing to the memory locations passed as
4965** the 5th and subsequent parameters to this function. Any of these
4966** arguments may be NULL, in which case the corresponding element of meta
shane26b34032008-05-23 17:21:09 +00004967** information is omitted.
danielk1977deb802c2006-02-09 13:43:28 +00004968**
drh6ed48bf2007-06-14 20:57:18 +00004969** <pre>
danielk1977deb802c2006-02-09 13:43:28 +00004970** Parameter Output Type Description
4971** -----------------------------------
4972**
4973** 5th const char* Data type
4974** 6th const char* Name of the default collation sequence
4975** 7th int True if the column has a NOT NULL constraint
4976** 8th int True if the column is part of the PRIMARY KEY
4977** 9th int True if the column is AUTOINCREMENT
drh6ed48bf2007-06-14 20:57:18 +00004978** </pre>
danielk1977deb802c2006-02-09 13:43:28 +00004979**
4980**
4981** The memory pointed to by the character pointers returned for the
4982** declaration type and collation sequence is valid only until the next
4983** call to any sqlite API function.
4984**
4985** If the specified table is actually a view, then an error is returned.
4986**
4987** If the specified column is "rowid", "oid" or "_rowid_" and an
4988** INTEGER PRIMARY KEY column has been explicitly declared, then the output
4989** parameters are set for the explicitly declared column. If there is no
4990** explicitly declared IPK column, then the output parameters are set as
4991** follows:
4992**
drh6ed48bf2007-06-14 20:57:18 +00004993** <pre>
danielk1977deb802c2006-02-09 13:43:28 +00004994** data type: "INTEGER"
4995** collation sequence: "BINARY"
4996** not null: 0
4997** primary key: 1
4998** auto increment: 0
drh6ed48bf2007-06-14 20:57:18 +00004999** </pre>
danielk1977deb802c2006-02-09 13:43:28 +00005000**
5001** This function may load one or more schemas from database files. If an
5002** error occurs during this process, or if the requested table or column
5003** cannot be found, an SQLITE error code is returned and an error message
5004** left in the database handle (to be retrieved using sqlite3_errmsg()).
danielk19774b1ae992006-02-10 03:06:10 +00005005**
5006** This API is only available if the library was compiled with the
5007** SQLITE_ENABLE_COLUMN_METADATA preprocessor symbol defined.
danielk1977deb802c2006-02-09 13:43:28 +00005008*/
5009int sqlite3_table_column_metadata(
5010 sqlite3 *db, /* Connection handle */
5011 const char *zDbName, /* Database name or NULL */
5012 const char *zTableName, /* Table name */
5013 const char *zColumnName, /* Column name */
5014 char const **pzDataType, /* OUTPUT: Declared data type */
5015 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
5016 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
5017 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh98c94802007-10-01 13:50:31 +00005018 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00005019);
5020
5021/*
drhfddfa2d2007-12-05 18:05:16 +00005022** CAPI3REF: Load An Extension {F12600}
drh1e397f82006-06-08 15:28:43 +00005023**
drhf5befa02007-12-06 02:42:07 +00005024** {F12601} The sqlite3_load_extension() interface
5025** attempts to load an SQLite extension library contained in the file
5026** zFile. {F12602} The entry point is zProc. {F12603} zProc may be 0
5027** in which case the name of the entry point defaults
5028** to "sqlite3_extension_init".
drh1e397f82006-06-08 15:28:43 +00005029**
drhf5befa02007-12-06 02:42:07 +00005030** {F12604} The sqlite3_load_extension() interface shall
5031** return [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.
drh1e397f82006-06-08 15:28:43 +00005032**
drhf5befa02007-12-06 02:42:07 +00005033** {F12605}
5034** If an error occurs and pzErrMsg is not 0, then the
5035** sqlite3_load_extension() interface shall attempt to fill *pzErrMsg with
5036** error message text stored in memory obtained from [sqlite3_malloc()].
5037** {END} The calling function should free this memory
drh6ed48bf2007-06-14 20:57:18 +00005038** by calling [sqlite3_free()].
drh1e397f82006-06-08 15:28:43 +00005039**
drhf5befa02007-12-06 02:42:07 +00005040** {F12606}
drh6ed48bf2007-06-14 20:57:18 +00005041** Extension loading must be enabled using [sqlite3_enable_load_extension()]
drhc2e87a32006-06-27 15:16:14 +00005042** prior to calling this API or an error will be returned.
drh1e397f82006-06-08 15:28:43 +00005043*/
5044int sqlite3_load_extension(
5045 sqlite3 *db, /* Load the extension into this database connection */
5046 const char *zFile, /* Name of the shared library containing extension */
5047 const char *zProc, /* Entry point. Derived from zFile if 0 */
5048 char **pzErrMsg /* Put error message here if not 0 */
5049);
5050
5051/*
drhfddfa2d2007-12-05 18:05:16 +00005052** CAPI3REF: Enable Or Disable Extension Loading {F12620}
drh6ed48bf2007-06-14 20:57:18 +00005053**
drhc2e87a32006-06-27 15:16:14 +00005054** So as not to open security holes in older applications that are
drh6ed48bf2007-06-14 20:57:18 +00005055** unprepared to deal with extension loading, and as a means of disabling
5056** extension loading while evaluating user-entered SQL, the following
5057** API is provided to turn the [sqlite3_load_extension()] mechanism on and
drhf5befa02007-12-06 02:42:07 +00005058** off. {F12622} It is off by default. {END} See ticket #1863.
drhc2e87a32006-06-27 15:16:14 +00005059**
drhf5befa02007-12-06 02:42:07 +00005060** {F12621} Call the sqlite3_enable_load_extension() routine
5061** with onoff==1 to turn extension loading on
5062** and call it with onoff==0 to turn it back off again. {END}
drhc2e87a32006-06-27 15:16:14 +00005063*/
5064int sqlite3_enable_load_extension(sqlite3 *db, int onoff);
5065
5066/*
drhfddfa2d2007-12-05 18:05:16 +00005067** CAPI3REF: Make Arrangements To Automatically Load An Extension {F12640}
drh9eff6162006-06-12 21:59:13 +00005068**
drhf5befa02007-12-06 02:42:07 +00005069** {F12641} This function
5070** registers an extension entry point that is automatically invoked
drh6ed48bf2007-06-14 20:57:18 +00005071** whenever a new database connection is opened using
drhf5befa02007-12-06 02:42:07 +00005072** [sqlite3_open()], [sqlite3_open16()], or [sqlite3_open_v2()]. {END}
drh1409be62006-08-23 20:07:20 +00005073**
5074** This API can be invoked at program startup in order to register
5075** one or more statically linked extensions that will be available
5076** to all new database connections.
5077**
drhf5befa02007-12-06 02:42:07 +00005078** {F12642} Duplicate extensions are detected so calling this routine multiple
drh1409be62006-08-23 20:07:20 +00005079** times with the same extension is harmless.
5080**
drhf5befa02007-12-06 02:42:07 +00005081** {F12643} This routine stores a pointer to the extension in an array
5082** that is obtained from sqlite_malloc(). {END} If you run a memory leak
drh1409be62006-08-23 20:07:20 +00005083** checker on your program and it reports a leak because of this
drhcfa063b2007-11-21 15:24:00 +00005084** array, then invoke [sqlite3_reset_auto_extension()] prior
drh1409be62006-08-23 20:07:20 +00005085** to shutdown to free the memory.
5086**
drhf5befa02007-12-06 02:42:07 +00005087** {F12644} Automatic extensions apply across all threads. {END}
drh6ed48bf2007-06-14 20:57:18 +00005088**
5089** This interface is experimental and is subject to change or
5090** removal in future releases of SQLite.
drh1409be62006-08-23 20:07:20 +00005091*/
5092int sqlite3_auto_extension(void *xEntryPoint);
5093
5094
5095/*
drhfddfa2d2007-12-05 18:05:16 +00005096** CAPI3REF: Reset Automatic Extension Loading {F12660}
drh1409be62006-08-23 20:07:20 +00005097**
drhf5befa02007-12-06 02:42:07 +00005098** {F12661} This function disables all previously registered
5099** automatic extensions. {END} This
drh21ac7f92008-01-31 12:26:49 +00005100** routine undoes the effect of all prior [sqlite3_auto_extension()]
drh1409be62006-08-23 20:07:20 +00005101** calls.
5102**
drhf5befa02007-12-06 02:42:07 +00005103** {F12662} This call disabled automatic extensions in all threads. {END}
drh6ed48bf2007-06-14 20:57:18 +00005104**
5105** This interface is experimental and is subject to change or
5106** removal in future releases of SQLite.
drh1409be62006-08-23 20:07:20 +00005107*/
5108void sqlite3_reset_auto_extension(void);
5109
5110
5111/*
5112****** EXPERIMENTAL - subject to change without notice **************
5113**
drh9eff6162006-06-12 21:59:13 +00005114** The interface to the virtual-table mechanism is currently considered
5115** to be experimental. The interface might change in incompatible ways.
5116** If this is a problem for you, do not use the interface at this time.
5117**
shane26b34032008-05-23 17:21:09 +00005118** When the virtual-table mechanism stabilizes, we will declare the
drh9eff6162006-06-12 21:59:13 +00005119** interface fixed, support it indefinitely, and remove this comment.
5120*/
5121
5122/*
5123** Structures used by the virtual table interface
drhe09daa92006-06-10 13:29:31 +00005124*/
5125typedef struct sqlite3_vtab sqlite3_vtab;
5126typedef struct sqlite3_index_info sqlite3_index_info;
5127typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor;
5128typedef struct sqlite3_module sqlite3_module;
drh9eff6162006-06-12 21:59:13 +00005129
5130/*
drhb4d58ae2008-02-21 20:17:06 +00005131** CAPI3REF: Virtual Table Object {F18000}
5132** KEYWORDS: sqlite3_module
5133**
drh9eff6162006-06-12 21:59:13 +00005134** A module is a class of virtual tables. Each module is defined
5135** by an instance of the following structure. This structure consists
5136** mostly of methods for the module.
5137*/
drhe09daa92006-06-10 13:29:31 +00005138struct sqlite3_module {
5139 int iVersion;
danielk19779da9d472006-06-14 06:58:15 +00005140 int (*xCreate)(sqlite3*, void *pAux,
drhe4102962006-09-11 00:34:22 +00005141 int argc, const char *const*argv,
drh4ca8aac2006-09-10 17:31:58 +00005142 sqlite3_vtab **ppVTab, char**);
danielk19779da9d472006-06-14 06:58:15 +00005143 int (*xConnect)(sqlite3*, void *pAux,
drhe4102962006-09-11 00:34:22 +00005144 int argc, const char *const*argv,
drh4ca8aac2006-09-10 17:31:58 +00005145 sqlite3_vtab **ppVTab, char**);
drhe09daa92006-06-10 13:29:31 +00005146 int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*);
5147 int (*xDisconnect)(sqlite3_vtab *pVTab);
5148 int (*xDestroy)(sqlite3_vtab *pVTab);
5149 int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor);
5150 int (*xClose)(sqlite3_vtab_cursor*);
drh4be8b512006-06-13 23:51:34 +00005151 int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr,
drhe09daa92006-06-10 13:29:31 +00005152 int argc, sqlite3_value **argv);
5153 int (*xNext)(sqlite3_vtab_cursor*);
danielk1977a298e902006-06-22 09:53:48 +00005154 int (*xEof)(sqlite3_vtab_cursor*);
drhe09daa92006-06-10 13:29:31 +00005155 int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int);
drh6d2069d2007-08-14 01:58:53 +00005156 int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid);
5157 int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *);
drhe09daa92006-06-10 13:29:31 +00005158 int (*xBegin)(sqlite3_vtab *pVTab);
5159 int (*xSync)(sqlite3_vtab *pVTab);
5160 int (*xCommit)(sqlite3_vtab *pVTab);
5161 int (*xRollback)(sqlite3_vtab *pVTab);
drhb7f6f682006-07-08 17:06:43 +00005162 int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName,
drhe94b0c32006-07-08 18:09:15 +00005163 void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),
5164 void **ppArg);
danielk1977182c4ba2007-06-27 15:53:34 +00005165
5166 int (*xRename)(sqlite3_vtab *pVtab, const char *zNew);
drhe09daa92006-06-10 13:29:31 +00005167};
drh9eff6162006-06-12 21:59:13 +00005168
5169/*
drhb4d58ae2008-02-21 20:17:06 +00005170** CAPI3REF: Virtual Table Indexing Information {F18100}
5171** KEYWORDS: sqlite3_index_info
5172**
drh9eff6162006-06-12 21:59:13 +00005173** The sqlite3_index_info structure and its substructures is used to
5174** pass information into and receive the reply from the xBestIndex
5175** method of an sqlite3_module. The fields under **Inputs** are the
5176** inputs to xBestIndex and are read-only. xBestIndex inserts its
5177** results into the **Outputs** fields.
5178**
5179** The aConstraint[] array records WHERE clause constraints of the
5180** form:
5181**
5182** column OP expr
5183**
drhfddfa2d2007-12-05 18:05:16 +00005184** Where OP is =, &lt;, &lt;=, &gt;, or &gt;=.
5185** The particular operator is stored
drh9eff6162006-06-12 21:59:13 +00005186** in aConstraint[].op. The index of the column is stored in
5187** aConstraint[].iColumn. aConstraint[].usable is TRUE if the
5188** expr on the right-hand side can be evaluated (and thus the constraint
5189** is usable) and false if it cannot.
5190**
5191** The optimizer automatically inverts terms of the form "expr OP column"
drh98c94802007-10-01 13:50:31 +00005192** and makes other simplifications to the WHERE clause in an attempt to
drh9eff6162006-06-12 21:59:13 +00005193** get as many WHERE clause terms into the form shown above as possible.
5194** The aConstraint[] array only reports WHERE clause terms in the correct
5195** form that refer to the particular virtual table being queried.
5196**
5197** Information about the ORDER BY clause is stored in aOrderBy[].
5198** Each term of aOrderBy records a column of the ORDER BY clause.
5199**
5200** The xBestIndex method must fill aConstraintUsage[] with information
danielk19775fac9f82006-06-13 14:16:58 +00005201** about what parameters to pass to xFilter. If argvIndex>0 then
drh9eff6162006-06-12 21:59:13 +00005202** the right-hand side of the corresponding aConstraint[] is evaluated
5203** and becomes the argvIndex-th entry in argv. If aConstraintUsage[].omit
5204** is true, then the constraint is assumed to be fully handled by the
5205** virtual table and is not checked again by SQLite.
5206**
drh4be8b512006-06-13 23:51:34 +00005207** The idxNum and idxPtr values are recorded and passed into xFilter.
5208** sqlite3_free() is used to free idxPtr if needToFreeIdxPtr is true.
drh9eff6162006-06-12 21:59:13 +00005209**
5210** The orderByConsumed means that output from xFilter will occur in
5211** the correct order to satisfy the ORDER BY clause so that no separate
5212** sorting step is required.
5213**
5214** The estimatedCost value is an estimate of the cost of doing the
5215** particular lookup. A full scan of a table with N entries should have
5216** a cost of N. A binary search of a table of N entries should have a
5217** cost of approximately log(N).
5218*/
drhe09daa92006-06-10 13:29:31 +00005219struct sqlite3_index_info {
5220 /* Inputs */
drh6cca08c2007-09-21 12:43:16 +00005221 int nConstraint; /* Number of entries in aConstraint */
5222 struct sqlite3_index_constraint {
drh9eff6162006-06-12 21:59:13 +00005223 int iColumn; /* Column on left-hand side of constraint */
5224 unsigned char op; /* Constraint operator */
5225 unsigned char usable; /* True if this constraint is usable */
5226 int iTermOffset; /* Used internally - xBestIndex should ignore */
drh6cca08c2007-09-21 12:43:16 +00005227 } *aConstraint; /* Table of WHERE clause constraints */
5228 int nOrderBy; /* Number of terms in the ORDER BY clause */
5229 struct sqlite3_index_orderby {
drh9eff6162006-06-12 21:59:13 +00005230 int iColumn; /* Column number */
5231 unsigned char desc; /* True for DESC. False for ASC. */
drh6cca08c2007-09-21 12:43:16 +00005232 } *aOrderBy; /* The ORDER BY clause */
drhe09daa92006-06-10 13:29:31 +00005233
5234 /* Outputs */
drh9eff6162006-06-12 21:59:13 +00005235 struct sqlite3_index_constraint_usage {
5236 int argvIndex; /* if >0, constraint is part of argv to xFilter */
5237 unsigned char omit; /* Do not code a test for this constraint */
drh6cca08c2007-09-21 12:43:16 +00005238 } *aConstraintUsage;
drh4be8b512006-06-13 23:51:34 +00005239 int idxNum; /* Number used to identify the index */
5240 char *idxStr; /* String, possibly obtained from sqlite3_malloc */
5241 int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */
drh9eff6162006-06-12 21:59:13 +00005242 int orderByConsumed; /* True if output is already ordered */
5243 double estimatedCost; /* Estimated cost of using this index */
drhe09daa92006-06-10 13:29:31 +00005244};
drh9eff6162006-06-12 21:59:13 +00005245#define SQLITE_INDEX_CONSTRAINT_EQ 2
5246#define SQLITE_INDEX_CONSTRAINT_GT 4
5247#define SQLITE_INDEX_CONSTRAINT_LE 8
5248#define SQLITE_INDEX_CONSTRAINT_LT 16
5249#define SQLITE_INDEX_CONSTRAINT_GE 32
5250#define SQLITE_INDEX_CONSTRAINT_MATCH 64
5251
5252/*
drhb4d58ae2008-02-21 20:17:06 +00005253** CAPI3REF: Register A Virtual Table Implementation {F18200}
5254**
drh9eff6162006-06-12 21:59:13 +00005255** This routine is used to register a new module name with an SQLite
5256** connection. Module names must be registered before creating new
5257** virtual tables on the module, or before using preexisting virtual
5258** tables of the module.
5259*/
drhb9bb7c12006-06-11 23:41:55 +00005260int sqlite3_create_module(
drh9eff6162006-06-12 21:59:13 +00005261 sqlite3 *db, /* SQLite connection to register module with */
5262 const char *zName, /* Name of the module */
danielk1977d1ab1ba2006-06-15 04:28:13 +00005263 const sqlite3_module *, /* Methods for the module */
5264 void * /* Client data for xCreate/xConnect */
drhb9bb7c12006-06-11 23:41:55 +00005265);
drhe09daa92006-06-10 13:29:31 +00005266
drh9eff6162006-06-12 21:59:13 +00005267/*
drhb4d58ae2008-02-21 20:17:06 +00005268** CAPI3REF: Register A Virtual Table Implementation {F18210}
5269**
danielk1977832a58a2007-06-22 15:21:15 +00005270** This routine is identical to the sqlite3_create_module() method above,
5271** except that it allows a destructor function to be specified. It is
5272** even more experimental than the rest of the virtual tables API.
5273*/
5274int sqlite3_create_module_v2(
5275 sqlite3 *db, /* SQLite connection to register module with */
5276 const char *zName, /* Name of the module */
5277 const sqlite3_module *, /* Methods for the module */
5278 void *, /* Client data for xCreate/xConnect */
5279 void(*xDestroy)(void*) /* Module destructor function */
5280);
5281
5282/*
drhb4d58ae2008-02-21 20:17:06 +00005283** CAPI3REF: Virtual Table Instance Object {F18010}
5284** KEYWORDS: sqlite3_vtab
5285**
drh9eff6162006-06-12 21:59:13 +00005286** Every module implementation uses a subclass of the following structure
5287** to describe a particular instance of the module. Each subclass will
drh98c94802007-10-01 13:50:31 +00005288** be tailored to the specific needs of the module implementation. The
drh9eff6162006-06-12 21:59:13 +00005289** purpose of this superclass is to define certain fields that are common
5290** to all module implementations.
drhfe1368e2006-09-10 17:08:29 +00005291**
5292** Virtual tables methods can set an error message by assigning a
5293** string obtained from sqlite3_mprintf() to zErrMsg. The method should
5294** take care that any prior string is freed by a call to sqlite3_free()
5295** prior to assigning a new string to zErrMsg. After the error message
5296** is delivered up to the client application, the string will be automatically
5297** freed by sqlite3_free() and the zErrMsg field will be zeroed. Note
5298** that sqlite3_mprintf() and sqlite3_free() are used on the zErrMsg field
5299** since virtual tables are commonly implemented in loadable extensions which
5300** do not have access to sqlite3MPrintf() or sqlite3Free().
drh9eff6162006-06-12 21:59:13 +00005301*/
5302struct sqlite3_vtab {
drha967e882006-06-13 01:04:52 +00005303 const sqlite3_module *pModule; /* The module for this virtual table */
danielk1977be718892006-06-23 08:05:19 +00005304 int nRef; /* Used internally */
drh4ca8aac2006-09-10 17:31:58 +00005305 char *zErrMsg; /* Error message from sqlite3_mprintf() */
drh9eff6162006-06-12 21:59:13 +00005306 /* Virtual table implementations will typically add additional fields */
5307};
5308
drhb4d58ae2008-02-21 20:17:06 +00005309/*
5310** CAPI3REF: Virtual Table Cursor Object {F18020}
5311** KEYWORDS: sqlite3_vtab_cursor
5312**
5313** Every module implementation uses a subclass of the following structure
drh9eff6162006-06-12 21:59:13 +00005314** to describe cursors that point into the virtual table and are used
5315** to loop through the virtual table. Cursors are created using the
5316** xOpen method of the module. Each module implementation will define
5317** the content of a cursor structure to suit its own needs.
5318**
5319** This superclass exists in order to define fields of the cursor that
5320** are common to all implementations.
5321*/
5322struct sqlite3_vtab_cursor {
5323 sqlite3_vtab *pVtab; /* Virtual table of this cursor */
5324 /* Virtual table implementations will typically add additional fields */
5325};
5326
5327/*
drhb4d58ae2008-02-21 20:17:06 +00005328** CAPI3REF: Declare The Schema Of A Virtual Table {F18280}
5329**
drh9eff6162006-06-12 21:59:13 +00005330** The xCreate and xConnect methods of a module use the following API
5331** to declare the format (the names and datatypes of the columns) of
5332** the virtual tables they implement.
5333*/
danielk19777e6ebfb2006-06-12 11:24:37 +00005334int sqlite3_declare_vtab(sqlite3*, const char *zCreateTable);
drhe09daa92006-06-10 13:29:31 +00005335
5336/*
drhb4d58ae2008-02-21 20:17:06 +00005337** CAPI3REF: Overload A Function For A Virtual Table {F18300}
5338**
drhb7481e72006-09-16 21:45:14 +00005339** Virtual tables can provide alternative implementations of functions
5340** using the xFindFunction method. But global versions of those functions
5341** must exist in order to be overloaded.
5342**
5343** This API makes sure a global version of a function with a particular
5344** name and number of parameters exists. If no such function exists
5345** before this API is called, a new function is created. The implementation
5346** of the new function always causes an exception to be thrown. So
5347** the new function is not good for anything by itself. Its only
shane26b34032008-05-23 17:21:09 +00005348** purpose is to be a placeholder function that can be overloaded
drhb7481e72006-09-16 21:45:14 +00005349** by virtual tables.
5350**
5351** This API should be considered part of the virtual table interface,
5352** which is experimental and subject to change.
5353*/
5354int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg);
5355
5356/*
drh9eff6162006-06-12 21:59:13 +00005357** The interface to the virtual-table mechanism defined above (back up
5358** to a comment remarkably similar to this one) is currently considered
5359** to be experimental. The interface might change in incompatible ways.
5360** If this is a problem for you, do not use the interface at this time.
5361**
drh98c94802007-10-01 13:50:31 +00005362** When the virtual-table mechanism stabilizes, we will declare the
drh9eff6162006-06-12 21:59:13 +00005363** interface fixed, support it indefinitely, and remove this comment.
5364**
5365****** EXPERIMENTAL - subject to change without notice **************
5366*/
5367
danielk19778cbadb02007-05-03 16:31:26 +00005368/*
drhfddfa2d2007-12-05 18:05:16 +00005369** CAPI3REF: A Handle To An Open BLOB {F17800}
drh6ed48bf2007-06-14 20:57:18 +00005370**
drhb4d58ae2008-02-21 20:17:06 +00005371** An instance of this object represents an open BLOB on which
5372** incremental I/O can be preformed.
5373** Objects of this type are created by
drh6ed48bf2007-06-14 20:57:18 +00005374** [sqlite3_blob_open()] and destroyed by [sqlite3_blob_close()].
5375** The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces
5376** can be used to read or write small subsections of the blob.
drh79491ab2007-09-04 12:00:00 +00005377** The [sqlite3_blob_bytes()] interface returns the size of the
drh6ed48bf2007-06-14 20:57:18 +00005378** blob in bytes.
danielk19778cbadb02007-05-03 16:31:26 +00005379*/
danielk1977b4e9af92007-05-01 17:49:49 +00005380typedef struct sqlite3_blob sqlite3_blob;
5381
danielk19778cbadb02007-05-03 16:31:26 +00005382/*
drhfddfa2d2007-12-05 18:05:16 +00005383** CAPI3REF: Open A BLOB For Incremental I/O {F17810}
drh6ed48bf2007-06-14 20:57:18 +00005384**
drhb4d58ae2008-02-21 20:17:06 +00005385** This interfaces opens a handle to the blob located
drhf84ddc12008-03-24 12:51:46 +00005386** in row iRow, column zColumn, table zTable in database zDb;
drhf5befa02007-12-06 02:42:07 +00005387** in other words, the same blob that would be selected by:
danielk19778cbadb02007-05-03 16:31:26 +00005388**
drh6ed48bf2007-06-14 20:57:18 +00005389** <pre>
5390** SELECT zColumn FROM zDb.zTable WHERE rowid = iRow;
drhf5befa02007-12-06 02:42:07 +00005391** </pre> {END}
danielk19778cbadb02007-05-03 16:31:26 +00005392**
drhb4d58ae2008-02-21 20:17:06 +00005393** If the flags parameter is non-zero, the blob is opened for
danielk19778cbadb02007-05-03 16:31:26 +00005394** read and write access. If it is zero, the blob is opened for read
drhb4d58ae2008-02-21 20:17:06 +00005395** access.
danielk19778cbadb02007-05-03 16:31:26 +00005396**
drhf84ddc12008-03-24 12:51:46 +00005397** Note that the database name is not the filename that contains
5398** the database but rather the symbolic name of the database that
5399** is assigned when the database is connected using [ATTACH].
5400** For the main database file, the database name is "main". For
5401** TEMP tables, the database name is "temp".
5402**
drhb4d58ae2008-02-21 20:17:06 +00005403** On success, [SQLITE_OK] is returned and the new
drhf5befa02007-12-06 02:42:07 +00005404** [sqlite3_blob | blob handle] is written to *ppBlob.
drhb4d58ae2008-02-21 20:17:06 +00005405** Otherwise an error code is returned and
danielk19778cbadb02007-05-03 16:31:26 +00005406** any value written to *ppBlob should not be used by the caller.
drhb4d58ae2008-02-21 20:17:06 +00005407** This function sets the database-handle error code and message
drh6ed48bf2007-06-14 20:57:18 +00005408** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()].
drhb4d58ae2008-02-21 20:17:06 +00005409**
5410** INVARIANTS:
5411**
5412** {F17813} A successful invocation of the [sqlite3_blob_open(D,B,T,C,R,F,P)]
5413** interface opens an [sqlite3_blob] object P on the blob
5414** in column C of table T in database B on [database connection] D.
5415**
5416** {F17814} A successful invocation of [sqlite3_blob_open(D,...)] starts
5417** a new transaction on [database connection] D if that connection
5418** is not already in a transaction.
5419**
5420** {F17816} The [sqlite3_blob_open(D,B,T,C,R,F,P)] interface opens the blob
5421** for read and write access if and only if the F parameter
5422** is non-zero.
5423**
5424** {F17819} The [sqlite3_blob_open()] interface returns [SQLITE_OK] on
5425** success and an appropriate [error code] on failure.
5426**
5427** {F17821} If an error occurs during evaluation of [sqlite3_blob_open(D,...)]
5428** then subsequent calls to [sqlite3_errcode(D)],
5429** [sqlite3_errmsg(D)], and [sqlite3_errmsg16(D)] will return
shane26b34032008-05-23 17:21:09 +00005430** information appropriate for that error.
danielk19778cbadb02007-05-03 16:31:26 +00005431*/
danielk1977b4e9af92007-05-01 17:49:49 +00005432int sqlite3_blob_open(
5433 sqlite3*,
5434 const char *zDb,
5435 const char *zTable,
5436 const char *zColumn,
drh6d2069d2007-08-14 01:58:53 +00005437 sqlite3_int64 iRow,
danielk1977b4e9af92007-05-01 17:49:49 +00005438 int flags,
5439 sqlite3_blob **ppBlob
5440);
5441
danielk19778cbadb02007-05-03 16:31:26 +00005442/*
drhfddfa2d2007-12-05 18:05:16 +00005443** CAPI3REF: Close A BLOB Handle {F17830}
drh6ed48bf2007-06-14 20:57:18 +00005444**
5445** Close an open [sqlite3_blob | blob handle].
drh2dd62be2007-12-04 13:22:43 +00005446**
drhb4d58ae2008-02-21 20:17:06 +00005447** Closing a BLOB shall cause the current transaction to commit
drhf5befa02007-12-06 02:42:07 +00005448** if there are no other BLOBs, no pending prepared statements, and the
5449** database connection is in autocommit mode.
drhb4d58ae2008-02-21 20:17:06 +00005450** If any writes were made to the BLOB, they might be held in cache
drhf5befa02007-12-06 02:42:07 +00005451** until the close operation if they will fit. {END}
5452** Closing the BLOB often forces the changes
drh2dd62be2007-12-04 13:22:43 +00005453** out to disk and so if any I/O errors occur, they will likely occur
drhf5befa02007-12-06 02:42:07 +00005454** at the time when the BLOB is closed. {F17833} Any errors that occur during
drh2dd62be2007-12-04 13:22:43 +00005455** closing are reported as a non-zero return value.
5456**
drhb4d58ae2008-02-21 20:17:06 +00005457** The BLOB is closed unconditionally. Even if this routine returns
drh2dd62be2007-12-04 13:22:43 +00005458** an error code, the BLOB is still closed.
drhb4d58ae2008-02-21 20:17:06 +00005459**
5460** INVARIANTS:
5461**
5462** {F17833} The [sqlite3_blob_close(P)] interface closes an
5463** [sqlite3_blob] object P previously opened using
5464** [sqlite3_blob_open()].
5465**
5466** {F17836} Closing an [sqlite3_blob] object using
5467** [sqlite3_blob_close()] shall cause the current transaction to
5468** commit if there are no other open [sqlite3_blob] objects
5469** or [prepared statements] on the same [database connection] and
5470** the [database connection] is in
5471** [sqlite3_get_autocommit | autocommit mode].
5472**
5473** {F17839} The [sqlite3_blob_close(P)] interfaces closes the
5474** [sqlite3_blob] object P unconditionally, even if
5475** [sqlite3_blob_close(P)] returns something other than [SQLITE_OK].
5476**
danielk19778cbadb02007-05-03 16:31:26 +00005477*/
danielk1977b4e9af92007-05-01 17:49:49 +00005478int sqlite3_blob_close(sqlite3_blob *);
5479
danielk19778cbadb02007-05-03 16:31:26 +00005480/*
drhb4d58ae2008-02-21 20:17:06 +00005481** CAPI3REF: Return The Size Of An Open BLOB {F17840}
drh6ed48bf2007-06-14 20:57:18 +00005482**
drhb4d58ae2008-02-21 20:17:06 +00005483** Return the size in bytes of the blob accessible via the open
5484** [sqlite3_blob] object in its only argument.
5485**
5486** INVARIANTS:
5487**
5488** {F17843} The [sqlite3_blob_bytes(P)] interface returns the size
5489** in bytes of the BLOB that the [sqlite3_blob] object P
5490** refers to.
danielk19778cbadb02007-05-03 16:31:26 +00005491*/
danielk1977b4e9af92007-05-01 17:49:49 +00005492int sqlite3_blob_bytes(sqlite3_blob *);
5493
drh9eff6162006-06-12 21:59:13 +00005494/*
drhfddfa2d2007-12-05 18:05:16 +00005495** CAPI3REF: Read Data From A BLOB Incrementally {F17850}
drh6ed48bf2007-06-14 20:57:18 +00005496**
5497** This function is used to read data from an open
5498** [sqlite3_blob | blob-handle] into a caller supplied buffer.
drhb4d58ae2008-02-21 20:17:06 +00005499** N bytes of data are copied into buffer
5500** Z from the open blob, starting at offset iOffset.
danielk19778cbadb02007-05-03 16:31:26 +00005501**
drhb4d58ae2008-02-21 20:17:06 +00005502** If offset iOffset is less than N bytes from the end of the blob,
5503** [SQLITE_ERROR] is returned and no data is read. If N or iOffset is
drhf5befa02007-12-06 02:42:07 +00005504** less than zero [SQLITE_ERROR] is returned and no data is read.
5505**
drhb4d58ae2008-02-21 20:17:06 +00005506** On success, SQLITE_OK is returned. Otherwise, an
drh33c1be32008-01-30 16:16:14 +00005507** [error code] or an [extended error code] is returned.
drhb4d58ae2008-02-21 20:17:06 +00005508**
5509** INVARIANTS:
5510**
5511** {F17853} The [sqlite3_blob_read(P,Z,N,X)] interface reads N bytes
5512** beginning at offset X from
5513** the blob that [sqlite3_blob] object P refers to
5514** and writes those N bytes into buffer Z.
5515**
5516** {F17856} In [sqlite3_blob_read(P,Z,N,X)] if the size of the blob
5517** is less than N+X bytes, then the function returns [SQLITE_ERROR]
5518** and nothing is read from the blob.
5519**
5520** {F17859} In [sqlite3_blob_read(P,Z,N,X)] if X or N is less than zero
5521** then the function returns [SQLITE_ERROR]
5522** and nothing is read from the blob.
5523**
5524** {F17862} The [sqlite3_blob_read(P,Z,N,X)] interface returns [SQLITE_OK]
5525** if N bytes where successfully read into buffer Z.
5526**
5527** {F17865} If the requested read could not be completed,
5528** the [sqlite3_blob_read(P,Z,N,X)] interface returns an
5529** appropriate [error code] or [extended error code].
5530**
danielk19779eca0812008-04-24 08:56:54 +00005531** {F17868} If an error occurs during evaluation of [sqlite3_blob_read(P,...)]
drhb4d58ae2008-02-21 20:17:06 +00005532** then subsequent calls to [sqlite3_errcode(D)],
5533** [sqlite3_errmsg(D)], and [sqlite3_errmsg16(D)] will return
shane26b34032008-05-23 17:21:09 +00005534** information appropriate for that error, where D is the
danielk19779eca0812008-04-24 08:56:54 +00005535** database handle that was used to open blob handle P.
danielk19778cbadb02007-05-03 16:31:26 +00005536*/
drhb4d58ae2008-02-21 20:17:06 +00005537int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset);
danielk19778cbadb02007-05-03 16:31:26 +00005538
5539/*
drhfddfa2d2007-12-05 18:05:16 +00005540** CAPI3REF: Write Data Into A BLOB Incrementally {F17870}
drh6ed48bf2007-06-14 20:57:18 +00005541**
5542** This function is used to write data into an open
5543** [sqlite3_blob | blob-handle] from a user supplied buffer.
drhb4d58ae2008-02-21 20:17:06 +00005544** n bytes of data are copied from the buffer
danielk19778cbadb02007-05-03 16:31:26 +00005545** pointed to by z into the open blob, starting at offset iOffset.
5546**
drhb4d58ae2008-02-21 20:17:06 +00005547** If the [sqlite3_blob | blob-handle] passed as the first argument
drh6ed48bf2007-06-14 20:57:18 +00005548** was not opened for writing (the flags parameter to [sqlite3_blob_open()]
5549*** was zero), this function returns [SQLITE_READONLY].
danielk19778cbadb02007-05-03 16:31:26 +00005550**
drhb4d58ae2008-02-21 20:17:06 +00005551** This function may only modify the contents of the blob; it is
drhf5befa02007-12-06 02:42:07 +00005552** not possible to increase the size of a blob using this API.
drhb4d58ae2008-02-21 20:17:06 +00005553** If offset iOffset is less than n bytes from the end of the blob,
5554** [SQLITE_ERROR] is returned and no data is written. If n is
drhf5befa02007-12-06 02:42:07 +00005555** less than zero [SQLITE_ERROR] is returned and no data is written.
danielk19778cbadb02007-05-03 16:31:26 +00005556**
drhb4d58ae2008-02-21 20:17:06 +00005557** On success, SQLITE_OK is returned. Otherwise, an
drh33c1be32008-01-30 16:16:14 +00005558** [error code] or an [extended error code] is returned.
drhb4d58ae2008-02-21 20:17:06 +00005559**
5560** INVARIANTS:
5561**
5562** {F17873} The [sqlite3_blob_write(P,Z,N,X)] interface writes N bytes
5563** from buffer Z into
5564** the blob that [sqlite3_blob] object P refers to
5565** beginning at an offset of X into the blob.
5566**
5567** {F17875} The [sqlite3_blob_write(P,Z,N,X)] interface returns
5568** [SQLITE_READONLY] if the [sqlite3_blob] object P was
5569** [sqlite3_blob_open | opened] for reading only.
5570**
5571** {F17876} In [sqlite3_blob_write(P,Z,N,X)] if the size of the blob
5572** is less than N+X bytes, then the function returns [SQLITE_ERROR]
5573** and nothing is written into the blob.
5574**
5575** {F17879} In [sqlite3_blob_write(P,Z,N,X)] if X or N is less than zero
5576** then the function returns [SQLITE_ERROR]
5577** and nothing is written into the blob.
5578**
5579** {F17882} The [sqlite3_blob_write(P,Z,N,X)] interface returns [SQLITE_OK]
5580** if N bytes where successfully written into blob.
5581**
5582** {F17885} If the requested write could not be completed,
5583** the [sqlite3_blob_write(P,Z,N,X)] interface returns an
5584** appropriate [error code] or [extended error code].
5585**
5586** {F17888} If an error occurs during evaluation of [sqlite3_blob_write(D,...)]
5587** then subsequent calls to [sqlite3_errcode(D)],
5588** [sqlite3_errmsg(D)], and [sqlite3_errmsg16(D)] will return
shane26b34032008-05-23 17:21:09 +00005589** information appropriate for that error.
danielk19778cbadb02007-05-03 16:31:26 +00005590*/
5591int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset);
5592
drhd84f9462007-08-15 11:28:56 +00005593/*
drhfddfa2d2007-12-05 18:05:16 +00005594** CAPI3REF: Virtual File System Objects {F11200}
drhd84f9462007-08-15 11:28:56 +00005595**
5596** A virtual filesystem (VFS) is an [sqlite3_vfs] object
5597** that SQLite uses to interact
drhb4d58ae2008-02-21 20:17:06 +00005598** with the underlying operating system. Most SQLite builds come with a
drhd84f9462007-08-15 11:28:56 +00005599** single default VFS that is appropriate for the host computer.
5600** New VFSes can be registered and existing VFSes can be unregistered.
5601** The following interfaces are provided.
5602**
drhb4d58ae2008-02-21 20:17:06 +00005603** The sqlite3_vfs_find() interface returns a pointer to
5604** a VFS given its name. Names are case sensitive.
5605** Names are zero-terminated UTF-8 strings.
5606** If there is no match, a NULL
5607** pointer is returned. If zVfsName is NULL then the default
5608** VFS is returned.
drhd84f9462007-08-15 11:28:56 +00005609**
drhb4d58ae2008-02-21 20:17:06 +00005610** New VFSes are registered with sqlite3_vfs_register().
5611** Each new VFS becomes the default VFS if the makeDflt flag is set.
5612** The same VFS can be registered multiple times without injury.
5613** To make an existing VFS into the default VFS, register it again
5614** with the makeDflt flag set. If two different VFSes with the
5615** same name are registered, the behavior is undefined. If a
drhb6f5cf32007-08-28 15:21:45 +00005616** VFS is registered with a name that is NULL or an empty string,
5617** then the behavior is undefined.
drhd84f9462007-08-15 11:28:56 +00005618**
drhb4d58ae2008-02-21 20:17:06 +00005619** Unregister a VFS with the sqlite3_vfs_unregister() interface.
5620** If the default VFS is unregistered, another VFS is chosen as
drhd84f9462007-08-15 11:28:56 +00005621** the default. The choice for the new VFS is arbitrary.
drhb4d58ae2008-02-21 20:17:06 +00005622**
5623** INVARIANTS:
5624**
5625** {F11203} The [sqlite3_vfs_find(N)] interface returns a pointer to the
5626** registered [sqlite3_vfs] object whose name exactly matches
5627** the zero-terminated UTF-8 string N, or it returns NULL if
5628** there is no match.
5629**
5630** {F11206} If the N parameter to [sqlite3_vfs_find(N)] is NULL then
5631** the function returns a pointer to the default [sqlite3_vfs]
5632** object if there is one, or NULL if there is no default
5633** [sqlite3_vfs] object.
5634**
5635** {F11209} The [sqlite3_vfs_register(P,F)] interface registers the
5636** well-formed [sqlite3_vfs] object P using the name given
5637** by the zName field of the object.
5638**
5639** {F11212} Using the [sqlite3_vfs_register(P,F)] interface to register
5640** the same [sqlite3_vfs] object multiple times is a harmless no-op.
5641**
5642** {F11215} The [sqlite3_vfs_register(P,F)] interface makes the
5643** the [sqlite3_vfs] object P the default [sqlite3_vfs] object
5644** if F is non-zero.
5645**
5646** {F11218} The [sqlite3_vfs_unregister(P)] interface unregisters the
5647** [sqlite3_vfs] object P so that it is no longer returned by
5648** subsequent calls to [sqlite3_vfs_find()].
drhd84f9462007-08-15 11:28:56 +00005649*/
drhd677b3d2007-08-20 22:48:41 +00005650sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName);
drhd677b3d2007-08-20 22:48:41 +00005651int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);
5652int sqlite3_vfs_unregister(sqlite3_vfs*);
drhd84f9462007-08-15 11:28:56 +00005653
5654/*
drhfddfa2d2007-12-05 18:05:16 +00005655** CAPI3REF: Mutexes {F17000}
drhd84f9462007-08-15 11:28:56 +00005656**
5657** The SQLite core uses these routines for thread
5658** synchronization. Though they are intended for internal
5659** use by SQLite, code that links against SQLite is
5660** permitted to use any of these routines.
5661**
5662** The SQLite source code contains multiple implementations
drh8bacf972007-08-25 16:21:29 +00005663** of these mutex routines. An appropriate implementation
5664** is selected automatically at compile-time. The following
5665** implementations are available in the SQLite core:
drhd84f9462007-08-15 11:28:56 +00005666**
5667** <ul>
drhc7ce76a2007-08-30 14:10:30 +00005668** <li> SQLITE_MUTEX_OS2
drhd84f9462007-08-15 11:28:56 +00005669** <li> SQLITE_MUTEX_PTHREAD
drhc7ce76a2007-08-30 14:10:30 +00005670** <li> SQLITE_MUTEX_W32
drhd84f9462007-08-15 11:28:56 +00005671** <li> SQLITE_MUTEX_NOOP
drhd84f9462007-08-15 11:28:56 +00005672** </ul>
5673**
drhd84f9462007-08-15 11:28:56 +00005674** The SQLITE_MUTEX_NOOP implementation is a set of routines
5675** that does no real locking and is appropriate for use in
drhc7ce76a2007-08-30 14:10:30 +00005676** a single-threaded application. The SQLITE_MUTEX_OS2,
5677** SQLITE_MUTEX_PTHREAD, and SQLITE_MUTEX_W32 implementations
shane26b34032008-05-23 17:21:09 +00005678** are appropriate for use on OS/2, Unix, and Windows.
drhd84f9462007-08-15 11:28:56 +00005679**
drh8bacf972007-08-25 16:21:29 +00005680** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor
5681** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex
drhd84f9462007-08-15 11:28:56 +00005682** implementation is included with the library. The
drh8bacf972007-08-25 16:21:29 +00005683** mutex interface routines defined here become external
drhd84f9462007-08-15 11:28:56 +00005684** references in the SQLite library for which implementations
drh8bacf972007-08-25 16:21:29 +00005685** must be provided by the application. This facility allows an
5686** application that links against SQLite to provide its own mutex
5687** implementation without having to modify the SQLite core.
drhd84f9462007-08-15 11:28:56 +00005688**
drhcb041342008-06-12 00:07:29 +00005689** {F17001} The sqlite3_mutex_init() routine is called once by each
5690** effective call to [sqlite3_initialize()]. The sqlite3_mutex_init()
5691** interface initializes the mutex subsystem. The application should
5692** never call sqlite3_mutex_init() directly but only indirectly by
5693** invoking [sqlite3_initialize()].
5694**
5695** {F17003} The sqlite3_mutex_end() routine undoes the effect of
5696** sqlite3_mutex_init(). The sqlite3_mutex_end() interface is called
5697** by [sqlite3_shutdown()]. The application should never call
5698** sqlite3_mutex_end() directly but only indirectly through
5699** [sqlite3_shutdown()].
5700**
drhf5befa02007-12-06 02:42:07 +00005701** {F17011} The sqlite3_mutex_alloc() routine allocates a new
5702** mutex and returns a pointer to it. {F17012} If it returns NULL
5703** that means that a mutex could not be allocated. {F17013} SQLite
5704** will unwind its stack and return an error. {F17014} The argument
drh6bdec4a2007-08-16 19:40:16 +00005705** to sqlite3_mutex_alloc() is one of these integer constants:
5706**
5707** <ul>
5708** <li> SQLITE_MUTEX_FAST
5709** <li> SQLITE_MUTEX_RECURSIVE
5710** <li> SQLITE_MUTEX_STATIC_MASTER
5711** <li> SQLITE_MUTEX_STATIC_MEM
drh86f8c192007-08-22 00:39:19 +00005712** <li> SQLITE_MUTEX_STATIC_MEM2
drh6bdec4a2007-08-16 19:40:16 +00005713** <li> SQLITE_MUTEX_STATIC_PRNG
danielk19779f61c2f2007-08-27 17:27:49 +00005714** <li> SQLITE_MUTEX_STATIC_LRU
danielk1977dfb316d2008-03-26 18:34:43 +00005715** <li> SQLITE_MUTEX_STATIC_LRU2
drhf5befa02007-12-06 02:42:07 +00005716** </ul> {END}
drh6bdec4a2007-08-16 19:40:16 +00005717**
drhf5befa02007-12-06 02:42:07 +00005718** {F17015} The first two constants cause sqlite3_mutex_alloc() to create
drh6bdec4a2007-08-16 19:40:16 +00005719** a new mutex. The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
drhf5befa02007-12-06 02:42:07 +00005720** is used but not necessarily so when SQLITE_MUTEX_FAST is used. {END}
drh6bdec4a2007-08-16 19:40:16 +00005721** The mutex implementation does not need to make a distinction
5722** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
drhf5befa02007-12-06 02:42:07 +00005723** not want to. {F17016} But SQLite will only request a recursive mutex in
5724** cases where it really needs one. {END} If a faster non-recursive mutex
drh6bdec4a2007-08-16 19:40:16 +00005725** implementation is available on the host platform, the mutex subsystem
5726** might return such a mutex in response to SQLITE_MUTEX_FAST.
5727**
drhf5befa02007-12-06 02:42:07 +00005728** {F17017} The other allowed parameters to sqlite3_mutex_alloc() each return
5729** a pointer to a static preexisting mutex. {END} Four static mutexes are
drh6bdec4a2007-08-16 19:40:16 +00005730** used by the current version of SQLite. Future versions of SQLite
5731** may add additional static mutexes. Static mutexes are for internal
5732** use by SQLite only. Applications that use SQLite mutexes should
5733** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
5734** SQLITE_MUTEX_RECURSIVE.
5735**
drhf5befa02007-12-06 02:42:07 +00005736** {F17018} Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
drh6bdec4a2007-08-16 19:40:16 +00005737** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
drhf5befa02007-12-06 02:42:07 +00005738** returns a different mutex on every call. {F17034} But for the static
drh6bdec4a2007-08-16 19:40:16 +00005739** mutex types, the same mutex is returned on every call that has
drhf5befa02007-12-06 02:42:07 +00005740** the same type number. {END}
drhd84f9462007-08-15 11:28:56 +00005741**
drhf5befa02007-12-06 02:42:07 +00005742** {F17019} The sqlite3_mutex_free() routine deallocates a previously
5743** allocated dynamic mutex. {F17020} SQLite is careful to deallocate every
5744** dynamic mutex that it allocates. {U17021} The dynamic mutexes must not be in
5745** use when they are deallocated. {U17022} Attempting to deallocate a static
5746** mutex results in undefined behavior. {F17023} SQLite never deallocates
5747** a static mutex. {END}
drhd84f9462007-08-15 11:28:56 +00005748**
drh6bdec4a2007-08-16 19:40:16 +00005749** The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
drhf5befa02007-12-06 02:42:07 +00005750** to enter a mutex. {F17024} If another thread is already within the mutex,
drh6bdec4a2007-08-16 19:40:16 +00005751** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
shane26b34032008-05-23 17:21:09 +00005752** SQLITE_BUSY. {F17025} The sqlite3_mutex_try() interface returns [SQLITE_OK]
drhf5befa02007-12-06 02:42:07 +00005753** upon successful entry. {F17026} Mutexes created using
5754** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread.
5755** {F17027} In such cases the,
drh6bdec4a2007-08-16 19:40:16 +00005756** mutex must be exited an equal number of times before another thread
drhf5befa02007-12-06 02:42:07 +00005757** can enter. {U17028} If the same thread tries to enter any other
5758** kind of mutex more than once, the behavior is undefined.
5759** {F17029} SQLite will never exhibit
drhcb041342008-06-12 00:07:29 +00005760** such behavior in its own use of mutexes.
drhd84f9462007-08-15 11:28:56 +00005761**
drhcb041342008-06-12 00:07:29 +00005762** Some systems (ex: windows95) do not support the operation implemented by
drhca49cba2007-09-04 22:31:36 +00005763** sqlite3_mutex_try(). On those systems, sqlite3_mutex_try() will
drhf5befa02007-12-06 02:42:07 +00005764** always return SQLITE_BUSY. {F17030} The SQLite core only ever uses
drhcb041342008-06-12 00:07:29 +00005765** sqlite3_mutex_try() as an optimization so this is acceptable behavior.
drhca49cba2007-09-04 22:31:36 +00005766**
drhf5befa02007-12-06 02:42:07 +00005767** {F17031} The sqlite3_mutex_leave() routine exits a mutex that was
5768** previously entered by the same thread. {U17032} The behavior
drh8bacf972007-08-25 16:21:29 +00005769** is undefined if the mutex is not currently entered by the
drhf5befa02007-12-06 02:42:07 +00005770** calling thread or is not currently allocated. {F17033} SQLite will
5771** never do either. {END}
drh8bacf972007-08-25 16:21:29 +00005772**
drh40257ff2008-06-13 18:24:27 +00005773** If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or
5774** sqlite3_mutex_leave() is a NULL pointer, then all three routines
5775** behave as no-ops.
5776**
drh8bacf972007-08-25 16:21:29 +00005777** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()].
5778*/
drh40257ff2008-06-13 18:24:27 +00005779int sqlite3_mutex_init(void);
drh8bacf972007-08-25 16:21:29 +00005780sqlite3_mutex *sqlite3_mutex_alloc(int);
5781void sqlite3_mutex_free(sqlite3_mutex*);
5782void sqlite3_mutex_enter(sqlite3_mutex*);
5783int sqlite3_mutex_try(sqlite3_mutex*);
5784void sqlite3_mutex_leave(sqlite3_mutex*);
drh40257ff2008-06-13 18:24:27 +00005785int sqlite3_mutex_end(void);
drh8bacf972007-08-25 16:21:29 +00005786
5787/*
drhfddfa2d2007-12-05 18:05:16 +00005788** CAPI3REF: Mutex Verifcation Routines {F17080}
drhd677b3d2007-08-20 22:48:41 +00005789**
5790** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines
drhfddfa2d2007-12-05 18:05:16 +00005791** are intended for use inside assert() statements. {F17081} The SQLite core
drhf77a2ff2007-08-25 14:49:36 +00005792** never uses these routines except inside an assert() and applications
drhfddfa2d2007-12-05 18:05:16 +00005793** are advised to follow the lead of the core. {F17082} The core only
drh8bacf972007-08-25 16:21:29 +00005794** provides implementations for these routines when it is compiled
drhf5befa02007-12-06 02:42:07 +00005795** with the SQLITE_DEBUG flag. {U17087} External mutex implementations
drh8bacf972007-08-25 16:21:29 +00005796** are only required to provide these routines if SQLITE_DEBUG is
5797** defined and if NDEBUG is not defined.
5798**
drhfddfa2d2007-12-05 18:05:16 +00005799** {F17083} These routines should return true if the mutex in their argument
5800** is held or not held, respectively, by the calling thread. {END}
drh8bacf972007-08-25 16:21:29 +00005801**
drhfddfa2d2007-12-05 18:05:16 +00005802** {X17084} The implementation is not required to provided versions of these
drh8bacf972007-08-25 16:21:29 +00005803** routines that actually work.
5804** If the implementation does not provide working
5805** versions of these routines, it should at least provide stubs
5806** that always return true so that one does not get spurious
drhfddfa2d2007-12-05 18:05:16 +00005807** assertion failures. {END}
drhd677b3d2007-08-20 22:48:41 +00005808**
drhfddfa2d2007-12-05 18:05:16 +00005809** {F17085} If the argument to sqlite3_mutex_held() is a NULL pointer then
5810** the routine should return 1. {END} This seems counter-intuitive since
drhd677b3d2007-08-20 22:48:41 +00005811** clearly the mutex cannot be held if it does not exist. But the
5812** the reason the mutex does not exist is because the build is not
5813** using mutexes. And we do not want the assert() containing the
5814** call to sqlite3_mutex_held() to fail, so a non-zero return is
drhfddfa2d2007-12-05 18:05:16 +00005815** the appropriate thing to do. {F17086} The sqlite3_mutex_notheld()
drhd677b3d2007-08-20 22:48:41 +00005816** interface should also return 1 when given a NULL pointer.
drhd84f9462007-08-15 11:28:56 +00005817*/
drhd677b3d2007-08-20 22:48:41 +00005818int sqlite3_mutex_held(sqlite3_mutex*);
5819int sqlite3_mutex_notheld(sqlite3_mutex*);
drh32bc3f62007-08-21 20:25:39 +00005820
5821/*
drhfddfa2d2007-12-05 18:05:16 +00005822** CAPI3REF: Mutex Types {F17001}
drh32bc3f62007-08-21 20:25:39 +00005823**
drhfddfa2d2007-12-05 18:05:16 +00005824** {F17002} The [sqlite3_mutex_alloc()] interface takes a single argument
5825** which is one of these integer constants. {END}
drh32bc3f62007-08-21 20:25:39 +00005826*/
drh6bdec4a2007-08-16 19:40:16 +00005827#define SQLITE_MUTEX_FAST 0
5828#define SQLITE_MUTEX_RECURSIVE 1
5829#define SQLITE_MUTEX_STATIC_MASTER 2
drh86f8c192007-08-22 00:39:19 +00005830#define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */
5831#define SQLITE_MUTEX_STATIC_MEM2 4 /* sqlite3_release_memory() */
5832#define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */
danielk19779f61c2f2007-08-27 17:27:49 +00005833#define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */
danielk1977dfb316d2008-03-26 18:34:43 +00005834#define SQLITE_MUTEX_STATIC_LRU2 7 /* lru page list */
drh6d2069d2007-08-14 01:58:53 +00005835
drhcc6bb3e2007-08-31 16:11:35 +00005836/*
drhfddfa2d2007-12-05 18:05:16 +00005837** CAPI3REF: Low-Level Control Of Database Files {F11300}
drhcc6bb3e2007-08-31 16:11:35 +00005838**
drhfddfa2d2007-12-05 18:05:16 +00005839** {F11301} The [sqlite3_file_control()] interface makes a direct call to the
drhcc6bb3e2007-08-31 16:11:35 +00005840** xFileControl method for the [sqlite3_io_methods] object associated
drhfddfa2d2007-12-05 18:05:16 +00005841** with a particular database identified by the second argument. {F11302} The
drhcc6bb3e2007-08-31 16:11:35 +00005842** name of the database is the name assigned to the database by the
5843** <a href="lang_attach.html">ATTACH</a> SQL command that opened the
drhfddfa2d2007-12-05 18:05:16 +00005844** database. {F11303} To control the main database file, use the name "main"
5845** or a NULL pointer. {F11304} The third and fourth parameters to this routine
drhcc6bb3e2007-08-31 16:11:35 +00005846** are passed directly through to the second and third parameters of
drhfddfa2d2007-12-05 18:05:16 +00005847** the xFileControl method. {F11305} The return value of the xFileControl
drhcc6bb3e2007-08-31 16:11:35 +00005848** method becomes the return value of this routine.
5849**
drhfddfa2d2007-12-05 18:05:16 +00005850** {F11306} If the second parameter (zDbName) does not match the name of any
5851** open database file, then SQLITE_ERROR is returned. {F11307} This error
drhcc6bb3e2007-08-31 16:11:35 +00005852** code is not remembered and will not be recalled by [sqlite3_errcode()]
drhf5befa02007-12-06 02:42:07 +00005853** or [sqlite3_errmsg()]. {U11308} The underlying xFileControl method might
5854** also return SQLITE_ERROR. {U11309} There is no way to distinguish between
drhcc6bb3e2007-08-31 16:11:35 +00005855** an incorrect zDbName and an SQLITE_ERROR return from the underlying
drhfddfa2d2007-12-05 18:05:16 +00005856** xFileControl method. {END}
drh4ff7fa02007-09-01 18:17:21 +00005857**
5858** See also: [SQLITE_FCNTL_LOCKSTATE]
drhcc6bb3e2007-08-31 16:11:35 +00005859*/
5860int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*);
drh6d2069d2007-08-14 01:58:53 +00005861
danielk19778cbadb02007-05-03 16:31:26 +00005862/*
drhed13d982008-01-31 14:43:24 +00005863** CAPI3REF: Testing Interface {F11400}
5864**
5865** The sqlite3_test_control() interface is used to read out internal
5866** state of SQLite and to inject faults into SQLite for testing
shane26b34032008-05-23 17:21:09 +00005867** purposes. The first parameter is an operation code that determines
drhed13d982008-01-31 14:43:24 +00005868** the number, meaning, and operation of all subsequent parameters.
5869**
5870** This interface is not for use by applications. It exists solely
5871** for verifying the correct operation of the SQLite library. Depending
5872** on how the SQLite library is compiled, this interface might not exist.
5873**
5874** The details of the operation codes, their meanings, the parameters
5875** they take, and what they do are all subject to change without notice.
5876** Unlike most of the SQLite API, this function is not guaranteed to
5877** operate consistently from one release to the next.
5878*/
5879int sqlite3_test_control(int op, ...);
5880
5881/*
5882** CAPI3REF: Testing Interface Operation Codes {F11410}
5883**
5884** These constants are the valid operation code parameters used
5885** as the first argument to [sqlite3_test_control()].
5886**
shane26b34032008-05-23 17:21:09 +00005887** These parameters and their meanings are subject to change
drhed13d982008-01-31 14:43:24 +00005888** without notice. These values are for testing purposes only.
5889** Applications should not use any of these parameters or the
5890** [sqlite3_test_control()] interface.
5891*/
5892#define SQLITE_TESTCTRL_FAULT_CONFIG 1
5893#define SQLITE_TESTCTRL_FAULT_FAILURES 2
5894#define SQLITE_TESTCTRL_FAULT_BENIGN_FAILURES 3
5895#define SQLITE_TESTCTRL_FAULT_PENDING 4
drh2fa18682008-03-19 14:15:34 +00005896#define SQLITE_TESTCTRL_PRNG_SAVE 5
5897#define SQLITE_TESTCTRL_PRNG_RESTORE 6
5898#define SQLITE_TESTCTRL_PRNG_RESET 7
drh3088d592008-03-21 16:45:47 +00005899#define SQLITE_TESTCTRL_BITVEC_TEST 8
drhed13d982008-01-31 14:43:24 +00005900
5901
5902/*
drhb37df7b2005-10-13 02:09:49 +00005903** Undo the hack that converts floating point types to integer for
5904** builds on processors without floating point support.
5905*/
5906#ifdef SQLITE_OMIT_FLOATING_POINT
5907# undef double
5908#endif
5909
drh382c0242001-10-06 16:33:02 +00005910#ifdef __cplusplus
5911} /* End of the 'extern "C"' block */
5912#endif
danielk19774adee202004-05-08 08:23:19 +00005913#endif