blob: 5adaf5b6667dde3093fbfaac939d83764e348c24 [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**
danielk1977d0251742008-06-18 18:57:42 +000033** @(#) $Id: sqlite.h.in,v 1.336 2008/06/18 18:57:42 danielk1977 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
drhfacf0302008-06-17 15:12:00 +0000978** of 8. Some allocators round up to a larger multiple or to a power of 2.
drhe5ae5732008-06-15 02:51:47 +0000979**
drhfec00ea2008-06-14 16:56:21 +0000980** 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**
drh33589792008-06-18 13:27:46 +00001035** <dt>SQLITE_CONFIG_GETMALLOC</dt>
1036** <dd>This option takes a single argument which is a pointer to an
1037** instance of the [sqlite3_mem_methods] structure. The [sqlite3_mem_methods]
1038** structure is filled with the currently defined memory allocation routines.
1039** This option can be used to overload the default memory allocation
1040** routines with a wrapper that simulations memory allocation failure or
1041** tracks memory usage, for example.</dd>
1042**
drhfec00ea2008-06-14 16:56:21 +00001043** <dt>SQLITE_CONFIG_MEMSTATUS</dt>
drhce5a5a02008-06-10 17:41:44 +00001044** <dd>This option takes single boolean argument which enables or disables
1045** the collection of memory allocation statistics. When disabled, the
1046** following SQLite interfaces become non-operational:
1047** <ul>
1048** <li> [sqlite3_memory_used()]
1049** <li> [sqlite3_memory_highwater()]
1050** <li> [sqlite3_soft_heap_limit()]
drh40257ff2008-06-13 18:24:27 +00001051** <li> sqlite3_memory_status()
drhce5a5a02008-06-10 17:41:44 +00001052** </ul>
1053** </dd>
drh33589792008-06-18 13:27:46 +00001054**
1055** <dt>SQLITE_CONFIG_SCRATCH</dt>
1056** <dd>This option specifies a static memory buffer that SQLite can use for
1057** scratch memory. There are three arguments: A pointer to the memory, the
drh9ac3fe92008-06-18 18:12:04 +00001058** size of each scratch buffer (sz), and the number of buffers (N). The sz
1059** argument must be a multiple of 16. The first
1060** argument should point to an allocation of at least (sz+1)*N bytes of memory.
drh33589792008-06-18 13:27:46 +00001061** SQLite will use no more than one scratch buffer at once per thread, so
1062** N should be set to the expected maximum number of threads. The sz
1063** parameter should be 6 times the size of the largest database page size.
1064** Scratch buffers are used as part of the btree balance operation. If
1065** The btree balancer needs additional memory beyond what is provided by
1066** scratch buffers or if no scratch buffer space is specified, then SQLite
1067** goes to [sqlite3_malloc()] to obtain the memory it needs.
1068** </dd>
1069**
1070** <dt>SQLITE_CONFIG_PAGECACHE</dt>
1071** <dd>This option specifies a static memory buffer that SQLite can use for
1072** the database page cache. There are three arguments:
1073** A pointer to the memory, the
drh9ac3fe92008-06-18 18:12:04 +00001074** size of each page buffer (sz), and the number of pages (N). The sz
1075** argument must be a power of two between 512 and 32768. The first
1076** argument should point to an allocation of at least (sz+4)*N bytes of memory.
drh33589792008-06-18 13:27:46 +00001077** SQLite will use the memory provided by the first argument to satisfy
1078** its memory needs for the first N pages that it adds to cache. If
1079** additional page cache memory is needed beyond what is provided by
1080** this option, then SQLite goes to [sqlite3_malloc()] for the additional
1081** storage space.
1082** </dd>
1083**
1084** <dt>SQLITE_CONFIG_HEAP</dt>
1085** <dd>This option specifies a static memory buffer that SQLite will use
1086** for all of its dynamic memory allocation needs beyond those provided
1087** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE].
1088** There are three arguments: A pointer to the memory, the number of
1089** bytes in the memory buffer, and the minimum allocation size. When
1090** this configuration option is used, SQLite never calls the system
1091** malloc() implementation but instead uses the supplied memory buffer
1092** to satisfy all [sqlite3_malloc()] requests.
1093** </dd>
1094**
1095** <dt>SQLITE_CONFIG_MUTEX</dt>
1096** <dd>This option takes a single argument which is a pointer to an
1097** instance of the [sqlite3_mutex_methods] structure. The argument specifics
1098** alternative low-level mutex routines to be used in place
1099** the mutex routines built into SQLite.</dd>
1100**
1101** <dt>SQLITE_CONFIG_GETMALLOC</dt>
1102** <dd>This option takes a single argument which is a pointer to an
1103** instance of the [sqlite3_mutex_methods] structure. The
1104** [sqlite3_mutex_methods]
1105** structure is filled with the currently defined mutex routines.
1106** This option can be used to overload the default mutex allocation
1107** routines with a wrapper used to track mutex usage for performance
1108** profiling or testing, for example.</dd>
1109**
drhce5a5a02008-06-10 17:41:44 +00001110** </dl>
1111*/
drh40257ff2008-06-13 18:24:27 +00001112#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */
1113#define SQLITE_CONFIG_MULTITHREAD 2 /* nil */
1114#define SQLITE_CONFIG_SERIALIZED 3 /* nil */
drhfec00ea2008-06-14 16:56:21 +00001115#define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */
drh33589792008-06-18 13:27:46 +00001116#define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */
1117#define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */
1118#define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */
1119#define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */
1120#define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */
1121#define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */
1122#define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */
drhce5a5a02008-06-10 17:41:44 +00001123
drh673299b2008-06-09 21:57:22 +00001124
1125/*
drhfddfa2d2007-12-05 18:05:16 +00001126** CAPI3REF: Enable Or Disable Extended Result Codes {F12200}
drh6ed48bf2007-06-14 20:57:18 +00001127**
drh33c1be32008-01-30 16:16:14 +00001128** The sqlite3_extended_result_codes() routine enables or disables the
1129** [SQLITE_IOERR_READ | extended result codes] feature of SQLite.
1130** The extended result codes are disabled by default for historical
1131** compatibility.
drh6ed48bf2007-06-14 20:57:18 +00001132**
drh33c1be32008-01-30 16:16:14 +00001133** INVARIANTS:
1134**
drh282c8e52008-05-20 18:43:38 +00001135** {F12201} Each new [database connection] shall have the
drh33c1be32008-01-30 16:16:14 +00001136** [extended result codes] feature
1137** disabled by default.
1138**
drh282c8e52008-05-20 18:43:38 +00001139** {F12202} The [sqlite3_extended_result_codes(D,F)] interface shall enable
drh33c1be32008-01-30 16:16:14 +00001140** [extended result codes] for the
1141** [database connection] D if the F parameter
1142** is true, or disable them if F is false.
drh4ac285a2006-09-15 07:28:50 +00001143*/
1144int sqlite3_extended_result_codes(sqlite3*, int onoff);
1145
1146/*
drhfddfa2d2007-12-05 18:05:16 +00001147** CAPI3REF: Last Insert Rowid {F12220}
drh6ed48bf2007-06-14 20:57:18 +00001148**
drh33c1be32008-01-30 16:16:14 +00001149** Each entry in an SQLite table has a unique 64-bit signed
1150** integer key called the "rowid". The rowid is always available
drhfddfa2d2007-12-05 18:05:16 +00001151** as an undeclared column named ROWID, OID, or _ROWID_ as long as those
drh33c1be32008-01-30 16:16:14 +00001152** names are not also used by explicitly declared columns. If
drhfddfa2d2007-12-05 18:05:16 +00001153** the table has a column of type INTEGER PRIMARY KEY then that column
mlcreechb2799412008-03-07 03:20:31 +00001154** is another alias for the rowid.
drh6ed48bf2007-06-14 20:57:18 +00001155**
drh33c1be32008-01-30 16:16:14 +00001156** This routine returns the rowid of the most recent
drhfddfa2d2007-12-05 18:05:16 +00001157** successful INSERT into the database from the database connection
drh33c1be32008-01-30 16:16:14 +00001158** shown in the first argument. If no successful inserts
drhfddfa2d2007-12-05 18:05:16 +00001159** have ever occurred on this database connection, zero is returned.
drh6ed48bf2007-06-14 20:57:18 +00001160**
drh33c1be32008-01-30 16:16:14 +00001161** If an INSERT occurs within a trigger, then the rowid of the
drh6ed48bf2007-06-14 20:57:18 +00001162** inserted row is returned by this routine as long as the trigger
drh33c1be32008-01-30 16:16:14 +00001163** is running. But once the trigger terminates, the value returned
drh6ed48bf2007-06-14 20:57:18 +00001164** by this routine reverts to the last value inserted before the
1165** trigger fired.
drhe30f4422007-08-21 16:15:55 +00001166**
drh33c1be32008-01-30 16:16:14 +00001167** An INSERT that fails due to a constraint violation is not a
drhdc1d9f12007-10-27 16:25:16 +00001168** successful insert and does not change the value returned by this
drh33c1be32008-01-30 16:16:14 +00001169** routine. Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK,
drhdc1d9f12007-10-27 16:25:16 +00001170** and INSERT OR ABORT make no changes to the return value of this
drh33c1be32008-01-30 16:16:14 +00001171** routine when their insertion fails. When INSERT OR REPLACE
drhdc1d9f12007-10-27 16:25:16 +00001172** encounters a constraint violation, it does not fail. The
1173** INSERT continues to completion after deleting rows that caused
1174** the constraint problem so INSERT OR REPLACE will always change
drhfddfa2d2007-12-05 18:05:16 +00001175** the return value of this interface.
drhdc1d9f12007-10-27 16:25:16 +00001176**
drh33c1be32008-01-30 16:16:14 +00001177** For the purposes of this routine, an insert is considered to
1178** be successful even if it is subsequently rolled back.
1179**
1180** INVARIANTS:
1181**
1182** {F12221} The [sqlite3_last_insert_rowid()] function returns the
1183** rowid of the most recent successful insert done
1184** on the same database connection and within the same
drh282c8e52008-05-20 18:43:38 +00001185** or higher level trigger context, or zero if there have
1186** been no qualifying inserts.
drh33c1be32008-01-30 16:16:14 +00001187**
1188** {F12223} The [sqlite3_last_insert_rowid()] function returns
1189** same value when called from the same trigger context
1190** immediately before and after a ROLLBACK.
1191**
1192** LIMITATIONS:
1193**
mlcreechb2799412008-03-07 03:20:31 +00001194** {U12232} If a separate thread does a new insert on the same
drh33c1be32008-01-30 16:16:14 +00001195** database connection while the [sqlite3_last_insert_rowid()]
1196** function is running and thus changes the last insert rowid,
1197** then the value returned by [sqlite3_last_insert_rowid()] is
1198** unpredictable and might not equal either the old or the new
1199** last insert rowid.
drhaf9ff332002-01-16 21:00:27 +00001200*/
drh6d2069d2007-08-14 01:58:53 +00001201sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*);
drhaf9ff332002-01-16 21:00:27 +00001202
drhc8d30ac2002-04-12 10:08:59 +00001203/*
drhfddfa2d2007-12-05 18:05:16 +00001204** CAPI3REF: Count The Number Of Rows Modified {F12240}
drh6ed48bf2007-06-14 20:57:18 +00001205**
drh33c1be32008-01-30 16:16:14 +00001206** This function returns the number of database rows that were changed
drhfddfa2d2007-12-05 18:05:16 +00001207** or inserted or deleted by the most recently completed SQL statement
drh33c1be32008-01-30 16:16:14 +00001208** on the connection specified by the first parameter. Only
drh930cc582007-03-28 13:07:40 +00001209** changes that are directly specified by the INSERT, UPDATE, or
1210** DELETE statement are counted. Auxiliary changes caused by
drh33c1be32008-01-30 16:16:14 +00001211** triggers are not counted. Use the [sqlite3_total_changes()] function
drh6ed48bf2007-06-14 20:57:18 +00001212** to find the total number of changes including changes caused by triggers.
1213**
mlcreechb2799412008-03-07 03:20:31 +00001214** A "row change" is a change to a single row of a single table
drh33c1be32008-01-30 16:16:14 +00001215** caused by an INSERT, DELETE, or UPDATE statement. Rows that
1216** are changed as side effects of REPLACE constraint resolution,
1217** rollback, ABORT processing, DROP TABLE, or by any other
1218** mechanisms do not count as direct row changes.
1219**
1220** A "trigger context" is a scope of execution that begins and
1221** ends with the script of a trigger. Most SQL statements are
1222** evaluated outside of any trigger. This is the "top level"
1223** trigger context. If a trigger fires from the top level, a
1224** new trigger context is entered for the duration of that one
1225** trigger. Subtriggers create subcontexts for their duration.
1226**
1227** Calling [sqlite3_exec()] or [sqlite3_step()] recursively does
1228** not create a new trigger context.
1229**
1230** This function returns the number of direct row changes in the
1231** most recent INSERT, UPDATE, or DELETE statement within the same
1232** trigger context.
1233**
1234** So when called from the top level, this function returns the
1235** number of changes in the most recent INSERT, UPDATE, or DELETE
1236** that also occurred at the top level.
1237** Within the body of a trigger, the sqlite3_changes() interface
drhf5befa02007-12-06 02:42:07 +00001238** can be called to find the number of
drh930cc582007-03-28 13:07:40 +00001239** changes in the most recently completed INSERT, UPDATE, or DELETE
drhf5befa02007-12-06 02:42:07 +00001240** statement within the body of the same trigger.
drh33c1be32008-01-30 16:16:14 +00001241** However, the number returned does not include in changes
1242** caused by subtriggers since they have their own context.
drhc8d30ac2002-04-12 10:08:59 +00001243**
drh33c1be32008-01-30 16:16:14 +00001244** SQLite implements the command "DELETE FROM table" without
drhfddfa2d2007-12-05 18:05:16 +00001245** a WHERE clause by dropping and recreating the table. (This is much
1246** faster than going through and deleting individual elements from the
drh33c1be32008-01-30 16:16:14 +00001247** table.) Because of this optimization, the deletions in
1248** "DELETE FROM table" are not row changes and will not be counted
1249** by the sqlite3_changes() or [sqlite3_total_changes()] functions.
1250** To get an accurate count of the number of rows deleted, use
drhc8d30ac2002-04-12 10:08:59 +00001251** "DELETE FROM table WHERE 1" instead.
drhe30f4422007-08-21 16:15:55 +00001252**
drh33c1be32008-01-30 16:16:14 +00001253** INVARIANTS:
1254**
drhe63b2c22008-05-21 13:44:13 +00001255** {F12241} The [sqlite3_changes()] function shall return the number of
drh33c1be32008-01-30 16:16:14 +00001256** row changes caused by the most recent INSERT, UPDATE,
1257** or DELETE statement on the same database connection and
drhe63b2c22008-05-21 13:44:13 +00001258** within the same or higher trigger context, or zero if there have
drh33c1be32008-01-30 16:16:14 +00001259** not been any qualifying row changes.
1260**
drhe63b2c22008-05-21 13:44:13 +00001261** {F12243} Statements of the form "DELETE FROM tablename" with no
1262** WHERE clause shall cause subsequent calls to
1263** [sqlite3_changes()] to return zero, regardless of the
1264** number of rows originally in the table.
1265**
drh33c1be32008-01-30 16:16:14 +00001266** LIMITATIONS:
1267**
1268** {U12252} If a separate thread makes changes on the same database connection
1269** while [sqlite3_changes()] is running then the value returned
shane26b34032008-05-23 17:21:09 +00001270** is unpredictable and not meaningful.
drhc8d30ac2002-04-12 10:08:59 +00001271*/
danielk1977f9d64d22004-06-19 08:18:07 +00001272int sqlite3_changes(sqlite3*);
drhc8d30ac2002-04-12 10:08:59 +00001273
rdcf146a772004-02-25 22:51:06 +00001274/*
drhfddfa2d2007-12-05 18:05:16 +00001275** CAPI3REF: Total Number Of Rows Modified {F12260}
drh6ed48bf2007-06-14 20:57:18 +00001276***
drh33c1be32008-01-30 16:16:14 +00001277** This function returns the number of row changes caused
1278** by INSERT, UPDATE or DELETE statements since the database handle
1279** was opened. The count includes all changes from all trigger
1280** contexts. But the count does not include changes used to
1281** implement REPLACE constraints, do rollbacks or ABORT processing,
1282** or DROP table processing.
1283** The changes
drhfddfa2d2007-12-05 18:05:16 +00001284** are counted as soon as the statement that makes them is completed
1285** (when the statement handle is passed to [sqlite3_reset()] or
drh33c1be32008-01-30 16:16:14 +00001286** [sqlite3_finalize()]).
drh6ed48bf2007-06-14 20:57:18 +00001287**
drh33c1be32008-01-30 16:16:14 +00001288** SQLite implements the command "DELETE FROM table" without
drhf5befa02007-12-06 02:42:07 +00001289** a WHERE clause by dropping and recreating the table. (This is much
1290** faster than going
mlcreechb2799412008-03-07 03:20:31 +00001291** through and deleting individual elements from the table.) Because of
rdcf146a772004-02-25 22:51:06 +00001292** this optimization, the change count for "DELETE FROM table" will be
1293** zero regardless of the number of elements that were originally in the
1294** table. To get an accurate count of the number of rows deleted, use
1295** "DELETE FROM table WHERE 1" instead.
drhe30f4422007-08-21 16:15:55 +00001296**
drh33c1be32008-01-30 16:16:14 +00001297** See also the [sqlite3_changes()] interface.
1298**
1299** INVARIANTS:
1300**
1301** {F12261} The [sqlite3_total_changes()] returns the total number
1302** of row changes caused by INSERT, UPDATE, and/or DELETE
1303** statements on the same [database connection], in any
1304** trigger context, since the database connection was
1305** created.
1306**
drhe63b2c22008-05-21 13:44:13 +00001307** {F12263} Statements of the form "DELETE FROM tablename" with no
1308** WHERE clause shall not change the value returned
1309** by [sqlite3_total_changes()]
1310**
drh33c1be32008-01-30 16:16:14 +00001311** LIMITATIONS:
1312**
1313** {U12264} If a separate thread makes changes on the same database connection
1314** while [sqlite3_total_changes()] is running then the value
shane26b34032008-05-23 17:21:09 +00001315** returned is unpredictable and not meaningful.
rdcf146a772004-02-25 22:51:06 +00001316*/
danielk1977b28af712004-06-21 06:50:26 +00001317int sqlite3_total_changes(sqlite3*);
1318
drh6ed48bf2007-06-14 20:57:18 +00001319/*
drhfddfa2d2007-12-05 18:05:16 +00001320** CAPI3REF: Interrupt A Long-Running Query {F12270}
drh6ed48bf2007-06-14 20:57:18 +00001321**
drh33c1be32008-01-30 16:16:14 +00001322** This function causes any pending database operation to abort and
1323** return at its earliest opportunity. This routine is typically
drh66b89c82000-11-28 20:47:17 +00001324** called in response to a user action such as pressing "Cancel"
drh4c504392000-10-16 22:06:40 +00001325** or Ctrl-C where the user wants a long query operation to halt
1326** immediately.
drh930cc582007-03-28 13:07:40 +00001327**
drh33c1be32008-01-30 16:16:14 +00001328** It is safe to call this routine from a thread different from the
1329** thread that is currently running the database operation. But it
drh871f6ca2007-08-14 18:03:14 +00001330** is not safe to call this routine with a database connection that
1331** is closed or might close before sqlite3_interrupt() returns.
drh6ed48bf2007-06-14 20:57:18 +00001332**
drhf5befa02007-12-06 02:42:07 +00001333** If an SQL is very nearly finished at the time when sqlite3_interrupt()
1334** is called, then it might not have an opportunity to be interrupted.
1335** It might continue to completion.
drh33c1be32008-01-30 16:16:14 +00001336** An SQL operation that is interrupted will return
1337** [SQLITE_INTERRUPT]. If the interrupted SQL operation is an
drhf5befa02007-12-06 02:42:07 +00001338** INSERT, UPDATE, or DELETE that is inside an explicit transaction,
1339** then the entire transaction will be rolled back automatically.
drh33c1be32008-01-30 16:16:14 +00001340** A call to sqlite3_interrupt() has no effect on SQL statements
drhf5befa02007-12-06 02:42:07 +00001341** that are started after sqlite3_interrupt() returns.
drh33c1be32008-01-30 16:16:14 +00001342**
1343** INVARIANTS:
1344**
1345** {F12271} The [sqlite3_interrupt()] interface will force all running
1346** SQL statements associated with the same database connection
1347** to halt after processing at most one additional row of
1348** data.
1349**
1350** {F12272} Any SQL statement that is interrupted by [sqlite3_interrupt()]
1351** will return [SQLITE_INTERRUPT].
1352**
1353** LIMITATIONS:
1354**
1355** {U12279} If the database connection closes while [sqlite3_interrupt()]
1356** is running then bad things will likely happen.
drh4c504392000-10-16 22:06:40 +00001357*/
danielk1977f9d64d22004-06-19 08:18:07 +00001358void sqlite3_interrupt(sqlite3*);
drh4c504392000-10-16 22:06:40 +00001359
drh6ed48bf2007-06-14 20:57:18 +00001360/*
drhfddfa2d2007-12-05 18:05:16 +00001361** CAPI3REF: Determine If An SQL Statement Is Complete {F10510}
drh75897232000-05-29 14:26:00 +00001362**
drh6ed48bf2007-06-14 20:57:18 +00001363** These routines are useful for command-line input to determine if the
drhf5befa02007-12-06 02:42:07 +00001364** currently entered text seems to form complete a SQL statement or
1365** if additional input is needed before sending the text into
drhfddfa2d2007-12-05 18:05:16 +00001366** SQLite for parsing. These routines return true if the input string
1367** appears to be a complete SQL statement. A statement is judged to be
drh33c1be32008-01-30 16:16:14 +00001368** complete if it ends with a semicolon token and is not a fragment of a
1369** CREATE TRIGGER statement. Semicolons that are embedded within
1370** string literals or quoted identifier names or comments are not
1371** independent tokens (they are part of the token in which they are
1372** embedded) and thus do not count as a statement terminator.
1373**
1374** These routines do not parse the SQL and
drhf5befa02007-12-06 02:42:07 +00001375** so will not detect syntactically incorrect SQL.
drhfddfa2d2007-12-05 18:05:16 +00001376**
drh33c1be32008-01-30 16:16:14 +00001377** INVARIANTS:
1378**
1379** {F10511} The sqlite3_complete() and sqlite3_complete16() functions
1380** return true (non-zero) if and only if the last
1381** non-whitespace token in their input is a semicolon that
1382** is not in between the BEGIN and END of a CREATE TRIGGER
1383** statement.
1384**
1385** LIMITATIONS:
1386**
1387** {U10512} The input to sqlite3_complete() must be a zero-terminated
1388** UTF-8 string.
1389**
1390** {U10513} The input to sqlite3_complete16() must be a zero-terminated
1391** UTF-16 string in native byte order.
drh75897232000-05-29 14:26:00 +00001392*/
danielk19776f8a5032004-05-10 10:34:51 +00001393int sqlite3_complete(const char *sql);
danielk197761de0d12004-05-27 23:56:16 +00001394int sqlite3_complete16(const void *sql);
drh75897232000-05-29 14:26:00 +00001395
drh2dfbbca2000-07-28 14:32:48 +00001396/*
drhfddfa2d2007-12-05 18:05:16 +00001397** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors {F12310}
drh6ed48bf2007-06-14 20:57:18 +00001398**
drh33c1be32008-01-30 16:16:14 +00001399** This routine identifies a callback function that might be
drhfddfa2d2007-12-05 18:05:16 +00001400** invoked whenever an attempt is made to open a database table
drh6ed48bf2007-06-14 20:57:18 +00001401** that another thread or process has locked.
drh33c1be32008-01-30 16:16:14 +00001402** If the busy callback is NULL, then [SQLITE_BUSY]
drhf5befa02007-12-06 02:42:07 +00001403** or [SQLITE_IOERR_BLOCKED]
drh6ed48bf2007-06-14 20:57:18 +00001404** is returned immediately upon encountering the lock.
drh33c1be32008-01-30 16:16:14 +00001405** If the busy callback is not NULL, then the
1406** callback will be invoked with two arguments. The
drh86939b52007-01-10 12:54:51 +00001407** first argument to the handler is a copy of the void* pointer which
drh33c1be32008-01-30 16:16:14 +00001408** is the third argument to this routine. The second argument to
drh86939b52007-01-10 12:54:51 +00001409** the handler is the number of times that the busy handler has
drh33c1be32008-01-30 16:16:14 +00001410** been invoked for this locking event. If the
drh6ed48bf2007-06-14 20:57:18 +00001411** busy callback returns 0, then no additional attempts are made to
1412** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned.
drh33c1be32008-01-30 16:16:14 +00001413** If the callback returns non-zero, then another attempt
drhfddfa2d2007-12-05 18:05:16 +00001414** is made to open the database for reading and the cycle repeats.
drh2dfbbca2000-07-28 14:32:48 +00001415**
drhf5befa02007-12-06 02:42:07 +00001416** The presence of a busy handler does not guarantee that
drh33c1be32008-01-30 16:16:14 +00001417** it will be invoked when there is lock contention.
drh86939b52007-01-10 12:54:51 +00001418** If SQLite determines that invoking the busy handler could result in
drhf5befa02007-12-06 02:42:07 +00001419** a deadlock, it will go ahead and return [SQLITE_BUSY] or
1420** [SQLITE_IOERR_BLOCKED] instead of invoking the
drh33c1be32008-01-30 16:16:14 +00001421** busy handler.
drh86939b52007-01-10 12:54:51 +00001422** Consider a scenario where one process is holding a read lock that
1423** it is trying to promote to a reserved lock and
1424** a second process is holding a reserved lock that it is trying
1425** to promote to an exclusive lock. The first process cannot proceed
1426** because it is blocked by the second and the second process cannot
1427** proceed because it is blocked by the first. If both processes
drhf5befa02007-12-06 02:42:07 +00001428** invoke the busy handlers, neither will make any progress. Therefore,
drh6ed48bf2007-06-14 20:57:18 +00001429** SQLite returns [SQLITE_BUSY] for the first process, hoping that this
drh86939b52007-01-10 12:54:51 +00001430** will induce the first process to release its read lock and allow
1431** the second process to proceed.
1432**
drh33c1be32008-01-30 16:16:14 +00001433** The default busy callback is NULL.
drh2dfbbca2000-07-28 14:32:48 +00001434**
drh33c1be32008-01-30 16:16:14 +00001435** The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED]
drhfddfa2d2007-12-05 18:05:16 +00001436** when SQLite is in the middle of a large transaction where all the
drh33c1be32008-01-30 16:16:14 +00001437** changes will not fit into the in-memory cache. SQLite will
drh6ed48bf2007-06-14 20:57:18 +00001438** already hold a RESERVED lock on the database file, but it needs
1439** to promote this lock to EXCLUSIVE so that it can spill cache
1440** pages into the database file without harm to concurrent
drh33c1be32008-01-30 16:16:14 +00001441** readers. If it is unable to promote the lock, then the in-memory
drh6ed48bf2007-06-14 20:57:18 +00001442** cache will be left in an inconsistent state and so the error
1443** code is promoted from the relatively benign [SQLITE_BUSY] to
drh33c1be32008-01-30 16:16:14 +00001444** the more severe [SQLITE_IOERR_BLOCKED]. This error code promotion
1445** forces an automatic rollback of the changes. See the
drh6ed48bf2007-06-14 20:57:18 +00001446** <a href="http://www.sqlite.org/cvstrac/wiki?p=CorruptionFollowingBusyError">
1447** CorruptionFollowingBusyError</a> wiki page for a discussion of why
1448** this is important.
1449**
drh33c1be32008-01-30 16:16:14 +00001450** There can only be a single busy handler defined for each database
drhfddfa2d2007-12-05 18:05:16 +00001451** connection. Setting a new busy handler clears any previous one.
drh33c1be32008-01-30 16:16:14 +00001452** Note that calling [sqlite3_busy_timeout()] will also set or clear
drh6ed48bf2007-06-14 20:57:18 +00001453** the busy handler.
drhd677b3d2007-08-20 22:48:41 +00001454**
drh33c1be32008-01-30 16:16:14 +00001455** INVARIANTS:
1456**
1457** {F12311} The [sqlite3_busy_handler()] function replaces the busy handler
1458** callback in the database connection identified by the 1st
1459** parameter with a new busy handler identified by the 2nd and 3rd
1460** parameters.
1461**
1462** {F12312} The default busy handler for new database connections is NULL.
1463**
shane26b34032008-05-23 17:21:09 +00001464** {F12314} When two or more database connection share a [sqlite3_enable_shared_cache | common cache],
drh33c1be32008-01-30 16:16:14 +00001465** the busy handler for the database connection currently using
1466** the cache is invoked when the cache encounters a lock.
1467**
1468** {F12316} If a busy handler callback returns zero, then the SQLite
1469** interface that provoked the locking event will return
1470** [SQLITE_BUSY].
1471**
shane26b34032008-05-23 17:21:09 +00001472** {F12318} SQLite will invokes the busy handler with two arguments which
drh33c1be32008-01-30 16:16:14 +00001473** are a copy of the pointer supplied by the 3rd parameter to
1474** [sqlite3_busy_handler()] and a count of the number of prior
1475** invocations of the busy handler for the same locking event.
1476**
1477** LIMITATIONS:
1478**
1479** {U12319} A busy handler should not call close the database connection
1480** or prepared statement that invoked the busy handler.
drh2dfbbca2000-07-28 14:32:48 +00001481*/
danielk1977f9d64d22004-06-19 08:18:07 +00001482int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*);
drh2dfbbca2000-07-28 14:32:48 +00001483
1484/*
drhfddfa2d2007-12-05 18:05:16 +00001485** CAPI3REF: Set A Busy Timeout {F12340}
drh6ed48bf2007-06-14 20:57:18 +00001486**
drh33c1be32008-01-30 16:16:14 +00001487** This routine sets a [sqlite3_busy_handler | busy handler]
drhf5befa02007-12-06 02:42:07 +00001488** that sleeps for a while when a
drh33c1be32008-01-30 16:16:14 +00001489** table is locked. The handler will sleep multiple times until
drhfddfa2d2007-12-05 18:05:16 +00001490** at least "ms" milliseconds of sleeping have been done. {F12343} After
drh6ed48bf2007-06-14 20:57:18 +00001491** "ms" milliseconds of sleeping, the handler returns 0 which
1492** causes [sqlite3_step()] to return [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED].
drh2dfbbca2000-07-28 14:32:48 +00001493**
drh33c1be32008-01-30 16:16:14 +00001494** Calling this routine with an argument less than or equal to zero
drh2dfbbca2000-07-28 14:32:48 +00001495** turns off all busy handlers.
drh6ed48bf2007-06-14 20:57:18 +00001496**
drh33c1be32008-01-30 16:16:14 +00001497** There can only be a single busy handler for a particular database
drh6ed48bf2007-06-14 20:57:18 +00001498** connection. If another busy handler was defined
1499** (using [sqlite3_busy_handler()]) prior to calling
1500** this routine, that other busy handler is cleared.
drh33c1be32008-01-30 16:16:14 +00001501**
1502** INVARIANTS:
1503**
1504** {F12341} The [sqlite3_busy_timeout()] function overrides any prior
1505** [sqlite3_busy_timeout()] or [sqlite3_busy_handler()] setting
1506** on the same database connection.
1507**
1508** {F12343} If the 2nd parameter to [sqlite3_busy_timeout()] is less than
1509** or equal to zero, then the busy handler is cleared so that
1510** all subsequent locking events immediately return [SQLITE_BUSY].
1511**
1512** {F12344} If the 2nd parameter to [sqlite3_busy_timeout()] is a positive
1513** number N, then a busy handler is set that repeatedly calls
1514** the xSleep() method in the VFS interface until either the
1515** lock clears or until the cumulative sleep time reported back
1516** by xSleep() exceeds N milliseconds.
drh2dfbbca2000-07-28 14:32:48 +00001517*/
danielk1977f9d64d22004-06-19 08:18:07 +00001518int sqlite3_busy_timeout(sqlite3*, int ms);
drh2dfbbca2000-07-28 14:32:48 +00001519
drhe3710332000-09-29 13:30:53 +00001520/*
drhfddfa2d2007-12-05 18:05:16 +00001521** CAPI3REF: Convenience Routines For Running Queries {F12370}
drh6ed48bf2007-06-14 20:57:18 +00001522**
drh33c1be32008-01-30 16:16:14 +00001523** Definition: A <b>result table</b> is memory data structure created by the
1524** [sqlite3_get_table()] interface. A result table records the
1525** complete query results from one or more queries.
drha18c5682000-10-08 22:20:57 +00001526**
drh33c1be32008-01-30 16:16:14 +00001527** The table conceptually has a number of rows and columns. But
1528** these numbers are not part of the result table itself. These
1529** numbers are obtained separately. Let N be the number of rows
1530** and M be the number of columns.
1531**
1532** A result table is an array of pointers to zero-terminated
1533** UTF-8 strings. There are (N+1)*M elements in the array.
1534** The first M pointers point to zero-terminated strings that
1535** contain the names of the columns.
1536** The remaining entries all point to query results. NULL
1537** values are give a NULL pointer. All other values are in
1538** their UTF-8 zero-terminated string representation as returned by
1539** [sqlite3_column_text()].
1540**
1541** A result table might consists of one or more memory allocations.
1542** It is not safe to pass a result table directly to [sqlite3_free()].
1543** A result table should be deallocated using [sqlite3_free_table()].
1544**
1545** As an example of the result table format, suppose a query result
1546** is as follows:
drha18c5682000-10-08 22:20:57 +00001547**
drh8bacf972007-08-25 16:21:29 +00001548** <blockquote><pre>
drha18c5682000-10-08 22:20:57 +00001549** Name | Age
1550** -----------------------
1551** Alice | 43
1552** Bob | 28
1553** Cindy | 21
drh8bacf972007-08-25 16:21:29 +00001554** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001555**
drh33c1be32008-01-30 16:16:14 +00001556** There are two column (M==2) and three rows (N==3). Thus the
1557** result table has 8 entries. Suppose the result table is stored
1558** in an array names azResult. Then azResult holds this content:
drha18c5682000-10-08 22:20:57 +00001559**
drh8bacf972007-08-25 16:21:29 +00001560** <blockquote><pre>
1561** azResult&#91;0] = "Name";
1562** azResult&#91;1] = "Age";
1563** azResult&#91;2] = "Alice";
1564** azResult&#91;3] = "43";
1565** azResult&#91;4] = "Bob";
1566** azResult&#91;5] = "28";
1567** azResult&#91;6] = "Cindy";
1568** azResult&#91;7] = "21";
1569** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001570**
drh33c1be32008-01-30 16:16:14 +00001571** The sqlite3_get_table() function evaluates one or more
1572** semicolon-separated SQL statements in the zero-terminated UTF-8
1573** string of its 2nd parameter. It returns a result table to the
1574** pointer given in its 3rd parameter.
drha18c5682000-10-08 22:20:57 +00001575**
drh33c1be32008-01-30 16:16:14 +00001576** After the calling function has finished using the result, it should
1577** pass the pointer to the result table to sqlite3_free_table() in order to
shane26b34032008-05-23 17:21:09 +00001578** release the memory that was malloced. Because of the way the
drh33c1be32008-01-30 16:16:14 +00001579** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling
1580** function must not try to call [sqlite3_free()] directly. Only
1581** [sqlite3_free_table()] is able to release the memory properly and safely.
drhe3710332000-09-29 13:30:53 +00001582**
drh33c1be32008-01-30 16:16:14 +00001583** The sqlite3_get_table() interface is implemented as a wrapper around
1584** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access
1585** to any internal data structures of SQLite. It uses only the public
1586** interface defined here. As a consequence, errors that occur in the
1587** wrapper layer outside of the internal [sqlite3_exec()] call are not
1588** reflected in subsequent calls to [sqlite3_errcode()] or
1589** [sqlite3_errmsg()].
1590**
1591** INVARIANTS:
1592**
1593** {F12371} If a [sqlite3_get_table()] fails a memory allocation, then
1594** it frees the result table under construction, aborts the
1595** query in process, skips any subsequent queries, sets the
1596** *resultp output pointer to NULL and returns [SQLITE_NOMEM].
1597**
1598** {F12373} If the ncolumn parameter to [sqlite3_get_table()] is not NULL
1599** then [sqlite3_get_table()] write the number of columns in the
1600** result set of the query into *ncolumn if the query is
1601** successful (if the function returns SQLITE_OK).
1602**
1603** {F12374} If the nrow parameter to [sqlite3_get_table()] is not NULL
1604** then [sqlite3_get_table()] write the number of rows in the
1605** result set of the query into *nrow if the query is
1606** successful (if the function returns SQLITE_OK).
1607**
drh21ac7f92008-01-31 12:26:49 +00001608** {F12376} The [sqlite3_get_table()] function sets its *ncolumn value
drh33c1be32008-01-30 16:16:14 +00001609** to the number of columns in the result set of the query in the
1610** sql parameter, or to zero if the query in sql has an empty
1611** result set.
drhe3710332000-09-29 13:30:53 +00001612*/
danielk19776f8a5032004-05-10 10:34:51 +00001613int sqlite3_get_table(
drh33c1be32008-01-30 16:16:14 +00001614 sqlite3*, /* An open database */
1615 const char *sql, /* SQL to be evaluated */
1616 char ***pResult, /* Results of the query */
1617 int *nrow, /* Number of result rows written here */
1618 int *ncolumn, /* Number of result columns written here */
1619 char **errmsg /* Error msg written here */
drhe3710332000-09-29 13:30:53 +00001620);
danielk19776f8a5032004-05-10 10:34:51 +00001621void sqlite3_free_table(char **result);
drhe3710332000-09-29 13:30:53 +00001622
drha18c5682000-10-08 22:20:57 +00001623/*
drhfddfa2d2007-12-05 18:05:16 +00001624** CAPI3REF: Formatted String Printing Functions {F17400}
drh6ed48bf2007-06-14 20:57:18 +00001625**
1626** These routines are workalikes of the "printf()" family of functions
1627** from the standard C library.
1628**
drh33c1be32008-01-30 16:16:14 +00001629** The sqlite3_mprintf() and sqlite3_vmprintf() routines write their
drh6d2069d2007-08-14 01:58:53 +00001630** results into memory obtained from [sqlite3_malloc()].
drh33c1be32008-01-30 16:16:14 +00001631** The strings returned by these two routines should be
1632** released by [sqlite3_free()]. Both routines return a
drh6ed48bf2007-06-14 20:57:18 +00001633** NULL pointer if [sqlite3_malloc()] is unable to allocate enough
1634** memory to hold the resulting string.
1635**
drh33c1be32008-01-30 16:16:14 +00001636** In sqlite3_snprintf() routine is similar to "snprintf()" from
drh6ed48bf2007-06-14 20:57:18 +00001637** the standard C library. The result is written into the
1638** buffer supplied as the second parameter whose size is given by
drh33c1be32008-01-30 16:16:14 +00001639** the first parameter. Note that the order of the
drh6ed48bf2007-06-14 20:57:18 +00001640** first two parameters is reversed from snprintf(). This is an
1641** historical accident that cannot be fixed without breaking
drh33c1be32008-01-30 16:16:14 +00001642** backwards compatibility. Note also that sqlite3_snprintf()
drh6ed48bf2007-06-14 20:57:18 +00001643** returns a pointer to its buffer instead of the number of
drh33c1be32008-01-30 16:16:14 +00001644** characters actually written into the buffer. We admit that
drh6ed48bf2007-06-14 20:57:18 +00001645** the number of characters written would be a more useful return
1646** value but we cannot change the implementation of sqlite3_snprintf()
1647** now without breaking compatibility.
1648**
drh33c1be32008-01-30 16:16:14 +00001649** As long as the buffer size is greater than zero, sqlite3_snprintf()
1650** guarantees that the buffer is always zero-terminated. The first
drh6ed48bf2007-06-14 20:57:18 +00001651** parameter "n" is the total size of the buffer, including space for
drh33c1be32008-01-30 16:16:14 +00001652** the zero terminator. So the longest string that can be completely
drh6ed48bf2007-06-14 20:57:18 +00001653** written will be n-1 characters.
1654**
1655** These routines all implement some additional formatting
drh4f26d6c2004-05-26 23:25:30 +00001656** options that are useful for constructing SQL statements.
shane26b34032008-05-23 17:21:09 +00001657** All of the usual printf() formatting options apply. In addition, there
drh153c62c2007-08-24 03:51:33 +00001658** is are "%q", "%Q", and "%z" options.
drh6ed48bf2007-06-14 20:57:18 +00001659**
drh33c1be32008-01-30 16:16:14 +00001660** The %q option works like %s in that it substitutes a null-terminated
drh66b89c82000-11-28 20:47:17 +00001661** string from the argument list. But %q also doubles every '\'' character.
drh33c1be32008-01-30 16:16:14 +00001662** %q is designed for use inside a string literal. By doubling each '\''
drh66b89c82000-11-28 20:47:17 +00001663** character it escapes that character and allows it to be inserted into
drha18c5682000-10-08 22:20:57 +00001664** the string.
1665**
1666** For example, so some string variable contains text as follows:
1667**
drh6ed48bf2007-06-14 20:57:18 +00001668** <blockquote><pre>
1669** char *zText = "It's a happy day!";
1670** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001671**
drh6ed48bf2007-06-14 20:57:18 +00001672** One can use this text in an SQL statement as follows:
drha18c5682000-10-08 22:20:57 +00001673**
drh6ed48bf2007-06-14 20:57:18 +00001674** <blockquote><pre>
1675** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText);
1676** sqlite3_exec(db, zSQL, 0, 0, 0);
1677** sqlite3_free(zSQL);
1678** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001679**
1680** Because the %q format string is used, the '\'' character in zText
1681** is escaped and the SQL generated is as follows:
1682**
drh6ed48bf2007-06-14 20:57:18 +00001683** <blockquote><pre>
1684** INSERT INTO table1 VALUES('It''s a happy day!')
1685** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001686**
1687** This is correct. Had we used %s instead of %q, the generated SQL
1688** would have looked like this:
1689**
drh6ed48bf2007-06-14 20:57:18 +00001690** <blockquote><pre>
1691** INSERT INTO table1 VALUES('It's a happy day!');
1692** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001693**
1694** This second example is an SQL syntax error. As a general rule you
1695** should always use %q instead of %s when inserting text into a string
1696** literal.
drh6ed48bf2007-06-14 20:57:18 +00001697**
drh33c1be32008-01-30 16:16:14 +00001698** The %Q option works like %q except it also adds single quotes around
drh6ed48bf2007-06-14 20:57:18 +00001699** the outside of the total string. Or if the parameter in the argument
1700** list is a NULL pointer, %Q substitutes the text "NULL" (without single
drhfddfa2d2007-12-05 18:05:16 +00001701** quotes) in place of the %Q option. {END} So, for example, one could say:
drh6ed48bf2007-06-14 20:57:18 +00001702**
1703** <blockquote><pre>
1704** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText);
1705** sqlite3_exec(db, zSQL, 0, 0, 0);
1706** sqlite3_free(zSQL);
1707** </pre></blockquote>
1708**
1709** The code above will render a correct SQL statement in the zSQL
1710** variable even if the zText variable is a NULL pointer.
drh153c62c2007-08-24 03:51:33 +00001711**
drh33c1be32008-01-30 16:16:14 +00001712** The "%z" formatting option works exactly like "%s" with the
drh153c62c2007-08-24 03:51:33 +00001713** addition that after the string has been read and copied into
drhfddfa2d2007-12-05 18:05:16 +00001714** the result, [sqlite3_free()] is called on the input string. {END}
drh33c1be32008-01-30 16:16:14 +00001715**
1716** INVARIANTS:
1717**
1718** {F17403} The [sqlite3_mprintf()] and [sqlite3_vmprintf()] interfaces
1719** return either pointers to zero-terminated UTF-8 strings held in
1720** memory obtained from [sqlite3_malloc()] or NULL pointers if
1721** a call to [sqlite3_malloc()] fails.
1722**
1723** {F17406} The [sqlite3_snprintf()] interface writes a zero-terminated
1724** UTF-8 string into the buffer pointed to by the second parameter
1725** provided that the first parameter is greater than zero.
1726**
1727** {F17407} The [sqlite3_snprintf()] interface does not writes slots of
1728** its output buffer (the second parameter) outside the range
1729** of 0 through N-1 (where N is the first parameter)
1730** regardless of the length of the string
1731** requested by the format specification.
1732**
drha18c5682000-10-08 22:20:57 +00001733*/
danielk19776f8a5032004-05-10 10:34:51 +00001734char *sqlite3_mprintf(const char*,...);
1735char *sqlite3_vmprintf(const char*, va_list);
drhfeac5f82004-08-01 00:10:45 +00001736char *sqlite3_snprintf(int,char*,const char*, ...);
drh5191b7e2002-03-08 02:12:00 +00001737
drh28dd4792006-06-26 21:35:44 +00001738/*
drhfddfa2d2007-12-05 18:05:16 +00001739** CAPI3REF: Memory Allocation Subsystem {F17300}
drhd84f9462007-08-15 11:28:56 +00001740**
drh33c1be32008-01-30 16:16:14 +00001741** The SQLite core uses these three routines for all of its own
1742** internal memory allocation needs. "Core" in the previous sentence
drhf5befa02007-12-06 02:42:07 +00001743** does not include operating-system specific VFS implementation. The
shane26b34032008-05-23 17:21:09 +00001744** Windows VFS uses native malloc() and free() for some operations.
drhd64621d2007-11-05 17:54:17 +00001745**
drh33c1be32008-01-30 16:16:14 +00001746** The sqlite3_malloc() routine returns a pointer to a block
drhfddfa2d2007-12-05 18:05:16 +00001747** of memory at least N bytes in length, where N is the parameter.
drh33c1be32008-01-30 16:16:14 +00001748** If sqlite3_malloc() is unable to obtain sufficient free
1749** memory, it returns a NULL pointer. If the parameter N to
drhfddfa2d2007-12-05 18:05:16 +00001750** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns
1751** a NULL pointer.
1752**
drh33c1be32008-01-30 16:16:14 +00001753** Calling sqlite3_free() with a pointer previously returned
drhfddfa2d2007-12-05 18:05:16 +00001754** by sqlite3_malloc() or sqlite3_realloc() releases that memory so
drh33c1be32008-01-30 16:16:14 +00001755** that it might be reused. The sqlite3_free() routine is
drhfddfa2d2007-12-05 18:05:16 +00001756** a no-op if is called with a NULL pointer. Passing a NULL pointer
drh33c1be32008-01-30 16:16:14 +00001757** to sqlite3_free() is harmless. After being freed, memory
drhfddfa2d2007-12-05 18:05:16 +00001758** should neither be read nor written. Even reading previously freed
1759** memory might result in a segmentation fault or other severe error.
drh33c1be32008-01-30 16:16:14 +00001760** Memory corruption, a segmentation fault, or other severe error
drhfddfa2d2007-12-05 18:05:16 +00001761** might result if sqlite3_free() is called with a non-NULL pointer that
1762** was not obtained from sqlite3_malloc() or sqlite3_free().
1763**
drh33c1be32008-01-30 16:16:14 +00001764** The sqlite3_realloc() interface attempts to resize a
drhfddfa2d2007-12-05 18:05:16 +00001765** prior memory allocation to be at least N bytes, where N is the
1766** second parameter. The memory allocation to be resized is the first
drh33c1be32008-01-30 16:16:14 +00001767** parameter. If the first parameter to sqlite3_realloc()
drhfddfa2d2007-12-05 18:05:16 +00001768** is a NULL pointer then its behavior is identical to calling
1769** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc().
drh33c1be32008-01-30 16:16:14 +00001770** If the second parameter to sqlite3_realloc() is zero or
drhfddfa2d2007-12-05 18:05:16 +00001771** negative then the behavior is exactly the same as calling
1772** sqlite3_free(P) where P is the first parameter to sqlite3_realloc().
drh33c1be32008-01-30 16:16:14 +00001773** Sqlite3_realloc() returns a pointer to a memory allocation
drhfddfa2d2007-12-05 18:05:16 +00001774** of at least N bytes in size or NULL if sufficient memory is unavailable.
drh33c1be32008-01-30 16:16:14 +00001775** If M is the size of the prior allocation, then min(N,M) bytes
drhfddfa2d2007-12-05 18:05:16 +00001776** of the prior allocation are copied into the beginning of buffer returned
1777** by sqlite3_realloc() and the prior allocation is freed.
drh33c1be32008-01-30 16:16:14 +00001778** If sqlite3_realloc() returns NULL, then the prior allocation
drhfddfa2d2007-12-05 18:05:16 +00001779** is not freed.
1780**
drh33c1be32008-01-30 16:16:14 +00001781** The memory returned by sqlite3_malloc() and sqlite3_realloc()
drhf5befa02007-12-06 02:42:07 +00001782** is always aligned to at least an 8 byte boundary. {END}
1783**
drh33c1be32008-01-30 16:16:14 +00001784** The default implementation
drhd84f9462007-08-15 11:28:56 +00001785** of the memory allocation subsystem uses the malloc(), realloc()
drhfddfa2d2007-12-05 18:05:16 +00001786** and free() provided by the standard C library. {F17382} However, if
drhd84f9462007-08-15 11:28:56 +00001787** SQLite is compiled with the following C preprocessor macro
1788**
drhd64621d2007-11-05 17:54:17 +00001789** <blockquote> SQLITE_MEMORY_SIZE=<i>NNN</i> </blockquote>
drhd84f9462007-08-15 11:28:56 +00001790**
drhd64621d2007-11-05 17:54:17 +00001791** where <i>NNN</i> is an integer, then SQLite create a static
1792** array of at least <i>NNN</i> bytes in size and use that array
drhfddfa2d2007-12-05 18:05:16 +00001793** for all of its dynamic memory allocation needs. {END} Additional
1794** memory allocator options may be added in future releases.
drhd64621d2007-11-05 17:54:17 +00001795**
1796** In SQLite version 3.5.0 and 3.5.1, it was possible to define
1797** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in
1798** implementation of these routines to be omitted. That capability
1799** is no longer provided. Only built-in memory allocators can be
1800** used.
drh8bacf972007-08-25 16:21:29 +00001801**
shane26b34032008-05-23 17:21:09 +00001802** The Windows OS interface layer calls
drh8bacf972007-08-25 16:21:29 +00001803** the system malloc() and free() directly when converting
1804** filenames between the UTF-8 encoding used by SQLite
shane26b34032008-05-23 17:21:09 +00001805** and whatever filename encoding is used by the particular Windows
drh8bacf972007-08-25 16:21:29 +00001806** installation. Memory allocation errors are detected, but
1807** they are reported back as [SQLITE_CANTOPEN] or
1808** [SQLITE_IOERR] rather than [SQLITE_NOMEM].
drh33c1be32008-01-30 16:16:14 +00001809**
1810** INVARIANTS:
1811**
1812** {F17303} The [sqlite3_malloc(N)] interface returns either a pointer to
1813** newly checked-out block of at least N bytes of memory
1814** that is 8-byte aligned,
1815** or it returns NULL if it is unable to fulfill the request.
1816**
1817** {F17304} The [sqlite3_malloc(N)] interface returns a NULL pointer if
1818** N is less than or equal to zero.
1819**
1820** {F17305} The [sqlite3_free(P)] interface releases memory previously
1821** returned from [sqlite3_malloc()] or [sqlite3_realloc()],
1822** making it available for reuse.
1823**
1824** {F17306} A call to [sqlite3_free(NULL)] is a harmless no-op.
1825**
1826** {F17310} A call to [sqlite3_realloc(0,N)] is equivalent to a call
1827** to [sqlite3_malloc(N)].
1828**
1829** {F17312} A call to [sqlite3_realloc(P,0)] is equivalent to a call
1830** to [sqlite3_free(P)].
1831**
1832** {F17315} The SQLite core uses [sqlite3_malloc()], [sqlite3_realloc()],
1833** and [sqlite3_free()] for all of its memory allocation and
1834** deallocation needs.
1835**
1836** {F17318} The [sqlite3_realloc(P,N)] interface returns either a pointer
1837** to a block of checked-out memory of at least N bytes in size
1838** that is 8-byte aligned, or a NULL pointer.
1839**
1840** {F17321} When [sqlite3_realloc(P,N)] returns a non-NULL pointer, it first
1841** copies the first K bytes of content from P into the newly allocated
shane26b34032008-05-23 17:21:09 +00001842** where K is the lesser of N and the size of the buffer P.
drh33c1be32008-01-30 16:16:14 +00001843**
1844** {F17322} When [sqlite3_realloc(P,N)] returns a non-NULL pointer, it first
1845** releases the buffer P.
1846**
1847** {F17323} When [sqlite3_realloc(P,N)] returns NULL, the buffer P is
1848** not modified or released.
1849**
1850** LIMITATIONS:
1851**
1852** {U17350} The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()]
1853** must be either NULL or else a pointer obtained from a prior
1854** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that has
1855** not been released.
1856**
1857** {U17351} The application must not read or write any part of
1858** a block of memory after it has been released using
1859** [sqlite3_free()] or [sqlite3_realloc()].
1860**
drh28dd4792006-06-26 21:35:44 +00001861*/
drhf3a65f72007-08-22 20:18:21 +00001862void *sqlite3_malloc(int);
1863void *sqlite3_realloc(void*, int);
drh28dd4792006-06-26 21:35:44 +00001864void sqlite3_free(void*);
1865
drh5191b7e2002-03-08 02:12:00 +00001866/*
drhfddfa2d2007-12-05 18:05:16 +00001867** CAPI3REF: Memory Allocator Statistics {F17370}
drhd84f9462007-08-15 11:28:56 +00001868**
drh33c1be32008-01-30 16:16:14 +00001869** SQLite provides these two interfaces for reporting on the status
1870** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()]
1871** the memory allocation subsystem included within the SQLite.
drhd84f9462007-08-15 11:28:56 +00001872**
drh33c1be32008-01-30 16:16:14 +00001873** INVARIANTS:
1874**
1875** {F17371} The [sqlite3_memory_used()] routine returns the
1876** number of bytes of memory currently outstanding
1877** (malloced but not freed).
1878**
1879** {F17373} The [sqlite3_memory_highwater()] routine returns the maximum
1880** value of [sqlite3_memory_used()]
shane26b34032008-05-23 17:21:09 +00001881** since the high-water mark was last reset.
drh33c1be32008-01-30 16:16:14 +00001882**
1883** {F17374} The values returned by [sqlite3_memory_used()] and
1884** [sqlite3_memory_highwater()] include any overhead
1885** added by SQLite in its implementation of [sqlite3_malloc()],
1886** but not overhead added by the any underlying system library
1887** routines that [sqlite3_malloc()] may call.
1888**
shane26b34032008-05-23 17:21:09 +00001889** {F17375} The memory high-water mark is reset to the current value of
drh33c1be32008-01-30 16:16:14 +00001890** [sqlite3_memory_used()] if and only if the parameter to
1891** [sqlite3_memory_highwater()] is true. The value returned
shane26b34032008-05-23 17:21:09 +00001892** by [sqlite3_memory_highwater(1)] is the high-water mark
drh33c1be32008-01-30 16:16:14 +00001893** prior to the reset.
drhd84f9462007-08-15 11:28:56 +00001894*/
drh153c62c2007-08-24 03:51:33 +00001895sqlite3_int64 sqlite3_memory_used(void);
1896sqlite3_int64 sqlite3_memory_highwater(int resetFlag);
drhd84f9462007-08-15 11:28:56 +00001897
1898/*
drh2fa18682008-03-19 14:15:34 +00001899** CAPI3REF: Pseudo-Random Number Generator {F17390}
1900**
1901** SQLite contains a high-quality pseudo-random number generator (PRNG) used to
1902** select random ROWIDs when inserting new records into a table that
1903** already uses the largest possible ROWID. The PRNG is also used for
1904** the build-in random() and randomblob() SQL functions. This interface allows
shane26b34032008-05-23 17:21:09 +00001905** applications to access the same PRNG for other purposes.
drh2fa18682008-03-19 14:15:34 +00001906**
1907** A call to this routine stores N bytes of randomness into buffer P.
1908**
1909** The first time this routine is invoked (either internally or by
1910** the application) the PRNG is seeded using randomness obtained
1911** from the xRandomness method of the default [sqlite3_vfs] object.
1912** On all subsequent invocations, the pseudo-randomness is generated
1913** internally and without recourse to the [sqlite3_vfs] xRandomness
1914** method.
1915**
1916** INVARIANTS:
1917**
1918** {F17392} The [sqlite3_randomness(N,P)] interface writes N bytes of
1919** high-quality pseudo-randomness into buffer P.
1920*/
1921void sqlite3_randomness(int N, void *P);
1922
1923/*
drhfddfa2d2007-12-05 18:05:16 +00001924** CAPI3REF: Compile-Time Authorization Callbacks {F12500}
1925**
drh33c1be32008-01-30 16:16:14 +00001926** This routine registers a authorizer callback with a particular
drhf47ce562008-03-20 18:00:49 +00001927** [database connection], supplied in the first argument.
drh6ed48bf2007-06-14 20:57:18 +00001928** The authorizer callback is invoked as SQL statements are being compiled
1929** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()],
drh33c1be32008-01-30 16:16:14 +00001930** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. At various
drh6ed48bf2007-06-14 20:57:18 +00001931** points during the compilation process, as logic is being created
1932** to perform various actions, the authorizer callback is invoked to
drhf5befa02007-12-06 02:42:07 +00001933** see if those actions are allowed. The authorizer callback should
drhf47ce562008-03-20 18:00:49 +00001934** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the
drh6ed48bf2007-06-14 20:57:18 +00001935** specific action but allow the SQL statement to continue to be
1936** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be
drh33c1be32008-01-30 16:16:14 +00001937** rejected with an error. If the authorizer callback returns
drhf5befa02007-12-06 02:42:07 +00001938** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY]
1939** then [sqlite3_prepare_v2()] or equivalent call that triggered
drh33c1be32008-01-30 16:16:14 +00001940** the authorizer will fail with an error message.
drh6ed48bf2007-06-14 20:57:18 +00001941**
drhf5befa02007-12-06 02:42:07 +00001942** When the callback returns [SQLITE_OK], that means the operation
drh33c1be32008-01-30 16:16:14 +00001943** requested is ok. When the callback returns [SQLITE_DENY], the
drhf5befa02007-12-06 02:42:07 +00001944** [sqlite3_prepare_v2()] or equivalent call that triggered the
drh33c1be32008-01-30 16:16:14 +00001945** authorizer will fail with an error message explaining that
1946** access is denied. If the authorizer code is [SQLITE_READ]
drhf47ce562008-03-20 18:00:49 +00001947** and the callback returns [SQLITE_IGNORE] then the
1948** [prepared statement] statement is constructed to substitute
1949** a NULL value in place of the table column that would have
drh33c1be32008-01-30 16:16:14 +00001950** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE]
1951** return can be used to deny an untrusted user access to individual
1952** columns of a table.
drh6ed48bf2007-06-14 20:57:18 +00001953**
drh33c1be32008-01-30 16:16:14 +00001954** The first parameter to the authorizer callback is a copy of
drh6ed48bf2007-06-14 20:57:18 +00001955** the third parameter to the sqlite3_set_authorizer() interface.
drh33c1be32008-01-30 16:16:14 +00001956** The second parameter to the callback is an integer
drh6ed48bf2007-06-14 20:57:18 +00001957** [SQLITE_COPY | action code] that specifies the particular action
drh33c1be32008-01-30 16:16:14 +00001958** to be authorized. The third through sixth
drhfddfa2d2007-12-05 18:05:16 +00001959** parameters to the callback are zero-terminated strings that contain
drh33c1be32008-01-30 16:16:14 +00001960** additional details about the action to be authorized.
drh6ed48bf2007-06-14 20:57:18 +00001961**
drhf47ce562008-03-20 18:00:49 +00001962** An authorizer is used when [sqlite3_prepare | preparing]
1963** SQL statements from an untrusted
drh6ed48bf2007-06-14 20:57:18 +00001964** source, to ensure that the SQL statements do not try to access data
1965** that they are not allowed to see, or that they do not try to
1966** execute malicious statements that damage the database. For
1967** example, an application may allow a user to enter arbitrary
1968** SQL queries for evaluation by a database. But the application does
1969** not want the user to be able to make arbitrary changes to the
1970** database. An authorizer could then be put in place while the
drhf47ce562008-03-20 18:00:49 +00001971** user-entered SQL is being [sqlite3_prepare | prepared] that
1972** disallows everything except [SELECT] statements.
1973**
1974** Applications that need to process SQL from untrusted sources
1975** might also consider lowering resource limits using [sqlite3_limit()]
1976** and limiting database size using the [max_page_count] [PRAGMA]
1977** in addition to using an authorizer.
drh6ed48bf2007-06-14 20:57:18 +00001978**
drh33c1be32008-01-30 16:16:14 +00001979** Only a single authorizer can be in place on a database connection
drh6ed48bf2007-06-14 20:57:18 +00001980** at a time. Each call to sqlite3_set_authorizer overrides the
drh33c1be32008-01-30 16:16:14 +00001981** previous call. Disable the authorizer by installing a NULL callback.
1982** The authorizer is disabled by default.
drh6ed48bf2007-06-14 20:57:18 +00001983**
1984** Note that the authorizer callback is invoked only during
drh33c1be32008-01-30 16:16:14 +00001985** [sqlite3_prepare()] or its variants. Authorization is not
1986** performed during statement evaluation in [sqlite3_step()].
1987**
1988** INVARIANTS:
1989**
1990** {F12501} The [sqlite3_set_authorizer(D,...)] interface registers a
1991** authorizer callback with database connection D.
1992**
1993** {F12502} The authorizer callback is invoked as SQL statements are
1994** being compiled
1995**
1996** {F12503} If the authorizer callback returns any value other than
1997** [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY] then
1998** the [sqlite3_prepare_v2()] or equivalent call that caused
1999** the authorizer callback to run shall fail with an
2000** [SQLITE_ERROR] error code and an appropriate error message.
2001**
2002** {F12504} When the authorizer callback returns [SQLITE_OK], the operation
2003** described is coded normally.
2004**
2005** {F12505} When the authorizer callback returns [SQLITE_DENY], the
2006** [sqlite3_prepare_v2()] or equivalent call that caused the
2007** authorizer callback to run shall fail
2008** with an [SQLITE_ERROR] error code and an error message
2009** explaining that access is denied.
2010**
2011** {F12506} If the authorizer code (the 2nd parameter to the authorizer
2012** callback) is [SQLITE_READ] and the authorizer callback returns
2013** [SQLITE_IGNORE] then the prepared statement is constructed to
2014** insert a NULL value in place of the table column that would have
2015** been read if [SQLITE_OK] had been returned.
2016**
2017** {F12507} If the authorizer code (the 2nd parameter to the authorizer
2018** callback) is anything other than [SQLITE_READ], then
2019** a return of [SQLITE_IGNORE] has the same effect as [SQLITE_DENY].
2020**
2021** {F12510} The first parameter to the authorizer callback is a copy of
2022** the third parameter to the [sqlite3_set_authorizer()] interface.
2023**
2024** {F12511} The second parameter to the callback is an integer
2025** [SQLITE_COPY | action code] that specifies the particular action
2026** to be authorized.
2027**
2028** {F12512} The third through sixth parameters to the callback are
2029** zero-terminated strings that contain
2030** additional details about the action to be authorized.
2031**
2032** {F12520} Each call to [sqlite3_set_authorizer()] overrides the
2033** any previously installed authorizer.
2034**
2035** {F12521} A NULL authorizer means that no authorization
2036** callback is invoked.
2037**
2038** {F12522} The default authorizer is NULL.
drhed6c8672003-01-12 18:02:16 +00002039*/
danielk19776f8a5032004-05-10 10:34:51 +00002040int sqlite3_set_authorizer(
danielk1977f9d64d22004-06-19 08:18:07 +00002041 sqlite3*,
drhe22a3342003-04-22 20:30:37 +00002042 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
drhe5f9c642003-01-13 23:27:31 +00002043 void *pUserData
drhed6c8672003-01-12 18:02:16 +00002044);
2045
2046/*
drhf5befa02007-12-06 02:42:07 +00002047** CAPI3REF: Authorizer Return Codes {F12590}
drh6ed48bf2007-06-14 20:57:18 +00002048**
2049** The [sqlite3_set_authorizer | authorizer callback function] must
2050** return either [SQLITE_OK] or one of these two constants in order
2051** to signal SQLite whether or not the action is permitted. See the
2052** [sqlite3_set_authorizer | authorizer documentation] for additional
2053** information.
2054*/
2055#define SQLITE_DENY 1 /* Abort the SQL statement with an error */
2056#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
2057
2058/*
drhf5befa02007-12-06 02:42:07 +00002059** CAPI3REF: Authorizer Action Codes {F12550}
drh6ed48bf2007-06-14 20:57:18 +00002060**
2061** The [sqlite3_set_authorizer()] interface registers a callback function
drh33c1be32008-01-30 16:16:14 +00002062** that is invoked to authorizer certain SQL statement actions. The
drh6ed48bf2007-06-14 20:57:18 +00002063** second parameter to the callback is an integer code that specifies
2064** what action is being authorized. These are the integer action codes that
drh33c1be32008-01-30 16:16:14 +00002065** the authorizer callback may be passed.
drh6ed48bf2007-06-14 20:57:18 +00002066**
2067** These action code values signify what kind of operation is to be
drh33c1be32008-01-30 16:16:14 +00002068** authorized. The 3rd and 4th parameters to the authorization
drhf5befa02007-12-06 02:42:07 +00002069** callback function will be parameters or NULL depending on which of these
drh33c1be32008-01-30 16:16:14 +00002070** codes is used as the second parameter. The 5th parameter to the
drh6ed48bf2007-06-14 20:57:18 +00002071** authorizer callback is the name of the database ("main", "temp",
drh33c1be32008-01-30 16:16:14 +00002072** etc.) if applicable. The 6th parameter to the authorizer callback
drh5cf590c2003-04-24 01:45:04 +00002073** is the name of the inner-most trigger or view that is responsible for
2074** the access attempt or NULL if this access attempt is directly from
drh6ed48bf2007-06-14 20:57:18 +00002075** top-level SQL code.
drh33c1be32008-01-30 16:16:14 +00002076**
2077** INVARIANTS:
2078**
2079** {F12551} The second parameter to an
shane26b34032008-05-23 17:21:09 +00002080** [sqlite3_set_authorizer | authorizer callback] is always an integer
drh33c1be32008-01-30 16:16:14 +00002081** [SQLITE_COPY | authorizer code] that specifies what action
2082** is being authorized.
2083**
2084** {F12552} The 3rd and 4th parameters to the
2085** [sqlite3_set_authorizer | authorization callback function]
2086** will be parameters or NULL depending on which
2087** [SQLITE_COPY | authorizer code] is used as the second parameter.
2088**
2089** {F12553} The 5th parameter to the
2090** [sqlite3_set_authorizer | authorizer callback] is the name
2091** of the database (example: "main", "temp", etc.) if applicable.
2092**
2093** {F12554} The 6th parameter to the
2094** [sqlite3_set_authorizer | authorizer callback] is the name
2095** of the inner-most trigger or view that is responsible for
2096** the access attempt or NULL if this access attempt is directly from
2097** top-level SQL code.
drhed6c8672003-01-12 18:02:16 +00002098*/
drh6ed48bf2007-06-14 20:57:18 +00002099/******************************************* 3rd ************ 4th ***********/
drhe5f9c642003-01-13 23:27:31 +00002100#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */
2101#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */
2102#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */
2103#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +00002104#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00002105#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */
drh77ad4e42003-01-14 02:49:27 +00002106#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00002107#define SQLITE_CREATE_VIEW 8 /* View Name NULL */
2108#define SQLITE_DELETE 9 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +00002109#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00002110#define SQLITE_DROP_TABLE 11 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +00002111#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00002112#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +00002113#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00002114#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */
drh77ad4e42003-01-14 02:49:27 +00002115#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00002116#define SQLITE_DROP_VIEW 17 /* View Name NULL */
2117#define SQLITE_INSERT 18 /* Table Name NULL */
2118#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */
2119#define SQLITE_READ 20 /* Table Name Column Name */
2120#define SQLITE_SELECT 21 /* NULL NULL */
2121#define SQLITE_TRANSACTION 22 /* NULL NULL */
2122#define SQLITE_UPDATE 23 /* Table Name Column Name */
drh81e293b2003-06-06 19:00:42 +00002123#define SQLITE_ATTACH 24 /* Filename NULL */
2124#define SQLITE_DETACH 25 /* Database Name NULL */
danielk19771c8c23c2004-11-12 15:53:37 +00002125#define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */
danielk19771d54df82004-11-23 15:41:16 +00002126#define SQLITE_REINDEX 27 /* Index Name NULL */
drhe6e04962005-07-23 02:17:03 +00002127#define SQLITE_ANALYZE 28 /* Table Name NULL */
danielk1977f1a381e2006-06-16 08:01:02 +00002128#define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */
2129#define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */
drh5169bbc2006-08-24 14:59:45 +00002130#define SQLITE_FUNCTION 31 /* Function Name NULL */
drh6ed48bf2007-06-14 20:57:18 +00002131#define SQLITE_COPY 0 /* No longer used */
drhed6c8672003-01-12 18:02:16 +00002132
2133/*
drhf5befa02007-12-06 02:42:07 +00002134** CAPI3REF: Tracing And Profiling Functions {F12280}
drh6ed48bf2007-06-14 20:57:18 +00002135**
2136** These routines register callback functions that can be used for
2137** tracing and profiling the execution of SQL statements.
drhfddfa2d2007-12-05 18:05:16 +00002138**
drh33c1be32008-01-30 16:16:14 +00002139** The callback function registered by sqlite3_trace() is invoked at
2140** various times when an SQL statement is being run by [sqlite3_step()].
2141** The callback returns a UTF-8 rendering of the SQL statement text
2142** as the statement first begins executing. Additional callbacks occur
shane26b34032008-05-23 17:21:09 +00002143** as each triggered subprogram is entered. The callbacks for triggers
drh33c1be32008-01-30 16:16:14 +00002144** contain a UTF-8 SQL comment that identifies the trigger.
2145**
2146** The callback function registered by sqlite3_profile() is invoked
2147** as each SQL statement finishes. The profile callback contains
2148** the original statement text and an estimate of wall-clock time
2149** of how long that statement took to run.
drh19e2d372005-08-29 23:00:03 +00002150**
2151** The sqlite3_profile() API is currently considered experimental and
drh33c1be32008-01-30 16:16:14 +00002152** is subject to change or removal in a future release.
2153**
2154** The trigger reporting feature of the trace callback is considered
2155** experimental and is subject to change or removal in future releases.
2156** Future versions of SQLite might also add new trace callback
2157** invocations.
2158**
2159** INVARIANTS:
2160**
2161** {F12281} The callback function registered by [sqlite3_trace()] is
2162** whenever an SQL statement first begins to execute and
2163** whenever a trigger subprogram first begins to run.
2164**
2165** {F12282} Each call to [sqlite3_trace()] overrides the previously
2166** registered trace callback.
2167**
2168** {F12283} A NULL trace callback disables tracing.
2169**
2170** {F12284} The first argument to the trace callback is a copy of
2171** the pointer which was the 3rd argument to [sqlite3_trace()].
2172**
2173** {F12285} The second argument to the trace callback is a
2174** zero-terminated UTF8 string containing the original text
2175** of the SQL statement as it was passed into [sqlite3_prepare_v2()]
2176** or the equivalent, or an SQL comment indicating the beginning
2177** of a trigger subprogram.
2178**
2179** {F12287} The callback function registered by [sqlite3_profile()] is invoked
2180** as each SQL statement finishes.
2181**
2182** {F12288} The first parameter to the profile callback is a copy of
2183** the 3rd parameter to [sqlite3_profile()].
2184**
2185** {F12289} The second parameter to the profile callback is a
2186** zero-terminated UTF-8 string that contains the complete text of
2187** the SQL statement as it was processed by [sqlite3_prepare_v2()]
2188** or the equivalent.
2189**
2190** {F12290} The third parameter to the profile callback is an estimate
2191** of the number of nanoseconds of wall-clock time required to
2192** run the SQL statement from start to finish.
drh18de4822003-01-16 16:28:53 +00002193*/
danielk1977f9d64d22004-06-19 08:18:07 +00002194void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*);
drh19e2d372005-08-29 23:00:03 +00002195void *sqlite3_profile(sqlite3*,
drh6d2069d2007-08-14 01:58:53 +00002196 void(*xProfile)(void*,const char*,sqlite3_uint64), void*);
drh18de4822003-01-16 16:28:53 +00002197
danielk1977348bb5d2003-10-18 09:37:26 +00002198/*
drhfddfa2d2007-12-05 18:05:16 +00002199** CAPI3REF: Query Progress Callbacks {F12910}
drh6ed48bf2007-06-14 20:57:18 +00002200**
drh33c1be32008-01-30 16:16:14 +00002201** This routine configures a callback function - the
drhfddfa2d2007-12-05 18:05:16 +00002202** progress callback - that is invoked periodically during long
2203** running calls to [sqlite3_exec()], [sqlite3_step()] and
drh33c1be32008-01-30 16:16:14 +00002204** [sqlite3_get_table()]. An example use for this
drh6ed48bf2007-06-14 20:57:18 +00002205** interface is to keep a GUI updated during a large query.
danielk1977348bb5d2003-10-18 09:37:26 +00002206**
shane236ce972008-05-30 15:35:30 +00002207** If the progress callback returns non-zero, the operation is
drh33c1be32008-01-30 16:16:14 +00002208** interrupted. This feature can be used to implement a
2209** "Cancel" button on a GUI dialog box.
danielk1977348bb5d2003-10-18 09:37:26 +00002210**
drh33c1be32008-01-30 16:16:14 +00002211** INVARIANTS:
2212**
2213** {F12911} The callback function registered by [sqlite3_progress_handler()]
2214** is invoked periodically during long running calls to
2215** [sqlite3_step()].
2216**
2217** {F12912} The progress callback is invoked once for every N virtual
2218** machine opcodes, where N is the second argument to
2219** the [sqlite3_progress_handler()] call that registered
2220** the callback. <todo>What if N is less than 1?</todo>
2221**
2222** {F12913} The progress callback itself is identified by the third
2223** argument to [sqlite3_progress_handler()].
2224**
2225** {F12914} The fourth argument [sqlite3_progress_handler()] is a
2226*** void pointer passed to the progress callback
2227** function each time it is invoked.
2228**
2229** {F12915} If a call to [sqlite3_step()] results in fewer than
2230** N opcodes being executed,
2231** then the progress callback is never invoked. {END}
danielk1977348bb5d2003-10-18 09:37:26 +00002232**
drh33c1be32008-01-30 16:16:14 +00002233** {F12916} Every call to [sqlite3_progress_handler()]
shane26b34032008-05-23 17:21:09 +00002234** overwrites any previously registered progress handler.
drh33c1be32008-01-30 16:16:14 +00002235**
2236** {F12917} If the progress handler callback is NULL then no progress
2237** handler is invoked.
danielk1977348bb5d2003-10-18 09:37:26 +00002238**
drhfddfa2d2007-12-05 18:05:16 +00002239** {F12918} If the progress callback returns a result other than 0, then
drh33c1be32008-01-30 16:16:14 +00002240** the behavior is a if [sqlite3_interrupt()] had been called.
danielk1977348bb5d2003-10-18 09:37:26 +00002241*/
danielk1977f9d64d22004-06-19 08:18:07 +00002242void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
danielk1977348bb5d2003-10-18 09:37:26 +00002243
drhaa940ea2004-01-15 02:44:03 +00002244/*
drhfddfa2d2007-12-05 18:05:16 +00002245** CAPI3REF: Opening A New Database Connection {F12700}
drhaa940ea2004-01-15 02:44:03 +00002246**
drh33c1be32008-01-30 16:16:14 +00002247** These routines open an SQLite database file whose name
drhfddfa2d2007-12-05 18:05:16 +00002248** is given by the filename argument.
drh33c1be32008-01-30 16:16:14 +00002249** The filename argument is interpreted as UTF-8
drhfddfa2d2007-12-05 18:05:16 +00002250** for [sqlite3_open()] and [sqlite3_open_v2()] and as UTF-16
drh9da9d962007-08-28 15:47:44 +00002251** in the native byte order for [sqlite3_open16()].
drh33c1be32008-01-30 16:16:14 +00002252** An [sqlite3*] handle is usually returned in *ppDb, even
2253** if an error occurs. The only exception is if SQLite is unable
drhfddfa2d2007-12-05 18:05:16 +00002254** to allocate memory to hold the [sqlite3] object, a NULL will
drh33c1be32008-01-30 16:16:14 +00002255** be written into *ppDb instead of a pointer to the [sqlite3] object.
2256** If the database is opened (and/or created)
2257** successfully, then [SQLITE_OK] is returned. Otherwise an
2258** error code is returned. The
drh6d2069d2007-08-14 01:58:53 +00002259** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain
drh4f26d6c2004-05-26 23:25:30 +00002260** an English language description of the error.
drh22fbcb82004-02-01 01:22:50 +00002261**
drh33c1be32008-01-30 16:16:14 +00002262** The default encoding for the database will be UTF-8 if
drh9da9d962007-08-28 15:47:44 +00002263** [sqlite3_open()] or [sqlite3_open_v2()] is called and
drhfddfa2d2007-12-05 18:05:16 +00002264** UTF-16 in the native byte order if [sqlite3_open16()] is used.
danielk197765904932004-05-26 06:18:37 +00002265**
drh33c1be32008-01-30 16:16:14 +00002266** Whether or not an error occurs when it is opened, resources
drhfddfa2d2007-12-05 18:05:16 +00002267** associated with the [sqlite3*] handle should be released by passing it
2268** to [sqlite3_close()] when it is no longer required.
drh6d2069d2007-08-14 01:58:53 +00002269**
drh33c1be32008-01-30 16:16:14 +00002270** The [sqlite3_open_v2()] interface works like [sqlite3_open()]
shane26b34032008-05-23 17:21:09 +00002271** except that it accepts two additional parameters for additional control
drh33c1be32008-01-30 16:16:14 +00002272** over the new database connection. The flags parameter can be
drhfddfa2d2007-12-05 18:05:16 +00002273** one of:
drh6d2069d2007-08-14 01:58:53 +00002274**
2275** <ol>
2276** <li> [SQLITE_OPEN_READONLY]
2277** <li> [SQLITE_OPEN_READWRITE]
2278** <li> [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]
2279** </ol>
2280**
drh33c1be32008-01-30 16:16:14 +00002281** The first value opens the database read-only.
2282** If the database does not previously exist, an error is returned.
2283** The second option opens
drh9da9d962007-08-28 15:47:44 +00002284** the database for reading and writing if possible, or reading only if
drh33c1be32008-01-30 16:16:14 +00002285** if the file is write protected. In either case the database
2286** must already exist or an error is returned. The third option
drhfddfa2d2007-12-05 18:05:16 +00002287** opens the database for reading and writing and creates it if it does
drh33c1be32008-01-30 16:16:14 +00002288** not already exist.
drh9da9d962007-08-28 15:47:44 +00002289** The third options is behavior that is always used for [sqlite3_open()]
2290** and [sqlite3_open16()].
2291**
drh1cceeb92008-04-19 14:06:28 +00002292** If the 3rd parameter to [sqlite3_open_v2()] is not one of the
drhd9b97cf2008-04-10 13:38:17 +00002293** combinations shown above then the behavior is undefined.
2294**
drh33c1be32008-01-30 16:16:14 +00002295** If the filename is ":memory:", then an private
2296** in-memory database is created for the connection. This in-memory
2297** database will vanish when the database connection is closed. Future
drh9da9d962007-08-28 15:47:44 +00002298** version of SQLite might make use of additional special filenames
2299** that begin with the ":" character. It is recommended that
2300** when a database filename really does begin with
2301** ":" that you prefix the filename with a pathname like "./" to
2302** avoid ambiguity.
drh6d2069d2007-08-14 01:58:53 +00002303**
drh33c1be32008-01-30 16:16:14 +00002304** If the filename is an empty string, then a private temporary
2305** on-disk database will be created. This private database will be
drh3f3b6352007-09-03 20:32:45 +00002306** automatically deleted as soon as the database connection is closed.
2307**
drh33c1be32008-01-30 16:16:14 +00002308** The fourth parameter to sqlite3_open_v2() is the name of the
drhd84f9462007-08-15 11:28:56 +00002309** [sqlite3_vfs] object that defines the operating system
drh33c1be32008-01-30 16:16:14 +00002310** interface that the new database connection should use. If the
drh9da9d962007-08-28 15:47:44 +00002311** fourth parameter is a NULL pointer then the default [sqlite3_vfs]
drh33c1be32008-01-30 16:16:14 +00002312** object is used.
drh6ed48bf2007-06-14 20:57:18 +00002313**
shane26b34032008-05-23 17:21:09 +00002314** <b>Note to Windows users:</b> The encoding used for the filename argument
drh9da9d962007-08-28 15:47:44 +00002315** of [sqlite3_open()] and [sqlite3_open_v2()] must be UTF-8, not whatever
2316** codepage is currently defined. Filenames containing international
2317** characters must be converted to UTF-8 prior to passing them into
2318** [sqlite3_open()] or [sqlite3_open_v2()].
drh33c1be32008-01-30 16:16:14 +00002319**
2320** INVARIANTS:
2321**
2322** {F12701} The [sqlite3_open()], [sqlite3_open16()], and
2323** [sqlite3_open_v2()] interfaces create a new
2324** [database connection] associated with
2325** the database file given in their first parameter.
2326**
2327** {F12702} The filename argument is interpreted as UTF-8
2328** for [sqlite3_open()] and [sqlite3_open_v2()] and as UTF-16
2329** in the native byte order for [sqlite3_open16()].
2330**
2331** {F12703} A successful invocation of [sqlite3_open()], [sqlite3_open16()],
2332** or [sqlite3_open_v2()] writes a pointer to a new
2333** [database connection] into *ppDb.
2334**
2335** {F12704} The [sqlite3_open()], [sqlite3_open16()], and
2336** [sqlite3_open_v2()] interfaces return [SQLITE_OK] upon success,
2337** or an appropriate [error code] on failure.
2338**
2339** {F12706} The default text encoding for a new database created using
2340** [sqlite3_open()] or [sqlite3_open_v2()] will be UTF-8.
2341**
2342** {F12707} The default text encoding for a new database created using
2343** [sqlite3_open16()] will be UTF-16.
2344**
2345** {F12709} The [sqlite3_open(F,D)] interface is equivalent to
2346** [sqlite3_open_v2(F,D,G,0)] where the G parameter is
2347** [SQLITE_OPEN_READWRITE]|[SQLITE_OPEN_CREATE].
2348**
2349** {F12711} If the G parameter to [sqlite3_open_v2(F,D,G,V)] contains the
2350** bit value [SQLITE_OPEN_READONLY] then the database is opened
2351** for reading only.
2352**
2353** {F12712} If the G parameter to [sqlite3_open_v2(F,D,G,V)] contains the
2354** bit value [SQLITE_OPEN_READWRITE] then the database is opened
2355** reading and writing if possible, or for reading only if the
2356** file is write protected by the operating system.
2357**
2358** {F12713} If the G parameter to [sqlite3_open(v2(F,D,G,V)] omits the
2359** bit value [SQLITE_OPEN_CREATE] and the database does not
2360** previously exist, an error is returned.
2361**
2362** {F12714} If the G parameter to [sqlite3_open(v2(F,D,G,V)] contains the
2363** bit value [SQLITE_OPEN_CREATE] and the database does not
2364** previously exist, then an attempt is made to create and
2365** initialize the database.
2366**
2367** {F12717} If the filename argument to [sqlite3_open()], [sqlite3_open16()],
2368** or [sqlite3_open_v2()] is ":memory:", then an private,
2369** ephemeral, in-memory database is created for the connection.
2370** <todo>Is SQLITE_OPEN_CREATE|SQLITE_OPEN_READWRITE required
2371** in sqlite3_open_v2()?</todo>
2372**
drhafc91042008-02-21 02:09:45 +00002373** {F12719} If the filename is NULL or an empty string, then a private,
shane26b34032008-05-23 17:21:09 +00002374** ephemeral on-disk database will be created.
drh33c1be32008-01-30 16:16:14 +00002375** <todo>Is SQLITE_OPEN_CREATE|SQLITE_OPEN_READWRITE required
2376** in sqlite3_open_v2()?</todo>
2377**
2378** {F12721} The [database connection] created by
2379** [sqlite3_open_v2(F,D,G,V)] will use the
2380** [sqlite3_vfs] object identified by the V parameter, or
2381** the default [sqlite3_vfs] object is V is a NULL pointer.
shane0c6844e2008-05-21 15:01:21 +00002382**
2383** {F12723} Two [database connection | database connections] will share a common cache
2384** if both were opened with the same VFS
2385** while [sqlite3_enable_shared_cache | shared cache mode was enabled] and
2386** if both filenames compare equal using memcmp()
2387** after having been processed by the [sqlite3_vfs | xFullPathname] method of
2388** the VFS.
2389**
danielk197765904932004-05-26 06:18:37 +00002390*/
2391int sqlite3_open(
2392 const char *filename, /* Database filename (UTF-8) */
danielk19774f057f92004-06-08 00:02:33 +00002393 sqlite3 **ppDb /* OUT: SQLite db handle */
danielk197765904932004-05-26 06:18:37 +00002394);
danielk197765904932004-05-26 06:18:37 +00002395int sqlite3_open16(
2396 const void *filename, /* Database filename (UTF-16) */
danielk19774f057f92004-06-08 00:02:33 +00002397 sqlite3 **ppDb /* OUT: SQLite db handle */
danielk197765904932004-05-26 06:18:37 +00002398);
drh6d2069d2007-08-14 01:58:53 +00002399int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00002400 const char *filename, /* Database filename (UTF-8) */
drh6d2069d2007-08-14 01:58:53 +00002401 sqlite3 **ppDb, /* OUT: SQLite db handle */
2402 int flags, /* Flags */
drhd84f9462007-08-15 11:28:56 +00002403 const char *zVfs /* Name of VFS module to use */
drh6d2069d2007-08-14 01:58:53 +00002404);
danielk1977295ba552004-05-19 10:34:51 +00002405
danielk197765904932004-05-26 06:18:37 +00002406/*
drhfddfa2d2007-12-05 18:05:16 +00002407** CAPI3REF: Error Codes And Messages {F12800}
drh6ed48bf2007-06-14 20:57:18 +00002408**
drh33c1be32008-01-30 16:16:14 +00002409** The sqlite3_errcode() interface returns the numeric
drh6ed48bf2007-06-14 20:57:18 +00002410** [SQLITE_OK | result code] or [SQLITE_IOERR_READ | extended result code]
2411** for the most recent failed sqlite3_* API call associated
drh33c1be32008-01-30 16:16:14 +00002412** with [sqlite3] handle 'db'. If a prior API call failed but the
drh6ed48bf2007-06-14 20:57:18 +00002413** most recent API call succeeded, the return value from sqlite3_errcode()
drh33c1be32008-01-30 16:16:14 +00002414** is undefined.
drh6ed48bf2007-06-14 20:57:18 +00002415**
drh33c1be32008-01-30 16:16:14 +00002416** The sqlite3_errmsg() and sqlite3_errmsg16() return English-language
drh6ed48bf2007-06-14 20:57:18 +00002417** text that describes the error, as either UTF8 or UTF16 respectively.
drh33c1be32008-01-30 16:16:14 +00002418** Memory to hold the error message string is managed internally.
2419** The application does not need to worry with freeing the result.
mlcreech27358862008-03-01 23:34:46 +00002420** However, the error string might be overwritten or deallocated by
drh33c1be32008-01-30 16:16:14 +00002421** subsequent calls to other SQLite interface functions.
danielk197765904932004-05-26 06:18:37 +00002422**
drh33c1be32008-01-30 16:16:14 +00002423** INVARIANTS:
danielk197765904932004-05-26 06:18:37 +00002424**
drh33c1be32008-01-30 16:16:14 +00002425** {F12801} The [sqlite3_errcode(D)] interface returns the numeric
2426** [SQLITE_OK | result code] or
2427** [SQLITE_IOERR_READ | extended result code]
drhb4d58ae2008-02-21 20:17:06 +00002428** for the most recently failed interface call associated
2429** with [database connection] D.
drh33c1be32008-01-30 16:16:14 +00002430**
2431** {F12803} The [sqlite3_errmsg(D)] and [sqlite3_errmsg16(D)]
2432** interfaces return English-language text that describes
2433** the error in the mostly recently failed interface call,
2434** encoded as either UTF8 or UTF16 respectively.
2435**
drhb4d58ae2008-02-21 20:17:06 +00002436** {F12807} The strings returned by [sqlite3_errmsg()] and [sqlite3_errmsg16()]
2437** are valid until the next SQLite interface call.
drh33c1be32008-01-30 16:16:14 +00002438**
2439** {F12808} Calls to API routines that do not return an error code
2440** (example: [sqlite3_data_count()]) do not
2441** change the error code or message returned by
2442** [sqlite3_errcode()], [sqlite3_errmsg()], or [sqlite3_errmsg16()].
2443**
2444** {F12809} Interfaces that are not associated with a specific
2445** [database connection] (examples:
2446** [sqlite3_mprintf()] or [sqlite3_enable_shared_cache()]
2447** do not change the values returned by
2448** [sqlite3_errcode()], [sqlite3_errmsg()], or [sqlite3_errmsg16()].
danielk197765904932004-05-26 06:18:37 +00002449*/
2450int sqlite3_errcode(sqlite3 *db);
danielk197765904932004-05-26 06:18:37 +00002451const char *sqlite3_errmsg(sqlite3*);
danielk197765904932004-05-26 06:18:37 +00002452const void *sqlite3_errmsg16(sqlite3*);
2453
2454/*
drhfddfa2d2007-12-05 18:05:16 +00002455** CAPI3REF: SQL Statement Object {F13000}
drh33c1be32008-01-30 16:16:14 +00002456** KEYWORDS: {prepared statement} {prepared statements}
drh6ed48bf2007-06-14 20:57:18 +00002457**
shane26b34032008-05-23 17:21:09 +00002458** An instance of this object represents a single SQL statement. This
drhf5befa02007-12-06 02:42:07 +00002459** object is variously known as a "prepared statement" or a
drh6ed48bf2007-06-14 20:57:18 +00002460** "compiled SQL statement" or simply as a "statement".
2461**
2462** The life of a statement object goes something like this:
2463**
2464** <ol>
2465** <li> Create the object using [sqlite3_prepare_v2()] or a related
2466** function.
2467** <li> Bind values to host parameters using
2468** [sqlite3_bind_blob | sqlite3_bind_* interfaces].
2469** <li> Run the SQL by calling [sqlite3_step()] one or more times.
2470** <li> Reset the statement using [sqlite3_reset()] then go back
2471** to step 2. Do this zero or more times.
2472** <li> Destroy the object using [sqlite3_finalize()].
2473** </ol>
2474**
2475** Refer to documentation on individual methods above for additional
2476** information.
danielk197765904932004-05-26 06:18:37 +00002477*/
danielk1977fc57d7b2004-05-26 02:04:57 +00002478typedef struct sqlite3_stmt sqlite3_stmt;
2479
danielk1977e3209e42004-05-20 01:40:18 +00002480/*
drhcaa639f2008-03-20 00:32:20 +00002481** CAPI3REF: Run-time Limits {F12760}
2482**
2483** This interface allows the size of various constructs to be limited
2484** on a connection by connection basis. The first parameter is the
2485** [database connection] whose limit is to be set or queried. The
2486** second parameter is one of the [limit categories] that define a
2487** class of constructs to be size limited. The third parameter is the
2488** new limit for that construct. The function returns the old limit.
2489**
2490** If the new limit is a negative number, the limit is unchanged.
drhf47ce562008-03-20 18:00:49 +00002491** For the limit category of SQLITE_LIMIT_XYZ there is a hard upper
2492** bound set by a compile-time C-preprocess macro named SQLITE_MAX_XYZ.
2493** (The "_LIMIT_" in the name is changed to "_MAX_".)
2494** Attempts to increase a limit above its hard upper bound are
2495** silently truncated to the hard upper limit.
drhcaa639f2008-03-20 00:32:20 +00002496**
drhbb4957f2008-03-20 14:03:29 +00002497** Run time limits are intended for use in applications that manage
2498** both their own internal database and also databases that are controlled
2499** by untrusted external sources. An example application might be a
2500** webbrowser that has its own databases for storing history and
shane26b34032008-05-23 17:21:09 +00002501** separate databases controlled by JavaScript applications downloaded
shane236ce972008-05-30 15:35:30 +00002502** off the Internet. The internal databases can be given the
drhbb4957f2008-03-20 14:03:29 +00002503** large, default limits. Databases managed by external sources can
2504** be given much smaller limits designed to prevent a denial of service
drhf47ce562008-03-20 18:00:49 +00002505** attach. Developers might also want to use the [sqlite3_set_authorizer()]
2506** interface to further control untrusted SQL. The size of the database
2507** created by an untrusted script can be contained using the
2508** [max_page_count] [PRAGMA].
drhbb4957f2008-03-20 14:03:29 +00002509**
drhcaa639f2008-03-20 00:32:20 +00002510** This interface is currently considered experimental and is subject
2511** to change or removal without prior notice.
2512**
2513** INVARIANTS:
2514**
drhf47ce562008-03-20 18:00:49 +00002515** {F12762} A successful call to [sqlite3_limit(D,C,V)] where V is
drhcaa639f2008-03-20 00:32:20 +00002516** positive changes the
drhbb4957f2008-03-20 14:03:29 +00002517** limit on the size of construct C in [database connection] D
shane26b34032008-05-23 17:21:09 +00002518** to the lesser of V and the hard upper bound on the size
drhcaa639f2008-03-20 00:32:20 +00002519** of C that is set at compile-time.
2520**
drhcaa639f2008-03-20 00:32:20 +00002521** {F12766} A successful call to [sqlite3_limit(D,C,V)] where V is negative
2522** leaves the state of [database connection] D unchanged.
2523**
2524** {F12769} A successful call to [sqlite3_limit(D,C,V)] returns the
2525** value of the limit on the size of construct C in
drhbb4957f2008-03-20 14:03:29 +00002526** in [database connection] D as it was prior to the call.
drhcaa639f2008-03-20 00:32:20 +00002527*/
2528int sqlite3_limit(sqlite3*, int id, int newVal);
2529
2530/*
2531** CAPI3REF: Run-Time Limit Categories {F12790}
2532** KEYWORDS: {limit category} {limit categories}
2533**
2534** These constants define various aspects of a [database connection]
2535** that can be limited in size by calls to [sqlite3_limit()].
drhbb4957f2008-03-20 14:03:29 +00002536** The meanings of the various limits are as follows:
2537**
2538** <dl>
2539** <dt>SQLITE_LIMIT_LENGTH</dt>
2540** <dd>The maximum size of any
2541** string or blob or table row.<dd>
2542**
2543** <dt>SQLITE_LIMIT_SQL_LENGTH</dt>
2544** <dd>The maximum length of an SQL statement.</dd>
2545**
2546** <dt>SQLITE_LIMIT_COLUMN</dt>
2547** <dd>The maximum number of columns in a table definition or in the
2548** result set of a SELECT or the maximum number of columns in an index
2549** or in an ORDER BY or GROUP BY clause.</dd>
2550**
2551** <dt>SQLITE_LIMIT_EXPR_DEPTH</dt>
2552** <dd>The maximum depth of the parse tree on any expression.</dd>
2553**
2554** <dt>SQLITE_LIMIT_COMPOUND_SELECT</dt>
2555** <dd>The maximum number of terms in a compound SELECT statement.</dd>
2556**
2557** <dt>SQLITE_LIMIT_VDBE_OP</dt>
2558** <dd>The maximum number of instructions in a virtual machine program
2559** used to implement an SQL statement.</dd>
2560**
2561** <dt>SQLITE_LIMIT_FUNCTION_ARG</dt>
2562** <dd>The maximum number of arguments on a function.</dd>
2563**
2564** <dt>SQLITE_LIMIT_ATTACHED</dt>
2565** <dd>The maximum number of attached databases.</dd>
2566**
drhbb4957f2008-03-20 14:03:29 +00002567** <dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt>
2568** <dd>The maximum length of the pattern argument to the LIKE or
2569** GLOB operators.</dd>
2570**
2571** <dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt>
2572** <dd>The maximum number of variables in an SQL statement that can
2573** be bound.</dd>
2574** </dl>
drhcaa639f2008-03-20 00:32:20 +00002575*/
2576#define SQLITE_LIMIT_LENGTH 0
2577#define SQLITE_LIMIT_SQL_LENGTH 1
2578#define SQLITE_LIMIT_COLUMN 2
2579#define SQLITE_LIMIT_EXPR_DEPTH 3
2580#define SQLITE_LIMIT_COMPOUND_SELECT 4
2581#define SQLITE_LIMIT_VDBE_OP 5
2582#define SQLITE_LIMIT_FUNCTION_ARG 6
2583#define SQLITE_LIMIT_ATTACHED 7
drhb1a6c3c2008-03-20 16:30:17 +00002584#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8
2585#define SQLITE_LIMIT_VARIABLE_NUMBER 9
drhcaa639f2008-03-20 00:32:20 +00002586
2587/*
drhfddfa2d2007-12-05 18:05:16 +00002588** CAPI3REF: Compiling An SQL Statement {F13010}
danielk197765904932004-05-26 06:18:37 +00002589**
drh6ed48bf2007-06-14 20:57:18 +00002590** To execute an SQL query, it must first be compiled into a byte-code
2591** program using one of these routines.
2592**
drh33c1be32008-01-30 16:16:14 +00002593** The first argument "db" is an [database connection]
drh4ff7fa02007-09-01 18:17:21 +00002594** obtained from a prior call to [sqlite3_open()], [sqlite3_open_v2()]
drh33c1be32008-01-30 16:16:14 +00002595** or [sqlite3_open16()].
drh6ed48bf2007-06-14 20:57:18 +00002596** The second argument "zSql" is the statement to be compiled, encoded
2597** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2()
2598** interfaces uses UTF-8 and sqlite3_prepare16() and sqlite3_prepare16_v2()
drhfddfa2d2007-12-05 18:05:16 +00002599** use UTF-16. {END}
drh21f06722007-07-19 12:41:39 +00002600**
drh33c1be32008-01-30 16:16:14 +00002601** If the nByte argument is less
drhfddfa2d2007-12-05 18:05:16 +00002602** than zero, then zSql is read up to the first zero terminator.
drh33c1be32008-01-30 16:16:14 +00002603** If nByte is non-negative, then it is the maximum number of
drh21f06722007-07-19 12:41:39 +00002604** bytes read from zSql. When nByte is non-negative, the
drhf5befa02007-12-06 02:42:07 +00002605** zSql string ends at either the first '\000' or '\u0000' character or
drhb08c2a72008-04-16 00:28:13 +00002606** the nByte-th byte, whichever comes first. If the caller knows
danielk19773a2c8c82008-04-03 14:36:25 +00002607** that the supplied string is nul-terminated, then there is a small
2608** performance advantage to be had by passing an nByte parameter that
2609** is equal to the number of bytes in the input string <i>including</i>
2610** the nul-terminator bytes.{END}
danielk197765904932004-05-26 06:18:37 +00002611**
drh33c1be32008-01-30 16:16:14 +00002612** *pzTail is made to point to the first byte past the end of the
shane26b34032008-05-23 17:21:09 +00002613** first SQL statement in zSql. These routines only compile the first
drhf5befa02007-12-06 02:42:07 +00002614** statement in zSql, so *pzTail is left pointing to what remains
drh33c1be32008-01-30 16:16:14 +00002615** uncompiled.
danielk197765904932004-05-26 06:18:37 +00002616**
drh33c1be32008-01-30 16:16:14 +00002617** *ppStmt is left pointing to a compiled [prepared statement] that can be
drh17eaae72008-03-03 18:47:28 +00002618** executed using [sqlite3_step()]. Or if there is an error, *ppStmt is
drh33c1be32008-01-30 16:16:14 +00002619** set to NULL. If the input text contains no SQL (if the input
drhfddfa2d2007-12-05 18:05:16 +00002620** is and empty string or a comment) then *ppStmt is set to NULL.
2621** {U13018} The calling procedure is responsible for deleting the
2622** compiled SQL statement
drh6ed48bf2007-06-14 20:57:18 +00002623** using [sqlite3_finalize()] after it has finished with it.
danielk197765904932004-05-26 06:18:37 +00002624**
drh33c1be32008-01-30 16:16:14 +00002625** On success, [SQLITE_OK] is returned. Otherwise an
2626** [error code] is returned.
drh6ed48bf2007-06-14 20:57:18 +00002627**
2628** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are
2629** recommended for all new programs. The two older interfaces are retained
2630** for backwards compatibility, but their use is discouraged.
drh33c1be32008-01-30 16:16:14 +00002631** In the "v2" interfaces, the prepared statement
drh6ed48bf2007-06-14 20:57:18 +00002632** that is returned (the [sqlite3_stmt] object) contains a copy of the
drhfddfa2d2007-12-05 18:05:16 +00002633** original SQL text. {END} This causes the [sqlite3_step()] interface to
drh6ed48bf2007-06-14 20:57:18 +00002634** behave a differently in two ways:
2635**
2636** <ol>
drh33c1be32008-01-30 16:16:14 +00002637** <li>
drh6ed48bf2007-06-14 20:57:18 +00002638** If the database schema changes, instead of returning [SQLITE_SCHEMA] as it
2639** always used to do, [sqlite3_step()] will automatically recompile the SQL
drh33c1be32008-01-30 16:16:14 +00002640** statement and try to run it again. If the schema has changed in
drhfddfa2d2007-12-05 18:05:16 +00002641** a way that makes the statement no longer valid, [sqlite3_step()] will still
drh33c1be32008-01-30 16:16:14 +00002642** return [SQLITE_SCHEMA]. But unlike the legacy behavior,
2643** [SQLITE_SCHEMA] is now a fatal error. Calling
drhfddfa2d2007-12-05 18:05:16 +00002644** [sqlite3_prepare_v2()] again will not make the
drh33c1be32008-01-30 16:16:14 +00002645** error go away. Note: use [sqlite3_errmsg()] to find the text
drhfddfa2d2007-12-05 18:05:16 +00002646** of the parsing error that results in an [SQLITE_SCHEMA] return. {END}
drh6ed48bf2007-06-14 20:57:18 +00002647** </li>
2648**
2649** <li>
drh33c1be32008-01-30 16:16:14 +00002650** When an error occurs,
drh6ed48bf2007-06-14 20:57:18 +00002651** [sqlite3_step()] will return one of the detailed
drh33c1be32008-01-30 16:16:14 +00002652** [error codes] or [extended error codes].
drh6ed48bf2007-06-14 20:57:18 +00002653** The legacy behavior was that [sqlite3_step()] would only return a generic
2654** [SQLITE_ERROR] result code and you would have to make a second call to
2655** [sqlite3_reset()] in order to find the underlying cause of the problem.
2656** With the "v2" prepare interfaces, the underlying reason for the error is
drh33c1be32008-01-30 16:16:14 +00002657** returned immediately.
drh6ed48bf2007-06-14 20:57:18 +00002658** </li>
2659** </ol>
drh33c1be32008-01-30 16:16:14 +00002660**
2661** INVARIANTS:
2662**
2663** {F13011} The [sqlite3_prepare(db,zSql,...)] and
2664** [sqlite3_prepare_v2(db,zSql,...)] interfaces interpret the
2665** text in their zSql parameter as UTF-8.
2666**
2667** {F13012} The [sqlite3_prepare16(db,zSql,...)] and
2668** [sqlite3_prepare16_v2(db,zSql,...)] interfaces interpret the
2669** text in their zSql parameter as UTF-16 in the native byte order.
2670**
2671** {F13013} If the nByte argument to [sqlite3_prepare_v2(db,zSql,nByte,...)]
2672** and its variants is less than zero, then SQL text is
2673** read from zSql is read up to the first zero terminator.
2674**
2675** {F13014} If the nByte argument to [sqlite3_prepare_v2(db,zSql,nByte,...)]
drhb08c2a72008-04-16 00:28:13 +00002676** and its variants is non-negative, then at most nBytes bytes
drh33c1be32008-01-30 16:16:14 +00002677** SQL text is read from zSql.
2678**
2679** {F13015} In [sqlite3_prepare_v2(db,zSql,N,P,pzTail)] and its variants
2680** if the zSql input text contains more than one SQL statement
2681** and pzTail is not NULL, then *pzTail is made to point to the
2682** first byte past the end of the first SQL statement in zSql.
2683** <todo>What does *pzTail point to if there is one statement?</todo>
2684**
2685** {F13016} A successful call to [sqlite3_prepare_v2(db,zSql,N,ppStmt,...)]
2686** or one of its variants writes into *ppStmt a pointer to a new
2687** [prepared statement] or a pointer to NULL
2688** if zSql contains nothing other than whitespace or comments.
2689**
2690** {F13019} The [sqlite3_prepare_v2()] interface and its variants return
2691** [SQLITE_OK] or an appropriate [error code] upon failure.
drh17eaae72008-03-03 18:47:28 +00002692**
2693** {F13021} Before [sqlite3_prepare(db,zSql,nByte,ppStmt,pzTail)] or its
2694** variants returns an error (any value other than [SQLITE_OK])
2695** it first sets *ppStmt to NULL.
danielk197765904932004-05-26 06:18:37 +00002696*/
2697int sqlite3_prepare(
2698 sqlite3 *db, /* Database handle */
2699 const char *zSql, /* SQL statement, UTF-8 encoded */
drh21f06722007-07-19 12:41:39 +00002700 int nByte, /* Maximum length of zSql in bytes. */
danielk197765904932004-05-26 06:18:37 +00002701 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2702 const char **pzTail /* OUT: Pointer to unused portion of zSql */
2703);
drh6ed48bf2007-06-14 20:57:18 +00002704int sqlite3_prepare_v2(
2705 sqlite3 *db, /* Database handle */
2706 const char *zSql, /* SQL statement, UTF-8 encoded */
drh21f06722007-07-19 12:41:39 +00002707 int nByte, /* Maximum length of zSql in bytes. */
drh6ed48bf2007-06-14 20:57:18 +00002708 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2709 const char **pzTail /* OUT: Pointer to unused portion of zSql */
2710);
danielk197765904932004-05-26 06:18:37 +00002711int sqlite3_prepare16(
2712 sqlite3 *db, /* Database handle */
2713 const void *zSql, /* SQL statement, UTF-16 encoded */
drh21f06722007-07-19 12:41:39 +00002714 int nByte, /* Maximum length of zSql in bytes. */
danielk197765904932004-05-26 06:18:37 +00002715 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2716 const void **pzTail /* OUT: Pointer to unused portion of zSql */
2717);
drhb900aaf2006-11-09 00:24:53 +00002718int sqlite3_prepare16_v2(
2719 sqlite3 *db, /* Database handle */
2720 const void *zSql, /* SQL statement, UTF-16 encoded */
drh21f06722007-07-19 12:41:39 +00002721 int nByte, /* Maximum length of zSql in bytes. */
drhb900aaf2006-11-09 00:24:53 +00002722 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2723 const void **pzTail /* OUT: Pointer to unused portion of zSql */
2724);
2725
2726/*
drhfddfa2d2007-12-05 18:05:16 +00002727** CAPIREF: Retrieving Statement SQL {F13100}
danielk1977d0e2a852007-11-14 06:48:48 +00002728**
shane26b34032008-05-23 17:21:09 +00002729** This interface can be used to retrieve a saved copy of the original
drh33c1be32008-01-30 16:16:14 +00002730** SQL text used to create a [prepared statement].
danielk1977d0e2a852007-11-14 06:48:48 +00002731**
drh33c1be32008-01-30 16:16:14 +00002732** INVARIANTS:
2733**
2734** {F13101} If the [prepared statement] passed as
2735** the an argument to [sqlite3_sql()] was compiled
2736** compiled using either [sqlite3_prepare_v2()] or
2737** [sqlite3_prepare16_v2()],
2738** then [sqlite3_sql()] function returns a pointer to a
2739** zero-terminated string containing a UTF-8 rendering
2740** of the original SQL statement.
2741**
2742** {F13102} If the [prepared statement] passed as
2743** the an argument to [sqlite3_sql()] was compiled
2744** compiled using either [sqlite3_prepare()] or
2745** [sqlite3_prepare16()],
2746** then [sqlite3_sql()] function returns a NULL pointer.
2747**
2748** {F13103} The string returned by [sqlite3_sql(S)] is valid until the
2749** [prepared statement] S is deleted using [sqlite3_finalize(S)].
danielk1977d0e2a852007-11-14 06:48:48 +00002750*/
2751const char *sqlite3_sql(sqlite3_stmt *pStmt);
2752
2753/*
drhfddfa2d2007-12-05 18:05:16 +00002754** CAPI3REF: Dynamically Typed Value Object {F15000}
drhaa28e142008-03-18 13:47:20 +00002755** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value}
drh6ed48bf2007-06-14 20:57:18 +00002756**
drh33c1be32008-01-30 16:16:14 +00002757** SQLite uses the sqlite3_value object to represent all values
drhaa28e142008-03-18 13:47:20 +00002758** that can be stored in a database table.
drhf5befa02007-12-06 02:42:07 +00002759** SQLite uses dynamic typing for the values it stores.
drh33c1be32008-01-30 16:16:14 +00002760** Values stored in sqlite3_value objects can be
drhf5befa02007-12-06 02:42:07 +00002761** be integers, floating point values, strings, BLOBs, or NULL.
drhaa28e142008-03-18 13:47:20 +00002762**
2763** An sqlite3_value object may be either "protected" or "unprotected".
2764** Some interfaces require a protected sqlite3_value. Other interfaces
2765** will accept either a protected or an unprotected sqlite3_value.
2766** Every interface that accepts sqlite3_value arguments specifies
2767** whether or not it requires a protected sqlite3_value.
2768**
2769** The terms "protected" and "unprotected" refer to whether or not
2770** a mutex is held. A internal mutex is held for a protected
2771** sqlite3_value object but no mutex is held for an unprotected
2772** sqlite3_value object. If SQLite is compiled to be single-threaded
2773** (with SQLITE_THREADSAFE=0 and with [sqlite3_threadsafe()] returning 0)
2774** then there is no distinction between
2775** protected and unprotected sqlite3_value objects and they can be
shane26b34032008-05-23 17:21:09 +00002776** used interchangeable. However, for maximum code portability it
drhaa28e142008-03-18 13:47:20 +00002777** is recommended that applications make the distinction between
2778** between protected and unprotected sqlite3_value objects even if
2779** they are single threaded.
2780**
2781** The sqlite3_value objects that are passed as parameters into the
drhce5a5a02008-06-10 17:41:44 +00002782** implementation of
2783** [sqlite3_create_function | application-defined SQL functions]
2784** are protected.
drhaa28e142008-03-18 13:47:20 +00002785** The sqlite3_value object returned by
2786** [sqlite3_column_value()] is unprotected.
2787** Unprotected sqlite3_value objects may only be used with
drhce5a5a02008-06-10 17:41:44 +00002788** [sqlite3_result_value()] and [sqlite3_bind_value()].
2789** The [sqlite3_value_blob | sqlite3_value_type()] family of
2790** interfaces require protected sqlite3_value objects.
drhf4479502004-05-27 03:12:53 +00002791*/
drhf4479502004-05-27 03:12:53 +00002792typedef struct Mem sqlite3_value;
2793
2794/*
drhfddfa2d2007-12-05 18:05:16 +00002795** CAPI3REF: SQL Function Context Object {F16001}
drh4f26d6c2004-05-26 23:25:30 +00002796**
drh6ed48bf2007-06-14 20:57:18 +00002797** The context in which an SQL function executes is stored in an
drh33c1be32008-01-30 16:16:14 +00002798** sqlite3_context object. A pointer to an sqlite3_context
drhce5a5a02008-06-10 17:41:44 +00002799** object is always first parameter to
2800** [sqlite3_create_function | application-defined SQL functions].
2801** The applicationed-defined SQL function implementation will pass this
2802** pointer through into calls to
2803** [sqlite3_result_int | sqlite3_result()],
2804** [sqlite3_aggregate_context()],
2805** [sqlite3_user_data()],
2806** [sqlite3_context_db_handle()],
2807** [sqlite3_get_auxdata()], and/or [sqlite3_set_auxdata()].
drh6ed48bf2007-06-14 20:57:18 +00002808*/
2809typedef struct sqlite3_context sqlite3_context;
2810
2811/*
drhfddfa2d2007-12-05 18:05:16 +00002812** CAPI3REF: Binding Values To Prepared Statements {F13500}
drh6ed48bf2007-06-14 20:57:18 +00002813**
drh33c1be32008-01-30 16:16:14 +00002814** In the SQL strings input to [sqlite3_prepare_v2()] and its
drhf5befa02007-12-06 02:42:07 +00002815** variants, literals may be replace by a parameter in one
drhfddfa2d2007-12-05 18:05:16 +00002816** of these forms:
drh6ed48bf2007-06-14 20:57:18 +00002817**
2818** <ul>
2819** <li> ?
2820** <li> ?NNN
drh33c1be32008-01-30 16:16:14 +00002821** <li> :VVV
2822** <li> @VVV
drh6ed48bf2007-06-14 20:57:18 +00002823** <li> $VVV
2824** </ul>
2825**
2826** In the parameter forms shown above NNN is an integer literal,
drh33c1be32008-01-30 16:16:14 +00002827** VVV alpha-numeric parameter name.
2828** The values of these parameters (also called "host parameter names"
2829** or "SQL parameters")
drh6ed48bf2007-06-14 20:57:18 +00002830** can be set using the sqlite3_bind_*() routines defined here.
2831**
drh33c1be32008-01-30 16:16:14 +00002832** The first argument to the sqlite3_bind_*() routines always
drhfddfa2d2007-12-05 18:05:16 +00002833** is a pointer to the [sqlite3_stmt] object returned from
drh33c1be32008-01-30 16:16:14 +00002834** [sqlite3_prepare_v2()] or its variants. The second
2835** argument is the index of the parameter to be set. The
2836** first parameter has an index of 1. When the same named
drhfddfa2d2007-12-05 18:05:16 +00002837** parameter is used more than once, second and subsequent
2838** occurrences have the same index as the first occurrence.
drh33c1be32008-01-30 16:16:14 +00002839** The index for named parameters can be looked up using the
2840** [sqlite3_bind_parameter_name()] API if desired. The index
drhf5befa02007-12-06 02:42:07 +00002841** for "?NNN" parameters is the value of NNN.
drh33c1be32008-01-30 16:16:14 +00002842** The NNN value must be between 1 and the compile-time
2843** parameter SQLITE_MAX_VARIABLE_NUMBER (default value: 999).
drh6ed48bf2007-06-14 20:57:18 +00002844**
drh33c1be32008-01-30 16:16:14 +00002845** The third argument is the value to bind to the parameter.
drh6ed48bf2007-06-14 20:57:18 +00002846**
drh33c1be32008-01-30 16:16:14 +00002847** In those
drh6ed48bf2007-06-14 20:57:18 +00002848** routines that have a fourth argument, its value is the number of bytes
drh33c1be32008-01-30 16:16:14 +00002849** in the parameter. To be clear: the value is the number of <u>bytes</u>
drhb08c2a72008-04-16 00:28:13 +00002850** in the value, not the number of characters.
drh6ed48bf2007-06-14 20:57:18 +00002851** If the fourth parameter is negative, the length of the string is
shane26b34032008-05-23 17:21:09 +00002852** the number of bytes up to the first zero terminator.
drh4f26d6c2004-05-26 23:25:30 +00002853**
drh930cc582007-03-28 13:07:40 +00002854** The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and
drh900dfba2004-07-21 15:21:36 +00002855** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or
drh33c1be32008-01-30 16:16:14 +00002856** string after SQLite has finished with it. If the fifth argument is
2857** the special value [SQLITE_STATIC], then SQLite assumes that the
drhfddfa2d2007-12-05 18:05:16 +00002858** information is in static, unmanaged space and does not need to be freed.
drh33c1be32008-01-30 16:16:14 +00002859** If the fifth argument has the value [SQLITE_TRANSIENT], then
drhfddfa2d2007-12-05 18:05:16 +00002860** SQLite makes its own private copy of the data immediately, before
drh33c1be32008-01-30 16:16:14 +00002861** the sqlite3_bind_*() routine returns.
drh4f26d6c2004-05-26 23:25:30 +00002862**
drh33c1be32008-01-30 16:16:14 +00002863** The sqlite3_bind_zeroblob() routine binds a BLOB of length N that
2864** is filled with zeros. A zeroblob uses a fixed amount of memory
2865** (just an integer to hold it size) while it is being processed.
shane26b34032008-05-23 17:21:09 +00002866** Zeroblobs are intended to serve as placeholders for BLOBs whose
drh6ed48bf2007-06-14 20:57:18 +00002867** content is later written using
drh33c1be32008-01-30 16:16:14 +00002868** [sqlite3_blob_open | increment BLOB I/O] routines. A negative
2869** value for the zeroblob results in a zero-length BLOB.
drh6ed48bf2007-06-14 20:57:18 +00002870**
drh33c1be32008-01-30 16:16:14 +00002871** The sqlite3_bind_*() routines must be called after
drh6ed48bf2007-06-14 20:57:18 +00002872** [sqlite3_prepare_v2()] (and its variants) or [sqlite3_reset()] and
drh33c1be32008-01-30 16:16:14 +00002873** before [sqlite3_step()].
drh6ed48bf2007-06-14 20:57:18 +00002874** Bindings are not cleared by the [sqlite3_reset()] routine.
drh33c1be32008-01-30 16:16:14 +00002875** Unbound parameters are interpreted as NULL.
drh6ed48bf2007-06-14 20:57:18 +00002876**
drh33c1be32008-01-30 16:16:14 +00002877** These routines return [SQLITE_OK] on success or an error code if
2878** anything goes wrong. [SQLITE_RANGE] is returned if the parameter
shane26b34032008-05-23 17:21:09 +00002879** index is out of range. [SQLITE_NOMEM] is returned if malloc() fails.
drh33c1be32008-01-30 16:16:14 +00002880** [SQLITE_MISUSE] might be returned if these routines are called on a
drhfddfa2d2007-12-05 18:05:16 +00002881** virtual machine that is the wrong state or which has already been finalized.
drh33c1be32008-01-30 16:16:14 +00002882** Detection of misuse is unreliable. Applications should not depend
2883** on SQLITE_MISUSE returns. SQLITE_MISUSE is intended to indicate a
2884** a logic error in the application. Future versions of SQLite might
2885** panic rather than return SQLITE_MISUSE.
2886**
2887** See also: [sqlite3_bind_parameter_count()],
2888** [sqlite3_bind_parameter_name()], and
2889** [sqlite3_bind_parameter_index()].
2890**
2891** INVARIANTS:
2892**
2893** {F13506} The [sqlite3_prepare | SQL statement compiler] recognizes
2894** tokens of the forms "?", "?NNN", "$VVV", ":VVV", and "@VVV"
2895** as SQL parameters, where NNN is any sequence of one or more
2896** digits and where VVV is any sequence of one or more
2897** alphanumeric characters or "::" optionally followed by
2898** a string containing no spaces and contained within parentheses.
2899**
2900** {F13509} The initial value of an SQL parameter is NULL.
2901**
2902** {F13512} The index of an "?" SQL parameter is one larger than the
2903** largest index of SQL parameter to the left, or 1 if
2904** the "?" is the leftmost SQL parameter.
2905**
2906** {F13515} The index of an "?NNN" SQL parameter is the integer NNN.
2907**
2908** {F13518} The index of an ":VVV", "$VVV", or "@VVV" SQL parameter is
shane26b34032008-05-23 17:21:09 +00002909** the same as the index of leftmost occurrences of the same
drh33c1be32008-01-30 16:16:14 +00002910** parameter, or one more than the largest index over all
shane26b34032008-05-23 17:21:09 +00002911** parameters to the left if this is the first occurrence
drh33c1be32008-01-30 16:16:14 +00002912** of this parameter, or 1 if this is the leftmost parameter.
2913**
2914** {F13521} The [sqlite3_prepare | SQL statement compiler] fail with
2915** an [SQLITE_RANGE] error if the index of an SQL parameter
2916** is less than 1 or greater than SQLITE_MAX_VARIABLE_NUMBER.
2917**
2918** {F13524} Calls to [sqlite3_bind_text | sqlite3_bind(S,N,V,...)]
2919** associate the value V with all SQL parameters having an
2920** index of N in the [prepared statement] S.
2921**
2922** {F13527} Calls to [sqlite3_bind_text | sqlite3_bind(S,N,...)]
2923** override prior calls with the same values of S and N.
2924**
2925** {F13530} Bindings established by [sqlite3_bind_text | sqlite3_bind(S,...)]
2926** persist across calls to [sqlite3_reset(S)].
2927**
2928** {F13533} In calls to [sqlite3_bind_blob(S,N,V,L,D)],
2929** [sqlite3_bind_text(S,N,V,L,D)], or
2930** [sqlite3_bind_text16(S,N,V,L,D)] SQLite binds the first L
2931** bytes of the blob or string pointed to by V, when L
2932** is non-negative.
2933**
2934** {F13536} In calls to [sqlite3_bind_text(S,N,V,L,D)] or
2935** [sqlite3_bind_text16(S,N,V,L,D)] SQLite binds characters
2936** from V through the first zero character when L is negative.
2937**
2938** {F13539} In calls to [sqlite3_bind_blob(S,N,V,L,D)],
2939** [sqlite3_bind_text(S,N,V,L,D)], or
2940** [sqlite3_bind_text16(S,N,V,L,D)] when D is the special
2941** constant [SQLITE_STATIC], SQLite assumes that the value V
2942** is held in static unmanaged space that will not change
2943** during the lifetime of the binding.
2944**
2945** {F13542} In calls to [sqlite3_bind_blob(S,N,V,L,D)],
2946** [sqlite3_bind_text(S,N,V,L,D)], or
2947** [sqlite3_bind_text16(S,N,V,L,D)] when D is the special
2948** constant [SQLITE_TRANSIENT], the routine makes a
2949** private copy of V value before it returns.
2950**
2951** {F13545} In calls to [sqlite3_bind_blob(S,N,V,L,D)],
2952** [sqlite3_bind_text(S,N,V,L,D)], or
2953** [sqlite3_bind_text16(S,N,V,L,D)] when D is a pointer to
2954** a function, SQLite invokes that function to destroy the
2955** V value after it has finished using the V value.
2956**
2957** {F13548} In calls to [sqlite3_bind_zeroblob(S,N,V,L)] the value bound
2958** is a blob of L bytes, or a zero-length blob if L is negative.
drhaa28e142008-03-18 13:47:20 +00002959**
2960** {F13551} In calls to [sqlite3_bind_value(S,N,V)] the V argument may
2961** be either a [protected sqlite3_value] object or an
2962** [unprotected sqlite3_value] object.
drh4f26d6c2004-05-26 23:25:30 +00002963*/
danielk1977d8123362004-06-12 09:25:12 +00002964int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*));
drhf4479502004-05-27 03:12:53 +00002965int sqlite3_bind_double(sqlite3_stmt*, int, double);
2966int sqlite3_bind_int(sqlite3_stmt*, int, int);
drh6d2069d2007-08-14 01:58:53 +00002967int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64);
drhf4479502004-05-27 03:12:53 +00002968int sqlite3_bind_null(sqlite3_stmt*, int);
danielk1977d8123362004-06-12 09:25:12 +00002969int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*));
2970int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*));
drhf4479502004-05-27 03:12:53 +00002971int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);
drhb026e052007-05-02 01:34:31 +00002972int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n);
drh4f26d6c2004-05-26 23:25:30 +00002973
2974/*
drh33c1be32008-01-30 16:16:14 +00002975** CAPI3REF: Number Of SQL Parameters {F13600}
drh6ed48bf2007-06-14 20:57:18 +00002976**
drh33c1be32008-01-30 16:16:14 +00002977** This routine can be used to find the number of SQL parameters
2978** in a prepared statement. SQL parameters are tokens of the
2979** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as
shane26b34032008-05-23 17:21:09 +00002980** placeholders for values that are [sqlite3_bind_blob | bound]
drh33c1be32008-01-30 16:16:14 +00002981** to the parameters at a later time.
drh605264d2007-08-21 15:13:19 +00002982**
drh33c1be32008-01-30 16:16:14 +00002983** This routine actually returns the index of the largest parameter.
2984** For all forms except ?NNN, this will correspond to the number of
2985** unique parameters. If parameters of the ?NNN are used, there may
2986** be gaps in the list.
2987**
2988** See also: [sqlite3_bind_blob|sqlite3_bind()],
2989** [sqlite3_bind_parameter_name()], and
2990** [sqlite3_bind_parameter_index()].
2991**
2992** INVARIANTS:
2993**
2994** {F13601} The [sqlite3_bind_parameter_count(S)] interface returns
2995** the largest index of all SQL parameters in the
2996** [prepared statement] S, or 0 if S
2997** contains no SQL parameters.
drh75f6a032004-07-15 14:15:00 +00002998*/
2999int sqlite3_bind_parameter_count(sqlite3_stmt*);
3000
3001/*
drhfddfa2d2007-12-05 18:05:16 +00003002** CAPI3REF: Name Of A Host Parameter {F13620}
drh6ed48bf2007-06-14 20:57:18 +00003003**
drh33c1be32008-01-30 16:16:14 +00003004** This routine returns a pointer to the name of the n-th
3005** SQL parameter in a [prepared statement].
drhe1b3e802008-04-27 22:29:01 +00003006** SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA"
3007** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA"
3008** respectively.
3009** In other words, the initial ":" or "$" or "@" or "?"
drh33c1be32008-01-30 16:16:14 +00003010** is included as part of the name.
drhe1b3e802008-04-27 22:29:01 +00003011** Parameters of the form "?" without a following integer have no name.
drh6ed48bf2007-06-14 20:57:18 +00003012**
drh33c1be32008-01-30 16:16:14 +00003013** The first host parameter has an index of 1, not 0.
drh6ed48bf2007-06-14 20:57:18 +00003014**
drh33c1be32008-01-30 16:16:14 +00003015** If the value n is out of range or if the n-th parameter is
3016** nameless, then NULL is returned. The returned string is
drhfddfa2d2007-12-05 18:05:16 +00003017** always in the UTF-8 encoding even if the named parameter was
3018** originally specified as UTF-16 in [sqlite3_prepare16()] or
3019** [sqlite3_prepare16_v2()].
drh33c1be32008-01-30 16:16:14 +00003020**
3021** See also: [sqlite3_bind_blob|sqlite3_bind()],
3022** [sqlite3_bind_parameter_count()], and
3023** [sqlite3_bind_parameter_index()].
3024**
3025** INVARIANTS:
3026**
3027** {F13621} The [sqlite3_bind_parameter_name(S,N)] interface returns
3028** a UTF-8 rendering of the name of the SQL parameter in
3029** [prepared statement] S having index N, or
3030** NULL if there is no SQL parameter with index N or if the
drhe1b3e802008-04-27 22:29:01 +00003031** parameter with index N is an anonymous parameter "?".
drh895d7472004-08-20 16:02:39 +00003032*/
3033const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int);
3034
3035/*
drhfddfa2d2007-12-05 18:05:16 +00003036** CAPI3REF: Index Of A Parameter With A Given Name {F13640}
drh6ed48bf2007-06-14 20:57:18 +00003037**
drh33c1be32008-01-30 16:16:14 +00003038** Return the index of an SQL parameter given its name. The
3039** index value returned is suitable for use as the second
3040** parameter to [sqlite3_bind_blob|sqlite3_bind()]. A zero
3041** is returned if no matching parameter is found. The parameter
3042** name must be given in UTF-8 even if the original statement
3043** was prepared from UTF-16 text using [sqlite3_prepare16_v2()].
3044**
3045** See also: [sqlite3_bind_blob|sqlite3_bind()],
3046** [sqlite3_bind_parameter_count()], and
3047** [sqlite3_bind_parameter_index()].
3048**
3049** INVARIANTS:
3050**
3051** {F13641} The [sqlite3_bind_parameter_index(S,N)] interface returns
3052** the index of SQL parameter in [prepared statement]
3053** S whose name matches the UTF-8 string N, or 0 if there is
3054** no match.
drhfa6bc002004-09-07 16:19:52 +00003055*/
3056int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName);
3057
3058/*
drhfddfa2d2007-12-05 18:05:16 +00003059** CAPI3REF: Reset All Bindings On A Prepared Statement {F13660}
drh6ed48bf2007-06-14 20:57:18 +00003060**
drh33c1be32008-01-30 16:16:14 +00003061** Contrary to the intuition of many, [sqlite3_reset()] does not
drh6ed48bf2007-06-14 20:57:18 +00003062** reset the [sqlite3_bind_blob | bindings] on a
drh33c1be32008-01-30 16:16:14 +00003063** [prepared statement]. Use this routine to
drh6ed48bf2007-06-14 20:57:18 +00003064** reset all host parameters to NULL.
drh33c1be32008-01-30 16:16:14 +00003065**
3066** INVARIANTS:
3067**
3068** {F13661} The [sqlite3_clear_bindings(S)] interface resets all
3069** SQL parameter bindings in [prepared statement] S
3070** back to NULL.
danielk1977600dd0b2005-01-20 01:14:23 +00003071*/
3072int sqlite3_clear_bindings(sqlite3_stmt*);
3073
3074/*
drhfddfa2d2007-12-05 18:05:16 +00003075** CAPI3REF: Number Of Columns In A Result Set {F13710}
drh6ed48bf2007-06-14 20:57:18 +00003076**
drh33c1be32008-01-30 16:16:14 +00003077** Return the number of columns in the result set returned by the
3078** [prepared statement]. This routine returns 0
drh6ed48bf2007-06-14 20:57:18 +00003079** if pStmt is an SQL statement that does not return data (for
3080** example an UPDATE).
drh33c1be32008-01-30 16:16:14 +00003081**
3082** INVARIANTS:
3083**
3084** {F13711} The [sqlite3_column_count(S)] interface returns the number of
3085** columns in the result set generated by the
3086** [prepared statement] S, or 0 if S does not generate
3087** a result set.
danielk197765904932004-05-26 06:18:37 +00003088*/
3089int sqlite3_column_count(sqlite3_stmt *pStmt);
3090
3091/*
drhfddfa2d2007-12-05 18:05:16 +00003092** CAPI3REF: Column Names In A Result Set {F13720}
drh6ed48bf2007-06-14 20:57:18 +00003093**
drh33c1be32008-01-30 16:16:14 +00003094** These routines return the name assigned to a particular column
3095** in the result set of a SELECT statement. The sqlite3_column_name()
drhf5befa02007-12-06 02:42:07 +00003096** interface returns a pointer to a zero-terminated UTF8 string
3097** and sqlite3_column_name16() returns a pointer to a zero-terminated
drh33c1be32008-01-30 16:16:14 +00003098** UTF16 string. The first parameter is the
3099** [prepared statement] that implements the SELECT statement.
drh6ed48bf2007-06-14 20:57:18 +00003100** The second parameter is the column number. The left-most column is
3101** number 0.
3102**
drh33c1be32008-01-30 16:16:14 +00003103** The returned string pointer is valid until either the
3104** [prepared statement] is destroyed by [sqlite3_finalize()]
drh6ed48bf2007-06-14 20:57:18 +00003105** or until the next call sqlite3_column_name() or sqlite3_column_name16()
3106** on the same column.
drh4a50aac2007-08-23 02:47:53 +00003107**
drh33c1be32008-01-30 16:16:14 +00003108** If sqlite3_malloc() fails during the processing of either routine
drh4a50aac2007-08-23 02:47:53 +00003109** (for example during a conversion from UTF-8 to UTF-16) then a
3110** NULL pointer is returned.
drh33c1be32008-01-30 16:16:14 +00003111**
3112** The name of a result column is the value of the "AS" clause for
3113** that column, if there is an AS clause. If there is no AS clause
3114** then the name of the column is unspecified and may change from
3115** one release of SQLite to the next.
3116**
3117** INVARIANTS:
3118**
3119** {F13721} A successful invocation of the [sqlite3_column_name(S,N)]
3120** interface returns the name
3121** of the Nth column (where 0 is the left-most column) for the
3122** result set of [prepared statement] S as a
3123** zero-terminated UTF-8 string.
3124**
3125** {F13723} A successful invocation of the [sqlite3_column_name16(S,N)]
3126** interface returns the name
3127** of the Nth column (where 0 is the left-most column) for the
3128** result set of [prepared statement] S as a
3129** zero-terminated UTF-16 string in the native byte order.
3130**
3131** {F13724} The [sqlite3_column_name()] and [sqlite3_column_name16()]
3132** interfaces return a NULL pointer if they are unable to
shane26b34032008-05-23 17:21:09 +00003133** allocate memory to hold their normal return strings.
drh33c1be32008-01-30 16:16:14 +00003134**
3135** {F13725} If the N parameter to [sqlite3_column_name(S,N)] or
3136** [sqlite3_column_name16(S,N)] is out of range, then the
shane26b34032008-05-23 17:21:09 +00003137** interfaces return a NULL pointer.
drh33c1be32008-01-30 16:16:14 +00003138**
3139** {F13726} The strings returned by [sqlite3_column_name(S,N)] and
3140** [sqlite3_column_name16(S,N)] are valid until the next
3141** call to either routine with the same S and N parameters
3142** or until [sqlite3_finalize(S)] is called.
3143**
3144** {F13727} When a result column of a [SELECT] statement contains
shane26b34032008-05-23 17:21:09 +00003145** an AS clause, the name of that column is the identifier
drh33c1be32008-01-30 16:16:14 +00003146** to the right of the AS keyword.
danielk197765904932004-05-26 06:18:37 +00003147*/
drh6ed48bf2007-06-14 20:57:18 +00003148const char *sqlite3_column_name(sqlite3_stmt*, int N);
3149const void *sqlite3_column_name16(sqlite3_stmt*, int N);
danielk197765904932004-05-26 06:18:37 +00003150
3151/*
drhfddfa2d2007-12-05 18:05:16 +00003152** CAPI3REF: Source Of Data In A Query Result {F13740}
drh6ed48bf2007-06-14 20:57:18 +00003153**
drh33c1be32008-01-30 16:16:14 +00003154** These routines provide a means to determine what column of what
drh6ed48bf2007-06-14 20:57:18 +00003155** table in which database a result of a SELECT statement comes from.
drh33c1be32008-01-30 16:16:14 +00003156** The name of the database or table or column can be returned as
3157** either a UTF8 or UTF16 string. The _database_ routines return
drhbf2564f2007-06-21 15:25:05 +00003158** the database name, the _table_ routines return the table name, and
drh33c1be32008-01-30 16:16:14 +00003159** the origin_ routines return the column name.
drhbf2564f2007-06-21 15:25:05 +00003160** The returned string is valid until
drh33c1be32008-01-30 16:16:14 +00003161** the [prepared statement] is destroyed using
drh6ed48bf2007-06-14 20:57:18 +00003162** [sqlite3_finalize()] or until the same information is requested
drhbf2564f2007-06-21 15:25:05 +00003163** again in a different encoding.
3164**
drh33c1be32008-01-30 16:16:14 +00003165** The names returned are the original un-aliased names of the
drhbf2564f2007-06-21 15:25:05 +00003166** database, table, and column.
drh6ed48bf2007-06-14 20:57:18 +00003167**
drh33c1be32008-01-30 16:16:14 +00003168** The first argument to the following calls is a [prepared statement].
3169** These functions return information about the Nth column returned by
danielk1977955de522006-02-10 02:27:42 +00003170** the statement, where N is the second function argument.
3171**
drh33c1be32008-01-30 16:16:14 +00003172** If the Nth column returned by the statement is an expression
drh6ed48bf2007-06-14 20:57:18 +00003173** or subquery and is not a column value, then all of these functions
drh33c1be32008-01-30 16:16:14 +00003174** return NULL. These routine might also return NULL if a memory
3175** allocation error occurs. Otherwise, they return the
drh6ed48bf2007-06-14 20:57:18 +00003176** name of the attached database, table and column that query result
3177** column was extracted from.
danielk1977955de522006-02-10 02:27:42 +00003178**
drh33c1be32008-01-30 16:16:14 +00003179** As with all other SQLite APIs, those postfixed with "16" return
drhfddfa2d2007-12-05 18:05:16 +00003180** UTF-16 encoded strings, the other functions return UTF-8. {END}
danielk19774b1ae992006-02-10 03:06:10 +00003181**
3182** These APIs are only available if the library was compiled with the
3183** SQLITE_ENABLE_COLUMN_METADATA preprocessor symbol defined.
drh32bc3f62007-08-21 20:25:39 +00003184**
drhfddfa2d2007-12-05 18:05:16 +00003185** {U13751}
drh32bc3f62007-08-21 20:25:39 +00003186** If two or more threads call one or more of these routines against the same
3187** prepared statement and column at the same time then the results are
3188** undefined.
drh33c1be32008-01-30 16:16:14 +00003189**
3190** INVARIANTS:
3191**
3192** {F13741} The [sqlite3_column_database_name(S,N)] interface returns either
3193** the UTF-8 zero-terminated name of the database from which the
3194** Nth result column of [prepared statement] S
shane26b34032008-05-23 17:21:09 +00003195** is extracted, or NULL if the Nth column of S is a
drh33c1be32008-01-30 16:16:14 +00003196** general expression or if unable to allocate memory
3197** to store the name.
3198**
3199** {F13742} The [sqlite3_column_database_name16(S,N)] interface returns either
3200** the UTF-16 native byte order
3201** zero-terminated name of the database from which the
3202** Nth result column of [prepared statement] S
shane26b34032008-05-23 17:21:09 +00003203** is extracted, or NULL if the Nth column of S is a
drh33c1be32008-01-30 16:16:14 +00003204** general expression or if unable to allocate memory
3205** to store the name.
3206**
3207** {F13743} The [sqlite3_column_table_name(S,N)] interface returns either
3208** the UTF-8 zero-terminated name of the table from which the
3209** Nth result column of [prepared statement] S
shane26b34032008-05-23 17:21:09 +00003210** is extracted, or NULL if the Nth column of S is a
drh33c1be32008-01-30 16:16:14 +00003211** general expression or if unable to allocate memory
3212** to store the name.
3213**
3214** {F13744} The [sqlite3_column_table_name16(S,N)] interface returns either
3215** the UTF-16 native byte order
3216** zero-terminated name of the table from which the
3217** Nth result column of [prepared statement] S
shane26b34032008-05-23 17:21:09 +00003218** is extracted, or NULL if the Nth column of S is a
drh33c1be32008-01-30 16:16:14 +00003219** general expression or if unable to allocate memory
3220** to store the name.
3221**
3222** {F13745} The [sqlite3_column_origin_name(S,N)] interface returns either
3223** the UTF-8 zero-terminated name of the table column from which the
3224** Nth result column of [prepared statement] S
shane26b34032008-05-23 17:21:09 +00003225** is extracted, or NULL if the Nth column of S is a
drh33c1be32008-01-30 16:16:14 +00003226** general expression or if unable to allocate memory
3227** to store the name.
3228**
3229** {F13746} The [sqlite3_column_origin_name16(S,N)] interface returns either
3230** the UTF-16 native byte order
3231** zero-terminated name of the table column from which the
3232** Nth result column of [prepared statement] S
shane26b34032008-05-23 17:21:09 +00003233** is extracted, or NULL if the Nth column of S is a
drh33c1be32008-01-30 16:16:14 +00003234** general expression or if unable to allocate memory
3235** to store the name.
3236**
3237** {F13748} The return values from
3238** [sqlite3_column_database_name|column metadata interfaces]
3239** are valid
3240** for the lifetime of the [prepared statement]
3241** or until the encoding is changed by another metadata
3242** interface call for the same prepared statement and column.
3243**
3244** LIMITATIONS:
3245**
3246** {U13751} If two or more threads call one or more
3247** [sqlite3_column_database_name|column metadata interfaces]
3248** the same [prepared statement] and result column
3249** at the same time then the results are undefined.
danielk1977955de522006-02-10 02:27:42 +00003250*/
3251const char *sqlite3_column_database_name(sqlite3_stmt*,int);
3252const void *sqlite3_column_database_name16(sqlite3_stmt*,int);
3253const char *sqlite3_column_table_name(sqlite3_stmt*,int);
3254const void *sqlite3_column_table_name16(sqlite3_stmt*,int);
3255const char *sqlite3_column_origin_name(sqlite3_stmt*,int);
3256const void *sqlite3_column_origin_name16(sqlite3_stmt*,int);
3257
3258/*
drhfddfa2d2007-12-05 18:05:16 +00003259** CAPI3REF: Declared Datatype Of A Query Result {F13760}
drh6ed48bf2007-06-14 20:57:18 +00003260**
drh33c1be32008-01-30 16:16:14 +00003261** The first parameter is a [prepared statement].
3262** If this statement is a SELECT statement and the Nth column of the
drhf5befa02007-12-06 02:42:07 +00003263** returned result set of that SELECT is a table column (not an
drh6ed48bf2007-06-14 20:57:18 +00003264** expression or subquery) then the declared type of the table
drh33c1be32008-01-30 16:16:14 +00003265** column is returned. If the Nth column of the result set is an
drh6ed48bf2007-06-14 20:57:18 +00003266** expression or subquery, then a NULL pointer is returned.
drh33c1be32008-01-30 16:16:14 +00003267** The returned string is always UTF-8 encoded. {END}
drhfddfa2d2007-12-05 18:05:16 +00003268** For example, in the database schema:
danielk197765904932004-05-26 06:18:37 +00003269**
3270** CREATE TABLE t1(c1 VARIANT);
3271**
3272** And the following statement compiled:
3273**
danielk1977955de522006-02-10 02:27:42 +00003274** SELECT c1 + 1, c1 FROM t1;
danielk197765904932004-05-26 06:18:37 +00003275**
3276** Then this routine would return the string "VARIANT" for the second
3277** result column (i==1), and a NULL pointer for the first result column
3278** (i==0).
drh6ed48bf2007-06-14 20:57:18 +00003279**
3280** SQLite uses dynamic run-time typing. So just because a column
3281** is declared to contain a particular type does not mean that the
3282** data stored in that column is of the declared type. SQLite is
3283** strongly typed, but the typing is dynamic not static. Type
3284** is associated with individual values, not with the containers
3285** used to hold those values.
drh33c1be32008-01-30 16:16:14 +00003286**
3287** INVARIANTS:
3288**
3289** {F13761} A successful call to [sqlite3_column_decltype(S,N)]
3290** returns a zero-terminated UTF-8 string containing the
3291** the declared datatype of the table column that appears
3292** as the Nth column (numbered from 0) of the result set to the
3293** [prepared statement] S.
3294**
3295** {F13762} A successful call to [sqlite3_column_decltype16(S,N)]
3296** returns a zero-terminated UTF-16 native byte order string
3297** containing the declared datatype of the table column that appears
3298** as the Nth column (numbered from 0) of the result set to the
3299** [prepared statement] S.
3300**
3301** {F13763} If N is less than 0 or N is greater than or equal to
3302** the number of columns in [prepared statement] S
3303** or if the Nth column of S is an expression or subquery rather
3304** than a table column or if a memory allocation failure
3305** occurs during encoding conversions, then
3306** calls to [sqlite3_column_decltype(S,N)] or
3307** [sqlite3_column_decltype16(S,N)] return NULL.
danielk197765904932004-05-26 06:18:37 +00003308*/
drh33c1be32008-01-30 16:16:14 +00003309const char *sqlite3_column_decltype(sqlite3_stmt*,int);
danielk197765904932004-05-26 06:18:37 +00003310const void *sqlite3_column_decltype16(sqlite3_stmt*,int);
3311
danielk1977106bb232004-05-21 10:08:53 +00003312/*
drhfddfa2d2007-12-05 18:05:16 +00003313** CAPI3REF: Evaluate An SQL Statement {F13200}
danielk1977106bb232004-05-21 10:08:53 +00003314**
drh33c1be32008-01-30 16:16:14 +00003315** After an [prepared statement] has been prepared with a call
drh6ed48bf2007-06-14 20:57:18 +00003316** to either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or to one of
3317** the legacy interfaces [sqlite3_prepare()] or [sqlite3_prepare16()],
3318** then this function must be called one or more times to evaluate the
3319** statement.
danielk1977106bb232004-05-21 10:08:53 +00003320**
drh6ed48bf2007-06-14 20:57:18 +00003321** The details of the behavior of this sqlite3_step() interface depend
3322** on whether the statement was prepared using the newer "v2" interface
3323** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy
3324** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the
3325** new "v2" interface is recommended for new applications but the legacy
3326** interface will continue to be supported.
danielk1977106bb232004-05-21 10:08:53 +00003327**
drhc3dbded2008-05-12 12:39:55 +00003328** In the legacy interface, the return value will be either [SQLITE_BUSY],
drh6ed48bf2007-06-14 20:57:18 +00003329** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE].
3330** With the "v2" interface, any of the other [SQLITE_OK | result code]
3331** or [SQLITE_IOERR_READ | extended result code] might be returned as
3332** well.
3333**
3334** [SQLITE_BUSY] means that the database engine was unable to acquire the
3335** database locks it needs to do its job. If the statement is a COMMIT
3336** or occurs outside of an explicit transaction, then you can retry the
3337** statement. If the statement is not a COMMIT and occurs within a
3338** explicit transaction then you should rollback the transaction before
3339** continuing.
3340**
3341** [SQLITE_DONE] means that the statement has finished executing
danielk1977106bb232004-05-21 10:08:53 +00003342** successfully. sqlite3_step() should not be called again on this virtual
drh6ed48bf2007-06-14 20:57:18 +00003343** machine without first calling [sqlite3_reset()] to reset the virtual
3344** machine back to its initial state.
danielk1977106bb232004-05-21 10:08:53 +00003345**
3346** If the SQL statement being executed returns any data, then
drh6ed48bf2007-06-14 20:57:18 +00003347** [SQLITE_ROW] is returned each time a new row of data is ready
danielk1977106bb232004-05-21 10:08:53 +00003348** for processing by the caller. The values may be accessed using
drh6ed48bf2007-06-14 20:57:18 +00003349** the [sqlite3_column_int | column access functions].
3350** sqlite3_step() is called again to retrieve the next row of data.
danielk1977106bb232004-05-21 10:08:53 +00003351**
drh6ed48bf2007-06-14 20:57:18 +00003352** [SQLITE_ERROR] means that a run-time error (such as a constraint
danielk1977106bb232004-05-21 10:08:53 +00003353** violation) has occurred. sqlite3_step() should not be called again on
drh6ed48bf2007-06-14 20:57:18 +00003354** the VM. More information may be found by calling [sqlite3_errmsg()].
3355** With the legacy interface, a more specific error code (example:
3356** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth)
3357** can be obtained by calling [sqlite3_reset()] on the
drh33c1be32008-01-30 16:16:14 +00003358** [prepared statement]. In the "v2" interface,
drh6ed48bf2007-06-14 20:57:18 +00003359** the more specific error code is returned directly by sqlite3_step().
danielk1977106bb232004-05-21 10:08:53 +00003360**
drh6ed48bf2007-06-14 20:57:18 +00003361** [SQLITE_MISUSE] means that the this routine was called inappropriately.
drh33c1be32008-01-30 16:16:14 +00003362** Perhaps it was called on a [prepared statement] that has
drh6ed48bf2007-06-14 20:57:18 +00003363** already been [sqlite3_finalize | finalized] or on one that had
3364** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could
3365** be the case that the same database connection is being used by two or
3366** more threads at the same moment in time.
3367**
3368** <b>Goofy Interface Alert:</b>
3369** In the legacy interface,
3370** the sqlite3_step() API always returns a generic error code,
3371** [SQLITE_ERROR], following any error other than [SQLITE_BUSY]
3372** and [SQLITE_MISUSE]. You must call [sqlite3_reset()] or
3373** [sqlite3_finalize()] in order to find one of the specific
drh33c1be32008-01-30 16:16:14 +00003374** [error codes] that better describes the error.
drh6ed48bf2007-06-14 20:57:18 +00003375** We admit that this is a goofy design. The problem has been fixed
3376** with the "v2" interface. If you prepare all of your SQL statements
3377** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead
3378** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()], then the
drh33c1be32008-01-30 16:16:14 +00003379** more specific [error codes] are returned directly
drh6ed48bf2007-06-14 20:57:18 +00003380** by sqlite3_step(). The use of the "v2" interface is recommended.
drh33c1be32008-01-30 16:16:14 +00003381**
3382** INVARIANTS:
3383**
3384** {F13202} If [prepared statement] S is ready to be
3385** run, then [sqlite3_step(S)] advances that prepared statement
3386** until to completion or until it is ready to return another
3387** row of the result set or an interrupt or run-time error occurs.
3388**
3389** {F15304} When a call to [sqlite3_step(S)] causes the
3390** [prepared statement] S to run to completion,
3391** the function returns [SQLITE_DONE].
3392**
3393** {F15306} When a call to [sqlite3_step(S)] stops because it is ready
3394** to return another row of the result set, it returns
3395** [SQLITE_ROW].
3396**
3397** {F15308} If a call to [sqlite3_step(S)] encounters an
3398** [sqlite3_interrupt|interrupt] or a run-time error,
shane26b34032008-05-23 17:21:09 +00003399** it returns an appropriate error code that is not one of
drh33c1be32008-01-30 16:16:14 +00003400** [SQLITE_OK], [SQLITE_ROW], or [SQLITE_DONE].
3401**
3402** {F15310} If an [sqlite3_interrupt|interrupt] or run-time error
3403** occurs during a call to [sqlite3_step(S)]
3404** for a [prepared statement] S created using
3405** legacy interfaces [sqlite3_prepare()] or
3406** [sqlite3_prepare16()] then the function returns either
3407** [SQLITE_ERROR], [SQLITE_BUSY], or [SQLITE_MISUSE].
danielk1977106bb232004-05-21 10:08:53 +00003408*/
danielk197717240fd2004-05-26 00:07:25 +00003409int sqlite3_step(sqlite3_stmt*);
danielk1977106bb232004-05-21 10:08:53 +00003410
danielk1977106bb232004-05-21 10:08:53 +00003411/*
drhfddfa2d2007-12-05 18:05:16 +00003412** CAPI3REF: Number of columns in a result set {F13770}
drh6ed48bf2007-06-14 20:57:18 +00003413**
danielk1977106bb232004-05-21 10:08:53 +00003414** Return the number of values in the current row of the result set.
3415**
drh33c1be32008-01-30 16:16:14 +00003416** INVARIANTS:
3417**
3418** {F13771} After a call to [sqlite3_step(S)] that returns
3419** [SQLITE_ROW], the [sqlite3_data_count(S)] routine
3420** will return the same value as the
3421** [sqlite3_column_count(S)] function.
3422**
3423** {F13772} After [sqlite3_step(S)] has returned any value other than
3424** [SQLITE_ROW] or before [sqlite3_step(S)] has been
3425** called on the [prepared statement] for
3426** the first time since it was [sqlite3_prepare|prepared]
3427** or [sqlite3_reset|reset], the [sqlite3_data_count(S)]
3428** routine returns zero.
danielk1977106bb232004-05-21 10:08:53 +00003429*/
danielk197793d46752004-05-23 13:30:58 +00003430int sqlite3_data_count(sqlite3_stmt *pStmt);
danielk19774adee202004-05-08 08:23:19 +00003431
drh4f26d6c2004-05-26 23:25:30 +00003432/*
drhf5befa02007-12-06 02:42:07 +00003433** CAPI3REF: Fundamental Datatypes {F10265}
drh33c1be32008-01-30 16:16:14 +00003434** KEYWORDS: SQLITE_TEXT
drh6ed48bf2007-06-14 20:57:18 +00003435**
drhf5befa02007-12-06 02:42:07 +00003436** {F10266}Every value in SQLite has one of five fundamental datatypes:
drh6ed48bf2007-06-14 20:57:18 +00003437**
3438** <ul>
3439** <li> 64-bit signed integer
3440** <li> 64-bit IEEE floating point number
3441** <li> string
3442** <li> BLOB
3443** <li> NULL
drhfddfa2d2007-12-05 18:05:16 +00003444** </ul> {END}
drh6ed48bf2007-06-14 20:57:18 +00003445**
3446** These constants are codes for each of those types.
3447**
3448** Note that the SQLITE_TEXT constant was also used in SQLite version 2
3449** for a completely different meaning. Software that links against both
3450** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT not
3451** SQLITE_TEXT.
drh4f26d6c2004-05-26 23:25:30 +00003452*/
drh9c054832004-05-31 18:51:57 +00003453#define SQLITE_INTEGER 1
3454#define SQLITE_FLOAT 2
drh9c054832004-05-31 18:51:57 +00003455#define SQLITE_BLOB 4
3456#define SQLITE_NULL 5
drh1e284f42004-10-06 15:52:01 +00003457#ifdef SQLITE_TEXT
3458# undef SQLITE_TEXT
3459#else
3460# define SQLITE_TEXT 3
3461#endif
3462#define SQLITE3_TEXT 3
3463
3464/*
drhfddfa2d2007-12-05 18:05:16 +00003465** CAPI3REF: Results Values From A Query {F13800}
drh6ed48bf2007-06-14 20:57:18 +00003466**
drh33c1be32008-01-30 16:16:14 +00003467** These routines form the "result set query" interface.
3468**
drh32bc3f62007-08-21 20:25:39 +00003469** These routines return information about
3470** a single column of the current result row of a query. In every
drh6ed48bf2007-06-14 20:57:18 +00003471** case the first argument is a pointer to the
drh33c1be32008-01-30 16:16:14 +00003472** [prepared statement] that is being
drh32bc3f62007-08-21 20:25:39 +00003473** evaluated (the [sqlite3_stmt*] that was returned from
drh6ed48bf2007-06-14 20:57:18 +00003474** [sqlite3_prepare_v2()] or one of its variants) and
drh4f26d6c2004-05-26 23:25:30 +00003475** the second argument is the index of the column for which information
drh32bc3f62007-08-21 20:25:39 +00003476** should be returned. The left-most column of the result set
3477** has an index of 0.
danielk1977106bb232004-05-21 10:08:53 +00003478**
drh4f26d6c2004-05-26 23:25:30 +00003479** If the SQL statement is not currently point to a valid row, or if the
drh32bc3f62007-08-21 20:25:39 +00003480** the column index is out of range, the result is undefined.
3481** These routines may only be called when the most recent call to
3482** [sqlite3_step()] has returned [SQLITE_ROW] and neither
3483** [sqlite3_reset()] nor [sqlite3_finalize()] has been call subsequently.
3484** If any of these routines are called after [sqlite3_reset()] or
3485** [sqlite3_finalize()] or after [sqlite3_step()] has returned
3486** something other than [SQLITE_ROW], the results are undefined.
3487** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()]
3488** are called from a different thread while any of these routines
3489** are pending, then the results are undefined.
drh6ed48bf2007-06-14 20:57:18 +00003490**
3491** The sqlite3_column_type() routine returns
3492** [SQLITE_INTEGER | datatype code] for the initial data type
3493** of the result column. The returned value is one of [SQLITE_INTEGER],
3494** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value
3495** returned by sqlite3_column_type() is only meaningful if no type
3496** conversions have occurred as described below. After a type conversion,
3497** the value returned by sqlite3_column_type() is undefined. Future
3498** versions of SQLite may change the behavior of sqlite3_column_type()
3499** following a type conversion.
3500**
drh6ed48bf2007-06-14 20:57:18 +00003501** If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes()
3502** routine returns the number of bytes in that BLOB or string.
3503** If the result is a UTF-16 string, then sqlite3_column_bytes() converts
3504** the string to UTF-8 and then returns the number of bytes.
3505** If the result is a numeric value then sqlite3_column_bytes() uses
3506** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns
3507** the number of bytes in that string.
3508** The value returned does not include the zero terminator at the end
3509** of the string. For clarity: the value returned is the number of
3510** bytes in the string, not the number of characters.
3511**
drhc0b3abb2007-09-04 12:18:41 +00003512** Strings returned by sqlite3_column_text() and sqlite3_column_text16(),
drh33c1be32008-01-30 16:16:14 +00003513** even empty strings, are always zero terminated. The return
drhc0b3abb2007-09-04 12:18:41 +00003514** value from sqlite3_column_blob() for a zero-length blob is an arbitrary
3515** pointer, possibly even a NULL pointer.
3516**
drh6ed48bf2007-06-14 20:57:18 +00003517** The sqlite3_column_bytes16() routine is similar to sqlite3_column_bytes()
drh33c1be32008-01-30 16:16:14 +00003518** but leaves the result in UTF-16 in native byte order instead of UTF-8.
drh6ed48bf2007-06-14 20:57:18 +00003519** The zero terminator is not included in this count.
drh4f26d6c2004-05-26 23:25:30 +00003520**
drhaa28e142008-03-18 13:47:20 +00003521** The object returned by [sqlite3_column_value()] is an
3522** [unprotected sqlite3_value] object. An unprotected sqlite3_value object
3523** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()].
3524** If the [unprotected sqlite3_value] object returned by
3525** [sqlite3_column_value()] is used in any other way, including calls
3526** to routines like
3527** [sqlite3_value_int()], [sqlite3_value_text()], or [sqlite3_value_bytes()],
3528** then the behavior is undefined.
3529**
drh4f26d6c2004-05-26 23:25:30 +00003530** These routines attempt to convert the value where appropriate. For
3531** example, if the internal representation is FLOAT and a text result
drh6ed48bf2007-06-14 20:57:18 +00003532** is requested, [sqlite3_snprintf()] is used internally to do the conversion
drh4f26d6c2004-05-26 23:25:30 +00003533** automatically. The following table details the conversions that
3534** are applied:
3535**
drh6ed48bf2007-06-14 20:57:18 +00003536** <blockquote>
3537** <table border="1">
drh8bacf972007-08-25 16:21:29 +00003538** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion
drh4f26d6c2004-05-26 23:25:30 +00003539**
drh6ed48bf2007-06-14 20:57:18 +00003540** <tr><td> NULL <td> INTEGER <td> Result is 0
3541** <tr><td> NULL <td> FLOAT <td> Result is 0.0
3542** <tr><td> NULL <td> TEXT <td> Result is NULL pointer
3543** <tr><td> NULL <td> BLOB <td> Result is NULL pointer
3544** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float
3545** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer
3546** <tr><td> INTEGER <td> BLOB <td> Same as for INTEGER->TEXT
3547** <tr><td> FLOAT <td> INTEGER <td> Convert from float to integer
3548** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float
3549** <tr><td> FLOAT <td> BLOB <td> Same as FLOAT->TEXT
3550** <tr><td> TEXT <td> INTEGER <td> Use atoi()
3551** <tr><td> TEXT <td> FLOAT <td> Use atof()
3552** <tr><td> TEXT <td> BLOB <td> No change
3553** <tr><td> BLOB <td> INTEGER <td> Convert to TEXT then use atoi()
3554** <tr><td> BLOB <td> FLOAT <td> Convert to TEXT then use atof()
3555** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed
3556** </table>
3557** </blockquote>
drh4f26d6c2004-05-26 23:25:30 +00003558**
drh6ed48bf2007-06-14 20:57:18 +00003559** The table above makes reference to standard C library functions atoi()
3560** and atof(). SQLite does not really use these functions. It has its
shane26b34032008-05-23 17:21:09 +00003561** own equivalent internal routines. The atoi() and atof() names are
drh6ed48bf2007-06-14 20:57:18 +00003562** used in the table for brevity and because they are familiar to most
3563** C programmers.
3564**
3565** Note that when type conversions occur, pointers returned by prior
3566** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or
3567** sqlite3_column_text16() may be invalidated.
3568** Type conversions and pointer invalidations might occur
3569** in the following cases:
3570**
3571** <ul>
3572** <li><p> The initial content is a BLOB and sqlite3_column_text()
3573** or sqlite3_column_text16() is called. A zero-terminator might
3574** need to be added to the string.</p></li>
3575**
3576** <li><p> The initial content is UTF-8 text and sqlite3_column_bytes16() or
3577** sqlite3_column_text16() is called. The content must be converted
3578** to UTF-16.</p></li>
3579**
3580** <li><p> The initial content is UTF-16 text and sqlite3_column_bytes() or
3581** sqlite3_column_text() is called. The content must be converted
3582** to UTF-8.</p></li>
3583** </ul>
3584**
3585** Conversions between UTF-16be and UTF-16le are always done in place and do
3586** not invalidate a prior pointer, though of course the content of the buffer
3587** that the prior pointer points to will have been modified. Other kinds
3588** of conversion are done in place when it is possible, but sometime it is
3589** not possible and in those cases prior pointers are invalidated.
3590**
3591** The safest and easiest to remember policy is to invoke these routines
3592** in one of the following ways:
3593**
3594** <ul>
3595** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li>
3596** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li>
3597** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li>
3598** </ul>
3599**
3600** In other words, you should call sqlite3_column_text(), sqlite3_column_blob(),
3601** or sqlite3_column_text16() first to force the result into the desired
3602** format, then invoke sqlite3_column_bytes() or sqlite3_column_bytes16() to
3603** find the size of the result. Do not mix call to sqlite3_column_text() or
3604** sqlite3_column_blob() with calls to sqlite3_column_bytes16(). And do not
3605** mix calls to sqlite3_column_text16() with calls to sqlite3_column_bytes().
drh32bc3f62007-08-21 20:25:39 +00003606**
3607** The pointers returned are valid until a type conversion occurs as
3608** described above, or until [sqlite3_step()] or [sqlite3_reset()] or
3609** [sqlite3_finalize()] is called. The memory space used to hold strings
3610** and blobs is freed automatically. Do <b>not</b> pass the pointers returned
drh79491ab2007-09-04 12:00:00 +00003611** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into
drh32bc3f62007-08-21 20:25:39 +00003612** [sqlite3_free()].
drh4a50aac2007-08-23 02:47:53 +00003613**
3614** If a memory allocation error occurs during the evaluation of any
3615** of these routines, a default value is returned. The default value
3616** is either the integer 0, the floating point number 0.0, or a NULL
3617** pointer. Subsequent calls to [sqlite3_errcode()] will return
3618** [SQLITE_NOMEM].
drh21ac7f92008-01-31 12:26:49 +00003619**
3620** INVARIANTS:
3621**
3622** {F13803} The [sqlite3_column_blob(S,N)] interface converts the
3623** Nth column in the current row of the result set for
drh414025d2008-01-31 16:36:40 +00003624** [prepared statement] S into a blob and then returns a
drh21ac7f92008-01-31 12:26:49 +00003625** pointer to the converted value.
3626**
3627** {F13806} The [sqlite3_column_bytes(S,N)] interface returns the
3628** number of bytes in the blob or string (exclusive of the
3629** zero terminator on the string) that was returned by the
3630** most recent call to [sqlite3_column_blob(S,N)] or
3631** [sqlite3_column_text(S,N)].
3632**
3633** {F13809} The [sqlite3_column_bytes16(S,N)] interface returns the
3634** number of bytes in the string (exclusive of the
3635** zero terminator on the string) that was returned by the
3636** most recent call to [sqlite3_column_text16(S,N)].
3637**
3638** {F13812} The [sqlite3_column_double(S,N)] interface converts the
3639** Nth column in the current row of the result set for
drh414025d2008-01-31 16:36:40 +00003640** [prepared statement] S into a floating point value and
drh21ac7f92008-01-31 12:26:49 +00003641** returns a copy of that value.
3642**
3643** {F13815} The [sqlite3_column_int(S,N)] interface converts the
3644** Nth column in the current row of the result set for
drhafc91042008-02-21 02:09:45 +00003645** [prepared statement] S into a 64-bit signed integer and
3646** returns the lower 32 bits of that integer.
drh21ac7f92008-01-31 12:26:49 +00003647**
3648** {F13818} The [sqlite3_column_int64(S,N)] interface converts the
3649** Nth column in the current row of the result set for
drh414025d2008-01-31 16:36:40 +00003650** [prepared statement] S into a 64-bit signed integer and
drh21ac7f92008-01-31 12:26:49 +00003651** returns a copy of that integer.
3652**
3653** {F13821} The [sqlite3_column_text(S,N)] interface converts the
3654** Nth column in the current row of the result set for
drh414025d2008-01-31 16:36:40 +00003655** [prepared statement] S into a zero-terminated UTF-8
drh21ac7f92008-01-31 12:26:49 +00003656** string and returns a pointer to that string.
3657**
3658** {F13824} The [sqlite3_column_text16(S,N)] interface converts the
3659** Nth column in the current row of the result set for
drh414025d2008-01-31 16:36:40 +00003660** [prepared statement] S into a zero-terminated 2-byte
drh21ac7f92008-01-31 12:26:49 +00003661** aligned UTF-16 native byte order
3662** string and returns a pointer to that string.
3663**
3664** {F13827} The [sqlite3_column_type(S,N)] interface returns
drh414025d2008-01-31 16:36:40 +00003665** one of [SQLITE_NULL], [SQLITE_INTEGER], [SQLITE_FLOAT],
drh21ac7f92008-01-31 12:26:49 +00003666** [SQLITE_TEXT], or [SQLITE_BLOB] as appropriate for
3667** the Nth column in the current row of the result set for
drh414025d2008-01-31 16:36:40 +00003668** [prepared statement] S.
drh21ac7f92008-01-31 12:26:49 +00003669**
3670** {F13830} The [sqlite3_column_value(S,N)] interface returns a
drhaa28e142008-03-18 13:47:20 +00003671** pointer to an [unprotected sqlite3_value] object for the
drh21ac7f92008-01-31 12:26:49 +00003672** Nth column in the current row of the result set for
drh414025d2008-01-31 16:36:40 +00003673** [prepared statement] S.
danielk1977106bb232004-05-21 10:08:53 +00003674*/
drhf4479502004-05-27 03:12:53 +00003675const void *sqlite3_column_blob(sqlite3_stmt*, int iCol);
3676int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
3677int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
3678double sqlite3_column_double(sqlite3_stmt*, int iCol);
3679int sqlite3_column_int(sqlite3_stmt*, int iCol);
drh6d2069d2007-08-14 01:58:53 +00003680sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol);
drhf4479502004-05-27 03:12:53 +00003681const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol);
3682const void *sqlite3_column_text16(sqlite3_stmt*, int iCol);
drh4f26d6c2004-05-26 23:25:30 +00003683int sqlite3_column_type(sqlite3_stmt*, int iCol);
drh4be8b512006-06-13 23:51:34 +00003684sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol);
danielk19774adee202004-05-08 08:23:19 +00003685
danielk197765904932004-05-26 06:18:37 +00003686/*
drhfddfa2d2007-12-05 18:05:16 +00003687** CAPI3REF: Destroy A Prepared Statement Object {F13300}
drh6ed48bf2007-06-14 20:57:18 +00003688**
3689** The sqlite3_finalize() function is called to delete a
drh33c1be32008-01-30 16:16:14 +00003690** [prepared statement]. If the statement was
drh6ed48bf2007-06-14 20:57:18 +00003691** executed successfully, or not executed at all, then SQLITE_OK is returned.
3692** If execution of the statement failed then an
drh33c1be32008-01-30 16:16:14 +00003693** [error code] or [extended error code]
drh6ed48bf2007-06-14 20:57:18 +00003694** is returned.
danielk197765904932004-05-26 06:18:37 +00003695**
3696** This routine can be called at any point during the execution of the
drh33c1be32008-01-30 16:16:14 +00003697** [prepared statement]. If the virtual machine has not
drh6ed48bf2007-06-14 20:57:18 +00003698** completed execution when this routine is called, that is like
3699** encountering an error or an interrupt. (See [sqlite3_interrupt()].)
shane236ce972008-05-30 15:35:30 +00003700** Incomplete updates may be rolled back and transactions canceled,
drh6ed48bf2007-06-14 20:57:18 +00003701** depending on the circumstances, and the
drh33c1be32008-01-30 16:16:14 +00003702** [error code] returned will be [SQLITE_ABORT].
3703**
3704** INVARIANTS:
3705**
3706** {F11302} The [sqlite3_finalize(S)] interface destroys the
3707** [prepared statement] S and releases all
3708** memory and file resources held by that object.
3709**
3710** {F11304} If the most recent call to [sqlite3_step(S)] for the
3711** [prepared statement] S returned an error,
3712** then [sqlite3_finalize(S)] returns that same error.
danielk197765904932004-05-26 06:18:37 +00003713*/
3714int sqlite3_finalize(sqlite3_stmt *pStmt);
3715
3716/*
drhfddfa2d2007-12-05 18:05:16 +00003717** CAPI3REF: Reset A Prepared Statement Object {F13330}
drh6ed48bf2007-06-14 20:57:18 +00003718**
3719** The sqlite3_reset() function is called to reset a
drh33c1be32008-01-30 16:16:14 +00003720** [prepared statement] object.
drh85b623f2007-12-13 21:54:09 +00003721** back to its initial state, ready to be re-executed.
danielk197765904932004-05-26 06:18:37 +00003722** Any SQL statement variables that had values bound to them using
drh6ed48bf2007-06-14 20:57:18 +00003723** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values.
3724** Use [sqlite3_clear_bindings()] to reset the bindings.
drh33c1be32008-01-30 16:16:14 +00003725**
3726** {F11332} The [sqlite3_reset(S)] interface resets the [prepared statement] S
3727** back to the beginning of its program.
3728**
3729** {F11334} If the most recent call to [sqlite3_step(S)] for
3730** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE],
3731** or if [sqlite3_step(S)] has never before been called on S,
3732** then [sqlite3_reset(S)] returns [SQLITE_OK].
3733**
3734** {F11336} If the most recent call to [sqlite3_step(S)] for
3735** [prepared statement] S indicated an error, then
3736** [sqlite3_reset(S)] returns an appropriate [error code].
3737**
3738** {F11338} The [sqlite3_reset(S)] interface does not change the values
3739** of any [sqlite3_bind_blob|bindings] on [prepared statement] S.
danielk197765904932004-05-26 06:18:37 +00003740*/
3741int sqlite3_reset(sqlite3_stmt *pStmt);
3742
3743/*
drhfddfa2d2007-12-05 18:05:16 +00003744** CAPI3REF: Create Or Redefine SQL Functions {F16100}
drh21ac7f92008-01-31 12:26:49 +00003745** KEYWORDS: {function creation routines}
drh6ed48bf2007-06-14 20:57:18 +00003746**
drh21ac7f92008-01-31 12:26:49 +00003747** These two functions (collectively known as
3748** "function creation routines") are used to add SQL functions or aggregates
drh6ed48bf2007-06-14 20:57:18 +00003749** or to redefine the behavior of existing SQL functions or aggregates. The
danielk197765904932004-05-26 06:18:37 +00003750** difference only between the two is that the second parameter, the
3751** name of the (scalar) function or aggregate, is encoded in UTF-8 for
3752** sqlite3_create_function() and UTF-16 for sqlite3_create_function16().
3753**
drh1c3cfc62008-03-08 12:37:30 +00003754** The first parameter is the [database connection] to which the SQL
3755** function is to be added. If a single
3756** program uses more than one [database connection] internally, then SQL
3757** functions must be added individually to each [database connection].
danielk197765904932004-05-26 06:18:37 +00003758**
drh6ed48bf2007-06-14 20:57:18 +00003759** The second parameter is the name of the SQL function to be created
3760** or redefined.
3761** The length of the name is limited to 255 bytes, exclusive of the
3762** zero-terminator. Note that the name length limit is in bytes, not
3763** characters. Any attempt to create a function with a longer name
3764** will result in an SQLITE_ERROR error.
3765**
3766** The third parameter is the number of arguments that the SQL function or
3767** aggregate takes. If this parameter is negative, then the SQL function or
danielk197765904932004-05-26 06:18:37 +00003768** aggregate may take any number of arguments.
3769**
drh6ed48bf2007-06-14 20:57:18 +00003770** The fourth parameter, eTextRep, specifies what
3771** [SQLITE_UTF8 | text encoding] this SQL function prefers for
3772** its parameters. Any SQL function implementation should be able to work
3773** work with UTF-8, UTF-16le, or UTF-16be. But some implementations may be
3774** more efficient with one encoding than another. It is allowed to
drh6d2069d2007-08-14 01:58:53 +00003775** invoke sqlite3_create_function() or sqlite3_create_function16() multiple
drh6ed48bf2007-06-14 20:57:18 +00003776** times with the same function but with different values of eTextRep.
3777** When multiple implementations of the same function are available, SQLite
3778** will pick the one that involves the least amount of data conversion.
3779** If there is only a single implementation which does not care what
3780** text encoding is used, then the fourth argument should be
3781** [SQLITE_ANY].
3782**
3783** The fifth parameter is an arbitrary pointer. The implementation
3784** of the function can gain access to this pointer using
drh6d2069d2007-08-14 01:58:53 +00003785** [sqlite3_user_data()].
danielk1977d02eb1f2004-06-06 09:44:03 +00003786**
danielk197765904932004-05-26 06:18:37 +00003787** The seventh, eighth and ninth parameters, xFunc, xStep and xFinal, are
drh6ed48bf2007-06-14 20:57:18 +00003788** pointers to C-language functions that implement the SQL
3789** function or aggregate. A scalar SQL function requires an implementation of
danielk197765904932004-05-26 06:18:37 +00003790** the xFunc callback only, NULL pointers should be passed as the xStep
drh6ed48bf2007-06-14 20:57:18 +00003791** and xFinal parameters. An aggregate SQL function requires an implementation
3792** of xStep and xFinal and NULL should be passed for xFunc. To delete an
3793** existing SQL function or aggregate, pass NULL for all three function
shane26b34032008-05-23 17:21:09 +00003794** callbacks.
drh6ed48bf2007-06-14 20:57:18 +00003795**
3796** It is permitted to register multiple implementations of the same
3797** functions with the same name but with either differing numbers of
shane26b34032008-05-23 17:21:09 +00003798** arguments or differing preferred text encodings. SQLite will use
drh6ed48bf2007-06-14 20:57:18 +00003799** the implementation most closely matches the way in which the
3800** SQL function is used.
drh21ac7f92008-01-31 12:26:49 +00003801**
3802** INVARIANTS:
3803**
3804** {F16103} The [sqlite3_create_function16()] interface behaves exactly
3805** like [sqlite3_create_function()] in every way except that it
3806** interprets the zFunctionName argument as
3807** zero-terminated UTF-16 native byte order instead of as a
3808** zero-terminated UTF-8.
3809**
drhafc91042008-02-21 02:09:45 +00003810** {F16106} A successful invocation of
3811** the [sqlite3_create_function(D,X,N,E,...)] interface registers
3812** or replaces callback functions in [database connection] D
3813** used to implement the SQL function named X with N parameters
shane26b34032008-05-23 17:21:09 +00003814** and having a preferred text encoding of E.
drhafc91042008-02-21 02:09:45 +00003815**
3816** {F16109} A successful call to [sqlite3_create_function(D,X,N,E,P,F,S,L)]
3817** replaces the P, F, S, and L values from any prior calls with
3818** the same D, X, N, and E values.
3819**
3820** {F16112} The [sqlite3_create_function(D,X,...)] interface fails with
3821** a return code of [SQLITE_ERROR] if the SQL function name X is
3822** longer than 255 bytes exclusive of the zero terminator.
3823**
3824** {F16118} Either F must be NULL and S and L are non-NULL or else F
3825** is non-NULL and S and L are NULL, otherwise
3826** [sqlite3_create_function(D,X,N,E,P,F,S,L)] returns [SQLITE_ERROR].
3827**
3828** {F16121} The [sqlite3_create_function(D,...)] interface fails with an
3829** error code of [SQLITE_BUSY] if there exist [prepared statements]
3830** associated with the [database connection] D.
3831**
3832** {F16124} The [sqlite3_create_function(D,X,N,...)] interface fails with an
3833** error code of [SQLITE_ERROR] if parameter N (specifying the number
3834** of arguments to the SQL function being registered) is less
3835** than -1 or greater than 127.
3836**
3837** {F16127} When N is non-negative, the [sqlite3_create_function(D,X,N,...)]
3838** interface causes callbacks to be invoked for the SQL function
3839** named X when the number of arguments to the SQL function is
3840** exactly N.
3841**
3842** {F16130} When N is -1, the [sqlite3_create_function(D,X,N,...)]
3843** interface causes callbacks to be invoked for the SQL function
3844** named X with any number of arguments.
3845**
3846** {F16133} When calls to [sqlite3_create_function(D,X,N,...)]
3847** specify multiple implementations of the same function X
3848** and when one implementation has N>=0 and the other has N=(-1)
3849** the implementation with a non-zero N is preferred.
3850**
3851** {F16136} When calls to [sqlite3_create_function(D,X,N,E,...)]
3852** specify multiple implementations of the same function X with
3853** the same number of arguments N but with different
3854** encodings E, then the implementation where E matches the
3855** database encoding is preferred.
3856**
3857** {F16139} For an aggregate SQL function created using
3858** [sqlite3_create_function(D,X,N,E,P,0,S,L)] the finializer
3859** function L will always be invoked exactly once if the
3860** step function S is called one or more times.
drhaa28e142008-03-18 13:47:20 +00003861**
3862** {F16142} When SQLite invokes either the xFunc or xStep function of
3863** an application-defined SQL function or aggregate created
3864** by [sqlite3_create_function()] or [sqlite3_create_function16()],
3865** then the array of [sqlite3_value] objects passed as the
3866** third parameter are always [protected sqlite3_value] objects.
danielk197765904932004-05-26 06:18:37 +00003867*/
3868int sqlite3_create_function(
drh33c1be32008-01-30 16:16:14 +00003869 sqlite3 *db,
danielk197765904932004-05-26 06:18:37 +00003870 const char *zFunctionName,
3871 int nArg,
3872 int eTextRep,
drh33c1be32008-01-30 16:16:14 +00003873 void *pApp,
danielk197765904932004-05-26 06:18:37 +00003874 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
3875 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
3876 void (*xFinal)(sqlite3_context*)
3877);
3878int sqlite3_create_function16(
drh33c1be32008-01-30 16:16:14 +00003879 sqlite3 *db,
danielk197765904932004-05-26 06:18:37 +00003880 const void *zFunctionName,
3881 int nArg,
3882 int eTextRep,
drh33c1be32008-01-30 16:16:14 +00003883 void *pApp,
danielk197765904932004-05-26 06:18:37 +00003884 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
3885 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
3886 void (*xFinal)(sqlite3_context*)
3887);
3888
3889/*
drhf5befa02007-12-06 02:42:07 +00003890** CAPI3REF: Text Encodings {F10267}
drh6ed48bf2007-06-14 20:57:18 +00003891**
3892** These constant define integer codes that represent the various
3893** text encodings supported by SQLite.
danielk197765904932004-05-26 06:18:37 +00003894*/
drh6ed48bf2007-06-14 20:57:18 +00003895#define SQLITE_UTF8 1
3896#define SQLITE_UTF16LE 2
3897#define SQLITE_UTF16BE 3
3898#define SQLITE_UTF16 4 /* Use native byte order */
3899#define SQLITE_ANY 5 /* sqlite3_create_function only */
3900#define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */
danielk197765904932004-05-26 06:18:37 +00003901
danielk19770ffba6b2004-05-24 09:10:10 +00003902/*
drh6ed48bf2007-06-14 20:57:18 +00003903** CAPI3REF: Obsolete Functions
3904**
3905** These functions are all now obsolete. In order to maintain
3906** backwards compatibility with older code, we continue to support
3907** these functions. However, new development projects should avoid
3908** the use of these functions. To help encourage people to avoid
3909** using these functions, we are not going to tell you want they do.
3910*/
3911int sqlite3_aggregate_count(sqlite3_context*);
3912int sqlite3_expired(sqlite3_stmt*);
3913int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*);
3914int sqlite3_global_recover(void);
drhe30f4422007-08-21 16:15:55 +00003915void sqlite3_thread_cleanup(void);
drhd64621d2007-11-05 17:54:17 +00003916int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),void*,sqlite3_int64);
drh6ed48bf2007-06-14 20:57:18 +00003917
3918/*
drhfddfa2d2007-12-05 18:05:16 +00003919** CAPI3REF: Obtaining SQL Function Parameter Values {F15100}
drh6ed48bf2007-06-14 20:57:18 +00003920**
3921** The C-language implementation of SQL functions and aggregates uses
3922** this set of interface routines to access the parameter values on
3923** the function or aggregate.
3924**
3925** The xFunc (for scalar functions) or xStep (for aggregates) parameters
3926** to [sqlite3_create_function()] and [sqlite3_create_function16()]
3927** define callbacks that implement the SQL functions and aggregates.
3928** The 4th parameter to these callbacks is an array of pointers to
drhaa28e142008-03-18 13:47:20 +00003929** [protected sqlite3_value] objects. There is one [sqlite3_value] object for
drh6ed48bf2007-06-14 20:57:18 +00003930** each parameter to the SQL function. These routines are used to
3931** extract values from the [sqlite3_value] objects.
3932**
drhaa28e142008-03-18 13:47:20 +00003933** These routines work only with [protected sqlite3_value] objects.
3934** Any attempt to use these routines on an [unprotected sqlite3_value]
3935** object results in undefined behavior.
3936**
drh6ed48bf2007-06-14 20:57:18 +00003937** These routines work just like the corresponding
3938** [sqlite3_column_blob | sqlite3_column_* routines] except that
drhaa28e142008-03-18 13:47:20 +00003939** these routines take a single [protected sqlite3_value] object pointer
shane26b34032008-05-23 17:21:09 +00003940** instead of a [sqlite3_stmt*] pointer and an integer column number.
drh6ed48bf2007-06-14 20:57:18 +00003941**
3942** The sqlite3_value_text16() interface extracts a UTF16 string
3943** in the native byte-order of the host machine. The
3944** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces
3945** extract UTF16 strings as big-endian and little-endian respectively.
3946**
3947** The sqlite3_value_numeric_type() interface attempts to apply
3948** numeric affinity to the value. This means that an attempt is
3949** made to convert the value to an integer or floating point. If
drhf5befa02007-12-06 02:42:07 +00003950** such a conversion is possible without loss of information (in other
3951** words if the value is a string that looks like a number)
3952** then the conversion is done. Otherwise no conversion occurs. The
drh6ed48bf2007-06-14 20:57:18 +00003953** [SQLITE_INTEGER | datatype] after conversion is returned.
3954**
3955** Please pay particular attention to the fact that the pointer that
3956** is returned from [sqlite3_value_blob()], [sqlite3_value_text()], or
3957** [sqlite3_value_text16()] can be invalidated by a subsequent call to
drh6d2069d2007-08-14 01:58:53 +00003958** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()],
drh6ed48bf2007-06-14 20:57:18 +00003959** or [sqlite3_value_text16()].
drhe53831d2007-08-17 01:14:38 +00003960**
3961** These routines must be called from the same thread as
drhaa28e142008-03-18 13:47:20 +00003962** the SQL function that supplied the [sqlite3_value*] parameters.
drhf5befa02007-12-06 02:42:07 +00003963**
drhafc91042008-02-21 02:09:45 +00003964**
3965** INVARIANTS:
3966**
3967** {F15103} The [sqlite3_value_blob(V)] interface converts the
drhaa28e142008-03-18 13:47:20 +00003968** [protected sqlite3_value] object V into a blob and then returns a
drhafc91042008-02-21 02:09:45 +00003969** pointer to the converted value.
3970**
3971** {F15106} The [sqlite3_value_bytes(V)] interface returns the
3972** number of bytes in the blob or string (exclusive of the
3973** zero terminator on the string) that was returned by the
3974** most recent call to [sqlite3_value_blob(V)] or
3975** [sqlite3_value_text(V)].
3976**
3977** {F15109} The [sqlite3_value_bytes16(V)] interface returns the
3978** number of bytes in the string (exclusive of the
3979** zero terminator on the string) that was returned by the
3980** most recent call to [sqlite3_value_text16(V)],
3981** [sqlite3_value_text16be(V)], or [sqlite3_value_text16le(V)].
3982**
3983** {F15112} The [sqlite3_value_double(V)] interface converts the
drhaa28e142008-03-18 13:47:20 +00003984** [protected sqlite3_value] object V into a floating point value and
drhafc91042008-02-21 02:09:45 +00003985** returns a copy of that value.
3986**
3987** {F15115} The [sqlite3_value_int(V)] interface converts the
drhaa28e142008-03-18 13:47:20 +00003988** [protected sqlite3_value] object V into a 64-bit signed integer and
drhafc91042008-02-21 02:09:45 +00003989** returns the lower 32 bits of that integer.
3990**
3991** {F15118} The [sqlite3_value_int64(V)] interface converts the
drhaa28e142008-03-18 13:47:20 +00003992** [protected sqlite3_value] object V into a 64-bit signed integer and
drhafc91042008-02-21 02:09:45 +00003993** returns a copy of that integer.
3994**
3995** {F15121} The [sqlite3_value_text(V)] interface converts the
drhaa28e142008-03-18 13:47:20 +00003996** [protected sqlite3_value] object V into a zero-terminated UTF-8
drhafc91042008-02-21 02:09:45 +00003997** string and returns a pointer to that string.
3998**
3999** {F15124} The [sqlite3_value_text16(V)] interface converts the
drhaa28e142008-03-18 13:47:20 +00004000** [protected sqlite3_value] object V into a zero-terminated 2-byte
drhafc91042008-02-21 02:09:45 +00004001** aligned UTF-16 native byte order
4002** string and returns a pointer to that string.
4003**
4004** {F15127} The [sqlite3_value_text16be(V)] interface converts the
drhaa28e142008-03-18 13:47:20 +00004005** [protected sqlite3_value] object V into a zero-terminated 2-byte
drhafc91042008-02-21 02:09:45 +00004006** aligned UTF-16 big-endian
4007** string and returns a pointer to that string.
4008**
4009** {F15130} The [sqlite3_value_text16le(V)] interface converts the
drhaa28e142008-03-18 13:47:20 +00004010** [protected sqlite3_value] object V into a zero-terminated 2-byte
drhafc91042008-02-21 02:09:45 +00004011** aligned UTF-16 little-endian
4012** string and returns a pointer to that string.
4013**
4014** {F15133} The [sqlite3_value_type(V)] interface returns
4015** one of [SQLITE_NULL], [SQLITE_INTEGER], [SQLITE_FLOAT],
4016** [SQLITE_TEXT], or [SQLITE_BLOB] as appropriate for
4017** the [sqlite3_value] object V.
4018**
4019** {F15136} The [sqlite3_value_numeric_type(V)] interface converts
drhaa28e142008-03-18 13:47:20 +00004020** the [protected sqlite3_value] object V into either an integer or
drhafc91042008-02-21 02:09:45 +00004021** a floating point value if it can do so without loss of
4022** information, and returns one of [SQLITE_NULL],
4023** [SQLITE_INTEGER], [SQLITE_FLOAT], [SQLITE_TEXT], or
4024** [SQLITE_BLOB] as appropriate for
drhaa28e142008-03-18 13:47:20 +00004025** the [protected sqlite3_value] object V after the conversion attempt.
danielk19770ffba6b2004-05-24 09:10:10 +00004026*/
drhf4479502004-05-27 03:12:53 +00004027const void *sqlite3_value_blob(sqlite3_value*);
4028int sqlite3_value_bytes(sqlite3_value*);
4029int sqlite3_value_bytes16(sqlite3_value*);
4030double sqlite3_value_double(sqlite3_value*);
4031int sqlite3_value_int(sqlite3_value*);
drh6d2069d2007-08-14 01:58:53 +00004032sqlite3_int64 sqlite3_value_int64(sqlite3_value*);
drhf4479502004-05-27 03:12:53 +00004033const unsigned char *sqlite3_value_text(sqlite3_value*);
4034const void *sqlite3_value_text16(sqlite3_value*);
danielk1977d8123362004-06-12 09:25:12 +00004035const void *sqlite3_value_text16le(sqlite3_value*);
4036const void *sqlite3_value_text16be(sqlite3_value*);
danielk197793d46752004-05-23 13:30:58 +00004037int sqlite3_value_type(sqlite3_value*);
drh29d72102006-02-09 22:13:41 +00004038int sqlite3_value_numeric_type(sqlite3_value*);
danielk19770ffba6b2004-05-24 09:10:10 +00004039
4040/*
drhfddfa2d2007-12-05 18:05:16 +00004041** CAPI3REF: Obtain Aggregate Function Context {F16210}
drh6ed48bf2007-06-14 20:57:18 +00004042**
4043** The implementation of aggregate SQL functions use this routine to allocate
drhf5befa02007-12-06 02:42:07 +00004044** a structure for storing their state.
drhafc91042008-02-21 02:09:45 +00004045** The first time the sqlite3_aggregate_context() routine is
drhf5befa02007-12-06 02:42:07 +00004046** is called for a particular aggregate, SQLite allocates nBytes of memory
4047** zeros that memory, and returns a pointer to it.
drhafc91042008-02-21 02:09:45 +00004048** On second and subsequent calls to sqlite3_aggregate_context()
4049** for the same aggregate function index, the same buffer is returned.
drhf5befa02007-12-06 02:42:07 +00004050** The implementation
danielk19770ae8b832004-05-25 12:05:56 +00004051** of the aggregate can use the returned buffer to accumulate data.
4052**
drhafc91042008-02-21 02:09:45 +00004053** SQLite automatically frees the allocated buffer when the aggregate
4054** query concludes.
drh6ed48bf2007-06-14 20:57:18 +00004055**
4056** The first parameter should be a copy of the
4057** [sqlite3_context | SQL function context] that is the first
4058** parameter to the callback routine that implements the aggregate
4059** function.
drhe53831d2007-08-17 01:14:38 +00004060**
4061** This routine must be called from the same thread in which
drh605264d2007-08-21 15:13:19 +00004062** the aggregate SQL function is running.
drhafc91042008-02-21 02:09:45 +00004063**
4064** INVARIANTS:
4065**
4066** {F16211} The first invocation of [sqlite3_aggregate_context(C,N)] for
4067** a particular instance of an aggregate function (for a particular
4068** context C) causes SQLite to allocation N bytes of memory,
shane26b34032008-05-23 17:21:09 +00004069** zero that memory, and return a pointer to the allocated
drhafc91042008-02-21 02:09:45 +00004070** memory.
4071**
4072** {F16213} If a memory allocation error occurs during
4073** [sqlite3_aggregate_context(C,N)] then the function returns 0.
4074**
4075** {F16215} Second and subsequent invocations of
4076** [sqlite3_aggregate_context(C,N)] for the same context pointer C
4077** ignore the N parameter and return a pointer to the same
4078** block of memory returned by the first invocation.
4079**
4080** {F16217} The memory allocated by [sqlite3_aggregate_context(C,N)] is
4081** automatically freed on the next call to [sqlite3_reset()]
4082** or [sqlite3_finalize()] for the [prepared statement] containing
4083** the aggregate function associated with context C.
danielk19770ae8b832004-05-25 12:05:56 +00004084*/
drh4f26d6c2004-05-26 23:25:30 +00004085void *sqlite3_aggregate_context(sqlite3_context*, int nBytes);
danielk19777e18c252004-05-25 11:47:24 +00004086
4087/*
drhfddfa2d2007-12-05 18:05:16 +00004088** CAPI3REF: User Data For Functions {F16240}
drh6ed48bf2007-06-14 20:57:18 +00004089**
drhafc91042008-02-21 02:09:45 +00004090** The sqlite3_user_data() interface returns a copy of
drhf5befa02007-12-06 02:42:07 +00004091** the pointer that was the pUserData parameter (the 5th parameter)
shane26b34032008-05-23 17:21:09 +00004092** of the [sqlite3_create_function()]
drhf5befa02007-12-06 02:42:07 +00004093** and [sqlite3_create_function16()] routines that originally
4094** registered the application defined function. {END}
drhe53831d2007-08-17 01:14:38 +00004095**
drhafc91042008-02-21 02:09:45 +00004096** This routine must be called from the same thread in which
drhf5befa02007-12-06 02:42:07 +00004097** the application-defined function is running.
drhafc91042008-02-21 02:09:45 +00004098**
4099** INVARIANTS:
4100**
4101** {F16243} The [sqlite3_user_data(C)] interface returns a copy of the
4102** P pointer from the [sqlite3_create_function(D,X,N,E,P,F,S,L)]
4103** or [sqlite3_create_function16(D,X,N,E,P,F,S,L)] call that
4104** registered the SQL function associated with
4105** [sqlite3_context] C.
danielk19777e18c252004-05-25 11:47:24 +00004106*/
4107void *sqlite3_user_data(sqlite3_context*);
4108
4109/*
drhfa4a4b92008-03-19 21:45:51 +00004110** CAPI3REF: Database Connection For Functions {F16250}
4111**
4112** The sqlite3_context_db_handle() interface returns a copy of
4113** the pointer to the [database connection] (the 1st parameter)
shane26b34032008-05-23 17:21:09 +00004114** of the [sqlite3_create_function()]
drhfa4a4b92008-03-19 21:45:51 +00004115** and [sqlite3_create_function16()] routines that originally
4116** registered the application defined function.
4117**
4118** INVARIANTS:
4119**
4120** {F16253} The [sqlite3_context_db_handle(C)] interface returns a copy of the
4121** D pointer from the [sqlite3_create_function(D,X,N,E,P,F,S,L)]
4122** or [sqlite3_create_function16(D,X,N,E,P,F,S,L)] call that
4123** registered the SQL function associated with
4124** [sqlite3_context] C.
4125*/
4126sqlite3 *sqlite3_context_db_handle(sqlite3_context*);
4127
4128/*
drhfddfa2d2007-12-05 18:05:16 +00004129** CAPI3REF: Function Auxiliary Data {F16270}
drh6ed48bf2007-06-14 20:57:18 +00004130**
4131** The following two functions may be used by scalar SQL functions to
danielk1977682f68b2004-06-05 10:22:17 +00004132** associate meta-data with argument values. If the same value is passed to
drh6ed48bf2007-06-14 20:57:18 +00004133** multiple invocations of the same SQL function during query execution, under
danielk1977682f68b2004-06-05 10:22:17 +00004134** some circumstances the associated meta-data may be preserved. This may
4135** be used, for example, to add a regular-expression matching scalar
4136** function. The compiled version of the regular expression is stored as
4137** meta-data associated with the SQL value passed as the regular expression
drh6ed48bf2007-06-14 20:57:18 +00004138** pattern. The compiled regular expression can be reused on multiple
4139** invocations of the same function so that the original pattern string
4140** does not need to be recompiled on each invocation.
danielk1977682f68b2004-06-05 10:22:17 +00004141**
drh6ed48bf2007-06-14 20:57:18 +00004142** The sqlite3_get_auxdata() interface returns a pointer to the meta-data
drhf5befa02007-12-06 02:42:07 +00004143** associated by the sqlite3_set_auxdata() function with the Nth argument
4144** value to the application-defined function.
drhafc91042008-02-21 02:09:45 +00004145** If no meta-data has been ever been set for the Nth
shane26b34032008-05-23 17:21:09 +00004146** argument of the function, or if the corresponding function parameter
drhf5befa02007-12-06 02:42:07 +00004147** has changed since the meta-data was set, then sqlite3_get_auxdata()
4148** returns a NULL pointer.
danielk1977682f68b2004-06-05 10:22:17 +00004149**
drhafc91042008-02-21 02:09:45 +00004150** The sqlite3_set_auxdata() interface saves the meta-data
drhf5befa02007-12-06 02:42:07 +00004151** pointed to by its 3rd parameter as the meta-data for the N-th
drhafc91042008-02-21 02:09:45 +00004152** argument of the application-defined function. Subsequent
drhf5befa02007-12-06 02:42:07 +00004153** calls to sqlite3_get_auxdata() might return this data, if it has
4154** not been destroyed.
drhafc91042008-02-21 02:09:45 +00004155** If it is not NULL, SQLite will invoke the destructor
drhf5befa02007-12-06 02:42:07 +00004156** function given by the 4th parameter to sqlite3_set_auxdata() on
4157** the meta-data when the corresponding function parameter changes
drhafc91042008-02-21 02:09:45 +00004158** or when the SQL statement completes, whichever comes first.
4159**
4160** SQLite is free to call the destructor and drop meta-data on
4161** any parameter of any function at any time. The only guarantee
4162** is that the destructor will be called before the metadata is
4163** dropped.
danielk1977682f68b2004-06-05 10:22:17 +00004164**
4165** In practice, meta-data is preserved between function calls for
4166** expressions that are constant at compile time. This includes literal
4167** values and SQL variables.
drhe53831d2007-08-17 01:14:38 +00004168**
drhb21c8cd2007-08-21 19:33:56 +00004169** These routines must be called from the same thread in which
4170** the SQL function is running.
drhafc91042008-02-21 02:09:45 +00004171**
4172** INVARIANTS:
4173**
4174** {F16272} The [sqlite3_get_auxdata(C,N)] interface returns a pointer
4175** to metadata associated with the Nth parameter of the SQL function
4176** whose context is C, or NULL if there is no metadata associated
4177** with that parameter.
4178**
4179** {F16274} The [sqlite3_set_auxdata(C,N,P,D)] interface assigns a metadata
4180** pointer P to the Nth parameter of the SQL function with context
4181** C.
4182**
4183** {F16276} SQLite will invoke the destructor D with a single argument
4184** which is the metadata pointer P following a call to
4185** [sqlite3_set_auxdata(C,N,P,D)] when SQLite ceases to hold
4186** the metadata.
4187**
4188** {F16277} SQLite ceases to hold metadata for an SQL function parameter
4189** when the value of that parameter changes.
4190**
4191** {F16278} When [sqlite3_set_auxdata(C,N,P,D)] is invoked, the destructor
4192** is called for any prior metadata associated with the same function
4193** context C and parameter N.
4194**
4195** {F16279} SQLite will call destructors for any metadata it is holding
4196** in a particular [prepared statement] S when either
4197** [sqlite3_reset(S)] or [sqlite3_finalize(S)] is called.
danielk1977682f68b2004-06-05 10:22:17 +00004198*/
drhf5befa02007-12-06 02:42:07 +00004199void *sqlite3_get_auxdata(sqlite3_context*, int N);
4200void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*));
danielk1977682f68b2004-06-05 10:22:17 +00004201
drha2854222004-06-17 19:04:17 +00004202
4203/*
drhfddfa2d2007-12-05 18:05:16 +00004204** CAPI3REF: Constants Defining Special Destructor Behavior {F10280}
drh6ed48bf2007-06-14 20:57:18 +00004205**
drha2854222004-06-17 19:04:17 +00004206** These are special value for the destructor that is passed in as the
drh6ed48bf2007-06-14 20:57:18 +00004207** final argument to routines like [sqlite3_result_blob()]. If the destructor
drha2854222004-06-17 19:04:17 +00004208** argument is SQLITE_STATIC, it means that the content pointer is constant
4209** and will never change. It does not need to be destroyed. The
4210** SQLITE_TRANSIENT value means that the content will likely change in
4211** the near future and that SQLite should make its own private copy of
4212** the content before returning.
drh6c9121a2007-01-26 00:51:43 +00004213**
4214** The typedef is necessary to work around problems in certain
4215** C++ compilers. See ticket #2191.
drha2854222004-06-17 19:04:17 +00004216*/
drh6c9121a2007-01-26 00:51:43 +00004217typedef void (*sqlite3_destructor_type)(void*);
4218#define SQLITE_STATIC ((sqlite3_destructor_type)0)
4219#define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1)
danielk1977d8123362004-06-12 09:25:12 +00004220
danielk1977682f68b2004-06-05 10:22:17 +00004221/*
drhfddfa2d2007-12-05 18:05:16 +00004222** CAPI3REF: Setting The Result Of An SQL Function {F16400}
drh6ed48bf2007-06-14 20:57:18 +00004223**
4224** These routines are used by the xFunc or xFinal callbacks that
4225** implement SQL functions and aggregates. See
4226** [sqlite3_create_function()] and [sqlite3_create_function16()]
4227** for additional information.
4228**
4229** These functions work very much like the
4230** [sqlite3_bind_blob | sqlite3_bind_*] family of functions used
4231** to bind values to host parameters in prepared statements.
4232** Refer to the
4233** [sqlite3_bind_blob | sqlite3_bind_* documentation] for
4234** additional information.
4235**
drhafc91042008-02-21 02:09:45 +00004236** The sqlite3_result_blob() interface sets the result from
drhf5befa02007-12-06 02:42:07 +00004237** an application defined function to be the BLOB whose content is pointed
4238** to by the second parameter and which is N bytes long where N is the
4239** third parameter.
shane26b34032008-05-23 17:21:09 +00004240** The sqlite3_result_zeroblob() interfaces set the result of
drhf5befa02007-12-06 02:42:07 +00004241** the application defined function to be a BLOB containing all zero
4242** bytes and N bytes in size, where N is the value of the 2nd parameter.
drh6ed48bf2007-06-14 20:57:18 +00004243**
drhafc91042008-02-21 02:09:45 +00004244** The sqlite3_result_double() interface sets the result from
drhf5befa02007-12-06 02:42:07 +00004245** an application defined function to be a floating point value specified
4246** by its 2nd argument.
drhe53831d2007-08-17 01:14:38 +00004247**
drhafc91042008-02-21 02:09:45 +00004248** The sqlite3_result_error() and sqlite3_result_error16() functions
drhf5befa02007-12-06 02:42:07 +00004249** cause the implemented SQL function to throw an exception.
drhafc91042008-02-21 02:09:45 +00004250** SQLite uses the string pointed to by the
drhf5befa02007-12-06 02:42:07 +00004251** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16()
drhafc91042008-02-21 02:09:45 +00004252** as the text of an error message. SQLite interprets the error
4253** message string from sqlite3_result_error() as UTF8. SQLite
drhf5befa02007-12-06 02:42:07 +00004254** interprets the string from sqlite3_result_error16() as UTF16 in native
drhafc91042008-02-21 02:09:45 +00004255** byte order. If the third parameter to sqlite3_result_error()
drhf5befa02007-12-06 02:42:07 +00004256** or sqlite3_result_error16() is negative then SQLite takes as the error
4257** message all text up through the first zero character.
drhafc91042008-02-21 02:09:45 +00004258** If the third parameter to sqlite3_result_error() or
drhf5befa02007-12-06 02:42:07 +00004259** sqlite3_result_error16() is non-negative then SQLite takes that many
4260** bytes (not characters) from the 2nd parameter as the error message.
drhafc91042008-02-21 02:09:45 +00004261** The sqlite3_result_error() and sqlite3_result_error16()
drhf5befa02007-12-06 02:42:07 +00004262** routines make a copy private copy of the error message text before
drhafc91042008-02-21 02:09:45 +00004263** they return. Hence, the calling function can deallocate or
drhf5befa02007-12-06 02:42:07 +00004264** modify the text after they return without harm.
drh69544ec2008-02-06 14:11:34 +00004265** The sqlite3_result_error_code() function changes the error code
4266** returned by SQLite as a result of an error in a function. By default,
drh00e087b2008-04-10 17:14:07 +00004267** the error code is SQLITE_ERROR. A subsequent call to sqlite3_result_error()
4268** or sqlite3_result_error16() resets the error code to SQLITE_ERROR.
drhf5befa02007-12-06 02:42:07 +00004269**
drhafc91042008-02-21 02:09:45 +00004270** The sqlite3_result_toobig() interface causes SQLite
drhf5befa02007-12-06 02:42:07 +00004271** to throw an error indicating that a string or BLOB is to long
drhafc91042008-02-21 02:09:45 +00004272** to represent. The sqlite3_result_nomem() interface
drhf5befa02007-12-06 02:42:07 +00004273** causes SQLite to throw an exception indicating that the a
4274** memory allocation failed.
4275**
drhafc91042008-02-21 02:09:45 +00004276** The sqlite3_result_int() interface sets the return value
drhf5befa02007-12-06 02:42:07 +00004277** of the application-defined function to be the 32-bit signed integer
4278** value given in the 2nd argument.
drhafc91042008-02-21 02:09:45 +00004279** The sqlite3_result_int64() interface sets the return value
drhf5befa02007-12-06 02:42:07 +00004280** of the application-defined function to be the 64-bit signed integer
4281** value given in the 2nd argument.
4282**
drhafc91042008-02-21 02:09:45 +00004283** The sqlite3_result_null() interface sets the return value
drhf5befa02007-12-06 02:42:07 +00004284** of the application-defined function to be NULL.
4285**
drhafc91042008-02-21 02:09:45 +00004286** The sqlite3_result_text(), sqlite3_result_text16(),
drhf5befa02007-12-06 02:42:07 +00004287** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces
4288** set the return value of the application-defined function to be
4289** a text string which is represented as UTF-8, UTF-16 native byte order,
4290** UTF-16 little endian, or UTF-16 big endian, respectively.
drhafc91042008-02-21 02:09:45 +00004291** SQLite takes the text result from the application from
drhf5befa02007-12-06 02:42:07 +00004292** the 2nd parameter of the sqlite3_result_text* interfaces.
drhafc91042008-02-21 02:09:45 +00004293** If the 3rd parameter to the sqlite3_result_text* interfaces
drhf5befa02007-12-06 02:42:07 +00004294** is negative, then SQLite takes result text from the 2nd parameter
4295** through the first zero character.
drhafc91042008-02-21 02:09:45 +00004296** If the 3rd parameter to the sqlite3_result_text* interfaces
drhf5befa02007-12-06 02:42:07 +00004297** is non-negative, then as many bytes (not characters) of the text
4298** pointed to by the 2nd parameter are taken as the application-defined
4299** function result.
drhafc91042008-02-21 02:09:45 +00004300** If the 4th parameter to the sqlite3_result_text* interfaces
drhf5befa02007-12-06 02:42:07 +00004301** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that
4302** function as the destructor on the text or blob result when it has
4303** finished using that result.
drhafc91042008-02-21 02:09:45 +00004304** If the 4th parameter to the sqlite3_result_text* interfaces
drhf5befa02007-12-06 02:42:07 +00004305** or sqlite3_result_blob is the special constant SQLITE_STATIC, then
4306** SQLite assumes that the text or blob result is constant space and
4307** does not copy the space or call a destructor when it has
4308** finished using that result.
drhafc91042008-02-21 02:09:45 +00004309** If the 4th parameter to the sqlite3_result_text* interfaces
drhf5befa02007-12-06 02:42:07 +00004310** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT
4311** then SQLite makes a copy of the result into space obtained from
4312** from [sqlite3_malloc()] before it returns.
4313**
drhafc91042008-02-21 02:09:45 +00004314** The sqlite3_result_value() interface sets the result of
drhaa28e142008-03-18 13:47:20 +00004315** the application-defined function to be a copy the
4316** [unprotected sqlite3_value] object specified by the 2nd parameter. The
drhf5befa02007-12-06 02:42:07 +00004317** sqlite3_result_value() interface makes a copy of the [sqlite3_value]
4318** so that [sqlite3_value] specified in the parameter may change or
4319** be deallocated after sqlite3_result_value() returns without harm.
drhaa28e142008-03-18 13:47:20 +00004320** A [protected sqlite3_value] object may always be used where an
4321** [unprotected sqlite3_value] object is required, so either
4322** kind of [sqlite3_value] object can be used with this interface.
drhf5befa02007-12-06 02:42:07 +00004323**
drhafc91042008-02-21 02:09:45 +00004324** If these routines are called from within the different thread
shane26b34032008-05-23 17:21:09 +00004325** than the one containing the application-defined function that received
drhf5befa02007-12-06 02:42:07 +00004326** the [sqlite3_context] pointer, the results are undefined.
drhafc91042008-02-21 02:09:45 +00004327**
4328** INVARIANTS:
4329**
4330** {F16403} The default return value from any SQL function is NULL.
4331**
4332** {F16406} The [sqlite3_result_blob(C,V,N,D)] interface changes the
4333** return value of function C to be a blob that is N bytes
4334** in length and with content pointed to by V.
4335**
4336** {F16409} The [sqlite3_result_double(C,V)] interface changes the
4337** return value of function C to be the floating point value V.
4338**
4339** {F16412} The [sqlite3_result_error(C,V,N)] interface changes the return
4340** value of function C to be an exception with error code
4341** [SQLITE_ERROR] and a UTF8 error message copied from V up to the
4342** first zero byte or until N bytes are read if N is positive.
4343**
4344** {F16415} The [sqlite3_result_error16(C,V,N)] interface changes the return
4345** value of function C to be an exception with error code
4346** [SQLITE_ERROR] and a UTF16 native byte order error message
4347** copied from V up to the first zero terminator or until N bytes
4348** are read if N is positive.
4349**
4350** {F16418} The [sqlite3_result_error_toobig(C)] interface changes the return
4351** value of the function C to be an exception with error code
4352** [SQLITE_TOOBIG] and an appropriate error message.
4353**
4354** {F16421} The [sqlite3_result_error_nomem(C)] interface changes the return
4355** value of the function C to be an exception with error code
4356** [SQLITE_NOMEM] and an appropriate error message.
4357**
4358** {F16424} The [sqlite3_result_error_code(C,E)] interface changes the return
4359** value of the function C to be an exception with error code E.
4360** The error message text is unchanged.
4361**
4362** {F16427} The [sqlite3_result_int(C,V)] interface changes the
4363** return value of function C to be the 32-bit integer value V.
4364**
4365** {F16430} The [sqlite3_result_int64(C,V)] interface changes the
4366** return value of function C to be the 64-bit integer value V.
4367**
4368** {F16433} The [sqlite3_result_null(C)] interface changes the
4369** return value of function C to be NULL.
4370**
4371** {F16436} The [sqlite3_result_text(C,V,N,D)] interface changes the
4372** return value of function C to be the UTF8 string
drha95174b2008-04-17 17:03:25 +00004373** V up to the first zero if N is negative
drhb08c2a72008-04-16 00:28:13 +00004374** or the first N bytes of V if N is non-negative.
drhafc91042008-02-21 02:09:45 +00004375**
4376** {F16439} The [sqlite3_result_text16(C,V,N,D)] interface changes the
4377** return value of function C to be the UTF16 native byte order
drhb08c2a72008-04-16 00:28:13 +00004378** string V up to the first zero if N is
4379** negative or the first N bytes of V if N is non-negative.
drhafc91042008-02-21 02:09:45 +00004380**
4381** {F16442} The [sqlite3_result_text16be(C,V,N,D)] interface changes the
4382** return value of function C to be the UTF16 big-endian
drhb08c2a72008-04-16 00:28:13 +00004383** string V up to the first zero if N is
4384** is negative or the first N bytes or V if N is non-negative.
drhafc91042008-02-21 02:09:45 +00004385**
4386** {F16445} The [sqlite3_result_text16le(C,V,N,D)] interface changes the
4387** return value of function C to be the UTF16 little-endian
drhb08c2a72008-04-16 00:28:13 +00004388** string V up to the first zero if N is
4389** negative or the first N bytes of V if N is non-negative.
drhafc91042008-02-21 02:09:45 +00004390**
4391** {F16448} The [sqlite3_result_value(C,V)] interface changes the
drhaa28e142008-03-18 13:47:20 +00004392** return value of function C to be [unprotected sqlite3_value]
4393** object V.
drhafc91042008-02-21 02:09:45 +00004394**
4395** {F16451} The [sqlite3_result_zeroblob(C,N)] interface changes the
4396** return value of function C to be an N-byte blob of all zeros.
4397**
4398** {F16454} The [sqlite3_result_error()] and [sqlite3_result_error16()]
4399** interfaces make a copy of their error message strings before
4400** returning.
4401**
4402** {F16457} If the D destructor parameter to [sqlite3_result_blob(C,V,N,D)],
4403** [sqlite3_result_text(C,V,N,D)], [sqlite3_result_text16(C,V,N,D)],
4404** [sqlite3_result_text16be(C,V,N,D)], or
4405** [sqlite3_result_text16le(C,V,N,D)] is the constant [SQLITE_STATIC]
4406** then no destructor is ever called on the pointer V and SQLite
4407** assumes that V is immutable.
4408**
4409** {F16460} If the D destructor parameter to [sqlite3_result_blob(C,V,N,D)],
4410** [sqlite3_result_text(C,V,N,D)], [sqlite3_result_text16(C,V,N,D)],
4411** [sqlite3_result_text16be(C,V,N,D)], or
4412** [sqlite3_result_text16le(C,V,N,D)] is the constant
4413** [SQLITE_TRANSIENT] then the interfaces makes a copy of the
4414** content of V and retains the copy.
4415**
4416** {F16463} If the D destructor parameter to [sqlite3_result_blob(C,V,N,D)],
4417** [sqlite3_result_text(C,V,N,D)], [sqlite3_result_text16(C,V,N,D)],
4418** [sqlite3_result_text16be(C,V,N,D)], or
4419** [sqlite3_result_text16le(C,V,N,D)] is some value other than
4420** the constants [SQLITE_STATIC] and [SQLITE_TRANSIENT] then
4421** SQLite will invoke the destructor D with V as its only argument
4422** when it has finished with the V value.
danielk19777e18c252004-05-25 11:47:24 +00004423*/
danielk1977d8123362004-06-12 09:25:12 +00004424void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*));
drh4f26d6c2004-05-26 23:25:30 +00004425void sqlite3_result_double(sqlite3_context*, double);
danielk19777e18c252004-05-25 11:47:24 +00004426void sqlite3_result_error(sqlite3_context*, const char*, int);
4427void sqlite3_result_error16(sqlite3_context*, const void*, int);
drh6ed48bf2007-06-14 20:57:18 +00004428void sqlite3_result_error_toobig(sqlite3_context*);
danielk1977a1644fd2007-08-29 12:31:25 +00004429void sqlite3_result_error_nomem(sqlite3_context*);
drh69544ec2008-02-06 14:11:34 +00004430void sqlite3_result_error_code(sqlite3_context*, int);
drh4f26d6c2004-05-26 23:25:30 +00004431void sqlite3_result_int(sqlite3_context*, int);
drh6d2069d2007-08-14 01:58:53 +00004432void sqlite3_result_int64(sqlite3_context*, sqlite3_int64);
drh4f26d6c2004-05-26 23:25:30 +00004433void sqlite3_result_null(sqlite3_context*);
danielk1977d8123362004-06-12 09:25:12 +00004434void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*));
4435void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*));
4436void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*));
4437void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*));
drh4f26d6c2004-05-26 23:25:30 +00004438void sqlite3_result_value(sqlite3_context*, sqlite3_value*);
drhb026e052007-05-02 01:34:31 +00004439void sqlite3_result_zeroblob(sqlite3_context*, int n);
drhf9b596e2004-05-26 16:54:42 +00004440
drh52619df2004-06-11 17:48:02 +00004441/*
drhfddfa2d2007-12-05 18:05:16 +00004442** CAPI3REF: Define New Collating Sequences {F16600}
drh6ed48bf2007-06-14 20:57:18 +00004443**
4444** These functions are used to add new collation sequences to the
4445** [sqlite3*] handle specified as the first argument.
danielk19777cedc8d2004-06-10 10:50:08 +00004446**
4447** The name of the new collation sequence is specified as a UTF-8 string
drh6ed48bf2007-06-14 20:57:18 +00004448** for sqlite3_create_collation() and sqlite3_create_collation_v2()
drhafc91042008-02-21 02:09:45 +00004449** and a UTF-16 string for sqlite3_create_collation16(). In all cases
drh6ed48bf2007-06-14 20:57:18 +00004450** the name is passed as the second function argument.
danielk19777cedc8d2004-06-10 10:50:08 +00004451**
drh4145f832007-10-12 18:30:12 +00004452** The third argument may be one of the constants [SQLITE_UTF8],
drh6ed48bf2007-06-14 20:57:18 +00004453** [SQLITE_UTF16LE] or [SQLITE_UTF16BE], indicating that the user-supplied
danielk19777cedc8d2004-06-10 10:50:08 +00004454** routine expects to be passed pointers to strings encoded using UTF-8,
drhafc91042008-02-21 02:09:45 +00004455** UTF-16 little-endian or UTF-16 big-endian respectively. The
drh4145f832007-10-12 18:30:12 +00004456** third argument might also be [SQLITE_UTF16_ALIGNED] to indicate that
4457** the routine expects pointers to 16-bit word aligned strings
4458** of UTF16 in the native byte order of the host computer.
danielk19777cedc8d2004-06-10 10:50:08 +00004459**
4460** A pointer to the user supplied routine must be passed as the fifth
drhafc91042008-02-21 02:09:45 +00004461** argument. If it is NULL, this is the same as deleting the collation
drhf5befa02007-12-06 02:42:07 +00004462** sequence (so that SQLite cannot call it anymore).
drhafc91042008-02-21 02:09:45 +00004463** Each time the application
danielk19777cedc8d2004-06-10 10:50:08 +00004464** supplied function is invoked, it is passed a copy of the void* passed as
4465** the fourth argument to sqlite3_create_collation() or
4466** sqlite3_create_collation16() as its first parameter.
4467**
drhf5befa02007-12-06 02:42:07 +00004468** The remaining arguments to the application-supplied routine are two strings,
drh33c1be32008-01-30 16:16:14 +00004469** each represented by a (length, data) pair and encoded in the encoding
danielk19777cedc8d2004-06-10 10:50:08 +00004470** that was passed as the third argument when the collation sequence was
drhf5befa02007-12-06 02:42:07 +00004471** registered. {END} The application defined collation routine should
4472** return negative, zero or positive if
danielk19777cedc8d2004-06-10 10:50:08 +00004473** the first string is less than, equal to, or greater than the second
4474** string. i.e. (STRING1 - STRING2).
drh6ed48bf2007-06-14 20:57:18 +00004475**
4476** The sqlite3_create_collation_v2() works like sqlite3_create_collation()
shane26b34032008-05-23 17:21:09 +00004477** except that it takes an extra argument which is a destructor for
drhafc91042008-02-21 02:09:45 +00004478** the collation. The destructor is called when the collation is
drh6ed48bf2007-06-14 20:57:18 +00004479** destroyed and is passed a copy of the fourth parameter void* pointer
drhf5befa02007-12-06 02:42:07 +00004480** of the sqlite3_create_collation_v2().
drhafc91042008-02-21 02:09:45 +00004481** Collations are destroyed when
drh6ed48bf2007-06-14 20:57:18 +00004482** they are overridden by later calls to the collation creation functions
4483** or when the [sqlite3*] database handle is closed using [sqlite3_close()].
drhafc91042008-02-21 02:09:45 +00004484**
4485** INVARIANTS:
4486**
4487** {F16603} A successful call to the
4488** [sqlite3_create_collation_v2(B,X,E,P,F,D)] interface
4489** registers function F as the comparison function used to
4490** implement collation X on [database connection] B for
4491** databases having encoding E.
4492**
4493** {F16604} SQLite understands the X parameter to
4494** [sqlite3_create_collation_v2(B,X,E,P,F,D)] as a zero-terminated
4495** UTF-8 string in which case is ignored for ASCII characters and
4496** is significant for non-ASCII characters.
4497**
4498** {F16606} Successive calls to [sqlite3_create_collation_v2(B,X,E,P,F,D)]
4499** with the same values for B, X, and E, override prior values
4500** of P, F, and D.
4501**
4502** {F16609} The destructor D in [sqlite3_create_collation_v2(B,X,E,P,F,D)]
4503** is not NULL then it is called with argument P when the
4504** collating function is dropped by SQLite.
4505**
4506** {F16612} A collating function is dropped when it is overloaded.
4507**
4508** {F16615} A collating function is dropped when the database connection
4509** is closed using [sqlite3_close()].
4510**
4511** {F16618} The pointer P in [sqlite3_create_collation_v2(B,X,E,P,F,D)]
4512** is passed through as the first parameter to the comparison
4513** function F for all subsequent invocations of F.
4514**
4515** {F16621} A call to [sqlite3_create_collation(B,X,E,P,F)] is exactly
4516** the same as a call to [sqlite3_create_collation_v2()] with
4517** the same parameters and a NULL destructor.
4518**
4519** {F16624} Following a [sqlite3_create_collation_v2(B,X,E,P,F,D)],
4520** SQLite uses the comparison function F for all text comparison
4521** operations on [database connection] B on text values that
4522** use the collating sequence name X.
4523**
4524** {F16627} The [sqlite3_create_collation16(B,X,E,P,F)] works the same
4525** as [sqlite3_create_collation(B,X,E,P,F)] except that the
4526** collation name X is understood as UTF-16 in native byte order
4527** instead of UTF-8.
4528**
4529** {F16630} When multiple comparison functions are available for the same
4530** collating sequence, SQLite chooses the one whose text encoding
4531** requires the least amount of conversion from the default
4532** text encoding of the database.
danielk19777cedc8d2004-06-10 10:50:08 +00004533*/
danielk19770202b292004-06-09 09:55:16 +00004534int sqlite3_create_collation(
4535 sqlite3*,
4536 const char *zName,
danielk19777cedc8d2004-06-10 10:50:08 +00004537 int eTextRep,
danielk19770202b292004-06-09 09:55:16 +00004538 void*,
4539 int(*xCompare)(void*,int,const void*,int,const void*)
4540);
drh6ed48bf2007-06-14 20:57:18 +00004541int sqlite3_create_collation_v2(
4542 sqlite3*,
4543 const char *zName,
4544 int eTextRep,
4545 void*,
4546 int(*xCompare)(void*,int,const void*,int,const void*),
4547 void(*xDestroy)(void*)
4548);
danielk19770202b292004-06-09 09:55:16 +00004549int sqlite3_create_collation16(
4550 sqlite3*,
4551 const char *zName,
danielk19777cedc8d2004-06-10 10:50:08 +00004552 int eTextRep,
danielk19770202b292004-06-09 09:55:16 +00004553 void*,
4554 int(*xCompare)(void*,int,const void*,int,const void*)
4555);
4556
danielk19777cedc8d2004-06-10 10:50:08 +00004557/*
drhfddfa2d2007-12-05 18:05:16 +00004558** CAPI3REF: Collation Needed Callbacks {F16700}
danielk1977a393c032007-05-07 14:58:53 +00004559**
danielk19777cedc8d2004-06-10 10:50:08 +00004560** To avoid having to register all collation sequences before a database
4561** can be used, a single callback function may be registered with the
4562** database handle to be called whenever an undefined collation sequence is
4563** required.
4564**
4565** If the function is registered using the sqlite3_collation_needed() API,
4566** then it is passed the names of undefined collation sequences as strings
drhf5befa02007-12-06 02:42:07 +00004567** encoded in UTF-8. {F16703} If sqlite3_collation_needed16() is used, the names
drhafc91042008-02-21 02:09:45 +00004568** are passed as UTF-16 in machine native byte order. A call to either
danielk19777cedc8d2004-06-10 10:50:08 +00004569** function replaces any existing callback.
4570**
drhafc91042008-02-21 02:09:45 +00004571** When the callback is invoked, the first argument passed is a copy
danielk19777cedc8d2004-06-10 10:50:08 +00004572** of the second argument to sqlite3_collation_needed() or
drhafc91042008-02-21 02:09:45 +00004573** sqlite3_collation_needed16(). The second argument is the database
4574** handle. The third argument is one of [SQLITE_UTF8],
drhf5befa02007-12-06 02:42:07 +00004575** [SQLITE_UTF16BE], or [SQLITE_UTF16LE], indicating the most
4576** desirable form of the collation sequence function required.
drhafc91042008-02-21 02:09:45 +00004577** The fourth parameter is the name of the
4578** required collation sequence.
danielk19777cedc8d2004-06-10 10:50:08 +00004579**
drh6ed48bf2007-06-14 20:57:18 +00004580** The callback function should register the desired collation using
4581** [sqlite3_create_collation()], [sqlite3_create_collation16()], or
4582** [sqlite3_create_collation_v2()].
drhafc91042008-02-21 02:09:45 +00004583**
4584** INVARIANTS:
4585**
4586** {F16702} A successful call to [sqlite3_collation_needed(D,P,F)]
4587** or [sqlite3_collation_needed16(D,P,F)] causes
4588** the [database connection] D to invoke callback F with first
4589** parameter P whenever it needs a comparison function for a
4590** collating sequence that it does not know about.
4591**
4592** {F16704} Each successful call to [sqlite3_collation_needed()] or
4593** [sqlite3_collation_needed16()] overrides the callback registered
4594** on the same [database connection] by prior calls to either
4595** interface.
4596**
4597** {F16706} The name of the requested collating function passed in the
4598** 4th parameter to the callback is in UTF-8 if the callback
4599** was registered using [sqlite3_collation_needed()] and
4600** is in UTF-16 native byte order if the callback was
4601** registered using [sqlite3_collation_needed16()].
4602**
4603**
danielk19777cedc8d2004-06-10 10:50:08 +00004604*/
4605int sqlite3_collation_needed(
4606 sqlite3*,
4607 void*,
4608 void(*)(void*,sqlite3*,int eTextRep,const char*)
4609);
4610int sqlite3_collation_needed16(
4611 sqlite3*,
4612 void*,
4613 void(*)(void*,sqlite3*,int eTextRep,const void*)
4614);
4615
drh2011d5f2004-07-22 02:40:37 +00004616/*
4617** Specify the key for an encrypted database. This routine should be
4618** called right after sqlite3_open().
4619**
4620** The code to implement this API is not available in the public release
4621** of SQLite.
4622*/
4623int sqlite3_key(
4624 sqlite3 *db, /* Database to be rekeyed */
4625 const void *pKey, int nKey /* The key */
4626);
4627
4628/*
4629** Change the key on an open database. If the current database is not
4630** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the
4631** database is decrypted.
4632**
4633** The code to implement this API is not available in the public release
4634** of SQLite.
4635*/
4636int sqlite3_rekey(
4637 sqlite3 *db, /* Database to be rekeyed */
4638 const void *pKey, int nKey /* The new key */
4639);
danielk19770202b292004-06-09 09:55:16 +00004640
drhab3f9fe2004-08-14 17:10:10 +00004641/*
drhfddfa2d2007-12-05 18:05:16 +00004642** CAPI3REF: Suspend Execution For A Short Time {F10530}
drh6ed48bf2007-06-14 20:57:18 +00004643**
drhafc91042008-02-21 02:09:45 +00004644** The sqlite3_sleep() function
drhf5befa02007-12-06 02:42:07 +00004645** causes the current thread to suspend execution
drhfddfa2d2007-12-05 18:05:16 +00004646** for at least a number of milliseconds specified in its parameter.
danielk1977600dd0b2005-01-20 01:14:23 +00004647**
drhafc91042008-02-21 02:09:45 +00004648** If the operating system does not support sleep requests with
drh6ed48bf2007-06-14 20:57:18 +00004649** millisecond time resolution, then the time will be rounded up to
drhafc91042008-02-21 02:09:45 +00004650** the nearest second. The number of milliseconds of sleep actually
danielk1977600dd0b2005-01-20 01:14:23 +00004651** requested from the operating system is returned.
drh8bacf972007-08-25 16:21:29 +00004652**
drhafc91042008-02-21 02:09:45 +00004653** SQLite implements this interface by calling the xSleep()
4654** method of the default [sqlite3_vfs] object.
4655**
4656** INVARIANTS:
4657**
4658** {F10533} The [sqlite3_sleep(M)] interface invokes the xSleep
4659** method of the default [sqlite3_vfs|VFS] in order to
4660** suspend execution of the current thread for at least
4661** M milliseconds.
4662**
4663** {F10536} The [sqlite3_sleep(M)] interface returns the number of
4664** milliseconds of sleep actually requested of the operating
4665** system, which might be larger than the parameter M.
danielk1977600dd0b2005-01-20 01:14:23 +00004666*/
4667int sqlite3_sleep(int);
4668
4669/*
drhfddfa2d2007-12-05 18:05:16 +00004670** CAPI3REF: Name Of The Folder Holding Temporary Files {F10310}
drhd89bd002005-01-22 03:03:54 +00004671**
drh6ed48bf2007-06-14 20:57:18 +00004672** If this global variable is made to point to a string which is
shane26b34032008-05-23 17:21:09 +00004673** the name of a folder (a.k.a. directory), then all temporary files
drhab3f9fe2004-08-14 17:10:10 +00004674** created by SQLite will be placed in that directory. If this variable
4675** is NULL pointer, then SQLite does a search for an appropriate temporary
4676** file directory.
4677**
drh4ff7fa02007-09-01 18:17:21 +00004678** It is not safe to modify this variable once a database connection
4679** has been opened. It is intended that this variable be set once
4680** as part of process initialization and before any SQLite interface
4681** routines have been call and remain unchanged thereafter.
drhab3f9fe2004-08-14 17:10:10 +00004682*/
drh73be5012007-08-08 12:11:21 +00004683SQLITE_EXTERN char *sqlite3_temp_directory;
drhab3f9fe2004-08-14 17:10:10 +00004684
danielk19776b456a22005-03-21 04:04:02 +00004685/*
drhfddfa2d2007-12-05 18:05:16 +00004686** CAPI3REF: Test To See If The Database Is In Auto-Commit Mode {F12930}
danielk19776b456a22005-03-21 04:04:02 +00004687**
shane26b34032008-05-23 17:21:09 +00004688** The sqlite3_get_autocommit() interface returns non-zero or
drhf5befa02007-12-06 02:42:07 +00004689** zero if the given database connection is or is not in autocommit mode,
drh33c1be32008-01-30 16:16:14 +00004690** respectively. Autocommit mode is on
4691** by default. Autocommit mode is disabled by a [BEGIN] statement.
shane26b34032008-05-23 17:21:09 +00004692** Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK].
drhe30f4422007-08-21 16:15:55 +00004693**
drh7c3472a2007-10-03 20:15:28 +00004694** If certain kinds of errors occur on a statement within a multi-statement
4695** transactions (errors including [SQLITE_FULL], [SQLITE_IOERR],
4696** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the
drh33c1be32008-01-30 16:16:14 +00004697** transaction might be rolled back automatically. The only way to
drh7c3472a2007-10-03 20:15:28 +00004698** find out if SQLite automatically rolled back the transaction after
drh33c1be32008-01-30 16:16:14 +00004699** an error is to use this function.
drh7c3472a2007-10-03 20:15:28 +00004700**
drh33c1be32008-01-30 16:16:14 +00004701** INVARIANTS:
4702**
drhafc91042008-02-21 02:09:45 +00004703** {F12931} The [sqlite3_get_autocommit(D)] interface returns non-zero or
4704** zero if the [database connection] D is or is not in autocommit
drh33c1be32008-01-30 16:16:14 +00004705** mode, respectively.
4706**
4707** {F12932} Autocommit mode is on by default.
4708**
4709** {F12933} Autocommit mode is disabled by a successful [BEGIN] statement.
4710**
4711** {F12934} Autocommit mode is enabled by a successful [COMMIT] or [ROLLBACK]
4712** statement.
4713**
4714**
4715** LIMITATIONS:
4716***
drhf5befa02007-12-06 02:42:07 +00004717** {U12936} If another thread changes the autocommit status of the database
drh33c1be32008-01-30 16:16:14 +00004718** connection while this routine is running, then the return value
4719** is undefined.
drh3e1d8e62005-05-26 16:23:34 +00004720*/
4721int sqlite3_get_autocommit(sqlite3*);
4722
drh51942bc2005-06-12 22:01:42 +00004723/*
drhfddfa2d2007-12-05 18:05:16 +00004724** CAPI3REF: Find The Database Handle Of A Prepared Statement {F13120}
drh6ed48bf2007-06-14 20:57:18 +00004725**
drhafc91042008-02-21 02:09:45 +00004726** The sqlite3_db_handle interface
drhf5befa02007-12-06 02:42:07 +00004727** returns the [sqlite3*] database handle to which a
drh33c1be32008-01-30 16:16:14 +00004728** [prepared statement] belongs.
drhafc91042008-02-21 02:09:45 +00004729** The database handle returned by sqlite3_db_handle
drhf5befa02007-12-06 02:42:07 +00004730** is the same database handle that was
drh6ed48bf2007-06-14 20:57:18 +00004731** the first argument to the [sqlite3_prepare_v2()] or its variants
4732** that was used to create the statement in the first place.
drhafc91042008-02-21 02:09:45 +00004733**
4734** INVARIANTS:
4735**
4736** {F13123} The [sqlite3_db_handle(S)] interface returns a pointer
4737** to the [database connection] associated with
4738** [prepared statement] S.
drh51942bc2005-06-12 22:01:42 +00004739*/
4740sqlite3 *sqlite3_db_handle(sqlite3_stmt*);
drh3e1d8e62005-05-26 16:23:34 +00004741
drh6ed48bf2007-06-14 20:57:18 +00004742
drhb37df7b2005-10-13 02:09:49 +00004743/*
drhfddfa2d2007-12-05 18:05:16 +00004744** CAPI3REF: Commit And Rollback Notification Callbacks {F12950}
drh6ed48bf2007-06-14 20:57:18 +00004745**
drhafc91042008-02-21 02:09:45 +00004746** The sqlite3_commit_hook() interface registers a callback
drhf5befa02007-12-06 02:42:07 +00004747** function to be invoked whenever a transaction is committed.
drhafc91042008-02-21 02:09:45 +00004748** Any callback set by a previous call to sqlite3_commit_hook()
drhf5befa02007-12-06 02:42:07 +00004749** for the same database connection is overridden.
drhafc91042008-02-21 02:09:45 +00004750** The sqlite3_rollback_hook() interface registers a callback
drhf5befa02007-12-06 02:42:07 +00004751** function to be invoked whenever a transaction is committed.
drhafc91042008-02-21 02:09:45 +00004752** Any callback set by a previous call to sqlite3_commit_hook()
drhf5befa02007-12-06 02:42:07 +00004753** for the same database connection is overridden.
drhafc91042008-02-21 02:09:45 +00004754** The pArg argument is passed through
4755** to the callback. If the callback on a commit hook function
drh6ed48bf2007-06-14 20:57:18 +00004756** returns non-zero, then the commit is converted into a rollback.
4757**
drhafc91042008-02-21 02:09:45 +00004758** If another function was previously registered, its
drhf5befa02007-12-06 02:42:07 +00004759** pArg value is returned. Otherwise NULL is returned.
drh6ed48bf2007-06-14 20:57:18 +00004760**
drhafc91042008-02-21 02:09:45 +00004761** Registering a NULL function disables the callback.
drh6ed48bf2007-06-14 20:57:18 +00004762**
drhafc91042008-02-21 02:09:45 +00004763** For the purposes of this API, a transaction is said to have been
drh6ed48bf2007-06-14 20:57:18 +00004764** rolled back if an explicit "ROLLBACK" statement is executed, or
drhf5befa02007-12-06 02:42:07 +00004765** an error or constraint causes an implicit rollback to occur.
drhafc91042008-02-21 02:09:45 +00004766** The rollback callback is not invoked if a transaction is
drhf5befa02007-12-06 02:42:07 +00004767** automatically rolled back because the database connection is closed.
drhafc91042008-02-21 02:09:45 +00004768** The rollback callback is not invoked if a transaction is
drhf5befa02007-12-06 02:42:07 +00004769** rolled back because a commit callback returned non-zero.
drhafc91042008-02-21 02:09:45 +00004770** <todo> Check on this </todo>
drh6ed48bf2007-06-14 20:57:18 +00004771**
4772** These are experimental interfaces and are subject to change.
drhafc91042008-02-21 02:09:45 +00004773**
4774** INVARIANTS:
4775**
4776** {F12951} The [sqlite3_commit_hook(D,F,P)] interface registers the
4777** callback function F to be invoked with argument P whenever
4778** a transaction commits on [database connection] D.
4779**
4780** {F12952} The [sqlite3_commit_hook(D,F,P)] interface returns the P
4781** argument from the previous call with the same
4782** [database connection ] D , or NULL on the first call
4783** for a particular [database connection] D.
4784**
4785** {F12953} Each call to [sqlite3_commit_hook()] overwrites the callback
4786** registered by prior calls.
4787**
4788** {F12954} If the F argument to [sqlite3_commit_hook(D,F,P)] is NULL
shane236ce972008-05-30 15:35:30 +00004789** then the commit hook callback is canceled and no callback
drhafc91042008-02-21 02:09:45 +00004790** is invoked when a transaction commits.
4791**
4792** {F12955} If the commit callback returns non-zero then the commit is
4793** converted into a rollback.
4794**
4795** {F12961} The [sqlite3_rollback_hook(D,F,P)] interface registers the
4796** callback function F to be invoked with argument P whenever
4797** a transaction rolls back on [database connection] D.
4798**
4799** {F12962} The [sqlite3_rollback_hook(D,F,P)] interface returns the P
4800** argument from the previous call with the same
4801** [database connection ] D , or NULL on the first call
4802** for a particular [database connection] D.
4803**
4804** {F12963} Each call to [sqlite3_rollback_hook()] overwrites the callback
4805** registered by prior calls.
4806**
4807** {F12964} If the F argument to [sqlite3_rollback_hook(D,F,P)] is NULL
shane236ce972008-05-30 15:35:30 +00004808** then the rollback hook callback is canceled and no callback
drhafc91042008-02-21 02:09:45 +00004809** is invoked when a transaction rolls back.
drh6ed48bf2007-06-14 20:57:18 +00004810*/
4811void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
4812void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);
4813
4814/*
drhfddfa2d2007-12-05 18:05:16 +00004815** CAPI3REF: Data Change Notification Callbacks {F12970}
drh6ed48bf2007-06-14 20:57:18 +00004816**
drhafc91042008-02-21 02:09:45 +00004817** The sqlite3_update_hook() interface
drhf5befa02007-12-06 02:42:07 +00004818** registers a callback function with the database connection identified by the
danielk197794eb6a12005-12-15 15:22:08 +00004819** first argument to be invoked whenever a row is updated, inserted or deleted.
drhafc91042008-02-21 02:09:45 +00004820** Any callback set by a previous call to this function for the same
danielk197794eb6a12005-12-15 15:22:08 +00004821** database connection is overridden.
4822**
drhafc91042008-02-21 02:09:45 +00004823** The second argument is a pointer to the function to invoke when a
drhf5befa02007-12-06 02:42:07 +00004824** row is updated, inserted or deleted.
drhafc91042008-02-21 02:09:45 +00004825** The first argument to the callback is
drhf5befa02007-12-06 02:42:07 +00004826** a copy of the third argument to sqlite3_update_hook().
drhafc91042008-02-21 02:09:45 +00004827** The second callback
drhf5befa02007-12-06 02:42:07 +00004828** argument is one of [SQLITE_INSERT], [SQLITE_DELETE] or [SQLITE_UPDATE],
4829** depending on the operation that caused the callback to be invoked.
drhafc91042008-02-21 02:09:45 +00004830** The third and
danielk197794eb6a12005-12-15 15:22:08 +00004831** fourth arguments to the callback contain pointers to the database and
drhf5befa02007-12-06 02:42:07 +00004832** table name containing the affected row.
drhafc91042008-02-21 02:09:45 +00004833** The final callback parameter is
drhf5befa02007-12-06 02:42:07 +00004834** the rowid of the row.
drhafc91042008-02-21 02:09:45 +00004835** In the case of an update, this is the rowid after
danielk197794eb6a12005-12-15 15:22:08 +00004836** the update takes place.
4837**
drhafc91042008-02-21 02:09:45 +00004838** The update hook is not invoked when internal system tables are
danielk197794eb6a12005-12-15 15:22:08 +00004839** modified (i.e. sqlite_master and sqlite_sequence).
danielk197771fd80b2005-12-16 06:54:01 +00004840**
drhafc91042008-02-21 02:09:45 +00004841** If another function was previously registered, its pArg value
4842** is returned. Otherwise NULL is returned.
4843**
4844** INVARIANTS:
4845**
4846** {F12971} The [sqlite3_update_hook(D,F,P)] interface causes callback
4847** function F to be invoked with first parameter P whenever
4848** a table row is modified, inserted, or deleted on
4849** [database connection] D.
4850**
4851** {F12973} The [sqlite3_update_hook(D,F,P)] interface returns the value
4852** of P for the previous call on the same [database connection] D,
4853** or NULL for the first call.
4854**
4855** {F12975} If the update hook callback F in [sqlite3_update_hook(D,F,P)]
4856** is NULL then the no update callbacks are made.
4857**
4858** {F12977} Each call to [sqlite3_update_hook(D,F,P)] overrides prior calls
4859** to the same interface on the same [database connection] D.
4860**
4861** {F12979} The update hook callback is not invoked when internal system
4862** tables such as sqlite_master and sqlite_sequence are modified.
4863**
4864** {F12981} The second parameter to the update callback
4865** is one of [SQLITE_INSERT], [SQLITE_DELETE] or [SQLITE_UPDATE],
4866** depending on the operation that caused the callback to be invoked.
4867**
4868** {F12983} The third and fourth arguments to the callback contain pointers
4869** to zero-terminated UTF-8 strings which are the names of the
4870** database and table that is being updated.
4871
4872** {F12985} The final callback parameter is the rowid of the row after
4873** the change occurs.
danielk197794eb6a12005-12-15 15:22:08 +00004874*/
danielk197771fd80b2005-12-16 06:54:01 +00004875void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00004876 sqlite3*,
drh6d2069d2007-08-14 01:58:53 +00004877 void(*)(void *,int ,char const *,char const *,sqlite3_int64),
danielk197794eb6a12005-12-15 15:22:08 +00004878 void*
4879);
danielk197713a68c32005-12-15 10:11:30 +00004880
danielk1977f3f06bb2005-12-16 15:24:28 +00004881/*
drhfddfa2d2007-12-05 18:05:16 +00004882** CAPI3REF: Enable Or Disable Shared Pager Cache {F10330}
danielk1977f3f06bb2005-12-16 15:24:28 +00004883**
drh6ed48bf2007-06-14 20:57:18 +00004884** This routine enables or disables the sharing of the database cache
4885** and schema data structures between connections to the same database.
4886** Sharing is enabled if the argument is true and disabled if the argument
4887** is false.
danielk1977f3f06bb2005-12-16 15:24:28 +00004888**
drhafc91042008-02-21 02:09:45 +00004889** Cache sharing is enabled and disabled
drhf5befa02007-12-06 02:42:07 +00004890** for an entire process. {END} This is a change as of SQLite version 3.5.0.
4891** In prior versions of SQLite, sharing was
drhe30f4422007-08-21 16:15:55 +00004892** enabled or disabled for each thread separately.
drh6ed48bf2007-06-14 20:57:18 +00004893**
drhe30f4422007-08-21 16:15:55 +00004894** The cache sharing mode set by this interface effects all subsequent
4895** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()].
drhafc91042008-02-21 02:09:45 +00004896** Existing database connections continue use the sharing mode
4897** that was in effect at the time they were opened.
drh6ed48bf2007-06-14 20:57:18 +00004898**
drhafc91042008-02-21 02:09:45 +00004899** Virtual tables cannot be used with a shared cache. When shared
drh4ff7fa02007-09-01 18:17:21 +00004900** cache is enabled, the [sqlite3_create_module()] API used to register
drhafc91042008-02-21 02:09:45 +00004901** virtual tables will always return an error.
drh6ed48bf2007-06-14 20:57:18 +00004902**
drhafc91042008-02-21 02:09:45 +00004903** This routine returns [SQLITE_OK] if shared cache was
4904** enabled or disabled successfully. An [error code]
4905** is returned otherwise.
drh6ed48bf2007-06-14 20:57:18 +00004906**
drhafc91042008-02-21 02:09:45 +00004907** Shared cache is disabled by default. But this might change in
drh4ff7fa02007-09-01 18:17:21 +00004908** future releases of SQLite. Applications that care about shared
4909** cache setting should set it explicitly.
drhafc91042008-02-21 02:09:45 +00004910**
4911** INVARIANTS:
4912**
4913** {F10331} A successful invocation of [sqlite3_enable_shared_cache(B)]
4914** will enable or disable shared cache mode for any subsequently
4915** created [database connection] in the same process.
4916**
4917** {F10336} When shared cache is enabled, the [sqlite3_create_module()]
4918** interface will always return an error.
4919**
4920** {F10337} The [sqlite3_enable_shared_cache(B)] interface returns
4921** [SQLITE_OK] if shared cache was enabled or disabled successfully.
4922**
4923** {F10339} Shared cache is disabled by default.
danielk1977aef0bf62005-12-30 16:28:01 +00004924*/
4925int sqlite3_enable_shared_cache(int);
4926
4927/*
drhfddfa2d2007-12-05 18:05:16 +00004928** CAPI3REF: Attempt To Free Heap Memory {F17340}
drh6ed48bf2007-06-14 20:57:18 +00004929**
drhafc91042008-02-21 02:09:45 +00004930** The sqlite3_release_memory() interface attempts to
drhf5befa02007-12-06 02:42:07 +00004931** free N bytes of heap memory by deallocating non-essential memory
shane26b34032008-05-23 17:21:09 +00004932** allocations held by the database library. {END} Memory used
drhf5befa02007-12-06 02:42:07 +00004933** to cache database pages to improve performance is an example of
drhafc91042008-02-21 02:09:45 +00004934** non-essential memory. Sqlite3_release_memory() returns
drhf5befa02007-12-06 02:42:07 +00004935** the number of bytes actually freed, which might be more or less
4936** than the amount requested.
drhafc91042008-02-21 02:09:45 +00004937**
4938** INVARIANTS:
4939**
4940** {F17341} The [sqlite3_release_memory(N)] interface attempts to
4941** free N bytes of heap memory by deallocating non-essential
shane26b34032008-05-23 17:21:09 +00004942** memory allocations held by the database library.
drhafc91042008-02-21 02:09:45 +00004943**
4944** {F16342} The [sqlite3_release_memory(N)] returns the number
4945** of bytes actually freed, which might be more or less
4946** than the amount requested.
danielk197752622822006-01-09 09:59:49 +00004947*/
4948int sqlite3_release_memory(int);
4949
4950/*
drhfddfa2d2007-12-05 18:05:16 +00004951** CAPI3REF: Impose A Limit On Heap Size {F17350}
drh6ed48bf2007-06-14 20:57:18 +00004952**
drhafc91042008-02-21 02:09:45 +00004953** The sqlite3_soft_heap_limit() interface
drhf5befa02007-12-06 02:42:07 +00004954** places a "soft" limit on the amount of heap memory that may be allocated
drhafc91042008-02-21 02:09:45 +00004955** by SQLite. If an internal allocation is requested
drhf5befa02007-12-06 02:42:07 +00004956** that would exceed the soft heap limit, [sqlite3_release_memory()] is
drhe30f4422007-08-21 16:15:55 +00004957** invoked one or more times to free up some space before the allocation
drhafc91042008-02-21 02:09:45 +00004958** is made.
danielk197752622822006-01-09 09:59:49 +00004959**
drhafc91042008-02-21 02:09:45 +00004960** The limit is called "soft", because if
drhf5befa02007-12-06 02:42:07 +00004961** [sqlite3_release_memory()] cannot
drhe30f4422007-08-21 16:15:55 +00004962** free sufficient memory to prevent the limit from being exceeded,
4963** the memory is allocated anyway and the current operation proceeds.
drh6ed48bf2007-06-14 20:57:18 +00004964**
4965** A negative or zero value for N means that there is no soft heap limit and
drhe30f4422007-08-21 16:15:55 +00004966** [sqlite3_release_memory()] will only be called when memory is exhausted.
drhafc91042008-02-21 02:09:45 +00004967** The default value for the soft heap limit is zero.
drh6ed48bf2007-06-14 20:57:18 +00004968**
drhf5befa02007-12-06 02:42:07 +00004969** SQLite makes a best effort to honor the soft heap limit.
shane26b34032008-05-23 17:21:09 +00004970** But if the soft heap limit cannot be honored, execution will
drhafc91042008-02-21 02:09:45 +00004971** continue without error or notification. This is why the limit is
drh6ed48bf2007-06-14 20:57:18 +00004972** called a "soft" limit. It is advisory only.
4973**
drhe30f4422007-08-21 16:15:55 +00004974** Prior to SQLite version 3.5.0, this routine only constrained the memory
4975** allocated by a single thread - the same thread in which this routine
4976** runs. Beginning with SQLite version 3.5.0, the soft heap limit is
drhafc91042008-02-21 02:09:45 +00004977** applied to all threads. The value specified for the soft heap limit
4978** is an upper bound on the total memory allocation for all threads. In
drh8bacf972007-08-25 16:21:29 +00004979** version 3.5.0 there is no mechanism for limiting the heap usage for
4980** individual threads.
drhafc91042008-02-21 02:09:45 +00004981**
4982** INVARIANTS:
4983**
4984** {F16351} The [sqlite3_soft_heap_limit(N)] interface places a soft limit
4985** of N bytes on the amount of heap memory that may be allocated
4986** using [sqlite3_malloc()] or [sqlite3_realloc()] at any point
4987** in time.
4988**
4989** {F16352} If a call to [sqlite3_malloc()] or [sqlite3_realloc()] would
4990** cause the total amount of allocated memory to exceed the
4991** soft heap limit, then [sqlite3_release_memory()] is invoked
4992** in an attempt to reduce the memory usage prior to proceeding
4993** with the memory allocation attempt.
4994**
4995** {F16353} Calls to [sqlite3_malloc()] or [sqlite3_realloc()] that trigger
4996** attempts to reduce memory usage through the soft heap limit
4997** mechanism continue even if the attempt to reduce memory
4998** usage is unsuccessful.
4999**
5000** {F16354} A negative or zero value for N in a call to
5001** [sqlite3_soft_heap_limit(N)] means that there is no soft
5002** heap limit and [sqlite3_release_memory()] will only be
5003** called when memory is completely exhausted.
5004**
5005** {F16355} The default value for the soft heap limit is zero.
5006**
5007** {F16358} Each call to [sqlite3_soft_heap_limit(N)] overrides the
5008** values set by all prior calls.
danielk197752622822006-01-09 09:59:49 +00005009*/
drhd2d4a6b2006-01-10 15:18:27 +00005010void sqlite3_soft_heap_limit(int);
danielk197752622822006-01-09 09:59:49 +00005011
5012/*
drhfddfa2d2007-12-05 18:05:16 +00005013** CAPI3REF: Extract Metadata About A Column Of A Table {F12850}
drh6ed48bf2007-06-14 20:57:18 +00005014**
5015** This routine
5016** returns meta-data about a specific column of a specific database
danielk1977deb802c2006-02-09 13:43:28 +00005017** table accessible using the connection handle passed as the first function
5018** argument.
5019**
5020** The column is identified by the second, third and fourth parameters to
5021** this function. The second parameter is either the name of the database
5022** (i.e. "main", "temp" or an attached database) containing the specified
5023** table or NULL. If it is NULL, then all attached databases are searched
5024** for the table using the same algorithm as the database engine uses to
5025** resolve unqualified table references.
5026**
5027** The third and fourth parameters to this function are the table and column
5028** name of the desired column, respectively. Neither of these parameters
5029** may be NULL.
5030**
5031** Meta information is returned by writing to the memory locations passed as
5032** the 5th and subsequent parameters to this function. Any of these
5033** arguments may be NULL, in which case the corresponding element of meta
shane26b34032008-05-23 17:21:09 +00005034** information is omitted.
danielk1977deb802c2006-02-09 13:43:28 +00005035**
drh6ed48bf2007-06-14 20:57:18 +00005036** <pre>
danielk1977deb802c2006-02-09 13:43:28 +00005037** Parameter Output Type Description
5038** -----------------------------------
5039**
5040** 5th const char* Data type
5041** 6th const char* Name of the default collation sequence
5042** 7th int True if the column has a NOT NULL constraint
5043** 8th int True if the column is part of the PRIMARY KEY
5044** 9th int True if the column is AUTOINCREMENT
drh6ed48bf2007-06-14 20:57:18 +00005045** </pre>
danielk1977deb802c2006-02-09 13:43:28 +00005046**
5047**
5048** The memory pointed to by the character pointers returned for the
5049** declaration type and collation sequence is valid only until the next
5050** call to any sqlite API function.
5051**
5052** If the specified table is actually a view, then an error is returned.
5053**
5054** If the specified column is "rowid", "oid" or "_rowid_" and an
5055** INTEGER PRIMARY KEY column has been explicitly declared, then the output
5056** parameters are set for the explicitly declared column. If there is no
5057** explicitly declared IPK column, then the output parameters are set as
5058** follows:
5059**
drh6ed48bf2007-06-14 20:57:18 +00005060** <pre>
danielk1977deb802c2006-02-09 13:43:28 +00005061** data type: "INTEGER"
5062** collation sequence: "BINARY"
5063** not null: 0
5064** primary key: 1
5065** auto increment: 0
drh6ed48bf2007-06-14 20:57:18 +00005066** </pre>
danielk1977deb802c2006-02-09 13:43:28 +00005067**
5068** This function may load one or more schemas from database files. If an
5069** error occurs during this process, or if the requested table or column
5070** cannot be found, an SQLITE error code is returned and an error message
5071** left in the database handle (to be retrieved using sqlite3_errmsg()).
danielk19774b1ae992006-02-10 03:06:10 +00005072**
5073** This API is only available if the library was compiled with the
5074** SQLITE_ENABLE_COLUMN_METADATA preprocessor symbol defined.
danielk1977deb802c2006-02-09 13:43:28 +00005075*/
5076int sqlite3_table_column_metadata(
5077 sqlite3 *db, /* Connection handle */
5078 const char *zDbName, /* Database name or NULL */
5079 const char *zTableName, /* Table name */
5080 const char *zColumnName, /* Column name */
5081 char const **pzDataType, /* OUTPUT: Declared data type */
5082 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
5083 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
5084 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh98c94802007-10-01 13:50:31 +00005085 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00005086);
5087
5088/*
drhfddfa2d2007-12-05 18:05:16 +00005089** CAPI3REF: Load An Extension {F12600}
drh1e397f82006-06-08 15:28:43 +00005090**
drhf5befa02007-12-06 02:42:07 +00005091** {F12601} The sqlite3_load_extension() interface
5092** attempts to load an SQLite extension library contained in the file
5093** zFile. {F12602} The entry point is zProc. {F12603} zProc may be 0
5094** in which case the name of the entry point defaults
5095** to "sqlite3_extension_init".
drh1e397f82006-06-08 15:28:43 +00005096**
drhf5befa02007-12-06 02:42:07 +00005097** {F12604} The sqlite3_load_extension() interface shall
5098** return [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.
drh1e397f82006-06-08 15:28:43 +00005099**
drhf5befa02007-12-06 02:42:07 +00005100** {F12605}
5101** If an error occurs and pzErrMsg is not 0, then the
5102** sqlite3_load_extension() interface shall attempt to fill *pzErrMsg with
5103** error message text stored in memory obtained from [sqlite3_malloc()].
5104** {END} The calling function should free this memory
drh6ed48bf2007-06-14 20:57:18 +00005105** by calling [sqlite3_free()].
drh1e397f82006-06-08 15:28:43 +00005106**
drhf5befa02007-12-06 02:42:07 +00005107** {F12606}
drh6ed48bf2007-06-14 20:57:18 +00005108** Extension loading must be enabled using [sqlite3_enable_load_extension()]
drhc2e87a32006-06-27 15:16:14 +00005109** prior to calling this API or an error will be returned.
drh1e397f82006-06-08 15:28:43 +00005110*/
5111int sqlite3_load_extension(
5112 sqlite3 *db, /* Load the extension into this database connection */
5113 const char *zFile, /* Name of the shared library containing extension */
5114 const char *zProc, /* Entry point. Derived from zFile if 0 */
5115 char **pzErrMsg /* Put error message here if not 0 */
5116);
5117
5118/*
drhfddfa2d2007-12-05 18:05:16 +00005119** CAPI3REF: Enable Or Disable Extension Loading {F12620}
drh6ed48bf2007-06-14 20:57:18 +00005120**
drhc2e87a32006-06-27 15:16:14 +00005121** So as not to open security holes in older applications that are
drh6ed48bf2007-06-14 20:57:18 +00005122** unprepared to deal with extension loading, and as a means of disabling
5123** extension loading while evaluating user-entered SQL, the following
5124** API is provided to turn the [sqlite3_load_extension()] mechanism on and
drhf5befa02007-12-06 02:42:07 +00005125** off. {F12622} It is off by default. {END} See ticket #1863.
drhc2e87a32006-06-27 15:16:14 +00005126**
drhf5befa02007-12-06 02:42:07 +00005127** {F12621} Call the sqlite3_enable_load_extension() routine
5128** with onoff==1 to turn extension loading on
5129** and call it with onoff==0 to turn it back off again. {END}
drhc2e87a32006-06-27 15:16:14 +00005130*/
5131int sqlite3_enable_load_extension(sqlite3 *db, int onoff);
5132
5133/*
drhfddfa2d2007-12-05 18:05:16 +00005134** CAPI3REF: Make Arrangements To Automatically Load An Extension {F12640}
drh9eff6162006-06-12 21:59:13 +00005135**
drhf5befa02007-12-06 02:42:07 +00005136** {F12641} This function
5137** registers an extension entry point that is automatically invoked
drh6ed48bf2007-06-14 20:57:18 +00005138** whenever a new database connection is opened using
drhf5befa02007-12-06 02:42:07 +00005139** [sqlite3_open()], [sqlite3_open16()], or [sqlite3_open_v2()]. {END}
drh1409be62006-08-23 20:07:20 +00005140**
5141** This API can be invoked at program startup in order to register
5142** one or more statically linked extensions that will be available
5143** to all new database connections.
5144**
drhf5befa02007-12-06 02:42:07 +00005145** {F12642} Duplicate extensions are detected so calling this routine multiple
drh1409be62006-08-23 20:07:20 +00005146** times with the same extension is harmless.
5147**
drhf5befa02007-12-06 02:42:07 +00005148** {F12643} This routine stores a pointer to the extension in an array
5149** that is obtained from sqlite_malloc(). {END} If you run a memory leak
drh1409be62006-08-23 20:07:20 +00005150** checker on your program and it reports a leak because of this
drhcfa063b2007-11-21 15:24:00 +00005151** array, then invoke [sqlite3_reset_auto_extension()] prior
drh1409be62006-08-23 20:07:20 +00005152** to shutdown to free the memory.
5153**
drhf5befa02007-12-06 02:42:07 +00005154** {F12644} Automatic extensions apply across all threads. {END}
drh6ed48bf2007-06-14 20:57:18 +00005155**
5156** This interface is experimental and is subject to change or
5157** removal in future releases of SQLite.
drh1409be62006-08-23 20:07:20 +00005158*/
5159int sqlite3_auto_extension(void *xEntryPoint);
5160
5161
5162/*
drhfddfa2d2007-12-05 18:05:16 +00005163** CAPI3REF: Reset Automatic Extension Loading {F12660}
drh1409be62006-08-23 20:07:20 +00005164**
drhf5befa02007-12-06 02:42:07 +00005165** {F12661} This function disables all previously registered
5166** automatic extensions. {END} This
drh21ac7f92008-01-31 12:26:49 +00005167** routine undoes the effect of all prior [sqlite3_auto_extension()]
drh1409be62006-08-23 20:07:20 +00005168** calls.
5169**
drhf5befa02007-12-06 02:42:07 +00005170** {F12662} This call disabled automatic extensions in all threads. {END}
drh6ed48bf2007-06-14 20:57:18 +00005171**
5172** This interface is experimental and is subject to change or
5173** removal in future releases of SQLite.
drh1409be62006-08-23 20:07:20 +00005174*/
5175void sqlite3_reset_auto_extension(void);
5176
5177
5178/*
5179****** EXPERIMENTAL - subject to change without notice **************
5180**
drh9eff6162006-06-12 21:59:13 +00005181** The interface to the virtual-table mechanism is currently considered
5182** to be experimental. The interface might change in incompatible ways.
5183** If this is a problem for you, do not use the interface at this time.
5184**
shane26b34032008-05-23 17:21:09 +00005185** When the virtual-table mechanism stabilizes, we will declare the
drh9eff6162006-06-12 21:59:13 +00005186** interface fixed, support it indefinitely, and remove this comment.
5187*/
5188
5189/*
5190** Structures used by the virtual table interface
drhe09daa92006-06-10 13:29:31 +00005191*/
5192typedef struct sqlite3_vtab sqlite3_vtab;
5193typedef struct sqlite3_index_info sqlite3_index_info;
5194typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor;
5195typedef struct sqlite3_module sqlite3_module;
drh9eff6162006-06-12 21:59:13 +00005196
5197/*
drhb4d58ae2008-02-21 20:17:06 +00005198** CAPI3REF: Virtual Table Object {F18000}
5199** KEYWORDS: sqlite3_module
5200**
drh9eff6162006-06-12 21:59:13 +00005201** A module is a class of virtual tables. Each module is defined
5202** by an instance of the following structure. This structure consists
5203** mostly of methods for the module.
5204*/
drhe09daa92006-06-10 13:29:31 +00005205struct sqlite3_module {
5206 int iVersion;
danielk19779da9d472006-06-14 06:58:15 +00005207 int (*xCreate)(sqlite3*, void *pAux,
drhe4102962006-09-11 00:34:22 +00005208 int argc, const char *const*argv,
drh4ca8aac2006-09-10 17:31:58 +00005209 sqlite3_vtab **ppVTab, char**);
danielk19779da9d472006-06-14 06:58:15 +00005210 int (*xConnect)(sqlite3*, void *pAux,
drhe4102962006-09-11 00:34:22 +00005211 int argc, const char *const*argv,
drh4ca8aac2006-09-10 17:31:58 +00005212 sqlite3_vtab **ppVTab, char**);
drhe09daa92006-06-10 13:29:31 +00005213 int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*);
5214 int (*xDisconnect)(sqlite3_vtab *pVTab);
5215 int (*xDestroy)(sqlite3_vtab *pVTab);
5216 int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor);
5217 int (*xClose)(sqlite3_vtab_cursor*);
drh4be8b512006-06-13 23:51:34 +00005218 int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr,
drhe09daa92006-06-10 13:29:31 +00005219 int argc, sqlite3_value **argv);
5220 int (*xNext)(sqlite3_vtab_cursor*);
danielk1977a298e902006-06-22 09:53:48 +00005221 int (*xEof)(sqlite3_vtab_cursor*);
drhe09daa92006-06-10 13:29:31 +00005222 int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int);
drh6d2069d2007-08-14 01:58:53 +00005223 int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid);
5224 int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *);
drhe09daa92006-06-10 13:29:31 +00005225 int (*xBegin)(sqlite3_vtab *pVTab);
5226 int (*xSync)(sqlite3_vtab *pVTab);
5227 int (*xCommit)(sqlite3_vtab *pVTab);
5228 int (*xRollback)(sqlite3_vtab *pVTab);
drhb7f6f682006-07-08 17:06:43 +00005229 int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName,
drhe94b0c32006-07-08 18:09:15 +00005230 void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),
5231 void **ppArg);
danielk1977182c4ba2007-06-27 15:53:34 +00005232
5233 int (*xRename)(sqlite3_vtab *pVtab, const char *zNew);
drhe09daa92006-06-10 13:29:31 +00005234};
drh9eff6162006-06-12 21:59:13 +00005235
5236/*
drhb4d58ae2008-02-21 20:17:06 +00005237** CAPI3REF: Virtual Table Indexing Information {F18100}
5238** KEYWORDS: sqlite3_index_info
5239**
drh9eff6162006-06-12 21:59:13 +00005240** The sqlite3_index_info structure and its substructures is used to
5241** pass information into and receive the reply from the xBestIndex
5242** method of an sqlite3_module. The fields under **Inputs** are the
5243** inputs to xBestIndex and are read-only. xBestIndex inserts its
5244** results into the **Outputs** fields.
5245**
5246** The aConstraint[] array records WHERE clause constraints of the
5247** form:
5248**
5249** column OP expr
5250**
drhfddfa2d2007-12-05 18:05:16 +00005251** Where OP is =, &lt;, &lt;=, &gt;, or &gt;=.
5252** The particular operator is stored
drh9eff6162006-06-12 21:59:13 +00005253** in aConstraint[].op. The index of the column is stored in
5254** aConstraint[].iColumn. aConstraint[].usable is TRUE if the
5255** expr on the right-hand side can be evaluated (and thus the constraint
5256** is usable) and false if it cannot.
5257**
5258** The optimizer automatically inverts terms of the form "expr OP column"
drh98c94802007-10-01 13:50:31 +00005259** and makes other simplifications to the WHERE clause in an attempt to
drh9eff6162006-06-12 21:59:13 +00005260** get as many WHERE clause terms into the form shown above as possible.
5261** The aConstraint[] array only reports WHERE clause terms in the correct
5262** form that refer to the particular virtual table being queried.
5263**
5264** Information about the ORDER BY clause is stored in aOrderBy[].
5265** Each term of aOrderBy records a column of the ORDER BY clause.
5266**
5267** The xBestIndex method must fill aConstraintUsage[] with information
danielk19775fac9f82006-06-13 14:16:58 +00005268** about what parameters to pass to xFilter. If argvIndex>0 then
drh9eff6162006-06-12 21:59:13 +00005269** the right-hand side of the corresponding aConstraint[] is evaluated
5270** and becomes the argvIndex-th entry in argv. If aConstraintUsage[].omit
5271** is true, then the constraint is assumed to be fully handled by the
5272** virtual table and is not checked again by SQLite.
5273**
drh4be8b512006-06-13 23:51:34 +00005274** The idxNum and idxPtr values are recorded and passed into xFilter.
5275** sqlite3_free() is used to free idxPtr if needToFreeIdxPtr is true.
drh9eff6162006-06-12 21:59:13 +00005276**
5277** The orderByConsumed means that output from xFilter will occur in
5278** the correct order to satisfy the ORDER BY clause so that no separate
5279** sorting step is required.
5280**
5281** The estimatedCost value is an estimate of the cost of doing the
5282** particular lookup. A full scan of a table with N entries should have
5283** a cost of N. A binary search of a table of N entries should have a
5284** cost of approximately log(N).
5285*/
drhe09daa92006-06-10 13:29:31 +00005286struct sqlite3_index_info {
5287 /* Inputs */
drh6cca08c2007-09-21 12:43:16 +00005288 int nConstraint; /* Number of entries in aConstraint */
5289 struct sqlite3_index_constraint {
drh9eff6162006-06-12 21:59:13 +00005290 int iColumn; /* Column on left-hand side of constraint */
5291 unsigned char op; /* Constraint operator */
5292 unsigned char usable; /* True if this constraint is usable */
5293 int iTermOffset; /* Used internally - xBestIndex should ignore */
drh6cca08c2007-09-21 12:43:16 +00005294 } *aConstraint; /* Table of WHERE clause constraints */
5295 int nOrderBy; /* Number of terms in the ORDER BY clause */
5296 struct sqlite3_index_orderby {
drh9eff6162006-06-12 21:59:13 +00005297 int iColumn; /* Column number */
5298 unsigned char desc; /* True for DESC. False for ASC. */
drh6cca08c2007-09-21 12:43:16 +00005299 } *aOrderBy; /* The ORDER BY clause */
drhe09daa92006-06-10 13:29:31 +00005300
5301 /* Outputs */
drh9eff6162006-06-12 21:59:13 +00005302 struct sqlite3_index_constraint_usage {
5303 int argvIndex; /* if >0, constraint is part of argv to xFilter */
5304 unsigned char omit; /* Do not code a test for this constraint */
drh6cca08c2007-09-21 12:43:16 +00005305 } *aConstraintUsage;
drh4be8b512006-06-13 23:51:34 +00005306 int idxNum; /* Number used to identify the index */
5307 char *idxStr; /* String, possibly obtained from sqlite3_malloc */
5308 int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */
drh9eff6162006-06-12 21:59:13 +00005309 int orderByConsumed; /* True if output is already ordered */
5310 double estimatedCost; /* Estimated cost of using this index */
drhe09daa92006-06-10 13:29:31 +00005311};
drh9eff6162006-06-12 21:59:13 +00005312#define SQLITE_INDEX_CONSTRAINT_EQ 2
5313#define SQLITE_INDEX_CONSTRAINT_GT 4
5314#define SQLITE_INDEX_CONSTRAINT_LE 8
5315#define SQLITE_INDEX_CONSTRAINT_LT 16
5316#define SQLITE_INDEX_CONSTRAINT_GE 32
5317#define SQLITE_INDEX_CONSTRAINT_MATCH 64
5318
5319/*
drhb4d58ae2008-02-21 20:17:06 +00005320** CAPI3REF: Register A Virtual Table Implementation {F18200}
5321**
drh9eff6162006-06-12 21:59:13 +00005322** This routine is used to register a new module name with an SQLite
5323** connection. Module names must be registered before creating new
5324** virtual tables on the module, or before using preexisting virtual
5325** tables of the module.
5326*/
drhb9bb7c12006-06-11 23:41:55 +00005327int sqlite3_create_module(
drh9eff6162006-06-12 21:59:13 +00005328 sqlite3 *db, /* SQLite connection to register module with */
5329 const char *zName, /* Name of the module */
danielk1977d1ab1ba2006-06-15 04:28:13 +00005330 const sqlite3_module *, /* Methods for the module */
5331 void * /* Client data for xCreate/xConnect */
drhb9bb7c12006-06-11 23:41:55 +00005332);
drhe09daa92006-06-10 13:29:31 +00005333
drh9eff6162006-06-12 21:59:13 +00005334/*
drhb4d58ae2008-02-21 20:17:06 +00005335** CAPI3REF: Register A Virtual Table Implementation {F18210}
5336**
danielk1977832a58a2007-06-22 15:21:15 +00005337** This routine is identical to the sqlite3_create_module() method above,
5338** except that it allows a destructor function to be specified. It is
5339** even more experimental than the rest of the virtual tables API.
5340*/
5341int sqlite3_create_module_v2(
5342 sqlite3 *db, /* SQLite connection to register module with */
5343 const char *zName, /* Name of the module */
5344 const sqlite3_module *, /* Methods for the module */
5345 void *, /* Client data for xCreate/xConnect */
5346 void(*xDestroy)(void*) /* Module destructor function */
5347);
5348
5349/*
drhb4d58ae2008-02-21 20:17:06 +00005350** CAPI3REF: Virtual Table Instance Object {F18010}
5351** KEYWORDS: sqlite3_vtab
5352**
drh9eff6162006-06-12 21:59:13 +00005353** Every module implementation uses a subclass of the following structure
5354** to describe a particular instance of the module. Each subclass will
drh98c94802007-10-01 13:50:31 +00005355** be tailored to the specific needs of the module implementation. The
drh9eff6162006-06-12 21:59:13 +00005356** purpose of this superclass is to define certain fields that are common
5357** to all module implementations.
drhfe1368e2006-09-10 17:08:29 +00005358**
5359** Virtual tables methods can set an error message by assigning a
5360** string obtained from sqlite3_mprintf() to zErrMsg. The method should
5361** take care that any prior string is freed by a call to sqlite3_free()
5362** prior to assigning a new string to zErrMsg. After the error message
5363** is delivered up to the client application, the string will be automatically
5364** freed by sqlite3_free() and the zErrMsg field will be zeroed. Note
5365** that sqlite3_mprintf() and sqlite3_free() are used on the zErrMsg field
5366** since virtual tables are commonly implemented in loadable extensions which
5367** do not have access to sqlite3MPrintf() or sqlite3Free().
drh9eff6162006-06-12 21:59:13 +00005368*/
5369struct sqlite3_vtab {
drha967e882006-06-13 01:04:52 +00005370 const sqlite3_module *pModule; /* The module for this virtual table */
danielk1977be718892006-06-23 08:05:19 +00005371 int nRef; /* Used internally */
drh4ca8aac2006-09-10 17:31:58 +00005372 char *zErrMsg; /* Error message from sqlite3_mprintf() */
drh9eff6162006-06-12 21:59:13 +00005373 /* Virtual table implementations will typically add additional fields */
5374};
5375
drhb4d58ae2008-02-21 20:17:06 +00005376/*
5377** CAPI3REF: Virtual Table Cursor Object {F18020}
5378** KEYWORDS: sqlite3_vtab_cursor
5379**
5380** Every module implementation uses a subclass of the following structure
drh9eff6162006-06-12 21:59:13 +00005381** to describe cursors that point into the virtual table and are used
5382** to loop through the virtual table. Cursors are created using the
5383** xOpen method of the module. Each module implementation will define
5384** the content of a cursor structure to suit its own needs.
5385**
5386** This superclass exists in order to define fields of the cursor that
5387** are common to all implementations.
5388*/
5389struct sqlite3_vtab_cursor {
5390 sqlite3_vtab *pVtab; /* Virtual table of this cursor */
5391 /* Virtual table implementations will typically add additional fields */
5392};
5393
5394/*
drhb4d58ae2008-02-21 20:17:06 +00005395** CAPI3REF: Declare The Schema Of A Virtual Table {F18280}
5396**
drh9eff6162006-06-12 21:59:13 +00005397** The xCreate and xConnect methods of a module use the following API
5398** to declare the format (the names and datatypes of the columns) of
5399** the virtual tables they implement.
5400*/
danielk19777e6ebfb2006-06-12 11:24:37 +00005401int sqlite3_declare_vtab(sqlite3*, const char *zCreateTable);
drhe09daa92006-06-10 13:29:31 +00005402
5403/*
drhb4d58ae2008-02-21 20:17:06 +00005404** CAPI3REF: Overload A Function For A Virtual Table {F18300}
5405**
drhb7481e72006-09-16 21:45:14 +00005406** Virtual tables can provide alternative implementations of functions
5407** using the xFindFunction method. But global versions of those functions
5408** must exist in order to be overloaded.
5409**
5410** This API makes sure a global version of a function with a particular
5411** name and number of parameters exists. If no such function exists
5412** before this API is called, a new function is created. The implementation
5413** of the new function always causes an exception to be thrown. So
5414** the new function is not good for anything by itself. Its only
shane26b34032008-05-23 17:21:09 +00005415** purpose is to be a placeholder function that can be overloaded
drhb7481e72006-09-16 21:45:14 +00005416** by virtual tables.
5417**
5418** This API should be considered part of the virtual table interface,
5419** which is experimental and subject to change.
5420*/
5421int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg);
5422
5423/*
drh9eff6162006-06-12 21:59:13 +00005424** The interface to the virtual-table mechanism defined above (back up
5425** to a comment remarkably similar to this one) is currently considered
5426** to be experimental. The interface might change in incompatible ways.
5427** If this is a problem for you, do not use the interface at this time.
5428**
drh98c94802007-10-01 13:50:31 +00005429** When the virtual-table mechanism stabilizes, we will declare the
drh9eff6162006-06-12 21:59:13 +00005430** interface fixed, support it indefinitely, and remove this comment.
5431**
5432****** EXPERIMENTAL - subject to change without notice **************
5433*/
5434
danielk19778cbadb02007-05-03 16:31:26 +00005435/*
drhfddfa2d2007-12-05 18:05:16 +00005436** CAPI3REF: A Handle To An Open BLOB {F17800}
drh6ed48bf2007-06-14 20:57:18 +00005437**
drhb4d58ae2008-02-21 20:17:06 +00005438** An instance of this object represents an open BLOB on which
5439** incremental I/O can be preformed.
5440** Objects of this type are created by
drh6ed48bf2007-06-14 20:57:18 +00005441** [sqlite3_blob_open()] and destroyed by [sqlite3_blob_close()].
5442** The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces
5443** can be used to read or write small subsections of the blob.
drh79491ab2007-09-04 12:00:00 +00005444** The [sqlite3_blob_bytes()] interface returns the size of the
drh6ed48bf2007-06-14 20:57:18 +00005445** blob in bytes.
danielk19778cbadb02007-05-03 16:31:26 +00005446*/
danielk1977b4e9af92007-05-01 17:49:49 +00005447typedef struct sqlite3_blob sqlite3_blob;
5448
danielk19778cbadb02007-05-03 16:31:26 +00005449/*
drhfddfa2d2007-12-05 18:05:16 +00005450** CAPI3REF: Open A BLOB For Incremental I/O {F17810}
drh6ed48bf2007-06-14 20:57:18 +00005451**
drhb4d58ae2008-02-21 20:17:06 +00005452** This interfaces opens a handle to the blob located
drhf84ddc12008-03-24 12:51:46 +00005453** in row iRow, column zColumn, table zTable in database zDb;
drhf5befa02007-12-06 02:42:07 +00005454** in other words, the same blob that would be selected by:
danielk19778cbadb02007-05-03 16:31:26 +00005455**
drh6ed48bf2007-06-14 20:57:18 +00005456** <pre>
5457** SELECT zColumn FROM zDb.zTable WHERE rowid = iRow;
drhf5befa02007-12-06 02:42:07 +00005458** </pre> {END}
danielk19778cbadb02007-05-03 16:31:26 +00005459**
drhb4d58ae2008-02-21 20:17:06 +00005460** If the flags parameter is non-zero, the blob is opened for
danielk19778cbadb02007-05-03 16:31:26 +00005461** read and write access. If it is zero, the blob is opened for read
drhb4d58ae2008-02-21 20:17:06 +00005462** access.
danielk19778cbadb02007-05-03 16:31:26 +00005463**
drhf84ddc12008-03-24 12:51:46 +00005464** Note that the database name is not the filename that contains
5465** the database but rather the symbolic name of the database that
5466** is assigned when the database is connected using [ATTACH].
5467** For the main database file, the database name is "main". For
5468** TEMP tables, the database name is "temp".
5469**
drhb4d58ae2008-02-21 20:17:06 +00005470** On success, [SQLITE_OK] is returned and the new
drhf5befa02007-12-06 02:42:07 +00005471** [sqlite3_blob | blob handle] is written to *ppBlob.
drhb4d58ae2008-02-21 20:17:06 +00005472** Otherwise an error code is returned and
danielk19778cbadb02007-05-03 16:31:26 +00005473** any value written to *ppBlob should not be used by the caller.
drhb4d58ae2008-02-21 20:17:06 +00005474** This function sets the database-handle error code and message
drh6ed48bf2007-06-14 20:57:18 +00005475** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()].
drhb4d58ae2008-02-21 20:17:06 +00005476**
5477** INVARIANTS:
5478**
5479** {F17813} A successful invocation of the [sqlite3_blob_open(D,B,T,C,R,F,P)]
5480** interface opens an [sqlite3_blob] object P on the blob
5481** in column C of table T in database B on [database connection] D.
5482**
5483** {F17814} A successful invocation of [sqlite3_blob_open(D,...)] starts
5484** a new transaction on [database connection] D if that connection
5485** is not already in a transaction.
5486**
5487** {F17816} The [sqlite3_blob_open(D,B,T,C,R,F,P)] interface opens the blob
5488** for read and write access if and only if the F parameter
5489** is non-zero.
5490**
5491** {F17819} The [sqlite3_blob_open()] interface returns [SQLITE_OK] on
5492** success and an appropriate [error code] on failure.
5493**
5494** {F17821} If an error occurs during evaluation of [sqlite3_blob_open(D,...)]
5495** then subsequent calls to [sqlite3_errcode(D)],
5496** [sqlite3_errmsg(D)], and [sqlite3_errmsg16(D)] will return
shane26b34032008-05-23 17:21:09 +00005497** information appropriate for that error.
danielk19778cbadb02007-05-03 16:31:26 +00005498*/
danielk1977b4e9af92007-05-01 17:49:49 +00005499int sqlite3_blob_open(
5500 sqlite3*,
5501 const char *zDb,
5502 const char *zTable,
5503 const char *zColumn,
drh6d2069d2007-08-14 01:58:53 +00005504 sqlite3_int64 iRow,
danielk1977b4e9af92007-05-01 17:49:49 +00005505 int flags,
5506 sqlite3_blob **ppBlob
5507);
5508
danielk19778cbadb02007-05-03 16:31:26 +00005509/*
drhfddfa2d2007-12-05 18:05:16 +00005510** CAPI3REF: Close A BLOB Handle {F17830}
drh6ed48bf2007-06-14 20:57:18 +00005511**
5512** Close an open [sqlite3_blob | blob handle].
drh2dd62be2007-12-04 13:22:43 +00005513**
drhb4d58ae2008-02-21 20:17:06 +00005514** Closing a BLOB shall cause the current transaction to commit
drhf5befa02007-12-06 02:42:07 +00005515** if there are no other BLOBs, no pending prepared statements, and the
5516** database connection is in autocommit mode.
drhb4d58ae2008-02-21 20:17:06 +00005517** If any writes were made to the BLOB, they might be held in cache
drhf5befa02007-12-06 02:42:07 +00005518** until the close operation if they will fit. {END}
5519** Closing the BLOB often forces the changes
drh2dd62be2007-12-04 13:22:43 +00005520** out to disk and so if any I/O errors occur, they will likely occur
drhf5befa02007-12-06 02:42:07 +00005521** at the time when the BLOB is closed. {F17833} Any errors that occur during
drh2dd62be2007-12-04 13:22:43 +00005522** closing are reported as a non-zero return value.
5523**
drhb4d58ae2008-02-21 20:17:06 +00005524** The BLOB is closed unconditionally. Even if this routine returns
drh2dd62be2007-12-04 13:22:43 +00005525** an error code, the BLOB is still closed.
drhb4d58ae2008-02-21 20:17:06 +00005526**
5527** INVARIANTS:
5528**
5529** {F17833} The [sqlite3_blob_close(P)] interface closes an
5530** [sqlite3_blob] object P previously opened using
5531** [sqlite3_blob_open()].
5532**
5533** {F17836} Closing an [sqlite3_blob] object using
5534** [sqlite3_blob_close()] shall cause the current transaction to
5535** commit if there are no other open [sqlite3_blob] objects
5536** or [prepared statements] on the same [database connection] and
5537** the [database connection] is in
5538** [sqlite3_get_autocommit | autocommit mode].
5539**
5540** {F17839} The [sqlite3_blob_close(P)] interfaces closes the
5541** [sqlite3_blob] object P unconditionally, even if
5542** [sqlite3_blob_close(P)] returns something other than [SQLITE_OK].
5543**
danielk19778cbadb02007-05-03 16:31:26 +00005544*/
danielk1977b4e9af92007-05-01 17:49:49 +00005545int sqlite3_blob_close(sqlite3_blob *);
5546
danielk19778cbadb02007-05-03 16:31:26 +00005547/*
drhb4d58ae2008-02-21 20:17:06 +00005548** CAPI3REF: Return The Size Of An Open BLOB {F17840}
drh6ed48bf2007-06-14 20:57:18 +00005549**
drhb4d58ae2008-02-21 20:17:06 +00005550** Return the size in bytes of the blob accessible via the open
5551** [sqlite3_blob] object in its only argument.
5552**
5553** INVARIANTS:
5554**
5555** {F17843} The [sqlite3_blob_bytes(P)] interface returns the size
5556** in bytes of the BLOB that the [sqlite3_blob] object P
5557** refers to.
danielk19778cbadb02007-05-03 16:31:26 +00005558*/
danielk1977b4e9af92007-05-01 17:49:49 +00005559int sqlite3_blob_bytes(sqlite3_blob *);
5560
drh9eff6162006-06-12 21:59:13 +00005561/*
drhfddfa2d2007-12-05 18:05:16 +00005562** CAPI3REF: Read Data From A BLOB Incrementally {F17850}
drh6ed48bf2007-06-14 20:57:18 +00005563**
5564** This function is used to read data from an open
5565** [sqlite3_blob | blob-handle] into a caller supplied buffer.
drhb4d58ae2008-02-21 20:17:06 +00005566** N bytes of data are copied into buffer
5567** Z from the open blob, starting at offset iOffset.
danielk19778cbadb02007-05-03 16:31:26 +00005568**
drhb4d58ae2008-02-21 20:17:06 +00005569** If offset iOffset is less than N bytes from the end of the blob,
5570** [SQLITE_ERROR] is returned and no data is read. If N or iOffset is
drhf5befa02007-12-06 02:42:07 +00005571** less than zero [SQLITE_ERROR] is returned and no data is read.
5572**
drhb4d58ae2008-02-21 20:17:06 +00005573** On success, SQLITE_OK is returned. Otherwise, an
drh33c1be32008-01-30 16:16:14 +00005574** [error code] or an [extended error code] is returned.
drhb4d58ae2008-02-21 20:17:06 +00005575**
5576** INVARIANTS:
5577**
5578** {F17853} The [sqlite3_blob_read(P,Z,N,X)] interface reads N bytes
5579** beginning at offset X from
5580** the blob that [sqlite3_blob] object P refers to
5581** and writes those N bytes into buffer Z.
5582**
5583** {F17856} In [sqlite3_blob_read(P,Z,N,X)] if the size of the blob
5584** is less than N+X bytes, then the function returns [SQLITE_ERROR]
5585** and nothing is read from the blob.
5586**
5587** {F17859} In [sqlite3_blob_read(P,Z,N,X)] if X or N is less than zero
5588** then the function returns [SQLITE_ERROR]
5589** and nothing is read from the blob.
5590**
5591** {F17862} The [sqlite3_blob_read(P,Z,N,X)] interface returns [SQLITE_OK]
5592** if N bytes where successfully read into buffer Z.
5593**
5594** {F17865} If the requested read could not be completed,
5595** the [sqlite3_blob_read(P,Z,N,X)] interface returns an
5596** appropriate [error code] or [extended error code].
5597**
danielk19779eca0812008-04-24 08:56:54 +00005598** {F17868} If an error occurs during evaluation of [sqlite3_blob_read(P,...)]
drhb4d58ae2008-02-21 20:17:06 +00005599** then subsequent calls to [sqlite3_errcode(D)],
5600** [sqlite3_errmsg(D)], and [sqlite3_errmsg16(D)] will return
shane26b34032008-05-23 17:21:09 +00005601** information appropriate for that error, where D is the
danielk19779eca0812008-04-24 08:56:54 +00005602** database handle that was used to open blob handle P.
danielk19778cbadb02007-05-03 16:31:26 +00005603*/
drhb4d58ae2008-02-21 20:17:06 +00005604int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset);
danielk19778cbadb02007-05-03 16:31:26 +00005605
5606/*
drhfddfa2d2007-12-05 18:05:16 +00005607** CAPI3REF: Write Data Into A BLOB Incrementally {F17870}
drh6ed48bf2007-06-14 20:57:18 +00005608**
5609** This function is used to write data into an open
5610** [sqlite3_blob | blob-handle] from a user supplied buffer.
drhb4d58ae2008-02-21 20:17:06 +00005611** n bytes of data are copied from the buffer
danielk19778cbadb02007-05-03 16:31:26 +00005612** pointed to by z into the open blob, starting at offset iOffset.
5613**
drhb4d58ae2008-02-21 20:17:06 +00005614** If the [sqlite3_blob | blob-handle] passed as the first argument
drh6ed48bf2007-06-14 20:57:18 +00005615** was not opened for writing (the flags parameter to [sqlite3_blob_open()]
5616*** was zero), this function returns [SQLITE_READONLY].
danielk19778cbadb02007-05-03 16:31:26 +00005617**
drhb4d58ae2008-02-21 20:17:06 +00005618** This function may only modify the contents of the blob; it is
drhf5befa02007-12-06 02:42:07 +00005619** not possible to increase the size of a blob using this API.
drhb4d58ae2008-02-21 20:17:06 +00005620** If offset iOffset is less than n bytes from the end of the blob,
5621** [SQLITE_ERROR] is returned and no data is written. If n is
drhf5befa02007-12-06 02:42:07 +00005622** less than zero [SQLITE_ERROR] is returned and no data is written.
danielk19778cbadb02007-05-03 16:31:26 +00005623**
drhb4d58ae2008-02-21 20:17:06 +00005624** On success, SQLITE_OK is returned. Otherwise, an
drh33c1be32008-01-30 16:16:14 +00005625** [error code] or an [extended error code] is returned.
drhb4d58ae2008-02-21 20:17:06 +00005626**
5627** INVARIANTS:
5628**
5629** {F17873} The [sqlite3_blob_write(P,Z,N,X)] interface writes N bytes
5630** from buffer Z into
5631** the blob that [sqlite3_blob] object P refers to
5632** beginning at an offset of X into the blob.
5633**
5634** {F17875} The [sqlite3_blob_write(P,Z,N,X)] interface returns
5635** [SQLITE_READONLY] if the [sqlite3_blob] object P was
5636** [sqlite3_blob_open | opened] for reading only.
5637**
5638** {F17876} In [sqlite3_blob_write(P,Z,N,X)] if the size of the blob
5639** is less than N+X bytes, then the function returns [SQLITE_ERROR]
5640** and nothing is written into the blob.
5641**
5642** {F17879} In [sqlite3_blob_write(P,Z,N,X)] if X or N is less than zero
5643** then the function returns [SQLITE_ERROR]
5644** and nothing is written into the blob.
5645**
5646** {F17882} The [sqlite3_blob_write(P,Z,N,X)] interface returns [SQLITE_OK]
5647** if N bytes where successfully written into blob.
5648**
5649** {F17885} If the requested write could not be completed,
5650** the [sqlite3_blob_write(P,Z,N,X)] interface returns an
5651** appropriate [error code] or [extended error code].
5652**
5653** {F17888} If an error occurs during evaluation of [sqlite3_blob_write(D,...)]
5654** then subsequent calls to [sqlite3_errcode(D)],
5655** [sqlite3_errmsg(D)], and [sqlite3_errmsg16(D)] will return
shane26b34032008-05-23 17:21:09 +00005656** information appropriate for that error.
danielk19778cbadb02007-05-03 16:31:26 +00005657*/
5658int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset);
5659
drhd84f9462007-08-15 11:28:56 +00005660/*
drhfddfa2d2007-12-05 18:05:16 +00005661** CAPI3REF: Virtual File System Objects {F11200}
drhd84f9462007-08-15 11:28:56 +00005662**
5663** A virtual filesystem (VFS) is an [sqlite3_vfs] object
5664** that SQLite uses to interact
drhb4d58ae2008-02-21 20:17:06 +00005665** with the underlying operating system. Most SQLite builds come with a
drhd84f9462007-08-15 11:28:56 +00005666** single default VFS that is appropriate for the host computer.
5667** New VFSes can be registered and existing VFSes can be unregistered.
5668** The following interfaces are provided.
5669**
drhb4d58ae2008-02-21 20:17:06 +00005670** The sqlite3_vfs_find() interface returns a pointer to
5671** a VFS given its name. Names are case sensitive.
5672** Names are zero-terminated UTF-8 strings.
5673** If there is no match, a NULL
5674** pointer is returned. If zVfsName is NULL then the default
5675** VFS is returned.
drhd84f9462007-08-15 11:28:56 +00005676**
drhb4d58ae2008-02-21 20:17:06 +00005677** New VFSes are registered with sqlite3_vfs_register().
5678** Each new VFS becomes the default VFS if the makeDflt flag is set.
5679** The same VFS can be registered multiple times without injury.
5680** To make an existing VFS into the default VFS, register it again
5681** with the makeDflt flag set. If two different VFSes with the
5682** same name are registered, the behavior is undefined. If a
drhb6f5cf32007-08-28 15:21:45 +00005683** VFS is registered with a name that is NULL or an empty string,
5684** then the behavior is undefined.
drhd84f9462007-08-15 11:28:56 +00005685**
drhb4d58ae2008-02-21 20:17:06 +00005686** Unregister a VFS with the sqlite3_vfs_unregister() interface.
5687** If the default VFS is unregistered, another VFS is chosen as
drhd84f9462007-08-15 11:28:56 +00005688** the default. The choice for the new VFS is arbitrary.
drhb4d58ae2008-02-21 20:17:06 +00005689**
5690** INVARIANTS:
5691**
5692** {F11203} The [sqlite3_vfs_find(N)] interface returns a pointer to the
5693** registered [sqlite3_vfs] object whose name exactly matches
5694** the zero-terminated UTF-8 string N, or it returns NULL if
5695** there is no match.
5696**
5697** {F11206} If the N parameter to [sqlite3_vfs_find(N)] is NULL then
5698** the function returns a pointer to the default [sqlite3_vfs]
5699** object if there is one, or NULL if there is no default
5700** [sqlite3_vfs] object.
5701**
5702** {F11209} The [sqlite3_vfs_register(P,F)] interface registers the
5703** well-formed [sqlite3_vfs] object P using the name given
5704** by the zName field of the object.
5705**
5706** {F11212} Using the [sqlite3_vfs_register(P,F)] interface to register
5707** the same [sqlite3_vfs] object multiple times is a harmless no-op.
5708**
5709** {F11215} The [sqlite3_vfs_register(P,F)] interface makes the
5710** the [sqlite3_vfs] object P the default [sqlite3_vfs] object
5711** if F is non-zero.
5712**
5713** {F11218} The [sqlite3_vfs_unregister(P)] interface unregisters the
5714** [sqlite3_vfs] object P so that it is no longer returned by
5715** subsequent calls to [sqlite3_vfs_find()].
drhd84f9462007-08-15 11:28:56 +00005716*/
drhd677b3d2007-08-20 22:48:41 +00005717sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName);
drhd677b3d2007-08-20 22:48:41 +00005718int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);
5719int sqlite3_vfs_unregister(sqlite3_vfs*);
drhd84f9462007-08-15 11:28:56 +00005720
5721/*
drhfddfa2d2007-12-05 18:05:16 +00005722** CAPI3REF: Mutexes {F17000}
drhd84f9462007-08-15 11:28:56 +00005723**
5724** The SQLite core uses these routines for thread
5725** synchronization. Though they are intended for internal
5726** use by SQLite, code that links against SQLite is
5727** permitted to use any of these routines.
5728**
5729** The SQLite source code contains multiple implementations
drh8bacf972007-08-25 16:21:29 +00005730** of these mutex routines. An appropriate implementation
5731** is selected automatically at compile-time. The following
5732** implementations are available in the SQLite core:
drhd84f9462007-08-15 11:28:56 +00005733**
5734** <ul>
drhc7ce76a2007-08-30 14:10:30 +00005735** <li> SQLITE_MUTEX_OS2
drhd84f9462007-08-15 11:28:56 +00005736** <li> SQLITE_MUTEX_PTHREAD
drhc7ce76a2007-08-30 14:10:30 +00005737** <li> SQLITE_MUTEX_W32
drhd84f9462007-08-15 11:28:56 +00005738** <li> SQLITE_MUTEX_NOOP
drhd84f9462007-08-15 11:28:56 +00005739** </ul>
5740**
drhd84f9462007-08-15 11:28:56 +00005741** The SQLITE_MUTEX_NOOP implementation is a set of routines
5742** that does no real locking and is appropriate for use in
drhc7ce76a2007-08-30 14:10:30 +00005743** a single-threaded application. The SQLITE_MUTEX_OS2,
5744** SQLITE_MUTEX_PTHREAD, and SQLITE_MUTEX_W32 implementations
shane26b34032008-05-23 17:21:09 +00005745** are appropriate for use on OS/2, Unix, and Windows.
drhd84f9462007-08-15 11:28:56 +00005746**
drh8bacf972007-08-25 16:21:29 +00005747** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor
5748** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex
drhd84f9462007-08-15 11:28:56 +00005749** implementation is included with the library. The
drh8bacf972007-08-25 16:21:29 +00005750** mutex interface routines defined here become external
drhd84f9462007-08-15 11:28:56 +00005751** references in the SQLite library for which implementations
drh8bacf972007-08-25 16:21:29 +00005752** must be provided by the application. This facility allows an
5753** application that links against SQLite to provide its own mutex
5754** implementation without having to modify the SQLite core.
drhd84f9462007-08-15 11:28:56 +00005755**
drhcb041342008-06-12 00:07:29 +00005756** {F17001} The sqlite3_mutex_init() routine is called once by each
5757** effective call to [sqlite3_initialize()]. The sqlite3_mutex_init()
5758** interface initializes the mutex subsystem. The application should
5759** never call sqlite3_mutex_init() directly but only indirectly by
5760** invoking [sqlite3_initialize()].
5761**
5762** {F17003} The sqlite3_mutex_end() routine undoes the effect of
5763** sqlite3_mutex_init(). The sqlite3_mutex_end() interface is called
5764** by [sqlite3_shutdown()]. The application should never call
5765** sqlite3_mutex_end() directly but only indirectly through
5766** [sqlite3_shutdown()].
5767**
drhf5befa02007-12-06 02:42:07 +00005768** {F17011} The sqlite3_mutex_alloc() routine allocates a new
5769** mutex and returns a pointer to it. {F17012} If it returns NULL
5770** that means that a mutex could not be allocated. {F17013} SQLite
5771** will unwind its stack and return an error. {F17014} The argument
drh6bdec4a2007-08-16 19:40:16 +00005772** to sqlite3_mutex_alloc() is one of these integer constants:
5773**
5774** <ul>
5775** <li> SQLITE_MUTEX_FAST
5776** <li> SQLITE_MUTEX_RECURSIVE
5777** <li> SQLITE_MUTEX_STATIC_MASTER
5778** <li> SQLITE_MUTEX_STATIC_MEM
drh86f8c192007-08-22 00:39:19 +00005779** <li> SQLITE_MUTEX_STATIC_MEM2
drh6bdec4a2007-08-16 19:40:16 +00005780** <li> SQLITE_MUTEX_STATIC_PRNG
danielk19779f61c2f2007-08-27 17:27:49 +00005781** <li> SQLITE_MUTEX_STATIC_LRU
danielk1977dfb316d2008-03-26 18:34:43 +00005782** <li> SQLITE_MUTEX_STATIC_LRU2
drhf5befa02007-12-06 02:42:07 +00005783** </ul> {END}
drh6bdec4a2007-08-16 19:40:16 +00005784**
drhf5befa02007-12-06 02:42:07 +00005785** {F17015} The first two constants cause sqlite3_mutex_alloc() to create
drh6bdec4a2007-08-16 19:40:16 +00005786** a new mutex. The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
drhf5befa02007-12-06 02:42:07 +00005787** is used but not necessarily so when SQLITE_MUTEX_FAST is used. {END}
drh6bdec4a2007-08-16 19:40:16 +00005788** The mutex implementation does not need to make a distinction
5789** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
drhf5befa02007-12-06 02:42:07 +00005790** not want to. {F17016} But SQLite will only request a recursive mutex in
5791** cases where it really needs one. {END} If a faster non-recursive mutex
drh6bdec4a2007-08-16 19:40:16 +00005792** implementation is available on the host platform, the mutex subsystem
5793** might return such a mutex in response to SQLITE_MUTEX_FAST.
5794**
drhf5befa02007-12-06 02:42:07 +00005795** {F17017} The other allowed parameters to sqlite3_mutex_alloc() each return
5796** a pointer to a static preexisting mutex. {END} Four static mutexes are
drh6bdec4a2007-08-16 19:40:16 +00005797** used by the current version of SQLite. Future versions of SQLite
5798** may add additional static mutexes. Static mutexes are for internal
5799** use by SQLite only. Applications that use SQLite mutexes should
5800** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
5801** SQLITE_MUTEX_RECURSIVE.
5802**
drhf5befa02007-12-06 02:42:07 +00005803** {F17018} Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
drh6bdec4a2007-08-16 19:40:16 +00005804** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
drhf5befa02007-12-06 02:42:07 +00005805** returns a different mutex on every call. {F17034} But for the static
drh6bdec4a2007-08-16 19:40:16 +00005806** mutex types, the same mutex is returned on every call that has
drhf5befa02007-12-06 02:42:07 +00005807** the same type number. {END}
drhd84f9462007-08-15 11:28:56 +00005808**
drhf5befa02007-12-06 02:42:07 +00005809** {F17019} The sqlite3_mutex_free() routine deallocates a previously
5810** allocated dynamic mutex. {F17020} SQLite is careful to deallocate every
5811** dynamic mutex that it allocates. {U17021} The dynamic mutexes must not be in
5812** use when they are deallocated. {U17022} Attempting to deallocate a static
5813** mutex results in undefined behavior. {F17023} SQLite never deallocates
5814** a static mutex. {END}
drhd84f9462007-08-15 11:28:56 +00005815**
drh6bdec4a2007-08-16 19:40:16 +00005816** The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
drhf5befa02007-12-06 02:42:07 +00005817** to enter a mutex. {F17024} If another thread is already within the mutex,
drh6bdec4a2007-08-16 19:40:16 +00005818** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
shane26b34032008-05-23 17:21:09 +00005819** SQLITE_BUSY. {F17025} The sqlite3_mutex_try() interface returns [SQLITE_OK]
drhf5befa02007-12-06 02:42:07 +00005820** upon successful entry. {F17026} Mutexes created using
5821** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread.
5822** {F17027} In such cases the,
drh6bdec4a2007-08-16 19:40:16 +00005823** mutex must be exited an equal number of times before another thread
drhf5befa02007-12-06 02:42:07 +00005824** can enter. {U17028} If the same thread tries to enter any other
5825** kind of mutex more than once, the behavior is undefined.
5826** {F17029} SQLite will never exhibit
drhcb041342008-06-12 00:07:29 +00005827** such behavior in its own use of mutexes.
drhd84f9462007-08-15 11:28:56 +00005828**
drhcb041342008-06-12 00:07:29 +00005829** Some systems (ex: windows95) do not support the operation implemented by
drhca49cba2007-09-04 22:31:36 +00005830** sqlite3_mutex_try(). On those systems, sqlite3_mutex_try() will
drhf5befa02007-12-06 02:42:07 +00005831** always return SQLITE_BUSY. {F17030} The SQLite core only ever uses
drhcb041342008-06-12 00:07:29 +00005832** sqlite3_mutex_try() as an optimization so this is acceptable behavior.
drhca49cba2007-09-04 22:31:36 +00005833**
drhf5befa02007-12-06 02:42:07 +00005834** {F17031} The sqlite3_mutex_leave() routine exits a mutex that was
5835** previously entered by the same thread. {U17032} The behavior
drh8bacf972007-08-25 16:21:29 +00005836** is undefined if the mutex is not currently entered by the
drhf5befa02007-12-06 02:42:07 +00005837** calling thread or is not currently allocated. {F17033} SQLite will
5838** never do either. {END}
drh8bacf972007-08-25 16:21:29 +00005839**
drh40257ff2008-06-13 18:24:27 +00005840** If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or
5841** sqlite3_mutex_leave() is a NULL pointer, then all three routines
5842** behave as no-ops.
5843**
drh8bacf972007-08-25 16:21:29 +00005844** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()].
5845*/
5846sqlite3_mutex *sqlite3_mutex_alloc(int);
5847void sqlite3_mutex_free(sqlite3_mutex*);
5848void sqlite3_mutex_enter(sqlite3_mutex*);
5849int sqlite3_mutex_try(sqlite3_mutex*);
5850void sqlite3_mutex_leave(sqlite3_mutex*);
5851
drh56a40a82008-06-18 13:47:03 +00005852/*
5853** CAPI3REF: Mutex Methods Object {F17120}
5854**
5855** An instance of this structure defines the low-level routines
5856** used to allocate and use mutexes. This structure is used as
5857** an argument to the [SQLITE_CONFIG_MUTEX] and [SQLITE_CONFIG_GETMUTEX]
5858** options of [sqlite3_config()]. The methods defined by this
5859** structure implement the following interfaces (respectively):
5860**
5861** <ul>
5862** <li> [sqlite3_mutex_init()] </li>
5863** <li> [sqlite3_mutex_alloc()] </li>
5864** <li> [sqlite3_mutex_free()] </li>
5865** <li> [sqlite3_mutex_enter()] </li>
5866** <li> [sqlite3_mutex_try()] </li>
5867** <li> [sqlite3_mutex_leave()] </li>
5868** <li> [sqlite3_mutex_end()] </li>
5869** <li> [sqlite3_mutex_held()] </li>
5870** <li> [sqlite3_mutex_notheld()] </li>
5871** </ul>
5872*/
danielk19776d2ab0e2008-06-17 17:21:18 +00005873typedef struct sqlite3_mutex_methods sqlite3_mutex_methods;
5874struct sqlite3_mutex_methods {
5875 int (*xMutexInit)(void);
5876 sqlite3_mutex *(*xMutexAlloc)(int);
5877 void (*xMutexFree)(sqlite3_mutex *);
5878 void (*xMutexEnter)(sqlite3_mutex *);
5879 int (*xMutexTry)(sqlite3_mutex *);
5880 void (*xMutexLeave)(sqlite3_mutex *);
5881 int (*xMutexEnd)(void);
5882 int (*xMutexHeld)(sqlite3_mutex *);
5883 int (*xMutexNotheld)(sqlite3_mutex *);
5884};
5885
5886
drh8bacf972007-08-25 16:21:29 +00005887/*
drhfddfa2d2007-12-05 18:05:16 +00005888** CAPI3REF: Mutex Verifcation Routines {F17080}
drhd677b3d2007-08-20 22:48:41 +00005889**
5890** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines
drhfddfa2d2007-12-05 18:05:16 +00005891** are intended for use inside assert() statements. {F17081} The SQLite core
drhf77a2ff2007-08-25 14:49:36 +00005892** never uses these routines except inside an assert() and applications
drhfddfa2d2007-12-05 18:05:16 +00005893** are advised to follow the lead of the core. {F17082} The core only
drh8bacf972007-08-25 16:21:29 +00005894** provides implementations for these routines when it is compiled
drhf5befa02007-12-06 02:42:07 +00005895** with the SQLITE_DEBUG flag. {U17087} External mutex implementations
drh8bacf972007-08-25 16:21:29 +00005896** are only required to provide these routines if SQLITE_DEBUG is
5897** defined and if NDEBUG is not defined.
5898**
drhfddfa2d2007-12-05 18:05:16 +00005899** {F17083} These routines should return true if the mutex in their argument
5900** is held or not held, respectively, by the calling thread. {END}
drh8bacf972007-08-25 16:21:29 +00005901**
drhfddfa2d2007-12-05 18:05:16 +00005902** {X17084} The implementation is not required to provided versions of these
drh8bacf972007-08-25 16:21:29 +00005903** routines that actually work.
5904** If the implementation does not provide working
5905** versions of these routines, it should at least provide stubs
5906** that always return true so that one does not get spurious
drhfddfa2d2007-12-05 18:05:16 +00005907** assertion failures. {END}
drhd677b3d2007-08-20 22:48:41 +00005908**
drhfddfa2d2007-12-05 18:05:16 +00005909** {F17085} If the argument to sqlite3_mutex_held() is a NULL pointer then
5910** the routine should return 1. {END} This seems counter-intuitive since
drhd677b3d2007-08-20 22:48:41 +00005911** clearly the mutex cannot be held if it does not exist. But the
5912** the reason the mutex does not exist is because the build is not
5913** using mutexes. And we do not want the assert() containing the
5914** call to sqlite3_mutex_held() to fail, so a non-zero return is
drhfddfa2d2007-12-05 18:05:16 +00005915** the appropriate thing to do. {F17086} The sqlite3_mutex_notheld()
drhd677b3d2007-08-20 22:48:41 +00005916** interface should also return 1 when given a NULL pointer.
drhd84f9462007-08-15 11:28:56 +00005917*/
drhd677b3d2007-08-20 22:48:41 +00005918int sqlite3_mutex_held(sqlite3_mutex*);
5919int sqlite3_mutex_notheld(sqlite3_mutex*);
drh32bc3f62007-08-21 20:25:39 +00005920
5921/*
drhfddfa2d2007-12-05 18:05:16 +00005922** CAPI3REF: Mutex Types {F17001}
drh32bc3f62007-08-21 20:25:39 +00005923**
drhfddfa2d2007-12-05 18:05:16 +00005924** {F17002} The [sqlite3_mutex_alloc()] interface takes a single argument
5925** which is one of these integer constants. {END}
drh32bc3f62007-08-21 20:25:39 +00005926*/
drh6bdec4a2007-08-16 19:40:16 +00005927#define SQLITE_MUTEX_FAST 0
5928#define SQLITE_MUTEX_RECURSIVE 1
5929#define SQLITE_MUTEX_STATIC_MASTER 2
drh86f8c192007-08-22 00:39:19 +00005930#define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */
5931#define SQLITE_MUTEX_STATIC_MEM2 4 /* sqlite3_release_memory() */
5932#define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */
danielk19779f61c2f2007-08-27 17:27:49 +00005933#define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */
danielk1977dfb316d2008-03-26 18:34:43 +00005934#define SQLITE_MUTEX_STATIC_LRU2 7 /* lru page list */
drh6d2069d2007-08-14 01:58:53 +00005935
drhcc6bb3e2007-08-31 16:11:35 +00005936/*
drhfddfa2d2007-12-05 18:05:16 +00005937** CAPI3REF: Low-Level Control Of Database Files {F11300}
drhcc6bb3e2007-08-31 16:11:35 +00005938**
drhfddfa2d2007-12-05 18:05:16 +00005939** {F11301} The [sqlite3_file_control()] interface makes a direct call to the
drhcc6bb3e2007-08-31 16:11:35 +00005940** xFileControl method for the [sqlite3_io_methods] object associated
drhfddfa2d2007-12-05 18:05:16 +00005941** with a particular database identified by the second argument. {F11302} The
drhcc6bb3e2007-08-31 16:11:35 +00005942** name of the database is the name assigned to the database by the
5943** <a href="lang_attach.html">ATTACH</a> SQL command that opened the
drhfddfa2d2007-12-05 18:05:16 +00005944** database. {F11303} To control the main database file, use the name "main"
5945** or a NULL pointer. {F11304} The third and fourth parameters to this routine
drhcc6bb3e2007-08-31 16:11:35 +00005946** are passed directly through to the second and third parameters of
drhfddfa2d2007-12-05 18:05:16 +00005947** the xFileControl method. {F11305} The return value of the xFileControl
drhcc6bb3e2007-08-31 16:11:35 +00005948** method becomes the return value of this routine.
5949**
drhfddfa2d2007-12-05 18:05:16 +00005950** {F11306} If the second parameter (zDbName) does not match the name of any
5951** open database file, then SQLITE_ERROR is returned. {F11307} This error
drhcc6bb3e2007-08-31 16:11:35 +00005952** code is not remembered and will not be recalled by [sqlite3_errcode()]
drhf5befa02007-12-06 02:42:07 +00005953** or [sqlite3_errmsg()]. {U11308} The underlying xFileControl method might
5954** also return SQLITE_ERROR. {U11309} There is no way to distinguish between
drhcc6bb3e2007-08-31 16:11:35 +00005955** an incorrect zDbName and an SQLITE_ERROR return from the underlying
drhfddfa2d2007-12-05 18:05:16 +00005956** xFileControl method. {END}
drh4ff7fa02007-09-01 18:17:21 +00005957**
5958** See also: [SQLITE_FCNTL_LOCKSTATE]
drhcc6bb3e2007-08-31 16:11:35 +00005959*/
5960int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*);
drh6d2069d2007-08-14 01:58:53 +00005961
danielk19778cbadb02007-05-03 16:31:26 +00005962/*
drhed13d982008-01-31 14:43:24 +00005963** CAPI3REF: Testing Interface {F11400}
5964**
5965** The sqlite3_test_control() interface is used to read out internal
5966** state of SQLite and to inject faults into SQLite for testing
shane26b34032008-05-23 17:21:09 +00005967** purposes. The first parameter is an operation code that determines
drhed13d982008-01-31 14:43:24 +00005968** the number, meaning, and operation of all subsequent parameters.
5969**
5970** This interface is not for use by applications. It exists solely
5971** for verifying the correct operation of the SQLite library. Depending
5972** on how the SQLite library is compiled, this interface might not exist.
5973**
5974** The details of the operation codes, their meanings, the parameters
5975** they take, and what they do are all subject to change without notice.
5976** Unlike most of the SQLite API, this function is not guaranteed to
5977** operate consistently from one release to the next.
5978*/
5979int sqlite3_test_control(int op, ...);
5980
5981/*
5982** CAPI3REF: Testing Interface Operation Codes {F11410}
5983**
5984** These constants are the valid operation code parameters used
5985** as the first argument to [sqlite3_test_control()].
5986**
shane26b34032008-05-23 17:21:09 +00005987** These parameters and their meanings are subject to change
drhed13d982008-01-31 14:43:24 +00005988** without notice. These values are for testing purposes only.
5989** Applications should not use any of these parameters or the
5990** [sqlite3_test_control()] interface.
5991*/
5992#define SQLITE_TESTCTRL_FAULT_CONFIG 1
5993#define SQLITE_TESTCTRL_FAULT_FAILURES 2
5994#define SQLITE_TESTCTRL_FAULT_BENIGN_FAILURES 3
5995#define SQLITE_TESTCTRL_FAULT_PENDING 4
drh2fa18682008-03-19 14:15:34 +00005996#define SQLITE_TESTCTRL_PRNG_SAVE 5
5997#define SQLITE_TESTCTRL_PRNG_RESTORE 6
5998#define SQLITE_TESTCTRL_PRNG_RESET 7
drh3088d592008-03-21 16:45:47 +00005999#define SQLITE_TESTCTRL_BITVEC_TEST 8
drhed13d982008-01-31 14:43:24 +00006000
6001
6002/*
drhb37df7b2005-10-13 02:09:49 +00006003** Undo the hack that converts floating point types to integer for
6004** builds on processors without floating point support.
6005*/
6006#ifdef SQLITE_OMIT_FLOATING_POINT
6007# undef double
6008#endif
6009
drh382c0242001-10-06 16:33:02 +00006010#ifdef __cplusplus
6011} /* End of the 'extern "C"' block */
6012#endif
danielk19774adee202004-05-08 08:23:19 +00006013#endif