2** This file is an amalgamation of many separate C source files from SQLite
3** version 3.37.2. By combining all the individual C code files into this
4** single large file, the entire code can be compiled as a single translation
5** unit. This allows many compilers to do optimizations that would not be
6** possible if the files were compiled separately. Performance improvements
7** of 5% or more are commonly seen when SQLite is compiled as a single
8** translation unit.
10** This file is all you need to compile SQLite. To use SQLite in other
11** programs, you need this file and the "sqlite3.h" header file that defines
12** the programming interface to the SQLite library. (If you do not have
13** the "sqlite3.h" header file at hand, you will find a copy embedded within
14** the text of this file. Search for "Begin file sqlite3.h" to find the start
15** of the embedded sqlite3.h header file.) Additional code files may be needed
16** if you want a wrapper to interface SQLite with your choice of programming
17** language. The code for the "sqlite3" command-line shell is also in a
18** separate file. This file contains only code for the core SQLite library.
20#define SQLITE_CORE 1
23# define SQLITE_PRIVATE static
25/************** Begin file sqliteInt.h ***************************************/
27** 2001 September 15
29** The author disclaims copyright to this source code. In place of
30** a legal notice, here is a blessing:
32** May you do good and not evil.
33** May you find forgiveness for yourself and forgive others.
34** May you share freely, never taking more than you give.
37** Internal interface definitions for SQLite.
40#ifndef SQLITEINT_H
41#define SQLITEINT_H
43/* Special Comments:
45** Some comments have special meaning to the tools that measure test
46** coverage:
48** NO_TEST - The branches on this line are not
49** measured by branch coverage. This is
50** used on lines of code that actually
51** implement parts of coverage testing.
53** OPTIMIZATION-IF-TRUE - This branch is allowed to alway be false
54** and the correct answer is still obtained,
55** though perhaps more slowly.
57** OPTIMIZATION-IF-FALSE - This branch is allowed to alway be true
58** and the correct answer is still obtained,
59** though perhaps more slowly.
61** PREVENTS-HARMLESS-OVERREAD - This branch prevents a buffer overread
62** that would be harmless and undetectable
63** if it did occur.
65** In all cases, the special comment must be enclosed in the usual
66** slash-asterisk...asterisk-slash comment marks, with no spaces between the
67** asterisks and the comment text.
71** Make sure the Tcl calling convention macro is defined. This macro is
72** only used by test code and Tcl integration code.
75# define SQLITE_TCLAPI
79** Include the header file used to customize the compiler options for MSVC.
80** This should be done first so that it can successfully prevent spurious
81** compiler warnings due to subsequent content in this file and other files
82** that are included by this file.
84/************** Include msvc.h in the middle of sqliteInt.h ******************/
85/************** Begin file msvc.h ********************************************/
87** 2015 January 12
89** The author disclaims copyright to this source code. In place of
90** a legal notice, here is a blessing:
92** May you do good and not evil.
93** May you find forgiveness for yourself and forgive others.
94** May you share freely, never taking more than you give.
98** This file contains code that is specific to MSVC.
100#ifndef SQLITE_MSVC_H
101#define SQLITE_MSVC_H
103#if defined(_MSC_VER)
104#pragma warning(disable : 4054)
105#pragma warning(disable : 4055)
106#pragma warning(disable : 4100)
107#pragma warning(disable : 4127)
108#pragma warning(disable : 4130)
109#pragma warning(disable : 4152)
110#pragma warning(disable : 4189)
111#pragma warning(disable : 4206)
112#pragma warning(disable : 4210)
113#pragma warning(disable : 4232)
114#pragma warning(disable : 4244)
115#pragma warning(disable : 4305)
116#pragma warning(disable : 4306)
117#pragma warning(disable : 4702)
118#pragma warning(disable : 4706)
119#endif /* defined(_MSC_VER) */
121#if defined(_MSC_VER) && !defined(_WIN64)
124#endif /* defined(_MSC_VER) && !defined(_WIN64) */
126#endif /* SQLITE_MSVC_H */
128/************** End of msvc.h ************************************************/
129/************** Continuing where we left off in sqliteInt.h ******************/
132** Special setup for VxWorks
134/************** Include vxworks.h in the middle of sqliteInt.h ***************/
135/************** Begin file vxworks.h *****************************************/
137** 2015-03-02
139** The author disclaims copyright to this source code. In place of
140** a legal notice, here is a blessing:
142** May you do good and not evil.
143** May you find forgiveness for yourself and forgive others.
144** May you share freely, never taking more than you give.
148** This file contains code that is specific to Wind River's VxWorks
150#if defined(__RTP__) || defined(_WRS_KERNEL)
151/* This is VxWorks. Set up things specially for that OS
153#include <vxWorks.h>
154#include <pthread.h> /* amalgamator: dontcache */
155#define OS_VXWORKS 1
156#define SQLITE_OS_OTHER 0
160#define HAVE_UTIME 1
162/* This is not VxWorks. */
163#define OS_VXWORKS 0
164#define HAVE_FCHOWN 1
165#define HAVE_READLINK 1
166#define HAVE_LSTAT 1
167#endif /* defined(_WRS_KERNEL) */
169/************** End of vxworks.h *********************************************/
170/************** Continuing where we left off in sqliteInt.h ******************/
173** These #defines should enable >2GB file support on POSIX if the
174** underlying operating system supports it. If the OS lacks
175** large file support, or if the OS is windows, these should be no-ops.
177** Ticket #2739: The _LARGEFILE_SOURCE macro must appear before any
178** system #includes. Hence, this block of code must be the very first
179** code in all source files.
181** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
182** on the compiler command line. This is necessary if you are compiling
183** on a recent machine (ex: Red Hat 7.2) but you want your code to work
184** on an older machine (ex: Red Hat 6.0). If you compile on Red Hat 7.2
185** without this option, LFS is enable. But LFS does not exist in the kernel
186** in Red Hat 6.0, so the code won't work. Hence, for maximum binary
187** portability you should omit LFS.
189** The previous paragraph was written in 2005. (This paragraph is written
190** on 2008-11-28.) These days, all Linux kernels support large files, so
191** you should probably leave LFS enabled. But some embedded platforms might
192** lack LFS in which case the SQLITE_DISABLE_LFS macro might still be useful.
194** Similar is true for Mac OS X. LFS is only supported on Mac OS X 9 and later.
197# define _LARGE_FILE 1
198# ifndef _FILE_OFFSET_BITS
199# define _FILE_OFFSET_BITS 64
200# endif
201# define _LARGEFILE_SOURCE 1
204/* The GCC_VERSION and MSVC_VERSION macros are used to
205** conditionally include optimizations for each of these compilers. A
206** value of 0 means that compiler is not being used. The
207** SQLITE_DISABLE_INTRINSIC macro means do not use any compiler-specific
208** optimizations, and hence set all compiler macros to 0
210** There was once also a CLANG_VERSION macro. However, we learn that the
211** version numbers in clang are for "marketing" only and are inconsistent
212** and unreliable. Fortunately, all versions of clang also recognize the
213** gcc version numbers and have reasonable settings for gcc version numbers,
214** so the GCC_VERSION macro will be set to a correct non-zero value even
215** when compiling with clang.
217#if defined(__GNUC__) && !defined(SQLITE_DISABLE_INTRINSIC)
218# define GCC_VERSION (__GNUC__*1000000+__GNUC_MINOR__*1000+__GNUC_PATCHLEVEL__)
220# define GCC_VERSION 0
222#if defined(_MSC_VER) && !defined(SQLITE_DISABLE_INTRINSIC)
225# define MSVC_VERSION 0
229** Some C99 functions in "math.h" are only present for MSVC when its version
230** is associated with Visual Studio 2013 or higher.
233# if MSVC_VERSION==0 || MSVC_VERSION>=1800
234# define SQLITE_HAVE_C99_MATH_FUNCS (1)
235# else
236# define SQLITE_HAVE_C99_MATH_FUNCS (0)
237# endif
240/* Needed for various definitions... */
241#if defined(__GNUC__) && !defined(_GNU_SOURCE)
242# define _GNU_SOURCE
245#if defined(__OpenBSD__) && !defined(_BSD_SOURCE)
246# define _BSD_SOURCE
250** Macro to disable warnings about missing "break" at the end of a "case".
252#if GCC_VERSION>=7000000
253# define deliberate_fall_through __attribute__((fallthrough));
255# define deliberate_fall_through
259** For MinGW, check to see if we can include the header file containing its
260** version information, among other things. Normally, this internal MinGW
261** header file would [only] be included automatically by other MinGW header
262** files; however, the contained version information is now required by this
263** header file to work around binary compatibility issues (see below) and
264** this is the only known way to reliably obtain it. This entire #if block
265** would be completely unnecessary if there was any other way of detecting
266** MinGW via their preprocessor (e.g. if they customized their GCC to define
267** some MinGW-specific macros). When compiling for MinGW, either the
268** _HAVE_MINGW_H or _HAVE__MINGW_H (note the extra underscore) macro must be
269** defined; otherwise, detection of conditions specific to MinGW will be
270** disabled.
272#if defined(_HAVE_MINGW_H)
273# include "mingw.h"
274#elif defined(_HAVE__MINGW_H)
275# include "_mingw.h"
279** For MinGW version 4.x (and higher), check to see if the _USE_32BIT_TIME_T
280** define is required to maintain binary compatibility with the MSVC runtime
281** library in use (e.g. for Windows XP).
283#if !defined(_USE_32BIT_TIME_T) && !defined(_USE_64BIT_TIME_T) && \
284 defined(_WIN32) && !defined(_WIN64) && \
285 defined(__MINGW_MAJOR_VERSION) && __MINGW_MAJOR_VERSION >= 4 && \
286 defined(__MSVCRT__)
287# define _USE_32BIT_TIME_T
290/* Optionally #include a user-defined header, whereby compilation options
291** may be set prior to where they take effect, but after platform setup.
292** If SQLITE_CUSTOM_INCLUDE=? is defined, its value names the #include
293** file.
296# define INC_STRINGIFY_(f) #f
301/* The public SQLite interface. The _FILE_OFFSET_BITS macro must appear
302** first in QNX. Also, the _USE_32BIT_TIME_T macro must appear first for
303** MinGW.
305/************** Include sqlite3.h in the middle of sqliteInt.h ***************/
306/************** Begin file sqlite3.h *****************************************/
308** 2001-09-15
310** The author disclaims copyright to this source code. In place of
311** a legal notice, here is a blessing:
313** May you do good and not evil.
314** May you find forgiveness for yourself and forgive others.
315** May you share freely, never taking more than you give.
318** This header file defines the interface that the SQLite library
319** presents to client programs. If a C-function, structure, datatype,
320** or constant definition does not appear in this file, then it is
321** not a published API of SQLite, is subject to change without
322** notice, and should not be referenced by programs that use SQLite.
324** Some of the definitions that are in this file are marked as
325** "experimental". Experimental interfaces are normally new
326** features recently added to SQLite. We do not anticipate changes
327** to experimental interfaces but reserve the right to make minor changes
328** if experience from use "in the wild" suggest such changes are prudent.
330** The official C-language API documentation for SQLite is derived
331** from comments in this file. This file is the authoritative source
332** on how SQLite interfaces are supposed to operate.
334** The name of this file under configuration management is "sqlite.h.in".
335** The makefile makes some minor changes to this file (such as inserting
336** the version number) and changes its name to "sqlite3.h" as
337** part of the build process.
339#ifndef SQLITE3_H
340#define SQLITE3_H
341#include <stdarg.h> /* Needed for the definition of va_list */
344** Make sure we can call this stuff from C++.
346#if 0
347extern "C" {
352** Facilitate override of interface linkage and calling conventions.
353** Be aware that these macros may not be used within this particular
354** translation of the amalgamation and its associated header file.
356** The SQLITE_EXTERN and SQLITE_API macros are used to instruct the
357** compiler that the target identifier should have external linkage.
359** The SQLITE_CDECL macro is used to set the calling convention for
360** public functions that accept a variable number of arguments.
362** The SQLITE_APICALL macro is used to set the calling convention for
363** public functions that accept a fixed number of arguments.
365** The SQLITE_STDCALL macro is no longer used and is now deprecated.
367** The SQLITE_CALLBACK macro is used to set the calling convention for
368** function pointers.
370** The SQLITE_SYSAPI macro is used to set the calling convention for
371** functions provided by the operating system.
374** SQLITE_SYSAPI macros are used only when building for environments
375** that require non-default calling conventions.
377#ifndef SQLITE_EXTERN
378# define SQLITE_EXTERN extern
380#ifndef SQLITE_API
381# define SQLITE_API
383#ifndef SQLITE_CDECL
384# define SQLITE_CDECL
387# define SQLITE_APICALL
395#ifndef SQLITE_SYSAPI
396# define SQLITE_SYSAPI
400** These no-op macros are used in front of interfaces to mark those
401** interfaces as either deprecated or experimental. New applications
402** should not use deprecated interfaces - they are supported for backwards
403** compatibility only. Application writers should be aware that
404** experimental interfaces are subject to change in point releases.
406** These macros used to resolve to various kinds of compiler magic that
407** would generate warning messages when they were used. But that
408** compiler magic ended up generating such a flurry of bug reports
409** that we have taken it all out and gone back to using simple
410** noop macros.
416** Ensure these symbols were not defined by some previous header file.
426** CAPI3REF: Compile-Time Library Version Numbers
428** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header
429** evaluates to a string literal that is the SQLite version in the
430** format "X.Y.Z" where X is the major version number (always 3 for
431** SQLite3) and Y is the minor version number and Z is the release number.)^
432** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer
433** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z are the same
434** numbers used in [SQLITE_VERSION].)^
435** The SQLITE_VERSION_NUMBER for any given release of SQLite will also
436** be larger than the release from which it is derived. Either Y will
437** be held constant and Z will be incremented or else Y will be incremented
438** and Z will be reset to zero.
440** Since [version 3.6.18] ([dateof:3.6.18]),
441** SQLite source code has been stored in the
442** <a href="http://www.fossil-scm.org/">Fossil configuration management
443** system</a>. ^The SQLITE_SOURCE_ID macro evaluates to
444** a string which identifies a particular check-in of SQLite
445** within its configuration management system. ^The SQLITE_SOURCE_ID
446** string contains the date and time of the check-in (UTC) and a SHA1
447** or SHA3-256 hash of the entire source tree. If the source code has
448** been edited in any way since it was last checked in, then the last
449** four hexadecimal digits of the hash may be modified.
451** See also: [sqlite3_libversion()],
452** [sqlite3_libversion_number()], [sqlite3_sourceid()],
453** [sqlite_version()] and [sqlite_source_id()].
455#define SQLITE_VERSION "3.37.2"
456#define SQLITE_VERSION_NUMBER 3037002
457#define SQLITE_SOURCE_ID "2022-01-06 13:25:41 872ba256cbf61d9290b571c0e6d82a20c224ca3ad82971edc46b29818d5d17a0"
460** CAPI3REF: Run-Time Library Version Numbers
461** KEYWORDS: sqlite3_version sqlite3_sourceid
463** These interfaces provide the same information as the [SQLITE_VERSION],
464** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros
465** but are associated with the library instead of the header file. ^(Cautious
466** programmers might include assert() statements in their application to
467** verify that values returned by these interfaces match the macros in
468** the header, and thus ensure that the application is
469** compiled with matching library and header files.
471** <blockquote><pre>
472** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER );
473** assert( strncmp(sqlite3_sourceid(),SQLITE_SOURCE_ID,80)==0 );
474** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 );
475** </pre></blockquote>)^
477** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION]
478** macro. ^The sqlite3_libversion() function returns a pointer to the
479** to the sqlite3_version[] string constant. The sqlite3_libversion()
480** function is provided for use in DLLs since DLL users usually do not have
481** direct access to string constants within the DLL. ^The
482** sqlite3_libversion_number() function returns an integer equal to
483** [SQLITE_VERSION_NUMBER]. ^(The sqlite3_sourceid() function returns
484** a pointer to a string constant whose value is the same as the
485** [SQLITE_SOURCE_ID] C preprocessor macro. Except if SQLite is built
486** using an edited copy of [the amalgamation], then the last four characters
487** of the hash might be different from [SQLITE_SOURCE_ID].)^
489** See also: [sqlite_version()] and [sqlite_source_id()].
491SQLITE_API const char sqlite3_version[] = SQLITE_VERSION;
492SQLITE_API const char *sqlite3_libversion(void);
493SQLITE_API const char *sqlite3_sourceid(void);
494SQLITE_API int sqlite3_libversion_number(void);
497** CAPI3REF: Run-Time Library Compilation Options Diagnostics
499** ^The sqlite3_compileoption_used() function returns 0 or 1
500** indicating whether the specified option was defined at
501** compile time. ^The SQLITE_ prefix may be omitted from the
502** option name passed to sqlite3_compileoption_used().
504** ^The sqlite3_compileoption_get() function allows iterating
505** over the list of options that were defined at compile time by
506** returning the N-th compile time option string. ^If N is out of range,
507** sqlite3_compileoption_get() returns a NULL pointer. ^The SQLITE_
508** prefix is omitted from any strings returned by
509** sqlite3_compileoption_get().
511** ^Support for the diagnostic functions sqlite3_compileoption_used()
512** and sqlite3_compileoption_get() may be omitted by specifying the
513** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time.
515** See also: SQL functions [sqlite_compileoption_used()] and
516** [sqlite_compileoption_get()] and the [compile_options pragma].
519SQLITE_API int sqlite3_compileoption_used(const char *zOptName);
520SQLITE_API const char *sqlite3_compileoption_get(int N);
522# define sqlite3_compileoption_used(X) 0
523# define sqlite3_compileoption_get(X) ((void*)0)
527** CAPI3REF: Test To See If The Library Is Threadsafe
529** ^The sqlite3_threadsafe() function returns zero if and only if
530** SQLite was compiled with mutexing code omitted due to the
531** [SQLITE_THREADSAFE] compile-time option being set to 0.
533** SQLite can be compiled with or without mutexes. When
534** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes
535** are enabled and SQLite is threadsafe. When the
536** [SQLITE_THREADSAFE] macro is 0,
537** the mutexes are omitted. Without the mutexes, it is not safe
538** to use SQLite concurrently from more than one thread.
540** Enabling mutexes incurs a measurable performance penalty.
541** So if speed is of utmost importance, it makes sense to disable
542** the mutexes. But for maximum safety, mutexes should be enabled.
543** ^The default behavior is for mutexes to be enabled.
545** This interface can be used by an application to make sure that the
546** version of SQLite that it is linking against was compiled with
547** the desired setting of the [SQLITE_THREADSAFE] macro.
549** This interface only reports on the compile-time mutex setting
550** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with
551** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but
552** can be fully or partially disabled using a call to [sqlite3_config()]
554** or [SQLITE_CONFIG_SERIALIZED]. ^(The return value of the
555** sqlite3_threadsafe() function shows only the compile-time setting of
556** thread safety, not any run-time changes to that setting made by
557** sqlite3_config(). In other words, the return value from sqlite3_threadsafe()
558** is unchanged by calls to sqlite3_config().)^
560** See the [threading mode] documentation for additional information.
562SQLITE_API int sqlite3_threadsafe(void);
565** CAPI3REF: Database Connection Handle
566** KEYWORDS: {database connection} {database connections}
568** Each open SQLite database is represented by a pointer to an instance of
569** the opaque structure named "sqlite3". It is useful to think of an sqlite3
570** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and
571** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()]
572** and [sqlite3_close_v2()] are its destructors. There are many other
573** interfaces (such as
574** [sqlite3_prepare_v2()], [sqlite3_create_function()], and
575** [sqlite3_busy_timeout()] to name but three) that are methods on an
576** sqlite3 object.
578typedef struct sqlite3 sqlite3;
581** CAPI3REF: 64-Bit Integer Types
582** KEYWORDS: sqlite_int64 sqlite_uint64
584** Because there is no cross-platform way to specify 64-bit integer types
585** SQLite includes typedefs for 64-bit signed and unsigned integers.
587** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions.
588** The sqlite_int64 and sqlite_uint64 types are supported for backwards
589** compatibility only.
591** ^The sqlite3_int64 and sqlite_int64 types can store integer values
592** between -9223372036854775808 and +9223372036854775807 inclusive. ^The
593** sqlite3_uint64 and sqlite_uint64 types can store integer values
594** between 0 and +18446744073709551615 inclusive.
596#ifdef SQLITE_INT64_TYPE
597 typedef SQLITE_INT64_TYPE sqlite_int64;
598# ifdef SQLITE_UINT64_TYPE
599 typedef SQLITE_UINT64_TYPE sqlite_uint64;
600# else
601 typedef unsigned SQLITE_INT64_TYPE sqlite_uint64;
602# endif
603#elif defined(_MSC_VER) || defined(__BORLANDC__)
604 typedef __int64 sqlite_int64;
605 typedef unsigned __int64 sqlite_uint64;
607 typedef long long int sqlite_int64;
608 typedef unsigned long long int sqlite_uint64;
610typedef sqlite_int64 sqlite3_int64;
611typedef sqlite_uint64 sqlite3_uint64;
614** If compiling for a processor that lacks floating point support,
615** substitute integer for floating-point.
618# define double sqlite3_int64
622** CAPI3REF: Closing A Database Connection
623** DESTRUCTOR: sqlite3
625** ^The sqlite3_close() and sqlite3_close_v2() routines are destructors
626** for the [sqlite3] object.
627** ^Calls to sqlite3_close() and sqlite3_close_v2() return [SQLITE_OK] if
628** the [sqlite3] object is successfully destroyed and all associated
629** resources are deallocated.
631** Ideally, applications should [sqlite3_finalize | finalize] all
632** [prepared statements], [sqlite3_blob_close | close] all [BLOB handles], and
633** [sqlite3_backup_finish | finish] all [sqlite3_backup] objects associated
634** with the [sqlite3] object prior to attempting to close the object.
635** ^If the database connection is associated with unfinalized prepared
636** statements, BLOB handlers, and/or unfinished sqlite3_backup objects then
637** sqlite3_close() will leave the database connection open and return
638** [SQLITE_BUSY]. ^If sqlite3_close_v2() is called with unfinalized prepared
639** statements, unclosed BLOB handlers, and/or unfinished sqlite3_backups,
640** it returns [SQLITE_OK] regardless, but instead of deallocating the database
641** connection immediately, it marks the database connection as an unusable
642** "zombie" and makes arrangements to automatically deallocate the database
643** connection after all prepared statements are finalized, all BLOB handles
644** are closed, and all backups have finished. The sqlite3_close_v2() interface
645** is intended for use with host languages that are garbage collected, and
646** where the order in which destructors are called is arbitrary.
648** ^If an [sqlite3] object is destroyed while a transaction is open,
649** the transaction is automatically rolled back.
651** The C parameter to [sqlite3_close(C)] and [sqlite3_close_v2(C)]
652** must be either a NULL
653** pointer or an [sqlite3] object pointer obtained
654** from [sqlite3_open()], [sqlite3_open16()], or
655** [sqlite3_open_v2()], and not previously closed.
656** ^Calling sqlite3_close() or sqlite3_close_v2() with a NULL pointer
657** argument is a harmless no-op.
659SQLITE_API int sqlite3_close(sqlite3*);
660SQLITE_API int sqlite3_close_v2(sqlite3*);
663** The type for a callback function.
664** This is legacy and deprecated. It is included for historical
665** compatibility and is not documented.
667typedef int (*sqlite3_callback)(void*,int,char**, char**);
670** CAPI3REF: One-Step Query Execution Interface
671** METHOD: sqlite3
673** The sqlite3_exec() interface is a convenience wrapper around
674** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()],
675** that allows an application to run multiple statements of SQL
676** without having to use a lot of C code.
678** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded,
679** semicolon-separate SQL statements passed into its 2nd argument,
680** in the context of the [database connection] passed in as its 1st
681** argument. ^If the callback function of the 3rd argument to
682** sqlite3_exec() is not NULL, then it is invoked for each result row
683** coming out of the evaluated SQL statements. ^The 4th argument to
684** sqlite3_exec() is relayed through to the 1st argument of each
685** callback invocation. ^If the callback pointer to sqlite3_exec()
686** is NULL, then no callback is ever invoked and result rows are
687** ignored.
689** ^If an error occurs while evaluating the SQL statements passed into
690** sqlite3_exec(), then execution of the current statement stops and
691** subsequent statements are skipped. ^If the 5th parameter to sqlite3_exec()
692** is not NULL then any error message is written into memory obtained
693** from [sqlite3_malloc()] and passed back through the 5th parameter.
694** To avoid memory leaks, the application should invoke [sqlite3_free()]
695** on error message strings returned through the 5th parameter of
696** sqlite3_exec() after the error message string is no longer needed.
697** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors
698** occur, then sqlite3_exec() sets the pointer in its 5th parameter to
699** NULL before returning.
701** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec()
702** routine returns SQLITE_ABORT without invoking the callback again and
703** without running any subsequent SQL statements.
705** ^The 2nd argument to the sqlite3_exec() callback function is the
706** number of columns in the result. ^The 3rd argument to the sqlite3_exec()
707** callback is an array of pointers to strings obtained as if from
708** [sqlite3_column_text()], one for each column. ^If an element of a
709** result row is NULL then the corresponding string pointer for the
710** sqlite3_exec() callback is a NULL pointer. ^The 4th argument to the
711** sqlite3_exec() callback is an array of pointers to strings where each
712** entry represents the name of corresponding result column as obtained
713** from [sqlite3_column_name()].
715** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer
716** to an empty string, or a pointer that contains only whitespace and/or
717** SQL comments, then no SQL statements are evaluated and the database
718** is not changed.
720** Restrictions:
722** <ul>
723** <li> The application must ensure that the 1st parameter to sqlite3_exec()
724** is a valid and open [database connection].
725** <li> The application must not close the [database connection] specified by
726** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running.
727** <li> The application must not modify the SQL statement text passed into
728** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running.
729** </ul>
731SQLITE_API int sqlite3_exec(
732 sqlite3*, /* An open database */
733 const char *sql, /* SQL to be evaluated */
734 int (*callback)(void*,int,char**,char**), /* Callback function */
735 void *, /* 1st argument to callback */
736 char **errmsg /* Error msg written here */
740** CAPI3REF: Result Codes
741** KEYWORDS: {result code definitions}
743** Many SQLite functions return an integer result code from the set shown
744** here in order to indicate success or failure.
746** New error codes may be added in future versions of SQLite.
748** See also: [extended result code definitions]
750#define SQLITE_OK 0 /* Successful result */
751/* beginning-of-error-codes */
752#define SQLITE_ERROR 1 /* Generic error */
753#define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */
754#define SQLITE_PERM 3 /* Access permission denied */
755#define SQLITE_ABORT 4 /* Callback routine requested an abort */
756#define SQLITE_BUSY 5 /* The database file is locked */
757#define SQLITE_LOCKED 6 /* A table in the database is locked */
758#define SQLITE_NOMEM 7 /* A malloc() failed */
759#define SQLITE_READONLY 8 /* Attempt to write a readonly database */
760#define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/
761#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */
762#define SQLITE_CORRUPT 11 /* The database disk image is malformed */
763#define SQLITE_NOTFOUND 12 /* Unknown opcode in sqlite3_file_control() */
764#define SQLITE_FULL 13 /* Insertion failed because database is full */
765#define SQLITE_CANTOPEN 14 /* Unable to open the database file */
766#define SQLITE_PROTOCOL 15 /* Database lock protocol error */
767#define SQLITE_EMPTY 16 /* Internal use only */
768#define SQLITE_SCHEMA 17 /* The database schema changed */
769#define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */
770#define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */
771#define SQLITE_MISMATCH 20 /* Data type mismatch */
772#define SQLITE_MISUSE 21 /* Library used incorrectly */
773#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */
774#define SQLITE_AUTH 23 /* Authorization denied */
775#define SQLITE_FORMAT 24 /* Not used */
776#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */
777#define SQLITE_NOTADB 26 /* File opened that is not a database file */
778#define SQLITE_NOTICE 27 /* Notifications from sqlite3_log() */
779#define SQLITE_WARNING 28 /* Warnings from sqlite3_log() */
780#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */
781#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */
782/* end-of-error-codes */
785** CAPI3REF: Extended Result Codes
786** KEYWORDS: {extended result code definitions}
788** In its default configuration, SQLite API routines return one of 30 integer
789** [result codes]. However, experience has shown that many of
790** these result codes are too coarse-grained. They do not provide as
791** much information about problems as programmers might like. In an effort to
792** address this, newer versions of SQLite (version 3.3.8 [dateof:3.3.8]
793** and later) include
794** support for additional result codes that provide more detailed information
795** about errors. These [extended result codes] are enabled or disabled
796** on a per database connection basis using the
797** [sqlite3_extended_result_codes()] API. Or, the extended code for
798** the most recent error can be obtained using
799** [sqlite3_extended_errcode()].
804#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8))
815#define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8))
818#define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8))
819#define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8))
825#define SQLITE_IOERR_SEEK (SQLITE_IOERR | (22<<8))
827#define SQLITE_IOERR_MMAP (SQLITE_IOERR | (24<<8))
830#define SQLITE_IOERR_VNODE (SQLITE_IOERR | (27<<8))
831#define SQLITE_IOERR_AUTH (SQLITE_IOERR | (28<<8))
835#define SQLITE_IOERR_DATA (SQLITE_IOERR | (32<<8))
846#define SQLITE_CANTOPEN_DIRTYWAL (SQLITE_CANTOPEN | (5<<8)) /* Not Used */
873#define SQLITE_AUTH_USER (SQLITE_AUTH | (1<<8))
875#define SQLITE_OK_SYMLINK (SQLITE_OK | (2<<8))
878** CAPI3REF: Flags For File Open Operations
880** These bit values are intended for use in the
881** 3rd parameter to the [sqlite3_open_v2()] interface and
882** in the 4th parameter to the [sqlite3_vfs.xOpen] method.
884** Only those flags marked as "Ok for sqlite3_open_v2()" may be
885** used as the third argument to the [sqlite3_open_v2()] interface.
886** The other flags have historically been ignored by sqlite3_open_v2(),
887** though future versions of SQLite might change so that an error is
888** raised if any of the disallowed bits are passed into sqlite3_open_v2().
889** Applications should not depend on the historical behavior.
891** Note in particular that passing the SQLITE_OPEN_EXCLUSIVE flag into
892** [sqlite3_open_v2()] does *not* cause the underlying database file
893** to be opened using O_EXCL. Passing SQLITE_OPEN_EXCLUSIVE into
894** [sqlite3_open_v2()] has historically be a no-op and might become an
895** error in future versions of SQLite.
897#define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */
898#define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */
899#define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */
900#define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */
901#define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */
902#define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */
903#define SQLITE_OPEN_URI 0x00000040 /* Ok for sqlite3_open_v2() */
904#define SQLITE_OPEN_MEMORY 0x00000080 /* Ok for sqlite3_open_v2() */
905#define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */
906#define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */
907#define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */
908#define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */
909#define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */
910#define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */
911#define SQLITE_OPEN_SUPER_JOURNAL 0x00004000 /* VFS only */
912#define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */
913#define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */
914#define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */
915#define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */
916#define SQLITE_OPEN_WAL 0x00080000 /* VFS only */
917#define SQLITE_OPEN_NOFOLLOW 0x01000000 /* Ok for sqlite3_open_v2() */
918#define SQLITE_OPEN_EXRESCODE 0x02000000 /* Extended result codes */
920/* Reserved: 0x00F00000 */
921/* Legacy compatibility: */
922#define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */
926** CAPI3REF: Device Characteristics
928** The xDeviceCharacteristics method of the [sqlite3_io_methods]
929** object returns an integer which is a vector of these
930** bit values expressing I/O characteristics of the mass storage
931** device that holds the file that the [sqlite3_io_methods]
932** refers to.
934** The SQLITE_IOCAP_ATOMIC property means that all writes of
935** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
936** mean that writes of blocks that are nnn bytes in size and
937** are aligned to an address which is an integer multiple of
938** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
939** that when data is appended to a file, the data is appended
940** first then the size of the file is extended, never the other
941** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
942** information is written to disk in the same order as calls
943** to xWrite(). The SQLITE_IOCAP_POWERSAFE_OVERWRITE property means that
944** after reboot following a crash or power loss, the only bytes in a
945** file that were written at the application level might have changed
946** and that adjacent bytes, even bytes within the same sector are
947** guaranteed to be unchanged. The SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN
948** flag indicates that a file cannot be deleted when open. The
949** SQLITE_IOCAP_IMMUTABLE flag indicates that the file is on
950** read-only media and cannot be changed even by processes with
951** elevated privileges.
953** The SQLITE_IOCAP_BATCH_ATOMIC property means that the underlying
954** filesystem supports doing multiple write operations atomically when those
955** write operations are bracketed by [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] and
958#define SQLITE_IOCAP_ATOMIC 0x00000001
959#define SQLITE_IOCAP_ATOMIC512 0x00000002
960#define SQLITE_IOCAP_ATOMIC1K 0x00000004
961#define SQLITE_IOCAP_ATOMIC2K 0x00000008
962#define SQLITE_IOCAP_ATOMIC4K 0x00000010
963#define SQLITE_IOCAP_ATOMIC8K 0x00000020
964#define SQLITE_IOCAP_ATOMIC16K 0x00000040
965#define SQLITE_IOCAP_ATOMIC32K 0x00000080
966#define SQLITE_IOCAP_ATOMIC64K 0x00000100
967#define SQLITE_IOCAP_SAFE_APPEND 0x00000200
968#define SQLITE_IOCAP_SEQUENTIAL 0x00000400
971#define SQLITE_IOCAP_IMMUTABLE 0x00002000
972#define SQLITE_IOCAP_BATCH_ATOMIC 0x00004000
975** CAPI3REF: File Locking Levels
977** SQLite uses one of these integer values as the second
978** argument to calls it makes to the xLock() and xUnlock() methods
979** of an [sqlite3_io_methods] object.
981#define SQLITE_LOCK_NONE 0
988** CAPI3REF: Synchronization Type Flags
990** When SQLite invokes the xSync() method of an
991** [sqlite3_io_methods] object it uses a combination of
992** these integer values as the second argument.
994** When the SQLITE_SYNC_DATAONLY flag is used, it means that the
995** sync operation only needs to flush data to mass storage. Inode
996** information need not be flushed. If the lower four bits of the flag
997** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics.
998** If the lower four bits equal SQLITE_SYNC_FULL, that means
999** to use Mac OS X style fullsync instead of fsync().
1001** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags
1002** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL
1003** settings. The [synchronous pragma] determines when calls to the
1004** xSync VFS method occur and applies uniformly across all platforms.
1005** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how
1006** energetic or rigorous or forceful the sync operations are and
1007** only make a difference on Mac OSX for the default SQLite code.
1008** (Third-party VFS implementations might also make the distinction
1009** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the
1010** operating systems natively supported by SQLite, only Mac OSX
1011** cares about the difference.)
1013#define SQLITE_SYNC_NORMAL 0x00002
1014#define SQLITE_SYNC_FULL 0x00003
1015#define SQLITE_SYNC_DATAONLY 0x00010
1018** CAPI3REF: OS Interface Open File Handle
1020** An [sqlite3_file] object represents an open file in the
1021** [sqlite3_vfs | OS interface layer]. Individual OS interface
1022** implementations will
1023** want to subclass this object by appending additional fields
1024** for their own use. The pMethods entry is a pointer to an
1025** [sqlite3_io_methods] object that defines methods for performing
1026** I/O operations on the open file.
1028typedef struct sqlite3_file sqlite3_file;
1029struct sqlite3_file {
1030 const struct sqlite3_io_methods *pMethods; /* Methods for an open file */
1034** CAPI3REF: OS Interface File Virtual Methods Object
1036** Every file opened by the [sqlite3_vfs.xOpen] method populates an
1037** [sqlite3_file] object (or, more commonly, a subclass of the
1038** [sqlite3_file] object) with a pointer to an instance of this object.
1039** This object defines the methods used to perform various operations
1040** against the open file represented by the [sqlite3_file] object.
1042** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element
1043** to a non-NULL pointer, then the sqlite3_io_methods.xClose method
1044** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed. The
1045** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen]
1046** is for the [sqlite3_vfs.xOpen] to set the sqlite3_file.pMethods element
1047** to NULL.
1049** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or
1050** [SQLITE_SYNC_FULL]. The first choice is the normal fsync().
1051** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY]
1052** flag may be ORed in to indicate that only the data of the file
1053** and not its inode needs to be synced.
1055** The integer values to xLock() and xUnlock() are one of
1056** <ul>
1057** <li> [SQLITE_LOCK_NONE],
1058** <li> [SQLITE_LOCK_SHARED],
1060** <li> [SQLITE_LOCK_PENDING], or
1062** </ul>
1063** xLock() increases the lock. xUnlock() decreases the lock.
1064** The xCheckReservedLock() method checks whether any database connection,
1065** either in this process or in some other process, is holding a RESERVED,
1066** PENDING, or EXCLUSIVE lock on the file. It returns true
1067** if such a lock exists and false otherwise.
1069** The xFileControl() method is a generic interface that allows custom
1070** VFS implementations to directly control an open file using the
1071** [sqlite3_file_control()] interface. The second "op" argument is an
1072** integer opcode. The third argument is a generic pointer intended to
1073** point to a structure that may contain arguments or space in which to
1074** write return values. Potential uses for xFileControl() might be
1075** functions to enable blocking locks with timeouts, to change the
1076** locking strategy (for example to use dot-file locks), to inquire
1077** about the status of a lock, or to break stale locks. The SQLite
1078** core reserves all opcodes less than 100 for its own use.
1079** A [file control opcodes | list of opcodes] less than 100 is available.
1080** Applications that define a custom xFileControl method should use opcodes
1081** greater than 100 to avoid conflicts. VFS implementations should
1082** return [SQLITE_NOTFOUND] for file control opcodes that they do not
1083** recognize.
1085** The xSectorSize() method returns the sector size of the
1086** device that underlies the file. The sector size is the
1087** minimum write that can be performed without disturbing
1088** other bytes in the file. The xDeviceCharacteristics()
1089** method returns a bit vector describing behaviors of the
1090** underlying device:
1092** <ul>
1094** <li> [SQLITE_IOCAP_ATOMIC512]
1099** <li> [SQLITE_IOCAP_ATOMIC16K]
1100** <li> [SQLITE_IOCAP_ATOMIC32K]
1101** <li> [SQLITE_IOCAP_ATOMIC64K]
1108** </ul>
1110** The SQLITE_IOCAP_ATOMIC property means that all writes of
1111** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
1112** mean that writes of blocks that are nnn bytes in size and
1113** are aligned to an address which is an integer multiple of
1114** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
1115** that when data is appended to a file, the data is appended
1116** first then the size of the file is extended, never the other
1117** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
1118** information is written to disk in the same order as calls
1119** to xWrite().
1121** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill
1122** in the unread portions of the buffer with zeros. A VFS that
1123** fails to zero-fill short reads might seem to work. However,
1124** failure to zero-fill short reads will eventually lead to
1125** database corruption.
1127typedef struct sqlite3_io_methods sqlite3_io_methods;
1128struct sqlite3_io_methods {
1129 int iVersion;
1130 int (*xClose)(sqlite3_file*);
1131 int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst);
1132 int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst);
1133 int (*xTruncate)(sqlite3_file*, sqlite3_int64 size);
1134 int (*xSync)(sqlite3_file*, int flags);
1135 int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize);
1136 int (*xLock)(sqlite3_file*, int);
1137 int (*xUnlock)(sqlite3_file*, int);
1138 int (*xCheckReservedLock)(sqlite3_file*, int *pResOut);
1139 int (*xFileControl)(sqlite3_file*, int op, void *pArg);
1140 int (*xSectorSize)(sqlite3_file*);
1141 int (*xDeviceCharacteristics)(sqlite3_file*);
1142 /* Methods above are valid for version 1 */
1143 int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, void volatile**);
1144 int (*xShmLock)(sqlite3_file*, int offset, int n, int flags);
1145 void (*xShmBarrier)(sqlite3_file*);
1146 int (*xShmUnmap)(sqlite3_file*, int deleteFlag);
1147 /* Methods above are valid for version 2 */
1148 int (*xFetch)(sqlite3_file*, sqlite3_int64 iOfst, int iAmt, void **pp);
1149 int (*xUnfetch)(sqlite3_file*, sqlite3_int64 iOfst, void *p);
1150 /* Methods above are valid for version 3 */
1151 /* Additional methods may be added in future releases */
1155** CAPI3REF: Standard File Control Opcodes
1156** KEYWORDS: {file control opcodes} {file control opcode}
1158** These integer constants are opcodes for the xFileControl method
1159** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()]
1160** interface.
1162** <ul>
1164** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This
1165** opcode causes the xFileControl method to write the current state of
1166** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED],
1168** into an integer that the pArg argument points to. This capability
1169** is used during testing and is only available when the SQLITE_TEST
1170** compile-time option is used.
1173** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS
1174** layer a hint of how large the database file will grow to be during the
1175** current transaction. This hint is not guaranteed to be accurate but it
1176** is often close. The underlying VFS might choose to preallocate database
1177** file space based on this hint in order to help writes to the database
1178** file run faster.
1181** The [SQLITE_FCNTL_SIZE_LIMIT] opcode is used by in-memory VFS that
1182** implements [sqlite3_deserialize()] to set an upper bound on the size
1183** of the in-memory database. The argument is a pointer to a [sqlite3_int64].
1184** If the integer pointed to is negative, then it is filled in with the
1185** current limit. Otherwise the limit is set to the larger of the value
1186** of the integer pointed to and the current database size. The integer
1187** pointed to is set to the new limit.
1190** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS
1191** extends and truncates the database file in chunks of a size specified
1192** by the user. The fourth argument to [sqlite3_file_control()] should
1193** point to an integer (type int) containing the new chunk-size to use
1194** for the nominated database. Allocating database file space in large
1195** chunks (say 1MB at a time), may reduce file-system fragmentation and
1196** improve performance on some systems.
1199** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer
1200** to the [sqlite3_file] object associated with a particular database
1201** connection. See also [SQLITE_FCNTL_JOURNAL_POINTER].
1204** The [SQLITE_FCNTL_JOURNAL_POINTER] opcode is used to obtain a pointer
1205** to the [sqlite3_file] object associated with the journal file (either
1206** the [rollback journal] or the [write-ahead log]) for a particular database
1207** connection. See also [SQLITE_FCNTL_FILE_POINTER].
1210** No longer in use.
1212** <li>[[SQLITE_FCNTL_SYNC]]
1213** The [SQLITE_FCNTL_SYNC] opcode is generated internally by SQLite and
1214** sent to the VFS immediately before the xSync method is invoked on a
1215** database file descriptor. Or, if the xSync method is not invoked
1216** because the user has configured SQLite with
1217** [PRAGMA synchronous | PRAGMA synchronous=OFF] it is invoked in place
1218** of the xSync method. In most cases, the pointer argument passed with
1219** this file-control is NULL. However, if the database file is being synced
1220** as part of a multi-database commit, the argument points to a nul-terminated
1221** string containing the transactions super-journal file name. VFSes that
1222** do not need this signal should silently ignore this opcode. Applications
1223** should not call [sqlite3_file_control()] with this opcode as doing so may
1224** disrupt the operation of the specialized VFSes that do require it.
1227** The [SQLITE_FCNTL_COMMIT_PHASETWO] opcode is generated internally by SQLite
1228** and sent to the VFS after a transaction has been committed immediately
1229** but before the database is unlocked. VFSes that do not need this signal
1230** should silently ignore this opcode. Applications should not call
1231** [sqlite3_file_control()] with this opcode as doing so may disrupt the
1232** operation of the specialized VFSes that do require it.
1234** <li>[[SQLITE_FCNTL_WIN32_AV_RETRY]]
1235** ^The [SQLITE_FCNTL_WIN32_AV_RETRY] opcode is used to configure automatic
1236** retry counts and intervals for certain disk I/O operations for the
1237** windows [VFS] in order to provide robustness in the presence of
1238** anti-virus programs. By default, the windows VFS will retry file read,
1239** file write, and file delete operations up to 10 times, with a delay
1240** of 25 milliseconds before the first retry and with the delay increasing
1241** by an additional 25 milliseconds with each subsequent retry. This
1242** opcode allows these two values (10 retries and 25 milliseconds of delay)
1243** to be adjusted. The values are changed for all database connections
1244** within the same process. The argument is a pointer to an array of two
1245** integers where the first integer is the new retry count and the second
1246** integer is the delay. If either integer is negative, then the setting
1247** is not changed but instead the prior value of that setting is written
1248** into the array entry, allowing the current retry settings to be
1249** interrogated. The zDbName parameter is ignored.
1252** ^The [SQLITE_FCNTL_PERSIST_WAL] opcode is used to set or query the
1253** persistent [WAL | Write Ahead Log] setting. By default, the auxiliary
1254** write ahead log ([WAL file]) and shared memory
1255** files used for transaction control
1256** are automatically deleted when the latest connection to the database
1257** closes. Setting persistent WAL mode causes those files to persist after
1258** close. Persisting the files is useful when other processes that do not
1259** have write permission on the directory containing the database file want
1260** to read the database file, as the WAL and shared memory files must exist
1261** in order for the database to be readable. The fourth parameter to
1262** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
1263** That integer is 0 to disable persistent WAL mode or 1 to enable persistent
1264** WAL mode. If the integer is -1, then it is overwritten with the current
1265** WAL persistence setting.
1268** ^The [SQLITE_FCNTL_POWERSAFE_OVERWRITE] opcode is used to set or query the
1269** persistent "powersafe-overwrite" or "PSOW" setting. The PSOW setting
1270** determines the [SQLITE_IOCAP_POWERSAFE_OVERWRITE] bit of the
1271** xDeviceCharacteristics methods. The fourth parameter to
1272** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
1273** That integer is 0 to disable zero-damage mode or 1 to enable zero-damage
1274** mode. If the integer is -1, then it is overwritten with the current
1275** zero-damage mode setting.
1278** ^The [SQLITE_FCNTL_OVERWRITE] opcode is invoked by SQLite after opening
1279** a write transaction to indicate that, unless it is rolled back for some
1280** reason, the entire database file will be overwritten by the current
1281** transaction. This is used by VACUUM operations.
1284** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of
1285** all [VFSes] in the VFS stack. The names are of all VFS shims and the
1286** final bottom-level VFS are written into memory obtained from
1287** [sqlite3_malloc()] and the result is stored in the char* variable
1288** that the fourth parameter of [sqlite3_file_control()] points to.
1289** The caller is responsible for freeing the memory when done. As with
1290** all file-control actions, there is no guarantee that this will actually
1291** do anything. Callers should initialize the char* variable to a NULL
1292** pointer in case this file-control is not implemented. This file-control
1293** is intended for diagnostic use only.
1296** ^The [SQLITE_FCNTL_VFS_POINTER] opcode finds a pointer to the top-level
1297** [VFSes] currently in use. ^(The argument X in
1298** sqlite3_file_control(db,SQLITE_FCNTL_VFS_POINTER,X) must be
1299** of type "[sqlite3_vfs] **". This opcodes will set *X
1300** to a pointer to the top-level VFS.)^
1301** ^When there are multiple VFS shims in the stack, this opcode finds the
1302** upper-most shim only.
1304** <li>[[SQLITE_FCNTL_PRAGMA]]
1305** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA]
1306** file control is sent to the open [sqlite3_file] object corresponding
1307** to the database file to which the pragma statement refers. ^The argument
1308** to the [SQLITE_FCNTL_PRAGMA] file control is an array of
1309** pointers to strings (char**) in which the second element of the array
1310** is the name of the pragma and the third element is the argument to the
1311** pragma or NULL if the pragma has no argument. ^The handler for an
1312** [SQLITE_FCNTL_PRAGMA] file control can optionally make the first element
1313** of the char** argument point to a string obtained from [sqlite3_mprintf()]
1314** or the equivalent and that string will become the result of the pragma or
1315** the error message if the pragma fails. ^If the
1316** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal
1317** [PRAGMA] processing continues. ^If the [SQLITE_FCNTL_PRAGMA]
1318** file control returns [SQLITE_OK], then the parser assumes that the
1319** VFS has handled the PRAGMA itself and the parser generates a no-op
1320** prepared statement if result string is NULL, or that returns a copy
1321** of the result string if the string is non-NULL.
1322** ^If the [SQLITE_FCNTL_PRAGMA] file control returns
1323** any result code other than [SQLITE_OK] or [SQLITE_NOTFOUND], that means
1324** that the VFS encountered an error while handling the [PRAGMA] and the
1325** compilation of the PRAGMA fails with an error. ^The [SQLITE_FCNTL_PRAGMA]
1326** file control occurs at the beginning of pragma statement analysis and so
1327** it is able to override built-in [PRAGMA] statements.
1331** file-control may be invoked by SQLite on the database file handle
1332** shortly after it is opened in order to provide a custom VFS with access
1333** to the connection's busy-handler callback. The argument is of type (void**)
1334** - an array of two (void *) values. The first (void *) actually points
1335** to a function of type (int (*)(void *)). In order to invoke the connection's
1336** busy-handler, this function should be invoked with the second (void *) in
1337** the array as the only argument. If it returns non-zero, then the operation
1338** should be retried. If it returns zero, the custom VFS should abandon the
1339** current operation.
1342** ^Applications can invoke the [SQLITE_FCNTL_TEMPFILENAME] file-control
1343** to have SQLite generate a
1344** temporary filename using the same algorithm that is followed to generate
1345** temporary filenames for TEMP tables and other internal uses. The
1346** argument should be a char** which will be filled with the filename
1347** written into memory obtained from [sqlite3_malloc()]. The caller should
1348** invoke [sqlite3_free()] on the result to avoid a memory leak.
1351** The [SQLITE_FCNTL_MMAP_SIZE] file control is used to query or set the
1352** maximum number of bytes that will be used for memory-mapped I/O.
1353** The argument is a pointer to a value of type sqlite3_int64 that
1354** is an advisory maximum number of bytes in the file to memory map. The
1355** pointer is overwritten with the old value. The limit is not changed if
1356** the value originally pointed to is negative, and so the current limit
1357** can be queried by passing in a pointer to a negative number. This
1358** file-control is used internally to implement [PRAGMA mmap_size].
1360** <li>[[SQLITE_FCNTL_TRACE]]
1361** The [SQLITE_FCNTL_TRACE] file control provides advisory information
1362** to the VFS about what the higher layers of the SQLite stack are doing.
1363** This file control is used by some VFS activity tracing [shims].
1364** The argument is a zero-terminated string. Higher layers in the
1365** SQLite stack may generate instances of this file control if
1366** the [SQLITE_USE_FCNTL_TRACE] compile-time option is enabled.
1369** The [SQLITE_FCNTL_HAS_MOVED] file control interprets its argument as a
1370** pointer to an integer and it writes a boolean into that integer depending
1371** on whether or not the file has been renamed, moved, or deleted since it
1372** was first opened.
1375** The [SQLITE_FCNTL_WIN32_GET_HANDLE] opcode can be used to obtain the
1376** underlying native file handle associated with a file handle. This file
1377** control interprets its argument as a pointer to a native file handle and
1378** writes the resulting value there.
1381** The [SQLITE_FCNTL_WIN32_SET_HANDLE] opcode is used for debugging. This
1382** opcode causes the xFileControl method to swap the file handle with the one
1383** pointed to by the pArg argument. This capability is used during testing
1384** and only needs to be supported when SQLITE_TEST is defined.
1387** The [SQLITE_FCNTL_WAL_BLOCK] is a signal to the VFS layer that it might
1388** be advantageous to block on the next WAL lock if the lock is not immediately
1389** available. The WAL subsystem issues this signal during rare
1390** circumstances in order to fix a problem with priority inversion.
1391** Applications should <em>not</em> use this file-control.
1393** <li>[[SQLITE_FCNTL_ZIPVFS]]
1394** The [SQLITE_FCNTL_ZIPVFS] opcode is implemented by zipvfs only. All other
1395** VFS should return SQLITE_NOTFOUND for this opcode.
1397** <li>[[SQLITE_FCNTL_RBU]]
1398** The [SQLITE_FCNTL_RBU] opcode is implemented by the special VFS used by
1399** the RBU extension only. All other VFS should return SQLITE_NOTFOUND for
1400** this opcode.
1403** If the [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] opcode returns SQLITE_OK, then
1404** the file descriptor is placed in "batch write mode", which
1405** means all subsequent write operations will be deferred and done
1406** atomically at the next [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]. Systems
1407** that do not support batch atomic writes will return SQLITE_NOTFOUND.
1408** ^Following a successful SQLITE_FCNTL_BEGIN_ATOMIC_WRITE and prior to
1409** the closing [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE] or
1411** no VFS interface calls on the same [sqlite3_file] file descriptor
1412** except for calls to the xWrite method and the xFileControl method
1416** The [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE] opcode causes all write
1417** operations since the previous successful call to
1418** [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] to be performed atomically.
1419** This file control returns [SQLITE_OK] if and only if the writes were
1420** all performed successfully and have been committed to persistent storage.
1421** ^Regardless of whether or not it is successful, this file control takes
1422** the file descriptor out of batch write mode so that all subsequent
1423** write operations are independent.
1424** ^SQLite will never invoke SQLITE_FCNTL_COMMIT_ATOMIC_WRITE without
1425** a prior successful call to [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE].
1428** The [SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE] opcode causes all write
1429** operations since the previous successful call to
1430** [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] to be rolled back.
1431** ^This file control takes the file descriptor out of batch write mode
1432** so that all subsequent write operations are independent.
1433** ^SQLite will never invoke SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE without
1434** a prior successful call to [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE].
1437** The [SQLITE_FCNTL_LOCK_TIMEOUT] opcode is used to configure a VFS
1438** to block for up to M milliseconds before failing when attempting to
1439** obtain a file lock using the xLock or xShmLock methods of the VFS.
1440** The parameter is a pointer to a 32-bit signed integer that contains
1441** the value that M is to be set to. Before returning, the 32-bit signed
1442** integer is overwritten with the previous value of M.
1445** The [SQLITE_FCNTL_DATA_VERSION] opcode is used to detect changes to
1446** a database file. The argument is a pointer to a 32-bit unsigned integer.
1447** The "data version" for the pager is written into the pointer. The
1448** "data version" changes whenever any change occurs to the corresponding
1449** database file, either through SQL statements on the same database
1450** connection or through transactions committed by separate database
1451** connections possibly in other processes. The [sqlite3_total_changes()]
1452** interface can be used to find if any database on the connection has changed,
1453** but that interface responds to changes on TEMP as well as MAIN and does
1454** not provide a mechanism to detect changes to MAIN only. Also, the
1455** [sqlite3_total_changes()] interface responds to internal changes only and
1456** omits changes made by other database connections. The
1457** [PRAGMA data_version] command provides a mechanism to detect changes to
1458** a single attached database that occur due to other database connections,
1459** but omits changes implemented by the database connection on which it is
1460** called. This file control is the only mechanism to detect changes that
1461** happen either internally or externally and that are associated with
1462** a particular attached database.
1465** The [SQLITE_FCNTL_CKPT_START] opcode is invoked from within a checkpoint
1466** in wal mode before the client starts to copy pages from the wal
1467** file to the database file.
1470** The [SQLITE_FCNTL_CKPT_DONE] opcode is invoked from within a checkpoint
1471** in wal mode after the client has finished copying pages from the wal
1472** file to the database file, but before the *-shm file is updated to
1473** record the fact that the pages have been checkpointed.
1474** </ul>
1477** The EXPERIMENTAL [SQLITE_FCNTL_EXTERNAL_READER] opcode is used to detect
1478** whether or not there is a database client in another process with a wal-mode
1479** transaction open on the database or not. It is only available on unix.The
1480** (void*) argument passed with this file-control should be a pointer to a
1481** value of type (int). The integer value is set to 1 if the database is a wal
1482** mode database and there exists at least one client in another process that
1483** currently has an SQL transaction open on the database. It is set to 0 if
1484** the database is not a wal-mode db, or if there is no such connection in any
1485** other process. This opcode cannot be used to detect transactions opened
1486** by clients within the current process, only within other processes.
1487** </ul>
1490** Used by the cksmvfs VFS module only.
1491** </ul>
1506#define SQLITE_FCNTL_PRAGMA 14
1510#define SQLITE_FCNTL_TRACE 19
1512#define SQLITE_FCNTL_SYNC 21
1516#define SQLITE_FCNTL_ZIPVFS 25
1517#define SQLITE_FCNTL_RBU 26
1521#define SQLITE_FCNTL_PDB 30
1534/* deprecated names */
1541** CAPI3REF: Mutex Handle
1543** The mutex module within SQLite defines [sqlite3_mutex] to be an
1544** abstract type for a mutex object. The SQLite core never looks
1545** at the internal representation of an [sqlite3_mutex]. It only
1546** deals with pointers to the [sqlite3_mutex] object.
1548** Mutexes are created using [sqlite3_mutex_alloc()].
1550typedef struct sqlite3_mutex sqlite3_mutex;
1553** CAPI3REF: Loadable Extension Thunk
1555** A pointer to the opaque sqlite3_api_routines structure is passed as
1556** the third parameter to entry points of [loadable extensions]. This
1557** structure must be typedefed in order to work around compiler warnings
1558** on some platforms.
1560typedef struct sqlite3_api_routines sqlite3_api_routines;
1563** CAPI3REF: OS Interface Object
1565** An instance of the sqlite3_vfs object defines the interface between
1566** the SQLite core and the underlying operating system. The "vfs"
1567** in the name of the object stands for "virtual file system". See
1568** the [VFS | VFS documentation] for further information.
1570** The VFS interface is sometimes extended by adding new methods onto
1571** the end. Each time such an extension occurs, the iVersion field
1572** is incremented. The iVersion value started out as 1 in
1573** SQLite [version 3.5.0] on [dateof:3.5.0], then increased to 2
1574** with SQLite [version 3.7.0] on [dateof:3.7.0], and then increased
1575** to 3 with SQLite [version 3.7.6] on [dateof:3.7.6]. Additional fields
1576** may be appended to the sqlite3_vfs object and the iVersion value
1577** may increase again in future versions of SQLite.
1578** Note that due to an oversight, the structure
1579** of the sqlite3_vfs object changed in the transition from
1580** SQLite [version 3.5.9] to [version 3.6.0] on [dateof:3.6.0]
1581** and yet the iVersion field was not increased.
1583** The szOsFile field is the size of the subclassed [sqlite3_file]
1584** structure used by this VFS. mxPathname is the maximum length of
1585** a pathname in this VFS.
1587** Registered sqlite3_vfs objects are kept on a linked list formed by
1588** the pNext pointer. The [sqlite3_vfs_register()]
1589** and [sqlite3_vfs_unregister()] interfaces manage this list
1590** in a thread-safe way. The [sqlite3_vfs_find()] interface
1591** searches the list. Neither the application code nor the VFS
1592** implementation should use the pNext pointer.
1594** The pNext field is the only field in the sqlite3_vfs
1595** structure that SQLite will ever modify. SQLite will only access
1596** or modify this field while holding a particular static mutex.
1597** The application should never modify anything within the sqlite3_vfs
1598** object once the object has been registered.
1600** The zName field holds the name of the VFS module. The name must
1601** be unique across all VFS modules.
1603** [[sqlite3_vfs.xOpen]]
1604** ^SQLite guarantees that the zFilename parameter to xOpen
1605** is either a NULL pointer or string obtained
1606** from xFullPathname() with an optional suffix added.
1607** ^If a suffix is added to the zFilename parameter, it will
1608** consist of a single "-" character followed by no more than
1609** 11 alphanumeric and/or "-" characters.
1610** ^SQLite further guarantees that
1611** the string will be valid and unchanged until xClose() is
1612** called. Because of the previous sentence,
1613** the [sqlite3_file] can safely store a pointer to the
1614** filename if it needs to remember the filename for some reason.
1615** If the zFilename parameter to xOpen is a NULL pointer then xOpen
1616** must invent its own temporary name for the file. ^Whenever the
1617** xFilename parameter is NULL it will also be the case that the
1618** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE].
1620** The flags argument to xOpen() includes all bits set in
1621** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()]
1622** or [sqlite3_open16()] is used, then flags includes at least
1624** If xOpen() opens a file read-only then it sets *pOutFlags to
1625** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set.
1627** ^(SQLite will also add one of the following flags to the xOpen()
1628** call, depending on the object being opened:
1630** <ul>
1631** <li> [SQLITE_OPEN_MAIN_DB]
1633** <li> [SQLITE_OPEN_TEMP_DB]
1638** <li> [SQLITE_OPEN_WAL]
1639** </ul>)^
1641** The file I/O implementation can use the object type flags to
1642** change the way it deals with files. For example, an application
1643** that does not care about crash recovery or rollback might make
1644** the open of a journal file a no-op. Writes to this journal would
1645** also be no-ops, and any attempt to read the journal would return
1646** SQLITE_IOERR. Or the implementation might recognize that a database
1647** file will be doing page-aligned sector reads and writes in a random
1648** order and set up its I/O subsystem accordingly.
1650** SQLite might also add one of the following flags to the xOpen method:
1652** <ul>
1655** </ul>
1657** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be
1658** deleted when it is closed. ^The [SQLITE_OPEN_DELETEONCLOSE]
1659** will be set for TEMP databases and their journals, transient
1660** databases, and subjournals.
1662** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction
1663** with the [SQLITE_OPEN_CREATE] flag, which are both directly
1664** analogous to the O_EXCL and O_CREAT flags of the POSIX open()
1665** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the
1666** SQLITE_OPEN_CREATE, is used to indicate that file should always
1667** be created, and that it is an error if it already exists.
1668** It is <i>not</i> used to indicate the file should be opened
1669** for exclusive access.
1671** ^At least szOsFile bytes of memory are allocated by SQLite
1672** to hold the [sqlite3_file] structure passed as the third
1673** argument to xOpen. The xOpen method does not have to
1674** allocate the structure; it should just fill it in. Note that
1675** the xOpen method must set the sqlite3_file.pMethods to either
1676** a valid [sqlite3_io_methods] object or to NULL. xOpen must do
1677** this even if the open fails. SQLite expects that the sqlite3_file.pMethods
1678** element will be valid after xOpen returns regardless of the success
1679** or failure of the xOpen call.
1681** [[sqlite3_vfs.xAccess]]
1682** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS]
1683** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to
1684** test whether a file is readable and writable, or [SQLITE_ACCESS_READ]
1685** to test whether a file is at least readable. The SQLITE_ACCESS_READ
1686** flag is never actually used and is not implemented in the built-in
1687** VFSes of SQLite. The file is named by the second argument and can be a
1688** directory. The xAccess method returns [SQLITE_OK] on success or some
1689** non-zero error code if there is an I/O error or if the name of
1690** the file given in the second argument is illegal. If SQLITE_OK
1691** is returned, then non-zero or zero is written into *pResOut to indicate
1692** whether or not the file is accessible.
1694** ^SQLite will always allocate at least mxPathname+1 bytes for the
1695** output buffer xFullPathname. The exact size of the output buffer
1696** is also passed as a parameter to both methods. If the output buffer
1697** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is
1698** handled as a fatal error by SQLite, vfs implementations should endeavor
1699** to prevent this by setting mxPathname to a sufficiently large value.
1701** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64()
1702** interfaces are not strictly a part of the filesystem, but they are
1703** included in the VFS structure for completeness.
1704** The xRandomness() function attempts to return nBytes bytes
1705** of good-quality randomness into zOut. The return value is
1706** the actual number of bytes of randomness obtained.
1707** The xSleep() method causes the calling thread to sleep for at
1708** least the number of microseconds given. ^The xCurrentTime()
1709** method returns a Julian Day Number for the current date and time as
1710** a floating point value.
1711** ^The xCurrentTimeInt64() method returns, as an integer, the Julian
1712** Day Number multiplied by 86400000 (the number of milliseconds in
1713** a 24-hour day).
1714** ^SQLite will use the xCurrentTimeInt64() method to get the current
1715** date and time if that method is available (if iVersion is 2 or
1716** greater and the function pointer is not NULL) and will fall back
1717** to xCurrentTime() if xCurrentTimeInt64() is unavailable.
1719** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces
1720** are not used by the SQLite core. These optional interfaces are provided
1721** by some VFSes to facilitate testing of the VFS code. By overriding
1722** system calls with functions under its control, a test program can
1723** simulate faults and error conditions that would otherwise be difficult
1724** or impossible to induce. The set of system calls that can be overridden
1725** varies from one VFS to another, and from one version of the same VFS to the
1726** next. Applications that use these interfaces must be prepared for any
1727** or all of these interfaces to be NULL or for their behavior to change
1728** from one release to the next. Applications must not attempt to access
1729** any of these methods if the iVersion of the VFS is less than 3.
1731typedef struct sqlite3_vfs sqlite3_vfs;
1732typedef void (*sqlite3_syscall_ptr)(void);
1733struct sqlite3_vfs {
1734 int iVersion; /* Structure version number (currently 3) */
1735 int szOsFile; /* Size of subclassed sqlite3_file */
1736 int mxPathname; /* Maximum file pathname length */
1737 sqlite3_vfs *pNext; /* Next registered VFS */
1738 const char *zName; /* Name of this virtual file system */
1739 void *pAppData; /* Pointer to application-specific data */
1740 int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*,
1741 int flags, int *pOutFlags);
1742 int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir);
1743 int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut);
1744 int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut);
1745 void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename);
1746 void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg);
1747 void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void);
1748 void (*xDlClose)(sqlite3_vfs*, void*);
1749 int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut);
1750 int (*xSleep)(sqlite3_vfs*, int microseconds);
1751 int (*xCurrentTime)(sqlite3_vfs*, double*);
1752 int (*xGetLastError)(sqlite3_vfs*, int, char *);
1753 /*
1754 ** The methods above are in version 1 of the sqlite_vfs object
1755 ** definition. Those that follow are added in version 2 or later
1756 */
1757 int (*xCurrentTimeInt64)(sqlite3_vfs*, sqlite3_int64*);
1758 /*
1759 ** The methods above are in versions 1 and 2 of the sqlite_vfs object.
1760 ** Those below are for version 3 and greater.
1761 */
1762 int (*xSetSystemCall)(sqlite3_vfs*, const char *zName, sqlite3_syscall_ptr);
1763 sqlite3_syscall_ptr (*xGetSystemCall)(sqlite3_vfs*, const char *zName);
1764 const char *(*xNextSystemCall)(sqlite3_vfs*, const char *zName);
1765 /*
1766 ** The methods above are in versions 1 through 3 of the sqlite_vfs object.
1767 ** New fields may be appended in future versions. The iVersion
1768 ** value will increment whenever this happens.
1769 */
1773** CAPI3REF: Flags for the xAccess VFS method
1775** These integer constants can be used as the third parameter to
1776** the xAccess method of an [sqlite3_vfs] object. They determine
1777** what kind of permissions the xAccess method is looking for.
1778** With SQLITE_ACCESS_EXISTS, the xAccess method
1779** simply checks whether the file exists.
1780** With SQLITE_ACCESS_READWRITE, the xAccess method
1781** checks whether the named directory is both readable and writable
1782** (in other words, if files can be added, removed, and renamed within
1783** the directory).
1784** The SQLITE_ACCESS_READWRITE constant is currently used only by the
1785** [temp_store_directory pragma], though this could change in a future
1786** release of SQLite.
1787** With SQLITE_ACCESS_READ, the xAccess method
1788** checks whether the file is readable. The SQLITE_ACCESS_READ constant is
1789** currently unused, though it might be used in a future release of
1790** SQLite.
1793#define SQLITE_ACCESS_READWRITE 1 /* Used by PRAGMA temp_store_directory */
1794#define SQLITE_ACCESS_READ 2 /* Unused */
1797** CAPI3REF: Flags for the xShmLock VFS method
1799** These integer constants define the various locking operations
1800** allowed by the xShmLock method of [sqlite3_io_methods]. The
1801** following are the only legal combinations of flags to the
1802** xShmLock method:
1804** <ul>
1809** </ul>
1811** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as
1812** was given on the corresponding lock.
1814** The xShmLock method can transition between unlocked and SHARED or
1815** between unlocked and EXCLUSIVE. It cannot transition between SHARED
1816** and EXCLUSIVE.
1818#define SQLITE_SHM_UNLOCK 1
1819#define SQLITE_SHM_LOCK 2
1820#define SQLITE_SHM_SHARED 4
1824** CAPI3REF: Maximum xShmLock index
1826** The xShmLock method on [sqlite3_io_methods] may use values
1827** between 0 and this upper bound as its "offset" argument.
1828** The SQLite core will never attempt to acquire or release a
1829** lock outside of this range
1831#define SQLITE_SHM_NLOCK 8
1835** CAPI3REF: Initialize The SQLite Library
1837** ^The sqlite3_initialize() routine initializes the
1838** SQLite library. ^The sqlite3_shutdown() routine
1839** deallocates any resources that were allocated by sqlite3_initialize().
1840** These routines are designed to aid in process initialization and
1841** shutdown on embedded systems. Workstation applications using
1842** SQLite normally do not need to invoke either of these routines.
1844** A call to sqlite3_initialize() is an "effective" call if it is
1845** the first time sqlite3_initialize() is invoked during the lifetime of
1846** the process, or if it is the first time sqlite3_initialize() is invoked
1847** following a call to sqlite3_shutdown(). ^(Only an effective call
1848** of sqlite3_initialize() does any initialization. All other calls
1849** are harmless no-ops.)^
1851** A call to sqlite3_shutdown() is an "effective" call if it is the first
1852** call to sqlite3_shutdown() since the last sqlite3_initialize(). ^(Only
1853** an effective call to sqlite3_shutdown() does any deinitialization.
1854** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^
1856** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown()
1857** is not. The sqlite3_shutdown() interface must only be called from a
1858** single thread. All open [database connections] must be closed and all
1859** other SQLite resources must be deallocated prior to invoking
1860** sqlite3_shutdown().
1862** Among other things, ^sqlite3_initialize() will invoke
1863** sqlite3_os_init(). Similarly, ^sqlite3_shutdown()
1864** will invoke sqlite3_os_end().
1866** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success.
1867** ^If for some reason, sqlite3_initialize() is unable to initialize
1868** the library (perhaps it is unable to allocate a needed resource such
1869** as a mutex) it returns an [error code] other than [SQLITE_OK].
1871** ^The sqlite3_initialize() routine is called internally by many other
1872** SQLite interfaces so that an application usually does not need to
1873** invoke sqlite3_initialize() directly. For example, [sqlite3_open()]
1874** calls sqlite3_initialize() so the SQLite library will be automatically
1875** initialized when [sqlite3_open()] is called if it has not be initialized
1876** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT]
1877** compile-time option, then the automatic calls to sqlite3_initialize()
1878** are omitted and the application must call sqlite3_initialize() directly
1879** prior to using any other SQLite interface. For maximum portability,
1880** it is recommended that applications always invoke sqlite3_initialize()
1881** directly prior to using any other SQLite interface. Future releases
1882** of SQLite may require this. In other words, the behavior exhibited
1883** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the
1884** default behavior in some future release of SQLite.
1886** The sqlite3_os_init() routine does operating-system specific
1887** initialization of the SQLite library. The sqlite3_os_end()
1888** routine undoes the effect of sqlite3_os_init(). Typical tasks
1889** performed by these routines include allocation or deallocation
1890** of static resources, initialization of global variables,
1891** setting up a default [sqlite3_vfs] module, or setting up
1892** a default configuration using [sqlite3_config()].
1894** The application should never invoke either sqlite3_os_init()
1895** or sqlite3_os_end() directly. The application should only invoke
1896** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init()
1897** interface is called automatically by sqlite3_initialize() and
1898** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate
1899** implementations for sqlite3_os_init() and sqlite3_os_end()
1900** are built into SQLite when it is compiled for Unix, Windows, or OS/2.
1901** When [custom builds | built for other platforms]
1902** (using the [SQLITE_OS_OTHER=1] compile-time
1903** option) the application must supply a suitable implementation for
1904** sqlite3_os_init() and sqlite3_os_end(). An application-supplied
1905** implementation of sqlite3_os_init() or sqlite3_os_end()
1906** must return [SQLITE_OK] on success and some other [error code] upon
1907** failure.
1909SQLITE_API int sqlite3_initialize(void);
1910SQLITE_API int sqlite3_shutdown(void);
1911SQLITE_API int sqlite3_os_init(void);
1912SQLITE_API int sqlite3_os_end(void);
1915** CAPI3REF: Configuring The SQLite Library
1917** The sqlite3_config() interface is used to make global configuration
1918** changes to SQLite in order to tune SQLite to the specific needs of
1919** the application. The default configuration is recommended for most
1920** applications and so this routine is usually not necessary. It is
1921** provided to support rare applications with unusual needs.
1923** <b>The sqlite3_config() interface is not threadsafe. The application
1924** must ensure that no other SQLite interfaces are invoked by other
1925** threads while sqlite3_config() is running.</b>
1927** The sqlite3_config() interface
1928** may only be invoked prior to library initialization using
1929** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()].
1930** ^If sqlite3_config() is called after [sqlite3_initialize()] and before
1931** [sqlite3_shutdown()] then it will return SQLITE_MISUSE.
1932** Note, however, that ^sqlite3_config() can be called as part of the
1933** implementation of an application-defined [sqlite3_os_init()].
1935** The first argument to sqlite3_config() is an integer
1936** [configuration option] that determines
1937** what property of SQLite is to be configured. Subsequent arguments
1938** vary depending on the [configuration option]
1939** in the first argument.
1941** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK].
1942** ^If the option is unknown or SQLite is unable to set the option
1943** then this routine returns a non-zero [error code].
1945SQLITE_API int sqlite3_config(int, ...);
1948** CAPI3REF: Configure database connections
1949** METHOD: sqlite3
1951** The sqlite3_db_config() interface is used to make configuration
1952** changes to a [database connection]. The interface is similar to
1953** [sqlite3_config()] except that the changes apply to a single
1954** [database connection] (specified in the first argument).
1956** The second argument to sqlite3_db_config(D,V,...) is the
1957** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code
1958** that indicates what aspect of the [database connection] is being configured.
1959** Subsequent arguments vary depending on the configuration verb.
1961** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if
1962** the call is considered successful.
1964SQLITE_API int sqlite3_db_config(sqlite3*, int op, ...);
1967** CAPI3REF: Memory Allocation Routines
1969** An instance of this object defines the interface between SQLite
1970** and low-level memory allocation routines.
1972** This object is used in only one place in the SQLite interface.
1973** A pointer to an instance of this object is the argument to
1974** [sqlite3_config()] when the configuration option is
1976** By creating an instance of this object
1977** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC])
1978** during configuration, an application can specify an alternative
1979** memory allocation subsystem for SQLite to use for all of its
1980** dynamic memory needs.
1982** Note that SQLite comes with several [built-in memory allocators]
1983** that are perfectly adequate for the overwhelming majority of applications
1984** and that this object is only useful to a tiny minority of applications
1985** with specialized memory allocation requirements. This object is
1986** also used during testing of SQLite in order to specify an alternative
1987** memory allocator that simulates memory out-of-memory conditions in
1988** order to verify that SQLite recovers gracefully from such
1989** conditions.
1991** The xMalloc, xRealloc, and xFree methods must work like the
1992** malloc(), realloc() and free() functions from the standard C library.
1993** ^SQLite guarantees that the second argument to
1994** xRealloc is always a value returned by a prior call to xRoundup.
1996** xSize should return the allocated size of a memory allocation
1997** previously obtained from xMalloc or xRealloc. The allocated size
1998** is always at least as big as the requested size but may be larger.
2000** The xRoundup method returns what would be the allocated size of
2001** a memory allocation given a particular requested size. Most memory
2002** allocators round up memory allocations at least to the next multiple
2003** of 8. Some allocators round up to a larger multiple or to a power of 2.
2004** Every memory allocation request coming in through [sqlite3_malloc()]
2005** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0,
2006** that causes the corresponding memory allocation to fail.
2008** The xInit method initializes the memory allocator. For example,
2009** it might allocate any required mutexes or initialize internal data
2010** structures. The xShutdown method is invoked (indirectly) by
2011** [sqlite3_shutdown()] and should deallocate any resources acquired
2012** by xInit. The pAppData pointer is used as the only parameter to
2013** xInit and xShutdown.
2015** SQLite holds the [SQLITE_MUTEX_STATIC_MAIN] mutex when it invokes
2016** the xInit method, so the xInit method need not be threadsafe. The
2017** xShutdown method is only called from [sqlite3_shutdown()] so it does
2018** not need to be threadsafe either. For all other methods, SQLite
2019** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the
2020** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which
2021** it is by default) and so the methods are automatically serialized.
2022** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other
2023** methods must be threadsafe or else make their own arrangements for
2024** serialization.
2026** SQLite will never invoke xInit() more than once without an intervening
2027** call to xShutdown().
2029typedef struct sqlite3_mem_methods sqlite3_mem_methods;
2030struct sqlite3_mem_methods {
2031 void *(*xMalloc)(int); /* Memory allocation function */
2032 void (*xFree)(void*); /* Free a prior allocation */
2033 void *(*xRealloc)(void*,int); /* Resize an allocation */
2034 int (*xSize)(void*); /* Return the size of an allocation */
2035 int (*xRoundup)(int); /* Round up request size to allocation size */
2036 int (*xInit)(void*); /* Initialize the memory allocator */
2037 void (*xShutdown)(void*); /* Deinitialize the memory allocator */
2038 void *pAppData; /* Argument to xInit() and xShutdown() */
2042** CAPI3REF: Configuration Options
2043** KEYWORDS: {configuration option}
2045** These constants are the available integer configuration options that
2046** can be passed as the first argument to the [sqlite3_config()] interface.
2048** New configuration options may be added in future releases of SQLite.
2049** Existing configuration options might be discontinued. Applications
2050** should check the return code from [sqlite3_config()] to make sure that
2051** the call worked. The [sqlite3_config()] interface will return a
2052** non-zero [error code] if a discontinued or unsupported configuration option
2053** is invoked.
2055** <dl>
2057** <dd>There are no arguments to this option. ^This option sets the
2058** [threading mode] to Single-thread. In other words, it disables
2059** all mutexing and puts SQLite into a mode where it can only be used
2060** by a single thread. ^If SQLite is compiled with
2061** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
2062** it is not possible to change the [threading mode] from its default
2063** value of Single-thread and so [sqlite3_config()] will return
2065** configuration option.</dd>
2068** <dd>There are no arguments to this option. ^This option sets the
2069** [threading mode] to Multi-thread. In other words, it disables
2070** mutexing on [database connection] and [prepared statement] objects.
2071** The application is responsible for serializing access to
2072** [database connections] and [prepared statements]. But other mutexes
2073** are enabled so that SQLite will be safe to use in a multi-threaded
2074** environment as long as no two threads attempt to use the same
2075** [database connection] at the same time. ^If SQLite is compiled with
2076** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
2077** it is not possible to set the Multi-thread [threading mode] and
2078** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
2079** SQLITE_CONFIG_MULTITHREAD configuration option.</dd>
2082** <dd>There are no arguments to this option. ^This option sets the
2083** [threading mode] to Serialized. In other words, this option enables
2084** all mutexes including the recursive
2085** mutexes on [database connection] and [prepared statement] objects.
2086** In this mode (which is the default when SQLite is compiled with
2087** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access
2088** to [database connections] and [prepared statements] so that the
2089** application is free to use the same [database connection] or the
2090** same [prepared statement] in different threads at the same time.
2091** ^If SQLite is compiled with
2092** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
2093** it is not possible to set the Serialized [threading mode] and
2094** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
2095** SQLITE_CONFIG_SERIALIZED configuration option.</dd>
2098** <dd> ^(The SQLITE_CONFIG_MALLOC option takes a single argument which is
2099** a pointer to an instance of the [sqlite3_mem_methods] structure.
2100** The argument specifies
2101** alternative low-level memory allocation routines to be used in place of
2102** the memory allocation routines built into SQLite.)^ ^SQLite makes
2103** its own private copy of the content of the [sqlite3_mem_methods] structure
2104** before the [sqlite3_config()] call returns.</dd>
2107** <dd> ^(The SQLITE_CONFIG_GETMALLOC option takes a single argument which
2108** is a pointer to an instance of the [sqlite3_mem_methods] structure.
2109** The [sqlite3_mem_methods]
2110** structure is filled with the currently defined memory allocation routines.)^
2111** This option can be used to overload the default memory allocation
2112** routines with a wrapper that simulations memory allocation failure or
2113** tracks memory usage, for example. </dd>
2116** <dd> ^The SQLITE_CONFIG_SMALL_MALLOC option takes single argument of
2117** type int, interpreted as a boolean, which if true provides a hint to
2118** SQLite that it should avoid large memory allocations if possible.
2119** SQLite will run faster if it is free to make large memory allocations,
2120** but some application might prefer to run slower in exchange for
2121** guarantees about memory fragmentation that are possible if large
2122** allocations are avoided. This hint is normally off.
2123** </dd>
2126** <dd> ^The SQLITE_CONFIG_MEMSTATUS option takes single argument of type int,
2127** interpreted as a boolean, which enables or disables the collection of
2128** memory allocation statistics. ^(When memory allocation statistics are
2129** disabled, the following SQLite interfaces become non-operational:
2130** <ul>
2131** <li> [sqlite3_hard_heap_limit64()]
2132** <li> [sqlite3_memory_used()]
2133** <li> [sqlite3_memory_highwater()]
2134** <li> [sqlite3_soft_heap_limit64()]
2135** <li> [sqlite3_status64()]
2136** </ul>)^
2137** ^Memory allocation statistics are enabled by default unless SQLite is
2138** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory
2139** allocation statistics are disabled by default.
2140** </dd>
2143** <dd> The SQLITE_CONFIG_SCRATCH option is no longer used.
2144** </dd>
2147** <dd> ^The SQLITE_CONFIG_PAGECACHE option specifies a memory pool
2148** that SQLite can use for the database page cache with the default page
2149** cache implementation.
2150** This configuration option is a no-op if an application-defined page
2151** cache implementation is loaded using the [SQLITE_CONFIG_PCACHE2].
2152** ^There are three arguments to SQLITE_CONFIG_PAGECACHE: A pointer to
2153** 8-byte aligned memory (pMem), the size of each page cache line (sz),
2154** and the number of cache lines (N).
2155** The sz argument should be the size of the largest database page
2156** (a power of two between 512 and 65536) plus some extra bytes for each
2157** page header. ^The number of extra bytes needed by the page header
2158** can be determined using [SQLITE_CONFIG_PCACHE_HDRSZ].
2159** ^It is harmless, apart from the wasted memory,
2160** for the sz parameter to be larger than necessary. The pMem
2161** argument must be either a NULL pointer or a pointer to an 8-byte
2162** aligned block of memory of at least sz*N bytes, otherwise
2163** subsequent behavior is undefined.
2164** ^When pMem is not NULL, SQLite will strive to use the memory provided
2165** to satisfy page cache needs, falling back to [sqlite3_malloc()] if
2166** a page cache line is larger than sz bytes or if all of the pMem buffer
2167** is exhausted.
2168** ^If pMem is NULL and N is non-zero, then each database connection
2169** does an initial bulk allocation for page cache memory
2170** from [sqlite3_malloc()] sufficient for N cache lines if N is positive or
2171** of -1024*N bytes if N is negative, . ^If additional
2172** page cache memory is needed beyond what is provided by the initial
2173** allocation, then SQLite goes to [sqlite3_malloc()] separately for each
2174** additional cache line. </dd>
2177** <dd> ^The SQLITE_CONFIG_HEAP option specifies a static memory buffer
2178** that SQLite will use for all of its dynamic memory allocation needs
2179** beyond those provided for by [SQLITE_CONFIG_PAGECACHE].
2180** ^The SQLITE_CONFIG_HEAP option is only available if SQLite is compiled
2181** with either [SQLITE_ENABLE_MEMSYS3] or [SQLITE_ENABLE_MEMSYS5] and returns
2182** [SQLITE_ERROR] if invoked otherwise.
2183** ^There are three arguments to SQLITE_CONFIG_HEAP:
2184** An 8-byte aligned pointer to the memory,
2185** the number of bytes in the memory buffer, and the minimum allocation size.
2186** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts
2187** to using its default memory allocator (the system malloc() implementation),
2188** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the
2189** memory pointer is not NULL then the alternative memory
2190** allocator is engaged to handle all of SQLites memory allocation needs.
2191** The first pointer (the memory pointer) must be aligned to an 8-byte
2192** boundary or subsequent behavior of SQLite will be undefined.
2193** The minimum allocation size is capped at 2**12. Reasonable values
2194** for the minimum allocation size are 2**5 through 2**8.</dd>
2197** <dd> ^(The SQLITE_CONFIG_MUTEX option takes a single argument which is a
2198** pointer to an instance of the [sqlite3_mutex_methods] structure.
2199** The argument specifies alternative low-level mutex routines to be used
2200** in place the mutex routines built into SQLite.)^ ^SQLite makes a copy of
2201** the content of the [sqlite3_mutex_methods] structure before the call to
2202** [sqlite3_config()] returns. ^If SQLite is compiled with
2203** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
2204** the entire mutexing subsystem is omitted from the build and hence calls to
2205** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will
2206** return [SQLITE_ERROR].</dd>
2209** <dd> ^(The SQLITE_CONFIG_GETMUTEX option takes a single argument which
2210** is a pointer to an instance of the [sqlite3_mutex_methods] structure. The
2211** [sqlite3_mutex_methods]
2212** structure is filled with the currently defined mutex routines.)^
2213** This option can be used to overload the default mutex allocation
2214** routines with a wrapper used to track mutex usage for performance
2215** profiling or testing, for example. ^If SQLite is compiled with
2216** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
2217** the entire mutexing subsystem is omitted from the build and hence calls to
2218** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will
2219** return [SQLITE_ERROR].</dd>
2222** <dd> ^(The SQLITE_CONFIG_LOOKASIDE option takes two arguments that determine
2223** the default size of lookaside memory on each [database connection].
2224** The first argument is the
2225** size of each lookaside buffer slot and the second is the number of
2226** slots allocated to each database connection.)^ ^(SQLITE_CONFIG_LOOKASIDE
2227** sets the <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE]
2228** option to [sqlite3_db_config()] can be used to change the lookaside
2229** configuration on individual connections.)^ </dd>
2232** <dd> ^(The SQLITE_CONFIG_PCACHE2 option takes a single argument which is
2233** a pointer to an [sqlite3_pcache_methods2] object. This object specifies
2234** the interface to a custom page cache implementation.)^
2235** ^SQLite makes a copy of the [sqlite3_pcache_methods2] object.</dd>
2238** <dd> ^(The SQLITE_CONFIG_GETPCACHE2 option takes a single argument which
2239** is a pointer to an [sqlite3_pcache_methods2] object. SQLite copies of
2240** the current page cache implementation into that object.)^ </dd>
2243** <dd> The SQLITE_CONFIG_LOG option is used to configure the SQLite
2244** global [error log].
2245** (^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a
2246** function with a call signature of void(*)(void*,int,const char*),
2247** and a pointer to void. ^If the function pointer is not NULL, it is
2248** invoked by [sqlite3_log()] to process each logging event. ^If the
2249** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op.
2250** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is
2251** passed through as the first parameter to the application-defined logger
2252** function whenever that function is invoked. ^The second parameter to
2253** the logger function is a copy of the first parameter to the corresponding
2254** [sqlite3_log()] call and is intended to be a [result code] or an
2255** [extended result code]. ^The third parameter passed to the logger is
2256** log message after formatting via [sqlite3_snprintf()].
2257** The SQLite logging interface is not reentrant; the logger function
2258** supplied by the application must not invoke any SQLite interface.
2259** In a multi-threaded application, the application-defined logger
2260** function must be threadsafe. </dd>
2263** <dd>^(The SQLITE_CONFIG_URI option takes a single argument of type int.
2264** If non-zero, then URI handling is globally enabled. If the parameter is zero,
2265** then URI handling is globally disabled.)^ ^If URI handling is globally
2266** enabled, all filenames passed to [sqlite3_open()], [sqlite3_open_v2()],
2267** [sqlite3_open16()] or
2268** specified as part of [ATTACH] commands are interpreted as URIs, regardless
2269** of whether or not the [SQLITE_OPEN_URI] flag is set when the database
2270** connection is opened. ^If it is globally disabled, filenames are
2271** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the
2272** database connection is opened. ^(By default, URI handling is globally
2273** disabled. The default value may be changed by compiling with the
2274** [SQLITE_USE_URI] symbol defined.)^
2277** <dd>^The SQLITE_CONFIG_COVERING_INDEX_SCAN option takes a single integer
2278** argument which is interpreted as a boolean in order to enable or disable
2279** the use of covering indices for full table scans in the query optimizer.
2280** ^The default setting is determined
2281** by the [SQLITE_ALLOW_COVERING_INDEX_SCAN] compile-time option, or is "on"
2282** if that compile-time option is omitted.
2283** The ability to disable the use of covering indices for full table scans
2284** is because some incorrectly coded legacy applications might malfunction
2285** when the optimization is enabled. Providing the ability to
2286** disable the optimization allows the older, buggy application code to work
2287** without change even with newer versions of SQLite.
2291** <dd> These options are obsolete and should not be used by new code.
2292** They are retained for backwards compatibility but are now no-ops.
2293** </dd>
2297** <dd>This option is only available if sqlite is compiled with the
2298** [SQLITE_ENABLE_SQLLOG] pre-processor macro defined. The first argument should
2299** be a pointer to a function of type void(*)(void*,sqlite3*,const char*, int).
2300** The second should be of type (void*). The callback is invoked by the library
2301** in three separate circumstances, identified by the value passed as the
2302** fourth parameter. If the fourth parameter is 0, then the database connection
2303** passed as the second argument has just been opened. The third argument
2304** points to a buffer containing the name of the main database file. If the
2305** fourth parameter is 1, then the SQL statement that the third parameter
2306** points to has just been executed. Or, if the fourth parameter is 2, then
2307** the connection being passed as the second parameter is being closed. The
2308** third parameter is passed NULL In this case. An example of using this
2309** configuration option can be seen in the "test_sqllog.c" source file in
2310** the canonical SQLite source tree.</dd>
2314** <dd>^SQLITE_CONFIG_MMAP_SIZE takes two 64-bit integer (sqlite3_int64) values
2315** that are the default mmap size limit (the default setting for
2316** [PRAGMA mmap_size]) and the maximum allowed mmap size limit.
2317** ^The default setting can be overridden by each database connection using
2318** either the [PRAGMA mmap_size] command, or by using the
2319** [SQLITE_FCNTL_MMAP_SIZE] file control. ^(The maximum allowed mmap size
2320** will be silently truncated if necessary so that it does not exceed the
2321** compile-time maximum mmap size set by the
2322** [SQLITE_MAX_MMAP_SIZE] compile-time option.)^
2323** ^If either argument to this option is negative, then that argument is
2324** changed to its compile-time default.
2328** <dd>^The SQLITE_CONFIG_WIN32_HEAPSIZE option is only available if SQLite is
2329** compiled for Windows with the [SQLITE_WIN32_MALLOC] pre-processor macro
2330** defined. ^SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit unsigned integer value
2331** that specifies the maximum size of the created heap.
2335** <dd>^The SQLITE_CONFIG_PCACHE_HDRSZ option takes a single parameter which
2336** is a pointer to an integer and writes into that integer the number of extra
2337** bytes per page required for each page in [SQLITE_CONFIG_PAGECACHE].
2338** The amount of extra space required can change depending on the compiler,
2339** target platform, and SQLite version.
2343** <dd>^The SQLITE_CONFIG_PMASZ option takes a single parameter which
2344** is an unsigned integer and sets the "Minimum PMA Size" for the multithreaded
2345** sorter to that integer. The default minimum PMA Size is set by the
2346** [SQLITE_SORTER_PMASZ] compile-time option. New threads are launched
2347** to help with sort operations when multithreaded sorting
2348** is enabled (using the [PRAGMA threads] command) and the amount of content
2349** to be sorted exceeds the page size times the minimum of the
2350** [PRAGMA cache_size] setting and this value.
2354** <dd>^The SQLITE_CONFIG_STMTJRNL_SPILL option takes a single parameter which
2355** becomes the [statement journal] spill-to-disk threshold.
2356** [Statement journals] are held in memory until their size (in bytes)
2357** exceeds this threshold, at which point they are written to disk.
2358** Or if the threshold is -1, statement journals are always held
2359** exclusively in memory.
2360** Since many statement journals never become large, setting the spill
2361** threshold to a value such as 64KiB can greatly reduce the amount of
2362** I/O required to support statement rollback.
2363** The default value for this setting is controlled by the
2364** [SQLITE_STMTJRNL_SPILL] compile-time option.
2368** <dd>The SQLITE_CONFIG_SORTERREF_SIZE option accepts a single parameter
2369** of type (int) - the new value of the sorter-reference size threshold.
2370** Usually, when SQLite uses an external sort to order records according
2371** to an ORDER BY clause, all fields required by the caller are present in the
2372** sorted records. However, if SQLite determines based on the declared type
2373** of a table column that its values are likely to be very large - larger
2374** than the configured sorter-reference size threshold - then a reference
2375** is stored in each sorted record and the required column values loaded
2376** from the database as records are returned in sorted order. The default
2377** value for this option is to never use this optimization. Specifying a
2378** negative value for this option restores the default behaviour.
2379** This option is only available if SQLite is compiled with the
2380** [SQLITE_ENABLE_SORTER_REFERENCES] compile-time option.
2384** <dd>The SQLITE_CONFIG_MEMDB_MAXSIZE option accepts a single parameter
2385** [sqlite3_int64] parameter which is the default maximum size for an in-memory
2386** database created using [sqlite3_deserialize()]. This default maximum
2387** size can be adjusted up or down for individual databases using the
2388** [SQLITE_FCNTL_SIZE_LIMIT] [sqlite3_file_control|file-control]. If this
2389** configuration setting is never used, then the default maximum is determined
2390** by the [SQLITE_MEMDB_DEFAULT_MAXSIZE] compile-time option. If that
2391** compile-time option is not set, then the default maximum is 1073741824.
2392** </dl>
2394#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */
2395#define SQLITE_CONFIG_MULTITHREAD 2 /* nil */
2396#define SQLITE_CONFIG_SERIALIZED 3 /* nil */
2397#define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */
2398#define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */
2399#define SQLITE_CONFIG_SCRATCH 6 /* No longer used */
2400#define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */
2401#define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */
2402#define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */
2403#define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */
2404#define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */
2405/* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */
2406#define SQLITE_CONFIG_LOOKASIDE 13 /* int int */
2407#define SQLITE_CONFIG_PCACHE 14 /* no-op */
2408#define SQLITE_CONFIG_GETPCACHE 15 /* no-op */
2409#define SQLITE_CONFIG_LOG 16 /* xFunc, void* */
2410#define SQLITE_CONFIG_URI 17 /* int */
2411#define SQLITE_CONFIG_PCACHE2 18 /* sqlite3_pcache_methods2* */
2412#define SQLITE_CONFIG_GETPCACHE2 19 /* sqlite3_pcache_methods2* */
2413#define SQLITE_CONFIG_COVERING_INDEX_SCAN 20 /* int */
2414#define SQLITE_CONFIG_SQLLOG 21 /* xSqllog, void* */
2415#define SQLITE_CONFIG_MMAP_SIZE 22 /* sqlite3_int64, sqlite3_int64 */
2416#define SQLITE_CONFIG_WIN32_HEAPSIZE 23 /* int nByte */
2417#define SQLITE_CONFIG_PCACHE_HDRSZ 24 /* int *psz */
2418#define SQLITE_CONFIG_PMASZ 25 /* unsigned int szPma */
2419#define SQLITE_CONFIG_STMTJRNL_SPILL 26 /* int nByte */
2420#define SQLITE_CONFIG_SMALL_MALLOC 27 /* boolean */
2421#define SQLITE_CONFIG_SORTERREF_SIZE 28 /* int nByte */
2422#define SQLITE_CONFIG_MEMDB_MAXSIZE 29 /* sqlite3_int64 */
2425** CAPI3REF: Database Connection Configuration Options
2427** These constants are the available integer configuration options that
2428** can be passed as the second argument to the [sqlite3_db_config()] interface.
2430** New configuration options may be added in future releases of SQLite.
2431** Existing configuration options might be discontinued. Applications
2432** should check the return code from [sqlite3_db_config()] to make sure that
2433** the call worked. ^The [sqlite3_db_config()] interface will return a
2434** non-zero [error code] if a discontinued or unsupported configuration option
2435** is invoked.
2437** <dl>
2440** <dd> ^This option takes three additional arguments that determine the
2441** [lookaside memory allocator] configuration for the [database connection].
2442** ^The first argument (the third parameter to [sqlite3_db_config()] is a
2443** pointer to a memory buffer to use for lookaside memory.
2444** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb
2445** may be NULL in which case SQLite will allocate the
2446** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the
2447** size of each lookaside buffer slot. ^The third argument is the number of
2448** slots. The size of the buffer in the first argument must be greater than
2449** or equal to the product of the second and third arguments. The buffer
2450** must be aligned to an 8-byte boundary. ^If the second argument to
2451** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally
2452** rounded down to the next smaller multiple of 8. ^(The lookaside memory
2453** configuration for a database connection can only be changed when that
2454** connection is not currently using lookaside memory, or in other words
2455** when the "current value" returned by
2456** [sqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero.
2457** Any attempt to change the lookaside memory configuration when lookaside
2458** memory is in use leaves the configuration unchanged and returns
2459** [SQLITE_BUSY].)^</dd>
2463** <dd> ^This option is used to enable or disable the enforcement of
2464** [foreign key constraints]. There should be two additional arguments.
2465** The first argument is an integer which is 0 to disable FK enforcement,
2466** positive to enable FK enforcement or negative to leave FK enforcement
2467** unchanged. The second parameter is a pointer to an integer into which
2468** is written 0 or 1 to indicate whether FK enforcement is off or on
2469** following this call. The second parameter may be a NULL pointer, in
2470** which case the FK enforcement setting is not reported back. </dd>
2474** <dd> ^This option is used to enable or disable [CREATE TRIGGER | triggers].
2475** There should be two additional arguments.
2476** The first argument is an integer which is 0 to disable triggers,
2477** positive to enable triggers or negative to leave the setting unchanged.
2478** The second parameter is a pointer to an integer into which
2479** is written 0 or 1 to indicate whether triggers are disabled or enabled
2480** following this call. The second parameter may be a NULL pointer, in
2481** which case the trigger setting is not reported back.
2483** <p>Originally this option disabled all triggers. ^(However, since
2484** SQLite version 3.35.0, TEMP triggers are still allowed even if
2485** this option is off. So, in other words, this option now only disables
2486** triggers in the main database schema or in the schemas of ATTACH-ed
2487** databases.)^ </dd>
2491** <dd> ^This option is used to enable or disable [CREATE VIEW | views].
2492** There should be two additional arguments.
2493** The first argument is an integer which is 0 to disable views,
2494** positive to enable views or negative to leave the setting unchanged.
2495** The second parameter is a pointer to an integer into which
2496** is written 0 or 1 to indicate whether views are disabled or enabled
2497** following this call. The second parameter may be a NULL pointer, in
2498** which case the view setting is not reported back.
2500** <p>Originally this option disabled all views. ^(However, since
2501** SQLite version 3.35.0, TEMP views are still allowed even if
2502** this option is off. So, in other words, this option now only disables
2503** views in the main database schema or in the schemas of ATTACH-ed
2504** databases.)^ </dd>
2508** <dd> ^This option is used to enable or disable the
2509** [fts3_tokenizer()] function which is part of the
2510** [FTS3] full-text search engine extension.
2511** There should be two additional arguments.
2512** The first argument is an integer which is 0 to disable fts3_tokenizer() or
2513** positive to enable fts3_tokenizer() or negative to leave the setting
2514** unchanged.
2515** The second parameter is a pointer to an integer into which
2516** is written 0 or 1 to indicate whether fts3_tokenizer is disabled or enabled
2517** following this call. The second parameter may be a NULL pointer, in
2518** which case the new setting is not reported back. </dd>
2522** <dd> ^This option is used to enable or disable the [sqlite3_load_extension()]
2523** interface independently of the [load_extension()] SQL function.
2524** The [sqlite3_enable_load_extension()] API enables or disables both the
2525** C-API [sqlite3_load_extension()] and the SQL function [load_extension()].
2526** There should be two additional arguments.
2527** When the first argument to this interface is 1, then only the C-API is
2528** enabled and the SQL function remains disabled. If the first argument to
2529** this interface is 0, then both the C-API and the SQL function are disabled.
2530** If the first argument is -1, then no changes are made to state of either the
2531** C-API or the SQL function.
2532** The second parameter is a pointer to an integer into which
2533** is written 0 or 1 to indicate whether [sqlite3_load_extension()] interface
2534** is disabled or enabled following this call. The second parameter may
2535** be a NULL pointer, in which case the new setting is not reported back.
2536** </dd>
2539** <dd> ^This option is used to change the name of the "main" database
2540** schema. ^The sole argument is a pointer to a constant UTF8 string
2541** which will become the new schema name in place of "main". ^SQLite
2542** does not make a copy of the new main schema name string, so the application
2543** must ensure that the argument passed into this DBCONFIG option is unchanged
2544** until after the database connection closes.
2545** </dd>
2549** <dd> Usually, when a database in wal mode is closed or detached from a
2550** database handle, SQLite checks if this will mean that there are now no
2551** connections at all to the database. If so, it performs a checkpoint
2552** operation before closing the connection. This option may be used to
2553** override this behaviour. The first parameter passed to this operation
2554** is an integer - positive to disable checkpoints-on-close, or zero (the
2555** default) to enable them, and negative to leave the setting unchanged.
2556** The second parameter is a pointer to an integer
2557** into which is written 0 or 1 to indicate whether checkpoints-on-close
2558** have been disabled - 0 if they are not disabled, 1 if they are.
2559** </dd>
2562** <dd>^(The SQLITE_DBCONFIG_ENABLE_QPSG option activates or deactivates
2563** the [query planner stability guarantee] (QPSG). When the QPSG is active,
2564** a single SQL query statement will always use the same algorithm regardless
2565** of values of [bound parameters].)^ The QPSG disables some query optimizations
2566** that look at the values of bound parameters, which can make some queries
2567** slower. But the QPSG has the advantage of more predictable behavior. With
2568** the QPSG active, SQLite will always use the same query plan in the field as
2569** was used during testing in the lab.
2570** The first argument to this setting is an integer which is 0 to disable
2571** the QPSG, positive to enable QPSG, or negative to leave the setting
2572** unchanged. The second parameter is a pointer to an integer into which
2573** is written 0 or 1 to indicate whether the QPSG is disabled or enabled
2574** following this call.
2575** </dd>
2578** <dd> By default, the output of EXPLAIN QUERY PLAN commands does not
2579** include output for any operations performed by trigger programs. This
2580** option is used to set or clear (the default) a flag that governs this
2581** behavior. The first parameter passed to this operation is an integer -
2582** positive to enable output for trigger programs, or zero to disable it,
2583** or negative to leave the setting unchanged.
2584** The second parameter is a pointer to an integer into which is written
2585** 0 or 1 to indicate whether output-for-triggers has been disabled - 0 if
2586** it is not disabled, 1 if it is.
2587** </dd>
2590** <dd> Set the SQLITE_DBCONFIG_RESET_DATABASE flag and then run
2591** [VACUUM] in order to reset a database back to an empty database
2592** with no schema and no content. The following process works even for
2593** a badly corrupted database file:
2594** <ol>
2595** <li> If the database connection is newly opened, make sure it has read the
2596** database schema by preparing then discarding some query against the
2597** database, or calling sqlite3_table_column_metadata(), ignoring any
2598** errors. This step is only necessary if the application desires to keep
2599** the database in WAL mode after the reset if it was in WAL mode before
2600** the reset.
2601** <li> sqlite3_db_config(db, SQLITE_DBCONFIG_RESET_DATABASE, 1, 0);
2602** <li> [sqlite3_exec](db, "[VACUUM]", 0, 0, 0);
2603** <li> sqlite3_db_config(db, SQLITE_DBCONFIG_RESET_DATABASE, 0, 0);
2604** </ol>
2605** Because resetting a database is destructive and irreversible, the
2606** process requires the use of this obscure API and multiple steps to help
2607** ensure that it does not happen by accident.
2610** <dd>The SQLITE_DBCONFIG_DEFENSIVE option activates or deactivates the
2611** "defensive" flag for a database connection. When the defensive
2612** flag is enabled, language features that allow ordinary SQL to
2613** deliberately corrupt the database file are disabled. The disabled
2614** features include but are not limited to the following:
2615** <ul>
2616** <li> The [PRAGMA writable_schema=ON] statement.
2617** <li> The [PRAGMA journal_mode=OFF] statement.
2618** <li> Writes to the [sqlite_dbpage] virtual table.
2619** <li> Direct writes to [shadow tables].
2620** </ul>
2621** </dd>
2624** <dd>The SQLITE_DBCONFIG_WRITABLE_SCHEMA option activates or deactivates the
2625** "writable_schema" flag. This has the same effect and is logically equivalent
2626** to setting [PRAGMA writable_schema=ON] or [PRAGMA writable_schema=OFF].
2627** The first argument to this setting is an integer which is 0 to disable
2628** the writable_schema, positive to enable writable_schema, or negative to
2629** leave the setting unchanged. The second parameter is a pointer to an
2630** integer into which is written 0 or 1 to indicate whether the writable_schema
2631** is enabled or disabled following this call.
2632** </dd>
2636** <dd>The SQLITE_DBCONFIG_LEGACY_ALTER_TABLE option activates or deactivates
2637** the legacy behavior of the [ALTER TABLE RENAME] command such it
2638** behaves as it did prior to [version 3.24.0] (2018-06-04). See the
2639** "Compatibility Notice" on the [ALTER TABLE RENAME documentation] for
2640** additional information. This feature can also be turned on and off
2641** using the [PRAGMA legacy_alter_table] statement.
2642** </dd>
2646** <dd>The SQLITE_DBCONFIG_DQS_DML option activates or deactivates
2647** the legacy [double-quoted string literal] misfeature for DML statements
2648** only, that is DELETE, INSERT, SELECT, and UPDATE statements. The
2649** default value of this setting is determined by the [-DSQLITE_DQS]
2650** compile-time option.
2651** </dd>
2655** <dd>The SQLITE_DBCONFIG_DQS option activates or deactivates
2656** the legacy [double-quoted string literal] misfeature for DDL statements,
2657** such as CREATE TABLE and CREATE INDEX. The
2658** default value of this setting is determined by the [-DSQLITE_DQS]
2659** compile-time option.
2660** </dd>
2664** <dd>The SQLITE_DBCONFIG_TRUSTED_SCHEMA option tells SQLite to
2665** assume that database schemas are untainted by malicious content.
2666** When the SQLITE_DBCONFIG_TRUSTED_SCHEMA option is disabled, SQLite
2667** takes additional defensive steps to protect the application from harm
2668** including:
2669** <ul>
2670** <li> Prohibit the use of SQL functions inside triggers, views,
2671** CHECK constraints, DEFAULT clauses, expression indexes,
2672** partial indexes, or generated columns
2673** unless those functions are tagged with [SQLITE_INNOCUOUS].
2674** <li> Prohibit the use of virtual tables inside of triggers or views
2675** unless those virtual tables are tagged with [SQLITE_VTAB_INNOCUOUS].
2676** </ul>
2677** This setting defaults to "on" for legacy compatibility, however
2678** all applications are advised to turn it off if possible. This setting
2679** can also be controlled using the [PRAGMA trusted_schema] statement.
2680** </dd>
2684** <dd>The SQLITE_DBCONFIG_LEGACY_FILE_FORMAT option activates or deactivates
2685** the legacy file format flag. When activated, this flag causes all newly
2686** created database file to have a schema format version number (the 4-byte
2687** integer found at offset 44 into the database header) of 1. This in turn
2688** means that the resulting database file will be readable and writable by
2689** any SQLite version back to 3.0.0 ([dateof:3.0.0]). Without this setting,
2690** newly created databases are generally not understandable by SQLite versions
2691** prior to 3.3.0 ([dateof:3.3.0]). As these words are written, there
2692** is now scarcely any need to generated database files that are compatible
2693** all the way back to version 3.0.0, and so this setting is of little
2694** practical use, but is provided so that SQLite can continue to claim the
2695** ability to generate new database files that are compatible with version
2696** 3.0.0.
2697** <p>Note that when the SQLITE_DBCONFIG_LEGACY_FILE_FORMAT setting is on,
2698** the [VACUUM] command will fail with an obscure error when attempting to
2699** process a table with generated columns and a descending index. This is
2700** not considered a bug since SQLite versions 3.3.0 and earlier do not support
2701** either generated columns or decending indexes.
2702** </dd>
2703** </dl>
2705#define SQLITE_DBCONFIG_MAINDBNAME 1000 /* const char* */
2706#define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */
2707#define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */
2708#define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */
2709#define SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER 1004 /* int int* */
2710#define SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION 1005 /* int int* */
2711#define SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE 1006 /* int int* */
2712#define SQLITE_DBCONFIG_ENABLE_QPSG 1007 /* int int* */
2713#define SQLITE_DBCONFIG_TRIGGER_EQP 1008 /* int int* */
2714#define SQLITE_DBCONFIG_RESET_DATABASE 1009 /* int int* */
2715#define SQLITE_DBCONFIG_DEFENSIVE 1010 /* int int* */
2716#define SQLITE_DBCONFIG_WRITABLE_SCHEMA 1011 /* int int* */
2717#define SQLITE_DBCONFIG_LEGACY_ALTER_TABLE 1012 /* int int* */
2718#define SQLITE_DBCONFIG_DQS_DML 1013 /* int int* */
2719#define SQLITE_DBCONFIG_DQS_DDL 1014 /* int int* */
2720#define SQLITE_DBCONFIG_ENABLE_VIEW 1015 /* int int* */
2721#define SQLITE_DBCONFIG_LEGACY_FILE_FORMAT 1016 /* int int* */
2722#define SQLITE_DBCONFIG_TRUSTED_SCHEMA 1017 /* int int* */
2723#define SQLITE_DBCONFIG_MAX 1017 /* Largest DBCONFIG */
2726** CAPI3REF: Enable Or Disable Extended Result Codes
2727** METHOD: sqlite3
2729** ^The sqlite3_extended_result_codes() routine enables or disables the
2730** [extended result codes] feature of SQLite. ^The extended result
2731** codes are disabled by default for historical compatibility.
2733SQLITE_API int sqlite3_extended_result_codes(sqlite3*, int onoff);
2736** CAPI3REF: Last Insert Rowid
2737** METHOD: sqlite3
2739** ^Each entry in most SQLite tables (except for [WITHOUT ROWID] tables)
2740** has a unique 64-bit signed
2741** integer key called the [ROWID | "rowid"]. ^The rowid is always available
2742** as an undeclared column named ROWID, OID, or _ROWID_ as long as those
2743** names are not also used by explicitly declared columns. ^If
2744** the table has a column of type [INTEGER PRIMARY KEY] then that column
2745** is another alias for the rowid.
2747** ^The sqlite3_last_insert_rowid(D) interface usually returns the [rowid] of
2748** the most recent successful [INSERT] into a rowid table or [virtual table]
2749** on database connection D. ^Inserts into [WITHOUT ROWID] tables are not
2750** recorded. ^If no successful [INSERT]s into rowid tables have ever occurred
2751** on the database connection D, then sqlite3_last_insert_rowid(D) returns
2752** zero.
2754** As well as being set automatically as rows are inserted into database
2755** tables, the value returned by this function may be set explicitly by
2756** [sqlite3_set_last_insert_rowid()]
2758** Some virtual table implementations may INSERT rows into rowid tables as
2759** part of committing a transaction (e.g. to flush data accumulated in memory
2760** to disk). In this case subsequent calls to this function return the rowid
2761** associated with these internal INSERT operations, which leads to
2762** unintuitive results. Virtual table implementations that do write to rowid
2763** tables in this way can avoid this problem by restoring the original
2764** rowid value using [sqlite3_set_last_insert_rowid()] before returning
2765** control to the user.
2767** ^(If an [INSERT] occurs within a trigger then this routine will
2768** return the [rowid] of the inserted row as long as the trigger is
2769** running. Once the trigger program ends, the value returned
2770** by this routine reverts to what it was before the trigger was fired.)^
2772** ^An [INSERT] that fails due to a constraint violation is not a
2773** successful [INSERT] and does not change the value returned by this
2775** and INSERT OR ABORT make no changes to the return value of this
2776** routine when their insertion fails. ^(When INSERT OR REPLACE
2777** encounters a constraint violation, it does not fail. The
2778** INSERT continues to completion after deleting rows that caused
2779** the constraint problem so INSERT OR REPLACE will always change
2780** the return value of this interface.)^
2782** ^For the purposes of this routine, an [INSERT] is considered to
2783** be successful even if it is subsequently rolled back.
2785** This function is accessible to SQL statements via the
2786** [last_insert_rowid() SQL function].
2788** If a separate thread performs a new [INSERT] on the same
2789** database connection while the [sqlite3_last_insert_rowid()]
2790** function is running and thus changes the last insert [rowid],
2791** then the value returned by [sqlite3_last_insert_rowid()] is
2792** unpredictable and might not equal either the old or the new
2793** last insert [rowid].
2795SQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*);
2798** CAPI3REF: Set the Last Insert Rowid value.
2799** METHOD: sqlite3
2801** The sqlite3_set_last_insert_rowid(D, R) method allows the application to
2802** set the value returned by calling sqlite3_last_insert_rowid(D) to R
2803** without inserting a row into the database.
2805SQLITE_API void sqlite3_set_last_insert_rowid(sqlite3*,sqlite3_int64);
2808** CAPI3REF: Count The Number Of Rows Modified
2809** METHOD: sqlite3
2811** ^These functions return the number of rows modified, inserted or
2812** deleted by the most recently completed INSERT, UPDATE or DELETE
2813** statement on the database connection specified by the only parameter.
2814** The two functions are identical except for the type of the return value
2815** and that if the number of rows modified by the most recent INSERT, UPDATE
2816** or DELETE is greater than the maximum value supported by type "int", then
2817** the return value of sqlite3_changes() is undefined. ^Executing any other
2818** type of SQL statement does not modify the value returned by these functions.
2820** ^Only changes made directly by the INSERT, UPDATE or DELETE statement are
2821** considered - auxiliary changes caused by [CREATE TRIGGER | triggers],
2822** [foreign key actions] or [REPLACE] constraint resolution are not counted.
2824** Changes to a view that are intercepted by
2825** [INSTEAD OF trigger | INSTEAD OF triggers] are not counted. ^The value
2826** returned by sqlite3_changes() immediately after an INSERT, UPDATE or
2827** DELETE statement run on a view is always zero. Only changes made to real
2828** tables are counted.
2830** Things are more complicated if the sqlite3_changes() function is
2831** executed while a trigger program is running. This may happen if the
2832** program uses the [changes() SQL function], or if some other callback
2833** function invokes sqlite3_changes() directly. Essentially:
2835** <ul>
2836** <li> ^(Before entering a trigger program the value returned by
2837** sqlite3_changes() function is saved. After the trigger program
2838** has finished, the original value is restored.)^
2840** <li> ^(Within a trigger program each INSERT, UPDATE and DELETE
2841** statement sets the value returned by sqlite3_changes()
2842** upon completion as normal. Of course, this value will not include
2843** any changes performed by sub-triggers, as the sqlite3_changes()
2844** value will be saved and restored after each sub-trigger has run.)^
2845** </ul>
2847** ^This means that if the changes() SQL function (or similar) is used
2848** by the first INSERT, UPDATE or DELETE statement within a trigger, it
2849** returns the value as set when the calling statement began executing.
2850** ^If it is used by the second or subsequent such statement within a trigger
2851** program, the value returned reflects the number of rows modified by the
2852** previous INSERT, UPDATE or DELETE statement within the same trigger.
2854** If a separate thread makes changes on the same database connection
2855** while [sqlite3_changes()] is running then the value returned
2856** is unpredictable and not meaningful.
2858** See also:
2859** <ul>
2860** <li> the [sqlite3_total_changes()] interface
2861** <li> the [count_changes pragma]
2862** <li> the [changes() SQL function]
2863** <li> the [data_version pragma]
2864** </ul>
2866SQLITE_API int sqlite3_changes(sqlite3*);
2867SQLITE_API sqlite3_int64 sqlite3_changes64(sqlite3*);
2870** CAPI3REF: Total Number Of Rows Modified
2871** METHOD: sqlite3
2873** ^These functions return the total number of rows inserted, modified or
2874** deleted by all [INSERT], [UPDATE] or [DELETE] statements completed
2875** since the database connection was opened, including those executed as
2876** part of trigger programs. The two functions are identical except for the
2877** type of the return value and that if the number of rows modified by the
2878** connection exceeds the maximum value supported by type "int", then
2879** the return value of sqlite3_total_changes() is undefined. ^Executing
2880** any other type of SQL statement does not affect the value returned by
2881** sqlite3_total_changes().
2883** ^Changes made as part of [foreign key actions] are included in the
2884** count, but those made as part of REPLACE constraint resolution are
2885** not. ^Changes to a view that are intercepted by INSTEAD OF triggers
2886** are not counted.
2888** The [sqlite3_total_changes(D)] interface only reports the number
2889** of rows that changed due to SQL statement run against database
2890** connection D. Any changes by other database connections are ignored.
2891** To detect changes against a database file from other database
2892** connections use the [PRAGMA data_version] command or the
2893** [SQLITE_FCNTL_DATA_VERSION] [file control].
2895** If a separate thread makes changes on the same database connection
2896** while [sqlite3_total_changes()] is running then the value
2897** returned is unpredictable and not meaningful.
2899** See also:
2900** <ul>
2901** <li> the [sqlite3_changes()] interface
2902** <li> the [count_changes pragma]
2903** <li> the [changes() SQL function]
2904** <li> the [data_version pragma]
2905** <li> the [SQLITE_FCNTL_DATA_VERSION] [file control]
2906** </ul>
2908SQLITE_API int sqlite3_total_changes(sqlite3*);
2909SQLITE_API sqlite3_int64 sqlite3_total_changes64(sqlite3*);
2912** CAPI3REF: Interrupt A Long-Running Query
2913** METHOD: sqlite3
2915** ^This function causes any pending database operation to abort and
2916** return at its earliest opportunity. This routine is typically
2917** called in response to a user action such as pressing "Cancel"
2918** or Ctrl-C where the user wants a long query operation to halt
2919** immediately.
2921** ^It is safe to call this routine from a thread different from the
2922** thread that is currently running the database operation. But it
2923** is not safe to call this routine with a [database connection] that
2924** is closed or might close before sqlite3_interrupt() returns.
2926** ^If an SQL operation is very nearly finished at the time when
2927** sqlite3_interrupt() is called, then it might not have an opportunity
2928** to be interrupted and might continue to completion.
2930** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT].
2931** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE
2932** that is inside an explicit transaction, then the entire transaction
2933** will be rolled back automatically.
2935** ^The sqlite3_interrupt(D) call is in effect until all currently running
2936** SQL statements on [database connection] D complete. ^Any new SQL statements
2937** that are started after the sqlite3_interrupt() call and before the
2938** running statement count reaches zero are interrupted as if they had been
2939** running prior to the sqlite3_interrupt() call. ^New SQL statements
2940** that are started after the running statement count reaches zero are
2941** not effected by the sqlite3_interrupt().
2942** ^A call to sqlite3_interrupt(D) that occurs when there are no running
2943** SQL statements is a no-op and has no effect on SQL statements
2944** that are started after the sqlite3_interrupt() call returns.
2946SQLITE_API void sqlite3_interrupt(sqlite3*);
2949** CAPI3REF: Determine If An SQL Statement Is Complete
2951** These routines are useful during command-line input to determine if the
2952** currently entered text seems to form a complete SQL statement or
2953** if additional input is needed before sending the text into
2954** SQLite for parsing. ^These routines return 1 if the input string
2955** appears to be a complete SQL statement. ^A statement is judged to be
2956** complete if it ends with a semicolon token and is not a prefix of a
2957** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within
2958** string literals or quoted identifier names or comments are not
2959** independent tokens (they are part of the token in which they are
2960** embedded) and thus do not count as a statement terminator. ^Whitespace
2961** and comments that follow the final semicolon are ignored.
2963** ^These routines return 0 if the statement is incomplete. ^If a
2964** memory allocation fails, then SQLITE_NOMEM is returned.
2966** ^These routines do not parse the SQL statements thus
2967** will not detect syntactically incorrect SQL.
2969** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior
2970** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked
2971** automatically by sqlite3_complete16(). If that initialization fails,
2972** then the return value from sqlite3_complete16() will be non-zero
2973** regardless of whether or not the input SQL is complete.)^
2975** The input to [sqlite3_complete()] must be a zero-terminated
2976** UTF-8 string.
2978** The input to [sqlite3_complete16()] must be a zero-terminated
2979** UTF-16 string in native byte order.
2981SQLITE_API int sqlite3_complete(const char *sql);
2982SQLITE_API int sqlite3_complete16(const void *sql);
2985** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors
2986** KEYWORDS: {busy-handler callback} {busy handler}
2987** METHOD: sqlite3
2989** ^The sqlite3_busy_handler(D,X,P) routine sets a callback function X
2990** that might be invoked with argument P whenever
2991** an attempt is made to access a database table associated with
2992** [database connection] D when another thread
2993** or process has the table locked.
2994** The sqlite3_busy_handler() interface is used to implement
2995** [sqlite3_busy_timeout()] and [PRAGMA busy_timeout].
2997** ^If the busy callback is NULL, then [SQLITE_BUSY]
2998** is returned immediately upon encountering the lock. ^If the busy callback
2999** is not NULL, then the callback might be invoked with two arguments.
3001** ^The first argument to the busy handler is a copy of the void* pointer which
3002** is the third argument to sqlite3_busy_handler(). ^The second argument to
3003** the busy handler callback is the number of times that the busy handler has
3004** been invoked previously for the same locking event. ^If the
3005** busy callback returns 0, then no additional attempts are made to
3006** access the database and [SQLITE_BUSY] is returned
3007** to the application.
3008** ^If the callback returns non-zero, then another attempt
3009** is made to access the database and the cycle repeats.
3011** The presence of a busy handler does not guarantee that it will be invoked
3012** when there is lock contention. ^If SQLite determines that invoking the busy
3013** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY]
3014** to the application instead of invoking the
3015** busy handler.
3016** Consider a scenario where one process is holding a read lock that
3017** it is trying to promote to a reserved lock and
3018** a second process is holding a reserved lock that it is trying
3019** to promote to an exclusive lock. The first process cannot proceed
3020** because it is blocked by the second and the second process cannot
3021** proceed because it is blocked by the first. If both processes
3022** invoke the busy handlers, neither will make any progress. Therefore,
3023** SQLite returns [SQLITE_BUSY] for the first process, hoping that this
3024** will induce the first process to release its read lock and allow
3025** the second process to proceed.
3027** ^The default busy callback is NULL.
3029** ^(There can only be a single busy handler defined for each
3030** [database connection]. Setting a new busy handler clears any
3031** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()]
3032** or evaluating [PRAGMA busy_timeout=N] will change the
3033** busy handler and thus clear any previously set busy handler.
3035** The busy callback should not take any actions which modify the
3036** database connection that invoked the busy handler. In other words,
3037** the busy handler is not reentrant. Any such actions
3038** result in undefined behavior.
3040** A busy handler must not close the database connection
3041** or [prepared statement] that invoked the busy handler.
3043SQLITE_API int sqlite3_busy_handler(sqlite3*,int(*)(void*,int),void*);
3046** CAPI3REF: Set A Busy Timeout
3047** METHOD: sqlite3
3049** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps
3050** for a specified amount of time when a table is locked. ^The handler
3051** will sleep multiple times until at least "ms" milliseconds of sleeping
3052** have accumulated. ^After at least "ms" milliseconds of sleeping,
3053** the handler returns 0 which causes [sqlite3_step()] to return
3054** [SQLITE_BUSY].
3056** ^Calling this routine with an argument less than or equal to zero
3057** turns off all busy handlers.
3059** ^(There can only be a single busy handler for a particular
3060** [database connection] at any given moment. If another busy handler
3061** was defined (using [sqlite3_busy_handler()]) prior to calling
3062** this routine, that other busy handler is cleared.)^
3064** See also: [PRAGMA busy_timeout]
3066SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms);
3069** CAPI3REF: Convenience Routines For Running Queries
3070** METHOD: sqlite3
3072** This is a legacy interface that is preserved for backwards compatibility.
3073** Use of this interface is not recommended.
3075** Definition: A <b>result table</b> is memory data structure created by the
3076** [sqlite3_get_table()] interface. A result table records the
3077** complete query results from one or more queries.
3079** The table conceptually has a number of rows and columns. But
3080** these numbers are not part of the result table itself. These
3081** numbers are obtained separately. Let N be the number of rows
3082** and M be the number of columns.
3084** A result table is an array of pointers to zero-terminated UTF-8 strings.
3085** There are (N+1)*M elements in the array. The first M pointers point
3086** to zero-terminated strings that contain the names of the columns.
3087** The remaining entries all point to query results. NULL values result
3088** in NULL pointers. All other values are in their UTF-8 zero-terminated
3089** string representation as returned by [sqlite3_column_text()].
3091** A result table might consist of one or more memory allocations.
3092** It is not safe to pass a result table directly to [sqlite3_free()].
3093** A result table should be deallocated using [sqlite3_free_table()].
3095** ^(As an example of the result table format, suppose a query result
3096** is as follows:
3098** <blockquote><pre>
3099** Name | Age
3100** -----------------------
3101** Alice | 43
3102** Bob | 28
3103** Cindy | 21
3104** </pre></blockquote>
3106** There are two columns (M==2) and three rows (N==3). Thus the
3107** result table has 8 entries. Suppose the result table is stored
3108** in an array named azResult. Then azResult holds this content:
3110** <blockquote><pre>
3111** azResult&#91;0] = "Name";
3112** azResult&#91;1] = "Age";
3113** azResult&#91;2] = "Alice";
3114** azResult&#91;3] = "43";
3115** azResult&#91;4] = "Bob";
3116** azResult&#91;5] = "28";
3117** azResult&#91;6] = "Cindy";
3118** azResult&#91;7] = "21";
3119** </pre></blockquote>)^
3121** ^The sqlite3_get_table() function evaluates one or more
3122** semicolon-separated SQL statements in the zero-terminated UTF-8
3123** string of its 2nd parameter and returns a result table to the
3124** pointer given in its 3rd parameter.
3126** After the application has finished with the result from sqlite3_get_table(),
3127** it must pass the result table pointer to sqlite3_free_table() in order to
3128** release the memory that was malloced. Because of the way the
3129** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling
3130** function must not try to call [sqlite3_free()] directly. Only
3131** [sqlite3_free_table()] is able to release the memory properly and safely.
3133** The sqlite3_get_table() interface is implemented as a wrapper around
3134** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access
3135** to any internal data structures of SQLite. It uses only the public
3136** interface defined here. As a consequence, errors that occur in the
3137** wrapper layer outside of the internal [sqlite3_exec()] call are not
3138** reflected in subsequent calls to [sqlite3_errcode()] or
3139** [sqlite3_errmsg()].
3141SQLITE_API int sqlite3_get_table(
3142 sqlite3 *db, /* An open database */
3143 const char *zSql, /* SQL to be evaluated */
3144 char ***pazResult, /* Results of the query */
3145 int *pnRow, /* Number of result rows written here */
3146 int *pnColumn, /* Number of result columns written here */
3147 char **pzErrmsg /* Error msg written here */
3149SQLITE_API void sqlite3_free_table(char **result);
3152** CAPI3REF: Formatted String Printing Functions
3154** These routines are work-alikes of the "printf()" family of functions
3155** from the standard C library.
3156** These routines understand most of the common formatting options from
3157** the standard library printf()
3158** plus some additional non-standard formats ([%q], [%Q], [%w], and [%z]).
3159** See the [built-in printf()] documentation for details.
3161** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their
3162** results into memory obtained from [sqlite3_malloc64()].
3163** The strings returned by these two routines should be
3164** released by [sqlite3_free()]. ^Both routines return a
3165** NULL pointer if [sqlite3_malloc64()] is unable to allocate enough
3166** memory to hold the resulting string.
3168** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from
3169** the standard C library. The result is written into the
3170** buffer supplied as the second parameter whose size is given by
3171** the first parameter. Note that the order of the
3172** first two parameters is reversed from snprintf().)^ This is an
3173** historical accident that cannot be fixed without breaking
3174** backwards compatibility. ^(Note also that sqlite3_snprintf()
3175** returns a pointer to its buffer instead of the number of
3176** characters actually written into the buffer.)^ We admit that
3177** the number of characters written would be a more useful return
3178** value but we cannot change the implementation of sqlite3_snprintf()
3179** now without breaking compatibility.
3181** ^As long as the buffer size is greater than zero, sqlite3_snprintf()
3182** guarantees that the buffer is always zero-terminated. ^The first
3183** parameter "n" is the total size of the buffer, including space for
3184** the zero terminator. So the longest string that can be completely
3185** written will be n-1 characters.
3187** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf().
3189** See also: [built-in printf()], [printf() SQL function]
3191SQLITE_API char *sqlite3_mprintf(const char*,...);
3192SQLITE_API char *sqlite3_vmprintf(const char*, va_list);
3193SQLITE_API char *sqlite3_snprintf(int,char*,const char*, ...);
3194SQLITE_API char *sqlite3_vsnprintf(int,char*,const char*, va_list);
3197** CAPI3REF: Memory Allocation Subsystem
3199** The SQLite core uses these three routines for all of its own
3200** internal memory allocation needs. "Core" in the previous sentence
3201** does not include operating-system specific [VFS] implementation. The
3202** Windows VFS uses native malloc() and free() for some operations.
3204** ^The sqlite3_malloc() routine returns a pointer to a block
3205** of memory at least N bytes in length, where N is the parameter.
3206** ^If sqlite3_malloc() is unable to obtain sufficient free
3207** memory, it returns a NULL pointer. ^If the parameter N to
3208** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns
3209** a NULL pointer.
3211** ^The sqlite3_malloc64(N) routine works just like
3212** sqlite3_malloc(N) except that N is an unsigned 64-bit integer instead
3213** of a signed 32-bit integer.
3215** ^Calling sqlite3_free() with a pointer previously returned
3216** by sqlite3_malloc() or sqlite3_realloc() releases that memory so
3217** that it might be reused. ^The sqlite3_free() routine is
3218** a no-op if is called with a NULL pointer. Passing a NULL pointer
3219** to sqlite3_free() is harmless. After being freed, memory
3220** should neither be read nor written. Even reading previously freed
3221** memory might result in a segmentation fault or other severe error.
3222** Memory corruption, a segmentation fault, or other severe error
3223** might result if sqlite3_free() is called with a non-NULL pointer that
3224** was not obtained from sqlite3_malloc() or sqlite3_realloc().
3226** ^The sqlite3_realloc(X,N) interface attempts to resize a
3227** prior memory allocation X to be at least N bytes.
3228** ^If the X parameter to sqlite3_realloc(X,N)
3229** is a NULL pointer then its behavior is identical to calling
3230** sqlite3_malloc(N).
3231** ^If the N parameter to sqlite3_realloc(X,N) is zero or
3232** negative then the behavior is exactly the same as calling
3233** sqlite3_free(X).
3234** ^sqlite3_realloc(X,N) returns a pointer to a memory allocation
3235** of at least N bytes in size or NULL if insufficient memory is available.
3236** ^If M is the size of the prior allocation, then min(N,M) bytes
3237** of the prior allocation are copied into the beginning of buffer returned
3238** by sqlite3_realloc(X,N) and the prior allocation is freed.
3239** ^If sqlite3_realloc(X,N) returns NULL and N is positive, then the
3240** prior allocation is not freed.
3242** ^The sqlite3_realloc64(X,N) interfaces works the same as
3243** sqlite3_realloc(X,N) except that N is a 64-bit unsigned integer instead
3244** of a 32-bit signed integer.
3246** ^If X is a memory allocation previously obtained from sqlite3_malloc(),
3247** sqlite3_malloc64(), sqlite3_realloc(), or sqlite3_realloc64(), then
3248** sqlite3_msize(X) returns the size of that memory allocation in bytes.
3249** ^The value returned by sqlite3_msize(X) might be larger than the number
3250** of bytes requested when X was allocated. ^If X is a NULL pointer then
3251** sqlite3_msize(X) returns zero. If X points to something that is not
3252** the beginning of memory allocation, or if it points to a formerly
3253** valid memory allocation that has now been freed, then the behavior
3254** of sqlite3_msize(X) is undefined and possibly harmful.
3256** ^The memory returned by sqlite3_malloc(), sqlite3_realloc(),
3257** sqlite3_malloc64(), and sqlite3_realloc64()
3258** is always aligned to at least an 8 byte boundary, or to a
3259** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time
3260** option is used.
3262** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()]
3263** must be either NULL or else pointers obtained from a prior
3264** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have
3265** not yet been released.
3267** The application must not read or write any part of
3268** a block of memory after it has been released using
3269** [sqlite3_free()] or [sqlite3_realloc()].
3271SQLITE_API void *sqlite3_malloc(int);
3272SQLITE_API void *sqlite3_malloc64(sqlite3_uint64);
3273SQLITE_API void *sqlite3_realloc(void*, int);
3274SQLITE_API void *sqlite3_realloc64(void*, sqlite3_uint64);
3275SQLITE_API void sqlite3_free(void*);
3276SQLITE_API sqlite3_uint64 sqlite3_msize(void*);
3279** CAPI3REF: Memory Allocator Statistics
3281** SQLite provides these two interfaces for reporting on the status
3282** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()]
3283** routines, which form the built-in memory allocation subsystem.
3285** ^The [sqlite3_memory_used()] routine returns the number of bytes
3286** of memory currently outstanding (malloced but not freed).
3287** ^The [sqlite3_memory_highwater()] routine returns the maximum
3288** value of [sqlite3_memory_used()] since the high-water mark
3289** was last reset. ^The values returned by [sqlite3_memory_used()] and
3290** [sqlite3_memory_highwater()] include any overhead
3291** added by SQLite in its implementation of [sqlite3_malloc()],
3292** but not overhead added by the any underlying system library
3293** routines that [sqlite3_malloc()] may call.
3295** ^The memory high-water mark is reset to the current value of
3296** [sqlite3_memory_used()] if and only if the parameter to
3297** [sqlite3_memory_highwater()] is true. ^The value returned
3298** by [sqlite3_memory_highwater(1)] is the high-water mark
3299** prior to the reset.
3301SQLITE_API sqlite3_int64 sqlite3_memory_used(void);
3302SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag);
3305** CAPI3REF: Pseudo-Random Number Generator
3307** SQLite contains a high-quality pseudo-random number generator (PRNG) used to
3308** select random [ROWID | ROWIDs] when inserting new records into a table that
3309** already uses the largest possible [ROWID]. The PRNG is also used for
3310** the built-in random() and randomblob() SQL functions. This interface allows
3311** applications to access the same PRNG for other purposes.
3313** ^A call to this routine stores N bytes of randomness into buffer P.
3314** ^The P parameter can be a NULL pointer.
3316** ^If this routine has not been previously called or if the previous
3317** call had N less than one or a NULL pointer for P, then the PRNG is
3318** seeded using randomness obtained from the xRandomness method of
3319** the default [sqlite3_vfs] object.
3320** ^If the previous call to this routine had an N of 1 or more and a
3321** non-NULL P then the pseudo-randomness is generated
3322** internally and without recourse to the [sqlite3_vfs] xRandomness
3323** method.
3325SQLITE_API void sqlite3_randomness(int N, void *P);
3328** CAPI3REF: Compile-Time Authorization Callbacks
3329** METHOD: sqlite3
3330** KEYWORDS: {authorizer callback}
3332** ^This routine registers an authorizer callback with a particular
3333** [database connection], supplied in the first argument.
3334** ^The authorizer callback is invoked as SQL statements are being compiled
3335** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()],
3336** [sqlite3_prepare_v3()], [sqlite3_prepare16()], [sqlite3_prepare16_v2()],
3337** and [sqlite3_prepare16_v3()]. ^At various
3338** points during the compilation process, as logic is being created
3339** to perform various actions, the authorizer callback is invoked to
3340** see if those actions are allowed. ^The authorizer callback should
3341** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the
3342** specific action but allow the SQL statement to continue to be
3343** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be
3344** rejected with an error. ^If the authorizer callback returns
3345** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY]
3346** then the [sqlite3_prepare_v2()] or equivalent call that triggered
3347** the authorizer will fail with an error message.
3349** When the callback returns [SQLITE_OK], that means the operation
3350** requested is ok. ^When the callback returns [SQLITE_DENY], the
3351** [sqlite3_prepare_v2()] or equivalent call that triggered the
3352** authorizer will fail with an error message explaining that
3353** access is denied.
3355** ^The first parameter to the authorizer callback is a copy of the third
3356** parameter to the sqlite3_set_authorizer() interface. ^The second parameter
3357** to the callback is an integer [SQLITE_COPY | action code] that specifies
3358** the particular action to be authorized. ^The third through sixth parameters
3359** to the callback are either NULL pointers or zero-terminated strings
3360** that contain additional details about the action to be authorized.
3361** Applications must always be prepared to encounter a NULL pointer in any
3362** of the third through the sixth parameters of the authorization callback.
3364** ^If the action code is [SQLITE_READ]
3365** and the callback returns [SQLITE_IGNORE] then the
3366** [prepared statement] statement is constructed to substitute
3367** a NULL value in place of the table column that would have
3368** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE]
3369** return can be used to deny an untrusted user access to individual
3370** columns of a table.
3371** ^When a table is referenced by a [SELECT] but no column values are
3372** extracted from that table (for example in a query like
3373** "SELECT count(*) FROM tab") then the [SQLITE_READ] authorizer callback
3374** is invoked once for that table with a column name that is an empty string.
3375** ^If the action code is [SQLITE_DELETE] and the callback returns
3376** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the
3377** [truncate optimization] is disabled and all rows are deleted individually.
3379** An authorizer is used when [sqlite3_prepare | preparing]
3380** SQL statements from an untrusted source, to ensure that the SQL statements
3381** do not try to access data they are not allowed to see, or that they do not
3382** try to execute malicious statements that damage the database. For
3383** example, an application may allow a user to enter arbitrary
3384** SQL queries for evaluation by a database. But the application does
3385** not want the user to be able to make arbitrary changes to the
3386** database. An authorizer could then be put in place while the
3387** user-entered SQL is being [sqlite3_prepare | prepared] that
3388** disallows everything except [SELECT] statements.
3390** Applications that need to process SQL from untrusted sources
3391** might also consider lowering resource limits using [sqlite3_limit()]
3392** and limiting database size using the [max_page_count] [PRAGMA]
3393** in addition to using an authorizer.
3395** ^(Only a single authorizer can be in place on a database connection
3396** at a time. Each call to sqlite3_set_authorizer overrides the
3397** previous call.)^ ^Disable the authorizer by installing a NULL callback.
3398** The authorizer is disabled by default.
3400** The authorizer callback must not do anything that will modify
3401** the database connection that invoked the authorizer callback.
3402** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
3403** database connections for the meaning of "modify" in this paragraph.
3405** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the
3406** statement might be re-prepared during [sqlite3_step()] due to a
3407** schema change. Hence, the application should ensure that the
3408** correct authorizer callback remains in place during the [sqlite3_step()].
3410** ^Note that the authorizer callback is invoked only during
3411** [sqlite3_prepare()] or its variants. Authorization is not
3412** performed during statement evaluation in [sqlite3_step()], unless
3413** as stated in the previous paragraph, sqlite3_step() invokes
3414** sqlite3_prepare_v2() to reprepare a statement after a schema change.
3416SQLITE_API int sqlite3_set_authorizer(
3417 sqlite3*,
3418 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
3419 void *pUserData
3423** CAPI3REF: Authorizer Return Codes
3425** The [sqlite3_set_authorizer | authorizer callback function] must
3426** return either [SQLITE_OK] or one of these two constants in order
3427** to signal SQLite whether or not the action is permitted. See the
3428** [sqlite3_set_authorizer | authorizer documentation] for additional
3429** information.
3431** Note that SQLITE_IGNORE is also used as a [conflict resolution mode]
3432** returned from the [sqlite3_vtab_on_conflict()] interface.
3434#define SQLITE_DENY 1 /* Abort the SQL statement with an error */
3435#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
3438** CAPI3REF: Authorizer Action Codes
3440** The [sqlite3_set_authorizer()] interface registers a callback function
3441** that is invoked to authorize certain SQL statement actions. The
3442** second parameter to the callback is an integer code that specifies
3443** what action is being authorized. These are the integer action codes that
3444** the authorizer callback may be passed.
3446** These action code values signify what kind of operation is to be
3447** authorized. The 3rd and 4th parameters to the authorization
3448** callback function will be parameters or NULL depending on which of these
3449** codes is used as the second parameter. ^(The 5th parameter to the
3450** authorizer callback is the name of the database ("main", "temp",
3451** etc.) if applicable.)^ ^The 6th parameter to the authorizer callback
3452** is the name of the inner-most trigger or view that is responsible for
3453** the access attempt or NULL if this access attempt is directly from
3454** top-level SQL code.
3456/******************************************* 3rd ************ 4th ***********/
3457#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */
3458#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */
3459#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */
3460#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */
3461#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */
3462#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */
3463#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */
3464#define SQLITE_CREATE_VIEW 8 /* View Name NULL */
3465#define SQLITE_DELETE 9 /* Table Name NULL */
3466#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */
3467#define SQLITE_DROP_TABLE 11 /* Table Name NULL */
3468#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */
3469#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */
3470#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */
3471#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */
3472#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */
3473#define SQLITE_DROP_VIEW 17 /* View Name NULL */
3474#define SQLITE_INSERT 18 /* Table Name NULL */
3475#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */
3476#define SQLITE_READ 20 /* Table Name Column Name */
3477#define SQLITE_SELECT 21 /* NULL NULL */
3478#define SQLITE_TRANSACTION 22 /* Operation NULL */
3479#define SQLITE_UPDATE 23 /* Table Name Column Name */
3480#define SQLITE_ATTACH 24 /* Filename NULL */
3481#define SQLITE_DETACH 25 /* Database Name NULL */
3482#define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */
3483#define SQLITE_REINDEX 27 /* Index Name NULL */
3484#define SQLITE_ANALYZE 28 /* Table Name NULL */
3485#define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */
3486#define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */
3487#define SQLITE_FUNCTION 31 /* NULL Function Name */
3488#define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */
3489#define SQLITE_COPY 0 /* No longer used */
3490#define SQLITE_RECURSIVE 33 /* NULL NULL */
3493** CAPI3REF: Tracing And Profiling Functions
3494** METHOD: sqlite3
3496** These routines are deprecated. Use the [sqlite3_trace_v2()] interface
3497** instead of the routines described here.
3499** These routines register callback functions that can be used for
3500** tracing and profiling the execution of SQL statements.
3502** ^The callback function registered by sqlite3_trace() is invoked at
3503** various times when an SQL statement is being run by [sqlite3_step()].
3504** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the
3505** SQL statement text as the statement first begins executing.
3506** ^(Additional sqlite3_trace() callbacks might occur
3507** as each triggered subprogram is entered. The callbacks for triggers
3508** contain a UTF-8 SQL comment that identifies the trigger.)^
3510** The [SQLITE_TRACE_SIZE_LIMIT] compile-time option can be used to limit
3511** the length of [bound parameter] expansion in the output of sqlite3_trace().
3513** ^The callback function registered by sqlite3_profile() is invoked
3514** as each SQL statement finishes. ^The profile callback contains
3515** the original statement text and an estimate of wall-clock time
3516** of how long that statement took to run. ^The profile callback
3517** time is in units of nanoseconds, however the current implementation
3518** is only capable of millisecond resolution so the six least significant
3519** digits in the time are meaningless. Future versions of SQLite
3520** might provide greater resolution on the profiler callback. Invoking
3521** either [sqlite3_trace()] or [sqlite3_trace_v2()] will cancel the
3522** profile callback.
3524SQLITE_API SQLITE_DEPRECATED void *sqlite3_trace(sqlite3*,
3525 void(*xTrace)(void*,const char*), void*);
3526SQLITE_API SQLITE_DEPRECATED void *sqlite3_profile(sqlite3*,
3527 void(*xProfile)(void*,const char*,sqlite3_uint64), void*);
3530** CAPI3REF: SQL Trace Event Codes
3533** These constants identify classes of events that can be monitored
3534** using the [sqlite3_trace_v2()] tracing logic. The M argument
3535** to [sqlite3_trace_v2(D,M,X,P)] is an OR-ed combination of one or more of
3536** the following constants. ^The first argument to the trace callback
3537** is one of the following constants.
3539** New tracing constants may be added in future releases.
3541** ^A trace callback has four arguments: xCallback(T,C,P,X).
3542** ^The T argument is one of the integer type codes above.
3543** ^The C argument is a copy of the context pointer passed in as the
3544** fourth argument to [sqlite3_trace_v2()].
3545** The P and X arguments are pointers whose meanings depend on T.
3547** <dl>
3549** <dd>^An SQLITE_TRACE_STMT callback is invoked when a prepared statement
3550** first begins running and possibly at other times during the
3551** execution of the prepared statement, such as at the start of each
3552** trigger subprogram. ^The P argument is a pointer to the
3553** [prepared statement]. ^The X argument is a pointer to a string which
3554** is the unexpanded SQL text of the prepared statement or an SQL comment
3555** that indicates the invocation of a trigger. ^The callback can compute
3556** the same text that would have been returned by the legacy [sqlite3_trace()]
3557** interface by using the X argument when X begins with "--" and invoking
3558** [sqlite3_expanded_sql(P)] otherwise.
3561** <dd>^An SQLITE_TRACE_PROFILE callback provides approximately the same
3562** information as is provided by the [sqlite3_profile()] callback.
3563** ^The P argument is a pointer to the [prepared statement] and the
3564** X argument points to a 64-bit integer which is the estimated of
3565** the number of nanosecond that the prepared statement took to run.
3566** ^The SQLITE_TRACE_PROFILE callback is invoked when the statement finishes.
3569** <dd>^An SQLITE_TRACE_ROW callback is invoked whenever a prepared
3570** statement generates a single row of result.
3571** ^The P argument is a pointer to the [prepared statement] and the
3572** X argument is unused.
3575** <dd>^An SQLITE_TRACE_CLOSE callback is invoked when a database
3576** connection closes.
3577** ^The P argument is a pointer to the [database connection] object
3578** and the X argument is unused.
3579** </dl>
3581#define SQLITE_TRACE_STMT 0x01
3582#define SQLITE_TRACE_PROFILE 0x02
3583#define SQLITE_TRACE_ROW 0x04
3584#define SQLITE_TRACE_CLOSE 0x08
3587** CAPI3REF: SQL Trace Hook
3588** METHOD: sqlite3
3590** ^The sqlite3_trace_v2(D,M,X,P) interface registers a trace callback
3591** function X against [database connection] D, using property mask M
3592** and context pointer P. ^If the X callback is
3593** NULL or if the M mask is zero, then tracing is disabled. The
3594** M argument should be the bitwise OR-ed combination of
3595** zero or more [SQLITE_TRACE] constants.
3597** ^Each call to either sqlite3_trace() or sqlite3_trace_v2() overrides
3598** (cancels) any prior calls to sqlite3_trace() or sqlite3_trace_v2().
3600** ^The X callback is invoked whenever any of the events identified by
3601** mask M occur. ^The integer return value from the callback is currently
3602** ignored, though this may change in future releases. Callback
3603** implementations should return zero to ensure future compatibility.
3605** ^A trace callback is invoked with four arguments: callback(T,C,P,X).
3606** ^The T argument is one of the [SQLITE_TRACE]
3607** constants to indicate why the callback was invoked.
3608** ^The C argument is a copy of the context pointer.
3609** The P and X arguments are pointers whose meanings depend on T.
3611** The sqlite3_trace_v2() interface is intended to replace the legacy
3612** interfaces [sqlite3_trace()] and [sqlite3_profile()], both of which
3613** are deprecated.
3615SQLITE_API int sqlite3_trace_v2(
3616 sqlite3*,
3617 unsigned uMask,
3618 int(*xCallback)(unsigned,void*,void*,void*),
3619 void *pCtx
3623** CAPI3REF: Query Progress Callbacks
3624** METHOD: sqlite3
3626** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback
3627** function X to be invoked periodically during long running calls to
3628** [sqlite3_exec()], [sqlite3_step()] and [sqlite3_get_table()] for
3629** database connection D. An example use for this
3630** interface is to keep a GUI updated during a large query.
3632** ^The parameter P is passed through as the only parameter to the
3633** callback function X. ^The parameter N is the approximate number of
3634** [virtual machine instructions] that are evaluated between successive
3635** invocations of the callback X. ^If N is less than one then the progress
3636** handler is disabled.
3638** ^Only a single progress handler may be defined at one time per
3639** [database connection]; setting a new progress handler cancels the
3640** old one. ^Setting parameter X to NULL disables the progress handler.
3641** ^The progress handler is also disabled by setting N to a value less
3642** than 1.
3644** ^If the progress callback returns non-zero, the operation is
3645** interrupted. This feature can be used to implement a
3646** "Cancel" button on a GUI progress dialog box.
3648** The progress handler callback must not do anything that will modify
3649** the database connection that invoked the progress handler.
3650** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
3651** database connections for the meaning of "modify" in this paragraph.
3654SQLITE_API void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
3657** CAPI3REF: Opening A New Database Connection
3658** CONSTRUCTOR: sqlite3
3660** ^These routines open an SQLite database file as specified by the
3661** filename argument. ^The filename argument is interpreted as UTF-8 for
3662** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte
3663** order for sqlite3_open16(). ^(A [database connection] handle is usually
3664** returned in *ppDb, even if an error occurs. The only exception is that
3665** if SQLite is unable to allocate memory to hold the [sqlite3] object,
3666** a NULL will be written into *ppDb instead of a pointer to the [sqlite3]
3667** object.)^ ^(If the database is opened (and/or created) successfully, then
3668** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The
3669** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain
3670** an English language description of the error following a failure of any
3671** of the sqlite3_open() routines.
3673** ^The default encoding will be UTF-8 for databases created using
3674** sqlite3_open() or sqlite3_open_v2(). ^The default encoding for databases
3675** created using sqlite3_open16() will be UTF-16 in the native byte order.
3677** Whether or not an error occurs when it is opened, resources
3678** associated with the [database connection] handle should be released by
3679** passing it to [sqlite3_close()] when it is no longer required.
3681** The sqlite3_open_v2() interface works like sqlite3_open()
3682** except that it accepts two additional parameters for additional control
3683** over the new database connection. ^(The flags parameter to
3684** sqlite3_open_v2() must include, at a minimum, one of the following
3685** three flag combinations:)^
3687** <dl>
3688** ^(<dt>[SQLITE_OPEN_READONLY]</dt>
3689** <dd>The database is opened in read-only mode. If the database does not
3690** already exist, an error is returned.</dd>)^
3692** ^(<dt>[SQLITE_OPEN_READWRITE]</dt>
3693** <dd>The database is opened for reading and writing if possible, or reading
3694** only if the file is write protected by the operating system. In either
3695** case the database must already exist, otherwise an error is returned.</dd>)^
3698** <dd>The database is opened for reading and writing, and is created if
3699** it does not already exist. This is the behavior that is always used for
3700** sqlite3_open() and sqlite3_open16().</dd>)^
3701** </dl>
3703** In addition to the required flags, the following optional flags are
3704** also supported:
3706** <dl>
3707** ^(<dt>[SQLITE_OPEN_URI]</dt>
3708** <dd>The filename can be interpreted as a URI if this flag is set.</dd>)^
3710** ^(<dt>[SQLITE_OPEN_MEMORY]</dt>
3711** <dd>The database will be opened as an in-memory database. The database
3712** is named by the "filename" argument for the purposes of cache-sharing,
3713** if shared cache mode is enabled, but the "filename" is otherwise ignored.
3714** </dd>)^
3716** ^(<dt>[SQLITE_OPEN_NOMUTEX]</dt>
3717** <dd>The new database connection will use the "multi-thread"
3718** [threading mode].)^ This means that separate threads are allowed
3719** to use SQLite at the same time, as long as each thread is using
3720** a different [database connection].
3722** ^(<dt>[SQLITE_OPEN_FULLMUTEX]</dt>
3723** <dd>The new database connection will use the "serialized"
3724** [threading mode].)^ This means the multiple threads can safely
3725** attempt to use the same database connection at the same time.
3726** (Mutexes will block any actual concurrency, but in this mode
3727** there is no harm in trying.)
3729** ^(<dt>[SQLITE_OPEN_SHAREDCACHE]</dt>
3730** <dd>The database is opened [shared cache] enabled, overriding
3731** the default shared cache setting provided by
3732** [sqlite3_enable_shared_cache()].)^
3734** ^(<dt>[SQLITE_OPEN_PRIVATECACHE]</dt>
3735** <dd>The database is opened [shared cache] disabled, overriding
3736** the default shared cache setting provided by
3737** [sqlite3_enable_shared_cache()].)^
3740** <dd>The database connection comes up in "extended result code mode".
3741** In other words, the database behaves has if
3742** [sqlite3_extended_result_codes(db,1)] where called on the database
3743** connection as soon as the connection is created. In addition to setting
3744** the extended result code mode, this flag also causes [sqlite3_open_v2()]
3745** to return an extended result code.</dd>
3748** <dd>The database filename is not allowed to be a symbolic link</dd>
3749** </dl>)^
3751** If the 3rd parameter to sqlite3_open_v2() is not one of the
3752** required combinations shown above optionally combined with other
3754** then the behavior is undefined. Historic versions of SQLite
3755** have silently ignored surplus bits in the flags parameter to
3756** sqlite3_open_v2(), however that behavior might not be carried through
3757** into future versions of SQLite and so applications should not rely
3758** upon it. Note in particular that the SQLITE_OPEN_EXCLUSIVE flag is a no-op
3759** for sqlite3_open_v2(). The SQLITE_OPEN_EXCLUSIVE does *not* cause
3760** the open to fail if the database already exists. The SQLITE_OPEN_EXCLUSIVE
3761** flag is intended for use by the [sqlite3_vfs|VFS interface] only, and not
3762** by sqlite3_open_v2().
3764** ^The fourth parameter to sqlite3_open_v2() is the name of the
3765** [sqlite3_vfs] object that defines the operating system interface that
3766** the new database connection should use. ^If the fourth parameter is
3767** a NULL pointer then the default [sqlite3_vfs] object is used.
3769** ^If the filename is ":memory:", then a private, temporary in-memory database
3770** is created for the connection. ^This in-memory database will vanish when
3771** the database connection is closed. Future versions of SQLite might
3772** make use of additional special filenames that begin with the ":" character.
3773** It is recommended that when a database filename actually does begin with
3774** a ":" character you should prefix the filename with a pathname such as
3775** "./" to avoid ambiguity.
3777** ^If the filename is an empty string, then a private, temporary
3778** on-disk database will be created. ^This private database will be
3779** automatically deleted as soon as the database connection is closed.
3781** [[URI filenames in sqlite3_open()]] <h3>URI Filenames</h3>
3783** ^If [URI filename] interpretation is enabled, and the filename argument
3784** begins with "file:", then the filename is interpreted as a URI. ^URI
3785** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is
3786** set in the third argument to sqlite3_open_v2(), or if it has
3787** been enabled globally using the [SQLITE_CONFIG_URI] option with the
3788** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option.
3789** URI filename interpretation is turned off
3790** by default, but future releases of SQLite might enable URI filename
3791** interpretation by default. See "[URI filenames]" for additional
3792** information.
3794** URI filenames are parsed according to RFC 3986. ^If the URI contains an
3795** authority, then it must be either an empty string or the string
3796** "localhost". ^If the authority is not an empty string or "localhost", an
3797** error is returned to the caller. ^The fragment component of a URI, if
3798** present, is ignored.
3800** ^SQLite uses the path component of the URI as the name of the disk file
3801** which contains the database. ^If the path begins with a '/' character,
3802** then it is interpreted as an absolute path. ^If the path does not begin
3803** with a '/' (meaning that the authority section is omitted from the URI)
3804** then the path is interpreted as a relative path.
3805** ^(On windows, the first component of an absolute path
3806** is a drive specification (e.g. "C:").)^
3808** [[core URI query parameters]]
3809** The query component of a URI may contain parameters that are interpreted
3810** either by SQLite itself, or by a [VFS | custom VFS implementation].
3811** SQLite and its built-in [VFSes] interpret the
3812** following query parameters:
3814** <ul>
3815** <li> <b>vfs</b>: ^The "vfs" parameter may be used to specify the name of
3816** a VFS object that provides the operating system interface that should
3817** be used to access the database file on disk. ^If this option is set to
3818** an empty string the default VFS object is used. ^Specifying an unknown
3819** VFS is an error. ^If sqlite3_open_v2() is used and the vfs option is
3820** present, then the VFS specified by the option takes precedence over
3821** the value passed as the fourth parameter to sqlite3_open_v2().
3823** <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw",
3824** "rwc", or "memory". Attempting to set it to any other value is
3825** an error)^.
3826** ^If "ro" is specified, then the database is opened for read-only
3827** access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the
3828** third argument to sqlite3_open_v2(). ^If the mode option is set to
3829** "rw", then the database is opened for read-write (but not create)
3830** access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had
3831** been set. ^Value "rwc" is equivalent to setting both
3832** SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE. ^If the mode option is
3833** set to "memory" then a pure [in-memory database] that never reads
3834** or writes from disk is used. ^It is an error to specify a value for
3835** the mode parameter that is less restrictive than that specified by
3836** the flags passed in the third parameter to sqlite3_open_v2().
3838** <li> <b>cache</b>: ^The cache parameter may be set to either "shared" or
3839** "private". ^Setting it to "shared" is equivalent to setting the
3840** SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to
3841** sqlite3_open_v2(). ^Setting the cache parameter to "private" is
3842** equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit.
3843** ^If sqlite3_open_v2() is used and the "cache" parameter is present in
3844** a URI filename, its value overrides any behavior requested by setting
3847** <li> <b>psow</b>: ^The psow parameter indicates whether or not the
3848** [powersafe overwrite] property does or does not apply to the
3849** storage media on which the database file resides.
3851** <li> <b>nolock</b>: ^The nolock parameter is a boolean query parameter
3852** which if set disables file locking in rollback journal modes. This
3853** is useful for accessing a database on a filesystem that does not
3854** support locking. Caution: Database corruption might result if two
3855** or more processes write to the same database and any one of those
3856** processes uses nolock=1.
3858** <li> <b>immutable</b>: ^The immutable parameter is a boolean query
3859** parameter that indicates that the database file is stored on
3860** read-only media. ^When immutable is set, SQLite assumes that the
3861** database file cannot be changed, even by a process with higher
3862** privilege, and so the database is opened read-only and all locking
3863** and change detection is disabled. Caution: Setting the immutable
3864** property on a database file that does in fact change can result
3865** in incorrect query results and/or [SQLITE_CORRUPT] errors.
3866** See also: [SQLITE_IOCAP_IMMUTABLE].
3868** </ul>
3870** ^Specifying an unknown parameter in the query component of a URI is not an
3871** error. Future versions of SQLite might understand additional query
3872** parameters. See "[query parameters with special meaning to SQLite]" for
3873** additional information.
3875** [[URI filename examples]] <h3>URI filename examples</h3>
3877** <table border="1" align=center cellpadding=5>
3878** <tr><th> URI filenames <th> Results
3879** <tr><td> file:data.db <td>
3880** Open the file "data.db" in the current directory.
3881** <tr><td> file:/home/fred/data.db<br>
3882** file:///home/fred/data.db <br>
3883** file://localhost/home/fred/data.db <br> <td>
3884** Open the database file "/home/fred/data.db".
3885** <tr><td> file://darkstar/home/fred/data.db <td>
3886** An error. "darkstar" is not a recognized authority.
3887** <tr><td style="white-space:nowrap">
3888** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db
3889** <td> Windows only: Open the file "data.db" on fred's desktop on drive
3890** C:. Note that the %20 escaping in this example is not strictly
3891** necessary - space characters can be used literally
3892** in URI filenames.
3893** <tr><td> file:data.db?mode=ro&cache=private <td>
3894** Open file "data.db" in the current directory for read-only access.
3895** Regardless of whether or not shared-cache mode is enabled by
3896** default, use a private cache.
3897** <tr><td> file:/home/fred/data.db?vfs=unix-dotfile <td>
3898** Open file "/home/fred/data.db". Use the special VFS "unix-dotfile"
3899** that uses dot-files in place of posix advisory locking.
3900** <tr><td> file:data.db?mode=readonly <td>
3901** An error. "readonly" is not a valid option for the "mode" parameter.
3902** Use "ro" instead: "file:data.db?mode=ro".
3903** </table>
3905** ^URI hexadecimal escape sequences (%HH) are supported within the path and
3906** query components of a URI. A hexadecimal escape sequence consists of a
3907** percent sign - "%" - followed by exactly two hexadecimal digits
3908** specifying an octet value. ^Before the path or query components of a
3909** URI filename are interpreted, they are encoded using UTF-8 and all
3910** hexadecimal escape sequences replaced by a single byte containing the
3911** corresponding octet. If this process generates an invalid UTF-8 encoding,
3912** the results are undefined.
3914** <b>Note to Windows users:</b> The encoding used for the filename argument
3915** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever
3916** codepage is currently defined. Filenames containing international
3917** characters must be converted to UTF-8 prior to passing them into
3918** sqlite3_open() or sqlite3_open_v2().
3920** <b>Note to Windows Runtime users:</b> The temporary directory must be set
3921** prior to calling sqlite3_open() or sqlite3_open_v2(). Otherwise, various
3922** features that require the use of temporary files may fail.
3924** See also: [sqlite3_temp_directory]
3926SQLITE_API int sqlite3_open(
3927 const char *filename, /* Database filename (UTF-8) */
3928 sqlite3 **ppDb /* OUT: SQLite db handle */
3930SQLITE_API int sqlite3_open16(
3931 const void *filename, /* Database filename (UTF-16) */
3932 sqlite3 **ppDb /* OUT: SQLite db handle */
3934SQLITE_API int sqlite3_open_v2(
3935 const char *filename, /* Database filename (UTF-8) */
3936 sqlite3 **ppDb, /* OUT: SQLite db handle */
3937 int flags, /* Flags */
3938 const char *zVfs /* Name of VFS module to use */
3942** CAPI3REF: Obtain Values For URI Parameters
3944** These are utility routines, useful to [VFS|custom VFS implementations],
3945** that check if a database file was a URI that contained a specific query
3946** parameter, and if so obtains the value of that query parameter.
3948** The first parameter to these interfaces (hereafter referred to
3949** as F) must be one of:
3950** <ul>
3951** <li> A database filename pointer created by the SQLite core and
3952** passed into the xOpen() method of a VFS implemention, or
3953** <li> A filename obtained from [sqlite3_db_filename()], or
3954** <li> A new filename constructed using [sqlite3_create_filename()].
3955** </ul>
3956** If the F parameter is not one of the above, then the behavior is
3957** undefined and probably undesirable. Older versions of SQLite were
3958** more tolerant of invalid F parameters than newer versions.
3960** If F is a suitable filename (as described in the previous paragraph)
3961** and if P is the name of the query parameter, then
3962** sqlite3_uri_parameter(F,P) returns the value of the P
3963** parameter if it exists or a NULL pointer if P does not appear as a
3964** query parameter on F. If P is a query parameter of F and it
3965** has no explicit value, then sqlite3_uri_parameter(F,P) returns
3966** a pointer to an empty string.
3968** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean
3969** parameter and returns true (1) or false (0) according to the value
3970** of P. The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the
3971** value of query parameter P is one of "yes", "true", or "on" in any
3972** case or if the value begins with a non-zero number. The
3973** sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of
3974** query parameter P is one of "no", "false", or "off" in any case or
3975** if the value begins with a numeric zero. If P is not a query
3976** parameter on F or if the value of P does not match any of the
3977** above, then sqlite3_uri_boolean(F,P,B) returns (B!=0).
3979** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a
3980** 64-bit signed integer and returns that integer, or D if P does not
3981** exist. If the value of P is something other than an integer, then
3982** zero is returned.
3984** The sqlite3_uri_key(F,N) returns a pointer to the name (not
3985** the value) of the N-th query parameter for filename F, or a NULL
3986** pointer if N is less than zero or greater than the number of query
3987** parameters minus 1. The N value is zero-based so N should be 0 to obtain
3988** the name of the first query parameter, 1 for the second parameter, and
3989** so forth.
3991** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and
3992** sqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and
3993** is not a database file pathname pointer that the SQLite core passed
3994** into the xOpen VFS method, then the behavior of this routine is undefined
3995** and probably undesirable.
3997** Beginning with SQLite [version 3.31.0] ([dateof:3.31.0]) the input F
3998** parameter can also be the name of a rollback journal file or WAL file
3999** in addition to the main database file. Prior to version 3.31.0, these
4000** routines would only work if F was the name of the main database file.
4001** When the F parameter is the name of the rollback journal or WAL file,
4002** it has access to all the same query parameters as were found on the
4003** main database file.
4005** See the [URI filename] documentation for additional information.
4007SQLITE_API const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam);
4008SQLITE_API int sqlite3_uri_boolean(const char *zFile, const char *zParam, int bDefault);
4009SQLITE_API sqlite3_int64 sqlite3_uri_int64(const char*, const char*, sqlite3_int64);
4010SQLITE_API const char *sqlite3_uri_key(const char *zFilename, int N);
4013** CAPI3REF: Translate filenames
4015** These routines are available to [VFS|custom VFS implementations] for
4016** translating filenames between the main database file, the journal file,
4017** and the WAL file.
4019** If F is the name of an sqlite database file, journal file, or WAL file
4020** passed by the SQLite core into the VFS, then sqlite3_filename_database(F)
4021** returns the name of the corresponding database file.
4023** If F is the name of an sqlite database file, journal file, or WAL file
4024** passed by the SQLite core into the VFS, or if F is a database filename
4025** obtained from [sqlite3_db_filename()], then sqlite3_filename_journal(F)
4026** returns the name of the corresponding rollback journal file.
4028** If F is the name of an sqlite database file, journal file, or WAL file
4029** that was passed by the SQLite core into the VFS, or if F is a database
4030** filename obtained from [sqlite3_db_filename()], then
4031** sqlite3_filename_wal(F) returns the name of the corresponding
4032** WAL file.
4034** In all of the above, if F is not the name of a database, journal or WAL
4035** filename passed into the VFS from the SQLite core and F is not the
4036** return value from [sqlite3_db_filename()], then the result is
4037** undefined and is likely a memory access violation.
4039SQLITE_API const char *sqlite3_filename_database(const char*);
4040SQLITE_API const char *sqlite3_filename_journal(const char*);
4041SQLITE_API const char *sqlite3_filename_wal(const char*);
4044** CAPI3REF: Database File Corresponding To A Journal
4046** ^If X is the name of a rollback or WAL-mode journal file that is
4047** passed into the xOpen method of [sqlite3_vfs], then
4048** sqlite3_database_file_object(X) returns a pointer to the [sqlite3_file]
4049** object that represents the main database file.
4051** This routine is intended for use in custom [VFS] implementations
4052** only. It is not a general-purpose interface.
4053** The argument sqlite3_file_object(X) must be a filename pointer that
4054** has been passed into [sqlite3_vfs].xOpen method where the
4055** flags parameter to xOpen contains one of the bits
4057** of this routine results in undefined and probably undesirable
4058** behavior.
4060SQLITE_API sqlite3_file *sqlite3_database_file_object(const char*);
4063** CAPI3REF: Create and Destroy VFS Filenames
4065** These interfces are provided for use by [VFS shim] implementations and
4066** are not useful outside of that context.
4068** The sqlite3_create_filename(D,J,W,N,P) allocates memory to hold a version of
4069** database filename D with corresponding journal file J and WAL file W and
4070** with N URI parameters key/values pairs in the array P. The result from
4071** sqlite3_create_filename(D,J,W,N,P) is a pointer to a database filename that
4072** is safe to pass to routines like:
4073** <ul>
4074** <li> [sqlite3_uri_parameter()],
4075** <li> [sqlite3_uri_boolean()],
4076** <li> [sqlite3_uri_int64()],
4077** <li> [sqlite3_uri_key()],
4078** <li> [sqlite3_filename_database()],
4079** <li> [sqlite3_filename_journal()], or
4080** <li> [sqlite3_filename_wal()].
4081** </ul>
4082** If a memory allocation error occurs, sqlite3_create_filename() might
4083** return a NULL pointer. The memory obtained from sqlite3_create_filename(X)
4084** must be released by a corresponding call to sqlite3_free_filename(Y).
4086** The P parameter in sqlite3_create_filename(D,J,W,N,P) should be an array
4087** of 2*N pointers to strings. Each pair of pointers in this array corresponds
4088** to a key and value for a query parameter. The P parameter may be a NULL
4089** pointer if N is zero. None of the 2*N pointers in the P array may be
4090** NULL pointers and key pointers should not be empty strings.
4091** None of the D, J, or W parameters to sqlite3_create_filename(D,J,W,N,P) may
4092** be NULL pointers, though they can be empty strings.
4094** The sqlite3_free_filename(Y) routine releases a memory allocation
4095** previously obtained from sqlite3_create_filename(). Invoking
4096** sqlite3_free_filename(Y) where Y is a NULL pointer is a harmless no-op.
4098** If the Y parameter to sqlite3_free_filename(Y) is anything other
4099** than a NULL pointer or a pointer previously acquired from
4100** sqlite3_create_filename(), then bad things such as heap
4101** corruption or segfaults may occur. The value Y should not be
4102** used again after sqlite3_free_filename(Y) has been called. This means
4103** that if the [sqlite3_vfs.xOpen()] method of a VFS has been called using Y,
4104** then the corresponding [sqlite3_module.xClose() method should also be
4105** invoked prior to calling sqlite3_free_filename(Y).
4107SQLITE_API char *sqlite3_create_filename(
4108 const char *zDatabase,
4109 const char *zJournal,
4110 const char *zWal,
4111 int nParam,
4112 const char **azParam
4114SQLITE_API void sqlite3_free_filename(char*);
4117** CAPI3REF: Error Codes And Messages
4118** METHOD: sqlite3
4120** ^If the most recent sqlite3_* API call associated with
4121** [database connection] D failed, then the sqlite3_errcode(D) interface
4122** returns the numeric [result code] or [extended result code] for that
4123** API call.
4124** ^The sqlite3_extended_errcode()
4125** interface is the same except that it always returns the
4126** [extended result code] even when extended result codes are
4127** disabled.
4129** The values returned by sqlite3_errcode() and/or
4130** sqlite3_extended_errcode() might change with each API call.
4131** Except, there are some interfaces that are guaranteed to never
4132** change the value of the error code. The error-code preserving
4133** interfaces are:
4135** <ul>
4136** <li> sqlite3_errcode()
4137** <li> sqlite3_extended_errcode()
4138** <li> sqlite3_errmsg()
4139** <li> sqlite3_errmsg16()
4140** </ul>
4142** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language
4143** text that describes the error, as either UTF-8 or UTF-16 respectively.
4144** ^(Memory to hold the error message string is managed internally.
4145** The application does not need to worry about freeing the result.
4146** However, the error string might be overwritten or deallocated by
4147** subsequent calls to other SQLite interface functions.)^
4149** ^The sqlite3_errstr() interface returns the English-language text
4150** that describes the [result code], as UTF-8.
4151** ^(Memory to hold the error message string is managed internally
4152** and must not be freed by the application)^.
4154** When the serialized [threading mode] is in use, it might be the
4155** case that a second error occurs on a separate thread in between
4156** the time of the first error and the call to these interfaces.
4157** When that happens, the second error will be reported since these
4158** interfaces always report the most recent result. To avoid
4159** this, each thread can obtain exclusive use of the [database connection] D
4160** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning
4161** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after
4162** all calls to the interfaces listed here are completed.
4164** If an interface fails with SQLITE_MISUSE, that means the interface
4165** was invoked incorrectly by the application. In that case, the
4166** error code and message may or may not be set.
4168SQLITE_API int sqlite3_errcode(sqlite3 *db);
4169SQLITE_API int sqlite3_extended_errcode(sqlite3 *db);
4170SQLITE_API const char *sqlite3_errmsg(sqlite3*);
4171SQLITE_API const void *sqlite3_errmsg16(sqlite3*);
4172SQLITE_API const char *sqlite3_errstr(int);
4175** CAPI3REF: Prepared Statement Object
4176** KEYWORDS: {prepared statement} {prepared statements}
4178** An instance of this object represents a single SQL statement that
4179** has been compiled into binary form and is ready to be evaluated.
4181** Think of each SQL statement as a separate computer program. The
4182** original SQL text is source code. A prepared statement object
4183** is the compiled object code. All SQL must be converted into a
4184** prepared statement before it can be run.
4186** The life-cycle of a prepared statement object usually goes like this:
4188** <ol>
4189** <li> Create the prepared statement object using [sqlite3_prepare_v2()].
4190** <li> Bind values to [parameters] using the sqlite3_bind_*()
4191** interfaces.
4192** <li> Run the SQL by calling [sqlite3_step()] one or more times.
4193** <li> Reset the prepared statement using [sqlite3_reset()] then go back
4194** to step 2. Do this zero or more times.
4195** <li> Destroy the object using [sqlite3_finalize()].
4196** </ol>
4198typedef struct sqlite3_stmt sqlite3_stmt;
4201** CAPI3REF: Run-time Limits
4202** METHOD: sqlite3
4204** ^(This interface allows the size of various constructs to be limited
4205** on a connection by connection basis. The first parameter is the
4206** [database connection] whose limit is to be set or queried. The
4207** second parameter is one of the [limit categories] that define a
4208** class of constructs to be size limited. The third parameter is the
4209** new limit for that construct.)^
4211** ^If the new limit is a negative number, the limit is unchanged.
4212** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a
4213** [limits | hard upper bound]
4214** set at compile-time by a C preprocessor macro called
4215** [limits | SQLITE_MAX_<i>NAME</i>].
4216** (The "_LIMIT_" in the name is changed to "_MAX_".))^
4217** ^Attempts to increase a limit above its hard upper bound are
4218** silently truncated to the hard upper bound.
4220** ^Regardless of whether or not the limit was changed, the
4221** [sqlite3_limit()] interface returns the prior value of the limit.
4222** ^Hence, to find the current value of a limit without changing it,
4223** simply invoke this interface with the third parameter set to -1.
4225** Run-time limits are intended for use in applications that manage
4226** both their own internal database and also databases that are controlled
4227** by untrusted external sources. An example application might be a
4228** web browser that has its own databases for storing history and
4229** separate databases controlled by JavaScript applications downloaded
4230** off the Internet. The internal databases can be given the
4231** large, default limits. Databases managed by external sources can
4232** be given much smaller limits designed to prevent a denial of service
4233** attack. Developers might also want to use the [sqlite3_set_authorizer()]
4234** interface to further control untrusted SQL. The size of the database
4235** created by an untrusted script can be contained using the
4236** [max_page_count] [PRAGMA].
4238** New run-time limit categories may be added in future releases.
4240SQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal);
4243** CAPI3REF: Run-Time Limit Categories
4244** KEYWORDS: {limit category} {*limit categories}
4246** These constants define various performance limits
4247** that can be lowered at run-time using [sqlite3_limit()].
4248** The synopsis of the meanings of the various limits is shown below.
4249** Additional information is available at [limits | Limits in SQLite].
4251** <dl>
4253** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^
4256** <dd>The maximum length of an SQL statement, in bytes.</dd>)^
4259** <dd>The maximum number of columns in a table definition or in the
4260** result set of a [SELECT] or the maximum number of columns in an index
4261** or in an ORDER BY or GROUP BY clause.</dd>)^
4264** <dd>The maximum depth of the parse tree on any expression.</dd>)^
4267** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^
4270** <dd>The maximum number of instructions in a virtual machine program
4271** used to implement an SQL statement. If [sqlite3_prepare_v2()] or
4272** the equivalent tries to allocate space for more than this many opcodes
4273** in a single prepared statement, an SQLITE_NOMEM error is returned.</dd>)^
4276** <dd>The maximum number of arguments on a function.</dd>)^
4279** <dd>The maximum number of [ATTACH | attached databases].)^</dd>
4283** <dd>The maximum length of the pattern argument to the [LIKE] or
4284** [GLOB] operators.</dd>)^
4288** <dd>The maximum index number of any [parameter] in an SQL statement.)^
4291** <dd>The maximum depth of recursion for triggers.</dd>)^
4294** <dd>The maximum number of auxiliary worker threads that a single
4295** [prepared statement] may start.</dd>)^
4296** </dl>
4303#define SQLITE_LIMIT_VDBE_OP 5
4312** CAPI3REF: Prepare Flags
4314** These constants define various flags that can be passed into
4315** "prepFlags" parameter of the [sqlite3_prepare_v3()] and
4316** [sqlite3_prepare16_v3()] interfaces.
4318** New flags may be added in future releases of SQLite.
4320** <dl>
4322** <dd>The SQLITE_PREPARE_PERSISTENT flag is a hint to the query planner
4323** that the prepared statement will be retained for a long time and
4324** probably reused many times.)^ ^Without this flag, [sqlite3_prepare_v3()]
4325** and [sqlite3_prepare16_v3()] assume that the prepared statement will
4326** be used just once or at most a few times and then destroyed using
4327** [sqlite3_finalize()] relatively soon. The current implementation acts
4328** on this hint by avoiding the use of [lookaside memory] so as not to
4329** deplete the limited store of lookaside memory. Future versions of
4330** SQLite may act on this hint differently.
4333** <dd>The SQLITE_PREPARE_NORMALIZE flag is a no-op. This flag used
4334** to be required for any prepared statement that wanted to use the
4335** [sqlite3_normalized_sql()] interface. However, the
4336** [sqlite3_normalized_sql()] interface is now available to all
4337** prepared statements, regardless of whether or not they use this
4338** flag.
4341** <dd>The SQLITE_PREPARE_NO_VTAB flag causes the SQL compiler
4342** to return an error (error code SQLITE_ERROR) if the statement uses
4343** any virtual tables.
4344** </dl>
4348#define SQLITE_PREPARE_NO_VTAB 0x04
4351** CAPI3REF: Compiling An SQL Statement
4352** KEYWORDS: {SQL statement compiler}
4353** METHOD: sqlite3
4354** CONSTRUCTOR: sqlite3_stmt
4356** To execute an SQL statement, it must first be compiled into a byte-code
4357** program using one of these routines. Or, in other words, these routines
4358** are constructors for the [prepared statement] object.
4360** The preferred routine to use is [sqlite3_prepare_v2()]. The
4361** [sqlite3_prepare()] interface is legacy and should be avoided.
4362** [sqlite3_prepare_v3()] has an extra "prepFlags" option that is used
4363** for special purposes.
4365** The use of the UTF-8 interfaces is preferred, as SQLite currently
4366** does all parsing using UTF-8. The UTF-16 interfaces are provided
4367** as a convenience. The UTF-16 interfaces work by converting the
4368** input text into UTF-8, then invoking the corresponding UTF-8 interface.
4370** The first argument, "db", is a [database connection] obtained from a
4371** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or
4372** [sqlite3_open16()]. The database connection must not have been closed.
4374** The second argument, "zSql", is the statement to be compiled, encoded
4375** as either UTF-8 or UTF-16. The sqlite3_prepare(), sqlite3_prepare_v2(),
4376** and sqlite3_prepare_v3()
4377** interfaces use UTF-8, and sqlite3_prepare16(), sqlite3_prepare16_v2(),
4378** and sqlite3_prepare16_v3() use UTF-16.
4380** ^If the nByte argument is negative, then zSql is read up to the
4381** first zero terminator. ^If nByte is positive, then it is the
4382** number of bytes read from zSql. ^If nByte is zero, then no prepared
4383** statement is generated.
4384** If the caller knows that the supplied string is nul-terminated, then
4385** there is a small performance advantage to passing an nByte parameter that
4386** is the number of bytes in the input string <i>including</i>
4387** the nul-terminator.
4389** ^If pzTail is not NULL then *pzTail is made to point to the first byte
4390** past the end of the first SQL statement in zSql. These routines only
4391** compile the first statement in zSql, so *pzTail is left pointing to
4392** what remains uncompiled.
4394** ^*ppStmt is left pointing to a compiled [prepared statement] that can be
4395** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set
4396** to NULL. ^If the input text contains no SQL (if the input is an empty
4397** string or a comment) then *ppStmt is set to NULL.
4398** The calling procedure is responsible for deleting the compiled
4399** SQL statement using [sqlite3_finalize()] after it has finished with it.
4400** ppStmt may not be NULL.
4402** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK];
4403** otherwise an [error code] is returned.
4405** The sqlite3_prepare_v2(), sqlite3_prepare_v3(), sqlite3_prepare16_v2(),
4406** and sqlite3_prepare16_v3() interfaces are recommended for all new programs.
4407** The older interfaces (sqlite3_prepare() and sqlite3_prepare16())
4408** are retained for backwards compatibility, but their use is discouraged.
4409** ^In the "vX" interfaces, the prepared statement
4410** that is returned (the [sqlite3_stmt] object) contains a copy of the
4411** original SQL text. This causes the [sqlite3_step()] interface to
4412** behave differently in three ways:
4414** <ol>
4415** <li>
4416** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it
4417** always used to do, [sqlite3_step()] will automatically recompile the SQL
4418** statement and try to run it again. As many as [SQLITE_MAX_SCHEMA_RETRY]
4419** retries will occur before sqlite3_step() gives up and returns an error.
4420** </li>
4422** <li>
4423** ^When an error occurs, [sqlite3_step()] will return one of the detailed
4424** [error codes] or [extended error codes]. ^The legacy behavior was that
4425** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code
4426** and the application would have to make a second call to [sqlite3_reset()]
4427** in order to find the underlying cause of the problem. With the "v2" prepare
4428** interfaces, the underlying reason for the error is returned immediately.
4429** </li>
4431** <li>
4432** ^If the specific value bound to a [parameter | host parameter] in the
4433** WHERE clause might influence the choice of query plan for a statement,
4434** then the statement will be automatically recompiled, as if there had been
4435** a schema change, on the first [sqlite3_step()] call following any change
4436** to the [sqlite3_bind_text | bindings] of that [parameter].
4437** ^The specific value of a WHERE-clause [parameter] might influence the
4438** choice of query plan if the parameter is the left-hand side of a [LIKE]
4439** or [GLOB] operator or if the parameter is compared to an indexed column
4440** and the [SQLITE_ENABLE_STAT4] compile-time option is enabled.
4441** </li>
4442** </ol>
4444** <p>^sqlite3_prepare_v3() differs from sqlite3_prepare_v2() only in having
4445** the extra prepFlags parameter, which is a bit array consisting of zero or
4446** more of the [SQLITE_PREPARE_PERSISTENT|SQLITE_PREPARE_*] flags. ^The
4447** sqlite3_prepare_v2() interface works exactly the same as
4448** sqlite3_prepare_v3() with a zero prepFlags parameter.
4450SQLITE_API int sqlite3_prepare(
4451 sqlite3 *db, /* Database handle */
4452 const char *zSql, /* SQL statement, UTF-8 encoded */
4453 int nByte, /* Maximum length of zSql in bytes. */
4454 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
4455 const char **pzTail /* OUT: Pointer to unused portion of zSql */
4457SQLITE_API int sqlite3_prepare_v2(
4458 sqlite3 *db, /* Database handle */
4459 const char *zSql, /* SQL statement, UTF-8 encoded */
4460 int nByte, /* Maximum length of zSql in bytes. */
4461 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
4462 const char **pzTail /* OUT: Pointer to unused portion of zSql */
4464SQLITE_API int sqlite3_prepare_v3(
4465 sqlite3 *db, /* Database handle */
4466 const char *zSql, /* SQL statement, UTF-8 encoded */
4467 int nByte, /* Maximum length of zSql in bytes. */
4468 unsigned int prepFlags, /* Zero or more SQLITE_PREPARE_ flags */
4469 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
4470 const char **pzTail /* OUT: Pointer to unused portion of zSql */
4472SQLITE_API int sqlite3_prepare16(
4473 sqlite3 *db, /* Database handle */
4474 const void *zSql, /* SQL statement, UTF-16 encoded */
4475 int nByte, /* Maximum length of zSql in bytes. */
4476 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
4477 const void **pzTail /* OUT: Pointer to unused portion of zSql */
4479SQLITE_API int sqlite3_prepare16_v2(
4480 sqlite3 *db, /* Database handle */
4481 const void *zSql, /* SQL statement, UTF-16 encoded */
4482 int nByte, /* Maximum length of zSql in bytes. */
4483 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
4484 const void **pzTail /* OUT: Pointer to unused portion of zSql */
4486SQLITE_API int sqlite3_prepare16_v3(
4487 sqlite3 *db, /* Database handle */
4488 const void *zSql, /* SQL statement, UTF-16 encoded */
4489 int nByte, /* Maximum length of zSql in bytes. */
4490 unsigned int prepFlags, /* Zero or more SQLITE_PREPARE_ flags */
4491 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
4492 const void **pzTail /* OUT: Pointer to unused portion of zSql */
4496** CAPI3REF: Retrieving Statement SQL
4497** METHOD: sqlite3_stmt
4499** ^The sqlite3_sql(P) interface returns a pointer to a copy of the UTF-8
4500** SQL text used to create [prepared statement] P if P was
4501** created by [sqlite3_prepare_v2()], [sqlite3_prepare_v3()],
4502** [sqlite3_prepare16_v2()], or [sqlite3_prepare16_v3()].
4503** ^The sqlite3_expanded_sql(P) interface returns a pointer to a UTF-8
4504** string containing the SQL text of prepared statement P with
4505** [bound parameters] expanded.
4506** ^The sqlite3_normalized_sql(P) interface returns a pointer to a UTF-8
4507** string containing the normalized SQL text of prepared statement P. The
4508** semantics used to normalize a SQL statement are unspecified and subject
4509** to change. At a minimum, literal values will be replaced with suitable
4510** placeholders.
4512** ^(For example, if a prepared statement is created using the SQL
4513** text "SELECT $abc,:xyz" and if parameter $abc is bound to integer 2345
4514** and parameter :xyz is unbound, then sqlite3_sql() will return
4515** the original string, "SELECT $abc,:xyz" but sqlite3_expanded_sql()
4516** will return "SELECT 2345,NULL".)^
4518** ^The sqlite3_expanded_sql() interface returns NULL if insufficient memory
4519** is available to hold the result, or if the result would exceed the
4520** the maximum string length determined by the [SQLITE_LIMIT_LENGTH].
4522** ^The [SQLITE_TRACE_SIZE_LIMIT] compile-time option limits the size of
4523** bound parameter expansions. ^The [SQLITE_OMIT_TRACE] compile-time
4524** option causes sqlite3_expanded_sql() to always return NULL.
4526** ^The strings returned by sqlite3_sql(P) and sqlite3_normalized_sql(P)
4527** are managed by SQLite and are automatically freed when the prepared
4528** statement is finalized.
4529** ^The string returned by sqlite3_expanded_sql(P), on the other hand,
4530** is obtained from [sqlite3_malloc()] and must be freed by the application
4531** by passing it to [sqlite3_free()].
4533** ^The sqlite3_normalized_sql() interface is only available if
4534** the [SQLITE_ENABLE_NORMALIZE] compile-time option is defined.
4536SQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt);
4537SQLITE_API char *sqlite3_expanded_sql(sqlite3_stmt *pStmt);
4539SQLITE_API const char *sqlite3_normalized_sql(sqlite3_stmt *pStmt);
4543** CAPI3REF: Determine If An SQL Statement Writes The Database
4544** METHOD: sqlite3_stmt
4546** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if
4547** and only if the [prepared statement] X makes no direct changes to
4548** the content of the database file.
4550** Note that [application-defined SQL functions] or
4551** [virtual tables] might change the database indirectly as a side effect.
4552** ^(For example, if an application defines a function "eval()" that
4553** calls [sqlite3_exec()], then the following SQL statement would
4554** change the database file through side-effects:
4556** <blockquote><pre>
4557** SELECT eval('DELETE FROM t1') FROM t2;
4558** </pre></blockquote>
4560** But because the [SELECT] statement does not change the database file
4561** directly, sqlite3_stmt_readonly() would still return true.)^
4563** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK],
4564** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true,
4565** since the statements themselves do not actually modify the database but
4566** rather they control the timing of when other statements modify the
4567** database. ^The [ATTACH] and [DETACH] statements also cause
4568** sqlite3_stmt_readonly() to return true since, while those statements
4569** change the configuration of a database connection, they do not make
4570** changes to the content of the database files on disk.
4571** ^The sqlite3_stmt_readonly() interface returns true for [BEGIN] since
4572** [BEGIN] merely sets internal flags, but the [BEGIN|BEGIN IMMEDIATE] and
4573** [BEGIN|BEGIN EXCLUSIVE] commands do touch the database and so
4574** sqlite3_stmt_readonly() returns false for those commands.
4576** ^This routine returns false if there is any possibility that the
4577** statement might change the database file. ^A false return does
4578** not guarantee that the statement will change the database file.
4579** ^For example, an UPDATE statement might have a WHERE clause that
4580** makes it a no-op, but the sqlite3_stmt_readonly() result would still
4581** be false. ^Similarly, a CREATE TABLE IF NOT EXISTS statement is a
4582** read-only no-op if the table already exists, but
4583** sqlite3_stmt_readonly() still returns false for such a statement.
4585SQLITE_API int sqlite3_stmt_readonly(sqlite3_stmt *pStmt);
4588** CAPI3REF: Query The EXPLAIN Setting For A Prepared Statement
4589** METHOD: sqlite3_stmt
4591** ^The sqlite3_stmt_isexplain(S) interface returns 1 if the
4592** prepared statement S is an EXPLAIN statement, or 2 if the
4593** statement S is an EXPLAIN QUERY PLAN.
4594** ^The sqlite3_stmt_isexplain(S) interface returns 0 if S is
4595** an ordinary statement or a NULL pointer.
4597SQLITE_API int sqlite3_stmt_isexplain(sqlite3_stmt *pStmt);
4600** CAPI3REF: Determine If A Prepared Statement Has Been Reset
4601** METHOD: sqlite3_stmt
4603** ^The sqlite3_stmt_busy(S) interface returns true (non-zero) if the
4604** [prepared statement] S has been stepped at least once using
4605** [sqlite3_step(S)] but has neither run to completion (returned
4606** [SQLITE_DONE] from [sqlite3_step(S)]) nor
4607** been reset using [sqlite3_reset(S)]. ^The sqlite3_stmt_busy(S)
4608** interface returns false if S is a NULL pointer. If S is not a
4609** NULL pointer and is not a pointer to a valid [prepared statement]
4610** object, then the behavior is undefined and probably undesirable.
4612** This interface can be used in combination [sqlite3_next_stmt()]
4613** to locate all prepared statements associated with a database
4614** connection that are in need of being reset. This can be used,
4615** for example, in diagnostic routines to search for prepared
4616** statements that are holding a transaction open.
4618SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*);
4621** CAPI3REF: Dynamically Typed Value Object
4622** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value}
4624** SQLite uses the sqlite3_value object to represent all values
4625** that can be stored in a database table. SQLite uses dynamic typing
4626** for the values it stores. ^Values stored in sqlite3_value objects
4627** can be integers, floating point values, strings, BLOBs, or NULL.
4629** An sqlite3_value object may be either "protected" or "unprotected".
4630** Some interfaces require a protected sqlite3_value. Other interfaces
4631** will accept either a protected or an unprotected sqlite3_value.
4632** Every interface that accepts sqlite3_value arguments specifies
4633** whether or not it requires a protected sqlite3_value. The
4634** [sqlite3_value_dup()] interface can be used to construct a new
4635** protected sqlite3_value from an unprotected sqlite3_value.
4637** The terms "protected" and "unprotected" refer to whether or not
4638** a mutex is held. An internal mutex is held for a protected
4639** sqlite3_value object but no mutex is held for an unprotected
4640** sqlite3_value object. If SQLite is compiled to be single-threaded
4641** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0)
4642** or if SQLite is run in one of reduced mutex modes
4644** then there is no distinction between protected and unprotected
4645** sqlite3_value objects and they can be used interchangeably. However,
4646** for maximum code portability it is recommended that applications
4647** still make the distinction between protected and unprotected
4648** sqlite3_value objects even when not strictly required.
4650** ^The sqlite3_value objects that are passed as parameters into the
4651** implementation of [application-defined SQL functions] are protected.
4652** ^The sqlite3_value object returned by
4653** [sqlite3_column_value()] is unprotected.
4654** Unprotected sqlite3_value objects may only be used as arguments
4655** to [sqlite3_result_value()], [sqlite3_bind_value()], and
4656** [sqlite3_value_dup()].
4657** The [sqlite3_value_blob | sqlite3_value_type()] family of
4658** interfaces require protected sqlite3_value objects.
4660typedef struct sqlite3_value sqlite3_value;
4663** CAPI3REF: SQL Function Context Object
4665** The context in which an SQL function executes is stored in an
4666** sqlite3_context object. ^A pointer to an sqlite3_context object
4667** is always first parameter to [application-defined SQL functions].
4668** The application-defined SQL function implementation will pass this
4669** pointer through into calls to [sqlite3_result_int | sqlite3_result()],
4670** [sqlite3_aggregate_context()], [sqlite3_user_data()],
4671** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()],
4672** and/or [sqlite3_set_auxdata()].
4674typedef struct sqlite3_context sqlite3_context;
4677** CAPI3REF: Binding Values To Prepared Statements
4678** KEYWORDS: {host parameter} {host parameters} {host parameter name}
4679** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding}
4680** METHOD: sqlite3_stmt
4682** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants,
4683** literals may be replaced by a [parameter] that matches one of following
4684** templates:
4686** <ul>
4687** <li> ?
4688** <li> ?NNN
4689** <li> :VVV
4690** <li> @VVV
4691** <li> $VVV
4692** </ul>
4694** In the templates above, NNN represents an integer literal,
4695** and VVV represents an alphanumeric identifier.)^ ^The values of these
4696** parameters (also called "host parameter names" or "SQL parameters")
4697** can be set using the sqlite3_bind_*() routines defined here.
4699** ^The first argument to the sqlite3_bind_*() routines is always
4700** a pointer to the [sqlite3_stmt] object returned from
4701** [sqlite3_prepare_v2()] or its variants.
4703** ^The second argument is the index of the SQL parameter to be set.
4704** ^The leftmost SQL parameter has an index of 1. ^When the same named
4705** SQL parameter is used more than once, second and subsequent
4706** occurrences have the same index as the first occurrence.
4707** ^The index for named parameters can be looked up using the
4708** [sqlite3_bind_parameter_index()] API if desired. ^The index
4709** for "?NNN" parameters is the value of NNN.
4710** ^The NNN value must be between 1 and the [sqlite3_limit()]
4711** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 32766).
4713** ^The third argument is the value to bind to the parameter.
4714** ^If the third parameter to sqlite3_bind_text() or sqlite3_bind_text16()
4715** or sqlite3_bind_blob() is a NULL pointer then the fourth parameter
4716** is ignored and the end result is the same as sqlite3_bind_null().
4717** ^If the third parameter to sqlite3_bind_text() is not NULL, then
4718** it should be a pointer to well-formed UTF8 text.
4719** ^If the third parameter to sqlite3_bind_text16() is not NULL, then
4720** it should be a pointer to well-formed UTF16 text.
4721** ^If the third parameter to sqlite3_bind_text64() is not NULL, then
4722** it should be a pointer to a well-formed unicode string that is
4723** either UTF8 if the sixth parameter is SQLITE_UTF8, or UTF16
4724** otherwise.
4726** [[byte-order determination rules]] ^The byte-order of
4727** UTF16 input text is determined by the byte-order mark (BOM, U+FEFF)
4728** found in first character, which is removed, or in the absence of a BOM
4729** the byte order is the native byte order of the host
4730** machine for sqlite3_bind_text16() or the byte order specified in
4731** the 6th parameter for sqlite3_bind_text64().)^
4732** ^If UTF16 input text contains invalid unicode
4733** characters, then SQLite might change those invalid characters
4734** into the unicode replacement character: U+FFFD.
4736** ^(In those routines that have a fourth argument, its value is the
4737** number of bytes in the parameter. To be clear: the value is the
4738** number of <u>bytes</u> in the value, not the number of characters.)^
4739** ^If the fourth parameter to sqlite3_bind_text() or sqlite3_bind_text16()
4740** is negative, then the length of the string is
4741** the number of bytes up to the first zero terminator.
4742** If the fourth parameter to sqlite3_bind_blob() is negative, then
4743** the behavior is undefined.
4744** If a non-negative fourth parameter is provided to sqlite3_bind_text()
4745** or sqlite3_bind_text16() or sqlite3_bind_text64() then
4746** that parameter must be the byte offset
4747** where the NUL terminator would occur assuming the string were NUL
4748** terminated. If any NUL characters occurs at byte offsets less than
4749** the value of the fourth parameter then the resulting string value will
4750** contain embedded NULs. The result of expressions involving strings
4751** with embedded NULs is undefined.
4753** ^The fifth argument to the BLOB and string binding interfaces controls
4754** or indicates the lifetime of the object referenced by the third parameter.
4755** These three options exist:
4756** ^ (1) A destructor to dispose of the BLOB or string after SQLite has finished
4757** with it may be passed. ^It is called to dispose of the BLOB or string even
4758** if the call to the bind API fails, except the destructor is not called if
4759** the third parameter is a NULL pointer or the fourth parameter is negative.
4760** ^ (2) The special constant, [SQLITE_STATIC], may be passsed to indicate that
4761** the application remains responsible for disposing of the object. ^In this
4762** case, the object and the provided pointer to it must remain valid until
4763** either the prepared statement is finalized or the same SQL parameter is
4764** bound to something else, whichever occurs sooner.
4765** ^ (3) The constant, [SQLITE_TRANSIENT], may be passed to indicate that the
4766** object is to be copied prior to the return from sqlite3_bind_*(). ^The
4767** object and pointer to it must remain valid until then. ^SQLite will then
4768** manage the lifetime of its private copy.
4770** ^The sixth argument to sqlite3_bind_text64() must be one of
4772** to specify the encoding of the text in the third parameter. If
4773** the sixth argument to sqlite3_bind_text64() is not one of the
4774** allowed values shown above, or if the text encoding is different
4775** from the encoding specified by the sixth parameter, then the behavior
4776** is undefined.
4778** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that
4779** is filled with zeroes. ^A zeroblob uses a fixed amount of memory
4780** (just an integer to hold its size) while it is being processed.
4781** Zeroblobs are intended to serve as placeholders for BLOBs whose
4782** content is later written using
4783** [sqlite3_blob_open | incremental BLOB I/O] routines.
4784** ^A negative value for the zeroblob results in a zero-length BLOB.
4786** ^The sqlite3_bind_pointer(S,I,P,T,D) routine causes the I-th parameter in
4787** [prepared statement] S to have an SQL value of NULL, but to also be
4788** associated with the pointer P of type T. ^D is either a NULL pointer or
4789** a pointer to a destructor function for P. ^SQLite will invoke the
4790** destructor D with a single argument of P when it is finished using
4791** P. The T parameter should be a static string, preferably a string
4792** literal. The sqlite3_bind_pointer() routine is part of the
4793** [pointer passing interface] added for SQLite 3.20.0.
4795** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer
4796** for the [prepared statement] or with a prepared statement for which
4797** [sqlite3_step()] has been called more recently than [sqlite3_reset()],
4798** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_()
4799** routine is passed a [prepared statement] that has been finalized, the
4800** result is undefined and probably harmful.
4802** ^Bindings are not cleared by the [sqlite3_reset()] routine.
4803** ^Unbound parameters are interpreted as NULL.
4805** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an
4806** [error code] if anything goes wrong.
4807** ^[SQLITE_TOOBIG] might be returned if the size of a string or BLOB
4808** exceeds limits imposed by [sqlite3_limit]([SQLITE_LIMIT_LENGTH]) or
4810** ^[SQLITE_RANGE] is returned if the parameter
4811** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails.
4813** See also: [sqlite3_bind_parameter_count()],
4814** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()].
4816SQLITE_API int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*));
4817SQLITE_API int sqlite3_bind_blob64(sqlite3_stmt*, int, const void*, sqlite3_uint64,
4818 void(*)(void*));
4819SQLITE_API int sqlite3_bind_double(sqlite3_stmt*, int, double);
4820SQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int);
4821SQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64);
4822SQLITE_API int sqlite3_bind_null(sqlite3_stmt*, int);
4823SQLITE_API int sqlite3_bind_text(sqlite3_stmt*,int,const char*,int,void(*)(void*));
4824SQLITE_API int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*));
4825SQLITE_API int sqlite3_bind_text64(sqlite3_stmt*, int, const char*, sqlite3_uint64,
4826 void(*)(void*), unsigned char encoding);
4827SQLITE_API int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);
4828SQLITE_API int sqlite3_bind_pointer(sqlite3_stmt*, int, void*, const char*,void(*)(void*));
4829SQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n);
4830SQLITE_API int sqlite3_bind_zeroblob64(sqlite3_stmt*, int, sqlite3_uint64);
4833** CAPI3REF: Number Of SQL Parameters
4834** METHOD: sqlite3_stmt
4836** ^This routine can be used to find the number of [SQL parameters]
4837** in a [prepared statement]. SQL parameters are tokens of the
4838** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as
4839** placeholders for values that are [sqlite3_bind_blob | bound]
4840** to the parameters at a later time.
4842** ^(This routine actually returns the index of the largest (rightmost)
4843** parameter. For all forms except ?NNN, this will correspond to the
4844** number of unique parameters. If parameters of the ?NNN form are used,
4845** there may be gaps in the list.)^
4847** See also: [sqlite3_bind_blob|sqlite3_bind()],
4848** [sqlite3_bind_parameter_name()], and
4849** [sqlite3_bind_parameter_index()].
4851SQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt*);
4854** CAPI3REF: Name Of A Host Parameter
4855** METHOD: sqlite3_stmt
4857** ^The sqlite3_bind_parameter_name(P,N) interface returns
4858** the name of the N-th [SQL parameter] in the [prepared statement] P.
4859** ^(SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA"
4860** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA"
4861** respectively.
4862** In other words, the initial ":" or "$" or "@" or "?"
4863** is included as part of the name.)^
4864** ^Parameters of the form "?" without a following integer have no name
4865** and are referred to as "nameless" or "anonymous parameters".
4867** ^The first host parameter has an index of 1, not 0.
4869** ^If the value N is out of range or if the N-th parameter is
4870** nameless, then NULL is returned. ^The returned string is
4871** always in UTF-8 encoding even if the named parameter was
4872** originally specified as UTF-16 in [sqlite3_prepare16()],
4873** [sqlite3_prepare16_v2()], or [sqlite3_prepare16_v3()].
4875** See also: [sqlite3_bind_blob|sqlite3_bind()],
4876** [sqlite3_bind_parameter_count()], and
4877** [sqlite3_bind_parameter_index()].
4879SQLITE_API const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int);
4882** CAPI3REF: Index Of A Parameter With A Given Name
4883** METHOD: sqlite3_stmt
4885** ^Return the index of an SQL parameter given its name. ^The
4886** index value returned is suitable for use as the second
4887** parameter to [sqlite3_bind_blob|sqlite3_bind()]. ^A zero
4888** is returned if no matching parameter is found. ^The parameter
4889** name must be given in UTF-8 even if the original statement
4890** was prepared from UTF-16 text using [sqlite3_prepare16_v2()] or
4891** [sqlite3_prepare16_v3()].
4893** See also: [sqlite3_bind_blob|sqlite3_bind()],
4894** [sqlite3_bind_parameter_count()], and
4895** [sqlite3_bind_parameter_name()].
4897SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName);
4900** CAPI3REF: Reset All Bindings On A Prepared Statement
4901** METHOD: sqlite3_stmt
4903** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset
4904** the [sqlite3_bind_blob | bindings] on a [prepared statement].
4905** ^Use this routine to reset all host parameters to NULL.
4907SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*);
4910** CAPI3REF: Number Of Columns In A Result Set
4911** METHOD: sqlite3_stmt
4913** ^Return the number of columns in the result set returned by the
4914** [prepared statement]. ^If this routine returns 0, that means the
4915** [prepared statement] returns no data (for example an [UPDATE]).
4916** ^However, just because this routine returns a positive number does not
4917** mean that one or more rows of data will be returned. ^A SELECT statement
4918** will always have a positive sqlite3_column_count() but depending on the
4919** WHERE clause constraints and the table content, it might return no rows.
4921** See also: [sqlite3_data_count()]
4923SQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt);
4926** CAPI3REF: Column Names In A Result Set
4927** METHOD: sqlite3_stmt
4929** ^These routines return the name assigned to a particular column
4930** in the result set of a [SELECT] statement. ^The sqlite3_column_name()
4931** interface returns a pointer to a zero-terminated UTF-8 string
4932** and sqlite3_column_name16() returns a pointer to a zero-terminated
4933** UTF-16 string. ^The first parameter is the [prepared statement]
4934** that implements the [SELECT] statement. ^The second parameter is the
4935** column number. ^The leftmost column is number 0.
4937** ^The returned string pointer is valid until either the [prepared statement]
4938** is destroyed by [sqlite3_finalize()] or until the statement is automatically
4939** reprepared by the first call to [sqlite3_step()] for a particular run
4940** or until the next call to
4941** sqlite3_column_name() or sqlite3_column_name16() on the same column.
4943** ^If sqlite3_malloc() fails during the processing of either routine
4944** (for example during a conversion from UTF-8 to UTF-16) then a
4945** NULL pointer is returned.
4947** ^The name of a result column is the value of the "AS" clause for
4948** that column, if there is an AS clause. If there is no AS clause
4949** then the name of the column is unspecified and may change from
4950** one release of SQLite to the next.
4952SQLITE_API const char *sqlite3_column_name(sqlite3_stmt*, int N);
4953SQLITE_API const void *sqlite3_column_name16(sqlite3_stmt*, int N);
4956** CAPI3REF: Source Of Data In A Query Result
4957** METHOD: sqlite3_stmt
4959** ^These routines provide a means to determine the database, table, and
4960** table column that is the origin of a particular result column in
4961** [SELECT] statement.
4962** ^The name of the database or table or column can be returned as
4963** either a UTF-8 or UTF-16 string. ^The _database_ routines return
4964** the database name, the _table_ routines return the table name, and
4965** the origin_ routines return the column name.
4966** ^The returned string is valid until the [prepared statement] is destroyed
4967** using [sqlite3_finalize()] or until the statement is automatically
4968** reprepared by the first call to [sqlite3_step()] for a particular run
4969** or until the same information is requested
4970** again in a different encoding.
4972** ^The names returned are the original un-aliased names of the
4973** database, table, and column.
4975** ^The first argument to these interfaces is a [prepared statement].
4976** ^These functions return information about the Nth result column returned by
4977** the statement, where N is the second function argument.
4978** ^The left-most column is column 0 for these routines.
4980** ^If the Nth column returned by the statement is an expression or
4981** subquery and is not a column value, then all of these functions return
4982** NULL. ^These routines might also return NULL if a memory allocation error
4983** occurs. ^Otherwise, they return the name of the attached database, table,
4984** or column that query result column was extracted from.
4986** ^As with all other SQLite APIs, those whose names end with "16" return
4987** UTF-16 encoded strings and the other functions return UTF-8.
4989** ^These APIs are only available if the library was compiled with the
4990** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol.
4992** If two or more threads call one or more
4993** [sqlite3_column_database_name | column metadata interfaces]
4994** for the same [prepared statement] and result column
4995** at the same time then the results are undefined.
4997SQLITE_API const char *sqlite3_column_database_name(sqlite3_stmt*,int);
4998SQLITE_API const void *sqlite3_column_database_name16(sqlite3_stmt*,int);
4999SQLITE_API const char *sqlite3_column_table_name(sqlite3_stmt*,int);
5000SQLITE_API const void *sqlite3_column_table_name16(sqlite3_stmt*,int);
5001SQLITE_API const char *sqlite3_column_origin_name(sqlite3_stmt*,int);
5002SQLITE_API const void *sqlite3_column_origin_name16(sqlite3_stmt*,int);
5005** CAPI3REF: Declared Datatype Of A Query Result
5006** METHOD: sqlite3_stmt
5008** ^(The first parameter is a [prepared statement].
5009** If this statement is a [SELECT] statement and the Nth column of the
5010** returned result set of that [SELECT] is a table column (not an
5011** expression or subquery) then the declared type of the table
5012** column is returned.)^ ^If the Nth column of the result set is an
5013** expression or subquery, then a NULL pointer is returned.
5014** ^The returned string is always UTF-8 encoded.
5016** ^(For example, given the database schema:
5020** and the following statement to be compiled:
5022** SELECT c1 + 1, c1 FROM t1;
5024** this routine would return the string "VARIANT" for the second result
5025** column (i==1), and a NULL pointer for the first result column (i==0).)^
5027** ^SQLite uses dynamic run-time typing. ^So just because a column
5028** is declared to contain a particular type does not mean that the
5029** data stored in that column is of the declared type. SQLite is
5030** strongly typed, but the typing is dynamic not static. ^Type
5031** is associated with individual values, not with the containers
5032** used to hold those values.
5034SQLITE_API const char *sqlite3_column_decltype(sqlite3_stmt*,int);
5035SQLITE_API const void *sqlite3_column_decltype16(sqlite3_stmt*,int);
5038** CAPI3REF: Evaluate An SQL Statement
5039** METHOD: sqlite3_stmt
5041** After a [prepared statement] has been prepared using any of
5042** [sqlite3_prepare_v2()], [sqlite3_prepare_v3()], [sqlite3_prepare16_v2()],
5043** or [sqlite3_prepare16_v3()] or one of the legacy
5044** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function
5045** must be called one or more times to evaluate the statement.
5047** The details of the behavior of the sqlite3_step() interface depend
5048** on whether the statement was prepared using the newer "vX" interfaces
5049** [sqlite3_prepare_v3()], [sqlite3_prepare_v2()], [sqlite3_prepare16_v3()],
5050** [sqlite3_prepare16_v2()] or the older legacy
5051** interfaces [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the
5052** new "vX" interface is recommended for new applications but the legacy
5053** interface will continue to be supported.
5055** ^In the legacy interface, the return value will be either [SQLITE_BUSY],
5057** ^With the "v2" interface, any of the other [result codes] or
5058** [extended result codes] might be returned as well.
5060** ^[SQLITE_BUSY] means that the database engine was unable to acquire the
5061** database locks it needs to do its job. ^If the statement is a [COMMIT]
5062** or occurs outside of an explicit transaction, then you can retry the
5063** statement. If the statement is not a [COMMIT] and occurs within an
5064** explicit transaction then you should rollback the transaction before
5065** continuing.
5067** ^[SQLITE_DONE] means that the statement has finished executing
5068** successfully. sqlite3_step() should not be called again on this virtual
5069** machine without first calling [sqlite3_reset()] to reset the virtual
5070** machine back to its initial state.
5072** ^If the SQL statement being executed returns any data, then [SQLITE_ROW]
5073** is returned each time a new row of data is ready for processing by the
5074** caller. The values may be accessed using the [column access functions].
5075** sqlite3_step() is called again to retrieve the next row of data.
5077** ^[SQLITE_ERROR] means that a run-time error (such as a constraint
5078** violation) has occurred. sqlite3_step() should not be called again on
5079** the VM. More information may be found by calling [sqlite3_errmsg()].
5080** ^With the legacy interface, a more specific error code (for example,
5082** can be obtained by calling [sqlite3_reset()] on the
5083** [prepared statement]. ^In the "v2" interface,
5084** the more specific error code is returned directly by sqlite3_step().
5086** [SQLITE_MISUSE] means that the this routine was called inappropriately.
5087** Perhaps it was called on a [prepared statement] that has
5088** already been [sqlite3_finalize | finalized] or on one that had
5089** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could
5090** be the case that the same database connection is being used by two or
5091** more threads at the same moment in time.
5093** For all versions of SQLite up to and including, a call to
5094** [sqlite3_reset()] was required after sqlite3_step() returned anything
5095** other than [SQLITE_ROW] before any subsequent invocation of
5096** sqlite3_step(). Failure to reset the prepared statement using
5097** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from
5098** sqlite3_step(). But after [version] ([dateof:],
5099** sqlite3_step() began
5100** calling [sqlite3_reset()] automatically in this circumstance rather
5101** than returning [SQLITE_MISUSE]. This is not considered a compatibility
5102** break because any application that ever receives an SQLITE_MISUSE error
5103** is broken by definition. The [SQLITE_OMIT_AUTORESET] compile-time option
5104** can be used to restore the legacy behavior.
5106** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step()
5107** API always returns a generic error code, [SQLITE_ERROR], following any
5108** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call
5109** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the
5110** specific [error codes] that better describes the error.
5111** We admit that this is a goofy design. The problem has been fixed
5112** with the "v2" interface. If you prepare all of your SQL statements
5113** using [sqlite3_prepare_v3()] or [sqlite3_prepare_v2()]
5114** or [sqlite3_prepare16_v2()] or [sqlite3_prepare16_v3()] instead
5115** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces,
5116** then the more specific [error codes] are returned directly
5117** by sqlite3_step(). The use of the "vX" interfaces is recommended.
5119SQLITE_API int sqlite3_step(sqlite3_stmt*);
5122** CAPI3REF: Number of columns in a result set
5123** METHOD: sqlite3_stmt
5125** ^The sqlite3_data_count(P) interface returns the number of columns in the
5126** current row of the result set of [prepared statement] P.
5127** ^If prepared statement P does not have results ready to return
5128** (via calls to the [sqlite3_column_int | sqlite3_column()] family of
5129** interfaces) then sqlite3_data_count(P) returns 0.
5130** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer.
5131** ^The sqlite3_data_count(P) routine returns 0 if the previous call to
5132** [sqlite3_step](P) returned [SQLITE_DONE]. ^The sqlite3_data_count(P)
5133** will return non-zero if previous call to [sqlite3_step](P) returned
5134** [SQLITE_ROW], except in the case of the [PRAGMA incremental_vacuum]
5135** where it always returns zero since each step of that multi-step
5136** pragma returns 0 columns of data.
5138** See also: [sqlite3_column_count()]
5140SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt);
5143** CAPI3REF: Fundamental Datatypes
5146** ^(Every value in SQLite has one of five fundamental datatypes:
5148** <ul>
5149** <li> 64-bit signed integer
5150** <li> 64-bit IEEE floating point number
5151** <li> string
5152** <li> BLOB
5153** <li> NULL
5154** </ul>)^
5156** These constants are codes for each of those types.
5158** Note that the SQLITE_TEXT constant was also used in SQLite version 2
5159** for a completely different meaning. Software that links against both
5160** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not
5163#define SQLITE_INTEGER 1
5164#define SQLITE_FLOAT 2
5165#define SQLITE_BLOB 4
5166#define SQLITE_NULL 5
5167#ifdef SQLITE_TEXT
5168# undef SQLITE_TEXT
5170# define SQLITE_TEXT 3
5172#define SQLITE3_TEXT 3
5175** CAPI3REF: Result Values From A Query
5176** KEYWORDS: {column access functions}
5177** METHOD: sqlite3_stmt
5179** <b>Summary:</b>
5180** <blockquote><table border=0 cellpadding=0 cellspacing=0>
5181** <tr><td><b>sqlite3_column_blob</b><td>&rarr;<td>BLOB result
5182** <tr><td><b>sqlite3_column_double</b><td>&rarr;<td>REAL result
5183** <tr><td><b>sqlite3_column_int</b><td>&rarr;<td>32-bit INTEGER result
5184** <tr><td><b>sqlite3_column_int64</b><td>&rarr;<td>64-bit INTEGER result
5185** <tr><td><b>sqlite3_column_text</b><td>&rarr;<td>UTF-8 TEXT result
5186** <tr><td><b>sqlite3_column_text16</b><td>&rarr;<td>UTF-16 TEXT result
5187** <tr><td><b>sqlite3_column_value</b><td>&rarr;<td>The result as an
5188** [sqlite3_value|unprotected sqlite3_value] object.
5189** <tr><td>&nbsp;<td>&nbsp;<td>&nbsp;
5190** <tr><td><b>sqlite3_column_bytes</b><td>&rarr;<td>Size of a BLOB
5191** or a UTF-8 TEXT result in bytes
5192** <tr><td><b>sqlite3_column_bytes16&nbsp;&nbsp;</b>
5193** <td>&rarr;&nbsp;&nbsp;<td>Size of UTF-16
5194** TEXT in bytes
5195** <tr><td><b>sqlite3_column_type</b><td>&rarr;<td>Default
5196** datatype of the result
5197** </table></blockquote>
5199** <b>Details:</b>
5201** ^These routines return information about a single column of the current
5202** result row of a query. ^In every case the first argument is a pointer
5203** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*]
5204** that was returned from [sqlite3_prepare_v2()] or one of its variants)
5205** and the second argument is the index of the column for which information
5206** should be returned. ^The leftmost column of the result set has the index 0.
5207** ^The number of columns in the result can be determined using
5208** [sqlite3_column_count()].
5210** If the SQL statement does not currently point to a valid row, or if the
5211** column index is out of range, the result is undefined.
5212** These routines may only be called when the most recent call to
5213** [sqlite3_step()] has returned [SQLITE_ROW] and neither
5214** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently.
5215** If any of these routines are called after [sqlite3_reset()] or
5216** [sqlite3_finalize()] or after [sqlite3_step()] has returned
5217** something other than [SQLITE_ROW], the results are undefined.
5218** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()]
5219** are called from a different thread while any of these routines
5220** are pending, then the results are undefined.
5222** The first six interfaces (_blob, _double, _int, _int64, _text, and _text16)
5223** each return the value of a result column in a specific data format. If
5224** the result column is not initially in the requested format (for example,
5225** if the query returns an integer but the sqlite3_column_text() interface
5226** is used to extract the value) then an automatic type conversion is performed.
5228** ^The sqlite3_column_type() routine returns the
5229** [SQLITE_INTEGER | datatype code] for the initial data type
5230** of the result column. ^The returned value is one of [SQLITE_INTEGER],
5232** The return value of sqlite3_column_type() can be used to decide which
5233** of the first six interface should be used to extract the column value.
5234** The value returned by sqlite3_column_type() is only meaningful if no
5235** automatic type conversions have occurred for the value in question.
5236** After a type conversion, the result of calling sqlite3_column_type()
5237** is undefined, though harmless. Future
5238** versions of SQLite may change the behavior of sqlite3_column_type()
5239** following a type conversion.
5241** If the result is a BLOB or a TEXT string, then the sqlite3_column_bytes()
5242** or sqlite3_column_bytes16() interfaces can be used to determine the size
5243** of that BLOB or string.
5245** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes()
5246** routine returns the number of bytes in that BLOB or string.
5247** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts
5248** the string to UTF-8 and then returns the number of bytes.
5249** ^If the result is a numeric value then sqlite3_column_bytes() uses
5250** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns
5251** the number of bytes in that string.
5252** ^If the result is NULL, then sqlite3_column_bytes() returns zero.
5254** ^If the result is a BLOB or UTF-16 string then the sqlite3_column_bytes16()
5255** routine returns the number of bytes in that BLOB or string.
5256** ^If the result is a UTF-8 string, then sqlite3_column_bytes16() converts
5257** the string to UTF-16 and then returns the number of bytes.
5258** ^If the result is a numeric value then sqlite3_column_bytes16() uses
5259** [sqlite3_snprintf()] to convert that value to a UTF-16 string and returns
5260** the number of bytes in that string.
5261** ^If the result is NULL, then sqlite3_column_bytes16() returns zero.
5263** ^The values returned by [sqlite3_column_bytes()] and
5264** [sqlite3_column_bytes16()] do not include the zero terminators at the end
5265** of the string. ^For clarity: the values returned by
5266** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of
5267** bytes in the string, not the number of characters.
5269** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(),
5270** even empty strings, are always zero-terminated. ^The return
5271** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer.
5273** <b>Warning:</b> ^The object returned by [sqlite3_column_value()] is an
5274** [unprotected sqlite3_value] object. In a multithreaded environment,
5275** an unprotected sqlite3_value object may only be used safely with
5276** [sqlite3_bind_value()] and [sqlite3_result_value()].
5277** If the [unprotected sqlite3_value] object returned by
5278** [sqlite3_column_value()] is used in any other way, including calls
5279** to routines like [sqlite3_value_int()], [sqlite3_value_text()],
5280** or [sqlite3_value_bytes()], the behavior is not threadsafe.
5281** Hence, the sqlite3_column_value() interface
5282** is normally only useful within the implementation of
5283** [application-defined SQL functions] or [virtual tables], not within
5284** top-level application code.
5286** The these routines may attempt to convert the datatype of the result.
5287** ^For example, if the internal representation is FLOAT and a text result
5288** is requested, [sqlite3_snprintf()] is used internally to perform the
5289** conversion automatically. ^(The following table details the conversions
5290** that are applied:
5292** <blockquote>
5293** <table border="1">
5294** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion
5296** <tr><td> NULL <td> INTEGER <td> Result is 0
5297** <tr><td> NULL <td> FLOAT <td> Result is 0.0
5298** <tr><td> NULL <td> TEXT <td> Result is a NULL pointer
5299** <tr><td> NULL <td> BLOB <td> Result is a NULL pointer
5300** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float
5301** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer
5302** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT
5303** <tr><td> FLOAT <td> INTEGER <td> [CAST] to INTEGER
5304** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float
5305** <tr><td> FLOAT <td> BLOB <td> [CAST] to BLOB
5306** <tr><td> TEXT <td> INTEGER <td> [CAST] to INTEGER
5307** <tr><td> TEXT <td> FLOAT <td> [CAST] to REAL
5308** <tr><td> TEXT <td> BLOB <td> No change
5309** <tr><td> BLOB <td> INTEGER <td> [CAST] to INTEGER
5310** <tr><td> BLOB <td> FLOAT <td> [CAST] to REAL
5311** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed
5312** </table>
5313** </blockquote>)^
5315** Note that when type conversions occur, pointers returned by prior
5316** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or
5317** sqlite3_column_text16() may be invalidated.
5318** Type conversions and pointer invalidations might occur
5319** in the following cases:
5321** <ul>
5322** <li> The initial content is a BLOB and sqlite3_column_text() or
5323** sqlite3_column_text16() is called. A zero-terminator might
5324** need to be added to the string.</li>
5325** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or
5326** sqlite3_column_text16() is called. The content must be converted
5327** to UTF-16.</li>
5328** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or
5329** sqlite3_column_text() is called. The content must be converted
5330** to UTF-8.</li>
5331** </ul>
5333** ^Conversions between UTF-16be and UTF-16le are always done in place and do
5334** not invalidate a prior pointer, though of course the content of the buffer
5335** that the prior pointer references will have been modified. Other kinds
5336** of conversion are done in place when it is possible, but sometimes they
5337** are not possible and in those cases prior pointers are invalidated.
5339** The safest policy is to invoke these routines
5340** in one of the following ways:
5342** <ul>
5343** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li>
5344** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li>
5345** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li>
5346** </ul>
5348** In other words, you should call sqlite3_column_text(),
5349** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result
5350** into the desired format, then invoke sqlite3_column_bytes() or
5351** sqlite3_column_bytes16() to find the size of the result. Do not mix calls
5352** to sqlite3_column_text() or sqlite3_column_blob() with calls to
5353** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16()
5354** with calls to sqlite3_column_bytes().
5356** ^The pointers returned are valid until a type conversion occurs as
5357** described above, or until [sqlite3_step()] or [sqlite3_reset()] or
5358** [sqlite3_finalize()] is called. ^The memory space used to hold strings
5359** and BLOBs is freed automatically. Do not pass the pointers returned
5360** from [sqlite3_column_blob()], [sqlite3_column_text()], etc. into
5361** [sqlite3_free()].
5363** As long as the input parameters are correct, these routines will only
5364** fail if an out-of-memory error occurs during a format conversion.
5365** Only the following subset of interfaces are subject to out-of-memory
5366** errors:
5368** <ul>
5369** <li> sqlite3_column_blob()
5370** <li> sqlite3_column_text()
5371** <li> sqlite3_column_text16()
5372** <li> sqlite3_column_bytes()
5373** <li> sqlite3_column_bytes16()
5374** </ul>
5376** If an out-of-memory error occurs, then the return value from these
5377** routines is the same as if the column had contained an SQL NULL value.
5378** Valid SQL NULL returns can be distinguished from out-of-memory errors
5379** by invoking the [sqlite3_errcode()] immediately after the suspect
5380** return value is obtained and before any
5381** other SQLite interface is called on the same [database connection].
5383SQLITE_API const void *sqlite3_column_blob(sqlite3_stmt*, int iCol);
5384SQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol);
5385SQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol);
5386SQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol);
5387SQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol);
5388SQLITE_API const void *sqlite3_column_text16(sqlite3_stmt*, int iCol);
5389SQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol);
5390SQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
5391SQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
5392SQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol);
5395** CAPI3REF: Destroy A Prepared Statement Object
5396** DESTRUCTOR: sqlite3_stmt
5398** ^The sqlite3_finalize() function is called to delete a [prepared statement].
5399** ^If the most recent evaluation of the statement encountered no errors
5400** or if the statement is never been evaluated, then sqlite3_finalize() returns
5401** SQLITE_OK. ^If the most recent evaluation of statement S failed, then
5402** sqlite3_finalize(S) returns the appropriate [error code] or
5403** [extended error code].
5405** ^The sqlite3_finalize(S) routine can be called at any point during
5406** the life cycle of [prepared statement] S:
5407** before statement S is ever evaluated, after
5408** one or more calls to [sqlite3_reset()], or after any call
5409** to [sqlite3_step()] regardless of whether or not the statement has
5410** completed execution.
5412** ^Invoking sqlite3_finalize() on a NULL pointer is a harmless no-op.
5414** The application must finalize every [prepared statement] in order to avoid
5415** resource leaks. It is a grievous error for the application to try to use
5416** a prepared statement after it has been finalized. Any use of a prepared
5417** statement after it has been finalized can result in undefined and
5418** undesirable behavior such as segfaults and heap corruption.
5420SQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt);
5423** CAPI3REF: Reset A Prepared Statement Object
5424** METHOD: sqlite3_stmt
5426** The sqlite3_reset() function is called to reset a [prepared statement]
5427** object back to its initial state, ready to be re-executed.
5428** ^Any SQL statement variables that had values bound to them using
5429** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values.
5430** Use [sqlite3_clear_bindings()] to reset the bindings.
5432** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S
5433** back to the beginning of its program.
5435** ^If the most recent call to [sqlite3_step(S)] for the
5436** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE],
5437** or if [sqlite3_step(S)] has never before been called on S,
5438** then [sqlite3_reset(S)] returns [SQLITE_OK].
5440** ^If the most recent call to [sqlite3_step(S)] for the
5441** [prepared statement] S indicated an error, then
5442** [sqlite3_reset(S)] returns an appropriate [error code].
5444** ^The [sqlite3_reset(S)] interface does not change the values
5445** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S.
5447SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
5450** CAPI3REF: Create Or Redefine SQL Functions
5451** KEYWORDS: {function creation routines}
5452** METHOD: sqlite3
5454** ^These functions (collectively known as "function creation routines")
5455** are used to add SQL functions or aggregates or to redefine the behavior
5456** of existing SQL functions or aggregates. The only differences between
5457** the three "sqlite3_create_function*" routines are the text encoding
5458** expected for the second parameter (the name of the function being
5459** created) and the presence or absence of a destructor callback for
5460** the application data pointer. Function sqlite3_create_window_function()
5461** is similar, but allows the user to supply the extra callback functions
5462** needed by [aggregate window functions].
5464** ^The first parameter is the [database connection] to which the SQL
5465** function is to be added. ^If an application uses more than one database
5466** connection then application-defined SQL functions must be added
5467** to each database connection separately.
5469** ^The second parameter is the name of the SQL function to be created or
5470** redefined. ^The length of the name is limited to 255 bytes in a UTF-8
5471** representation, exclusive of the zero-terminator. ^Note that the name
5472** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes.
5473** ^Any attempt to create a function with a longer name
5474** will result in [SQLITE_MISUSE] being returned.
5476** ^The third parameter (nArg)
5477** is the number of arguments that the SQL function or
5478** aggregate takes. ^If this parameter is -1, then the SQL function or
5479** aggregate may take any number of arguments between 0 and the limit
5480** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third
5481** parameter is less than -1 or greater than 127 then the behavior is
5482** undefined.
5484** ^The fourth parameter, eTextRep, specifies what
5485** [SQLITE_UTF8 | text encoding] this SQL function prefers for
5486** its parameters. The application should set this parameter to
5487** [SQLITE_UTF16LE] if the function implementation invokes
5488** [sqlite3_value_text16le()] on an input, or [SQLITE_UTF16BE] if the
5489** implementation invokes [sqlite3_value_text16be()] on an input, or
5490** [SQLITE_UTF16] if [sqlite3_value_text16()] is used, or [SQLITE_UTF8]
5491** otherwise. ^The same SQL function may be registered multiple times using
5492** different preferred text encodings, with different implementations for
5493** each encoding.
5494** ^When multiple implementations of the same function are available, SQLite
5495** will pick the one that involves the least amount of data conversion.
5497** ^The fourth parameter may optionally be ORed with [SQLITE_DETERMINISTIC]
5498** to signal that the function will always return the same result given
5499** the same inputs within a single SQL statement. Most SQL functions are
5500** deterministic. The built-in [random()] SQL function is an example of a
5501** function that is not deterministic. The SQLite query planner is able to
5502** perform additional optimizations on deterministic functions, so use
5503** of the [SQLITE_DETERMINISTIC] flag is recommended where possible.
5505** ^The fourth parameter may also optionally include the [SQLITE_DIRECTONLY]
5506** flag, which if present prevents the function from being invoked from
5507** within VIEWs, TRIGGERs, CHECK constraints, generated column expressions,
5508** index expressions, or the WHERE clause of partial indexes.
5510** For best security, the [SQLITE_DIRECTONLY] flag is recommended for
5511** all application-defined SQL functions that do not need to be
5512** used inside of triggers, view, CHECK constraints, or other elements of
5513** the database schema. This flags is especially recommended for SQL
5514** functions that have side effects or reveal internal application state.
5515** Without this flag, an attacker might be able to modify the schema of
5516** a database file to include invocations of the function with parameters
5517** chosen by the attacker, which the application will then execute when
5518** the database file is opened and read.
5520** ^(The fifth parameter is an arbitrary pointer. The implementation of the
5521** function can gain access to this pointer using [sqlite3_user_data()].)^
5523** ^The sixth, seventh and eighth parameters passed to the three
5524** "sqlite3_create_function*" functions, xFunc, xStep and xFinal, are
5525** pointers to C-language functions that implement the SQL function or
5526** aggregate. ^A scalar SQL function requires an implementation of the xFunc
5527** callback only; NULL pointers must be passed as the xStep and xFinal
5528** parameters. ^An aggregate SQL function requires an implementation of xStep
5529** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing
5530** SQL function or aggregate, pass NULL pointers for all three function
5531** callbacks.
5533** ^The sixth, seventh, eighth and ninth parameters (xStep, xFinal, xValue
5534** and xInverse) passed to sqlite3_create_window_function are pointers to
5535** C-language callbacks that implement the new function. xStep and xFinal
5536** must both be non-NULL. xValue and xInverse may either both be NULL, in
5537** which case a regular aggregate function is created, or must both be
5538** non-NULL, in which case the new function may be used as either an aggregate
5539** or aggregate window function. More details regarding the implementation
5540** of aggregate window functions are
5541** [user-defined window functions|available here].
5543** ^(If the final parameter to sqlite3_create_function_v2() or
5544** sqlite3_create_window_function() is not NULL, then it is destructor for
5545** the application data pointer. The destructor is invoked when the function
5546** is deleted, either by being overloaded or when the database connection
5547** closes.)^ ^The destructor is also invoked if the call to
5548** sqlite3_create_function_v2() fails. ^When the destructor callback is
5549** invoked, it is passed a single argument which is a copy of the application
5550** data pointer which was the fifth parameter to sqlite3_create_function_v2().
5552** ^It is permitted to register multiple implementations of the same
5553** functions with the same name but with either differing numbers of
5554** arguments or differing preferred text encodings. ^SQLite will use
5555** the implementation that most closely matches the way in which the
5556** SQL function is used. ^A function implementation with a non-negative
5557** nArg parameter is a better match than a function implementation with
5558** a negative nArg. ^A function where the preferred text encoding
5559** matches the database encoding is a better
5560** match than a function where the encoding is different.
5561** ^A function where the encoding difference is between UTF16le and UTF16be
5562** is a closer match than a function where the encoding difference is
5563** between UTF8 and UTF16.
5565** ^Built-in functions may be overloaded by new application-defined functions.
5567** ^An application-defined function is permitted to call other
5568** SQLite interfaces. However, such calls must not
5569** close the database connection nor finalize or reset the prepared
5570** statement in which the function is running.
5572SQLITE_API int sqlite3_create_function(
5573 sqlite3 *db,
5574 const char *zFunctionName,
5575 int nArg,
5576 int eTextRep,
5577 void *pApp,
5578 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
5579 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
5580 void (*xFinal)(sqlite3_context*)
5582SQLITE_API int sqlite3_create_function16(
5583 sqlite3 *db,
5584 const void *zFunctionName,
5585 int nArg,
5586 int eTextRep,
5587 void *pApp,
5588 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
5589 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
5590 void (*xFinal)(sqlite3_context*)
5592SQLITE_API int sqlite3_create_function_v2(
5593 sqlite3 *db,
5594 const char *zFunctionName,
5595 int nArg,
5596 int eTextRep,
5597 void *pApp,
5598 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
5599 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
5600 void (*xFinal)(sqlite3_context*),
5601 void(*xDestroy)(void*)
5603SQLITE_API int sqlite3_create_window_function(
5604 sqlite3 *db,
5605 const char *zFunctionName,
5606 int nArg,
5607 int eTextRep,
5608 void *pApp,
5609 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
5610 void (*xFinal)(sqlite3_context*),
5611 void (*xValue)(sqlite3_context*),
5612 void (*xInverse)(sqlite3_context*,int,sqlite3_value**),
5613 void(*xDestroy)(void*)
5617** CAPI3REF: Text Encodings
5619** These constant define integer codes that represent the various
5620** text encodings supported by SQLite.
5622#define SQLITE_UTF8 1 /* IMP: R-37514-35566 */
5623#define SQLITE_UTF16LE 2 /* IMP: R-03371-37637 */
5624#define SQLITE_UTF16BE 3 /* IMP: R-51971-34154 */
5625#define SQLITE_UTF16 4 /* Use native byte order */
5626#define SQLITE_ANY 5 /* Deprecated */
5627#define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */
5630** CAPI3REF: Function Flags
5632** These constants may be ORed together with the
5633** [SQLITE_UTF8 | preferred text encoding] as the fourth argument
5634** to [sqlite3_create_function()], [sqlite3_create_function16()], or
5635** [sqlite3_create_function_v2()].
5637** <dl>
5639** The SQLITE_DETERMINISTIC flag means that the new function always gives
5640** the same output when the input parameters are the same.
5641** The [abs|abs() function] is deterministic, for example, but
5642** [randomblob|randomblob()] is not. Functions must
5643** be deterministic in order to be used in certain contexts such as
5644** with the WHERE clause of [partial indexes] or in [generated columns].
5645** SQLite might also optimize deterministic functions by factoring them
5646** out of inner loops.
5647** </dd>
5650** The SQLITE_DIRECTONLY flag means that the function may only be invoked
5651** from top-level SQL, and cannot be used in VIEWs or TRIGGERs nor in
5652** schema structures such as [CHECK constraints], [DEFAULT clauses],
5653** [expression indexes], [partial indexes], or [generated columns].
5654** The SQLITE_DIRECTONLY flags is a security feature which is recommended
5655** for all [application-defined SQL functions], and especially for functions
5656** that have side-effects or that could potentially leak sensitive
5657** information.
5658** </dd>
5661** The SQLITE_INNOCUOUS flag means that the function is unlikely
5662** to cause problems even if misused. An innocuous function should have
5663** no side effects and should not depend on any values other than its
5664** input parameters. The [abs|abs() function] is an example of an
5665** innocuous function.
5666** The [load_extension() SQL function] is not innocuous because of its
5667** side effects.
5668** <p> SQLITE_INNOCUOUS is similar to SQLITE_DETERMINISTIC, but is not
5669** exactly the same. The [random|random() function] is an example of a
5670** function that is innocuous but not deterministic.
5671** <p>Some heightened security settings
5672** ([SQLITE_DBCONFIG_TRUSTED_SCHEMA] and [PRAGMA trusted_schema=OFF])
5673** disable the use of SQL functions inside views and triggers and in
5674** schema structures such as [CHECK constraints], [DEFAULT clauses],
5675** [expression indexes], [partial indexes], and [generated columns] unless
5676** the function is tagged with SQLITE_INNOCUOUS. Most built-in functions
5677** are innocuous. Developers are advised to avoid using the
5678** SQLITE_INNOCUOUS flag for application-defined functions unless the
5679** function has been carefully audited and found to be free of potentially
5680** security-adverse side-effects and information-leaks.
5681** </dd>
5683** [[SQLITE_SUBTYPE]] <dt>SQLITE_SUBTYPE</dt><dd>
5684** The SQLITE_SUBTYPE flag indicates to SQLite that a function may call
5685** [sqlite3_value_subtype()] to inspect the sub-types of its arguments.
5686** Specifying this flag makes no difference for scalar or aggregate user
5687** functions. However, if it is not specified for a user-defined window
5688** function, then any sub-types belonging to arguments passed to the window
5689** function may be discarded before the window function is called (i.e.
5690** sqlite3_value_subtype() will always return 0).
5691** </dd>
5692** </dl>
5694#define SQLITE_DETERMINISTIC 0x000000800
5695#define SQLITE_DIRECTONLY 0x000080000
5696#define SQLITE_SUBTYPE 0x000100000
5697#define SQLITE_INNOCUOUS 0x000200000
5700** CAPI3REF: Deprecated Functions
5703** These functions are [deprecated]. In order to maintain
5704** backwards compatibility with older code, these functions continue
5705** to be supported. However, new applications should avoid
5706** the use of these functions. To encourage programmers to avoid
5707** these functions, we will not explain what they do.
5710SQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*);
5711SQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*);
5712SQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*);
5713SQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void);
5714SQLITE_API SQLITE_DEPRECATED void sqlite3_thread_cleanup(void);
5715SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),
5716 void*,sqlite3_int64);
5720** CAPI3REF: Obtaining SQL Values
5721** METHOD: sqlite3_value
5723** <b>Summary:</b>
5724** <blockquote><table border=0 cellpadding=0 cellspacing=0>
5725** <tr><td><b>sqlite3_value_blob</b><td>&rarr;<td>BLOB value
5726** <tr><td><b>sqlite3_value_double</b><td>&rarr;<td>REAL value
5727** <tr><td><b>sqlite3_value_int</b><td>&rarr;<td>32-bit INTEGER value
5728** <tr><td><b>sqlite3_value_int64</b><td>&rarr;<td>64-bit INTEGER value
5729** <tr><td><b>sqlite3_value_pointer</b><td>&rarr;<td>Pointer value
5730** <tr><td><b>sqlite3_value_text</b><td>&rarr;<td>UTF-8 TEXT value
5731** <tr><td><b>sqlite3_value_text16</b><td>&rarr;<td>UTF-16 TEXT value in
5732** the native byteorder
5733** <tr><td><b>sqlite3_value_text16be</b><td>&rarr;<td>UTF-16be TEXT value
5734** <tr><td><b>sqlite3_value_text16le</b><td>&rarr;<td>UTF-16le TEXT value
5735** <tr><td>&nbsp;<td>&nbsp;<td>&nbsp;
5736** <tr><td><b>sqlite3_value_bytes</b><td>&rarr;<td>Size of a BLOB
5737** or a UTF-8 TEXT in bytes
5738** <tr><td><b>sqlite3_value_bytes16&nbsp;&nbsp;</b>
5739** <td>&rarr;&nbsp;&nbsp;<td>Size of UTF-16
5740** TEXT in bytes
5741** <tr><td><b>sqlite3_value_type</b><td>&rarr;<td>Default
5742** datatype of the value
5743** <tr><td><b>sqlite3_value_numeric_type&nbsp;&nbsp;</b>
5744** <td>&rarr;&nbsp;&nbsp;<td>Best numeric datatype of the value
5745** <tr><td><b>sqlite3_value_nochange&nbsp;&nbsp;</b>
5746** <td>&rarr;&nbsp;&nbsp;<td>True if the column is unchanged in an UPDATE
5747** against a virtual table.
5748** <tr><td><b>sqlite3_value_frombind&nbsp;&nbsp;</b>
5749** <td>&rarr;&nbsp;&nbsp;<td>True if value originated from a [bound parameter]
5750** </table></blockquote>
5752** <b>Details:</b>
5754** These routines extract type, size, and content information from
5755** [protected sqlite3_value] objects. Protected sqlite3_value objects
5756** are used to pass parameter information into the functions that
5757** implement [application-defined SQL functions] and [virtual tables].
5759** These routines work only with [protected sqlite3_value] objects.
5760** Any attempt to use these routines on an [unprotected sqlite3_value]
5761** is not threadsafe.
5763** ^These routines work just like the corresponding [column access functions]
5764** except that these routines take a single [protected sqlite3_value] object
5765** pointer instead of a [sqlite3_stmt*] pointer and an integer column number.
5767** ^The sqlite3_value_text16() interface extracts a UTF-16 string
5768** in the native byte-order of the host machine. ^The
5769** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces
5770** extract UTF-16 strings as big-endian and little-endian respectively.
5772** ^If [sqlite3_value] object V was initialized
5773** using [sqlite3_bind_pointer(S,I,P,X,D)] or [sqlite3_result_pointer(C,P,X,D)]
5774** and if X and Y are strings that compare equal according to strcmp(X,Y),
5775** then sqlite3_value_pointer(V,Y) will return the pointer P. ^Otherwise,
5776** sqlite3_value_pointer(V,Y) returns a NULL. The sqlite3_bind_pointer()
5777** routine is part of the [pointer passing interface] added for SQLite 3.20.0.
5779** ^(The sqlite3_value_type(V) interface returns the
5780** [SQLITE_INTEGER | datatype code] for the initial datatype of the
5781** [sqlite3_value] object V. The returned value is one of [SQLITE_INTEGER],
5783** Other interfaces might change the datatype for an sqlite3_value object.
5784** For example, if the datatype is initially SQLITE_INTEGER and
5785** sqlite3_value_text(V) is called to extract a text value for that
5786** integer, then subsequent calls to sqlite3_value_type(V) might return
5787** SQLITE_TEXT. Whether or not a persistent internal datatype conversion
5788** occurs is undefined and may change from one release of SQLite to the next.
5790** ^(The sqlite3_value_numeric_type() interface attempts to apply
5791** numeric affinity to the value. This means that an attempt is
5792** made to convert the value to an integer or floating point. If
5793** such a conversion is possible without loss of information (in other
5794** words, if the value is a string that looks like a number)
5795** then the conversion is performed. Otherwise no conversion occurs.
5796** The [SQLITE_INTEGER | datatype] after conversion is returned.)^
5798** ^Within the [xUpdate] method of a [virtual table], the
5799** sqlite3_value_nochange(X) interface returns true if and only if
5800** the column corresponding to X is unchanged by the UPDATE operation
5801** that the xUpdate method call was invoked to implement and if
5802** and the prior [xColumn] method call that was invoked to extracted
5803** the value for that column returned without setting a result (probably
5804** because it queried [sqlite3_vtab_nochange()] and found that the column
5805** was unchanging). ^Within an [xUpdate] method, any value for which
5806** sqlite3_value_nochange(X) is true will in all other respects appear
5807** to be a NULL value. If sqlite3_value_nochange(X) is invoked anywhere other
5808** than within an [xUpdate] method call for an UPDATE statement, then
5809** the return value is arbitrary and meaningless.
5811** ^The sqlite3_value_frombind(X) interface returns non-zero if the
5812** value X originated from one of the [sqlite3_bind_int|sqlite3_bind()]
5813** interfaces. ^If X comes from an SQL literal value, or a table column,
5814** or an expression, then sqlite3_value_frombind(X) returns zero.
5816** Please pay particular attention to the fact that the pointer returned
5817** from [sqlite3_value_blob()], [sqlite3_value_text()], or
5818** [sqlite3_value_text16()] can be invalidated by a subsequent call to
5819** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()],
5820** or [sqlite3_value_text16()].
5822** These routines must be called from the same thread as
5823** the SQL function that supplied the [sqlite3_value*] parameters.
5825** As long as the input parameter is correct, these routines can only
5826** fail if an out-of-memory error occurs during a format conversion.
5827** Only the following subset of interfaces are subject to out-of-memory
5828** errors:
5830** <ul>
5831** <li> sqlite3_value_blob()
5832** <li> sqlite3_value_text()
5833** <li> sqlite3_value_text16()
5834** <li> sqlite3_value_text16le()
5835** <li> sqlite3_value_text16be()
5836** <li> sqlite3_value_bytes()
5837** <li> sqlite3_value_bytes16()
5838** </ul>
5840** If an out-of-memory error occurs, then the return value from these
5841** routines is the same as if the column had contained an SQL NULL value.
5842** Valid SQL NULL returns can be distinguished from out-of-memory errors
5843** by invoking the [sqlite3_errcode()] immediately after the suspect
5844** return value is obtained and before any
5845** other SQLite interface is called on the same [database connection].
5847SQLITE_API const void *sqlite3_value_blob(sqlite3_value*);
5848SQLITE_API double sqlite3_value_double(sqlite3_value*);
5849SQLITE_API int sqlite3_value_int(sqlite3_value*);
5850SQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value*);
5851SQLITE_API void *sqlite3_value_pointer(sqlite3_value*, const char*);
5852SQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value*);
5853SQLITE_API const void *sqlite3_value_text16(sqlite3_value*);
5854SQLITE_API const void *sqlite3_value_text16le(sqlite3_value*);
5855SQLITE_API const void *sqlite3_value_text16be(sqlite3_value*);
5856SQLITE_API int sqlite3_value_bytes(sqlite3_value*);
5857SQLITE_API int sqlite3_value_bytes16(sqlite3_value*);
5858SQLITE_API int sqlite3_value_type(sqlite3_value*);
5859SQLITE_API int sqlite3_value_numeric_type(sqlite3_value*);
5860SQLITE_API int sqlite3_value_nochange(sqlite3_value*);
5861SQLITE_API int sqlite3_value_frombind(sqlite3_value*);
5864** CAPI3REF: Finding The Subtype Of SQL Values
5865** METHOD: sqlite3_value
5867** The sqlite3_value_subtype(V) function returns the subtype for
5868** an [application-defined SQL function] argument V. The subtype
5869** information can be used to pass a limited amount of context from
5870** one SQL function to another. Use the [sqlite3_result_subtype()]
5871** routine to set the subtype for the return value of an SQL function.
5873SQLITE_API unsigned int sqlite3_value_subtype(sqlite3_value*);
5876** CAPI3REF: Copy And Free SQL Values
5877** METHOD: sqlite3_value
5879** ^The sqlite3_value_dup(V) interface makes a copy of the [sqlite3_value]
5880** object D and returns a pointer to that copy. ^The [sqlite3_value] returned
5881** is a [protected sqlite3_value] object even if the input is not.
5882** ^The sqlite3_value_dup(V) interface returns NULL if V is NULL or if a
5883** memory allocation fails.
5885** ^The sqlite3_value_free(V) interface frees an [sqlite3_value] object
5886** previously obtained from [sqlite3_value_dup()]. ^If V is a NULL pointer
5887** then sqlite3_value_free(V) is a harmless no-op.
5889SQLITE_API sqlite3_value *sqlite3_value_dup(const sqlite3_value*);
5890SQLITE_API void sqlite3_value_free(sqlite3_value*);
5893** CAPI3REF: Obtain Aggregate Function Context
5894** METHOD: sqlite3_context
5896** Implementations of aggregate SQL functions use this
5897** routine to allocate memory for storing their state.
5899** ^The first time the sqlite3_aggregate_context(C,N) routine is called
5900** for a particular aggregate function, SQLite allocates
5901** N bytes of memory, zeroes out that memory, and returns a pointer
5902** to the new memory. ^On second and subsequent calls to
5903** sqlite3_aggregate_context() for the same aggregate function instance,
5904** the same buffer is returned. Sqlite3_aggregate_context() is normally
5905** called once for each invocation of the xStep callback and then one
5906** last time when the xFinal callback is invoked. ^(When no rows match
5907** an aggregate query, the xStep() callback of the aggregate function
5908** implementation is never called and xFinal() is called exactly once.
5909** In those cases, sqlite3_aggregate_context() might be called for the
5910** first time from within xFinal().)^
5912** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer
5913** when first called if N is less than or equal to zero or if a memory
5914** allocate error occurs.
5916** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is
5917** determined by the N parameter on first successful call. Changing the
5918** value of N in any subsequent call to sqlite3_aggregate_context() within
5919** the same aggregate function instance will not resize the memory
5920** allocation.)^ Within the xFinal callback, it is customary to set
5921** N=0 in calls to sqlite3_aggregate_context(C,N) so that no
5922** pointless memory allocations occur.
5924** ^SQLite automatically frees the memory allocated by
5925** sqlite3_aggregate_context() when the aggregate query concludes.
5927** The first parameter must be a copy of the
5928** [sqlite3_context | SQL function context] that is the first parameter
5929** to the xStep or xFinal callback routine that implements the aggregate
5930** function.
5932** This routine must be called from the same thread in which
5933** the aggregate SQL function is running.
5935SQLITE_API void *sqlite3_aggregate_context(sqlite3_context*, int nBytes);
5938** CAPI3REF: User Data For Functions
5939** METHOD: sqlite3_context
5941** ^The sqlite3_user_data() interface returns a copy of
5942** the pointer that was the pUserData parameter (the 5th parameter)
5943** of the [sqlite3_create_function()]
5944** and [sqlite3_create_function16()] routines that originally
5945** registered the application defined function.
5947** This routine must be called from the same thread in which
5948** the application-defined function is running.
5950SQLITE_API void *sqlite3_user_data(sqlite3_context*);
5953** CAPI3REF: Database Connection For Functions
5954** METHOD: sqlite3_context
5956** ^The sqlite3_context_db_handle() interface returns a copy of
5957** the pointer to the [database connection] (the 1st parameter)
5958** of the [sqlite3_create_function()]
5959** and [sqlite3_create_function16()] routines that originally
5960** registered the application defined function.
5962SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_context*);
5965** CAPI3REF: Function Auxiliary Data
5966** METHOD: sqlite3_context
5968** These functions may be used by (non-aggregate) SQL functions to
5969** associate metadata with argument values. If the same value is passed to
5970** multiple invocations of the same SQL function during query execution, under
5971** some circumstances the associated metadata may be preserved. An example
5972** of where this might be useful is in a regular-expression matching
5973** function. The compiled version of the regular expression can be stored as
5974** metadata associated with the pattern string.
5975** Then as long as the pattern string remains the same,
5976** the compiled regular expression can be reused on multiple
5977** invocations of the same function.
5979** ^The sqlite3_get_auxdata(C,N) interface returns a pointer to the metadata
5980** associated by the sqlite3_set_auxdata(C,N,P,X) function with the Nth argument
5981** value to the application-defined function. ^N is zero for the left-most
5982** function argument. ^If there is no metadata
5983** associated with the function argument, the sqlite3_get_auxdata(C,N) interface
5984** returns a NULL pointer.
5986** ^The sqlite3_set_auxdata(C,N,P,X) interface saves P as metadata for the N-th
5987** argument of the application-defined function. ^Subsequent
5988** calls to sqlite3_get_auxdata(C,N) return P from the most recent
5989** sqlite3_set_auxdata(C,N,P,X) call if the metadata is still valid or
5990** NULL if the metadata has been discarded.
5991** ^After each call to sqlite3_set_auxdata(C,N,P,X) where X is not NULL,
5992** SQLite will invoke the destructor function X with parameter P exactly
5993** once, when the metadata is discarded.
5994** SQLite is free to discard the metadata at any time, including: <ul>
5995** <li> ^(when the corresponding function parameter changes)^, or
5996** <li> ^(when [sqlite3_reset()] or [sqlite3_finalize()] is called for the
5997** SQL statement)^, or
5998** <li> ^(when sqlite3_set_auxdata() is invoked again on the same
5999** parameter)^, or
6000** <li> ^(during the original sqlite3_set_auxdata() call when a memory
6001** allocation error occurs.)^ </ul>
6003** Note the last bullet in particular. The destructor X in
6004** sqlite3_set_auxdata(C,N,P,X) might be called immediately, before the
6005** sqlite3_set_auxdata() interface even returns. Hence sqlite3_set_auxdata()
6006** should be called near the end of the function implementation and the
6007** function implementation should not make any use of P after
6008** sqlite3_set_auxdata() has been called.
6010** ^(In practice, metadata is preserved between function calls for
6011** function parameters that are compile-time constants, including literal
6012** values and [parameters] and expressions composed from the same.)^
6014** The value of the N parameter to these interfaces should be non-negative.
6015** Future enhancements may make use of negative N values to define new
6016** kinds of function caching behavior.
6018** These routines must be called from the same thread in which
6019** the SQL function is running.
6021SQLITE_API void *sqlite3_get_auxdata(sqlite3_context*, int N);
6022SQLITE_API void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*));
6026** CAPI3REF: Constants Defining Special Destructor Behavior
6028** These are special values for the destructor that is passed in as the
6029** final argument to routines like [sqlite3_result_blob()]. ^If the destructor
6030** argument is SQLITE_STATIC, it means that the content pointer is constant
6031** and will never change. It does not need to be destroyed. ^The
6032** SQLITE_TRANSIENT value means that the content will likely change in
6033** the near future and that SQLite should make its own private copy of
6034** the content before returning.
6036** The typedef is necessary to work around problems in certain
6037** C++ compilers.
6039typedef void (*sqlite3_destructor_type)(void*);
6040#define SQLITE_STATIC ((sqlite3_destructor_type)0)
6041#define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1)
6044** CAPI3REF: Setting The Result Of An SQL Function
6045** METHOD: sqlite3_context
6047** These routines are used by the xFunc or xFinal callbacks that
6048** implement SQL functions and aggregates. See
6049** [sqlite3_create_function()] and [sqlite3_create_function16()]
6050** for additional information.
6052** These functions work very much like the [parameter binding] family of
6053** functions used to bind values to host parameters in prepared statements.
6054** Refer to the [SQL parameter] documentation for additional information.
6056** ^The sqlite3_result_blob() interface sets the result from
6057** an application-defined function to be the BLOB whose content is pointed
6058** to by the second parameter and which is N bytes long where N is the
6059** third parameter.
6061** ^The sqlite3_result_zeroblob(C,N) and sqlite3_result_zeroblob64(C,N)
6062** interfaces set the result of the application-defined function to be
6063** a BLOB containing all zero bytes and N bytes in size.
6065** ^The sqlite3_result_double() interface sets the result from
6066** an application-defined function to be a floating point value specified
6067** by its 2nd argument.
6069** ^The sqlite3_result_error() and sqlite3_result_error16() functions
6070** cause the implemented SQL function to throw an exception.
6071** ^SQLite uses the string pointed to by the
6072** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16()
6073** as the text of an error message. ^SQLite interprets the error
6074** message string from sqlite3_result_error() as UTF-8. ^SQLite
6075** interprets the string from sqlite3_result_error16() as UTF-16 using
6076** the same [byte-order determination rules] as [sqlite3_bind_text16()].
6077** ^If the third parameter to sqlite3_result_error()
6078** or sqlite3_result_error16() is negative then SQLite takes as the error
6079** message all text up through the first zero character.
6080** ^If the third parameter to sqlite3_result_error() or
6081** sqlite3_result_error16() is non-negative then SQLite takes that many
6082** bytes (not characters) from the 2nd parameter as the error message.
6083** ^The sqlite3_result_error() and sqlite3_result_error16()
6084** routines make a private copy of the error message text before
6085** they return. Hence, the calling function can deallocate or
6086** modify the text after they return without harm.
6087** ^The sqlite3_result_error_code() function changes the error code
6088** returned by SQLite as a result of an error in a function. ^By default,
6089** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error()
6090** or sqlite3_result_error16() resets the error code to SQLITE_ERROR.
6092** ^The sqlite3_result_error_toobig() interface causes SQLite to throw an
6093** error indicating that a string or BLOB is too long to represent.
6095** ^The sqlite3_result_error_nomem() interface causes SQLite to throw an
6096** error indicating that a memory allocation failed.
6098** ^The sqlite3_result_int() interface sets the return value
6099** of the application-defined function to be the 32-bit signed integer
6100** value given in the 2nd argument.
6101** ^The sqlite3_result_int64() interface sets the return value
6102** of the application-defined function to be the 64-bit signed integer
6103** value given in the 2nd argument.
6105** ^The sqlite3_result_null() interface sets the return value
6106** of the application-defined function to be NULL.
6108** ^The sqlite3_result_text(), sqlite3_result_text16(),
6109** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces
6110** set the return value of the application-defined function to be
6111** a text string which is represented as UTF-8, UTF-16 native byte order,
6112** UTF-16 little endian, or UTF-16 big endian, respectively.
6113** ^The sqlite3_result_text64() interface sets the return value of an
6114** application-defined function to be a text string in an encoding
6115** specified by the fifth (and last) parameter, which must be one
6117** ^SQLite takes the text result from the application from
6118** the 2nd parameter of the sqlite3_result_text* interfaces.
6119** ^If the 3rd parameter to the sqlite3_result_text* interfaces
6120** is negative, then SQLite takes result text from the 2nd parameter
6121** through the first zero character.
6122** ^If the 3rd parameter to the sqlite3_result_text* interfaces
6123** is non-negative, then as many bytes (not characters) of the text
6124** pointed to by the 2nd parameter are taken as the application-defined
6125** function result. If the 3rd parameter is non-negative, then it
6126** must be the byte offset into the string where the NUL terminator would
6127** appear if the string where NUL terminated. If any NUL characters occur
6128** in the string at a byte offset that is less than the value of the 3rd
6129** parameter, then the resulting string will contain embedded NULs and the
6130** result of expressions operating on strings with embedded NULs is undefined.
6131** ^If the 4th parameter to the sqlite3_result_text* interfaces
6132** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that
6133** function as the destructor on the text or BLOB result when it has
6134** finished using that result.
6135** ^If the 4th parameter to the sqlite3_result_text* interfaces or to
6136** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite
6137** assumes that the text or BLOB result is in constant space and does not
6138** copy the content of the parameter nor call a destructor on the content
6139** when it has finished using that result.
6140** ^If the 4th parameter to the sqlite3_result_text* interfaces
6141** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT
6142** then SQLite makes a copy of the result into space obtained
6143** from [sqlite3_malloc()] before it returns.
6145** ^For the sqlite3_result_text16(), sqlite3_result_text16le(), and
6146** sqlite3_result_text16be() routines, and for sqlite3_result_text64()
6147** when the encoding is not UTF8, if the input UTF16 begins with a
6148** byte-order mark (BOM, U+FEFF) then the BOM is removed from the
6149** string and the rest of the string is interpreted according to the
6150** byte-order specified by the BOM. ^The byte-order specified by
6151** the BOM at the beginning of the text overrides the byte-order
6152** specified by the interface procedure. ^So, for example, if
6153** sqlite3_result_text16le() is invoked with text that begins
6154** with bytes 0xfe, 0xff (a big-endian byte-order mark) then the
6155** first two bytes of input are skipped and the remaining input
6156** is interpreted as UTF16BE text.
6158** ^For UTF16 input text to the sqlite3_result_text16(),
6159** sqlite3_result_text16be(), sqlite3_result_text16le(), and
6160** sqlite3_result_text64() routines, if the text contains invalid
6161** UTF16 characters, the invalid characters might be converted
6162** into the unicode replacement character, U+FFFD.
6164** ^The sqlite3_result_value() interface sets the result of
6165** the application-defined function to be a copy of the
6166** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The
6167** sqlite3_result_value() interface makes a copy of the [sqlite3_value]
6168** so that the [sqlite3_value] specified in the parameter may change or
6169** be deallocated after sqlite3_result_value() returns without harm.
6170** ^A [protected sqlite3_value] object may always be used where an
6171** [unprotected sqlite3_value] object is required, so either
6172** kind of [sqlite3_value] object can be used with this interface.
6174** ^The sqlite3_result_pointer(C,P,T,D) interface sets the result to an
6175** SQL NULL value, just like [sqlite3_result_null(C)], except that it
6176** also associates the host-language pointer P or type T with that
6177** NULL value such that the pointer can be retrieved within an
6178** [application-defined SQL function] using [sqlite3_value_pointer()].
6179** ^If the D parameter is not NULL, then it is a pointer to a destructor
6180** for the P parameter. ^SQLite invokes D with P as its only argument
6181** when SQLite is finished with P. The T parameter should be a static
6182** string and preferably a string literal. The sqlite3_result_pointer()
6183** routine is part of the [pointer passing interface] added for SQLite 3.20.0.
6185** If these routines are called from within the different thread
6186** than the one containing the application-defined function that received
6187** the [sqlite3_context] pointer, the results are undefined.
6189SQLITE_API void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*));
6190SQLITE_API void sqlite3_result_blob64(sqlite3_context*,const void*,
6191 sqlite3_uint64,void(*)(void*));
6192SQLITE_API void sqlite3_result_double(sqlite3_context*, double);
6193SQLITE_API void sqlite3_result_error(sqlite3_context*, const char*, int);
6194SQLITE_API void sqlite3_result_error16(sqlite3_context*, const void*, int);
6195SQLITE_API void sqlite3_result_error_toobig(sqlite3_context*);
6196SQLITE_API void sqlite3_result_error_nomem(sqlite3_context*);
6197SQLITE_API void sqlite3_result_error_code(sqlite3_context*, int);
6198SQLITE_API void sqlite3_result_int(sqlite3_context*, int);
6199SQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64);
6200SQLITE_API void sqlite3_result_null(sqlite3_context*);
6201SQLITE_API void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*));
6202SQLITE_API void sqlite3_result_text64(sqlite3_context*, const char*,sqlite3_uint64,
6203 void(*)(void*), unsigned char encoding);
6204SQLITE_API void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*));
6205SQLITE_API void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*));
6206SQLITE_API void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*));
6207SQLITE_API void sqlite3_result_value(sqlite3_context*, sqlite3_value*);
6208SQLITE_API void sqlite3_result_pointer(sqlite3_context*, void*,const char*,void(*)(void*));
6209SQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n);
6210SQLITE_API int sqlite3_result_zeroblob64(sqlite3_context*, sqlite3_uint64 n);
6214** CAPI3REF: Setting The Subtype Of An SQL Function
6215** METHOD: sqlite3_context
6217** The sqlite3_result_subtype(C,T) function causes the subtype of
6218** the result from the [application-defined SQL function] with
6219** [sqlite3_context] C to be the value T. Only the lower 8 bits
6220** of the subtype T are preserved in current versions of SQLite;
6221** higher order bits are discarded.
6222** The number of subtype bytes preserved by SQLite might increase
6223** in future releases of SQLite.
6225SQLITE_API void sqlite3_result_subtype(sqlite3_context*,unsigned int);
6228** CAPI3REF: Define New Collating Sequences
6229** METHOD: sqlite3
6231** ^These functions add, remove, or modify a [collation] associated
6232** with the [database connection] specified as the first argument.
6234** ^The name of the collation is a UTF-8 string
6235** for sqlite3_create_collation() and sqlite3_create_collation_v2()
6236** and a UTF-16 string in native byte order for sqlite3_create_collation16().
6237** ^Collation names that compare equal according to [sqlite3_strnicmp()] are
6238** considered to be the same name.
6240** ^(The third argument (eTextRep) must be one of the constants:
6241** <ul>
6242** <li> [SQLITE_UTF8],
6243** <li> [SQLITE_UTF16LE],
6244** <li> [SQLITE_UTF16BE],
6245** <li> [SQLITE_UTF16], or
6246** <li> [SQLITE_UTF16_ALIGNED].
6247** </ul>)^
6248** ^The eTextRep argument determines the encoding of strings passed
6249** to the collating function callback, xCompare.
6250** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep
6251** force strings to be UTF16 with native byte order.
6252** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin
6253** on an even byte address.
6255** ^The fourth argument, pArg, is an application data pointer that is passed
6256** through as the first argument to the collating function callback.
6258** ^The fifth argument, xCompare, is a pointer to the collating function.
6259** ^Multiple collating functions can be registered using the same name but
6260** with different eTextRep parameters and SQLite will use whichever
6261** function requires the least amount of data transformation.
6262** ^If the xCompare argument is NULL then the collating function is
6263** deleted. ^When all collating functions having the same name are deleted,
6264** that collation is no longer usable.
6266** ^The collating function callback is invoked with a copy of the pArg
6267** application data pointer and with two strings in the encoding specified
6268** by the eTextRep argument. The two integer parameters to the collating
6269** function callback are the length of the two strings, in bytes. The collating
6270** function must return an integer that is negative, zero, or positive
6271** if the first string is less than, equal to, or greater than the second,
6272** respectively. A collating function must always return the same answer
6273** given the same inputs. If two or more collating functions are registered
6274** to the same collation name (using different eTextRep values) then all
6275** must give an equivalent answer when invoked with equivalent strings.
6276** The collating function must obey the following properties for all
6277** strings A, B, and C:
6279** <ol>
6280** <li> If A==B then B==A.
6281** <li> If A==B and B==C then A==C.
6282** <li> If A&lt;B THEN B&gt;A.
6283** <li> If A&lt;B and B&lt;C then A&lt;C.
6284** </ol>
6286** If a collating function fails any of the above constraints and that
6287** collating function is registered and used, then the behavior of SQLite
6288** is undefined.
6290** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation()
6291** with the addition that the xDestroy callback is invoked on pArg when
6292** the collating function is deleted.
6293** ^Collating functions are deleted when they are overridden by later
6294** calls to the collation creation functions or when the
6295** [database connection] is closed using [sqlite3_close()].
6297** ^The xDestroy callback is <u>not</u> called if the
6298** sqlite3_create_collation_v2() function fails. Applications that invoke
6299** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should
6300** check the return code and dispose of the application data pointer
6301** themselves rather than expecting SQLite to deal with it for them.
6302** This is different from every other SQLite interface. The inconsistency
6303** is unfortunate but cannot be changed without breaking backwards
6304** compatibility.
6306** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()].
6308SQLITE_API int sqlite3_create_collation(
6309 sqlite3*,
6310 const char *zName,
6311 int eTextRep,
6312 void *pArg,
6313 int(*xCompare)(void*,int,const void*,int,const void*)
6315SQLITE_API int sqlite3_create_collation_v2(
6316 sqlite3*,
6317 const char *zName,
6318 int eTextRep,
6319 void *pArg,
6320 int(*xCompare)(void*,int,const void*,int,const void*),
6321 void(*xDestroy)(void*)
6323SQLITE_API int sqlite3_create_collation16(
6324 sqlite3*,
6325 const void *zName,
6326 int eTextRep,
6327 void *pArg,
6328 int(*xCompare)(void*,int,const void*,int,const void*)
6332** CAPI3REF: Collation Needed Callbacks
6333** METHOD: sqlite3
6335** ^To avoid having to register all collation sequences before a database
6336** can be used, a single callback function may be registered with the
6337** [database connection] to be invoked whenever an undefined collation
6338** sequence is required.
6340** ^If the function is registered using the sqlite3_collation_needed() API,
6341** then it is passed the names of undefined collation sequences as strings
6342** encoded in UTF-8. ^If sqlite3_collation_needed16() is used,
6343** the names are passed as UTF-16 in machine native byte order.
6344** ^A call to either function replaces the existing collation-needed callback.
6346** ^(When the callback is invoked, the first argument passed is a copy
6347** of the second argument to sqlite3_collation_needed() or
6348** sqlite3_collation_needed16(). The second argument is the database
6349** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE],
6350** or [SQLITE_UTF16LE], indicating the most desirable form of the collation
6351** sequence function required. The fourth parameter is the name of the
6352** required collation sequence.)^
6354** The callback function should register the desired collation using
6355** [sqlite3_create_collation()], [sqlite3_create_collation16()], or
6356** [sqlite3_create_collation_v2()].
6358SQLITE_API int sqlite3_collation_needed(
6359 sqlite3*,
6360 void*,
6361 void(*)(void*,sqlite3*,int eTextRep,const char*)
6363SQLITE_API int sqlite3_collation_needed16(
6364 sqlite3*,
6365 void*,
6366 void(*)(void*,sqlite3*,int eTextRep,const void*)
6371** Specify the activation key for a CEROD database. Unless
6372** activated, none of the CEROD routines will work.
6374SQLITE_API void sqlite3_activate_cerod(
6375 const char *zPassPhrase /* Activation phrase */
6380** CAPI3REF: Suspend Execution For A Short Time
6382** The sqlite3_sleep() function causes the current thread to suspend execution
6383** for at least a number of milliseconds specified in its parameter.
6385** If the operating system does not support sleep requests with
6386** millisecond time resolution, then the time will be rounded up to
6387** the nearest second. The number of milliseconds of sleep actually
6388** requested from the operating system is returned.
6390** ^SQLite implements this interface by calling the xSleep()
6391** method of the default [sqlite3_vfs] object. If the xSleep() method
6392** of the default VFS is not implemented correctly, or not implemented at
6393** all, then the behavior of sqlite3_sleep() may deviate from the description
6394** in the previous paragraphs.
6396SQLITE_API int sqlite3_sleep(int);
6399** CAPI3REF: Name Of The Folder Holding Temporary Files
6401** ^(If this global variable is made to point to a string which is
6402** the name of a folder (a.k.a. directory), then all temporary files
6403** created by SQLite when using a built-in [sqlite3_vfs | VFS]
6404** will be placed in that directory.)^ ^If this variable
6405** is a NULL pointer, then SQLite performs a search for an appropriate
6406** temporary file directory.
6408** Applications are strongly discouraged from using this global variable.
6409** It is required to set a temporary folder on Windows Runtime (WinRT).
6410** But for all other platforms, it is highly recommended that applications
6411** neither read nor write this variable. This global variable is a relic
6412** that exists for backwards compatibility of legacy applications and should
6413** be avoided in new projects.
6415** It is not safe to read or modify this variable in more than one
6416** thread at a time. It is not safe to read or modify this variable
6417** if a [database connection] is being used at the same time in a separate
6418** thread.
6419** It is intended that this variable be set once
6420** as part of process initialization and before any SQLite interface
6421** routines have been called and that this variable remain unchanged
6422** thereafter.
6424** ^The [temp_store_directory pragma] may modify this variable and cause
6425** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
6426** the [temp_store_directory pragma] always assumes that any string
6427** that this variable points to is held in memory obtained from
6428** [sqlite3_malloc] and the pragma may attempt to free that memory
6429** using [sqlite3_free].
6430** Hence, if this variable is modified directly, either it should be
6431** made NULL or made to point to memory obtained from [sqlite3_malloc]
6432** or else the use of the [temp_store_directory pragma] should be avoided.
6433** Except when requested by the [temp_store_directory pragma], SQLite
6434** does not free the memory that sqlite3_temp_directory points to. If
6435** the application wants that memory to be freed, it must do
6436** so itself, taking care to only do so after all [database connection]
6437** objects have been destroyed.
6439** <b>Note to Windows Runtime users:</b> The temporary directory must be set
6440** prior to calling [sqlite3_open] or [sqlite3_open_v2]. Otherwise, various
6441** features that require the use of temporary files may fail. Here is an
6442** example of how to do this using C++ with the Windows Runtime:
6444** <blockquote><pre>
6445** LPCWSTR zPath = Windows::Storage::ApplicationData::Current->
6446** &nbsp; TemporaryFolder->Path->Data();
6447** char zPathBuf&#91;MAX_PATH + 1&#93;;
6448** memset(zPathBuf, 0, sizeof(zPathBuf));
6449** WideCharToMultiByte(CP_UTF8, 0, zPath, -1, zPathBuf, sizeof(zPathBuf),
6450** &nbsp; NULL, NULL);
6451** sqlite3_temp_directory = sqlite3_mprintf("%s", zPathBuf);
6452** </pre></blockquote>
6454SQLITE_API char *sqlite3_temp_directory;
6457** CAPI3REF: Name Of The Folder Holding Database Files
6459** ^(If this global variable is made to point to a string which is
6460** the name of a folder (a.k.a. directory), then all database files
6461** specified with a relative pathname and created or accessed by
6462** SQLite when using a built-in windows [sqlite3_vfs | VFS] will be assumed
6463** to be relative to that directory.)^ ^If this variable is a NULL
6464** pointer, then SQLite assumes that all database files specified
6465** with a relative pathname are relative to the current directory
6466** for the process. Only the windows VFS makes use of this global
6467** variable; it is ignored by the unix VFS.
6469** Changing the value of this variable while a database connection is
6470** open can result in a corrupt database.
6472** It is not safe to read or modify this variable in more than one
6473** thread at a time. It is not safe to read or modify this variable
6474** if a [database connection] is being used at the same time in a separate
6475** thread.
6476** It is intended that this variable be set once
6477** as part of process initialization and before any SQLite interface
6478** routines have been called and that this variable remain unchanged
6479** thereafter.
6481** ^The [data_store_directory pragma] may modify this variable and cause
6482** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
6483** the [data_store_directory pragma] always assumes that any string
6484** that this variable points to is held in memory obtained from
6485** [sqlite3_malloc] and the pragma may attempt to free that memory
6486** using [sqlite3_free].
6487** Hence, if this variable is modified directly, either it should be
6488** made NULL or made to point to memory obtained from [sqlite3_malloc]
6489** or else the use of the [data_store_directory pragma] should be avoided.
6491SQLITE_API char *sqlite3_data_directory;
6494** CAPI3REF: Win32 Specific Interface
6496** These interfaces are available only on Windows. The
6497** [sqlite3_win32_set_directory] interface is used to set the value associated
6498** with the [sqlite3_temp_directory] or [sqlite3_data_directory] variable, to
6499** zValue, depending on the value of the type parameter. The zValue parameter
6500** should be NULL to cause the previous value to be freed via [sqlite3_free];
6501** a non-NULL value will be copied into memory obtained from [sqlite3_malloc]
6502** prior to being used. The [sqlite3_win32_set_directory] interface returns
6503** [SQLITE_OK] to indicate success, [SQLITE_ERROR] if the type is unsupported,
6504** or [SQLITE_NOMEM] if memory could not be allocated. The value of the
6505** [sqlite3_data_directory] variable is intended to act as a replacement for
6506** the current directory on the sub-platforms of Win32 where that concept is
6507** not present, e.g. WinRT and UWP. The [sqlite3_win32_set_directory8] and
6508** [sqlite3_win32_set_directory16] interfaces behave exactly the same as the
6509** sqlite3_win32_set_directory interface except the string parameter must be
6510** UTF-8 or UTF-16, respectively.
6512SQLITE_API int sqlite3_win32_set_directory(
6513 unsigned long type, /* Identifier for directory being set or reset */
6514 void *zValue /* New value for directory being set or reset */
6516SQLITE_API int sqlite3_win32_set_directory8(unsigned long type, const char *zValue);
6517SQLITE_API int sqlite3_win32_set_directory16(unsigned long type, const void *zValue);
6520** CAPI3REF: Win32 Directory Types
6522** These macros are only available on Windows. They define the allowed values
6523** for the type argument to the [sqlite3_win32_set_directory] interface.
6529** CAPI3REF: Test For Auto-Commit Mode
6530** KEYWORDS: {autocommit mode}
6531** METHOD: sqlite3
6533** ^The sqlite3_get_autocommit() interface returns non-zero or
6534** zero if the given database connection is or is not in autocommit mode,
6535** respectively. ^Autocommit mode is on by default.
6536** ^Autocommit mode is disabled by a [BEGIN] statement.
6537** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK].
6539** If certain kinds of errors occur on a statement within a multi-statement
6540** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR],
6542** transaction might be rolled back automatically. The only way to
6543** find out whether SQLite automatically rolled back the transaction after
6544** an error is to use this function.
6546** If another thread changes the autocommit status of the database
6547** connection while this routine is running, then the return value
6548** is undefined.
6550SQLITE_API int sqlite3_get_autocommit(sqlite3*);
6553** CAPI3REF: Find The Database Handle Of A Prepared Statement
6554** METHOD: sqlite3_stmt
6556** ^The sqlite3_db_handle interface returns the [database connection] handle
6557** to which a [prepared statement] belongs. ^The [database connection]
6558** returned by sqlite3_db_handle is the same [database connection]
6559** that was the first argument
6560** to the [sqlite3_prepare_v2()] call (or its variants) that was used to
6561** create the statement in the first place.
6563SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*);
6566** CAPI3REF: Return The Filename For A Database Connection
6567** METHOD: sqlite3
6569** ^The sqlite3_db_filename(D,N) interface returns a pointer to the filename
6570** associated with database N of connection D.
6571** ^If there is no attached database N on the database
6572** connection D, or if database N is a temporary or in-memory database, then
6573** this function will return either a NULL pointer or an empty string.
6575** ^The string value returned by this routine is owned and managed by
6576** the database connection. ^The value will be valid until the database N
6577** is [DETACH]-ed or until the database connection closes.
6579** ^The filename returned by this function is the output of the
6580** xFullPathname method of the [VFS]. ^In other words, the filename
6581** will be an absolute pathname, even if the filename used
6582** to open the database originally was a URI or relative pathname.
6584** If the filename pointer returned by this routine is not NULL, then it
6585** can be used as the filename input parameter to these routines:
6586** <ul>
6587** <li> [sqlite3_uri_parameter()]
6588** <li> [sqlite3_uri_boolean()]
6589** <li> [sqlite3_uri_int64()]
6590** <li> [sqlite3_filename_database()]
6591** <li> [sqlite3_filename_journal()]
6592** <li> [sqlite3_filename_wal()]
6593** </ul>
6595SQLITE_API const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName);
6598** CAPI3REF: Determine if a database is read-only
6599** METHOD: sqlite3
6601** ^The sqlite3_db_readonly(D,N) interface returns 1 if the database N
6602** of connection D is read-only, 0 if it is read/write, or -1 if N is not
6603** the name of a database on connection D.
6605SQLITE_API int sqlite3_db_readonly(sqlite3 *db, const char *zDbName);
6608** CAPI3REF: Determine the transaction state of a database
6609** METHOD: sqlite3
6611** ^The sqlite3_txn_state(D,S) interface returns the current
6612** [transaction state] of schema S in database connection D. ^If S is NULL,
6613** then the highest transaction state of any schema on database connection D
6614** is returned. Transaction states are (in order of lowest to highest):
6615** <ol>
6616** <li value="0"> SQLITE_TXN_NONE
6617** <li value="1"> SQLITE_TXN_READ
6618** <li value="2"> SQLITE_TXN_WRITE
6619** </ol>
6620** ^If the S argument to sqlite3_txn_state(D,S) is not the name of
6621** a valid schema, then -1 is returned.
6623SQLITE_API int sqlite3_txn_state(sqlite3*,const char *zSchema);
6626** CAPI3REF: Allowed return values from [sqlite3_txn_state()]
6627** KEYWORDS: {transaction state}
6629** These constants define the current transaction state of a database file.
6630** ^The [sqlite3_txn_state(D,S)] interface returns one of these
6631** constants in order to describe the transaction state of schema S
6632** in [database connection] D.
6634** <dl>
6636** <dd>The SQLITE_TXN_NONE state means that no transaction is currently
6637** pending.</dd>
6640** <dd>The SQLITE_TXN_READ state means that the database is currently
6641** in a read transaction. Content has been read from the database file
6642** but nothing in the database file has changed. The transaction state
6643** will advanced to SQLITE_TXN_WRITE if any changes occur and there are
6644** no other conflicting concurrent write transactions. The transaction
6645** state will revert to SQLITE_TXN_NONE following a [ROLLBACK] or
6646** [COMMIT].</dd>
6649** <dd>The SQLITE_TXN_WRITE state means that the database is currently
6650** in a write transaction. Content has been written to the database file
6651** but has not yet committed. The transaction state will change to
6652** to SQLITE_TXN_NONE at the next [ROLLBACK] or [COMMIT].</dd>
6654#define SQLITE_TXN_NONE 0
6655#define SQLITE_TXN_READ 1
6656#define SQLITE_TXN_WRITE 2
6659** CAPI3REF: Find the next prepared statement
6660** METHOD: sqlite3
6662** ^This interface returns a pointer to the next [prepared statement] after
6663** pStmt associated with the [database connection] pDb. ^If pStmt is NULL
6664** then this interface returns a pointer to the first prepared statement
6665** associated with the database connection pDb. ^If no prepared statement
6666** satisfies the conditions of this routine, it returns NULL.
6668** The [database connection] pointer D in a call to
6669** [sqlite3_next_stmt(D,S)] must refer to an open database
6670** connection and in particular must not be a NULL pointer.
6672SQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt);
6675** CAPI3REF: Commit And Rollback Notification Callbacks
6676** METHOD: sqlite3
6678** ^The sqlite3_commit_hook() interface registers a callback
6679** function to be invoked whenever a transaction is [COMMIT | committed].
6680** ^Any callback set by a previous call to sqlite3_commit_hook()
6681** for the same database connection is overridden.
6682** ^The sqlite3_rollback_hook() interface registers a callback
6683** function to be invoked whenever a transaction is [ROLLBACK | rolled back].
6684** ^Any callback set by a previous call to sqlite3_rollback_hook()
6685** for the same database connection is overridden.
6686** ^The pArg argument is passed through to the callback.
6687** ^If the callback on a commit hook function returns non-zero,
6688** then the commit is converted into a rollback.
6690** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions
6691** return the P argument from the previous call of the same function
6692** on the same [database connection] D, or NULL for
6693** the first call for each function on D.
6695** The commit and rollback hook callbacks are not reentrant.
6696** The callback implementation must not do anything that will modify
6697** the database connection that invoked the callback. Any actions
6698** to modify the database connection must be deferred until after the
6699** completion of the [sqlite3_step()] call that triggered the commit
6700** or rollback hook in the first place.
6701** Note that running any other SQL statements, including SELECT statements,
6702** or merely calling [sqlite3_prepare_v2()] and [sqlite3_step()] will modify
6703** the database connections for the meaning of "modify" in this paragraph.
6705** ^Registering a NULL function disables the callback.
6707** ^When the commit hook callback routine returns zero, the [COMMIT]
6708** operation is allowed to continue normally. ^If the commit hook
6709** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK].
6710** ^The rollback hook is invoked on a rollback that results from a commit
6711** hook returning non-zero, just as it would be with any other rollback.
6713** ^For the purposes of this API, a transaction is said to have been
6714** rolled back if an explicit "ROLLBACK" statement is executed, or
6715** an error or constraint causes an implicit rollback to occur.
6716** ^The rollback callback is not invoked if a transaction is
6717** automatically rolled back because the database connection is closed.
6719** See also the [sqlite3_update_hook()] interface.
6721SQLITE_API void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
6722SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);
6725** CAPI3REF: Autovacuum Compaction Amount Callback
6726** METHOD: sqlite3
6728** ^The sqlite3_autovacuum_pages(D,C,P,X) interface registers a callback
6729** function C that is invoked prior to each autovacuum of the database
6730** file. ^The callback is passed a copy of the generic data pointer (P),
6731** the schema-name of the attached database that is being autovacuumed,
6732** the the size of the database file in pages, the number of free pages,
6733** and the number of bytes per page, respectively. The callback should
6734** return the number of free pages that should be removed by the
6735** autovacuum. ^If the callback returns zero, then no autovacuum happens.
6736** ^If the value returned is greater than or equal to the number of
6737** free pages, then a complete autovacuum happens.
6739** <p>^If there are multiple ATTACH-ed database files that are being
6740** modified as part of a transaction commit, then the autovacuum pages
6741** callback is invoked separately for each file.
6743** <p><b>The callback is not reentrant.</b> The callback function should
6744** not attempt to invoke any other SQLite interface. If it does, bad
6745** things may happen, including segmentation faults and corrupt database
6746** files. The callback function should be a simple function that
6747** does some arithmetic on its input parameters and returns a result.
6749** ^The X parameter to sqlite3_autovacuum_pages(D,C,P,X) is an optional
6750** destructor for the P parameter. ^If X is not NULL, then X(P) is
6751** invoked whenever the database connection closes or when the callback
6752** is overwritten by another invocation of sqlite3_autovacuum_pages().
6754** <p>^There is only one autovacuum pages callback per database connection.
6755** ^Each call to the sqlite3_autovacuum_pages() interface overrides all
6756** previous invocations for that database connection. ^If the callback
6757** argument (C) to sqlite3_autovacuum_pages(D,C,P,X) is a NULL pointer,
6758** then the autovacuum steps callback is cancelled. The return value
6759** from sqlite3_autovacuum_pages() is normally SQLITE_OK, but might
6760** be some other error code if something goes wrong. The current
6761** implementation will only return SQLITE_OK or SQLITE_MISUSE, but other
6762** return codes might be added in future releases.
6764** <p>If no autovacuum pages callback is specified (the usual case) or
6765** a NULL pointer is provided for the callback,
6766** then the default behavior is to vacuum all free pages. So, in other
6767** words, the default behavior is the same as if the callback function
6768** were something like this:
6770** <blockquote><pre>
6771** &nbsp; unsigned int demonstration_autovac_pages_callback(
6772** &nbsp; void *pClientData,
6773** &nbsp; const char *zSchema,
6774** &nbsp; unsigned int nDbPage,
6775** &nbsp; unsigned int nFreePage,
6776** &nbsp; unsigned int nBytePerPage
6777** &nbsp; ){
6778** &nbsp; return nFreePage;
6779** &nbsp; }
6780** </pre></blockquote>
6782SQLITE_API int sqlite3_autovacuum_pages(
6783 sqlite3 *db,
6784 unsigned int(*)(void*,const char*,unsigned int,unsigned int,unsigned int),
6785 void*,
6786 void(*)(void*)
6791** CAPI3REF: Data Change Notification Callbacks
6792** METHOD: sqlite3
6794** ^The sqlite3_update_hook() interface registers a callback function
6795** with the [database connection] identified by the first argument
6796** to be invoked whenever a row is updated, inserted or deleted in
6797** a [rowid table].
6798** ^Any callback set by a previous call to this function
6799** for the same database connection is overridden.
6801** ^The second argument is a pointer to the function to invoke when a
6802** row is updated, inserted or deleted in a rowid table.
6803** ^The first argument to the callback is a copy of the third argument
6804** to sqlite3_update_hook().
6805** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE],
6806** or [SQLITE_UPDATE], depending on the operation that caused the callback
6807** to be invoked.
6808** ^The third and fourth arguments to the callback contain pointers to the
6809** database and table name containing the affected row.
6810** ^The final callback parameter is the [rowid] of the row.
6811** ^In the case of an update, this is the [rowid] after the update takes place.
6813** ^(The update hook is not invoked when internal system tables are
6814** modified (i.e. sqlite_sequence).)^
6815** ^The update hook is not invoked when [WITHOUT ROWID] tables are modified.
6817** ^In the current implementation, the update hook
6818** is not invoked when conflicting rows are deleted because of an
6819** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook
6820** invoked when rows are deleted using the [truncate optimization].
6821** The exceptions defined in this paragraph might change in a future
6822** release of SQLite.
6824** The update hook implementation must not do anything that will modify
6825** the database connection that invoked the update hook. Any actions
6826** to modify the database connection must be deferred until after the
6827** completion of the [sqlite3_step()] call that triggered the update hook.
6828** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
6829** database connections for the meaning of "modify" in this paragraph.
6831** ^The sqlite3_update_hook(D,C,P) function
6832** returns the P argument from the previous call
6833** on the same [database connection] D, or NULL for
6834** the first call on D.
6836** See also the [sqlite3_commit_hook()], [sqlite3_rollback_hook()],
6837** and [sqlite3_preupdate_hook()] interfaces.
6839SQLITE_API void *sqlite3_update_hook(
6840 sqlite3*,
6841 void(*)(void *,int ,char const *,char const *,sqlite3_int64),
6842 void*
6846** CAPI3REF: Enable Or Disable Shared Pager Cache
6848** ^(This routine enables or disables the sharing of the database cache
6849** and schema data structures between [database connection | connections]
6850** to the same database. Sharing is enabled if the argument is true
6851** and disabled if the argument is false.)^
6853** ^Cache sharing is enabled and disabled for an entire process.
6854** This is a change as of SQLite [version 3.5.0] ([dateof:3.5.0]).
6855** In prior versions of SQLite,
6856** sharing was enabled or disabled for each thread separately.
6858** ^(The cache sharing mode set by this interface effects all subsequent
6859** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()].
6860** Existing database connections continue to use the sharing mode
6861** that was in effect at the time they were opened.)^
6863** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled
6864** successfully. An [error code] is returned otherwise.)^
6866** ^Shared cache is disabled by default. It is recommended that it stay
6867** that way. In other words, do not use this routine. This interface
6868** continues to be provided for historical compatibility, but its use is
6869** discouraged. Any use of shared cache is discouraged. If shared cache
6870** must be used, it is recommended that shared cache only be enabled for
6871** individual database connections using the [sqlite3_open_v2()] interface
6872** with the [SQLITE_OPEN_SHAREDCACHE] flag.
6874** Note: This method is disabled on MacOS X 10.7 and iOS version 5.0
6875** and will always return SQLITE_MISUSE. On those systems,
6876** shared cache mode should be enabled per-database connection via
6877** [sqlite3_open_v2()] with [SQLITE_OPEN_SHAREDCACHE].
6879** This interface is threadsafe on processors where writing a
6880** 32-bit integer is atomic.
6882** See Also: [SQLite Shared-Cache Mode]
6884SQLITE_API int sqlite3_enable_shared_cache(int);
6887** CAPI3REF: Attempt To Free Heap Memory
6889** ^The sqlite3_release_memory() interface attempts to free N bytes
6890** of heap memory by deallocating non-essential memory allocations
6891** held by the database library. Memory used to cache database
6892** pages to improve performance is an example of non-essential memory.
6893** ^sqlite3_release_memory() returns the number of bytes actually freed,
6894** which might be more or less than the amount requested.
6895** ^The sqlite3_release_memory() routine is a no-op returning zero
6896** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT].
6898** See also: [sqlite3_db_release_memory()]
6900SQLITE_API int sqlite3_release_memory(int);
6903** CAPI3REF: Free Memory Used By A Database Connection
6904** METHOD: sqlite3
6906** ^The sqlite3_db_release_memory(D) interface attempts to free as much heap
6907** memory as possible from database connection D. Unlike the
6908** [sqlite3_release_memory()] interface, this interface is in effect even
6909** when the [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is
6910** omitted.
6912** See also: [sqlite3_release_memory()]
6914SQLITE_API int sqlite3_db_release_memory(sqlite3*);
6917** CAPI3REF: Impose A Limit On Heap Size
6919** These interfaces impose limits on the amount of heap memory that will be
6920** by all database connections within a single process.
6922** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the
6923** soft limit on the amount of heap memory that may be allocated by SQLite.
6924** ^SQLite strives to keep heap memory utilization below the soft heap
6925** limit by reducing the number of pages held in the page cache
6926** as heap memory usages approaches the limit.
6927** ^The soft heap limit is "soft" because even though SQLite strives to stay
6928** below the limit, it will exceed the limit rather than generate
6929** an [SQLITE_NOMEM] error. In other words, the soft heap limit
6930** is advisory only.
6932** ^The sqlite3_hard_heap_limit64(N) interface sets a hard upper bound of
6933** N bytes on the amount of memory that will be allocated. ^The
6934** sqlite3_hard_heap_limit64(N) interface is similar to
6935** sqlite3_soft_heap_limit64(N) except that memory allocations will fail
6936** when the hard heap limit is reached.
6938** ^The return value from both sqlite3_soft_heap_limit64() and
6939** sqlite3_hard_heap_limit64() is the size of
6940** the heap limit prior to the call, or negative in the case of an
6941** error. ^If the argument N is negative
6942** then no change is made to the heap limit. Hence, the current
6943** size of heap limits can be determined by invoking
6944** sqlite3_soft_heap_limit64(-1) or sqlite3_hard_heap_limit(-1).
6946** ^Setting the heap limits to zero disables the heap limiter mechanism.
6948** ^The soft heap limit may not be greater than the hard heap limit.
6949** ^If the hard heap limit is enabled and if sqlite3_soft_heap_limit(N)
6950** is invoked with a value of N that is greater than the hard heap limit,
6951** the the soft heap limit is set to the value of the hard heap limit.
6952** ^The soft heap limit is automatically enabled whenever the hard heap
6953** limit is enabled. ^When sqlite3_hard_heap_limit64(N) is invoked and
6954** the soft heap limit is outside the range of 1..N, then the soft heap
6955** limit is set to N. ^Invoking sqlite3_soft_heap_limit64(0) when the
6956** hard heap limit is enabled makes the soft heap limit equal to the
6957** hard heap limit.
6959** The memory allocation limits can also be adjusted using
6960** [PRAGMA soft_heap_limit] and [PRAGMA hard_heap_limit].
6962** ^(The heap limits are not enforced in the current implementation
6963** if one or more of following conditions are true:
6965** <ul>
6966** <li> The limit value is set to zero.
6967** <li> Memory accounting is disabled using a combination of the
6968** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and
6969** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option.
6970** <li> An alternative page cache implementation is specified using
6971** [sqlite3_config]([SQLITE_CONFIG_PCACHE2],...).
6972** <li> The page cache allocates from its own memory pool supplied
6973** by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than
6974** from the heap.
6975** </ul>)^
6977** The circumstances under which SQLite will enforce the heap limits may
6978** changes in future releases of SQLite.
6980SQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N);
6981SQLITE_API sqlite3_int64 sqlite3_hard_heap_limit64(sqlite3_int64 N);
6984** CAPI3REF: Deprecated Soft Heap Limit Interface
6987** This is a deprecated version of the [sqlite3_soft_heap_limit64()]
6988** interface. This routine is provided for historical compatibility
6989** only. All new applications should use the
6990** [sqlite3_soft_heap_limit64()] interface rather than this one.
6992SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_limit(int N);
6996** CAPI3REF: Extract Metadata About A Column Of A Table
6997** METHOD: sqlite3
6999** ^(The sqlite3_table_column_metadata(X,D,T,C,....) routine returns
7000** information about column C of table T in database D
7001** on [database connection] X.)^ ^The sqlite3_table_column_metadata()
7002** interface returns SQLITE_OK and fills in the non-NULL pointers in
7003** the final five arguments with appropriate values if the specified
7004** column exists. ^The sqlite3_table_column_metadata() interface returns
7005** SQLITE_ERROR if the specified column does not exist.
7006** ^If the column-name parameter to sqlite3_table_column_metadata() is a
7007** NULL pointer, then this routine simply checks for the existence of the
7008** table and returns SQLITE_OK if the table exists and SQLITE_ERROR if it
7009** does not. If the table name parameter T in a call to
7010** sqlite3_table_column_metadata(X,D,T,C,...) is NULL then the result is
7011** undefined behavior.
7013** ^The column is identified by the second, third and fourth parameters to
7014** this function. ^(The second parameter is either the name of the database
7015** (i.e. "main", "temp", or an attached database) containing the specified
7016** table or NULL.)^ ^If it is NULL, then all attached databases are searched
7017** for the table using the same algorithm used by the database engine to
7018** resolve unqualified table references.
7020** ^The third and fourth parameters to this function are the table and column
7021** name of the desired column, respectively.
7023** ^Metadata is returned by writing to the memory locations passed as the 5th
7024** and subsequent parameters to this function. ^Any of these arguments may be
7025** NULL, in which case the corresponding element of metadata is omitted.
7027** ^(<blockquote>
7028** <table border="1">
7029** <tr><th> Parameter <th> Output<br>Type <th> Description
7031** <tr><td> 5th <td> const char* <td> Data type
7032** <tr><td> 6th <td> const char* <td> Name of default collation sequence
7033** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint
7034** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY
7035** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT]
7036** </table>
7037** </blockquote>)^
7039** ^The memory pointed to by the character pointers returned for the
7040** declaration type and collation sequence is valid until the next
7041** call to any SQLite API function.
7043** ^If the specified table is actually a view, an [error code] is returned.
7045** ^If the specified column is "rowid", "oid" or "_rowid_" and the table
7046** is not a [WITHOUT ROWID] table and an
7047** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output
7048** parameters are set for the explicitly declared column. ^(If there is no
7049** [INTEGER PRIMARY KEY] column, then the outputs
7050** for the [rowid] are set as follows:
7052** <pre>
7053** data type: "INTEGER"
7054** collation sequence: "BINARY"
7055** not null: 0
7056** primary key: 1
7057** auto increment: 0
7058** </pre>)^
7060** ^This function causes all database schemas to be read from disk and
7061** parsed, if that has not already been done, and returns an error if
7062** any errors are encountered while loading the schema.
7064SQLITE_API int sqlite3_table_column_metadata(
7065 sqlite3 *db, /* Connection handle */
7066 const char *zDbName, /* Database name or NULL */
7067 const char *zTableName, /* Table name */
7068 const char *zColumnName, /* Column name */
7069 char const **pzDataType, /* OUTPUT: Declared data type */
7070 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
7071 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
7072 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
7073 int *pAutoinc /* OUTPUT: True if column is auto-increment */
7077** CAPI3REF: Load An Extension
7078** METHOD: sqlite3
7080** ^This interface loads an SQLite extension library from the named file.
7082** ^The sqlite3_load_extension() interface attempts to load an
7083** [SQLite extension] library contained in the file zFile. If
7084** the file cannot be loaded directly, attempts are made to load
7085** with various operating-system specific extensions added.
7086** So for example, if "samplelib" cannot be loaded, then names like
7087** "samplelib.so" or "samplelib.dylib" or "samplelib.dll" might
7088** be tried also.
7090** ^The entry point is zProc.
7091** ^(zProc may be 0, in which case SQLite will try to come up with an
7092** entry point name on its own. It first tries "sqlite3_extension_init".
7093** If that does not work, it constructs a name "sqlite3_X_init" where the
7094** X is consists of the lower-case equivalent of all ASCII alphabetic
7095** characters in the filename from the last "/" to the first following
7096** "." and omitting any initial "lib".)^
7097** ^The sqlite3_load_extension() interface returns
7098** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.
7099** ^If an error occurs and pzErrMsg is not 0, then the
7100** [sqlite3_load_extension()] interface shall attempt to
7101** fill *pzErrMsg with error message text stored in memory
7102** obtained from [sqlite3_malloc()]. The calling function
7103** should free this memory by calling [sqlite3_free()].
7105** ^Extension loading must be enabled using
7106** [sqlite3_enable_load_extension()] or
7107** [sqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],1,NULL)
7108** prior to calling this API,
7109** otherwise an error will be returned.
7111** <b>Security warning:</b> It is recommended that the
7112** [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method be used to enable only this
7113** interface. The use of the [sqlite3_enable_load_extension()] interface
7114** should be avoided. This will keep the SQL function [load_extension()]
7115** disabled and prevent SQL injections from giving attackers
7116** access to extension loading capabilities.
7118** See also the [load_extension() SQL function].
7120SQLITE_API int sqlite3_load_extension(
7121 sqlite3 *db, /* Load the extension into this database connection */
7122 const char *zFile, /* Name of the shared library containing extension */
7123 const char *zProc, /* Entry point. Derived from zFile if 0 */
7124 char **pzErrMsg /* Put error message here if not 0 */
7128** CAPI3REF: Enable Or Disable Extension Loading
7129** METHOD: sqlite3
7131** ^So as not to open security holes in older applications that are
7132** unprepared to deal with [extension loading], and as a means of disabling
7133** [extension loading] while evaluating user-entered SQL, the following API
7134** is provided to turn the [sqlite3_load_extension()] mechanism on and off.
7136** ^Extension loading is off by default.
7137** ^Call the sqlite3_enable_load_extension() routine with onoff==1
7138** to turn extension loading on and call it with onoff==0 to turn
7139** it back off again.
7141** ^This interface enables or disables both the C-API
7142** [sqlite3_load_extension()] and the SQL function [load_extension()].
7143** ^(Use [sqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],..)
7144** to enable or disable only the C-API.)^
7146** <b>Security warning:</b> It is recommended that extension loading
7147** be enabled using the [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method
7148** rather than this interface, so the [load_extension()] SQL function
7149** remains disabled. This will prevent SQL injections from giving attackers
7150** access to extension loading capabilities.
7152SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff);
7155** CAPI3REF: Automatically Load Statically Linked Extensions
7157** ^This interface causes the xEntryPoint() function to be invoked for
7158** each new [database connection] that is created. The idea here is that
7159** xEntryPoint() is the entry point for a statically linked [SQLite extension]
7160** that is to be automatically loaded into all new database connections.
7162** ^(Even though the function prototype shows that xEntryPoint() takes
7163** no arguments and returns void, SQLite invokes xEntryPoint() with three
7164** arguments and expects an integer result as if the signature of the
7165** entry point where as follows:
7167** <blockquote><pre>
7168** &nbsp; int xEntryPoint(
7169** &nbsp; sqlite3 *db,
7170** &nbsp; const char **pzErrMsg,
7171** &nbsp; const struct sqlite3_api_routines *pThunk
7172** &nbsp; );
7173** </pre></blockquote>)^
7175** If the xEntryPoint routine encounters an error, it should make *pzErrMsg
7176** point to an appropriate error message (obtained from [sqlite3_mprintf()])
7177** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg
7178** is NULL before calling the xEntryPoint(). ^SQLite will invoke
7179** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any
7180** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()],
7181** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail.
7183** ^Calling sqlite3_auto_extension(X) with an entry point X that is already
7184** on the list of automatic extensions is a harmless no-op. ^No entry point
7185** will be called more than once for each database connection that is opened.
7187** See also: [sqlite3_reset_auto_extension()]
7188** and [sqlite3_cancel_auto_extension()]
7190SQLITE_API int sqlite3_auto_extension(void(*xEntryPoint)(void));
7193** CAPI3REF: Cancel Automatic Extension Loading
7195** ^The [sqlite3_cancel_auto_extension(X)] interface unregisters the
7196** initialization routine X that was registered using a prior call to
7197** [sqlite3_auto_extension(X)]. ^The [sqlite3_cancel_auto_extension(X)]
7198** routine returns 1 if initialization routine X was successfully
7199** unregistered and it returns 0 if X was not on the list of initialization
7200** routines.
7202SQLITE_API int sqlite3_cancel_auto_extension(void(*xEntryPoint)(void));
7205** CAPI3REF: Reset Automatic Extension Loading
7207** ^This interface disables all automatic extensions previously
7208** registered using [sqlite3_auto_extension()].
7210SQLITE_API void sqlite3_reset_auto_extension(void);
7213** The interface to the virtual-table mechanism is currently considered
7214** to be experimental. The interface might change in incompatible ways.
7215** If this is a problem for you, do not use the interface at this time.
7217** When the virtual-table mechanism stabilizes, we will declare the
7218** interface fixed, support it indefinitely, and remove this comment.
7222** Structures used by the virtual table interface
7224typedef struct sqlite3_vtab sqlite3_vtab;
7225typedef struct sqlite3_index_info sqlite3_index_info;
7226typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor;
7227typedef struct sqlite3_module sqlite3_module;
7230** CAPI3REF: Virtual Table Object
7231** KEYWORDS: sqlite3_module {virtual table module}
7233** This structure, sometimes called a "virtual table module",
7234** defines the implementation of a [virtual table].
7235** This structure consists mostly of methods for the module.
7237** ^A virtual table module is created by filling in a persistent
7238** instance of this structure and passing a pointer to that instance
7239** to [sqlite3_create_module()] or [sqlite3_create_module_v2()].
7240** ^The registration remains valid until it is replaced by a different
7241** module or until the [database connection] closes. The content
7242** of this structure must not change while it is registered with
7243** any database connection.
7245struct sqlite3_module {
7246 int iVersion;
7247 int (*xCreate)(sqlite3*, void *pAux,
7248 int argc, const char *const*argv,
7249 sqlite3_vtab **ppVTab, char**);
7250 int (*xConnect)(sqlite3*, void *pAux,
7251 int argc, const char *const*argv,
7252 sqlite3_vtab **ppVTab, char**);
7253 int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*);
7254 int (*xDisconnect)(sqlite3_vtab *pVTab);
7255 int (*xDestroy)(sqlite3_vtab *pVTab);
7256 int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor);
7257 int (*xClose)(sqlite3_vtab_cursor*);
7258 int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr,
7259 int argc, sqlite3_value **argv);
7260 int (*xNext)(sqlite3_vtab_cursor*);
7261 int (*xEof)(sqlite3_vtab_cursor*);
7262 int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int);
7263 int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid);
7264 int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *);
7265 int (*xBegin)(sqlite3_vtab *pVTab);
7266 int (*xSync)(sqlite3_vtab *pVTab);
7267 int (*xCommit)(sqlite3_vtab *pVTab);
7268 int (*xRollback)(sqlite3_vtab *pVTab);
7269 int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName,
7270 void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),
7271 void **ppArg);
7272 int (*xRename)(sqlite3_vtab *pVtab, const char *zNew);
7273 /* The methods above are in version 1 of the sqlite_module object. Those
7274 ** below are for version 2 and greater. */
7275 int (*xSavepoint)(sqlite3_vtab *pVTab, int);
7276 int (*xRelease)(sqlite3_vtab *pVTab, int);
7277 int (*xRollbackTo)(sqlite3_vtab *pVTab, int);
7278 /* The methods above are in versions 1 and 2 of the sqlite_module object.
7279 ** Those below are for version 3 and greater. */
7280 int (*xShadowName)(const char*);
7284** CAPI3REF: Virtual Table Indexing Information
7285** KEYWORDS: sqlite3_index_info
7287** The sqlite3_index_info structure and its substructures is used as part
7288** of the [virtual table] interface to
7289** pass information into and receive the reply from the [xBestIndex]
7290** method of a [virtual table module]. The fields under **Inputs** are the
7291** inputs to xBestIndex and are read-only. xBestIndex inserts its
7292** results into the **Outputs** fields.
7294** ^(The aConstraint[] array records WHERE clause constraints of the form:
7296** <blockquote>column OP expr</blockquote>
7298** where OP is =, &lt;, &lt;=, &gt;, or &gt;=.)^ ^(The particular operator is
7299** stored in aConstraint[].op using one of the
7301** ^(The index of the column is stored in
7302** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the
7303** expr on the right-hand side can be evaluated (and thus the constraint
7304** is usable) and false if it cannot.)^
7306** ^The optimizer automatically inverts terms of the form "expr OP column"
7307** and makes other simplifications to the WHERE clause in an attempt to
7308** get as many WHERE clause terms into the form shown above as possible.
7309** ^The aConstraint[] array only reports WHERE clause terms that are
7310** relevant to the particular virtual table being queried.
7312** ^Information about the ORDER BY clause is stored in aOrderBy[].
7313** ^Each term of aOrderBy records a column of the ORDER BY clause.
7315** The colUsed field indicates which columns of the virtual table may be
7316** required by the current scan. Virtual table columns are numbered from
7317** zero in the order in which they appear within the CREATE TABLE statement
7318** passed to sqlite3_declare_vtab(). For the first 63 columns (columns 0-62),
7319** the corresponding bit is set within the colUsed mask if the column may be
7320** required by SQLite. If the table has at least 64 columns and any column
7321** to the right of the first 63 is required, then bit 63 of colUsed is also
7322** set. In other words, column iCol may be required if the expression
7323** (colUsed & ((sqlite3_uint64)1 << (iCol>=63 ? 63 : iCol))) evaluates to
7324** non-zero.
7326** The [xBestIndex] method must fill aConstraintUsage[] with information
7327** about what parameters to pass to xFilter. ^If argvIndex>0 then
7328** the right-hand side of the corresponding aConstraint[] is evaluated
7329** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit
7330** is true, then the constraint is assumed to be fully handled by the
7331** virtual table and might not be checked again by the byte code.)^ ^(The
7332** aConstraintUsage[].omit flag is an optimization hint. When the omit flag
7333** is left in its default setting of false, the constraint will always be
7334** checked separately in byte code. If the omit flag is change to true, then
7335** the constraint may or may not be checked in byte code. In other words,
7336** when the omit flag is true there is no guarantee that the constraint will
7337** not be checked again using byte code.)^
7339** ^The idxNum and idxPtr values are recorded and passed into the
7340** [xFilter] method.
7341** ^[sqlite3_free()] is used to free idxPtr if and only if
7342** needToFreeIdxPtr is true.
7344** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in
7345** the correct order to satisfy the ORDER BY clause so that no separate
7346** sorting step is required.
7348** ^The estimatedCost value is an estimate of the cost of a particular
7349** strategy. A cost of N indicates that the cost of the strategy is similar
7350** to a linear scan of an SQLite table with N rows. A cost of log(N)
7351** indicates that the expense of the operation is similar to that of a
7352** binary search on a unique indexed field of an SQLite table with N rows.
7354** ^The estimatedRows value is an estimate of the number of rows that
7355** will be returned by the strategy.
7357** The xBestIndex method may optionally populate the idxFlags field with a
7358** mask of SQLITE_INDEX_SCAN_* flags. Currently there is only one such flag -
7359** SQLITE_INDEX_SCAN_UNIQUE. If the xBestIndex method sets this flag, SQLite
7360** assumes that the strategy may visit at most one row.
7362** Additionally, if xBestIndex sets the SQLITE_INDEX_SCAN_UNIQUE flag, then
7363** SQLite also assumes that if a call to the xUpdate() method is made as
7364** part of the same statement to delete or update a virtual table row and the
7365** implementation returns SQLITE_CONSTRAINT, then there is no need to rollback
7366** any database changes. In other words, if the xUpdate() returns
7367** SQLITE_CONSTRAINT, the database contents must be exactly as they were
7368** before xUpdate was called. By contrast, if SQLITE_INDEX_SCAN_UNIQUE is not
7369** set and xUpdate returns SQLITE_CONSTRAINT, any database changes made by
7370** the xUpdate method are automatically rolled back by SQLite.
7372** IMPORTANT: The estimatedRows field was added to the sqlite3_index_info
7373** structure for SQLite [version 3.8.2] ([dateof:3.8.2]).
7374** If a virtual table extension is
7375** used with an SQLite version earlier than 3.8.2, the results of attempting
7376** to read or write the estimatedRows field are undefined (but are likely
7377** to include crashing the application). The estimatedRows field should
7378** therefore only be used if [sqlite3_libversion_number()] returns a
7379** value greater than or equal to 3008002. Similarly, the idxFlags field
7380** was added for [version 3.9.0] ([dateof:3.9.0]).
7381** It may therefore only be used if
7382** sqlite3_libversion_number() returns a value greater than or equal to
7383** 3009000.
7385struct sqlite3_index_info {
7386 /* Inputs */
7387 int nConstraint; /* Number of entries in aConstraint */
7388 struct sqlite3_index_constraint {
7389 int iColumn; /* Column constrained. -1 for ROWID */
7390 unsigned char op; /* Constraint operator */
7391 unsigned char usable; /* True if this constraint is usable */
7392 int iTermOffset; /* Used internally - xBestIndex should ignore */
7393 } *aConstraint; /* Table of WHERE clause constraints */
7394 int nOrderBy; /* Number of terms in the ORDER BY clause */
7395 struct sqlite3_index_orderby {
7396 int iColumn; /* Column number */
7397 unsigned char desc; /* True for DESC. False for ASC. */
7398 } *aOrderBy; /* The ORDER BY clause */
7399 /* Outputs */
7400 struct sqlite3_index_constraint_usage {
7401 int argvIndex; /* if >0, constraint is part of argv to xFilter */
7402 unsigned char omit; /* Do not code a test for this constraint */
7403 } *aConstraintUsage;
7404 int idxNum; /* Number used to identify the index */
7405 char *idxStr; /* String, possibly obtained from sqlite3_malloc */
7406 int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */
7407 int orderByConsumed; /* True if output is already ordered */
7408 double estimatedCost; /* Estimated cost of using this index */
7409 /* Fields below are only available in SQLite 3.8.2 and later */
7410 sqlite3_int64 estimatedRows; /* Estimated number of rows returned */
7411 /* Fields below are only available in SQLite 3.9.0 and later */
7412 int idxFlags; /* Mask of SQLITE_INDEX_SCAN_* flags */
7413 /* Fields below are only available in SQLite 3.10.0 and later */
7414 sqlite3_uint64 colUsed; /* Input: Mask of columns used by statement */
7418** CAPI3REF: Virtual Table Scan Flags
7420** Virtual table implementations are allowed to set the
7421** [sqlite3_index_info].idxFlags field to some combination of
7422** these bits.
7424#define SQLITE_INDEX_SCAN_UNIQUE 1 /* Scan visits at most 1 row */
7427** CAPI3REF: Virtual Table Constraint Operator Codes
7429** These macros define the allowed values for the
7430** [sqlite3_index_info].aConstraint[].op field. Each value represents
7431** an operator that is part of a constraint term in the wHERE clause of
7432** a query that uses a [virtual table].
7451** CAPI3REF: Register A Virtual Table Implementation
7452** METHOD: sqlite3
7454** ^These routines are used to register a new [virtual table module] name.
7455** ^Module names must be registered before
7456** creating a new [virtual table] using the module and before using a
7457** preexisting [virtual table] for the module.
7459** ^The module name is registered on the [database connection] specified
7460** by the first parameter. ^The name of the module is given by the
7461** second parameter. ^The third parameter is a pointer to
7462** the implementation of the [virtual table module]. ^The fourth
7463** parameter is an arbitrary client data pointer that is passed through
7464** into the [xCreate] and [xConnect] methods of the virtual table module
7465** when a new virtual table is be being created or reinitialized.
7467** ^The sqlite3_create_module_v2() interface has a fifth parameter which
7468** is a pointer to a destructor for the pClientData. ^SQLite will
7469** invoke the destructor function (if it is not NULL) when SQLite
7470** no longer needs the pClientData pointer. ^The destructor will also
7471** be invoked if the call to sqlite3_create_module_v2() fails.
7472** ^The sqlite3_create_module()
7473** interface is equivalent to sqlite3_create_module_v2() with a NULL
7474** destructor.
7476** ^If the third parameter (the pointer to the sqlite3_module object) is
7477** NULL then no new module is create and any existing modules with the
7478** same name are dropped.
7480** See also: [sqlite3_drop_modules()]
7482SQLITE_API int sqlite3_create_module(
7483 sqlite3 *db, /* SQLite connection to register module with */
7484 const char *zName, /* Name of the module */
7485 const sqlite3_module *p, /* Methods for the module */
7486 void *pClientData /* Client data for xCreate/xConnect */
7488SQLITE_API int sqlite3_create_module_v2(
7489 sqlite3 *db, /* SQLite connection to register module with */
7490 const char *zName, /* Name of the module */
7491 const sqlite3_module *p, /* Methods for the module */
7492 void *pClientData, /* Client data for xCreate/xConnect */
7493 void(*xDestroy)(void*) /* Module destructor function */
7497** CAPI3REF: Remove Unnecessary Virtual Table Implementations
7498** METHOD: sqlite3
7500** ^The sqlite3_drop_modules(D,L) interface removes all virtual
7501** table modules from database connection D except those named on list L.
7502** The L parameter must be either NULL or a pointer to an array of pointers
7503** to strings where the array is terminated by a single NULL pointer.
7504** ^If the L parameter is NULL, then all virtual table modules are removed.
7506** See also: [sqlite3_create_module()]
7508SQLITE_API int sqlite3_drop_modules(
7509 sqlite3 *db, /* Remove modules from this connection */
7510 const char **azKeep /* Except, do not remove the ones named here */
7514** CAPI3REF: Virtual Table Instance Object
7515** KEYWORDS: sqlite3_vtab
7517** Every [virtual table module] implementation uses a subclass
7518** of this object to describe a particular instance
7519** of the [virtual table]. Each subclass will
7520** be tailored to the specific needs of the module implementation.
7521** The purpose of this superclass is to define certain fields that are
7522** common to all module implementations.
7524** ^Virtual tables methods can set an error message by assigning a
7525** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should
7526** take care that any prior string is freed by a call to [sqlite3_free()]
7527** prior to assigning a new string to zErrMsg. ^After the error message
7528** is delivered up to the client application, the string will be automatically
7529** freed by sqlite3_free() and the zErrMsg field will be zeroed.
7531struct sqlite3_vtab {
7532 const sqlite3_module *pModule; /* The module for this virtual table */
7533 int nRef; /* Number of open cursors */
7534 char *zErrMsg; /* Error message from sqlite3_mprintf() */
7535 /* Virtual table implementations will typically add additional fields */
7539** CAPI3REF: Virtual Table Cursor Object
7540** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor}
7542** Every [virtual table module] implementation uses a subclass of the
7543** following structure to describe cursors that point into the
7544** [virtual table] and are used
7545** to loop through the virtual table. Cursors are created using the
7546** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed
7547** by the [sqlite3_module.xClose | xClose] method. Cursors are used
7548** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods
7549** of the module. Each module implementation will define
7550** the content of a cursor structure to suit its own needs.
7552** This superclass exists in order to define fields of the cursor that
7553** are common to all implementations.
7555struct sqlite3_vtab_cursor {
7556 sqlite3_vtab *pVtab; /* Virtual table of this cursor */
7557 /* Virtual table implementations will typically add additional fields */
7561** CAPI3REF: Declare The Schema Of A Virtual Table
7563** ^The [xCreate] and [xConnect] methods of a
7564** [virtual table module] call this interface
7565** to declare the format (the names and datatypes of the columns) of
7566** the virtual tables they implement.
7568SQLITE_API int sqlite3_declare_vtab(sqlite3*, const char *zSQL);
7571** CAPI3REF: Overload A Function For A Virtual Table
7572** METHOD: sqlite3
7574** ^(Virtual tables can provide alternative implementations of functions
7575** using the [xFindFunction] method of the [virtual table module].
7576** But global versions of those functions
7577** must exist in order to be overloaded.)^
7579** ^(This API makes sure a global version of a function with a particular
7580** name and number of parameters exists. If no such function exists
7581** before this API is called, a new function is created.)^ ^The implementation
7582** of the new function always causes an exception to be thrown. So
7583** the new function is not good for anything by itself. Its only
7584** purpose is to be a placeholder function that can be overloaded
7585** by a [virtual table].
7587SQLITE_API int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg);
7590** The interface to the virtual-table mechanism defined above (back up
7591** to a comment remarkably similar to this one) is currently considered
7592** to be experimental. The interface might change in incompatible ways.
7593** If this is a problem for you, do not use the interface at this time.
7595** When the virtual-table mechanism stabilizes, we will declare the
7596** interface fixed, support it indefinitely, and remove this comment.
7600** CAPI3REF: A Handle To An Open BLOB
7601** KEYWORDS: {BLOB handle} {BLOB handles}
7603** An instance of this object represents an open BLOB on which
7604** [sqlite3_blob_open | incremental BLOB I/O] can be performed.
7605** ^Objects of this type are created by [sqlite3_blob_open()]
7606** and destroyed by [sqlite3_blob_close()].
7607** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces
7608** can be used to read or write small subsections of the BLOB.
7609** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes.
7611typedef struct sqlite3_blob sqlite3_blob;
7614** CAPI3REF: Open A BLOB For Incremental I/O
7615** METHOD: sqlite3
7616** CONSTRUCTOR: sqlite3_blob
7618** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located
7619** in row iRow, column zColumn, table zTable in database zDb;
7620** in other words, the same BLOB that would be selected by:
7622** <pre>
7623** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow;
7624** </pre>)^
7626** ^(Parameter zDb is not the filename that contains the database, but
7627** rather the symbolic name of the database. For attached databases, this is
7628** the name that appears after the AS keyword in the [ATTACH] statement.
7629** For the main database file, the database name is "main". For TEMP
7630** tables, the database name is "temp".)^
7632** ^If the flags parameter is non-zero, then the BLOB is opened for read
7633** and write access. ^If the flags parameter is zero, the BLOB is opened for
7634** read-only access.
7636** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is stored
7637** in *ppBlob. Otherwise an [error code] is returned and, unless the error
7638** code is SQLITE_MISUSE, *ppBlob is set to NULL.)^ ^This means that, provided
7639** the API is not misused, it is always safe to call [sqlite3_blob_close()]
7640** on *ppBlob after this function it returns.
7642** This function fails with SQLITE_ERROR if any of the following are true:
7643** <ul>
7644** <li> ^(Database zDb does not exist)^,
7645** <li> ^(Table zTable does not exist within database zDb)^,
7646** <li> ^(Table zTable is a WITHOUT ROWID table)^,
7647** <li> ^(Column zColumn does not exist)^,
7648** <li> ^(Row iRow is not present in the table)^,
7649** <li> ^(The specified column of row iRow contains a value that is not
7650** a TEXT or BLOB value)^,
7651** <li> ^(Column zColumn is part of an index, PRIMARY KEY or UNIQUE
7652** constraint and the blob is being opened for read/write access)^,
7653** <li> ^([foreign key constraints | Foreign key constraints] are enabled,
7654** column zColumn is part of a [child key] definition and the blob is
7655** being opened for read/write access)^.
7656** </ul>
7658** ^Unless it returns SQLITE_MISUSE, this function sets the
7659** [database connection] error code and message accessible via
7660** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions.
7662** A BLOB referenced by sqlite3_blob_open() may be read using the
7663** [sqlite3_blob_read()] interface and modified by using
7664** [sqlite3_blob_write()]. The [BLOB handle] can be moved to a
7665** different row of the same table using the [sqlite3_blob_reopen()]
7666** interface. However, the column, table, or database of a [BLOB handle]
7667** cannot be changed after the [BLOB handle] is opened.
7669** ^(If the row that a BLOB handle points to is modified by an
7670** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects
7671** then the BLOB handle is marked as "expired".
7672** This is true if any column of the row is changed, even a column
7673** other than the one the BLOB handle is open on.)^
7674** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for
7675** an expired BLOB handle fail with a return code of [SQLITE_ABORT].
7676** ^(Changes written into a BLOB prior to the BLOB expiring are not
7677** rolled back by the expiration of the BLOB. Such changes will eventually
7678** commit if the transaction continues to completion.)^
7680** ^Use the [sqlite3_blob_bytes()] interface to determine the size of
7681** the opened blob. ^The size of a blob may not be changed by this
7682** interface. Use the [UPDATE] SQL command to change the size of a
7683** blob.
7685** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces
7686** and the built-in [zeroblob] SQL function may be used to create a
7687** zero-filled blob to read or write using the incremental-blob interface.
7689** To avoid a resource leak, every open [BLOB handle] should eventually
7690** be released by a call to [sqlite3_blob_close()].
7692** See also: [sqlite3_blob_close()],
7693** [sqlite3_blob_reopen()], [sqlite3_blob_read()],
7694** [sqlite3_blob_bytes()], [sqlite3_blob_write()].
7696SQLITE_API int sqlite3_blob_open(
7697 sqlite3*,
7698 const char *zDb,
7699 const char *zTable,
7700 const char *zColumn,
7701 sqlite3_int64 iRow,
7702 int flags,
7703 sqlite3_blob **ppBlob
7707** CAPI3REF: Move a BLOB Handle to a New Row
7708** METHOD: sqlite3_blob
7710** ^This function is used to move an existing [BLOB handle] so that it points
7711** to a different row of the same database table. ^The new row is identified
7712** by the rowid value passed as the second argument. Only the row can be
7713** changed. ^The database, table and column on which the blob handle is open
7714** remain the same. Moving an existing [BLOB handle] to a new row is
7715** faster than closing the existing handle and opening a new one.
7717** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] -
7718** it must exist and there must be either a blob or text value stored in
7719** the nominated column.)^ ^If the new row is not present in the table, or if
7720** it does not contain a blob or text value, or if another error occurs, an
7721** SQLite error code is returned and the blob handle is considered aborted.
7722** ^All subsequent calls to [sqlite3_blob_read()], [sqlite3_blob_write()] or
7723** [sqlite3_blob_reopen()] on an aborted blob handle immediately return
7724** SQLITE_ABORT. ^Calling [sqlite3_blob_bytes()] on an aborted blob handle
7725** always returns zero.
7727** ^This function sets the database handle error code and message.
7729SQLITE_API int sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64);
7732** CAPI3REF: Close A BLOB Handle
7733** DESTRUCTOR: sqlite3_blob
7735** ^This function closes an open [BLOB handle]. ^(The BLOB handle is closed
7736** unconditionally. Even if this routine returns an error code, the
7737** handle is still closed.)^
7739** ^If the blob handle being closed was opened for read-write access, and if
7740** the database is in auto-commit mode and there are no other open read-write
7741** blob handles or active write statements, the current transaction is
7742** committed. ^If an error occurs while committing the transaction, an error
7743** code is returned and the transaction rolled back.
7745** Calling this function with an argument that is not a NULL pointer or an
7746** open blob handle results in undefined behaviour. ^Calling this routine
7747** with a null pointer (such as would be returned by a failed call to
7748** [sqlite3_blob_open()]) is a harmless no-op. ^Otherwise, if this function
7749** is passed a valid open blob handle, the values returned by the
7750** sqlite3_errcode() and sqlite3_errmsg() functions are set before returning.
7752SQLITE_API int sqlite3_blob_close(sqlite3_blob *);
7755** CAPI3REF: Return The Size Of An Open BLOB
7756** METHOD: sqlite3_blob
7758** ^Returns the size in bytes of the BLOB accessible via the
7759** successfully opened [BLOB handle] in its only argument. ^The
7760** incremental blob I/O routines can only read or overwriting existing
7761** blob content; they cannot change the size of a blob.
7763** This routine only works on a [BLOB handle] which has been created
7764** by a prior successful call to [sqlite3_blob_open()] and which has not
7765** been closed by [sqlite3_blob_close()]. Passing any other pointer in
7766** to this routine results in undefined and probably undesirable behavior.
7768SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *);
7771** CAPI3REF: Read Data From A BLOB Incrementally
7772** METHOD: sqlite3_blob
7774** ^(This function is used to read data from an open [BLOB handle] into a
7775** caller-supplied buffer. N bytes of data are copied into buffer Z
7776** from the open BLOB, starting at offset iOffset.)^
7778** ^If offset iOffset is less than N bytes from the end of the BLOB,
7779** [SQLITE_ERROR] is returned and no data is read. ^If N or iOffset is
7780** less than zero, [SQLITE_ERROR] is returned and no data is read.
7781** ^The size of the blob (and hence the maximum value of N+iOffset)
7782** can be determined using the [sqlite3_blob_bytes()] interface.
7784** ^An attempt to read from an expired [BLOB handle] fails with an
7785** error code of [SQLITE_ABORT].
7787** ^(On success, sqlite3_blob_read() returns SQLITE_OK.
7788** Otherwise, an [error code] or an [extended error code] is returned.)^
7790** This routine only works on a [BLOB handle] which has been created
7791** by a prior successful call to [sqlite3_blob_open()] and which has not
7792** been closed by [sqlite3_blob_close()]. Passing any other pointer in
7793** to this routine results in undefined and probably undesirable behavior.
7795** See also: [sqlite3_blob_write()].
7797SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset);
7800** CAPI3REF: Write Data Into A BLOB Incrementally
7801** METHOD: sqlite3_blob
7803** ^(This function is used to write data into an open [BLOB handle] from a
7804** caller-supplied buffer. N bytes of data are copied from the buffer Z
7805** into the open BLOB, starting at offset iOffset.)^
7807** ^(On success, sqlite3_blob_write() returns SQLITE_OK.
7808** Otherwise, an [error code] or an [extended error code] is returned.)^
7809** ^Unless SQLITE_MISUSE is returned, this function sets the
7810** [database connection] error code and message accessible via
7811** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions.
7813** ^If the [BLOB handle] passed as the first argument was not opened for
7814** writing (the flags parameter to [sqlite3_blob_open()] was zero),
7815** this function returns [SQLITE_READONLY].
7817** This function may only modify the contents of the BLOB; it is
7818** not possible to increase the size of a BLOB using this API.
7819** ^If offset iOffset is less than N bytes from the end of the BLOB,
7820** [SQLITE_ERROR] is returned and no data is written. The size of the
7821** BLOB (and hence the maximum value of N+iOffset) can be determined
7822** using the [sqlite3_blob_bytes()] interface. ^If N or iOffset are less
7823** than zero [SQLITE_ERROR] is returned and no data is written.
7825** ^An attempt to write to an expired [BLOB handle] fails with an
7826** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred
7827** before the [BLOB handle] expired are not rolled back by the
7828** expiration of the handle, though of course those changes might
7829** have been overwritten by the statement that expired the BLOB handle
7830** or by other independent statements.
7832** This routine only works on a [BLOB handle] which has been created
7833** by a prior successful call to [sqlite3_blob_open()] and which has not
7834** been closed by [sqlite3_blob_close()]. Passing any other pointer in
7835** to this routine results in undefined and probably undesirable behavior.
7837** See also: [sqlite3_blob_read()].
7839SQLITE_API int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset);
7842** CAPI3REF: Virtual File System Objects
7844** A virtual filesystem (VFS) is an [sqlite3_vfs] object
7845** that SQLite uses to interact
7846** with the underlying operating system. Most SQLite builds come with a
7847** single default VFS that is appropriate for the host computer.
7848** New VFSes can be registered and existing VFSes can be unregistered.
7849** The following interfaces are provided.
7851** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name.
7852** ^Names are case sensitive.
7853** ^Names are zero-terminated UTF-8 strings.
7854** ^If there is no match, a NULL pointer is returned.
7855** ^If zVfsName is NULL then the default VFS is returned.
7857** ^New VFSes are registered with sqlite3_vfs_register().
7858** ^Each new VFS becomes the default VFS if the makeDflt flag is set.
7859** ^The same VFS can be registered multiple times without injury.
7860** ^To make an existing VFS into the default VFS, register it again
7861** with the makeDflt flag set. If two different VFSes with the
7862** same name are registered, the behavior is undefined. If a
7863** VFS is registered with a name that is NULL or an empty string,
7864** then the behavior is undefined.
7866** ^Unregister a VFS with the sqlite3_vfs_unregister() interface.
7867** ^(If the default VFS is unregistered, another VFS is chosen as
7868** the default. The choice for the new VFS is arbitrary.)^
7870SQLITE_API sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName);
7871SQLITE_API int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);
7872SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);
7875** CAPI3REF: Mutexes
7877** The SQLite core uses these routines for thread
7878** synchronization. Though they are intended for internal
7879** use by SQLite, code that links against SQLite is
7880** permitted to use any of these routines.
7882** The SQLite source code contains multiple implementations
7883** of these mutex routines. An appropriate implementation
7884** is selected automatically at compile-time. The following
7885** implementations are available in the SQLite core:
7887** <ul>
7889** <li> SQLITE_MUTEX_W32
7891** </ul>
7893** The SQLITE_MUTEX_NOOP implementation is a set of routines
7894** that does no real locking and is appropriate for use in
7895** a single-threaded application. The SQLITE_MUTEX_PTHREADS and
7896** SQLITE_MUTEX_W32 implementations are appropriate for use on Unix
7897** and Windows.
7899** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor
7900** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex
7901** implementation is included with the library. In this case the
7902** application must supply a custom mutex implementation using the
7903** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function
7904** before calling sqlite3_initialize() or any other public sqlite3_
7905** function that calls sqlite3_initialize().
7907** ^The sqlite3_mutex_alloc() routine allocates a new
7908** mutex and returns a pointer to it. ^The sqlite3_mutex_alloc()
7909** routine returns NULL if it is unable to allocate the requested
7910** mutex. The argument to sqlite3_mutex_alloc() must one of these
7911** integer constants:
7913** <ul>
7928** </ul>
7930** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE)
7931** cause sqlite3_mutex_alloc() to create
7932** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
7933** is used but not necessarily so when SQLITE_MUTEX_FAST is used.
7934** The mutex implementation does not need to make a distinction
7935** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
7936** not want to. SQLite will only request a recursive mutex in
7937** cases where it really needs one. If a faster non-recursive mutex
7938** implementation is available on the host platform, the mutex subsystem
7939** might return such a mutex in response to SQLITE_MUTEX_FAST.
7941** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other
7943** a pointer to a static preexisting mutex. ^Nine static mutexes are
7944** used by the current version of SQLite. Future versions of SQLite
7945** may add additional static mutexes. Static mutexes are for internal
7946** use by SQLite only. Applications that use SQLite mutexes should
7947** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
7950** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
7951** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
7952** returns a different mutex on every call. ^For the static
7953** mutex types, the same mutex is returned on every call that has
7954** the same type number.
7956** ^The sqlite3_mutex_free() routine deallocates a previously
7957** allocated dynamic mutex. Attempting to deallocate a static
7958** mutex results in undefined behavior.
7960** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
7961** to enter a mutex. ^If another thread is already within the mutex,
7962** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
7963** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK]
7964** upon successful entry. ^(Mutexes created using
7965** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread.
7966** In such cases, the
7967** mutex must be exited an equal number of times before another thread
7968** can enter.)^ If the same thread tries to enter any mutex other
7969** than an SQLITE_MUTEX_RECURSIVE more than once, the behavior is undefined.
7971** ^(Some systems (for example, Windows 95) do not support the operation
7972** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try()
7973** will always return SQLITE_BUSY. The SQLite core only ever uses
7974** sqlite3_mutex_try() as an optimization so this is acceptable
7975** behavior.)^
7977** ^The sqlite3_mutex_leave() routine exits a mutex that was
7978** previously entered by the same thread. The behavior
7979** is undefined if the mutex is not currently entered by the
7980** calling thread or is not currently allocated.
7982** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or
7983** sqlite3_mutex_leave() is a NULL pointer, then all three routines
7984** behave as no-ops.
7986** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()].
7988SQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int);
7989SQLITE_API void sqlite3_mutex_free(sqlite3_mutex*);
7990SQLITE_API void sqlite3_mutex_enter(sqlite3_mutex*);
7991SQLITE_API int sqlite3_mutex_try(sqlite3_mutex*);
7992SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*);
7995** CAPI3REF: Mutex Methods Object
7997** An instance of this structure defines the low-level routines
7998** used to allocate and use mutexes.
8000** Usually, the default mutex implementations provided by SQLite are
8001** sufficient, however the application has the option of substituting a custom
8002** implementation for specialized deployments or systems for which SQLite
8003** does not provide a suitable implementation. In this case, the application
8004** creates and populates an instance of this structure to pass
8005** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option.
8006** Additionally, an instance of this structure can be used as an
8007** output variable when querying the system for the current mutex
8008** implementation, using the [SQLITE_CONFIG_GETMUTEX] option.
8010** ^The xMutexInit method defined by this structure is invoked as
8011** part of system initialization by the sqlite3_initialize() function.
8012** ^The xMutexInit routine is called by SQLite exactly once for each
8013** effective call to [sqlite3_initialize()].
8015** ^The xMutexEnd method defined by this structure is invoked as
8016** part of system shutdown by the sqlite3_shutdown() function. The
8017** implementation of this method is expected to release all outstanding
8018** resources obtained by the mutex methods implementation, especially
8019** those obtained by the xMutexInit method. ^The xMutexEnd()
8020** interface is invoked exactly once for each call to [sqlite3_shutdown()].
8022** ^(The remaining seven methods defined by this structure (xMutexAlloc,
8023** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and
8024** xMutexNotheld) implement the following interfaces (respectively):
8026** <ul>
8027** <li> [sqlite3_mutex_alloc()] </li>
8028** <li> [sqlite3_mutex_free()] </li>
8029** <li> [sqlite3_mutex_enter()] </li>
8030** <li> [sqlite3_mutex_try()] </li>
8031** <li> [sqlite3_mutex_leave()] </li>
8032** <li> [sqlite3_mutex_held()] </li>
8033** <li> [sqlite3_mutex_notheld()] </li>
8034** </ul>)^
8036** The only difference is that the public sqlite3_XXX functions enumerated
8037** above silently ignore any invocations that pass a NULL pointer instead
8038** of a valid mutex handle. The implementations of the methods defined
8039** by this structure are not required to handle this case. The results
8040** of passing a NULL pointer instead of a valid mutex handle are undefined
8041** (i.e. it is acceptable to provide an implementation that segfaults if
8042** it is passed a NULL pointer).
8044** The xMutexInit() method must be threadsafe. It must be harmless to
8045** invoke xMutexInit() multiple times within the same process and without
8046** intervening calls to xMutexEnd(). Second and subsequent calls to
8047** xMutexInit() must be no-ops.
8049** xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()]
8050** and its associates). Similarly, xMutexAlloc() must not use SQLite memory
8051** allocation for a static mutex. ^However xMutexAlloc() may use SQLite
8052** memory allocation for a fast or recursive mutex.
8054** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is
8055** called, but only if the prior call to xMutexInit returned SQLITE_OK.
8056** If xMutexInit fails in any way, it is expected to clean up after itself
8057** prior to returning.
8059typedef struct sqlite3_mutex_methods sqlite3_mutex_methods;
8060struct sqlite3_mutex_methods {
8061 int (*xMutexInit)(void);
8062 int (*xMutexEnd)(void);
8063 sqlite3_mutex *(*xMutexAlloc)(int);
8064 void (*xMutexFree)(sqlite3_mutex *);
8065 void (*xMutexEnter)(sqlite3_mutex *);
8066 int (*xMutexTry)(sqlite3_mutex *);
8067 void (*xMutexLeave)(sqlite3_mutex *);
8068 int (*xMutexHeld)(sqlite3_mutex *);
8069 int (*xMutexNotheld)(sqlite3_mutex *);
8073** CAPI3REF: Mutex Verification Routines
8075** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines
8076** are intended for use inside assert() statements. The SQLite core
8077** never uses these routines except inside an assert() and applications
8078** are advised to follow the lead of the core. The SQLite core only
8079** provides implementations for these routines when it is compiled
8080** with the SQLITE_DEBUG flag. External mutex implementations
8081** are only required to provide these routines if SQLITE_DEBUG is
8082** defined and if NDEBUG is not defined.
8084** These routines should return true if the mutex in their argument
8085** is held or not held, respectively, by the calling thread.
8087** The implementation is not required to provide versions of these
8088** routines that actually work. If the implementation does not provide working
8089** versions of these routines, it should at least provide stubs that always
8090** return true so that one does not get spurious assertion failures.
8092** If the argument to sqlite3_mutex_held() is a NULL pointer then
8093** the routine should return 1. This seems counter-intuitive since
8094** clearly the mutex cannot be held if it does not exist. But
8095** the reason the mutex does not exist is because the build is not
8096** using mutexes. And we do not want the assert() containing the
8097** call to sqlite3_mutex_held() to fail, so a non-zero return is
8098** the appropriate thing to do. The sqlite3_mutex_notheld()
8099** interface should also return 1 when given a NULL pointer.
8101#ifndef NDEBUG
8102SQLITE_API int sqlite3_mutex_held(sqlite3_mutex*);
8103SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*);
8107** CAPI3REF: Mutex Types
8109** The [sqlite3_mutex_alloc()] interface takes a single argument
8110** which is one of these integer constants.
8112** The set of static mutexes may change from one SQLite release to the
8113** next. Applications that override the built-in mutex logic must be
8114** prepared to accommodate additional static mutexes.
8116#define SQLITE_MUTEX_FAST 0
8119#define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */
8121#define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */
8122#define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_randomness() */
8123#define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */
8125#define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */
8126#define SQLITE_MUTEX_STATIC_APP1 8 /* For use by application */
8127#define SQLITE_MUTEX_STATIC_APP2 9 /* For use by application */
8128#define SQLITE_MUTEX_STATIC_APP3 10 /* For use by application */
8129#define SQLITE_MUTEX_STATIC_VFS1 11 /* For use by built-in VFS */
8130#define SQLITE_MUTEX_STATIC_VFS2 12 /* For use by extension VFS */
8131#define SQLITE_MUTEX_STATIC_VFS3 13 /* For use by application VFS */
8133/* Legacy compatibility: */
8138** CAPI3REF: Retrieve the mutex for a database connection
8139** METHOD: sqlite3
8141** ^This interface returns a pointer the [sqlite3_mutex] object that
8142** serializes access to the [database connection] given in the argument
8143** when the [threading mode] is Serialized.
8144** ^If the [threading mode] is Single-thread or Multi-thread then this
8145** routine returns a NULL pointer.
8147SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*);
8150** CAPI3REF: Low-Level Control Of Database Files
8151** METHOD: sqlite3
8152** KEYWORDS: {file control}
8154** ^The [sqlite3_file_control()] interface makes a direct call to the
8155** xFileControl method for the [sqlite3_io_methods] object associated
8156** with a particular database identified by the second argument. ^The
8157** name of the database is "main" for the main database or "temp" for the
8158** TEMP database, or the name that appears after the AS keyword for
8159** databases that are added using the [ATTACH] SQL command.
8160** ^A NULL pointer can be used in place of "main" to refer to the
8161** main database file.
8162** ^The third and fourth parameters to this routine
8163** are passed directly through to the second and third parameters of
8164** the xFileControl method. ^The return value of the xFileControl
8165** method becomes the return value of this routine.
8167** A few opcodes for [sqlite3_file_control()] are handled directly
8168** by the SQLite core and never invoke the
8169** sqlite3_io_methods.xFileControl method.
8170** ^The [SQLITE_FCNTL_FILE_POINTER] value for the op parameter causes
8171** a pointer to the underlying [sqlite3_file] object to be written into
8172** the space pointed to by the 4th parameter. The
8173** [SQLITE_FCNTL_JOURNAL_POINTER] works similarly except that it returns
8174** the [sqlite3_file] object associated with the journal file instead of
8175** the main database. The [SQLITE_FCNTL_VFS_POINTER] opcode returns
8176** a pointer to the underlying [sqlite3_vfs] object for the file.
8177** The [SQLITE_FCNTL_DATA_VERSION] returns the data version counter
8178** from the pager.
8180** ^If the second parameter (zDbName) does not match the name of any
8181** open database file, then SQLITE_ERROR is returned. ^This error
8182** code is not remembered and will not be recalled by [sqlite3_errcode()]
8183** or [sqlite3_errmsg()]. The underlying xFileControl method might
8184** also return SQLITE_ERROR. There is no way to distinguish between
8185** an incorrect zDbName and an SQLITE_ERROR return from the underlying
8186** xFileControl method.
8188** See also: [file control opcodes]
8190SQLITE_API int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*);
8193** CAPI3REF: Testing Interface
8195** ^The sqlite3_test_control() interface is used to read out internal
8196** state of SQLite and to inject faults into SQLite for testing
8197** purposes. ^The first parameter is an operation code that determines
8198** the number, meaning, and operation of all subsequent parameters.
8200** This interface is not for use by applications. It exists solely
8201** for verifying the correct operation of the SQLite library. Depending
8202** on how the SQLite library is compiled, this interface might not exist.
8204** The details of the operation codes, their meanings, the parameters
8205** they take, and what they do are all subject to change without notice.
8206** Unlike most of the SQLite API, this function is not guaranteed to
8207** operate consistently from one release to the next.
8209SQLITE_API int sqlite3_test_control(int op, ...);
8212** CAPI3REF: Testing Interface Operation Codes
8214** These constants are the valid operation code parameters used
8215** as the first argument to [sqlite3_test_control()].
8217** These parameters and their meanings are subject to change
8218** without notice. These values are for testing purposes only.
8219** Applications should not use any of these parameters or the
8220** [sqlite3_test_control()] interface.
8253#define SQLITE_TESTCTRL_LAST 32 /* Largest TESTCTRL */
8256** CAPI3REF: SQL Keyword Checking
8258** These routines provide access to the set of SQL language keywords
8259** recognized by SQLite. Applications can uses these routines to determine
8260** whether or not a specific identifier needs to be escaped (for example,
8261** by enclosing in double-quotes) so as not to confuse the parser.
8263** The sqlite3_keyword_count() interface returns the number of distinct
8264** keywords understood by SQLite.
8266** The sqlite3_keyword_name(N,Z,L) interface finds the N-th keyword and
8267** makes *Z point to that keyword expressed as UTF8 and writes the number
8268** of bytes in the keyword into *L. The string that *Z points to is not
8269** zero-terminated. The sqlite3_keyword_name(N,Z,L) routine returns
8270** SQLITE_OK if N is within bounds and SQLITE_ERROR if not. If either Z
8271** or L are NULL or invalid pointers then calls to
8272** sqlite3_keyword_name(N,Z,L) result in undefined behavior.
8274** The sqlite3_keyword_check(Z,L) interface checks to see whether or not
8275** the L-byte UTF8 identifier that Z points to is a keyword, returning non-zero
8276** if it is and zero if not.
8278** The parser used by SQLite is forgiving. It is often possible to use
8279** a keyword as an identifier as long as such use does not result in a
8280** parsing ambiguity. For example, the statement
8281** "CREATE TABLE BEGIN(REPLACE,PRAGMA,END);" is accepted by SQLite, and
8282** creates a new table named "BEGIN" with three columns named
8283** "REPLACE", "PRAGMA", and "END". Nevertheless, best practice is to avoid
8284** using keywords as identifiers. Common techniques used to avoid keyword
8285** name collisions include:
8286** <ul>
8287** <li> Put all identifier names inside double-quotes. This is the official
8288** SQL way to escape identifier names.
8289** <li> Put identifier names inside &#91;...&#93;. This is not standard SQL,
8290** but it is what SQL Server does and so lots of programmers use this
8291** technique.
8292** <li> Begin every identifier with the letter "Z" as no SQL keywords start
8293** with "Z".
8294** <li> Include a digit somewhere in every identifier name.
8295** </ul>
8297** Note that the number of keywords understood by SQLite can depend on
8298** compile-time options. For example, "VACUUM" is not a keyword if
8299** SQLite is compiled with the [-DSQLITE_OMIT_VACUUM] option. Also,
8300** new keywords may be added to future releases of SQLite.
8302SQLITE_API int sqlite3_keyword_count(void);
8303SQLITE_API int sqlite3_keyword_name(int,const char**,int*);
8304SQLITE_API int sqlite3_keyword_check(const char*,int);
8307** CAPI3REF: Dynamic String Object
8308** KEYWORDS: {dynamic string}
8310** An instance of the sqlite3_str object contains a dynamically-sized
8311** string under construction.
8313** The lifecycle of an sqlite3_str object is as follows:
8314** <ol>
8315** <li> ^The sqlite3_str object is created using [sqlite3_str_new()].
8316** <li> ^Text is appended to the sqlite3_str object using various
8317** methods, such as [sqlite3_str_appendf()].
8318** <li> ^The sqlite3_str object is destroyed and the string it created
8319** is returned using the [sqlite3_str_finish()] interface.
8320** </ol>
8322typedef struct sqlite3_str sqlite3_str;
8325** CAPI3REF: Create A New Dynamic String Object
8326** CONSTRUCTOR: sqlite3_str
8328** ^The [sqlite3_str_new(D)] interface allocates and initializes
8329** a new [sqlite3_str] object. To avoid memory leaks, the object returned by
8330** [sqlite3_str_new()] must be freed by a subsequent call to
8331** [sqlite3_str_finish(X)].
8333** ^The [sqlite3_str_new(D)] interface always returns a pointer to a
8334** valid [sqlite3_str] object, though in the event of an out-of-memory
8335** error the returned object might be a special singleton that will
8336** silently reject new text, always return SQLITE_NOMEM from
8337** [sqlite3_str_errcode()], always return 0 for
8338** [sqlite3_str_length()], and always return NULL from
8339** [sqlite3_str_finish(X)]. It is always safe to use the value
8340** returned by [sqlite3_str_new(D)] as the sqlite3_str parameter
8341** to any of the other [sqlite3_str] methods.
8343** The D parameter to [sqlite3_str_new(D)] may be NULL. If the
8344** D parameter in [sqlite3_str_new(D)] is not NULL, then the maximum
8345** length of the string contained in the [sqlite3_str] object will be
8346** the value set for [sqlite3_limit](D,[SQLITE_LIMIT_LENGTH]) instead
8347** of [SQLITE_MAX_LENGTH].
8349SQLITE_API sqlite3_str *sqlite3_str_new(sqlite3*);
8352** CAPI3REF: Finalize A Dynamic String
8353** DESTRUCTOR: sqlite3_str
8355** ^The [sqlite3_str_finish(X)] interface destroys the sqlite3_str object X
8356** and returns a pointer to a memory buffer obtained from [sqlite3_malloc64()]
8357** that contains the constructed string. The calling application should
8358** pass the returned value to [sqlite3_free()] to avoid a memory leak.
8359** ^The [sqlite3_str_finish(X)] interface may return a NULL pointer if any
8360** errors were encountered during construction of the string. ^The
8361** [sqlite3_str_finish(X)] interface will also return a NULL pointer if the
8362** string in [sqlite3_str] object X is zero bytes long.
8364SQLITE_API char *sqlite3_str_finish(sqlite3_str*);
8367** CAPI3REF: Add Content To A Dynamic String
8368** METHOD: sqlite3_str
8370** These interfaces add content to an sqlite3_str object previously obtained
8371** from [sqlite3_str_new()].
8373** ^The [sqlite3_str_appendf(X,F,...)] and
8374** [sqlite3_str_vappendf(X,F,V)] interfaces uses the [built-in printf]
8375** functionality of SQLite to append formatted text onto the end of
8376** [sqlite3_str] object X.
8378** ^The [sqlite3_str_append(X,S,N)] method appends exactly N bytes from string S
8379** onto the end of the [sqlite3_str] object X. N must be non-negative.
8380** S must contain at least N non-zero bytes of content. To append a
8381** zero-terminated string in its entirety, use the [sqlite3_str_appendall()]
8382** method instead.
8384** ^The [sqlite3_str_appendall(X,S)] method appends the complete content of
8385** zero-terminated string S onto the end of [sqlite3_str] object X.
8387** ^The [sqlite3_str_appendchar(X,N,C)] method appends N copies of the
8388** single-byte character C onto the end of [sqlite3_str] object X.
8389** ^This method can be used, for example, to add whitespace indentation.
8391** ^The [sqlite3_str_reset(X)] method resets the string under construction
8392** inside [sqlite3_str] object X back to zero bytes in length.
8394** These methods do not return a result code. ^If an error occurs, that fact
8395** is recorded in the [sqlite3_str] object and can be recovered by a
8396** subsequent call to [sqlite3_str_errcode(X)].
8398SQLITE_API void sqlite3_str_appendf(sqlite3_str*, const char *zFormat, ...);
8399SQLITE_API void sqlite3_str_vappendf(sqlite3_str*, const char *zFormat, va_list);
8400SQLITE_API void sqlite3_str_append(sqlite3_str*, const char *zIn, int N);
8401SQLITE_API void sqlite3_str_appendall(sqlite3_str*, const char *zIn);
8402SQLITE_API void sqlite3_str_appendchar(sqlite3_str*, int N, char C);
8403SQLITE_API void sqlite3_str_reset(sqlite3_str*);
8406** CAPI3REF: Status Of A Dynamic String
8407** METHOD: sqlite3_str
8409** These interfaces return the current status of an [sqlite3_str] object.
8411** ^If any prior errors have occurred while constructing the dynamic string
8412** in sqlite3_str X, then the [sqlite3_str_errcode(X)] method will return
8413** an appropriate error code. ^The [sqlite3_str_errcode(X)] method returns
8414** [SQLITE_NOMEM] following any out-of-memory error, or
8415** [SQLITE_TOOBIG] if the size of the dynamic string exceeds
8416** [SQLITE_MAX_LENGTH], or [SQLITE_OK] if there have been no errors.
8418** ^The [sqlite3_str_length(X)] method returns the current length, in bytes,
8419** of the dynamic string under construction in [sqlite3_str] object X.
8420** ^The length returned by [sqlite3_str_length(X)] does not include the
8421** zero-termination byte.
8423** ^The [sqlite3_str_value(X)] method returns a pointer to the current
8424** content of the dynamic string under construction in X. The value
8425** returned by [sqlite3_str_value(X)] is managed by the sqlite3_str object X
8426** and might be freed or altered by any subsequent method on the same
8427** [sqlite3_str] object. Applications must not used the pointer returned
8428** [sqlite3_str_value(X)] after any subsequent method call on the same
8429** object. ^Applications may change the content of the string returned
8430** by [sqlite3_str_value(X)] as long as they do not write into any bytes
8431** outside the range of 0 to [sqlite3_str_length(X)] and do not read or
8432** write any byte after any subsequent sqlite3_str method call.
8434SQLITE_API int sqlite3_str_errcode(sqlite3_str*);
8435SQLITE_API int sqlite3_str_length(sqlite3_str*);
8436SQLITE_API char *sqlite3_str_value(sqlite3_str*);
8439** CAPI3REF: SQLite Runtime Status
8441** ^These interfaces are used to retrieve runtime status information
8442** about the performance of SQLite, and optionally to reset various
8443** highwater marks. ^The first argument is an integer code for
8444** the specific parameter to measure. ^(Recognized integer codes
8445** are of the form [status parameters | SQLITE_STATUS_...].)^
8446** ^The current value of the parameter is returned into *pCurrent.
8447** ^The highest recorded value is returned in *pHighwater. ^If the
8448** resetFlag is true, then the highest record value is reset after
8449** *pHighwater is written. ^(Some parameters do not record the highest
8450** value. For those parameters
8451** nothing is written into *pHighwater and the resetFlag is ignored.)^
8452** ^(Other parameters record only the highwater mark and not the current
8453** value. For these latter parameters nothing is written into *pCurrent.)^
8455** ^The sqlite3_status() and sqlite3_status64() routines return
8456** SQLITE_OK on success and a non-zero [error code] on failure.
8458** If either the current value or the highwater mark is too large to
8459** be represented by a 32-bit integer, then the values returned by
8460** sqlite3_status() are undefined.
8462** See also: [sqlite3_db_status()]
8464SQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag);
8465SQLITE_API int sqlite3_status64(
8466 int op,
8467 sqlite3_int64 *pCurrent,
8468 sqlite3_int64 *pHighwater,
8469 int resetFlag
8474** CAPI3REF: Status Parameters
8475** KEYWORDS: {status parameters}
8477** These integer constants designate various run-time status parameters
8478** that can be returned by [sqlite3_status()].
8480** <dl>
8482** <dd>This parameter is the current amount of memory checked out
8483** using [sqlite3_malloc()], either directly or indirectly. The
8484** figure includes calls made to [sqlite3_malloc()] by the application
8485** and internal memory usage by the SQLite library. Auxiliary page-cache
8486** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in
8487** this parameter. The amount returned is the sum of the allocation
8488** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^
8491** <dd>This parameter records the largest memory allocation request
8492** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their
8493** internal equivalents). Only the value returned in the
8494** *pHighwater parameter to [sqlite3_status()] is of interest.
8495** The value written into the *pCurrent parameter is undefined.</dd>)^
8498** <dd>This parameter records the number of separate memory allocations
8499** currently checked out.</dd>)^
8502** <dd>This parameter returns the number of pages used out of the
8503** [pagecache memory allocator] that was configured using
8505** value returned is in pages, not in bytes.</dd>)^
8509** <dd>This parameter returns the number of bytes of page cache
8510** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE]
8511** buffer and where forced to overflow to [sqlite3_malloc()]. The
8512** returned value includes allocations that overflowed because they
8513** where too large (they were larger than the "sz" parameter to
8514** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because
8515** no space was left in the page cache.</dd>)^
8518** <dd>This parameter records the largest memory allocation request
8519** handed to the [pagecache memory allocator]. Only the value returned in the
8520** *pHighwater parameter to [sqlite3_status()] is of interest.
8521** The value written into the *pCurrent parameter is undefined.</dd>)^
8524** <dd>No longer used.</dd>
8527** <dd>No longer used.</dd>
8530** <dd>No longer used.</dd>
8533** <dd>The *pHighwater parameter records the deepest parser stack.
8534** The *pCurrent value is undefined. The *pHighwater value is only
8535** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^
8536** </dl>
8538** New status parameters may be added from time to time.
8552** CAPI3REF: Database Connection Status
8553** METHOD: sqlite3
8555** ^This interface is used to retrieve runtime status information
8556** about a single [database connection]. ^The first argument is the
8557** database connection object to be interrogated. ^The second argument
8558** is an integer constant, taken from the set of
8559** [SQLITE_DBSTATUS options], that
8560** determines the parameter to interrogate. The set of
8561** [SQLITE_DBSTATUS options] is likely
8562** to grow in future releases of SQLite.
8564** ^The current value of the requested parameter is written into *pCur
8565** and the highest instantaneous value is written into *pHiwtr. ^If
8566** the resetFlg is true, then the highest instantaneous value is
8567** reset back down to the current value.
8569** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a
8570** non-zero [error code] on failure.
8572** See also: [sqlite3_status()] and [sqlite3_stmt_status()].
8574SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg);
8577** CAPI3REF: Status Parameters for database connections
8580** These constants are the available integer "verbs" that can be passed as
8581** the second argument to the [sqlite3_db_status()] interface.
8583** New verbs may be added in future releases of SQLite. Existing verbs
8584** might be discontinued. Applications should check the return code from
8585** [sqlite3_db_status()] to make sure that the call worked.
8586** The [sqlite3_db_status()] interface will return a non-zero error code
8587** if a discontinued or unsupported verb is invoked.
8589** <dl>
8591** <dd>This parameter returns the number of lookaside memory slots currently
8592** checked out.</dd>)^
8595** <dd>This parameter returns the number of malloc attempts that were
8596** satisfied using lookaside memory. Only the high-water value is meaningful;
8597** the current value is always zero.)^
8601** <dd>This parameter returns the number malloc attempts that might have
8602** been satisfied using lookaside memory but failed due to the amount of
8603** memory requested being larger than the lookaside slot size.
8604** Only the high-water value is meaningful;
8605** the current value is always zero.)^
8609** <dd>This parameter returns the number malloc attempts that might have
8610** been satisfied using lookaside memory but failed due to all lookaside
8611** memory already being in use.
8612** Only the high-water value is meaningful;
8613** the current value is always zero.)^
8616** <dd>This parameter returns the approximate number of bytes of heap
8617** memory used by all pager caches associated with the database connection.)^
8618** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0.
8622** <dd>This parameter is similar to DBSTATUS_CACHE_USED, except that if a
8623** pager cache is shared between two or more connections the bytes of heap
8624** memory used by that pager cache is divided evenly between the attached
8625** connections.)^ In other words, if none of the pager caches associated
8626** with the database connection are shared, this request returns the same
8627** value as DBSTATUS_CACHE_USED. Or, if one or more or the pager caches are
8628** shared, the value returned by this call will be smaller than that returned
8629** by DBSTATUS_CACHE_USED. ^The highwater mark associated with
8633** <dd>This parameter returns the approximate number of bytes of heap
8634** memory used to store the schema for all databases associated
8635** with the connection - main, temp, and any [ATTACH]-ed databases.)^
8636** ^The full amount of memory used by the schemas is reported, even if the
8637** schema memory is shared with other database connections due to
8638** [shared cache mode] being enabled.
8639** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0.
8642** <dd>This parameter returns the approximate number of bytes of heap
8643** and lookaside memory used by all prepared statements associated with
8644** the database connection.)^
8645** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0.
8646** </dd>
8649** <dd>This parameter returns the number of pager cache hits that have
8650** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT
8651** is always 0.
8652** </dd>
8655** <dd>This parameter returns the number of pager cache misses that have
8656** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS
8657** is always 0.
8658** </dd>
8661** <dd>This parameter returns the number of dirty cache entries that have
8662** been written to disk. Specifically, the number of pages written to the
8663** wal file in wal mode databases, or the number of pages written to the
8664** database file in rollback mode databases. Any pages written as part of
8665** transaction rollback or database recovery operations are not included.
8666** If an IO or other error occurs while writing a page to disk, the effect
8667** on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined.)^ ^The
8668** highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0.
8669** </dd>
8672** <dd>This parameter returns the number of dirty cache entries that have
8673** been written to disk in the middle of a transaction due to the page
8674** cache overflowing. Transactions are more efficient if they are written
8675** to disk all at once. When pages spill mid-transaction, that introduces
8676** additional overhead. This parameter can be used help