blob: 3a3a697b136354ec0f30d9db62bd5f031cff31b5 [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**
danielk1977106bb232004-05-21 10:08:53 +000015** @(#) $Id: sqlite.h.in,v 1.68 2004/05/21 10:08:54 danielk1977 Exp $
drh75897232000-05-29 14:26:00 +000016*/
17#ifndef _SQLITE_H_
18#define _SQLITE_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*/
31#define SQLITE_VERSION "--VERS--"
32
33/*
drhb217a572000-08-22 13:40:18 +000034** The version string is also compiled into the library so that a program
35** can check to make sure that the lib*.a file and the *.h file are from
36** the same version.
37*/
danielk19776f8a5032004-05-10 10:34:51 +000038extern const char sqlite3_version[];
drh303aaa72000-08-17 10:22:34 +000039
40/*
drh297ecf12001-04-05 15:57:13 +000041** The SQLITE_UTF8 macro is defined if the library expects to see
42** UTF-8 encoded data. The SQLITE_ISO8859 macro is defined if the
43** iso8859 encoded should be used.
44*/
45#define SQLITE_--ENCODING-- 1
46
47/*
48** The following constant holds one of two strings, "UTF-8" or "iso8859",
49** depending on which character encoding the SQLite library expects to
50** see. The character encoding makes a difference for the LIKE and GLOB
51** operators and for the LENGTH() and SUBSTR() functions.
52*/
danielk19776f8a5032004-05-10 10:34:51 +000053extern const char sqlite3_encoding[];
drh297ecf12001-04-05 15:57:13 +000054
55/*
drh75897232000-05-29 14:26:00 +000056** Each open sqlite database is represented by an instance of the
57** following opaque structure.
58*/
59typedef struct sqlite sqlite;
60
61/*
62** A function to open a new sqlite database.
63**
64** If the database does not exist and mode indicates write
65** permission, then a new database is created. If the database
66** does not exist and mode does not indicate write permission,
67** then the open fails, an error message generated (if errmsg!=0)
68** and the function returns 0.
69**
70** If mode does not indicates user write permission, then the
71** database is opened read-only.
72**
73** The Truth: As currently implemented, all databases are opened
74** for writing all the time. Maybe someday we will provide the
75** ability to open a database readonly. The mode parameters is
drhb86ccfb2003-01-28 23:13:10 +000076** provided in anticipation of that enhancement.
drh75897232000-05-29 14:26:00 +000077*/
danielk19776f8a5032004-05-10 10:34:51 +000078sqlite *sqlite3_open(const char *filename, int mode, char **errmsg);
drh75897232000-05-29 14:26:00 +000079
80/*
81** A function to close the database.
82**
83** Call this function with a pointer to a structure that was previously
danielk19776f8a5032004-05-10 10:34:51 +000084** returned from sqlite3_open() and the corresponding database will by closed.
drh75897232000-05-29 14:26:00 +000085*/
danielk19776f8a5032004-05-10 10:34:51 +000086void sqlite3_close(sqlite *);
drh75897232000-05-29 14:26:00 +000087
88/*
89** The type for a callback function.
90*/
91typedef int (*sqlite_callback)(void*,int,char**, char**);
92
93/*
94** A function to executes one or more statements of SQL.
95**
96** If one or more of the SQL statements are queries, then
97** the callback function specified by the 3rd parameter is
98** invoked once for each row of the query result. This callback
99** should normally return 0. If the callback returns a non-zero
100** value then the query is aborted, all subsequent SQL statements
danielk19776f8a5032004-05-10 10:34:51 +0000101** are skipped and the sqlite3_exec() function returns the SQLITE_ABORT.
drh75897232000-05-29 14:26:00 +0000102**
103** The 4th parameter is an arbitrary pointer that is passed
104** to the callback function as its first parameter.
105**
106** The 2nd parameter to the callback function is the number of
drhb19a2bc2001-09-16 00:13:26 +0000107** columns in the query result. The 3rd parameter to the callback
108** is an array of strings holding the values for each column.
109** The 4th parameter to the callback is an array of strings holding
110** the names of each column.
drh75897232000-05-29 14:26:00 +0000111**
112** The callback function may be NULL, even for queries. A NULL
113** callback is not an error. It just means that no callback
114** will be invoked.
115**
116** If an error occurs while parsing or evaluating the SQL (but
117** not while executing the callback) then an appropriate error
118** message is written into memory obtained from malloc() and
drhb19a2bc2001-09-16 00:13:26 +0000119** *errmsg is made to point to that message. The calling function
120** is responsible for freeing the memory that holds the error
danielk19776f8a5032004-05-10 10:34:51 +0000121** message. Use sqlite3_freemem() for this. If errmsg==NULL,
drhb86ccfb2003-01-28 23:13:10 +0000122** then no error message is ever written.
drhb19a2bc2001-09-16 00:13:26 +0000123**
124** The return value is is SQLITE_OK if there are no errors and
125** some other return code if there is an error. The particular
126** return value depends on the type of error.
drh58b95762000-06-02 01:17:37 +0000127**
128** If the query could not be executed because a database file is
drh2dfbbca2000-07-28 14:32:48 +0000129** locked or busy, then this function returns SQLITE_BUSY. (This
danielk19776f8a5032004-05-10 10:34:51 +0000130** behavior can be modified somewhat using the sqlite3_busy_handler()
131** and sqlite3_busy_timeout() functions below.)
drh75897232000-05-29 14:26:00 +0000132*/
danielk19776f8a5032004-05-10 10:34:51 +0000133int sqlite3_exec(
drh75897232000-05-29 14:26:00 +0000134 sqlite*, /* An open database */
drh9f71c2e2001-11-03 23:57:09 +0000135 const char *sql, /* SQL to be executed */
drh75897232000-05-29 14:26:00 +0000136 sqlite_callback, /* Callback function */
137 void *, /* 1st argument to callback function */
138 char **errmsg /* Error msg written here */
139);
140
drh58b95762000-06-02 01:17:37 +0000141/*
danielk19776f8a5032004-05-10 10:34:51 +0000142** Return values for sqlite3_exec() and sqlite3_step()
drh58b95762000-06-02 01:17:37 +0000143*/
drh717e6402001-09-27 03:22:32 +0000144#define SQLITE_OK 0 /* Successful result */
145#define SQLITE_ERROR 1 /* SQL error or missing database */
146#define SQLITE_INTERNAL 2 /* An internal logic error in SQLite */
147#define SQLITE_PERM 3 /* Access permission denied */
148#define SQLITE_ABORT 4 /* Callback routine requested an abort */
149#define SQLITE_BUSY 5 /* The database file is locked */
150#define SQLITE_LOCKED 6 /* A table in the database is locked */
151#define SQLITE_NOMEM 7 /* A malloc() failed */
152#define SQLITE_READONLY 8 /* Attempt to write a readonly database */
drh24cd67e2004-05-10 16:18:47 +0000153#define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/
drh717e6402001-09-27 03:22:32 +0000154#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */
155#define SQLITE_CORRUPT 11 /* The database disk image is malformed */
156#define SQLITE_NOTFOUND 12 /* (Internal Only) Table or record not found */
157#define SQLITE_FULL 13 /* Insertion failed because database is full */
158#define SQLITE_CANTOPEN 14 /* Unable to open the database file */
159#define SQLITE_PROTOCOL 15 /* Database lock protocol error */
drh24cd67e2004-05-10 16:18:47 +0000160#define SQLITE_EMPTY 16 /* Database is empty */
drh717e6402001-09-27 03:22:32 +0000161#define SQLITE_SCHEMA 17 /* The database schema changed */
162#define SQLITE_TOOBIG 18 /* Too much data for one row of a table */
163#define SQLITE_CONSTRAINT 19 /* Abort due to contraint violation */
drh8aff1012001-12-22 14:49:24 +0000164#define SQLITE_MISMATCH 20 /* Data type mismatch */
drh247be432002-05-10 05:44:55 +0000165#define SQLITE_MISUSE 21 /* Library used incorrectly */
drh8766c342002-11-09 00:33:15 +0000166#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */
drhed6c8672003-01-12 18:02:16 +0000167#define SQLITE_AUTH 23 /* Authorization denied */
drh1c2d8412003-03-31 00:30:47 +0000168#define SQLITE_FORMAT 24 /* Auxiliary database format error */
danielk19776f8a5032004-05-10 10:34:51 +0000169#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */
drhc602f9a2004-02-12 19:01:04 +0000170#define SQLITE_NOTADB 26 /* File opened that is not a database file */
danielk19776f8a5032004-05-10 10:34:51 +0000171#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */
172#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */
drh717e6402001-09-27 03:22:32 +0000173
drhaf9ff332002-01-16 21:00:27 +0000174/*
175** Each entry in an SQLite table has a unique integer key. (The key is
176** the value of the INTEGER PRIMARY KEY column if there is such a column,
177** otherwise the key is generated at random. The unique key is always
178** available as the ROWID, OID, or _ROWID_ column.) The following routine
179** returns the integer key of the most recent insert in the database.
180**
181** This function is similar to the mysql_insert_id() function from MySQL.
182*/
danielk19776f8a5032004-05-10 10:34:51 +0000183int sqlite3_last_insert_rowid(sqlite*);
drhaf9ff332002-01-16 21:00:27 +0000184
drhc8d30ac2002-04-12 10:08:59 +0000185/*
186** This function returns the number of database rows that were changed
danielk19776f8a5032004-05-10 10:34:51 +0000187** (or inserted or deleted) by the most recent called sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000188**
189** All changes are counted, even if they were later undone by a
190** ROLLBACK or ABORT. Except, changes associated with creating and
191** dropping tables are not counted.
192**
danielk19776f8a5032004-05-10 10:34:51 +0000193** If a callback invokes sqlite3_exec() recursively, then the changes
drhc8d30ac2002-04-12 10:08:59 +0000194** in the inner, recursive call are counted together with the changes
195** in the outer call.
196**
197** SQLite implements the command "DELETE FROM table" without a WHERE clause
198** by dropping and recreating the table. (This is much faster than going
199** through and deleting individual elements form the table.) Because of
200** this optimization, the change count for "DELETE FROM table" will be
201** zero regardless of the number of elements that were originally in the
202** table. To get an accurate count of the number of rows deleted, use
203** "DELETE FROM table WHERE 1" instead.
204*/
danielk19776f8a5032004-05-10 10:34:51 +0000205int sqlite3_changes(sqlite*);
drhc8d30ac2002-04-12 10:08:59 +0000206
rdcf146a772004-02-25 22:51:06 +0000207/*
208** This function returns the number of database rows that were changed
danielk19776f8a5032004-05-10 10:34:51 +0000209** by the last INSERT, UPDATE, or DELETE statment executed by sqlite3_exec(),
rdcf146a772004-02-25 22:51:06 +0000210** or by the last VM to run to completion. The change count is not updated
211** by SQL statements other than INSERT, UPDATE or DELETE.
212**
213** Changes are counted, even if they are later undone by a ROLLBACK or
214** ABORT. Changes associated with trigger programs that execute as a
215** result of the INSERT, UPDATE, or DELETE statement are not counted.
216**
danielk19776f8a5032004-05-10 10:34:51 +0000217** If a callback invokes sqlite3_exec() recursively, then the changes
rdcf146a772004-02-25 22:51:06 +0000218** in the inner, recursive call are counted together with the changes
219** in the outer call.
220**
221** SQLite implements the command "DELETE FROM table" without a WHERE clause
222** by dropping and recreating the table. (This is much faster than going
223** through and deleting individual elements form the table.) Because of
224** this optimization, the change count for "DELETE FROM table" will be
225** zero regardless of the number of elements that were originally in the
226** table. To get an accurate count of the number of rows deleted, use
227** "DELETE FROM table WHERE 1" instead.
228**
229******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
230*/
danielk19776f8a5032004-05-10 10:34:51 +0000231int sqlite3_last_statement_changes(sqlite*);
rdcf146a772004-02-25 22:51:06 +0000232
drh717e6402001-09-27 03:22:32 +0000233/* If the parameter to this routine is one of the return value constants
234** defined above, then this routine returns a constant text string which
235** descripts (in English) the meaning of the return value.
236*/
danielk19776f8a5032004-05-10 10:34:51 +0000237const char *sqlite3_error_string(int);
238#define sqliteErrStr sqlite3_error_string /* Legacy. Do not use in new code. */
drh4c504392000-10-16 22:06:40 +0000239
240/* 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*/
danielk19776f8a5032004-05-10 10:34:51 +0000246void sqlite3_interrupt(sqlite*);
drh4c504392000-10-16 22:06:40 +0000247
drheec553b2000-06-02 01:51:20 +0000248
drh75897232000-05-29 14:26:00 +0000249/* This function returns true if the given input string comprises
250** one or more complete SQL statements.
251**
252** The algorithm is simple. If the last token other than spaces
253** and comments is a semicolon, then return true. otherwise return
254** false.
255*/
danielk19776f8a5032004-05-10 10:34:51 +0000256int sqlite3_complete(const char *sql);
drh75897232000-05-29 14:26:00 +0000257
drh2dfbbca2000-07-28 14:32:48 +0000258/*
259** This routine identifies a callback function that is invoked
260** whenever an attempt is made to open a database table that is
261** currently locked by another process or thread. If the busy callback
danielk19776f8a5032004-05-10 10:34:51 +0000262** is NULL, then sqlite3_exec() returns SQLITE_BUSY immediately if
drh2dfbbca2000-07-28 14:32:48 +0000263** it finds a locked table. If the busy callback is not NULL, then
danielk19776f8a5032004-05-10 10:34:51 +0000264** sqlite3_exec() invokes the callback with three arguments. The
drh2dfbbca2000-07-28 14:32:48 +0000265** second argument is the name of the locked table and the third
266** argument is the number of times the table has been busy. If the
danielk19776f8a5032004-05-10 10:34:51 +0000267** busy callback returns 0, then sqlite3_exec() immediately returns
268** SQLITE_BUSY. If the callback returns non-zero, then sqlite3_exec()
drh2dfbbca2000-07-28 14:32:48 +0000269** tries to open the table again and the cycle repeats.
270**
271** The default busy callback is NULL.
272**
273** Sqlite is re-entrant, so the busy handler may start a new query.
274** (It is not clear why anyone would every want to do this, but it
275** is allowed, in theory.) But the busy handler may not close the
276** database. Closing the database from a busy handler will delete
277** data structures out from under the executing query and will
278** probably result in a coredump.
279*/
danielk19776f8a5032004-05-10 10:34:51 +0000280void sqlite3_busy_handler(sqlite*, int(*)(void*,const char*,int), void*);
drh2dfbbca2000-07-28 14:32:48 +0000281
282/*
283** This routine sets a busy handler that sleeps for a while when a
284** table is locked. The handler will sleep multiple times until
285** at least "ms" milleseconds of sleeping have been done. After
286** "ms" milleseconds of sleeping, the handler returns 0 which
danielk19776f8a5032004-05-10 10:34:51 +0000287** causes sqlite3_exec() to return SQLITE_BUSY.
drh2dfbbca2000-07-28 14:32:48 +0000288**
289** Calling this routine with an argument less than or equal to zero
290** turns off all busy handlers.
291*/
danielk19776f8a5032004-05-10 10:34:51 +0000292void sqlite3_busy_timeout(sqlite*, int ms);
drh2dfbbca2000-07-28 14:32:48 +0000293
drhe3710332000-09-29 13:30:53 +0000294/*
danielk19776f8a5032004-05-10 10:34:51 +0000295** This next routine is really just a wrapper around sqlite3_exec().
drhe3710332000-09-29 13:30:53 +0000296** Instead of invoking a user-supplied callback for each row of the
297** result, this routine remembers each row of the result in memory
298** obtained from malloc(), then returns all of the result after the
drha18c5682000-10-08 22:20:57 +0000299** query has finished.
300**
301** As an example, suppose the query result where this table:
302**
303** Name | Age
304** -----------------------
305** Alice | 43
306** Bob | 28
307** Cindy | 21
308**
309** If the 3rd argument were &azResult then after the function returns
drh98699b52000-10-09 12:57:00 +0000310** azResult will contain the following data:
drha18c5682000-10-08 22:20:57 +0000311**
312** azResult[0] = "Name";
313** azResult[1] = "Age";
314** azResult[2] = "Alice";
315** azResult[3] = "43";
316** azResult[4] = "Bob";
317** azResult[5] = "28";
318** azResult[6] = "Cindy";
319** azResult[7] = "21";
320**
321** Notice that there is an extra row of data containing the column
322** headers. But the *nrow return value is still 3. *ncolumn is
323** set to 2. In general, the number of values inserted into azResult
324** will be ((*nrow) + 1)*(*ncolumn).
325**
326** After the calling function has finished using the result, it should
danielk19776f8a5032004-05-10 10:34:51 +0000327** pass the result data pointer to sqlite3_free_table() in order to
drha18c5682000-10-08 22:20:57 +0000328** release the memory that was malloc-ed. Because of the way the
329** malloc() happens, the calling function must not try to call
danielk19776f8a5032004-05-10 10:34:51 +0000330** malloc() directly. Only sqlite3_free_table() is able to release
drha18c5682000-10-08 22:20:57 +0000331** the memory properly and safely.
drhe3710332000-09-29 13:30:53 +0000332**
danielk19776f8a5032004-05-10 10:34:51 +0000333** The return value of this routine is the same as from sqlite3_exec().
drhe3710332000-09-29 13:30:53 +0000334*/
danielk19776f8a5032004-05-10 10:34:51 +0000335int sqlite3_get_table(
drhe3710332000-09-29 13:30:53 +0000336 sqlite*, /* An open database */
drh9f71c2e2001-11-03 23:57:09 +0000337 const char *sql, /* SQL to be executed */
drhe3710332000-09-29 13:30:53 +0000338 char ***resultp, /* Result written to a char *[] that this points to */
339 int *nrow, /* Number of result rows written here */
340 int *ncolumn, /* Number of result columns written here */
341 char **errmsg /* Error msg written here */
342);
343
344/*
danielk19776f8a5032004-05-10 10:34:51 +0000345** Call this routine to free the memory that sqlite3_get_table() allocated.
drhe3710332000-09-29 13:30:53 +0000346*/
danielk19776f8a5032004-05-10 10:34:51 +0000347void sqlite3_free_table(char **result);
drhe3710332000-09-29 13:30:53 +0000348
drha18c5682000-10-08 22:20:57 +0000349/*
danielk19776f8a5032004-05-10 10:34:51 +0000350** The following routines are wrappers around sqlite3_exec() and
351** sqlite3_get_table(). The only difference between the routines that
drha18c5682000-10-08 22:20:57 +0000352** follow and the originals is that the second argument to the
353** routines that follow is really a printf()-style format
354** string describing the SQL to be executed. Arguments to the format
355** string appear at the end of the argument list.
356**
357** All of the usual printf formatting options apply. In addition, there
358** is a "%q" option. %q works like %s in that it substitutes a null-terminated
drh66b89c82000-11-28 20:47:17 +0000359** string from the argument list. But %q also doubles every '\'' character.
drha18c5682000-10-08 22:20:57 +0000360** %q is designed for use inside a string literal. By doubling each '\''
drh66b89c82000-11-28 20:47:17 +0000361** character it escapes that character and allows it to be inserted into
drha18c5682000-10-08 22:20:57 +0000362** the string.
363**
364** For example, so some string variable contains text as follows:
365**
366** char *zText = "It's a happy day!";
367**
368** We can use this text in an SQL statement as follows:
369**
danielk19776f8a5032004-05-10 10:34:51 +0000370** sqlite3_exec_printf(db, "INSERT INTO table VALUES('%q')",
drha18c5682000-10-08 22:20:57 +0000371** callback1, 0, 0, zText);
372**
373** Because the %q format string is used, the '\'' character in zText
374** is escaped and the SQL generated is as follows:
375**
376** INSERT INTO table1 VALUES('It''s a happy day!')
377**
378** This is correct. Had we used %s instead of %q, the generated SQL
379** would have looked like this:
380**
381** INSERT INTO table1 VALUES('It's a happy day!');
382**
383** This second example is an SQL syntax error. As a general rule you
384** should always use %q instead of %s when inserting text into a string
385** literal.
386*/
danielk19776f8a5032004-05-10 10:34:51 +0000387int sqlite3_exec_printf(
drha18c5682000-10-08 22:20:57 +0000388 sqlite*, /* An open database */
drh9f71c2e2001-11-03 23:57:09 +0000389 const char *sqlFormat, /* printf-style format string for the SQL */
drha18c5682000-10-08 22:20:57 +0000390 sqlite_callback, /* Callback function */
391 void *, /* 1st argument to callback function */
392 char **errmsg, /* Error msg written here */
393 ... /* Arguments to the format string. */
394);
danielk19776f8a5032004-05-10 10:34:51 +0000395int sqlite3_exec_vprintf(
drha18c5682000-10-08 22:20:57 +0000396 sqlite*, /* An open database */
drh9f71c2e2001-11-03 23:57:09 +0000397 const char *sqlFormat, /* printf-style format string for the SQL */
drha18c5682000-10-08 22:20:57 +0000398 sqlite_callback, /* Callback function */
399 void *, /* 1st argument to callback function */
400 char **errmsg, /* Error msg written here */
401 va_list ap /* Arguments to the format string. */
402);
danielk19776f8a5032004-05-10 10:34:51 +0000403int sqlite3_get_table_printf(
drha18c5682000-10-08 22:20:57 +0000404 sqlite*, /* An open database */
drh9f71c2e2001-11-03 23:57:09 +0000405 const char *sqlFormat, /* printf-style format string for the SQL */
drha18c5682000-10-08 22:20:57 +0000406 char ***resultp, /* Result written to a char *[] that this points to */
407 int *nrow, /* Number of result rows written here */
408 int *ncolumn, /* Number of result columns written here */
409 char **errmsg, /* Error msg written here */
410 ... /* Arguments to the format string */
411);
danielk19776f8a5032004-05-10 10:34:51 +0000412int sqlite3_get_table_vprintf(
drha18c5682000-10-08 22:20:57 +0000413 sqlite*, /* An open database */
drh9f71c2e2001-11-03 23:57:09 +0000414 const char *sqlFormat, /* printf-style format string for the SQL */
drha18c5682000-10-08 22:20:57 +0000415 char ***resultp, /* Result written to a char *[] that this points to */
416 int *nrow, /* Number of result rows written here */
417 int *ncolumn, /* Number of result columns written here */
418 char **errmsg, /* Error msg written here */
419 va_list ap /* Arguments to the format string */
420);
danielk19776f8a5032004-05-10 10:34:51 +0000421char *sqlite3_mprintf(const char*,...);
422char *sqlite3_vmprintf(const char*, va_list);
drha18c5682000-10-08 22:20:57 +0000423
drh8e0a2f92002-02-23 23:45:45 +0000424/*
drh5191b7e2002-03-08 02:12:00 +0000425** Windows systems should call this routine to free memory that
danielk19776f8a5032004-05-10 10:34:51 +0000426** is returned in the in the errmsg parameter of sqlite3_open() when
drh5191b7e2002-03-08 02:12:00 +0000427** SQLite is a DLL. For some reason, it does not work to call free()
428** directly.
429*/
danielk19776f8a5032004-05-10 10:34:51 +0000430void sqlite3_freemem(void *p);
drh5191b7e2002-03-08 02:12:00 +0000431
432/*
danielk19776f8a5032004-05-10 10:34:51 +0000433** Windows systems need functions to call to return the sqlite3_version
434** and sqlite3_encoding strings.
drh5191b7e2002-03-08 02:12:00 +0000435*/
danielk19776f8a5032004-05-10 10:34:51 +0000436const char *sqlite3_libversion(void);
437const char *sqlite3_libencoding(void);
drh5191b7e2002-03-08 02:12:00 +0000438
439/*
drh1350b032002-02-27 19:00:20 +0000440** A pointer to the following structure is used to communicate with
441** the implementations of user-defined functions.
442*/
443typedef struct sqlite_func sqlite_func;
444
445/*
drh8e0a2f92002-02-23 23:45:45 +0000446** Use the following routines to create new user-defined functions. See
447** the documentation for details.
448*/
danielk19776f8a5032004-05-10 10:34:51 +0000449int sqlite3_create_function(
drh1350b032002-02-27 19:00:20 +0000450 sqlite*, /* Database where the new function is registered */
451 const char *zName, /* Name of the new function */
452 int nArg, /* Number of arguments. -1 means any number */
453 void (*xFunc)(sqlite_func*,int,const char**), /* C code to implement */
danielk19776f8a5032004-05-10 10:34:51 +0000454 void *pUserData /* Available via the sqlite3_user_data() call */
drh8e0a2f92002-02-23 23:45:45 +0000455);
danielk19776f8a5032004-05-10 10:34:51 +0000456int sqlite3_create_aggregate(
drh1350b032002-02-27 19:00:20 +0000457 sqlite*, /* Database where the new function is registered */
458 const char *zName, /* Name of the function */
459 int nArg, /* Number of arguments */
460 void (*xStep)(sqlite_func*,int,const char**), /* Called for each row */
461 void (*xFinalize)(sqlite_func*), /* Called once to get final result */
danielk19776f8a5032004-05-10 10:34:51 +0000462 void *pUserData /* Available via the sqlite3_user_data() call */
drh8e0a2f92002-02-23 23:45:45 +0000463);
464
465/*
drhc9b84a12002-06-20 11:36:48 +0000466** Use the following routine to define the datatype returned by a
467** user-defined function. The second argument can be one of the
468** constants SQLITE_NUMERIC, SQLITE_TEXT, or SQLITE_ARGS or it
drh268380c2004-02-25 13:47:31 +0000469** can be an integer greater than or equal to zero. When the datatype
470** parameter is non-negative, the type of the result will be the
471** same as the datatype-th argument. If datatype==SQLITE_NUMERIC
472** then the result is always numeric. If datatype==SQLITE_TEXT then
473** the result is always text. If datatype==SQLITE_ARGS then the result
474** is numeric if any argument is numeric and is text otherwise.
drhc9b84a12002-06-20 11:36:48 +0000475*/
danielk19776f8a5032004-05-10 10:34:51 +0000476int sqlite3_function_type(
drhc9b84a12002-06-20 11:36:48 +0000477 sqlite *db, /* The database there the function is registered */
478 const char *zName, /* Name of the function */
479 int datatype /* The datatype for this function */
480);
481#define SQLITE_NUMERIC (-1)
482#define SQLITE_TEXT (-2)
483#define SQLITE_ARGS (-3)
484
485/*
drh8e0a2f92002-02-23 23:45:45 +0000486** The user function implementations call one of the following four routines
487** in order to return their results. The first parameter to each of these
drhdd5baa92002-02-27 19:50:59 +0000488** routines is a copy of the first argument to xFunc() or xFinialize().
drh1350b032002-02-27 19:00:20 +0000489** The second parameter to these routines is the result to be returned.
danielk19776f8a5032004-05-10 10:34:51 +0000490** A NULL can be passed as the second parameter to sqlite3_set_result_string()
drh1350b032002-02-27 19:00:20 +0000491** in order to return a NULL result.
drh8e0a2f92002-02-23 23:45:45 +0000492**
493** The 3rd argument to _string and _error is the number of characters to
494** take from the string. If this argument is negative, then all characters
495** up to and including the first '\000' are used.
drh1350b032002-02-27 19:00:20 +0000496**
danielk19776f8a5032004-05-10 10:34:51 +0000497** The sqlite3_set_result_string() function allocates a buffer to hold the
drh1350b032002-02-27 19:00:20 +0000498** result and returns a pointer to this buffer. The calling routine
499** (that is, the implmentation of a user function) can alter the content
500** of this buffer if desired.
drh8e0a2f92002-02-23 23:45:45 +0000501*/
danielk19776f8a5032004-05-10 10:34:51 +0000502char *sqlite3_set_result_string(sqlite_func*,const char*,int);
503void sqlite3_set_result_int(sqlite_func*,int);
504void sqlite3_set_result_double(sqlite_func*,double);
505void sqlite3_set_result_error(sqlite_func*,const char*,int);
drh1350b032002-02-27 19:00:20 +0000506
507/*
danielk19776f8a5032004-05-10 10:34:51 +0000508** The pUserData parameter to the sqlite3_create_function() and
509** sqlite3_create_aggregate() routines used to register user functions
drh1350b032002-02-27 19:00:20 +0000510** is available to the implementation of the function using this
511** call.
512*/
danielk19776f8a5032004-05-10 10:34:51 +0000513void *sqlite3_user_data(sqlite_func*);
drh1350b032002-02-27 19:00:20 +0000514
515/*
drhdd5baa92002-02-27 19:50:59 +0000516** Aggregate functions use the following routine to allocate
517** a structure for storing their state. The first time this routine
drh1350b032002-02-27 19:00:20 +0000518** is called for a particular aggregate, a new structure of size nBytes
519** is allocated, zeroed, and returned. On subsequent calls (for the
520** same aggregate instance) the same buffer is returned. The implementation
521** of the aggregate can use the returned buffer to accumulate data.
522**
523** The buffer allocated is freed automatically be SQLite.
524*/
danielk19776f8a5032004-05-10 10:34:51 +0000525void *sqlite3_aggregate_context(sqlite_func*, int nBytes);
drh1350b032002-02-27 19:00:20 +0000526
527/*
drhdd5baa92002-02-27 19:50:59 +0000528** The next routine returns the number of calls to xStep for a particular
529** aggregate function instance. The current call to xStep counts so this
530** routine always returns at least 1.
drh1350b032002-02-27 19:00:20 +0000531*/
danielk19776f8a5032004-05-10 10:34:51 +0000532int sqlite3_aggregate_count(sqlite_func*);
drh8e0a2f92002-02-23 23:45:45 +0000533
drh411995d2002-06-25 19:31:18 +0000534/*
drhed6c8672003-01-12 18:02:16 +0000535** This routine registers a callback with the SQLite library. The
drhb86ccfb2003-01-28 23:13:10 +0000536** callback is invoked (at compile-time, not at run-time) for each
537** attempt to access a column of a table in the database. The callback
538** returns SQLITE_OK if access is allowed, SQLITE_DENY if the entire
539** SQL statement should be aborted with an error and SQLITE_IGNORE
540** if the column should be treated as a NULL value.
drhed6c8672003-01-12 18:02:16 +0000541*/
danielk19776f8a5032004-05-10 10:34:51 +0000542int sqlite3_set_authorizer(
drhed6c8672003-01-12 18:02:16 +0000543 sqlite*,
drhe22a3342003-04-22 20:30:37 +0000544 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
drhe5f9c642003-01-13 23:27:31 +0000545 void *pUserData
drhed6c8672003-01-12 18:02:16 +0000546);
547
548/*
549** The second parameter to the access authorization function above will
drhe5f9c642003-01-13 23:27:31 +0000550** be one of the values below. These values signify what kind of operation
551** is to be authorized. The 3rd and 4th parameters to the authorization
552** function will be parameters or NULL depending on which of the following
drhe22a3342003-04-22 20:30:37 +0000553** codes is used as the second parameter. The 5th parameter is the name
554** of the database ("main", "temp", etc.) if applicable. The 6th parameter
drh5cf590c2003-04-24 01:45:04 +0000555** is the name of the inner-most trigger or view that is responsible for
556** the access attempt or NULL if this access attempt is directly from
557** input SQL code.
drhe5f9c642003-01-13 23:27:31 +0000558**
559** Arg-3 Arg-4
drhed6c8672003-01-12 18:02:16 +0000560*/
drh77ad4e42003-01-14 02:49:27 +0000561#define SQLITE_COPY 0 /* Table Name File Name */
drhe5f9c642003-01-13 23:27:31 +0000562#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */
563#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */
564#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */
565#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000566#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000567#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000568#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000569#define SQLITE_CREATE_VIEW 8 /* View Name NULL */
570#define SQLITE_DELETE 9 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000571#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000572#define SQLITE_DROP_TABLE 11 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000573#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000574#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000575#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000576#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000577#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000578#define SQLITE_DROP_VIEW 17 /* View Name NULL */
579#define SQLITE_INSERT 18 /* Table Name NULL */
580#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */
581#define SQLITE_READ 20 /* Table Name Column Name */
582#define SQLITE_SELECT 21 /* NULL NULL */
583#define SQLITE_TRANSACTION 22 /* NULL NULL */
584#define SQLITE_UPDATE 23 /* Table Name Column Name */
drh81e293b2003-06-06 19:00:42 +0000585#define SQLITE_ATTACH 24 /* Filename NULL */
586#define SQLITE_DETACH 25 /* Database Name NULL */
587
drhed6c8672003-01-12 18:02:16 +0000588
589/*
590** The return value of the authorization function should be one of the
591** following constants:
592*/
593/* #define SQLITE_OK 0 // Allow access (This is actually defined above) */
594#define SQLITE_DENY 1 /* Abort the SQL statement with an error */
595#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
596
597/*
danielk19776f8a5032004-05-10 10:34:51 +0000598** Register a function that is called at every invocation of sqlite3_exec()
danielk19774ad17132004-05-21 01:47:26 +0000599** or sqlite3_prepare(). This function can be used (for example) to generate
drhb86ccfb2003-01-28 23:13:10 +0000600** a log file of all SQL executed against a database.
drh18de4822003-01-16 16:28:53 +0000601*/
danielk19776f8a5032004-05-10 10:34:51 +0000602void *sqlite3_trace(sqlite*, void(*xTrace)(void*,const char*), void*);
drh18de4822003-01-16 16:28:53 +0000603
drhb86ccfb2003-01-28 23:13:10 +0000604/*** The Callback-Free API
605**
606** The following routines implement a new way to access SQLite that does not
607** involve the use of callbacks.
608**
609** An sqlite_vm is an opaque object that represents a single SQL statement
610** that is ready to be executed.
611*/
612typedef struct sqlite_vm sqlite_vm;
613
614/*
615** To execute an SQLite query without the use of callbacks, you first have
616** to compile the SQL using this routine. The 1st parameter "db" is a pointer
danielk19776f8a5032004-05-10 10:34:51 +0000617** to an sqlite object obtained from sqlite3_open(). The 2nd parameter
drhb86ccfb2003-01-28 23:13:10 +0000618** "zSql" is the text of the SQL to be compiled. The remaining parameters
619** are all outputs.
620**
621** *pzTail is made to point to the first character past the end of the first
622** SQL statement in zSql. This routine only compiles the first statement
623** in zSql, so *pzTail is left pointing to what remains uncompiled.
624**
625** *ppVm is left pointing to a "virtual machine" that can be used to execute
626** the compiled statement. Or if there is an error, *ppVm may be set to NULL.
drh326dce72003-01-29 14:06:07 +0000627** If the input text contained no SQL (if the input is and empty string or
628** a comment) then *ppVm is set to NULL.
drhb86ccfb2003-01-28 23:13:10 +0000629**
630** If any errors are detected during compilation, an error message is written
631** into space obtained from malloc() and *pzErrMsg is made to point to that
632** error message. The calling routine is responsible for freeing the text
danielk19776f8a5032004-05-10 10:34:51 +0000633** of this message when it has finished with it. Use sqlite3_freemem() to
drhb86ccfb2003-01-28 23:13:10 +0000634** free the message. pzErrMsg may be NULL in which case no error message
635** will be generated.
636**
637** On success, SQLITE_OK is returned. Otherwise and error code is returned.
638*/
danielk19776f8a5032004-05-10 10:34:51 +0000639int sqlite3_compile(
drhb86ccfb2003-01-28 23:13:10 +0000640 sqlite *db, /* The open database */
641 const char *zSql, /* SQL statement to be compiled */
642 const char **pzTail, /* OUT: uncompiled tail of zSql */
643 sqlite_vm **ppVm, /* OUT: the virtual machine to execute zSql */
644 char **pzErrmsg /* OUT: Error message. */
645);
646
647/*
648** After an SQL statement has been compiled, it is handed to this routine
649** to be executed. This routine executes the statement as far as it can
650** go then returns. The return value will be one of SQLITE_DONE,
651** SQLITE_ERROR, SQLITE_BUSY, SQLITE_ROW, or SQLITE_MISUSE.
652**
653** SQLITE_DONE means that the execute of the SQL statement is complete
danielk19776f8a5032004-05-10 10:34:51 +0000654** an no errors have occurred. sqlite3_step() should not be called again
drhb86ccfb2003-01-28 23:13:10 +0000655** for the same virtual machine. *pN is set to the number of columns in
656** the result set and *pazColName is set to an array of strings that
657** describe the column names and datatypes. The name of the i-th column
658** is (*pazColName)[i] and the datatype of the i-th column is
659** (*pazColName)[i+*pN]. *pazValue is set to NULL.
660**
661** SQLITE_ERROR means that the virtual machine encountered a run-time
danielk19776f8a5032004-05-10 10:34:51 +0000662** error. sqlite3_step() should not be called again for the same
drhb86ccfb2003-01-28 23:13:10 +0000663** virtual machine. *pN is set to 0 and *pazColName and *pazValue are set
danielk19776f8a5032004-05-10 10:34:51 +0000664** to NULL. Use sqlite3_finalize() to obtain the specific error code
drhb86ccfb2003-01-28 23:13:10 +0000665** and the error message text for the error.
666**
667** SQLITE_BUSY means that an attempt to open the database failed because
668** another thread or process is holding a lock. The calling routine
danielk19776f8a5032004-05-10 10:34:51 +0000669** can try again to open the database by calling sqlite3_step() again.
drhb86ccfb2003-01-28 23:13:10 +0000670** The return code will only be SQLITE_BUSY if no busy handler is registered
danielk19776f8a5032004-05-10 10:34:51 +0000671** using the sqlite3_busy_handler() or sqlite3_busy_timeout() routines. If
drhb86ccfb2003-01-28 23:13:10 +0000672** a busy handler callback has been registered but returns 0, then this
673** routine will return SQLITE_ERROR and sqltie_finalize() will return
674** SQLITE_BUSY when it is called.
675**
676** SQLITE_ROW means that a single row of the result is now available.
677** The data is contained in *pazValue. The value of the i-th column is
678** (*azValue)[i]. *pN and *pazColName are set as described in SQLITE_DONE.
danielk19776f8a5032004-05-10 10:34:51 +0000679** Invoke sqlite3_step() again to advance to the next row.
drhb86ccfb2003-01-28 23:13:10 +0000680**
danielk19776f8a5032004-05-10 10:34:51 +0000681** SQLITE_MISUSE is returned if sqlite3_step() is called incorrectly.
682** For example, if you call sqlite3_step() after the virtual machine
683** has halted (after a prior call to sqlite3_step() has returned SQLITE_DONE)
684** or if you call sqlite3_step() with an incorrectly initialized virtual
drhb86ccfb2003-01-28 23:13:10 +0000685** machine or a virtual machine that has been deleted or that is associated
686** with an sqlite structure that has been closed.
687*/
danielk19776f8a5032004-05-10 10:34:51 +0000688int sqlite3_step(
drhb86ccfb2003-01-28 23:13:10 +0000689 sqlite_vm *pVm, /* The virtual machine to execute */
690 int *pN, /* OUT: Number of columns in result */
691 const char ***pazValue, /* OUT: Column data */
692 const char ***pazColName /* OUT: Column names and datatypes */
693);
694
695/*
696** This routine is called to delete a virtual machine after it has finished
697** executing. The return value is the result code. SQLITE_OK is returned
698** if the statement executed successfully and some other value is returned if
699** there was any kind of error. If an error occurred and pzErrMsg is not
700** NULL, then an error message is written into memory obtained from malloc()
701** and *pzErrMsg is made to point to that error message. The calling routine
danielk19776f8a5032004-05-10 10:34:51 +0000702** should use sqlite3_freemem() to delete this message when it has finished
drhb86ccfb2003-01-28 23:13:10 +0000703** with it.
704**
705** This routine can be called at any point during the execution of the
706** virtual machine. If the virtual machine has not completed execution
707** when this routine is called, that is like encountering an error or
danielk19776f8a5032004-05-10 10:34:51 +0000708** an interrupt. (See sqlite3_interrupt().) Incomplete updates may be
drhb86ccfb2003-01-28 23:13:10 +0000709** rolled back and transactions cancelled, depending on the circumstances,
710** and the result code returned will be SQLITE_ABORT.
711*/
danielk19776f8a5032004-05-10 10:34:51 +0000712int sqlite3_finalize(sqlite_vm*, char **pzErrMsg);
drhb86ccfb2003-01-28 23:13:10 +0000713
danielk1977999af642003-07-22 09:24:43 +0000714/*
715** This routine deletes the virtual machine, writes any error message to
716** *pzErrMsg and returns an SQLite return code in the same way as the
danielk19776f8a5032004-05-10 10:34:51 +0000717** sqlite3_finalize() function.
danielk1977999af642003-07-22 09:24:43 +0000718**
719** Additionally, if ppVm is not NULL, *ppVm is left pointing to a new virtual
720** machine loaded with the compiled version of the original query ready for
721** execution.
722**
danielk19776f8a5032004-05-10 10:34:51 +0000723** If sqlite3_reset() returns SQLITE_SCHEMA, then *ppVm is set to NULL.
danielk1977999af642003-07-22 09:24:43 +0000724**
drh7c972de2003-09-06 22:18:07 +0000725******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
drh50457892003-09-06 01:10:47 +0000726*/
danielk19776f8a5032004-05-10 10:34:51 +0000727int sqlite3_reset(sqlite_vm*, char **pzErrMsg);
drh50457892003-09-06 01:10:47 +0000728
729/*
danielk19774ad17132004-05-21 01:47:26 +0000730** If the SQL that was handed to sqlite3_prepare contains variables that
drh7c972de2003-09-06 22:18:07 +0000731** are represeted in the SQL text by a question mark ('?'). This routine
732** is used to assign values to those variables.
733**
danielk19774ad17132004-05-21 01:47:26 +0000734** The first parameter is a virtual machine obtained from sqlite3_prepare().
drh7c972de2003-09-06 22:18:07 +0000735** The 2nd "idx" parameter determines which variable in the SQL statement
736** to bind the value to. The left most '?' is 1. The 3rd parameter is
737** the value to assign to that variable. The 4th parameter is the number
738** of bytes in the value, including the terminating \000 for strings.
739** Finally, the 5th "copy" parameter is TRUE if SQLite should make its
740** own private copy of this value, or false if the space that the 3rd
741** parameter points to will be unchanging and can be used directly by
742** SQLite.
743**
744** Unbound variables are treated as having a value of NULL. To explicitly
745** set a variable to NULL, call this routine with the 3rd parameter as a
746** NULL pointer.
747**
748** If the 4th "len" parameter is -1, then strlen() is used to find the
749** length.
drh50457892003-09-06 01:10:47 +0000750**
danielk19774ad17132004-05-21 01:47:26 +0000751** This routine can only be called immediately after sqlite3_prepare()
danielk19776f8a5032004-05-10 10:34:51 +0000752** or sqlite3_reset() and before any calls to sqlite3_step().
drh50457892003-09-06 01:10:47 +0000753**
danielk1977999af642003-07-22 09:24:43 +0000754******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
755*/
danielk19776f8a5032004-05-10 10:34:51 +0000756int sqlite3_bind(sqlite_vm*, int idx, const char *value, int len, int copy);
danielk1977999af642003-07-22 09:24:43 +0000757
danielk1977348bb5d2003-10-18 09:37:26 +0000758/*
759** This routine configures a callback function - the progress callback - that
danielk19776f8a5032004-05-10 10:34:51 +0000760** is invoked periodically during long running calls to sqlite3_exec(),
761** sqlite3_step() and sqlite3_get_table(). An example use for this API is to keep
danielk1977348bb5d2003-10-18 09:37:26 +0000762** a GUI updated during a large query.
763**
764** The progress callback is invoked once for every N virtual machine opcodes,
765** where N is the second argument to this function. The progress callback
766** itself is identified by the third argument to this function. The fourth
767** argument to this function is a void pointer passed to the progress callback
768** function each time it is invoked.
769**
danielk19776f8a5032004-05-10 10:34:51 +0000770** If a call to sqlite3_exec(), sqlite3_step() or sqlite3_get_table() results
danielk1977348bb5d2003-10-18 09:37:26 +0000771** in less than N opcodes being executed, then the progress callback is not
772** invoked.
773**
774** Calling this routine overwrites any previously installed progress callback.
775** To remove the progress callback altogether, pass NULL as the third
776** argument to this function.
777**
778** If the progress callback returns a result other than 0, then the current
779** query is immediately terminated and any database changes rolled back. If the
780** query was part of a larger transaction, then the transaction is not rolled
danielk19776f8a5032004-05-10 10:34:51 +0000781** back and remains active. The sqlite3_exec() call returns SQLITE_ABORT.
drhaa940ea2004-01-15 02:44:03 +0000782**
783******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
danielk1977348bb5d2003-10-18 09:37:26 +0000784*/
danielk19776f8a5032004-05-10 10:34:51 +0000785void sqlite3_progress_handler(sqlite*, int, int(*)(void*), void*);
danielk1977348bb5d2003-10-18 09:37:26 +0000786
drhaa940ea2004-01-15 02:44:03 +0000787/*
788** Register a callback function to be invoked whenever a new transaction
789** is committed. The pArg argument is passed through to the callback.
790** callback. If the callback function returns non-zero, then the commit
791** is converted into a rollback.
792**
793** If another function was previously registered, its pArg value is returned.
794** Otherwise NULL is returned.
795**
796** Registering a NULL function disables the callback.
797**
798******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
799*/
danielk19776f8a5032004-05-10 10:34:51 +0000800void *sqlite3_commit_hook(sqlite*, int(*)(void*), void*);
drhaa940ea2004-01-15 02:44:03 +0000801
drh22fbcb82004-02-01 01:22:50 +0000802/*
803** Open an encrypted SQLite database. If pKey==0 or nKey==0, this routine
danielk19776f8a5032004-05-10 10:34:51 +0000804** is the same as sqlite3_open().
drh22fbcb82004-02-01 01:22:50 +0000805**
806** The code to implement this API is not available in the public release
807** of SQLite.
808*/
danielk19776f8a5032004-05-10 10:34:51 +0000809sqlite *sqlite3_open_encrypted(
drh22fbcb82004-02-01 01:22:50 +0000810 const char *zFilename, /* Name of the encrypted database */
811 const void *pKey, /* Pointer to the key */
812 int nKey, /* Number of bytes in the key */
drhe384a4e2004-02-12 20:49:36 +0000813 int *pErrcode, /* Write error code here */
drh22fbcb82004-02-01 01:22:50 +0000814 char **pzErrmsg /* Write error message here */
815);
816
817/*
818** Change the key on an open database. If the current database is not
819** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the
820** database is decrypted.
821**
822** The code to implement this API is not available in the public release
823** of SQLite.
824*/
825int sqlite_rekey(
826 sqlite *db, /* Database to be rekeyed */
827 const void *pKey, int nKey /* The new key */
828);
829
drh6ff15d02004-03-14 22:12:34 +0000830/*
831** Encode a binary buffer "in" of size n bytes so that it contains
832** no instances of characters '\'' or '\000'. The output is
833** null-terminated and can be used as a string value in an INSERT
834** or UPDATE statement. Use sqlite_decode_binary() to convert the
835** string back into its original binary.
836**
837** The result is written into a preallocated output buffer "out".
838** "out" must be able to hold at least 2 +(257*n)/254 bytes.
839** In other words, the output will be expanded by as much as 3
840** bytes for every 254 bytes of input plus 2 bytes of fixed overhead.
841** (This is approximately 2 + 1.0118*n or about a 1.2% size increase.)
842**
843** The return value is the number of characters in the encoded
844** string, excluding the "\000" terminator.
845**
846** If out==NULL then no output is generated but the routine still returns
847** the number of characters that would have been generated if out had
848** not been NULL.
849*/
850int sqlite_encode_binary(const unsigned char *in, int n, unsigned char *out);
851
852/*
853** Decode the string "in" into binary data and write it into "out".
854** This routine reverses the encoding created by sqlite_encode_binary().
855** The output will always be a few bytes less than the input. The number
856** of bytes of output is returned. If the input is not a well-formed
857** encoding, -1 is returned.
858**
859** The "in" and "out" parameters may point to the same buffer in order
860** to decode a string in place.
861*/
862int sqlite_decode_binary(const unsigned char *in, unsigned char *out);
863
danielk19776622cce2004-05-20 11:00:52 +0000864
865/* FIX ME */
danielk1977295ba552004-05-19 10:34:51 +0000866typedef sqlite_vm sqlite3_stmt;
danielk19776622cce2004-05-20 11:00:52 +0000867typedef sqlite sqlite3;
danielk1977295ba552004-05-19 10:34:51 +0000868
danielk1977e3209e42004-05-20 01:40:18 +0000869/*
870** This routine is used to bind a 32-bit integer value to a variable
danielk19774ad17132004-05-21 01:47:26 +0000871** in an SQL statement compiled by sqlite3_prepare(). See comments for
872** sqlite3_prepare() for more details on SQL statement variables.
danielk1977e3209e42004-05-20 01:40:18 +0000873**
874** The first argument is a pointer to an SQL statement previously
danielk19774ad17132004-05-21 01:47:26 +0000875** obtained from a call to sqlite3_prepare(). The second parameter "i"
danielk1977e3209e42004-05-20 01:40:18 +0000876** determines the parameter to bind the value "iValue" to.
877*/
danielk1977295ba552004-05-19 10:34:51 +0000878int sqlite3_bind_int32(sqlite3_stmt*, int i, int iValue);
danielk1977e3209e42004-05-20 01:40:18 +0000879
880/*
881** This routine is used to bind a 64-bit integer value to a variable
danielk19774ad17132004-05-21 01:47:26 +0000882** in an SQL statement compiled by sqlite3_prepare(). See comments for
883** sqlite3_prepare() for more details on SQL statement variables.
danielk1977e3209e42004-05-20 01:40:18 +0000884**
885** The first argument is a pointer to an SQL statement previously
danielk19774ad17132004-05-21 01:47:26 +0000886** obtained from a call to sqlite3_prepare(). The second parameter "i"
danielk1977e3209e42004-05-20 01:40:18 +0000887** determines the parameter to bind the value "iValue" to.
888*/
danielk1977295ba552004-05-19 10:34:51 +0000889int sqlite3_bind_int64(sqlite3_stmt*, int i, long long int iValue);
danielk1977e3209e42004-05-20 01:40:18 +0000890
891/*
892** This routine is used to bind a real (floating point) value to a variable
danielk19774ad17132004-05-21 01:47:26 +0000893** in an SQL statement compiled by sqlite3_prepare(). See comments for
894** sqlite3_prepare() for more details on SQL statement variables.
danielk1977e3209e42004-05-20 01:40:18 +0000895**
896** The first argument is a pointer to an SQL statement previously obtained
danielk19774ad17132004-05-21 01:47:26 +0000897** from a call to sqlite3_prepare(). The second parameter "i" determines
danielk1977e3209e42004-05-20 01:40:18 +0000898** the parameter to bind the value "iValue" to. Internally, SQLite will
899** manipulate the value as a 64-bit IEEE float.
900*/
danielk1977295ba552004-05-19 10:34:51 +0000901int sqlite3_bind_double(sqlite3_stmt*, int i, double iValue);
danielk1977e3209e42004-05-20 01:40:18 +0000902
903/*
904** This routine is used to bind a NULL value to a variable in an SQL
danielk19774ad17132004-05-21 01:47:26 +0000905** statement compiled by sqlite3_prepare(). See comments for
906** sqlite3_prepare() for more details on SQL statement variables.
danielk1977e3209e42004-05-20 01:40:18 +0000907**
908** The first argument is a pointer to an SQL statement previously obtained
danielk19774ad17132004-05-21 01:47:26 +0000909** from a call to sqlite3_prepare(). The second parameter "i" determines
danielk1977e3209e42004-05-20 01:40:18 +0000910** the parameter to bind the NULL value to.
911*/
danielk1977295ba552004-05-19 10:34:51 +0000912int sqlite3_bind_null(sqlite3_stmt*, int i);
danielk1977e3209e42004-05-20 01:40:18 +0000913
914/*
915** This routine is used to bind a UTF-8 string value to a variable in an
danielk19774ad17132004-05-21 01:47:26 +0000916** SQL statement compiled by sqlite3_prepare(). See comments for
917** sqlite3_prepare() for more details on SQL statement variables.
danielk1977e3209e42004-05-20 01:40:18 +0000918**
919** The first argument is a pointer to an SQL statement previously obtained
danielk19774ad17132004-05-21 01:47:26 +0000920** from a call to sqlite3_prepare(). The second parameter "i" determines
danielk1977e3209e42004-05-20 01:40:18 +0000921** the parameter to bind the value to. Parameter three "z" is a pointer
922** to the UTF-8 string.
923**
924** The fourth "n" parameter is the number of bytes (not characters) in the
925** string pointed to by "z". "n" may or may not include any nul terminator
926** character. If "n" is less than zero, then SQLite assumes that "z" is
927** a nul terminated string.
928**
929** If paramater "eCopy" is true, then SQLite makes a copy of the string
930** pointed to by "z". If "eCopy" is false, then SQLite stores a pointer to
931** the original string data. In this case the caller must ensure that the
932** string data remains stable until after the SQL statement has been
933** finalised or another value bound to variable "i".
934*/
935int sqlite3_bind_text(sqlite3_stmt*, int i, const char* z, int n, int eCopy);
936
937/*
938** This routine is used to bind a UTF-16 string value to a variable in an
danielk19774ad17132004-05-21 01:47:26 +0000939** SQL statement compiled by sqlite3_prepare(). See comments for
940** sqlite3_prepare() for more details on SQL statement variables.
danielk1977e3209e42004-05-20 01:40:18 +0000941**
942** The first argument is a pointer to an SQL statement previously obtained
danielk19774ad17132004-05-21 01:47:26 +0000943** from a call to sqlite3_prepare(). The second parameter "i" determines
danielk1977e3209e42004-05-20 01:40:18 +0000944** the parameter to bind the value to. Parameter three "z" is a pointer to
945** the UTF-16 string. If the string does not begin with a byte-order-mark,
946** it is assumed to be encoded in the native byte order of the machine.
947**
948** The fourth "n" parameter is the number of bytes (not characters) in the
949** string pointed to by "z". "n" may or may not include any nul terminator
950** character. If "n" is less than zero, then SQLite assumes that "z" is
951** terminated by a pair of 0x00 characters.
952**
953** If paramater "eCopy" is true, then SQLite makes a copy of the string
954** pointed to by "z". If "eCopy" is false, then SQLite stores a pointer to
955** the original string data. In this case the caller must ensure that the
956** string data remains stable until after the SQL statement has been
957** finalised or another value bound to variable "i".
958*/
959int sqlite3_bind_text16(sqlite3_stmt*, int i, const void *z, int, int eCopy);
960
961/*
962** This routine is used to bind a blob value to a variable in an
danielk19774ad17132004-05-21 01:47:26 +0000963** SQL statement compiled by sqlite3_prepare(). See comments for
964** sqlite3_prepare() for more details on SQL statement variables.
danielk1977e3209e42004-05-20 01:40:18 +0000965**
966** The first argument is a pointer to an SQL statement previously obtained
danielk19774ad17132004-05-21 01:47:26 +0000967** from a call to sqlite3_prepare(). The second parameter "i" determines
danielk1977e3209e42004-05-20 01:40:18 +0000968** the parameter to bind the value to. Parameter three "z" is a pointer to
969** the blob of data.
970**
971** The fourth "n" parameter is the number of bytes in the blob pointed to
972** by "z". "n" may not be less than zero.
973**
974** If paramater "eCopy" is true, then SQLite makes a copy of the blob
975** pointed to by "z". If "eCopy" is false, then SQLite stores a pointer to
976** the original blob data. In this case the caller must ensure that the
977** blob data remains stable until after the SQL statement has been
978** finalised or another value bound to variable "i".
979*/
980int sqlite3_bind_blob(sqlite3_stmt*, int i, const void *z, int n, int eCopy);
981
danielk19776622cce2004-05-20 11:00:52 +0000982/*
983** Return the error code for the most recent sqlite3_* API call associated
984** with sqlite3 handle 'db'. SQLITE_OK is returned if the most recent
985** API call was successful.
986**
987** Calls to many sqlite3_* functions set the error code and string returned
988** by sqlite3_errcode(), sqlite3_errmsg() and sqlite3_errmsg16()
989** (overwriting the previous values). A complete list of functions that set
990** the error code and string returned by these functions follows. Note that
991** calls to sqlite3_errcode(), sqlite3_errmsg() and sqlite3_errmsg16()
992** themselves do not affect the results of future invocations.
993**
994** sqlite3_bind_int32
995** sqlite3_bind_int64
996** sqlite3_bind_double
997** sqlite3_bind_null
998** sqlite3_bind_text
999** sqlite3_bind_text16
1000** sqlite3_bind_blob
danielk1977106bb232004-05-21 10:08:53 +00001001** sqlite3_open
1002** sqlite3_open16
1003** sqlite3_prepare
1004** sqlite3_prepare16
1005** sqlite3_step
1006** sqlite3_finalize
danielk19776622cce2004-05-20 11:00:52 +00001007**
1008** Assuming no other intervening sqlite3_* API calls are made, the error
1009** code returned by this function is associated with the same error as
1010** the strings returned by sqlite3_errmsg() and sqlite3_errmsg16().
1011*/
1012int sqlite3_errcode(sqlite3 *db);
danielk19774adee202004-05-08 08:23:19 +00001013
1014/*
danielk19776622cce2004-05-20 11:00:52 +00001015** Return a pointer to a UTF-8 encoded string describing in english the
1016** error condition for the most recent sqlite3_* API call. The returned
1017** string is always terminated by an 0x00 byte.
1018**
1019** The string "not an error" is returned when the most recent API call was
1020** successful.
danielk19774adee202004-05-08 08:23:19 +00001021*/
danielk19776622cce2004-05-20 11:00:52 +00001022const char *sqlite3_errmsg(sqlite3*);
danielk19774adee202004-05-08 08:23:19 +00001023
danielk19776622cce2004-05-20 11:00:52 +00001024/*
1025** Return a pointer to a UTF-16 native byte order encoded string describing
1026** in english the error condition for the most recent sqlite3_* API call.
1027** The returned string is always terminated by a pair of 0x00 bytes.
1028**
1029** The string "not an error" is returned when the most recent API call was
1030** successful.
1031*/
1032const void *sqlite3_errmsg16(sqlite3*);
1033
danielk19774ad17132004-05-21 01:47:26 +00001034/*
1035** To execute an SQL query, it must first be compiled into a byte-code
1036** program using this routine. The first parameter "db" is an SQLite
1037** database handle. The second parameter "zSql" is the statement
1038** to be compiled, encoded as UTF-8 text. If the next parameter, "nBytes",
1039** is less than zero, then zSql is read up to the first nul terminator.
1040** If "nBytes" is not less than zero, then it is the length of the
danielk1977106bb232004-05-21 10:08:53 +00001041** string zSql in bytes (not characters).
danielk19774ad17132004-05-21 01:47:26 +00001042**
danielk1977106bb232004-05-21 10:08:53 +00001043** *pzTail is made to point to the first byte past the end of the first
danielk19774ad17132004-05-21 01:47:26 +00001044** SQL statement in zSql. This routine only compiles the first statement
1045** in zSql, so *pzTail is left pointing to what remains uncompiled.
1046**
1047** *ppStmt is left pointing to a compiled SQL statement that can be
1048** executed using sqlite3_step(). Or if there is an error, *ppStmt may be
1049** set to NULL. If the input text contained no SQL (if the input is and
1050** empty string or a comment) then *ppStmt is set to NULL.
1051**
1052** On success, SQLITE_OK is returned. Otherwise an error code is returned.
1053**
1054*/
danielk19776622cce2004-05-20 11:00:52 +00001055int sqlite3_prepare(
1056 sqlite3 *db, /* Database handle */
1057 const char *zSql, /* SQL statement, UTF-8 encoded */
1058 int nBytes, /* Length of zSql in bytes. */
1059 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
1060 const char **pzTail /* OUT: Pointer to unused portion of zSql */
1061);
1062
danielk1977106bb232004-05-21 10:08:53 +00001063/*
1064** To execute an SQL query, it must first be compiled into a byte-code
1065** program using this routine. The first parameter "db" is an SQLite
1066** database handle. The second parameter "zSql" is the statement
1067** to be compiled, encoded as UTF-16 text. If the next parameter, "nBytes",
1068** is less than zero, then zSql is read up to the first pair of successive
1069** 0x00 bytes. If "nBytes" is not less than zero, then it is the length of
1070** the string zSql in bytes (not characters).
1071**
1072** *pzTail is made to point to the first byte past the end of the first
1073** SQL statement in zSql. This routine only compiles the first statement
1074** in zSql, so *pzTail is left pointing to what remains uncompiled.
1075**
1076** *ppStmt is left pointing to a compiled SQL statement that can be
1077** executed using sqlite3_step(). Or if there is an error, *ppStmt may be
1078** set to NULL. If the input text contained no SQL (if the input is and
1079** empty string or a comment) then *ppStmt is set to NULL.
1080**
1081** On success, SQLITE_OK is returned. Otherwise an error code is returned.
1082**
1083*/
danielk19776622cce2004-05-20 11:00:52 +00001084int sqlite3_prepare16(
1085 sqlite3 *db, /* Database handle */
1086 const void *zSql, /* SQL statement, UTF-16 encoded */
1087 int nBytes, /* Length of zSql in bytes. */
1088 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
1089 const void **pzTail /* OUT: Pointer to unused portion of zSql */
1090);
1091
danielk1977106bb232004-05-21 10:08:53 +00001092/*
1093** Return the number of columns in the result set returned by the compiled
1094** SQL statement. This routine returns 0 if pStmt is an SQL statement
1095** that does not return data (for example an UPDATE).
1096*/
1097int sqlite3_column_count(sqlite3_stmt *pStmt);
1098
1099/*
1100** The first parameter is a compiled SQL statement. This function returns
1101** the column heading for the Nth column of that statement, where N is the
1102** second function parameter. The string returned is UTF-8 encoded.
1103*/
1104const char *sqlite3_column_name(sqlite3_stmt*,int);
1105
1106/*
1107** The first parameter is a compiled SQL statement. This function returns
1108** the column heading for the Nth column of that statement, where N is the
1109** second function parameter. The string returned is UTF-16 encoded.
1110*/
1111const void *sqlite3_column_name16(sqlite3_stmt*,int);
1112
1113/*
1114** The first parameter is a compiled SQL statement. If this statement
1115** is a SELECT statement, the Nth column of the returned result set
1116** of the SELECT is a table column then the declared type of the table
1117** column is returned. If the Nth column of the result set is not at table
1118** column, then a NULL pointer is returned. The returned string is always
1119** UTF-8 encoded. For example, in the database schema:
1120**
1121** CREATE TABLE t1(c1 VARINT);
1122**
1123** And the following statement compiled:
1124**
1125** SELECT c1 + 1, 0 FROM t1;
1126**
1127** Then this routine would return the string "VARIANT" for the second
1128** result column (i==1), and a NULL pointer for the first result column
1129** (i==0).
1130*/
1131const char *sqlite3_column_decltype(sqlite3_stmt *, int i);
1132
1133/*
1134** The first parameter is a compiled SQL statement. If this statement
1135** is a SELECT statement, the Nth column of the returned result set
1136** of the SELECT is a table column then the declared type of the table
1137** column is returned. If the Nth column of the result set is not at table
1138** column, then a NULL pointer is returned. The returned string is always
1139** UTF-16 encoded. For example, in the database schema:
1140**
1141** CREATE TABLE t1(c1 VARINT);
1142**
1143** And the following statement compiled:
1144**
1145** SELECT c1 + 1, 0 FROM t1;
1146**
1147** Then this routine would return the string "VARIANT" for the second
1148** result column (i==1), and a NULL pointer for the first result column
1149** (i==0).
1150*/
1151const void *sqlite3_column_decltype16(sqlite3_stmt*,int);
1152
1153/*
1154** After an SQL query has been compiled with a call to either
1155** sqlite3_prepare() or sqlite3_prepare16(), then this function must be
1156** called one or more times to execute the statement.
1157**
1158** The return value will be either SQLITE_BUSY, SQLITE_DONE,
1159** SQLITE_ROW, SQLITE_ERROR, or SQLITE_MISUSE.
1160**
1161** SQLITE_BUSY means that the database engine attempted to open
1162** a locked database and there is no busy callback registered.
1163** Call sqlite3_step() again to retry the open.
1164**
1165** SQLITE_DONE means that the statement has finished executing
1166** successfully. sqlite3_step() should not be called again on this virtual
1167** machine.
1168**
1169** If the SQL statement being executed returns any data, then
1170** SQLITE_ROW is returned each time a new row of data is ready
1171** for processing by the caller. The values may be accessed using
1172** the sqlite3_column_*() functions described below. sqlite3_step()
1173** is called again to retrieve the next row of data.
1174**
1175** SQLITE_ERROR means that a run-time error (such as a constraint
1176** violation) has occurred. sqlite3_step() should not be called again on
1177** the VM. More information may be found by calling sqlite3_errmsg().
1178**
1179** SQLITE_MISUSE means that the this routine was called inappropriately.
1180** Perhaps it was called on a virtual machine that had already been
1181** finalized or on one that had previously returned SQLITE_ERROR or
1182** SQLITE_DONE. Or it could be the case the the same database connection
1183** is being used simulataneously by two or more threads.
1184*/
1185int sqlite3_step_new(sqlite3_stmt*);
1186
1187
1188/*
1189** The sqlite3_finalize() function is called to delete a compiled
1190** SQL statement obtained by a previous call to sqlite3_prepare()
1191** or sqlite3_prepare16(). If the statement was executed successfully, or
1192** not executed at all, then SQLITE_OK is returned. If execution of the
1193** statement failed then an error code is returned.
1194*/
1195int sqlite3_finalize_new(sqlite3_stmt *pStmt);
1196
1197/*
1198** The sqlite3_reset() function is called to reset a compiled SQL
1199** statement obtained by a previous call to sqlite3_prepare() or
1200** sqlite3_prepare16() back to it's initial state, ready to be re-executed.
1201** Any SQL statement variables that had values bound to them using
1202** the sqlite3_bind_*() API retain their values.
1203*/
1204int sqlite3_reset_new(sqlite3_stmt *pStmt);
1205
danielk19774ad17132004-05-21 01:47:26 +00001206int sqlite3_open_new(
1207 const char *filename, /* Database filename (UTF-8) */
1208 sqlite3 **ppDb, /* OUT: SQLite db handle */
1209 const char **args /* Null terminated array of option strings */
1210);
1211
1212int sqlite3_open16(
1213 const void *filename, /* Database filename (UTF-16) */
1214 sqlite3 **ppDb, /* OUT: SQLite db handle */
1215 const char **args /* Null terminated array of option strings */
1216);
1217
danielk1977106bb232004-05-21 10:08:53 +00001218/*
1219** Return the number of values in the current row of the result set.
1220**
1221** After a call to sqlite3_step() that returns SQLITE_ROW, this routine
1222** will return the same value as the sqlite3_column_count() function.
1223** After sqlite3_step() has returned an SQLITE_DONE, SQLITE_BUSY or
1224** error code, or before sqlite3_step() has been called on a
1225** compiled SQL statement, this routine returns zero.
1226*/
1227int sqlite3_value_count(sqlite3_stmt *pStmt);
danielk19774adee202004-05-08 08:23:19 +00001228
1229#define SQLITE3_INTEGER 1
1230#define SQLITE3_FLOAT 2
1231#define SQLITE3_TEXT 3
1232#define SQLITE3_BLOB 4
1233#define SQLITE3_NULL 5
1234
danielk1977106bb232004-05-21 10:08:53 +00001235/*
1236** The first parameter is a compiled SQL statement for which the most
1237** recent call to sqlite3_step() has returned SQLITE_ROW. This routine
1238** retrieves the type of the Nth column of the current row, where
1239** N is the second function parameter.
1240**
1241** The value type is one of SQLITE3_INTEGER, SQLITE3_FLOAT, SQLITE3_TEXT,
1242** SQLITE3_BLOB and SQLITE3_NULL.
1243*/
1244int sqlite3_column_type(sqlite3_stmt *pStmt, int i);
danielk19774adee202004-05-08 08:23:19 +00001245
danielk1977106bb232004-05-21 10:08:53 +00001246/*
1247** The first parameter is a compiled SQL statement for which the most
1248** recent call to sqlite3_step() has returned SQLITE_ROW. This routine
1249** retrieves the value of the Nth column of the current row, where
1250** N is the second function parameter.
1251**
1252** The value returned depends on the type of the SQL column value, as
1253** returned by sqlite3_column_type():
1254**
1255** SQLITE3_NULL A Null pointer.
1256** SQLITE3_INTEGER String representation of the integer, UTF-8 encoded.
1257** SQLITE3_FLOAT String representation of the real, UTF-8 encoded.
1258** SQLITE3_TEXT The string UTF-8 encoded.
1259** SQLITE3_BLOB A pointer to the blob of data.
1260*/
1261const unsigned char *sqlite3_column_data(sqlite3_stmt*,int);
1262
1263/*
1264** The first parameter is a compiled SQL statement for which the most
1265** recent call to sqlite3_step() has returned SQLITE_ROW. This routine
1266** retrieves the value of the Nth column of the current row, where
1267** N is the second function parameter.
1268**
1269** The value returned depends on the type of the SQL column value, as
1270** returned by sqlite3_column_type():
1271**
1272** SQLITE3_NULL A Null pointer.
1273** SQLITE3_INTEGER String representation of the integer, UTF-16 encoded.
1274** SQLITE3_FLOAT String representation of the real, UTF-16 encoded.
1275** SQLITE3_TEXT The string UTF-16 encoded.
1276** SQLITE3_BLOB A pointer to the blob of data.
1277*/
1278const void *sqlite3_column_data16(sqlite3_stmt*,int);
1279
1280/*
1281** The first parameter is a compiled SQL statement for which the most
1282** recent call to sqlite3_step() has returned SQLITE_ROW. This routine
1283** retrieves the length of the data in bytse returned by the
1284** sqlite3_column_data() routine for the same second parameter value.
1285**
1286** If sqlite3_column_data() returns a UTF-8 string, then the length
1287** returned by this function includes the nul terminator character at the
1288** end of the UTF-8 string.
1289*/
1290int sqlite3_column_bytes(sqlite3_stmt*,int);
1291
1292/*
1293** The first parameter is a compiled SQL statement for which the most
1294** recent call to sqlite3_step() has returned SQLITE_ROW. This routine
1295** retrieves the value of the Nth column of the current row, where
1296** N is the second function parameter as an integer.
1297**
1298** SQLITE3_NULL 0
1299** SQLITE3_INTEGER The integer value.
1300** SQLITE3_FLOAT The integer component of the real (2^63 if too large)
1301** SQLITE3_TEXT Integer conversion of string, or 0
1302** SQLITE3_BLOB 0
1303*/
1304long long int sqlite3_column_int(sqlite3_stmt*,int);
1305
1306/*
1307** The first parameter is a compiled SQL statement for which the most
1308** recent call to sqlite3_step() has returned SQLITE_ROW. This routine
1309** retrieves the value of the Nth column of the current row, where
1310** N is the second function parameter as an integer.
1311**
1312** SQLITE3_NULL 0.0
1313** SQLITE3_INTEGER The value of the integer. Some rounding may occur.
1314** SQLITE3_FLOAT The value of the float.
1315** SQLITE3_TEXT Real number conversion of string, or 0.0
1316** SQLITE3_BLOB 0.0
1317*/
1318double sqlite3_column_float(sqlite3_stmt*,int);
danielk19774adee202004-05-08 08:23:19 +00001319
drh382c0242001-10-06 16:33:02 +00001320#ifdef __cplusplus
1321} /* End of the 'extern "C"' block */
1322#endif
danielk19774adee202004-05-08 08:23:19 +00001323#endif