Commit MetaInfo

Revision344b9ac97ba5edabd4f9414cce81dbb9c29cf440 (tree)
Time2019-11-09 04:37:09
Author <Kuddel@c0f5...>

Log Message

- added 'build-tools' branch.
- added sources for over.exe

Change Summary

Incremental Difference

diff -r 000000000000 -r 344b9ac97ba5 src/over/over_vs2015.sln
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/over/over_vs2015.sln Fri Nov 08 19:37:09 2019 +0000
@@ -0,0 +1,20 @@
2+Microsoft Visual Studio Solution File, Format Version 11.00
3+# Visual C++ Express 2010
4+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "over", "src\over_vs2015.vcxproj", "{0B23C799-196D-475B-8AF4-B2D0C1194FFD}"
7+ GlobalSection(SolutionConfigurationPlatforms) = preSolution
8+ Debug|Win32 = Debug|Win32
9+ Release|Win32 = Release|Win32
10+ EndGlobalSection
11+ GlobalSection(ProjectConfigurationPlatforms) = postSolution
12+ {0B23C799-196D-475B-8AF4-B2D0C1194FFD}.Debug|Win32.ActiveCfg = Debug|Win32
13+ {0B23C799-196D-475B-8AF4-B2D0C1194FFD}.Debug|Win32.Build.0 = Debug|Win32
14+ {0B23C799-196D-475B-8AF4-B2D0C1194FFD}.Release|Win32.ActiveCfg = Release|Win32
15+ {0B23C799-196D-475B-8AF4-B2D0C1194FFD}.Release|Win32.Build.0 = Release|Win32
16+ EndGlobalSection
17+ GlobalSection(SolutionProperties) = preSolution
18+ HideSolutionNode = FALSE
19+ EndGlobalSection
diff -r 000000000000 -r 344b9ac97ba5 src/over/sqlite/sqlite3.c
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/over/sqlite/sqlite3.c Fri Nov 08 19:37:09 2019 +0000
@@ -0,0 +1,186041 @@
2+** This file is an amalgamation of many separate C source files from SQLite
3+** version 3.10.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_
44+** Include the header file used to customize the compiler options for MSVC.
45+** This should be done first so that it can successfully prevent spurious
46+** compiler warnings due to subsequent content in this file and other files
47+** that are included by this file.
49+/************** Include msvc.h in the middle of sqliteInt.h ******************/
50+/************** Begin file msvc.h ********************************************/
52+** 2015 January 12
54+** The author disclaims copyright to this source code. In place of
55+** a legal notice, here is a blessing:
57+** May you do good and not evil.
58+** May you find forgiveness for yourself and forgive others.
59+** May you share freely, never taking more than you give.
63+** This file contains code that is specific to MSVC.
65+#ifndef _MSVC_H_
66+#define _MSVC_H_
68+#if defined(_MSC_VER)
69+#pragma warning(disable : 4054)
70+#pragma warning(disable : 4055)
71+#pragma warning(disable : 4100)
72+#pragma warning(disable : 4127)
73+#pragma warning(disable : 4130)
74+#pragma warning(disable : 4152)
75+#pragma warning(disable : 4189)
76+#pragma warning(disable : 4206)
77+#pragma warning(disable : 4210)
78+#pragma warning(disable : 4232)
79+#pragma warning(disable : 4244)
80+#pragma warning(disable : 4305)
81+#pragma warning(disable : 4306)
82+#pragma warning(disable : 4702)
83+#pragma warning(disable : 4706)
84+#endif /* defined(_MSC_VER) */
86+#endif /* _MSVC_H_ */
88+/************** End of msvc.h ************************************************/
89+/************** Continuing where we left off in sqliteInt.h ******************/
92+** Special setup for VxWorks
94+/************** Include vxworks.h in the middle of sqliteInt.h ***************/
95+/************** Begin file vxworks.h *****************************************/
97+** 2015-03-02
99+** The author disclaims copyright to this source code. In place of
100+** a legal notice, here is a blessing:
102+** May you do good and not evil.
103+** May you find forgiveness for yourself and forgive others.
104+** May you share freely, never taking more than you give.
108+** This file contains code that is specific to Wind River's VxWorks
110+#if defined(__RTP__) || defined(_WRS_KERNEL)
111+/* This is VxWorks. Set up things specially for that OS
113+#include <vxWorks.h>
114+#include <pthread.h> /* amalgamator: dontcache */
115+#define OS_VXWORKS 1
116+#define SQLITE_OS_OTHER 0
120+#define HAVE_UTIME 1
122+/* This is not VxWorks. */
123+#define OS_VXWORKS 0
124+#endif /* defined(_WRS_KERNEL) */
126+/************** End of vxworks.h *********************************************/
127+/************** Continuing where we left off in sqliteInt.h ******************/
130+** These #defines should enable >2GB file support on POSIX if the
131+** underlying operating system supports it. If the OS lacks
132+** large file support, or if the OS is windows, these should be no-ops.
134+** Ticket #2739: The _LARGEFILE_SOURCE macro must appear before any
135+** system #includes. Hence, this block of code must be the very first
136+** code in all source files.
138+** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
139+** on the compiler command line. This is necessary if you are compiling
140+** on a recent machine (ex: Red Hat 7.2) but you want your code to work
141+** on an older machine (ex: Red Hat 6.0). If you compile on Red Hat 7.2
142+** without this option, LFS is enable. But LFS does not exist in the kernel
143+** in Red Hat 6.0, so the code won't work. Hence, for maximum binary
144+** portability you should omit LFS.
146+** The previous paragraph was written in 2005. (This paragraph is written
147+** on 2008-11-28.) These days, all Linux kernels support large files, so
148+** you should probably leave LFS enabled. But some embedded platforms might
149+** lack LFS in which case the SQLITE_DISABLE_LFS macro might still be useful.
151+** Similar is true for Mac OS X. LFS is only supported on Mac OS X 9 and later.
154+# define _LARGE_FILE 1
155+# ifndef _FILE_OFFSET_BITS
156+# define _FILE_OFFSET_BITS 64
157+# endif
158+# define _LARGEFILE_SOURCE 1
161+/* What version of GCC is being used. 0 means GCC is not being used */
162+#ifdef __GNUC__
163+# define GCC_VERSION (__GNUC__*1000000+__GNUC_MINOR__*1000+__GNUC_PATCHLEVEL__)
165+# define GCC_VERSION 0
168+/* Needed for various definitions... */
169+#if defined(__GNUC__) && !defined(_GNU_SOURCE)
170+# define _GNU_SOURCE
173+#if defined(__OpenBSD__) && !defined(_BSD_SOURCE)
174+# define _BSD_SOURCE
178+** For MinGW, check to see if we can include the header file containing its
179+** version information, among other things. Normally, this internal MinGW
180+** header file would [only] be included automatically by other MinGW header
181+** files; however, the contained version information is now required by this
182+** header file to work around binary compatibility issues (see below) and
183+** this is the only known way to reliably obtain it. This entire #if block
184+** would be completely unnecessary if there was any other way of detecting
185+** MinGW via their preprocessor (e.g. if they customized their GCC to define
186+** some MinGW-specific macros). When compiling for MinGW, either the
187+** _HAVE_MINGW_H or _HAVE__MINGW_H (note the extra underscore) macro must be
188+** defined; otherwise, detection of conditions specific to MinGW will be
189+** disabled.
191+#if defined(_HAVE_MINGW_H)
192+# include "mingw.h"
193+#elif defined(_HAVE__MINGW_H)
194+# include "_mingw.h"
198+** For MinGW version 4.x (and higher), check to see if the _USE_32BIT_TIME_T
199+** define is required to maintain binary compatibility with the MSVC runtime
200+** library in use (e.g. for Windows XP).
202+#if !defined(_USE_32BIT_TIME_T) && !defined(_USE_64BIT_TIME_T) && \
203+ defined(_WIN32) && !defined(_WIN64) && \
204+ defined(__MINGW_MAJOR_VERSION) && __MINGW_MAJOR_VERSION >= 4 && \
205+ defined(__MSVCRT__)
206+# define _USE_32BIT_TIME_T
209+/* The public SQLite interface. The _FILE_OFFSET_BITS macro must appear
210+** first in QNX. Also, the _USE_32BIT_TIME_T macro must appear first for
211+** MinGW.
213+/************** Include sqlite3.h in the middle of sqliteInt.h ***************/
214+/************** Begin file sqlite3.h *****************************************/
216+** 2001 September 15
218+** The author disclaims copyright to this source code. In place of
219+** a legal notice, here is a blessing:
221+** May you do good and not evil.
222+** May you find forgiveness for yourself and forgive others.
223+** May you share freely, never taking more than you give.
226+** This header file defines the interface that the SQLite library
227+** presents to client programs. If a C-function, structure, datatype,
228+** or constant definition does not appear in this file, then it is
229+** not a published API of SQLite, is subject to change without
230+** notice, and should not be referenced by programs that use SQLite.
232+** Some of the definitions that are in this file are marked as
233+** "experimental". Experimental interfaces are normally new
234+** features recently added to SQLite. We do not anticipate changes
235+** to experimental interfaces but reserve the right to make minor changes
236+** if experience from use "in the wild" suggest such changes are prudent.
238+** The official C-language API documentation for SQLite is derived
239+** from comments in this file. This file is the authoritative source
240+** on how SQLite interfaces are supposed to operate.
242+** The name of this file under configuration management is "".
243+** The makefile makes some minor changes to this file (such as inserting
244+** the version number) and changes its name to "sqlite3.h" as
245+** part of the build process.
247+#ifndef _SQLITE3_H_
248+#define _SQLITE3_H_
249+#include <stdarg.h> /* Needed for the definition of va_list */
252+** Make sure we can call this stuff from C++.
254+#if 0
255+extern "C" {
260+** Provide the ability to override linkage features of the interface.
262+#ifndef SQLITE_EXTERN
263+# define SQLITE_EXTERN extern
265+#ifndef SQLITE_API
266+# define SQLITE_API
268+#ifndef SQLITE_CDECL
269+# define SQLITE_CDECL
271+#ifndef SQLITE_STDCALL
272+# define SQLITE_STDCALL
276+** These no-op macros are used in front of interfaces to mark those
277+** interfaces as either deprecated or experimental. New applications
278+** should not use deprecated interfaces - they are supported for backwards
279+** compatibility only. Application writers should be aware that
280+** experimental interfaces are subject to change in point releases.
282+** These macros used to resolve to various kinds of compiler magic that
283+** would generate warning messages when they were used. But that
284+** compiler magic ended up generating such a flurry of bug reports
285+** that we have taken it all out and gone back to using simple
286+** noop macros.
292+** Ensure these symbols were not defined by some previous header file.
295+# undef SQLITE_VERSION
302+** CAPI3REF: Compile-Time Library Version Numbers
304+** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header
305+** evaluates to a string literal that is the SQLite version in the
306+** format "X.Y.Z" where X is the major version number (always 3 for
307+** SQLite3) and Y is the minor version number and Z is the release number.)^
308+** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer
309+** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z are the same
310+** numbers used in [SQLITE_VERSION].)^
311+** The SQLITE_VERSION_NUMBER for any given release of SQLite will also
312+** be larger than the release from which it is derived. Either Y will
313+** be held constant and Z will be incremented or else Y will be incremented
314+** and Z will be reset to zero.
316+** Since version 3.6.18, SQLite source code has been stored in the
317+** <a href="">Fossil configuration management
318+** system</a>. ^The SQLITE_SOURCE_ID macro evaluates to
319+** a string which identifies a particular check-in of SQLite
320+** within its configuration management system. ^The SQLITE_SOURCE_ID
321+** string contains the date and time of the check-in (UTC) and an SHA1
322+** hash of the entire source tree.
324+** See also: [sqlite3_libversion()],
325+** [sqlite3_libversion_number()], [sqlite3_sourceid()],
326+** [sqlite_version()] and [sqlite_source_id()].
328+#define SQLITE_VERSION "3.10.2"
329+#define SQLITE_VERSION_NUMBER 3010002
330+#define SQLITE_SOURCE_ID "2016-01-20 15:27:19 17efb4209f97fb4971656086b138599a91a75ff9"
333+** CAPI3REF: Run-Time Library Version Numbers
334+** KEYWORDS: sqlite3_version, sqlite3_sourceid
336+** These interfaces provide the same information as the [SQLITE_VERSION],
337+** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros
338+** but are associated with the library instead of the header file. ^(Cautious
339+** programmers might include assert() statements in their application to
340+** verify that values returned by these interfaces match the macros in
341+** the header, and thus ensure that the application is
342+** compiled with matching library and header files.
344+** <blockquote><pre>
345+** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER );
346+** assert( strcmp(sqlite3_sourceid(),SQLITE_SOURCE_ID)==0 );
347+** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 );
348+** </pre></blockquote>)^
350+** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION]
351+** macro. ^The sqlite3_libversion() function returns a pointer to the
352+** to the sqlite3_version[] string constant. The sqlite3_libversion()
353+** function is provided for use in DLLs since DLL users usually do not have
354+** direct access to string constants within the DLL. ^The
355+** sqlite3_libversion_number() function returns an integer equal to
356+** [SQLITE_VERSION_NUMBER]. ^The sqlite3_sourceid() function returns
357+** a pointer to a string constant whose value is the same as the
358+** [SQLITE_SOURCE_ID] C preprocessor macro.
360+** See also: [sqlite_version()] and [sqlite_source_id()].
362+SQLITE_API const char sqlite3_version[] = SQLITE_VERSION;
363+SQLITE_API const char *SQLITE_STDCALL sqlite3_libversion(void);
364+SQLITE_API const char *SQLITE_STDCALL sqlite3_sourceid(void);
365+SQLITE_API int SQLITE_STDCALL sqlite3_libversion_number(void);
368+** CAPI3REF: Run-Time Library Compilation Options Diagnostics
370+** ^The sqlite3_compileoption_used() function returns 0 or 1
371+** indicating whether the specified option was defined at
372+** compile time. ^The SQLITE_ prefix may be omitted from the
373+** option name passed to sqlite3_compileoption_used().
375+** ^The sqlite3_compileoption_get() function allows iterating
376+** over the list of options that were defined at compile time by
377+** returning the N-th compile time option string. ^If N is out of range,
378+** sqlite3_compileoption_get() returns a NULL pointer. ^The SQLITE_
379+** prefix is omitted from any strings returned by
380+** sqlite3_compileoption_get().
382+** ^Support for the diagnostic functions sqlite3_compileoption_used()
383+** and sqlite3_compileoption_get() may be omitted by specifying the
384+** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time.
386+** See also: SQL functions [sqlite_compileoption_used()] and
387+** [sqlite_compileoption_get()] and the [compile_options pragma].
390+SQLITE_API int SQLITE_STDCALL sqlite3_compileoption_used(const char *zOptName);
391+SQLITE_API const char *SQLITE_STDCALL sqlite3_compileoption_get(int N);
395+** CAPI3REF: Test To See If The Library Is Threadsafe
397+** ^The sqlite3_threadsafe() function returns zero if and only if
398+** SQLite was compiled with mutexing code omitted due to the
399+** [SQLITE_THREADSAFE] compile-time option being set to 0.
401+** SQLite can be compiled with or without mutexes. When
402+** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes
403+** are enabled and SQLite is threadsafe. When the
404+** [SQLITE_THREADSAFE] macro is 0,
405+** the mutexes are omitted. Without the mutexes, it is not safe
406+** to use SQLite concurrently from more than one thread.
408+** Enabling mutexes incurs a measurable performance penalty.
409+** So if speed is of utmost importance, it makes sense to disable
410+** the mutexes. But for maximum safety, mutexes should be enabled.
411+** ^The default behavior is for mutexes to be enabled.
413+** This interface can be used by an application to make sure that the
414+** version of SQLite that it is linking against was compiled with
415+** the desired setting of the [SQLITE_THREADSAFE] macro.
417+** This interface only reports on the compile-time mutex setting
418+** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with
419+** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but
420+** can be fully or partially disabled using a call to [sqlite3_config()]
422+** or [SQLITE_CONFIG_SERIALIZED]. ^(The return value of the
423+** sqlite3_threadsafe() function shows only the compile-time setting of
424+** thread safety, not any run-time changes to that setting made by
425+** sqlite3_config(). In other words, the return value from sqlite3_threadsafe()
426+** is unchanged by calls to sqlite3_config().)^
428+** See the [threading mode] documentation for additional information.
430+SQLITE_API int SQLITE_STDCALL sqlite3_threadsafe(void);
433+** CAPI3REF: Database Connection Handle
434+** KEYWORDS: {database connection} {database connections}
436+** Each open SQLite database is represented by a pointer to an instance of
437+** the opaque structure named "sqlite3". It is useful to think of an sqlite3
438+** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and
439+** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()]
440+** and [sqlite3_close_v2()] are its destructors. There are many other
441+** interfaces (such as
442+** [sqlite3_prepare_v2()], [sqlite3_create_function()], and
443+** [sqlite3_busy_timeout()] to name but three) that are methods on an
444+** sqlite3 object.
446+typedef struct sqlite3 sqlite3;
449+** CAPI3REF: 64-Bit Integer Types
450+** KEYWORDS: sqlite_int64 sqlite_uint64
452+** Because there is no cross-platform way to specify 64-bit integer types
453+** SQLite includes typedefs for 64-bit signed and unsigned integers.
455+** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions.
456+** The sqlite_int64 and sqlite_uint64 types are supported for backwards
457+** compatibility only.
459+** ^The sqlite3_int64 and sqlite_int64 types can store integer values
460+** between -9223372036854775808 and +9223372036854775807 inclusive. ^The
461+** sqlite3_uint64 and sqlite_uint64 types can store integer values
462+** between 0 and +18446744073709551615 inclusive.
464+#ifdef SQLITE_INT64_TYPE
465+ typedef SQLITE_INT64_TYPE sqlite_int64;
466+ typedef unsigned SQLITE_INT64_TYPE sqlite_uint64;
467+#elif defined(_MSC_VER) || defined(__BORLANDC__)
468+ typedef __int64 sqlite_int64;
469+ typedef unsigned __int64 sqlite_uint64;
471+ typedef long long int sqlite_int64;
472+ typedef unsigned long long int sqlite_uint64;
474+typedef sqlite_int64 sqlite3_int64;
475+typedef sqlite_uint64 sqlite3_uint64;
478+** If compiling for a processor that lacks floating point support,
479+** substitute integer for floating-point.
482+# define double sqlite3_int64
486+** CAPI3REF: Closing A Database Connection
487+** DESTRUCTOR: sqlite3
489+** ^The sqlite3_close() and sqlite3_close_v2() routines are destructors
490+** for the [sqlite3] object.
491+** ^Calls to sqlite3_close() and sqlite3_close_v2() return [SQLITE_OK] if
492+** the [sqlite3] object is successfully destroyed and all associated
493+** resources are deallocated.
495+** ^If the database connection is associated with unfinalized prepared
496+** statements or unfinished sqlite3_backup objects then sqlite3_close()
497+** will leave the database connection open and return [SQLITE_BUSY].
498+** ^If sqlite3_close_v2() is called with unfinalized prepared statements
499+** and/or unfinished sqlite3_backups, then the database connection becomes
500+** an unusable "zombie" which will automatically be deallocated when the
501+** last prepared statement is finalized or the last sqlite3_backup is
502+** finished. The sqlite3_close_v2() interface is intended for use with
503+** host languages that are garbage collected, and where the order in which
504+** destructors are called is arbitrary.
506+** Applications should [sqlite3_finalize | finalize] all [prepared statements],
507+** [sqlite3_blob_close | close] all [BLOB handles], and
508+** [sqlite3_backup_finish | finish] all [sqlite3_backup] objects associated
509+** with the [sqlite3] object prior to attempting to close the object. ^If
510+** sqlite3_close_v2() is called on a [database connection] that still has
511+** outstanding [prepared statements], [BLOB handles], and/or
512+** [sqlite3_backup] objects then it returns [SQLITE_OK] and the deallocation
513+** of resources is deferred until all [prepared statements], [BLOB handles],
514+** and [sqlite3_backup] objects are also destroyed.
516+** ^If an [sqlite3] object is destroyed while a transaction is open,
517+** the transaction is automatically rolled back.
519+** The C parameter to [sqlite3_close(C)] and [sqlite3_close_v2(C)]
520+** must be either a NULL
521+** pointer or an [sqlite3] object pointer obtained
522+** from [sqlite3_open()], [sqlite3_open16()], or
523+** [sqlite3_open_v2()], and not previously closed.
524+** ^Calling sqlite3_close() or sqlite3_close_v2() with a NULL pointer
525+** argument is a harmless no-op.
527+SQLITE_API int SQLITE_STDCALL sqlite3_close(sqlite3*);
528+SQLITE_API int SQLITE_STDCALL sqlite3_close_v2(sqlite3*);
531+** The type for a callback function.
532+** This is legacy and deprecated. It is included for historical
533+** compatibility and is not documented.
535+typedef int (*sqlite3_callback)(void*,int,char**, char**);
538+** CAPI3REF: One-Step Query Execution Interface
539+** METHOD: sqlite3
541+** The sqlite3_exec() interface is a convenience wrapper around
542+** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()],
543+** that allows an application to run multiple statements of SQL
544+** without having to use a lot of C code.
546+** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded,
547+** semicolon-separate SQL statements passed into its 2nd argument,
548+** in the context of the [database connection] passed in as its 1st
549+** argument. ^If the callback function of the 3rd argument to
550+** sqlite3_exec() is not NULL, then it is invoked for each result row
551+** coming out of the evaluated SQL statements. ^The 4th argument to
552+** sqlite3_exec() is relayed through to the 1st argument of each
553+** callback invocation. ^If the callback pointer to sqlite3_exec()
554+** is NULL, then no callback is ever invoked and result rows are
555+** ignored.
557+** ^If an error occurs while evaluating the SQL statements passed into
558+** sqlite3_exec(), then execution of the current statement stops and
559+** subsequent statements are skipped. ^If the 5th parameter to sqlite3_exec()
560+** is not NULL then any error message is written into memory obtained
561+** from [sqlite3_malloc()] and passed back through the 5th parameter.
562+** To avoid memory leaks, the application should invoke [sqlite3_free()]
563+** on error message strings returned through the 5th parameter of
564+** of sqlite3_exec() after the error message string is no longer needed.
565+** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors
566+** occur, then sqlite3_exec() sets the pointer in its 5th parameter to
567+** NULL before returning.
569+** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec()
570+** routine returns SQLITE_ABORT without invoking the callback again and
571+** without running any subsequent SQL statements.
573+** ^The 2nd argument to the sqlite3_exec() callback function is the
574+** number of columns in the result. ^The 3rd argument to the sqlite3_exec()
575+** callback is an array of pointers to strings obtained as if from
576+** [sqlite3_column_text()], one for each column. ^If an element of a
577+** result row is NULL then the corresponding string pointer for the
578+** sqlite3_exec() callback is a NULL pointer. ^The 4th argument to the
579+** sqlite3_exec() callback is an array of pointers to strings where each
580+** entry represents the name of corresponding result column as obtained
581+** from [sqlite3_column_name()].
583+** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer
584+** to an empty string, or a pointer that contains only whitespace and/or
585+** SQL comments, then no SQL statements are evaluated and the database
586+** is not changed.
588+** Restrictions:
590+** <ul>
591+** <li> The application must ensure that the 1st parameter to sqlite3_exec()
592+** is a valid and open [database connection].
593+** <li> The application must not close the [database connection] specified by
594+** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running.
595+** <li> The application must not modify the SQL statement text passed into
596+** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running.
597+** </ul>
599+SQLITE_API int SQLITE_STDCALL sqlite3_exec(
600+ sqlite3*, /* An open database */
601+ const char *sql, /* SQL to be evaluated */
602+ int (*callback)(void*,int,char**,char**), /* Callback function */
603+ void *, /* 1st argument to callback */
604+ char **errmsg /* Error msg written here */
608+** CAPI3REF: Result Codes
609+** KEYWORDS: {result code definitions}
611+** Many SQLite functions return an integer result code from the set shown
612+** here in order to indicate success or failure.
614+** New error codes may be added in future versions of SQLite.
616+** See also: [extended result code definitions]
618+#define SQLITE_OK 0 /* Successful result */
619+/* beginning-of-error-codes */
620+#define SQLITE_ERROR 1 /* SQL error or missing database */
621+#define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */
622+#define SQLITE_PERM 3 /* Access permission denied */
623+#define SQLITE_ABORT 4 /* Callback routine requested an abort */
624+#define SQLITE_BUSY 5 /* The database file is locked */
625+#define SQLITE_LOCKED 6 /* A table in the database is locked */
626+#define SQLITE_NOMEM 7 /* A malloc() failed */
627+#define SQLITE_READONLY 8 /* Attempt to write a readonly database */
628+#define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/
629+#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */
630+#define SQLITE_CORRUPT 11 /* The database disk image is malformed */
631+#define SQLITE_NOTFOUND 12 /* Unknown opcode in sqlite3_file_control() */
632+#define SQLITE_FULL 13 /* Insertion failed because database is full */
633+#define SQLITE_CANTOPEN 14 /* Unable to open the database file */
634+#define SQLITE_PROTOCOL 15 /* Database lock protocol error */
635+#define SQLITE_EMPTY 16 /* Database is empty */
636+#define SQLITE_SCHEMA 17 /* The database schema changed */
637+#define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */
638+#define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */
639+#define SQLITE_MISMATCH 20 /* Data type mismatch */
640+#define SQLITE_MISUSE 21 /* Library used incorrectly */
641+#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */
642+#define SQLITE_AUTH 23 /* Authorization denied */
643+#define SQLITE_FORMAT 24 /* Auxiliary database format error */
644+#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */
645+#define SQLITE_NOTADB 26 /* File opened that is not a database file */
646+#define SQLITE_NOTICE 27 /* Notifications from sqlite3_log() */
647+#define SQLITE_WARNING 28 /* Warnings from sqlite3_log() */
648+#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */
649+#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */
650+/* end-of-error-codes */
653+** CAPI3REF: Extended Result Codes
654+** KEYWORDS: {extended result code definitions}
656+** In its default configuration, SQLite API routines return one of 30 integer
657+** [result codes]. However, experience has shown that many of
658+** these result codes are too coarse-grained. They do not provide as
659+** much information about problems as programmers might like. In an effort to
660+** address this, newer versions of SQLite (version 3.3.8 and later) include
661+** support for additional result codes that provide more detailed information
662+** about errors. These [extended result codes] are enabled or disabled
663+** on a per database connection basis using the
664+** [sqlite3_extended_result_codes()] API. Or, the extended code for
665+** the most recent error can be obtained using
666+** [sqlite3_extended_errcode()].
668+#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8))
670+#define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8))
671+#define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8))
674+#define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8))
677+#define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8))
679+#define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8))
680+#define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8))
682+#define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8))
683+#define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8))
688+#define SQLITE_IOERR_SHMMAP (SQLITE_IOERR | (21<<8))
689+#define SQLITE_IOERR_SEEK (SQLITE_IOERR | (22<<8))
691+#define SQLITE_IOERR_MMAP (SQLITE_IOERR | (24<<8))
694+#define SQLITE_IOERR_VNODE (SQLITE_IOERR | (27<<8))
695+#define SQLITE_IOERR_AUTH (SQLITE_IOERR | (28<<8))
722+#define SQLITE_AUTH_USER (SQLITE_AUTH | (1<<8))
725+** CAPI3REF: Flags For File Open Operations
727+** These bit values are intended for use in the
728+** 3rd parameter to the [sqlite3_open_v2()] interface and
729+** in the 4th parameter to the [sqlite3_vfs.xOpen] method.
731+#define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */
732+#define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */
733+#define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */
734+#define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */
735+#define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */
736+#define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */
737+#define SQLITE_OPEN_URI 0x00000040 /* Ok for sqlite3_open_v2() */
738+#define SQLITE_OPEN_MEMORY 0x00000080 /* Ok for sqlite3_open_v2() */
739+#define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */
740+#define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */
741+#define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */
742+#define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */
743+#define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */
744+#define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */
745+#define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */
746+#define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */
747+#define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */
748+#define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */
749+#define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */
750+#define SQLITE_OPEN_WAL 0x00080000 /* VFS only */
752+/* Reserved: 0x00F00000 */
755+** CAPI3REF: Device Characteristics
757+** The xDeviceCharacteristics method of the [sqlite3_io_methods]
758+** object returns an integer which is a vector of these
759+** bit values expressing I/O characteristics of the mass storage
760+** device that holds the file that the [sqlite3_io_methods]
761+** refers to.
763+** The SQLITE_IOCAP_ATOMIC property means that all writes of
764+** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
765+** mean that writes of blocks that are nnn bytes in size and
766+** are aligned to an address which is an integer multiple of
767+** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
768+** that when data is appended to a file, the data is appended
769+** first then the size of the file is extended, never the other
770+** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
771+** information is written to disk in the same order as calls
772+** to xWrite(). The SQLITE_IOCAP_POWERSAFE_OVERWRITE property means that
773+** after reboot following a crash or power loss, the only bytes in a
774+** file that were written at the application level might have changed
775+** and that adjacent bytes, even bytes within the same sector are
776+** guaranteed to be unchanged. The SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN
777+** flag indicate that a file cannot be deleted when open. The
778+** SQLITE_IOCAP_IMMUTABLE flag indicates that the file is on
779+** read-only media and cannot be changed even by processes with
780+** elevated privileges.
782+#define SQLITE_IOCAP_ATOMIC 0x00000001
783+#define SQLITE_IOCAP_ATOMIC512 0x00000002
784+#define SQLITE_IOCAP_ATOMIC1K 0x00000004
785+#define SQLITE_IOCAP_ATOMIC2K 0x00000008
786+#define SQLITE_IOCAP_ATOMIC4K 0x00000010
787+#define SQLITE_IOCAP_ATOMIC8K 0x00000020
788+#define SQLITE_IOCAP_ATOMIC16K 0x00000040
789+#define SQLITE_IOCAP_ATOMIC32K 0x00000080
790+#define SQLITE_IOCAP_ATOMIC64K 0x00000100
791+#define SQLITE_IOCAP_SAFE_APPEND 0x00000200
792+#define SQLITE_IOCAP_SEQUENTIAL 0x00000400
795+#define SQLITE_IOCAP_IMMUTABLE 0x00002000
798+** CAPI3REF: File Locking Levels
800+** SQLite uses one of these integer values as the second
801+** argument to calls it makes to the xLock() and xUnlock() methods
802+** of an [sqlite3_io_methods] object.
804+#define SQLITE_LOCK_NONE 0
805+#define SQLITE_LOCK_SHARED 1
811+** CAPI3REF: Synchronization Type Flags
813+** When SQLite invokes the xSync() method of an
814+** [sqlite3_io_methods] object it uses a combination of
815+** these integer values as the second argument.
817+** When the SQLITE_SYNC_DATAONLY flag is used, it means that the
818+** sync operation only needs to flush data to mass storage. Inode
819+** information need not be flushed. If the lower four bits of the flag
820+** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics.
821+** If the lower four bits equal SQLITE_SYNC_FULL, that means
822+** to use Mac OS X style fullsync instead of fsync().
824+** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags
825+** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL
826+** settings. The [synchronous pragma] determines when calls to the
827+** xSync VFS method occur and applies uniformly across all platforms.
828+** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how
829+** energetic or rigorous or forceful the sync operations are and
830+** only make a difference on Mac OSX for the default SQLite code.
831+** (Third-party VFS implementations might also make the distinction
832+** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the
833+** operating systems natively supported by SQLite, only Mac OSX
834+** cares about the difference.)
836+#define SQLITE_SYNC_NORMAL 0x00002
837+#define SQLITE_SYNC_FULL 0x00003
838+#define SQLITE_SYNC_DATAONLY 0x00010
841+** CAPI3REF: OS Interface Open File Handle
843+** An [sqlite3_file] object represents an open file in the
844+** [sqlite3_vfs | OS interface layer]. Individual OS interface
845+** implementations will
846+** want to subclass this object by appending additional fields
847+** for their own use. The pMethods entry is a pointer to an
848+** [sqlite3_io_methods] object that defines methods for performing
849+** I/O operations on the open file.
851+typedef struct sqlite3_file sqlite3_file;
852+struct sqlite3_file {
853+ const struct sqlite3_io_methods *pMethods; /* Methods for an open file */
857+** CAPI3REF: OS Interface File Virtual Methods Object
859+** Every file opened by the [sqlite3_vfs.xOpen] method populates an
860+** [sqlite3_file] object (or, more commonly, a subclass of the
861+** [sqlite3_file] object) with a pointer to an instance of this object.
862+** This object defines the methods used to perform various operations
863+** against the open file represented by the [sqlite3_file] object.
865+** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element
866+** to a non-NULL pointer, then the sqlite3_io_methods.xClose method
867+** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed. The
868+** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen]
869+** is for the [sqlite3_vfs.xOpen] to set the sqlite3_file.pMethods element
870+** to NULL.
872+** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or
873+** [SQLITE_SYNC_FULL]. The first choice is the normal fsync().
874+** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY]
875+** flag may be ORed in to indicate that only the data of the file
876+** and not its inode needs to be synced.
878+** The integer values to xLock() and xUnlock() are one of
879+** <ul>
880+** <li> [SQLITE_LOCK_NONE],
881+** <li> [SQLITE_LOCK_SHARED],
883+** <li> [SQLITE_LOCK_PENDING], or
885+** </ul>
886+** xLock() increases the lock. xUnlock() decreases the lock.
887+** The xCheckReservedLock() method checks whether any database connection,
888+** either in this process or in some other process, is holding a RESERVED,
889+** PENDING, or EXCLUSIVE lock on the file. It returns true
890+** if such a lock exists and false otherwise.
892+** The xFileControl() method is a generic interface that allows custom
893+** VFS implementations to directly control an open file using the
894+** [sqlite3_file_control()] interface. The second "op" argument is an
895+** integer opcode. The third argument is a generic pointer intended to
896+** point to a structure that may contain arguments or space in which to
897+** write return values. Potential uses for xFileControl() might be
898+** functions to enable blocking locks with timeouts, to change the
899+** locking strategy (for example to use dot-file locks), to inquire
900+** about the status of a lock, or to break stale locks. The SQLite
901+** core reserves all opcodes less than 100 for its own use.
902+** A [file control opcodes | list of opcodes] less than 100 is available.
903+** Applications that define a custom xFileControl method should use opcodes
904+** greater than 100 to avoid conflicts. VFS implementations should
905+** return [SQLITE_NOTFOUND] for file control opcodes that they do not
906+** recognize.
908+** The xSectorSize() method returns the sector size of the
909+** device that underlies the file. The sector size is the
910+** minimum write that can be performed without disturbing
911+** other bytes in the file. The xDeviceCharacteristics()
912+** method returns a bit vector describing behaviors of the
913+** underlying device:
915+** <ul>
917+** <li> [SQLITE_IOCAP_ATOMIC512]
922+** <li> [SQLITE_IOCAP_ATOMIC16K]
923+** <li> [SQLITE_IOCAP_ATOMIC32K]
924+** <li> [SQLITE_IOCAP_ATOMIC64K]
927+** </ul>
929+** The SQLITE_IOCAP_ATOMIC property means that all writes of
930+** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
931+** mean that writes of blocks that are nnn bytes in size and
932+** are aligned to an address which is an integer multiple of
933+** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
934+** that when data is appended to a file, the data is appended
935+** first then the size of the file is extended, never the other
936+** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
937+** information is written to disk in the same order as calls
938+** to xWrite().
940+** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill
941+** in the unread portions of the buffer with zeros. A VFS that
942+** fails to zero-fill short reads might seem to work. However,
943+** failure to zero-fill short reads will eventually lead to
944+** database corruption.
946+typedef struct sqlite3_io_methods sqlite3_io_methods;
947+struct sqlite3_io_methods {
948+ int iVersion;
949+ int (*xClose)(sqlite3_file*);
950+ int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst);
951+ int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst);
952+ int (*xTruncate)(sqlite3_file*, sqlite3_int64 size);
953+ int (*xSync)(sqlite3_file*, int flags);
954+ int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize);
955+ int (*xLock)(sqlite3_file*, int);
956+ int (*xUnlock)(sqlite3_file*, int);
957+ int (*xCheckReservedLock)(sqlite3_file*, int *pResOut);
958+ int (*xFileControl)(sqlite3_file*, int op, void *pArg);
959+ int (*xSectorSize)(sqlite3_file*);
960+ int (*xDeviceCharacteristics)(sqlite3_file*);
961+ /* Methods above are valid for version 1 */
962+ int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, void volatile**);
963+ int (*xShmLock)(sqlite3_file*, int offset, int n, int flags);
964+ void (*xShmBarrier)(sqlite3_file*);
965+ int (*xShmUnmap)(sqlite3_file*, int deleteFlag);
966+ /* Methods above are valid for version 2 */
967+ int (*xFetch)(sqlite3_file*, sqlite3_int64 iOfst, int iAmt, void **pp);
968+ int (*xUnfetch)(sqlite3_file*, sqlite3_int64 iOfst, void *p);
969+ /* Methods above are valid for version 3 */
970+ /* Additional methods may be added in future releases */
974+** CAPI3REF: Standard File Control Opcodes
975+** KEYWORDS: {file control opcodes} {file control opcode}
977+** These integer constants are opcodes for the xFileControl method
978+** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()]
979+** interface.
981+** <ul>
983+** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This
984+** opcode causes the xFileControl method to write the current state of
985+** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED],
987+** into an integer that the pArg argument points to. This capability
988+** is used during testing and is only available when the SQLITE_TEST
989+** compile-time option is used.
992+** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS
993+** layer a hint of how large the database file will grow to be during the
994+** current transaction. This hint is not guaranteed to be accurate but it
995+** is often close. The underlying VFS might choose to preallocate database
996+** file space based on this hint in order to help writes to the database
997+** file run faster.
1000+** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS
1001+** extends and truncates the database file in chunks of a size specified
1002+** by the user. The fourth argument to [sqlite3_file_control()] should
1003+** point to an integer (type int) containing the new chunk-size to use
1004+** for the nominated database. Allocating database file space in large
1005+** chunks (say 1MB at a time), may reduce file-system fragmentation and
1006+** improve performance on some systems.
1009+** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer
1010+** to the [sqlite3_file] object associated with a particular database
1011+** connection. See also [SQLITE_FCNTL_JOURNAL_POINTER].
1014+** The [SQLITE_FCNTL_JOURNAL_POINTER] opcode is used to obtain a pointer
1015+** to the [sqlite3_file] object associated with the journal file (either
1016+** the [rollback journal] or the [write-ahead log]) for a particular database
1017+** connection. See also [SQLITE_FCNTL_FILE_POINTER].
1020+** No longer in use.
1022+** <li>[[SQLITE_FCNTL_SYNC]]
1023+** The [SQLITE_FCNTL_SYNC] opcode is generated internally by SQLite and
1024+** sent to the VFS immediately before the xSync method is invoked on a
1025+** database file descriptor. Or, if the xSync method is not invoked
1026+** because the user has configured SQLite with
1027+** [PRAGMA synchronous | PRAGMA synchronous=OFF] it is invoked in place
1028+** of the xSync method. In most cases, the pointer argument passed with
1029+** this file-control is NULL. However, if the database file is being synced
1030+** as part of a multi-database commit, the argument points to a nul-terminated
1031+** string containing the transactions master-journal file name. VFSes that
1032+** do not need this signal should silently ignore this opcode. Applications
1033+** should not call [sqlite3_file_control()] with this opcode as doing so may
1034+** disrupt the operation of the specialized VFSes that do require it.
1037+** The [SQLITE_FCNTL_COMMIT_PHASETWO] opcode is generated internally by SQLite
1038+** and sent to the VFS after a transaction has been committed immediately
1039+** but before the database is unlocked. VFSes that do not need this signal
1040+** should silently ignore this opcode. Applications should not call
1041+** [sqlite3_file_control()] with this opcode as doing so may disrupt the
1042+** operation of the specialized VFSes that do require it.
1044+** <li>[[SQLITE_FCNTL_WIN32_AV_RETRY]]
1045+** ^The [SQLITE_FCNTL_WIN32_AV_RETRY] opcode is used to configure automatic
1046+** retry counts and intervals for certain disk I/O operations for the
1047+** windows [VFS] in order to provide robustness in the presence of
1048+** anti-virus programs. By default, the windows VFS will retry file read,
1049+** file write, and file delete operations up to 10 times, with a delay
1050+** of 25 milliseconds before the first retry and with the delay increasing
1051+** by an additional 25 milliseconds with each subsequent retry. This
1052+** opcode allows these two values (10 retries and 25 milliseconds of delay)
1053+** to be adjusted. The values are changed for all database connections
1054+** within the same process. The argument is a pointer to an array of two
1055+** integers where the first integer i the new retry count and the second
1056+** integer is the delay. If either integer is negative, then the setting
1057+** is not changed but instead the prior value of that setting is written
1058+** into the array entry, allowing the current retry settings to be
1059+** interrogated. The zDbName parameter is ignored.
1062+** ^The [SQLITE_FCNTL_PERSIST_WAL] opcode is used to set or query the
1063+** persistent [WAL | Write Ahead Log] setting. By default, the auxiliary
1064+** write ahead log and shared memory files used for transaction control
1065+** are automatically deleted when the latest connection to the database
1066+** closes. Setting persistent WAL mode causes those files to persist after
1067+** close. Persisting the files is useful when other processes that do not
1068+** have write permission on the directory containing the database file want
1069+** to read the database file, as the WAL and shared memory files must exist
1070+** in order for the database to be readable. The fourth parameter to
1071+** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
1072+** That integer is 0 to disable persistent WAL mode or 1 to enable persistent
1073+** WAL mode. If the integer is -1, then it is overwritten with the current
1074+** WAL persistence setting.
1077+** ^The [SQLITE_FCNTL_POWERSAFE_OVERWRITE] opcode is used to set or query the
1078+** persistent "powersafe-overwrite" or "PSOW" setting. The PSOW setting
1079+** determines the [SQLITE_IOCAP_POWERSAFE_OVERWRITE] bit of the
1080+** xDeviceCharacteristics methods. The fourth parameter to
1081+** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
1082+** That integer is 0 to disable zero-damage mode or 1 to enable zero-damage
1083+** mode. If the integer is -1, then it is overwritten with the current
1084+** zero-damage mode setting.
1087+** ^The [SQLITE_FCNTL_OVERWRITE] opcode is invoked by SQLite after opening
1088+** a write transaction to indicate that, unless it is rolled back for some
1089+** reason, the entire database file will be overwritten by the current
1090+** transaction. This is used by VACUUM operations.
1092+** <li>[[SQLITE_FCNTL_VFSNAME]]
1093+** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of
1094+** all [VFSes] in the VFS stack. The names are of all VFS shims and the
1095+** final bottom-level VFS are written into memory obtained from
1096+** [sqlite3_malloc()] and the result is stored in the char* variable
1097+** that the fourth parameter of [sqlite3_file_control()] points to.
1098+** The caller is responsible for freeing the memory when done. As with
1099+** all file-control actions, there is no guarantee that this will actually
1100+** do anything. Callers should initialize the char* variable to a NULL
1101+** pointer in case this file-control is not implemented. This file-control
1102+** is intended for diagnostic use only.
1105+** ^The [SQLITE_FCNTL_VFS_POINTER] opcode finds a pointer to the top-level
1106+** [VFSes] currently in use. ^(The argument X in
1107+** sqlite3_file_control(db,SQLITE_FCNTL_VFS_POINTER,X) must be
1108+** of type "[sqlite3_vfs] **". This opcodes will set *X
1109+** to a pointer to the top-level VFS.)^
1110+** ^When there are multiple VFS shims in the stack, this opcode finds the
1111+** upper-most shim only.
1113+** <li>[[SQLITE_FCNTL_PRAGMA]]
1114+** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA]
1115+** file control is sent to the open [sqlite3_file] object corresponding
1116+** to the database file to which the pragma statement refers. ^The argument
1117+** to the [SQLITE_FCNTL_PRAGMA] file control is an array of
1118+** pointers to strings (char**) in which the second element of the array
1119+** is the name of the pragma and the third element is the argument to the
1120+** pragma or NULL if the pragma has no argument. ^The handler for an
1121+** [SQLITE_FCNTL_PRAGMA] file control can optionally make the first element
1122+** of the char** argument point to a string obtained from [sqlite3_mprintf()]
1123+** or the equivalent and that string will become the result of the pragma or
1124+** the error message if the pragma fails. ^If the
1125+** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal
1126+** [PRAGMA] processing continues. ^If the [SQLITE_FCNTL_PRAGMA]
1127+** file control returns [SQLITE_OK], then the parser assumes that the
1128+** VFS has handled the PRAGMA itself and the parser generates a no-op
1129+** prepared statement if result string is NULL, or that returns a copy
1130+** of the result string if the string is non-NULL.
1131+** ^If the [SQLITE_FCNTL_PRAGMA] file control returns
1132+** any result code other than [SQLITE_OK] or [SQLITE_NOTFOUND], that means
1133+** that the VFS encountered an error while handling the [PRAGMA] and the
1134+** compilation of the PRAGMA fails with an error. ^The [SQLITE_FCNTL_PRAGMA]
1135+** file control occurs at the beginning of pragma statement analysis and so
1136+** it is able to override built-in [PRAGMA] statements.
1140+** file-control may be invoked by SQLite on the database file handle
1141+** shortly after it is opened in order to provide a custom VFS with access
1142+** to the connections busy-handler callback. The argument is of type (void **)
1143+** - an array of two (void *) values. The first (void *) actually points
1144+** to a function of type (int (*)(void *)). In order to invoke the connections
1145+** busy-handler, this function should be invoked with the second (void *) in
1146+** the array as the only argument. If it returns non-zero, then the operation
1147+** should be retried. If it returns zero, the custom VFS should abandon the
1148+** current operation.
1151+** ^Application can invoke the [SQLITE_FCNTL_TEMPFILENAME] file-control
1152+** to have SQLite generate a
1153+** temporary filename using the same algorithm that is followed to generate
1154+** temporary filenames for TEMP tables and other internal uses. The
1155+** argument should be a char** which will be filled with the filename
1156+** written into memory obtained from [sqlite3_malloc()]. The caller should
1157+** invoke [sqlite3_free()] on the result to avoid a memory leak.
1159+** <li>[[SQLITE_FCNTL_MMAP_SIZE]]
1160+** The [SQLITE_FCNTL_MMAP_SIZE] file control is used to query or set the
1161+** maximum number of bytes that will be used for memory-mapped I/O.
1162+** The argument is a pointer to a value of type sqlite3_int64 that
1163+** is an advisory maximum number of bytes in the file to memory map. The
1164+** pointer is overwritten with the old value. The limit is not changed if
1165+** the value originally pointed to is negative, and so the current limit
1166+** can be queried by passing in a pointer to a negative number. This
1167+** file-control is used internally to implement [PRAGMA mmap_size].
1169+** <li>[[SQLITE_FCNTL_TRACE]]
1170+** The [SQLITE_FCNTL_TRACE] file control provides advisory information
1171+** to the VFS about what the higher layers of the SQLite stack are doing.
1172+** This file control is used by some VFS activity tracing [shims].
1173+** The argument is a zero-terminated string. Higher layers in the
1174+** SQLite stack may generate instances of this file control if
1175+** the [SQLITE_USE_FCNTL_TRACE] compile-time option is enabled.
1177+** <li>[[SQLITE_FCNTL_HAS_MOVED]]
1178+** The [SQLITE_FCNTL_HAS_MOVED] file control interprets its argument as a
1179+** pointer to an integer and it writes a boolean into that integer depending
1180+** on whether or not the file has been renamed, moved, or deleted since it
1181+** was first opened.
1184+** The [SQLITE_FCNTL_WIN32_SET_HANDLE] opcode is used for debugging. This
1185+** opcode causes the xFileControl method to swap the file handle with the one
1186+** pointed to by the pArg argument. This capability is used during testing
1187+** and only needs to be supported when SQLITE_TEST is defined.
1189+** <li>[[SQLITE_FCNTL_WAL_BLOCK]]
1190+** The [SQLITE_FCNTL_WAL_BLOCK] is a signal to the VFS layer that it might
1191+** be advantageous to block on the next WAL lock if the lock is not immediately
1192+** available. The WAL subsystem issues this signal during rare
1193+** circumstances in order to fix a problem with priority inversion.
1194+** Applications should <em>not</em> use this file-control.
1196+** <li>[[SQLITE_FCNTL_ZIPVFS]]
1197+** The [SQLITE_FCNTL_ZIPVFS] opcode is implemented by zipvfs only. All other
1198+** VFS should return SQLITE_NOTFOUND for this opcode.
1200+** <li>[[SQLITE_FCNTL_RBU]]
1201+** The [SQLITE_FCNTL_RBU] opcode is implemented by the special VFS used by
1202+** the RBU extension only. All other VFS should return SQLITE_NOTFOUND for
1203+** this opcode.
1204+** </ul>
1214+#define SQLITE_FCNTL_WIN32_AV_RETRY 9
1217+#define SQLITE_FCNTL_VFSNAME 12
1219+#define SQLITE_FCNTL_PRAGMA 14
1222+#define SQLITE_FCNTL_MMAP_SIZE 18
1223+#define SQLITE_FCNTL_TRACE 19
1224+#define SQLITE_FCNTL_HAS_MOVED 20
1225+#define SQLITE_FCNTL_SYNC 21
1228+#define SQLITE_FCNTL_WAL_BLOCK 24
1229+#define SQLITE_FCNTL_ZIPVFS 25
1230+#define SQLITE_FCNTL_RBU 26
1234+/* deprecated names */
1241+** CAPI3REF: Mutex Handle
1243+** The mutex module within SQLite defines [sqlite3_mutex] to be an
1244+** abstract type for a mutex object. The SQLite core never looks
1245+** at the internal representation of an [sqlite3_mutex]. It only
1246+** deals with pointers to the [sqlite3_mutex] object.
1248+** Mutexes are created using [sqlite3_mutex_alloc()].
1250+typedef struct sqlite3_mutex sqlite3_mutex;
1253+** CAPI3REF: OS Interface Object
1255+** An instance of the sqlite3_vfs object defines the interface between
1256+** the SQLite core and the underlying operating system. The "vfs"
1257+** in the name of the object stands for "virtual file system". See
1258+** the [VFS | VFS documentation] for further information.
1260+** The value of the iVersion field is initially 1 but may be larger in
1261+** future versions of SQLite. Additional fields may be appended to this
1262+** object when the iVersion value is increased. Note that the structure
1263+** of the sqlite3_vfs object changes in the transaction between
1264+** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not
1265+** modified.
1267+** The szOsFile field is the size of the subclassed [sqlite3_file]
1268+** structure used by this VFS. mxPathname is the maximum length of
1269+** a pathname in this VFS.
1271+** Registered sqlite3_vfs objects are kept on a linked list formed by
1272+** the pNext pointer. The [sqlite3_vfs_register()]
1273+** and [sqlite3_vfs_unregister()] interfaces manage this list
1274+** in a thread-safe way. The [sqlite3_vfs_find()] interface
1275+** searches the list. Neither the application code nor the VFS
1276+** implementation should use the pNext pointer.
1278+** The pNext field is the only field in the sqlite3_vfs
1279+** structure that SQLite will ever modify. SQLite will only access
1280+** or modify this field while holding a particular static mutex.
1281+** The application should never modify anything within the sqlite3_vfs
1282+** object once the object has been registered.
1284+** The zName field holds the name of the VFS module. The name must
1285+** be unique across all VFS modules.
1287+** [[sqlite3_vfs.xOpen]]
1288+** ^SQLite guarantees that the zFilename parameter to xOpen
1289+** is either a NULL pointer or string obtained
1290+** from xFullPathname() with an optional suffix added.
1291+** ^If a suffix is added to the zFilename parameter, it will
1292+** consist of a single "-" character followed by no more than
1293+** 11 alphanumeric and/or "-" characters.
1294+** ^SQLite further guarantees that
1295+** the string will be valid and unchanged until xClose() is
1296+** called. Because of the previous sentence,
1297+** the [sqlite3_file] can safely store a pointer to the
1298+** filename if it needs to remember the filename for some reason.
1299+** If the zFilename parameter to xOpen is a NULL pointer then xOpen
1300+** must invent its own temporary name for the file. ^Whenever the
1301+** xFilename parameter is NULL it will also be the case that the
1302+** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE].
1304+** The flags argument to xOpen() includes all bits set in
1305+** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()]
1306+** or [sqlite3_open16()] is used, then flags includes at least
1308+** If xOpen() opens a file read-only then it sets *pOutFlags to
1309+** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set.
1311+** ^(SQLite will also add one of the following flags to the xOpen()
1312+** call, depending on the object being opened:
1314+** <ul>
1315+** <li> [SQLITE_OPEN_MAIN_DB]
1317+** <li> [SQLITE_OPEN_TEMP_DB]
1322+** <li> [SQLITE_OPEN_WAL]
1323+** </ul>)^
1325+** The file I/O implementation can use the object type flags to
1326+** change the way it deals with files. For example, an application
1327+** that does not care about crash recovery or rollback might make
1328+** the open of a journal file a no-op. Writes to this journal would
1329+** also be no-ops, and any attempt to read the journal would return
1330+** SQLITE_IOERR. Or the implementation might recognize that a database
1331+** file will be doing page-aligned sector reads and writes in a random
1332+** order and set up its I/O subsystem accordingly.
1334+** SQLite might also add one of the following flags to the xOpen method:
1336+** <ul>
1339+** </ul>
1341+** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be
1342+** deleted when it is closed. ^The [SQLITE_OPEN_DELETEONCLOSE]
1343+** will be set for TEMP databases and their journals, transient
1344+** databases, and subjournals.
1346+** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction
1347+** with the [SQLITE_OPEN_CREATE] flag, which are both directly
1348+** analogous to the O_EXCL and O_CREAT flags of the POSIX open()
1349+** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the
1350+** SQLITE_OPEN_CREATE, is used to indicate that file should always
1351+** be created, and that it is an error if it already exists.
1352+** It is <i>not</i> used to indicate the file should be opened
1353+** for exclusive access.
1355+** ^At least szOsFile bytes of memory are allocated by SQLite
1356+** to hold the [sqlite3_file] structure passed as the third
1357+** argument to xOpen. The xOpen method does not have to
1358+** allocate the structure; it should just fill it in. Note that
1359+** the xOpen method must set the sqlite3_file.pMethods to either
1360+** a valid [sqlite3_io_methods] object or to NULL. xOpen must do
1361+** this even if the open fails. SQLite expects that the sqlite3_file.pMethods
1362+** element will be valid after xOpen returns regardless of the success
1363+** or failure of the xOpen call.
1365+** [[sqlite3_vfs.xAccess]]
1366+** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS]
1367+** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to
1368+** test whether a file is readable and writable, or [SQLITE_ACCESS_READ]
1369+** to test whether a file is at least readable. The file can be a
1370+** directory.
1372+** ^SQLite will always allocate at least mxPathname+1 bytes for the
1373+** output buffer xFullPathname. The exact size of the output buffer
1374+** is also passed as a parameter to both methods. If the output buffer
1375+** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is
1376+** handled as a fatal error by SQLite, vfs implementations should endeavor
1377+** to prevent this by setting mxPathname to a sufficiently large value.
1379+** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64()
1380+** interfaces are not strictly a part of the filesystem, but they are
1381+** included in the VFS structure for completeness.
1382+** The xRandomness() function attempts to return nBytes bytes
1383+** of good-quality randomness into zOut. The return value is
1384+** the actual number of bytes of randomness obtained.
1385+** The xSleep() method causes the calling thread to sleep for at
1386+** least the number of microseconds given. ^The xCurrentTime()
1387+** method returns a Julian Day Number for the current date and time as
1388+** a floating point value.
1389+** ^The xCurrentTimeInt64() method returns, as an integer, the Julian
1390+** Day Number multiplied by 86400000 (the number of milliseconds in
1391+** a 24-hour day).
1392+** ^SQLite will use the xCurrentTimeInt64() method to get the current
1393+** date and time if that method is available (if iVersion is 2 or
1394+** greater and the function pointer is not NULL) and will fall back
1395+** to xCurrentTime() if xCurrentTimeInt64() is unavailable.
1397+** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces
1398+** are not used by the SQLite core. These optional interfaces are provided
1399+** by some VFSes to facilitate testing of the VFS code. By overriding
1400+** system calls with functions under its control, a test program can
1401+** simulate faults and error conditions that would otherwise be difficult
1402+** or impossible to induce. The set of system calls that can be overridden
1403+** varies from one VFS to another, and from one version of the same VFS to the
1404+** next. Applications that use these interfaces must be prepared for any
1405+** or all of these interfaces to be NULL or for their behavior to change
1406+** from one release to the next. Applications must not attempt to access
1407+** any of these methods if the iVersion of the VFS is less than 3.
1409+typedef struct sqlite3_vfs sqlite3_vfs;
1410+typedef void (*sqlite3_syscall_ptr)(void);
1411+struct sqlite3_vfs {
1412+ int iVersion; /* Structure version number (currently 3) */
1413+ int szOsFile; /* Size of subclassed sqlite3_file */
1414+ int mxPathname; /* Maximum file pathname length */
1415+ sqlite3_vfs *pNext; /* Next registered VFS */
1416+ const char *zName; /* Name of this virtual file system */
1417+ void *pAppData; /* Pointer to application-specific data */
1418+ int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*,
1419+ int flags, int *pOutFlags);
1420+ int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir);
1421+ int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut);
1422+ int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut);
1423+ void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename);
1424+ void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg);
1425+ void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void);
1426+ void (*xDlClose)(sqlite3_vfs*, void*);
1427+ int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut);
1428+ int (*xSleep)(sqlite3_vfs*, int microseconds);
1429+ int (*xCurrentTime)(sqlite3_vfs*, double*);
1430+ int (*xGetLastError)(sqlite3_vfs*, int, char *);
1431+ /*
1432+ ** The methods above are in version 1 of the sqlite_vfs object
1433+ ** definition. Those that follow are added in version 2 or later
1434+ */
1435+ int (*xCurrentTimeInt64)(sqlite3_vfs*, sqlite3_int64*);
1436+ /*
1437+ ** The methods above are in versions 1 and 2 of the sqlite_vfs object.
1438+ ** Those below are for version 3 and greater.
1439+ */
1440+ int (*xSetSystemCall)(sqlite3_vfs*, const char *zName, sqlite3_syscall_ptr);
1441+ sqlite3_syscall_ptr (*xGetSystemCall)(sqlite3_vfs*, const char *zName);
1442+ const char *(*xNextSystemCall)(sqlite3_vfs*, const char *zName);
1443+ /*
1444+ ** The methods above are in versions 1 through 3 of the sqlite_vfs object.
1445+ ** New fields may be appended in figure versions. The iVersion
1446+ ** value will increment whenever this happens.
1447+ */
1451+** CAPI3REF: Flags for the xAccess VFS method
1453+** These integer constants can be used as the third parameter to
1454+** the xAccess method of an [sqlite3_vfs] object. They determine
1455+** what kind of permissions the xAccess method is looking for.
1456+** With SQLITE_ACCESS_EXISTS, the xAccess method
1457+** simply checks whether the file exists.
1458+** With SQLITE_ACCESS_READWRITE, the xAccess method
1459+** checks whether the named directory is both readable and writable
1460+** (in other words, if files can be added, removed, and renamed within
1461+** the directory).
1462+** The SQLITE_ACCESS_READWRITE constant is currently used only by the
1463+** [temp_store_directory pragma], though this could change in a future
1464+** release of SQLite.
1465+** With SQLITE_ACCESS_READ, the xAccess method
1466+** checks whether the file is readable. The SQLITE_ACCESS_READ constant is
1467+** currently unused, though it might be used in a future release of
1468+** SQLite.
1471+#define SQLITE_ACCESS_READWRITE 1 /* Used by PRAGMA temp_store_directory */
1472+#define SQLITE_ACCESS_READ 2 /* Unused */
1475+** CAPI3REF: Flags for the xShmLock VFS method
1477+** These integer constants define the various locking operations
1478+** allowed by the xShmLock method of [sqlite3_io_methods]. The
1479+** following are the only legal combinations of flags to the
1480+** xShmLock method:
1482+** <ul>
1487+** </ul>
1489+** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as
1490+** was given on the corresponding lock.
1492+** The xShmLock method can transition between unlocked and SHARED or
1493+** between unlocked and EXCLUSIVE. It cannot transition between SHARED
1494+** and EXCLUSIVE.
1496+#define SQLITE_SHM_UNLOCK 1
1497+#define SQLITE_SHM_LOCK 2
1498+#define SQLITE_SHM_SHARED 4
1502+** CAPI3REF: Maximum xShmLock index
1504+** The xShmLock method on [sqlite3_io_methods] may use values
1505+** between 0 and this upper bound as its "offset" argument.
1506+** The SQLite core will never attempt to acquire or release a
1507+** lock outside of this range
1509+#define SQLITE_SHM_NLOCK 8
1513+** CAPI3REF: Initialize The SQLite Library
1515+** ^The sqlite3_initialize() routine initializes the
1516+** SQLite library. ^The sqlite3_shutdown() routine
1517+** deallocates any resources that were allocated by sqlite3_initialize().
1518+** These routines are designed to aid in process initialization and
1519+** shutdown on embedded systems. Workstation applications using
1520+** SQLite normally do not need to invoke either of these routines.
1522+** A call to sqlite3_initialize() is an "effective" call if it is
1523+** the first time sqlite3_initialize() is invoked during the lifetime of
1524+** the process, or if it is the first time sqlite3_initialize() is invoked
1525+** following a call to sqlite3_shutdown(). ^(Only an effective call
1526+** of sqlite3_initialize() does any initialization. All other calls
1527+** are harmless no-ops.)^
1529+** A call to sqlite3_shutdown() is an "effective" call if it is the first
1530+** call to sqlite3_shutdown() since the last sqlite3_initialize(). ^(Only
1531+** an effective call to sqlite3_shutdown() does any deinitialization.
1532+** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^
1534+** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown()
1535+** is not. The sqlite3_shutdown() interface must only be called from a
1536+** single thread. All open [database connections] must be closed and all
1537+** other SQLite resources must be deallocated prior to invoking
1538+** sqlite3_shutdown().
1540+** Among other things, ^sqlite3_initialize() will invoke
1541+** sqlite3_os_init(). Similarly, ^sqlite3_shutdown()
1542+** will invoke sqlite3_os_end().
1544+** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success.
1545+** ^If for some reason, sqlite3_initialize() is unable to initialize
1546+** the library (perhaps it is unable to allocate a needed resource such
1547+** as a mutex) it returns an [error code] other than [SQLITE_OK].
1549+** ^The sqlite3_initialize() routine is called internally by many other
1550+** SQLite interfaces so that an application usually does not need to
1551+** invoke sqlite3_initialize() directly. For example, [sqlite3_open()]
1552+** calls sqlite3_initialize() so the SQLite library will be automatically
1553+** initialized when [sqlite3_open()] is called if it has not be initialized
1554+** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT]
1555+** compile-time option, then the automatic calls to sqlite3_initialize()
1556+** are omitted and the application must call sqlite3_initialize() directly
1557+** prior to using any other SQLite interface. For maximum portability,
1558+** it is recommended that applications always invoke sqlite3_initialize()
1559+** directly prior to using any other SQLite interface. Future releases
1560+** of SQLite may require this. In other words, the behavior exhibited
1561+** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the
1562+** default behavior in some future release of SQLite.
1564+** The sqlite3_os_init() routine does operating-system specific
1565+** initialization of the SQLite library. The sqlite3_os_end()
1566+** routine undoes the effect of sqlite3_os_init(). Typical tasks
1567+** performed by these routines include allocation or deallocation
1568+** of static resources, initialization of global variables,
1569+** setting up a default [sqlite3_vfs] module, or setting up
1570+** a default configuration using [sqlite3_config()].
1572+** The application should never invoke either sqlite3_os_init()
1573+** or sqlite3_os_end() directly. The application should only invoke
1574+** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init()
1575+** interface is called automatically by sqlite3_initialize() and
1576+** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate
1577+** implementations for sqlite3_os_init() and sqlite3_os_end()
1578+** are built into SQLite when it is compiled for Unix, Windows, or OS/2.
1579+** When [custom builds | built for other platforms]
1580+** (using the [SQLITE_OS_OTHER=1] compile-time
1581+** option) the application must supply a suitable implementation for
1582+** sqlite3_os_init() and sqlite3_os_end(). An application-supplied
1583+** implementation of sqlite3_os_init() or sqlite3_os_end()
1584+** must return [SQLITE_OK] on success and some other [error code] upon
1585+** failure.
1587+SQLITE_API int SQLITE_STDCALL sqlite3_initialize(void);
1588+SQLITE_API int SQLITE_STDCALL sqlite3_shutdown(void);
1589+SQLITE_API int SQLITE_STDCALL sqlite3_os_init(void);
1590+SQLITE_API int SQLITE_STDCALL sqlite3_os_end(void);
1593+** CAPI3REF: Configuring The SQLite Library
1595+** The sqlite3_config() interface is used to make global configuration
1596+** changes to SQLite in order to tune SQLite to the specific needs of
1597+** the application. The default configuration is recommended for most
1598+** applications and so this routine is usually not necessary. It is
1599+** provided to support rare applications with unusual needs.
1601+** <b>The sqlite3_config() interface is not threadsafe. The application
1602+** must ensure that no other SQLite interfaces are invoked by other
1603+** threads while sqlite3_config() is running.</b>
1605+** The sqlite3_config() interface
1606+** may only be invoked prior to library initialization using
1607+** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()].
1608+** ^If sqlite3_config() is called after [sqlite3_initialize()] and before
1609+** [sqlite3_shutdown()] then it will return SQLITE_MISUSE.
1610+** Note, however, that ^sqlite3_config() can be called as part of the
1611+** implementation of an application-defined [sqlite3_os_init()].
1613+** The first argument to sqlite3_config() is an integer
1614+** [configuration option] that determines
1615+** what property of SQLite is to be configured. Subsequent arguments
1616+** vary depending on the [configuration option]
1617+** in the first argument.
1619+** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK].
1620+** ^If the option is unknown or SQLite is unable to set the option
1621+** then this routine returns a non-zero [error code].
1623+SQLITE_API int SQLITE_CDECL sqlite3_config(int, ...);
1626+** CAPI3REF: Configure database connections
1627+** METHOD: sqlite3
1629+** The sqlite3_db_config() interface is used to make configuration
1630+** changes to a [database connection]. The interface is similar to
1631+** [sqlite3_config()] except that the changes apply to a single
1632+** [database connection] (specified in the first argument).
1634+** The second argument to sqlite3_db_config(D,V,...) is the
1635+** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code
1636+** that indicates what aspect of the [database connection] is being configured.
1637+** Subsequent arguments vary depending on the configuration verb.
1639+** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if
1640+** the call is considered successful.
1642+SQLITE_API int SQLITE_CDECL sqlite3_db_config(sqlite3*, int op, ...);
1645+** CAPI3REF: Memory Allocation Routines
1647+** An instance of this object defines the interface between SQLite
1648+** and low-level memory allocation routines.
1650+** This object is used in only one place in the SQLite interface.
1651+** A pointer to an instance of this object is the argument to
1652+** [sqlite3_config()] when the configuration option is
1654+** By creating an instance of this object
1655+** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC])
1656+** during configuration, an application can specify an alternative
1657+** memory allocation subsystem for SQLite to use for all of its
1658+** dynamic memory needs.
1660+** Note that SQLite comes with several [built-in memory allocators]
1661+** that are perfectly adequate for the overwhelming majority of applications
1662+** and that this object is only useful to a tiny minority of applications
1663+** with specialized memory allocation requirements. This object is
1664+** also used during testing of SQLite in order to specify an alternative
1665+** memory allocator that simulates memory out-of-memory conditions in
1666+** order to verify that SQLite recovers gracefully from such
1667+** conditions.
1669+** The xMalloc, xRealloc, and xFree methods must work like the
1670+** malloc(), realloc() and free() functions from the standard C library.
1671+** ^SQLite guarantees that the second argument to
1672+** xRealloc is always a value returned by a prior call to xRoundup.
1674+** xSize should return the allocated size of a memory allocation
1675+** previously obtained from xMalloc or xRealloc. The allocated size
1676+** is always at least as big as the requested size but may be larger.
1678+** The xRoundup method returns what would be the allocated size of
1679+** a memory allocation given a particular requested size. Most memory
1680+** allocators round up memory allocations at least to the next multiple
1681+** of 8. Some allocators round up to a larger multiple or to a power of 2.
1682+** Every memory allocation request coming in through [sqlite3_malloc()]
1683+** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0,
1684+** that causes the corresponding memory allocation to fail.
1686+** The xInit method initializes the memory allocator. For example,
1687+** it might allocate any require mutexes or initialize internal data
1688+** structures. The xShutdown method is invoked (indirectly) by
1689+** [sqlite3_shutdown()] and should deallocate any resources acquired
1690+** by xInit. The pAppData pointer is used as the only parameter to
1691+** xInit and xShutdown.
1693+** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes
1694+** the xInit method, so the xInit method need not be threadsafe. The
1695+** xShutdown method is only called from [sqlite3_shutdown()] so it does
1696+** not need to be threadsafe either. For all other methods, SQLite
1697+** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the
1698+** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which
1699+** it is by default) and so the methods are automatically serialized.
1700+** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other
1701+** methods must be threadsafe or else make their own arrangements for
1702+** serialization.
1704+** SQLite will never invoke xInit() more than once without an intervening
1705+** call to xShutdown().
1707+typedef struct sqlite3_mem_methods sqlite3_mem_methods;
1708+struct sqlite3_mem_methods {
1709+ void *(*xMalloc)(int); /* Memory allocation function */
1710+ void (*xFree)(void*); /* Free a prior allocation */
1711+ void *(*xRealloc)(void*,int); /* Resize an allocation */
1712+ int (*xSize)(void*); /* Return the size of an allocation */
1713+ int (*xRoundup)(int); /* Round up request size to allocation size */
1714+ int (*xInit)(void*); /* Initialize the memory allocator */
1715+ void (*xShutdown)(void*); /* Deinitialize the memory allocator */
1716+ void *pAppData; /* Argument to xInit() and xShutdown() */
1720+** CAPI3REF: Configuration Options
1721+** KEYWORDS: {configuration option}
1723+** These constants are the available integer configuration options that
1724+** can be passed as the first argument to the [sqlite3_config()] interface.
1726+** New configuration options may be added in future releases of SQLite.
1727+** Existing configuration options might be discontinued. Applications
1728+** should check the return code from [sqlite3_config()] to make sure that
1729+** the call worked. The [sqlite3_config()] interface will return a
1730+** non-zero [error code] if a discontinued or unsupported configuration option
1731+** is invoked.
1733+** <dl>
1735+** <dd>There are no arguments to this option. ^This option sets the
1736+** [threading mode] to Single-thread. In other words, it disables
1737+** all mutexing and puts SQLite into a mode where it can only be used
1738+** by a single thread. ^If SQLite is compiled with
1739+** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
1740+** it is not possible to change the [threading mode] from its default
1741+** value of Single-thread and so [sqlite3_config()] will return
1743+** configuration option.</dd>
1746+** <dd>There are no arguments to this option. ^This option sets the
1747+** [threading mode] to Multi-thread. In other words, it disables
1748+** mutexing on [database connection] and [prepared statement] objects.
1749+** The application is responsible for serializing access to
1750+** [database connections] and [prepared statements]. But other mutexes
1751+** are enabled so that SQLite will be safe to use in a multi-threaded
1752+** environment as long as no two threads attempt to use the same
1753+** [database connection] at the same time. ^If SQLite is compiled with
1754+** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
1755+** it is not possible to set the Multi-thread [threading mode] and
1756+** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
1757+** SQLITE_CONFIG_MULTITHREAD configuration option.</dd>
1760+** <dd>There are no arguments to this option. ^This option sets the
1761+** [threading mode] to Serialized. In other words, this option enables
1762+** all mutexes including the recursive
1763+** mutexes on [database connection] and [prepared statement] objects.
1764+** In this mode (which is the default when SQLite is compiled with
1765+** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access
1766+** to [database connections] and [prepared statements] so that the
1767+** application is free to use the same [database connection] or the
1768+** same [prepared statement] in different threads at the same time.
1769+** ^If SQLite is compiled with
1770+** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
1771+** it is not possible to set the Serialized [threading mode] and
1772+** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
1773+** SQLITE_CONFIG_SERIALIZED configuration option.</dd>
1776+** <dd> ^(The SQLITE_CONFIG_MALLOC option takes a single argument which is
1777+** a pointer to an instance of the [sqlite3_mem_methods] structure.
1778+** The argument specifies
1779+** alternative low-level memory allocation routines to be used in place of
1780+** the memory allocation routines built into SQLite.)^ ^SQLite makes
1781+** its own private copy of the content of the [sqlite3_mem_methods] structure
1782+** before the [sqlite3_config()] call returns.</dd>
1785+** <dd> ^(The SQLITE_CONFIG_GETMALLOC option takes a single argument which
1786+** is a pointer to an instance of the [sqlite3_mem_methods] structure.
1787+** The [sqlite3_mem_methods]
1788+** structure is filled with the currently defined memory allocation routines.)^
1789+** This option can be used to overload the default memory allocation
1790+** routines with a wrapper that simulations memory allocation failure or
1791+** tracks memory usage, for example. </dd>
1794+** <dd> ^The SQLITE_CONFIG_MEMSTATUS option takes single argument of type int,
1795+** interpreted as a boolean, which enables or disables the collection of
1796+** memory allocation statistics. ^(When memory allocation statistics are
1797+** disabled, the following SQLite interfaces become non-operational:
1798+** <ul>
1799+** <li> [sqlite3_memory_used()]
1800+** <li> [sqlite3_memory_highwater()]
1801+** <li> [sqlite3_soft_heap_limit64()]
1802+** <li> [sqlite3_status64()]
1803+** </ul>)^
1804+** ^Memory allocation statistics are enabled by default unless SQLite is
1805+** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory
1806+** allocation statistics are disabled by default.
1807+** </dd>
1810+** <dd> ^The SQLITE_CONFIG_SCRATCH option specifies a static memory buffer
1811+** that SQLite can use for scratch memory. ^(There are three arguments
1812+** to SQLITE_CONFIG_SCRATCH: A pointer an 8-byte
1813+** aligned memory buffer from which the scratch allocations will be
1814+** drawn, the size of each scratch allocation (sz),
1815+** and the maximum number of scratch allocations (N).)^
1816+** The first argument must be a pointer to an 8-byte aligned buffer
1817+** of at least sz*N bytes of memory.
1818+** ^SQLite will not use more than one scratch buffers per thread.
1819+** ^SQLite will never request a scratch buffer that is more than 6
1820+** times the database page size.
1821+** ^If SQLite needs needs additional
1822+** scratch memory beyond what is provided by this configuration option, then
1823+** [sqlite3_malloc()] will be used to obtain the memory needed.<p>
1824+** ^When the application provides any amount of scratch memory using
1825+** SQLITE_CONFIG_SCRATCH, SQLite avoids unnecessary large
1826+** [sqlite3_malloc|heap allocations].
1827+** This can help [Robson proof|prevent memory allocation failures] due to heap
1828+** fragmentation in low-memory embedded systems.
1829+** </dd>
1832+** <dd> ^The SQLITE_CONFIG_PAGECACHE option specifies a memory pool
1833+** that SQLite can use for the database page cache with the default page
1834+** cache implementation.
1835+** This configuration option is a no-op if an application-define page
1836+** cache implementation is loaded using the [SQLITE_CONFIG_PCACHE2].
1837+** ^There are three arguments to SQLITE_CONFIG_PAGECACHE: A pointer to
1838+** 8-byte aligned memory (pMem), the size of each page cache line (sz),
1839+** and the number of cache lines (N).
1840+** The sz argument should be the size of the largest database page
1841+** (a power of two between 512 and 65536) plus some extra bytes for each
1842+** page header. ^The number of extra bytes needed by the page header
1843+** can be determined using [SQLITE_CONFIG_PCACHE_HDRSZ].
1844+** ^It is harmless, apart from the wasted memory,
1845+** for the sz parameter to be larger than necessary. The pMem
1846+** argument must be either a NULL pointer or a pointer to an 8-byte
1847+** aligned block of memory of at least sz*N bytes, otherwise
1848+** subsequent behavior is undefined.
1849+** ^When pMem is not NULL, SQLite will strive to use the memory provided
1850+** to satisfy page cache needs, falling back to [sqlite3_malloc()] if
1851+** a page cache line is larger than sz bytes or if all of the pMem buffer
1852+** is exhausted.
1853+** ^If pMem is NULL and N is non-zero, then each database connection
1854+** does an initial bulk allocation for page cache memory
1855+** from [sqlite3_malloc()] sufficient for N cache lines if N is positive or
1856+** of -1024*N bytes if N is negative, . ^If additional
1857+** page cache memory is needed beyond what is provided by the initial
1858+** allocation, then SQLite goes to [sqlite3_malloc()] separately for each
1859+** additional cache line. </dd>
1862+** <dd> ^The SQLITE_CONFIG_HEAP option specifies a static memory buffer
1863+** that SQLite will use for all of its dynamic memory allocation needs
1864+** beyond those provided for by [SQLITE_CONFIG_SCRATCH] and
1866+** ^The SQLITE_CONFIG_HEAP option is only available if SQLite is compiled
1867+** with either [SQLITE_ENABLE_MEMSYS3] or [SQLITE_ENABLE_MEMSYS5] and returns
1868+** [SQLITE_ERROR] if invoked otherwise.
1869+** ^There are three arguments to SQLITE_CONFIG_HEAP:
1870+** An 8-byte aligned pointer to the memory,
1871+** the number of bytes in the memory buffer, and the minimum allocation size.
1872+** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts
1873+** to using its default memory allocator (the system malloc() implementation),
1874+** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the
1875+** memory pointer is not NULL then the alternative memory
1876+** allocator is engaged to handle all of SQLites memory allocation needs.
1877+** The first pointer (the memory pointer) must be aligned to an 8-byte
1878+** boundary or subsequent behavior of SQLite will be undefined.
1879+** The minimum allocation size is capped at 2**12. Reasonable values
1880+** for the minimum allocation size are 2**5 through 2**8.</dd>
1883+** <dd> ^(The SQLITE_CONFIG_MUTEX option takes a single argument which is a
1884+** pointer to an instance of the [sqlite3_mutex_methods] structure.
1885+** The argument specifies alternative low-level mutex routines to be used
1886+** in place the mutex routines built into SQLite.)^ ^SQLite makes a copy of
1887+** the content of the [sqlite3_mutex_methods] structure before the call to
1888+** [sqlite3_config()] returns. ^If SQLite is compiled with
1889+** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
1890+** the entire mutexing subsystem is omitted from the build and hence calls to
1891+** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will
1892+** return [SQLITE_ERROR].</dd>
1895+** <dd> ^(The SQLITE_CONFIG_GETMUTEX option takes a single argument which
1896+** is a pointer to an instance of the [sqlite3_mutex_methods] structure. The
1897+** [sqlite3_mutex_methods]
1898+** structure is filled with the currently defined mutex routines.)^
1899+** This option can be used to overload the default mutex allocation
1900+** routines with a wrapper used to track mutex usage for performance
1901+** profiling or testing, for example. ^If SQLite is compiled with
1902+** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
1903+** the entire mutexing subsystem is omitted from the build and hence calls to
1904+** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will
1905+** return [SQLITE_ERROR].</dd>
1908+** <dd> ^(The SQLITE_CONFIG_LOOKASIDE option takes two arguments that determine
1909+** the default size of lookaside memory on each [database connection].
1910+** The first argument is the
1911+** size of each lookaside buffer slot and the second is the number of
1912+** slots allocated to each database connection.)^ ^(SQLITE_CONFIG_LOOKASIDE
1913+** sets the <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE]
1914+** option to [sqlite3_db_config()] can be used to change the lookaside
1915+** configuration on individual connections.)^ </dd>
1918+** <dd> ^(The SQLITE_CONFIG_PCACHE2 option takes a single argument which is
1919+** a pointer to an [sqlite3_pcache_methods2] object. This object specifies
1920+** the interface to a custom page cache implementation.)^
1921+** ^SQLite makes a copy of the [sqlite3_pcache_methods2] object.</dd>
1924+** <dd> ^(The SQLITE_CONFIG_GETPCACHE2 option takes a single argument which
1925+** is a pointer to an [sqlite3_pcache_methods2] object. SQLite copies of
1926+** the current page cache implementation into that object.)^ </dd>
1929+** <dd> The SQLITE_CONFIG_LOG option is used to configure the SQLite
1930+** global [error log].
1931+** (^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a
1932+** function with a call signature of void(*)(void*,int,const char*),
1933+** and a pointer to void. ^If the function pointer is not NULL, it is
1934+** invoked by [sqlite3_log()] to process each logging event. ^If the
1935+** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op.
1936+** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is
1937+** passed through as the first parameter to the application-defined logger
1938+** function whenever that function is invoked. ^The second parameter to
1939+** the logger function is a copy of the first parameter to the corresponding
1940+** [sqlite3_log()] call and is intended to be a [result code] or an
1941+** [extended result code]. ^The third parameter passed to the logger is
1942+** log message after formatting via [sqlite3_snprintf()].
1943+** The SQLite logging interface is not reentrant; the logger function
1944+** supplied by the application must not invoke any SQLite interface.
1945+** In a multi-threaded application, the application-defined logger
1946+** function must be threadsafe. </dd>
1949+** <dd>^(The SQLITE_CONFIG_URI option takes a single argument of type int.
1950+** If non-zero, then URI handling is globally enabled. If the parameter is zero,
1951+** then URI handling is globally disabled.)^ ^If URI handling is globally
1952+** enabled, all filenames passed to [sqlite3_open()], [sqlite3_open_v2()],
1953+** [sqlite3_open16()] or
1954+** specified as part of [ATTACH] commands are interpreted as URIs, regardless
1955+** of whether or not the [SQLITE_OPEN_URI] flag is set when the database
1956+** connection is opened. ^If it is globally disabled, filenames are
1957+** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the
1958+** database connection is opened. ^(By default, URI handling is globally
1959+** disabled. The default value may be changed by compiling with the
1960+** [SQLITE_USE_URI] symbol defined.)^
1963+** <dd>^The SQLITE_CONFIG_COVERING_INDEX_SCAN option takes a single integer
1964+** argument which is interpreted as a boolean in order to enable or disable
1965+** the use of covering indices for full table scans in the query optimizer.
1966+** ^The default setting is determined
1967+** by the [SQLITE_ALLOW_COVERING_INDEX_SCAN] compile-time option, or is "on"
1968+** if that compile-time option is omitted.
1969+** The ability to disable the use of covering indices for full table scans
1970+** is because some incorrectly coded legacy applications might malfunction
1971+** when the optimization is enabled. Providing the ability to
1972+** disable the optimization allows the older, buggy application code to work
1973+** without change even with newer versions of SQLite.
1977+** <dd> These options are obsolete and should not be used by new code.
1978+** They are retained for backwards compatibility but are now no-ops.
1979+** </dd>
1983+** <dd>This option is only available if sqlite is compiled with the
1984+** [SQLITE_ENABLE_SQLLOG] pre-processor macro defined. The first argument should
1985+** be a pointer to a function of type void(*)(void*,sqlite3*,const char*, int).
1986+** The second should be of type (void*). The callback is invoked by the library
1987+** in three separate circumstances, identified by the value passed as the
1988+** fourth parameter. If the fourth parameter is 0, then the database connection
1989+** passed as the second argument has just been opened. The third argument
1990+** points to a buffer containing the name of the main database file. If the
1991+** fourth parameter is 1, then the SQL statement that the third parameter
1992+** points to has just been executed. Or, if the fourth parameter is 2, then
1993+** the connection being passed as the second parameter is being closed. The
1994+** third parameter is passed NULL In this case. An example of using this
1995+** configuration option can be seen in the "test_sqllog.c" source file in
1996+** the canonical SQLite source tree.</dd>
2000+** <dd>^SQLITE_CONFIG_MMAP_SIZE takes two 64-bit integer (sqlite3_int64) values
2001+** that are the default mmap size limit (the default setting for
2002+** [PRAGMA mmap_size]) and the maximum allowed mmap size limit.
2003+** ^The default setting can be overridden by each database connection using
2004+** either the [PRAGMA mmap_size] command, or by using the
2005+** [SQLITE_FCNTL_MMAP_SIZE] file control. ^(The maximum allowed mmap size
2006+** will be silently truncated if necessary so that it does not exceed the
2007+** compile-time maximum mmap size set by the
2008+** [SQLITE_MAX_MMAP_SIZE] compile-time option.)^
2009+** ^If either argument to this option is negative, then that argument is
2010+** changed to its compile-time default.
2014+** <dd>^The SQLITE_CONFIG_WIN32_HEAPSIZE option is only available if SQLite is
2015+** compiled for Windows with the [SQLITE_WIN32_MALLOC] pre-processor macro
2016+** defined. ^SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit unsigned integer value
2017+** that specifies the maximum size of the created heap.
2021+** <dd>^The SQLITE_CONFIG_PCACHE_HDRSZ option takes a single parameter which
2022+** is a pointer to an integer and writes into that integer the number of extra
2023+** bytes per page required for each page in [SQLITE_CONFIG_PAGECACHE].
2024+** The amount of extra space required can change depending on the compiler,
2025+** target platform, and SQLite version.
2029+** <dd>^The SQLITE_CONFIG_PMASZ option takes a single parameter which
2030+** is an unsigned integer and sets the "Minimum PMA Size" for the multithreaded
2031+** sorter to that integer. The default minimum PMA Size is set by the
2032+** [SQLITE_SORTER_PMASZ] compile-time option. New threads are launched
2033+** to help with sort operations when multithreaded sorting
2034+** is enabled (using the [PRAGMA threads] command) and the amount of content
2035+** to be sorted exceeds the page size times the minimum of the
2036+** [PRAGMA cache_size] setting and this value.
2037+** </dl>
2039+#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */
2040+#define SQLITE_CONFIG_MULTITHREAD 2 /* nil */
2041+#define SQLITE_CONFIG_SERIALIZED 3 /* nil */
2042+#define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */
2043+#define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */
2044+#define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */
2045+#define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */
2046+#define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */
2047+#define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */
2048+#define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */
2049+#define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */
2050+/* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */
2051+#define SQLITE_CONFIG_LOOKASIDE 13 /* int int */
2052+#define SQLITE_CONFIG_PCACHE 14 /* no-op */
2053+#define SQLITE_CONFIG_GETPCACHE 15 /* no-op */
2054+#define SQLITE_CONFIG_LOG 16 /* xFunc, void* */
2055+#define SQLITE_CONFIG_URI 17 /* int */
2056+#define SQLITE_CONFIG_PCACHE2 18 /* sqlite3_pcache_methods2* */
2057+#define SQLITE_CONFIG_GETPCACHE2 19 /* sqlite3_pcache_methods2* */
2058+#define SQLITE_CONFIG_COVERING_INDEX_SCAN 20 /* int */
2059+#define SQLITE_CONFIG_SQLLOG 21 /* xSqllog, void* */
2060+#define SQLITE_CONFIG_MMAP_SIZE 22 /* sqlite3_int64, sqlite3_int64 */
2061+#define SQLITE_CONFIG_WIN32_HEAPSIZE 23 /* int nByte */
2062+#define SQLITE_CONFIG_PCACHE_HDRSZ 24 /* int *psz */
2063+#define SQLITE_CONFIG_PMASZ 25 /* unsigned int szPma */
2066+** CAPI3REF: Database Connection Configuration Options
2068+** These constants are the available integer configuration options that
2069+** can be passed as the second argument to the [sqlite3_db_config()] interface.
2071+** New configuration options may be added in future releases of SQLite.
2072+** Existing configuration options might be discontinued. Applications
2073+** should check the return code from [sqlite3_db_config()] to make sure that
2074+** the call worked. ^The [sqlite3_db_config()] interface will return a
2075+** non-zero [error code] if a discontinued or unsupported configuration option
2076+** is invoked.
2078+** <dl>
2080+** <dd> ^This option takes three additional arguments that determine the
2081+** [lookaside memory allocator] configuration for the [database connection].
2082+** ^The first argument (the third parameter to [sqlite3_db_config()] is a
2083+** pointer to a memory buffer to use for lookaside memory.
2084+** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb
2085+** may be NULL in which case SQLite will allocate the
2086+** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the
2087+** size of each lookaside buffer slot. ^The third argument is the number of
2088+** slots. The size of the buffer in the first argument must be greater than
2089+** or equal to the product of the second and third arguments. The buffer
2090+** must be aligned to an 8-byte boundary. ^If the second argument to
2091+** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally
2092+** rounded down to the next smaller multiple of 8. ^(The lookaside memory
2093+** configuration for a database connection can only be changed when that
2094+** connection is not currently using lookaside memory, or in other words
2095+** when the "current value" returned by
2096+** [sqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero.
2097+** Any attempt to change the lookaside memory configuration when lookaside
2098+** memory is in use leaves the configuration unchanged and returns
2099+** [SQLITE_BUSY].)^</dd>
2102+** <dd> ^This option is used to enable or disable the enforcement of
2103+** [foreign key constraints]. There should be two additional arguments.
2104+** The first argument is an integer which is 0 to disable FK enforcement,
2105+** positive to enable FK enforcement or negative to leave FK enforcement
2106+** unchanged. The second parameter is a pointer to an integer into which
2107+** is written 0 or 1 to indicate whether FK enforcement is off or on
2108+** following this call. The second parameter may be a NULL pointer, in
2109+** which case the FK enforcement setting is not reported back. </dd>
2112+** <dd> ^This option is used to enable or disable [CREATE TRIGGER | triggers].
2113+** There should be two additional arguments.
2114+** The first argument is an integer which is 0 to disable triggers,
2115+** positive to enable triggers or negative to leave the setting unchanged.
2116+** The second parameter is a pointer to an integer into which
2117+** is written 0 or 1 to indicate whether triggers are disabled or enabled
2118+** following this call. The second parameter may be a NULL pointer, in
2119+** which case the trigger setting is not reported back. </dd>
2121+** </dl>
2123+#define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */
2124+#define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */
2125+#define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */
2129+** CAPI3REF: Enable Or Disable Extended Result Codes
2130+** METHOD: sqlite3
2132+** ^The sqlite3_extended_result_codes() routine enables or disables the
2133+** [extended result codes] feature of SQLite. ^The extended result
2134+** codes are disabled by default for historical compatibility.
2136+SQLITE_API int SQLITE_STDCALL sqlite3_extended_result_codes(sqlite3*, int onoff);
2139+** CAPI3REF: Last Insert Rowid
2140+** METHOD: sqlite3
2142+** ^Each entry in most SQLite tables (except for [WITHOUT ROWID] tables)
2143+** has a unique 64-bit signed
2144+** integer key called the [ROWID | "rowid"]. ^The rowid is always available
2145+** as an undeclared column named ROWID, OID, or _ROWID_ as long as those
2146+** names are not also used by explicitly declared columns. ^If
2147+** the table has a column of type [INTEGER PRIMARY KEY] then that column
2148+** is another alias for the rowid.
2150+** ^The sqlite3_last_insert_rowid(D) interface returns the [rowid] of the
2151+** most recent successful [INSERT] into a rowid table or [virtual table]
2152+** on database connection D.
2153+** ^Inserts into [WITHOUT ROWID] tables are not recorded.
2154+** ^If no successful [INSERT]s into rowid tables
2155+** have ever occurred on the database connection D,
2156+** then sqlite3_last_insert_rowid(D) returns zero.
2158+** ^(If an [INSERT] occurs within a trigger or within a [virtual table]
2159+** method, then this routine will return the [rowid] of the inserted
2160+** row as long as the trigger or virtual table method is running.
2161+** But once the trigger or virtual table method ends, the value returned
2162+** by this routine reverts to what it was before the trigger or virtual
2163+** table method began.)^
2165+** ^An [INSERT] that fails due to a constraint violation is not a
2166+** successful [INSERT] and does not change the value returned by this
2168+** and INSERT OR ABORT make no changes to the return value of this
2169+** routine when their insertion fails. ^(When INSERT OR REPLACE
2170+** encounters a constraint violation, it does not fail. The
2171+** INSERT continues to completion after deleting rows that caused
2172+** the constraint problem so INSERT OR REPLACE will always change
2173+** the return value of this interface.)^
2175+** ^For the purposes of this routine, an [INSERT] is considered to
2176+** be successful even if it is subsequently rolled back.
2178+** This function is accessible to SQL statements via the
2179+** [last_insert_rowid() SQL function].
2181+** If a separate thread performs a new [INSERT] on the same
2182+** database connection while the [sqlite3_last_insert_rowid()]
2183+** function is running and thus changes the last insert [rowid],
2184+** then the value returned by [sqlite3_last_insert_rowid()] is
2185+** unpredictable and might not equal either the old or the new
2186+** last insert [rowid].
2188+SQLITE_API sqlite3_int64 SQLITE_STDCALL sqlite3_last_insert_rowid(sqlite3*);
2191+** CAPI3REF: Count The Number Of Rows Modified
2192+** METHOD: sqlite3
2194+** ^This function returns the number of rows modified, inserted or
2195+** deleted by the most recently completed INSERT, UPDATE or DELETE
2196+** statement on the database connection specified by the only parameter.
2197+** ^Executing any other type of SQL statement does not modify the value
2198+** returned by this function.
2200+** ^Only changes made directly by the INSERT, UPDATE or DELETE statement are
2201+** considered - auxiliary changes caused by [CREATE TRIGGER | triggers],
2202+** [foreign key actions] or [REPLACE] constraint resolution are not counted.
2204+** Changes to a view that are intercepted by
2205+** [INSTEAD OF trigger | INSTEAD OF triggers] are not counted. ^The value
2206+** returned by sqlite3_changes() immediately after an INSERT, UPDATE or
2207+** DELETE statement run on a view is always zero. Only changes made to real
2208+** tables are counted.
2210+** Things are more complicated if the sqlite3_changes() function is
2211+** executed while a trigger program is running. This may happen if the
2212+** program uses the [changes() SQL function], or if some other callback
2213+** function invokes sqlite3_changes() directly. Essentially:
2215+** <ul>
2216+** <li> ^(Before entering a trigger program the value returned by
2217+** sqlite3_changes() function is saved. After the trigger program
2218+** has finished, the original value is restored.)^
2220+** <li> ^(Within a trigger program each INSERT, UPDATE and DELETE
2221+** statement sets the value returned by sqlite3_changes()
2222+** upon completion as normal. Of course, this value will not include
2223+** any changes performed by sub-triggers, as the sqlite3_changes()
2224+** value will be saved and restored after each sub-trigger has run.)^
2225+** </ul>
2227+** ^This means that if the changes() SQL function (or similar) is used
2228+** by the first INSERT, UPDATE or DELETE statement within a trigger, it
2229+** returns the value as set when the calling statement began executing.
2230+** ^If it is used by the second or subsequent such statement within a trigger
2231+** program, the value returned reflects the number of rows modified by the
2232+** previous INSERT, UPDATE or DELETE statement within the same trigger.
2234+** See also the [sqlite3_total_changes()] interface, the
2235+** [count_changes pragma], and the [changes() SQL function].
2237+** If a separate thread makes changes on the same database connection
2238+** while [sqlite3_changes()] is running then the value returned
2239+** is unpredictable and not meaningful.
2241+SQLITE_API int SQLITE_STDCALL sqlite3_changes(sqlite3*);
2244+** CAPI3REF: Total Number Of Rows Modified
2245+** METHOD: sqlite3
2247+** ^This function returns the total number of rows inserted, modified or
2248+** deleted by all [INSERT], [UPDATE] or [DELETE] statements completed
2249+** since the database connection was opened, including those executed as
2250+** part of trigger programs. ^Executing any other type of SQL statement
2251+** does not affect the value returned by sqlite3_total_changes().
2253+** ^Changes made as part of [foreign key actions] are included in the
2254+** count, but those made as part of REPLACE constraint resolution are
2255+** not. ^Changes to a view that are intercepted by INSTEAD OF triggers
2256+** are not counted.
2258+** See also the [sqlite3_changes()] interface, the
2259+** [count_changes pragma], and the [total_changes() SQL function].
2261+** If a separate thread makes changes on the same database connection
2262+** while [sqlite3_total_changes()] is running then the value
2263+** returned is unpredictable and not meaningful.
2265+SQLITE_API int SQLITE_STDCALL sqlite3_total_changes(sqlite3*);
2268+** CAPI3REF: Interrupt A Long-Running Query
2269+** METHOD: sqlite3
2271+** ^This function causes any pending database operation to abort and
2272+** return at its earliest opportunity. This routine is typically
2273+** called in response to a user action such as pressing "Cancel"
2274+** or Ctrl-C where the user wants a long query operation to halt
2275+** immediately.
2277+** ^It is safe to call this routine from a thread different from the
2278+** thread that is currently running the database operation. But it
2279+** is not safe to call this routine with a [database connection] that
2280+** is closed or might close before sqlite3_interrupt() returns.
2282+** ^If an SQL operation is very nearly finished at the time when
2283+** sqlite3_interrupt() is called, then it might not have an opportunity
2284+** to be interrupted and might continue to completion.
2286+** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT].
2287+** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE
2288+** that is inside an explicit transaction, then the entire transaction
2289+** will be rolled back automatically.
2291+** ^The sqlite3_interrupt(D) call is in effect until all currently running
2292+** SQL statements on [database connection] D complete. ^Any new SQL statements
2293+** that are started after the sqlite3_interrupt() call and before the
2294+** running statements reaches zero are interrupted as if they had been
2295+** running prior to the sqlite3_interrupt() call. ^New SQL statements
2296+** that are started after the running statement count reaches zero are
2297+** not effected by the sqlite3_interrupt().
2298+** ^A call to sqlite3_interrupt(D) that occurs when there are no running
2299+** SQL statements is a no-op and has no effect on SQL statements
2300+** that are started after the sqlite3_interrupt() call returns.
2302+** If the database connection closes while [sqlite3_interrupt()]
2303+** is running then bad things will likely happen.
2305+SQLITE_API void SQLITE_STDCALL sqlite3_interrupt(sqlite3*);
2308+** CAPI3REF: Determine If An SQL Statement Is Complete
2310+** These routines are useful during command-line input to determine if the
2311+** currently entered text seems to form a complete SQL statement or
2312+** if additional input is needed before sending the text into
2313+** SQLite for parsing. ^These routines return 1 if the input string
2314+** appears to be a complete SQL statement. ^A statement is judged to be
2315+** complete if it ends with a semicolon token and is not a prefix of a
2316+** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within
2317+** string literals or quoted identifier names or comments are not
2318+** independent tokens (they are part of the token in which they are
2319+** embedded) and thus do not count as a statement terminator. ^Whitespace
2320+** and comments that follow the final semicolon are ignored.
2322+** ^These routines return 0 if the statement is incomplete. ^If a
2323+** memory allocation fails, then SQLITE_NOMEM is returned.
2325+** ^These routines do not parse the SQL statements thus
2326+** will not detect syntactically incorrect SQL.
2328+** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior
2329+** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked
2330+** automatically by sqlite3_complete16(). If that initialization fails,
2331+** then the return value from sqlite3_complete16() will be non-zero
2332+** regardless of whether or not the input SQL is complete.)^
2334+** The input to [sqlite3_complete()] must be a zero-terminated
2335+** UTF-8 string.
2337+** The input to [sqlite3_complete16()] must be a zero-terminated
2338+** UTF-16 string in native byte order.
2340+SQLITE_API int SQLITE_STDCALL sqlite3_complete(const char *sql);
2341+SQLITE_API int SQLITE_STDCALL sqlite3_complete16(const void *sql);
2344+** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors
2345+** KEYWORDS: {busy-handler callback} {busy handler}
2346+** METHOD: sqlite3
2348+** ^The sqlite3_busy_handler(D,X,P) routine sets a callback function X
2349+** that might be invoked with argument P whenever
2350+** an attempt is made to access a database table associated with
2351+** [database connection] D when another thread
2352+** or process has the table locked.
2353+** The sqlite3_busy_handler() interface is used to implement
2354+** [sqlite3_busy_timeout()] and [PRAGMA busy_timeout].
2356+** ^If the busy callback is NULL, then [SQLITE_BUSY]
2357+** is returned immediately upon encountering the lock. ^If the busy callback
2358+** is not NULL, then the callback might be invoked with two arguments.
2360+** ^The first argument to the busy handler is a copy of the void* pointer which
2361+** is the third argument to sqlite3_busy_handler(). ^The second argument to
2362+** the busy handler callback is the number of times that the busy handler has
2363+** been invoked previously for the same locking event. ^If the
2364+** busy callback returns 0, then no additional attempts are made to
2365+** access the database and [SQLITE_BUSY] is returned
2366+** to the application.
2367+** ^If the callback returns non-zero, then another attempt
2368+** is made to access the database and the cycle repeats.
2370+** The presence of a busy handler does not guarantee that it will be invoked
2371+** when there is lock contention. ^If SQLite determines that invoking the busy
2372+** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY]
2373+** to the application instead of invoking the
2374+** busy handler.
2375+** Consider a scenario where one process is holding a read lock that
2376+** it is trying to promote to a reserved lock and
2377+** a second process is holding a reserved lock that it is trying
2378+** to promote to an exclusive lock. The first process cannot proceed
2379+** because it is blocked by the second and the second process cannot
2380+** proceed because it is blocked by the first. If both processes
2381+** invoke the busy handlers, neither will make any progress. Therefore,
2382+** SQLite returns [SQLITE_BUSY] for the first process, hoping that this
2383+** will induce the first process to release its read lock and allow
2384+** the second process to proceed.
2386+** ^The default busy callback is NULL.
2388+** ^(There can only be a single busy handler defined for each
2389+** [database connection]. Setting a new busy handler clears any
2390+** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()]
2391+** or evaluating [PRAGMA busy_timeout=N] will change the
2392+** busy handler and thus clear any previously set busy handler.
2394+** The busy callback should not take any actions which modify the
2395+** database connection that invoked the busy handler. In other words,
2396+** the busy handler is not reentrant. Any such actions
2397+** result in undefined behavior.
2399+** A busy handler must not close the database connection
2400+** or [prepared statement] that invoked the busy handler.
2402+SQLITE_API int SQLITE_STDCALL sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*);
2405+** CAPI3REF: Set A Busy Timeout
2406+** METHOD: sqlite3
2408+** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps
2409+** for a specified amount of time when a table is locked. ^The handler
2410+** will sleep multiple times until at least "ms" milliseconds of sleeping
2411+** have accumulated. ^After at least "ms" milliseconds of sleeping,
2412+** the handler returns 0 which causes [sqlite3_step()] to return
2413+** [SQLITE_BUSY].
2415+** ^Calling this routine with an argument less than or equal to zero
2416+** turns off all busy handlers.
2418+** ^(There can only be a single busy handler for a particular
2419+** [database connection] at any given moment. If another busy handler
2420+** was defined (using [sqlite3_busy_handler()]) prior to calling
2421+** this routine, that other busy handler is cleared.)^
2423+** See also: [PRAGMA busy_timeout]
2425+SQLITE_API int SQLITE_STDCALL sqlite3_busy_timeout(sqlite3*, int ms);
2428+** CAPI3REF: Convenience Routines For Running Queries
2429+** METHOD: sqlite3
2431+** This is a legacy interface that is preserved for backwards compatibility.
2432+** Use of this interface is not recommended.
2434+** Definition: A <b>result table</b> is memory data structure created by the
2435+** [sqlite3_get_table()] interface. A result table records the
2436+** complete query results from one or more queries.
2438+** The table conceptually has a number of rows and columns. But
2439+** these numbers are not part of the result table itself. These
2440+** numbers are obtained separately. Let N be the number of rows
2441+** and M be the number of columns.
2443+** A result table is an array of pointers to zero-terminated UTF-8 strings.
2444+** There are (N+1)*M elements in the array. The first M pointers point
2445+** to zero-terminated strings that contain the names of the columns.
2446+** The remaining entries all point to query results. NULL values result
2447+** in NULL pointers. All other values are in their UTF-8 zero-terminated
2448+** string representation as returned by [sqlite3_column_text()].
2450+** A result table might consist of one or more memory allocations.
2451+** It is not safe to pass a result table directly to [sqlite3_free()].
2452+** A result table should be deallocated using [sqlite3_free_table()].
2454+** ^(As an example of the result table format, suppose a query result
2455+** is as follows:
2457+** <blockquote><pre>
2458+** Name | Age
2459+** -----------------------
2460+** Alice | 43
2461+** Bob | 28
2462+** Cindy | 21
2463+** </pre></blockquote>
2465+** There are two column (M==2) and three rows (N==3). Thus the
2466+** result table has 8 entries. Suppose the result table is stored
2467+** in an array names azResult. Then azResult holds this content:
2469+** <blockquote><pre>
2470+** azResult&#91;0] = "Name";
2471+** azResult&#91;1] = "Age";
2472+** azResult&#91;2] = "Alice";
2473+** azResult&#91;3] = "43";
2474+** azResult&#91;4] = "Bob";
2475+** azResult&#91;5] = "28";
2476+** azResult&#91;6] = "Cindy";
2477+** azResult&#91;7] = "21";
2478+** </pre></blockquote>)^
2480+** ^The sqlite3_get_table() function evaluates one or more
2481+** semicolon-separated SQL statements in the zero-terminated UTF-8
2482+** string of its 2nd parameter and returns a result table to the
2483+** pointer given in its 3rd parameter.
2485+** After the application has finished with the result from sqlite3_get_table(),
2486+** it must pass the result table pointer to sqlite3_free_table() in order to
2487+** release the memory that was malloced. Because of the way the
2488+** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling
2489+** function must not try to call [sqlite3_free()] directly. Only
2490+** [sqlite3_free_table()] is able to release the memory properly and safely.
2492+** The sqlite3_get_table() interface is implemented as a wrapper around
2493+** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access
2494+** to any internal data structures of SQLite. It uses only the public
2495+** interface defined here. As a consequence, errors that occur in the
2496+** wrapper layer outside of the internal [sqlite3_exec()] call are not
2497+** reflected in subsequent calls to [sqlite3_errcode()] or
2498+** [sqlite3_errmsg()].
2500+SQLITE_API int SQLITE_STDCALL sqlite3_get_table(
2501+ sqlite3 *db, /* An open database */
2502+ const char *zSql, /* SQL to be evaluated */
2503+ char ***pazResult, /* Results of the query */
2504+ int *pnRow, /* Number of result rows written here */
2505+ int *pnColumn, /* Number of result columns written here */
2506+ char **pzErrmsg /* Error msg written here */
2508+SQLITE_API void SQLITE_STDCALL sqlite3_free_table(char **result);
2511+** CAPI3REF: Formatted String Printing Functions
2513+** These routines are work-alikes of the "printf()" family of functions
2514+** from the standard C library.
2515+** These routines understand most of the common K&R formatting options,
2516+** plus some additional non-standard formats, detailed below.
2517+** Note that some of the more obscure formatting options from recent
2518+** C-library standards are omitted from this implementation.
2520+** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their
2521+** results into memory obtained from [sqlite3_malloc()].
2522+** The strings returned by these two routines should be
2523+** released by [sqlite3_free()]. ^Both routines return a
2524+** NULL pointer if [sqlite3_malloc()] is unable to allocate enough
2525+** memory to hold the resulting string.
2527+** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from
2528+** the standard C library. The result is written into the
2529+** buffer supplied as the second parameter whose size is given by
2530+** the first parameter. Note that the order of the
2531+** first two parameters is reversed from snprintf().)^ This is an
2532+** historical accident that cannot be fixed without breaking
2533+** backwards compatibility. ^(Note also that sqlite3_snprintf()
2534+** returns a pointer to its buffer instead of the number of
2535+** characters actually written into the buffer.)^ We admit that
2536+** the number of characters written would be a more useful return
2537+** value but we cannot change the implementation of sqlite3_snprintf()
2538+** now without breaking compatibility.
2540+** ^As long as the buffer size is greater than zero, sqlite3_snprintf()
2541+** guarantees that the buffer is always zero-terminated. ^The first
2542+** parameter "n" is the total size of the buffer, including space for
2543+** the zero terminator. So the longest string that can be completely
2544+** written will be n-1 characters.
2546+** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf().
2548+** These routines all implement some additional formatting
2549+** options that are useful for constructing SQL statements.
2550+** All of the usual printf() formatting options apply. In addition, there
2551+** is are "%q", "%Q", "%w" and "%z" options.
2553+** ^(The %q option works like %s in that it substitutes a nul-terminated
2554+** string from the argument list. But %q also doubles every '\'' character.
2555+** %q is designed for use inside a string literal.)^ By doubling each '\''
2556+** character it escapes that character and allows it to be inserted into
2557+** the string.
2559+** For example, assume the string variable zText contains text as follows:
2561+** <blockquote><pre>
2562+** char *zText = "It's a happy day!";
2563+** </pre></blockquote>
2565+** One can use this text in an SQL statement as follows:
2567+** <blockquote><pre>
2568+** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText);
2569+** sqlite3_exec(db, zSQL, 0, 0, 0);
2570+** sqlite3_free(zSQL);
2571+** </pre></blockquote>
2573+** Because the %q format string is used, the '\'' character in zText
2574+** is escaped and the SQL generated is as follows:
2576+** <blockquote><pre>
2577+** INSERT INTO table1 VALUES('It''s a happy day!')
2578+** </pre></blockquote>
2580+** This is correct. Had we used %s instead of %q, the generated SQL
2581+** would have looked like this:
2583+** <blockquote><pre>
2584+** INSERT INTO table1 VALUES('It's a happy day!');
2585+** </pre></blockquote>
2587+** This second example is an SQL syntax error. As a general rule you should
2588+** always use %q instead of %s when inserting text into a string literal.
2590+** ^(The %Q option works like %q except it also adds single quotes around
2591+** the outside of the total string. Additionally, if the parameter in the
2592+** argument list is a NULL pointer, %Q substitutes the text "NULL" (without
2593+** single quotes).)^ So, for example, one could say:
2595+** <blockquote><pre>
2596+** char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText);
2597+** sqlite3_exec(db, zSQL, 0, 0, 0);
2598+** sqlite3_free(zSQL);
2599+** </pre></blockquote>
2601+** The code above will render a correct SQL statement in the zSQL
2602+** variable even if the zText variable is a NULL pointer.
2604+** ^(The "%w" formatting option is like "%q" except that it expects to
2605+** be contained within double-quotes instead of single quotes, and it
2606+** escapes the double-quote character instead of the single-quote
2607+** character.)^ The "%w" formatting option is intended for safely inserting
2608+** table and column names into a constructed SQL statement.
2610+** ^(The "%z" formatting option works like "%s" but with the
2611+** addition that after the string has been read and copied into
2612+** the result, [sqlite3_free()] is called on the input string.)^
2614+SQLITE_API char *SQLITE_CDECL sqlite3_mprintf(const char*,...);
2615+SQLITE_API char *SQLITE_STDCALL sqlite3_vmprintf(const char*, va_list);
2616+SQLITE_API char *SQLITE_CDECL sqlite3_snprintf(int,char*,const char*, ...);
2617+SQLITE_API char *SQLITE_STDCALL sqlite3_vsnprintf(int,char*,const char*, va_list);
2620+** CAPI3REF: Memory Allocation Subsystem
2622+** The SQLite core uses these three routines for all of its own
2623+** internal memory allocation needs. "Core" in the previous sentence
2624+** does not include operating-system specific VFS implementation. The
2625+** Windows VFS uses native malloc() and free() for some operations.
2627+** ^The sqlite3_malloc() routine returns a pointer to a block
2628+** of memory at least N bytes in length, where N is the parameter.
2629+** ^If sqlite3_malloc() is unable to obtain sufficient free
2630+** memory, it returns a NULL pointer. ^If the parameter N to
2631+** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns
2632+** a NULL pointer.
2634+** ^The sqlite3_malloc64(N) routine works just like
2635+** sqlite3_malloc(N) except that N is an unsigned 64-bit integer instead
2636+** of a signed 32-bit integer.
2638+** ^Calling sqlite3_free() with a pointer previously returned
2639+** by sqlite3_malloc() or sqlite3_realloc() releases that memory so
2640+** that it might be reused. ^The sqlite3_free() routine is
2641+** a no-op if is called with a NULL pointer. Passing a NULL pointer
2642+** to sqlite3_free() is harmless. After being freed, memory
2643+** should neither be read nor written. Even reading previously freed
2644+** memory might result in a segmentation fault or other severe error.
2645+** Memory corruption, a segmentation fault, or other severe error
2646+** might result if sqlite3_free() is called with a non-NULL pointer that
2647+** was not obtained from sqlite3_malloc() or sqlite3_realloc().
2649+** ^The sqlite3_realloc(X,N) interface attempts to resize a
2650+** prior memory allocation X to be at least N bytes.
2651+** ^If the X parameter to sqlite3_realloc(X,N)
2652+** is a NULL pointer then its behavior is identical to calling
2653+** sqlite3_malloc(N).
2654+** ^If the N parameter to sqlite3_realloc(X,N) is zero or
2655+** negative then the behavior is exactly the same as calling
2656+** sqlite3_free(X).
2657+** ^sqlite3_realloc(X,N) returns a pointer to a memory allocation
2658+** of at least N bytes in size or NULL if insufficient memory is available.
2659+** ^If M is the size of the prior allocation, then min(N,M) bytes
2660+** of the prior allocation are copied into the beginning of buffer returned
2661+** by sqlite3_realloc(X,N) and the prior allocation is freed.
2662+** ^If sqlite3_realloc(X,N) returns NULL and N is positive, then the
2663+** prior allocation is not freed.
2665+** ^The sqlite3_realloc64(X,N) interfaces works the same as
2666+** sqlite3_realloc(X,N) except that N is a 64-bit unsigned integer instead
2667+** of a 32-bit signed integer.
2669+** ^If X is a memory allocation previously obtained from sqlite3_malloc(),
2670+** sqlite3_malloc64(), sqlite3_realloc(), or sqlite3_realloc64(), then
2671+** sqlite3_msize(X) returns the size of that memory allocation in bytes.
2672+** ^The value returned by sqlite3_msize(X) might be larger than the number
2673+** of bytes requested when X was allocated. ^If X is a NULL pointer then
2674+** sqlite3_msize(X) returns zero. If X points to something that is not
2675+** the beginning of memory allocation, or if it points to a formerly
2676+** valid memory allocation that has now been freed, then the behavior
2677+** of sqlite3_msize(X) is undefined and possibly harmful.
2679+** ^The memory returned by sqlite3_malloc(), sqlite3_realloc(),
2680+** sqlite3_malloc64(), and sqlite3_realloc64()
2681+** is always aligned to at least an 8 byte boundary, or to a
2682+** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time
2683+** option is used.
2685+** In SQLite version 3.5.0 and 3.5.1, it was possible to define
2686+** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in
2687+** implementation of these routines to be omitted. That capability
2688+** is no longer provided. Only built-in memory allocators can be used.
2690+** Prior to SQLite version 3.7.10, the Windows OS interface layer called
2691+** the system malloc() and free() directly when converting
2692+** filenames between the UTF-8 encoding used by SQLite
2693+** and whatever filename encoding is used by the particular Windows
2694+** installation. Memory allocation errors were detected, but
2695+** they were reported back as [SQLITE_CANTOPEN] or
2696+** [SQLITE_IOERR] rather than [SQLITE_NOMEM].
2698+** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()]
2699+** must be either NULL or else pointers obtained from a prior
2700+** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have
2701+** not yet been released.
2703+** The application must not read or write any part of
2704+** a block of memory after it has been released using
2705+** [sqlite3_free()] or [sqlite3_realloc()].
2707+SQLITE_API void *SQLITE_STDCALL sqlite3_malloc(int);
2708+SQLITE_API void *SQLITE_STDCALL sqlite3_malloc64(sqlite3_uint64);
2709+SQLITE_API void *SQLITE_STDCALL sqlite3_realloc(void*, int);
2710+SQLITE_API void *SQLITE_STDCALL sqlite3_realloc64(void*, sqlite3_uint64);
2711+SQLITE_API void SQLITE_STDCALL sqlite3_free(void*);
2712+SQLITE_API sqlite3_uint64 SQLITE_STDCALL sqlite3_msize(void*);
2715+** CAPI3REF: Memory Allocator Statistics
2717+** SQLite provides these two interfaces for reporting on the status
2718+** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()]
2719+** routines, which form the built-in memory allocation subsystem.
2721+** ^The [sqlite3_memory_used()] routine returns the number of bytes
2722+** of memory currently outstanding (malloced but not freed).
2723+** ^The [sqlite3_memory_highwater()] routine returns the maximum
2724+** value of [sqlite3_memory_used()] since the high-water mark
2725+** was last reset. ^The values returned by [sqlite3_memory_used()] and
2726+** [sqlite3_memory_highwater()] include any overhead
2727+** added by SQLite in its implementation of [sqlite3_malloc()],
2728+** but not overhead added by the any underlying system library
2729+** routines that [sqlite3_malloc()] may call.
2731+** ^The memory high-water mark is reset to the current value of
2732+** [sqlite3_memory_used()] if and only if the parameter to
2733+** [sqlite3_memory_highwater()] is true. ^The value returned
2734+** by [sqlite3_memory_highwater(1)] is the high-water mark
2735+** prior to the reset.
2737+SQLITE_API sqlite3_int64 SQLITE_STDCALL sqlite3_memory_used(void);
2738+SQLITE_API sqlite3_int64 SQLITE_STDCALL sqlite3_memory_highwater(int resetFlag);
2741+** CAPI3REF: Pseudo-Random Number Generator
2743+** SQLite contains a high-quality pseudo-random number generator (PRNG) used to
2744+** select random [ROWID | ROWIDs] when inserting new records into a table that
2745+** already uses the largest possible [ROWID]. The PRNG is also used for
2746+** the build-in random() and randomblob() SQL functions. This interface allows
2747+** applications to access the same PRNG for other purposes.
2749+** ^A call to this routine stores N bytes of randomness into buffer P.
2750+** ^The P parameter can be a NULL pointer.
2752+** ^If this routine has not been previously called or if the previous
2753+** call had N less than one or a NULL pointer for P, then the PRNG is
2754+** seeded using randomness obtained from the xRandomness method of
2755+** the default [sqlite3_vfs] object.
2756+** ^If the previous call to this routine had an N of 1 or more and a
2757+** non-NULL P then the pseudo-randomness is generated
2758+** internally and without recourse to the [sqlite3_vfs] xRandomness
2759+** method.
2761+SQLITE_API void SQLITE_STDCALL sqlite3_randomness(int N, void *P);
2764+** CAPI3REF: Compile-Time Authorization Callbacks
2765+** METHOD: sqlite3
2767+** ^This routine registers an authorizer callback with a particular
2768+** [database connection], supplied in the first argument.
2769+** ^The authorizer callback is invoked as SQL statements are being compiled
2770+** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()],
2771+** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. ^At various
2772+** points during the compilation process, as logic is being created
2773+** to perform various actions, the authorizer callback is invoked to
2774+** see if those actions are allowed. ^The authorizer callback should
2775+** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the
2776+** specific action but allow the SQL statement to continue to be
2777+** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be
2778+** rejected with an error. ^If the authorizer callback returns
2779+** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY]
2780+** then the [sqlite3_prepare_v2()] or equivalent call that triggered
2781+** the authorizer will fail with an error message.
2783+** When the callback returns [SQLITE_OK], that means the operation
2784+** requested is ok. ^When the callback returns [SQLITE_DENY], the
2785+** [sqlite3_prepare_v2()] or equivalent call that triggered the
2786+** authorizer will fail with an error message explaining that
2787+** access is denied.
2789+** ^The first parameter to the authorizer callback is a copy of the third
2790+** parameter to the sqlite3_set_authorizer() interface. ^The second parameter
2791+** to the callback is an integer [SQLITE_COPY | action code] that specifies
2792+** the particular action to be authorized. ^The third through sixth parameters
2793+** to the callback are zero-terminated strings that contain additional
2794+** details about the action to be authorized.
2796+** ^If the action code is [SQLITE_READ]
2797+** and the callback returns [SQLITE_IGNORE] then the
2798+** [prepared statement] statement is constructed to substitute
2799+** a NULL value in place of the table column that would have
2800+** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE]
2801+** return can be used to deny an untrusted user access to individual
2802+** columns of a table.
2803+** ^If the action code is [SQLITE_DELETE] and the callback returns
2804+** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the
2805+** [truncate optimization] is disabled and all rows are deleted individually.
2807+** An authorizer is used when [sqlite3_prepare | preparing]
2808+** SQL statements from an untrusted source, to ensure that the SQL statements
2809+** do not try to access data they are not allowed to see, or that they do not
2810+** try to execute malicious statements that damage the database. For
2811+** example, an application may allow a user to enter arbitrary
2812+** SQL queries for evaluation by a database. But the application does
2813+** not want the user to be able to make arbitrary changes to the
2814+** database. An authorizer could then be put in place while the
2815+** user-entered SQL is being [sqlite3_prepare | prepared] that
2816+** disallows everything except [SELECT] statements.
2818+** Applications that need to process SQL from untrusted sources
2819+** might also consider lowering resource limits using [sqlite3_limit()]
2820+** and limiting database size using the [max_page_count] [PRAGMA]
2821+** in addition to using an authorizer.
2823+** ^(Only a single authorizer can be in place on a database connection
2824+** at a time. Each call to sqlite3_set_authorizer overrides the
2825+** previous call.)^ ^Disable the authorizer by installing a NULL callback.
2826+** The authorizer is disabled by default.
2828+** The authorizer callback must not do anything that will modify
2829+** the database connection that invoked the authorizer callback.
2830+** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
2831+** database connections for the meaning of "modify" in this paragraph.
2833+** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the
2834+** statement might be re-prepared during [sqlite3_step()] due to a
2835+** schema change. Hence, the application should ensure that the
2836+** correct authorizer callback remains in place during the [sqlite3_step()].
2838+** ^Note that the authorizer callback is invoked only during
2839+** [sqlite3_prepare()] or its variants. Authorization is not
2840+** performed during statement evaluation in [sqlite3_step()], unless
2841+** as stated in the previous paragraph, sqlite3_step() invokes
2842+** sqlite3_prepare_v2() to reprepare a statement after a schema change.
2844+SQLITE_API int SQLITE_STDCALL sqlite3_set_authorizer(
2845+ sqlite3*,
2846+ int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
2847+ void *pUserData
2851+** CAPI3REF: Authorizer Return Codes
2853+** The [sqlite3_set_authorizer | authorizer callback function] must
2854+** return either [SQLITE_OK] or one of these two constants in order
2855+** to signal SQLite whether or not the action is permitted. See the
2856+** [sqlite3_set_authorizer | authorizer documentation] for additional
2857+** information.
2859+** Note that SQLITE_IGNORE is also used as a [conflict resolution mode]
2860+** returned from the [sqlite3_vtab_on_conflict()] interface.
2862+#define SQLITE_DENY 1 /* Abort the SQL statement with an error */
2863+#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
2866+** CAPI3REF: Authorizer Action Codes
2868+** The [sqlite3_set_authorizer()] interface registers a callback function
2869+** that is invoked to authorize certain SQL statement actions. The
2870+** second parameter to the callback is an integer code that specifies
2871+** what action is being authorized. These are the integer action codes that
2872+** the authorizer callback may be passed.
2874+** These action code values signify what kind of operation is to be
2875+** authorized. The 3rd and 4th parameters to the authorization
2876+** callback function will be parameters or NULL depending on which of these
2877+** codes is used as the second parameter. ^(The 5th parameter to the
2878+** authorizer callback is the name of the database ("main", "temp",
2879+** etc.) if applicable.)^ ^The 6th parameter to the authorizer callback
2880+** is the name of the inner-most trigger or view that is responsible for
2881+** the access attempt or NULL if this access attempt is directly from
2882+** top-level SQL code.
2884+/******************************************* 3rd ************ 4th ***********/
2885+#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */
2886+#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */
2887+#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */
2888+#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */
2889+#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */
2890+#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */
2891+#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */
2892+#define SQLITE_CREATE_VIEW 8 /* View Name NULL */
2893+#define SQLITE_DELETE 9 /* Table Name NULL */
2894+#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */
2895+#define SQLITE_DROP_TABLE 11 /* Table Name NULL */
2896+#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */
2897+#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */
2898+#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */
2899+#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */
2900+#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */
2901+#define SQLITE_DROP_VIEW 17 /* View Name NULL */
2902+#define SQLITE_INSERT 18 /* Table Name NULL */
2903+#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */
2904+#define SQLITE_READ 20 /* Table Name Column Name */
2905+#define SQLITE_SELECT 21 /* NULL NULL */
2906+#define SQLITE_TRANSACTION 22 /* Operation NULL */
2907+#define SQLITE_UPDATE 23 /* Table Name Column Name */
2908+#define SQLITE_ATTACH 24 /* Filename NULL */
2909+#define SQLITE_DETACH 25 /* Database Name NULL */
2910+#define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */
2911+#define SQLITE_REINDEX 27 /* Index Name NULL */
2912+#define SQLITE_ANALYZE 28 /* Table Name NULL */
2913+#define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */
2914+#define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */
2915+#define SQLITE_FUNCTION 31 /* NULL Function Name */
2916+#define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */
2917+#define SQLITE_COPY 0 /* No longer used */
2918+#define SQLITE_RECURSIVE 33 /* NULL NULL */
2921+** CAPI3REF: Tracing And Profiling Functions
2922+** METHOD: sqlite3
2924+** These routines register callback functions that can be used for
2925+** tracing and profiling the execution of SQL statements.
2927+** ^The callback function registered by sqlite3_trace() is invoked at
2928+** various times when an SQL statement is being run by [sqlite3_step()].
2929+** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the
2930+** SQL statement text as the statement first begins executing.
2931+** ^(Additional sqlite3_trace() callbacks might occur
2932+** as each triggered subprogram is entered. The callbacks for triggers
2933+** contain a UTF-8 SQL comment that identifies the trigger.)^
2935+** The [SQLITE_TRACE_SIZE_LIMIT] compile-time option can be used to limit
2936+** the length of [bound parameter] expansion in the output of sqlite3_trace().
2938+** ^The callback function registered by sqlite3_profile() is invoked
2939+** as each SQL statement finishes. ^The profile callback contains
2940+** the original statement text and an estimate of wall-clock time
2941+** of how long that statement took to run. ^The profile callback
2942+** time is in units of nanoseconds, however the current implementation
2943+** is only capable of millisecond resolution so the six least significant
2944+** digits in the time are meaningless. Future versions of SQLite
2945+** might provide greater resolution on the profiler callback. The
2946+** sqlite3_profile() function is considered experimental and is
2947+** subject to change in future versions of SQLite.
2949+SQLITE_API void *SQLITE_STDCALL sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*);
2950+SQLITE_API SQLITE_EXPERIMENTAL void *SQLITE_STDCALL sqlite3_profile(sqlite3*,
2951+ void(*xProfile)(void*,const char*,sqlite3_uint64), void*);
2954+** CAPI3REF: Query Progress Callbacks
2955+** METHOD: sqlite3
2957+** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback
2958+** function X to be invoked periodically during long running calls to
2959+** [sqlite3_exec()], [sqlite3_step()] and [sqlite3_get_table()] for
2960+** database connection D. An example use for this
2961+** interface is to keep a GUI updated during a large query.
2963+** ^The parameter P is passed through as the only parameter to the
2964+** callback function X. ^The parameter N is the approximate number of
2965+** [virtual machine instructions] that are evaluated between successive
2966+** invocations of the callback X. ^If N is less than one then the progress
2967+** handler is disabled.
2969+** ^Only a single progress handler may be defined at one time per
2970+** [database connection]; setting a new progress handler cancels the
2971+** old one. ^Setting parameter X to NULL disables the progress handler.
2972+** ^The progress handler is also disabled by setting N to a value less
2973+** than 1.
2975+** ^If the progress callback returns non-zero, the operation is
2976+** interrupted. This feature can be used to implement a
2977+** "Cancel" button on a GUI progress dialog box.
2979+** The progress handler callback must not do anything that will modify
2980+** the database connection that invoked the progress handler.
2981+** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
2982+** database connections for the meaning of "modify" in this paragraph.
2985+SQLITE_API void SQLITE_STDCALL sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
2988+** CAPI3REF: Opening A New Database Connection
2989+** CONSTRUCTOR: sqlite3
2991+** ^These routines open an SQLite database file as specified by the
2992+** filename argument. ^The filename argument is interpreted as UTF-8 for
2993+** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte
2994+** order for sqlite3_open16(). ^(A [database connection] handle is usually
2995+** returned in *ppDb, even if an error occurs. The only exception is that
2996+** if SQLite is unable to allocate memory to hold the [sqlite3] object,
2997+** a NULL will be written into *ppDb instead of a pointer to the [sqlite3]
2998+** object.)^ ^(If the database is opened (and/or created) successfully, then
2999+** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The
3000+** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain
3001+** an English language description of the error following a failure of any
3002+** of the sqlite3_open() routines.
3004+** ^The default encoding will be UTF-8 for databases created using
3005+** sqlite3_open() or sqlite3_open_v2(). ^The default encoding for databases
3006+** created using sqlite3_open16() will be UTF-16 in the native byte order.
3008+** Whether or not an error occurs when it is opened, resources
3009+** associated with the [database connection] handle should be released by
3010+** passing it to [sqlite3_close()] when it is no longer required.
3012+** The sqlite3_open_v2() interface works like sqlite3_open()
3013+** except that it accepts two additional parameters for additional control
3014+** over the new database connection. ^(The flags parameter to
3015+** sqlite3_open_v2() can take one of
3016+** the following three values, optionally combined with the
3020+** <dl>
3021+** ^(<dt>[SQLITE_OPEN_READONLY]</dt>
3022+** <dd>The database is opened in read-only mode. If the database does not
3023+** already exist, an error is returned.</dd>)^
3025+** ^(<dt>[SQLITE_OPEN_READWRITE]</dt>
3026+** <dd>The database is opened for reading and writing if possible, or reading
3027+** only if the file is write protected by the operating system. In either
3028+** case the database must already exist, otherwise an error is returned.</dd>)^
3031+** <dd>The database is opened for reading and writing, and is created if
3032+** it does not already exist. This is the behavior that is always used for
3033+** sqlite3_open() and sqlite3_open16().</dd>)^
3034+** </dl>
3036+** If the 3rd parameter to sqlite3_open_v2() is not one of the
3037+** combinations shown above optionally combined with other
3039+** then the behavior is undefined.
3041+** ^If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection
3042+** opens in the multi-thread [threading mode] as long as the single-thread
3043+** mode has not been set at compile-time or start-time. ^If the
3044+** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens
3045+** in the serialized [threading mode] unless single-thread was
3046+** previously selected at compile-time or start-time.
3047+** ^The [SQLITE_OPEN_SHAREDCACHE] flag causes the database connection to be
3048+** eligible to use [shared cache mode], regardless of whether or not shared
3049+** cache is enabled using [sqlite3_enable_shared_cache()]. ^The
3050+** [SQLITE_OPEN_PRIVATECACHE] flag causes the database connection to not
3051+** participate in [shared cache mode] even if it is enabled.
3053+** ^The fourth parameter to sqlite3_open_v2() is the name of the
3054+** [sqlite3_vfs] object that defines the operating system interface that
3055+** the new database connection should use. ^If the fourth parameter is
3056+** a NULL pointer then the default [sqlite3_vfs] object is used.
3058+** ^If the filename is ":memory:", then a private, temporary in-memory database
3059+** is created for the connection. ^This in-memory database will vanish when
3060+** the database connection is closed. Future versions of SQLite might
3061+** make use of additional special filenames that begin with the ":" character.
3062+** It is recommended that when a database filename actually does begin with
3063+** a ":" character you should prefix the filename with a pathname such as
3064+** "./" to avoid ambiguity.
3066+** ^If the filename is an empty string, then a private, temporary
3067+** on-disk database will be created. ^This private database will be
3068+** automatically deleted as soon as the database connection is closed.
3070+** [[URI filenames in sqlite3_open()]] <h3>URI Filenames</h3>
3072+** ^If [URI filename] interpretation is enabled, and the filename argument
3073+** begins with "file:", then the filename is interpreted as a URI. ^URI
3074+** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is
3075+** set in the fourth argument to sqlite3_open_v2(), or if it has
3076+** been enabled globally using the [SQLITE_CONFIG_URI] option with the
3077+** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option.
3078+** As of SQLite version 3.7.7, URI filename interpretation is turned off
3079+** by default, but future releases of SQLite might enable URI filename
3080+** interpretation by default. See "[URI filenames]" for additional
3081+** information.
3083+** URI filenames are parsed according to RFC 3986. ^If the URI contains an
3084+** authority, then it must be either an empty string or the string
3085+** "localhost". ^If the authority is not an empty string or "localhost", an
3086+** error is returned to the caller. ^The fragment component of a URI, if
3087+** present, is ignored.
3089+** ^SQLite uses the path component of the URI as the name of the disk file
3090+** which contains the database. ^If the path begins with a '/' character,
3091+** then it is interpreted as an absolute path. ^If the path does not begin
3092+** with a '/' (meaning that the authority section is omitted from the URI)
3093+** then the path is interpreted as a relative path.
3094+** ^(On windows, the first component of an absolute path
3095+** is a drive specification (e.g. "C:").)^
3097+** [[core URI query parameters]]
3098+** The query component of a URI may contain parameters that are interpreted
3099+** either by SQLite itself, or by a [VFS | custom VFS implementation].
3100+** SQLite and its built-in [VFSes] interpret the
3101+** following query parameters:
3103+** <ul>
3104+** <li> <b>vfs</b>: ^The "vfs" parameter may be used to specify the name of
3105+** a VFS object that provides the operating system interface that should
3106+** be used to access the database file on disk. ^If this option is set to
3107+** an empty string the default VFS object is used. ^Specifying an unknown
3108+** VFS is an error. ^If sqlite3_open_v2() is used and the vfs option is
3109+** present, then the VFS specified by the option takes precedence over
3110+** the value passed as the fourth parameter to sqlite3_open_v2().
3112+** <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw",
3113+** "rwc", or "memory". Attempting to set it to any other value is
3114+** an error)^.
3115+** ^If "ro" is specified, then the database is opened for read-only
3116+** access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the
3117+** third argument to sqlite3_open_v2(). ^If the mode option is set to
3118+** "rw", then the database is opened for read-write (but not create)
3119+** access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had
3120+** been set. ^Value "rwc" is equivalent to setting both
3121+** SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE. ^If the mode option is
3122+** set to "memory" then a pure [in-memory database] that never reads
3123+** or writes from disk is used. ^It is an error to specify a value for
3124+** the mode parameter that is less restrictive than that specified by
3125+** the flags passed in the third parameter to sqlite3_open_v2().
3127+** <li> <b>cache</b>: ^The cache parameter may be set to either "shared" or
3128+** "private". ^Setting it to "shared" is equivalent to setting the
3129+** SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to
3130+** sqlite3_open_v2(). ^Setting the cache parameter to "private" is
3131+** equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit.
3132+** ^If sqlite3_open_v2() is used and the "cache" parameter is present in
3133+** a URI filename, its value overrides any behavior requested by setting
3136+** <li> <b>psow</b>: ^The psow parameter indicates whether or not the
3137+** [powersafe overwrite] property does or does not apply to the
3138+** storage media on which the database file resides.
3140+** <li> <b>nolock</b>: ^The nolock parameter is a boolean query parameter
3141+** which if set disables file locking in rollback journal modes. This
3142+** is useful for accessing a database on a filesystem that does not
3143+** support locking. Caution: Database corruption might result if two
3144+** or more processes write to the same database and any one of those
3145+** processes uses nolock=1.
3147+** <li> <b>immutable</b>: ^The immutable parameter is a boolean query
3148+** parameter that indicates that the database file is stored on
3149+** read-only media. ^When immutable is set, SQLite assumes that the
3150+** database file cannot be changed, even by a process with higher
3151+** privilege, and so the database is opened read-only and all locking
3152+** and change detection is disabled. Caution: Setting the immutable
3153+** property on a database file that does in fact change can result
3154+** in incorrect query results and/or [SQLITE_CORRUPT] errors.
3155+** See also: [SQLITE_IOCAP_IMMUTABLE].
3157+** </ul>
3159+** ^Specifying an unknown parameter in the query component of a URI is not an
3160+** error. Future versions of SQLite might understand additional query
3161+** parameters. See "[query parameters with special meaning to SQLite]" for
3162+** additional information.
3164+** [[URI filename examples]] <h3>URI filename examples</h3>
3166+** <table border="1" align=center cellpadding=5>
3167+** <tr><th> URI filenames <th> Results
3168+** <tr><td> file:data.db <td>
3169+** Open the file "data.db" in the current directory.
3170+** <tr><td> file:/home/fred/data.db<br>
3171+** file:///home/fred/data.db <br>
3172+** file://localhost/home/fred/data.db <br> <td>
3173+** Open the database file "/home/fred/data.db".
3174+** <tr><td> file://darkstar/home/fred/data.db <td>
3175+** An error. "darkstar" is not a recognized authority.
3176+** <tr><td style="white-space:nowrap">
3177+** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db
3178+** <td> Windows only: Open the file "data.db" on fred's desktop on drive
3179+** C:. Note that the %20 escaping in this example is not strictly
3180+** necessary - space characters can be used literally
3181+** in URI filenames.
3182+** <tr><td> file:data.db?mode=ro&cache=private <td>
3183+** Open file "data.db" in the current directory for read-only access.
3184+** Regardless of whether or not shared-cache mode is enabled by
3185+** default, use a private cache.
3186+** <tr><td> file:/home/fred/data.db?vfs=unix-dotfile <td>
3187+** Open file "/home/fred/data.db". Use the special VFS "unix-dotfile"
3188+** that uses dot-files in place of posix advisory locking.
3189+** <tr><td> file:data.db?mode=readonly <td>
3190+** An error. "readonly" is not a valid option for the "mode" parameter.
3191+** </table>
3193+** ^URI hexadecimal escape sequences (%HH) are supported within the path and
3194+** query components of a URI. A hexadecimal escape sequence consists of a
3195+** percent sign - "%" - followed by exactly two hexadecimal digits
3196+** specifying an octet value. ^Before the path or query components of a
3197+** URI filename are interpreted, they are encoded using UTF-8 and all
3198+** hexadecimal escape sequences replaced by a single byte containing the
3199+** corresponding octet. If this process generates an invalid UTF-8 encoding,
3200+** the results are undefined.
3202+** <b>Note to Windows users:</b> The encoding used for the filename argument
3203+** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever
3204+** codepage is currently defined. Filenames containing international
3205+** characters must be converted to UTF-8 prior to passing them into
3206+** sqlite3_open() or sqlite3_open_v2().
3208+** <b>Note to Windows Runtime users:</b> The temporary directory must be set
3209+** prior to calling sqlite3_open() or sqlite3_open_v2(). Otherwise, various
3210+** features that require the use of temporary files may fail.
3212+** See also: [sqlite3_temp_directory]
3214+SQLITE_API int SQLITE_STDCALL sqlite3_open(
3215+ const char *filename, /* Database filename (UTF-8) */
3216+ sqlite3 **ppDb /* OUT: SQLite db handle */
3218+SQLITE_API int SQLITE_STDCALL sqlite3_open16(
3219+ const void *filename, /* Database filename (UTF-16) */
3220+ sqlite3 **ppDb /* OUT: SQLite db handle */
3222+SQLITE_API int SQLITE_STDCALL sqlite3_open_v2(
3223+ const char *filename, /* Database filename (UTF-8) */
3224+ sqlite3 **ppDb, /* OUT: SQLite db handle */
3225+ int flags, /* Flags */
3226+ const char *zVfs /* Name of VFS module to use */
3230+** CAPI3REF: Obtain Values For URI Parameters
3232+** These are utility routines, useful to VFS implementations, that check
3233+** to see if a database file was a URI that contained a specific query
3234+** parameter, and if so obtains the value of that query parameter.
3236+** If F is the database filename pointer passed into the xOpen() method of
3237+** a VFS implementation when the flags parameter to xOpen() has one or
3238+** more of the [SQLITE_OPEN_URI] or [SQLITE_OPEN_MAIN_DB] bits set and
3239+** P is the name of the query parameter, then
3240+** sqlite3_uri_parameter(F,P) returns the value of the P
3241+** parameter if it exists or a NULL pointer if P does not appear as a
3242+** query parameter on F. If P is a query parameter of F
3243+** has no explicit value, then sqlite3_uri_parameter(F,P) returns
3244+** a pointer to an empty string.
3246+** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean
3247+** parameter and returns true (1) or false (0) according to the value
3248+** of P. The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the
3249+** value of query parameter P is one of "yes", "true", or "on" in any
3250+** case or if the value begins with a non-zero number. The
3251+** sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of
3252+** query parameter P is one of "no", "false", or "off" in any case or
3253+** if the value begins with a numeric zero. If P is not a query
3254+** parameter on F or if the value of P is does not match any of the
3255+** above, then sqlite3_uri_boolean(F,P,B) returns (B!=0).
3257+** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a
3258+** 64-bit signed integer and returns that integer, or D if P does not
3259+** exist. If the value of P is something other than an integer, then
3260+** zero is returned.
3262+** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and
3263+** sqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and
3264+** is not a database file pathname pointer that SQLite passed into the xOpen
3265+** VFS method, then the behavior of this routine is undefined and probably
3266+** undesirable.
3268+SQLITE_API const char *SQLITE_STDCALL sqlite3_uri_parameter(const char *zFilename, const char *zParam);
3269+SQLITE_API int SQLITE_STDCALL sqlite3_uri_boolean(const char *zFile, const char *zParam, int bDefault);
3270+SQLITE_API sqlite3_int64 SQLITE_STDCALL sqlite3_uri_int64(const char*, const char*, sqlite3_int64);
3274+** CAPI3REF: Error Codes And Messages
3275+** METHOD: sqlite3
3277+** ^If the most recent sqlite3_* API call associated with
3278+** [database connection] D failed, then the sqlite3_errcode(D) interface
3279+** returns the numeric [result code] or [extended result code] for that
3280+** API call.
3281+** If the most recent API call was successful,
3282+** then the return value from sqlite3_errcode() is undefined.
3283+** ^The sqlite3_extended_errcode()
3284+** interface is the same except that it always returns the
3285+** [extended result code] even when extended result codes are
3286+** disabled.
3288+** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language
3289+** text that describes the error, as either UTF-8 or UTF-16 respectively.
3290+** ^(Memory to hold the error message string is managed internally.
3291+** The application does not need to worry about freeing the result.
3292+** However, the error string might be overwritten or deallocated by
3293+** subsequent calls to other SQLite interface functions.)^
3295+** ^The sqlite3_errstr() interface returns the English-language text
3296+** that describes the [result code], as UTF-8.
3297+** ^(Memory to hold the error message string is managed internally
3298+** and must not be freed by the application)^.
3300+** When the serialized [threading mode] is in use, it might be the
3301+** case that a second error occurs on a separate thread in between
3302+** the time of the first error and the call to these interfaces.
3303+** When that happens, the second error will be reported since these
3304+** interfaces always report the most recent result. To avoid
3305+** this, each thread can obtain exclusive use of the [database connection] D
3306+** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning
3307+** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after
3308+** all calls to the interfaces listed here are completed.
3310+** If an interface fails with SQLITE_MISUSE, that means the interface
3311+** was invoked incorrectly by the application. In that case, the
3312+** error code and message may or may not be set.
3314+SQLITE_API int SQLITE_STDCALL sqlite3_errcode(sqlite3 *db);
3315+SQLITE_API int SQLITE_STDCALL sqlite3_extended_errcode(sqlite3 *db);
3316+SQLITE_API const char *SQLITE_STDCALL sqlite3_errmsg(sqlite3*);
3317+SQLITE_API const void *SQLITE_STDCALL sqlite3_errmsg16(sqlite3*);
3318+SQLITE_API const char *SQLITE_STDCALL sqlite3_errstr(int);
3321+** CAPI3REF: Prepared Statement Object
3322+** KEYWORDS: {prepared statement} {prepared statements}
3324+** An instance of this object represents a single SQL statement that
3325+** has been compiled into binary form and is ready to be evaluated.
3327+** Think of each SQL statement as a separate computer program. The
3328+** original SQL text is source code. A prepared statement object
3329+** is the compiled object code. All SQL must be converted into a
3330+** prepared statement before it can be run.
3332+** The life-cycle of a prepared statement object usually goes like this:
3334+** <ol>
3335+** <li> Create the prepared statement object using [sqlite3_prepare_v2()].
3336+** <li> Bind values to [parameters] using the sqlite3_bind_*()
3337+** interfaces.
3338+** <li> Run the SQL by calling [sqlite3_step()] one or more times.
3339+** <li> Reset the prepared statement using [sqlite3_reset()] then go back
3340+** to step 2. Do this zero or more times.
3341+** <li> Destroy the object using [sqlite3_finalize()].
3342+** </ol>
3344+typedef struct sqlite3_stmt sqlite3_stmt;
3347+** CAPI3REF: Run-time Limits
3348+** METHOD: sqlite3
3350+** ^(This interface allows the size of various constructs to be limited
3351+** on a connection by connection basis. The first parameter is the
3352+** [database connection] whose limit is to be set or queried. The
3353+** second parameter is one of the [limit categories] that define a
3354+** class of constructs to be size limited. The third parameter is the
3355+** new limit for that construct.)^
3357+** ^If the new limit is a negative number, the limit is unchanged.
3358+** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a
3359+** [limits | hard upper bound]
3360+** set at compile-time by a C preprocessor macro called
3361+** [limits | SQLITE_MAX_<i>NAME</i>].
3362+** (The "_LIMIT_" in the name is changed to "_MAX_".))^
3363+** ^Attempts to increase a limit above its hard upper bound are
3364+** silently truncated to the hard upper bound.
3366+** ^Regardless of whether or not the limit was changed, the
3367+** [sqlite3_limit()] interface returns the prior value of the limit.
3368+** ^Hence, to find the current value of a limit without changing it,
3369+** simply invoke this interface with the third parameter set to -1.
3371+** Run-time limits are intended for use in applications that manage
3372+** both their own internal database and also databases that are controlled
3373+** by untrusted external sources. An example application might be a
3374+** web browser that has its own databases for storing history and
3375+** separate databases controlled by JavaScript applications downloaded
3376+** off the Internet. The internal databases can be given the
3377+** large, default limits. Databases managed by external sources can
3378+** be given much smaller limits designed to prevent a denial of service
3379+** attack. Developers might also want to use the [sqlite3_set_authorizer()]
3380+** interface to further control untrusted SQL. The size of the database
3381+** created by an untrusted script can be contained using the
3382+** [max_page_count] [PRAGMA].
3384+** New run-time limit categories may be added in future releases.
3386+SQLITE_API int SQLITE_STDCALL sqlite3_limit(sqlite3*, int id, int newVal);
3389+** CAPI3REF: Run-Time Limit Categories
3390+** KEYWORDS: {limit category} {*limit categories}
3392+** These constants define various performance limits
3393+** that can be lowered at run-time using [sqlite3_limit()].
3394+** The synopsis of the meanings of the various limits is shown below.
3395+** Additional information is available at [limits | Limits in SQLite].
3397+** <dl>
3399+** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^
3402+** <dd>The maximum length of an SQL statement, in bytes.</dd>)^
3405+** <dd>The maximum number of columns in a table definition or in the
3406+** result set of a [SELECT] or the maximum number of columns in an index
3407+** or in an ORDER BY or GROUP BY clause.</dd>)^
3410+** <dd>The maximum depth of the parse tree on any expression.</dd>)^
3413+** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^
3416+** <dd>The maximum number of instructions in a virtual machine program
3417+** used to implement an SQL statement. This limit is not currently
3418+** enforced, though that might be added in some future release of
3419+** SQLite.</dd>)^
3422+** <dd>The maximum number of arguments on a function.</dd>)^
3425+** <dd>The maximum number of [ATTACH | attached databases].)^</dd>
3429+** <dd>The maximum length of the pattern argument to the [LIKE] or
3430+** [GLOB] operators.</dd>)^
3434+** <dd>The maximum index number of any [parameter] in an SQL statement.)^
3437+** <dd>The maximum depth of recursion for triggers.</dd>)^
3440+** <dd>The maximum number of auxiliary worker threads that a single
3441+** [prepared statement] may start.</dd>)^
3442+** </dl>
3444+#define SQLITE_LIMIT_LENGTH 0
3446+#define SQLITE_LIMIT_COLUMN 2
3449+#define SQLITE_LIMIT_VDBE_OP 5
3458+** CAPI3REF: Compiling An SQL Statement
3459+** KEYWORDS: {SQL statement compiler}
3460+** METHOD: sqlite3
3461+** CONSTRUCTOR: sqlite3_stmt
3463+** To execute an SQL query, it must first be compiled into a byte-code
3464+** program using one of these routines.
3466+** The first argument, "db", is a [database connection] obtained from a
3467+** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or
3468+** [sqlite3_open16()]. The database connection must not have been closed.
3470+** The second argument, "zSql", is the statement to be compiled, encoded
3471+** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2()
3472+** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2()
3473+** use UTF-16.
3475+** ^If the nByte argument is negative, then zSql is read up to the
3476+** first zero terminator. ^If nByte is positive, then it is the
3477+** number of bytes read from zSql. ^If nByte is zero, then no prepared
3478+** statement is generated.
3479+** If the caller knows that the supplied string is nul-terminated, then
3480+** there is a small performance advantage to passing an nByte parameter that
3481+** is the number of bytes in the input string <i>including</i>
3482+** the nul-terminator.
3484+** ^If pzTail is not NULL then *pzTail is made to point to the first byte
3485+** past the end of the first SQL statement in zSql. These routines only
3486+** compile the first statement in zSql, so *pzTail is left pointing to
3487+** what remains uncompiled.
3489+** ^*ppStmt is left pointing to a compiled [prepared statement] that can be
3490+** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set
3491+** to NULL. ^If the input text contains no SQL (if the input is an empty
3492+** string or a comment) then *ppStmt is set to NULL.
3493+** The calling procedure is responsible for deleting the compiled
3494+** SQL statement using [sqlite3_finalize()] after it has finished with it.
3495+** ppStmt may not be NULL.
3497+** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK];
3498+** otherwise an [error code] is returned.
3500+** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are
3501+** recommended for all new programs. The two older interfaces are retained
3502+** for backwards compatibility, but their use is discouraged.
3503+** ^In the "v2" interfaces, the prepared statement
3504+** that is returned (the [sqlite3_stmt] object) contains a copy of the
3505+** original SQL text. This causes the [sqlite3_step()] interface to
3506+** behave differently in three ways:
3508+** <ol>
3509+** <li>
3510+** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it
3511+** always used to do, [sqlite3_step()] will automatically recompile the SQL
3512+** statement and try to run it again. As many as [SQLITE_MAX_SCHEMA_RETRY]
3513+** retries will occur before sqlite3_step() gives up and returns an error.
3514+** </li>
3516+** <li>
3517+** ^When an error occurs, [sqlite3_step()] will return one of the detailed
3518+** [error codes] or [extended error codes]. ^The legacy behavior was that
3519+** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code
3520+** and the application would have to make a second call to [sqlite3_reset()]
3521+** in order to find the underlying cause of the problem. With the "v2" prepare
3522+** interfaces, the underlying reason for the error is returned immediately.
3523+** </li>
3525+** <li>
3526+** ^If the specific value bound to [parameter | host parameter] in the
3527+** WHERE clause might influence the choice of query plan for a statement,
3528+** then the statement will be automatically recompiled, as if there had been
3529+** a schema change, on the first [sqlite3_step()] call following any change
3530+** to the [sqlite3_bind_text | bindings] of that [parameter].
3531+** ^The specific value of WHERE-clause [parameter] might influence the
3532+** choice of query plan if the parameter is the left-hand side of a [LIKE]
3533+** or [GLOB] operator or if the parameter is compared to an indexed column
3534+** and the [SQLITE_ENABLE_STAT3] compile-time option is enabled.
3535+** </li>
3536+** </ol>
3538+SQLITE_API int SQLITE_STDCALL sqlite3_prepare(
3539+ sqlite3 *db, /* Database handle */
3540+ const char *zSql, /* SQL statement, UTF-8 encoded */
3541+ int nByte, /* Maximum length of zSql in bytes. */
3542+ sqlite3_stmt **ppStmt, /* OUT: Statement handle */
3543+ const char **pzTail /* OUT: Pointer to unused portion of zSql */
3545+SQLITE_API int SQLITE_STDCALL sqlite3_prepare_v2(
3546+ sqlite3 *db, /* Database handle */
3547+ const char *zSql, /* SQL statement, UTF-8 encoded */
3548+ int nByte, /* Maximum length of zSql in bytes. */
3549+ sqlite3_stmt **ppStmt, /* OUT: Statement handle */
3550+ const char **pzTail /* OUT: Pointer to unused portion of zSql */
3552+SQLITE_API int SQLITE_STDCALL sqlite3_prepare16(
3553+ sqlite3 *db, /* Database handle */
3554+ const void *zSql, /* SQL statement, UTF-16 encoded */
3555+ int nByte, /* Maximum length of zSql in bytes. */
3556+ sqlite3_stmt **ppStmt, /* OUT: Statement handle */
3557+ const void **pzTail /* OUT: Pointer to unused portion of zSql */
3559+SQLITE_API int SQLITE_STDCALL sqlite3_prepare16_v2(
3560+ sqlite3 *db, /* Database handle */
3561+ const void *zSql, /* SQL statement, UTF-16 encoded */
3562+ int nByte, /* Maximum length of zSql in bytes. */
3563+ sqlite3_stmt **ppStmt, /* OUT: Statement handle */
3564+ const void **pzTail /* OUT: Pointer to unused portion of zSql */
3568+** CAPI3REF: Retrieving Statement SQL
3569+** METHOD: sqlite3_stmt
3571+** ^This interface can be used to retrieve a saved copy of the original
3572+** SQL text used to create a [prepared statement] if that statement was
3573+** compiled using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()].
3575+SQLITE_API const char *SQLITE_STDCALL sqlite3_sql(sqlite3_stmt *pStmt);
3578+** CAPI3REF: Determine If An SQL Statement Writes The Database
3579+** METHOD: sqlite3_stmt
3581+** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if
3582+** and only if the [prepared statement] X makes no direct changes to
3583+** the content of the database file.
3585+** Note that [application-defined SQL functions] or
3586+** [virtual tables] might change the database indirectly as a side effect.
3587+** ^(For example, if an application defines a function "eval()" that
3588+** calls [sqlite3_exec()], then the following SQL statement would
3589+** change the database file through side-effects:
3591+** <blockquote><pre>
3592+** SELECT eval('DELETE FROM t1') FROM t2;
3593+** </pre></blockquote>
3595+** But because the [SELECT] statement does not change the database file
3596+** directly, sqlite3_stmt_readonly() would still return true.)^
3598+** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK],
3599+** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true,
3600+** since the statements themselves do not actually modify the database but
3601+** rather they control the timing of when other statements modify the
3602+** database. ^The [ATTACH] and [DETACH] statements also cause
3603+** sqlite3_stmt_readonly() to return true since, while those statements
3604+** change the configuration of a database connection, they do not make
3605+** changes to the content of the database files on disk.
3607+SQLITE_API int SQLITE_STDCALL sqlite3_stmt_readonly(sqlite3_stmt *pStmt);
3610+** CAPI3REF: Determine If A Prepared Statement Has Been Reset
3611+** METHOD: sqlite3_stmt
3613+** ^The sqlite3_stmt_busy(S) interface returns true (non-zero) if the
3614+** [prepared statement] S has been stepped at least once using
3615+** [sqlite3_step(S)] but has neither run to completion (returned
3616+** [SQLITE_DONE] from [sqlite3_step(S)]) nor
3617+** been reset using [sqlite3_reset(S)]. ^The sqlite3_stmt_busy(S)
3618+** interface returns false if S is a NULL pointer. If S is not a
3619+** NULL pointer and is not a pointer to a valid [prepared statement]
3620+** object, then the behavior is undefined and probably undesirable.
3622+** This interface can be used in combination [sqlite3_next_stmt()]
3623+** to locate all prepared statements associated with a database
3624+** connection that are in need of being reset. This can be used,
3625+** for example, in diagnostic routines to search for prepared
3626+** statements that are holding a transaction open.
3628+SQLITE_API int SQLITE_STDCALL sqlite3_stmt_busy(sqlite3_stmt*);
3631+** CAPI3REF: Dynamically Typed Value Object
3632+** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value}
3634+** SQLite uses the sqlite3_value object to represent all values
3635+** that can be stored in a database table. SQLite uses dynamic typing
3636+** for the values it stores. ^Values stored in sqlite3_value objects
3637+** can be integers, floating point values, strings, BLOBs, or NULL.
3639+** An sqlite3_value object may be either "protected" or "unprotected".
3640+** Some interfaces require a protected sqlite3_value. Other interfaces
3641+** will accept either a protected or an unprotected sqlite3_value.
3642+** Every interface that accepts sqlite3_value arguments specifies
3643+** whether or not it requires a protected sqlite3_value. The
3644+** [sqlite3_value_dup()] interface can be used to construct a new
3645+** protected sqlite3_value from an unprotected sqlite3_value.
3647+** The terms "protected" and "unprotected" refer to whether or not
3648+** a mutex is held. An internal mutex is held for a protected
3649+** sqlite3_value object but no mutex is held for an unprotected
3650+** sqlite3_value object. If SQLite is compiled to be single-threaded
3651+** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0)
3652+** or if SQLite is run in one of reduced mutex modes
3654+** then there is no distinction between protected and unprotected
3655+** sqlite3_value objects and they can be used interchangeably. However,
3656+** for maximum code portability it is recommended that applications
3657+** still make the distinction between protected and unprotected
3658+** sqlite3_value objects even when not strictly required.
3660+** ^The sqlite3_value objects that are passed as parameters into the
3661+** implementation of [application-defined SQL functions] are protected.
3662+** ^The sqlite3_value object returned by
3663+** [sqlite3_column_value()] is unprotected.
3664+** Unprotected sqlite3_value objects may only be used with
3665+** [sqlite3_result_value()] and [sqlite3_bind_value()].
3666+** The [sqlite3_value_blob | sqlite3_value_type()] family of
3667+** interfaces require protected sqlite3_value objects.
3669+typedef struct Mem sqlite3_value;
3672+** CAPI3REF: SQL Function Context Object
3674+** The context in which an SQL function executes is stored in an
3675+** sqlite3_context object. ^A pointer to an sqlite3_context object
3676+** is always first parameter to [application-defined SQL functions].
3677+** The application-defined SQL function implementation will pass this
3678+** pointer through into calls to [sqlite3_result_int | sqlite3_result()],
3679+** [sqlite3_aggregate_context()], [sqlite3_user_data()],
3680+** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()],
3681+** and/or [sqlite3_set_auxdata()].
3683+typedef struct sqlite3_context sqlite3_context;
3686+** CAPI3REF: Binding Values To Prepared Statements
3687+** KEYWORDS: {host parameter} {host parameters} {host parameter name}
3688+** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding}
3689+** METHOD: sqlite3_stmt
3691+** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants,
3692+** literals may be replaced by a [parameter] that matches one of following
3693+** templates:
3695+** <ul>
3696+** <li> ?
3697+** <li> ?NNN
3698+** <li> :VVV
3699+** <li> @VVV
3700+** <li> $VVV
3701+** </ul>
3703+** In the templates above, NNN represents an integer literal,
3704+** and VVV represents an alphanumeric identifier.)^ ^The values of these
3705+** parameters (also called "host parameter names" or "SQL parameters")
3706+** can be set using the sqlite3_bind_*() routines defined here.
3708+** ^The first argument to the sqlite3_bind_*() routines is always
3709+** a pointer to the [sqlite3_stmt] object returned from
3710+** [sqlite3_prepare_v2()] or its variants.
3712+** ^The second argument is the index of the SQL parameter to be set.
3713+** ^The leftmost SQL parameter has an index of 1. ^When the same named
3714+** SQL parameter is used more than once, second and subsequent
3715+** occurrences have the same index as the first occurrence.
3716+** ^The index for named parameters can be looked up using the
3717+** [sqlite3_bind_parameter_index()] API if desired. ^The index
3718+** for "?NNN" parameters is the value of NNN.
3719+** ^The NNN value must be between 1 and the [sqlite3_limit()]
3720+** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999).
3722+** ^The third argument is the value to bind to the parameter.
3723+** ^If the third parameter to sqlite3_bind_text() or sqlite3_bind_text16()
3724+** or sqlite3_bind_blob() is a NULL pointer then the fourth parameter
3725+** is ignored and the end result is the same as sqlite3_bind_null().
3727+** ^(In those routines that have a fourth argument, its value is the
3728+** number of bytes in the parameter. To be clear: the value is the
3729+** number of <u>bytes</u> in the value, not the number of characters.)^
3730+** ^If the fourth parameter to sqlite3_bind_text() or sqlite3_bind_text16()
3731+** is negative, then the length of the string is
3732+** the number of bytes up to the first zero terminator.
3733+** If the fourth parameter to sqlite3_bind_blob() is negative, then
3734+** the behavior is undefined.
3735+** If a non-negative fourth parameter is provided to sqlite3_bind_text()
3736+** or sqlite3_bind_text16() or sqlite3_bind_text64() then
3737+** that parameter must be the byte offset
3738+** where the NUL terminator would occur assuming the string were NUL
3739+** terminated. If any NUL characters occur at byte offsets less than
3740+** the value of the fourth parameter then the resulting string value will
3741+** contain embedded NULs. The result of expressions involving strings
3742+** with embedded NULs is undefined.
3744+** ^The fifth argument to the BLOB and string binding interfaces
3745+** is a destructor used to dispose of the BLOB or
3746+** string after SQLite has finished with it. ^The destructor is called
3747+** to dispose of the BLOB or string even if the call to bind API fails.
3748+** ^If the fifth argument is
3749+** the special value [SQLITE_STATIC], then SQLite assumes that the
3750+** information is in static, unmanaged space and does not need to be freed.
3751+** ^If the fifth argument has the value [SQLITE_TRANSIENT], then
3752+** SQLite makes its own private copy of the data immediately, before
3753+** the sqlite3_bind_*() routine returns.
3755+** ^The sixth argument to sqlite3_bind_text64() must be one of
3757+** to specify the encoding of the text in the third parameter. If
3758+** the sixth argument to sqlite3_bind_text64() is not one of the
3759+** allowed values shown above, or if the text encoding is different
3760+** from the encoding specified by the sixth parameter, then the behavior
3761+** is undefined.
3763+** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that
3764+** is filled with zeroes. ^A zeroblob uses a fixed amount of memory
3765+** (just an integer to hold its size) while it is being processed.
3766+** Zeroblobs are intended to serve as placeholders for BLOBs whose
3767+** content is later written using
3768+** [sqlite3_blob_open | incremental BLOB I/O] routines.
3769+** ^A negative value for the zeroblob results in a zero-length BLOB.
3771+** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer
3772+** for the [prepared statement] or with a prepared statement for which
3773+** [sqlite3_step()] has been called more recently than [sqlite3_reset()],
3774+** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_()
3775+** routine is passed a [prepared statement] that has been finalized, the
3776+** result is undefined and probably harmful.
3778+** ^Bindings are not cleared by the [sqlite3_reset()] routine.
3779+** ^Unbound parameters are interpreted as NULL.
3781+** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an
3782+** [error code] if anything goes wrong.
3783+** ^[SQLITE_TOOBIG] might be returned if the size of a string or BLOB
3784+** exceeds limits imposed by [sqlite3_limit]([SQLITE_LIMIT_LENGTH]) or
3786+** ^[SQLITE_RANGE] is returned if the parameter
3787+** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails.
3789+** See also: [sqlite3_bind_parameter_count()],
3790+** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()].
3792+SQLITE_API int SQLITE_STDCALL sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*));
3793+SQLITE_API int SQLITE_STDCALL sqlite3_bind_blob64(sqlite3_stmt*, int, const void*, sqlite3_uint64,
3794+ void(*)(void*));
3795+SQLITE_API int SQLITE_STDCALL sqlite3_bind_double(sqlite3_stmt*, int, double);
3796+SQLITE_API int SQLITE_STDCALL sqlite3_bind_int(sqlite3_stmt*, int, int);
3797+SQLITE_API int SQLITE_STDCALL sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64);
3798+SQLITE_API int SQLITE_STDCALL sqlite3_bind_null(sqlite3_stmt*, int);
3799+SQLITE_API int SQLITE_STDCALL sqlite3_bind_text(sqlite3_stmt*,int,const char*,int,void(*)(void*));
3800+SQLITE_API int SQLITE_STDCALL sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*));
3801+SQLITE_API int SQLITE_STDCALL sqlite3_bind_text64(sqlite3_stmt*, int, const char*, sqlite3_uint64,
3802+ void(*)(void*), unsigned char encoding);
3803+SQLITE_API int SQLITE_STDCALL sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);
3804+SQLITE_API int SQLITE_STDCALL sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n);
3805+SQLITE_API int SQLITE_STDCALL sqlite3_bind_zeroblob64(sqlite3_stmt*, int, sqlite3_uint64);
3808+** CAPI3REF: Number Of SQL Parameters
3809+** METHOD: sqlite3_stmt
3811+** ^This routine can be used to find the number of [SQL parameters]
3812+** in a [prepared statement]. SQL parameters are tokens of the
3813+** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as
3814+** placeholders for values that are [sqlite3_bind_blob | bound]
3815+** to the parameters at a later time.
3817+** ^(This routine actually returns the index of the largest (rightmost)
3818+** parameter. For all forms except ?NNN, this will correspond to the
3819+** number of unique parameters. If parameters of the ?NNN form are used,
3820+** there may be gaps in the list.)^
3822+** See also: [sqlite3_bind_blob|sqlite3_bind()],
3823+** [sqlite3_bind_parameter_name()], and
3824+** [sqlite3_bind_parameter_index()].
3826+SQLITE_API int SQLITE_STDCALL sqlite3_bind_parameter_count(sqlite3_stmt*);
3829+** CAPI3REF: Name Of A Host Parameter
3830+** METHOD: sqlite3_stmt
3832+** ^The sqlite3_bind_parameter_name(P,N) interface returns
3833+** the name of the N-th [SQL parameter] in the [prepared statement] P.
3834+** ^(SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA"
3835+** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA"
3836+** respectively.
3837+** In other words, the initial ":" or "$" or "@" or "?"
3838+** is included as part of the name.)^
3839+** ^Parameters of the form "?" without a following integer have no name
3840+** and are referred to as "nameless" or "anonymous parameters".
3842+** ^The first host parameter has an index of 1, not 0.
3844+** ^If the value N is out of range or if the N-th parameter is
3845+** nameless, then NULL is returned. ^The returned string is
3846+** always in UTF-8 encoding even if the named parameter was
3847+** originally specified as UTF-16 in [sqlite3_prepare16()] or
3848+** [sqlite3_prepare16_v2()].
3850+** See also: [sqlite3_bind_blob|sqlite3_bind()],
3851+** [sqlite3_bind_parameter_count()], and
3852+** [sqlite3_bind_parameter_index()].
3854+SQLITE_API const char *SQLITE_STDCALL sqlite3_bind_parameter_name(sqlite3_stmt*, int);
3857+** CAPI3REF: Index Of A Parameter With A Given Name
3858+** METHOD: sqlite3_stmt
3860+** ^Return the index of an SQL parameter given its name. ^The
3861+** index value returned is suitable for use as the second
3862+** parameter to [sqlite3_bind_blob|sqlite3_bind()]. ^A zero
3863+** is returned if no matching parameter is found. ^The parameter
3864+** name must be given in UTF-8 even if the original statement
3865+** was prepared from UTF-16 text using [sqlite3_prepare16_v2()].
3867+** See also: [sqlite3_bind_blob|sqlite3_bind()],
3868+** [sqlite3_bind_parameter_count()], and
3869+** [sqlite3_bind_parameter_name()].
3871+SQLITE_API int SQLITE_STDCALL sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName);
3874+** CAPI3REF: Reset All Bindings On A Prepared Statement
3875+** METHOD: sqlite3_stmt
3877+** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset
3878+** the [sqlite3_bind_blob | bindings] on a [prepared statement].
3879+** ^Use this routine to reset all host parameters to NULL.
3881+SQLITE_API int SQLITE_STDCALL sqlite3_clear_bindings(sqlite3_stmt*);
3884+** CAPI3REF: Number Of Columns In A Result Set
3885+** METHOD: sqlite3_stmt
3887+** ^Return the number of columns in the result set returned by the
3888+** [prepared statement]. ^This routine returns 0 if pStmt is an SQL
3889+** statement that does not return data (for example an [UPDATE]).
3891+** See also: [sqlite3_data_count()]
3893+SQLITE_API int SQLITE_STDCALL sqlite3_column_count(sqlite3_stmt *pStmt);
3896+** CAPI3REF: Column Names In A Result Set
3897+** METHOD: sqlite3_stmt
3899+** ^These routines return the name assigned to a particular column
3900+** in the result set of a [SELECT] statement. ^The sqlite3_column_name()
3901+** interface returns a pointer to a zero-terminated UTF-8 string
3902+** and sqlite3_column_name16() returns a pointer to a zero-terminated
3903+** UTF-16 string. ^The first parameter is the [prepared statement]
3904+** that implements the [SELECT] statement. ^The second parameter is the
3905+** column number. ^The leftmost column is number 0.
3907+** ^The returned string pointer is valid until either the [prepared statement]
3908+** is destroyed by [sqlite3_finalize()] or until the statement is automatically
3909+** reprepared by the first call to [sqlite3_step()] for a particular run
3910+** or until the next call to
3911+** sqlite3_column_name() or sqlite3_column_name16() on the same column.
3913+** ^If sqlite3_malloc() fails during the processing of either routine
3914+** (for example during a conversion from UTF-8 to UTF-16) then a
3915+** NULL pointer is returned.
3917+** ^The name of a result column is the value of the "AS" clause for
3918+** that column, if there is an AS clause. If there is no AS clause
3919+** then the name of the column is unspecified and may change from
3920+** one release of SQLite to the next.
3922+SQLITE_API const char *SQLITE_STDCALL sqlite3_column_name(sqlite3_stmt*, int N);
3923+SQLITE_API const void *SQLITE_STDCALL sqlite3_column_name16(sqlite3_stmt*, int N);
3926+** CAPI3REF: Source Of Data In A Query Result
3927+** METHOD: sqlite3_stmt
3929+** ^These routines provide a means to determine the database, table, and
3930+** table column that is the origin of a particular result column in
3931+** [SELECT] statement.
3932+** ^The name of the database or table or column can be returned as
3933+** either a UTF-8 or UTF-16 string. ^The _database_ routines return
3934+** the database name, the _table_ routines return the table name, and
3935+** the origin_ routines return the column name.
3936+** ^The returned string is valid until the [prepared statement] is destroyed
3937+** using [sqlite3_finalize()] or until the statement is automatically
3938+** reprepared by the first call to [sqlite3_step()] for a particular run
3939+** or until the same information is requested
3940+** again in a different encoding.
3942+** ^The names returned are the original un-aliased names of the
3943+** database, table, and column.
3945+** ^The first argument to these interfaces is a [prepared statement].
3946+** ^These functions return information about the Nth result column returned by
3947+** the statement, where N is the second function argument.
3948+** ^The left-most column is column 0 for these routines.
3950+** ^If the Nth column returned by the statement is an expression or
3951+** subquery and is not a column value, then all of these functions return
3952+** NULL. ^These routine might also return NULL if a memory allocation error
3953+** occurs. ^Otherwise, they return the name of the attached database, table,
3954+** or column that query result column was extracted from.
3956+** ^As with all other SQLite APIs, those whose names end with "16" return
3957+** UTF-16 encoded strings and the other functions return UTF-8.
3959+** ^These APIs are only available if the library was compiled with the
3960+** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol.
3962+** If two or more threads call one or more of these routines against the same
3963+** prepared statement and column at the same time then the results are
3964+** undefined.
3966+** If two or more threads call one or more
3967+** [sqlite3_column_database_name | column metadata interfaces]
3968+** for the same [prepared statement] and result column
3969+** at the same time then the results are undefined.
3971+SQLITE_API const char *SQLITE_STDCALL sqlite3_column_database_name(sqlite3_stmt*,int);
3972+SQLITE_API const void *SQLITE_STDCALL sqlite3_column_database_name16(sqlite3_stmt*,int);
3973+SQLITE_API const char *SQLITE_STDCALL sqlite3_column_table_name(sqlite3_stmt*,int);
3974+SQLITE_API const void *SQLITE_STDCALL sqlite3_column_table_name16(sqlite3_stmt*,int);
3975+SQLITE_API const char *SQLITE_STDCALL sqlite3_column_origin_name(sqlite3_stmt*,int);
3976+SQLITE_API const void *SQLITE_STDCALL sqlite3_column_origin_name16(sqlite3_stmt*,int);
3979+** CAPI3REF: Declared Datatype Of A Query Result
3980+** METHOD: sqlite3_stmt
3982+** ^(The first parameter is a [prepared statement].
3983+** If this statement is a [SELECT] statement and the Nth column of the
3984+** returned result set of that [SELECT] is a table column (not an
3985+** expression or subquery) then the declared type of the table
3986+** column is returned.)^ ^If the Nth column of the result set is an
3987+** expression or subquery, then a NULL pointer is returned.
3988+** ^The returned string is always UTF-8 encoded.
3990+** ^(For example, given the database schema:
3992+** CREATE TABLE t1(c1 VARIANT);
3994+** and the following statement to be compiled:
3996+** SELECT c1 + 1, c1 FROM t1;
3998+** this routine would return the string "VARIANT" for the second result
3999+** column (i==1), and a NULL pointer for the first result column (i==0).)^
4001+** ^SQLite uses dynamic run-time typing. ^So just because a column
4002+** is declared to contain a particular type does not mean that the
4003+** data stored in that column is of the declared type. SQLite is
4004+** strongly typed, but the typing is dynamic not static. ^Type
4005+** is associated with individual values, not with the containers
4006+** used to hold those values.
4008+SQLITE_API const char *SQLITE_STDCALL sqlite3_column_decltype(sqlite3_stmt*,int);
4009+SQLITE_API const void *SQLITE_STDCALL sqlite3_column_decltype16(sqlite3_stmt*,int);
4012+** CAPI3REF: Evaluate An SQL Statement
4013+** METHOD: sqlite3_stmt
4015+** After a [prepared statement] has been prepared using either
4016+** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy
4017+** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function
4018+** must be called one or more times to evaluate the statement.
4020+** The details of the behavior of the sqlite3_step() interface depend
4021+** on whether the statement was prepared using the newer "v2" interface
4022+** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy
4023+** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the
4024+** new "v2" interface is recommended for new applications but the legacy
4025+** interface will continue to be supported.
4027+** ^In the legacy interface, the return value will be either [SQLITE_BUSY],
4029+** ^With the "v2" interface, any of the other [result codes] or
4030+** [extended result codes] might be returned as well.
4032+** ^[SQLITE_BUSY] means that the database engine was unable to acquire the
4033+** database locks it needs to do its job. ^If the statement is a [COMMIT]
4034+** or occurs outside of an explicit transaction, then you can retry the
4035+** statement. If the statement is not a [COMMIT] and occurs within an
4036+** explicit transaction then you should rollback the transaction before
4037+** continuing.
4039+** ^[SQLITE_DONE] means that the statement has finished executing
4040+** successfully. sqlite3_step() should not be called again on this virtual
4041+** machine without first calling [sqlite3_reset()] to reset the virtual
4042+** machine back to its initial state.
4044+** ^If the SQL statement being executed returns any data, then [SQLITE_ROW]
4045+** is returned each time a new row of data is ready for processing by the
4046+** caller. The values may be accessed using the [column access functions].
4047+** sqlite3_step() is called again to retrieve the next row of data.
4049+** ^[SQLITE_ERROR] means that a run-time error (such as a constraint
4050+** violation) has occurred. sqlite3_step() should not be called again on
4051+** the VM. More information may be found by calling [sqlite3_errmsg()].
4052+** ^With the legacy interface, a more specific error code (for example,
4054+** can be obtained by calling [sqlite3_reset()] on the
4055+** [prepared statement]. ^In the "v2" interface,
4056+** the more specific error code is returned directly by sqlite3_step().
4058+** [SQLITE_MISUSE] means that the this routine was called inappropriately.
4059+** Perhaps it was called on a [prepared statement] that has
4060+** already been [sqlite3_finalize | finalized] or on one that had
4061+** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could
4062+** be the case that the same database connection is being used by two or
4063+** more threads at the same moment in time.
4065+** For all versions of SQLite up to and including, a call to
4066+** [sqlite3_reset()] was required after sqlite3_step() returned anything
4067+** other than [SQLITE_ROW] before any subsequent invocation of
4068+** sqlite3_step(). Failure to reset the prepared statement using
4069+** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from
4070+** sqlite3_step(). But after version, sqlite3_step() began
4071+** calling [sqlite3_reset()] automatically in this circumstance rather
4072+** than returning [SQLITE_MISUSE]. This is not considered a compatibility
4073+** break because any application that ever receives an SQLITE_MISUSE error
4074+** is broken by definition. The [SQLITE_OMIT_AUTORESET] compile-time option
4075+** can be used to restore the legacy behavior.
4077+** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step()
4078+** API always returns a generic error code, [SQLITE_ERROR], following any
4079+** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call
4080+** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the
4081+** specific [error codes] that better describes the error.
4082+** We admit that this is a goofy design. The problem has been fixed
4083+** with the "v2" interface. If you prepare all of your SQL statements
4084+** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead
4085+** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces,
4086+** then the more specific [error codes] are returned directly
4087+** by sqlite3_step(). The use of the "v2" interface is recommended.
4089+SQLITE_API int SQLITE_STDCALL sqlite3_step(sqlite3_stmt*);
4092+** CAPI3REF: Number of columns in a result set
4093+** METHOD: sqlite3_stmt
4095+** ^The sqlite3_data_count(P) interface returns the number of columns in the
4096+** current row of the result set of [prepared statement] P.
4097+** ^If prepared statement P does not have results ready to return
4098+** (via calls to the [sqlite3_column_int | sqlite3_column_*()] of
4099+** interfaces) then sqlite3_data_count(P) returns 0.
4100+** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer.
4101+** ^The sqlite3_data_count(P) routine returns 0 if the previous call to
4102+** [sqlite3_step](P) returned [SQLITE_DONE]. ^The sqlite3_data_count(P)
4103+** will return non-zero if previous call to [sqlite3_step](P) returned
4104+** [SQLITE_ROW], except in the case of the [PRAGMA incremental_vacuum]
4105+** where it always returns zero since each step of that multi-step
4106+** pragma returns 0 columns of data.
4108+** See also: [sqlite3_column_count()]
4110+SQLITE_API int SQLITE_STDCALL sqlite3_data_count(sqlite3_stmt *pStmt);
4113+** CAPI3REF: Fundamental Datatypes
4116+** ^(Every value in SQLite has one of five fundamental datatypes:
4118+** <ul>
4119+** <li> 64-bit signed integer
4120+** <li> 64-bit IEEE floating point number
4121+** <li> string
4122+** <li> BLOB
4123+** <li> NULL
4124+** </ul>)^
4126+** These constants are codes for each of those types.
4128+** Note that the SQLITE_TEXT constant was also used in SQLite version 2
4129+** for a completely different meaning. Software that links against both
4130+** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not
4131+** SQLITE_TEXT.
4133+#define SQLITE_INTEGER 1
4134+#define SQLITE_FLOAT 2
4135+#define SQLITE_BLOB 4
4136+#define SQLITE_NULL 5
4137+#ifdef SQLITE_TEXT
4138+# undef SQLITE_TEXT
4140+# define SQLITE_TEXT 3
4142+#define SQLITE3_TEXT 3
4145+** CAPI3REF: Result Values From A Query
4146+** KEYWORDS: {column access functions}
4147+** METHOD: sqlite3_stmt
4149+** ^These routines return information about a single column of the current
4150+** result row of a query. ^In every case the first argument is a pointer
4151+** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*]
4152+** that was returned from [sqlite3_prepare_v2()] or one of its variants)
4153+** and the second argument is the index of the column for which information
4154+** should be returned. ^The leftmost column of the result set has the index 0.
4155+** ^The number of columns in the result can be determined using
4156+** [sqlite3_column_count()].
4158+** If the SQL statement does not currently point to a valid row, or if the
4159+** column index is out of range, the result is undefined.
4160+** These routines may only be called when the most recent call to
4161+** [sqlite3_step()] has returned [SQLITE_ROW] and neither
4162+** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently.
4163+** If any of these routines are called after [sqlite3_reset()] or
4164+** [sqlite3_finalize()] or after [sqlite3_step()] has returned
4165+** something other than [SQLITE_ROW], the results are undefined.
4166+** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()]
4167+** are called from a different thread while any of these routines
4168+** are pending, then the results are undefined.
4170+** ^The sqlite3_column_type() routine returns the
4171+** [SQLITE_INTEGER | datatype code] for the initial data type
4172+** of the result column. ^The returned value is one of [SQLITE_INTEGER],
4174+** returned by sqlite3_column_type() is only meaningful if no type
4175+** conversions have occurred as described below. After a type conversion,
4176+** the value returned by sqlite3_column_type() is undefined. Future
4177+** versions of SQLite may change the behavior of sqlite3_column_type()
4178+** following a type conversion.
4180+** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes()
4181+** routine returns the number of bytes in that BLOB or string.
4182+** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts
4183+** the string to UTF-8 and then returns the number of bytes.
4184+** ^If the result is a numeric value then sqlite3_column_bytes() uses
4185+** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns
4186+** the number of bytes in that string.
4187+** ^If the result is NULL, then sqlite3_column_bytes() returns zero.
4189+** ^If the result is a BLOB or UTF-16 string then the sqlite3_column_bytes16()
4190+** routine returns the number of bytes in that BLOB or string.
4191+** ^If the result is a UTF-8 string, then sqlite3_column_bytes16() converts
4192+** the string to UTF-16 and then returns the number of bytes.
4193+** ^If the result is a numeric value then sqlite3_column_bytes16() uses
4194+** [sqlite3_snprintf()] to convert that value to a UTF-16 string and returns
4195+** the number of bytes in that string.
4196+** ^If the result is NULL, then sqlite3_column_bytes16() returns zero.
4198+** ^The values returned by [sqlite3_column_bytes()] and
4199+** [sqlite3_column_bytes16()] do not include the zero terminators at the end
4200+** of the string. ^For clarity: the values returned by
4201+** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of
4202+** bytes in the string, not the number of characters.
4204+** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(),
4205+** even empty strings, are always zero-terminated. ^The return
4206+** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer.
4208+** <b>Warning:</b> ^The object returned by [sqlite3_column_value()] is an
4209+** [unprotected sqlite3_value] object. In a multithreaded environment,
4210+** an unprotected sqlite3_value object may only be used safely with
4211+** [sqlite3_bind_value()] and [sqlite3_result_value()].
4212+** If the [unprotected sqlite3_value] object returned by
4213+** [sqlite3_column_value()] is used in any other way, including calls
4214+** to routines like [sqlite3_value_int()], [sqlite3_value_text()],
4215+** or [sqlite3_value_bytes()], the behavior is not threadsafe.
4217+** These routines attempt to convert the value where appropriate. ^For
4218+** example, if the internal representation is FLOAT and a text result
4219+** is requested, [sqlite3_snprintf()] is used internally to perform the
4220+** conversion automatically. ^(The following table details the conversions
4221+** that are applied:
4223+** <blockquote>
4224+** <table border="1">
4225+** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion
4227+** <tr><td> NULL <td> INTEGER <td> Result is 0
4228+** <tr><td> NULL <td> FLOAT <td> Result is 0.0
4229+** <tr><td> NULL <td> TEXT <td> Result is a NULL pointer
4230+** <tr><td> NULL <td> BLOB <td> Result is a NULL pointer
4231+** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float
4232+** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer
4233+** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT
4234+** <tr><td> FLOAT <td> INTEGER <td> [CAST] to INTEGER
4235+** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float
4236+** <tr><td> FLOAT <td> BLOB <td> [CAST] to BLOB
4237+** <tr><td> TEXT <td> INTEGER <td> [CAST] to INTEGER
4238+** <tr><td> TEXT <td> FLOAT <td> [CAST] to REAL
4239+** <tr><td> TEXT <td> BLOB <td> No change
4240+** <tr><td> BLOB <td> INTEGER <td> [CAST] to INTEGER
4241+** <tr><td> BLOB <td> FLOAT <td> [CAST] to REAL
4242+** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed
4243+** </table>
4244+** </blockquote>)^
4246+** Note that when type conversions occur, pointers returned by prior
4247+** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or
4248+** sqlite3_column_text16() may be invalidated.
4249+** Type conversions and pointer invalidations might occur
4250+** in the following cases:
4252+** <ul>
4253+** <li> The initial content is a BLOB and sqlite3_column_text() or
4254+** sqlite3_column_text16() is called. A zero-terminator might
4255+** need to be added to the string.</li>
4256+** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or
4257+** sqlite3_column_text16() is called. The content must be converted
4258+** to UTF-16.</li>
4259+** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or
4260+** sqlite3_column_text() is called. The content must be converted
4261+** to UTF-8.</li>
4262+** </ul>
4264+** ^Conversions between UTF-16be and UTF-16le are always done in place and do
4265+** not invalidate a prior pointer, though of course the content of the buffer
4266+** that the prior pointer references will have been modified. Other kinds
4267+** of conversion are done in place when it is possible, but sometimes they
4268+** are not possible and in those cases prior pointers are invalidated.
4270+** The safest policy is to invoke these routines
4271+** in one of the following ways:
4273+** <ul>
4274+** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li>
4275+** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li>
4276+** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li>
4277+** </ul>
4279+** In other words, you should call sqlite3_column_text(),
4280+** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result
4281+** into the desired format, then invoke sqlite3_column_bytes() or
4282+** sqlite3_column_bytes16() to find the size of the result. Do not mix calls
4283+** to sqlite3_column_text() or sqlite3_column_blob() with calls to
4284+** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16()
4285+** with calls to sqlite3_column_bytes().
4287+** ^The pointers returned are valid until a type conversion occurs as
4288+** described above, or until [sqlite3_step()] or [sqlite3_reset()] or
4289+** [sqlite3_finalize()] is called. ^The memory space used to hold strings
4290+** and BLOBs is freed automatically. Do <em>not</em> pass the pointers returned
4291+** from [sqlite3_column_blob()], [sqlite3_column_text()], etc. into
4292+** [sqlite3_free()].
4294+** ^(If a memory allocation error occurs during the evaluation of any
4295+** of these routines, a default value is returned. The default value
4296+** is either the integer 0, the floating point number 0.0, or a NULL
4297+** pointer. Subsequent calls to [sqlite3_errcode()] will return
4298+** [SQLITE_NOMEM].)^
4300+SQLITE_API const void *SQLITE_STDCALL sqlite3_column_blob(sqlite3_stmt*, int iCol);
4301+SQLITE_API int SQLITE_STDCALL sqlite3_column_bytes(sqlite3_stmt*, int iCol);
4302+SQLITE_API int SQLITE_STDCALL sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
4303+SQLITE_API double SQLITE_STDCALL sqlite3_column_double(sqlite3_stmt*, int iCol);
4304+SQLITE_API int SQLITE_STDCALL sqlite3_column_int(sqlite3_stmt*, int iCol);
4305+SQLITE_API sqlite3_int64 SQLITE_STDCALL sqlite3_column_int64(sqlite3_stmt*, int iCol);
4306+SQLITE_API const unsigned char *SQLITE_STDCALL sqlite3_column_text(sqlite3_stmt*, int iCol);
4307+SQLITE_API const void *SQLITE_STDCALL sqlite3_column_text16(sqlite3_stmt*, int iCol);
4308+SQLITE_API int SQLITE_STDCALL sqlite3_column_type(sqlite3_stmt*, int iCol);
4309+SQLITE_API sqlite3_value *SQLITE_STDCALL sqlite3_column_value(sqlite3_stmt*, int iCol);
4312+** CAPI3REF: Destroy A Prepared Statement Object
4313+** DESTRUCTOR: sqlite3_stmt
4315+** ^The sqlite3_finalize() function is called to delete a [prepared statement].
4316+** ^If the most recent evaluation of the statement encountered no errors
4317+** or if the statement is never been evaluated, then sqlite3_finalize() returns
4318+** SQLITE_OK. ^If the most recent evaluation of statement S failed, then
4319+** sqlite3_finalize(S) returns the appropriate [error code] or
4320+** [extended error code].
4322+** ^The sqlite3_finalize(S) routine can be called at any point during
4323+** the life cycle of [prepared statement] S:
4324+** before statement S is ever evaluated, after
4325+** one or more calls to [sqlite3_reset()], or after any call
4326+** to [sqlite3_step()] regardless of whether or not the statement has
4327+** completed execution.
4329+** ^Invoking sqlite3_finalize() on a NULL pointer is a harmless no-op.
4331+** The application must finalize every [prepared statement] in order to avoid
4332+** resource leaks. It is a grievous error for the application to try to use
4333+** a prepared statement after it has been finalized. Any use of a prepared
4334+** statement after it has been finalized can result in undefined and
4335+** undesirable behavior such as segfaults and heap corruption.
4337+SQLITE_API int SQLITE_STDCALL sqlite3_finalize(sqlite3_stmt *pStmt);
4340+** CAPI3REF: Reset A Prepared Statement Object
4341+** METHOD: sqlite3_stmt
4343+** The sqlite3_reset() function is called to reset a [prepared statement]
4344+** object back to its initial state, ready to be re-executed.
4345+** ^Any SQL statement variables that had values bound to them using
4346+** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values.
4347+** Use [sqlite3_clear_bindings()] to reset the bindings.
4349+** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S
4350+** back to the beginning of its program.
4352+** ^If the most recent call to [sqlite3_step(S)] for the
4353+** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE],
4354+** or if [sqlite3_step(S)] has never before been called on S,
4355+** then [sqlite3_reset(S)] returns [SQLITE_OK].
4357+** ^If the most recent call to [sqlite3_step(S)] for the
4358+** [prepared statement] S indicated an error, then
4359+** [sqlite3_reset(S)] returns an appropriate [error code].
4361+** ^The [sqlite3_reset(S)] interface does not change the values
4362+** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S.
4364+SQLITE_API int SQLITE_STDCALL sqlite3_reset(sqlite3_stmt *pStmt);
4367+** CAPI3REF: Create Or Redefine SQL Functions
4368+** KEYWORDS: {function creation routines}
4369+** KEYWORDS: {application-defined SQL function}
4370+** KEYWORDS: {application-defined SQL functions}
4371+** METHOD: sqlite3
4373+** ^These functions (collectively known as "function creation routines")
4374+** are used to add SQL functions or aggregates or to redefine the behavior
4375+** of existing SQL functions or aggregates. The only differences between
4376+** these routines are the text encoding expected for
4377+** the second parameter (the name of the function being created)
4378+** and the presence or absence of a destructor callback for
4379+** the application data pointer.
4381+** ^The first parameter is the [database connection] to which the SQL
4382+** function is to be added. ^If an application uses more than one database
4383+** connection then application-defined SQL functions must be added
4384+** to each database connection separately.
4386+** ^The second parameter is the name of the SQL function to be created or
4387+** redefined. ^The length of the name is limited to 255 bytes in a UTF-8
4388+** representation, exclusive of the zero-terminator. ^Note that the name
4389+** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes.
4390+** ^Any attempt to create a function with a longer name
4391+** will result in [SQLITE_MISUSE] being returned.
4393+** ^The third parameter (nArg)
4394+** is the number of arguments that the SQL function or
4395+** aggregate takes. ^If this parameter is -1, then the SQL function or
4396+** aggregate may take any number of arguments between 0 and the limit
4397+** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third
4398+** parameter is less than -1 or greater than 127 then the behavior is
4399+** undefined.
4401+** ^The fourth parameter, eTextRep, specifies what
4402+** [SQLITE_UTF8 | text encoding] this SQL function prefers for
4403+** its parameters. The application should set this parameter to
4404+** [SQLITE_UTF16LE] if the function implementation invokes
4405+** [sqlite3_value_text16le()] on an input, or [SQLITE_UTF16BE] if the
4406+** implementation invokes [sqlite3_value_text16be()] on an input, or
4407+** [SQLITE_UTF16] if [sqlite3_value_text16()] is used, or [SQLITE_UTF8]
4408+** otherwise. ^The same SQL function may be registered multiple times using
4409+** different preferred text encodings, with different implementations for
4410+** each encoding.
4411+** ^When multiple implementations of the same function are available, SQLite
4412+** will pick the one that involves the least amount of data conversion.
4414+** ^The fourth parameter may optionally be ORed with [SQLITE_DETERMINISTIC]
4415+** to signal that the function will always return the same result given
4416+** the same inputs within a single SQL statement. Most SQL functions are
4417+** deterministic. The built-in [random()] SQL function is an example of a
4418+** function that is not deterministic. The SQLite query planner is able to
4419+** perform additional optimizations on deterministic functions, so use
4420+** of the [SQLITE_DETERMINISTIC] flag is recommended where possible.
4422+** ^(The fifth parameter is an arbitrary pointer. The implementation of the
4423+** function can gain access to this pointer using [sqlite3_user_data()].)^
4425+** ^The sixth, seventh and eighth parameters, xFunc, xStep and xFinal, are
4426+** pointers to C-language functions that implement the SQL function or
4427+** aggregate. ^A scalar SQL function requires an implementation of the xFunc
4428+** callback only; NULL pointers must be passed as the xStep and xFinal
4429+** parameters. ^An aggregate SQL function requires an implementation of xStep
4430+** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing
4431+** SQL function or aggregate, pass NULL pointers for all three function
4432+** callbacks.
4434+** ^(If the ninth parameter to sqlite3_create_function_v2() is not NULL,
4435+** then it is destructor for the application data pointer.
4436+** The destructor is invoked when the function is deleted, either by being
4437+** overloaded or when the database connection closes.)^
4438+** ^The destructor is also invoked if the call to
4439+** sqlite3_create_function_v2() fails.
4440+** ^When the destructor callback of the tenth parameter is invoked, it
4441+** is passed a single argument which is a copy of the application data
4442+** pointer which was the fifth parameter to sqlite3_create_function_v2().
4444+** ^It is permitted to register multiple implementations of the same
4445+** functions with the same name but with either differing numbers of
4446+** arguments or differing preferred text encodings. ^SQLite will use
4447+** the implementation that most closely matches the way in which the
4448+** SQL function is used. ^A function implementation with a non-negative
4449+** nArg parameter is a better match than a function implementation with
4450+** a negative nArg. ^A function where the preferred text encoding
4451+** matches the database encoding is a better
4452+** match than a function where the encoding is different.
4453+** ^A function where the encoding difference is between UTF16le and UTF16be
4454+** is a closer match than a function where the encoding difference is
4455+** between UTF8 and UTF16.
4457+** ^Built-in functions may be overloaded by new application-defined functions.
4459+** ^An application-defined function is permitted to call other
4460+** SQLite interfaces. However, such calls must not
4461+** close the database connection nor finalize or reset the prepared
4462+** statement in which the function is running.
4464+SQLITE_API int SQLITE_STDCALL sqlite3_create_function(
4465+ sqlite3 *db,
4466+ const char *zFunctionName,
4467+ int nArg,
4468+ int eTextRep,
4469+ void *pApp,
4470+ void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
4471+ void (*xStep)(sqlite3_context*,int,sqlite3_value**),
4472+ void (*xFinal)(sqlite3_context*)
4474+SQLITE_API int SQLITE_STDCALL sqlite3_create_function16(
4475+ sqlite3 *db,
4476+ const void *zFunctionName,
4477+ int nArg,
4478+ int eTextRep,
4479+ void *pApp,
4480+ void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
4481+ void (*xStep)(sqlite3_context*,int,sqlite3_value**),
4482+ void (*xFinal)(sqlite3_context*)
4484+SQLITE_API int SQLITE_STDCALL sqlite3_create_function_v2(
4485+ sqlite3 *db,
4486+ const char *zFunctionName,
4487+ int nArg,
4488+ int eTextRep,
4489+ void *pApp,
4490+ void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
4491+ void (*xStep)(sqlite3_context*,int,sqlite3_value**),
4492+ void (*xFinal)(sqlite3_context*),
4493+ void(*xDestroy)(void*)
4497+** CAPI3REF: Text Encodings
4499+** These constant define integer codes that represent the various
4500+** text encodings supported by SQLite.
4502+#define SQLITE_UTF8 1 /* IMP: R-37514-35566 */
4503+#define SQLITE_UTF16LE 2 /* IMP: R-03371-37637 */
4504+#define SQLITE_UTF16BE 3 /* IMP: R-51971-34154 */
4505+#define SQLITE_UTF16 4 /* Use native byte order */
4506+#define SQLITE_ANY 5 /* Deprecated */
4507+#define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */
4510+** CAPI3REF: Function Flags
4512+** These constants may be ORed together with the
4513+** [SQLITE_UTF8 | preferred text encoding] as the fourth argument
4514+** to [sqlite3_create_function()], [sqlite3_create_function16()], or
4515+** [sqlite3_create_function_v2()].
4517+#define SQLITE_DETERMINISTIC 0x800
4520+** CAPI3REF: Deprecated Functions
4523+** These functions are [deprecated]. In order to maintain
4524+** backwards compatibility with older code, these functions continue
4525+** to be supported. However, new applications should avoid
4526+** the use of these functions. To encourage programmers to avoid
4527+** these functions, we will not explain what they do.
4530+SQLITE_API SQLITE_DEPRECATED int SQLITE_STDCALL sqlite3_aggregate_count(sqlite3_context*);
4531+SQLITE_API SQLITE_DEPRECATED int SQLITE_STDCALL sqlite3_expired(sqlite3_stmt*);
4532+SQLITE_API SQLITE_DEPRECATED int SQLITE_STDCALL sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*);
4533+SQLITE_API SQLITE_DEPRECATED int SQLITE_STDCALL sqlite3_global_recover(void);
4534+SQLITE_API SQLITE_DEPRECATED void SQLITE_STDCALL sqlite3_thread_cleanup(void);
4535+SQLITE_API SQLITE_DEPRECATED int SQLITE_STDCALL sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),
4536+ void*,sqlite3_int64);
4540+** CAPI3REF: Obtaining SQL Values
4541+** METHOD: sqlite3_value
4543+** The C-language implementation of SQL functions and aggregates uses
4544+** this set of interface routines to access the parameter values on
4545+** the function or aggregate.
4547+** The xFunc (for scalar functions) or xStep (for aggregates) parameters
4548+** to [sqlite3_create_function()] and [sqlite3_create_function16()]
4549+** define callbacks that implement the SQL functions and aggregates.
4550+** The 3rd parameter to these callbacks is an array of pointers to
4551+** [protected sqlite3_value] objects. There is one [sqlite3_value] object for
4552+** each parameter to the SQL function. These routines are used to
4553+** extract values from the [sqlite3_value] objects.
4555+** These routines work only with [protected sqlite3_value] objects.
4556+** Any attempt to use these routines on an [unprotected sqlite3_value]
4557+** object results in undefined behavior.
4559+** ^These routines work just like the corresponding [column access functions]
4560+** except that these routines take a single [protected sqlite3_value] object
4561+** pointer instead of a [sqlite3_stmt*] pointer and an integer column number.
4563+** ^The sqlite3_value_text16() interface extracts a UTF-16 string
4564+** in the native byte-order of the host machine. ^The
4565+** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces
4566+** extract UTF-16 strings as big-endian and little-endian respectively.
4568+** ^(The sqlite3_value_numeric_type() interface attempts to apply
4569+** numeric affinity to the value. This means that an attempt is
4570+** made to convert the value to an integer or floating point. If
4571+** such a conversion is possible without loss of information (in other
4572+** words, if the value is a string that looks like a number)
4573+** then the conversion is performed. Otherwise no conversion occurs.
4574+** The [SQLITE_INTEGER | datatype] after conversion is returned.)^
4576+** Please pay particular attention to the fact that the pointer returned
4577+** from [sqlite3_value_blob()], [sqlite3_value_text()], or
4578+** [sqlite3_value_text16()] can be invalidated by a subsequent call to
4579+** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()],
4580+** or [sqlite3_value_text16()].
4582+** These routines must be called from the same thread as
4583+** the SQL function that supplied the [sqlite3_value*] parameters.
4585+SQLITE_API const void *SQLITE_STDCALL sqlite3_value_blob(sqlite3_value*);
4586+SQLITE_API int SQLITE_STDCALL sqlite3_value_bytes(sqlite3_value*);
4587+SQLITE_API int SQLITE_STDCALL sqlite3_value_bytes16(sqlite3_value*);
4588+SQLITE_API double SQLITE_STDCALL sqlite3_value_double(sqlite3_value*);
4589+SQLITE_API int SQLITE_STDCALL sqlite3_value_int(sqlite3_value*);
4590+SQLITE_API sqlite3_int64 SQLITE_STDCALL sqlite3_value_int64(sqlite3_value*);
4591+SQLITE_API const unsigned char *SQLITE_STDCALL sqlite3_value_text(sqlite3_value*);
4592+SQLITE_API const void *SQLITE_STDCALL sqlite3_value_text16(sqlite3_value*);
4593+SQLITE_API const void *SQLITE_STDCALL sqlite3_value_text16le(sqlite3_value*);
4594+SQLITE_API const void *SQLITE_STDCALL sqlite3_value_text16be(sqlite3_value*);
4595+SQLITE_API int SQLITE_STDCALL sqlite3_value_type(sqlite3_value*);
4596+SQLITE_API int SQLITE_STDCALL sqlite3_value_numeric_type(sqlite3_value*);
4599+** CAPI3REF: Finding The Subtype Of SQL Values
4600+** METHOD: sqlite3_value
4602+** The sqlite3_value_subtype(V) function returns the subtype for
4603+** an [application-defined SQL function] argument V. The subtype
4604+** information can be used to pass a limited amount of context from
4605+** one SQL function to another. Use the [sqlite3_result_subtype()]
4606+** routine to set the subtype for the return value of an SQL function.
4608+** SQLite makes no use of subtype itself. It merely passes the subtype
4609+** from the result of one [application-defined SQL function] into the
4610+** input of another.
4612+SQLITE_API unsigned int SQLITE_STDCALL sqlite3_value_subtype(sqlite3_value*);
4615+** CAPI3REF: Copy And Free SQL Values
4616+** METHOD: sqlite3_value
4618+** ^The sqlite3_value_dup(V) interface makes a copy of the [sqlite3_value]
4619+** object D and returns a pointer to that copy. ^The [sqlite3_value] returned
4620+** is a [protected sqlite3_value] object even if the input is not.
4621+** ^The sqlite3_value_dup(V) interface returns NULL if V is NULL or if a
4622+** memory allocation fails.
4624+** ^The sqlite3_value_free(V) interface frees an [sqlite3_value] object
4625+** previously obtained from [sqlite3_value_dup()]. ^If V is a NULL pointer
4626+** then sqlite3_value_free(V) is a harmless no-op.
4628+SQLITE_API sqlite3_value *SQLITE_STDCALL sqlite3_value_dup(const sqlite3_value*);
4629+SQLITE_API void SQLITE_STDCALL sqlite3_value_free(sqlite3_value*);
4632+** CAPI3REF: Obtain Aggregate Function Context
4633+** METHOD: sqlite3_context
4635+** Implementations of aggregate SQL functions use this
4636+** routine to allocate memory for storing their state.
4638+** ^The first time the sqlite3_aggregate_context(C,N) routine is called
4639+** for a particular aggregate function, SQLite
4640+** allocates N of memory, zeroes out that memory, and returns a pointer
4641+** to the new memory. ^On second and subsequent calls to
4642+** sqlite3_aggregate_context() for the same aggregate function instance,
4643+** the same buffer is returned. Sqlite3_aggregate_context() is normally
4644+** called once for each invocation of the xStep callback and then one
4645+** last time when the xFinal callback is invoked. ^(When no rows match
4646+** an aggregate query, the xStep() callback of the aggregate function
4647+** implementation is never called and xFinal() is called exactly once.
4648+** In those cases, sqlite3_aggregate_context() might be called for the
4649+** first time from within xFinal().)^
4651+** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer
4652+** when first called if N is less than or equal to zero or if a memory
4653+** allocate error occurs.
4655+** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is
4656+** determined by the N parameter on first successful call. Changing the
4657+** value of N in subsequent call to sqlite3_aggregate_context() within
4658+** the same aggregate function instance will not resize the memory
4659+** allocation.)^ Within the xFinal callback, it is customary to set
4660+** N=0 in calls to sqlite3_aggregate_context(C,N) so that no
4661+** pointless memory allocations occur.
4663+** ^SQLite automatically frees the memory allocated by
4664+** sqlite3_aggregate_context() when the aggregate query concludes.
4666+** The first parameter must be a copy of the
4667+** [sqlite3_context | SQL function context] that is the first parameter
4668+** to the xStep or xFinal callback routine that implements the aggregate
4669+** function.
4671+** This routine must be called from the same thread in which
4672+** the aggregate SQL function is running.
4674+SQLITE_API void *SQLITE_STDCALL sqlite3_aggregate_context(sqlite3_context*, int nBytes);
4677+** CAPI3REF: User Data For Functions
4678+** METHOD: sqlite3_context
4680+** ^The sqlite3_user_data() interface returns a copy of
4681+** the pointer that was the pUserData parameter (the 5th parameter)
4682+** of the [sqlite3_create_function()]
4683+** and [sqlite3_create_function16()] routines that originally
4684+** registered the application defined function.
4686+** This routine must be called from the same thread in which
4687+** the application-defined function is running.
4689+SQLITE_API void *SQLITE_STDCALL sqlite3_user_data(sqlite3_context*);
4692+** CAPI3REF: Database Connection For Functions
4693+** METHOD: sqlite3_context
4695+** ^The sqlite3_context_db_handle() interface returns a copy of
4696+** the pointer to the [database connection] (the 1st parameter)
4697+** of the [sqlite3_create_function()]
4698+** and [sqlite3_create_function16()] routines that originally
4699+** registered the application defined function.
4701+SQLITE_API sqlite3 *SQLITE_STDCALL sqlite3_context_db_handle(sqlite3_context*);
4704+** CAPI3REF: Function Auxiliary Data
4705+** METHOD: sqlite3_context
4707+** These functions may be used by (non-aggregate) SQL functions to
4708+** associate metadata with argument values. If the same value is passed to
4709+** multiple invocations of the same SQL function during query execution, under
4710+** some circumstances the associated metadata may be preserved. An example
4711+** of where this might be useful is in a regular-expression matching
4712+** function. The compiled version of the regular expression can be stored as
4713+** metadata associated with the pattern string.
4714+** Then as long as the pattern string remains the same,
4715+** the compiled regular expression can be reused on multiple
4716+** invocations of the same function.
4718+** ^The sqlite3_get_auxdata() interface returns a pointer to the metadata
4719+** associated by the sqlite3_set_auxdata() function with the Nth argument
4720+** value to the application-defined function. ^If there is no metadata
4721+** associated with the function argument, this sqlite3_get_auxdata() interface
4722+** returns a NULL pointer.
4724+** ^The sqlite3_set_auxdata(C,N,P,X) interface saves P as metadata for the N-th
4725+** argument of the application-defined function. ^Subsequent
4726+** calls to sqlite3_get_auxdata(C,N) return P from the most recent
4727+** sqlite3_set_auxdata(C,N,P,X) call if the metadata is still valid or
4728+** NULL if the metadata has been discarded.
4729+** ^After each call to sqlite3_set_auxdata(C,N,P,X) where X is not NULL,
4730+** SQLite will invoke the destructor function X with parameter P exactly
4731+** once, when the metadata is discarded.
4732+** SQLite is free to discard the metadata at any time, including: <ul>
4733+** <li> when the corresponding function parameter changes, or
4734+** <li> when [sqlite3_reset()] or [sqlite3_finalize()] is called for the
4735+** SQL statement, or
4736+** <li> when sqlite3_set_auxdata() is invoked again on the same parameter, or
4737+** <li> during the original sqlite3_set_auxdata() call when a memory
4738+** allocation error occurs. </ul>)^
4740+** Note the last bullet in particular. The destructor X in
4741+** sqlite3_set_auxdata(C,N,P,X) might be called immediately, before the
4742+** sqlite3_set_auxdata() interface even returns. Hence sqlite3_set_auxdata()
4743+** should be called near the end of the function implementation and the
4744+** function implementation should not make any use of P after
4745+** sqlite3_set_auxdata() has been called.
4747+** ^(In practice, metadata is preserved between function calls for
4748+** function parameters that are compile-time constants, including literal
4749+** values and [parameters] and expressions composed from the same.)^
4751+** These routines must be called from the same thread in which
4752+** the SQL function is running.
4754+SQLITE_API void *SQLITE_STDCALL sqlite3_get_auxdata(sqlite3_context*, int N);
4755+SQLITE_API void SQLITE_STDCALL sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*));
4759+** CAPI3REF: Constants Defining Special Destructor Behavior
4761+** These are special values for the destructor that is passed in as the
4762+** final argument to routines like [sqlite3_result_blob()]. ^If the destructor
4763+** argument is SQLITE_STATIC, it means that the content pointer is constant
4764+** and will never change. It does not need to be destroyed. ^The
4765+** SQLITE_TRANSIENT value means that the content will likely change in
4766+** the near future and that SQLite should make its own private copy of
4767+** the content before returning.
4769+** The typedef is necessary to work around problems in certain
4770+** C++ compilers.
4772+typedef void (*sqlite3_destructor_type)(void*);
4773+#define SQLITE_STATIC ((sqlite3_destructor_type)0)
4774+#define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1)
4777+** CAPI3REF: Setting The Result Of An SQL Function
4778+** METHOD: sqlite3_context
4780+** These routines are used by the xFunc or xFinal callbacks that
4781+** implement SQL functions and aggregates. See
4782+** [sqlite3_create_function()] and [sqlite3_create_function16()]
4783+** for additional information.
4785+** These functions work very much like the [parameter binding] family of
4786+** functions used to bind values to host parameters in prepared statements.
4787+** Refer to the [SQL parameter] documentation for additional information.
4789+** ^The sqlite3_result_blob() interface sets the result from
4790+** an application-defined function to be the BLOB whose content is pointed
4791+** to by the second parameter and which is N bytes long where N is the
4792+** third parameter.
4794+** ^The sqlite3_result_zeroblob(C,N) and sqlite3_result_zeroblob64(C,N)
4795+** interfaces set the result of the application-defined function to be
4796+** a BLOB containing all zero bytes and N bytes in size.
4798+** ^The sqlite3_result_double() interface sets the result from
4799+** an application-defined function to be a floating point value specified
4800+** by its 2nd argument.
4802+** ^The sqlite3_result_error() and sqlite3_result_error16() functions
4803+** cause the implemented SQL function to throw an exception.
4804+** ^SQLite uses the string pointed to by the
4805+** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16()
4806+** as the text of an error message. ^SQLite interprets the error
4807+** message string from sqlite3_result_error() as UTF-8. ^SQLite
4808+** interprets the string from sqlite3_result_error16() as UTF-16 in native
4809+** byte order. ^If the third parameter to sqlite3_result_error()
4810+** or sqlite3_result_error16() is negative then SQLite takes as the error
4811+** message all text up through the first zero character.
4812+** ^If the third parameter to sqlite3_result_error() or
4813+** sqlite3_result_error16() is non-negative then SQLite takes that many
4814+** bytes (not characters) from the 2nd parameter as the error message.
4815+** ^The sqlite3_result_error() and sqlite3_result_error16()
4816+** routines make a private copy of the error message text before
4817+** they return. Hence, the calling function can deallocate or
4818+** modify the text after they return without harm.
4819+** ^The sqlite3_result_error_code() function changes the error code
4820+** returned by SQLite as a result of an error in a function. ^By default,
4821+** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error()
4822+** or sqlite3_result_error16() resets the error code to SQLITE_ERROR.
4824+** ^The sqlite3_result_error_toobig() interface causes SQLite to throw an
4825+** error indicating that a string or BLOB is too long to represent.
4827+** ^The sqlite3_result_error_nomem() interface causes SQLite to throw an
4828+** error indicating that a memory allocation failed.
4830+** ^The sqlite3_result_int() interface sets the return value
4831+** of the application-defined function to be the 32-bit signed integer
4832+** value given in the 2nd argument.
4833+** ^The sqlite3_result_int64() interface sets the return value
4834+** of the application-defined function to be the 64-bit signed integer
4835+** value given in the 2nd argument.
4837+** ^The sqlite3_result_null() interface sets the return value
4838+** of the application-defined function to be NULL.
4840+** ^The sqlite3_result_text(), sqlite3_result_text16(),
4841+** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces
4842+** set the return value of the application-defined function to be
4843+** a text string which is represented as UTF-8, UTF-16 native byte order,
4844+** UTF-16 little endian, or UTF-16 big endian, respectively.
4845+** ^The sqlite3_result_text64() interface sets the return value of an
4846+** application-defined function to be a text string in an encoding
4847+** specified by the fifth (and last) parameter, which must be one
4848+** of [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE].
4849+** ^SQLite takes the text result from the application from
4850+** the 2nd parameter of the sqlite3_result_text* interfaces.
4851+** ^If the 3rd parameter to the sqlite3_result_text* interfaces
4852+** is negative, then SQLite takes result text from the 2nd parameter
4853+** through the first zero character.
4854+** ^If the 3rd parameter to the sqlite3_result_text* interfaces
4855+** is non-negative, then as many bytes (not characters) of the text
4856+** pointed to by the 2nd parameter are taken as the application-defined
4857+** function result. If the 3rd parameter is non-negative, then it
4858+** must be the byte offset into the string where the NUL terminator would
4859+** appear if the string where NUL terminated. If any NUL characters occur
4860+** in the string at a byte offset that is less than the value of the 3rd
4861+** parameter, then the resulting string will contain embedded NULs and the
4862+** result of expressions operating on strings with embedded NULs is undefined.
4863+** ^If the 4th parameter to the sqlite3_result_text* interfaces
4864+** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that
4865+** function as the destructor on the text or BLOB result when it has
4866+** finished using that result.
4867+** ^If the 4th parameter to the sqlite3_result_text* interfaces or to
4868+** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite
4869+** assumes that the text or BLOB result is in constant space and does not
4870+** copy the content of the parameter nor call a destructor on the content
4871+** when it has finished using that result.
4872+** ^If the 4th parameter to the sqlite3_result_text* interfaces
4873+** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT
4874+** then SQLite makes a copy of the result into space obtained from
4875+** from [sqlite3_malloc()] before it returns.
4877+** ^The sqlite3_result_value() interface sets the result of
4878+** the application-defined function to be a copy of the
4879+** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The
4880+** sqlite3_result_value() interface makes a copy of the [sqlite3_value]
4881+** so that the [sqlite3_value] specified in the parameter may change or
4882+** be deallocated after sqlite3_result_value() returns without harm.
4883+** ^A [protected sqlite3_value] object may always be used where an
4884+** [unprotected sqlite3_value] object is required, so either
4885+** kind of [sqlite3_value] object can be used with this interface.
4887+** If these routines are called from within the different thread
4888+** than the one containing the application-defined function that received
4889+** the [sqlite3_context] pointer, the results are undefined.
4891+SQLITE_API void SQLITE_STDCALL sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*));
4892+SQLITE_API void SQLITE_STDCALL sqlite3_result_blob64(sqlite3_context*,const void*,
4893+ sqlite3_uint64,void(*)(void*));
4894+SQLITE_API void SQLITE_STDCALL sqlite3_result_double(sqlite3_context*, double);
4895+SQLITE_API void SQLITE_STDCALL sqlite3_result_error(sqlite3_context*, const char*, int);
4896+SQLITE_API void SQLITE_STDCALL sqlite3_result_error16(sqlite3_context*, const void*, int);
4897+SQLITE_API void SQLITE_STDCALL sqlite3_result_error_toobig(sqlite3_context*);
4898+SQLITE_API void SQLITE_STDCALL sqlite3_result_error_nomem(sqlite3_context*);
4899+SQLITE_API void SQLITE_STDCALL sqlite3_result_error_code(sqlite3_context*, int);
4900+SQLITE_API void SQLITE_STDCALL sqlite3_result_int(sqlite3_context*, int);
4901+SQLITE_API void SQLITE_STDCALL sqlite3_result_int64(sqlite3_context*, sqlite3_int64);
4902+SQLITE_API void SQLITE_STDCALL sqlite3_result_null(sqlite3_context*);
4903+SQLITE_API void SQLITE_STDCALL sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*));
4904+SQLITE_API void SQLITE_STDCALL sqlite3_result_text64(sqlite3_context*, const char*,sqlite3_uint64,
4905+ void(*)(void*), unsigned char encoding);
4906+SQLITE_API void SQLITE_STDCALL sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*));
4907+SQLITE_API void SQLITE_STDCALL sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*));
4908+SQLITE_API void SQLITE_STDCALL sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*));
4909+SQLITE_API void SQLITE_STDCALL sqlite3_result_value(sqlite3_context*, sqlite3_value*);
4910+SQLITE_API void SQLITE_STDCALL sqlite3_result_zeroblob(sqlite3_context*, int n);
4911+SQLITE_API int SQLITE_STDCALL sqlite3_result_zeroblob64(sqlite3_context*, sqlite3_uint64 n);
4915+** CAPI3REF: Setting The Subtype Of An SQL Function
4916+** METHOD: sqlite3_context
4918+** The sqlite3_result_subtype(C,T) function causes the subtype of
4919+** the result from the [application-defined SQL function] with
4920+** [sqlite3_context] C to be the value T. Only the lower 8 bits
4921+** of the subtype T are preserved in current versions of SQLite;
4922+** higher order bits are discarded.
4923+** The number of subtype bytes preserved by SQLite might increase
4924+** in future releases of SQLite.
4926+SQLITE_API void SQLITE_STDCALL sqlite3_result_subtype(sqlite3_context*,unsigned int);
4929+** CAPI3REF: Define New Collating Sequences
4930+** METHOD: sqlite3
4932+** ^These functions add, remove, or modify a [collation] associated
4933+** with the [database connection] specified as the first argument.
4935+** ^The name of the collation is a UTF-8 string
4936+** for sqlite3_create_collation() and sqlite3_create_collation_v2()
4937+** and a UTF-16 string in native byte order for sqlite3_create_collation16().
4938+** ^Collation names that compare equal according to [sqlite3_strnicmp()] are
4939+** considered to be the same name.
4941+** ^(The third argument (eTextRep) must be one of the constants:
4942+** <ul>
4943+** <li> [SQLITE_UTF8],
4944+** <li> [SQLITE_UTF16LE],
4945+** <li> [SQLITE_UTF16BE],
4946+** <li> [SQLITE_UTF16], or
4947+** <li> [SQLITE_UTF16_ALIGNED].
4948+** </ul>)^
4949+** ^The eTextRep argument determines the encoding of strings passed
4950+** to the collating function callback, xCallback.
4951+** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep
4952+** force strings to be UTF16 with native byte order.
4953+** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin
4954+** on an even byte address.
4956+** ^The fourth argument, pArg, is an application data pointer that is passed
4957+** through as the first argument to the collating function callback.
4959+** ^The fifth argument, xCallback, is a pointer to the collating function.
4960+** ^Multiple collating functions can be registered using the same name but
4961+** with different eTextRep parameters and SQLite will use whichever
4962+** function requires the least amount of data transformation.
4963+** ^If the xCallback argument is NULL then the collating function is
4964+** deleted. ^When all collating functions having the same name are deleted,
4965+** that collation is no longer usable.
4967+** ^The collating function callback is invoked with a copy of the pArg
4968+** application data pointer and with two strings in the encoding specified
4969+** by the eTextRep argument. The collating function must return an
4970+** integer that is negative, zero, or positive
4971+** if the first string is less than, equal to, or greater than the second,
4972+** respectively. A collating function must always return the same answer
4973+** given the same inputs. If two or more collating functions are registered
4974+** to the same collation name (using different eTextRep values) then all
4975+** must give an equivalent answer when invoked with equivalent strings.
4976+** The collating function must obey the following properties for all
4977+** strings A, B, and C:
4979+** <ol>
4980+** <li> If A==B then B==A.
4981+** <li> If A==B and B==C then A==C.
4982+** <li> If A&lt;B THEN B&gt;A.
4983+** <li> If A&lt;B and B&lt;C then A&lt;C.
4984+** </ol>
4986+** If a collating function fails any of the above constraints and that
4987+** collating function is registered and used, then the behavior of SQLite
4988+** is undefined.
4990+** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation()
4991+** with the addition that the xDestroy callback is invoked on pArg when
4992+** the collating function is deleted.
4993+** ^Collating functions are deleted when they are overridden by later
4994+** calls to the collation creation functions or when the
4995+** [database connection] is closed using [sqlite3_close()].
4997+** ^The xDestroy callback is <u>not</u> called if the
4998+** sqlite3_create_collation_v2() function fails. Applications that invoke
4999+** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should
5000+** check the return code and dispose of the application data pointer
5001+** themselves rather than expecting SQLite to deal with it for them.
5002+** This is different from every other SQLite interface. The inconsistency
5003+** is unfortunate but cannot be changed without breaking backwards
5004+** compatibility.
5006+** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()].
5008+SQLITE_API int SQLITE_STDCALL sqlite3_create_collation(
5009+ sqlite3*,
5010+ const char *zName,
5011+ int eTextRep,
5012+ void *pArg,
5013+ int(*xCompare)(void*,int,const void*,int,const void*)
5015+SQLITE_API int SQLITE_STDCALL sqlite3_create_collation_v2(
5016+ sqlite3*,
5017+ const char *zName,
5018+ int eTextRep,
5019+ void *pArg,
5020+ int(*xCompare)(void*,int,const void*,int,const void*),
5021+ void(*xDestroy)(void*)
5023+SQLITE_API int SQLITE_STDCALL sqlite3_create_collation16(
5024+ sqlite3*,
5025+ const void *zName,
5026+ int eTextRep,
5027+ void *pArg,
5028+ int(*xCompare)(void*,int,const void*,int,const void*)
5032+** CAPI3REF: Collation Needed Callbacks
5033+** METHOD: sqlite3
5035+** ^To avoid having to register all collation sequences before a database
5036+** can be used, a single callback function may be registered with the
5037+** [database connection] to be invoked whenever an undefined collation
5038+** sequence is required.
5040+** ^If the function is registered using the sqlite3_collation_needed() API,
5041+** then it is passed the names of undefined collation sequences as strings
5042+** encoded in UTF-8. ^If sqlite3_collation_needed16() is used,
5043+** the names are passed as UTF-16 in machine native byte order.
5044+** ^A call to either function replaces the existing collation-needed callback.
5046+** ^(When the callback is invoked, the first argument passed is a copy
5047+** of the second argument to sqlite3_collation_needed() or
5048+** sqlite3_collation_needed16(). The second argument is the database
5049+** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE],
5050+** or [SQLITE_UTF16LE], indicating the most desirable form of the collation
5051+** sequence function required. The fourth parameter is the name of the
5052+** required collation sequence.)^
5054+** The callback function should register the desired collation using
5055+** [sqlite3_create_collation()], [sqlite3_create_collation16()], or
5056+** [sqlite3_create_collation_v2()].
5058+SQLITE_API int SQLITE_STDCALL sqlite3_collation_needed(
5059+ sqlite3*,
5060+ void*,
5061+ void(*)(void*,sqlite3*,int eTextRep,const char*)
5063+SQLITE_API int SQLITE_STDCALL sqlite3_collation_needed16(
5064+ sqlite3*,
5065+ void*,
5066+ void(*)(void*,sqlite3*,int eTextRep,const void*)
5069+#ifdef SQLITE_HAS_CODEC
5071+** Specify the key for an encrypted database. This routine should be
5072+** called right after sqlite3_open().
5074+** The code to implement this API is not available in the public release
5075+** of SQLite.
5077+SQLITE_API int SQLITE_STDCALL sqlite3_key(
5078+ sqlite3 *db, /* Database to be rekeyed */
5079+ const void *pKey, int nKey /* The key */
5081+SQLITE_API int SQLITE_STDCALL sqlite3_key_v2(
5082+ sqlite3 *db, /* Database to be rekeyed */
5083+ const char *zDbName, /* Name of the database */
5084+ const void *pKey, int nKey /* The key */
5088+** Change the key on an open database. If the current database is not
5089+** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the
5090+** database is decrypted.
5092+** The code to implement this API is not available in the public release
5093+** of SQLite.
5095+SQLITE_API int SQLITE_STDCALL sqlite3_rekey(
5096+ sqlite3 *db, /* Database to be rekeyed */
5097+ const void *pKey, int nKey /* The new key */
5099+SQLITE_API int SQLITE_STDCALL sqlite3_rekey_v2(
5100+ sqlite3 *db, /* Database to be rekeyed */
5101+ const char *zDbName, /* Name of the database */
5102+ const void *pKey, int nKey /* The new key */
5106+** Specify the activation key for a SEE database. Unless
5107+** activated, none of the SEE routines will work.
5109+SQLITE_API void SQLITE_STDCALL sqlite3_activate_see(
5110+ const char *zPassPhrase /* Activation phrase */
5116+** Specify the activation key for a CEROD database. Unless
5117+** activated, none of the CEROD routines will work.
5119+SQLITE_API void SQLITE_STDCALL sqlite3_activate_cerod(
5120+ const char *zPassPhrase /* Activation phrase */
5125+** CAPI3REF: Suspend Execution For A Short Time
5127+** The sqlite3_sleep() function causes the current thread to suspend execution
5128+** for at least a number of milliseconds specified in its parameter.
5130+** If the operating system does not support sleep requests with
5131+** millisecond time resolution, then the time will be rounded up to
5132+** the nearest second. The number of milliseconds of sleep actually
5133+** requested from the operating system is returned.
5135+** ^SQLite implements this interface by calling the xSleep()
5136+** method of the default [sqlite3_vfs] object. If the xSleep() method
5137+** of the default VFS is not implemented correctly, or not implemented at
5138+** all, then the behavior of sqlite3_sleep() may deviate from the description
5139+** in the previous paragraphs.
5141+SQLITE_API int SQLITE_STDCALL sqlite3_sleep(int);
5144+** CAPI3REF: Name Of The Folder Holding Temporary Files
5146+** ^(If this global variable is made to point to a string which is
5147+** the name of a folder (a.k.a. directory), then all temporary files
5148+** created by SQLite when using a built-in [sqlite3_vfs | VFS]
5149+** will be placed in that directory.)^ ^If this variable
5150+** is a NULL pointer, then SQLite performs a search for an appropriate
5151+** temporary file directory.
5153+** Applications are strongly discouraged from using this global variable.
5154+** It is required to set a temporary folder on Windows Runtime (WinRT).
5155+** But for all other platforms, it is highly recommended that applications
5156+** neither read nor write this variable. This global variable is a relic
5157+** that exists for backwards compatibility of legacy applications and should
5158+** be avoided in new projects.
5160+** It is not safe to read or modify this variable in more than one
5161+** thread at a time. It is not safe to read or modify this variable
5162+** if a [database connection] is being used at the same time in a separate
5163+** thread.
5164+** It is intended that this variable be set once
5165+** as part of process initialization and before any SQLite interface
5166+** routines have been called and that this variable remain unchanged
5167+** thereafter.
5169+** ^The [temp_store_directory pragma] may modify this variable and cause
5170+** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
5171+** the [temp_store_directory pragma] always assumes that any string
5172+** that this variable points to is held in memory obtained from
5173+** [sqlite3_malloc] and the pragma may attempt to free that memory
5174+** using [sqlite3_free].
5175+** Hence, if this variable is modified directly, either it should be
5176+** made NULL or made to point to memory obtained from [sqlite3_malloc]
5177+** or else the use of the [temp_store_directory pragma] should be avoided.
5178+** Except when requested by the [temp_store_directory pragma], SQLite
5179+** does not free the memory that sqlite3_temp_directory points to. If
5180+** the application wants that memory to be freed, it must do
5181+** so itself, taking care to only do so after all [database connection]
5182+** objects have been destroyed.
5184+** <b>Note to Windows Runtime users:</b> The temporary directory must be set
5185+** prior to calling [sqlite3_open] or [sqlite3_open_v2]. Otherwise, various
5186+** features that require the use of temporary files may fail. Here is an
5187+** example of how to do this using C++ with the Windows Runtime:
5189+** <blockquote><pre>
5190+** LPCWSTR zPath = Windows::Storage::ApplicationData::Current->
5191+** &nbsp; TemporaryFolder->Path->Data();
5192+** char zPathBuf&#91;MAX_PATH + 1&#93;;
5193+** memset(zPathBuf, 0, sizeof(zPathBuf));
5194+** WideCharToMultiByte(CP_UTF8, 0, zPath, -1, zPathBuf, sizeof(zPathBuf),
5195+** &nbsp; NULL, NULL);
5196+** sqlite3_temp_directory = sqlite3_mprintf("%s", zPathBuf);
5197+** </pre></blockquote>
5199+SQLITE_API char *sqlite3_temp_directory;
5202+** CAPI3REF: Name Of The Folder Holding Database Files
5204+** ^(If this global variable is made to point to a string which is
5205+** the name of a folder (a.k.a. directory), then all database files
5206+** specified with a relative pathname and created or accessed by
5207+** SQLite when using a built-in windows [sqlite3_vfs | VFS] will be assumed
5208+** to be relative to that directory.)^ ^If this variable is a NULL
5209+** pointer, then SQLite assumes that all database files specified
5210+** with a relative pathname are relative to the current directory
5211+** for the process. Only the windows VFS makes use of this global
5212+** variable; it is ignored by the unix VFS.
5214+** Changing the value of this variable while a database connection is
5215+** open can result in a corrupt database.
5217+** It is not safe to read or modify this variable in more than one
5218+** thread at a time. It is not safe to read or modify this variable
5219+** if a [database connection] is being used at the same time in a separate
5220+** thread.
5221+** It is intended that this variable be set once
5222+** as part of process initialization and before any SQLite interface
5223+** routines have been called and that this variable remain unchanged
5224+** thereafter.
5226+** ^The [data_store_directory pragma] may modify this variable and cause
5227+** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
5228+** the [data_store_directory pragma] always assumes that any string
5229+** that this variable points to is held in memory obtained from
5230+** [sqlite3_malloc] and the pragma may attempt to free that memory
5231+** using [sqlite3_free].
5232+** Hence, if this variable is modified directly, either it should be
5233+** made NULL or made to point to memory obtained from [sqlite3_malloc]
5234+** or else the use of the [data_store_directory pragma] should be avoided.
5236+SQLITE_API char *sqlite3_data_directory;
5239+** CAPI3REF: Test For Auto-Commit Mode
5240+** KEYWORDS: {autocommit mode}
5241+** METHOD: sqlite3
5243+** ^The sqlite3_get_autocommit() interface returns non-zero or
5244+** zero if the given database connection is or is not in autocommit mode,
5245+** respectively. ^Autocommit mode is on by default.
5246+** ^Autocommit mode is disabled by a [BEGIN] statement.
5247+** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK].
5249+** If certain kinds of errors occur on a statement within a multi-statement
5250+** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR],
5252+** transaction might be rolled back automatically. The only way to
5253+** find out whether SQLite automatically rolled back the transaction after
5254+** an error is to use this function.
5256+** If another thread changes the autocommit status of the database
5257+** connection while this routine is running, then the return value
5258+** is undefined.
5260+SQLITE_API int SQLITE_STDCALL sqlite3_get_autocommit(sqlite3*);
5263+** CAPI3REF: Find The Database Handle Of A Prepared Statement
5264+** METHOD: sqlite3_stmt
5266+** ^The sqlite3_db_handle interface returns the [database connection] handle
5267+** to which a [prepared statement] belongs. ^The [database connection]
5268+** returned by sqlite3_db_handle is the same [database connection]
5269+** that was the first argument
5270+** to the [sqlite3_prepare_v2()] call (or its variants) that was used to
5271+** create the statement in the first place.
5273+SQLITE_API sqlite3 *SQLITE_STDCALL sqlite3_db_handle(sqlite3_stmt*);
5276+** CAPI3REF: Return The Filename For A Database Connection
5277+** METHOD: sqlite3
5279+** ^The sqlite3_db_filename(D,N) interface returns a pointer to a filename
5280+** associated with database N of connection D. ^The main database file
5281+** has the name "main". If there is no attached database N on the database
5282+** connection D, or if database N is a temporary or in-memory database, then
5283+** a NULL pointer is returned.
5285+** ^The filename returned by this function is the output of the
5286+** xFullPathname method of the [VFS]. ^In other words, the filename
5287+** will be an absolute pathname, even if the filename used
5288+** to open the database originally was a URI or relative pathname.
5290+SQLITE_API const char *SQLITE_STDCALL sqlite3_db_filename(sqlite3 *db, const char *zDbName);
5293+** CAPI3REF: Determine if a database is read-only
5294+** METHOD: sqlite3
5296+** ^The sqlite3_db_readonly(D,N) interface returns 1 if the database N
5297+** of connection D is read-only, 0 if it is read/write, or -1 if N is not
5298+** the name of a database on connection D.
5300+SQLITE_API int SQLITE_STDCALL sqlite3_db_readonly(sqlite3 *db, const char *zDbName);
5303+** CAPI3REF: Find the next prepared statement
5304+** METHOD: sqlite3
5306+** ^This interface returns a pointer to the next [prepared statement] after
5307+** pStmt associated with the [database connection] pDb. ^If pStmt is NULL
5308+** then this interface returns a pointer to the first prepared statement
5309+** associated with the database connection pDb. ^If no prepared statement
5310+** satisfies the conditions of this routine, it returns NULL.
5312+** The [database connection] pointer D in a call to
5313+** [sqlite3_next_stmt(D,S)] must refer to an open database
5314+** connection and in particular must not be a NULL pointer.
5316+SQLITE_API sqlite3_stmt *SQLITE_STDCALL sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt);
5319+** CAPI3REF: Commit And Rollback Notification Callbacks
5320+** METHOD: sqlite3
5322+** ^The sqlite3_commit_hook() interface registers a callback
5323+** function to be invoked whenever a transaction is [COMMIT | committed].
5324+** ^Any callback set by a previous call to sqlite3_commit_hook()
5325+** for the same database connection is overridden.
5326+** ^The sqlite3_rollback_hook() interface registers a callback
5327+** function to be invoked whenever a transaction is [ROLLBACK | rolled back].
5328+** ^Any callback set by a previous call to sqlite3_rollback_hook()
5329+** for the same database connection is overridden.
5330+** ^The pArg argument is passed through to the callback.
5331+** ^If the callback on a commit hook function returns non-zero,
5332+** then the commit is converted into a rollback.
5334+** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions
5335+** return the P argument from the previous call of the same function
5336+** on the same [database connection] D, or NULL for
5337+** the first call for each function on D.
5339+** The commit and rollback hook callbacks are not reentrant.
5340+** The callback implementation must not do anything that will modify
5341+** the database connection that invoked the callback. Any actions
5342+** to modify the database connection must be deferred until after the
5343+** completion of the [sqlite3_step()] call that triggered the commit
5344+** or rollback hook in the first place.
5345+** Note that running any other SQL statements, including SELECT statements,
5346+** or merely calling [sqlite3_prepare_v2()] and [sqlite3_step()] will modify
5347+** the database connections for the meaning of "modify" in this paragraph.
5349+** ^Registering a NULL function disables the callback.
5351+** ^When the commit hook callback routine returns zero, the [COMMIT]
5352+** operation is allowed to continue normally. ^If the commit hook
5353+** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK].
5354+** ^The rollback hook is invoked on a rollback that results from a commit
5355+** hook returning non-zero, just as it would be with any other rollback.
5357+** ^For the purposes of this API, a transaction is said to have been
5358+** rolled back if an explicit "ROLLBACK" statement is executed, or
5359+** an error or constraint causes an implicit rollback to occur.
5360+** ^The rollback callback is not invoked if a transaction is
5361+** automatically rolled back because the database connection is closed.
5363+** See also the [sqlite3_update_hook()] interface.
5365+SQLITE_API void *SQLITE_STDCALL sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
5366+SQLITE_API void *SQLITE_STDCALL sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);
5369+** CAPI3REF: Data Change Notification Callbacks
5370+** METHOD: sqlite3
5372+** ^The sqlite3_update_hook() interface registers a callback function
5373+** with the [database connection] identified by the first argument
5374+** to be invoked whenever a row is updated, inserted or deleted in
5375+** a rowid table.
5376+** ^Any callback set by a previous call to this function
5377+** for the same database connection is overridden.
5379+** ^The second argument is a pointer to the function to invoke when a
5380+** row is updated, inserted or deleted in a rowid table.
5381+** ^The first argument to the callback is a copy of the third argument
5382+** to sqlite3_update_hook().
5383+** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE],
5384+** or [SQLITE_UPDATE], depending on the operation that caused the callback
5385+** to be invoked.
5386+** ^The third and fourth arguments to the callback contain pointers to the
5387+** database and table name containing the affected row.
5388+** ^The final callback parameter is the [rowid] of the row.
5389+** ^In the case of an update, this is the [rowid] after the update takes place.
5391+** ^(The update hook is not invoked when internal system tables are
5392+** modified (i.e. sqlite_master and sqlite_sequence).)^
5393+** ^The update hook is not invoked when [WITHOUT ROWID] tables are modified.
5395+** ^In the current implementation, the update hook
5396+** is not invoked when duplication rows are deleted because of an
5397+** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook
5398+** invoked when rows are deleted using the [truncate optimization].
5399+** The exceptions defined in this paragraph might change in a future
5400+** release of SQLite.
5402+** The update hook implementation must not do anything that will modify
5403+** the database connection that invoked the update hook. Any actions
5404+** to modify the database connection must be deferred until after the
5405+** completion of the [sqlite3_step()] call that triggered the update hook.
5406+** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
5407+** database connections for the meaning of "modify" in this paragraph.
5409+** ^The sqlite3_update_hook(D,C,P) function
5410+** returns the P argument from the previous call
5411+** on the same [database connection] D, or NULL for
5412+** the first call on D.
5414+** See also the [sqlite3_commit_hook()] and [sqlite3_rollback_hook()]
5415+** interfaces.
5417+SQLITE_API void *SQLITE_STDCALL sqlite3_update_hook(
5418+ sqlite3*,
5419+ void(*)(void *,int ,char const *,char const *,sqlite3_int64),
5420+ void*
5424+** CAPI3REF: Enable Or Disable Shared Pager Cache
5426+** ^(This routine enables or disables the sharing of the database cache
5427+** and schema data structures between [database connection | connections]
5428+** to the same database. Sharing is enabled if the argument is true
5429+** and disabled if the argument is false.)^
5431+** ^Cache sharing is enabled and disabled for an entire process.
5432+** This is a change as of SQLite version 3.5.0. In prior versions of SQLite,
5433+** sharing was enabled or disabled for each thread separately.
5435+** ^(The cache sharing mode set by this interface effects all subsequent
5436+** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()].
5437+** Existing database connections continue use the sharing mode
5438+** that was in effect at the time they were opened.)^
5440+** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled
5441+** successfully. An [error code] is returned otherwise.)^
5443+** ^Shared cache is disabled by default. But this might change in
5444+** future releases of SQLite. Applications that care about shared
5445+** cache setting should set it explicitly.
5447+** Note: This method is disabled on MacOS X 10.7 and iOS version 5.0
5448+** and will always return SQLITE_MISUSE. On those systems,
5449+** shared cache mode should be enabled per-database connection via
5450+** [sqlite3_open_v2()] with [SQLITE_OPEN_SHAREDCACHE].
5452+** This interface is threadsafe on processors where writing a
5453+** 32-bit integer is atomic.
5455+** See Also: [SQLite Shared-Cache Mode]
5457+SQLITE_API int SQLITE_STDCALL sqlite3_enable_shared_cache(int);
5460+** CAPI3REF: Attempt To Free Heap Memory
5462+** ^The sqlite3_release_memory() interface attempts to free N bytes
5463+** of heap memory by deallocating non-essential memory allocations
5464+** held by the database library. Memory used to cache database
5465+** pages to improve performance is an example of non-essential memory.
5466+** ^sqlite3_release_memory() returns the number of bytes actually freed,
5467+** which might be more or less than the amount requested.
5468+** ^The sqlite3_release_memory() routine is a no-op returning zero
5469+** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT].
5471+** See also: [sqlite3_db_release_memory()]
5473+SQLITE_API int SQLITE_STDCALL sqlite3_release_memory(int);
5476+** CAPI3REF: Free Memory Used By A Database Connection
5477+** METHOD: sqlite3
5479+** ^The sqlite3_db_release_memory(D) interface attempts to free as much heap
5480+** memory as possible from database connection D. Unlike the
5481+** [sqlite3_release_memory()] interface, this interface is in effect even
5482+** when the [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is
5483+** omitted.
5485+** See also: [sqlite3_release_memory()]
5487+SQLITE_API int SQLITE_STDCALL sqlite3_db_release_memory(sqlite3*);
5490+** CAPI3REF: Impose A Limit On Heap Size
5492+** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the
5493+** soft limit on the amount of heap memory that may be allocated by SQLite.
5494+** ^SQLite strives to keep heap memory utilization below the soft heap
5495+** limit by reducing the number of pages held in the page cache
5496+** as heap memory usages approaches the limit.
5497+** ^The soft heap limit is "soft" because even though SQLite strives to stay
5498+** below the limit, it will exceed the limit rather than generate
5499+** an [SQLITE_NOMEM] error. In other words, the soft heap limit
5500+** is advisory only.
5502+** ^The return value from sqlite3_soft_heap_limit64() is the size of
5503+** the soft heap limit prior to the call, or negative in the case of an
5504+** error. ^If the argument N is negative
5505+** then no change is made to the soft heap limit. Hence, the current
5506+** size of the soft heap limit can be determined by invoking
5507+** sqlite3_soft_heap_limit64() with a negative argument.
5509+** ^If the argument N is zero then the soft heap limit is disabled.
5511+** ^(The soft heap limit is not enforced in the current implementation
5512+** if one or more of following conditions are true:
5514+** <ul>
5515+** <li> The soft heap limit is set to zero.
5516+** <li> Memory accounting is disabled using a combination of the
5517+** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and
5518+** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option.
5519+** <li> An alternative page cache implementation is specified using
5520+** [sqlite3_config]([SQLITE_CONFIG_PCACHE2],...).
5521+** <li> The page cache allocates from its own memory pool supplied
5522+** by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than
5523+** from the heap.
5524+** </ul>)^
5526+** Beginning with SQLite version 3.7.3, the soft heap limit is enforced
5527+** regardless of whether or not the [SQLITE_ENABLE_MEMORY_MANAGEMENT]
5528+** compile-time option is invoked. With [SQLITE_ENABLE_MEMORY_MANAGEMENT],
5529+** the soft heap limit is enforced on every memory allocation. Without
5530+** [SQLITE_ENABLE_MEMORY_MANAGEMENT], the soft heap limit is only enforced
5531+** when memory is allocated by the page cache. Testing suggests that because
5532+** the page cache is the predominate memory user in SQLite, most
5533+** applications will achieve adequate soft heap limit enforcement without
5536+** The circumstances under which SQLite will enforce the soft heap limit may
5537+** changes in future releases of SQLite.
5539+SQLITE_API sqlite3_int64 SQLITE_STDCALL sqlite3_soft_heap_limit64(sqlite3_int64 N);
5542+** CAPI3REF: Deprecated Soft Heap Limit Interface
5545+** This is a deprecated version of the [sqlite3_soft_heap_limit64()]
5546+** interface. This routine is provided for historical compatibility
5547+** only. All new applications should use the
5548+** [sqlite3_soft_heap_limit64()] interface rather than this one.
5550+SQLITE_API SQLITE_DEPRECATED void SQLITE_STDCALL sqlite3_soft_heap_limit(int N);
5554+** CAPI3REF: Extract Metadata About A Column Of A Table
5555+** METHOD: sqlite3
5557+** ^(The sqlite3_table_column_metadata(X,D,T,C,....) routine returns
5558+** information about column C of table T in database D
5559+** on [database connection] X.)^ ^The sqlite3_table_column_metadata()
5560+** interface returns SQLITE_OK and fills in the non-NULL pointers in
5561+** the final five arguments with appropriate values if the specified
5562+** column exists. ^The sqlite3_table_column_metadata() interface returns
5563+** SQLITE_ERROR and if the specified column does not exist.
5564+** ^If the column-name parameter to sqlite3_table_column_metadata() is a
5565+** NULL pointer, then this routine simply checks for the existance of the
5566+** table and returns SQLITE_OK if the table exists and SQLITE_ERROR if it
5567+** does not.
5569+** ^The column is identified by the second, third and fourth parameters to
5570+** this function. ^(The second parameter is either the name of the database
5571+** (i.e. "main", "temp", or an attached database) containing the specified
5572+** table or NULL.)^ ^If it is NULL, then all attached databases are searched
5573+** for the table using the same algorithm used by the database engine to
5574+** resolve unqualified table references.
5576+** ^The third and fourth parameters to this function are the table and column
5577+** name of the desired column, respectively.
5579+** ^Metadata is returned by writing to the memory locations passed as the 5th
5580+** and subsequent parameters to this function. ^Any of these arguments may be
5581+** NULL, in which case the corresponding element of metadata is omitted.
5583+** ^(<blockquote>
5584+** <table border="1">
5585+** <tr><th> Parameter <th> Output<br>Type <th> Description
5587+** <tr><td> 5th <td> const char* <td> Data type
5588+** <tr><td> 6th <td> const char* <td> Name of default collation sequence
5589+** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint
5590+** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY
5591+** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT]
5592+** </table>
5593+** </blockquote>)^
5595+** ^The memory pointed to by the character pointers returned for the
5596+** declaration type and collation sequence is valid until the next
5597+** call to any SQLite API function.
5599+** ^If the specified table is actually a view, an [error code] is returned.
5601+** ^If the specified column is "rowid", "oid" or "_rowid_" and the table
5602+** is not a [WITHOUT ROWID] table and an
5603+** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output
5604+** parameters are set for the explicitly declared column. ^(If there is no
5605+** [INTEGER PRIMARY KEY] column, then the outputs
5606+** for the [rowid] are set as follows:
5608+** <pre>
5609+** data type: "INTEGER"
5610+** collation sequence: "BINARY"
5611+** not null: 0
5612+** primary key: 1
5613+** auto increment: 0
5614+** </pre>)^
5616+** ^This function causes all database schemas to be read from disk and
5617+** parsed, if that has not already been done, and returns an error if
5618+** any errors are encountered while loading the schema.
5620+SQLITE_API int SQLITE_STDCALL sqlite3_table_column_metadata(
5621+ sqlite3 *db, /* Connection handle */
5622+ const char *zDbName, /* Database name or NULL */
5623+ const char *zTableName, /* Table name */
5624+ const char *zColumnName, /* Column name */
5625+ char const **pzDataType, /* OUTPUT: Declared data type */
5626+ char const **pzCollSeq, /* OUTPUT: Collation sequence name */
5627+ int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
5628+ int *pPrimaryKey, /* OUTPUT: True if column part of PK */
5629+ int *pAutoinc /* OUTPUT: True if column is auto-increment */
5633+** CAPI3REF: Load An Extension
5634+** METHOD: sqlite3
5636+** ^This interface loads an SQLite extension library from the named file.
5638+** ^The sqlite3_load_extension() interface attempts to load an
5639+** [SQLite extension] library contained in the file zFile. If
5640+** the file cannot be loaded directly, attempts are made to load
5641+** with various operating-system specific extensions added.
5642+** So for example, if "samplelib" cannot be loaded, then names like
5643+** "" or "samplelib.dylib" or "samplelib.dll" might
5644+** be tried also.
5646+** ^The entry point is zProc.
5647+** ^(zProc may be 0, in which case SQLite will try to come up with an
5648+** entry point name on its own. It first tries "sqlite3_extension_init".
5649+** If that does not work, it constructs a name "sqlite3_X_init" where the
5650+** X is consists of the lower-case equivalent of all ASCII alphabetic
5651+** characters in the filename from the last "/" to the first following
5652+** "." and omitting any initial "lib".)^
5653+** ^The sqlite3_load_extension() interface returns
5654+** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.
5655+** ^If an error occurs and pzErrMsg is not 0, then the
5656+** [sqlite3_load_extension()] interface shall attempt to
5657+** fill *pzErrMsg with error message text stored in memory
5658+** obtained from [sqlite3_malloc()]. The calling function
5659+** should free this memory by calling [sqlite3_free()].
5661+** ^Extension loading must be enabled using
5662+** [sqlite3_enable_load_extension()] prior to calling this API,
5663+** otherwise an error will be returned.
5665+** See also the [load_extension() SQL function].
5667+SQLITE_API int SQLITE_STDCALL sqlite3_load_extension(
5668+ sqlite3 *db, /* Load the extension into this database connection */
5669+ const char *zFile, /* Name of the shared library containing extension */
5670+ const char *zProc, /* Entry point. Derived from zFile if 0 */
5671+ char **pzErrMsg /* Put error message here if not 0 */
5675+** CAPI3REF: Enable Or Disable Extension Loading
5676+** METHOD: sqlite3
5678+** ^So as not to open security holes in older applications that are
5679+** unprepared to deal with [extension loading], and as a means of disabling
5680+** [extension loading] while evaluating user-entered SQL, the following API
5681+** is provided to turn the [sqlite3_load_extension()] mechanism on and off.
5683+** ^Extension loading is off by default.
5684+** ^Call the sqlite3_enable_load_extension() routine with onoff==1
5685+** to turn extension loading on and call it with onoff==0 to turn
5686+** it back off again.
5688+SQLITE_API int SQLITE_STDCALL sqlite3_enable_load_extension(sqlite3 *db, int onoff);
5691+** CAPI3REF: Automatically Load Statically Linked Extensions
5693+** ^This interface causes the xEntryPoint() function to be invoked for
5694+** each new [database connection] that is created. The idea here is that
5695+** xEntryPoint() is the entry point for a statically linked [SQLite extension]
5696+** that is to be automatically loaded into all new database connections.
5698+** ^(Even though the function prototype shows that xEntryPoint() takes
5699+** no arguments and returns void, SQLite invokes xEntryPoint() with three
5700+** arguments and expects and integer result as if the signature of the
5701+** entry point where as follows:
5703+** <blockquote><pre>
5704+** &nbsp; int xEntryPoint(
5705+** &nbsp; sqlite3 *db,
5706+** &nbsp; const char **pzErrMsg,
5707+** &nbsp; const struct sqlite3_api_routines *pThunk
5708+** &nbsp; );
5709+** </pre></blockquote>)^
5711+** If the xEntryPoint routine encounters an error, it should make *pzErrMsg
5712+** point to an appropriate error message (obtained from [sqlite3_mprintf()])
5713+** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg
5714+** is NULL before calling the xEntryPoint(). ^SQLite will invoke
5715+** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any
5716+** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()],
5717+** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail.
5719+** ^Calling sqlite3_auto_extension(X) with an entry point X that is already
5720+** on the list of automatic extensions is a harmless no-op. ^No entry point
5721+** will be called more than once for each database connection that is opened.
5723+** See also: [sqlite3_reset_auto_extension()]
5724+** and [sqlite3_cancel_auto_extension()]
5726+SQLITE_API int SQLITE_STDCALL sqlite3_auto_extension(void (*xEntryPoint)(void));
5729+** CAPI3REF: Cancel Automatic Extension Loading
5731+** ^The [sqlite3_cancel_auto_extension(X)] interface unregisters the
5732+** initialization routine X that was registered using a prior call to
5733+** [sqlite3_auto_extension(X)]. ^The [sqlite3_cancel_auto_extension(X)]
5734+** routine returns 1 if initialization routine X was successfully
5735+** unregistered and it returns 0 if X was not on the list of initialization
5736+** routines.
5738+SQLITE_API int SQLITE_STDCALL sqlite3_cancel_auto_extension(void (*xEntryPoint)(void));
5741+** CAPI3REF: Reset Automatic Extension Loading
5743+** ^This interface disables all automatic extensions previously
5744+** registered using [sqlite3_auto_extension()].
5746+SQLITE_API void SQLITE_STDCALL sqlite3_reset_auto_extension(void);
5749+** The interface to the virtual-table mechanism is currently considered
5750+** to be experimental. The interface might change in incompatible ways.
5751+** If this is a problem for you, do not use the interface at this time.
5753+** When the virtual-table mechanism stabilizes, we will declare the
5754+** interface fixed, support it indefinitely, and remove this comment.
5758+** Structures used by the virtual table interface
5760+typedef struct sqlite3_vtab sqlite3_vtab;
5761+typedef struct sqlite3_index_info sqlite3_index_info;
5762+typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor;
5763+typedef struct sqlite3_module sqlite3_module;
5766+** CAPI3REF: Virtual Table Object
5767+** KEYWORDS: sqlite3_module {virtual table module}
5769+** This structure, sometimes called a "virtual table module",
5770+** defines the implementation of a [virtual tables].
5771+** This structure consists mostly of methods for the module.
5773+** ^A virtual table module is created by filling in a persistent
5774+** instance of this structure and passing a pointer to that instance
5775+** to [sqlite3_create_module()] or [sqlite3_create_module_v2()].
5776+** ^The registration remains valid until it is replaced by a different
5777+** module or until the [database connection] closes. The content
5778+** of this structure must not change while it is registered with
5779+** any database connection.
5781+struct sqlite3_module {
5782+ int iVersion;
5783+ int (*xCreate)(sqlite3*, void *pAux,
5784+ int argc, const char *const*argv,
5785+ sqlite3_vtab **ppVTab, char**);
5786+ int (*xConnect)(sqlite3*, void *pAux,
5787+ int argc, const char *const*argv,
5788+ sqlite3_vtab **ppVTab, char**);
5789+ int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*);
5790+ int (*xDisconnect)(sqlite3_vtab *pVTab);
5791+ int (*xDestroy)(sqlite3_vtab *pVTab);
5792+ int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor);
5793+ int (*xClose)(sqlite3_vtab_cursor*);
5794+ int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr,
5795+ int argc, sqlite3_value **argv);
5796+ int (*xNext)(sqlite3_vtab_cursor*);
5797+ int (*xEof)(sqlite3_vtab_cursor*);
5798+ int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int);
5799+ int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid);
5800+ int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *);
5801+ int (*xBegin)(sqlite3_vtab *pVTab);
5802+ int (*xSync)(sqlite3_vtab *pVTab);
5803+ int (*xCommit)(sqlite3_vtab *pVTab);
5804+ int (*xRollback)(sqlite3_vtab *pVTab);
5805+ int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName,
5806+ void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),
5807+ void **ppArg);
5808+ int (*xRename)(sqlite3_vtab *pVtab, const char *zNew);
5809+ /* The methods above are in version 1 of the sqlite_module object. Those
5810+ ** below are for version 2 and greater. */
5811+ int (*xSavepoint)(sqlite3_vtab *pVTab, int);
5812+ int (*xRelease)(sqlite3_vtab *pVTab, int);
5813+ int (*xRollbackTo)(sqlite3_vtab *pVTab, int);
5817+** CAPI3REF: Virtual Table Indexing Information
5818+** KEYWORDS: sqlite3_index_info
5820+** The sqlite3_index_info structure and its substructures is used as part
5821+** of the [virtual table] interface to
5822+** pass information into and receive the reply from the [xBestIndex]
5823+** method of a [virtual table module]. The fields under **Inputs** are the
5824+** inputs to xBestIndex and are read-only. xBestIndex inserts its
5825+** results into the **Outputs** fields.
5827+** ^(The aConstraint[] array records WHERE clause constraints of the form:
5829+** <blockquote>column OP expr</blockquote>
5831+** where OP is =, &lt;, &lt;=, &gt;, or &gt;=.)^ ^(The particular operator is
5832+** stored in aConstraint[].op using one of the
5834+** ^(The index of the column is stored in
5835+** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the
5836+** expr on the right-hand side can be evaluated (and thus the constraint
5837+** is usable) and false if it cannot.)^
5839+** ^The optimizer automatically inverts terms of the form "expr OP column"
5840+** and makes other simplifications to the WHERE clause in an attempt to
5841+** get as many WHERE clause terms into the form shown above as possible.
5842+** ^The aConstraint[] array only reports WHERE clause terms that are
5843+** relevant to the particular virtual table being queried.
5845+** ^Information about the ORDER BY clause is stored in aOrderBy[].
5846+** ^Each term of aOrderBy records a column of the ORDER BY clause.
5848+** The colUsed field indicates which columns of the virtual table may be
5849+** required by the current scan. Virtual table columns are numbered from
5850+** zero in the order in which they appear within the CREATE TABLE statement
5851+** passed to sqlite3_declare_vtab(). For the first 63 columns (columns 0-62),
5852+** the corresponding bit is set within the colUsed mask if the column may be
5853+** required by SQLite. If the table has at least 64 columns and any column
5854+** to the right of the first 63 is required, then bit 63 of colUsed is also
5855+** set. In other words, column iCol may be required if the expression
5856+** (colUsed & ((sqlite3_uint64)1 << (iCol>=63 ? 63 : iCol))) evaluates to
5857+** non-zero.
5859+** The [xBestIndex] method must fill aConstraintUsage[] with information
5860+** about what parameters to pass to xFilter. ^If argvIndex>0 then
5861+** the right-hand side of the corresponding aConstraint[] is evaluated
5862+** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit
5863+** is true, then the constraint is assumed to be fully handled by the
5864+** virtual table and is not checked again by SQLite.)^
5866+** ^The idxNum and idxPtr values are recorded and passed into the
5867+** [xFilter] method.
5868+** ^[sqlite3_free()] is used to free idxPtr if and only if
5869+** needToFreeIdxPtr is true.
5871+** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in
5872+** the correct order to satisfy the ORDER BY clause so that no separate
5873+** sorting step is required.
5875+** ^The estimatedCost value is an estimate of the cost of a particular
5876+** strategy. A cost of N indicates that the cost of the strategy is similar
5877+** to a linear scan of an SQLite table with N rows. A cost of log(N)
5878+** indicates that the expense of the operation is similar to that of a
5879+** binary search on a unique indexed field of an SQLite table with N rows.
5881+** ^The estimatedRows value is an estimate of the number of rows that
5882+** will be returned by the strategy.
5884+** The xBestIndex method may optionally populate the idxFlags field with a
5885+** mask of SQLITE_INDEX_SCAN_* flags. Currently there is only one such flag -
5886+** SQLITE_INDEX_SCAN_UNIQUE. If the xBestIndex method sets this flag, SQLite
5887+** assumes that the strategy may visit at most one row.
5889+** Additionally, if xBestIndex sets the SQLITE_INDEX_SCAN_UNIQUE flag, then
5890+** SQLite also assumes that if a call to the xUpdate() method is made as
5891+** part of the same statement to delete or update a virtual table row and the
5892+** implementation returns SQLITE_CONSTRAINT, then there is no need to rollback
5893+** any database changes. In other words, if the xUpdate() returns
5894+** SQLITE_CONSTRAINT, the database contents must be exactly as they were
5895+** before xUpdate was called. By contrast, if SQLITE_INDEX_SCAN_UNIQUE is not
5896+** set and xUpdate returns SQLITE_CONSTRAINT, any database changes made by
5897+** the xUpdate method are automatically rolled back by SQLite.
5899+** IMPORTANT: The estimatedRows field was added to the sqlite3_index_info
5900+** structure for SQLite version 3.8.2. If a virtual table extension is
5901+** used with an SQLite version earlier than 3.8.2, the results of attempting
5902+** to read or write the estimatedRows field are undefined (but are likely
5903+** to included crashing the application). The estimatedRows field should
5904+** therefore only be used if [sqlite3_libversion_number()] returns a
5905+** value greater than or equal to 3008002. Similarly, the idxFlags field
5906+** was added for version 3.9.0. It may therefore only be used if
5907+** sqlite3_libversion_number() returns a value greater than or equal to
5908+** 3009000.
5910+struct sqlite3_index_info {
5911+ /* Inputs */
5912+ int nConstraint; /* Number of entries in aConstraint */
5913+ struct sqlite3_index_constraint {
5914+ int iColumn; /* Column on left-hand side of constraint */
5915+ unsigned char op; /* Constraint operator */
5916+ unsigned char usable; /* True if this constraint is usable */
5917+ int iTermOffset; /* Used internally - xBestIndex should ignore */
5918+ } *aConstraint; /* Table of WHERE clause constraints */
5919+ int nOrderBy; /* Number of terms in the ORDER BY clause */
5920+ struct sqlite3_index_orderby {
5921+ int iColumn; /* Column number */
5922+ unsigned char desc; /* True for DESC. False for ASC. */
5923+ } *aOrderBy; /* The ORDER BY clause */
5924+ /* Outputs */
5925+ struct sqlite3_index_constraint_usage {
5926+ int argvIndex; /* if >0, constraint is part of argv to xFilter */
5927+ unsigned char omit; /* Do not code a test for this constraint */
5928+ } *aConstraintUsage;
5929+ int idxNum; /* Number used to identify the index */
5930+ char *idxStr; /* String, possibly obtained from sqlite3_malloc */
5931+ int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */
5932+ int orderByConsumed; /* True if output is already ordered */
5933+ double estimatedCost; /* Estimated cost of using this index */
5934+ /* Fields below are only available in SQLite 3.8.2 and later */
5935+ sqlite3_int64 estimatedRows; /* Estimated number of rows returned */
5936+ /* Fields below are only available in SQLite 3.9.0 and later */
5937+ int idxFlags; /* Mask of SQLITE_INDEX_SCAN_* flags */
5938+ /* Fields below are only available in SQLite 3.10.0 and later */
5939+ sqlite3_uint64 colUsed; /* Input: Mask of columns used by statement */
5943+** CAPI3REF: Virtual Table Scan Flags
5945+#define SQLITE_INDEX_SCAN_UNIQUE 1 /* Scan visits at most 1 row */
5948+** CAPI3REF: Virtual Table Constraint Operator Codes
5950+** These macros defined the allowed values for the
5951+** [sqlite3_index_info].aConstraint[].op field. Each value represents
5952+** an operator that is part of a constraint term in the wHERE clause of
5953+** a query that uses a [virtual table].
5966+** CAPI3REF: Register A Virtual Table Implementation
5967+** METHOD: sqlite3
5969+** ^These routines are used to register a new [virtual table module] name.
5970+** ^Module names must be registered before
5971+** creating a new [virtual table] using the module and before using a
5972+** preexisting [virtual table] for the module.
5974+** ^The module name is registered on the [database connection] specified
5975+** by the first parameter. ^The name of the module is given by the
5976+** second parameter. ^The third parameter is a pointer to
5977+** the implementation of the [virtual table module]. ^The fourth
5978+** parameter is an arbitrary client data pointer that is passed through
5979+** into the [xCreate] and [xConnect] methods of the virtual table module
5980+** when a new virtual table is be being created or reinitialized.
5982+** ^The sqlite3_create_module_v2() interface has a fifth parameter which
5983+** is a pointer to a destructor for the pClientData. ^SQLite will
5984+** invoke the destructor function (if it is not NULL) when SQLite
5985+** no longer needs the pClientData pointer. ^The destructor will also
5986+** be invoked if the call to sqlite3_create_module_v2() fails.
5987+** ^The sqlite3_create_module()
5988+** interface is equivalent to sqlite3_create_module_v2() with a NULL
5989+** destructor.
5991+SQLITE_API int SQLITE_STDCALL sqlite3_create_module(
5992+ sqlite3 *db, /* SQLite connection to register module with */
5993+ const char *zName, /* Name of the module */
5994+ const sqlite3_module *p, /* Methods for the module */
5995+ void *pClientData /* Client data for xCreate/xConnect */
5997+SQLITE_API int SQLITE_STDCALL sqlite3_create_module_v2(
5998+ sqlite3 *db, /* SQLite connection to register module with */
5999+ const char *zName, /* Name of the module */
6000+ const sqlite3_module *p, /* Methods for the module */
6001+ void *pClientData, /* Client data for xCreate/xConnect */
6002+ void(*xDestroy)(void*) /* Module destructor function */
6006+** CAPI3REF: Virtual Table Instance Object
6007+** KEYWORDS: sqlite3_vtab
6009+** Every [virtual table module] implementation uses a subclass
6010+** of this object to describe a particular instance
6011+** of the [virtual table]. Each subclass will
6012+** be tailored to the specific needs of the module implementation.
6013+** The purpose of this superclass is to define certain fields that are
6014+** common to all module implementations.
6016+** ^Virtual tables methods can set an error message by assigning a
6017+** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should
6018+** take care that any prior string is freed by a call to [sqlite3_free()]
6019+** prior to assigning a new string to zErrMsg. ^After the error message
6020+** is delivered up to the client application, the string will be automatically
6021+** freed by sqlite3_free() and the zErrMsg field will be zeroed.
6023+struct sqlite3_vtab {
6024+ const sqlite3_module *pModule; /* The module for this virtual table */
6025+ int nRef; /* Number of open cursors */
6026+ char *zErrMsg; /* Error message from sqlite3_mprintf() */
6027+ /* Virtual table implementations will typically add additional fields */
6031+** CAPI3REF: Virtual Table Cursor Object
6032+** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor}
6034+** Every [virtual table module] implementation uses a subclass of the
6035+** following structure to describe cursors that point into the
6036+** [virtual table] and are used
6037+** to loop through the virtual table. Cursors are created using the
6038+** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed
6039+** by the [sqlite3_module.xClose | xClose] method. Cursors are used
6040+** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods
6041+** of the module. Each module implementation will define
6042+** the content of a cursor structure to suit its own needs.
6044+** This superclass exists in order to define fields of the cursor that
6045+** are common to all implementations.
6047+struct sqlite3_vtab_cursor {
6048+ sqlite3_vtab *pVtab; /* Virtual table of this cursor */
6049+ /* Virtual table implementations will typically add additional fields */
6053+** CAPI3REF: Declare The Schema Of A Virtual Table
6055+** ^The [xCreate] and [xConnect] methods of a
6056+** [virtual table module] call this interface
6057+** to declare the format (the names and datatypes of the columns) of
6058+** the virtual tables they implement.
6060+SQLITE_API int SQLITE_STDCALL sqlite3_declare_vtab(sqlite3*, const char *zSQL);
6063+** CAPI3REF: Overload A Function For A Virtual Table
6064+** METHOD: sqlite3
6066+** ^(Virtual tables can provide alternative implementations of functions
6067+** using the [xFindFunction] method of the [virtual table module].
6068+** But global versions of those functions
6069+** must exist in order to be overloaded.)^
6071+** ^(This API makes sure a global version of a function with a particular
6072+** name and number of parameters exists. If no such function exists
6073+** before this API is called, a new function is created.)^ ^The implementation
6074+** of the new function always causes an exception to be thrown. So
6075+** the new function is not good for anything by itself. Its only
6076+** purpose is to be a placeholder function that can be overloaded
6077+** by a [virtual table].
6079+SQLITE_API int SQLITE_STDCALL sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg);
6082+** The interface to the virtual-table mechanism defined above (back up
6083+** to a comment remarkably similar to this one) is currently considered
6084+** to be experimental. The interface might change in incompatible ways.
6085+** If this is a problem for you, do not use the interface at this time.
6087+** When the virtual-table mechanism stabilizes, we will declare the
6088+** interface fixed, support it indefinitely, and remove this comment.
6092+** CAPI3REF: A Handle To An Open BLOB
6093+** KEYWORDS: {BLOB handle} {BLOB handles}
6095+** An instance of this object represents an open BLOB on which
6096+** [sqlite3_blob_open | incremental BLOB I/O] can be performed.
6097+** ^Objects of this type are created by [sqlite3_blob_open()]
6098+** and destroyed by [sqlite3_blob_close()].
6099+** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces
6100+** can be used to read or write small subsections of the BLOB.
6101+** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes.
6103+typedef struct sqlite3_blob sqlite3_blob;
6106+** CAPI3REF: Open A BLOB For Incremental I/O
6107+** METHOD: sqlite3
6108+** CONSTRUCTOR: sqlite3_blob
6110+** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located
6111+** in row iRow, column zColumn, table zTable in database zDb;
6112+** in other words, the same BLOB that would be selected by:
6114+** <pre>
6115+** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow;
6116+** </pre>)^
6118+** ^(Parameter zDb is not the filename that contains the database, but
6119+** rather the symbolic name of the database. For attached databases, this is
6120+** the name that appears after the AS keyword in the [ATTACH] statement.
6121+** For the main database file, the database name is "main". For TEMP
6122+** tables, the database name is "temp".)^
6124+** ^If the flags parameter is non-zero, then the BLOB is opened for read
6125+** and write access. ^If the flags parameter is zero, the BLOB is opened for
6126+** read-only access.
6128+** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is stored
6129+** in *ppBlob. Otherwise an [error code] is returned and, unless the error
6130+** code is SQLITE_MISUSE, *ppBlob is set to NULL.)^ ^This means that, provided
6131+** the API is not misused, it is always safe to call [sqlite3_blob_close()]
6132+** on *ppBlob after this function it returns.
6134+** This function fails with SQLITE_ERROR if any of the following are true:
6135+** <ul>
6136+** <li> ^(Database zDb does not exist)^,
6137+** <li> ^(Table zTable does not exist within database zDb)^,
6138+** <li> ^(Table zTable is a WITHOUT ROWID table)^,
6139+** <li> ^(Column zColumn does not exist)^,
6140+** <li> ^(Row iRow is not present in the table)^,
6141+** <li> ^(The specified column of row iRow contains a value that is not
6142+** a TEXT or BLOB value)^,
6143+** <li> ^(Column zColumn is part of an index, PRIMARY KEY or UNIQUE
6144+** constraint and the blob is being opened for read/write access)^,
6145+** <li> ^([foreign key constraints | Foreign key constraints] are enabled,
6146+** column zColumn is part of a [child key] definition and the blob is
6147+** being opened for read/write access)^.
6148+** </ul>
6150+** ^Unless it returns SQLITE_MISUSE, this function sets the
6151+** [database connection] error code and message accessible via
6152+** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions.
6155+** ^(If the row that a BLOB handle points to is modified by an
6156+** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects
6157+** then the BLOB handle is marked as "expired".
6158+** This is true if any column of the row is changed, even a column
6159+** other than the one the BLOB handle is open on.)^
6160+** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for
6161+** an expired BLOB handle fail with a return code of [SQLITE_ABORT].
6162+** ^(Changes written into a BLOB prior to the BLOB expiring are not
6163+** rolled back by the expiration of the BLOB. Such changes will eventually
6164+** commit if the transaction continues to completion.)^
6166+** ^Use the [sqlite3_blob_bytes()] interface to determine the size of
6167+** the opened blob. ^The size of a blob may not be changed by this
6168+** interface. Use the [UPDATE] SQL command to change the size of a
6169+** blob.
6171+** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces
6172+** and the built-in [zeroblob] SQL function may be used to create a
6173+** zero-filled blob to read or write using the incremental-blob interface.
6175+** To avoid a resource leak, every open [BLOB handle] should eventually
6176+** be released by a call to [sqlite3_blob_close()].
6178+SQLITE_API int SQLITE_STDCALL sqlite3_blob_open(
6179+ sqlite3*,
6180+ const char *zDb,
6181+ const char *zTable,
6182+ const char *zColumn,
6183+ sqlite3_int64 iRow,
6184+ int flags,
6185+ sqlite3_blob **ppBlob
6189+** CAPI3REF: Move a BLOB Handle to a New Row
6190+** METHOD: sqlite3_blob
6192+** ^This function is used to move an existing blob handle so that it points
6193+** to a different row of the same database table. ^The new row is identified
6194+** by the rowid value passed as the second argument. Only the row can be
6195+** changed. ^The database, table and column on which the blob handle is open
6196+** remain the same. Moving an existing blob handle to a new row can be
6197+** faster than closing the existing handle and opening a new one.
6199+** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] -
6200+** it must exist and there must be either a blob or text value stored in
6201+** the nominated column.)^ ^If the new row is not present in the table, or if
6202+** it does not contain a blob or text value, or if another error occurs, an
6203+** SQLite error code is returned and the blob handle is considered aborted.
6204+** ^All subsequent calls to [sqlite3_blob_read()], [sqlite3_blob_write()] or
6205+** [sqlite3_blob_reopen()] on an aborted blob handle immediately return
6206+** SQLITE_ABORT. ^Calling [sqlite3_blob_bytes()] on an aborted blob handle
6207+** always returns zero.
6209+** ^This function sets the database handle error code and message.
6211+SQLITE_API int SQLITE_STDCALL sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64);
6214+** CAPI3REF: Close A BLOB Handle
6215+** DESTRUCTOR: sqlite3_blob
6217+** ^This function closes an open [BLOB handle]. ^(The BLOB handle is closed
6218+** unconditionally. Even if this routine returns an error code, the
6219+** handle is still closed.)^
6221+** ^If the blob handle being closed was opened for read-write access, and if
6222+** the database is in auto-commit mode and there are no other open read-write
6223+** blob handles or active write statements, the current transaction is
6224+** committed. ^If an error occurs while committing the transaction, an error
6225+** code is returned and the transaction rolled back.
6227+** Calling this function with an argument that is not a NULL pointer or an
6228+** open blob handle results in undefined behaviour. ^Calling this routine
6229+** with a null pointer (such as would be returned by a failed call to
6230+** [sqlite3_blob_open()]) is a harmless no-op. ^Otherwise, if this function
6231+** is passed a valid open blob handle, the values returned by the
6232+** sqlite3_errcode() and sqlite3_errmsg() functions are set before returning.
6234+SQLITE_API int SQLITE_STDCALL sqlite3_blob_close(sqlite3_blob *);
6237+** CAPI3REF: Return The Size Of An Open BLOB
6238+** METHOD: sqlite3_blob
6240+** ^Returns the size in bytes of the BLOB accessible via the
6241+** successfully opened [BLOB handle] in its only argument. ^The
6242+** incremental blob I/O routines can only read or overwriting existing
6243+** blob content; they cannot change the size of a blob.
6245+** This routine only works on a [BLOB handle] which has been created
6246+** by a prior successful call to [sqlite3_blob_open()] and which has not
6247+** been closed by [sqlite3_blob_close()]. Passing any other pointer in
6248+** to this routine results in undefined and probably undesirable behavior.
6250+SQLITE_API int SQLITE_STDCALL sqlite3_blob_bytes(sqlite3_blob *);
6253+** CAPI3REF: Read Data From A BLOB Incrementally
6254+** METHOD: sqlite3_blob
6256+** ^(This function is used to read data from an open [BLOB handle] into a
6257+** caller-supplied buffer. N bytes of data are copied into buffer Z
6258+** from the open BLOB, starting at offset iOffset.)^
6260+** ^If offset iOffset is less than N bytes from the end of the BLOB,
6261+** [SQLITE_ERROR] is returned and no data is read. ^If N or iOffset is
6262+** less than zero, [SQLITE_ERROR] is returned and no data is read.
6263+** ^The size of the blob (and hence the maximum value of N+iOffset)
6264+** can be determined using the [sqlite3_blob_bytes()] interface.
6266+** ^An attempt to read from an expired [BLOB handle] fails with an
6267+** error code of [SQLITE_ABORT].
6269+** ^(On success, sqlite3_blob_read() returns SQLITE_OK.
6270+** Otherwise, an [error code] or an [extended error code] is returned.)^
6272+** This routine only works on a [BLOB handle] which has been created
6273+** by a prior successful call to [sqlite3_blob_open()] and which has not
6274+** been closed by [sqlite3_blob_close()]. Passing any other pointer in
6275+** to this routine results in undefined and probably undesirable behavior.
6277+** See also: [sqlite3_blob_write()].
6279+SQLITE_API int SQLITE_STDCALL sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset);
6282+** CAPI3REF: Write Data Into A BLOB Incrementally
6283+** METHOD: sqlite3_blob
6285+** ^(This function is used to write data into an open [BLOB handle] from a
6286+** caller-supplied buffer. N bytes of data are copied from the buffer Z
6287+** into the open BLOB, starting at offset iOffset.)^
6289+** ^(On success, sqlite3_blob_write() returns SQLITE_OK.
6290+** Otherwise, an [error code] or an [extended error code] is returned.)^
6291+** ^Unless SQLITE_MISUSE is returned, this function sets the
6292+** [database connection] error code and message accessible via
6293+** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions.
6295+** ^If the [BLOB handle] passed as the first argument was not opened for
6296+** writing (the flags parameter to [sqlite3_blob_open()] was zero),
6297+** this function returns [SQLITE_READONLY].
6299+** This function may only modify the contents of the BLOB; it is
6300+** not possible to increase the size of a BLOB using this API.
6301+** ^If offset iOffset is less than N bytes from the end of the BLOB,
6302+** [SQLITE_ERROR] is returned and no data is written. The size of the
6303+** BLOB (and hence the maximum value of N+iOffset) can be determined
6304+** using the [sqlite3_blob_bytes()] interface. ^If N or iOffset are less
6305+** than zero [SQLITE_ERROR] is returned and no data is written.
6307+** ^An attempt to write to an expired [BLOB handle] fails with an
6308+** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred
6309+** before the [BLOB handle] expired are not rolled back by the
6310+** expiration of the handle, though of course those changes might
6311+** have been overwritten by the statement that expired the BLOB handle
6312+** or by other independent statements.
6314+** This routine only works on a [BLOB handle] which has been created
6315+** by a prior successful call to [sqlite3_blob_open()] and which has not
6316+** been closed by [sqlite3_blob_close()]. Passing any other pointer in
6317+** to this routine results in undefined and probably undesirable behavior.
6319+** See also: [sqlite3_blob_read()].
6321+SQLITE_API int SQLITE_STDCALL sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset);
6324+** CAPI3REF: Virtual File System Objects
6326+** A virtual filesystem (VFS) is an [sqlite3_vfs] object
6327+** that SQLite uses to interact
6328+** with the underlying operating system. Most SQLite builds come with a
6329+** single default VFS that is appropriate for the host computer.
6330+** New VFSes can be registered and existing VFSes can be unregistered.
6331+** The following interfaces are provided.
6333+** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name.
6334+** ^Names are case sensitive.
6335+** ^Names are zero-terminated UTF-8 strings.
6336+** ^If there is no match, a NULL pointer is returned.
6337+** ^If zVfsName is NULL then the default VFS is returned.
6339+** ^New VFSes are registered with sqlite3_vfs_register().
6340+** ^Each new VFS becomes the default VFS if the makeDflt flag is set.
6341+** ^The same VFS can be registered multiple times without injury.
6342+** ^To make an existing VFS into the default VFS, register it again
6343+** with the makeDflt flag set. If two different VFSes with the
6344+** same name are registered, the behavior is undefined. If a
6345+** VFS is registered with a name that is NULL or an empty string,
6346+** then the behavior is undefined.
6348+** ^Unregister a VFS with the sqlite3_vfs_unregister() interface.
6349+** ^(If the default VFS is unregistered, another VFS is chosen as
6350+** the default. The choice for the new VFS is arbitrary.)^
6352+SQLITE_API sqlite3_vfs *SQLITE_STDCALL sqlite3_vfs_find(const char *zVfsName);
6353+SQLITE_API int SQLITE_STDCALL sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);
6354+SQLITE_API int SQLITE_STDCALL sqlite3_vfs_unregister(sqlite3_vfs*);
6357+** CAPI3REF: Mutexes
6359+** The SQLite core uses these routines for thread
6360+** synchronization. Though they are intended for internal
6361+** use by SQLite, code that links against SQLite is
6362+** permitted to use any of these routines.
6364+** The SQLite source code contains multiple implementations
6365+** of these mutex routines. An appropriate implementation
6366+** is selected automatically at compile-time. The following
6367+** implementations are available in the SQLite core:
6369+** <ul>
6371+** <li> SQLITE_MUTEX_W32
6372+** <li> SQLITE_MUTEX_NOOP
6373+** </ul>
6375+** The SQLITE_MUTEX_NOOP implementation is a set of routines
6376+** that does no real locking and is appropriate for use in
6377+** a single-threaded application. The SQLITE_MUTEX_PTHREADS and
6378+** SQLITE_MUTEX_W32 implementations are appropriate for use on Unix
6379+** and Windows.
6381+** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor
6382+** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex
6383+** implementation is included with the library. In this case the
6384+** application must supply a custom mutex implementation using the
6385+** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function
6386+** before calling sqlite3_initialize() or any other public sqlite3_
6387+** function that calls sqlite3_initialize().
6389+** ^The sqlite3_mutex_alloc() routine allocates a new
6390+** mutex and returns a pointer to it. ^The sqlite3_mutex_alloc()
6391+** routine returns NULL if it is unable to allocate the requested
6392+** mutex. The argument to sqlite3_mutex_alloc() must one of these
6393+** integer constants:
6395+** <ul>
6396+** <li> SQLITE_MUTEX_FAST
6410+** </ul>
6412+** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE)
6413+** cause sqlite3_mutex_alloc() to create
6414+** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
6415+** is used but not necessarily so when SQLITE_MUTEX_FAST is used.
6416+** The mutex implementation does not need to make a distinction
6417+** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
6418+** not want to. SQLite will only request a recursive mutex in
6419+** cases where it really needs one. If a faster non-recursive mutex
6420+** implementation is available on the host platform, the mutex subsystem
6421+** might return such a mutex in response to SQLITE_MUTEX_FAST.
6423+** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other
6424+** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return
6425+** a pointer to a static preexisting mutex. ^Nine static mutexes are
6426+** used by the current version of SQLite. Future versions of SQLite
6427+** may add additional static mutexes. Static mutexes are for internal
6428+** use by SQLite only. Applications that use SQLite mutexes should
6429+** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
6432+** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
6433+** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
6434+** returns a different mutex on every call. ^For the static
6435+** mutex types, the same mutex is returned on every call that has
6436+** the same type number.
6438+** ^The sqlite3_mutex_free() routine deallocates a previously
6439+** allocated dynamic mutex. Attempting to deallocate a static
6440+** mutex results in undefined behavior.
6442+** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
6443+** to enter a mutex. ^If another thread is already within the mutex,
6444+** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
6445+** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK]
6446+** upon successful entry. ^(Mutexes created using
6447+** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread.
6448+** In such cases, the
6449+** mutex must be exited an equal number of times before another thread
6450+** can enter.)^ If the same thread tries to enter any mutex other
6451+** than an SQLITE_MUTEX_RECURSIVE more than once, the behavior is undefined.
6453+** ^(Some systems (for example, Windows 95) do not support the operation
6454+** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try()
6455+** will always return SQLITE_BUSY. The SQLite core only ever uses
6456+** sqlite3_mutex_try() as an optimization so this is acceptable
6457+** behavior.)^
6459+** ^The sqlite3_mutex_leave() routine exits a mutex that was
6460+** previously entered by the same thread. The behavior
6461+** is undefined if the mutex is not currently entered by the
6462+** calling thread or is not currently allocated.
6464+** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or
6465+** sqlite3_mutex_leave() is a NULL pointer, then all three routines
6466+** behave as no-ops.
6468+** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()].
6470+SQLITE_API sqlite3_mutex *SQLITE_STDCALL sqlite3_mutex_alloc(int);
6471+SQLITE_API void SQLITE_STDCALL sqlite3_mutex_free(sqlite3_mutex*);
6472+SQLITE_API void SQLITE_STDCALL sqlite3_mutex_enter(sqlite3_mutex*);
6473+SQLITE_API int SQLITE_STDCALL sqlite3_mutex_try(sqlite3_mutex*);
6474+SQLITE_API void SQLITE_STDCALL sqlite3_mutex_leave(sqlite3_mutex*);
6477+** CAPI3REF: Mutex Methods Object
6479+** An instance of this structure defines the low-level routines
6480+** used to allocate and use mutexes.
6482+** Usually, the default mutex implementations provided by SQLite are
6483+** sufficient, however the application has the option of substituting a custom
6484+** implementation for specialized deployments or systems for which SQLite
6485+** does not provide a suitable implementation. In this case, the application
6486+** creates and populates an instance of this structure to pass
6487+** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option.
6488+** Additionally, an instance of this structure can be used as an
6489+** output variable when querying the system for the current mutex
6490+** implementation, using the [SQLITE_CONFIG_GETMUTEX] option.
6492+** ^The xMutexInit method defined by this structure is invoked as
6493+** part of system initialization by the sqlite3_initialize() function.
6494+** ^The xMutexInit routine is called by SQLite exactly once for each
6495+** effective call to [sqlite3_initialize()].
6497+** ^The xMutexEnd method defined by this structure is invoked as
6498+** part of system shutdown by the sqlite3_shutdown() function. The
6499+** implementation of this method is expected to release all outstanding
6500+** resources obtained by the mutex methods implementation, especially
6501+** those obtained by the xMutexInit method. ^The xMutexEnd()
6502+** interface is invoked exactly once for each call to [sqlite3_shutdown()].
6504+** ^(The remaining seven methods defined by this structure (xMutexAlloc,
6505+** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and
6506+** xMutexNotheld) implement the following interfaces (respectively):
6508+** <ul>
6509+** <li> [sqlite3_mutex_alloc()] </li>
6510+** <li> [sqlite3_mutex_free()] </li>
6511+** <li> [sqlite3_mutex_enter()] </li>
6512+** <li> [sqlite3_mutex_try()] </li>
6513+** <li> [sqlite3_mutex_leave()] </li>
6514+** <li> [sqlite3_mutex_held()] </li>
6515+** <li> [sqlite3_mutex_notheld()] </li>
6516+** </ul>)^
6518+** The only difference is that the public sqlite3_XXX functions enumerated
6519+** above silently ignore any invocations that pass a NULL pointer instead
6520+** of a valid mutex handle. The implementations of the methods defined
6521+** by this structure are not required to handle this case, the results
6522+** of passing a NULL pointer instead of a valid mutex handle are undefined
6523+** (i.e. it is acceptable to provide an implementation that segfaults if
6524+** it is passed a NULL pointer).
6526+** The xMutexInit() method must be threadsafe. It must be harmless to
6527+** invoke xMutexInit() multiple times within the same process and without
6528+** intervening calls to xMutexEnd(). Second and subsequent calls to
6529+** xMutexInit() must be no-ops.
6531+** xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()]
6532+** and its associates). Similarly, xMutexAlloc() must not use SQLite memory
6533+** allocation for a static mutex. ^However xMutexAlloc() may use SQLite
6534+** memory allocation for a fast or recursive mutex.
6536+** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is
6537+** called, but only if the prior call to xMutexInit returned SQLITE_OK.
6538+** If xMutexInit fails in any way, it is expected to clean up after itself
6539+** prior to returning.
6541+typedef struct sqlite3_mutex_methods sqlite3_mutex_methods;
6542+struct sqlite3_mutex_methods {
6543+ int (*xMutexInit)(void);
6544+ int (*xMutexEnd)(void);
6545+ sqlite3_mutex *(*xMutexAlloc)(int);
6546+ void (*xMutexFree)(sqlite3_mutex *);
6547+ void (*xMutexEnter)(sqlite3_mutex *);
6548+ int (*xMutexTry)(sqlite3_mutex *);
6549+ void (*xMutexLeave)(sqlite3_mutex *);
6550+ int (*xMutexHeld)(sqlite3_mutex *);
6551+ int (*xMutexNotheld)(sqlite3_mutex *);
6555+** CAPI3REF: Mutex Verification Routines
6557+** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines
6558+** are intended for use inside assert() statements. The SQLite core
6559+** never uses these routines except inside an assert() and applications
6560+** are advised to follow the lead of the core. The SQLite core only
6561+** provides implementations for these routines when it is compiled
6562+** with the SQLITE_DEBUG flag. External mutex implementations
6563+** are only required to provide these routines if SQLITE_DEBUG is
6564+** defined and if NDEBUG is not defined.
6566+** These routines should return true if the mutex in their argument
6567+** is held or not held, respectively, by the calling thread.
6569+** The implementation is not required to provide versions of these
6570+** routines that actually work. If the implementation does not provide working
6571+** versions of these routines, it should at least provide stubs that always
6572+** return true so that one does not get spurious assertion failures.
6574+** If the argument to sqlite3_mutex_held() is a NULL pointer then
6575+** the routine should return 1. This seems counter-intuitive since
6576+** clearly the mutex cannot be held if it does not exist. But
6577+** the reason the mutex does not exist is because the build is not
6578+** using mutexes. And we do not want the assert() containing the
6579+** call to sqlite3_mutex_held() to fail, so a non-zero return is
6580+** the appropriate thing to do. The sqlite3_mutex_notheld()
6581+** interface should also return 1 when given a NULL pointer.
6583+#ifndef NDEBUG
6584+SQLITE_API int SQLITE_STDCALL sqlite3_mutex_held(sqlite3_mutex*);
6585+SQLITE_API int SQLITE_STDCALL sqlite3_mutex_notheld(sqlite3_mutex*);
6589+** CAPI3REF: Mutex Types
6591+** The [sqlite3_mutex_alloc()] interface takes a single argument
6592+** which is one of these integer constants.
6594+** The set of static mutexes may change from one SQLite release to the
6595+** next. Applications that override the built-in mutex logic must be
6596+** prepared to accommodate additional static mutexes.
6598+#define SQLITE_MUTEX_FAST 0
6601+#define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */
6602+#define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */
6603+#define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */
6604+#define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */
6605+#define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */
6606+#define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */
6607+#define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */
6608+#define SQLITE_MUTEX_STATIC_APP1 8 /* For use by application */
6609+#define SQLITE_MUTEX_STATIC_APP2 9 /* For use by application */
6610+#define SQLITE_MUTEX_STATIC_APP3 10 /* For use by application */
6611+#define SQLITE_MUTEX_STATIC_VFS1 11 /* For use by built-in VFS */
6612+#define SQLITE_MUTEX_STATIC_VFS2 12 /* For use by extension VFS */
6613+#define SQLITE_MUTEX_STATIC_VFS3 13 /* For use by application VFS */
6616+** CAPI3REF: Retrieve the mutex for a database connection
6617+** METHOD: sqlite3
6619+** ^This interface returns a pointer the [sqlite3_mutex] object that
6620+** serializes access to the [database connection] given in the argument
6621+** when the [threading mode] is Serialized.
6622+** ^If the [threading mode] is Single-thread or Multi-thread then this
6623+** routine returns a NULL pointer.
6625+SQLITE_API sqlite3_mutex *SQLITE_STDCALL sqlite3_db_mutex(sqlite3*);
6628+** CAPI3REF: Low-Level Control Of Database Files
6629+** METHOD: sqlite3
6631+** ^The [sqlite3_file_control()] interface makes a direct call to the
6632+** xFileControl method for the [sqlite3_io_methods] object associated
6633+** with a particular database identified by the second argument. ^The
6634+** name of the database is "main" for the main database or "temp" for the
6635+** TEMP database, or the name that appears after the AS keyword for
6636+** databases that are added using the [ATTACH] SQL command.
6637+** ^A NULL pointer can be used in place of "main" to refer to the
6638+** main database file.
6639+** ^The third and fourth parameters to this routine
6640+** are passed directly through to the second and third parameters of
6641+** the xFileControl method. ^The return value of the xFileControl
6642+** method becomes the return value of this routine.
6644+** ^The SQLITE_FCNTL_FILE_POINTER value for the op parameter causes
6645+** a pointer to the underlying [sqlite3_file] object to be written into
6646+** the space pointed to by the 4th parameter. ^The SQLITE_FCNTL_FILE_POINTER
6647+** case is a short-circuit path which does not actually invoke the
6648+** underlying sqlite3_io_methods.xFileControl method.
6650+** ^If the second parameter (zDbName) does not match the name of any
6651+** open database file, then SQLITE_ERROR is returned. ^This error
6652+** code is not remembered and will not be recalled by [sqlite3_errcode()]
6653+** or [sqlite3_errmsg()]. The underlying xFileControl method might
6654+** also return SQLITE_ERROR. There is no way to distinguish between
6655+** an incorrect zDbName and an SQLITE_ERROR return from the underlying
6656+** xFileControl method.
6658+** See also: [SQLITE_FCNTL_LOCKSTATE]
6660+SQLITE_API int SQLITE_STDCALL sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*);
6663+** CAPI3REF: Testing Interface
6665+** ^The sqlite3_test_control() interface is used to read out internal
6666+** state of SQLite and to inject faults into SQLite for testing
6667+** purposes. ^The first parameter is an operation code that determines
6668+** the number, meaning, and operation of all subsequent parameters.
6670+** This interface is not for use by applications. It exists solely
6671+** for verifying the correct operation of the SQLite library. Depending
6672+** on how the SQLite library is compiled, this interface might not exist.
6674+** The details of the operation codes, their meanings, the parameters
6675+** they take, and what they do are all subject to change without notice.
6676+** Unlike most of the SQLite API, this function is not guaranteed to
6677+** operate consistently from one release to the next.
6679+SQLITE_API int SQLITE_CDECL sqlite3_test_control(int op, ...);
6682+** CAPI3REF: Testing Interface Operation Codes
6684+** These constants are the valid operation code parameters used
6685+** as the first argument to [sqlite3_test_control()].
6687+** These parameters and their meanings are subject to change
6688+** without notice. These values are for testing purposes only.
6689+** Applications should not use any of these parameters or the
6690+** [sqlite3_test_control()] interface.
6714+#define SQLITE_TESTCTRL_LAST 25
6717+** CAPI3REF: SQLite Runtime Status
6719+** ^These interfaces are used to retrieve runtime status information
6720+** about the performance of SQLite, and optionally to reset various
6721+** highwater marks. ^The first argument is an integer code for
6722+** the specific parameter to measure. ^(Recognized integer codes
6723+** are of the form [status parameters | SQLITE_STATUS_...].)^
6724+** ^The current value of the parameter is returned into *pCurrent.
6725+** ^The highest recorded value is returned in *pHighwater. ^If the
6726+** resetFlag is true, then the highest record value is reset after
6727+** *pHighwater is written. ^(Some parameters do not record the highest
6728+** value. For those parameters
6729+** nothing is written into *pHighwater and the resetFlag is ignored.)^
6730+** ^(Other parameters record only the highwater mark and not the current
6731+** value. For these latter parameters nothing is written into *pCurrent.)^
6733+** ^The sqlite3_status() and sqlite3_status64() routines return
6734+** SQLITE_OK on success and a non-zero [error code] on failure.
6736+** If either the current value or the highwater mark is too large to
6737+** be represented by a 32-bit integer, then the values returned by
6738+** sqlite3_status() are undefined.
6740+** See also: [sqlite3_db_status()]
6742+SQLITE_API int SQLITE_STDCALL sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag);
6743+SQLITE_API int SQLITE_STDCALL sqlite3_status64(
6744+ int op,
6745+ sqlite3_int64 *pCurrent,
6746+ sqlite3_int64 *pHighwater,
6747+ int resetFlag
6752+** CAPI3REF: Status Parameters
6753+** KEYWORDS: {status parameters}
6755+** These integer constants designate various run-time status parameters
6756+** that can be returned by [sqlite3_status()].
6758+** <dl>
6760+** <dd>This parameter is the current amount of memory checked out
6761+** using [sqlite3_malloc()], either directly or indirectly. The
6762+** figure includes calls made to [sqlite3_malloc()] by the application
6763+** and internal memory usage by the SQLite library. Scratch memory
6764+** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache
6765+** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in
6766+** this parameter. The amount returned is the sum of the allocation
6767+** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^
6770+** <dd>This parameter records the largest memory allocation request
6771+** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their
6772+** internal equivalents). Only the value returned in the
6773+** *pHighwater parameter to [sqlite3_status()] is of interest.
6774+** The value written into the *pCurrent parameter is undefined.</dd>)^
6777+** <dd>This parameter records the number of separate memory allocations
6778+** currently checked out.</dd>)^
6781+** <dd>This parameter returns the number of pages used out of the
6782+** [pagecache memory allocator] that was configured using
6784+** value returned is in pages, not in bytes.</dd>)^
6788+** <dd>This parameter returns the number of bytes of page cache
6789+** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE]
6790+** buffer and where forced to overflow to [sqlite3_malloc()]. The
6791+** returned value includes allocations that overflowed because they
6792+** where too large (they were larger than the "sz" parameter to
6793+** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because
6794+** no space was left in the page cache.</dd>)^
6797+** <dd>This parameter records the largest memory allocation request
6798+** handed to [pagecache memory allocator]. Only the value returned in the
6799+** *pHighwater parameter to [sqlite3_status()] is of interest.
6800+** The value written into the *pCurrent parameter is undefined.</dd>)^
6803+** <dd>This parameter returns the number of allocations used out of the
6804+** [scratch memory allocator] configured using
6805+** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not
6806+** in bytes. Since a single thread may only have one scratch allocation
6807+** outstanding at time, this parameter also reports the number of threads
6808+** using scratch memory at the same time.</dd>)^
6811+** <dd>This parameter returns the number of bytes of scratch memory
6812+** allocation which could not be satisfied by the [SQLITE_CONFIG_SCRATCH]
6813+** buffer and where forced to overflow to [sqlite3_malloc()]. The values
6814+** returned include overflows because the requested allocation was too
6815+** larger (that is, because the requested allocation was larger than the
6816+** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer
6817+** slots were available.
6818+** </dd>)^
6821+** <dd>This parameter records the largest memory allocation request
6822+** handed to [scratch memory allocator]. Only the value returned in the
6823+** *pHighwater parameter to [sqlite3_status()] is of interest.
6824+** The value written into the *pCurrent parameter is undefined.</dd>)^
6827+** <dd>The *pHighwater parameter records the deepest parser stack.
6828+** The *pCurrent value is undefined. The *pHighwater value is only
6829+** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^
6830+** </dl>
6832+** New status parameters may be added from time to time.
6846+** CAPI3REF: Database Connection Status
6847+** METHOD: sqlite3
6849+** ^This interface is used to retrieve runtime status information
6850+** about a single [database connection]. ^The first argument is the
6851+** database connection object to be interrogated. ^The second argument
6852+** is an integer constant, taken from the set of
6853+** [SQLITE_DBSTATUS options], that
6854+** determines the parameter to interrogate. The set of
6855+** [SQLITE_DBSTATUS options] is likely
6856+** to grow in future releases of SQLite.
6858+** ^The current value of the requested parameter is written into *pCur
6859+** and the highest instantaneous value is written into *pHiwtr. ^If
6860+** the resetFlg is true, then the highest instantaneous value is
6861+** reset back down to the current value.
6863+** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a
6864+** non-zero [error code] on failure.
6866+** See also: [sqlite3_status()] and [sqlite3_stmt_status()].
6868+SQLITE_API int SQLITE_STDCALL sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg);
6871+** CAPI3REF: Status Parameters for database connections
6874+** These constants are the available integer "verbs" that can be passed as
6875+** the second argument to the [sqlite3_db_status()] interface.
6877+** New verbs may be added in future releases of SQLite. Existing verbs
6878+** might be discontinued. Applications should check the return code from
6879+** [sqlite3_db_status()] to make sure that the call worked.
6880+** The [sqlite3_db_status()] interface will return a non-zero error code
6881+** if a discontinued or unsupported verb is invoked.
6883+** <dl>
6885+** <dd>This parameter returns the number of lookaside memory slots currently
6886+** checked out.</dd>)^
6889+** <dd>This parameter returns the number malloc attempts that were
6890+** satisfied using lookaside memory. Only the high-water value is meaningful;
6891+** the current value is always zero.)^
6895+** <dd>This parameter returns the number malloc attempts that might have
6896+** been satisfied using lookaside memory but failed due to the amount of
6897+** memory requested being larger than the lookaside slot size.
6898+** Only the high-water value is meaningful;
6899+** the current value is always zero.)^
6903+** <dd>This parameter returns the number malloc attempts that might have
6904+** been satisfied using lookaside memory but failed due to all lookaside
6905+** memory already being in use.
6906+** Only the high-water value is meaningful;
6907+** the current value is always zero.)^
6910+** <dd>This parameter returns the approximate number of bytes of heap
6911+** memory used by all pager caches associated with the database connection.)^
6912+** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0.
6915+** <dd>This parameter returns the approximate number of bytes of heap
6916+** memory used to store the schema for all databases associated
6917+** with the connection - main, temp, and any [ATTACH]-ed databases.)^
6918+** ^The full amount of memory used by the schemas is reported, even if the
6919+** schema memory is shared with other database connections due to
6920+** [shared cache mode] being enabled.
6921+** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0.
6924+** <dd>This parameter returns the approximate number of bytes of heap
6925+** and lookaside memory used by all prepared statements associated with
6926+** the database connection.)^
6927+** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0.
6928+** </dd>
6931+** <dd>This parameter returns the number of pager cache hits that have
6932+** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT
6933+** is always 0.
6934+** </dd>
6937+** <dd>This parameter returns the number of pager cache misses that have
6938+** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS
6939+** is always 0.
6940+** </dd>
6943+** <dd>This parameter returns the number of dirty cache entries that have
6944+** been written to disk. Specifically, the number of pages written to the
6945+** wal file in wal mode databases, or the number of pages written to the
6946+** database file in rollback mode databases. Any pages written as part of
6947+** transaction rollback or database recovery operations are not included.
6948+** If an IO or other error occurs while writing a page to disk, the effect
6949+** on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined.)^ ^The
6950+** highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0.
6951+** </dd>
6954+** <dd>This parameter returns zero for the current value if and only if
6955+** all foreign key constraints (deferred or immediate) have been
6956+** resolved.)^ ^The highwater mark is always 0.
6957+** </dd>
6958+** </dl>
6971+#define SQLITE_DBSTATUS_MAX 10 /* Largest defined DBSTATUS */
6975+** CAPI3REF: Prepared Statement Status
6976+** METHOD: sqlite3_stmt
6978+** ^(Each prepared statement maintains various
6979+** [SQLITE_STMTSTATUS counters] that measure the number
6980+** of times it has performed specific operations.)^ These counters can
6981+** be used to monitor the performance characteristics of the prepared
6982+** statements. For example, if the number of table steps greatly exceeds
6983+** the number of table searches or result rows, that would tend to indicate
6984+** that the prepared statement is using a full table scan rather than
6985+** an index.
6987+** ^(This interface is used to retrieve and reset counter values from
6988+** a [prepared statement]. The first argument is the prepared statement
6989+** object to be interrogated. The second argument
6990+** is an integer code for a specific [SQLITE_STMTSTATUS counter]
6991+** to be interrogated.)^
6992+** ^The current value of the requested counter is returned.
6993+** ^If the resetFlg is true, then the counter is reset to zero after this
6994+** interface call returns.
6996+** See also: [sqlite3_status()] and [sqlite3_db_status()].
6998+SQLITE_API int SQLITE_STDCALL sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg);
7001+** CAPI3REF: Status Parameters for prepared statements
7004+** These preprocessor macros define integer codes that name counter
7005+** values associated with the [sqlite3_stmt_status()] interface.
7006+** The meanings of the various counters are as follows:
7008+** <dl>
7010+** <dd>^This is the number of times that SQLite has stepped forward in
7011+** a table as part of a full table scan. Large numbers for this counter
7012+** may indicate opportunities for performance improvement through
7013+** careful use of indices.</dd>
7016+** <dd>^This is the number of sort operations that have occurred.
7017+** A non-zero value in this counter may indicate an opportunity to
7018+** improvement performance through careful use of indices.</dd>
7021+** <dd>^This is the number of rows inserted into transient indices that
7022+** were created automatically in order to help joins run faster.
7023+** A non-zero value in this counter may indicate an opportunity to
7024+** improvement performance by adding permanent indices that do not
7025+** need to be reinitialized each time the statement is run.</dd>
7028+** <dd>^This is the number of virtual machine operations executed
7029+** by the prepared statement if that number is less than or equal
7030+** to 2147483647. The number of virtual machine operations can be
7031+** used as a proxy for the total work done by the prepared statement.
7032+** If the number of virtual machine operations exceeds 2147483647
7033+** then the value returned by this statement status code is undefined.
7034+** </dd>
7035+** </dl>
7043+** CAPI3REF: Custom Page Cache Object
7045+** The sqlite3_pcache type is opaque. It is implemented by
7046+** the pluggable module. The SQLite core has no knowledge of
7047+** its size or internal structure and never deals with the
7048+** sqlite3_pcache object except by holding and passing pointers
7049+** to the object.
7051+** See [sqlite3_pcache_methods2] for additional information.
7053+typedef struct sqlite3_pcache sqlite3_pcache;
7056+** CAPI3REF: Custom Page Cache Object
7058+** The sqlite3_pcache_page object represents a single page in the
7059+** page cache. The page cache will allocate instances of this
7060+** object. Various methods of the page cache use pointers to instances
7061+** of this object as parameters or as their return value.
7063+** See [sqlite3_pcache_methods2] for additional information.
7065+typedef struct sqlite3_pcache_page sqlite3_pcache_page;
7066+struct sqlite3_pcache_page {
7067+ void *pBuf; /* The content of the page */
7068+ void *pExtra; /* Extra information associated with the page */
7072+** CAPI3REF: Application Defined Page Cache.
7073+** KEYWORDS: {page cache}
7075+** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE2], ...) interface can
7076+** register an alternative page cache implementation by passing in an
7077+** instance of the sqlite3_pcache_methods2 structure.)^
7078+** In many applications, most of the heap memory allocated by
7079+** SQLite is used for the page cache.
7080+** By implementing a
7081+** custom page cache using this API, an application can better control
7082+** the amount of memory consumed by SQLite, the way in which
7083+** that memory is allocated and released, and the policies used to
7084+** determine exactly which parts of a database file are cached and for
7085+** how long.
7087+** The alternative page cache mechanism is an
7088+** extreme measure that is only needed by the most demanding applications.
7089+** The built-in page cache is recommended for most uses.
7091+** ^(The contents of the sqlite3_pcache_methods2 structure are copied to an
7092+** internal buffer by SQLite within the call to [sqlite3_config]. Hence
7093+** the application may discard the parameter after the call to
7094+** [sqlite3_config()] returns.)^
7096+** [[the xInit() page cache method]]
7097+** ^(The xInit() method is called once for each effective
7098+** call to [sqlite3_initialize()])^
7099+** (usually only once during the lifetime of the process). ^(The xInit()
7100+** method is passed a copy of the sqlite3_pcache_methods2.pArg value.)^
7101+** The intent of the xInit() method is to set up global data structures
7102+** required by the custom page cache implementation.
7103+** ^(If the xInit() method is NULL, then the
7104+** built-in default page cache is used instead of the application defined
7105+** page cache.)^
7107+** [[the xShutdown() page cache method]]
7108+** ^The xShutdown() method is called by [sqlite3_shutdown()].
7109+** It can be used to clean up
7110+** any outstanding resources before process shutdown, if required.
7111+** ^The xShutdown() method may be NULL.
7113+** ^SQLite automatically serializes calls to the xInit method,
7114+** so the xInit method need not be threadsafe. ^The
7115+** xShutdown method is only called from [sqlite3_shutdown()] so it does
7116+** not need to be threadsafe either. All other methods must be threadsafe
7117+** in multithreaded applications.
7119+** ^SQLite will never invoke xInit() more than once without an intervening
7120+** call to xShutdown().
7122+** [[the xCreate() page cache methods]]
7123+** ^SQLite invokes the xCreate() method to construct a new cache instance.
7124+** SQLite will typically create one cache instance for each open database file,
7125+** though this is not guaranteed. ^The
7126+** first parameter, szPage, is the size in bytes of the pages that must
7127+** be allocated by the cache. ^szPage will always a power of two. ^The
7128+** second parameter szExtra is a number of bytes of extra storage
7129+** associated with each page cache entry. ^The szExtra parameter will
7130+** a number less than 250. SQLite will use the
7131+** extra szExtra bytes on each page to store metadata about the underlying
7132+** database page on disk. The value passed into szExtra depends
7133+** on the SQLite version, the target platform, and how SQLite was compiled.
7134+** ^The third argument to xCreate(), bPurgeable, is true if the cache being
7135+** created will be used to cache database pages of a file stored on disk, or
7136+** false if it is used for an in-memory database. The cache implementation
7137+** does not have to do anything special based with the value of bPurgeable;
7138+** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will
7139+** never invoke xUnpin() except to deliberately delete a page.
7140+** ^In other words, calls to xUnpin() on a cache with bPurgeable set to
7141+** false will always have the "discard" flag set to true.
7142+** ^Hence, a cache created with bPurgeable false will
7143+** never contain any unpinned pages.
7145+** [[the xCachesize() page cache method]]
7146+** ^(The xCachesize() method may be called at any time by SQLite to set the
7147+** suggested maximum cache-size (number of pages stored by) the cache
7148+** instance passed as the first argument. This is the value configured using
7149+** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable
7150+** parameter, the implementation is not required to do anything with this
7151+** value; it is advisory only.
7153+** [[the xPagecount() page cache methods]]
7154+** The xPagecount() method must return the number of pages currently
7155+** stored in the cache, both pinned and unpinned.
7157+** [[the xFetch() page cache methods]]
7158+** The xFetch() method locates a page in the cache and returns a pointer to
7159+** an sqlite3_pcache_page object associated with that page, or a NULL pointer.
7160+** The pBuf element of the returned sqlite3_pcache_page object will be a
7161+** pointer to a buffer of szPage bytes used to store the content of a
7162+** single database page. The pExtra element of sqlite3_pcache_page will be
7163+** a pointer to the szExtra bytes of extra storage that SQLite has requested
7164+** for each entry in the page cache.
7166+** The page to be fetched is determined by the key. ^The minimum key value
7167+** is 1. After it has been retrieved using xFetch, the page is considered
7168+** to be "pinned".
7170+** If the requested page is already in the page cache, then the page cache
7171+** implementation must return a pointer to the page buffer with its content
7172+** intact. If the requested page is not already in the cache, then the
7173+** cache implementation should use the value of the createFlag
7174+** parameter to help it determined what action to take:
7176+** <table border=1 width=85% align=center>
7177+** <tr><th> createFlag <th> Behavior when page is not already in cache
7178+** <tr><td> 0 <td> Do not allocate a new page. Return NULL.
7179+** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so.
7180+** Otherwise return NULL.
7181+** <tr><td> 2 <td> Make every effort to allocate a new page. Only return
7182+** NULL if allocating a new page is effectively impossible.
7183+** </table>
7185+** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite
7186+** will only use a createFlag of 2 after a prior call with a createFlag of 1
7187+** failed.)^ In between the to xFetch() calls, SQLite may
7188+** attempt to unpin one or more cache pages by spilling the content of
7189+** pinned pages to disk and synching the operating system disk cache.
7191+** [[the xUnpin() page cache method]]
7192+** ^xUnpin() is called by SQLite with a pointer to a currently pinned page
7193+** as its second argument. If the third parameter, discard, is non-zero,
7194+** then the page must be evicted from the cache.
7195+** ^If the discard parameter is
7196+** zero, then the page may be discarded or retained at the discretion of
7197+** page cache implementation. ^The page cache implementation
7198+** may choose to evict unpinned pages at any time.
7200+** The cache must not perform any reference counting. A single
7201+** call to xUnpin() unpins the page regardless of the number of prior calls
7202+** to xFetch().
7204+** [[the xRekey() page cache methods]]
7205+** The xRekey() method is used to change the key value associated with the
7206+** page passed as the second argument. If the cache
7207+** previously contains an entry associated with newKey, it must be
7208+** discarded. ^Any prior cache entry associated with newKey is guaranteed not
7209+** to be pinned.
7211+** When SQLite calls the xTruncate() method, the cache must discard all
7212+** existing cache entries with page numbers (keys) greater than or equal
7213+** to the value of the iLimit parameter passed to xTruncate(). If any
7214+** of these pages are pinned, they are implicitly unpinned, meaning that
7215+** they can be safely discarded.
7217+** [[the xDestroy() page cache method]]
7218+** ^The xDestroy() method is used to delete a cache allocated by xCreate().
7219+** All resources associated with the specified cache should be freed. ^After
7220+** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*]
7221+** handle invalid, and will not use it with any other sqlite3_pcache_methods2
7222+** functions.
7224+** [[the xShrink() page cache method]]
7225+** ^SQLite invokes the xShrink() method when it wants the page cache to
7226+** free up as much of heap memory as possible. The page cache implementation
7227+** is not obligated to free any memory, but well-behaved implementations should
7228+** do their best.
7230+typedef struct sqlite3_pcache_methods2 sqlite3_pcache_methods2;
7231+struct sqlite3_pcache_methods2 {
7232+ int iVersion;
7233+ void *pArg;
7234+ int (*xInit)(void*);
7235+ void (*xShutdown)(void*);
7236+ sqlite3_pcache *(*xCreate)(int szPage, int szExtra, int bPurgeable);
7237+ void (*xCachesize)(sqlite3_pcache*, int nCachesize);
7238+ int (*xPagecount)(sqlite3_pcache*);
7239+ sqlite3_pcache_page *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
7240+ void (*xUnpin)(sqlite3_pcache*, sqlite3_pcache_page*, int discard);
7241+ void (*xRekey)(sqlite3_pcache*, sqlite3_pcache_page*,
7242+ unsigned oldKey, unsigned newKey);
7243+ void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);
7244+ void (*xDestroy)(sqlite3_pcache*);
7245+ void (*xShrink)(sqlite3_pcache*);
7249+** This is the obsolete pcache_methods object that has now been replaced
7250+** by sqlite3_pcache_methods2. This object is not used by SQLite. It is
7251+** retained in the header file for backwards compatibility only.
7253+typedef struct sqlite3_pcache_methods sqlite3_pcache_methods;
7254+struct sqlite3_pcache_methods {
7255+ void *pArg;
7256+ int (*xInit)(void*);
7257+ void (*xShutdown)(void*);
7258+ sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable);
7259+ void (*xCachesize)(sqlite3_pcache*, int nCachesize);
7260+ int (*xPagecount)(sqlite3_pcache*);
7261+ void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
7262+ void (*xUnpin)(sqlite3_pcache*, void*, int discard);
7263+ void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey);
7264+ void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);
7265+ void (*xDestroy)(sqlite3_pcache*);
7270+** CAPI3REF: Online Backup Object
7272+** The sqlite3_backup object records state information about an ongoing
7273+** online backup operation. ^The sqlite3_backup object is created by
7274+** a call to [sqlite3_backup_init()] and is destroyed by a call to
7275+** [sqlite3_backup_finish()].
7277+** See Also: [Using the SQLite Online Backup API]
7279+typedef struct sqlite3_backup sqlite3_backup;
7282+** CAPI3REF: Online Backup API.
7284+** The backup API copies the content of one database into another.
7285+** It is useful either for creating backups of databases or
7286+** for copying in-memory databases to or from persistent files.
7288+** See Also: [Using the SQLite Online Backup API]
7290+** ^SQLite holds a write transaction open on the destination database file
7291+** for the duration of the backup operation.
7292+** ^The source database is read-locked only while it is being read;
7293+** it is not locked continuously for the entire backup operation.
7294+** ^Thus, the backup may be performed on a live source database without
7295+** preventing other database connections from
7296+** reading or writing to the source database while the backup is underway.
7298+** ^(To perform a backup operation:
7299+** <ol>
7300+** <li><b>sqlite3_backup_init()</b> is called once to initialize the
7301+** backup,
7302+** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer
7303+** the data between the two databases, and finally
7304+** <li><b>sqlite3_backup_finish()</b> is called to release all resources
7305+** associated with the backup operation.
7306+** </ol>)^
7307+** There should be exactly one call to sqlite3_backup_finish() for each
7308+** successful call to sqlite3_backup_init().
7310+** [[sqlite3_backup_init()]] <b>sqlite3_backup_init()</b>
7312+** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the
7313+** [database connection] associated with the destination database
7314+** and the database name, respectively.
7315+** ^The database name is "main" for the main database, "temp" for the
7316+** temporary database, or the name specified after the AS keyword in
7317+** an [ATTACH] statement for an attached database.
7318+** ^The S and M arguments passed to
7319+** sqlite3_backup_init(D,N,S,M) identify the [database connection]
7320+** and database name of the source database, respectively.
7321+** ^The source and destination [database connections] (parameters S and D)
7322+** must be different or else sqlite3_backup_init(D,N,S,M) will fail with
7323+** an error.
7325+** ^A call to sqlite3_backup_init() will fail, returning SQLITE_ERROR, if
7326+** there is already a read or read-write transaction open on the
7327+** destination database.
7329+** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is
7330+** returned and an error code and error message are stored in the
7331+** destination [database connection] D.
7332+** ^The error code and message for the failed call to sqlite3_backup_init()
7333+** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or
7334+** [sqlite3_errmsg16()] functions.
7335+** ^A successful call to sqlite3_backup_init() returns a pointer to an
7336+** [sqlite3_backup] object.
7337+** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and
7338+** sqlite3_backup_finish() functions to perform the specified backup
7339+** operation.
7341+** [[sqlite3_backup_step()]] <b>sqlite3_backup_step()</b>
7343+** ^Function sqlite3_backup_step(B,N) will copy up to N pages between
7344+** the source and destination databases specified by [sqlite3_backup] object B.
7345+** ^If N is negative, all remaining source pages are copied.
7346+** ^If sqlite3_backup_step(B,N) successfully copies N pages and there
7347+** are still more pages to be copied, then the function returns [SQLITE_OK].
7348+** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages
7349+** from source to destination, then it returns [SQLITE_DONE].
7350+** ^If an error occurs while running sqlite3_backup_step(B,N),
7351+** then an [error code] is returned. ^As well as [SQLITE_OK] and
7352+** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY],
7354+** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code.
7356+** ^(The sqlite3_backup_step() might return [SQLITE_READONLY] if
7357+** <ol>
7358+** <li> the destination database was opened read-only, or
7359+** <li> the destination database is using write-ahead-log journaling
7360+** and the destination and source page sizes differ, or
7361+** <li> the destination database is an in-memory database and the
7362+** destination and source page sizes differ.
7363+** </ol>)^
7365+** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then
7366+** the [sqlite3_busy_handler | busy-handler function]
7367+** is invoked (if one is specified). ^If the
7368+** busy-handler returns non-zero before the lock is available, then
7369+** [SQLITE_BUSY] is returned to the caller. ^In this case the call to
7370+** sqlite3_backup_step() can be retried later. ^If the source
7371+** [database connection]
7372+** is being used to write to the source database when sqlite3_backup_step()
7373+** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this
7374+** case the call to sqlite3_backup_step() can be retried later on. ^(If
7376+** [SQLITE_READONLY] is returned, then
7377+** there is no point in retrying the call to sqlite3_backup_step(). These
7378+** errors are considered fatal.)^ The application must accept
7379+** that the backup operation has failed and pass the backup operation handle
7380+** to the sqlite3_backup_finish() to release associated resources.
7382+** ^The first call to sqlite3_backup_step() obtains an exclusive lock
7383+** on the destination file. ^The exclusive lock is not released until either
7384+** sqlite3_backup_finish() is called or the backup operation is complete
7385+** and sqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to
7386+** sqlite3_backup_step() obtains a [shared lock] on the source database that
7387+** lasts for the duration of the sqlite3_backup_step() call.
7388+** ^Because the source database is not locked between calls to
7389+** sqlite3_backup_step(), the source database may be modified mid-way
7390+** through the backup process. ^If the source database is modified by an
7391+** external process or via a database connection other than the one being
7392+** used by the backup operation, then the backup will be automatically
7393+** restarted by the next call to sqlite3_backup_step(). ^If the source
7394+** database is modified by the using the same database connection as is used
7395+** by the backup operation, then the backup database is automatically
7396+** updated at the same time.
7398+** [[sqlite3_backup_finish()]] <b>sqlite3_backup_finish()</b>
7400+** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the
7401+** application wishes to abandon the backup operation, the application
7402+** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish().
7403+** ^The sqlite3_backup_finish() interfaces releases all
7404+** resources associated with the [sqlite3_backup] object.
7405+** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any
7406+** active write-transaction on the destination database is rolled back.
7407+** The [sqlite3_backup] object is invalid
7408+** and may not be used following a call to sqlite3_backup_finish().
7410+** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no
7411+** sqlite3_backup_step() errors occurred, regardless or whether or not
7412+** sqlite3_backup_step() completed.
7413+** ^If an out-of-memory condition or IO error occurred during any prior
7414+** sqlite3_backup_step() call on the same [sqlite3_backup] object, then
7415+** sqlite3_backup_finish() returns the corresponding [error code].
7417+** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step()
7418+** is not a permanent error and does not affect the return value of
7419+** sqlite3_backup_finish().
7421+** [[sqlite3_backup_remaining()]] [[sqlite3_backup_pagecount()]]
7422+** <b>sqlite3_backup_remaining() and sqlite3_backup_pagecount()</b>
7424+** ^The sqlite3_backup_remaining() routine returns the number of pages still
7425+** to be backed up at the conclusion of the most recent sqlite3_backup_step().
7426+** ^The sqlite3_backup_pagecount() routine returns the total number of pages
7427+** in the source database at the conclusion of the most recent
7428+** sqlite3_backup_step().
7429+** ^(The values returned by these functions are only updated by
7430+** sqlite3_backup_step(). If the source database is modified in a way that
7431+** changes the size of the source database or the number of pages remaining,
7432+** those changes are not reflected in the output of sqlite3_backup_pagecount()
7433+** and sqlite3_backup_remaining() until after the next
7434+** sqlite3_backup_step().)^