blob: c8f0717fcee0a6bc26c057fc6c06674e232fe0c4 [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**
danielk197793d46752004-05-23 13:30:58 +000015** @(#) $Id: sqlite.h.in,v 1.71 2004/05/23 13:30:58 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/*
drh75897232000-05-29 14:26:00 +000062** A function to close the database.
63**
64** Call this function with a pointer to a structure that was previously
danielk19776f8a5032004-05-10 10:34:51 +000065** returned from sqlite3_open() and the corresponding database will by closed.
drh75897232000-05-29 14:26:00 +000066*/
danielk19776f8a5032004-05-10 10:34:51 +000067void sqlite3_close(sqlite *);
drh75897232000-05-29 14:26:00 +000068
69/*
70** The type for a callback function.
71*/
72typedef int (*sqlite_callback)(void*,int,char**, char**);
73
74/*
75** A function to executes one or more statements of SQL.
76**
77** If one or more of the SQL statements are queries, then
78** the callback function specified by the 3rd parameter is
79** invoked once for each row of the query result. This callback
80** should normally return 0. If the callback returns a non-zero
81** value then the query is aborted, all subsequent SQL statements
danielk19776f8a5032004-05-10 10:34:51 +000082** are skipped and the sqlite3_exec() function returns the SQLITE_ABORT.
drh75897232000-05-29 14:26:00 +000083**
84** The 4th parameter is an arbitrary pointer that is passed
85** to the callback function as its first parameter.
86**
87** The 2nd parameter to the callback function is the number of
drhb19a2bc2001-09-16 00:13:26 +000088** columns in the query result. The 3rd parameter to the callback
89** is an array of strings holding the values for each column.
90** The 4th parameter to the callback is an array of strings holding
91** the names of each column.
drh75897232000-05-29 14:26:00 +000092**
93** The callback function may be NULL, even for queries. A NULL
94** callback is not an error. It just means that no callback
95** will be invoked.
96**
97** If an error occurs while parsing or evaluating the SQL (but
98** not while executing the callback) then an appropriate error
99** message is written into memory obtained from malloc() and
drhb19a2bc2001-09-16 00:13:26 +0000100** *errmsg is made to point to that message. The calling function
101** is responsible for freeing the memory that holds the error
danielk19776f8a5032004-05-10 10:34:51 +0000102** message. Use sqlite3_freemem() for this. If errmsg==NULL,
drhb86ccfb2003-01-28 23:13:10 +0000103** then no error message is ever written.
drhb19a2bc2001-09-16 00:13:26 +0000104**
105** The return value is is SQLITE_OK if there are no errors and
106** some other return code if there is an error. The particular
107** return value depends on the type of error.
drh58b95762000-06-02 01:17:37 +0000108**
109** If the query could not be executed because a database file is
drh2dfbbca2000-07-28 14:32:48 +0000110** locked or busy, then this function returns SQLITE_BUSY. (This
danielk19776f8a5032004-05-10 10:34:51 +0000111** behavior can be modified somewhat using the sqlite3_busy_handler()
112** and sqlite3_busy_timeout() functions below.)
drh75897232000-05-29 14:26:00 +0000113*/
danielk19776f8a5032004-05-10 10:34:51 +0000114int sqlite3_exec(
drh75897232000-05-29 14:26:00 +0000115 sqlite*, /* An open database */
drh9f71c2e2001-11-03 23:57:09 +0000116 const char *sql, /* SQL to be executed */
drh75897232000-05-29 14:26:00 +0000117 sqlite_callback, /* Callback function */
118 void *, /* 1st argument to callback function */
119 char **errmsg /* Error msg written here */
120);
121
drh58b95762000-06-02 01:17:37 +0000122/*
danielk19776f8a5032004-05-10 10:34:51 +0000123** Return values for sqlite3_exec() and sqlite3_step()
drh58b95762000-06-02 01:17:37 +0000124*/
drh717e6402001-09-27 03:22:32 +0000125#define SQLITE_OK 0 /* Successful result */
126#define SQLITE_ERROR 1 /* SQL error or missing database */
127#define SQLITE_INTERNAL 2 /* An internal logic error in SQLite */
128#define SQLITE_PERM 3 /* Access permission denied */
129#define SQLITE_ABORT 4 /* Callback routine requested an abort */
130#define SQLITE_BUSY 5 /* The database file is locked */
131#define SQLITE_LOCKED 6 /* A table in the database is locked */
132#define SQLITE_NOMEM 7 /* A malloc() failed */
133#define SQLITE_READONLY 8 /* Attempt to write a readonly database */
drh24cd67e2004-05-10 16:18:47 +0000134#define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/
drh717e6402001-09-27 03:22:32 +0000135#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */
136#define SQLITE_CORRUPT 11 /* The database disk image is malformed */
137#define SQLITE_NOTFOUND 12 /* (Internal Only) Table or record not found */
138#define SQLITE_FULL 13 /* Insertion failed because database is full */
139#define SQLITE_CANTOPEN 14 /* Unable to open the database file */
140#define SQLITE_PROTOCOL 15 /* Database lock protocol error */
drh24cd67e2004-05-10 16:18:47 +0000141#define SQLITE_EMPTY 16 /* Database is empty */
drh717e6402001-09-27 03:22:32 +0000142#define SQLITE_SCHEMA 17 /* The database schema changed */
143#define SQLITE_TOOBIG 18 /* Too much data for one row of a table */
144#define SQLITE_CONSTRAINT 19 /* Abort due to contraint violation */
drh8aff1012001-12-22 14:49:24 +0000145#define SQLITE_MISMATCH 20 /* Data type mismatch */
drh247be432002-05-10 05:44:55 +0000146#define SQLITE_MISUSE 21 /* Library used incorrectly */
drh8766c342002-11-09 00:33:15 +0000147#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */
drhed6c8672003-01-12 18:02:16 +0000148#define SQLITE_AUTH 23 /* Authorization denied */
drh1c2d8412003-03-31 00:30:47 +0000149#define SQLITE_FORMAT 24 /* Auxiliary database format error */
danielk19776f8a5032004-05-10 10:34:51 +0000150#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */
drhc602f9a2004-02-12 19:01:04 +0000151#define SQLITE_NOTADB 26 /* File opened that is not a database file */
danielk19776f8a5032004-05-10 10:34:51 +0000152#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */
153#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */
drh717e6402001-09-27 03:22:32 +0000154
drhaf9ff332002-01-16 21:00:27 +0000155/*
156** Each entry in an SQLite table has a unique integer key. (The key is
157** the value of the INTEGER PRIMARY KEY column if there is such a column,
158** otherwise the key is generated at random. The unique key is always
159** available as the ROWID, OID, or _ROWID_ column.) The following routine
160** returns the integer key of the most recent insert in the database.
161**
162** This function is similar to the mysql_insert_id() function from MySQL.
163*/
danielk19776f8a5032004-05-10 10:34:51 +0000164int sqlite3_last_insert_rowid(sqlite*);
drhaf9ff332002-01-16 21:00:27 +0000165
drhc8d30ac2002-04-12 10:08:59 +0000166/*
167** This function returns the number of database rows that were changed
danielk19776f8a5032004-05-10 10:34:51 +0000168** (or inserted or deleted) by the most recent called sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000169**
170** All changes are counted, even if they were later undone by a
171** ROLLBACK or ABORT. Except, changes associated with creating and
172** dropping tables are not counted.
173**
danielk19776f8a5032004-05-10 10:34:51 +0000174** If a callback invokes sqlite3_exec() recursively, then the changes
drhc8d30ac2002-04-12 10:08:59 +0000175** in the inner, recursive call are counted together with the changes
176** in the outer call.
177**
178** SQLite implements the command "DELETE FROM table" without a WHERE clause
179** by dropping and recreating the table. (This is much faster than going
180** through and deleting individual elements form the table.) Because of
181** this optimization, the change count for "DELETE FROM table" will be
182** zero regardless of the number of elements that were originally in the
183** table. To get an accurate count of the number of rows deleted, use
184** "DELETE FROM table WHERE 1" instead.
185*/
danielk19776f8a5032004-05-10 10:34:51 +0000186int sqlite3_changes(sqlite*);
drhc8d30ac2002-04-12 10:08:59 +0000187
rdcf146a772004-02-25 22:51:06 +0000188/*
189** This function returns the number of database rows that were changed
danielk19776f8a5032004-05-10 10:34:51 +0000190** by the last INSERT, UPDATE, or DELETE statment executed by sqlite3_exec(),
rdcf146a772004-02-25 22:51:06 +0000191** or by the last VM to run to completion. The change count is not updated
192** by SQL statements other than INSERT, UPDATE or DELETE.
193**
194** Changes are counted, even if they are later undone by a ROLLBACK or
195** ABORT. Changes associated with trigger programs that execute as a
196** result of the INSERT, UPDATE, or DELETE statement are not counted.
197**
danielk19776f8a5032004-05-10 10:34:51 +0000198** If a callback invokes sqlite3_exec() recursively, then the changes
rdcf146a772004-02-25 22:51:06 +0000199** in the inner, recursive call are counted together with the changes
200** in the outer call.
201**
202** SQLite implements the command "DELETE FROM table" without a WHERE clause
203** by dropping and recreating the table. (This is much faster than going
204** through and deleting individual elements form the table.) Because of
205** this optimization, the change count for "DELETE FROM table" will be
206** zero regardless of the number of elements that were originally in the
207** table. To get an accurate count of the number of rows deleted, use
208** "DELETE FROM table WHERE 1" instead.
209**
210******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
211*/
danielk19776f8a5032004-05-10 10:34:51 +0000212int sqlite3_last_statement_changes(sqlite*);
rdcf146a772004-02-25 22:51:06 +0000213
drh717e6402001-09-27 03:22:32 +0000214/* If the parameter to this routine is one of the return value constants
215** defined above, then this routine returns a constant text string which
216** descripts (in English) the meaning of the return value.
217*/
danielk19776f8a5032004-05-10 10:34:51 +0000218const char *sqlite3_error_string(int);
219#define sqliteErrStr sqlite3_error_string /* Legacy. Do not use in new code. */
drh4c504392000-10-16 22:06:40 +0000220
221/* This function causes any pending database operation to abort and
222** return at its earliest opportunity. This routine is typically
drh66b89c82000-11-28 20:47:17 +0000223** called in response to a user action such as pressing "Cancel"
drh4c504392000-10-16 22:06:40 +0000224** or Ctrl-C where the user wants a long query operation to halt
225** immediately.
226*/
danielk19776f8a5032004-05-10 10:34:51 +0000227void sqlite3_interrupt(sqlite*);
drh4c504392000-10-16 22:06:40 +0000228
drheec553b2000-06-02 01:51:20 +0000229
drh75897232000-05-29 14:26:00 +0000230/* This function returns true if the given input string comprises
231** one or more complete SQL statements.
232**
233** The algorithm is simple. If the last token other than spaces
234** and comments is a semicolon, then return true. otherwise return
235** false.
236*/
danielk19776f8a5032004-05-10 10:34:51 +0000237int sqlite3_complete(const char *sql);
drh75897232000-05-29 14:26:00 +0000238
drh2dfbbca2000-07-28 14:32:48 +0000239/*
240** This routine identifies a callback function that is invoked
241** whenever an attempt is made to open a database table that is
242** currently locked by another process or thread. If the busy callback
danielk19776f8a5032004-05-10 10:34:51 +0000243** is NULL, then sqlite3_exec() returns SQLITE_BUSY immediately if
drh2dfbbca2000-07-28 14:32:48 +0000244** it finds a locked table. If the busy callback is not NULL, then
danielk19776f8a5032004-05-10 10:34:51 +0000245** sqlite3_exec() invokes the callback with three arguments. The
drh2dfbbca2000-07-28 14:32:48 +0000246** second argument is the name of the locked table and the third
247** argument is the number of times the table has been busy. If the
danielk19776f8a5032004-05-10 10:34:51 +0000248** busy callback returns 0, then sqlite3_exec() immediately returns
249** SQLITE_BUSY. If the callback returns non-zero, then sqlite3_exec()
drh2dfbbca2000-07-28 14:32:48 +0000250** tries to open the table again and the cycle repeats.
251**
252** The default busy callback is NULL.
253**
254** Sqlite is re-entrant, so the busy handler may start a new query.
255** (It is not clear why anyone would every want to do this, but it
256** is allowed, in theory.) But the busy handler may not close the
257** database. Closing the database from a busy handler will delete
258** data structures out from under the executing query and will
259** probably result in a coredump.
260*/
danielk19776f8a5032004-05-10 10:34:51 +0000261void sqlite3_busy_handler(sqlite*, int(*)(void*,const char*,int), void*);
drh2dfbbca2000-07-28 14:32:48 +0000262
263/*
264** This routine sets a busy handler that sleeps for a while when a
265** table is locked. The handler will sleep multiple times until
266** at least "ms" milleseconds of sleeping have been done. After
267** "ms" milleseconds of sleeping, the handler returns 0 which
danielk19776f8a5032004-05-10 10:34:51 +0000268** causes sqlite3_exec() to return SQLITE_BUSY.
drh2dfbbca2000-07-28 14:32:48 +0000269**
270** Calling this routine with an argument less than or equal to zero
271** turns off all busy handlers.
272*/
danielk19776f8a5032004-05-10 10:34:51 +0000273void sqlite3_busy_timeout(sqlite*, int ms);
drh2dfbbca2000-07-28 14:32:48 +0000274
drhe3710332000-09-29 13:30:53 +0000275/*
danielk19776f8a5032004-05-10 10:34:51 +0000276** This next routine is really just a wrapper around sqlite3_exec().
drhe3710332000-09-29 13:30:53 +0000277** Instead of invoking a user-supplied callback for each row of the
278** result, this routine remembers each row of the result in memory
279** obtained from malloc(), then returns all of the result after the
drha18c5682000-10-08 22:20:57 +0000280** query has finished.
281**
282** As an example, suppose the query result where this table:
283**
284** Name | Age
285** -----------------------
286** Alice | 43
287** Bob | 28
288** Cindy | 21
289**
290** If the 3rd argument were &azResult then after the function returns
drh98699b52000-10-09 12:57:00 +0000291** azResult will contain the following data:
drha18c5682000-10-08 22:20:57 +0000292**
293** azResult[0] = "Name";
294** azResult[1] = "Age";
295** azResult[2] = "Alice";
296** azResult[3] = "43";
297** azResult[4] = "Bob";
298** azResult[5] = "28";
299** azResult[6] = "Cindy";
300** azResult[7] = "21";
301**
302** Notice that there is an extra row of data containing the column
303** headers. But the *nrow return value is still 3. *ncolumn is
304** set to 2. In general, the number of values inserted into azResult
305** will be ((*nrow) + 1)*(*ncolumn).
306**
307** After the calling function has finished using the result, it should
danielk19776f8a5032004-05-10 10:34:51 +0000308** pass the result data pointer to sqlite3_free_table() in order to
drha18c5682000-10-08 22:20:57 +0000309** release the memory that was malloc-ed. Because of the way the
310** malloc() happens, the calling function must not try to call
danielk19776f8a5032004-05-10 10:34:51 +0000311** malloc() directly. Only sqlite3_free_table() is able to release
drha18c5682000-10-08 22:20:57 +0000312** the memory properly and safely.
drhe3710332000-09-29 13:30:53 +0000313**
danielk19776f8a5032004-05-10 10:34:51 +0000314** The return value of this routine is the same as from sqlite3_exec().
drhe3710332000-09-29 13:30:53 +0000315*/
danielk19776f8a5032004-05-10 10:34:51 +0000316int sqlite3_get_table(
drhe3710332000-09-29 13:30:53 +0000317 sqlite*, /* An open database */
drh9f71c2e2001-11-03 23:57:09 +0000318 const char *sql, /* SQL to be executed */
drhe3710332000-09-29 13:30:53 +0000319 char ***resultp, /* Result written to a char *[] that this points to */
320 int *nrow, /* Number of result rows written here */
321 int *ncolumn, /* Number of result columns written here */
322 char **errmsg /* Error msg written here */
323);
324
325/*
danielk19776f8a5032004-05-10 10:34:51 +0000326** Call this routine to free the memory that sqlite3_get_table() allocated.
drhe3710332000-09-29 13:30:53 +0000327*/
danielk19776f8a5032004-05-10 10:34:51 +0000328void sqlite3_free_table(char **result);
drhe3710332000-09-29 13:30:53 +0000329
drha18c5682000-10-08 22:20:57 +0000330/*
danielk19776f8a5032004-05-10 10:34:51 +0000331** The following routines are wrappers around sqlite3_exec() and
332** sqlite3_get_table(). The only difference between the routines that
drha18c5682000-10-08 22:20:57 +0000333** follow and the originals is that the second argument to the
334** routines that follow is really a printf()-style format
335** string describing the SQL to be executed. Arguments to the format
336** string appear at the end of the argument list.
337**
338** All of the usual printf formatting options apply. In addition, there
339** is a "%q" option. %q works like %s in that it substitutes a null-terminated
drh66b89c82000-11-28 20:47:17 +0000340** string from the argument list. But %q also doubles every '\'' character.
drha18c5682000-10-08 22:20:57 +0000341** %q is designed for use inside a string literal. By doubling each '\''
drh66b89c82000-11-28 20:47:17 +0000342** character it escapes that character and allows it to be inserted into
drha18c5682000-10-08 22:20:57 +0000343** the string.
344**
345** For example, so some string variable contains text as follows:
346**
347** char *zText = "It's a happy day!";
348**
349** We can use this text in an SQL statement as follows:
350**
danielk19776f8a5032004-05-10 10:34:51 +0000351** sqlite3_exec_printf(db, "INSERT INTO table VALUES('%q')",
drha18c5682000-10-08 22:20:57 +0000352** callback1, 0, 0, zText);
353**
354** Because the %q format string is used, the '\'' character in zText
355** is escaped and the SQL generated is as follows:
356**
357** INSERT INTO table1 VALUES('It''s a happy day!')
358**
359** This is correct. Had we used %s instead of %q, the generated SQL
360** would have looked like this:
361**
362** INSERT INTO table1 VALUES('It's a happy day!');
363**
364** This second example is an SQL syntax error. As a general rule you
365** should always use %q instead of %s when inserting text into a string
366** literal.
367*/
danielk19776f8a5032004-05-10 10:34:51 +0000368int sqlite3_exec_printf(
drha18c5682000-10-08 22:20:57 +0000369 sqlite*, /* An open database */
drh9f71c2e2001-11-03 23:57:09 +0000370 const char *sqlFormat, /* printf-style format string for the SQL */
drha18c5682000-10-08 22:20:57 +0000371 sqlite_callback, /* Callback function */
372 void *, /* 1st argument to callback function */
373 char **errmsg, /* Error msg written here */
374 ... /* Arguments to the format string. */
375);
danielk19776f8a5032004-05-10 10:34:51 +0000376int sqlite3_exec_vprintf(
drha18c5682000-10-08 22:20:57 +0000377 sqlite*, /* An open database */
drh9f71c2e2001-11-03 23:57:09 +0000378 const char *sqlFormat, /* printf-style format string for the SQL */
drha18c5682000-10-08 22:20:57 +0000379 sqlite_callback, /* Callback function */
380 void *, /* 1st argument to callback function */
381 char **errmsg, /* Error msg written here */
382 va_list ap /* Arguments to the format string. */
383);
danielk19776f8a5032004-05-10 10:34:51 +0000384int sqlite3_get_table_printf(
drha18c5682000-10-08 22:20:57 +0000385 sqlite*, /* An open database */
drh9f71c2e2001-11-03 23:57:09 +0000386 const char *sqlFormat, /* printf-style format string for the SQL */
drha18c5682000-10-08 22:20:57 +0000387 char ***resultp, /* Result written to a char *[] that this points to */
388 int *nrow, /* Number of result rows written here */
389 int *ncolumn, /* Number of result columns written here */
390 char **errmsg, /* Error msg written here */
391 ... /* Arguments to the format string */
392);
danielk19776f8a5032004-05-10 10:34:51 +0000393int sqlite3_get_table_vprintf(
drha18c5682000-10-08 22:20:57 +0000394 sqlite*, /* An open database */
drh9f71c2e2001-11-03 23:57:09 +0000395 const char *sqlFormat, /* printf-style format string for the SQL */
drha18c5682000-10-08 22:20:57 +0000396 char ***resultp, /* Result written to a char *[] that this points to */
397 int *nrow, /* Number of result rows written here */
398 int *ncolumn, /* Number of result columns written here */
399 char **errmsg, /* Error msg written here */
400 va_list ap /* Arguments to the format string */
401);
danielk19776f8a5032004-05-10 10:34:51 +0000402char *sqlite3_mprintf(const char*,...);
403char *sqlite3_vmprintf(const char*, va_list);
drha18c5682000-10-08 22:20:57 +0000404
drh8e0a2f92002-02-23 23:45:45 +0000405/*
drh5191b7e2002-03-08 02:12:00 +0000406** Windows systems should call this routine to free memory that
danielk19776f8a5032004-05-10 10:34:51 +0000407** is returned in the in the errmsg parameter of sqlite3_open() when
drh5191b7e2002-03-08 02:12:00 +0000408** SQLite is a DLL. For some reason, it does not work to call free()
409** directly.
410*/
danielk19776f8a5032004-05-10 10:34:51 +0000411void sqlite3_freemem(void *p);
drh5191b7e2002-03-08 02:12:00 +0000412
413/*
danielk19776f8a5032004-05-10 10:34:51 +0000414** Windows systems need functions to call to return the sqlite3_version
415** and sqlite3_encoding strings.
drh5191b7e2002-03-08 02:12:00 +0000416*/
danielk19776f8a5032004-05-10 10:34:51 +0000417const char *sqlite3_libversion(void);
418const char *sqlite3_libencoding(void);
drh5191b7e2002-03-08 02:12:00 +0000419
420/*
drh1350b032002-02-27 19:00:20 +0000421** A pointer to the following structure is used to communicate with
422** the implementations of user-defined functions.
423*/
424typedef struct sqlite_func sqlite_func;
425
426/*
drh8e0a2f92002-02-23 23:45:45 +0000427** Use the following routines to create new user-defined functions. See
428** the documentation for details.
429*/
danielk19776f8a5032004-05-10 10:34:51 +0000430int sqlite3_create_function(
drh1350b032002-02-27 19:00:20 +0000431 sqlite*, /* Database where the new function is registered */
432 const char *zName, /* Name of the new function */
433 int nArg, /* Number of arguments. -1 means any number */
434 void (*xFunc)(sqlite_func*,int,const char**), /* C code to implement */
danielk19776f8a5032004-05-10 10:34:51 +0000435 void *pUserData /* Available via the sqlite3_user_data() call */
drh8e0a2f92002-02-23 23:45:45 +0000436);
danielk19776f8a5032004-05-10 10:34:51 +0000437int sqlite3_create_aggregate(
drh1350b032002-02-27 19:00:20 +0000438 sqlite*, /* Database where the new function is registered */
439 const char *zName, /* Name of the function */
440 int nArg, /* Number of arguments */
441 void (*xStep)(sqlite_func*,int,const char**), /* Called for each row */
442 void (*xFinalize)(sqlite_func*), /* Called once to get final result */
danielk19776f8a5032004-05-10 10:34:51 +0000443 void *pUserData /* Available via the sqlite3_user_data() call */
drh8e0a2f92002-02-23 23:45:45 +0000444);
445
446/*
drhc9b84a12002-06-20 11:36:48 +0000447** Use the following routine to define the datatype returned by a
448** user-defined function. The second argument can be one of the
449** constants SQLITE_NUMERIC, SQLITE_TEXT, or SQLITE_ARGS or it
drh268380c2004-02-25 13:47:31 +0000450** can be an integer greater than or equal to zero. When the datatype
451** parameter is non-negative, the type of the result will be the
452** same as the datatype-th argument. If datatype==SQLITE_NUMERIC
453** then the result is always numeric. If datatype==SQLITE_TEXT then
454** the result is always text. If datatype==SQLITE_ARGS then the result
455** is numeric if any argument is numeric and is text otherwise.
drhc9b84a12002-06-20 11:36:48 +0000456*/
danielk19776f8a5032004-05-10 10:34:51 +0000457int sqlite3_function_type(
drhc9b84a12002-06-20 11:36:48 +0000458 sqlite *db, /* The database there the function is registered */
459 const char *zName, /* Name of the function */
460 int datatype /* The datatype for this function */
461);
462#define SQLITE_NUMERIC (-1)
463#define SQLITE_TEXT (-2)
464#define SQLITE_ARGS (-3)
465
466/*
drh8e0a2f92002-02-23 23:45:45 +0000467** The user function implementations call one of the following four routines
468** in order to return their results. The first parameter to each of these
drhdd5baa92002-02-27 19:50:59 +0000469** routines is a copy of the first argument to xFunc() or xFinialize().
drh1350b032002-02-27 19:00:20 +0000470** The second parameter to these routines is the result to be returned.
danielk19776f8a5032004-05-10 10:34:51 +0000471** A NULL can be passed as the second parameter to sqlite3_set_result_string()
drh1350b032002-02-27 19:00:20 +0000472** in order to return a NULL result.
drh8e0a2f92002-02-23 23:45:45 +0000473**
474** The 3rd argument to _string and _error is the number of characters to
475** take from the string. If this argument is negative, then all characters
476** up to and including the first '\000' are used.
drh1350b032002-02-27 19:00:20 +0000477**
danielk19776f8a5032004-05-10 10:34:51 +0000478** The sqlite3_set_result_string() function allocates a buffer to hold the
drh1350b032002-02-27 19:00:20 +0000479** result and returns a pointer to this buffer. The calling routine
480** (that is, the implmentation of a user function) can alter the content
481** of this buffer if desired.
drh8e0a2f92002-02-23 23:45:45 +0000482*/
danielk19776f8a5032004-05-10 10:34:51 +0000483char *sqlite3_set_result_string(sqlite_func*,const char*,int);
484void sqlite3_set_result_int(sqlite_func*,int);
485void sqlite3_set_result_double(sqlite_func*,double);
486void sqlite3_set_result_error(sqlite_func*,const char*,int);
drh1350b032002-02-27 19:00:20 +0000487
488/*
danielk19776f8a5032004-05-10 10:34:51 +0000489** The pUserData parameter to the sqlite3_create_function() and
490** sqlite3_create_aggregate() routines used to register user functions
drh1350b032002-02-27 19:00:20 +0000491** is available to the implementation of the function using this
492** call.
493*/
danielk19776f8a5032004-05-10 10:34:51 +0000494void *sqlite3_user_data(sqlite_func*);
drh1350b032002-02-27 19:00:20 +0000495
496/*
drhdd5baa92002-02-27 19:50:59 +0000497** Aggregate functions use the following routine to allocate
498** a structure for storing their state. The first time this routine
drh1350b032002-02-27 19:00:20 +0000499** is called for a particular aggregate, a new structure of size nBytes
500** is allocated, zeroed, and returned. On subsequent calls (for the
501** same aggregate instance) the same buffer is returned. The implementation
502** of the aggregate can use the returned buffer to accumulate data.
503**
504** The buffer allocated is freed automatically be SQLite.
505*/
danielk19776f8a5032004-05-10 10:34:51 +0000506void *sqlite3_aggregate_context(sqlite_func*, int nBytes);
drh1350b032002-02-27 19:00:20 +0000507
508/*
drhdd5baa92002-02-27 19:50:59 +0000509** The next routine returns the number of calls to xStep for a particular
510** aggregate function instance. The current call to xStep counts so this
511** routine always returns at least 1.
drh1350b032002-02-27 19:00:20 +0000512*/
danielk19776f8a5032004-05-10 10:34:51 +0000513int sqlite3_aggregate_count(sqlite_func*);
drh8e0a2f92002-02-23 23:45:45 +0000514
drh411995d2002-06-25 19:31:18 +0000515/*
drhed6c8672003-01-12 18:02:16 +0000516** This routine registers a callback with the SQLite library. The
drhb86ccfb2003-01-28 23:13:10 +0000517** callback is invoked (at compile-time, not at run-time) for each
518** attempt to access a column of a table in the database. The callback
519** returns SQLITE_OK if access is allowed, SQLITE_DENY if the entire
520** SQL statement should be aborted with an error and SQLITE_IGNORE
521** if the column should be treated as a NULL value.
drhed6c8672003-01-12 18:02:16 +0000522*/
danielk19776f8a5032004-05-10 10:34:51 +0000523int sqlite3_set_authorizer(
drhed6c8672003-01-12 18:02:16 +0000524 sqlite*,
drhe22a3342003-04-22 20:30:37 +0000525 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
drhe5f9c642003-01-13 23:27:31 +0000526 void *pUserData
drhed6c8672003-01-12 18:02:16 +0000527);
528
529/*
530** The second parameter to the access authorization function above will
drhe5f9c642003-01-13 23:27:31 +0000531** be one of the values below. These values signify what kind of operation
532** is to be authorized. The 3rd and 4th parameters to the authorization
533** function will be parameters or NULL depending on which of the following
drhe22a3342003-04-22 20:30:37 +0000534** codes is used as the second parameter. The 5th parameter is the name
535** of the database ("main", "temp", etc.) if applicable. The 6th parameter
drh5cf590c2003-04-24 01:45:04 +0000536** is the name of the inner-most trigger or view that is responsible for
537** the access attempt or NULL if this access attempt is directly from
538** input SQL code.
drhe5f9c642003-01-13 23:27:31 +0000539**
540** Arg-3 Arg-4
drhed6c8672003-01-12 18:02:16 +0000541*/
drh77ad4e42003-01-14 02:49:27 +0000542#define SQLITE_COPY 0 /* Table Name File Name */
drhe5f9c642003-01-13 23:27:31 +0000543#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */
544#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */
545#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */
546#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000547#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000548#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000549#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000550#define SQLITE_CREATE_VIEW 8 /* View Name NULL */
551#define SQLITE_DELETE 9 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000552#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000553#define SQLITE_DROP_TABLE 11 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000554#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000555#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000556#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000557#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */
drh77ad4e42003-01-14 02:49:27 +0000558#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */
drhe5f9c642003-01-13 23:27:31 +0000559#define SQLITE_DROP_VIEW 17 /* View Name NULL */
560#define SQLITE_INSERT 18 /* Table Name NULL */
561#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */
562#define SQLITE_READ 20 /* Table Name Column Name */
563#define SQLITE_SELECT 21 /* NULL NULL */
564#define SQLITE_TRANSACTION 22 /* NULL NULL */
565#define SQLITE_UPDATE 23 /* Table Name Column Name */
drh81e293b2003-06-06 19:00:42 +0000566#define SQLITE_ATTACH 24 /* Filename NULL */
567#define SQLITE_DETACH 25 /* Database Name NULL */
568
drhed6c8672003-01-12 18:02:16 +0000569
570/*
571** The return value of the authorization function should be one of the
572** following constants:
573*/
574/* #define SQLITE_OK 0 // Allow access (This is actually defined above) */
575#define SQLITE_DENY 1 /* Abort the SQL statement with an error */
576#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
577
578/*
danielk19776f8a5032004-05-10 10:34:51 +0000579** Register a function that is called at every invocation of sqlite3_exec()
danielk19774ad17132004-05-21 01:47:26 +0000580** or sqlite3_prepare(). This function can be used (for example) to generate
drhb86ccfb2003-01-28 23:13:10 +0000581** a log file of all SQL executed against a database.
drh18de4822003-01-16 16:28:53 +0000582*/
danielk19776f8a5032004-05-10 10:34:51 +0000583void *sqlite3_trace(sqlite*, void(*xTrace)(void*,const char*), void*);
drh18de4822003-01-16 16:28:53 +0000584
drhb86ccfb2003-01-28 23:13:10 +0000585/*** The Callback-Free API
586**
587** The following routines implement a new way to access SQLite that does not
588** involve the use of callbacks.
589**
590** An sqlite_vm is an opaque object that represents a single SQL statement
591** that is ready to be executed.
592*/
593typedef struct sqlite_vm sqlite_vm;
594
595/*
596** To execute an SQLite query without the use of callbacks, you first have
597** to compile the SQL using this routine. The 1st parameter "db" is a pointer
danielk19776f8a5032004-05-10 10:34:51 +0000598** to an sqlite object obtained from sqlite3_open(). The 2nd parameter
drhb86ccfb2003-01-28 23:13:10 +0000599** "zSql" is the text of the SQL to be compiled. The remaining parameters
600** are all outputs.
601**
602** *pzTail is made to point to the first character past the end of the first
603** SQL statement in zSql. This routine only compiles the first statement
604** in zSql, so *pzTail is left pointing to what remains uncompiled.
605**
606** *ppVm is left pointing to a "virtual machine" that can be used to execute
607** the compiled statement. Or if there is an error, *ppVm may be set to NULL.
drh326dce72003-01-29 14:06:07 +0000608** If the input text contained no SQL (if the input is and empty string or
609** a comment) then *ppVm is set to NULL.
drhb86ccfb2003-01-28 23:13:10 +0000610**
611** If any errors are detected during compilation, an error message is written
612** into space obtained from malloc() and *pzErrMsg is made to point to that
613** error message. The calling routine is responsible for freeing the text
danielk19776f8a5032004-05-10 10:34:51 +0000614** of this message when it has finished with it. Use sqlite3_freemem() to
drhb86ccfb2003-01-28 23:13:10 +0000615** free the message. pzErrMsg may be NULL in which case no error message
616** will be generated.
617**
618** On success, SQLITE_OK is returned. Otherwise and error code is returned.
619*/
danielk19776f8a5032004-05-10 10:34:51 +0000620int sqlite3_compile(
drhb86ccfb2003-01-28 23:13:10 +0000621 sqlite *db, /* The open database */
622 const char *zSql, /* SQL statement to be compiled */
623 const char **pzTail, /* OUT: uncompiled tail of zSql */
624 sqlite_vm **ppVm, /* OUT: the virtual machine to execute zSql */
625 char **pzErrmsg /* OUT: Error message. */
626);
627
628/*
629** After an SQL statement has been compiled, it is handed to this routine
630** to be executed. This routine executes the statement as far as it can
631** go then returns. The return value will be one of SQLITE_DONE,
632** SQLITE_ERROR, SQLITE_BUSY, SQLITE_ROW, or SQLITE_MISUSE.
633**
634** SQLITE_DONE means that the execute of the SQL statement is complete
danielk19776f8a5032004-05-10 10:34:51 +0000635** an no errors have occurred. sqlite3_step() should not be called again
drhb86ccfb2003-01-28 23:13:10 +0000636** for the same virtual machine. *pN is set to the number of columns in
637** the result set and *pazColName is set to an array of strings that
638** describe the column names and datatypes. The name of the i-th column
639** is (*pazColName)[i] and the datatype of the i-th column is
640** (*pazColName)[i+*pN]. *pazValue is set to NULL.
641**
642** SQLITE_ERROR means that the virtual machine encountered a run-time
danielk19776f8a5032004-05-10 10:34:51 +0000643** error. sqlite3_step() should not be called again for the same
drhb86ccfb2003-01-28 23:13:10 +0000644** virtual machine. *pN is set to 0 and *pazColName and *pazValue are set
danielk19776f8a5032004-05-10 10:34:51 +0000645** to NULL. Use sqlite3_finalize() to obtain the specific error code
drhb86ccfb2003-01-28 23:13:10 +0000646** and the error message text for the error.
647**
648** SQLITE_BUSY means that an attempt to open the database failed because
649** another thread or process is holding a lock. The calling routine
danielk19776f8a5032004-05-10 10:34:51 +0000650** can try again to open the database by calling sqlite3_step() again.
drhb86ccfb2003-01-28 23:13:10 +0000651** The return code will only be SQLITE_BUSY if no busy handler is registered
danielk19776f8a5032004-05-10 10:34:51 +0000652** using the sqlite3_busy_handler() or sqlite3_busy_timeout() routines. If
drhb86ccfb2003-01-28 23:13:10 +0000653** a busy handler callback has been registered but returns 0, then this
654** routine will return SQLITE_ERROR and sqltie_finalize() will return
655** SQLITE_BUSY when it is called.
656**
657** SQLITE_ROW means that a single row of the result is now available.
658** The data is contained in *pazValue. The value of the i-th column is
659** (*azValue)[i]. *pN and *pazColName are set as described in SQLITE_DONE.
danielk19776f8a5032004-05-10 10:34:51 +0000660** Invoke sqlite3_step() again to advance to the next row.
drhb86ccfb2003-01-28 23:13:10 +0000661**
danielk19776f8a5032004-05-10 10:34:51 +0000662** SQLITE_MISUSE is returned if sqlite3_step() is called incorrectly.
663** For example, if you call sqlite3_step() after the virtual machine
664** has halted (after a prior call to sqlite3_step() has returned SQLITE_DONE)
665** or if you call sqlite3_step() with an incorrectly initialized virtual
drhb86ccfb2003-01-28 23:13:10 +0000666** machine or a virtual machine that has been deleted or that is associated
667** with an sqlite structure that has been closed.
668*/
danielk19776f8a5032004-05-10 10:34:51 +0000669int sqlite3_step(
drhb86ccfb2003-01-28 23:13:10 +0000670 sqlite_vm *pVm, /* The virtual machine to execute */
671 int *pN, /* OUT: Number of columns in result */
672 const char ***pazValue, /* OUT: Column data */
673 const char ***pazColName /* OUT: Column names and datatypes */
674);
675
676/*
677** This routine is called to delete a virtual machine after it has finished
678** executing. The return value is the result code. SQLITE_OK is returned
679** if the statement executed successfully and some other value is returned if
680** there was any kind of error. If an error occurred and pzErrMsg is not
681** NULL, then an error message is written into memory obtained from malloc()
682** and *pzErrMsg is made to point to that error message. The calling routine
danielk19776f8a5032004-05-10 10:34:51 +0000683** should use sqlite3_freemem() to delete this message when it has finished
drhb86ccfb2003-01-28 23:13:10 +0000684** with it.
685**
686** This routine can be called at any point during the execution of the
687** virtual machine. If the virtual machine has not completed execution
688** when this routine is called, that is like encountering an error or
danielk19776f8a5032004-05-10 10:34:51 +0000689** an interrupt. (See sqlite3_interrupt().) Incomplete updates may be
drhb86ccfb2003-01-28 23:13:10 +0000690** rolled back and transactions cancelled, depending on the circumstances,
691** and the result code returned will be SQLITE_ABORT.
692*/
danielk19776f8a5032004-05-10 10:34:51 +0000693int sqlite3_finalize(sqlite_vm*, char **pzErrMsg);
drhb86ccfb2003-01-28 23:13:10 +0000694
danielk1977999af642003-07-22 09:24:43 +0000695/*
696** This routine deletes the virtual machine, writes any error message to
697** *pzErrMsg and returns an SQLite return code in the same way as the
danielk19776f8a5032004-05-10 10:34:51 +0000698** sqlite3_finalize() function.
danielk1977999af642003-07-22 09:24:43 +0000699**
700** Additionally, if ppVm is not NULL, *ppVm is left pointing to a new virtual
701** machine loaded with the compiled version of the original query ready for
702** execution.
703**
danielk19776f8a5032004-05-10 10:34:51 +0000704** If sqlite3_reset() returns SQLITE_SCHEMA, then *ppVm is set to NULL.
danielk1977999af642003-07-22 09:24:43 +0000705**
drh7c972de2003-09-06 22:18:07 +0000706******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
drh50457892003-09-06 01:10:47 +0000707*/
danielk19776f8a5032004-05-10 10:34:51 +0000708int sqlite3_reset(sqlite_vm*, char **pzErrMsg);
drh50457892003-09-06 01:10:47 +0000709
710/*
danielk19774ad17132004-05-21 01:47:26 +0000711** If the SQL that was handed to sqlite3_prepare contains variables that
drh7c972de2003-09-06 22:18:07 +0000712** are represeted in the SQL text by a question mark ('?'). This routine
713** is used to assign values to those variables.
714**
danielk19774ad17132004-05-21 01:47:26 +0000715** The first parameter is a virtual machine obtained from sqlite3_prepare().
drh7c972de2003-09-06 22:18:07 +0000716** The 2nd "idx" parameter determines which variable in the SQL statement
717** to bind the value to. The left most '?' is 1. The 3rd parameter is
718** the value to assign to that variable. The 4th parameter is the number
719** of bytes in the value, including the terminating \000 for strings.
720** Finally, the 5th "copy" parameter is TRUE if SQLite should make its
721** own private copy of this value, or false if the space that the 3rd
722** parameter points to will be unchanging and can be used directly by
723** SQLite.
724**
725** Unbound variables are treated as having a value of NULL. To explicitly
726** set a variable to NULL, call this routine with the 3rd parameter as a
727** NULL pointer.
728**
729** If the 4th "len" parameter is -1, then strlen() is used to find the
730** length.
drh50457892003-09-06 01:10:47 +0000731**
danielk19774ad17132004-05-21 01:47:26 +0000732** This routine can only be called immediately after sqlite3_prepare()
danielk19776f8a5032004-05-10 10:34:51 +0000733** or sqlite3_reset() and before any calls to sqlite3_step().
drh50457892003-09-06 01:10:47 +0000734**
danielk1977999af642003-07-22 09:24:43 +0000735******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
736*/
danielk19776f8a5032004-05-10 10:34:51 +0000737int sqlite3_bind(sqlite_vm*, int idx, const char *value, int len, int copy);
danielk1977999af642003-07-22 09:24:43 +0000738
danielk1977348bb5d2003-10-18 09:37:26 +0000739/*
740** This routine configures a callback function - the progress callback - that
danielk19776f8a5032004-05-10 10:34:51 +0000741** is invoked periodically during long running calls to sqlite3_exec(),
742** sqlite3_step() and sqlite3_get_table(). An example use for this API is to keep
danielk1977348bb5d2003-10-18 09:37:26 +0000743** a GUI updated during a large query.
744**
745** The progress callback is invoked once for every N virtual machine opcodes,
746** where N is the second argument to this function. The progress callback
747** itself is identified by the third argument to this function. The fourth
748** argument to this function is a void pointer passed to the progress callback
749** function each time it is invoked.
750**
danielk19776f8a5032004-05-10 10:34:51 +0000751** If a call to sqlite3_exec(), sqlite3_step() or sqlite3_get_table() results
danielk1977348bb5d2003-10-18 09:37:26 +0000752** in less than N opcodes being executed, then the progress callback is not
753** invoked.
754**
755** Calling this routine overwrites any previously installed progress callback.
756** To remove the progress callback altogether, pass NULL as the third
757** argument to this function.
758**
759** If the progress callback returns a result other than 0, then the current
760** query is immediately terminated and any database changes rolled back. If the
761** query was part of a larger transaction, then the transaction is not rolled
danielk19776f8a5032004-05-10 10:34:51 +0000762** back and remains active. The sqlite3_exec() call returns SQLITE_ABORT.
drhaa940ea2004-01-15 02:44:03 +0000763**
764******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
danielk1977348bb5d2003-10-18 09:37:26 +0000765*/
danielk19776f8a5032004-05-10 10:34:51 +0000766void sqlite3_progress_handler(sqlite*, int, int(*)(void*), void*);
danielk1977348bb5d2003-10-18 09:37:26 +0000767
drhaa940ea2004-01-15 02:44:03 +0000768/*
769** Register a callback function to be invoked whenever a new transaction
770** is committed. The pArg argument is passed through to the callback.
771** callback. If the callback function returns non-zero, then the commit
772** is converted into a rollback.
773**
774** If another function was previously registered, its pArg value is returned.
775** Otherwise NULL is returned.
776**
777** Registering a NULL function disables the callback.
778**
779******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
780*/
danielk19776f8a5032004-05-10 10:34:51 +0000781void *sqlite3_commit_hook(sqlite*, int(*)(void*), void*);
drhaa940ea2004-01-15 02:44:03 +0000782
drh22fbcb82004-02-01 01:22:50 +0000783/*
784** Open an encrypted SQLite database. If pKey==0 or nKey==0, this routine
danielk19776f8a5032004-05-10 10:34:51 +0000785** is the same as sqlite3_open().
drh22fbcb82004-02-01 01:22:50 +0000786**
787** The code to implement this API is not available in the public release
788** of SQLite.
789*/
danielk19776f8a5032004-05-10 10:34:51 +0000790sqlite *sqlite3_open_encrypted(
drh22fbcb82004-02-01 01:22:50 +0000791 const char *zFilename, /* Name of the encrypted database */
792 const void *pKey, /* Pointer to the key */
793 int nKey, /* Number of bytes in the key */
drhe384a4e2004-02-12 20:49:36 +0000794 int *pErrcode, /* Write error code here */
drh22fbcb82004-02-01 01:22:50 +0000795 char **pzErrmsg /* Write error message here */
796);
797
798/*
799** Change the key on an open database. If the current database is not
800** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the
801** database is decrypted.
802**
803** The code to implement this API is not available in the public release
804** of SQLite.
805*/
806int sqlite_rekey(
807 sqlite *db, /* Database to be rekeyed */
808 const void *pKey, int nKey /* The new key */
809);
810
drh6ff15d02004-03-14 22:12:34 +0000811/*
812** Encode a binary buffer "in" of size n bytes so that it contains
813** no instances of characters '\'' or '\000'. The output is
814** null-terminated and can be used as a string value in an INSERT
815** or UPDATE statement. Use sqlite_decode_binary() to convert the
816** string back into its original binary.
817**
818** The result is written into a preallocated output buffer "out".
819** "out" must be able to hold at least 2 +(257*n)/254 bytes.
820** In other words, the output will be expanded by as much as 3
821** bytes for every 254 bytes of input plus 2 bytes of fixed overhead.
822** (This is approximately 2 + 1.0118*n or about a 1.2% size increase.)
823**
824** The return value is the number of characters in the encoded
825** string, excluding the "\000" terminator.
826**
827** If out==NULL then no output is generated but the routine still returns
828** the number of characters that would have been generated if out had
829** not been NULL.
830*/
831int sqlite_encode_binary(const unsigned char *in, int n, unsigned char *out);
832
833/*
834** Decode the string "in" into binary data and write it into "out".
835** This routine reverses the encoding created by sqlite_encode_binary().
836** The output will always be a few bytes less than the input. The number
837** of bytes of output is returned. If the input is not a well-formed
838** encoding, -1 is returned.
839**
840** The "in" and "out" parameters may point to the same buffer in order
841** to decode a string in place.
842*/
843int sqlite_decode_binary(const unsigned char *in, unsigned char *out);
844
danielk19776622cce2004-05-20 11:00:52 +0000845
846/* FIX ME */
danielk1977295ba552004-05-19 10:34:51 +0000847typedef sqlite_vm sqlite3_stmt;
danielk19776622cce2004-05-20 11:00:52 +0000848typedef sqlite sqlite3;
danielk1977295ba552004-05-19 10:34:51 +0000849
danielk1977e3209e42004-05-20 01:40:18 +0000850/*
851** This routine is used to bind a 32-bit integer value to a variable
danielk19774ad17132004-05-21 01:47:26 +0000852** in an SQL statement compiled by sqlite3_prepare(). See comments for
853** sqlite3_prepare() for more details on SQL statement variables.
danielk1977e3209e42004-05-20 01:40:18 +0000854**
855** The first argument is a pointer to an SQL statement previously
danielk19774ad17132004-05-21 01:47:26 +0000856** obtained from a call to sqlite3_prepare(). The second parameter "i"
danielk1977e3209e42004-05-20 01:40:18 +0000857** determines the parameter to bind the value "iValue" to.
858*/
danielk1977295ba552004-05-19 10:34:51 +0000859int sqlite3_bind_int32(sqlite3_stmt*, int i, int iValue);
danielk1977e3209e42004-05-20 01:40:18 +0000860
861/*
862** This routine is used to bind a 64-bit integer value to a variable
danielk19774ad17132004-05-21 01:47:26 +0000863** in an SQL statement compiled by sqlite3_prepare(). See comments for
864** sqlite3_prepare() for more details on SQL statement variables.
danielk1977e3209e42004-05-20 01:40:18 +0000865**
866** The first argument is a pointer to an SQL statement previously
danielk19774ad17132004-05-21 01:47:26 +0000867** obtained from a call to sqlite3_prepare(). The second parameter "i"
danielk1977e3209e42004-05-20 01:40:18 +0000868** determines the parameter to bind the value "iValue" to.
869*/
danielk1977295ba552004-05-19 10:34:51 +0000870int sqlite3_bind_int64(sqlite3_stmt*, int i, long long int iValue);
danielk1977e3209e42004-05-20 01:40:18 +0000871
872/*
873** This routine is used to bind a real (floating point) value to a variable
danielk19774ad17132004-05-21 01:47:26 +0000874** in an SQL statement compiled by sqlite3_prepare(). See comments for
875** sqlite3_prepare() for more details on SQL statement variables.
danielk1977e3209e42004-05-20 01:40:18 +0000876**
877** The first argument is a pointer to an SQL statement previously obtained
danielk19774ad17132004-05-21 01:47:26 +0000878** from a call to sqlite3_prepare(). The second parameter "i" determines
danielk1977e3209e42004-05-20 01:40:18 +0000879** the parameter to bind the value "iValue" to. Internally, SQLite will
880** manipulate the value as a 64-bit IEEE float.
881*/
danielk1977295ba552004-05-19 10:34:51 +0000882int sqlite3_bind_double(sqlite3_stmt*, int i, double iValue);
danielk1977e3209e42004-05-20 01:40:18 +0000883
884/*
885** This routine is used to bind a NULL value to a variable in an SQL
danielk19774ad17132004-05-21 01:47:26 +0000886** statement compiled by sqlite3_prepare(). See comments for
887** sqlite3_prepare() for more details on SQL statement variables.
danielk1977e3209e42004-05-20 01:40:18 +0000888**
889** The first argument is a pointer to an SQL statement previously obtained
danielk19774ad17132004-05-21 01:47:26 +0000890** from a call to sqlite3_prepare(). The second parameter "i" determines
danielk1977e3209e42004-05-20 01:40:18 +0000891** the parameter to bind the NULL value to.
892*/
danielk1977295ba552004-05-19 10:34:51 +0000893int sqlite3_bind_null(sqlite3_stmt*, int i);
danielk1977e3209e42004-05-20 01:40:18 +0000894
895/*
896** This routine is used to bind a UTF-8 string value to a variable in an
danielk19774ad17132004-05-21 01:47:26 +0000897** SQL statement compiled by sqlite3_prepare(). See comments for
898** sqlite3_prepare() for more details on SQL statement variables.
danielk1977e3209e42004-05-20 01:40:18 +0000899**
900** The first argument is a pointer to an SQL statement previously obtained
danielk19774ad17132004-05-21 01:47:26 +0000901** from a call to sqlite3_prepare(). The second parameter "i" determines
danielk1977e3209e42004-05-20 01:40:18 +0000902** the parameter to bind the value to. Parameter three "z" is a pointer
903** to the UTF-8 string.
904**
905** The fourth "n" parameter is the number of bytes (not characters) in the
906** string pointed to by "z". "n" may or may not include any nul terminator
907** character. If "n" is less than zero, then SQLite assumes that "z" is
908** a nul terminated string.
909**
910** If paramater "eCopy" is true, then SQLite makes a copy of the string
911** pointed to by "z". If "eCopy" is false, then SQLite stores a pointer to
912** the original string data. In this case the caller must ensure that the
913** string data remains stable until after the SQL statement has been
914** finalised or another value bound to variable "i".
915*/
916int sqlite3_bind_text(sqlite3_stmt*, int i, const char* z, int n, int eCopy);
917
918/*
919** This routine is used to bind a UTF-16 string value to a variable in an
danielk19774ad17132004-05-21 01:47:26 +0000920** SQL statement compiled by sqlite3_prepare(). See comments for
921** sqlite3_prepare() for more details on SQL statement variables.
danielk1977e3209e42004-05-20 01:40:18 +0000922**
923** The first argument is a pointer to an SQL statement previously obtained
danielk19774ad17132004-05-21 01:47:26 +0000924** from a call to sqlite3_prepare(). The second parameter "i" determines
danielk1977e3209e42004-05-20 01:40:18 +0000925** the parameter to bind the value to. Parameter three "z" is a pointer to
926** the UTF-16 string. If the string does not begin with a byte-order-mark,
927** it is assumed to be encoded in the native byte order of the machine.
928**
929** The fourth "n" parameter is the number of bytes (not characters) in the
930** string pointed to by "z". "n" may or may not include any nul terminator
931** character. If "n" is less than zero, then SQLite assumes that "z" is
932** terminated by a pair of 0x00 characters.
933**
934** If paramater "eCopy" is true, then SQLite makes a copy of the string
935** pointed to by "z". If "eCopy" is false, then SQLite stores a pointer to
936** the original string data. In this case the caller must ensure that the
937** string data remains stable until after the SQL statement has been
938** finalised or another value bound to variable "i".
939*/
940int sqlite3_bind_text16(sqlite3_stmt*, int i, const void *z, int, int eCopy);
941
942/*
943** This routine is used to bind a blob value to a variable in an
danielk19774ad17132004-05-21 01:47:26 +0000944** SQL statement compiled by sqlite3_prepare(). See comments for
945** sqlite3_prepare() for more details on SQL statement variables.
danielk1977e3209e42004-05-20 01:40:18 +0000946**
947** The first argument is a pointer to an SQL statement previously obtained
danielk19774ad17132004-05-21 01:47:26 +0000948** from a call to sqlite3_prepare(). The second parameter "i" determines
danielk1977e3209e42004-05-20 01:40:18 +0000949** the parameter to bind the value to. Parameter three "z" is a pointer to
950** the blob of data.
951**
952** The fourth "n" parameter is the number of bytes in the blob pointed to
953** by "z". "n" may not be less than zero.
954**
955** If paramater "eCopy" is true, then SQLite makes a copy of the blob
956** pointed to by "z". If "eCopy" is false, then SQLite stores a pointer to
957** the original blob data. In this case the caller must ensure that the
958** blob data remains stable until after the SQL statement has been
959** finalised or another value bound to variable "i".
960*/
961int sqlite3_bind_blob(sqlite3_stmt*, int i, const void *z, int n, int eCopy);
962
danielk19776622cce2004-05-20 11:00:52 +0000963/*
964** Return the error code for the most recent sqlite3_* API call associated
965** with sqlite3 handle 'db'. SQLITE_OK is returned if the most recent
966** API call was successful.
967**
968** Calls to many sqlite3_* functions set the error code and string returned
969** by sqlite3_errcode(), sqlite3_errmsg() and sqlite3_errmsg16()
970** (overwriting the previous values). A complete list of functions that set
971** the error code and string returned by these functions follows. Note that
972** calls to sqlite3_errcode(), sqlite3_errmsg() and sqlite3_errmsg16()
973** themselves do not affect the results of future invocations.
974**
975** sqlite3_bind_int32
976** sqlite3_bind_int64
977** sqlite3_bind_double
978** sqlite3_bind_null
979** sqlite3_bind_text
980** sqlite3_bind_text16
981** sqlite3_bind_blob
danielk1977106bb232004-05-21 10:08:53 +0000982** sqlite3_open
983** sqlite3_open16
984** sqlite3_prepare
985** sqlite3_prepare16
986** sqlite3_step
987** sqlite3_finalize
danielk19776622cce2004-05-20 11:00:52 +0000988**
989** Assuming no other intervening sqlite3_* API calls are made, the error
990** code returned by this function is associated with the same error as
991** the strings returned by sqlite3_errmsg() and sqlite3_errmsg16().
992*/
993int sqlite3_errcode(sqlite3 *db);
danielk19774adee202004-05-08 08:23:19 +0000994
995/*
danielk19776622cce2004-05-20 11:00:52 +0000996** Return a pointer to a UTF-8 encoded string describing in english the
997** error condition for the most recent sqlite3_* API call. The returned
998** string is always terminated by an 0x00 byte.
999**
1000** The string "not an error" is returned when the most recent API call was
1001** successful.
danielk19774adee202004-05-08 08:23:19 +00001002*/
danielk19776622cce2004-05-20 11:00:52 +00001003const char *sqlite3_errmsg(sqlite3*);
danielk19774adee202004-05-08 08:23:19 +00001004
danielk19776622cce2004-05-20 11:00:52 +00001005/*
1006** Return a pointer to a UTF-16 native byte order encoded string describing
1007** in english the error condition for the most recent sqlite3_* API call.
1008** The returned string is always terminated by a pair of 0x00 bytes.
1009**
1010** The string "not an error" is returned when the most recent API call was
1011** successful.
1012*/
1013const void *sqlite3_errmsg16(sqlite3*);
1014
danielk19774ad17132004-05-21 01:47:26 +00001015/*
1016** To execute an SQL query, it must first be compiled into a byte-code
1017** program using this routine. The first parameter "db" is an SQLite
1018** database handle. The second parameter "zSql" is the statement
1019** to be compiled, encoded as UTF-8 text. If the next parameter, "nBytes",
1020** is less than zero, then zSql is read up to the first nul terminator.
1021** If "nBytes" is not less than zero, then it is the length of the
danielk1977106bb232004-05-21 10:08:53 +00001022** string zSql in bytes (not characters).
danielk19774ad17132004-05-21 01:47:26 +00001023**
danielk1977106bb232004-05-21 10:08:53 +00001024** *pzTail is made to point to the first byte past the end of the first
danielk19774ad17132004-05-21 01:47:26 +00001025** SQL statement in zSql. This routine only compiles the first statement
1026** in zSql, so *pzTail is left pointing to what remains uncompiled.
1027**
1028** *ppStmt is left pointing to a compiled SQL statement that can be
1029** executed using sqlite3_step(). Or if there is an error, *ppStmt may be
1030** set to NULL. If the input text contained no SQL (if the input is and
1031** empty string or a comment) then *ppStmt is set to NULL.
1032**
1033** On success, SQLITE_OK is returned. Otherwise an error code is returned.
1034**
1035*/
danielk19776622cce2004-05-20 11:00:52 +00001036int sqlite3_prepare(
1037 sqlite3 *db, /* Database handle */
1038 const char *zSql, /* SQL statement, UTF-8 encoded */
1039 int nBytes, /* Length of zSql in bytes. */
1040 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
1041 const char **pzTail /* OUT: Pointer to unused portion of zSql */
1042);
1043
danielk1977106bb232004-05-21 10:08:53 +00001044/*
1045** To execute an SQL query, it must first be compiled into a byte-code
1046** program using this routine. The first parameter "db" is an SQLite
1047** database handle. The second parameter "zSql" is the statement
1048** to be compiled, encoded as UTF-16 text. If the next parameter, "nBytes",
1049** is less than zero, then zSql is read up to the first pair of successive
1050** 0x00 bytes. If "nBytes" is not less than zero, then it is the length of
1051** the string zSql in bytes (not characters).
1052**
1053** *pzTail is made to point to the first byte past the end of the first
1054** SQL statement in zSql. This routine only compiles the first statement
1055** in zSql, so *pzTail is left pointing to what remains uncompiled.
1056**
1057** *ppStmt is left pointing to a compiled SQL statement that can be
1058** executed using sqlite3_step(). Or if there is an error, *ppStmt may be
1059** set to NULL. If the input text contained no SQL (if the input is and
1060** empty string or a comment) then *ppStmt is set to NULL.
1061**
1062** On success, SQLITE_OK is returned. Otherwise an error code is returned.
1063**
1064*/
danielk19776622cce2004-05-20 11:00:52 +00001065int sqlite3_prepare16(
1066 sqlite3 *db, /* Database handle */
1067 const void *zSql, /* SQL statement, UTF-16 encoded */
1068 int nBytes, /* Length of zSql in bytes. */
1069 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
1070 const void **pzTail /* OUT: Pointer to unused portion of zSql */
1071);
1072
danielk1977106bb232004-05-21 10:08:53 +00001073/*
1074** Return the number of columns in the result set returned by the compiled
1075** SQL statement. This routine returns 0 if pStmt is an SQL statement
1076** that does not return data (for example an UPDATE).
1077*/
1078int sqlite3_column_count(sqlite3_stmt *pStmt);
1079
1080/*
1081** The first parameter is a compiled SQL statement. This function returns
1082** the column heading for the Nth column of that statement, where N is the
1083** second function parameter. The string returned is UTF-8 encoded.
1084*/
1085const char *sqlite3_column_name(sqlite3_stmt*,int);
1086
1087/*
1088** The first parameter is a compiled SQL statement. This function returns
1089** the column heading for the Nth column of that statement, where N is the
1090** second function parameter. The string returned is UTF-16 encoded.
1091*/
1092const void *sqlite3_column_name16(sqlite3_stmt*,int);
1093
1094/*
1095** The first parameter is a compiled SQL statement. If this statement
1096** is a SELECT statement, the Nth column of the returned result set
1097** of the SELECT is a table column then the declared type of the table
1098** column is returned. If the Nth column of the result set is not at table
1099** column, then a NULL pointer is returned. The returned string is always
1100** UTF-8 encoded. For example, in the database schema:
1101**
1102** CREATE TABLE t1(c1 VARINT);
1103**
1104** And the following statement compiled:
1105**
1106** SELECT c1 + 1, 0 FROM t1;
1107**
1108** Then this routine would return the string "VARIANT" for the second
1109** result column (i==1), and a NULL pointer for the first result column
1110** (i==0).
1111*/
1112const char *sqlite3_column_decltype(sqlite3_stmt *, int i);
1113
1114/*
1115** The first parameter is a compiled SQL statement. If this statement
1116** is a SELECT statement, the Nth column of the returned result set
1117** of the SELECT is a table column then the declared type of the table
1118** column is returned. If the Nth column of the result set is not at table
1119** column, then a NULL pointer is returned. The returned string is always
1120** UTF-16 encoded. For example, in the database schema:
1121**
1122** CREATE TABLE t1(c1 VARINT);
1123**
1124** And the following statement compiled:
1125**
1126** SELECT c1 + 1, 0 FROM t1;
1127**
1128** Then this routine would return the string "VARIANT" for the second
1129** result column (i==1), and a NULL pointer for the first result column
1130** (i==0).
1131*/
1132const void *sqlite3_column_decltype16(sqlite3_stmt*,int);
1133
1134/*
1135** After an SQL query has been compiled with a call to either
1136** sqlite3_prepare() or sqlite3_prepare16(), then this function must be
1137** called one or more times to execute the statement.
1138**
1139** The return value will be either SQLITE_BUSY, SQLITE_DONE,
1140** SQLITE_ROW, SQLITE_ERROR, or SQLITE_MISUSE.
1141**
1142** SQLITE_BUSY means that the database engine attempted to open
1143** a locked database and there is no busy callback registered.
1144** Call sqlite3_step() again to retry the open.
1145**
1146** SQLITE_DONE means that the statement has finished executing
1147** successfully. sqlite3_step() should not be called again on this virtual
1148** machine.
1149**
1150** If the SQL statement being executed returns any data, then
1151** SQLITE_ROW is returned each time a new row of data is ready
1152** for processing by the caller. The values may be accessed using
1153** the sqlite3_column_*() functions described below. sqlite3_step()
1154** is called again to retrieve the next row of data.
1155**
1156** SQLITE_ERROR means that a run-time error (such as a constraint
1157** violation) has occurred. sqlite3_step() should not be called again on
1158** the VM. More information may be found by calling sqlite3_errmsg().
1159**
1160** SQLITE_MISUSE means that the this routine was called inappropriately.
1161** Perhaps it was called on a virtual machine that had already been
1162** finalized or on one that had previously returned SQLITE_ERROR or
1163** SQLITE_DONE. Or it could be the case the the same database connection
1164** is being used simulataneously by two or more threads.
1165*/
1166int sqlite3_step_new(sqlite3_stmt*);
1167
1168
1169/*
1170** The sqlite3_finalize() function is called to delete a compiled
1171** SQL statement obtained by a previous call to sqlite3_prepare()
1172** or sqlite3_prepare16(). If the statement was executed successfully, or
1173** not executed at all, then SQLITE_OK is returned. If execution of the
1174** statement failed then an error code is returned.
1175*/
1176int sqlite3_finalize_new(sqlite3_stmt *pStmt);
1177
1178/*
1179** The sqlite3_reset() function is called to reset a compiled SQL
1180** statement obtained by a previous call to sqlite3_prepare() or
1181** sqlite3_prepare16() back to it's initial state, ready to be re-executed.
1182** Any SQL statement variables that had values bound to them using
1183** the sqlite3_bind_*() API retain their values.
1184*/
1185int sqlite3_reset_new(sqlite3_stmt *pStmt);
1186
danielk197780290862004-05-22 09:21:21 +00001187/*
1188** Open the sqlite database file "filename", where "filename" is UTF-8
1189** encoded. An sqlite3* handle is returned in *ppDb, even if an error
1190** occurs. If the database is opened (or created) successfully, then
1191** SQLITE_OK is returned. Otherwise an error code is returned and the
1192** sqlite3_errmsg() function may be used to obtain an English language
1193** explanation of the error.
1194**
1195** If the database file does not exist, then a new database is created
1196** using UTF-8 text encoding.
1197**
1198** Whether or not an error occurs when it is opened, resources associated
1199** with the sqlite3* handle should be released by passing it to
1200** sqlite3_close() when it is no longer required.
1201*/
1202int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00001203 const char *filename, /* Database filename (UTF-8) */
1204 sqlite3 **ppDb, /* OUT: SQLite db handle */
1205 const char **args /* Null terminated array of option strings */
1206);
1207
danielk197780290862004-05-22 09:21:21 +00001208/*
1209** Open the sqlite database file "filename", where "filename" is native
1210** byte order UTF-16 encoded. An sqlite3* handle is returned in *ppDb, even
1211** if an error occurs. If the database is opened (or created) successfully,
1212** then SQLITE_OK is returned. Otherwise an error code is returned and the
1213** sqlite3_errmsg() function may be used to obtain an English language
1214** explanation of the error.
1215**
1216** If the database file does not exist, then a new database is created
1217** using UTF-16 text encoding in the machines native byte order.
1218**
1219** Whether or not an error occurs when it is opened, resources associated
1220** with the sqlite3* handle should be released by passing it to
1221** sqlite3_close() when it is no longer required.
1222*/
danielk19774ad17132004-05-21 01:47:26 +00001223int sqlite3_open16(
1224 const void *filename, /* Database filename (UTF-16) */
1225 sqlite3 **ppDb, /* OUT: SQLite db handle */
1226 const char **args /* Null terminated array of option strings */
1227);
1228
danielk1977106bb232004-05-21 10:08:53 +00001229/*
1230** Return the number of values in the current row of the result set.
1231**
1232** After a call to sqlite3_step() that returns SQLITE_ROW, this routine
1233** will return the same value as the sqlite3_column_count() function.
1234** After sqlite3_step() has returned an SQLITE_DONE, SQLITE_BUSY or
1235** error code, or before sqlite3_step() has been called on a
1236** compiled SQL statement, this routine returns zero.
1237*/
danielk197793d46752004-05-23 13:30:58 +00001238int sqlite3_data_count(sqlite3_stmt *pStmt);
danielk19774adee202004-05-08 08:23:19 +00001239
1240#define SQLITE3_INTEGER 1
1241#define SQLITE3_FLOAT 2
1242#define SQLITE3_TEXT 3
1243#define SQLITE3_BLOB 4
1244#define SQLITE3_NULL 5
1245
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 type of the Nth column of the current row, where
1250** N is the second function parameter.
1251**
1252** The value type is one of SQLITE3_INTEGER, SQLITE3_FLOAT, SQLITE3_TEXT,
1253** SQLITE3_BLOB and SQLITE3_NULL.
1254*/
1255int sqlite3_column_type(sqlite3_stmt *pStmt, int i);
danielk19774adee202004-05-08 08:23:19 +00001256
danielk1977106bb232004-05-21 10:08:53 +00001257/*
1258** The first parameter is a compiled SQL statement for which the most
1259** recent call to sqlite3_step() has returned SQLITE_ROW. This routine
1260** retrieves the value of the Nth column of the current row, where
1261** N is the second function parameter.
1262**
1263** The value returned depends on the type of the SQL column value, as
1264** returned by sqlite3_column_type():
1265**
1266** SQLITE3_NULL A Null pointer.
1267** SQLITE3_INTEGER String representation of the integer, UTF-8 encoded.
1268** SQLITE3_FLOAT String representation of the real, UTF-8 encoded.
1269** SQLITE3_TEXT The string UTF-8 encoded.
1270** SQLITE3_BLOB A pointer to the blob of data.
1271*/
1272const unsigned char *sqlite3_column_data(sqlite3_stmt*,int);
1273
1274/*
1275** The first parameter is a compiled SQL statement for which the most
1276** recent call to sqlite3_step() has returned SQLITE_ROW. This routine
1277** retrieves the value of the Nth column of the current row, where
1278** N is the second function parameter.
1279**
1280** The value returned depends on the type of the SQL column value, as
1281** returned by sqlite3_column_type():
1282**
1283** SQLITE3_NULL A Null pointer.
1284** SQLITE3_INTEGER String representation of the integer, UTF-16 encoded.
1285** SQLITE3_FLOAT String representation of the real, UTF-16 encoded.
1286** SQLITE3_TEXT The string UTF-16 encoded.
1287** SQLITE3_BLOB A pointer to the blob of data.
1288*/
1289const void *sqlite3_column_data16(sqlite3_stmt*,int);
1290
1291/*
1292** The first parameter is a compiled SQL statement for which the most
1293** recent call to sqlite3_step() has returned SQLITE_ROW. This routine
danielk1977e1cd9872004-05-22 10:33:04 +00001294** retrieves the length of the data in bytes returned by the
danielk1977106bb232004-05-21 10:08:53 +00001295** sqlite3_column_data() routine for the same second parameter value.
1296**
1297** If sqlite3_column_data() returns a UTF-8 string, then the length
1298** returned by this function includes the nul terminator character at the
1299** end of the UTF-8 string.
1300*/
1301int sqlite3_column_bytes(sqlite3_stmt*,int);
1302
1303/*
1304** The first parameter is a compiled SQL statement for which the most
1305** recent call to sqlite3_step() has returned SQLITE_ROW. This routine
danielk1977e1cd9872004-05-22 10:33:04 +00001306** retrieves the length of the data in bytes returned by the
1307** sqlite3_column_data() routine for the same second parameter value.
1308**
1309** If sqlite3_column_data() returns a UTF-16 string, then the length
1310** returned by this function includes the nul terminator character (two
1311** bytes) at the end of the UTF-16 string.
1312*/
1313int sqlite3_column_bytes16(sqlite3_stmt *, int);
1314
1315/*
1316** The first parameter is a compiled SQL statement for which the most
1317** recent call to sqlite3_step() has returned SQLITE_ROW. This routine
danielk1977106bb232004-05-21 10:08:53 +00001318** retrieves the value of the Nth column of the current row, where
1319** N is the second function parameter as an integer.
1320**
1321** SQLITE3_NULL 0
1322** SQLITE3_INTEGER The integer value.
1323** SQLITE3_FLOAT The integer component of the real (2^63 if too large)
1324** SQLITE3_TEXT Integer conversion of string, or 0
1325** SQLITE3_BLOB 0
1326*/
1327long long int sqlite3_column_int(sqlite3_stmt*,int);
1328
1329/*
1330** The first parameter is a compiled SQL statement for which the most
1331** recent call to sqlite3_step() has returned SQLITE_ROW. This routine
1332** retrieves the value of the Nth column of the current row, where
1333** N is the second function parameter as an integer.
1334**
1335** SQLITE3_NULL 0.0
1336** SQLITE3_INTEGER The value of the integer. Some rounding may occur.
1337** SQLITE3_FLOAT The value of the float.
1338** SQLITE3_TEXT Real number conversion of string, or 0.0
1339** SQLITE3_BLOB 0.0
1340*/
1341double sqlite3_column_float(sqlite3_stmt*,int);
danielk19774adee202004-05-08 08:23:19 +00001342
danielk197793d46752004-05-23 13:30:58 +00001343typedef struct Mem sqlite3_value;
1344
1345int sqlite3_value_type(sqlite3_value*);
1346int sqlite3_value_bytes(sqlite3_value*);
1347int sqlite3_value_bytes16(sqlite3_value*);
1348const unsigned char *sqlite3_value_data(sqlite3_value*);
1349const void *sqlite3_value_data16(sqlite3_value*);
1350long long int sqlite3_value_int(sqlite3_value*);
1351double sqlite3_value_float(sqlite3_value*);
1352
drh382c0242001-10-06 16:33:02 +00001353#ifdef __cplusplus
1354} /* End of the 'extern "C"' block */
1355#endif
danielk19774adee202004-05-08 08:23:19 +00001356#endif