blob: 3f18f88e93cdf1a37aa80a1a42d37edf5641326e [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**
drh2db0bbc2005-08-11 02:10:18 +000015** @(#) $Id: sqlite.h.in,v 1.139 2005/08/11 02:10:19 drh 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*/
81#if defined(_MSC_VER) || defined(__BORLANDC__)
82 typedef __int64 sqlite_int64;
drh1211de32004-07-26 12:24:22 +000083 typedef unsigned __int64 sqlite_uint64;
drhefad9992004-06-22 12:13:55 +000084#else
85 typedef long long int sqlite_int64;
drh1211de32004-07-26 12:24:22 +000086 typedef unsigned long long int sqlite_uint64;
drhefad9992004-06-22 12:13:55 +000087#endif
88
89
90/*
drh75897232000-05-29 14:26:00 +000091** A function to close the database.
92**
93** Call this function with a pointer to a structure that was previously
danielk19776f8a5032004-05-10 10:34:51 +000094** returned from sqlite3_open() and the corresponding database will by closed.
danielk197796d81f92004-06-19 03:33:57 +000095**
96** All SQL statements prepared using sqlite3_prepare() or
97** sqlite3_prepare16() must be deallocated using sqlite3_finalize() before
98** this routine is called. Otherwise, SQLITE_BUSY is returned and the
99** database connection remains open.
drh75897232000-05-29 14:26:00 +0000100*/
danielk1977f9d64d22004-06-19 08:18:07 +0000101int sqlite3_close(sqlite3 *);
drh75897232000-05-29 14:26:00 +0000102
103/*
104** The type for a callback function.
105*/
drh12057d52004-09-06 17:34:12 +0000106typedef int (*sqlite3_callback)(void*,int,char**, char**);
drh75897232000-05-29 14:26:00 +0000107
108/*
109** A function to executes one or more statements of SQL.
110**
111** If one or more of the SQL statements are queries, then
112** the callback function specified by the 3rd parameter is
113** invoked once for each row of the query result. This callback
114** should normally return 0. If the callback returns a non-zero
115** value then the query is aborted, all subsequent SQL statements
danielk19776f8a5032004-05-10 10:34:51 +0000116** are skipped and the sqlite3_exec() function returns the SQLITE_ABORT.
drh75897232000-05-29 14:26:00 +0000117**
118** The 4th parameter is an arbitrary pointer that is passed
119** to the callback function as its first parameter.
120**
121** The 2nd parameter to the callback function is the number of
drhb19a2bc2001-09-16 00:13:26 +0000122** columns in the query result. The 3rd parameter to the callback
123** is an array of strings holding the values for each column.
124** The 4th parameter to the callback is an array of strings holding
125** the names of each column.
drh75897232000-05-29 14:26:00 +0000126**
127** The callback function may be NULL, even for queries. A NULL
128** callback is not an error. It just means that no callback
129** will be invoked.
130**
131** If an error occurs while parsing or evaluating the SQL (but
132** not while executing the callback) then an appropriate error
133** message is written into memory obtained from malloc() and
drhb19a2bc2001-09-16 00:13:26 +0000134** *errmsg is made to point to that message. The calling function
135** is responsible for freeing the memory that holds the error
drh3f4fedb2004-05-31 19:34:33 +0000136** message. Use sqlite3_free() for this. If errmsg==NULL,
drhb86ccfb2003-01-28 23:13:10 +0000137** then no error message is ever written.
drhb19a2bc2001-09-16 00:13:26 +0000138**
139** The return value is is SQLITE_OK if there are no errors and
140** some other return code if there is an error. The particular
141** return value depends on the type of error.
drh58b95762000-06-02 01:17:37 +0000142**
143** If the query could not be executed because a database file is
drh2dfbbca2000-07-28 14:32:48 +0000144** locked or busy, then this function returns SQLITE_BUSY. (This
danielk19776f8a5032004-05-10 10:34:51 +0000145** behavior can be modified somewhat using the sqlite3_busy_handler()
146** and sqlite3_busy_timeout() functions below.)
drh75897232000-05-29 14:26:00 +0000147*/
danielk19776f8a5032004-05-10 10:34:51 +0000148int sqlite3_exec(
drh12057d52004-09-06 17:34:12 +0000149 sqlite3*, /* An open database */
drh9f71c2e2001-11-03 23:57:09 +0000150 const char *sql, /* SQL to be executed */
drh12057d52004-09-06 17:34:12 +0000151 sqlite3_callback, /* Callback function */
drh75897232000-05-29 14:26:00 +0000152 void *, /* 1st argument to callback function */
153 char **errmsg /* Error msg written here */
154);
155
drh58b95762000-06-02 01:17:37 +0000156/*
danielk19776f8a5032004-05-10 10:34:51 +0000157** Return values for sqlite3_exec() and sqlite3_step()
drh58b95762000-06-02 01:17:37 +0000158*/
drh717e6402001-09-27 03:22:32 +0000159#define SQLITE_OK 0 /* Successful result */
160#define SQLITE_ERROR 1 /* SQL error or missing database */
drh2db0bbc2005-08-11 02:10:18 +0000161#define SQLITE_INTERNAL 2 /* NOT USED. Internal logic error in SQLite */
drh717e6402001-09-27 03:22:32 +0000162#define SQLITE_PERM 3 /* Access permission denied */
163#define SQLITE_ABORT 4 /* Callback routine requested an abort */
164#define SQLITE_BUSY 5 /* The database file is locked */
165#define SQLITE_LOCKED 6 /* A table in the database is locked */
166#define SQLITE_NOMEM 7 /* A malloc() failed */
167#define SQLITE_READONLY 8 /* Attempt to write a readonly database */
drh24cd67e2004-05-10 16:18:47 +0000168#define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/
drh717e6402001-09-27 03:22:32 +0000169#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */
170#define SQLITE_CORRUPT 11 /* The database disk image is malformed */
drh2db0bbc2005-08-11 02:10:18 +0000171#define SQLITE_NOTFOUND 12 /* NOT USED. Table or record not found */
drh717e6402001-09-27 03:22:32 +0000172#define SQLITE_FULL 13 /* Insertion failed because database is full */
173#define SQLITE_CANTOPEN 14 /* Unable to open the database file */
174#define SQLITE_PROTOCOL 15 /* Database lock protocol error */
drh24cd67e2004-05-10 16:18:47 +0000175#define SQLITE_EMPTY 16 /* Database is empty */
drh717e6402001-09-27 03:22:32 +0000176#define SQLITE_SCHEMA 17 /* The database schema changed */
drh2db0bbc2005-08-11 02:10:18 +0000177#define SQLITE_TOOBIG 18 /* NOT USED. Too much data for one row */
drh717e6402001-09-27 03:22:32 +0000178#define SQLITE_CONSTRAINT 19 /* Abort due to contraint violation */
drh8aff1012001-12-22 14:49:24 +0000179#define SQLITE_MISMATCH 20 /* Data type mismatch */
drh247be432002-05-10 05:44:55 +0000180#define SQLITE_MISUSE 21 /* Library used incorrectly */
drh8766c342002-11-09 00:33:15 +0000181#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */
drhed6c8672003-01-12 18:02:16 +0000182#define SQLITE_AUTH 23 /* Authorization denied */
drh1c2d8412003-03-31 00:30:47 +0000183#define SQLITE_FORMAT 24 /* Auxiliary database format error */
danielk19776f8a5032004-05-10 10:34:51 +0000184#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */
drhc602f9a2004-02-12 19:01:04 +0000185#define SQLITE_NOTADB 26 /* File opened that is not a database file */
danielk19776f8a5032004-05-10 10:34:51 +0000186#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */
187#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */
drh717e6402001-09-27 03:22:32 +0000188
drhaf9ff332002-01-16 21:00:27 +0000189/*
190** Each entry in an SQLite table has a unique integer key. (The key is
191** the value of the INTEGER PRIMARY KEY column if there is such a column,
192** otherwise the key is generated at random. The unique key is always
193** available as the ROWID, OID, or _ROWID_ column.) The following routine
194** returns the integer key of the most recent insert in the database.
195**
196** This function is similar to the mysql_insert_id() function from MySQL.
197*/
drhefad9992004-06-22 12:13:55 +0000198sqlite_int64 sqlite3_last_insert_rowid(sqlite3*);
drhaf9ff332002-01-16 21:00:27 +0000199
drhc8d30ac2002-04-12 10:08:59 +0000200/*
201** This function returns the number of database rows that were changed
danielk19776f8a5032004-05-10 10:34:51 +0000202** (or inserted or deleted) by the most recent called sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000203**
204** All changes are counted, even if they were later undone by a
205** ROLLBACK or ABORT. Except, changes associated with creating and
206** dropping tables are not counted.
207**
danielk19776f8a5032004-05-10 10:34:51 +0000208** If a callback invokes sqlite3_exec() recursively, then the changes
drhc8d30ac2002-04-12 10:08:59 +0000209** in the inner, recursive call are counted together with the changes
210** in the outer call.
211**
212** SQLite implements the command "DELETE FROM table" without a WHERE clause
213** by dropping and recreating the table. (This is much faster than going
214** through and deleting individual elements form the table.) Because of
215** this optimization, the change count for "DELETE FROM table" will be
216** zero regardless of the number of elements that were originally in the
217** table. To get an accurate count of the number of rows deleted, use
218** "DELETE FROM table WHERE 1" instead.
219*/
danielk1977f9d64d22004-06-19 08:18:07 +0000220int sqlite3_changes(sqlite3*);
drhc8d30ac2002-04-12 10:08:59 +0000221
rdcf146a772004-02-25 22:51:06 +0000222/*
danielk1977b28af712004-06-21 06:50:26 +0000223** This function returns the number of database rows that have been
224** modified by INSERT, UPDATE or DELETE statements since the database handle
225** was opened. This includes UPDATE, INSERT and DELETE statements executed
226** as part of trigger programs. All changes are counted as soon as the
227** statement that makes them is completed (when the statement handle is
228** passed to sqlite3_reset() or sqlite_finalise()).
rdcf146a772004-02-25 22:51:06 +0000229**
230** SQLite implements the command "DELETE FROM table" without a WHERE clause
231** by dropping and recreating the table. (This is much faster than going
232** through and deleting individual elements form the table.) Because of
233** this optimization, the change count for "DELETE FROM table" will be
234** zero regardless of the number of elements that were originally in the
235** table. To get an accurate count of the number of rows deleted, use
236** "DELETE FROM table WHERE 1" instead.
rdcf146a772004-02-25 22:51:06 +0000237*/
danielk1977b28af712004-06-21 06:50:26 +0000238int sqlite3_total_changes(sqlite3*);
239
drh4c504392000-10-16 22:06:40 +0000240/* This function causes any pending database operation to abort and
241** return at its earliest opportunity. This routine is typically
drh66b89c82000-11-28 20:47:17 +0000242** called in response to a user action such as pressing "Cancel"
drh4c504392000-10-16 22:06:40 +0000243** or Ctrl-C where the user wants a long query operation to halt
244** immediately.
245*/
danielk1977f9d64d22004-06-19 08:18:07 +0000246void sqlite3_interrupt(sqlite3*);
drh4c504392000-10-16 22:06:40 +0000247
drheec553b2000-06-02 01:51:20 +0000248
danielk197761de0d12004-05-27 23:56:16 +0000249/* These functions return true if the given input string comprises
250** one or more complete SQL statements. For the sqlite3_complete() call,
251** the parameter must be a nul-terminated UTF-8 string. For
252** sqlite3_complete16(), a nul-terminated machine byte order UTF-16 string
253** is required.
drh75897232000-05-29 14:26:00 +0000254**
255** The algorithm is simple. If the last token other than spaces
256** and comments is a semicolon, then return true. otherwise return
257** false.
258*/
danielk19776f8a5032004-05-10 10:34:51 +0000259int sqlite3_complete(const char *sql);
danielk197761de0d12004-05-27 23:56:16 +0000260int sqlite3_complete16(const void *sql);
drh75897232000-05-29 14:26:00 +0000261
drh2dfbbca2000-07-28 14:32:48 +0000262/*
263** This routine identifies a callback function that is invoked
264** whenever an attempt is made to open a database table that is
265** currently locked by another process or thread. If the busy callback
danielk19776f8a5032004-05-10 10:34:51 +0000266** is NULL, then sqlite3_exec() returns SQLITE_BUSY immediately if
drh2dfbbca2000-07-28 14:32:48 +0000267** it finds a locked table. If the busy callback is not NULL, then
danielk19776f8a5032004-05-10 10:34:51 +0000268** sqlite3_exec() invokes the callback with three arguments. The
drh2dfbbca2000-07-28 14:32:48 +0000269** second argument is the name of the locked table and the third
270** argument is the number of times the table has been busy. If the
danielk19776f8a5032004-05-10 10:34:51 +0000271** busy callback returns 0, then sqlite3_exec() immediately returns
272** SQLITE_BUSY. If the callback returns non-zero, then sqlite3_exec()
drh2dfbbca2000-07-28 14:32:48 +0000273** tries to open the table again and the cycle repeats.
274**
275** The default busy callback is NULL.
276**
277** Sqlite is re-entrant, so the busy handler may start a new query.
278** (It is not clear why anyone would every want to do this, but it
279** is allowed, in theory.) But the busy handler may not close the
280** database. Closing the database from a busy handler will delete
281** data structures out from under the executing query and will
282** probably result in a coredump.
283*/
danielk1977f9d64d22004-06-19 08:18:07 +0000284int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*);
drh2dfbbca2000-07-28 14:32:48 +0000285
286/*
287** This routine sets a busy handler that sleeps for a while when a
288** table is locked. The handler will sleep multiple times until
289** at least "ms" milleseconds of sleeping have been done. After
290** "ms" milleseconds of sleeping, the handler returns 0 which
danielk19776f8a5032004-05-10 10:34:51 +0000291** causes sqlite3_exec() to return SQLITE_BUSY.
drh2dfbbca2000-07-28 14:32:48 +0000292**
293** Calling this routine with an argument less than or equal to zero
294** turns off all busy handlers.
295*/
danielk1977f9d64d22004-06-19 08:18:07 +0000296int sqlite3_busy_timeout(sqlite3*, int ms);
drh2dfbbca2000-07-28 14:32:48 +0000297
drhe3710332000-09-29 13:30:53 +0000298/*
danielk19776f8a5032004-05-10 10:34:51 +0000299** This next routine is really just a wrapper around sqlite3_exec().
drhe3710332000-09-29 13:30:53 +0000300** Instead of invoking a user-supplied callback for each row of the
301** result, this routine remembers each row of the result in memory
302** obtained from malloc(), then returns all of the result after the
drha18c5682000-10-08 22:20:57 +0000303** query has finished.
304**
305** As an example, suppose the query result where this table:
306**
307** Name | Age
308** -----------------------
309** Alice | 43
310** Bob | 28
311** Cindy | 21
312**
313** If the 3rd argument were &azResult then after the function returns
drh98699b52000-10-09 12:57:00 +0000314** azResult will contain the following data:
drha18c5682000-10-08 22:20:57 +0000315**
316** azResult[0] = "Name";
317** azResult[1] = "Age";
318** azResult[2] = "Alice";
319** azResult[3] = "43";
320** azResult[4] = "Bob";
321** azResult[5] = "28";
322** azResult[6] = "Cindy";
323** azResult[7] = "21";
324**
325** Notice that there is an extra row of data containing the column
326** headers. But the *nrow return value is still 3. *ncolumn is
327** set to 2. In general, the number of values inserted into azResult
328** will be ((*nrow) + 1)*(*ncolumn).
329**
330** After the calling function has finished using the result, it should
danielk19776f8a5032004-05-10 10:34:51 +0000331** pass the result data pointer to sqlite3_free_table() in order to
drha18c5682000-10-08 22:20:57 +0000332** release the memory that was malloc-ed. Because of the way the
333** malloc() happens, the calling function must not try to call
danielk197799b214d2005-02-02 01:13:38 +0000334** free() directly. Only sqlite3_free_table() is able to release
drha18c5682000-10-08 22:20:57 +0000335** the memory properly and safely.
drhe3710332000-09-29 13:30:53 +0000336**
danielk19776f8a5032004-05-10 10:34:51 +0000337** The return value of this routine is the same as from sqlite3_exec().
drhe3710332000-09-29 13:30:53 +0000338*/
danielk19776f8a5032004-05-10 10:34:51 +0000339int sqlite3_get_table(
danielk1977f9d64d22004-06-19 08:18:07 +0000340 sqlite3*, /* An open database */
drh9f71c2e2001-11-03 23:57:09 +0000341 const char *sql, /* SQL to be executed */
drhe3710332000-09-29 13:30:53 +0000342 char ***resultp, /* Result written to a char *[] that this points to */
343 int *nrow, /* Number of result rows written here */
344 int *ncolumn, /* Number of result columns written here */
345 char **errmsg /* Error msg written here */
346);
347
348/*
danielk19776f8a5032004-05-10 10:34:51 +0000349** Call this routine to free the memory that sqlite3_get_table() allocated.
drhe3710332000-09-29 13:30:53 +0000350*/
danielk19776f8a5032004-05-10 10:34:51 +0000351void sqlite3_free_table(char **result);
drhe3710332000-09-29 13:30:53 +0000352
drha18c5682000-10-08 22:20:57 +0000353/*
drh4f26d6c2004-05-26 23:25:30 +0000354** The following routines are variants of the "sprintf()" from the
355** standard C library. The resulting string is written into memory
356** obtained from malloc() so that there is never a possiblity of buffer
357** overflow. These routines also implement some additional formatting
358** options that are useful for constructing SQL statements.
359**
360** The strings returned by these routines should be freed by calling
361** sqlite3_free().
drha18c5682000-10-08 22:20:57 +0000362**
363** All of the usual printf formatting options apply. In addition, there
364** is a "%q" option. %q works like %s in that it substitutes a null-terminated
drh66b89c82000-11-28 20:47:17 +0000365** string from the argument list. But %q also doubles every '\'' character.
drha18c5682000-10-08 22:20:57 +0000366** %q is designed for use inside a string literal. By doubling each '\''
drh66b89c82000-11-28 20:47:17 +0000367** character it escapes that character and allows it to be inserted into
drha18c5682000-10-08 22:20:57 +0000368** the string.
369**
370** For example, so some string variable contains text as follows:
371**
372** char *zText = "It's a happy day!";
373**
374** We can use this text in an SQL statement as follows:
375**
danielk19776f8a5032004-05-10 10:34:51 +0000376** sqlite3_exec_printf(db, "INSERT INTO table VALUES('%q')",
drha18c5682000-10-08 22:20:57 +0000377** callback1, 0, 0, zText);
378**
379** Because the %q format string is used, the '\'' character in zText
380** is escaped and the SQL generated is as follows:
381**
382** INSERT INTO table1 VALUES('It''s a happy day!')
383**
384** This is correct. Had we used %s instead of %q, the generated SQL
385** would have looked like this:
386**
387** INSERT INTO table1 VALUES('It's a happy day!');
388**
389** This second example is an SQL syntax error. As a general rule you
390** should always use %q instead of %s when inserting text into a string
391** literal.
392*/
danielk19776f8a5032004-05-10 10:34:51 +0000393char *sqlite3_mprintf(const char*,...);
394char *sqlite3_vmprintf(const char*, va_list);
drh4f26d6c2004-05-26 23:25:30 +0000395void sqlite3_free(char *z);
drhfeac5f82004-08-01 00:10:45 +0000396char *sqlite3_snprintf(int,char*,const char*, ...);
drh5191b7e2002-03-08 02:12:00 +0000397
drh1211de32004-07-26 12:24:22 +0000398#ifndef SQLITE_OMIT_AUTHORIZATION
drh5191b7e2002-03-08 02:12:00 +0000399/*
drhed6c8672003-01-12 18:02:16 +0000400** This routine registers a callback with the SQLite library. The
drhb86ccfb2003-01-28 23:13:10 +0000401** callback is invoked (at compile-time, not at run-time) for each
402** attempt to access a column of a table in the database. The callback
403** returns SQLITE_OK if access is allowed, SQLITE_DENY if the entire
404** SQL statement should be aborted with an error and SQLITE_IGNORE
405** if the column should be treated as a NULL value.
drhed6c8672003-01-12 18:02:16 +0000406*/
danielk19776f8a5032004-05-10 10:34:51 +0000407int sqlite3_set_authorizer(
danielk1977f9d64d22004-06-19 08:18:07 +0000408 sqlite3*,
drhe22a3342003-04-22 20:30:37 +0000409 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
drhe5f9c642003-01-13 23:27:31 +0000410 void *pUserData
drhed6c8672003-01-12 18:02:16 +0000411);
drh1211de32004-07-26 12:24:22 +0000412#endif
drhed6c8672003-01-12 18:02:16 +0000413
414/*
415** The second parameter to the access authorization function above will
drhe5f9c642003-01-13 23:27:31 +0000416** be one of the values below. These values signify what kind of operation
417** is to be authorized. The 3rd and 4th parameters to the authorization
418** function will be parameters or NULL depending on which of the following
drhe22a3342003-04-22 20:30:37 +0000419** codes is used as the second parameter. The 5th parameter is the name
420** of the database ("main", "temp", etc.) if applicable. The 6th parameter
drh5cf590c2003-04-24 01:45:04 +0000421** is the name of the inner-most trigger or view that is responsible for
422** the access attempt or NULL if this access attempt is directly from
423** input SQL code.
drhe5f9c642003-01-13 23:27:31 +0000424**
425** Arg-3 Arg-4
drhed6c8672003-01-12 18:02:16 +0000426*/
drh77ad4e42003-01-14 02:49:27 +0000427#define SQLITE_COPY 0 /* Table Name File Name */
drhe5f9c642003-01-13 23:27:31 +0000428#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */
429#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */
430#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */
431#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000432#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000433#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000434#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000435#define SQLITE_CREATE_VIEW 8 /* View Name NULL */
436#define SQLITE_DELETE 9 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000437#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000438#define SQLITE_DROP_TABLE 11 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000439#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000440#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000441#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000442#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000443#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000444#define SQLITE_DROP_VIEW 17 /* View Name NULL */
445#define SQLITE_INSERT 18 /* Table Name NULL */
446#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */
447#define SQLITE_READ 20 /* Table Name Column Name */
448#define SQLITE_SELECT 21 /* NULL NULL */
449#define SQLITE_TRANSACTION 22 /* NULL NULL */
450#define SQLITE_UPDATE 23 /* Table Name Column Name */
drh81e293b2003-06-06 19:00:42 +0000451#define SQLITE_ATTACH 24 /* Filename NULL */
452#define SQLITE_DETACH 25 /* Database Name NULL */
danielk19771c8c23c2004-11-12 15:53:37 +0000453#define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */
danielk19771d54df82004-11-23 15:41:16 +0000454#define SQLITE_REINDEX 27 /* Index Name NULL */
drhe6e04962005-07-23 02:17:03 +0000455#define SQLITE_ANALYZE 28 /* Table Name NULL */
drh81e293b2003-06-06 19:00:42 +0000456
drhed6c8672003-01-12 18:02:16 +0000457
458/*
459** The return value of the authorization function should be one of the
460** following constants:
461*/
462/* #define SQLITE_OK 0 // Allow access (This is actually defined above) */
463#define SQLITE_DENY 1 /* Abort the SQL statement with an error */
464#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
465
466/*
danielk19776f8a5032004-05-10 10:34:51 +0000467** Register a function that is called at every invocation of sqlite3_exec()
danielk19774ad17132004-05-21 01:47:26 +0000468** or sqlite3_prepare(). This function can be used (for example) to generate
drhb86ccfb2003-01-28 23:13:10 +0000469** a log file of all SQL executed against a database.
drh18de4822003-01-16 16:28:53 +0000470*/
danielk1977f9d64d22004-06-19 08:18:07 +0000471void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*);
drh18de4822003-01-16 16:28:53 +0000472
danielk1977348bb5d2003-10-18 09:37:26 +0000473/*
474** This routine configures a callback function - the progress callback - that
danielk19776f8a5032004-05-10 10:34:51 +0000475** is invoked periodically during long running calls to sqlite3_exec(),
danielk19772097e942004-11-20 06:05:56 +0000476** sqlite3_step() and sqlite3_get_table(). An example use for this API is to
477** keep a GUI updated during a large query.
danielk1977348bb5d2003-10-18 09:37:26 +0000478**
479** The progress callback is invoked once for every N virtual machine opcodes,
480** where N is the second argument to this function. The progress callback
481** itself is identified by the third argument to this function. The fourth
482** argument to this function is a void pointer passed to the progress callback
483** function each time it is invoked.
484**
danielk19776f8a5032004-05-10 10:34:51 +0000485** If a call to sqlite3_exec(), sqlite3_step() or sqlite3_get_table() results
danielk1977348bb5d2003-10-18 09:37:26 +0000486** in less than N opcodes being executed, then the progress callback is not
487** invoked.
488**
danielk1977348bb5d2003-10-18 09:37:26 +0000489** To remove the progress callback altogether, pass NULL as the third
490** argument to this function.
491**
492** If the progress callback returns a result other than 0, then the current
493** query is immediately terminated and any database changes rolled back. If the
494** query was part of a larger transaction, then the transaction is not rolled
danielk19776f8a5032004-05-10 10:34:51 +0000495** back and remains active. The sqlite3_exec() call returns SQLITE_ABORT.
drhaa940ea2004-01-15 02:44:03 +0000496**
497******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
danielk1977348bb5d2003-10-18 09:37:26 +0000498*/
danielk1977f9d64d22004-06-19 08:18:07 +0000499void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
danielk1977348bb5d2003-10-18 09:37:26 +0000500
drhaa940ea2004-01-15 02:44:03 +0000501/*
502** Register a callback function to be invoked whenever a new transaction
503** is committed. The pArg argument is passed through to the callback.
504** callback. If the callback function returns non-zero, then the commit
505** is converted into a rollback.
506**
507** If another function was previously registered, its pArg value is returned.
508** Otherwise NULL is returned.
509**
510** Registering a NULL function disables the callback.
511**
512******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
513*/
danielk1977f9d64d22004-06-19 08:18:07 +0000514void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
drhaa940ea2004-01-15 02:44:03 +0000515
drh22fbcb82004-02-01 01:22:50 +0000516/*
drh4f26d6c2004-05-26 23:25:30 +0000517** Open the sqlite database file "filename". The "filename" is UTF-8
518** encoded for sqlite3_open() and UTF-16 encoded in the native byte order
519** for sqlite3_open16(). An sqlite3* handle is returned in *ppDb, even
520** if an error occurs. If the database is opened (or created) successfully,
521** then SQLITE_OK is returned. Otherwise an error code is returned. The
522** sqlite3_errmsg() or sqlite3_errmsg16() routines can be used to obtain
523** an English language description of the error.
drh22fbcb82004-02-01 01:22:50 +0000524**
drh4f26d6c2004-05-26 23:25:30 +0000525** If the database file does not exist, then a new database is created.
526** The encoding for the database is UTF-8 if sqlite3_open() is called and
527** UTF-16 if sqlite3_open16 is used.
danielk197765904932004-05-26 06:18:37 +0000528**
529** Whether or not an error occurs when it is opened, resources associated
530** with the sqlite3* handle should be released by passing it to
531** sqlite3_close() when it is no longer required.
532*/
533int sqlite3_open(
534 const char *filename, /* Database filename (UTF-8) */
danielk19774f057f92004-06-08 00:02:33 +0000535 sqlite3 **ppDb /* OUT: SQLite db handle */
danielk197765904932004-05-26 06:18:37 +0000536);
danielk197765904932004-05-26 06:18:37 +0000537int sqlite3_open16(
538 const void *filename, /* Database filename (UTF-16) */
danielk19774f057f92004-06-08 00:02:33 +0000539 sqlite3 **ppDb /* OUT: SQLite db handle */
danielk197765904932004-05-26 06:18:37 +0000540);
danielk1977295ba552004-05-19 10:34:51 +0000541
danielk197765904932004-05-26 06:18:37 +0000542/*
543** Return the error code for the most recent sqlite3_* API call associated
544** with sqlite3 handle 'db'. SQLITE_OK is returned if the most recent
545** API call was successful.
546**
547** Calls to many sqlite3_* functions set the error code and string returned
548** by sqlite3_errcode(), sqlite3_errmsg() and sqlite3_errmsg16()
549** (overwriting the previous values). Note that calls to sqlite3_errcode(),
550** sqlite3_errmsg() and sqlite3_errmsg16() themselves do not affect the
551** results of future invocations.
552**
553** Assuming no other intervening sqlite3_* API calls are made, the error
554** code returned by this function is associated with the same error as
555** the strings returned by sqlite3_errmsg() and sqlite3_errmsg16().
556*/
557int sqlite3_errcode(sqlite3 *db);
558
559/*
560** Return a pointer to a UTF-8 encoded string describing in english the
561** error condition for the most recent sqlite3_* API call. The returned
562** string is always terminated by an 0x00 byte.
563**
564** The string "not an error" is returned when the most recent API call was
565** successful.
566*/
567const char *sqlite3_errmsg(sqlite3*);
568
569/*
570** Return a pointer to a UTF-16 native byte order encoded string describing
571** in english the error condition for the most recent sqlite3_* API call.
572** The returned string is always terminated by a pair of 0x00 bytes.
573**
574** The string "not an error" is returned when the most recent API call was
575** successful.
576*/
577const void *sqlite3_errmsg16(sqlite3*);
578
579/*
580** An instance of the following opaque structure is used to represent
581** a compiled SQL statment.
582*/
danielk1977fc57d7b2004-05-26 02:04:57 +0000583typedef struct sqlite3_stmt sqlite3_stmt;
584
danielk1977e3209e42004-05-20 01:40:18 +0000585/*
danielk197765904932004-05-26 06:18:37 +0000586** To execute an SQL query, it must first be compiled into a byte-code
587** program using one of the following routines. The only difference between
588** them is that the second argument, specifying the SQL statement to
589** compile, is assumed to be encoded in UTF-8 for the sqlite3_prepare()
590** function and UTF-16 for sqlite3_prepare16().
591**
592** The first parameter "db" is an SQLite database handle. The second
593** parameter "zSql" is the statement to be compiled, encoded as either
594** UTF-8 or UTF-16 (see above). If the next parameter, "nBytes", is less
595** than zero, then zSql is read up to the first nul terminator. If
596** "nBytes" is not less than zero, then it is the length of the string zSql
597** in bytes (not characters).
598**
599** *pzTail is made to point to the first byte past the end of the first
600** SQL statement in zSql. This routine only compiles the first statement
601** in zSql, so *pzTail is left pointing to what remains uncompiled.
602**
603** *ppStmt is left pointing to a compiled SQL statement that can be
604** executed using sqlite3_step(). Or if there is an error, *ppStmt may be
605** set to NULL. If the input text contained no SQL (if the input is and
606** empty string or a comment) then *ppStmt is set to NULL.
607**
608** On success, SQLITE_OK is returned. Otherwise an error code is returned.
609*/
610int sqlite3_prepare(
611 sqlite3 *db, /* Database handle */
612 const char *zSql, /* SQL statement, UTF-8 encoded */
613 int nBytes, /* Length of zSql in bytes. */
614 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
615 const char **pzTail /* OUT: Pointer to unused portion of zSql */
616);
617int sqlite3_prepare16(
618 sqlite3 *db, /* Database handle */
619 const void *zSql, /* SQL statement, UTF-16 encoded */
620 int nBytes, /* Length of zSql in bytes. */
621 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
622 const void **pzTail /* OUT: Pointer to unused portion of zSql */
623);
624
625/*
drhf4479502004-05-27 03:12:53 +0000626** Pointers to the following two opaque structures are used to communicate
627** with the implementations of user-defined functions.
628*/
629typedef struct sqlite3_context sqlite3_context;
630typedef struct Mem sqlite3_value;
631
632/*
drh4f26d6c2004-05-26 23:25:30 +0000633** In the SQL strings input to sqlite3_prepare() and sqlite3_prepare16(),
drh32c0d4f2004-12-07 02:14:51 +0000634** one or more literals can be replace by parameters "?" or ":AAA" or
635** "$VVV" where AAA is an identifer and VVV is a variable name according
636** to the syntax rules of the TCL programming language.
637** The value of these parameters (also called "host parameter names") can
638** be set using the routines listed below.
drh4f26d6c2004-05-26 23:25:30 +0000639**
640** In every case, the first parameter is a pointer to the sqlite3_stmt
641** structure returned from sqlite3_prepare(). The second parameter is the
drh32c0d4f2004-12-07 02:14:51 +0000642** index of the parameter. The first parameter as an index of 1. For
643** named parameters (":AAA" or "$VVV") you can use
644** sqlite3_bind_parameter_index() to get the correct index value given
645** the parameters name. If the same named parameter occurs more than
646** once, it is assigned the same index each time.
drh4f26d6c2004-05-26 23:25:30 +0000647**
drh900dfba2004-07-21 15:21:36 +0000648** The fifth parameter to sqlite3_bind_blob(), sqlite3_bind_text(), and
649** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or
650** text after SQLite has finished with it. If the fifth argument is the
651** special value SQLITE_STATIC, then the library assumes that the information
652** is in static, unmanaged space and does not need to be freed. If the
653** fifth argument has the value SQLITE_TRANSIENT, then SQLite makes its
654** own private copy of the data.
drh4f26d6c2004-05-26 23:25:30 +0000655**
656** The sqlite3_bind_* routine must be called before sqlite3_step() after
drh32c0d4f2004-12-07 02:14:51 +0000657** an sqlite3_prepare() or sqlite3_reset(). Unbound parameterss are
658** interpreted as NULL.
drh4f26d6c2004-05-26 23:25:30 +0000659*/
danielk1977d8123362004-06-12 09:25:12 +0000660int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*));
drhf4479502004-05-27 03:12:53 +0000661int sqlite3_bind_double(sqlite3_stmt*, int, double);
662int sqlite3_bind_int(sqlite3_stmt*, int, int);
drhefad9992004-06-22 12:13:55 +0000663int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite_int64);
drhf4479502004-05-27 03:12:53 +0000664int sqlite3_bind_null(sqlite3_stmt*, int);
danielk1977d8123362004-06-12 09:25:12 +0000665int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*));
666int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*));
drhf4479502004-05-27 03:12:53 +0000667int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);
drh4f26d6c2004-05-26 23:25:30 +0000668
669/*
drh32c0d4f2004-12-07 02:14:51 +0000670** Return the number of parameters in a compiled SQL statement. This
drh75f6a032004-07-15 14:15:00 +0000671** routine was added to support DBD::SQLite.
drh75f6a032004-07-15 14:15:00 +0000672*/
673int sqlite3_bind_parameter_count(sqlite3_stmt*);
674
675/*
drh32c0d4f2004-12-07 02:14:51 +0000676** Return the name of the i-th parameter. Ordinary parameters "?" are
677** nameless and a NULL is returned. For parameters of the form :AAA or
678** $VVV the complete text of the parameter name is returned, including
679** the initial ":" or "$". NULL is returned if the index is out of range.
drh895d7472004-08-20 16:02:39 +0000680*/
681const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int);
682
683/*
drhfa6bc002004-09-07 16:19:52 +0000684** Return the index of a parameter with the given name. The name
685** must match exactly. If no parameter with the given name is found,
686** return 0.
687*/
688int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName);
689
690/*
danielk1977600dd0b2005-01-20 01:14:23 +0000691** Set all the parameters in the compiled SQL statement to NULL.
danielk1977600dd0b2005-01-20 01:14:23 +0000692*/
693int sqlite3_clear_bindings(sqlite3_stmt*);
694
695/*
danielk197765904932004-05-26 06:18:37 +0000696** Return the number of columns in the result set returned by the compiled
697** SQL statement. This routine returns 0 if pStmt is an SQL statement
698** that does not return data (for example an UPDATE).
699*/
700int sqlite3_column_count(sqlite3_stmt *pStmt);
701
702/*
703** The first parameter is a compiled SQL statement. This function returns
704** the column heading for the Nth column of that statement, where N is the
drh4f26d6c2004-05-26 23:25:30 +0000705** second function parameter. The string returned is UTF-8 for
706** sqlite3_column_name() and UTF-16 for sqlite3_column_name16().
danielk197765904932004-05-26 06:18:37 +0000707*/
708const char *sqlite3_column_name(sqlite3_stmt*,int);
danielk197765904932004-05-26 06:18:37 +0000709const void *sqlite3_column_name16(sqlite3_stmt*,int);
710
711/*
712** The first parameter is a compiled SQL statement. If this statement
713** is a SELECT statement, the Nth column of the returned result set
714** of the SELECT is a table column then the declared type of the table
715** column is returned. If the Nth column of the result set is not at table
716** column, then a NULL pointer is returned. The returned string is always
717** UTF-8 encoded. For example, in the database schema:
718**
719** CREATE TABLE t1(c1 VARIANT);
720**
721** And the following statement compiled:
722**
723** SELECT c1 + 1, 0 FROM t1;
724**
725** Then this routine would return the string "VARIANT" for the second
726** result column (i==1), and a NULL pointer for the first result column
727** (i==0).
728*/
729const char *sqlite3_column_decltype(sqlite3_stmt *, int i);
730
731/*
732** The first parameter is a compiled SQL statement. If this statement
733** is a SELECT statement, the Nth column of the returned result set
734** of the SELECT is a table column then the declared type of the table
735** column is returned. If the Nth column of the result set is not at table
736** column, then a NULL pointer is returned. The returned string is always
737** UTF-16 encoded. For example, in the database schema:
738**
drh4f26d6c2004-05-26 23:25:30 +0000739** CREATE TABLE t1(c1 INTEGER);
danielk197765904932004-05-26 06:18:37 +0000740**
741** And the following statement compiled:
742**
743** SELECT c1 + 1, 0 FROM t1;
744**
drh4f26d6c2004-05-26 23:25:30 +0000745** Then this routine would return the string "INTEGER" for the second
danielk197765904932004-05-26 06:18:37 +0000746** result column (i==1), and a NULL pointer for the first result column
747** (i==0).
748*/
749const void *sqlite3_column_decltype16(sqlite3_stmt*,int);
750
danielk1977106bb232004-05-21 10:08:53 +0000751/*
752** After an SQL query has been compiled with a call to either
753** sqlite3_prepare() or sqlite3_prepare16(), then this function must be
754** called one or more times to execute the statement.
755**
756** The return value will be either SQLITE_BUSY, SQLITE_DONE,
757** SQLITE_ROW, SQLITE_ERROR, or SQLITE_MISUSE.
758**
759** SQLITE_BUSY means that the database engine attempted to open
760** a locked database and there is no busy callback registered.
761** Call sqlite3_step() again to retry the open.
762**
763** SQLITE_DONE means that the statement has finished executing
764** successfully. sqlite3_step() should not be called again on this virtual
765** machine.
766**
767** If the SQL statement being executed returns any data, then
768** SQLITE_ROW is returned each time a new row of data is ready
769** for processing by the caller. The values may be accessed using
770** the sqlite3_column_*() functions described below. sqlite3_step()
771** is called again to retrieve the next row of data.
772**
773** SQLITE_ERROR means that a run-time error (such as a constraint
774** violation) has occurred. sqlite3_step() should not be called again on
775** the VM. More information may be found by calling sqlite3_errmsg().
776**
777** SQLITE_MISUSE means that the this routine was called inappropriately.
778** Perhaps it was called on a virtual machine that had already been
779** finalized or on one that had previously returned SQLITE_ERROR or
780** SQLITE_DONE. Or it could be the case the the same database connection
781** is being used simulataneously by two or more threads.
782*/
danielk197717240fd2004-05-26 00:07:25 +0000783int sqlite3_step(sqlite3_stmt*);
danielk1977106bb232004-05-21 10:08:53 +0000784
danielk1977106bb232004-05-21 10:08:53 +0000785/*
786** Return the number of values in the current row of the result set.
787**
788** After a call to sqlite3_step() that returns SQLITE_ROW, this routine
789** will return the same value as the sqlite3_column_count() function.
790** After sqlite3_step() has returned an SQLITE_DONE, SQLITE_BUSY or
791** error code, or before sqlite3_step() has been called on a
792** compiled SQL statement, this routine returns zero.
793*/
danielk197793d46752004-05-23 13:30:58 +0000794int sqlite3_data_count(sqlite3_stmt *pStmt);
danielk19774adee202004-05-08 08:23:19 +0000795
drh4f26d6c2004-05-26 23:25:30 +0000796/*
797** Values are stored in the database in one of the following fundamental
798** types.
799*/
drh9c054832004-05-31 18:51:57 +0000800#define SQLITE_INTEGER 1
801#define SQLITE_FLOAT 2
drh1e284f42004-10-06 15:52:01 +0000802/* #define SQLITE_TEXT 3 // See below */
drh9c054832004-05-31 18:51:57 +0000803#define SQLITE_BLOB 4
804#define SQLITE_NULL 5
danielk19774adee202004-05-08 08:23:19 +0000805
danielk1977106bb232004-05-21 10:08:53 +0000806/*
drh1e284f42004-10-06 15:52:01 +0000807** SQLite version 2 defines SQLITE_TEXT differently. To allow both
808** version 2 and version 3 to be included, undefine them both if a
809** conflict is seen. Define SQLITE3_TEXT to be the version 3 value.
810*/
811#ifdef SQLITE_TEXT
812# undef SQLITE_TEXT
813#else
814# define SQLITE_TEXT 3
815#endif
816#define SQLITE3_TEXT 3
817
818/*
drh4f26d6c2004-05-26 23:25:30 +0000819** The next group of routines returns information about the information
820** in a single column of the current result row of a query. In every
821** case the first parameter is a pointer to the SQL statement that is being
822** executed (the sqlite_stmt* that was returned from sqlite3_prepare()) and
823** the second argument is the index of the column for which information
824** should be returned. iCol is zero-indexed. The left-most column as an
825** index of 0.
danielk1977106bb232004-05-21 10:08:53 +0000826**
drh4f26d6c2004-05-26 23:25:30 +0000827** If the SQL statement is not currently point to a valid row, or if the
828** the colulmn index is out of range, the result is undefined.
829**
830** These routines attempt to convert the value where appropriate. For
831** example, if the internal representation is FLOAT and a text result
832** is requested, sprintf() is used internally to do the conversion
833** automatically. The following table details the conversions that
834** are applied:
835**
836** Internal Type Requested Type Conversion
837** ------------- -------------- --------------------------
838** NULL INTEGER Result is 0
839** NULL FLOAT Result is 0.0
840** NULL TEXT Result is an empty string
841** NULL BLOB Result is a zero-length BLOB
842** INTEGER FLOAT Convert from integer to float
843** INTEGER TEXT ASCII rendering of the integer
844** INTEGER BLOB Same as for INTEGER->TEXT
845** FLOAT INTEGER Convert from float to integer
846** FLOAT TEXT ASCII rendering of the float
847** FLOAT BLOB Same as FLOAT->TEXT
848** TEXT INTEGER Use atoi()
849** TEXT FLOAT Use atof()
850** TEXT BLOB No change
851** BLOB INTEGER Convert to TEXT then use atoi()
852** BLOB FLOAT Convert to TEXT then use atof()
853** BLOB TEXT Add a \000 terminator if needed
854**
855** The following access routines are provided:
856**
857** _type() Return the datatype of the result. This is one of
858** SQLITE_INTEGER, SQLITE_FLOAT, SQLITE_TEXT, SQLITE_BLOB,
859** or SQLITE_NULL.
860** _blob() Return the value of a BLOB.
861** _bytes() Return the number of bytes in a BLOB value or the number
862** of bytes in a TEXT value represented as UTF-8. The \000
863** terminator is included in the byte count for TEXT values.
864** _bytes16() Return the number of bytes in a BLOB value or the number
865** of bytes in a TEXT value represented as UTF-16. The \u0000
866** terminator is included in the byte count for TEXT values.
867** _double() Return a FLOAT value.
868** _int() Return an INTEGER value in the host computer's native
869** integer representation. This might be either a 32- or 64-bit
870** integer depending on the host.
871** _int64() Return an INTEGER value as a 64-bit signed integer.
872** _text() Return the value as UTF-8 text.
873** _text16() Return the value as UTF-16 text.
danielk1977106bb232004-05-21 10:08:53 +0000874*/
drhf4479502004-05-27 03:12:53 +0000875const void *sqlite3_column_blob(sqlite3_stmt*, int iCol);
876int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
877int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
878double sqlite3_column_double(sqlite3_stmt*, int iCol);
879int sqlite3_column_int(sqlite3_stmt*, int iCol);
drhefad9992004-06-22 12:13:55 +0000880sqlite_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol);
drhf4479502004-05-27 03:12:53 +0000881const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol);
882const void *sqlite3_column_text16(sqlite3_stmt*, int iCol);
drh4f26d6c2004-05-26 23:25:30 +0000883int sqlite3_column_type(sqlite3_stmt*, int iCol);
danielk19774adee202004-05-08 08:23:19 +0000884
danielk197765904932004-05-26 06:18:37 +0000885/*
886** The sqlite3_finalize() function is called to delete a compiled
887** SQL statement obtained by a previous call to sqlite3_prepare()
888** or sqlite3_prepare16(). If the statement was executed successfully, or
889** not executed at all, then SQLITE_OK is returned. If execution of the
890** statement failed then an error code is returned.
891**
892** This routine can be called at any point during the execution of the
893** virtual machine. If the virtual machine has not completed execution
894** when this routine is called, that is like encountering an error or
895** an interrupt. (See sqlite3_interrupt().) Incomplete updates may be
896** rolled back and transactions cancelled, depending on the circumstances,
897** and the result code returned will be SQLITE_ABORT.
898*/
899int sqlite3_finalize(sqlite3_stmt *pStmt);
900
901/*
902** The sqlite3_reset() function is called to reset a compiled SQL
903** statement obtained by a previous call to sqlite3_prepare() or
904** sqlite3_prepare16() back to it's initial state, ready to be re-executed.
905** Any SQL statement variables that had values bound to them using
906** the sqlite3_bind_*() API retain their values.
907*/
908int sqlite3_reset(sqlite3_stmt *pStmt);
909
910/*
danielk197765904932004-05-26 06:18:37 +0000911** The following two functions are used to add user functions or aggregates
912** implemented in C to the SQL langauge interpreted by SQLite. The
913** difference only between the two is that the second parameter, the
914** name of the (scalar) function or aggregate, is encoded in UTF-8 for
915** sqlite3_create_function() and UTF-16 for sqlite3_create_function16().
916**
917** The first argument is the database handle that the new function or
918** aggregate is to be added to. If a single program uses more than one
919** database handle internally, then user functions or aggregates must
920** be added individually to each database handle with which they will be
921** used.
922**
923** The third parameter is the number of arguments that the function or
924** aggregate takes. If this parameter is negative, then the function or
925** aggregate may take any number of arguments.
926**
danielk1977d8123362004-06-12 09:25:12 +0000927** The fourth parameter is one of SQLITE_UTF* values defined below,
928** indicating the encoding that the function is most likely to handle
929** values in. This does not change the behaviour of the programming
930** interface. However, if two versions of the same function are registered
931** with different encoding values, SQLite invokes the version likely to
932** minimize conversions between text encodings.
danielk1977d02eb1f2004-06-06 09:44:03 +0000933**
danielk197765904932004-05-26 06:18:37 +0000934** The seventh, eighth and ninth parameters, xFunc, xStep and xFinal, are
935** pointers to user implemented C functions that implement the user
936** function or aggregate. A scalar function requires an implementation of
937** the xFunc callback only, NULL pointers should be passed as the xStep
938** and xFinal parameters. An aggregate function requires an implementation
939** of xStep and xFinal, but NULL should be passed for xFunc. To delete an
940** existing user function or aggregate, pass NULL for all three function
941** callback. Specifying an inconstent set of callback values, such as an
942** xFunc and an xFinal, or an xStep but no xFinal, SQLITE_ERROR is
943** returned.
944*/
945int sqlite3_create_function(
946 sqlite3 *,
947 const char *zFunctionName,
948 int nArg,
949 int eTextRep,
danielk197765904932004-05-26 06:18:37 +0000950 void*,
951 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
952 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
953 void (*xFinal)(sqlite3_context*)
954);
955int sqlite3_create_function16(
956 sqlite3*,
957 const void *zFunctionName,
958 int nArg,
959 int eTextRep,
danielk197765904932004-05-26 06:18:37 +0000960 void*,
961 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
962 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
963 void (*xFinal)(sqlite3_context*)
964);
965
966/*
danielk197765904932004-05-26 06:18:37 +0000967** The next routine returns the number of calls to xStep for a particular
968** aggregate function instance. The current call to xStep counts so this
969** routine always returns at least 1.
970*/
971int sqlite3_aggregate_count(sqlite3_context*);
972
danielk19770ffba6b2004-05-24 09:10:10 +0000973/*
drh4f26d6c2004-05-26 23:25:30 +0000974** The next group of routines returns information about parameters to
975** a user-defined function. Function implementations use these routines
976** to access their parameters. These routines are the same as the
977** sqlite3_column_* routines except that these routines take a single
978** sqlite3_value* pointer instead of an sqlite3_stmt* and an integer
979** column number.
danielk19770ffba6b2004-05-24 09:10:10 +0000980*/
drhf4479502004-05-27 03:12:53 +0000981const void *sqlite3_value_blob(sqlite3_value*);
982int sqlite3_value_bytes(sqlite3_value*);
983int sqlite3_value_bytes16(sqlite3_value*);
984double sqlite3_value_double(sqlite3_value*);
985int sqlite3_value_int(sqlite3_value*);
drhefad9992004-06-22 12:13:55 +0000986sqlite_int64 sqlite3_value_int64(sqlite3_value*);
drhf4479502004-05-27 03:12:53 +0000987const unsigned char *sqlite3_value_text(sqlite3_value*);
988const void *sqlite3_value_text16(sqlite3_value*);
danielk1977d8123362004-06-12 09:25:12 +0000989const void *sqlite3_value_text16le(sqlite3_value*);
990const void *sqlite3_value_text16be(sqlite3_value*);
danielk197793d46752004-05-23 13:30:58 +0000991int sqlite3_value_type(sqlite3_value*);
danielk19770ffba6b2004-05-24 09:10:10 +0000992
993/*
danielk19770ae8b832004-05-25 12:05:56 +0000994** Aggregate functions use the following routine to allocate
995** a structure for storing their state. The first time this routine
996** is called for a particular aggregate, a new structure of size nBytes
997** is allocated, zeroed, and returned. On subsequent calls (for the
998** same aggregate instance) the same buffer is returned. The implementation
999** of the aggregate can use the returned buffer to accumulate data.
1000**
1001** The buffer allocated is freed automatically by SQLite.
1002*/
drh4f26d6c2004-05-26 23:25:30 +00001003void *sqlite3_aggregate_context(sqlite3_context*, int nBytes);
danielk19777e18c252004-05-25 11:47:24 +00001004
1005/*
drhc0f2a012005-07-09 02:39:40 +00001006** The pUserData parameter to the sqlite3_create_function()
1007** routine used to register user functions is available to
1008** the implementation of the function using this call.
danielk19777e18c252004-05-25 11:47:24 +00001009*/
1010void *sqlite3_user_data(sqlite3_context*);
1011
1012/*
danielk1977682f68b2004-06-05 10:22:17 +00001013** The following two functions may be used by scalar user functions to
1014** associate meta-data with argument values. If the same value is passed to
1015** multiple invocations of the user-function during query execution, under
1016** some circumstances the associated meta-data may be preserved. This may
1017** be used, for example, to add a regular-expression matching scalar
1018** function. The compiled version of the regular expression is stored as
1019** meta-data associated with the SQL value passed as the regular expression
1020** pattern.
1021**
1022** Calling sqlite3_get_auxdata() returns a pointer to the meta data
1023** associated with the Nth argument value to the current user function
1024** call, where N is the second parameter. If no meta-data has been set for
1025** that value, then a NULL pointer is returned.
1026**
1027** The sqlite3_set_auxdata() is used to associate meta data with a user
1028** function argument. The third parameter is a pointer to the meta data
1029** to be associated with the Nth user function argument value. The fourth
1030** parameter specifies a 'delete function' that will be called on the meta
1031** data pointer to release it when it is no longer required. If the delete
1032** function pointer is NULL, it is not invoked.
1033**
1034** In practice, meta-data is preserved between function calls for
1035** expressions that are constant at compile time. This includes literal
1036** values and SQL variables.
1037*/
1038void *sqlite3_get_auxdata(sqlite3_context*, int);
1039void sqlite3_set_auxdata(sqlite3_context*, int, void*, void (*)(void*));
1040
drha2854222004-06-17 19:04:17 +00001041
1042/*
1043** These are special value for the destructor that is passed in as the
1044** final argument to routines like sqlite3_result_blob(). If the destructor
1045** argument is SQLITE_STATIC, it means that the content pointer is constant
1046** and will never change. It does not need to be destroyed. The
1047** SQLITE_TRANSIENT value means that the content will likely change in
1048** the near future and that SQLite should make its own private copy of
1049** the content before returning.
1050*/
danielk1977d8123362004-06-12 09:25:12 +00001051#define SQLITE_STATIC ((void(*)(void *))0)
1052#define SQLITE_TRANSIENT ((void(*)(void *))-1)
1053
danielk1977682f68b2004-06-05 10:22:17 +00001054/*
drh4f26d6c2004-05-26 23:25:30 +00001055** User-defined functions invoke the following routines in order to
1056** set their return value.
danielk19777e18c252004-05-25 11:47:24 +00001057*/
danielk1977d8123362004-06-12 09:25:12 +00001058void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*));
drh4f26d6c2004-05-26 23:25:30 +00001059void sqlite3_result_double(sqlite3_context*, double);
danielk19777e18c252004-05-25 11:47:24 +00001060void sqlite3_result_error(sqlite3_context*, const char*, int);
1061void sqlite3_result_error16(sqlite3_context*, const void*, int);
drh4f26d6c2004-05-26 23:25:30 +00001062void sqlite3_result_int(sqlite3_context*, int);
drhefad9992004-06-22 12:13:55 +00001063void sqlite3_result_int64(sqlite3_context*, sqlite_int64);
drh4f26d6c2004-05-26 23:25:30 +00001064void sqlite3_result_null(sqlite3_context*);
danielk1977d8123362004-06-12 09:25:12 +00001065void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*));
1066void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*));
1067void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*));
1068void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*));
drh4f26d6c2004-05-26 23:25:30 +00001069void sqlite3_result_value(sqlite3_context*, sqlite3_value*);
drhf9b596e2004-05-26 16:54:42 +00001070
drh52619df2004-06-11 17:48:02 +00001071/*
1072** These are the allowed values for the eTextRep argument to
1073** sqlite3_create_collation and sqlite3_create_function.
1074*/
danielk1977466be562004-06-10 02:16:01 +00001075#define SQLITE_UTF8 1
danielk1977dc8453f2004-06-12 00:42:34 +00001076#define SQLITE_UTF16LE 2
1077#define SQLITE_UTF16BE 3
1078#define SQLITE_UTF16 4 /* Use native byte order */
drh52619df2004-06-11 17:48:02 +00001079#define SQLITE_ANY 5 /* sqlite3_create_function only */
danielk1977466be562004-06-10 02:16:01 +00001080
danielk19777cedc8d2004-06-10 10:50:08 +00001081/*
1082** These two functions are used to add new collation sequences to the
1083** sqlite3 handle specified as the first argument.
1084**
1085** The name of the new collation sequence is specified as a UTF-8 string
1086** for sqlite3_create_collation() and a UTF-16 string for
1087** sqlite3_create_collation16(). In both cases the name is passed as the
1088** second function argument.
1089**
1090** The third argument must be one of the constants SQLITE_UTF8,
1091** SQLITE_UTF16LE or SQLITE_UTF16BE, indicating that the user-supplied
1092** routine expects to be passed pointers to strings encoded using UTF-8,
1093** UTF-16 little-endian or UTF-16 big-endian respectively.
1094**
1095** A pointer to the user supplied routine must be passed as the fifth
1096** argument. If it is NULL, this is the same as deleting the collation
1097** sequence (so that SQLite cannot call it anymore). Each time the user
1098** supplied function is invoked, it is passed a copy of the void* passed as
1099** the fourth argument to sqlite3_create_collation() or
1100** sqlite3_create_collation16() as its first parameter.
1101**
1102** The remaining arguments to the user-supplied routine are two strings,
1103** each represented by a [length, data] pair and encoded in the encoding
1104** that was passed as the third argument when the collation sequence was
1105** registered. The user routine should return negative, zero or positive if
1106** the first string is less than, equal to, or greater than the second
1107** string. i.e. (STRING1 - STRING2).
1108*/
danielk19770202b292004-06-09 09:55:16 +00001109int sqlite3_create_collation(
1110 sqlite3*,
1111 const char *zName,
danielk19777cedc8d2004-06-10 10:50:08 +00001112 int eTextRep,
danielk19770202b292004-06-09 09:55:16 +00001113 void*,
1114 int(*xCompare)(void*,int,const void*,int,const void*)
1115);
1116int sqlite3_create_collation16(
1117 sqlite3*,
1118 const char *zName,
danielk19777cedc8d2004-06-10 10:50:08 +00001119 int eTextRep,
danielk19770202b292004-06-09 09:55:16 +00001120 void*,
1121 int(*xCompare)(void*,int,const void*,int,const void*)
1122);
1123
danielk19777cedc8d2004-06-10 10:50:08 +00001124/*
1125** To avoid having to register all collation sequences before a database
1126** can be used, a single callback function may be registered with the
1127** database handle to be called whenever an undefined collation sequence is
1128** required.
1129**
1130** If the function is registered using the sqlite3_collation_needed() API,
1131** then it is passed the names of undefined collation sequences as strings
1132** encoded in UTF-8. If sqlite3_collation_needed16() is used, the names
1133** are passed as UTF-16 in machine native byte order. A call to either
1134** function replaces any existing callback.
1135**
1136** When the user-function is invoked, the first argument passed is a copy
1137** of the second argument to sqlite3_collation_needed() or
1138** sqlite3_collation_needed16(). The second argument is the database
1139** handle. The third argument is one of SQLITE_UTF8, SQLITE_UTF16BE or
1140** SQLITE_UTF16LE, indicating the most desirable form of the collation
1141** sequence function required. The fourth parameter is the name of the
1142** required collation sequence.
1143**
1144** The collation sequence is returned to SQLite by a collation-needed
1145** callback using the sqlite3_create_collation() or
1146** sqlite3_create_collation16() APIs, described above.
1147*/
1148int sqlite3_collation_needed(
1149 sqlite3*,
1150 void*,
1151 void(*)(void*,sqlite3*,int eTextRep,const char*)
1152);
1153int sqlite3_collation_needed16(
1154 sqlite3*,
1155 void*,
1156 void(*)(void*,sqlite3*,int eTextRep,const void*)
1157);
1158
drh2011d5f2004-07-22 02:40:37 +00001159/*
1160** Specify the key for an encrypted database. This routine should be
1161** called right after sqlite3_open().
1162**
1163** The code to implement this API is not available in the public release
1164** of SQLite.
1165*/
1166int sqlite3_key(
1167 sqlite3 *db, /* Database to be rekeyed */
1168 const void *pKey, int nKey /* The key */
1169);
1170
1171/*
1172** Change the key on an open database. If the current database is not
1173** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the
1174** database is decrypted.
1175**
1176** The code to implement this API is not available in the public release
1177** of SQLite.
1178*/
1179int sqlite3_rekey(
1180 sqlite3 *db, /* Database to be rekeyed */
1181 const void *pKey, int nKey /* The new key */
1182);
danielk19770202b292004-06-09 09:55:16 +00001183
drhab3f9fe2004-08-14 17:10:10 +00001184/*
danielk1977600dd0b2005-01-20 01:14:23 +00001185** Sleep for a little while. The second parameter is the number of
1186** miliseconds to sleep for.
1187**
1188** If the operating system does not support sleep requests with
1189** milisecond time resolution, then the time will be rounded up to
1190** the nearest second. The number of miliseconds of sleep actually
1191** requested from the operating system is returned.
danielk1977600dd0b2005-01-20 01:14:23 +00001192*/
1193int sqlite3_sleep(int);
1194
1195/*
drh65efb652005-06-12 22:12:39 +00001196** Return TRUE (non-zero) if the statement supplied as an argument needs
drhd89bd002005-01-22 03:03:54 +00001197** to be recompiled. A statement needs to be recompiled whenever the
1198** execution environment changes in a way that would alter the program
1199** that sqlite3_prepare() generates. For example, if new functions or
1200** collating sequences are registered or if an authorizer function is
1201** added or changed.
1202**
drhd89bd002005-01-22 03:03:54 +00001203*/
1204int sqlite3_expired(sqlite3_stmt*);
1205
1206/*
drhf8db1bc2005-04-22 02:38:37 +00001207** Move all bindings from the first prepared statement over to the second.
1208** This routine is useful, for example, if the first prepared statement
1209** fails with an SQLITE_SCHEMA error. The same SQL can be prepared into
1210** the second prepared statement then all of the bindings transfered over
1211** to the second statement before the first statement is finalized.
drhf8db1bc2005-04-22 02:38:37 +00001212*/
1213int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*);
1214
1215/*
tpoindex9a09a3c2004-12-20 19:01:32 +00001216** If the following global variable is made to point to a
drhab3f9fe2004-08-14 17:10:10 +00001217** string which is the name of a directory, then all temporary files
1218** created by SQLite will be placed in that directory. If this variable
1219** is NULL pointer, then SQLite does a search for an appropriate temporary
1220** file directory.
1221**
danielk19776b456a22005-03-21 04:04:02 +00001222** Once sqlite3_open() has been called, changing this variable will invalidate
1223** the current temporary database, if any.
drhab3f9fe2004-08-14 17:10:10 +00001224*/
tpoindex9a09a3c2004-12-20 19:01:32 +00001225extern char *sqlite3_temp_directory;
drhab3f9fe2004-08-14 17:10:10 +00001226
danielk19776b456a22005-03-21 04:04:02 +00001227/*
1228** This function is called to recover from a malloc() failure that occured
1229** within the SQLite library. Normally, after a single malloc() fails the
1230** library refuses to function (all major calls return SQLITE_NOMEM).
drh9a7e6082005-03-31 22:26:19 +00001231** This function restores the library state so that it can be used again.
danielk19776b456a22005-03-21 04:04:02 +00001232**
1233** All existing statements (sqlite3_stmt pointers) must be finalized or
1234** reset before this call is made. Otherwise, SQLITE_BUSY is returned.
1235** If any in-memory databases are in use, either as a main or TEMP
1236** database, SQLITE_ERROR is returned. In either of these cases, the
1237** library is not reset and remains unusable.
1238**
1239** This function is *not* threadsafe. Calling this from within a threaded
1240** application when threads other than the caller have used SQLite is
1241** dangerous and will almost certainly result in malfunctions.
1242**
1243** This functionality can be omitted from a build by defining the
1244** SQLITE_OMIT_GLOBALRECOVER at compile time.
1245*/
1246int sqlite3_global_recover();
1247
drh3e1d8e62005-05-26 16:23:34 +00001248/*
1249** Test to see whether or not the database connection is in autocommit
1250** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
1251** by default. Autocommit is disabled by a BEGIN statement and reenabled
1252** by the next COMMIT or ROLLBACK.
drh3e1d8e62005-05-26 16:23:34 +00001253*/
1254int sqlite3_get_autocommit(sqlite3*);
1255
drh51942bc2005-06-12 22:01:42 +00001256/*
1257** Return the sqlite3* database handle to which the prepared statement given
1258** in the argument belongs. This is the same database handle that was
1259** the first argument to the sqlite3_prepare() that was used to create
1260** the statement in the first place.
1261*/
1262sqlite3 *sqlite3_db_handle(sqlite3_stmt*);
drh3e1d8e62005-05-26 16:23:34 +00001263
drh382c0242001-10-06 16:33:02 +00001264#ifdef __cplusplus
1265} /* End of the 'extern "C"' block */
1266#endif
danielk19774adee202004-05-08 08:23:19 +00001267#endif