blob: 31cc5b2166cc114a98a8c2db12f3306cf4f943a2 [file] [log] [blame]
drh75897232000-05-29 14:26:00 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drh75897232000-05-29 14:26:00 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drh75897232000-05-29 14:26:00 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
drh75897232000-05-29 14:26:00 +000010**
11*************************************************************************
drhb19a2bc2001-09-16 00:13:26 +000012** This header file defines the interface that the SQLite library
drh6ed48bf2007-06-14 20:57:18 +000013** presents to client programs. If a C-function, structure, datatype,
14** or constant definition does not appear in this file, then it is
15** not a published API of SQLite, is subject to change without
16** notice, and should not be referenced by programs that use SQLite.
drh75897232000-05-29 14:26:00 +000017**
drh6ed48bf2007-06-14 20:57:18 +000018** Some of the definitions that are in this file are marked as
19** "experimental". Experimental interfaces are normally new
mihailima3f64902008-06-21 13:35:56 +000020** features recently added to SQLite. We do not anticipate changes
drh6ed48bf2007-06-14 20:57:18 +000021** 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**
drh39bf74a2009-06-09 18:02:10 +000033** @(#) $Id: sqlite.h.in,v 1.456 2009/06/09 18:02:10 drh Exp $
drh75897232000-05-29 14:26:00 +000034*/
drh12057d52004-09-06 17:34:12 +000035#ifndef _SQLITE3_H_
36#define _SQLITE3_H_
drha18c5682000-10-08 22:20:57 +000037#include <stdarg.h> /* Needed for the definition of va_list */
drh75897232000-05-29 14:26:00 +000038
39/*
drh382c0242001-10-06 16:33:02 +000040** Make sure we can call this stuff from C++.
41*/
42#ifdef __cplusplus
43extern "C" {
44#endif
45
drh6d2069d2007-08-14 01:58:53 +000046
drh382c0242001-10-06 16:33:02 +000047/*
drh73be5012007-08-08 12:11:21 +000048** Add the ability to override 'extern'
49*/
50#ifndef SQLITE_EXTERN
51# define SQLITE_EXTERN extern
52#endif
53
54/*
drh4d6618f2008-09-22 17:54:46 +000055** These no-op macros are used in front of interfaces to mark those
56** interfaces as either deprecated or experimental. New applications
57** should not use deprecated intrfaces - they are support for backwards
58** compatibility only. Application writers should be aware that
59** experimental interfaces are subject to change in point releases.
60**
61** These macros used to resolve to various kinds of compiler magic that
62** would generate warning messages when they were used. But that
63** compiler magic ended up generating such a flurry of bug reports
64** that we have taken it all out and gone back to using simple
65** noop macros.
shanea79c3cc2008-08-11 17:27:01 +000066*/
drh4d6618f2008-09-22 17:54:46 +000067#define SQLITE_DEPRECATED
68#define SQLITE_EXPERIMENTAL
shanea79c3cc2008-08-11 17:27:01 +000069
70/*
mihailim362cc832008-06-21 06:16:42 +000071** Ensure these symbols were not defined by some previous header file.
drhb86ccfb2003-01-28 23:13:10 +000072*/
drh1e284f42004-10-06 15:52:01 +000073#ifdef SQLITE_VERSION
74# undef SQLITE_VERSION
drh1e284f42004-10-06 15:52:01 +000075#endif
drh6ed48bf2007-06-14 20:57:18 +000076#ifdef SQLITE_VERSION_NUMBER
77# undef SQLITE_VERSION_NUMBER
78#endif
danielk197799ba19e2005-02-05 07:33:34 +000079
80/*
drhb25f9d82008-07-23 15:40:06 +000081** CAPI3REF: Compile-Time Library Version Numbers {H10010} <S60100>
drh6ed48bf2007-06-14 20:57:18 +000082**
drh33c1be32008-01-30 16:16:14 +000083** The SQLITE_VERSION and SQLITE_VERSION_NUMBER #defines in
84** the sqlite3.h file specify the version of SQLite with which
85** that header file is associated.
danielk197799ba19e2005-02-05 07:33:34 +000086**
drh7663e362008-02-14 23:24:16 +000087** The "version" of SQLite is a string of the form "X.Y.Z".
drh33c1be32008-01-30 16:16:14 +000088** The phrase "alpha" or "beta" might be appended after the Z.
89** The X value is major version number always 3 in SQLite3.
mihailim362cc832008-06-21 06:16:42 +000090** The X value only changes when backwards compatibility is
91** broken and we intend to never break backwards compatibility.
92** The Y value is the minor version number and only changes when
drh6ed48bf2007-06-14 20:57:18 +000093** there are major feature enhancements that are forwards compatible
mihailim362cc832008-06-21 06:16:42 +000094** but not backwards compatible.
95** The Z value is the release number and is incremented with
96** each release but resets back to 0 whenever Y is incremented.
drh6ed48bf2007-06-14 20:57:18 +000097**
drh6ed48bf2007-06-14 20:57:18 +000098** See also: [sqlite3_libversion()] and [sqlite3_libversion_number()].
drh33c1be32008-01-30 16:16:14 +000099**
drh8b39db12009-02-18 18:37:58 +0000100** Requirements: [H10011] [H10014]
danielk197799ba19e2005-02-05 07:33:34 +0000101*/
drh6ed48bf2007-06-14 20:57:18 +0000102#define SQLITE_VERSION "--VERS--"
drhb4d58ae2008-02-21 20:17:06 +0000103#define SQLITE_VERSION_NUMBER --VERSION-NUMBER--
drhb86ccfb2003-01-28 23:13:10 +0000104
105/*
drh9a247912008-07-22 18:45:08 +0000106** CAPI3REF: Run-Time Library Version Numbers {H10020} <S60100>
drh33c1be32008-01-30 16:16:14 +0000107** KEYWORDS: sqlite3_version
drh6ed48bf2007-06-14 20:57:18 +0000108**
drh33c1be32008-01-30 16:16:14 +0000109** These features provide the same information as the [SQLITE_VERSION]
110** and [SQLITE_VERSION_NUMBER] #defines in the header, but are associated
111** with the library instead of the header file. Cautious programmers might
mihailim362cc832008-06-21 06:16:42 +0000112** include a check in their application to verify that
113** sqlite3_libversion_number() always returns the value
drhfddfa2d2007-12-05 18:05:16 +0000114** [SQLITE_VERSION_NUMBER].
drh6ed48bf2007-06-14 20:57:18 +0000115**
drh33c1be32008-01-30 16:16:14 +0000116** The sqlite3_libversion() function returns the same information as is
117** in the sqlite3_version[] string constant. The function is provided
118** for use in DLLs since DLL users usually do not have direct access to string
drhfddfa2d2007-12-05 18:05:16 +0000119** constants within the DLL.
drh33c1be32008-01-30 16:16:14 +0000120**
drh8b39db12009-02-18 18:37:58 +0000121** Requirements: [H10021] [H10022] [H10023]
drhb217a572000-08-22 13:40:18 +0000122*/
drh73be5012007-08-08 12:11:21 +0000123SQLITE_EXTERN const char sqlite3_version[];
drha3f70cb2004-09-30 14:24:50 +0000124const char *sqlite3_libversion(void);
danielk197799ba19e2005-02-05 07:33:34 +0000125int sqlite3_libversion_number(void);
126
127/*
drh9a247912008-07-22 18:45:08 +0000128** CAPI3REF: Test To See If The Library Is Threadsafe {H10100} <S60100>
drhb67e8bf2007-08-30 20:09:48 +0000129**
drh33c1be32008-01-30 16:16:14 +0000130** SQLite can be compiled with or without mutexes. When
drhafacce02008-09-02 21:35:03 +0000131** the [SQLITE_THREADSAFE] C preprocessor macro 1 or 2, mutexes
132** are enabled and SQLite is threadsafe. When the
133** [SQLITE_THREADSAFE] macro is 0,
drh33c1be32008-01-30 16:16:14 +0000134** the mutexes are omitted. Without the mutexes, it is not safe
mihailim362cc832008-06-21 06:16:42 +0000135** to use SQLite concurrently from more than one thread.
drhb67e8bf2007-08-30 20:09:48 +0000136**
mihailim362cc832008-06-21 06:16:42 +0000137** Enabling mutexes incurs a measurable performance penalty.
drh33c1be32008-01-30 16:16:14 +0000138** So if speed is of utmost importance, it makes sense to disable
139** the mutexes. But for maximum safety, mutexes should be enabled.
140** The default behavior is for mutexes to be enabled.
141**
142** This interface can be used by a program to make sure that the
143** version of SQLite that it is linking against was compiled with
drh4766b292008-06-26 02:53:02 +0000144** the desired setting of the [SQLITE_THREADSAFE] macro.
145**
146** This interface only reports on the compile-time mutex setting
147** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with
148** SQLITE_THREADSAFE=1 then mutexes are enabled by default but
149** can be fully or partially disabled using a call to [sqlite3_config()]
150** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD],
151** or [SQLITE_CONFIG_MUTEX]. The return value of this function shows
152** only the default compile-time setting, not any run-time changes
153** to that setting.
drh33c1be32008-01-30 16:16:14 +0000154**
drhafacce02008-09-02 21:35:03 +0000155** See the [threading mode] documentation for additional information.
156**
drh8b39db12009-02-18 18:37:58 +0000157** Requirements: [H10101] [H10102]
drhb67e8bf2007-08-30 20:09:48 +0000158*/
159int sqlite3_threadsafe(void);
160
161/*
drh9cd29642008-07-23 00:52:55 +0000162** CAPI3REF: Database Connection Handle {H12000} <S40200>
drha06f17f2008-05-11 11:07:06 +0000163** KEYWORDS: {database connection} {database connections}
drh6ed48bf2007-06-14 20:57:18 +0000164**
mihailim362cc832008-06-21 06:16:42 +0000165** Each open SQLite database is represented by a pointer to an instance of
166** the opaque structure named "sqlite3". It is useful to think of an sqlite3
drh8bacf972007-08-25 16:21:29 +0000167** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and
mihailim362cc832008-06-21 06:16:42 +0000168** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()]
169** is its destructor. There are many other interfaces (such as
170** [sqlite3_prepare_v2()], [sqlite3_create_function()], and
171** [sqlite3_busy_timeout()] to name but three) that are methods on an
172** sqlite3 object.
drh75897232000-05-29 14:26:00 +0000173*/
drh9bb575f2004-09-06 17:24:11 +0000174typedef struct sqlite3 sqlite3;
danielk197765904932004-05-26 06:18:37 +0000175
drh75897232000-05-29 14:26:00 +0000176/*
drh9cd29642008-07-23 00:52:55 +0000177** CAPI3REF: 64-Bit Integer Types {H10200} <S10110>
drh33c1be32008-01-30 16:16:14 +0000178** KEYWORDS: sqlite_int64 sqlite_uint64
drh6ed48bf2007-06-14 20:57:18 +0000179**
drh33c1be32008-01-30 16:16:14 +0000180** Because there is no cross-platform way to specify 64-bit integer types
drhfddfa2d2007-12-05 18:05:16 +0000181** SQLite includes typedefs for 64-bit signed and unsigned integers.
drh6ed48bf2007-06-14 20:57:18 +0000182**
mihailim362cc832008-06-21 06:16:42 +0000183** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions.
184** The sqlite_int64 and sqlite_uint64 types are supported for backwards
185** compatibility only.
drh33c1be32008-01-30 16:16:14 +0000186**
drh8b39db12009-02-18 18:37:58 +0000187** Requirements: [H10201] [H10202]
drhefad9992004-06-22 12:13:55 +0000188*/
drh27436af2006-03-28 23:57:17 +0000189#ifdef SQLITE_INT64_TYPE
drh9b8f4472006-04-04 01:54:55 +0000190 typedef SQLITE_INT64_TYPE sqlite_int64;
drh27436af2006-03-28 23:57:17 +0000191 typedef unsigned SQLITE_INT64_TYPE sqlite_uint64;
192#elif defined(_MSC_VER) || defined(__BORLANDC__)
drhefad9992004-06-22 12:13:55 +0000193 typedef __int64 sqlite_int64;
drh1211de32004-07-26 12:24:22 +0000194 typedef unsigned __int64 sqlite_uint64;
drhefad9992004-06-22 12:13:55 +0000195#else
196 typedef long long int sqlite_int64;
drh1211de32004-07-26 12:24:22 +0000197 typedef unsigned long long int sqlite_uint64;
drhefad9992004-06-22 12:13:55 +0000198#endif
drh6d2069d2007-08-14 01:58:53 +0000199typedef sqlite_int64 sqlite3_int64;
200typedef sqlite_uint64 sqlite3_uint64;
drhefad9992004-06-22 12:13:55 +0000201
drhb37df7b2005-10-13 02:09:49 +0000202/*
203** If compiling for a processor that lacks floating point support,
mihailim362cc832008-06-21 06:16:42 +0000204** substitute integer for floating-point.
drhb37df7b2005-10-13 02:09:49 +0000205*/
206#ifdef SQLITE_OMIT_FLOATING_POINT
drh6d2069d2007-08-14 01:58:53 +0000207# define double sqlite3_int64
drhb37df7b2005-10-13 02:09:49 +0000208#endif
drhefad9992004-06-22 12:13:55 +0000209
210/*
drh9cd29642008-07-23 00:52:55 +0000211** CAPI3REF: Closing A Database Connection {H12010} <S30100><S40200>
drh75897232000-05-29 14:26:00 +0000212**
mihailim362cc832008-06-21 06:16:42 +0000213** This routine is the destructor for the [sqlite3] object.
drh33c1be32008-01-30 16:16:14 +0000214**
mihailim362cc832008-06-21 06:16:42 +0000215** Applications should [sqlite3_finalize | finalize] all [prepared statements]
mihailim15194222008-06-22 09:55:14 +0000216** and [sqlite3_blob_close | close] all [BLOB handles] associated with
mihailim362cc832008-06-21 06:16:42 +0000217** the [sqlite3] object prior to attempting to close the object.
218** The [sqlite3_next_stmt()] interface can be used to locate all
219** [prepared statements] associated with a [database connection] if desired.
220** Typical code might look like this:
drh33c1be32008-01-30 16:16:14 +0000221**
drh55b0cf02008-06-19 17:54:33 +0000222** <blockquote><pre>
223** sqlite3_stmt *pStmt;
224** while( (pStmt = sqlite3_next_stmt(db, 0))!=0 ){
225** &nbsp; sqlite3_finalize(pStmt);
226** }
227** </pre></blockquote>
228**
mihailim362cc832008-06-21 06:16:42 +0000229** If [sqlite3_close()] is invoked while a transaction is open,
drh55b0cf02008-06-19 17:54:33 +0000230** the transaction is automatically rolled back.
drh33c1be32008-01-30 16:16:14 +0000231**
drh8b39db12009-02-18 18:37:58 +0000232** The C parameter to [sqlite3_close(C)] must be either a NULL
233** pointer or an [sqlite3] object pointer obtained
234** from [sqlite3_open()], [sqlite3_open16()], or
235** [sqlite3_open_v2()], and not previously closed.
drh33c1be32008-01-30 16:16:14 +0000236**
drh8b39db12009-02-18 18:37:58 +0000237** Requirements:
238** [H12011] [H12012] [H12013] [H12014] [H12015] [H12019]
drh75897232000-05-29 14:26:00 +0000239*/
danielk1977f9d64d22004-06-19 08:18:07 +0000240int sqlite3_close(sqlite3 *);
drh75897232000-05-29 14:26:00 +0000241
242/*
243** The type for a callback function.
drh6ed48bf2007-06-14 20:57:18 +0000244** This is legacy and deprecated. It is included for historical
245** compatibility and is not documented.
drh75897232000-05-29 14:26:00 +0000246*/
drh12057d52004-09-06 17:34:12 +0000247typedef int (*sqlite3_callback)(void*,int,char**, char**);
drh75897232000-05-29 14:26:00 +0000248
249/*
drh9cd29642008-07-23 00:52:55 +0000250** CAPI3REF: One-Step Query Execution Interface {H12100} <S10000>
drh6ed48bf2007-06-14 20:57:18 +0000251**
mihailim362cc832008-06-21 06:16:42 +0000252** The sqlite3_exec() interface is a convenient way of running one or more
253** SQL statements without having to write a lot of C code. The UTF-8 encoded
254** SQL statements are passed in as the second parameter to sqlite3_exec().
255** The statements are evaluated one by one until either an error or
256** an interrupt is encountered, or until they are all done. The 3rd parameter
257** is an optional callback that is invoked once for each row of any query
258** results produced by the SQL statements. The 5th parameter tells where
drh33c1be32008-01-30 16:16:14 +0000259** to write any error messages.
drh75897232000-05-29 14:26:00 +0000260**
drh35c61902008-05-20 15:44:30 +0000261** The error message passed back through the 5th parameter is held
262** in memory obtained from [sqlite3_malloc()]. To avoid a memory leak,
263** the calling application should call [sqlite3_free()] on any error
264** message returned through the 5th parameter when it has finished using
265** the error message.
266**
267** If the SQL statement in the 2nd parameter is NULL or an empty string
mihailim362cc832008-06-21 06:16:42 +0000268** or a string containing only whitespace and comments, then no SQL
269** statements are evaluated and the database is not changed.
drh35c61902008-05-20 15:44:30 +0000270**
drh33c1be32008-01-30 16:16:14 +0000271** The sqlite3_exec() interface is implemented in terms of
272** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()].
drh35c61902008-05-20 15:44:30 +0000273** The sqlite3_exec() routine does nothing to the database that cannot be done
drh33c1be32008-01-30 16:16:14 +0000274** by [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()].
drh75897232000-05-29 14:26:00 +0000275**
drh8b39db12009-02-18 18:37:58 +0000276** The first parameter to [sqlite3_exec()] must be an valid and open
277** [database connection].
mihailima3f64902008-06-21 13:35:56 +0000278**
drh8b39db12009-02-18 18:37:58 +0000279** The database connection must not be closed while
280** [sqlite3_exec()] is running.
drh75897232000-05-29 14:26:00 +0000281**
drh8b39db12009-02-18 18:37:58 +0000282** The calling function should use [sqlite3_free()] to free
283** the memory that *errmsg is left pointing at once the error
284** message is no longer needed.
drh75897232000-05-29 14:26:00 +0000285**
drh8b39db12009-02-18 18:37:58 +0000286** The SQL statement text in the 2nd parameter to [sqlite3_exec()]
287** must remain unchanged while [sqlite3_exec()] is running.
drhf50bebf2008-05-19 23:51:55 +0000288**
drh8b39db12009-02-18 18:37:58 +0000289** Requirements:
290** [H12101] [H12102] [H12104] [H12105] [H12107] [H12110] [H12113] [H12116]
291** [H12119] [H12122] [H12125] [H12131] [H12134] [H12137] [H12138]
drh75897232000-05-29 14:26:00 +0000292*/
danielk19776f8a5032004-05-10 10:34:51 +0000293int sqlite3_exec(
drh6ed48bf2007-06-14 20:57:18 +0000294 sqlite3*, /* An open database */
shane236ce972008-05-30 15:35:30 +0000295 const char *sql, /* SQL to be evaluated */
drh6ed48bf2007-06-14 20:57:18 +0000296 int (*callback)(void*,int,char**,char**), /* Callback function */
297 void *, /* 1st argument to callback */
298 char **errmsg /* Error msg written here */
drh75897232000-05-29 14:26:00 +0000299);
300
drh58b95762000-06-02 01:17:37 +0000301/*
drhb25f9d82008-07-23 15:40:06 +0000302** CAPI3REF: Result Codes {H10210} <S10700>
drh33c1be32008-01-30 16:16:14 +0000303** KEYWORDS: SQLITE_OK {error code} {error codes}
mihailimefc8e8a2008-06-21 16:47:09 +0000304** KEYWORDS: {result code} {result codes}
drh6ed48bf2007-06-14 20:57:18 +0000305**
306** Many SQLite functions return an integer result code from the set shown
drh33c1be32008-01-30 16:16:14 +0000307** here in order to indicates success or failure.
drh6ed48bf2007-06-14 20:57:18 +0000308**
drh4766b292008-06-26 02:53:02 +0000309** New error codes may be added in future versions of SQLite.
310**
drh6ed48bf2007-06-14 20:57:18 +0000311** See also: [SQLITE_IOERR_READ | extended result codes]
drh58b95762000-06-02 01:17:37 +0000312*/
drh717e6402001-09-27 03:22:32 +0000313#define SQLITE_OK 0 /* Successful result */
drh15b9a152006-01-31 20:49:13 +0000314/* beginning-of-error-codes */
drh717e6402001-09-27 03:22:32 +0000315#define SQLITE_ERROR 1 /* SQL error or missing database */
drh89e0dde2007-12-12 12:25:21 +0000316#define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */
drh717e6402001-09-27 03:22:32 +0000317#define SQLITE_PERM 3 /* Access permission denied */
318#define SQLITE_ABORT 4 /* Callback routine requested an abort */
319#define SQLITE_BUSY 5 /* The database file is locked */
320#define SQLITE_LOCKED 6 /* A table in the database is locked */
321#define SQLITE_NOMEM 7 /* A malloc() failed */
322#define SQLITE_READONLY 8 /* Attempt to write a readonly database */
drh24cd67e2004-05-10 16:18:47 +0000323#define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/
drh717e6402001-09-27 03:22:32 +0000324#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */
325#define SQLITE_CORRUPT 11 /* The database disk image is malformed */
drh2db0bbc2005-08-11 02:10:18 +0000326#define SQLITE_NOTFOUND 12 /* NOT USED. Table or record not found */
drh717e6402001-09-27 03:22:32 +0000327#define SQLITE_FULL 13 /* Insertion failed because database is full */
328#define SQLITE_CANTOPEN 14 /* Unable to open the database file */
drh4f0ee682007-03-30 20:43:40 +0000329#define SQLITE_PROTOCOL 15 /* NOT USED. Database lock protocol error */
drh24cd67e2004-05-10 16:18:47 +0000330#define SQLITE_EMPTY 16 /* Database is empty */
drh717e6402001-09-27 03:22:32 +0000331#define SQLITE_SCHEMA 17 /* The database schema changed */
drhc797d4d2007-05-08 01:08:49 +0000332#define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */
danielk19776eb91d22007-09-21 04:27:02 +0000333#define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */
drh8aff1012001-12-22 14:49:24 +0000334#define SQLITE_MISMATCH 20 /* Data type mismatch */
drh247be432002-05-10 05:44:55 +0000335#define SQLITE_MISUSE 21 /* Library used incorrectly */
drh8766c342002-11-09 00:33:15 +0000336#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */
drhed6c8672003-01-12 18:02:16 +0000337#define SQLITE_AUTH 23 /* Authorization denied */
drh1c2d8412003-03-31 00:30:47 +0000338#define SQLITE_FORMAT 24 /* Auxiliary database format error */
danielk19776f8a5032004-05-10 10:34:51 +0000339#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */
drhc602f9a2004-02-12 19:01:04 +0000340#define SQLITE_NOTADB 26 /* File opened that is not a database file */
danielk19776f8a5032004-05-10 10:34:51 +0000341#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */
342#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */
drh15b9a152006-01-31 20:49:13 +0000343/* end-of-error-codes */
drh717e6402001-09-27 03:22:32 +0000344
drhaf9ff332002-01-16 21:00:27 +0000345/*
drhb25f9d82008-07-23 15:40:06 +0000346** CAPI3REF: Extended Result Codes {H10220} <S10700>
drh33c1be32008-01-30 16:16:14 +0000347** KEYWORDS: {extended error code} {extended error codes}
mihailimefc8e8a2008-06-21 16:47:09 +0000348** KEYWORDS: {extended result code} {extended result codes}
drh4ac285a2006-09-15 07:28:50 +0000349**
drh6ed48bf2007-06-14 20:57:18 +0000350** In its default configuration, SQLite API routines return one of 26 integer
mihailim362cc832008-06-21 06:16:42 +0000351** [SQLITE_OK | result codes]. However, experience has shown that many of
352** these result codes are too coarse-grained. They do not provide as
drhf5befa02007-12-06 02:42:07 +0000353** much information about problems as programmers might like. In an effort to
drh6ed48bf2007-06-14 20:57:18 +0000354** address this, newer versions of SQLite (version 3.3.8 and later) include
355** support for additional result codes that provide more detailed information
drh33c1be32008-01-30 16:16:14 +0000356** about errors. The extended result codes are enabled or disabled
mihailim362cc832008-06-21 06:16:42 +0000357** on a per database connection basis using the
358** [sqlite3_extended_result_codes()] API.
mihailima3f64902008-06-21 13:35:56 +0000359**
drh33c1be32008-01-30 16:16:14 +0000360** Some of the available extended result codes are listed here.
361** One may expect the number of extended result codes will be expand
362** over time. Software that uses extended result codes should expect
363** to see new result codes in future releases of SQLite.
drh4ac285a2006-09-15 07:28:50 +0000364**
365** The SQLITE_OK result code will never be extended. It will always
366** be exactly zero.
drh4ac285a2006-09-15 07:28:50 +0000367*/
danielk1977861f7452008-06-05 11:39:11 +0000368#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8))
369#define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8))
370#define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8))
371#define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8))
372#define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8))
373#define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8))
374#define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8))
375#define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8))
376#define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8))
377#define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8))
378#define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8))
379#define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8))
380#define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8))
381#define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8))
aswift5b1a2562008-08-22 00:22:35 +0000382#define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8))
aswiftaebf4132008-11-21 00:10:35 +0000383#define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8))
384#define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8))
danielk1977404ca072009-03-16 13:19:36 +0000385#define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8) )
386
drh4ac285a2006-09-15 07:28:50 +0000387/*
drh9cd29642008-07-23 00:52:55 +0000388** CAPI3REF: Flags For File Open Operations {H10230} <H11120> <H12700>
drh6d2069d2007-08-14 01:58:53 +0000389**
mlcreechb2799412008-03-07 03:20:31 +0000390** These bit values are intended for use in the
drh33c1be32008-01-30 16:16:14 +0000391** 3rd parameter to the [sqlite3_open_v2()] interface and
392** in the 4th parameter to the xOpen method of the
drhd84f9462007-08-15 11:28:56 +0000393** [sqlite3_vfs] object.
drh6d2069d2007-08-14 01:58:53 +0000394*/
shane089b0a42009-05-14 03:21:28 +0000395#define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */
396#define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */
397#define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */
398#define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */
399#define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */
400#define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */
401#define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */
402#define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */
403#define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */
404#define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */
405#define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */
406#define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */
407#define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */
408#define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */
drh6d2069d2007-08-14 01:58:53 +0000409
410/*
drh9cd29642008-07-23 00:52:55 +0000411** CAPI3REF: Device Characteristics {H10240} <H11120>
drh6d2069d2007-08-14 01:58:53 +0000412**
drh33c1be32008-01-30 16:16:14 +0000413** The xDeviceCapabilities method of the [sqlite3_io_methods]
drhfddfa2d2007-12-05 18:05:16 +0000414** object returns an integer which is a vector of the these
drh6d2069d2007-08-14 01:58:53 +0000415** bit values expressing I/O characteristics of the mass storage
416** device that holds the file that the [sqlite3_io_methods]
drh33c1be32008-01-30 16:16:14 +0000417** refers to.
drh6d2069d2007-08-14 01:58:53 +0000418**
drh33c1be32008-01-30 16:16:14 +0000419** The SQLITE_IOCAP_ATOMIC property means that all writes of
420** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
drh6d2069d2007-08-14 01:58:53 +0000421** mean that writes of blocks that are nnn bytes in size and
422** are aligned to an address which is an integer multiple of
drh33c1be32008-01-30 16:16:14 +0000423** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
drh6d2069d2007-08-14 01:58:53 +0000424** that when data is appended to a file, the data is appended
425** first then the size of the file is extended, never the other
drh33c1be32008-01-30 16:16:14 +0000426** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
drh6d2069d2007-08-14 01:58:53 +0000427** information is written to disk in the same order as calls
428** to xWrite().
429*/
430#define SQLITE_IOCAP_ATOMIC 0x00000001
431#define SQLITE_IOCAP_ATOMIC512 0x00000002
432#define SQLITE_IOCAP_ATOMIC1K 0x00000004
433#define SQLITE_IOCAP_ATOMIC2K 0x00000008
434#define SQLITE_IOCAP_ATOMIC4K 0x00000010
435#define SQLITE_IOCAP_ATOMIC8K 0x00000020
436#define SQLITE_IOCAP_ATOMIC16K 0x00000040
437#define SQLITE_IOCAP_ATOMIC32K 0x00000080
438#define SQLITE_IOCAP_ATOMIC64K 0x00000100
439#define SQLITE_IOCAP_SAFE_APPEND 0x00000200
440#define SQLITE_IOCAP_SEQUENTIAL 0x00000400
441
442/*
drhb25f9d82008-07-23 15:40:06 +0000443** CAPI3REF: File Locking Levels {H10250} <H11120> <H11310>
drh6d2069d2007-08-14 01:58:53 +0000444**
drh33c1be32008-01-30 16:16:14 +0000445** SQLite uses one of these integer values as the second
drh6d2069d2007-08-14 01:58:53 +0000446** argument to calls it makes to the xLock() and xUnlock() methods
drh33c1be32008-01-30 16:16:14 +0000447** of an [sqlite3_io_methods] object.
drh6d2069d2007-08-14 01:58:53 +0000448*/
449#define SQLITE_LOCK_NONE 0
450#define SQLITE_LOCK_SHARED 1
451#define SQLITE_LOCK_RESERVED 2
452#define SQLITE_LOCK_PENDING 3
453#define SQLITE_LOCK_EXCLUSIVE 4
454
455/*
drh9cd29642008-07-23 00:52:55 +0000456** CAPI3REF: Synchronization Type Flags {H10260} <H11120>
drh6d2069d2007-08-14 01:58:53 +0000457**
drh33c1be32008-01-30 16:16:14 +0000458** When SQLite invokes the xSync() method of an
mlcreechb2799412008-03-07 03:20:31 +0000459** [sqlite3_io_methods] object it uses a combination of
drhfddfa2d2007-12-05 18:05:16 +0000460** these integer values as the second argument.
drh6d2069d2007-08-14 01:58:53 +0000461**
drh33c1be32008-01-30 16:16:14 +0000462** When the SQLITE_SYNC_DATAONLY flag is used, it means that the
drh6d2069d2007-08-14 01:58:53 +0000463** sync operation only needs to flush data to mass storage. Inode
drheb0d6292009-04-04 14:04:58 +0000464** information need not be flushed. If the lower four bits of the flag
465** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics.
466** If the lower four bits equal SQLITE_SYNC_FULL, that means
shane7ba429a2008-11-10 17:08:49 +0000467** to use Mac OS X style fullsync instead of fsync().
drh6d2069d2007-08-14 01:58:53 +0000468*/
drh6d2069d2007-08-14 01:58:53 +0000469#define SQLITE_SYNC_NORMAL 0x00002
470#define SQLITE_SYNC_FULL 0x00003
471#define SQLITE_SYNC_DATAONLY 0x00010
472
drh6d2069d2007-08-14 01:58:53 +0000473/*
drh9cd29642008-07-23 00:52:55 +0000474** CAPI3REF: OS Interface Open File Handle {H11110} <S20110>
drh6d2069d2007-08-14 01:58:53 +0000475**
476** An [sqlite3_file] object represents an open file in the OS
477** interface layer. Individual OS interface implementations will
478** want to subclass this object by appending additional fields
drh4ff7fa02007-09-01 18:17:21 +0000479** for their own use. The pMethods entry is a pointer to an
drhd84f9462007-08-15 11:28:56 +0000480** [sqlite3_io_methods] object that defines methods for performing
481** I/O operations on the open file.
drh6d2069d2007-08-14 01:58:53 +0000482*/
483typedef struct sqlite3_file sqlite3_file;
484struct sqlite3_file {
drh153c62c2007-08-24 03:51:33 +0000485 const struct sqlite3_io_methods *pMethods; /* Methods for an open file */
drh6d2069d2007-08-14 01:58:53 +0000486};
487
488/*
drh9cd29642008-07-23 00:52:55 +0000489** CAPI3REF: OS Interface File Virtual Methods Object {H11120} <S20110>
drh6d2069d2007-08-14 01:58:53 +0000490**
drh4766b292008-06-26 02:53:02 +0000491** Every file opened by the [sqlite3_vfs] xOpen method populates an
492** [sqlite3_file] object (or, more commonly, a subclass of the
493** [sqlite3_file] object) with a pointer to an instance of this object.
494** This object defines the methods used to perform various operations
495** against the open file represented by the [sqlite3_file] object.
drhd84f9462007-08-15 11:28:56 +0000496**
drhfddfa2d2007-12-05 18:05:16 +0000497** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or
498** [SQLITE_SYNC_FULL]. The first choice is the normal fsync().
shane7ba429a2008-11-10 17:08:49 +0000499** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY]
mihailim362cc832008-06-21 06:16:42 +0000500** flag may be ORed in to indicate that only the data of the file
501** and not its inode needs to be synced.
mihailima3f64902008-06-21 13:35:56 +0000502**
drhd84f9462007-08-15 11:28:56 +0000503** The integer values to xLock() and xUnlock() are one of
drh4ff7fa02007-09-01 18:17:21 +0000504** <ul>
505** <li> [SQLITE_LOCK_NONE],
drh79491ab2007-09-04 12:00:00 +0000506** <li> [SQLITE_LOCK_SHARED],
drh4ff7fa02007-09-01 18:17:21 +0000507** <li> [SQLITE_LOCK_RESERVED],
508** <li> [SQLITE_LOCK_PENDING], or
509** <li> [SQLITE_LOCK_EXCLUSIVE].
510** </ul>
mihailima3f64902008-06-21 13:35:56 +0000511** xLock() increases the lock. xUnlock() decreases the lock.
mihailim362cc832008-06-21 06:16:42 +0000512** The xCheckReservedLock() method checks whether any database connection,
513** either in this process or in some other process, is holding a RESERVED,
drhd84f9462007-08-15 11:28:56 +0000514** PENDING, or EXCLUSIVE lock on the file. It returns true
mihailim362cc832008-06-21 06:16:42 +0000515** if such a lock exists and false otherwise.
mihailima3f64902008-06-21 13:35:56 +0000516**
drhcc6bb3e2007-08-31 16:11:35 +0000517** The xFileControl() method is a generic interface that allows custom
518** VFS implementations to directly control an open file using the
mihailim362cc832008-06-21 06:16:42 +0000519** [sqlite3_file_control()] interface. The second "op" argument is an
mihailima3f64902008-06-21 13:35:56 +0000520** integer opcode. The third argument is a generic pointer intended to
mihailim362cc832008-06-21 06:16:42 +0000521** point to a structure that may contain arguments or space in which to
drhcc6bb3e2007-08-31 16:11:35 +0000522** write return values. Potential uses for xFileControl() might be
523** functions to enable blocking locks with timeouts, to change the
524** locking strategy (for example to use dot-file locks), to inquire
drh9e33c2c2007-08-31 18:34:59 +0000525** about the status of a lock, or to break stale locks. The SQLite
mihailima3f64902008-06-21 13:35:56 +0000526** core reserves all opcodes less than 100 for its own use.
drh4ff7fa02007-09-01 18:17:21 +0000527** A [SQLITE_FCNTL_LOCKSTATE | list of opcodes] less than 100 is available.
mihailim362cc832008-06-21 06:16:42 +0000528** Applications that define a custom xFileControl method should use opcodes
drh9e33c2c2007-08-31 18:34:59 +0000529** greater than 100 to avoid conflicts.
drhd84f9462007-08-15 11:28:56 +0000530**
531** The xSectorSize() method returns the sector size of the
532** device that underlies the file. The sector size is the
533** minimum write that can be performed without disturbing
534** other bytes in the file. The xDeviceCharacteristics()
535** method returns a bit vector describing behaviors of the
536** underlying device:
537**
538** <ul>
drh4ff7fa02007-09-01 18:17:21 +0000539** <li> [SQLITE_IOCAP_ATOMIC]
540** <li> [SQLITE_IOCAP_ATOMIC512]
541** <li> [SQLITE_IOCAP_ATOMIC1K]
542** <li> [SQLITE_IOCAP_ATOMIC2K]
543** <li> [SQLITE_IOCAP_ATOMIC4K]
544** <li> [SQLITE_IOCAP_ATOMIC8K]
545** <li> [SQLITE_IOCAP_ATOMIC16K]
546** <li> [SQLITE_IOCAP_ATOMIC32K]
547** <li> [SQLITE_IOCAP_ATOMIC64K]
548** <li> [SQLITE_IOCAP_SAFE_APPEND]
549** <li> [SQLITE_IOCAP_SEQUENTIAL]
drhd84f9462007-08-15 11:28:56 +0000550** </ul>
551**
552** The SQLITE_IOCAP_ATOMIC property means that all writes of
553** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
554** mean that writes of blocks that are nnn bytes in size and
555** are aligned to an address which is an integer multiple of
556** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
557** that when data is appended to a file, the data is appended
558** first then the size of the file is extended, never the other
559** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
560** information is written to disk in the same order as calls
561** to xWrite().
drh4c17c3f2008-11-07 00:06:18 +0000562**
563** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill
564** in the unread portions of the buffer with zeros. A VFS that
565** fails to zero-fill short reads might seem to work. However,
566** failure to zero-fill short reads will eventually lead to
567** database corruption.
drh6d2069d2007-08-14 01:58:53 +0000568*/
569typedef struct sqlite3_io_methods sqlite3_io_methods;
570struct sqlite3_io_methods {
571 int iVersion;
572 int (*xClose)(sqlite3_file*);
drh79491ab2007-09-04 12:00:00 +0000573 int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst);
574 int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst);
575 int (*xTruncate)(sqlite3_file*, sqlite3_int64 size);
drh6d2069d2007-08-14 01:58:53 +0000576 int (*xSync)(sqlite3_file*, int flags);
drh79491ab2007-09-04 12:00:00 +0000577 int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize);
drh6d2069d2007-08-14 01:58:53 +0000578 int (*xLock)(sqlite3_file*, int);
579 int (*xUnlock)(sqlite3_file*, int);
danielk1977861f7452008-06-05 11:39:11 +0000580 int (*xCheckReservedLock)(sqlite3_file*, int *pResOut);
drhcc6bb3e2007-08-31 16:11:35 +0000581 int (*xFileControl)(sqlite3_file*, int op, void *pArg);
drh6d2069d2007-08-14 01:58:53 +0000582 int (*xSectorSize)(sqlite3_file*);
583 int (*xDeviceCharacteristics)(sqlite3_file*);
584 /* Additional methods may be added in future releases */
585};
586
587/*
drh9cd29642008-07-23 00:52:55 +0000588** CAPI3REF: Standard File Control Opcodes {H11310} <S30800>
drh9e33c2c2007-08-31 18:34:59 +0000589**
590** These integer constants are opcodes for the xFileControl method
mihailim362cc832008-06-21 06:16:42 +0000591** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()]
drh9e33c2c2007-08-31 18:34:59 +0000592** interface.
593**
drh33c1be32008-01-30 16:16:14 +0000594** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This
mlcreechb2799412008-03-07 03:20:31 +0000595** opcode causes the xFileControl method to write the current state of
drh9e33c2c2007-08-31 18:34:59 +0000596** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED],
597** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE])
drh33c1be32008-01-30 16:16:14 +0000598** into an integer that the pArg argument points to. This capability
drh9e33c2c2007-08-31 18:34:59 +0000599** is used during testing and only needs to be supported when SQLITE_TEST
600** is defined.
601*/
602#define SQLITE_FCNTL_LOCKSTATE 1
aswiftaebf4132008-11-21 00:10:35 +0000603#define SQLITE_GET_LOCKPROXYFILE 2
604#define SQLITE_SET_LOCKPROXYFILE 3
605#define SQLITE_LAST_ERRNO 4
drh9e33c2c2007-08-31 18:34:59 +0000606
607/*
drh9cd29642008-07-23 00:52:55 +0000608** CAPI3REF: Mutex Handle {H17110} <S20130>
drh6d2069d2007-08-14 01:58:53 +0000609**
drhd84f9462007-08-15 11:28:56 +0000610** The mutex module within SQLite defines [sqlite3_mutex] to be an
drh33c1be32008-01-30 16:16:14 +0000611** abstract type for a mutex object. The SQLite core never looks
612** at the internal representation of an [sqlite3_mutex]. It only
drhd84f9462007-08-15 11:28:56 +0000613** deals with pointers to the [sqlite3_mutex] object.
drh6bdec4a2007-08-16 19:40:16 +0000614**
615** Mutexes are created using [sqlite3_mutex_alloc()].
drh6d2069d2007-08-14 01:58:53 +0000616*/
617typedef struct sqlite3_mutex sqlite3_mutex;
618
619/*
drh9cd29642008-07-23 00:52:55 +0000620** CAPI3REF: OS Interface Object {H11140} <S20100>
drh6d2069d2007-08-14 01:58:53 +0000621**
mihailim362cc832008-06-21 06:16:42 +0000622** An instance of the sqlite3_vfs object defines the interface between
623** the SQLite core and the underlying operating system. The "vfs"
drhd84f9462007-08-15 11:28:56 +0000624** in the name of the object stands for "virtual file system".
drh6d2069d2007-08-14 01:58:53 +0000625**
mihailim362cc832008-06-21 06:16:42 +0000626** The value of the iVersion field is initially 1 but may be larger in
627** future versions of SQLite. Additional fields may be appended to this
drh4766b292008-06-26 02:53:02 +0000628** object when the iVersion value is increased. Note that the structure
629** of the sqlite3_vfs object changes in the transaction between
630** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not
631** modified.
drh6bdec4a2007-08-16 19:40:16 +0000632**
drh4ff7fa02007-09-01 18:17:21 +0000633** The szOsFile field is the size of the subclassed [sqlite3_file]
drhd84f9462007-08-15 11:28:56 +0000634** structure used by this VFS. mxPathname is the maximum length of
635** a pathname in this VFS.
636**
drhb4d58ae2008-02-21 20:17:06 +0000637** Registered sqlite3_vfs objects are kept on a linked list formed by
drh79491ab2007-09-04 12:00:00 +0000638** the pNext pointer. The [sqlite3_vfs_register()]
639** and [sqlite3_vfs_unregister()] interfaces manage this list
640** in a thread-safe way. The [sqlite3_vfs_find()] interface
drh4766b292008-06-26 02:53:02 +0000641** searches the list. Neither the application code nor the VFS
642** implementation should use the pNext pointer.
drhd84f9462007-08-15 11:28:56 +0000643**
mihailima3f64902008-06-21 13:35:56 +0000644** The pNext field is the only field in the sqlite3_vfs
drh1cc8c442007-08-24 16:08:29 +0000645** structure that SQLite will ever modify. SQLite will only access
646** or modify this field while holding a particular static mutex.
647** The application should never modify anything within the sqlite3_vfs
648** object once the object has been registered.
649**
drhd84f9462007-08-15 11:28:56 +0000650** The zName field holds the name of the VFS module. The name must
651** be unique across all VFS modules.
652**
drh032ca702008-12-10 11:44:30 +0000653** SQLite will guarantee that the zFilename parameter to xOpen
drh4766b292008-06-26 02:53:02 +0000654** is either a NULL pointer or string obtained
655** from xFullPathname(). SQLite further guarantees that
656** the string will be valid and unchanged until xClose() is
drh032ca702008-12-10 11:44:30 +0000657** called. Because of the previous sentense,
drh4766b292008-06-26 02:53:02 +0000658** the [sqlite3_file] can safely store a pointer to the
drh6d2069d2007-08-14 01:58:53 +0000659** filename if it needs to remember the filename for some reason.
drh4766b292008-06-26 02:53:02 +0000660** If the zFilename parameter is xOpen is a NULL pointer then xOpen
661** must invite its own temporary name for the file. Whenever the
662** xFilename parameter is NULL it will also be the case that the
663** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE].
drhd84f9462007-08-15 11:28:56 +0000664**
drh032ca702008-12-10 11:44:30 +0000665** The flags argument to xOpen() includes all bits set in
drhf5befa02007-12-06 02:42:07 +0000666** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()]
667** or [sqlite3_open16()] is used, then flags includes at least
drh032ca702008-12-10 11:44:30 +0000668** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE].
drh6d2069d2007-08-14 01:58:53 +0000669** If xOpen() opens a file read-only then it sets *pOutFlags to
mihailim362cc832008-06-21 06:16:42 +0000670** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set.
671**
drh032ca702008-12-10 11:44:30 +0000672** SQLite will also add one of the following flags to the xOpen()
drh6d2069d2007-08-14 01:58:53 +0000673** call, depending on the object being opened:
mihailim362cc832008-06-21 06:16:42 +0000674**
drh6d2069d2007-08-14 01:58:53 +0000675** <ul>
676** <li> [SQLITE_OPEN_MAIN_DB]
677** <li> [SQLITE_OPEN_MAIN_JOURNAL]
678** <li> [SQLITE_OPEN_TEMP_DB]
679** <li> [SQLITE_OPEN_TEMP_JOURNAL]
drh33f4e022007-09-03 15:19:34 +0000680** <li> [SQLITE_OPEN_TRANSIENT_DB]
drh6d2069d2007-08-14 01:58:53 +0000681** <li> [SQLITE_OPEN_SUBJOURNAL]
682** <li> [SQLITE_OPEN_MASTER_JOURNAL]
drh032ca702008-12-10 11:44:30 +0000683** </ul>
drhd84f9462007-08-15 11:28:56 +0000684**
drh6d2069d2007-08-14 01:58:53 +0000685** The file I/O implementation can use the object type flags to
mihailim362cc832008-06-21 06:16:42 +0000686** change the way it deals with files. For example, an application
mlcreechb2799412008-03-07 03:20:31 +0000687** that does not care about crash recovery or rollback might make
688** the open of a journal file a no-op. Writes to this journal would
mihailim362cc832008-06-21 06:16:42 +0000689** also be no-ops, and any attempt to read the journal would return
690** SQLITE_IOERR. Or the implementation might recognize that a database
691** file will be doing page-aligned sector reads and writes in a random
mlcreechb2799412008-03-07 03:20:31 +0000692** order and set up its I/O subsystem accordingly.
mihailim362cc832008-06-21 06:16:42 +0000693**
694** SQLite might also add one of the following flags to the xOpen method:
695**
drh6d2069d2007-08-14 01:58:53 +0000696** <ul>
697** <li> [SQLITE_OPEN_DELETEONCLOSE]
698** <li> [SQLITE_OPEN_EXCLUSIVE]
699** </ul>
mihailim362cc832008-06-21 06:16:42 +0000700**
drh032ca702008-12-10 11:44:30 +0000701** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be
702** deleted when it is closed. The [SQLITE_OPEN_DELETEONCLOSE]
mihailim362cc832008-06-21 06:16:42 +0000703** will be set for TEMP databases, journals and for subjournals.
mihailim04bcc002008-06-22 10:21:27 +0000704**
shane089b0a42009-05-14 03:21:28 +0000705** The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction
706** with the [SQLITE_OPEN_CREATE] flag, which are both directly
707** analogous to the O_EXCL and O_CREAT flags of the POSIX open()
708** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the
709** SQLITE_OPEN_CREATE, is used to indicate that file should always
710** be created, and that it is an error if it already exists.
711** It is <i>not</i> used to indicate the file should be opened
712** for exclusive access.
mihailim362cc832008-06-21 06:16:42 +0000713**
drh032ca702008-12-10 11:44:30 +0000714** At least szOsFile bytes of memory are allocated by SQLite
mihailim362cc832008-06-21 06:16:42 +0000715** to hold the [sqlite3_file] structure passed as the third
drh032ca702008-12-10 11:44:30 +0000716** argument to xOpen. The xOpen method does not have to
drhf5befa02007-12-06 02:42:07 +0000717** allocate the structure; it should just fill it in.
mihailim362cc832008-06-21 06:16:42 +0000718**
drh032ca702008-12-10 11:44:30 +0000719** The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS]
mihailim362cc832008-06-21 06:16:42 +0000720** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to
721** test whether a file is readable and writable, or [SQLITE_ACCESS_READ]
drh032ca702008-12-10 11:44:30 +0000722** to test whether a file is at least readable. The file can be a
drh6d2069d2007-08-14 01:58:53 +0000723** directory.
mihailim362cc832008-06-21 06:16:42 +0000724**
drh032ca702008-12-10 11:44:30 +0000725** SQLite will always allocate at least mxPathname+1 bytes for the
726** output buffer xFullPathname. The exact size of the output buffer
727** is also passed as a parameter to both methods. If the output buffer
mihailim362cc832008-06-21 06:16:42 +0000728** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is
729** handled as a fatal error by SQLite, vfs implementations should endeavor
730** to prevent this by setting mxPathname to a sufficiently large value.
731**
drhd84f9462007-08-15 11:28:56 +0000732** The xRandomness(), xSleep(), and xCurrentTime() interfaces
733** are not strictly a part of the filesystem, but they are
734** included in the VFS structure for completeness.
drh6d2069d2007-08-14 01:58:53 +0000735** The xRandomness() function attempts to return nBytes bytes
736** of good-quality randomness into zOut. The return value is
mihailim362cc832008-06-21 06:16:42 +0000737** the actual number of bytes of randomness obtained.
738** The xSleep() method causes the calling thread to sleep for at
drhd84f9462007-08-15 11:28:56 +0000739** least the number of microseconds given. The xCurrentTime()
mihailim362cc832008-06-21 06:16:42 +0000740** method returns a Julian Day Number for the current date and time.
drh032ca702008-12-10 11:44:30 +0000741**
drh6d2069d2007-08-14 01:58:53 +0000742*/
drhd84f9462007-08-15 11:28:56 +0000743typedef struct sqlite3_vfs sqlite3_vfs;
744struct sqlite3_vfs {
drh6d2069d2007-08-14 01:58:53 +0000745 int iVersion; /* Structure version number */
746 int szOsFile; /* Size of subclassed sqlite3_file */
drh6d2069d2007-08-14 01:58:53 +0000747 int mxPathname; /* Maximum file pathname length */
drhd84f9462007-08-15 11:28:56 +0000748 sqlite3_vfs *pNext; /* Next registered VFS */
drhd84f9462007-08-15 11:28:56 +0000749 const char *zName; /* Name of this virtual file system */
drh1cc8c442007-08-24 16:08:29 +0000750 void *pAppData; /* Pointer to application-specific data */
drh153c62c2007-08-24 03:51:33 +0000751 int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*,
drh6d2069d2007-08-14 01:58:53 +0000752 int flags, int *pOutFlags);
drh153c62c2007-08-24 03:51:33 +0000753 int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir);
danielk1977861f7452008-06-05 11:39:11 +0000754 int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut);
danielk1977adfb9b02007-09-17 07:02:56 +0000755 int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut);
drh153c62c2007-08-24 03:51:33 +0000756 void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename);
757 void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg);
drh1875f7a2008-12-08 18:19:17 +0000758 void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void);
drh153c62c2007-08-24 03:51:33 +0000759 void (*xDlClose)(sqlite3_vfs*, void*);
760 int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut);
761 int (*xSleep)(sqlite3_vfs*, int microseconds);
762 int (*xCurrentTime)(sqlite3_vfs*, double*);
danielk1977bcb97fe2008-06-06 15:49:29 +0000763 int (*xGetLastError)(sqlite3_vfs*, int, char *);
drhd84f9462007-08-15 11:28:56 +0000764 /* New fields may be appended in figure versions. The iVersion
drh6d2069d2007-08-14 01:58:53 +0000765 ** value will increment whenever this happens. */
766};
767
drh50d3f902007-08-27 21:10:36 +0000768/*
drh9cd29642008-07-23 00:52:55 +0000769** CAPI3REF: Flags for the xAccess VFS method {H11190} <H11140>
drh50d3f902007-08-27 21:10:36 +0000770**
drh032ca702008-12-10 11:44:30 +0000771** These integer constants can be used as the third parameter to
drhfddfa2d2007-12-05 18:05:16 +0000772** the xAccess method of an [sqlite3_vfs] object. {END} They determine
mihailim04bcc002008-06-22 10:21:27 +0000773** what kind of permissions the xAccess method is looking for.
drh032ca702008-12-10 11:44:30 +0000774** With SQLITE_ACCESS_EXISTS, the xAccess method
mihailim04bcc002008-06-22 10:21:27 +0000775** simply checks whether the file exists.
drh032ca702008-12-10 11:44:30 +0000776** With SQLITE_ACCESS_READWRITE, the xAccess method
mihailim04bcc002008-06-22 10:21:27 +0000777** checks whether the file is both readable and writable.
drh032ca702008-12-10 11:44:30 +0000778** With SQLITE_ACCESS_READ, the xAccess method
mihailim04bcc002008-06-22 10:21:27 +0000779** checks whether the file is readable.
drh50d3f902007-08-27 21:10:36 +0000780*/
danielk1977b4b47412007-08-17 15:53:36 +0000781#define SQLITE_ACCESS_EXISTS 0
782#define SQLITE_ACCESS_READWRITE 1
drh50d3f902007-08-27 21:10:36 +0000783#define SQLITE_ACCESS_READ 2
danielk1977b4b47412007-08-17 15:53:36 +0000784
drh6d2069d2007-08-14 01:58:53 +0000785/*
drh9cd29642008-07-23 00:52:55 +0000786** CAPI3REF: Initialize The SQLite Library {H10130} <S20000><S30100>
drh673299b2008-06-09 21:57:22 +0000787**
drhcb041342008-06-12 00:07:29 +0000788** The sqlite3_initialize() routine initializes the
drh4766b292008-06-26 02:53:02 +0000789** SQLite library. The sqlite3_shutdown() routine
drhcb041342008-06-12 00:07:29 +0000790** deallocates any resources that were allocated by sqlite3_initialize().
drh673299b2008-06-09 21:57:22 +0000791**
drhcb041342008-06-12 00:07:29 +0000792** A call to sqlite3_initialize() is an "effective" call if it is
793** the first time sqlite3_initialize() is invoked during the lifetime of
794** the process, or if it is the first time sqlite3_initialize() is invoked
795** following a call to sqlite3_shutdown(). Only an effective call
796** of sqlite3_initialize() does any initialization. All other calls
drh4766b292008-06-26 02:53:02 +0000797** are harmless no-ops.
drhcb041342008-06-12 00:07:29 +0000798**
drhd1a24402009-04-19 12:23:58 +0000799** A call to sqlite3_shutdown() is an "effective" call if it is the first
800** call to sqlite3_shutdown() since the last sqlite3_initialize(). Only
801** an effective call to sqlite3_shutdown() does any deinitialization.
802** All other calls to sqlite3_shutdown() are harmless no-ops.
803**
drhcb041342008-06-12 00:07:29 +0000804** Among other things, sqlite3_initialize() shall invoke
drh55b0cf02008-06-19 17:54:33 +0000805** sqlite3_os_init(). Similarly, sqlite3_shutdown()
806** shall invoke sqlite3_os_end().
drh673299b2008-06-09 21:57:22 +0000807**
drhadfae6c2008-10-10 17:26:35 +0000808** The sqlite3_initialize() routine returns [SQLITE_OK] on success.
drhce5a5a02008-06-10 17:41:44 +0000809** If for some reason, sqlite3_initialize() is unable to initialize
810** the library (perhaps it is unable to allocate a needed resource such
drhadfae6c2008-10-10 17:26:35 +0000811** as a mutex) it returns an [error code] other than [SQLITE_OK].
drh673299b2008-06-09 21:57:22 +0000812**
drhce5a5a02008-06-10 17:41:44 +0000813** The sqlite3_initialize() routine is called internally by many other
drhcb041342008-06-12 00:07:29 +0000814** SQLite interfaces so that an application usually does not need to
drhce5a5a02008-06-10 17:41:44 +0000815** invoke sqlite3_initialize() directly. For example, [sqlite3_open()]
816** calls sqlite3_initialize() so the SQLite library will be automatically
817** initialized when [sqlite3_open()] is called if it has not be initialized
drhadfae6c2008-10-10 17:26:35 +0000818** already. However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT]
drhcb041342008-06-12 00:07:29 +0000819** compile-time option, then the automatic calls to sqlite3_initialize()
820** are omitted and the application must call sqlite3_initialize() directly
821** prior to using any other SQLite interface. For maximum portability,
822** it is recommended that applications always invoke sqlite3_initialize()
823** directly prior to using any other SQLite interface. Future releases
824** of SQLite may require this. In other words, the behavior exhibited
drhadfae6c2008-10-10 17:26:35 +0000825** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the
drhcb041342008-06-12 00:07:29 +0000826** default behavior in some future release of SQLite.
drh673299b2008-06-09 21:57:22 +0000827**
drhcb041342008-06-12 00:07:29 +0000828** The sqlite3_os_init() routine does operating-system specific
829** initialization of the SQLite library. The sqlite3_os_end()
830** routine undoes the effect of sqlite3_os_init(). Typical tasks
831** performed by these routines include allocation or deallocation
832** of static resources, initialization of global variables,
833** setting up a default [sqlite3_vfs] module, or setting up
mihailima3f64902008-06-21 13:35:56 +0000834** a default configuration using [sqlite3_config()].
drh673299b2008-06-09 21:57:22 +0000835**
drhcb041342008-06-12 00:07:29 +0000836** The application should never invoke either sqlite3_os_init()
837** or sqlite3_os_end() directly. The application should only invoke
838** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init()
mihailima3f64902008-06-21 13:35:56 +0000839** interface is called automatically by sqlite3_initialize() and
drhcb041342008-06-12 00:07:29 +0000840** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate
841** implementations for sqlite3_os_init() and sqlite3_os_end()
842** are built into SQLite when it is compiled for unix, windows, or os/2.
drhadfae6c2008-10-10 17:26:35 +0000843** When built for other platforms (using the [SQLITE_OS_OTHER=1] compile-time
drhcb041342008-06-12 00:07:29 +0000844** option) the application must supply a suitable implementation for
845** sqlite3_os_init() and sqlite3_os_end(). An application-supplied
846** implementation of sqlite3_os_init() or sqlite3_os_end()
drhadfae6c2008-10-10 17:26:35 +0000847** must return [SQLITE_OK] on success and some other [error code] upon
drhcb041342008-06-12 00:07:29 +0000848** failure.
drh673299b2008-06-09 21:57:22 +0000849*/
drhce5a5a02008-06-10 17:41:44 +0000850int sqlite3_initialize(void);
drh673299b2008-06-09 21:57:22 +0000851int sqlite3_shutdown(void);
drhcb041342008-06-12 00:07:29 +0000852int sqlite3_os_init(void);
853int sqlite3_os_end(void);
drh673299b2008-06-09 21:57:22 +0000854
drhce5a5a02008-06-10 17:41:44 +0000855/*
drhadfae6c2008-10-10 17:26:35 +0000856** CAPI3REF: Configuring The SQLite Library {H14100} <S20000><S30200>
drhd5a68d32008-08-04 13:44:57 +0000857** EXPERIMENTAL
drhce5a5a02008-06-10 17:41:44 +0000858**
859** The sqlite3_config() interface is used to make global configuration
860** changes to SQLite in order to tune SQLite to the specific needs of
861** the application. The default configuration is recommended for most
862** applications and so this routine is usually not necessary. It is
863** provided to support rare applications with unusual needs.
864**
865** The sqlite3_config() interface is not threadsafe. The application
866** must insure that no other SQLite interfaces are invoked by other
867** threads while sqlite3_config() is running. Furthermore, sqlite3_config()
868** may only be invoked prior to library initialization using
869** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()].
870** Note, however, that sqlite3_config() can be called as part of the
drh40257ff2008-06-13 18:24:27 +0000871** implementation of an application-defined [sqlite3_os_init()].
drhce5a5a02008-06-10 17:41:44 +0000872**
873** The first argument to sqlite3_config() is an integer
874** [SQLITE_CONFIG_SINGLETHREAD | configuration option] that determines
875** what property of SQLite is to be configured. Subsequent arguments
876** vary depending on the [SQLITE_CONFIG_SINGLETHREAD | configuration option]
877** in the first argument.
878**
drhadfae6c2008-10-10 17:26:35 +0000879** When a configuration option is set, sqlite3_config() returns [SQLITE_OK].
mihailima3f64902008-06-21 13:35:56 +0000880** If the option is unknown or SQLite is unable to set the option
drh40257ff2008-06-13 18:24:27 +0000881** then this routine returns a non-zero [error code].
drhadfae6c2008-10-10 17:26:35 +0000882**
drh8b39db12009-02-18 18:37:58 +0000883** Requirements:
884** [H14103] [H14106] [H14120] [H14123] [H14126] [H14129] [H14132] [H14135]
885** [H14138] [H14141] [H14144] [H14147] [H14150] [H14153] [H14156] [H14159]
886** [H14162] [H14165] [H14168]
drhce5a5a02008-06-10 17:41:44 +0000887*/
shanea79c3cc2008-08-11 17:27:01 +0000888SQLITE_EXPERIMENTAL int sqlite3_config(int, ...);
drhce5a5a02008-06-10 17:41:44 +0000889
890/*
drhf8cecda2008-10-10 23:48:25 +0000891** CAPI3REF: Configure database connections {H14200} <S20000>
drhd5a68d32008-08-04 13:44:57 +0000892** EXPERIMENTAL
drh633e6d52008-07-28 19:34:53 +0000893**
894** The sqlite3_db_config() interface is used to make configuration
drh2462e322008-07-31 14:47:54 +0000895** changes to a [database connection]. The interface is similar to
896** [sqlite3_config()] except that the changes apply to a single
897** [database connection] (specified in the first argument). The
898** sqlite3_db_config() interface can only be used immediately after
899** the database connection is created using [sqlite3_open()],
900** [sqlite3_open16()], or [sqlite3_open_v2()].
901**
902** The second argument to sqlite3_db_config(D,V,...) is the
903** configuration verb - an integer code that indicates what
904** aspect of the [database connection] is being configured.
drhe9d1c722008-08-04 20:13:26 +0000905** The only choice for this value is [SQLITE_DBCONFIG_LOOKASIDE].
drh2462e322008-07-31 14:47:54 +0000906** New verbs are likely to be added in future releases of SQLite.
drhe9d1c722008-08-04 20:13:26 +0000907** Additional arguments depend on the verb.
drhf8cecda2008-10-10 23:48:25 +0000908**
drh8b39db12009-02-18 18:37:58 +0000909** Requirements:
910** [H14203] [H14206] [H14209] [H14212] [H14215]
drh633e6d52008-07-28 19:34:53 +0000911*/
shanea79c3cc2008-08-11 17:27:01 +0000912SQLITE_EXPERIMENTAL int sqlite3_db_config(sqlite3*, int op, ...);
drh633e6d52008-07-28 19:34:53 +0000913
914/*
drh9cd29642008-07-23 00:52:55 +0000915** CAPI3REF: Memory Allocation Routines {H10155} <S20120>
drhd5a68d32008-08-04 13:44:57 +0000916** EXPERIMENTAL
drhfec00ea2008-06-14 16:56:21 +0000917**
918** An instance of this object defines the interface between SQLite
mihailima3f64902008-06-21 13:35:56 +0000919** and low-level memory allocation routines.
drhfec00ea2008-06-14 16:56:21 +0000920**
921** This object is used in only one place in the SQLite interface.
922** A pointer to an instance of this object is the argument to
drh4766b292008-06-26 02:53:02 +0000923** [sqlite3_config()] when the configuration option is
drhfec00ea2008-06-14 16:56:21 +0000924** [SQLITE_CONFIG_MALLOC]. By creating an instance of this object
drh4766b292008-06-26 02:53:02 +0000925** and passing it to [sqlite3_config()] during configuration, an
drhfec00ea2008-06-14 16:56:21 +0000926** application can specify an alternative memory allocation subsystem
927** for SQLite to use for all of its dynamic memory needs.
928**
929** Note that SQLite comes with a built-in memory allocator that is
930** perfectly adequate for the overwhelming majority of applications
931** and that this object is only useful to a tiny minority of applications
932** with specialized memory allocation requirements. This object is
933** also used during testing of SQLite in order to specify an alternative
934** memory allocator that simulates memory out-of-memory conditions in
935** order to verify that SQLite recovers gracefully from such
936** conditions.
937**
drh4766b292008-06-26 02:53:02 +0000938** The xMalloc, xFree, and xRealloc methods must work like the
drhfec00ea2008-06-14 16:56:21 +0000939** malloc(), free(), and realloc() functions from the standard library.
940**
941** xSize should return the allocated size of a memory allocation
942** previously obtained from xMalloc or xRealloc. The allocated size
943** is always at least as big as the requested size but may be larger.
944**
945** The xRoundup method returns what would be the allocated size of
946** a memory allocation given a particular requested size. Most memory
947** allocators round up memory allocations at least to the next multiple
mihailima3f64902008-06-21 13:35:56 +0000948** of 8. Some allocators round up to a larger multiple or to a power of 2.
drhe5ae5732008-06-15 02:51:47 +0000949**
drhfec00ea2008-06-14 16:56:21 +0000950** The xInit method initializes the memory allocator. (For example,
951** it might allocate any require mutexes or initialize internal data
952** structures. The xShutdown method is invoked (indirectly) by
953** [sqlite3_shutdown()] and should deallocate any resources acquired
954** by xInit. The pAppData pointer is used as the only parameter to
955** xInit and xShutdown.
956*/
957typedef struct sqlite3_mem_methods sqlite3_mem_methods;
958struct sqlite3_mem_methods {
959 void *(*xMalloc)(int); /* Memory allocation function */
960 void (*xFree)(void*); /* Free a prior allocation */
961 void *(*xRealloc)(void*,int); /* Resize an allocation */
962 int (*xSize)(void*); /* Return the size of an allocation */
963 int (*xRoundup)(int); /* Round up request size to allocation size */
964 int (*xInit)(void*); /* Initialize the memory allocator */
965 void (*xShutdown)(void*); /* Deinitialize the memory allocator */
966 void *pAppData; /* Argument to xInit() and xShutdown() */
967};
968
969/*
drh9cd29642008-07-23 00:52:55 +0000970** CAPI3REF: Configuration Options {H10160} <S20000>
drhd5a68d32008-08-04 13:44:57 +0000971** EXPERIMENTAL
drhce5a5a02008-06-10 17:41:44 +0000972**
973** These constants are the available integer configuration options that
974** can be passed as the first argument to the [sqlite3_config()] interface.
mihailima3f64902008-06-21 13:35:56 +0000975**
drha911abe2008-07-16 13:29:51 +0000976** New configuration options may be added in future releases of SQLite.
977** Existing configuration options might be discontinued. Applications
978** should check the return code from [sqlite3_config()] to make sure that
979** the call worked. The [sqlite3_config()] interface will return a
980** non-zero [error code] if a discontinued or unsupported configuration option
981** is invoked.
982**
drhce5a5a02008-06-10 17:41:44 +0000983** <dl>
984** <dt>SQLITE_CONFIG_SINGLETHREAD</dt>
985** <dd>There are no arguments to this option. This option disables
986** all mutexing and puts SQLite into a mode where it can only be used
987** by a single thread.</dd>
988**
989** <dt>SQLITE_CONFIG_MULTITHREAD</dt>
990** <dd>There are no arguments to this option. This option disables
991** mutexing on [database connection] and [prepared statement] objects.
992** The application is responsible for serializing access to
993** [database connections] and [prepared statements]. But other mutexes
994** are enabled so that SQLite will be safe to use in a multi-threaded
drhafacce02008-09-02 21:35:03 +0000995** environment as long as no two threads attempt to use the same
996** [database connection] at the same time. See the [threading mode]
997** documentation for additional information.</dd>
drhce5a5a02008-06-10 17:41:44 +0000998**
999** <dt>SQLITE_CONFIG_SERIALIZED</dt>
1000** <dd>There are no arguments to this option. This option enables
1001** all mutexes including the recursive
1002** mutexes on [database connection] and [prepared statement] objects.
1003** In this mode (which is the default when SQLite is compiled with
drh4766b292008-06-26 02:53:02 +00001004** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access
drhce5a5a02008-06-10 17:41:44 +00001005** to [database connections] and [prepared statements] so that the
1006** application is free to use the same [database connection] or the
drh31d38cf2008-07-12 20:35:08 +00001007** same [prepared statement] in different threads at the same time.
drhafacce02008-09-02 21:35:03 +00001008** See the [threading mode] documentation for additional information.</dd>
drhce5a5a02008-06-10 17:41:44 +00001009**
1010** <dt>SQLITE_CONFIG_MALLOC</dt>
drhfec00ea2008-06-14 16:56:21 +00001011** <dd>This option takes a single argument which is a pointer to an
mihailimdb4f2ad2008-06-21 11:20:48 +00001012** instance of the [sqlite3_mem_methods] structure. The argument specifies
1013** alternative low-level memory allocation routines to be used in place of
drhfec00ea2008-06-14 16:56:21 +00001014** the memory allocation routines built into SQLite.</dd>
drhce5a5a02008-06-10 17:41:44 +00001015**
drh33589792008-06-18 13:27:46 +00001016** <dt>SQLITE_CONFIG_GETMALLOC</dt>
1017** <dd>This option takes a single argument which is a pointer to an
1018** instance of the [sqlite3_mem_methods] structure. The [sqlite3_mem_methods]
1019** structure is filled with the currently defined memory allocation routines.
1020** This option can be used to overload the default memory allocation
1021** routines with a wrapper that simulations memory allocation failure or
1022** tracks memory usage, for example.</dd>
1023**
drhfec00ea2008-06-14 16:56:21 +00001024** <dt>SQLITE_CONFIG_MEMSTATUS</dt>
danielk197795c232d2008-07-28 05:22:35 +00001025** <dd>This option takes single argument of type int, interpreted as a
1026** boolean, which enables or disables the collection of memory allocation
1027** statistics. When disabled, the following SQLite interfaces become
1028** non-operational:
drhce5a5a02008-06-10 17:41:44 +00001029** <ul>
1030** <li> [sqlite3_memory_used()]
1031** <li> [sqlite3_memory_highwater()]
1032** <li> [sqlite3_soft_heap_limit()]
drh0a60a382008-07-31 17:16:05 +00001033** <li> [sqlite3_status()]
drhce5a5a02008-06-10 17:41:44 +00001034** </ul>
1035** </dd>
drh33589792008-06-18 13:27:46 +00001036**
1037** <dt>SQLITE_CONFIG_SCRATCH</dt>
1038** <dd>This option specifies a static memory buffer that SQLite can use for
1039** scratch memory. There are three arguments: A pointer to the memory, the
drh9ac3fe92008-06-18 18:12:04 +00001040** size of each scratch buffer (sz), and the number of buffers (N). The sz
drh0a60a382008-07-31 17:16:05 +00001041** argument must be a multiple of 16. The sz parameter should be a few bytes
1042** larger than the actual scratch space required due internal overhead.
1043** The first
1044** argument should point to an allocation of at least sz*N bytes of memory.
drh33589792008-06-18 13:27:46 +00001045** SQLite will use no more than one scratch buffer at once per thread, so
mihailimdb4f2ad2008-06-21 11:20:48 +00001046** N should be set to the expected maximum number of threads. The sz
drh33589792008-06-18 13:27:46 +00001047** parameter should be 6 times the size of the largest database page size.
1048** Scratch buffers are used as part of the btree balance operation. If
1049** The btree balancer needs additional memory beyond what is provided by
1050** scratch buffers or if no scratch buffer space is specified, then SQLite
mihailimdb4f2ad2008-06-21 11:20:48 +00001051** goes to [sqlite3_malloc()] to obtain the memory it needs.</dd>
drh33589792008-06-18 13:27:46 +00001052**
1053** <dt>SQLITE_CONFIG_PAGECACHE</dt>
1054** <dd>This option specifies a static memory buffer that SQLite can use for
drh21614742008-11-18 19:18:08 +00001055** the database page cache with the default page cache implemenation.
1056** This configuration should not be used if an application-define page
1057** cache implementation is loaded using the SQLITE_CONFIG_PCACHE option.
1058** There are three arguments to this option: A pointer to the
mihailimdb4f2ad2008-06-21 11:20:48 +00001059** memory, the size of each page buffer (sz), and the number of pages (N).
1060** The sz argument must be a power of two between 512 and 32768. The first
drh0a60a382008-07-31 17:16:05 +00001061** argument should point to an allocation of at least sz*N bytes of memory.
mihailimdb4f2ad2008-06-21 11:20:48 +00001062** SQLite will use the memory provided by the first argument to satisfy its
1063** memory needs for the first N pages that it adds to cache. If additional
1064** page cache memory is needed beyond what is provided by this option, then
drh0a60a382008-07-31 17:16:05 +00001065** SQLite goes to [sqlite3_malloc()] for the additional storage space.
1066** The implementation might use one or more of the N buffers to hold
1067** memory accounting information. </dd>
drh33589792008-06-18 13:27:46 +00001068**
1069** <dt>SQLITE_CONFIG_HEAP</dt>
1070** <dd>This option specifies a static memory buffer that SQLite will use
1071** for all of its dynamic memory allocation needs beyond those provided
1072** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE].
1073** There are three arguments: A pointer to the memory, the number of
drh8a42cbd2008-07-10 18:13:42 +00001074** bytes in the memory buffer, and the minimum allocation size. If
1075** the first pointer (the memory pointer) is NULL, then SQLite reverts
1076** to using its default memory allocator (the system malloc() implementation),
1077** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. If the
1078** memory pointer is not NULL and either [SQLITE_ENABLE_MEMSYS3] or
1079** [SQLITE_ENABLE_MEMSYS5] are defined, then the alternative memory
drh39bf74a2009-06-09 18:02:10 +00001080** allocator is engaged to handle all of SQLites memory allocation needs.
1081** The first pointer (the memory pointer) must be aligned to an 8-byte
1082** boundary or the behavior is undefined.</dd>
drh33589792008-06-18 13:27:46 +00001083**
1084** <dt>SQLITE_CONFIG_MUTEX</dt>
1085** <dd>This option takes a single argument which is a pointer to an
mihailimdb4f2ad2008-06-21 11:20:48 +00001086** instance of the [sqlite3_mutex_methods] structure. The argument specifies
drh33589792008-06-18 13:27:46 +00001087** alternative low-level mutex routines to be used in place
1088** the mutex routines built into SQLite.</dd>
1089**
drh584ff182008-07-14 18:38:17 +00001090** <dt>SQLITE_CONFIG_GETMUTEX</dt>
drh33589792008-06-18 13:27:46 +00001091** <dd>This option takes a single argument which is a pointer to an
1092** instance of the [sqlite3_mutex_methods] structure. The
1093** [sqlite3_mutex_methods]
1094** structure is filled with the currently defined mutex routines.
1095** This option can be used to overload the default mutex allocation
1096** routines with a wrapper used to track mutex usage for performance
1097** profiling or testing, for example.</dd>
drh633e6d52008-07-28 19:34:53 +00001098**
1099** <dt>SQLITE_CONFIG_LOOKASIDE</dt>
1100** <dd>This option takes two arguments that determine the default
1101** memory allcation lookaside optimization. The first argument is the
1102** size of each lookaside buffer slot and the second is the number of
1103** slots allocated to each database connection.</dd>
1104**
drh21614742008-11-18 19:18:08 +00001105** <dt>SQLITE_CONFIG_PCACHE</dt>
1106** <dd>This option takes a single argument which is a pointer to
1107** an [sqlite3_pcache_methods] object. This object specifies the interface
1108** to a custom page cache implementation. SQLite makes a copy of the
1109** object and uses it for page cache memory allocations.</dd>
1110**
1111** <dt>SQLITE_CONFIG_GETPCACHE</dt>
1112** <dd>This option takes a single argument which is a pointer to an
1113** [sqlite3_pcache_methods] object. SQLite copies of the current
1114** page cache implementation into that object.</dd>
1115**
drh633e6d52008-07-28 19:34:53 +00001116** </dl>
mihailima3f64902008-06-21 13:35:56 +00001117*/
drh40257ff2008-06-13 18:24:27 +00001118#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */
1119#define SQLITE_CONFIG_MULTITHREAD 2 /* nil */
1120#define SQLITE_CONFIG_SERIALIZED 3 /* nil */
drhfec00ea2008-06-14 16:56:21 +00001121#define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */
drh33589792008-06-18 13:27:46 +00001122#define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */
1123#define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */
1124#define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */
1125#define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */
1126#define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */
1127#define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */
1128#define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */
shane2479de32008-11-10 18:05:35 +00001129/* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */
drh633e6d52008-07-28 19:34:53 +00001130#define SQLITE_CONFIG_LOOKASIDE 13 /* int int */
danielk1977bc2ca9e2008-11-13 14:28:28 +00001131#define SQLITE_CONFIG_PCACHE 14 /* sqlite3_pcache_methods* */
1132#define SQLITE_CONFIG_GETPCACHE 15 /* sqlite3_pcache_methods* */
danielk19772d340812008-07-24 08:20:40 +00001133
drhe9d1c722008-08-04 20:13:26 +00001134/*
1135** CAPI3REF: Configuration Options {H10170} <S20000>
1136** EXPERIMENTAL
1137**
1138** These constants are the available integer configuration options that
1139** can be passed as the second argument to the [sqlite3_db_config()] interface.
1140**
1141** New configuration options may be added in future releases of SQLite.
1142** Existing configuration options might be discontinued. Applications
1143** should check the return code from [sqlite3_db_config()] to make sure that
1144** the call worked. The [sqlite3_db_config()] interface will return a
1145** non-zero [error code] if a discontinued or unsupported configuration option
1146** is invoked.
1147**
1148** <dl>
1149** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt>
1150** <dd>This option takes three additional arguments that determine the
1151** [lookaside memory allocator] configuration for the [database connection].
1152** The first argument (the third parameter to [sqlite3_db_config()] is a
1153** pointer to a memory buffer to use for lookaside memory. The first
1154** argument may be NULL in which case SQLite will allocate the lookaside
1155** buffer itself using [sqlite3_malloc()]. The second argument is the
1156** size of each lookaside buffer slot and the third argument is the number of
1157** slots. The size of the buffer in the first argument must be greater than
1158** or equal to the product of the second and third arguments.</dd>
1159**
1160** </dl>
1161*/
1162#define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */
1163
drhce5a5a02008-06-10 17:41:44 +00001164
drh673299b2008-06-09 21:57:22 +00001165/*
drhb25f9d82008-07-23 15:40:06 +00001166** CAPI3REF: Enable Or Disable Extended Result Codes {H12200} <S10700>
drh6ed48bf2007-06-14 20:57:18 +00001167**
drh33c1be32008-01-30 16:16:14 +00001168** The sqlite3_extended_result_codes() routine enables or disables the
mihailimefc8e8a2008-06-21 16:47:09 +00001169** [extended result codes] feature of SQLite. The extended result
1170** codes are disabled by default for historical compatibility considerations.
drh6ed48bf2007-06-14 20:57:18 +00001171**
drh8b39db12009-02-18 18:37:58 +00001172** Requirements:
1173** [H12201] [H12202]
drh4ac285a2006-09-15 07:28:50 +00001174*/
1175int sqlite3_extended_result_codes(sqlite3*, int onoff);
1176
1177/*
drh9cd29642008-07-23 00:52:55 +00001178** CAPI3REF: Last Insert Rowid {H12220} <S10700>
drh6ed48bf2007-06-14 20:57:18 +00001179**
drh33c1be32008-01-30 16:16:14 +00001180** Each entry in an SQLite table has a unique 64-bit signed
drh49c3d572008-12-15 22:51:38 +00001181** integer key called the [ROWID | "rowid"]. The rowid is always available
drhfddfa2d2007-12-05 18:05:16 +00001182** as an undeclared column named ROWID, OID, or _ROWID_ as long as those
drh33c1be32008-01-30 16:16:14 +00001183** names are not also used by explicitly declared columns. If
drh49c3d572008-12-15 22:51:38 +00001184** the table has a column of type [INTEGER PRIMARY KEY] then that column
mlcreechb2799412008-03-07 03:20:31 +00001185** is another alias for the rowid.
drh6ed48bf2007-06-14 20:57:18 +00001186**
drh49c3d572008-12-15 22:51:38 +00001187** This routine returns the [rowid] of the most recent
drhf8cecda2008-10-10 23:48:25 +00001188** successful [INSERT] into the database from the [database connection]
1189** in the first argument. If no successful [INSERT]s
mihailimdb4f2ad2008-06-21 11:20:48 +00001190** have ever occurred on that database connection, zero is returned.
drh6ed48bf2007-06-14 20:57:18 +00001191**
drh49c3d572008-12-15 22:51:38 +00001192** If an [INSERT] occurs within a trigger, then the [rowid] of the inserted
mihailimdb4f2ad2008-06-21 11:20:48 +00001193** row is returned by this routine as long as the trigger is running.
1194** But once the trigger terminates, the value returned by this routine
1195** reverts to the last value inserted before the trigger fired.
drhe30f4422007-08-21 16:15:55 +00001196**
drhf8cecda2008-10-10 23:48:25 +00001197** An [INSERT] that fails due to a constraint violation is not a
1198** successful [INSERT] and does not change the value returned by this
drh33c1be32008-01-30 16:16:14 +00001199** routine. Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK,
drhdc1d9f12007-10-27 16:25:16 +00001200** and INSERT OR ABORT make no changes to the return value of this
mihailimdb4f2ad2008-06-21 11:20:48 +00001201** routine when their insertion fails. When INSERT OR REPLACE
drhdc1d9f12007-10-27 16:25:16 +00001202** encounters a constraint violation, it does not fail. The
1203** INSERT continues to completion after deleting rows that caused
1204** the constraint problem so INSERT OR REPLACE will always change
mihailimdb4f2ad2008-06-21 11:20:48 +00001205** the return value of this interface.
drhdc1d9f12007-10-27 16:25:16 +00001206**
drhf8cecda2008-10-10 23:48:25 +00001207** For the purposes of this routine, an [INSERT] is considered to
drh33c1be32008-01-30 16:16:14 +00001208** be successful even if it is subsequently rolled back.
1209**
drh8b39db12009-02-18 18:37:58 +00001210** Requirements:
1211** [H12221] [H12223]
drh33c1be32008-01-30 16:16:14 +00001212**
drh8b39db12009-02-18 18:37:58 +00001213** If a separate thread performs a new [INSERT] on the same
1214** database connection while the [sqlite3_last_insert_rowid()]
1215** function is running and thus changes the last insert [rowid],
1216** then the value returned by [sqlite3_last_insert_rowid()] is
1217** unpredictable and might not equal either the old or the new
1218** last insert [rowid].
drhaf9ff332002-01-16 21:00:27 +00001219*/
drh6d2069d2007-08-14 01:58:53 +00001220sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*);
drhaf9ff332002-01-16 21:00:27 +00001221
drhc8d30ac2002-04-12 10:08:59 +00001222/*
drh9cd29642008-07-23 00:52:55 +00001223** CAPI3REF: Count The Number Of Rows Modified {H12240} <S10600>
drh6ed48bf2007-06-14 20:57:18 +00001224**
drh33c1be32008-01-30 16:16:14 +00001225** This function returns the number of database rows that were changed
drhfddfa2d2007-12-05 18:05:16 +00001226** or inserted or deleted by the most recently completed SQL statement
mihailimdb4f2ad2008-06-21 11:20:48 +00001227** on the [database connection] specified by the first parameter.
drhf8cecda2008-10-10 23:48:25 +00001228** Only changes that are directly specified by the [INSERT], [UPDATE],
1229** or [DELETE] statement are counted. Auxiliary changes caused by
drh33c1be32008-01-30 16:16:14 +00001230** triggers are not counted. Use the [sqlite3_total_changes()] function
drh6ed48bf2007-06-14 20:57:18 +00001231** to find the total number of changes including changes caused by triggers.
1232**
drhd9c20d72009-04-29 14:33:44 +00001233** Changes to a view that are simulated by an [INSTEAD OF trigger]
1234** are not counted. Only real table changes are counted.
1235**
mlcreechb2799412008-03-07 03:20:31 +00001236** A "row change" is a change to a single row of a single table
drh33c1be32008-01-30 16:16:14 +00001237** caused by an INSERT, DELETE, or UPDATE statement. Rows that
drhd9c20d72009-04-29 14:33:44 +00001238** are changed as side effects of [REPLACE] constraint resolution,
1239** rollback, ABORT processing, [DROP TABLE], or by any other
drh33c1be32008-01-30 16:16:14 +00001240** mechanisms do not count as direct row changes.
1241**
1242** A "trigger context" is a scope of execution that begins and
drhd9c20d72009-04-29 14:33:44 +00001243** ends with the script of a [CREATE TRIGGER | trigger].
1244** Most SQL statements are
drh33c1be32008-01-30 16:16:14 +00001245** evaluated outside of any trigger. This is the "top level"
1246** trigger context. If a trigger fires from the top level, a
1247** new trigger context is entered for the duration of that one
1248** trigger. Subtriggers create subcontexts for their duration.
1249**
1250** Calling [sqlite3_exec()] or [sqlite3_step()] recursively does
1251** not create a new trigger context.
1252**
1253** This function returns the number of direct row changes in the
1254** most recent INSERT, UPDATE, or DELETE statement within the same
1255** trigger context.
1256**
mihailimdb4f2ad2008-06-21 11:20:48 +00001257** Thus, when called from the top level, this function returns the
drh33c1be32008-01-30 16:16:14 +00001258** number of changes in the most recent INSERT, UPDATE, or DELETE
mihailimdb4f2ad2008-06-21 11:20:48 +00001259** that also occurred at the top level. Within the body of a trigger,
1260** the sqlite3_changes() interface can be called to find the number of
drh930cc582007-03-28 13:07:40 +00001261** changes in the most recently completed INSERT, UPDATE, or DELETE
drhf5befa02007-12-06 02:42:07 +00001262** statement within the body of the same trigger.
mihailimdb4f2ad2008-06-21 11:20:48 +00001263** However, the number returned does not include changes
1264** caused by subtriggers since those have their own context.
drhc8d30ac2002-04-12 10:08:59 +00001265**
drhd9c20d72009-04-29 14:33:44 +00001266** See also the [sqlite3_total_changes()] interface and the
1267** [count_changes pragma].
drhe30f4422007-08-21 16:15:55 +00001268**
drh8b39db12009-02-18 18:37:58 +00001269** Requirements:
1270** [H12241] [H12243]
drh33c1be32008-01-30 16:16:14 +00001271**
drh8b39db12009-02-18 18:37:58 +00001272** If a separate thread makes changes on the same database connection
1273** while [sqlite3_changes()] is running then the value returned
1274** is unpredictable and not meaningful.
drhc8d30ac2002-04-12 10:08:59 +00001275*/
danielk1977f9d64d22004-06-19 08:18:07 +00001276int sqlite3_changes(sqlite3*);
drhc8d30ac2002-04-12 10:08:59 +00001277
rdcf146a772004-02-25 22:51:06 +00001278/*
drh9cd29642008-07-23 00:52:55 +00001279** CAPI3REF: Total Number Of Rows Modified {H12260} <S10600>
mihailimdb4f2ad2008-06-21 11:20:48 +00001280**
drhd9c20d72009-04-29 14:33:44 +00001281** This function returns the number of row changes caused by [INSERT],
1282** [UPDATE] or [DELETE] statements since the [database connection] was opened.
1283** The count includes all changes from all
1284** [CREATE TRIGGER | trigger] contexts. However,
1285** the count does not include changes used to implement [REPLACE] constraints,
1286** do rollbacks or ABORT processing, or [DROP TABLE] processing. The
drh4fb08662009-05-22 01:02:26 +00001287** count does not include rows of views that fire an [INSTEAD OF trigger],
1288** though if the INSTEAD OF trigger makes changes of its own, those changes
1289** are counted.
mihailimdb4f2ad2008-06-21 11:20:48 +00001290** The changes are counted as soon as the statement that makes them is
1291** completed (when the statement handle is passed to [sqlite3_reset()] or
drh33c1be32008-01-30 16:16:14 +00001292** [sqlite3_finalize()]).
drh6ed48bf2007-06-14 20:57:18 +00001293**
drhd9c20d72009-04-29 14:33:44 +00001294** See also the [sqlite3_changes()] interface and the
1295** [count_changes pragma].
drh33c1be32008-01-30 16:16:14 +00001296**
drh8b39db12009-02-18 18:37:58 +00001297** Requirements:
1298** [H12261] [H12263]
mihailimdb4f2ad2008-06-21 11:20:48 +00001299**
drh8b39db12009-02-18 18:37:58 +00001300** If a separate thread makes changes on the same database connection
1301** while [sqlite3_total_changes()] is running then the value
1302** returned is unpredictable and not meaningful.
rdcf146a772004-02-25 22:51:06 +00001303*/
danielk1977b28af712004-06-21 06:50:26 +00001304int sqlite3_total_changes(sqlite3*);
1305
drh6ed48bf2007-06-14 20:57:18 +00001306/*
drh9cd29642008-07-23 00:52:55 +00001307** CAPI3REF: Interrupt A Long-Running Query {H12270} <S30500>
drh6ed48bf2007-06-14 20:57:18 +00001308**
drh33c1be32008-01-30 16:16:14 +00001309** This function causes any pending database operation to abort and
1310** return at its earliest opportunity. This routine is typically
mihailimebe796c2008-06-21 20:11:17 +00001311** called in response to a user action such as pressing "Cancel"
drh4c504392000-10-16 22:06:40 +00001312** or Ctrl-C where the user wants a long query operation to halt
1313** immediately.
drh930cc582007-03-28 13:07:40 +00001314**
drh33c1be32008-01-30 16:16:14 +00001315** It is safe to call this routine from a thread different from the
1316** thread that is currently running the database operation. But it
mihailimdb4f2ad2008-06-21 11:20:48 +00001317** is not safe to call this routine with a [database connection] that
drh871f6ca2007-08-14 18:03:14 +00001318** is closed or might close before sqlite3_interrupt() returns.
drh6ed48bf2007-06-14 20:57:18 +00001319**
mihailimdb4f2ad2008-06-21 11:20:48 +00001320** If an SQL operation is very nearly finished at the time when
1321** sqlite3_interrupt() is called, then it might not have an opportunity
1322** to be interrupted and might continue to completion.
1323**
1324** An SQL operation that is interrupted will return [SQLITE_INTERRUPT].
1325** If the interrupted SQL operation is an INSERT, UPDATE, or DELETE
1326** that is inside an explicit transaction, then the entire transaction
1327** will be rolled back automatically.
1328**
drhd2b68432009-04-20 12:31:46 +00001329** The sqlite3_interrupt(D) call is in effect until all currently running
1330** SQL statements on [database connection] D complete. Any new SQL statements
1331** that are started after the sqlite3_interrupt() call and before the
1332** running statements reaches zero are interrupted as if they had been
1333** running prior to the sqlite3_interrupt() call. New SQL statements
1334** that are started after the running statement count reaches zero are
1335** not effected by the sqlite3_interrupt().
1336** A call to sqlite3_interrupt(D) that occurs when there are no running
1337** SQL statements is a no-op and has no effect on SQL statements
1338** that are started after the sqlite3_interrupt() call returns.
drh33c1be32008-01-30 16:16:14 +00001339**
drh8b39db12009-02-18 18:37:58 +00001340** Requirements:
1341** [H12271] [H12272]
drh33c1be32008-01-30 16:16:14 +00001342**
drh8b39db12009-02-18 18:37:58 +00001343** If the database connection closes while [sqlite3_interrupt()]
1344** is running then bad things will likely happen.
drh4c504392000-10-16 22:06:40 +00001345*/
danielk1977f9d64d22004-06-19 08:18:07 +00001346void sqlite3_interrupt(sqlite3*);
drh4c504392000-10-16 22:06:40 +00001347
drh6ed48bf2007-06-14 20:57:18 +00001348/*
drh9cd29642008-07-23 00:52:55 +00001349** CAPI3REF: Determine If An SQL Statement Is Complete {H10510} <S70200>
drh75897232000-05-29 14:26:00 +00001350**
drh709915d2009-04-28 04:46:41 +00001351** These routines are useful during command-line input to determine if the
1352** currently entered text seems to form a complete SQL statement or
drhf5befa02007-12-06 02:42:07 +00001353** if additional input is needed before sending the text into
drh709915d2009-04-28 04:46:41 +00001354** SQLite for parsing. These routines return 1 if the input string
drhfddfa2d2007-12-05 18:05:16 +00001355** appears to be a complete SQL statement. A statement is judged to be
drh709915d2009-04-28 04:46:41 +00001356** complete if it ends with a semicolon token and is not a prefix of a
1357** well-formed CREATE TRIGGER statement. Semicolons that are embedded within
drh33c1be32008-01-30 16:16:14 +00001358** string literals or quoted identifier names or comments are not
1359** independent tokens (they are part of the token in which they are
drh709915d2009-04-28 04:46:41 +00001360** embedded) and thus do not count as a statement terminator. Whitespace
1361** and comments that follow the final semicolon are ignored.
1362**
1363** These routines return 0 if the statement is incomplete. If a
1364** memory allocation fails, then SQLITE_NOMEM is returned.
drh33c1be32008-01-30 16:16:14 +00001365**
mihailimdb4f2ad2008-06-21 11:20:48 +00001366** These routines do not parse the SQL statements thus
1367** will not detect syntactically incorrect SQL.
drhfddfa2d2007-12-05 18:05:16 +00001368**
drh709915d2009-04-28 04:46:41 +00001369** If SQLite has not been initialized using [sqlite3_initialize()] prior
1370** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked
1371** automatically by sqlite3_complete16(). If that initialization fails,
1372** then the return value from sqlite3_complete16() will be non-zero
1373** regardless of whether or not the input SQL is complete.
1374**
drh8b39db12009-02-18 18:37:58 +00001375** Requirements: [H10511] [H10512]
drh33c1be32008-01-30 16:16:14 +00001376**
drh8b39db12009-02-18 18:37:58 +00001377** The input to [sqlite3_complete()] must be a zero-terminated
1378** UTF-8 string.
drh33c1be32008-01-30 16:16:14 +00001379**
drh8b39db12009-02-18 18:37:58 +00001380** The input to [sqlite3_complete16()] must be a zero-terminated
1381** UTF-16 string in native byte order.
drh75897232000-05-29 14:26:00 +00001382*/
danielk19776f8a5032004-05-10 10:34:51 +00001383int sqlite3_complete(const char *sql);
danielk197761de0d12004-05-27 23:56:16 +00001384int sqlite3_complete16(const void *sql);
drh75897232000-05-29 14:26:00 +00001385
drh2dfbbca2000-07-28 14:32:48 +00001386/*
drh9cd29642008-07-23 00:52:55 +00001387** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors {H12310} <S40400>
drh6ed48bf2007-06-14 20:57:18 +00001388**
mihailimdb4f2ad2008-06-21 11:20:48 +00001389** This routine sets a callback function that might be invoked whenever
1390** an attempt is made to open a database table that another thread
1391** or process has locked.
1392**
1393** If the busy callback is NULL, then [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED]
1394** is returned immediately upon encountering the lock. If the busy callback
1395** is not NULL, then the callback will be invoked with two arguments.
1396**
1397** The first argument to the handler is a copy of the void* pointer which
1398** is the third argument to sqlite3_busy_handler(). The second argument to
1399** the handler callback is the number of times that the busy handler has
1400** been invoked for this locking event. If the
drh6ed48bf2007-06-14 20:57:18 +00001401** busy callback returns 0, then no additional attempts are made to
1402** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned.
drh33c1be32008-01-30 16:16:14 +00001403** If the callback returns non-zero, then another attempt
drhfddfa2d2007-12-05 18:05:16 +00001404** is made to open the database for reading and the cycle repeats.
drh2dfbbca2000-07-28 14:32:48 +00001405**
mihailimdb4f2ad2008-06-21 11:20:48 +00001406** The presence of a busy handler does not guarantee that it will be invoked
1407** when there is lock contention. If SQLite determines that invoking the busy
1408** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY]
1409** or [SQLITE_IOERR_BLOCKED] instead of invoking the busy handler.
drh86939b52007-01-10 12:54:51 +00001410** Consider a scenario where one process is holding a read lock that
1411** it is trying to promote to a reserved lock and
1412** a second process is holding a reserved lock that it is trying
1413** to promote to an exclusive lock. The first process cannot proceed
1414** because it is blocked by the second and the second process cannot
1415** proceed because it is blocked by the first. If both processes
drhf5befa02007-12-06 02:42:07 +00001416** invoke the busy handlers, neither will make any progress. Therefore,
drh6ed48bf2007-06-14 20:57:18 +00001417** SQLite returns [SQLITE_BUSY] for the first process, hoping that this
drh86939b52007-01-10 12:54:51 +00001418** will induce the first process to release its read lock and allow
1419** the second process to proceed.
1420**
drh33c1be32008-01-30 16:16:14 +00001421** The default busy callback is NULL.
drh2dfbbca2000-07-28 14:32:48 +00001422**
drh33c1be32008-01-30 16:16:14 +00001423** The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED]
drhfddfa2d2007-12-05 18:05:16 +00001424** when SQLite is in the middle of a large transaction where all the
drh33c1be32008-01-30 16:16:14 +00001425** changes will not fit into the in-memory cache. SQLite will
drh6ed48bf2007-06-14 20:57:18 +00001426** already hold a RESERVED lock on the database file, but it needs
1427** to promote this lock to EXCLUSIVE so that it can spill cache
1428** pages into the database file without harm to concurrent
drh33c1be32008-01-30 16:16:14 +00001429** readers. If it is unable to promote the lock, then the in-memory
drh6ed48bf2007-06-14 20:57:18 +00001430** cache will be left in an inconsistent state and so the error
1431** code is promoted from the relatively benign [SQLITE_BUSY] to
drh33c1be32008-01-30 16:16:14 +00001432** the more severe [SQLITE_IOERR_BLOCKED]. This error code promotion
1433** forces an automatic rollback of the changes. See the
mihailimdb4f2ad2008-06-21 11:20:48 +00001434** <a href="/cvstrac/wiki?p=CorruptionFollowingBusyError">
drh6ed48bf2007-06-14 20:57:18 +00001435** CorruptionFollowingBusyError</a> wiki page for a discussion of why
1436** this is important.
mihailimdb4f2ad2008-06-21 11:20:48 +00001437**
1438** There can only be a single busy handler defined for each
1439** [database connection]. Setting a new busy handler clears any
1440** previously set handler. Note that calling [sqlite3_busy_timeout()]
1441** will also set or clear the busy handler.
drhd677b3d2007-08-20 22:48:41 +00001442**
drhc8075422008-09-10 13:09:23 +00001443** The busy callback should not take any actions which modify the
1444** database connection that invoked the busy handler. Any such actions
1445** result in undefined behavior.
1446**
drh8b39db12009-02-18 18:37:58 +00001447** Requirements:
1448** [H12311] [H12312] [H12314] [H12316] [H12318]
drh33c1be32008-01-30 16:16:14 +00001449**
drh8b39db12009-02-18 18:37:58 +00001450** A busy handler must not close the database connection
1451** or [prepared statement] that invoked the busy handler.
drh2dfbbca2000-07-28 14:32:48 +00001452*/
danielk1977f9d64d22004-06-19 08:18:07 +00001453int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*);
drh2dfbbca2000-07-28 14:32:48 +00001454
1455/*
drhb25f9d82008-07-23 15:40:06 +00001456** CAPI3REF: Set A Busy Timeout {H12340} <S40410>
drh6ed48bf2007-06-14 20:57:18 +00001457**
mihailimdb4f2ad2008-06-21 11:20:48 +00001458** This routine sets a [sqlite3_busy_handler | busy handler] that sleeps
1459** for a specified amount of time when a table is locked. The handler
1460** will sleep multiple times until at least "ms" milliseconds of sleeping
drh9a247912008-07-22 18:45:08 +00001461** have accumulated. {H12343} After "ms" milliseconds of sleeping,
mihailimdb4f2ad2008-06-21 11:20:48 +00001462** the handler returns 0 which causes [sqlite3_step()] to return
1463** [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED].
drh2dfbbca2000-07-28 14:32:48 +00001464**
drh33c1be32008-01-30 16:16:14 +00001465** Calling this routine with an argument less than or equal to zero
drh2dfbbca2000-07-28 14:32:48 +00001466** turns off all busy handlers.
drh6ed48bf2007-06-14 20:57:18 +00001467**
mihailimdb4f2ad2008-06-21 11:20:48 +00001468** There can only be a single busy handler for a particular
1469** [database connection] any any given moment. If another busy handler
1470** was defined (using [sqlite3_busy_handler()]) prior to calling
drh6ed48bf2007-06-14 20:57:18 +00001471** this routine, that other busy handler is cleared.
drh33c1be32008-01-30 16:16:14 +00001472**
drh8b39db12009-02-18 18:37:58 +00001473** Requirements:
1474** [H12341] [H12343] [H12344]
drh2dfbbca2000-07-28 14:32:48 +00001475*/
danielk1977f9d64d22004-06-19 08:18:07 +00001476int sqlite3_busy_timeout(sqlite3*, int ms);
drh2dfbbca2000-07-28 14:32:48 +00001477
drhe3710332000-09-29 13:30:53 +00001478/*
drh9cd29642008-07-23 00:52:55 +00001479** CAPI3REF: Convenience Routines For Running Queries {H12370} <S10000>
drh6ed48bf2007-06-14 20:57:18 +00001480**
drh33c1be32008-01-30 16:16:14 +00001481** Definition: A <b>result table</b> is memory data structure created by the
1482** [sqlite3_get_table()] interface. A result table records the
1483** complete query results from one or more queries.
drha18c5682000-10-08 22:20:57 +00001484**
drh33c1be32008-01-30 16:16:14 +00001485** The table conceptually has a number of rows and columns. But
1486** these numbers are not part of the result table itself. These
1487** numbers are obtained separately. Let N be the number of rows
1488** and M be the number of columns.
1489**
mihailimdb4f2ad2008-06-21 11:20:48 +00001490** A result table is an array of pointers to zero-terminated UTF-8 strings.
1491** There are (N+1)*M elements in the array. The first M pointers point
1492** to zero-terminated strings that contain the names of the columns.
1493** The remaining entries all point to query results. NULL values result
1494** in NULL pointers. All other values are in their UTF-8 zero-terminated
1495** string representation as returned by [sqlite3_column_text()].
drh33c1be32008-01-30 16:16:14 +00001496**
mihailimdb4f2ad2008-06-21 11:20:48 +00001497** A result table might consist of one or more memory allocations.
drh33c1be32008-01-30 16:16:14 +00001498** It is not safe to pass a result table directly to [sqlite3_free()].
1499** A result table should be deallocated using [sqlite3_free_table()].
1500**
1501** As an example of the result table format, suppose a query result
1502** is as follows:
drha18c5682000-10-08 22:20:57 +00001503**
drh8bacf972007-08-25 16:21:29 +00001504** <blockquote><pre>
drha18c5682000-10-08 22:20:57 +00001505** Name | Age
1506** -----------------------
1507** Alice | 43
1508** Bob | 28
1509** Cindy | 21
drh8bacf972007-08-25 16:21:29 +00001510** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001511**
drh33c1be32008-01-30 16:16:14 +00001512** There are two column (M==2) and three rows (N==3). Thus the
1513** result table has 8 entries. Suppose the result table is stored
1514** in an array names azResult. Then azResult holds this content:
drha18c5682000-10-08 22:20:57 +00001515**
drh8bacf972007-08-25 16:21:29 +00001516** <blockquote><pre>
1517** azResult&#91;0] = "Name";
1518** azResult&#91;1] = "Age";
1519** azResult&#91;2] = "Alice";
1520** azResult&#91;3] = "43";
1521** azResult&#91;4] = "Bob";
1522** azResult&#91;5] = "28";
1523** azResult&#91;6] = "Cindy";
1524** azResult&#91;7] = "21";
1525** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001526**
drh33c1be32008-01-30 16:16:14 +00001527** The sqlite3_get_table() function evaluates one or more
1528** semicolon-separated SQL statements in the zero-terminated UTF-8
1529** string of its 2nd parameter. It returns a result table to the
1530** pointer given in its 3rd parameter.
drha18c5682000-10-08 22:20:57 +00001531**
mihailimdb4f2ad2008-06-21 11:20:48 +00001532** After the calling function has finished using the result, it should
1533** pass the pointer to the result table to sqlite3_free_table() in order to
1534** release the memory that was malloced. Because of the way the
drh33c1be32008-01-30 16:16:14 +00001535** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling
mihailimdb4f2ad2008-06-21 11:20:48 +00001536** function must not try to call [sqlite3_free()] directly. Only
drh33c1be32008-01-30 16:16:14 +00001537** [sqlite3_free_table()] is able to release the memory properly and safely.
drhe3710332000-09-29 13:30:53 +00001538**
drh33c1be32008-01-30 16:16:14 +00001539** The sqlite3_get_table() interface is implemented as a wrapper around
1540** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access
1541** to any internal data structures of SQLite. It uses only the public
1542** interface defined here. As a consequence, errors that occur in the
1543** wrapper layer outside of the internal [sqlite3_exec()] call are not
mihailimdb4f2ad2008-06-21 11:20:48 +00001544** reflected in subsequent calls to [sqlite3_errcode()] or [sqlite3_errmsg()].
drh33c1be32008-01-30 16:16:14 +00001545**
drh8b39db12009-02-18 18:37:58 +00001546** Requirements:
1547** [H12371] [H12373] [H12374] [H12376] [H12379] [H12382]
drhe3710332000-09-29 13:30:53 +00001548*/
danielk19776f8a5032004-05-10 10:34:51 +00001549int sqlite3_get_table(
drhcf538f42008-06-27 14:51:52 +00001550 sqlite3 *db, /* An open database */
1551 const char *zSql, /* SQL to be evaluated */
1552 char ***pazResult, /* Results of the query */
1553 int *pnRow, /* Number of result rows written here */
1554 int *pnColumn, /* Number of result columns written here */
1555 char **pzErrmsg /* Error msg written here */
drhe3710332000-09-29 13:30:53 +00001556);
danielk19776f8a5032004-05-10 10:34:51 +00001557void sqlite3_free_table(char **result);
drhe3710332000-09-29 13:30:53 +00001558
drha18c5682000-10-08 22:20:57 +00001559/*
drh9cd29642008-07-23 00:52:55 +00001560** CAPI3REF: Formatted String Printing Functions {H17400} <S70000><S20000>
drh6ed48bf2007-06-14 20:57:18 +00001561**
1562** These routines are workalikes of the "printf()" family of functions
1563** from the standard C library.
1564**
drh33c1be32008-01-30 16:16:14 +00001565** The sqlite3_mprintf() and sqlite3_vmprintf() routines write their
drh6d2069d2007-08-14 01:58:53 +00001566** results into memory obtained from [sqlite3_malloc()].
drh33c1be32008-01-30 16:16:14 +00001567** The strings returned by these two routines should be
mihailim04bcc002008-06-22 10:21:27 +00001568** released by [sqlite3_free()]. Both routines return a
drh6ed48bf2007-06-14 20:57:18 +00001569** NULL pointer if [sqlite3_malloc()] is unable to allocate enough
1570** memory to hold the resulting string.
1571**
drh33c1be32008-01-30 16:16:14 +00001572** In sqlite3_snprintf() routine is similar to "snprintf()" from
drh6ed48bf2007-06-14 20:57:18 +00001573** the standard C library. The result is written into the
1574** buffer supplied as the second parameter whose size is given by
drh33c1be32008-01-30 16:16:14 +00001575** the first parameter. Note that the order of the
drh6ed48bf2007-06-14 20:57:18 +00001576** first two parameters is reversed from snprintf(). This is an
1577** historical accident that cannot be fixed without breaking
drh33c1be32008-01-30 16:16:14 +00001578** backwards compatibility. Note also that sqlite3_snprintf()
drh6ed48bf2007-06-14 20:57:18 +00001579** returns a pointer to its buffer instead of the number of
drh33c1be32008-01-30 16:16:14 +00001580** characters actually written into the buffer. We admit that
drh6ed48bf2007-06-14 20:57:18 +00001581** the number of characters written would be a more useful return
1582** value but we cannot change the implementation of sqlite3_snprintf()
1583** now without breaking compatibility.
1584**
drh33c1be32008-01-30 16:16:14 +00001585** As long as the buffer size is greater than zero, sqlite3_snprintf()
1586** guarantees that the buffer is always zero-terminated. The first
drh6ed48bf2007-06-14 20:57:18 +00001587** parameter "n" is the total size of the buffer, including space for
drh33c1be32008-01-30 16:16:14 +00001588** the zero terminator. So the longest string that can be completely
drh6ed48bf2007-06-14 20:57:18 +00001589** written will be n-1 characters.
1590**
1591** These routines all implement some additional formatting
drh4f26d6c2004-05-26 23:25:30 +00001592** options that are useful for constructing SQL statements.
shane26b34032008-05-23 17:21:09 +00001593** All of the usual printf() formatting options apply. In addition, there
drh153c62c2007-08-24 03:51:33 +00001594** is are "%q", "%Q", and "%z" options.
drh6ed48bf2007-06-14 20:57:18 +00001595**
drh33c1be32008-01-30 16:16:14 +00001596** The %q option works like %s in that it substitutes a null-terminated
drh66b89c82000-11-28 20:47:17 +00001597** string from the argument list. But %q also doubles every '\'' character.
drh33c1be32008-01-30 16:16:14 +00001598** %q is designed for use inside a string literal. By doubling each '\''
drh66b89c82000-11-28 20:47:17 +00001599** character it escapes that character and allows it to be inserted into
drha18c5682000-10-08 22:20:57 +00001600** the string.
1601**
mihailimdb4f2ad2008-06-21 11:20:48 +00001602** For example, assume the string variable zText contains text as follows:
drha18c5682000-10-08 22:20:57 +00001603**
drh6ed48bf2007-06-14 20:57:18 +00001604** <blockquote><pre>
1605** char *zText = "It's a happy day!";
1606** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001607**
drh6ed48bf2007-06-14 20:57:18 +00001608** One can use this text in an SQL statement as follows:
drha18c5682000-10-08 22:20:57 +00001609**
drh6ed48bf2007-06-14 20:57:18 +00001610** <blockquote><pre>
1611** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText);
1612** sqlite3_exec(db, zSQL, 0, 0, 0);
1613** sqlite3_free(zSQL);
1614** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001615**
1616** Because the %q format string is used, the '\'' character in zText
1617** is escaped and the SQL generated is as follows:
1618**
drh6ed48bf2007-06-14 20:57:18 +00001619** <blockquote><pre>
1620** INSERT INTO table1 VALUES('It''s a happy day!')
1621** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001622**
1623** This is correct. Had we used %s instead of %q, the generated SQL
1624** would have looked like this:
1625**
drh6ed48bf2007-06-14 20:57:18 +00001626** <blockquote><pre>
1627** INSERT INTO table1 VALUES('It's a happy day!');
1628** </pre></blockquote>
drha18c5682000-10-08 22:20:57 +00001629**
mihailimdb4f2ad2008-06-21 11:20:48 +00001630** This second example is an SQL syntax error. As a general rule you should
1631** always use %q instead of %s when inserting text into a string literal.
drh6ed48bf2007-06-14 20:57:18 +00001632**
drh33c1be32008-01-30 16:16:14 +00001633** The %Q option works like %q except it also adds single quotes around
mihailimdb4f2ad2008-06-21 11:20:48 +00001634** the outside of the total string. Additionally, if the parameter in the
1635** argument list is a NULL pointer, %Q substitutes the text "NULL" (without
mihailim04bcc002008-06-22 10:21:27 +00001636** single quotes) in place of the %Q option. So, for example, one could say:
drh6ed48bf2007-06-14 20:57:18 +00001637**
1638** <blockquote><pre>
1639** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText);
1640** sqlite3_exec(db, zSQL, 0, 0, 0);
1641** sqlite3_free(zSQL);
1642** </pre></blockquote>
1643**
1644** The code above will render a correct SQL statement in the zSQL
1645** variable even if the zText variable is a NULL pointer.
drh153c62c2007-08-24 03:51:33 +00001646**
drh33c1be32008-01-30 16:16:14 +00001647** The "%z" formatting option works exactly like "%s" with the
drh153c62c2007-08-24 03:51:33 +00001648** addition that after the string has been read and copied into
drhfddfa2d2007-12-05 18:05:16 +00001649** the result, [sqlite3_free()] is called on the input string. {END}
drh33c1be32008-01-30 16:16:14 +00001650**
drh8b39db12009-02-18 18:37:58 +00001651** Requirements:
1652** [H17403] [H17406] [H17407]
drha18c5682000-10-08 22:20:57 +00001653*/
danielk19776f8a5032004-05-10 10:34:51 +00001654char *sqlite3_mprintf(const char*,...);
1655char *sqlite3_vmprintf(const char*, va_list);
drhfeac5f82004-08-01 00:10:45 +00001656char *sqlite3_snprintf(int,char*,const char*, ...);
drh5191b7e2002-03-08 02:12:00 +00001657
drh28dd4792006-06-26 21:35:44 +00001658/*
drh9cd29642008-07-23 00:52:55 +00001659** CAPI3REF: Memory Allocation Subsystem {H17300} <S20000>
drhd84f9462007-08-15 11:28:56 +00001660**
drh33c1be32008-01-30 16:16:14 +00001661** The SQLite core uses these three routines for all of its own
1662** internal memory allocation needs. "Core" in the previous sentence
drhf5befa02007-12-06 02:42:07 +00001663** does not include operating-system specific VFS implementation. The
shane26b34032008-05-23 17:21:09 +00001664** Windows VFS uses native malloc() and free() for some operations.
drhd64621d2007-11-05 17:54:17 +00001665**
drh33c1be32008-01-30 16:16:14 +00001666** The sqlite3_malloc() routine returns a pointer to a block
drhfddfa2d2007-12-05 18:05:16 +00001667** of memory at least N bytes in length, where N is the parameter.
drh33c1be32008-01-30 16:16:14 +00001668** If sqlite3_malloc() is unable to obtain sufficient free
1669** memory, it returns a NULL pointer. If the parameter N to
drhfddfa2d2007-12-05 18:05:16 +00001670** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns
1671** a NULL pointer.
1672**
drh33c1be32008-01-30 16:16:14 +00001673** Calling sqlite3_free() with a pointer previously returned
drhfddfa2d2007-12-05 18:05:16 +00001674** by sqlite3_malloc() or sqlite3_realloc() releases that memory so
drh33c1be32008-01-30 16:16:14 +00001675** that it might be reused. The sqlite3_free() routine is
drhfddfa2d2007-12-05 18:05:16 +00001676** a no-op if is called with a NULL pointer. Passing a NULL pointer
drh33c1be32008-01-30 16:16:14 +00001677** to sqlite3_free() is harmless. After being freed, memory
drhfddfa2d2007-12-05 18:05:16 +00001678** should neither be read nor written. Even reading previously freed
1679** memory might result in a segmentation fault or other severe error.
drh33c1be32008-01-30 16:16:14 +00001680** Memory corruption, a segmentation fault, or other severe error
drhfddfa2d2007-12-05 18:05:16 +00001681** might result if sqlite3_free() is called with a non-NULL pointer that
drh7b228b32008-10-17 15:10:37 +00001682** was not obtained from sqlite3_malloc() or sqlite3_realloc().
drhfddfa2d2007-12-05 18:05:16 +00001683**
drh33c1be32008-01-30 16:16:14 +00001684** The sqlite3_realloc() interface attempts to resize a
drhfddfa2d2007-12-05 18:05:16 +00001685** prior memory allocation to be at least N bytes, where N is the
1686** second parameter. The memory allocation to be resized is the first
drh33c1be32008-01-30 16:16:14 +00001687** parameter. If the first parameter to sqlite3_realloc()
drhfddfa2d2007-12-05 18:05:16 +00001688** is a NULL pointer then its behavior is identical to calling
1689** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc().
drh33c1be32008-01-30 16:16:14 +00001690** If the second parameter to sqlite3_realloc() is zero or
drhfddfa2d2007-12-05 18:05:16 +00001691** negative then the behavior is exactly the same as calling
1692** sqlite3_free(P) where P is the first parameter to sqlite3_realloc().
mihailimdb4f2ad2008-06-21 11:20:48 +00001693** sqlite3_realloc() returns a pointer to a memory allocation
drhfddfa2d2007-12-05 18:05:16 +00001694** of at least N bytes in size or NULL if sufficient memory is unavailable.
drh33c1be32008-01-30 16:16:14 +00001695** If M is the size of the prior allocation, then min(N,M) bytes
drhfddfa2d2007-12-05 18:05:16 +00001696** of the prior allocation are copied into the beginning of buffer returned
1697** by sqlite3_realloc() and the prior allocation is freed.
drh33c1be32008-01-30 16:16:14 +00001698** If sqlite3_realloc() returns NULL, then the prior allocation
drhfddfa2d2007-12-05 18:05:16 +00001699** is not freed.
1700**
drh33c1be32008-01-30 16:16:14 +00001701** The memory returned by sqlite3_malloc() and sqlite3_realloc()
drhf5befa02007-12-06 02:42:07 +00001702** is always aligned to at least an 8 byte boundary. {END}
1703**
mihailimdb4f2ad2008-06-21 11:20:48 +00001704** The default implementation of the memory allocation subsystem uses
1705** the malloc(), realloc() and free() provided by the standard C library.
drh9a247912008-07-22 18:45:08 +00001706** {H17382} However, if SQLite is compiled with the
mihailimdb4f2ad2008-06-21 11:20:48 +00001707** SQLITE_MEMORY_SIZE=<i>NNN</i> C preprocessor macro (where <i>NNN</i>
1708** is an integer), then SQLite create a static array of at least
1709** <i>NNN</i> bytes in size and uses that array for all of its dynamic
1710** memory allocation needs. {END} Additional memory allocator options
1711** may be added in future releases.
drhd64621d2007-11-05 17:54:17 +00001712**
1713** In SQLite version 3.5.0 and 3.5.1, it was possible to define
1714** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in
1715** implementation of these routines to be omitted. That capability
mihailimdb4f2ad2008-06-21 11:20:48 +00001716** is no longer provided. Only built-in memory allocators can be used.
drh8bacf972007-08-25 16:21:29 +00001717**
shane26b34032008-05-23 17:21:09 +00001718** The Windows OS interface layer calls
drh8bacf972007-08-25 16:21:29 +00001719** the system malloc() and free() directly when converting
1720** filenames between the UTF-8 encoding used by SQLite
shane26b34032008-05-23 17:21:09 +00001721** and whatever filename encoding is used by the particular Windows
drh8bacf972007-08-25 16:21:29 +00001722** installation. Memory allocation errors are detected, but
1723** they are reported back as [SQLITE_CANTOPEN] or
1724** [SQLITE_IOERR] rather than [SQLITE_NOMEM].
drh33c1be32008-01-30 16:16:14 +00001725**
drh8b39db12009-02-18 18:37:58 +00001726** Requirements:
1727** [H17303] [H17304] [H17305] [H17306] [H17310] [H17312] [H17315] [H17318]
1728** [H17321] [H17322] [H17323]
drh33c1be32008-01-30 16:16:14 +00001729**
drh8b39db12009-02-18 18:37:58 +00001730** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()]
1731** must be either NULL or else pointers obtained from a prior
1732** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have
1733** not yet been released.
drh33c1be32008-01-30 16:16:14 +00001734**
drh8b39db12009-02-18 18:37:58 +00001735** The application must not read or write any part of
1736** a block of memory after it has been released using
1737** [sqlite3_free()] or [sqlite3_realloc()].
drh28dd4792006-06-26 21:35:44 +00001738*/
drhf3a65f72007-08-22 20:18:21 +00001739void *sqlite3_malloc(int);
1740void *sqlite3_realloc(void*, int);
drh28dd4792006-06-26 21:35:44 +00001741void sqlite3_free(void*);
1742
drh5191b7e2002-03-08 02:12:00 +00001743/*
drh9cd29642008-07-23 00:52:55 +00001744** CAPI3REF: Memory Allocator Statistics {H17370} <S30210>
drhd84f9462007-08-15 11:28:56 +00001745**
drh33c1be32008-01-30 16:16:14 +00001746** SQLite provides these two interfaces for reporting on the status
1747** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()]
mihailimdb4f2ad2008-06-21 11:20:48 +00001748** routines, which form the built-in memory allocation subsystem.
drhd84f9462007-08-15 11:28:56 +00001749**
drh8b39db12009-02-18 18:37:58 +00001750** Requirements:
1751** [H17371] [H17373] [H17374] [H17375]
drhd84f9462007-08-15 11:28:56 +00001752*/
drh153c62c2007-08-24 03:51:33 +00001753sqlite3_int64 sqlite3_memory_used(void);
1754sqlite3_int64 sqlite3_memory_highwater(int resetFlag);
drhd84f9462007-08-15 11:28:56 +00001755
1756/*
drh9cd29642008-07-23 00:52:55 +00001757** CAPI3REF: Pseudo-Random Number Generator {H17390} <S20000>
drh2fa18682008-03-19 14:15:34 +00001758**
1759** SQLite contains a high-quality pseudo-random number generator (PRNG) used to
drh49c3d572008-12-15 22:51:38 +00001760** select random [ROWID | ROWIDs] when inserting new records into a table that
1761** already uses the largest possible [ROWID]. The PRNG is also used for
drh2fa18682008-03-19 14:15:34 +00001762** the build-in random() and randomblob() SQL functions. This interface allows
shane26b34032008-05-23 17:21:09 +00001763** applications to access the same PRNG for other purposes.
drh2fa18682008-03-19 14:15:34 +00001764**
1765** A call to this routine stores N bytes of randomness into buffer P.
1766**
1767** The first time this routine is invoked (either internally or by
1768** the application) the PRNG is seeded using randomness obtained
1769** from the xRandomness method of the default [sqlite3_vfs] object.
1770** On all subsequent invocations, the pseudo-randomness is generated
1771** internally and without recourse to the [sqlite3_vfs] xRandomness
1772** method.
1773**
drh8b39db12009-02-18 18:37:58 +00001774** Requirements:
1775** [H17392]
drh2fa18682008-03-19 14:15:34 +00001776*/
1777void sqlite3_randomness(int N, void *P);
1778
1779/*
drh9cd29642008-07-23 00:52:55 +00001780** CAPI3REF: Compile-Time Authorization Callbacks {H12500} <S70100>
drhfddfa2d2007-12-05 18:05:16 +00001781**
drh33c1be32008-01-30 16:16:14 +00001782** This routine registers a authorizer callback with a particular
drhf47ce562008-03-20 18:00:49 +00001783** [database connection], supplied in the first argument.
drh6ed48bf2007-06-14 20:57:18 +00001784** The authorizer callback is invoked as SQL statements are being compiled
1785** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()],
drh33c1be32008-01-30 16:16:14 +00001786** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. At various
drh6ed48bf2007-06-14 20:57:18 +00001787** points during the compilation process, as logic is being created
1788** to perform various actions, the authorizer callback is invoked to
drhf5befa02007-12-06 02:42:07 +00001789** see if those actions are allowed. The authorizer callback should
drhf47ce562008-03-20 18:00:49 +00001790** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the
drh6ed48bf2007-06-14 20:57:18 +00001791** specific action but allow the SQL statement to continue to be
1792** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be
mihailima3f64902008-06-21 13:35:56 +00001793** rejected with an error. If the authorizer callback returns
drhf5befa02007-12-06 02:42:07 +00001794** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY]
mihailima3f64902008-06-21 13:35:56 +00001795** then the [sqlite3_prepare_v2()] or equivalent call that triggered
drh33c1be32008-01-30 16:16:14 +00001796** the authorizer will fail with an error message.
drh6ed48bf2007-06-14 20:57:18 +00001797**
drhf5befa02007-12-06 02:42:07 +00001798** When the callback returns [SQLITE_OK], that means the operation
drh33c1be32008-01-30 16:16:14 +00001799** requested is ok. When the callback returns [SQLITE_DENY], the
drhf5befa02007-12-06 02:42:07 +00001800** [sqlite3_prepare_v2()] or equivalent call that triggered the
drh33c1be32008-01-30 16:16:14 +00001801** authorizer will fail with an error message explaining that
drh959b5302009-04-30 15:59:56 +00001802** access is denied.
drh6ed48bf2007-06-14 20:57:18 +00001803**
mihailima3f64902008-06-21 13:35:56 +00001804** The first parameter to the authorizer callback is a copy of the third
1805** parameter to the sqlite3_set_authorizer() interface. The second parameter
1806** to the callback is an integer [SQLITE_COPY | action code] that specifies
1807** the particular action to be authorized. The third through sixth parameters
1808** to the callback are zero-terminated strings that contain additional
1809** details about the action to be authorized.
drh6ed48bf2007-06-14 20:57:18 +00001810**
drh959b5302009-04-30 15:59:56 +00001811** If the action code is [SQLITE_READ]
1812** and the callback returns [SQLITE_IGNORE] then the
1813** [prepared statement] statement is constructed to substitute
1814** a NULL value in place of the table column that would have
1815** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE]
1816** return can be used to deny an untrusted user access to individual
1817** columns of a table.
1818** If the action code is [SQLITE_DELETE] and the callback returns
1819** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the
1820** [truncate optimization] is disabled and all rows are deleted individually.
1821**
drhf47ce562008-03-20 18:00:49 +00001822** An authorizer is used when [sqlite3_prepare | preparing]
mihailimebe796c2008-06-21 20:11:17 +00001823** SQL statements from an untrusted source, to ensure that the SQL statements
1824** do not try to access data they are not allowed to see, or that they do not
1825** try to execute malicious statements that damage the database. For
drh6ed48bf2007-06-14 20:57:18 +00001826** example, an application may allow a user to enter arbitrary
1827** SQL queries for evaluation by a database. But the application does
1828** not want the user to be able to make arbitrary changes to the
1829** database. An authorizer could then be put in place while the
drhf47ce562008-03-20 18:00:49 +00001830** user-entered SQL is being [sqlite3_prepare | prepared] that
1831** disallows everything except [SELECT] statements.
1832**
1833** Applications that need to process SQL from untrusted sources
1834** might also consider lowering resource limits using [sqlite3_limit()]
1835** and limiting database size using the [max_page_count] [PRAGMA]
1836** in addition to using an authorizer.
drh6ed48bf2007-06-14 20:57:18 +00001837**
drh33c1be32008-01-30 16:16:14 +00001838** Only a single authorizer can be in place on a database connection
drh6ed48bf2007-06-14 20:57:18 +00001839** at a time. Each call to sqlite3_set_authorizer overrides the
drh33c1be32008-01-30 16:16:14 +00001840** previous call. Disable the authorizer by installing a NULL callback.
1841** The authorizer is disabled by default.
drh6ed48bf2007-06-14 20:57:18 +00001842**
drhc8075422008-09-10 13:09:23 +00001843** The authorizer callback must not do anything that will modify
1844** the database connection that invoked the authorizer callback.
1845** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
1846** database connections for the meaning of "modify" in this paragraph.
1847**
drh7b37c5d2008-08-12 14:51:29 +00001848** When [sqlite3_prepare_v2()] is used to prepare a statement, the
1849** statement might be reprepared during [sqlite3_step()] due to a
1850** schema change. Hence, the application should ensure that the
1851** correct authorizer callback remains in place during the [sqlite3_step()].
1852**
mihailima3f64902008-06-21 13:35:56 +00001853** Note that the authorizer callback is invoked only during
drh33c1be32008-01-30 16:16:14 +00001854** [sqlite3_prepare()] or its variants. Authorization is not
drh959b5302009-04-30 15:59:56 +00001855** performed during statement evaluation in [sqlite3_step()], unless
1856** as stated in the previous paragraph, sqlite3_step() invokes
1857** sqlite3_prepare_v2() to reprepare a statement after a schema change.
drh33c1be32008-01-30 16:16:14 +00001858**
drh8b39db12009-02-18 18:37:58 +00001859** Requirements:
1860** [H12501] [H12502] [H12503] [H12504] [H12505] [H12506] [H12507] [H12510]
1861** [H12511] [H12512] [H12520] [H12521] [H12522]
drhed6c8672003-01-12 18:02:16 +00001862*/
danielk19776f8a5032004-05-10 10:34:51 +00001863int sqlite3_set_authorizer(
danielk1977f9d64d22004-06-19 08:18:07 +00001864 sqlite3*,
drhe22a3342003-04-22 20:30:37 +00001865 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
drhe5f9c642003-01-13 23:27:31 +00001866 void *pUserData
drhed6c8672003-01-12 18:02:16 +00001867);
1868
1869/*
drh9cd29642008-07-23 00:52:55 +00001870** CAPI3REF: Authorizer Return Codes {H12590} <H12500>
drh6ed48bf2007-06-14 20:57:18 +00001871**
1872** The [sqlite3_set_authorizer | authorizer callback function] must
1873** return either [SQLITE_OK] or one of these two constants in order
1874** to signal SQLite whether or not the action is permitted. See the
1875** [sqlite3_set_authorizer | authorizer documentation] for additional
1876** information.
1877*/
1878#define SQLITE_DENY 1 /* Abort the SQL statement with an error */
1879#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
1880
1881/*
drh9cd29642008-07-23 00:52:55 +00001882** CAPI3REF: Authorizer Action Codes {H12550} <H12500>
drh6ed48bf2007-06-14 20:57:18 +00001883**
1884** The [sqlite3_set_authorizer()] interface registers a callback function
mihailima3f64902008-06-21 13:35:56 +00001885** that is invoked to authorize certain SQL statement actions. The
drh6ed48bf2007-06-14 20:57:18 +00001886** second parameter to the callback is an integer code that specifies
1887** what action is being authorized. These are the integer action codes that
drh33c1be32008-01-30 16:16:14 +00001888** the authorizer callback may be passed.
drh6ed48bf2007-06-14 20:57:18 +00001889**
mihailima3f64902008-06-21 13:35:56 +00001890** These action code values signify what kind of operation is to be
drh33c1be32008-01-30 16:16:14 +00001891** authorized. The 3rd and 4th parameters to the authorization
drhf5befa02007-12-06 02:42:07 +00001892** callback function will be parameters or NULL depending on which of these
drh33c1be32008-01-30 16:16:14 +00001893** codes is used as the second parameter. The 5th parameter to the
mihailima3f64902008-06-21 13:35:56 +00001894** authorizer callback is the name of the database ("main", "temp",
drh33c1be32008-01-30 16:16:14 +00001895** etc.) if applicable. The 6th parameter to the authorizer callback
drh5cf590c2003-04-24 01:45:04 +00001896** is the name of the inner-most trigger or view that is responsible for
mihailima3f64902008-06-21 13:35:56 +00001897** the access attempt or NULL if this access attempt is directly from
drh6ed48bf2007-06-14 20:57:18 +00001898** top-level SQL code.
drh33c1be32008-01-30 16:16:14 +00001899**
drh8b39db12009-02-18 18:37:58 +00001900** Requirements:
1901** [H12551] [H12552] [H12553] [H12554]
drhed6c8672003-01-12 18:02:16 +00001902*/
drh6ed48bf2007-06-14 20:57:18 +00001903/******************************************* 3rd ************ 4th ***********/
drhe5f9c642003-01-13 23:27:31 +00001904#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */
1905#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */
1906#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */
1907#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +00001908#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00001909#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */
drh77ad4e42003-01-14 02:49:27 +00001910#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00001911#define SQLITE_CREATE_VIEW 8 /* View Name NULL */
1912#define SQLITE_DELETE 9 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +00001913#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00001914#define SQLITE_DROP_TABLE 11 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +00001915#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00001916#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +00001917#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00001918#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */
drh77ad4e42003-01-14 02:49:27 +00001919#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +00001920#define SQLITE_DROP_VIEW 17 /* View Name NULL */
1921#define SQLITE_INSERT 18 /* Table Name NULL */
1922#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */
1923#define SQLITE_READ 20 /* Table Name Column Name */
1924#define SQLITE_SELECT 21 /* NULL NULL */
danielk1977ab9b7032008-12-30 06:24:58 +00001925#define SQLITE_TRANSACTION 22 /* Operation NULL */
drhe5f9c642003-01-13 23:27:31 +00001926#define SQLITE_UPDATE 23 /* Table Name Column Name */
drh81e293b2003-06-06 19:00:42 +00001927#define SQLITE_ATTACH 24 /* Filename NULL */
1928#define SQLITE_DETACH 25 /* Database Name NULL */
danielk19771c8c23c2004-11-12 15:53:37 +00001929#define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */
danielk19771d54df82004-11-23 15:41:16 +00001930#define SQLITE_REINDEX 27 /* Index Name NULL */
drhe6e04962005-07-23 02:17:03 +00001931#define SQLITE_ANALYZE 28 /* Table Name NULL */
danielk1977f1a381e2006-06-16 08:01:02 +00001932#define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */
1933#define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */
drh2e904c52008-11-10 23:54:05 +00001934#define SQLITE_FUNCTION 31 /* NULL Function Name */
danielk1977ab9b7032008-12-30 06:24:58 +00001935#define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */
drh6ed48bf2007-06-14 20:57:18 +00001936#define SQLITE_COPY 0 /* No longer used */
drhed6c8672003-01-12 18:02:16 +00001937
1938/*
drh9cd29642008-07-23 00:52:55 +00001939** CAPI3REF: Tracing And Profiling Functions {H12280} <S60400>
drhd5a68d32008-08-04 13:44:57 +00001940** EXPERIMENTAL
drh6ed48bf2007-06-14 20:57:18 +00001941**
1942** These routines register callback functions that can be used for
1943** tracing and profiling the execution of SQL statements.
drhfddfa2d2007-12-05 18:05:16 +00001944**
drh33c1be32008-01-30 16:16:14 +00001945** The callback function registered by sqlite3_trace() is invoked at
1946** various times when an SQL statement is being run by [sqlite3_step()].
1947** The callback returns a UTF-8 rendering of the SQL statement text
1948** as the statement first begins executing. Additional callbacks occur
shane26b34032008-05-23 17:21:09 +00001949** as each triggered subprogram is entered. The callbacks for triggers
drh33c1be32008-01-30 16:16:14 +00001950** contain a UTF-8 SQL comment that identifies the trigger.
mihailima3f64902008-06-21 13:35:56 +00001951**
drh33c1be32008-01-30 16:16:14 +00001952** The callback function registered by sqlite3_profile() is invoked
1953** as each SQL statement finishes. The profile callback contains
1954** the original statement text and an estimate of wall-clock time
1955** of how long that statement took to run.
drh19e2d372005-08-29 23:00:03 +00001956**
drh8b39db12009-02-18 18:37:58 +00001957** Requirements:
1958** [H12281] [H12282] [H12283] [H12284] [H12285] [H12287] [H12288] [H12289]
1959** [H12290]
drh18de4822003-01-16 16:28:53 +00001960*/
shanea79c3cc2008-08-11 17:27:01 +00001961SQLITE_EXPERIMENTAL void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*);
1962SQLITE_EXPERIMENTAL void *sqlite3_profile(sqlite3*,
drh6d2069d2007-08-14 01:58:53 +00001963 void(*xProfile)(void*,const char*,sqlite3_uint64), void*);
drh18de4822003-01-16 16:28:53 +00001964
danielk1977348bb5d2003-10-18 09:37:26 +00001965/*
drh9cd29642008-07-23 00:52:55 +00001966** CAPI3REF: Query Progress Callbacks {H12910} <S60400>
drh6ed48bf2007-06-14 20:57:18 +00001967**
drh33c1be32008-01-30 16:16:14 +00001968** This routine configures a callback function - the
drhfddfa2d2007-12-05 18:05:16 +00001969** progress callback - that is invoked periodically during long
1970** running calls to [sqlite3_exec()], [sqlite3_step()] and
mihailima3f64902008-06-21 13:35:56 +00001971** [sqlite3_get_table()]. An example use for this
drh6ed48bf2007-06-14 20:57:18 +00001972** interface is to keep a GUI updated during a large query.
danielk1977348bb5d2003-10-18 09:37:26 +00001973**
shane236ce972008-05-30 15:35:30 +00001974** If the progress callback returns non-zero, the operation is
drh33c1be32008-01-30 16:16:14 +00001975** interrupted. This feature can be used to implement a
drhc8075422008-09-10 13:09:23 +00001976** "Cancel" button on a GUI progress dialog box.
1977**
1978** The progress handler must not do anything that will modify
1979** the database connection that invoked the progress handler.
1980** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
1981** database connections for the meaning of "modify" in this paragraph.
danielk1977348bb5d2003-10-18 09:37:26 +00001982**
drh8b39db12009-02-18 18:37:58 +00001983** Requirements:
1984** [H12911] [H12912] [H12913] [H12914] [H12915] [H12916] [H12917] [H12918]
drh33c1be32008-01-30 16:16:14 +00001985**
danielk1977348bb5d2003-10-18 09:37:26 +00001986*/
danielk1977f9d64d22004-06-19 08:18:07 +00001987void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
danielk1977348bb5d2003-10-18 09:37:26 +00001988
drhaa940ea2004-01-15 02:44:03 +00001989/*
drh9cd29642008-07-23 00:52:55 +00001990** CAPI3REF: Opening A New Database Connection {H12700} <S40200>
drhaa940ea2004-01-15 02:44:03 +00001991**
mihailima3f64902008-06-21 13:35:56 +00001992** These routines open an SQLite database file whose name is given by the
1993** filename argument. The filename argument is interpreted as UTF-8 for
1994** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte
1995** order for sqlite3_open16(). A [database connection] handle is usually
1996** returned in *ppDb, even if an error occurs. The only exception is that
1997** if SQLite is unable to allocate memory to hold the [sqlite3] object,
1998** a NULL will be written into *ppDb instead of a pointer to the [sqlite3]
1999** object. If the database is opened (and/or created) successfully, then
mihailimefc8e8a2008-06-21 16:47:09 +00002000** [SQLITE_OK] is returned. Otherwise an [error code] is returned. The
mihailima3f64902008-06-21 13:35:56 +00002001** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain
drh4f26d6c2004-05-26 23:25:30 +00002002** an English language description of the error.
drh22fbcb82004-02-01 01:22:50 +00002003**
drh33c1be32008-01-30 16:16:14 +00002004** The default encoding for the database will be UTF-8 if
mihailima3f64902008-06-21 13:35:56 +00002005** sqlite3_open() or sqlite3_open_v2() is called and
2006** UTF-16 in the native byte order if sqlite3_open16() is used.
danielk197765904932004-05-26 06:18:37 +00002007**
drh33c1be32008-01-30 16:16:14 +00002008** Whether or not an error occurs when it is opened, resources
mihailima3f64902008-06-21 13:35:56 +00002009** associated with the [database connection] handle should be released by
2010** passing it to [sqlite3_close()] when it is no longer required.
drh6d2069d2007-08-14 01:58:53 +00002011**
mihailima3f64902008-06-21 13:35:56 +00002012** The sqlite3_open_v2() interface works like sqlite3_open()
shane26b34032008-05-23 17:21:09 +00002013** except that it accepts two additional parameters for additional control
danielk19779a6284c2008-07-10 17:52:49 +00002014** over the new database connection. The flags parameter can take one of
2015** the following three values, optionally combined with the
drhafacce02008-09-02 21:35:03 +00002016** [SQLITE_OPEN_NOMUTEX] or [SQLITE_OPEN_FULLMUTEX] flags:
drh6d2069d2007-08-14 01:58:53 +00002017**
mihailima3f64902008-06-21 13:35:56 +00002018** <dl>
2019** <dt>[SQLITE_OPEN_READONLY]</dt>
2020** <dd>The database is opened in read-only mode. If the database does not
2021** already exist, an error is returned.</dd>
drh6d2069d2007-08-14 01:58:53 +00002022**
mihailima3f64902008-06-21 13:35:56 +00002023** <dt>[SQLITE_OPEN_READWRITE]</dt>
2024** <dd>The database is opened for reading and writing if possible, or reading
2025** only if the file is write protected by the operating system. In either
2026** case the database must already exist, otherwise an error is returned.</dd>
drh9da9d962007-08-28 15:47:44 +00002027**
mihailima3f64902008-06-21 13:35:56 +00002028** <dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt>
2029** <dd>The database is opened for reading and writing, and is creates it if
2030** it does not already exist. This is the behavior that is always used for
2031** sqlite3_open() and sqlite3_open16().</dd>
2032** </dl>
2033**
2034** If the 3rd parameter to sqlite3_open_v2() is not one of the
danielk19779a6284c2008-07-10 17:52:49 +00002035** combinations shown above or one of the combinations shown above combined
drhafacce02008-09-02 21:35:03 +00002036** with the [SQLITE_OPEN_NOMUTEX] or [SQLITE_OPEN_FULLMUTEX] flags,
2037** then the behavior is undefined.
danielk19779a6284c2008-07-10 17:52:49 +00002038**
drhafacce02008-09-02 21:35:03 +00002039** If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection
2040** opens in the multi-thread [threading mode] as long as the single-thread
2041** mode has not been set at compile-time or start-time. If the
2042** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens
2043** in the serialized [threading mode] unless single-thread was
2044** previously selected at compile-time or start-time.
drhd9b97cf2008-04-10 13:38:17 +00002045**
mihailima3f64902008-06-21 13:35:56 +00002046** If the filename is ":memory:", then a private, temporary in-memory database
2047** is created for the connection. This in-memory database will vanish when
2048** the database connection is closed. Future versions of SQLite might
2049** make use of additional special filenames that begin with the ":" character.
2050** It is recommended that when a database filename actually does begin with
2051** a ":" character you should prefix the filename with a pathname such as
2052** "./" to avoid ambiguity.
drh6d2069d2007-08-14 01:58:53 +00002053**
mihailima3f64902008-06-21 13:35:56 +00002054** If the filename is an empty string, then a private, temporary
drh33c1be32008-01-30 16:16:14 +00002055** on-disk database will be created. This private database will be
drh3f3b6352007-09-03 20:32:45 +00002056** automatically deleted as soon as the database connection is closed.
2057**
drh33c1be32008-01-30 16:16:14 +00002058** The fourth parameter to sqlite3_open_v2() is the name of the
mihailima3f64902008-06-21 13:35:56 +00002059** [sqlite3_vfs] object that defines the operating system interface that
2060** the new database connection should use. If the fourth parameter is
2061** a NULL pointer then the default [sqlite3_vfs] object is used.
drh6ed48bf2007-06-14 20:57:18 +00002062**
shane26b34032008-05-23 17:21:09 +00002063** <b>Note to Windows users:</b> The encoding used for the filename argument
mihailima3f64902008-06-21 13:35:56 +00002064** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever
drh9da9d962007-08-28 15:47:44 +00002065** codepage is currently defined. Filenames containing international
2066** characters must be converted to UTF-8 prior to passing them into
mihailima3f64902008-06-21 13:35:56 +00002067** sqlite3_open() or sqlite3_open_v2().
drh33c1be32008-01-30 16:16:14 +00002068**
drh8b39db12009-02-18 18:37:58 +00002069** Requirements:
2070** [H12701] [H12702] [H12703] [H12704] [H12706] [H12707] [H12709] [H12711]
2071** [H12712] [H12713] [H12714] [H12717] [H12719] [H12721] [H12723]
danielk197765904932004-05-26 06:18:37 +00002072*/
2073int sqlite3_open(
2074 const char *filename, /* Database filename (UTF-8) */
danielk19774f057f92004-06-08 00:02:33 +00002075 sqlite3 **ppDb /* OUT: SQLite db handle */
danielk197765904932004-05-26 06:18:37 +00002076);
danielk197765904932004-05-26 06:18:37 +00002077int sqlite3_open16(
2078 const void *filename, /* Database filename (UTF-16) */
danielk19774f057f92004-06-08 00:02:33 +00002079 sqlite3 **ppDb /* OUT: SQLite db handle */
danielk197765904932004-05-26 06:18:37 +00002080);
drh6d2069d2007-08-14 01:58:53 +00002081int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00002082 const char *filename, /* Database filename (UTF-8) */
drh6d2069d2007-08-14 01:58:53 +00002083 sqlite3 **ppDb, /* OUT: SQLite db handle */
2084 int flags, /* Flags */
drhd84f9462007-08-15 11:28:56 +00002085 const char *zVfs /* Name of VFS module to use */
drh6d2069d2007-08-14 01:58:53 +00002086);
danielk1977295ba552004-05-19 10:34:51 +00002087
danielk197765904932004-05-26 06:18:37 +00002088/*
drh9cd29642008-07-23 00:52:55 +00002089** CAPI3REF: Error Codes And Messages {H12800} <S60200>
drh6ed48bf2007-06-14 20:57:18 +00002090**
mihailimefc8e8a2008-06-21 16:47:09 +00002091** The sqlite3_errcode() interface returns the numeric [result code] or
2092** [extended result code] for the most recent failed sqlite3_* API call
2093** associated with a [database connection]. If a prior API call failed
2094** but the most recent API call succeeded, the return value from
drh99dfe5e2008-10-30 15:03:15 +00002095** sqlite3_errcode() is undefined. The sqlite3_extended_errcode()
2096** interface is the same except that it always returns the
2097** [extended result code] even when extended result codes are
2098** disabled.
drh6ed48bf2007-06-14 20:57:18 +00002099**
drh33c1be32008-01-30 16:16:14 +00002100** The sqlite3_errmsg() and sqlite3_errmsg16() return English-language
mihailimebe796c2008-06-21 20:11:17 +00002101** text that describes the error, as either UTF-8 or UTF-16 respectively.
drh33c1be32008-01-30 16:16:14 +00002102** Memory to hold the error message string is managed internally.
mihailimefc8e8a2008-06-21 16:47:09 +00002103** The application does not need to worry about freeing the result.
mlcreech27358862008-03-01 23:34:46 +00002104** However, the error string might be overwritten or deallocated by
drh33c1be32008-01-30 16:16:14 +00002105** subsequent calls to other SQLite interface functions.
danielk197765904932004-05-26 06:18:37 +00002106**
drh2838b472008-11-04 14:48:22 +00002107** When the serialized [threading mode] is in use, it might be the
2108** case that a second error occurs on a separate thread in between
2109** the time of the first error and the call to these interfaces.
2110** When that happens, the second error will be reported since these
2111** interfaces always report the most recent result. To avoid
2112** this, each thread can obtain exclusive use of the [database connection] D
2113** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning
2114** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after
2115** all calls to the interfaces listed here are completed.
2116**
drhd55d57e2008-07-07 17:53:07 +00002117** If an interface fails with SQLITE_MISUSE, that means the interface
2118** was invoked incorrectly by the application. In that case, the
2119** error code and message may or may not be set.
2120**
drh8b39db12009-02-18 18:37:58 +00002121** Requirements:
2122** [H12801] [H12802] [H12803] [H12807] [H12808] [H12809]
danielk197765904932004-05-26 06:18:37 +00002123*/
2124int sqlite3_errcode(sqlite3 *db);
drh99dfe5e2008-10-30 15:03:15 +00002125int sqlite3_extended_errcode(sqlite3 *db);
danielk197765904932004-05-26 06:18:37 +00002126const char *sqlite3_errmsg(sqlite3*);
danielk197765904932004-05-26 06:18:37 +00002127const void *sqlite3_errmsg16(sqlite3*);
2128
2129/*
drh9cd29642008-07-23 00:52:55 +00002130** CAPI3REF: SQL Statement Object {H13000} <H13010>
drh33c1be32008-01-30 16:16:14 +00002131** KEYWORDS: {prepared statement} {prepared statements}
drh6ed48bf2007-06-14 20:57:18 +00002132**
mihailimefc8e8a2008-06-21 16:47:09 +00002133** An instance of this object represents a single SQL statement.
2134** This object is variously known as a "prepared statement" or a
drh6ed48bf2007-06-14 20:57:18 +00002135** "compiled SQL statement" or simply as a "statement".
mihailimefc8e8a2008-06-21 16:47:09 +00002136**
drh6ed48bf2007-06-14 20:57:18 +00002137** The life of a statement object goes something like this:
2138**
2139** <ol>
2140** <li> Create the object using [sqlite3_prepare_v2()] or a related
2141** function.
mihailimefc8e8a2008-06-21 16:47:09 +00002142** <li> Bind values to [host parameters] using the sqlite3_bind_*()
2143** interfaces.
drh6ed48bf2007-06-14 20:57:18 +00002144** <li> Run the SQL by calling [sqlite3_step()] one or more times.
2145** <li> Reset the statement using [sqlite3_reset()] then go back
2146** to step 2. Do this zero or more times.
2147** <li> Destroy the object using [sqlite3_finalize()].
2148** </ol>
2149**
2150** Refer to documentation on individual methods above for additional
2151** information.
danielk197765904932004-05-26 06:18:37 +00002152*/
danielk1977fc57d7b2004-05-26 02:04:57 +00002153typedef struct sqlite3_stmt sqlite3_stmt;
2154
danielk1977e3209e42004-05-20 01:40:18 +00002155/*
drh9cd29642008-07-23 00:52:55 +00002156** CAPI3REF: Run-time Limits {H12760} <S20600>
drhcaa639f2008-03-20 00:32:20 +00002157**
2158** This interface allows the size of various constructs to be limited
2159** on a connection by connection basis. The first parameter is the
2160** [database connection] whose limit is to be set or queried. The
2161** second parameter is one of the [limit categories] that define a
2162** class of constructs to be size limited. The third parameter is the
2163** new limit for that construct. The function returns the old limit.
2164**
2165** If the new limit is a negative number, the limit is unchanged.
drhae1a8802009-02-11 15:04:40 +00002166** For the limit category of SQLITE_LIMIT_XYZ there is a
2167** [limits | hard upper bound]
2168** set by a compile-time C preprocessor macro named
2169** [limits | SQLITE_MAX_XYZ].
drhf47ce562008-03-20 18:00:49 +00002170** (The "_LIMIT_" in the name is changed to "_MAX_".)
2171** Attempts to increase a limit above its hard upper bound are
2172** silently truncated to the hard upper limit.
drhcaa639f2008-03-20 00:32:20 +00002173**
drhbb4957f2008-03-20 14:03:29 +00002174** Run time limits are intended for use in applications that manage
2175** both their own internal database and also databases that are controlled
2176** by untrusted external sources. An example application might be a
drh46f33ef2009-02-11 15:23:35 +00002177** web browser that has its own databases for storing history and
shane26b34032008-05-23 17:21:09 +00002178** separate databases controlled by JavaScript applications downloaded
shane236ce972008-05-30 15:35:30 +00002179** off the Internet. The internal databases can be given the
drhbb4957f2008-03-20 14:03:29 +00002180** large, default limits. Databases managed by external sources can
2181** be given much smaller limits designed to prevent a denial of service
mihailimefc8e8a2008-06-21 16:47:09 +00002182** attack. Developers might also want to use the [sqlite3_set_authorizer()]
drhf47ce562008-03-20 18:00:49 +00002183** interface to further control untrusted SQL. The size of the database
2184** created by an untrusted script can be contained using the
2185** [max_page_count] [PRAGMA].
drhbb4957f2008-03-20 14:03:29 +00002186**
drha911abe2008-07-16 13:29:51 +00002187** New run-time limit categories may be added in future releases.
drhcaa639f2008-03-20 00:32:20 +00002188**
drh8b39db12009-02-18 18:37:58 +00002189** Requirements:
2190** [H12762] [H12766] [H12769]
drhcaa639f2008-03-20 00:32:20 +00002191*/
2192int sqlite3_limit(sqlite3*, int id, int newVal);
2193
2194/*
drh9cd29642008-07-23 00:52:55 +00002195** CAPI3REF: Run-Time Limit Categories {H12790} <H12760>
drhcaa639f2008-03-20 00:32:20 +00002196** KEYWORDS: {limit category} {limit categories}
mihailimefc8e8a2008-06-21 16:47:09 +00002197**
drh46f33ef2009-02-11 15:23:35 +00002198** These constants define various performance limits
2199** that can be lowered at run-time using [sqlite3_limit()].
2200** The synopsis of the meanings of the various limits is shown below.
2201** Additional information is available at [limits | Limits in SQLite].
drhbb4957f2008-03-20 14:03:29 +00002202**
2203** <dl>
2204** <dt>SQLITE_LIMIT_LENGTH</dt>
mihailimefc8e8a2008-06-21 16:47:09 +00002205** <dd>The maximum size of any string or BLOB or table row.<dd>
drhbb4957f2008-03-20 14:03:29 +00002206**
2207** <dt>SQLITE_LIMIT_SQL_LENGTH</dt>
2208** <dd>The maximum length of an SQL statement.</dd>
2209**
2210** <dt>SQLITE_LIMIT_COLUMN</dt>
2211** <dd>The maximum number of columns in a table definition or in the
drh46f33ef2009-02-11 15:23:35 +00002212** result set of a [SELECT] or the maximum number of columns in an index
drhbb4957f2008-03-20 14:03:29 +00002213** or in an ORDER BY or GROUP BY clause.</dd>
2214**
2215** <dt>SQLITE_LIMIT_EXPR_DEPTH</dt>
2216** <dd>The maximum depth of the parse tree on any expression.</dd>
2217**
2218** <dt>SQLITE_LIMIT_COMPOUND_SELECT</dt>
2219** <dd>The maximum number of terms in a compound SELECT statement.</dd>
2220**
2221** <dt>SQLITE_LIMIT_VDBE_OP</dt>
2222** <dd>The maximum number of instructions in a virtual machine program
2223** used to implement an SQL statement.</dd>
2224**
2225** <dt>SQLITE_LIMIT_FUNCTION_ARG</dt>
2226** <dd>The maximum number of arguments on a function.</dd>
2227**
2228** <dt>SQLITE_LIMIT_ATTACHED</dt>
drh46f33ef2009-02-11 15:23:35 +00002229** <dd>The maximum number of [ATTACH | attached databases].</dd>
drhbb4957f2008-03-20 14:03:29 +00002230**
drhbb4957f2008-03-20 14:03:29 +00002231** <dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt>
drh46f33ef2009-02-11 15:23:35 +00002232** <dd>The maximum length of the pattern argument to the [LIKE] or
2233** [GLOB] operators.</dd>
drhbb4957f2008-03-20 14:03:29 +00002234**
2235** <dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt>
2236** <dd>The maximum number of variables in an SQL statement that can
2237** be bound.</dd>
2238** </dl>
drhcaa639f2008-03-20 00:32:20 +00002239*/
2240#define SQLITE_LIMIT_LENGTH 0
2241#define SQLITE_LIMIT_SQL_LENGTH 1
2242#define SQLITE_LIMIT_COLUMN 2
2243#define SQLITE_LIMIT_EXPR_DEPTH 3
2244#define SQLITE_LIMIT_COMPOUND_SELECT 4
2245#define SQLITE_LIMIT_VDBE_OP 5
2246#define SQLITE_LIMIT_FUNCTION_ARG 6
2247#define SQLITE_LIMIT_ATTACHED 7
drhb1a6c3c2008-03-20 16:30:17 +00002248#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8
2249#define SQLITE_LIMIT_VARIABLE_NUMBER 9
drhcaa639f2008-03-20 00:32:20 +00002250
2251/*
drh9cd29642008-07-23 00:52:55 +00002252** CAPI3REF: Compiling An SQL Statement {H13010} <S10000>
mihailimefc8e8a2008-06-21 16:47:09 +00002253** KEYWORDS: {SQL statement compiler}
danielk197765904932004-05-26 06:18:37 +00002254**
drh6ed48bf2007-06-14 20:57:18 +00002255** To execute an SQL query, it must first be compiled into a byte-code
mihailimefc8e8a2008-06-21 16:47:09 +00002256** program using one of these routines.
drh6ed48bf2007-06-14 20:57:18 +00002257**
mihailimefc8e8a2008-06-21 16:47:09 +00002258** The first argument, "db", is a [database connection] obtained from a
drh860e0772009-04-02 18:32:26 +00002259** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or
2260** [sqlite3_open16()]. The database connection must not have been closed.
mihailimefc8e8a2008-06-21 16:47:09 +00002261**
2262** The second argument, "zSql", is the statement to be compiled, encoded
drh6ed48bf2007-06-14 20:57:18 +00002263** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2()
mihailimefc8e8a2008-06-21 16:47:09 +00002264** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2()
mihailim04bcc002008-06-22 10:21:27 +00002265** use UTF-16.
drh21f06722007-07-19 12:41:39 +00002266**
mihailimefc8e8a2008-06-21 16:47:09 +00002267** If the nByte argument is less than zero, then zSql is read up to the
2268** first zero terminator. If nByte is non-negative, then it is the maximum
2269** number of bytes read from zSql. When nByte is non-negative, the
2270** zSql string ends at either the first '\000' or '\u0000' character or
drhb08c2a72008-04-16 00:28:13 +00002271** the nByte-th byte, whichever comes first. If the caller knows
danielk19773a2c8c82008-04-03 14:36:25 +00002272** that the supplied string is nul-terminated, then there is a small
mihailimefc8e8a2008-06-21 16:47:09 +00002273** performance advantage to be gained by passing an nByte parameter that
2274** is equal to the number of bytes in the input string <i>including</i>
mihailim04bcc002008-06-22 10:21:27 +00002275** the nul-terminator bytes.
danielk197765904932004-05-26 06:18:37 +00002276**
drh860e0772009-04-02 18:32:26 +00002277** If pzTail is not NULL then *pzTail is made to point to the first byte
2278** past the end of the first SQL statement in zSql. These routines only
2279** compile the first statement in zSql, so *pzTail is left pointing to
2280** what remains uncompiled.
danielk197765904932004-05-26 06:18:37 +00002281**
drh33c1be32008-01-30 16:16:14 +00002282** *ppStmt is left pointing to a compiled [prepared statement] that can be
mihailimefc8e8a2008-06-21 16:47:09 +00002283** executed using [sqlite3_step()]. If there is an error, *ppStmt is set
2284** to NULL. If the input text contains no SQL (if the input is an empty
2285** string or a comment) then *ppStmt is set to NULL.
drh860e0772009-04-02 18:32:26 +00002286** The calling procedure is responsible for deleting the compiled
mihailimefc8e8a2008-06-21 16:47:09 +00002287** SQL statement using [sqlite3_finalize()] after it has finished with it.
drh860e0772009-04-02 18:32:26 +00002288** ppStmt may not be NULL.
danielk197765904932004-05-26 06:18:37 +00002289**
mihailimefc8e8a2008-06-21 16:47:09 +00002290** On success, [SQLITE_OK] is returned, otherwise an [error code] is returned.
drh6ed48bf2007-06-14 20:57:18 +00002291**
2292** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are
2293** recommended for all new programs. The two older interfaces are retained
2294** for backwards compatibility, but their use is discouraged.
drh33c1be32008-01-30 16:16:14 +00002295** In the "v2" interfaces, the prepared statement
mihailimefc8e8a2008-06-21 16:47:09 +00002296** that is returned (the [sqlite3_stmt] object) contains a copy of the
mihailim04bcc002008-06-22 10:21:27 +00002297** original SQL text. This causes the [sqlite3_step()] interface to
drh6ed48bf2007-06-14 20:57:18 +00002298** behave a differently in two ways:
2299**
2300** <ol>
drh33c1be32008-01-30 16:16:14 +00002301** <li>
drh6ed48bf2007-06-14 20:57:18 +00002302** If the database schema changes, instead of returning [SQLITE_SCHEMA] as it
2303** always used to do, [sqlite3_step()] will automatically recompile the SQL
drh33c1be32008-01-30 16:16:14 +00002304** statement and try to run it again. If the schema has changed in
drhfddfa2d2007-12-05 18:05:16 +00002305** a way that makes the statement no longer valid, [sqlite3_step()] will still
mihailimefc8e8a2008-06-21 16:47:09 +00002306** return [SQLITE_SCHEMA]. But unlike the legacy behavior, [SQLITE_SCHEMA] is
2307** now a fatal error. Calling [sqlite3_prepare_v2()] again will not make the
drh33c1be32008-01-30 16:16:14 +00002308** error go away. Note: use [sqlite3_errmsg()] to find the text
mihailim04bcc002008-06-22 10:21:27 +00002309** of the parsing error that results in an [SQLITE_SCHEMA] return.
drh6ed48bf2007-06-14 20:57:18 +00002310** </li>
2311**
2312** <li>
mihailimefc8e8a2008-06-21 16:47:09 +00002313** When an error occurs, [sqlite3_step()] will return one of the detailed
2314** [error codes] or [extended error codes]. The legacy behavior was that
2315** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code
2316** and you would have to make a second call to [sqlite3_reset()] in order
2317** to find the underlying cause of the problem. With the "v2" prepare
2318** interfaces, the underlying reason for the error is returned immediately.
drh6ed48bf2007-06-14 20:57:18 +00002319** </li>
2320** </ol>
drh33c1be32008-01-30 16:16:14 +00002321**
drh8b39db12009-02-18 18:37:58 +00002322** Requirements:
2323** [H13011] [H13012] [H13013] [H13014] [H13015] [H13016] [H13019] [H13021]
drh33c1be32008-01-30 16:16:14 +00002324**
danielk197765904932004-05-26 06:18:37 +00002325*/
2326int sqlite3_prepare(
2327 sqlite3 *db, /* Database handle */
2328 const char *zSql, /* SQL statement, UTF-8 encoded */
drh21f06722007-07-19 12:41:39 +00002329 int nByte, /* Maximum length of zSql in bytes. */
danielk197765904932004-05-26 06:18:37 +00002330 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2331 const char **pzTail /* OUT: Pointer to unused portion of zSql */
2332);
drh6ed48bf2007-06-14 20:57:18 +00002333int sqlite3_prepare_v2(
2334 sqlite3 *db, /* Database handle */
2335 const char *zSql, /* SQL statement, UTF-8 encoded */
drh21f06722007-07-19 12:41:39 +00002336 int nByte, /* Maximum length of zSql in bytes. */
drh6ed48bf2007-06-14 20:57:18 +00002337 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2338 const char **pzTail /* OUT: Pointer to unused portion of zSql */
2339);
danielk197765904932004-05-26 06:18:37 +00002340int sqlite3_prepare16(
2341 sqlite3 *db, /* Database handle */
2342 const void *zSql, /* SQL statement, UTF-16 encoded */
drh21f06722007-07-19 12:41:39 +00002343 int nByte, /* Maximum length of zSql in bytes. */
danielk197765904932004-05-26 06:18:37 +00002344 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2345 const void **pzTail /* OUT: Pointer to unused portion of zSql */
2346);
drhb900aaf2006-11-09 00:24:53 +00002347int sqlite3_prepare16_v2(
2348 sqlite3 *db, /* Database handle */
2349 const void *zSql, /* SQL statement, UTF-16 encoded */
drh21f06722007-07-19 12:41:39 +00002350 int nByte, /* Maximum length of zSql in bytes. */
drhb900aaf2006-11-09 00:24:53 +00002351 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2352 const void **pzTail /* OUT: Pointer to unused portion of zSql */
2353);
2354
2355/*
drh25ef8f12008-10-02 14:33:56 +00002356** CAPI3REF: Retrieving Statement SQL {H13100} <H13000>
danielk1977d0e2a852007-11-14 06:48:48 +00002357**
mihailimefc8e8a2008-06-21 16:47:09 +00002358** This interface can be used to retrieve a saved copy of the original
2359** SQL text used to create a [prepared statement] if that statement was
2360** compiled using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()].
danielk1977d0e2a852007-11-14 06:48:48 +00002361**
drh8b39db12009-02-18 18:37:58 +00002362** Requirements:
2363** [H13101] [H13102] [H13103]
danielk1977d0e2a852007-11-14 06:48:48 +00002364*/
2365const char *sqlite3_sql(sqlite3_stmt *pStmt);
2366
2367/*
drhb25f9d82008-07-23 15:40:06 +00002368** CAPI3REF: Dynamically Typed Value Object {H15000} <S20200>
drhaa28e142008-03-18 13:47:20 +00002369** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value}
drh6ed48bf2007-06-14 20:57:18 +00002370**
drh33c1be32008-01-30 16:16:14 +00002371** SQLite uses the sqlite3_value object to represent all values
mihailimefc8e8a2008-06-21 16:47:09 +00002372** that can be stored in a database table. SQLite uses dynamic typing
2373** for the values it stores. Values stored in sqlite3_value objects
2374** can be integers, floating point values, strings, BLOBs, or NULL.
drhaa28e142008-03-18 13:47:20 +00002375**
2376** An sqlite3_value object may be either "protected" or "unprotected".
2377** Some interfaces require a protected sqlite3_value. Other interfaces
2378** will accept either a protected or an unprotected sqlite3_value.
mihailimefc8e8a2008-06-21 16:47:09 +00002379** Every interface that accepts sqlite3_value arguments specifies
drhaa28e142008-03-18 13:47:20 +00002380** whether or not it requires a protected sqlite3_value.
2381**
2382** The terms "protected" and "unprotected" refer to whether or not
2383** a mutex is held. A internal mutex is held for a protected
2384** sqlite3_value object but no mutex is held for an unprotected
2385** sqlite3_value object. If SQLite is compiled to be single-threaded
drh4766b292008-06-26 02:53:02 +00002386** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0)
drh4ead1482008-06-26 18:16:05 +00002387** or if SQLite is run in one of reduced mutex modes
2388** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD]
mihailimefc8e8a2008-06-21 16:47:09 +00002389** then there is no distinction between protected and unprotected
2390** sqlite3_value objects and they can be used interchangeably. However,
2391** for maximum code portability it is recommended that applications
2392** still make the distinction between between protected and unprotected
drh4ead1482008-06-26 18:16:05 +00002393** sqlite3_value objects even when not strictly required.
drhaa28e142008-03-18 13:47:20 +00002394**
2395** The sqlite3_value objects that are passed as parameters into the
mihailimefc8e8a2008-06-21 16:47:09 +00002396** implementation of [application-defined SQL functions] are protected.
drhaa28e142008-03-18 13:47:20 +00002397** The sqlite3_value object returned by
2398** [sqlite3_column_value()] is unprotected.
2399** Unprotected sqlite3_value objects may only be used with
mihailimefc8e8a2008-06-21 16:47:09 +00002400** [sqlite3_result_value()] and [sqlite3_bind_value()].
drhce5a5a02008-06-10 17:41:44 +00002401** The [sqlite3_value_blob | sqlite3_value_type()] family of
2402** interfaces require protected sqlite3_value objects.
drhf4479502004-05-27 03:12:53 +00002403*/
drhf4479502004-05-27 03:12:53 +00002404typedef struct Mem sqlite3_value;
2405
2406/*
drhb25f9d82008-07-23 15:40:06 +00002407** CAPI3REF: SQL Function Context Object {H16001} <S20200>
drh4f26d6c2004-05-26 23:25:30 +00002408**
drh6ed48bf2007-06-14 20:57:18 +00002409** The context in which an SQL function executes is stored in an
mihailimefc8e8a2008-06-21 16:47:09 +00002410** sqlite3_context object. A pointer to an sqlite3_context object
2411** is always first parameter to [application-defined SQL functions].
2412** The application-defined SQL function implementation will pass this
2413** pointer through into calls to [sqlite3_result_int | sqlite3_result()],
2414** [sqlite3_aggregate_context()], [sqlite3_user_data()],
2415** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()],
2416** and/or [sqlite3_set_auxdata()].
drh6ed48bf2007-06-14 20:57:18 +00002417*/
2418typedef struct sqlite3_context sqlite3_context;
2419
2420/*
drhb25f9d82008-07-23 15:40:06 +00002421** CAPI3REF: Binding Values To Prepared Statements {H13500} <S70300>
mihailimefc8e8a2008-06-21 16:47:09 +00002422** KEYWORDS: {host parameter} {host parameters} {host parameter name}
mihailimebe796c2008-06-21 20:11:17 +00002423** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding}
drh6ed48bf2007-06-14 20:57:18 +00002424**
mihailimefc8e8a2008-06-21 16:47:09 +00002425** In the SQL strings input to [sqlite3_prepare_v2()] and its variants,
drhaff46972009-02-12 17:07:34 +00002426** literals may be replaced by a [parameter] in one of these forms:
drh6ed48bf2007-06-14 20:57:18 +00002427**
2428** <ul>
2429** <li> ?
2430** <li> ?NNN
drh33c1be32008-01-30 16:16:14 +00002431** <li> :VVV
2432** <li> @VVV
drh6ed48bf2007-06-14 20:57:18 +00002433** <li> $VVV
2434** </ul>
2435**
2436** In the parameter forms shown above NNN is an integer literal,
mihailimefc8e8a2008-06-21 16:47:09 +00002437** and VVV is an alpha-numeric parameter name. The values of these
2438** parameters (also called "host parameter names" or "SQL parameters")
drh6ed48bf2007-06-14 20:57:18 +00002439** can be set using the sqlite3_bind_*() routines defined here.
2440**
mihailimefc8e8a2008-06-21 16:47:09 +00002441** The first argument to the sqlite3_bind_*() routines is always
2442** a pointer to the [sqlite3_stmt] object returned from
2443** [sqlite3_prepare_v2()] or its variants.
2444**
2445** The second argument is the index of the SQL parameter to be set.
2446** The leftmost SQL parameter has an index of 1. When the same named
2447** SQL parameter is used more than once, second and subsequent
2448** occurrences have the same index as the first occurrence.
drh33c1be32008-01-30 16:16:14 +00002449** The index for named parameters can be looked up using the
danielk1977c001fc32008-06-24 09:52:39 +00002450** [sqlite3_bind_parameter_index()] API if desired. The index
drhf5befa02007-12-06 02:42:07 +00002451** for "?NNN" parameters is the value of NNN.
drh4ead1482008-06-26 18:16:05 +00002452** The NNN value must be between 1 and the [sqlite3_limit()]
2453** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999).
drh6ed48bf2007-06-14 20:57:18 +00002454**
drh33c1be32008-01-30 16:16:14 +00002455** The third argument is the value to bind to the parameter.
drh6ed48bf2007-06-14 20:57:18 +00002456**
mihailimefc8e8a2008-06-21 16:47:09 +00002457** In those routines that have a fourth argument, its value is the
2458** number of bytes in the parameter. To be clear: the value is the
2459** number of <u>bytes</u> in the value, not the number of characters.
drh6ed48bf2007-06-14 20:57:18 +00002460** If the fourth parameter is negative, the length of the string is
shane26b34032008-05-23 17:21:09 +00002461** the number of bytes up to the first zero terminator.
drh4f26d6c2004-05-26 23:25:30 +00002462**
drh930cc582007-03-28 13:07:40 +00002463** The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and
drh900dfba2004-07-21 15:21:36 +00002464** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or
drh33c1be32008-01-30 16:16:14 +00002465** string after SQLite has finished with it. If the fifth argument is
2466** the special value [SQLITE_STATIC], then SQLite assumes that the
drhfddfa2d2007-12-05 18:05:16 +00002467** information is in static, unmanaged space and does not need to be freed.
drh33c1be32008-01-30 16:16:14 +00002468** If the fifth argument has the value [SQLITE_TRANSIENT], then
drhfddfa2d2007-12-05 18:05:16 +00002469** SQLite makes its own private copy of the data immediately, before
drh33c1be32008-01-30 16:16:14 +00002470** the sqlite3_bind_*() routine returns.
drh4f26d6c2004-05-26 23:25:30 +00002471**
drh33c1be32008-01-30 16:16:14 +00002472** The sqlite3_bind_zeroblob() routine binds a BLOB of length N that
mihailimefc8e8a2008-06-21 16:47:09 +00002473** is filled with zeroes. A zeroblob uses a fixed amount of memory
2474** (just an integer to hold its size) while it is being processed.
shane26b34032008-05-23 17:21:09 +00002475** Zeroblobs are intended to serve as placeholders for BLOBs whose
mihailimefc8e8a2008-06-21 16:47:09 +00002476** content is later written using
2477** [sqlite3_blob_open | incremental BLOB I/O] routines.
2478** A negative value for the zeroblob results in a zero-length BLOB.
drh6ed48bf2007-06-14 20:57:18 +00002479**
drh33c1be32008-01-30 16:16:14 +00002480** The sqlite3_bind_*() routines must be called after
drh6ed48bf2007-06-14 20:57:18 +00002481** [sqlite3_prepare_v2()] (and its variants) or [sqlite3_reset()] and
drh33c1be32008-01-30 16:16:14 +00002482** before [sqlite3_step()].
drh6ed48bf2007-06-14 20:57:18 +00002483** Bindings are not cleared by the [sqlite3_reset()] routine.
drh33c1be32008-01-30 16:16:14 +00002484** Unbound parameters are interpreted as NULL.
drh6ed48bf2007-06-14 20:57:18 +00002485**
drh33c1be32008-01-30 16:16:14 +00002486** These routines return [SQLITE_OK] on success or an error code if
2487** anything goes wrong. [SQLITE_RANGE] is returned if the parameter
shane26b34032008-05-23 17:21:09 +00002488** index is out of range. [SQLITE_NOMEM] is returned if malloc() fails.
drh33c1be32008-01-30 16:16:14 +00002489** [SQLITE_MISUSE] might be returned if these routines are called on a
drhfddfa2d2007-12-05 18:05:16 +00002490** virtual machine that is the wrong state or which has already been finalized.
drh33c1be32008-01-30 16:16:14 +00002491** Detection of misuse is unreliable. Applications should not depend
2492** on SQLITE_MISUSE returns. SQLITE_MISUSE is intended to indicate a
2493** a logic error in the application. Future versions of SQLite might
2494** panic rather than return SQLITE_MISUSE.
2495**
2496** See also: [sqlite3_bind_parameter_count()],
mihailimefc8e8a2008-06-21 16:47:09 +00002497** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()].
drh33c1be32008-01-30 16:16:14 +00002498**
drh8b39db12009-02-18 18:37:58 +00002499** Requirements:
2500** [H13506] [H13509] [H13512] [H13515] [H13518] [H13521] [H13524] [H13527]
2501** [H13530] [H13533] [H13536] [H13539] [H13542] [H13545] [H13548] [H13551]
drh33c1be32008-01-30 16:16:14 +00002502**
drh4f26d6c2004-05-26 23:25:30 +00002503*/
danielk1977d8123362004-06-12 09:25:12 +00002504int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*));
drhf4479502004-05-27 03:12:53 +00002505int sqlite3_bind_double(sqlite3_stmt*, int, double);
2506int sqlite3_bind_int(sqlite3_stmt*, int, int);
drh6d2069d2007-08-14 01:58:53 +00002507int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64);
drhf4479502004-05-27 03:12:53 +00002508int sqlite3_bind_null(sqlite3_stmt*, int);
danielk1977d8123362004-06-12 09:25:12 +00002509int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*));
2510int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*));
drhf4479502004-05-27 03:12:53 +00002511int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);
drhb026e052007-05-02 01:34:31 +00002512int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n);
drh4f26d6c2004-05-26 23:25:30 +00002513
2514/*
drhb25f9d82008-07-23 15:40:06 +00002515** CAPI3REF: Number Of SQL Parameters {H13600} <S70300>
drh6ed48bf2007-06-14 20:57:18 +00002516**
mihailimefc8e8a2008-06-21 16:47:09 +00002517** This routine can be used to find the number of [SQL parameters]
2518** in a [prepared statement]. SQL parameters are tokens of the
drh33c1be32008-01-30 16:16:14 +00002519** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as
shane26b34032008-05-23 17:21:09 +00002520** placeholders for values that are [sqlite3_bind_blob | bound]
drh33c1be32008-01-30 16:16:14 +00002521** to the parameters at a later time.
drh605264d2007-08-21 15:13:19 +00002522**
mihailim1c492652008-06-21 18:02:16 +00002523** This routine actually returns the index of the largest (rightmost)
mihailimefc8e8a2008-06-21 16:47:09 +00002524** parameter. For all forms except ?NNN, this will correspond to the
2525** number of unique parameters. If parameters of the ?NNN are used,
2526** there may be gaps in the list.
drh33c1be32008-01-30 16:16:14 +00002527**
2528** See also: [sqlite3_bind_blob|sqlite3_bind()],
2529** [sqlite3_bind_parameter_name()], and
2530** [sqlite3_bind_parameter_index()].
2531**
drh8b39db12009-02-18 18:37:58 +00002532** Requirements:
2533** [H13601]
drh75f6a032004-07-15 14:15:00 +00002534*/
2535int sqlite3_bind_parameter_count(sqlite3_stmt*);
2536
2537/*
drhb25f9d82008-07-23 15:40:06 +00002538** CAPI3REF: Name Of A Host Parameter {H13620} <S70300>
drh6ed48bf2007-06-14 20:57:18 +00002539**
drh33c1be32008-01-30 16:16:14 +00002540** This routine returns a pointer to the name of the n-th
mihailimefc8e8a2008-06-21 16:47:09 +00002541** [SQL parameter] in a [prepared statement].
drhe1b3e802008-04-27 22:29:01 +00002542** SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA"
2543** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA"
2544** respectively.
2545** In other words, the initial ":" or "$" or "@" or "?"
drh33c1be32008-01-30 16:16:14 +00002546** is included as part of the name.
mihailimefc8e8a2008-06-21 16:47:09 +00002547** Parameters of the form "?" without a following integer have no name
2548** and are also referred to as "anonymous parameters".
drh6ed48bf2007-06-14 20:57:18 +00002549**
drh33c1be32008-01-30 16:16:14 +00002550** The first host parameter has an index of 1, not 0.
drh6ed48bf2007-06-14 20:57:18 +00002551**
drh33c1be32008-01-30 16:16:14 +00002552** If the value n is out of range or if the n-th parameter is
2553** nameless, then NULL is returned. The returned string is
mihailimefc8e8a2008-06-21 16:47:09 +00002554** always in UTF-8 encoding even if the named parameter was
drhfddfa2d2007-12-05 18:05:16 +00002555** originally specified as UTF-16 in [sqlite3_prepare16()] or
2556** [sqlite3_prepare16_v2()].
drh33c1be32008-01-30 16:16:14 +00002557**
2558** See also: [sqlite3_bind_blob|sqlite3_bind()],
2559** [sqlite3_bind_parameter_count()], and
2560** [sqlite3_bind_parameter_index()].
2561**
drh8b39db12009-02-18 18:37:58 +00002562** Requirements:
2563** [H13621]
drh895d7472004-08-20 16:02:39 +00002564*/
2565const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int);
2566
2567/*
drhb25f9d82008-07-23 15:40:06 +00002568** CAPI3REF: Index Of A Parameter With A Given Name {H13640} <S70300>
drh6ed48bf2007-06-14 20:57:18 +00002569**
drh33c1be32008-01-30 16:16:14 +00002570** Return the index of an SQL parameter given its name. The
2571** index value returned is suitable for use as the second
2572** parameter to [sqlite3_bind_blob|sqlite3_bind()]. A zero
2573** is returned if no matching parameter is found. The parameter
2574** name must be given in UTF-8 even if the original statement
2575** was prepared from UTF-16 text using [sqlite3_prepare16_v2()].
2576**
2577** See also: [sqlite3_bind_blob|sqlite3_bind()],
2578** [sqlite3_bind_parameter_count()], and
2579** [sqlite3_bind_parameter_index()].
2580**
drh8b39db12009-02-18 18:37:58 +00002581** Requirements:
2582** [H13641]
drhfa6bc002004-09-07 16:19:52 +00002583*/
2584int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName);
2585
2586/*
drhb25f9d82008-07-23 15:40:06 +00002587** CAPI3REF: Reset All Bindings On A Prepared Statement {H13660} <S70300>
drh6ed48bf2007-06-14 20:57:18 +00002588**
mihailimefc8e8a2008-06-21 16:47:09 +00002589** Contrary to the intuition of many, [sqlite3_reset()] does not reset
2590** the [sqlite3_bind_blob | bindings] on a [prepared statement].
2591** Use this routine to reset all host parameters to NULL.
drh33c1be32008-01-30 16:16:14 +00002592**
drh8b39db12009-02-18 18:37:58 +00002593** Requirements:
2594** [H13661]
danielk1977600dd0b2005-01-20 01:14:23 +00002595*/
2596int sqlite3_clear_bindings(sqlite3_stmt*);
2597
2598/*
drh9cd29642008-07-23 00:52:55 +00002599** CAPI3REF: Number Of Columns In A Result Set {H13710} <S10700>
drh6ed48bf2007-06-14 20:57:18 +00002600**
mihailimefc8e8a2008-06-21 16:47:09 +00002601** Return the number of columns in the result set returned by the
2602** [prepared statement]. This routine returns 0 if pStmt is an SQL
drh4ead1482008-06-26 18:16:05 +00002603** statement that does not return data (for example an [UPDATE]).
drh33c1be32008-01-30 16:16:14 +00002604**
drh8b39db12009-02-18 18:37:58 +00002605** Requirements:
2606** [H13711]
danielk197765904932004-05-26 06:18:37 +00002607*/
2608int sqlite3_column_count(sqlite3_stmt *pStmt);
2609
2610/*
drh9cd29642008-07-23 00:52:55 +00002611** CAPI3REF: Column Names In A Result Set {H13720} <S10700>
drh6ed48bf2007-06-14 20:57:18 +00002612**
drh33c1be32008-01-30 16:16:14 +00002613** These routines return the name assigned to a particular column
drh4ead1482008-06-26 18:16:05 +00002614** in the result set of a [SELECT] statement. The sqlite3_column_name()
mihailimefc8e8a2008-06-21 16:47:09 +00002615** interface returns a pointer to a zero-terminated UTF-8 string
drhf5befa02007-12-06 02:42:07 +00002616** and sqlite3_column_name16() returns a pointer to a zero-terminated
mihailimefc8e8a2008-06-21 16:47:09 +00002617** UTF-16 string. The first parameter is the [prepared statement]
drh4ead1482008-06-26 18:16:05 +00002618** that implements the [SELECT] statement. The second parameter is the
mihailimefc8e8a2008-06-21 16:47:09 +00002619** column number. The leftmost column is number 0.
drh6ed48bf2007-06-14 20:57:18 +00002620**
mihailimefc8e8a2008-06-21 16:47:09 +00002621** The returned string pointer is valid until either the [prepared statement]
2622** is destroyed by [sqlite3_finalize()] or until the next call to
2623** sqlite3_column_name() or sqlite3_column_name16() on the same column.
drh4a50aac2007-08-23 02:47:53 +00002624**
drh33c1be32008-01-30 16:16:14 +00002625** If sqlite3_malloc() fails during the processing of either routine
drh4a50aac2007-08-23 02:47:53 +00002626** (for example during a conversion from UTF-8 to UTF-16) then a
2627** NULL pointer is returned.
drh33c1be32008-01-30 16:16:14 +00002628**
2629** The name of a result column is the value of the "AS" clause for
2630** that column, if there is an AS clause. If there is no AS clause
2631** then the name of the column is unspecified and may change from
2632** one release of SQLite to the next.
2633**
drh8b39db12009-02-18 18:37:58 +00002634** Requirements:
2635** [H13721] [H13723] [H13724] [H13725] [H13726] [H13727]
danielk197765904932004-05-26 06:18:37 +00002636*/
drh6ed48bf2007-06-14 20:57:18 +00002637const char *sqlite3_column_name(sqlite3_stmt*, int N);
2638const void *sqlite3_column_name16(sqlite3_stmt*, int N);
danielk197765904932004-05-26 06:18:37 +00002639
2640/*
drh9cd29642008-07-23 00:52:55 +00002641** CAPI3REF: Source Of Data In A Query Result {H13740} <S10700>
drh6ed48bf2007-06-14 20:57:18 +00002642**
drh33c1be32008-01-30 16:16:14 +00002643** These routines provide a means to determine what column of what
drh4ead1482008-06-26 18:16:05 +00002644** table in which database a result of a [SELECT] statement comes from.
drh33c1be32008-01-30 16:16:14 +00002645** The name of the database or table or column can be returned as
mihailimebe796c2008-06-21 20:11:17 +00002646** either a UTF-8 or UTF-16 string. The _database_ routines return
drhbf2564f2007-06-21 15:25:05 +00002647** the database name, the _table_ routines return the table name, and
drh33c1be32008-01-30 16:16:14 +00002648** the origin_ routines return the column name.
mihailim1c492652008-06-21 18:02:16 +00002649** The returned string is valid until the [prepared statement] is destroyed
2650** using [sqlite3_finalize()] or until the same information is requested
drhbf2564f2007-06-21 15:25:05 +00002651** again in a different encoding.
2652**
drh33c1be32008-01-30 16:16:14 +00002653** The names returned are the original un-aliased names of the
drhbf2564f2007-06-21 15:25:05 +00002654** database, table, and column.
drh6ed48bf2007-06-14 20:57:18 +00002655**
drh33c1be32008-01-30 16:16:14 +00002656** The first argument to the following calls is a [prepared statement].
mihailim1c492652008-06-21 18:02:16 +00002657** These functions return information about the Nth column returned by
danielk1977955de522006-02-10 02:27:42 +00002658** the statement, where N is the second function argument.
2659**
mihailim1c492652008-06-21 18:02:16 +00002660** If the Nth column returned by the statement is an expression or
2661** subquery and is not a column value, then all of these functions return
2662** NULL. These routine might also return NULL if a memory allocation error
2663** occurs. Otherwise, they return the name of the attached database, table
2664** and column that query result column was extracted from.
danielk1977955de522006-02-10 02:27:42 +00002665**
drh33c1be32008-01-30 16:16:14 +00002666** As with all other SQLite APIs, those postfixed with "16" return
drhfddfa2d2007-12-05 18:05:16 +00002667** UTF-16 encoded strings, the other functions return UTF-8. {END}
danielk19774b1ae992006-02-10 03:06:10 +00002668**
mihailim1c492652008-06-21 18:02:16 +00002669** These APIs are only available if the library was compiled with the
drh4ead1482008-06-26 18:16:05 +00002670** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined.
drh32bc3f62007-08-21 20:25:39 +00002671**
drh4766b292008-06-26 02:53:02 +00002672** {A13751}
drh32bc3f62007-08-21 20:25:39 +00002673** If two or more threads call one or more of these routines against the same
2674** prepared statement and column at the same time then the results are
2675** undefined.
drh33c1be32008-01-30 16:16:14 +00002676**
drh8b39db12009-02-18 18:37:58 +00002677** Requirements:
2678** [H13741] [H13742] [H13743] [H13744] [H13745] [H13746] [H13748]
drh33c1be32008-01-30 16:16:14 +00002679**
drh8b39db12009-02-18 18:37:58 +00002680** If two or more threads call one or more
2681** [sqlite3_column_database_name | column metadata interfaces]
2682** for the same [prepared statement] and result column
2683** at the same time then the results are undefined.
danielk1977955de522006-02-10 02:27:42 +00002684*/
2685const char *sqlite3_column_database_name(sqlite3_stmt*,int);
2686const void *sqlite3_column_database_name16(sqlite3_stmt*,int);
2687const char *sqlite3_column_table_name(sqlite3_stmt*,int);
2688const void *sqlite3_column_table_name16(sqlite3_stmt*,int);
2689const char *sqlite3_column_origin_name(sqlite3_stmt*,int);
2690const void *sqlite3_column_origin_name16(sqlite3_stmt*,int);
2691
2692/*
drh9cd29642008-07-23 00:52:55 +00002693** CAPI3REF: Declared Datatype Of A Query Result {H13760} <S10700>
drh6ed48bf2007-06-14 20:57:18 +00002694**
mihailim1c492652008-06-21 18:02:16 +00002695** The first parameter is a [prepared statement].
drh4ead1482008-06-26 18:16:05 +00002696** If this statement is a [SELECT] statement and the Nth column of the
2697** returned result set of that [SELECT] is a table column (not an
drh6ed48bf2007-06-14 20:57:18 +00002698** expression or subquery) then the declared type of the table
drh33c1be32008-01-30 16:16:14 +00002699** column is returned. If the Nth column of the result set is an
drh6ed48bf2007-06-14 20:57:18 +00002700** expression or subquery, then a NULL pointer is returned.
mihailim1c492652008-06-21 18:02:16 +00002701** The returned string is always UTF-8 encoded. {END}
2702**
2703** For example, given the database schema:
danielk197765904932004-05-26 06:18:37 +00002704**
2705** CREATE TABLE t1(c1 VARIANT);
2706**
mihailim1c492652008-06-21 18:02:16 +00002707** and the following statement to be compiled:
danielk197765904932004-05-26 06:18:37 +00002708**
danielk1977955de522006-02-10 02:27:42 +00002709** SELECT c1 + 1, c1 FROM t1;
danielk197765904932004-05-26 06:18:37 +00002710**
mihailim1c492652008-06-21 18:02:16 +00002711** this routine would return the string "VARIANT" for the second result
2712** column (i==1), and a NULL pointer for the first result column (i==0).
drh6ed48bf2007-06-14 20:57:18 +00002713**
2714** SQLite uses dynamic run-time typing. So just because a column
2715** is declared to contain a particular type does not mean that the
2716** data stored in that column is of the declared type. SQLite is
2717** strongly typed, but the typing is dynamic not static. Type
2718** is associated with individual values, not with the containers
2719** used to hold those values.
drh33c1be32008-01-30 16:16:14 +00002720**
drh8b39db12009-02-18 18:37:58 +00002721** Requirements:
2722** [H13761] [H13762] [H13763]
danielk197765904932004-05-26 06:18:37 +00002723*/
drh33c1be32008-01-30 16:16:14 +00002724const char *sqlite3_column_decltype(sqlite3_stmt*,int);
danielk197765904932004-05-26 06:18:37 +00002725const void *sqlite3_column_decltype16(sqlite3_stmt*,int);
2726
mihailimebe796c2008-06-21 20:11:17 +00002727/*
drh9cd29642008-07-23 00:52:55 +00002728** CAPI3REF: Evaluate An SQL Statement {H13200} <S10000>
danielk1977106bb232004-05-21 10:08:53 +00002729**
mihailim1c492652008-06-21 18:02:16 +00002730** After a [prepared statement] has been prepared using either
2731** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy
2732** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function
2733** must be called one or more times to evaluate the statement.
danielk1977106bb232004-05-21 10:08:53 +00002734**
mihailim1c492652008-06-21 18:02:16 +00002735** The details of the behavior of the sqlite3_step() interface depend
drh6ed48bf2007-06-14 20:57:18 +00002736** on whether the statement was prepared using the newer "v2" interface
2737** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy
2738** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the
2739** new "v2" interface is recommended for new applications but the legacy
2740** interface will continue to be supported.
danielk1977106bb232004-05-21 10:08:53 +00002741**
mihailimebe796c2008-06-21 20:11:17 +00002742** In the legacy interface, the return value will be either [SQLITE_BUSY],
drh6ed48bf2007-06-14 20:57:18 +00002743** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE].
mihailim1c492652008-06-21 18:02:16 +00002744** With the "v2" interface, any of the other [result codes] or
2745** [extended result codes] might be returned as well.
drh6ed48bf2007-06-14 20:57:18 +00002746**
2747** [SQLITE_BUSY] means that the database engine was unable to acquire the
drh4ead1482008-06-26 18:16:05 +00002748** database locks it needs to do its job. If the statement is a [COMMIT]
drh6ed48bf2007-06-14 20:57:18 +00002749** or occurs outside of an explicit transaction, then you can retry the
drh4ead1482008-06-26 18:16:05 +00002750** statement. If the statement is not a [COMMIT] and occurs within a
drh6ed48bf2007-06-14 20:57:18 +00002751** explicit transaction then you should rollback the transaction before
2752** continuing.
2753**
2754** [SQLITE_DONE] means that the statement has finished executing
danielk1977106bb232004-05-21 10:08:53 +00002755** successfully. sqlite3_step() should not be called again on this virtual
drh6ed48bf2007-06-14 20:57:18 +00002756** machine without first calling [sqlite3_reset()] to reset the virtual
2757** machine back to its initial state.
danielk1977106bb232004-05-21 10:08:53 +00002758**
mihailim1c492652008-06-21 18:02:16 +00002759** If the SQL statement being executed returns any data, then [SQLITE_ROW]
2760** is returned each time a new row of data is ready for processing by the
2761** caller. The values may be accessed using the [column access functions].
drh6ed48bf2007-06-14 20:57:18 +00002762** sqlite3_step() is called again to retrieve the next row of data.
mihailim1c492652008-06-21 18:02:16 +00002763**
drh6ed48bf2007-06-14 20:57:18 +00002764** [SQLITE_ERROR] means that a run-time error (such as a constraint
danielk1977106bb232004-05-21 10:08:53 +00002765** violation) has occurred. sqlite3_step() should not be called again on
drh6ed48bf2007-06-14 20:57:18 +00002766** the VM. More information may be found by calling [sqlite3_errmsg()].
mihailim1c492652008-06-21 18:02:16 +00002767** With the legacy interface, a more specific error code (for example,
drh6ed48bf2007-06-14 20:57:18 +00002768** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth)
2769** can be obtained by calling [sqlite3_reset()] on the
drh33c1be32008-01-30 16:16:14 +00002770** [prepared statement]. In the "v2" interface,
drh6ed48bf2007-06-14 20:57:18 +00002771** the more specific error code is returned directly by sqlite3_step().
danielk1977106bb232004-05-21 10:08:53 +00002772**
drh6ed48bf2007-06-14 20:57:18 +00002773** [SQLITE_MISUSE] means that the this routine was called inappropriately.
drh33c1be32008-01-30 16:16:14 +00002774** Perhaps it was called on a [prepared statement] that has
mihailim1c492652008-06-21 18:02:16 +00002775** already been [sqlite3_finalize | finalized] or on one that had
drh6ed48bf2007-06-14 20:57:18 +00002776** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could
2777** be the case that the same database connection is being used by two or
2778** more threads at the same moment in time.
2779**
mihailim1c492652008-06-21 18:02:16 +00002780** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step()
2781** API always returns a generic error code, [SQLITE_ERROR], following any
2782** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call
2783** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the
2784** specific [error codes] that better describes the error.
drh6ed48bf2007-06-14 20:57:18 +00002785** We admit that this is a goofy design. The problem has been fixed
2786** with the "v2" interface. If you prepare all of your SQL statements
2787** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead
mihailim1c492652008-06-21 18:02:16 +00002788** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces,
2789** then the more specific [error codes] are returned directly
drh6ed48bf2007-06-14 20:57:18 +00002790** by sqlite3_step(). The use of the "v2" interface is recommended.
drh33c1be32008-01-30 16:16:14 +00002791**
drh8b39db12009-02-18 18:37:58 +00002792** Requirements:
2793** [H13202] [H15304] [H15306] [H15308] [H15310]
danielk1977106bb232004-05-21 10:08:53 +00002794*/
danielk197717240fd2004-05-26 00:07:25 +00002795int sqlite3_step(sqlite3_stmt*);
danielk1977106bb232004-05-21 10:08:53 +00002796
danielk1977106bb232004-05-21 10:08:53 +00002797/*
drh9cd29642008-07-23 00:52:55 +00002798** CAPI3REF: Number of columns in a result set {H13770} <S10700>
drh6ed48bf2007-06-14 20:57:18 +00002799**
mihailim1c492652008-06-21 18:02:16 +00002800** Returns the number of values in the current row of the result set.
danielk1977106bb232004-05-21 10:08:53 +00002801**
drh8b39db12009-02-18 18:37:58 +00002802** Requirements:
2803** [H13771] [H13772]
danielk1977106bb232004-05-21 10:08:53 +00002804*/
danielk197793d46752004-05-23 13:30:58 +00002805int sqlite3_data_count(sqlite3_stmt *pStmt);
danielk19774adee202004-05-08 08:23:19 +00002806
drh4f26d6c2004-05-26 23:25:30 +00002807/*
drhb25f9d82008-07-23 15:40:06 +00002808** CAPI3REF: Fundamental Datatypes {H10265} <S10110><S10120>
drh33c1be32008-01-30 16:16:14 +00002809** KEYWORDS: SQLITE_TEXT
drh6ed48bf2007-06-14 20:57:18 +00002810**
drh9a247912008-07-22 18:45:08 +00002811** {H10266} Every value in SQLite has one of five fundamental datatypes:
drh6ed48bf2007-06-14 20:57:18 +00002812**
2813** <ul>
2814** <li> 64-bit signed integer
2815** <li> 64-bit IEEE floating point number
2816** <li> string
2817** <li> BLOB
2818** <li> NULL
drhfddfa2d2007-12-05 18:05:16 +00002819** </ul> {END}
drh6ed48bf2007-06-14 20:57:18 +00002820**
2821** These constants are codes for each of those types.
2822**
2823** Note that the SQLITE_TEXT constant was also used in SQLite version 2
2824** for a completely different meaning. Software that links against both
mihailim1c492652008-06-21 18:02:16 +00002825** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not
drh6ed48bf2007-06-14 20:57:18 +00002826** SQLITE_TEXT.
drh4f26d6c2004-05-26 23:25:30 +00002827*/
drh9c054832004-05-31 18:51:57 +00002828#define SQLITE_INTEGER 1
2829#define SQLITE_FLOAT 2
drh9c054832004-05-31 18:51:57 +00002830#define SQLITE_BLOB 4
2831#define SQLITE_NULL 5
drh1e284f42004-10-06 15:52:01 +00002832#ifdef SQLITE_TEXT
2833# undef SQLITE_TEXT
2834#else
2835# define SQLITE_TEXT 3
2836#endif
2837#define SQLITE3_TEXT 3
2838
2839/*
drh9cd29642008-07-23 00:52:55 +00002840** CAPI3REF: Result Values From A Query {H13800} <S10700>
mihailim1c492652008-06-21 18:02:16 +00002841** KEYWORDS: {column access functions}
drh6ed48bf2007-06-14 20:57:18 +00002842**
drh33c1be32008-01-30 16:16:14 +00002843** These routines form the "result set query" interface.
2844**
mihailim1c492652008-06-21 18:02:16 +00002845** These routines return information about a single column of the current
2846** result row of a query. In every case the first argument is a pointer
2847** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*]
2848** that was returned from [sqlite3_prepare_v2()] or one of its variants)
2849** and the second argument is the index of the column for which information
2850** should be returned. The leftmost column of the result set has the index 0.
danielk1977106bb232004-05-21 10:08:53 +00002851**
mihailim1c492652008-06-21 18:02:16 +00002852** If the SQL statement does not currently point to a valid row, or if the
2853** column index is out of range, the result is undefined.
drh32bc3f62007-08-21 20:25:39 +00002854** These routines may only be called when the most recent call to
2855** [sqlite3_step()] has returned [SQLITE_ROW] and neither
mihailim1c492652008-06-21 18:02:16 +00002856** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently.
drh32bc3f62007-08-21 20:25:39 +00002857** If any of these routines are called after [sqlite3_reset()] or
2858** [sqlite3_finalize()] or after [sqlite3_step()] has returned
2859** something other than [SQLITE_ROW], the results are undefined.
2860** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()]
2861** are called from a different thread while any of these routines
mihailim1c492652008-06-21 18:02:16 +00002862** are pending, then the results are undefined.
drh6ed48bf2007-06-14 20:57:18 +00002863**
mihailim1c492652008-06-21 18:02:16 +00002864** The sqlite3_column_type() routine returns the
drh6ed48bf2007-06-14 20:57:18 +00002865** [SQLITE_INTEGER | datatype code] for the initial data type
2866** of the result column. The returned value is one of [SQLITE_INTEGER],
2867** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value
2868** returned by sqlite3_column_type() is only meaningful if no type
2869** conversions have occurred as described below. After a type conversion,
2870** the value returned by sqlite3_column_type() is undefined. Future
2871** versions of SQLite may change the behavior of sqlite3_column_type()
2872** following a type conversion.
2873**
mihailim1c492652008-06-21 18:02:16 +00002874** If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes()
drh6ed48bf2007-06-14 20:57:18 +00002875** routine returns the number of bytes in that BLOB or string.
mihailimebe796c2008-06-21 20:11:17 +00002876** If the result is a UTF-16 string, then sqlite3_column_bytes() converts
drh6ed48bf2007-06-14 20:57:18 +00002877** the string to UTF-8 and then returns the number of bytes.
2878** If the result is a numeric value then sqlite3_column_bytes() uses
mihailimebe796c2008-06-21 20:11:17 +00002879** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns
drh6ed48bf2007-06-14 20:57:18 +00002880** the number of bytes in that string.
2881** The value returned does not include the zero terminator at the end
2882** of the string. For clarity: the value returned is the number of
2883** bytes in the string, not the number of characters.
2884**
drhc0b3abb2007-09-04 12:18:41 +00002885** Strings returned by sqlite3_column_text() and sqlite3_column_text16(),
drh33c1be32008-01-30 16:16:14 +00002886** even empty strings, are always zero terminated. The return
mihailim04bcc002008-06-22 10:21:27 +00002887** value from sqlite3_column_blob() for a zero-length BLOB is an arbitrary
drhc0b3abb2007-09-04 12:18:41 +00002888** pointer, possibly even a NULL pointer.
2889**
drh6ed48bf2007-06-14 20:57:18 +00002890** The sqlite3_column_bytes16() routine is similar to sqlite3_column_bytes()
mihailim1c492652008-06-21 18:02:16 +00002891** but leaves the result in UTF-16 in native byte order instead of UTF-8.
drh6ed48bf2007-06-14 20:57:18 +00002892** The zero terminator is not included in this count.
drh4f26d6c2004-05-26 23:25:30 +00002893**
drhaa28e142008-03-18 13:47:20 +00002894** The object returned by [sqlite3_column_value()] is an
2895** [unprotected sqlite3_value] object. An unprotected sqlite3_value object
2896** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()].
2897** If the [unprotected sqlite3_value] object returned by
2898** [sqlite3_column_value()] is used in any other way, including calls
mihailim1c492652008-06-21 18:02:16 +00002899** to routines like [sqlite3_value_int()], [sqlite3_value_text()],
2900** or [sqlite3_value_bytes()], then the behavior is undefined.
drhaa28e142008-03-18 13:47:20 +00002901**
drh4f26d6c2004-05-26 23:25:30 +00002902** These routines attempt to convert the value where appropriate. For
2903** example, if the internal representation is FLOAT and a text result
mihailim1c492652008-06-21 18:02:16 +00002904** is requested, [sqlite3_snprintf()] is used internally to perform the
2905** conversion automatically. The following table details the conversions
2906** that are applied:
drh4f26d6c2004-05-26 23:25:30 +00002907**
drh6ed48bf2007-06-14 20:57:18 +00002908** <blockquote>
2909** <table border="1">
drh8bacf972007-08-25 16:21:29 +00002910** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion
drh4f26d6c2004-05-26 23:25:30 +00002911**
drh6ed48bf2007-06-14 20:57:18 +00002912** <tr><td> NULL <td> INTEGER <td> Result is 0
2913** <tr><td> NULL <td> FLOAT <td> Result is 0.0
2914** <tr><td> NULL <td> TEXT <td> Result is NULL pointer
2915** <tr><td> NULL <td> BLOB <td> Result is NULL pointer
2916** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float
2917** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer
mihailim1c492652008-06-21 18:02:16 +00002918** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT
drh6ed48bf2007-06-14 20:57:18 +00002919** <tr><td> FLOAT <td> INTEGER <td> Convert from float to integer
2920** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float
2921** <tr><td> FLOAT <td> BLOB <td> Same as FLOAT->TEXT
2922** <tr><td> TEXT <td> INTEGER <td> Use atoi()
2923** <tr><td> TEXT <td> FLOAT <td> Use atof()
2924** <tr><td> TEXT <td> BLOB <td> No change
2925** <tr><td> BLOB <td> INTEGER <td> Convert to TEXT then use atoi()
2926** <tr><td> BLOB <td> FLOAT <td> Convert to TEXT then use atof()
2927** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed
2928** </table>
2929** </blockquote>
drh4f26d6c2004-05-26 23:25:30 +00002930**
drh6ed48bf2007-06-14 20:57:18 +00002931** The table above makes reference to standard C library functions atoi()
2932** and atof(). SQLite does not really use these functions. It has its
shane26b34032008-05-23 17:21:09 +00002933** own equivalent internal routines. The atoi() and atof() names are
drh6ed48bf2007-06-14 20:57:18 +00002934** used in the table for brevity and because they are familiar to most
2935** C programmers.
2936**
2937** Note that when type conversions occur, pointers returned by prior
2938** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or
mihailim1c492652008-06-21 18:02:16 +00002939** sqlite3_column_text16() may be invalidated.
drh6ed48bf2007-06-14 20:57:18 +00002940** Type conversions and pointer invalidations might occur
2941** in the following cases:
2942**
2943** <ul>
mihailim1c492652008-06-21 18:02:16 +00002944** <li> The initial content is a BLOB and sqlite3_column_text() or
2945** sqlite3_column_text16() is called. A zero-terminator might
2946** need to be added to the string.</li>
2947** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or
2948** sqlite3_column_text16() is called. The content must be converted
2949** to UTF-16.</li>
2950** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or
2951** sqlite3_column_text() is called. The content must be converted
2952** to UTF-8.</li>
drh6ed48bf2007-06-14 20:57:18 +00002953** </ul>
2954**
2955** Conversions between UTF-16be and UTF-16le are always done in place and do
2956** not invalidate a prior pointer, though of course the content of the buffer
2957** that the prior pointer points to will have been modified. Other kinds
mihailim1c492652008-06-21 18:02:16 +00002958** of conversion are done in place when it is possible, but sometimes they
2959** are not possible and in those cases prior pointers are invalidated.
drh6ed48bf2007-06-14 20:57:18 +00002960**
2961** The safest and easiest to remember policy is to invoke these routines
2962** in one of the following ways:
2963**
mihailim1c492652008-06-21 18:02:16 +00002964** <ul>
drh6ed48bf2007-06-14 20:57:18 +00002965** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li>
2966** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li>
2967** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li>
mihailim1c492652008-06-21 18:02:16 +00002968** </ul>
drh6ed48bf2007-06-14 20:57:18 +00002969**
mihailim1c492652008-06-21 18:02:16 +00002970** In other words, you should call sqlite3_column_text(),
2971** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result
2972** into the desired format, then invoke sqlite3_column_bytes() or
2973** sqlite3_column_bytes16() to find the size of the result. Do not mix calls
2974** to sqlite3_column_text() or sqlite3_column_blob() with calls to
2975** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16()
2976** with calls to sqlite3_column_bytes().
drh32bc3f62007-08-21 20:25:39 +00002977**
2978** The pointers returned are valid until a type conversion occurs as
2979** described above, or until [sqlite3_step()] or [sqlite3_reset()] or
2980** [sqlite3_finalize()] is called. The memory space used to hold strings
mihailim04bcc002008-06-22 10:21:27 +00002981** and BLOBs is freed automatically. Do <b>not</b> pass the pointers returned
mihailim1c492652008-06-21 18:02:16 +00002982** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into
drh32bc3f62007-08-21 20:25:39 +00002983** [sqlite3_free()].
drh4a50aac2007-08-23 02:47:53 +00002984**
2985** If a memory allocation error occurs during the evaluation of any
2986** of these routines, a default value is returned. The default value
2987** is either the integer 0, the floating point number 0.0, or a NULL
2988** pointer. Subsequent calls to [sqlite3_errcode()] will return
2989** [SQLITE_NOMEM].
drh21ac7f92008-01-31 12:26:49 +00002990**
drh8b39db12009-02-18 18:37:58 +00002991** Requirements:
2992** [H13803] [H13806] [H13809] [H13812] [H13815] [H13818] [H13821] [H13824]
2993** [H13827] [H13830]
danielk1977106bb232004-05-21 10:08:53 +00002994*/
drhf4479502004-05-27 03:12:53 +00002995const void *sqlite3_column_blob(sqlite3_stmt*, int iCol);
2996int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
2997int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
2998double sqlite3_column_double(sqlite3_stmt*, int iCol);
2999int sqlite3_column_int(sqlite3_stmt*, int iCol);
drh6d2069d2007-08-14 01:58:53 +00003000sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol);
drhf4479502004-05-27 03:12:53 +00003001const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol);
3002const void *sqlite3_column_text16(sqlite3_stmt*, int iCol);
drh4f26d6c2004-05-26 23:25:30 +00003003int sqlite3_column_type(sqlite3_stmt*, int iCol);
drh4be8b512006-06-13 23:51:34 +00003004sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol);
danielk19774adee202004-05-08 08:23:19 +00003005
danielk197765904932004-05-26 06:18:37 +00003006/*
drhb25f9d82008-07-23 15:40:06 +00003007** CAPI3REF: Destroy A Prepared Statement Object {H13300} <S70300><S30100>
drh6ed48bf2007-06-14 20:57:18 +00003008**
mihailimebe796c2008-06-21 20:11:17 +00003009** The sqlite3_finalize() function is called to delete a [prepared statement].
3010** If the statement was executed successfully or not executed at all, then
3011** SQLITE_OK is returned. If execution of the statement failed then an
3012** [error code] or [extended error code] is returned.
danielk197765904932004-05-26 06:18:37 +00003013**
3014** This routine can be called at any point during the execution of the
mihailimebe796c2008-06-21 20:11:17 +00003015** [prepared statement]. If the virtual machine has not
drh6ed48bf2007-06-14 20:57:18 +00003016** completed execution when this routine is called, that is like
mihailimebe796c2008-06-21 20:11:17 +00003017** encountering an error or an [sqlite3_interrupt | interrupt].
3018** Incomplete updates may be rolled back and transactions canceled,
3019** depending on the circumstances, and the
drh33c1be32008-01-30 16:16:14 +00003020** [error code] returned will be [SQLITE_ABORT].
3021**
drh8b39db12009-02-18 18:37:58 +00003022** Requirements:
3023** [H11302] [H11304]
danielk197765904932004-05-26 06:18:37 +00003024*/
3025int sqlite3_finalize(sqlite3_stmt *pStmt);
3026
3027/*
drh9cd29642008-07-23 00:52:55 +00003028** CAPI3REF: Reset A Prepared Statement Object {H13330} <S70300>
drh6ed48bf2007-06-14 20:57:18 +00003029**
mihailimebe796c2008-06-21 20:11:17 +00003030** The sqlite3_reset() function is called to reset a [prepared statement]
3031** object back to its initial state, ready to be re-executed.
danielk197765904932004-05-26 06:18:37 +00003032** Any SQL statement variables that had values bound to them using
drh6ed48bf2007-06-14 20:57:18 +00003033** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values.
3034** Use [sqlite3_clear_bindings()] to reset the bindings.
drh33c1be32008-01-30 16:16:14 +00003035**
drh9a247912008-07-22 18:45:08 +00003036** {H11332} The [sqlite3_reset(S)] interface resets the [prepared statement] S
drh33c1be32008-01-30 16:16:14 +00003037** back to the beginning of its program.
3038**
drh9a247912008-07-22 18:45:08 +00003039** {H11334} If the most recent call to [sqlite3_step(S)] for the
drh33c1be32008-01-30 16:16:14 +00003040** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE],
3041** or if [sqlite3_step(S)] has never before been called on S,
3042** then [sqlite3_reset(S)] returns [SQLITE_OK].
3043**
drh9a247912008-07-22 18:45:08 +00003044** {H11336} If the most recent call to [sqlite3_step(S)] for the
drh33c1be32008-01-30 16:16:14 +00003045** [prepared statement] S indicated an error, then
3046** [sqlite3_reset(S)] returns an appropriate [error code].
3047**
drh9a247912008-07-22 18:45:08 +00003048** {H11338} The [sqlite3_reset(S)] interface does not change the values
mihailimebe796c2008-06-21 20:11:17 +00003049** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S.
danielk197765904932004-05-26 06:18:37 +00003050*/
3051int sqlite3_reset(sqlite3_stmt *pStmt);
3052
3053/*
drh9cd29642008-07-23 00:52:55 +00003054** CAPI3REF: Create Or Redefine SQL Functions {H16100} <S20200>
mihailimefc8e8a2008-06-21 16:47:09 +00003055** KEYWORDS: {function creation routines}
3056** KEYWORDS: {application-defined SQL function}
3057** KEYWORDS: {application-defined SQL functions}
drh6ed48bf2007-06-14 20:57:18 +00003058**
mihailimebe796c2008-06-21 20:11:17 +00003059** These two functions (collectively known as "function creation routines")
3060** are used to add SQL functions or aggregates or to redefine the behavior
3061** of existing SQL functions or aggregates. The only difference between the
3062** two is that the second parameter, the name of the (scalar) function or
3063** aggregate, is encoded in UTF-8 for sqlite3_create_function() and UTF-16
3064** for sqlite3_create_function16().
danielk197765904932004-05-26 06:18:37 +00003065**
drh1c3cfc62008-03-08 12:37:30 +00003066** The first parameter is the [database connection] to which the SQL
mihailimebe796c2008-06-21 20:11:17 +00003067** function is to be added. If a single program uses more than one database
3068** connection internally, then SQL functions must be added individually to
3069** each database connection.
danielk197765904932004-05-26 06:18:37 +00003070**
mihailimebe796c2008-06-21 20:11:17 +00003071** The second parameter is the name of the SQL function to be created or
3072** redefined. The length of the name is limited to 255 bytes, exclusive of
3073** the zero-terminator. Note that the name length limit is in bytes, not
drh6ed48bf2007-06-14 20:57:18 +00003074** characters. Any attempt to create a function with a longer name
mihailimebe796c2008-06-21 20:11:17 +00003075** will result in [SQLITE_ERROR] being returned.
drh6ed48bf2007-06-14 20:57:18 +00003076**
drhc8075422008-09-10 13:09:23 +00003077** The third parameter (nArg)
3078** is the number of arguments that the SQL function or
drh97602f82009-05-24 11:07:49 +00003079** aggregate takes. If this parameter is -1, then the SQL function or
3080** aggregate may take any number of arguments between 0 and the limit
3081** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third
drh09943b52009-05-24 21:59:27 +00003082** parameter is less than -1 or greater than 127 then the behavior is
3083** undefined.
danielk197765904932004-05-26 06:18:37 +00003084**
mihailimebe796c2008-06-21 20:11:17 +00003085** The fourth parameter, eTextRep, specifies what
drh6ed48bf2007-06-14 20:57:18 +00003086** [SQLITE_UTF8 | text encoding] this SQL function prefers for
3087** its parameters. Any SQL function implementation should be able to work
3088** work with UTF-8, UTF-16le, or UTF-16be. But some implementations may be
3089** more efficient with one encoding than another. It is allowed to
drh6d2069d2007-08-14 01:58:53 +00003090** invoke sqlite3_create_function() or sqlite3_create_function16() multiple
drh6ed48bf2007-06-14 20:57:18 +00003091** times with the same function but with different values of eTextRep.
3092** When multiple implementations of the same function are available, SQLite
3093** will pick the one that involves the least amount of data conversion.
mihailimebe796c2008-06-21 20:11:17 +00003094** If there is only a single implementation which does not care what text
3095** encoding is used, then the fourth argument should be [SQLITE_ANY].
drh6ed48bf2007-06-14 20:57:18 +00003096**
mihailimebe796c2008-06-21 20:11:17 +00003097** The fifth parameter is an arbitrary pointer. The implementation of the
3098** function can gain access to this pointer using [sqlite3_user_data()].
danielk1977d02eb1f2004-06-06 09:44:03 +00003099**
danielk197765904932004-05-26 06:18:37 +00003100** The seventh, eighth and ninth parameters, xFunc, xStep and xFinal, are
mihailimebe796c2008-06-21 20:11:17 +00003101** pointers to C-language functions that implement the SQL function or
3102** aggregate. A scalar SQL function requires an implementation of the xFunc
3103** callback only, NULL pointers should be passed as the xStep and xFinal
3104** parameters. An aggregate SQL function requires an implementation of xStep
3105** and xFinal and NULL should be passed for xFunc. To delete an existing
3106** SQL function or aggregate, pass NULL for all three function callbacks.
drh6ed48bf2007-06-14 20:57:18 +00003107**
3108** It is permitted to register multiple implementations of the same
3109** functions with the same name but with either differing numbers of
shane26b34032008-05-23 17:21:09 +00003110** arguments or differing preferred text encodings. SQLite will use
drh6ed48bf2007-06-14 20:57:18 +00003111** the implementation most closely matches the way in which the
drhc8075422008-09-10 13:09:23 +00003112** SQL function is used. A function implementation with a non-negative
3113** nArg parameter is a better match than a function implementation with
3114** a negative nArg. A function where the preferred text encoding
3115** matches the database encoding is a better
3116** match than a function where the encoding is different.
3117** A function where the encoding difference is between UTF16le and UTF16be
3118** is a closer match than a function where the encoding difference is
3119** between UTF8 and UTF16.
3120**
3121** Built-in functions may be overloaded by new application-defined functions.
3122** The first application-defined function with a given name overrides all
3123** built-in functions in the same [database connection] with the same name.
3124** Subsequent application-defined functions of the same name only override
3125** prior application-defined functions that are an exact match for the
3126** number of parameters and preferred encoding.
3127**
3128** An application-defined function is permitted to call other
3129** SQLite interfaces. However, such calls must not
3130** close the database connection nor finalize or reset the prepared
3131** statement in which the function is running.
drh21ac7f92008-01-31 12:26:49 +00003132**
drh8b39db12009-02-18 18:37:58 +00003133** Requirements:
drh09943b52009-05-24 21:59:27 +00003134** [H16103] [H16106] [H16109] [H16112] [H16118] [H16121] [H16127]
drh8b39db12009-02-18 18:37:58 +00003135** [H16130] [H16133] [H16136] [H16139] [H16142]
danielk197765904932004-05-26 06:18:37 +00003136*/
3137int sqlite3_create_function(
drh33c1be32008-01-30 16:16:14 +00003138 sqlite3 *db,
danielk197765904932004-05-26 06:18:37 +00003139 const char *zFunctionName,
3140 int nArg,
3141 int eTextRep,
drh33c1be32008-01-30 16:16:14 +00003142 void *pApp,
danielk197765904932004-05-26 06:18:37 +00003143 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
3144 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
3145 void (*xFinal)(sqlite3_context*)
3146);
3147int sqlite3_create_function16(
drh33c1be32008-01-30 16:16:14 +00003148 sqlite3 *db,
danielk197765904932004-05-26 06:18:37 +00003149 const void *zFunctionName,
3150 int nArg,
3151 int eTextRep,
drh33c1be32008-01-30 16:16:14 +00003152 void *pApp,
danielk197765904932004-05-26 06:18:37 +00003153 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
3154 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
3155 void (*xFinal)(sqlite3_context*)
3156);
3157
3158/*
drh9cd29642008-07-23 00:52:55 +00003159** CAPI3REF: Text Encodings {H10267} <S50200> <H16100>
drh6ed48bf2007-06-14 20:57:18 +00003160**
3161** These constant define integer codes that represent the various
3162** text encodings supported by SQLite.
danielk197765904932004-05-26 06:18:37 +00003163*/
drh6ed48bf2007-06-14 20:57:18 +00003164#define SQLITE_UTF8 1
3165#define SQLITE_UTF16LE 2
3166#define SQLITE_UTF16BE 3
3167#define SQLITE_UTF16 4 /* Use native byte order */
3168#define SQLITE_ANY 5 /* sqlite3_create_function only */
3169#define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */
danielk197765904932004-05-26 06:18:37 +00003170
danielk19770ffba6b2004-05-24 09:10:10 +00003171/*
drhd5a68d32008-08-04 13:44:57 +00003172** CAPI3REF: Deprecated Functions
3173** DEPRECATED
drh6ed48bf2007-06-14 20:57:18 +00003174**
drhd5a68d32008-08-04 13:44:57 +00003175** These functions are [deprecated]. In order to maintain
3176** backwards compatibility with older code, these functions continue
3177** to be supported. However, new applications should avoid
drh6ed48bf2007-06-14 20:57:18 +00003178** the use of these functions. To help encourage people to avoid
shane7ba429a2008-11-10 17:08:49 +00003179** using these functions, we are not going to tell you what they do.
drh6ed48bf2007-06-14 20:57:18 +00003180*/
shaneeec556d2008-10-12 00:27:53 +00003181#ifndef SQLITE_OMIT_DEPRECATED
shanea79c3cc2008-08-11 17:27:01 +00003182SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*);
3183SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*);
3184SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*);
3185SQLITE_DEPRECATED int sqlite3_global_recover(void);
3186SQLITE_DEPRECATED void sqlite3_thread_cleanup(void);
3187SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),void*,sqlite3_int64);
shaneeec556d2008-10-12 00:27:53 +00003188#endif
drh6ed48bf2007-06-14 20:57:18 +00003189
3190/*
drh9cd29642008-07-23 00:52:55 +00003191** CAPI3REF: Obtaining SQL Function Parameter Values {H15100} <S20200>
drh6ed48bf2007-06-14 20:57:18 +00003192**
3193** The C-language implementation of SQL functions and aggregates uses
3194** this set of interface routines to access the parameter values on
3195** the function or aggregate.
3196**
3197** The xFunc (for scalar functions) or xStep (for aggregates) parameters
3198** to [sqlite3_create_function()] and [sqlite3_create_function16()]
3199** define callbacks that implement the SQL functions and aggregates.
3200** The 4th parameter to these callbacks is an array of pointers to
drhaa28e142008-03-18 13:47:20 +00003201** [protected sqlite3_value] objects. There is one [sqlite3_value] object for
drh6ed48bf2007-06-14 20:57:18 +00003202** each parameter to the SQL function. These routines are used to
3203** extract values from the [sqlite3_value] objects.
3204**
drhaa28e142008-03-18 13:47:20 +00003205** These routines work only with [protected sqlite3_value] objects.
3206** Any attempt to use these routines on an [unprotected sqlite3_value]
3207** object results in undefined behavior.
3208**
mihailim1c492652008-06-21 18:02:16 +00003209** These routines work just like the corresponding [column access functions]
3210** except that these routines take a single [protected sqlite3_value] object
3211** pointer instead of a [sqlite3_stmt*] pointer and an integer column number.
drh6ed48bf2007-06-14 20:57:18 +00003212**
mihailimebe796c2008-06-21 20:11:17 +00003213** The sqlite3_value_text16() interface extracts a UTF-16 string
drh6ed48bf2007-06-14 20:57:18 +00003214** in the native byte-order of the host machine. The
3215** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces
mihailimebe796c2008-06-21 20:11:17 +00003216** extract UTF-16 strings as big-endian and little-endian respectively.
drh6ed48bf2007-06-14 20:57:18 +00003217**
3218** The sqlite3_value_numeric_type() interface attempts to apply
3219** numeric affinity to the value. This means that an attempt is
3220** made to convert the value to an integer or floating point. If
drhf5befa02007-12-06 02:42:07 +00003221** such a conversion is possible without loss of information (in other
mihailimebe796c2008-06-21 20:11:17 +00003222** words, if the value is a string that looks like a number)
3223** then the conversion is performed. Otherwise no conversion occurs.
3224** The [SQLITE_INTEGER | datatype] after conversion is returned.
drh6ed48bf2007-06-14 20:57:18 +00003225**
mihailimebe796c2008-06-21 20:11:17 +00003226** Please pay particular attention to the fact that the pointer returned
3227** from [sqlite3_value_blob()], [sqlite3_value_text()], or
drh6ed48bf2007-06-14 20:57:18 +00003228** [sqlite3_value_text16()] can be invalidated by a subsequent call to
drh6d2069d2007-08-14 01:58:53 +00003229** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()],
mihailimebe796c2008-06-21 20:11:17 +00003230** or [sqlite3_value_text16()].
drhe53831d2007-08-17 01:14:38 +00003231**
3232** These routines must be called from the same thread as
drhaa28e142008-03-18 13:47:20 +00003233** the SQL function that supplied the [sqlite3_value*] parameters.
drhf5befa02007-12-06 02:42:07 +00003234**
drh8b39db12009-02-18 18:37:58 +00003235** Requirements:
3236** [H15103] [H15106] [H15109] [H15112] [H15115] [H15118] [H15121] [H15124]
3237** [H15127] [H15130] [H15133] [H15136]
danielk19770ffba6b2004-05-24 09:10:10 +00003238*/
drhf4479502004-05-27 03:12:53 +00003239const void *sqlite3_value_blob(sqlite3_value*);
3240int sqlite3_value_bytes(sqlite3_value*);
3241int sqlite3_value_bytes16(sqlite3_value*);
3242double sqlite3_value_double(sqlite3_value*);
3243int sqlite3_value_int(sqlite3_value*);
drh6d2069d2007-08-14 01:58:53 +00003244sqlite3_int64 sqlite3_value_int64(sqlite3_value*);
drhf4479502004-05-27 03:12:53 +00003245const unsigned char *sqlite3_value_text(sqlite3_value*);
3246const void *sqlite3_value_text16(sqlite3_value*);
danielk1977d8123362004-06-12 09:25:12 +00003247const void *sqlite3_value_text16le(sqlite3_value*);
3248const void *sqlite3_value_text16be(sqlite3_value*);
danielk197793d46752004-05-23 13:30:58 +00003249int sqlite3_value_type(sqlite3_value*);
drh29d72102006-02-09 22:13:41 +00003250int sqlite3_value_numeric_type(sqlite3_value*);
danielk19770ffba6b2004-05-24 09:10:10 +00003251
3252/*
drh9cd29642008-07-23 00:52:55 +00003253** CAPI3REF: Obtain Aggregate Function Context {H16210} <S20200>
drh6ed48bf2007-06-14 20:57:18 +00003254**
3255** The implementation of aggregate SQL functions use this routine to allocate
mihailimebe796c2008-06-21 20:11:17 +00003256** a structure for storing their state.
3257**
3258** The first time the sqlite3_aggregate_context() routine is called for a
3259** particular aggregate, SQLite allocates nBytes of memory, zeroes out that
3260** memory, and returns a pointer to it. On second and subsequent calls to
3261** sqlite3_aggregate_context() for the same aggregate function index,
3262** the same buffer is returned. The implementation of the aggregate can use
3263** the returned buffer to accumulate data.
danielk19770ae8b832004-05-25 12:05:56 +00003264**
drhafc91042008-02-21 02:09:45 +00003265** SQLite automatically frees the allocated buffer when the aggregate
3266** query concludes.
drh6ed48bf2007-06-14 20:57:18 +00003267**
mihailimebe796c2008-06-21 20:11:17 +00003268** The first parameter should be a copy of the
3269** [sqlite3_context | SQL function context] that is the first parameter
3270** to the callback routine that implements the aggregate function.
drhe53831d2007-08-17 01:14:38 +00003271**
3272** This routine must be called from the same thread in which
drh605264d2007-08-21 15:13:19 +00003273** the aggregate SQL function is running.
drhafc91042008-02-21 02:09:45 +00003274**
drh8b39db12009-02-18 18:37:58 +00003275** Requirements:
3276** [H16211] [H16213] [H16215] [H16217]
danielk19770ae8b832004-05-25 12:05:56 +00003277*/
drh4f26d6c2004-05-26 23:25:30 +00003278void *sqlite3_aggregate_context(sqlite3_context*, int nBytes);
danielk19777e18c252004-05-25 11:47:24 +00003279
3280/*
drh9cd29642008-07-23 00:52:55 +00003281** CAPI3REF: User Data For Functions {H16240} <S20200>
drh6ed48bf2007-06-14 20:57:18 +00003282**
drhafc91042008-02-21 02:09:45 +00003283** The sqlite3_user_data() interface returns a copy of
drhf5befa02007-12-06 02:42:07 +00003284** the pointer that was the pUserData parameter (the 5th parameter)
shane26b34032008-05-23 17:21:09 +00003285** of the [sqlite3_create_function()]
drhf5befa02007-12-06 02:42:07 +00003286** and [sqlite3_create_function16()] routines that originally
3287** registered the application defined function. {END}
drhe53831d2007-08-17 01:14:38 +00003288**
drhafc91042008-02-21 02:09:45 +00003289** This routine must be called from the same thread in which
drhf5befa02007-12-06 02:42:07 +00003290** the application-defined function is running.
drhafc91042008-02-21 02:09:45 +00003291**
drh8b39db12009-02-18 18:37:58 +00003292** Requirements:
3293** [H16243]
danielk19777e18c252004-05-25 11:47:24 +00003294*/
3295void *sqlite3_user_data(sqlite3_context*);
3296
3297/*
drhb25f9d82008-07-23 15:40:06 +00003298** CAPI3REF: Database Connection For Functions {H16250} <S60600><S20200>
drhfa4a4b92008-03-19 21:45:51 +00003299**
3300** The sqlite3_context_db_handle() interface returns a copy of
3301** the pointer to the [database connection] (the 1st parameter)
shane26b34032008-05-23 17:21:09 +00003302** of the [sqlite3_create_function()]
drhfa4a4b92008-03-19 21:45:51 +00003303** and [sqlite3_create_function16()] routines that originally
3304** registered the application defined function.
3305**
drh8b39db12009-02-18 18:37:58 +00003306** Requirements:
3307** [H16253]
drhfa4a4b92008-03-19 21:45:51 +00003308*/
3309sqlite3 *sqlite3_context_db_handle(sqlite3_context*);
3310
3311/*
drh9cd29642008-07-23 00:52:55 +00003312** CAPI3REF: Function Auxiliary Data {H16270} <S20200>
drh6ed48bf2007-06-14 20:57:18 +00003313**
3314** The following two functions may be used by scalar SQL functions to
mihailimebe796c2008-06-21 20:11:17 +00003315** associate metadata with argument values. If the same value is passed to
drh6ed48bf2007-06-14 20:57:18 +00003316** multiple invocations of the same SQL function during query execution, under
mihailimebe796c2008-06-21 20:11:17 +00003317** some circumstances the associated metadata may be preserved. This may
danielk1977682f68b2004-06-05 10:22:17 +00003318** be used, for example, to add a regular-expression matching scalar
3319** function. The compiled version of the regular expression is stored as
mihailimebe796c2008-06-21 20:11:17 +00003320** metadata associated with the SQL value passed as the regular expression
drh6ed48bf2007-06-14 20:57:18 +00003321** pattern. The compiled regular expression can be reused on multiple
3322** invocations of the same function so that the original pattern string
3323** does not need to be recompiled on each invocation.
danielk1977682f68b2004-06-05 10:22:17 +00003324**
mihailimebe796c2008-06-21 20:11:17 +00003325** The sqlite3_get_auxdata() interface returns a pointer to the metadata
drhf5befa02007-12-06 02:42:07 +00003326** associated by the sqlite3_set_auxdata() function with the Nth argument
mihailimebe796c2008-06-21 20:11:17 +00003327** value to the application-defined function. If no metadata has been ever
3328** been set for the Nth argument of the function, or if the corresponding
3329** function parameter has changed since the meta-data was set,
3330** then sqlite3_get_auxdata() returns a NULL pointer.
danielk1977682f68b2004-06-05 10:22:17 +00003331**
mihailimebe796c2008-06-21 20:11:17 +00003332** The sqlite3_set_auxdata() interface saves the metadata
3333** pointed to by its 3rd parameter as the metadata for the N-th
drhafc91042008-02-21 02:09:45 +00003334** argument of the application-defined function. Subsequent
drhf5befa02007-12-06 02:42:07 +00003335** calls to sqlite3_get_auxdata() might return this data, if it has
mihailimebe796c2008-06-21 20:11:17 +00003336** not been destroyed.
3337** If it is not NULL, SQLite will invoke the destructor
drhf5befa02007-12-06 02:42:07 +00003338** function given by the 4th parameter to sqlite3_set_auxdata() on
mihailimebe796c2008-06-21 20:11:17 +00003339** the metadata when the corresponding function parameter changes
drhafc91042008-02-21 02:09:45 +00003340** or when the SQL statement completes, whichever comes first.
3341**
mihailimebe796c2008-06-21 20:11:17 +00003342** SQLite is free to call the destructor and drop metadata on any
3343** parameter of any function at any time. The only guarantee is that
3344** the destructor will be called before the metadata is dropped.
danielk1977682f68b2004-06-05 10:22:17 +00003345**
mihailimebe796c2008-06-21 20:11:17 +00003346** In practice, metadata is preserved between function calls for
danielk1977682f68b2004-06-05 10:22:17 +00003347** expressions that are constant at compile time. This includes literal
3348** values and SQL variables.
drhe53831d2007-08-17 01:14:38 +00003349**
drhb21c8cd2007-08-21 19:33:56 +00003350** These routines must be called from the same thread in which
3351** the SQL function is running.
drhafc91042008-02-21 02:09:45 +00003352**
drh8b39db12009-02-18 18:37:58 +00003353** Requirements:
3354** [H16272] [H16274] [H16276] [H16277] [H16278] [H16279]
danielk1977682f68b2004-06-05 10:22:17 +00003355*/
drhf5befa02007-12-06 02:42:07 +00003356void *sqlite3_get_auxdata(sqlite3_context*, int N);
3357void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*));
danielk1977682f68b2004-06-05 10:22:17 +00003358
drha2854222004-06-17 19:04:17 +00003359
3360/*
drhb25f9d82008-07-23 15:40:06 +00003361** CAPI3REF: Constants Defining Special Destructor Behavior {H10280} <S30100>
drh6ed48bf2007-06-14 20:57:18 +00003362**
mihailimebe796c2008-06-21 20:11:17 +00003363** These are special values for the destructor that is passed in as the
drh6ed48bf2007-06-14 20:57:18 +00003364** final argument to routines like [sqlite3_result_blob()]. If the destructor
drha2854222004-06-17 19:04:17 +00003365** argument is SQLITE_STATIC, it means that the content pointer is constant
mihailimebe796c2008-06-21 20:11:17 +00003366** and will never change. It does not need to be destroyed. The
drha2854222004-06-17 19:04:17 +00003367** SQLITE_TRANSIENT value means that the content will likely change in
3368** the near future and that SQLite should make its own private copy of
3369** the content before returning.
drh6c9121a2007-01-26 00:51:43 +00003370**
3371** The typedef is necessary to work around problems in certain
3372** C++ compilers. See ticket #2191.
drha2854222004-06-17 19:04:17 +00003373*/
drh6c9121a2007-01-26 00:51:43 +00003374typedef void (*sqlite3_destructor_type)(void*);
3375#define SQLITE_STATIC ((sqlite3_destructor_type)0)
3376#define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1)
danielk1977d8123362004-06-12 09:25:12 +00003377
danielk1977682f68b2004-06-05 10:22:17 +00003378/*
drh9cd29642008-07-23 00:52:55 +00003379** CAPI3REF: Setting The Result Of An SQL Function {H16400} <S20200>
drh6ed48bf2007-06-14 20:57:18 +00003380**
3381** These routines are used by the xFunc or xFinal callbacks that
3382** implement SQL functions and aggregates. See
3383** [sqlite3_create_function()] and [sqlite3_create_function16()]
3384** for additional information.
3385**
mihailimebe796c2008-06-21 20:11:17 +00003386** These functions work very much like the [parameter binding] family of
3387** functions used to bind values to host parameters in prepared statements.
3388** Refer to the [SQL parameter] documentation for additional information.
drh6ed48bf2007-06-14 20:57:18 +00003389**
drhafc91042008-02-21 02:09:45 +00003390** The sqlite3_result_blob() interface sets the result from
mihailimebe796c2008-06-21 20:11:17 +00003391** an application-defined function to be the BLOB whose content is pointed
drhf5befa02007-12-06 02:42:07 +00003392** to by the second parameter and which is N bytes long where N is the
mihailimebe796c2008-06-21 20:11:17 +00003393** third parameter.
3394**
shane26b34032008-05-23 17:21:09 +00003395** The sqlite3_result_zeroblob() interfaces set the result of
mihailimebe796c2008-06-21 20:11:17 +00003396** the application-defined function to be a BLOB containing all zero
drhf5befa02007-12-06 02:42:07 +00003397** bytes and N bytes in size, where N is the value of the 2nd parameter.
drh6ed48bf2007-06-14 20:57:18 +00003398**
drhafc91042008-02-21 02:09:45 +00003399** The sqlite3_result_double() interface sets the result from
mihailimebe796c2008-06-21 20:11:17 +00003400** an application-defined function to be a floating point value specified
drhf5befa02007-12-06 02:42:07 +00003401** by its 2nd argument.
drhe53831d2007-08-17 01:14:38 +00003402**
drhafc91042008-02-21 02:09:45 +00003403** The sqlite3_result_error() and sqlite3_result_error16() functions
drhf5befa02007-12-06 02:42:07 +00003404** cause the implemented SQL function to throw an exception.
drhafc91042008-02-21 02:09:45 +00003405** SQLite uses the string pointed to by the
drhf5befa02007-12-06 02:42:07 +00003406** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16()
drhafc91042008-02-21 02:09:45 +00003407** as the text of an error message. SQLite interprets the error
mihailimebe796c2008-06-21 20:11:17 +00003408** message string from sqlite3_result_error() as UTF-8. SQLite
3409** interprets the string from sqlite3_result_error16() as UTF-16 in native
drhafc91042008-02-21 02:09:45 +00003410** byte order. If the third parameter to sqlite3_result_error()
drhf5befa02007-12-06 02:42:07 +00003411** or sqlite3_result_error16() is negative then SQLite takes as the error
3412** message all text up through the first zero character.
drhafc91042008-02-21 02:09:45 +00003413** If the third parameter to sqlite3_result_error() or
drhf5befa02007-12-06 02:42:07 +00003414** sqlite3_result_error16() is non-negative then SQLite takes that many
3415** bytes (not characters) from the 2nd parameter as the error message.
drhafc91042008-02-21 02:09:45 +00003416** The sqlite3_result_error() and sqlite3_result_error16()
mihailimebe796c2008-06-21 20:11:17 +00003417** routines make a private copy of the error message text before
drhafc91042008-02-21 02:09:45 +00003418** they return. Hence, the calling function can deallocate or
drhf5befa02007-12-06 02:42:07 +00003419** modify the text after they return without harm.
drh69544ec2008-02-06 14:11:34 +00003420** The sqlite3_result_error_code() function changes the error code
3421** returned by SQLite as a result of an error in a function. By default,
drh00e087b2008-04-10 17:14:07 +00003422** the error code is SQLITE_ERROR. A subsequent call to sqlite3_result_error()
3423** or sqlite3_result_error16() resets the error code to SQLITE_ERROR.
drhf5befa02007-12-06 02:42:07 +00003424**
mihailimebe796c2008-06-21 20:11:17 +00003425** The sqlite3_result_toobig() interface causes SQLite to throw an error
3426** indicating that a string or BLOB is to long to represent.
3427**
3428** The sqlite3_result_nomem() interface causes SQLite to throw an error
3429** indicating that a memory allocation failed.
drhf5befa02007-12-06 02:42:07 +00003430**
drhafc91042008-02-21 02:09:45 +00003431** The sqlite3_result_int() interface sets the return value
drhf5befa02007-12-06 02:42:07 +00003432** of the application-defined function to be the 32-bit signed integer
3433** value given in the 2nd argument.
drhafc91042008-02-21 02:09:45 +00003434** The sqlite3_result_int64() interface sets the return value
drhf5befa02007-12-06 02:42:07 +00003435** of the application-defined function to be the 64-bit signed integer
3436** value given in the 2nd argument.
3437**
drhafc91042008-02-21 02:09:45 +00003438** The sqlite3_result_null() interface sets the return value
drhf5befa02007-12-06 02:42:07 +00003439** of the application-defined function to be NULL.
3440**
mihailimebe796c2008-06-21 20:11:17 +00003441** The sqlite3_result_text(), sqlite3_result_text16(),
drhf5befa02007-12-06 02:42:07 +00003442** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces
3443** set the return value of the application-defined function to be
3444** a text string which is represented as UTF-8, UTF-16 native byte order,
3445** UTF-16 little endian, or UTF-16 big endian, respectively.
drhafc91042008-02-21 02:09:45 +00003446** SQLite takes the text result from the application from
drhf5befa02007-12-06 02:42:07 +00003447** the 2nd parameter of the sqlite3_result_text* interfaces.
drhafc91042008-02-21 02:09:45 +00003448** If the 3rd parameter to the sqlite3_result_text* interfaces
mihailimebe796c2008-06-21 20:11:17 +00003449** is negative, then SQLite takes result text from the 2nd parameter
drhf5befa02007-12-06 02:42:07 +00003450** through the first zero character.
drhafc91042008-02-21 02:09:45 +00003451** If the 3rd parameter to the sqlite3_result_text* interfaces
drhf5befa02007-12-06 02:42:07 +00003452** is non-negative, then as many bytes (not characters) of the text
3453** pointed to by the 2nd parameter are taken as the application-defined
3454** function result.
drhafc91042008-02-21 02:09:45 +00003455** If the 4th parameter to the sqlite3_result_text* interfaces
drhf5befa02007-12-06 02:42:07 +00003456** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that
mihailimebe796c2008-06-21 20:11:17 +00003457** function as the destructor on the text or BLOB result when it has
drhf5befa02007-12-06 02:42:07 +00003458** finished using that result.
mihailimebe796c2008-06-21 20:11:17 +00003459** If the 4th parameter to the sqlite3_result_text* interfaces or
3460** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite
3461** assumes that the text or BLOB result is in constant space and does not
3462** copy the it or call a destructor when it has finished using that result.
drhafc91042008-02-21 02:09:45 +00003463** If the 4th parameter to the sqlite3_result_text* interfaces
drhf5befa02007-12-06 02:42:07 +00003464** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT
3465** then SQLite makes a copy of the result into space obtained from
3466** from [sqlite3_malloc()] before it returns.
3467**
drhafc91042008-02-21 02:09:45 +00003468** The sqlite3_result_value() interface sets the result of
drhaa28e142008-03-18 13:47:20 +00003469** the application-defined function to be a copy the
3470** [unprotected sqlite3_value] object specified by the 2nd parameter. The
drhf5befa02007-12-06 02:42:07 +00003471** sqlite3_result_value() interface makes a copy of the [sqlite3_value]
mihailimebe796c2008-06-21 20:11:17 +00003472** so that the [sqlite3_value] specified in the parameter may change or
drhf5befa02007-12-06 02:42:07 +00003473** be deallocated after sqlite3_result_value() returns without harm.
drhaa28e142008-03-18 13:47:20 +00003474** A [protected sqlite3_value] object may always be used where an
3475** [unprotected sqlite3_value] object is required, so either
3476** kind of [sqlite3_value] object can be used with this interface.
drhf5befa02007-12-06 02:42:07 +00003477**
mihailimebe796c2008-06-21 20:11:17 +00003478** If these routines are called from within the different thread
shane26b34032008-05-23 17:21:09 +00003479** than the one containing the application-defined function that received
drhf5befa02007-12-06 02:42:07 +00003480** the [sqlite3_context] pointer, the results are undefined.
drhafc91042008-02-21 02:09:45 +00003481**
drh8b39db12009-02-18 18:37:58 +00003482** Requirements:
3483** [H16403] [H16406] [H16409] [H16412] [H16415] [H16418] [H16421] [H16424]
3484** [H16427] [H16430] [H16433] [H16436] [H16439] [H16442] [H16445] [H16448]
3485** [H16451] [H16454] [H16457] [H16460] [H16463]
danielk19777e18c252004-05-25 11:47:24 +00003486*/
danielk1977d8123362004-06-12 09:25:12 +00003487void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*));
drh4f26d6c2004-05-26 23:25:30 +00003488void sqlite3_result_double(sqlite3_context*, double);
danielk19777e18c252004-05-25 11:47:24 +00003489void sqlite3_result_error(sqlite3_context*, const char*, int);
3490void sqlite3_result_error16(sqlite3_context*, const void*, int);
drh6ed48bf2007-06-14 20:57:18 +00003491void sqlite3_result_error_toobig(sqlite3_context*);
danielk1977a1644fd2007-08-29 12:31:25 +00003492void sqlite3_result_error_nomem(sqlite3_context*);
drh69544ec2008-02-06 14:11:34 +00003493void sqlite3_result_error_code(sqlite3_context*, int);
drh4f26d6c2004-05-26 23:25:30 +00003494void sqlite3_result_int(sqlite3_context*, int);
drh6d2069d2007-08-14 01:58:53 +00003495void sqlite3_result_int64(sqlite3_context*, sqlite3_int64);
drh4f26d6c2004-05-26 23:25:30 +00003496void sqlite3_result_null(sqlite3_context*);
danielk1977d8123362004-06-12 09:25:12 +00003497void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*));
3498void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*));
3499void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*));
3500void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*));
drh4f26d6c2004-05-26 23:25:30 +00003501void sqlite3_result_value(sqlite3_context*, sqlite3_value*);
drhb026e052007-05-02 01:34:31 +00003502void sqlite3_result_zeroblob(sqlite3_context*, int n);
drhf9b596e2004-05-26 16:54:42 +00003503
drh52619df2004-06-11 17:48:02 +00003504/*
drh9cd29642008-07-23 00:52:55 +00003505** CAPI3REF: Define New Collating Sequences {H16600} <S20300>
drh6ed48bf2007-06-14 20:57:18 +00003506**
3507** These functions are used to add new collation sequences to the
mihailimebe796c2008-06-21 20:11:17 +00003508** [database connection] specified as the first argument.
danielk19777cedc8d2004-06-10 10:50:08 +00003509**
3510** The name of the new collation sequence is specified as a UTF-8 string
drh6ed48bf2007-06-14 20:57:18 +00003511** for sqlite3_create_collation() and sqlite3_create_collation_v2()
drhafc91042008-02-21 02:09:45 +00003512** and a UTF-16 string for sqlite3_create_collation16(). In all cases
drh6ed48bf2007-06-14 20:57:18 +00003513** the name is passed as the second function argument.
danielk19777cedc8d2004-06-10 10:50:08 +00003514**
drh4145f832007-10-12 18:30:12 +00003515** The third argument may be one of the constants [SQLITE_UTF8],
drh51c7d862009-04-27 18:46:06 +00003516** [SQLITE_UTF16LE], or [SQLITE_UTF16BE], indicating that the user-supplied
danielk19777cedc8d2004-06-10 10:50:08 +00003517** routine expects to be passed pointers to strings encoded using UTF-8,
mihailimebe796c2008-06-21 20:11:17 +00003518** UTF-16 little-endian, or UTF-16 big-endian, respectively. The
drh51c7d862009-04-27 18:46:06 +00003519** third argument might also be [SQLITE_UTF16] to indicate that the routine
3520** expects pointers to be UTF-16 strings in the native byte order, or the
3521** argument can be [SQLITE_UTF16_ALIGNED] if the
drh4145f832007-10-12 18:30:12 +00003522** the routine expects pointers to 16-bit word aligned strings
drh51c7d862009-04-27 18:46:06 +00003523** of UTF-16 in the native byte order.
danielk19777cedc8d2004-06-10 10:50:08 +00003524**
3525** A pointer to the user supplied routine must be passed as the fifth
drhafc91042008-02-21 02:09:45 +00003526** argument. If it is NULL, this is the same as deleting the collation
drhf5befa02007-12-06 02:42:07 +00003527** sequence (so that SQLite cannot call it anymore).
mihailimebe796c2008-06-21 20:11:17 +00003528** Each time the application supplied function is invoked, it is passed
3529** as its first parameter a copy of the void* passed as the fourth argument
3530** to sqlite3_create_collation() or sqlite3_create_collation16().
danielk19777cedc8d2004-06-10 10:50:08 +00003531**
drhf5befa02007-12-06 02:42:07 +00003532** The remaining arguments to the application-supplied routine are two strings,
drh33c1be32008-01-30 16:16:14 +00003533** each represented by a (length, data) pair and encoded in the encoding
danielk19777cedc8d2004-06-10 10:50:08 +00003534** that was passed as the third argument when the collation sequence was
mihailim04bcc002008-06-22 10:21:27 +00003535** registered. {END} The application defined collation routine should
mihailimebe796c2008-06-21 20:11:17 +00003536** return negative, zero or positive if the first string is less than,
3537** equal to, or greater than the second string. i.e. (STRING1 - STRING2).
drh6ed48bf2007-06-14 20:57:18 +00003538**
3539** The sqlite3_create_collation_v2() works like sqlite3_create_collation()
shane26b34032008-05-23 17:21:09 +00003540** except that it takes an extra argument which is a destructor for
drhafc91042008-02-21 02:09:45 +00003541** the collation. The destructor is called when the collation is
drh6ed48bf2007-06-14 20:57:18 +00003542** destroyed and is passed a copy of the fourth parameter void* pointer
drhf5befa02007-12-06 02:42:07 +00003543** of the sqlite3_create_collation_v2().
mihailimebe796c2008-06-21 20:11:17 +00003544** Collations are destroyed when they are overridden by later calls to the
3545** collation creation functions or when the [database connection] is closed
3546** using [sqlite3_close()].
drhafc91042008-02-21 02:09:45 +00003547**
drh51c7d862009-04-27 18:46:06 +00003548** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()].
3549**
drh8b39db12009-02-18 18:37:58 +00003550** Requirements:
3551** [H16603] [H16604] [H16606] [H16609] [H16612] [H16615] [H16618] [H16621]
3552** [H16624] [H16627] [H16630]
danielk19777cedc8d2004-06-10 10:50:08 +00003553*/
danielk19770202b292004-06-09 09:55:16 +00003554int sqlite3_create_collation(
3555 sqlite3*,
3556 const char *zName,
danielk19777cedc8d2004-06-10 10:50:08 +00003557 int eTextRep,
danielk19770202b292004-06-09 09:55:16 +00003558 void*,
3559 int(*xCompare)(void*,int,const void*,int,const void*)
3560);
drh6ed48bf2007-06-14 20:57:18 +00003561int sqlite3_create_collation_v2(
3562 sqlite3*,
3563 const char *zName,
3564 int eTextRep,
3565 void*,
3566 int(*xCompare)(void*,int,const void*,int,const void*),
3567 void(*xDestroy)(void*)
3568);
danielk19770202b292004-06-09 09:55:16 +00003569int sqlite3_create_collation16(
3570 sqlite3*,
mihailimbda2e622008-06-23 11:23:14 +00003571 const void *zName,
danielk19777cedc8d2004-06-10 10:50:08 +00003572 int eTextRep,
danielk19770202b292004-06-09 09:55:16 +00003573 void*,
3574 int(*xCompare)(void*,int,const void*,int,const void*)
3575);
3576
danielk19777cedc8d2004-06-10 10:50:08 +00003577/*
drh9cd29642008-07-23 00:52:55 +00003578** CAPI3REF: Collation Needed Callbacks {H16700} <S20300>
danielk1977a393c032007-05-07 14:58:53 +00003579**
danielk19777cedc8d2004-06-10 10:50:08 +00003580** To avoid having to register all collation sequences before a database
3581** can be used, a single callback function may be registered with the
mihailimdc884822008-06-22 08:58:50 +00003582** [database connection] to be called whenever an undefined collation
3583** sequence is required.
danielk19777cedc8d2004-06-10 10:50:08 +00003584**
3585** If the function is registered using the sqlite3_collation_needed() API,
3586** then it is passed the names of undefined collation sequences as strings
drh9a247912008-07-22 18:45:08 +00003587** encoded in UTF-8. {H16703} If sqlite3_collation_needed16() is used,
mihailimdc884822008-06-22 08:58:50 +00003588** the names are passed as UTF-16 in machine native byte order.
3589** A call to either function replaces any existing callback.
danielk19777cedc8d2004-06-10 10:50:08 +00003590**
drhafc91042008-02-21 02:09:45 +00003591** When the callback is invoked, the first argument passed is a copy
danielk19777cedc8d2004-06-10 10:50:08 +00003592** of the second argument to sqlite3_collation_needed() or
drhafc91042008-02-21 02:09:45 +00003593** sqlite3_collation_needed16(). The second argument is the database
mihailimdc884822008-06-22 08:58:50 +00003594** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE],
3595** or [SQLITE_UTF16LE], indicating the most desirable form of the collation
3596** sequence function required. The fourth parameter is the name of the
drhafc91042008-02-21 02:09:45 +00003597** required collation sequence.
danielk19777cedc8d2004-06-10 10:50:08 +00003598**
drh6ed48bf2007-06-14 20:57:18 +00003599** The callback function should register the desired collation using
3600** [sqlite3_create_collation()], [sqlite3_create_collation16()], or
3601** [sqlite3_create_collation_v2()].
drhafc91042008-02-21 02:09:45 +00003602**
drh8b39db12009-02-18 18:37:58 +00003603** Requirements:
3604** [H16702] [H16704] [H16706]
danielk19777cedc8d2004-06-10 10:50:08 +00003605*/
3606int sqlite3_collation_needed(
3607 sqlite3*,
3608 void*,
3609 void(*)(void*,sqlite3*,int eTextRep,const char*)
3610);
3611int sqlite3_collation_needed16(
3612 sqlite3*,
3613 void*,
3614 void(*)(void*,sqlite3*,int eTextRep,const void*)
3615);
3616
drh2011d5f2004-07-22 02:40:37 +00003617/*
3618** Specify the key for an encrypted database. This routine should be
3619** called right after sqlite3_open().
3620**
3621** The code to implement this API is not available in the public release
3622** of SQLite.
3623*/
3624int sqlite3_key(
3625 sqlite3 *db, /* Database to be rekeyed */
3626 const void *pKey, int nKey /* The key */
3627);
3628
3629/*
3630** Change the key on an open database. If the current database is not
3631** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the
3632** database is decrypted.
3633**
3634** The code to implement this API is not available in the public release
3635** of SQLite.
3636*/
3637int sqlite3_rekey(
3638 sqlite3 *db, /* Database to be rekeyed */
3639 const void *pKey, int nKey /* The new key */
3640);
danielk19770202b292004-06-09 09:55:16 +00003641
drhab3f9fe2004-08-14 17:10:10 +00003642/*
drhb25f9d82008-07-23 15:40:06 +00003643** CAPI3REF: Suspend Execution For A Short Time {H10530} <S40410>
drh6ed48bf2007-06-14 20:57:18 +00003644**
mihailimdc884822008-06-22 08:58:50 +00003645** The sqlite3_sleep() function causes the current thread to suspend execution
drhfddfa2d2007-12-05 18:05:16 +00003646** for at least a number of milliseconds specified in its parameter.
danielk1977600dd0b2005-01-20 01:14:23 +00003647**
mihailimdc884822008-06-22 08:58:50 +00003648** If the operating system does not support sleep requests with
3649** millisecond time resolution, then the time will be rounded up to
3650** the nearest second. The number of milliseconds of sleep actually
danielk1977600dd0b2005-01-20 01:14:23 +00003651** requested from the operating system is returned.
drh8bacf972007-08-25 16:21:29 +00003652**
drhafc91042008-02-21 02:09:45 +00003653** SQLite implements this interface by calling the xSleep()
3654** method of the default [sqlite3_vfs] object.
3655**
drh8b39db12009-02-18 18:37:58 +00003656** Requirements: [H10533] [H10536]
danielk1977600dd0b2005-01-20 01:14:23 +00003657*/
3658int sqlite3_sleep(int);
3659
3660/*
drhb25f9d82008-07-23 15:40:06 +00003661** CAPI3REF: Name Of The Folder Holding Temporary Files {H10310} <S20000>
drhd89bd002005-01-22 03:03:54 +00003662**
drh6ed48bf2007-06-14 20:57:18 +00003663** If this global variable is made to point to a string which is
shane26b34032008-05-23 17:21:09 +00003664** the name of a folder (a.k.a. directory), then all temporary files
drhab3f9fe2004-08-14 17:10:10 +00003665** created by SQLite will be placed in that directory. If this variable
mihailimdc884822008-06-22 08:58:50 +00003666** is a NULL pointer, then SQLite performs a search for an appropriate
3667** temporary file directory.
drhab3f9fe2004-08-14 17:10:10 +00003668**
drh1a25f112009-04-06 15:55:03 +00003669** It is not safe to read or modify this variable in more than one
3670** thread at a time. It is not safe to read or modify this variable
3671** if a [database connection] is being used at the same time in a separate
3672** thread.
3673** It is intended that this variable be set once
drh4ff7fa02007-09-01 18:17:21 +00003674** as part of process initialization and before any SQLite interface
drh1a25f112009-04-06 15:55:03 +00003675** routines have been called and that this variable remain unchanged
3676** thereafter.
3677**
3678** The [temp_store_directory pragma] may modify this variable and cause
3679** it to point to memory obtained from [sqlite3_malloc]. Furthermore,
3680** the [temp_store_directory pragma] always assumes that any string
3681** that this variable points to is held in memory obtained from
3682** [sqlite3_malloc] and the pragma may attempt to free that memory
3683** using [sqlite3_free].
3684** Hence, if this variable is modified directly, either it should be
3685** made NULL or made to point to memory obtained from [sqlite3_malloc]
3686** or else the use of the [temp_store_directory pragma] should be avoided.
drhab3f9fe2004-08-14 17:10:10 +00003687*/
drh73be5012007-08-08 12:11:21 +00003688SQLITE_EXTERN char *sqlite3_temp_directory;
drhab3f9fe2004-08-14 17:10:10 +00003689
danielk19776b456a22005-03-21 04:04:02 +00003690/*
drh9cd29642008-07-23 00:52:55 +00003691** CAPI3REF: Test For Auto-Commit Mode {H12930} <S60200>
mihailim15194222008-06-22 09:55:14 +00003692** KEYWORDS: {autocommit mode}
danielk19776b456a22005-03-21 04:04:02 +00003693**
shane26b34032008-05-23 17:21:09 +00003694** The sqlite3_get_autocommit() interface returns non-zero or
drhf5befa02007-12-06 02:42:07 +00003695** zero if the given database connection is or is not in autocommit mode,
mihailim04bcc002008-06-22 10:21:27 +00003696** respectively. Autocommit mode is on by default.
mihailimdc884822008-06-22 08:58:50 +00003697** Autocommit mode is disabled by a [BEGIN] statement.
shane26b34032008-05-23 17:21:09 +00003698** Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK].
drhe30f4422007-08-21 16:15:55 +00003699**
drh7c3472a2007-10-03 20:15:28 +00003700** If certain kinds of errors occur on a statement within a multi-statement
mihailimdc884822008-06-22 08:58:50 +00003701** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR],
drh7c3472a2007-10-03 20:15:28 +00003702** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the
drh33c1be32008-01-30 16:16:14 +00003703** transaction might be rolled back automatically. The only way to
mihailimdc884822008-06-22 08:58:50 +00003704** find out whether SQLite automatically rolled back the transaction after
drh33c1be32008-01-30 16:16:14 +00003705** an error is to use this function.
drh7c3472a2007-10-03 20:15:28 +00003706**
drh8b39db12009-02-18 18:37:58 +00003707** If another thread changes the autocommit status of the database
3708** connection while this routine is running, then the return value
3709** is undefined.
drh33c1be32008-01-30 16:16:14 +00003710**
drh8b39db12009-02-18 18:37:58 +00003711** Requirements: [H12931] [H12932] [H12933] [H12934]
drh3e1d8e62005-05-26 16:23:34 +00003712*/
3713int sqlite3_get_autocommit(sqlite3*);
3714
drh51942bc2005-06-12 22:01:42 +00003715/*
drhb25f9d82008-07-23 15:40:06 +00003716** CAPI3REF: Find The Database Handle Of A Prepared Statement {H13120} <S60600>
drh6ed48bf2007-06-14 20:57:18 +00003717**
mihailimdc884822008-06-22 08:58:50 +00003718** The sqlite3_db_handle interface returns the [database connection] handle
drh62b5d2d2009-02-03 18:47:22 +00003719** to which a [prepared statement] belongs. The [database connection]
3720** returned by sqlite3_db_handle is the same [database connection] that was the first argument
mihailimdc884822008-06-22 08:58:50 +00003721** to the [sqlite3_prepare_v2()] call (or its variants) that was used to
3722** create the statement in the first place.
drhafc91042008-02-21 02:09:45 +00003723**
drh8b39db12009-02-18 18:37:58 +00003724** Requirements: [H13123]
drh51942bc2005-06-12 22:01:42 +00003725*/
3726sqlite3 *sqlite3_db_handle(sqlite3_stmt*);
drh3e1d8e62005-05-26 16:23:34 +00003727
drhbb5a9c32008-06-19 02:52:25 +00003728/*
drhb25f9d82008-07-23 15:40:06 +00003729** CAPI3REF: Find the next prepared statement {H13140} <S60600>
drhbb5a9c32008-06-19 02:52:25 +00003730**
mihailimdc884822008-06-22 08:58:50 +00003731** This interface returns a pointer to the next [prepared statement] after
3732** pStmt associated with the [database connection] pDb. If pStmt is NULL
3733** then this interface returns a pointer to the first prepared statement
3734** associated with the database connection pDb. If no prepared statement
3735** satisfies the conditions of this routine, it returns NULL.
drhbb5a9c32008-06-19 02:52:25 +00003736**
drh8b39db12009-02-18 18:37:58 +00003737** The [database connection] pointer D in a call to
3738** [sqlite3_next_stmt(D,S)] must refer to an open database
3739** connection and in particular must not be a NULL pointer.
drhbb5a9c32008-06-19 02:52:25 +00003740**
drh8b39db12009-02-18 18:37:58 +00003741** Requirements: [H13143] [H13146] [H13149] [H13152]
drhbb5a9c32008-06-19 02:52:25 +00003742*/
3743sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt);
3744
drhb37df7b2005-10-13 02:09:49 +00003745/*
drh9cd29642008-07-23 00:52:55 +00003746** CAPI3REF: Commit And Rollback Notification Callbacks {H12950} <S60400>
drh6ed48bf2007-06-14 20:57:18 +00003747**
drhafc91042008-02-21 02:09:45 +00003748** The sqlite3_commit_hook() interface registers a callback
drhabda6112009-05-14 22:37:47 +00003749** function to be invoked whenever a transaction is [COMMIT | committed].
drhafc91042008-02-21 02:09:45 +00003750** Any callback set by a previous call to sqlite3_commit_hook()
drhf5befa02007-12-06 02:42:07 +00003751** for the same database connection is overridden.
drhafc91042008-02-21 02:09:45 +00003752** The sqlite3_rollback_hook() interface registers a callback
drhabda6112009-05-14 22:37:47 +00003753** function to be invoked whenever a transaction is [ROLLBACK | rolled back].
drhafc91042008-02-21 02:09:45 +00003754** Any callback set by a previous call to sqlite3_commit_hook()
drhf5befa02007-12-06 02:42:07 +00003755** for the same database connection is overridden.
mihailimdc884822008-06-22 08:58:50 +00003756** The pArg argument is passed through to the callback.
3757** If the callback on a commit hook function returns non-zero,
3758** then the commit is converted into a rollback.
drh6ed48bf2007-06-14 20:57:18 +00003759**
drhafc91042008-02-21 02:09:45 +00003760** If another function was previously registered, its
drhf5befa02007-12-06 02:42:07 +00003761** pArg value is returned. Otherwise NULL is returned.
drh6ed48bf2007-06-14 20:57:18 +00003762**
drhc8075422008-09-10 13:09:23 +00003763** The callback implementation must not do anything that will modify
3764** the database connection that invoked the callback. Any actions
3765** to modify the database connection must be deferred until after the
3766** completion of the [sqlite3_step()] call that triggered the commit
3767** or rollback hook in the first place.
3768** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
3769** database connections for the meaning of "modify" in this paragraph.
3770**
drhafc91042008-02-21 02:09:45 +00003771** Registering a NULL function disables the callback.
drh6ed48bf2007-06-14 20:57:18 +00003772**
drhabda6112009-05-14 22:37:47 +00003773** When the commit hook callback routine returns zero, the [COMMIT]
3774** operation is allowed to continue normally. If the commit hook
3775** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK].
3776** The rollback hook is invoked on a rollback that results from a commit
3777** hook returning non-zero, just as it would be with any other rollback.
3778**
mihailimdc884822008-06-22 08:58:50 +00003779** For the purposes of this API, a transaction is said to have been
drh6ed48bf2007-06-14 20:57:18 +00003780** rolled back if an explicit "ROLLBACK" statement is executed, or
drhf5befa02007-12-06 02:42:07 +00003781** an error or constraint causes an implicit rollback to occur.
drhafc91042008-02-21 02:09:45 +00003782** The rollback callback is not invoked if a transaction is
drhf5befa02007-12-06 02:42:07 +00003783** automatically rolled back because the database connection is closed.
drhafc91042008-02-21 02:09:45 +00003784** The rollback callback is not invoked if a transaction is
drhf5befa02007-12-06 02:42:07 +00003785** rolled back because a commit callback returned non-zero.
drhafc91042008-02-21 02:09:45 +00003786** <todo> Check on this </todo>
drh6ed48bf2007-06-14 20:57:18 +00003787**
drhabda6112009-05-14 22:37:47 +00003788** See also the [sqlite3_update_hook()] interface.
3789**
drh8b39db12009-02-18 18:37:58 +00003790** Requirements:
3791** [H12951] [H12952] [H12953] [H12954] [H12955]
3792** [H12961] [H12962] [H12963] [H12964]
drh6ed48bf2007-06-14 20:57:18 +00003793*/
3794void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
3795void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);
3796
3797/*
drh9cd29642008-07-23 00:52:55 +00003798** CAPI3REF: Data Change Notification Callbacks {H12970} <S60400>
drh6ed48bf2007-06-14 20:57:18 +00003799**
mihailimdc884822008-06-22 08:58:50 +00003800** The sqlite3_update_hook() interface registers a callback function
3801** with the [database connection] identified by the first argument
3802** to be invoked whenever a row is updated, inserted or deleted.
3803** Any callback set by a previous call to this function
3804** for the same database connection is overridden.
danielk197794eb6a12005-12-15 15:22:08 +00003805**
mihailimdc884822008-06-22 08:58:50 +00003806** The second argument is a pointer to the function to invoke when a
3807** row is updated, inserted or deleted.
3808** The first argument to the callback is a copy of the third argument
3809** to sqlite3_update_hook().
3810** The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE],
3811** or [SQLITE_UPDATE], depending on the operation that caused the callback
3812** to be invoked.
3813** The third and fourth arguments to the callback contain pointers to the
3814** database and table name containing the affected row.
drh49c3d572008-12-15 22:51:38 +00003815** The final callback parameter is the [rowid] of the row.
3816** In the case of an update, this is the [rowid] after the update takes place.
danielk197794eb6a12005-12-15 15:22:08 +00003817**
drhafc91042008-02-21 02:09:45 +00003818** The update hook is not invoked when internal system tables are
danielk197794eb6a12005-12-15 15:22:08 +00003819** modified (i.e. sqlite_master and sqlite_sequence).
danielk197771fd80b2005-12-16 06:54:01 +00003820**
drhabda6112009-05-14 22:37:47 +00003821** In the current implementation, the update hook
3822** is not invoked when duplication rows are deleted because of an
3823** [ON CONFLICT | ON CONFLICT REPLACE] clause. Nor is the update hook
3824** invoked when rows are deleted using the [truncate optimization].
3825** The exceptions defined in this paragraph might change in a future
3826** release of SQLite.
3827**
drhc8075422008-09-10 13:09:23 +00003828** The update hook implementation must not do anything that will modify
3829** the database connection that invoked the update hook. Any actions
3830** to modify the database connection must be deferred until after the
3831** completion of the [sqlite3_step()] call that triggered the update hook.
3832** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
3833** database connections for the meaning of "modify" in this paragraph.
3834**
drhafc91042008-02-21 02:09:45 +00003835** If another function was previously registered, its pArg value
3836** is returned. Otherwise NULL is returned.
3837**
drhabda6112009-05-14 22:37:47 +00003838** See also the [sqlite3_commit_hook()] and [sqlite3_rollback_hook()]
3839** interfaces.
3840**
drh8b39db12009-02-18 18:37:58 +00003841** Requirements:
3842** [H12971] [H12973] [H12975] [H12977] [H12979] [H12981] [H12983] [H12986]
danielk197794eb6a12005-12-15 15:22:08 +00003843*/
danielk197771fd80b2005-12-16 06:54:01 +00003844void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00003845 sqlite3*,
drh6d2069d2007-08-14 01:58:53 +00003846 void(*)(void *,int ,char const *,char const *,sqlite3_int64),
danielk197794eb6a12005-12-15 15:22:08 +00003847 void*
3848);
danielk197713a68c32005-12-15 10:11:30 +00003849
danielk1977f3f06bb2005-12-16 15:24:28 +00003850/*
drh9cd29642008-07-23 00:52:55 +00003851** CAPI3REF: Enable Or Disable Shared Pager Cache {H10330} <S30900>
mihailimefc8e8a2008-06-21 16:47:09 +00003852** KEYWORDS: {shared cache} {shared cache mode}
danielk1977f3f06bb2005-12-16 15:24:28 +00003853**
drh6ed48bf2007-06-14 20:57:18 +00003854** This routine enables or disables the sharing of the database cache
mihailimdc884822008-06-22 08:58:50 +00003855** and schema data structures between [database connection | connections]
3856** to the same database. Sharing is enabled if the argument is true
3857** and disabled if the argument is false.
danielk1977f3f06bb2005-12-16 15:24:28 +00003858**
drhaff46972009-02-12 17:07:34 +00003859** Cache sharing is enabled and disabled for an entire process.
mihailimdc884822008-06-22 08:58:50 +00003860** This is a change as of SQLite version 3.5.0. In prior versions of SQLite,
3861** sharing was enabled or disabled for each thread separately.
drh6ed48bf2007-06-14 20:57:18 +00003862**
drhe30f4422007-08-21 16:15:55 +00003863** The cache sharing mode set by this interface effects all subsequent
3864** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()].
drhafc91042008-02-21 02:09:45 +00003865** Existing database connections continue use the sharing mode
3866** that was in effect at the time they were opened.
drh6ed48bf2007-06-14 20:57:18 +00003867**
mihailimdc884822008-06-22 08:58:50 +00003868** Virtual tables cannot be used with a shared cache. When shared
drh4ff7fa02007-09-01 18:17:21 +00003869** cache is enabled, the [sqlite3_create_module()] API used to register
drhafc91042008-02-21 02:09:45 +00003870** virtual tables will always return an error.
drh6ed48bf2007-06-14 20:57:18 +00003871**
mihailimdc884822008-06-22 08:58:50 +00003872** This routine returns [SQLITE_OK] if shared cache was enabled or disabled
3873** successfully. An [error code] is returned otherwise.
drh6ed48bf2007-06-14 20:57:18 +00003874**
drhafc91042008-02-21 02:09:45 +00003875** Shared cache is disabled by default. But this might change in
drh4ff7fa02007-09-01 18:17:21 +00003876** future releases of SQLite. Applications that care about shared
3877** cache setting should set it explicitly.
drhafc91042008-02-21 02:09:45 +00003878**
drhaff46972009-02-12 17:07:34 +00003879** See Also: [SQLite Shared-Cache Mode]
3880**
drh8b39db12009-02-18 18:37:58 +00003881** Requirements: [H10331] [H10336] [H10337] [H10339]
danielk1977aef0bf62005-12-30 16:28:01 +00003882*/
3883int sqlite3_enable_shared_cache(int);
3884
3885/*
drh9cd29642008-07-23 00:52:55 +00003886** CAPI3REF: Attempt To Free Heap Memory {H17340} <S30220>
drh6ed48bf2007-06-14 20:57:18 +00003887**
mihailim04bcc002008-06-22 10:21:27 +00003888** The sqlite3_release_memory() interface attempts to free N bytes
3889** of heap memory by deallocating non-essential memory allocations
3890** held by the database library. {END} Memory used to cache database
3891** pages to improve performance is an example of non-essential memory.
3892** sqlite3_release_memory() returns the number of bytes actually freed,
3893** which might be more or less than the amount requested.
drhafc91042008-02-21 02:09:45 +00003894**
drh8b39db12009-02-18 18:37:58 +00003895** Requirements: [H17341] [H17342]
danielk197752622822006-01-09 09:59:49 +00003896*/
3897int sqlite3_release_memory(int);
3898
3899/*
drh9cd29642008-07-23 00:52:55 +00003900** CAPI3REF: Impose A Limit On Heap Size {H17350} <S30220>
drh6ed48bf2007-06-14 20:57:18 +00003901**
mihailimdc884822008-06-22 08:58:50 +00003902** The sqlite3_soft_heap_limit() interface places a "soft" limit
3903** on the amount of heap memory that may be allocated by SQLite.
3904** If an internal allocation is requested that would exceed the
3905** soft heap limit, [sqlite3_release_memory()] is invoked one or
3906** more times to free up some space before the allocation is performed.
danielk197752622822006-01-09 09:59:49 +00003907**
mihailimdc884822008-06-22 08:58:50 +00003908** The limit is called "soft", because if [sqlite3_release_memory()]
3909** cannot free sufficient memory to prevent the limit from being exceeded,
drhe30f4422007-08-21 16:15:55 +00003910** the memory is allocated anyway and the current operation proceeds.
drh6ed48bf2007-06-14 20:57:18 +00003911**
3912** A negative or zero value for N means that there is no soft heap limit and
drhe30f4422007-08-21 16:15:55 +00003913** [sqlite3_release_memory()] will only be called when memory is exhausted.
drhafc91042008-02-21 02:09:45 +00003914** The default value for the soft heap limit is zero.
drh6ed48bf2007-06-14 20:57:18 +00003915**
mihailim15194222008-06-22 09:55:14 +00003916** SQLite makes a best effort to honor the soft heap limit.
shane26b34032008-05-23 17:21:09 +00003917** But if the soft heap limit cannot be honored, execution will
mihailimdc884822008-06-22 08:58:50 +00003918** continue without error or notification. This is why the limit is
drh6ed48bf2007-06-14 20:57:18 +00003919** called a "soft" limit. It is advisory only.
3920**
drhe30f4422007-08-21 16:15:55 +00003921** Prior to SQLite version 3.5.0, this routine only constrained the memory
3922** allocated by a single thread - the same thread in which this routine
3923** runs. Beginning with SQLite version 3.5.0, the soft heap limit is
drhafc91042008-02-21 02:09:45 +00003924** applied to all threads. The value specified for the soft heap limit
3925** is an upper bound on the total memory allocation for all threads. In
drh8bacf972007-08-25 16:21:29 +00003926** version 3.5.0 there is no mechanism for limiting the heap usage for
3927** individual threads.
drhafc91042008-02-21 02:09:45 +00003928**
drh8b39db12009-02-18 18:37:58 +00003929** Requirements:
3930** [H16351] [H16352] [H16353] [H16354] [H16355] [H16358]
danielk197752622822006-01-09 09:59:49 +00003931*/
drhd2d4a6b2006-01-10 15:18:27 +00003932void sqlite3_soft_heap_limit(int);
danielk197752622822006-01-09 09:59:49 +00003933
3934/*
drh9cd29642008-07-23 00:52:55 +00003935** CAPI3REF: Extract Metadata About A Column Of A Table {H12850} <S60300>
drh6ed48bf2007-06-14 20:57:18 +00003936**
mihailimdc884822008-06-22 08:58:50 +00003937** This routine returns metadata about a specific column of a specific
3938** database table accessible using the [database connection] handle
3939** passed as the first function argument.
danielk1977deb802c2006-02-09 13:43:28 +00003940**
mihailimdc884822008-06-22 08:58:50 +00003941** The column is identified by the second, third and fourth parameters to
danielk1977deb802c2006-02-09 13:43:28 +00003942** this function. The second parameter is either the name of the database
3943** (i.e. "main", "temp" or an attached database) containing the specified
3944** table or NULL. If it is NULL, then all attached databases are searched
mihailimdc884822008-06-22 08:58:50 +00003945** for the table using the same algorithm used by the database engine to
danielk1977deb802c2006-02-09 13:43:28 +00003946** resolve unqualified table references.
3947**
mihailimdc884822008-06-22 08:58:50 +00003948** The third and fourth parameters to this function are the table and column
3949** name of the desired column, respectively. Neither of these parameters
danielk1977deb802c2006-02-09 13:43:28 +00003950** may be NULL.
3951**
mihailimdc884822008-06-22 08:58:50 +00003952** Metadata is returned by writing to the memory locations passed as the 5th
3953** and subsequent parameters to this function. Any of these arguments may be
3954** NULL, in which case the corresponding element of metadata is omitted.
mihailim15194222008-06-22 09:55:14 +00003955**
mihailimdc884822008-06-22 08:58:50 +00003956** <blockquote>
3957** <table border="1">
3958** <tr><th> Parameter <th> Output<br>Type <th> Description
danielk1977deb802c2006-02-09 13:43:28 +00003959**
mihailimdc884822008-06-22 08:58:50 +00003960** <tr><td> 5th <td> const char* <td> Data type
3961** <tr><td> 6th <td> const char* <td> Name of default collation sequence
3962** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint
3963** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY
drh49c3d572008-12-15 22:51:38 +00003964** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT]
mihailimdc884822008-06-22 08:58:50 +00003965** </table>
3966** </blockquote>
danielk1977deb802c2006-02-09 13:43:28 +00003967**
mihailimdc884822008-06-22 08:58:50 +00003968** The memory pointed to by the character pointers returned for the
3969** declaration type and collation sequence is valid only until the next
3970** call to any SQLite API function.
danielk1977deb802c2006-02-09 13:43:28 +00003971**
mihailimdc884822008-06-22 08:58:50 +00003972** If the specified table is actually a view, an [error code] is returned.
danielk1977deb802c2006-02-09 13:43:28 +00003973**
mihailimdc884822008-06-22 08:58:50 +00003974** If the specified column is "rowid", "oid" or "_rowid_" and an
drh49c3d572008-12-15 22:51:38 +00003975** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output
danielk1977deb802c2006-02-09 13:43:28 +00003976** parameters are set for the explicitly declared column. If there is no
drh49c3d572008-12-15 22:51:38 +00003977** explicitly declared [INTEGER PRIMARY KEY] column, then the output
mihailimdc884822008-06-22 08:58:50 +00003978** parameters are set as follows:
danielk1977deb802c2006-02-09 13:43:28 +00003979**
drh6ed48bf2007-06-14 20:57:18 +00003980** <pre>
danielk1977deb802c2006-02-09 13:43:28 +00003981** data type: "INTEGER"
3982** collation sequence: "BINARY"
3983** not null: 0
3984** primary key: 1
3985** auto increment: 0
drh6ed48bf2007-06-14 20:57:18 +00003986** </pre>
danielk1977deb802c2006-02-09 13:43:28 +00003987**
3988** This function may load one or more schemas from database files. If an
3989** error occurs during this process, or if the requested table or column
mihailimdc884822008-06-22 08:58:50 +00003990** cannot be found, an [error code] is returned and an error message left
3991** in the [database connection] (to be retrieved using sqlite3_errmsg()).
danielk19774b1ae992006-02-10 03:06:10 +00003992**
3993** This API is only available if the library was compiled with the
drh4ead1482008-06-26 18:16:05 +00003994** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined.
danielk1977deb802c2006-02-09 13:43:28 +00003995*/
3996int sqlite3_table_column_metadata(
3997 sqlite3 *db, /* Connection handle */
3998 const char *zDbName, /* Database name or NULL */
3999 const char *zTableName, /* Table name */
4000 const char *zColumnName, /* Column name */
4001 char const **pzDataType, /* OUTPUT: Declared data type */
4002 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
4003 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
4004 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh98c94802007-10-01 13:50:31 +00004005 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00004006);
4007
4008/*
drh9cd29642008-07-23 00:52:55 +00004009** CAPI3REF: Load An Extension {H12600} <S20500>
drh1e397f82006-06-08 15:28:43 +00004010**
mihailimdc884822008-06-22 08:58:50 +00004011** This interface loads an SQLite extension library from the named file.
drh1e397f82006-06-08 15:28:43 +00004012**
drh9a247912008-07-22 18:45:08 +00004013** {H12601} The sqlite3_load_extension() interface attempts to load an
mihailimdc884822008-06-22 08:58:50 +00004014** SQLite extension library contained in the file zFile.
drh1e397f82006-06-08 15:28:43 +00004015**
drh9a247912008-07-22 18:45:08 +00004016** {H12602} The entry point is zProc.
mihailimdc884822008-06-22 08:58:50 +00004017**
drh9a247912008-07-22 18:45:08 +00004018** {H12603} zProc may be 0, in which case the name of the entry point
mihailimdc884822008-06-22 08:58:50 +00004019** defaults to "sqlite3_extension_init".
4020**
drh9a247912008-07-22 18:45:08 +00004021** {H12604} The sqlite3_load_extension() interface shall return
mihailimdc884822008-06-22 08:58:50 +00004022** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.
4023**
drh9a247912008-07-22 18:45:08 +00004024** {H12605} If an error occurs and pzErrMsg is not 0, then the
mihailim421dfca2008-06-22 16:35:48 +00004025** [sqlite3_load_extension()] interface shall attempt to
4026** fill *pzErrMsg with error message text stored in memory
4027** obtained from [sqlite3_malloc()]. {END} The calling function
4028** should free this memory by calling [sqlite3_free()].
4029**
drh9a247912008-07-22 18:45:08 +00004030** {H12606} Extension loading must be enabled using
mihailimdc884822008-06-22 08:58:50 +00004031** [sqlite3_enable_load_extension()] prior to calling this API,
4032** otherwise an error will be returned.
drh1e397f82006-06-08 15:28:43 +00004033*/
4034int sqlite3_load_extension(
4035 sqlite3 *db, /* Load the extension into this database connection */
4036 const char *zFile, /* Name of the shared library containing extension */
4037 const char *zProc, /* Entry point. Derived from zFile if 0 */
4038 char **pzErrMsg /* Put error message here if not 0 */
4039);
4040
4041/*
drh9cd29642008-07-23 00:52:55 +00004042** CAPI3REF: Enable Or Disable Extension Loading {H12620} <S20500>
drh6ed48bf2007-06-14 20:57:18 +00004043**
drhc2e87a32006-06-27 15:16:14 +00004044** So as not to open security holes in older applications that are
drh6ed48bf2007-06-14 20:57:18 +00004045** unprepared to deal with extension loading, and as a means of disabling
mihailimdc884822008-06-22 08:58:50 +00004046** extension loading while evaluating user-entered SQL, the following API
4047** is provided to turn the [sqlite3_load_extension()] mechanism on and off.
drhc2e87a32006-06-27 15:16:14 +00004048**
mihailimdc884822008-06-22 08:58:50 +00004049** Extension loading is off by default. See ticket #1863.
4050**
drh9a247912008-07-22 18:45:08 +00004051** {H12621} Call the sqlite3_enable_load_extension() routine with onoff==1
mihailimdc884822008-06-22 08:58:50 +00004052** to turn extension loading on and call it with onoff==0 to turn
4053** it back off again.
4054**
drh9a247912008-07-22 18:45:08 +00004055** {H12622} Extension loading is off by default.
drhc2e87a32006-06-27 15:16:14 +00004056*/
4057int sqlite3_enable_load_extension(sqlite3 *db, int onoff);
4058
4059/*
drh9cd29642008-07-23 00:52:55 +00004060** CAPI3REF: Automatically Load An Extensions {H12640} <S20500>
drh9eff6162006-06-12 21:59:13 +00004061**
drh1409be62006-08-23 20:07:20 +00004062** This API can be invoked at program startup in order to register
4063** one or more statically linked extensions that will be available
mihailim04bcc002008-06-22 10:21:27 +00004064** to all new [database connections]. {END}
mihailimdc884822008-06-22 08:58:50 +00004065**
4066** This routine stores a pointer to the extension in an array that is
4067** obtained from [sqlite3_malloc()]. If you run a memory leak checker
4068** on your program and it reports a leak because of this array, invoke
4069** [sqlite3_reset_auto_extension()] prior to shutdown to free the memory.
4070**
drh9a247912008-07-22 18:45:08 +00004071** {H12641} This function registers an extension entry point that is
mihailimdc884822008-06-22 08:58:50 +00004072** automatically invoked whenever a new [database connection]
4073** is opened using [sqlite3_open()], [sqlite3_open16()],
4074** or [sqlite3_open_v2()].
4075**
drh9a247912008-07-22 18:45:08 +00004076** {H12642} Duplicate extensions are detected so calling this routine
mihailimdc884822008-06-22 08:58:50 +00004077** multiple times with the same extension is harmless.
4078**
drh9a247912008-07-22 18:45:08 +00004079** {H12643} This routine stores a pointer to the extension in an array
mihailimdc884822008-06-22 08:58:50 +00004080** that is obtained from [sqlite3_malloc()].
4081**
drh9a247912008-07-22 18:45:08 +00004082** {H12644} Automatic extensions apply across all threads.
drh1409be62006-08-23 20:07:20 +00004083*/
drh1875f7a2008-12-08 18:19:17 +00004084int sqlite3_auto_extension(void (*xEntryPoint)(void));
drh1409be62006-08-23 20:07:20 +00004085
drh1409be62006-08-23 20:07:20 +00004086/*
drh9cd29642008-07-23 00:52:55 +00004087** CAPI3REF: Reset Automatic Extension Loading {H12660} <S20500>
drh1409be62006-08-23 20:07:20 +00004088**
mihailim04bcc002008-06-22 10:21:27 +00004089** This function disables all previously registered automatic
4090** extensions. {END} It undoes the effect of all prior
4091** [sqlite3_auto_extension()] calls.
drh6ed48bf2007-06-14 20:57:18 +00004092**
drh9a247912008-07-22 18:45:08 +00004093** {H12661} This function disables all previously registered
mihailimdc884822008-06-22 08:58:50 +00004094** automatic extensions.
4095**
drh9a247912008-07-22 18:45:08 +00004096** {H12662} This function disables automatic extensions in all threads.
drh1409be62006-08-23 20:07:20 +00004097*/
4098void sqlite3_reset_auto_extension(void);
4099
drh1409be62006-08-23 20:07:20 +00004100/*
4101****** EXPERIMENTAL - subject to change without notice **************
4102**
drh9eff6162006-06-12 21:59:13 +00004103** The interface to the virtual-table mechanism is currently considered
4104** to be experimental. The interface might change in incompatible ways.
4105** If this is a problem for you, do not use the interface at this time.
4106**
shane26b34032008-05-23 17:21:09 +00004107** When the virtual-table mechanism stabilizes, we will declare the
drh9eff6162006-06-12 21:59:13 +00004108** interface fixed, support it indefinitely, and remove this comment.
4109*/
4110
4111/*
4112** Structures used by the virtual table interface
drhe09daa92006-06-10 13:29:31 +00004113*/
4114typedef struct sqlite3_vtab sqlite3_vtab;
4115typedef struct sqlite3_index_info sqlite3_index_info;
4116typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor;
4117typedef struct sqlite3_module sqlite3_module;
drh9eff6162006-06-12 21:59:13 +00004118
4119/*
drh9cd29642008-07-23 00:52:55 +00004120** CAPI3REF: Virtual Table Object {H18000} <S20400>
drh9cff9dc2009-04-13 14:43:40 +00004121** KEYWORDS: sqlite3_module {virtual table module}
drhd5a68d32008-08-04 13:44:57 +00004122** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004123**
drh9cff9dc2009-04-13 14:43:40 +00004124** This structure, sometimes called a a "virtual table module",
4125** defines the implementation of a [virtual tables].
4126** This structure consists mostly of methods for the module.
mihailim15194222008-06-22 09:55:14 +00004127**
drh9cff9dc2009-04-13 14:43:40 +00004128** A virtual table module is created by filling in a persistent
4129** instance of this structure and passing a pointer to that instance
4130** to [sqlite3_create_module()] or [sqlite3_create_module_v2()].
4131** The registration remains valid until it is replaced by a different
4132** module or until the [database connection] closes. The content
4133** of this structure must not change while it is registered with
4134** any database connection.
drh9eff6162006-06-12 21:59:13 +00004135*/
drhe09daa92006-06-10 13:29:31 +00004136struct sqlite3_module {
4137 int iVersion;
danielk19779da9d472006-06-14 06:58:15 +00004138 int (*xCreate)(sqlite3*, void *pAux,
drhe4102962006-09-11 00:34:22 +00004139 int argc, const char *const*argv,
drh4ca8aac2006-09-10 17:31:58 +00004140 sqlite3_vtab **ppVTab, char**);
danielk19779da9d472006-06-14 06:58:15 +00004141 int (*xConnect)(sqlite3*, void *pAux,
drhe4102962006-09-11 00:34:22 +00004142 int argc, const char *const*argv,
drh4ca8aac2006-09-10 17:31:58 +00004143 sqlite3_vtab **ppVTab, char**);
drhe09daa92006-06-10 13:29:31 +00004144 int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*);
4145 int (*xDisconnect)(sqlite3_vtab *pVTab);
4146 int (*xDestroy)(sqlite3_vtab *pVTab);
4147 int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor);
4148 int (*xClose)(sqlite3_vtab_cursor*);
drh4be8b512006-06-13 23:51:34 +00004149 int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr,
drhe09daa92006-06-10 13:29:31 +00004150 int argc, sqlite3_value **argv);
4151 int (*xNext)(sqlite3_vtab_cursor*);
danielk1977a298e902006-06-22 09:53:48 +00004152 int (*xEof)(sqlite3_vtab_cursor*);
drhe09daa92006-06-10 13:29:31 +00004153 int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int);
drh6d2069d2007-08-14 01:58:53 +00004154 int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid);
4155 int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *);
drhe09daa92006-06-10 13:29:31 +00004156 int (*xBegin)(sqlite3_vtab *pVTab);
4157 int (*xSync)(sqlite3_vtab *pVTab);
4158 int (*xCommit)(sqlite3_vtab *pVTab);
4159 int (*xRollback)(sqlite3_vtab *pVTab);
drhb7f6f682006-07-08 17:06:43 +00004160 int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName,
drhe94b0c32006-07-08 18:09:15 +00004161 void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),
4162 void **ppArg);
danielk1977182c4ba2007-06-27 15:53:34 +00004163 int (*xRename)(sqlite3_vtab *pVtab, const char *zNew);
drhe09daa92006-06-10 13:29:31 +00004164};
drh9eff6162006-06-12 21:59:13 +00004165
4166/*
drh9cd29642008-07-23 00:52:55 +00004167** CAPI3REF: Virtual Table Indexing Information {H18100} <S20400>
drhb4d58ae2008-02-21 20:17:06 +00004168** KEYWORDS: sqlite3_index_info
drhd5a68d32008-08-04 13:44:57 +00004169** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004170**
drh9eff6162006-06-12 21:59:13 +00004171** The sqlite3_index_info structure and its substructures is used to
drh9cff9dc2009-04-13 14:43:40 +00004172** pass information into and receive the reply from the [xBestIndex]
4173** method of a [virtual table module]. The fields under **Inputs** are the
drh9eff6162006-06-12 21:59:13 +00004174** inputs to xBestIndex and are read-only. xBestIndex inserts its
4175** results into the **Outputs** fields.
4176**
mihailim15194222008-06-22 09:55:14 +00004177** The aConstraint[] array records WHERE clause constraints of the form:
drh9eff6162006-06-12 21:59:13 +00004178**
mihailim15194222008-06-22 09:55:14 +00004179** <pre>column OP expr</pre>
drh9eff6162006-06-12 21:59:13 +00004180**
mihailim15194222008-06-22 09:55:14 +00004181** where OP is =, &lt;, &lt;=, &gt;, or &gt;=. The particular operator is
4182** stored in aConstraint[].op. The index of the column is stored in
drh9eff6162006-06-12 21:59:13 +00004183** aConstraint[].iColumn. aConstraint[].usable is TRUE if the
4184** expr on the right-hand side can be evaluated (and thus the constraint
4185** is usable) and false if it cannot.
4186**
4187** The optimizer automatically inverts terms of the form "expr OP column"
drh98c94802007-10-01 13:50:31 +00004188** and makes other simplifications to the WHERE clause in an attempt to
drh9eff6162006-06-12 21:59:13 +00004189** get as many WHERE clause terms into the form shown above as possible.
4190** The aConstraint[] array only reports WHERE clause terms in the correct
4191** form that refer to the particular virtual table being queried.
4192**
4193** Information about the ORDER BY clause is stored in aOrderBy[].
4194** Each term of aOrderBy records a column of the ORDER BY clause.
4195**
drh9cff9dc2009-04-13 14:43:40 +00004196** The [xBestIndex] method must fill aConstraintUsage[] with information
danielk19775fac9f82006-06-13 14:16:58 +00004197** about what parameters to pass to xFilter. If argvIndex>0 then
drh9eff6162006-06-12 21:59:13 +00004198** the right-hand side of the corresponding aConstraint[] is evaluated
4199** and becomes the argvIndex-th entry in argv. If aConstraintUsage[].omit
4200** is true, then the constraint is assumed to be fully handled by the
4201** virtual table and is not checked again by SQLite.
4202**
drh9cff9dc2009-04-13 14:43:40 +00004203** The idxNum and idxPtr values are recorded and passed into the
4204** [xFilter] method.
4205** [sqlite3_free()] is used to free idxPtr if and only iff
4206** needToFreeIdxPtr is true.
drh9eff6162006-06-12 21:59:13 +00004207**
drh9cff9dc2009-04-13 14:43:40 +00004208** The orderByConsumed means that output from [xFilter]/[xNext] will occur in
drh9eff6162006-06-12 21:59:13 +00004209** the correct order to satisfy the ORDER BY clause so that no separate
4210** sorting step is required.
4211**
4212** The estimatedCost value is an estimate of the cost of doing the
4213** particular lookup. A full scan of a table with N entries should have
4214** a cost of N. A binary search of a table of N entries should have a
4215** cost of approximately log(N).
4216*/
drhe09daa92006-06-10 13:29:31 +00004217struct sqlite3_index_info {
4218 /* Inputs */
drh6cca08c2007-09-21 12:43:16 +00004219 int nConstraint; /* Number of entries in aConstraint */
4220 struct sqlite3_index_constraint {
drh9eff6162006-06-12 21:59:13 +00004221 int iColumn; /* Column on left-hand side of constraint */
4222 unsigned char op; /* Constraint operator */
4223 unsigned char usable; /* True if this constraint is usable */
4224 int iTermOffset; /* Used internally - xBestIndex should ignore */
drh6cca08c2007-09-21 12:43:16 +00004225 } *aConstraint; /* Table of WHERE clause constraints */
4226 int nOrderBy; /* Number of terms in the ORDER BY clause */
4227 struct sqlite3_index_orderby {
drh9eff6162006-06-12 21:59:13 +00004228 int iColumn; /* Column number */
4229 unsigned char desc; /* True for DESC. False for ASC. */
drh6cca08c2007-09-21 12:43:16 +00004230 } *aOrderBy; /* The ORDER BY clause */
drhe09daa92006-06-10 13:29:31 +00004231 /* Outputs */
drh9eff6162006-06-12 21:59:13 +00004232 struct sqlite3_index_constraint_usage {
4233 int argvIndex; /* if >0, constraint is part of argv to xFilter */
4234 unsigned char omit; /* Do not code a test for this constraint */
drh6cca08c2007-09-21 12:43:16 +00004235 } *aConstraintUsage;
drh4be8b512006-06-13 23:51:34 +00004236 int idxNum; /* Number used to identify the index */
4237 char *idxStr; /* String, possibly obtained from sqlite3_malloc */
4238 int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */
drh9eff6162006-06-12 21:59:13 +00004239 int orderByConsumed; /* True if output is already ordered */
4240 double estimatedCost; /* Estimated cost of using this index */
drhe09daa92006-06-10 13:29:31 +00004241};
drh9eff6162006-06-12 21:59:13 +00004242#define SQLITE_INDEX_CONSTRAINT_EQ 2
4243#define SQLITE_INDEX_CONSTRAINT_GT 4
4244#define SQLITE_INDEX_CONSTRAINT_LE 8
4245#define SQLITE_INDEX_CONSTRAINT_LT 16
4246#define SQLITE_INDEX_CONSTRAINT_GE 32
4247#define SQLITE_INDEX_CONSTRAINT_MATCH 64
4248
4249/*
drh9cd29642008-07-23 00:52:55 +00004250** CAPI3REF: Register A Virtual Table Implementation {H18200} <S20400>
drhd5a68d32008-08-04 13:44:57 +00004251** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004252**
drh9cff9dc2009-04-13 14:43:40 +00004253** This routine is used to register a new [virtual table module] name.
4254** Module names must be registered before
4255** creating a new [virtual table] using the module, or before using a
4256** preexisting [virtual table] for the module.
mihailim15194222008-06-22 09:55:14 +00004257**
drh9cff9dc2009-04-13 14:43:40 +00004258** The module name is registered on the [database connection] specified
4259** by the first parameter. The name of the module is given by the
4260** second parameter. The third parameter is a pointer to
4261** the implementation of the [virtual table module]. The fourth
4262** parameter is an arbitrary client data pointer that is passed through
4263** into the [xCreate] and [xConnect] methods of the virtual table module
4264** when a new virtual table is be being created or reinitialized.
4265**
4266** This interface has exactly the same effect as calling
4267** [sqlite3_create_module_v2()] with a NULL client data destructor.
drh9eff6162006-06-12 21:59:13 +00004268*/
shanea79c3cc2008-08-11 17:27:01 +00004269SQLITE_EXPERIMENTAL int sqlite3_create_module(
drh9eff6162006-06-12 21:59:13 +00004270 sqlite3 *db, /* SQLite connection to register module with */
4271 const char *zName, /* Name of the module */
drh9cff9dc2009-04-13 14:43:40 +00004272 const sqlite3_module *p, /* Methods for the module */
4273 void *pClientData /* Client data for xCreate/xConnect */
drhb9bb7c12006-06-11 23:41:55 +00004274);
drhe09daa92006-06-10 13:29:31 +00004275
drh9eff6162006-06-12 21:59:13 +00004276/*
drh9cd29642008-07-23 00:52:55 +00004277** CAPI3REF: Register A Virtual Table Implementation {H18210} <S20400>
drhd5a68d32008-08-04 13:44:57 +00004278** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004279**
drh9cff9dc2009-04-13 14:43:40 +00004280** This routine is identical to the [sqlite3_create_module()] method,
4281** except that it has an extra parameter to specify
4282** a destructor function for the client data pointer. SQLite will
4283** invoke the destructor function (if it is not NULL) when SQLite
4284** no longer needs the pClientData pointer.
danielk1977832a58a2007-06-22 15:21:15 +00004285*/
shanea79c3cc2008-08-11 17:27:01 +00004286SQLITE_EXPERIMENTAL int sqlite3_create_module_v2(
danielk1977832a58a2007-06-22 15:21:15 +00004287 sqlite3 *db, /* SQLite connection to register module with */
4288 const char *zName, /* Name of the module */
drh9cff9dc2009-04-13 14:43:40 +00004289 const sqlite3_module *p, /* Methods for the module */
4290 void *pClientData, /* Client data for xCreate/xConnect */
danielk1977832a58a2007-06-22 15:21:15 +00004291 void(*xDestroy)(void*) /* Module destructor function */
4292);
4293
4294/*
drh9cd29642008-07-23 00:52:55 +00004295** CAPI3REF: Virtual Table Instance Object {H18010} <S20400>
drhb4d58ae2008-02-21 20:17:06 +00004296** KEYWORDS: sqlite3_vtab
drhd5a68d32008-08-04 13:44:57 +00004297** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004298**
drh9cff9dc2009-04-13 14:43:40 +00004299** Every [virtual table module] implementation uses a subclass
4300** of the following structure to describe a particular instance
4301** of the [virtual table]. Each subclass will
mihailim15194222008-06-22 09:55:14 +00004302** be tailored to the specific needs of the module implementation.
4303** The purpose of this superclass is to define certain fields that are
4304** common to all module implementations.
drhfe1368e2006-09-10 17:08:29 +00004305**
4306** Virtual tables methods can set an error message by assigning a
mihailim15194222008-06-22 09:55:14 +00004307** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should
4308** take care that any prior string is freed by a call to [sqlite3_free()]
drhfe1368e2006-09-10 17:08:29 +00004309** prior to assigning a new string to zErrMsg. After the error message
4310** is delivered up to the client application, the string will be automatically
drh9cff9dc2009-04-13 14:43:40 +00004311** freed by sqlite3_free() and the zErrMsg field will be zeroed.
drh9eff6162006-06-12 21:59:13 +00004312*/
4313struct sqlite3_vtab {
drha967e882006-06-13 01:04:52 +00004314 const sqlite3_module *pModule; /* The module for this virtual table */
danielk1977be718892006-06-23 08:05:19 +00004315 int nRef; /* Used internally */
drh4ca8aac2006-09-10 17:31:58 +00004316 char *zErrMsg; /* Error message from sqlite3_mprintf() */
drh9eff6162006-06-12 21:59:13 +00004317 /* Virtual table implementations will typically add additional fields */
4318};
4319
drhb4d58ae2008-02-21 20:17:06 +00004320/*
drh9cd29642008-07-23 00:52:55 +00004321** CAPI3REF: Virtual Table Cursor Object {H18020} <S20400>
drh9cff9dc2009-04-13 14:43:40 +00004322** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor}
drhd5a68d32008-08-04 13:44:57 +00004323** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004324**
drh9cff9dc2009-04-13 14:43:40 +00004325** Every [virtual table module] implementation uses a subclass of the
4326** following structure to describe cursors that point into the
4327** [virtual table] and are used
drh9eff6162006-06-12 21:59:13 +00004328** to loop through the virtual table. Cursors are created using the
drh9cff9dc2009-04-13 14:43:40 +00004329** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed
4330** by the [sqlite3_module.xClose | xClose] method. Cussors are used
4331** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods
4332** of the module. Each module implementation will define
drh9eff6162006-06-12 21:59:13 +00004333** the content of a cursor structure to suit its own needs.
4334**
4335** This superclass exists in order to define fields of the cursor that
4336** are common to all implementations.
4337*/
4338struct sqlite3_vtab_cursor {
4339 sqlite3_vtab *pVtab; /* Virtual table of this cursor */
4340 /* Virtual table implementations will typically add additional fields */
4341};
4342
4343/*
drh9cd29642008-07-23 00:52:55 +00004344** CAPI3REF: Declare The Schema Of A Virtual Table {H18280} <S20400>
drhd5a68d32008-08-04 13:44:57 +00004345** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004346**
drh9cff9dc2009-04-13 14:43:40 +00004347** The [xCreate] and [xConnect] methods of a
4348** [virtual table module] call this interface
drh9eff6162006-06-12 21:59:13 +00004349** to declare the format (the names and datatypes of the columns) of
4350** the virtual tables they implement.
4351*/
drh9cff9dc2009-04-13 14:43:40 +00004352SQLITE_EXPERIMENTAL int sqlite3_declare_vtab(sqlite3*, const char *zSQL);
drhe09daa92006-06-10 13:29:31 +00004353
4354/*
drh9cd29642008-07-23 00:52:55 +00004355** CAPI3REF: Overload A Function For A Virtual Table {H18300} <S20400>
drhd5a68d32008-08-04 13:44:57 +00004356** EXPERIMENTAL
drhb4d58ae2008-02-21 20:17:06 +00004357**
drhb7481e72006-09-16 21:45:14 +00004358** Virtual tables can provide alternative implementations of functions
drh9cff9dc2009-04-13 14:43:40 +00004359** using the [xFindFunction] method of the [virtual table module].
4360** But global versions of those functions
drhb7481e72006-09-16 21:45:14 +00004361** must exist in order to be overloaded.
4362**
4363** This API makes sure a global version of a function with a particular
4364** name and number of parameters exists. If no such function exists
4365** before this API is called, a new function is created. The implementation
4366** of the new function always causes an exception to be thrown. So
4367** the new function is not good for anything by itself. Its only
shane26b34032008-05-23 17:21:09 +00004368** purpose is to be a placeholder function that can be overloaded
drh9cff9dc2009-04-13 14:43:40 +00004369** by a [virtual table].
drhb7481e72006-09-16 21:45:14 +00004370*/
shanea79c3cc2008-08-11 17:27:01 +00004371SQLITE_EXPERIMENTAL int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg);
drhb7481e72006-09-16 21:45:14 +00004372
4373/*
drh9eff6162006-06-12 21:59:13 +00004374** The interface to the virtual-table mechanism defined above (back up
4375** to a comment remarkably similar to this one) is currently considered
4376** to be experimental. The interface might change in incompatible ways.
4377** If this is a problem for you, do not use the interface at this time.
4378**
drh98c94802007-10-01 13:50:31 +00004379** When the virtual-table mechanism stabilizes, we will declare the
drh9eff6162006-06-12 21:59:13 +00004380** interface fixed, support it indefinitely, and remove this comment.
4381**
4382****** EXPERIMENTAL - subject to change without notice **************
4383*/
4384
danielk19778cbadb02007-05-03 16:31:26 +00004385/*
drh9cd29642008-07-23 00:52:55 +00004386** CAPI3REF: A Handle To An Open BLOB {H17800} <S30230>
mihailim15194222008-06-22 09:55:14 +00004387** KEYWORDS: {BLOB handle} {BLOB handles}
drh6ed48bf2007-06-14 20:57:18 +00004388**
drhb4d58ae2008-02-21 20:17:06 +00004389** An instance of this object represents an open BLOB on which
mihailim1c492652008-06-21 18:02:16 +00004390** [sqlite3_blob_open | incremental BLOB I/O] can be performed.
mihailim15194222008-06-22 09:55:14 +00004391** Objects of this type are created by [sqlite3_blob_open()]
4392** and destroyed by [sqlite3_blob_close()].
drh6ed48bf2007-06-14 20:57:18 +00004393** The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces
mihailim15194222008-06-22 09:55:14 +00004394** can be used to read or write small subsections of the BLOB.
4395** The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes.
danielk19778cbadb02007-05-03 16:31:26 +00004396*/
danielk1977b4e9af92007-05-01 17:49:49 +00004397typedef struct sqlite3_blob sqlite3_blob;
4398
danielk19778cbadb02007-05-03 16:31:26 +00004399/*
drh9cd29642008-07-23 00:52:55 +00004400** CAPI3REF: Open A BLOB For Incremental I/O {H17810} <S30230>
drh6ed48bf2007-06-14 20:57:18 +00004401**
mihailim04bcc002008-06-22 10:21:27 +00004402** This interfaces opens a [BLOB handle | handle] to the BLOB located
drhf84ddc12008-03-24 12:51:46 +00004403** in row iRow, column zColumn, table zTable in database zDb;
mihailim15194222008-06-22 09:55:14 +00004404** in other words, the same BLOB that would be selected by:
danielk19778cbadb02007-05-03 16:31:26 +00004405**
drh6ed48bf2007-06-14 20:57:18 +00004406** <pre>
drh49c3d572008-12-15 22:51:38 +00004407** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow;
drhf5befa02007-12-06 02:42:07 +00004408** </pre> {END}
danielk19778cbadb02007-05-03 16:31:26 +00004409**
drh554b3832009-05-17 12:07:47 +00004410** If the flags parameter is non-zero, then the BLOB is opened for read
mihailim15194222008-06-22 09:55:14 +00004411** and write access. If it is zero, the BLOB is opened for read access.
danielk19778cbadb02007-05-03 16:31:26 +00004412**
drhf84ddc12008-03-24 12:51:46 +00004413** Note that the database name is not the filename that contains
4414** the database but rather the symbolic name of the database that
4415** is assigned when the database is connected using [ATTACH].
mihailim15194222008-06-22 09:55:14 +00004416** For the main database file, the database name is "main".
4417** For TEMP tables, the database name is "temp".
drhf84ddc12008-03-24 12:51:46 +00004418**
mihailim15194222008-06-22 09:55:14 +00004419** On success, [SQLITE_OK] is returned and the new [BLOB handle] is written
drhabda6112009-05-14 22:37:47 +00004420** to *ppBlob. Otherwise an [error code] is returned and *ppBlob is set
4421** to be a null pointer.
mihailim15194222008-06-22 09:55:14 +00004422** This function sets the [database connection] error code and message
drhabda6112009-05-14 22:37:47 +00004423** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()] and related
4424** functions. Note that the *ppBlob variable is always initialized in a
4425** way that makes it safe to invoke [sqlite3_blob_close()] on *ppBlob
4426** regardless of the success or failure of this routine.
mihailim15194222008-06-22 09:55:14 +00004427**
drh9de1b352008-06-26 15:04:57 +00004428** If the row that a BLOB handle points to is modified by an
4429** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects
4430** then the BLOB handle is marked as "expired".
4431** This is true if any column of the row is changed, even a column
4432** other than the one the BLOB handle is open on.
4433** Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for
4434** a expired BLOB handle fail with an return code of [SQLITE_ABORT].
4435** Changes written into a BLOB prior to the BLOB expiring are not
4436** rollback by the expiration of the BLOB. Such changes will eventually
4437** commit if the transaction continues to completion.
4438**
drhabda6112009-05-14 22:37:47 +00004439** Use the [sqlite3_blob_bytes()] interface to determine the size of
4440** the opened blob. The size of a blob may not be changed by this
4441** underface. Use the [UPDATE] SQL command to change the size of a
4442** blob.
4443**
4444** The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces
4445** and the built-in [zeroblob] SQL function can be used, if desired,
4446** to create an empty, zero-filled blob in which to read or write using
4447** this interface.
4448**
4449** To avoid a resource leak, every open [BLOB handle] should eventually
4450** be released by a call to [sqlite3_blob_close()].
4451**
drh8b39db12009-02-18 18:37:58 +00004452** Requirements:
4453** [H17813] [H17814] [H17816] [H17819] [H17821] [H17824]
danielk19778cbadb02007-05-03 16:31:26 +00004454*/
danielk1977b4e9af92007-05-01 17:49:49 +00004455int sqlite3_blob_open(
4456 sqlite3*,
4457 const char *zDb,
4458 const char *zTable,
4459 const char *zColumn,
drh6d2069d2007-08-14 01:58:53 +00004460 sqlite3_int64 iRow,
danielk1977b4e9af92007-05-01 17:49:49 +00004461 int flags,
4462 sqlite3_blob **ppBlob
4463);
4464
danielk19778cbadb02007-05-03 16:31:26 +00004465/*
drh9cd29642008-07-23 00:52:55 +00004466** CAPI3REF: Close A BLOB Handle {H17830} <S30230>
drh6ed48bf2007-06-14 20:57:18 +00004467**
mihailim15194222008-06-22 09:55:14 +00004468** Closes an open [BLOB handle].
drh2dd62be2007-12-04 13:22:43 +00004469**
drhb4d58ae2008-02-21 20:17:06 +00004470** Closing a BLOB shall cause the current transaction to commit
drhf5befa02007-12-06 02:42:07 +00004471** if there are no other BLOBs, no pending prepared statements, and the
mihailim15194222008-06-22 09:55:14 +00004472** database connection is in [autocommit mode].
drhb4d58ae2008-02-21 20:17:06 +00004473** If any writes were made to the BLOB, they might be held in cache
drhabda6112009-05-14 22:37:47 +00004474** until the close operation if they will fit.
mihailim15194222008-06-22 09:55:14 +00004475**
drhf5befa02007-12-06 02:42:07 +00004476** Closing the BLOB often forces the changes
drh2dd62be2007-12-04 13:22:43 +00004477** out to disk and so if any I/O errors occur, they will likely occur
drhabda6112009-05-14 22:37:47 +00004478** at the time when the BLOB is closed. Any errors that occur during
drh2dd62be2007-12-04 13:22:43 +00004479** closing are reported as a non-zero return value.
4480**
drhb4d58ae2008-02-21 20:17:06 +00004481** The BLOB is closed unconditionally. Even if this routine returns
drh2dd62be2007-12-04 13:22:43 +00004482** an error code, the BLOB is still closed.
drhb4d58ae2008-02-21 20:17:06 +00004483**
drhabda6112009-05-14 22:37:47 +00004484** Calling this routine with a null pointer (which as would be returned
4485** by failed call to [sqlite3_blob_open()]) is a harmless no-op.
4486**
drh8b39db12009-02-18 18:37:58 +00004487** Requirements:
4488** [H17833] [H17836] [H17839]
danielk19778cbadb02007-05-03 16:31:26 +00004489*/
danielk1977b4e9af92007-05-01 17:49:49 +00004490int sqlite3_blob_close(sqlite3_blob *);
4491
danielk19778cbadb02007-05-03 16:31:26 +00004492/*
drh9cd29642008-07-23 00:52:55 +00004493** CAPI3REF: Return The Size Of An Open BLOB {H17840} <S30230>
drh6ed48bf2007-06-14 20:57:18 +00004494**
drhabda6112009-05-14 22:37:47 +00004495** Returns the size in bytes of the BLOB accessible via the
4496** successfully opened [BLOB handle] in its only argument. The
4497** incremental blob I/O routines can only read or overwriting existing
4498** blob content; they cannot change the size of a blob.
4499**
4500** This routine only works on a [BLOB handle] which has been created
4501** by a prior successful call to [sqlite3_blob_open()] and which has not
4502** been closed by [sqlite3_blob_close()]. Passing any other pointer in
4503** to this routine results in undefined and probably undesirable behavior.
drhb4d58ae2008-02-21 20:17:06 +00004504**
drh8b39db12009-02-18 18:37:58 +00004505** Requirements:
4506** [H17843]
danielk19778cbadb02007-05-03 16:31:26 +00004507*/
danielk1977b4e9af92007-05-01 17:49:49 +00004508int sqlite3_blob_bytes(sqlite3_blob *);
4509
drh9eff6162006-06-12 21:59:13 +00004510/*
drh9cd29642008-07-23 00:52:55 +00004511** CAPI3REF: Read Data From A BLOB Incrementally {H17850} <S30230>
drh6ed48bf2007-06-14 20:57:18 +00004512**
mihailim15194222008-06-22 09:55:14 +00004513** This function is used to read data from an open [BLOB handle] into a
4514** caller-supplied buffer. N bytes of data are copied into buffer Z
4515** from the open BLOB, starting at offset iOffset.
danielk19778cbadb02007-05-03 16:31:26 +00004516**
mihailim15194222008-06-22 09:55:14 +00004517** If offset iOffset is less than N bytes from the end of the BLOB,
drhb4d58ae2008-02-21 20:17:06 +00004518** [SQLITE_ERROR] is returned and no data is read. If N or iOffset is
mihailim15194222008-06-22 09:55:14 +00004519** less than zero, [SQLITE_ERROR] is returned and no data is read.
drhabda6112009-05-14 22:37:47 +00004520** The size of the blob (and hence the maximum value of N+iOffset)
4521** can be determined using the [sqlite3_blob_bytes()] interface.
drhf5befa02007-12-06 02:42:07 +00004522**
drh9de1b352008-06-26 15:04:57 +00004523** An attempt to read from an expired [BLOB handle] fails with an
4524** error code of [SQLITE_ABORT].
4525**
mihailim15194222008-06-22 09:55:14 +00004526** On success, SQLITE_OK is returned.
4527** Otherwise, an [error code] or an [extended error code] is returned.
drhb4d58ae2008-02-21 20:17:06 +00004528**
drhabda6112009-05-14 22:37:47 +00004529** This routine only works on a [BLOB handle] which has been created
4530** by a prior successful call to [sqlite3_blob_open()] and which has not
4531** been closed by [sqlite3_blob_close()]. Passing any other pointer in
4532** to this routine results in undefined and probably undesirable behavior.
4533**
4534** See also: [sqlite3_blob_write()].
4535**
drh8b39db12009-02-18 18:37:58 +00004536** Requirements:
4537** [H17853] [H17856] [H17859] [H17862] [H17863] [H17865] [H17868]
danielk19778cbadb02007-05-03 16:31:26 +00004538*/
drhb4d58ae2008-02-21 20:17:06 +00004539int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset);
danielk19778cbadb02007-05-03 16:31:26 +00004540
4541/*
drh9cd29642008-07-23 00:52:55 +00004542** CAPI3REF: Write Data Into A BLOB Incrementally {H17870} <S30230>
drh6ed48bf2007-06-14 20:57:18 +00004543**
mihailim15194222008-06-22 09:55:14 +00004544** This function is used to write data into an open [BLOB handle] from a
4545** caller-supplied buffer. N bytes of data are copied from the buffer Z
4546** into the open BLOB, starting at offset iOffset.
danielk19778cbadb02007-05-03 16:31:26 +00004547**
mihailim15194222008-06-22 09:55:14 +00004548** If the [BLOB handle] passed as the first argument was not opened for
4549** writing (the flags parameter to [sqlite3_blob_open()] was zero),
4550** this function returns [SQLITE_READONLY].
danielk19778cbadb02007-05-03 16:31:26 +00004551**
mihailim15194222008-06-22 09:55:14 +00004552** This function may only modify the contents of the BLOB; it is
4553** not possible to increase the size of a BLOB using this API.
4554** If offset iOffset is less than N bytes from the end of the BLOB,
4555** [SQLITE_ERROR] is returned and no data is written. If N is
drhf5befa02007-12-06 02:42:07 +00004556** less than zero [SQLITE_ERROR] is returned and no data is written.
drhabda6112009-05-14 22:37:47 +00004557** The size of the BLOB (and hence the maximum value of N+iOffset)
4558** can be determined using the [sqlite3_blob_bytes()] interface.
danielk19778cbadb02007-05-03 16:31:26 +00004559**
drh9de1b352008-06-26 15:04:57 +00004560** An attempt to write to an expired [BLOB handle] fails with an
4561** error code of [SQLITE_ABORT]. Writes to the BLOB that occurred
4562** before the [BLOB handle] expired are not rolled back by the
4563** expiration of the handle, though of course those changes might
4564** have been overwritten by the statement that expired the BLOB handle
4565** or by other independent statements.
4566**
mihailim15194222008-06-22 09:55:14 +00004567** On success, SQLITE_OK is returned.
4568** Otherwise, an [error code] or an [extended error code] is returned.
drhb4d58ae2008-02-21 20:17:06 +00004569**
drhabda6112009-05-14 22:37:47 +00004570** This routine only works on a [BLOB handle] which has been created
4571** by a prior successful call to [sqlite3_blob_open()] and which has not
4572** been closed by [sqlite3_blob_close()]. Passing any other pointer in
4573** to this routine results in undefined and probably undesirable behavior.
4574**
4575** See also: [sqlite3_blob_read()].
4576**
drh8b39db12009-02-18 18:37:58 +00004577** Requirements:
4578** [H17873] [H17874] [H17875] [H17876] [H17877] [H17879] [H17882] [H17885]
4579** [H17888]
danielk19778cbadb02007-05-03 16:31:26 +00004580*/
4581int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset);
4582
drhd84f9462007-08-15 11:28:56 +00004583/*
drh9cd29642008-07-23 00:52:55 +00004584** CAPI3REF: Virtual File System Objects {H11200} <S20100>
drhd84f9462007-08-15 11:28:56 +00004585**
4586** A virtual filesystem (VFS) is an [sqlite3_vfs] object
4587** that SQLite uses to interact
drhb4d58ae2008-02-21 20:17:06 +00004588** with the underlying operating system. Most SQLite builds come with a
drhd84f9462007-08-15 11:28:56 +00004589** single default VFS that is appropriate for the host computer.
4590** New VFSes can be registered and existing VFSes can be unregistered.
4591** The following interfaces are provided.
4592**
mihailim15194222008-06-22 09:55:14 +00004593** The sqlite3_vfs_find() interface returns a pointer to a VFS given its name.
4594** Names are case sensitive.
drhb4d58ae2008-02-21 20:17:06 +00004595** Names are zero-terminated UTF-8 strings.
mihailim15194222008-06-22 09:55:14 +00004596** If there is no match, a NULL pointer is returned.
4597** If zVfsName is NULL then the default VFS is returned.
drhd84f9462007-08-15 11:28:56 +00004598**
drhb4d58ae2008-02-21 20:17:06 +00004599** New VFSes are registered with sqlite3_vfs_register().
4600** Each new VFS becomes the default VFS if the makeDflt flag is set.
4601** The same VFS can be registered multiple times without injury.
4602** To make an existing VFS into the default VFS, register it again
4603** with the makeDflt flag set. If two different VFSes with the
4604** same name are registered, the behavior is undefined. If a
drhb6f5cf32007-08-28 15:21:45 +00004605** VFS is registered with a name that is NULL or an empty string,
4606** then the behavior is undefined.
mihailim15194222008-06-22 09:55:14 +00004607**
drhb4d58ae2008-02-21 20:17:06 +00004608** Unregister a VFS with the sqlite3_vfs_unregister() interface.
4609** If the default VFS is unregistered, another VFS is chosen as
drhd84f9462007-08-15 11:28:56 +00004610** the default. The choice for the new VFS is arbitrary.
drhb4d58ae2008-02-21 20:17:06 +00004611**
drh8b39db12009-02-18 18:37:58 +00004612** Requirements:
4613** [H11203] [H11206] [H11209] [H11212] [H11215] [H11218]
drhd84f9462007-08-15 11:28:56 +00004614*/
drhd677b3d2007-08-20 22:48:41 +00004615sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName);
drhd677b3d2007-08-20 22:48:41 +00004616int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);
4617int sqlite3_vfs_unregister(sqlite3_vfs*);
drhd84f9462007-08-15 11:28:56 +00004618
4619/*
drh9cd29642008-07-23 00:52:55 +00004620** CAPI3REF: Mutexes {H17000} <S20000>
drhd84f9462007-08-15 11:28:56 +00004621**
4622** The SQLite core uses these routines for thread
danielk19774a9d1f62008-06-19 08:51:23 +00004623** synchronization. Though they are intended for internal
drhd84f9462007-08-15 11:28:56 +00004624** use by SQLite, code that links against SQLite is
4625** permitted to use any of these routines.
4626**
mihailim15194222008-06-22 09:55:14 +00004627** The SQLite source code contains multiple implementations
drh8bacf972007-08-25 16:21:29 +00004628** of these mutex routines. An appropriate implementation
4629** is selected automatically at compile-time. The following
4630** implementations are available in the SQLite core:
drhd84f9462007-08-15 11:28:56 +00004631**
4632** <ul>
drhc7ce76a2007-08-30 14:10:30 +00004633** <li> SQLITE_MUTEX_OS2
drhd84f9462007-08-15 11:28:56 +00004634** <li> SQLITE_MUTEX_PTHREAD
drhc7ce76a2007-08-30 14:10:30 +00004635** <li> SQLITE_MUTEX_W32
drhd84f9462007-08-15 11:28:56 +00004636** <li> SQLITE_MUTEX_NOOP
drhd84f9462007-08-15 11:28:56 +00004637** </ul>
4638**
mihailim15194222008-06-22 09:55:14 +00004639** The SQLITE_MUTEX_NOOP implementation is a set of routines
4640** that does no real locking and is appropriate for use in
drhc7ce76a2007-08-30 14:10:30 +00004641** a single-threaded application. The SQLITE_MUTEX_OS2,
4642** SQLITE_MUTEX_PTHREAD, and SQLITE_MUTEX_W32 implementations
shane26b34032008-05-23 17:21:09 +00004643** are appropriate for use on OS/2, Unix, and Windows.
mihailim15194222008-06-22 09:55:14 +00004644**
drh8bacf972007-08-25 16:21:29 +00004645** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor
4646** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex
danielk19774a9d1f62008-06-19 08:51:23 +00004647** implementation is included with the library. In this case the
4648** application must supply a custom mutex implementation using the
4649** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function
mihailim15194222008-06-22 09:55:14 +00004650** before calling sqlite3_initialize() or any other public sqlite3_
danielk19774a9d1f62008-06-19 08:51:23 +00004651** function that calls sqlite3_initialize().
drhcb041342008-06-12 00:07:29 +00004652**
drh9a247912008-07-22 18:45:08 +00004653** {H17011} The sqlite3_mutex_alloc() routine allocates a new
4654** mutex and returns a pointer to it. {H17012} If it returns NULL
4655** that means that a mutex could not be allocated. {H17013} SQLite
4656** will unwind its stack and return an error. {H17014} The argument
drh6bdec4a2007-08-16 19:40:16 +00004657** to sqlite3_mutex_alloc() is one of these integer constants:
4658**
4659** <ul>
4660** <li> SQLITE_MUTEX_FAST
4661** <li> SQLITE_MUTEX_RECURSIVE
4662** <li> SQLITE_MUTEX_STATIC_MASTER
4663** <li> SQLITE_MUTEX_STATIC_MEM
drh86f8c192007-08-22 00:39:19 +00004664** <li> SQLITE_MUTEX_STATIC_MEM2
drh6bdec4a2007-08-16 19:40:16 +00004665** <li> SQLITE_MUTEX_STATIC_PRNG
danielk19779f61c2f2007-08-27 17:27:49 +00004666** <li> SQLITE_MUTEX_STATIC_LRU
danielk1977dfb316d2008-03-26 18:34:43 +00004667** <li> SQLITE_MUTEX_STATIC_LRU2
mihailim04bcc002008-06-22 10:21:27 +00004668** </ul>
drh6bdec4a2007-08-16 19:40:16 +00004669**
drh9a247912008-07-22 18:45:08 +00004670** {H17015} The first two constants cause sqlite3_mutex_alloc() to create
drh6bdec4a2007-08-16 19:40:16 +00004671** a new mutex. The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
drhf5befa02007-12-06 02:42:07 +00004672** is used but not necessarily so when SQLITE_MUTEX_FAST is used. {END}
drh6bdec4a2007-08-16 19:40:16 +00004673** The mutex implementation does not need to make a distinction
4674** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
drh9a247912008-07-22 18:45:08 +00004675** not want to. {H17016} But SQLite will only request a recursive mutex in
drhf5befa02007-12-06 02:42:07 +00004676** cases where it really needs one. {END} If a faster non-recursive mutex
drh6bdec4a2007-08-16 19:40:16 +00004677** implementation is available on the host platform, the mutex subsystem
4678** might return such a mutex in response to SQLITE_MUTEX_FAST.
4679**
drh9a247912008-07-22 18:45:08 +00004680** {H17017} The other allowed parameters to sqlite3_mutex_alloc() each return
drhf5befa02007-12-06 02:42:07 +00004681** a pointer to a static preexisting mutex. {END} Four static mutexes are
drh6bdec4a2007-08-16 19:40:16 +00004682** used by the current version of SQLite. Future versions of SQLite
4683** may add additional static mutexes. Static mutexes are for internal
4684** use by SQLite only. Applications that use SQLite mutexes should
4685** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
4686** SQLITE_MUTEX_RECURSIVE.
4687**
drh9a247912008-07-22 18:45:08 +00004688** {H17018} Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
drh6bdec4a2007-08-16 19:40:16 +00004689** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
drh9a247912008-07-22 18:45:08 +00004690** returns a different mutex on every call. {H17034} But for the static
drh6bdec4a2007-08-16 19:40:16 +00004691** mutex types, the same mutex is returned on every call that has
mihailim04bcc002008-06-22 10:21:27 +00004692** the same type number.
drhd84f9462007-08-15 11:28:56 +00004693**
drh9a247912008-07-22 18:45:08 +00004694** {H17019} The sqlite3_mutex_free() routine deallocates a previously
4695** allocated dynamic mutex. {H17020} SQLite is careful to deallocate every
drh4766b292008-06-26 02:53:02 +00004696** dynamic mutex that it allocates. {A17021} The dynamic mutexes must not be in
4697** use when they are deallocated. {A17022} Attempting to deallocate a static
drh9a247912008-07-22 18:45:08 +00004698** mutex results in undefined behavior. {H17023} SQLite never deallocates
drhf5befa02007-12-06 02:42:07 +00004699** a static mutex. {END}
drhd84f9462007-08-15 11:28:56 +00004700**
drh6bdec4a2007-08-16 19:40:16 +00004701** The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
drh9a247912008-07-22 18:45:08 +00004702** to enter a mutex. {H17024} If another thread is already within the mutex,
drh6bdec4a2007-08-16 19:40:16 +00004703** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
drh9a247912008-07-22 18:45:08 +00004704** SQLITE_BUSY. {H17025} The sqlite3_mutex_try() interface returns [SQLITE_OK]
4705** upon successful entry. {H17026} Mutexes created using
drhf5befa02007-12-06 02:42:07 +00004706** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread.
drh9a247912008-07-22 18:45:08 +00004707** {H17027} In such cases the,
drh6bdec4a2007-08-16 19:40:16 +00004708** mutex must be exited an equal number of times before another thread
drh4766b292008-06-26 02:53:02 +00004709** can enter. {A17028} If the same thread tries to enter any other
drhf5befa02007-12-06 02:42:07 +00004710** kind of mutex more than once, the behavior is undefined.
drh9a247912008-07-22 18:45:08 +00004711** {H17029} SQLite will never exhibit
drhcb041342008-06-12 00:07:29 +00004712** such behavior in its own use of mutexes.
drhd84f9462007-08-15 11:28:56 +00004713**
mihailim15194222008-06-22 09:55:14 +00004714** Some systems (for example, Windows 95) do not support the operation
4715** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try()
drh9a247912008-07-22 18:45:08 +00004716** will always return SQLITE_BUSY. {H17030} The SQLite core only ever uses
drhcb041342008-06-12 00:07:29 +00004717** sqlite3_mutex_try() as an optimization so this is acceptable behavior.
drhca49cba2007-09-04 22:31:36 +00004718**
drh9a247912008-07-22 18:45:08 +00004719** {H17031} The sqlite3_mutex_leave() routine exits a mutex that was
drh4766b292008-06-26 02:53:02 +00004720** previously entered by the same thread. {A17032} The behavior
drh8bacf972007-08-25 16:21:29 +00004721** is undefined if the mutex is not currently entered by the
drh9a247912008-07-22 18:45:08 +00004722** calling thread or is not currently allocated. {H17033} SQLite will
drhf5befa02007-12-06 02:42:07 +00004723** never do either. {END}
drh8bacf972007-08-25 16:21:29 +00004724**
drh40257ff2008-06-13 18:24:27 +00004725** If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or
4726** sqlite3_mutex_leave() is a NULL pointer, then all three routines
4727** behave as no-ops.
4728**
drh8bacf972007-08-25 16:21:29 +00004729** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()].
4730*/
4731sqlite3_mutex *sqlite3_mutex_alloc(int);
4732void sqlite3_mutex_free(sqlite3_mutex*);
4733void sqlite3_mutex_enter(sqlite3_mutex*);
4734int sqlite3_mutex_try(sqlite3_mutex*);
4735void sqlite3_mutex_leave(sqlite3_mutex*);
4736
drh56a40a82008-06-18 13:47:03 +00004737/*
drh9cd29642008-07-23 00:52:55 +00004738** CAPI3REF: Mutex Methods Object {H17120} <S20130>
drhd5a68d32008-08-04 13:44:57 +00004739** EXPERIMENTAL
drh56a40a82008-06-18 13:47:03 +00004740**
4741** An instance of this structure defines the low-level routines
danielk19774a9d1f62008-06-19 08:51:23 +00004742** used to allocate and use mutexes.
4743**
4744** Usually, the default mutex implementations provided by SQLite are
mihailim15194222008-06-22 09:55:14 +00004745** sufficient, however the user has the option of substituting a custom
4746** implementation for specialized deployments or systems for which SQLite
danielk19774a9d1f62008-06-19 08:51:23 +00004747** does not provide a suitable implementation. In this case, the user
4748** creates and populates an instance of this structure to pass
mihailim15194222008-06-22 09:55:14 +00004749** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option.
danielk19774a9d1f62008-06-19 08:51:23 +00004750** Additionally, an instance of this structure can be used as an
4751** output variable when querying the system for the current mutex
4752** implementation, using the [SQLITE_CONFIG_GETMUTEX] option.
4753**
4754** The xMutexInit method defined by this structure is invoked as
4755** part of system initialization by the sqlite3_initialize() function.
drh9a247912008-07-22 18:45:08 +00004756** {H17001} The xMutexInit routine shall be called by SQLite once for each
mihailim15194222008-06-22 09:55:14 +00004757** effective call to [sqlite3_initialize()].
danielk19774a9d1f62008-06-19 08:51:23 +00004758**
4759** The xMutexEnd method defined by this structure is invoked as
4760** part of system shutdown by the sqlite3_shutdown() function. The
4761** implementation of this method is expected to release all outstanding
4762** resources obtained by the mutex methods implementation, especially
drh9a247912008-07-22 18:45:08 +00004763** those obtained by the xMutexInit method. {H17003} The xMutexEnd()
mihailim15194222008-06-22 09:55:14 +00004764** interface shall be invoked once for each call to [sqlite3_shutdown()].
danielk19774a9d1f62008-06-19 08:51:23 +00004765**
4766** The remaining seven methods defined by this structure (xMutexAlloc,
4767** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and
4768** xMutexNotheld) implement the following interfaces (respectively):
drh56a40a82008-06-18 13:47:03 +00004769**
4770** <ul>
danielk19774a9d1f62008-06-19 08:51:23 +00004771** <li> [sqlite3_mutex_alloc()] </li>
4772** <li> [sqlite3_mutex_free()] </li>
4773** <li> [sqlite3_mutex_enter()] </li>
4774** <li> [sqlite3_mutex_try()] </li>
4775** <li> [sqlite3_mutex_leave()] </li>
4776** <li> [sqlite3_mutex_held()] </li>
4777** <li> [sqlite3_mutex_notheld()] </li>
drh56a40a82008-06-18 13:47:03 +00004778** </ul>
danielk19774a9d1f62008-06-19 08:51:23 +00004779**
4780** The only difference is that the public sqlite3_XXX functions enumerated
4781** above silently ignore any invocations that pass a NULL pointer instead
4782** of a valid mutex handle. The implementations of the methods defined
4783** by this structure are not required to handle this case, the results
4784** of passing a NULL pointer instead of a valid mutex handle are undefined
4785** (i.e. it is acceptable to provide an implementation that segfaults if
4786** it is passed a NULL pointer).
drh56a40a82008-06-18 13:47:03 +00004787*/
danielk19776d2ab0e2008-06-17 17:21:18 +00004788typedef struct sqlite3_mutex_methods sqlite3_mutex_methods;
4789struct sqlite3_mutex_methods {
4790 int (*xMutexInit)(void);
danielk19774a9d1f62008-06-19 08:51:23 +00004791 int (*xMutexEnd)(void);
danielk19776d2ab0e2008-06-17 17:21:18 +00004792 sqlite3_mutex *(*xMutexAlloc)(int);
4793 void (*xMutexFree)(sqlite3_mutex *);
4794 void (*xMutexEnter)(sqlite3_mutex *);
4795 int (*xMutexTry)(sqlite3_mutex *);
4796 void (*xMutexLeave)(sqlite3_mutex *);
danielk19776d2ab0e2008-06-17 17:21:18 +00004797 int (*xMutexHeld)(sqlite3_mutex *);
4798 int (*xMutexNotheld)(sqlite3_mutex *);
4799};
4800
drh8bacf972007-08-25 16:21:29 +00004801/*
drh9cd29642008-07-23 00:52:55 +00004802** CAPI3REF: Mutex Verification Routines {H17080} <S20130> <S30800>
drhd677b3d2007-08-20 22:48:41 +00004803**
4804** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines
drh9a247912008-07-22 18:45:08 +00004805** are intended for use inside assert() statements. {H17081} The SQLite core
drhf77a2ff2007-08-25 14:49:36 +00004806** never uses these routines except inside an assert() and applications
drh9a247912008-07-22 18:45:08 +00004807** are advised to follow the lead of the core. {H17082} The core only
drh8bacf972007-08-25 16:21:29 +00004808** provides implementations for these routines when it is compiled
drh4766b292008-06-26 02:53:02 +00004809** with the SQLITE_DEBUG flag. {A17087} External mutex implementations
drh8bacf972007-08-25 16:21:29 +00004810** are only required to provide these routines if SQLITE_DEBUG is
4811** defined and if NDEBUG is not defined.
4812**
drh9a247912008-07-22 18:45:08 +00004813** {H17083} These routines should return true if the mutex in their argument
mihailim04bcc002008-06-22 10:21:27 +00004814** is held or not held, respectively, by the calling thread.
drh8bacf972007-08-25 16:21:29 +00004815**
drhfddfa2d2007-12-05 18:05:16 +00004816** {X17084} The implementation is not required to provided versions of these
mihailim04bcc002008-06-22 10:21:27 +00004817** routines that actually work. If the implementation does not provide working
4818** versions of these routines, it should at least provide stubs that always
4819** return true so that one does not get spurious assertion failures.
drhd677b3d2007-08-20 22:48:41 +00004820**
drh9a247912008-07-22 18:45:08 +00004821** {H17085} If the argument to sqlite3_mutex_held() is a NULL pointer then
drhfddfa2d2007-12-05 18:05:16 +00004822** the routine should return 1. {END} This seems counter-intuitive since
drhd677b3d2007-08-20 22:48:41 +00004823** clearly the mutex cannot be held if it does not exist. But the
4824** the reason the mutex does not exist is because the build is not
4825** using mutexes. And we do not want the assert() containing the
4826** call to sqlite3_mutex_held() to fail, so a non-zero return is
drh9a247912008-07-22 18:45:08 +00004827** the appropriate thing to do. {H17086} The sqlite3_mutex_notheld()
drhd677b3d2007-08-20 22:48:41 +00004828** interface should also return 1 when given a NULL pointer.
drhd84f9462007-08-15 11:28:56 +00004829*/
drhd677b3d2007-08-20 22:48:41 +00004830int sqlite3_mutex_held(sqlite3_mutex*);
4831int sqlite3_mutex_notheld(sqlite3_mutex*);
drh32bc3f62007-08-21 20:25:39 +00004832
4833/*
drh9cd29642008-07-23 00:52:55 +00004834** CAPI3REF: Mutex Types {H17001} <H17000>
drh32bc3f62007-08-21 20:25:39 +00004835**
drhd5a68d32008-08-04 13:44:57 +00004836** The [sqlite3_mutex_alloc()] interface takes a single argument
mihailim04bcc002008-06-22 10:21:27 +00004837** which is one of these integer constants.
drhd5a68d32008-08-04 13:44:57 +00004838**
4839** The set of static mutexes may change from one SQLite release to the
4840** next. Applications that override the built-in mutex logic must be
4841** prepared to accommodate additional static mutexes.
drh32bc3f62007-08-21 20:25:39 +00004842*/
drh6bdec4a2007-08-16 19:40:16 +00004843#define SQLITE_MUTEX_FAST 0
4844#define SQLITE_MUTEX_RECURSIVE 1
4845#define SQLITE_MUTEX_STATIC_MASTER 2
drh86f8c192007-08-22 00:39:19 +00004846#define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */
drh7555d8e2009-03-20 13:15:30 +00004847#define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */
4848#define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */
drh86f8c192007-08-22 00:39:19 +00004849#define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */
danielk19779f61c2f2007-08-27 17:27:49 +00004850#define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */
danielk1977dfb316d2008-03-26 18:34:43 +00004851#define SQLITE_MUTEX_STATIC_LRU2 7 /* lru page list */
drh6d2069d2007-08-14 01:58:53 +00004852
drhcc6bb3e2007-08-31 16:11:35 +00004853/*
drh4413d0e2008-11-04 13:46:27 +00004854** CAPI3REF: Retrieve the mutex for a database connection {H17002} <H17000>
4855**
4856** This interface returns a pointer the [sqlite3_mutex] object that
4857** serializes access to the [database connection] given in the argument
4858** when the [threading mode] is Serialized.
4859** If the [threading mode] is Single-thread or Multi-thread then this
4860** routine returns a NULL pointer.
4861*/
4862sqlite3_mutex *sqlite3_db_mutex(sqlite3*);
4863
4864/*
drh9cd29642008-07-23 00:52:55 +00004865** CAPI3REF: Low-Level Control Of Database Files {H11300} <S30800>
drhcc6bb3e2007-08-31 16:11:35 +00004866**
drh9a247912008-07-22 18:45:08 +00004867** {H11301} The [sqlite3_file_control()] interface makes a direct call to the
drhcc6bb3e2007-08-31 16:11:35 +00004868** xFileControl method for the [sqlite3_io_methods] object associated
drh9a247912008-07-22 18:45:08 +00004869** with a particular database identified by the second argument. {H11302} The
drhcc6bb3e2007-08-31 16:11:35 +00004870** name of the database is the name assigned to the database by the
4871** <a href="lang_attach.html">ATTACH</a> SQL command that opened the
drh9a247912008-07-22 18:45:08 +00004872** database. {H11303} To control the main database file, use the name "main"
4873** or a NULL pointer. {H11304} The third and fourth parameters to this routine
drhcc6bb3e2007-08-31 16:11:35 +00004874** are passed directly through to the second and third parameters of
drh9a247912008-07-22 18:45:08 +00004875** the xFileControl method. {H11305} The return value of the xFileControl
drhcc6bb3e2007-08-31 16:11:35 +00004876** method becomes the return value of this routine.
4877**
drh9a247912008-07-22 18:45:08 +00004878** {H11306} If the second parameter (zDbName) does not match the name of any
4879** open database file, then SQLITE_ERROR is returned. {H11307} This error
drhcc6bb3e2007-08-31 16:11:35 +00004880** code is not remembered and will not be recalled by [sqlite3_errcode()]
drh4766b292008-06-26 02:53:02 +00004881** or [sqlite3_errmsg()]. {A11308} The underlying xFileControl method might
4882** also return SQLITE_ERROR. {A11309} There is no way to distinguish between
drhcc6bb3e2007-08-31 16:11:35 +00004883** an incorrect zDbName and an SQLITE_ERROR return from the underlying
drhfddfa2d2007-12-05 18:05:16 +00004884** xFileControl method. {END}
drh4ff7fa02007-09-01 18:17:21 +00004885**
4886** See also: [SQLITE_FCNTL_LOCKSTATE]
drhcc6bb3e2007-08-31 16:11:35 +00004887*/
4888int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*);
drh6d2069d2007-08-14 01:58:53 +00004889
danielk19778cbadb02007-05-03 16:31:26 +00004890/*
drh9cd29642008-07-23 00:52:55 +00004891** CAPI3REF: Testing Interface {H11400} <S30800>
drhed13d982008-01-31 14:43:24 +00004892**
4893** The sqlite3_test_control() interface is used to read out internal
4894** state of SQLite and to inject faults into SQLite for testing
shane26b34032008-05-23 17:21:09 +00004895** purposes. The first parameter is an operation code that determines
drhed13d982008-01-31 14:43:24 +00004896** the number, meaning, and operation of all subsequent parameters.
4897**
4898** This interface is not for use by applications. It exists solely
4899** for verifying the correct operation of the SQLite library. Depending
4900** on how the SQLite library is compiled, this interface might not exist.
4901**
4902** The details of the operation codes, their meanings, the parameters
4903** they take, and what they do are all subject to change without notice.
4904** Unlike most of the SQLite API, this function is not guaranteed to
4905** operate consistently from one release to the next.
4906*/
4907int sqlite3_test_control(int op, ...);
4908
4909/*
drh9cd29642008-07-23 00:52:55 +00004910** CAPI3REF: Testing Interface Operation Codes {H11410} <H11400>
drhed13d982008-01-31 14:43:24 +00004911**
4912** These constants are the valid operation code parameters used
4913** as the first argument to [sqlite3_test_control()].
4914**
shane26b34032008-05-23 17:21:09 +00004915** These parameters and their meanings are subject to change
drhed13d982008-01-31 14:43:24 +00004916** without notice. These values are for testing purposes only.
4917** Applications should not use any of these parameters or the
4918** [sqlite3_test_control()] interface.
4919*/
drh2fa18682008-03-19 14:15:34 +00004920#define SQLITE_TESTCTRL_PRNG_SAVE 5
4921#define SQLITE_TESTCTRL_PRNG_RESTORE 6
4922#define SQLITE_TESTCTRL_PRNG_RESET 7
drh3088d592008-03-21 16:45:47 +00004923#define SQLITE_TESTCTRL_BITVEC_TEST 8
danielk1977d09414c2008-06-19 18:17:49 +00004924#define SQLITE_TESTCTRL_FAULT_INSTALL 9
danielk19772d1d86f2008-06-20 14:59:51 +00004925#define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10
drhc7a3bb92009-02-05 16:31:45 +00004926#define SQLITE_TESTCTRL_PENDING_BYTE 11
drhf3af63f2009-05-09 18:59:42 +00004927#define SQLITE_TESTCTRL_ASSERT 12
4928#define SQLITE_TESTCTRL_ALWAYS 13
drhed13d982008-01-31 14:43:24 +00004929
drhf7141992008-06-19 00:16:08 +00004930/*
drh9cd29642008-07-23 00:52:55 +00004931** CAPI3REF: SQLite Runtime Status {H17200} <S60200>
drhd5a68d32008-08-04 13:44:57 +00004932** EXPERIMENTAL
drhf7141992008-06-19 00:16:08 +00004933**
mihailim15194222008-06-22 09:55:14 +00004934** This interface is used to retrieve runtime status information
drhf7141992008-06-19 00:16:08 +00004935** about the preformance of SQLite, and optionally to reset various
4936** highwater marks. The first argument is an integer code for
4937** the specific parameter to measure. Recognized integer codes
4938** are of the form [SQLITE_STATUS_MEMORY_USED | SQLITE_STATUS_...].
4939** The current value of the parameter is returned into *pCurrent.
4940** The highest recorded value is returned in *pHighwater. If the
4941** resetFlag is true, then the highest record value is reset after
4942** *pHighwater is written. Some parameters do not record the highest
4943** value. For those parameters
4944** nothing is written into *pHighwater and the resetFlag is ignored.
4945** Other parameters record only the highwater mark and not the current
4946** value. For these latter parameters nothing is written into *pCurrent.
4947**
4948** This routine returns SQLITE_OK on success and a non-zero
4949** [error code] on failure.
4950**
4951** This routine is threadsafe but is not atomic. This routine can
4952** called while other threads are running the same or different SQLite
4953** interfaces. However the values returned in *pCurrent and
4954** *pHighwater reflect the status of SQLite at different points in time
4955** and it is possible that another thread might change the parameter
4956** in between the times when *pCurrent and *pHighwater are written.
4957**
drh2462e322008-07-31 14:47:54 +00004958** See also: [sqlite3_db_status()]
drhf7141992008-06-19 00:16:08 +00004959*/
shanea79c3cc2008-08-11 17:27:01 +00004960SQLITE_EXPERIMENTAL int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag);
drh2462e322008-07-31 14:47:54 +00004961
danielk1977075c23a2008-09-01 18:34:20 +00004962
drhf7141992008-06-19 00:16:08 +00004963/*
drh9cd29642008-07-23 00:52:55 +00004964** CAPI3REF: Status Parameters {H17250} <H17200>
drhd5a68d32008-08-04 13:44:57 +00004965** EXPERIMENTAL
drhf7141992008-06-19 00:16:08 +00004966**
4967** These integer constants designate various run-time status parameters
4968** that can be returned by [sqlite3_status()].
4969**
4970** <dl>
4971** <dt>SQLITE_STATUS_MEMORY_USED</dt>
4972** <dd>This parameter is the current amount of memory checked out
mihailim15194222008-06-22 09:55:14 +00004973** using [sqlite3_malloc()], either directly or indirectly. The
drhf7141992008-06-19 00:16:08 +00004974** figure includes calls made to [sqlite3_malloc()] by the application
4975** and internal memory usage by the SQLite library. Scratch memory
4976** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache
4977** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in
4978** this parameter. The amount returned is the sum of the allocation
mihailim15194222008-06-22 09:55:14 +00004979** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>
drhf7141992008-06-19 00:16:08 +00004980**
drhe50135e2008-08-05 17:53:22 +00004981** <dt>SQLITE_STATUS_MALLOC_SIZE</dt>
4982** <dd>This parameter records the largest memory allocation request
4983** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their
4984** internal equivalents). Only the value returned in the
4985** *pHighwater parameter to [sqlite3_status()] is of interest.
4986** The value written into the *pCurrent parameter is undefined.</dd>
4987**
drhf7141992008-06-19 00:16:08 +00004988** <dt>SQLITE_STATUS_PAGECACHE_USED</dt>
4989** <dd>This parameter returns the number of pages used out of the
drhe50135e2008-08-05 17:53:22 +00004990** [pagecache memory allocator] that was configured using
4991** [SQLITE_CONFIG_PAGECACHE]. The
drhf7141992008-06-19 00:16:08 +00004992** value returned is in pages, not in bytes.</dd>
4993**
4994** <dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt>
4995** <dd>This parameter returns the number of bytes of page cache
4996** allocation which could not be statisfied by the [SQLITE_CONFIG_PAGECACHE]
drhe50135e2008-08-05 17:53:22 +00004997** buffer and where forced to overflow to [sqlite3_malloc()]. The
4998** returned value includes allocations that overflowed because they
4999** where too large (they were larger than the "sz" parameter to
5000** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because
5001** no space was left in the page cache.</dd>
5002**
5003** <dt>SQLITE_STATUS_PAGECACHE_SIZE</dt>
5004** <dd>This parameter records the largest memory allocation request
5005** handed to [pagecache memory allocator]. Only the value returned in the
5006** *pHighwater parameter to [sqlite3_status()] is of interest.
5007** The value written into the *pCurrent parameter is undefined.</dd>
drhf7141992008-06-19 00:16:08 +00005008**
5009** <dt>SQLITE_STATUS_SCRATCH_USED</dt>
5010** <dd>This parameter returns the number of allocations used out of the
drhe50135e2008-08-05 17:53:22 +00005011** [scratch memory allocator] configured using
drhf7141992008-06-19 00:16:08 +00005012** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not
drhe50135e2008-08-05 17:53:22 +00005013** in bytes. Since a single thread may only have one scratch allocation
drhf7141992008-06-19 00:16:08 +00005014** outstanding at time, this parameter also reports the number of threads
5015** using scratch memory at the same time.</dd>
5016**
drh71f48622008-07-13 03:55:03 +00005017** <dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt>
drhf7141992008-06-19 00:16:08 +00005018** <dd>This parameter returns the number of bytes of scratch memory
5019** allocation which could not be statisfied by the [SQLITE_CONFIG_SCRATCH]
drhe50135e2008-08-05 17:53:22 +00005020** buffer and where forced to overflow to [sqlite3_malloc()]. The values
5021** returned include overflows because the requested allocation was too
5022** larger (that is, because the requested allocation was larger than the
5023** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer
5024** slots were available.
5025** </dd>
drhf7141992008-06-19 00:16:08 +00005026**
drhe50135e2008-08-05 17:53:22 +00005027** <dt>SQLITE_STATUS_SCRATCH_SIZE</dt>
drhf7141992008-06-19 00:16:08 +00005028** <dd>This parameter records the largest memory allocation request
drhe50135e2008-08-05 17:53:22 +00005029** handed to [scratch memory allocator]. Only the value returned in the
5030** *pHighwater parameter to [sqlite3_status()] is of interest.
5031** The value written into the *pCurrent parameter is undefined.</dd>
drhec424a52008-07-25 15:39:03 +00005032**
5033** <dt>SQLITE_STATUS_PARSER_STACK</dt>
5034** <dd>This parameter records the deepest parser stack. It is only
drh0a60a382008-07-31 17:16:05 +00005035** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>
drhf7141992008-06-19 00:16:08 +00005036** </dl>
5037**
5038** New status parameters may be added from time to time.
5039*/
5040#define SQLITE_STATUS_MEMORY_USED 0
5041#define SQLITE_STATUS_PAGECACHE_USED 1
5042#define SQLITE_STATUS_PAGECACHE_OVERFLOW 2
5043#define SQLITE_STATUS_SCRATCH_USED 3
5044#define SQLITE_STATUS_SCRATCH_OVERFLOW 4
5045#define SQLITE_STATUS_MALLOC_SIZE 5
drhec424a52008-07-25 15:39:03 +00005046#define SQLITE_STATUS_PARSER_STACK 6
drhe50135e2008-08-05 17:53:22 +00005047#define SQLITE_STATUS_PAGECACHE_SIZE 7
5048#define SQLITE_STATUS_SCRATCH_SIZE 8
drhf7141992008-06-19 00:16:08 +00005049
drh633e6d52008-07-28 19:34:53 +00005050/*
drhd1d38482008-10-07 23:46:38 +00005051** CAPI3REF: Database Connection Status {H17500} <S60200>
5052** EXPERIMENTAL
5053**
5054** This interface is used to retrieve runtime status information
5055** about a single [database connection]. The first argument is the
5056** database connection object to be interrogated. The second argument
5057** is the parameter to interrogate. Currently, the only allowed value
5058** for the second parameter is [SQLITE_DBSTATUS_LOOKASIDE_USED].
5059** Additional options will likely appear in future releases of SQLite.
5060**
5061** The current value of the requested parameter is written into *pCur
5062** and the highest instantaneous value is written into *pHiwtr. If
5063** the resetFlg is true, then the highest instantaneous value is
5064** reset back down to the current value.
5065**
5066** See also: [sqlite3_status()] and [sqlite3_stmt_status()].
5067*/
5068SQLITE_EXPERIMENTAL int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg);
5069
5070/*
5071** CAPI3REF: Status Parameters for database connections {H17520} <H17500>
drhd5a68d32008-08-04 13:44:57 +00005072** EXPERIMENTAL
drh633e6d52008-07-28 19:34:53 +00005073**
5074** Status verbs for [sqlite3_db_status()].
5075**
5076** <dl>
5077** <dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt>
5078** <dd>This parameter returns the number of lookaside memory slots currently
5079** checked out.</dd>
5080** </dl>
5081*/
5082#define SQLITE_DBSTATUS_LOOKASIDE_USED 0
drhed13d982008-01-31 14:43:24 +00005083
drhd1d38482008-10-07 23:46:38 +00005084
5085/*
5086** CAPI3REF: Prepared Statement Status {H17550} <S60200>
5087** EXPERIMENTAL
5088**
5089** Each prepared statement maintains various
5090** [SQLITE_STMTSTATUS_SORT | counters] that measure the number
5091** of times it has performed specific operations. These counters can
5092** be used to monitor the performance characteristics of the prepared
5093** statements. For example, if the number of table steps greatly exceeds
5094** the number of table searches or result rows, that would tend to indicate
5095** that the prepared statement is using a full table scan rather than
5096** an index.
5097**
5098** This interface is used to retrieve and reset counter values from
5099** a [prepared statement]. The first argument is the prepared statement
5100** object to be interrogated. The second argument
5101** is an integer code for a specific [SQLITE_STMTSTATUS_SORT | counter]
5102** to be interrogated.
5103** The current value of the requested counter is returned.
5104** If the resetFlg is true, then the counter is reset to zero after this
5105** interface call returns.
5106**
5107** See also: [sqlite3_status()] and [sqlite3_db_status()].
5108*/
5109SQLITE_EXPERIMENTAL int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg);
5110
5111/*
5112** CAPI3REF: Status Parameters for prepared statements {H17570} <H17550>
5113** EXPERIMENTAL
5114**
5115** These preprocessor macros define integer codes that name counter
5116** values associated with the [sqlite3_stmt_status()] interface.
5117** The meanings of the various counters are as follows:
5118**
5119** <dl>
5120** <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt>
5121** <dd>This is the number of times that SQLite has stepped forward in
5122** a table as part of a full table scan. Large numbers for this counter
5123** may indicate opportunities for performance improvement through
5124** careful use of indices.</dd>
5125**
5126** <dt>SQLITE_STMTSTATUS_SORT</dt>
5127** <dd>This is the number of sort operations that have occurred.
5128** A non-zero value in this counter may indicate an opportunity to
5129** improvement performance through careful use of indices.</dd>
5130**
5131** </dl>
5132*/
5133#define SQLITE_STMTSTATUS_FULLSCAN_STEP 1
5134#define SQLITE_STMTSTATUS_SORT 2
5135
drhed13d982008-01-31 14:43:24 +00005136/*
drh21614742008-11-18 19:18:08 +00005137** CAPI3REF: Custom Page Cache Object
5138** EXPERIMENTAL
5139**
danielk1977bc2ca9e2008-11-13 14:28:28 +00005140** The sqlite3_pcache type is opaque. It is implemented by
5141** the pluggable module. The SQLite core has no knowledge of
5142** its size or internal structure and never deals with the
5143** sqlite3_pcache object except by holding and passing pointers
5144** to the object.
drh21614742008-11-18 19:18:08 +00005145**
5146** See [sqlite3_pcache_methods] for additional information.
danielk1977bc2ca9e2008-11-13 14:28:28 +00005147*/
5148typedef struct sqlite3_pcache sqlite3_pcache;
5149
5150/*
drh21614742008-11-18 19:18:08 +00005151** CAPI3REF: Application Defined Page Cache.
danielk1977bc2ca9e2008-11-13 14:28:28 +00005152** EXPERIMENTAL
5153**
drh21614742008-11-18 19:18:08 +00005154** The [sqlite3_config]([SQLITE_CONFIG_PCACHE], ...) interface can
danielk1977bc2ca9e2008-11-13 14:28:28 +00005155** register an alternative page cache implementation by passing in an
5156** instance of the sqlite3_pcache_methods structure. The majority of the
5157** heap memory used by sqlite is used by the page cache to cache data read
5158** from, or ready to be written to, the database file. By implementing a
5159** custom page cache using this API, an application can control more
5160** precisely the amount of memory consumed by sqlite, the way in which
5161** said memory is allocated and released, and the policies used to
5162** determine exactly which parts of a database file are cached and for
5163** how long.
5164**
5165** The contents of the structure are copied to an internal buffer by sqlite
5166** within the call to [sqlite3_config].
5167**
drh21614742008-11-18 19:18:08 +00005168** The xInit() method is called once for each call to [sqlite3_initialize()]
danielk1977bc2ca9e2008-11-13 14:28:28 +00005169** (usually only once during the lifetime of the process). It is passed
5170** a copy of the sqlite3_pcache_methods.pArg value. It can be used to set
5171** up global structures and mutexes required by the custom page cache
5172** implementation. The xShutdown() method is called from within
drh21614742008-11-18 19:18:08 +00005173** [sqlite3_shutdown()], if the application invokes this API. It can be used
danielk1977bc2ca9e2008-11-13 14:28:28 +00005174** to clean up any outstanding resources before process shutdown, if required.
5175**
5176** The xCreate() method is used to construct a new cache instance. The
5177** first parameter, szPage, is the size in bytes of the pages that must
5178** be allocated by the cache. szPage will not be a power of two. The
5179** second argument, bPurgeable, is true if the cache being created will
5180** be used to cache database pages read from a file stored on disk, or
5181** false if it is used for an in-memory database. The cache implementation
5182** does not have to do anything special based on the value of bPurgeable,
5183** it is purely advisory.
5184**
5185** The xCachesize() method may be called at any time by SQLite to set the
5186** suggested maximum cache-size (number of pages stored by) the cache
5187** instance passed as the first argument. This is the value configured using
drh21614742008-11-18 19:18:08 +00005188** the SQLite "[PRAGMA cache_size]" command. As with the bPurgeable parameter,
danielk1977bc2ca9e2008-11-13 14:28:28 +00005189** the implementation is not required to do anything special with this
5190** value, it is advisory only.
5191**
5192** The xPagecount() method should return the number of pages currently
5193** stored in the cache supplied as an argument.
5194**
5195** The xFetch() method is used to fetch a page and return a pointer to it.
5196** A 'page', in this context, is a buffer of szPage bytes aligned at an
5197** 8-byte boundary. The page to be fetched is determined by the key. The
5198** mimimum key value is 1. After it has been retrieved using xFetch, the page
5199** is considered to be pinned.
5200**
5201** If the requested page is already in the page cache, then a pointer to
5202** the cached buffer should be returned with its contents intact. If the
5203** page is not already in the cache, then the expected behaviour of the
5204** cache is determined by the value of the createFlag parameter passed
5205** to xFetch, according to the following table:
5206**
5207** <table border=1 width=85% align=center>
5208** <tr><th>createFlag<th>Expected Behaviour
5209** <tr><td>0<td>NULL should be returned. No new cache entry is created.
5210** <tr><td>1<td>If createFlag is set to 1, this indicates that
5211** SQLite is holding pinned pages that can be unpinned
5212** by writing their contents to the database file (a
5213** relatively expensive operation). In this situation the
5214** cache implementation has two choices: it can return NULL,
5215** in which case SQLite will attempt to unpin one or more
5216** pages before re-requesting the same page, or it can
5217** allocate a new page and return a pointer to it. If a new
danielk1977e1fd5082009-01-23 16:45:00 +00005218** page is allocated, then the first sizeof(void*) bytes of
5219** it (at least) must be zeroed before it is returned.
danielk1977bc2ca9e2008-11-13 14:28:28 +00005220** <tr><td>2<td>If createFlag is set to 2, then SQLite is not holding any
5221** pinned pages associated with the specific cache passed
5222** as the first argument to xFetch() that can be unpinned. The
5223** cache implementation should attempt to allocate a new
danielk1977e1fd5082009-01-23 16:45:00 +00005224** cache entry and return a pointer to it. Again, the first
5225** sizeof(void*) bytes of the page should be zeroed before
5226** it is returned. If the xFetch() method returns NULL when
5227** createFlag==2, SQLite assumes that a memory allocation
5228** failed and returns SQLITE_NOMEM to the user.
danielk1977bc2ca9e2008-11-13 14:28:28 +00005229** </table>
5230**
5231** xUnpin() is called by SQLite with a pointer to a currently pinned page
5232** as its second argument. If the third parameter, discard, is non-zero,
5233** then the page should be evicted from the cache. In this case SQLite
5234** assumes that the next time the page is retrieved from the cache using
5235** the xFetch() method, it will be zeroed. If the discard parameter is
5236** zero, then the page is considered to be unpinned. The cache implementation
5237** may choose to reclaim (free or recycle) unpinned pages at any time.
5238** SQLite assumes that next time the page is retrieved from the cache
5239** it will either be zeroed, or contain the same data that it did when it
5240** was unpinned.
5241**
5242** The cache is not required to perform any reference counting. A single
5243** call to xUnpin() unpins the page regardless of the number of prior calls
5244** to xFetch().
5245**
5246** The xRekey() method is used to change the key value associated with the
5247** page passed as the second argument from oldKey to newKey. If the cache
drhb232c232008-11-19 01:20:26 +00005248** previously contains an entry associated with newKey, it should be
5249** discarded. Any prior cache entry associated with newKey is guaranteed not
5250** to be pinned.
danielk1977bc2ca9e2008-11-13 14:28:28 +00005251**
5252** When SQLite calls the xTruncate() method, the cache must discard all
5253** existing cache entries with page numbers (keys) greater than or equal
5254** to the value of the iLimit parameter passed to xTruncate(). If any
5255** of these pages are pinned, they are implicitly unpinned, meaning that
5256** they can be safely discarded.
5257**
5258** The xDestroy() method is used to delete a cache allocated by xCreate().
5259** All resources associated with the specified cache should be freed. After
drh21614742008-11-18 19:18:08 +00005260** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*]
danielk1977bc2ca9e2008-11-13 14:28:28 +00005261** handle invalid, and will not use it with any other sqlite3_pcache_methods
5262** functions.
5263*/
5264typedef struct sqlite3_pcache_methods sqlite3_pcache_methods;
5265struct sqlite3_pcache_methods {
5266 void *pArg;
5267 int (*xInit)(void*);
5268 void (*xShutdown)(void*);
5269 sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable);
5270 void (*xCachesize)(sqlite3_pcache*, int nCachesize);
5271 int (*xPagecount)(sqlite3_pcache*);
5272 void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
5273 void (*xUnpin)(sqlite3_pcache*, void*, int discard);
5274 void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey);
5275 void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);
5276 void (*xDestroy)(sqlite3_pcache*);
5277};
5278
5279/*
drh27b3b842009-02-03 18:25:13 +00005280** CAPI3REF: Online Backup Object
5281** EXPERIMENTAL
5282**
5283** The sqlite3_backup object records state information about an ongoing
5284** online backup operation. The sqlite3_backup object is created by
5285** a call to [sqlite3_backup_init()] and is destroyed by a call to
5286** [sqlite3_backup_finish()].
drh52224a72009-02-10 13:41:42 +00005287**
5288** See Also: [Using the SQLite Online Backup API]
drh27b3b842009-02-03 18:25:13 +00005289*/
5290typedef struct sqlite3_backup sqlite3_backup;
5291
5292/*
danielk197704103022009-02-03 16:51:24 +00005293** CAPI3REF: Online Backup API.
5294** EXPERIMENTAL
5295**
5296** This API is used to overwrite the contents of one database with that
5297** of another. It is useful either for creating backups of databases or
5298** for copying in-memory databases to or from persistent files.
5299**
drh52224a72009-02-10 13:41:42 +00005300** See Also: [Using the SQLite Online Backup API]
5301**
danielk197704103022009-02-03 16:51:24 +00005302** Exclusive access is required to the destination database for the
5303** duration of the operation. However the source database is only
5304** read-locked while it is actually being read, it is not locked
5305** continuously for the entire operation. Thus, the backup may be
5306** performed on a live database without preventing other users from
5307** writing to the database for an extended period of time.
5308**
5309** To perform a backup operation:
5310** <ol>
drh62b5d2d2009-02-03 18:47:22 +00005311** <li><b>sqlite3_backup_init()</b> is called once to initialize the
5312** backup,
5313** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer
danielk197704103022009-02-03 16:51:24 +00005314** the data between the two databases, and finally
drh62b5d2d2009-02-03 18:47:22 +00005315** <li><b>sqlite3_backup_finish()</b> is called to release all resources
danielk197704103022009-02-03 16:51:24 +00005316** associated with the backup operation.
5317** </ol>
5318** There should be exactly one call to sqlite3_backup_finish() for each
5319** successful call to sqlite3_backup_init().
5320**
5321** <b>sqlite3_backup_init()</b>
5322**
5323** The first two arguments passed to [sqlite3_backup_init()] are the database
5324** handle associated with the destination database and the database name
5325** used to attach the destination database to the handle. The database name
5326** is "main" for the main database, "temp" for the temporary database, or
drh62b5d2d2009-02-03 18:47:22 +00005327** the name specified as part of the [ATTACH] statement if the destination is
danielk197704103022009-02-03 16:51:24 +00005328** an attached database. The third and fourth arguments passed to
drh62b5d2d2009-02-03 18:47:22 +00005329** sqlite3_backup_init() identify the [database connection]
5330** and database name used
danielk197704103022009-02-03 16:51:24 +00005331** to access the source database. The values passed for the source and
drh62b5d2d2009-02-03 18:47:22 +00005332** destination [database connection] parameters must not be the same.
danielk197704103022009-02-03 16:51:24 +00005333**
5334** If an error occurs within sqlite3_backup_init(), then NULL is returned
drh62b5d2d2009-02-03 18:47:22 +00005335** and an error code and error message written into the [database connection]
danielk197704103022009-02-03 16:51:24 +00005336** passed as the first argument. They may be retrieved using the
drh62b5d2d2009-02-03 18:47:22 +00005337** [sqlite3_errcode()], [sqlite3_errmsg()], and [sqlite3_errmsg16()] functions.
drh27b3b842009-02-03 18:25:13 +00005338** Otherwise, if successful, a pointer to an [sqlite3_backup] object is
5339** returned. This pointer may be used with the sqlite3_backup_step() and
danielk197704103022009-02-03 16:51:24 +00005340** sqlite3_backup_finish() functions to perform the specified backup
5341** operation.
5342**
5343** <b>sqlite3_backup_step()</b>
5344**
5345** Function [sqlite3_backup_step()] is used to copy up to nPage pages between
5346** the source and destination databases, where nPage is the value of the
danielk197703ab0352009-02-06 05:59:44 +00005347** second parameter passed to sqlite3_backup_step(). If nPage is a negative
5348** value, all remaining source pages are copied. If the required pages are
danielk197704103022009-02-03 16:51:24 +00005349** succesfully copied, but there are still more pages to copy before the
drh62b5d2d2009-02-03 18:47:22 +00005350** backup is complete, it returns [SQLITE_OK]. If no error occured and there
5351** are no more pages to copy, then [SQLITE_DONE] is returned. If an error
5352** occurs, then an SQLite error code is returned. As well as [SQLITE_OK] and
5353** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY],
5354** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an
5355** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code.
danielk197704103022009-02-03 16:51:24 +00005356**
5357** As well as the case where the destination database file was opened for
drh62b5d2d2009-02-03 18:47:22 +00005358** read-only access, sqlite3_backup_step() may return [SQLITE_READONLY] if
danielk197704103022009-02-03 16:51:24 +00005359** the destination is an in-memory database with a different page size
5360** from the source database.
5361**
5362** If sqlite3_backup_step() cannot obtain a required file-system lock, then
drh62b5d2d2009-02-03 18:47:22 +00005363** the [sqlite3_busy_handler | busy-handler function]
5364** is invoked (if one is specified). If the
danielk197704103022009-02-03 16:51:24 +00005365** busy-handler returns non-zero before the lock is available, then
drh62b5d2d2009-02-03 18:47:22 +00005366** [SQLITE_BUSY] is returned to the caller. In this case the call to
5367** sqlite3_backup_step() can be retried later. If the source
5368** [database connection]
danielk197704103022009-02-03 16:51:24 +00005369** is being used to write to the source database when sqlite3_backup_step()
drh62b5d2d2009-02-03 18:47:22 +00005370** is called, then [SQLITE_LOCKED] is returned immediately. Again, in this
danielk197704103022009-02-03 16:51:24 +00005371** case the call to sqlite3_backup_step() can be retried later on. If
drh62b5d2d2009-02-03 18:47:22 +00005372** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or
5373** [SQLITE_READONLY] is returned, then
danielk197704103022009-02-03 16:51:24 +00005374** there is no point in retrying the call to sqlite3_backup_step(). These
5375** errors are considered fatal. At this point the application must accept
5376** that the backup operation has failed and pass the backup operation handle
5377** to the sqlite3_backup_finish() to release associated resources.
5378**
5379** Following the first call to sqlite3_backup_step(), an exclusive lock is
5380** obtained on the destination file. It is not released until either
5381** sqlite3_backup_finish() is called or the backup operation is complete
drh62b5d2d2009-02-03 18:47:22 +00005382** and sqlite3_backup_step() returns [SQLITE_DONE]. Additionally, each time
5383** a call to sqlite3_backup_step() is made a [shared lock] is obtained on
danielk197704103022009-02-03 16:51:24 +00005384** the source database file. This lock is released before the
5385** sqlite3_backup_step() call returns. Because the source database is not
5386** locked between calls to sqlite3_backup_step(), it may be modified mid-way
5387** through the backup procedure. If the source database is modified by an
5388** external process or via a database connection other than the one being
5389** used by the backup operation, then the backup will be transparently
5390** restarted by the next call to sqlite3_backup_step(). If the source
5391** database is modified by the using the same database connection as is used
5392** by the backup operation, then the backup database is transparently
5393** updated at the same time.
5394**
5395** <b>sqlite3_backup_finish()</b>
5396**
drh62b5d2d2009-02-03 18:47:22 +00005397** Once sqlite3_backup_step() has returned [SQLITE_DONE], or when the
drh27b3b842009-02-03 18:25:13 +00005398** application wishes to abandon the backup operation, the [sqlite3_backup]
5399** object should be passed to sqlite3_backup_finish(). This releases all
danielk197704103022009-02-03 16:51:24 +00005400** resources associated with the backup operation. If sqlite3_backup_step()
drh62b5d2d2009-02-03 18:47:22 +00005401** has not yet returned [SQLITE_DONE], then any active write-transaction on the
drh27b3b842009-02-03 18:25:13 +00005402** destination database is rolled back. The [sqlite3_backup] object is invalid
danielk197704103022009-02-03 16:51:24 +00005403** and may not be used following a call to sqlite3_backup_finish().
5404**
drh62b5d2d2009-02-03 18:47:22 +00005405** The value returned by sqlite3_backup_finish is [SQLITE_OK] if no error
5406** occurred, regardless or whether or not sqlite3_backup_step() was called
danielk197704103022009-02-03 16:51:24 +00005407** a sufficient number of times to complete the backup operation. Or, if
5408** an out-of-memory condition or IO error occured during a call to
drh62b5d2d2009-02-03 18:47:22 +00005409** sqlite3_backup_step() then [SQLITE_NOMEM] or an
5410** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] error code
danielk197704103022009-02-03 16:51:24 +00005411** is returned. In this case the error code and an error message are
drh62b5d2d2009-02-03 18:47:22 +00005412** written to the destination [database connection].
danielk197704103022009-02-03 16:51:24 +00005413**
drh62b5d2d2009-02-03 18:47:22 +00005414** A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step() is
5415** not a permanent error and does not affect the return value of
danielk197704103022009-02-03 16:51:24 +00005416** sqlite3_backup_finish().
5417**
5418** <b>sqlite3_backup_remaining(), sqlite3_backup_pagecount()</b>
5419**
5420** Each call to sqlite3_backup_step() sets two values stored internally
drh27b3b842009-02-03 18:25:13 +00005421** by an [sqlite3_backup] object. The number of pages still to be backed
danielk197704103022009-02-03 16:51:24 +00005422** up, which may be queried by sqlite3_backup_remaining(), and the total
5423** number of pages in the source database file, which may be queried by
5424** sqlite3_backup_pagecount().
5425**
5426** The values returned by these functions are only updated by
5427** sqlite3_backup_step(). If the source database is modified during a backup
5428** operation, then the values are not updated to account for any extra
5429** pages that need to be updated or the size of the source database file
5430** changing.
5431**
5432** <b>Concurrent Usage of Database Handles</b>
5433**
drh62b5d2d2009-02-03 18:47:22 +00005434** The source [database connection] may be used by the application for other
danielk197704103022009-02-03 16:51:24 +00005435** purposes while a backup operation is underway or being initialized.
5436** If SQLite is compiled and configured to support threadsafe database
5437** connections, then the source database connection may be used concurrently
5438** from within other threads.
5439**
5440** However, the application must guarantee that the destination database
5441** connection handle is not passed to any other API (by any thread) after
5442** sqlite3_backup_init() is called and before the corresponding call to
5443** sqlite3_backup_finish(). Unfortunately SQLite does not currently check
drh62b5d2d2009-02-03 18:47:22 +00005444** for this, if the application does use the destination [database connection]
danielk197704103022009-02-03 16:51:24 +00005445** for some other purpose during a backup operation, things may appear to
drh662c58c2009-02-03 21:13:07 +00005446** work correctly but in fact be subtly malfunctioning. Use of the
5447** destination database connection while a backup is in progress might
5448** also cause a mutex deadlock.
danielk197704103022009-02-03 16:51:24 +00005449**
drh62b5d2d2009-02-03 18:47:22 +00005450** Furthermore, if running in [shared cache mode], the application must
danielk197704103022009-02-03 16:51:24 +00005451** guarantee that the shared cache used by the destination database
5452** is not accessed while the backup is running. In practice this means
5453** that the application must guarantee that the file-system file being
5454** backed up to is not accessed by any connection within the process,
5455** not just the specific connection that was passed to sqlite3_backup_init().
5456**
drh27b3b842009-02-03 18:25:13 +00005457** The [sqlite3_backup] object itself is partially threadsafe. Multiple
danielk197704103022009-02-03 16:51:24 +00005458** threads may safely make multiple concurrent calls to sqlite3_backup_step().
5459** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount()
5460** APIs are not strictly speaking threadsafe. If they are invoked at the
5461** same time as another thread is invoking sqlite3_backup_step() it is
5462** possible that they return invalid values.
5463*/
danielk197704103022009-02-03 16:51:24 +00005464sqlite3_backup *sqlite3_backup_init(
5465 sqlite3 *pDest, /* Destination database handle */
5466 const char *zDestName, /* Destination database name */
5467 sqlite3 *pSource, /* Source database handle */
5468 const char *zSourceName /* Source database name */
5469);
5470int sqlite3_backup_step(sqlite3_backup *p, int nPage);
5471int sqlite3_backup_finish(sqlite3_backup *p);
5472int sqlite3_backup_remaining(sqlite3_backup *p);
5473int sqlite3_backup_pagecount(sqlite3_backup *p);
5474
5475/*
danielk1977404ca072009-03-16 13:19:36 +00005476** CAPI3REF: Unlock Notification
5477** EXPERIMENTAL
5478**
5479** When running in shared-cache mode, a database operation may fail with
drh89487472009-03-16 13:37:02 +00005480** an [SQLITE_LOCKED] error if the required locks on the shared-cache or
danielk1977404ca072009-03-16 13:19:36 +00005481** individual tables within the shared-cache cannot be obtained. See
5482** [SQLite Shared-Cache Mode] for a description of shared-cache locking.
5483** This API may be used to register a callback that SQLite will invoke
5484** when the connection currently holding the required lock relinquishes it.
5485** This API is only available if the library was compiled with the
drh89487472009-03-16 13:37:02 +00005486** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined.
danielk1977404ca072009-03-16 13:19:36 +00005487**
5488** See Also: [Using the SQLite Unlock Notification Feature].
5489**
5490** Shared-cache locks are released when a database connection concludes
5491** its current transaction, either by committing it or rolling it back.
5492**
5493** When a connection (known as the blocked connection) fails to obtain a
5494** shared-cache lock and SQLITE_LOCKED is returned to the caller, the
5495** identity of the database connection (the blocking connection) that
5496** has locked the required resource is stored internally. After an
5497** application receives an SQLITE_LOCKED error, it may call the
5498** sqlite3_unlock_notify() method with the blocked connection handle as
5499** the first argument to register for a callback that will be invoked
5500** when the blocking connections current transaction is concluded. The
5501** callback is invoked from within the [sqlite3_step] or [sqlite3_close]
5502** call that concludes the blocking connections transaction.
5503**
5504** If sqlite3_unlock_notify() is called in a multi-threaded application,
5505** there is a chance that the blocking connection will have already
5506** concluded its transaction by the time sqlite3_unlock_notify() is invoked.
5507** If this happens, then the specified callback is invoked immediately,
5508** from within the call to sqlite3_unlock_notify().
5509**
5510** If the blocked connection is attempting to obtain a write-lock on a
5511** shared-cache table, and more than one other connection currently holds
5512** a read-lock on the same table, then SQLite arbitrarily selects one of
5513** the other connections to use as the blocking connection.
5514**
5515** There may be at most one unlock-notify callback registered by a
5516** blocked connection. If sqlite3_unlock_notify() is called when the
5517** blocked connection already has a registered unlock-notify callback,
5518** then the new callback replaces the old. If sqlite3_unlock_notify() is
5519** called with a NULL pointer as its second argument, then any existing
5520** unlock-notify callback is cancelled. The blocked connections
5521** unlock-notify callback may also be canceled by closing the blocked
5522** connection using [sqlite3_close()].
5523**
5524** The unlock-notify callback is not reentrant. If an application invokes
5525** any sqlite3_xxx API functions from within an unlock-notify callback, a
5526** crash or deadlock may be the result.
5527**
5528** Unless deadlock is detected (see below), sqlite3_unlock_notify() always
5529** returns SQLITE_OK.
5530**
5531** <b>Callback Invocation Details</b>
5532**
5533** When an unlock-notify callback is registered, the application provides a
5534** single void* pointer that is passed to the callback when it is invoked.
5535** However, the signature of the callback function allows SQLite to pass
5536** it an array of void* context pointers. The first argument passed to
5537** an unlock-notify callback is a pointer to an array of void* pointers,
5538** and the second is the number of entries in the array.
5539**
5540** When a blocking connections transaction is concluded, there may be
5541** more than one blocked connection that has registered for an unlock-notify
5542** callback. If two or more such blocked connections have specified the
5543** same callback function, then instead of invoking the callback function
5544** multiple times, it is invoked once with the set of void* context pointers
5545** specified by the blocked connections bundled together into an array.
5546** This gives the application an opportunity to prioritize any actions
5547** related to the set of unblocked database connections.
5548**
5549** <b>Deadlock Detection</b>
5550**
5551** Assuming that after registering for an unlock-notify callback a
5552** database waits for the callback to be issued before taking any further
5553** action (a reasonable assumption), then using this API may cause the
5554** application to deadlock. For example, if connection X is waiting for
5555** connection Y's transaction to be concluded, and similarly connection
5556** Y is waiting on connection X's transaction, then neither connection
5557** will proceed and the system may remain deadlocked indefinitely.
5558**
5559** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock
5560** detection. If a given call to sqlite3_unlock_notify() would put the
5561** system in a deadlocked state, then SQLITE_LOCKED is returned and no
5562** unlock-notify callback is registered. The system is said to be in
5563** a deadlocked state if connection A has registered for an unlock-notify
5564** callback on the conclusion of connection B's transaction, and connection
5565** B has itself registered for an unlock-notify callback when connection
5566** A's transaction is concluded. Indirect deadlock is also detected, so
5567** the system is also considered to be deadlocked if connection B has
5568** registered for an unlock-notify callback on the conclusion of connection
5569** C's transaction, where connection C is waiting on connection A. Any
5570** number of levels of indirection are allowed.
5571**
5572** <b>The "DROP TABLE" Exception</b>
5573**
5574** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost
5575** always appropriate to call sqlite3_unlock_notify(). There is however,
5576** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement,
5577** SQLite checks if there are any currently executing SELECT statements
5578** that belong to the same connection. If there are, SQLITE_LOCKED is
5579** returned. In this case there is no "blocking connection", so invoking
5580** sqlite3_unlock_notify() results in the unlock-notify callback being
5581** invoked immediately. If the application then re-attempts the "DROP TABLE"
5582** or "DROP INDEX" query, an infinite loop might be the result.
5583**
5584** One way around this problem is to check the extended error code returned
5585** by an sqlite3_step() call. If there is a blocking connection, then the
5586** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in
5587** the special "DROP TABLE/INDEX" case, the extended error code is just
5588** SQLITE_LOCKED.
5589*/
5590int sqlite3_unlock_notify(
5591 sqlite3 *pBlocked, /* Waiting connection */
5592 void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */
5593 void *pNotifyArg /* Argument to pass to xNotify */
5594);
5595
5596/*
drhb37df7b2005-10-13 02:09:49 +00005597** Undo the hack that converts floating point types to integer for
5598** builds on processors without floating point support.
5599*/
5600#ifdef SQLITE_OMIT_FLOATING_POINT
5601# undef double
5602#endif
5603
drh382c0242001-10-06 16:33:02 +00005604#ifdef __cplusplus
5605} /* End of the 'extern "C"' block */
5606#endif
danielk19774adee202004-05-08 08:23:19 +00005607#endif