Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(7)

Side by Side Diff: third_party/sqlite/sqlite-src-3080704/src/sqlite.h.in

Issue 883353008: [sql] Import reference version of SQLite 3.8.7.4. (Closed) Base URL: http://chromium.googlesource.com/chromium/src.git@master
Patch Set: Hold back encoding change which is messing up patch. Created 5 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 /* 1 /*
2 ** 2001 September 15 2 ** 2001 September 15
3 ** 3 **
4 ** The author disclaims copyright to this source code. In place of 4 ** The author disclaims copyright to this source code. In place of
5 ** a legal notice, here is a blessing: 5 ** a legal notice, here is a blessing:
6 ** 6 **
7 ** May you do good and not evil. 7 ** May you do good and not evil.
8 ** May you find forgiveness for yourself and forgive others. 8 ** May you find forgiveness for yourself and forgive others.
9 ** May you share freely, never taking more than you give. 9 ** May you share freely, never taking more than you give.
10 ** 10 **
(...skipping 154 matching lines...) Expand 10 before | Expand all | Expand 10 after
165 */ 165 */
166 #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS 166 #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
167 int sqlite3_compileoption_used(const char *zOptName); 167 int sqlite3_compileoption_used(const char *zOptName);
168 const char *sqlite3_compileoption_get(int N); 168 const char *sqlite3_compileoption_get(int N);
169 #endif 169 #endif
170 170
171 /* 171 /*
172 ** CAPI3REF: Test To See If The Library Is Threadsafe 172 ** CAPI3REF: Test To See If The Library Is Threadsafe
173 ** 173 **
174 ** ^The sqlite3_threadsafe() function returns zero if and only if 174 ** ^The sqlite3_threadsafe() function returns zero if and only if
175 ** SQLite was compiled mutexing code omitted due to the 175 ** SQLite was compiled with mutexing code omitted due to the
176 ** [SQLITE_THREADSAFE] compile-time option being set to 0. 176 ** [SQLITE_THREADSAFE] compile-time option being set to 0.
177 ** 177 **
178 ** SQLite can be compiled with or without mutexes. When 178 ** SQLite can be compiled with or without mutexes. When
179 ** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes 179 ** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes
180 ** are enabled and SQLite is threadsafe. When the 180 ** are enabled and SQLite is threadsafe. When the
181 ** [SQLITE_THREADSAFE] macro is 0, 181 ** [SQLITE_THREADSAFE] macro is 0,
182 ** the mutexes are omitted. Without the mutexes, it is not safe 182 ** the mutexes are omitted. Without the mutexes, it is not safe
183 ** to use SQLite concurrently from more than one thread. 183 ** to use SQLite concurrently from more than one thread.
184 ** 184 **
185 ** Enabling mutexes incurs a measurable performance penalty. 185 ** Enabling mutexes incurs a measurable performance penalty.
(...skipping 21 matching lines...) Expand all
207 int sqlite3_threadsafe(void); 207 int sqlite3_threadsafe(void);
208 208
209 /* 209 /*
210 ** CAPI3REF: Database Connection Handle 210 ** CAPI3REF: Database Connection Handle
211 ** KEYWORDS: {database connection} {database connections} 211 ** KEYWORDS: {database connection} {database connections}
212 ** 212 **
213 ** Each open SQLite database is represented by a pointer to an instance of 213 ** Each open SQLite database is represented by a pointer to an instance of
214 ** the opaque structure named "sqlite3". It is useful to think of an sqlite3 214 ** the opaque structure named "sqlite3". It is useful to think of an sqlite3
215 ** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and 215 ** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and
216 ** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()] 216 ** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()]
217 ** is its destructor. There are many other interfaces (such as 217 ** and [sqlite3_close_v2()] are its destructors. There are many other
218 ** interfaces (such as
218 ** [sqlite3_prepare_v2()], [sqlite3_create_function()], and 219 ** [sqlite3_prepare_v2()], [sqlite3_create_function()], and
219 ** [sqlite3_busy_timeout()] to name but three) that are methods on an 220 ** [sqlite3_busy_timeout()] to name but three) that are methods on an
220 ** sqlite3 object. 221 ** sqlite3 object.
221 */ 222 */
222 typedef struct sqlite3 sqlite3; 223 typedef struct sqlite3 sqlite3;
223 224
224 /* 225 /*
225 ** CAPI3REF: 64-Bit Integer Types 226 ** CAPI3REF: 64-Bit Integer Types
226 ** KEYWORDS: sqlite_int64 sqlite_uint64 227 ** KEYWORDS: sqlite_int64 sqlite_uint64
227 ** 228 **
(...skipping 26 matching lines...) Expand all
254 ** If compiling for a processor that lacks floating point support, 255 ** If compiling for a processor that lacks floating point support,
255 ** substitute integer for floating-point. 256 ** substitute integer for floating-point.
256 */ 257 */
257 #ifdef SQLITE_OMIT_FLOATING_POINT 258 #ifdef SQLITE_OMIT_FLOATING_POINT
258 # define double sqlite3_int64 259 # define double sqlite3_int64
259 #endif 260 #endif
260 261
261 /* 262 /*
262 ** CAPI3REF: Closing A Database Connection 263 ** CAPI3REF: Closing A Database Connection
263 ** 264 **
264 ** ^The sqlite3_close() routine is the destructor for the [sqlite3] object. 265 ** ^The sqlite3_close() and sqlite3_close_v2() routines are destructors
265 ** ^Calls to sqlite3_close() return SQLITE_OK if the [sqlite3] object is 266 ** for the [sqlite3] object.
266 ** successfully destroyed and all associated resources are deallocated. 267 ** ^Calls to sqlite3_close() and sqlite3_close_v2() return [SQLITE_OK] if
268 ** the [sqlite3] object is successfully destroyed and all associated
269 ** resources are deallocated.
267 ** 270 **
268 ** Applications must [sqlite3_finalize | finalize] all [prepared statements] 271 ** ^If the database connection is associated with unfinalized prepared
269 ** and [sqlite3_blob_close | close] all [BLOB handles] associated with 272 ** statements or unfinished sqlite3_backup objects then sqlite3_close()
270 ** the [sqlite3] object prior to attempting to close the object. ^If 273 ** will leave the database connection open and return [SQLITE_BUSY].
271 ** sqlite3_close() is called on a [database connection] that still has 274 ** ^If sqlite3_close_v2() is called with unfinalized prepared statements
272 ** outstanding [prepared statements] or [BLOB handles], then it returns 275 ** and/or unfinished sqlite3_backups, then the database connection becomes
273 ** SQLITE_BUSY. 276 ** an unusable "zombie" which will automatically be deallocated when the
277 ** last prepared statement is finalized or the last sqlite3_backup is
278 ** finished. The sqlite3_close_v2() interface is intended for use with
279 ** host languages that are garbage collected, and where the order in which
280 ** destructors are called is arbitrary.
274 ** 281 **
275 ** ^If [sqlite3_close()] is invoked while a transaction is open, 282 ** Applications should [sqlite3_finalize | finalize] all [prepared statements],
283 ** [sqlite3_blob_close | close] all [BLOB handles], and
284 ** [sqlite3_backup_finish | finish] all [sqlite3_backup] objects associated
285 ** with the [sqlite3] object prior to attempting to close the object. ^If
286 ** sqlite3_close_v2() is called on a [database connection] that still has
287 ** outstanding [prepared statements], [BLOB handles], and/or
288 ** [sqlite3_backup] objects then it returns [SQLITE_OK] and the deallocation
289 ** of resources is deferred until all [prepared statements], [BLOB handles],
290 ** and [sqlite3_backup] objects are also destroyed.
291 **
292 ** ^If an [sqlite3] object is destroyed while a transaction is open,
276 ** the transaction is automatically rolled back. 293 ** the transaction is automatically rolled back.
277 ** 294 **
278 ** The C parameter to [sqlite3_close(C)] must be either a NULL 295 ** The C parameter to [sqlite3_close(C)] and [sqlite3_close_v2(C)]
296 ** must be either a NULL
279 ** pointer or an [sqlite3] object pointer obtained 297 ** pointer or an [sqlite3] object pointer obtained
280 ** from [sqlite3_open()], [sqlite3_open16()], or 298 ** from [sqlite3_open()], [sqlite3_open16()], or
281 ** [sqlite3_open_v2()], and not previously closed. 299 ** [sqlite3_open_v2()], and not previously closed.
282 ** ^Calling sqlite3_close() with a NULL pointer argument is a 300 ** ^Calling sqlite3_close() or sqlite3_close_v2() with a NULL pointer
283 ** harmless no-op. 301 ** argument is a harmless no-op.
284 */ 302 */
285 int sqlite3_close(sqlite3 *); 303 int sqlite3_close(sqlite3*);
304 int sqlite3_close_v2(sqlite3*);
286 305
287 /* 306 /*
288 ** The type for a callback function. 307 ** The type for a callback function.
289 ** This is legacy and deprecated. It is included for historical 308 ** This is legacy and deprecated. It is included for historical
290 ** compatibility and is not documented. 309 ** compatibility and is not documented.
291 */ 310 */
292 typedef int (*sqlite3_callback)(void*,int,char**, char**); 311 typedef int (*sqlite3_callback)(void*,int,char**, char**);
293 312
294 /* 313 /*
295 ** CAPI3REF: One-Step Query Execution Interface 314 ** CAPI3REF: One-Step Query Execution Interface
296 ** 315 **
297 ** The sqlite3_exec() interface is a convenience wrapper around 316 ** The sqlite3_exec() interface is a convenience wrapper around
298 ** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()], 317 ** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()],
299 ** that allows an application to run multiple statements of SQL 318 ** that allows an application to run multiple statements of SQL
300 ** without having to use a lot of C code. 319 ** without having to use a lot of C code.
301 ** 320 **
302 ** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded, 321 ** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded,
303 ** semicolon-separate SQL statements passed into its 2nd argument, 322 ** semicolon-separate SQL statements passed into its 2nd argument,
304 ** in the context of the [database connection] passed in as its 1st 323 ** in the context of the [database connection] passed in as its 1st
305 ** argument. ^If the callback function of the 3rd argument to 324 ** argument. ^If the callback function of the 3rd argument to
306 ** sqlite3_exec() is not NULL, then it is invoked for each result row 325 ** sqlite3_exec() is not NULL, then it is invoked for each result row
307 ** coming out of the evaluated SQL statements. ^The 4th argument to 326 ** coming out of the evaluated SQL statements. ^The 4th argument to
308 ** to sqlite3_exec() is relayed through to the 1st argument of each 327 ** sqlite3_exec() is relayed through to the 1st argument of each
309 ** callback invocation. ^If the callback pointer to sqlite3_exec() 328 ** callback invocation. ^If the callback pointer to sqlite3_exec()
310 ** is NULL, then no callback is ever invoked and result rows are 329 ** is NULL, then no callback is ever invoked and result rows are
311 ** ignored. 330 ** ignored.
312 ** 331 **
313 ** ^If an error occurs while evaluating the SQL statements passed into 332 ** ^If an error occurs while evaluating the SQL statements passed into
314 ** sqlite3_exec(), then execution of the current statement stops and 333 ** sqlite3_exec(), then execution of the current statement stops and
315 ** subsequent statements are skipped. ^If the 5th parameter to sqlite3_exec() 334 ** subsequent statements are skipped. ^If the 5th parameter to sqlite3_exec()
316 ** is not NULL then any error message is written into memory obtained 335 ** is not NULL then any error message is written into memory obtained
317 ** from [sqlite3_malloc()] and passed back through the 5th parameter. 336 ** from [sqlite3_malloc()] and passed back through the 5th parameter.
318 ** To avoid memory leaks, the application should invoke [sqlite3_free()] 337 ** To avoid memory leaks, the application should invoke [sqlite3_free()]
(...skipping 20 matching lines...) Expand all
339 ** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer 358 ** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer
340 ** to an empty string, or a pointer that contains only whitespace and/or 359 ** to an empty string, or a pointer that contains only whitespace and/or
341 ** SQL comments, then no SQL statements are evaluated and the database 360 ** SQL comments, then no SQL statements are evaluated and the database
342 ** is not changed. 361 ** is not changed.
343 ** 362 **
344 ** Restrictions: 363 ** Restrictions:
345 ** 364 **
346 ** <ul> 365 ** <ul>
347 ** <li> The application must insure that the 1st parameter to sqlite3_exec() 366 ** <li> The application must insure that the 1st parameter to sqlite3_exec()
348 ** is a valid and open [database connection]. 367 ** is a valid and open [database connection].
349 ** <li> The application must not close [database connection] specified by 368 ** <li> The application must not close the [database connection] specified by
350 ** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running. 369 ** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running.
351 ** <li> The application must not modify the SQL statement text passed into 370 ** <li> The application must not modify the SQL statement text passed into
352 ** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running. 371 ** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running.
353 ** </ul> 372 ** </ul>
354 */ 373 */
355 int sqlite3_exec( 374 int sqlite3_exec(
356 sqlite3*, /* An open database */ 375 sqlite3*, /* An open database */
357 const char *sql, /* SQL to be evaluated */ 376 const char *sql, /* SQL to be evaluated */
358 int (*callback)(void*,int,char**,char**), /* Callback function */ 377 int (*callback)(void*,int,char**,char**), /* Callback function */
359 void *, /* 1st argument to callback */ 378 void *, /* 1st argument to callback */
360 char **errmsg /* Error msg written here */ 379 char **errmsg /* Error msg written here */
361 ); 380 );
362 381
363 /* 382 /*
364 ** CAPI3REF: Result Codes 383 ** CAPI3REF: Result Codes
365 ** KEYWORDS: SQLITE_OK {error code} {error codes} 384 ** KEYWORDS: {result code definitions}
366 ** KEYWORDS: {result code} {result codes}
367 ** 385 **
368 ** Many SQLite functions return an integer result code from the set shown 386 ** Many SQLite functions return an integer result code from the set shown
369 ** here in order to indicates success or failure. 387 ** here in order to indicate success or failure.
370 ** 388 **
371 ** New error codes may be added in future versions of SQLite. 389 ** New error codes may be added in future versions of SQLite.
372 ** 390 **
373 ** See also: [SQLITE_IOERR_READ | extended result codes] 391 ** See also: [extended result code definitions]
374 */ 392 */
375 #define SQLITE_OK 0 /* Successful result */ 393 #define SQLITE_OK 0 /* Successful result */
376 /* beginning-of-error-codes */ 394 /* beginning-of-error-codes */
377 #define SQLITE_ERROR 1 /* SQL error or missing database */ 395 #define SQLITE_ERROR 1 /* SQL error or missing database */
378 #define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */ 396 #define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */
379 #define SQLITE_PERM 3 /* Access permission denied */ 397 #define SQLITE_PERM 3 /* Access permission denied */
380 #define SQLITE_ABORT 4 /* Callback routine requested an abort */ 398 #define SQLITE_ABORT 4 /* Callback routine requested an abort */
381 #define SQLITE_BUSY 5 /* The database file is locked */ 399 #define SQLITE_BUSY 5 /* The database file is locked */
382 #define SQLITE_LOCKED 6 /* A table in the database is locked */ 400 #define SQLITE_LOCKED 6 /* A table in the database is locked */
383 #define SQLITE_NOMEM 7 /* A malloc() failed */ 401 #define SQLITE_NOMEM 7 /* A malloc() failed */
384 #define SQLITE_READONLY 8 /* Attempt to write a readonly database */ 402 #define SQLITE_READONLY 8 /* Attempt to write a readonly database */
385 #define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/ 403 #define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/
386 #define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */ 404 #define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */
387 #define SQLITE_CORRUPT 11 /* The database disk image is malformed */ 405 #define SQLITE_CORRUPT 11 /* The database disk image is malformed */
388 #define SQLITE_NOTFOUND 12 /* Unknown opcode in sqlite3_file_control() */ 406 #define SQLITE_NOTFOUND 12 /* Unknown opcode in sqlite3_file_control() */
389 #define SQLITE_FULL 13 /* Insertion failed because database is full */ 407 #define SQLITE_FULL 13 /* Insertion failed because database is full */
390 #define SQLITE_CANTOPEN 14 /* Unable to open the database file */ 408 #define SQLITE_CANTOPEN 14 /* Unable to open the database file */
391 #define SQLITE_PROTOCOL 15 /* Database lock protocol error */ 409 #define SQLITE_PROTOCOL 15 /* Database lock protocol error */
392 #define SQLITE_EMPTY 16 /* Database is empty */ 410 #define SQLITE_EMPTY 16 /* Database is empty */
393 #define SQLITE_SCHEMA 17 /* The database schema changed */ 411 #define SQLITE_SCHEMA 17 /* The database schema changed */
394 #define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */ 412 #define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */
395 #define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */ 413 #define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */
396 #define SQLITE_MISMATCH 20 /* Data type mismatch */ 414 #define SQLITE_MISMATCH 20 /* Data type mismatch */
397 #define SQLITE_MISUSE 21 /* Library used incorrectly */ 415 #define SQLITE_MISUSE 21 /* Library used incorrectly */
398 #define SQLITE_NOLFS 22 /* Uses OS features not supported on host */ 416 #define SQLITE_NOLFS 22 /* Uses OS features not supported on host */
399 #define SQLITE_AUTH 23 /* Authorization denied */ 417 #define SQLITE_AUTH 23 /* Authorization denied */
400 #define SQLITE_FORMAT 24 /* Auxiliary database format error */ 418 #define SQLITE_FORMAT 24 /* Auxiliary database format error */
401 #define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */ 419 #define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */
402 #define SQLITE_NOTADB 26 /* File opened that is not a database file */ 420 #define SQLITE_NOTADB 26 /* File opened that is not a database file */
421 #define SQLITE_NOTICE 27 /* Notifications from sqlite3_log() */
422 #define SQLITE_WARNING 28 /* Warnings from sqlite3_log() */
403 #define SQLITE_ROW 100 /* sqlite3_step() has another row ready */ 423 #define SQLITE_ROW 100 /* sqlite3_step() has another row ready */
404 #define SQLITE_DONE 101 /* sqlite3_step() has finished executing */ 424 #define SQLITE_DONE 101 /* sqlite3_step() has finished executing */
405 /* end-of-error-codes */ 425 /* end-of-error-codes */
406 426
407 /* 427 /*
408 ** CAPI3REF: Extended Result Codes 428 ** CAPI3REF: Extended Result Codes
409 ** KEYWORDS: {extended error code} {extended error codes} 429 ** KEYWORDS: {extended result code definitions}
410 ** KEYWORDS: {extended result code} {extended result codes}
411 ** 430 **
412 ** In its default configuration, SQLite API routines return one of 26 integer 431 ** In its default configuration, SQLite API routines return one of 30 integer
413 ** [SQLITE_OK | result codes]. However, experience has shown that many of 432 ** [result codes]. However, experience has shown that many of
414 ** these result codes are too coarse-grained. They do not provide as 433 ** these result codes are too coarse-grained. They do not provide as
415 ** much information about problems as programmers might like. In an effort to 434 ** much information about problems as programmers might like. In an effort to
416 ** address this, newer versions of SQLite (version 3.3.8 and later) include 435 ** address this, newer versions of SQLite (version 3.3.8 and later) include
417 ** support for additional result codes that provide more detailed information 436 ** support for additional result codes that provide more detailed information
418 ** about errors. The extended result codes are enabled or disabled 437 ** about errors. These [extended result codes] are enabled or disabled
419 ** on a per database connection basis using the 438 ** on a per database connection basis using the
420 ** [sqlite3_extended_result_codes()] API. 439 ** [sqlite3_extended_result_codes()] API. Or, the extended code for
421 ** 440 ** the most recent error can be obtained using
422 ** Some of the available extended result codes are listed here. 441 ** [sqlite3_extended_errcode()].
423 ** One may expect the number of extended result codes will be expand
424 ** over time. Software that uses extended result codes should expect
425 ** to see new result codes in future releases of SQLite.
426 **
427 ** The SQLITE_OK result code will never be extended. It will always
428 ** be exactly zero.
429 */ 442 */
430 #define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8)) 443 #define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8))
431 #define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8)) 444 #define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8))
432 #define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8)) 445 #define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8))
433 #define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8)) 446 #define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8))
434 #define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8)) 447 #define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8))
435 #define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8)) 448 #define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8))
436 #define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8)) 449 #define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8))
437 #define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8)) 450 #define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8))
438 #define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8)) 451 #define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8))
439 #define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8)) 452 #define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8))
440 #define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8)) 453 #define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8))
441 #define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8)) 454 #define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8))
442 #define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8)) 455 #define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8))
443 #define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8)) 456 #define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8))
444 #define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8)) 457 #define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8))
445 #define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8)) 458 #define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8))
446 #define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8)) 459 #define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8))
447 #define SQLITE_IOERR_SHMOPEN (SQLITE_IOERR | (18<<8)) 460 #define SQLITE_IOERR_SHMOPEN (SQLITE_IOERR | (18<<8))
448 #define SQLITE_IOERR_SHMSIZE (SQLITE_IOERR | (19<<8)) 461 #define SQLITE_IOERR_SHMSIZE (SQLITE_IOERR | (19<<8))
449 #define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR | (20<<8)) 462 #define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR | (20<<8))
463 #define SQLITE_IOERR_SHMMAP (SQLITE_IOERR | (21<<8))
464 #define SQLITE_IOERR_SEEK (SQLITE_IOERR | (22<<8))
465 #define SQLITE_IOERR_DELETE_NOENT (SQLITE_IOERR | (23<<8))
466 #define SQLITE_IOERR_MMAP (SQLITE_IOERR | (24<<8))
467 #define SQLITE_IOERR_GETTEMPPATH (SQLITE_IOERR | (25<<8))
468 #define SQLITE_IOERR_CONVPATH (SQLITE_IOERR | (26<<8))
450 #define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8)) 469 #define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8))
451 #define SQLITE_BUSY_RECOVERY (SQLITE_BUSY | (1<<8)) 470 #define SQLITE_BUSY_RECOVERY (SQLITE_BUSY | (1<<8))
471 #define SQLITE_BUSY_SNAPSHOT (SQLITE_BUSY | (2<<8))
452 #define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN | (1<<8)) 472 #define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN | (1<<8))
473 #define SQLITE_CANTOPEN_ISDIR (SQLITE_CANTOPEN | (2<<8))
474 #define SQLITE_CANTOPEN_FULLPATH (SQLITE_CANTOPEN | (3<<8))
475 #define SQLITE_CANTOPEN_CONVPATH (SQLITE_CANTOPEN | (4<<8))
476 #define SQLITE_CORRUPT_VTAB (SQLITE_CORRUPT | (1<<8))
477 #define SQLITE_READONLY_RECOVERY (SQLITE_READONLY | (1<<8))
478 #define SQLITE_READONLY_CANTLOCK (SQLITE_READONLY | (2<<8))
479 #define SQLITE_READONLY_ROLLBACK (SQLITE_READONLY | (3<<8))
480 #define SQLITE_READONLY_DBMOVED (SQLITE_READONLY | (4<<8))
481 #define SQLITE_ABORT_ROLLBACK (SQLITE_ABORT | (2<<8))
482 #define SQLITE_CONSTRAINT_CHECK (SQLITE_CONSTRAINT | (1<<8))
483 #define SQLITE_CONSTRAINT_COMMITHOOK (SQLITE_CONSTRAINT | (2<<8))
484 #define SQLITE_CONSTRAINT_FOREIGNKEY (SQLITE_CONSTRAINT | (3<<8))
485 #define SQLITE_CONSTRAINT_FUNCTION (SQLITE_CONSTRAINT | (4<<8))
486 #define SQLITE_CONSTRAINT_NOTNULL (SQLITE_CONSTRAINT | (5<<8))
487 #define SQLITE_CONSTRAINT_PRIMARYKEY (SQLITE_CONSTRAINT | (6<<8))
488 #define SQLITE_CONSTRAINT_TRIGGER (SQLITE_CONSTRAINT | (7<<8))
489 #define SQLITE_CONSTRAINT_UNIQUE (SQLITE_CONSTRAINT | (8<<8))
490 #define SQLITE_CONSTRAINT_VTAB (SQLITE_CONSTRAINT | (9<<8))
491 #define SQLITE_CONSTRAINT_ROWID (SQLITE_CONSTRAINT |(10<<8))
492 #define SQLITE_NOTICE_RECOVER_WAL (SQLITE_NOTICE | (1<<8))
493 #define SQLITE_NOTICE_RECOVER_ROLLBACK (SQLITE_NOTICE | (2<<8))
494 #define SQLITE_WARNING_AUTOINDEX (SQLITE_WARNING | (1<<8))
495 #define SQLITE_AUTH_USER (SQLITE_AUTH | (1<<8))
453 496
454 /* 497 /*
455 ** CAPI3REF: Flags For File Open Operations 498 ** CAPI3REF: Flags For File Open Operations
456 ** 499 **
457 ** These bit values are intended for use in the 500 ** These bit values are intended for use in the
458 ** 3rd parameter to the [sqlite3_open_v2()] interface and 501 ** 3rd parameter to the [sqlite3_open_v2()] interface and
459 ** in the 4th parameter to the xOpen method of the 502 ** in the 4th parameter to the [sqlite3_vfs.xOpen] method.
460 ** [sqlite3_vfs] object.
461 */ 503 */
462 #define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */ 504 #define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */
463 #define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */ 505 #define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */
464 #define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */ 506 #define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */
465 #define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */ 507 #define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */
466 #define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */ 508 #define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */
467 #define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */ 509 #define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */
510 #define SQLITE_OPEN_URI 0x00000040 /* Ok for sqlite3_open_v2() */
511 #define SQLITE_OPEN_MEMORY 0x00000080 /* Ok for sqlite3_open_v2() */
468 #define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */ 512 #define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */
469 #define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */ 513 #define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */
470 #define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */ 514 #define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */
471 #define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */ 515 #define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */
472 #define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */ 516 #define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */
473 #define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */ 517 #define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */
474 #define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */ 518 #define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */
475 #define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */ 519 #define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */
476 #define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */ 520 #define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */
477 #define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */ 521 #define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */
478 #define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */ 522 #define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */
479 #define SQLITE_OPEN_WAL 0x00080000 /* VFS only */ 523 #define SQLITE_OPEN_WAL 0x00080000 /* VFS only */
480 524
481 /* Reserved: 0x00F00000 */ 525 /* Reserved: 0x00F00000 */
482 526
483 /* 527 /*
484 ** CAPI3REF: Device Characteristics 528 ** CAPI3REF: Device Characteristics
485 ** 529 **
486 ** The xDeviceCharacteristics method of the [sqlite3_io_methods] 530 ** The xDeviceCharacteristics method of the [sqlite3_io_methods]
487 ** object returns an integer which is a vector of the these 531 ** object returns an integer which is a vector of these
488 ** bit values expressing I/O characteristics of the mass storage 532 ** bit values expressing I/O characteristics of the mass storage
489 ** device that holds the file that the [sqlite3_io_methods] 533 ** device that holds the file that the [sqlite3_io_methods]
490 ** refers to. 534 ** refers to.
491 ** 535 **
492 ** The SQLITE_IOCAP_ATOMIC property means that all writes of 536 ** The SQLITE_IOCAP_ATOMIC property means that all writes of
493 ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values 537 ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
494 ** mean that writes of blocks that are nnn bytes in size and 538 ** mean that writes of blocks that are nnn bytes in size and
495 ** are aligned to an address which is an integer multiple of 539 ** are aligned to an address which is an integer multiple of
496 ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means 540 ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
497 ** that when data is appended to a file, the data is appended 541 ** that when data is appended to a file, the data is appended
498 ** first then the size of the file is extended, never the other 542 ** first then the size of the file is extended, never the other
499 ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that 543 ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
500 ** information is written to disk in the same order as calls 544 ** information is written to disk in the same order as calls
501 ** to xWrite(). 545 ** to xWrite(). The SQLITE_IOCAP_POWERSAFE_OVERWRITE property means that
546 ** after reboot following a crash or power loss, the only bytes in a
547 ** file that were written at the application level might have changed
548 ** and that adjacent bytes, even bytes within the same sector are
549 ** guaranteed to be unchanged. The SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN
550 ** flag indicate that a file cannot be deleted when open. The
551 ** SQLITE_IOCAP_IMMUTABLE flag indicates that the file is on
552 ** read-only media and cannot be changed even by processes with
553 ** elevated privileges.
502 */ 554 */
503 #define SQLITE_IOCAP_ATOMIC 0x00000001 555 #define SQLITE_IOCAP_ATOMIC 0x00000001
504 #define SQLITE_IOCAP_ATOMIC512 0x00000002 556 #define SQLITE_IOCAP_ATOMIC512 0x00000002
505 #define SQLITE_IOCAP_ATOMIC1K 0x00000004 557 #define SQLITE_IOCAP_ATOMIC1K 0x00000004
506 #define SQLITE_IOCAP_ATOMIC2K 0x00000008 558 #define SQLITE_IOCAP_ATOMIC2K 0x00000008
507 #define SQLITE_IOCAP_ATOMIC4K 0x00000010 559 #define SQLITE_IOCAP_ATOMIC4K 0x00000010
508 #define SQLITE_IOCAP_ATOMIC8K 0x00000020 560 #define SQLITE_IOCAP_ATOMIC8K 0x00000020
509 #define SQLITE_IOCAP_ATOMIC16K 0x00000040 561 #define SQLITE_IOCAP_ATOMIC16K 0x00000040
510 #define SQLITE_IOCAP_ATOMIC32K 0x00000080 562 #define SQLITE_IOCAP_ATOMIC32K 0x00000080
511 #define SQLITE_IOCAP_ATOMIC64K 0x00000100 563 #define SQLITE_IOCAP_ATOMIC64K 0x00000100
512 #define SQLITE_IOCAP_SAFE_APPEND 0x00000200 564 #define SQLITE_IOCAP_SAFE_APPEND 0x00000200
513 #define SQLITE_IOCAP_SEQUENTIAL 0x00000400 565 #define SQLITE_IOCAP_SEQUENTIAL 0x00000400
514 #define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800 566 #define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800
567 #define SQLITE_IOCAP_POWERSAFE_OVERWRITE 0x00001000
568 #define SQLITE_IOCAP_IMMUTABLE 0x00002000
515 569
516 /* 570 /*
517 ** CAPI3REF: File Locking Levels 571 ** CAPI3REF: File Locking Levels
518 ** 572 **
519 ** SQLite uses one of these integer values as the second 573 ** SQLite uses one of these integer values as the second
520 ** argument to calls it makes to the xLock() and xUnlock() methods 574 ** argument to calls it makes to the xLock() and xUnlock() methods
521 ** of an [sqlite3_io_methods] object. 575 ** of an [sqlite3_io_methods] object.
522 */ 576 */
523 #define SQLITE_LOCK_NONE 0 577 #define SQLITE_LOCK_NONE 0
524 #define SQLITE_LOCK_SHARED 1 578 #define SQLITE_LOCK_SHARED 1
(...skipping 43 matching lines...) Expand 10 before | Expand all | Expand 10 after
568 ** I/O operations on the open file. 622 ** I/O operations on the open file.
569 */ 623 */
570 typedef struct sqlite3_file sqlite3_file; 624 typedef struct sqlite3_file sqlite3_file;
571 struct sqlite3_file { 625 struct sqlite3_file {
572 const struct sqlite3_io_methods *pMethods; /* Methods for an open file */ 626 const struct sqlite3_io_methods *pMethods; /* Methods for an open file */
573 }; 627 };
574 628
575 /* 629 /*
576 ** CAPI3REF: OS Interface File Virtual Methods Object 630 ** CAPI3REF: OS Interface File Virtual Methods Object
577 ** 631 **
578 ** Every file opened by the [sqlite3_vfs] xOpen method populates an 632 ** Every file opened by the [sqlite3_vfs.xOpen] method populates an
579 ** [sqlite3_file] object (or, more commonly, a subclass of the 633 ** [sqlite3_file] object (or, more commonly, a subclass of the
580 ** [sqlite3_file] object) with a pointer to an instance of this object. 634 ** [sqlite3_file] object) with a pointer to an instance of this object.
581 ** This object defines the methods used to perform various operations 635 ** This object defines the methods used to perform various operations
582 ** against the open file represented by the [sqlite3_file] object. 636 ** against the open file represented by the [sqlite3_file] object.
583 ** 637 **
584 ** If the xOpen method sets the sqlite3_file.pMethods element 638 ** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element
585 ** to a non-NULL pointer, then the sqlite3_io_methods.xClose method 639 ** to a non-NULL pointer, then the sqlite3_io_methods.xClose method
586 ** may be invoked even if the xOpen reported that it failed. The 640 ** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed. The
587 ** only way to prevent a call to xClose following a failed xOpen 641 ** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen]
588 ** is for the xOpen to set the sqlite3_file.pMethods element to NULL. 642 ** is for the [sqlite3_vfs.xOpen] to set the sqlite3_file.pMethods element
643 ** to NULL.
589 ** 644 **
590 ** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or 645 ** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or
591 ** [SQLITE_SYNC_FULL]. The first choice is the normal fsync(). 646 ** [SQLITE_SYNC_FULL]. The first choice is the normal fsync().
592 ** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY] 647 ** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY]
593 ** flag may be ORed in to indicate that only the data of the file 648 ** flag may be ORed in to indicate that only the data of the file
594 ** and not its inode needs to be synced. 649 ** and not its inode needs to be synced.
595 ** 650 **
596 ** The integer values to xLock() and xUnlock() are one of 651 ** The integer values to xLock() and xUnlock() are one of
597 ** <ul> 652 ** <ul>
598 ** <li> [SQLITE_LOCK_NONE], 653 ** <li> [SQLITE_LOCK_NONE],
(...skipping 11 matching lines...) Expand all
610 ** The xFileControl() method is a generic interface that allows custom 665 ** The xFileControl() method is a generic interface that allows custom
611 ** VFS implementations to directly control an open file using the 666 ** VFS implementations to directly control an open file using the
612 ** [sqlite3_file_control()] interface. The second "op" argument is an 667 ** [sqlite3_file_control()] interface. The second "op" argument is an
613 ** integer opcode. The third argument is a generic pointer intended to 668 ** integer opcode. The third argument is a generic pointer intended to
614 ** point to a structure that may contain arguments or space in which to 669 ** point to a structure that may contain arguments or space in which to
615 ** write return values. Potential uses for xFileControl() might be 670 ** write return values. Potential uses for xFileControl() might be
616 ** functions to enable blocking locks with timeouts, to change the 671 ** functions to enable blocking locks with timeouts, to change the
617 ** locking strategy (for example to use dot-file locks), to inquire 672 ** locking strategy (for example to use dot-file locks), to inquire
618 ** about the status of a lock, or to break stale locks. The SQLite 673 ** about the status of a lock, or to break stale locks. The SQLite
619 ** core reserves all opcodes less than 100 for its own use. 674 ** core reserves all opcodes less than 100 for its own use.
620 ** A [SQLITE_FCNTL_LOCKSTATE | list of opcodes] less than 100 is available. 675 ** A [file control opcodes | list of opcodes] less than 100 is available.
621 ** Applications that define a custom xFileControl method should use opcodes 676 ** Applications that define a custom xFileControl method should use opcodes
622 ** greater than 100 to avoid conflicts. VFS implementations should 677 ** greater than 100 to avoid conflicts. VFS implementations should
623 ** return [SQLITE_NOTFOUND] for file control opcodes that they do not 678 ** return [SQLITE_NOTFOUND] for file control opcodes that they do not
624 ** recognize. 679 ** recognize.
625 ** 680 **
626 ** The xSectorSize() method returns the sector size of the 681 ** The xSectorSize() method returns the sector size of the
627 ** device that underlies the file. The sector size is the 682 ** device that underlies the file. The sector size is the
628 ** minimum write that can be performed without disturbing 683 ** minimum write that can be performed without disturbing
629 ** other bytes in the file. The xDeviceCharacteristics() 684 ** other bytes in the file. The xDeviceCharacteristics()
630 ** method returns a bit vector describing behaviors of the 685 ** method returns a bit vector describing behaviors of the
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after
675 int (*xCheckReservedLock)(sqlite3_file*, int *pResOut); 730 int (*xCheckReservedLock)(sqlite3_file*, int *pResOut);
676 int (*xFileControl)(sqlite3_file*, int op, void *pArg); 731 int (*xFileControl)(sqlite3_file*, int op, void *pArg);
677 int (*xSectorSize)(sqlite3_file*); 732 int (*xSectorSize)(sqlite3_file*);
678 int (*xDeviceCharacteristics)(sqlite3_file*); 733 int (*xDeviceCharacteristics)(sqlite3_file*);
679 /* Methods above are valid for version 1 */ 734 /* Methods above are valid for version 1 */
680 int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, void volatile**); 735 int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, void volatile**);
681 int (*xShmLock)(sqlite3_file*, int offset, int n, int flags); 736 int (*xShmLock)(sqlite3_file*, int offset, int n, int flags);
682 void (*xShmBarrier)(sqlite3_file*); 737 void (*xShmBarrier)(sqlite3_file*);
683 int (*xShmUnmap)(sqlite3_file*, int deleteFlag); 738 int (*xShmUnmap)(sqlite3_file*, int deleteFlag);
684 /* Methods above are valid for version 2 */ 739 /* Methods above are valid for version 2 */
740 int (*xFetch)(sqlite3_file*, sqlite3_int64 iOfst, int iAmt, void **pp);
741 int (*xUnfetch)(sqlite3_file*, sqlite3_int64 iOfst, void *p);
742 /* Methods above are valid for version 3 */
685 /* Additional methods may be added in future releases */ 743 /* Additional methods may be added in future releases */
686 }; 744 };
687 745
688 /* 746 /*
689 ** CAPI3REF: Standard File Control Opcodes 747 ** CAPI3REF: Standard File Control Opcodes
748 ** KEYWORDS: {file control opcodes} {file control opcode}
690 ** 749 **
691 ** These integer constants are opcodes for the xFileControl method 750 ** These integer constants are opcodes for the xFileControl method
692 ** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()] 751 ** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()]
693 ** interface. 752 ** interface.
694 ** 753 **
695 ** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This 754 ** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This
696 ** opcode causes the xFileControl method to write the current state of 755 ** opcode causes the xFileControl method to write the current state of
697 ** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED], 756 ** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED],
698 ** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE]) 757 ** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE])
699 ** into an integer that the pArg argument points to. This capability 758 ** into an integer that the pArg argument points to. This capability
700 ** is used during testing and only needs to be supported when SQLITE_TEST 759 ** is used during testing and only needs to be supported when SQLITE_TEST
701 ** is defined. 760 ** is defined.
702 ** 761 ** <ul>
762 ** <li>[[SQLITE_FCNTL_SIZE_HINT]]
703 ** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS 763 ** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS
704 ** layer a hint of how large the database file will grow to be during the 764 ** layer a hint of how large the database file will grow to be during the
705 ** current transaction. This hint is not guaranteed to be accurate but it 765 ** current transaction. This hint is not guaranteed to be accurate but it
706 ** is often close. The underlying VFS might choose to preallocate database 766 ** is often close. The underlying VFS might choose to preallocate database
707 ** file space based on this hint in order to help writes to the database 767 ** file space based on this hint in order to help writes to the database
708 ** file run faster. 768 ** file run faster.
709 ** 769 **
770 ** <li>[[SQLITE_FCNTL_CHUNK_SIZE]]
710 ** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS 771 ** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS
711 ** extends and truncates the database file in chunks of a size specified 772 ** extends and truncates the database file in chunks of a size specified
712 ** by the user. The fourth argument to [sqlite3_file_control()] should 773 ** by the user. The fourth argument to [sqlite3_file_control()] should
713 ** point to an integer (type int) containing the new chunk-size to use 774 ** point to an integer (type int) containing the new chunk-size to use
714 ** for the nominated database. Allocating database file space in large 775 ** for the nominated database. Allocating database file space in large
715 ** chunks (say 1MB at a time), may reduce file-system fragmentation and 776 ** chunks (say 1MB at a time), may reduce file-system fragmentation and
716 ** improve performance on some systems. 777 ** improve performance on some systems.
717 ** 778 **
779 ** <li>[[SQLITE_FCNTL_FILE_POINTER]]
718 ** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer 780 ** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer
719 ** to the [sqlite3_file] object associated with a particular database 781 ** to the [sqlite3_file] object associated with a particular database
720 ** connection. See the [sqlite3_file_control()] documentation for 782 ** connection. See the [sqlite3_file_control()] documentation for
721 ** additional information. 783 ** additional information.
722 ** 784 **
723 ** ^(The [SQLITE_FCNTL_SYNC_OMITTED] opcode is generated internally by 785 ** <li>[[SQLITE_FCNTL_SYNC_OMITTED]]
724 ** SQLite and sent to all VFSes in place of a call to the xSync method 786 ** No longer in use.
725 ** when the database connection has [PRAGMA synchronous] set to OFF.)^ 787 **
726 ** Some specialized VFSes need this signal in order to operate correctly 788 ** <li>[[SQLITE_FCNTL_SYNC]]
727 ** when [PRAGMA synchronous | PRAGMA synchronous=OFF] is set, but most 789 ** The [SQLITE_FCNTL_SYNC] opcode is generated internally by SQLite and
728 ** VFSes do not need this signal and should silently ignore this opcode. 790 ** sent to the VFS immediately before the xSync method is invoked on a
729 ** Applications should not call [sqlite3_file_control()] with this 791 ** database file descriptor. Or, if the xSync method is not invoked
730 ** opcode as doing so may disrupt the operation of the specialized VFSes 792 ** because the user has configured SQLite with
731 ** that do require it. 793 ** [PRAGMA synchronous | PRAGMA synchronous=OFF] it is invoked in place
794 ** of the xSync method. In most cases, the pointer argument passed with
795 ** this file-control is NULL. However, if the database file is being synced
796 ** as part of a multi-database commit, the argument points to a nul-terminated
797 ** string containing the transactions master-journal file name. VFSes that
798 ** do not need this signal should silently ignore this opcode. Applications
799 ** should not call [sqlite3_file_control()] with this opcode as doing so may
800 ** disrupt the operation of the specialized VFSes that do require it.
801 **
802 ** <li>[[SQLITE_FCNTL_COMMIT_PHASETWO]]
803 ** The [SQLITE_FCNTL_COMMIT_PHASETWO] opcode is generated internally by SQLite
804 ** and sent to the VFS after a transaction has been committed immediately
805 ** but before the database is unlocked. VFSes that do not need this signal
806 ** should silently ignore this opcode. Applications should not call
807 ** [sqlite3_file_control()] with this opcode as doing so may disrupt the
808 ** operation of the specialized VFSes that do require it.
809 **
810 ** <li>[[SQLITE_FCNTL_WIN32_AV_RETRY]]
811 ** ^The [SQLITE_FCNTL_WIN32_AV_RETRY] opcode is used to configure automatic
812 ** retry counts and intervals for certain disk I/O operations for the
813 ** windows [VFS] in order to provide robustness in the presence of
814 ** anti-virus programs. By default, the windows VFS will retry file read,
815 ** file write, and file delete operations up to 10 times, with a delay
816 ** of 25 milliseconds before the first retry and with the delay increasing
817 ** by an additional 25 milliseconds with each subsequent retry. This
818 ** opcode allows these two values (10 retries and 25 milliseconds of delay)
819 ** to be adjusted. The values are changed for all database connections
820 ** within the same process. The argument is a pointer to an array of two
821 ** integers where the first integer i the new retry count and the second
822 ** integer is the delay. If either integer is negative, then the setting
823 ** is not changed but instead the prior value of that setting is written
824 ** into the array entry, allowing the current retry settings to be
825 ** interrogated. The zDbName parameter is ignored.
826 **
827 ** <li>[[SQLITE_FCNTL_PERSIST_WAL]]
828 ** ^The [SQLITE_FCNTL_PERSIST_WAL] opcode is used to set or query the
829 ** persistent [WAL | Write Ahead Log] setting. By default, the auxiliary
830 ** write ahead log and shared memory files used for transaction control
831 ** are automatically deleted when the latest connection to the database
832 ** closes. Setting persistent WAL mode causes those files to persist after
833 ** close. Persisting the files is useful when other processes that do not
834 ** have write permission on the directory containing the database file want
835 ** to read the database file, as the WAL and shared memory files must exist
836 ** in order for the database to be readable. The fourth parameter to
837 ** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
838 ** That integer is 0 to disable persistent WAL mode or 1 to enable persistent
839 ** WAL mode. If the integer is -1, then it is overwritten with the current
840 ** WAL persistence setting.
841 **
842 ** <li>[[SQLITE_FCNTL_POWERSAFE_OVERWRITE]]
843 ** ^The [SQLITE_FCNTL_POWERSAFE_OVERWRITE] opcode is used to set or query the
844 ** persistent "powersafe-overwrite" or "PSOW" setting. The PSOW setting
845 ** determines the [SQLITE_IOCAP_POWERSAFE_OVERWRITE] bit of the
846 ** xDeviceCharacteristics methods. The fourth parameter to
847 ** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
848 ** That integer is 0 to disable zero-damage mode or 1 to enable zero-damage
849 ** mode. If the integer is -1, then it is overwritten with the current
850 ** zero-damage mode setting.
851 **
852 ** <li>[[SQLITE_FCNTL_OVERWRITE]]
853 ** ^The [SQLITE_FCNTL_OVERWRITE] opcode is invoked by SQLite after opening
854 ** a write transaction to indicate that, unless it is rolled back for some
855 ** reason, the entire database file will be overwritten by the current
856 ** transaction. This is used by VACUUM operations.
857 **
858 ** <li>[[SQLITE_FCNTL_VFSNAME]]
859 ** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of
860 ** all [VFSes] in the VFS stack. The names are of all VFS shims and the
861 ** final bottom-level VFS are written into memory obtained from
862 ** [sqlite3_malloc()] and the result is stored in the char* variable
863 ** that the fourth parameter of [sqlite3_file_control()] points to.
864 ** The caller is responsible for freeing the memory when done. As with
865 ** all file-control actions, there is no guarantee that this will actually
866 ** do anything. Callers should initialize the char* variable to a NULL
867 ** pointer in case this file-control is not implemented. This file-control
868 ** is intended for diagnostic use only.
869 **
870 ** <li>[[SQLITE_FCNTL_PRAGMA]]
871 ** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA]
872 ** file control is sent to the open [sqlite3_file] object corresponding
873 ** to the database file to which the pragma statement refers. ^The argument
874 ** to the [SQLITE_FCNTL_PRAGMA] file control is an array of
875 ** pointers to strings (char**) in which the second element of the array
876 ** is the name of the pragma and the third element is the argument to the
877 ** pragma or NULL if the pragma has no argument. ^The handler for an
878 ** [SQLITE_FCNTL_PRAGMA] file control can optionally make the first element
879 ** of the char** argument point to a string obtained from [sqlite3_mprintf()]
880 ** or the equivalent and that string will become the result of the pragma or
881 ** the error message if the pragma fails. ^If the
882 ** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal
883 ** [PRAGMA] processing continues. ^If the [SQLITE_FCNTL_PRAGMA]
884 ** file control returns [SQLITE_OK], then the parser assumes that the
885 ** VFS has handled the PRAGMA itself and the parser generates a no-op
886 ** prepared statement. ^If the [SQLITE_FCNTL_PRAGMA] file control returns
887 ** any result code other than [SQLITE_OK] or [SQLITE_NOTFOUND], that means
888 ** that the VFS encountered an error while handling the [PRAGMA] and the
889 ** compilation of the PRAGMA fails with an error. ^The [SQLITE_FCNTL_PRAGMA]
890 ** file control occurs at the beginning of pragma statement analysis and so
891 ** it is able to override built-in [PRAGMA] statements.
892 **
893 ** <li>[[SQLITE_FCNTL_BUSYHANDLER]]
894 ** ^The [SQLITE_FCNTL_BUSYHANDLER]
895 ** file-control may be invoked by SQLite on the database file handle
896 ** shortly after it is opened in order to provide a custom VFS with access
897 ** to the connections busy-handler callback. The argument is of type (void **)
898 ** - an array of two (void *) values. The first (void *) actually points
899 ** to a function of type (int (*)(void *)). In order to invoke the connections
900 ** busy-handler, this function should be invoked with the second (void *) in
901 ** the array as the only argument. If it returns non-zero, then the operation
902 ** should be retried. If it returns zero, the custom VFS should abandon the
903 ** current operation.
904 **
905 ** <li>[[SQLITE_FCNTL_TEMPFILENAME]]
906 ** ^Application can invoke the [SQLITE_FCNTL_TEMPFILENAME] file-control
907 ** to have SQLite generate a
908 ** temporary filename using the same algorithm that is followed to generate
909 ** temporary filenames for TEMP tables and other internal uses. The
910 ** argument should be a char** which will be filled with the filename
911 ** written into memory obtained from [sqlite3_malloc()]. The caller should
912 ** invoke [sqlite3_free()] on the result to avoid a memory leak.
913 **
914 ** <li>[[SQLITE_FCNTL_MMAP_SIZE]]
915 ** The [SQLITE_FCNTL_MMAP_SIZE] file control is used to query or set the
916 ** maximum number of bytes that will be used for memory-mapped I/O.
917 ** The argument is a pointer to a value of type sqlite3_int64 that
918 ** is an advisory maximum number of bytes in the file to memory map. The
919 ** pointer is overwritten with the old value. The limit is not changed if
920 ** the value originally pointed to is negative, and so the current limit
921 ** can be queried by passing in a pointer to a negative number. This
922 ** file-control is used internally to implement [PRAGMA mmap_size].
923 **
924 ** <li>[[SQLITE_FCNTL_TRACE]]
925 ** The [SQLITE_FCNTL_TRACE] file control provides advisory information
926 ** to the VFS about what the higher layers of the SQLite stack are doing.
927 ** This file control is used by some VFS activity tracing [shims].
928 ** The argument is a zero-terminated string. Higher layers in the
929 ** SQLite stack may generate instances of this file control if
930 ** the [SQLITE_USE_FCNTL_TRACE] compile-time option is enabled.
931 **
932 ** <li>[[SQLITE_FCNTL_HAS_MOVED]]
933 ** The [SQLITE_FCNTL_HAS_MOVED] file control interprets its argument as a
934 ** pointer to an integer and it writes a boolean into that integer depending
935 ** on whether or not the file has been renamed, moved, or deleted since it
936 ** was first opened.
937 **
938 ** <li>[[SQLITE_FCNTL_WIN32_SET_HANDLE]]
939 ** The [SQLITE_FCNTL_WIN32_SET_HANDLE] opcode is used for debugging. This
940 ** opcode causes the xFileControl method to swap the file handle with the one
941 ** pointed to by the pArg argument. This capability is used during testing
942 ** and only needs to be supported when SQLITE_TEST is defined.
943 **
944 ** </ul>
732 */ 945 */
733 #define SQLITE_FCNTL_LOCKSTATE 1 946 #define SQLITE_FCNTL_LOCKSTATE 1
734 #define SQLITE_GET_LOCKPROXYFILE 2 947 #define SQLITE_GET_LOCKPROXYFILE 2
735 #define SQLITE_SET_LOCKPROXYFILE 3 948 #define SQLITE_SET_LOCKPROXYFILE 3
736 #define SQLITE_LAST_ERRNO 4 949 #define SQLITE_LAST_ERRNO 4
737 #define SQLITE_FCNTL_SIZE_HINT 5 950 #define SQLITE_FCNTL_SIZE_HINT 5
738 #define SQLITE_FCNTL_CHUNK_SIZE 6 951 #define SQLITE_FCNTL_CHUNK_SIZE 6
739 #define SQLITE_FCNTL_FILE_POINTER 7 952 #define SQLITE_FCNTL_FILE_POINTER 7
740 #define SQLITE_FCNTL_SYNC_OMITTED 8 953 #define SQLITE_FCNTL_SYNC_OMITTED 8
741 954 #define SQLITE_FCNTL_WIN32_AV_RETRY 9
955 #define SQLITE_FCNTL_PERSIST_WAL 10
956 #define SQLITE_FCNTL_OVERWRITE 11
957 #define SQLITE_FCNTL_VFSNAME 12
958 #define SQLITE_FCNTL_POWERSAFE_OVERWRITE 13
959 #define SQLITE_FCNTL_PRAGMA 14
960 #define SQLITE_FCNTL_BUSYHANDLER 15
961 #define SQLITE_FCNTL_TEMPFILENAME 16
962 #define SQLITE_FCNTL_MMAP_SIZE 18
963 #define SQLITE_FCNTL_TRACE 19
964 #define SQLITE_FCNTL_HAS_MOVED 20
965 #define SQLITE_FCNTL_SYNC 21
966 #define SQLITE_FCNTL_COMMIT_PHASETWO 22
967 #define SQLITE_FCNTL_WIN32_SET_HANDLE 23
742 968
743 /* 969 /*
744 ** CAPI3REF: Mutex Handle 970 ** CAPI3REF: Mutex Handle
745 ** 971 **
746 ** The mutex module within SQLite defines [sqlite3_mutex] to be an 972 ** The mutex module within SQLite defines [sqlite3_mutex] to be an
747 ** abstract type for a mutex object. The SQLite core never looks 973 ** abstract type for a mutex object. The SQLite core never looks
748 ** at the internal representation of an [sqlite3_mutex]. It only 974 ** at the internal representation of an [sqlite3_mutex]. It only
749 ** deals with pointers to the [sqlite3_mutex] object. 975 ** deals with pointers to the [sqlite3_mutex] object.
750 ** 976 **
751 ** Mutexes are created using [sqlite3_mutex_alloc()]. 977 ** Mutexes are created using [sqlite3_mutex_alloc()].
752 */ 978 */
753 typedef struct sqlite3_mutex sqlite3_mutex; 979 typedef struct sqlite3_mutex sqlite3_mutex;
754 980
755 /* 981 /*
756 ** CAPI3REF: OS Interface Object 982 ** CAPI3REF: OS Interface Object
757 ** 983 **
758 ** An instance of the sqlite3_vfs object defines the interface between 984 ** An instance of the sqlite3_vfs object defines the interface between
759 ** the SQLite core and the underlying operating system. The "vfs" 985 ** the SQLite core and the underlying operating system. The "vfs"
760 ** in the name of the object stands for "virtual file system". 986 ** in the name of the object stands for "virtual file system". See
987 ** the [VFS | VFS documentation] for further information.
761 ** 988 **
762 ** The value of the iVersion field is initially 1 but may be larger in 989 ** The value of the iVersion field is initially 1 but may be larger in
763 ** future versions of SQLite. Additional fields may be appended to this 990 ** future versions of SQLite. Additional fields may be appended to this
764 ** object when the iVersion value is increased. Note that the structure 991 ** object when the iVersion value is increased. Note that the structure
765 ** of the sqlite3_vfs object changes in the transaction between 992 ** of the sqlite3_vfs object changes in the transaction between
766 ** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not 993 ** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not
767 ** modified. 994 ** modified.
768 ** 995 **
769 ** The szOsFile field is the size of the subclassed [sqlite3_file] 996 ** The szOsFile field is the size of the subclassed [sqlite3_file]
770 ** structure used by this VFS. mxPathname is the maximum length of 997 ** structure used by this VFS. mxPathname is the maximum length of
771 ** a pathname in this VFS. 998 ** a pathname in this VFS.
772 ** 999 **
773 ** Registered sqlite3_vfs objects are kept on a linked list formed by 1000 ** Registered sqlite3_vfs objects are kept on a linked list formed by
774 ** the pNext pointer. The [sqlite3_vfs_register()] 1001 ** the pNext pointer. The [sqlite3_vfs_register()]
775 ** and [sqlite3_vfs_unregister()] interfaces manage this list 1002 ** and [sqlite3_vfs_unregister()] interfaces manage this list
776 ** in a thread-safe way. The [sqlite3_vfs_find()] interface 1003 ** in a thread-safe way. The [sqlite3_vfs_find()] interface
777 ** searches the list. Neither the application code nor the VFS 1004 ** searches the list. Neither the application code nor the VFS
778 ** implementation should use the pNext pointer. 1005 ** implementation should use the pNext pointer.
779 ** 1006 **
780 ** The pNext field is the only field in the sqlite3_vfs 1007 ** The pNext field is the only field in the sqlite3_vfs
781 ** structure that SQLite will ever modify. SQLite will only access 1008 ** structure that SQLite will ever modify. SQLite will only access
782 ** or modify this field while holding a particular static mutex. 1009 ** or modify this field while holding a particular static mutex.
783 ** The application should never modify anything within the sqlite3_vfs 1010 ** The application should never modify anything within the sqlite3_vfs
784 ** object once the object has been registered. 1011 ** object once the object has been registered.
785 ** 1012 **
786 ** The zName field holds the name of the VFS module. The name must 1013 ** The zName field holds the name of the VFS module. The name must
787 ** be unique across all VFS modules. 1014 ** be unique across all VFS modules.
788 ** 1015 **
1016 ** [[sqlite3_vfs.xOpen]]
789 ** ^SQLite guarantees that the zFilename parameter to xOpen 1017 ** ^SQLite guarantees that the zFilename parameter to xOpen
790 ** is either a NULL pointer or string obtained 1018 ** is either a NULL pointer or string obtained
791 ** from xFullPathname() with an optional suffix added. 1019 ** from xFullPathname() with an optional suffix added.
792 ** ^If a suffix is added to the zFilename parameter, it will 1020 ** ^If a suffix is added to the zFilename parameter, it will
793 ** consist of a single "-" character followed by no more than 1021 ** consist of a single "-" character followed by no more than
794 ** 10 alphanumeric and/or "-" characters. 1022 ** 11 alphanumeric and/or "-" characters.
795 ** ^SQLite further guarantees that 1023 ** ^SQLite further guarantees that
796 ** the string will be valid and unchanged until xClose() is 1024 ** the string will be valid and unchanged until xClose() is
797 ** called. Because of the previous sentence, 1025 ** called. Because of the previous sentence,
798 ** the [sqlite3_file] can safely store a pointer to the 1026 ** the [sqlite3_file] can safely store a pointer to the
799 ** filename if it needs to remember the filename for some reason. 1027 ** filename if it needs to remember the filename for some reason.
800 ** If the zFilename parameter to xOpen is a NULL pointer then xOpen 1028 ** If the zFilename parameter to xOpen is a NULL pointer then xOpen
801 ** must invent its own temporary name for the file. ^Whenever the 1029 ** must invent its own temporary name for the file. ^Whenever the
802 ** xFilename parameter is NULL it will also be the case that the 1030 ** xFilename parameter is NULL it will also be the case that the
803 ** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE]. 1031 ** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE].
804 ** 1032 **
(...skipping 51 matching lines...) Expand 10 before | Expand all | Expand 10 after
856 ** ^At least szOsFile bytes of memory are allocated by SQLite 1084 ** ^At least szOsFile bytes of memory are allocated by SQLite
857 ** to hold the [sqlite3_file] structure passed as the third 1085 ** to hold the [sqlite3_file] structure passed as the third
858 ** argument to xOpen. The xOpen method does not have to 1086 ** argument to xOpen. The xOpen method does not have to
859 ** allocate the structure; it should just fill it in. Note that 1087 ** allocate the structure; it should just fill it in. Note that
860 ** the xOpen method must set the sqlite3_file.pMethods to either 1088 ** the xOpen method must set the sqlite3_file.pMethods to either
861 ** a valid [sqlite3_io_methods] object or to NULL. xOpen must do 1089 ** a valid [sqlite3_io_methods] object or to NULL. xOpen must do
862 ** this even if the open fails. SQLite expects that the sqlite3_file.pMethods 1090 ** this even if the open fails. SQLite expects that the sqlite3_file.pMethods
863 ** element will be valid after xOpen returns regardless of the success 1091 ** element will be valid after xOpen returns regardless of the success
864 ** or failure of the xOpen call. 1092 ** or failure of the xOpen call.
865 ** 1093 **
1094 ** [[sqlite3_vfs.xAccess]]
866 ** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS] 1095 ** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS]
867 ** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to 1096 ** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to
868 ** test whether a file is readable and writable, or [SQLITE_ACCESS_READ] 1097 ** test whether a file is readable and writable, or [SQLITE_ACCESS_READ]
869 ** to test whether a file is at least readable. The file can be a 1098 ** to test whether a file is at least readable. The file can be a
870 ** directory. 1099 ** directory.
871 ** 1100 **
872 ** ^SQLite will always allocate at least mxPathname+1 bytes for the 1101 ** ^SQLite will always allocate at least mxPathname+1 bytes for the
873 ** output buffer xFullPathname. The exact size of the output buffer 1102 ** output buffer xFullPathname. The exact size of the output buffer
874 ** is also passed as a parameter to both methods. If the output buffer 1103 ** is also passed as a parameter to both methods. If the output buffer
875 ** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is 1104 ** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is
876 ** handled as a fatal error by SQLite, vfs implementations should endeavor 1105 ** handled as a fatal error by SQLite, vfs implementations should endeavor
877 ** to prevent this by setting mxPathname to a sufficiently large value. 1106 ** to prevent this by setting mxPathname to a sufficiently large value.
878 ** 1107 **
879 ** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64() 1108 ** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64()
880 ** interfaces are not strictly a part of the filesystem, but they are 1109 ** interfaces are not strictly a part of the filesystem, but they are
881 ** included in the VFS structure for completeness. 1110 ** included in the VFS structure for completeness.
882 ** The xRandomness() function attempts to return nBytes bytes 1111 ** The xRandomness() function attempts to return nBytes bytes
883 ** of good-quality randomness into zOut. The return value is 1112 ** of good-quality randomness into zOut. The return value is
884 ** the actual number of bytes of randomness obtained. 1113 ** the actual number of bytes of randomness obtained.
885 ** The xSleep() method causes the calling thread to sleep for at 1114 ** The xSleep() method causes the calling thread to sleep for at
886 ** least the number of microseconds given. ^The xCurrentTime() 1115 ** least the number of microseconds given. ^The xCurrentTime()
887 ** method returns a Julian Day Number for the current date and time as 1116 ** method returns a Julian Day Number for the current date and time as
888 ** a floating point value. 1117 ** a floating point value.
889 ** ^The xCurrentTimeInt64() method returns, as an integer, the Julian 1118 ** ^The xCurrentTimeInt64() method returns, as an integer, the Julian
890 ** Day Number multipled by 86400000 (the number of milliseconds in 1119 ** Day Number multiplied by 86400000 (the number of milliseconds in
891 ** a 24-hour day). 1120 ** a 24-hour day).
892 ** ^SQLite will use the xCurrentTimeInt64() method to get the current 1121 ** ^SQLite will use the xCurrentTimeInt64() method to get the current
893 ** date and time if that method is available (if iVersion is 2 or 1122 ** date and time if that method is available (if iVersion is 2 or
894 ** greater and the function pointer is not NULL) and will fall back 1123 ** greater and the function pointer is not NULL) and will fall back
895 ** to xCurrentTime() if xCurrentTimeInt64() is unavailable. 1124 ** to xCurrentTime() if xCurrentTimeInt64() is unavailable.
896 ** 1125 **
897 ** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces 1126 ** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces
898 ** are not used by the SQLite core. These optional interfaces are provided 1127 ** are not used by the SQLite core. These optional interfaces are provided
899 ** by some VFSes to facilitate testing of the VFS code. By overriding 1128 ** by some VFSes to facilitate testing of the VFS code. By overriding
900 ** system calls with functions under its control, a test program can 1129 ** system calls with functions under its control, a test program can
(...skipping 201 matching lines...) Expand 10 before | Expand all | Expand 10 after
1102 ** must insure that no other SQLite interfaces are invoked by other 1331 ** must insure that no other SQLite interfaces are invoked by other
1103 ** threads while sqlite3_config() is running. Furthermore, sqlite3_config() 1332 ** threads while sqlite3_config() is running. Furthermore, sqlite3_config()
1104 ** may only be invoked prior to library initialization using 1333 ** may only be invoked prior to library initialization using
1105 ** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()]. 1334 ** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()].
1106 ** ^If sqlite3_config() is called after [sqlite3_initialize()] and before 1335 ** ^If sqlite3_config() is called after [sqlite3_initialize()] and before
1107 ** [sqlite3_shutdown()] then it will return SQLITE_MISUSE. 1336 ** [sqlite3_shutdown()] then it will return SQLITE_MISUSE.
1108 ** Note, however, that ^sqlite3_config() can be called as part of the 1337 ** Note, however, that ^sqlite3_config() can be called as part of the
1109 ** implementation of an application-defined [sqlite3_os_init()]. 1338 ** implementation of an application-defined [sqlite3_os_init()].
1110 ** 1339 **
1111 ** The first argument to sqlite3_config() is an integer 1340 ** The first argument to sqlite3_config() is an integer
1112 ** [SQLITE_CONFIG_SINGLETHREAD | configuration option] that determines 1341 ** [configuration option] that determines
1113 ** what property of SQLite is to be configured. Subsequent arguments 1342 ** what property of SQLite is to be configured. Subsequent arguments
1114 ** vary depending on the [SQLITE_CONFIG_SINGLETHREAD | configuration option] 1343 ** vary depending on the [configuration option]
1115 ** in the first argument. 1344 ** in the first argument.
1116 ** 1345 **
1117 ** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK]. 1346 ** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK].
1118 ** ^If the option is unknown or SQLite is unable to set the option 1347 ** ^If the option is unknown or SQLite is unable to set the option
1119 ** then this routine returns a non-zero [error code]. 1348 ** then this routine returns a non-zero [error code].
1120 */ 1349 */
1121 int sqlite3_config(int, ...); 1350 int sqlite3_config(int, ...);
1122 1351
1123 /* 1352 /*
1124 ** CAPI3REF: Configure database connections 1353 ** CAPI3REF: Configure database connections
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after
1156 ** 1385 **
1157 ** Note that SQLite comes with several [built-in memory allocators] 1386 ** Note that SQLite comes with several [built-in memory allocators]
1158 ** that are perfectly adequate for the overwhelming majority of applications 1387 ** that are perfectly adequate for the overwhelming majority of applications
1159 ** and that this object is only useful to a tiny minority of applications 1388 ** and that this object is only useful to a tiny minority of applications
1160 ** with specialized memory allocation requirements. This object is 1389 ** with specialized memory allocation requirements. This object is
1161 ** also used during testing of SQLite in order to specify an alternative 1390 ** also used during testing of SQLite in order to specify an alternative
1162 ** memory allocator that simulates memory out-of-memory conditions in 1391 ** memory allocator that simulates memory out-of-memory conditions in
1163 ** order to verify that SQLite recovers gracefully from such 1392 ** order to verify that SQLite recovers gracefully from such
1164 ** conditions. 1393 ** conditions.
1165 ** 1394 **
1166 ** The xMalloc and xFree methods must work like the 1395 ** The xMalloc, xRealloc, and xFree methods must work like the
1167 ** malloc() and free() functions from the standard C library. 1396 ** malloc(), realloc() and free() functions from the standard C library.
1168 ** The xRealloc method must work like realloc() from the standard C library 1397 ** ^SQLite guarantees that the second argument to
1169 ** with the exception that if the second argument to xRealloc is zero,
1170 ** xRealloc must be a no-op - it must not perform any allocation or
1171 ** deallocation. ^SQLite guarantees that the second argument to
1172 ** xRealloc is always a value returned by a prior call to xRoundup. 1398 ** xRealloc is always a value returned by a prior call to xRoundup.
1173 ** And so in cases where xRoundup always returns a positive number,
1174 ** xRealloc can perform exactly as the standard library realloc() and
1175 ** still be in compliance with this specification.
1176 ** 1399 **
1177 ** xSize should return the allocated size of a memory allocation 1400 ** xSize should return the allocated size of a memory allocation
1178 ** previously obtained from xMalloc or xRealloc. The allocated size 1401 ** previously obtained from xMalloc or xRealloc. The allocated size
1179 ** is always at least as big as the requested size but may be larger. 1402 ** is always at least as big as the requested size but may be larger.
1180 ** 1403 **
1181 ** The xRoundup method returns what would be the allocated size of 1404 ** The xRoundup method returns what would be the allocated size of
1182 ** a memory allocation given a particular requested size. Most memory 1405 ** a memory allocation given a particular requested size. Most memory
1183 ** allocators round up memory allocations at least to the next multiple 1406 ** allocators round up memory allocations at least to the next multiple
1184 ** of 8. Some allocators round up to a larger multiple or to a power of 2. 1407 ** of 8. Some allocators round up to a larger multiple or to a power of 2.
1185 ** Every memory allocation request coming in through [sqlite3_malloc()] 1408 ** Every memory allocation request coming in through [sqlite3_malloc()]
1186 ** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0, 1409 ** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0,
1187 ** that causes the corresponding memory allocation to fail. 1410 ** that causes the corresponding memory allocation to fail.
1188 ** 1411 **
1189 ** The xInit method initializes the memory allocator. (For example, 1412 ** The xInit method initializes the memory allocator. For example,
1190 ** it might allocate any require mutexes or initialize internal data 1413 ** it might allocate any require mutexes or initialize internal data
1191 ** structures. The xShutdown method is invoked (indirectly) by 1414 ** structures. The xShutdown method is invoked (indirectly) by
1192 ** [sqlite3_shutdown()] and should deallocate any resources acquired 1415 ** [sqlite3_shutdown()] and should deallocate any resources acquired
1193 ** by xInit. The pAppData pointer is used as the only parameter to 1416 ** by xInit. The pAppData pointer is used as the only parameter to
1194 ** xInit and xShutdown. 1417 ** xInit and xShutdown.
1195 ** 1418 **
1196 ** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes 1419 ** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes
1197 ** the xInit method, so the xInit method need not be threadsafe. The 1420 ** the xInit method, so the xInit method need not be threadsafe. The
1198 ** xShutdown method is only called from [sqlite3_shutdown()] so it does 1421 ** xShutdown method is only called from [sqlite3_shutdown()] so it does
1199 ** not need to be threadsafe either. For all other methods, SQLite 1422 ** not need to be threadsafe either. For all other methods, SQLite
(...skipping 14 matching lines...) Expand all
1214 void *(*xRealloc)(void*,int); /* Resize an allocation */ 1437 void *(*xRealloc)(void*,int); /* Resize an allocation */
1215 int (*xSize)(void*); /* Return the size of an allocation */ 1438 int (*xSize)(void*); /* Return the size of an allocation */
1216 int (*xRoundup)(int); /* Round up request size to allocation size */ 1439 int (*xRoundup)(int); /* Round up request size to allocation size */
1217 int (*xInit)(void*); /* Initialize the memory allocator */ 1440 int (*xInit)(void*); /* Initialize the memory allocator */
1218 void (*xShutdown)(void*); /* Deinitialize the memory allocator */ 1441 void (*xShutdown)(void*); /* Deinitialize the memory allocator */
1219 void *pAppData; /* Argument to xInit() and xShutdown() */ 1442 void *pAppData; /* Argument to xInit() and xShutdown() */
1220 }; 1443 };
1221 1444
1222 /* 1445 /*
1223 ** CAPI3REF: Configuration Options 1446 ** CAPI3REF: Configuration Options
1447 ** KEYWORDS: {configuration option}
1224 ** 1448 **
1225 ** These constants are the available integer configuration options that 1449 ** These constants are the available integer configuration options that
1226 ** can be passed as the first argument to the [sqlite3_config()] interface. 1450 ** can be passed as the first argument to the [sqlite3_config()] interface.
1227 ** 1451 **
1228 ** New configuration options may be added in future releases of SQLite. 1452 ** New configuration options may be added in future releases of SQLite.
1229 ** Existing configuration options might be discontinued. Applications 1453 ** Existing configuration options might be discontinued. Applications
1230 ** should check the return code from [sqlite3_config()] to make sure that 1454 ** should check the return code from [sqlite3_config()] to make sure that
1231 ** the call worked. The [sqlite3_config()] interface will return a 1455 ** the call worked. The [sqlite3_config()] interface will return a
1232 ** non-zero [error code] if a discontinued or unsupported configuration option 1456 ** non-zero [error code] if a discontinued or unsupported configuration option
1233 ** is invoked. 1457 ** is invoked.
1234 ** 1458 **
1235 ** <dl> 1459 ** <dl>
1236 ** <dt>SQLITE_CONFIG_SINGLETHREAD</dt> 1460 ** [[SQLITE_CONFIG_SINGLETHREAD]] <dt>SQLITE_CONFIG_SINGLETHREAD</dt>
1237 ** <dd>There are no arguments to this option. ^This option sets the 1461 ** <dd>There are no arguments to this option. ^This option sets the
1238 ** [threading mode] to Single-thread. In other words, it disables 1462 ** [threading mode] to Single-thread. In other words, it disables
1239 ** all mutexing and puts SQLite into a mode where it can only be used 1463 ** all mutexing and puts SQLite into a mode where it can only be used
1240 ** by a single thread. ^If SQLite is compiled with 1464 ** by a single thread. ^If SQLite is compiled with
1241 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1465 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
1242 ** it is not possible to change the [threading mode] from its default 1466 ** it is not possible to change the [threading mode] from its default
1243 ** value of Single-thread and so [sqlite3_config()] will return 1467 ** value of Single-thread and so [sqlite3_config()] will return
1244 ** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD 1468 ** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD
1245 ** configuration option.</dd> 1469 ** configuration option.</dd>
1246 ** 1470 **
1247 ** <dt>SQLITE_CONFIG_MULTITHREAD</dt> 1471 ** [[SQLITE_CONFIG_MULTITHREAD]] <dt>SQLITE_CONFIG_MULTITHREAD</dt>
1248 ** <dd>There are no arguments to this option. ^This option sets the 1472 ** <dd>There are no arguments to this option. ^This option sets the
1249 ** [threading mode] to Multi-thread. In other words, it disables 1473 ** [threading mode] to Multi-thread. In other words, it disables
1250 ** mutexing on [database connection] and [prepared statement] objects. 1474 ** mutexing on [database connection] and [prepared statement] objects.
1251 ** The application is responsible for serializing access to 1475 ** The application is responsible for serializing access to
1252 ** [database connections] and [prepared statements]. But other mutexes 1476 ** [database connections] and [prepared statements]. But other mutexes
1253 ** are enabled so that SQLite will be safe to use in a multi-threaded 1477 ** are enabled so that SQLite will be safe to use in a multi-threaded
1254 ** environment as long as no two threads attempt to use the same 1478 ** environment as long as no two threads attempt to use the same
1255 ** [database connection] at the same time. ^If SQLite is compiled with 1479 ** [database connection] at the same time. ^If SQLite is compiled with
1256 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1480 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
1257 ** it is not possible to set the Multi-thread [threading mode] and 1481 ** it is not possible to set the Multi-thread [threading mode] and
1258 ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the 1482 ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
1259 ** SQLITE_CONFIG_MULTITHREAD configuration option.</dd> 1483 ** SQLITE_CONFIG_MULTITHREAD configuration option.</dd>
1260 ** 1484 **
1261 ** <dt>SQLITE_CONFIG_SERIALIZED</dt> 1485 ** [[SQLITE_CONFIG_SERIALIZED]] <dt>SQLITE_CONFIG_SERIALIZED</dt>
1262 ** <dd>There are no arguments to this option. ^This option sets the 1486 ** <dd>There are no arguments to this option. ^This option sets the
1263 ** [threading mode] to Serialized. In other words, this option enables 1487 ** [threading mode] to Serialized. In other words, this option enables
1264 ** all mutexes including the recursive 1488 ** all mutexes including the recursive
1265 ** mutexes on [database connection] and [prepared statement] objects. 1489 ** mutexes on [database connection] and [prepared statement] objects.
1266 ** In this mode (which is the default when SQLite is compiled with 1490 ** In this mode (which is the default when SQLite is compiled with
1267 ** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access 1491 ** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access
1268 ** to [database connections] and [prepared statements] so that the 1492 ** to [database connections] and [prepared statements] so that the
1269 ** application is free to use the same [database connection] or the 1493 ** application is free to use the same [database connection] or the
1270 ** same [prepared statement] in different threads at the same time. 1494 ** same [prepared statement] in different threads at the same time.
1271 ** ^If SQLite is compiled with 1495 ** ^If SQLite is compiled with
1272 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1496 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
1273 ** it is not possible to set the Serialized [threading mode] and 1497 ** it is not possible to set the Serialized [threading mode] and
1274 ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the 1498 ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
1275 ** SQLITE_CONFIG_SERIALIZED configuration option.</dd> 1499 ** SQLITE_CONFIG_SERIALIZED configuration option.</dd>
1276 ** 1500 **
1277 ** <dt>SQLITE_CONFIG_MALLOC</dt> 1501 ** [[SQLITE_CONFIG_MALLOC]] <dt>SQLITE_CONFIG_MALLOC</dt>
1278 ** <dd> ^(This option takes a single argument which is a pointer to an 1502 ** <dd> ^(This option takes a single argument which is a pointer to an
1279 ** instance of the [sqlite3_mem_methods] structure. The argument specifies 1503 ** instance of the [sqlite3_mem_methods] structure. The argument specifies
1280 ** alternative low-level memory allocation routines to be used in place of 1504 ** alternative low-level memory allocation routines to be used in place of
1281 ** the memory allocation routines built into SQLite.)^ ^SQLite makes 1505 ** the memory allocation routines built into SQLite.)^ ^SQLite makes
1282 ** its own private copy of the content of the [sqlite3_mem_methods] structure 1506 ** its own private copy of the content of the [sqlite3_mem_methods] structure
1283 ** before the [sqlite3_config()] call returns.</dd> 1507 ** before the [sqlite3_config()] call returns.</dd>
1284 ** 1508 **
1285 ** <dt>SQLITE_CONFIG_GETMALLOC</dt> 1509 ** [[SQLITE_CONFIG_GETMALLOC]] <dt>SQLITE_CONFIG_GETMALLOC</dt>
1286 ** <dd> ^(This option takes a single argument which is a pointer to an 1510 ** <dd> ^(This option takes a single argument which is a pointer to an
1287 ** instance of the [sqlite3_mem_methods] structure. The [sqlite3_mem_methods] 1511 ** instance of the [sqlite3_mem_methods] structure. The [sqlite3_mem_methods]
1288 ** structure is filled with the currently defined memory allocation routines.)^ 1512 ** structure is filled with the currently defined memory allocation routines.)^
1289 ** This option can be used to overload the default memory allocation 1513 ** This option can be used to overload the default memory allocation
1290 ** routines with a wrapper that simulations memory allocation failure or 1514 ** routines with a wrapper that simulations memory allocation failure or
1291 ** tracks memory usage, for example. </dd> 1515 ** tracks memory usage, for example. </dd>
1292 ** 1516 **
1293 ** <dt>SQLITE_CONFIG_MEMSTATUS</dt> 1517 ** [[SQLITE_CONFIG_MEMSTATUS]] <dt>SQLITE_CONFIG_MEMSTATUS</dt>
1294 ** <dd> ^This option takes single argument of type int, interpreted as a 1518 ** <dd> ^This option takes single argument of type int, interpreted as a
1295 ** boolean, which enables or disables the collection of memory allocation 1519 ** boolean, which enables or disables the collection of memory allocation
1296 ** statistics. ^(When memory allocation statistics are disabled, the 1520 ** statistics. ^(When memory allocation statistics are disabled, the
1297 ** following SQLite interfaces become non-operational: 1521 ** following SQLite interfaces become non-operational:
1298 ** <ul> 1522 ** <ul>
1299 ** <li> [sqlite3_memory_used()] 1523 ** <li> [sqlite3_memory_used()]
1300 ** <li> [sqlite3_memory_highwater()] 1524 ** <li> [sqlite3_memory_highwater()]
1301 ** <li> [sqlite3_soft_heap_limit64()] 1525 ** <li> [sqlite3_soft_heap_limit64()]
1302 ** <li> [sqlite3_status()] 1526 ** <li> [sqlite3_status()]
1303 ** </ul>)^ 1527 ** </ul>)^
1304 ** ^Memory allocation statistics are enabled by default unless SQLite is 1528 ** ^Memory allocation statistics are enabled by default unless SQLite is
1305 ** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory 1529 ** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory
1306 ** allocation statistics are disabled by default. 1530 ** allocation statistics are disabled by default.
1307 ** </dd> 1531 ** </dd>
1308 ** 1532 **
1309 ** <dt>SQLITE_CONFIG_SCRATCH</dt> 1533 ** [[SQLITE_CONFIG_SCRATCH]] <dt>SQLITE_CONFIG_SCRATCH</dt>
1310 ** <dd> ^This option specifies a static memory buffer that SQLite can use for 1534 ** <dd> ^This option specifies a static memory buffer that SQLite can use for
1311 ** scratch memory. There are three arguments: A pointer an 8-byte 1535 ** scratch memory. There are three arguments: A pointer an 8-byte
1312 ** aligned memory buffer from which the scratch allocations will be 1536 ** aligned memory buffer from which the scratch allocations will be
1313 ** drawn, the size of each scratch allocation (sz), 1537 ** drawn, the size of each scratch allocation (sz),
1314 ** and the maximum number of scratch allocations (N). The sz 1538 ** and the maximum number of scratch allocations (N). The sz
1315 ** argument must be a multiple of 16. 1539 ** argument must be a multiple of 16.
1316 ** The first argument must be a pointer to an 8-byte aligned buffer 1540 ** The first argument must be a pointer to an 8-byte aligned buffer
1317 ** of at least sz*N bytes of memory. 1541 ** of at least sz*N bytes of memory.
1318 ** ^SQLite will use no more than two scratch buffers per thread. So 1542 ** ^SQLite will use no more than two scratch buffers per thread. So
1319 ** N should be set to twice the expected maximum number of threads. 1543 ** N should be set to twice the expected maximum number of threads.
1320 ** ^SQLite will never require a scratch buffer that is more than 6 1544 ** ^SQLite will never require a scratch buffer that is more than 6
1321 ** times the database page size. ^If SQLite needs needs additional 1545 ** times the database page size. ^If SQLite needs needs additional
1322 ** scratch memory beyond what is provided by this configuration option, then 1546 ** scratch memory beyond what is provided by this configuration option, then
1323 ** [sqlite3_malloc()] will be used to obtain the memory needed.</dd> 1547 ** [sqlite3_malloc()] will be used to obtain the memory needed.</dd>
1324 ** 1548 **
1325 ** <dt>SQLITE_CONFIG_PAGECACHE</dt> 1549 ** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt>
1326 ** <dd> ^This option specifies a static memory buffer that SQLite can use for 1550 ** <dd> ^This option specifies a static memory buffer that SQLite can use for
1327 ** the database page cache with the default page cache implemenation. 1551 ** the database page cache with the default page cache implementation.
1328 ** This configuration should not be used if an application-define page 1552 ** This configuration should not be used if an application-define page
1329 ** cache implementation is loaded using the SQLITE_CONFIG_PCACHE option. 1553 ** cache implementation is loaded using the SQLITE_CONFIG_PCACHE2 option.
1330 ** There are three arguments to this option: A pointer to 8-byte aligned 1554 ** There are three arguments to this option: A pointer to 8-byte aligned
1331 ** memory, the size of each page buffer (sz), and the number of pages (N). 1555 ** memory, the size of each page buffer (sz), and the number of pages (N).
1332 ** The sz argument should be the size of the largest database page 1556 ** The sz argument should be the size of the largest database page
1333 ** (a power of two between 512 and 32768) plus a little extra for each 1557 ** (a power of two between 512 and 32768) plus a little extra for each
1334 ** page header. ^The page header size is 20 to 40 bytes depending on 1558 ** page header. ^The page header size is 20 to 40 bytes depending on
1335 ** the host architecture. ^It is harmless, apart from the wasted memory, 1559 ** the host architecture. ^It is harmless, apart from the wasted memory,
1336 ** to make sz a little too large. The first 1560 ** to make sz a little too large. The first
1337 ** argument should point to an allocation of at least sz*N bytes of memory. 1561 ** argument should point to an allocation of at least sz*N bytes of memory.
1338 ** ^SQLite will use the memory provided by the first argument to satisfy its 1562 ** ^SQLite will use the memory provided by the first argument to satisfy its
1339 ** memory needs for the first N pages that it adds to cache. ^If additional 1563 ** memory needs for the first N pages that it adds to cache. ^If additional
1340 ** page cache memory is needed beyond what is provided by this option, then 1564 ** page cache memory is needed beyond what is provided by this option, then
1341 ** SQLite goes to [sqlite3_malloc()] for the additional storage space. 1565 ** SQLite goes to [sqlite3_malloc()] for the additional storage space.
1342 ** The pointer in the first argument must 1566 ** The pointer in the first argument must
1343 ** be aligned to an 8-byte boundary or subsequent behavior of SQLite 1567 ** be aligned to an 8-byte boundary or subsequent behavior of SQLite
1344 ** will be undefined.</dd> 1568 ** will be undefined.</dd>
1345 ** 1569 **
1346 ** <dt>SQLITE_CONFIG_HEAP</dt> 1570 ** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt>
1347 ** <dd> ^This option specifies a static memory buffer that SQLite will use 1571 ** <dd> ^This option specifies a static memory buffer that SQLite will use
1348 ** for all of its dynamic memory allocation needs beyond those provided 1572 ** for all of its dynamic memory allocation needs beyond those provided
1349 ** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE]. 1573 ** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE].
1350 ** There are three arguments: An 8-byte aligned pointer to the memory, 1574 ** There are three arguments: An 8-byte aligned pointer to the memory,
1351 ** the number of bytes in the memory buffer, and the minimum allocation size. 1575 ** the number of bytes in the memory buffer, and the minimum allocation size.
1352 ** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts 1576 ** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts
1353 ** to using its default memory allocator (the system malloc() implementation), 1577 ** to using its default memory allocator (the system malloc() implementation),
1354 ** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the 1578 ** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the
1355 ** memory pointer is not NULL and either [SQLITE_ENABLE_MEMSYS3] or 1579 ** memory pointer is not NULL and either [SQLITE_ENABLE_MEMSYS3] or
1356 ** [SQLITE_ENABLE_MEMSYS5] are defined, then the alternative memory 1580 ** [SQLITE_ENABLE_MEMSYS5] are defined, then the alternative memory
1357 ** allocator is engaged to handle all of SQLites memory allocation needs. 1581 ** allocator is engaged to handle all of SQLites memory allocation needs.
1358 ** The first pointer (the memory pointer) must be aligned to an 8-byte 1582 ** The first pointer (the memory pointer) must be aligned to an 8-byte
1359 ** boundary or subsequent behavior of SQLite will be undefined. 1583 ** boundary or subsequent behavior of SQLite will be undefined.
1360 ** The minimum allocation size is capped at 2^12. Reasonable values 1584 ** The minimum allocation size is capped at 2**12. Reasonable values
1361 ** for the minimum allocation size are 2^5 through 2^8.</dd> 1585 ** for the minimum allocation size are 2**5 through 2**8.</dd>
1362 ** 1586 **
1363 ** <dt>SQLITE_CONFIG_MUTEX</dt> 1587 ** [[SQLITE_CONFIG_MUTEX]] <dt>SQLITE_CONFIG_MUTEX</dt>
1364 ** <dd> ^(This option takes a single argument which is a pointer to an 1588 ** <dd> ^(This option takes a single argument which is a pointer to an
1365 ** instance of the [sqlite3_mutex_methods] structure. The argument specifies 1589 ** instance of the [sqlite3_mutex_methods] structure. The argument specifies
1366 ** alternative low-level mutex routines to be used in place 1590 ** alternative low-level mutex routines to be used in place
1367 ** the mutex routines built into SQLite.)^ ^SQLite makes a copy of the 1591 ** the mutex routines built into SQLite.)^ ^SQLite makes a copy of the
1368 ** content of the [sqlite3_mutex_methods] structure before the call to 1592 ** content of the [sqlite3_mutex_methods] structure before the call to
1369 ** [sqlite3_config()] returns. ^If SQLite is compiled with 1593 ** [sqlite3_config()] returns. ^If SQLite is compiled with
1370 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1594 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
1371 ** the entire mutexing subsystem is omitted from the build and hence calls to 1595 ** the entire mutexing subsystem is omitted from the build and hence calls to
1372 ** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will 1596 ** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will
1373 ** return [SQLITE_ERROR].</dd> 1597 ** return [SQLITE_ERROR].</dd>
1374 ** 1598 **
1375 ** <dt>SQLITE_CONFIG_GETMUTEX</dt> 1599 ** [[SQLITE_CONFIG_GETMUTEX]] <dt>SQLITE_CONFIG_GETMUTEX</dt>
1376 ** <dd> ^(This option takes a single argument which is a pointer to an 1600 ** <dd> ^(This option takes a single argument which is a pointer to an
1377 ** instance of the [sqlite3_mutex_methods] structure. The 1601 ** instance of the [sqlite3_mutex_methods] structure. The
1378 ** [sqlite3_mutex_methods] 1602 ** [sqlite3_mutex_methods]
1379 ** structure is filled with the currently defined mutex routines.)^ 1603 ** structure is filled with the currently defined mutex routines.)^
1380 ** This option can be used to overload the default mutex allocation 1604 ** This option can be used to overload the default mutex allocation
1381 ** routines with a wrapper used to track mutex usage for performance 1605 ** routines with a wrapper used to track mutex usage for performance
1382 ** profiling or testing, for example. ^If SQLite is compiled with 1606 ** profiling or testing, for example. ^If SQLite is compiled with
1383 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then 1607 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
1384 ** the entire mutexing subsystem is omitted from the build and hence calls to 1608 ** the entire mutexing subsystem is omitted from the build and hence calls to
1385 ** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will 1609 ** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will
1386 ** return [SQLITE_ERROR].</dd> 1610 ** return [SQLITE_ERROR].</dd>
1387 ** 1611 **
1388 ** <dt>SQLITE_CONFIG_LOOKASIDE</dt> 1612 ** [[SQLITE_CONFIG_LOOKASIDE]] <dt>SQLITE_CONFIG_LOOKASIDE</dt>
1389 ** <dd> ^(This option takes two arguments that determine the default 1613 ** <dd> ^(This option takes two arguments that determine the default
1390 ** memory allocation for the lookaside memory allocator on each 1614 ** memory allocation for the lookaside memory allocator on each
1391 ** [database connection]. The first argument is the 1615 ** [database connection]. The first argument is the
1392 ** size of each lookaside buffer slot and the second is the number of 1616 ** size of each lookaside buffer slot and the second is the number of
1393 ** slots allocated to each database connection.)^ ^(This option sets the 1617 ** slots allocated to each database connection.)^ ^(This option sets the
1394 ** <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE] 1618 ** <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE]
1395 ** verb to [sqlite3_db_config()] can be used to change the lookaside 1619 ** verb to [sqlite3_db_config()] can be used to change the lookaside
1396 ** configuration on individual connections.)^ </dd> 1620 ** configuration on individual connections.)^ </dd>
1397 ** 1621 **
1398 ** <dt>SQLITE_CONFIG_PCACHE</dt> 1622 ** [[SQLITE_CONFIG_PCACHE2]] <dt>SQLITE_CONFIG_PCACHE2</dt>
1399 ** <dd> ^(This option takes a single argument which is a pointer to 1623 ** <dd> ^(This option takes a single argument which is a pointer to
1400 ** an [sqlite3_pcache_methods] object. This object specifies the interface 1624 ** an [sqlite3_pcache_methods2] object. This object specifies the interface
1401 ** to a custom page cache implementation.)^ ^SQLite makes a copy of the 1625 ** to a custom page cache implementation.)^ ^SQLite makes a copy of the
1402 ** object and uses it for page cache memory allocations.</dd> 1626 ** object and uses it for page cache memory allocations.</dd>
1403 ** 1627 **
1404 ** <dt>SQLITE_CONFIG_GETPCACHE</dt> 1628 ** [[SQLITE_CONFIG_GETPCACHE2]] <dt>SQLITE_CONFIG_GETPCACHE2</dt>
1405 ** <dd> ^(This option takes a single argument which is a pointer to an 1629 ** <dd> ^(This option takes a single argument which is a pointer to an
1406 ** [sqlite3_pcache_methods] object. SQLite copies of the current 1630 ** [sqlite3_pcache_methods2] object. SQLite copies of the current
1407 ** page cache implementation into that object.)^ </dd> 1631 ** page cache implementation into that object.)^ </dd>
1408 ** 1632 **
1409 ** <dt>SQLITE_CONFIG_LOG</dt> 1633 ** [[SQLITE_CONFIG_LOG]] <dt>SQLITE_CONFIG_LOG</dt>
1410 ** <dd> ^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a 1634 ** <dd> The SQLITE_CONFIG_LOG option is used to configure the SQLite
1635 ** global [error log].
1636 ** (^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a
1411 ** function with a call signature of void(*)(void*,int,const char*), 1637 ** function with a call signature of void(*)(void*,int,const char*),
1412 ** and a pointer to void. ^If the function pointer is not NULL, it is 1638 ** and a pointer to void. ^If the function pointer is not NULL, it is
1413 ** invoked by [sqlite3_log()] to process each logging event. ^If the 1639 ** invoked by [sqlite3_log()] to process each logging event. ^If the
1414 ** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op. 1640 ** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op.
1415 ** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is 1641 ** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is
1416 ** passed through as the first parameter to the application-defined logger 1642 ** passed through as the first parameter to the application-defined logger
1417 ** function whenever that function is invoked. ^The second parameter to 1643 ** function whenever that function is invoked. ^The second parameter to
1418 ** the logger function is a copy of the first parameter to the corresponding 1644 ** the logger function is a copy of the first parameter to the corresponding
1419 ** [sqlite3_log()] call and is intended to be a [result code] or an 1645 ** [sqlite3_log()] call and is intended to be a [result code] or an
1420 ** [extended result code]. ^The third parameter passed to the logger is 1646 ** [extended result code]. ^The third parameter passed to the logger is
1421 ** log message after formatting via [sqlite3_snprintf()]. 1647 ** log message after formatting via [sqlite3_snprintf()].
1422 ** The SQLite logging interface is not reentrant; the logger function 1648 ** The SQLite logging interface is not reentrant; the logger function
1423 ** supplied by the application must not invoke any SQLite interface. 1649 ** supplied by the application must not invoke any SQLite interface.
1424 ** In a multi-threaded application, the application-defined logger 1650 ** In a multi-threaded application, the application-defined logger
1425 ** function must be threadsafe. </dd> 1651 ** function must be threadsafe. </dd>
1426 ** 1652 **
1653 ** [[SQLITE_CONFIG_URI]] <dt>SQLITE_CONFIG_URI
1654 ** <dd>^(This option takes a single argument of type int. If non-zero, then
1655 ** URI handling is globally enabled. If the parameter is zero, then URI handling
1656 ** is globally disabled.)^ ^If URI handling is globally enabled, all filenames
1657 ** passed to [sqlite3_open()], [sqlite3_open_v2()], [sqlite3_open16()] or
1658 ** specified as part of [ATTACH] commands are interpreted as URIs, regardless
1659 ** of whether or not the [SQLITE_OPEN_URI] flag is set when the database
1660 ** connection is opened. ^If it is globally disabled, filenames are
1661 ** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the
1662 ** database connection is opened. ^(By default, URI handling is globally
1663 ** disabled. The default value may be changed by compiling with the
1664 ** [SQLITE_USE_URI] symbol defined.)^
1665 **
1666 ** [[SQLITE_CONFIG_COVERING_INDEX_SCAN]] <dt>SQLITE_CONFIG_COVERING_INDEX_SCAN
1667 ** <dd>^This option takes a single integer argument which is interpreted as
1668 ** a boolean in order to enable or disable the use of covering indices for
1669 ** full table scans in the query optimizer. ^The default setting is determined
1670 ** by the [SQLITE_ALLOW_COVERING_INDEX_SCAN] compile-time option, or is "on"
1671 ** if that compile-time option is omitted.
1672 ** The ability to disable the use of covering indices for full table scans
1673 ** is because some incorrectly coded legacy applications might malfunction
1674 ** when the optimization is enabled. Providing the ability to
1675 ** disable the optimization allows the older, buggy application code to work
1676 ** without change even with newer versions of SQLite.
1677 **
1678 ** [[SQLITE_CONFIG_PCACHE]] [[SQLITE_CONFIG_GETPCACHE]]
1679 ** <dt>SQLITE_CONFIG_PCACHE and SQLITE_CONFIG_GETPCACHE
1680 ** <dd> These options are obsolete and should not be used by new code.
1681 ** They are retained for backwards compatibility but are now no-ops.
1682 ** </dd>
1683 **
1684 ** [[SQLITE_CONFIG_SQLLOG]]
1685 ** <dt>SQLITE_CONFIG_SQLLOG
1686 ** <dd>This option is only available if sqlite is compiled with the
1687 ** [SQLITE_ENABLE_SQLLOG] pre-processor macro defined. The first argument should
1688 ** be a pointer to a function of type void(*)(void*,sqlite3*,const char*, int).
1689 ** The second should be of type (void*). The callback is invoked by the library
1690 ** in three separate circumstances, identified by the value passed as the
1691 ** fourth parameter. If the fourth parameter is 0, then the database connection
1692 ** passed as the second argument has just been opened. The third argument
1693 ** points to a buffer containing the name of the main database file. If the
1694 ** fourth parameter is 1, then the SQL statement that the third parameter
1695 ** points to has just been executed. Or, if the fourth parameter is 2, then
1696 ** the connection being passed as the second parameter is being closed. The
1697 ** third parameter is passed NULL In this case. An example of using this
1698 ** configuration option can be seen in the "test_sqllog.c" source file in
1699 ** the canonical SQLite source tree.</dd>
1700 **
1701 ** [[SQLITE_CONFIG_MMAP_SIZE]]
1702 ** <dt>SQLITE_CONFIG_MMAP_SIZE
1703 ** <dd>^SQLITE_CONFIG_MMAP_SIZE takes two 64-bit integer (sqlite3_int64) values
1704 ** that are the default mmap size limit (the default setting for
1705 ** [PRAGMA mmap_size]) and the maximum allowed mmap size limit.
1706 ** ^The default setting can be overridden by each database connection using
1707 ** either the [PRAGMA mmap_size] command, or by using the
1708 ** [SQLITE_FCNTL_MMAP_SIZE] file control. ^(The maximum allowed mmap size
1709 ** cannot be changed at run-time. Nor may the maximum allowed mmap size
1710 ** exceed the compile-time maximum mmap size set by the
1711 ** [SQLITE_MAX_MMAP_SIZE] compile-time option.)^
1712 ** ^If either argument to this option is negative, then that argument is
1713 ** changed to its compile-time default.
1714 **
1715 ** [[SQLITE_CONFIG_WIN32_HEAPSIZE]]
1716 ** <dt>SQLITE_CONFIG_WIN32_HEAPSIZE
1717 ** <dd>^This option is only available if SQLite is compiled for Windows
1718 ** with the [SQLITE_WIN32_MALLOC] pre-processor macro defined.
1719 ** SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit unsigned integer value
1720 ** that specifies the maximum size of the created heap.
1427 ** </dl> 1721 ** </dl>
1428 */ 1722 */
1429 #define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */ 1723 #define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */
1430 #define SQLITE_CONFIG_MULTITHREAD 2 /* nil */ 1724 #define SQLITE_CONFIG_MULTITHREAD 2 /* nil */
1431 #define SQLITE_CONFIG_SERIALIZED 3 /* nil */ 1725 #define SQLITE_CONFIG_SERIALIZED 3 /* nil */
1432 #define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */ 1726 #define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */
1433 #define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */ 1727 #define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */
1434 #define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */ 1728 #define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */
1435 #define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */ 1729 #define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */
1436 #define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */ 1730 #define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */
1437 #define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */ 1731 #define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */
1438 #define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */ 1732 #define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */
1439 #define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */ 1733 #define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */
1440 /* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */ 1734 /* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */
1441 #define SQLITE_CONFIG_LOOKASIDE 13 /* int int */ 1735 #define SQLITE_CONFIG_LOOKASIDE 13 /* int int */
1442 #define SQLITE_CONFIG_PCACHE 14 /* sqlite3_pcache_methods* */ 1736 #define SQLITE_CONFIG_PCACHE 14 /* no-op */
1443 #define SQLITE_CONFIG_GETPCACHE 15 /* sqlite3_pcache_methods* */ 1737 #define SQLITE_CONFIG_GETPCACHE 15 /* no-op */
1444 #define SQLITE_CONFIG_LOG 16 /* xFunc, void* */ 1738 #define SQLITE_CONFIG_LOG 16 /* xFunc, void* */
1739 #define SQLITE_CONFIG_URI 17 /* int */
1740 #define SQLITE_CONFIG_PCACHE2 18 /* sqlite3_pcache_methods2* */
1741 #define SQLITE_CONFIG_GETPCACHE2 19 /* sqlite3_pcache_methods2* */
1742 #define SQLITE_CONFIG_COVERING_INDEX_SCAN 20 /* int */
1743 #define SQLITE_CONFIG_SQLLOG 21 /* xSqllog, void* */
1744 #define SQLITE_CONFIG_MMAP_SIZE 22 /* sqlite3_int64, sqlite3_int64 */
1745 #define SQLITE_CONFIG_WIN32_HEAPSIZE 23 /* int nByte */
1445 1746
1446 /* 1747 /*
1447 ** CAPI3REF: Database Connection Configuration Options 1748 ** CAPI3REF: Database Connection Configuration Options
1448 ** 1749 **
1449 ** These constants are the available integer configuration options that 1750 ** These constants are the available integer configuration options that
1450 ** can be passed as the second argument to the [sqlite3_db_config()] interface. 1751 ** can be passed as the second argument to the [sqlite3_db_config()] interface.
1451 ** 1752 **
1452 ** New configuration options may be added in future releases of SQLite. 1753 ** New configuration options may be added in future releases of SQLite.
1453 ** Existing configuration options might be discontinued. Applications 1754 ** Existing configuration options might be discontinued. Applications
1454 ** should check the return code from [sqlite3_db_config()] to make sure that 1755 ** should check the return code from [sqlite3_db_config()] to make sure that
(...skipping 56 matching lines...) Expand 10 before | Expand all | Expand 10 after
1511 ** 1812 **
1512 ** ^The sqlite3_extended_result_codes() routine enables or disables the 1813 ** ^The sqlite3_extended_result_codes() routine enables or disables the
1513 ** [extended result codes] feature of SQLite. ^The extended result 1814 ** [extended result codes] feature of SQLite. ^The extended result
1514 ** codes are disabled by default for historical compatibility. 1815 ** codes are disabled by default for historical compatibility.
1515 */ 1816 */
1516 int sqlite3_extended_result_codes(sqlite3*, int onoff); 1817 int sqlite3_extended_result_codes(sqlite3*, int onoff);
1517 1818
1518 /* 1819 /*
1519 ** CAPI3REF: Last Insert Rowid 1820 ** CAPI3REF: Last Insert Rowid
1520 ** 1821 **
1521 ** ^Each entry in an SQLite table has a unique 64-bit signed 1822 ** ^Each entry in most SQLite tables (except for [WITHOUT ROWID] tables)
1823 ** has a unique 64-bit signed
1522 ** integer key called the [ROWID | "rowid"]. ^The rowid is always available 1824 ** integer key called the [ROWID | "rowid"]. ^The rowid is always available
1523 ** as an undeclared column named ROWID, OID, or _ROWID_ as long as those 1825 ** as an undeclared column named ROWID, OID, or _ROWID_ as long as those
1524 ** names are not also used by explicitly declared columns. ^If 1826 ** names are not also used by explicitly declared columns. ^If
1525 ** the table has a column of type [INTEGER PRIMARY KEY] then that column 1827 ** the table has a column of type [INTEGER PRIMARY KEY] then that column
1526 ** is another alias for the rowid. 1828 ** is another alias for the rowid.
1527 ** 1829 **
1528 ** ^This routine returns the [rowid] of the most recent 1830 ** ^The sqlite3_last_insert_rowid(D) interface returns the [rowid] of the
1529 ** successful [INSERT] into the database from the [database connection] 1831 ** most recent successful [INSERT] into a rowid table or [virtual table]
1530 ** in the first argument. ^If no successful [INSERT]s 1832 ** on database connection D.
1531 ** have ever occurred on that database connection, zero is returned. 1833 ** ^Inserts into [WITHOUT ROWID] tables are not recorded.
1834 ** ^If no successful [INSERT]s into rowid tables
1835 ** have ever occurred on the database connection D,
1836 ** then sqlite3_last_insert_rowid(D) returns zero.
1532 ** 1837 **
1533 ** ^(If an [INSERT] occurs within a trigger, then the [rowid] of the inserted 1838 ** ^(If an [INSERT] occurs within a trigger or within a [virtual table]
1534 ** row is returned by this routine as long as the trigger is running. 1839 ** method, then this routine will return the [rowid] of the inserted
1535 ** But once the trigger terminates, the value returned by this routine 1840 ** row as long as the trigger or virtual table method is running.
1536 ** reverts to the last value inserted before the trigger fired.)^ 1841 ** But once the trigger or virtual table method ends, the value returned
1842 ** by this routine reverts to what it was before the trigger or virtual
1843 ** table method began.)^
1537 ** 1844 **
1538 ** ^An [INSERT] that fails due to a constraint violation is not a 1845 ** ^An [INSERT] that fails due to a constraint violation is not a
1539 ** successful [INSERT] and does not change the value returned by this 1846 ** successful [INSERT] and does not change the value returned by this
1540 ** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK, 1847 ** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK,
1541 ** and INSERT OR ABORT make no changes to the return value of this 1848 ** and INSERT OR ABORT make no changes to the return value of this
1542 ** routine when their insertion fails. ^(When INSERT OR REPLACE 1849 ** routine when their insertion fails. ^(When INSERT OR REPLACE
1543 ** encounters a constraint violation, it does not fail. The 1850 ** encounters a constraint violation, it does not fail. The
1544 ** INSERT continues to completion after deleting rows that caused 1851 ** INSERT continues to completion after deleting rows that caused
1545 ** the constraint problem so INSERT OR REPLACE will always change 1852 ** the constraint problem so INSERT OR REPLACE will always change
1546 ** the return value of this interface.)^ 1853 ** the return value of this interface.)^
(...skipping 164 matching lines...) Expand 10 before | Expand all | Expand 10 after
1711 ** 2018 **
1712 ** The input to [sqlite3_complete16()] must be a zero-terminated 2019 ** The input to [sqlite3_complete16()] must be a zero-terminated
1713 ** UTF-16 string in native byte order. 2020 ** UTF-16 string in native byte order.
1714 */ 2021 */
1715 int sqlite3_complete(const char *sql); 2022 int sqlite3_complete(const char *sql);
1716 int sqlite3_complete16(const void *sql); 2023 int sqlite3_complete16(const void *sql);
1717 2024
1718 /* 2025 /*
1719 ** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors 2026 ** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors
1720 ** 2027 **
1721 ** ^This routine sets a callback function that might be invoked whenever 2028 ** ^The sqlite3_busy_handler(D,X,P) routine sets a callback function X
1722 ** an attempt is made to open a database table that another thread 2029 ** that might be invoked with argument P whenever
1723 ** or process has locked. 2030 ** an attempt is made to access a database table associated with
2031 ** [database connection] D when another thread
2032 ** or process has the table locked.
2033 ** The sqlite3_busy_handler() interface is used to implement
2034 ** [sqlite3_busy_timeout()] and [PRAGMA busy_timeout].
1724 ** 2035 **
1725 ** ^If the busy callback is NULL, then [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] 2036 ** ^If the busy callback is NULL, then [SQLITE_BUSY]
1726 ** is returned immediately upon encountering the lock. ^If the busy callback 2037 ** is returned immediately upon encountering the lock. ^If the busy callback
1727 ** is not NULL, then the callback might be invoked with two arguments. 2038 ** is not NULL, then the callback might be invoked with two arguments.
1728 ** 2039 **
1729 ** ^The first argument to the busy handler is a copy of the void* pointer which 2040 ** ^The first argument to the busy handler is a copy of the void* pointer which
1730 ** is the third argument to sqlite3_busy_handler(). ^The second argument to 2041 ** is the third argument to sqlite3_busy_handler(). ^The second argument to
1731 ** the busy handler callback is the number of times that the busy handler has 2042 ** the busy handler callback is the number of times that the busy handler has
1732 ** been invoked for this locking event. ^If the 2043 ** been invoked for the same locking event. ^If the
1733 ** busy callback returns 0, then no additional attempts are made to 2044 ** busy callback returns 0, then no additional attempts are made to
1734 ** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned. 2045 ** access the database and [SQLITE_BUSY] is returned
2046 ** to the application.
1735 ** ^If the callback returns non-zero, then another attempt 2047 ** ^If the callback returns non-zero, then another attempt
1736 ** is made to open the database for reading and the cycle repeats. 2048 ** is made to access the database and the cycle repeats.
1737 ** 2049 **
1738 ** The presence of a busy handler does not guarantee that it will be invoked 2050 ** The presence of a busy handler does not guarantee that it will be invoked
1739 ** when there is lock contention. ^If SQLite determines that invoking the busy 2051 ** when there is lock contention. ^If SQLite determines that invoking the busy
1740 ** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY] 2052 ** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY]
1741 ** or [SQLITE_IOERR_BLOCKED] instead of invoking the busy handler. 2053 ** to the application instead of invoking the
2054 ** busy handler.
1742 ** Consider a scenario where one process is holding a read lock that 2055 ** Consider a scenario where one process is holding a read lock that
1743 ** it is trying to promote to a reserved lock and 2056 ** it is trying to promote to a reserved lock and
1744 ** a second process is holding a reserved lock that it is trying 2057 ** a second process is holding a reserved lock that it is trying
1745 ** to promote to an exclusive lock. The first process cannot proceed 2058 ** to promote to an exclusive lock. The first process cannot proceed
1746 ** because it is blocked by the second and the second process cannot 2059 ** because it is blocked by the second and the second process cannot
1747 ** proceed because it is blocked by the first. If both processes 2060 ** proceed because it is blocked by the first. If both processes
1748 ** invoke the busy handlers, neither will make any progress. Therefore, 2061 ** invoke the busy handlers, neither will make any progress. Therefore,
1749 ** SQLite returns [SQLITE_BUSY] for the first process, hoping that this 2062 ** SQLite returns [SQLITE_BUSY] for the first process, hoping that this
1750 ** will induce the first process to release its read lock and allow 2063 ** will induce the first process to release its read lock and allow
1751 ** the second process to proceed. 2064 ** the second process to proceed.
1752 ** 2065 **
1753 ** ^The default busy callback is NULL. 2066 ** ^The default busy callback is NULL.
1754 ** 2067 **
1755 ** ^The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED]
1756 ** when SQLite is in the middle of a large transaction where all the
1757 ** changes will not fit into the in-memory cache. SQLite will
1758 ** already hold a RESERVED lock on the database file, but it needs
1759 ** to promote this lock to EXCLUSIVE so that it can spill cache
1760 ** pages into the database file without harm to concurrent
1761 ** readers. ^If it is unable to promote the lock, then the in-memory
1762 ** cache will be left in an inconsistent state and so the error
1763 ** code is promoted from the relatively benign [SQLITE_BUSY] to
1764 ** the more severe [SQLITE_IOERR_BLOCKED]. ^This error code promotion
1765 ** forces an automatic rollback of the changes. See the
1766 ** <a href="/cvstrac/wiki?p=CorruptionFollowingBusyError">
1767 ** CorruptionFollowingBusyError</a> wiki page for a discussion of why
1768 ** this is important.
1769 **
1770 ** ^(There can only be a single busy handler defined for each 2068 ** ^(There can only be a single busy handler defined for each
1771 ** [database connection]. Setting a new busy handler clears any 2069 ** [database connection]. Setting a new busy handler clears any
1772 ** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()] 2070 ** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()]
1773 ** will also set or clear the busy handler. 2071 ** or evaluating [PRAGMA busy_timeout=N] will change the
2072 ** busy handler and thus clear any previously set busy handler.
1774 ** 2073 **
1775 ** The busy callback should not take any actions which modify the 2074 ** The busy callback should not take any actions which modify the
1776 ** database connection that invoked the busy handler. Any such actions 2075 ** database connection that invoked the busy handler. In other words,
2076 ** the busy handler is not reentrant. Any such actions
1777 ** result in undefined behavior. 2077 ** result in undefined behavior.
1778 ** 2078 **
1779 ** A busy handler must not close the database connection 2079 ** A busy handler must not close the database connection
1780 ** or [prepared statement] that invoked the busy handler. 2080 ** or [prepared statement] that invoked the busy handler.
1781 */ 2081 */
1782 int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*); 2082 int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*);
1783 2083
1784 /* 2084 /*
1785 ** CAPI3REF: Set A Busy Timeout 2085 ** CAPI3REF: Set A Busy Timeout
1786 ** 2086 **
1787 ** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps 2087 ** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps
1788 ** for a specified amount of time when a table is locked. ^The handler 2088 ** for a specified amount of time when a table is locked. ^The handler
1789 ** will sleep multiple times until at least "ms" milliseconds of sleeping 2089 ** will sleep multiple times until at least "ms" milliseconds of sleeping
1790 ** have accumulated. ^After at least "ms" milliseconds of sleeping, 2090 ** have accumulated. ^After at least "ms" milliseconds of sleeping,
1791 ** the handler returns 0 which causes [sqlite3_step()] to return 2091 ** the handler returns 0 which causes [sqlite3_step()] to return
1792 ** [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED]. 2092 ** [SQLITE_BUSY].
1793 ** 2093 **
1794 ** ^Calling this routine with an argument less than or equal to zero 2094 ** ^Calling this routine with an argument less than or equal to zero
1795 ** turns off all busy handlers. 2095 ** turns off all busy handlers.
1796 ** 2096 **
1797 ** ^(There can only be a single busy handler for a particular 2097 ** ^(There can only be a single busy handler for a particular
1798 ** [database connection] any any given moment. If another busy handler 2098 ** [database connection] at any given moment. If another busy handler
1799 ** was defined (using [sqlite3_busy_handler()]) prior to calling 2099 ** was defined (using [sqlite3_busy_handler()]) prior to calling
1800 ** this routine, that other busy handler is cleared.)^ 2100 ** this routine, that other busy handler is cleared.)^
2101 **
2102 ** See also: [PRAGMA busy_timeout]
1801 */ 2103 */
1802 int sqlite3_busy_timeout(sqlite3*, int ms); 2104 int sqlite3_busy_timeout(sqlite3*, int ms);
1803 2105
1804 /* 2106 /*
1805 ** CAPI3REF: Convenience Routines For Running Queries 2107 ** CAPI3REF: Convenience Routines For Running Queries
1806 ** 2108 **
1807 ** This is a legacy interface that is preserved for backwards compatibility. 2109 ** This is a legacy interface that is preserved for backwards compatibility.
1808 ** Use of this interface is not recommended. 2110 ** Use of this interface is not recommended.
1809 ** 2111 **
1810 ** Definition: A <b>result table</b> is memory data structure created by the 2112 ** Definition: A <b>result table</b> is memory data structure created by the
(...skipping 104 matching lines...) Expand 10 before | Expand all | Expand 10 after
1915 ** the zero terminator. So the longest string that can be completely 2217 ** the zero terminator. So the longest string that can be completely
1916 ** written will be n-1 characters. 2218 ** written will be n-1 characters.
1917 ** 2219 **
1918 ** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf(). 2220 ** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf().
1919 ** 2221 **
1920 ** These routines all implement some additional formatting 2222 ** These routines all implement some additional formatting
1921 ** options that are useful for constructing SQL statements. 2223 ** options that are useful for constructing SQL statements.
1922 ** All of the usual printf() formatting options apply. In addition, there 2224 ** All of the usual printf() formatting options apply. In addition, there
1923 ** is are "%q", "%Q", and "%z" options. 2225 ** is are "%q", "%Q", and "%z" options.
1924 ** 2226 **
1925 ** ^(The %q option works like %s in that it substitutes a null-terminated 2227 ** ^(The %q option works like %s in that it substitutes a nul-terminated
1926 ** string from the argument list. But %q also doubles every '\'' character. 2228 ** string from the argument list. But %q also doubles every '\'' character.
1927 ** %q is designed for use inside a string literal.)^ By doubling each '\'' 2229 ** %q is designed for use inside a string literal.)^ By doubling each '\''
1928 ** character it escapes that character and allows it to be inserted into 2230 ** character it escapes that character and allows it to be inserted into
1929 ** the string. 2231 ** the string.
1930 ** 2232 **
1931 ** For example, assume the string variable zText contains text as follows: 2233 ** For example, assume the string variable zText contains text as follows:
1932 ** 2234 **
1933 ** <blockquote><pre> 2235 ** <blockquote><pre>
1934 ** char *zText = "It's a happy day!"; 2236 ** char *zText = "It's a happy day!";
1935 ** </pre></blockquote> 2237 ** </pre></blockquote>
(...skipping 54 matching lines...) Expand 10 before | Expand all | Expand 10 after
1990 ** does not include operating-system specific VFS implementation. The 2292 ** does not include operating-system specific VFS implementation. The
1991 ** Windows VFS uses native malloc() and free() for some operations. 2293 ** Windows VFS uses native malloc() and free() for some operations.
1992 ** 2294 **
1993 ** ^The sqlite3_malloc() routine returns a pointer to a block 2295 ** ^The sqlite3_malloc() routine returns a pointer to a block
1994 ** of memory at least N bytes in length, where N is the parameter. 2296 ** of memory at least N bytes in length, where N is the parameter.
1995 ** ^If sqlite3_malloc() is unable to obtain sufficient free 2297 ** ^If sqlite3_malloc() is unable to obtain sufficient free
1996 ** memory, it returns a NULL pointer. ^If the parameter N to 2298 ** memory, it returns a NULL pointer. ^If the parameter N to
1997 ** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns 2299 ** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns
1998 ** a NULL pointer. 2300 ** a NULL pointer.
1999 ** 2301 **
2302 ** ^The sqlite3_malloc64(N) routine works just like
2303 ** sqlite3_malloc(N) except that N is an unsigned 64-bit integer instead
2304 ** of a signed 32-bit integer.
2305 **
2000 ** ^Calling sqlite3_free() with a pointer previously returned 2306 ** ^Calling sqlite3_free() with a pointer previously returned
2001 ** by sqlite3_malloc() or sqlite3_realloc() releases that memory so 2307 ** by sqlite3_malloc() or sqlite3_realloc() releases that memory so
2002 ** that it might be reused. ^The sqlite3_free() routine is 2308 ** that it might be reused. ^The sqlite3_free() routine is
2003 ** a no-op if is called with a NULL pointer. Passing a NULL pointer 2309 ** a no-op if is called with a NULL pointer. Passing a NULL pointer
2004 ** to sqlite3_free() is harmless. After being freed, memory 2310 ** to sqlite3_free() is harmless. After being freed, memory
2005 ** should neither be read nor written. Even reading previously freed 2311 ** should neither be read nor written. Even reading previously freed
2006 ** memory might result in a segmentation fault or other severe error. 2312 ** memory might result in a segmentation fault or other severe error.
2007 ** Memory corruption, a segmentation fault, or other severe error 2313 ** Memory corruption, a segmentation fault, or other severe error
2008 ** might result if sqlite3_free() is called with a non-NULL pointer that 2314 ** might result if sqlite3_free() is called with a non-NULL pointer that
2009 ** was not obtained from sqlite3_malloc() or sqlite3_realloc(). 2315 ** was not obtained from sqlite3_malloc() or sqlite3_realloc().
2010 ** 2316 **
2011 ** ^(The sqlite3_realloc() interface attempts to resize a 2317 ** ^The sqlite3_realloc(X,N) interface attempts to resize a
2012 ** prior memory allocation to be at least N bytes, where N is the 2318 ** prior memory allocation X to be at least N bytes.
2013 ** second parameter. The memory allocation to be resized is the first 2319 ** ^If the X parameter to sqlite3_realloc(X,N)
2014 ** parameter.)^ ^ If the first parameter to sqlite3_realloc()
2015 ** is a NULL pointer then its behavior is identical to calling 2320 ** is a NULL pointer then its behavior is identical to calling
2016 ** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc(). 2321 ** sqlite3_malloc(N).
2017 ** ^If the second parameter to sqlite3_realloc() is zero or 2322 ** ^If the N parameter to sqlite3_realloc(X,N) is zero or
2018 ** negative then the behavior is exactly the same as calling 2323 ** negative then the behavior is exactly the same as calling
2019 ** sqlite3_free(P) where P is the first parameter to sqlite3_realloc(). 2324 ** sqlite3_free(X).
2020 ** ^sqlite3_realloc() returns a pointer to a memory allocation 2325 ** ^sqlite3_realloc(X,N) returns a pointer to a memory allocation
2021 ** of at least N bytes in size or NULL if sufficient memory is unavailable. 2326 ** of at least N bytes in size or NULL if insufficient memory is available.
2022 ** ^If M is the size of the prior allocation, then min(N,M) bytes 2327 ** ^If M is the size of the prior allocation, then min(N,M) bytes
2023 ** of the prior allocation are copied into the beginning of buffer returned 2328 ** of the prior allocation are copied into the beginning of buffer returned
2024 ** by sqlite3_realloc() and the prior allocation is freed. 2329 ** by sqlite3_realloc(X,N) and the prior allocation is freed.
2025 ** ^If sqlite3_realloc() returns NULL, then the prior allocation 2330 ** ^If sqlite3_realloc(X,N) returns NULL and N is positive, then the
2026 ** is not freed. 2331 ** prior allocation is not freed.
2027 ** 2332 **
2028 ** ^The memory returned by sqlite3_malloc() and sqlite3_realloc() 2333 ** ^The sqlite3_realloc64(X,N) interfaces works the same as
2334 ** sqlite3_realloc(X,N) except that N is a 64-bit unsigned integer instead
2335 ** of a 32-bit signed integer.
2336 **
2337 ** ^If X is a memory allocation previously obtained from sqlite3_malloc(),
2338 ** sqlite3_malloc64(), sqlite3_realloc(), or sqlite3_realloc64(), then
2339 ** sqlite3_msize(X) returns the size of that memory allocation in bytes.
2340 ** ^The value returned by sqlite3_msize(X) might be larger than the number
2341 ** of bytes requested when X was allocated. ^If X is a NULL pointer then
2342 ** sqlite3_msize(X) returns zero. If X points to something that is not
2343 ** the beginning of memory allocation, or if it points to a formerly
2344 ** valid memory allocation that has now been freed, then the behavior
2345 ** of sqlite3_msize(X) is undefined and possibly harmful.
2346 **
2347 ** ^The memory returned by sqlite3_malloc(), sqlite3_realloc(),
2348 ** sqlite3_malloc64(), and sqlite3_realloc64()
2029 ** is always aligned to at least an 8 byte boundary, or to a 2349 ** is always aligned to at least an 8 byte boundary, or to a
2030 ** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time 2350 ** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time
2031 ** option is used. 2351 ** option is used.
2032 ** 2352 **
2033 ** In SQLite version 3.5.0 and 3.5.1, it was possible to define 2353 ** In SQLite version 3.5.0 and 3.5.1, it was possible to define
2034 ** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in 2354 ** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in
2035 ** implementation of these routines to be omitted. That capability 2355 ** implementation of these routines to be omitted. That capability
2036 ** is no longer provided. Only built-in memory allocators can be used. 2356 ** is no longer provided. Only built-in memory allocators can be used.
2037 ** 2357 **
2038 ** The Windows OS interface layer calls 2358 ** Prior to SQLite version 3.7.10, the Windows OS interface layer called
2039 ** the system malloc() and free() directly when converting 2359 ** the system malloc() and free() directly when converting
2040 ** filenames between the UTF-8 encoding used by SQLite 2360 ** filenames between the UTF-8 encoding used by SQLite
2041 ** and whatever filename encoding is used by the particular Windows 2361 ** and whatever filename encoding is used by the particular Windows
2042 ** installation. Memory allocation errors are detected, but 2362 ** installation. Memory allocation errors were detected, but
2043 ** they are reported back as [SQLITE_CANTOPEN] or 2363 ** they were reported back as [SQLITE_CANTOPEN] or
2044 ** [SQLITE_IOERR] rather than [SQLITE_NOMEM]. 2364 ** [SQLITE_IOERR] rather than [SQLITE_NOMEM].
2045 ** 2365 **
2046 ** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()] 2366 ** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()]
2047 ** must be either NULL or else pointers obtained from a prior 2367 ** must be either NULL or else pointers obtained from a prior
2048 ** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have 2368 ** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have
2049 ** not yet been released. 2369 ** not yet been released.
2050 ** 2370 **
2051 ** The application must not read or write any part of 2371 ** The application must not read or write any part of
2052 ** a block of memory after it has been released using 2372 ** a block of memory after it has been released using
2053 ** [sqlite3_free()] or [sqlite3_realloc()]. 2373 ** [sqlite3_free()] or [sqlite3_realloc()].
2054 */ 2374 */
2055 void *sqlite3_malloc(int); 2375 void *sqlite3_malloc(int);
2376 void *sqlite3_malloc64(sqlite3_uint64);
2056 void *sqlite3_realloc(void*, int); 2377 void *sqlite3_realloc(void*, int);
2378 void *sqlite3_realloc64(void*, sqlite3_uint64);
2057 void sqlite3_free(void*); 2379 void sqlite3_free(void*);
2380 sqlite3_uint64 sqlite3_msize(void*);
2058 2381
2059 /* 2382 /*
2060 ** CAPI3REF: Memory Allocator Statistics 2383 ** CAPI3REF: Memory Allocator Statistics
2061 ** 2384 **
2062 ** SQLite provides these two interfaces for reporting on the status 2385 ** SQLite provides these two interfaces for reporting on the status
2063 ** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()] 2386 ** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()]
2064 ** routines, which form the built-in memory allocation subsystem. 2387 ** routines, which form the built-in memory allocation subsystem.
2065 ** 2388 **
2066 ** ^The [sqlite3_memory_used()] routine returns the number of bytes 2389 ** ^The [sqlite3_memory_used()] routine returns the number of bytes
2067 ** of memory currently outstanding (malloced but not freed). 2390 ** of memory currently outstanding (malloced but not freed).
(...skipping 17 matching lines...) Expand all
2085 /* 2408 /*
2086 ** CAPI3REF: Pseudo-Random Number Generator 2409 ** CAPI3REF: Pseudo-Random Number Generator
2087 ** 2410 **
2088 ** SQLite contains a high-quality pseudo-random number generator (PRNG) used to 2411 ** SQLite contains a high-quality pseudo-random number generator (PRNG) used to
2089 ** select random [ROWID | ROWIDs] when inserting new records into a table that 2412 ** select random [ROWID | ROWIDs] when inserting new records into a table that
2090 ** already uses the largest possible [ROWID]. The PRNG is also used for 2413 ** already uses the largest possible [ROWID]. The PRNG is also used for
2091 ** the build-in random() and randomblob() SQL functions. This interface allows 2414 ** the build-in random() and randomblob() SQL functions. This interface allows
2092 ** applications to access the same PRNG for other purposes. 2415 ** applications to access the same PRNG for other purposes.
2093 ** 2416 **
2094 ** ^A call to this routine stores N bytes of randomness into buffer P. 2417 ** ^A call to this routine stores N bytes of randomness into buffer P.
2418 ** ^If N is less than one, then P can be a NULL pointer.
2095 ** 2419 **
2096 ** ^The first time this routine is invoked (either internally or by 2420 ** ^If this routine has not been previously called or if the previous
2097 ** the application) the PRNG is seeded using randomness obtained 2421 ** call had N less than one, then the PRNG is seeded using randomness
2098 ** from the xRandomness method of the default [sqlite3_vfs] object. 2422 ** obtained from the xRandomness method of the default [sqlite3_vfs] object.
2099 ** ^On all subsequent invocations, the pseudo-randomness is generated 2423 ** ^If the previous call to this routine had an N of 1 or more then
2424 ** the pseudo-randomness is generated
2100 ** internally and without recourse to the [sqlite3_vfs] xRandomness 2425 ** internally and without recourse to the [sqlite3_vfs] xRandomness
2101 ** method. 2426 ** method.
2102 */ 2427 */
2103 void sqlite3_randomness(int N, void *P); 2428 void sqlite3_randomness(int N, void *P);
2104 2429
2105 /* 2430 /*
2106 ** CAPI3REF: Compile-Time Authorization Callbacks 2431 ** CAPI3REF: Compile-Time Authorization Callbacks
2107 ** 2432 **
2108 ** ^This routine registers an authorizer callback with a particular 2433 ** ^This routine registers an authorizer callback with a particular
2109 ** [database connection], supplied in the first argument. 2434 ** [database connection], supplied in the first argument.
(...skipping 79 matching lines...) Expand 10 before | Expand all | Expand 10 after
2189 ); 2514 );
2190 2515
2191 /* 2516 /*
2192 ** CAPI3REF: Authorizer Return Codes 2517 ** CAPI3REF: Authorizer Return Codes
2193 ** 2518 **
2194 ** The [sqlite3_set_authorizer | authorizer callback function] must 2519 ** The [sqlite3_set_authorizer | authorizer callback function] must
2195 ** return either [SQLITE_OK] or one of these two constants in order 2520 ** return either [SQLITE_OK] or one of these two constants in order
2196 ** to signal SQLite whether or not the action is permitted. See the 2521 ** to signal SQLite whether or not the action is permitted. See the
2197 ** [sqlite3_set_authorizer | authorizer documentation] for additional 2522 ** [sqlite3_set_authorizer | authorizer documentation] for additional
2198 ** information. 2523 ** information.
2524 **
2525 ** Note that SQLITE_IGNORE is also used as a [conflict resolution mode]
2526 ** returned from the [sqlite3_vtab_on_conflict()] interface.
2199 */ 2527 */
2200 #define SQLITE_DENY 1 /* Abort the SQL statement with an error */ 2528 #define SQLITE_DENY 1 /* Abort the SQL statement with an error */
2201 #define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */ 2529 #define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
2202 2530
2203 /* 2531 /*
2204 ** CAPI3REF: Authorizer Action Codes 2532 ** CAPI3REF: Authorizer Action Codes
2205 ** 2533 **
2206 ** The [sqlite3_set_authorizer()] interface registers a callback function 2534 ** The [sqlite3_set_authorizer()] interface registers a callback function
2207 ** that is invoked to authorize certain SQL statement actions. The 2535 ** that is invoked to authorize certain SQL statement actions. The
2208 ** second parameter to the callback is an integer code that specifies 2536 ** second parameter to the callback is an integer code that specifies
(...skipping 37 matching lines...) Expand 10 before | Expand all | Expand 10 after
2246 #define SQLITE_ATTACH 24 /* Filename NULL */ 2574 #define SQLITE_ATTACH 24 /* Filename NULL */
2247 #define SQLITE_DETACH 25 /* Database Name NULL */ 2575 #define SQLITE_DETACH 25 /* Database Name NULL */
2248 #define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */ 2576 #define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */
2249 #define SQLITE_REINDEX 27 /* Index Name NULL */ 2577 #define SQLITE_REINDEX 27 /* Index Name NULL */
2250 #define SQLITE_ANALYZE 28 /* Table Name NULL */ 2578 #define SQLITE_ANALYZE 28 /* Table Name NULL */
2251 #define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */ 2579 #define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */
2252 #define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */ 2580 #define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */
2253 #define SQLITE_FUNCTION 31 /* NULL Function Name */ 2581 #define SQLITE_FUNCTION 31 /* NULL Function Name */
2254 #define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */ 2582 #define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */
2255 #define SQLITE_COPY 0 /* No longer used */ 2583 #define SQLITE_COPY 0 /* No longer used */
2584 #define SQLITE_RECURSIVE 33 /* NULL NULL */
2256 2585
2257 /* 2586 /*
2258 ** CAPI3REF: Tracing And Profiling Functions 2587 ** CAPI3REF: Tracing And Profiling Functions
2259 ** 2588 **
2260 ** These routines register callback functions that can be used for 2589 ** These routines register callback functions that can be used for
2261 ** tracing and profiling the execution of SQL statements. 2590 ** tracing and profiling the execution of SQL statements.
2262 ** 2591 **
2263 ** ^The callback function registered by sqlite3_trace() is invoked at 2592 ** ^The callback function registered by sqlite3_trace() is invoked at
2264 ** various times when an SQL statement is being run by [sqlite3_step()]. 2593 ** various times when an SQL statement is being run by [sqlite3_step()].
2265 ** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the 2594 ** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the
2266 ** SQL statement text as the statement first begins executing. 2595 ** SQL statement text as the statement first begins executing.
2267 ** ^(Additional sqlite3_trace() callbacks might occur 2596 ** ^(Additional sqlite3_trace() callbacks might occur
2268 ** as each triggered subprogram is entered. The callbacks for triggers 2597 ** as each triggered subprogram is entered. The callbacks for triggers
2269 ** contain a UTF-8 SQL comment that identifies the trigger.)^ 2598 ** contain a UTF-8 SQL comment that identifies the trigger.)^
2270 ** 2599 **
2600 ** The [SQLITE_TRACE_SIZE_LIMIT] compile-time option can be used to limit
2601 ** the length of [bound parameter] expansion in the output of sqlite3_trace().
2602 **
2271 ** ^The callback function registered by sqlite3_profile() is invoked 2603 ** ^The callback function registered by sqlite3_profile() is invoked
2272 ** as each SQL statement finishes. ^The profile callback contains 2604 ** as each SQL statement finishes. ^The profile callback contains
2273 ** the original statement text and an estimate of wall-clock time 2605 ** the original statement text and an estimate of wall-clock time
2274 ** of how long that statement took to run. ^The profile callback 2606 ** of how long that statement took to run. ^The profile callback
2275 ** time is in units of nanoseconds, however the current implementation 2607 ** time is in units of nanoseconds, however the current implementation
2276 ** is only capable of millisecond resolution so the six least significant 2608 ** is only capable of millisecond resolution so the six least significant
2277 ** digits in the time are meaningless. Future versions of SQLite 2609 ** digits in the time are meaningless. Future versions of SQLite
2278 ** might provide greater resolution on the profiler callback. The 2610 ** might provide greater resolution on the profiler callback. The
2279 ** sqlite3_profile() function is considered experimental and is 2611 ** sqlite3_profile() function is considered experimental and is
2280 ** subject to change in future versions of SQLite. 2612 ** subject to change in future versions of SQLite.
2281 */ 2613 */
2282 void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*); 2614 void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*);
2283 SQLITE_EXPERIMENTAL void *sqlite3_profile(sqlite3*, 2615 SQLITE_EXPERIMENTAL void *sqlite3_profile(sqlite3*,
2284 void(*xProfile)(void*,const char*,sqlite3_uint64), void*); 2616 void(*xProfile)(void*,const char*,sqlite3_uint64), void*);
2285 2617
2286 /* 2618 /*
2287 ** CAPI3REF: Query Progress Callbacks 2619 ** CAPI3REF: Query Progress Callbacks
2288 ** 2620 **
2289 ** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback 2621 ** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback
2290 ** function X to be invoked periodically during long running calls to 2622 ** function X to be invoked periodically during long running calls to
2291 ** [sqlite3_exec()], [sqlite3_step()] and [sqlite3_get_table()] for 2623 ** [sqlite3_exec()], [sqlite3_step()] and [sqlite3_get_table()] for
2292 ** database connection D. An example use for this 2624 ** database connection D. An example use for this
2293 ** interface is to keep a GUI updated during a large query. 2625 ** interface is to keep a GUI updated during a large query.
2294 ** 2626 **
2295 ** ^The parameter P is passed through as the only parameter to the 2627 ** ^The parameter P is passed through as the only parameter to the
2296 ** callback function X. ^The parameter N is the number of 2628 ** callback function X. ^The parameter N is the approximate number of
2297 ** [virtual machine instructions] that are evaluated between successive 2629 ** [virtual machine instructions] that are evaluated between successive
2298 ** invocations of the callback X. 2630 ** invocations of the callback X. ^If N is less than one then the progress
2631 ** handler is disabled.
2299 ** 2632 **
2300 ** ^Only a single progress handler may be defined at one time per 2633 ** ^Only a single progress handler may be defined at one time per
2301 ** [database connection]; setting a new progress handler cancels the 2634 ** [database connection]; setting a new progress handler cancels the
2302 ** old one. ^Setting parameter X to NULL disables the progress handler. 2635 ** old one. ^Setting parameter X to NULL disables the progress handler.
2303 ** ^The progress handler is also disabled by setting N to a value less 2636 ** ^The progress handler is also disabled by setting N to a value less
2304 ** than 1. 2637 ** than 1.
2305 ** 2638 **
2306 ** ^If the progress callback returns non-zero, the operation is 2639 ** ^If the progress callback returns non-zero, the operation is
2307 ** interrupted. This feature can be used to implement a 2640 ** interrupted. This feature can be used to implement a
2308 ** "Cancel" button on a GUI progress dialog box. 2641 ** "Cancel" button on a GUI progress dialog box.
2309 ** 2642 **
2310 ** The progress handler callback must not do anything that will modify 2643 ** The progress handler callback must not do anything that will modify
2311 ** the database connection that invoked the progress handler. 2644 ** the database connection that invoked the progress handler.
2312 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 2645 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
2313 ** database connections for the meaning of "modify" in this paragraph. 2646 ** database connections for the meaning of "modify" in this paragraph.
2314 ** 2647 **
2315 */ 2648 */
2316 void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*); 2649 void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
2317 2650
2318 /* 2651 /*
2319 ** CAPI3REF: Opening A New Database Connection 2652 ** CAPI3REF: Opening A New Database Connection
2320 ** 2653 **
2321 ** ^These routines open an SQLite database file whose name is given by the 2654 ** ^These routines open an SQLite database file as specified by the
2322 ** filename argument. ^The filename argument is interpreted as UTF-8 for 2655 ** filename argument. ^The filename argument is interpreted as UTF-8 for
2323 ** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte 2656 ** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte
2324 ** order for sqlite3_open16(). ^(A [database connection] handle is usually 2657 ** order for sqlite3_open16(). ^(A [database connection] handle is usually
2325 ** returned in *ppDb, even if an error occurs. The only exception is that 2658 ** returned in *ppDb, even if an error occurs. The only exception is that
2326 ** if SQLite is unable to allocate memory to hold the [sqlite3] object, 2659 ** if SQLite is unable to allocate memory to hold the [sqlite3] object,
2327 ** a NULL will be written into *ppDb instead of a pointer to the [sqlite3] 2660 ** a NULL will be written into *ppDb instead of a pointer to the [sqlite3]
2328 ** object.)^ ^(If the database is opened (and/or created) successfully, then 2661 ** object.)^ ^(If the database is opened (and/or created) successfully, then
2329 ** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The 2662 ** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The
2330 ** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain 2663 ** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain
2331 ** an English language description of the error following a failure of any 2664 ** an English language description of the error following a failure of any
2332 ** of the sqlite3_open() routines. 2665 ** of the sqlite3_open() routines.
2333 ** 2666 **
2334 ** ^The default encoding for the database will be UTF-8 if 2667 ** ^The default encoding will be UTF-8 for databases created using
2335 ** sqlite3_open() or sqlite3_open_v2() is called and 2668 ** sqlite3_open() or sqlite3_open_v2(). ^The default encoding for databases
2336 ** UTF-16 in the native byte order if sqlite3_open16() is used. 2669 ** created using sqlite3_open16() will be UTF-16 in the native byte order.
2337 ** 2670 **
2338 ** Whether or not an error occurs when it is opened, resources 2671 ** Whether or not an error occurs when it is opened, resources
2339 ** associated with the [database connection] handle should be released by 2672 ** associated with the [database connection] handle should be released by
2340 ** passing it to [sqlite3_close()] when it is no longer required. 2673 ** passing it to [sqlite3_close()] when it is no longer required.
2341 ** 2674 **
2342 ** The sqlite3_open_v2() interface works like sqlite3_open() 2675 ** The sqlite3_open_v2() interface works like sqlite3_open()
2343 ** except that it accepts two additional parameters for additional control 2676 ** except that it accepts two additional parameters for additional control
2344 ** over the new database connection. ^(The flags parameter to 2677 ** over the new database connection. ^(The flags parameter to
2345 ** sqlite3_open_v2() can take one of 2678 ** sqlite3_open_v2() can take one of
2346 ** the following three values, optionally combined with the 2679 ** the following three values, optionally combined with the
2347 ** [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], [SQLITE_OPEN_SHAREDCACHE], 2680 ** [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], [SQLITE_OPEN_SHAREDCACHE],
2348 ** and/or [SQLITE_OPEN_PRIVATECACHE] flags:)^ 2681 ** [SQLITE_OPEN_PRIVATECACHE], and/or [SQLITE_OPEN_URI] flags:)^
2349 ** 2682 **
2350 ** <dl> 2683 ** <dl>
2351 ** ^(<dt>[SQLITE_OPEN_READONLY]</dt> 2684 ** ^(<dt>[SQLITE_OPEN_READONLY]</dt>
2352 ** <dd>The database is opened in read-only mode. If the database does not 2685 ** <dd>The database is opened in read-only mode. If the database does not
2353 ** already exist, an error is returned.</dd>)^ 2686 ** already exist, an error is returned.</dd>)^
2354 ** 2687 **
2355 ** ^(<dt>[SQLITE_OPEN_READWRITE]</dt> 2688 ** ^(<dt>[SQLITE_OPEN_READWRITE]</dt>
2356 ** <dd>The database is opened for reading and writing if possible, or reading 2689 ** <dd>The database is opened for reading and writing if possible, or reading
2357 ** only if the file is write protected by the operating system. In either 2690 ** only if the file is write protected by the operating system. In either
2358 ** case the database must already exist, otherwise an error is returned.</dd>)^ 2691 ** case the database must already exist, otherwise an error is returned.</dd>)^
2359 ** 2692 **
2360 ** ^(<dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt> 2693 ** ^(<dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt>
2361 ** <dd>The database is opened for reading and writing, and is created if 2694 ** <dd>The database is opened for reading and writing, and is created if
2362 ** it does not already exist. This is the behavior that is always used for 2695 ** it does not already exist. This is the behavior that is always used for
2363 ** sqlite3_open() and sqlite3_open16().</dd>)^ 2696 ** sqlite3_open() and sqlite3_open16().</dd>)^
2364 ** </dl> 2697 ** </dl>
2365 ** 2698 **
2366 ** If the 3rd parameter to sqlite3_open_v2() is not one of the 2699 ** If the 3rd parameter to sqlite3_open_v2() is not one of the
2367 ** combinations shown above or one of the combinations shown above combined 2700 ** combinations shown above optionally combined with other
2368 ** with the [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], 2701 ** [SQLITE_OPEN_READONLY | SQLITE_OPEN_* bits]
2369 ** [SQLITE_OPEN_SHAREDCACHE] and/or [SQLITE_OPEN_PRIVATECACHE] flags,
2370 ** then the behavior is undefined. 2702 ** then the behavior is undefined.
2371 ** 2703 **
2372 ** ^If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection 2704 ** ^If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection
2373 ** opens in the multi-thread [threading mode] as long as the single-thread 2705 ** opens in the multi-thread [threading mode] as long as the single-thread
2374 ** mode has not been set at compile-time or start-time. ^If the 2706 ** mode has not been set at compile-time or start-time. ^If the
2375 ** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens 2707 ** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens
2376 ** in the serialized [threading mode] unless single-thread was 2708 ** in the serialized [threading mode] unless single-thread was
2377 ** previously selected at compile-time or start-time. 2709 ** previously selected at compile-time or start-time.
2378 ** ^The [SQLITE_OPEN_SHAREDCACHE] flag causes the database connection to be 2710 ** ^The [SQLITE_OPEN_SHAREDCACHE] flag causes the database connection to be
2379 ** eligible to use [shared cache mode], regardless of whether or not shared 2711 ** eligible to use [shared cache mode], regardless of whether or not shared
2380 ** cache is enabled using [sqlite3_enable_shared_cache()]. ^The 2712 ** cache is enabled using [sqlite3_enable_shared_cache()]. ^The
2381 ** [SQLITE_OPEN_PRIVATECACHE] flag causes the database connection to not 2713 ** [SQLITE_OPEN_PRIVATECACHE] flag causes the database connection to not
2382 ** participate in [shared cache mode] even if it is enabled. 2714 ** participate in [shared cache mode] even if it is enabled.
2383 ** 2715 **
2716 ** ^The fourth parameter to sqlite3_open_v2() is the name of the
2717 ** [sqlite3_vfs] object that defines the operating system interface that
2718 ** the new database connection should use. ^If the fourth parameter is
2719 ** a NULL pointer then the default [sqlite3_vfs] object is used.
2720 **
2384 ** ^If the filename is ":memory:", then a private, temporary in-memory database 2721 ** ^If the filename is ":memory:", then a private, temporary in-memory database
2385 ** is created for the connection. ^This in-memory database will vanish when 2722 ** is created for the connection. ^This in-memory database will vanish when
2386 ** the database connection is closed. Future versions of SQLite might 2723 ** the database connection is closed. Future versions of SQLite might
2387 ** make use of additional special filenames that begin with the ":" character. 2724 ** make use of additional special filenames that begin with the ":" character.
2388 ** It is recommended that when a database filename actually does begin with 2725 ** It is recommended that when a database filename actually does begin with
2389 ** a ":" character you should prefix the filename with a pathname such as 2726 ** a ":" character you should prefix the filename with a pathname such as
2390 ** "./" to avoid ambiguity. 2727 ** "./" to avoid ambiguity.
2391 ** 2728 **
2392 ** ^If the filename is an empty string, then a private, temporary 2729 ** ^If the filename is an empty string, then a private, temporary
2393 ** on-disk database will be created. ^This private database will be 2730 ** on-disk database will be created. ^This private database will be
2394 ** automatically deleted as soon as the database connection is closed. 2731 ** automatically deleted as soon as the database connection is closed.
2395 ** 2732 **
2396 ** ^The fourth parameter to sqlite3_open_v2() is the name of the 2733 ** [[URI filenames in sqlite3_open()]] <h3>URI Filenames</h3>
2397 ** [sqlite3_vfs] object that defines the operating system interface that 2734 **
2398 ** the new database connection should use. ^If the fourth parameter is 2735 ** ^If [URI filename] interpretation is enabled, and the filename argument
2399 ** a NULL pointer then the default [sqlite3_vfs] object is used. 2736 ** begins with "file:", then the filename is interpreted as a URI. ^URI
2737 ** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is
2738 ** set in the fourth argument to sqlite3_open_v2(), or if it has
2739 ** been enabled globally using the [SQLITE_CONFIG_URI] option with the
2740 ** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option.
2741 ** As of SQLite version 3.7.7, URI filename interpretation is turned off
2742 ** by default, but future releases of SQLite might enable URI filename
2743 ** interpretation by default. See "[URI filenames]" for additional
2744 ** information.
2745 **
2746 ** URI filenames are parsed according to RFC 3986. ^If the URI contains an
2747 ** authority, then it must be either an empty string or the string
2748 ** "localhost". ^If the authority is not an empty string or "localhost", an
2749 ** error is returned to the caller. ^The fragment component of a URI, if
2750 ** present, is ignored.
2751 **
2752 ** ^SQLite uses the path component of the URI as the name of the disk file
2753 ** which contains the database. ^If the path begins with a '/' character,
2754 ** then it is interpreted as an absolute path. ^If the path does not begin
2755 ** with a '/' (meaning that the authority section is omitted from the URI)
2756 ** then the path is interpreted as a relative path.
2757 ** ^(On windows, the first component of an absolute path
2758 ** is a drive specification (e.g. "C:").)^
2759 **
2760 ** [[core URI query parameters]]
2761 ** The query component of a URI may contain parameters that are interpreted
2762 ** either by SQLite itself, or by a [VFS | custom VFS implementation].
2763 ** SQLite and its built-in [VFSes] interpret the
2764 ** following query parameters:
2765 **
2766 ** <ul>
2767 ** <li> <b>vfs</b>: ^The "vfs" parameter may be used to specify the name of
2768 ** a VFS object that provides the operating system interface that should
2769 ** be used to access the database file on disk. ^If this option is set to
2770 ** an empty string the default VFS object is used. ^Specifying an unknown
2771 ** VFS is an error. ^If sqlite3_open_v2() is used and the vfs option is
2772 ** present, then the VFS specified by the option takes precedence over
2773 ** the value passed as the fourth parameter to sqlite3_open_v2().
2774 **
2775 ** <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw",
2776 ** "rwc", or "memory". Attempting to set it to any other value is
2777 ** an error)^.
2778 ** ^If "ro" is specified, then the database is opened for read-only
2779 ** access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the
2780 ** third argument to sqlite3_open_v2(). ^If the mode option is set to
2781 ** "rw", then the database is opened for read-write (but not create)
2782 ** access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had
2783 ** been set. ^Value "rwc" is equivalent to setting both
2784 ** SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE. ^If the mode option is
2785 ** set to "memory" then a pure [in-memory database] that never reads
2786 ** or writes from disk is used. ^It is an error to specify a value for
2787 ** the mode parameter that is less restrictive than that specified by
2788 ** the flags passed in the third parameter to sqlite3_open_v2().
2789 **
2790 ** <li> <b>cache</b>: ^The cache parameter may be set to either "shared" or
2791 ** "private". ^Setting it to "shared" is equivalent to setting the
2792 ** SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to
2793 ** sqlite3_open_v2(). ^Setting the cache parameter to "private" is
2794 ** equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit.
2795 ** ^If sqlite3_open_v2() is used and the "cache" parameter is present in
2796 ** a URI filename, its value overrides any behavior requested by setting
2797 ** SQLITE_OPEN_PRIVATECACHE or SQLITE_OPEN_SHAREDCACHE flag.
2798 **
2799 ** <li> <b>psow</b>: ^The psow parameter indicates whether or not the
2800 ** [powersafe overwrite] property does or does not apply to the
2801 ** storage media on which the database file resides.
2802 **
2803 ** <li> <b>nolock</b>: ^The nolock parameter is a boolean query parameter
2804 ** which if set disables file locking in rollback journal modes. This
2805 ** is useful for accessing a database on a filesystem that does not
2806 ** support locking. Caution: Database corruption might result if two
2807 ** or more processes write to the same database and any one of those
2808 ** processes uses nolock=1.
2809 **
2810 ** <li> <b>immutable</b>: ^The immutable parameter is a boolean query
2811 ** parameter that indicates that the database file is stored on
2812 ** read-only media. ^When immutable is set, SQLite assumes that the
2813 ** database file cannot be changed, even by a process with higher
2814 ** privilege, and so the database is opened read-only and all locking
2815 ** and change detection is disabled. Caution: Setting the immutable
2816 ** property on a database file that does in fact change can result
2817 ** in incorrect query results and/or [SQLITE_CORRUPT] errors.
2818 ** See also: [SQLITE_IOCAP_IMMUTABLE].
2819 **
2820 ** </ul>
2821 **
2822 ** ^Specifying an unknown parameter in the query component of a URI is not an
2823 ** error. Future versions of SQLite might understand additional query
2824 ** parameters. See "[query parameters with special meaning to SQLite]" for
2825 ** additional information.
2826 **
2827 ** [[URI filename examples]] <h3>URI filename examples</h3>
2828 **
2829 ** <table border="1" align=center cellpadding=5>
2830 ** <tr><th> URI filenames <th> Results
2831 ** <tr><td> file:data.db <td>
2832 ** Open the file "data.db" in the current directory.
2833 ** <tr><td> file:/home/fred/data.db<br>
2834 ** file:///home/fred/data.db <br>
2835 ** file://localhost/home/fred/data.db <br> <td>
2836 ** Open the database file "/home/fred/data.db".
2837 ** <tr><td> file://darkstar/home/fred/data.db <td>
2838 ** An error. "darkstar" is not a recognized authority.
2839 ** <tr><td style="white-space:nowrap">
2840 ** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db
2841 ** <td> Windows only: Open the file "data.db" on fred's desktop on drive
2842 ** C:. Note that the %20 escaping in this example is not strictly
2843 ** necessary - space characters can be used literally
2844 ** in URI filenames.
2845 ** <tr><td> file:data.db?mode=ro&cache=private <td>
2846 ** Open file "data.db" in the current directory for read-only access.
2847 ** Regardless of whether or not shared-cache mode is enabled by
2848 ** default, use a private cache.
2849 ** <tr><td> file:/home/fred/data.db?vfs=unix-dotfile <td>
2850 ** Open file "/home/fred/data.db". Use the special VFS "unix-dotfile"
2851 ** that uses dot-files in place of posix advisory locking.
2852 ** <tr><td> file:data.db?mode=readonly <td>
2853 ** An error. "readonly" is not a valid option for the "mode" parameter.
2854 ** </table>
2855 **
2856 ** ^URI hexadecimal escape sequences (%HH) are supported within the path and
2857 ** query components of a URI. A hexadecimal escape sequence consists of a
2858 ** percent sign - "%" - followed by exactly two hexadecimal digits
2859 ** specifying an octet value. ^Before the path or query components of a
2860 ** URI filename are interpreted, they are encoded using UTF-8 and all
2861 ** hexadecimal escape sequences replaced by a single byte containing the
2862 ** corresponding octet. If this process generates an invalid UTF-8 encoding,
2863 ** the results are undefined.
2400 ** 2864 **
2401 ** <b>Note to Windows users:</b> The encoding used for the filename argument 2865 ** <b>Note to Windows users:</b> The encoding used for the filename argument
2402 ** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever 2866 ** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever
2403 ** codepage is currently defined. Filenames containing international 2867 ** codepage is currently defined. Filenames containing international
2404 ** characters must be converted to UTF-8 prior to passing them into 2868 ** characters must be converted to UTF-8 prior to passing them into
2405 ** sqlite3_open() or sqlite3_open_v2(). 2869 ** sqlite3_open() or sqlite3_open_v2().
2870 **
2871 ** <b>Note to Windows Runtime users:</b> The temporary directory must be set
2872 ** prior to calling sqlite3_open() or sqlite3_open_v2(). Otherwise, various
2873 ** features that require the use of temporary files may fail.
2874 **
2875 ** See also: [sqlite3_temp_directory]
2406 */ 2876 */
2407 int sqlite3_open( 2877 int sqlite3_open(
2408 const char *filename, /* Database filename (UTF-8) */ 2878 const char *filename, /* Database filename (UTF-8) */
2409 sqlite3 **ppDb /* OUT: SQLite db handle */ 2879 sqlite3 **ppDb /* OUT: SQLite db handle */
2410 ); 2880 );
2411 int sqlite3_open16( 2881 int sqlite3_open16(
2412 const void *filename, /* Database filename (UTF-16) */ 2882 const void *filename, /* Database filename (UTF-16) */
2413 sqlite3 **ppDb /* OUT: SQLite db handle */ 2883 sqlite3 **ppDb /* OUT: SQLite db handle */
2414 ); 2884 );
2415 int sqlite3_open_v2( 2885 int sqlite3_open_v2(
2416 const char *filename, /* Database filename (UTF-8) */ 2886 const char *filename, /* Database filename (UTF-8) */
2417 sqlite3 **ppDb, /* OUT: SQLite db handle */ 2887 sqlite3 **ppDb, /* OUT: SQLite db handle */
2418 int flags, /* Flags */ 2888 int flags, /* Flags */
2419 const char *zVfs /* Name of VFS module to use */ 2889 const char *zVfs /* Name of VFS module to use */
2420 ); 2890 );
2421 2891
2422 /* 2892 /*
2893 ** CAPI3REF: Obtain Values For URI Parameters
2894 **
2895 ** These are utility routines, useful to VFS implementations, that check
2896 ** to see if a database file was a URI that contained a specific query
2897 ** parameter, and if so obtains the value of that query parameter.
2898 **
2899 ** If F is the database filename pointer passed into the xOpen() method of
2900 ** a VFS implementation when the flags parameter to xOpen() has one or
2901 ** more of the [SQLITE_OPEN_URI] or [SQLITE_OPEN_MAIN_DB] bits set and
2902 ** P is the name of the query parameter, then
2903 ** sqlite3_uri_parameter(F,P) returns the value of the P
2904 ** parameter if it exists or a NULL pointer if P does not appear as a
2905 ** query parameter on F. If P is a query parameter of F
2906 ** has no explicit value, then sqlite3_uri_parameter(F,P) returns
2907 ** a pointer to an empty string.
2908 **
2909 ** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean
2910 ** parameter and returns true (1) or false (0) according to the value
2911 ** of P. The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the
2912 ** value of query parameter P is one of "yes", "true", or "on" in any
2913 ** case or if the value begins with a non-zero number. The
2914 ** sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of
2915 ** query parameter P is one of "no", "false", or "off" in any case or
2916 ** if the value begins with a numeric zero. If P is not a query
2917 ** parameter on F or if the value of P is does not match any of the
2918 ** above, then sqlite3_uri_boolean(F,P,B) returns (B!=0).
2919 **
2920 ** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a
2921 ** 64-bit signed integer and returns that integer, or D if P does not
2922 ** exist. If the value of P is something other than an integer, then
2923 ** zero is returned.
2924 **
2925 ** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and
2926 ** sqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and
2927 ** is not a database file pathname pointer that SQLite passed into the xOpen
2928 ** VFS method, then the behavior of this routine is undefined and probably
2929 ** undesirable.
2930 */
2931 const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam);
2932 int sqlite3_uri_boolean(const char *zFile, const char *zParam, int bDefault);
2933 sqlite3_int64 sqlite3_uri_int64(const char*, const char*, sqlite3_int64);
2934
2935
2936 /*
2423 ** CAPI3REF: Error Codes And Messages 2937 ** CAPI3REF: Error Codes And Messages
2424 ** 2938 **
2425 ** ^The sqlite3_errcode() interface returns the numeric [result code] or 2939 ** ^The sqlite3_errcode() interface returns the numeric [result code] or
2426 ** [extended result code] for the most recent failed sqlite3_* API call 2940 ** [extended result code] for the most recent failed sqlite3_* API call
2427 ** associated with a [database connection]. If a prior API call failed 2941 ** associated with a [database connection]. If a prior API call failed
2428 ** but the most recent API call succeeded, the return value from 2942 ** but the most recent API call succeeded, the return value from
2429 ** sqlite3_errcode() is undefined. ^The sqlite3_extended_errcode() 2943 ** sqlite3_errcode() is undefined. ^The sqlite3_extended_errcode()
2430 ** interface is the same except that it always returns the 2944 ** interface is the same except that it always returns the
2431 ** [extended result code] even when extended result codes are 2945 ** [extended result code] even when extended result codes are
2432 ** disabled. 2946 ** disabled.
2433 ** 2947 **
2434 ** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language 2948 ** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language
2435 ** text that describes the error, as either UTF-8 or UTF-16 respectively. 2949 ** text that describes the error, as either UTF-8 or UTF-16 respectively.
2436 ** ^(Memory to hold the error message string is managed internally. 2950 ** ^(Memory to hold the error message string is managed internally.
2437 ** The application does not need to worry about freeing the result. 2951 ** The application does not need to worry about freeing the result.
2438 ** However, the error string might be overwritten or deallocated by 2952 ** However, the error string might be overwritten or deallocated by
2439 ** subsequent calls to other SQLite interface functions.)^ 2953 ** subsequent calls to other SQLite interface functions.)^
2440 ** 2954 **
2955 ** ^The sqlite3_errstr() interface returns the English-language text
2956 ** that describes the [result code], as UTF-8.
2957 ** ^(Memory to hold the error message string is managed internally
2958 ** and must not be freed by the application)^.
2959 **
2441 ** When the serialized [threading mode] is in use, it might be the 2960 ** When the serialized [threading mode] is in use, it might be the
2442 ** case that a second error occurs on a separate thread in between 2961 ** case that a second error occurs on a separate thread in between
2443 ** the time of the first error and the call to these interfaces. 2962 ** the time of the first error and the call to these interfaces.
2444 ** When that happens, the second error will be reported since these 2963 ** When that happens, the second error will be reported since these
2445 ** interfaces always report the most recent result. To avoid 2964 ** interfaces always report the most recent result. To avoid
2446 ** this, each thread can obtain exclusive use of the [database connection] D 2965 ** this, each thread can obtain exclusive use of the [database connection] D
2447 ** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning 2966 ** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning
2448 ** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after 2967 ** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after
2449 ** all calls to the interfaces listed here are completed. 2968 ** all calls to the interfaces listed here are completed.
2450 ** 2969 **
2451 ** If an interface fails with SQLITE_MISUSE, that means the interface 2970 ** If an interface fails with SQLITE_MISUSE, that means the interface
2452 ** was invoked incorrectly by the application. In that case, the 2971 ** was invoked incorrectly by the application. In that case, the
2453 ** error code and message may or may not be set. 2972 ** error code and message may or may not be set.
2454 */ 2973 */
2455 int sqlite3_errcode(sqlite3 *db); 2974 int sqlite3_errcode(sqlite3 *db);
2456 int sqlite3_extended_errcode(sqlite3 *db); 2975 int sqlite3_extended_errcode(sqlite3 *db);
2457 const char *sqlite3_errmsg(sqlite3*); 2976 const char *sqlite3_errmsg(sqlite3*);
2458 const void *sqlite3_errmsg16(sqlite3*); 2977 const void *sqlite3_errmsg16(sqlite3*);
2978 const char *sqlite3_errstr(int);
2459 2979
2460 /* 2980 /*
2461 ** CAPI3REF: SQL Statement Object 2981 ** CAPI3REF: SQL Statement Object
2462 ** KEYWORDS: {prepared statement} {prepared statements} 2982 ** KEYWORDS: {prepared statement} {prepared statements}
2463 ** 2983 **
2464 ** An instance of this object represents a single SQL statement. 2984 ** An instance of this object represents a single SQL statement.
2465 ** This object is variously known as a "prepared statement" or a 2985 ** This object is variously known as a "prepared statement" or a
2466 ** "compiled SQL statement" or simply as a "statement". 2986 ** "compiled SQL statement" or simply as a "statement".
2467 ** 2987 **
2468 ** The life of a statement object goes something like this: 2988 ** The life of a statement object goes something like this:
(...skipping 58 matching lines...) Expand 10 before | Expand all | Expand 10 after
2527 /* 3047 /*
2528 ** CAPI3REF: Run-Time Limit Categories 3048 ** CAPI3REF: Run-Time Limit Categories
2529 ** KEYWORDS: {limit category} {*limit categories} 3049 ** KEYWORDS: {limit category} {*limit categories}
2530 ** 3050 **
2531 ** These constants define various performance limits 3051 ** These constants define various performance limits
2532 ** that can be lowered at run-time using [sqlite3_limit()]. 3052 ** that can be lowered at run-time using [sqlite3_limit()].
2533 ** The synopsis of the meanings of the various limits is shown below. 3053 ** The synopsis of the meanings of the various limits is shown below.
2534 ** Additional information is available at [limits | Limits in SQLite]. 3054 ** Additional information is available at [limits | Limits in SQLite].
2535 ** 3055 **
2536 ** <dl> 3056 ** <dl>
2537 ** ^(<dt>SQLITE_LIMIT_LENGTH</dt> 3057 ** [[SQLITE_LIMIT_LENGTH]] ^(<dt>SQLITE_LIMIT_LENGTH</dt>
2538 ** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^ 3058 ** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^
2539 ** 3059 **
2540 ** ^(<dt>SQLITE_LIMIT_SQL_LENGTH</dt> 3060 ** [[SQLITE_LIMIT_SQL_LENGTH]] ^(<dt>SQLITE_LIMIT_SQL_LENGTH</dt>
2541 ** <dd>The maximum length of an SQL statement, in bytes.</dd>)^ 3061 ** <dd>The maximum length of an SQL statement, in bytes.</dd>)^
2542 ** 3062 **
2543 ** ^(<dt>SQLITE_LIMIT_COLUMN</dt> 3063 ** [[SQLITE_LIMIT_COLUMN]] ^(<dt>SQLITE_LIMIT_COLUMN</dt>
2544 ** <dd>The maximum number of columns in a table definition or in the 3064 ** <dd>The maximum number of columns in a table definition or in the
2545 ** result set of a [SELECT] or the maximum number of columns in an index 3065 ** result set of a [SELECT] or the maximum number of columns in an index
2546 ** or in an ORDER BY or GROUP BY clause.</dd>)^ 3066 ** or in an ORDER BY or GROUP BY clause.</dd>)^
2547 ** 3067 **
2548 ** ^(<dt>SQLITE_LIMIT_EXPR_DEPTH</dt> 3068 ** [[SQLITE_LIMIT_EXPR_DEPTH]] ^(<dt>SQLITE_LIMIT_EXPR_DEPTH</dt>
2549 ** <dd>The maximum depth of the parse tree on any expression.</dd>)^ 3069 ** <dd>The maximum depth of the parse tree on any expression.</dd>)^
2550 ** 3070 **
2551 ** ^(<dt>SQLITE_LIMIT_COMPOUND_SELECT</dt> 3071 ** [[SQLITE_LIMIT_COMPOUND_SELECT]] ^(<dt>SQLITE_LIMIT_COMPOUND_SELECT</dt>
2552 ** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^ 3072 ** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^
2553 ** 3073 **
2554 ** ^(<dt>SQLITE_LIMIT_VDBE_OP</dt> 3074 ** [[SQLITE_LIMIT_VDBE_OP]] ^(<dt>SQLITE_LIMIT_VDBE_OP</dt>
2555 ** <dd>The maximum number of instructions in a virtual machine program 3075 ** <dd>The maximum number of instructions in a virtual machine program
2556 ** used to implement an SQL statement. This limit is not currently 3076 ** used to implement an SQL statement. This limit is not currently
2557 ** enforced, though that might be added in some future release of 3077 ** enforced, though that might be added in some future release of
2558 ** SQLite.</dd>)^ 3078 ** SQLite.</dd>)^
2559 ** 3079 **
2560 ** ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt> 3080 ** [[SQLITE_LIMIT_FUNCTION_ARG]] ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt>
2561 ** <dd>The maximum number of arguments on a function.</dd>)^ 3081 ** <dd>The maximum number of arguments on a function.</dd>)^
2562 ** 3082 **
2563 ** ^(<dt>SQLITE_LIMIT_ATTACHED</dt> 3083 ** [[SQLITE_LIMIT_ATTACHED]] ^(<dt>SQLITE_LIMIT_ATTACHED</dt>
2564 ** <dd>The maximum number of [ATTACH | attached databases].)^</dd> 3084 ** <dd>The maximum number of [ATTACH | attached databases].)^</dd>
2565 ** 3085 **
3086 ** [[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]]
2566 ** ^(<dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt> 3087 ** ^(<dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt>
2567 ** <dd>The maximum length of the pattern argument to the [LIKE] or 3088 ** <dd>The maximum length of the pattern argument to the [LIKE] or
2568 ** [GLOB] operators.</dd>)^ 3089 ** [GLOB] operators.</dd>)^
2569 ** 3090 **
3091 ** [[SQLITE_LIMIT_VARIABLE_NUMBER]]
2570 ** ^(<dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt> 3092 ** ^(<dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt>
2571 ** <dd>The maximum index number of any [parameter] in an SQL statement.)^ 3093 ** <dd>The maximum index number of any [parameter] in an SQL statement.)^
2572 ** 3094 **
2573 ** ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt> 3095 ** [[SQLITE_LIMIT_TRIGGER_DEPTH]] ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt>
2574 ** <dd>The maximum depth of recursion for triggers.</dd>)^ 3096 ** <dd>The maximum depth of recursion for triggers.</dd>)^
3097 **
3098 ** [[SQLITE_LIMIT_WORKER_THREADS]] ^(<dt>SQLITE_LIMIT_WORKER_THREADS</dt>
3099 ** <dd>The maximum number of auxiliary worker threads that a single
3100 ** [prepared statement] may start.</dd>)^
2575 ** </dl> 3101 ** </dl>
2576 */ 3102 */
2577 #define SQLITE_LIMIT_LENGTH 0 3103 #define SQLITE_LIMIT_LENGTH 0
2578 #define SQLITE_LIMIT_SQL_LENGTH 1 3104 #define SQLITE_LIMIT_SQL_LENGTH 1
2579 #define SQLITE_LIMIT_COLUMN 2 3105 #define SQLITE_LIMIT_COLUMN 2
2580 #define SQLITE_LIMIT_EXPR_DEPTH 3 3106 #define SQLITE_LIMIT_EXPR_DEPTH 3
2581 #define SQLITE_LIMIT_COMPOUND_SELECT 4 3107 #define SQLITE_LIMIT_COMPOUND_SELECT 4
2582 #define SQLITE_LIMIT_VDBE_OP 5 3108 #define SQLITE_LIMIT_VDBE_OP 5
2583 #define SQLITE_LIMIT_FUNCTION_ARG 6 3109 #define SQLITE_LIMIT_FUNCTION_ARG 6
2584 #define SQLITE_LIMIT_ATTACHED 7 3110 #define SQLITE_LIMIT_ATTACHED 7
2585 #define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8 3111 #define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8
2586 #define SQLITE_LIMIT_VARIABLE_NUMBER 9 3112 #define SQLITE_LIMIT_VARIABLE_NUMBER 9
2587 #define SQLITE_LIMIT_TRIGGER_DEPTH 10 3113 #define SQLITE_LIMIT_TRIGGER_DEPTH 10
3114 #define SQLITE_LIMIT_WORKER_THREADS 11
2588 3115
2589 /* 3116 /*
2590 ** CAPI3REF: Compiling An SQL Statement 3117 ** CAPI3REF: Compiling An SQL Statement
2591 ** KEYWORDS: {SQL statement compiler} 3118 ** KEYWORDS: {SQL statement compiler}
2592 ** 3119 **
2593 ** To execute an SQL query, it must first be compiled into a byte-code 3120 ** To execute an SQL query, it must first be compiled into a byte-code
2594 ** program using one of these routines. 3121 ** program using one of these routines.
2595 ** 3122 **
2596 ** The first argument, "db", is a [database connection] obtained from a 3123 ** The first argument, "db", is a [database connection] obtained from a
2597 ** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or 3124 ** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or
2598 ** [sqlite3_open16()]. The database connection must not have been closed. 3125 ** [sqlite3_open16()]. The database connection must not have been closed.
2599 ** 3126 **
2600 ** The second argument, "zSql", is the statement to be compiled, encoded 3127 ** The second argument, "zSql", is the statement to be compiled, encoded
2601 ** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2() 3128 ** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2()
2602 ** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2() 3129 ** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2()
2603 ** use UTF-16. 3130 ** use UTF-16.
2604 ** 3131 **
2605 ** ^If the nByte argument is less than zero, then zSql is read up to the 3132 ** ^If the nByte argument is less than zero, then zSql is read up to the
2606 ** first zero terminator. ^If nByte is non-negative, then it is the maximum 3133 ** first zero terminator. ^If nByte is non-negative, then it is the maximum
2607 ** number of bytes read from zSql. ^When nByte is non-negative, the 3134 ** number of bytes read from zSql. ^When nByte is non-negative, the
2608 ** zSql string ends at either the first '\000' or '\u0000' character or 3135 ** zSql string ends at either the first '\000' or '\u0000' character or
2609 ** the nByte-th byte, whichever comes first. If the caller knows 3136 ** the nByte-th byte, whichever comes first. If the caller knows
2610 ** that the supplied string is nul-terminated, then there is a small 3137 ** that the supplied string is nul-terminated, then there is a small
2611 ** performance advantage to be gained by passing an nByte parameter that 3138 ** performance advantage to be gained by passing an nByte parameter that
2612 ** is equal to the number of bytes in the input string <i>including</i> 3139 ** is equal to the number of bytes in the input string <i>including</i>
2613 ** the nul-terminator bytes. 3140 ** the nul-terminator bytes as this saves SQLite from having to
3141 ** make a copy of the input string.
2614 ** 3142 **
2615 ** ^If pzTail is not NULL then *pzTail is made to point to the first byte 3143 ** ^If pzTail is not NULL then *pzTail is made to point to the first byte
2616 ** past the end of the first SQL statement in zSql. These routines only 3144 ** past the end of the first SQL statement in zSql. These routines only
2617 ** compile the first statement in zSql, so *pzTail is left pointing to 3145 ** compile the first statement in zSql, so *pzTail is left pointing to
2618 ** what remains uncompiled. 3146 ** what remains uncompiled.
2619 ** 3147 **
2620 ** ^*ppStmt is left pointing to a compiled [prepared statement] that can be 3148 ** ^*ppStmt is left pointing to a compiled [prepared statement] that can be
2621 ** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set 3149 ** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set
2622 ** to NULL. ^If the input text contains no SQL (if the input is an empty 3150 ** to NULL. ^If the input text contains no SQL (if the input is an empty
2623 ** string or a comment) then *ppStmt is set to NULL. 3151 ** string or a comment) then *ppStmt is set to NULL.
2624 ** The calling procedure is responsible for deleting the compiled 3152 ** The calling procedure is responsible for deleting the compiled
2625 ** SQL statement using [sqlite3_finalize()] after it has finished with it. 3153 ** SQL statement using [sqlite3_finalize()] after it has finished with it.
2626 ** ppStmt may not be NULL. 3154 ** ppStmt may not be NULL.
2627 ** 3155 **
2628 ** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK]; 3156 ** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK];
2629 ** otherwise an [error code] is returned. 3157 ** otherwise an [error code] is returned.
2630 ** 3158 **
2631 ** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are 3159 ** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are
2632 ** recommended for all new programs. The two older interfaces are retained 3160 ** recommended for all new programs. The two older interfaces are retained
2633 ** for backwards compatibility, but their use is discouraged. 3161 ** for backwards compatibility, but their use is discouraged.
2634 ** ^In the "v2" interfaces, the prepared statement 3162 ** ^In the "v2" interfaces, the prepared statement
2635 ** that is returned (the [sqlite3_stmt] object) contains a copy of the 3163 ** that is returned (the [sqlite3_stmt] object) contains a copy of the
2636 ** original SQL text. This causes the [sqlite3_step()] interface to 3164 ** original SQL text. This causes the [sqlite3_step()] interface to
2637 ** behave differently in three ways: 3165 ** behave differently in three ways:
2638 ** 3166 **
2639 ** <ol> 3167 ** <ol>
2640 ** <li> 3168 ** <li>
2641 ** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it 3169 ** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it
2642 ** always used to do, [sqlite3_step()] will automatically recompile the SQL 3170 ** always used to do, [sqlite3_step()] will automatically recompile the SQL
2643 ** statement and try to run it again. 3171 ** statement and try to run it again. As many as [SQLITE_MAX_SCHEMA_RETRY]
3172 ** retries will occur before sqlite3_step() gives up and returns an error.
2644 ** </li> 3173 ** </li>
2645 ** 3174 **
2646 ** <li> 3175 ** <li>
2647 ** ^When an error occurs, [sqlite3_step()] will return one of the detailed 3176 ** ^When an error occurs, [sqlite3_step()] will return one of the detailed
2648 ** [error codes] or [extended error codes]. ^The legacy behavior was that 3177 ** [error codes] or [extended error codes]. ^The legacy behavior was that
2649 ** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code 3178 ** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code
2650 ** and the application would have to make a second call to [sqlite3_reset()] 3179 ** and the application would have to make a second call to [sqlite3_reset()]
2651 ** in order to find the underlying cause of the problem. With the "v2" prepare 3180 ** in order to find the underlying cause of the problem. With the "v2" prepare
2652 ** interfaces, the underlying reason for the error is returned immediately. 3181 ** interfaces, the underlying reason for the error is returned immediately.
2653 ** </li> 3182 ** </li>
2654 ** 3183 **
2655 ** <li> 3184 ** <li>
2656 ** ^If the specific value bound to [parameter | host parameter] in the 3185 ** ^If the specific value bound to [parameter | host parameter] in the
2657 ** WHERE clause might influence the choice of query plan for a statement, 3186 ** WHERE clause might influence the choice of query plan for a statement,
2658 ** then the statement will be automatically recompiled, as if there had been 3187 ** then the statement will be automatically recompiled, as if there had been
2659 ** a schema change, on the first [sqlite3_step()] call following any change 3188 ** a schema change, on the first [sqlite3_step()] call following any change
2660 ** to the [sqlite3_bind_text | bindings] of that [parameter]. 3189 ** to the [sqlite3_bind_text | bindings] of that [parameter].
2661 ** ^The specific value of WHERE-clause [parameter] might influence the 3190 ** ^The specific value of WHERE-clause [parameter] might influence the
2662 ** choice of query plan if the parameter is the left-hand side of a [LIKE] 3191 ** choice of query plan if the parameter is the left-hand side of a [LIKE]
2663 ** or [GLOB] operator or if the parameter is compared to an indexed column 3192 ** or [GLOB] operator or if the parameter is compared to an indexed column
2664 ** and the [SQLITE_ENABLE_STAT2] compile-time option is enabled. 3193 ** and the [SQLITE_ENABLE_STAT3] compile-time option is enabled.
2665 ** the
2666 ** </li> 3194 ** </li>
2667 ** </ol> 3195 ** </ol>
2668 */ 3196 */
2669 int sqlite3_prepare( 3197 int sqlite3_prepare(
2670 sqlite3 *db, /* Database handle */ 3198 sqlite3 *db, /* Database handle */
2671 const char *zSql, /* SQL statement, UTF-8 encoded */ 3199 const char *zSql, /* SQL statement, UTF-8 encoded */
2672 int nByte, /* Maximum length of zSql in bytes. */ 3200 int nByte, /* Maximum length of zSql in bytes. */
2673 sqlite3_stmt **ppStmt, /* OUT: Statement handle */ 3201 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
2674 const char **pzTail /* OUT: Pointer to unused portion of zSql */ 3202 const char **pzTail /* OUT: Pointer to unused portion of zSql */
2675 ); 3203 );
(...skipping 53 matching lines...) Expand 10 before | Expand all | Expand 10 after
2729 ** since the statements themselves do not actually modify the database but 3257 ** since the statements themselves do not actually modify the database but
2730 ** rather they control the timing of when other statements modify the 3258 ** rather they control the timing of when other statements modify the
2731 ** database. ^The [ATTACH] and [DETACH] statements also cause 3259 ** database. ^The [ATTACH] and [DETACH] statements also cause
2732 ** sqlite3_stmt_readonly() to return true since, while those statements 3260 ** sqlite3_stmt_readonly() to return true since, while those statements
2733 ** change the configuration of a database connection, they do not make 3261 ** change the configuration of a database connection, they do not make
2734 ** changes to the content of the database files on disk. 3262 ** changes to the content of the database files on disk.
2735 */ 3263 */
2736 int sqlite3_stmt_readonly(sqlite3_stmt *pStmt); 3264 int sqlite3_stmt_readonly(sqlite3_stmt *pStmt);
2737 3265
2738 /* 3266 /*
3267 ** CAPI3REF: Determine If A Prepared Statement Has Been Reset
3268 **
3269 ** ^The sqlite3_stmt_busy(S) interface returns true (non-zero) if the
3270 ** [prepared statement] S has been stepped at least once using
3271 ** [sqlite3_step(S)] but has not run to completion and/or has not
3272 ** been reset using [sqlite3_reset(S)]. ^The sqlite3_stmt_busy(S)
3273 ** interface returns false if S is a NULL pointer. If S is not a
3274 ** NULL pointer and is not a pointer to a valid [prepared statement]
3275 ** object, then the behavior is undefined and probably undesirable.
3276 **
3277 ** This interface can be used in combination [sqlite3_next_stmt()]
3278 ** to locate all prepared statements associated with a database
3279 ** connection that are in need of being reset. This can be used,
3280 ** for example, in diagnostic routines to search for prepared
3281 ** statements that are holding a transaction open.
3282 */
3283 int sqlite3_stmt_busy(sqlite3_stmt*);
3284
3285 /*
2739 ** CAPI3REF: Dynamically Typed Value Object 3286 ** CAPI3REF: Dynamically Typed Value Object
2740 ** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value} 3287 ** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value}
2741 ** 3288 **
2742 ** SQLite uses the sqlite3_value object to represent all values 3289 ** SQLite uses the sqlite3_value object to represent all values
2743 ** that can be stored in a database table. SQLite uses dynamic typing 3290 ** that can be stored in a database table. SQLite uses dynamic typing
2744 ** for the values it stores. ^Values stored in sqlite3_value objects 3291 ** for the values it stores. ^Values stored in sqlite3_value objects
2745 ** can be integers, floating point values, strings, BLOBs, or NULL. 3292 ** can be integers, floating point values, strings, BLOBs, or NULL.
2746 ** 3293 **
2747 ** An sqlite3_value object may be either "protected" or "unprotected". 3294 ** An sqlite3_value object may be either "protected" or "unprotected".
2748 ** Some interfaces require a protected sqlite3_value. Other interfaces 3295 ** Some interfaces require a protected sqlite3_value. Other interfaces
(...skipping 69 matching lines...) Expand 10 before | Expand all | Expand 10 after
2818 ** ^The leftmost SQL parameter has an index of 1. ^When the same named 3365 ** ^The leftmost SQL parameter has an index of 1. ^When the same named
2819 ** SQL parameter is used more than once, second and subsequent 3366 ** SQL parameter is used more than once, second and subsequent
2820 ** occurrences have the same index as the first occurrence. 3367 ** occurrences have the same index as the first occurrence.
2821 ** ^The index for named parameters can be looked up using the 3368 ** ^The index for named parameters can be looked up using the
2822 ** [sqlite3_bind_parameter_index()] API if desired. ^The index 3369 ** [sqlite3_bind_parameter_index()] API if desired. ^The index
2823 ** for "?NNN" parameters is the value of NNN. 3370 ** for "?NNN" parameters is the value of NNN.
2824 ** ^The NNN value must be between 1 and the [sqlite3_limit()] 3371 ** ^The NNN value must be between 1 and the [sqlite3_limit()]
2825 ** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999). 3372 ** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999).
2826 ** 3373 **
2827 ** ^The third argument is the value to bind to the parameter. 3374 ** ^The third argument is the value to bind to the parameter.
3375 ** ^If the third parameter to sqlite3_bind_text() or sqlite3_bind_text16()
3376 ** or sqlite3_bind_blob() is a NULL pointer then the fourth parameter
3377 ** is ignored and the end result is the same as sqlite3_bind_null().
2828 ** 3378 **
2829 ** ^(In those routines that have a fourth argument, its value is the 3379 ** ^(In those routines that have a fourth argument, its value is the
2830 ** number of bytes in the parameter. To be clear: the value is the 3380 ** number of bytes in the parameter. To be clear: the value is the
2831 ** number of <u>bytes</u> in the value, not the number of characters.)^ 3381 ** number of <u>bytes</u> in the value, not the number of characters.)^
2832 ** ^If the fourth parameter is negative, the length of the string is 3382 ** ^If the fourth parameter to sqlite3_bind_text() or sqlite3_bind_text16()
3383 ** is negative, then the length of the string is
2833 ** the number of bytes up to the first zero terminator. 3384 ** the number of bytes up to the first zero terminator.
3385 ** If the fourth parameter to sqlite3_bind_blob() is negative, then
3386 ** the behavior is undefined.
3387 ** If a non-negative fourth parameter is provided to sqlite3_bind_text()
3388 ** or sqlite3_bind_text16() or sqlite3_bind_text64() then
3389 ** that parameter must be the byte offset
3390 ** where the NUL terminator would occur assuming the string were NUL
3391 ** terminated. If any NUL characters occur at byte offsets less than
3392 ** the value of the fourth parameter then the resulting string value will
3393 ** contain embedded NULs. The result of expressions involving strings
3394 ** with embedded NULs is undefined.
2834 ** 3395 **
2835 ** ^The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and 3396 ** ^The fifth argument to the BLOB and string binding interfaces
2836 ** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or 3397 ** is a destructor used to dispose of the BLOB or
2837 ** string after SQLite has finished with it. ^The destructor is called 3398 ** string after SQLite has finished with it. ^The destructor is called
2838 ** to dispose of the BLOB or string even if the call to sqlite3_bind_blob(), 3399 ** to dispose of the BLOB or string even if the call to bind API fails.
2839 ** sqlite3_bind_text(), or sqlite3_bind_text16() fails.
2840 ** ^If the fifth argument is 3400 ** ^If the fifth argument is
2841 ** the special value [SQLITE_STATIC], then SQLite assumes that the 3401 ** the special value [SQLITE_STATIC], then SQLite assumes that the
2842 ** information is in static, unmanaged space and does not need to be freed. 3402 ** information is in static, unmanaged space and does not need to be freed.
2843 ** ^If the fifth argument has the value [SQLITE_TRANSIENT], then 3403 ** ^If the fifth argument has the value [SQLITE_TRANSIENT], then
2844 ** SQLite makes its own private copy of the data immediately, before 3404 ** SQLite makes its own private copy of the data immediately, before
2845 ** the sqlite3_bind_*() routine returns. 3405 ** the sqlite3_bind_*() routine returns.
2846 ** 3406 **
3407 ** ^The sixth argument to sqlite3_bind_text64() must be one of
3408 ** [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE]
3409 ** to specify the encoding of the text in the third parameter. If
3410 ** the sixth argument to sqlite3_bind_text64() is not one of the
3411 ** allowed values shown above, or if the text encoding is different
3412 ** from the encoding specified by the sixth parameter, then the behavior
3413 ** is undefined.
3414 **
2847 ** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that 3415 ** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that
2848 ** is filled with zeroes. ^A zeroblob uses a fixed amount of memory 3416 ** is filled with zeroes. ^A zeroblob uses a fixed amount of memory
2849 ** (just an integer to hold its size) while it is being processed. 3417 ** (just an integer to hold its size) while it is being processed.
2850 ** Zeroblobs are intended to serve as placeholders for BLOBs whose 3418 ** Zeroblobs are intended to serve as placeholders for BLOBs whose
2851 ** content is later written using 3419 ** content is later written using
2852 ** [sqlite3_blob_open | incremental BLOB I/O] routines. 3420 ** [sqlite3_blob_open | incremental BLOB I/O] routines.
2853 ** ^A negative value for the zeroblob results in a zero-length BLOB. 3421 ** ^A negative value for the zeroblob results in a zero-length BLOB.
2854 ** 3422 **
2855 ** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer 3423 ** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer
2856 ** for the [prepared statement] or with a prepared statement for which 3424 ** for the [prepared statement] or with a prepared statement for which
2857 ** [sqlite3_step()] has been called more recently than [sqlite3_reset()], 3425 ** [sqlite3_step()] has been called more recently than [sqlite3_reset()],
2858 ** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_() 3426 ** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_()
2859 ** routine is passed a [prepared statement] that has been finalized, the 3427 ** routine is passed a [prepared statement] that has been finalized, the
2860 ** result is undefined and probably harmful. 3428 ** result is undefined and probably harmful.
2861 ** 3429 **
2862 ** ^Bindings are not cleared by the [sqlite3_reset()] routine. 3430 ** ^Bindings are not cleared by the [sqlite3_reset()] routine.
2863 ** ^Unbound parameters are interpreted as NULL. 3431 ** ^Unbound parameters are interpreted as NULL.
2864 ** 3432 **
2865 ** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an 3433 ** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an
2866 ** [error code] if anything goes wrong. 3434 ** [error code] if anything goes wrong.
3435 ** ^[SQLITE_TOOBIG] might be returned if the size of a string or BLOB
3436 ** exceeds limits imposed by [sqlite3_limit]([SQLITE_LIMIT_LENGTH]) or
3437 ** [SQLITE_MAX_LENGTH].
2867 ** ^[SQLITE_RANGE] is returned if the parameter 3438 ** ^[SQLITE_RANGE] is returned if the parameter
2868 ** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails. 3439 ** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails.
2869 ** 3440 **
2870 ** See also: [sqlite3_bind_parameter_count()], 3441 ** See also: [sqlite3_bind_parameter_count()],
2871 ** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()]. 3442 ** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()].
2872 */ 3443 */
2873 int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*)); 3444 int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*));
3445 int sqlite3_bind_blob64(sqlite3_stmt*, int, const void*, sqlite3_uint64,
3446 void(*)(void*));
2874 int sqlite3_bind_double(sqlite3_stmt*, int, double); 3447 int sqlite3_bind_double(sqlite3_stmt*, int, double);
2875 int sqlite3_bind_int(sqlite3_stmt*, int, int); 3448 int sqlite3_bind_int(sqlite3_stmt*, int, int);
2876 int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64); 3449 int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64);
2877 int sqlite3_bind_null(sqlite3_stmt*, int); 3450 int sqlite3_bind_null(sqlite3_stmt*, int);
2878 int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*)); 3451 int sqlite3_bind_text(sqlite3_stmt*,int,const char*,int,void(*)(void*));
2879 int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*)); 3452 int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*));
3453 int sqlite3_bind_text64(sqlite3_stmt*, int, const char*, sqlite3_uint64,
3454 void(*)(void*), unsigned char encoding);
2880 int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*); 3455 int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);
2881 int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n); 3456 int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n);
2882 3457
2883 /* 3458 /*
2884 ** CAPI3REF: Number Of SQL Parameters 3459 ** CAPI3REF: Number Of SQL Parameters
2885 ** 3460 **
2886 ** ^This routine can be used to find the number of [SQL parameters] 3461 ** ^This routine can be used to find the number of [SQL parameters]
2887 ** in a [prepared statement]. SQL parameters are tokens of the 3462 ** in a [prepared statement]. SQL parameters are tokens of the
2888 ** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as 3463 ** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as
2889 ** placeholders for values that are [sqlite3_bind_blob | bound] 3464 ** placeholders for values that are [sqlite3_bind_blob | bound]
(...skipping 202 matching lines...) Expand 10 before | Expand all | Expand 10 after
3092 ** interface will continue to be supported. 3667 ** interface will continue to be supported.
3093 ** 3668 **
3094 ** ^In the legacy interface, the return value will be either [SQLITE_BUSY], 3669 ** ^In the legacy interface, the return value will be either [SQLITE_BUSY],
3095 ** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE]. 3670 ** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE].
3096 ** ^With the "v2" interface, any of the other [result codes] or 3671 ** ^With the "v2" interface, any of the other [result codes] or
3097 ** [extended result codes] might be returned as well. 3672 ** [extended result codes] might be returned as well.
3098 ** 3673 **
3099 ** ^[SQLITE_BUSY] means that the database engine was unable to acquire the 3674 ** ^[SQLITE_BUSY] means that the database engine was unable to acquire the
3100 ** database locks it needs to do its job. ^If the statement is a [COMMIT] 3675 ** database locks it needs to do its job. ^If the statement is a [COMMIT]
3101 ** or occurs outside of an explicit transaction, then you can retry the 3676 ** or occurs outside of an explicit transaction, then you can retry the
3102 ** statement. If the statement is not a [COMMIT] and occurs within a 3677 ** statement. If the statement is not a [COMMIT] and occurs within an
3103 ** explicit transaction then you should rollback the transaction before 3678 ** explicit transaction then you should rollback the transaction before
3104 ** continuing. 3679 ** continuing.
3105 ** 3680 **
3106 ** ^[SQLITE_DONE] means that the statement has finished executing 3681 ** ^[SQLITE_DONE] means that the statement has finished executing
3107 ** successfully. sqlite3_step() should not be called again on this virtual 3682 ** successfully. sqlite3_step() should not be called again on this virtual
3108 ** machine without first calling [sqlite3_reset()] to reset the virtual 3683 ** machine without first calling [sqlite3_reset()] to reset the virtual
3109 ** machine back to its initial state. 3684 ** machine back to its initial state.
3110 ** 3685 **
3111 ** ^If the SQL statement being executed returns any data, then [SQLITE_ROW] 3686 ** ^If the SQL statement being executed returns any data, then [SQLITE_ROW]
3112 ** is returned each time a new row of data is ready for processing by the 3687 ** is returned each time a new row of data is ready for processing by the
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after
3157 3732
3158 /* 3733 /*
3159 ** CAPI3REF: Number of columns in a result set 3734 ** CAPI3REF: Number of columns in a result set
3160 ** 3735 **
3161 ** ^The sqlite3_data_count(P) interface returns the number of columns in the 3736 ** ^The sqlite3_data_count(P) interface returns the number of columns in the
3162 ** current row of the result set of [prepared statement] P. 3737 ** current row of the result set of [prepared statement] P.
3163 ** ^If prepared statement P does not have results ready to return 3738 ** ^If prepared statement P does not have results ready to return
3164 ** (via calls to the [sqlite3_column_int | sqlite3_column_*()] of 3739 ** (via calls to the [sqlite3_column_int | sqlite3_column_*()] of
3165 ** interfaces) then sqlite3_data_count(P) returns 0. 3740 ** interfaces) then sqlite3_data_count(P) returns 0.
3166 ** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer. 3741 ** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer.
3742 ** ^The sqlite3_data_count(P) routine returns 0 if the previous call to
3743 ** [sqlite3_step](P) returned [SQLITE_DONE]. ^The sqlite3_data_count(P)
3744 ** will return non-zero if previous call to [sqlite3_step](P) returned
3745 ** [SQLITE_ROW], except in the case of the [PRAGMA incremental_vacuum]
3746 ** where it always returns zero since each step of that multi-step
3747 ** pragma returns 0 columns of data.
3167 ** 3748 **
3168 ** See also: [sqlite3_column_count()] 3749 ** See also: [sqlite3_column_count()]
3169 */ 3750 */
3170 int sqlite3_data_count(sqlite3_stmt *pStmt); 3751 int sqlite3_data_count(sqlite3_stmt *pStmt);
3171 3752
3172 /* 3753 /*
3173 ** CAPI3REF: Fundamental Datatypes 3754 ** CAPI3REF: Fundamental Datatypes
3174 ** KEYWORDS: SQLITE_TEXT 3755 ** KEYWORDS: SQLITE_TEXT
3175 ** 3756 **
3176 ** ^(Every value in SQLite has one of five fundamental datatypes: 3757 ** ^(Every value in SQLite has one of five fundamental datatypes:
(...skipping 79 matching lines...) Expand 10 before | Expand all | Expand 10 after
3256 ** the number of bytes in that string. 3837 ** the number of bytes in that string.
3257 ** ^If the result is NULL, then sqlite3_column_bytes16() returns zero. 3838 ** ^If the result is NULL, then sqlite3_column_bytes16() returns zero.
3258 ** 3839 **
3259 ** ^The values returned by [sqlite3_column_bytes()] and 3840 ** ^The values returned by [sqlite3_column_bytes()] and
3260 ** [sqlite3_column_bytes16()] do not include the zero terminators at the end 3841 ** [sqlite3_column_bytes16()] do not include the zero terminators at the end
3261 ** of the string. ^For clarity: the values returned by 3842 ** of the string. ^For clarity: the values returned by
3262 ** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of 3843 ** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of
3263 ** bytes in the string, not the number of characters. 3844 ** bytes in the string, not the number of characters.
3264 ** 3845 **
3265 ** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(), 3846 ** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(),
3266 ** even empty strings, are always zero terminated. ^The return 3847 ** even empty strings, are always zero-terminated. ^The return
3267 ** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer. 3848 ** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer.
3268 ** 3849 **
3269 ** ^The object returned by [sqlite3_column_value()] is an 3850 ** ^The object returned by [sqlite3_column_value()] is an
3270 ** [unprotected sqlite3_value] object. An unprotected sqlite3_value object 3851 ** [unprotected sqlite3_value] object. An unprotected sqlite3_value object
3271 ** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()]. 3852 ** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()].
3272 ** If the [unprotected sqlite3_value] object returned by 3853 ** If the [unprotected sqlite3_value] object returned by
3273 ** [sqlite3_column_value()] is used in any other way, including calls 3854 ** [sqlite3_column_value()] is used in any other way, including calls
3274 ** to routines like [sqlite3_value_int()], [sqlite3_value_text()], 3855 ** to routines like [sqlite3_value_int()], [sqlite3_value_text()],
3275 ** or [sqlite3_value_bytes()], then the behavior is undefined. 3856 ** or [sqlite3_value_bytes()], then the behavior is undefined.
3276 ** 3857 **
3277 ** These routines attempt to convert the value where appropriate. ^For 3858 ** These routines attempt to convert the value where appropriate. ^For
3278 ** example, if the internal representation is FLOAT and a text result 3859 ** example, if the internal representation is FLOAT and a text result
3279 ** is requested, [sqlite3_snprintf()] is used internally to perform the 3860 ** is requested, [sqlite3_snprintf()] is used internally to perform the
3280 ** conversion automatically. ^(The following table details the conversions 3861 ** conversion automatically. ^(The following table details the conversions
3281 ** that are applied: 3862 ** that are applied:
3282 ** 3863 **
3283 ** <blockquote> 3864 ** <blockquote>
3284 ** <table border="1"> 3865 ** <table border="1">
3285 ** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion 3866 ** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion
3286 ** 3867 **
3287 ** <tr><td> NULL <td> INTEGER <td> Result is 0 3868 ** <tr><td> NULL <td> INTEGER <td> Result is 0
3288 ** <tr><td> NULL <td> FLOAT <td> Result is 0.0 3869 ** <tr><td> NULL <td> FLOAT <td> Result is 0.0
3289 ** <tr><td> NULL <td> TEXT <td> Result is NULL pointer 3870 ** <tr><td> NULL <td> TEXT <td> Result is a NULL pointer
3290 ** <tr><td> NULL <td> BLOB <td> Result is NULL pointer 3871 ** <tr><td> NULL <td> BLOB <td> Result is a NULL pointer
3291 ** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float 3872 ** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float
3292 ** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer 3873 ** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer
3293 ** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT 3874 ** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT
3294 ** <tr><td> FLOAT <td> INTEGER <td> Convert from float to integer 3875 ** <tr><td> FLOAT <td> INTEGER <td> [CAST] to INTEGER
3295 ** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float 3876 ** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float
3296 ** <tr><td> FLOAT <td> BLOB <td> Same as FLOAT->TEXT 3877 ** <tr><td> FLOAT <td> BLOB <td> [CAST] to BLOB
3297 ** <tr><td> TEXT <td> INTEGER <td> Use atoi() 3878 ** <tr><td> TEXT <td> INTEGER <td> [CAST] to INTEGER
3298 ** <tr><td> TEXT <td> FLOAT <td> Use atof() 3879 ** <tr><td> TEXT <td> FLOAT <td> [CAST] to REAL
3299 ** <tr><td> TEXT <td> BLOB <td> No change 3880 ** <tr><td> TEXT <td> BLOB <td> No change
3300 ** <tr><td> BLOB <td> INTEGER <td> Convert to TEXT then use atoi() 3881 ** <tr><td> BLOB <td> INTEGER <td> [CAST] to INTEGER
3301 ** <tr><td> BLOB <td> FLOAT <td> Convert to TEXT then use atof() 3882 ** <tr><td> BLOB <td> FLOAT <td> [CAST] to REAL
3302 ** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed 3883 ** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed
3303 ** </table> 3884 ** </table>
3304 ** </blockquote>)^ 3885 ** </blockquote>)^
3305 ** 3886 **
3306 ** The table above makes reference to standard C library functions atoi() 3887 ** The table above makes reference to standard C library functions atoi()
3307 ** and atof(). SQLite does not really use these functions. It has its 3888 ** and atof(). SQLite does not really use these functions. It has its
3308 ** own equivalent internal routines. The atoi() and atof() names are 3889 ** own equivalent internal routines. The atoi() and atof() names are
3309 ** used in the table for brevity and because they are familiar to most 3890 ** used in the table for brevity and because they are familiar to most
3310 ** C programmers. 3891 ** C programmers.
3311 ** 3892 **
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after
3347 ** into the desired format, then invoke sqlite3_column_bytes() or 3928 ** into the desired format, then invoke sqlite3_column_bytes() or
3348 ** sqlite3_column_bytes16() to find the size of the result. Do not mix calls 3929 ** sqlite3_column_bytes16() to find the size of the result. Do not mix calls
3349 ** to sqlite3_column_text() or sqlite3_column_blob() with calls to 3930 ** to sqlite3_column_text() or sqlite3_column_blob() with calls to
3350 ** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16() 3931 ** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16()
3351 ** with calls to sqlite3_column_bytes(). 3932 ** with calls to sqlite3_column_bytes().
3352 ** 3933 **
3353 ** ^The pointers returned are valid until a type conversion occurs as 3934 ** ^The pointers returned are valid until a type conversion occurs as
3354 ** described above, or until [sqlite3_step()] or [sqlite3_reset()] or 3935 ** described above, or until [sqlite3_step()] or [sqlite3_reset()] or
3355 ** [sqlite3_finalize()] is called. ^The memory space used to hold strings 3936 ** [sqlite3_finalize()] is called. ^The memory space used to hold strings
3356 ** and BLOBs is freed automatically. Do <b>not</b> pass the pointers returned 3937 ** and BLOBs is freed automatically. Do <b>not</b> pass the pointers returned
3357 ** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into 3938 ** from [sqlite3_column_blob()], [sqlite3_column_text()], etc. into
3358 ** [sqlite3_free()]. 3939 ** [sqlite3_free()].
3359 ** 3940 **
3360 ** ^(If a memory allocation error occurs during the evaluation of any 3941 ** ^(If a memory allocation error occurs during the evaluation of any
3361 ** of these routines, a default value is returned. The default value 3942 ** of these routines, a default value is returned. The default value
3362 ** is either the integer 0, the floating point number 0.0, or a NULL 3943 ** is either the integer 0, the floating point number 0.0, or a NULL
3363 ** pointer. Subsequent calls to [sqlite3_errcode()] will return 3944 ** pointer. Subsequent calls to [sqlite3_errcode()] will return
3364 ** [SQLITE_NOMEM].)^ 3945 ** [SQLITE_NOMEM].)^
3365 */ 3946 */
3366 const void *sqlite3_column_blob(sqlite3_stmt*, int iCol); 3947 const void *sqlite3_column_blob(sqlite3_stmt*, int iCol);
3367 int sqlite3_column_bytes(sqlite3_stmt*, int iCol); 3948 int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
3368 int sqlite3_column_bytes16(sqlite3_stmt*, int iCol); 3949 int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
3369 double sqlite3_column_double(sqlite3_stmt*, int iCol); 3950 double sqlite3_column_double(sqlite3_stmt*, int iCol);
3370 int sqlite3_column_int(sqlite3_stmt*, int iCol); 3951 int sqlite3_column_int(sqlite3_stmt*, int iCol);
3371 sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol); 3952 sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol);
3372 const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol); 3953 const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol);
3373 const void *sqlite3_column_text16(sqlite3_stmt*, int iCol); 3954 const void *sqlite3_column_text16(sqlite3_stmt*, int iCol);
3374 int sqlite3_column_type(sqlite3_stmt*, int iCol); 3955 int sqlite3_column_type(sqlite3_stmt*, int iCol);
3375 sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol); 3956 sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol);
3376 3957
3377 /* 3958 /*
3378 ** CAPI3REF: Destroy A Prepared Statement Object 3959 ** CAPI3REF: Destroy A Prepared Statement Object
3379 ** 3960 **
3380 ** ^The sqlite3_finalize() function is called to delete a [prepared statement]. 3961 ** ^The sqlite3_finalize() function is called to delete a [prepared statement].
3381 ** ^If the most recent evaluation of the statement encountered no errors or 3962 ** ^If the most recent evaluation of the statement encountered no errors
3382 ** or if the statement is never been evaluated, then sqlite3_finalize() returns 3963 ** or if the statement is never been evaluated, then sqlite3_finalize() returns
3383 ** SQLITE_OK. ^If the most recent evaluation of statement S failed, then 3964 ** SQLITE_OK. ^If the most recent evaluation of statement S failed, then
3384 ** sqlite3_finalize(S) returns the appropriate [error code] or 3965 ** sqlite3_finalize(S) returns the appropriate [error code] or
3385 ** [extended error code]. 3966 ** [extended error code].
3386 ** 3967 **
3387 ** ^The sqlite3_finalize(S) routine can be called at any point during 3968 ** ^The sqlite3_finalize(S) routine can be called at any point during
3388 ** the life cycle of [prepared statement] S: 3969 ** the life cycle of [prepared statement] S:
3389 ** before statement S is ever evaluated, after 3970 ** before statement S is ever evaluated, after
3390 ** one or more calls to [sqlite3_reset()], or after any call 3971 ** one or more calls to [sqlite3_reset()], or after any call
3391 ** to [sqlite3_step()] regardless of whether or not the statement has 3972 ** to [sqlite3_step()] regardless of whether or not the statement has
(...skipping 64 matching lines...) Expand 10 before | Expand all | Expand 10 after
3456 ** ^The third parameter (nArg) 4037 ** ^The third parameter (nArg)
3457 ** is the number of arguments that the SQL function or 4038 ** is the number of arguments that the SQL function or
3458 ** aggregate takes. ^If this parameter is -1, then the SQL function or 4039 ** aggregate takes. ^If this parameter is -1, then the SQL function or
3459 ** aggregate may take any number of arguments between 0 and the limit 4040 ** aggregate may take any number of arguments between 0 and the limit
3460 ** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third 4041 ** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third
3461 ** parameter is less than -1 or greater than 127 then the behavior is 4042 ** parameter is less than -1 or greater than 127 then the behavior is
3462 ** undefined. 4043 ** undefined.
3463 ** 4044 **
3464 ** ^The fourth parameter, eTextRep, specifies what 4045 ** ^The fourth parameter, eTextRep, specifies what
3465 ** [SQLITE_UTF8 | text encoding] this SQL function prefers for 4046 ** [SQLITE_UTF8 | text encoding] this SQL function prefers for
3466 ** its parameters. Every SQL function implementation must be able to work 4047 ** its parameters. The application should set this parameter to
3467 ** with UTF-8, UTF-16le, or UTF-16be. But some implementations may be 4048 ** [SQLITE_UTF16LE] if the function implementation invokes
3468 ** more efficient with one encoding than another. ^An application may 4049 ** [sqlite3_value_text16le()] on an input, or [SQLITE_UTF16BE] if the
3469 ** invoke sqlite3_create_function() or sqlite3_create_function16() multiple 4050 ** implementation invokes [sqlite3_value_text16be()] on an input, or
3470 ** times with the same function but with different values of eTextRep. 4051 ** [SQLITE_UTF16] if [sqlite3_value_text16()] is used, or [SQLITE_UTF8]
4052 ** otherwise. ^The same SQL function may be registered multiple times using
4053 ** different preferred text encodings, with different implementations for
4054 ** each encoding.
3471 ** ^When multiple implementations of the same function are available, SQLite 4055 ** ^When multiple implementations of the same function are available, SQLite
3472 ** will pick the one that involves the least amount of data conversion. 4056 ** will pick the one that involves the least amount of data conversion.
3473 ** If there is only a single implementation which does not care what text 4057 **
3474 ** encoding is used, then the fourth argument should be [SQLITE_ANY]. 4058 ** ^The fourth parameter may optionally be ORed with [SQLITE_DETERMINISTIC]
4059 ** to signal that the function will always return the same result given
4060 ** the same inputs within a single SQL statement. Most SQL functions are
4061 ** deterministic. The built-in [random()] SQL function is an example of a
4062 ** function that is not deterministic. The SQLite query planner is able to
4063 ** perform additional optimizations on deterministic functions, so use
4064 ** of the [SQLITE_DETERMINISTIC] flag is recommended where possible.
3475 ** 4065 **
3476 ** ^(The fifth parameter is an arbitrary pointer. The implementation of the 4066 ** ^(The fifth parameter is an arbitrary pointer. The implementation of the
3477 ** function can gain access to this pointer using [sqlite3_user_data()].)^ 4067 ** function can gain access to this pointer using [sqlite3_user_data()].)^
3478 ** 4068 **
3479 ** ^The sixth, seventh and eighth parameters, xFunc, xStep and xFinal, are 4069 ** ^The sixth, seventh and eighth parameters, xFunc, xStep and xFinal, are
3480 ** pointers to C-language functions that implement the SQL function or 4070 ** pointers to C-language functions that implement the SQL function or
3481 ** aggregate. ^A scalar SQL function requires an implementation of the xFunc 4071 ** aggregate. ^A scalar SQL function requires an implementation of the xFunc
3482 ** callback only; NULL pointers must be passed as the xStep and xFinal 4072 ** callback only; NULL pointers must be passed as the xStep and xFinal
3483 ** parameters. ^An aggregate SQL function requires an implementation of xStep 4073 ** parameters. ^An aggregate SQL function requires an implementation of xStep
3484 ** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing 4074 ** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing
(...skipping 65 matching lines...) Expand 10 before | Expand all | Expand 10 after
3550 /* 4140 /*
3551 ** CAPI3REF: Text Encodings 4141 ** CAPI3REF: Text Encodings
3552 ** 4142 **
3553 ** These constant define integer codes that represent the various 4143 ** These constant define integer codes that represent the various
3554 ** text encodings supported by SQLite. 4144 ** text encodings supported by SQLite.
3555 */ 4145 */
3556 #define SQLITE_UTF8 1 4146 #define SQLITE_UTF8 1
3557 #define SQLITE_UTF16LE 2 4147 #define SQLITE_UTF16LE 2
3558 #define SQLITE_UTF16BE 3 4148 #define SQLITE_UTF16BE 3
3559 #define SQLITE_UTF16 4 /* Use native byte order */ 4149 #define SQLITE_UTF16 4 /* Use native byte order */
3560 #define SQLITE_ANY 5 /* sqlite3_create_function only */ 4150 #define SQLITE_ANY 5 /* Deprecated */
3561 #define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */ 4151 #define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */
3562 4152
3563 /* 4153 /*
4154 ** CAPI3REF: Function Flags
4155 **
4156 ** These constants may be ORed together with the
4157 ** [SQLITE_UTF8 | preferred text encoding] as the fourth argument
4158 ** to [sqlite3_create_function()], [sqlite3_create_function16()], or
4159 ** [sqlite3_create_function_v2()].
4160 */
4161 #define SQLITE_DETERMINISTIC 0x800
4162
4163 /*
3564 ** CAPI3REF: Deprecated Functions 4164 ** CAPI3REF: Deprecated Functions
3565 ** DEPRECATED 4165 ** DEPRECATED
3566 ** 4166 **
3567 ** These functions are [deprecated]. In order to maintain 4167 ** These functions are [deprecated]. In order to maintain
3568 ** backwards compatibility with older code, these functions continue 4168 ** backwards compatibility with older code, these functions continue
3569 ** to be supported. However, new applications should avoid 4169 ** to be supported. However, new applications should avoid
3570 ** the use of these functions. To help encourage people to avoid 4170 ** the use of these functions. To help encourage people to avoid
3571 ** using these functions, we are not going to tell you what they do. 4171 ** using these functions, we are not going to tell you what they do.
3572 */ 4172 */
3573 #ifndef SQLITE_OMIT_DEPRECATED 4173 #ifndef SQLITE_OMIT_DEPRECATED
3574 SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*); 4174 SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*);
3575 SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*); 4175 SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*);
3576 SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*); 4176 SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*);
3577 SQLITE_DEPRECATED int sqlite3_global_recover(void); 4177 SQLITE_DEPRECATED int sqlite3_global_recover(void);
3578 SQLITE_DEPRECATED void sqlite3_thread_cleanup(void); 4178 SQLITE_DEPRECATED void sqlite3_thread_cleanup(void);
3579 SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),void *,sqlite3_int64); 4179 SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),
4180 void*,sqlite3_int64);
3580 #endif 4181 #endif
3581 4182
3582 /* 4183 /*
3583 ** CAPI3REF: Obtaining SQL Function Parameter Values 4184 ** CAPI3REF: Obtaining SQL Function Parameter Values
3584 ** 4185 **
3585 ** The C-language implementation of SQL functions and aggregates uses 4186 ** The C-language implementation of SQL functions and aggregates uses
3586 ** this set of interface routines to access the parameter values on 4187 ** this set of interface routines to access the parameter values on
3587 ** the function or aggregate. 4188 ** the function or aggregate.
3588 ** 4189 **
3589 ** The xFunc (for scalar functions) or xStep (for aggregates) parameters 4190 ** The xFunc (for scalar functions) or xStep (for aggregates) parameters
3590 ** to [sqlite3_create_function()] and [sqlite3_create_function16()] 4191 ** to [sqlite3_create_function()] and [sqlite3_create_function16()]
3591 ** define callbacks that implement the SQL functions and aggregates. 4192 ** define callbacks that implement the SQL functions and aggregates.
3592 ** The 3rd parameter to these callbacks is an array of pointers to 4193 ** The 3rd parameter to these callbacks is an array of pointers to
3593 ** [protected sqlite3_value] objects. There is one [sqlite3_value] object for 4194 ** [protected sqlite3_value] objects. There is one [sqlite3_value] object for
3594 ** each parameter to the SQL function. These routines are used to 4195 ** each parameter to the SQL function. These routines are used to
3595 ** extract values from the [sqlite3_value] objects. 4196 ** extract values from the [sqlite3_value] objects.
3596 ** 4197 **
3597 ** These routines work only with [protected sqlite3_value] objects. 4198 ** These routines work only with [protected sqlite3_value] objects.
3598 ** Any attempt to use these routines on an [unprotected sqlite3_value] 4199 ** Any attempt to use these routines on an [unprotected sqlite3_value]
3599 ** object results in undefined behavior. 4200 ** object results in undefined behavior.
3600 ** 4201 **
3601 ** ^These routines work just like the corresponding [column access functions] 4202 ** ^These routines work just like the corresponding [column access functions]
3602 ** except that these routines take a single [protected sqlite3_value] object 4203 ** except that these routines take a single [protected sqlite3_value] object
3603 ** pointer instead of a [sqlite3_stmt*] pointer and an integer column number. 4204 ** pointer instead of a [sqlite3_stmt*] pointer and an integer column number.
3604 ** 4205 **
3605 ** ^The sqlite3_value_text16() interface extracts a UTF-16 string 4206 ** ^The sqlite3_value_text16() interface extracts a UTF-16 string
3606 ** in the native byte-order of the host machine. ^The 4207 ** in the native byte-order of the host machine. ^The
3607 ** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces 4208 ** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces
3608 ** extract UTF-16 strings as big-endian and little-endian respectively. 4209 ** extract UTF-16 strings as big-endian and little-endian respectively.
3609 ** 4210 **
3610 ** ^(The sqlite3_value_numeric_type() interface attempts to apply 4211 ** ^(The sqlite3_value_numeric_type() interface attempts to apply
3611 ** numeric affinity to the value. This means that an attempt is 4212 ** numeric affinity to the value. This means that an attempt is
3612 ** made to convert the value to an integer or floating point. If 4213 ** made to convert the value to an integer or floating point. If
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after
3649 ** to the new memory. ^On second and subsequent calls to 4250 ** to the new memory. ^On second and subsequent calls to
3650 ** sqlite3_aggregate_context() for the same aggregate function instance, 4251 ** sqlite3_aggregate_context() for the same aggregate function instance,
3651 ** the same buffer is returned. Sqlite3_aggregate_context() is normally 4252 ** the same buffer is returned. Sqlite3_aggregate_context() is normally
3652 ** called once for each invocation of the xStep callback and then one 4253 ** called once for each invocation of the xStep callback and then one
3653 ** last time when the xFinal callback is invoked. ^(When no rows match 4254 ** last time when the xFinal callback is invoked. ^(When no rows match
3654 ** an aggregate query, the xStep() callback of the aggregate function 4255 ** an aggregate query, the xStep() callback of the aggregate function
3655 ** implementation is never called and xFinal() is called exactly once. 4256 ** implementation is never called and xFinal() is called exactly once.
3656 ** In those cases, sqlite3_aggregate_context() might be called for the 4257 ** In those cases, sqlite3_aggregate_context() might be called for the
3657 ** first time from within xFinal().)^ 4258 ** first time from within xFinal().)^
3658 ** 4259 **
3659 ** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer if N is 4260 ** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer
3660 ** less than or equal to zero or if a memory allocate error occurs. 4261 ** when first called if N is less than or equal to zero or if a memory
4262 ** allocate error occurs.
3661 ** 4263 **
3662 ** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is 4264 ** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is
3663 ** determined by the N parameter on first successful call. Changing the 4265 ** determined by the N parameter on first successful call. Changing the
3664 ** value of N in subsequent call to sqlite3_aggregate_context() within 4266 ** value of N in subsequent call to sqlite3_aggregate_context() within
3665 ** the same aggregate function instance will not resize the memory 4267 ** the same aggregate function instance will not resize the memory
3666 ** allocation.)^ 4268 ** allocation.)^ Within the xFinal callback, it is customary to set
4269 ** N=0 in calls to sqlite3_aggregate_context(C,N) so that no
4270 ** pointless memory allocations occur.
3667 ** 4271 **
3668 ** ^SQLite automatically frees the memory allocated by 4272 ** ^SQLite automatically frees the memory allocated by
3669 ** sqlite3_aggregate_context() when the aggregate query concludes. 4273 ** sqlite3_aggregate_context() when the aggregate query concludes.
3670 ** 4274 **
3671 ** The first parameter must be a copy of the 4275 ** The first parameter must be a copy of the
3672 ** [sqlite3_context | SQL function context] that is the first parameter 4276 ** [sqlite3_context | SQL function context] that is the first parameter
3673 ** to the xStep or xFinal callback routine that implements the aggregate 4277 ** to the xStep or xFinal callback routine that implements the aggregate
3674 ** function. 4278 ** function.
3675 ** 4279 **
3676 ** This routine must be called from the same thread in which 4280 ** This routine must be called from the same thread in which
(...skipping 22 matching lines...) Expand all
3699 ** the pointer to the [database connection] (the 1st parameter) 4303 ** the pointer to the [database connection] (the 1st parameter)
3700 ** of the [sqlite3_create_function()] 4304 ** of the [sqlite3_create_function()]
3701 ** and [sqlite3_create_function16()] routines that originally 4305 ** and [sqlite3_create_function16()] routines that originally
3702 ** registered the application defined function. 4306 ** registered the application defined function.
3703 */ 4307 */
3704 sqlite3 *sqlite3_context_db_handle(sqlite3_context*); 4308 sqlite3 *sqlite3_context_db_handle(sqlite3_context*);
3705 4309
3706 /* 4310 /*
3707 ** CAPI3REF: Function Auxiliary Data 4311 ** CAPI3REF: Function Auxiliary Data
3708 ** 4312 **
3709 ** The following two functions may be used by scalar SQL functions to 4313 ** These functions may be used by (non-aggregate) SQL functions to
3710 ** associate metadata with argument values. If the same value is passed to 4314 ** associate metadata with argument values. If the same value is passed to
3711 ** multiple invocations of the same SQL function during query execution, under 4315 ** multiple invocations of the same SQL function during query execution, under
3712 ** some circumstances the associated metadata may be preserved. This may 4316 ** some circumstances the associated metadata may be preserved. An example
3713 ** be used, for example, to add a regular-expression matching scalar 4317 ** of where this might be useful is in a regular-expression matching
3714 ** function. The compiled version of the regular expression is stored as 4318 ** function. The compiled version of the regular expression can be stored as
3715 ** metadata associated with the SQL value passed as the regular expression 4319 ** metadata associated with the pattern string.
3716 ** pattern. The compiled regular expression can be reused on multiple 4320 ** Then as long as the pattern string remains the same,
3717 ** invocations of the same function so that the original pattern string 4321 ** the compiled regular expression can be reused on multiple
3718 ** does not need to be recompiled on each invocation. 4322 ** invocations of the same function.
3719 ** 4323 **
3720 ** ^The sqlite3_get_auxdata() interface returns a pointer to the metadata 4324 ** ^The sqlite3_get_auxdata() interface returns a pointer to the metadata
3721 ** associated by the sqlite3_set_auxdata() function with the Nth argument 4325 ** associated by the sqlite3_set_auxdata() function with the Nth argument
3722 ** value to the application-defined function. ^If no metadata has been ever 4326 ** value to the application-defined function. ^If there is no metadata
3723 ** been set for the Nth argument of the function, or if the corresponding 4327 ** associated with the function argument, this sqlite3_get_auxdata() interface
3724 ** function parameter has changed since the meta-data was set, 4328 ** returns a NULL pointer.
3725 ** then sqlite3_get_auxdata() returns a NULL pointer.
3726 ** 4329 **
3727 ** ^The sqlite3_set_auxdata() interface saves the metadata 4330 ** ^The sqlite3_set_auxdata(C,N,P,X) interface saves P as metadata for the N-th
3728 ** pointed to by its 3rd parameter as the metadata for the N-th 4331 ** argument of the application-defined function. ^Subsequent
3729 ** argument of the application-defined function. Subsequent 4332 ** calls to sqlite3_get_auxdata(C,N) return P from the most recent
3730 ** calls to sqlite3_get_auxdata() might return this data, if it has 4333 ** sqlite3_set_auxdata(C,N,P,X) call if the metadata is still valid or
3731 ** not been destroyed. 4334 ** NULL if the metadata has been discarded.
3732 ** ^If it is not NULL, SQLite will invoke the destructor 4335 ** ^After each call to sqlite3_set_auxdata(C,N,P,X) where X is not NULL,
3733 ** function given by the 4th parameter to sqlite3_set_auxdata() on 4336 ** SQLite will invoke the destructor function X with parameter P exactly
3734 ** the metadata when the corresponding function parameter changes 4337 ** once, when the metadata is discarded.
3735 ** or when the SQL statement completes, whichever comes first. 4338 ** SQLite is free to discard the metadata at any time, including: <ul>
4339 ** <li> when the corresponding function parameter changes, or
4340 ** <li> when [sqlite3_reset()] or [sqlite3_finalize()] is called for the
4341 ** SQL statement, or
4342 ** <li> when sqlite3_set_auxdata() is invoked again on the same parameter, or
4343 ** <li> during the original sqlite3_set_auxdata() call when a memory
4344 ** allocation error occurs. </ul>)^
3736 ** 4345 **
3737 ** SQLite is free to call the destructor and drop metadata on any 4346 ** Note the last bullet in particular. The destructor X in
3738 ** parameter of any function at any time. ^The only guarantee is that 4347 ** sqlite3_set_auxdata(C,N,P,X) might be called immediately, before the
3739 ** the destructor will be called before the metadata is dropped. 4348 ** sqlite3_set_auxdata() interface even returns. Hence sqlite3_set_auxdata()
4349 ** should be called near the end of the function implementation and the
4350 ** function implementation should not make any use of P after
4351 ** sqlite3_set_auxdata() has been called.
3740 ** 4352 **
3741 ** ^(In practice, metadata is preserved between function calls for 4353 ** ^(In practice, metadata is preserved between function calls for
3742 ** expressions that are constant at compile time. This includes literal 4354 ** function parameters that are compile-time constants, including literal
3743 ** values and [parameters].)^ 4355 ** values and [parameters] and expressions composed from the same.)^
3744 ** 4356 **
3745 ** These routines must be called from the same thread in which 4357 ** These routines must be called from the same thread in which
3746 ** the SQL function is running. 4358 ** the SQL function is running.
3747 */ 4359 */
3748 void *sqlite3_get_auxdata(sqlite3_context*, int N); 4360 void *sqlite3_get_auxdata(sqlite3_context*, int N);
3749 void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*)); 4361 void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*));
3750 4362
3751 4363
3752 /* 4364 /*
3753 ** CAPI3REF: Constants Defining Special Destructor Behavior 4365 ** CAPI3REF: Constants Defining Special Destructor Behavior
3754 ** 4366 **
3755 ** These are special values for the destructor that is passed in as the 4367 ** These are special values for the destructor that is passed in as the
3756 ** final argument to routines like [sqlite3_result_blob()]. ^If the destructor 4368 ** final argument to routines like [sqlite3_result_blob()]. ^If the destructor
3757 ** argument is SQLITE_STATIC, it means that the content pointer is constant 4369 ** argument is SQLITE_STATIC, it means that the content pointer is constant
3758 ** and will never change. It does not need to be destroyed. ^The 4370 ** and will never change. It does not need to be destroyed. ^The
3759 ** SQLITE_TRANSIENT value means that the content will likely change in 4371 ** SQLITE_TRANSIENT value means that the content will likely change in
3760 ** the near future and that SQLite should make its own private copy of 4372 ** the near future and that SQLite should make its own private copy of
3761 ** the content before returning. 4373 ** the content before returning.
3762 ** 4374 **
3763 ** The typedef is necessary to work around problems in certain 4375 ** The typedef is necessary to work around problems in certain
3764 ** C++ compilers. See ticket #2191. 4376 ** C++ compilers.
3765 */ 4377 */
3766 typedef void (*sqlite3_destructor_type)(void*); 4378 typedef void (*sqlite3_destructor_type)(void*);
3767 #define SQLITE_STATIC ((sqlite3_destructor_type)0) 4379 #define SQLITE_STATIC ((sqlite3_destructor_type)0)
3768 #define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1) 4380 #define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1)
3769 4381
3770 /* 4382 /*
3771 ** CAPI3REF: Setting The Result Of An SQL Function 4383 ** CAPI3REF: Setting The Result Of An SQL Function
3772 ** 4384 **
3773 ** These routines are used by the xFunc or xFinal callbacks that 4385 ** These routines are used by the xFunc or xFinal callbacks that
3774 ** implement SQL functions and aggregates. See 4386 ** implement SQL functions and aggregates. See
(...skipping 32 matching lines...) Expand 10 before | Expand all | Expand 10 after
3807 ** bytes (not characters) from the 2nd parameter as the error message. 4419 ** bytes (not characters) from the 2nd parameter as the error message.
3808 ** ^The sqlite3_result_error() and sqlite3_result_error16() 4420 ** ^The sqlite3_result_error() and sqlite3_result_error16()
3809 ** routines make a private copy of the error message text before 4421 ** routines make a private copy of the error message text before
3810 ** they return. Hence, the calling function can deallocate or 4422 ** they return. Hence, the calling function can deallocate or
3811 ** modify the text after they return without harm. 4423 ** modify the text after they return without harm.
3812 ** ^The sqlite3_result_error_code() function changes the error code 4424 ** ^The sqlite3_result_error_code() function changes the error code
3813 ** returned by SQLite as a result of an error in a function. ^By default, 4425 ** returned by SQLite as a result of an error in a function. ^By default,
3814 ** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error() 4426 ** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error()
3815 ** or sqlite3_result_error16() resets the error code to SQLITE_ERROR. 4427 ** or sqlite3_result_error16() resets the error code to SQLITE_ERROR.
3816 ** 4428 **
3817 ** ^The sqlite3_result_toobig() interface causes SQLite to throw an error 4429 ** ^The sqlite3_result_error_toobig() interface causes SQLite to throw an
3818 ** indicating that a string or BLOB is too long to represent. 4430 ** error indicating that a string or BLOB is too long to represent.
3819 ** 4431 **
3820 ** ^The sqlite3_result_nomem() interface causes SQLite to throw an error 4432 ** ^The sqlite3_result_error_nomem() interface causes SQLite to throw an
3821 ** indicating that a memory allocation failed. 4433 ** error indicating that a memory allocation failed.
3822 ** 4434 **
3823 ** ^The sqlite3_result_int() interface sets the return value 4435 ** ^The sqlite3_result_int() interface sets the return value
3824 ** of the application-defined function to be the 32-bit signed integer 4436 ** of the application-defined function to be the 32-bit signed integer
3825 ** value given in the 2nd argument. 4437 ** value given in the 2nd argument.
3826 ** ^The sqlite3_result_int64() interface sets the return value 4438 ** ^The sqlite3_result_int64() interface sets the return value
3827 ** of the application-defined function to be the 64-bit signed integer 4439 ** of the application-defined function to be the 64-bit signed integer
3828 ** value given in the 2nd argument. 4440 ** value given in the 2nd argument.
3829 ** 4441 **
3830 ** ^The sqlite3_result_null() interface sets the return value 4442 ** ^The sqlite3_result_null() interface sets the return value
3831 ** of the application-defined function to be NULL. 4443 ** of the application-defined function to be NULL.
3832 ** 4444 **
3833 ** ^The sqlite3_result_text(), sqlite3_result_text16(), 4445 ** ^The sqlite3_result_text(), sqlite3_result_text16(),
3834 ** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces 4446 ** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces
3835 ** set the return value of the application-defined function to be 4447 ** set the return value of the application-defined function to be
3836 ** a text string which is represented as UTF-8, UTF-16 native byte order, 4448 ** a text string which is represented as UTF-8, UTF-16 native byte order,
3837 ** UTF-16 little endian, or UTF-16 big endian, respectively. 4449 ** UTF-16 little endian, or UTF-16 big endian, respectively.
4450 ** ^The sqlite3_result_text64() interface sets the return value of an
4451 ** application-defined function to be a text string in an encoding
4452 ** specified by the fifth (and last) parameter, which must be one
4453 ** of [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE].
3838 ** ^SQLite takes the text result from the application from 4454 ** ^SQLite takes the text result from the application from
3839 ** the 2nd parameter of the sqlite3_result_text* interfaces. 4455 ** the 2nd parameter of the sqlite3_result_text* interfaces.
3840 ** ^If the 3rd parameter to the sqlite3_result_text* interfaces 4456 ** ^If the 3rd parameter to the sqlite3_result_text* interfaces
3841 ** is negative, then SQLite takes result text from the 2nd parameter 4457 ** is negative, then SQLite takes result text from the 2nd parameter
3842 ** through the first zero character. 4458 ** through the first zero character.
3843 ** ^If the 3rd parameter to the sqlite3_result_text* interfaces 4459 ** ^If the 3rd parameter to the sqlite3_result_text* interfaces
3844 ** is non-negative, then as many bytes (not characters) of the text 4460 ** is non-negative, then as many bytes (not characters) of the text
3845 ** pointed to by the 2nd parameter are taken as the application-defined 4461 ** pointed to by the 2nd parameter are taken as the application-defined
3846 ** function result. 4462 ** function result. If the 3rd parameter is non-negative, then it
4463 ** must be the byte offset into the string where the NUL terminator would
4464 ** appear if the string where NUL terminated. If any NUL characters occur
4465 ** in the string at a byte offset that is less than the value of the 3rd
4466 ** parameter, then the resulting string will contain embedded NULs and the
4467 ** result of expressions operating on strings with embedded NULs is undefined.
3847 ** ^If the 4th parameter to the sqlite3_result_text* interfaces 4468 ** ^If the 4th parameter to the sqlite3_result_text* interfaces
3848 ** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that 4469 ** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that
3849 ** function as the destructor on the text or BLOB result when it has 4470 ** function as the destructor on the text or BLOB result when it has
3850 ** finished using that result. 4471 ** finished using that result.
3851 ** ^If the 4th parameter to the sqlite3_result_text* interfaces or to 4472 ** ^If the 4th parameter to the sqlite3_result_text* interfaces or to
3852 ** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite 4473 ** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite
3853 ** assumes that the text or BLOB result is in constant space and does not 4474 ** assumes that the text or BLOB result is in constant space and does not
3854 ** copy the content of the parameter nor call a destructor on the content 4475 ** copy the content of the parameter nor call a destructor on the content
3855 ** when it has finished using that result. 4476 ** when it has finished using that result.
3856 ** ^If the 4th parameter to the sqlite3_result_text* interfaces 4477 ** ^If the 4th parameter to the sqlite3_result_text* interfaces
3857 ** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT 4478 ** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT
3858 ** then SQLite makes a copy of the result into space obtained from 4479 ** then SQLite makes a copy of the result into space obtained from
3859 ** from [sqlite3_malloc()] before it returns. 4480 ** from [sqlite3_malloc()] before it returns.
3860 ** 4481 **
3861 ** ^The sqlite3_result_value() interface sets the result of 4482 ** ^The sqlite3_result_value() interface sets the result of
3862 ** the application-defined function to be a copy the 4483 ** the application-defined function to be a copy the
3863 ** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The 4484 ** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The
3864 ** sqlite3_result_value() interface makes a copy of the [sqlite3_value] 4485 ** sqlite3_result_value() interface makes a copy of the [sqlite3_value]
3865 ** so that the [sqlite3_value] specified in the parameter may change or 4486 ** so that the [sqlite3_value] specified in the parameter may change or
3866 ** be deallocated after sqlite3_result_value() returns without harm. 4487 ** be deallocated after sqlite3_result_value() returns without harm.
3867 ** ^A [protected sqlite3_value] object may always be used where an 4488 ** ^A [protected sqlite3_value] object may always be used where an
3868 ** [unprotected sqlite3_value] object is required, so either 4489 ** [unprotected sqlite3_value] object is required, so either
3869 ** kind of [sqlite3_value] object can be used with this interface. 4490 ** kind of [sqlite3_value] object can be used with this interface.
3870 ** 4491 **
3871 ** If these routines are called from within the different thread 4492 ** If these routines are called from within the different thread
3872 ** than the one containing the application-defined function that received 4493 ** than the one containing the application-defined function that received
3873 ** the [sqlite3_context] pointer, the results are undefined. 4494 ** the [sqlite3_context] pointer, the results are undefined.
3874 */ 4495 */
3875 void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*)); 4496 void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*));
4497 void sqlite3_result_blob64(sqlite3_context*,const void*,sqlite3_uint64,void(*)(v oid*));
3876 void sqlite3_result_double(sqlite3_context*, double); 4498 void sqlite3_result_double(sqlite3_context*, double);
3877 void sqlite3_result_error(sqlite3_context*, const char*, int); 4499 void sqlite3_result_error(sqlite3_context*, const char*, int);
3878 void sqlite3_result_error16(sqlite3_context*, const void*, int); 4500 void sqlite3_result_error16(sqlite3_context*, const void*, int);
3879 void sqlite3_result_error_toobig(sqlite3_context*); 4501 void sqlite3_result_error_toobig(sqlite3_context*);
3880 void sqlite3_result_error_nomem(sqlite3_context*); 4502 void sqlite3_result_error_nomem(sqlite3_context*);
3881 void sqlite3_result_error_code(sqlite3_context*, int); 4503 void sqlite3_result_error_code(sqlite3_context*, int);
3882 void sqlite3_result_int(sqlite3_context*, int); 4504 void sqlite3_result_int(sqlite3_context*, int);
3883 void sqlite3_result_int64(sqlite3_context*, sqlite3_int64); 4505 void sqlite3_result_int64(sqlite3_context*, sqlite3_int64);
3884 void sqlite3_result_null(sqlite3_context*); 4506 void sqlite3_result_null(sqlite3_context*);
3885 void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*)); 4507 void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*));
4508 void sqlite3_result_text64(sqlite3_context*, const char*,sqlite3_uint64,
4509 void(*)(void*), unsigned char encoding);
3886 void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*)); 4510 void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*));
3887 void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*)); 4511 void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*));
3888 void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*)); 4512 void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*));
3889 void sqlite3_result_value(sqlite3_context*, sqlite3_value*); 4513 void sqlite3_result_value(sqlite3_context*, sqlite3_value*);
3890 void sqlite3_result_zeroblob(sqlite3_context*, int n); 4514 void sqlite3_result_zeroblob(sqlite3_context*, int n);
3891 4515
3892 /* 4516 /*
3893 ** CAPI3REF: Define New Collating Sequences 4517 ** CAPI3REF: Define New Collating Sequences
3894 ** 4518 **
3895 ** ^These functions add, remove, or modify a [collation] associated 4519 ** ^These functions add, remove, or modify a [collation] associated
(...skipping 137 matching lines...) Expand 10 before | Expand all | Expand 10 after
4033 ** Specify the key for an encrypted database. This routine should be 4657 ** Specify the key for an encrypted database. This routine should be
4034 ** called right after sqlite3_open(). 4658 ** called right after sqlite3_open().
4035 ** 4659 **
4036 ** The code to implement this API is not available in the public release 4660 ** The code to implement this API is not available in the public release
4037 ** of SQLite. 4661 ** of SQLite.
4038 */ 4662 */
4039 int sqlite3_key( 4663 int sqlite3_key(
4040 sqlite3 *db, /* Database to be rekeyed */ 4664 sqlite3 *db, /* Database to be rekeyed */
4041 const void *pKey, int nKey /* The key */ 4665 const void *pKey, int nKey /* The key */
4042 ); 4666 );
4667 int sqlite3_key_v2(
4668 sqlite3 *db, /* Database to be rekeyed */
4669 const char *zDbName, /* Name of the database */
4670 const void *pKey, int nKey /* The key */
4671 );
4043 4672
4044 /* 4673 /*
4045 ** Change the key on an open database. If the current database is not 4674 ** Change the key on an open database. If the current database is not
4046 ** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the 4675 ** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the
4047 ** database is decrypted. 4676 ** database is decrypted.
4048 ** 4677 **
4049 ** The code to implement this API is not available in the public release 4678 ** The code to implement this API is not available in the public release
4050 ** of SQLite. 4679 ** of SQLite.
4051 */ 4680 */
4052 int sqlite3_rekey( 4681 int sqlite3_rekey(
4053 sqlite3 *db, /* Database to be rekeyed */ 4682 sqlite3 *db, /* Database to be rekeyed */
4054 const void *pKey, int nKey /* The new key */ 4683 const void *pKey, int nKey /* The new key */
4055 ); 4684 );
4685 int sqlite3_rekey_v2(
4686 sqlite3 *db, /* Database to be rekeyed */
4687 const char *zDbName, /* Name of the database */
4688 const void *pKey, int nKey /* The new key */
4689 );
4056 4690
4057 /* 4691 /*
4058 ** Specify the activation key for a SEE database. Unless 4692 ** Specify the activation key for a SEE database. Unless
4059 ** activated, none of the SEE routines will work. 4693 ** activated, none of the SEE routines will work.
4060 */ 4694 */
4061 void sqlite3_activate_see( 4695 void sqlite3_activate_see(
4062 const char *zPassPhrase /* Activation phrase */ 4696 const char *zPassPhrase /* Activation phrase */
4063 ); 4697 );
4064 #endif 4698 #endif
4065 4699
(...skipping 29 matching lines...) Expand all
4095 /* 4729 /*
4096 ** CAPI3REF: Name Of The Folder Holding Temporary Files 4730 ** CAPI3REF: Name Of The Folder Holding Temporary Files
4097 ** 4731 **
4098 ** ^(If this global variable is made to point to a string which is 4732 ** ^(If this global variable is made to point to a string which is
4099 ** the name of a folder (a.k.a. directory), then all temporary files 4733 ** the name of a folder (a.k.a. directory), then all temporary files
4100 ** created by SQLite when using a built-in [sqlite3_vfs | VFS] 4734 ** created by SQLite when using a built-in [sqlite3_vfs | VFS]
4101 ** will be placed in that directory.)^ ^If this variable 4735 ** will be placed in that directory.)^ ^If this variable
4102 ** is a NULL pointer, then SQLite performs a search for an appropriate 4736 ** is a NULL pointer, then SQLite performs a search for an appropriate
4103 ** temporary file directory. 4737 ** temporary file directory.
4104 ** 4738 **
4739 ** Applications are strongly discouraged from using this global variable.
4740 ** It is required to set a temporary folder on Windows Runtime (WinRT).
4741 ** But for all other platforms, it is highly recommended that applications
4742 ** neither read nor write this variable. This global variable is a relic
4743 ** that exists for backwards compatibility of legacy applications and should
4744 ** be avoided in new projects.
4745 **
4105 ** It is not safe to read or modify this variable in more than one 4746 ** It is not safe to read or modify this variable in more than one
4106 ** thread at a time. It is not safe to read or modify this variable 4747 ** thread at a time. It is not safe to read or modify this variable
4107 ** if a [database connection] is being used at the same time in a separate 4748 ** if a [database connection] is being used at the same time in a separate
4108 ** thread. 4749 ** thread.
4109 ** It is intended that this variable be set once 4750 ** It is intended that this variable be set once
4110 ** as part of process initialization and before any SQLite interface 4751 ** as part of process initialization and before any SQLite interface
4111 ** routines have been called and that this variable remain unchanged 4752 ** routines have been called and that this variable remain unchanged
4112 ** thereafter. 4753 ** thereafter.
4113 ** 4754 **
4114 ** ^The [temp_store_directory pragma] may modify this variable and cause 4755 ** ^The [temp_store_directory pragma] may modify this variable and cause
4115 ** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore, 4756 ** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
4116 ** the [temp_store_directory pragma] always assumes that any string 4757 ** the [temp_store_directory pragma] always assumes that any string
4117 ** that this variable points to is held in memory obtained from 4758 ** that this variable points to is held in memory obtained from
4118 ** [sqlite3_malloc] and the pragma may attempt to free that memory 4759 ** [sqlite3_malloc] and the pragma may attempt to free that memory
4119 ** using [sqlite3_free]. 4760 ** using [sqlite3_free].
4120 ** Hence, if this variable is modified directly, either it should be 4761 ** Hence, if this variable is modified directly, either it should be
4121 ** made NULL or made to point to memory obtained from [sqlite3_malloc] 4762 ** made NULL or made to point to memory obtained from [sqlite3_malloc]
4122 ** or else the use of the [temp_store_directory pragma] should be avoided. 4763 ** or else the use of the [temp_store_directory pragma] should be avoided.
4764 ** Except when requested by the [temp_store_directory pragma], SQLite
4765 ** does not free the memory that sqlite3_temp_directory points to. If
4766 ** the application wants that memory to be freed, it must do
4767 ** so itself, taking care to only do so after all [database connection]
4768 ** objects have been destroyed.
4769 **
4770 ** <b>Note to Windows Runtime users:</b> The temporary directory must be set
4771 ** prior to calling [sqlite3_open] or [sqlite3_open_v2]. Otherwise, various
4772 ** features that require the use of temporary files may fail. Here is an
4773 ** example of how to do this using C++ with the Windows Runtime:
4774 **
4775 ** <blockquote><pre>
4776 ** LPCWSTR zPath = Windows::Storage::ApplicationData::Current->
4777 ** &nbsp; TemporaryFolder->Path->Data();
4778 ** char zPathBuf&#91;MAX_PATH + 1&#93;;
4779 ** memset(zPathBuf, 0, sizeof(zPathBuf));
4780 ** WideCharToMultiByte(CP_UTF8, 0, zPath, -1, zPathBuf, sizeof(zPathBuf),
4781 ** &nbsp; NULL, NULL);
4782 ** sqlite3_temp_directory = sqlite3_mprintf("%s", zPathBuf);
4783 ** </pre></blockquote>
4123 */ 4784 */
4124 SQLITE_EXTERN char *sqlite3_temp_directory; 4785 SQLITE_EXTERN char *sqlite3_temp_directory;
4125 4786
4126 /* 4787 /*
4788 ** CAPI3REF: Name Of The Folder Holding Database Files
4789 **
4790 ** ^(If this global variable is made to point to a string which is
4791 ** the name of a folder (a.k.a. directory), then all database files
4792 ** specified with a relative pathname and created or accessed by
4793 ** SQLite when using a built-in windows [sqlite3_vfs | VFS] will be assumed
4794 ** to be relative to that directory.)^ ^If this variable is a NULL
4795 ** pointer, then SQLite assumes that all database files specified
4796 ** with a relative pathname are relative to the current directory
4797 ** for the process. Only the windows VFS makes use of this global
4798 ** variable; it is ignored by the unix VFS.
4799 **
4800 ** Changing the value of this variable while a database connection is
4801 ** open can result in a corrupt database.
4802 **
4803 ** It is not safe to read or modify this variable in more than one
4804 ** thread at a time. It is not safe to read or modify this variable
4805 ** if a [database connection] is being used at the same time in a separate
4806 ** thread.
4807 ** It is intended that this variable be set once
4808 ** as part of process initialization and before any SQLite interface
4809 ** routines have been called and that this variable remain unchanged
4810 ** thereafter.
4811 **
4812 ** ^The [data_store_directory pragma] may modify this variable and cause
4813 ** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
4814 ** the [data_store_directory pragma] always assumes that any string
4815 ** that this variable points to is held in memory obtained from
4816 ** [sqlite3_malloc] and the pragma may attempt to free that memory
4817 ** using [sqlite3_free].
4818 ** Hence, if this variable is modified directly, either it should be
4819 ** made NULL or made to point to memory obtained from [sqlite3_malloc]
4820 ** or else the use of the [data_store_directory pragma] should be avoided.
4821 */
4822 SQLITE_EXTERN char *sqlite3_data_directory;
4823
4824 /*
4127 ** CAPI3REF: Test For Auto-Commit Mode 4825 ** CAPI3REF: Test For Auto-Commit Mode
4128 ** KEYWORDS: {autocommit mode} 4826 ** KEYWORDS: {autocommit mode}
4129 ** 4827 **
4130 ** ^The sqlite3_get_autocommit() interface returns non-zero or 4828 ** ^The sqlite3_get_autocommit() interface returns non-zero or
4131 ** zero if the given database connection is or is not in autocommit mode, 4829 ** zero if the given database connection is or is not in autocommit mode,
4132 ** respectively. ^Autocommit mode is on by default. 4830 ** respectively. ^Autocommit mode is on by default.
4133 ** ^Autocommit mode is disabled by a [BEGIN] statement. 4831 ** ^Autocommit mode is disabled by a [BEGIN] statement.
4134 ** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK]. 4832 ** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK].
4135 ** 4833 **
4136 ** If certain kinds of errors occur on a statement within a multi-statement 4834 ** If certain kinds of errors occur on a statement within a multi-statement
(...skipping 15 matching lines...) Expand all
4152 ** ^The sqlite3_db_handle interface returns the [database connection] handle 4850 ** ^The sqlite3_db_handle interface returns the [database connection] handle
4153 ** to which a [prepared statement] belongs. ^The [database connection] 4851 ** to which a [prepared statement] belongs. ^The [database connection]
4154 ** returned by sqlite3_db_handle is the same [database connection] 4852 ** returned by sqlite3_db_handle is the same [database connection]
4155 ** that was the first argument 4853 ** that was the first argument
4156 ** to the [sqlite3_prepare_v2()] call (or its variants) that was used to 4854 ** to the [sqlite3_prepare_v2()] call (or its variants) that was used to
4157 ** create the statement in the first place. 4855 ** create the statement in the first place.
4158 */ 4856 */
4159 sqlite3 *sqlite3_db_handle(sqlite3_stmt*); 4857 sqlite3 *sqlite3_db_handle(sqlite3_stmt*);
4160 4858
4161 /* 4859 /*
4860 ** CAPI3REF: Return The Filename For A Database Connection
4861 **
4862 ** ^The sqlite3_db_filename(D,N) interface returns a pointer to a filename
4863 ** associated with database N of connection D. ^The main database file
4864 ** has the name "main". If there is no attached database N on the database
4865 ** connection D, or if database N is a temporary or in-memory database, then
4866 ** a NULL pointer is returned.
4867 **
4868 ** ^The filename returned by this function is the output of the
4869 ** xFullPathname method of the [VFS]. ^In other words, the filename
4870 ** will be an absolute pathname, even if the filename used
4871 ** to open the database originally was a URI or relative pathname.
4872 */
4873 const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName);
4874
4875 /*
4876 ** CAPI3REF: Determine if a database is read-only
4877 **
4878 ** ^The sqlite3_db_readonly(D,N) interface returns 1 if the database N
4879 ** of connection D is read-only, 0 if it is read/write, or -1 if N is not
4880 ** the name of a database on connection D.
4881 */
4882 int sqlite3_db_readonly(sqlite3 *db, const char *zDbName);
4883
4884 /*
4162 ** CAPI3REF: Find the next prepared statement 4885 ** CAPI3REF: Find the next prepared statement
4163 ** 4886 **
4164 ** ^This interface returns a pointer to the next [prepared statement] after 4887 ** ^This interface returns a pointer to the next [prepared statement] after
4165 ** pStmt associated with the [database connection] pDb. ^If pStmt is NULL 4888 ** pStmt associated with the [database connection] pDb. ^If pStmt is NULL
4166 ** then this interface returns a pointer to the first prepared statement 4889 ** then this interface returns a pointer to the first prepared statement
4167 ** associated with the database connection pDb. ^If no prepared statement 4890 ** associated with the database connection pDb. ^If no prepared statement
4168 ** satisfies the conditions of this routine, it returns NULL. 4891 ** satisfies the conditions of this routine, it returns NULL.
4169 ** 4892 **
4170 ** The [database connection] pointer D in a call to 4893 ** The [database connection] pointer D in a call to
4171 ** [sqlite3_next_stmt(D,S)] must refer to an open database 4894 ** [sqlite3_next_stmt(D,S)] must refer to an open database
(...skipping 14 matching lines...) Expand all
4186 ** for the same database connection is overridden. 4909 ** for the same database connection is overridden.
4187 ** ^The pArg argument is passed through to the callback. 4910 ** ^The pArg argument is passed through to the callback.
4188 ** ^If the callback on a commit hook function returns non-zero, 4911 ** ^If the callback on a commit hook function returns non-zero,
4189 ** then the commit is converted into a rollback. 4912 ** then the commit is converted into a rollback.
4190 ** 4913 **
4191 ** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions 4914 ** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions
4192 ** return the P argument from the previous call of the same function 4915 ** return the P argument from the previous call of the same function
4193 ** on the same [database connection] D, or NULL for 4916 ** on the same [database connection] D, or NULL for
4194 ** the first call for each function on D. 4917 ** the first call for each function on D.
4195 ** 4918 **
4919 ** The commit and rollback hook callbacks are not reentrant.
4196 ** The callback implementation must not do anything that will modify 4920 ** The callback implementation must not do anything that will modify
4197 ** the database connection that invoked the callback. Any actions 4921 ** the database connection that invoked the callback. Any actions
4198 ** to modify the database connection must be deferred until after the 4922 ** to modify the database connection must be deferred until after the
4199 ** completion of the [sqlite3_step()] call that triggered the commit 4923 ** completion of the [sqlite3_step()] call that triggered the commit
4200 ** or rollback hook in the first place. 4924 ** or rollback hook in the first place.
4201 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their 4925 ** Note that running any other SQL statements, including SELECT statements,
4202 ** database connections for the meaning of "modify" in this paragraph. 4926 ** or merely calling [sqlite3_prepare_v2()] and [sqlite3_step()] will modify
4927 ** the database connections for the meaning of "modify" in this paragraph.
4203 ** 4928 **
4204 ** ^Registering a NULL function disables the callback. 4929 ** ^Registering a NULL function disables the callback.
4205 ** 4930 **
4206 ** ^When the commit hook callback routine returns zero, the [COMMIT] 4931 ** ^When the commit hook callback routine returns zero, the [COMMIT]
4207 ** operation is allowed to continue normally. ^If the commit hook 4932 ** operation is allowed to continue normally. ^If the commit hook
4208 ** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK]. 4933 ** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK].
4209 ** ^The rollback hook is invoked on a rollback that results from a commit 4934 ** ^The rollback hook is invoked on a rollback that results from a commit
4210 ** hook returning non-zero, just as it would be with any other rollback. 4935 ** hook returning non-zero, just as it would be with any other rollback.
4211 ** 4936 **
4212 ** ^For the purposes of this API, a transaction is said to have been 4937 ** ^For the purposes of this API, a transaction is said to have been
4213 ** rolled back if an explicit "ROLLBACK" statement is executed, or 4938 ** rolled back if an explicit "ROLLBACK" statement is executed, or
4214 ** an error or constraint causes an implicit rollback to occur. 4939 ** an error or constraint causes an implicit rollback to occur.
4215 ** ^The rollback callback is not invoked if a transaction is 4940 ** ^The rollback callback is not invoked if a transaction is
4216 ** automatically rolled back because the database connection is closed. 4941 ** automatically rolled back because the database connection is closed.
4217 ** 4942 **
4218 ** See also the [sqlite3_update_hook()] interface. 4943 ** See also the [sqlite3_update_hook()] interface.
4219 */ 4944 */
4220 void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*); 4945 void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
4221 void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*); 4946 void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);
4222 4947
4223 /* 4948 /*
4224 ** CAPI3REF: Data Change Notification Callbacks 4949 ** CAPI3REF: Data Change Notification Callbacks
4225 ** 4950 **
4226 ** ^The sqlite3_update_hook() interface registers a callback function 4951 ** ^The sqlite3_update_hook() interface registers a callback function
4227 ** with the [database connection] identified by the first argument 4952 ** with the [database connection] identified by the first argument
4228 ** to be invoked whenever a row is updated, inserted or deleted. 4953 ** to be invoked whenever a row is updated, inserted or deleted in
4954 ** a rowid table.
4229 ** ^Any callback set by a previous call to this function 4955 ** ^Any callback set by a previous call to this function
4230 ** for the same database connection is overridden. 4956 ** for the same database connection is overridden.
4231 ** 4957 **
4232 ** ^The second argument is a pointer to the function to invoke when a 4958 ** ^The second argument is a pointer to the function to invoke when a
4233 ** row is updated, inserted or deleted. 4959 ** row is updated, inserted or deleted in a rowid table.
4234 ** ^The first argument to the callback is a copy of the third argument 4960 ** ^The first argument to the callback is a copy of the third argument
4235 ** to sqlite3_update_hook(). 4961 ** to sqlite3_update_hook().
4236 ** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE], 4962 ** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE],
4237 ** or [SQLITE_UPDATE], depending on the operation that caused the callback 4963 ** or [SQLITE_UPDATE], depending on the operation that caused the callback
4238 ** to be invoked. 4964 ** to be invoked.
4239 ** ^The third and fourth arguments to the callback contain pointers to the 4965 ** ^The third and fourth arguments to the callback contain pointers to the
4240 ** database and table name containing the affected row. 4966 ** database and table name containing the affected row.
4241 ** ^The final callback parameter is the [rowid] of the row. 4967 ** ^The final callback parameter is the [rowid] of the row.
4242 ** ^In the case of an update, this is the [rowid] after the update takes place. 4968 ** ^In the case of an update, this is the [rowid] after the update takes place.
4243 ** 4969 **
4244 ** ^(The update hook is not invoked when internal system tables are 4970 ** ^(The update hook is not invoked when internal system tables are
4245 ** modified (i.e. sqlite_master and sqlite_sequence).)^ 4971 ** modified (i.e. sqlite_master and sqlite_sequence).)^
4972 ** ^The update hook is not invoked when [WITHOUT ROWID] tables are modified.
4246 ** 4973 **
4247 ** ^In the current implementation, the update hook 4974 ** ^In the current implementation, the update hook
4248 ** is not invoked when duplication rows are deleted because of an 4975 ** is not invoked when duplication rows are deleted because of an
4249 ** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook 4976 ** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook
4250 ** invoked when rows are deleted using the [truncate optimization]. 4977 ** invoked when rows are deleted using the [truncate optimization].
4251 ** The exceptions defined in this paragraph might change in a future 4978 ** The exceptions defined in this paragraph might change in a future
4252 ** release of SQLite. 4979 ** release of SQLite.
4253 ** 4980 **
4254 ** The update hook implementation must not do anything that will modify 4981 ** The update hook implementation must not do anything that will modify
4255 ** the database connection that invoked the update hook. Any actions 4982 ** the database connection that invoked the update hook. Any actions
(...skipping 11 matching lines...) Expand all
4267 ** interfaces. 4994 ** interfaces.
4268 */ 4995 */
4269 void *sqlite3_update_hook( 4996 void *sqlite3_update_hook(
4270 sqlite3*, 4997 sqlite3*,
4271 void(*)(void *,int ,char const *,char const *,sqlite3_int64), 4998 void(*)(void *,int ,char const *,char const *,sqlite3_int64),
4272 void* 4999 void*
4273 ); 5000 );
4274 5001
4275 /* 5002 /*
4276 ** CAPI3REF: Enable Or Disable Shared Pager Cache 5003 ** CAPI3REF: Enable Or Disable Shared Pager Cache
4277 ** KEYWORDS: {shared cache}
4278 ** 5004 **
4279 ** ^(This routine enables or disables the sharing of the database cache 5005 ** ^(This routine enables or disables the sharing of the database cache
4280 ** and schema data structures between [database connection | connections] 5006 ** and schema data structures between [database connection | connections]
4281 ** to the same database. Sharing is enabled if the argument is true 5007 ** to the same database. Sharing is enabled if the argument is true
4282 ** and disabled if the argument is false.)^ 5008 ** and disabled if the argument is false.)^
4283 ** 5009 **
4284 ** ^Cache sharing is enabled and disabled for an entire process. 5010 ** ^Cache sharing is enabled and disabled for an entire process.
4285 ** This is a change as of SQLite version 3.5.0. In prior versions of SQLite, 5011 ** This is a change as of SQLite version 3.5.0. In prior versions of SQLite,
4286 ** sharing was enabled or disabled for each thread separately. 5012 ** sharing was enabled or disabled for each thread separately.
4287 ** 5013 **
4288 ** ^(The cache sharing mode set by this interface effects all subsequent 5014 ** ^(The cache sharing mode set by this interface effects all subsequent
4289 ** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()]. 5015 ** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()].
4290 ** Existing database connections continue use the sharing mode 5016 ** Existing database connections continue use the sharing mode
4291 ** that was in effect at the time they were opened.)^ 5017 ** that was in effect at the time they were opened.)^
4292 ** 5018 **
4293 ** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled 5019 ** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled
4294 ** successfully. An [error code] is returned otherwise.)^ 5020 ** successfully. An [error code] is returned otherwise.)^
4295 ** 5021 **
4296 ** ^Shared cache is disabled by default. But this might change in 5022 ** ^Shared cache is disabled by default. But this might change in
4297 ** future releases of SQLite. Applications that care about shared 5023 ** future releases of SQLite. Applications that care about shared
4298 ** cache setting should set it explicitly. 5024 ** cache setting should set it explicitly.
4299 ** 5025 **
5026 ** This interface is threadsafe on processors where writing a
5027 ** 32-bit integer is atomic.
5028 **
4300 ** See Also: [SQLite Shared-Cache Mode] 5029 ** See Also: [SQLite Shared-Cache Mode]
4301 */ 5030 */
4302 int sqlite3_enable_shared_cache(int); 5031 int sqlite3_enable_shared_cache(int);
4303 5032
4304 /* 5033 /*
4305 ** CAPI3REF: Attempt To Free Heap Memory 5034 ** CAPI3REF: Attempt To Free Heap Memory
4306 ** 5035 **
4307 ** ^The sqlite3_release_memory() interface attempts to free N bytes 5036 ** ^The sqlite3_release_memory() interface attempts to free N bytes
4308 ** of heap memory by deallocating non-essential memory allocations 5037 ** of heap memory by deallocating non-essential memory allocations
4309 ** held by the database library. Memory used to cache database 5038 ** held by the database library. Memory used to cache database
4310 ** pages to improve performance is an example of non-essential memory. 5039 ** pages to improve performance is an example of non-essential memory.
4311 ** ^sqlite3_release_memory() returns the number of bytes actually freed, 5040 ** ^sqlite3_release_memory() returns the number of bytes actually freed,
4312 ** which might be more or less than the amount requested. 5041 ** which might be more or less than the amount requested.
4313 ** ^The sqlite3_release_memory() routine is a no-op returning zero 5042 ** ^The sqlite3_release_memory() routine is a no-op returning zero
4314 ** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT]. 5043 ** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT].
5044 **
5045 ** See also: [sqlite3_db_release_memory()]
4315 */ 5046 */
4316 int sqlite3_release_memory(int); 5047 int sqlite3_release_memory(int);
4317 5048
4318 /* 5049 /*
5050 ** CAPI3REF: Free Memory Used By A Database Connection
5051 **
5052 ** ^The sqlite3_db_release_memory(D) interface attempts to free as much heap
5053 ** memory as possible from database connection D. Unlike the
5054 ** [sqlite3_release_memory()] interface, this interface is in effect even
5055 ** when the [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is
5056 ** omitted.
5057 **
5058 ** See also: [sqlite3_release_memory()]
5059 */
5060 int sqlite3_db_release_memory(sqlite3*);
5061
5062 /*
4319 ** CAPI3REF: Impose A Limit On Heap Size 5063 ** CAPI3REF: Impose A Limit On Heap Size
4320 ** 5064 **
4321 ** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the 5065 ** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the
4322 ** soft limit on the amount of heap memory that may be allocated by SQLite. 5066 ** soft limit on the amount of heap memory that may be allocated by SQLite.
4323 ** ^SQLite strives to keep heap memory utilization below the soft heap 5067 ** ^SQLite strives to keep heap memory utilization below the soft heap
4324 ** limit by reducing the number of pages held in the page cache 5068 ** limit by reducing the number of pages held in the page cache
4325 ** as heap memory usages approaches the limit. 5069 ** as heap memory usages approaches the limit.
4326 ** ^The soft heap limit is "soft" because even though SQLite strives to stay 5070 ** ^The soft heap limit is "soft" because even though SQLite strives to stay
4327 ** below the limit, it will exceed the limit rather than generate 5071 ** below the limit, it will exceed the limit rather than generate
4328 ** an [SQLITE_NOMEM] error. In other words, the soft heap limit 5072 ** an [SQLITE_NOMEM] error. In other words, the soft heap limit
4329 ** is advisory only. 5073 ** is advisory only.
4330 ** 5074 **
4331 ** ^The return value from sqlite3_soft_heap_limit64() is the size of 5075 ** ^The return value from sqlite3_soft_heap_limit64() is the size of
4332 ** the soft heap limit prior to the call. ^If the argument N is negative 5076 ** the soft heap limit prior to the call, or negative in the case of an
5077 ** error. ^If the argument N is negative
4333 ** then no change is made to the soft heap limit. Hence, the current 5078 ** then no change is made to the soft heap limit. Hence, the current
4334 ** size of the soft heap limit can be determined by invoking 5079 ** size of the soft heap limit can be determined by invoking
4335 ** sqlite3_soft_heap_limit64() with a negative argument. 5080 ** sqlite3_soft_heap_limit64() with a negative argument.
4336 ** 5081 **
4337 ** ^If the argument N is zero then the soft heap limit is disabled. 5082 ** ^If the argument N is zero then the soft heap limit is disabled.
4338 ** 5083 **
4339 ** ^(The soft heap limit is not enforced in the current implementation 5084 ** ^(The soft heap limit is not enforced in the current implementation
4340 ** if one or more of following conditions are true: 5085 ** if one or more of following conditions are true:
4341 ** 5086 **
4342 ** <ul> 5087 ** <ul>
4343 ** <li> The soft heap limit is set to zero. 5088 ** <li> The soft heap limit is set to zero.
4344 ** <li> Memory accounting is disabled using a combination of the 5089 ** <li> Memory accounting is disabled using a combination of the
4345 ** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and 5090 ** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and
4346 ** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option. 5091 ** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option.
4347 ** <li> An alternative page cache implementation is specified using 5092 ** <li> An alternative page cache implementation is specified using
4348 ** [sqlite3_config]([SQLITE_CONFIG_PCACHE],...). 5093 ** [sqlite3_config]([SQLITE_CONFIG_PCACHE2],...).
4349 ** <li> The page cache allocates from its own memory pool supplied 5094 ** <li> The page cache allocates from its own memory pool supplied
4350 ** by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than 5095 ** by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than
4351 ** from the heap. 5096 ** from the heap.
4352 ** </ul>)^ 5097 ** </ul>)^
4353 ** 5098 **
4354 ** Beginning with SQLite version 3.7.3, the soft heap limit is enforced 5099 ** Beginning with SQLite version 3.7.3, the soft heap limit is enforced
4355 ** regardless of whether or not the [SQLITE_ENABLE_MEMORY_MANAGEMENT] 5100 ** regardless of whether or not the [SQLITE_ENABLE_MEMORY_MANAGEMENT]
4356 ** compile-time option is invoked. With [SQLITE_ENABLE_MEMORY_MANAGEMENT], 5101 ** compile-time option is invoked. With [SQLITE_ENABLE_MEMORY_MANAGEMENT],
4357 ** the soft heap limit is enforced on every memory allocation. Without 5102 ** the soft heap limit is enforced on every memory allocation. Without
4358 ** [SQLITE_ENABLE_MEMORY_MANAGEMENT], the soft heap limit is only enforced 5103 ** [SQLITE_ENABLE_MEMORY_MANAGEMENT], the soft heap limit is only enforced
(...skipping 92 matching lines...) Expand 10 before | Expand all | Expand 10 after
4451 int *pPrimaryKey, /* OUTPUT: True if column part of PK */ 5196 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
4452 int *pAutoinc /* OUTPUT: True if column is auto-increment */ 5197 int *pAutoinc /* OUTPUT: True if column is auto-increment */
4453 ); 5198 );
4454 5199
4455 /* 5200 /*
4456 ** CAPI3REF: Load An Extension 5201 ** CAPI3REF: Load An Extension
4457 ** 5202 **
4458 ** ^This interface loads an SQLite extension library from the named file. 5203 ** ^This interface loads an SQLite extension library from the named file.
4459 ** 5204 **
4460 ** ^The sqlite3_load_extension() interface attempts to load an 5205 ** ^The sqlite3_load_extension() interface attempts to load an
4461 ** SQLite extension library contained in the file zFile. 5206 ** [SQLite extension] library contained in the file zFile. If
5207 ** the file cannot be loaded directly, attempts are made to load
5208 ** with various operating-system specific extensions added.
5209 ** So for example, if "samplelib" cannot be loaded, then names like
5210 ** "samplelib.so" or "samplelib.dylib" or "samplelib.dll" might
5211 ** be tried also.
4462 ** 5212 **
4463 ** ^The entry point is zProc. 5213 ** ^The entry point is zProc.
4464 ** ^zProc may be 0, in which case the name of the entry point 5214 ** ^(zProc may be 0, in which case SQLite will try to come up with an
4465 ** defaults to "sqlite3_extension_init". 5215 ** entry point name on its own. It first tries "sqlite3_extension_init".
5216 ** If that does not work, it constructs a name "sqlite3_X_init" where the
5217 ** X is consists of the lower-case equivalent of all ASCII alphabetic
5218 ** characters in the filename from the last "/" to the first following
5219 ** "." and omitting any initial "lib".)^
4466 ** ^The sqlite3_load_extension() interface returns 5220 ** ^The sqlite3_load_extension() interface returns
4467 ** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong. 5221 ** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.
4468 ** ^If an error occurs and pzErrMsg is not 0, then the 5222 ** ^If an error occurs and pzErrMsg is not 0, then the
4469 ** [sqlite3_load_extension()] interface shall attempt to 5223 ** [sqlite3_load_extension()] interface shall attempt to
4470 ** fill *pzErrMsg with error message text stored in memory 5224 ** fill *pzErrMsg with error message text stored in memory
4471 ** obtained from [sqlite3_malloc()]. The calling function 5225 ** obtained from [sqlite3_malloc()]. The calling function
4472 ** should free this memory by calling [sqlite3_free()]. 5226 ** should free this memory by calling [sqlite3_free()].
4473 ** 5227 **
4474 ** ^Extension loading must be enabled using 5228 ** ^Extension loading must be enabled using
4475 ** [sqlite3_enable_load_extension()] prior to calling this API, 5229 ** [sqlite3_enable_load_extension()] prior to calling this API,
4476 ** otherwise an error will be returned. 5230 ** otherwise an error will be returned.
4477 ** 5231 **
4478 ** See also the [load_extension() SQL function]. 5232 ** See also the [load_extension() SQL function].
4479 */ 5233 */
4480 int sqlite3_load_extension( 5234 int sqlite3_load_extension(
4481 sqlite3 *db, /* Load the extension into this database connection */ 5235 sqlite3 *db, /* Load the extension into this database connection */
4482 const char *zFile, /* Name of the shared library containing extension */ 5236 const char *zFile, /* Name of the shared library containing extension */
4483 const char *zProc, /* Entry point. Derived from zFile if 0 */ 5237 const char *zProc, /* Entry point. Derived from zFile if 0 */
4484 char **pzErrMsg /* Put error message here if not 0 */ 5238 char **pzErrMsg /* Put error message here if not 0 */
4485 ); 5239 );
4486 5240
4487 /* 5241 /*
4488 ** CAPI3REF: Enable Or Disable Extension Loading 5242 ** CAPI3REF: Enable Or Disable Extension Loading
4489 ** 5243 **
4490 ** ^So as not to open security holes in older applications that are 5244 ** ^So as not to open security holes in older applications that are
4491 ** unprepared to deal with extension loading, and as a means of disabling 5245 ** unprepared to deal with [extension loading], and as a means of disabling
4492 ** extension loading while evaluating user-entered SQL, the following API 5246 ** [extension loading] while evaluating user-entered SQL, the following API
4493 ** is provided to turn the [sqlite3_load_extension()] mechanism on and off. 5247 ** is provided to turn the [sqlite3_load_extension()] mechanism on and off.
4494 ** 5248 **
4495 ** ^Extension loading is off by default. See ticket #1863. 5249 ** ^Extension loading is off by default.
4496 ** ^Call the sqlite3_enable_load_extension() routine with onoff==1 5250 ** ^Call the sqlite3_enable_load_extension() routine with onoff==1
4497 ** to turn extension loading on and call it with onoff==0 to turn 5251 ** to turn extension loading on and call it with onoff==0 to turn
4498 ** it back off again. 5252 ** it back off again.
4499 */ 5253 */
4500 int sqlite3_enable_load_extension(sqlite3 *db, int onoff); 5254 int sqlite3_enable_load_extension(sqlite3 *db, int onoff);
4501 5255
4502 /* 5256 /*
4503 ** CAPI3REF: Automatically Load Statically Linked Extensions 5257 ** CAPI3REF: Automatically Load Statically Linked Extensions
4504 ** 5258 **
4505 ** ^This interface causes the xEntryPoint() function to be invoked for 5259 ** ^This interface causes the xEntryPoint() function to be invoked for
4506 ** each new [database connection] that is created. The idea here is that 5260 ** each new [database connection] that is created. The idea here is that
4507 ** xEntryPoint() is the entry point for a statically linked SQLite extension 5261 ** xEntryPoint() is the entry point for a statically linked [SQLite extension]
4508 ** that is to be automatically loaded into all new database connections. 5262 ** that is to be automatically loaded into all new database connections.
4509 ** 5263 **
4510 ** ^(Even though the function prototype shows that xEntryPoint() takes 5264 ** ^(Even though the function prototype shows that xEntryPoint() takes
4511 ** no arguments and returns void, SQLite invokes xEntryPoint() with three 5265 ** no arguments and returns void, SQLite invokes xEntryPoint() with three
4512 ** arguments and expects and integer result as if the signature of the 5266 ** arguments and expects and integer result as if the signature of the
4513 ** entry point where as follows: 5267 ** entry point where as follows:
4514 ** 5268 **
4515 ** <blockquote><pre> 5269 ** <blockquote><pre>
4516 ** &nbsp; int xEntryPoint( 5270 ** &nbsp; int xEntryPoint(
4517 ** &nbsp; sqlite3 *db, 5271 ** &nbsp; sqlite3 *db,
4518 ** &nbsp; const char **pzErrMsg, 5272 ** &nbsp; const char **pzErrMsg,
4519 ** &nbsp; const struct sqlite3_api_routines *pThunk 5273 ** &nbsp; const struct sqlite3_api_routines *pThunk
4520 ** &nbsp; ); 5274 ** &nbsp; );
4521 ** </pre></blockquote>)^ 5275 ** </pre></blockquote>)^
4522 ** 5276 **
4523 ** If the xEntryPoint routine encounters an error, it should make *pzErrMsg 5277 ** If the xEntryPoint routine encounters an error, it should make *pzErrMsg
4524 ** point to an appropriate error message (obtained from [sqlite3_mprintf()]) 5278 ** point to an appropriate error message (obtained from [sqlite3_mprintf()])
4525 ** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg 5279 ** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg
4526 ** is NULL before calling the xEntryPoint(). ^SQLite will invoke 5280 ** is NULL before calling the xEntryPoint(). ^SQLite will invoke
4527 ** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any 5281 ** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any
4528 ** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()], 5282 ** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()],
4529 ** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail. 5283 ** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail.
4530 ** 5284 **
4531 ** ^Calling sqlite3_auto_extension(X) with an entry point X that is already 5285 ** ^Calling sqlite3_auto_extension(X) with an entry point X that is already
4532 ** on the list of automatic extensions is a harmless no-op. ^No entry point 5286 ** on the list of automatic extensions is a harmless no-op. ^No entry point
4533 ** will be called more than once for each database connection that is opened. 5287 ** will be called more than once for each database connection that is opened.
4534 ** 5288 **
4535 ** See also: [sqlite3_reset_auto_extension()]. 5289 ** See also: [sqlite3_reset_auto_extension()]
5290 ** and [sqlite3_cancel_auto_extension()]
4536 */ 5291 */
4537 int sqlite3_auto_extension(void (*xEntryPoint)(void)); 5292 int sqlite3_auto_extension(void (*xEntryPoint)(void));
4538 5293
4539 /* 5294 /*
5295 ** CAPI3REF: Cancel Automatic Extension Loading
5296 **
5297 ** ^The [sqlite3_cancel_auto_extension(X)] interface unregisters the
5298 ** initialization routine X that was registered using a prior call to
5299 ** [sqlite3_auto_extension(X)]. ^The [sqlite3_cancel_auto_extension(X)]
5300 ** routine returns 1 if initialization routine X was successfully
5301 ** unregistered and it returns 0 if X was not on the list of initialization
5302 ** routines.
5303 */
5304 int sqlite3_cancel_auto_extension(void (*xEntryPoint)(void));
5305
5306 /*
4540 ** CAPI3REF: Reset Automatic Extension Loading 5307 ** CAPI3REF: Reset Automatic Extension Loading
4541 ** 5308 **
4542 ** ^This interface disables all automatic extensions previously 5309 ** ^This interface disables all automatic extensions previously
4543 ** registered using [sqlite3_auto_extension()]. 5310 ** registered using [sqlite3_auto_extension()].
4544 */ 5311 */
4545 void sqlite3_reset_auto_extension(void); 5312 void sqlite3_reset_auto_extension(void);
4546 5313
4547 /* 5314 /*
4548 ** The interface to the virtual-table mechanism is currently considered 5315 ** The interface to the virtual-table mechanism is currently considered
4549 ** to be experimental. The interface might change in incompatible ways. 5316 ** to be experimental. The interface might change in incompatible ways.
(...skipping 48 matching lines...) Expand 10 before | Expand all | Expand 10 after
4598 int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid); 5365 int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid);
4599 int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *); 5366 int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *);
4600 int (*xBegin)(sqlite3_vtab *pVTab); 5367 int (*xBegin)(sqlite3_vtab *pVTab);
4601 int (*xSync)(sqlite3_vtab *pVTab); 5368 int (*xSync)(sqlite3_vtab *pVTab);
4602 int (*xCommit)(sqlite3_vtab *pVTab); 5369 int (*xCommit)(sqlite3_vtab *pVTab);
4603 int (*xRollback)(sqlite3_vtab *pVTab); 5370 int (*xRollback)(sqlite3_vtab *pVTab);
4604 int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName, 5371 int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName,
4605 void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), 5372 void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),
4606 void **ppArg); 5373 void **ppArg);
4607 int (*xRename)(sqlite3_vtab *pVtab, const char *zNew); 5374 int (*xRename)(sqlite3_vtab *pVtab, const char *zNew);
5375 /* The methods above are in version 1 of the sqlite_module object. Those
5376 ** below are for version 2 and greater. */
5377 int (*xSavepoint)(sqlite3_vtab *pVTab, int);
5378 int (*xRelease)(sqlite3_vtab *pVTab, int);
5379 int (*xRollbackTo)(sqlite3_vtab *pVTab, int);
4608 }; 5380 };
4609 5381
4610 /* 5382 /*
4611 ** CAPI3REF: Virtual Table Indexing Information 5383 ** CAPI3REF: Virtual Table Indexing Information
4612 ** KEYWORDS: sqlite3_index_info 5384 ** KEYWORDS: sqlite3_index_info
4613 ** 5385 **
4614 ** The sqlite3_index_info structure and its substructures is used as part 5386 ** The sqlite3_index_info structure and its substructures is used as part
4615 ** of the [virtual table] interface to 5387 ** of the [virtual table] interface to
4616 ** pass information into and receive the reply from the [xBestIndex] 5388 ** pass information into and receive the reply from the [xBestIndex]
4617 ** method of a [virtual table module]. The fields under **Inputs** are the 5389 ** method of a [virtual table module]. The fields under **Inputs** are the
(...skipping 30 matching lines...) Expand all
4648 ** 5420 **
4649 ** ^The idxNum and idxPtr values are recorded and passed into the 5421 ** ^The idxNum and idxPtr values are recorded and passed into the
4650 ** [xFilter] method. 5422 ** [xFilter] method.
4651 ** ^[sqlite3_free()] is used to free idxPtr if and only if 5423 ** ^[sqlite3_free()] is used to free idxPtr if and only if
4652 ** needToFreeIdxPtr is true. 5424 ** needToFreeIdxPtr is true.
4653 ** 5425 **
4654 ** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in 5426 ** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in
4655 ** the correct order to satisfy the ORDER BY clause so that no separate 5427 ** the correct order to satisfy the ORDER BY clause so that no separate
4656 ** sorting step is required. 5428 ** sorting step is required.
4657 ** 5429 **
4658 ** ^The estimatedCost value is an estimate of the cost of doing the 5430 ** ^The estimatedCost value is an estimate of the cost of a particular
4659 ** particular lookup. A full scan of a table with N entries should have 5431 ** strategy. A cost of N indicates that the cost of the strategy is similar
4660 ** a cost of N. A binary search of a table of N entries should have a 5432 ** to a linear scan of an SQLite table with N rows. A cost of log(N)
4661 ** cost of approximately log(N). 5433 ** indicates that the expense of the operation is similar to that of a
5434 ** binary search on a unique indexed field of an SQLite table with N rows.
5435 **
5436 ** ^The estimatedRows value is an estimate of the number of rows that
5437 ** will be returned by the strategy.
5438 **
5439 ** IMPORTANT: The estimatedRows field was added to the sqlite3_index_info
5440 ** structure for SQLite version 3.8.2. If a virtual table extension is
5441 ** used with an SQLite version earlier than 3.8.2, the results of attempting
5442 ** to read or write the estimatedRows field are undefined (but are likely
5443 ** to included crashing the application). The estimatedRows field should
5444 ** therefore only be used if [sqlite3_libversion_number()] returns a
5445 ** value greater than or equal to 3008002.
4662 */ 5446 */
4663 struct sqlite3_index_info { 5447 struct sqlite3_index_info {
4664 /* Inputs */ 5448 /* Inputs */
4665 int nConstraint; /* Number of entries in aConstraint */ 5449 int nConstraint; /* Number of entries in aConstraint */
4666 struct sqlite3_index_constraint { 5450 struct sqlite3_index_constraint {
4667 int iColumn; /* Column on left-hand side of constraint */ 5451 int iColumn; /* Column on left-hand side of constraint */
4668 unsigned char op; /* Constraint operator */ 5452 unsigned char op; /* Constraint operator */
4669 unsigned char usable; /* True if this constraint is usable */ 5453 unsigned char usable; /* True if this constraint is usable */
4670 int iTermOffset; /* Used internally - xBestIndex should ignore */ 5454 int iTermOffset; /* Used internally - xBestIndex should ignore */
4671 } *aConstraint; /* Table of WHERE clause constraints */ 5455 } *aConstraint; /* Table of WHERE clause constraints */
4672 int nOrderBy; /* Number of terms in the ORDER BY clause */ 5456 int nOrderBy; /* Number of terms in the ORDER BY clause */
4673 struct sqlite3_index_orderby { 5457 struct sqlite3_index_orderby {
4674 int iColumn; /* Column number */ 5458 int iColumn; /* Column number */
4675 unsigned char desc; /* True for DESC. False for ASC. */ 5459 unsigned char desc; /* True for DESC. False for ASC. */
4676 } *aOrderBy; /* The ORDER BY clause */ 5460 } *aOrderBy; /* The ORDER BY clause */
4677 /* Outputs */ 5461 /* Outputs */
4678 struct sqlite3_index_constraint_usage { 5462 struct sqlite3_index_constraint_usage {
4679 int argvIndex; /* if >0, constraint is part of argv to xFilter */ 5463 int argvIndex; /* if >0, constraint is part of argv to xFilter */
4680 unsigned char omit; /* Do not code a test for this constraint */ 5464 unsigned char omit; /* Do not code a test for this constraint */
4681 } *aConstraintUsage; 5465 } *aConstraintUsage;
4682 int idxNum; /* Number used to identify the index */ 5466 int idxNum; /* Number used to identify the index */
4683 char *idxStr; /* String, possibly obtained from sqlite3_malloc */ 5467 char *idxStr; /* String, possibly obtained from sqlite3_malloc */
4684 int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ 5468 int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */
4685 int orderByConsumed; /* True if output is already ordered */ 5469 int orderByConsumed; /* True if output is already ordered */
4686 double estimatedCost; /* Estimated cost of using this index */ 5470 double estimatedCost; /* Estimated cost of using this index */
5471 /* Fields below are only available in SQLite 3.8.2 and later */
5472 sqlite3_int64 estimatedRows; /* Estimated number of rows returned */
4687 }; 5473 };
4688 5474
4689 /* 5475 /*
4690 ** CAPI3REF: Virtual Table Constraint Operator Codes 5476 ** CAPI3REF: Virtual Table Constraint Operator Codes
4691 ** 5477 **
4692 ** These macros defined the allowed values for the 5478 ** These macros defined the allowed values for the
4693 ** [sqlite3_index_info].aConstraint[].op field. Each value represents 5479 ** [sqlite3_index_info].aConstraint[].op field. Each value represents
4694 ** an operator that is part of a constraint term in the wHERE clause of 5480 ** an operator that is part of a constraint term in the wHERE clause of
4695 ** a query that uses a [virtual table]. 5481 ** a query that uses a [virtual table].
4696 */ 5482 */
(...skipping 183 matching lines...) Expand 10 before | Expand all | Expand 10 after
4880 ** an expired BLOB handle fail with a return code of [SQLITE_ABORT]. 5666 ** an expired BLOB handle fail with a return code of [SQLITE_ABORT].
4881 ** ^(Changes written into a BLOB prior to the BLOB expiring are not 5667 ** ^(Changes written into a BLOB prior to the BLOB expiring are not
4882 ** rolled back by the expiration of the BLOB. Such changes will eventually 5668 ** rolled back by the expiration of the BLOB. Such changes will eventually
4883 ** commit if the transaction continues to completion.)^ 5669 ** commit if the transaction continues to completion.)^
4884 ** 5670 **
4885 ** ^Use the [sqlite3_blob_bytes()] interface to determine the size of 5671 ** ^Use the [sqlite3_blob_bytes()] interface to determine the size of
4886 ** the opened blob. ^The size of a blob may not be changed by this 5672 ** the opened blob. ^The size of a blob may not be changed by this
4887 ** interface. Use the [UPDATE] SQL command to change the size of a 5673 ** interface. Use the [UPDATE] SQL command to change the size of a
4888 ** blob. 5674 ** blob.
4889 ** 5675 **
5676 ** ^The [sqlite3_blob_open()] interface will fail for a [WITHOUT ROWID]
5677 ** table. Incremental BLOB I/O is not possible on [WITHOUT ROWID] tables.
5678 **
4890 ** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces 5679 ** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces
4891 ** and the built-in [zeroblob] SQL function can be used, if desired, 5680 ** and the built-in [zeroblob] SQL function can be used, if desired,
4892 ** to create an empty, zero-filled blob in which to read or write using 5681 ** to create an empty, zero-filled blob in which to read or write using
4893 ** this interface. 5682 ** this interface.
4894 ** 5683 **
4895 ** To avoid a resource leak, every open [BLOB handle] should eventually 5684 ** To avoid a resource leak, every open [BLOB handle] should eventually
4896 ** be released by a call to [sqlite3_blob_close()]. 5685 ** be released by a call to [sqlite3_blob_close()].
4897 */ 5686 */
4898 int sqlite3_blob_open( 5687 int sqlite3_blob_open(
4899 sqlite3*, 5688 sqlite3*,
(...skipping 174 matching lines...) Expand 10 before | Expand all | Expand 10 after
5074 ** synchronization. Though they are intended for internal 5863 ** synchronization. Though they are intended for internal
5075 ** use by SQLite, code that links against SQLite is 5864 ** use by SQLite, code that links against SQLite is
5076 ** permitted to use any of these routines. 5865 ** permitted to use any of these routines.
5077 ** 5866 **
5078 ** The SQLite source code contains multiple implementations 5867 ** The SQLite source code contains multiple implementations
5079 ** of these mutex routines. An appropriate implementation 5868 ** of these mutex routines. An appropriate implementation
5080 ** is selected automatically at compile-time. ^(The following 5869 ** is selected automatically at compile-time. ^(The following
5081 ** implementations are available in the SQLite core: 5870 ** implementations are available in the SQLite core:
5082 ** 5871 **
5083 ** <ul> 5872 ** <ul>
5084 ** <li> SQLITE_MUTEX_OS2 5873 ** <li> SQLITE_MUTEX_PTHREADS
5085 ** <li> SQLITE_MUTEX_PTHREAD
5086 ** <li> SQLITE_MUTEX_W32 5874 ** <li> SQLITE_MUTEX_W32
5087 ** <li> SQLITE_MUTEX_NOOP 5875 ** <li> SQLITE_MUTEX_NOOP
5088 ** </ul>)^ 5876 ** </ul>)^
5089 ** 5877 **
5090 ** ^The SQLITE_MUTEX_NOOP implementation is a set of routines 5878 ** ^The SQLITE_MUTEX_NOOP implementation is a set of routines
5091 ** that does no real locking and is appropriate for use in 5879 ** that does no real locking and is appropriate for use in
5092 ** a single-threaded application. ^The SQLITE_MUTEX_OS2, 5880 ** a single-threaded application. ^The SQLITE_MUTEX_PTHREADS and
5093 ** SQLITE_MUTEX_PTHREAD, and SQLITE_MUTEX_W32 implementations 5881 ** SQLITE_MUTEX_W32 implementations are appropriate for use on Unix
5094 ** are appropriate for use on OS/2, Unix, and Windows. 5882 ** and Windows.
5095 ** 5883 **
5096 ** ^(If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor 5884 ** ^(If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor
5097 ** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex 5885 ** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex
5098 ** implementation is included with the library. In this case the 5886 ** implementation is included with the library. In this case the
5099 ** application must supply a custom mutex implementation using the 5887 ** application must supply a custom mutex implementation using the
5100 ** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function 5888 ** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function
5101 ** before calling sqlite3_initialize() or any other public sqlite3_ 5889 ** before calling sqlite3_initialize() or any other public sqlite3_
5102 ** function that calls sqlite3_initialize().)^ 5890 ** function that calls sqlite3_initialize().)^
5103 ** 5891 **
5104 ** ^The sqlite3_mutex_alloc() routine allocates a new 5892 ** ^The sqlite3_mutex_alloc() routine allocates a new
5105 ** mutex and returns a pointer to it. ^If it returns NULL 5893 ** mutex and returns a pointer to it. ^If it returns NULL
5106 ** that means that a mutex could not be allocated. ^SQLite 5894 ** that means that a mutex could not be allocated. ^SQLite
5107 ** will unwind its stack and return an error. ^(The argument 5895 ** will unwind its stack and return an error. ^(The argument
5108 ** to sqlite3_mutex_alloc() is one of these integer constants: 5896 ** to sqlite3_mutex_alloc() is one of these integer constants:
5109 ** 5897 **
5110 ** <ul> 5898 ** <ul>
5111 ** <li> SQLITE_MUTEX_FAST 5899 ** <li> SQLITE_MUTEX_FAST
5112 ** <li> SQLITE_MUTEX_RECURSIVE 5900 ** <li> SQLITE_MUTEX_RECURSIVE
5113 ** <li> SQLITE_MUTEX_STATIC_MASTER 5901 ** <li> SQLITE_MUTEX_STATIC_MASTER
5114 ** <li> SQLITE_MUTEX_STATIC_MEM 5902 ** <li> SQLITE_MUTEX_STATIC_MEM
5115 ** <li> SQLITE_MUTEX_STATIC_MEM2 5903 ** <li> SQLITE_MUTEX_STATIC_OPEN
5116 ** <li> SQLITE_MUTEX_STATIC_PRNG 5904 ** <li> SQLITE_MUTEX_STATIC_PRNG
5117 ** <li> SQLITE_MUTEX_STATIC_LRU 5905 ** <li> SQLITE_MUTEX_STATIC_LRU
5118 ** <li> SQLITE_MUTEX_STATIC_LRU2 5906 ** <li> SQLITE_MUTEX_STATIC_PMEM
5907 ** <li> SQLITE_MUTEX_STATIC_APP1
5908 ** <li> SQLITE_MUTEX_STATIC_APP2
5119 ** </ul>)^ 5909 ** </ul>)^
5120 ** 5910 **
5121 ** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) 5911 ** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE)
5122 ** cause sqlite3_mutex_alloc() to create 5912 ** cause sqlite3_mutex_alloc() to create
5123 ** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE 5913 ** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
5124 ** is used but not necessarily so when SQLITE_MUTEX_FAST is used. 5914 ** is used but not necessarily so when SQLITE_MUTEX_FAST is used.
5125 ** The mutex implementation does not need to make a distinction 5915 ** The mutex implementation does not need to make a distinction
5126 ** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does 5916 ** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
5127 ** not want to. ^SQLite will only request a recursive mutex in 5917 ** not want to. ^SQLite will only request a recursive mutex in
5128 ** cases where it really needs one. ^If a faster non-recursive mutex 5918 ** cases where it really needs one. ^If a faster non-recursive mutex
(...skipping 144 matching lines...) Expand 10 before | Expand all | Expand 10 after
5273 ** never uses these routines except inside an assert() and applications 6063 ** never uses these routines except inside an assert() and applications
5274 ** are advised to follow the lead of the core. ^The SQLite core only 6064 ** are advised to follow the lead of the core. ^The SQLite core only
5275 ** provides implementations for these routines when it is compiled 6065 ** provides implementations for these routines when it is compiled
5276 ** with the SQLITE_DEBUG flag. ^External mutex implementations 6066 ** with the SQLITE_DEBUG flag. ^External mutex implementations
5277 ** are only required to provide these routines if SQLITE_DEBUG is 6067 ** are only required to provide these routines if SQLITE_DEBUG is
5278 ** defined and if NDEBUG is not defined. 6068 ** defined and if NDEBUG is not defined.
5279 ** 6069 **
5280 ** ^These routines should return true if the mutex in their argument 6070 ** ^These routines should return true if the mutex in their argument
5281 ** is held or not held, respectively, by the calling thread. 6071 ** is held or not held, respectively, by the calling thread.
5282 ** 6072 **
5283 ** ^The implementation is not required to provided versions of these 6073 ** ^The implementation is not required to provide versions of these
5284 ** routines that actually work. If the implementation does not provide working 6074 ** routines that actually work. If the implementation does not provide working
5285 ** versions of these routines, it should at least provide stubs that always 6075 ** versions of these routines, it should at least provide stubs that always
5286 ** return true so that one does not get spurious assertion failures. 6076 ** return true so that one does not get spurious assertion failures.
5287 ** 6077 **
5288 ** ^If the argument to sqlite3_mutex_held() is a NULL pointer then 6078 ** ^If the argument to sqlite3_mutex_held() is a NULL pointer then
5289 ** the routine should return 1. This seems counter-intuitive since 6079 ** the routine should return 1. This seems counter-intuitive since
5290 ** clearly the mutex cannot be held if it does not exist. But the 6080 ** clearly the mutex cannot be held if it does not exist. But
5291 ** the reason the mutex does not exist is because the build is not 6081 ** the reason the mutex does not exist is because the build is not
5292 ** using mutexes. And we do not want the assert() containing the 6082 ** using mutexes. And we do not want the assert() containing the
5293 ** call to sqlite3_mutex_held() to fail, so a non-zero return is 6083 ** call to sqlite3_mutex_held() to fail, so a non-zero return is
5294 ** the appropriate thing to do. ^The sqlite3_mutex_notheld() 6084 ** the appropriate thing to do. ^The sqlite3_mutex_notheld()
5295 ** interface should also return 1 when given a NULL pointer. 6085 ** interface should also return 1 when given a NULL pointer.
5296 */ 6086 */
5297 #ifndef NDEBUG 6087 #ifndef NDEBUG
5298 int sqlite3_mutex_held(sqlite3_mutex*); 6088 int sqlite3_mutex_held(sqlite3_mutex*);
5299 int sqlite3_mutex_notheld(sqlite3_mutex*); 6089 int sqlite3_mutex_notheld(sqlite3_mutex*);
5300 #endif 6090 #endif
(...skipping 11 matching lines...) Expand all
5312 #define SQLITE_MUTEX_FAST 0 6102 #define SQLITE_MUTEX_FAST 0
5313 #define SQLITE_MUTEX_RECURSIVE 1 6103 #define SQLITE_MUTEX_RECURSIVE 1
5314 #define SQLITE_MUTEX_STATIC_MASTER 2 6104 #define SQLITE_MUTEX_STATIC_MASTER 2
5315 #define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */ 6105 #define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */
5316 #define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */ 6106 #define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */
5317 #define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */ 6107 #define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */
5318 #define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */ 6108 #define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */
5319 #define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */ 6109 #define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */
5320 #define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */ 6110 #define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */
5321 #define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */ 6111 #define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */
6112 #define SQLITE_MUTEX_STATIC_APP1 8 /* For use by application */
6113 #define SQLITE_MUTEX_STATIC_APP2 9 /* For use by application */
6114 #define SQLITE_MUTEX_STATIC_APP3 10 /* For use by application */
5322 6115
5323 /* 6116 /*
5324 ** CAPI3REF: Retrieve the mutex for a database connection 6117 ** CAPI3REF: Retrieve the mutex for a database connection
5325 ** 6118 **
5326 ** ^This interface returns a pointer the [sqlite3_mutex] object that 6119 ** ^This interface returns a pointer the [sqlite3_mutex] object that
5327 ** serializes access to the [database connection] given in the argument 6120 ** serializes access to the [database connection] given in the argument
5328 ** when the [threading mode] is Serialized. 6121 ** when the [threading mode] is Serialized.
5329 ** ^If the [threading mode] is Single-thread or Multi-thread then this 6122 ** ^If the [threading mode] is Single-thread or Multi-thread then this
5330 ** routine returns a NULL pointer. 6123 ** routine returns a NULL pointer.
5331 */ 6124 */
(...skipping 69 matching lines...) Expand 10 before | Expand all | Expand 10 after
5401 #define SQLITE_TESTCTRL_PRNG_RESET 7 6194 #define SQLITE_TESTCTRL_PRNG_RESET 7
5402 #define SQLITE_TESTCTRL_BITVEC_TEST 8 6195 #define SQLITE_TESTCTRL_BITVEC_TEST 8
5403 #define SQLITE_TESTCTRL_FAULT_INSTALL 9 6196 #define SQLITE_TESTCTRL_FAULT_INSTALL 9
5404 #define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10 6197 #define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10
5405 #define SQLITE_TESTCTRL_PENDING_BYTE 11 6198 #define SQLITE_TESTCTRL_PENDING_BYTE 11
5406 #define SQLITE_TESTCTRL_ASSERT 12 6199 #define SQLITE_TESTCTRL_ASSERT 12
5407 #define SQLITE_TESTCTRL_ALWAYS 13 6200 #define SQLITE_TESTCTRL_ALWAYS 13
5408 #define SQLITE_TESTCTRL_RESERVE 14 6201 #define SQLITE_TESTCTRL_RESERVE 14
5409 #define SQLITE_TESTCTRL_OPTIMIZATIONS 15 6202 #define SQLITE_TESTCTRL_OPTIMIZATIONS 15
5410 #define SQLITE_TESTCTRL_ISKEYWORD 16 6203 #define SQLITE_TESTCTRL_ISKEYWORD 16
5411 #define SQLITE_TESTCTRL_PGHDRSZ 17 6204 #define SQLITE_TESTCTRL_SCRATCHMALLOC 17
5412 #define SQLITE_TESTCTRL_SCRATCHMALLOC 18 6205 #define SQLITE_TESTCTRL_LOCALTIME_FAULT 18
5413 #define SQLITE_TESTCTRL_LAST 18 6206 #define SQLITE_TESTCTRL_EXPLAIN_STMT 19 /* NOT USED */
6207 #define SQLITE_TESTCTRL_NEVER_CORRUPT 20
6208 #define SQLITE_TESTCTRL_VDBE_COVERAGE 21
6209 #define SQLITE_TESTCTRL_BYTEORDER 22
6210 #define SQLITE_TESTCTRL_ISINIT 23
6211 #define SQLITE_TESTCTRL_SORTER_MMAP 24
6212 #define SQLITE_TESTCTRL_LAST 24
5414 6213
5415 /* 6214 /*
5416 ** CAPI3REF: SQLite Runtime Status 6215 ** CAPI3REF: SQLite Runtime Status
5417 ** 6216 **
5418 ** ^This interface is used to retrieve runtime status information 6217 ** ^This interface is used to retrieve runtime status information
5419 ** about the performance of SQLite, and optionally to reset various 6218 ** about the performance of SQLite, and optionally to reset various
5420 ** highwater marks. ^The first argument is an integer code for 6219 ** highwater marks. ^The first argument is an integer code for
5421 ** the specific parameter to measure. ^(Recognized integer codes 6220 ** the specific parameter to measure. ^(Recognized integer codes
5422 ** are of the form [SQLITE_STATUS_MEMORY_USED | SQLITE_STATUS_...].)^ 6221 ** are of the form [status parameters | SQLITE_STATUS_...].)^
5423 ** ^The current value of the parameter is returned into *pCurrent. 6222 ** ^The current value of the parameter is returned into *pCurrent.
5424 ** ^The highest recorded value is returned in *pHighwater. ^If the 6223 ** ^The highest recorded value is returned in *pHighwater. ^If the
5425 ** resetFlag is true, then the highest record value is reset after 6224 ** resetFlag is true, then the highest record value is reset after
5426 ** *pHighwater is written. ^(Some parameters do not record the highest 6225 ** *pHighwater is written. ^(Some parameters do not record the highest
5427 ** value. For those parameters 6226 ** value. For those parameters
5428 ** nothing is written into *pHighwater and the resetFlag is ignored.)^ 6227 ** nothing is written into *pHighwater and the resetFlag is ignored.)^
5429 ** ^(Other parameters record only the highwater mark and not the current 6228 ** ^(Other parameters record only the highwater mark and not the current
5430 ** value. For these latter parameters nothing is written into *pCurrent.)^ 6229 ** value. For these latter parameters nothing is written into *pCurrent.)^
5431 ** 6230 **
5432 ** ^The sqlite3_status() routine returns SQLITE_OK on success and a 6231 ** ^The sqlite3_status() routine returns SQLITE_OK on success and a
5433 ** non-zero [error code] on failure. 6232 ** non-zero [error code] on failure.
5434 ** 6233 **
5435 ** This routine is threadsafe but is not atomic. This routine can be 6234 ** This routine is threadsafe but is not atomic. This routine can be
5436 ** called while other threads are running the same or different SQLite 6235 ** called while other threads are running the same or different SQLite
5437 ** interfaces. However the values returned in *pCurrent and 6236 ** interfaces. However the values returned in *pCurrent and
5438 ** *pHighwater reflect the status of SQLite at different points in time 6237 ** *pHighwater reflect the status of SQLite at different points in time
5439 ** and it is possible that another thread might change the parameter 6238 ** and it is possible that another thread might change the parameter
5440 ** in between the times when *pCurrent and *pHighwater are written. 6239 ** in between the times when *pCurrent and *pHighwater are written.
5441 ** 6240 **
5442 ** See also: [sqlite3_db_status()] 6241 ** See also: [sqlite3_db_status()]
5443 */ 6242 */
5444 int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag); 6243 int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag);
5445 6244
5446 6245
5447 /* 6246 /*
5448 ** CAPI3REF: Status Parameters 6247 ** CAPI3REF: Status Parameters
6248 ** KEYWORDS: {status parameters}
5449 ** 6249 **
5450 ** These integer constants designate various run-time status parameters 6250 ** These integer constants designate various run-time status parameters
5451 ** that can be returned by [sqlite3_status()]. 6251 ** that can be returned by [sqlite3_status()].
5452 ** 6252 **
5453 ** <dl> 6253 ** <dl>
5454 ** ^(<dt>SQLITE_STATUS_MEMORY_USED</dt> 6254 ** [[SQLITE_STATUS_MEMORY_USED]] ^(<dt>SQLITE_STATUS_MEMORY_USED</dt>
5455 ** <dd>This parameter is the current amount of memory checked out 6255 ** <dd>This parameter is the current amount of memory checked out
5456 ** using [sqlite3_malloc()], either directly or indirectly. The 6256 ** using [sqlite3_malloc()], either directly or indirectly. The
5457 ** figure includes calls made to [sqlite3_malloc()] by the application 6257 ** figure includes calls made to [sqlite3_malloc()] by the application
5458 ** and internal memory usage by the SQLite library. Scratch memory 6258 ** and internal memory usage by the SQLite library. Scratch memory
5459 ** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache 6259 ** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache
5460 ** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in 6260 ** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in
5461 ** this parameter. The amount returned is the sum of the allocation 6261 ** this parameter. The amount returned is the sum of the allocation
5462 ** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^ 6262 ** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^
5463 ** 6263 **
5464 ** ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt> 6264 ** [[SQLITE_STATUS_MALLOC_SIZE]] ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt>
5465 ** <dd>This parameter records the largest memory allocation request 6265 ** <dd>This parameter records the largest memory allocation request
5466 ** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their 6266 ** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their
5467 ** internal equivalents). Only the value returned in the 6267 ** internal equivalents). Only the value returned in the
5468 ** *pHighwater parameter to [sqlite3_status()] is of interest. 6268 ** *pHighwater parameter to [sqlite3_status()] is of interest.
5469 ** The value written into the *pCurrent parameter is undefined.</dd>)^ 6269 ** The value written into the *pCurrent parameter is undefined.</dd>)^
5470 ** 6270 **
5471 ** ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt> 6271 ** [[SQLITE_STATUS_MALLOC_COUNT]] ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt>
5472 ** <dd>This parameter records the number of separate memory allocations 6272 ** <dd>This parameter records the number of separate memory allocations
5473 ** currently checked out.</dd>)^ 6273 ** currently checked out.</dd>)^
5474 ** 6274 **
5475 ** ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt> 6275 ** [[SQLITE_STATUS_PAGECACHE_USED]] ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt>
5476 ** <dd>This parameter returns the number of pages used out of the 6276 ** <dd>This parameter returns the number of pages used out of the
5477 ** [pagecache memory allocator] that was configured using 6277 ** [pagecache memory allocator] that was configured using
5478 ** [SQLITE_CONFIG_PAGECACHE]. The 6278 ** [SQLITE_CONFIG_PAGECACHE]. The
5479 ** value returned is in pages, not in bytes.</dd>)^ 6279 ** value returned is in pages, not in bytes.</dd>)^
5480 ** 6280 **
6281 ** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]]
5481 ** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt> 6282 ** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt>
5482 ** <dd>This parameter returns the number of bytes of page cache 6283 ** <dd>This parameter returns the number of bytes of page cache
5483 ** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE] 6284 ** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE]
5484 ** buffer and where forced to overflow to [sqlite3_malloc()]. The 6285 ** buffer and where forced to overflow to [sqlite3_malloc()]. The
5485 ** returned value includes allocations that overflowed because they 6286 ** returned value includes allocations that overflowed because they
5486 ** where too large (they were larger than the "sz" parameter to 6287 ** where too large (they were larger than the "sz" parameter to
5487 ** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because 6288 ** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because
5488 ** no space was left in the page cache.</dd>)^ 6289 ** no space was left in the page cache.</dd>)^
5489 ** 6290 **
5490 ** ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt> 6291 ** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt>
5491 ** <dd>This parameter records the largest memory allocation request 6292 ** <dd>This parameter records the largest memory allocation request
5492 ** handed to [pagecache memory allocator]. Only the value returned in the 6293 ** handed to [pagecache memory allocator]. Only the value returned in the
5493 ** *pHighwater parameter to [sqlite3_status()] is of interest. 6294 ** *pHighwater parameter to [sqlite3_status()] is of interest.
5494 ** The value written into the *pCurrent parameter is undefined.</dd>)^ 6295 ** The value written into the *pCurrent parameter is undefined.</dd>)^
5495 ** 6296 **
5496 ** ^(<dt>SQLITE_STATUS_SCRATCH_USED</dt> 6297 ** [[SQLITE_STATUS_SCRATCH_USED]] ^(<dt>SQLITE_STATUS_SCRATCH_USED</dt>
5497 ** <dd>This parameter returns the number of allocations used out of the 6298 ** <dd>This parameter returns the number of allocations used out of the
5498 ** [scratch memory allocator] configured using 6299 ** [scratch memory allocator] configured using
5499 ** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not 6300 ** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not
5500 ** in bytes. Since a single thread may only have one scratch allocation 6301 ** in bytes. Since a single thread may only have one scratch allocation
5501 ** outstanding at time, this parameter also reports the number of threads 6302 ** outstanding at time, this parameter also reports the number of threads
5502 ** using scratch memory at the same time.</dd>)^ 6303 ** using scratch memory at the same time.</dd>)^
5503 ** 6304 **
5504 ** ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt> 6305 ** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt>
5505 ** <dd>This parameter returns the number of bytes of scratch memory 6306 ** <dd>This parameter returns the number of bytes of scratch memory
5506 ** allocation which could not be satisfied by the [SQLITE_CONFIG_SCRATCH] 6307 ** allocation which could not be satisfied by the [SQLITE_CONFIG_SCRATCH]
5507 ** buffer and where forced to overflow to [sqlite3_malloc()]. The values 6308 ** buffer and where forced to overflow to [sqlite3_malloc()]. The values
5508 ** returned include overflows because the requested allocation was too 6309 ** returned include overflows because the requested allocation was too
5509 ** larger (that is, because the requested allocation was larger than the 6310 ** larger (that is, because the requested allocation was larger than the
5510 ** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer 6311 ** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer
5511 ** slots were available. 6312 ** slots were available.
5512 ** </dd>)^ 6313 ** </dd>)^
5513 ** 6314 **
5514 ** ^(<dt>SQLITE_STATUS_SCRATCH_SIZE</dt> 6315 ** [[SQLITE_STATUS_SCRATCH_SIZE]] ^(<dt>SQLITE_STATUS_SCRATCH_SIZE</dt>
5515 ** <dd>This parameter records the largest memory allocation request 6316 ** <dd>This parameter records the largest memory allocation request
5516 ** handed to [scratch memory allocator]. Only the value returned in the 6317 ** handed to [scratch memory allocator]. Only the value returned in the
5517 ** *pHighwater parameter to [sqlite3_status()] is of interest. 6318 ** *pHighwater parameter to [sqlite3_status()] is of interest.
5518 ** The value written into the *pCurrent parameter is undefined.</dd>)^ 6319 ** The value written into the *pCurrent parameter is undefined.</dd>)^
5519 ** 6320 **
5520 ** ^(<dt>SQLITE_STATUS_PARSER_STACK</dt> 6321 ** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt>
5521 ** <dd>This parameter records the deepest parser stack. It is only 6322 ** <dd>This parameter records the deepest parser stack. It is only
5522 ** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^ 6323 ** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^
5523 ** </dl> 6324 ** </dl>
5524 ** 6325 **
5525 ** New status parameters may be added from time to time. 6326 ** New status parameters may be added from time to time.
5526 */ 6327 */
5527 #define SQLITE_STATUS_MEMORY_USED 0 6328 #define SQLITE_STATUS_MEMORY_USED 0
5528 #define SQLITE_STATUS_PAGECACHE_USED 1 6329 #define SQLITE_STATUS_PAGECACHE_USED 1
5529 #define SQLITE_STATUS_PAGECACHE_OVERFLOW 2 6330 #define SQLITE_STATUS_PAGECACHE_OVERFLOW 2
5530 #define SQLITE_STATUS_SCRATCH_USED 3 6331 #define SQLITE_STATUS_SCRATCH_USED 3
5531 #define SQLITE_STATUS_SCRATCH_OVERFLOW 4 6332 #define SQLITE_STATUS_SCRATCH_OVERFLOW 4
5532 #define SQLITE_STATUS_MALLOC_SIZE 5 6333 #define SQLITE_STATUS_MALLOC_SIZE 5
5533 #define SQLITE_STATUS_PARSER_STACK 6 6334 #define SQLITE_STATUS_PARSER_STACK 6
5534 #define SQLITE_STATUS_PAGECACHE_SIZE 7 6335 #define SQLITE_STATUS_PAGECACHE_SIZE 7
5535 #define SQLITE_STATUS_SCRATCH_SIZE 8 6336 #define SQLITE_STATUS_SCRATCH_SIZE 8
5536 #define SQLITE_STATUS_MALLOC_COUNT 9 6337 #define SQLITE_STATUS_MALLOC_COUNT 9
5537 6338
5538 /* 6339 /*
5539 ** CAPI3REF: Database Connection Status 6340 ** CAPI3REF: Database Connection Status
5540 ** 6341 **
5541 ** ^This interface is used to retrieve runtime status information 6342 ** ^This interface is used to retrieve runtime status information
5542 ** about a single [database connection]. ^The first argument is the 6343 ** about a single [database connection]. ^The first argument is the
5543 ** database connection object to be interrogated. ^The second argument 6344 ** database connection object to be interrogated. ^The second argument
5544 ** is an integer constant, taken from the set of 6345 ** is an integer constant, taken from the set of
5545 ** [SQLITE_DBSTATUS_LOOKASIDE_USED | SQLITE_DBSTATUS_*] macros, that 6346 ** [SQLITE_DBSTATUS options], that
5546 ** determines the parameter to interrogate. The set of 6347 ** determines the parameter to interrogate. The set of
5547 ** [SQLITE_DBSTATUS_LOOKASIDE_USED | SQLITE_DBSTATUS_*] macros is likely 6348 ** [SQLITE_DBSTATUS options] is likely
5548 ** to grow in future releases of SQLite. 6349 ** to grow in future releases of SQLite.
5549 ** 6350 **
5550 ** ^The current value of the requested parameter is written into *pCur 6351 ** ^The current value of the requested parameter is written into *pCur
5551 ** and the highest instantaneous value is written into *pHiwtr. ^If 6352 ** and the highest instantaneous value is written into *pHiwtr. ^If
5552 ** the resetFlg is true, then the highest instantaneous value is 6353 ** the resetFlg is true, then the highest instantaneous value is
5553 ** reset back down to the current value. 6354 ** reset back down to the current value.
5554 ** 6355 **
5555 ** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a 6356 ** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a
5556 ** non-zero [error code] on failure. 6357 ** non-zero [error code] on failure.
5557 ** 6358 **
5558 ** See also: [sqlite3_status()] and [sqlite3_stmt_status()]. 6359 ** See also: [sqlite3_status()] and [sqlite3_stmt_status()].
5559 */ 6360 */
5560 int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg); 6361 int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg);
5561 6362
5562 /* 6363 /*
5563 ** CAPI3REF: Status Parameters for database connections 6364 ** CAPI3REF: Status Parameters for database connections
6365 ** KEYWORDS: {SQLITE_DBSTATUS options}
5564 ** 6366 **
5565 ** These constants are the available integer "verbs" that can be passed as 6367 ** These constants are the available integer "verbs" that can be passed as
5566 ** the second argument to the [sqlite3_db_status()] interface. 6368 ** the second argument to the [sqlite3_db_status()] interface.
5567 ** 6369 **
5568 ** New verbs may be added in future releases of SQLite. Existing verbs 6370 ** New verbs may be added in future releases of SQLite. Existing verbs
5569 ** might be discontinued. Applications should check the return code from 6371 ** might be discontinued. Applications should check the return code from
5570 ** [sqlite3_db_status()] to make sure that the call worked. 6372 ** [sqlite3_db_status()] to make sure that the call worked.
5571 ** The [sqlite3_db_status()] interface will return a non-zero error code 6373 ** The [sqlite3_db_status()] interface will return a non-zero error code
5572 ** if a discontinued or unsupported verb is invoked. 6374 ** if a discontinued or unsupported verb is invoked.
5573 ** 6375 **
5574 ** <dl> 6376 ** <dl>
5575 ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt> 6377 ** [[SQLITE_DBSTATUS_LOOKASIDE_USED]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt>
5576 ** <dd>This parameter returns the number of lookaside memory slots currently 6378 ** <dd>This parameter returns the number of lookaside memory slots currently
5577 ** checked out.</dd>)^ 6379 ** checked out.</dd>)^
5578 ** 6380 **
5579 ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt> 6381 ** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt>
5580 ** <dd>This parameter returns the number malloc attempts that were 6382 ** <dd>This parameter returns the number malloc attempts that were
5581 ** satisfied using lookaside memory. Only the high-water value is meaningful; 6383 ** satisfied using lookaside memory. Only the high-water value is meaningful;
5582 ** the current value is always zero.)^ 6384 ** the current value is always zero.)^
5583 ** 6385 **
6386 ** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE]]
5584 ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt> 6387 ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt>
5585 ** <dd>This parameter returns the number malloc attempts that might have 6388 ** <dd>This parameter returns the number malloc attempts that might have
5586 ** been satisfied using lookaside memory but failed due to the amount of 6389 ** been satisfied using lookaside memory but failed due to the amount of
5587 ** memory requested being larger than the lookaside slot size. 6390 ** memory requested being larger than the lookaside slot size.
5588 ** Only the high-water value is meaningful; 6391 ** Only the high-water value is meaningful;
5589 ** the current value is always zero.)^ 6392 ** the current value is always zero.)^
5590 ** 6393 **
6394 ** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL]]
5591 ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt> 6395 ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt>
5592 ** <dd>This parameter returns the number malloc attempts that might have 6396 ** <dd>This parameter returns the number malloc attempts that might have
5593 ** been satisfied using lookaside memory but failed due to all lookaside 6397 ** been satisfied using lookaside memory but failed due to all lookaside
5594 ** memory already being in use. 6398 ** memory already being in use.
5595 ** Only the high-water value is meaningful; 6399 ** Only the high-water value is meaningful;
5596 ** the current value is always zero.)^ 6400 ** the current value is always zero.)^
5597 ** 6401 **
5598 ** ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt> 6402 ** [[SQLITE_DBSTATUS_CACHE_USED]] ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt>
5599 ** <dd>This parameter returns the approximate number of of bytes of heap 6403 ** <dd>This parameter returns the approximate number of bytes of heap
5600 ** memory used by all pager caches associated with the database connection.)^ 6404 ** memory used by all pager caches associated with the database connection.)^
5601 ** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0. 6405 ** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0.
5602 ** 6406 **
5603 ** ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt> 6407 ** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt>
5604 ** <dd>This parameter returns the approximate number of of bytes of heap 6408 ** <dd>This parameter returns the approximate number of bytes of heap
5605 ** memory used to store the schema for all databases associated 6409 ** memory used to store the schema for all databases associated
5606 ** with the connection - main, temp, and any [ATTACH]-ed databases.)^ 6410 ** with the connection - main, temp, and any [ATTACH]-ed databases.)^
5607 ** ^The full amount of memory used by the schemas is reported, even if the 6411 ** ^The full amount of memory used by the schemas is reported, even if the
5608 ** schema memory is shared with other database connections due to 6412 ** schema memory is shared with other database connections due to
5609 ** [shared cache mode] being enabled. 6413 ** [shared cache mode] being enabled.
5610 ** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0. 6414 ** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0.
5611 ** 6415 **
5612 ** ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt> 6416 ** [[SQLITE_DBSTATUS_STMT_USED]] ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt>
5613 ** <dd>This parameter returns the approximate number of of bytes of heap 6417 ** <dd>This parameter returns the approximate number of bytes of heap
5614 ** and lookaside memory used by all prepared statements associated with 6418 ** and lookaside memory used by all prepared statements associated with
5615 ** the database connection.)^ 6419 ** the database connection.)^
5616 ** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0. 6420 ** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0.
5617 ** </dd> 6421 ** </dd>
6422 **
6423 ** [[SQLITE_DBSTATUS_CACHE_HIT]] ^(<dt>SQLITE_DBSTATUS_CACHE_HIT</dt>
6424 ** <dd>This parameter returns the number of pager cache hits that have
6425 ** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT
6426 ** is always 0.
6427 ** </dd>
6428 **
6429 ** [[SQLITE_DBSTATUS_CACHE_MISS]] ^(<dt>SQLITE_DBSTATUS_CACHE_MISS</dt>
6430 ** <dd>This parameter returns the number of pager cache misses that have
6431 ** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS
6432 ** is always 0.
6433 ** </dd>
6434 **
6435 ** [[SQLITE_DBSTATUS_CACHE_WRITE]] ^(<dt>SQLITE_DBSTATUS_CACHE_WRITE</dt>
6436 ** <dd>This parameter returns the number of dirty cache entries that have
6437 ** been written to disk. Specifically, the number of pages written to the
6438 ** wal file in wal mode databases, or the number of pages written to the
6439 ** database file in rollback mode databases. Any pages written as part of
6440 ** transaction rollback or database recovery operations are not included.
6441 ** If an IO or other error occurs while writing a page to disk, the effect
6442 ** on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined.)^ ^The
6443 ** highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0.
6444 ** </dd>
6445 **
6446 ** [[SQLITE_DBSTATUS_DEFERRED_FKS]] ^(<dt>SQLITE_DBSTATUS_DEFERRED_FKS</dt>
6447 ** <dd>This parameter returns zero for the current value if and only if
6448 ** all foreign key constraints (deferred or immediate) have been
6449 ** resolved.)^ ^The highwater mark is always 0.
6450 ** </dd>
5618 ** </dl> 6451 ** </dl>
5619 */ 6452 */
5620 #define SQLITE_DBSTATUS_LOOKASIDE_USED 0 6453 #define SQLITE_DBSTATUS_LOOKASIDE_USED 0
5621 #define SQLITE_DBSTATUS_CACHE_USED 1 6454 #define SQLITE_DBSTATUS_CACHE_USED 1
5622 #define SQLITE_DBSTATUS_SCHEMA_USED 2 6455 #define SQLITE_DBSTATUS_SCHEMA_USED 2
5623 #define SQLITE_DBSTATUS_STMT_USED 3 6456 #define SQLITE_DBSTATUS_STMT_USED 3
5624 #define SQLITE_DBSTATUS_LOOKASIDE_HIT 4 6457 #define SQLITE_DBSTATUS_LOOKASIDE_HIT 4
5625 #define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE 5 6458 #define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE 5
5626 #define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6 6459 #define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6
5627 #define SQLITE_DBSTATUS_MAX 6 /* Largest defined DBSTATUS */ 6460 #define SQLITE_DBSTATUS_CACHE_HIT 7
6461 #define SQLITE_DBSTATUS_CACHE_MISS 8
6462 #define SQLITE_DBSTATUS_CACHE_WRITE 9
6463 #define SQLITE_DBSTATUS_DEFERRED_FKS 10
6464 #define SQLITE_DBSTATUS_MAX 10 /* Largest defined DBSTATUS */
5628 6465
5629 6466
5630 /* 6467 /*
5631 ** CAPI3REF: Prepared Statement Status 6468 ** CAPI3REF: Prepared Statement Status
5632 ** 6469 **
5633 ** ^(Each prepared statement maintains various 6470 ** ^(Each prepared statement maintains various
5634 ** [SQLITE_STMTSTATUS_SORT | counters] that measure the number 6471 ** [SQLITE_STMTSTATUS counters] that measure the number
5635 ** of times it has performed specific operations.)^ These counters can 6472 ** of times it has performed specific operations.)^ These counters can
5636 ** be used to monitor the performance characteristics of the prepared 6473 ** be used to monitor the performance characteristics of the prepared
5637 ** statements. For example, if the number of table steps greatly exceeds 6474 ** statements. For example, if the number of table steps greatly exceeds
5638 ** the number of table searches or result rows, that would tend to indicate 6475 ** the number of table searches or result rows, that would tend to indicate
5639 ** that the prepared statement is using a full table scan rather than 6476 ** that the prepared statement is using a full table scan rather than
5640 ** an index. 6477 ** an index.
5641 ** 6478 **
5642 ** ^(This interface is used to retrieve and reset counter values from 6479 ** ^(This interface is used to retrieve and reset counter values from
5643 ** a [prepared statement]. The first argument is the prepared statement 6480 ** a [prepared statement]. The first argument is the prepared statement
5644 ** object to be interrogated. The second argument 6481 ** object to be interrogated. The second argument
5645 ** is an integer code for a specific [SQLITE_STMTSTATUS_SORT | counter] 6482 ** is an integer code for a specific [SQLITE_STMTSTATUS counter]
5646 ** to be interrogated.)^ 6483 ** to be interrogated.)^
5647 ** ^The current value of the requested counter is returned. 6484 ** ^The current value of the requested counter is returned.
5648 ** ^If the resetFlg is true, then the counter is reset to zero after this 6485 ** ^If the resetFlg is true, then the counter is reset to zero after this
5649 ** interface call returns. 6486 ** interface call returns.
5650 ** 6487 **
5651 ** See also: [sqlite3_status()] and [sqlite3_db_status()]. 6488 ** See also: [sqlite3_status()] and [sqlite3_db_status()].
5652 */ 6489 */
5653 int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg); 6490 int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg);
5654 6491
5655 /* 6492 /*
5656 ** CAPI3REF: Status Parameters for prepared statements 6493 ** CAPI3REF: Status Parameters for prepared statements
6494 ** KEYWORDS: {SQLITE_STMTSTATUS counter} {SQLITE_STMTSTATUS counters}
5657 ** 6495 **
5658 ** These preprocessor macros define integer codes that name counter 6496 ** These preprocessor macros define integer codes that name counter
5659 ** values associated with the [sqlite3_stmt_status()] interface. 6497 ** values associated with the [sqlite3_stmt_status()] interface.
5660 ** The meanings of the various counters are as follows: 6498 ** The meanings of the various counters are as follows:
5661 ** 6499 **
5662 ** <dl> 6500 ** <dl>
5663 ** <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt> 6501 ** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]] <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt>
5664 ** <dd>^This is the number of times that SQLite has stepped forward in 6502 ** <dd>^This is the number of times that SQLite has stepped forward in
5665 ** a table as part of a full table scan. Large numbers for this counter 6503 ** a table as part of a full table scan. Large numbers for this counter
5666 ** may indicate opportunities for performance improvement through 6504 ** may indicate opportunities for performance improvement through
5667 ** careful use of indices.</dd> 6505 ** careful use of indices.</dd>
5668 ** 6506 **
5669 ** <dt>SQLITE_STMTSTATUS_SORT</dt> 6507 ** [[SQLITE_STMTSTATUS_SORT]] <dt>SQLITE_STMTSTATUS_SORT</dt>
5670 ** <dd>^This is the number of sort operations that have occurred. 6508 ** <dd>^This is the number of sort operations that have occurred.
5671 ** A non-zero value in this counter may indicate an opportunity to 6509 ** A non-zero value in this counter may indicate an opportunity to
5672 ** improvement performance through careful use of indices.</dd> 6510 ** improvement performance through careful use of indices.</dd>
5673 ** 6511 **
5674 ** <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt> 6512 ** [[SQLITE_STMTSTATUS_AUTOINDEX]] <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt>
5675 ** <dd>^This is the number of rows inserted into transient indices that 6513 ** <dd>^This is the number of rows inserted into transient indices that
5676 ** were created automatically in order to help joins run faster. 6514 ** were created automatically in order to help joins run faster.
5677 ** A non-zero value in this counter may indicate an opportunity to 6515 ** A non-zero value in this counter may indicate an opportunity to
5678 ** improvement performance by adding permanent indices that do not 6516 ** improvement performance by adding permanent indices that do not
5679 ** need to be reinitialized each time the statement is run.</dd> 6517 ** need to be reinitialized each time the statement is run.</dd>
5680 ** 6518 **
6519 ** [[SQLITE_STMTSTATUS_VM_STEP]] <dt>SQLITE_STMTSTATUS_VM_STEP</dt>
6520 ** <dd>^This is the number of virtual machine operations executed
6521 ** by the prepared statement if that number is less than or equal
6522 ** to 2147483647. The number of virtual machine operations can be
6523 ** used as a proxy for the total work done by the prepared statement.
6524 ** If the number of virtual machine operations exceeds 2147483647
6525 ** then the value returned by this statement status code is undefined.
6526 ** </dd>
5681 ** </dl> 6527 ** </dl>
5682 */ 6528 */
5683 #define SQLITE_STMTSTATUS_FULLSCAN_STEP 1 6529 #define SQLITE_STMTSTATUS_FULLSCAN_STEP 1
5684 #define SQLITE_STMTSTATUS_SORT 2 6530 #define SQLITE_STMTSTATUS_SORT 2
5685 #define SQLITE_STMTSTATUS_AUTOINDEX 3 6531 #define SQLITE_STMTSTATUS_AUTOINDEX 3
6532 #define SQLITE_STMTSTATUS_VM_STEP 4
5686 6533
5687 /* 6534 /*
5688 ** CAPI3REF: Custom Page Cache Object 6535 ** CAPI3REF: Custom Page Cache Object
5689 ** 6536 **
5690 ** The sqlite3_pcache type is opaque. It is implemented by 6537 ** The sqlite3_pcache type is opaque. It is implemented by
5691 ** the pluggable module. The SQLite core has no knowledge of 6538 ** the pluggable module. The SQLite core has no knowledge of
5692 ** its size or internal structure and never deals with the 6539 ** its size or internal structure and never deals with the
5693 ** sqlite3_pcache object except by holding and passing pointers 6540 ** sqlite3_pcache object except by holding and passing pointers
5694 ** to the object. 6541 ** to the object.
5695 ** 6542 **
5696 ** See [sqlite3_pcache_methods] for additional information. 6543 ** See [sqlite3_pcache_methods2] for additional information.
5697 */ 6544 */
5698 typedef struct sqlite3_pcache sqlite3_pcache; 6545 typedef struct sqlite3_pcache sqlite3_pcache;
5699 6546
5700 /* 6547 /*
6548 ** CAPI3REF: Custom Page Cache Object
6549 **
6550 ** The sqlite3_pcache_page object represents a single page in the
6551 ** page cache. The page cache will allocate instances of this
6552 ** object. Various methods of the page cache use pointers to instances
6553 ** of this object as parameters or as their return value.
6554 **
6555 ** See [sqlite3_pcache_methods2] for additional information.
6556 */
6557 typedef struct sqlite3_pcache_page sqlite3_pcache_page;
6558 struct sqlite3_pcache_page {
6559 void *pBuf; /* The content of the page */
6560 void *pExtra; /* Extra information associated with the page */
6561 };
6562
6563 /*
5701 ** CAPI3REF: Application Defined Page Cache. 6564 ** CAPI3REF: Application Defined Page Cache.
5702 ** KEYWORDS: {page cache} 6565 ** KEYWORDS: {page cache}
5703 ** 6566 **
5704 ** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE], ...) interface can 6567 ** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE2], ...) interface can
5705 ** register an alternative page cache implementation by passing in an 6568 ** register an alternative page cache implementation by passing in an
5706 ** instance of the sqlite3_pcache_methods structure.)^ 6569 ** instance of the sqlite3_pcache_methods2 structure.)^
5707 ** In many applications, most of the heap memory allocated by 6570 ** In many applications, most of the heap memory allocated by
5708 ** SQLite is used for the page cache. 6571 ** SQLite is used for the page cache.
5709 ** By implementing a 6572 ** By implementing a
5710 ** custom page cache using this API, an application can better control 6573 ** custom page cache using this API, an application can better control
5711 ** the amount of memory consumed by SQLite, the way in which 6574 ** the amount of memory consumed by SQLite, the way in which
5712 ** that memory is allocated and released, and the policies used to 6575 ** that memory is allocated and released, and the policies used to
5713 ** determine exactly which parts of a database file are cached and for 6576 ** determine exactly which parts of a database file are cached and for
5714 ** how long. 6577 ** how long.
5715 ** 6578 **
5716 ** The alternative page cache mechanism is an 6579 ** The alternative page cache mechanism is an
5717 ** extreme measure that is only needed by the most demanding applications. 6580 ** extreme measure that is only needed by the most demanding applications.
5718 ** The built-in page cache is recommended for most uses. 6581 ** The built-in page cache is recommended for most uses.
5719 ** 6582 **
5720 ** ^(The contents of the sqlite3_pcache_methods structure are copied to an 6583 ** ^(The contents of the sqlite3_pcache_methods2 structure are copied to an
5721 ** internal buffer by SQLite within the call to [sqlite3_config]. Hence 6584 ** internal buffer by SQLite within the call to [sqlite3_config]. Hence
5722 ** the application may discard the parameter after the call to 6585 ** the application may discard the parameter after the call to
5723 ** [sqlite3_config()] returns.)^ 6586 ** [sqlite3_config()] returns.)^
5724 ** 6587 **
6588 ** [[the xInit() page cache method]]
5725 ** ^(The xInit() method is called once for each effective 6589 ** ^(The xInit() method is called once for each effective
5726 ** call to [sqlite3_initialize()])^ 6590 ** call to [sqlite3_initialize()])^
5727 ** (usually only once during the lifetime of the process). ^(The xInit() 6591 ** (usually only once during the lifetime of the process). ^(The xInit()
5728 ** method is passed a copy of the sqlite3_pcache_methods.pArg value.)^ 6592 ** method is passed a copy of the sqlite3_pcache_methods2.pArg value.)^
5729 ** The intent of the xInit() method is to set up global data structures 6593 ** The intent of the xInit() method is to set up global data structures
5730 ** required by the custom page cache implementation. 6594 ** required by the custom page cache implementation.
5731 ** ^(If the xInit() method is NULL, then the 6595 ** ^(If the xInit() method is NULL, then the
5732 ** built-in default page cache is used instead of the application defined 6596 ** built-in default page cache is used instead of the application defined
5733 ** page cache.)^ 6597 ** page cache.)^
5734 ** 6598 **
6599 ** [[the xShutdown() page cache method]]
5735 ** ^The xShutdown() method is called by [sqlite3_shutdown()]. 6600 ** ^The xShutdown() method is called by [sqlite3_shutdown()].
5736 ** It can be used to clean up 6601 ** It can be used to clean up
5737 ** any outstanding resources before process shutdown, if required. 6602 ** any outstanding resources before process shutdown, if required.
5738 ** ^The xShutdown() method may be NULL. 6603 ** ^The xShutdown() method may be NULL.
5739 ** 6604 **
5740 ** ^SQLite automatically serializes calls to the xInit method, 6605 ** ^SQLite automatically serializes calls to the xInit method,
5741 ** so the xInit method need not be threadsafe. ^The 6606 ** so the xInit method need not be threadsafe. ^The
5742 ** xShutdown method is only called from [sqlite3_shutdown()] so it does 6607 ** xShutdown method is only called from [sqlite3_shutdown()] so it does
5743 ** not need to be threadsafe either. All other methods must be threadsafe 6608 ** not need to be threadsafe either. All other methods must be threadsafe
5744 ** in multithreaded applications. 6609 ** in multithreaded applications.
5745 ** 6610 **
5746 ** ^SQLite will never invoke xInit() more than once without an intervening 6611 ** ^SQLite will never invoke xInit() more than once without an intervening
5747 ** call to xShutdown(). 6612 ** call to xShutdown().
5748 ** 6613 **
6614 ** [[the xCreate() page cache methods]]
5749 ** ^SQLite invokes the xCreate() method to construct a new cache instance. 6615 ** ^SQLite invokes the xCreate() method to construct a new cache instance.
5750 ** SQLite will typically create one cache instance for each open database file, 6616 ** SQLite will typically create one cache instance for each open database file,
5751 ** though this is not guaranteed. ^The 6617 ** though this is not guaranteed. ^The
5752 ** first parameter, szPage, is the size in bytes of the pages that must 6618 ** first parameter, szPage, is the size in bytes of the pages that must
5753 ** be allocated by the cache. ^szPage will not be a power of two. ^szPage 6619 ** be allocated by the cache. ^szPage will always a power of two. ^The
5754 ** will the page size of the database file that is to be cached plus an 6620 ** second parameter szExtra is a number of bytes of extra storage
5755 ** increment (here called "R") of less than 250. SQLite will use the 6621 ** associated with each page cache entry. ^The szExtra parameter will
5756 ** extra R bytes on each page to store metadata about the underlying 6622 ** a number less than 250. SQLite will use the
5757 ** database page on disk. The value of R depends 6623 ** extra szExtra bytes on each page to store metadata about the underlying
6624 ** database page on disk. The value passed into szExtra depends
5758 ** on the SQLite version, the target platform, and how SQLite was compiled. 6625 ** on the SQLite version, the target platform, and how SQLite was compiled.
5759 ** ^(R is constant for a particular build of SQLite. Except, there are two 6626 ** ^The third argument to xCreate(), bPurgeable, is true if the cache being
5760 ** distinct values of R when SQLite is compiled with the proprietary 6627 ** created will be used to cache database pages of a file stored on disk, or
5761 ** ZIPVFS extension.)^ ^The second argument to
5762 ** xCreate(), bPurgeable, is true if the cache being created will
5763 ** be used to cache database pages of a file stored on disk, or
5764 ** false if it is used for an in-memory database. The cache implementation 6628 ** false if it is used for an in-memory database. The cache implementation
5765 ** does not have to do anything special based with the value of bPurgeable; 6629 ** does not have to do anything special based with the value of bPurgeable;
5766 ** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will 6630 ** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will
5767 ** never invoke xUnpin() except to deliberately delete a page. 6631 ** never invoke xUnpin() except to deliberately delete a page.
5768 ** ^In other words, calls to xUnpin() on a cache with bPurgeable set to 6632 ** ^In other words, calls to xUnpin() on a cache with bPurgeable set to
5769 ** false will always have the "discard" flag set to true. 6633 ** false will always have the "discard" flag set to true.
5770 ** ^Hence, a cache created with bPurgeable false will 6634 ** ^Hence, a cache created with bPurgeable false will
5771 ** never contain any unpinned pages. 6635 ** never contain any unpinned pages.
5772 ** 6636 **
6637 ** [[the xCachesize() page cache method]]
5773 ** ^(The xCachesize() method may be called at any time by SQLite to set the 6638 ** ^(The xCachesize() method may be called at any time by SQLite to set the
5774 ** suggested maximum cache-size (number of pages stored by) the cache 6639 ** suggested maximum cache-size (number of pages stored by) the cache
5775 ** instance passed as the first argument. This is the value configured using 6640 ** instance passed as the first argument. This is the value configured using
5776 ** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable 6641 ** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable
5777 ** parameter, the implementation is not required to do anything with this 6642 ** parameter, the implementation is not required to do anything with this
5778 ** value; it is advisory only. 6643 ** value; it is advisory only.
5779 ** 6644 **
6645 ** [[the xPagecount() page cache methods]]
5780 ** The xPagecount() method must return the number of pages currently 6646 ** The xPagecount() method must return the number of pages currently
5781 ** stored in the cache, both pinned and unpinned. 6647 ** stored in the cache, both pinned and unpinned.
5782 ** 6648 **
6649 ** [[the xFetch() page cache methods]]
5783 ** The xFetch() method locates a page in the cache and returns a pointer to 6650 ** The xFetch() method locates a page in the cache and returns a pointer to
5784 ** the page, or a NULL pointer. 6651 ** an sqlite3_pcache_page object associated with that page, or a NULL pointer.
5785 ** A "page", in this context, means a buffer of szPage bytes aligned at an 6652 ** The pBuf element of the returned sqlite3_pcache_page object will be a
5786 ** 8-byte boundary. The page to be fetched is determined by the key. ^The 6653 ** pointer to a buffer of szPage bytes used to store the content of a
5787 ** mimimum key value is 1. After it has been retrieved using xFetch, the page 6654 ** single database page. The pExtra element of sqlite3_pcache_page will be
5788 ** is considered to be "pinned". 6655 ** a pointer to the szExtra bytes of extra storage that SQLite has requested
6656 ** for each entry in the page cache.
6657 **
6658 ** The page to be fetched is determined by the key. ^The minimum key value
6659 ** is 1. After it has been retrieved using xFetch, the page is considered
6660 ** to be "pinned".
5789 ** 6661 **
5790 ** If the requested page is already in the page cache, then the page cache 6662 ** If the requested page is already in the page cache, then the page cache
5791 ** implementation must return a pointer to the page buffer with its content 6663 ** implementation must return a pointer to the page buffer with its content
5792 ** intact. If the requested page is not already in the cache, then the 6664 ** intact. If the requested page is not already in the cache, then the
5793 ** cache implementation should use the value of the createFlag 6665 ** cache implementation should use the value of the createFlag
5794 ** parameter to help it determined what action to take: 6666 ** parameter to help it determined what action to take:
5795 ** 6667 **
5796 ** <table border=1 width=85% align=center> 6668 ** <table border=1 width=85% align=center>
5797 ** <tr><th> createFlag <th> Behaviour when page is not already in cache 6669 ** <tr><th> createFlag <th> Behavior when page is not already in cache
5798 ** <tr><td> 0 <td> Do not allocate a new page. Return NULL. 6670 ** <tr><td> 0 <td> Do not allocate a new page. Return NULL.
5799 ** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so. 6671 ** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so.
5800 ** Otherwise return NULL. 6672 ** Otherwise return NULL.
5801 ** <tr><td> 2 <td> Make every effort to allocate a new page. Only return 6673 ** <tr><td> 2 <td> Make every effort to allocate a new page. Only return
5802 ** NULL if allocating a new page is effectively impossible. 6674 ** NULL if allocating a new page is effectively impossible.
5803 ** </table> 6675 ** </table>
5804 ** 6676 **
5805 ** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite 6677 ** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite
5806 ** will only use a createFlag of 2 after a prior call with a createFlag of 1 6678 ** will only use a createFlag of 2 after a prior call with a createFlag of 1
5807 ** failed.)^ In between the to xFetch() calls, SQLite may 6679 ** failed.)^ In between the to xFetch() calls, SQLite may
5808 ** attempt to unpin one or more cache pages by spilling the content of 6680 ** attempt to unpin one or more cache pages by spilling the content of
5809 ** pinned pages to disk and synching the operating system disk cache. 6681 ** pinned pages to disk and synching the operating system disk cache.
5810 ** 6682 **
6683 ** [[the xUnpin() page cache method]]
5811 ** ^xUnpin() is called by SQLite with a pointer to a currently pinned page 6684 ** ^xUnpin() is called by SQLite with a pointer to a currently pinned page
5812 ** as its second argument. If the third parameter, discard, is non-zero, 6685 ** as its second argument. If the third parameter, discard, is non-zero,
5813 ** then the page must be evicted from the cache. 6686 ** then the page must be evicted from the cache.
5814 ** ^If the discard parameter is 6687 ** ^If the discard parameter is
5815 ** zero, then the page may be discarded or retained at the discretion of 6688 ** zero, then the page may be discarded or retained at the discretion of
5816 ** page cache implementation. ^The page cache implementation 6689 ** page cache implementation. ^The page cache implementation
5817 ** may choose to evict unpinned pages at any time. 6690 ** may choose to evict unpinned pages at any time.
5818 ** 6691 **
5819 ** The cache must not perform any reference counting. A single 6692 ** The cache must not perform any reference counting. A single
5820 ** call to xUnpin() unpins the page regardless of the number of prior calls 6693 ** call to xUnpin() unpins the page regardless of the number of prior calls
5821 ** to xFetch(). 6694 ** to xFetch().
5822 ** 6695 **
6696 ** [[the xRekey() page cache methods]]
5823 ** The xRekey() method is used to change the key value associated with the 6697 ** The xRekey() method is used to change the key value associated with the
5824 ** page passed as the second argument. If the cache 6698 ** page passed as the second argument. If the cache
5825 ** previously contains an entry associated with newKey, it must be 6699 ** previously contains an entry associated with newKey, it must be
5826 ** discarded. ^Any prior cache entry associated with newKey is guaranteed not 6700 ** discarded. ^Any prior cache entry associated with newKey is guaranteed not
5827 ** to be pinned. 6701 ** to be pinned.
5828 ** 6702 **
5829 ** When SQLite calls the xTruncate() method, the cache must discard all 6703 ** When SQLite calls the xTruncate() method, the cache must discard all
5830 ** existing cache entries with page numbers (keys) greater than or equal 6704 ** existing cache entries with page numbers (keys) greater than or equal
5831 ** to the value of the iLimit parameter passed to xTruncate(). If any 6705 ** to the value of the iLimit parameter passed to xTruncate(). If any
5832 ** of these pages are pinned, they are implicitly unpinned, meaning that 6706 ** of these pages are pinned, they are implicitly unpinned, meaning that
5833 ** they can be safely discarded. 6707 ** they can be safely discarded.
5834 ** 6708 **
6709 ** [[the xDestroy() page cache method]]
5835 ** ^The xDestroy() method is used to delete a cache allocated by xCreate(). 6710 ** ^The xDestroy() method is used to delete a cache allocated by xCreate().
5836 ** All resources associated with the specified cache should be freed. ^After 6711 ** All resources associated with the specified cache should be freed. ^After
5837 ** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*] 6712 ** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*]
5838 ** handle invalid, and will not use it with any other sqlite3_pcache_methods 6713 ** handle invalid, and will not use it with any other sqlite3_pcache_methods2
5839 ** functions. 6714 ** functions.
6715 **
6716 ** [[the xShrink() page cache method]]
6717 ** ^SQLite invokes the xShrink() method when it wants the page cache to
6718 ** free up as much of heap memory as possible. The page cache implementation
6719 ** is not obligated to free any memory, but well-behaved implementations should
6720 ** do their best.
6721 */
6722 typedef struct sqlite3_pcache_methods2 sqlite3_pcache_methods2;
6723 struct sqlite3_pcache_methods2 {
6724 int iVersion;
6725 void *pArg;
6726 int (*xInit)(void*);
6727 void (*xShutdown)(void*);
6728 sqlite3_pcache *(*xCreate)(int szPage, int szExtra, int bPurgeable);
6729 void (*xCachesize)(sqlite3_pcache*, int nCachesize);
6730 int (*xPagecount)(sqlite3_pcache*);
6731 sqlite3_pcache_page *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
6732 void (*xUnpin)(sqlite3_pcache*, sqlite3_pcache_page*, int discard);
6733 void (*xRekey)(sqlite3_pcache*, sqlite3_pcache_page*,
6734 unsigned oldKey, unsigned newKey);
6735 void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);
6736 void (*xDestroy)(sqlite3_pcache*);
6737 void (*xShrink)(sqlite3_pcache*);
6738 };
6739
6740 /*
6741 ** This is the obsolete pcache_methods object that has now been replaced
6742 ** by sqlite3_pcache_methods2. This object is not used by SQLite. It is
6743 ** retained in the header file for backwards compatibility only.
5840 */ 6744 */
5841 typedef struct sqlite3_pcache_methods sqlite3_pcache_methods; 6745 typedef struct sqlite3_pcache_methods sqlite3_pcache_methods;
5842 struct sqlite3_pcache_methods { 6746 struct sqlite3_pcache_methods {
5843 void *pArg; 6747 void *pArg;
5844 int (*xInit)(void*); 6748 int (*xInit)(void*);
5845 void (*xShutdown)(void*); 6749 void (*xShutdown)(void*);
5846 sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable); 6750 sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable);
5847 void (*xCachesize)(sqlite3_pcache*, int nCachesize); 6751 void (*xCachesize)(sqlite3_pcache*, int nCachesize);
5848 int (*xPagecount)(sqlite3_pcache*); 6752 int (*xPagecount)(sqlite3_pcache*);
5849 void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); 6753 void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
5850 void (*xUnpin)(sqlite3_pcache*, void*, int discard); 6754 void (*xUnpin)(sqlite3_pcache*, void*, int discard);
5851 void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey); 6755 void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey);
5852 void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); 6756 void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);
5853 void (*xDestroy)(sqlite3_pcache*); 6757 void (*xDestroy)(sqlite3_pcache*);
5854 }; 6758 };
5855 6759
6760
5856 /* 6761 /*
5857 ** CAPI3REF: Online Backup Object 6762 ** CAPI3REF: Online Backup Object
5858 ** 6763 **
5859 ** The sqlite3_backup object records state information about an ongoing 6764 ** The sqlite3_backup object records state information about an ongoing
5860 ** online backup operation. ^The sqlite3_backup object is created by 6765 ** online backup operation. ^The sqlite3_backup object is created by
5861 ** a call to [sqlite3_backup_init()] and is destroyed by a call to 6766 ** a call to [sqlite3_backup_init()] and is destroyed by a call to
5862 ** [sqlite3_backup_finish()]. 6767 ** [sqlite3_backup_finish()].
5863 ** 6768 **
5864 ** See Also: [Using the SQLite Online Backup API] 6769 ** See Also: [Using the SQLite Online Backup API]
5865 */ 6770 */
(...skipping 21 matching lines...) Expand all
5887 ** <li><b>sqlite3_backup_init()</b> is called once to initialize the 6792 ** <li><b>sqlite3_backup_init()</b> is called once to initialize the
5888 ** backup, 6793 ** backup,
5889 ** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer 6794 ** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer
5890 ** the data between the two databases, and finally 6795 ** the data between the two databases, and finally
5891 ** <li><b>sqlite3_backup_finish()</b> is called to release all resources 6796 ** <li><b>sqlite3_backup_finish()</b> is called to release all resources
5892 ** associated with the backup operation. 6797 ** associated with the backup operation.
5893 ** </ol>)^ 6798 ** </ol>)^
5894 ** There should be exactly one call to sqlite3_backup_finish() for each 6799 ** There should be exactly one call to sqlite3_backup_finish() for each
5895 ** successful call to sqlite3_backup_init(). 6800 ** successful call to sqlite3_backup_init().
5896 ** 6801 **
5897 ** <b>sqlite3_backup_init()</b> 6802 ** [[sqlite3_backup_init()]] <b>sqlite3_backup_init()</b>
5898 ** 6803 **
5899 ** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the 6804 ** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the
5900 ** [database connection] associated with the destination database 6805 ** [database connection] associated with the destination database
5901 ** and the database name, respectively. 6806 ** and the database name, respectively.
5902 ** ^The database name is "main" for the main database, "temp" for the 6807 ** ^The database name is "main" for the main database, "temp" for the
5903 ** temporary database, or the name specified after the AS keyword in 6808 ** temporary database, or the name specified after the AS keyword in
5904 ** an [ATTACH] statement for an attached database. 6809 ** an [ATTACH] statement for an attached database.
5905 ** ^The S and M arguments passed to 6810 ** ^The S and M arguments passed to
5906 ** sqlite3_backup_init(D,N,S,M) identify the [database connection] 6811 ** sqlite3_backup_init(D,N,S,M) identify the [database connection]
5907 ** and database name of the source database, respectively. 6812 ** and database name of the source database, respectively.
5908 ** ^The source and destination [database connections] (parameters S and D) 6813 ** ^The source and destination [database connections] (parameters S and D)
5909 ** must be different or else sqlite3_backup_init(D,N,S,M) will fail with 6814 ** must be different or else sqlite3_backup_init(D,N,S,M) will fail with
5910 ** an error. 6815 ** an error.
5911 ** 6816 **
5912 ** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is 6817 ** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is
5913 ** returned and an error code and error message are stored in the 6818 ** returned and an error code and error message are stored in the
5914 ** destination [database connection] D. 6819 ** destination [database connection] D.
5915 ** ^The error code and message for the failed call to sqlite3_backup_init() 6820 ** ^The error code and message for the failed call to sqlite3_backup_init()
5916 ** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or 6821 ** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or
5917 ** [sqlite3_errmsg16()] functions. 6822 ** [sqlite3_errmsg16()] functions.
5918 ** ^A successful call to sqlite3_backup_init() returns a pointer to an 6823 ** ^A successful call to sqlite3_backup_init() returns a pointer to an
5919 ** [sqlite3_backup] object. 6824 ** [sqlite3_backup] object.
5920 ** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and 6825 ** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and
5921 ** sqlite3_backup_finish() functions to perform the specified backup 6826 ** sqlite3_backup_finish() functions to perform the specified backup
5922 ** operation. 6827 ** operation.
5923 ** 6828 **
5924 ** <b>sqlite3_backup_step()</b> 6829 ** [[sqlite3_backup_step()]] <b>sqlite3_backup_step()</b>
5925 ** 6830 **
5926 ** ^Function sqlite3_backup_step(B,N) will copy up to N pages between 6831 ** ^Function sqlite3_backup_step(B,N) will copy up to N pages between
5927 ** the source and destination databases specified by [sqlite3_backup] object B. 6832 ** the source and destination databases specified by [sqlite3_backup] object B.
5928 ** ^If N is negative, all remaining source pages are copied. 6833 ** ^If N is negative, all remaining source pages are copied.
5929 ** ^If sqlite3_backup_step(B,N) successfully copies N pages and there 6834 ** ^If sqlite3_backup_step(B,N) successfully copies N pages and there
5930 ** are still more pages to be copied, then the function returns [SQLITE_OK]. 6835 ** are still more pages to be copied, then the function returns [SQLITE_OK].
5931 ** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages 6836 ** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages
5932 ** from source to destination, then it returns [SQLITE_DONE]. 6837 ** from source to destination, then it returns [SQLITE_DONE].
5933 ** ^If an error occurs while running sqlite3_backup_step(B,N), 6838 ** ^If an error occurs while running sqlite3_backup_step(B,N),
5934 ** then an [error code] is returned. ^As well as [SQLITE_OK] and 6839 ** then an [error code] is returned. ^As well as [SQLITE_OK] and
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after
5971 ** ^Because the source database is not locked between calls to 6876 ** ^Because the source database is not locked between calls to
5972 ** sqlite3_backup_step(), the source database may be modified mid-way 6877 ** sqlite3_backup_step(), the source database may be modified mid-way
5973 ** through the backup process. ^If the source database is modified by an 6878 ** through the backup process. ^If the source database is modified by an
5974 ** external process or via a database connection other than the one being 6879 ** external process or via a database connection other than the one being
5975 ** used by the backup operation, then the backup will be automatically 6880 ** used by the backup operation, then the backup will be automatically
5976 ** restarted by the next call to sqlite3_backup_step(). ^If the source 6881 ** restarted by the next call to sqlite3_backup_step(). ^If the source
5977 ** database is modified by the using the same database connection as is used 6882 ** database is modified by the using the same database connection as is used
5978 ** by the backup operation, then the backup database is automatically 6883 ** by the backup operation, then the backup database is automatically
5979 ** updated at the same time. 6884 ** updated at the same time.
5980 ** 6885 **
5981 ** <b>sqlite3_backup_finish()</b> 6886 ** [[sqlite3_backup_finish()]] <b>sqlite3_backup_finish()</b>
5982 ** 6887 **
5983 ** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the 6888 ** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the
5984 ** application wishes to abandon the backup operation, the application 6889 ** application wishes to abandon the backup operation, the application
5985 ** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish(). 6890 ** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish().
5986 ** ^The sqlite3_backup_finish() interfaces releases all 6891 ** ^The sqlite3_backup_finish() interfaces releases all
5987 ** resources associated with the [sqlite3_backup] object. 6892 ** resources associated with the [sqlite3_backup] object.
5988 ** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any 6893 ** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any
5989 ** active write-transaction on the destination database is rolled back. 6894 ** active write-transaction on the destination database is rolled back.
5990 ** The [sqlite3_backup] object is invalid 6895 ** The [sqlite3_backup] object is invalid
5991 ** and may not be used following a call to sqlite3_backup_finish(). 6896 ** and may not be used following a call to sqlite3_backup_finish().
5992 ** 6897 **
5993 ** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no 6898 ** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no
5994 ** sqlite3_backup_step() errors occurred, regardless or whether or not 6899 ** sqlite3_backup_step() errors occurred, regardless or whether or not
5995 ** sqlite3_backup_step() completed. 6900 ** sqlite3_backup_step() completed.
5996 ** ^If an out-of-memory condition or IO error occurred during any prior 6901 ** ^If an out-of-memory condition or IO error occurred during any prior
5997 ** sqlite3_backup_step() call on the same [sqlite3_backup] object, then 6902 ** sqlite3_backup_step() call on the same [sqlite3_backup] object, then
5998 ** sqlite3_backup_finish() returns the corresponding [error code]. 6903 ** sqlite3_backup_finish() returns the corresponding [error code].
5999 ** 6904 **
6000 ** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step() 6905 ** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step()
6001 ** is not a permanent error and does not affect the return value of 6906 ** is not a permanent error and does not affect the return value of
6002 ** sqlite3_backup_finish(). 6907 ** sqlite3_backup_finish().
6003 ** 6908 **
6004 ** <b>sqlite3_backup_remaining(), sqlite3_backup_pagecount()</b> 6909 ** [[sqlite3_backup__remaining()]] [[sqlite3_backup_pagecount()]]
6910 ** <b>sqlite3_backup_remaining() and sqlite3_backup_pagecount()</b>
6005 ** 6911 **
6006 ** ^Each call to sqlite3_backup_step() sets two values inside 6912 ** ^Each call to sqlite3_backup_step() sets two values inside
6007 ** the [sqlite3_backup] object: the number of pages still to be backed 6913 ** the [sqlite3_backup] object: the number of pages still to be backed
6008 ** up and the total number of pages in the source database file. 6914 ** up and the total number of pages in the source database file.
6009 ** The sqlite3_backup_remaining() and sqlite3_backup_pagecount() interfaces 6915 ** The sqlite3_backup_remaining() and sqlite3_backup_pagecount() interfaces
6010 ** retrieve these two values, respectively. 6916 ** retrieve these two values, respectively.
6011 ** 6917 **
6012 ** ^The values returned by these functions are only updated by 6918 ** ^The values returned by these functions are only updated by
6013 ** sqlite3_backup_step(). ^If the source database is modified during a backup 6919 ** sqlite3_backup_step(). ^If the source database is modified during a backup
6014 ** operation, then the values are not updated to account for any extra 6920 ** operation, then the values are not updated to account for any extra
(...skipping 159 matching lines...) Expand 10 before | Expand all | Expand 10 after
6174 int sqlite3_unlock_notify( 7080 int sqlite3_unlock_notify(
6175 sqlite3 *pBlocked, /* Waiting connection */ 7081 sqlite3 *pBlocked, /* Waiting connection */
6176 void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */ 7082 void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */
6177 void *pNotifyArg /* Argument to pass to xNotify */ 7083 void *pNotifyArg /* Argument to pass to xNotify */
6178 ); 7084 );
6179 7085
6180 7086
6181 /* 7087 /*
6182 ** CAPI3REF: String Comparison 7088 ** CAPI3REF: String Comparison
6183 ** 7089 **
6184 ** ^The [sqlite3_strnicmp()] API allows applications and extensions to 7090 ** ^The [sqlite3_stricmp()] and [sqlite3_strnicmp()] APIs allow applications
6185 ** compare the contents of two buffers containing UTF-8 strings in a 7091 ** and extensions to compare the contents of two buffers containing UTF-8
6186 ** case-independent fashion, using the same definition of case independence 7092 ** strings in a case-independent fashion, using the same definition of "case
6187 ** that SQLite uses internally when comparing identifiers. 7093 ** independence" that SQLite uses internally when comparing identifiers.
6188 */ 7094 */
7095 int sqlite3_stricmp(const char *, const char *);
6189 int sqlite3_strnicmp(const char *, const char *, int); 7096 int sqlite3_strnicmp(const char *, const char *, int);
6190 7097
6191 /* 7098 /*
7099 ** CAPI3REF: String Globbing
7100 *
7101 ** ^The [sqlite3_strglob(P,X)] interface returns zero if string X matches
7102 ** the glob pattern P, and it returns non-zero if string X does not match
7103 ** the glob pattern P. ^The definition of glob pattern matching used in
7104 ** [sqlite3_strglob(P,X)] is the same as for the "X GLOB P" operator in the
7105 ** SQL dialect used by SQLite. ^The sqlite3_strglob(P,X) function is case
7106 ** sensitive.
7107 **
7108 ** Note that this routine returns zero on a match and non-zero if the strings
7109 ** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()].
7110 */
7111 int sqlite3_strglob(const char *zGlob, const char *zStr);
7112
7113 /*
6192 ** CAPI3REF: Error Logging Interface 7114 ** CAPI3REF: Error Logging Interface
6193 ** 7115 **
6194 ** ^The [sqlite3_log()] interface writes a message into the error log 7116 ** ^The [sqlite3_log()] interface writes a message into the [error log]
6195 ** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()]. 7117 ** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()].
6196 ** ^If logging is enabled, the zFormat string and subsequent arguments are 7118 ** ^If logging is enabled, the zFormat string and subsequent arguments are
6197 ** used with [sqlite3_snprintf()] to generate the final output string. 7119 ** used with [sqlite3_snprintf()] to generate the final output string.
6198 ** 7120 **
6199 ** The sqlite3_log() interface is intended for use by extensions such as 7121 ** The sqlite3_log() interface is intended for use by extensions such as
6200 ** virtual tables, collating functions, and SQL functions. While there is 7122 ** virtual tables, collating functions, and SQL functions. While there is
6201 ** nothing to prevent an application from calling sqlite3_log(), doing so 7123 ** nothing to prevent an application from calling sqlite3_log(), doing so
6202 ** is considered bad form. 7124 ** is considered bad form.
6203 ** 7125 **
6204 ** The zFormat string must not be NULL. 7126 ** The zFormat string must not be NULL.
(...skipping 59 matching lines...) Expand 10 before | Expand all | Expand 10 after
6264 ** checkpoints entirely. 7186 ** checkpoints entirely.
6265 ** 7187 **
6266 ** ^The callback registered by this function replaces any existing callback 7188 ** ^The callback registered by this function replaces any existing callback
6267 ** registered using [sqlite3_wal_hook()]. ^Likewise, registering a callback 7189 ** registered using [sqlite3_wal_hook()]. ^Likewise, registering a callback
6268 ** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism 7190 ** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism
6269 ** configured by this function. 7191 ** configured by this function.
6270 ** 7192 **
6271 ** ^The [wal_autocheckpoint pragma] can be used to invoke this interface 7193 ** ^The [wal_autocheckpoint pragma] can be used to invoke this interface
6272 ** from SQL. 7194 ** from SQL.
6273 ** 7195 **
7196 ** ^Checkpoints initiated by this mechanism are
7197 ** [sqlite3_wal_checkpoint_v2|PASSIVE].
7198 **
6274 ** ^Every new [database connection] defaults to having the auto-checkpoint 7199 ** ^Every new [database connection] defaults to having the auto-checkpoint
6275 ** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT] 7200 ** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT]
6276 ** pages. The use of this interface 7201 ** pages. The use of this interface
6277 ** is only necessary if the default setting is found to be suboptimal 7202 ** is only necessary if the default setting is found to be suboptimal
6278 ** for a particular application. 7203 ** for a particular application.
6279 */ 7204 */
6280 int sqlite3_wal_autocheckpoint(sqlite3 *db, int N); 7205 int sqlite3_wal_autocheckpoint(sqlite3 *db, int N);
6281 7206
6282 /* 7207 /*
6283 ** CAPI3REF: Checkpoint a database 7208 ** CAPI3REF: Checkpoint a database
6284 ** 7209 **
6285 ** ^The [sqlite3_wal_checkpoint(D,X)] interface causes database named X 7210 ** ^The [sqlite3_wal_checkpoint(D,X)] interface causes database named X
6286 ** on [database connection] D to be [checkpointed]. ^If X is NULL or an 7211 ** on [database connection] D to be [checkpointed]. ^If X is NULL or an
6287 ** empty string, then a checkpoint is run on all databases of 7212 ** empty string, then a checkpoint is run on all databases of
6288 ** connection D. ^If the database connection D is not in 7213 ** connection D. ^If the database connection D is not in
6289 ** [WAL | write-ahead log mode] then this interface is a harmless no-op. 7214 ** [WAL | write-ahead log mode] then this interface is a harmless no-op.
7215 ** ^The [sqlite3_wal_checkpoint(D,X)] interface initiates a
7216 ** [sqlite3_wal_checkpoint_v2|PASSIVE] checkpoint.
7217 ** Use the [sqlite3_wal_checkpoint_v2()] interface to get a FULL
7218 ** or RESET checkpoint.
6290 ** 7219 **
6291 ** ^The [wal_checkpoint pragma] can be used to invoke this interface 7220 ** ^The [wal_checkpoint pragma] can be used to invoke this interface
6292 ** from SQL. ^The [sqlite3_wal_autocheckpoint()] interface and the 7221 ** from SQL. ^The [sqlite3_wal_autocheckpoint()] interface and the
6293 ** [wal_autocheckpoint pragma] can be used to cause this interface to be 7222 ** [wal_autocheckpoint pragma] can be used to cause this interface to be
6294 ** run whenever the WAL reaches a certain size threshold. 7223 ** run whenever the WAL reaches a certain size threshold.
6295 ** 7224 **
6296 ** See also: [sqlite3_wal_checkpoint_v2()] 7225 ** See also: [sqlite3_wal_checkpoint_v2()]
6297 */ 7226 */
6298 int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb); 7227 int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb);
6299 7228
6300 /* 7229 /*
6301 ** CAPI3REF: Checkpoint a database 7230 ** CAPI3REF: Checkpoint a database
6302 ** 7231 **
6303 ** Run a checkpoint operation on WAL database zDb attached to database 7232 ** Run a checkpoint operation on WAL database zDb attached to database
6304 ** handle db. The specific operation is determined by the value of the 7233 ** handle db. The specific operation is determined by the value of the
6305 ** eMode parameter: 7234 ** eMode parameter:
6306 ** 7235 **
6307 ** <dl> 7236 ** <dl>
6308 ** <dt>SQLITE_CHECKPOINT_PASSIVE<dd> 7237 ** <dt>SQLITE_CHECKPOINT_PASSIVE<dd>
6309 ** Checkpoint as many frames as possible without waiting for any database 7238 ** Checkpoint as many frames as possible without waiting for any database
6310 ** readers or writers to finish. Sync the db file if all frames in the log 7239 ** readers or writers to finish. Sync the db file if all frames in the log
6311 ** are checkpointed. This mode is the same as calling 7240 ** are checkpointed. This mode is the same as calling
6312 ** sqlite3_wal_checkpoint(). The busy-handler callback is never invoked. 7241 ** sqlite3_wal_checkpoint(). The [sqlite3_busy_handler|busy-handler callback]
7242 ** is never invoked.
6313 ** 7243 **
6314 ** <dt>SQLITE_CHECKPOINT_FULL<dd> 7244 ** <dt>SQLITE_CHECKPOINT_FULL<dd>
6315 ** This mode blocks (calls the busy-handler callback) until there is no 7245 ** This mode blocks (it invokes the
7246 ** [sqlite3_busy_handler|busy-handler callback]) until there is no
6316 ** database writer and all readers are reading from the most recent database 7247 ** database writer and all readers are reading from the most recent database
6317 ** snapshot. It then checkpoints all frames in the log file and syncs the 7248 ** snapshot. It then checkpoints all frames in the log file and syncs the
6318 ** database file. This call blocks database writers while it is running, 7249 ** database file. This call blocks database writers while it is running,
6319 ** but not database readers. 7250 ** but not database readers.
6320 ** 7251 **
6321 ** <dt>SQLITE_CHECKPOINT_RESTART<dd> 7252 ** <dt>SQLITE_CHECKPOINT_RESTART<dd>
6322 ** This mode works the same way as SQLITE_CHECKPOINT_FULL, except after 7253 ** This mode works the same way as SQLITE_CHECKPOINT_FULL, except after
6323 ** checkpointing the log file it blocks (calls the busy-handler callback) 7254 ** checkpointing the log file it blocks (calls the
7255 ** [sqlite3_busy_handler|busy-handler callback])
6324 ** until all readers are reading from the database file only. This ensures 7256 ** until all readers are reading from the database file only. This ensures
6325 ** that the next client to write to the database file restarts the log file 7257 ** that the next client to write to the database file restarts the log file
6326 ** from the beginning. This call blocks database writers while it is running, 7258 ** from the beginning. This call blocks database writers while it is running,
6327 ** but not database readers. 7259 ** but not database readers.
6328 ** </dl> 7260 ** </dl>
6329 ** 7261 **
6330 ** If pnLog is not NULL, then *pnLog is set to the total number of frames in 7262 ** If pnLog is not NULL, then *pnLog is set to the total number of frames in
6331 ** the log file before returning. If pnCkpt is not NULL, then *pnCkpt is set to 7263 ** the log file before returning. If pnCkpt is not NULL, then *pnCkpt is set to
6332 ** the total number of checkpointed frames (including any that were already 7264 ** the total number of checkpointed frames (including any that were already
6333 ** checkpointed when this function is called). *pnLog and *pnCkpt may be 7265 ** checkpointed when this function is called). *pnLog and *pnCkpt may be
(...skipping 46 matching lines...) Expand 10 before | Expand all | Expand 10 after
6380 ** 7312 **
6381 ** These constants can be used as the 3rd parameter to 7313 ** These constants can be used as the 3rd parameter to
6382 ** [sqlite3_wal_checkpoint_v2()]. See the [sqlite3_wal_checkpoint_v2()] 7314 ** [sqlite3_wal_checkpoint_v2()]. See the [sqlite3_wal_checkpoint_v2()]
6383 ** documentation for additional information about the meaning and use of 7315 ** documentation for additional information about the meaning and use of
6384 ** each of these values. 7316 ** each of these values.
6385 */ 7317 */
6386 #define SQLITE_CHECKPOINT_PASSIVE 0 7318 #define SQLITE_CHECKPOINT_PASSIVE 0
6387 #define SQLITE_CHECKPOINT_FULL 1 7319 #define SQLITE_CHECKPOINT_FULL 1
6388 #define SQLITE_CHECKPOINT_RESTART 2 7320 #define SQLITE_CHECKPOINT_RESTART 2
6389 7321
7322 /*
7323 ** CAPI3REF: Virtual Table Interface Configuration
7324 **
7325 ** This function may be called by either the [xConnect] or [xCreate] method
7326 ** of a [virtual table] implementation to configure
7327 ** various facets of the virtual table interface.
7328 **
7329 ** If this interface is invoked outside the context of an xConnect or
7330 ** xCreate virtual table method then the behavior is undefined.
7331 **
7332 ** At present, there is only one option that may be configured using
7333 ** this function. (See [SQLITE_VTAB_CONSTRAINT_SUPPORT].) Further options
7334 ** may be added in the future.
7335 */
7336 int sqlite3_vtab_config(sqlite3*, int op, ...);
6390 7337
6391 /* Begin recover.patch for Chromium */
6392 /* 7338 /*
6393 ** Call to initialize the recover virtual-table modules (see recover.c). 7339 ** CAPI3REF: Virtual Table Configuration Options
6394 ** 7340 **
6395 ** This could be loaded by default in main.c, but that would make the 7341 ** These macros define the various options to the
6396 ** virtual table available to Web SQL. Breaking it out allows only 7342 ** [sqlite3_vtab_config()] interface that [virtual table] implementations
6397 ** selected users to enable it (currently sql/recovery.cc). 7343 ** can use to customize and optimize their behavior.
7344 **
7345 ** <dl>
7346 ** <dt>SQLITE_VTAB_CONSTRAINT_SUPPORT
7347 ** <dd>Calls of the form
7348 ** [sqlite3_vtab_config](db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported,
7349 ** where X is an integer. If X is zero, then the [virtual table] whose
7350 ** [xCreate] or [xConnect] method invoked [sqlite3_vtab_config()] does not
7351 ** support constraints. In this configuration (which is the default) if
7352 ** a call to the [xUpdate] method returns [SQLITE_CONSTRAINT], then the entire
7353 ** statement is rolled back as if [ON CONFLICT | OR ABORT] had been
7354 ** specified as part of the users SQL statement, regardless of the actual
7355 ** ON CONFLICT mode specified.
7356 **
7357 ** If X is non-zero, then the virtual table implementation guarantees
7358 ** that if [xUpdate] returns [SQLITE_CONSTRAINT], it will do so before
7359 ** any modifications to internal or persistent data structures have been made.
7360 ** If the [ON CONFLICT] mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite
7361 ** is able to roll back a statement or database transaction, and abandon
7362 ** or continue processing the current SQL statement as appropriate.
7363 ** If the ON CONFLICT mode is REPLACE and the [xUpdate] method returns
7364 ** [SQLITE_CONSTRAINT], SQLite handles this as if the ON CONFLICT mode
7365 ** had been ABORT.
7366 **
7367 ** Virtual table implementations that are required to handle OR REPLACE
7368 ** must do so within the [xUpdate] method. If a call to the
7369 ** [sqlite3_vtab_on_conflict()] function indicates that the current ON
7370 ** CONFLICT policy is REPLACE, the virtual table implementation should
7371 ** silently replace the appropriate rows within the xUpdate callback and
7372 ** return SQLITE_OK. Or, if this is not possible, it may return
7373 ** SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT
7374 ** constraint handling.
7375 ** </dl>
6398 */ 7376 */
6399 int recoverVtableInit(sqlite3 *db); 7377 #define SQLITE_VTAB_CONSTRAINT_SUPPORT 1
6400 /* End recover.patch for Chromium */ 7378
7379 /*
7380 ** CAPI3REF: Determine The Virtual Table Conflict Policy
7381 **
7382 ** This function may only be called from within a call to the [xUpdate] method
7383 ** of a [virtual table] implementation for an INSERT or UPDATE operation. ^The
7384 ** value returned is one of [SQLITE_ROLLBACK], [SQLITE_IGNORE], [SQLITE_FAIL],
7385 ** [SQLITE_ABORT], or [SQLITE_REPLACE], according to the [ON CONFLICT] mode
7386 ** of the SQL statement that triggered the call to the [xUpdate] method of the
7387 ** [virtual table].
7388 */
7389 int sqlite3_vtab_on_conflict(sqlite3 *);
7390
7391 /*
7392 ** CAPI3REF: Conflict resolution modes
7393 ** KEYWORDS: {conflict resolution mode}
7394 **
7395 ** These constants are returned by [sqlite3_vtab_on_conflict()] to
7396 ** inform a [virtual table] implementation what the [ON CONFLICT] mode
7397 ** is for the SQL statement being evaluated.
7398 **
7399 ** Note that the [SQLITE_IGNORE] constant is also used as a potential
7400 ** return value from the [sqlite3_set_authorizer()] callback and that
7401 ** [SQLITE_ABORT] is also a [result code].
7402 */
7403 #define SQLITE_ROLLBACK 1
7404 /* #define SQLITE_IGNORE 2 // Also used by sqlite3_authorizer() callback */
7405 #define SQLITE_FAIL 3
7406 /* #define SQLITE_ABORT 4 // Also an error code */
7407 #define SQLITE_REPLACE 5
7408
7409
6401 7410
6402 /* 7411 /*
6403 ** Undo the hack that converts floating point types to integer for 7412 ** Undo the hack that converts floating point types to integer for
6404 ** builds on processors without floating point support. 7413 ** builds on processors without floating point support.
6405 */ 7414 */
6406 #ifdef SQLITE_OMIT_FLOATING_POINT 7415 #ifdef SQLITE_OMIT_FLOATING_POINT
6407 # undef double 7416 # undef double
6408 #endif 7417 #endif
6409 7418
6410 #ifdef __cplusplus 7419 #ifdef __cplusplus
6411 } /* End of the 'extern "C"' block */ 7420 } /* End of the 'extern "C"' block */
6412 #endif 7421 #endif
6413 #endif 7422 #endif /* _SQLITE3_H_ */
OLDNEW
« no previous file with comments | « third_party/sqlite/sqlite-src-3080704/src/shell.c ('k') | third_party/sqlite/sqlite-src-3080704/src/sqlite3.rc » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698