drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 1 | /* |
drh | b19a2bc | 2001-09-16 00:13:26 +0000 | [diff] [blame] | 2 | ** 2001 September 15 |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 3 | ** |
drh | b19a2bc | 2001-09-16 00:13:26 +0000 | [diff] [blame] | 4 | ** The author disclaims copyright to this source code. In place of |
| 5 | ** a legal notice, here is a blessing: |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 6 | ** |
drh | b19a2bc | 2001-09-16 00:13:26 +0000 | [diff] [blame] | 7 | ** 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. |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 10 | ** |
| 11 | ************************************************************************* |
drh | b19a2bc | 2001-09-16 00:13:26 +0000 | [diff] [blame] | 12 | ** This header file defines the interface that the SQLite library |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 13 | ** presents to client programs. |
| 14 | ** |
drh | b37df7b | 2005-10-13 02:09:49 +0000 | [diff] [blame^] | 15 | ** @(#) $Id: sqlite.h.in,v 1.142 2005/10/13 02:09:50 drh Exp $ |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 16 | */ |
drh | 12057d5 | 2004-09-06 17:34:12 +0000 | [diff] [blame] | 17 | #ifndef _SQLITE3_H_ |
| 18 | #define _SQLITE3_H_ |
drh | a18c568 | 2000-10-08 22:20:57 +0000 | [diff] [blame] | 19 | #include <stdarg.h> /* Needed for the definition of va_list */ |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 20 | |
| 21 | /* |
drh | 382c024 | 2001-10-06 16:33:02 +0000 | [diff] [blame] | 22 | ** Make sure we can call this stuff from C++. |
| 23 | */ |
| 24 | #ifdef __cplusplus |
| 25 | extern "C" { |
| 26 | #endif |
| 27 | |
| 28 | /* |
drh | b86ccfb | 2003-01-28 23:13:10 +0000 | [diff] [blame] | 29 | ** The version of the SQLite library. |
| 30 | */ |
drh | 1e284f4 | 2004-10-06 15:52:01 +0000 | [diff] [blame] | 31 | #ifdef SQLITE_VERSION |
| 32 | # undef SQLITE_VERSION |
drh | 1e284f4 | 2004-10-06 15:52:01 +0000 | [diff] [blame] | 33 | #endif |
danielk1977 | 99ba19e | 2005-02-05 07:33:34 +0000 | [diff] [blame] | 34 | #define SQLITE_VERSION "--VERS--" |
| 35 | |
| 36 | /* |
| 37 | ** The format of the version string is "X.Y.Z<trailing string>", where |
| 38 | ** X is the major version number, Y is the minor version number and Z |
| 39 | ** is the release number. The trailing string is often "alpha" or "beta". |
| 40 | ** For example "3.1.1beta". |
| 41 | ** |
| 42 | ** The SQLITE_VERSION_NUMBER is an integer with the value |
| 43 | ** (X*100000 + Y*1000 + Z). For example, for version "3.1.1beta", |
| 44 | ** SQLITE_VERSION_NUMBER is set to 3001001. To detect if they are using |
| 45 | ** version 3.1.1 or greater at compile time, programs may use the test |
| 46 | ** (SQLITE_VERSION_NUMBER>=3001001). |
| 47 | */ |
| 48 | #ifdef SQLITE_VERSION_NUMBER |
| 49 | # undef SQLITE_VERSION_NUMBER |
| 50 | #endif |
| 51 | #define SQLITE_VERSION_NUMBER --VERSION-NUMBER-- |
drh | b86ccfb | 2003-01-28 23:13:10 +0000 | [diff] [blame] | 52 | |
| 53 | /* |
drh | b217a57 | 2000-08-22 13:40:18 +0000 | [diff] [blame] | 54 | ** The version string is also compiled into the library so that a program |
| 55 | ** can check to make sure that the lib*.a file and the *.h file are from |
drh | 6f3a3ef | 2004-08-28 18:21:21 +0000 | [diff] [blame] | 56 | ** the same version. The sqlite3_libversion() function returns a pointer |
| 57 | ** to the sqlite3_version variable - useful in DLLs which cannot access |
| 58 | ** global variables. |
drh | b217a57 | 2000-08-22 13:40:18 +0000 | [diff] [blame] | 59 | */ |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 60 | extern const char sqlite3_version[]; |
drh | a3f70cb | 2004-09-30 14:24:50 +0000 | [diff] [blame] | 61 | const char *sqlite3_libversion(void); |
drh | 303aaa7 | 2000-08-17 10:22:34 +0000 | [diff] [blame] | 62 | |
| 63 | /* |
danielk1977 | 99ba19e | 2005-02-05 07:33:34 +0000 | [diff] [blame] | 64 | ** Return the value of the SQLITE_VERSION_NUMBER macro when the |
| 65 | ** library was compiled. |
| 66 | */ |
| 67 | int sqlite3_libversion_number(void); |
| 68 | |
| 69 | /* |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 70 | ** Each open sqlite database is represented by an instance of the |
| 71 | ** following opaque structure. |
| 72 | */ |
drh | 9bb575f | 2004-09-06 17:24:11 +0000 | [diff] [blame] | 73 | typedef struct sqlite3 sqlite3; |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 74 | |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 75 | |
| 76 | /* |
drh | efad999 | 2004-06-22 12:13:55 +0000 | [diff] [blame] | 77 | ** Some compilers do not support the "long long" datatype. So we have |
| 78 | ** to do a typedef that for 64-bit integers that depends on what compiler |
| 79 | ** is being used. |
| 80 | */ |
| 81 | #if defined(_MSC_VER) || defined(__BORLANDC__) |
| 82 | typedef __int64 sqlite_int64; |
drh | 1211de3 | 2004-07-26 12:24:22 +0000 | [diff] [blame] | 83 | typedef unsigned __int64 sqlite_uint64; |
drh | efad999 | 2004-06-22 12:13:55 +0000 | [diff] [blame] | 84 | #else |
| 85 | typedef long long int sqlite_int64; |
drh | 1211de3 | 2004-07-26 12:24:22 +0000 | [diff] [blame] | 86 | typedef unsigned long long int sqlite_uint64; |
drh | efad999 | 2004-06-22 12:13:55 +0000 | [diff] [blame] | 87 | #endif |
| 88 | |
drh | b37df7b | 2005-10-13 02:09:49 +0000 | [diff] [blame^] | 89 | /* |
| 90 | ** If compiling for a processor that lacks floating point support, |
| 91 | ** substitute integer for floating-point |
| 92 | */ |
| 93 | #ifdef SQLITE_OMIT_FLOATING_POINT |
| 94 | # define double sqlite_int64 |
| 95 | #endif |
drh | efad999 | 2004-06-22 12:13:55 +0000 | [diff] [blame] | 96 | |
| 97 | /* |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 98 | ** A function to close the database. |
| 99 | ** |
| 100 | ** Call this function with a pointer to a structure that was previously |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 101 | ** returned from sqlite3_open() and the corresponding database will by closed. |
danielk1977 | 96d81f9 | 2004-06-19 03:33:57 +0000 | [diff] [blame] | 102 | ** |
| 103 | ** All SQL statements prepared using sqlite3_prepare() or |
| 104 | ** sqlite3_prepare16() must be deallocated using sqlite3_finalize() before |
| 105 | ** this routine is called. Otherwise, SQLITE_BUSY is returned and the |
| 106 | ** database connection remains open. |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 107 | */ |
danielk1977 | f9d64d2 | 2004-06-19 08:18:07 +0000 | [diff] [blame] | 108 | int sqlite3_close(sqlite3 *); |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 109 | |
| 110 | /* |
| 111 | ** The type for a callback function. |
| 112 | */ |
drh | 12057d5 | 2004-09-06 17:34:12 +0000 | [diff] [blame] | 113 | typedef int (*sqlite3_callback)(void*,int,char**, char**); |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 114 | |
| 115 | /* |
| 116 | ** A function to executes one or more statements of SQL. |
| 117 | ** |
| 118 | ** If one or more of the SQL statements are queries, then |
| 119 | ** the callback function specified by the 3rd parameter is |
| 120 | ** invoked once for each row of the query result. This callback |
| 121 | ** should normally return 0. If the callback returns a non-zero |
| 122 | ** value then the query is aborted, all subsequent SQL statements |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 123 | ** are skipped and the sqlite3_exec() function returns the SQLITE_ABORT. |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 124 | ** |
| 125 | ** The 4th parameter is an arbitrary pointer that is passed |
| 126 | ** to the callback function as its first parameter. |
| 127 | ** |
| 128 | ** The 2nd parameter to the callback function is the number of |
drh | b19a2bc | 2001-09-16 00:13:26 +0000 | [diff] [blame] | 129 | ** columns in the query result. The 3rd parameter to the callback |
| 130 | ** is an array of strings holding the values for each column. |
| 131 | ** The 4th parameter to the callback is an array of strings holding |
| 132 | ** the names of each column. |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 133 | ** |
| 134 | ** The callback function may be NULL, even for queries. A NULL |
| 135 | ** callback is not an error. It just means that no callback |
| 136 | ** will be invoked. |
| 137 | ** |
| 138 | ** If an error occurs while parsing or evaluating the SQL (but |
| 139 | ** not while executing the callback) then an appropriate error |
| 140 | ** message is written into memory obtained from malloc() and |
drh | b19a2bc | 2001-09-16 00:13:26 +0000 | [diff] [blame] | 141 | ** *errmsg is made to point to that message. The calling function |
| 142 | ** is responsible for freeing the memory that holds the error |
drh | 3f4fedb | 2004-05-31 19:34:33 +0000 | [diff] [blame] | 143 | ** message. Use sqlite3_free() for this. If errmsg==NULL, |
drh | b86ccfb | 2003-01-28 23:13:10 +0000 | [diff] [blame] | 144 | ** then no error message is ever written. |
drh | b19a2bc | 2001-09-16 00:13:26 +0000 | [diff] [blame] | 145 | ** |
| 146 | ** The return value is is SQLITE_OK if there are no errors and |
| 147 | ** some other return code if there is an error. The particular |
| 148 | ** return value depends on the type of error. |
drh | 58b9576 | 2000-06-02 01:17:37 +0000 | [diff] [blame] | 149 | ** |
| 150 | ** If the query could not be executed because a database file is |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 151 | ** locked or busy, then this function returns SQLITE_BUSY. (This |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 152 | ** behavior can be modified somewhat using the sqlite3_busy_handler() |
| 153 | ** and sqlite3_busy_timeout() functions below.) |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 154 | */ |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 155 | int sqlite3_exec( |
drh | 12057d5 | 2004-09-06 17:34:12 +0000 | [diff] [blame] | 156 | sqlite3*, /* An open database */ |
drh | 9f71c2e | 2001-11-03 23:57:09 +0000 | [diff] [blame] | 157 | const char *sql, /* SQL to be executed */ |
drh | 12057d5 | 2004-09-06 17:34:12 +0000 | [diff] [blame] | 158 | sqlite3_callback, /* Callback function */ |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 159 | void *, /* 1st argument to callback function */ |
| 160 | char **errmsg /* Error msg written here */ |
| 161 | ); |
| 162 | |
drh | 58b9576 | 2000-06-02 01:17:37 +0000 | [diff] [blame] | 163 | /* |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 164 | ** Return values for sqlite3_exec() and sqlite3_step() |
drh | 58b9576 | 2000-06-02 01:17:37 +0000 | [diff] [blame] | 165 | */ |
drh | 717e640 | 2001-09-27 03:22:32 +0000 | [diff] [blame] | 166 | #define SQLITE_OK 0 /* Successful result */ |
| 167 | #define SQLITE_ERROR 1 /* SQL error or missing database */ |
drh | 2db0bbc | 2005-08-11 02:10:18 +0000 | [diff] [blame] | 168 | #define SQLITE_INTERNAL 2 /* NOT USED. Internal logic error in SQLite */ |
drh | 717e640 | 2001-09-27 03:22:32 +0000 | [diff] [blame] | 169 | #define SQLITE_PERM 3 /* Access permission denied */ |
| 170 | #define SQLITE_ABORT 4 /* Callback routine requested an abort */ |
| 171 | #define SQLITE_BUSY 5 /* The database file is locked */ |
| 172 | #define SQLITE_LOCKED 6 /* A table in the database is locked */ |
| 173 | #define SQLITE_NOMEM 7 /* A malloc() failed */ |
| 174 | #define SQLITE_READONLY 8 /* Attempt to write a readonly database */ |
drh | 24cd67e | 2004-05-10 16:18:47 +0000 | [diff] [blame] | 175 | #define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/ |
drh | 717e640 | 2001-09-27 03:22:32 +0000 | [diff] [blame] | 176 | #define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */ |
| 177 | #define SQLITE_CORRUPT 11 /* The database disk image is malformed */ |
drh | 2db0bbc | 2005-08-11 02:10:18 +0000 | [diff] [blame] | 178 | #define SQLITE_NOTFOUND 12 /* NOT USED. Table or record not found */ |
drh | 717e640 | 2001-09-27 03:22:32 +0000 | [diff] [blame] | 179 | #define SQLITE_FULL 13 /* Insertion failed because database is full */ |
| 180 | #define SQLITE_CANTOPEN 14 /* Unable to open the database file */ |
| 181 | #define SQLITE_PROTOCOL 15 /* Database lock protocol error */ |
drh | 24cd67e | 2004-05-10 16:18:47 +0000 | [diff] [blame] | 182 | #define SQLITE_EMPTY 16 /* Database is empty */ |
drh | 717e640 | 2001-09-27 03:22:32 +0000 | [diff] [blame] | 183 | #define SQLITE_SCHEMA 17 /* The database schema changed */ |
drh | 2db0bbc | 2005-08-11 02:10:18 +0000 | [diff] [blame] | 184 | #define SQLITE_TOOBIG 18 /* NOT USED. Too much data for one row */ |
drh | 717e640 | 2001-09-27 03:22:32 +0000 | [diff] [blame] | 185 | #define SQLITE_CONSTRAINT 19 /* Abort due to contraint violation */ |
drh | 8aff101 | 2001-12-22 14:49:24 +0000 | [diff] [blame] | 186 | #define SQLITE_MISMATCH 20 /* Data type mismatch */ |
drh | 247be43 | 2002-05-10 05:44:55 +0000 | [diff] [blame] | 187 | #define SQLITE_MISUSE 21 /* Library used incorrectly */ |
drh | 8766c34 | 2002-11-09 00:33:15 +0000 | [diff] [blame] | 188 | #define SQLITE_NOLFS 22 /* Uses OS features not supported on host */ |
drh | ed6c867 | 2003-01-12 18:02:16 +0000 | [diff] [blame] | 189 | #define SQLITE_AUTH 23 /* Authorization denied */ |
drh | 1c2d841 | 2003-03-31 00:30:47 +0000 | [diff] [blame] | 190 | #define SQLITE_FORMAT 24 /* Auxiliary database format error */ |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 191 | #define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */ |
drh | c602f9a | 2004-02-12 19:01:04 +0000 | [diff] [blame] | 192 | #define SQLITE_NOTADB 26 /* File opened that is not a database file */ |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 193 | #define SQLITE_ROW 100 /* sqlite3_step() has another row ready */ |
| 194 | #define SQLITE_DONE 101 /* sqlite3_step() has finished executing */ |
drh | 717e640 | 2001-09-27 03:22:32 +0000 | [diff] [blame] | 195 | |
drh | af9ff33 | 2002-01-16 21:00:27 +0000 | [diff] [blame] | 196 | /* |
| 197 | ** Each entry in an SQLite table has a unique integer key. (The key is |
| 198 | ** the value of the INTEGER PRIMARY KEY column if there is such a column, |
| 199 | ** otherwise the key is generated at random. The unique key is always |
| 200 | ** available as the ROWID, OID, or _ROWID_ column.) The following routine |
| 201 | ** returns the integer key of the most recent insert in the database. |
| 202 | ** |
| 203 | ** This function is similar to the mysql_insert_id() function from MySQL. |
| 204 | */ |
drh | efad999 | 2004-06-22 12:13:55 +0000 | [diff] [blame] | 205 | sqlite_int64 sqlite3_last_insert_rowid(sqlite3*); |
drh | af9ff33 | 2002-01-16 21:00:27 +0000 | [diff] [blame] | 206 | |
drh | c8d30ac | 2002-04-12 10:08:59 +0000 | [diff] [blame] | 207 | /* |
| 208 | ** This function returns the number of database rows that were changed |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 209 | ** (or inserted or deleted) by the most recent called sqlite3_exec(). |
drh | c8d30ac | 2002-04-12 10:08:59 +0000 | [diff] [blame] | 210 | ** |
| 211 | ** All changes are counted, even if they were later undone by a |
| 212 | ** ROLLBACK or ABORT. Except, changes associated with creating and |
| 213 | ** dropping tables are not counted. |
| 214 | ** |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 215 | ** If a callback invokes sqlite3_exec() recursively, then the changes |
drh | c8d30ac | 2002-04-12 10:08:59 +0000 | [diff] [blame] | 216 | ** in the inner, recursive call are counted together with the changes |
| 217 | ** in the outer call. |
| 218 | ** |
| 219 | ** SQLite implements the command "DELETE FROM table" without a WHERE clause |
| 220 | ** by dropping and recreating the table. (This is much faster than going |
| 221 | ** through and deleting individual elements form the table.) Because of |
| 222 | ** this optimization, the change count for "DELETE FROM table" will be |
| 223 | ** zero regardless of the number of elements that were originally in the |
| 224 | ** table. To get an accurate count of the number of rows deleted, use |
| 225 | ** "DELETE FROM table WHERE 1" instead. |
| 226 | */ |
danielk1977 | f9d64d2 | 2004-06-19 08:18:07 +0000 | [diff] [blame] | 227 | int sqlite3_changes(sqlite3*); |
drh | c8d30ac | 2002-04-12 10:08:59 +0000 | [diff] [blame] | 228 | |
rdc | f146a77 | 2004-02-25 22:51:06 +0000 | [diff] [blame] | 229 | /* |
danielk1977 | b28af71 | 2004-06-21 06:50:26 +0000 | [diff] [blame] | 230 | ** This function returns the number of database rows that have been |
| 231 | ** modified by INSERT, UPDATE or DELETE statements since the database handle |
| 232 | ** was opened. This includes UPDATE, INSERT and DELETE statements executed |
| 233 | ** as part of trigger programs. All changes are counted as soon as the |
| 234 | ** statement that makes them is completed (when the statement handle is |
| 235 | ** passed to sqlite3_reset() or sqlite_finalise()). |
rdc | f146a77 | 2004-02-25 22:51:06 +0000 | [diff] [blame] | 236 | ** |
| 237 | ** SQLite implements the command "DELETE FROM table" without a WHERE clause |
| 238 | ** by dropping and recreating the table. (This is much faster than going |
| 239 | ** through and deleting individual elements form the table.) Because of |
| 240 | ** this optimization, the change count for "DELETE FROM table" will be |
| 241 | ** zero regardless of the number of elements that were originally in the |
| 242 | ** table. To get an accurate count of the number of rows deleted, use |
| 243 | ** "DELETE FROM table WHERE 1" instead. |
rdc | f146a77 | 2004-02-25 22:51:06 +0000 | [diff] [blame] | 244 | */ |
danielk1977 | b28af71 | 2004-06-21 06:50:26 +0000 | [diff] [blame] | 245 | int sqlite3_total_changes(sqlite3*); |
| 246 | |
drh | 4c50439 | 2000-10-16 22:06:40 +0000 | [diff] [blame] | 247 | /* This function causes any pending database operation to abort and |
| 248 | ** return at its earliest opportunity. This routine is typically |
drh | 66b89c8 | 2000-11-28 20:47:17 +0000 | [diff] [blame] | 249 | ** called in response to a user action such as pressing "Cancel" |
drh | 4c50439 | 2000-10-16 22:06:40 +0000 | [diff] [blame] | 250 | ** or Ctrl-C where the user wants a long query operation to halt |
| 251 | ** immediately. |
| 252 | */ |
danielk1977 | f9d64d2 | 2004-06-19 08:18:07 +0000 | [diff] [blame] | 253 | void sqlite3_interrupt(sqlite3*); |
drh | 4c50439 | 2000-10-16 22:06:40 +0000 | [diff] [blame] | 254 | |
drh | eec553b | 2000-06-02 01:51:20 +0000 | [diff] [blame] | 255 | |
danielk1977 | 61de0d1 | 2004-05-27 23:56:16 +0000 | [diff] [blame] | 256 | /* These functions return true if the given input string comprises |
| 257 | ** one or more complete SQL statements. For the sqlite3_complete() call, |
| 258 | ** the parameter must be a nul-terminated UTF-8 string. For |
| 259 | ** sqlite3_complete16(), a nul-terminated machine byte order UTF-16 string |
| 260 | ** is required. |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 261 | ** |
| 262 | ** The algorithm is simple. If the last token other than spaces |
| 263 | ** and comments is a semicolon, then return true. otherwise return |
| 264 | ** false. |
| 265 | */ |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 266 | int sqlite3_complete(const char *sql); |
danielk1977 | 61de0d1 | 2004-05-27 23:56:16 +0000 | [diff] [blame] | 267 | int sqlite3_complete16(const void *sql); |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 268 | |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 269 | /* |
| 270 | ** This routine identifies a callback function that is invoked |
| 271 | ** whenever an attempt is made to open a database table that is |
| 272 | ** currently locked by another process or thread. If the busy callback |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 273 | ** is NULL, then sqlite3_exec() returns SQLITE_BUSY immediately if |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 274 | ** it finds a locked table. If the busy callback is not NULL, then |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 275 | ** sqlite3_exec() invokes the callback with three arguments. The |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 276 | ** second argument is the name of the locked table and the third |
| 277 | ** argument is the number of times the table has been busy. If the |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 278 | ** busy callback returns 0, then sqlite3_exec() immediately returns |
| 279 | ** SQLITE_BUSY. If the callback returns non-zero, then sqlite3_exec() |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 280 | ** tries to open the table again and the cycle repeats. |
| 281 | ** |
| 282 | ** The default busy callback is NULL. |
| 283 | ** |
| 284 | ** Sqlite is re-entrant, so the busy handler may start a new query. |
| 285 | ** (It is not clear why anyone would every want to do this, but it |
| 286 | ** is allowed, in theory.) But the busy handler may not close the |
| 287 | ** database. Closing the database from a busy handler will delete |
| 288 | ** data structures out from under the executing query and will |
| 289 | ** probably result in a coredump. |
| 290 | */ |
danielk1977 | f9d64d2 | 2004-06-19 08:18:07 +0000 | [diff] [blame] | 291 | int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*); |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 292 | |
| 293 | /* |
| 294 | ** This routine sets a busy handler that sleeps for a while when a |
| 295 | ** table is locked. The handler will sleep multiple times until |
| 296 | ** at least "ms" milleseconds of sleeping have been done. After |
| 297 | ** "ms" milleseconds of sleeping, the handler returns 0 which |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 298 | ** causes sqlite3_exec() to return SQLITE_BUSY. |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 299 | ** |
| 300 | ** Calling this routine with an argument less than or equal to zero |
| 301 | ** turns off all busy handlers. |
| 302 | */ |
danielk1977 | f9d64d2 | 2004-06-19 08:18:07 +0000 | [diff] [blame] | 303 | int sqlite3_busy_timeout(sqlite3*, int ms); |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 304 | |
drh | e371033 | 2000-09-29 13:30:53 +0000 | [diff] [blame] | 305 | /* |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 306 | ** This next routine is really just a wrapper around sqlite3_exec(). |
drh | e371033 | 2000-09-29 13:30:53 +0000 | [diff] [blame] | 307 | ** Instead of invoking a user-supplied callback for each row of the |
| 308 | ** result, this routine remembers each row of the result in memory |
| 309 | ** obtained from malloc(), then returns all of the result after the |
drh | a18c568 | 2000-10-08 22:20:57 +0000 | [diff] [blame] | 310 | ** query has finished. |
| 311 | ** |
| 312 | ** As an example, suppose the query result where this table: |
| 313 | ** |
| 314 | ** Name | Age |
| 315 | ** ----------------------- |
| 316 | ** Alice | 43 |
| 317 | ** Bob | 28 |
| 318 | ** Cindy | 21 |
| 319 | ** |
| 320 | ** If the 3rd argument were &azResult then after the function returns |
drh | 98699b5 | 2000-10-09 12:57:00 +0000 | [diff] [blame] | 321 | ** azResult will contain the following data: |
drh | a18c568 | 2000-10-08 22:20:57 +0000 | [diff] [blame] | 322 | ** |
| 323 | ** azResult[0] = "Name"; |
| 324 | ** azResult[1] = "Age"; |
| 325 | ** azResult[2] = "Alice"; |
| 326 | ** azResult[3] = "43"; |
| 327 | ** azResult[4] = "Bob"; |
| 328 | ** azResult[5] = "28"; |
| 329 | ** azResult[6] = "Cindy"; |
| 330 | ** azResult[7] = "21"; |
| 331 | ** |
| 332 | ** Notice that there is an extra row of data containing the column |
| 333 | ** headers. But the *nrow return value is still 3. *ncolumn is |
| 334 | ** set to 2. In general, the number of values inserted into azResult |
| 335 | ** will be ((*nrow) + 1)*(*ncolumn). |
| 336 | ** |
| 337 | ** After the calling function has finished using the result, it should |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 338 | ** pass the result data pointer to sqlite3_free_table() in order to |
drh | a18c568 | 2000-10-08 22:20:57 +0000 | [diff] [blame] | 339 | ** release the memory that was malloc-ed. Because of the way the |
| 340 | ** malloc() happens, the calling function must not try to call |
danielk1977 | 99b214d | 2005-02-02 01:13:38 +0000 | [diff] [blame] | 341 | ** free() directly. Only sqlite3_free_table() is able to release |
drh | a18c568 | 2000-10-08 22:20:57 +0000 | [diff] [blame] | 342 | ** the memory properly and safely. |
drh | e371033 | 2000-09-29 13:30:53 +0000 | [diff] [blame] | 343 | ** |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 344 | ** The return value of this routine is the same as from sqlite3_exec(). |
drh | e371033 | 2000-09-29 13:30:53 +0000 | [diff] [blame] | 345 | */ |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 346 | int sqlite3_get_table( |
danielk1977 | f9d64d2 | 2004-06-19 08:18:07 +0000 | [diff] [blame] | 347 | sqlite3*, /* An open database */ |
drh | 9f71c2e | 2001-11-03 23:57:09 +0000 | [diff] [blame] | 348 | const char *sql, /* SQL to be executed */ |
drh | e371033 | 2000-09-29 13:30:53 +0000 | [diff] [blame] | 349 | char ***resultp, /* Result written to a char *[] that this points to */ |
| 350 | int *nrow, /* Number of result rows written here */ |
| 351 | int *ncolumn, /* Number of result columns written here */ |
| 352 | char **errmsg /* Error msg written here */ |
| 353 | ); |
| 354 | |
| 355 | /* |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 356 | ** Call this routine to free the memory that sqlite3_get_table() allocated. |
drh | e371033 | 2000-09-29 13:30:53 +0000 | [diff] [blame] | 357 | */ |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 358 | void sqlite3_free_table(char **result); |
drh | e371033 | 2000-09-29 13:30:53 +0000 | [diff] [blame] | 359 | |
drh | a18c568 | 2000-10-08 22:20:57 +0000 | [diff] [blame] | 360 | /* |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 361 | ** The following routines are variants of the "sprintf()" from the |
| 362 | ** standard C library. The resulting string is written into memory |
| 363 | ** obtained from malloc() so that there is never a possiblity of buffer |
| 364 | ** overflow. These routines also implement some additional formatting |
| 365 | ** options that are useful for constructing SQL statements. |
| 366 | ** |
| 367 | ** The strings returned by these routines should be freed by calling |
| 368 | ** sqlite3_free(). |
drh | a18c568 | 2000-10-08 22:20:57 +0000 | [diff] [blame] | 369 | ** |
| 370 | ** All of the usual printf formatting options apply. In addition, there |
| 371 | ** is a "%q" option. %q works like %s in that it substitutes a null-terminated |
drh | 66b89c8 | 2000-11-28 20:47:17 +0000 | [diff] [blame] | 372 | ** string from the argument list. But %q also doubles every '\'' character. |
drh | a18c568 | 2000-10-08 22:20:57 +0000 | [diff] [blame] | 373 | ** %q is designed for use inside a string literal. By doubling each '\'' |
drh | 66b89c8 | 2000-11-28 20:47:17 +0000 | [diff] [blame] | 374 | ** character it escapes that character and allows it to be inserted into |
drh | a18c568 | 2000-10-08 22:20:57 +0000 | [diff] [blame] | 375 | ** the string. |
| 376 | ** |
| 377 | ** For example, so some string variable contains text as follows: |
| 378 | ** |
| 379 | ** char *zText = "It's a happy day!"; |
| 380 | ** |
| 381 | ** We can use this text in an SQL statement as follows: |
| 382 | ** |
drh | 3224b32 | 2005-09-08 10:58:51 +0000 | [diff] [blame] | 383 | ** char *z = sqlite3_mprintf("INSERT INTO TABLES('%q')", zText); |
| 384 | ** sqlite3_exec(db, z, callback1, 0, 0); |
| 385 | ** sqlite3_free(z); |
drh | a18c568 | 2000-10-08 22:20:57 +0000 | [diff] [blame] | 386 | ** |
| 387 | ** Because the %q format string is used, the '\'' character in zText |
| 388 | ** is escaped and the SQL generated is as follows: |
| 389 | ** |
| 390 | ** INSERT INTO table1 VALUES('It''s a happy day!') |
| 391 | ** |
| 392 | ** This is correct. Had we used %s instead of %q, the generated SQL |
| 393 | ** would have looked like this: |
| 394 | ** |
| 395 | ** INSERT INTO table1 VALUES('It's a happy day!'); |
| 396 | ** |
| 397 | ** This second example is an SQL syntax error. As a general rule you |
| 398 | ** should always use %q instead of %s when inserting text into a string |
| 399 | ** literal. |
| 400 | */ |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 401 | char *sqlite3_mprintf(const char*,...); |
| 402 | char *sqlite3_vmprintf(const char*, va_list); |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 403 | void sqlite3_free(char *z); |
drh | feac5f8 | 2004-08-01 00:10:45 +0000 | [diff] [blame] | 404 | char *sqlite3_snprintf(int,char*,const char*, ...); |
drh | 5191b7e | 2002-03-08 02:12:00 +0000 | [diff] [blame] | 405 | |
drh | 1211de3 | 2004-07-26 12:24:22 +0000 | [diff] [blame] | 406 | #ifndef SQLITE_OMIT_AUTHORIZATION |
drh | 5191b7e | 2002-03-08 02:12:00 +0000 | [diff] [blame] | 407 | /* |
drh | ed6c867 | 2003-01-12 18:02:16 +0000 | [diff] [blame] | 408 | ** This routine registers a callback with the SQLite library. The |
drh | b86ccfb | 2003-01-28 23:13:10 +0000 | [diff] [blame] | 409 | ** callback is invoked (at compile-time, not at run-time) for each |
| 410 | ** attempt to access a column of a table in the database. The callback |
| 411 | ** returns SQLITE_OK if access is allowed, SQLITE_DENY if the entire |
| 412 | ** SQL statement should be aborted with an error and SQLITE_IGNORE |
| 413 | ** if the column should be treated as a NULL value. |
drh | ed6c867 | 2003-01-12 18:02:16 +0000 | [diff] [blame] | 414 | */ |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 415 | int sqlite3_set_authorizer( |
danielk1977 | f9d64d2 | 2004-06-19 08:18:07 +0000 | [diff] [blame] | 416 | sqlite3*, |
drh | e22a334 | 2003-04-22 20:30:37 +0000 | [diff] [blame] | 417 | int (*xAuth)(void*,int,const char*,const char*,const char*,const char*), |
drh | e5f9c64 | 2003-01-13 23:27:31 +0000 | [diff] [blame] | 418 | void *pUserData |
drh | ed6c867 | 2003-01-12 18:02:16 +0000 | [diff] [blame] | 419 | ); |
drh | 1211de3 | 2004-07-26 12:24:22 +0000 | [diff] [blame] | 420 | #endif |
drh | ed6c867 | 2003-01-12 18:02:16 +0000 | [diff] [blame] | 421 | |
| 422 | /* |
| 423 | ** The second parameter to the access authorization function above will |
drh | e5f9c64 | 2003-01-13 23:27:31 +0000 | [diff] [blame] | 424 | ** be one of the values below. These values signify what kind of operation |
| 425 | ** is to be authorized. The 3rd and 4th parameters to the authorization |
| 426 | ** function will be parameters or NULL depending on which of the following |
drh | e22a334 | 2003-04-22 20:30:37 +0000 | [diff] [blame] | 427 | ** codes is used as the second parameter. The 5th parameter is the name |
| 428 | ** of the database ("main", "temp", etc.) if applicable. The 6th parameter |
drh | 5cf590c | 2003-04-24 01:45:04 +0000 | [diff] [blame] | 429 | ** is the name of the inner-most trigger or view that is responsible for |
| 430 | ** the access attempt or NULL if this access attempt is directly from |
| 431 | ** input SQL code. |
drh | e5f9c64 | 2003-01-13 23:27:31 +0000 | [diff] [blame] | 432 | ** |
| 433 | ** Arg-3 Arg-4 |
drh | ed6c867 | 2003-01-12 18:02:16 +0000 | [diff] [blame] | 434 | */ |
drh | 77ad4e4 | 2003-01-14 02:49:27 +0000 | [diff] [blame] | 435 | #define SQLITE_COPY 0 /* Table Name File Name */ |
drh | e5f9c64 | 2003-01-13 23:27:31 +0000 | [diff] [blame] | 436 | #define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */ |
| 437 | #define SQLITE_CREATE_TABLE 2 /* Table Name NULL */ |
| 438 | #define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */ |
| 439 | #define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */ |
drh | 77ad4e4 | 2003-01-14 02:49:27 +0000 | [diff] [blame] | 440 | #define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */ |
drh | e5f9c64 | 2003-01-13 23:27:31 +0000 | [diff] [blame] | 441 | #define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */ |
drh | 77ad4e4 | 2003-01-14 02:49:27 +0000 | [diff] [blame] | 442 | #define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */ |
drh | e5f9c64 | 2003-01-13 23:27:31 +0000 | [diff] [blame] | 443 | #define SQLITE_CREATE_VIEW 8 /* View Name NULL */ |
| 444 | #define SQLITE_DELETE 9 /* Table Name NULL */ |
drh | 77ad4e4 | 2003-01-14 02:49:27 +0000 | [diff] [blame] | 445 | #define SQLITE_DROP_INDEX 10 /* Index Name Table Name */ |
drh | e5f9c64 | 2003-01-13 23:27:31 +0000 | [diff] [blame] | 446 | #define SQLITE_DROP_TABLE 11 /* Table Name NULL */ |
drh | 77ad4e4 | 2003-01-14 02:49:27 +0000 | [diff] [blame] | 447 | #define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */ |
drh | e5f9c64 | 2003-01-13 23:27:31 +0000 | [diff] [blame] | 448 | #define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */ |
drh | 77ad4e4 | 2003-01-14 02:49:27 +0000 | [diff] [blame] | 449 | #define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */ |
drh | e5f9c64 | 2003-01-13 23:27:31 +0000 | [diff] [blame] | 450 | #define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */ |
drh | 77ad4e4 | 2003-01-14 02:49:27 +0000 | [diff] [blame] | 451 | #define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */ |
drh | e5f9c64 | 2003-01-13 23:27:31 +0000 | [diff] [blame] | 452 | #define SQLITE_DROP_VIEW 17 /* View Name NULL */ |
| 453 | #define SQLITE_INSERT 18 /* Table Name NULL */ |
| 454 | #define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */ |
| 455 | #define SQLITE_READ 20 /* Table Name Column Name */ |
| 456 | #define SQLITE_SELECT 21 /* NULL NULL */ |
| 457 | #define SQLITE_TRANSACTION 22 /* NULL NULL */ |
| 458 | #define SQLITE_UPDATE 23 /* Table Name Column Name */ |
drh | 81e293b | 2003-06-06 19:00:42 +0000 | [diff] [blame] | 459 | #define SQLITE_ATTACH 24 /* Filename NULL */ |
| 460 | #define SQLITE_DETACH 25 /* Database Name NULL */ |
danielk1977 | 1c8c23c | 2004-11-12 15:53:37 +0000 | [diff] [blame] | 461 | #define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */ |
danielk1977 | 1d54df8 | 2004-11-23 15:41:16 +0000 | [diff] [blame] | 462 | #define SQLITE_REINDEX 27 /* Index Name NULL */ |
drh | e6e0496 | 2005-07-23 02:17:03 +0000 | [diff] [blame] | 463 | #define SQLITE_ANALYZE 28 /* Table Name NULL */ |
drh | 81e293b | 2003-06-06 19:00:42 +0000 | [diff] [blame] | 464 | |
drh | ed6c867 | 2003-01-12 18:02:16 +0000 | [diff] [blame] | 465 | |
| 466 | /* |
| 467 | ** The return value of the authorization function should be one of the |
| 468 | ** following constants: |
| 469 | */ |
| 470 | /* #define SQLITE_OK 0 // Allow access (This is actually defined above) */ |
| 471 | #define SQLITE_DENY 1 /* Abort the SQL statement with an error */ |
| 472 | #define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */ |
| 473 | |
| 474 | /* |
drh | 19e2d37 | 2005-08-29 23:00:03 +0000 | [diff] [blame] | 475 | ** Register a function for tracing SQL command evaluation. The function |
| 476 | ** registered by sqlite3_trace() is invoked at the first sqlite3_step() |
| 477 | ** for the evaluation of an SQL statement. The function registered by |
| 478 | ** sqlite3_profile() runs at the end of each SQL statement and includes |
| 479 | ** information on how long that statement ran. |
| 480 | ** |
| 481 | ** The sqlite3_profile() API is currently considered experimental and |
| 482 | ** is subject to change. |
drh | 18de482 | 2003-01-16 16:28:53 +0000 | [diff] [blame] | 483 | */ |
danielk1977 | f9d64d2 | 2004-06-19 08:18:07 +0000 | [diff] [blame] | 484 | void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*); |
drh | 19e2d37 | 2005-08-29 23:00:03 +0000 | [diff] [blame] | 485 | void *sqlite3_profile(sqlite3*, |
| 486 | void(*xProfile)(void*,const char*,sqlite_uint64), void*); |
drh | 18de482 | 2003-01-16 16:28:53 +0000 | [diff] [blame] | 487 | |
danielk1977 | 348bb5d | 2003-10-18 09:37:26 +0000 | [diff] [blame] | 488 | /* |
| 489 | ** This routine configures a callback function - the progress callback - that |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 490 | ** is invoked periodically during long running calls to sqlite3_exec(), |
danielk1977 | 2097e94 | 2004-11-20 06:05:56 +0000 | [diff] [blame] | 491 | ** sqlite3_step() and sqlite3_get_table(). An example use for this API is to |
| 492 | ** keep a GUI updated during a large query. |
danielk1977 | 348bb5d | 2003-10-18 09:37:26 +0000 | [diff] [blame] | 493 | ** |
| 494 | ** The progress callback is invoked once for every N virtual machine opcodes, |
| 495 | ** where N is the second argument to this function. The progress callback |
| 496 | ** itself is identified by the third argument to this function. The fourth |
| 497 | ** argument to this function is a void pointer passed to the progress callback |
| 498 | ** function each time it is invoked. |
| 499 | ** |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 500 | ** If a call to sqlite3_exec(), sqlite3_step() or sqlite3_get_table() results |
danielk1977 | 348bb5d | 2003-10-18 09:37:26 +0000 | [diff] [blame] | 501 | ** in less than N opcodes being executed, then the progress callback is not |
| 502 | ** invoked. |
| 503 | ** |
danielk1977 | 348bb5d | 2003-10-18 09:37:26 +0000 | [diff] [blame] | 504 | ** To remove the progress callback altogether, pass NULL as the third |
| 505 | ** argument to this function. |
| 506 | ** |
| 507 | ** If the progress callback returns a result other than 0, then the current |
| 508 | ** query is immediately terminated and any database changes rolled back. If the |
| 509 | ** query was part of a larger transaction, then the transaction is not rolled |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 510 | ** back and remains active. The sqlite3_exec() call returns SQLITE_ABORT. |
drh | aa940ea | 2004-01-15 02:44:03 +0000 | [diff] [blame] | 511 | ** |
| 512 | ******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ****** |
danielk1977 | 348bb5d | 2003-10-18 09:37:26 +0000 | [diff] [blame] | 513 | */ |
danielk1977 | f9d64d2 | 2004-06-19 08:18:07 +0000 | [diff] [blame] | 514 | void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*); |
danielk1977 | 348bb5d | 2003-10-18 09:37:26 +0000 | [diff] [blame] | 515 | |
drh | aa940ea | 2004-01-15 02:44:03 +0000 | [diff] [blame] | 516 | /* |
| 517 | ** Register a callback function to be invoked whenever a new transaction |
| 518 | ** is committed. The pArg argument is passed through to the callback. |
| 519 | ** callback. If the callback function returns non-zero, then the commit |
| 520 | ** is converted into a rollback. |
| 521 | ** |
| 522 | ** If another function was previously registered, its pArg value is returned. |
| 523 | ** Otherwise NULL is returned. |
| 524 | ** |
| 525 | ** Registering a NULL function disables the callback. |
| 526 | ** |
| 527 | ******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ****** |
| 528 | */ |
danielk1977 | f9d64d2 | 2004-06-19 08:18:07 +0000 | [diff] [blame] | 529 | void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*); |
drh | aa940ea | 2004-01-15 02:44:03 +0000 | [diff] [blame] | 530 | |
drh | 22fbcb8 | 2004-02-01 01:22:50 +0000 | [diff] [blame] | 531 | /* |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 532 | ** Open the sqlite database file "filename". The "filename" is UTF-8 |
| 533 | ** encoded for sqlite3_open() and UTF-16 encoded in the native byte order |
| 534 | ** for sqlite3_open16(). An sqlite3* handle is returned in *ppDb, even |
| 535 | ** if an error occurs. If the database is opened (or created) successfully, |
| 536 | ** then SQLITE_OK is returned. Otherwise an error code is returned. The |
| 537 | ** sqlite3_errmsg() or sqlite3_errmsg16() routines can be used to obtain |
| 538 | ** an English language description of the error. |
drh | 22fbcb8 | 2004-02-01 01:22:50 +0000 | [diff] [blame] | 539 | ** |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 540 | ** If the database file does not exist, then a new database is created. |
| 541 | ** The encoding for the database is UTF-8 if sqlite3_open() is called and |
| 542 | ** UTF-16 if sqlite3_open16 is used. |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 543 | ** |
| 544 | ** Whether or not an error occurs when it is opened, resources associated |
| 545 | ** with the sqlite3* handle should be released by passing it to |
| 546 | ** sqlite3_close() when it is no longer required. |
| 547 | */ |
| 548 | int sqlite3_open( |
| 549 | const char *filename, /* Database filename (UTF-8) */ |
danielk1977 | 4f057f9 | 2004-06-08 00:02:33 +0000 | [diff] [blame] | 550 | sqlite3 **ppDb /* OUT: SQLite db handle */ |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 551 | ); |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 552 | int sqlite3_open16( |
| 553 | const void *filename, /* Database filename (UTF-16) */ |
danielk1977 | 4f057f9 | 2004-06-08 00:02:33 +0000 | [diff] [blame] | 554 | sqlite3 **ppDb /* OUT: SQLite db handle */ |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 555 | ); |
danielk1977 | 295ba55 | 2004-05-19 10:34:51 +0000 | [diff] [blame] | 556 | |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 557 | /* |
| 558 | ** Return the error code for the most recent sqlite3_* API call associated |
| 559 | ** with sqlite3 handle 'db'. SQLITE_OK is returned if the most recent |
| 560 | ** API call was successful. |
| 561 | ** |
| 562 | ** Calls to many sqlite3_* functions set the error code and string returned |
| 563 | ** by sqlite3_errcode(), sqlite3_errmsg() and sqlite3_errmsg16() |
| 564 | ** (overwriting the previous values). Note that calls to sqlite3_errcode(), |
| 565 | ** sqlite3_errmsg() and sqlite3_errmsg16() themselves do not affect the |
| 566 | ** results of future invocations. |
| 567 | ** |
| 568 | ** Assuming no other intervening sqlite3_* API calls are made, the error |
| 569 | ** code returned by this function is associated with the same error as |
| 570 | ** the strings returned by sqlite3_errmsg() and sqlite3_errmsg16(). |
| 571 | */ |
| 572 | int sqlite3_errcode(sqlite3 *db); |
| 573 | |
| 574 | /* |
| 575 | ** Return a pointer to a UTF-8 encoded string describing in english the |
| 576 | ** error condition for the most recent sqlite3_* API call. The returned |
| 577 | ** string is always terminated by an 0x00 byte. |
| 578 | ** |
| 579 | ** The string "not an error" is returned when the most recent API call was |
| 580 | ** successful. |
| 581 | */ |
| 582 | const char *sqlite3_errmsg(sqlite3*); |
| 583 | |
| 584 | /* |
| 585 | ** Return a pointer to a UTF-16 native byte order encoded string describing |
| 586 | ** in english the error condition for the most recent sqlite3_* API call. |
| 587 | ** The returned string is always terminated by a pair of 0x00 bytes. |
| 588 | ** |
| 589 | ** The string "not an error" is returned when the most recent API call was |
| 590 | ** successful. |
| 591 | */ |
| 592 | const void *sqlite3_errmsg16(sqlite3*); |
| 593 | |
| 594 | /* |
| 595 | ** An instance of the following opaque structure is used to represent |
| 596 | ** a compiled SQL statment. |
| 597 | */ |
danielk1977 | fc57d7b | 2004-05-26 02:04:57 +0000 | [diff] [blame] | 598 | typedef struct sqlite3_stmt sqlite3_stmt; |
| 599 | |
danielk1977 | e3209e4 | 2004-05-20 01:40:18 +0000 | [diff] [blame] | 600 | /* |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 601 | ** To execute an SQL query, it must first be compiled into a byte-code |
| 602 | ** program using one of the following routines. The only difference between |
| 603 | ** them is that the second argument, specifying the SQL statement to |
| 604 | ** compile, is assumed to be encoded in UTF-8 for the sqlite3_prepare() |
| 605 | ** function and UTF-16 for sqlite3_prepare16(). |
| 606 | ** |
| 607 | ** The first parameter "db" is an SQLite database handle. The second |
| 608 | ** parameter "zSql" is the statement to be compiled, encoded as either |
| 609 | ** UTF-8 or UTF-16 (see above). If the next parameter, "nBytes", is less |
| 610 | ** than zero, then zSql is read up to the first nul terminator. If |
| 611 | ** "nBytes" is not less than zero, then it is the length of the string zSql |
| 612 | ** in bytes (not characters). |
| 613 | ** |
| 614 | ** *pzTail is made to point to the first byte past the end of the first |
| 615 | ** SQL statement in zSql. This routine only compiles the first statement |
| 616 | ** in zSql, so *pzTail is left pointing to what remains uncompiled. |
| 617 | ** |
| 618 | ** *ppStmt is left pointing to a compiled SQL statement that can be |
| 619 | ** executed using sqlite3_step(). Or if there is an error, *ppStmt may be |
| 620 | ** set to NULL. If the input text contained no SQL (if the input is and |
| 621 | ** empty string or a comment) then *ppStmt is set to NULL. |
| 622 | ** |
| 623 | ** On success, SQLITE_OK is returned. Otherwise an error code is returned. |
| 624 | */ |
| 625 | int sqlite3_prepare( |
| 626 | sqlite3 *db, /* Database handle */ |
| 627 | const char *zSql, /* SQL statement, UTF-8 encoded */ |
| 628 | int nBytes, /* Length of zSql in bytes. */ |
| 629 | sqlite3_stmt **ppStmt, /* OUT: Statement handle */ |
| 630 | const char **pzTail /* OUT: Pointer to unused portion of zSql */ |
| 631 | ); |
| 632 | int sqlite3_prepare16( |
| 633 | sqlite3 *db, /* Database handle */ |
| 634 | const void *zSql, /* SQL statement, UTF-16 encoded */ |
| 635 | int nBytes, /* Length of zSql in bytes. */ |
| 636 | sqlite3_stmt **ppStmt, /* OUT: Statement handle */ |
| 637 | const void **pzTail /* OUT: Pointer to unused portion of zSql */ |
| 638 | ); |
| 639 | |
| 640 | /* |
drh | f447950 | 2004-05-27 03:12:53 +0000 | [diff] [blame] | 641 | ** Pointers to the following two opaque structures are used to communicate |
| 642 | ** with the implementations of user-defined functions. |
| 643 | */ |
| 644 | typedef struct sqlite3_context sqlite3_context; |
| 645 | typedef struct Mem sqlite3_value; |
| 646 | |
| 647 | /* |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 648 | ** In the SQL strings input to sqlite3_prepare() and sqlite3_prepare16(), |
drh | 32c0d4f | 2004-12-07 02:14:51 +0000 | [diff] [blame] | 649 | ** one or more literals can be replace by parameters "?" or ":AAA" or |
| 650 | ** "$VVV" where AAA is an identifer and VVV is a variable name according |
| 651 | ** to the syntax rules of the TCL programming language. |
| 652 | ** The value of these parameters (also called "host parameter names") can |
| 653 | ** be set using the routines listed below. |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 654 | ** |
| 655 | ** In every case, the first parameter is a pointer to the sqlite3_stmt |
| 656 | ** structure returned from sqlite3_prepare(). The second parameter is the |
drh | 32c0d4f | 2004-12-07 02:14:51 +0000 | [diff] [blame] | 657 | ** index of the parameter. The first parameter as an index of 1. For |
| 658 | ** named parameters (":AAA" or "$VVV") you can use |
| 659 | ** sqlite3_bind_parameter_index() to get the correct index value given |
| 660 | ** the parameters name. If the same named parameter occurs more than |
| 661 | ** once, it is assigned the same index each time. |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 662 | ** |
drh | 900dfba | 2004-07-21 15:21:36 +0000 | [diff] [blame] | 663 | ** The fifth parameter to sqlite3_bind_blob(), sqlite3_bind_text(), and |
| 664 | ** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or |
| 665 | ** text after SQLite has finished with it. If the fifth argument is the |
| 666 | ** special value SQLITE_STATIC, then the library assumes that the information |
| 667 | ** is in static, unmanaged space and does not need to be freed. If the |
| 668 | ** fifth argument has the value SQLITE_TRANSIENT, then SQLite makes its |
| 669 | ** own private copy of the data. |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 670 | ** |
| 671 | ** The sqlite3_bind_* routine must be called before sqlite3_step() after |
drh | 32c0d4f | 2004-12-07 02:14:51 +0000 | [diff] [blame] | 672 | ** an sqlite3_prepare() or sqlite3_reset(). Unbound parameterss are |
| 673 | ** interpreted as NULL. |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 674 | */ |
danielk1977 | d812336 | 2004-06-12 09:25:12 +0000 | [diff] [blame] | 675 | int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*)); |
drh | f447950 | 2004-05-27 03:12:53 +0000 | [diff] [blame] | 676 | int sqlite3_bind_double(sqlite3_stmt*, int, double); |
| 677 | int sqlite3_bind_int(sqlite3_stmt*, int, int); |
drh | efad999 | 2004-06-22 12:13:55 +0000 | [diff] [blame] | 678 | int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite_int64); |
drh | f447950 | 2004-05-27 03:12:53 +0000 | [diff] [blame] | 679 | int sqlite3_bind_null(sqlite3_stmt*, int); |
danielk1977 | d812336 | 2004-06-12 09:25:12 +0000 | [diff] [blame] | 680 | int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*)); |
| 681 | int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*)); |
drh | f447950 | 2004-05-27 03:12:53 +0000 | [diff] [blame] | 682 | int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*); |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 683 | |
| 684 | /* |
drh | 32c0d4f | 2004-12-07 02:14:51 +0000 | [diff] [blame] | 685 | ** Return the number of parameters in a compiled SQL statement. This |
drh | 75f6a03 | 2004-07-15 14:15:00 +0000 | [diff] [blame] | 686 | ** routine was added to support DBD::SQLite. |
drh | 75f6a03 | 2004-07-15 14:15:00 +0000 | [diff] [blame] | 687 | */ |
| 688 | int sqlite3_bind_parameter_count(sqlite3_stmt*); |
| 689 | |
| 690 | /* |
drh | 32c0d4f | 2004-12-07 02:14:51 +0000 | [diff] [blame] | 691 | ** Return the name of the i-th parameter. Ordinary parameters "?" are |
| 692 | ** nameless and a NULL is returned. For parameters of the form :AAA or |
| 693 | ** $VVV the complete text of the parameter name is returned, including |
| 694 | ** the initial ":" or "$". NULL is returned if the index is out of range. |
drh | 895d747 | 2004-08-20 16:02:39 +0000 | [diff] [blame] | 695 | */ |
| 696 | const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int); |
| 697 | |
| 698 | /* |
drh | fa6bc00 | 2004-09-07 16:19:52 +0000 | [diff] [blame] | 699 | ** Return the index of a parameter with the given name. The name |
| 700 | ** must match exactly. If no parameter with the given name is found, |
| 701 | ** return 0. |
| 702 | */ |
| 703 | int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName); |
| 704 | |
| 705 | /* |
danielk1977 | 600dd0b | 2005-01-20 01:14:23 +0000 | [diff] [blame] | 706 | ** Set all the parameters in the compiled SQL statement to NULL. |
danielk1977 | 600dd0b | 2005-01-20 01:14:23 +0000 | [diff] [blame] | 707 | */ |
| 708 | int sqlite3_clear_bindings(sqlite3_stmt*); |
| 709 | |
| 710 | /* |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 711 | ** Return the number of columns in the result set returned by the compiled |
| 712 | ** SQL statement. This routine returns 0 if pStmt is an SQL statement |
| 713 | ** that does not return data (for example an UPDATE). |
| 714 | */ |
| 715 | int sqlite3_column_count(sqlite3_stmt *pStmt); |
| 716 | |
| 717 | /* |
| 718 | ** The first parameter is a compiled SQL statement. This function returns |
| 719 | ** the column heading for the Nth column of that statement, where N is the |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 720 | ** second function parameter. The string returned is UTF-8 for |
| 721 | ** sqlite3_column_name() and UTF-16 for sqlite3_column_name16(). |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 722 | */ |
| 723 | const char *sqlite3_column_name(sqlite3_stmt*,int); |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 724 | const void *sqlite3_column_name16(sqlite3_stmt*,int); |
| 725 | |
| 726 | /* |
| 727 | ** The first parameter is a compiled SQL statement. If this statement |
| 728 | ** is a SELECT statement, the Nth column of the returned result set |
| 729 | ** of the SELECT is a table column then the declared type of the table |
| 730 | ** column is returned. If the Nth column of the result set is not at table |
| 731 | ** column, then a NULL pointer is returned. The returned string is always |
| 732 | ** UTF-8 encoded. For example, in the database schema: |
| 733 | ** |
| 734 | ** CREATE TABLE t1(c1 VARIANT); |
| 735 | ** |
| 736 | ** And the following statement compiled: |
| 737 | ** |
| 738 | ** SELECT c1 + 1, 0 FROM t1; |
| 739 | ** |
| 740 | ** Then this routine would return the string "VARIANT" for the second |
| 741 | ** result column (i==1), and a NULL pointer for the first result column |
| 742 | ** (i==0). |
| 743 | */ |
| 744 | const char *sqlite3_column_decltype(sqlite3_stmt *, int i); |
| 745 | |
| 746 | /* |
| 747 | ** The first parameter is a compiled SQL statement. If this statement |
| 748 | ** is a SELECT statement, the Nth column of the returned result set |
| 749 | ** of the SELECT is a table column then the declared type of the table |
| 750 | ** column is returned. If the Nth column of the result set is not at table |
| 751 | ** column, then a NULL pointer is returned. The returned string is always |
| 752 | ** UTF-16 encoded. For example, in the database schema: |
| 753 | ** |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 754 | ** CREATE TABLE t1(c1 INTEGER); |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 755 | ** |
| 756 | ** And the following statement compiled: |
| 757 | ** |
| 758 | ** SELECT c1 + 1, 0 FROM t1; |
| 759 | ** |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 760 | ** Then this routine would return the string "INTEGER" for the second |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 761 | ** result column (i==1), and a NULL pointer for the first result column |
| 762 | ** (i==0). |
| 763 | */ |
| 764 | const void *sqlite3_column_decltype16(sqlite3_stmt*,int); |
| 765 | |
danielk1977 | 106bb23 | 2004-05-21 10:08:53 +0000 | [diff] [blame] | 766 | /* |
| 767 | ** After an SQL query has been compiled with a call to either |
| 768 | ** sqlite3_prepare() or sqlite3_prepare16(), then this function must be |
| 769 | ** called one or more times to execute the statement. |
| 770 | ** |
| 771 | ** The return value will be either SQLITE_BUSY, SQLITE_DONE, |
| 772 | ** SQLITE_ROW, SQLITE_ERROR, or SQLITE_MISUSE. |
| 773 | ** |
| 774 | ** SQLITE_BUSY means that the database engine attempted to open |
| 775 | ** a locked database and there is no busy callback registered. |
| 776 | ** Call sqlite3_step() again to retry the open. |
| 777 | ** |
| 778 | ** SQLITE_DONE means that the statement has finished executing |
| 779 | ** successfully. sqlite3_step() should not be called again on this virtual |
| 780 | ** machine. |
| 781 | ** |
| 782 | ** If the SQL statement being executed returns any data, then |
| 783 | ** SQLITE_ROW is returned each time a new row of data is ready |
| 784 | ** for processing by the caller. The values may be accessed using |
| 785 | ** the sqlite3_column_*() functions described below. sqlite3_step() |
| 786 | ** is called again to retrieve the next row of data. |
| 787 | ** |
| 788 | ** SQLITE_ERROR means that a run-time error (such as a constraint |
| 789 | ** violation) has occurred. sqlite3_step() should not be called again on |
| 790 | ** the VM. More information may be found by calling sqlite3_errmsg(). |
| 791 | ** |
| 792 | ** SQLITE_MISUSE means that the this routine was called inappropriately. |
| 793 | ** Perhaps it was called on a virtual machine that had already been |
| 794 | ** finalized or on one that had previously returned SQLITE_ERROR or |
| 795 | ** SQLITE_DONE. Or it could be the case the the same database connection |
| 796 | ** is being used simulataneously by two or more threads. |
| 797 | */ |
danielk1977 | 17240fd | 2004-05-26 00:07:25 +0000 | [diff] [blame] | 798 | int sqlite3_step(sqlite3_stmt*); |
danielk1977 | 106bb23 | 2004-05-21 10:08:53 +0000 | [diff] [blame] | 799 | |
danielk1977 | 106bb23 | 2004-05-21 10:08:53 +0000 | [diff] [blame] | 800 | /* |
| 801 | ** Return the number of values in the current row of the result set. |
| 802 | ** |
| 803 | ** After a call to sqlite3_step() that returns SQLITE_ROW, this routine |
| 804 | ** will return the same value as the sqlite3_column_count() function. |
| 805 | ** After sqlite3_step() has returned an SQLITE_DONE, SQLITE_BUSY or |
| 806 | ** error code, or before sqlite3_step() has been called on a |
| 807 | ** compiled SQL statement, this routine returns zero. |
| 808 | */ |
danielk1977 | 93d4675 | 2004-05-23 13:30:58 +0000 | [diff] [blame] | 809 | int sqlite3_data_count(sqlite3_stmt *pStmt); |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 810 | |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 811 | /* |
| 812 | ** Values are stored in the database in one of the following fundamental |
| 813 | ** types. |
| 814 | */ |
drh | 9c05483 | 2004-05-31 18:51:57 +0000 | [diff] [blame] | 815 | #define SQLITE_INTEGER 1 |
| 816 | #define SQLITE_FLOAT 2 |
drh | 1e284f4 | 2004-10-06 15:52:01 +0000 | [diff] [blame] | 817 | /* #define SQLITE_TEXT 3 // See below */ |
drh | 9c05483 | 2004-05-31 18:51:57 +0000 | [diff] [blame] | 818 | #define SQLITE_BLOB 4 |
| 819 | #define SQLITE_NULL 5 |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 820 | |
danielk1977 | 106bb23 | 2004-05-21 10:08:53 +0000 | [diff] [blame] | 821 | /* |
drh | 1e284f4 | 2004-10-06 15:52:01 +0000 | [diff] [blame] | 822 | ** SQLite version 2 defines SQLITE_TEXT differently. To allow both |
| 823 | ** version 2 and version 3 to be included, undefine them both if a |
| 824 | ** conflict is seen. Define SQLITE3_TEXT to be the version 3 value. |
| 825 | */ |
| 826 | #ifdef SQLITE_TEXT |
| 827 | # undef SQLITE_TEXT |
| 828 | #else |
| 829 | # define SQLITE_TEXT 3 |
| 830 | #endif |
| 831 | #define SQLITE3_TEXT 3 |
| 832 | |
| 833 | /* |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 834 | ** The next group of routines returns information about the information |
| 835 | ** in a single column of the current result row of a query. In every |
| 836 | ** case the first parameter is a pointer to the SQL statement that is being |
| 837 | ** executed (the sqlite_stmt* that was returned from sqlite3_prepare()) and |
| 838 | ** the second argument is the index of the column for which information |
| 839 | ** should be returned. iCol is zero-indexed. The left-most column as an |
| 840 | ** index of 0. |
danielk1977 | 106bb23 | 2004-05-21 10:08:53 +0000 | [diff] [blame] | 841 | ** |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 842 | ** If the SQL statement is not currently point to a valid row, or if the |
| 843 | ** the colulmn index is out of range, the result is undefined. |
| 844 | ** |
| 845 | ** These routines attempt to convert the value where appropriate. For |
| 846 | ** example, if the internal representation is FLOAT and a text result |
| 847 | ** is requested, sprintf() is used internally to do the conversion |
| 848 | ** automatically. The following table details the conversions that |
| 849 | ** are applied: |
| 850 | ** |
| 851 | ** Internal Type Requested Type Conversion |
| 852 | ** ------------- -------------- -------------------------- |
| 853 | ** NULL INTEGER Result is 0 |
| 854 | ** NULL FLOAT Result is 0.0 |
| 855 | ** NULL TEXT Result is an empty string |
| 856 | ** NULL BLOB Result is a zero-length BLOB |
| 857 | ** INTEGER FLOAT Convert from integer to float |
| 858 | ** INTEGER TEXT ASCII rendering of the integer |
| 859 | ** INTEGER BLOB Same as for INTEGER->TEXT |
| 860 | ** FLOAT INTEGER Convert from float to integer |
| 861 | ** FLOAT TEXT ASCII rendering of the float |
| 862 | ** FLOAT BLOB Same as FLOAT->TEXT |
| 863 | ** TEXT INTEGER Use atoi() |
| 864 | ** TEXT FLOAT Use atof() |
| 865 | ** TEXT BLOB No change |
| 866 | ** BLOB INTEGER Convert to TEXT then use atoi() |
| 867 | ** BLOB FLOAT Convert to TEXT then use atof() |
| 868 | ** BLOB TEXT Add a \000 terminator if needed |
| 869 | ** |
| 870 | ** The following access routines are provided: |
| 871 | ** |
| 872 | ** _type() Return the datatype of the result. This is one of |
| 873 | ** SQLITE_INTEGER, SQLITE_FLOAT, SQLITE_TEXT, SQLITE_BLOB, |
| 874 | ** or SQLITE_NULL. |
| 875 | ** _blob() Return the value of a BLOB. |
| 876 | ** _bytes() Return the number of bytes in a BLOB value or the number |
| 877 | ** of bytes in a TEXT value represented as UTF-8. The \000 |
| 878 | ** terminator is included in the byte count for TEXT values. |
| 879 | ** _bytes16() Return the number of bytes in a BLOB value or the number |
| 880 | ** of bytes in a TEXT value represented as UTF-16. The \u0000 |
| 881 | ** terminator is included in the byte count for TEXT values. |
| 882 | ** _double() Return a FLOAT value. |
| 883 | ** _int() Return an INTEGER value in the host computer's native |
| 884 | ** integer representation. This might be either a 32- or 64-bit |
| 885 | ** integer depending on the host. |
| 886 | ** _int64() Return an INTEGER value as a 64-bit signed integer. |
| 887 | ** _text() Return the value as UTF-8 text. |
| 888 | ** _text16() Return the value as UTF-16 text. |
danielk1977 | 106bb23 | 2004-05-21 10:08:53 +0000 | [diff] [blame] | 889 | */ |
drh | f447950 | 2004-05-27 03:12:53 +0000 | [diff] [blame] | 890 | const void *sqlite3_column_blob(sqlite3_stmt*, int iCol); |
| 891 | int sqlite3_column_bytes(sqlite3_stmt*, int iCol); |
| 892 | int sqlite3_column_bytes16(sqlite3_stmt*, int iCol); |
| 893 | double sqlite3_column_double(sqlite3_stmt*, int iCol); |
| 894 | int sqlite3_column_int(sqlite3_stmt*, int iCol); |
drh | efad999 | 2004-06-22 12:13:55 +0000 | [diff] [blame] | 895 | sqlite_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol); |
drh | f447950 | 2004-05-27 03:12:53 +0000 | [diff] [blame] | 896 | const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol); |
| 897 | const void *sqlite3_column_text16(sqlite3_stmt*, int iCol); |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 898 | int sqlite3_column_type(sqlite3_stmt*, int iCol); |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 899 | |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 900 | /* |
| 901 | ** The sqlite3_finalize() function is called to delete a compiled |
| 902 | ** SQL statement obtained by a previous call to sqlite3_prepare() |
| 903 | ** or sqlite3_prepare16(). If the statement was executed successfully, or |
| 904 | ** not executed at all, then SQLITE_OK is returned. If execution of the |
| 905 | ** statement failed then an error code is returned. |
| 906 | ** |
| 907 | ** This routine can be called at any point during the execution of the |
| 908 | ** virtual machine. If the virtual machine has not completed execution |
| 909 | ** when this routine is called, that is like encountering an error or |
| 910 | ** an interrupt. (See sqlite3_interrupt().) Incomplete updates may be |
| 911 | ** rolled back and transactions cancelled, depending on the circumstances, |
| 912 | ** and the result code returned will be SQLITE_ABORT. |
| 913 | */ |
| 914 | int sqlite3_finalize(sqlite3_stmt *pStmt); |
| 915 | |
| 916 | /* |
| 917 | ** The sqlite3_reset() function is called to reset a compiled SQL |
| 918 | ** statement obtained by a previous call to sqlite3_prepare() or |
| 919 | ** sqlite3_prepare16() back to it's initial state, ready to be re-executed. |
| 920 | ** Any SQL statement variables that had values bound to them using |
| 921 | ** the sqlite3_bind_*() API retain their values. |
| 922 | */ |
| 923 | int sqlite3_reset(sqlite3_stmt *pStmt); |
| 924 | |
| 925 | /* |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 926 | ** The following two functions are used to add user functions or aggregates |
| 927 | ** implemented in C to the SQL langauge interpreted by SQLite. The |
| 928 | ** difference only between the two is that the second parameter, the |
| 929 | ** name of the (scalar) function or aggregate, is encoded in UTF-8 for |
| 930 | ** sqlite3_create_function() and UTF-16 for sqlite3_create_function16(). |
| 931 | ** |
| 932 | ** The first argument is the database handle that the new function or |
| 933 | ** aggregate is to be added to. If a single program uses more than one |
| 934 | ** database handle internally, then user functions or aggregates must |
| 935 | ** be added individually to each database handle with which they will be |
| 936 | ** used. |
| 937 | ** |
| 938 | ** The third parameter is the number of arguments that the function or |
| 939 | ** aggregate takes. If this parameter is negative, then the function or |
| 940 | ** aggregate may take any number of arguments. |
| 941 | ** |
danielk1977 | d812336 | 2004-06-12 09:25:12 +0000 | [diff] [blame] | 942 | ** The fourth parameter is one of SQLITE_UTF* values defined below, |
| 943 | ** indicating the encoding that the function is most likely to handle |
| 944 | ** values in. This does not change the behaviour of the programming |
| 945 | ** interface. However, if two versions of the same function are registered |
| 946 | ** with different encoding values, SQLite invokes the version likely to |
| 947 | ** minimize conversions between text encodings. |
danielk1977 | d02eb1f | 2004-06-06 09:44:03 +0000 | [diff] [blame] | 948 | ** |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 949 | ** The seventh, eighth and ninth parameters, xFunc, xStep and xFinal, are |
| 950 | ** pointers to user implemented C functions that implement the user |
| 951 | ** function or aggregate. A scalar function requires an implementation of |
| 952 | ** the xFunc callback only, NULL pointers should be passed as the xStep |
| 953 | ** and xFinal parameters. An aggregate function requires an implementation |
| 954 | ** of xStep and xFinal, but NULL should be passed for xFunc. To delete an |
| 955 | ** existing user function or aggregate, pass NULL for all three function |
| 956 | ** callback. Specifying an inconstent set of callback values, such as an |
| 957 | ** xFunc and an xFinal, or an xStep but no xFinal, SQLITE_ERROR is |
| 958 | ** returned. |
| 959 | */ |
| 960 | int sqlite3_create_function( |
| 961 | sqlite3 *, |
| 962 | const char *zFunctionName, |
| 963 | int nArg, |
| 964 | int eTextRep, |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 965 | void*, |
| 966 | void (*xFunc)(sqlite3_context*,int,sqlite3_value**), |
| 967 | void (*xStep)(sqlite3_context*,int,sqlite3_value**), |
| 968 | void (*xFinal)(sqlite3_context*) |
| 969 | ); |
| 970 | int sqlite3_create_function16( |
| 971 | sqlite3*, |
| 972 | const void *zFunctionName, |
| 973 | int nArg, |
| 974 | int eTextRep, |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 975 | void*, |
| 976 | void (*xFunc)(sqlite3_context*,int,sqlite3_value**), |
| 977 | void (*xStep)(sqlite3_context*,int,sqlite3_value**), |
| 978 | void (*xFinal)(sqlite3_context*) |
| 979 | ); |
| 980 | |
| 981 | /* |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 982 | ** The next routine returns the number of calls to xStep for a particular |
| 983 | ** aggregate function instance. The current call to xStep counts so this |
| 984 | ** routine always returns at least 1. |
| 985 | */ |
| 986 | int sqlite3_aggregate_count(sqlite3_context*); |
| 987 | |
danielk1977 | 0ffba6b | 2004-05-24 09:10:10 +0000 | [diff] [blame] | 988 | /* |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 989 | ** The next group of routines returns information about parameters to |
| 990 | ** a user-defined function. Function implementations use these routines |
| 991 | ** to access their parameters. These routines are the same as the |
| 992 | ** sqlite3_column_* routines except that these routines take a single |
| 993 | ** sqlite3_value* pointer instead of an sqlite3_stmt* and an integer |
| 994 | ** column number. |
danielk1977 | 0ffba6b | 2004-05-24 09:10:10 +0000 | [diff] [blame] | 995 | */ |
drh | f447950 | 2004-05-27 03:12:53 +0000 | [diff] [blame] | 996 | const void *sqlite3_value_blob(sqlite3_value*); |
| 997 | int sqlite3_value_bytes(sqlite3_value*); |
| 998 | int sqlite3_value_bytes16(sqlite3_value*); |
| 999 | double sqlite3_value_double(sqlite3_value*); |
| 1000 | int sqlite3_value_int(sqlite3_value*); |
drh | efad999 | 2004-06-22 12:13:55 +0000 | [diff] [blame] | 1001 | sqlite_int64 sqlite3_value_int64(sqlite3_value*); |
drh | f447950 | 2004-05-27 03:12:53 +0000 | [diff] [blame] | 1002 | const unsigned char *sqlite3_value_text(sqlite3_value*); |
| 1003 | const void *sqlite3_value_text16(sqlite3_value*); |
danielk1977 | d812336 | 2004-06-12 09:25:12 +0000 | [diff] [blame] | 1004 | const void *sqlite3_value_text16le(sqlite3_value*); |
| 1005 | const void *sqlite3_value_text16be(sqlite3_value*); |
danielk1977 | 93d4675 | 2004-05-23 13:30:58 +0000 | [diff] [blame] | 1006 | int sqlite3_value_type(sqlite3_value*); |
danielk1977 | 0ffba6b | 2004-05-24 09:10:10 +0000 | [diff] [blame] | 1007 | |
| 1008 | /* |
danielk1977 | 0ae8b83 | 2004-05-25 12:05:56 +0000 | [diff] [blame] | 1009 | ** Aggregate functions use the following routine to allocate |
| 1010 | ** a structure for storing their state. The first time this routine |
| 1011 | ** is called for a particular aggregate, a new structure of size nBytes |
| 1012 | ** is allocated, zeroed, and returned. On subsequent calls (for the |
| 1013 | ** same aggregate instance) the same buffer is returned. The implementation |
| 1014 | ** of the aggregate can use the returned buffer to accumulate data. |
| 1015 | ** |
| 1016 | ** The buffer allocated is freed automatically by SQLite. |
| 1017 | */ |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 1018 | void *sqlite3_aggregate_context(sqlite3_context*, int nBytes); |
danielk1977 | 7e18c25 | 2004-05-25 11:47:24 +0000 | [diff] [blame] | 1019 | |
| 1020 | /* |
drh | c0f2a01 | 2005-07-09 02:39:40 +0000 | [diff] [blame] | 1021 | ** The pUserData parameter to the sqlite3_create_function() |
| 1022 | ** routine used to register user functions is available to |
| 1023 | ** the implementation of the function using this call. |
danielk1977 | 7e18c25 | 2004-05-25 11:47:24 +0000 | [diff] [blame] | 1024 | */ |
| 1025 | void *sqlite3_user_data(sqlite3_context*); |
| 1026 | |
| 1027 | /* |
danielk1977 | 682f68b | 2004-06-05 10:22:17 +0000 | [diff] [blame] | 1028 | ** The following two functions may be used by scalar user functions to |
| 1029 | ** associate meta-data with argument values. If the same value is passed to |
| 1030 | ** multiple invocations of the user-function during query execution, under |
| 1031 | ** some circumstances the associated meta-data may be preserved. This may |
| 1032 | ** be used, for example, to add a regular-expression matching scalar |
| 1033 | ** function. The compiled version of the regular expression is stored as |
| 1034 | ** meta-data associated with the SQL value passed as the regular expression |
| 1035 | ** pattern. |
| 1036 | ** |
| 1037 | ** Calling sqlite3_get_auxdata() returns a pointer to the meta data |
| 1038 | ** associated with the Nth argument value to the current user function |
| 1039 | ** call, where N is the second parameter. If no meta-data has been set for |
| 1040 | ** that value, then a NULL pointer is returned. |
| 1041 | ** |
| 1042 | ** The sqlite3_set_auxdata() is used to associate meta data with a user |
| 1043 | ** function argument. The third parameter is a pointer to the meta data |
| 1044 | ** to be associated with the Nth user function argument value. The fourth |
| 1045 | ** parameter specifies a 'delete function' that will be called on the meta |
| 1046 | ** data pointer to release it when it is no longer required. If the delete |
| 1047 | ** function pointer is NULL, it is not invoked. |
| 1048 | ** |
| 1049 | ** In practice, meta-data is preserved between function calls for |
| 1050 | ** expressions that are constant at compile time. This includes literal |
| 1051 | ** values and SQL variables. |
| 1052 | */ |
| 1053 | void *sqlite3_get_auxdata(sqlite3_context*, int); |
| 1054 | void sqlite3_set_auxdata(sqlite3_context*, int, void*, void (*)(void*)); |
| 1055 | |
drh | a285422 | 2004-06-17 19:04:17 +0000 | [diff] [blame] | 1056 | |
| 1057 | /* |
| 1058 | ** These are special value for the destructor that is passed in as the |
| 1059 | ** final argument to routines like sqlite3_result_blob(). If the destructor |
| 1060 | ** argument is SQLITE_STATIC, it means that the content pointer is constant |
| 1061 | ** and will never change. It does not need to be destroyed. The |
| 1062 | ** SQLITE_TRANSIENT value means that the content will likely change in |
| 1063 | ** the near future and that SQLite should make its own private copy of |
| 1064 | ** the content before returning. |
| 1065 | */ |
danielk1977 | d812336 | 2004-06-12 09:25:12 +0000 | [diff] [blame] | 1066 | #define SQLITE_STATIC ((void(*)(void *))0) |
| 1067 | #define SQLITE_TRANSIENT ((void(*)(void *))-1) |
| 1068 | |
danielk1977 | 682f68b | 2004-06-05 10:22:17 +0000 | [diff] [blame] | 1069 | /* |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 1070 | ** User-defined functions invoke the following routines in order to |
| 1071 | ** set their return value. |
danielk1977 | 7e18c25 | 2004-05-25 11:47:24 +0000 | [diff] [blame] | 1072 | */ |
danielk1977 | d812336 | 2004-06-12 09:25:12 +0000 | [diff] [blame] | 1073 | void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*)); |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 1074 | void sqlite3_result_double(sqlite3_context*, double); |
danielk1977 | 7e18c25 | 2004-05-25 11:47:24 +0000 | [diff] [blame] | 1075 | void sqlite3_result_error(sqlite3_context*, const char*, int); |
| 1076 | void sqlite3_result_error16(sqlite3_context*, const void*, int); |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 1077 | void sqlite3_result_int(sqlite3_context*, int); |
drh | efad999 | 2004-06-22 12:13:55 +0000 | [diff] [blame] | 1078 | void sqlite3_result_int64(sqlite3_context*, sqlite_int64); |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 1079 | void sqlite3_result_null(sqlite3_context*); |
danielk1977 | d812336 | 2004-06-12 09:25:12 +0000 | [diff] [blame] | 1080 | void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*)); |
| 1081 | void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*)); |
| 1082 | void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*)); |
| 1083 | void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*)); |
drh | 4f26d6c | 2004-05-26 23:25:30 +0000 | [diff] [blame] | 1084 | void sqlite3_result_value(sqlite3_context*, sqlite3_value*); |
drh | f9b596e | 2004-05-26 16:54:42 +0000 | [diff] [blame] | 1085 | |
drh | 52619df | 2004-06-11 17:48:02 +0000 | [diff] [blame] | 1086 | /* |
| 1087 | ** These are the allowed values for the eTextRep argument to |
| 1088 | ** sqlite3_create_collation and sqlite3_create_function. |
| 1089 | */ |
danielk1977 | 466be56 | 2004-06-10 02:16:01 +0000 | [diff] [blame] | 1090 | #define SQLITE_UTF8 1 |
danielk1977 | dc8453f | 2004-06-12 00:42:34 +0000 | [diff] [blame] | 1091 | #define SQLITE_UTF16LE 2 |
| 1092 | #define SQLITE_UTF16BE 3 |
| 1093 | #define SQLITE_UTF16 4 /* Use native byte order */ |
drh | 52619df | 2004-06-11 17:48:02 +0000 | [diff] [blame] | 1094 | #define SQLITE_ANY 5 /* sqlite3_create_function only */ |
danielk1977 | 466be56 | 2004-06-10 02:16:01 +0000 | [diff] [blame] | 1095 | |
danielk1977 | 7cedc8d | 2004-06-10 10:50:08 +0000 | [diff] [blame] | 1096 | /* |
| 1097 | ** These two functions are used to add new collation sequences to the |
| 1098 | ** sqlite3 handle specified as the first argument. |
| 1099 | ** |
| 1100 | ** The name of the new collation sequence is specified as a UTF-8 string |
| 1101 | ** for sqlite3_create_collation() and a UTF-16 string for |
| 1102 | ** sqlite3_create_collation16(). In both cases the name is passed as the |
| 1103 | ** second function argument. |
| 1104 | ** |
| 1105 | ** The third argument must be one of the constants SQLITE_UTF8, |
| 1106 | ** SQLITE_UTF16LE or SQLITE_UTF16BE, indicating that the user-supplied |
| 1107 | ** routine expects to be passed pointers to strings encoded using UTF-8, |
| 1108 | ** UTF-16 little-endian or UTF-16 big-endian respectively. |
| 1109 | ** |
| 1110 | ** A pointer to the user supplied routine must be passed as the fifth |
| 1111 | ** argument. If it is NULL, this is the same as deleting the collation |
| 1112 | ** sequence (so that SQLite cannot call it anymore). Each time the user |
| 1113 | ** supplied function is invoked, it is passed a copy of the void* passed as |
| 1114 | ** the fourth argument to sqlite3_create_collation() or |
| 1115 | ** sqlite3_create_collation16() as its first parameter. |
| 1116 | ** |
| 1117 | ** The remaining arguments to the user-supplied routine are two strings, |
| 1118 | ** each represented by a [length, data] pair and encoded in the encoding |
| 1119 | ** that was passed as the third argument when the collation sequence was |
| 1120 | ** registered. The user routine should return negative, zero or positive if |
| 1121 | ** the first string is less than, equal to, or greater than the second |
| 1122 | ** string. i.e. (STRING1 - STRING2). |
| 1123 | */ |
danielk1977 | 0202b29 | 2004-06-09 09:55:16 +0000 | [diff] [blame] | 1124 | int sqlite3_create_collation( |
| 1125 | sqlite3*, |
| 1126 | const char *zName, |
danielk1977 | 7cedc8d | 2004-06-10 10:50:08 +0000 | [diff] [blame] | 1127 | int eTextRep, |
danielk1977 | 0202b29 | 2004-06-09 09:55:16 +0000 | [diff] [blame] | 1128 | void*, |
| 1129 | int(*xCompare)(void*,int,const void*,int,const void*) |
| 1130 | ); |
| 1131 | int sqlite3_create_collation16( |
| 1132 | sqlite3*, |
| 1133 | const char *zName, |
danielk1977 | 7cedc8d | 2004-06-10 10:50:08 +0000 | [diff] [blame] | 1134 | int eTextRep, |
danielk1977 | 0202b29 | 2004-06-09 09:55:16 +0000 | [diff] [blame] | 1135 | void*, |
| 1136 | int(*xCompare)(void*,int,const void*,int,const void*) |
| 1137 | ); |
| 1138 | |
danielk1977 | 7cedc8d | 2004-06-10 10:50:08 +0000 | [diff] [blame] | 1139 | /* |
| 1140 | ** To avoid having to register all collation sequences before a database |
| 1141 | ** can be used, a single callback function may be registered with the |
| 1142 | ** database handle to be called whenever an undefined collation sequence is |
| 1143 | ** required. |
| 1144 | ** |
| 1145 | ** If the function is registered using the sqlite3_collation_needed() API, |
| 1146 | ** then it is passed the names of undefined collation sequences as strings |
| 1147 | ** encoded in UTF-8. If sqlite3_collation_needed16() is used, the names |
| 1148 | ** are passed as UTF-16 in machine native byte order. A call to either |
| 1149 | ** function replaces any existing callback. |
| 1150 | ** |
| 1151 | ** When the user-function is invoked, the first argument passed is a copy |
| 1152 | ** of the second argument to sqlite3_collation_needed() or |
| 1153 | ** sqlite3_collation_needed16(). The second argument is the database |
| 1154 | ** handle. The third argument is one of SQLITE_UTF8, SQLITE_UTF16BE or |
| 1155 | ** SQLITE_UTF16LE, indicating the most desirable form of the collation |
| 1156 | ** sequence function required. The fourth parameter is the name of the |
| 1157 | ** required collation sequence. |
| 1158 | ** |
| 1159 | ** The collation sequence is returned to SQLite by a collation-needed |
| 1160 | ** callback using the sqlite3_create_collation() or |
| 1161 | ** sqlite3_create_collation16() APIs, described above. |
| 1162 | */ |
| 1163 | int sqlite3_collation_needed( |
| 1164 | sqlite3*, |
| 1165 | void*, |
| 1166 | void(*)(void*,sqlite3*,int eTextRep,const char*) |
| 1167 | ); |
| 1168 | int sqlite3_collation_needed16( |
| 1169 | sqlite3*, |
| 1170 | void*, |
| 1171 | void(*)(void*,sqlite3*,int eTextRep,const void*) |
| 1172 | ); |
| 1173 | |
drh | 2011d5f | 2004-07-22 02:40:37 +0000 | [diff] [blame] | 1174 | /* |
| 1175 | ** Specify the key for an encrypted database. This routine should be |
| 1176 | ** called right after sqlite3_open(). |
| 1177 | ** |
| 1178 | ** The code to implement this API is not available in the public release |
| 1179 | ** of SQLite. |
| 1180 | */ |
| 1181 | int sqlite3_key( |
| 1182 | sqlite3 *db, /* Database to be rekeyed */ |
| 1183 | const void *pKey, int nKey /* The key */ |
| 1184 | ); |
| 1185 | |
| 1186 | /* |
| 1187 | ** Change the key on an open database. If the current database is not |
| 1188 | ** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the |
| 1189 | ** database is decrypted. |
| 1190 | ** |
| 1191 | ** The code to implement this API is not available in the public release |
| 1192 | ** of SQLite. |
| 1193 | */ |
| 1194 | int sqlite3_rekey( |
| 1195 | sqlite3 *db, /* Database to be rekeyed */ |
| 1196 | const void *pKey, int nKey /* The new key */ |
| 1197 | ); |
danielk1977 | 0202b29 | 2004-06-09 09:55:16 +0000 | [diff] [blame] | 1198 | |
drh | ab3f9fe | 2004-08-14 17:10:10 +0000 | [diff] [blame] | 1199 | /* |
danielk1977 | 600dd0b | 2005-01-20 01:14:23 +0000 | [diff] [blame] | 1200 | ** Sleep for a little while. The second parameter is the number of |
| 1201 | ** miliseconds to sleep for. |
| 1202 | ** |
| 1203 | ** If the operating system does not support sleep requests with |
| 1204 | ** milisecond time resolution, then the time will be rounded up to |
| 1205 | ** the nearest second. The number of miliseconds of sleep actually |
| 1206 | ** requested from the operating system is returned. |
danielk1977 | 600dd0b | 2005-01-20 01:14:23 +0000 | [diff] [blame] | 1207 | */ |
| 1208 | int sqlite3_sleep(int); |
| 1209 | |
| 1210 | /* |
drh | 65efb65 | 2005-06-12 22:12:39 +0000 | [diff] [blame] | 1211 | ** Return TRUE (non-zero) if the statement supplied as an argument needs |
drh | d89bd00 | 2005-01-22 03:03:54 +0000 | [diff] [blame] | 1212 | ** to be recompiled. A statement needs to be recompiled whenever the |
| 1213 | ** execution environment changes in a way that would alter the program |
| 1214 | ** that sqlite3_prepare() generates. For example, if new functions or |
| 1215 | ** collating sequences are registered or if an authorizer function is |
| 1216 | ** added or changed. |
| 1217 | ** |
drh | d89bd00 | 2005-01-22 03:03:54 +0000 | [diff] [blame] | 1218 | */ |
| 1219 | int sqlite3_expired(sqlite3_stmt*); |
| 1220 | |
| 1221 | /* |
drh | f8db1bc | 2005-04-22 02:38:37 +0000 | [diff] [blame] | 1222 | ** Move all bindings from the first prepared statement over to the second. |
| 1223 | ** This routine is useful, for example, if the first prepared statement |
| 1224 | ** fails with an SQLITE_SCHEMA error. The same SQL can be prepared into |
| 1225 | ** the second prepared statement then all of the bindings transfered over |
| 1226 | ** to the second statement before the first statement is finalized. |
drh | f8db1bc | 2005-04-22 02:38:37 +0000 | [diff] [blame] | 1227 | */ |
| 1228 | int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*); |
| 1229 | |
| 1230 | /* |
tpoindex | 9a09a3c | 2004-12-20 19:01:32 +0000 | [diff] [blame] | 1231 | ** If the following global variable is made to point to a |
drh | ab3f9fe | 2004-08-14 17:10:10 +0000 | [diff] [blame] | 1232 | ** string which is the name of a directory, then all temporary files |
| 1233 | ** created by SQLite will be placed in that directory. If this variable |
| 1234 | ** is NULL pointer, then SQLite does a search for an appropriate temporary |
| 1235 | ** file directory. |
| 1236 | ** |
danielk1977 | 6b456a2 | 2005-03-21 04:04:02 +0000 | [diff] [blame] | 1237 | ** Once sqlite3_open() has been called, changing this variable will invalidate |
| 1238 | ** the current temporary database, if any. |
drh | ab3f9fe | 2004-08-14 17:10:10 +0000 | [diff] [blame] | 1239 | */ |
tpoindex | 9a09a3c | 2004-12-20 19:01:32 +0000 | [diff] [blame] | 1240 | extern char *sqlite3_temp_directory; |
drh | ab3f9fe | 2004-08-14 17:10:10 +0000 | [diff] [blame] | 1241 | |
danielk1977 | 6b456a2 | 2005-03-21 04:04:02 +0000 | [diff] [blame] | 1242 | /* |
| 1243 | ** This function is called to recover from a malloc() failure that occured |
| 1244 | ** within the SQLite library. Normally, after a single malloc() fails the |
| 1245 | ** library refuses to function (all major calls return SQLITE_NOMEM). |
drh | 9a7e608 | 2005-03-31 22:26:19 +0000 | [diff] [blame] | 1246 | ** This function restores the library state so that it can be used again. |
danielk1977 | 6b456a2 | 2005-03-21 04:04:02 +0000 | [diff] [blame] | 1247 | ** |
| 1248 | ** All existing statements (sqlite3_stmt pointers) must be finalized or |
| 1249 | ** reset before this call is made. Otherwise, SQLITE_BUSY is returned. |
| 1250 | ** If any in-memory databases are in use, either as a main or TEMP |
| 1251 | ** database, SQLITE_ERROR is returned. In either of these cases, the |
| 1252 | ** library is not reset and remains unusable. |
| 1253 | ** |
| 1254 | ** This function is *not* threadsafe. Calling this from within a threaded |
| 1255 | ** application when threads other than the caller have used SQLite is |
| 1256 | ** dangerous and will almost certainly result in malfunctions. |
| 1257 | ** |
| 1258 | ** This functionality can be omitted from a build by defining the |
| 1259 | ** SQLITE_OMIT_GLOBALRECOVER at compile time. |
| 1260 | */ |
| 1261 | int sqlite3_global_recover(); |
| 1262 | |
drh | 3e1d8e6 | 2005-05-26 16:23:34 +0000 | [diff] [blame] | 1263 | /* |
| 1264 | ** Test to see whether or not the database connection is in autocommit |
| 1265 | ** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on |
| 1266 | ** by default. Autocommit is disabled by a BEGIN statement and reenabled |
| 1267 | ** by the next COMMIT or ROLLBACK. |
drh | 3e1d8e6 | 2005-05-26 16:23:34 +0000 | [diff] [blame] | 1268 | */ |
| 1269 | int sqlite3_get_autocommit(sqlite3*); |
| 1270 | |
drh | 51942bc | 2005-06-12 22:01:42 +0000 | [diff] [blame] | 1271 | /* |
| 1272 | ** Return the sqlite3* database handle to which the prepared statement given |
| 1273 | ** in the argument belongs. This is the same database handle that was |
| 1274 | ** the first argument to the sqlite3_prepare() that was used to create |
| 1275 | ** the statement in the first place. |
| 1276 | */ |
| 1277 | sqlite3 *sqlite3_db_handle(sqlite3_stmt*); |
drh | 3e1d8e6 | 2005-05-26 16:23:34 +0000 | [diff] [blame] | 1278 | |
drh | b37df7b | 2005-10-13 02:09:49 +0000 | [diff] [blame^] | 1279 | /* |
| 1280 | ** Undo the hack that converts floating point types to integer for |
| 1281 | ** builds on processors without floating point support. |
| 1282 | */ |
| 1283 | #ifdef SQLITE_OMIT_FLOATING_POINT |
| 1284 | # undef double |
| 1285 | #endif |
| 1286 | |
drh | 382c024 | 2001-10-06 16:33:02 +0000 | [diff] [blame] | 1287 | #ifdef __cplusplus |
| 1288 | } /* End of the 'extern "C"' block */ |
| 1289 | #endif |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 1290 | #endif |