blob: 7865e66391c66eb7166df6c6dbd958b3411d5b8f [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
drh75897232000-05-29 14:26:00 +000013** presents to client programs.
14**
danielk1977979f38e2007-03-27 16:19:51 +000015** @(#) $Id: sqlite.h.in,v 1.199 2007/03/27 16:19:52 danielk1977 Exp $
drh75897232000-05-29 14:26:00 +000016*/
drh12057d52004-09-06 17:34:12 +000017#ifndef _SQLITE3_H_
18#define _SQLITE3_H_
drha18c5682000-10-08 22:20:57 +000019#include <stdarg.h> /* Needed for the definition of va_list */
drh75897232000-05-29 14:26:00 +000020
21/*
drh382c0242001-10-06 16:33:02 +000022** Make sure we can call this stuff from C++.
23*/
24#ifdef __cplusplus
25extern "C" {
26#endif
27
28/*
drhb86ccfb2003-01-28 23:13:10 +000029** The version of the SQLite library.
30*/
drh1e284f42004-10-06 15:52:01 +000031#ifdef SQLITE_VERSION
32# undef SQLITE_VERSION
drh1e284f42004-10-06 15:52:01 +000033#endif
danielk197799ba19e2005-02-05 07:33:34 +000034#define SQLITE_VERSION "--VERS--"
35
36/*
37** The format of the version string is "X.Y.Z<trailing string>", where
38** X is the major version number, Y is the minor version number and Z
39** is the release number. The trailing string is often "alpha" or "beta".
40** For example "3.1.1beta".
41**
42** The SQLITE_VERSION_NUMBER is an integer with the value
43** (X*100000 + Y*1000 + Z). For example, for version "3.1.1beta",
44** SQLITE_VERSION_NUMBER is set to 3001001. To detect if they are using
45** version 3.1.1 or greater at compile time, programs may use the test
46** (SQLITE_VERSION_NUMBER>=3001001).
47*/
48#ifdef SQLITE_VERSION_NUMBER
49# undef SQLITE_VERSION_NUMBER
50#endif
51#define SQLITE_VERSION_NUMBER --VERSION-NUMBER--
drhb86ccfb2003-01-28 23:13:10 +000052
53/*
drhb217a572000-08-22 13:40:18 +000054** The version string is also compiled into the library so that a program
55** can check to make sure that the lib*.a file and the *.h file are from
drh6f3a3ef2004-08-28 18:21:21 +000056** the same version. The sqlite3_libversion() function returns a pointer
57** to the sqlite3_version variable - useful in DLLs which cannot access
58** global variables.
drhb217a572000-08-22 13:40:18 +000059*/
danielk19776f8a5032004-05-10 10:34:51 +000060extern const char sqlite3_version[];
drha3f70cb2004-09-30 14:24:50 +000061const char *sqlite3_libversion(void);
drh303aaa72000-08-17 10:22:34 +000062
63/*
danielk197799ba19e2005-02-05 07:33:34 +000064** Return the value of the SQLITE_VERSION_NUMBER macro when the
65** library was compiled.
66*/
67int sqlite3_libversion_number(void);
68
69/*
drh75897232000-05-29 14:26:00 +000070** Each open sqlite database is represented by an instance of the
71** following opaque structure.
72*/
drh9bb575f2004-09-06 17:24:11 +000073typedef struct sqlite3 sqlite3;
danielk197765904932004-05-26 06:18:37 +000074
drh75897232000-05-29 14:26:00 +000075
76/*
drhefad9992004-06-22 12:13:55 +000077** Some compilers do not support the "long long" datatype. So we have
78** to do a typedef that for 64-bit integers that depends on what compiler
79** is being used.
80*/
drh27436af2006-03-28 23:57:17 +000081#ifdef SQLITE_INT64_TYPE
drh9b8f4472006-04-04 01:54:55 +000082 typedef SQLITE_INT64_TYPE sqlite_int64;
drh27436af2006-03-28 23:57:17 +000083 typedef unsigned SQLITE_INT64_TYPE sqlite_uint64;
84#elif defined(_MSC_VER) || defined(__BORLANDC__)
drhefad9992004-06-22 12:13:55 +000085 typedef __int64 sqlite_int64;
drh1211de32004-07-26 12:24:22 +000086 typedef unsigned __int64 sqlite_uint64;
drhefad9992004-06-22 12:13:55 +000087#else
88 typedef long long int sqlite_int64;
drh1211de32004-07-26 12:24:22 +000089 typedef unsigned long long int sqlite_uint64;
drhefad9992004-06-22 12:13:55 +000090#endif
91
drhb37df7b2005-10-13 02:09:49 +000092/*
93** If compiling for a processor that lacks floating point support,
94** substitute integer for floating-point
95*/
96#ifdef SQLITE_OMIT_FLOATING_POINT
97# define double sqlite_int64
98#endif
drhefad9992004-06-22 12:13:55 +000099
100/*
drh75897232000-05-29 14:26:00 +0000101** A function to close the database.
102**
103** Call this function with a pointer to a structure that was previously
danielk19776f8a5032004-05-10 10:34:51 +0000104** returned from sqlite3_open() and the corresponding database will by closed.
danielk197796d81f92004-06-19 03:33:57 +0000105**
106** All SQL statements prepared using sqlite3_prepare() or
107** sqlite3_prepare16() must be deallocated using sqlite3_finalize() before
108** this routine is called. Otherwise, SQLITE_BUSY is returned and the
109** database connection remains open.
drh75897232000-05-29 14:26:00 +0000110*/
danielk1977f9d64d22004-06-19 08:18:07 +0000111int sqlite3_close(sqlite3 *);
drh75897232000-05-29 14:26:00 +0000112
113/*
114** The type for a callback function.
115*/
drh12057d52004-09-06 17:34:12 +0000116typedef int (*sqlite3_callback)(void*,int,char**, char**);
drh75897232000-05-29 14:26:00 +0000117
118/*
119** A function to executes one or more statements of SQL.
120**
121** If one or more of the SQL statements are queries, then
122** the callback function specified by the 3rd parameter is
123** invoked once for each row of the query result. This callback
124** should normally return 0. If the callback returns a non-zero
125** value then the query is aborted, all subsequent SQL statements
danielk19776f8a5032004-05-10 10:34:51 +0000126** are skipped and the sqlite3_exec() function returns the SQLITE_ABORT.
drh75897232000-05-29 14:26:00 +0000127**
drha09883f2007-01-10 12:57:29 +0000128** The 1st parameter is an arbitrary pointer that is passed
drh75897232000-05-29 14:26:00 +0000129** to the callback function as its first parameter.
130**
131** The 2nd parameter to the callback function is the number of
drhb19a2bc2001-09-16 00:13:26 +0000132** columns in the query result. The 3rd parameter to the callback
133** is an array of strings holding the values for each column.
134** The 4th parameter to the callback is an array of strings holding
135** the names of each column.
drh75897232000-05-29 14:26:00 +0000136**
137** The callback function may be NULL, even for queries. A NULL
138** callback is not an error. It just means that no callback
139** will be invoked.
140**
141** If an error occurs while parsing or evaluating the SQL (but
142** not while executing the callback) then an appropriate error
143** message is written into memory obtained from malloc() and
drhb19a2bc2001-09-16 00:13:26 +0000144** *errmsg is made to point to that message. The calling function
145** is responsible for freeing the memory that holds the error
drh3f4fedb2004-05-31 19:34:33 +0000146** message. Use sqlite3_free() for this. If errmsg==NULL,
drhb86ccfb2003-01-28 23:13:10 +0000147** then no error message is ever written.
drhb19a2bc2001-09-16 00:13:26 +0000148**
149** The return value is is SQLITE_OK if there are no errors and
150** some other return code if there is an error. The particular
151** return value depends on the type of error.
drh58b95762000-06-02 01:17:37 +0000152**
153** If the query could not be executed because a database file is
drh2dfbbca2000-07-28 14:32:48 +0000154** locked or busy, then this function returns SQLITE_BUSY. (This
danielk19776f8a5032004-05-10 10:34:51 +0000155** behavior can be modified somewhat using the sqlite3_busy_handler()
156** and sqlite3_busy_timeout() functions below.)
drh75897232000-05-29 14:26:00 +0000157*/
danielk19776f8a5032004-05-10 10:34:51 +0000158int sqlite3_exec(
drh12057d52004-09-06 17:34:12 +0000159 sqlite3*, /* An open database */
drh9f71c2e2001-11-03 23:57:09 +0000160 const char *sql, /* SQL to be executed */
drh12057d52004-09-06 17:34:12 +0000161 sqlite3_callback, /* Callback function */
drh75897232000-05-29 14:26:00 +0000162 void *, /* 1st argument to callback function */
163 char **errmsg /* Error msg written here */
164);
165
drh58b95762000-06-02 01:17:37 +0000166/*
danielk19776f8a5032004-05-10 10:34:51 +0000167** Return values for sqlite3_exec() and sqlite3_step()
drh58b95762000-06-02 01:17:37 +0000168*/
drh717e6402001-09-27 03:22:32 +0000169#define SQLITE_OK 0 /* Successful result */
drh15b9a152006-01-31 20:49:13 +0000170/* beginning-of-error-codes */
drh717e6402001-09-27 03:22:32 +0000171#define SQLITE_ERROR 1 /* SQL error or missing database */
drh2db0bbc2005-08-11 02:10:18 +0000172#define SQLITE_INTERNAL 2 /* NOT USED. Internal logic error in SQLite */
drh717e6402001-09-27 03:22:32 +0000173#define SQLITE_PERM 3 /* Access permission denied */
174#define SQLITE_ABORT 4 /* Callback routine requested an abort */
175#define SQLITE_BUSY 5 /* The database file is locked */
176#define SQLITE_LOCKED 6 /* A table in the database is locked */
177#define SQLITE_NOMEM 7 /* A malloc() failed */
178#define SQLITE_READONLY 8 /* Attempt to write a readonly database */
drh24cd67e2004-05-10 16:18:47 +0000179#define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/
drh717e6402001-09-27 03:22:32 +0000180#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */
181#define SQLITE_CORRUPT 11 /* The database disk image is malformed */
drh2db0bbc2005-08-11 02:10:18 +0000182#define SQLITE_NOTFOUND 12 /* NOT USED. Table or record not found */
drh717e6402001-09-27 03:22:32 +0000183#define SQLITE_FULL 13 /* Insertion failed because database is full */
184#define SQLITE_CANTOPEN 14 /* Unable to open the database file */
185#define SQLITE_PROTOCOL 15 /* Database lock protocol error */
drh24cd67e2004-05-10 16:18:47 +0000186#define SQLITE_EMPTY 16 /* Database is empty */
drh717e6402001-09-27 03:22:32 +0000187#define SQLITE_SCHEMA 17 /* The database schema changed */
drh2db0bbc2005-08-11 02:10:18 +0000188#define SQLITE_TOOBIG 18 /* NOT USED. Too much data for one row */
drh717e6402001-09-27 03:22:32 +0000189#define SQLITE_CONSTRAINT 19 /* Abort due to contraint violation */
drh8aff1012001-12-22 14:49:24 +0000190#define SQLITE_MISMATCH 20 /* Data type mismatch */
drh247be432002-05-10 05:44:55 +0000191#define SQLITE_MISUSE 21 /* Library used incorrectly */
drh8766c342002-11-09 00:33:15 +0000192#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */
drhed6c8672003-01-12 18:02:16 +0000193#define SQLITE_AUTH 23 /* Authorization denied */
drh1c2d8412003-03-31 00:30:47 +0000194#define SQLITE_FORMAT 24 /* Auxiliary database format error */
danielk19776f8a5032004-05-10 10:34:51 +0000195#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */
drhc602f9a2004-02-12 19:01:04 +0000196#define SQLITE_NOTADB 26 /* File opened that is not a database file */
danielk19776f8a5032004-05-10 10:34:51 +0000197#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */
198#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */
drh15b9a152006-01-31 20:49:13 +0000199/* end-of-error-codes */
drh717e6402001-09-27 03:22:32 +0000200
drhaf9ff332002-01-16 21:00:27 +0000201/*
drh4ac285a2006-09-15 07:28:50 +0000202** Using the sqlite3_extended_result_codes() API, you can cause
203** SQLite to return result codes with additional information in
204** their upper bits. The lower 8 bits will be the same as the
205** primary result codes above. But the upper bits might contain
206** more specific error information.
207**
208** To extract the primary result code from an extended result code,
209** simply mask off the lower 8 bits.
210**
211** primary = extended & 0xff;
212**
213** New result error codes may be added from time to time. Software
214** that uses the extended result codes should plan accordingly and be
215** sure to always handle new unknown codes gracefully.
216**
217** The SQLITE_OK result code will never be extended. It will always
218** be exactly zero.
219**
220** The extended result codes always have the primary result code
221** as a prefix. Primary result codes only contain a single "_"
222** character. Extended result codes contain two or more "_" characters.
223*/
224#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8))
225#define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8))
226#define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8))
227#define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8))
228#define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8))
229#define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8))
230#define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8))
231#define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8))
232#define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8))
danielk1977979f38e2007-03-27 16:19:51 +0000233#define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8))
drh4ac285a2006-09-15 07:28:50 +0000234
235/*
236** Enable or disable the extended result codes.
237*/
238int sqlite3_extended_result_codes(sqlite3*, int onoff);
239
240/*
drhaf9ff332002-01-16 21:00:27 +0000241** Each entry in an SQLite table has a unique integer key. (The key is
242** the value of the INTEGER PRIMARY KEY column if there is such a column,
243** otherwise the key is generated at random. The unique key is always
244** available as the ROWID, OID, or _ROWID_ column.) The following routine
245** returns the integer key of the most recent insert in the database.
246**
247** This function is similar to the mysql_insert_id() function from MySQL.
248*/
drhefad9992004-06-22 12:13:55 +0000249sqlite_int64 sqlite3_last_insert_rowid(sqlite3*);
drhaf9ff332002-01-16 21:00:27 +0000250
drhc8d30ac2002-04-12 10:08:59 +0000251/*
252** This function returns the number of database rows that were changed
danielk19776f8a5032004-05-10 10:34:51 +0000253** (or inserted or deleted) by the most recent called sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000254**
255** All changes are counted, even if they were later undone by a
256** ROLLBACK or ABORT. Except, changes associated with creating and
257** dropping tables are not counted.
258**
danielk19776f8a5032004-05-10 10:34:51 +0000259** If a callback invokes sqlite3_exec() recursively, then the changes
drhc8d30ac2002-04-12 10:08:59 +0000260** in the inner, recursive call are counted together with the changes
261** in the outer call.
262**
263** SQLite implements the command "DELETE FROM table" without a WHERE clause
264** by dropping and recreating the table. (This is much faster than going
265** through and deleting individual elements form the table.) Because of
266** this optimization, the change count for "DELETE FROM table" will be
267** zero regardless of the number of elements that were originally in the
268** table. To get an accurate count of the number of rows deleted, use
269** "DELETE FROM table WHERE 1" instead.
270*/
danielk1977f9d64d22004-06-19 08:18:07 +0000271int sqlite3_changes(sqlite3*);
drhc8d30ac2002-04-12 10:08:59 +0000272
rdcf146a772004-02-25 22:51:06 +0000273/*
danielk1977b28af712004-06-21 06:50:26 +0000274** This function returns the number of database rows that have been
275** modified by INSERT, UPDATE or DELETE statements since the database handle
276** was opened. This includes UPDATE, INSERT and DELETE statements executed
277** as part of trigger programs. All changes are counted as soon as the
278** statement that makes them is completed (when the statement handle is
279** passed to sqlite3_reset() or sqlite_finalise()).
rdcf146a772004-02-25 22:51:06 +0000280**
281** SQLite implements the command "DELETE FROM table" without a WHERE clause
282** by dropping and recreating the table. (This is much faster than going
283** through and deleting individual elements form the table.) Because of
284** this optimization, the change count for "DELETE FROM table" will be
285** zero regardless of the number of elements that were originally in the
286** table. To get an accurate count of the number of rows deleted, use
287** "DELETE FROM table WHERE 1" instead.
rdcf146a772004-02-25 22:51:06 +0000288*/
danielk1977b28af712004-06-21 06:50:26 +0000289int sqlite3_total_changes(sqlite3*);
290
drh4c504392000-10-16 22:06:40 +0000291/* This function causes any pending database operation to abort and
292** return at its earliest opportunity. This routine is typically
drh66b89c82000-11-28 20:47:17 +0000293** called in response to a user action such as pressing "Cancel"
drh4c504392000-10-16 22:06:40 +0000294** or Ctrl-C where the user wants a long query operation to halt
295** immediately.
296*/
danielk1977f9d64d22004-06-19 08:18:07 +0000297void sqlite3_interrupt(sqlite3*);
drh4c504392000-10-16 22:06:40 +0000298
drheec553b2000-06-02 01:51:20 +0000299
danielk197761de0d12004-05-27 23:56:16 +0000300/* These functions return true if the given input string comprises
301** one or more complete SQL statements. For the sqlite3_complete() call,
302** the parameter must be a nul-terminated UTF-8 string. For
303** sqlite3_complete16(), a nul-terminated machine byte order UTF-16 string
304** is required.
drh75897232000-05-29 14:26:00 +0000305**
306** The algorithm is simple. If the last token other than spaces
307** and comments is a semicolon, then return true. otherwise return
308** false.
309*/
danielk19776f8a5032004-05-10 10:34:51 +0000310int sqlite3_complete(const char *sql);
danielk197761de0d12004-05-27 23:56:16 +0000311int sqlite3_complete16(const void *sql);
drh75897232000-05-29 14:26:00 +0000312
drh2dfbbca2000-07-28 14:32:48 +0000313/*
314** This routine identifies a callback function that is invoked
315** whenever an attempt is made to open a database table that is
316** currently locked by another process or thread. If the busy callback
danielk19776f8a5032004-05-10 10:34:51 +0000317** is NULL, then sqlite3_exec() returns SQLITE_BUSY immediately if
drh2dfbbca2000-07-28 14:32:48 +0000318** it finds a locked table. If the busy callback is not NULL, then
drh86939b52007-01-10 12:54:51 +0000319** sqlite3_exec() invokes the callback with two arguments. The
320** first argument to the handler is a copy of the void* pointer which
321** is the third argument to this routine. The second argument to
322** the handler is the number of times that the busy handler has
323** been invoked for this locking event. If the
danielk19776f8a5032004-05-10 10:34:51 +0000324** busy callback returns 0, then sqlite3_exec() immediately returns
325** SQLITE_BUSY. If the callback returns non-zero, then sqlite3_exec()
drh2dfbbca2000-07-28 14:32:48 +0000326** tries to open the table again and the cycle repeats.
327**
drh86939b52007-01-10 12:54:51 +0000328** The presence of a busy handler does not guarantee that
329** it will be invoked when there is lock contention.
330** If SQLite determines that invoking the busy handler could result in
331** a deadlock, it will return SQLITE_BUSY instead.
332** Consider a scenario where one process is holding a read lock that
333** it is trying to promote to a reserved lock and
334** a second process is holding a reserved lock that it is trying
335** to promote to an exclusive lock. The first process cannot proceed
336** because it is blocked by the second and the second process cannot
337** proceed because it is blocked by the first. If both processes
338** invoke the busy handlers, neither will make any progress. Therefore,
339** SQLite returns SQLITE_BUSY for the first process, hoping that this
340** will induce the first process to release its read lock and allow
341** the second process to proceed.
342**
drh2dfbbca2000-07-28 14:32:48 +0000343** The default busy callback is NULL.
344**
345** Sqlite is re-entrant, so the busy handler may start a new query.
346** (It is not clear why anyone would every want to do this, but it
347** is allowed, in theory.) But the busy handler may not close the
348** database. Closing the database from a busy handler will delete
349** data structures out from under the executing query and will
350** probably result in a coredump.
351*/
danielk1977f9d64d22004-06-19 08:18:07 +0000352int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*);
drh2dfbbca2000-07-28 14:32:48 +0000353
354/*
355** This routine sets a busy handler that sleeps for a while when a
356** table is locked. The handler will sleep multiple times until
357** at least "ms" milleseconds of sleeping have been done. After
358** "ms" milleseconds of sleeping, the handler returns 0 which
danielk19776f8a5032004-05-10 10:34:51 +0000359** causes sqlite3_exec() to return SQLITE_BUSY.
drh2dfbbca2000-07-28 14:32:48 +0000360**
361** Calling this routine with an argument less than or equal to zero
362** turns off all busy handlers.
363*/
danielk1977f9d64d22004-06-19 08:18:07 +0000364int sqlite3_busy_timeout(sqlite3*, int ms);
drh2dfbbca2000-07-28 14:32:48 +0000365
drhe3710332000-09-29 13:30:53 +0000366/*
danielk19776f8a5032004-05-10 10:34:51 +0000367** This next routine is really just a wrapper around sqlite3_exec().
drhe3710332000-09-29 13:30:53 +0000368** Instead of invoking a user-supplied callback for each row of the
369** result, this routine remembers each row of the result in memory
370** obtained from malloc(), then returns all of the result after the
drha18c5682000-10-08 22:20:57 +0000371** query has finished.
372**
373** As an example, suppose the query result where this table:
374**
375** Name | Age
376** -----------------------
377** Alice | 43
378** Bob | 28
379** Cindy | 21
380**
381** If the 3rd argument were &azResult then after the function returns
drh98699b52000-10-09 12:57:00 +0000382** azResult will contain the following data:
drha18c5682000-10-08 22:20:57 +0000383**
384** azResult[0] = "Name";
385** azResult[1] = "Age";
386** azResult[2] = "Alice";
387** azResult[3] = "43";
388** azResult[4] = "Bob";
389** azResult[5] = "28";
390** azResult[6] = "Cindy";
391** azResult[7] = "21";
392**
393** Notice that there is an extra row of data containing the column
394** headers. But the *nrow return value is still 3. *ncolumn is
395** set to 2. In general, the number of values inserted into azResult
396** will be ((*nrow) + 1)*(*ncolumn).
397**
398** After the calling function has finished using the result, it should
danielk19776f8a5032004-05-10 10:34:51 +0000399** pass the result data pointer to sqlite3_free_table() in order to
drha18c5682000-10-08 22:20:57 +0000400** release the memory that was malloc-ed. Because of the way the
401** malloc() happens, the calling function must not try to call
danielk197799b214d2005-02-02 01:13:38 +0000402** free() directly. Only sqlite3_free_table() is able to release
drha18c5682000-10-08 22:20:57 +0000403** the memory properly and safely.
drhe3710332000-09-29 13:30:53 +0000404**
danielk19776f8a5032004-05-10 10:34:51 +0000405** The return value of this routine is the same as from sqlite3_exec().
drhe3710332000-09-29 13:30:53 +0000406*/
danielk19776f8a5032004-05-10 10:34:51 +0000407int sqlite3_get_table(
danielk1977f9d64d22004-06-19 08:18:07 +0000408 sqlite3*, /* An open database */
drh9f71c2e2001-11-03 23:57:09 +0000409 const char *sql, /* SQL to be executed */
drhe3710332000-09-29 13:30:53 +0000410 char ***resultp, /* Result written to a char *[] that this points to */
411 int *nrow, /* Number of result rows written here */
412 int *ncolumn, /* Number of result columns written here */
413 char **errmsg /* Error msg written here */
414);
415
416/*
danielk19776f8a5032004-05-10 10:34:51 +0000417** Call this routine to free the memory that sqlite3_get_table() allocated.
drhe3710332000-09-29 13:30:53 +0000418*/
danielk19776f8a5032004-05-10 10:34:51 +0000419void sqlite3_free_table(char **result);
drhe3710332000-09-29 13:30:53 +0000420
drha18c5682000-10-08 22:20:57 +0000421/*
drh4f26d6c2004-05-26 23:25:30 +0000422** The following routines are variants of the "sprintf()" from the
423** standard C library. The resulting string is written into memory
424** obtained from malloc() so that there is never a possiblity of buffer
425** overflow. These routines also implement some additional formatting
426** options that are useful for constructing SQL statements.
427**
428** The strings returned by these routines should be freed by calling
429** sqlite3_free().
drha18c5682000-10-08 22:20:57 +0000430**
431** All of the usual printf formatting options apply. In addition, there
432** is a "%q" option. %q works like %s in that it substitutes a null-terminated
drh66b89c82000-11-28 20:47:17 +0000433** string from the argument list. But %q also doubles every '\'' character.
drha18c5682000-10-08 22:20:57 +0000434** %q is designed for use inside a string literal. By doubling each '\''
drh66b89c82000-11-28 20:47:17 +0000435** character it escapes that character and allows it to be inserted into
drha18c5682000-10-08 22:20:57 +0000436** the string.
437**
438** For example, so some string variable contains text as follows:
439**
440** char *zText = "It's a happy day!";
441**
442** We can use this text in an SQL statement as follows:
443**
drh3224b322005-09-08 10:58:51 +0000444** char *z = sqlite3_mprintf("INSERT INTO TABLES('%q')", zText);
445** sqlite3_exec(db, z, callback1, 0, 0);
446** sqlite3_free(z);
drha18c5682000-10-08 22:20:57 +0000447**
448** Because the %q format string is used, the '\'' character in zText
449** is escaped and the SQL generated is as follows:
450**
451** INSERT INTO table1 VALUES('It''s a happy day!')
452**
453** This is correct. Had we used %s instead of %q, the generated SQL
454** would have looked like this:
455**
456** INSERT INTO table1 VALUES('It's a happy day!');
457**
458** This second example is an SQL syntax error. As a general rule you
459** should always use %q instead of %s when inserting text into a string
460** literal.
461*/
danielk19776f8a5032004-05-10 10:34:51 +0000462char *sqlite3_mprintf(const char*,...);
463char *sqlite3_vmprintf(const char*, va_list);
drhfeac5f82004-08-01 00:10:45 +0000464char *sqlite3_snprintf(int,char*,const char*, ...);
drh5191b7e2002-03-08 02:12:00 +0000465
drh28dd4792006-06-26 21:35:44 +0000466/*
467** SQLite uses its own memory allocator. On many installations, this
468** memory allocator is identical to the standard malloc()/realloc()/free()
469** and can be used interchangable. On others, the implementations are
470** different. For maximum portability, it is best not to mix calls
471** to the standard malloc/realloc/free with the sqlite versions.
472*/
473void *sqlite3_malloc(int);
474void *sqlite3_realloc(void*, int);
475void sqlite3_free(void*);
476
drh1211de32004-07-26 12:24:22 +0000477#ifndef SQLITE_OMIT_AUTHORIZATION
drh5191b7e2002-03-08 02:12:00 +0000478/*
drhed6c8672003-01-12 18:02:16 +0000479** This routine registers a callback with the SQLite library. The
drhb86ccfb2003-01-28 23:13:10 +0000480** callback is invoked (at compile-time, not at run-time) for each
481** attempt to access a column of a table in the database. The callback
482** returns SQLITE_OK if access is allowed, SQLITE_DENY if the entire
483** SQL statement should be aborted with an error and SQLITE_IGNORE
484** if the column should be treated as a NULL value.
drhed6c8672003-01-12 18:02:16 +0000485*/
danielk19776f8a5032004-05-10 10:34:51 +0000486int sqlite3_set_authorizer(
danielk1977f9d64d22004-06-19 08:18:07 +0000487 sqlite3*,
drhe22a3342003-04-22 20:30:37 +0000488 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
drhe5f9c642003-01-13 23:27:31 +0000489 void *pUserData
drhed6c8672003-01-12 18:02:16 +0000490);
drh1211de32004-07-26 12:24:22 +0000491#endif
drhed6c8672003-01-12 18:02:16 +0000492
493/*
494** The second parameter to the access authorization function above will
drhe5f9c642003-01-13 23:27:31 +0000495** be one of the values below. These values signify what kind of operation
496** is to be authorized. The 3rd and 4th parameters to the authorization
497** function will be parameters or NULL depending on which of the following
drhe22a3342003-04-22 20:30:37 +0000498** codes is used as the second parameter. The 5th parameter is the name
499** of the database ("main", "temp", etc.) if applicable. The 6th parameter
drh5cf590c2003-04-24 01:45:04 +0000500** is the name of the inner-most trigger or view that is responsible for
501** the access attempt or NULL if this access attempt is directly from
502** input SQL code.
drhe5f9c642003-01-13 23:27:31 +0000503**
504** Arg-3 Arg-4
drhed6c8672003-01-12 18:02:16 +0000505*/
drh77ad4e42003-01-14 02:49:27 +0000506#define SQLITE_COPY 0 /* Table Name File Name */
drhe5f9c642003-01-13 23:27:31 +0000507#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */
508#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */
509#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */
510#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000511#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000512#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000513#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000514#define SQLITE_CREATE_VIEW 8 /* View Name NULL */
515#define SQLITE_DELETE 9 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000516#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000517#define SQLITE_DROP_TABLE 11 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000518#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000519#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000520#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000521#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000522#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000523#define SQLITE_DROP_VIEW 17 /* View Name NULL */
524#define SQLITE_INSERT 18 /* Table Name NULL */
525#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */
526#define SQLITE_READ 20 /* Table Name Column Name */
527#define SQLITE_SELECT 21 /* NULL NULL */
528#define SQLITE_TRANSACTION 22 /* NULL NULL */
529#define SQLITE_UPDATE 23 /* Table Name Column Name */
drh81e293b2003-06-06 19:00:42 +0000530#define SQLITE_ATTACH 24 /* Filename NULL */
531#define SQLITE_DETACH 25 /* Database Name NULL */
danielk19771c8c23c2004-11-12 15:53:37 +0000532#define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */
danielk19771d54df82004-11-23 15:41:16 +0000533#define SQLITE_REINDEX 27 /* Index Name NULL */
drhe6e04962005-07-23 02:17:03 +0000534#define SQLITE_ANALYZE 28 /* Table Name NULL */
danielk1977f1a381e2006-06-16 08:01:02 +0000535#define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */
536#define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */
drh5169bbc2006-08-24 14:59:45 +0000537#define SQLITE_FUNCTION 31 /* Function Name NULL */
drhed6c8672003-01-12 18:02:16 +0000538
539/*
540** The return value of the authorization function should be one of the
541** following constants:
542*/
543/* #define SQLITE_OK 0 // Allow access (This is actually defined above) */
544#define SQLITE_DENY 1 /* Abort the SQL statement with an error */
545#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
546
547/*
drh19e2d372005-08-29 23:00:03 +0000548** Register a function for tracing SQL command evaluation. The function
549** registered by sqlite3_trace() is invoked at the first sqlite3_step()
550** for the evaluation of an SQL statement. The function registered by
551** sqlite3_profile() runs at the end of each SQL statement and includes
552** information on how long that statement ran.
553**
554** The sqlite3_profile() API is currently considered experimental and
555** is subject to change.
drh18de4822003-01-16 16:28:53 +0000556*/
danielk1977f9d64d22004-06-19 08:18:07 +0000557void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*);
drh19e2d372005-08-29 23:00:03 +0000558void *sqlite3_profile(sqlite3*,
559 void(*xProfile)(void*,const char*,sqlite_uint64), void*);
drh18de4822003-01-16 16:28:53 +0000560
danielk1977348bb5d2003-10-18 09:37:26 +0000561/*
562** This routine configures a callback function - the progress callback - that
danielk19776f8a5032004-05-10 10:34:51 +0000563** is invoked periodically during long running calls to sqlite3_exec(),
danielk19772097e942004-11-20 06:05:56 +0000564** sqlite3_step() and sqlite3_get_table(). An example use for this API is to
565** keep a GUI updated during a large query.
danielk1977348bb5d2003-10-18 09:37:26 +0000566**
567** The progress callback is invoked once for every N virtual machine opcodes,
568** where N is the second argument to this function. The progress callback
569** itself is identified by the third argument to this function. The fourth
570** argument to this function is a void pointer passed to the progress callback
571** function each time it is invoked.
572**
danielk19776f8a5032004-05-10 10:34:51 +0000573** If a call to sqlite3_exec(), sqlite3_step() or sqlite3_get_table() results
danielk1977348bb5d2003-10-18 09:37:26 +0000574** in less than N opcodes being executed, then the progress callback is not
575** invoked.
576**
danielk1977348bb5d2003-10-18 09:37:26 +0000577** To remove the progress callback altogether, pass NULL as the third
578** argument to this function.
579**
580** If the progress callback returns a result other than 0, then the current
581** query is immediately terminated and any database changes rolled back. If the
582** query was part of a larger transaction, then the transaction is not rolled
danielk19776f8a5032004-05-10 10:34:51 +0000583** back and remains active. The sqlite3_exec() call returns SQLITE_ABORT.
drhaa940ea2004-01-15 02:44:03 +0000584**
585******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
danielk1977348bb5d2003-10-18 09:37:26 +0000586*/
danielk1977f9d64d22004-06-19 08:18:07 +0000587void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
danielk1977348bb5d2003-10-18 09:37:26 +0000588
drhaa940ea2004-01-15 02:44:03 +0000589/*
590** Register a callback function to be invoked whenever a new transaction
591** is committed. The pArg argument is passed through to the callback.
592** callback. If the callback function returns non-zero, then the commit
593** is converted into a rollback.
594**
595** If another function was previously registered, its pArg value is returned.
596** Otherwise NULL is returned.
597**
598** Registering a NULL function disables the callback.
599**
600******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
601*/
danielk1977f9d64d22004-06-19 08:18:07 +0000602void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
drhaa940ea2004-01-15 02:44:03 +0000603
drh22fbcb82004-02-01 01:22:50 +0000604/*
drh4f26d6c2004-05-26 23:25:30 +0000605** Open the sqlite database file "filename". The "filename" is UTF-8
606** encoded for sqlite3_open() and UTF-16 encoded in the native byte order
607** for sqlite3_open16(). An sqlite3* handle is returned in *ppDb, even
608** if an error occurs. If the database is opened (or created) successfully,
609** then SQLITE_OK is returned. Otherwise an error code is returned. The
610** sqlite3_errmsg() or sqlite3_errmsg16() routines can be used to obtain
611** an English language description of the error.
drh22fbcb82004-02-01 01:22:50 +0000612**
drh4f26d6c2004-05-26 23:25:30 +0000613** If the database file does not exist, then a new database is created.
614** The encoding for the database is UTF-8 if sqlite3_open() is called and
615** UTF-16 if sqlite3_open16 is used.
danielk197765904932004-05-26 06:18:37 +0000616**
617** Whether or not an error occurs when it is opened, resources associated
618** with the sqlite3* handle should be released by passing it to
619** sqlite3_close() when it is no longer required.
620*/
621int sqlite3_open(
622 const char *filename, /* Database filename (UTF-8) */
danielk19774f057f92004-06-08 00:02:33 +0000623 sqlite3 **ppDb /* OUT: SQLite db handle */
danielk197765904932004-05-26 06:18:37 +0000624);
danielk197765904932004-05-26 06:18:37 +0000625int sqlite3_open16(
626 const void *filename, /* Database filename (UTF-16) */
danielk19774f057f92004-06-08 00:02:33 +0000627 sqlite3 **ppDb /* OUT: SQLite db handle */
danielk197765904932004-05-26 06:18:37 +0000628);
danielk1977295ba552004-05-19 10:34:51 +0000629
danielk197765904932004-05-26 06:18:37 +0000630/*
631** Return the error code for the most recent sqlite3_* API call associated
632** with sqlite3 handle 'db'. SQLITE_OK is returned if the most recent
633** API call was successful.
634**
635** Calls to many sqlite3_* functions set the error code and string returned
636** by sqlite3_errcode(), sqlite3_errmsg() and sqlite3_errmsg16()
637** (overwriting the previous values). Note that calls to sqlite3_errcode(),
638** sqlite3_errmsg() and sqlite3_errmsg16() themselves do not affect the
639** results of future invocations.
640**
641** Assuming no other intervening sqlite3_* API calls are made, the error
642** code returned by this function is associated with the same error as
643** the strings returned by sqlite3_errmsg() and sqlite3_errmsg16().
644*/
645int sqlite3_errcode(sqlite3 *db);
646
647/*
648** Return a pointer to a UTF-8 encoded string describing in english the
649** error condition for the most recent sqlite3_* API call. The returned
650** string is always terminated by an 0x00 byte.
651**
652** The string "not an error" is returned when the most recent API call was
653** successful.
654*/
655const char *sqlite3_errmsg(sqlite3*);
656
657/*
658** Return a pointer to a UTF-16 native byte order encoded string describing
659** in english the error condition for the most recent sqlite3_* API call.
660** The returned string is always terminated by a pair of 0x00 bytes.
661**
662** The string "not an error" is returned when the most recent API call was
663** successful.
664*/
665const void *sqlite3_errmsg16(sqlite3*);
666
667/*
668** An instance of the following opaque structure is used to represent
669** a compiled SQL statment.
670*/
danielk1977fc57d7b2004-05-26 02:04:57 +0000671typedef struct sqlite3_stmt sqlite3_stmt;
672
danielk1977e3209e42004-05-20 01:40:18 +0000673/*
danielk197765904932004-05-26 06:18:37 +0000674** To execute an SQL query, it must first be compiled into a byte-code
675** program using one of the following routines. The only difference between
676** them is that the second argument, specifying the SQL statement to
677** compile, is assumed to be encoded in UTF-8 for the sqlite3_prepare()
678** function and UTF-16 for sqlite3_prepare16().
679**
680** The first parameter "db" is an SQLite database handle. The second
681** parameter "zSql" is the statement to be compiled, encoded as either
682** UTF-8 or UTF-16 (see above). If the next parameter, "nBytes", is less
683** than zero, then zSql is read up to the first nul terminator. If
684** "nBytes" is not less than zero, then it is the length of the string zSql
685** in bytes (not characters).
686**
687** *pzTail is made to point to the first byte past the end of the first
688** SQL statement in zSql. This routine only compiles the first statement
689** in zSql, so *pzTail is left pointing to what remains uncompiled.
690**
691** *ppStmt is left pointing to a compiled SQL statement that can be
692** executed using sqlite3_step(). Or if there is an error, *ppStmt may be
693** set to NULL. If the input text contained no SQL (if the input is and
694** empty string or a comment) then *ppStmt is set to NULL.
695**
696** On success, SQLITE_OK is returned. Otherwise an error code is returned.
697*/
698int sqlite3_prepare(
699 sqlite3 *db, /* Database handle */
700 const char *zSql, /* SQL statement, UTF-8 encoded */
701 int nBytes, /* Length of zSql in bytes. */
702 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
703 const char **pzTail /* OUT: Pointer to unused portion of zSql */
704);
705int sqlite3_prepare16(
706 sqlite3 *db, /* Database handle */
707 const void *zSql, /* SQL statement, UTF-16 encoded */
708 int nBytes, /* Length of zSql in bytes. */
709 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
710 const void **pzTail /* OUT: Pointer to unused portion of zSql */
711);
712
713/*
drhb900aaf2006-11-09 00:24:53 +0000714** Newer versions of the prepare API work just like the legacy versions
715** but with one exception: The a copy of the SQL text is saved in the
716** sqlite3_stmt structure that is returned. If this copy exists, it
717** modifieds the behavior of sqlite3_step() slightly. First, sqlite3_step()
718** will no longer return an SQLITE_SCHEMA error but will instead automatically
719** rerun the compiler to rebuild the prepared statement. Secondly,
720** sqlite3_step() now turns a full result code - the result code that
721** use used to have to call sqlite3_reset() to get.
722*/
723int sqlite3_prepare_v2(
724 sqlite3 *db, /* Database handle */
725 const char *zSql, /* SQL statement, UTF-8 encoded */
726 int nBytes, /* Length of zSql in bytes. */
727 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
728 const char **pzTail /* OUT: Pointer to unused portion of zSql */
729);
730int sqlite3_prepare16_v2(
731 sqlite3 *db, /* Database handle */
732 const void *zSql, /* SQL statement, UTF-16 encoded */
733 int nBytes, /* Length of zSql in bytes. */
734 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
735 const void **pzTail /* OUT: Pointer to unused portion of zSql */
736);
737
738/*
drhf4479502004-05-27 03:12:53 +0000739** Pointers to the following two opaque structures are used to communicate
740** with the implementations of user-defined functions.
741*/
742typedef struct sqlite3_context sqlite3_context;
743typedef struct Mem sqlite3_value;
744
745/*
drh4f26d6c2004-05-26 23:25:30 +0000746** In the SQL strings input to sqlite3_prepare() and sqlite3_prepare16(),
drh32c0d4f2004-12-07 02:14:51 +0000747** one or more literals can be replace by parameters "?" or ":AAA" or
748** "$VVV" where AAA is an identifer and VVV is a variable name according
749** to the syntax rules of the TCL programming language.
750** The value of these parameters (also called "host parameter names") can
751** be set using the routines listed below.
drh4f26d6c2004-05-26 23:25:30 +0000752**
753** In every case, the first parameter is a pointer to the sqlite3_stmt
754** structure returned from sqlite3_prepare(). The second parameter is the
drh32c0d4f2004-12-07 02:14:51 +0000755** index of the parameter. The first parameter as an index of 1. For
756** named parameters (":AAA" or "$VVV") you can use
757** sqlite3_bind_parameter_index() to get the correct index value given
758** the parameters name. If the same named parameter occurs more than
759** once, it is assigned the same index each time.
drh4f26d6c2004-05-26 23:25:30 +0000760**
drh900dfba2004-07-21 15:21:36 +0000761** The fifth parameter to sqlite3_bind_blob(), sqlite3_bind_text(), and
762** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or
763** text after SQLite has finished with it. If the fifth argument is the
764** special value SQLITE_STATIC, then the library assumes that the information
765** is in static, unmanaged space and does not need to be freed. If the
766** fifth argument has the value SQLITE_TRANSIENT, then SQLite makes its
767** own private copy of the data.
drh4f26d6c2004-05-26 23:25:30 +0000768**
769** The sqlite3_bind_* routine must be called before sqlite3_step() after
drh32c0d4f2004-12-07 02:14:51 +0000770** an sqlite3_prepare() or sqlite3_reset(). Unbound parameterss are
771** interpreted as NULL.
drh4f26d6c2004-05-26 23:25:30 +0000772*/
danielk1977d8123362004-06-12 09:25:12 +0000773int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*));
drhf4479502004-05-27 03:12:53 +0000774int sqlite3_bind_double(sqlite3_stmt*, int, double);
775int sqlite3_bind_int(sqlite3_stmt*, int, int);
drhefad9992004-06-22 12:13:55 +0000776int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite_int64);
drhf4479502004-05-27 03:12:53 +0000777int sqlite3_bind_null(sqlite3_stmt*, int);
danielk1977d8123362004-06-12 09:25:12 +0000778int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*));
779int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*));
drhf4479502004-05-27 03:12:53 +0000780int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);
drh4f26d6c2004-05-26 23:25:30 +0000781
782/*
drh32c0d4f2004-12-07 02:14:51 +0000783** Return the number of parameters in a compiled SQL statement. This
drh75f6a032004-07-15 14:15:00 +0000784** routine was added to support DBD::SQLite.
drh75f6a032004-07-15 14:15:00 +0000785*/
786int sqlite3_bind_parameter_count(sqlite3_stmt*);
787
788/*
drh32c0d4f2004-12-07 02:14:51 +0000789** Return the name of the i-th parameter. Ordinary parameters "?" are
790** nameless and a NULL is returned. For parameters of the form :AAA or
791** $VVV the complete text of the parameter name is returned, including
792** the initial ":" or "$". NULL is returned if the index is out of range.
drh895d7472004-08-20 16:02:39 +0000793*/
794const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int);
795
796/*
drhfa6bc002004-09-07 16:19:52 +0000797** Return the index of a parameter with the given name. The name
798** must match exactly. If no parameter with the given name is found,
799** return 0.
800*/
801int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName);
802
803/*
danielk1977600dd0b2005-01-20 01:14:23 +0000804** Set all the parameters in the compiled SQL statement to NULL.
danielk1977600dd0b2005-01-20 01:14:23 +0000805*/
806int sqlite3_clear_bindings(sqlite3_stmt*);
807
808/*
danielk197765904932004-05-26 06:18:37 +0000809** Return the number of columns in the result set returned by the compiled
810** SQL statement. This routine returns 0 if pStmt is an SQL statement
811** that does not return data (for example an UPDATE).
812*/
813int sqlite3_column_count(sqlite3_stmt *pStmt);
814
815/*
816** The first parameter is a compiled SQL statement. This function returns
817** the column heading for the Nth column of that statement, where N is the
drh4f26d6c2004-05-26 23:25:30 +0000818** second function parameter. The string returned is UTF-8 for
819** sqlite3_column_name() and UTF-16 for sqlite3_column_name16().
danielk197765904932004-05-26 06:18:37 +0000820*/
821const char *sqlite3_column_name(sqlite3_stmt*,int);
danielk197765904932004-05-26 06:18:37 +0000822const void *sqlite3_column_name16(sqlite3_stmt*,int);
823
824/*
danielk1977955de522006-02-10 02:27:42 +0000825** The first parameter to the following calls is a compiled SQL statement.
826** These functions return information about the Nth column returned by
827** the statement, where N is the second function argument.
828**
829** If the Nth column returned by the statement is not a column value,
830** then all of the functions return NULL. Otherwise, the return the
831** name of the attached database, table and column that the expression
832** extracts a value from.
833**
834** As with all other SQLite APIs, those postfixed with "16" return UTF-16
835** encoded strings, the other functions return UTF-8. The memory containing
836** the returned strings is valid until the statement handle is finalized().
danielk19774b1ae992006-02-10 03:06:10 +0000837**
838** These APIs are only available if the library was compiled with the
839** SQLITE_ENABLE_COLUMN_METADATA preprocessor symbol defined.
danielk1977955de522006-02-10 02:27:42 +0000840*/
841const char *sqlite3_column_database_name(sqlite3_stmt*,int);
842const void *sqlite3_column_database_name16(sqlite3_stmt*,int);
843const char *sqlite3_column_table_name(sqlite3_stmt*,int);
844const void *sqlite3_column_table_name16(sqlite3_stmt*,int);
845const char *sqlite3_column_origin_name(sqlite3_stmt*,int);
846const void *sqlite3_column_origin_name16(sqlite3_stmt*,int);
847
848/*
danielk197765904932004-05-26 06:18:37 +0000849** The first parameter is a compiled SQL statement. If this statement
850** is a SELECT statement, the Nth column of the returned result set
851** of the SELECT is a table column then the declared type of the table
852** column is returned. If the Nth column of the result set is not at table
853** column, then a NULL pointer is returned. The returned string is always
854** UTF-8 encoded. For example, in the database schema:
855**
856** CREATE TABLE t1(c1 VARIANT);
857**
858** And the following statement compiled:
859**
danielk1977955de522006-02-10 02:27:42 +0000860** SELECT c1 + 1, c1 FROM t1;
danielk197765904932004-05-26 06:18:37 +0000861**
862** Then this routine would return the string "VARIANT" for the second
863** result column (i==1), and a NULL pointer for the first result column
864** (i==0).
865*/
866const char *sqlite3_column_decltype(sqlite3_stmt *, int i);
867
868/*
869** The first parameter is a compiled SQL statement. If this statement
870** is a SELECT statement, the Nth column of the returned result set
871** of the SELECT is a table column then the declared type of the table
872** column is returned. If the Nth column of the result set is not at table
873** column, then a NULL pointer is returned. The returned string is always
874** UTF-16 encoded. For example, in the database schema:
875**
drh4f26d6c2004-05-26 23:25:30 +0000876** CREATE TABLE t1(c1 INTEGER);
danielk197765904932004-05-26 06:18:37 +0000877**
878** And the following statement compiled:
879**
danielk1977955de522006-02-10 02:27:42 +0000880** SELECT c1 + 1, c1 FROM t1;
danielk197765904932004-05-26 06:18:37 +0000881**
drh4f26d6c2004-05-26 23:25:30 +0000882** Then this routine would return the string "INTEGER" for the second
danielk197765904932004-05-26 06:18:37 +0000883** result column (i==1), and a NULL pointer for the first result column
884** (i==0).
885*/
886const void *sqlite3_column_decltype16(sqlite3_stmt*,int);
887
danielk1977106bb232004-05-21 10:08:53 +0000888/*
889** After an SQL query has been compiled with a call to either
890** sqlite3_prepare() or sqlite3_prepare16(), then this function must be
891** called one or more times to execute the statement.
892**
893** The return value will be either SQLITE_BUSY, SQLITE_DONE,
894** SQLITE_ROW, SQLITE_ERROR, or SQLITE_MISUSE.
895**
896** SQLITE_BUSY means that the database engine attempted to open
897** a locked database and there is no busy callback registered.
898** Call sqlite3_step() again to retry the open.
899**
900** SQLITE_DONE means that the statement has finished executing
901** successfully. sqlite3_step() should not be called again on this virtual
902** machine.
903**
904** If the SQL statement being executed returns any data, then
905** SQLITE_ROW is returned each time a new row of data is ready
906** for processing by the caller. The values may be accessed using
907** the sqlite3_column_*() functions described below. sqlite3_step()
908** is called again to retrieve the next row of data.
909**
910** SQLITE_ERROR means that a run-time error (such as a constraint
911** violation) has occurred. sqlite3_step() should not be called again on
912** the VM. More information may be found by calling sqlite3_errmsg().
913**
914** SQLITE_MISUSE means that the this routine was called inappropriately.
915** Perhaps it was called on a virtual machine that had already been
916** finalized or on one that had previously returned SQLITE_ERROR or
917** SQLITE_DONE. Or it could be the case the the same database connection
918** is being used simulataneously by two or more threads.
919*/
danielk197717240fd2004-05-26 00:07:25 +0000920int sqlite3_step(sqlite3_stmt*);
danielk1977106bb232004-05-21 10:08:53 +0000921
danielk1977106bb232004-05-21 10:08:53 +0000922/*
923** Return the number of values in the current row of the result set.
924**
925** After a call to sqlite3_step() that returns SQLITE_ROW, this routine
926** will return the same value as the sqlite3_column_count() function.
927** After sqlite3_step() has returned an SQLITE_DONE, SQLITE_BUSY or
928** error code, or before sqlite3_step() has been called on a
929** compiled SQL statement, this routine returns zero.
930*/
danielk197793d46752004-05-23 13:30:58 +0000931int sqlite3_data_count(sqlite3_stmt *pStmt);
danielk19774adee202004-05-08 08:23:19 +0000932
drh4f26d6c2004-05-26 23:25:30 +0000933/*
934** Values are stored in the database in one of the following fundamental
935** types.
936*/
drh9c054832004-05-31 18:51:57 +0000937#define SQLITE_INTEGER 1
938#define SQLITE_FLOAT 2
drh1e284f42004-10-06 15:52:01 +0000939/* #define SQLITE_TEXT 3 // See below */
drh9c054832004-05-31 18:51:57 +0000940#define SQLITE_BLOB 4
941#define SQLITE_NULL 5
danielk19774adee202004-05-08 08:23:19 +0000942
danielk1977106bb232004-05-21 10:08:53 +0000943/*
drh1e284f42004-10-06 15:52:01 +0000944** SQLite version 2 defines SQLITE_TEXT differently. To allow both
945** version 2 and version 3 to be included, undefine them both if a
946** conflict is seen. Define SQLITE3_TEXT to be the version 3 value.
947*/
948#ifdef SQLITE_TEXT
949# undef SQLITE_TEXT
950#else
951# define SQLITE_TEXT 3
952#endif
953#define SQLITE3_TEXT 3
954
955/*
drh4f26d6c2004-05-26 23:25:30 +0000956** The next group of routines returns information about the information
957** in a single column of the current result row of a query. In every
958** case the first parameter is a pointer to the SQL statement that is being
959** executed (the sqlite_stmt* that was returned from sqlite3_prepare()) and
960** the second argument is the index of the column for which information
961** should be returned. iCol is zero-indexed. The left-most column as an
962** index of 0.
danielk1977106bb232004-05-21 10:08:53 +0000963**
drh4f26d6c2004-05-26 23:25:30 +0000964** If the SQL statement is not currently point to a valid row, or if the
965** the colulmn index is out of range, the result is undefined.
966**
967** These routines attempt to convert the value where appropriate. For
968** example, if the internal representation is FLOAT and a text result
969** is requested, sprintf() is used internally to do the conversion
970** automatically. The following table details the conversions that
971** are applied:
972**
973** Internal Type Requested Type Conversion
974** ------------- -------------- --------------------------
975** NULL INTEGER Result is 0
976** NULL FLOAT Result is 0.0
977** NULL TEXT Result is an empty string
978** NULL BLOB Result is a zero-length BLOB
979** INTEGER FLOAT Convert from integer to float
980** INTEGER TEXT ASCII rendering of the integer
981** INTEGER BLOB Same as for INTEGER->TEXT
982** FLOAT INTEGER Convert from float to integer
983** FLOAT TEXT ASCII rendering of the float
984** FLOAT BLOB Same as FLOAT->TEXT
985** TEXT INTEGER Use atoi()
986** TEXT FLOAT Use atof()
987** TEXT BLOB No change
988** BLOB INTEGER Convert to TEXT then use atoi()
989** BLOB FLOAT Convert to TEXT then use atof()
990** BLOB TEXT Add a \000 terminator if needed
991**
992** The following access routines are provided:
993**
994** _type() Return the datatype of the result. This is one of
995** SQLITE_INTEGER, SQLITE_FLOAT, SQLITE_TEXT, SQLITE_BLOB,
996** or SQLITE_NULL.
997** _blob() Return the value of a BLOB.
998** _bytes() Return the number of bytes in a BLOB value or the number
999** of bytes in a TEXT value represented as UTF-8. The \000
1000** terminator is included in the byte count for TEXT values.
1001** _bytes16() Return the number of bytes in a BLOB value or the number
1002** of bytes in a TEXT value represented as UTF-16. The \u0000
1003** terminator is included in the byte count for TEXT values.
1004** _double() Return a FLOAT value.
1005** _int() Return an INTEGER value in the host computer's native
1006** integer representation. This might be either a 32- or 64-bit
1007** integer depending on the host.
1008** _int64() Return an INTEGER value as a 64-bit signed integer.
1009** _text() Return the value as UTF-8 text.
1010** _text16() Return the value as UTF-16 text.
danielk1977106bb232004-05-21 10:08:53 +00001011*/
drhf4479502004-05-27 03:12:53 +00001012const void *sqlite3_column_blob(sqlite3_stmt*, int iCol);
1013int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
1014int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
1015double sqlite3_column_double(sqlite3_stmt*, int iCol);
1016int sqlite3_column_int(sqlite3_stmt*, int iCol);
drhefad9992004-06-22 12:13:55 +00001017sqlite_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol);
drhf4479502004-05-27 03:12:53 +00001018const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol);
1019const void *sqlite3_column_text16(sqlite3_stmt*, int iCol);
drh4f26d6c2004-05-26 23:25:30 +00001020int sqlite3_column_type(sqlite3_stmt*, int iCol);
drh29d72102006-02-09 22:13:41 +00001021int sqlite3_column_numeric_type(sqlite3_stmt*, int iCol);
drh4be8b512006-06-13 23:51:34 +00001022sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol);
danielk19774adee202004-05-08 08:23:19 +00001023
danielk197765904932004-05-26 06:18:37 +00001024/*
1025** The sqlite3_finalize() function is called to delete a compiled
1026** SQL statement obtained by a previous call to sqlite3_prepare()
1027** or sqlite3_prepare16(). If the statement was executed successfully, or
1028** not executed at all, then SQLITE_OK is returned. If execution of the
1029** statement failed then an error code is returned.
1030**
1031** This routine can be called at any point during the execution of the
1032** virtual machine. If the virtual machine has not completed execution
1033** when this routine is called, that is like encountering an error or
1034** an interrupt. (See sqlite3_interrupt().) Incomplete updates may be
1035** rolled back and transactions cancelled, depending on the circumstances,
1036** and the result code returned will be SQLITE_ABORT.
1037*/
1038int sqlite3_finalize(sqlite3_stmt *pStmt);
1039
1040/*
1041** The sqlite3_reset() function is called to reset a compiled SQL
1042** statement obtained by a previous call to sqlite3_prepare() or
1043** sqlite3_prepare16() back to it's initial state, ready to be re-executed.
1044** Any SQL statement variables that had values bound to them using
1045** the sqlite3_bind_*() API retain their values.
1046*/
1047int sqlite3_reset(sqlite3_stmt *pStmt);
1048
1049/*
danielk197765904932004-05-26 06:18:37 +00001050** The following two functions are used to add user functions or aggregates
1051** implemented in C to the SQL langauge interpreted by SQLite. The
1052** difference only between the two is that the second parameter, the
1053** name of the (scalar) function or aggregate, is encoded in UTF-8 for
1054** sqlite3_create_function() and UTF-16 for sqlite3_create_function16().
1055**
1056** The first argument is the database handle that the new function or
1057** aggregate is to be added to. If a single program uses more than one
1058** database handle internally, then user functions or aggregates must
1059** be added individually to each database handle with which they will be
1060** used.
1061**
1062** The third parameter is the number of arguments that the function or
1063** aggregate takes. If this parameter is negative, then the function or
1064** aggregate may take any number of arguments.
1065**
danielk1977d8123362004-06-12 09:25:12 +00001066** The fourth parameter is one of SQLITE_UTF* values defined below,
1067** indicating the encoding that the function is most likely to handle
1068** values in. This does not change the behaviour of the programming
1069** interface. However, if two versions of the same function are registered
1070** with different encoding values, SQLite invokes the version likely to
1071** minimize conversions between text encodings.
danielk1977d02eb1f2004-06-06 09:44:03 +00001072**
danielk197765904932004-05-26 06:18:37 +00001073** The seventh, eighth and ninth parameters, xFunc, xStep and xFinal, are
1074** pointers to user implemented C functions that implement the user
1075** function or aggregate. A scalar function requires an implementation of
1076** the xFunc callback only, NULL pointers should be passed as the xStep
1077** and xFinal parameters. An aggregate function requires an implementation
1078** of xStep and xFinal, but NULL should be passed for xFunc. To delete an
1079** existing user function or aggregate, pass NULL for all three function
1080** callback. Specifying an inconstent set of callback values, such as an
1081** xFunc and an xFinal, or an xStep but no xFinal, SQLITE_ERROR is
1082** returned.
1083*/
1084int sqlite3_create_function(
1085 sqlite3 *,
1086 const char *zFunctionName,
1087 int nArg,
1088 int eTextRep,
danielk197765904932004-05-26 06:18:37 +00001089 void*,
1090 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
1091 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1092 void (*xFinal)(sqlite3_context*)
1093);
1094int sqlite3_create_function16(
1095 sqlite3*,
1096 const void *zFunctionName,
1097 int nArg,
1098 int eTextRep,
danielk197765904932004-05-26 06:18:37 +00001099 void*,
1100 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
1101 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1102 void (*xFinal)(sqlite3_context*)
1103);
1104
1105/*
drhcf85a512006-02-09 18:35:29 +00001106** This function is deprecated. Do not use it. It continues to exist
1107** so as not to break legacy code. But new code should avoid using it.
danielk197765904932004-05-26 06:18:37 +00001108*/
1109int sqlite3_aggregate_count(sqlite3_context*);
1110
danielk19770ffba6b2004-05-24 09:10:10 +00001111/*
drh4f26d6c2004-05-26 23:25:30 +00001112** The next group of routines returns information about parameters to
1113** a user-defined function. Function implementations use these routines
1114** to access their parameters. These routines are the same as the
1115** sqlite3_column_* routines except that these routines take a single
1116** sqlite3_value* pointer instead of an sqlite3_stmt* and an integer
1117** column number.
danielk19770ffba6b2004-05-24 09:10:10 +00001118*/
drhf4479502004-05-27 03:12:53 +00001119const void *sqlite3_value_blob(sqlite3_value*);
1120int sqlite3_value_bytes(sqlite3_value*);
1121int sqlite3_value_bytes16(sqlite3_value*);
1122double sqlite3_value_double(sqlite3_value*);
1123int sqlite3_value_int(sqlite3_value*);
drhefad9992004-06-22 12:13:55 +00001124sqlite_int64 sqlite3_value_int64(sqlite3_value*);
drhf4479502004-05-27 03:12:53 +00001125const unsigned char *sqlite3_value_text(sqlite3_value*);
1126const void *sqlite3_value_text16(sqlite3_value*);
danielk1977d8123362004-06-12 09:25:12 +00001127const void *sqlite3_value_text16le(sqlite3_value*);
1128const void *sqlite3_value_text16be(sqlite3_value*);
danielk197793d46752004-05-23 13:30:58 +00001129int sqlite3_value_type(sqlite3_value*);
drh29d72102006-02-09 22:13:41 +00001130int sqlite3_value_numeric_type(sqlite3_value*);
danielk19770ffba6b2004-05-24 09:10:10 +00001131
1132/*
danielk19770ae8b832004-05-25 12:05:56 +00001133** Aggregate functions use the following routine to allocate
1134** a structure for storing their state. The first time this routine
1135** is called for a particular aggregate, a new structure of size nBytes
1136** is allocated, zeroed, and returned. On subsequent calls (for the
1137** same aggregate instance) the same buffer is returned. The implementation
1138** of the aggregate can use the returned buffer to accumulate data.
1139**
1140** The buffer allocated is freed automatically by SQLite.
1141*/
drh4f26d6c2004-05-26 23:25:30 +00001142void *sqlite3_aggregate_context(sqlite3_context*, int nBytes);
danielk19777e18c252004-05-25 11:47:24 +00001143
1144/*
drhc0f2a012005-07-09 02:39:40 +00001145** The pUserData parameter to the sqlite3_create_function()
1146** routine used to register user functions is available to
1147** the implementation of the function using this call.
danielk19777e18c252004-05-25 11:47:24 +00001148*/
1149void *sqlite3_user_data(sqlite3_context*);
1150
1151/*
danielk1977682f68b2004-06-05 10:22:17 +00001152** The following two functions may be used by scalar user functions to
1153** associate meta-data with argument values. If the same value is passed to
1154** multiple invocations of the user-function during query execution, under
1155** some circumstances the associated meta-data may be preserved. This may
1156** be used, for example, to add a regular-expression matching scalar
1157** function. The compiled version of the regular expression is stored as
1158** meta-data associated with the SQL value passed as the regular expression
1159** pattern.
1160**
1161** Calling sqlite3_get_auxdata() returns a pointer to the meta data
1162** associated with the Nth argument value to the current user function
1163** call, where N is the second parameter. If no meta-data has been set for
1164** that value, then a NULL pointer is returned.
1165**
1166** The sqlite3_set_auxdata() is used to associate meta data with a user
1167** function argument. The third parameter is a pointer to the meta data
1168** to be associated with the Nth user function argument value. The fourth
1169** parameter specifies a 'delete function' that will be called on the meta
1170** data pointer to release it when it is no longer required. If the delete
1171** function pointer is NULL, it is not invoked.
1172**
1173** In practice, meta-data is preserved between function calls for
1174** expressions that are constant at compile time. This includes literal
1175** values and SQL variables.
1176*/
1177void *sqlite3_get_auxdata(sqlite3_context*, int);
1178void sqlite3_set_auxdata(sqlite3_context*, int, void*, void (*)(void*));
1179
drha2854222004-06-17 19:04:17 +00001180
1181/*
1182** These are special value for the destructor that is passed in as the
1183** final argument to routines like sqlite3_result_blob(). If the destructor
1184** argument is SQLITE_STATIC, it means that the content pointer is constant
1185** and will never change. It does not need to be destroyed. The
1186** SQLITE_TRANSIENT value means that the content will likely change in
1187** the near future and that SQLite should make its own private copy of
1188** the content before returning.
drh6c9121a2007-01-26 00:51:43 +00001189**
1190** The typedef is necessary to work around problems in certain
1191** C++ compilers. See ticket #2191.
drha2854222004-06-17 19:04:17 +00001192*/
drh6c9121a2007-01-26 00:51:43 +00001193typedef void (*sqlite3_destructor_type)(void*);
1194#define SQLITE_STATIC ((sqlite3_destructor_type)0)
1195#define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1)
danielk1977d8123362004-06-12 09:25:12 +00001196
danielk1977682f68b2004-06-05 10:22:17 +00001197/*
drh4f26d6c2004-05-26 23:25:30 +00001198** User-defined functions invoke the following routines in order to
1199** set their return value.
danielk19777e18c252004-05-25 11:47:24 +00001200*/
danielk1977d8123362004-06-12 09:25:12 +00001201void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*));
drh4f26d6c2004-05-26 23:25:30 +00001202void sqlite3_result_double(sqlite3_context*, double);
danielk19777e18c252004-05-25 11:47:24 +00001203void sqlite3_result_error(sqlite3_context*, const char*, int);
1204void sqlite3_result_error16(sqlite3_context*, const void*, int);
drh4f26d6c2004-05-26 23:25:30 +00001205void sqlite3_result_int(sqlite3_context*, int);
drhefad9992004-06-22 12:13:55 +00001206void sqlite3_result_int64(sqlite3_context*, sqlite_int64);
drh4f26d6c2004-05-26 23:25:30 +00001207void sqlite3_result_null(sqlite3_context*);
danielk1977d8123362004-06-12 09:25:12 +00001208void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*));
1209void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*));
1210void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*));
1211void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*));
drh4f26d6c2004-05-26 23:25:30 +00001212void sqlite3_result_value(sqlite3_context*, sqlite3_value*);
drhf9b596e2004-05-26 16:54:42 +00001213
drh52619df2004-06-11 17:48:02 +00001214/*
1215** These are the allowed values for the eTextRep argument to
1216** sqlite3_create_collation and sqlite3_create_function.
1217*/
drh7d9bd4e2006-02-16 18:16:36 +00001218#define SQLITE_UTF8 1
1219#define SQLITE_UTF16LE 2
1220#define SQLITE_UTF16BE 3
1221#define SQLITE_UTF16 4 /* Use native byte order */
1222#define SQLITE_ANY 5 /* sqlite3_create_function only */
1223#define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */
danielk1977466be562004-06-10 02:16:01 +00001224
danielk19777cedc8d2004-06-10 10:50:08 +00001225/*
1226** These two functions are used to add new collation sequences to the
1227** sqlite3 handle specified as the first argument.
1228**
1229** The name of the new collation sequence is specified as a UTF-8 string
1230** for sqlite3_create_collation() and a UTF-16 string for
1231** sqlite3_create_collation16(). In both cases the name is passed as the
1232** second function argument.
1233**
1234** The third argument must be one of the constants SQLITE_UTF8,
1235** SQLITE_UTF16LE or SQLITE_UTF16BE, indicating that the user-supplied
1236** routine expects to be passed pointers to strings encoded using UTF-8,
1237** UTF-16 little-endian or UTF-16 big-endian respectively.
1238**
1239** A pointer to the user supplied routine must be passed as the fifth
1240** argument. If it is NULL, this is the same as deleting the collation
1241** sequence (so that SQLite cannot call it anymore). Each time the user
1242** supplied function is invoked, it is passed a copy of the void* passed as
1243** the fourth argument to sqlite3_create_collation() or
1244** sqlite3_create_collation16() as its first parameter.
1245**
1246** The remaining arguments to the user-supplied routine are two strings,
1247** each represented by a [length, data] pair and encoded in the encoding
1248** that was passed as the third argument when the collation sequence was
1249** registered. The user routine should return negative, zero or positive if
1250** the first string is less than, equal to, or greater than the second
1251** string. i.e. (STRING1 - STRING2).
1252*/
danielk19770202b292004-06-09 09:55:16 +00001253int sqlite3_create_collation(
1254 sqlite3*,
1255 const char *zName,
danielk19777cedc8d2004-06-10 10:50:08 +00001256 int eTextRep,
danielk19770202b292004-06-09 09:55:16 +00001257 void*,
1258 int(*xCompare)(void*,int,const void*,int,const void*)
1259);
1260int sqlite3_create_collation16(
1261 sqlite3*,
1262 const char *zName,
danielk19777cedc8d2004-06-10 10:50:08 +00001263 int eTextRep,
danielk19770202b292004-06-09 09:55:16 +00001264 void*,
1265 int(*xCompare)(void*,int,const void*,int,const void*)
1266);
1267
danielk19777cedc8d2004-06-10 10:50:08 +00001268/*
1269** To avoid having to register all collation sequences before a database
1270** can be used, a single callback function may be registered with the
1271** database handle to be called whenever an undefined collation sequence is
1272** required.
1273**
1274** If the function is registered using the sqlite3_collation_needed() API,
1275** then it is passed the names of undefined collation sequences as strings
1276** encoded in UTF-8. If sqlite3_collation_needed16() is used, the names
1277** are passed as UTF-16 in machine native byte order. A call to either
1278** function replaces any existing callback.
1279**
1280** When the user-function is invoked, the first argument passed is a copy
1281** of the second argument to sqlite3_collation_needed() or
1282** sqlite3_collation_needed16(). The second argument is the database
1283** handle. The third argument is one of SQLITE_UTF8, SQLITE_UTF16BE or
1284** SQLITE_UTF16LE, indicating the most desirable form of the collation
1285** sequence function required. The fourth parameter is the name of the
1286** required collation sequence.
1287**
1288** The collation sequence is returned to SQLite by a collation-needed
1289** callback using the sqlite3_create_collation() or
1290** sqlite3_create_collation16() APIs, described above.
1291*/
1292int sqlite3_collation_needed(
1293 sqlite3*,
1294 void*,
1295 void(*)(void*,sqlite3*,int eTextRep,const char*)
1296);
1297int sqlite3_collation_needed16(
1298 sqlite3*,
1299 void*,
1300 void(*)(void*,sqlite3*,int eTextRep,const void*)
1301);
1302
drh2011d5f2004-07-22 02:40:37 +00001303/*
1304** Specify the key for an encrypted database. This routine should be
1305** called right after sqlite3_open().
1306**
1307** The code to implement this API is not available in the public release
1308** of SQLite.
1309*/
1310int sqlite3_key(
1311 sqlite3 *db, /* Database to be rekeyed */
1312 const void *pKey, int nKey /* The key */
1313);
1314
1315/*
1316** Change the key on an open database. If the current database is not
1317** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the
1318** database is decrypted.
1319**
1320** The code to implement this API is not available in the public release
1321** of SQLite.
1322*/
1323int sqlite3_rekey(
1324 sqlite3 *db, /* Database to be rekeyed */
1325 const void *pKey, int nKey /* The new key */
1326);
danielk19770202b292004-06-09 09:55:16 +00001327
drhab3f9fe2004-08-14 17:10:10 +00001328/*
danielk1977600dd0b2005-01-20 01:14:23 +00001329** Sleep for a little while. The second parameter is the number of
1330** miliseconds to sleep for.
1331**
1332** If the operating system does not support sleep requests with
1333** milisecond time resolution, then the time will be rounded up to
1334** the nearest second. The number of miliseconds of sleep actually
1335** requested from the operating system is returned.
danielk1977600dd0b2005-01-20 01:14:23 +00001336*/
1337int sqlite3_sleep(int);
1338
1339/*
drh65efb652005-06-12 22:12:39 +00001340** Return TRUE (non-zero) if the statement supplied as an argument needs
drhd89bd002005-01-22 03:03:54 +00001341** to be recompiled. A statement needs to be recompiled whenever the
1342** execution environment changes in a way that would alter the program
1343** that sqlite3_prepare() generates. For example, if new functions or
1344** collating sequences are registered or if an authorizer function is
1345** added or changed.
1346**
drhd89bd002005-01-22 03:03:54 +00001347*/
1348int sqlite3_expired(sqlite3_stmt*);
1349
1350/*
drhf8db1bc2005-04-22 02:38:37 +00001351** Move all bindings from the first prepared statement over to the second.
1352** This routine is useful, for example, if the first prepared statement
1353** fails with an SQLITE_SCHEMA error. The same SQL can be prepared into
1354** the second prepared statement then all of the bindings transfered over
1355** to the second statement before the first statement is finalized.
drhf8db1bc2005-04-22 02:38:37 +00001356*/
1357int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*);
1358
1359/*
tpoindex9a09a3c2004-12-20 19:01:32 +00001360** If the following global variable is made to point to a
drhab3f9fe2004-08-14 17:10:10 +00001361** string which is the name of a directory, then all temporary files
1362** created by SQLite will be placed in that directory. If this variable
1363** is NULL pointer, then SQLite does a search for an appropriate temporary
1364** file directory.
1365**
danielk19776b456a22005-03-21 04:04:02 +00001366** Once sqlite3_open() has been called, changing this variable will invalidate
1367** the current temporary database, if any.
drhab3f9fe2004-08-14 17:10:10 +00001368*/
tpoindex9a09a3c2004-12-20 19:01:32 +00001369extern char *sqlite3_temp_directory;
drhab3f9fe2004-08-14 17:10:10 +00001370
danielk19776b456a22005-03-21 04:04:02 +00001371/*
1372** This function is called to recover from a malloc() failure that occured
1373** within the SQLite library. Normally, after a single malloc() fails the
1374** library refuses to function (all major calls return SQLITE_NOMEM).
drh9a7e6082005-03-31 22:26:19 +00001375** This function restores the library state so that it can be used again.
danielk19776b456a22005-03-21 04:04:02 +00001376**
1377** All existing statements (sqlite3_stmt pointers) must be finalized or
1378** reset before this call is made. Otherwise, SQLITE_BUSY is returned.
1379** If any in-memory databases are in use, either as a main or TEMP
1380** database, SQLITE_ERROR is returned. In either of these cases, the
1381** library is not reset and remains unusable.
1382**
1383** This function is *not* threadsafe. Calling this from within a threaded
1384** application when threads other than the caller have used SQLite is
1385** dangerous and will almost certainly result in malfunctions.
1386**
1387** This functionality can be omitted from a build by defining the
1388** SQLITE_OMIT_GLOBALRECOVER at compile time.
1389*/
drhd9cb6ac2005-10-20 07:28:17 +00001390int sqlite3_global_recover(void);
danielk19776b456a22005-03-21 04:04:02 +00001391
drh3e1d8e62005-05-26 16:23:34 +00001392/*
1393** Test to see whether or not the database connection is in autocommit
1394** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
1395** by default. Autocommit is disabled by a BEGIN statement and reenabled
1396** by the next COMMIT or ROLLBACK.
drh3e1d8e62005-05-26 16:23:34 +00001397*/
1398int sqlite3_get_autocommit(sqlite3*);
1399
drh51942bc2005-06-12 22:01:42 +00001400/*
1401** Return the sqlite3* database handle to which the prepared statement given
1402** in the argument belongs. This is the same database handle that was
1403** the first argument to the sqlite3_prepare() that was used to create
1404** the statement in the first place.
1405*/
1406sqlite3 *sqlite3_db_handle(sqlite3_stmt*);
drh3e1d8e62005-05-26 16:23:34 +00001407
drhb37df7b2005-10-13 02:09:49 +00001408/*
danielk197794eb6a12005-12-15 15:22:08 +00001409** Register a callback function with the database connection identified by the
1410** first argument to be invoked whenever a row is updated, inserted or deleted.
1411** Any callback set by a previous call to this function for the same
1412** database connection is overridden.
1413**
1414** The second argument is a pointer to the function to invoke when a
1415** row is updated, inserted or deleted. The first argument to the callback is
1416** a copy of the third argument to sqlite3_update_hook. The second callback
1417** argument is one of SQLITE_INSERT, SQLITE_DELETE or SQLITE_UPDATE, depending
1418** on the operation that caused the callback to be invoked. The third and
1419** fourth arguments to the callback contain pointers to the database and
1420** table name containing the affected row. The final callback parameter is
1421** the rowid of the row. In the case of an update, this is the rowid after
1422** the update takes place.
1423**
1424** The update hook is not invoked when internal system tables are
1425** modified (i.e. sqlite_master and sqlite_sequence).
danielk197771fd80b2005-12-16 06:54:01 +00001426**
1427** If another function was previously registered, its pArg value is returned.
1428** Otherwise NULL is returned.
danielk197794eb6a12005-12-15 15:22:08 +00001429*/
danielk197771fd80b2005-12-16 06:54:01 +00001430void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00001431 sqlite3*,
1432 void(*)(void *,int ,char const *,char const *,sqlite_int64),
1433 void*
1434);
danielk197713a68c32005-12-15 10:11:30 +00001435
danielk1977f3f06bb2005-12-16 15:24:28 +00001436/*
1437** Register a callback to be invoked whenever a transaction is rolled
1438** back.
1439**
1440** The new callback function overrides any existing rollback-hook
1441** callback. If there was an existing callback, then it's pArg value
1442** (the third argument to sqlite3_rollback_hook() when it was registered)
1443** is returned. Otherwise, NULL is returned.
1444**
1445** For the purposes of this API, a transaction is said to have been
1446** rolled back if an explicit "ROLLBACK" statement is executed, or
1447** an error or constraint causes an implicit rollback to occur. The
1448** callback is not invoked if a transaction is automatically rolled
1449** back because the database connection is closed.
1450*/
danielk197771fd80b2005-12-16 06:54:01 +00001451void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);
1452
danielk19777ddad962005-12-12 06:53:03 +00001453/*
danielk1977aef0bf62005-12-30 16:28:01 +00001454** This function is only available if the library is compiled without
1455** the SQLITE_OMIT_SHARED_CACHE macro defined. It is used to enable or
1456** disable (if the argument is true or false, respectively) the
1457** "shared pager" feature.
1458*/
1459int sqlite3_enable_shared_cache(int);
1460
1461/*
danielk197752622822006-01-09 09:59:49 +00001462** Attempt to free N bytes of heap memory by deallocating non-essential
1463** memory allocations held by the database library (example: memory
1464** used to cache database pages to improve performance).
1465**
drh6f7adc82006-01-11 21:41:20 +00001466** This function is not a part of standard builds. It is only created
1467** if SQLite is compiled with the SQLITE_ENABLE_MEMORY_MANAGEMENT macro.
danielk197752622822006-01-09 09:59:49 +00001468*/
1469int sqlite3_release_memory(int);
1470
1471/*
1472** Place a "soft" limit on the amount of heap memory that may be allocated by
1473** SQLite within the current thread. If an internal allocation is requested
1474** that would exceed the specified limit, sqlite3_release_memory() is invoked
1475** one or more times to free up some space before the allocation is made.
1476**
1477** The limit is called "soft", because if sqlite3_release_memory() cannot free
1478** sufficient memory to prevent the limit from being exceeded, the memory is
1479** allocated anyway and the current operation proceeds.
1480**
drh6f7adc82006-01-11 21:41:20 +00001481** This function is only available if the library was compiled with the
1482** SQLITE_ENABLE_MEMORY_MANAGEMENT option set.
danielk197752622822006-01-09 09:59:49 +00001483** memory-management has been enabled.
1484*/
drhd2d4a6b2006-01-10 15:18:27 +00001485void sqlite3_soft_heap_limit(int);
danielk197752622822006-01-09 09:59:49 +00001486
1487/*
drh6f7adc82006-01-11 21:41:20 +00001488** This routine makes sure that all thread-local storage has been
1489** deallocated for the current thread.
1490**
1491** This routine is not technically necessary. All thread-local storage
1492** will be automatically deallocated once memory-management and
1493** shared-cache are disabled and the soft heap limit has been set
1494** to zero. This routine is provided as a convenience for users who
1495** want to make absolutely sure they have not forgotten something
1496** prior to killing off a thread.
1497*/
1498void sqlite3_thread_cleanup(void);
1499
1500/*
danielk1977deb802c2006-02-09 13:43:28 +00001501** Return meta information about a specific column of a specific database
1502** table accessible using the connection handle passed as the first function
1503** argument.
1504**
1505** The column is identified by the second, third and fourth parameters to
1506** this function. The second parameter is either the name of the database
1507** (i.e. "main", "temp" or an attached database) containing the specified
1508** table or NULL. If it is NULL, then all attached databases are searched
1509** for the table using the same algorithm as the database engine uses to
1510** resolve unqualified table references.
1511**
1512** The third and fourth parameters to this function are the table and column
1513** name of the desired column, respectively. Neither of these parameters
1514** may be NULL.
1515**
1516** Meta information is returned by writing to the memory locations passed as
1517** the 5th and subsequent parameters to this function. Any of these
1518** arguments may be NULL, in which case the corresponding element of meta
1519** information is ommitted.
1520**
1521** Parameter Output Type Description
1522** -----------------------------------
1523**
1524** 5th const char* Data type
1525** 6th const char* Name of the default collation sequence
1526** 7th int True if the column has a NOT NULL constraint
1527** 8th int True if the column is part of the PRIMARY KEY
1528** 9th int True if the column is AUTOINCREMENT
1529**
1530**
1531** The memory pointed to by the character pointers returned for the
1532** declaration type and collation sequence is valid only until the next
1533** call to any sqlite API function.
1534**
1535** If the specified table is actually a view, then an error is returned.
1536**
1537** If the specified column is "rowid", "oid" or "_rowid_" and an
1538** INTEGER PRIMARY KEY column has been explicitly declared, then the output
1539** parameters are set for the explicitly declared column. If there is no
1540** explicitly declared IPK column, then the output parameters are set as
1541** follows:
1542**
1543** data type: "INTEGER"
1544** collation sequence: "BINARY"
1545** not null: 0
1546** primary key: 1
1547** auto increment: 0
1548**
1549** This function may load one or more schemas from database files. If an
1550** error occurs during this process, or if the requested table or column
1551** cannot be found, an SQLITE error code is returned and an error message
1552** left in the database handle (to be retrieved using sqlite3_errmsg()).
danielk19774b1ae992006-02-10 03:06:10 +00001553**
1554** This API is only available if the library was compiled with the
1555** SQLITE_ENABLE_COLUMN_METADATA preprocessor symbol defined.
danielk1977deb802c2006-02-09 13:43:28 +00001556*/
1557int sqlite3_table_column_metadata(
1558 sqlite3 *db, /* Connection handle */
1559 const char *zDbName, /* Database name or NULL */
1560 const char *zTableName, /* Table name */
1561 const char *zColumnName, /* Column name */
1562 char const **pzDataType, /* OUTPUT: Declared data type */
1563 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
1564 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
1565 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
1566 int *pAutoinc /* OUTPUT: True if colums is auto-increment */
1567);
1568
1569/*
drh1e397f82006-06-08 15:28:43 +00001570****** EXPERIMENTAL - subject to change without notice **************
1571**
1572** Attempt to load an SQLite extension library contained in the file
1573** zFile. The entry point is zProc. zProc may be 0 in which case the
drhc2e87a32006-06-27 15:16:14 +00001574** name of the entry point defaults to "sqlite3_extension_init".
drh1e397f82006-06-08 15:28:43 +00001575**
1576** Return SQLITE_OK on success and SQLITE_ERROR if something goes wrong.
1577**
1578** If an error occurs and pzErrMsg is not 0, then fill *pzErrMsg with
1579** error message text. The calling function should free this memory
1580** by calling sqlite3_free().
1581**
drhc2e87a32006-06-27 15:16:14 +00001582** Extension loading must be enabled using sqlite3_enable_load_extension()
1583** prior to calling this API or an error will be returned.
drh1e397f82006-06-08 15:28:43 +00001584**
1585****** EXPERIMENTAL - subject to change without notice **************
1586*/
1587int sqlite3_load_extension(
1588 sqlite3 *db, /* Load the extension into this database connection */
1589 const char *zFile, /* Name of the shared library containing extension */
1590 const char *zProc, /* Entry point. Derived from zFile if 0 */
1591 char **pzErrMsg /* Put error message here if not 0 */
1592);
1593
1594/*
drhc2e87a32006-06-27 15:16:14 +00001595** So as not to open security holes in older applications that are
1596** unprepared to deal with extension load, and as a means of disabling
1597** extension loading while executing user-entered SQL, the following
1598** API is provided to turn the extension loading mechanism on and
1599** off. It is off by default. See ticket #1863.
1600**
1601** Call this routine with onoff==1 to turn extension loading on
1602** and call it with onoff==0 to turn it back off again.
1603*/
1604int sqlite3_enable_load_extension(sqlite3 *db, int onoff);
1605
1606/*
drhe09daa92006-06-10 13:29:31 +00001607****** EXPERIMENTAL - subject to change without notice **************
drh9eff6162006-06-12 21:59:13 +00001608**
drh1409be62006-08-23 20:07:20 +00001609** Register an extension entry point that is automatically invoked
1610** whenever a new database connection is opened.
1611**
1612** This API can be invoked at program startup in order to register
1613** one or more statically linked extensions that will be available
1614** to all new database connections.
1615**
1616** Duplicate extensions are detected so calling this routine multiple
1617** times with the same extension is harmless.
1618**
1619** This routine stores a pointer to the extension in an array
1620** that is obtained from malloc(). If you run a memory leak
1621** checker on your program and it reports a leak because of this
1622** array, then invoke sqlite3_automatic_extension_reset() prior
1623** to shutdown to free the memory.
1624**
1625** Automatic extensions apply across all threads.
1626*/
1627int sqlite3_auto_extension(void *xEntryPoint);
1628
1629
1630/*
1631****** EXPERIMENTAL - subject to change without notice **************
1632**
1633** Disable all previously registered automatic extensions. This
1634** routine undoes the effect of all prior sqlite3_automatic_extension()
1635** calls.
1636**
1637** This call disabled automatic extensions in all threads.
1638*/
1639void sqlite3_reset_auto_extension(void);
1640
1641
1642/*
1643****** EXPERIMENTAL - subject to change without notice **************
1644**
drh9eff6162006-06-12 21:59:13 +00001645** The interface to the virtual-table mechanism is currently considered
1646** to be experimental. The interface might change in incompatible ways.
1647** If this is a problem for you, do not use the interface at this time.
1648**
1649** When the virtual-table mechanism stablizes, we will declare the
1650** interface fixed, support it indefinitely, and remove this comment.
1651*/
1652
1653/*
1654** Structures used by the virtual table interface
drhe09daa92006-06-10 13:29:31 +00001655*/
1656typedef struct sqlite3_vtab sqlite3_vtab;
1657typedef struct sqlite3_index_info sqlite3_index_info;
1658typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor;
1659typedef struct sqlite3_module sqlite3_module;
drh9eff6162006-06-12 21:59:13 +00001660
1661/*
1662** A module is a class of virtual tables. Each module is defined
1663** by an instance of the following structure. This structure consists
1664** mostly of methods for the module.
1665*/
drhe09daa92006-06-10 13:29:31 +00001666struct sqlite3_module {
1667 int iVersion;
danielk19779da9d472006-06-14 06:58:15 +00001668 int (*xCreate)(sqlite3*, void *pAux,
drhe4102962006-09-11 00:34:22 +00001669 int argc, const char *const*argv,
drh4ca8aac2006-09-10 17:31:58 +00001670 sqlite3_vtab **ppVTab, char**);
danielk19779da9d472006-06-14 06:58:15 +00001671 int (*xConnect)(sqlite3*, void *pAux,
drhe4102962006-09-11 00:34:22 +00001672 int argc, const char *const*argv,
drh4ca8aac2006-09-10 17:31:58 +00001673 sqlite3_vtab **ppVTab, char**);
drhe09daa92006-06-10 13:29:31 +00001674 int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*);
1675 int (*xDisconnect)(sqlite3_vtab *pVTab);
1676 int (*xDestroy)(sqlite3_vtab *pVTab);
1677 int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor);
1678 int (*xClose)(sqlite3_vtab_cursor*);
drh4be8b512006-06-13 23:51:34 +00001679 int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr,
drhe09daa92006-06-10 13:29:31 +00001680 int argc, sqlite3_value **argv);
1681 int (*xNext)(sqlite3_vtab_cursor*);
danielk1977a298e902006-06-22 09:53:48 +00001682 int (*xEof)(sqlite3_vtab_cursor*);
drhe09daa92006-06-10 13:29:31 +00001683 int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int);
1684 int (*xRowid)(sqlite3_vtab_cursor*, sqlite_int64 *pRowid);
danielk19771f6eec52006-06-16 06:17:47 +00001685 int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite_int64 *);
drhe09daa92006-06-10 13:29:31 +00001686 int (*xBegin)(sqlite3_vtab *pVTab);
1687 int (*xSync)(sqlite3_vtab *pVTab);
1688 int (*xCommit)(sqlite3_vtab *pVTab);
1689 int (*xRollback)(sqlite3_vtab *pVTab);
drhb7f6f682006-07-08 17:06:43 +00001690 int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName,
drhe94b0c32006-07-08 18:09:15 +00001691 void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),
1692 void **ppArg);
drhe09daa92006-06-10 13:29:31 +00001693};
drh9eff6162006-06-12 21:59:13 +00001694
1695/*
1696** The sqlite3_index_info structure and its substructures is used to
1697** pass information into and receive the reply from the xBestIndex
1698** method of an sqlite3_module. The fields under **Inputs** are the
1699** inputs to xBestIndex and are read-only. xBestIndex inserts its
1700** results into the **Outputs** fields.
1701**
1702** The aConstraint[] array records WHERE clause constraints of the
1703** form:
1704**
1705** column OP expr
1706**
1707** Where OP is =, <, <=, >, or >=. The particular operator is stored
1708** in aConstraint[].op. The index of the column is stored in
1709** aConstraint[].iColumn. aConstraint[].usable is TRUE if the
1710** expr on the right-hand side can be evaluated (and thus the constraint
1711** is usable) and false if it cannot.
1712**
1713** The optimizer automatically inverts terms of the form "expr OP column"
1714** and makes other simplificatinos to the WHERE clause in an attempt to
1715** get as many WHERE clause terms into the form shown above as possible.
1716** The aConstraint[] array only reports WHERE clause terms in the correct
1717** form that refer to the particular virtual table being queried.
1718**
1719** Information about the ORDER BY clause is stored in aOrderBy[].
1720** Each term of aOrderBy records a column of the ORDER BY clause.
1721**
1722** The xBestIndex method must fill aConstraintUsage[] with information
danielk19775fac9f82006-06-13 14:16:58 +00001723** about what parameters to pass to xFilter. If argvIndex>0 then
drh9eff6162006-06-12 21:59:13 +00001724** the right-hand side of the corresponding aConstraint[] is evaluated
1725** and becomes the argvIndex-th entry in argv. If aConstraintUsage[].omit
1726** is true, then the constraint is assumed to be fully handled by the
1727** virtual table and is not checked again by SQLite.
1728**
drh4be8b512006-06-13 23:51:34 +00001729** The idxNum and idxPtr values are recorded and passed into xFilter.
1730** sqlite3_free() is used to free idxPtr if needToFreeIdxPtr is true.
drh9eff6162006-06-12 21:59:13 +00001731**
1732** The orderByConsumed means that output from xFilter will occur in
1733** the correct order to satisfy the ORDER BY clause so that no separate
1734** sorting step is required.
1735**
1736** The estimatedCost value is an estimate of the cost of doing the
1737** particular lookup. A full scan of a table with N entries should have
1738** a cost of N. A binary search of a table of N entries should have a
1739** cost of approximately log(N).
1740*/
drhe09daa92006-06-10 13:29:31 +00001741struct sqlite3_index_info {
1742 /* Inputs */
drh9eff6162006-06-12 21:59:13 +00001743 const int nConstraint; /* Number of entries in aConstraint */
1744 const struct sqlite3_index_constraint {
1745 int iColumn; /* Column on left-hand side of constraint */
1746 unsigned char op; /* Constraint operator */
1747 unsigned char usable; /* True if this constraint is usable */
1748 int iTermOffset; /* Used internally - xBestIndex should ignore */
1749 } *const aConstraint; /* Table of WHERE clause constraints */
1750 const int nOrderBy; /* Number of terms in the ORDER BY clause */
1751 const struct sqlite3_index_orderby {
1752 int iColumn; /* Column number */
1753 unsigned char desc; /* True for DESC. False for ASC. */
1754 } *const aOrderBy; /* The ORDER BY clause */
drhe09daa92006-06-10 13:29:31 +00001755
1756 /* Outputs */
drh9eff6162006-06-12 21:59:13 +00001757 struct sqlite3_index_constraint_usage {
1758 int argvIndex; /* if >0, constraint is part of argv to xFilter */
1759 unsigned char omit; /* Do not code a test for this constraint */
1760 } *const aConstraintUsage;
drh4be8b512006-06-13 23:51:34 +00001761 int idxNum; /* Number used to identify the index */
1762 char *idxStr; /* String, possibly obtained from sqlite3_malloc */
1763 int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */
drh9eff6162006-06-12 21:59:13 +00001764 int orderByConsumed; /* True if output is already ordered */
1765 double estimatedCost; /* Estimated cost of using this index */
drhe09daa92006-06-10 13:29:31 +00001766};
drh9eff6162006-06-12 21:59:13 +00001767#define SQLITE_INDEX_CONSTRAINT_EQ 2
1768#define SQLITE_INDEX_CONSTRAINT_GT 4
1769#define SQLITE_INDEX_CONSTRAINT_LE 8
1770#define SQLITE_INDEX_CONSTRAINT_LT 16
1771#define SQLITE_INDEX_CONSTRAINT_GE 32
1772#define SQLITE_INDEX_CONSTRAINT_MATCH 64
1773
1774/*
1775** This routine is used to register a new module name with an SQLite
1776** connection. Module names must be registered before creating new
1777** virtual tables on the module, or before using preexisting virtual
1778** tables of the module.
1779*/
drhb9bb7c12006-06-11 23:41:55 +00001780int sqlite3_create_module(
drh9eff6162006-06-12 21:59:13 +00001781 sqlite3 *db, /* SQLite connection to register module with */
1782 const char *zName, /* Name of the module */
danielk1977d1ab1ba2006-06-15 04:28:13 +00001783 const sqlite3_module *, /* Methods for the module */
1784 void * /* Client data for xCreate/xConnect */
drhb9bb7c12006-06-11 23:41:55 +00001785);
drhe09daa92006-06-10 13:29:31 +00001786
drh9eff6162006-06-12 21:59:13 +00001787/*
1788** Every module implementation uses a subclass of the following structure
1789** to describe a particular instance of the module. Each subclass will
1790** be taylored to the specific needs of the module implementation. The
1791** purpose of this superclass is to define certain fields that are common
1792** to all module implementations.
drhfe1368e2006-09-10 17:08:29 +00001793**
1794** Virtual tables methods can set an error message by assigning a
1795** string obtained from sqlite3_mprintf() to zErrMsg. The method should
1796** take care that any prior string is freed by a call to sqlite3_free()
1797** prior to assigning a new string to zErrMsg. After the error message
1798** is delivered up to the client application, the string will be automatically
1799** freed by sqlite3_free() and the zErrMsg field will be zeroed. Note
1800** that sqlite3_mprintf() and sqlite3_free() are used on the zErrMsg field
1801** since virtual tables are commonly implemented in loadable extensions which
1802** do not have access to sqlite3MPrintf() or sqlite3Free().
drh9eff6162006-06-12 21:59:13 +00001803*/
1804struct sqlite3_vtab {
drha967e882006-06-13 01:04:52 +00001805 const sqlite3_module *pModule; /* The module for this virtual table */
danielk1977be718892006-06-23 08:05:19 +00001806 int nRef; /* Used internally */
drh4ca8aac2006-09-10 17:31:58 +00001807 char *zErrMsg; /* Error message from sqlite3_mprintf() */
drh9eff6162006-06-12 21:59:13 +00001808 /* Virtual table implementations will typically add additional fields */
1809};
1810
1811/* Every module implementation uses a subclass of the following structure
1812** to describe cursors that point into the virtual table and are used
1813** to loop through the virtual table. Cursors are created using the
1814** xOpen method of the module. Each module implementation will define
1815** the content of a cursor structure to suit its own needs.
1816**
1817** This superclass exists in order to define fields of the cursor that
1818** are common to all implementations.
1819*/
1820struct sqlite3_vtab_cursor {
1821 sqlite3_vtab *pVtab; /* Virtual table of this cursor */
1822 /* Virtual table implementations will typically add additional fields */
1823};
1824
1825/*
1826** The xCreate and xConnect methods of a module use the following API
1827** to declare the format (the names and datatypes of the columns) of
1828** the virtual tables they implement.
1829*/
danielk19777e6ebfb2006-06-12 11:24:37 +00001830int sqlite3_declare_vtab(sqlite3*, const char *zCreateTable);
drhe09daa92006-06-10 13:29:31 +00001831
1832/*
drhb7481e72006-09-16 21:45:14 +00001833** Virtual tables can provide alternative implementations of functions
1834** using the xFindFunction method. But global versions of those functions
1835** must exist in order to be overloaded.
1836**
1837** This API makes sure a global version of a function with a particular
1838** name and number of parameters exists. If no such function exists
1839** before this API is called, a new function is created. The implementation
1840** of the new function always causes an exception to be thrown. So
1841** the new function is not good for anything by itself. Its only
1842** purpose is to be a place-holder function that can be overloaded
1843** by virtual tables.
1844**
1845** This API should be considered part of the virtual table interface,
1846** which is experimental and subject to change.
1847*/
1848int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg);
1849
1850/*
drh9eff6162006-06-12 21:59:13 +00001851** The interface to the virtual-table mechanism defined above (back up
1852** to a comment remarkably similar to this one) is currently considered
1853** to be experimental. The interface might change in incompatible ways.
1854** If this is a problem for you, do not use the interface at this time.
1855**
1856** When the virtual-table mechanism stablizes, we will declare the
1857** interface fixed, support it indefinitely, and remove this comment.
1858**
1859****** EXPERIMENTAL - subject to change without notice **************
1860*/
1861
1862/*
drhb37df7b2005-10-13 02:09:49 +00001863** Undo the hack that converts floating point types to integer for
1864** builds on processors without floating point support.
1865*/
1866#ifdef SQLITE_OMIT_FLOATING_POINT
1867# undef double
1868#endif
1869
drh382c0242001-10-06 16:33:02 +00001870#ifdef __cplusplus
1871} /* End of the 'extern "C"' block */
1872#endif
danielk19774adee202004-05-08 08:23:19 +00001873#endif