]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | ** 2001 September 15 | |
3 | ** | |
4 | ** The author disclaims copyright to this source code. In place of | |
5 | ** a legal notice, here is a blessing: | |
6 | ** | |
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. | |
10 | ** | |
11 | ************************************************************************* | |
12 | ** This header file defines the interface that the SQLite library | |
13 | ** presents to client programs. If a C-function, structure, datatype, | |
14 | ** or constant definition does not appear in this file, then it is | |
15 | ** not a published API of SQLite, is subject to change without | |
16 | ** notice, and should not be referenced by programs that use SQLite. | |
17 | ** | |
18 | ** Some of the definitions that are in this file are marked as | |
19 | ** "experimental". Experimental interfaces are normally new | |
20 | ** features recently added to SQLite. We do not anticipate changes | |
21 | ** to experimental interfaces but reserve to make minor changes if | |
22 | ** experience from use "in the wild" suggest such changes are prudent. | |
23 | ** | |
24 | ** The official C-language API documentation for SQLite is derived | |
25 | ** from comments in this file. This file is the authoritative source | |
26 | ** on how SQLite interfaces are suppose to operate. | |
27 | ** | |
28 | ** The name of this file under configuration management is "sqlite.h.in". | |
29 | ** The makefile makes some minor changes to this file (such as inserting | |
30 | ** the version number) and changes its name to "sqlite3.h" as | |
31 | ** part of the build process. | |
32 | ** | |
33 | */ | |
34 | #ifndef _SQLITE3_H_ | |
35 | #define _SQLITE3_H_ | |
36 | #include <stdarg.h> /* Needed for the definition of va_list */ | |
37 | ||
38 | /* | |
39 | ** Make sure we can call this stuff from C++. | |
40 | */ | |
41 | #ifdef __cplusplus | |
42 | extern "C" { | |
43 | #endif | |
44 | ||
45 | ||
46 | /* | |
47 | ** Add the ability to override 'extern' | |
48 | */ | |
49 | #ifndef SQLITE_EXTERN | |
50 | # define SQLITE_EXTERN extern | |
51 | #endif | |
52 | ||
53 | /* | |
54 | ** Make sure these symbols where not defined by some previous header | |
55 | ** file. | |
56 | */ | |
57 | #ifdef SQLITE_VERSION | |
58 | # undef SQLITE_VERSION | |
59 | #endif | |
60 | #ifdef SQLITE_VERSION_NUMBER | |
61 | # undef SQLITE_VERSION_NUMBER | |
62 | #endif | |
63 | ||
64 | /* | |
65 | ** CAPI3REF: Compile-Time Library Version Numbers {F10010} | |
66 | ** | |
67 | ** The SQLITE_VERSION and SQLITE_VERSION_NUMBER #defines in | |
68 | ** the sqlite3.h file specify the version of SQLite with which | |
69 | ** that header file is associated. | |
70 | ** | |
71 | ** The "version" of SQLite is a string of the form "X.Y.Z". | |
72 | ** The phrase "alpha" or "beta" might be appended after the Z. | |
73 | ** The X value is major version number always 3 in SQLite3. | |
74 | ** The X value only changes when backwards compatibility is | |
75 | ** broken and we intend to never break | |
76 | ** backwards compatibility. The Y value is the minor version | |
77 | ** number and only changes when | |
78 | ** there are major feature enhancements that are forwards compatible | |
79 | ** but not backwards compatible. The Z value is release number | |
80 | ** and is incremented with | |
81 | ** each release but resets back to 0 when Y is incremented. | |
82 | ** | |
83 | ** See also: [sqlite3_libversion()] and [sqlite3_libversion_number()]. | |
84 | ** | |
85 | ** INVARIANTS: | |
86 | ** | |
87 | ** {F10011} The SQLITE_VERSION #define in the sqlite3.h header file | |
88 | ** evaluates to a string literal that is the SQLite version | |
89 | ** with which the header file is associated. | |
90 | ** | |
91 | ** {F10014} The SQLITE_VERSION_NUMBER #define resolves to an integer | |
92 | ** with the value (X*1000000 + Y*1000 + Z) where X, Y, and | |
93 | ** Z are the major version, minor version, and release number. | |
94 | */ | |
95 | #define SQLITE_VERSION "3.5.9" | |
96 | #define SQLITE_VERSION_NUMBER 3005009 | |
97 | ||
98 | /* | |
99 | ** CAPI3REF: Run-Time Library Version Numbers {F10020} | |
100 | ** KEYWORDS: sqlite3_version | |
101 | ** | |
102 | ** These features provide the same information as the [SQLITE_VERSION] | |
103 | ** and [SQLITE_VERSION_NUMBER] #defines in the header, but are associated | |
104 | ** with the library instead of the header file. Cautious programmers might | |
105 | ** include a check in their application to verify that | |
106 | ** sqlite3_libversion_number() always returns the value | |
107 | ** [SQLITE_VERSION_NUMBER]. | |
108 | ** | |
109 | ** The sqlite3_libversion() function returns the same information as is | |
110 | ** in the sqlite3_version[] string constant. The function is provided | |
111 | ** for use in DLLs since DLL users usually do not have direct access to string | |
112 | ** constants within the DLL. | |
113 | ** | |
114 | ** INVARIANTS: | |
115 | ** | |
116 | ** {F10021} The [sqlite3_libversion_number()] interface returns an integer | |
117 | ** equal to [SQLITE_VERSION_NUMBER]. | |
118 | ** | |
119 | ** {F10022} The [sqlite3_version] string constant contains the text of the | |
120 | ** [SQLITE_VERSION] string. | |
121 | ** | |
122 | ** {F10023} The [sqlite3_libversion()] function returns | |
123 | ** a pointer to the [sqlite3_version] string constant. | |
124 | */ | |
125 | SQLITE_EXTERN const char sqlite3_version[]; | |
126 | const char *sqlite3_libversion(void); | |
127 | int sqlite3_libversion_number(void); | |
128 | ||
129 | /* | |
130 | ** CAPI3REF: Test To See If The Library Is Threadsafe {F10100} | |
131 | ** | |
132 | ** SQLite can be compiled with or without mutexes. When | |
133 | ** the SQLITE_THREADSAFE C preprocessor macro is true, mutexes | |
134 | ** are enabled and SQLite is threadsafe. When that macro is false, | |
135 | ** the mutexes are omitted. Without the mutexes, it is not safe | |
136 | ** to use SQLite from more than one thread. | |
137 | ** | |
138 | ** There is a measurable performance penalty for enabling mutexes. | |
139 | ** So if speed is of utmost importance, it makes sense to disable | |
140 | ** the mutexes. But for maximum safety, mutexes should be enabled. | |
141 | ** The default behavior is for mutexes to be enabled. | |
142 | ** | |
143 | ** This interface can be used by a program to make sure that the | |
144 | ** version of SQLite that it is linking against was compiled with | |
145 | ** the desired setting of the SQLITE_THREADSAFE macro. | |
146 | ** | |
147 | ** INVARIANTS: | |
148 | ** | |
149 | ** {F10101} The [sqlite3_threadsafe()] function returns nonzero if | |
150 | ** SQLite was compiled with its mutexes enabled or zero | |
151 | ** if SQLite was compiled with mutexes disabled. | |
152 | */ | |
153 | int sqlite3_threadsafe(void); | |
154 | ||
155 | /* | |
156 | ** CAPI3REF: Database Connection Handle {F12000} | |
157 | ** KEYWORDS: {database connection} {database connections} | |
158 | ** | |
159 | ** Each open SQLite database is represented by pointer to an instance of the | |
160 | ** opaque structure named "sqlite3". It is useful to think of an sqlite3 | |
161 | ** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and | |
162 | ** [sqlite3_open_v2()] interfaces are its constructors | |
163 | ** and [sqlite3_close()] is its destructor. There are many other interfaces | |
164 | ** (such as [sqlite3_prepare_v2()], [sqlite3_create_function()], and | |
165 | ** [sqlite3_busy_timeout()] to name but three) that are methods on this | |
166 | ** object. | |
167 | */ | |
168 | typedef struct sqlite3 sqlite3; | |
169 | ||
170 | ||
171 | /* | |
172 | ** CAPI3REF: 64-Bit Integer Types {F10200} | |
173 | ** KEYWORDS: sqlite_int64 sqlite_uint64 | |
174 | ** | |
175 | ** Because there is no cross-platform way to specify 64-bit integer types | |
176 | ** SQLite includes typedefs for 64-bit signed and unsigned integers. | |
177 | ** | |
178 | ** The sqlite3_int64 and sqlite3_uint64 are the preferred type | |
179 | ** definitions. The sqlite_int64 and sqlite_uint64 types are | |
180 | ** supported for backwards compatibility only. | |
181 | ** | |
182 | ** INVARIANTS: | |
183 | ** | |
184 | ** {F10201} The [sqlite_int64] and [sqlite3_int64] types specify a | |
185 | ** 64-bit signed integer. | |
186 | ** | |
187 | ** {F10202} The [sqlite_uint64] and [sqlite3_uint64] types specify | |
188 | ** a 64-bit unsigned integer. | |
189 | */ | |
190 | #ifdef SQLITE_INT64_TYPE | |
191 | typedef SQLITE_INT64_TYPE sqlite_int64; | |
192 | typedef unsigned SQLITE_INT64_TYPE sqlite_uint64; | |
193 | #elif defined(_MSC_VER) || defined(__BORLANDC__) | |
194 | typedef __int64 sqlite_int64; | |
195 | typedef unsigned __int64 sqlite_uint64; | |
196 | #else | |
197 | typedef long long int sqlite_int64; | |
198 | typedef unsigned long long int sqlite_uint64; | |
199 | #endif | |
200 | typedef sqlite_int64 sqlite3_int64; | |
201 | typedef sqlite_uint64 sqlite3_uint64; | |
202 | ||
203 | /* | |
204 | ** If compiling for a processor that lacks floating point support, | |
205 | ** substitute integer for floating-point | |
206 | */ | |
207 | #ifdef SQLITE_OMIT_FLOATING_POINT | |
208 | # define double sqlite3_int64 | |
209 | #endif | |
210 | ||
211 | /* | |
212 | ** CAPI3REF: Closing A Database Connection {F12010} | |
213 | ** | |
214 | ** This routine is the destructor for the [sqlite3] object. | |
215 | ** | |
216 | ** Applications should [sqlite3_finalize | finalize] all | |
217 | ** [prepared statements] and | |
218 | ** [sqlite3_blob_close | close] all [sqlite3_blob | BLOBs] | |
219 | ** associated with the [sqlite3] object prior | |
220 | ** to attempting to close the [sqlite3] object. | |
221 | ** | |
222 | ** <todo>What happens to pending transactions? Are they | |
223 | ** rolled back, or abandoned?</todo> | |
224 | ** | |
225 | ** INVARIANTS: | |
226 | ** | |
227 | ** {F12011} The [sqlite3_close()] interface destroys an [sqlite3] object | |
228 | ** allocated by a prior call to [sqlite3_open()], | |
229 | ** [sqlite3_open16()], or [sqlite3_open_v2()]. | |
230 | ** | |
231 | ** {F12012} The [sqlite3_close()] function releases all memory used by the | |
232 | ** connection and closes all open files. | |
233 | ** | |
234 | ** {F12013} If the database connection contains | |
235 | ** [prepared statements] that have not been | |
236 | ** finalized by [sqlite3_finalize()], then [sqlite3_close()] | |
237 | ** returns [SQLITE_BUSY] and leaves the connection open. | |
238 | ** | |
239 | ** {F12014} Giving sqlite3_close() a NULL pointer is a harmless no-op. | |
240 | ** | |
241 | ** LIMITATIONS: | |
242 | ** | |
243 | ** {U12015} The parameter to [sqlite3_close()] must be an [sqlite3] object | |
244 | ** pointer previously obtained from [sqlite3_open()] or the | |
245 | ** equivalent, or NULL. | |
246 | ** | |
247 | ** {U12016} The parameter to [sqlite3_close()] must not have been previously | |
248 | ** closed. | |
249 | */ | |
250 | int sqlite3_close(sqlite3 *); | |
251 | ||
252 | /* | |
253 | ** The type for a callback function. | |
254 | ** This is legacy and deprecated. It is included for historical | |
255 | ** compatibility and is not documented. | |
256 | */ | |
257 | typedef int (*sqlite3_callback)(void*,int,char**, char**); | |
258 | ||
259 | /* | |
260 | ** CAPI3REF: One-Step Query Execution Interface {F12100} | |
261 | ** | |
262 | ** The sqlite3_exec() interface is a convenient way of running | |
263 | ** one or more SQL statements without a lot of C code. The | |
264 | ** SQL statements are passed in as the second parameter to | |
265 | ** sqlite3_exec(). The statements are evaluated one by one | |
266 | ** until either an error or an interrupt is encountered or | |
267 | ** until they are all done. The 3rd parameter is an optional | |
268 | ** callback that is invoked once for each row of any query results | |
269 | ** produced by the SQL statements. The 5th parameter tells where | |
270 | ** to write any error messages. | |
271 | ** | |
272 | ** The sqlite3_exec() interface is implemented in terms of | |
273 | ** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()]. | |
274 | ** The sqlite3_exec() routine does nothing that cannot be done | |
275 | ** by [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()]. | |
276 | ** The sqlite3_exec() is just a convenient wrapper. | |
277 | ** | |
278 | ** INVARIANTS: | |
279 | ** | |
280 | ** {F12101} The [sqlite3_exec()] interface evaluates zero or more UTF-8 | |
281 | ** encoded, semicolon-separated, SQL statements in the | |
282 | ** zero-terminated string of its 2nd parameter within the | |
283 | ** context of the [sqlite3] object given in the 1st parameter. | |
284 | ** | |
285 | ** {F12104} The return value of [sqlite3_exec()] is SQLITE_OK if all | |
286 | ** SQL statements run successfully. | |
287 | ** | |
288 | ** {F12105} The return value of [sqlite3_exec()] is an appropriate | |
289 | ** non-zero error code if any SQL statement fails. | |
290 | ** | |
291 | ** {F12107} If one or more of the SQL statements handed to [sqlite3_exec()] | |
292 | ** return results and the 3rd parameter is not NULL, then | |
293 | ** the callback function specified by the 3rd parameter is | |
294 | ** invoked once for each row of result. | |
295 | ** | |
296 | ** {F12110} If the callback returns a non-zero value then [sqlite3_exec()] | |
297 | ** will aborted the SQL statement it is currently evaluating, | |
298 | ** skip all subsequent SQL statements, and return [SQLITE_ABORT]. | |
299 | ** <todo>What happens to *errmsg here? Does the result code for | |
300 | ** sqlite3_errcode() get set?</todo> | |
301 | ** | |
302 | ** {F12113} The [sqlite3_exec()] routine will pass its 4th parameter through | |
303 | ** as the 1st parameter of the callback. | |
304 | ** | |
305 | ** {F12116} The [sqlite3_exec()] routine sets the 2nd parameter of its | |
306 | ** callback to be the number of columns in the current row of | |
307 | ** result. | |
308 | ** | |
309 | ** {F12119} The [sqlite3_exec()] routine sets the 3rd parameter of its | |
310 | ** callback to be an array of pointers to strings holding the | |
311 | ** values for each column in the current result set row as | |
312 | ** obtained from [sqlite3_column_text()]. | |
313 | ** | |
314 | ** {F12122} The [sqlite3_exec()] routine sets the 4th parameter of its | |
315 | ** callback to be an array of pointers to strings holding the | |
316 | ** names of result columns as obtained from [sqlite3_column_name()]. | |
317 | ** | |
318 | ** {F12125} If the 3rd parameter to [sqlite3_exec()] is NULL then | |
319 | ** [sqlite3_exec()] never invokes a callback. All query | |
320 | ** results are silently discarded. | |
321 | ** | |
322 | ** {F12128} If an error occurs while parsing or evaluating any of the SQL | |
323 | ** statements handed to [sqlite3_exec()] then [sqlite3_exec()] will | |
324 | ** return an [error code] other than [SQLITE_OK]. | |
325 | ** | |
326 | ** {F12131} If an error occurs while parsing or evaluating any of the SQL | |
327 | ** handed to [sqlite3_exec()] and if the 5th parameter (errmsg) | |
328 | ** to [sqlite3_exec()] is not NULL, then an error message is | |
329 | ** allocated using the equivalent of [sqlite3_mprintf()] and | |
330 | ** *errmsg is made to point to that message. | |
331 | ** | |
332 | ** {F12134} The [sqlite3_exec()] routine does not change the value of | |
333 | ** *errmsg if errmsg is NULL or if there are no errors. | |
334 | ** | |
335 | ** {F12137} The [sqlite3_exec()] function sets the error code and message | |
336 | ** accessible via [sqlite3_errcode()], [sqlite3_errmsg()], and | |
337 | ** [sqlite3_errmsg16()]. | |
338 | ** | |
339 | ** LIMITATIONS: | |
340 | ** | |
341 | ** {U12141} The first parameter to [sqlite3_exec()] must be an valid and open | |
342 | ** [database connection]. | |
343 | ** | |
344 | ** {U12142} The database connection must not be closed while | |
345 | ** [sqlite3_exec()] is running. | |
346 | ** | |
347 | ** {U12143} The calling function is should use [sqlite3_free()] to free | |
348 | ** the memory that *errmsg is left pointing at once the error | |
349 | ** message is no longer needed. | |
350 | ** | |
351 | ** {U12145} The SQL statement text in the 2nd parameter to [sqlite3_exec()] | |
352 | ** must remain unchanged while [sqlite3_exec()] is running. | |
353 | */ | |
354 | int sqlite3_exec( | |
355 | sqlite3*, /* An open database */ | |
356 | const char *sql, /* SQL to be evaluted */ | |
357 | int (*callback)(void*,int,char**,char**), /* Callback function */ | |
358 | void *, /* 1st argument to callback */ | |
359 | char **errmsg /* Error msg written here */ | |
360 | ); | |
361 | ||
362 | /* | |
363 | ** CAPI3REF: Result Codes {F10210} | |
364 | ** KEYWORDS: SQLITE_OK {error code} {error codes} | |
365 | ** | |
366 | ** Many SQLite functions return an integer result code from the set shown | |
367 | ** here in order to indicates success or failure. | |
368 | ** | |
369 | ** See also: [SQLITE_IOERR_READ | extended result codes] | |
370 | */ | |
371 | #define SQLITE_OK 0 /* Successful result */ | |
372 | /* beginning-of-error-codes */ | |
373 | #define SQLITE_ERROR 1 /* SQL error or missing database */ | |
374 | #define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */ | |
375 | #define SQLITE_PERM 3 /* Access permission denied */ | |
376 | #define SQLITE_ABORT 4 /* Callback routine requested an abort */ | |
377 | #define SQLITE_BUSY 5 /* The database file is locked */ | |
378 | #define SQLITE_LOCKED 6 /* A table in the database is locked */ | |
379 | #define SQLITE_NOMEM 7 /* A malloc() failed */ | |
380 | #define SQLITE_READONLY 8 /* Attempt to write a readonly database */ | |
381 | #define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/ | |
382 | #define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */ | |
383 | #define SQLITE_CORRUPT 11 /* The database disk image is malformed */ | |
384 | #define SQLITE_NOTFOUND 12 /* NOT USED. Table or record not found */ | |
385 | #define SQLITE_FULL 13 /* Insertion failed because database is full */ | |
386 | #define SQLITE_CANTOPEN 14 /* Unable to open the database file */ | |
387 | #define SQLITE_PROTOCOL 15 /* NOT USED. Database lock protocol error */ | |
388 | #define SQLITE_EMPTY 16 /* Database is empty */ | |
389 | #define SQLITE_SCHEMA 17 /* The database schema changed */ | |
390 | #define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */ | |
391 | #define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */ | |
392 | #define SQLITE_MISMATCH 20 /* Data type mismatch */ | |
393 | #define SQLITE_MISUSE 21 /* Library used incorrectly */ | |
394 | #define SQLITE_NOLFS 22 /* Uses OS features not supported on host */ | |
395 | #define SQLITE_AUTH 23 /* Authorization denied */ | |
396 | #define SQLITE_FORMAT 24 /* Auxiliary database format error */ | |
397 | #define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */ | |
398 | #define SQLITE_NOTADB 26 /* File opened that is not a database file */ | |
399 | #define SQLITE_ROW 100 /* sqlite3_step() has another row ready */ | |
400 | #define SQLITE_DONE 101 /* sqlite3_step() has finished executing */ | |
401 | /* end-of-error-codes */ | |
402 | ||
403 | /* | |
404 | ** CAPI3REF: Extended Result Codes {F10220} | |
405 | ** KEYWORDS: {extended error code} {extended error codes} | |
406 | ** KEYWORDS: {extended result codes} | |
407 | ** | |
408 | ** In its default configuration, SQLite API routines return one of 26 integer | |
409 | ** [SQLITE_OK | result codes]. However, experience has shown that | |
410 | ** many of these result codes are too course-grained. They do not provide as | |
411 | ** much information about problems as programmers might like. In an effort to | |
412 | ** address this, newer versions of SQLite (version 3.3.8 and later) include | |
413 | ** support for additional result codes that provide more detailed information | |
414 | ** about errors. The extended result codes are enabled or disabled | |
415 | ** for each database connection using the [sqlite3_extended_result_codes()] | |
416 | ** API. | |
417 | ** | |
418 | ** Some of the available extended result codes are listed here. | |
419 | ** One may expect the number of extended result codes will be expand | |
420 | ** over time. Software that uses extended result codes should expect | |
421 | ** to see new result codes in future releases of SQLite. | |
422 | ** | |
423 | ** The SQLITE_OK result code will never be extended. It will always | |
424 | ** be exactly zero. | |
425 | ** | |
426 | ** INVARIANTS: | |
427 | ** | |
428 | ** {F10223} The symbolic name for an extended result code always contains | |
429 | ** a related primary result code as a prefix. | |
430 | ** | |
431 | ** {F10224} Primary result code names contain a single "_" character. | |
432 | ** | |
433 | ** {F10225} Extended result code names contain two or more "_" characters. | |
434 | ** | |
435 | ** {F10226} The numeric value of an extended result code contains the | |
436 | ** numeric value of its corresponding primary result code in | |
437 | ** its least significant 8 bits. | |
438 | */ | |
439 | #define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8)) | |
440 | #define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8)) | |
441 | #define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8)) | |
442 | #define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8)) | |
443 | #define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8)) | |
444 | #define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8)) | |
445 | #define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8)) | |
446 | #define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8)) | |
447 | #define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8)) | |
448 | #define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8)) | |
449 | #define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8)) | |
450 | #define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8)) | |
451 | ||
452 | /* | |
453 | ** CAPI3REF: Flags For File Open Operations {F10230} | |
454 | ** | |
455 | ** These bit values are intended for use in the | |
456 | ** 3rd parameter to the [sqlite3_open_v2()] interface and | |
457 | ** in the 4th parameter to the xOpen method of the | |
458 | ** [sqlite3_vfs] object. | |
459 | */ | |
460 | #define SQLITE_OPEN_READONLY 0x00000001 | |
461 | #define SQLITE_OPEN_READWRITE 0x00000002 | |
462 | #define SQLITE_OPEN_CREATE 0x00000004 | |
463 | #define SQLITE_OPEN_DELETEONCLOSE 0x00000008 | |
464 | #define SQLITE_OPEN_EXCLUSIVE 0x00000010 | |
465 | #define SQLITE_OPEN_MAIN_DB 0x00000100 | |
466 | #define SQLITE_OPEN_TEMP_DB 0x00000200 | |
467 | #define SQLITE_OPEN_TRANSIENT_DB 0x00000400 | |
468 | #define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 | |
469 | #define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 | |
470 | #define SQLITE_OPEN_SUBJOURNAL 0x00002000 | |
471 | #define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 | |
472 | ||
473 | /* | |
474 | ** CAPI3REF: Device Characteristics {F10240} | |
475 | ** | |
476 | ** The xDeviceCapabilities method of the [sqlite3_io_methods] | |
477 | ** object returns an integer which is a vector of the these | |
478 | ** bit values expressing I/O characteristics of the mass storage | |
479 | ** device that holds the file that the [sqlite3_io_methods] | |
480 | ** refers to. | |
481 | ** | |
482 | ** The SQLITE_IOCAP_ATOMIC property means that all writes of | |
483 | ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values | |
484 | ** mean that writes of blocks that are nnn bytes in size and | |
485 | ** are aligned to an address which is an integer multiple of | |
486 | ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means | |
487 | ** that when data is appended to a file, the data is appended | |
488 | ** first then the size of the file is extended, never the other | |
489 | ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that | |
490 | ** information is written to disk in the same order as calls | |
491 | ** to xWrite(). | |
492 | */ | |
493 | #define SQLITE_IOCAP_ATOMIC 0x00000001 | |
494 | #define SQLITE_IOCAP_ATOMIC512 0x00000002 | |
495 | #define SQLITE_IOCAP_ATOMIC1K 0x00000004 | |
496 | #define SQLITE_IOCAP_ATOMIC2K 0x00000008 | |
497 | #define SQLITE_IOCAP_ATOMIC4K 0x00000010 | |
498 | #define SQLITE_IOCAP_ATOMIC8K 0x00000020 | |
499 | #define SQLITE_IOCAP_ATOMIC16K 0x00000040 | |
500 | #define SQLITE_IOCAP_ATOMIC32K 0x00000080 | |
501 | #define SQLITE_IOCAP_ATOMIC64K 0x00000100 | |
502 | #define SQLITE_IOCAP_SAFE_APPEND 0x00000200 | |
503 | #define SQLITE_IOCAP_SEQUENTIAL 0x00000400 | |
504 | ||
505 | /* | |
506 | ** CAPI3REF: File Locking Levels {F10250} | |
507 | ** | |
508 | ** SQLite uses one of these integer values as the second | |
509 | ** argument to calls it makes to the xLock() and xUnlock() methods | |
510 | ** of an [sqlite3_io_methods] object. | |
511 | */ | |
512 | #define SQLITE_LOCK_NONE 0 | |
513 | #define SQLITE_LOCK_SHARED 1 | |
514 | #define SQLITE_LOCK_RESERVED 2 | |
515 | #define SQLITE_LOCK_PENDING 3 | |
516 | #define SQLITE_LOCK_EXCLUSIVE 4 | |
517 | ||
518 | /* | |
519 | ** CAPI3REF: Synchronization Type Flags {F10260} | |
520 | ** | |
521 | ** When SQLite invokes the xSync() method of an | |
522 | ** [sqlite3_io_methods] object it uses a combination of | |
523 | ** these integer values as the second argument. | |
524 | ** | |
525 | ** When the SQLITE_SYNC_DATAONLY flag is used, it means that the | |
526 | ** sync operation only needs to flush data to mass storage. Inode | |
527 | ** information need not be flushed. The SQLITE_SYNC_NORMAL flag means | |
528 | ** to use normal fsync() semantics. The SQLITE_SYNC_FULL flag means | |
529 | ** to use Mac OS-X style fullsync instead of fsync(). | |
530 | */ | |
531 | #define SQLITE_SYNC_NORMAL 0x00002 | |
532 | #define SQLITE_SYNC_FULL 0x00003 | |
533 | #define SQLITE_SYNC_DATAONLY 0x00010 | |
534 | ||
535 | ||
536 | /* | |
537 | ** CAPI3REF: OS Interface Open File Handle {F11110} | |
538 | ** | |
539 | ** An [sqlite3_file] object represents an open file in the OS | |
540 | ** interface layer. Individual OS interface implementations will | |
541 | ** want to subclass this object by appending additional fields | |
542 | ** for their own use. The pMethods entry is a pointer to an | |
543 | ** [sqlite3_io_methods] object that defines methods for performing | |
544 | ** I/O operations on the open file. | |
545 | */ | |
546 | typedef struct sqlite3_file sqlite3_file; | |
547 | struct sqlite3_file { | |
548 | const struct sqlite3_io_methods *pMethods; /* Methods for an open file */ | |
549 | }; | |
550 | ||
551 | /* | |
552 | ** CAPI3REF: OS Interface File Virtual Methods Object {F11120} | |
553 | ** | |
554 | ** Every file opened by the [sqlite3_vfs] xOpen method contains a pointer to | |
555 | ** an instance of this object. This object defines the | |
556 | ** methods used to perform various operations against the open file. | |
557 | ** | |
558 | ** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or | |
559 | ** [SQLITE_SYNC_FULL]. The first choice is the normal fsync(). | |
560 | * The second choice is an | |
561 | ** OS-X style fullsync. The SQLITE_SYNC_DATA flag may be ORed in to | |
562 | ** indicate that only the data of the file and not its inode needs to be | |
563 | ** synced. | |
564 | ** | |
565 | ** The integer values to xLock() and xUnlock() are one of | |
566 | ** <ul> | |
567 | ** <li> [SQLITE_LOCK_NONE], | |
568 | ** <li> [SQLITE_LOCK_SHARED], | |
569 | ** <li> [SQLITE_LOCK_RESERVED], | |
570 | ** <li> [SQLITE_LOCK_PENDING], or | |
571 | ** <li> [SQLITE_LOCK_EXCLUSIVE]. | |
572 | ** </ul> | |
573 | ** xLock() increases the lock. xUnlock() decreases the lock. | |
574 | ** The xCheckReservedLock() method looks | |
575 | ** to see if any database connection, either in this | |
576 | ** process or in some other process, is holding an RESERVED, | |
577 | ** PENDING, or EXCLUSIVE lock on the file. It returns true | |
578 | ** if such a lock exists and false if not. | |
579 | ** | |
580 | ** The xFileControl() method is a generic interface that allows custom | |
581 | ** VFS implementations to directly control an open file using the | |
582 | ** [sqlite3_file_control()] interface. The second "op" argument | |
583 | ** is an integer opcode. The third | |
584 | ** argument is a generic pointer which is intended to be a pointer | |
585 | ** to a structure that may contain arguments or space in which to | |
586 | ** write return values. Potential uses for xFileControl() might be | |
587 | ** functions to enable blocking locks with timeouts, to change the | |
588 | ** locking strategy (for example to use dot-file locks), to inquire | |
589 | ** about the status of a lock, or to break stale locks. The SQLite | |
590 | ** core reserves opcodes less than 100 for its own use. | |
591 | ** A [SQLITE_FCNTL_LOCKSTATE | list of opcodes] less than 100 is available. | |
592 | ** Applications that define a custom xFileControl method should use opcodes | |
593 | ** greater than 100 to avoid conflicts. | |
594 | ** | |
595 | ** The xSectorSize() method returns the sector size of the | |
596 | ** device that underlies the file. The sector size is the | |
597 | ** minimum write that can be performed without disturbing | |
598 | ** other bytes in the file. The xDeviceCharacteristics() | |
599 | ** method returns a bit vector describing behaviors of the | |
600 | ** underlying device: | |
601 | ** | |
602 | ** <ul> | |
603 | ** <li> [SQLITE_IOCAP_ATOMIC] | |
604 | ** <li> [SQLITE_IOCAP_ATOMIC512] | |
605 | ** <li> [SQLITE_IOCAP_ATOMIC1K] | |
606 | ** <li> [SQLITE_IOCAP_ATOMIC2K] | |
607 | ** <li> [SQLITE_IOCAP_ATOMIC4K] | |
608 | ** <li> [SQLITE_IOCAP_ATOMIC8K] | |
609 | ** <li> [SQLITE_IOCAP_ATOMIC16K] | |
610 | ** <li> [SQLITE_IOCAP_ATOMIC32K] | |
611 | ** <li> [SQLITE_IOCAP_ATOMIC64K] | |
612 | ** <li> [SQLITE_IOCAP_SAFE_APPEND] | |
613 | ** <li> [SQLITE_IOCAP_SEQUENTIAL] | |
614 | ** </ul> | |
615 | ** | |
616 | ** The SQLITE_IOCAP_ATOMIC property means that all writes of | |
617 | ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values | |
618 | ** mean that writes of blocks that are nnn bytes in size and | |
619 | ** are aligned to an address which is an integer multiple of | |
620 | ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means | |
621 | ** that when data is appended to a file, the data is appended | |
622 | ** first then the size of the file is extended, never the other | |
623 | ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that | |
624 | ** information is written to disk in the same order as calls | |
625 | ** to xWrite(). | |
626 | */ | |
627 | typedef struct sqlite3_io_methods sqlite3_io_methods; | |
628 | struct sqlite3_io_methods { | |
629 | int iVersion; | |
630 | int (*xClose)(sqlite3_file*); | |
631 | int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst); | |
632 | int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst); | |
633 | int (*xTruncate)(sqlite3_file*, sqlite3_int64 size); | |
634 | int (*xSync)(sqlite3_file*, int flags); | |
635 | int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize); | |
636 | int (*xLock)(sqlite3_file*, int); | |
637 | int (*xUnlock)(sqlite3_file*, int); | |
638 | int (*xCheckReservedLock)(sqlite3_file*); | |
639 | int (*xFileControl)(sqlite3_file*, int op, void *pArg); | |
640 | int (*xSectorSize)(sqlite3_file*); | |
641 | int (*xDeviceCharacteristics)(sqlite3_file*); | |
642 | /* Additional methods may be added in future releases */ | |
643 | }; | |
644 | ||
645 | /* | |
646 | ** CAPI3REF: Standard File Control Opcodes {F11310} | |
647 | ** | |
648 | ** These integer constants are opcodes for the xFileControl method | |
649 | ** of the [sqlite3_io_methods] object and to the [sqlite3_file_control()] | |
650 | ** interface. | |
651 | ** | |
652 | ** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This | |
653 | ** opcode causes the xFileControl method to write the current state of | |
654 | ** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED], | |
655 | ** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE]) | |
656 | ** into an integer that the pArg argument points to. This capability | |
657 | ** is used during testing and only needs to be supported when SQLITE_TEST | |
658 | ** is defined. | |
659 | */ | |
660 | #define SQLITE_FCNTL_LOCKSTATE 1 | |
661 | ||
662 | /* | |
663 | ** CAPI3REF: Mutex Handle {F17110} | |
664 | ** | |
665 | ** The mutex module within SQLite defines [sqlite3_mutex] to be an | |
666 | ** abstract type for a mutex object. The SQLite core never looks | |
667 | ** at the internal representation of an [sqlite3_mutex]. It only | |
668 | ** deals with pointers to the [sqlite3_mutex] object. | |
669 | ** | |
670 | ** Mutexes are created using [sqlite3_mutex_alloc()]. | |
671 | */ | |
672 | typedef struct sqlite3_mutex sqlite3_mutex; | |
673 | ||
674 | /* | |
675 | ** CAPI3REF: OS Interface Object {F11140} | |
676 | ** | |
677 | ** An instance of this object defines the interface between the | |
678 | ** SQLite core and the underlying operating system. The "vfs" | |
679 | ** in the name of the object stands for "virtual file system". | |
680 | ** | |
681 | ** The iVersion field is initially 1 but may be larger for future | |
682 | ** versions of SQLite. Additional fields may be appended to this | |
683 | ** object when the iVersion value is increased. | |
684 | ** | |
685 | ** The szOsFile field is the size of the subclassed [sqlite3_file] | |
686 | ** structure used by this VFS. mxPathname is the maximum length of | |
687 | ** a pathname in this VFS. | |
688 | ** | |
689 | ** Registered sqlite3_vfs objects are kept on a linked list formed by | |
690 | ** the pNext pointer. The [sqlite3_vfs_register()] | |
691 | ** and [sqlite3_vfs_unregister()] interfaces manage this list | |
692 | ** in a thread-safe way. The [sqlite3_vfs_find()] interface | |
693 | ** searches the list. | |
694 | ** | |
695 | ** The pNext field is the only field in the sqlite3_vfs | |
696 | ** structure that SQLite will ever modify. SQLite will only access | |
697 | ** or modify this field while holding a particular static mutex. | |
698 | ** The application should never modify anything within the sqlite3_vfs | |
699 | ** object once the object has been registered. | |
700 | ** | |
701 | ** The zName field holds the name of the VFS module. The name must | |
702 | ** be unique across all VFS modules. | |
703 | ** | |
704 | ** {F11141} SQLite will guarantee that the zFilename string passed to | |
705 | ** xOpen() is a full pathname as generated by xFullPathname() and | |
706 | ** that the string will be valid and unchanged until xClose() is | |
707 | ** called. {END} So the [sqlite3_file] can store a pointer to the | |
708 | ** filename if it needs to remember the filename for some reason. | |
709 | ** | |
710 | ** {F11142} The flags argument to xOpen() includes all bits set in | |
711 | ** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()] | |
712 | ** or [sqlite3_open16()] is used, then flags includes at least | |
713 | ** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. {END} | |
714 | ** If xOpen() opens a file read-only then it sets *pOutFlags to | |
715 | ** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be | |
716 | ** set. | |
717 | ** | |
718 | ** {F11143} SQLite will also add one of the following flags to the xOpen() | |
719 | ** call, depending on the object being opened: | |
720 | ** | |
721 | ** <ul> | |
722 | ** <li> [SQLITE_OPEN_MAIN_DB] | |
723 | ** <li> [SQLITE_OPEN_MAIN_JOURNAL] | |
724 | ** <li> [SQLITE_OPEN_TEMP_DB] | |
725 | ** <li> [SQLITE_OPEN_TEMP_JOURNAL] | |
726 | ** <li> [SQLITE_OPEN_TRANSIENT_DB] | |
727 | ** <li> [SQLITE_OPEN_SUBJOURNAL] | |
728 | ** <li> [SQLITE_OPEN_MASTER_JOURNAL] | |
729 | ** </ul> {END} | |
730 | ** | |
731 | ** The file I/O implementation can use the object type flags to | |
732 | ** changes the way it deals with files. For example, an application | |
733 | ** that does not care about crash recovery or rollback might make | |
734 | ** the open of a journal file a no-op. Writes to this journal would | |
735 | ** also be no-ops, and any attempt to read the journal would return | |
736 | ** SQLITE_IOERR. Or the implementation might recognize that a database | |
737 | ** file will be doing page-aligned sector reads and writes in a random | |
738 | ** order and set up its I/O subsystem accordingly. | |
739 | ** | |
740 | ** SQLite might also add one of the following flags to the xOpen | |
741 | ** method: | |
742 | ** | |
743 | ** <ul> | |
744 | ** <li> [SQLITE_OPEN_DELETEONCLOSE] | |
745 | ** <li> [SQLITE_OPEN_EXCLUSIVE] | |
746 | ** </ul> | |
747 | ** | |
748 | ** {F11145} The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be | |
749 | ** deleted when it is closed. {F11146} The [SQLITE_OPEN_DELETEONCLOSE] | |
750 | ** will be set for TEMP databases, journals and for subjournals. | |
751 | ** {F11147} The [SQLITE_OPEN_EXCLUSIVE] flag means the file should be opened | |
752 | ** for exclusive access. This flag is set for all files except | |
753 | ** for the main database file. {END} | |
754 | ** | |
755 | ** {F11148} At least szOsFile bytes of memory are allocated by SQLite | |
756 | ** to hold the [sqlite3_file] structure passed as the third | |
757 | ** argument to xOpen. {END} The xOpen method does not have to | |
758 | ** allocate the structure; it should just fill it in. | |
759 | ** | |
760 | ** {F11149} The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS] | |
761 | ** to test for the existance of a file, | |
762 | ** or [SQLITE_ACCESS_READWRITE] to test to see | |
763 | ** if a file is readable and writable, or [SQLITE_ACCESS_READ] | |
764 | ** to test to see if a file is at least readable. {END} The file can be a | |
765 | ** directory. | |
766 | ** | |
767 | ** {F11150} SQLite will always allocate at least mxPathname+1 bytes for | |
768 | ** the output buffers for xGetTempname and xFullPathname. {F11151} The exact | |
769 | ** size of the output buffer is also passed as a parameter to both | |
770 | ** methods. {END} If the output buffer is not large enough, SQLITE_CANTOPEN | |
771 | ** should be returned. As this is handled as a fatal error by SQLite, | |
772 | ** vfs implementations should endeavor to prevent this by setting | |
773 | ** mxPathname to a sufficiently large value. | |
774 | ** | |
775 | ** The xRandomness(), xSleep(), and xCurrentTime() interfaces | |
776 | ** are not strictly a part of the filesystem, but they are | |
777 | ** included in the VFS structure for completeness. | |
778 | ** The xRandomness() function attempts to return nBytes bytes | |
779 | ** of good-quality randomness into zOut. The return value is | |
780 | ** the actual number of bytes of randomness obtained. The | |
781 | ** xSleep() method causes the calling thread to sleep for at | |
782 | ** least the number of microseconds given. The xCurrentTime() | |
783 | ** method returns a Julian Day Number for the current date and | |
784 | ** time. | |
785 | */ | |
786 | typedef struct sqlite3_vfs sqlite3_vfs; | |
787 | struct sqlite3_vfs { | |
788 | int iVersion; /* Structure version number */ | |
789 | int szOsFile; /* Size of subclassed sqlite3_file */ | |
790 | int mxPathname; /* Maximum file pathname length */ | |
791 | sqlite3_vfs *pNext; /* Next registered VFS */ | |
792 | const char *zName; /* Name of this virtual file system */ | |
793 | void *pAppData; /* Pointer to application-specific data */ | |
794 | int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*, | |
795 | int flags, int *pOutFlags); | |
796 | int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir); | |
797 | int (*xAccess)(sqlite3_vfs*, const char *zName, int flags); | |
798 | int (*xGetTempname)(sqlite3_vfs*, int nOut, char *zOut); | |
799 | int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut); | |
800 | void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename); | |
801 | void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg); | |
802 | void *(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol); | |
803 | void (*xDlClose)(sqlite3_vfs*, void*); | |
804 | int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut); | |
805 | int (*xSleep)(sqlite3_vfs*, int microseconds); | |
806 | int (*xCurrentTime)(sqlite3_vfs*, double*); | |
807 | /* New fields may be appended in figure versions. The iVersion | |
808 | ** value will increment whenever this happens. */ | |
809 | }; | |
810 | ||
811 | /* | |
812 | ** CAPI3REF: Flags for the xAccess VFS method {F11190} | |
813 | ** | |
814 | ** {F11191} These integer constants can be used as the third parameter to | |
815 | ** the xAccess method of an [sqlite3_vfs] object. {END} They determine | |
816 | ** what kind of permissions the xAccess method is | |
817 | ** looking for. {F11192} With SQLITE_ACCESS_EXISTS, the xAccess method | |
818 | ** simply checks to see if the file exists. {F11193} With | |
819 | ** SQLITE_ACCESS_READWRITE, the xAccess method checks to see | |
820 | ** if the file is both readable and writable. {F11194} With | |
821 | ** SQLITE_ACCESS_READ the xAccess method | |
822 | ** checks to see if the file is readable. | |
823 | */ | |
824 | #define SQLITE_ACCESS_EXISTS 0 | |
825 | #define SQLITE_ACCESS_READWRITE 1 | |
826 | #define SQLITE_ACCESS_READ 2 | |
827 | ||
828 | /* | |
829 | ** CAPI3REF: Enable Or Disable Extended Result Codes {F12200} | |
830 | ** | |
831 | ** The sqlite3_extended_result_codes() routine enables or disables the | |
832 | ** [SQLITE_IOERR_READ | extended result codes] feature of SQLite. | |
833 | ** The extended result codes are disabled by default for historical | |
834 | ** compatibility. | |
835 | ** | |
836 | ** INVARIANTS: | |
837 | ** | |
838 | ** {F12201} Each new [database connection] has the | |
839 | ** [extended result codes] feature | |
840 | ** disabled by default. | |
841 | ** | |
842 | ** {F12202} The [sqlite3_extended_result_codes(D,F)] interface will enable | |
843 | ** [extended result codes] for the | |
844 | ** [database connection] D if the F parameter | |
845 | ** is true, or disable them if F is false. | |
846 | */ | |
847 | int sqlite3_extended_result_codes(sqlite3*, int onoff); | |
848 | ||
849 | /* | |
850 | ** CAPI3REF: Last Insert Rowid {F12220} | |
851 | ** | |
852 | ** Each entry in an SQLite table has a unique 64-bit signed | |
853 | ** integer key called the "rowid". The rowid is always available | |
854 | ** as an undeclared column named ROWID, OID, or _ROWID_ as long as those | |
855 | ** names are not also used by explicitly declared columns. If | |
856 | ** the table has a column of type INTEGER PRIMARY KEY then that column | |
857 | ** is another alias for the rowid. | |
858 | ** | |
859 | ** This routine returns the rowid of the most recent | |
860 | ** successful INSERT into the database from the database connection | |
861 | ** shown in the first argument. If no successful inserts | |
862 | ** have ever occurred on this database connection, zero is returned. | |
863 | ** | |
864 | ** If an INSERT occurs within a trigger, then the rowid of the | |
865 | ** inserted row is returned by this routine as long as the trigger | |
866 | ** is running. But once the trigger terminates, the value returned | |
867 | ** by this routine reverts to the last value inserted before the | |
868 | ** trigger fired. | |
869 | ** | |
870 | ** An INSERT that fails due to a constraint violation is not a | |
871 | ** successful insert and does not change the value returned by this | |
872 | ** routine. Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK, | |
873 | ** and INSERT OR ABORT make no changes to the return value of this | |
874 | ** routine when their insertion fails. When INSERT OR REPLACE | |
875 | ** encounters a constraint violation, it does not fail. The | |
876 | ** INSERT continues to completion after deleting rows that caused | |
877 | ** the constraint problem so INSERT OR REPLACE will always change | |
878 | ** the return value of this interface. | |
879 | ** | |
880 | ** For the purposes of this routine, an insert is considered to | |
881 | ** be successful even if it is subsequently rolled back. | |
882 | ** | |
883 | ** INVARIANTS: | |
884 | ** | |
885 | ** {F12221} The [sqlite3_last_insert_rowid()] function returns the | |
886 | ** rowid of the most recent successful insert done | |
887 | ** on the same database connection and within the same | |
888 | ** trigger context, or zero if there have | |
889 | ** been no qualifying inserts on that connection. | |
890 | ** | |
891 | ** {F12223} The [sqlite3_last_insert_rowid()] function returns | |
892 | ** same value when called from the same trigger context | |
893 | ** immediately before and after a ROLLBACK. | |
894 | ** | |
895 | ** LIMITATIONS: | |
896 | ** | |
897 | ** {U12232} If a separate thread does a new insert on the same | |
898 | ** database connection while the [sqlite3_last_insert_rowid()] | |
899 | ** function is running and thus changes the last insert rowid, | |
900 | ** then the value returned by [sqlite3_last_insert_rowid()] is | |
901 | ** unpredictable and might not equal either the old or the new | |
902 | ** last insert rowid. | |
903 | */ | |
904 | sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*); | |
905 | ||
906 | /* | |
907 | ** CAPI3REF: Count The Number Of Rows Modified {F12240} | |
908 | ** | |
909 | ** This function returns the number of database rows that were changed | |
910 | ** or inserted or deleted by the most recently completed SQL statement | |
911 | ** on the connection specified by the first parameter. Only | |
912 | ** changes that are directly specified by the INSERT, UPDATE, or | |
913 | ** DELETE statement are counted. Auxiliary changes caused by | |
914 | ** triggers are not counted. Use the [sqlite3_total_changes()] function | |
915 | ** to find the total number of changes including changes caused by triggers. | |
916 | ** | |
917 | ** A "row change" is a change to a single row of a single table | |
918 | ** caused by an INSERT, DELETE, or UPDATE statement. Rows that | |
919 | ** are changed as side effects of REPLACE constraint resolution, | |
920 | ** rollback, ABORT processing, DROP TABLE, or by any other | |
921 | ** mechanisms do not count as direct row changes. | |
922 | ** | |
923 | ** A "trigger context" is a scope of execution that begins and | |
924 | ** ends with the script of a trigger. Most SQL statements are | |
925 | ** evaluated outside of any trigger. This is the "top level" | |
926 | ** trigger context. If a trigger fires from the top level, a | |
927 | ** new trigger context is entered for the duration of that one | |
928 | ** trigger. Subtriggers create subcontexts for their duration. | |
929 | ** | |
930 | ** Calling [sqlite3_exec()] or [sqlite3_step()] recursively does | |
931 | ** not create a new trigger context. | |
932 | ** | |
933 | ** This function returns the number of direct row changes in the | |
934 | ** most recent INSERT, UPDATE, or DELETE statement within the same | |
935 | ** trigger context. | |
936 | ** | |
937 | ** So when called from the top level, this function returns the | |
938 | ** number of changes in the most recent INSERT, UPDATE, or DELETE | |
939 | ** that also occurred at the top level. | |
940 | ** Within the body of a trigger, the sqlite3_changes() interface | |
941 | ** can be called to find the number of | |
942 | ** changes in the most recently completed INSERT, UPDATE, or DELETE | |
943 | ** statement within the body of the same trigger. | |
944 | ** However, the number returned does not include in changes | |
945 | ** caused by subtriggers since they have their own context. | |
946 | ** | |
947 | ** SQLite implements the command "DELETE FROM table" without | |
948 | ** a WHERE clause by dropping and recreating the table. (This is much | |
949 | ** faster than going through and deleting individual elements from the | |
950 | ** table.) Because of this optimization, the deletions in | |
951 | ** "DELETE FROM table" are not row changes and will not be counted | |
952 | ** by the sqlite3_changes() or [sqlite3_total_changes()] functions. | |
953 | ** To get an accurate count of the number of rows deleted, use | |
954 | ** "DELETE FROM table WHERE 1" instead. | |
955 | ** | |
956 | ** INVARIANTS: | |
957 | ** | |
958 | ** {F12241} The [sqlite3_changes()] function returns the number of | |
959 | ** row changes caused by the most recent INSERT, UPDATE, | |
960 | ** or DELETE statement on the same database connection and | |
961 | ** within the same trigger context, or zero if there have | |
962 | ** not been any qualifying row changes. | |
963 | ** | |
964 | ** LIMITATIONS: | |
965 | ** | |
966 | ** {U12252} If a separate thread makes changes on the same database connection | |
967 | ** while [sqlite3_changes()] is running then the value returned | |
968 | ** is unpredictable and unmeaningful. | |
969 | */ | |
970 | int sqlite3_changes(sqlite3*); | |
971 | ||
972 | /* | |
973 | ** CAPI3REF: Total Number Of Rows Modified {F12260} | |
974 | *** | |
975 | ** This function returns the number of row changes caused | |
976 | ** by INSERT, UPDATE or DELETE statements since the database handle | |
977 | ** was opened. The count includes all changes from all trigger | |
978 | ** contexts. But the count does not include changes used to | |
979 | ** implement REPLACE constraints, do rollbacks or ABORT processing, | |
980 | ** or DROP table processing. | |
981 | ** The changes | |
982 | ** are counted as soon as the statement that makes them is completed | |
983 | ** (when the statement handle is passed to [sqlite3_reset()] or | |
984 | ** [sqlite3_finalize()]). | |
985 | ** | |
986 | ** SQLite implements the command "DELETE FROM table" without | |
987 | ** a WHERE clause by dropping and recreating the table. (This is much | |
988 | ** faster than going | |
989 | ** through and deleting individual elements from the table.) Because of | |
990 | ** this optimization, the change count for "DELETE FROM table" will be | |
991 | ** zero regardless of the number of elements that were originally in the | |
992 | ** table. To get an accurate count of the number of rows deleted, use | |
993 | ** "DELETE FROM table WHERE 1" instead. | |
994 | ** | |
995 | ** See also the [sqlite3_changes()] interface. | |
996 | ** | |
997 | ** INVARIANTS: | |
998 | ** | |
999 | ** {F12261} The [sqlite3_total_changes()] returns the total number | |
1000 | ** of row changes caused by INSERT, UPDATE, and/or DELETE | |
1001 | ** statements on the same [database connection], in any | |
1002 | ** trigger context, since the database connection was | |
1003 | ** created. | |
1004 | ** | |
1005 | ** LIMITATIONS: | |
1006 | ** | |
1007 | ** {U12264} If a separate thread makes changes on the same database connection | |
1008 | ** while [sqlite3_total_changes()] is running then the value | |
1009 | ** returned is unpredictable and unmeaningful. | |
1010 | */ | |
1011 | int sqlite3_total_changes(sqlite3*); | |
1012 | ||
1013 | /* | |
1014 | ** CAPI3REF: Interrupt A Long-Running Query {F12270} | |
1015 | ** | |
1016 | ** This function causes any pending database operation to abort and | |
1017 | ** return at its earliest opportunity. This routine is typically | |
1018 | ** called in response to a user action such as pressing "Cancel" | |
1019 | ** or Ctrl-C where the user wants a long query operation to halt | |
1020 | ** immediately. | |
1021 | ** | |
1022 | ** It is safe to call this routine from a thread different from the | |
1023 | ** thread that is currently running the database operation. But it | |
1024 | ** is not safe to call this routine with a database connection that | |
1025 | ** is closed or might close before sqlite3_interrupt() returns. | |
1026 | ** | |
1027 | ** If an SQL is very nearly finished at the time when sqlite3_interrupt() | |
1028 | ** is called, then it might not have an opportunity to be interrupted. | |
1029 | ** It might continue to completion. | |
1030 | ** An SQL operation that is interrupted will return | |
1031 | ** [SQLITE_INTERRUPT]. If the interrupted SQL operation is an | |
1032 | ** INSERT, UPDATE, or DELETE that is inside an explicit transaction, | |
1033 | ** then the entire transaction will be rolled back automatically. | |
1034 | ** A call to sqlite3_interrupt() has no effect on SQL statements | |
1035 | ** that are started after sqlite3_interrupt() returns. | |
1036 | ** | |
1037 | ** INVARIANTS: | |
1038 | ** | |
1039 | ** {F12271} The [sqlite3_interrupt()] interface will force all running | |
1040 | ** SQL statements associated with the same database connection | |
1041 | ** to halt after processing at most one additional row of | |
1042 | ** data. | |
1043 | ** | |
1044 | ** {F12272} Any SQL statement that is interrupted by [sqlite3_interrupt()] | |
1045 | ** will return [SQLITE_INTERRUPT]. | |
1046 | ** | |
1047 | ** LIMITATIONS: | |
1048 | ** | |
1049 | ** {U12279} If the database connection closes while [sqlite3_interrupt()] | |
1050 | ** is running then bad things will likely happen. | |
1051 | */ | |
1052 | void sqlite3_interrupt(sqlite3*); | |
1053 | ||
1054 | /* | |
1055 | ** CAPI3REF: Determine If An SQL Statement Is Complete {F10510} | |
1056 | ** | |
1057 | ** These routines are useful for command-line input to determine if the | |
1058 | ** currently entered text seems to form complete a SQL statement or | |
1059 | ** if additional input is needed before sending the text into | |
1060 | ** SQLite for parsing. These routines return true if the input string | |
1061 | ** appears to be a complete SQL statement. A statement is judged to be | |
1062 | ** complete if it ends with a semicolon token and is not a fragment of a | |
1063 | ** CREATE TRIGGER statement. Semicolons that are embedded within | |
1064 | ** string literals or quoted identifier names or comments are not | |
1065 | ** independent tokens (they are part of the token in which they are | |
1066 | ** embedded) and thus do not count as a statement terminator. | |
1067 | ** | |
1068 | ** These routines do not parse the SQL and | |
1069 | ** so will not detect syntactically incorrect SQL. | |
1070 | ** | |
1071 | ** INVARIANTS: | |
1072 | ** | |
1073 | ** {F10511} The sqlite3_complete() and sqlite3_complete16() functions | |
1074 | ** return true (non-zero) if and only if the last | |
1075 | ** non-whitespace token in their input is a semicolon that | |
1076 | ** is not in between the BEGIN and END of a CREATE TRIGGER | |
1077 | ** statement. | |
1078 | ** | |
1079 | ** LIMITATIONS: | |
1080 | ** | |
1081 | ** {U10512} The input to sqlite3_complete() must be a zero-terminated | |
1082 | ** UTF-8 string. | |
1083 | ** | |
1084 | ** {U10513} The input to sqlite3_complete16() must be a zero-terminated | |
1085 | ** UTF-16 string in native byte order. | |
1086 | */ | |
1087 | int sqlite3_complete(const char *sql); | |
1088 | int sqlite3_complete16(const void *sql); | |
1089 | ||
1090 | /* | |
1091 | ** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors {F12310} | |
1092 | ** | |
1093 | ** This routine identifies a callback function that might be | |
1094 | ** invoked whenever an attempt is made to open a database table | |
1095 | ** that another thread or process has locked. | |
1096 | ** If the busy callback is NULL, then [SQLITE_BUSY] | |
1097 | ** or [SQLITE_IOERR_BLOCKED] | |
1098 | ** is returned immediately upon encountering the lock. | |
1099 | ** If the busy callback is not NULL, then the | |
1100 | ** callback will be invoked with two arguments. The | |
1101 | ** first argument to the handler is a copy of the void* pointer which | |
1102 | ** is the third argument to this routine. The second argument to | |
1103 | ** the handler is the number of times that the busy handler has | |
1104 | ** been invoked for this locking event. If the | |
1105 | ** busy callback returns 0, then no additional attempts are made to | |
1106 | ** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned. | |
1107 | ** If the callback returns non-zero, then another attempt | |
1108 | ** is made to open the database for reading and the cycle repeats. | |
1109 | ** | |
1110 | ** The presence of a busy handler does not guarantee that | |
1111 | ** it will be invoked when there is lock contention. | |
1112 | ** If SQLite determines that invoking the busy handler could result in | |
1113 | ** a deadlock, it will go ahead and return [SQLITE_BUSY] or | |
1114 | ** [SQLITE_IOERR_BLOCKED] instead of invoking the | |
1115 | ** busy handler. | |
1116 | ** Consider a scenario where one process is holding a read lock that | |
1117 | ** it is trying to promote to a reserved lock and | |
1118 | ** a second process is holding a reserved lock that it is trying | |
1119 | ** to promote to an exclusive lock. The first process cannot proceed | |
1120 | ** because it is blocked by the second and the second process cannot | |
1121 | ** proceed because it is blocked by the first. If both processes | |
1122 | ** invoke the busy handlers, neither will make any progress. Therefore, | |
1123 | ** SQLite returns [SQLITE_BUSY] for the first process, hoping that this | |
1124 | ** will induce the first process to release its read lock and allow | |
1125 | ** the second process to proceed. | |
1126 | ** | |
1127 | ** The default busy callback is NULL. | |
1128 | ** | |
1129 | ** The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED] | |
1130 | ** when SQLite is in the middle of a large transaction where all the | |
1131 | ** changes will not fit into the in-memory cache. SQLite will | |
1132 | ** already hold a RESERVED lock on the database file, but it needs | |
1133 | ** to promote this lock to EXCLUSIVE so that it can spill cache | |
1134 | ** pages into the database file without harm to concurrent | |
1135 | ** readers. If it is unable to promote the lock, then the in-memory | |
1136 | ** cache will be left in an inconsistent state and so the error | |
1137 | ** code is promoted from the relatively benign [SQLITE_BUSY] to | |
1138 | ** the more severe [SQLITE_IOERR_BLOCKED]. This error code promotion | |
1139 | ** forces an automatic rollback of the changes. See the | |
1140 | ** <a href="http://www.sqlite.org/cvstrac/wiki?p=CorruptionFollowingBusyError"> | |
1141 | ** CorruptionFollowingBusyError</a> wiki page for a discussion of why | |
1142 | ** this is important. | |
1143 | ** | |
1144 | ** There can only be a single busy handler defined for each database | |
1145 | ** connection. Setting a new busy handler clears any previous one. | |
1146 | ** Note that calling [sqlite3_busy_timeout()] will also set or clear | |
1147 | ** the busy handler. | |
1148 | ** | |
1149 | ** INVARIANTS: | |
1150 | ** | |
1151 | ** {F12311} The [sqlite3_busy_handler()] function replaces the busy handler | |
1152 | ** callback in the database connection identified by the 1st | |
1153 | ** parameter with a new busy handler identified by the 2nd and 3rd | |
1154 | ** parameters. | |
1155 | ** | |
1156 | ** {F12312} The default busy handler for new database connections is NULL. | |
1157 | ** | |
1158 | ** {F12314} When two or more database connection share a common cache, | |
1159 | ** the busy handler for the database connection currently using | |
1160 | ** the cache is invoked when the cache encounters a lock. | |
1161 | ** | |
1162 | ** {F12316} If a busy handler callback returns zero, then the SQLite | |
1163 | ** interface that provoked the locking event will return | |
1164 | ** [SQLITE_BUSY]. | |
1165 | ** | |
1166 | ** {F12318} SQLite will invokes the busy handler with two argument which | |
1167 | ** are a copy of the pointer supplied by the 3rd parameter to | |
1168 | ** [sqlite3_busy_handler()] and a count of the number of prior | |
1169 | ** invocations of the busy handler for the same locking event. | |
1170 | ** | |
1171 | ** LIMITATIONS: | |
1172 | ** | |
1173 | ** {U12319} A busy handler should not call close the database connection | |
1174 | ** or prepared statement that invoked the busy handler. | |
1175 | */ | |
1176 | int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*); | |
1177 | ||
1178 | /* | |
1179 | ** CAPI3REF: Set A Busy Timeout {F12340} | |
1180 | ** | |
1181 | ** This routine sets a [sqlite3_busy_handler | busy handler] | |
1182 | ** that sleeps for a while when a | |
1183 | ** table is locked. The handler will sleep multiple times until | |
1184 | ** at least "ms" milliseconds of sleeping have been done. {F12343} After | |
1185 | ** "ms" milliseconds of sleeping, the handler returns 0 which | |
1186 | ** causes [sqlite3_step()] to return [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED]. | |
1187 | ** | |
1188 | ** Calling this routine with an argument less than or equal to zero | |
1189 | ** turns off all busy handlers. | |
1190 | ** | |
1191 | ** There can only be a single busy handler for a particular database | |
1192 | ** connection. If another busy handler was defined | |
1193 | ** (using [sqlite3_busy_handler()]) prior to calling | |
1194 | ** this routine, that other busy handler is cleared. | |
1195 | ** | |
1196 | ** INVARIANTS: | |
1197 | ** | |
1198 | ** {F12341} The [sqlite3_busy_timeout()] function overrides any prior | |
1199 | ** [sqlite3_busy_timeout()] or [sqlite3_busy_handler()] setting | |
1200 | ** on the same database connection. | |
1201 | ** | |
1202 | ** {F12343} If the 2nd parameter to [sqlite3_busy_timeout()] is less than | |
1203 | ** or equal to zero, then the busy handler is cleared so that | |
1204 | ** all subsequent locking events immediately return [SQLITE_BUSY]. | |
1205 | ** | |
1206 | ** {F12344} If the 2nd parameter to [sqlite3_busy_timeout()] is a positive | |
1207 | ** number N, then a busy handler is set that repeatedly calls | |
1208 | ** the xSleep() method in the VFS interface until either the | |
1209 | ** lock clears or until the cumulative sleep time reported back | |
1210 | ** by xSleep() exceeds N milliseconds. | |
1211 | */ | |
1212 | int sqlite3_busy_timeout(sqlite3*, int ms); | |
1213 | ||
1214 | /* | |
1215 | ** CAPI3REF: Convenience Routines For Running Queries {F12370} | |
1216 | ** | |
1217 | ** Definition: A <b>result table</b> is memory data structure created by the | |
1218 | ** [sqlite3_get_table()] interface. A result table records the | |
1219 | ** complete query results from one or more queries. | |
1220 | ** | |
1221 | ** The table conceptually has a number of rows and columns. But | |
1222 | ** these numbers are not part of the result table itself. These | |
1223 | ** numbers are obtained separately. Let N be the number of rows | |
1224 | ** and M be the number of columns. | |
1225 | ** | |
1226 | ** A result table is an array of pointers to zero-terminated | |
1227 | ** UTF-8 strings. There are (N+1)*M elements in the array. | |
1228 | ** The first M pointers point to zero-terminated strings that | |
1229 | ** contain the names of the columns. | |
1230 | ** The remaining entries all point to query results. NULL | |
1231 | ** values are give a NULL pointer. All other values are in | |
1232 | ** their UTF-8 zero-terminated string representation as returned by | |
1233 | ** [sqlite3_column_text()]. | |
1234 | ** | |
1235 | ** A result table might consists of one or more memory allocations. | |
1236 | ** It is not safe to pass a result table directly to [sqlite3_free()]. | |
1237 | ** A result table should be deallocated using [sqlite3_free_table()]. | |
1238 | ** | |
1239 | ** As an example of the result table format, suppose a query result | |
1240 | ** is as follows: | |
1241 | ** | |
1242 | ** <blockquote><pre> | |
1243 | ** Name | Age | |
1244 | ** ----------------------- | |
1245 | ** Alice | 43 | |
1246 | ** Bob | 28 | |
1247 | ** Cindy | 21 | |
1248 | ** </pre></blockquote> | |
1249 | ** | |
1250 | ** There are two column (M==2) and three rows (N==3). Thus the | |
1251 | ** result table has 8 entries. Suppose the result table is stored | |
1252 | ** in an array names azResult. Then azResult holds this content: | |
1253 | ** | |
1254 | ** <blockquote><pre> | |
1255 | ** azResult[0] = "Name"; | |
1256 | ** azResult[1] = "Age"; | |
1257 | ** azResult[2] = "Alice"; | |
1258 | ** azResult[3] = "43"; | |
1259 | ** azResult[4] = "Bob"; | |
1260 | ** azResult[5] = "28"; | |
1261 | ** azResult[6] = "Cindy"; | |
1262 | ** azResult[7] = "21"; | |
1263 | ** </pre></blockquote> | |
1264 | ** | |
1265 | ** The sqlite3_get_table() function evaluates one or more | |
1266 | ** semicolon-separated SQL statements in the zero-terminated UTF-8 | |
1267 | ** string of its 2nd parameter. It returns a result table to the | |
1268 | ** pointer given in its 3rd parameter. | |
1269 | ** | |
1270 | ** After the calling function has finished using the result, it should | |
1271 | ** pass the pointer to the result table to sqlite3_free_table() in order to | |
1272 | ** release the memory that was malloc-ed. Because of the way the | |
1273 | ** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling | |
1274 | ** function must not try to call [sqlite3_free()] directly. Only | |
1275 | ** [sqlite3_free_table()] is able to release the memory properly and safely. | |
1276 | ** | |
1277 | ** The sqlite3_get_table() interface is implemented as a wrapper around | |
1278 | ** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access | |
1279 | ** to any internal data structures of SQLite. It uses only the public | |
1280 | ** interface defined here. As a consequence, errors that occur in the | |
1281 | ** wrapper layer outside of the internal [sqlite3_exec()] call are not | |
1282 | ** reflected in subsequent calls to [sqlite3_errcode()] or | |
1283 | ** [sqlite3_errmsg()]. | |
1284 | ** | |
1285 | ** INVARIANTS: | |
1286 | ** | |
1287 | ** {F12371} If a [sqlite3_get_table()] fails a memory allocation, then | |
1288 | ** it frees the result table under construction, aborts the | |
1289 | ** query in process, skips any subsequent queries, sets the | |
1290 | ** *resultp output pointer to NULL and returns [SQLITE_NOMEM]. | |
1291 | ** | |
1292 | ** {F12373} If the ncolumn parameter to [sqlite3_get_table()] is not NULL | |
1293 | ** then [sqlite3_get_table()] write the number of columns in the | |
1294 | ** result set of the query into *ncolumn if the query is | |
1295 | ** successful (if the function returns SQLITE_OK). | |
1296 | ** | |
1297 | ** {F12374} If the nrow parameter to [sqlite3_get_table()] is not NULL | |
1298 | ** then [sqlite3_get_table()] write the number of rows in the | |
1299 | ** result set of the query into *nrow if the query is | |
1300 | ** successful (if the function returns SQLITE_OK). | |
1301 | ** | |
1302 | ** {F12376} The [sqlite3_get_table()] function sets its *ncolumn value | |
1303 | ** to the number of columns in the result set of the query in the | |
1304 | ** sql parameter, or to zero if the query in sql has an empty | |
1305 | ** result set. | |
1306 | */ | |
1307 | int sqlite3_get_table( | |
1308 | sqlite3*, /* An open database */ | |
1309 | const char *sql, /* SQL to be evaluated */ | |
1310 | char ***pResult, /* Results of the query */ | |
1311 | int *nrow, /* Number of result rows written here */ | |
1312 | int *ncolumn, /* Number of result columns written here */ | |
1313 | char **errmsg /* Error msg written here */ | |
1314 | ); | |
1315 | void sqlite3_free_table(char **result); | |
1316 | ||
1317 | /* | |
1318 | ** CAPI3REF: Formatted String Printing Functions {F17400} | |
1319 | ** | |
1320 | ** These routines are workalikes of the "printf()" family of functions | |
1321 | ** from the standard C library. | |
1322 | ** | |
1323 | ** The sqlite3_mprintf() and sqlite3_vmprintf() routines write their | |
1324 | ** results into memory obtained from [sqlite3_malloc()]. | |
1325 | ** The strings returned by these two routines should be | |
1326 | ** released by [sqlite3_free()]. Both routines return a | |
1327 | ** NULL pointer if [sqlite3_malloc()] is unable to allocate enough | |
1328 | ** memory to hold the resulting string. | |
1329 | ** | |
1330 | ** In sqlite3_snprintf() routine is similar to "snprintf()" from | |
1331 | ** the standard C library. The result is written into the | |
1332 | ** buffer supplied as the second parameter whose size is given by | |
1333 | ** the first parameter. Note that the order of the | |
1334 | ** first two parameters is reversed from snprintf(). This is an | |
1335 | ** historical accident that cannot be fixed without breaking | |
1336 | ** backwards compatibility. Note also that sqlite3_snprintf() | |
1337 | ** returns a pointer to its buffer instead of the number of | |
1338 | ** characters actually written into the buffer. We admit that | |
1339 | ** the number of characters written would be a more useful return | |
1340 | ** value but we cannot change the implementation of sqlite3_snprintf() | |
1341 | ** now without breaking compatibility. | |
1342 | ** | |
1343 | ** As long as the buffer size is greater than zero, sqlite3_snprintf() | |
1344 | ** guarantees that the buffer is always zero-terminated. The first | |
1345 | ** parameter "n" is the total size of the buffer, including space for | |
1346 | ** the zero terminator. So the longest string that can be completely | |
1347 | ** written will be n-1 characters. | |
1348 | ** | |
1349 | ** These routines all implement some additional formatting | |
1350 | ** options that are useful for constructing SQL statements. | |
1351 | ** All of the usual printf formatting options apply. In addition, there | |
1352 | ** is are "%q", "%Q", and "%z" options. | |
1353 | ** | |
1354 | ** The %q option works like %s in that it substitutes a null-terminated | |
1355 | ** string from the argument list. But %q also doubles every '\'' character. | |
1356 | ** %q is designed for use inside a string literal. By doubling each '\'' | |
1357 | ** character it escapes that character and allows it to be inserted into | |
1358 | ** the string. | |
1359 | ** | |
1360 | ** For example, so some string variable contains text as follows: | |
1361 | ** | |
1362 | ** <blockquote><pre> | |
1363 | ** char *zText = "It's a happy day!"; | |
1364 | ** </pre></blockquote> | |
1365 | ** | |
1366 | ** One can use this text in an SQL statement as follows: | |
1367 | ** | |
1368 | ** <blockquote><pre> | |
1369 | ** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText); | |
1370 | ** sqlite3_exec(db, zSQL, 0, 0, 0); | |
1371 | ** sqlite3_free(zSQL); | |
1372 | ** </pre></blockquote> | |
1373 | ** | |
1374 | ** Because the %q format string is used, the '\'' character in zText | |
1375 | ** is escaped and the SQL generated is as follows: | |
1376 | ** | |
1377 | ** <blockquote><pre> | |
1378 | ** INSERT INTO table1 VALUES('It''s a happy day!') | |
1379 | ** </pre></blockquote> | |
1380 | ** | |
1381 | ** This is correct. Had we used %s instead of %q, the generated SQL | |
1382 | ** would have looked like this: | |
1383 | ** | |
1384 | ** <blockquote><pre> | |
1385 | ** INSERT INTO table1 VALUES('It's a happy day!'); | |
1386 | ** </pre></blockquote> | |
1387 | ** | |
1388 | ** This second example is an SQL syntax error. As a general rule you | |
1389 | ** should always use %q instead of %s when inserting text into a string | |
1390 | ** literal. | |
1391 | ** | |
1392 | ** The %Q option works like %q except it also adds single quotes around | |
1393 | ** the outside of the total string. Or if the parameter in the argument | |
1394 | ** list is a NULL pointer, %Q substitutes the text "NULL" (without single | |
1395 | ** quotes) in place of the %Q option. {END} So, for example, one could say: | |
1396 | ** | |
1397 | ** <blockquote><pre> | |
1398 | ** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText); | |
1399 | ** sqlite3_exec(db, zSQL, 0, 0, 0); | |
1400 | ** sqlite3_free(zSQL); | |
1401 | ** </pre></blockquote> | |
1402 | ** | |
1403 | ** The code above will render a correct SQL statement in the zSQL | |
1404 | ** variable even if the zText variable is a NULL pointer. | |
1405 | ** | |
1406 | ** The "%z" formatting option works exactly like "%s" with the | |
1407 | ** addition that after the string has been read and copied into | |
1408 | ** the result, [sqlite3_free()] is called on the input string. {END} | |
1409 | ** | |
1410 | ** INVARIANTS: | |
1411 | ** | |
1412 | ** {F17403} The [sqlite3_mprintf()] and [sqlite3_vmprintf()] interfaces | |
1413 | ** return either pointers to zero-terminated UTF-8 strings held in | |
1414 | ** memory obtained from [sqlite3_malloc()] or NULL pointers if | |
1415 | ** a call to [sqlite3_malloc()] fails. | |
1416 | ** | |
1417 | ** {F17406} The [sqlite3_snprintf()] interface writes a zero-terminated | |
1418 | ** UTF-8 string into the buffer pointed to by the second parameter | |
1419 | ** provided that the first parameter is greater than zero. | |
1420 | ** | |
1421 | ** {F17407} The [sqlite3_snprintf()] interface does not writes slots of | |
1422 | ** its output buffer (the second parameter) outside the range | |
1423 | ** of 0 through N-1 (where N is the first parameter) | |
1424 | ** regardless of the length of the string | |
1425 | ** requested by the format specification. | |
1426 | ** | |
1427 | */ | |
1428 | char *sqlite3_mprintf(const char*,...); | |
1429 | char *sqlite3_vmprintf(const char*, va_list); | |
1430 | char *sqlite3_snprintf(int,char*,const char*, ...); | |
1431 | ||
1432 | /* | |
1433 | ** CAPI3REF: Memory Allocation Subsystem {F17300} | |
1434 | ** | |
1435 | ** The SQLite core uses these three routines for all of its own | |
1436 | ** internal memory allocation needs. "Core" in the previous sentence | |
1437 | ** does not include operating-system specific VFS implementation. The | |
1438 | ** windows VFS uses native malloc and free for some operations. | |
1439 | ** | |
1440 | ** The sqlite3_malloc() routine returns a pointer to a block | |
1441 | ** of memory at least N bytes in length, where N is the parameter. | |
1442 | ** If sqlite3_malloc() is unable to obtain sufficient free | |
1443 | ** memory, it returns a NULL pointer. If the parameter N to | |
1444 | ** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns | |
1445 | ** a NULL pointer. | |
1446 | ** | |
1447 | ** Calling sqlite3_free() with a pointer previously returned | |
1448 | ** by sqlite3_malloc() or sqlite3_realloc() releases that memory so | |
1449 | ** that it might be reused. The sqlite3_free() routine is | |
1450 | ** a no-op if is called with a NULL pointer. Passing a NULL pointer | |
1451 | ** to sqlite3_free() is harmless. After being freed, memory | |
1452 | ** should neither be read nor written. Even reading previously freed | |
1453 | ** memory might result in a segmentation fault or other severe error. | |
1454 | ** Memory corruption, a segmentation fault, or other severe error | |
1455 | ** might result if sqlite3_free() is called with a non-NULL pointer that | |
1456 | ** was not obtained from sqlite3_malloc() or sqlite3_free(). | |
1457 | ** | |
1458 | ** The sqlite3_realloc() interface attempts to resize a | |
1459 | ** prior memory allocation to be at least N bytes, where N is the | |
1460 | ** second parameter. The memory allocation to be resized is the first | |
1461 | ** parameter. If the first parameter to sqlite3_realloc() | |
1462 | ** is a NULL pointer then its behavior is identical to calling | |
1463 | ** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc(). | |
1464 | ** If the second parameter to sqlite3_realloc() is zero or | |
1465 | ** negative then the behavior is exactly the same as calling | |
1466 | ** sqlite3_free(P) where P is the first parameter to sqlite3_realloc(). | |
1467 | ** Sqlite3_realloc() returns a pointer to a memory allocation | |
1468 | ** of at least N bytes in size or NULL if sufficient memory is unavailable. | |
1469 | ** If M is the size of the prior allocation, then min(N,M) bytes | |
1470 | ** of the prior allocation are copied into the beginning of buffer returned | |
1471 | ** by sqlite3_realloc() and the prior allocation is freed. | |
1472 | ** If sqlite3_realloc() returns NULL, then the prior allocation | |
1473 | ** is not freed. | |
1474 | ** | |
1475 | ** The memory returned by sqlite3_malloc() and sqlite3_realloc() | |
1476 | ** is always aligned to at least an 8 byte boundary. {END} | |
1477 | ** | |
1478 | ** The default implementation | |
1479 | ** of the memory allocation subsystem uses the malloc(), realloc() | |
1480 | ** and free() provided by the standard C library. {F17382} However, if | |
1481 | ** SQLite is compiled with the following C preprocessor macro | |
1482 | ** | |
1483 | ** <blockquote> SQLITE_MEMORY_SIZE=<i>NNN</i> </blockquote> | |
1484 | ** | |
1485 | ** where <i>NNN</i> is an integer, then SQLite create a static | |
1486 | ** array of at least <i>NNN</i> bytes in size and use that array | |
1487 | ** for all of its dynamic memory allocation needs. {END} Additional | |
1488 | ** memory allocator options may be added in future releases. | |
1489 | ** | |
1490 | ** In SQLite version 3.5.0 and 3.5.1, it was possible to define | |
1491 | ** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in | |
1492 | ** implementation of these routines to be omitted. That capability | |
1493 | ** is no longer provided. Only built-in memory allocators can be | |
1494 | ** used. | |
1495 | ** | |
1496 | ** The windows OS interface layer calls | |
1497 | ** the system malloc() and free() directly when converting | |
1498 | ** filenames between the UTF-8 encoding used by SQLite | |
1499 | ** and whatever filename encoding is used by the particular windows | |
1500 | ** installation. Memory allocation errors are detected, but | |
1501 | ** they are reported back as [SQLITE_CANTOPEN] or | |
1502 | ** [SQLITE_IOERR] rather than [SQLITE_NOMEM]. | |
1503 | ** | |
1504 | ** INVARIANTS: | |
1505 | ** | |
1506 | ** {F17303} The [sqlite3_malloc(N)] interface returns either a pointer to | |
1507 | ** newly checked-out block of at least N bytes of memory | |
1508 | ** that is 8-byte aligned, | |
1509 | ** or it returns NULL if it is unable to fulfill the request. | |
1510 | ** | |
1511 | ** {F17304} The [sqlite3_malloc(N)] interface returns a NULL pointer if | |
1512 | ** N is less than or equal to zero. | |
1513 | ** | |
1514 | ** {F17305} The [sqlite3_free(P)] interface releases memory previously | |
1515 | ** returned from [sqlite3_malloc()] or [sqlite3_realloc()], | |
1516 | ** making it available for reuse. | |
1517 | ** | |
1518 | ** {F17306} A call to [sqlite3_free(NULL)] is a harmless no-op. | |
1519 | ** | |
1520 | ** {F17310} A call to [sqlite3_realloc(0,N)] is equivalent to a call | |
1521 | ** to [sqlite3_malloc(N)]. | |
1522 | ** | |
1523 | ** {F17312} A call to [sqlite3_realloc(P,0)] is equivalent to a call | |
1524 | ** to [sqlite3_free(P)]. | |
1525 | ** | |
1526 | ** {F17315} The SQLite core uses [sqlite3_malloc()], [sqlite3_realloc()], | |
1527 | ** and [sqlite3_free()] for all of its memory allocation and | |
1528 | ** deallocation needs. | |
1529 | ** | |
1530 | ** {F17318} The [sqlite3_realloc(P,N)] interface returns either a pointer | |
1531 | ** to a block of checked-out memory of at least N bytes in size | |
1532 | ** that is 8-byte aligned, or a NULL pointer. | |
1533 | ** | |
1534 | ** {F17321} When [sqlite3_realloc(P,N)] returns a non-NULL pointer, it first | |
1535 | ** copies the first K bytes of content from P into the newly allocated | |
1536 | ** where K is the lessor of N and the size of the buffer P. | |
1537 | ** | |
1538 | ** {F17322} When [sqlite3_realloc(P,N)] returns a non-NULL pointer, it first | |
1539 | ** releases the buffer P. | |
1540 | ** | |
1541 | ** {F17323} When [sqlite3_realloc(P,N)] returns NULL, the buffer P is | |
1542 | ** not modified or released. | |
1543 | ** | |
1544 | ** LIMITATIONS: | |
1545 | ** | |
1546 | ** {U17350} The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()] | |
1547 | ** must be either NULL or else a pointer obtained from a prior | |
1548 | ** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that has | |
1549 | ** not been released. | |
1550 | ** | |
1551 | ** {U17351} The application must not read or write any part of | |
1552 | ** a block of memory after it has been released using | |
1553 | ** [sqlite3_free()] or [sqlite3_realloc()]. | |
1554 | ** | |
1555 | */ | |
1556 | void *sqlite3_malloc(int); | |
1557 | void *sqlite3_realloc(void*, int); | |
1558 | void sqlite3_free(void*); | |
1559 | ||
1560 | /* | |
1561 | ** CAPI3REF: Memory Allocator Statistics {F17370} | |
1562 | ** | |
1563 | ** SQLite provides these two interfaces for reporting on the status | |
1564 | ** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()] | |
1565 | ** the memory allocation subsystem included within the SQLite. | |
1566 | ** | |
1567 | ** INVARIANTS: | |
1568 | ** | |
1569 | ** {F17371} The [sqlite3_memory_used()] routine returns the | |
1570 | ** number of bytes of memory currently outstanding | |
1571 | ** (malloced but not freed). | |
1572 | ** | |
1573 | ** {F17373} The [sqlite3_memory_highwater()] routine returns the maximum | |
1574 | ** value of [sqlite3_memory_used()] | |
1575 | ** since the highwater mark was last reset. | |
1576 | ** | |
1577 | ** {F17374} The values returned by [sqlite3_memory_used()] and | |
1578 | ** [sqlite3_memory_highwater()] include any overhead | |
1579 | ** added by SQLite in its implementation of [sqlite3_malloc()], | |
1580 | ** but not overhead added by the any underlying system library | |
1581 | ** routines that [sqlite3_malloc()] may call. | |
1582 | ** | |
1583 | ** {F17375} The memory highwater mark is reset to the current value of | |
1584 | ** [sqlite3_memory_used()] if and only if the parameter to | |
1585 | ** [sqlite3_memory_highwater()] is true. The value returned | |
1586 | ** by [sqlite3_memory_highwater(1)] is the highwater mark | |
1587 | ** prior to the reset. | |
1588 | */ | |
1589 | sqlite3_int64 sqlite3_memory_used(void); | |
1590 | sqlite3_int64 sqlite3_memory_highwater(int resetFlag); | |
1591 | ||
1592 | /* | |
1593 | ** CAPI3REF: Pseudo-Random Number Generator {F17390} | |
1594 | ** | |
1595 | ** SQLite contains a high-quality pseudo-random number generator (PRNG) used to | |
1596 | ** select random ROWIDs when inserting new records into a table that | |
1597 | ** already uses the largest possible ROWID. The PRNG is also used for | |
1598 | ** the build-in random() and randomblob() SQL functions. This interface allows | |
1599 | ** appliations to access the same PRNG for other purposes. | |
1600 | ** | |
1601 | ** A call to this routine stores N bytes of randomness into buffer P. | |
1602 | ** | |
1603 | ** The first time this routine is invoked (either internally or by | |
1604 | ** the application) the PRNG is seeded using randomness obtained | |
1605 | ** from the xRandomness method of the default [sqlite3_vfs] object. | |
1606 | ** On all subsequent invocations, the pseudo-randomness is generated | |
1607 | ** internally and without recourse to the [sqlite3_vfs] xRandomness | |
1608 | ** method. | |
1609 | ** | |
1610 | ** INVARIANTS: | |
1611 | ** | |
1612 | ** {F17392} The [sqlite3_randomness(N,P)] interface writes N bytes of | |
1613 | ** high-quality pseudo-randomness into buffer P. | |
1614 | */ | |
1615 | void sqlite3_randomness(int N, void *P); | |
1616 | ||
1617 | /* | |
1618 | ** CAPI3REF: Compile-Time Authorization Callbacks {F12500} | |
1619 | ** | |
1620 | ** This routine registers a authorizer callback with a particular | |
1621 | ** [database connection], supplied in the first argument. | |
1622 | ** The authorizer callback is invoked as SQL statements are being compiled | |
1623 | ** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()], | |
1624 | ** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. At various | |
1625 | ** points during the compilation process, as logic is being created | |
1626 | ** to perform various actions, the authorizer callback is invoked to | |
1627 | ** see if those actions are allowed. The authorizer callback should | |
1628 | ** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the | |
1629 | ** specific action but allow the SQL statement to continue to be | |
1630 | ** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be | |
1631 | ** rejected with an error. If the authorizer callback returns | |
1632 | ** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY] | |
1633 | ** then [sqlite3_prepare_v2()] or equivalent call that triggered | |
1634 | ** the authorizer will fail with an error message. | |
1635 | ** | |
1636 | ** When the callback returns [SQLITE_OK], that means the operation | |
1637 | ** requested is ok. When the callback returns [SQLITE_DENY], the | |
1638 | ** [sqlite3_prepare_v2()] or equivalent call that triggered the | |
1639 | ** authorizer will fail with an error message explaining that | |
1640 | ** access is denied. If the authorizer code is [SQLITE_READ] | |
1641 | ** and the callback returns [SQLITE_IGNORE] then the | |
1642 | ** [prepared statement] statement is constructed to substitute | |
1643 | ** a NULL value in place of the table column that would have | |
1644 | ** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE] | |
1645 | ** return can be used to deny an untrusted user access to individual | |
1646 | ** columns of a table. | |
1647 | ** | |
1648 | ** The first parameter to the authorizer callback is a copy of | |
1649 | ** the third parameter to the sqlite3_set_authorizer() interface. | |
1650 | ** The second parameter to the callback is an integer | |
1651 | ** [SQLITE_COPY | action code] that specifies the particular action | |
1652 | ** to be authorized. The third through sixth | |
1653 | ** parameters to the callback are zero-terminated strings that contain | |
1654 | ** additional details about the action to be authorized. | |
1655 | ** | |
1656 | ** An authorizer is used when [sqlite3_prepare | preparing] | |
1657 | ** SQL statements from an untrusted | |
1658 | ** source, to ensure that the SQL statements do not try to access data | |
1659 | ** that they are not allowed to see, or that they do not try to | |
1660 | ** execute malicious statements that damage the database. For | |
1661 | ** example, an application may allow a user to enter arbitrary | |
1662 | ** SQL queries for evaluation by a database. But the application does | |
1663 | ** not want the user to be able to make arbitrary changes to the | |
1664 | ** database. An authorizer could then be put in place while the | |
1665 | ** user-entered SQL is being [sqlite3_prepare | prepared] that | |
1666 | ** disallows everything except [SELECT] statements. | |
1667 | ** | |
1668 | ** Applications that need to process SQL from untrusted sources | |
1669 | ** might also consider lowering resource limits using [sqlite3_limit()] | |
1670 | ** and limiting database size using the [max_page_count] [PRAGMA] | |
1671 | ** in addition to using an authorizer. | |
1672 | ** | |
1673 | ** Only a single authorizer can be in place on a database connection | |
1674 | ** at a time. Each call to sqlite3_set_authorizer overrides the | |
1675 | ** previous call. Disable the authorizer by installing a NULL callback. | |
1676 | ** The authorizer is disabled by default. | |
1677 | ** | |
1678 | ** Note that the authorizer callback is invoked only during | |
1679 | ** [sqlite3_prepare()] or its variants. Authorization is not | |
1680 | ** performed during statement evaluation in [sqlite3_step()]. | |
1681 | ** | |
1682 | ** INVARIANTS: | |
1683 | ** | |
1684 | ** {F12501} The [sqlite3_set_authorizer(D,...)] interface registers a | |
1685 | ** authorizer callback with database connection D. | |
1686 | ** | |
1687 | ** {F12502} The authorizer callback is invoked as SQL statements are | |
1688 | ** being compiled | |
1689 | ** | |
1690 | ** {F12503} If the authorizer callback returns any value other than | |
1691 | ** [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY] then | |
1692 | ** the [sqlite3_prepare_v2()] or equivalent call that caused | |
1693 | ** the authorizer callback to run shall fail with an | |
1694 | ** [SQLITE_ERROR] error code and an appropriate error message. | |
1695 | ** | |
1696 | ** {F12504} When the authorizer callback returns [SQLITE_OK], the operation | |
1697 | ** described is coded normally. | |
1698 | ** | |
1699 | ** {F12505} When the authorizer callback returns [SQLITE_DENY], the | |
1700 | ** [sqlite3_prepare_v2()] or equivalent call that caused the | |
1701 | ** authorizer callback to run shall fail | |
1702 | ** with an [SQLITE_ERROR] error code and an error message | |
1703 | ** explaining that access is denied. | |
1704 | ** | |
1705 | ** {F12506} If the authorizer code (the 2nd parameter to the authorizer | |
1706 | ** callback) is [SQLITE_READ] and the authorizer callback returns | |
1707 | ** [SQLITE_IGNORE] then the prepared statement is constructed to | |
1708 | ** insert a NULL value in place of the table column that would have | |
1709 | ** been read if [SQLITE_OK] had been returned. | |
1710 | ** | |
1711 | ** {F12507} If the authorizer code (the 2nd parameter to the authorizer | |
1712 | ** callback) is anything other than [SQLITE_READ], then | |
1713 | ** a return of [SQLITE_IGNORE] has the same effect as [SQLITE_DENY]. | |
1714 | ** | |
1715 | ** {F12510} The first parameter to the authorizer callback is a copy of | |
1716 | ** the third parameter to the [sqlite3_set_authorizer()] interface. | |
1717 | ** | |
1718 | ** {F12511} The second parameter to the callback is an integer | |
1719 | ** [SQLITE_COPY | action code] that specifies the particular action | |
1720 | ** to be authorized. | |
1721 | ** | |
1722 | ** {F12512} The third through sixth parameters to the callback are | |
1723 | ** zero-terminated strings that contain | |
1724 | ** additional details about the action to be authorized. | |
1725 | ** | |
1726 | ** {F12520} Each call to [sqlite3_set_authorizer()] overrides the | |
1727 | ** any previously installed authorizer. | |
1728 | ** | |
1729 | ** {F12521} A NULL authorizer means that no authorization | |
1730 | ** callback is invoked. | |
1731 | ** | |
1732 | ** {F12522} The default authorizer is NULL. | |
1733 | */ | |
1734 | int sqlite3_set_authorizer( | |
1735 | sqlite3*, | |
1736 | int (*xAuth)(void*,int,const char*,const char*,const char*,const char*), | |
1737 | void *pUserData | |
1738 | ); | |
1739 | ||
1740 | /* | |
1741 | ** CAPI3REF: Authorizer Return Codes {F12590} | |
1742 | ** | |
1743 | ** The [sqlite3_set_authorizer | authorizer callback function] must | |
1744 | ** return either [SQLITE_OK] or one of these two constants in order | |
1745 | ** to signal SQLite whether or not the action is permitted. See the | |
1746 | ** [sqlite3_set_authorizer | authorizer documentation] for additional | |
1747 | ** information. | |
1748 | */ | |
1749 | #define SQLITE_DENY 1 /* Abort the SQL statement with an error */ | |
1750 | #define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */ | |
1751 | ||
1752 | /* | |
1753 | ** CAPI3REF: Authorizer Action Codes {F12550} | |
1754 | ** | |
1755 | ** The [sqlite3_set_authorizer()] interface registers a callback function | |
1756 | ** that is invoked to authorizer certain SQL statement actions. The | |
1757 | ** second parameter to the callback is an integer code that specifies | |
1758 | ** what action is being authorized. These are the integer action codes that | |
1759 | ** the authorizer callback may be passed. | |
1760 | ** | |
1761 | ** These action code values signify what kind of operation is to be | |
1762 | ** authorized. The 3rd and 4th parameters to the authorization | |
1763 | ** callback function will be parameters or NULL depending on which of these | |
1764 | ** codes is used as the second parameter. The 5th parameter to the | |
1765 | ** authorizer callback is the name of the database ("main", "temp", | |
1766 | ** etc.) if applicable. The 6th parameter to the authorizer callback | |
1767 | ** is the name of the inner-most trigger or view that is responsible for | |
1768 | ** the access attempt or NULL if this access attempt is directly from | |
1769 | ** top-level SQL code. | |
1770 | ** | |
1771 | ** INVARIANTS: | |
1772 | ** | |
1773 | ** {F12551} The second parameter to an | |
1774 | ** [sqlite3_set_authorizer | authorizer callback is always an integer | |
1775 | ** [SQLITE_COPY | authorizer code] that specifies what action | |
1776 | ** is being authorized. | |
1777 | ** | |
1778 | ** {F12552} The 3rd and 4th parameters to the | |
1779 | ** [sqlite3_set_authorizer | authorization callback function] | |
1780 | ** will be parameters or NULL depending on which | |
1781 | ** [SQLITE_COPY | authorizer code] is used as the second parameter. | |
1782 | ** | |
1783 | ** {F12553} The 5th parameter to the | |
1784 | ** [sqlite3_set_authorizer | authorizer callback] is the name | |
1785 | ** of the database (example: "main", "temp", etc.) if applicable. | |
1786 | ** | |
1787 | ** {F12554} The 6th parameter to the | |
1788 | ** [sqlite3_set_authorizer | authorizer callback] is the name | |
1789 | ** of the inner-most trigger or view that is responsible for | |
1790 | ** the access attempt or NULL if this access attempt is directly from | |
1791 | ** top-level SQL code. | |
1792 | */ | |
1793 | /******************************************* 3rd ************ 4th ***********/ | |
1794 | #define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */ | |
1795 | #define SQLITE_CREATE_TABLE 2 /* Table Name NULL */ | |
1796 | #define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */ | |
1797 | #define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */ | |
1798 | #define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */ | |
1799 | #define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */ | |
1800 | #define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */ | |
1801 | #define SQLITE_CREATE_VIEW 8 /* View Name NULL */ | |
1802 | #define SQLITE_DELETE 9 /* Table Name NULL */ | |
1803 | #define SQLITE_DROP_INDEX 10 /* Index Name Table Name */ | |
1804 | #define SQLITE_DROP_TABLE 11 /* Table Name NULL */ | |
1805 | #define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */ | |
1806 | #define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */ | |
1807 | #define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */ | |
1808 | #define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */ | |
1809 | #define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */ | |
1810 | #define SQLITE_DROP_VIEW 17 /* View Name NULL */ | |
1811 | #define SQLITE_INSERT 18 /* Table Name NULL */ | |
1812 | #define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */ | |
1813 | #define SQLITE_READ 20 /* Table Name Column Name */ | |
1814 | #define SQLITE_SELECT 21 /* NULL NULL */ | |
1815 | #define SQLITE_TRANSACTION 22 /* NULL NULL */ | |
1816 | #define SQLITE_UPDATE 23 /* Table Name Column Name */ | |
1817 | #define SQLITE_ATTACH 24 /* Filename NULL */ | |
1818 | #define SQLITE_DETACH 25 /* Database Name NULL */ | |
1819 | #define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */ | |
1820 | #define SQLITE_REINDEX 27 /* Index Name NULL */ | |
1821 | #define SQLITE_ANALYZE 28 /* Table Name NULL */ | |
1822 | #define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */ | |
1823 | #define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */ | |
1824 | #define SQLITE_FUNCTION 31 /* Function Name NULL */ | |
1825 | #define SQLITE_COPY 0 /* No longer used */ | |
1826 | ||
1827 | /* | |
1828 | ** CAPI3REF: Tracing And Profiling Functions {F12280} | |
1829 | ** | |
1830 | ** These routines register callback functions that can be used for | |
1831 | ** tracing and profiling the execution of SQL statements. | |
1832 | ** | |
1833 | ** The callback function registered by sqlite3_trace() is invoked at | |
1834 | ** various times when an SQL statement is being run by [sqlite3_step()]. | |
1835 | ** The callback returns a UTF-8 rendering of the SQL statement text | |
1836 | ** as the statement first begins executing. Additional callbacks occur | |
1837 | ** as each triggersubprogram is entered. The callbacks for triggers | |
1838 | ** contain a UTF-8 SQL comment that identifies the trigger. | |
1839 | ** | |
1840 | ** The callback function registered by sqlite3_profile() is invoked | |
1841 | ** as each SQL statement finishes. The profile callback contains | |
1842 | ** the original statement text and an estimate of wall-clock time | |
1843 | ** of how long that statement took to run. | |
1844 | ** | |
1845 | ** The sqlite3_profile() API is currently considered experimental and | |
1846 | ** is subject to change or removal in a future release. | |
1847 | ** | |
1848 | ** The trigger reporting feature of the trace callback is considered | |
1849 | ** experimental and is subject to change or removal in future releases. | |
1850 | ** Future versions of SQLite might also add new trace callback | |
1851 | ** invocations. | |
1852 | ** | |
1853 | ** INVARIANTS: | |
1854 | ** | |
1855 | ** {F12281} The callback function registered by [sqlite3_trace()] is | |
1856 | ** whenever an SQL statement first begins to execute and | |
1857 | ** whenever a trigger subprogram first begins to run. | |
1858 | ** | |
1859 | ** {F12282} Each call to [sqlite3_trace()] overrides the previously | |
1860 | ** registered trace callback. | |
1861 | ** | |
1862 | ** {F12283} A NULL trace callback disables tracing. | |
1863 | ** | |
1864 | ** {F12284} The first argument to the trace callback is a copy of | |
1865 | ** the pointer which was the 3rd argument to [sqlite3_trace()]. | |
1866 | ** | |
1867 | ** {F12285} The second argument to the trace callback is a | |
1868 | ** zero-terminated UTF8 string containing the original text | |
1869 | ** of the SQL statement as it was passed into [sqlite3_prepare_v2()] | |
1870 | ** or the equivalent, or an SQL comment indicating the beginning | |
1871 | ** of a trigger subprogram. | |
1872 | ** | |
1873 | ** {F12287} The callback function registered by [sqlite3_profile()] is invoked | |
1874 | ** as each SQL statement finishes. | |
1875 | ** | |
1876 | ** {F12288} The first parameter to the profile callback is a copy of | |
1877 | ** the 3rd parameter to [sqlite3_profile()]. | |
1878 | ** | |
1879 | ** {F12289} The second parameter to the profile callback is a | |
1880 | ** zero-terminated UTF-8 string that contains the complete text of | |
1881 | ** the SQL statement as it was processed by [sqlite3_prepare_v2()] | |
1882 | ** or the equivalent. | |
1883 | ** | |
1884 | ** {F12290} The third parameter to the profile callback is an estimate | |
1885 | ** of the number of nanoseconds of wall-clock time required to | |
1886 | ** run the SQL statement from start to finish. | |
1887 | */ | |
1888 | void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*); | |
1889 | void *sqlite3_profile(sqlite3*, | |
1890 | void(*xProfile)(void*,const char*,sqlite3_uint64), void*); | |
1891 | ||
1892 | /* | |
1893 | ** CAPI3REF: Query Progress Callbacks {F12910} | |
1894 | ** | |
1895 | ** This routine configures a callback function - the | |
1896 | ** progress callback - that is invoked periodically during long | |
1897 | ** running calls to [sqlite3_exec()], [sqlite3_step()] and | |
1898 | ** [sqlite3_get_table()]. An example use for this | |
1899 | ** interface is to keep a GUI updated during a large query. | |
1900 | ** | |
1901 | ** If the progress callback returns non-zero, the opertion is | |
1902 | ** interrupted. This feature can be used to implement a | |
1903 | ** "Cancel" button on a GUI dialog box. | |
1904 | ** | |
1905 | ** INVARIANTS: | |
1906 | ** | |
1907 | ** {F12911} The callback function registered by [sqlite3_progress_handler()] | |
1908 | ** is invoked periodically during long running calls to | |
1909 | ** [sqlite3_step()]. | |
1910 | ** | |
1911 | ** {F12912} The progress callback is invoked once for every N virtual | |
1912 | ** machine opcodes, where N is the second argument to | |
1913 | ** the [sqlite3_progress_handler()] call that registered | |
1914 | ** the callback. <todo>What if N is less than 1?</todo> | |
1915 | ** | |
1916 | ** {F12913} The progress callback itself is identified by the third | |
1917 | ** argument to [sqlite3_progress_handler()]. | |
1918 | ** | |
1919 | ** {F12914} The fourth argument [sqlite3_progress_handler()] is a | |
1920 | *** void pointer passed to the progress callback | |
1921 | ** function each time it is invoked. | |
1922 | ** | |
1923 | ** {F12915} If a call to [sqlite3_step()] results in fewer than | |
1924 | ** N opcodes being executed, | |
1925 | ** then the progress callback is never invoked. {END} | |
1926 | ** | |
1927 | ** {F12916} Every call to [sqlite3_progress_handler()] | |
1928 | ** overwrites any previously registere progress handler. | |
1929 | ** | |
1930 | ** {F12917} If the progress handler callback is NULL then no progress | |
1931 | ** handler is invoked. | |
1932 | ** | |
1933 | ** {F12918} If the progress callback returns a result other than 0, then | |
1934 | ** the behavior is a if [sqlite3_interrupt()] had been called. | |
1935 | */ | |
1936 | void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*); | |
1937 | ||
1938 | /* | |
1939 | ** CAPI3REF: Opening A New Database Connection {F12700} | |
1940 | ** | |
1941 | ** These routines open an SQLite database file whose name | |
1942 | ** is given by the filename argument. | |
1943 | ** The filename argument is interpreted as UTF-8 | |
1944 | ** for [sqlite3_open()] and [sqlite3_open_v2()] and as UTF-16 | |
1945 | ** in the native byte order for [sqlite3_open16()]. | |
1946 | ** An [sqlite3*] handle is usually returned in *ppDb, even | |
1947 | ** if an error occurs. The only exception is if SQLite is unable | |
1948 | ** to allocate memory to hold the [sqlite3] object, a NULL will | |
1949 | ** be written into *ppDb instead of a pointer to the [sqlite3] object. | |
1950 | ** If the database is opened (and/or created) | |
1951 | ** successfully, then [SQLITE_OK] is returned. Otherwise an | |
1952 | ** error code is returned. The | |
1953 | ** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain | |
1954 | ** an English language description of the error. | |
1955 | ** | |
1956 | ** The default encoding for the database will be UTF-8 if | |
1957 | ** [sqlite3_open()] or [sqlite3_open_v2()] is called and | |
1958 | ** UTF-16 in the native byte order if [sqlite3_open16()] is used. | |
1959 | ** | |
1960 | ** Whether or not an error occurs when it is opened, resources | |
1961 | ** associated with the [sqlite3*] handle should be released by passing it | |
1962 | ** to [sqlite3_close()] when it is no longer required. | |
1963 | ** | |
1964 | ** The [sqlite3_open_v2()] interface works like [sqlite3_open()] | |
1965 | ** except that it acccepts two additional parameters for additional control | |
1966 | ** over the new database connection. The flags parameter can be | |
1967 | ** one of: | |
1968 | ** | |
1969 | ** <ol> | |
1970 | ** <li> [SQLITE_OPEN_READONLY] | |
1971 | ** <li> [SQLITE_OPEN_READWRITE] | |
1972 | ** <li> [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE] | |
1973 | ** </ol> | |
1974 | ** | |
1975 | ** The first value opens the database read-only. | |
1976 | ** If the database does not previously exist, an error is returned. | |
1977 | ** The second option opens | |
1978 | ** the database for reading and writing if possible, or reading only if | |
1979 | ** if the file is write protected. In either case the database | |
1980 | ** must already exist or an error is returned. The third option | |
1981 | ** opens the database for reading and writing and creates it if it does | |
1982 | ** not already exist. | |
1983 | ** The third options is behavior that is always used for [sqlite3_open()] | |
1984 | ** and [sqlite3_open16()]. | |
1985 | ** | |
1986 | ** If the 3rd parameter to [sqlite3_open_v2()] is not one of the | |
1987 | ** combinations shown above then the behavior is undefined. | |
1988 | ** | |
1989 | ** If the filename is ":memory:", then an private | |
1990 | ** in-memory database is created for the connection. This in-memory | |
1991 | ** database will vanish when the database connection is closed. Future | |
1992 | ** version of SQLite might make use of additional special filenames | |
1993 | ** that begin with the ":" character. It is recommended that | |
1994 | ** when a database filename really does begin with | |
1995 | ** ":" that you prefix the filename with a pathname like "./" to | |
1996 | ** avoid ambiguity. | |
1997 | ** | |
1998 | ** If the filename is an empty string, then a private temporary | |
1999 | ** on-disk database will be created. This private database will be | |
2000 | ** automatically deleted as soon as the database connection is closed. | |
2001 | ** | |
2002 | ** The fourth parameter to sqlite3_open_v2() is the name of the | |
2003 | ** [sqlite3_vfs] object that defines the operating system | |
2004 | ** interface that the new database connection should use. If the | |
2005 | ** fourth parameter is a NULL pointer then the default [sqlite3_vfs] | |
2006 | ** object is used. | |
2007 | ** | |
2008 | ** <b>Note to windows users:</b> The encoding used for the filename argument | |
2009 | ** of [sqlite3_open()] and [sqlite3_open_v2()] must be UTF-8, not whatever | |
2010 | ** codepage is currently defined. Filenames containing international | |
2011 | ** characters must be converted to UTF-8 prior to passing them into | |
2012 | ** [sqlite3_open()] or [sqlite3_open_v2()]. | |
2013 | ** | |
2014 | ** INVARIANTS: | |
2015 | ** | |
2016 | ** {F12701} The [sqlite3_open()], [sqlite3_open16()], and | |
2017 | ** [sqlite3_open_v2()] interfaces create a new | |
2018 | ** [database connection] associated with | |
2019 | ** the database file given in their first parameter. | |
2020 | ** | |
2021 | ** {F12702} The filename argument is interpreted as UTF-8 | |
2022 | ** for [sqlite3_open()] and [sqlite3_open_v2()] and as UTF-16 | |
2023 | ** in the native byte order for [sqlite3_open16()]. | |
2024 | ** | |
2025 | ** {F12703} A successful invocation of [sqlite3_open()], [sqlite3_open16()], | |
2026 | ** or [sqlite3_open_v2()] writes a pointer to a new | |
2027 | ** [database connection] into *ppDb. | |
2028 | ** | |
2029 | ** {F12704} The [sqlite3_open()], [sqlite3_open16()], and | |
2030 | ** [sqlite3_open_v2()] interfaces return [SQLITE_OK] upon success, | |
2031 | ** or an appropriate [error code] on failure. | |
2032 | ** | |
2033 | ** {F12706} The default text encoding for a new database created using | |
2034 | ** [sqlite3_open()] or [sqlite3_open_v2()] will be UTF-8. | |
2035 | ** | |
2036 | ** {F12707} The default text encoding for a new database created using | |
2037 | ** [sqlite3_open16()] will be UTF-16. | |
2038 | ** | |
2039 | ** {F12709} The [sqlite3_open(F,D)] interface is equivalent to | |
2040 | ** [sqlite3_open_v2(F,D,G,0)] where the G parameter is | |
2041 | ** [SQLITE_OPEN_READWRITE]|[SQLITE_OPEN_CREATE]. | |
2042 | ** | |
2043 | ** {F12711} If the G parameter to [sqlite3_open_v2(F,D,G,V)] contains the | |
2044 | ** bit value [SQLITE_OPEN_READONLY] then the database is opened | |
2045 | ** for reading only. | |
2046 | ** | |
2047 | ** {F12712} If the G parameter to [sqlite3_open_v2(F,D,G,V)] contains the | |
2048 | ** bit value [SQLITE_OPEN_READWRITE] then the database is opened | |
2049 | ** reading and writing if possible, or for reading only if the | |
2050 | ** file is write protected by the operating system. | |
2051 | ** | |
2052 | ** {F12713} If the G parameter to [sqlite3_open(v2(F,D,G,V)] omits the | |
2053 | ** bit value [SQLITE_OPEN_CREATE] and the database does not | |
2054 | ** previously exist, an error is returned. | |
2055 | ** | |
2056 | ** {F12714} If the G parameter to [sqlite3_open(v2(F,D,G,V)] contains the | |
2057 | ** bit value [SQLITE_OPEN_CREATE] and the database does not | |
2058 | ** previously exist, then an attempt is made to create and | |
2059 | ** initialize the database. | |
2060 | ** | |
2061 | ** {F12717} If the filename argument to [sqlite3_open()], [sqlite3_open16()], | |
2062 | ** or [sqlite3_open_v2()] is ":memory:", then an private, | |
2063 | ** ephemeral, in-memory database is created for the connection. | |
2064 | ** <todo>Is SQLITE_OPEN_CREATE|SQLITE_OPEN_READWRITE required | |
2065 | ** in sqlite3_open_v2()?</todo> | |
2066 | ** | |
2067 | ** {F12719} If the filename is NULL or an empty string, then a private, | |
2068 | ** ephermeral on-disk database will be created. | |
2069 | ** <todo>Is SQLITE_OPEN_CREATE|SQLITE_OPEN_READWRITE required | |
2070 | ** in sqlite3_open_v2()?</todo> | |
2071 | ** | |
2072 | ** {F12721} The [database connection] created by | |
2073 | ** [sqlite3_open_v2(F,D,G,V)] will use the | |
2074 | ** [sqlite3_vfs] object identified by the V parameter, or | |
2075 | ** the default [sqlite3_vfs] object is V is a NULL pointer. | |
2076 | */ | |
2077 | int sqlite3_open( | |
2078 | const char *filename, /* Database filename (UTF-8) */ | |
2079 | sqlite3 **ppDb /* OUT: SQLite db handle */ | |
2080 | ); | |
2081 | int sqlite3_open16( | |
2082 | const void *filename, /* Database filename (UTF-16) */ | |
2083 | sqlite3 **ppDb /* OUT: SQLite db handle */ | |
2084 | ); | |
2085 | int sqlite3_open_v2( | |
2086 | const char *filename, /* Database filename (UTF-8) */ | |
2087 | sqlite3 **ppDb, /* OUT: SQLite db handle */ | |
2088 | int flags, /* Flags */ | |
2089 | const char *zVfs /* Name of VFS module to use */ | |
2090 | ); | |
2091 | ||
2092 | /* | |
2093 | ** CAPI3REF: Error Codes And Messages {F12800} | |
2094 | ** | |
2095 | ** The sqlite3_errcode() interface returns the numeric | |
2096 | ** [SQLITE_OK | result code] or [SQLITE_IOERR_READ | extended result code] | |
2097 | ** for the most recent failed sqlite3_* API call associated | |
2098 | ** with [sqlite3] handle 'db'. If a prior API call failed but the | |
2099 | ** most recent API call succeeded, the return value from sqlite3_errcode() | |
2100 | ** is undefined. | |
2101 | ** | |
2102 | ** The sqlite3_errmsg() and sqlite3_errmsg16() return English-language | |
2103 | ** text that describes the error, as either UTF8 or UTF16 respectively. | |
2104 | ** Memory to hold the error message string is managed internally. | |
2105 | ** The application does not need to worry with freeing the result. | |
2106 | ** However, the error string might be overwritten or deallocated by | |
2107 | ** subsequent calls to other SQLite interface functions. | |
2108 | ** | |
2109 | ** INVARIANTS: | |
2110 | ** | |
2111 | ** {F12801} The [sqlite3_errcode(D)] interface returns the numeric | |
2112 | ** [SQLITE_OK | result code] or | |
2113 | ** [SQLITE_IOERR_READ | extended result code] | |
2114 | ** for the most recently failed interface call associated | |
2115 | ** with [database connection] D. | |
2116 | ** | |
2117 | ** {F12803} The [sqlite3_errmsg(D)] and [sqlite3_errmsg16(D)] | |
2118 | ** interfaces return English-language text that describes | |
2119 | ** the error in the mostly recently failed interface call, | |
2120 | ** encoded as either UTF8 or UTF16 respectively. | |
2121 | ** | |
2122 | ** {F12807} The strings returned by [sqlite3_errmsg()] and [sqlite3_errmsg16()] | |
2123 | ** are valid until the next SQLite interface call. | |
2124 | ** | |
2125 | ** {F12808} Calls to API routines that do not return an error code | |
2126 | ** (example: [sqlite3_data_count()]) do not | |
2127 | ** change the error code or message returned by | |
2128 | ** [sqlite3_errcode()], [sqlite3_errmsg()], or [sqlite3_errmsg16()]. | |
2129 | ** | |
2130 | ** {F12809} Interfaces that are not associated with a specific | |
2131 | ** [database connection] (examples: | |
2132 | ** [sqlite3_mprintf()] or [sqlite3_enable_shared_cache()] | |
2133 | ** do not change the values returned by | |
2134 | ** [sqlite3_errcode()], [sqlite3_errmsg()], or [sqlite3_errmsg16()]. | |
2135 | */ | |
2136 | int sqlite3_errcode(sqlite3 *db); | |
2137 | const char *sqlite3_errmsg(sqlite3*); | |
2138 | const void *sqlite3_errmsg16(sqlite3*); | |
2139 | ||
2140 | /* | |
2141 | ** CAPI3REF: SQL Statement Object {F13000} | |
2142 | ** KEYWORDS: {prepared statement} {prepared statements} | |
2143 | ** | |
2144 | ** An instance of this object represent single SQL statements. This | |
2145 | ** object is variously known as a "prepared statement" or a | |
2146 | ** "compiled SQL statement" or simply as a "statement". | |
2147 | ** | |
2148 | ** The life of a statement object goes something like this: | |
2149 | ** | |
2150 | ** <ol> | |
2151 | ** <li> Create the object using [sqlite3_prepare_v2()] or a related | |
2152 | ** function. | |
2153 | ** <li> Bind values to host parameters using | |
2154 | ** [sqlite3_bind_blob | sqlite3_bind_* interfaces]. | |
2155 | ** <li> Run the SQL by calling [sqlite3_step()] one or more times. | |
2156 | ** <li> Reset the statement using [sqlite3_reset()] then go back | |
2157 | ** to step 2. Do this zero or more times. | |
2158 | ** <li> Destroy the object using [sqlite3_finalize()]. | |
2159 | ** </ol> | |
2160 | ** | |
2161 | ** Refer to documentation on individual methods above for additional | |
2162 | ** information. | |
2163 | */ | |
2164 | typedef struct sqlite3_stmt sqlite3_stmt; | |
2165 | ||
2166 | /* | |
2167 | ** CAPI3REF: Run-time Limits {F12760} | |
2168 | ** | |
2169 | ** This interface allows the size of various constructs to be limited | |
2170 | ** on a connection by connection basis. The first parameter is the | |
2171 | ** [database connection] whose limit is to be set or queried. The | |
2172 | ** second parameter is one of the [limit categories] that define a | |
2173 | ** class of constructs to be size limited. The third parameter is the | |
2174 | ** new limit for that construct. The function returns the old limit. | |
2175 | ** | |
2176 | ** If the new limit is a negative number, the limit is unchanged. | |
2177 | ** For the limit category of SQLITE_LIMIT_XYZ there is a hard upper | |
2178 | ** bound set by a compile-time C-preprocess macro named SQLITE_MAX_XYZ. | |
2179 | ** (The "_LIMIT_" in the name is changed to "_MAX_".) | |
2180 | ** Attempts to increase a limit above its hard upper bound are | |
2181 | ** silently truncated to the hard upper limit. | |
2182 | ** | |
2183 | ** Run time limits are intended for use in applications that manage | |
2184 | ** both their own internal database and also databases that are controlled | |
2185 | ** by untrusted external sources. An example application might be a | |
2186 | ** webbrowser that has its own databases for storing history and | |
2187 | ** separate databases controlled by javascript applications downloaded | |
2188 | ** off the internet. The internal databases can be given the | |
2189 | ** large, default limits. Databases managed by external sources can | |
2190 | ** be given much smaller limits designed to prevent a denial of service | |
2191 | ** attach. Developers might also want to use the [sqlite3_set_authorizer()] | |
2192 | ** interface to further control untrusted SQL. The size of the database | |
2193 | ** created by an untrusted script can be contained using the | |
2194 | ** [max_page_count] [PRAGMA]. | |
2195 | ** | |
2196 | ** This interface is currently considered experimental and is subject | |
2197 | ** to change or removal without prior notice. | |
2198 | ** | |
2199 | ** INVARIANTS: | |
2200 | ** | |
2201 | ** {F12762} A successful call to [sqlite3_limit(D,C,V)] where V is | |
2202 | ** positive changes the | |
2203 | ** limit on the size of construct C in [database connection] D | |
2204 | ** to the lessor of V and the hard upper bound on the size | |
2205 | ** of C that is set at compile-time. | |
2206 | ** | |
2207 | ** {F12766} A successful call to [sqlite3_limit(D,C,V)] where V is negative | |
2208 | ** leaves the state of [database connection] D unchanged. | |
2209 | ** | |
2210 | ** {F12769} A successful call to [sqlite3_limit(D,C,V)] returns the | |
2211 | ** value of the limit on the size of construct C in | |
2212 | ** in [database connection] D as it was prior to the call. | |
2213 | */ | |
2214 | int sqlite3_limit(sqlite3*, int id, int newVal); | |
2215 | ||
2216 | /* | |
2217 | ** CAPI3REF: Run-Time Limit Categories {F12790} | |
2218 | ** KEYWORDS: {limit category} {limit categories} | |
2219 | ** | |
2220 | ** These constants define various aspects of a [database connection] | |
2221 | ** that can be limited in size by calls to [sqlite3_limit()]. | |
2222 | ** The meanings of the various limits are as follows: | |
2223 | ** | |
2224 | ** <dl> | |
2225 | ** <dt>SQLITE_LIMIT_LENGTH</dt> | |
2226 | ** <dd>The maximum size of any | |
2227 | ** string or blob or table row.<dd> | |
2228 | ** | |
2229 | ** <dt>SQLITE_LIMIT_SQL_LENGTH</dt> | |
2230 | ** <dd>The maximum length of an SQL statement.</dd> | |
2231 | ** | |
2232 | ** <dt>SQLITE_LIMIT_COLUMN</dt> | |
2233 | ** <dd>The maximum number of columns in a table definition or in the | |
2234 | ** result set of a SELECT or the maximum number of columns in an index | |
2235 | ** or in an ORDER BY or GROUP BY clause.</dd> | |
2236 | ** | |
2237 | ** <dt>SQLITE_LIMIT_EXPR_DEPTH</dt> | |
2238 | ** <dd>The maximum depth of the parse tree on any expression.</dd> | |
2239 | ** | |
2240 | ** <dt>SQLITE_LIMIT_COMPOUND_SELECT</dt> | |
2241 | ** <dd>The maximum number of terms in a compound SELECT statement.</dd> | |
2242 | ** | |
2243 | ** <dt>SQLITE_LIMIT_VDBE_OP</dt> | |
2244 | ** <dd>The maximum number of instructions in a virtual machine program | |
2245 | ** used to implement an SQL statement.</dd> | |
2246 | ** | |
2247 | ** <dt>SQLITE_LIMIT_FUNCTION_ARG</dt> | |
2248 | ** <dd>The maximum number of arguments on a function.</dd> | |
2249 | ** | |
2250 | ** <dt>SQLITE_LIMIT_ATTACHED</dt> | |
2251 | ** <dd>The maximum number of attached databases.</dd> | |
2252 | ** | |
2253 | ** <dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt> | |
2254 | ** <dd>The maximum length of the pattern argument to the LIKE or | |
2255 | ** GLOB operators.</dd> | |
2256 | ** | |
2257 | ** <dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt> | |
2258 | ** <dd>The maximum number of variables in an SQL statement that can | |
2259 | ** be bound.</dd> | |
2260 | ** </dl> | |
2261 | */ | |
2262 | #define SQLITE_LIMIT_LENGTH 0 | |
2263 | #define SQLITE_LIMIT_SQL_LENGTH 1 | |
2264 | #define SQLITE_LIMIT_COLUMN 2 | |
2265 | #define SQLITE_LIMIT_EXPR_DEPTH 3 | |
2266 | #define SQLITE_LIMIT_COMPOUND_SELECT 4 | |
2267 | #define SQLITE_LIMIT_VDBE_OP 5 | |
2268 | #define SQLITE_LIMIT_FUNCTION_ARG 6 | |
2269 | #define SQLITE_LIMIT_ATTACHED 7 | |
2270 | #define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8 | |
2271 | #define SQLITE_LIMIT_VARIABLE_NUMBER 9 | |
2272 | ||
2273 | /* | |
2274 | ** CAPI3REF: Compiling An SQL Statement {F13010} | |
2275 | ** | |
2276 | ** To execute an SQL query, it must first be compiled into a byte-code | |
2277 | ** program using one of these routines. | |
2278 | ** | |
2279 | ** The first argument "db" is an [database connection] | |
2280 | ** obtained from a prior call to [sqlite3_open()], [sqlite3_open_v2()] | |
2281 | ** or [sqlite3_open16()]. | |
2282 | ** The second argument "zSql" is the statement to be compiled, encoded | |
2283 | ** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2() | |
2284 | ** interfaces uses UTF-8 and sqlite3_prepare16() and sqlite3_prepare16_v2() | |
2285 | ** use UTF-16. {END} | |
2286 | ** | |
2287 | ** If the nByte argument is less | |
2288 | ** than zero, then zSql is read up to the first zero terminator. | |
2289 | ** If nByte is non-negative, then it is the maximum number of | |
2290 | ** bytes read from zSql. When nByte is non-negative, the | |
2291 | ** zSql string ends at either the first '\000' or '\u0000' character or | |
2292 | ** the nByte-th byte, whichever comes first. If the caller knows | |
2293 | ** that the supplied string is nul-terminated, then there is a small | |
2294 | ** performance advantage to be had by passing an nByte parameter that | |
2295 | ** is equal to the number of bytes in the input string <i>including</i> | |
2296 | ** the nul-terminator bytes.{END} | |
2297 | ** | |
2298 | ** *pzTail is made to point to the first byte past the end of the | |
2299 | ** first SQL statement in zSql. These routines only compiles the first | |
2300 | ** statement in zSql, so *pzTail is left pointing to what remains | |
2301 | ** uncompiled. | |
2302 | ** | |
2303 | ** *ppStmt is left pointing to a compiled [prepared statement] that can be | |
2304 | ** executed using [sqlite3_step()]. Or if there is an error, *ppStmt is | |
2305 | ** set to NULL. If the input text contains no SQL (if the input | |
2306 | ** is and empty string or a comment) then *ppStmt is set to NULL. | |
2307 | ** {U13018} The calling procedure is responsible for deleting the | |
2308 | ** compiled SQL statement | |
2309 | ** using [sqlite3_finalize()] after it has finished with it. | |
2310 | ** | |
2311 | ** On success, [SQLITE_OK] is returned. Otherwise an | |
2312 | ** [error code] is returned. | |
2313 | ** | |
2314 | ** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are | |
2315 | ** recommended for all new programs. The two older interfaces are retained | |
2316 | ** for backwards compatibility, but their use is discouraged. | |
2317 | ** In the "v2" interfaces, the prepared statement | |
2318 | ** that is returned (the [sqlite3_stmt] object) contains a copy of the | |
2319 | ** original SQL text. {END} This causes the [sqlite3_step()] interface to | |
2320 | ** behave a differently in two ways: | |
2321 | ** | |
2322 | ** <ol> | |
2323 | ** <li> | |
2324 | ** If the database schema changes, instead of returning [SQLITE_SCHEMA] as it | |
2325 | ** always used to do, [sqlite3_step()] will automatically recompile the SQL | |
2326 | ** statement and try to run it again. If the schema has changed in | |
2327 | ** a way that makes the statement no longer valid, [sqlite3_step()] will still | |
2328 | ** return [SQLITE_SCHEMA]. But unlike the legacy behavior, | |
2329 | ** [SQLITE_SCHEMA] is now a fatal error. Calling | |
2330 | ** [sqlite3_prepare_v2()] again will not make the | |
2331 | ** error go away. Note: use [sqlite3_errmsg()] to find the text | |
2332 | ** of the parsing error that results in an [SQLITE_SCHEMA] return. {END} | |
2333 | ** </li> | |
2334 | ** | |
2335 | ** <li> | |
2336 | ** When an error occurs, | |
2337 | ** [sqlite3_step()] will return one of the detailed | |
2338 | ** [error codes] or [extended error codes]. | |
2339 | ** The legacy behavior was that [sqlite3_step()] would only return a generic | |
2340 | ** [SQLITE_ERROR] result code and you would have to make a second call to | |
2341 | ** [sqlite3_reset()] in order to find the underlying cause of the problem. | |
2342 | ** With the "v2" prepare interfaces, the underlying reason for the error is | |
2343 | ** returned immediately. | |
2344 | ** </li> | |
2345 | ** </ol> | |
2346 | ** | |
2347 | ** INVARIANTS: | |
2348 | ** | |
2349 | ** {F13011} The [sqlite3_prepare(db,zSql,...)] and | |
2350 | ** [sqlite3_prepare_v2(db,zSql,...)] interfaces interpret the | |
2351 | ** text in their zSql parameter as UTF-8. | |
2352 | ** | |
2353 | ** {F13012} The [sqlite3_prepare16(db,zSql,...)] and | |
2354 | ** [sqlite3_prepare16_v2(db,zSql,...)] interfaces interpret the | |
2355 | ** text in their zSql parameter as UTF-16 in the native byte order. | |
2356 | ** | |
2357 | ** {F13013} If the nByte argument to [sqlite3_prepare_v2(db,zSql,nByte,...)] | |
2358 | ** and its variants is less than zero, then SQL text is | |
2359 | ** read from zSql is read up to the first zero terminator. | |
2360 | ** | |
2361 | ** {F13014} If the nByte argument to [sqlite3_prepare_v2(db,zSql,nByte,...)] | |
2362 | ** and its variants is non-negative, then at most nBytes bytes | |
2363 | ** SQL text is read from zSql. | |
2364 | ** | |
2365 | ** {F13015} In [sqlite3_prepare_v2(db,zSql,N,P,pzTail)] and its variants | |
2366 | ** if the zSql input text contains more than one SQL statement | |
2367 | ** and pzTail is not NULL, then *pzTail is made to point to the | |
2368 | ** first byte past the end of the first SQL statement in zSql. | |
2369 | ** <todo>What does *pzTail point to if there is one statement?</todo> | |
2370 | ** | |
2371 | ** {F13016} A successful call to [sqlite3_prepare_v2(db,zSql,N,ppStmt,...)] | |
2372 | ** or one of its variants writes into *ppStmt a pointer to a new | |
2373 | ** [prepared statement] or a pointer to NULL | |
2374 | ** if zSql contains nothing other than whitespace or comments. | |
2375 | ** | |
2376 | ** {F13019} The [sqlite3_prepare_v2()] interface and its variants return | |
2377 | ** [SQLITE_OK] or an appropriate [error code] upon failure. | |
2378 | ** | |
2379 | ** {F13021} Before [sqlite3_prepare(db,zSql,nByte,ppStmt,pzTail)] or its | |
2380 | ** variants returns an error (any value other than [SQLITE_OK]) | |
2381 | ** it first sets *ppStmt to NULL. | |
2382 | */ | |
2383 | int sqlite3_prepare( | |
2384 | sqlite3 *db, /* Database handle */ | |
2385 | const char *zSql, /* SQL statement, UTF-8 encoded */ | |
2386 | int nByte, /* Maximum length of zSql in bytes. */ | |
2387 | sqlite3_stmt **ppStmt, /* OUT: Statement handle */ | |
2388 | const char **pzTail /* OUT: Pointer to unused portion of zSql */ | |
2389 | ); | |
2390 | int sqlite3_prepare_v2( | |
2391 | sqlite3 *db, /* Database handle */ | |
2392 | const char *zSql, /* SQL statement, UTF-8 encoded */ | |
2393 | int nByte, /* Maximum length of zSql in bytes. */ | |
2394 | sqlite3_stmt **ppStmt, /* OUT: Statement handle */ | |
2395 | const char **pzTail /* OUT: Pointer to unused portion of zSql */ | |
2396 | ); | |
2397 | int sqlite3_prepare16( | |
2398 | sqlite3 *db, /* Database handle */ | |
2399 | const void *zSql, /* SQL statement, UTF-16 encoded */ | |
2400 | int nByte, /* Maximum length of zSql in bytes. */ | |
2401 | sqlite3_stmt **ppStmt, /* OUT: Statement handle */ | |
2402 | const void **pzTail /* OUT: Pointer to unused portion of zSql */ | |
2403 | ); | |
2404 | int sqlite3_prepare16_v2( | |
2405 | sqlite3 *db, /* Database handle */ | |
2406 | const void *zSql, /* SQL statement, UTF-16 encoded */ | |
2407 | int nByte, /* Maximum length of zSql in bytes. */ | |
2408 | sqlite3_stmt **ppStmt, /* OUT: Statement handle */ | |
2409 | const void **pzTail /* OUT: Pointer to unused portion of zSql */ | |
2410 | ); | |
2411 | ||
2412 | /* | |
2413 | ** CAPIREF: Retrieving Statement SQL {F13100} | |
2414 | ** | |
2415 | ** This intereface can be used to retrieve a saved copy of the original | |
2416 | ** SQL text used to create a [prepared statement]. | |
2417 | ** | |
2418 | ** INVARIANTS: | |
2419 | ** | |
2420 | ** {F13101} If the [prepared statement] passed as | |
2421 | ** the an argument to [sqlite3_sql()] was compiled | |
2422 | ** compiled using either [sqlite3_prepare_v2()] or | |
2423 | ** [sqlite3_prepare16_v2()], | |
2424 | ** then [sqlite3_sql()] function returns a pointer to a | |
2425 | ** zero-terminated string containing a UTF-8 rendering | |
2426 | ** of the original SQL statement. | |
2427 | ** | |
2428 | ** {F13102} If the [prepared statement] passed as | |
2429 | ** the an argument to [sqlite3_sql()] was compiled | |
2430 | ** compiled using either [sqlite3_prepare()] or | |
2431 | ** [sqlite3_prepare16()], | |
2432 | ** then [sqlite3_sql()] function returns a NULL pointer. | |
2433 | ** | |
2434 | ** {F13103} The string returned by [sqlite3_sql(S)] is valid until the | |
2435 | ** [prepared statement] S is deleted using [sqlite3_finalize(S)]. | |
2436 | */ | |
2437 | const char *sqlite3_sql(sqlite3_stmt *pStmt); | |
2438 | ||
2439 | /* | |
2440 | ** CAPI3REF: Dynamically Typed Value Object {F15000} | |
2441 | ** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value} | |
2442 | ** | |
2443 | ** SQLite uses the sqlite3_value object to represent all values | |
2444 | ** that can be stored in a database table. | |
2445 | ** SQLite uses dynamic typing for the values it stores. | |
2446 | ** Values stored in sqlite3_value objects can be | |
2447 | ** be integers, floating point values, strings, BLOBs, or NULL. | |
2448 | ** | |
2449 | ** An sqlite3_value object may be either "protected" or "unprotected". | |
2450 | ** Some interfaces require a protected sqlite3_value. Other interfaces | |
2451 | ** will accept either a protected or an unprotected sqlite3_value. | |
2452 | ** Every interface that accepts sqlite3_value arguments specifies | |
2453 | ** whether or not it requires a protected sqlite3_value. | |
2454 | ** | |
2455 | ** The terms "protected" and "unprotected" refer to whether or not | |
2456 | ** a mutex is held. A internal mutex is held for a protected | |
2457 | ** sqlite3_value object but no mutex is held for an unprotected | |
2458 | ** sqlite3_value object. If SQLite is compiled to be single-threaded | |
2459 | ** (with SQLITE_THREADSAFE=0 and with [sqlite3_threadsafe()] returning 0) | |
2460 | ** then there is no distinction between | |
2461 | ** protected and unprotected sqlite3_value objects and they can be | |
2462 | ** used interchangable. However, for maximum code portability it | |
2463 | ** is recommended that applications make the distinction between | |
2464 | ** between protected and unprotected sqlite3_value objects even if | |
2465 | ** they are single threaded. | |
2466 | ** | |
2467 | ** The sqlite3_value objects that are passed as parameters into the | |
2468 | ** implementation of application-defined SQL functions are protected. | |
2469 | ** The sqlite3_value object returned by | |
2470 | ** [sqlite3_column_value()] is unprotected. | |
2471 | ** Unprotected sqlite3_value objects may only be used with | |
2472 | ** [sqlite3_result_value()] and [sqlite3_bind_value()]. All other | |
2473 | ** interfaces that use sqlite3_value require protected sqlite3_value objects. | |
2474 | */ | |
2475 | typedef struct Mem sqlite3_value; | |
2476 | ||
2477 | /* | |
2478 | ** CAPI3REF: SQL Function Context Object {F16001} | |
2479 | ** | |
2480 | ** The context in which an SQL function executes is stored in an | |
2481 | ** sqlite3_context object. A pointer to an sqlite3_context | |
2482 | ** object is always first parameter to application-defined SQL functions. | |
2483 | */ | |
2484 | typedef struct sqlite3_context sqlite3_context; | |
2485 | ||
2486 | /* | |
2487 | ** CAPI3REF: Binding Values To Prepared Statements {F13500} | |
2488 | ** | |
2489 | ** In the SQL strings input to [sqlite3_prepare_v2()] and its | |
2490 | ** variants, literals may be replace by a parameter in one | |
2491 | ** of these forms: | |
2492 | ** | |
2493 | ** <ul> | |
2494 | ** <li> ? | |
2495 | ** <li> ?NNN | |
2496 | ** <li> :VVV | |
2497 | ** <li> @VVV | |
2498 | ** <li> $VVV | |
2499 | ** </ul> | |
2500 | ** | |
2501 | ** In the parameter forms shown above NNN is an integer literal, | |
2502 | ** VVV alpha-numeric parameter name. | |
2503 | ** The values of these parameters (also called "host parameter names" | |
2504 | ** or "SQL parameters") | |
2505 | ** can be set using the sqlite3_bind_*() routines defined here. | |
2506 | ** | |
2507 | ** The first argument to the sqlite3_bind_*() routines always | |
2508 | ** is a pointer to the [sqlite3_stmt] object returned from | |
2509 | ** [sqlite3_prepare_v2()] or its variants. The second | |
2510 | ** argument is the index of the parameter to be set. The | |
2511 | ** first parameter has an index of 1. When the same named | |
2512 | ** parameter is used more than once, second and subsequent | |
2513 | ** occurrences have the same index as the first occurrence. | |
2514 | ** The index for named parameters can be looked up using the | |
2515 | ** [sqlite3_bind_parameter_name()] API if desired. The index | |
2516 | ** for "?NNN" parameters is the value of NNN. | |
2517 | ** The NNN value must be between 1 and the compile-time | |
2518 | ** parameter SQLITE_MAX_VARIABLE_NUMBER (default value: 999). | |
2519 | ** | |
2520 | ** The third argument is the value to bind to the parameter. | |
2521 | ** | |
2522 | ** In those | |
2523 | ** routines that have a fourth argument, its value is the number of bytes | |
2524 | ** in the parameter. To be clear: the value is the number of <u>bytes</u> | |
2525 | ** in the value, not the number of characters. | |
2526 | ** If the fourth parameter is negative, the length of the string is | |
2527 | ** number of bytes up to the first zero terminator. | |
2528 | ** | |
2529 | ** The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and | |
2530 | ** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or | |
2531 | ** string after SQLite has finished with it. If the fifth argument is | |
2532 | ** the special value [SQLITE_STATIC], then SQLite assumes that the | |
2533 | ** information is in static, unmanaged space and does not need to be freed. | |
2534 | ** If the fifth argument has the value [SQLITE_TRANSIENT], then | |
2535 | ** SQLite makes its own private copy of the data immediately, before | |
2536 | ** the sqlite3_bind_*() routine returns. | |
2537 | ** | |
2538 | ** The sqlite3_bind_zeroblob() routine binds a BLOB of length N that | |
2539 | ** is filled with zeros. A zeroblob uses a fixed amount of memory | |
2540 | ** (just an integer to hold it size) while it is being processed. | |
2541 | ** Zeroblobs are intended to serve as place-holders for BLOBs whose | |
2542 | ** content is later written using | |
2543 | ** [sqlite3_blob_open | increment BLOB I/O] routines. A negative | |
2544 | ** value for the zeroblob results in a zero-length BLOB. | |
2545 | ** | |
2546 | ** The sqlite3_bind_*() routines must be called after | |
2547 | ** [sqlite3_prepare_v2()] (and its variants) or [sqlite3_reset()] and | |
2548 | ** before [sqlite3_step()]. | |
2549 | ** Bindings are not cleared by the [sqlite3_reset()] routine. | |
2550 | ** Unbound parameters are interpreted as NULL. | |
2551 | ** | |
2552 | ** These routines return [SQLITE_OK] on success or an error code if | |
2553 | ** anything goes wrong. [SQLITE_RANGE] is returned if the parameter | |
2554 | ** index is out of range. [SQLITE_NOMEM] is returned if malloc fails. | |
2555 | ** [SQLITE_MISUSE] might be returned if these routines are called on a | |
2556 | ** virtual machine that is the wrong state or which has already been finalized. | |
2557 | ** Detection of misuse is unreliable. Applications should not depend | |
2558 | ** on SQLITE_MISUSE returns. SQLITE_MISUSE is intended to indicate a | |
2559 | ** a logic error in the application. Future versions of SQLite might | |
2560 | ** panic rather than return SQLITE_MISUSE. | |
2561 | ** | |
2562 | ** See also: [sqlite3_bind_parameter_count()], | |
2563 | ** [sqlite3_bind_parameter_name()], and | |
2564 | ** [sqlite3_bind_parameter_index()]. | |
2565 | ** | |
2566 | ** INVARIANTS: | |
2567 | ** | |
2568 | ** {F13506} The [sqlite3_prepare | SQL statement compiler] recognizes | |
2569 | ** tokens of the forms "?", "?NNN", "$VVV", ":VVV", and "@VVV" | |
2570 | ** as SQL parameters, where NNN is any sequence of one or more | |
2571 | ** digits and where VVV is any sequence of one or more | |
2572 | ** alphanumeric characters or "::" optionally followed by | |
2573 | ** a string containing no spaces and contained within parentheses. | |
2574 | ** | |
2575 | ** {F13509} The initial value of an SQL parameter is NULL. | |
2576 | ** | |
2577 | ** {F13512} The index of an "?" SQL parameter is one larger than the | |
2578 | ** largest index of SQL parameter to the left, or 1 if | |
2579 | ** the "?" is the leftmost SQL parameter. | |
2580 | ** | |
2581 | ** {F13515} The index of an "?NNN" SQL parameter is the integer NNN. | |
2582 | ** | |
2583 | ** {F13518} The index of an ":VVV", "$VVV", or "@VVV" SQL parameter is | |
2584 | ** the same as the index of leftmost occurances of the same | |
2585 | ** parameter, or one more than the largest index over all | |
2586 | ** parameters to the left if this is the first occurrance | |
2587 | ** of this parameter, or 1 if this is the leftmost parameter. | |
2588 | ** | |
2589 | ** {F13521} The [sqlite3_prepare | SQL statement compiler] fail with | |
2590 | ** an [SQLITE_RANGE] error if the index of an SQL parameter | |
2591 | ** is less than 1 or greater than SQLITE_MAX_VARIABLE_NUMBER. | |
2592 | ** | |
2593 | ** {F13524} Calls to [sqlite3_bind_text | sqlite3_bind(S,N,V,...)] | |
2594 | ** associate the value V with all SQL parameters having an | |
2595 | ** index of N in the [prepared statement] S. | |
2596 | ** | |
2597 | ** {F13527} Calls to [sqlite3_bind_text | sqlite3_bind(S,N,...)] | |
2598 | ** override prior calls with the same values of S and N. | |
2599 | ** | |
2600 | ** {F13530} Bindings established by [sqlite3_bind_text | sqlite3_bind(S,...)] | |
2601 | ** persist across calls to [sqlite3_reset(S)]. | |
2602 | ** | |
2603 | ** {F13533} In calls to [sqlite3_bind_blob(S,N,V,L,D)], | |
2604 | ** [sqlite3_bind_text(S,N,V,L,D)], or | |
2605 | ** [sqlite3_bind_text16(S,N,V,L,D)] SQLite binds the first L | |
2606 | ** bytes of the blob or string pointed to by V, when L | |
2607 | ** is non-negative. | |
2608 | ** | |
2609 | ** {F13536} In calls to [sqlite3_bind_text(S,N,V,L,D)] or | |
2610 | ** [sqlite3_bind_text16(S,N,V,L,D)] SQLite binds characters | |
2611 | ** from V through the first zero character when L is negative. | |
2612 | ** | |
2613 | ** {F13539} In calls to [sqlite3_bind_blob(S,N,V,L,D)], | |
2614 | ** [sqlite3_bind_text(S,N,V,L,D)], or | |
2615 | ** [sqlite3_bind_text16(S,N,V,L,D)] when D is the special | |
2616 | ** constant [SQLITE_STATIC], SQLite assumes that the value V | |
2617 | ** is held in static unmanaged space that will not change | |
2618 | ** during the lifetime of the binding. | |
2619 | ** | |
2620 | ** {F13542} In calls to [sqlite3_bind_blob(S,N,V,L,D)], | |
2621 | ** [sqlite3_bind_text(S,N,V,L,D)], or | |
2622 | ** [sqlite3_bind_text16(S,N,V,L,D)] when D is the special | |
2623 | ** constant [SQLITE_TRANSIENT], the routine makes a | |
2624 | ** private copy of V value before it returns. | |
2625 | ** | |
2626 | ** {F13545} In calls to [sqlite3_bind_blob(S,N,V,L,D)], | |
2627 | ** [sqlite3_bind_text(S,N,V,L,D)], or | |
2628 | ** [sqlite3_bind_text16(S,N,V,L,D)] when D is a pointer to | |
2629 | ** a function, SQLite invokes that function to destroy the | |
2630 | ** V value after it has finished using the V value. | |
2631 | ** | |
2632 | ** {F13548} In calls to [sqlite3_bind_zeroblob(S,N,V,L)] the value bound | |
2633 | ** is a blob of L bytes, or a zero-length blob if L is negative. | |
2634 | ** | |
2635 | ** {F13551} In calls to [sqlite3_bind_value(S,N,V)] the V argument may | |
2636 | ** be either a [protected sqlite3_value] object or an | |
2637 | ** [unprotected sqlite3_value] object. | |
2638 | */ | |
2639 | int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*)); | |
2640 | int sqlite3_bind_double(sqlite3_stmt*, int, double); | |
2641 | int sqlite3_bind_int(sqlite3_stmt*, int, int); | |
2642 | int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64); | |
2643 | int sqlite3_bind_null(sqlite3_stmt*, int); | |
2644 | int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*)); | |
2645 | int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*)); | |
2646 | int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*); | |
2647 | int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n); | |
2648 | ||
2649 | /* | |
2650 | ** CAPI3REF: Number Of SQL Parameters {F13600} | |
2651 | ** | |
2652 | ** This routine can be used to find the number of SQL parameters | |
2653 | ** in a prepared statement. SQL parameters are tokens of the | |
2654 | ** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as | |
2655 | ** place-holders for values that are [sqlite3_bind_blob | bound] | |
2656 | ** to the parameters at a later time. | |
2657 | ** | |
2658 | ** This routine actually returns the index of the largest parameter. | |
2659 | ** For all forms except ?NNN, this will correspond to the number of | |
2660 | ** unique parameters. If parameters of the ?NNN are used, there may | |
2661 | ** be gaps in the list. | |
2662 | ** | |
2663 | ** See also: [sqlite3_bind_blob|sqlite3_bind()], | |
2664 | ** [sqlite3_bind_parameter_name()], and | |
2665 | ** [sqlite3_bind_parameter_index()]. | |
2666 | ** | |
2667 | ** INVARIANTS: | |
2668 | ** | |
2669 | ** {F13601} The [sqlite3_bind_parameter_count(S)] interface returns | |
2670 | ** the largest index of all SQL parameters in the | |
2671 | ** [prepared statement] S, or 0 if S | |
2672 | ** contains no SQL parameters. | |
2673 | */ | |
2674 | int sqlite3_bind_parameter_count(sqlite3_stmt*); | |
2675 | ||
2676 | /* | |
2677 | ** CAPI3REF: Name Of A Host Parameter {F13620} | |
2678 | ** | |
2679 | ** This routine returns a pointer to the name of the n-th | |
2680 | ** SQL parameter in a [prepared statement]. | |
2681 | ** SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA" | |
2682 | ** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA" | |
2683 | ** respectively. | |
2684 | ** In other words, the initial ":" or "$" or "@" or "?" | |
2685 | ** is included as part of the name. | |
2686 | ** Parameters of the form "?" without a following integer have no name. | |
2687 | ** | |
2688 | ** The first host parameter has an index of 1, not 0. | |
2689 | ** | |
2690 | ** If the value n is out of range or if the n-th parameter is | |
2691 | ** nameless, then NULL is returned. The returned string is | |
2692 | ** always in the UTF-8 encoding even if the named parameter was | |
2693 | ** originally specified as UTF-16 in [sqlite3_prepare16()] or | |
2694 | ** [sqlite3_prepare16_v2()]. | |
2695 | ** | |
2696 | ** See also: [sqlite3_bind_blob|sqlite3_bind()], | |
2697 | ** [sqlite3_bind_parameter_count()], and | |
2698 | ** [sqlite3_bind_parameter_index()]. | |
2699 | ** | |
2700 | ** INVARIANTS: | |
2701 | ** | |
2702 | ** {F13621} The [sqlite3_bind_parameter_name(S,N)] interface returns | |
2703 | ** a UTF-8 rendering of the name of the SQL parameter in | |
2704 | ** [prepared statement] S having index N, or | |
2705 | ** NULL if there is no SQL parameter with index N or if the | |
2706 | ** parameter with index N is an anonymous parameter "?". | |
2707 | */ | |
2708 | const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int); | |
2709 | ||
2710 | /* | |
2711 | ** CAPI3REF: Index Of A Parameter With A Given Name {F13640} | |
2712 | ** | |
2713 | ** Return the index of an SQL parameter given its name. The | |
2714 | ** index value returned is suitable for use as the second | |
2715 | ** parameter to [sqlite3_bind_blob|sqlite3_bind()]. A zero | |
2716 | ** is returned if no matching parameter is found. The parameter | |
2717 | ** name must be given in UTF-8 even if the original statement | |
2718 | ** was prepared from UTF-16 text using [sqlite3_prepare16_v2()]. | |
2719 | ** | |
2720 | ** See also: [sqlite3_bind_blob|sqlite3_bind()], | |
2721 | ** [sqlite3_bind_parameter_count()], and | |
2722 | ** [sqlite3_bind_parameter_index()]. | |
2723 | ** | |
2724 | ** INVARIANTS: | |
2725 | ** | |
2726 | ** {F13641} The [sqlite3_bind_parameter_index(S,N)] interface returns | |
2727 | ** the index of SQL parameter in [prepared statement] | |
2728 | ** S whose name matches the UTF-8 string N, or 0 if there is | |
2729 | ** no match. | |
2730 | */ | |
2731 | int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName); | |
2732 | ||
2733 | /* | |
2734 | ** CAPI3REF: Reset All Bindings On A Prepared Statement {F13660} | |
2735 | ** | |
2736 | ** Contrary to the intuition of many, [sqlite3_reset()] does not | |
2737 | ** reset the [sqlite3_bind_blob | bindings] on a | |
2738 | ** [prepared statement]. Use this routine to | |
2739 | ** reset all host parameters to NULL. | |
2740 | ** | |
2741 | ** INVARIANTS: | |
2742 | ** | |
2743 | ** {F13661} The [sqlite3_clear_bindings(S)] interface resets all | |
2744 | ** SQL parameter bindings in [prepared statement] S | |
2745 | ** back to NULL. | |
2746 | */ | |
2747 | int sqlite3_clear_bindings(sqlite3_stmt*); | |
2748 | ||
2749 | /* | |
2750 | ** CAPI3REF: Number Of Columns In A Result Set {F13710} | |
2751 | ** | |
2752 | ** Return the number of columns in the result set returned by the | |
2753 | ** [prepared statement]. This routine returns 0 | |
2754 | ** if pStmt is an SQL statement that does not return data (for | |
2755 | ** example an UPDATE). | |
2756 | ** | |
2757 | ** INVARIANTS: | |
2758 | ** | |
2759 | ** {F13711} The [sqlite3_column_count(S)] interface returns the number of | |
2760 | ** columns in the result set generated by the | |
2761 | ** [prepared statement] S, or 0 if S does not generate | |
2762 | ** a result set. | |
2763 | */ | |
2764 | int sqlite3_column_count(sqlite3_stmt *pStmt); | |
2765 | ||
2766 | /* | |
2767 | ** CAPI3REF: Column Names In A Result Set {F13720} | |
2768 | ** | |
2769 | ** These routines return the name assigned to a particular column | |
2770 | ** in the result set of a SELECT statement. The sqlite3_column_name() | |
2771 | ** interface returns a pointer to a zero-terminated UTF8 string | |
2772 | ** and sqlite3_column_name16() returns a pointer to a zero-terminated | |
2773 | ** UTF16 string. The first parameter is the | |
2774 | ** [prepared statement] that implements the SELECT statement. | |
2775 | ** The second parameter is the column number. The left-most column is | |
2776 | ** number 0. | |
2777 | ** | |
2778 | ** The returned string pointer is valid until either the | |
2779 | ** [prepared statement] is destroyed by [sqlite3_finalize()] | |
2780 | ** or until the next call sqlite3_column_name() or sqlite3_column_name16() | |
2781 | ** on the same column. | |
2782 | ** | |
2783 | ** If sqlite3_malloc() fails during the processing of either routine | |
2784 | ** (for example during a conversion from UTF-8 to UTF-16) then a | |
2785 | ** NULL pointer is returned. | |
2786 | ** | |
2787 | ** The name of a result column is the value of the "AS" clause for | |
2788 | ** that column, if there is an AS clause. If there is no AS clause | |
2789 | ** then the name of the column is unspecified and may change from | |
2790 | ** one release of SQLite to the next. | |
2791 | ** | |
2792 | ** INVARIANTS: | |
2793 | ** | |
2794 | ** {F13721} A successful invocation of the [sqlite3_column_name(S,N)] | |
2795 | ** interface returns the name | |
2796 | ** of the Nth column (where 0 is the left-most column) for the | |
2797 | ** result set of [prepared statement] S as a | |
2798 | ** zero-terminated UTF-8 string. | |
2799 | ** | |
2800 | ** {F13723} A successful invocation of the [sqlite3_column_name16(S,N)] | |
2801 | ** interface returns the name | |
2802 | ** of the Nth column (where 0 is the left-most column) for the | |
2803 | ** result set of [prepared statement] S as a | |
2804 | ** zero-terminated UTF-16 string in the native byte order. | |
2805 | ** | |
2806 | ** {F13724} The [sqlite3_column_name()] and [sqlite3_column_name16()] | |
2807 | ** interfaces return a NULL pointer if they are unable to | |
2808 | ** allocate memory memory to hold there normal return strings. | |
2809 | ** | |
2810 | ** {F13725} If the N parameter to [sqlite3_column_name(S,N)] or | |
2811 | ** [sqlite3_column_name16(S,N)] is out of range, then the | |
2812 | ** interfaces returns a NULL pointer. | |
2813 | ** | |
2814 | ** {F13726} The strings returned by [sqlite3_column_name(S,N)] and | |
2815 | ** [sqlite3_column_name16(S,N)] are valid until the next | |
2816 | ** call to either routine with the same S and N parameters | |
2817 | ** or until [sqlite3_finalize(S)] is called. | |
2818 | ** | |
2819 | ** {F13727} When a result column of a [SELECT] statement contains | |
2820 | ** an AS clause, the name of that column is the indentifier | |
2821 | ** to the right of the AS keyword. | |
2822 | */ | |
2823 | const char *sqlite3_column_name(sqlite3_stmt*, int N); | |
2824 | const void *sqlite3_column_name16(sqlite3_stmt*, int N); | |
2825 | ||
2826 | /* | |
2827 | ** CAPI3REF: Source Of Data In A Query Result {F13740} | |
2828 | ** | |
2829 | ** These routines provide a means to determine what column of what | |
2830 | ** table in which database a result of a SELECT statement comes from. | |
2831 | ** The name of the database or table or column can be returned as | |
2832 | ** either a UTF8 or UTF16 string. The _database_ routines return | |
2833 | ** the database name, the _table_ routines return the table name, and | |
2834 | ** the origin_ routines return the column name. | |
2835 | ** The returned string is valid until | |
2836 | ** the [prepared statement] is destroyed using | |
2837 | ** [sqlite3_finalize()] or until the same information is requested | |
2838 | ** again in a different encoding. | |
2839 | ** | |
2840 | ** The names returned are the original un-aliased names of the | |
2841 | ** database, table, and column. | |
2842 | ** | |
2843 | ** The first argument to the following calls is a [prepared statement]. | |
2844 | ** These functions return information about the Nth column returned by | |
2845 | ** the statement, where N is the second function argument. | |
2846 | ** | |
2847 | ** If the Nth column returned by the statement is an expression | |
2848 | ** or subquery and is not a column value, then all of these functions | |
2849 | ** return NULL. These routine might also return NULL if a memory | |
2850 | ** allocation error occurs. Otherwise, they return the | |
2851 | ** name of the attached database, table and column that query result | |
2852 | ** column was extracted from. | |
2853 | ** | |
2854 | ** As with all other SQLite APIs, those postfixed with "16" return | |
2855 | ** UTF-16 encoded strings, the other functions return UTF-8. {END} | |
2856 | ** | |
2857 | ** These APIs are only available if the library was compiled with the | |
2858 | ** SQLITE_ENABLE_COLUMN_METADATA preprocessor symbol defined. | |
2859 | ** | |
2860 | ** {U13751} | |
2861 | ** If two or more threads call one or more of these routines against the same | |
2862 | ** prepared statement and column at the same time then the results are | |
2863 | ** undefined. | |
2864 | ** | |
2865 | ** INVARIANTS: | |
2866 | ** | |
2867 | ** {F13741} The [sqlite3_column_database_name(S,N)] interface returns either | |
2868 | ** the UTF-8 zero-terminated name of the database from which the | |
2869 | ** Nth result column of [prepared statement] S | |
2870 | ** is extracted, or NULL if the the Nth column of S is a | |
2871 | ** general expression or if unable to allocate memory | |
2872 | ** to store the name. | |
2873 | ** | |
2874 | ** {F13742} The [sqlite3_column_database_name16(S,N)] interface returns either | |
2875 | ** the UTF-16 native byte order | |
2876 | ** zero-terminated name of the database from which the | |
2877 | ** Nth result column of [prepared statement] S | |
2878 | ** is extracted, or NULL if the the Nth column of S is a | |
2879 | ** general expression or if unable to allocate memory | |
2880 | ** to store the name. | |
2881 | ** | |
2882 | ** {F13743} The [sqlite3_column_table_name(S,N)] interface returns either | |
2883 | ** the UTF-8 zero-terminated name of the table from which the | |
2884 | ** Nth result column of [prepared statement] S | |
2885 | ** is extracted, or NULL if the the Nth column of S is a | |
2886 | ** general expression or if unable to allocate memory | |
2887 | ** to store the name. | |
2888 | ** | |
2889 | ** {F13744} The [sqlite3_column_table_name16(S,N)] interface returns either | |
2890 | ** the UTF-16 native byte order | |
2891 | ** zero-terminated name of the table from which the | |
2892 | ** Nth result column of [prepared statement] S | |
2893 | ** is extracted, or NULL if the the Nth column of S is a | |
2894 | ** general expression or if unable to allocate memory | |
2895 | ** to store the name. | |
2896 | ** | |
2897 | ** {F13745} The [sqlite3_column_origin_name(S,N)] interface returns either | |
2898 | ** the UTF-8 zero-terminated name of the table column from which the | |
2899 | ** Nth result column of [prepared statement] S | |
2900 | ** is extracted, or NULL if the the Nth column of S is a | |
2901 | ** general expression or if unable to allocate memory | |
2902 | ** to store the name. | |
2903 | ** | |
2904 | ** {F13746} The [sqlite3_column_origin_name16(S,N)] interface returns either | |
2905 | ** the UTF-16 native byte order | |
2906 | ** zero-terminated name of the table column from which the | |
2907 | ** Nth result column of [prepared statement] S | |
2908 | ** is extracted, or NULL if the the Nth column of S is a | |
2909 | ** general expression or if unable to allocate memory | |
2910 | ** to store the name. | |
2911 | ** | |
2912 | ** {F13748} The return values from | |
2913 | ** [sqlite3_column_database_name|column metadata interfaces] | |
2914 | ** are valid | |
2915 | ** for the lifetime of the [prepared statement] | |
2916 | ** or until the encoding is changed by another metadata | |
2917 | ** interface call for the same prepared statement and column. | |
2918 | ** | |
2919 | ** LIMITATIONS: | |
2920 | ** | |
2921 | ** {U13751} If two or more threads call one or more | |
2922 | ** [sqlite3_column_database_name|column metadata interfaces] | |
2923 | ** the same [prepared statement] and result column | |
2924 | ** at the same time then the results are undefined. | |
2925 | */ | |
2926 | const char *sqlite3_column_database_name(sqlite3_stmt*,int); | |
2927 | const void *sqlite3_column_database_name16(sqlite3_stmt*,int); | |
2928 | const char *sqlite3_column_table_name(sqlite3_stmt*,int); | |
2929 | const void *sqlite3_column_table_name16(sqlite3_stmt*,int); | |
2930 | const char *sqlite3_column_origin_name(sqlite3_stmt*,int); | |
2931 | const void *sqlite3_column_origin_name16(sqlite3_stmt*,int); | |
2932 | ||
2933 | /* | |
2934 | ** CAPI3REF: Declared Datatype Of A Query Result {F13760} | |
2935 | ** | |
2936 | ** The first parameter is a [prepared statement]. | |
2937 | ** If this statement is a SELECT statement and the Nth column of the | |
2938 | ** returned result set of that SELECT is a table column (not an | |
2939 | ** expression or subquery) then the declared type of the table | |
2940 | ** column is returned. If the Nth column of the result set is an | |
2941 | ** expression or subquery, then a NULL pointer is returned. | |
2942 | ** The returned string is always UTF-8 encoded. {END} | |
2943 | ** For example, in the database schema: | |
2944 | ** | |
2945 | ** CREATE TABLE t1(c1 VARIANT); | |
2946 | ** | |
2947 | ** And the following statement compiled: | |
2948 | ** | |
2949 | ** SELECT c1 + 1, c1 FROM t1; | |
2950 | ** | |
2951 | ** Then this routine would return the string "VARIANT" for the second | |
2952 | ** result column (i==1), and a NULL pointer for the first result column | |
2953 | ** (i==0). | |
2954 | ** | |
2955 | ** SQLite uses dynamic run-time typing. So just because a column | |
2956 | ** is declared to contain a particular type does not mean that the | |
2957 | ** data stored in that column is of the declared type. SQLite is | |
2958 | ** strongly typed, but the typing is dynamic not static. Type | |
2959 | ** is associated with individual values, not with the containers | |
2960 | ** used to hold those values. | |
2961 | ** | |
2962 | ** INVARIANTS: | |
2963 | ** | |
2964 | ** {F13761} A successful call to [sqlite3_column_decltype(S,N)] | |
2965 | ** returns a zero-terminated UTF-8 string containing the | |
2966 | ** the declared datatype of the table column that appears | |
2967 | ** as the Nth column (numbered from 0) of the result set to the | |
2968 | ** [prepared statement] S. | |
2969 | ** | |
2970 | ** {F13762} A successful call to [sqlite3_column_decltype16(S,N)] | |
2971 | ** returns a zero-terminated UTF-16 native byte order string | |
2972 | ** containing the declared datatype of the table column that appears | |
2973 | ** as the Nth column (numbered from 0) of the result set to the | |
2974 | ** [prepared statement] S. | |
2975 | ** | |
2976 | ** {F13763} If N is less than 0 or N is greater than or equal to | |
2977 | ** the number of columns in [prepared statement] S | |
2978 | ** or if the Nth column of S is an expression or subquery rather | |
2979 | ** than a table column or if a memory allocation failure | |
2980 | ** occurs during encoding conversions, then | |
2981 | ** calls to [sqlite3_column_decltype(S,N)] or | |
2982 | ** [sqlite3_column_decltype16(S,N)] return NULL. | |
2983 | */ | |
2984 | const char *sqlite3_column_decltype(sqlite3_stmt*,int); | |
2985 | const void *sqlite3_column_decltype16(sqlite3_stmt*,int); | |
2986 | ||
2987 | /* | |
2988 | ** CAPI3REF: Evaluate An SQL Statement {F13200} | |
2989 | ** | |
2990 | ** After an [prepared statement] has been prepared with a call | |
2991 | ** to either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or to one of | |
2992 | ** the legacy interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], | |
2993 | ** then this function must be called one or more times to evaluate the | |
2994 | ** statement. | |
2995 | ** | |
2996 | ** The details of the behavior of this sqlite3_step() interface depend | |
2997 | ** on whether the statement was prepared using the newer "v2" interface | |
2998 | ** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy | |
2999 | ** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the | |
3000 | ** new "v2" interface is recommended for new applications but the legacy | |
3001 | ** interface will continue to be supported. | |
3002 | ** | |
3003 | ** In the legacy interface, the return value will be either [SQLITE_BUSY], | |
3004 | ** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE]. | |
3005 | ** With the "v2" interface, any of the other [SQLITE_OK | result code] | |
3006 | ** or [SQLITE_IOERR_READ | extended result code] might be returned as | |
3007 | ** well. | |
3008 | ** | |
3009 | ** [SQLITE_BUSY] means that the database engine was unable to acquire the | |
3010 | ** database locks it needs to do its job. If the statement is a COMMIT | |
3011 | ** or occurs outside of an explicit transaction, then you can retry the | |
3012 | ** statement. If the statement is not a COMMIT and occurs within a | |
3013 | ** explicit transaction then you should rollback the transaction before | |
3014 | ** continuing. | |
3015 | ** | |
3016 | ** [SQLITE_DONE] means that the statement has finished executing | |
3017 | ** successfully. sqlite3_step() should not be called again on this virtual | |
3018 | ** machine without first calling [sqlite3_reset()] to reset the virtual | |
3019 | ** machine back to its initial state. | |
3020 | ** | |
3021 | ** If the SQL statement being executed returns any data, then | |
3022 | ** [SQLITE_ROW] is returned each time a new row of data is ready | |
3023 | ** for processing by the caller. The values may be accessed using | |
3024 | ** the [sqlite3_column_int | column access functions]. | |
3025 | ** sqlite3_step() is called again to retrieve the next row of data. | |
3026 | ** | |
3027 | ** [SQLITE_ERROR] means that a run-time error (such as a constraint | |
3028 | ** violation) has occurred. sqlite3_step() should not be called again on | |
3029 | ** the VM. More information may be found by calling [sqlite3_errmsg()]. | |
3030 | ** With the legacy interface, a more specific error code (example: | |
3031 | ** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth) | |
3032 | ** can be obtained by calling [sqlite3_reset()] on the | |
3033 | ** [prepared statement]. In the "v2" interface, | |
3034 | ** the more specific error code is returned directly by sqlite3_step(). | |
3035 | ** | |
3036 | ** [SQLITE_MISUSE] means that the this routine was called inappropriately. | |
3037 | ** Perhaps it was called on a [prepared statement] that has | |
3038 | ** already been [sqlite3_finalize | finalized] or on one that had | |
3039 | ** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could | |
3040 | ** be the case that the same database connection is being used by two or | |
3041 | ** more threads at the same moment in time. | |
3042 | ** | |
3043 | ** <b>Goofy Interface Alert:</b> | |
3044 | ** In the legacy interface, | |
3045 | ** the sqlite3_step() API always returns a generic error code, | |
3046 | ** [SQLITE_ERROR], following any error other than [SQLITE_BUSY] | |
3047 | ** and [SQLITE_MISUSE]. You must call [sqlite3_reset()] or | |
3048 | ** [sqlite3_finalize()] in order to find one of the specific | |
3049 | ** [error codes] that better describes the error. | |
3050 | ** We admit that this is a goofy design. The problem has been fixed | |
3051 | ** with the "v2" interface. If you prepare all of your SQL statements | |
3052 | ** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead | |
3053 | ** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()], then the | |
3054 | ** more specific [error codes] are returned directly | |
3055 | ** by sqlite3_step(). The use of the "v2" interface is recommended. | |
3056 | ** | |
3057 | ** INVARIANTS: | |
3058 | ** | |
3059 | ** {F13202} If [prepared statement] S is ready to be | |
3060 | ** run, then [sqlite3_step(S)] advances that prepared statement | |
3061 | ** until to completion or until it is ready to return another | |
3062 | ** row of the result set or an interrupt or run-time error occurs. | |
3063 | ** | |
3064 | ** {F15304} When a call to [sqlite3_step(S)] causes the | |
3065 | ** [prepared statement] S to run to completion, | |
3066 | ** the function returns [SQLITE_DONE]. | |
3067 | ** | |
3068 | ** {F15306} When a call to [sqlite3_step(S)] stops because it is ready | |
3069 | ** to return another row of the result set, it returns | |
3070 | ** [SQLITE_ROW]. | |
3071 | ** | |
3072 | ** {F15308} If a call to [sqlite3_step(S)] encounters an | |
3073 | ** [sqlite3_interrupt|interrupt] or a run-time error, | |
3074 | ** it returns an appropraite error code that is not one of | |
3075 | ** [SQLITE_OK], [SQLITE_ROW], or [SQLITE_DONE]. | |
3076 | ** | |
3077 | ** {F15310} If an [sqlite3_interrupt|interrupt] or run-time error | |
3078 | ** occurs during a call to [sqlite3_step(S)] | |
3079 | ** for a [prepared statement] S created using | |
3080 | ** legacy interfaces [sqlite3_prepare()] or | |
3081 | ** [sqlite3_prepare16()] then the function returns either | |
3082 | ** [SQLITE_ERROR], [SQLITE_BUSY], or [SQLITE_MISUSE]. | |
3083 | */ | |
3084 | int sqlite3_step(sqlite3_stmt*); | |
3085 | ||
3086 | /* | |
3087 | ** CAPI3REF: Number of columns in a result set {F13770} | |
3088 | ** | |
3089 | ** Return the number of values in the current row of the result set. | |
3090 | ** | |
3091 | ** INVARIANTS: | |
3092 | ** | |
3093 | ** {F13771} After a call to [sqlite3_step(S)] that returns | |
3094 | ** [SQLITE_ROW], the [sqlite3_data_count(S)] routine | |
3095 | ** will return the same value as the | |
3096 | ** [sqlite3_column_count(S)] function. | |
3097 | ** | |
3098 | ** {F13772} After [sqlite3_step(S)] has returned any value other than | |
3099 | ** [SQLITE_ROW] or before [sqlite3_step(S)] has been | |
3100 | ** called on the [prepared statement] for | |
3101 | ** the first time since it was [sqlite3_prepare|prepared] | |
3102 | ** or [sqlite3_reset|reset], the [sqlite3_data_count(S)] | |
3103 | ** routine returns zero. | |
3104 | */ | |
3105 | int sqlite3_data_count(sqlite3_stmt *pStmt); | |
3106 | ||
3107 | /* | |
3108 | ** CAPI3REF: Fundamental Datatypes {F10265} | |
3109 | ** KEYWORDS: SQLITE_TEXT | |
3110 | ** | |
3111 | ** {F10266}Every value in SQLite has one of five fundamental datatypes: | |
3112 | ** | |
3113 | ** <ul> | |
3114 | ** <li> 64-bit signed integer | |
3115 | ** <li> 64-bit IEEE floating point number | |
3116 | ** <li> string | |
3117 | ** <li> BLOB | |
3118 | ** <li> NULL | |
3119 | ** </ul> {END} | |
3120 | ** | |
3121 | ** These constants are codes for each of those types. | |
3122 | ** | |
3123 | ** Note that the SQLITE_TEXT constant was also used in SQLite version 2 | |
3124 | ** for a completely different meaning. Software that links against both | |
3125 | ** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT not | |
3126 | ** SQLITE_TEXT. | |
3127 | */ | |
3128 | #define SQLITE_INTEGER 1 | |
3129 | #define SQLITE_FLOAT 2 | |
3130 | #define SQLITE_BLOB 4 | |
3131 | #define SQLITE_NULL 5 | |
3132 | #ifdef SQLITE_TEXT | |
3133 | # undef SQLITE_TEXT | |
3134 | #else | |
3135 | # define SQLITE_TEXT 3 | |
3136 | #endif | |
3137 | #define SQLITE3_TEXT 3 | |
3138 | ||
3139 | /* | |
3140 | ** CAPI3REF: Results Values From A Query {F13800} | |
3141 | ** | |
3142 | ** These routines form the "result set query" interface. | |
3143 | ** | |
3144 | ** These routines return information about | |
3145 | ** a single column of the current result row of a query. In every | |
3146 | ** case the first argument is a pointer to the | |
3147 | ** [prepared statement] that is being | |
3148 | ** evaluated (the [sqlite3_stmt*] that was returned from | |
3149 | ** [sqlite3_prepare_v2()] or one of its variants) and | |
3150 | ** the second argument is the index of the column for which information | |
3151 | ** should be returned. The left-most column of the result set | |
3152 | ** has an index of 0. | |
3153 | ** | |
3154 | ** If the SQL statement is not currently point to a valid row, or if the | |
3155 | ** the column index is out of range, the result is undefined. | |
3156 | ** These routines may only be called when the most recent call to | |
3157 | ** [sqlite3_step()] has returned [SQLITE_ROW] and neither | |
3158 | ** [sqlite3_reset()] nor [sqlite3_finalize()] has been call subsequently. | |
3159 | ** If any of these routines are called after [sqlite3_reset()] or | |
3160 | ** [sqlite3_finalize()] or after [sqlite3_step()] has returned | |
3161 | ** something other than [SQLITE_ROW], the results are undefined. | |
3162 | ** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()] | |
3163 | ** are called from a different thread while any of these routines | |
3164 | ** are pending, then the results are undefined. | |
3165 | ** | |
3166 | ** The sqlite3_column_type() routine returns | |
3167 | ** [SQLITE_INTEGER | datatype code] for the initial data type | |
3168 | ** of the result column. The returned value is one of [SQLITE_INTEGER], | |
3169 | ** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value | |
3170 | ** returned by sqlite3_column_type() is only meaningful if no type | |
3171 | ** conversions have occurred as described below. After a type conversion, | |
3172 | ** the value returned by sqlite3_column_type() is undefined. Future | |
3173 | ** versions of SQLite may change the behavior of sqlite3_column_type() | |
3174 | ** following a type conversion. | |
3175 | ** | |
3176 | ** If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes() | |
3177 | ** routine returns the number of bytes in that BLOB or string. | |
3178 | ** If the result is a UTF-16 string, then sqlite3_column_bytes() converts | |
3179 | ** the string to UTF-8 and then returns the number of bytes. | |
3180 | ** If the result is a numeric value then sqlite3_column_bytes() uses | |
3181 | ** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns | |
3182 | ** the number of bytes in that string. | |
3183 | ** The value returned does not include the zero terminator at the end | |
3184 | ** of the string. For clarity: the value returned is the number of | |
3185 | ** bytes in the string, not the number of characters. | |
3186 | ** | |
3187 | ** Strings returned by sqlite3_column_text() and sqlite3_column_text16(), | |
3188 | ** even empty strings, are always zero terminated. The return | |
3189 | ** value from sqlite3_column_blob() for a zero-length blob is an arbitrary | |
3190 | ** pointer, possibly even a NULL pointer. | |
3191 | ** | |
3192 | ** The sqlite3_column_bytes16() routine is similar to sqlite3_column_bytes() | |
3193 | ** but leaves the result in UTF-16 in native byte order instead of UTF-8. | |
3194 | ** The zero terminator is not included in this count. | |
3195 | ** | |
3196 | ** The object returned by [sqlite3_column_value()] is an | |
3197 | ** [unprotected sqlite3_value] object. An unprotected sqlite3_value object | |
3198 | ** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()]. | |
3199 | ** If the [unprotected sqlite3_value] object returned by | |
3200 | ** [sqlite3_column_value()] is used in any other way, including calls | |
3201 | ** to routines like | |
3202 | ** [sqlite3_value_int()], [sqlite3_value_text()], or [sqlite3_value_bytes()], | |
3203 | ** then the behavior is undefined. | |
3204 | ** | |
3205 | ** These routines attempt to convert the value where appropriate. For | |
3206 | ** example, if the internal representation is FLOAT and a text result | |
3207 | ** is requested, [sqlite3_snprintf()] is used internally to do the conversion | |
3208 | ** automatically. The following table details the conversions that | |
3209 | ** are applied: | |
3210 | ** | |
3211 | ** <blockquote> | |
3212 | ** <table border="1"> | |
3213 | ** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion | |
3214 | ** | |
3215 | ** <tr><td> NULL <td> INTEGER <td> Result is 0 | |
3216 | ** <tr><td> NULL <td> FLOAT <td> Result is 0.0 | |
3217 | ** <tr><td> NULL <td> TEXT <td> Result is NULL pointer | |
3218 | ** <tr><td> NULL <td> BLOB <td> Result is NULL pointer | |
3219 | ** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float | |
3220 | ** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer | |
3221 | ** <tr><td> INTEGER <td> BLOB <td> Same as for INTEGER->TEXT | |
3222 | ** <tr><td> FLOAT <td> INTEGER <td> Convert from float to integer | |
3223 | ** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float | |
3224 | ** <tr><td> FLOAT <td> BLOB <td> Same as FLOAT->TEXT | |
3225 | ** <tr><td> TEXT <td> INTEGER <td> Use atoi() | |
3226 | ** <tr><td> TEXT <td> FLOAT <td> Use atof() | |
3227 | ** <tr><td> TEXT <td> BLOB <td> No change | |
3228 | ** <tr><td> BLOB <td> INTEGER <td> Convert to TEXT then use atoi() | |
3229 | ** <tr><td> BLOB <td> FLOAT <td> Convert to TEXT then use atof() | |
3230 | ** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed | |
3231 | ** </table> | |
3232 | ** </blockquote> | |
3233 | ** | |
3234 | ** The table above makes reference to standard C library functions atoi() | |
3235 | ** and atof(). SQLite does not really use these functions. It has its | |
3236 | ** on equavalent internal routines. The atoi() and atof() names are | |
3237 | ** used in the table for brevity and because they are familiar to most | |
3238 | ** C programmers. | |
3239 | ** | |
3240 | ** Note that when type conversions occur, pointers returned by prior | |
3241 | ** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or | |
3242 | ** sqlite3_column_text16() may be invalidated. | |
3243 | ** Type conversions and pointer invalidations might occur | |
3244 | ** in the following cases: | |
3245 | ** | |
3246 | ** <ul> | |
3247 | ** <li><p> The initial content is a BLOB and sqlite3_column_text() | |
3248 | ** or sqlite3_column_text16() is called. A zero-terminator might | |
3249 | ** need to be added to the string.</p></li> | |
3250 | ** | |
3251 | ** <li><p> The initial content is UTF-8 text and sqlite3_column_bytes16() or | |
3252 | ** sqlite3_column_text16() is called. The content must be converted | |
3253 | ** to UTF-16.</p></li> | |
3254 | ** | |
3255 | ** <li><p> The initial content is UTF-16 text and sqlite3_column_bytes() or | |
3256 | ** sqlite3_column_text() is called. The content must be converted | |
3257 | ** to UTF-8.</p></li> | |
3258 | ** </ul> | |
3259 | ** | |
3260 | ** Conversions between UTF-16be and UTF-16le are always done in place and do | |
3261 | ** not invalidate a prior pointer, though of course the content of the buffer | |
3262 | ** that the prior pointer points to will have been modified. Other kinds | |
3263 | ** of conversion are done in place when it is possible, but sometime it is | |
3264 | ** not possible and in those cases prior pointers are invalidated. | |
3265 | ** | |
3266 | ** The safest and easiest to remember policy is to invoke these routines | |
3267 | ** in one of the following ways: | |
3268 | ** | |
3269 | ** <ul> | |
3270 | ** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li> | |
3271 | ** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li> | |
3272 | ** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li> | |
3273 | ** </ul> | |
3274 | ** | |
3275 | ** In other words, you should call sqlite3_column_text(), sqlite3_column_blob(), | |
3276 | ** or sqlite3_column_text16() first to force the result into the desired | |
3277 | ** format, then invoke sqlite3_column_bytes() or sqlite3_column_bytes16() to | |
3278 | ** find the size of the result. Do not mix call to sqlite3_column_text() or | |
3279 | ** sqlite3_column_blob() with calls to sqlite3_column_bytes16(). And do not | |
3280 | ** mix calls to sqlite3_column_text16() with calls to sqlite3_column_bytes(). | |
3281 | ** | |
3282 | ** The pointers returned are valid until a type conversion occurs as | |
3283 | ** described above, or until [sqlite3_step()] or [sqlite3_reset()] or | |
3284 | ** [sqlite3_finalize()] is called. The memory space used to hold strings | |
3285 | ** and blobs is freed automatically. Do <b>not</b> pass the pointers returned | |
3286 | ** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into | |
3287 | ** [sqlite3_free()]. | |
3288 | ** | |
3289 | ** If a memory allocation error occurs during the evaluation of any | |
3290 | ** of these routines, a default value is returned. The default value | |
3291 | ** is either the integer 0, the floating point number 0.0, or a NULL | |
3292 | ** pointer. Subsequent calls to [sqlite3_errcode()] will return | |
3293 | ** [SQLITE_NOMEM]. | |
3294 | ** | |
3295 | ** INVARIANTS: | |
3296 | ** | |
3297 | ** {F13803} The [sqlite3_column_blob(S,N)] interface converts the | |
3298 | ** Nth column in the current row of the result set for | |
3299 | ** [prepared statement] S into a blob and then returns a | |
3300 | ** pointer to the converted value. | |
3301 | ** | |
3302 | ** {F13806} The [sqlite3_column_bytes(S,N)] interface returns the | |
3303 | ** number of bytes in the blob or string (exclusive of the | |
3304 | ** zero terminator on the string) that was returned by the | |
3305 | ** most recent call to [sqlite3_column_blob(S,N)] or | |
3306 | ** [sqlite3_column_text(S,N)]. | |
3307 | ** | |
3308 | ** {F13809} The [sqlite3_column_bytes16(S,N)] interface returns the | |
3309 | ** number of bytes in the string (exclusive of the | |
3310 | ** zero terminator on the string) that was returned by the | |
3311 | ** most recent call to [sqlite3_column_text16(S,N)]. | |
3312 | ** | |
3313 | ** {F13812} The [sqlite3_column_double(S,N)] interface converts the | |
3314 | ** Nth column in the current row of the result set for | |
3315 | ** [prepared statement] S into a floating point value and | |
3316 | ** returns a copy of that value. | |
3317 | ** | |
3318 | ** {F13815} The [sqlite3_column_int(S,N)] interface converts the | |
3319 | ** Nth column in the current row of the result set for | |
3320 | ** [prepared statement] S into a 64-bit signed integer and | |
3321 | ** returns the lower 32 bits of that integer. | |
3322 | ** | |
3323 | ** {F13818} The [sqlite3_column_int64(S,N)] interface converts the | |
3324 | ** Nth column in the current row of the result set for | |
3325 | ** [prepared statement] S into a 64-bit signed integer and | |
3326 | ** returns a copy of that integer. | |
3327 | ** | |
3328 | ** {F13821} The [sqlite3_column_text(S,N)] interface converts the | |
3329 | ** Nth column in the current row of the result set for | |
3330 | ** [prepared statement] S into a zero-terminated UTF-8 | |
3331 | ** string and returns a pointer to that string. | |
3332 | ** | |
3333 | ** {F13824} The [sqlite3_column_text16(S,N)] interface converts the | |
3334 | ** Nth column in the current row of the result set for | |
3335 | ** [prepared statement] S into a zero-terminated 2-byte | |
3336 | ** aligned UTF-16 native byte order | |
3337 | ** string and returns a pointer to that string. | |
3338 | ** | |
3339 | ** {F13827} The [sqlite3_column_type(S,N)] interface returns | |
3340 | ** one of [SQLITE_NULL], [SQLITE_INTEGER], [SQLITE_FLOAT], | |
3341 | ** [SQLITE_TEXT], or [SQLITE_BLOB] as appropriate for | |
3342 | ** the Nth column in the current row of the result set for | |
3343 | ** [prepared statement] S. | |
3344 | ** | |
3345 | ** {F13830} The [sqlite3_column_value(S,N)] interface returns a | |
3346 | ** pointer to an [unprotected sqlite3_value] object for the | |
3347 | ** Nth column in the current row of the result set for | |
3348 | ** [prepared statement] S. | |
3349 | */ | |
3350 | const void *sqlite3_column_blob(sqlite3_stmt*, int iCol); | |
3351 | int sqlite3_column_bytes(sqlite3_stmt*, int iCol); | |
3352 | int sqlite3_column_bytes16(sqlite3_stmt*, int iCol); | |
3353 | double sqlite3_column_double(sqlite3_stmt*, int iCol); | |
3354 | int sqlite3_column_int(sqlite3_stmt*, int iCol); | |
3355 | sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol); | |
3356 | const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol); | |
3357 | const void *sqlite3_column_text16(sqlite3_stmt*, int iCol); | |
3358 | int sqlite3_column_type(sqlite3_stmt*, int iCol); | |
3359 | sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol); | |
3360 | ||
3361 | /* | |
3362 | ** CAPI3REF: Destroy A Prepared Statement Object {F13300} | |
3363 | ** | |
3364 | ** The sqlite3_finalize() function is called to delete a | |
3365 | ** [prepared statement]. If the statement was | |
3366 | ** executed successfully, or not executed at all, then SQLITE_OK is returned. | |
3367 | ** If execution of the statement failed then an | |
3368 | ** [error code] or [extended error code] | |
3369 | ** is returned. | |
3370 | ** | |
3371 | ** This routine can be called at any point during the execution of the | |
3372 | ** [prepared statement]. If the virtual machine has not | |
3373 | ** completed execution when this routine is called, that is like | |
3374 | ** encountering an error or an interrupt. (See [sqlite3_interrupt()].) | |
3375 | ** Incomplete updates may be rolled back and transactions cancelled, | |
3376 | ** depending on the circumstances, and the | |
3377 | ** [error code] returned will be [SQLITE_ABORT]. | |
3378 | ** | |
3379 | ** INVARIANTS: | |
3380 | ** | |
3381 | ** {F11302} The [sqlite3_finalize(S)] interface destroys the | |
3382 | ** [prepared statement] S and releases all | |
3383 | ** memory and file resources held by that object. | |
3384 | ** | |
3385 | ** {F11304} If the most recent call to [sqlite3_step(S)] for the | |
3386 | ** [prepared statement] S returned an error, | |
3387 | ** then [sqlite3_finalize(S)] returns that same error. | |
3388 | */ | |
3389 | int sqlite3_finalize(sqlite3_stmt *pStmt); | |
3390 | ||
3391 | /* | |
3392 | ** CAPI3REF: Reset A Prepared Statement Object {F13330} | |
3393 | ** | |
3394 | ** The sqlite3_reset() function is called to reset a | |
3395 | ** [prepared statement] object. | |
3396 | ** back to its initial state, ready to be re-executed. | |
3397 | ** Any SQL statement variables that had values bound to them using | |
3398 | ** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values. | |
3399 | ** Use [sqlite3_clear_bindings()] to reset the bindings. | |
3400 | ** | |
3401 | ** {F11332} The [sqlite3_reset(S)] interface resets the [prepared statement] S | |
3402 | ** back to the beginning of its program. | |
3403 | ** | |
3404 | ** {F11334} If the most recent call to [sqlite3_step(S)] for | |
3405 | ** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE], | |
3406 | ** or if [sqlite3_step(S)] has never before been called on S, | |
3407 | ** then [sqlite3_reset(S)] returns [SQLITE_OK]. | |
3408 | ** | |
3409 | ** {F11336} If the most recent call to [sqlite3_step(S)] for | |
3410 | ** [prepared statement] S indicated an error, then | |
3411 | ** [sqlite3_reset(S)] returns an appropriate [error code]. | |
3412 | ** | |
3413 | ** {F11338} The [sqlite3_reset(S)] interface does not change the values | |
3414 | ** of any [sqlite3_bind_blob|bindings] on [prepared statement] S. | |
3415 | */ | |
3416 | int sqlite3_reset(sqlite3_stmt *pStmt); | |
3417 | ||
3418 | /* | |
3419 | ** CAPI3REF: Create Or Redefine SQL Functions {F16100} | |
3420 | ** KEYWORDS: {function creation routines} | |
3421 | ** | |
3422 | ** These two functions (collectively known as | |
3423 | ** "function creation routines") are used to add SQL functions or aggregates | |
3424 | ** or to redefine the behavior of existing SQL functions or aggregates. The | |
3425 | ** difference only between the two is that the second parameter, the | |
3426 | ** name of the (scalar) function or aggregate, is encoded in UTF-8 for | |
3427 | ** sqlite3_create_function() and UTF-16 for sqlite3_create_function16(). | |
3428 | ** | |
3429 | ** The first parameter is the [database connection] to which the SQL | |
3430 | ** function is to be added. If a single | |
3431 | ** program uses more than one [database connection] internally, then SQL | |
3432 | ** functions must be added individually to each [database connection]. | |
3433 | ** | |
3434 | ** The second parameter is the name of the SQL function to be created | |
3435 | ** or redefined. | |
3436 | ** The length of the name is limited to 255 bytes, exclusive of the | |
3437 | ** zero-terminator. Note that the name length limit is in bytes, not | |
3438 | ** characters. Any attempt to create a function with a longer name | |
3439 | ** will result in an SQLITE_ERROR error. | |
3440 | ** | |
3441 | ** The third parameter is the number of arguments that the SQL function or | |
3442 | ** aggregate takes. If this parameter is negative, then the SQL function or | |
3443 | ** aggregate may take any number of arguments. | |
3444 | ** | |
3445 | ** The fourth parameter, eTextRep, specifies what | |
3446 | ** [SQLITE_UTF8 | text encoding] this SQL function prefers for | |
3447 | ** its parameters. Any SQL function implementation should be able to work | |
3448 | ** work with UTF-8, UTF-16le, or UTF-16be. But some implementations may be | |
3449 | ** more efficient with one encoding than another. It is allowed to | |
3450 | ** invoke sqlite3_create_function() or sqlite3_create_function16() multiple | |
3451 | ** times with the same function but with different values of eTextRep. | |
3452 | ** When multiple implementations of the same function are available, SQLite | |
3453 | ** will pick the one that involves the least amount of data conversion. | |
3454 | ** If there is only a single implementation which does not care what | |
3455 | ** text encoding is used, then the fourth argument should be | |
3456 | ** [SQLITE_ANY]. | |
3457 | ** | |
3458 | ** The fifth parameter is an arbitrary pointer. The implementation | |
3459 | ** of the function can gain access to this pointer using | |
3460 | ** [sqlite3_user_data()]. | |
3461 | ** | |
3462 | ** The seventh, eighth and ninth parameters, xFunc, xStep and xFinal, are | |
3463 | ** pointers to C-language functions that implement the SQL | |
3464 | ** function or aggregate. A scalar SQL function requires an implementation of | |
3465 | ** the xFunc callback only, NULL pointers should be passed as the xStep | |
3466 | ** and xFinal parameters. An aggregate SQL function requires an implementation | |
3467 | ** of xStep and xFinal and NULL should be passed for xFunc. To delete an | |
3468 | ** existing SQL function or aggregate, pass NULL for all three function | |
3469 | ** callback. | |
3470 | ** | |
3471 | ** It is permitted to register multiple implementations of the same | |
3472 | ** functions with the same name but with either differing numbers of | |
3473 | ** arguments or differing perferred text encodings. SQLite will use | |
3474 | ** the implementation most closely matches the way in which the | |
3475 | ** SQL function is used. | |
3476 | ** | |
3477 | ** INVARIANTS: | |
3478 | ** | |
3479 | ** {F16103} The [sqlite3_create_function16()] interface behaves exactly | |
3480 | ** like [sqlite3_create_function()] in every way except that it | |
3481 | ** interprets the zFunctionName argument as | |
3482 | ** zero-terminated UTF-16 native byte order instead of as a | |
3483 | ** zero-terminated UTF-8. | |
3484 | ** | |
3485 | ** {F16106} A successful invocation of | |
3486 | ** the [sqlite3_create_function(D,X,N,E,...)] interface registers | |
3487 | ** or replaces callback functions in [database connection] D | |
3488 | ** used to implement the SQL function named X with N parameters | |
3489 | ** and having a perferred text encoding of E. | |
3490 | ** | |
3491 | ** {F16109} A successful call to [sqlite3_create_function(D,X,N,E,P,F,S,L)] | |
3492 | ** replaces the P, F, S, and L values from any prior calls with | |
3493 | ** the same D, X, N, and E values. | |
3494 | ** | |
3495 | ** {F16112} The [sqlite3_create_function(D,X,...)] interface fails with | |
3496 | ** a return code of [SQLITE_ERROR] if the SQL function name X is | |
3497 | ** longer than 255 bytes exclusive of the zero terminator. | |
3498 | ** | |
3499 | ** {F16118} Either F must be NULL and S and L are non-NULL or else F | |
3500 | ** is non-NULL and S and L are NULL, otherwise | |
3501 | ** [sqlite3_create_function(D,X,N,E,P,F,S,L)] returns [SQLITE_ERROR]. | |
3502 | ** | |
3503 | ** {F16121} The [sqlite3_create_function(D,...)] interface fails with an | |
3504 | ** error code of [SQLITE_BUSY] if there exist [prepared statements] | |
3505 | ** associated with the [database connection] D. | |
3506 | ** | |
3507 | ** {F16124} The [sqlite3_create_function(D,X,N,...)] interface fails with an | |
3508 | ** error code of [SQLITE_ERROR] if parameter N (specifying the number | |
3509 | ** of arguments to the SQL function being registered) is less | |
3510 | ** than -1 or greater than 127. | |
3511 | ** | |
3512 | ** {F16127} When N is non-negative, the [sqlite3_create_function(D,X,N,...)] | |
3513 | ** interface causes callbacks to be invoked for the SQL function | |
3514 | ** named X when the number of arguments to the SQL function is | |
3515 | ** exactly N. | |
3516 | ** | |
3517 | ** {F16130} When N is -1, the [sqlite3_create_function(D,X,N,...)] | |
3518 | ** interface causes callbacks to be invoked for the SQL function | |
3519 | ** named X with any number of arguments. | |
3520 | ** | |
3521 | ** {F16133} When calls to [sqlite3_create_function(D,X,N,...)] | |
3522 | ** specify multiple implementations of the same function X | |
3523 | ** and when one implementation has N>=0 and the other has N=(-1) | |
3524 | ** the implementation with a non-zero N is preferred. | |
3525 | ** | |
3526 | ** {F16136} When calls to [sqlite3_create_function(D,X,N,E,...)] | |
3527 | ** specify multiple implementations of the same function X with | |
3528 | ** the same number of arguments N but with different | |
3529 | ** encodings E, then the implementation where E matches the | |
3530 | ** database encoding is preferred. | |
3531 | ** | |
3532 | ** {F16139} For an aggregate SQL function created using | |
3533 | ** [sqlite3_create_function(D,X,N,E,P,0,S,L)] the finializer | |
3534 | ** function L will always be invoked exactly once if the | |
3535 | ** step function S is called one or more times. | |
3536 | ** | |
3537 | ** {F16142} When SQLite invokes either the xFunc or xStep function of | |
3538 | ** an application-defined SQL function or aggregate created | |
3539 | ** by [sqlite3_create_function()] or [sqlite3_create_function16()], | |
3540 | ** then the array of [sqlite3_value] objects passed as the | |
3541 | ** third parameter are always [protected sqlite3_value] objects. | |
3542 | */ | |
3543 | int sqlite3_create_function( | |
3544 | sqlite3 *db, | |
3545 | const char *zFunctionName, | |
3546 | int nArg, | |
3547 | int eTextRep, | |
3548 | void *pApp, | |
3549 | void (*xFunc)(sqlite3_context*,int,sqlite3_value**), | |
3550 | void (*xStep)(sqlite3_context*,int,sqlite3_value**), | |
3551 | void (*xFinal)(sqlite3_context*) | |
3552 | ); | |
3553 | int sqlite3_create_function16( | |
3554 | sqlite3 *db, | |
3555 | const void *zFunctionName, | |
3556 | int nArg, | |
3557 | int eTextRep, | |
3558 | void *pApp, | |
3559 | void (*xFunc)(sqlite3_context*,int,sqlite3_value**), | |
3560 | void (*xStep)(sqlite3_context*,int,sqlite3_value**), | |
3561 | void (*xFinal)(sqlite3_context*) | |
3562 | ); | |
3563 | ||
3564 | /* | |
3565 | ** CAPI3REF: Text Encodings {F10267} | |
3566 | ** | |
3567 | ** These constant define integer codes that represent the various | |
3568 | ** text encodings supported by SQLite. | |
3569 | */ | |
3570 | #define SQLITE_UTF8 1 | |
3571 | #define SQLITE_UTF16LE 2 | |
3572 | #define SQLITE_UTF16BE 3 | |
3573 | #define SQLITE_UTF16 4 /* Use native byte order */ | |
3574 | #define SQLITE_ANY 5 /* sqlite3_create_function only */ | |
3575 | #define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */ | |
3576 | ||
3577 | /* | |
3578 | ** CAPI3REF: Obsolete Functions | |
3579 | ** | |
3580 | ** These functions are all now obsolete. In order to maintain | |
3581 | ** backwards compatibility with older code, we continue to support | |
3582 | ** these functions. However, new development projects should avoid | |
3583 | ** the use of these functions. To help encourage people to avoid | |
3584 | ** using these functions, we are not going to tell you want they do. | |
3585 | */ | |
3586 | int sqlite3_aggregate_count(sqlite3_context*); | |
3587 | int sqlite3_expired(sqlite3_stmt*); | |
3588 | int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*); | |
3589 | int sqlite3_global_recover(void); | |
3590 | void sqlite3_thread_cleanup(void); | |
3591 | int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),void*,sqlite3_int64); | |
3592 | ||
3593 | /* | |
3594 | ** CAPI3REF: Obtaining SQL Function Parameter Values {F15100} | |
3595 | ** | |
3596 | ** The C-language implementation of SQL functions and aggregates uses | |
3597 | ** this set of interface routines to access the parameter values on | |
3598 | ** the function or aggregate. | |
3599 | ** | |
3600 | ** The xFunc (for scalar functions) or xStep (for aggregates) parameters | |
3601 | ** to [sqlite3_create_function()] and [sqlite3_create_function16()] | |
3602 | ** define callbacks that implement the SQL functions and aggregates. | |
3603 | ** The 4th parameter to these callbacks is an array of pointers to | |
3604 | ** [protected sqlite3_value] objects. There is one [sqlite3_value] object for | |
3605 | ** each parameter to the SQL function. These routines are used to | |
3606 | ** extract values from the [sqlite3_value] objects. | |
3607 | ** | |
3608 | ** These routines work only with [protected sqlite3_value] objects. | |
3609 | ** Any attempt to use these routines on an [unprotected sqlite3_value] | |
3610 | ** object results in undefined behavior. | |
3611 | ** | |
3612 | ** These routines work just like the corresponding | |
3613 | ** [sqlite3_column_blob | sqlite3_column_* routines] except that | |
3614 | ** these routines take a single [protected sqlite3_value] object pointer | |
3615 | ** instead of an [sqlite3_stmt*] pointer and an integer column number. | |
3616 | ** | |
3617 | ** The sqlite3_value_text16() interface extracts a UTF16 string | |
3618 | ** in the native byte-order of the host machine. The | |
3619 | ** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces | |
3620 | ** extract UTF16 strings as big-endian and little-endian respectively. | |
3621 | ** | |
3622 | ** The sqlite3_value_numeric_type() interface attempts to apply | |
3623 | ** numeric affinity to the value. This means that an attempt is | |
3624 | ** made to convert the value to an integer or floating point. If | |
3625 | ** such a conversion is possible without loss of information (in other | |
3626 | ** words if the value is a string that looks like a number) | |
3627 | ** then the conversion is done. Otherwise no conversion occurs. The | |
3628 | ** [SQLITE_INTEGER | datatype] after conversion is returned. | |
3629 | ** | |
3630 | ** Please pay particular attention to the fact that the pointer that | |
3631 | ** is returned from [sqlite3_value_blob()], [sqlite3_value_text()], or | |
3632 | ** [sqlite3_value_text16()] can be invalidated by a subsequent call to | |
3633 | ** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()], | |
3634 | ** or [sqlite3_value_text16()]. | |
3635 | ** | |
3636 | ** These routines must be called from the same thread as | |
3637 | ** the SQL function that supplied the [sqlite3_value*] parameters. | |
3638 | ** | |
3639 | ** | |
3640 | ** INVARIANTS: | |
3641 | ** | |
3642 | ** {F15103} The [sqlite3_value_blob(V)] interface converts the | |
3643 | ** [protected sqlite3_value] object V into a blob and then returns a | |
3644 | ** pointer to the converted value. | |
3645 | ** | |
3646 | ** {F15106} The [sqlite3_value_bytes(V)] interface returns the | |
3647 | ** number of bytes in the blob or string (exclusive of the | |
3648 | ** zero terminator on the string) that was returned by the | |
3649 | ** most recent call to [sqlite3_value_blob(V)] or | |
3650 | ** [sqlite3_value_text(V)]. | |
3651 | ** | |
3652 | ** {F15109} The [sqlite3_value_bytes16(V)] interface returns the | |
3653 | ** number of bytes in the string (exclusive of the | |
3654 | ** zero terminator on the string) that was returned by the | |
3655 | ** most recent call to [sqlite3_value_text16(V)], | |
3656 | ** [sqlite3_value_text16be(V)], or [sqlite3_value_text16le(V)]. | |
3657 | ** | |
3658 | ** {F15112} The [sqlite3_value_double(V)] interface converts the | |
3659 | ** [protected sqlite3_value] object V into a floating point value and | |
3660 | ** returns a copy of that value. | |
3661 | ** | |
3662 | ** {F15115} The [sqlite3_value_int(V)] interface converts the | |
3663 | ** [protected sqlite3_value] object V into a 64-bit signed integer and | |
3664 | ** returns the lower 32 bits of that integer. | |
3665 | ** | |
3666 | ** {F15118} The [sqlite3_value_int64(V)] interface converts the | |
3667 | ** [protected sqlite3_value] object V into a 64-bit signed integer and | |
3668 | ** returns a copy of that integer. | |
3669 | ** | |
3670 | ** {F15121} The [sqlite3_value_text(V)] interface converts the | |
3671 | ** [protected sqlite3_value] object V into a zero-terminated UTF-8 | |
3672 | ** string and returns a pointer to that string. | |
3673 | ** | |
3674 | ** {F15124} The [sqlite3_value_text16(V)] interface converts the | |
3675 | ** [protected sqlite3_value] object V into a zero-terminated 2-byte | |
3676 | ** aligned UTF-16 native byte order | |
3677 | ** string and returns a pointer to that string. | |
3678 | ** | |
3679 | ** {F15127} The [sqlite3_value_text16be(V)] interface converts the | |
3680 | ** [protected sqlite3_value] object V into a zero-terminated 2-byte | |
3681 | ** aligned UTF-16 big-endian | |
3682 | ** string and returns a pointer to that string. | |
3683 | ** | |
3684 | ** {F15130} The [sqlite3_value_text16le(V)] interface converts the | |
3685 | ** [protected sqlite3_value] object V into a zero-terminated 2-byte | |
3686 | ** aligned UTF-16 little-endian | |
3687 | ** string and returns a pointer to that string. | |
3688 | ** | |
3689 | ** {F15133} The [sqlite3_value_type(V)] interface returns | |
3690 | ** one of [SQLITE_NULL], [SQLITE_INTEGER], [SQLITE_FLOAT], | |
3691 | ** [SQLITE_TEXT], or [SQLITE_BLOB] as appropriate for | |
3692 | ** the [sqlite3_value] object V. | |
3693 | ** | |
3694 | ** {F15136} The [sqlite3_value_numeric_type(V)] interface converts | |
3695 | ** the [protected sqlite3_value] object V into either an integer or | |
3696 | ** a floating point value if it can do so without loss of | |
3697 | ** information, and returns one of [SQLITE_NULL], | |
3698 | ** [SQLITE_INTEGER], [SQLITE_FLOAT], [SQLITE_TEXT], or | |
3699 | ** [SQLITE_BLOB] as appropriate for | |
3700 | ** the [protected sqlite3_value] object V after the conversion attempt. | |
3701 | */ | |
3702 | const void *sqlite3_value_blob(sqlite3_value*); | |
3703 | int sqlite3_value_bytes(sqlite3_value*); | |
3704 | int sqlite3_value_bytes16(sqlite3_value*); | |
3705 | double sqlite3_value_double(sqlite3_value*); | |
3706 | int sqlite3_value_int(sqlite3_value*); | |
3707 | sqlite3_int64 sqlite3_value_int64(sqlite3_value*); | |
3708 | const unsigned char *sqlite3_value_text(sqlite3_value*); | |
3709 | const void *sqlite3_value_text16(sqlite3_value*); | |
3710 | const void *sqlite3_value_text16le(sqlite3_value*); | |
3711 | const void *sqlite3_value_text16be(sqlite3_value*); | |
3712 | int sqlite3_value_type(sqlite3_value*); | |
3713 | int sqlite3_value_numeric_type(sqlite3_value*); | |
3714 | ||
3715 | /* | |
3716 | ** CAPI3REF: Obtain Aggregate Function Context {F16210} | |
3717 | ** | |
3718 | ** The implementation of aggregate SQL functions use this routine to allocate | |
3719 | ** a structure for storing their state. | |
3720 | ** The first time the sqlite3_aggregate_context() routine is | |
3721 | ** is called for a particular aggregate, SQLite allocates nBytes of memory | |
3722 | ** zeros that memory, and returns a pointer to it. | |
3723 | ** On second and subsequent calls to sqlite3_aggregate_context() | |
3724 | ** for the same aggregate function index, the same buffer is returned. | |
3725 | ** The implementation | |
3726 | ** of the aggregate can use the returned buffer to accumulate data. | |
3727 | ** | |
3728 | ** SQLite automatically frees the allocated buffer when the aggregate | |
3729 | ** query concludes. | |
3730 | ** | |
3731 | ** The first parameter should be a copy of the | |
3732 | ** [sqlite3_context | SQL function context] that is the first | |
3733 | ** parameter to the callback routine that implements the aggregate | |
3734 | ** function. | |
3735 | ** | |
3736 | ** This routine must be called from the same thread in which | |
3737 | ** the aggregate SQL function is running. | |
3738 | ** | |
3739 | ** INVARIANTS: | |
3740 | ** | |
3741 | ** {F16211} The first invocation of [sqlite3_aggregate_context(C,N)] for | |
3742 | ** a particular instance of an aggregate function (for a particular | |
3743 | ** context C) causes SQLite to allocation N bytes of memory, | |
3744 | ** zero that memory, and return a pointer to the allocationed | |
3745 | ** memory. | |
3746 | ** | |
3747 | ** {F16213} If a memory allocation error occurs during | |
3748 | ** [sqlite3_aggregate_context(C,N)] then the function returns 0. | |
3749 | ** | |
3750 | ** {F16215} Second and subsequent invocations of | |
3751 | ** [sqlite3_aggregate_context(C,N)] for the same context pointer C | |
3752 | ** ignore the N parameter and return a pointer to the same | |
3753 | ** block of memory returned by the first invocation. | |
3754 | ** | |
3755 | ** {F16217} The memory allocated by [sqlite3_aggregate_context(C,N)] is | |
3756 | ** automatically freed on the next call to [sqlite3_reset()] | |
3757 | ** or [sqlite3_finalize()] for the [prepared statement] containing | |
3758 | ** the aggregate function associated with context C. | |
3759 | */ | |
3760 | void *sqlite3_aggregate_context(sqlite3_context*, int nBytes); | |
3761 | ||
3762 | /* | |
3763 | ** CAPI3REF: User Data For Functions {F16240} | |
3764 | ** | |
3765 | ** The sqlite3_user_data() interface returns a copy of | |
3766 | ** the pointer that was the pUserData parameter (the 5th parameter) | |
3767 | ** of the the [sqlite3_create_function()] | |
3768 | ** and [sqlite3_create_function16()] routines that originally | |
3769 | ** registered the application defined function. {END} | |
3770 | ** | |
3771 | ** This routine must be called from the same thread in which | |
3772 | ** the application-defined function is running. | |
3773 | ** | |
3774 | ** INVARIANTS: | |
3775 | ** | |
3776 | ** {F16243} The [sqlite3_user_data(C)] interface returns a copy of the | |
3777 | ** P pointer from the [sqlite3_create_function(D,X,N,E,P,F,S,L)] | |
3778 | ** or [sqlite3_create_function16(D,X,N,E,P,F,S,L)] call that | |
3779 | ** registered the SQL function associated with | |
3780 | ** [sqlite3_context] C. | |
3781 | */ | |
3782 | void *sqlite3_user_data(sqlite3_context*); | |
3783 | ||
3784 | /* | |
3785 | ** CAPI3REF: Database Connection For Functions {F16250} | |
3786 | ** | |
3787 | ** The sqlite3_context_db_handle() interface returns a copy of | |
3788 | ** the pointer to the [database connection] (the 1st parameter) | |
3789 | ** of the the [sqlite3_create_function()] | |
3790 | ** and [sqlite3_create_function16()] routines that originally | |
3791 | ** registered the application defined function. | |
3792 | ** | |
3793 | ** INVARIANTS: | |
3794 | ** | |
3795 | ** {F16253} The [sqlite3_context_db_handle(C)] interface returns a copy of the | |
3796 | ** D pointer from the [sqlite3_create_function(D,X,N,E,P,F,S,L)] | |
3797 | ** or [sqlite3_create_function16(D,X,N,E,P,F,S,L)] call that | |
3798 | ** registered the SQL function associated with | |
3799 | ** [sqlite3_context] C. | |
3800 | */ | |
3801 | sqlite3 *sqlite3_context_db_handle(sqlite3_context*); | |
3802 | ||
3803 | /* | |
3804 | ** CAPI3REF: Function Auxiliary Data {F16270} | |
3805 | ** | |
3806 | ** The following two functions may be used by scalar SQL functions to | |
3807 | ** associate meta-data with argument values. If the same value is passed to | |
3808 | ** multiple invocations of the same SQL function during query execution, under | |
3809 | ** some circumstances the associated meta-data may be preserved. This may | |
3810 | ** be used, for example, to add a regular-expression matching scalar | |
3811 | ** function. The compiled version of the regular expression is stored as | |
3812 | ** meta-data associated with the SQL value passed as the regular expression | |
3813 | ** pattern. The compiled regular expression can be reused on multiple | |
3814 | ** invocations of the same function so that the original pattern string | |
3815 | ** does not need to be recompiled on each invocation. | |
3816 | ** | |
3817 | ** The sqlite3_get_auxdata() interface returns a pointer to the meta-data | |
3818 | ** associated by the sqlite3_set_auxdata() function with the Nth argument | |
3819 | ** value to the application-defined function. | |
3820 | ** If no meta-data has been ever been set for the Nth | |
3821 | ** argument of the function, or if the cooresponding function parameter | |
3822 | ** has changed since the meta-data was set, then sqlite3_get_auxdata() | |
3823 | ** returns a NULL pointer. | |
3824 | ** | |
3825 | ** The sqlite3_set_auxdata() interface saves the meta-data | |
3826 | ** pointed to by its 3rd parameter as the meta-data for the N-th | |
3827 | ** argument of the application-defined function. Subsequent | |
3828 | ** calls to sqlite3_get_auxdata() might return this data, if it has | |
3829 | ** not been destroyed. | |
3830 | ** If it is not NULL, SQLite will invoke the destructor | |
3831 | ** function given by the 4th parameter to sqlite3_set_auxdata() on | |
3832 | ** the meta-data when the corresponding function parameter changes | |
3833 | ** or when the SQL statement completes, whichever comes first. | |
3834 | ** | |
3835 | ** SQLite is free to call the destructor and drop meta-data on | |
3836 | ** any parameter of any function at any time. The only guarantee | |
3837 | ** is that the destructor will be called before the metadata is | |
3838 | ** dropped. | |
3839 | ** | |
3840 | ** In practice, meta-data is preserved between function calls for | |
3841 | ** expressions that are constant at compile time. This includes literal | |
3842 | ** values and SQL variables. | |
3843 | ** | |
3844 | ** These routines must be called from the same thread in which | |
3845 | ** the SQL function is running. | |
3846 | ** | |
3847 | ** INVARIANTS: | |
3848 | ** | |
3849 | ** {F16272} The [sqlite3_get_auxdata(C,N)] interface returns a pointer | |
3850 | ** to metadata associated with the Nth parameter of the SQL function | |
3851 | ** whose context is C, or NULL if there is no metadata associated | |
3852 | ** with that parameter. | |
3853 | ** | |
3854 | ** {F16274} The [sqlite3_set_auxdata(C,N,P,D)] interface assigns a metadata | |
3855 | ** pointer P to the Nth parameter of the SQL function with context | |
3856 | ** C. | |
3857 | ** | |
3858 | ** {F16276} SQLite will invoke the destructor D with a single argument | |
3859 | ** which is the metadata pointer P following a call to | |
3860 | ** [sqlite3_set_auxdata(C,N,P,D)] when SQLite ceases to hold | |
3861 | ** the metadata. | |
3862 | ** | |
3863 | ** {F16277} SQLite ceases to hold metadata for an SQL function parameter | |
3864 | ** when the value of that parameter changes. | |
3865 | ** | |
3866 | ** {F16278} When [sqlite3_set_auxdata(C,N,P,D)] is invoked, the destructor | |
3867 | ** is called for any prior metadata associated with the same function | |
3868 | ** context C and parameter N. | |
3869 | ** | |
3870 | ** {F16279} SQLite will call destructors for any metadata it is holding | |
3871 | ** in a particular [prepared statement] S when either | |
3872 | ** [sqlite3_reset(S)] or [sqlite3_finalize(S)] is called. | |
3873 | */ | |
3874 | void *sqlite3_get_auxdata(sqlite3_context*, int N); | |
3875 | void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*)); | |
3876 | ||
3877 | ||
3878 | /* | |
3879 | ** CAPI3REF: Constants Defining Special Destructor Behavior {F10280} | |
3880 | ** | |
3881 | ** These are special value for the destructor that is passed in as the | |
3882 | ** final argument to routines like [sqlite3_result_blob()]. If the destructor | |
3883 | ** argument is SQLITE_STATIC, it means that the content pointer is constant | |
3884 | ** and will never change. It does not need to be destroyed. The | |
3885 | ** SQLITE_TRANSIENT value means that the content will likely change in | |
3886 | ** the near future and that SQLite should make its own private copy of | |
3887 | ** the content before returning. | |
3888 | ** | |
3889 | ** The typedef is necessary to work around problems in certain | |
3890 | ** C++ compilers. See ticket #2191. | |
3891 | */ | |
3892 | typedef void (*sqlite3_destructor_type)(void*); | |
3893 | #define SQLITE_STATIC ((sqlite3_destructor_type)0) | |
3894 | #define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1) | |
3895 | ||
3896 | /* | |
3897 | ** CAPI3REF: Setting The Result Of An SQL Function {F16400} | |
3898 | ** | |
3899 | ** These routines are used by the xFunc or xFinal callbacks that | |
3900 | ** implement SQL functions and aggregates. See | |
3901 | ** [sqlite3_create_function()] and [sqlite3_create_function16()] | |
3902 | ** for additional information. | |
3903 | ** | |
3904 | ** These functions work very much like the | |
3905 | ** [sqlite3_bind_blob | sqlite3_bind_*] family of functions used | |
3906 | ** to bind values to host parameters in prepared statements. | |
3907 | ** Refer to the | |
3908 | ** [sqlite3_bind_blob | sqlite3_bind_* documentation] for | |
3909 | ** additional information. | |
3910 | ** | |
3911 | ** The sqlite3_result_blob() interface sets the result from | |
3912 | ** an application defined function to be the BLOB whose content is pointed | |
3913 | ** to by the second parameter and which is N bytes long where N is the | |
3914 | ** third parameter. | |
3915 | ** The sqlite3_result_zeroblob() inerfaces set the result of | |
3916 | ** the application defined function to be a BLOB containing all zero | |
3917 | ** bytes and N bytes in size, where N is the value of the 2nd parameter. | |
3918 | ** | |
3919 | ** The sqlite3_result_double() interface sets the result from | |
3920 | ** an application defined function to be a floating point value specified | |
3921 | ** by its 2nd argument. | |
3922 | ** | |
3923 | ** The sqlite3_result_error() and sqlite3_result_error16() functions | |
3924 | ** cause the implemented SQL function to throw an exception. | |
3925 | ** SQLite uses the string pointed to by the | |
3926 | ** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16() | |
3927 | ** as the text of an error message. SQLite interprets the error | |
3928 | ** message string from sqlite3_result_error() as UTF8. SQLite | |
3929 | ** interprets the string from sqlite3_result_error16() as UTF16 in native | |
3930 | ** byte order. If the third parameter to sqlite3_result_error() | |
3931 | ** or sqlite3_result_error16() is negative then SQLite takes as the error | |
3932 | ** message all text up through the first zero character. | |
3933 | ** If the third parameter to sqlite3_result_error() or | |
3934 | ** sqlite3_result_error16() is non-negative then SQLite takes that many | |
3935 | ** bytes (not characters) from the 2nd parameter as the error message. | |
3936 | ** The sqlite3_result_error() and sqlite3_result_error16() | |
3937 | ** routines make a copy private copy of the error message text before | |
3938 | ** they return. Hence, the calling function can deallocate or | |
3939 | ** modify the text after they return without harm. | |
3940 | ** The sqlite3_result_error_code() function changes the error code | |
3941 | ** returned by SQLite as a result of an error in a function. By default, | |
3942 | ** the error code is SQLITE_ERROR. A subsequent call to sqlite3_result_error() | |
3943 | ** or sqlite3_result_error16() resets the error code to SQLITE_ERROR. | |
3944 | ** | |
3945 | ** The sqlite3_result_toobig() interface causes SQLite | |
3946 | ** to throw an error indicating that a string or BLOB is to long | |
3947 | ** to represent. The sqlite3_result_nomem() interface | |
3948 | ** causes SQLite to throw an exception indicating that the a | |
3949 | ** memory allocation failed. | |
3950 | ** | |
3951 | ** The sqlite3_result_int() interface sets the return value | |
3952 | ** of the application-defined function to be the 32-bit signed integer | |
3953 | ** value given in the 2nd argument. | |
3954 | ** The sqlite3_result_int64() interface sets the return value | |
3955 | ** of the application-defined function to be the 64-bit signed integer | |
3956 | ** value given in the 2nd argument. | |
3957 | ** | |
3958 | ** The sqlite3_result_null() interface sets the return value | |
3959 | ** of the application-defined function to be NULL. | |
3960 | ** | |
3961 | ** The sqlite3_result_text(), sqlite3_result_text16(), | |
3962 | ** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces | |
3963 | ** set the return value of the application-defined function to be | |
3964 | ** a text string which is represented as UTF-8, UTF-16 native byte order, | |
3965 | ** UTF-16 little endian, or UTF-16 big endian, respectively. | |
3966 | ** SQLite takes the text result from the application from | |
3967 | ** the 2nd parameter of the sqlite3_result_text* interfaces. | |
3968 | ** If the 3rd parameter to the sqlite3_result_text* interfaces | |
3969 | ** is negative, then SQLite takes result text from the 2nd parameter | |
3970 | ** through the first zero character. | |
3971 | ** If the 3rd parameter to the sqlite3_result_text* interfaces | |
3972 | ** is non-negative, then as many bytes (not characters) of the text | |
3973 | ** pointed to by the 2nd parameter are taken as the application-defined | |
3974 | ** function result. | |
3975 | ** If the 4th parameter to the sqlite3_result_text* interfaces | |
3976 | ** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that | |
3977 | ** function as the destructor on the text or blob result when it has | |
3978 | ** finished using that result. | |
3979 | ** If the 4th parameter to the sqlite3_result_text* interfaces | |
3980 | ** or sqlite3_result_blob is the special constant SQLITE_STATIC, then | |
3981 | ** SQLite assumes that the text or blob result is constant space and | |
3982 | ** does not copy the space or call a destructor when it has | |
3983 | ** finished using that result. | |
3984 | ** If the 4th parameter to the sqlite3_result_text* interfaces | |
3985 | ** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT | |
3986 | ** then SQLite makes a copy of the result into space obtained from | |
3987 | ** from [sqlite3_malloc()] before it returns. | |
3988 | ** | |
3989 | ** The sqlite3_result_value() interface sets the result of | |
3990 | ** the application-defined function to be a copy the | |
3991 | ** [unprotected sqlite3_value] object specified by the 2nd parameter. The | |
3992 | ** sqlite3_result_value() interface makes a copy of the [sqlite3_value] | |
3993 | ** so that [sqlite3_value] specified in the parameter may change or | |
3994 | ** be deallocated after sqlite3_result_value() returns without harm. | |
3995 | ** A [protected sqlite3_value] object may always be used where an | |
3996 | ** [unprotected sqlite3_value] object is required, so either | |
3997 | ** kind of [sqlite3_value] object can be used with this interface. | |
3998 | ** | |
3999 | ** If these routines are called from within the different thread | |
4000 | ** than the one containing the application-defined function that recieved | |
4001 | ** the [sqlite3_context] pointer, the results are undefined. | |
4002 | ** | |
4003 | ** INVARIANTS: | |
4004 | ** | |
4005 | ** {F16403} The default return value from any SQL function is NULL. | |
4006 | ** | |
4007 | ** {F16406} The [sqlite3_result_blob(C,V,N,D)] interface changes the | |
4008 | ** return value of function C to be a blob that is N bytes | |
4009 | ** in length and with content pointed to by V. | |
4010 | ** | |
4011 | ** {F16409} The [sqlite3_result_double(C,V)] interface changes the | |
4012 | ** return value of function C to be the floating point value V. | |
4013 | ** | |
4014 | ** {F16412} The [sqlite3_result_error(C,V,N)] interface changes the return | |
4015 | ** value of function C to be an exception with error code | |
4016 | ** [SQLITE_ERROR] and a UTF8 error message copied from V up to the | |
4017 | ** first zero byte or until N bytes are read if N is positive. | |
4018 | ** | |
4019 | ** {F16415} The [sqlite3_result_error16(C,V,N)] interface changes the return | |
4020 | ** value of function C to be an exception with error code | |
4021 | ** [SQLITE_ERROR] and a UTF16 native byte order error message | |
4022 | ** copied from V up to the first zero terminator or until N bytes | |
4023 | ** are read if N is positive. | |
4024 | ** | |
4025 | ** {F16418} The [sqlite3_result_error_toobig(C)] interface changes the return | |
4026 | ** value of the function C to be an exception with error code | |
4027 | ** [SQLITE_TOOBIG] and an appropriate error message. | |
4028 | ** | |
4029 | ** {F16421} The [sqlite3_result_error_nomem(C)] interface changes the return | |
4030 | ** value of the function C to be an exception with error code | |
4031 | ** [SQLITE_NOMEM] and an appropriate error message. | |
4032 | ** | |
4033 | ** {F16424} The [sqlite3_result_error_code(C,E)] interface changes the return | |
4034 | ** value of the function C to be an exception with error code E. | |
4035 | ** The error message text is unchanged. | |
4036 | ** | |
4037 | ** {F16427} The [sqlite3_result_int(C,V)] interface changes the | |
4038 | ** return value of function C to be the 32-bit integer value V. | |
4039 | ** | |
4040 | ** {F16430} The [sqlite3_result_int64(C,V)] interface changes the | |
4041 | ** return value of function C to be the 64-bit integer value V. | |
4042 | ** | |
4043 | ** {F16433} The [sqlite3_result_null(C)] interface changes the | |
4044 | ** return value of function C to be NULL. | |
4045 | ** | |
4046 | ** {F16436} The [sqlite3_result_text(C,V,N,D)] interface changes the | |
4047 | ** return value of function C to be the UTF8 string | |
4048 | ** V up to the first zero if N is negative | |
4049 | ** or the first N bytes of V if N is non-negative. | |
4050 | ** | |
4051 | ** {F16439} The [sqlite3_result_text16(C,V,N,D)] interface changes the | |
4052 | ** return value of function C to be the UTF16 native byte order | |
4053 | ** string V up to the first zero if N is | |
4054 | ** negative or the first N bytes of V if N is non-negative. | |
4055 | ** | |
4056 | ** {F16442} The [sqlite3_result_text16be(C,V,N,D)] interface changes the | |
4057 | ** return value of function C to be the UTF16 big-endian | |
4058 | ** string V up to the first zero if N is | |
4059 | ** is negative or the first N bytes or V if N is non-negative. | |
4060 | ** | |
4061 | ** {F16445} The [sqlite3_result_text16le(C,V,N,D)] interface changes the | |
4062 | ** return value of function C to be the UTF16 little-endian | |
4063 | ** string V up to the first zero if N is | |
4064 | ** negative or the first N bytes of V if N is non-negative. | |
4065 | ** | |
4066 | ** {F16448} The [sqlite3_result_value(C,V)] interface changes the | |
4067 | ** return value of function C to be [unprotected sqlite3_value] | |
4068 | ** object V. | |
4069 | ** | |
4070 | ** {F16451} The [sqlite3_result_zeroblob(C,N)] interface changes the | |
4071 | ** return value of function C to be an N-byte blob of all zeros. | |
4072 | ** | |
4073 | ** {F16454} The [sqlite3_result_error()] and [sqlite3_result_error16()] | |
4074 | ** interfaces make a copy of their error message strings before | |
4075 | ** returning. | |
4076 | ** | |
4077 | ** {F16457} If the D destructor parameter to [sqlite3_result_blob(C,V,N,D)], | |
4078 | ** [sqlite3_result_text(C,V,N,D)], [sqlite3_result_text16(C,V,N,D)], | |
4079 | ** [sqlite3_result_text16be(C,V,N,D)], or | |
4080 | ** [sqlite3_result_text16le(C,V,N,D)] is the constant [SQLITE_STATIC] | |
4081 | ** then no destructor is ever called on the pointer V and SQLite | |
4082 | ** assumes that V is immutable. | |
4083 | ** | |
4084 | ** {F16460} If the D destructor parameter to [sqlite3_result_blob(C,V,N,D)], | |
4085 | ** [sqlite3_result_text(C,V,N,D)], [sqlite3_result_text16(C,V,N,D)], | |
4086 | ** [sqlite3_result_text16be(C,V,N,D)], or | |
4087 | ** [sqlite3_result_text16le(C,V,N,D)] is the constant | |
4088 | ** [SQLITE_TRANSIENT] then the interfaces makes a copy of the | |
4089 | ** content of V and retains the copy. | |
4090 | ** | |
4091 | ** {F16463} If the D destructor parameter to [sqlite3_result_blob(C,V,N,D)], | |
4092 | ** [sqlite3_result_text(C,V,N,D)], [sqlite3_result_text16(C,V,N,D)], | |
4093 | ** [sqlite3_result_text16be(C,V,N,D)], or | |
4094 | ** [sqlite3_result_text16le(C,V,N,D)] is some value other than | |
4095 | ** the constants [SQLITE_STATIC] and [SQLITE_TRANSIENT] then | |
4096 | ** SQLite will invoke the destructor D with V as its only argument | |
4097 | ** when it has finished with the V value. | |
4098 | */ | |
4099 | void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*)); | |
4100 | void sqlite3_result_double(sqlite3_context*, double); | |
4101 | void sqlite3_result_error(sqlite3_context*, const char*, int); | |
4102 | void sqlite3_result_error16(sqlite3_context*, const void*, int); | |
4103 | void sqlite3_result_error_toobig(sqlite3_context*); | |
4104 | void sqlite3_result_error_nomem(sqlite3_context*); | |
4105 | void sqlite3_result_error_code(sqlite3_context*, int); | |
4106 | void sqlite3_result_int(sqlite3_context*, int); | |
4107 | void sqlite3_result_int64(sqlite3_context*, sqlite3_int64); | |
4108 | void sqlite3_result_null(sqlite3_context*); | |
4109 | void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*)); | |
4110 | void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*)); | |
4111 | void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*)); | |
4112 | void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*)); | |
4113 | void sqlite3_result_value(sqlite3_context*, sqlite3_value*); | |
4114 | void sqlite3_result_zeroblob(sqlite3_context*, int n); | |
4115 | ||
4116 | /* | |
4117 | ** CAPI3REF: Define New Collating Sequences {F16600} | |
4118 | ** | |
4119 | ** These functions are used to add new collation sequences to the | |
4120 | ** [sqlite3*] handle specified as the first argument. | |
4121 | ** | |
4122 | ** The name of the new collation sequence is specified as a UTF-8 string | |
4123 | ** for sqlite3_create_collation() and sqlite3_create_collation_v2() | |
4124 | ** and a UTF-16 string for sqlite3_create_collation16(). In all cases | |
4125 | ** the name is passed as the second function argument. | |
4126 | ** | |
4127 | ** The third argument may be one of the constants [SQLITE_UTF8], | |
4128 | ** [SQLITE_UTF16LE] or [SQLITE_UTF16BE], indicating that the user-supplied | |
4129 | ** routine expects to be passed pointers to strings encoded using UTF-8, | |
4130 | ** UTF-16 little-endian or UTF-16 big-endian respectively. The | |
4131 | ** third argument might also be [SQLITE_UTF16_ALIGNED] to indicate that | |
4132 | ** the routine expects pointers to 16-bit word aligned strings | |
4133 | ** of UTF16 in the native byte order of the host computer. | |
4134 | ** | |
4135 | ** A pointer to the user supplied routine must be passed as the fifth | |
4136 | ** argument. If it is NULL, this is the same as deleting the collation | |
4137 | ** sequence (so that SQLite cannot call it anymore). | |
4138 | ** Each time the application | |
4139 | ** supplied function is invoked, it is passed a copy of the void* passed as | |
4140 | ** the fourth argument to sqlite3_create_collation() or | |
4141 | ** sqlite3_create_collation16() as its first parameter. | |
4142 | ** | |
4143 | ** The remaining arguments to the application-supplied routine are two strings, | |
4144 | ** each represented by a (length, data) pair and encoded in the encoding | |
4145 | ** that was passed as the third argument when the collation sequence was | |
4146 | ** registered. {END} The application defined collation routine should | |
4147 | ** return negative, zero or positive if | |
4148 | ** the first string is less than, equal to, or greater than the second | |
4149 | ** string. i.e. (STRING1 - STRING2). | |
4150 | ** | |
4151 | ** The sqlite3_create_collation_v2() works like sqlite3_create_collation() | |
4152 | ** excapt that it takes an extra argument which is a destructor for | |
4153 | ** the collation. The destructor is called when the collation is | |
4154 | ** destroyed and is passed a copy of the fourth parameter void* pointer | |
4155 | ** of the sqlite3_create_collation_v2(). | |
4156 | ** Collations are destroyed when | |
4157 | ** they are overridden by later calls to the collation creation functions | |
4158 | ** or when the [sqlite3*] database handle is closed using [sqlite3_close()]. | |
4159 | ** | |
4160 | ** INVARIANTS: | |
4161 | ** | |
4162 | ** {F16603} A successful call to the | |
4163 | ** [sqlite3_create_collation_v2(B,X,E,P,F,D)] interface | |
4164 | ** registers function F as the comparison function used to | |
4165 | ** implement collation X on [database connection] B for | |
4166 | ** databases having encoding E. | |
4167 | ** | |
4168 | ** {F16604} SQLite understands the X parameter to | |
4169 | ** [sqlite3_create_collation_v2(B,X,E,P,F,D)] as a zero-terminated | |
4170 | ** UTF-8 string in which case is ignored for ASCII characters and | |
4171 | ** is significant for non-ASCII characters. | |
4172 | ** | |
4173 | ** {F16606} Successive calls to [sqlite3_create_collation_v2(B,X,E,P,F,D)] | |
4174 | ** with the same values for B, X, and E, override prior values | |
4175 | ** of P, F, and D. | |
4176 | ** | |
4177 | ** {F16609} The destructor D in [sqlite3_create_collation_v2(B,X,E,P,F,D)] | |
4178 | ** is not NULL then it is called with argument P when the | |
4179 | ** collating function is dropped by SQLite. | |
4180 | ** | |
4181 | ** {F16612} A collating function is dropped when it is overloaded. | |
4182 | ** | |
4183 | ** {F16615} A collating function is dropped when the database connection | |
4184 | ** is closed using [sqlite3_close()]. | |
4185 | ** | |
4186 | ** {F16618} The pointer P in [sqlite3_create_collation_v2(B,X,E,P,F,D)] | |
4187 | ** is passed through as the first parameter to the comparison | |
4188 | ** function F for all subsequent invocations of F. | |
4189 | ** | |
4190 | ** {F16621} A call to [sqlite3_create_collation(B,X,E,P,F)] is exactly | |
4191 | ** the same as a call to [sqlite3_create_collation_v2()] with | |
4192 | ** the same parameters and a NULL destructor. | |
4193 | ** | |
4194 | ** {F16624} Following a [sqlite3_create_collation_v2(B,X,E,P,F,D)], | |
4195 | ** SQLite uses the comparison function F for all text comparison | |
4196 | ** operations on [database connection] B on text values that | |
4197 | ** use the collating sequence name X. | |
4198 | ** | |
4199 | ** {F16627} The [sqlite3_create_collation16(B,X,E,P,F)] works the same | |
4200 | ** as [sqlite3_create_collation(B,X,E,P,F)] except that the | |
4201 | ** collation name X is understood as UTF-16 in native byte order | |
4202 | ** instead of UTF-8. | |
4203 | ** | |
4204 | ** {F16630} When multiple comparison functions are available for the same | |
4205 | ** collating sequence, SQLite chooses the one whose text encoding | |
4206 | ** requires the least amount of conversion from the default | |
4207 | ** text encoding of the database. | |
4208 | */ | |
4209 | int sqlite3_create_collation( | |
4210 | sqlite3*, | |
4211 | const char *zName, | |
4212 | int eTextRep, | |
4213 | void*, | |
4214 | int(*xCompare)(void*,int,const void*,int,const void*) | |
4215 | ); | |
4216 | int sqlite3_create_collation_v2( | |
4217 | sqlite3*, | |
4218 | const char *zName, | |
4219 | int eTextRep, | |
4220 | void*, | |
4221 | int(*xCompare)(void*,int,const void*,int,const void*), | |
4222 | void(*xDestroy)(void*) | |
4223 | ); | |
4224 | int sqlite3_create_collation16( | |
4225 | sqlite3*, | |
4226 | const char *zName, | |
4227 | int eTextRep, | |
4228 | void*, | |
4229 | int(*xCompare)(void*,int,const void*,int,const void*) | |
4230 | ); | |
4231 | ||
4232 | /* | |
4233 | ** CAPI3REF: Collation Needed Callbacks {F16700} | |
4234 | ** | |
4235 | ** To avoid having to register all collation sequences before a database | |
4236 | ** can be used, a single callback function may be registered with the | |
4237 | ** database handle to be called whenever an undefined collation sequence is | |
4238 | ** required. | |
4239 | ** | |
4240 | ** If the function is registered using the sqlite3_collation_needed() API, | |
4241 | ** then it is passed the names of undefined collation sequences as strings | |
4242 | ** encoded in UTF-8. {F16703} If sqlite3_collation_needed16() is used, the names | |
4243 | ** are passed as UTF-16 in machine native byte order. A call to either | |
4244 | ** function replaces any existing callback. | |
4245 | ** | |
4246 | ** When the callback is invoked, the first argument passed is a copy | |
4247 | ** of the second argument to sqlite3_collation_needed() or | |
4248 | ** sqlite3_collation_needed16(). The second argument is the database | |
4249 | ** handle. The third argument is one of [SQLITE_UTF8], | |
4250 | ** [SQLITE_UTF16BE], or [SQLITE_UTF16LE], indicating the most | |
4251 | ** desirable form of the collation sequence function required. | |
4252 | ** The fourth parameter is the name of the | |
4253 | ** required collation sequence. | |
4254 | ** | |
4255 | ** The callback function should register the desired collation using | |
4256 | ** [sqlite3_create_collation()], [sqlite3_create_collation16()], or | |
4257 | ** [sqlite3_create_collation_v2()]. | |
4258 | ** | |
4259 | ** INVARIANTS: | |
4260 | ** | |
4261 | ** {F16702} A successful call to [sqlite3_collation_needed(D,P,F)] | |
4262 | ** or [sqlite3_collation_needed16(D,P,F)] causes | |
4263 | ** the [database connection] D to invoke callback F with first | |
4264 | ** parameter P whenever it needs a comparison function for a | |
4265 | ** collating sequence that it does not know about. | |
4266 | ** | |
4267 | ** {F16704} Each successful call to [sqlite3_collation_needed()] or | |
4268 | ** [sqlite3_collation_needed16()] overrides the callback registered | |
4269 | ** on the same [database connection] by prior calls to either | |
4270 | ** interface. | |
4271 | ** | |
4272 | ** {F16706} The name of the requested collating function passed in the | |
4273 | ** 4th parameter to the callback is in UTF-8 if the callback | |
4274 | ** was registered using [sqlite3_collation_needed()] and | |
4275 | ** is in UTF-16 native byte order if the callback was | |
4276 | ** registered using [sqlite3_collation_needed16()]. | |
4277 | ** | |
4278 | ** | |
4279 | */ | |
4280 | int sqlite3_collation_needed( | |
4281 | sqlite3*, | |
4282 | void*, | |
4283 | void(*)(void*,sqlite3*,int eTextRep,const char*) | |
4284 | ); | |
4285 | int sqlite3_collation_needed16( | |
4286 | sqlite3*, | |
4287 | void*, | |
4288 | void(*)(void*,sqlite3*,int eTextRep,const void*) | |
4289 | ); | |
4290 | ||
4291 | /* | |
4292 | ** Specify the key for an encrypted database. This routine should be | |
4293 | ** called right after sqlite3_open(). | |
4294 | ** | |
4295 | ** The code to implement this API is not available in the public release | |
4296 | ** of SQLite. | |
4297 | */ | |
4298 | int sqlite3_key( | |
4299 | sqlite3 *db, /* Database to be rekeyed */ | |
4300 | const void *pKey, int nKey /* The key */ | |
4301 | ); | |
4302 | ||
4303 | /* | |
4304 | ** Change the key on an open database. If the current database is not | |
4305 | ** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the | |
4306 | ** database is decrypted. | |
4307 | ** | |
4308 | ** The code to implement this API is not available in the public release | |
4309 | ** of SQLite. | |
4310 | */ | |
4311 | int sqlite3_rekey( | |
4312 | sqlite3 *db, /* Database to be rekeyed */ | |
4313 | const void *pKey, int nKey /* The new key */ | |
4314 | ); | |
4315 | ||
4316 | /* | |
4317 | ** CAPI3REF: Suspend Execution For A Short Time {F10530} | |
4318 | ** | |
4319 | ** The sqlite3_sleep() function | |
4320 | ** causes the current thread to suspend execution | |
4321 | ** for at least a number of milliseconds specified in its parameter. | |
4322 | ** | |
4323 | ** If the operating system does not support sleep requests with | |
4324 | ** millisecond time resolution, then the time will be rounded up to | |
4325 | ** the nearest second. The number of milliseconds of sleep actually | |
4326 | ** requested from the operating system is returned. | |
4327 | ** | |
4328 | ** SQLite implements this interface by calling the xSleep() | |
4329 | ** method of the default [sqlite3_vfs] object. | |
4330 | ** | |
4331 | ** INVARIANTS: | |
4332 | ** | |
4333 | ** {F10533} The [sqlite3_sleep(M)] interface invokes the xSleep | |
4334 | ** method of the default [sqlite3_vfs|VFS] in order to | |
4335 | ** suspend execution of the current thread for at least | |
4336 | ** M milliseconds. | |
4337 | ** | |
4338 | ** {F10536} The [sqlite3_sleep(M)] interface returns the number of | |
4339 | ** milliseconds of sleep actually requested of the operating | |
4340 | ** system, which might be larger than the parameter M. | |
4341 | */ | |
4342 | int sqlite3_sleep(int); | |
4343 | ||
4344 | /* | |
4345 | ** CAPI3REF: Name Of The Folder Holding Temporary Files {F10310} | |
4346 | ** | |
4347 | ** If this global variable is made to point to a string which is | |
4348 | ** the name of a folder (a.ka. directory), then all temporary files | |
4349 | ** created by SQLite will be placed in that directory. If this variable | |
4350 | ** is NULL pointer, then SQLite does a search for an appropriate temporary | |
4351 | ** file directory. | |
4352 | ** | |
4353 | ** It is not safe to modify this variable once a database connection | |
4354 | ** has been opened. It is intended that this variable be set once | |
4355 | ** as part of process initialization and before any SQLite interface | |
4356 | ** routines have been call and remain unchanged thereafter. | |
4357 | */ | |
4358 | SQLITE_EXTERN char *sqlite3_temp_directory; | |
4359 | ||
4360 | /* | |
4361 | ** CAPI3REF: Test To See If The Database Is In Auto-Commit Mode {F12930} | |
4362 | ** | |
4363 | ** The sqlite3_get_autocommit() interfaces returns non-zero or | |
4364 | ** zero if the given database connection is or is not in autocommit mode, | |
4365 | ** respectively. Autocommit mode is on | |
4366 | ** by default. Autocommit mode is disabled by a [BEGIN] statement. | |
4367 | ** Autocommit mode is reenabled by a [COMMIT] or [ROLLBACK]. | |
4368 | ** | |
4369 | ** If certain kinds of errors occur on a statement within a multi-statement | |
4370 | ** transactions (errors including [SQLITE_FULL], [SQLITE_IOERR], | |
4371 | ** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the | |
4372 | ** transaction might be rolled back automatically. The only way to | |
4373 | ** find out if SQLite automatically rolled back the transaction after | |
4374 | ** an error is to use this function. | |
4375 | ** | |
4376 | ** INVARIANTS: | |
4377 | ** | |
4378 | ** {F12931} The [sqlite3_get_autocommit(D)] interface returns non-zero or | |
4379 | ** zero if the [database connection] D is or is not in autocommit | |
4380 | ** mode, respectively. | |
4381 | ** | |
4382 | ** {F12932} Autocommit mode is on by default. | |
4383 | ** | |
4384 | ** {F12933} Autocommit mode is disabled by a successful [BEGIN] statement. | |
4385 | ** | |
4386 | ** {F12934} Autocommit mode is enabled by a successful [COMMIT] or [ROLLBACK] | |
4387 | ** statement. | |
4388 | ** | |
4389 | ** | |
4390 | ** LIMITATIONS: | |
4391 | *** | |
4392 | ** {U12936} If another thread changes the autocommit status of the database | |
4393 | ** connection while this routine is running, then the return value | |
4394 | ** is undefined. | |
4395 | */ | |
4396 | int sqlite3_get_autocommit(sqlite3*); | |
4397 | ||
4398 | /* | |
4399 | ** CAPI3REF: Find The Database Handle Of A Prepared Statement {F13120} | |
4400 | ** | |
4401 | ** The sqlite3_db_handle interface | |
4402 | ** returns the [sqlite3*] database handle to which a | |
4403 | ** [prepared statement] belongs. | |
4404 | ** The database handle returned by sqlite3_db_handle | |
4405 | ** is the same database handle that was | |
4406 | ** the first argument to the [sqlite3_prepare_v2()] or its variants | |
4407 | ** that was used to create the statement in the first place. | |
4408 | ** | |
4409 | ** INVARIANTS: | |
4410 | ** | |
4411 | ** {F13123} The [sqlite3_db_handle(S)] interface returns a pointer | |
4412 | ** to the [database connection] associated with | |
4413 | ** [prepared statement] S. | |
4414 | */ | |
4415 | sqlite3 *sqlite3_db_handle(sqlite3_stmt*); | |
4416 | ||
4417 | ||
4418 | /* | |
4419 | ** CAPI3REF: Commit And Rollback Notification Callbacks {F12950} | |
4420 | ** | |
4421 | ** The sqlite3_commit_hook() interface registers a callback | |
4422 | ** function to be invoked whenever a transaction is committed. | |
4423 | ** Any callback set by a previous call to sqlite3_commit_hook() | |
4424 | ** for the same database connection is overridden. | |
4425 | ** The sqlite3_rollback_hook() interface registers a callback | |
4426 | ** function to be invoked whenever a transaction is committed. | |
4427 | ** Any callback set by a previous call to sqlite3_commit_hook() | |
4428 | ** for the same database connection is overridden. | |
4429 | ** The pArg argument is passed through | |
4430 | ** to the callback. If the callback on a commit hook function | |
4431 | ** returns non-zero, then the commit is converted into a rollback. | |
4432 | ** | |
4433 | ** If another function was previously registered, its | |
4434 | ** pArg value is returned. Otherwise NULL is returned. | |
4435 | ** | |
4436 | ** Registering a NULL function disables the callback. | |
4437 | ** | |
4438 | ** For the purposes of this API, a transaction is said to have been | |
4439 | ** rolled back if an explicit "ROLLBACK" statement is executed, or | |
4440 | ** an error or constraint causes an implicit rollback to occur. | |
4441 | ** The rollback callback is not invoked if a transaction is | |
4442 | ** automatically rolled back because the database connection is closed. | |
4443 | ** The rollback callback is not invoked if a transaction is | |
4444 | ** rolled back because a commit callback returned non-zero. | |
4445 | ** <todo> Check on this </todo> | |
4446 | ** | |
4447 | ** These are experimental interfaces and are subject to change. | |
4448 | ** | |
4449 | ** INVARIANTS: | |
4450 | ** | |
4451 | ** {F12951} The [sqlite3_commit_hook(D,F,P)] interface registers the | |
4452 | ** callback function F to be invoked with argument P whenever | |
4453 | ** a transaction commits on [database connection] D. | |
4454 | ** | |
4455 | ** {F12952} The [sqlite3_commit_hook(D,F,P)] interface returns the P | |
4456 | ** argument from the previous call with the same | |
4457 | ** [database connection ] D , or NULL on the first call | |
4458 | ** for a particular [database connection] D. | |
4459 | ** | |
4460 | ** {F12953} Each call to [sqlite3_commit_hook()] overwrites the callback | |
4461 | ** registered by prior calls. | |
4462 | ** | |
4463 | ** {F12954} If the F argument to [sqlite3_commit_hook(D,F,P)] is NULL | |
4464 | ** then the commit hook callback is cancelled and no callback | |
4465 | ** is invoked when a transaction commits. | |
4466 | ** | |
4467 | ** {F12955} If the commit callback returns non-zero then the commit is | |
4468 | ** converted into a rollback. | |
4469 | ** | |
4470 | ** {F12961} The [sqlite3_rollback_hook(D,F,P)] interface registers the | |
4471 | ** callback function F to be invoked with argument P whenever | |
4472 | ** a transaction rolls back on [database connection] D. | |
4473 | ** | |
4474 | ** {F12962} The [sqlite3_rollback_hook(D,F,P)] interface returns the P | |
4475 | ** argument from the previous call with the same | |
4476 | ** [database connection ] D , or NULL on the first call | |
4477 | ** for a particular [database connection] D. | |
4478 | ** | |
4479 | ** {F12963} Each call to [sqlite3_rollback_hook()] overwrites the callback | |
4480 | ** registered by prior calls. | |
4481 | ** | |
4482 | ** {F12964} If the F argument to [sqlite3_rollback_hook(D,F,P)] is NULL | |
4483 | ** then the rollback hook callback is cancelled and no callback | |
4484 | ** is invoked when a transaction rolls back. | |
4485 | */ | |
4486 | void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*); | |
4487 | void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*); | |
4488 | ||
4489 | /* | |
4490 | ** CAPI3REF: Data Change Notification Callbacks {F12970} | |
4491 | ** | |
4492 | ** The sqlite3_update_hook() interface | |
4493 | ** registers a callback function with the database connection identified by the | |
4494 | ** first argument to be invoked whenever a row is updated, inserted or deleted. | |
4495 | ** Any callback set by a previous call to this function for the same | |
4496 | ** database connection is overridden. | |
4497 | ** | |
4498 | ** The second argument is a pointer to the function to invoke when a | |
4499 | ** row is updated, inserted or deleted. | |
4500 | ** The first argument to the callback is | |
4501 | ** a copy of the third argument to sqlite3_update_hook(). | |
4502 | ** The second callback | |
4503 | ** argument is one of [SQLITE_INSERT], [SQLITE_DELETE] or [SQLITE_UPDATE], | |
4504 | ** depending on the operation that caused the callback to be invoked. | |
4505 | ** The third and | |
4506 | ** fourth arguments to the callback contain pointers to the database and | |
4507 | ** table name containing the affected row. | |
4508 | ** The final callback parameter is | |
4509 | ** the rowid of the row. | |
4510 | ** In the case of an update, this is the rowid after | |
4511 | ** the update takes place. | |
4512 | ** | |
4513 | ** The update hook is not invoked when internal system tables are | |
4514 | ** modified (i.e. sqlite_master and sqlite_sequence). | |
4515 | ** | |
4516 | ** If another function was previously registered, its pArg value | |
4517 | ** is returned. Otherwise NULL is returned. | |
4518 | ** | |
4519 | ** INVARIANTS: | |
4520 | ** | |
4521 | ** {F12971} The [sqlite3_update_hook(D,F,P)] interface causes callback | |
4522 | ** function F to be invoked with first parameter P whenever | |
4523 | ** a table row is modified, inserted, or deleted on | |
4524 | ** [database connection] D. | |
4525 | ** | |
4526 | ** {F12973} The [sqlite3_update_hook(D,F,P)] interface returns the value | |
4527 | ** of P for the previous call on the same [database connection] D, | |
4528 | ** or NULL for the first call. | |
4529 | ** | |
4530 | ** {F12975} If the update hook callback F in [sqlite3_update_hook(D,F,P)] | |
4531 | ** is NULL then the no update callbacks are made. | |
4532 | ** | |
4533 | ** {F12977} Each call to [sqlite3_update_hook(D,F,P)] overrides prior calls | |
4534 | ** to the same interface on the same [database connection] D. | |
4535 | ** | |
4536 | ** {F12979} The update hook callback is not invoked when internal system | |
4537 | ** tables such as sqlite_master and sqlite_sequence are modified. | |
4538 | ** | |
4539 | ** {F12981} The second parameter to the update callback | |
4540 | ** is one of [SQLITE_INSERT], [SQLITE_DELETE] or [SQLITE_UPDATE], | |
4541 | ** depending on the operation that caused the callback to be invoked. | |
4542 | ** | |
4543 | ** {F12983} The third and fourth arguments to the callback contain pointers | |
4544 | ** to zero-terminated UTF-8 strings which are the names of the | |
4545 | ** database and table that is being updated. | |
4546 | ||
4547 | ** {F12985} The final callback parameter is the rowid of the row after | |
4548 | ** the change occurs. | |
4549 | */ | |
4550 | void *sqlite3_update_hook( | |
4551 | sqlite3*, | |
4552 | void(*)(void *,int ,char const *,char const *,sqlite3_int64), | |
4553 | void* | |
4554 | ); | |
4555 | ||
4556 | /* | |
4557 | ** CAPI3REF: Enable Or Disable Shared Pager Cache {F10330} | |
4558 | ** | |
4559 | ** This routine enables or disables the sharing of the database cache | |
4560 | ** and schema data structures between connections to the same database. | |
4561 | ** Sharing is enabled if the argument is true and disabled if the argument | |
4562 | ** is false. | |
4563 | ** | |
4564 | ** Cache sharing is enabled and disabled | |
4565 | ** for an entire process. {END} This is a change as of SQLite version 3.5.0. | |
4566 | ** In prior versions of SQLite, sharing was | |
4567 | ** enabled or disabled for each thread separately. | |
4568 | ** | |
4569 | ** The cache sharing mode set by this interface effects all subsequent | |
4570 | ** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()]. | |
4571 | ** Existing database connections continue use the sharing mode | |
4572 | ** that was in effect at the time they were opened. | |
4573 | ** | |
4574 | ** Virtual tables cannot be used with a shared cache. When shared | |
4575 | ** cache is enabled, the [sqlite3_create_module()] API used to register | |
4576 | ** virtual tables will always return an error. | |
4577 | ** | |
4578 | ** This routine returns [SQLITE_OK] if shared cache was | |
4579 | ** enabled or disabled successfully. An [error code] | |
4580 | ** is returned otherwise. | |
4581 | ** | |
4582 | ** Shared cache is disabled by default. But this might change in | |
4583 | ** future releases of SQLite. Applications that care about shared | |
4584 | ** cache setting should set it explicitly. | |
4585 | ** | |
4586 | ** INVARIANTS: | |
4587 | ** | |
4588 | ** {F10331} A successful invocation of [sqlite3_enable_shared_cache(B)] | |
4589 | ** will enable or disable shared cache mode for any subsequently | |
4590 | ** created [database connection] in the same process. | |
4591 | ** | |
4592 | ** {F10336} When shared cache is enabled, the [sqlite3_create_module()] | |
4593 | ** interface will always return an error. | |
4594 | ** | |
4595 | ** {F10337} The [sqlite3_enable_shared_cache(B)] interface returns | |
4596 | ** [SQLITE_OK] if shared cache was enabled or disabled successfully. | |
4597 | ** | |
4598 | ** {F10339} Shared cache is disabled by default. | |
4599 | */ | |
4600 | int sqlite3_enable_shared_cache(int); | |
4601 | ||
4602 | /* | |
4603 | ** CAPI3REF: Attempt To Free Heap Memory {F17340} | |
4604 | ** | |
4605 | ** The sqlite3_release_memory() interface attempts to | |
4606 | ** free N bytes of heap memory by deallocating non-essential memory | |
4607 | ** allocations held by the database labrary. {END} Memory used | |
4608 | ** to cache database pages to improve performance is an example of | |
4609 | ** non-essential memory. Sqlite3_release_memory() returns | |
4610 | ** the number of bytes actually freed, which might be more or less | |
4611 | ** than the amount requested. | |
4612 | ** | |
4613 | ** INVARIANTS: | |
4614 | ** | |
4615 | ** {F17341} The [sqlite3_release_memory(N)] interface attempts to | |
4616 | ** free N bytes of heap memory by deallocating non-essential | |
4617 | ** memory allocations held by the database labrary. | |
4618 | ** | |
4619 | ** {F16342} The [sqlite3_release_memory(N)] returns the number | |
4620 | ** of bytes actually freed, which might be more or less | |
4621 | ** than the amount requested. | |
4622 | */ | |
4623 | int sqlite3_release_memory(int); | |
4624 | ||
4625 | /* | |
4626 | ** CAPI3REF: Impose A Limit On Heap Size {F17350} | |
4627 | ** | |
4628 | ** The sqlite3_soft_heap_limit() interface | |
4629 | ** places a "soft" limit on the amount of heap memory that may be allocated | |
4630 | ** by SQLite. If an internal allocation is requested | |
4631 | ** that would exceed the soft heap limit, [sqlite3_release_memory()] is | |
4632 | ** invoked one or more times to free up some space before the allocation | |
4633 | ** is made. | |
4634 | ** | |
4635 | ** The limit is called "soft", because if | |
4636 | ** [sqlite3_release_memory()] cannot | |
4637 | ** free sufficient memory to prevent the limit from being exceeded, | |
4638 | ** the memory is allocated anyway and the current operation proceeds. | |
4639 | ** | |
4640 | ** A negative or zero value for N means that there is no soft heap limit and | |
4641 | ** [sqlite3_release_memory()] will only be called when memory is exhausted. | |
4642 | ** The default value for the soft heap limit is zero. | |
4643 | ** | |
4644 | ** SQLite makes a best effort to honor the soft heap limit. | |
4645 | ** But if the soft heap limit cannot honored, execution will | |
4646 | ** continue without error or notification. This is why the limit is | |
4647 | ** called a "soft" limit. It is advisory only. | |
4648 | ** | |
4649 | ** Prior to SQLite version 3.5.0, this routine only constrained the memory | |
4650 | ** allocated by a single thread - the same thread in which this routine | |
4651 | ** runs. Beginning with SQLite version 3.5.0, the soft heap limit is | |
4652 | ** applied to all threads. The value specified for the soft heap limit | |
4653 | ** is an upper bound on the total memory allocation for all threads. In | |
4654 | ** version 3.5.0 there is no mechanism for limiting the heap usage for | |
4655 | ** individual threads. | |
4656 | ** | |
4657 | ** INVARIANTS: | |
4658 | ** | |
4659 | ** {F16351} The [sqlite3_soft_heap_limit(N)] interface places a soft limit | |
4660 | ** of N bytes on the amount of heap memory that may be allocated | |
4661 | ** using [sqlite3_malloc()] or [sqlite3_realloc()] at any point | |
4662 | ** in time. | |
4663 | ** | |
4664 | ** {F16352} If a call to [sqlite3_malloc()] or [sqlite3_realloc()] would | |
4665 | ** cause the total amount of allocated memory to exceed the | |
4666 | ** soft heap limit, then [sqlite3_release_memory()] is invoked | |
4667 | ** in an attempt to reduce the memory usage prior to proceeding | |
4668 | ** with the memory allocation attempt. | |
4669 | ** | |
4670 | ** {F16353} Calls to [sqlite3_malloc()] or [sqlite3_realloc()] that trigger | |
4671 | ** attempts to reduce memory usage through the soft heap limit | |
4672 | ** mechanism continue even if the attempt to reduce memory | |
4673 | ** usage is unsuccessful. | |
4674 | ** | |
4675 | ** {F16354} A negative or zero value for N in a call to | |
4676 | ** [sqlite3_soft_heap_limit(N)] means that there is no soft | |
4677 | ** heap limit and [sqlite3_release_memory()] will only be | |
4678 | ** called when memory is completely exhausted. | |
4679 | ** | |
4680 | ** {F16355} The default value for the soft heap limit is zero. | |
4681 | ** | |
4682 | ** {F16358} Each call to [sqlite3_soft_heap_limit(N)] overrides the | |
4683 | ** values set by all prior calls. | |
4684 | */ | |
4685 | void sqlite3_soft_heap_limit(int); | |
4686 | ||
4687 | /* | |
4688 | ** CAPI3REF: Extract Metadata About A Column Of A Table {F12850} | |
4689 | ** | |
4690 | ** This routine | |
4691 | ** returns meta-data about a specific column of a specific database | |
4692 | ** table accessible using the connection handle passed as the first function | |
4693 | ** argument. | |
4694 | ** | |
4695 | ** The column is identified by the second, third and fourth parameters to | |
4696 | ** this function. The second parameter is either the name of the database | |
4697 | ** (i.e. "main", "temp" or an attached database) containing the specified | |
4698 | ** table or NULL. If it is NULL, then all attached databases are searched | |
4699 | ** for the table using the same algorithm as the database engine uses to | |
4700 | ** resolve unqualified table references. | |
4701 | ** | |
4702 | ** The third and fourth parameters to this function are the table and column | |
4703 | ** name of the desired column, respectively. Neither of these parameters | |
4704 | ** may be NULL. | |
4705 | ** | |
4706 | ** Meta information is returned by writing to the memory locations passed as | |
4707 | ** the 5th and subsequent parameters to this function. Any of these | |
4708 | ** arguments may be NULL, in which case the corresponding element of meta | |
4709 | ** information is ommitted. | |
4710 | ** | |
4711 | ** <pre> | |
4712 | ** Parameter Output Type Description | |
4713 | ** ----------------------------------- | |
4714 | ** | |
4715 | ** 5th const char* Data type | |
4716 | ** 6th const char* Name of the default collation sequence | |
4717 | ** 7th int True if the column has a NOT NULL constraint | |
4718 | ** 8th int True if the column is part of the PRIMARY KEY | |
4719 | ** 9th int True if the column is AUTOINCREMENT | |
4720 | ** </pre> | |
4721 | ** | |
4722 | ** | |
4723 | ** The memory pointed to by the character pointers returned for the | |
4724 | ** declaration type and collation sequence is valid only until the next | |
4725 | ** call to any sqlite API function. | |
4726 | ** | |
4727 | ** If the specified table is actually a view, then an error is returned. | |
4728 | ** | |
4729 | ** If the specified column is "rowid", "oid" or "_rowid_" and an | |
4730 | ** INTEGER PRIMARY KEY column has been explicitly declared, then the output | |
4731 | ** parameters are set for the explicitly declared column. If there is no | |
4732 | ** explicitly declared IPK column, then the output parameters are set as | |
4733 | ** follows: | |
4734 | ** | |
4735 | ** <pre> | |
4736 | ** data type: "INTEGER" | |
4737 | ** collation sequence: "BINARY" | |
4738 | ** not null: 0 | |
4739 | ** primary key: 1 | |
4740 | ** auto increment: 0 | |
4741 | ** </pre> | |
4742 | ** | |
4743 | ** This function may load one or more schemas from database files. If an | |
4744 | ** error occurs during this process, or if the requested table or column | |
4745 | ** cannot be found, an SQLITE error code is returned and an error message | |
4746 | ** left in the database handle (to be retrieved using sqlite3_errmsg()). | |
4747 | ** | |
4748 | ** This API is only available if the library was compiled with the | |
4749 | ** SQLITE_ENABLE_COLUMN_METADATA preprocessor symbol defined. | |
4750 | */ | |
4751 | int sqlite3_table_column_metadata( | |
4752 | sqlite3 *db, /* Connection handle */ | |
4753 | const char *zDbName, /* Database name or NULL */ | |
4754 | const char *zTableName, /* Table name */ | |
4755 | const char *zColumnName, /* Column name */ | |
4756 | char const **pzDataType, /* OUTPUT: Declared data type */ | |
4757 | char const **pzCollSeq, /* OUTPUT: Collation sequence name */ | |
4758 | int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */ | |
4759 | int *pPrimaryKey, /* OUTPUT: True if column part of PK */ | |
4760 | int *pAutoinc /* OUTPUT: True if column is auto-increment */ | |
4761 | ); | |
4762 | ||
4763 | /* | |
4764 | ** CAPI3REF: Load An Extension {F12600} | |
4765 | ** | |
4766 | ** {F12601} The sqlite3_load_extension() interface | |
4767 | ** attempts to load an SQLite extension library contained in the file | |
4768 | ** zFile. {F12602} The entry point is zProc. {F12603} zProc may be 0 | |
4769 | ** in which case the name of the entry point defaults | |
4770 | ** to "sqlite3_extension_init". | |
4771 | ** | |
4772 | ** {F12604} The sqlite3_load_extension() interface shall | |
4773 | ** return [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong. | |
4774 | ** | |
4775 | ** {F12605} | |
4776 | ** If an error occurs and pzErrMsg is not 0, then the | |
4777 | ** sqlite3_load_extension() interface shall attempt to fill *pzErrMsg with | |
4778 | ** error message text stored in memory obtained from [sqlite3_malloc()]. | |
4779 | ** {END} The calling function should free this memory | |
4780 | ** by calling [sqlite3_free()]. | |
4781 | ** | |
4782 | ** {F12606} | |
4783 | ** Extension loading must be enabled using [sqlite3_enable_load_extension()] | |
4784 | ** prior to calling this API or an error will be returned. | |
4785 | */ | |
4786 | int sqlite3_load_extension( | |
4787 | sqlite3 *db, /* Load the extension into this database connection */ | |
4788 | const char *zFile, /* Name of the shared library containing extension */ | |
4789 | const char *zProc, /* Entry point. Derived from zFile if 0 */ | |
4790 | char **pzErrMsg /* Put error message here if not 0 */ | |
4791 | ); | |
4792 | ||
4793 | /* | |
4794 | ** CAPI3REF: Enable Or Disable Extension Loading {F12620} | |
4795 | ** | |
4796 | ** So as not to open security holes in older applications that are | |
4797 | ** unprepared to deal with extension loading, and as a means of disabling | |
4798 | ** extension loading while evaluating user-entered SQL, the following | |
4799 | ** API is provided to turn the [sqlite3_load_extension()] mechanism on and | |
4800 | ** off. {F12622} It is off by default. {END} See ticket #1863. | |
4801 | ** | |
4802 | ** {F12621} Call the sqlite3_enable_load_extension() routine | |
4803 | ** with onoff==1 to turn extension loading on | |
4804 | ** and call it with onoff==0 to turn it back off again. {END} | |
4805 | */ | |
4806 | int sqlite3_enable_load_extension(sqlite3 *db, int onoff); | |
4807 | ||
4808 | /* | |
4809 | ** CAPI3REF: Make Arrangements To Automatically Load An Extension {F12640} | |
4810 | ** | |
4811 | ** {F12641} This function | |
4812 | ** registers an extension entry point that is automatically invoked | |
4813 | ** whenever a new database connection is opened using | |
4814 | ** [sqlite3_open()], [sqlite3_open16()], or [sqlite3_open_v2()]. {END} | |
4815 | ** | |
4816 | ** This API can be invoked at program startup in order to register | |
4817 | ** one or more statically linked extensions that will be available | |
4818 | ** to all new database connections. | |
4819 | ** | |
4820 | ** {F12642} Duplicate extensions are detected so calling this routine multiple | |
4821 | ** times with the same extension is harmless. | |
4822 | ** | |
4823 | ** {F12643} This routine stores a pointer to the extension in an array | |
4824 | ** that is obtained from sqlite_malloc(). {END} If you run a memory leak | |
4825 | ** checker on your program and it reports a leak because of this | |
4826 | ** array, then invoke [sqlite3_reset_auto_extension()] prior | |
4827 | ** to shutdown to free the memory. | |
4828 | ** | |
4829 | ** {F12644} Automatic extensions apply across all threads. {END} | |
4830 | ** | |
4831 | ** This interface is experimental and is subject to change or | |
4832 | ** removal in future releases of SQLite. | |
4833 | */ | |
4834 | int sqlite3_auto_extension(void *xEntryPoint); | |
4835 | ||
4836 | ||
4837 | /* | |
4838 | ** CAPI3REF: Reset Automatic Extension Loading {F12660} | |
4839 | ** | |
4840 | ** {F12661} This function disables all previously registered | |
4841 | ** automatic extensions. {END} This | |
4842 | ** routine undoes the effect of all prior [sqlite3_auto_extension()] | |
4843 | ** calls. | |
4844 | ** | |
4845 | ** {F12662} This call disabled automatic extensions in all threads. {END} | |
4846 | ** | |
4847 | ** This interface is experimental and is subject to change or | |
4848 | ** removal in future releases of SQLite. | |
4849 | */ | |
4850 | void sqlite3_reset_auto_extension(void); | |
4851 | ||
4852 | ||
4853 | /* | |
4854 | ****** EXPERIMENTAL - subject to change without notice ************** | |
4855 | ** | |
4856 | ** The interface to the virtual-table mechanism is currently considered | |
4857 | ** to be experimental. The interface might change in incompatible ways. | |
4858 | ** If this is a problem for you, do not use the interface at this time. | |
4859 | ** | |
4860 | ** When the virtual-table mechanism stablizes, we will declare the | |
4861 | ** interface fixed, support it indefinitely, and remove this comment. | |
4862 | */ | |
4863 | ||
4864 | /* | |
4865 | ** Structures used by the virtual table interface | |
4866 | */ | |
4867 | typedef struct sqlite3_vtab sqlite3_vtab; | |
4868 | typedef struct sqlite3_index_info sqlite3_index_info; | |
4869 | typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor; | |
4870 | typedef struct sqlite3_module sqlite3_module; | |
4871 | ||
4872 | /* | |
4873 | ** CAPI3REF: Virtual Table Object {F18000} | |
4874 | ** KEYWORDS: sqlite3_module | |
4875 | ** | |
4876 | ** A module is a class of virtual tables. Each module is defined | |
4877 | ** by an instance of the following structure. This structure consists | |
4878 | ** mostly of methods for the module. | |
4879 | */ | |
4880 | struct sqlite3_module { | |
4881 | int iVersion; | |
4882 | int (*xCreate)(sqlite3*, void *pAux, | |
4883 | int argc, const char *const*argv, | |
4884 | sqlite3_vtab **ppVTab, char**); | |
4885 | int (*xConnect)(sqlite3*, void *pAux, | |
4886 | int argc, const char *const*argv, | |
4887 | sqlite3_vtab **ppVTab, char**); | |
4888 | int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*); | |
4889 | int (*xDisconnect)(sqlite3_vtab *pVTab); | |
4890 | int (*xDestroy)(sqlite3_vtab *pVTab); | |
4891 | int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor); | |
4892 | int (*xClose)(sqlite3_vtab_cursor*); | |
4893 | int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr, | |
4894 | int argc, sqlite3_value **argv); | |
4895 | int (*xNext)(sqlite3_vtab_cursor*); | |
4896 | int (*xEof)(sqlite3_vtab_cursor*); | |
4897 | int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int); | |
4898 | int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid); | |
4899 | int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *); | |
4900 | int (*xBegin)(sqlite3_vtab *pVTab); | |
4901 | int (*xSync)(sqlite3_vtab *pVTab); | |
4902 | int (*xCommit)(sqlite3_vtab *pVTab); | |
4903 | int (*xRollback)(sqlite3_vtab *pVTab); | |
4904 | int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName, | |
4905 | void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), | |
4906 | void **ppArg); | |
4907 | ||
4908 | int (*xRename)(sqlite3_vtab *pVtab, const char *zNew); | |
4909 | }; | |
4910 | ||
4911 | /* | |
4912 | ** CAPI3REF: Virtual Table Indexing Information {F18100} | |
4913 | ** KEYWORDS: sqlite3_index_info | |
4914 | ** | |
4915 | ** The sqlite3_index_info structure and its substructures is used to | |
4916 | ** pass information into and receive the reply from the xBestIndex | |
4917 | ** method of an sqlite3_module. The fields under **Inputs** are the | |
4918 | ** inputs to xBestIndex and are read-only. xBestIndex inserts its | |
4919 | ** results into the **Outputs** fields. | |
4920 | ** | |
4921 | ** The aConstraint[] array records WHERE clause constraints of the | |
4922 | ** form: | |
4923 | ** | |
4924 | ** column OP expr | |
4925 | ** | |
4926 | ** Where OP is =, <, <=, >, or >=. | |
4927 | ** The particular operator is stored | |
4928 | ** in aConstraint[].op. The index of the column is stored in | |
4929 | ** aConstraint[].iColumn. aConstraint[].usable is TRUE if the | |
4930 | ** expr on the right-hand side can be evaluated (and thus the constraint | |
4931 | ** is usable) and false if it cannot. | |
4932 | ** | |
4933 | ** The optimizer automatically inverts terms of the form "expr OP column" | |
4934 | ** and makes other simplifications to the WHERE clause in an attempt to | |
4935 | ** get as many WHERE clause terms into the form shown above as possible. | |
4936 | ** The aConstraint[] array only reports WHERE clause terms in the correct | |
4937 | ** form that refer to the particular virtual table being queried. | |
4938 | ** | |
4939 | ** Information about the ORDER BY clause is stored in aOrderBy[]. | |
4940 | ** Each term of aOrderBy records a column of the ORDER BY clause. | |
4941 | ** | |
4942 | ** The xBestIndex method must fill aConstraintUsage[] with information | |
4943 | ** about what parameters to pass to xFilter. If argvIndex>0 then | |
4944 | ** the right-hand side of the corresponding aConstraint[] is evaluated | |
4945 | ** and becomes the argvIndex-th entry in argv. If aConstraintUsage[].omit | |
4946 | ** is true, then the constraint is assumed to be fully handled by the | |
4947 | ** virtual table and is not checked again by SQLite. | |
4948 | ** | |
4949 | ** The idxNum and idxPtr values are recorded and passed into xFilter. | |
4950 | ** sqlite3_free() is used to free idxPtr if needToFreeIdxPtr is true. | |
4951 | ** | |
4952 | ** The orderByConsumed means that output from xFilter will occur in | |
4953 | ** the correct order to satisfy the ORDER BY clause so that no separate | |
4954 | ** sorting step is required. | |
4955 | ** | |
4956 | ** The estimatedCost value is an estimate of the cost of doing the | |
4957 | ** particular lookup. A full scan of a table with N entries should have | |
4958 | ** a cost of N. A binary search of a table of N entries should have a | |
4959 | ** cost of approximately log(N). | |
4960 | */ | |
4961 | struct sqlite3_index_info { | |
4962 | /* Inputs */ | |
4963 | int nConstraint; /* Number of entries in aConstraint */ | |
4964 | struct sqlite3_index_constraint { | |
4965 | int iColumn; /* Column on left-hand side of constraint */ | |
4966 | unsigned char op; /* Constraint operator */ | |
4967 | unsigned char usable; /* True if this constraint is usable */ | |
4968 | int iTermOffset; /* Used internally - xBestIndex should ignore */ | |
4969 | } *aConstraint; /* Table of WHERE clause constraints */ | |
4970 | int nOrderBy; /* Number of terms in the ORDER BY clause */ | |
4971 | struct sqlite3_index_orderby { | |
4972 | int iColumn; /* Column number */ | |
4973 | unsigned char desc; /* True for DESC. False for ASC. */ | |
4974 | } *aOrderBy; /* The ORDER BY clause */ | |
4975 | ||
4976 | /* Outputs */ | |
4977 | struct sqlite3_index_constraint_usage { | |
4978 | int argvIndex; /* if >0, constraint is part of argv to xFilter */ | |
4979 | unsigned char omit; /* Do not code a test for this constraint */ | |
4980 | } *aConstraintUsage; | |
4981 | int idxNum; /* Number used to identify the index */ | |
4982 | char *idxStr; /* String, possibly obtained from sqlite3_malloc */ | |
4983 | int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ | |
4984 | int orderByConsumed; /* True if output is already ordered */ | |
4985 | double estimatedCost; /* Estimated cost of using this index */ | |
4986 | }; | |
4987 | #define SQLITE_INDEX_CONSTRAINT_EQ 2 | |
4988 | #define SQLITE_INDEX_CONSTRAINT_GT 4 | |
4989 | #define SQLITE_INDEX_CONSTRAINT_LE 8 | |
4990 | #define SQLITE_INDEX_CONSTRAINT_LT 16 | |
4991 | #define SQLITE_INDEX_CONSTRAINT_GE 32 | |
4992 | #define SQLITE_INDEX_CONSTRAINT_MATCH 64 | |
4993 | ||
4994 | /* | |
4995 | ** CAPI3REF: Register A Virtual Table Implementation {F18200} | |
4996 | ** | |
4997 | ** This routine is used to register a new module name with an SQLite | |
4998 | ** connection. Module names must be registered before creating new | |
4999 | ** virtual tables on the module, or before using preexisting virtual | |
5000 | ** tables of the module. | |
5001 | */ | |
5002 | int sqlite3_create_module( | |
5003 | sqlite3 *db, /* SQLite connection to register module with */ | |
5004 | const char *zName, /* Name of the module */ | |
5005 | const sqlite3_module *, /* Methods for the module */ | |
5006 | void * /* Client data for xCreate/xConnect */ | |
5007 | ); | |
5008 | ||
5009 | /* | |
5010 | ** CAPI3REF: Register A Virtual Table Implementation {F18210} | |
5011 | ** | |
5012 | ** This routine is identical to the sqlite3_create_module() method above, | |
5013 | ** except that it allows a destructor function to be specified. It is | |
5014 | ** even more experimental than the rest of the virtual tables API. | |
5015 | */ | |
5016 | int sqlite3_create_module_v2( | |
5017 | sqlite3 *db, /* SQLite connection to register module with */ | |
5018 | const char *zName, /* Name of the module */ | |
5019 | const sqlite3_module *, /* Methods for the module */ | |
5020 | void *, /* Client data for xCreate/xConnect */ | |
5021 | void(*xDestroy)(void*) /* Module destructor function */ | |
5022 | ); | |
5023 | ||
5024 | /* | |
5025 | ** CAPI3REF: Virtual Table Instance Object {F18010} | |
5026 | ** KEYWORDS: sqlite3_vtab | |
5027 | ** | |
5028 | ** Every module implementation uses a subclass of the following structure | |
5029 | ** to describe a particular instance of the module. Each subclass will | |
5030 | ** be tailored to the specific needs of the module implementation. The | |
5031 | ** purpose of this superclass is to define certain fields that are common | |
5032 | ** to all module implementations. | |
5033 | ** | |
5034 | ** Virtual tables methods can set an error message by assigning a | |
5035 | ** string obtained from sqlite3_mprintf() to zErrMsg. The method should | |
5036 | ** take care that any prior string is freed by a call to sqlite3_free() | |
5037 | ** prior to assigning a new string to zErrMsg. After the error message | |
5038 | ** is delivered up to the client application, the string will be automatically | |
5039 | ** freed by sqlite3_free() and the zErrMsg field will be zeroed. Note | |
5040 | ** that sqlite3_mprintf() and sqlite3_free() are used on the zErrMsg field | |
5041 | ** since virtual tables are commonly implemented in loadable extensions which | |
5042 | ** do not have access to sqlite3MPrintf() or sqlite3Free(). | |
5043 | */ | |
5044 | struct sqlite3_vtab { | |
5045 | const sqlite3_module *pModule; /* The module for this virtual table */ | |
5046 | int nRef; /* Used internally */ | |
5047 | char *zErrMsg; /* Error message from sqlite3_mprintf() */ | |
5048 | /* Virtual table implementations will typically add additional fields */ | |
5049 | }; | |
5050 | ||
5051 | /* | |
5052 | ** CAPI3REF: Virtual Table Cursor Object {F18020} | |
5053 | ** KEYWORDS: sqlite3_vtab_cursor | |
5054 | ** | |
5055 | ** Every module implementation uses a subclass of the following structure | |
5056 | ** to describe cursors that point into the virtual table and are used | |
5057 | ** to loop through the virtual table. Cursors are created using the | |
5058 | ** xOpen method of the module. Each module implementation will define | |
5059 | ** the content of a cursor structure to suit its own needs. | |
5060 | ** | |
5061 | ** This superclass exists in order to define fields of the cursor that | |
5062 | ** are common to all implementations. | |
5063 | */ | |
5064 | struct sqlite3_vtab_cursor { | |
5065 | sqlite3_vtab *pVtab; /* Virtual table of this cursor */ | |
5066 | /* Virtual table implementations will typically add additional fields */ | |
5067 | }; | |
5068 | ||
5069 | /* | |
5070 | ** CAPI3REF: Declare The Schema Of A Virtual Table {F18280} | |
5071 | ** | |
5072 | ** The xCreate and xConnect methods of a module use the following API | |
5073 | ** to declare the format (the names and datatypes of the columns) of | |
5074 | ** the virtual tables they implement. | |
5075 | */ | |
5076 | int sqlite3_declare_vtab(sqlite3*, const char *zCreateTable); | |
5077 | ||
5078 | /* | |
5079 | ** CAPI3REF: Overload A Function For A Virtual Table {F18300} | |
5080 | ** | |
5081 | ** Virtual tables can provide alternative implementations of functions | |
5082 | ** using the xFindFunction method. But global versions of those functions | |
5083 | ** must exist in order to be overloaded. | |
5084 | ** | |
5085 | ** This API makes sure a global version of a function with a particular | |
5086 | ** name and number of parameters exists. If no such function exists | |
5087 | ** before this API is called, a new function is created. The implementation | |
5088 | ** of the new function always causes an exception to be thrown. So | |
5089 | ** the new function is not good for anything by itself. Its only | |
5090 | ** purpose is to be a place-holder function that can be overloaded | |
5091 | ** by virtual tables. | |
5092 | ** | |
5093 | ** This API should be considered part of the virtual table interface, | |
5094 | ** which is experimental and subject to change. | |
5095 | */ | |
5096 | int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg); | |
5097 | ||
5098 | /* | |
5099 | ** The interface to the virtual-table mechanism defined above (back up | |
5100 | ** to a comment remarkably similar to this one) is currently considered | |
5101 | ** to be experimental. The interface might change in incompatible ways. | |
5102 | ** If this is a problem for you, do not use the interface at this time. | |
5103 | ** | |
5104 | ** When the virtual-table mechanism stabilizes, we will declare the | |
5105 | ** interface fixed, support it indefinitely, and remove this comment. | |
5106 | ** | |
5107 | ****** EXPERIMENTAL - subject to change without notice ************** | |
5108 | */ | |
5109 | ||
5110 | /* | |
5111 | ** CAPI3REF: A Handle To An Open BLOB {F17800} | |
5112 | ** | |
5113 | ** An instance of this object represents an open BLOB on which | |
5114 | ** incremental I/O can be preformed. | |
5115 | ** Objects of this type are created by | |
5116 | ** [sqlite3_blob_open()] and destroyed by [sqlite3_blob_close()]. | |
5117 | ** The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces | |
5118 | ** can be used to read or write small subsections of the blob. | |
5119 | ** The [sqlite3_blob_bytes()] interface returns the size of the | |
5120 | ** blob in bytes. | |
5121 | */ | |
5122 | typedef struct sqlite3_blob sqlite3_blob; | |
5123 | ||
5124 | /* | |
5125 | ** CAPI3REF: Open A BLOB For Incremental I/O {F17810} | |
5126 | ** | |
5127 | ** This interfaces opens a handle to the blob located | |
5128 | ** in row iRow, column zColumn, table zTable in database zDb; | |
5129 | ** in other words, the same blob that would be selected by: | |
5130 | ** | |
5131 | ** <pre> | |
5132 | ** SELECT zColumn FROM zDb.zTable WHERE rowid = iRow; | |
5133 | ** </pre> {END} | |
5134 | ** | |
5135 | ** If the flags parameter is non-zero, the blob is opened for | |
5136 | ** read and write access. If it is zero, the blob is opened for read | |
5137 | ** access. | |
5138 | ** | |
5139 | ** Note that the database name is not the filename that contains | |
5140 | ** the database but rather the symbolic name of the database that | |
5141 | ** is assigned when the database is connected using [ATTACH]. | |
5142 | ** For the main database file, the database name is "main". For | |
5143 | ** TEMP tables, the database name is "temp". | |
5144 | ** | |
5145 | ** On success, [SQLITE_OK] is returned and the new | |
5146 | ** [sqlite3_blob | blob handle] is written to *ppBlob. | |
5147 | ** Otherwise an error code is returned and | |
5148 | ** any value written to *ppBlob should not be used by the caller. | |
5149 | ** This function sets the database-handle error code and message | |
5150 | ** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()]. | |
5151 | ** | |
5152 | ** INVARIANTS: | |
5153 | ** | |
5154 | ** {F17813} A successful invocation of the [sqlite3_blob_open(D,B,T,C,R,F,P)] | |
5155 | ** interface opens an [sqlite3_blob] object P on the blob | |
5156 | ** in column C of table T in database B on [database connection] D. | |
5157 | ** | |
5158 | ** {F17814} A successful invocation of [sqlite3_blob_open(D,...)] starts | |
5159 | ** a new transaction on [database connection] D if that connection | |
5160 | ** is not already in a transaction. | |
5161 | ** | |
5162 | ** {F17816} The [sqlite3_blob_open(D,B,T,C,R,F,P)] interface opens the blob | |
5163 | ** for read and write access if and only if the F parameter | |
5164 | ** is non-zero. | |
5165 | ** | |
5166 | ** {F17819} The [sqlite3_blob_open()] interface returns [SQLITE_OK] on | |
5167 | ** success and an appropriate [error code] on failure. | |
5168 | ** | |
5169 | ** {F17821} If an error occurs during evaluation of [sqlite3_blob_open(D,...)] | |
5170 | ** then subsequent calls to [sqlite3_errcode(D)], | |
5171 | ** [sqlite3_errmsg(D)], and [sqlite3_errmsg16(D)] will return | |
5172 | ** information approprate for that error. | |
5173 | */ | |
5174 | int sqlite3_blob_open( | |
5175 | sqlite3*, | |
5176 | const char *zDb, | |
5177 | const char *zTable, | |
5178 | const char *zColumn, | |
5179 | sqlite3_int64 iRow, | |
5180 | int flags, | |
5181 | sqlite3_blob **ppBlob | |
5182 | ); | |
5183 | ||
5184 | /* | |
5185 | ** CAPI3REF: Close A BLOB Handle {F17830} | |
5186 | ** | |
5187 | ** Close an open [sqlite3_blob | blob handle]. | |
5188 | ** | |
5189 | ** Closing a BLOB shall cause the current transaction to commit | |
5190 | ** if there are no other BLOBs, no pending prepared statements, and the | |
5191 | ** database connection is in autocommit mode. | |
5192 | ** If any writes were made to the BLOB, they might be held in cache | |
5193 | ** until the close operation if they will fit. {END} | |
5194 | ** Closing the BLOB often forces the changes | |
5195 | ** out to disk and so if any I/O errors occur, they will likely occur | |
5196 | ** at the time when the BLOB is closed. {F17833} Any errors that occur during | |
5197 | ** closing are reported as a non-zero return value. | |
5198 | ** | |
5199 | ** The BLOB is closed unconditionally. Even if this routine returns | |
5200 | ** an error code, the BLOB is still closed. | |
5201 | ** | |
5202 | ** INVARIANTS: | |
5203 | ** | |
5204 | ** {F17833} The [sqlite3_blob_close(P)] interface closes an | |
5205 | ** [sqlite3_blob] object P previously opened using | |
5206 | ** [sqlite3_blob_open()]. | |
5207 | ** | |
5208 | ** {F17836} Closing an [sqlite3_blob] object using | |
5209 | ** [sqlite3_blob_close()] shall cause the current transaction to | |
5210 | ** commit if there are no other open [sqlite3_blob] objects | |
5211 | ** or [prepared statements] on the same [database connection] and | |
5212 | ** the [database connection] is in | |
5213 | ** [sqlite3_get_autocommit | autocommit mode]. | |
5214 | ** | |
5215 | ** {F17839} The [sqlite3_blob_close(P)] interfaces closes the | |
5216 | ** [sqlite3_blob] object P unconditionally, even if | |
5217 | ** [sqlite3_blob_close(P)] returns something other than [SQLITE_OK]. | |
5218 | ** | |
5219 | */ | |
5220 | int sqlite3_blob_close(sqlite3_blob *); | |
5221 | ||
5222 | /* | |
5223 | ** CAPI3REF: Return The Size Of An Open BLOB {F17840} | |
5224 | ** | |
5225 | ** Return the size in bytes of the blob accessible via the open | |
5226 | ** [sqlite3_blob] object in its only argument. | |
5227 | ** | |
5228 | ** INVARIANTS: | |
5229 | ** | |
5230 | ** {F17843} The [sqlite3_blob_bytes(P)] interface returns the size | |
5231 | ** in bytes of the BLOB that the [sqlite3_blob] object P | |
5232 | ** refers to. | |
5233 | */ | |
5234 | int sqlite3_blob_bytes(sqlite3_blob *); | |
5235 | ||
5236 | /* | |
5237 | ** CAPI3REF: Read Data From A BLOB Incrementally {F17850} | |
5238 | ** | |
5239 | ** This function is used to read data from an open | |
5240 | ** [sqlite3_blob | blob-handle] into a caller supplied buffer. | |
5241 | ** N bytes of data are copied into buffer | |
5242 | ** Z from the open blob, starting at offset iOffset. | |
5243 | ** | |
5244 | ** If offset iOffset is less than N bytes from the end of the blob, | |
5245 | ** [SQLITE_ERROR] is returned and no data is read. If N or iOffset is | |
5246 | ** less than zero [SQLITE_ERROR] is returned and no data is read. | |
5247 | ** | |
5248 | ** On success, SQLITE_OK is returned. Otherwise, an | |
5249 | ** [error code] or an [extended error code] is returned. | |
5250 | ** | |
5251 | ** INVARIANTS: | |
5252 | ** | |
5253 | ** {F17853} The [sqlite3_blob_read(P,Z,N,X)] interface reads N bytes | |
5254 | ** beginning at offset X from | |
5255 | ** the blob that [sqlite3_blob] object P refers to | |
5256 | ** and writes those N bytes into buffer Z. | |
5257 | ** | |
5258 | ** {F17856} In [sqlite3_blob_read(P,Z,N,X)] if the size of the blob | |
5259 | ** is less than N+X bytes, then the function returns [SQLITE_ERROR] | |
5260 | ** and nothing is read from the blob. | |
5261 | ** | |
5262 | ** {F17859} In [sqlite3_blob_read(P,Z,N,X)] if X or N is less than zero | |
5263 | ** then the function returns [SQLITE_ERROR] | |
5264 | ** and nothing is read from the blob. | |
5265 | ** | |
5266 | ** {F17862} The [sqlite3_blob_read(P,Z,N,X)] interface returns [SQLITE_OK] | |
5267 | ** if N bytes where successfully read into buffer Z. | |
5268 | ** | |
5269 | ** {F17865} If the requested read could not be completed, | |
5270 | ** the [sqlite3_blob_read(P,Z,N,X)] interface returns an | |
5271 | ** appropriate [error code] or [extended error code]. | |
5272 | ** | |
5273 | ** {F17868} If an error occurs during evaluation of [sqlite3_blob_read(P,...)] | |
5274 | ** then subsequent calls to [sqlite3_errcode(D)], | |
5275 | ** [sqlite3_errmsg(D)], and [sqlite3_errmsg16(D)] will return | |
5276 | ** information approprate for that error, where D is the | |
5277 | ** database handle that was used to open blob handle P. | |
5278 | */ | |
5279 | int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset); | |
5280 | ||
5281 | /* | |
5282 | ** CAPI3REF: Write Data Into A BLOB Incrementally {F17870} | |
5283 | ** | |
5284 | ** This function is used to write data into an open | |
5285 | ** [sqlite3_blob | blob-handle] from a user supplied buffer. | |
5286 | ** n bytes of data are copied from the buffer | |
5287 | ** pointed to by z into the open blob, starting at offset iOffset. | |
5288 | ** | |
5289 | ** If the [sqlite3_blob | blob-handle] passed as the first argument | |
5290 | ** was not opened for writing (the flags parameter to [sqlite3_blob_open()] | |
5291 | *** was zero), this function returns [SQLITE_READONLY]. | |
5292 | ** | |
5293 | ** This function may only modify the contents of the blob; it is | |
5294 | ** not possible to increase the size of a blob using this API. | |
5295 | ** If offset iOffset is less than n bytes from the end of the blob, | |
5296 | ** [SQLITE_ERROR] is returned and no data is written. If n is | |
5297 | ** less than zero [SQLITE_ERROR] is returned and no data is written. | |
5298 | ** | |
5299 | ** On success, SQLITE_OK is returned. Otherwise, an | |
5300 | ** [error code] or an [extended error code] is returned. | |
5301 | ** | |
5302 | ** INVARIANTS: | |
5303 | ** | |
5304 | ** {F17873} The [sqlite3_blob_write(P,Z,N,X)] interface writes N bytes | |
5305 | ** from buffer Z into | |
5306 | ** the blob that [sqlite3_blob] object P refers to | |
5307 | ** beginning at an offset of X into the blob. | |
5308 | ** | |
5309 | ** {F17875} The [sqlite3_blob_write(P,Z,N,X)] interface returns | |
5310 | ** [SQLITE_READONLY] if the [sqlite3_blob] object P was | |
5311 | ** [sqlite3_blob_open | opened] for reading only. | |
5312 | ** | |
5313 | ** {F17876} In [sqlite3_blob_write(P,Z,N,X)] if the size of the blob | |
5314 | ** is less than N+X bytes, then the function returns [SQLITE_ERROR] | |
5315 | ** and nothing is written into the blob. | |
5316 | ** | |
5317 | ** {F17879} In [sqlite3_blob_write(P,Z,N,X)] if X or N is less than zero | |
5318 | ** then the function returns [SQLITE_ERROR] | |
5319 | ** and nothing is written into the blob. | |
5320 | ** | |
5321 | ** {F17882} The [sqlite3_blob_write(P,Z,N,X)] interface returns [SQLITE_OK] | |
5322 | ** if N bytes where successfully written into blob. | |
5323 | ** | |
5324 | ** {F17885} If the requested write could not be completed, | |
5325 | ** the [sqlite3_blob_write(P,Z,N,X)] interface returns an | |
5326 | ** appropriate [error code] or [extended error code]. | |
5327 | ** | |
5328 | ** {F17888} If an error occurs during evaluation of [sqlite3_blob_write(D,...)] | |
5329 | ** then subsequent calls to [sqlite3_errcode(D)], | |
5330 | ** [sqlite3_errmsg(D)], and [sqlite3_errmsg16(D)] will return | |
5331 | ** information approprate for that error. | |
5332 | */ | |
5333 | int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset); | |
5334 | ||
5335 | /* | |
5336 | ** CAPI3REF: Virtual File System Objects {F11200} | |
5337 | ** | |
5338 | ** A virtual filesystem (VFS) is an [sqlite3_vfs] object | |
5339 | ** that SQLite uses to interact | |
5340 | ** with the underlying operating system. Most SQLite builds come with a | |
5341 | ** single default VFS that is appropriate for the host computer. | |
5342 | ** New VFSes can be registered and existing VFSes can be unregistered. | |
5343 | ** The following interfaces are provided. | |
5344 | ** | |
5345 | ** The sqlite3_vfs_find() interface returns a pointer to | |
5346 | ** a VFS given its name. Names are case sensitive. | |
5347 | ** Names are zero-terminated UTF-8 strings. | |
5348 | ** If there is no match, a NULL | |
5349 | ** pointer is returned. If zVfsName is NULL then the default | |
5350 | ** VFS is returned. | |
5351 | ** | |
5352 | ** New VFSes are registered with sqlite3_vfs_register(). | |
5353 | ** Each new VFS becomes the default VFS if the makeDflt flag is set. | |
5354 | ** The same VFS can be registered multiple times without injury. | |
5355 | ** To make an existing VFS into the default VFS, register it again | |
5356 | ** with the makeDflt flag set. If two different VFSes with the | |
5357 | ** same name are registered, the behavior is undefined. If a | |
5358 | ** VFS is registered with a name that is NULL or an empty string, | |
5359 | ** then the behavior is undefined. | |
5360 | ** | |
5361 | ** Unregister a VFS with the sqlite3_vfs_unregister() interface. | |
5362 | ** If the default VFS is unregistered, another VFS is chosen as | |
5363 | ** the default. The choice for the new VFS is arbitrary. | |
5364 | ** | |
5365 | ** INVARIANTS: | |
5366 | ** | |
5367 | ** {F11203} The [sqlite3_vfs_find(N)] interface returns a pointer to the | |
5368 | ** registered [sqlite3_vfs] object whose name exactly matches | |
5369 | ** the zero-terminated UTF-8 string N, or it returns NULL if | |
5370 | ** there is no match. | |
5371 | ** | |
5372 | ** {F11206} If the N parameter to [sqlite3_vfs_find(N)] is NULL then | |
5373 | ** the function returns a pointer to the default [sqlite3_vfs] | |
5374 | ** object if there is one, or NULL if there is no default | |
5375 | ** [sqlite3_vfs] object. | |
5376 | ** | |
5377 | ** {F11209} The [sqlite3_vfs_register(P,F)] interface registers the | |
5378 | ** well-formed [sqlite3_vfs] object P using the name given | |
5379 | ** by the zName field of the object. | |
5380 | ** | |
5381 | ** {F11212} Using the [sqlite3_vfs_register(P,F)] interface to register | |
5382 | ** the same [sqlite3_vfs] object multiple times is a harmless no-op. | |
5383 | ** | |
5384 | ** {F11215} The [sqlite3_vfs_register(P,F)] interface makes the | |
5385 | ** the [sqlite3_vfs] object P the default [sqlite3_vfs] object | |
5386 | ** if F is non-zero. | |
5387 | ** | |
5388 | ** {F11218} The [sqlite3_vfs_unregister(P)] interface unregisters the | |
5389 | ** [sqlite3_vfs] object P so that it is no longer returned by | |
5390 | ** subsequent calls to [sqlite3_vfs_find()]. | |
5391 | */ | |
5392 | sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName); | |
5393 | int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt); | |
5394 | int sqlite3_vfs_unregister(sqlite3_vfs*); | |
5395 | ||
5396 | /* | |
5397 | ** CAPI3REF: Mutexes {F17000} | |
5398 | ** | |
5399 | ** The SQLite core uses these routines for thread | |
5400 | ** synchronization. Though they are intended for internal | |
5401 | ** use by SQLite, code that links against SQLite is | |
5402 | ** permitted to use any of these routines. | |
5403 | ** | |
5404 | ** The SQLite source code contains multiple implementations | |
5405 | ** of these mutex routines. An appropriate implementation | |
5406 | ** is selected automatically at compile-time. The following | |
5407 | ** implementations are available in the SQLite core: | |
5408 | ** | |
5409 | ** <ul> | |
5410 | ** <li> SQLITE_MUTEX_OS2 | |
5411 | ** <li> SQLITE_MUTEX_PTHREAD | |
5412 | ** <li> SQLITE_MUTEX_W32 | |
5413 | ** <li> SQLITE_MUTEX_NOOP | |
5414 | ** </ul> | |
5415 | ** | |
5416 | ** The SQLITE_MUTEX_NOOP implementation is a set of routines | |
5417 | ** that does no real locking and is appropriate for use in | |
5418 | ** a single-threaded application. The SQLITE_MUTEX_OS2, | |
5419 | ** SQLITE_MUTEX_PTHREAD, and SQLITE_MUTEX_W32 implementations | |
5420 | ** are appropriate for use on os/2, unix, and windows. | |
5421 | ** | |
5422 | ** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor | |
5423 | ** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex | |
5424 | ** implementation is included with the library. The | |
5425 | ** mutex interface routines defined here become external | |
5426 | ** references in the SQLite library for which implementations | |
5427 | ** must be provided by the application. This facility allows an | |
5428 | ** application that links against SQLite to provide its own mutex | |
5429 | ** implementation without having to modify the SQLite core. | |
5430 | ** | |
5431 | ** {F17011} The sqlite3_mutex_alloc() routine allocates a new | |
5432 | ** mutex and returns a pointer to it. {F17012} If it returns NULL | |
5433 | ** that means that a mutex could not be allocated. {F17013} SQLite | |
5434 | ** will unwind its stack and return an error. {F17014} The argument | |
5435 | ** to sqlite3_mutex_alloc() is one of these integer constants: | |
5436 | ** | |
5437 | ** <ul> | |
5438 | ** <li> SQLITE_MUTEX_FAST | |
5439 | ** <li> SQLITE_MUTEX_RECURSIVE | |
5440 | ** <li> SQLITE_MUTEX_STATIC_MASTER | |
5441 | ** <li> SQLITE_MUTEX_STATIC_MEM | |
5442 | ** <li> SQLITE_MUTEX_STATIC_MEM2 | |
5443 | ** <li> SQLITE_MUTEX_STATIC_PRNG | |
5444 | ** <li> SQLITE_MUTEX_STATIC_LRU | |
5445 | ** <li> SQLITE_MUTEX_STATIC_LRU2 | |
5446 | ** </ul> {END} | |
5447 | ** | |
5448 | ** {F17015} The first two constants cause sqlite3_mutex_alloc() to create | |
5449 | ** a new mutex. The new mutex is recursive when SQLITE_MUTEX_RECURSIVE | |
5450 | ** is used but not necessarily so when SQLITE_MUTEX_FAST is used. {END} | |
5451 | ** The mutex implementation does not need to make a distinction | |
5452 | ** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does | |
5453 | ** not want to. {F17016} But SQLite will only request a recursive mutex in | |
5454 | ** cases where it really needs one. {END} If a faster non-recursive mutex | |
5455 | ** implementation is available on the host platform, the mutex subsystem | |
5456 | ** might return such a mutex in response to SQLITE_MUTEX_FAST. | |
5457 | ** | |
5458 | ** {F17017} The other allowed parameters to sqlite3_mutex_alloc() each return | |
5459 | ** a pointer to a static preexisting mutex. {END} Four static mutexes are | |
5460 | ** used by the current version of SQLite. Future versions of SQLite | |
5461 | ** may add additional static mutexes. Static mutexes are for internal | |
5462 | ** use by SQLite only. Applications that use SQLite mutexes should | |
5463 | ** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or | |
5464 | ** SQLITE_MUTEX_RECURSIVE. | |
5465 | ** | |
5466 | ** {F17018} Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST | |
5467 | ** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc() | |
5468 | ** returns a different mutex on every call. {F17034} But for the static | |
5469 | ** mutex types, the same mutex is returned on every call that has | |
5470 | ** the same type number. {END} | |
5471 | ** | |
5472 | ** {F17019} The sqlite3_mutex_free() routine deallocates a previously | |
5473 | ** allocated dynamic mutex. {F17020} SQLite is careful to deallocate every | |
5474 | ** dynamic mutex that it allocates. {U17021} The dynamic mutexes must not be in | |
5475 | ** use when they are deallocated. {U17022} Attempting to deallocate a static | |
5476 | ** mutex results in undefined behavior. {F17023} SQLite never deallocates | |
5477 | ** a static mutex. {END} | |
5478 | ** | |
5479 | ** The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt | |
5480 | ** to enter a mutex. {F17024} If another thread is already within the mutex, | |
5481 | ** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return | |
5482 | ** SQLITE_BUSY. {F17025} The sqlite3_mutex_try() interface returns SQLITE_OK | |
5483 | ** upon successful entry. {F17026} Mutexes created using | |
5484 | ** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread. | |
5485 | ** {F17027} In such cases the, | |
5486 | ** mutex must be exited an equal number of times before another thread | |
5487 | ** can enter. {U17028} If the same thread tries to enter any other | |
5488 | ** kind of mutex more than once, the behavior is undefined. | |
5489 | ** {F17029} SQLite will never exhibit | |
5490 | ** such behavior in its own use of mutexes. {END} | |
5491 | ** | |
5492 | ** Some systems (ex: windows95) do not the operation implemented by | |
5493 | ** sqlite3_mutex_try(). On those systems, sqlite3_mutex_try() will | |
5494 | ** always return SQLITE_BUSY. {F17030} The SQLite core only ever uses | |
5495 | ** sqlite3_mutex_try() as an optimization so this is acceptable behavior. {END} | |
5496 | ** | |
5497 | ** {F17031} The sqlite3_mutex_leave() routine exits a mutex that was | |
5498 | ** previously entered by the same thread. {U17032} The behavior | |
5499 | ** is undefined if the mutex is not currently entered by the | |
5500 | ** calling thread or is not currently allocated. {F17033} SQLite will | |
5501 | ** never do either. {END} | |
5502 | ** | |
5503 | ** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()]. | |
5504 | */ | |
5505 | sqlite3_mutex *sqlite3_mutex_alloc(int); | |
5506 | void sqlite3_mutex_free(sqlite3_mutex*); | |
5507 | void sqlite3_mutex_enter(sqlite3_mutex*); | |
5508 | int sqlite3_mutex_try(sqlite3_mutex*); | |
5509 | void sqlite3_mutex_leave(sqlite3_mutex*); | |
5510 | ||
5511 | /* | |
5512 | ** CAPI3REF: Mutex Verifcation Routines {F17080} | |
5513 | ** | |
5514 | ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines | |
5515 | ** are intended for use inside assert() statements. {F17081} The SQLite core | |
5516 | ** never uses these routines except inside an assert() and applications | |
5517 | ** are advised to follow the lead of the core. {F17082} The core only | |
5518 | ** provides implementations for these routines when it is compiled | |
5519 | ** with the SQLITE_DEBUG flag. {U17087} External mutex implementations | |
5520 | ** are only required to provide these routines if SQLITE_DEBUG is | |
5521 | ** defined and if NDEBUG is not defined. | |
5522 | ** | |
5523 | ** {F17083} These routines should return true if the mutex in their argument | |
5524 | ** is held or not held, respectively, by the calling thread. {END} | |
5525 | ** | |
5526 | ** {X17084} The implementation is not required to provided versions of these | |
5527 | ** routines that actually work. | |
5528 | ** If the implementation does not provide working | |
5529 | ** versions of these routines, it should at least provide stubs | |
5530 | ** that always return true so that one does not get spurious | |
5531 | ** assertion failures. {END} | |
5532 | ** | |
5533 | ** {F17085} If the argument to sqlite3_mutex_held() is a NULL pointer then | |
5534 | ** the routine should return 1. {END} This seems counter-intuitive since | |
5535 | ** clearly the mutex cannot be held if it does not exist. But the | |
5536 | ** the reason the mutex does not exist is because the build is not | |
5537 | ** using mutexes. And we do not want the assert() containing the | |
5538 | ** call to sqlite3_mutex_held() to fail, so a non-zero return is | |
5539 | ** the appropriate thing to do. {F17086} The sqlite3_mutex_notheld() | |
5540 | ** interface should also return 1 when given a NULL pointer. | |
5541 | */ | |
5542 | int sqlite3_mutex_held(sqlite3_mutex*); | |
5543 | int sqlite3_mutex_notheld(sqlite3_mutex*); | |
5544 | ||
5545 | /* | |
5546 | ** CAPI3REF: Mutex Types {F17001} | |
5547 | ** | |
5548 | ** {F17002} The [sqlite3_mutex_alloc()] interface takes a single argument | |
5549 | ** which is one of these integer constants. {END} | |
5550 | */ | |
5551 | #define SQLITE_MUTEX_FAST 0 | |
5552 | #define SQLITE_MUTEX_RECURSIVE 1 | |
5553 | #define SQLITE_MUTEX_STATIC_MASTER 2 | |
5554 | #define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */ | |
5555 | #define SQLITE_MUTEX_STATIC_MEM2 4 /* sqlite3_release_memory() */ | |
5556 | #define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */ | |
5557 | #define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */ | |
5558 | #define SQLITE_MUTEX_STATIC_LRU2 7 /* lru page list */ | |
5559 | ||
5560 | /* | |
5561 | ** CAPI3REF: Low-Level Control Of Database Files {F11300} | |
5562 | ** | |
5563 | ** {F11301} The [sqlite3_file_control()] interface makes a direct call to the | |
5564 | ** xFileControl method for the [sqlite3_io_methods] object associated | |
5565 | ** with a particular database identified by the second argument. {F11302} The | |
5566 | ** name of the database is the name assigned to the database by the | |
5567 | ** <a href="lang_attach.html">ATTACH</a> SQL command that opened the | |
5568 | ** database. {F11303} To control the main database file, use the name "main" | |
5569 | ** or a NULL pointer. {F11304} The third and fourth parameters to this routine | |
5570 | ** are passed directly through to the second and third parameters of | |
5571 | ** the xFileControl method. {F11305} The return value of the xFileControl | |
5572 | ** method becomes the return value of this routine. | |
5573 | ** | |
5574 | ** {F11306} If the second parameter (zDbName) does not match the name of any | |
5575 | ** open database file, then SQLITE_ERROR is returned. {F11307} This error | |
5576 | ** code is not remembered and will not be recalled by [sqlite3_errcode()] | |
5577 | ** or [sqlite3_errmsg()]. {U11308} The underlying xFileControl method might | |
5578 | ** also return SQLITE_ERROR. {U11309} There is no way to distinguish between | |
5579 | ** an incorrect zDbName and an SQLITE_ERROR return from the underlying | |
5580 | ** xFileControl method. {END} | |
5581 | ** | |
5582 | ** See also: [SQLITE_FCNTL_LOCKSTATE] | |
5583 | */ | |
5584 | int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*); | |
5585 | ||
5586 | /* | |
5587 | ** CAPI3REF: Testing Interface {F11400} | |
5588 | ** | |
5589 | ** The sqlite3_test_control() interface is used to read out internal | |
5590 | ** state of SQLite and to inject faults into SQLite for testing | |
5591 | ** purposes. The first parameter a operation code that determines | |
5592 | ** the number, meaning, and operation of all subsequent parameters. | |
5593 | ** | |
5594 | ** This interface is not for use by applications. It exists solely | |
5595 | ** for verifying the correct operation of the SQLite library. Depending | |
5596 | ** on how the SQLite library is compiled, this interface might not exist. | |
5597 | ** | |
5598 | ** The details of the operation codes, their meanings, the parameters | |
5599 | ** they take, and what they do are all subject to change without notice. | |
5600 | ** Unlike most of the SQLite API, this function is not guaranteed to | |
5601 | ** operate consistently from one release to the next. | |
5602 | */ | |
5603 | int sqlite3_test_control(int op, ...); | |
5604 | ||
5605 | /* | |
5606 | ** CAPI3REF: Testing Interface Operation Codes {F11410} | |
5607 | ** | |
5608 | ** These constants are the valid operation code parameters used | |
5609 | ** as the first argument to [sqlite3_test_control()]. | |
5610 | ** | |
5611 | ** These parameters and their meansing are subject to change | |
5612 | ** without notice. These values are for testing purposes only. | |
5613 | ** Applications should not use any of these parameters or the | |
5614 | ** [sqlite3_test_control()] interface. | |
5615 | */ | |
5616 | #define SQLITE_TESTCTRL_FAULT_CONFIG 1 | |
5617 | #define SQLITE_TESTCTRL_FAULT_FAILURES 2 | |
5618 | #define SQLITE_TESTCTRL_FAULT_BENIGN_FAILURES 3 | |
5619 | #define SQLITE_TESTCTRL_FAULT_PENDING 4 | |
5620 | #define SQLITE_TESTCTRL_PRNG_SAVE 5 | |
5621 | #define SQLITE_TESTCTRL_PRNG_RESTORE 6 | |
5622 | #define SQLITE_TESTCTRL_PRNG_RESET 7 | |
5623 | #define SQLITE_TESTCTRL_BITVEC_TEST 8 | |
5624 | ||
5625 | ||
5626 | /* | |
5627 | ** Undo the hack that converts floating point types to integer for | |
5628 | ** builds on processors without floating point support. | |
5629 | */ | |
5630 | #ifdef SQLITE_OMIT_FLOATING_POINT | |
5631 | # undef double | |
5632 | #endif | |
5633 | ||
5634 | #ifdef __cplusplus | |
5635 | } /* End of the 'extern "C"' block */ | |
5636 | #endif | |
5637 | #endif |