|
jpayne@69
|
1 /*
|
|
jpayne@69
|
2 ** 2001-09-15
|
|
jpayne@69
|
3 **
|
|
jpayne@69
|
4 ** The author disclaims copyright to this source code. In place of
|
|
jpayne@69
|
5 ** a legal notice, here is a blessing:
|
|
jpayne@69
|
6 **
|
|
jpayne@69
|
7 ** May you do good and not evil.
|
|
jpayne@69
|
8 ** May you find forgiveness for yourself and forgive others.
|
|
jpayne@69
|
9 ** May you share freely, never taking more than you give.
|
|
jpayne@69
|
10 **
|
|
jpayne@69
|
11 *************************************************************************
|
|
jpayne@69
|
12 ** This header file defines the interface that the SQLite library
|
|
jpayne@69
|
13 ** presents to client programs. If a C-function, structure, datatype,
|
|
jpayne@69
|
14 ** or constant definition does not appear in this file, then it is
|
|
jpayne@69
|
15 ** not a published API of SQLite, is subject to change without
|
|
jpayne@69
|
16 ** notice, and should not be referenced by programs that use SQLite.
|
|
jpayne@69
|
17 **
|
|
jpayne@69
|
18 ** Some of the definitions that are in this file are marked as
|
|
jpayne@69
|
19 ** "experimental". Experimental interfaces are normally new
|
|
jpayne@69
|
20 ** features recently added to SQLite. We do not anticipate changes
|
|
jpayne@69
|
21 ** to experimental interfaces but reserve the right to make minor changes
|
|
jpayne@69
|
22 ** if experience from use "in the wild" suggest such changes are prudent.
|
|
jpayne@69
|
23 **
|
|
jpayne@69
|
24 ** The official C-language API documentation for SQLite is derived
|
|
jpayne@69
|
25 ** from comments in this file. This file is the authoritative source
|
|
jpayne@69
|
26 ** on how SQLite interfaces are supposed to operate.
|
|
jpayne@69
|
27 **
|
|
jpayne@69
|
28 ** The name of this file under configuration management is "sqlite.h.in".
|
|
jpayne@69
|
29 ** The makefile makes some minor changes to this file (such as inserting
|
|
jpayne@69
|
30 ** the version number) and changes its name to "sqlite3.h" as
|
|
jpayne@69
|
31 ** part of the build process.
|
|
jpayne@69
|
32 */
|
|
jpayne@69
|
33 #ifndef SQLITE3_H
|
|
jpayne@69
|
34 #define SQLITE3_H
|
|
jpayne@69
|
35 #include <stdarg.h> /* Needed for the definition of va_list */
|
|
jpayne@69
|
36
|
|
jpayne@69
|
37 /*
|
|
jpayne@69
|
38 ** Make sure we can call this stuff from C++.
|
|
jpayne@69
|
39 */
|
|
jpayne@69
|
40 #ifdef __cplusplus
|
|
jpayne@69
|
41 extern "C" {
|
|
jpayne@69
|
42 #endif
|
|
jpayne@69
|
43
|
|
jpayne@69
|
44
|
|
jpayne@69
|
45 /*
|
|
jpayne@69
|
46 ** Facilitate override of interface linkage and calling conventions.
|
|
jpayne@69
|
47 ** Be aware that these macros may not be used within this particular
|
|
jpayne@69
|
48 ** translation of the amalgamation and its associated header file.
|
|
jpayne@69
|
49 **
|
|
jpayne@69
|
50 ** The SQLITE_EXTERN and SQLITE_API macros are used to instruct the
|
|
jpayne@69
|
51 ** compiler that the target identifier should have external linkage.
|
|
jpayne@69
|
52 **
|
|
jpayne@69
|
53 ** The SQLITE_CDECL macro is used to set the calling convention for
|
|
jpayne@69
|
54 ** public functions that accept a variable number of arguments.
|
|
jpayne@69
|
55 **
|
|
jpayne@69
|
56 ** The SQLITE_APICALL macro is used to set the calling convention for
|
|
jpayne@69
|
57 ** public functions that accept a fixed number of arguments.
|
|
jpayne@69
|
58 **
|
|
jpayne@69
|
59 ** The SQLITE_STDCALL macro is no longer used and is now deprecated.
|
|
jpayne@69
|
60 **
|
|
jpayne@69
|
61 ** The SQLITE_CALLBACK macro is used to set the calling convention for
|
|
jpayne@69
|
62 ** function pointers.
|
|
jpayne@69
|
63 **
|
|
jpayne@69
|
64 ** The SQLITE_SYSAPI macro is used to set the calling convention for
|
|
jpayne@69
|
65 ** functions provided by the operating system.
|
|
jpayne@69
|
66 **
|
|
jpayne@69
|
67 ** Currently, the SQLITE_CDECL, SQLITE_APICALL, SQLITE_CALLBACK, and
|
|
jpayne@69
|
68 ** SQLITE_SYSAPI macros are used only when building for environments
|
|
jpayne@69
|
69 ** that require non-default calling conventions.
|
|
jpayne@69
|
70 */
|
|
jpayne@69
|
71 #ifndef SQLITE_EXTERN
|
|
jpayne@69
|
72 # define SQLITE_EXTERN extern
|
|
jpayne@69
|
73 #endif
|
|
jpayne@69
|
74 #ifndef SQLITE_API
|
|
jpayne@69
|
75 # define SQLITE_API
|
|
jpayne@69
|
76 #endif
|
|
jpayne@69
|
77 #ifndef SQLITE_CDECL
|
|
jpayne@69
|
78 # define SQLITE_CDECL
|
|
jpayne@69
|
79 #endif
|
|
jpayne@69
|
80 #ifndef SQLITE_APICALL
|
|
jpayne@69
|
81 # define SQLITE_APICALL
|
|
jpayne@69
|
82 #endif
|
|
jpayne@69
|
83 #ifndef SQLITE_STDCALL
|
|
jpayne@69
|
84 # define SQLITE_STDCALL SQLITE_APICALL
|
|
jpayne@69
|
85 #endif
|
|
jpayne@69
|
86 #ifndef SQLITE_CALLBACK
|
|
jpayne@69
|
87 # define SQLITE_CALLBACK
|
|
jpayne@69
|
88 #endif
|
|
jpayne@69
|
89 #ifndef SQLITE_SYSAPI
|
|
jpayne@69
|
90 # define SQLITE_SYSAPI
|
|
jpayne@69
|
91 #endif
|
|
jpayne@69
|
92
|
|
jpayne@69
|
93 /*
|
|
jpayne@69
|
94 ** These no-op macros are used in front of interfaces to mark those
|
|
jpayne@69
|
95 ** interfaces as either deprecated or experimental. New applications
|
|
jpayne@69
|
96 ** should not use deprecated interfaces - they are supported for backwards
|
|
jpayne@69
|
97 ** compatibility only. Application writers should be aware that
|
|
jpayne@69
|
98 ** experimental interfaces are subject to change in point releases.
|
|
jpayne@69
|
99 **
|
|
jpayne@69
|
100 ** These macros used to resolve to various kinds of compiler magic that
|
|
jpayne@69
|
101 ** would generate warning messages when they were used. But that
|
|
jpayne@69
|
102 ** compiler magic ended up generating such a flurry of bug reports
|
|
jpayne@69
|
103 ** that we have taken it all out and gone back to using simple
|
|
jpayne@69
|
104 ** noop macros.
|
|
jpayne@69
|
105 */
|
|
jpayne@69
|
106 #define SQLITE_DEPRECATED
|
|
jpayne@69
|
107 #define SQLITE_EXPERIMENTAL
|
|
jpayne@69
|
108
|
|
jpayne@69
|
109 /*
|
|
jpayne@69
|
110 ** Ensure these symbols were not defined by some previous header file.
|
|
jpayne@69
|
111 */
|
|
jpayne@69
|
112 #ifdef SQLITE_VERSION
|
|
jpayne@69
|
113 # undef SQLITE_VERSION
|
|
jpayne@69
|
114 #endif
|
|
jpayne@69
|
115 #ifdef SQLITE_VERSION_NUMBER
|
|
jpayne@69
|
116 # undef SQLITE_VERSION_NUMBER
|
|
jpayne@69
|
117 #endif
|
|
jpayne@69
|
118
|
|
jpayne@69
|
119 /*
|
|
jpayne@69
|
120 ** CAPI3REF: Compile-Time Library Version Numbers
|
|
jpayne@69
|
121 **
|
|
jpayne@69
|
122 ** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header
|
|
jpayne@69
|
123 ** evaluates to a string literal that is the SQLite version in the
|
|
jpayne@69
|
124 ** format "X.Y.Z" where X is the major version number (always 3 for
|
|
jpayne@69
|
125 ** SQLite3) and Y is the minor version number and Z is the release number.)^
|
|
jpayne@69
|
126 ** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer
|
|
jpayne@69
|
127 ** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z are the same
|
|
jpayne@69
|
128 ** numbers used in [SQLITE_VERSION].)^
|
|
jpayne@69
|
129 ** The SQLITE_VERSION_NUMBER for any given release of SQLite will also
|
|
jpayne@69
|
130 ** be larger than the release from which it is derived. Either Y will
|
|
jpayne@69
|
131 ** be held constant and Z will be incremented or else Y will be incremented
|
|
jpayne@69
|
132 ** and Z will be reset to zero.
|
|
jpayne@69
|
133 **
|
|
jpayne@69
|
134 ** Since [version 3.6.18] ([dateof:3.6.18]),
|
|
jpayne@69
|
135 ** SQLite source code has been stored in the
|
|
jpayne@69
|
136 ** <a href="http://www.fossil-scm.org/">Fossil configuration management
|
|
jpayne@69
|
137 ** system</a>. ^The SQLITE_SOURCE_ID macro evaluates to
|
|
jpayne@69
|
138 ** a string which identifies a particular check-in of SQLite
|
|
jpayne@69
|
139 ** within its configuration management system. ^The SQLITE_SOURCE_ID
|
|
jpayne@69
|
140 ** string contains the date and time of the check-in (UTC) and a SHA1
|
|
jpayne@69
|
141 ** or SHA3-256 hash of the entire source tree. If the source code has
|
|
jpayne@69
|
142 ** been edited in any way since it was last checked in, then the last
|
|
jpayne@69
|
143 ** four hexadecimal digits of the hash may be modified.
|
|
jpayne@69
|
144 **
|
|
jpayne@69
|
145 ** See also: [sqlite3_libversion()],
|
|
jpayne@69
|
146 ** [sqlite3_libversion_number()], [sqlite3_sourceid()],
|
|
jpayne@69
|
147 ** [sqlite_version()] and [sqlite_source_id()].
|
|
jpayne@69
|
148 */
|
|
jpayne@69
|
149 #define SQLITE_VERSION "3.46.0"
|
|
jpayne@69
|
150 #define SQLITE_VERSION_NUMBER 3046000
|
|
jpayne@69
|
151 #define SQLITE_SOURCE_ID "2024-05-23 13:25:27 96c92aba00c8375bc32fafcdf12429c58bd8aabfcadab6683e35bbb9cdebf19e"
|
|
jpayne@69
|
152
|
|
jpayne@69
|
153 /*
|
|
jpayne@69
|
154 ** CAPI3REF: Run-Time Library Version Numbers
|
|
jpayne@69
|
155 ** KEYWORDS: sqlite3_version sqlite3_sourceid
|
|
jpayne@69
|
156 **
|
|
jpayne@69
|
157 ** These interfaces provide the same information as the [SQLITE_VERSION],
|
|
jpayne@69
|
158 ** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros
|
|
jpayne@69
|
159 ** but are associated with the library instead of the header file. ^(Cautious
|
|
jpayne@69
|
160 ** programmers might include assert() statements in their application to
|
|
jpayne@69
|
161 ** verify that values returned by these interfaces match the macros in
|
|
jpayne@69
|
162 ** the header, and thus ensure that the application is
|
|
jpayne@69
|
163 ** compiled with matching library and header files.
|
|
jpayne@69
|
164 **
|
|
jpayne@69
|
165 ** <blockquote><pre>
|
|
jpayne@69
|
166 ** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER );
|
|
jpayne@69
|
167 ** assert( strncmp(sqlite3_sourceid(),SQLITE_SOURCE_ID,80)==0 );
|
|
jpayne@69
|
168 ** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 );
|
|
jpayne@69
|
169 ** </pre></blockquote>)^
|
|
jpayne@69
|
170 **
|
|
jpayne@69
|
171 ** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION]
|
|
jpayne@69
|
172 ** macro. ^The sqlite3_libversion() function returns a pointer to the
|
|
jpayne@69
|
173 ** to the sqlite3_version[] string constant. The sqlite3_libversion()
|
|
jpayne@69
|
174 ** function is provided for use in DLLs since DLL users usually do not have
|
|
jpayne@69
|
175 ** direct access to string constants within the DLL. ^The
|
|
jpayne@69
|
176 ** sqlite3_libversion_number() function returns an integer equal to
|
|
jpayne@69
|
177 ** [SQLITE_VERSION_NUMBER]. ^(The sqlite3_sourceid() function returns
|
|
jpayne@69
|
178 ** a pointer to a string constant whose value is the same as the
|
|
jpayne@69
|
179 ** [SQLITE_SOURCE_ID] C preprocessor macro. Except if SQLite is built
|
|
jpayne@69
|
180 ** using an edited copy of [the amalgamation], then the last four characters
|
|
jpayne@69
|
181 ** of the hash might be different from [SQLITE_SOURCE_ID].)^
|
|
jpayne@69
|
182 **
|
|
jpayne@69
|
183 ** See also: [sqlite_version()] and [sqlite_source_id()].
|
|
jpayne@69
|
184 */
|
|
jpayne@69
|
185 SQLITE_API SQLITE_EXTERN const char sqlite3_version[];
|
|
jpayne@69
|
186 SQLITE_API const char *sqlite3_libversion(void);
|
|
jpayne@69
|
187 SQLITE_API const char *sqlite3_sourceid(void);
|
|
jpayne@69
|
188 SQLITE_API int sqlite3_libversion_number(void);
|
|
jpayne@69
|
189
|
|
jpayne@69
|
190 /*
|
|
jpayne@69
|
191 ** CAPI3REF: Run-Time Library Compilation Options Diagnostics
|
|
jpayne@69
|
192 **
|
|
jpayne@69
|
193 ** ^The sqlite3_compileoption_used() function returns 0 or 1
|
|
jpayne@69
|
194 ** indicating whether the specified option was defined at
|
|
jpayne@69
|
195 ** compile time. ^The SQLITE_ prefix may be omitted from the
|
|
jpayne@69
|
196 ** option name passed to sqlite3_compileoption_used().
|
|
jpayne@69
|
197 **
|
|
jpayne@69
|
198 ** ^The sqlite3_compileoption_get() function allows iterating
|
|
jpayne@69
|
199 ** over the list of options that were defined at compile time by
|
|
jpayne@69
|
200 ** returning the N-th compile time option string. ^If N is out of range,
|
|
jpayne@69
|
201 ** sqlite3_compileoption_get() returns a NULL pointer. ^The SQLITE_
|
|
jpayne@69
|
202 ** prefix is omitted from any strings returned by
|
|
jpayne@69
|
203 ** sqlite3_compileoption_get().
|
|
jpayne@69
|
204 **
|
|
jpayne@69
|
205 ** ^Support for the diagnostic functions sqlite3_compileoption_used()
|
|
jpayne@69
|
206 ** and sqlite3_compileoption_get() may be omitted by specifying the
|
|
jpayne@69
|
207 ** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time.
|
|
jpayne@69
|
208 **
|
|
jpayne@69
|
209 ** See also: SQL functions [sqlite_compileoption_used()] and
|
|
jpayne@69
|
210 ** [sqlite_compileoption_get()] and the [compile_options pragma].
|
|
jpayne@69
|
211 */
|
|
jpayne@69
|
212 #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
|
|
jpayne@69
|
213 SQLITE_API int sqlite3_compileoption_used(const char *zOptName);
|
|
jpayne@69
|
214 SQLITE_API const char *sqlite3_compileoption_get(int N);
|
|
jpayne@69
|
215 #else
|
|
jpayne@69
|
216 # define sqlite3_compileoption_used(X) 0
|
|
jpayne@69
|
217 # define sqlite3_compileoption_get(X) ((void*)0)
|
|
jpayne@69
|
218 #endif
|
|
jpayne@69
|
219
|
|
jpayne@69
|
220 /*
|
|
jpayne@69
|
221 ** CAPI3REF: Test To See If The Library Is Threadsafe
|
|
jpayne@69
|
222 **
|
|
jpayne@69
|
223 ** ^The sqlite3_threadsafe() function returns zero if and only if
|
|
jpayne@69
|
224 ** SQLite was compiled with mutexing code omitted due to the
|
|
jpayne@69
|
225 ** [SQLITE_THREADSAFE] compile-time option being set to 0.
|
|
jpayne@69
|
226 **
|
|
jpayne@69
|
227 ** SQLite can be compiled with or without mutexes. When
|
|
jpayne@69
|
228 ** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes
|
|
jpayne@69
|
229 ** are enabled and SQLite is threadsafe. When the
|
|
jpayne@69
|
230 ** [SQLITE_THREADSAFE] macro is 0,
|
|
jpayne@69
|
231 ** the mutexes are omitted. Without the mutexes, it is not safe
|
|
jpayne@69
|
232 ** to use SQLite concurrently from more than one thread.
|
|
jpayne@69
|
233 **
|
|
jpayne@69
|
234 ** Enabling mutexes incurs a measurable performance penalty.
|
|
jpayne@69
|
235 ** So if speed is of utmost importance, it makes sense to disable
|
|
jpayne@69
|
236 ** the mutexes. But for maximum safety, mutexes should be enabled.
|
|
jpayne@69
|
237 ** ^The default behavior is for mutexes to be enabled.
|
|
jpayne@69
|
238 **
|
|
jpayne@69
|
239 ** This interface can be used by an application to make sure that the
|
|
jpayne@69
|
240 ** version of SQLite that it is linking against was compiled with
|
|
jpayne@69
|
241 ** the desired setting of the [SQLITE_THREADSAFE] macro.
|
|
jpayne@69
|
242 **
|
|
jpayne@69
|
243 ** This interface only reports on the compile-time mutex setting
|
|
jpayne@69
|
244 ** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with
|
|
jpayne@69
|
245 ** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but
|
|
jpayne@69
|
246 ** can be fully or partially disabled using a call to [sqlite3_config()]
|
|
jpayne@69
|
247 ** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD],
|
|
jpayne@69
|
248 ** or [SQLITE_CONFIG_SERIALIZED]. ^(The return value of the
|
|
jpayne@69
|
249 ** sqlite3_threadsafe() function shows only the compile-time setting of
|
|
jpayne@69
|
250 ** thread safety, not any run-time changes to that setting made by
|
|
jpayne@69
|
251 ** sqlite3_config(). In other words, the return value from sqlite3_threadsafe()
|
|
jpayne@69
|
252 ** is unchanged by calls to sqlite3_config().)^
|
|
jpayne@69
|
253 **
|
|
jpayne@69
|
254 ** See the [threading mode] documentation for additional information.
|
|
jpayne@69
|
255 */
|
|
jpayne@69
|
256 SQLITE_API int sqlite3_threadsafe(void);
|
|
jpayne@69
|
257
|
|
jpayne@69
|
258 /*
|
|
jpayne@69
|
259 ** CAPI3REF: Database Connection Handle
|
|
jpayne@69
|
260 ** KEYWORDS: {database connection} {database connections}
|
|
jpayne@69
|
261 **
|
|
jpayne@69
|
262 ** Each open SQLite database is represented by a pointer to an instance of
|
|
jpayne@69
|
263 ** the opaque structure named "sqlite3". It is useful to think of an sqlite3
|
|
jpayne@69
|
264 ** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and
|
|
jpayne@69
|
265 ** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()]
|
|
jpayne@69
|
266 ** and [sqlite3_close_v2()] are its destructors. There are many other
|
|
jpayne@69
|
267 ** interfaces (such as
|
|
jpayne@69
|
268 ** [sqlite3_prepare_v2()], [sqlite3_create_function()], and
|
|
jpayne@69
|
269 ** [sqlite3_busy_timeout()] to name but three) that are methods on an
|
|
jpayne@69
|
270 ** sqlite3 object.
|
|
jpayne@69
|
271 */
|
|
jpayne@69
|
272 typedef struct sqlite3 sqlite3;
|
|
jpayne@69
|
273
|
|
jpayne@69
|
274 /*
|
|
jpayne@69
|
275 ** CAPI3REF: 64-Bit Integer Types
|
|
jpayne@69
|
276 ** KEYWORDS: sqlite_int64 sqlite_uint64
|
|
jpayne@69
|
277 **
|
|
jpayne@69
|
278 ** Because there is no cross-platform way to specify 64-bit integer types
|
|
jpayne@69
|
279 ** SQLite includes typedefs for 64-bit signed and unsigned integers.
|
|
jpayne@69
|
280 **
|
|
jpayne@69
|
281 ** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions.
|
|
jpayne@69
|
282 ** The sqlite_int64 and sqlite_uint64 types are supported for backwards
|
|
jpayne@69
|
283 ** compatibility only.
|
|
jpayne@69
|
284 **
|
|
jpayne@69
|
285 ** ^The sqlite3_int64 and sqlite_int64 types can store integer values
|
|
jpayne@69
|
286 ** between -9223372036854775808 and +9223372036854775807 inclusive. ^The
|
|
jpayne@69
|
287 ** sqlite3_uint64 and sqlite_uint64 types can store integer values
|
|
jpayne@69
|
288 ** between 0 and +18446744073709551615 inclusive.
|
|
jpayne@69
|
289 */
|
|
jpayne@69
|
290 #ifdef SQLITE_INT64_TYPE
|
|
jpayne@69
|
291 typedef SQLITE_INT64_TYPE sqlite_int64;
|
|
jpayne@69
|
292 # ifdef SQLITE_UINT64_TYPE
|
|
jpayne@69
|
293 typedef SQLITE_UINT64_TYPE sqlite_uint64;
|
|
jpayne@69
|
294 # else
|
|
jpayne@69
|
295 typedef unsigned SQLITE_INT64_TYPE sqlite_uint64;
|
|
jpayne@69
|
296 # endif
|
|
jpayne@69
|
297 #elif defined(_MSC_VER) || defined(__BORLANDC__)
|
|
jpayne@69
|
298 typedef __int64 sqlite_int64;
|
|
jpayne@69
|
299 typedef unsigned __int64 sqlite_uint64;
|
|
jpayne@69
|
300 #else
|
|
jpayne@69
|
301 typedef long long int sqlite_int64;
|
|
jpayne@69
|
302 typedef unsigned long long int sqlite_uint64;
|
|
jpayne@69
|
303 #endif
|
|
jpayne@69
|
304 typedef sqlite_int64 sqlite3_int64;
|
|
jpayne@69
|
305 typedef sqlite_uint64 sqlite3_uint64;
|
|
jpayne@69
|
306
|
|
jpayne@69
|
307 /*
|
|
jpayne@69
|
308 ** If compiling for a processor that lacks floating point support,
|
|
jpayne@69
|
309 ** substitute integer for floating-point.
|
|
jpayne@69
|
310 */
|
|
jpayne@69
|
311 #ifdef SQLITE_OMIT_FLOATING_POINT
|
|
jpayne@69
|
312 # define double sqlite3_int64
|
|
jpayne@69
|
313 #endif
|
|
jpayne@69
|
314
|
|
jpayne@69
|
315 /*
|
|
jpayne@69
|
316 ** CAPI3REF: Closing A Database Connection
|
|
jpayne@69
|
317 ** DESTRUCTOR: sqlite3
|
|
jpayne@69
|
318 **
|
|
jpayne@69
|
319 ** ^The sqlite3_close() and sqlite3_close_v2() routines are destructors
|
|
jpayne@69
|
320 ** for the [sqlite3] object.
|
|
jpayne@69
|
321 ** ^Calls to sqlite3_close() and sqlite3_close_v2() return [SQLITE_OK] if
|
|
jpayne@69
|
322 ** the [sqlite3] object is successfully destroyed and all associated
|
|
jpayne@69
|
323 ** resources are deallocated.
|
|
jpayne@69
|
324 **
|
|
jpayne@69
|
325 ** Ideally, applications should [sqlite3_finalize | finalize] all
|
|
jpayne@69
|
326 ** [prepared statements], [sqlite3_blob_close | close] all [BLOB handles], and
|
|
jpayne@69
|
327 ** [sqlite3_backup_finish | finish] all [sqlite3_backup] objects associated
|
|
jpayne@69
|
328 ** with the [sqlite3] object prior to attempting to close the object.
|
|
jpayne@69
|
329 ** ^If the database connection is associated with unfinalized prepared
|
|
jpayne@69
|
330 ** statements, BLOB handlers, and/or unfinished sqlite3_backup objects then
|
|
jpayne@69
|
331 ** sqlite3_close() will leave the database connection open and return
|
|
jpayne@69
|
332 ** [SQLITE_BUSY]. ^If sqlite3_close_v2() is called with unfinalized prepared
|
|
jpayne@69
|
333 ** statements, unclosed BLOB handlers, and/or unfinished sqlite3_backups,
|
|
jpayne@69
|
334 ** it returns [SQLITE_OK] regardless, but instead of deallocating the database
|
|
jpayne@69
|
335 ** connection immediately, it marks the database connection as an unusable
|
|
jpayne@69
|
336 ** "zombie" and makes arrangements to automatically deallocate the database
|
|
jpayne@69
|
337 ** connection after all prepared statements are finalized, all BLOB handles
|
|
jpayne@69
|
338 ** are closed, and all backups have finished. The sqlite3_close_v2() interface
|
|
jpayne@69
|
339 ** is intended for use with host languages that are garbage collected, and
|
|
jpayne@69
|
340 ** where the order in which destructors are called is arbitrary.
|
|
jpayne@69
|
341 **
|
|
jpayne@69
|
342 ** ^If an [sqlite3] object is destroyed while a transaction is open,
|
|
jpayne@69
|
343 ** the transaction is automatically rolled back.
|
|
jpayne@69
|
344 **
|
|
jpayne@69
|
345 ** The C parameter to [sqlite3_close(C)] and [sqlite3_close_v2(C)]
|
|
jpayne@69
|
346 ** must be either a NULL
|
|
jpayne@69
|
347 ** pointer or an [sqlite3] object pointer obtained
|
|
jpayne@69
|
348 ** from [sqlite3_open()], [sqlite3_open16()], or
|
|
jpayne@69
|
349 ** [sqlite3_open_v2()], and not previously closed.
|
|
jpayne@69
|
350 ** ^Calling sqlite3_close() or sqlite3_close_v2() with a NULL pointer
|
|
jpayne@69
|
351 ** argument is a harmless no-op.
|
|
jpayne@69
|
352 */
|
|
jpayne@69
|
353 SQLITE_API int sqlite3_close(sqlite3*);
|
|
jpayne@69
|
354 SQLITE_API int sqlite3_close_v2(sqlite3*);
|
|
jpayne@69
|
355
|
|
jpayne@69
|
356 /*
|
|
jpayne@69
|
357 ** The type for a callback function.
|
|
jpayne@69
|
358 ** This is legacy and deprecated. It is included for historical
|
|
jpayne@69
|
359 ** compatibility and is not documented.
|
|
jpayne@69
|
360 */
|
|
jpayne@69
|
361 typedef int (*sqlite3_callback)(void*,int,char**, char**);
|
|
jpayne@69
|
362
|
|
jpayne@69
|
363 /*
|
|
jpayne@69
|
364 ** CAPI3REF: One-Step Query Execution Interface
|
|
jpayne@69
|
365 ** METHOD: sqlite3
|
|
jpayne@69
|
366 **
|
|
jpayne@69
|
367 ** The sqlite3_exec() interface is a convenience wrapper around
|
|
jpayne@69
|
368 ** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()],
|
|
jpayne@69
|
369 ** that allows an application to run multiple statements of SQL
|
|
jpayne@69
|
370 ** without having to use a lot of C code.
|
|
jpayne@69
|
371 **
|
|
jpayne@69
|
372 ** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded,
|
|
jpayne@69
|
373 ** semicolon-separate SQL statements passed into its 2nd argument,
|
|
jpayne@69
|
374 ** in the context of the [database connection] passed in as its 1st
|
|
jpayne@69
|
375 ** argument. ^If the callback function of the 3rd argument to
|
|
jpayne@69
|
376 ** sqlite3_exec() is not NULL, then it is invoked for each result row
|
|
jpayne@69
|
377 ** coming out of the evaluated SQL statements. ^The 4th argument to
|
|
jpayne@69
|
378 ** sqlite3_exec() is relayed through to the 1st argument of each
|
|
jpayne@69
|
379 ** callback invocation. ^If the callback pointer to sqlite3_exec()
|
|
jpayne@69
|
380 ** is NULL, then no callback is ever invoked and result rows are
|
|
jpayne@69
|
381 ** ignored.
|
|
jpayne@69
|
382 **
|
|
jpayne@69
|
383 ** ^If an error occurs while evaluating the SQL statements passed into
|
|
jpayne@69
|
384 ** sqlite3_exec(), then execution of the current statement stops and
|
|
jpayne@69
|
385 ** subsequent statements are skipped. ^If the 5th parameter to sqlite3_exec()
|
|
jpayne@69
|
386 ** is not NULL then any error message is written into memory obtained
|
|
jpayne@69
|
387 ** from [sqlite3_malloc()] and passed back through the 5th parameter.
|
|
jpayne@69
|
388 ** To avoid memory leaks, the application should invoke [sqlite3_free()]
|
|
jpayne@69
|
389 ** on error message strings returned through the 5th parameter of
|
|
jpayne@69
|
390 ** sqlite3_exec() after the error message string is no longer needed.
|
|
jpayne@69
|
391 ** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors
|
|
jpayne@69
|
392 ** occur, then sqlite3_exec() sets the pointer in its 5th parameter to
|
|
jpayne@69
|
393 ** NULL before returning.
|
|
jpayne@69
|
394 **
|
|
jpayne@69
|
395 ** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec()
|
|
jpayne@69
|
396 ** routine returns SQLITE_ABORT without invoking the callback again and
|
|
jpayne@69
|
397 ** without running any subsequent SQL statements.
|
|
jpayne@69
|
398 **
|
|
jpayne@69
|
399 ** ^The 2nd argument to the sqlite3_exec() callback function is the
|
|
jpayne@69
|
400 ** number of columns in the result. ^The 3rd argument to the sqlite3_exec()
|
|
jpayne@69
|
401 ** callback is an array of pointers to strings obtained as if from
|
|
jpayne@69
|
402 ** [sqlite3_column_text()], one for each column. ^If an element of a
|
|
jpayne@69
|
403 ** result row is NULL then the corresponding string pointer for the
|
|
jpayne@69
|
404 ** sqlite3_exec() callback is a NULL pointer. ^The 4th argument to the
|
|
jpayne@69
|
405 ** sqlite3_exec() callback is an array of pointers to strings where each
|
|
jpayne@69
|
406 ** entry represents the name of corresponding result column as obtained
|
|
jpayne@69
|
407 ** from [sqlite3_column_name()].
|
|
jpayne@69
|
408 **
|
|
jpayne@69
|
409 ** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer
|
|
jpayne@69
|
410 ** to an empty string, or a pointer that contains only whitespace and/or
|
|
jpayne@69
|
411 ** SQL comments, then no SQL statements are evaluated and the database
|
|
jpayne@69
|
412 ** is not changed.
|
|
jpayne@69
|
413 **
|
|
jpayne@69
|
414 ** Restrictions:
|
|
jpayne@69
|
415 **
|
|
jpayne@69
|
416 ** <ul>
|
|
jpayne@69
|
417 ** <li> The application must ensure that the 1st parameter to sqlite3_exec()
|
|
jpayne@69
|
418 ** is a valid and open [database connection].
|
|
jpayne@69
|
419 ** <li> The application must not close the [database connection] specified by
|
|
jpayne@69
|
420 ** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running.
|
|
jpayne@69
|
421 ** <li> The application must not modify the SQL statement text passed into
|
|
jpayne@69
|
422 ** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running.
|
|
jpayne@69
|
423 ** <li> The application must not dereference the arrays or string pointers
|
|
jpayne@69
|
424 ** passed as the 3rd and 4th callback parameters after it returns.
|
|
jpayne@69
|
425 ** </ul>
|
|
jpayne@69
|
426 */
|
|
jpayne@69
|
427 SQLITE_API int sqlite3_exec(
|
|
jpayne@69
|
428 sqlite3*, /* An open database */
|
|
jpayne@69
|
429 const char *sql, /* SQL to be evaluated */
|
|
jpayne@69
|
430 int (*callback)(void*,int,char**,char**), /* Callback function */
|
|
jpayne@69
|
431 void *, /* 1st argument to callback */
|
|
jpayne@69
|
432 char **errmsg /* Error msg written here */
|
|
jpayne@69
|
433 );
|
|
jpayne@69
|
434
|
|
jpayne@69
|
435 /*
|
|
jpayne@69
|
436 ** CAPI3REF: Result Codes
|
|
jpayne@69
|
437 ** KEYWORDS: {result code definitions}
|
|
jpayne@69
|
438 **
|
|
jpayne@69
|
439 ** Many SQLite functions return an integer result code from the set shown
|
|
jpayne@69
|
440 ** here in order to indicate success or failure.
|
|
jpayne@69
|
441 **
|
|
jpayne@69
|
442 ** New error codes may be added in future versions of SQLite.
|
|
jpayne@69
|
443 **
|
|
jpayne@69
|
444 ** See also: [extended result code definitions]
|
|
jpayne@69
|
445 */
|
|
jpayne@69
|
446 #define SQLITE_OK 0 /* Successful result */
|
|
jpayne@69
|
447 /* beginning-of-error-codes */
|
|
jpayne@69
|
448 #define SQLITE_ERROR 1 /* Generic error */
|
|
jpayne@69
|
449 #define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */
|
|
jpayne@69
|
450 #define SQLITE_PERM 3 /* Access permission denied */
|
|
jpayne@69
|
451 #define SQLITE_ABORT 4 /* Callback routine requested an abort */
|
|
jpayne@69
|
452 #define SQLITE_BUSY 5 /* The database file is locked */
|
|
jpayne@69
|
453 #define SQLITE_LOCKED 6 /* A table in the database is locked */
|
|
jpayne@69
|
454 #define SQLITE_NOMEM 7 /* A malloc() failed */
|
|
jpayne@69
|
455 #define SQLITE_READONLY 8 /* Attempt to write a readonly database */
|
|
jpayne@69
|
456 #define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/
|
|
jpayne@69
|
457 #define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */
|
|
jpayne@69
|
458 #define SQLITE_CORRUPT 11 /* The database disk image is malformed */
|
|
jpayne@69
|
459 #define SQLITE_NOTFOUND 12 /* Unknown opcode in sqlite3_file_control() */
|
|
jpayne@69
|
460 #define SQLITE_FULL 13 /* Insertion failed because database is full */
|
|
jpayne@69
|
461 #define SQLITE_CANTOPEN 14 /* Unable to open the database file */
|
|
jpayne@69
|
462 #define SQLITE_PROTOCOL 15 /* Database lock protocol error */
|
|
jpayne@69
|
463 #define SQLITE_EMPTY 16 /* Internal use only */
|
|
jpayne@69
|
464 #define SQLITE_SCHEMA 17 /* The database schema changed */
|
|
jpayne@69
|
465 #define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */
|
|
jpayne@69
|
466 #define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */
|
|
jpayne@69
|
467 #define SQLITE_MISMATCH 20 /* Data type mismatch */
|
|
jpayne@69
|
468 #define SQLITE_MISUSE 21 /* Library used incorrectly */
|
|
jpayne@69
|
469 #define SQLITE_NOLFS 22 /* Uses OS features not supported on host */
|
|
jpayne@69
|
470 #define SQLITE_AUTH 23 /* Authorization denied */
|
|
jpayne@69
|
471 #define SQLITE_FORMAT 24 /* Not used */
|
|
jpayne@69
|
472 #define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */
|
|
jpayne@69
|
473 #define SQLITE_NOTADB 26 /* File opened that is not a database file */
|
|
jpayne@69
|
474 #define SQLITE_NOTICE 27 /* Notifications from sqlite3_log() */
|
|
jpayne@69
|
475 #define SQLITE_WARNING 28 /* Warnings from sqlite3_log() */
|
|
jpayne@69
|
476 #define SQLITE_ROW 100 /* sqlite3_step() has another row ready */
|
|
jpayne@69
|
477 #define SQLITE_DONE 101 /* sqlite3_step() has finished executing */
|
|
jpayne@69
|
478 /* end-of-error-codes */
|
|
jpayne@69
|
479
|
|
jpayne@69
|
480 /*
|
|
jpayne@69
|
481 ** CAPI3REF: Extended Result Codes
|
|
jpayne@69
|
482 ** KEYWORDS: {extended result code definitions}
|
|
jpayne@69
|
483 **
|
|
jpayne@69
|
484 ** In its default configuration, SQLite API routines return one of 30 integer
|
|
jpayne@69
|
485 ** [result codes]. However, experience has shown that many of
|
|
jpayne@69
|
486 ** these result codes are too coarse-grained. They do not provide as
|
|
jpayne@69
|
487 ** much information about problems as programmers might like. In an effort to
|
|
jpayne@69
|
488 ** address this, newer versions of SQLite (version 3.3.8 [dateof:3.3.8]
|
|
jpayne@69
|
489 ** and later) include
|
|
jpayne@69
|
490 ** support for additional result codes that provide more detailed information
|
|
jpayne@69
|
491 ** about errors. These [extended result codes] are enabled or disabled
|
|
jpayne@69
|
492 ** on a per database connection basis using the
|
|
jpayne@69
|
493 ** [sqlite3_extended_result_codes()] API. Or, the extended code for
|
|
jpayne@69
|
494 ** the most recent error can be obtained using
|
|
jpayne@69
|
495 ** [sqlite3_extended_errcode()].
|
|
jpayne@69
|
496 */
|
|
jpayne@69
|
497 #define SQLITE_ERROR_MISSING_COLLSEQ (SQLITE_ERROR | (1<<8))
|
|
jpayne@69
|
498 #define SQLITE_ERROR_RETRY (SQLITE_ERROR | (2<<8))
|
|
jpayne@69
|
499 #define SQLITE_ERROR_SNAPSHOT (SQLITE_ERROR | (3<<8))
|
|
jpayne@69
|
500 #define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8))
|
|
jpayne@69
|
501 #define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8))
|
|
jpayne@69
|
502 #define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8))
|
|
jpayne@69
|
503 #define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8))
|
|
jpayne@69
|
504 #define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8))
|
|
jpayne@69
|
505 #define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8))
|
|
jpayne@69
|
506 #define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8))
|
|
jpayne@69
|
507 #define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8))
|
|
jpayne@69
|
508 #define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8))
|
|
jpayne@69
|
509 #define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8))
|
|
jpayne@69
|
510 #define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8))
|
|
jpayne@69
|
511 #define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8))
|
|
jpayne@69
|
512 #define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8))
|
|
jpayne@69
|
513 #define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8))
|
|
jpayne@69
|
514 #define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8))
|
|
jpayne@69
|
515 #define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8))
|
|
jpayne@69
|
516 #define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8))
|
|
jpayne@69
|
517 #define SQLITE_IOERR_SHMOPEN (SQLITE_IOERR | (18<<8))
|
|
jpayne@69
|
518 #define SQLITE_IOERR_SHMSIZE (SQLITE_IOERR | (19<<8))
|
|
jpayne@69
|
519 #define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR | (20<<8))
|
|
jpayne@69
|
520 #define SQLITE_IOERR_SHMMAP (SQLITE_IOERR | (21<<8))
|
|
jpayne@69
|
521 #define SQLITE_IOERR_SEEK (SQLITE_IOERR | (22<<8))
|
|
jpayne@69
|
522 #define SQLITE_IOERR_DELETE_NOENT (SQLITE_IOERR | (23<<8))
|
|
jpayne@69
|
523 #define SQLITE_IOERR_MMAP (SQLITE_IOERR | (24<<8))
|
|
jpayne@69
|
524 #define SQLITE_IOERR_GETTEMPPATH (SQLITE_IOERR | (25<<8))
|
|
jpayne@69
|
525 #define SQLITE_IOERR_CONVPATH (SQLITE_IOERR | (26<<8))
|
|
jpayne@69
|
526 #define SQLITE_IOERR_VNODE (SQLITE_IOERR | (27<<8))
|
|
jpayne@69
|
527 #define SQLITE_IOERR_AUTH (SQLITE_IOERR | (28<<8))
|
|
jpayne@69
|
528 #define SQLITE_IOERR_BEGIN_ATOMIC (SQLITE_IOERR | (29<<8))
|
|
jpayne@69
|
529 #define SQLITE_IOERR_COMMIT_ATOMIC (SQLITE_IOERR | (30<<8))
|
|
jpayne@69
|
530 #define SQLITE_IOERR_ROLLBACK_ATOMIC (SQLITE_IOERR | (31<<8))
|
|
jpayne@69
|
531 #define SQLITE_IOERR_DATA (SQLITE_IOERR | (32<<8))
|
|
jpayne@69
|
532 #define SQLITE_IOERR_CORRUPTFS (SQLITE_IOERR | (33<<8))
|
|
jpayne@69
|
533 #define SQLITE_IOERR_IN_PAGE (SQLITE_IOERR | (34<<8))
|
|
jpayne@69
|
534 #define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8))
|
|
jpayne@69
|
535 #define SQLITE_LOCKED_VTAB (SQLITE_LOCKED | (2<<8))
|
|
jpayne@69
|
536 #define SQLITE_BUSY_RECOVERY (SQLITE_BUSY | (1<<8))
|
|
jpayne@69
|
537 #define SQLITE_BUSY_SNAPSHOT (SQLITE_BUSY | (2<<8))
|
|
jpayne@69
|
538 #define SQLITE_BUSY_TIMEOUT (SQLITE_BUSY | (3<<8))
|
|
jpayne@69
|
539 #define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN | (1<<8))
|
|
jpayne@69
|
540 #define SQLITE_CANTOPEN_ISDIR (SQLITE_CANTOPEN | (2<<8))
|
|
jpayne@69
|
541 #define SQLITE_CANTOPEN_FULLPATH (SQLITE_CANTOPEN | (3<<8))
|
|
jpayne@69
|
542 #define SQLITE_CANTOPEN_CONVPATH (SQLITE_CANTOPEN | (4<<8))
|
|
jpayne@69
|
543 #define SQLITE_CANTOPEN_DIRTYWAL (SQLITE_CANTOPEN | (5<<8)) /* Not Used */
|
|
jpayne@69
|
544 #define SQLITE_CANTOPEN_SYMLINK (SQLITE_CANTOPEN | (6<<8))
|
|
jpayne@69
|
545 #define SQLITE_CORRUPT_VTAB (SQLITE_CORRUPT | (1<<8))
|
|
jpayne@69
|
546 #define SQLITE_CORRUPT_SEQUENCE (SQLITE_CORRUPT | (2<<8))
|
|
jpayne@69
|
547 #define SQLITE_CORRUPT_INDEX (SQLITE_CORRUPT | (3<<8))
|
|
jpayne@69
|
548 #define SQLITE_READONLY_RECOVERY (SQLITE_READONLY | (1<<8))
|
|
jpayne@69
|
549 #define SQLITE_READONLY_CANTLOCK (SQLITE_READONLY | (2<<8))
|
|
jpayne@69
|
550 #define SQLITE_READONLY_ROLLBACK (SQLITE_READONLY | (3<<8))
|
|
jpayne@69
|
551 #define SQLITE_READONLY_DBMOVED (SQLITE_READONLY | (4<<8))
|
|
jpayne@69
|
552 #define SQLITE_READONLY_CANTINIT (SQLITE_READONLY | (5<<8))
|
|
jpayne@69
|
553 #define SQLITE_READONLY_DIRECTORY (SQLITE_READONLY | (6<<8))
|
|
jpayne@69
|
554 #define SQLITE_ABORT_ROLLBACK (SQLITE_ABORT | (2<<8))
|
|
jpayne@69
|
555 #define SQLITE_CONSTRAINT_CHECK (SQLITE_CONSTRAINT | (1<<8))
|
|
jpayne@69
|
556 #define SQLITE_CONSTRAINT_COMMITHOOK (SQLITE_CONSTRAINT | (2<<8))
|
|
jpayne@69
|
557 #define SQLITE_CONSTRAINT_FOREIGNKEY (SQLITE_CONSTRAINT | (3<<8))
|
|
jpayne@69
|
558 #define SQLITE_CONSTRAINT_FUNCTION (SQLITE_CONSTRAINT | (4<<8))
|
|
jpayne@69
|
559 #define SQLITE_CONSTRAINT_NOTNULL (SQLITE_CONSTRAINT | (5<<8))
|
|
jpayne@69
|
560 #define SQLITE_CONSTRAINT_PRIMARYKEY (SQLITE_CONSTRAINT | (6<<8))
|
|
jpayne@69
|
561 #define SQLITE_CONSTRAINT_TRIGGER (SQLITE_CONSTRAINT | (7<<8))
|
|
jpayne@69
|
562 #define SQLITE_CONSTRAINT_UNIQUE (SQLITE_CONSTRAINT | (8<<8))
|
|
jpayne@69
|
563 #define SQLITE_CONSTRAINT_VTAB (SQLITE_CONSTRAINT | (9<<8))
|
|
jpayne@69
|
564 #define SQLITE_CONSTRAINT_ROWID (SQLITE_CONSTRAINT |(10<<8))
|
|
jpayne@69
|
565 #define SQLITE_CONSTRAINT_PINNED (SQLITE_CONSTRAINT |(11<<8))
|
|
jpayne@69
|
566 #define SQLITE_CONSTRAINT_DATATYPE (SQLITE_CONSTRAINT |(12<<8))
|
|
jpayne@69
|
567 #define SQLITE_NOTICE_RECOVER_WAL (SQLITE_NOTICE | (1<<8))
|
|
jpayne@69
|
568 #define SQLITE_NOTICE_RECOVER_ROLLBACK (SQLITE_NOTICE | (2<<8))
|
|
jpayne@69
|
569 #define SQLITE_NOTICE_RBU (SQLITE_NOTICE | (3<<8))
|
|
jpayne@69
|
570 #define SQLITE_WARNING_AUTOINDEX (SQLITE_WARNING | (1<<8))
|
|
jpayne@69
|
571 #define SQLITE_AUTH_USER (SQLITE_AUTH | (1<<8))
|
|
jpayne@69
|
572 #define SQLITE_OK_LOAD_PERMANENTLY (SQLITE_OK | (1<<8))
|
|
jpayne@69
|
573 #define SQLITE_OK_SYMLINK (SQLITE_OK | (2<<8)) /* internal use only */
|
|
jpayne@69
|
574
|
|
jpayne@69
|
575 /*
|
|
jpayne@69
|
576 ** CAPI3REF: Flags For File Open Operations
|
|
jpayne@69
|
577 **
|
|
jpayne@69
|
578 ** These bit values are intended for use in the
|
|
jpayne@69
|
579 ** 3rd parameter to the [sqlite3_open_v2()] interface and
|
|
jpayne@69
|
580 ** in the 4th parameter to the [sqlite3_vfs.xOpen] method.
|
|
jpayne@69
|
581 **
|
|
jpayne@69
|
582 ** Only those flags marked as "Ok for sqlite3_open_v2()" may be
|
|
jpayne@69
|
583 ** used as the third argument to the [sqlite3_open_v2()] interface.
|
|
jpayne@69
|
584 ** The other flags have historically been ignored by sqlite3_open_v2(),
|
|
jpayne@69
|
585 ** though future versions of SQLite might change so that an error is
|
|
jpayne@69
|
586 ** raised if any of the disallowed bits are passed into sqlite3_open_v2().
|
|
jpayne@69
|
587 ** Applications should not depend on the historical behavior.
|
|
jpayne@69
|
588 **
|
|
jpayne@69
|
589 ** Note in particular that passing the SQLITE_OPEN_EXCLUSIVE flag into
|
|
jpayne@69
|
590 ** [sqlite3_open_v2()] does *not* cause the underlying database file
|
|
jpayne@69
|
591 ** to be opened using O_EXCL. Passing SQLITE_OPEN_EXCLUSIVE into
|
|
jpayne@69
|
592 ** [sqlite3_open_v2()] has historically be a no-op and might become an
|
|
jpayne@69
|
593 ** error in future versions of SQLite.
|
|
jpayne@69
|
594 */
|
|
jpayne@69
|
595 #define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */
|
|
jpayne@69
|
596 #define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */
|
|
jpayne@69
|
597 #define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */
|
|
jpayne@69
|
598 #define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */
|
|
jpayne@69
|
599 #define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */
|
|
jpayne@69
|
600 #define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */
|
|
jpayne@69
|
601 #define SQLITE_OPEN_URI 0x00000040 /* Ok for sqlite3_open_v2() */
|
|
jpayne@69
|
602 #define SQLITE_OPEN_MEMORY 0x00000080 /* Ok for sqlite3_open_v2() */
|
|
jpayne@69
|
603 #define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */
|
|
jpayne@69
|
604 #define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */
|
|
jpayne@69
|
605 #define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */
|
|
jpayne@69
|
606 #define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */
|
|
jpayne@69
|
607 #define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */
|
|
jpayne@69
|
608 #define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */
|
|
jpayne@69
|
609 #define SQLITE_OPEN_SUPER_JOURNAL 0x00004000 /* VFS only */
|
|
jpayne@69
|
610 #define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */
|
|
jpayne@69
|
611 #define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */
|
|
jpayne@69
|
612 #define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */
|
|
jpayne@69
|
613 #define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */
|
|
jpayne@69
|
614 #define SQLITE_OPEN_WAL 0x00080000 /* VFS only */
|
|
jpayne@69
|
615 #define SQLITE_OPEN_NOFOLLOW 0x01000000 /* Ok for sqlite3_open_v2() */
|
|
jpayne@69
|
616 #define SQLITE_OPEN_EXRESCODE 0x02000000 /* Extended result codes */
|
|
jpayne@69
|
617
|
|
jpayne@69
|
618 /* Reserved: 0x00F00000 */
|
|
jpayne@69
|
619 /* Legacy compatibility: */
|
|
jpayne@69
|
620 #define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */
|
|
jpayne@69
|
621
|
|
jpayne@69
|
622
|
|
jpayne@69
|
623 /*
|
|
jpayne@69
|
624 ** CAPI3REF: Device Characteristics
|
|
jpayne@69
|
625 **
|
|
jpayne@69
|
626 ** The xDeviceCharacteristics method of the [sqlite3_io_methods]
|
|
jpayne@69
|
627 ** object returns an integer which is a vector of these
|
|
jpayne@69
|
628 ** bit values expressing I/O characteristics of the mass storage
|
|
jpayne@69
|
629 ** device that holds the file that the [sqlite3_io_methods]
|
|
jpayne@69
|
630 ** refers to.
|
|
jpayne@69
|
631 **
|
|
jpayne@69
|
632 ** The SQLITE_IOCAP_ATOMIC property means that all writes of
|
|
jpayne@69
|
633 ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
|
|
jpayne@69
|
634 ** mean that writes of blocks that are nnn bytes in size and
|
|
jpayne@69
|
635 ** are aligned to an address which is an integer multiple of
|
|
jpayne@69
|
636 ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
|
|
jpayne@69
|
637 ** that when data is appended to a file, the data is appended
|
|
jpayne@69
|
638 ** first then the size of the file is extended, never the other
|
|
jpayne@69
|
639 ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
|
|
jpayne@69
|
640 ** information is written to disk in the same order as calls
|
|
jpayne@69
|
641 ** to xWrite(). The SQLITE_IOCAP_POWERSAFE_OVERWRITE property means that
|
|
jpayne@69
|
642 ** after reboot following a crash or power loss, the only bytes in a
|
|
jpayne@69
|
643 ** file that were written at the application level might have changed
|
|
jpayne@69
|
644 ** and that adjacent bytes, even bytes within the same sector are
|
|
jpayne@69
|
645 ** guaranteed to be unchanged. The SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN
|
|
jpayne@69
|
646 ** flag indicates that a file cannot be deleted when open. The
|
|
jpayne@69
|
647 ** SQLITE_IOCAP_IMMUTABLE flag indicates that the file is on
|
|
jpayne@69
|
648 ** read-only media and cannot be changed even by processes with
|
|
jpayne@69
|
649 ** elevated privileges.
|
|
jpayne@69
|
650 **
|
|
jpayne@69
|
651 ** The SQLITE_IOCAP_BATCH_ATOMIC property means that the underlying
|
|
jpayne@69
|
652 ** filesystem supports doing multiple write operations atomically when those
|
|
jpayne@69
|
653 ** write operations are bracketed by [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] and
|
|
jpayne@69
|
654 ** [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE].
|
|
jpayne@69
|
655 */
|
|
jpayne@69
|
656 #define SQLITE_IOCAP_ATOMIC 0x00000001
|
|
jpayne@69
|
657 #define SQLITE_IOCAP_ATOMIC512 0x00000002
|
|
jpayne@69
|
658 #define SQLITE_IOCAP_ATOMIC1K 0x00000004
|
|
jpayne@69
|
659 #define SQLITE_IOCAP_ATOMIC2K 0x00000008
|
|
jpayne@69
|
660 #define SQLITE_IOCAP_ATOMIC4K 0x00000010
|
|
jpayne@69
|
661 #define SQLITE_IOCAP_ATOMIC8K 0x00000020
|
|
jpayne@69
|
662 #define SQLITE_IOCAP_ATOMIC16K 0x00000040
|
|
jpayne@69
|
663 #define SQLITE_IOCAP_ATOMIC32K 0x00000080
|
|
jpayne@69
|
664 #define SQLITE_IOCAP_ATOMIC64K 0x00000100
|
|
jpayne@69
|
665 #define SQLITE_IOCAP_SAFE_APPEND 0x00000200
|
|
jpayne@69
|
666 #define SQLITE_IOCAP_SEQUENTIAL 0x00000400
|
|
jpayne@69
|
667 #define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800
|
|
jpayne@69
|
668 #define SQLITE_IOCAP_POWERSAFE_OVERWRITE 0x00001000
|
|
jpayne@69
|
669 #define SQLITE_IOCAP_IMMUTABLE 0x00002000
|
|
jpayne@69
|
670 #define SQLITE_IOCAP_BATCH_ATOMIC 0x00004000
|
|
jpayne@69
|
671
|
|
jpayne@69
|
672 /*
|
|
jpayne@69
|
673 ** CAPI3REF: File Locking Levels
|
|
jpayne@69
|
674 **
|
|
jpayne@69
|
675 ** SQLite uses one of these integer values as the second
|
|
jpayne@69
|
676 ** argument to calls it makes to the xLock() and xUnlock() methods
|
|
jpayne@69
|
677 ** of an [sqlite3_io_methods] object. These values are ordered from
|
|
jpayne@69
|
678 ** lest restrictive to most restrictive.
|
|
jpayne@69
|
679 **
|
|
jpayne@69
|
680 ** The argument to xLock() is always SHARED or higher. The argument to
|
|
jpayne@69
|
681 ** xUnlock is either SHARED or NONE.
|
|
jpayne@69
|
682 */
|
|
jpayne@69
|
683 #define SQLITE_LOCK_NONE 0 /* xUnlock() only */
|
|
jpayne@69
|
684 #define SQLITE_LOCK_SHARED 1 /* xLock() or xUnlock() */
|
|
jpayne@69
|
685 #define SQLITE_LOCK_RESERVED 2 /* xLock() only */
|
|
jpayne@69
|
686 #define SQLITE_LOCK_PENDING 3 /* xLock() only */
|
|
jpayne@69
|
687 #define SQLITE_LOCK_EXCLUSIVE 4 /* xLock() only */
|
|
jpayne@69
|
688
|
|
jpayne@69
|
689 /*
|
|
jpayne@69
|
690 ** CAPI3REF: Synchronization Type Flags
|
|
jpayne@69
|
691 **
|
|
jpayne@69
|
692 ** When SQLite invokes the xSync() method of an
|
|
jpayne@69
|
693 ** [sqlite3_io_methods] object it uses a combination of
|
|
jpayne@69
|
694 ** these integer values as the second argument.
|
|
jpayne@69
|
695 **
|
|
jpayne@69
|
696 ** When the SQLITE_SYNC_DATAONLY flag is used, it means that the
|
|
jpayne@69
|
697 ** sync operation only needs to flush data to mass storage. Inode
|
|
jpayne@69
|
698 ** information need not be flushed. If the lower four bits of the flag
|
|
jpayne@69
|
699 ** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics.
|
|
jpayne@69
|
700 ** If the lower four bits equal SQLITE_SYNC_FULL, that means
|
|
jpayne@69
|
701 ** to use Mac OS X style fullsync instead of fsync().
|
|
jpayne@69
|
702 **
|
|
jpayne@69
|
703 ** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags
|
|
jpayne@69
|
704 ** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL
|
|
jpayne@69
|
705 ** settings. The [synchronous pragma] determines when calls to the
|
|
jpayne@69
|
706 ** xSync VFS method occur and applies uniformly across all platforms.
|
|
jpayne@69
|
707 ** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how
|
|
jpayne@69
|
708 ** energetic or rigorous or forceful the sync operations are and
|
|
jpayne@69
|
709 ** only make a difference on Mac OSX for the default SQLite code.
|
|
jpayne@69
|
710 ** (Third-party VFS implementations might also make the distinction
|
|
jpayne@69
|
711 ** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the
|
|
jpayne@69
|
712 ** operating systems natively supported by SQLite, only Mac OSX
|
|
jpayne@69
|
713 ** cares about the difference.)
|
|
jpayne@69
|
714 */
|
|
jpayne@69
|
715 #define SQLITE_SYNC_NORMAL 0x00002
|
|
jpayne@69
|
716 #define SQLITE_SYNC_FULL 0x00003
|
|
jpayne@69
|
717 #define SQLITE_SYNC_DATAONLY 0x00010
|
|
jpayne@69
|
718
|
|
jpayne@69
|
719 /*
|
|
jpayne@69
|
720 ** CAPI3REF: OS Interface Open File Handle
|
|
jpayne@69
|
721 **
|
|
jpayne@69
|
722 ** An [sqlite3_file] object represents an open file in the
|
|
jpayne@69
|
723 ** [sqlite3_vfs | OS interface layer]. Individual OS interface
|
|
jpayne@69
|
724 ** implementations will
|
|
jpayne@69
|
725 ** want to subclass this object by appending additional fields
|
|
jpayne@69
|
726 ** for their own use. The pMethods entry is a pointer to an
|
|
jpayne@69
|
727 ** [sqlite3_io_methods] object that defines methods for performing
|
|
jpayne@69
|
728 ** I/O operations on the open file.
|
|
jpayne@69
|
729 */
|
|
jpayne@69
|
730 typedef struct sqlite3_file sqlite3_file;
|
|
jpayne@69
|
731 struct sqlite3_file {
|
|
jpayne@69
|
732 const struct sqlite3_io_methods *pMethods; /* Methods for an open file */
|
|
jpayne@69
|
733 };
|
|
jpayne@69
|
734
|
|
jpayne@69
|
735 /*
|
|
jpayne@69
|
736 ** CAPI3REF: OS Interface File Virtual Methods Object
|
|
jpayne@69
|
737 **
|
|
jpayne@69
|
738 ** Every file opened by the [sqlite3_vfs.xOpen] method populates an
|
|
jpayne@69
|
739 ** [sqlite3_file] object (or, more commonly, a subclass of the
|
|
jpayne@69
|
740 ** [sqlite3_file] object) with a pointer to an instance of this object.
|
|
jpayne@69
|
741 ** This object defines the methods used to perform various operations
|
|
jpayne@69
|
742 ** against the open file represented by the [sqlite3_file] object.
|
|
jpayne@69
|
743 **
|
|
jpayne@69
|
744 ** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element
|
|
jpayne@69
|
745 ** to a non-NULL pointer, then the sqlite3_io_methods.xClose method
|
|
jpayne@69
|
746 ** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed. The
|
|
jpayne@69
|
747 ** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen]
|
|
jpayne@69
|
748 ** is for the [sqlite3_vfs.xOpen] to set the sqlite3_file.pMethods element
|
|
jpayne@69
|
749 ** to NULL.
|
|
jpayne@69
|
750 **
|
|
jpayne@69
|
751 ** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or
|
|
jpayne@69
|
752 ** [SQLITE_SYNC_FULL]. The first choice is the normal fsync().
|
|
jpayne@69
|
753 ** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY]
|
|
jpayne@69
|
754 ** flag may be ORed in to indicate that only the data of the file
|
|
jpayne@69
|
755 ** and not its inode needs to be synced.
|
|
jpayne@69
|
756 **
|
|
jpayne@69
|
757 ** The integer values to xLock() and xUnlock() are one of
|
|
jpayne@69
|
758 ** <ul>
|
|
jpayne@69
|
759 ** <li> [SQLITE_LOCK_NONE],
|
|
jpayne@69
|
760 ** <li> [SQLITE_LOCK_SHARED],
|
|
jpayne@69
|
761 ** <li> [SQLITE_LOCK_RESERVED],
|
|
jpayne@69
|
762 ** <li> [SQLITE_LOCK_PENDING], or
|
|
jpayne@69
|
763 ** <li> [SQLITE_LOCK_EXCLUSIVE].
|
|
jpayne@69
|
764 ** </ul>
|
|
jpayne@69
|
765 ** xLock() upgrades the database file lock. In other words, xLock() moves the
|
|
jpayne@69
|
766 ** database file lock in the direction NONE toward EXCLUSIVE. The argument to
|
|
jpayne@69
|
767 ** xLock() is always one of SHARED, RESERVED, PENDING, or EXCLUSIVE, never
|
|
jpayne@69
|
768 ** SQLITE_LOCK_NONE. If the database file lock is already at or above the
|
|
jpayne@69
|
769 ** requested lock, then the call to xLock() is a no-op.
|
|
jpayne@69
|
770 ** xUnlock() downgrades the database file lock to either SHARED or NONE.
|
|
jpayne@69
|
771 ** If the lock is already at or below the requested lock state, then the call
|
|
jpayne@69
|
772 ** to xUnlock() is a no-op.
|
|
jpayne@69
|
773 ** The xCheckReservedLock() method checks whether any database connection,
|
|
jpayne@69
|
774 ** either in this process or in some other process, is holding a RESERVED,
|
|
jpayne@69
|
775 ** PENDING, or EXCLUSIVE lock on the file. It returns true
|
|
jpayne@69
|
776 ** if such a lock exists and false otherwise.
|
|
jpayne@69
|
777 **
|
|
jpayne@69
|
778 ** The xFileControl() method is a generic interface that allows custom
|
|
jpayne@69
|
779 ** VFS implementations to directly control an open file using the
|
|
jpayne@69
|
780 ** [sqlite3_file_control()] interface. The second "op" argument is an
|
|
jpayne@69
|
781 ** integer opcode. The third argument is a generic pointer intended to
|
|
jpayne@69
|
782 ** point to a structure that may contain arguments or space in which to
|
|
jpayne@69
|
783 ** write return values. Potential uses for xFileControl() might be
|
|
jpayne@69
|
784 ** functions to enable blocking locks with timeouts, to change the
|
|
jpayne@69
|
785 ** locking strategy (for example to use dot-file locks), to inquire
|
|
jpayne@69
|
786 ** about the status of a lock, or to break stale locks. The SQLite
|
|
jpayne@69
|
787 ** core reserves all opcodes less than 100 for its own use.
|
|
jpayne@69
|
788 ** A [file control opcodes | list of opcodes] less than 100 is available.
|
|
jpayne@69
|
789 ** Applications that define a custom xFileControl method should use opcodes
|
|
jpayne@69
|
790 ** greater than 100 to avoid conflicts. VFS implementations should
|
|
jpayne@69
|
791 ** return [SQLITE_NOTFOUND] for file control opcodes that they do not
|
|
jpayne@69
|
792 ** recognize.
|
|
jpayne@69
|
793 **
|
|
jpayne@69
|
794 ** The xSectorSize() method returns the sector size of the
|
|
jpayne@69
|
795 ** device that underlies the file. The sector size is the
|
|
jpayne@69
|
796 ** minimum write that can be performed without disturbing
|
|
jpayne@69
|
797 ** other bytes in the file. The xDeviceCharacteristics()
|
|
jpayne@69
|
798 ** method returns a bit vector describing behaviors of the
|
|
jpayne@69
|
799 ** underlying device:
|
|
jpayne@69
|
800 **
|
|
jpayne@69
|
801 ** <ul>
|
|
jpayne@69
|
802 ** <li> [SQLITE_IOCAP_ATOMIC]
|
|
jpayne@69
|
803 ** <li> [SQLITE_IOCAP_ATOMIC512]
|
|
jpayne@69
|
804 ** <li> [SQLITE_IOCAP_ATOMIC1K]
|
|
jpayne@69
|
805 ** <li> [SQLITE_IOCAP_ATOMIC2K]
|
|
jpayne@69
|
806 ** <li> [SQLITE_IOCAP_ATOMIC4K]
|
|
jpayne@69
|
807 ** <li> [SQLITE_IOCAP_ATOMIC8K]
|
|
jpayne@69
|
808 ** <li> [SQLITE_IOCAP_ATOMIC16K]
|
|
jpayne@69
|
809 ** <li> [SQLITE_IOCAP_ATOMIC32K]
|
|
jpayne@69
|
810 ** <li> [SQLITE_IOCAP_ATOMIC64K]
|
|
jpayne@69
|
811 ** <li> [SQLITE_IOCAP_SAFE_APPEND]
|
|
jpayne@69
|
812 ** <li> [SQLITE_IOCAP_SEQUENTIAL]
|
|
jpayne@69
|
813 ** <li> [SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN]
|
|
jpayne@69
|
814 ** <li> [SQLITE_IOCAP_POWERSAFE_OVERWRITE]
|
|
jpayne@69
|
815 ** <li> [SQLITE_IOCAP_IMMUTABLE]
|
|
jpayne@69
|
816 ** <li> [SQLITE_IOCAP_BATCH_ATOMIC]
|
|
jpayne@69
|
817 ** </ul>
|
|
jpayne@69
|
818 **
|
|
jpayne@69
|
819 ** The SQLITE_IOCAP_ATOMIC property means that all writes of
|
|
jpayne@69
|
820 ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
|
|
jpayne@69
|
821 ** mean that writes of blocks that are nnn bytes in size and
|
|
jpayne@69
|
822 ** are aligned to an address which is an integer multiple of
|
|
jpayne@69
|
823 ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
|
|
jpayne@69
|
824 ** that when data is appended to a file, the data is appended
|
|
jpayne@69
|
825 ** first then the size of the file is extended, never the other
|
|
jpayne@69
|
826 ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
|
|
jpayne@69
|
827 ** information is written to disk in the same order as calls
|
|
jpayne@69
|
828 ** to xWrite().
|
|
jpayne@69
|
829 **
|
|
jpayne@69
|
830 ** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill
|
|
jpayne@69
|
831 ** in the unread portions of the buffer with zeros. A VFS that
|
|
jpayne@69
|
832 ** fails to zero-fill short reads might seem to work. However,
|
|
jpayne@69
|
833 ** failure to zero-fill short reads will eventually lead to
|
|
jpayne@69
|
834 ** database corruption.
|
|
jpayne@69
|
835 */
|
|
jpayne@69
|
836 typedef struct sqlite3_io_methods sqlite3_io_methods;
|
|
jpayne@69
|
837 struct sqlite3_io_methods {
|
|
jpayne@69
|
838 int iVersion;
|
|
jpayne@69
|
839 int (*xClose)(sqlite3_file*);
|
|
jpayne@69
|
840 int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst);
|
|
jpayne@69
|
841 int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst);
|
|
jpayne@69
|
842 int (*xTruncate)(sqlite3_file*, sqlite3_int64 size);
|
|
jpayne@69
|
843 int (*xSync)(sqlite3_file*, int flags);
|
|
jpayne@69
|
844 int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize);
|
|
jpayne@69
|
845 int (*xLock)(sqlite3_file*, int);
|
|
jpayne@69
|
846 int (*xUnlock)(sqlite3_file*, int);
|
|
jpayne@69
|
847 int (*xCheckReservedLock)(sqlite3_file*, int *pResOut);
|
|
jpayne@69
|
848 int (*xFileControl)(sqlite3_file*, int op, void *pArg);
|
|
jpayne@69
|
849 int (*xSectorSize)(sqlite3_file*);
|
|
jpayne@69
|
850 int (*xDeviceCharacteristics)(sqlite3_file*);
|
|
jpayne@69
|
851 /* Methods above are valid for version 1 */
|
|
jpayne@69
|
852 int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, void volatile**);
|
|
jpayne@69
|
853 int (*xShmLock)(sqlite3_file*, int offset, int n, int flags);
|
|
jpayne@69
|
854 void (*xShmBarrier)(sqlite3_file*);
|
|
jpayne@69
|
855 int (*xShmUnmap)(sqlite3_file*, int deleteFlag);
|
|
jpayne@69
|
856 /* Methods above are valid for version 2 */
|
|
jpayne@69
|
857 int (*xFetch)(sqlite3_file*, sqlite3_int64 iOfst, int iAmt, void **pp);
|
|
jpayne@69
|
858 int (*xUnfetch)(sqlite3_file*, sqlite3_int64 iOfst, void *p);
|
|
jpayne@69
|
859 /* Methods above are valid for version 3 */
|
|
jpayne@69
|
860 /* Additional methods may be added in future releases */
|
|
jpayne@69
|
861 };
|
|
jpayne@69
|
862
|
|
jpayne@69
|
863 /*
|
|
jpayne@69
|
864 ** CAPI3REF: Standard File Control Opcodes
|
|
jpayne@69
|
865 ** KEYWORDS: {file control opcodes} {file control opcode}
|
|
jpayne@69
|
866 **
|
|
jpayne@69
|
867 ** These integer constants are opcodes for the xFileControl method
|
|
jpayne@69
|
868 ** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()]
|
|
jpayne@69
|
869 ** interface.
|
|
jpayne@69
|
870 **
|
|
jpayne@69
|
871 ** <ul>
|
|
jpayne@69
|
872 ** <li>[[SQLITE_FCNTL_LOCKSTATE]]
|
|
jpayne@69
|
873 ** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This
|
|
jpayne@69
|
874 ** opcode causes the xFileControl method to write the current state of
|
|
jpayne@69
|
875 ** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED],
|
|
jpayne@69
|
876 ** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE])
|
|
jpayne@69
|
877 ** into an integer that the pArg argument points to.
|
|
jpayne@69
|
878 ** This capability is only available if SQLite is compiled with [SQLITE_DEBUG].
|
|
jpayne@69
|
879 **
|
|
jpayne@69
|
880 ** <li>[[SQLITE_FCNTL_SIZE_HINT]]
|
|
jpayne@69
|
881 ** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS
|
|
jpayne@69
|
882 ** layer a hint of how large the database file will grow to be during the
|
|
jpayne@69
|
883 ** current transaction. This hint is not guaranteed to be accurate but it
|
|
jpayne@69
|
884 ** is often close. The underlying VFS might choose to preallocate database
|
|
jpayne@69
|
885 ** file space based on this hint in order to help writes to the database
|
|
jpayne@69
|
886 ** file run faster.
|
|
jpayne@69
|
887 **
|
|
jpayne@69
|
888 ** <li>[[SQLITE_FCNTL_SIZE_LIMIT]]
|
|
jpayne@69
|
889 ** The [SQLITE_FCNTL_SIZE_LIMIT] opcode is used by in-memory VFS that
|
|
jpayne@69
|
890 ** implements [sqlite3_deserialize()] to set an upper bound on the size
|
|
jpayne@69
|
891 ** of the in-memory database. The argument is a pointer to a [sqlite3_int64].
|
|
jpayne@69
|
892 ** If the integer pointed to is negative, then it is filled in with the
|
|
jpayne@69
|
893 ** current limit. Otherwise the limit is set to the larger of the value
|
|
jpayne@69
|
894 ** of the integer pointed to and the current database size. The integer
|
|
jpayne@69
|
895 ** pointed to is set to the new limit.
|
|
jpayne@69
|
896 **
|
|
jpayne@69
|
897 ** <li>[[SQLITE_FCNTL_CHUNK_SIZE]]
|
|
jpayne@69
|
898 ** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS
|
|
jpayne@69
|
899 ** extends and truncates the database file in chunks of a size specified
|
|
jpayne@69
|
900 ** by the user. The fourth argument to [sqlite3_file_control()] should
|
|
jpayne@69
|
901 ** point to an integer (type int) containing the new chunk-size to use
|
|
jpayne@69
|
902 ** for the nominated database. Allocating database file space in large
|
|
jpayne@69
|
903 ** chunks (say 1MB at a time), may reduce file-system fragmentation and
|
|
jpayne@69
|
904 ** improve performance on some systems.
|
|
jpayne@69
|
905 **
|
|
jpayne@69
|
906 ** <li>[[SQLITE_FCNTL_FILE_POINTER]]
|
|
jpayne@69
|
907 ** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer
|
|
jpayne@69
|
908 ** to the [sqlite3_file] object associated with a particular database
|
|
jpayne@69
|
909 ** connection. See also [SQLITE_FCNTL_JOURNAL_POINTER].
|
|
jpayne@69
|
910 **
|
|
jpayne@69
|
911 ** <li>[[SQLITE_FCNTL_JOURNAL_POINTER]]
|
|
jpayne@69
|
912 ** The [SQLITE_FCNTL_JOURNAL_POINTER] opcode is used to obtain a pointer
|
|
jpayne@69
|
913 ** to the [sqlite3_file] object associated with the journal file (either
|
|
jpayne@69
|
914 ** the [rollback journal] or the [write-ahead log]) for a particular database
|
|
jpayne@69
|
915 ** connection. See also [SQLITE_FCNTL_FILE_POINTER].
|
|
jpayne@69
|
916 **
|
|
jpayne@69
|
917 ** <li>[[SQLITE_FCNTL_SYNC_OMITTED]]
|
|
jpayne@69
|
918 ** No longer in use.
|
|
jpayne@69
|
919 **
|
|
jpayne@69
|
920 ** <li>[[SQLITE_FCNTL_SYNC]]
|
|
jpayne@69
|
921 ** The [SQLITE_FCNTL_SYNC] opcode is generated internally by SQLite and
|
|
jpayne@69
|
922 ** sent to the VFS immediately before the xSync method is invoked on a
|
|
jpayne@69
|
923 ** database file descriptor. Or, if the xSync method is not invoked
|
|
jpayne@69
|
924 ** because the user has configured SQLite with
|
|
jpayne@69
|
925 ** [PRAGMA synchronous | PRAGMA synchronous=OFF] it is invoked in place
|
|
jpayne@69
|
926 ** of the xSync method. In most cases, the pointer argument passed with
|
|
jpayne@69
|
927 ** this file-control is NULL. However, if the database file is being synced
|
|
jpayne@69
|
928 ** as part of a multi-database commit, the argument points to a nul-terminated
|
|
jpayne@69
|
929 ** string containing the transactions super-journal file name. VFSes that
|
|
jpayne@69
|
930 ** do not need this signal should silently ignore this opcode. Applications
|
|
jpayne@69
|
931 ** should not call [sqlite3_file_control()] with this opcode as doing so may
|
|
jpayne@69
|
932 ** disrupt the operation of the specialized VFSes that do require it.
|
|
jpayne@69
|
933 **
|
|
jpayne@69
|
934 ** <li>[[SQLITE_FCNTL_COMMIT_PHASETWO]]
|
|
jpayne@69
|
935 ** The [SQLITE_FCNTL_COMMIT_PHASETWO] opcode is generated internally by SQLite
|
|
jpayne@69
|
936 ** and sent to the VFS after a transaction has been committed immediately
|
|
jpayne@69
|
937 ** but before the database is unlocked. VFSes that do not need this signal
|
|
jpayne@69
|
938 ** should silently ignore this opcode. Applications should not call
|
|
jpayne@69
|
939 ** [sqlite3_file_control()] with this opcode as doing so may disrupt the
|
|
jpayne@69
|
940 ** operation of the specialized VFSes that do require it.
|
|
jpayne@69
|
941 **
|
|
jpayne@69
|
942 ** <li>[[SQLITE_FCNTL_WIN32_AV_RETRY]]
|
|
jpayne@69
|
943 ** ^The [SQLITE_FCNTL_WIN32_AV_RETRY] opcode is used to configure automatic
|
|
jpayne@69
|
944 ** retry counts and intervals for certain disk I/O operations for the
|
|
jpayne@69
|
945 ** windows [VFS] in order to provide robustness in the presence of
|
|
jpayne@69
|
946 ** anti-virus programs. By default, the windows VFS will retry file read,
|
|
jpayne@69
|
947 ** file write, and file delete operations up to 10 times, with a delay
|
|
jpayne@69
|
948 ** of 25 milliseconds before the first retry and with the delay increasing
|
|
jpayne@69
|
949 ** by an additional 25 milliseconds with each subsequent retry. This
|
|
jpayne@69
|
950 ** opcode allows these two values (10 retries and 25 milliseconds of delay)
|
|
jpayne@69
|
951 ** to be adjusted. The values are changed for all database connections
|
|
jpayne@69
|
952 ** within the same process. The argument is a pointer to an array of two
|
|
jpayne@69
|
953 ** integers where the first integer is the new retry count and the second
|
|
jpayne@69
|
954 ** integer is the delay. If either integer is negative, then the setting
|
|
jpayne@69
|
955 ** is not changed but instead the prior value of that setting is written
|
|
jpayne@69
|
956 ** into the array entry, allowing the current retry settings to be
|
|
jpayne@69
|
957 ** interrogated. The zDbName parameter is ignored.
|
|
jpayne@69
|
958 **
|
|
jpayne@69
|
959 ** <li>[[SQLITE_FCNTL_PERSIST_WAL]]
|
|
jpayne@69
|
960 ** ^The [SQLITE_FCNTL_PERSIST_WAL] opcode is used to set or query the
|
|
jpayne@69
|
961 ** persistent [WAL | Write Ahead Log] setting. By default, the auxiliary
|
|
jpayne@69
|
962 ** write ahead log ([WAL file]) and shared memory
|
|
jpayne@69
|
963 ** files used for transaction control
|
|
jpayne@69
|
964 ** are automatically deleted when the latest connection to the database
|
|
jpayne@69
|
965 ** closes. Setting persistent WAL mode causes those files to persist after
|
|
jpayne@69
|
966 ** close. Persisting the files is useful when other processes that do not
|
|
jpayne@69
|
967 ** have write permission on the directory containing the database file want
|
|
jpayne@69
|
968 ** to read the database file, as the WAL and shared memory files must exist
|
|
jpayne@69
|
969 ** in order for the database to be readable. The fourth parameter to
|
|
jpayne@69
|
970 ** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
|
|
jpayne@69
|
971 ** That integer is 0 to disable persistent WAL mode or 1 to enable persistent
|
|
jpayne@69
|
972 ** WAL mode. If the integer is -1, then it is overwritten with the current
|
|
jpayne@69
|
973 ** WAL persistence setting.
|
|
jpayne@69
|
974 **
|
|
jpayne@69
|
975 ** <li>[[SQLITE_FCNTL_POWERSAFE_OVERWRITE]]
|
|
jpayne@69
|
976 ** ^The [SQLITE_FCNTL_POWERSAFE_OVERWRITE] opcode is used to set or query the
|
|
jpayne@69
|
977 ** persistent "powersafe-overwrite" or "PSOW" setting. The PSOW setting
|
|
jpayne@69
|
978 ** determines the [SQLITE_IOCAP_POWERSAFE_OVERWRITE] bit of the
|
|
jpayne@69
|
979 ** xDeviceCharacteristics methods. The fourth parameter to
|
|
jpayne@69
|
980 ** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
|
|
jpayne@69
|
981 ** That integer is 0 to disable zero-damage mode or 1 to enable zero-damage
|
|
jpayne@69
|
982 ** mode. If the integer is -1, then it is overwritten with the current
|
|
jpayne@69
|
983 ** zero-damage mode setting.
|
|
jpayne@69
|
984 **
|
|
jpayne@69
|
985 ** <li>[[SQLITE_FCNTL_OVERWRITE]]
|
|
jpayne@69
|
986 ** ^The [SQLITE_FCNTL_OVERWRITE] opcode is invoked by SQLite after opening
|
|
jpayne@69
|
987 ** a write transaction to indicate that, unless it is rolled back for some
|
|
jpayne@69
|
988 ** reason, the entire database file will be overwritten by the current
|
|
jpayne@69
|
989 ** transaction. This is used by VACUUM operations.
|
|
jpayne@69
|
990 **
|
|
jpayne@69
|
991 ** <li>[[SQLITE_FCNTL_VFSNAME]]
|
|
jpayne@69
|
992 ** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of
|
|
jpayne@69
|
993 ** all [VFSes] in the VFS stack. The names are of all VFS shims and the
|
|
jpayne@69
|
994 ** final bottom-level VFS are written into memory obtained from
|
|
jpayne@69
|
995 ** [sqlite3_malloc()] and the result is stored in the char* variable
|
|
jpayne@69
|
996 ** that the fourth parameter of [sqlite3_file_control()] points to.
|
|
jpayne@69
|
997 ** The caller is responsible for freeing the memory when done. As with
|
|
jpayne@69
|
998 ** all file-control actions, there is no guarantee that this will actually
|
|
jpayne@69
|
999 ** do anything. Callers should initialize the char* variable to a NULL
|
|
jpayne@69
|
1000 ** pointer in case this file-control is not implemented. This file-control
|
|
jpayne@69
|
1001 ** is intended for diagnostic use only.
|
|
jpayne@69
|
1002 **
|
|
jpayne@69
|
1003 ** <li>[[SQLITE_FCNTL_VFS_POINTER]]
|
|
jpayne@69
|
1004 ** ^The [SQLITE_FCNTL_VFS_POINTER] opcode finds a pointer to the top-level
|
|
jpayne@69
|
1005 ** [VFSes] currently in use. ^(The argument X in
|
|
jpayne@69
|
1006 ** sqlite3_file_control(db,SQLITE_FCNTL_VFS_POINTER,X) must be
|
|
jpayne@69
|
1007 ** of type "[sqlite3_vfs] **". This opcodes will set *X
|
|
jpayne@69
|
1008 ** to a pointer to the top-level VFS.)^
|
|
jpayne@69
|
1009 ** ^When there are multiple VFS shims in the stack, this opcode finds the
|
|
jpayne@69
|
1010 ** upper-most shim only.
|
|
jpayne@69
|
1011 **
|
|
jpayne@69
|
1012 ** <li>[[SQLITE_FCNTL_PRAGMA]]
|
|
jpayne@69
|
1013 ** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA]
|
|
jpayne@69
|
1014 ** file control is sent to the open [sqlite3_file] object corresponding
|
|
jpayne@69
|
1015 ** to the database file to which the pragma statement refers. ^The argument
|
|
jpayne@69
|
1016 ** to the [SQLITE_FCNTL_PRAGMA] file control is an array of
|
|
jpayne@69
|
1017 ** pointers to strings (char**) in which the second element of the array
|
|
jpayne@69
|
1018 ** is the name of the pragma and the third element is the argument to the
|
|
jpayne@69
|
1019 ** pragma or NULL if the pragma has no argument. ^The handler for an
|
|
jpayne@69
|
1020 ** [SQLITE_FCNTL_PRAGMA] file control can optionally make the first element
|
|
jpayne@69
|
1021 ** of the char** argument point to a string obtained from [sqlite3_mprintf()]
|
|
jpayne@69
|
1022 ** or the equivalent and that string will become the result of the pragma or
|
|
jpayne@69
|
1023 ** the error message if the pragma fails. ^If the
|
|
jpayne@69
|
1024 ** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal
|
|
jpayne@69
|
1025 ** [PRAGMA] processing continues. ^If the [SQLITE_FCNTL_PRAGMA]
|
|
jpayne@69
|
1026 ** file control returns [SQLITE_OK], then the parser assumes that the
|
|
jpayne@69
|
1027 ** VFS has handled the PRAGMA itself and the parser generates a no-op
|
|
jpayne@69
|
1028 ** prepared statement if result string is NULL, or that returns a copy
|
|
jpayne@69
|
1029 ** of the result string if the string is non-NULL.
|
|
jpayne@69
|
1030 ** ^If the [SQLITE_FCNTL_PRAGMA] file control returns
|
|
jpayne@69
|
1031 ** any result code other than [SQLITE_OK] or [SQLITE_NOTFOUND], that means
|
|
jpayne@69
|
1032 ** that the VFS encountered an error while handling the [PRAGMA] and the
|
|
jpayne@69
|
1033 ** compilation of the PRAGMA fails with an error. ^The [SQLITE_FCNTL_PRAGMA]
|
|
jpayne@69
|
1034 ** file control occurs at the beginning of pragma statement analysis and so
|
|
jpayne@69
|
1035 ** it is able to override built-in [PRAGMA] statements.
|
|
jpayne@69
|
1036 **
|
|
jpayne@69
|
1037 ** <li>[[SQLITE_FCNTL_BUSYHANDLER]]
|
|
jpayne@69
|
1038 ** ^The [SQLITE_FCNTL_BUSYHANDLER]
|
|
jpayne@69
|
1039 ** file-control may be invoked by SQLite on the database file handle
|
|
jpayne@69
|
1040 ** shortly after it is opened in order to provide a custom VFS with access
|
|
jpayne@69
|
1041 ** to the connection's busy-handler callback. The argument is of type (void**)
|
|
jpayne@69
|
1042 ** - an array of two (void *) values. The first (void *) actually points
|
|
jpayne@69
|
1043 ** to a function of type (int (*)(void *)). In order to invoke the connection's
|
|
jpayne@69
|
1044 ** busy-handler, this function should be invoked with the second (void *) in
|
|
jpayne@69
|
1045 ** the array as the only argument. If it returns non-zero, then the operation
|
|
jpayne@69
|
1046 ** should be retried. If it returns zero, the custom VFS should abandon the
|
|
jpayne@69
|
1047 ** current operation.
|
|
jpayne@69
|
1048 **
|
|
jpayne@69
|
1049 ** <li>[[SQLITE_FCNTL_TEMPFILENAME]]
|
|
jpayne@69
|
1050 ** ^Applications can invoke the [SQLITE_FCNTL_TEMPFILENAME] file-control
|
|
jpayne@69
|
1051 ** to have SQLite generate a
|
|
jpayne@69
|
1052 ** temporary filename using the same algorithm that is followed to generate
|
|
jpayne@69
|
1053 ** temporary filenames for TEMP tables and other internal uses. The
|
|
jpayne@69
|
1054 ** argument should be a char** which will be filled with the filename
|
|
jpayne@69
|
1055 ** written into memory obtained from [sqlite3_malloc()]. The caller should
|
|
jpayne@69
|
1056 ** invoke [sqlite3_free()] on the result to avoid a memory leak.
|
|
jpayne@69
|
1057 **
|
|
jpayne@69
|
1058 ** <li>[[SQLITE_FCNTL_MMAP_SIZE]]
|
|
jpayne@69
|
1059 ** The [SQLITE_FCNTL_MMAP_SIZE] file control is used to query or set the
|
|
jpayne@69
|
1060 ** maximum number of bytes that will be used for memory-mapped I/O.
|
|
jpayne@69
|
1061 ** The argument is a pointer to a value of type sqlite3_int64 that
|
|
jpayne@69
|
1062 ** is an advisory maximum number of bytes in the file to memory map. The
|
|
jpayne@69
|
1063 ** pointer is overwritten with the old value. The limit is not changed if
|
|
jpayne@69
|
1064 ** the value originally pointed to is negative, and so the current limit
|
|
jpayne@69
|
1065 ** can be queried by passing in a pointer to a negative number. This
|
|
jpayne@69
|
1066 ** file-control is used internally to implement [PRAGMA mmap_size].
|
|
jpayne@69
|
1067 **
|
|
jpayne@69
|
1068 ** <li>[[SQLITE_FCNTL_TRACE]]
|
|
jpayne@69
|
1069 ** The [SQLITE_FCNTL_TRACE] file control provides advisory information
|
|
jpayne@69
|
1070 ** to the VFS about what the higher layers of the SQLite stack are doing.
|
|
jpayne@69
|
1071 ** This file control is used by some VFS activity tracing [shims].
|
|
jpayne@69
|
1072 ** The argument is a zero-terminated string. Higher layers in the
|
|
jpayne@69
|
1073 ** SQLite stack may generate instances of this file control if
|
|
jpayne@69
|
1074 ** the [SQLITE_USE_FCNTL_TRACE] compile-time option is enabled.
|
|
jpayne@69
|
1075 **
|
|
jpayne@69
|
1076 ** <li>[[SQLITE_FCNTL_HAS_MOVED]]
|
|
jpayne@69
|
1077 ** The [SQLITE_FCNTL_HAS_MOVED] file control interprets its argument as a
|
|
jpayne@69
|
1078 ** pointer to an integer and it writes a boolean into that integer depending
|
|
jpayne@69
|
1079 ** on whether or not the file has been renamed, moved, or deleted since it
|
|
jpayne@69
|
1080 ** was first opened.
|
|
jpayne@69
|
1081 **
|
|
jpayne@69
|
1082 ** <li>[[SQLITE_FCNTL_WIN32_GET_HANDLE]]
|
|
jpayne@69
|
1083 ** The [SQLITE_FCNTL_WIN32_GET_HANDLE] opcode can be used to obtain the
|
|
jpayne@69
|
1084 ** underlying native file handle associated with a file handle. This file
|
|
jpayne@69
|
1085 ** control interprets its argument as a pointer to a native file handle and
|
|
jpayne@69
|
1086 ** writes the resulting value there.
|
|
jpayne@69
|
1087 **
|
|
jpayne@69
|
1088 ** <li>[[SQLITE_FCNTL_WIN32_SET_HANDLE]]
|
|
jpayne@69
|
1089 ** The [SQLITE_FCNTL_WIN32_SET_HANDLE] opcode is used for debugging. This
|
|
jpayne@69
|
1090 ** opcode causes the xFileControl method to swap the file handle with the one
|
|
jpayne@69
|
1091 ** pointed to by the pArg argument. This capability is used during testing
|
|
jpayne@69
|
1092 ** and only needs to be supported when SQLITE_TEST is defined.
|
|
jpayne@69
|
1093 **
|
|
jpayne@69
|
1094 ** <li>[[SQLITE_FCNTL_WAL_BLOCK]]
|
|
jpayne@69
|
1095 ** The [SQLITE_FCNTL_WAL_BLOCK] is a signal to the VFS layer that it might
|
|
jpayne@69
|
1096 ** be advantageous to block on the next WAL lock if the lock is not immediately
|
|
jpayne@69
|
1097 ** available. The WAL subsystem issues this signal during rare
|
|
jpayne@69
|
1098 ** circumstances in order to fix a problem with priority inversion.
|
|
jpayne@69
|
1099 ** Applications should <em>not</em> use this file-control.
|
|
jpayne@69
|
1100 **
|
|
jpayne@69
|
1101 ** <li>[[SQLITE_FCNTL_ZIPVFS]]
|
|
jpayne@69
|
1102 ** The [SQLITE_FCNTL_ZIPVFS] opcode is implemented by zipvfs only. All other
|
|
jpayne@69
|
1103 ** VFS should return SQLITE_NOTFOUND for this opcode.
|
|
jpayne@69
|
1104 **
|
|
jpayne@69
|
1105 ** <li>[[SQLITE_FCNTL_RBU]]
|
|
jpayne@69
|
1106 ** The [SQLITE_FCNTL_RBU] opcode is implemented by the special VFS used by
|
|
jpayne@69
|
1107 ** the RBU extension only. All other VFS should return SQLITE_NOTFOUND for
|
|
jpayne@69
|
1108 ** this opcode.
|
|
jpayne@69
|
1109 **
|
|
jpayne@69
|
1110 ** <li>[[SQLITE_FCNTL_BEGIN_ATOMIC_WRITE]]
|
|
jpayne@69
|
1111 ** If the [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] opcode returns SQLITE_OK, then
|
|
jpayne@69
|
1112 ** the file descriptor is placed in "batch write mode", which
|
|
jpayne@69
|
1113 ** means all subsequent write operations will be deferred and done
|
|
jpayne@69
|
1114 ** atomically at the next [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]. Systems
|
|
jpayne@69
|
1115 ** that do not support batch atomic writes will return SQLITE_NOTFOUND.
|
|
jpayne@69
|
1116 ** ^Following a successful SQLITE_FCNTL_BEGIN_ATOMIC_WRITE and prior to
|
|
jpayne@69
|
1117 ** the closing [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE] or
|
|
jpayne@69
|
1118 ** [SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE], SQLite will make
|
|
jpayne@69
|
1119 ** no VFS interface calls on the same [sqlite3_file] file descriptor
|
|
jpayne@69
|
1120 ** except for calls to the xWrite method and the xFileControl method
|
|
jpayne@69
|
1121 ** with [SQLITE_FCNTL_SIZE_HINT].
|
|
jpayne@69
|
1122 **
|
|
jpayne@69
|
1123 ** <li>[[SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]]
|
|
jpayne@69
|
1124 ** The [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE] opcode causes all write
|
|
jpayne@69
|
1125 ** operations since the previous successful call to
|
|
jpayne@69
|
1126 ** [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] to be performed atomically.
|
|
jpayne@69
|
1127 ** This file control returns [SQLITE_OK] if and only if the writes were
|
|
jpayne@69
|
1128 ** all performed successfully and have been committed to persistent storage.
|
|
jpayne@69
|
1129 ** ^Regardless of whether or not it is successful, this file control takes
|
|
jpayne@69
|
1130 ** the file descriptor out of batch write mode so that all subsequent
|
|
jpayne@69
|
1131 ** write operations are independent.
|
|
jpayne@69
|
1132 ** ^SQLite will never invoke SQLITE_FCNTL_COMMIT_ATOMIC_WRITE without
|
|
jpayne@69
|
1133 ** a prior successful call to [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE].
|
|
jpayne@69
|
1134 **
|
|
jpayne@69
|
1135 ** <li>[[SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE]]
|
|
jpayne@69
|
1136 ** The [SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE] opcode causes all write
|
|
jpayne@69
|
1137 ** operations since the previous successful call to
|
|
jpayne@69
|
1138 ** [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] to be rolled back.
|
|
jpayne@69
|
1139 ** ^This file control takes the file descriptor out of batch write mode
|
|
jpayne@69
|
1140 ** so that all subsequent write operations are independent.
|
|
jpayne@69
|
1141 ** ^SQLite will never invoke SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE without
|
|
jpayne@69
|
1142 ** a prior successful call to [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE].
|
|
jpayne@69
|
1143 **
|
|
jpayne@69
|
1144 ** <li>[[SQLITE_FCNTL_LOCK_TIMEOUT]]
|
|
jpayne@69
|
1145 ** The [SQLITE_FCNTL_LOCK_TIMEOUT] opcode is used to configure a VFS
|
|
jpayne@69
|
1146 ** to block for up to M milliseconds before failing when attempting to
|
|
jpayne@69
|
1147 ** obtain a file lock using the xLock or xShmLock methods of the VFS.
|
|
jpayne@69
|
1148 ** The parameter is a pointer to a 32-bit signed integer that contains
|
|
jpayne@69
|
1149 ** the value that M is to be set to. Before returning, the 32-bit signed
|
|
jpayne@69
|
1150 ** integer is overwritten with the previous value of M.
|
|
jpayne@69
|
1151 **
|
|
jpayne@69
|
1152 ** <li>[[SQLITE_FCNTL_DATA_VERSION]]
|
|
jpayne@69
|
1153 ** The [SQLITE_FCNTL_DATA_VERSION] opcode is used to detect changes to
|
|
jpayne@69
|
1154 ** a database file. The argument is a pointer to a 32-bit unsigned integer.
|
|
jpayne@69
|
1155 ** The "data version" for the pager is written into the pointer. The
|
|
jpayne@69
|
1156 ** "data version" changes whenever any change occurs to the corresponding
|
|
jpayne@69
|
1157 ** database file, either through SQL statements on the same database
|
|
jpayne@69
|
1158 ** connection or through transactions committed by separate database
|
|
jpayne@69
|
1159 ** connections possibly in other processes. The [sqlite3_total_changes()]
|
|
jpayne@69
|
1160 ** interface can be used to find if any database on the connection has changed,
|
|
jpayne@69
|
1161 ** but that interface responds to changes on TEMP as well as MAIN and does
|
|
jpayne@69
|
1162 ** not provide a mechanism to detect changes to MAIN only. Also, the
|
|
jpayne@69
|
1163 ** [sqlite3_total_changes()] interface responds to internal changes only and
|
|
jpayne@69
|
1164 ** omits changes made by other database connections. The
|
|
jpayne@69
|
1165 ** [PRAGMA data_version] command provides a mechanism to detect changes to
|
|
jpayne@69
|
1166 ** a single attached database that occur due to other database connections,
|
|
jpayne@69
|
1167 ** but omits changes implemented by the database connection on which it is
|
|
jpayne@69
|
1168 ** called. This file control is the only mechanism to detect changes that
|
|
jpayne@69
|
1169 ** happen either internally or externally and that are associated with
|
|
jpayne@69
|
1170 ** a particular attached database.
|
|
jpayne@69
|
1171 **
|
|
jpayne@69
|
1172 ** <li>[[SQLITE_FCNTL_CKPT_START]]
|
|
jpayne@69
|
1173 ** The [SQLITE_FCNTL_CKPT_START] opcode is invoked from within a checkpoint
|
|
jpayne@69
|
1174 ** in wal mode before the client starts to copy pages from the wal
|
|
jpayne@69
|
1175 ** file to the database file.
|
|
jpayne@69
|
1176 **
|
|
jpayne@69
|
1177 ** <li>[[SQLITE_FCNTL_CKPT_DONE]]
|
|
jpayne@69
|
1178 ** The [SQLITE_FCNTL_CKPT_DONE] opcode is invoked from within a checkpoint
|
|
jpayne@69
|
1179 ** in wal mode after the client has finished copying pages from the wal
|
|
jpayne@69
|
1180 ** file to the database file, but before the *-shm file is updated to
|
|
jpayne@69
|
1181 ** record the fact that the pages have been checkpointed.
|
|
jpayne@69
|
1182 **
|
|
jpayne@69
|
1183 ** <li>[[SQLITE_FCNTL_EXTERNAL_READER]]
|
|
jpayne@69
|
1184 ** The EXPERIMENTAL [SQLITE_FCNTL_EXTERNAL_READER] opcode is used to detect
|
|
jpayne@69
|
1185 ** whether or not there is a database client in another process with a wal-mode
|
|
jpayne@69
|
1186 ** transaction open on the database or not. It is only available on unix.The
|
|
jpayne@69
|
1187 ** (void*) argument passed with this file-control should be a pointer to a
|
|
jpayne@69
|
1188 ** value of type (int). The integer value is set to 1 if the database is a wal
|
|
jpayne@69
|
1189 ** mode database and there exists at least one client in another process that
|
|
jpayne@69
|
1190 ** currently has an SQL transaction open on the database. It is set to 0 if
|
|
jpayne@69
|
1191 ** the database is not a wal-mode db, or if there is no such connection in any
|
|
jpayne@69
|
1192 ** other process. This opcode cannot be used to detect transactions opened
|
|
jpayne@69
|
1193 ** by clients within the current process, only within other processes.
|
|
jpayne@69
|
1194 **
|
|
jpayne@69
|
1195 ** <li>[[SQLITE_FCNTL_CKSM_FILE]]
|
|
jpayne@69
|
1196 ** The [SQLITE_FCNTL_CKSM_FILE] opcode is for use internally by the
|
|
jpayne@69
|
1197 ** [checksum VFS shim] only.
|
|
jpayne@69
|
1198 **
|
|
jpayne@69
|
1199 ** <li>[[SQLITE_FCNTL_RESET_CACHE]]
|
|
jpayne@69
|
1200 ** If there is currently no transaction open on the database, and the
|
|
jpayne@69
|
1201 ** database is not a temp db, then the [SQLITE_FCNTL_RESET_CACHE] file-control
|
|
jpayne@69
|
1202 ** purges the contents of the in-memory page cache. If there is an open
|
|
jpayne@69
|
1203 ** transaction, or if the db is a temp-db, this opcode is a no-op, not an error.
|
|
jpayne@69
|
1204 ** </ul>
|
|
jpayne@69
|
1205 */
|
|
jpayne@69
|
1206 #define SQLITE_FCNTL_LOCKSTATE 1
|
|
jpayne@69
|
1207 #define SQLITE_FCNTL_GET_LOCKPROXYFILE 2
|
|
jpayne@69
|
1208 #define SQLITE_FCNTL_SET_LOCKPROXYFILE 3
|
|
jpayne@69
|
1209 #define SQLITE_FCNTL_LAST_ERRNO 4
|
|
jpayne@69
|
1210 #define SQLITE_FCNTL_SIZE_HINT 5
|
|
jpayne@69
|
1211 #define SQLITE_FCNTL_CHUNK_SIZE 6
|
|
jpayne@69
|
1212 #define SQLITE_FCNTL_FILE_POINTER 7
|
|
jpayne@69
|
1213 #define SQLITE_FCNTL_SYNC_OMITTED 8
|
|
jpayne@69
|
1214 #define SQLITE_FCNTL_WIN32_AV_RETRY 9
|
|
jpayne@69
|
1215 #define SQLITE_FCNTL_PERSIST_WAL 10
|
|
jpayne@69
|
1216 #define SQLITE_FCNTL_OVERWRITE 11
|
|
jpayne@69
|
1217 #define SQLITE_FCNTL_VFSNAME 12
|
|
jpayne@69
|
1218 #define SQLITE_FCNTL_POWERSAFE_OVERWRITE 13
|
|
jpayne@69
|
1219 #define SQLITE_FCNTL_PRAGMA 14
|
|
jpayne@69
|
1220 #define SQLITE_FCNTL_BUSYHANDLER 15
|
|
jpayne@69
|
1221 #define SQLITE_FCNTL_TEMPFILENAME 16
|
|
jpayne@69
|
1222 #define SQLITE_FCNTL_MMAP_SIZE 18
|
|
jpayne@69
|
1223 #define SQLITE_FCNTL_TRACE 19
|
|
jpayne@69
|
1224 #define SQLITE_FCNTL_HAS_MOVED 20
|
|
jpayne@69
|
1225 #define SQLITE_FCNTL_SYNC 21
|
|
jpayne@69
|
1226 #define SQLITE_FCNTL_COMMIT_PHASETWO 22
|
|
jpayne@69
|
1227 #define SQLITE_FCNTL_WIN32_SET_HANDLE 23
|
|
jpayne@69
|
1228 #define SQLITE_FCNTL_WAL_BLOCK 24
|
|
jpayne@69
|
1229 #define SQLITE_FCNTL_ZIPVFS 25
|
|
jpayne@69
|
1230 #define SQLITE_FCNTL_RBU 26
|
|
jpayne@69
|
1231 #define SQLITE_FCNTL_VFS_POINTER 27
|
|
jpayne@69
|
1232 #define SQLITE_FCNTL_JOURNAL_POINTER 28
|
|
jpayne@69
|
1233 #define SQLITE_FCNTL_WIN32_GET_HANDLE 29
|
|
jpayne@69
|
1234 #define SQLITE_FCNTL_PDB 30
|
|
jpayne@69
|
1235 #define SQLITE_FCNTL_BEGIN_ATOMIC_WRITE 31
|
|
jpayne@69
|
1236 #define SQLITE_FCNTL_COMMIT_ATOMIC_WRITE 32
|
|
jpayne@69
|
1237 #define SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE 33
|
|
jpayne@69
|
1238 #define SQLITE_FCNTL_LOCK_TIMEOUT 34
|
|
jpayne@69
|
1239 #define SQLITE_FCNTL_DATA_VERSION 35
|
|
jpayne@69
|
1240 #define SQLITE_FCNTL_SIZE_LIMIT 36
|
|
jpayne@69
|
1241 #define SQLITE_FCNTL_CKPT_DONE 37
|
|
jpayne@69
|
1242 #define SQLITE_FCNTL_RESERVE_BYTES 38
|
|
jpayne@69
|
1243 #define SQLITE_FCNTL_CKPT_START 39
|
|
jpayne@69
|
1244 #define SQLITE_FCNTL_EXTERNAL_READER 40
|
|
jpayne@69
|
1245 #define SQLITE_FCNTL_CKSM_FILE 41
|
|
jpayne@69
|
1246 #define SQLITE_FCNTL_RESET_CACHE 42
|
|
jpayne@69
|
1247
|
|
jpayne@69
|
1248 /* deprecated names */
|
|
jpayne@69
|
1249 #define SQLITE_GET_LOCKPROXYFILE SQLITE_FCNTL_GET_LOCKPROXYFILE
|
|
jpayne@69
|
1250 #define SQLITE_SET_LOCKPROXYFILE SQLITE_FCNTL_SET_LOCKPROXYFILE
|
|
jpayne@69
|
1251 #define SQLITE_LAST_ERRNO SQLITE_FCNTL_LAST_ERRNO
|
|
jpayne@69
|
1252
|
|
jpayne@69
|
1253
|
|
jpayne@69
|
1254 /*
|
|
jpayne@69
|
1255 ** CAPI3REF: Mutex Handle
|
|
jpayne@69
|
1256 **
|
|
jpayne@69
|
1257 ** The mutex module within SQLite defines [sqlite3_mutex] to be an
|
|
jpayne@69
|
1258 ** abstract type for a mutex object. The SQLite core never looks
|
|
jpayne@69
|
1259 ** at the internal representation of an [sqlite3_mutex]. It only
|
|
jpayne@69
|
1260 ** deals with pointers to the [sqlite3_mutex] object.
|
|
jpayne@69
|
1261 **
|
|
jpayne@69
|
1262 ** Mutexes are created using [sqlite3_mutex_alloc()].
|
|
jpayne@69
|
1263 */
|
|
jpayne@69
|
1264 typedef struct sqlite3_mutex sqlite3_mutex;
|
|
jpayne@69
|
1265
|
|
jpayne@69
|
1266 /*
|
|
jpayne@69
|
1267 ** CAPI3REF: Loadable Extension Thunk
|
|
jpayne@69
|
1268 **
|
|
jpayne@69
|
1269 ** A pointer to the opaque sqlite3_api_routines structure is passed as
|
|
jpayne@69
|
1270 ** the third parameter to entry points of [loadable extensions]. This
|
|
jpayne@69
|
1271 ** structure must be typedefed in order to work around compiler warnings
|
|
jpayne@69
|
1272 ** on some platforms.
|
|
jpayne@69
|
1273 */
|
|
jpayne@69
|
1274 typedef struct sqlite3_api_routines sqlite3_api_routines;
|
|
jpayne@69
|
1275
|
|
jpayne@69
|
1276 /*
|
|
jpayne@69
|
1277 ** CAPI3REF: File Name
|
|
jpayne@69
|
1278 **
|
|
jpayne@69
|
1279 ** Type [sqlite3_filename] is used by SQLite to pass filenames to the
|
|
jpayne@69
|
1280 ** xOpen method of a [VFS]. It may be cast to (const char*) and treated
|
|
jpayne@69
|
1281 ** as a normal, nul-terminated, UTF-8 buffer containing the filename, but
|
|
jpayne@69
|
1282 ** may also be passed to special APIs such as:
|
|
jpayne@69
|
1283 **
|
|
jpayne@69
|
1284 ** <ul>
|
|
jpayne@69
|
1285 ** <li> sqlite3_filename_database()
|
|
jpayne@69
|
1286 ** <li> sqlite3_filename_journal()
|
|
jpayne@69
|
1287 ** <li> sqlite3_filename_wal()
|
|
jpayne@69
|
1288 ** <li> sqlite3_uri_parameter()
|
|
jpayne@69
|
1289 ** <li> sqlite3_uri_boolean()
|
|
jpayne@69
|
1290 ** <li> sqlite3_uri_int64()
|
|
jpayne@69
|
1291 ** <li> sqlite3_uri_key()
|
|
jpayne@69
|
1292 ** </ul>
|
|
jpayne@69
|
1293 */
|
|
jpayne@69
|
1294 typedef const char *sqlite3_filename;
|
|
jpayne@69
|
1295
|
|
jpayne@69
|
1296 /*
|
|
jpayne@69
|
1297 ** CAPI3REF: OS Interface Object
|
|
jpayne@69
|
1298 **
|
|
jpayne@69
|
1299 ** An instance of the sqlite3_vfs object defines the interface between
|
|
jpayne@69
|
1300 ** the SQLite core and the underlying operating system. The "vfs"
|
|
jpayne@69
|
1301 ** in the name of the object stands for "virtual file system". See
|
|
jpayne@69
|
1302 ** the [VFS | VFS documentation] for further information.
|
|
jpayne@69
|
1303 **
|
|
jpayne@69
|
1304 ** The VFS interface is sometimes extended by adding new methods onto
|
|
jpayne@69
|
1305 ** the end. Each time such an extension occurs, the iVersion field
|
|
jpayne@69
|
1306 ** is incremented. The iVersion value started out as 1 in
|
|
jpayne@69
|
1307 ** SQLite [version 3.5.0] on [dateof:3.5.0], then increased to 2
|
|
jpayne@69
|
1308 ** with SQLite [version 3.7.0] on [dateof:3.7.0], and then increased
|
|
jpayne@69
|
1309 ** to 3 with SQLite [version 3.7.6] on [dateof:3.7.6]. Additional fields
|
|
jpayne@69
|
1310 ** may be appended to the sqlite3_vfs object and the iVersion value
|
|
jpayne@69
|
1311 ** may increase again in future versions of SQLite.
|
|
jpayne@69
|
1312 ** Note that due to an oversight, the structure
|
|
jpayne@69
|
1313 ** of the sqlite3_vfs object changed in the transition from
|
|
jpayne@69
|
1314 ** SQLite [version 3.5.9] to [version 3.6.0] on [dateof:3.6.0]
|
|
jpayne@69
|
1315 ** and yet the iVersion field was not increased.
|
|
jpayne@69
|
1316 **
|
|
jpayne@69
|
1317 ** The szOsFile field is the size of the subclassed [sqlite3_file]
|
|
jpayne@69
|
1318 ** structure used by this VFS. mxPathname is the maximum length of
|
|
jpayne@69
|
1319 ** a pathname in this VFS.
|
|
jpayne@69
|
1320 **
|
|
jpayne@69
|
1321 ** Registered sqlite3_vfs objects are kept on a linked list formed by
|
|
jpayne@69
|
1322 ** the pNext pointer. The [sqlite3_vfs_register()]
|
|
jpayne@69
|
1323 ** and [sqlite3_vfs_unregister()] interfaces manage this list
|
|
jpayne@69
|
1324 ** in a thread-safe way. The [sqlite3_vfs_find()] interface
|
|
jpayne@69
|
1325 ** searches the list. Neither the application code nor the VFS
|
|
jpayne@69
|
1326 ** implementation should use the pNext pointer.
|
|
jpayne@69
|
1327 **
|
|
jpayne@69
|
1328 ** The pNext field is the only field in the sqlite3_vfs
|
|
jpayne@69
|
1329 ** structure that SQLite will ever modify. SQLite will only access
|
|
jpayne@69
|
1330 ** or modify this field while holding a particular static mutex.
|
|
jpayne@69
|
1331 ** The application should never modify anything within the sqlite3_vfs
|
|
jpayne@69
|
1332 ** object once the object has been registered.
|
|
jpayne@69
|
1333 **
|
|
jpayne@69
|
1334 ** The zName field holds the name of the VFS module. The name must
|
|
jpayne@69
|
1335 ** be unique across all VFS modules.
|
|
jpayne@69
|
1336 **
|
|
jpayne@69
|
1337 ** [[sqlite3_vfs.xOpen]]
|
|
jpayne@69
|
1338 ** ^SQLite guarantees that the zFilename parameter to xOpen
|
|
jpayne@69
|
1339 ** is either a NULL pointer or string obtained
|
|
jpayne@69
|
1340 ** from xFullPathname() with an optional suffix added.
|
|
jpayne@69
|
1341 ** ^If a suffix is added to the zFilename parameter, it will
|
|
jpayne@69
|
1342 ** consist of a single "-" character followed by no more than
|
|
jpayne@69
|
1343 ** 11 alphanumeric and/or "-" characters.
|
|
jpayne@69
|
1344 ** ^SQLite further guarantees that
|
|
jpayne@69
|
1345 ** the string will be valid and unchanged until xClose() is
|
|
jpayne@69
|
1346 ** called. Because of the previous sentence,
|
|
jpayne@69
|
1347 ** the [sqlite3_file] can safely store a pointer to the
|
|
jpayne@69
|
1348 ** filename if it needs to remember the filename for some reason.
|
|
jpayne@69
|
1349 ** If the zFilename parameter to xOpen is a NULL pointer then xOpen
|
|
jpayne@69
|
1350 ** must invent its own temporary name for the file. ^Whenever the
|
|
jpayne@69
|
1351 ** xFilename parameter is NULL it will also be the case that the
|
|
jpayne@69
|
1352 ** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE].
|
|
jpayne@69
|
1353 **
|
|
jpayne@69
|
1354 ** The flags argument to xOpen() includes all bits set in
|
|
jpayne@69
|
1355 ** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()]
|
|
jpayne@69
|
1356 ** or [sqlite3_open16()] is used, then flags includes at least
|
|
jpayne@69
|
1357 ** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE].
|
|
jpayne@69
|
1358 ** If xOpen() opens a file read-only then it sets *pOutFlags to
|
|
jpayne@69
|
1359 ** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set.
|
|
jpayne@69
|
1360 **
|
|
jpayne@69
|
1361 ** ^(SQLite will also add one of the following flags to the xOpen()
|
|
jpayne@69
|
1362 ** call, depending on the object being opened:
|
|
jpayne@69
|
1363 **
|
|
jpayne@69
|
1364 ** <ul>
|
|
jpayne@69
|
1365 ** <li> [SQLITE_OPEN_MAIN_DB]
|
|
jpayne@69
|
1366 ** <li> [SQLITE_OPEN_MAIN_JOURNAL]
|
|
jpayne@69
|
1367 ** <li> [SQLITE_OPEN_TEMP_DB]
|
|
jpayne@69
|
1368 ** <li> [SQLITE_OPEN_TEMP_JOURNAL]
|
|
jpayne@69
|
1369 ** <li> [SQLITE_OPEN_TRANSIENT_DB]
|
|
jpayne@69
|
1370 ** <li> [SQLITE_OPEN_SUBJOURNAL]
|
|
jpayne@69
|
1371 ** <li> [SQLITE_OPEN_SUPER_JOURNAL]
|
|
jpayne@69
|
1372 ** <li> [SQLITE_OPEN_WAL]
|
|
jpayne@69
|
1373 ** </ul>)^
|
|
jpayne@69
|
1374 **
|
|
jpayne@69
|
1375 ** The file I/O implementation can use the object type flags to
|
|
jpayne@69
|
1376 ** change the way it deals with files. For example, an application
|
|
jpayne@69
|
1377 ** that does not care about crash recovery or rollback might make
|
|
jpayne@69
|
1378 ** the open of a journal file a no-op. Writes to this journal would
|
|
jpayne@69
|
1379 ** also be no-ops, and any attempt to read the journal would return
|
|
jpayne@69
|
1380 ** SQLITE_IOERR. Or the implementation might recognize that a database
|
|
jpayne@69
|
1381 ** file will be doing page-aligned sector reads and writes in a random
|
|
jpayne@69
|
1382 ** order and set up its I/O subsystem accordingly.
|
|
jpayne@69
|
1383 **
|
|
jpayne@69
|
1384 ** SQLite might also add one of the following flags to the xOpen method:
|
|
jpayne@69
|
1385 **
|
|
jpayne@69
|
1386 ** <ul>
|
|
jpayne@69
|
1387 ** <li> [SQLITE_OPEN_DELETEONCLOSE]
|
|
jpayne@69
|
1388 ** <li> [SQLITE_OPEN_EXCLUSIVE]
|
|
jpayne@69
|
1389 ** </ul>
|
|
jpayne@69
|
1390 **
|
|
jpayne@69
|
1391 ** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be
|
|
jpayne@69
|
1392 ** deleted when it is closed. ^The [SQLITE_OPEN_DELETEONCLOSE]
|
|
jpayne@69
|
1393 ** will be set for TEMP databases and their journals, transient
|
|
jpayne@69
|
1394 ** databases, and subjournals.
|
|
jpayne@69
|
1395 **
|
|
jpayne@69
|
1396 ** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction
|
|
jpayne@69
|
1397 ** with the [SQLITE_OPEN_CREATE] flag, which are both directly
|
|
jpayne@69
|
1398 ** analogous to the O_EXCL and O_CREAT flags of the POSIX open()
|
|
jpayne@69
|
1399 ** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the
|
|
jpayne@69
|
1400 ** SQLITE_OPEN_CREATE, is used to indicate that file should always
|
|
jpayne@69
|
1401 ** be created, and that it is an error if it already exists.
|
|
jpayne@69
|
1402 ** It is <i>not</i> used to indicate the file should be opened
|
|
jpayne@69
|
1403 ** for exclusive access.
|
|
jpayne@69
|
1404 **
|
|
jpayne@69
|
1405 ** ^At least szOsFile bytes of memory are allocated by SQLite
|
|
jpayne@69
|
1406 ** to hold the [sqlite3_file] structure passed as the third
|
|
jpayne@69
|
1407 ** argument to xOpen. The xOpen method does not have to
|
|
jpayne@69
|
1408 ** allocate the structure; it should just fill it in. Note that
|
|
jpayne@69
|
1409 ** the xOpen method must set the sqlite3_file.pMethods to either
|
|
jpayne@69
|
1410 ** a valid [sqlite3_io_methods] object or to NULL. xOpen must do
|
|
jpayne@69
|
1411 ** this even if the open fails. SQLite expects that the sqlite3_file.pMethods
|
|
jpayne@69
|
1412 ** element will be valid after xOpen returns regardless of the success
|
|
jpayne@69
|
1413 ** or failure of the xOpen call.
|
|
jpayne@69
|
1414 **
|
|
jpayne@69
|
1415 ** [[sqlite3_vfs.xAccess]]
|
|
jpayne@69
|
1416 ** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS]
|
|
jpayne@69
|
1417 ** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to
|
|
jpayne@69
|
1418 ** test whether a file is readable and writable, or [SQLITE_ACCESS_READ]
|
|
jpayne@69
|
1419 ** to test whether a file is at least readable. The SQLITE_ACCESS_READ
|
|
jpayne@69
|
1420 ** flag is never actually used and is not implemented in the built-in
|
|
jpayne@69
|
1421 ** VFSes of SQLite. The file is named by the second argument and can be a
|
|
jpayne@69
|
1422 ** directory. The xAccess method returns [SQLITE_OK] on success or some
|
|
jpayne@69
|
1423 ** non-zero error code if there is an I/O error or if the name of
|
|
jpayne@69
|
1424 ** the file given in the second argument is illegal. If SQLITE_OK
|
|
jpayne@69
|
1425 ** is returned, then non-zero or zero is written into *pResOut to indicate
|
|
jpayne@69
|
1426 ** whether or not the file is accessible.
|
|
jpayne@69
|
1427 **
|
|
jpayne@69
|
1428 ** ^SQLite will always allocate at least mxPathname+1 bytes for the
|
|
jpayne@69
|
1429 ** output buffer xFullPathname. The exact size of the output buffer
|
|
jpayne@69
|
1430 ** is also passed as a parameter to both methods. If the output buffer
|
|
jpayne@69
|
1431 ** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is
|
|
jpayne@69
|
1432 ** handled as a fatal error by SQLite, vfs implementations should endeavor
|
|
jpayne@69
|
1433 ** to prevent this by setting mxPathname to a sufficiently large value.
|
|
jpayne@69
|
1434 **
|
|
jpayne@69
|
1435 ** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64()
|
|
jpayne@69
|
1436 ** interfaces are not strictly a part of the filesystem, but they are
|
|
jpayne@69
|
1437 ** included in the VFS structure for completeness.
|
|
jpayne@69
|
1438 ** The xRandomness() function attempts to return nBytes bytes
|
|
jpayne@69
|
1439 ** of good-quality randomness into zOut. The return value is
|
|
jpayne@69
|
1440 ** the actual number of bytes of randomness obtained.
|
|
jpayne@69
|
1441 ** The xSleep() method causes the calling thread to sleep for at
|
|
jpayne@69
|
1442 ** least the number of microseconds given. ^The xCurrentTime()
|
|
jpayne@69
|
1443 ** method returns a Julian Day Number for the current date and time as
|
|
jpayne@69
|
1444 ** a floating point value.
|
|
jpayne@69
|
1445 ** ^The xCurrentTimeInt64() method returns, as an integer, the Julian
|
|
jpayne@69
|
1446 ** Day Number multiplied by 86400000 (the number of milliseconds in
|
|
jpayne@69
|
1447 ** a 24-hour day).
|
|
jpayne@69
|
1448 ** ^SQLite will use the xCurrentTimeInt64() method to get the current
|
|
jpayne@69
|
1449 ** date and time if that method is available (if iVersion is 2 or
|
|
jpayne@69
|
1450 ** greater and the function pointer is not NULL) and will fall back
|
|
jpayne@69
|
1451 ** to xCurrentTime() if xCurrentTimeInt64() is unavailable.
|
|
jpayne@69
|
1452 **
|
|
jpayne@69
|
1453 ** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces
|
|
jpayne@69
|
1454 ** are not used by the SQLite core. These optional interfaces are provided
|
|
jpayne@69
|
1455 ** by some VFSes to facilitate testing of the VFS code. By overriding
|
|
jpayne@69
|
1456 ** system calls with functions under its control, a test program can
|
|
jpayne@69
|
1457 ** simulate faults and error conditions that would otherwise be difficult
|
|
jpayne@69
|
1458 ** or impossible to induce. The set of system calls that can be overridden
|
|
jpayne@69
|
1459 ** varies from one VFS to another, and from one version of the same VFS to the
|
|
jpayne@69
|
1460 ** next. Applications that use these interfaces must be prepared for any
|
|
jpayne@69
|
1461 ** or all of these interfaces to be NULL or for their behavior to change
|
|
jpayne@69
|
1462 ** from one release to the next. Applications must not attempt to access
|
|
jpayne@69
|
1463 ** any of these methods if the iVersion of the VFS is less than 3.
|
|
jpayne@69
|
1464 */
|
|
jpayne@69
|
1465 typedef struct sqlite3_vfs sqlite3_vfs;
|
|
jpayne@69
|
1466 typedef void (*sqlite3_syscall_ptr)(void);
|
|
jpayne@69
|
1467 struct sqlite3_vfs {
|
|
jpayne@69
|
1468 int iVersion; /* Structure version number (currently 3) */
|
|
jpayne@69
|
1469 int szOsFile; /* Size of subclassed sqlite3_file */
|
|
jpayne@69
|
1470 int mxPathname; /* Maximum file pathname length */
|
|
jpayne@69
|
1471 sqlite3_vfs *pNext; /* Next registered VFS */
|
|
jpayne@69
|
1472 const char *zName; /* Name of this virtual file system */
|
|
jpayne@69
|
1473 void *pAppData; /* Pointer to application-specific data */
|
|
jpayne@69
|
1474 int (*xOpen)(sqlite3_vfs*, sqlite3_filename zName, sqlite3_file*,
|
|
jpayne@69
|
1475 int flags, int *pOutFlags);
|
|
jpayne@69
|
1476 int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir);
|
|
jpayne@69
|
1477 int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut);
|
|
jpayne@69
|
1478 int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut);
|
|
jpayne@69
|
1479 void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename);
|
|
jpayne@69
|
1480 void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg);
|
|
jpayne@69
|
1481 void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void);
|
|
jpayne@69
|
1482 void (*xDlClose)(sqlite3_vfs*, void*);
|
|
jpayne@69
|
1483 int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut);
|
|
jpayne@69
|
1484 int (*xSleep)(sqlite3_vfs*, int microseconds);
|
|
jpayne@69
|
1485 int (*xCurrentTime)(sqlite3_vfs*, double*);
|
|
jpayne@69
|
1486 int (*xGetLastError)(sqlite3_vfs*, int, char *);
|
|
jpayne@69
|
1487 /*
|
|
jpayne@69
|
1488 ** The methods above are in version 1 of the sqlite_vfs object
|
|
jpayne@69
|
1489 ** definition. Those that follow are added in version 2 or later
|
|
jpayne@69
|
1490 */
|
|
jpayne@69
|
1491 int (*xCurrentTimeInt64)(sqlite3_vfs*, sqlite3_int64*);
|
|
jpayne@69
|
1492 /*
|
|
jpayne@69
|
1493 ** The methods above are in versions 1 and 2 of the sqlite_vfs object.
|
|
jpayne@69
|
1494 ** Those below are for version 3 and greater.
|
|
jpayne@69
|
1495 */
|
|
jpayne@69
|
1496 int (*xSetSystemCall)(sqlite3_vfs*, const char *zName, sqlite3_syscall_ptr);
|
|
jpayne@69
|
1497 sqlite3_syscall_ptr (*xGetSystemCall)(sqlite3_vfs*, const char *zName);
|
|
jpayne@69
|
1498 const char *(*xNextSystemCall)(sqlite3_vfs*, const char *zName);
|
|
jpayne@69
|
1499 /*
|
|
jpayne@69
|
1500 ** The methods above are in versions 1 through 3 of the sqlite_vfs object.
|
|
jpayne@69
|
1501 ** New fields may be appended in future versions. The iVersion
|
|
jpayne@69
|
1502 ** value will increment whenever this happens.
|
|
jpayne@69
|
1503 */
|
|
jpayne@69
|
1504 };
|
|
jpayne@69
|
1505
|
|
jpayne@69
|
1506 /*
|
|
jpayne@69
|
1507 ** CAPI3REF: Flags for the xAccess VFS method
|
|
jpayne@69
|
1508 **
|
|
jpayne@69
|
1509 ** These integer constants can be used as the third parameter to
|
|
jpayne@69
|
1510 ** the xAccess method of an [sqlite3_vfs] object. They determine
|
|
jpayne@69
|
1511 ** what kind of permissions the xAccess method is looking for.
|
|
jpayne@69
|
1512 ** With SQLITE_ACCESS_EXISTS, the xAccess method
|
|
jpayne@69
|
1513 ** simply checks whether the file exists.
|
|
jpayne@69
|
1514 ** With SQLITE_ACCESS_READWRITE, the xAccess method
|
|
jpayne@69
|
1515 ** checks whether the named directory is both readable and writable
|
|
jpayne@69
|
1516 ** (in other words, if files can be added, removed, and renamed within
|
|
jpayne@69
|
1517 ** the directory).
|
|
jpayne@69
|
1518 ** The SQLITE_ACCESS_READWRITE constant is currently used only by the
|
|
jpayne@69
|
1519 ** [temp_store_directory pragma], though this could change in a future
|
|
jpayne@69
|
1520 ** release of SQLite.
|
|
jpayne@69
|
1521 ** With SQLITE_ACCESS_READ, the xAccess method
|
|
jpayne@69
|
1522 ** checks whether the file is readable. The SQLITE_ACCESS_READ constant is
|
|
jpayne@69
|
1523 ** currently unused, though it might be used in a future release of
|
|
jpayne@69
|
1524 ** SQLite.
|
|
jpayne@69
|
1525 */
|
|
jpayne@69
|
1526 #define SQLITE_ACCESS_EXISTS 0
|
|
jpayne@69
|
1527 #define SQLITE_ACCESS_READWRITE 1 /* Used by PRAGMA temp_store_directory */
|
|
jpayne@69
|
1528 #define SQLITE_ACCESS_READ 2 /* Unused */
|
|
jpayne@69
|
1529
|
|
jpayne@69
|
1530 /*
|
|
jpayne@69
|
1531 ** CAPI3REF: Flags for the xShmLock VFS method
|
|
jpayne@69
|
1532 **
|
|
jpayne@69
|
1533 ** These integer constants define the various locking operations
|
|
jpayne@69
|
1534 ** allowed by the xShmLock method of [sqlite3_io_methods]. The
|
|
jpayne@69
|
1535 ** following are the only legal combinations of flags to the
|
|
jpayne@69
|
1536 ** xShmLock method:
|
|
jpayne@69
|
1537 **
|
|
jpayne@69
|
1538 ** <ul>
|
|
jpayne@69
|
1539 ** <li> SQLITE_SHM_LOCK | SQLITE_SHM_SHARED
|
|
jpayne@69
|
1540 ** <li> SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE
|
|
jpayne@69
|
1541 ** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED
|
|
jpayne@69
|
1542 ** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE
|
|
jpayne@69
|
1543 ** </ul>
|
|
jpayne@69
|
1544 **
|
|
jpayne@69
|
1545 ** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as
|
|
jpayne@69
|
1546 ** was given on the corresponding lock.
|
|
jpayne@69
|
1547 **
|
|
jpayne@69
|
1548 ** The xShmLock method can transition between unlocked and SHARED or
|
|
jpayne@69
|
1549 ** between unlocked and EXCLUSIVE. It cannot transition between SHARED
|
|
jpayne@69
|
1550 ** and EXCLUSIVE.
|
|
jpayne@69
|
1551 */
|
|
jpayne@69
|
1552 #define SQLITE_SHM_UNLOCK 1
|
|
jpayne@69
|
1553 #define SQLITE_SHM_LOCK 2
|
|
jpayne@69
|
1554 #define SQLITE_SHM_SHARED 4
|
|
jpayne@69
|
1555 #define SQLITE_SHM_EXCLUSIVE 8
|
|
jpayne@69
|
1556
|
|
jpayne@69
|
1557 /*
|
|
jpayne@69
|
1558 ** CAPI3REF: Maximum xShmLock index
|
|
jpayne@69
|
1559 **
|
|
jpayne@69
|
1560 ** The xShmLock method on [sqlite3_io_methods] may use values
|
|
jpayne@69
|
1561 ** between 0 and this upper bound as its "offset" argument.
|
|
jpayne@69
|
1562 ** The SQLite core will never attempt to acquire or release a
|
|
jpayne@69
|
1563 ** lock outside of this range
|
|
jpayne@69
|
1564 */
|
|
jpayne@69
|
1565 #define SQLITE_SHM_NLOCK 8
|
|
jpayne@69
|
1566
|
|
jpayne@69
|
1567
|
|
jpayne@69
|
1568 /*
|
|
jpayne@69
|
1569 ** CAPI3REF: Initialize The SQLite Library
|
|
jpayne@69
|
1570 **
|
|
jpayne@69
|
1571 ** ^The sqlite3_initialize() routine initializes the
|
|
jpayne@69
|
1572 ** SQLite library. ^The sqlite3_shutdown() routine
|
|
jpayne@69
|
1573 ** deallocates any resources that were allocated by sqlite3_initialize().
|
|
jpayne@69
|
1574 ** These routines are designed to aid in process initialization and
|
|
jpayne@69
|
1575 ** shutdown on embedded systems. Workstation applications using
|
|
jpayne@69
|
1576 ** SQLite normally do not need to invoke either of these routines.
|
|
jpayne@69
|
1577 **
|
|
jpayne@69
|
1578 ** A call to sqlite3_initialize() is an "effective" call if it is
|
|
jpayne@69
|
1579 ** the first time sqlite3_initialize() is invoked during the lifetime of
|
|
jpayne@69
|
1580 ** the process, or if it is the first time sqlite3_initialize() is invoked
|
|
jpayne@69
|
1581 ** following a call to sqlite3_shutdown(). ^(Only an effective call
|
|
jpayne@69
|
1582 ** of sqlite3_initialize() does any initialization. All other calls
|
|
jpayne@69
|
1583 ** are harmless no-ops.)^
|
|
jpayne@69
|
1584 **
|
|
jpayne@69
|
1585 ** A call to sqlite3_shutdown() is an "effective" call if it is the first
|
|
jpayne@69
|
1586 ** call to sqlite3_shutdown() since the last sqlite3_initialize(). ^(Only
|
|
jpayne@69
|
1587 ** an effective call to sqlite3_shutdown() does any deinitialization.
|
|
jpayne@69
|
1588 ** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^
|
|
jpayne@69
|
1589 **
|
|
jpayne@69
|
1590 ** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown()
|
|
jpayne@69
|
1591 ** is not. The sqlite3_shutdown() interface must only be called from a
|
|
jpayne@69
|
1592 ** single thread. All open [database connections] must be closed and all
|
|
jpayne@69
|
1593 ** other SQLite resources must be deallocated prior to invoking
|
|
jpayne@69
|
1594 ** sqlite3_shutdown().
|
|
jpayne@69
|
1595 **
|
|
jpayne@69
|
1596 ** Among other things, ^sqlite3_initialize() will invoke
|
|
jpayne@69
|
1597 ** sqlite3_os_init(). Similarly, ^sqlite3_shutdown()
|
|
jpayne@69
|
1598 ** will invoke sqlite3_os_end().
|
|
jpayne@69
|
1599 **
|
|
jpayne@69
|
1600 ** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success.
|
|
jpayne@69
|
1601 ** ^If for some reason, sqlite3_initialize() is unable to initialize
|
|
jpayne@69
|
1602 ** the library (perhaps it is unable to allocate a needed resource such
|
|
jpayne@69
|
1603 ** as a mutex) it returns an [error code] other than [SQLITE_OK].
|
|
jpayne@69
|
1604 **
|
|
jpayne@69
|
1605 ** ^The sqlite3_initialize() routine is called internally by many other
|
|
jpayne@69
|
1606 ** SQLite interfaces so that an application usually does not need to
|
|
jpayne@69
|
1607 ** invoke sqlite3_initialize() directly. For example, [sqlite3_open()]
|
|
jpayne@69
|
1608 ** calls sqlite3_initialize() so the SQLite library will be automatically
|
|
jpayne@69
|
1609 ** initialized when [sqlite3_open()] is called if it has not be initialized
|
|
jpayne@69
|
1610 ** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT]
|
|
jpayne@69
|
1611 ** compile-time option, then the automatic calls to sqlite3_initialize()
|
|
jpayne@69
|
1612 ** are omitted and the application must call sqlite3_initialize() directly
|
|
jpayne@69
|
1613 ** prior to using any other SQLite interface. For maximum portability,
|
|
jpayne@69
|
1614 ** it is recommended that applications always invoke sqlite3_initialize()
|
|
jpayne@69
|
1615 ** directly prior to using any other SQLite interface. Future releases
|
|
jpayne@69
|
1616 ** of SQLite may require this. In other words, the behavior exhibited
|
|
jpayne@69
|
1617 ** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the
|
|
jpayne@69
|
1618 ** default behavior in some future release of SQLite.
|
|
jpayne@69
|
1619 **
|
|
jpayne@69
|
1620 ** The sqlite3_os_init() routine does operating-system specific
|
|
jpayne@69
|
1621 ** initialization of the SQLite library. The sqlite3_os_end()
|
|
jpayne@69
|
1622 ** routine undoes the effect of sqlite3_os_init(). Typical tasks
|
|
jpayne@69
|
1623 ** performed by these routines include allocation or deallocation
|
|
jpayne@69
|
1624 ** of static resources, initialization of global variables,
|
|
jpayne@69
|
1625 ** setting up a default [sqlite3_vfs] module, or setting up
|
|
jpayne@69
|
1626 ** a default configuration using [sqlite3_config()].
|
|
jpayne@69
|
1627 **
|
|
jpayne@69
|
1628 ** The application should never invoke either sqlite3_os_init()
|
|
jpayne@69
|
1629 ** or sqlite3_os_end() directly. The application should only invoke
|
|
jpayne@69
|
1630 ** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init()
|
|
jpayne@69
|
1631 ** interface is called automatically by sqlite3_initialize() and
|
|
jpayne@69
|
1632 ** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate
|
|
jpayne@69
|
1633 ** implementations for sqlite3_os_init() and sqlite3_os_end()
|
|
jpayne@69
|
1634 ** are built into SQLite when it is compiled for Unix, Windows, or OS/2.
|
|
jpayne@69
|
1635 ** When [custom builds | built for other platforms]
|
|
jpayne@69
|
1636 ** (using the [SQLITE_OS_OTHER=1] compile-time
|
|
jpayne@69
|
1637 ** option) the application must supply a suitable implementation for
|
|
jpayne@69
|
1638 ** sqlite3_os_init() and sqlite3_os_end(). An application-supplied
|
|
jpayne@69
|
1639 ** implementation of sqlite3_os_init() or sqlite3_os_end()
|
|
jpayne@69
|
1640 ** must return [SQLITE_OK] on success and some other [error code] upon
|
|
jpayne@69
|
1641 ** failure.
|
|
jpayne@69
|
1642 */
|
|
jpayne@69
|
1643 SQLITE_API int sqlite3_initialize(void);
|
|
jpayne@69
|
1644 SQLITE_API int sqlite3_shutdown(void);
|
|
jpayne@69
|
1645 SQLITE_API int sqlite3_os_init(void);
|
|
jpayne@69
|
1646 SQLITE_API int sqlite3_os_end(void);
|
|
jpayne@69
|
1647
|
|
jpayne@69
|
1648 /*
|
|
jpayne@69
|
1649 ** CAPI3REF: Configuring The SQLite Library
|
|
jpayne@69
|
1650 **
|
|
jpayne@69
|
1651 ** The sqlite3_config() interface is used to make global configuration
|
|
jpayne@69
|
1652 ** changes to SQLite in order to tune SQLite to the specific needs of
|
|
jpayne@69
|
1653 ** the application. The default configuration is recommended for most
|
|
jpayne@69
|
1654 ** applications and so this routine is usually not necessary. It is
|
|
jpayne@69
|
1655 ** provided to support rare applications with unusual needs.
|
|
jpayne@69
|
1656 **
|
|
jpayne@69
|
1657 ** <b>The sqlite3_config() interface is not threadsafe. The application
|
|
jpayne@69
|
1658 ** must ensure that no other SQLite interfaces are invoked by other
|
|
jpayne@69
|
1659 ** threads while sqlite3_config() is running.</b>
|
|
jpayne@69
|
1660 **
|
|
jpayne@69
|
1661 ** The first argument to sqlite3_config() is an integer
|
|
jpayne@69
|
1662 ** [configuration option] that determines
|
|
jpayne@69
|
1663 ** what property of SQLite is to be configured. Subsequent arguments
|
|
jpayne@69
|
1664 ** vary depending on the [configuration option]
|
|
jpayne@69
|
1665 ** in the first argument.
|
|
jpayne@69
|
1666 **
|
|
jpayne@69
|
1667 ** For most configuration options, the sqlite3_config() interface
|
|
jpayne@69
|
1668 ** may only be invoked prior to library initialization using
|
|
jpayne@69
|
1669 ** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()].
|
|
jpayne@69
|
1670 ** The exceptional configuration options that may be invoked at any time
|
|
jpayne@69
|
1671 ** are called "anytime configuration options".
|
|
jpayne@69
|
1672 ** ^If sqlite3_config() is called after [sqlite3_initialize()] and before
|
|
jpayne@69
|
1673 ** [sqlite3_shutdown()] with a first argument that is not an anytime
|
|
jpayne@69
|
1674 ** configuration option, then the sqlite3_config() call will return SQLITE_MISUSE.
|
|
jpayne@69
|
1675 ** Note, however, that ^sqlite3_config() can be called as part of the
|
|
jpayne@69
|
1676 ** implementation of an application-defined [sqlite3_os_init()].
|
|
jpayne@69
|
1677 **
|
|
jpayne@69
|
1678 ** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK].
|
|
jpayne@69
|
1679 ** ^If the option is unknown or SQLite is unable to set the option
|
|
jpayne@69
|
1680 ** then this routine returns a non-zero [error code].
|
|
jpayne@69
|
1681 */
|
|
jpayne@69
|
1682 SQLITE_API int sqlite3_config(int, ...);
|
|
jpayne@69
|
1683
|
|
jpayne@69
|
1684 /*
|
|
jpayne@69
|
1685 ** CAPI3REF: Configure database connections
|
|
jpayne@69
|
1686 ** METHOD: sqlite3
|
|
jpayne@69
|
1687 **
|
|
jpayne@69
|
1688 ** The sqlite3_db_config() interface is used to make configuration
|
|
jpayne@69
|
1689 ** changes to a [database connection]. The interface is similar to
|
|
jpayne@69
|
1690 ** [sqlite3_config()] except that the changes apply to a single
|
|
jpayne@69
|
1691 ** [database connection] (specified in the first argument).
|
|
jpayne@69
|
1692 **
|
|
jpayne@69
|
1693 ** The second argument to sqlite3_db_config(D,V,...) is the
|
|
jpayne@69
|
1694 ** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code
|
|
jpayne@69
|
1695 ** that indicates what aspect of the [database connection] is being configured.
|
|
jpayne@69
|
1696 ** Subsequent arguments vary depending on the configuration verb.
|
|
jpayne@69
|
1697 **
|
|
jpayne@69
|
1698 ** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if
|
|
jpayne@69
|
1699 ** the call is considered successful.
|
|
jpayne@69
|
1700 */
|
|
jpayne@69
|
1701 SQLITE_API int sqlite3_db_config(sqlite3*, int op, ...);
|
|
jpayne@69
|
1702
|
|
jpayne@69
|
1703 /*
|
|
jpayne@69
|
1704 ** CAPI3REF: Memory Allocation Routines
|
|
jpayne@69
|
1705 **
|
|
jpayne@69
|
1706 ** An instance of this object defines the interface between SQLite
|
|
jpayne@69
|
1707 ** and low-level memory allocation routines.
|
|
jpayne@69
|
1708 **
|
|
jpayne@69
|
1709 ** This object is used in only one place in the SQLite interface.
|
|
jpayne@69
|
1710 ** A pointer to an instance of this object is the argument to
|
|
jpayne@69
|
1711 ** [sqlite3_config()] when the configuration option is
|
|
jpayne@69
|
1712 ** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC].
|
|
jpayne@69
|
1713 ** By creating an instance of this object
|
|
jpayne@69
|
1714 ** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC])
|
|
jpayne@69
|
1715 ** during configuration, an application can specify an alternative
|
|
jpayne@69
|
1716 ** memory allocation subsystem for SQLite to use for all of its
|
|
jpayne@69
|
1717 ** dynamic memory needs.
|
|
jpayne@69
|
1718 **
|
|
jpayne@69
|
1719 ** Note that SQLite comes with several [built-in memory allocators]
|
|
jpayne@69
|
1720 ** that are perfectly adequate for the overwhelming majority of applications
|
|
jpayne@69
|
1721 ** and that this object is only useful to a tiny minority of applications
|
|
jpayne@69
|
1722 ** with specialized memory allocation requirements. This object is
|
|
jpayne@69
|
1723 ** also used during testing of SQLite in order to specify an alternative
|
|
jpayne@69
|
1724 ** memory allocator that simulates memory out-of-memory conditions in
|
|
jpayne@69
|
1725 ** order to verify that SQLite recovers gracefully from such
|
|
jpayne@69
|
1726 ** conditions.
|
|
jpayne@69
|
1727 **
|
|
jpayne@69
|
1728 ** The xMalloc, xRealloc, and xFree methods must work like the
|
|
jpayne@69
|
1729 ** malloc(), realloc() and free() functions from the standard C library.
|
|
jpayne@69
|
1730 ** ^SQLite guarantees that the second argument to
|
|
jpayne@69
|
1731 ** xRealloc is always a value returned by a prior call to xRoundup.
|
|
jpayne@69
|
1732 **
|
|
jpayne@69
|
1733 ** xSize should return the allocated size of a memory allocation
|
|
jpayne@69
|
1734 ** previously obtained from xMalloc or xRealloc. The allocated size
|
|
jpayne@69
|
1735 ** is always at least as big as the requested size but may be larger.
|
|
jpayne@69
|
1736 **
|
|
jpayne@69
|
1737 ** The xRoundup method returns what would be the allocated size of
|
|
jpayne@69
|
1738 ** a memory allocation given a particular requested size. Most memory
|
|
jpayne@69
|
1739 ** allocators round up memory allocations at least to the next multiple
|
|
jpayne@69
|
1740 ** of 8. Some allocators round up to a larger multiple or to a power of 2.
|
|
jpayne@69
|
1741 ** Every memory allocation request coming in through [sqlite3_malloc()]
|
|
jpayne@69
|
1742 ** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0,
|
|
jpayne@69
|
1743 ** that causes the corresponding memory allocation to fail.
|
|
jpayne@69
|
1744 **
|
|
jpayne@69
|
1745 ** The xInit method initializes the memory allocator. For example,
|
|
jpayne@69
|
1746 ** it might allocate any required mutexes or initialize internal data
|
|
jpayne@69
|
1747 ** structures. The xShutdown method is invoked (indirectly) by
|
|
jpayne@69
|
1748 ** [sqlite3_shutdown()] and should deallocate any resources acquired
|
|
jpayne@69
|
1749 ** by xInit. The pAppData pointer is used as the only parameter to
|
|
jpayne@69
|
1750 ** xInit and xShutdown.
|
|
jpayne@69
|
1751 **
|
|
jpayne@69
|
1752 ** SQLite holds the [SQLITE_MUTEX_STATIC_MAIN] mutex when it invokes
|
|
jpayne@69
|
1753 ** the xInit method, so the xInit method need not be threadsafe. The
|
|
jpayne@69
|
1754 ** xShutdown method is only called from [sqlite3_shutdown()] so it does
|
|
jpayne@69
|
1755 ** not need to be threadsafe either. For all other methods, SQLite
|
|
jpayne@69
|
1756 ** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the
|
|
jpayne@69
|
1757 ** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which
|
|
jpayne@69
|
1758 ** it is by default) and so the methods are automatically serialized.
|
|
jpayne@69
|
1759 ** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other
|
|
jpayne@69
|
1760 ** methods must be threadsafe or else make their own arrangements for
|
|
jpayne@69
|
1761 ** serialization.
|
|
jpayne@69
|
1762 **
|
|
jpayne@69
|
1763 ** SQLite will never invoke xInit() more than once without an intervening
|
|
jpayne@69
|
1764 ** call to xShutdown().
|
|
jpayne@69
|
1765 */
|
|
jpayne@69
|
1766 typedef struct sqlite3_mem_methods sqlite3_mem_methods;
|
|
jpayne@69
|
1767 struct sqlite3_mem_methods {
|
|
jpayne@69
|
1768 void *(*xMalloc)(int); /* Memory allocation function */
|
|
jpayne@69
|
1769 void (*xFree)(void*); /* Free a prior allocation */
|
|
jpayne@69
|
1770 void *(*xRealloc)(void*,int); /* Resize an allocation */
|
|
jpayne@69
|
1771 int (*xSize)(void*); /* Return the size of an allocation */
|
|
jpayne@69
|
1772 int (*xRoundup)(int); /* Round up request size to allocation size */
|
|
jpayne@69
|
1773 int (*xInit)(void*); /* Initialize the memory allocator */
|
|
jpayne@69
|
1774 void (*xShutdown)(void*); /* Deinitialize the memory allocator */
|
|
jpayne@69
|
1775 void *pAppData; /* Argument to xInit() and xShutdown() */
|
|
jpayne@69
|
1776 };
|
|
jpayne@69
|
1777
|
|
jpayne@69
|
1778 /*
|
|
jpayne@69
|
1779 ** CAPI3REF: Configuration Options
|
|
jpayne@69
|
1780 ** KEYWORDS: {configuration option}
|
|
jpayne@69
|
1781 **
|
|
jpayne@69
|
1782 ** These constants are the available integer configuration options that
|
|
jpayne@69
|
1783 ** can be passed as the first argument to the [sqlite3_config()] interface.
|
|
jpayne@69
|
1784 **
|
|
jpayne@69
|
1785 ** Most of the configuration options for sqlite3_config()
|
|
jpayne@69
|
1786 ** will only work if invoked prior to [sqlite3_initialize()] or after
|
|
jpayne@69
|
1787 ** [sqlite3_shutdown()]. The few exceptions to this rule are called
|
|
jpayne@69
|
1788 ** "anytime configuration options".
|
|
jpayne@69
|
1789 ** ^Calling [sqlite3_config()] with a first argument that is not an
|
|
jpayne@69
|
1790 ** anytime configuration option in between calls to [sqlite3_initialize()] and
|
|
jpayne@69
|
1791 ** [sqlite3_shutdown()] is a no-op that returns SQLITE_MISUSE.
|
|
jpayne@69
|
1792 **
|
|
jpayne@69
|
1793 ** The set of anytime configuration options can change (by insertions
|
|
jpayne@69
|
1794 ** and/or deletions) from one release of SQLite to the next.
|
|
jpayne@69
|
1795 ** As of SQLite version 3.42.0, the complete set of anytime configuration
|
|
jpayne@69
|
1796 ** options is:
|
|
jpayne@69
|
1797 ** <ul>
|
|
jpayne@69
|
1798 ** <li> SQLITE_CONFIG_LOG
|
|
jpayne@69
|
1799 ** <li> SQLITE_CONFIG_PCACHE_HDRSZ
|
|
jpayne@69
|
1800 ** </ul>
|
|
jpayne@69
|
1801 **
|
|
jpayne@69
|
1802 ** New configuration options may be added in future releases of SQLite.
|
|
jpayne@69
|
1803 ** Existing configuration options might be discontinued. Applications
|
|
jpayne@69
|
1804 ** should check the return code from [sqlite3_config()] to make sure that
|
|
jpayne@69
|
1805 ** the call worked. The [sqlite3_config()] interface will return a
|
|
jpayne@69
|
1806 ** non-zero [error code] if a discontinued or unsupported configuration option
|
|
jpayne@69
|
1807 ** is invoked.
|
|
jpayne@69
|
1808 **
|
|
jpayne@69
|
1809 ** <dl>
|
|
jpayne@69
|
1810 ** [[SQLITE_CONFIG_SINGLETHREAD]] <dt>SQLITE_CONFIG_SINGLETHREAD</dt>
|
|
jpayne@69
|
1811 ** <dd>There are no arguments to this option. ^This option sets the
|
|
jpayne@69
|
1812 ** [threading mode] to Single-thread. In other words, it disables
|
|
jpayne@69
|
1813 ** all mutexing and puts SQLite into a mode where it can only be used
|
|
jpayne@69
|
1814 ** by a single thread. ^If SQLite is compiled with
|
|
jpayne@69
|
1815 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
|
|
jpayne@69
|
1816 ** it is not possible to change the [threading mode] from its default
|
|
jpayne@69
|
1817 ** value of Single-thread and so [sqlite3_config()] will return
|
|
jpayne@69
|
1818 ** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD
|
|
jpayne@69
|
1819 ** configuration option.</dd>
|
|
jpayne@69
|
1820 **
|
|
jpayne@69
|
1821 ** [[SQLITE_CONFIG_MULTITHREAD]] <dt>SQLITE_CONFIG_MULTITHREAD</dt>
|
|
jpayne@69
|
1822 ** <dd>There are no arguments to this option. ^This option sets the
|
|
jpayne@69
|
1823 ** [threading mode] to Multi-thread. In other words, it disables
|
|
jpayne@69
|
1824 ** mutexing on [database connection] and [prepared statement] objects.
|
|
jpayne@69
|
1825 ** The application is responsible for serializing access to
|
|
jpayne@69
|
1826 ** [database connections] and [prepared statements]. But other mutexes
|
|
jpayne@69
|
1827 ** are enabled so that SQLite will be safe to use in a multi-threaded
|
|
jpayne@69
|
1828 ** environment as long as no two threads attempt to use the same
|
|
jpayne@69
|
1829 ** [database connection] at the same time. ^If SQLite is compiled with
|
|
jpayne@69
|
1830 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
|
|
jpayne@69
|
1831 ** it is not possible to set the Multi-thread [threading mode] and
|
|
jpayne@69
|
1832 ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
|
|
jpayne@69
|
1833 ** SQLITE_CONFIG_MULTITHREAD configuration option.</dd>
|
|
jpayne@69
|
1834 **
|
|
jpayne@69
|
1835 ** [[SQLITE_CONFIG_SERIALIZED]] <dt>SQLITE_CONFIG_SERIALIZED</dt>
|
|
jpayne@69
|
1836 ** <dd>There are no arguments to this option. ^This option sets the
|
|
jpayne@69
|
1837 ** [threading mode] to Serialized. In other words, this option enables
|
|
jpayne@69
|
1838 ** all mutexes including the recursive
|
|
jpayne@69
|
1839 ** mutexes on [database connection] and [prepared statement] objects.
|
|
jpayne@69
|
1840 ** In this mode (which is the default when SQLite is compiled with
|
|
jpayne@69
|
1841 ** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access
|
|
jpayne@69
|
1842 ** to [database connections] and [prepared statements] so that the
|
|
jpayne@69
|
1843 ** application is free to use the same [database connection] or the
|
|
jpayne@69
|
1844 ** same [prepared statement] in different threads at the same time.
|
|
jpayne@69
|
1845 ** ^If SQLite is compiled with
|
|
jpayne@69
|
1846 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
|
|
jpayne@69
|
1847 ** it is not possible to set the Serialized [threading mode] and
|
|
jpayne@69
|
1848 ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
|
|
jpayne@69
|
1849 ** SQLITE_CONFIG_SERIALIZED configuration option.</dd>
|
|
jpayne@69
|
1850 **
|
|
jpayne@69
|
1851 ** [[SQLITE_CONFIG_MALLOC]] <dt>SQLITE_CONFIG_MALLOC</dt>
|
|
jpayne@69
|
1852 ** <dd> ^(The SQLITE_CONFIG_MALLOC option takes a single argument which is
|
|
jpayne@69
|
1853 ** a pointer to an instance of the [sqlite3_mem_methods] structure.
|
|
jpayne@69
|
1854 ** The argument specifies
|
|
jpayne@69
|
1855 ** alternative low-level memory allocation routines to be used in place of
|
|
jpayne@69
|
1856 ** the memory allocation routines built into SQLite.)^ ^SQLite makes
|
|
jpayne@69
|
1857 ** its own private copy of the content of the [sqlite3_mem_methods] structure
|
|
jpayne@69
|
1858 ** before the [sqlite3_config()] call returns.</dd>
|
|
jpayne@69
|
1859 **
|
|
jpayne@69
|
1860 ** [[SQLITE_CONFIG_GETMALLOC]] <dt>SQLITE_CONFIG_GETMALLOC</dt>
|
|
jpayne@69
|
1861 ** <dd> ^(The SQLITE_CONFIG_GETMALLOC option takes a single argument which
|
|
jpayne@69
|
1862 ** is a pointer to an instance of the [sqlite3_mem_methods] structure.
|
|
jpayne@69
|
1863 ** The [sqlite3_mem_methods]
|
|
jpayne@69
|
1864 ** structure is filled with the currently defined memory allocation routines.)^
|
|
jpayne@69
|
1865 ** This option can be used to overload the default memory allocation
|
|
jpayne@69
|
1866 ** routines with a wrapper that simulations memory allocation failure or
|
|
jpayne@69
|
1867 ** tracks memory usage, for example. </dd>
|
|
jpayne@69
|
1868 **
|
|
jpayne@69
|
1869 ** [[SQLITE_CONFIG_SMALL_MALLOC]] <dt>SQLITE_CONFIG_SMALL_MALLOC</dt>
|
|
jpayne@69
|
1870 ** <dd> ^The SQLITE_CONFIG_SMALL_MALLOC option takes single argument of
|
|
jpayne@69
|
1871 ** type int, interpreted as a boolean, which if true provides a hint to
|
|
jpayne@69
|
1872 ** SQLite that it should avoid large memory allocations if possible.
|
|
jpayne@69
|
1873 ** SQLite will run faster if it is free to make large memory allocations,
|
|
jpayne@69
|
1874 ** but some application might prefer to run slower in exchange for
|
|
jpayne@69
|
1875 ** guarantees about memory fragmentation that are possible if large
|
|
jpayne@69
|
1876 ** allocations are avoided. This hint is normally off.
|
|
jpayne@69
|
1877 ** </dd>
|
|
jpayne@69
|
1878 **
|
|
jpayne@69
|
1879 ** [[SQLITE_CONFIG_MEMSTATUS]] <dt>SQLITE_CONFIG_MEMSTATUS</dt>
|
|
jpayne@69
|
1880 ** <dd> ^The SQLITE_CONFIG_MEMSTATUS option takes single argument of type int,
|
|
jpayne@69
|
1881 ** interpreted as a boolean, which enables or disables the collection of
|
|
jpayne@69
|
1882 ** memory allocation statistics. ^(When memory allocation statistics are
|
|
jpayne@69
|
1883 ** disabled, the following SQLite interfaces become non-operational:
|
|
jpayne@69
|
1884 ** <ul>
|
|
jpayne@69
|
1885 ** <li> [sqlite3_hard_heap_limit64()]
|
|
jpayne@69
|
1886 ** <li> [sqlite3_memory_used()]
|
|
jpayne@69
|
1887 ** <li> [sqlite3_memory_highwater()]
|
|
jpayne@69
|
1888 ** <li> [sqlite3_soft_heap_limit64()]
|
|
jpayne@69
|
1889 ** <li> [sqlite3_status64()]
|
|
jpayne@69
|
1890 ** </ul>)^
|
|
jpayne@69
|
1891 ** ^Memory allocation statistics are enabled by default unless SQLite is
|
|
jpayne@69
|
1892 ** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory
|
|
jpayne@69
|
1893 ** allocation statistics are disabled by default.
|
|
jpayne@69
|
1894 ** </dd>
|
|
jpayne@69
|
1895 **
|
|
jpayne@69
|
1896 ** [[SQLITE_CONFIG_SCRATCH]] <dt>SQLITE_CONFIG_SCRATCH</dt>
|
|
jpayne@69
|
1897 ** <dd> The SQLITE_CONFIG_SCRATCH option is no longer used.
|
|
jpayne@69
|
1898 ** </dd>
|
|
jpayne@69
|
1899 **
|
|
jpayne@69
|
1900 ** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt>
|
|
jpayne@69
|
1901 ** <dd> ^The SQLITE_CONFIG_PAGECACHE option specifies a memory pool
|
|
jpayne@69
|
1902 ** that SQLite can use for the database page cache with the default page
|
|
jpayne@69
|
1903 ** cache implementation.
|
|
jpayne@69
|
1904 ** This configuration option is a no-op if an application-defined page
|
|
jpayne@69
|
1905 ** cache implementation is loaded using the [SQLITE_CONFIG_PCACHE2].
|
|
jpayne@69
|
1906 ** ^There are three arguments to SQLITE_CONFIG_PAGECACHE: A pointer to
|
|
jpayne@69
|
1907 ** 8-byte aligned memory (pMem), the size of each page cache line (sz),
|
|
jpayne@69
|
1908 ** and the number of cache lines (N).
|
|
jpayne@69
|
1909 ** The sz argument should be the size of the largest database page
|
|
jpayne@69
|
1910 ** (a power of two between 512 and 65536) plus some extra bytes for each
|
|
jpayne@69
|
1911 ** page header. ^The number of extra bytes needed by the page header
|
|
jpayne@69
|
1912 ** can be determined using [SQLITE_CONFIG_PCACHE_HDRSZ].
|
|
jpayne@69
|
1913 ** ^It is harmless, apart from the wasted memory,
|
|
jpayne@69
|
1914 ** for the sz parameter to be larger than necessary. The pMem
|
|
jpayne@69
|
1915 ** argument must be either a NULL pointer or a pointer to an 8-byte
|
|
jpayne@69
|
1916 ** aligned block of memory of at least sz*N bytes, otherwise
|
|
jpayne@69
|
1917 ** subsequent behavior is undefined.
|
|
jpayne@69
|
1918 ** ^When pMem is not NULL, SQLite will strive to use the memory provided
|
|
jpayne@69
|
1919 ** to satisfy page cache needs, falling back to [sqlite3_malloc()] if
|
|
jpayne@69
|
1920 ** a page cache line is larger than sz bytes or if all of the pMem buffer
|
|
jpayne@69
|
1921 ** is exhausted.
|
|
jpayne@69
|
1922 ** ^If pMem is NULL and N is non-zero, then each database connection
|
|
jpayne@69
|
1923 ** does an initial bulk allocation for page cache memory
|
|
jpayne@69
|
1924 ** from [sqlite3_malloc()] sufficient for N cache lines if N is positive or
|
|
jpayne@69
|
1925 ** of -1024*N bytes if N is negative, . ^If additional
|
|
jpayne@69
|
1926 ** page cache memory is needed beyond what is provided by the initial
|
|
jpayne@69
|
1927 ** allocation, then SQLite goes to [sqlite3_malloc()] separately for each
|
|
jpayne@69
|
1928 ** additional cache line. </dd>
|
|
jpayne@69
|
1929 **
|
|
jpayne@69
|
1930 ** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt>
|
|
jpayne@69
|
1931 ** <dd> ^The SQLITE_CONFIG_HEAP option specifies a static memory buffer
|
|
jpayne@69
|
1932 ** that SQLite will use for all of its dynamic memory allocation needs
|
|
jpayne@69
|
1933 ** beyond those provided for by [SQLITE_CONFIG_PAGECACHE].
|
|
jpayne@69
|
1934 ** ^The SQLITE_CONFIG_HEAP option is only available if SQLite is compiled
|
|
jpayne@69
|
1935 ** with either [SQLITE_ENABLE_MEMSYS3] or [SQLITE_ENABLE_MEMSYS5] and returns
|
|
jpayne@69
|
1936 ** [SQLITE_ERROR] if invoked otherwise.
|
|
jpayne@69
|
1937 ** ^There are three arguments to SQLITE_CONFIG_HEAP:
|
|
jpayne@69
|
1938 ** An 8-byte aligned pointer to the memory,
|
|
jpayne@69
|
1939 ** the number of bytes in the memory buffer, and the minimum allocation size.
|
|
jpayne@69
|
1940 ** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts
|
|
jpayne@69
|
1941 ** to using its default memory allocator (the system malloc() implementation),
|
|
jpayne@69
|
1942 ** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the
|
|
jpayne@69
|
1943 ** memory pointer is not NULL then the alternative memory
|
|
jpayne@69
|
1944 ** allocator is engaged to handle all of SQLites memory allocation needs.
|
|
jpayne@69
|
1945 ** The first pointer (the memory pointer) must be aligned to an 8-byte
|
|
jpayne@69
|
1946 ** boundary or subsequent behavior of SQLite will be undefined.
|
|
jpayne@69
|
1947 ** The minimum allocation size is capped at 2**12. Reasonable values
|
|
jpayne@69
|
1948 ** for the minimum allocation size are 2**5 through 2**8.</dd>
|
|
jpayne@69
|
1949 **
|
|
jpayne@69
|
1950 ** [[SQLITE_CONFIG_MUTEX]] <dt>SQLITE_CONFIG_MUTEX</dt>
|
|
jpayne@69
|
1951 ** <dd> ^(The SQLITE_CONFIG_MUTEX option takes a single argument which is a
|
|
jpayne@69
|
1952 ** pointer to an instance of the [sqlite3_mutex_methods] structure.
|
|
jpayne@69
|
1953 ** The argument specifies alternative low-level mutex routines to be used
|
|
jpayne@69
|
1954 ** in place the mutex routines built into SQLite.)^ ^SQLite makes a copy of
|
|
jpayne@69
|
1955 ** the content of the [sqlite3_mutex_methods] structure before the call to
|
|
jpayne@69
|
1956 ** [sqlite3_config()] returns. ^If SQLite is compiled with
|
|
jpayne@69
|
1957 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
|
|
jpayne@69
|
1958 ** the entire mutexing subsystem is omitted from the build and hence calls to
|
|
jpayne@69
|
1959 ** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will
|
|
jpayne@69
|
1960 ** return [SQLITE_ERROR].</dd>
|
|
jpayne@69
|
1961 **
|
|
jpayne@69
|
1962 ** [[SQLITE_CONFIG_GETMUTEX]] <dt>SQLITE_CONFIG_GETMUTEX</dt>
|
|
jpayne@69
|
1963 ** <dd> ^(The SQLITE_CONFIG_GETMUTEX option takes a single argument which
|
|
jpayne@69
|
1964 ** is a pointer to an instance of the [sqlite3_mutex_methods] structure. The
|
|
jpayne@69
|
1965 ** [sqlite3_mutex_methods]
|
|
jpayne@69
|
1966 ** structure is filled with the currently defined mutex routines.)^
|
|
jpayne@69
|
1967 ** This option can be used to overload the default mutex allocation
|
|
jpayne@69
|
1968 ** routines with a wrapper used to track mutex usage for performance
|
|
jpayne@69
|
1969 ** profiling or testing, for example. ^If SQLite is compiled with
|
|
jpayne@69
|
1970 ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
|
|
jpayne@69
|
1971 ** the entire mutexing subsystem is omitted from the build and hence calls to
|
|
jpayne@69
|
1972 ** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will
|
|
jpayne@69
|
1973 ** return [SQLITE_ERROR].</dd>
|
|
jpayne@69
|
1974 **
|
|
jpayne@69
|
1975 ** [[SQLITE_CONFIG_LOOKASIDE]] <dt>SQLITE_CONFIG_LOOKASIDE</dt>
|
|
jpayne@69
|
1976 ** <dd> ^(The SQLITE_CONFIG_LOOKASIDE option takes two arguments that determine
|
|
jpayne@69
|
1977 ** the default size of lookaside memory on each [database connection].
|
|
jpayne@69
|
1978 ** The first argument is the
|
|
jpayne@69
|
1979 ** size of each lookaside buffer slot and the second is the number of
|
|
jpayne@69
|
1980 ** slots allocated to each database connection.)^ ^(SQLITE_CONFIG_LOOKASIDE
|
|
jpayne@69
|
1981 ** sets the <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE]
|
|
jpayne@69
|
1982 ** option to [sqlite3_db_config()] can be used to change the lookaside
|
|
jpayne@69
|
1983 ** configuration on individual connections.)^ </dd>
|
|
jpayne@69
|
1984 **
|
|
jpayne@69
|
1985 ** [[SQLITE_CONFIG_PCACHE2]] <dt>SQLITE_CONFIG_PCACHE2</dt>
|
|
jpayne@69
|
1986 ** <dd> ^(The SQLITE_CONFIG_PCACHE2 option takes a single argument which is
|
|
jpayne@69
|
1987 ** a pointer to an [sqlite3_pcache_methods2] object. This object specifies
|
|
jpayne@69
|
1988 ** the interface to a custom page cache implementation.)^
|
|
jpayne@69
|
1989 ** ^SQLite makes a copy of the [sqlite3_pcache_methods2] object.</dd>
|
|
jpayne@69
|
1990 **
|
|
jpayne@69
|
1991 ** [[SQLITE_CONFIG_GETPCACHE2]] <dt>SQLITE_CONFIG_GETPCACHE2</dt>
|
|
jpayne@69
|
1992 ** <dd> ^(The SQLITE_CONFIG_GETPCACHE2 option takes a single argument which
|
|
jpayne@69
|
1993 ** is a pointer to an [sqlite3_pcache_methods2] object. SQLite copies of
|
|
jpayne@69
|
1994 ** the current page cache implementation into that object.)^ </dd>
|
|
jpayne@69
|
1995 **
|
|
jpayne@69
|
1996 ** [[SQLITE_CONFIG_LOG]] <dt>SQLITE_CONFIG_LOG</dt>
|
|
jpayne@69
|
1997 ** <dd> The SQLITE_CONFIG_LOG option is used to configure the SQLite
|
|
jpayne@69
|
1998 ** global [error log].
|
|
jpayne@69
|
1999 ** (^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a
|
|
jpayne@69
|
2000 ** function with a call signature of void(*)(void*,int,const char*),
|
|
jpayne@69
|
2001 ** and a pointer to void. ^If the function pointer is not NULL, it is
|
|
jpayne@69
|
2002 ** invoked by [sqlite3_log()] to process each logging event. ^If the
|
|
jpayne@69
|
2003 ** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op.
|
|
jpayne@69
|
2004 ** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is
|
|
jpayne@69
|
2005 ** passed through as the first parameter to the application-defined logger
|
|
jpayne@69
|
2006 ** function whenever that function is invoked. ^The second parameter to
|
|
jpayne@69
|
2007 ** the logger function is a copy of the first parameter to the corresponding
|
|
jpayne@69
|
2008 ** [sqlite3_log()] call and is intended to be a [result code] or an
|
|
jpayne@69
|
2009 ** [extended result code]. ^The third parameter passed to the logger is
|
|
jpayne@69
|
2010 ** log message after formatting via [sqlite3_snprintf()].
|
|
jpayne@69
|
2011 ** The SQLite logging interface is not reentrant; the logger function
|
|
jpayne@69
|
2012 ** supplied by the application must not invoke any SQLite interface.
|
|
jpayne@69
|
2013 ** In a multi-threaded application, the application-defined logger
|
|
jpayne@69
|
2014 ** function must be threadsafe. </dd>
|
|
jpayne@69
|
2015 **
|
|
jpayne@69
|
2016 ** [[SQLITE_CONFIG_URI]] <dt>SQLITE_CONFIG_URI
|
|
jpayne@69
|
2017 ** <dd>^(The SQLITE_CONFIG_URI option takes a single argument of type int.
|
|
jpayne@69
|
2018 ** If non-zero, then URI handling is globally enabled. If the parameter is zero,
|
|
jpayne@69
|
2019 ** then URI handling is globally disabled.)^ ^If URI handling is globally
|
|
jpayne@69
|
2020 ** enabled, all filenames passed to [sqlite3_open()], [sqlite3_open_v2()],
|
|
jpayne@69
|
2021 ** [sqlite3_open16()] or
|
|
jpayne@69
|
2022 ** specified as part of [ATTACH] commands are interpreted as URIs, regardless
|
|
jpayne@69
|
2023 ** of whether or not the [SQLITE_OPEN_URI] flag is set when the database
|
|
jpayne@69
|
2024 ** connection is opened. ^If it is globally disabled, filenames are
|
|
jpayne@69
|
2025 ** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the
|
|
jpayne@69
|
2026 ** database connection is opened. ^(By default, URI handling is globally
|
|
jpayne@69
|
2027 ** disabled. The default value may be changed by compiling with the
|
|
jpayne@69
|
2028 ** [SQLITE_USE_URI] symbol defined.)^
|
|
jpayne@69
|
2029 **
|
|
jpayne@69
|
2030 ** [[SQLITE_CONFIG_COVERING_INDEX_SCAN]] <dt>SQLITE_CONFIG_COVERING_INDEX_SCAN
|
|
jpayne@69
|
2031 ** <dd>^The SQLITE_CONFIG_COVERING_INDEX_SCAN option takes a single integer
|
|
jpayne@69
|
2032 ** argument which is interpreted as a boolean in order to enable or disable
|
|
jpayne@69
|
2033 ** the use of covering indices for full table scans in the query optimizer.
|
|
jpayne@69
|
2034 ** ^The default setting is determined
|
|
jpayne@69
|
2035 ** by the [SQLITE_ALLOW_COVERING_INDEX_SCAN] compile-time option, or is "on"
|
|
jpayne@69
|
2036 ** if that compile-time option is omitted.
|
|
jpayne@69
|
2037 ** The ability to disable the use of covering indices for full table scans
|
|
jpayne@69
|
2038 ** is because some incorrectly coded legacy applications might malfunction
|
|
jpayne@69
|
2039 ** when the optimization is enabled. Providing the ability to
|
|
jpayne@69
|
2040 ** disable the optimization allows the older, buggy application code to work
|
|
jpayne@69
|
2041 ** without change even with newer versions of SQLite.
|
|
jpayne@69
|
2042 **
|
|
jpayne@69
|
2043 ** [[SQLITE_CONFIG_PCACHE]] [[SQLITE_CONFIG_GETPCACHE]]
|
|
jpayne@69
|
2044 ** <dt>SQLITE_CONFIG_PCACHE and SQLITE_CONFIG_GETPCACHE
|
|
jpayne@69
|
2045 ** <dd> These options are obsolete and should not be used by new code.
|
|
jpayne@69
|
2046 ** They are retained for backwards compatibility but are now no-ops.
|
|
jpayne@69
|
2047 ** </dd>
|
|
jpayne@69
|
2048 **
|
|
jpayne@69
|
2049 ** [[SQLITE_CONFIG_SQLLOG]]
|
|
jpayne@69
|
2050 ** <dt>SQLITE_CONFIG_SQLLOG
|
|
jpayne@69
|
2051 ** <dd>This option is only available if sqlite is compiled with the
|
|
jpayne@69
|
2052 ** [SQLITE_ENABLE_SQLLOG] pre-processor macro defined. The first argument should
|
|
jpayne@69
|
2053 ** be a pointer to a function of type void(*)(void*,sqlite3*,const char*, int).
|
|
jpayne@69
|
2054 ** The second should be of type (void*). The callback is invoked by the library
|
|
jpayne@69
|
2055 ** in three separate circumstances, identified by the value passed as the
|
|
jpayne@69
|
2056 ** fourth parameter. If the fourth parameter is 0, then the database connection
|
|
jpayne@69
|
2057 ** passed as the second argument has just been opened. The third argument
|
|
jpayne@69
|
2058 ** points to a buffer containing the name of the main database file. If the
|
|
jpayne@69
|
2059 ** fourth parameter is 1, then the SQL statement that the third parameter
|
|
jpayne@69
|
2060 ** points to has just been executed. Or, if the fourth parameter is 2, then
|
|
jpayne@69
|
2061 ** the connection being passed as the second parameter is being closed. The
|
|
jpayne@69
|
2062 ** third parameter is passed NULL In this case. An example of using this
|
|
jpayne@69
|
2063 ** configuration option can be seen in the "test_sqllog.c" source file in
|
|
jpayne@69
|
2064 ** the canonical SQLite source tree.</dd>
|
|
jpayne@69
|
2065 **
|
|
jpayne@69
|
2066 ** [[SQLITE_CONFIG_MMAP_SIZE]]
|
|
jpayne@69
|
2067 ** <dt>SQLITE_CONFIG_MMAP_SIZE
|
|
jpayne@69
|
2068 ** <dd>^SQLITE_CONFIG_MMAP_SIZE takes two 64-bit integer (sqlite3_int64) values
|
|
jpayne@69
|
2069 ** that are the default mmap size limit (the default setting for
|
|
jpayne@69
|
2070 ** [PRAGMA mmap_size]) and the maximum allowed mmap size limit.
|
|
jpayne@69
|
2071 ** ^The default setting can be overridden by each database connection using
|
|
jpayne@69
|
2072 ** either the [PRAGMA mmap_size] command, or by using the
|
|
jpayne@69
|
2073 ** [SQLITE_FCNTL_MMAP_SIZE] file control. ^(The maximum allowed mmap size
|
|
jpayne@69
|
2074 ** will be silently truncated if necessary so that it does not exceed the
|
|
jpayne@69
|
2075 ** compile-time maximum mmap size set by the
|
|
jpayne@69
|
2076 ** [SQLITE_MAX_MMAP_SIZE] compile-time option.)^
|
|
jpayne@69
|
2077 ** ^If either argument to this option is negative, then that argument is
|
|
jpayne@69
|
2078 ** changed to its compile-time default.
|
|
jpayne@69
|
2079 **
|
|
jpayne@69
|
2080 ** [[SQLITE_CONFIG_WIN32_HEAPSIZE]]
|
|
jpayne@69
|
2081 ** <dt>SQLITE_CONFIG_WIN32_HEAPSIZE
|
|
jpayne@69
|
2082 ** <dd>^The SQLITE_CONFIG_WIN32_HEAPSIZE option is only available if SQLite is
|
|
jpayne@69
|
2083 ** compiled for Windows with the [SQLITE_WIN32_MALLOC] pre-processor macro
|
|
jpayne@69
|
2084 ** defined. ^SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit unsigned integer value
|
|
jpayne@69
|
2085 ** that specifies the maximum size of the created heap.
|
|
jpayne@69
|
2086 **
|
|
jpayne@69
|
2087 ** [[SQLITE_CONFIG_PCACHE_HDRSZ]]
|
|
jpayne@69
|
2088 ** <dt>SQLITE_CONFIG_PCACHE_HDRSZ
|
|
jpayne@69
|
2089 ** <dd>^The SQLITE_CONFIG_PCACHE_HDRSZ option takes a single parameter which
|
|
jpayne@69
|
2090 ** is a pointer to an integer and writes into that integer the number of extra
|
|
jpayne@69
|
2091 ** bytes per page required for each page in [SQLITE_CONFIG_PAGECACHE].
|
|
jpayne@69
|
2092 ** The amount of extra space required can change depending on the compiler,
|
|
jpayne@69
|
2093 ** target platform, and SQLite version.
|
|
jpayne@69
|
2094 **
|
|
jpayne@69
|
2095 ** [[SQLITE_CONFIG_PMASZ]]
|
|
jpayne@69
|
2096 ** <dt>SQLITE_CONFIG_PMASZ
|
|
jpayne@69
|
2097 ** <dd>^The SQLITE_CONFIG_PMASZ option takes a single parameter which
|
|
jpayne@69
|
2098 ** is an unsigned integer and sets the "Minimum PMA Size" for the multithreaded
|
|
jpayne@69
|
2099 ** sorter to that integer. The default minimum PMA Size is set by the
|
|
jpayne@69
|
2100 ** [SQLITE_SORTER_PMASZ] compile-time option. New threads are launched
|
|
jpayne@69
|
2101 ** to help with sort operations when multithreaded sorting
|
|
jpayne@69
|
2102 ** is enabled (using the [PRAGMA threads] command) and the amount of content
|
|
jpayne@69
|
2103 ** to be sorted exceeds the page size times the minimum of the
|
|
jpayne@69
|
2104 ** [PRAGMA cache_size] setting and this value.
|
|
jpayne@69
|
2105 **
|
|
jpayne@69
|
2106 ** [[SQLITE_CONFIG_STMTJRNL_SPILL]]
|
|
jpayne@69
|
2107 ** <dt>SQLITE_CONFIG_STMTJRNL_SPILL
|
|
jpayne@69
|
2108 ** <dd>^The SQLITE_CONFIG_STMTJRNL_SPILL option takes a single parameter which
|
|
jpayne@69
|
2109 ** becomes the [statement journal] spill-to-disk threshold.
|
|
jpayne@69
|
2110 ** [Statement journals] are held in memory until their size (in bytes)
|
|
jpayne@69
|
2111 ** exceeds this threshold, at which point they are written to disk.
|
|
jpayne@69
|
2112 ** Or if the threshold is -1, statement journals are always held
|
|
jpayne@69
|
2113 ** exclusively in memory.
|
|
jpayne@69
|
2114 ** Since many statement journals never become large, setting the spill
|
|
jpayne@69
|
2115 ** threshold to a value such as 64KiB can greatly reduce the amount of
|
|
jpayne@69
|
2116 ** I/O required to support statement rollback.
|
|
jpayne@69
|
2117 ** The default value for this setting is controlled by the
|
|
jpayne@69
|
2118 ** [SQLITE_STMTJRNL_SPILL] compile-time option.
|
|
jpayne@69
|
2119 **
|
|
jpayne@69
|
2120 ** [[SQLITE_CONFIG_SORTERREF_SIZE]]
|
|
jpayne@69
|
2121 ** <dt>SQLITE_CONFIG_SORTERREF_SIZE
|
|
jpayne@69
|
2122 ** <dd>The SQLITE_CONFIG_SORTERREF_SIZE option accepts a single parameter
|
|
jpayne@69
|
2123 ** of type (int) - the new value of the sorter-reference size threshold.
|
|
jpayne@69
|
2124 ** Usually, when SQLite uses an external sort to order records according
|
|
jpayne@69
|
2125 ** to an ORDER BY clause, all fields required by the caller are present in the
|
|
jpayne@69
|
2126 ** sorted records. However, if SQLite determines based on the declared type
|
|
jpayne@69
|
2127 ** of a table column that its values are likely to be very large - larger
|
|
jpayne@69
|
2128 ** than the configured sorter-reference size threshold - then a reference
|
|
jpayne@69
|
2129 ** is stored in each sorted record and the required column values loaded
|
|
jpayne@69
|
2130 ** from the database as records are returned in sorted order. The default
|
|
jpayne@69
|
2131 ** value for this option is to never use this optimization. Specifying a
|
|
jpayne@69
|
2132 ** negative value for this option restores the default behavior.
|
|
jpayne@69
|
2133 ** This option is only available if SQLite is compiled with the
|
|
jpayne@69
|
2134 ** [SQLITE_ENABLE_SORTER_REFERENCES] compile-time option.
|
|
jpayne@69
|
2135 **
|
|
jpayne@69
|
2136 ** [[SQLITE_CONFIG_MEMDB_MAXSIZE]]
|
|
jpayne@69
|
2137 ** <dt>SQLITE_CONFIG_MEMDB_MAXSIZE
|
|
jpayne@69
|
2138 ** <dd>The SQLITE_CONFIG_MEMDB_MAXSIZE option accepts a single parameter
|
|
jpayne@69
|
2139 ** [sqlite3_int64] parameter which is the default maximum size for an in-memory
|
|
jpayne@69
|
2140 ** database created using [sqlite3_deserialize()]. This default maximum
|
|
jpayne@69
|
2141 ** size can be adjusted up or down for individual databases using the
|
|
jpayne@69
|
2142 ** [SQLITE_FCNTL_SIZE_LIMIT] [sqlite3_file_control|file-control]. If this
|
|
jpayne@69
|
2143 ** configuration setting is never used, then the default maximum is determined
|
|
jpayne@69
|
2144 ** by the [SQLITE_MEMDB_DEFAULT_MAXSIZE] compile-time option. If that
|
|
jpayne@69
|
2145 ** compile-time option is not set, then the default maximum is 1073741824.
|
|
jpayne@69
|
2146 **
|
|
jpayne@69
|
2147 ** [[SQLITE_CONFIG_ROWID_IN_VIEW]]
|
|
jpayne@69
|
2148 ** <dt>SQLITE_CONFIG_ROWID_IN_VIEW
|
|
jpayne@69
|
2149 ** <dd>The SQLITE_CONFIG_ROWID_IN_VIEW option enables or disables the ability
|
|
jpayne@69
|
2150 ** for VIEWs to have a ROWID. The capability can only be enabled if SQLite is
|
|
jpayne@69
|
2151 ** compiled with -DSQLITE_ALLOW_ROWID_IN_VIEW, in which case the capability
|
|
jpayne@69
|
2152 ** defaults to on. This configuration option queries the current setting or
|
|
jpayne@69
|
2153 ** changes the setting to off or on. The argument is a pointer to an integer.
|
|
jpayne@69
|
2154 ** If that integer initially holds a value of 1, then the ability for VIEWs to
|
|
jpayne@69
|
2155 ** have ROWIDs is activated. If the integer initially holds zero, then the
|
|
jpayne@69
|
2156 ** ability is deactivated. Any other initial value for the integer leaves the
|
|
jpayne@69
|
2157 ** setting unchanged. After changes, if any, the integer is written with
|
|
jpayne@69
|
2158 ** a 1 or 0, if the ability for VIEWs to have ROWIDs is on or off. If SQLite
|
|
jpayne@69
|
2159 ** is compiled without -DSQLITE_ALLOW_ROWID_IN_VIEW (which is the usual and
|
|
jpayne@69
|
2160 ** recommended case) then the integer is always filled with zero, regardless
|
|
jpayne@69
|
2161 ** if its initial value.
|
|
jpayne@69
|
2162 ** </dl>
|
|
jpayne@69
|
2163 */
|
|
jpayne@69
|
2164 #define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */
|
|
jpayne@69
|
2165 #define SQLITE_CONFIG_MULTITHREAD 2 /* nil */
|
|
jpayne@69
|
2166 #define SQLITE_CONFIG_SERIALIZED 3 /* nil */
|
|
jpayne@69
|
2167 #define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */
|
|
jpayne@69
|
2168 #define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */
|
|
jpayne@69
|
2169 #define SQLITE_CONFIG_SCRATCH 6 /* No longer used */
|
|
jpayne@69
|
2170 #define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */
|
|
jpayne@69
|
2171 #define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */
|
|
jpayne@69
|
2172 #define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */
|
|
jpayne@69
|
2173 #define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */
|
|
jpayne@69
|
2174 #define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */
|
|
jpayne@69
|
2175 /* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */
|
|
jpayne@69
|
2176 #define SQLITE_CONFIG_LOOKASIDE 13 /* int int */
|
|
jpayne@69
|
2177 #define SQLITE_CONFIG_PCACHE 14 /* no-op */
|
|
jpayne@69
|
2178 #define SQLITE_CONFIG_GETPCACHE 15 /* no-op */
|
|
jpayne@69
|
2179 #define SQLITE_CONFIG_LOG 16 /* xFunc, void* */
|
|
jpayne@69
|
2180 #define SQLITE_CONFIG_URI 17 /* int */
|
|
jpayne@69
|
2181 #define SQLITE_CONFIG_PCACHE2 18 /* sqlite3_pcache_methods2* */
|
|
jpayne@69
|
2182 #define SQLITE_CONFIG_GETPCACHE2 19 /* sqlite3_pcache_methods2* */
|
|
jpayne@69
|
2183 #define SQLITE_CONFIG_COVERING_INDEX_SCAN 20 /* int */
|
|
jpayne@69
|
2184 #define SQLITE_CONFIG_SQLLOG 21 /* xSqllog, void* */
|
|
jpayne@69
|
2185 #define SQLITE_CONFIG_MMAP_SIZE 22 /* sqlite3_int64, sqlite3_int64 */
|
|
jpayne@69
|
2186 #define SQLITE_CONFIG_WIN32_HEAPSIZE 23 /* int nByte */
|
|
jpayne@69
|
2187 #define SQLITE_CONFIG_PCACHE_HDRSZ 24 /* int *psz */
|
|
jpayne@69
|
2188 #define SQLITE_CONFIG_PMASZ 25 /* unsigned int szPma */
|
|
jpayne@69
|
2189 #define SQLITE_CONFIG_STMTJRNL_SPILL 26 /* int nByte */
|
|
jpayne@69
|
2190 #define SQLITE_CONFIG_SMALL_MALLOC 27 /* boolean */
|
|
jpayne@69
|
2191 #define SQLITE_CONFIG_SORTERREF_SIZE 28 /* int nByte */
|
|
jpayne@69
|
2192 #define SQLITE_CONFIG_MEMDB_MAXSIZE 29 /* sqlite3_int64 */
|
|
jpayne@69
|
2193 #define SQLITE_CONFIG_ROWID_IN_VIEW 30 /* int* */
|
|
jpayne@69
|
2194
|
|
jpayne@69
|
2195 /*
|
|
jpayne@69
|
2196 ** CAPI3REF: Database Connection Configuration Options
|
|
jpayne@69
|
2197 **
|
|
jpayne@69
|
2198 ** These constants are the available integer configuration options that
|
|
jpayne@69
|
2199 ** can be passed as the second argument to the [sqlite3_db_config()] interface.
|
|
jpayne@69
|
2200 **
|
|
jpayne@69
|
2201 ** New configuration options may be added in future releases of SQLite.
|
|
jpayne@69
|
2202 ** Existing configuration options might be discontinued. Applications
|
|
jpayne@69
|
2203 ** should check the return code from [sqlite3_db_config()] to make sure that
|
|
jpayne@69
|
2204 ** the call worked. ^The [sqlite3_db_config()] interface will return a
|
|
jpayne@69
|
2205 ** non-zero [error code] if a discontinued or unsupported configuration option
|
|
jpayne@69
|
2206 ** is invoked.
|
|
jpayne@69
|
2207 **
|
|
jpayne@69
|
2208 ** <dl>
|
|
jpayne@69
|
2209 ** [[SQLITE_DBCONFIG_LOOKASIDE]]
|
|
jpayne@69
|
2210 ** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt>
|
|
jpayne@69
|
2211 ** <dd> ^This option takes three additional arguments that determine the
|
|
jpayne@69
|
2212 ** [lookaside memory allocator] configuration for the [database connection].
|
|
jpayne@69
|
2213 ** ^The first argument (the third parameter to [sqlite3_db_config()] is a
|
|
jpayne@69
|
2214 ** pointer to a memory buffer to use for lookaside memory.
|
|
jpayne@69
|
2215 ** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb
|
|
jpayne@69
|
2216 ** may be NULL in which case SQLite will allocate the
|
|
jpayne@69
|
2217 ** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the
|
|
jpayne@69
|
2218 ** size of each lookaside buffer slot. ^The third argument is the number of
|
|
jpayne@69
|
2219 ** slots. The size of the buffer in the first argument must be greater than
|
|
jpayne@69
|
2220 ** or equal to the product of the second and third arguments. The buffer
|
|
jpayne@69
|
2221 ** must be aligned to an 8-byte boundary. ^If the second argument to
|
|
jpayne@69
|
2222 ** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally
|
|
jpayne@69
|
2223 ** rounded down to the next smaller multiple of 8. ^(The lookaside memory
|
|
jpayne@69
|
2224 ** configuration for a database connection can only be changed when that
|
|
jpayne@69
|
2225 ** connection is not currently using lookaside memory, or in other words
|
|
jpayne@69
|
2226 ** when the "current value" returned by
|
|
jpayne@69
|
2227 ** [sqlite3_db_status](D,[SQLITE_DBSTATUS_LOOKASIDE_USED],...) is zero.
|
|
jpayne@69
|
2228 ** Any attempt to change the lookaside memory configuration when lookaside
|
|
jpayne@69
|
2229 ** memory is in use leaves the configuration unchanged and returns
|
|
jpayne@69
|
2230 ** [SQLITE_BUSY].)^</dd>
|
|
jpayne@69
|
2231 **
|
|
jpayne@69
|
2232 ** [[SQLITE_DBCONFIG_ENABLE_FKEY]]
|
|
jpayne@69
|
2233 ** <dt>SQLITE_DBCONFIG_ENABLE_FKEY</dt>
|
|
jpayne@69
|
2234 ** <dd> ^This option is used to enable or disable the enforcement of
|
|
jpayne@69
|
2235 ** [foreign key constraints]. There should be two additional arguments.
|
|
jpayne@69
|
2236 ** The first argument is an integer which is 0 to disable FK enforcement,
|
|
jpayne@69
|
2237 ** positive to enable FK enforcement or negative to leave FK enforcement
|
|
jpayne@69
|
2238 ** unchanged. The second parameter is a pointer to an integer into which
|
|
jpayne@69
|
2239 ** is written 0 or 1 to indicate whether FK enforcement is off or on
|
|
jpayne@69
|
2240 ** following this call. The second parameter may be a NULL pointer, in
|
|
jpayne@69
|
2241 ** which case the FK enforcement setting is not reported back. </dd>
|
|
jpayne@69
|
2242 **
|
|
jpayne@69
|
2243 ** [[SQLITE_DBCONFIG_ENABLE_TRIGGER]]
|
|
jpayne@69
|
2244 ** <dt>SQLITE_DBCONFIG_ENABLE_TRIGGER</dt>
|
|
jpayne@69
|
2245 ** <dd> ^This option is used to enable or disable [CREATE TRIGGER | triggers].
|
|
jpayne@69
|
2246 ** There should be two additional arguments.
|
|
jpayne@69
|
2247 ** The first argument is an integer which is 0 to disable triggers,
|
|
jpayne@69
|
2248 ** positive to enable triggers or negative to leave the setting unchanged.
|
|
jpayne@69
|
2249 ** The second parameter is a pointer to an integer into which
|
|
jpayne@69
|
2250 ** is written 0 or 1 to indicate whether triggers are disabled or enabled
|
|
jpayne@69
|
2251 ** following this call. The second parameter may be a NULL pointer, in
|
|
jpayne@69
|
2252 ** which case the trigger setting is not reported back.
|
|
jpayne@69
|
2253 **
|
|
jpayne@69
|
2254 ** <p>Originally this option disabled all triggers. ^(However, since
|
|
jpayne@69
|
2255 ** SQLite version 3.35.0, TEMP triggers are still allowed even if
|
|
jpayne@69
|
2256 ** this option is off. So, in other words, this option now only disables
|
|
jpayne@69
|
2257 ** triggers in the main database schema or in the schemas of ATTACH-ed
|
|
jpayne@69
|
2258 ** databases.)^ </dd>
|
|
jpayne@69
|
2259 **
|
|
jpayne@69
|
2260 ** [[SQLITE_DBCONFIG_ENABLE_VIEW]]
|
|
jpayne@69
|
2261 ** <dt>SQLITE_DBCONFIG_ENABLE_VIEW</dt>
|
|
jpayne@69
|
2262 ** <dd> ^This option is used to enable or disable [CREATE VIEW | views].
|
|
jpayne@69
|
2263 ** There should be two additional arguments.
|
|
jpayne@69
|
2264 ** The first argument is an integer which is 0 to disable views,
|
|
jpayne@69
|
2265 ** positive to enable views or negative to leave the setting unchanged.
|
|
jpayne@69
|
2266 ** The second parameter is a pointer to an integer into which
|
|
jpayne@69
|
2267 ** is written 0 or 1 to indicate whether views are disabled or enabled
|
|
jpayne@69
|
2268 ** following this call. The second parameter may be a NULL pointer, in
|
|
jpayne@69
|
2269 ** which case the view setting is not reported back.
|
|
jpayne@69
|
2270 **
|
|
jpayne@69
|
2271 ** <p>Originally this option disabled all views. ^(However, since
|
|
jpayne@69
|
2272 ** SQLite version 3.35.0, TEMP views are still allowed even if
|
|
jpayne@69
|
2273 ** this option is off. So, in other words, this option now only disables
|
|
jpayne@69
|
2274 ** views in the main database schema or in the schemas of ATTACH-ed
|
|
jpayne@69
|
2275 ** databases.)^ </dd>
|
|
jpayne@69
|
2276 **
|
|
jpayne@69
|
2277 ** [[SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER]]
|
|
jpayne@69
|
2278 ** <dt>SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER</dt>
|
|
jpayne@69
|
2279 ** <dd> ^This option is used to enable or disable the
|
|
jpayne@69
|
2280 ** [fts3_tokenizer()] function which is part of the
|
|
jpayne@69
|
2281 ** [FTS3] full-text search engine extension.
|
|
jpayne@69
|
2282 ** There should be two additional arguments.
|
|
jpayne@69
|
2283 ** The first argument is an integer which is 0 to disable fts3_tokenizer() or
|
|
jpayne@69
|
2284 ** positive to enable fts3_tokenizer() or negative to leave the setting
|
|
jpayne@69
|
2285 ** unchanged.
|
|
jpayne@69
|
2286 ** The second parameter is a pointer to an integer into which
|
|
jpayne@69
|
2287 ** is written 0 or 1 to indicate whether fts3_tokenizer is disabled or enabled
|
|
jpayne@69
|
2288 ** following this call. The second parameter may be a NULL pointer, in
|
|
jpayne@69
|
2289 ** which case the new setting is not reported back. </dd>
|
|
jpayne@69
|
2290 **
|
|
jpayne@69
|
2291 ** [[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION]]
|
|
jpayne@69
|
2292 ** <dt>SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION</dt>
|
|
jpayne@69
|
2293 ** <dd> ^This option is used to enable or disable the [sqlite3_load_extension()]
|
|
jpayne@69
|
2294 ** interface independently of the [load_extension()] SQL function.
|
|
jpayne@69
|
2295 ** The [sqlite3_enable_load_extension()] API enables or disables both the
|
|
jpayne@69
|
2296 ** C-API [sqlite3_load_extension()] and the SQL function [load_extension()].
|
|
jpayne@69
|
2297 ** There should be two additional arguments.
|
|
jpayne@69
|
2298 ** When the first argument to this interface is 1, then only the C-API is
|
|
jpayne@69
|
2299 ** enabled and the SQL function remains disabled. If the first argument to
|
|
jpayne@69
|
2300 ** this interface is 0, then both the C-API and the SQL function are disabled.
|
|
jpayne@69
|
2301 ** If the first argument is -1, then no changes are made to state of either the
|
|
jpayne@69
|
2302 ** C-API or the SQL function.
|
|
jpayne@69
|
2303 ** The second parameter is a pointer to an integer into which
|
|
jpayne@69
|
2304 ** is written 0 or 1 to indicate whether [sqlite3_load_extension()] interface
|
|
jpayne@69
|
2305 ** is disabled or enabled following this call. The second parameter may
|
|
jpayne@69
|
2306 ** be a NULL pointer, in which case the new setting is not reported back.
|
|
jpayne@69
|
2307 ** </dd>
|
|
jpayne@69
|
2308 **
|
|
jpayne@69
|
2309 ** [[SQLITE_DBCONFIG_MAINDBNAME]] <dt>SQLITE_DBCONFIG_MAINDBNAME</dt>
|
|
jpayne@69
|
2310 ** <dd> ^This option is used to change the name of the "main" database
|
|
jpayne@69
|
2311 ** schema. ^The sole argument is a pointer to a constant UTF8 string
|
|
jpayne@69
|
2312 ** which will become the new schema name in place of "main". ^SQLite
|
|
jpayne@69
|
2313 ** does not make a copy of the new main schema name string, so the application
|
|
jpayne@69
|
2314 ** must ensure that the argument passed into this DBCONFIG option is unchanged
|
|
jpayne@69
|
2315 ** until after the database connection closes.
|
|
jpayne@69
|
2316 ** </dd>
|
|
jpayne@69
|
2317 **
|
|
jpayne@69
|
2318 ** [[SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE]]
|
|
jpayne@69
|
2319 ** <dt>SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE</dt>
|
|
jpayne@69
|
2320 ** <dd> Usually, when a database in wal mode is closed or detached from a
|
|
jpayne@69
|
2321 ** database handle, SQLite checks if this will mean that there are now no
|
|
jpayne@69
|
2322 ** connections at all to the database. If so, it performs a checkpoint
|
|
jpayne@69
|
2323 ** operation before closing the connection. This option may be used to
|
|
jpayne@69
|
2324 ** override this behavior. The first parameter passed to this operation
|
|
jpayne@69
|
2325 ** is an integer - positive to disable checkpoints-on-close, or zero (the
|
|
jpayne@69
|
2326 ** default) to enable them, and negative to leave the setting unchanged.
|
|
jpayne@69
|
2327 ** The second parameter is a pointer to an integer
|
|
jpayne@69
|
2328 ** into which is written 0 or 1 to indicate whether checkpoints-on-close
|
|
jpayne@69
|
2329 ** have been disabled - 0 if they are not disabled, 1 if they are.
|
|
jpayne@69
|
2330 ** </dd>
|
|
jpayne@69
|
2331 **
|
|
jpayne@69
|
2332 ** [[SQLITE_DBCONFIG_ENABLE_QPSG]] <dt>SQLITE_DBCONFIG_ENABLE_QPSG</dt>
|
|
jpayne@69
|
2333 ** <dd>^(The SQLITE_DBCONFIG_ENABLE_QPSG option activates or deactivates
|
|
jpayne@69
|
2334 ** the [query planner stability guarantee] (QPSG). When the QPSG is active,
|
|
jpayne@69
|
2335 ** a single SQL query statement will always use the same algorithm regardless
|
|
jpayne@69
|
2336 ** of values of [bound parameters].)^ The QPSG disables some query optimizations
|
|
jpayne@69
|
2337 ** that look at the values of bound parameters, which can make some queries
|
|
jpayne@69
|
2338 ** slower. But the QPSG has the advantage of more predictable behavior. With
|
|
jpayne@69
|
2339 ** the QPSG active, SQLite will always use the same query plan in the field as
|
|
jpayne@69
|
2340 ** was used during testing in the lab.
|
|
jpayne@69
|
2341 ** The first argument to this setting is an integer which is 0 to disable
|
|
jpayne@69
|
2342 ** the QPSG, positive to enable QPSG, or negative to leave the setting
|
|
jpayne@69
|
2343 ** unchanged. The second parameter is a pointer to an integer into which
|
|
jpayne@69
|
2344 ** is written 0 or 1 to indicate whether the QPSG is disabled or enabled
|
|
jpayne@69
|
2345 ** following this call.
|
|
jpayne@69
|
2346 ** </dd>
|
|
jpayne@69
|
2347 **
|
|
jpayne@69
|
2348 ** [[SQLITE_DBCONFIG_TRIGGER_EQP]] <dt>SQLITE_DBCONFIG_TRIGGER_EQP</dt>
|
|
jpayne@69
|
2349 ** <dd> By default, the output of EXPLAIN QUERY PLAN commands does not
|
|
jpayne@69
|
2350 ** include output for any operations performed by trigger programs. This
|
|
jpayne@69
|
2351 ** option is used to set or clear (the default) a flag that governs this
|
|
jpayne@69
|
2352 ** behavior. The first parameter passed to this operation is an integer -
|
|
jpayne@69
|
2353 ** positive to enable output for trigger programs, or zero to disable it,
|
|
jpayne@69
|
2354 ** or negative to leave the setting unchanged.
|
|
jpayne@69
|
2355 ** The second parameter is a pointer to an integer into which is written
|
|
jpayne@69
|
2356 ** 0 or 1 to indicate whether output-for-triggers has been disabled - 0 if
|
|
jpayne@69
|
2357 ** it is not disabled, 1 if it is.
|
|
jpayne@69
|
2358 ** </dd>
|
|
jpayne@69
|
2359 **
|
|
jpayne@69
|
2360 ** [[SQLITE_DBCONFIG_RESET_DATABASE]] <dt>SQLITE_DBCONFIG_RESET_DATABASE</dt>
|
|
jpayne@69
|
2361 ** <dd> Set the SQLITE_DBCONFIG_RESET_DATABASE flag and then run
|
|
jpayne@69
|
2362 ** [VACUUM] in order to reset a database back to an empty database
|
|
jpayne@69
|
2363 ** with no schema and no content. The following process works even for
|
|
jpayne@69
|
2364 ** a badly corrupted database file:
|
|
jpayne@69
|
2365 ** <ol>
|
|
jpayne@69
|
2366 ** <li> If the database connection is newly opened, make sure it has read the
|
|
jpayne@69
|
2367 ** database schema by preparing then discarding some query against the
|
|
jpayne@69
|
2368 ** database, or calling sqlite3_table_column_metadata(), ignoring any
|
|
jpayne@69
|
2369 ** errors. This step is only necessary if the application desires to keep
|
|
jpayne@69
|
2370 ** the database in WAL mode after the reset if it was in WAL mode before
|
|
jpayne@69
|
2371 ** the reset.
|
|
jpayne@69
|
2372 ** <li> sqlite3_db_config(db, SQLITE_DBCONFIG_RESET_DATABASE, 1, 0);
|
|
jpayne@69
|
2373 ** <li> [sqlite3_exec](db, "[VACUUM]", 0, 0, 0);
|
|
jpayne@69
|
2374 ** <li> sqlite3_db_config(db, SQLITE_DBCONFIG_RESET_DATABASE, 0, 0);
|
|
jpayne@69
|
2375 ** </ol>
|
|
jpayne@69
|
2376 ** Because resetting a database is destructive and irreversible, the
|
|
jpayne@69
|
2377 ** process requires the use of this obscure API and multiple steps to
|
|
jpayne@69
|
2378 ** help ensure that it does not happen by accident. Because this
|
|
jpayne@69
|
2379 ** feature must be capable of resetting corrupt databases, and
|
|
jpayne@69
|
2380 ** shutting down virtual tables may require access to that corrupt
|
|
jpayne@69
|
2381 ** storage, the library must abandon any installed virtual tables
|
|
jpayne@69
|
2382 ** without calling their xDestroy() methods.
|
|
jpayne@69
|
2383 **
|
|
jpayne@69
|
2384 ** [[SQLITE_DBCONFIG_DEFENSIVE]] <dt>SQLITE_DBCONFIG_DEFENSIVE</dt>
|
|
jpayne@69
|
2385 ** <dd>The SQLITE_DBCONFIG_DEFENSIVE option activates or deactivates the
|
|
jpayne@69
|
2386 ** "defensive" flag for a database connection. When the defensive
|
|
jpayne@69
|
2387 ** flag is enabled, language features that allow ordinary SQL to
|
|
jpayne@69
|
2388 ** deliberately corrupt the database file are disabled. The disabled
|
|
jpayne@69
|
2389 ** features include but are not limited to the following:
|
|
jpayne@69
|
2390 ** <ul>
|
|
jpayne@69
|
2391 ** <li> The [PRAGMA writable_schema=ON] statement.
|
|
jpayne@69
|
2392 ** <li> The [PRAGMA journal_mode=OFF] statement.
|
|
jpayne@69
|
2393 ** <li> The [PRAGMA schema_version=N] statement.
|
|
jpayne@69
|
2394 ** <li> Writes to the [sqlite_dbpage] virtual table.
|
|
jpayne@69
|
2395 ** <li> Direct writes to [shadow tables].
|
|
jpayne@69
|
2396 ** </ul>
|
|
jpayne@69
|
2397 ** </dd>
|
|
jpayne@69
|
2398 **
|
|
jpayne@69
|
2399 ** [[SQLITE_DBCONFIG_WRITABLE_SCHEMA]] <dt>SQLITE_DBCONFIG_WRITABLE_SCHEMA</dt>
|
|
jpayne@69
|
2400 ** <dd>The SQLITE_DBCONFIG_WRITABLE_SCHEMA option activates or deactivates the
|
|
jpayne@69
|
2401 ** "writable_schema" flag. This has the same effect and is logically equivalent
|
|
jpayne@69
|
2402 ** to setting [PRAGMA writable_schema=ON] or [PRAGMA writable_schema=OFF].
|
|
jpayne@69
|
2403 ** The first argument to this setting is an integer which is 0 to disable
|
|
jpayne@69
|
2404 ** the writable_schema, positive to enable writable_schema, or negative to
|
|
jpayne@69
|
2405 ** leave the setting unchanged. The second parameter is a pointer to an
|
|
jpayne@69
|
2406 ** integer into which is written 0 or 1 to indicate whether the writable_schema
|
|
jpayne@69
|
2407 ** is enabled or disabled following this call.
|
|
jpayne@69
|
2408 ** </dd>
|
|
jpayne@69
|
2409 **
|
|
jpayne@69
|
2410 ** [[SQLITE_DBCONFIG_LEGACY_ALTER_TABLE]]
|
|
jpayne@69
|
2411 ** <dt>SQLITE_DBCONFIG_LEGACY_ALTER_TABLE</dt>
|
|
jpayne@69
|
2412 ** <dd>The SQLITE_DBCONFIG_LEGACY_ALTER_TABLE option activates or deactivates
|
|
jpayne@69
|
2413 ** the legacy behavior of the [ALTER TABLE RENAME] command such it
|
|
jpayne@69
|
2414 ** behaves as it did prior to [version 3.24.0] (2018-06-04). See the
|
|
jpayne@69
|
2415 ** "Compatibility Notice" on the [ALTER TABLE RENAME documentation] for
|
|
jpayne@69
|
2416 ** additional information. This feature can also be turned on and off
|
|
jpayne@69
|
2417 ** using the [PRAGMA legacy_alter_table] statement.
|
|
jpayne@69
|
2418 ** </dd>
|
|
jpayne@69
|
2419 **
|
|
jpayne@69
|
2420 ** [[SQLITE_DBCONFIG_DQS_DML]]
|
|
jpayne@69
|
2421 ** <dt>SQLITE_DBCONFIG_DQS_DML</dt>
|
|
jpayne@69
|
2422 ** <dd>The SQLITE_DBCONFIG_DQS_DML option activates or deactivates
|
|
jpayne@69
|
2423 ** the legacy [double-quoted string literal] misfeature for DML statements
|
|
jpayne@69
|
2424 ** only, that is DELETE, INSERT, SELECT, and UPDATE statements. The
|
|
jpayne@69
|
2425 ** default value of this setting is determined by the [-DSQLITE_DQS]
|
|
jpayne@69
|
2426 ** compile-time option.
|
|
jpayne@69
|
2427 ** </dd>
|
|
jpayne@69
|
2428 **
|
|
jpayne@69
|
2429 ** [[SQLITE_DBCONFIG_DQS_DDL]]
|
|
jpayne@69
|
2430 ** <dt>SQLITE_DBCONFIG_DQS_DDL</dt>
|
|
jpayne@69
|
2431 ** <dd>The SQLITE_DBCONFIG_DQS option activates or deactivates
|
|
jpayne@69
|
2432 ** the legacy [double-quoted string literal] misfeature for DDL statements,
|
|
jpayne@69
|
2433 ** such as CREATE TABLE and CREATE INDEX. The
|
|
jpayne@69
|
2434 ** default value of this setting is determined by the [-DSQLITE_DQS]
|
|
jpayne@69
|
2435 ** compile-time option.
|
|
jpayne@69
|
2436 ** </dd>
|
|
jpayne@69
|
2437 **
|
|
jpayne@69
|
2438 ** [[SQLITE_DBCONFIG_TRUSTED_SCHEMA]]
|
|
jpayne@69
|
2439 ** <dt>SQLITE_DBCONFIG_TRUSTED_SCHEMA</dt>
|
|
jpayne@69
|
2440 ** <dd>The SQLITE_DBCONFIG_TRUSTED_SCHEMA option tells SQLite to
|
|
jpayne@69
|
2441 ** assume that database schemas are untainted by malicious content.
|
|
jpayne@69
|
2442 ** When the SQLITE_DBCONFIG_TRUSTED_SCHEMA option is disabled, SQLite
|
|
jpayne@69
|
2443 ** takes additional defensive steps to protect the application from harm
|
|
jpayne@69
|
2444 ** including:
|
|
jpayne@69
|
2445 ** <ul>
|
|
jpayne@69
|
2446 ** <li> Prohibit the use of SQL functions inside triggers, views,
|
|
jpayne@69
|
2447 ** CHECK constraints, DEFAULT clauses, expression indexes,
|
|
jpayne@69
|
2448 ** partial indexes, or generated columns
|
|
jpayne@69
|
2449 ** unless those functions are tagged with [SQLITE_INNOCUOUS].
|
|
jpayne@69
|
2450 ** <li> Prohibit the use of virtual tables inside of triggers or views
|
|
jpayne@69
|
2451 ** unless those virtual tables are tagged with [SQLITE_VTAB_INNOCUOUS].
|
|
jpayne@69
|
2452 ** </ul>
|
|
jpayne@69
|
2453 ** This setting defaults to "on" for legacy compatibility, however
|
|
jpayne@69
|
2454 ** all applications are advised to turn it off if possible. This setting
|
|
jpayne@69
|
2455 ** can also be controlled using the [PRAGMA trusted_schema] statement.
|
|
jpayne@69
|
2456 ** </dd>
|
|
jpayne@69
|
2457 **
|
|
jpayne@69
|
2458 ** [[SQLITE_DBCONFIG_LEGACY_FILE_FORMAT]]
|
|
jpayne@69
|
2459 ** <dt>SQLITE_DBCONFIG_LEGACY_FILE_FORMAT</dt>
|
|
jpayne@69
|
2460 ** <dd>The SQLITE_DBCONFIG_LEGACY_FILE_FORMAT option activates or deactivates
|
|
jpayne@69
|
2461 ** the legacy file format flag. When activated, this flag causes all newly
|
|
jpayne@69
|
2462 ** created database file to have a schema format version number (the 4-byte
|
|
jpayne@69
|
2463 ** integer found at offset 44 into the database header) of 1. This in turn
|
|
jpayne@69
|
2464 ** means that the resulting database file will be readable and writable by
|
|
jpayne@69
|
2465 ** any SQLite version back to 3.0.0 ([dateof:3.0.0]). Without this setting,
|
|
jpayne@69
|
2466 ** newly created databases are generally not understandable by SQLite versions
|
|
jpayne@69
|
2467 ** prior to 3.3.0 ([dateof:3.3.0]). As these words are written, there
|
|
jpayne@69
|
2468 ** is now scarcely any need to generate database files that are compatible
|
|
jpayne@69
|
2469 ** all the way back to version 3.0.0, and so this setting is of little
|
|
jpayne@69
|
2470 ** practical use, but is provided so that SQLite can continue to claim the
|
|
jpayne@69
|
2471 ** ability to generate new database files that are compatible with version
|
|
jpayne@69
|
2472 ** 3.0.0.
|
|
jpayne@69
|
2473 ** <p>Note that when the SQLITE_DBCONFIG_LEGACY_FILE_FORMAT setting is on,
|
|
jpayne@69
|
2474 ** the [VACUUM] command will fail with an obscure error when attempting to
|
|
jpayne@69
|
2475 ** process a table with generated columns and a descending index. This is
|
|
jpayne@69
|
2476 ** not considered a bug since SQLite versions 3.3.0 and earlier do not support
|
|
jpayne@69
|
2477 ** either generated columns or descending indexes.
|
|
jpayne@69
|
2478 ** </dd>
|
|
jpayne@69
|
2479 **
|
|
jpayne@69
|
2480 ** [[SQLITE_DBCONFIG_STMT_SCANSTATUS]]
|
|
jpayne@69
|
2481 ** <dt>SQLITE_DBCONFIG_STMT_SCANSTATUS</dt>
|
|
jpayne@69
|
2482 ** <dd>The SQLITE_DBCONFIG_STMT_SCANSTATUS option is only useful in
|
|
jpayne@69
|
2483 ** SQLITE_ENABLE_STMT_SCANSTATUS builds. In this case, it sets or clears
|
|
jpayne@69
|
2484 ** a flag that enables collection of the sqlite3_stmt_scanstatus_v2()
|
|
jpayne@69
|
2485 ** statistics. For statistics to be collected, the flag must be set on
|
|
jpayne@69
|
2486 ** the database handle both when the SQL statement is prepared and when it
|
|
jpayne@69
|
2487 ** is stepped. The flag is set (collection of statistics is enabled)
|
|
jpayne@69
|
2488 ** by default. This option takes two arguments: an integer and a pointer to
|
|
jpayne@69
|
2489 ** an integer.. The first argument is 1, 0, or -1 to enable, disable, or
|
|
jpayne@69
|
2490 ** leave unchanged the statement scanstatus option. If the second argument
|
|
jpayne@69
|
2491 ** is not NULL, then the value of the statement scanstatus setting after
|
|
jpayne@69
|
2492 ** processing the first argument is written into the integer that the second
|
|
jpayne@69
|
2493 ** argument points to.
|
|
jpayne@69
|
2494 ** </dd>
|
|
jpayne@69
|
2495 **
|
|
jpayne@69
|
2496 ** [[SQLITE_DBCONFIG_REVERSE_SCANORDER]]
|
|
jpayne@69
|
2497 ** <dt>SQLITE_DBCONFIG_REVERSE_SCANORDER</dt>
|
|
jpayne@69
|
2498 ** <dd>The SQLITE_DBCONFIG_REVERSE_SCANORDER option changes the default order
|
|
jpayne@69
|
2499 ** in which tables and indexes are scanned so that the scans start at the end
|
|
jpayne@69
|
2500 ** and work toward the beginning rather than starting at the beginning and
|
|
jpayne@69
|
2501 ** working toward the end. Setting SQLITE_DBCONFIG_REVERSE_SCANORDER is the
|
|
jpayne@69
|
2502 ** same as setting [PRAGMA reverse_unordered_selects]. This option takes
|
|
jpayne@69
|
2503 ** two arguments which are an integer and a pointer to an integer. The first
|
|
jpayne@69
|
2504 ** argument is 1, 0, or -1 to enable, disable, or leave unchanged the
|
|
jpayne@69
|
2505 ** reverse scan order flag, respectively. If the second argument is not NULL,
|
|
jpayne@69
|
2506 ** then 0 or 1 is written into the integer that the second argument points to
|
|
jpayne@69
|
2507 ** depending on if the reverse scan order flag is set after processing the
|
|
jpayne@69
|
2508 ** first argument.
|
|
jpayne@69
|
2509 ** </dd>
|
|
jpayne@69
|
2510 **
|
|
jpayne@69
|
2511 ** </dl>
|
|
jpayne@69
|
2512 */
|
|
jpayne@69
|
2513 #define SQLITE_DBCONFIG_MAINDBNAME 1000 /* const char* */
|
|
jpayne@69
|
2514 #define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */
|
|
jpayne@69
|
2515 #define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */
|
|
jpayne@69
|
2516 #define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */
|
|
jpayne@69
|
2517 #define SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER 1004 /* int int* */
|
|
jpayne@69
|
2518 #define SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION 1005 /* int int* */
|
|
jpayne@69
|
2519 #define SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE 1006 /* int int* */
|
|
jpayne@69
|
2520 #define SQLITE_DBCONFIG_ENABLE_QPSG 1007 /* int int* */
|
|
jpayne@69
|
2521 #define SQLITE_DBCONFIG_TRIGGER_EQP 1008 /* int int* */
|
|
jpayne@69
|
2522 #define SQLITE_DBCONFIG_RESET_DATABASE 1009 /* int int* */
|
|
jpayne@69
|
2523 #define SQLITE_DBCONFIG_DEFENSIVE 1010 /* int int* */
|
|
jpayne@69
|
2524 #define SQLITE_DBCONFIG_WRITABLE_SCHEMA 1011 /* int int* */
|
|
jpayne@69
|
2525 #define SQLITE_DBCONFIG_LEGACY_ALTER_TABLE 1012 /* int int* */
|
|
jpayne@69
|
2526 #define SQLITE_DBCONFIG_DQS_DML 1013 /* int int* */
|
|
jpayne@69
|
2527 #define SQLITE_DBCONFIG_DQS_DDL 1014 /* int int* */
|
|
jpayne@69
|
2528 #define SQLITE_DBCONFIG_ENABLE_VIEW 1015 /* int int* */
|
|
jpayne@69
|
2529 #define SQLITE_DBCONFIG_LEGACY_FILE_FORMAT 1016 /* int int* */
|
|
jpayne@69
|
2530 #define SQLITE_DBCONFIG_TRUSTED_SCHEMA 1017 /* int int* */
|
|
jpayne@69
|
2531 #define SQLITE_DBCONFIG_STMT_SCANSTATUS 1018 /* int int* */
|
|
jpayne@69
|
2532 #define SQLITE_DBCONFIG_REVERSE_SCANORDER 1019 /* int int* */
|
|
jpayne@69
|
2533 #define SQLITE_DBCONFIG_MAX 1019 /* Largest DBCONFIG */
|
|
jpayne@69
|
2534
|
|
jpayne@69
|
2535 /*
|
|
jpayne@69
|
2536 ** CAPI3REF: Enable Or Disable Extended Result Codes
|
|
jpayne@69
|
2537 ** METHOD: sqlite3
|
|
jpayne@69
|
2538 **
|
|
jpayne@69
|
2539 ** ^The sqlite3_extended_result_codes() routine enables or disables the
|
|
jpayne@69
|
2540 ** [extended result codes] feature of SQLite. ^The extended result
|
|
jpayne@69
|
2541 ** codes are disabled by default for historical compatibility.
|
|
jpayne@69
|
2542 */
|
|
jpayne@69
|
2543 SQLITE_API int sqlite3_extended_result_codes(sqlite3*, int onoff);
|
|
jpayne@69
|
2544
|
|
jpayne@69
|
2545 /*
|
|
jpayne@69
|
2546 ** CAPI3REF: Last Insert Rowid
|
|
jpayne@69
|
2547 ** METHOD: sqlite3
|
|
jpayne@69
|
2548 **
|
|
jpayne@69
|
2549 ** ^Each entry in most SQLite tables (except for [WITHOUT ROWID] tables)
|
|
jpayne@69
|
2550 ** has a unique 64-bit signed
|
|
jpayne@69
|
2551 ** integer key called the [ROWID | "rowid"]. ^The rowid is always available
|
|
jpayne@69
|
2552 ** as an undeclared column named ROWID, OID, or _ROWID_ as long as those
|
|
jpayne@69
|
2553 ** names are not also used by explicitly declared columns. ^If
|
|
jpayne@69
|
2554 ** the table has a column of type [INTEGER PRIMARY KEY] then that column
|
|
jpayne@69
|
2555 ** is another alias for the rowid.
|
|
jpayne@69
|
2556 **
|
|
jpayne@69
|
2557 ** ^The sqlite3_last_insert_rowid(D) interface usually returns the [rowid] of
|
|
jpayne@69
|
2558 ** the most recent successful [INSERT] into a rowid table or [virtual table]
|
|
jpayne@69
|
2559 ** on database connection D. ^Inserts into [WITHOUT ROWID] tables are not
|
|
jpayne@69
|
2560 ** recorded. ^If no successful [INSERT]s into rowid tables have ever occurred
|
|
jpayne@69
|
2561 ** on the database connection D, then sqlite3_last_insert_rowid(D) returns
|
|
jpayne@69
|
2562 ** zero.
|
|
jpayne@69
|
2563 **
|
|
jpayne@69
|
2564 ** As well as being set automatically as rows are inserted into database
|
|
jpayne@69
|
2565 ** tables, the value returned by this function may be set explicitly by
|
|
jpayne@69
|
2566 ** [sqlite3_set_last_insert_rowid()]
|
|
jpayne@69
|
2567 **
|
|
jpayne@69
|
2568 ** Some virtual table implementations may INSERT rows into rowid tables as
|
|
jpayne@69
|
2569 ** part of committing a transaction (e.g. to flush data accumulated in memory
|
|
jpayne@69
|
2570 ** to disk). In this case subsequent calls to this function return the rowid
|
|
jpayne@69
|
2571 ** associated with these internal INSERT operations, which leads to
|
|
jpayne@69
|
2572 ** unintuitive results. Virtual table implementations that do write to rowid
|
|
jpayne@69
|
2573 ** tables in this way can avoid this problem by restoring the original
|
|
jpayne@69
|
2574 ** rowid value using [sqlite3_set_last_insert_rowid()] before returning
|
|
jpayne@69
|
2575 ** control to the user.
|
|
jpayne@69
|
2576 **
|
|
jpayne@69
|
2577 ** ^(If an [INSERT] occurs within a trigger then this routine will
|
|
jpayne@69
|
2578 ** return the [rowid] of the inserted row as long as the trigger is
|
|
jpayne@69
|
2579 ** running. Once the trigger program ends, the value returned
|
|
jpayne@69
|
2580 ** by this routine reverts to what it was before the trigger was fired.)^
|
|
jpayne@69
|
2581 **
|
|
jpayne@69
|
2582 ** ^An [INSERT] that fails due to a constraint violation is not a
|
|
jpayne@69
|
2583 ** successful [INSERT] and does not change the value returned by this
|
|
jpayne@69
|
2584 ** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK,
|
|
jpayne@69
|
2585 ** and INSERT OR ABORT make no changes to the return value of this
|
|
jpayne@69
|
2586 ** routine when their insertion fails. ^(When INSERT OR REPLACE
|
|
jpayne@69
|
2587 ** encounters a constraint violation, it does not fail. The
|
|
jpayne@69
|
2588 ** INSERT continues to completion after deleting rows that caused
|
|
jpayne@69
|
2589 ** the constraint problem so INSERT OR REPLACE will always change
|
|
jpayne@69
|
2590 ** the return value of this interface.)^
|
|
jpayne@69
|
2591 **
|
|
jpayne@69
|
2592 ** ^For the purposes of this routine, an [INSERT] is considered to
|
|
jpayne@69
|
2593 ** be successful even if it is subsequently rolled back.
|
|
jpayne@69
|
2594 **
|
|
jpayne@69
|
2595 ** This function is accessible to SQL statements via the
|
|
jpayne@69
|
2596 ** [last_insert_rowid() SQL function].
|
|
jpayne@69
|
2597 **
|
|
jpayne@69
|
2598 ** If a separate thread performs a new [INSERT] on the same
|
|
jpayne@69
|
2599 ** database connection while the [sqlite3_last_insert_rowid()]
|
|
jpayne@69
|
2600 ** function is running and thus changes the last insert [rowid],
|
|
jpayne@69
|
2601 ** then the value returned by [sqlite3_last_insert_rowid()] is
|
|
jpayne@69
|
2602 ** unpredictable and might not equal either the old or the new
|
|
jpayne@69
|
2603 ** last insert [rowid].
|
|
jpayne@69
|
2604 */
|
|
jpayne@69
|
2605 SQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*);
|
|
jpayne@69
|
2606
|
|
jpayne@69
|
2607 /*
|
|
jpayne@69
|
2608 ** CAPI3REF: Set the Last Insert Rowid value.
|
|
jpayne@69
|
2609 ** METHOD: sqlite3
|
|
jpayne@69
|
2610 **
|
|
jpayne@69
|
2611 ** The sqlite3_set_last_insert_rowid(D, R) method allows the application to
|
|
jpayne@69
|
2612 ** set the value returned by calling sqlite3_last_insert_rowid(D) to R
|
|
jpayne@69
|
2613 ** without inserting a row into the database.
|
|
jpayne@69
|
2614 */
|
|
jpayne@69
|
2615 SQLITE_API void sqlite3_set_last_insert_rowid(sqlite3*,sqlite3_int64);
|
|
jpayne@69
|
2616
|
|
jpayne@69
|
2617 /*
|
|
jpayne@69
|
2618 ** CAPI3REF: Count The Number Of Rows Modified
|
|
jpayne@69
|
2619 ** METHOD: sqlite3
|
|
jpayne@69
|
2620 **
|
|
jpayne@69
|
2621 ** ^These functions return the number of rows modified, inserted or
|
|
jpayne@69
|
2622 ** deleted by the most recently completed INSERT, UPDATE or DELETE
|
|
jpayne@69
|
2623 ** statement on the database connection specified by the only parameter.
|
|
jpayne@69
|
2624 ** The two functions are identical except for the type of the return value
|
|
jpayne@69
|
2625 ** and that if the number of rows modified by the most recent INSERT, UPDATE
|
|
jpayne@69
|
2626 ** or DELETE is greater than the maximum value supported by type "int", then
|
|
jpayne@69
|
2627 ** the return value of sqlite3_changes() is undefined. ^Executing any other
|
|
jpayne@69
|
2628 ** type of SQL statement does not modify the value returned by these functions.
|
|
jpayne@69
|
2629 **
|
|
jpayne@69
|
2630 ** ^Only changes made directly by the INSERT, UPDATE or DELETE statement are
|
|
jpayne@69
|
2631 ** considered - auxiliary changes caused by [CREATE TRIGGER | triggers],
|
|
jpayne@69
|
2632 ** [foreign key actions] or [REPLACE] constraint resolution are not counted.
|
|
jpayne@69
|
2633 **
|
|
jpayne@69
|
2634 ** Changes to a view that are intercepted by
|
|
jpayne@69
|
2635 ** [INSTEAD OF trigger | INSTEAD OF triggers] are not counted. ^The value
|
|
jpayne@69
|
2636 ** returned by sqlite3_changes() immediately after an INSERT, UPDATE or
|
|
jpayne@69
|
2637 ** DELETE statement run on a view is always zero. Only changes made to real
|
|
jpayne@69
|
2638 ** tables are counted.
|
|
jpayne@69
|
2639 **
|
|
jpayne@69
|
2640 ** Things are more complicated if the sqlite3_changes() function is
|
|
jpayne@69
|
2641 ** executed while a trigger program is running. This may happen if the
|
|
jpayne@69
|
2642 ** program uses the [changes() SQL function], or if some other callback
|
|
jpayne@69
|
2643 ** function invokes sqlite3_changes() directly. Essentially:
|
|
jpayne@69
|
2644 **
|
|
jpayne@69
|
2645 ** <ul>
|
|
jpayne@69
|
2646 ** <li> ^(Before entering a trigger program the value returned by
|
|
jpayne@69
|
2647 ** sqlite3_changes() function is saved. After the trigger program
|
|
jpayne@69
|
2648 ** has finished, the original value is restored.)^
|
|
jpayne@69
|
2649 **
|
|
jpayne@69
|
2650 ** <li> ^(Within a trigger program each INSERT, UPDATE and DELETE
|
|
jpayne@69
|
2651 ** statement sets the value returned by sqlite3_changes()
|
|
jpayne@69
|
2652 ** upon completion as normal. Of course, this value will not include
|
|
jpayne@69
|
2653 ** any changes performed by sub-triggers, as the sqlite3_changes()
|
|
jpayne@69
|
2654 ** value will be saved and restored after each sub-trigger has run.)^
|
|
jpayne@69
|
2655 ** </ul>
|
|
jpayne@69
|
2656 **
|
|
jpayne@69
|
2657 ** ^This means that if the changes() SQL function (or similar) is used
|
|
jpayne@69
|
2658 ** by the first INSERT, UPDATE or DELETE statement within a trigger, it
|
|
jpayne@69
|
2659 ** returns the value as set when the calling statement began executing.
|
|
jpayne@69
|
2660 ** ^If it is used by the second or subsequent such statement within a trigger
|
|
jpayne@69
|
2661 ** program, the value returned reflects the number of rows modified by the
|
|
jpayne@69
|
2662 ** previous INSERT, UPDATE or DELETE statement within the same trigger.
|
|
jpayne@69
|
2663 **
|
|
jpayne@69
|
2664 ** If a separate thread makes changes on the same database connection
|
|
jpayne@69
|
2665 ** while [sqlite3_changes()] is running then the value returned
|
|
jpayne@69
|
2666 ** is unpredictable and not meaningful.
|
|
jpayne@69
|
2667 **
|
|
jpayne@69
|
2668 ** See also:
|
|
jpayne@69
|
2669 ** <ul>
|
|
jpayne@69
|
2670 ** <li> the [sqlite3_total_changes()] interface
|
|
jpayne@69
|
2671 ** <li> the [count_changes pragma]
|
|
jpayne@69
|
2672 ** <li> the [changes() SQL function]
|
|
jpayne@69
|
2673 ** <li> the [data_version pragma]
|
|
jpayne@69
|
2674 ** </ul>
|
|
jpayne@69
|
2675 */
|
|
jpayne@69
|
2676 SQLITE_API int sqlite3_changes(sqlite3*);
|
|
jpayne@69
|
2677 SQLITE_API sqlite3_int64 sqlite3_changes64(sqlite3*);
|
|
jpayne@69
|
2678
|
|
jpayne@69
|
2679 /*
|
|
jpayne@69
|
2680 ** CAPI3REF: Total Number Of Rows Modified
|
|
jpayne@69
|
2681 ** METHOD: sqlite3
|
|
jpayne@69
|
2682 **
|
|
jpayne@69
|
2683 ** ^These functions return the total number of rows inserted, modified or
|
|
jpayne@69
|
2684 ** deleted by all [INSERT], [UPDATE] or [DELETE] statements completed
|
|
jpayne@69
|
2685 ** since the database connection was opened, including those executed as
|
|
jpayne@69
|
2686 ** part of trigger programs. The two functions are identical except for the
|
|
jpayne@69
|
2687 ** type of the return value and that if the number of rows modified by the
|
|
jpayne@69
|
2688 ** connection exceeds the maximum value supported by type "int", then
|
|
jpayne@69
|
2689 ** the return value of sqlite3_total_changes() is undefined. ^Executing
|
|
jpayne@69
|
2690 ** any other type of SQL statement does not affect the value returned by
|
|
jpayne@69
|
2691 ** sqlite3_total_changes().
|
|
jpayne@69
|
2692 **
|
|
jpayne@69
|
2693 ** ^Changes made as part of [foreign key actions] are included in the
|
|
jpayne@69
|
2694 ** count, but those made as part of REPLACE constraint resolution are
|
|
jpayne@69
|
2695 ** not. ^Changes to a view that are intercepted by INSTEAD OF triggers
|
|
jpayne@69
|
2696 ** are not counted.
|
|
jpayne@69
|
2697 **
|
|
jpayne@69
|
2698 ** The [sqlite3_total_changes(D)] interface only reports the number
|
|
jpayne@69
|
2699 ** of rows that changed due to SQL statement run against database
|
|
jpayne@69
|
2700 ** connection D. Any changes by other database connections are ignored.
|
|
jpayne@69
|
2701 ** To detect changes against a database file from other database
|
|
jpayne@69
|
2702 ** connections use the [PRAGMA data_version] command or the
|
|
jpayne@69
|
2703 ** [SQLITE_FCNTL_DATA_VERSION] [file control].
|
|
jpayne@69
|
2704 **
|
|
jpayne@69
|
2705 ** If a separate thread makes changes on the same database connection
|
|
jpayne@69
|
2706 ** while [sqlite3_total_changes()] is running then the value
|
|
jpayne@69
|
2707 ** returned is unpredictable and not meaningful.
|
|
jpayne@69
|
2708 **
|
|
jpayne@69
|
2709 ** See also:
|
|
jpayne@69
|
2710 ** <ul>
|
|
jpayne@69
|
2711 ** <li> the [sqlite3_changes()] interface
|
|
jpayne@69
|
2712 ** <li> the [count_changes pragma]
|
|
jpayne@69
|
2713 ** <li> the [changes() SQL function]
|
|
jpayne@69
|
2714 ** <li> the [data_version pragma]
|
|
jpayne@69
|
2715 ** <li> the [SQLITE_FCNTL_DATA_VERSION] [file control]
|
|
jpayne@69
|
2716 ** </ul>
|
|
jpayne@69
|
2717 */
|
|
jpayne@69
|
2718 SQLITE_API int sqlite3_total_changes(sqlite3*);
|
|
jpayne@69
|
2719 SQLITE_API sqlite3_int64 sqlite3_total_changes64(sqlite3*);
|
|
jpayne@69
|
2720
|
|
jpayne@69
|
2721 /*
|
|
jpayne@69
|
2722 ** CAPI3REF: Interrupt A Long-Running Query
|
|
jpayne@69
|
2723 ** METHOD: sqlite3
|
|
jpayne@69
|
2724 **
|
|
jpayne@69
|
2725 ** ^This function causes any pending database operation to abort and
|
|
jpayne@69
|
2726 ** return at its earliest opportunity. This routine is typically
|
|
jpayne@69
|
2727 ** called in response to a user action such as pressing "Cancel"
|
|
jpayne@69
|
2728 ** or Ctrl-C where the user wants a long query operation to halt
|
|
jpayne@69
|
2729 ** immediately.
|
|
jpayne@69
|
2730 **
|
|
jpayne@69
|
2731 ** ^It is safe to call this routine from a thread different from the
|
|
jpayne@69
|
2732 ** thread that is currently running the database operation. But it
|
|
jpayne@69
|
2733 ** is not safe to call this routine with a [database connection] that
|
|
jpayne@69
|
2734 ** is closed or might close before sqlite3_interrupt() returns.
|
|
jpayne@69
|
2735 **
|
|
jpayne@69
|
2736 ** ^If an SQL operation is very nearly finished at the time when
|
|
jpayne@69
|
2737 ** sqlite3_interrupt() is called, then it might not have an opportunity
|
|
jpayne@69
|
2738 ** to be interrupted and might continue to completion.
|
|
jpayne@69
|
2739 **
|
|
jpayne@69
|
2740 ** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT].
|
|
jpayne@69
|
2741 ** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE
|
|
jpayne@69
|
2742 ** that is inside an explicit transaction, then the entire transaction
|
|
jpayne@69
|
2743 ** will be rolled back automatically.
|
|
jpayne@69
|
2744 **
|
|
jpayne@69
|
2745 ** ^The sqlite3_interrupt(D) call is in effect until all currently running
|
|
jpayne@69
|
2746 ** SQL statements on [database connection] D complete. ^Any new SQL statements
|
|
jpayne@69
|
2747 ** that are started after the sqlite3_interrupt() call and before the
|
|
jpayne@69
|
2748 ** running statement count reaches zero are interrupted as if they had been
|
|
jpayne@69
|
2749 ** running prior to the sqlite3_interrupt() call. ^New SQL statements
|
|
jpayne@69
|
2750 ** that are started after the running statement count reaches zero are
|
|
jpayne@69
|
2751 ** not effected by the sqlite3_interrupt().
|
|
jpayne@69
|
2752 ** ^A call to sqlite3_interrupt(D) that occurs when there are no running
|
|
jpayne@69
|
2753 ** SQL statements is a no-op and has no effect on SQL statements
|
|
jpayne@69
|
2754 ** that are started after the sqlite3_interrupt() call returns.
|
|
jpayne@69
|
2755 **
|
|
jpayne@69
|
2756 ** ^The [sqlite3_is_interrupted(D)] interface can be used to determine whether
|
|
jpayne@69
|
2757 ** or not an interrupt is currently in effect for [database connection] D.
|
|
jpayne@69
|
2758 ** It returns 1 if an interrupt is currently in effect, or 0 otherwise.
|
|
jpayne@69
|
2759 */
|
|
jpayne@69
|
2760 SQLITE_API void sqlite3_interrupt(sqlite3*);
|
|
jpayne@69
|
2761 SQLITE_API int sqlite3_is_interrupted(sqlite3*);
|
|
jpayne@69
|
2762
|
|
jpayne@69
|
2763 /*
|
|
jpayne@69
|
2764 ** CAPI3REF: Determine If An SQL Statement Is Complete
|
|
jpayne@69
|
2765 **
|
|
jpayne@69
|
2766 ** These routines are useful during command-line input to determine if the
|
|
jpayne@69
|
2767 ** currently entered text seems to form a complete SQL statement or
|
|
jpayne@69
|
2768 ** if additional input is needed before sending the text into
|
|
jpayne@69
|
2769 ** SQLite for parsing. ^These routines return 1 if the input string
|
|
jpayne@69
|
2770 ** appears to be a complete SQL statement. ^A statement is judged to be
|
|
jpayne@69
|
2771 ** complete if it ends with a semicolon token and is not a prefix of a
|
|
jpayne@69
|
2772 ** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within
|
|
jpayne@69
|
2773 ** string literals or quoted identifier names or comments are not
|
|
jpayne@69
|
2774 ** independent tokens (they are part of the token in which they are
|
|
jpayne@69
|
2775 ** embedded) and thus do not count as a statement terminator. ^Whitespace
|
|
jpayne@69
|
2776 ** and comments that follow the final semicolon are ignored.
|
|
jpayne@69
|
2777 **
|
|
jpayne@69
|
2778 ** ^These routines return 0 if the statement is incomplete. ^If a
|
|
jpayne@69
|
2779 ** memory allocation fails, then SQLITE_NOMEM is returned.
|
|
jpayne@69
|
2780 **
|
|
jpayne@69
|
2781 ** ^These routines do not parse the SQL statements thus
|
|
jpayne@69
|
2782 ** will not detect syntactically incorrect SQL.
|
|
jpayne@69
|
2783 **
|
|
jpayne@69
|
2784 ** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior
|
|
jpayne@69
|
2785 ** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked
|
|
jpayne@69
|
2786 ** automatically by sqlite3_complete16(). If that initialization fails,
|
|
jpayne@69
|
2787 ** then the return value from sqlite3_complete16() will be non-zero
|
|
jpayne@69
|
2788 ** regardless of whether or not the input SQL is complete.)^
|
|
jpayne@69
|
2789 **
|
|
jpayne@69
|
2790 ** The input to [sqlite3_complete()] must be a zero-terminated
|
|
jpayne@69
|
2791 ** UTF-8 string.
|
|
jpayne@69
|
2792 **
|
|
jpayne@69
|
2793 ** The input to [sqlite3_complete16()] must be a zero-terminated
|
|
jpayne@69
|
2794 ** UTF-16 string in native byte order.
|
|
jpayne@69
|
2795 */
|
|
jpayne@69
|
2796 SQLITE_API int sqlite3_complete(const char *sql);
|
|
jpayne@69
|
2797 SQLITE_API int sqlite3_complete16(const void *sql);
|
|
jpayne@69
|
2798
|
|
jpayne@69
|
2799 /*
|
|
jpayne@69
|
2800 ** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors
|
|
jpayne@69
|
2801 ** KEYWORDS: {busy-handler callback} {busy handler}
|
|
jpayne@69
|
2802 ** METHOD: sqlite3
|
|
jpayne@69
|
2803 **
|
|
jpayne@69
|
2804 ** ^The sqlite3_busy_handler(D,X,P) routine sets a callback function X
|
|
jpayne@69
|
2805 ** that might be invoked with argument P whenever
|
|
jpayne@69
|
2806 ** an attempt is made to access a database table associated with
|
|
jpayne@69
|
2807 ** [database connection] D when another thread
|
|
jpayne@69
|
2808 ** or process has the table locked.
|
|
jpayne@69
|
2809 ** The sqlite3_busy_handler() interface is used to implement
|
|
jpayne@69
|
2810 ** [sqlite3_busy_timeout()] and [PRAGMA busy_timeout].
|
|
jpayne@69
|
2811 **
|
|
jpayne@69
|
2812 ** ^If the busy callback is NULL, then [SQLITE_BUSY]
|
|
jpayne@69
|
2813 ** is returned immediately upon encountering the lock. ^If the busy callback
|
|
jpayne@69
|
2814 ** is not NULL, then the callback might be invoked with two arguments.
|
|
jpayne@69
|
2815 **
|
|
jpayne@69
|
2816 ** ^The first argument to the busy handler is a copy of the void* pointer which
|
|
jpayne@69
|
2817 ** is the third argument to sqlite3_busy_handler(). ^The second argument to
|
|
jpayne@69
|
2818 ** the busy handler callback is the number of times that the busy handler has
|
|
jpayne@69
|
2819 ** been invoked previously for the same locking event. ^If the
|
|
jpayne@69
|
2820 ** busy callback returns 0, then no additional attempts are made to
|
|
jpayne@69
|
2821 ** access the database and [SQLITE_BUSY] is returned
|
|
jpayne@69
|
2822 ** to the application.
|
|
jpayne@69
|
2823 ** ^If the callback returns non-zero, then another attempt
|
|
jpayne@69
|
2824 ** is made to access the database and the cycle repeats.
|
|
jpayne@69
|
2825 **
|
|
jpayne@69
|
2826 ** The presence of a busy handler does not guarantee that it will be invoked
|
|
jpayne@69
|
2827 ** when there is lock contention. ^If SQLite determines that invoking the busy
|
|
jpayne@69
|
2828 ** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY]
|
|
jpayne@69
|
2829 ** to the application instead of invoking the
|
|
jpayne@69
|
2830 ** busy handler.
|
|
jpayne@69
|
2831 ** Consider a scenario where one process is holding a read lock that
|
|
jpayne@69
|
2832 ** it is trying to promote to a reserved lock and
|
|
jpayne@69
|
2833 ** a second process is holding a reserved lock that it is trying
|
|
jpayne@69
|
2834 ** to promote to an exclusive lock. The first process cannot proceed
|
|
jpayne@69
|
2835 ** because it is blocked by the second and the second process cannot
|
|
jpayne@69
|
2836 ** proceed because it is blocked by the first. If both processes
|
|
jpayne@69
|
2837 ** invoke the busy handlers, neither will make any progress. Therefore,
|
|
jpayne@69
|
2838 ** SQLite returns [SQLITE_BUSY] for the first process, hoping that this
|
|
jpayne@69
|
2839 ** will induce the first process to release its read lock and allow
|
|
jpayne@69
|
2840 ** the second process to proceed.
|
|
jpayne@69
|
2841 **
|
|
jpayne@69
|
2842 ** ^The default busy callback is NULL.
|
|
jpayne@69
|
2843 **
|
|
jpayne@69
|
2844 ** ^(There can only be a single busy handler defined for each
|
|
jpayne@69
|
2845 ** [database connection]. Setting a new busy handler clears any
|
|
jpayne@69
|
2846 ** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()]
|
|
jpayne@69
|
2847 ** or evaluating [PRAGMA busy_timeout=N] will change the
|
|
jpayne@69
|
2848 ** busy handler and thus clear any previously set busy handler.
|
|
jpayne@69
|
2849 **
|
|
jpayne@69
|
2850 ** The busy callback should not take any actions which modify the
|
|
jpayne@69
|
2851 ** database connection that invoked the busy handler. In other words,
|
|
jpayne@69
|
2852 ** the busy handler is not reentrant. Any such actions
|
|
jpayne@69
|
2853 ** result in undefined behavior.
|
|
jpayne@69
|
2854 **
|
|
jpayne@69
|
2855 ** A busy handler must not close the database connection
|
|
jpayne@69
|
2856 ** or [prepared statement] that invoked the busy handler.
|
|
jpayne@69
|
2857 */
|
|
jpayne@69
|
2858 SQLITE_API int sqlite3_busy_handler(sqlite3*,int(*)(void*,int),void*);
|
|
jpayne@69
|
2859
|
|
jpayne@69
|
2860 /*
|
|
jpayne@69
|
2861 ** CAPI3REF: Set A Busy Timeout
|
|
jpayne@69
|
2862 ** METHOD: sqlite3
|
|
jpayne@69
|
2863 **
|
|
jpayne@69
|
2864 ** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps
|
|
jpayne@69
|
2865 ** for a specified amount of time when a table is locked. ^The handler
|
|
jpayne@69
|
2866 ** will sleep multiple times until at least "ms" milliseconds of sleeping
|
|
jpayne@69
|
2867 ** have accumulated. ^After at least "ms" milliseconds of sleeping,
|
|
jpayne@69
|
2868 ** the handler returns 0 which causes [sqlite3_step()] to return
|
|
jpayne@69
|
2869 ** [SQLITE_BUSY].
|
|
jpayne@69
|
2870 **
|
|
jpayne@69
|
2871 ** ^Calling this routine with an argument less than or equal to zero
|
|
jpayne@69
|
2872 ** turns off all busy handlers.
|
|
jpayne@69
|
2873 **
|
|
jpayne@69
|
2874 ** ^(There can only be a single busy handler for a particular
|
|
jpayne@69
|
2875 ** [database connection] at any given moment. If another busy handler
|
|
jpayne@69
|
2876 ** was defined (using [sqlite3_busy_handler()]) prior to calling
|
|
jpayne@69
|
2877 ** this routine, that other busy handler is cleared.)^
|
|
jpayne@69
|
2878 **
|
|
jpayne@69
|
2879 ** See also: [PRAGMA busy_timeout]
|
|
jpayne@69
|
2880 */
|
|
jpayne@69
|
2881 SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms);
|
|
jpayne@69
|
2882
|
|
jpayne@69
|
2883 /*
|
|
jpayne@69
|
2884 ** CAPI3REF: Convenience Routines For Running Queries
|
|
jpayne@69
|
2885 ** METHOD: sqlite3
|
|
jpayne@69
|
2886 **
|
|
jpayne@69
|
2887 ** This is a legacy interface that is preserved for backwards compatibility.
|
|
jpayne@69
|
2888 ** Use of this interface is not recommended.
|
|
jpayne@69
|
2889 **
|
|
jpayne@69
|
2890 ** Definition: A <b>result table</b> is memory data structure created by the
|
|
jpayne@69
|
2891 ** [sqlite3_get_table()] interface. A result table records the
|
|
jpayne@69
|
2892 ** complete query results from one or more queries.
|
|
jpayne@69
|
2893 **
|
|
jpayne@69
|
2894 ** The table conceptually has a number of rows and columns. But
|
|
jpayne@69
|
2895 ** these numbers are not part of the result table itself. These
|
|
jpayne@69
|
2896 ** numbers are obtained separately. Let N be the number of rows
|
|
jpayne@69
|
2897 ** and M be the number of columns.
|
|
jpayne@69
|
2898 **
|
|
jpayne@69
|
2899 ** A result table is an array of pointers to zero-terminated UTF-8 strings.
|
|
jpayne@69
|
2900 ** There are (N+1)*M elements in the array. The first M pointers point
|
|
jpayne@69
|
2901 ** to zero-terminated strings that contain the names of the columns.
|
|
jpayne@69
|
2902 ** The remaining entries all point to query results. NULL values result
|
|
jpayne@69
|
2903 ** in NULL pointers. All other values are in their UTF-8 zero-terminated
|
|
jpayne@69
|
2904 ** string representation as returned by [sqlite3_column_text()].
|
|
jpayne@69
|
2905 **
|
|
jpayne@69
|
2906 ** A result table might consist of one or more memory allocations.
|
|
jpayne@69
|
2907 ** It is not safe to pass a result table directly to [sqlite3_free()].
|
|
jpayne@69
|
2908 ** A result table should be deallocated using [sqlite3_free_table()].
|
|
jpayne@69
|
2909 **
|
|
jpayne@69
|
2910 ** ^(As an example of the result table format, suppose a query result
|
|
jpayne@69
|
2911 ** is as follows:
|
|
jpayne@69
|
2912 **
|
|
jpayne@69
|
2913 ** <blockquote><pre>
|
|
jpayne@69
|
2914 ** Name | Age
|
|
jpayne@69
|
2915 ** -----------------------
|
|
jpayne@69
|
2916 ** Alice | 43
|
|
jpayne@69
|
2917 ** Bob | 28
|
|
jpayne@69
|
2918 ** Cindy | 21
|
|
jpayne@69
|
2919 ** </pre></blockquote>
|
|
jpayne@69
|
2920 **
|
|
jpayne@69
|
2921 ** There are two columns (M==2) and three rows (N==3). Thus the
|
|
jpayne@69
|
2922 ** result table has 8 entries. Suppose the result table is stored
|
|
jpayne@69
|
2923 ** in an array named azResult. Then azResult holds this content:
|
|
jpayne@69
|
2924 **
|
|
jpayne@69
|
2925 ** <blockquote><pre>
|
|
jpayne@69
|
2926 ** azResult[0] = "Name";
|
|
jpayne@69
|
2927 ** azResult[1] = "Age";
|
|
jpayne@69
|
2928 ** azResult[2] = "Alice";
|
|
jpayne@69
|
2929 ** azResult[3] = "43";
|
|
jpayne@69
|
2930 ** azResult[4] = "Bob";
|
|
jpayne@69
|
2931 ** azResult[5] = "28";
|
|
jpayne@69
|
2932 ** azResult[6] = "Cindy";
|
|
jpayne@69
|
2933 ** azResult[7] = "21";
|
|
jpayne@69
|
2934 ** </pre></blockquote>)^
|
|
jpayne@69
|
2935 **
|
|
jpayne@69
|
2936 ** ^The sqlite3_get_table() function evaluates one or more
|
|
jpayne@69
|
2937 ** semicolon-separated SQL statements in the zero-terminated UTF-8
|
|
jpayne@69
|
2938 ** string of its 2nd parameter and returns a result table to the
|
|
jpayne@69
|
2939 ** pointer given in its 3rd parameter.
|
|
jpayne@69
|
2940 **
|
|
jpayne@69
|
2941 ** After the application has finished with the result from sqlite3_get_table(),
|
|
jpayne@69
|
2942 ** it must pass the result table pointer to sqlite3_free_table() in order to
|
|
jpayne@69
|
2943 ** release the memory that was malloced. Because of the way the
|
|
jpayne@69
|
2944 ** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling
|
|
jpayne@69
|
2945 ** function must not try to call [sqlite3_free()] directly. Only
|
|
jpayne@69
|
2946 ** [sqlite3_free_table()] is able to release the memory properly and safely.
|
|
jpayne@69
|
2947 **
|
|
jpayne@69
|
2948 ** The sqlite3_get_table() interface is implemented as a wrapper around
|
|
jpayne@69
|
2949 ** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access
|
|
jpayne@69
|
2950 ** to any internal data structures of SQLite. It uses only the public
|
|
jpayne@69
|
2951 ** interface defined here. As a consequence, errors that occur in the
|
|
jpayne@69
|
2952 ** wrapper layer outside of the internal [sqlite3_exec()] call are not
|
|
jpayne@69
|
2953 ** reflected in subsequent calls to [sqlite3_errcode()] or
|
|
jpayne@69
|
2954 ** [sqlite3_errmsg()].
|
|
jpayne@69
|
2955 */
|
|
jpayne@69
|
2956 SQLITE_API int sqlite3_get_table(
|
|
jpayne@69
|
2957 sqlite3 *db, /* An open database */
|
|
jpayne@69
|
2958 const char *zSql, /* SQL to be evaluated */
|
|
jpayne@69
|
2959 char ***pazResult, /* Results of the query */
|
|
jpayne@69
|
2960 int *pnRow, /* Number of result rows written here */
|
|
jpayne@69
|
2961 int *pnColumn, /* Number of result columns written here */
|
|
jpayne@69
|
2962 char **pzErrmsg /* Error msg written here */
|
|
jpayne@69
|
2963 );
|
|
jpayne@69
|
2964 SQLITE_API void sqlite3_free_table(char **result);
|
|
jpayne@69
|
2965
|
|
jpayne@69
|
2966 /*
|
|
jpayne@69
|
2967 ** CAPI3REF: Formatted String Printing Functions
|
|
jpayne@69
|
2968 **
|
|
jpayne@69
|
2969 ** These routines are work-alikes of the "printf()" family of functions
|
|
jpayne@69
|
2970 ** from the standard C library.
|
|
jpayne@69
|
2971 ** These routines understand most of the common formatting options from
|
|
jpayne@69
|
2972 ** the standard library printf()
|
|
jpayne@69
|
2973 ** plus some additional non-standard formats ([%q], [%Q], [%w], and [%z]).
|
|
jpayne@69
|
2974 ** See the [built-in printf()] documentation for details.
|
|
jpayne@69
|
2975 **
|
|
jpayne@69
|
2976 ** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their
|
|
jpayne@69
|
2977 ** results into memory obtained from [sqlite3_malloc64()].
|
|
jpayne@69
|
2978 ** The strings returned by these two routines should be
|
|
jpayne@69
|
2979 ** released by [sqlite3_free()]. ^Both routines return a
|
|
jpayne@69
|
2980 ** NULL pointer if [sqlite3_malloc64()] is unable to allocate enough
|
|
jpayne@69
|
2981 ** memory to hold the resulting string.
|
|
jpayne@69
|
2982 **
|
|
jpayne@69
|
2983 ** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from
|
|
jpayne@69
|
2984 ** the standard C library. The result is written into the
|
|
jpayne@69
|
2985 ** buffer supplied as the second parameter whose size is given by
|
|
jpayne@69
|
2986 ** the first parameter. Note that the order of the
|
|
jpayne@69
|
2987 ** first two parameters is reversed from snprintf().)^ This is an
|
|
jpayne@69
|
2988 ** historical accident that cannot be fixed without breaking
|
|
jpayne@69
|
2989 ** backwards compatibility. ^(Note also that sqlite3_snprintf()
|
|
jpayne@69
|
2990 ** returns a pointer to its buffer instead of the number of
|
|
jpayne@69
|
2991 ** characters actually written into the buffer.)^ We admit that
|
|
jpayne@69
|
2992 ** the number of characters written would be a more useful return
|
|
jpayne@69
|
2993 ** value but we cannot change the implementation of sqlite3_snprintf()
|
|
jpayne@69
|
2994 ** now without breaking compatibility.
|
|
jpayne@69
|
2995 **
|
|
jpayne@69
|
2996 ** ^As long as the buffer size is greater than zero, sqlite3_snprintf()
|
|
jpayne@69
|
2997 ** guarantees that the buffer is always zero-terminated. ^The first
|
|
jpayne@69
|
2998 ** parameter "n" is the total size of the buffer, including space for
|
|
jpayne@69
|
2999 ** the zero terminator. So the longest string that can be completely
|
|
jpayne@69
|
3000 ** written will be n-1 characters.
|
|
jpayne@69
|
3001 **
|
|
jpayne@69
|
3002 ** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf().
|
|
jpayne@69
|
3003 **
|
|
jpayne@69
|
3004 ** See also: [built-in printf()], [printf() SQL function]
|
|
jpayne@69
|
3005 */
|
|
jpayne@69
|
3006 SQLITE_API char *sqlite3_mprintf(const char*,...);
|
|
jpayne@69
|
3007 SQLITE_API char *sqlite3_vmprintf(const char*, va_list);
|
|
jpayne@69
|
3008 SQLITE_API char *sqlite3_snprintf(int,char*,const char*, ...);
|
|
jpayne@69
|
3009 SQLITE_API char *sqlite3_vsnprintf(int,char*,const char*, va_list);
|
|
jpayne@69
|
3010
|
|
jpayne@69
|
3011 /*
|
|
jpayne@69
|
3012 ** CAPI3REF: Memory Allocation Subsystem
|
|
jpayne@69
|
3013 **
|
|
jpayne@69
|
3014 ** The SQLite core uses these three routines for all of its own
|
|
jpayne@69
|
3015 ** internal memory allocation needs. "Core" in the previous sentence
|
|
jpayne@69
|
3016 ** does not include operating-system specific [VFS] implementation. The
|
|
jpayne@69
|
3017 ** Windows VFS uses native malloc() and free() for some operations.
|
|
jpayne@69
|
3018 **
|
|
jpayne@69
|
3019 ** ^The sqlite3_malloc() routine returns a pointer to a block
|
|
jpayne@69
|
3020 ** of memory at least N bytes in length, where N is the parameter.
|
|
jpayne@69
|
3021 ** ^If sqlite3_malloc() is unable to obtain sufficient free
|
|
jpayne@69
|
3022 ** memory, it returns a NULL pointer. ^If the parameter N to
|
|
jpayne@69
|
3023 ** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns
|
|
jpayne@69
|
3024 ** a NULL pointer.
|
|
jpayne@69
|
3025 **
|
|
jpayne@69
|
3026 ** ^The sqlite3_malloc64(N) routine works just like
|
|
jpayne@69
|
3027 ** sqlite3_malloc(N) except that N is an unsigned 64-bit integer instead
|
|
jpayne@69
|
3028 ** of a signed 32-bit integer.
|
|
jpayne@69
|
3029 **
|
|
jpayne@69
|
3030 ** ^Calling sqlite3_free() with a pointer previously returned
|
|
jpayne@69
|
3031 ** by sqlite3_malloc() or sqlite3_realloc() releases that memory so
|
|
jpayne@69
|
3032 ** that it might be reused. ^The sqlite3_free() routine is
|
|
jpayne@69
|
3033 ** a no-op if is called with a NULL pointer. Passing a NULL pointer
|
|
jpayne@69
|
3034 ** to sqlite3_free() is harmless. After being freed, memory
|
|
jpayne@69
|
3035 ** should neither be read nor written. Even reading previously freed
|
|
jpayne@69
|
3036 ** memory might result in a segmentation fault or other severe error.
|
|
jpayne@69
|
3037 ** Memory corruption, a segmentation fault, or other severe error
|
|
jpayne@69
|
3038 ** might result if sqlite3_free() is called with a non-NULL pointer that
|
|
jpayne@69
|
3039 ** was not obtained from sqlite3_malloc() or sqlite3_realloc().
|
|
jpayne@69
|
3040 **
|
|
jpayne@69
|
3041 ** ^The sqlite3_realloc(X,N) interface attempts to resize a
|
|
jpayne@69
|
3042 ** prior memory allocation X to be at least N bytes.
|
|
jpayne@69
|
3043 ** ^If the X parameter to sqlite3_realloc(X,N)
|
|
jpayne@69
|
3044 ** is a NULL pointer then its behavior is identical to calling
|
|
jpayne@69
|
3045 ** sqlite3_malloc(N).
|
|
jpayne@69
|
3046 ** ^If the N parameter to sqlite3_realloc(X,N) is zero or
|
|
jpayne@69
|
3047 ** negative then the behavior is exactly the same as calling
|
|
jpayne@69
|
3048 ** sqlite3_free(X).
|
|
jpayne@69
|
3049 ** ^sqlite3_realloc(X,N) returns a pointer to a memory allocation
|
|
jpayne@69
|
3050 ** of at least N bytes in size or NULL if insufficient memory is available.
|
|
jpayne@69
|
3051 ** ^If M is the size of the prior allocation, then min(N,M) bytes
|
|
jpayne@69
|
3052 ** of the prior allocation are copied into the beginning of buffer returned
|
|
jpayne@69
|
3053 ** by sqlite3_realloc(X,N) and the prior allocation is freed.
|
|
jpayne@69
|
3054 ** ^If sqlite3_realloc(X,N) returns NULL and N is positive, then the
|
|
jpayne@69
|
3055 ** prior allocation is not freed.
|
|
jpayne@69
|
3056 **
|
|
jpayne@69
|
3057 ** ^The sqlite3_realloc64(X,N) interfaces works the same as
|
|
jpayne@69
|
3058 ** sqlite3_realloc(X,N) except that N is a 64-bit unsigned integer instead
|
|
jpayne@69
|
3059 ** of a 32-bit signed integer.
|
|
jpayne@69
|
3060 **
|
|
jpayne@69
|
3061 ** ^If X is a memory allocation previously obtained from sqlite3_malloc(),
|
|
jpayne@69
|
3062 ** sqlite3_malloc64(), sqlite3_realloc(), or sqlite3_realloc64(), then
|
|
jpayne@69
|
3063 ** sqlite3_msize(X) returns the size of that memory allocation in bytes.
|
|
jpayne@69
|
3064 ** ^The value returned by sqlite3_msize(X) might be larger than the number
|
|
jpayne@69
|
3065 ** of bytes requested when X was allocated. ^If X is a NULL pointer then
|
|
jpayne@69
|
3066 ** sqlite3_msize(X) returns zero. If X points to something that is not
|
|
jpayne@69
|
3067 ** the beginning of memory allocation, or if it points to a formerly
|
|
jpayne@69
|
3068 ** valid memory allocation that has now been freed, then the behavior
|
|
jpayne@69
|
3069 ** of sqlite3_msize(X) is undefined and possibly harmful.
|
|
jpayne@69
|
3070 **
|
|
jpayne@69
|
3071 ** ^The memory returned by sqlite3_malloc(), sqlite3_realloc(),
|
|
jpayne@69
|
3072 ** sqlite3_malloc64(), and sqlite3_realloc64()
|
|
jpayne@69
|
3073 ** is always aligned to at least an 8 byte boundary, or to a
|
|
jpayne@69
|
3074 ** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time
|
|
jpayne@69
|
3075 ** option is used.
|
|
jpayne@69
|
3076 **
|
|
jpayne@69
|
3077 ** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()]
|
|
jpayne@69
|
3078 ** must be either NULL or else pointers obtained from a prior
|
|
jpayne@69
|
3079 ** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have
|
|
jpayne@69
|
3080 ** not yet been released.
|
|
jpayne@69
|
3081 **
|
|
jpayne@69
|
3082 ** The application must not read or write any part of
|
|
jpayne@69
|
3083 ** a block of memory after it has been released using
|
|
jpayne@69
|
3084 ** [sqlite3_free()] or [sqlite3_realloc()].
|
|
jpayne@69
|
3085 */
|
|
jpayne@69
|
3086 SQLITE_API void *sqlite3_malloc(int);
|
|
jpayne@69
|
3087 SQLITE_API void *sqlite3_malloc64(sqlite3_uint64);
|
|
jpayne@69
|
3088 SQLITE_API void *sqlite3_realloc(void*, int);
|
|
jpayne@69
|
3089 SQLITE_API void *sqlite3_realloc64(void*, sqlite3_uint64);
|
|
jpayne@69
|
3090 SQLITE_API void sqlite3_free(void*);
|
|
jpayne@69
|
3091 SQLITE_API sqlite3_uint64 sqlite3_msize(void*);
|
|
jpayne@69
|
3092
|
|
jpayne@69
|
3093 /*
|
|
jpayne@69
|
3094 ** CAPI3REF: Memory Allocator Statistics
|
|
jpayne@69
|
3095 **
|
|
jpayne@69
|
3096 ** SQLite provides these two interfaces for reporting on the status
|
|
jpayne@69
|
3097 ** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()]
|
|
jpayne@69
|
3098 ** routines, which form the built-in memory allocation subsystem.
|
|
jpayne@69
|
3099 **
|
|
jpayne@69
|
3100 ** ^The [sqlite3_memory_used()] routine returns the number of bytes
|
|
jpayne@69
|
3101 ** of memory currently outstanding (malloced but not freed).
|
|
jpayne@69
|
3102 ** ^The [sqlite3_memory_highwater()] routine returns the maximum
|
|
jpayne@69
|
3103 ** value of [sqlite3_memory_used()] since the high-water mark
|
|
jpayne@69
|
3104 ** was last reset. ^The values returned by [sqlite3_memory_used()] and
|
|
jpayne@69
|
3105 ** [sqlite3_memory_highwater()] include any overhead
|
|
jpayne@69
|
3106 ** added by SQLite in its implementation of [sqlite3_malloc()],
|
|
jpayne@69
|
3107 ** but not overhead added by the any underlying system library
|
|
jpayne@69
|
3108 ** routines that [sqlite3_malloc()] may call.
|
|
jpayne@69
|
3109 **
|
|
jpayne@69
|
3110 ** ^The memory high-water mark is reset to the current value of
|
|
jpayne@69
|
3111 ** [sqlite3_memory_used()] if and only if the parameter to
|
|
jpayne@69
|
3112 ** [sqlite3_memory_highwater()] is true. ^The value returned
|
|
jpayne@69
|
3113 ** by [sqlite3_memory_highwater(1)] is the high-water mark
|
|
jpayne@69
|
3114 ** prior to the reset.
|
|
jpayne@69
|
3115 */
|
|
jpayne@69
|
3116 SQLITE_API sqlite3_int64 sqlite3_memory_used(void);
|
|
jpayne@69
|
3117 SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag);
|
|
jpayne@69
|
3118
|
|
jpayne@69
|
3119 /*
|
|
jpayne@69
|
3120 ** CAPI3REF: Pseudo-Random Number Generator
|
|
jpayne@69
|
3121 **
|
|
jpayne@69
|
3122 ** SQLite contains a high-quality pseudo-random number generator (PRNG) used to
|
|
jpayne@69
|
3123 ** select random [ROWID | ROWIDs] when inserting new records into a table that
|
|
jpayne@69
|
3124 ** already uses the largest possible [ROWID]. The PRNG is also used for
|
|
jpayne@69
|
3125 ** the built-in random() and randomblob() SQL functions. This interface allows
|
|
jpayne@69
|
3126 ** applications to access the same PRNG for other purposes.
|
|
jpayne@69
|
3127 **
|
|
jpayne@69
|
3128 ** ^A call to this routine stores N bytes of randomness into buffer P.
|
|
jpayne@69
|
3129 ** ^The P parameter can be a NULL pointer.
|
|
jpayne@69
|
3130 **
|
|
jpayne@69
|
3131 ** ^If this routine has not been previously called or if the previous
|
|
jpayne@69
|
3132 ** call had N less than one or a NULL pointer for P, then the PRNG is
|
|
jpayne@69
|
3133 ** seeded using randomness obtained from the xRandomness method of
|
|
jpayne@69
|
3134 ** the default [sqlite3_vfs] object.
|
|
jpayne@69
|
3135 ** ^If the previous call to this routine had an N of 1 or more and a
|
|
jpayne@69
|
3136 ** non-NULL P then the pseudo-randomness is generated
|
|
jpayne@69
|
3137 ** internally and without recourse to the [sqlite3_vfs] xRandomness
|
|
jpayne@69
|
3138 ** method.
|
|
jpayne@69
|
3139 */
|
|
jpayne@69
|
3140 SQLITE_API void sqlite3_randomness(int N, void *P);
|
|
jpayne@69
|
3141
|
|
jpayne@69
|
3142 /*
|
|
jpayne@69
|
3143 ** CAPI3REF: Compile-Time Authorization Callbacks
|
|
jpayne@69
|
3144 ** METHOD: sqlite3
|
|
jpayne@69
|
3145 ** KEYWORDS: {authorizer callback}
|
|
jpayne@69
|
3146 **
|
|
jpayne@69
|
3147 ** ^This routine registers an authorizer callback with a particular
|
|
jpayne@69
|
3148 ** [database connection], supplied in the first argument.
|
|
jpayne@69
|
3149 ** ^The authorizer callback is invoked as SQL statements are being compiled
|
|
jpayne@69
|
3150 ** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()],
|
|
jpayne@69
|
3151 ** [sqlite3_prepare_v3()], [sqlite3_prepare16()], [sqlite3_prepare16_v2()],
|
|
jpayne@69
|
3152 ** and [sqlite3_prepare16_v3()]. ^At various
|
|
jpayne@69
|
3153 ** points during the compilation process, as logic is being created
|
|
jpayne@69
|
3154 ** to perform various actions, the authorizer callback is invoked to
|
|
jpayne@69
|
3155 ** see if those actions are allowed. ^The authorizer callback should
|
|
jpayne@69
|
3156 ** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the
|
|
jpayne@69
|
3157 ** specific action but allow the SQL statement to continue to be
|
|
jpayne@69
|
3158 ** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be
|
|
jpayne@69
|
3159 ** rejected with an error. ^If the authorizer callback returns
|
|
jpayne@69
|
3160 ** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY]
|
|
jpayne@69
|
3161 ** then the [sqlite3_prepare_v2()] or equivalent call that triggered
|
|
jpayne@69
|
3162 ** the authorizer will fail with an error message.
|
|
jpayne@69
|
3163 **
|
|
jpayne@69
|
3164 ** When the callback returns [SQLITE_OK], that means the operation
|
|
jpayne@69
|
3165 ** requested is ok. ^When the callback returns [SQLITE_DENY], the
|
|
jpayne@69
|
3166 ** [sqlite3_prepare_v2()] or equivalent call that triggered the
|
|
jpayne@69
|
3167 ** authorizer will fail with an error message explaining that
|
|
jpayne@69
|
3168 ** access is denied.
|
|
jpayne@69
|
3169 **
|
|
jpayne@69
|
3170 ** ^The first parameter to the authorizer callback is a copy of the third
|
|
jpayne@69
|
3171 ** parameter to the sqlite3_set_authorizer() interface. ^The second parameter
|
|
jpayne@69
|
3172 ** to the callback is an integer [SQLITE_COPY | action code] that specifies
|
|
jpayne@69
|
3173 ** the particular action to be authorized. ^The third through sixth parameters
|
|
jpayne@69
|
3174 ** to the callback are either NULL pointers or zero-terminated strings
|
|
jpayne@69
|
3175 ** that contain additional details about the action to be authorized.
|
|
jpayne@69
|
3176 ** Applications must always be prepared to encounter a NULL pointer in any
|
|
jpayne@69
|
3177 ** of the third through the sixth parameters of the authorization callback.
|
|
jpayne@69
|
3178 **
|
|
jpayne@69
|
3179 ** ^If the action code is [SQLITE_READ]
|
|
jpayne@69
|
3180 ** and the callback returns [SQLITE_IGNORE] then the
|
|
jpayne@69
|
3181 ** [prepared statement] statement is constructed to substitute
|
|
jpayne@69
|
3182 ** a NULL value in place of the table column that would have
|
|
jpayne@69
|
3183 ** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE]
|
|
jpayne@69
|
3184 ** return can be used to deny an untrusted user access to individual
|
|
jpayne@69
|
3185 ** columns of a table.
|
|
jpayne@69
|
3186 ** ^When a table is referenced by a [SELECT] but no column values are
|
|
jpayne@69
|
3187 ** extracted from that table (for example in a query like
|
|
jpayne@69
|
3188 ** "SELECT count(*) FROM tab") then the [SQLITE_READ] authorizer callback
|
|
jpayne@69
|
3189 ** is invoked once for that table with a column name that is an empty string.
|
|
jpayne@69
|
3190 ** ^If the action code is [SQLITE_DELETE] and the callback returns
|
|
jpayne@69
|
3191 ** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the
|
|
jpayne@69
|
3192 ** [truncate optimization] is disabled and all rows are deleted individually.
|
|
jpayne@69
|
3193 **
|
|
jpayne@69
|
3194 ** An authorizer is used when [sqlite3_prepare | preparing]
|
|
jpayne@69
|
3195 ** SQL statements from an untrusted source, to ensure that the SQL statements
|
|
jpayne@69
|
3196 ** do not try to access data they are not allowed to see, or that they do not
|
|
jpayne@69
|
3197 ** try to execute malicious statements that damage the database. For
|
|
jpayne@69
|
3198 ** example, an application may allow a user to enter arbitrary
|
|
jpayne@69
|
3199 ** SQL queries for evaluation by a database. But the application does
|
|
jpayne@69
|
3200 ** not want the user to be able to make arbitrary changes to the
|
|
jpayne@69
|
3201 ** database. An authorizer could then be put in place while the
|
|
jpayne@69
|
3202 ** user-entered SQL is being [sqlite3_prepare | prepared] that
|
|
jpayne@69
|
3203 ** disallows everything except [SELECT] statements.
|
|
jpayne@69
|
3204 **
|
|
jpayne@69
|
3205 ** Applications that need to process SQL from untrusted sources
|
|
jpayne@69
|
3206 ** might also consider lowering resource limits using [sqlite3_limit()]
|
|
jpayne@69
|
3207 ** and limiting database size using the [max_page_count] [PRAGMA]
|
|
jpayne@69
|
3208 ** in addition to using an authorizer.
|
|
jpayne@69
|
3209 **
|
|
jpayne@69
|
3210 ** ^(Only a single authorizer can be in place on a database connection
|
|
jpayne@69
|
3211 ** at a time. Each call to sqlite3_set_authorizer overrides the
|
|
jpayne@69
|
3212 ** previous call.)^ ^Disable the authorizer by installing a NULL callback.
|
|
jpayne@69
|
3213 ** The authorizer is disabled by default.
|
|
jpayne@69
|
3214 **
|
|
jpayne@69
|
3215 ** The authorizer callback must not do anything that will modify
|
|
jpayne@69
|
3216 ** the database connection that invoked the authorizer callback.
|
|
jpayne@69
|
3217 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
|
|
jpayne@69
|
3218 ** database connections for the meaning of "modify" in this paragraph.
|
|
jpayne@69
|
3219 **
|
|
jpayne@69
|
3220 ** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the
|
|
jpayne@69
|
3221 ** statement might be re-prepared during [sqlite3_step()] due to a
|
|
jpayne@69
|
3222 ** schema change. Hence, the application should ensure that the
|
|
jpayne@69
|
3223 ** correct authorizer callback remains in place during the [sqlite3_step()].
|
|
jpayne@69
|
3224 **
|
|
jpayne@69
|
3225 ** ^Note that the authorizer callback is invoked only during
|
|
jpayne@69
|
3226 ** [sqlite3_prepare()] or its variants. Authorization is not
|
|
jpayne@69
|
3227 ** performed during statement evaluation in [sqlite3_step()], unless
|
|
jpayne@69
|
3228 ** as stated in the previous paragraph, sqlite3_step() invokes
|
|
jpayne@69
|
3229 ** sqlite3_prepare_v2() to reprepare a statement after a schema change.
|
|
jpayne@69
|
3230 */
|
|
jpayne@69
|
3231 SQLITE_API int sqlite3_set_authorizer(
|
|
jpayne@69
|
3232 sqlite3*,
|
|
jpayne@69
|
3233 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
|
|
jpayne@69
|
3234 void *pUserData
|
|
jpayne@69
|
3235 );
|
|
jpayne@69
|
3236
|
|
jpayne@69
|
3237 /*
|
|
jpayne@69
|
3238 ** CAPI3REF: Authorizer Return Codes
|
|
jpayne@69
|
3239 **
|
|
jpayne@69
|
3240 ** The [sqlite3_set_authorizer | authorizer callback function] must
|
|
jpayne@69
|
3241 ** return either [SQLITE_OK] or one of these two constants in order
|
|
jpayne@69
|
3242 ** to signal SQLite whether or not the action is permitted. See the
|
|
jpayne@69
|
3243 ** [sqlite3_set_authorizer | authorizer documentation] for additional
|
|
jpayne@69
|
3244 ** information.
|
|
jpayne@69
|
3245 **
|
|
jpayne@69
|
3246 ** Note that SQLITE_IGNORE is also used as a [conflict resolution mode]
|
|
jpayne@69
|
3247 ** returned from the [sqlite3_vtab_on_conflict()] interface.
|
|
jpayne@69
|
3248 */
|
|
jpayne@69
|
3249 #define SQLITE_DENY 1 /* Abort the SQL statement with an error */
|
|
jpayne@69
|
3250 #define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
|
|
jpayne@69
|
3251
|
|
jpayne@69
|
3252 /*
|
|
jpayne@69
|
3253 ** CAPI3REF: Authorizer Action Codes
|
|
jpayne@69
|
3254 **
|
|
jpayne@69
|
3255 ** The [sqlite3_set_authorizer()] interface registers a callback function
|
|
jpayne@69
|
3256 ** that is invoked to authorize certain SQL statement actions. The
|
|
jpayne@69
|
3257 ** second parameter to the callback is an integer code that specifies
|
|
jpayne@69
|
3258 ** what action is being authorized. These are the integer action codes that
|
|
jpayne@69
|
3259 ** the authorizer callback may be passed.
|
|
jpayne@69
|
3260 **
|
|
jpayne@69
|
3261 ** These action code values signify what kind of operation is to be
|
|
jpayne@69
|
3262 ** authorized. The 3rd and 4th parameters to the authorization
|
|
jpayne@69
|
3263 ** callback function will be parameters or NULL depending on which of these
|
|
jpayne@69
|
3264 ** codes is used as the second parameter. ^(The 5th parameter to the
|
|
jpayne@69
|
3265 ** authorizer callback is the name of the database ("main", "temp",
|
|
jpayne@69
|
3266 ** etc.) if applicable.)^ ^The 6th parameter to the authorizer callback
|
|
jpayne@69
|
3267 ** is the name of the inner-most trigger or view that is responsible for
|
|
jpayne@69
|
3268 ** the access attempt or NULL if this access attempt is directly from
|
|
jpayne@69
|
3269 ** top-level SQL code.
|
|
jpayne@69
|
3270 */
|
|
jpayne@69
|
3271 /******************************************* 3rd ************ 4th ***********/
|
|
jpayne@69
|
3272 #define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */
|
|
jpayne@69
|
3273 #define SQLITE_CREATE_TABLE 2 /* Table Name NULL */
|
|
jpayne@69
|
3274 #define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */
|
|
jpayne@69
|
3275 #define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */
|
|
jpayne@69
|
3276 #define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */
|
|
jpayne@69
|
3277 #define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */
|
|
jpayne@69
|
3278 #define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */
|
|
jpayne@69
|
3279 #define SQLITE_CREATE_VIEW 8 /* View Name NULL */
|
|
jpayne@69
|
3280 #define SQLITE_DELETE 9 /* Table Name NULL */
|
|
jpayne@69
|
3281 #define SQLITE_DROP_INDEX 10 /* Index Name Table Name */
|
|
jpayne@69
|
3282 #define SQLITE_DROP_TABLE 11 /* Table Name NULL */
|
|
jpayne@69
|
3283 #define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */
|
|
jpayne@69
|
3284 #define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */
|
|
jpayne@69
|
3285 #define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */
|
|
jpayne@69
|
3286 #define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */
|
|
jpayne@69
|
3287 #define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */
|
|
jpayne@69
|
3288 #define SQLITE_DROP_VIEW 17 /* View Name NULL */
|
|
jpayne@69
|
3289 #define SQLITE_INSERT 18 /* Table Name NULL */
|
|
jpayne@69
|
3290 #define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */
|
|
jpayne@69
|
3291 #define SQLITE_READ 20 /* Table Name Column Name */
|
|
jpayne@69
|
3292 #define SQLITE_SELECT 21 /* NULL NULL */
|
|
jpayne@69
|
3293 #define SQLITE_TRANSACTION 22 /* Operation NULL */
|
|
jpayne@69
|
3294 #define SQLITE_UPDATE 23 /* Table Name Column Name */
|
|
jpayne@69
|
3295 #define SQLITE_ATTACH 24 /* Filename NULL */
|
|
jpayne@69
|
3296 #define SQLITE_DETACH 25 /* Database Name NULL */
|
|
jpayne@69
|
3297 #define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */
|
|
jpayne@69
|
3298 #define SQLITE_REINDEX 27 /* Index Name NULL */
|
|
jpayne@69
|
3299 #define SQLITE_ANALYZE 28 /* Table Name NULL */
|
|
jpayne@69
|
3300 #define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */
|
|
jpayne@69
|
3301 #define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */
|
|
jpayne@69
|
3302 #define SQLITE_FUNCTION 31 /* NULL Function Name */
|
|
jpayne@69
|
3303 #define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */
|
|
jpayne@69
|
3304 #define SQLITE_COPY 0 /* No longer used */
|
|
jpayne@69
|
3305 #define SQLITE_RECURSIVE 33 /* NULL NULL */
|
|
jpayne@69
|
3306
|
|
jpayne@69
|
3307 /*
|
|
jpayne@69
|
3308 ** CAPI3REF: Deprecated Tracing And Profiling Functions
|
|
jpayne@69
|
3309 ** DEPRECATED
|
|
jpayne@69
|
3310 **
|
|
jpayne@69
|
3311 ** These routines are deprecated. Use the [sqlite3_trace_v2()] interface
|
|
jpayne@69
|
3312 ** instead of the routines described here.
|
|
jpayne@69
|
3313 **
|
|
jpayne@69
|
3314 ** These routines register callback functions that can be used for
|
|
jpayne@69
|
3315 ** tracing and profiling the execution of SQL statements.
|
|
jpayne@69
|
3316 **
|
|
jpayne@69
|
3317 ** ^The callback function registered by sqlite3_trace() is invoked at
|
|
jpayne@69
|
3318 ** various times when an SQL statement is being run by [sqlite3_step()].
|
|
jpayne@69
|
3319 ** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the
|
|
jpayne@69
|
3320 ** SQL statement text as the statement first begins executing.
|
|
jpayne@69
|
3321 ** ^(Additional sqlite3_trace() callbacks might occur
|
|
jpayne@69
|
3322 ** as each triggered subprogram is entered. The callbacks for triggers
|
|
jpayne@69
|
3323 ** contain a UTF-8 SQL comment that identifies the trigger.)^
|
|
jpayne@69
|
3324 **
|
|
jpayne@69
|
3325 ** The [SQLITE_TRACE_SIZE_LIMIT] compile-time option can be used to limit
|
|
jpayne@69
|
3326 ** the length of [bound parameter] expansion in the output of sqlite3_trace().
|
|
jpayne@69
|
3327 **
|
|
jpayne@69
|
3328 ** ^The callback function registered by sqlite3_profile() is invoked
|
|
jpayne@69
|
3329 ** as each SQL statement finishes. ^The profile callback contains
|
|
jpayne@69
|
3330 ** the original statement text and an estimate of wall-clock time
|
|
jpayne@69
|
3331 ** of how long that statement took to run. ^The profile callback
|
|
jpayne@69
|
3332 ** time is in units of nanoseconds, however the current implementation
|
|
jpayne@69
|
3333 ** is only capable of millisecond resolution so the six least significant
|
|
jpayne@69
|
3334 ** digits in the time are meaningless. Future versions of SQLite
|
|
jpayne@69
|
3335 ** might provide greater resolution on the profiler callback. Invoking
|
|
jpayne@69
|
3336 ** either [sqlite3_trace()] or [sqlite3_trace_v2()] will cancel the
|
|
jpayne@69
|
3337 ** profile callback.
|
|
jpayne@69
|
3338 */
|
|
jpayne@69
|
3339 SQLITE_API SQLITE_DEPRECATED void *sqlite3_trace(sqlite3*,
|
|
jpayne@69
|
3340 void(*xTrace)(void*,const char*), void*);
|
|
jpayne@69
|
3341 SQLITE_API SQLITE_DEPRECATED void *sqlite3_profile(sqlite3*,
|
|
jpayne@69
|
3342 void(*xProfile)(void*,const char*,sqlite3_uint64), void*);
|
|
jpayne@69
|
3343
|
|
jpayne@69
|
3344 /*
|
|
jpayne@69
|
3345 ** CAPI3REF: SQL Trace Event Codes
|
|
jpayne@69
|
3346 ** KEYWORDS: SQLITE_TRACE
|
|
jpayne@69
|
3347 **
|
|
jpayne@69
|
3348 ** These constants identify classes of events that can be monitored
|
|
jpayne@69
|
3349 ** using the [sqlite3_trace_v2()] tracing logic. The M argument
|
|
jpayne@69
|
3350 ** to [sqlite3_trace_v2(D,M,X,P)] is an OR-ed combination of one or more of
|
|
jpayne@69
|
3351 ** the following constants. ^The first argument to the trace callback
|
|
jpayne@69
|
3352 ** is one of the following constants.
|
|
jpayne@69
|
3353 **
|
|
jpayne@69
|
3354 ** New tracing constants may be added in future releases.
|
|
jpayne@69
|
3355 **
|
|
jpayne@69
|
3356 ** ^A trace callback has four arguments: xCallback(T,C,P,X).
|
|
jpayne@69
|
3357 ** ^The T argument is one of the integer type codes above.
|
|
jpayne@69
|
3358 ** ^The C argument is a copy of the context pointer passed in as the
|
|
jpayne@69
|
3359 ** fourth argument to [sqlite3_trace_v2()].
|
|
jpayne@69
|
3360 ** The P and X arguments are pointers whose meanings depend on T.
|
|
jpayne@69
|
3361 **
|
|
jpayne@69
|
3362 ** <dl>
|
|
jpayne@69
|
3363 ** [[SQLITE_TRACE_STMT]] <dt>SQLITE_TRACE_STMT</dt>
|
|
jpayne@69
|
3364 ** <dd>^An SQLITE_TRACE_STMT callback is invoked when a prepared statement
|
|
jpayne@69
|
3365 ** first begins running and possibly at other times during the
|
|
jpayne@69
|
3366 ** execution of the prepared statement, such as at the start of each
|
|
jpayne@69
|
3367 ** trigger subprogram. ^The P argument is a pointer to the
|
|
jpayne@69
|
3368 ** [prepared statement]. ^The X argument is a pointer to a string which
|
|
jpayne@69
|
3369 ** is the unexpanded SQL text of the prepared statement or an SQL comment
|
|
jpayne@69
|
3370 ** that indicates the invocation of a trigger. ^The callback can compute
|
|
jpayne@69
|
3371 ** the same text that would have been returned by the legacy [sqlite3_trace()]
|
|
jpayne@69
|
3372 ** interface by using the X argument when X begins with "--" and invoking
|
|
jpayne@69
|
3373 ** [sqlite3_expanded_sql(P)] otherwise.
|
|
jpayne@69
|
3374 **
|
|
jpayne@69
|
3375 ** [[SQLITE_TRACE_PROFILE]] <dt>SQLITE_TRACE_PROFILE</dt>
|
|
jpayne@69
|
3376 ** <dd>^An SQLITE_TRACE_PROFILE callback provides approximately the same
|
|
jpayne@69
|
3377 ** information as is provided by the [sqlite3_profile()] callback.
|
|
jpayne@69
|
3378 ** ^The P argument is a pointer to the [prepared statement] and the
|
|
jpayne@69
|
3379 ** X argument points to a 64-bit integer which is approximately
|
|
jpayne@69
|
3380 ** the number of nanoseconds that the prepared statement took to run.
|
|
jpayne@69
|
3381 ** ^The SQLITE_TRACE_PROFILE callback is invoked when the statement finishes.
|
|
jpayne@69
|
3382 **
|
|
jpayne@69
|
3383 ** [[SQLITE_TRACE_ROW]] <dt>SQLITE_TRACE_ROW</dt>
|
|
jpayne@69
|
3384 ** <dd>^An SQLITE_TRACE_ROW callback is invoked whenever a prepared
|
|
jpayne@69
|
3385 ** statement generates a single row of result.
|
|
jpayne@69
|
3386 ** ^The P argument is a pointer to the [prepared statement] and the
|
|
jpayne@69
|
3387 ** X argument is unused.
|
|
jpayne@69
|
3388 **
|
|
jpayne@69
|
3389 ** [[SQLITE_TRACE_CLOSE]] <dt>SQLITE_TRACE_CLOSE</dt>
|
|
jpayne@69
|
3390 ** <dd>^An SQLITE_TRACE_CLOSE callback is invoked when a database
|
|
jpayne@69
|
3391 ** connection closes.
|
|
jpayne@69
|
3392 ** ^The P argument is a pointer to the [database connection] object
|
|
jpayne@69
|
3393 ** and the X argument is unused.
|
|
jpayne@69
|
3394 ** </dl>
|
|
jpayne@69
|
3395 */
|
|
jpayne@69
|
3396 #define SQLITE_TRACE_STMT 0x01
|
|
jpayne@69
|
3397 #define SQLITE_TRACE_PROFILE 0x02
|
|
jpayne@69
|
3398 #define SQLITE_TRACE_ROW 0x04
|
|
jpayne@69
|
3399 #define SQLITE_TRACE_CLOSE 0x08
|
|
jpayne@69
|
3400
|
|
jpayne@69
|
3401 /*
|
|
jpayne@69
|
3402 ** CAPI3REF: SQL Trace Hook
|
|
jpayne@69
|
3403 ** METHOD: sqlite3
|
|
jpayne@69
|
3404 **
|
|
jpayne@69
|
3405 ** ^The sqlite3_trace_v2(D,M,X,P) interface registers a trace callback
|
|
jpayne@69
|
3406 ** function X against [database connection] D, using property mask M
|
|
jpayne@69
|
3407 ** and context pointer P. ^If the X callback is
|
|
jpayne@69
|
3408 ** NULL or if the M mask is zero, then tracing is disabled. The
|
|
jpayne@69
|
3409 ** M argument should be the bitwise OR-ed combination of
|
|
jpayne@69
|
3410 ** zero or more [SQLITE_TRACE] constants.
|
|
jpayne@69
|
3411 **
|
|
jpayne@69
|
3412 ** ^Each call to either sqlite3_trace(D,X,P) or sqlite3_trace_v2(D,M,X,P)
|
|
jpayne@69
|
3413 ** overrides (cancels) all prior calls to sqlite3_trace(D,X,P) or
|
|
jpayne@69
|
3414 ** sqlite3_trace_v2(D,M,X,P) for the [database connection] D. Each
|
|
jpayne@69
|
3415 ** database connection may have at most one trace callback.
|
|
jpayne@69
|
3416 **
|
|
jpayne@69
|
3417 ** ^The X callback is invoked whenever any of the events identified by
|
|
jpayne@69
|
3418 ** mask M occur. ^The integer return value from the callback is currently
|
|
jpayne@69
|
3419 ** ignored, though this may change in future releases. Callback
|
|
jpayne@69
|
3420 ** implementations should return zero to ensure future compatibility.
|
|
jpayne@69
|
3421 **
|
|
jpayne@69
|
3422 ** ^A trace callback is invoked with four arguments: callback(T,C,P,X).
|
|
jpayne@69
|
3423 ** ^The T argument is one of the [SQLITE_TRACE]
|
|
jpayne@69
|
3424 ** constants to indicate why the callback was invoked.
|
|
jpayne@69
|
3425 ** ^The C argument is a copy of the context pointer.
|
|
jpayne@69
|
3426 ** The P and X arguments are pointers whose meanings depend on T.
|
|
jpayne@69
|
3427 **
|
|
jpayne@69
|
3428 ** The sqlite3_trace_v2() interface is intended to replace the legacy
|
|
jpayne@69
|
3429 ** interfaces [sqlite3_trace()] and [sqlite3_profile()], both of which
|
|
jpayne@69
|
3430 ** are deprecated.
|
|
jpayne@69
|
3431 */
|
|
jpayne@69
|
3432 SQLITE_API int sqlite3_trace_v2(
|
|
jpayne@69
|
3433 sqlite3*,
|
|
jpayne@69
|
3434 unsigned uMask,
|
|
jpayne@69
|
3435 int(*xCallback)(unsigned,void*,void*,void*),
|
|
jpayne@69
|
3436 void *pCtx
|
|
jpayne@69
|
3437 );
|
|
jpayne@69
|
3438
|
|
jpayne@69
|
3439 /*
|
|
jpayne@69
|
3440 ** CAPI3REF: Query Progress Callbacks
|
|
jpayne@69
|
3441 ** METHOD: sqlite3
|
|
jpayne@69
|
3442 **
|
|
jpayne@69
|
3443 ** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback
|
|
jpayne@69
|
3444 ** function X to be invoked periodically during long running calls to
|
|
jpayne@69
|
3445 ** [sqlite3_step()] and [sqlite3_prepare()] and similar for
|
|
jpayne@69
|
3446 ** database connection D. An example use for this
|
|
jpayne@69
|
3447 ** interface is to keep a GUI updated during a large query.
|
|
jpayne@69
|
3448 **
|
|
jpayne@69
|
3449 ** ^The parameter P is passed through as the only parameter to the
|
|
jpayne@69
|
3450 ** callback function X. ^The parameter N is the approximate number of
|
|
jpayne@69
|
3451 ** [virtual machine instructions] that are evaluated between successive
|
|
jpayne@69
|
3452 ** invocations of the callback X. ^If N is less than one then the progress
|
|
jpayne@69
|
3453 ** handler is disabled.
|
|
jpayne@69
|
3454 **
|
|
jpayne@69
|
3455 ** ^Only a single progress handler may be defined at one time per
|
|
jpayne@69
|
3456 ** [database connection]; setting a new progress handler cancels the
|
|
jpayne@69
|
3457 ** old one. ^Setting parameter X to NULL disables the progress handler.
|
|
jpayne@69
|
3458 ** ^The progress handler is also disabled by setting N to a value less
|
|
jpayne@69
|
3459 ** than 1.
|
|
jpayne@69
|
3460 **
|
|
jpayne@69
|
3461 ** ^If the progress callback returns non-zero, the operation is
|
|
jpayne@69
|
3462 ** interrupted. This feature can be used to implement a
|
|
jpayne@69
|
3463 ** "Cancel" button on a GUI progress dialog box.
|
|
jpayne@69
|
3464 **
|
|
jpayne@69
|
3465 ** The progress handler callback must not do anything that will modify
|
|
jpayne@69
|
3466 ** the database connection that invoked the progress handler.
|
|
jpayne@69
|
3467 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
|
|
jpayne@69
|
3468 ** database connections for the meaning of "modify" in this paragraph.
|
|
jpayne@69
|
3469 **
|
|
jpayne@69
|
3470 ** The progress handler callback would originally only be invoked from the
|
|
jpayne@69
|
3471 ** bytecode engine. It still might be invoked during [sqlite3_prepare()]
|
|
jpayne@69
|
3472 ** and similar because those routines might force a reparse of the schema
|
|
jpayne@69
|
3473 ** which involves running the bytecode engine. However, beginning with
|
|
jpayne@69
|
3474 ** SQLite version 3.41.0, the progress handler callback might also be
|
|
jpayne@69
|
3475 ** invoked directly from [sqlite3_prepare()] while analyzing and generating
|
|
jpayne@69
|
3476 ** code for complex queries.
|
|
jpayne@69
|
3477 */
|
|
jpayne@69
|
3478 SQLITE_API void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
|
|
jpayne@69
|
3479
|
|
jpayne@69
|
3480 /*
|
|
jpayne@69
|
3481 ** CAPI3REF: Opening A New Database Connection
|
|
jpayne@69
|
3482 ** CONSTRUCTOR: sqlite3
|
|
jpayne@69
|
3483 **
|
|
jpayne@69
|
3484 ** ^These routines open an SQLite database file as specified by the
|
|
jpayne@69
|
3485 ** filename argument. ^The filename argument is interpreted as UTF-8 for
|
|
jpayne@69
|
3486 ** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte
|
|
jpayne@69
|
3487 ** order for sqlite3_open16(). ^(A [database connection] handle is usually
|
|
jpayne@69
|
3488 ** returned in *ppDb, even if an error occurs. The only exception is that
|
|
jpayne@69
|
3489 ** if SQLite is unable to allocate memory to hold the [sqlite3] object,
|
|
jpayne@69
|
3490 ** a NULL will be written into *ppDb instead of a pointer to the [sqlite3]
|
|
jpayne@69
|
3491 ** object.)^ ^(If the database is opened (and/or created) successfully, then
|
|
jpayne@69
|
3492 ** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The
|
|
jpayne@69
|
3493 ** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain
|
|
jpayne@69
|
3494 ** an English language description of the error following a failure of any
|
|
jpayne@69
|
3495 ** of the sqlite3_open() routines.
|
|
jpayne@69
|
3496 **
|
|
jpayne@69
|
3497 ** ^The default encoding will be UTF-8 for databases created using
|
|
jpayne@69
|
3498 ** sqlite3_open() or sqlite3_open_v2(). ^The default encoding for databases
|
|
jpayne@69
|
3499 ** created using sqlite3_open16() will be UTF-16 in the native byte order.
|
|
jpayne@69
|
3500 **
|
|
jpayne@69
|
3501 ** Whether or not an error occurs when it is opened, resources
|
|
jpayne@69
|
3502 ** associated with the [database connection] handle should be released by
|
|
jpayne@69
|
3503 ** passing it to [sqlite3_close()] when it is no longer required.
|
|
jpayne@69
|
3504 **
|
|
jpayne@69
|
3505 ** The sqlite3_open_v2() interface works like sqlite3_open()
|
|
jpayne@69
|
3506 ** except that it accepts two additional parameters for additional control
|
|
jpayne@69
|
3507 ** over the new database connection. ^(The flags parameter to
|
|
jpayne@69
|
3508 ** sqlite3_open_v2() must include, at a minimum, one of the following
|
|
jpayne@69
|
3509 ** three flag combinations:)^
|
|
jpayne@69
|
3510 **
|
|
jpayne@69
|
3511 ** <dl>
|
|
jpayne@69
|
3512 ** ^(<dt>[SQLITE_OPEN_READONLY]</dt>
|
|
jpayne@69
|
3513 ** <dd>The database is opened in read-only mode. If the database does
|
|
jpayne@69
|
3514 ** not already exist, an error is returned.</dd>)^
|
|
jpayne@69
|
3515 **
|
|
jpayne@69
|
3516 ** ^(<dt>[SQLITE_OPEN_READWRITE]</dt>
|
|
jpayne@69
|
3517 ** <dd>The database is opened for reading and writing if possible, or
|
|
jpayne@69
|
3518 ** reading only if the file is write protected by the operating
|
|
jpayne@69
|
3519 ** system. In either case the database must already exist, otherwise
|
|
jpayne@69
|
3520 ** an error is returned. For historical reasons, if opening in
|
|
jpayne@69
|
3521 ** read-write mode fails due to OS-level permissions, an attempt is
|
|
jpayne@69
|
3522 ** made to open it in read-only mode. [sqlite3_db_readonly()] can be
|
|
jpayne@69
|
3523 ** used to determine whether the database is actually
|
|
jpayne@69
|
3524 ** read-write.</dd>)^
|
|
jpayne@69
|
3525 **
|
|
jpayne@69
|
3526 ** ^(<dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt>
|
|
jpayne@69
|
3527 ** <dd>The database is opened for reading and writing, and is created if
|
|
jpayne@69
|
3528 ** it does not already exist. This is the behavior that is always used for
|
|
jpayne@69
|
3529 ** sqlite3_open() and sqlite3_open16().</dd>)^
|
|
jpayne@69
|
3530 ** </dl>
|
|
jpayne@69
|
3531 **
|
|
jpayne@69
|
3532 ** In addition to the required flags, the following optional flags are
|
|
jpayne@69
|
3533 ** also supported:
|
|
jpayne@69
|
3534 **
|
|
jpayne@69
|
3535 ** <dl>
|
|
jpayne@69
|
3536 ** ^(<dt>[SQLITE_OPEN_URI]</dt>
|
|
jpayne@69
|
3537 ** <dd>The filename can be interpreted as a URI if this flag is set.</dd>)^
|
|
jpayne@69
|
3538 **
|
|
jpayne@69
|
3539 ** ^(<dt>[SQLITE_OPEN_MEMORY]</dt>
|
|
jpayne@69
|
3540 ** <dd>The database will be opened as an in-memory database. The database
|
|
jpayne@69
|
3541 ** is named by the "filename" argument for the purposes of cache-sharing,
|
|
jpayne@69
|
3542 ** if shared cache mode is enabled, but the "filename" is otherwise ignored.
|
|
jpayne@69
|
3543 ** </dd>)^
|
|
jpayne@69
|
3544 **
|
|
jpayne@69
|
3545 ** ^(<dt>[SQLITE_OPEN_NOMUTEX]</dt>
|
|
jpayne@69
|
3546 ** <dd>The new database connection will use the "multi-thread"
|
|
jpayne@69
|
3547 ** [threading mode].)^ This means that separate threads are allowed
|
|
jpayne@69
|
3548 ** to use SQLite at the same time, as long as each thread is using
|
|
jpayne@69
|
3549 ** a different [database connection].
|
|
jpayne@69
|
3550 **
|
|
jpayne@69
|
3551 ** ^(<dt>[SQLITE_OPEN_FULLMUTEX]</dt>
|
|
jpayne@69
|
3552 ** <dd>The new database connection will use the "serialized"
|
|
jpayne@69
|
3553 ** [threading mode].)^ This means the multiple threads can safely
|
|
jpayne@69
|
3554 ** attempt to use the same database connection at the same time.
|
|
jpayne@69
|
3555 ** (Mutexes will block any actual concurrency, but in this mode
|
|
jpayne@69
|
3556 ** there is no harm in trying.)
|
|
jpayne@69
|
3557 **
|
|
jpayne@69
|
3558 ** ^(<dt>[SQLITE_OPEN_SHAREDCACHE]</dt>
|
|
jpayne@69
|
3559 ** <dd>The database is opened [shared cache] enabled, overriding
|
|
jpayne@69
|
3560 ** the default shared cache setting provided by
|
|
jpayne@69
|
3561 ** [sqlite3_enable_shared_cache()].)^
|
|
jpayne@69
|
3562 ** The [use of shared cache mode is discouraged] and hence shared cache
|
|
jpayne@69
|
3563 ** capabilities may be omitted from many builds of SQLite. In such cases,
|
|
jpayne@69
|
3564 ** this option is a no-op.
|
|
jpayne@69
|
3565 **
|
|
jpayne@69
|
3566 ** ^(<dt>[SQLITE_OPEN_PRIVATECACHE]</dt>
|
|
jpayne@69
|
3567 ** <dd>The database is opened [shared cache] disabled, overriding
|
|
jpayne@69
|
3568 ** the default shared cache setting provided by
|
|
jpayne@69
|
3569 ** [sqlite3_enable_shared_cache()].)^
|
|
jpayne@69
|
3570 **
|
|
jpayne@69
|
3571 ** [[OPEN_EXRESCODE]] ^(<dt>[SQLITE_OPEN_EXRESCODE]</dt>
|
|
jpayne@69
|
3572 ** <dd>The database connection comes up in "extended result code mode".
|
|
jpayne@69
|
3573 ** In other words, the database behaves has if
|
|
jpayne@69
|
3574 ** [sqlite3_extended_result_codes(db,1)] where called on the database
|
|
jpayne@69
|
3575 ** connection as soon as the connection is created. In addition to setting
|
|
jpayne@69
|
3576 ** the extended result code mode, this flag also causes [sqlite3_open_v2()]
|
|
jpayne@69
|
3577 ** to return an extended result code.</dd>
|
|
jpayne@69
|
3578 **
|
|
jpayne@69
|
3579 ** [[OPEN_NOFOLLOW]] ^(<dt>[SQLITE_OPEN_NOFOLLOW]</dt>
|
|
jpayne@69
|
3580 ** <dd>The database filename is not allowed to contain a symbolic link</dd>
|
|
jpayne@69
|
3581 ** </dl>)^
|
|
jpayne@69
|
3582 **
|
|
jpayne@69
|
3583 ** If the 3rd parameter to sqlite3_open_v2() is not one of the
|
|
jpayne@69
|
3584 ** required combinations shown above optionally combined with other
|
|
jpayne@69
|
3585 ** [SQLITE_OPEN_READONLY | SQLITE_OPEN_* bits]
|
|
jpayne@69
|
3586 ** then the behavior is undefined. Historic versions of SQLite
|
|
jpayne@69
|
3587 ** have silently ignored surplus bits in the flags parameter to
|
|
jpayne@69
|
3588 ** sqlite3_open_v2(), however that behavior might not be carried through
|
|
jpayne@69
|
3589 ** into future versions of SQLite and so applications should not rely
|
|
jpayne@69
|
3590 ** upon it. Note in particular that the SQLITE_OPEN_EXCLUSIVE flag is a no-op
|
|
jpayne@69
|
3591 ** for sqlite3_open_v2(). The SQLITE_OPEN_EXCLUSIVE does *not* cause
|
|
jpayne@69
|
3592 ** the open to fail if the database already exists. The SQLITE_OPEN_EXCLUSIVE
|
|
jpayne@69
|
3593 ** flag is intended for use by the [sqlite3_vfs|VFS interface] only, and not
|
|
jpayne@69
|
3594 ** by sqlite3_open_v2().
|
|
jpayne@69
|
3595 **
|
|
jpayne@69
|
3596 ** ^The fourth parameter to sqlite3_open_v2() is the name of the
|
|
jpayne@69
|
3597 ** [sqlite3_vfs] object that defines the operating system interface that
|
|
jpayne@69
|
3598 ** the new database connection should use. ^If the fourth parameter is
|
|
jpayne@69
|
3599 ** a NULL pointer then the default [sqlite3_vfs] object is used.
|
|
jpayne@69
|
3600 **
|
|
jpayne@69
|
3601 ** ^If the filename is ":memory:", then a private, temporary in-memory database
|
|
jpayne@69
|
3602 ** is created for the connection. ^This in-memory database will vanish when
|
|
jpayne@69
|
3603 ** the database connection is closed. Future versions of SQLite might
|
|
jpayne@69
|
3604 ** make use of additional special filenames that begin with the ":" character.
|
|
jpayne@69
|
3605 ** It is recommended that when a database filename actually does begin with
|
|
jpayne@69
|
3606 ** a ":" character you should prefix the filename with a pathname such as
|
|
jpayne@69
|
3607 ** "./" to avoid ambiguity.
|
|
jpayne@69
|
3608 **
|
|
jpayne@69
|
3609 ** ^If the filename is an empty string, then a private, temporary
|
|
jpayne@69
|
3610 ** on-disk database will be created. ^This private database will be
|
|
jpayne@69
|
3611 ** automatically deleted as soon as the database connection is closed.
|
|
jpayne@69
|
3612 **
|
|
jpayne@69
|
3613 ** [[URI filenames in sqlite3_open()]] <h3>URI Filenames</h3>
|
|
jpayne@69
|
3614 **
|
|
jpayne@69
|
3615 ** ^If [URI filename] interpretation is enabled, and the filename argument
|
|
jpayne@69
|
3616 ** begins with "file:", then the filename is interpreted as a URI. ^URI
|
|
jpayne@69
|
3617 ** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is
|
|
jpayne@69
|
3618 ** set in the third argument to sqlite3_open_v2(), or if it has
|
|
jpayne@69
|
3619 ** been enabled globally using the [SQLITE_CONFIG_URI] option with the
|
|
jpayne@69
|
3620 ** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option.
|
|
jpayne@69
|
3621 ** URI filename interpretation is turned off
|
|
jpayne@69
|
3622 ** by default, but future releases of SQLite might enable URI filename
|
|
jpayne@69
|
3623 ** interpretation by default. See "[URI filenames]" for additional
|
|
jpayne@69
|
3624 ** information.
|
|
jpayne@69
|
3625 **
|
|
jpayne@69
|
3626 ** URI filenames are parsed according to RFC 3986. ^If the URI contains an
|
|
jpayne@69
|
3627 ** authority, then it must be either an empty string or the string
|
|
jpayne@69
|
3628 ** "localhost". ^If the authority is not an empty string or "localhost", an
|
|
jpayne@69
|
3629 ** error is returned to the caller. ^The fragment component of a URI, if
|
|
jpayne@69
|
3630 ** present, is ignored.
|
|
jpayne@69
|
3631 **
|
|
jpayne@69
|
3632 ** ^SQLite uses the path component of the URI as the name of the disk file
|
|
jpayne@69
|
3633 ** which contains the database. ^If the path begins with a '/' character,
|
|
jpayne@69
|
3634 ** then it is interpreted as an absolute path. ^If the path does not begin
|
|
jpayne@69
|
3635 ** with a '/' (meaning that the authority section is omitted from the URI)
|
|
jpayne@69
|
3636 ** then the path is interpreted as a relative path.
|
|
jpayne@69
|
3637 ** ^(On windows, the first component of an absolute path
|
|
jpayne@69
|
3638 ** is a drive specification (e.g. "C:").)^
|
|
jpayne@69
|
3639 **
|
|
jpayne@69
|
3640 ** [[core URI query parameters]]
|
|
jpayne@69
|
3641 ** The query component of a URI may contain parameters that are interpreted
|
|
jpayne@69
|
3642 ** either by SQLite itself, or by a [VFS | custom VFS implementation].
|
|
jpayne@69
|
3643 ** SQLite and its built-in [VFSes] interpret the
|
|
jpayne@69
|
3644 ** following query parameters:
|
|
jpayne@69
|
3645 **
|
|
jpayne@69
|
3646 ** <ul>
|
|
jpayne@69
|
3647 ** <li> <b>vfs</b>: ^The "vfs" parameter may be used to specify the name of
|
|
jpayne@69
|
3648 ** a VFS object that provides the operating system interface that should
|
|
jpayne@69
|
3649 ** be used to access the database file on disk. ^If this option is set to
|
|
jpayne@69
|
3650 ** an empty string the default VFS object is used. ^Specifying an unknown
|
|
jpayne@69
|
3651 ** VFS is an error. ^If sqlite3_open_v2() is used and the vfs option is
|
|
jpayne@69
|
3652 ** present, then the VFS specified by the option takes precedence over
|
|
jpayne@69
|
3653 ** the value passed as the fourth parameter to sqlite3_open_v2().
|
|
jpayne@69
|
3654 **
|
|
jpayne@69
|
3655 ** <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw",
|
|
jpayne@69
|
3656 ** "rwc", or "memory". Attempting to set it to any other value is
|
|
jpayne@69
|
3657 ** an error)^.
|
|
jpayne@69
|
3658 ** ^If "ro" is specified, then the database is opened for read-only
|
|
jpayne@69
|
3659 ** access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the
|
|
jpayne@69
|
3660 ** third argument to sqlite3_open_v2(). ^If the mode option is set to
|
|
jpayne@69
|
3661 ** "rw", then the database is opened for read-write (but not create)
|
|
jpayne@69
|
3662 ** access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had
|
|
jpayne@69
|
3663 ** been set. ^Value "rwc" is equivalent to setting both
|
|
jpayne@69
|
3664 ** SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE. ^If the mode option is
|
|
jpayne@69
|
3665 ** set to "memory" then a pure [in-memory database] that never reads
|
|
jpayne@69
|
3666 ** or writes from disk is used. ^It is an error to specify a value for
|
|
jpayne@69
|
3667 ** the mode parameter that is less restrictive than that specified by
|
|
jpayne@69
|
3668 ** the flags passed in the third parameter to sqlite3_open_v2().
|
|
jpayne@69
|
3669 **
|
|
jpayne@69
|
3670 ** <li> <b>cache</b>: ^The cache parameter may be set to either "shared" or
|
|
jpayne@69
|
3671 ** "private". ^Setting it to "shared" is equivalent to setting the
|
|
jpayne@69
|
3672 ** SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to
|
|
jpayne@69
|
3673 ** sqlite3_open_v2(). ^Setting the cache parameter to "private" is
|
|
jpayne@69
|
3674 ** equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit.
|
|
jpayne@69
|
3675 ** ^If sqlite3_open_v2() is used and the "cache" parameter is present in
|
|
jpayne@69
|
3676 ** a URI filename, its value overrides any behavior requested by setting
|
|
jpayne@69
|
3677 ** SQLITE_OPEN_PRIVATECACHE or SQLITE_OPEN_SHAREDCACHE flag.
|
|
jpayne@69
|
3678 **
|
|
jpayne@69
|
3679 ** <li> <b>psow</b>: ^The psow parameter indicates whether or not the
|
|
jpayne@69
|
3680 ** [powersafe overwrite] property does or does not apply to the
|
|
jpayne@69
|
3681 ** storage media on which the database file resides.
|
|
jpayne@69
|
3682 **
|
|
jpayne@69
|
3683 ** <li> <b>nolock</b>: ^The nolock parameter is a boolean query parameter
|
|
jpayne@69
|
3684 ** which if set disables file locking in rollback journal modes. This
|
|
jpayne@69
|
3685 ** is useful for accessing a database on a filesystem that does not
|
|
jpayne@69
|
3686 ** support locking. Caution: Database corruption might result if two
|
|
jpayne@69
|
3687 ** or more processes write to the same database and any one of those
|
|
jpayne@69
|
3688 ** processes uses nolock=1.
|
|
jpayne@69
|
3689 **
|
|
jpayne@69
|
3690 ** <li> <b>immutable</b>: ^The immutable parameter is a boolean query
|
|
jpayne@69
|
3691 ** parameter that indicates that the database file is stored on
|
|
jpayne@69
|
3692 ** read-only media. ^When immutable is set, SQLite assumes that the
|
|
jpayne@69
|
3693 ** database file cannot be changed, even by a process with higher
|
|
jpayne@69
|
3694 ** privilege, and so the database is opened read-only and all locking
|
|
jpayne@69
|
3695 ** and change detection is disabled. Caution: Setting the immutable
|
|
jpayne@69
|
3696 ** property on a database file that does in fact change can result
|
|
jpayne@69
|
3697 ** in incorrect query results and/or [SQLITE_CORRUPT] errors.
|
|
jpayne@69
|
3698 ** See also: [SQLITE_IOCAP_IMMUTABLE].
|
|
jpayne@69
|
3699 **
|
|
jpayne@69
|
3700 ** </ul>
|
|
jpayne@69
|
3701 **
|
|
jpayne@69
|
3702 ** ^Specifying an unknown parameter in the query component of a URI is not an
|
|
jpayne@69
|
3703 ** error. Future versions of SQLite might understand additional query
|
|
jpayne@69
|
3704 ** parameters. See "[query parameters with special meaning to SQLite]" for
|
|
jpayne@69
|
3705 ** additional information.
|
|
jpayne@69
|
3706 **
|
|
jpayne@69
|
3707 ** [[URI filename examples]] <h3>URI filename examples</h3>
|
|
jpayne@69
|
3708 **
|
|
jpayne@69
|
3709 ** <table border="1" align=center cellpadding=5>
|
|
jpayne@69
|
3710 ** <tr><th> URI filenames <th> Results
|
|
jpayne@69
|
3711 ** <tr><td> file:data.db <td>
|
|
jpayne@69
|
3712 ** Open the file "data.db" in the current directory.
|
|
jpayne@69
|
3713 ** <tr><td> file:/home/fred/data.db<br>
|
|
jpayne@69
|
3714 ** file:///home/fred/data.db <br>
|
|
jpayne@69
|
3715 ** file://localhost/home/fred/data.db <br> <td>
|
|
jpayne@69
|
3716 ** Open the database file "/home/fred/data.db".
|
|
jpayne@69
|
3717 ** <tr><td> file://darkstar/home/fred/data.db <td>
|
|
jpayne@69
|
3718 ** An error. "darkstar" is not a recognized authority.
|
|
jpayne@69
|
3719 ** <tr><td style="white-space:nowrap">
|
|
jpayne@69
|
3720 ** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db
|
|
jpayne@69
|
3721 ** <td> Windows only: Open the file "data.db" on fred's desktop on drive
|
|
jpayne@69
|
3722 ** C:. Note that the %20 escaping in this example is not strictly
|
|
jpayne@69
|
3723 ** necessary - space characters can be used literally
|
|
jpayne@69
|
3724 ** in URI filenames.
|
|
jpayne@69
|
3725 ** <tr><td> file:data.db?mode=ro&cache=private <td>
|
|
jpayne@69
|
3726 ** Open file "data.db" in the current directory for read-only access.
|
|
jpayne@69
|
3727 ** Regardless of whether or not shared-cache mode is enabled by
|
|
jpayne@69
|
3728 ** default, use a private cache.
|
|
jpayne@69
|
3729 ** <tr><td> file:/home/fred/data.db?vfs=unix-dotfile <td>
|
|
jpayne@69
|
3730 ** Open file "/home/fred/data.db". Use the special VFS "unix-dotfile"
|
|
jpayne@69
|
3731 ** that uses dot-files in place of posix advisory locking.
|
|
jpayne@69
|
3732 ** <tr><td> file:data.db?mode=readonly <td>
|
|
jpayne@69
|
3733 ** An error. "readonly" is not a valid option for the "mode" parameter.
|
|
jpayne@69
|
3734 ** Use "ro" instead: "file:data.db?mode=ro".
|
|
jpayne@69
|
3735 ** </table>
|
|
jpayne@69
|
3736 **
|
|
jpayne@69
|
3737 ** ^URI hexadecimal escape sequences (%HH) are supported within the path and
|
|
jpayne@69
|
3738 ** query components of a URI. A hexadecimal escape sequence consists of a
|
|
jpayne@69
|
3739 ** percent sign - "%" - followed by exactly two hexadecimal digits
|
|
jpayne@69
|
3740 ** specifying an octet value. ^Before the path or query components of a
|
|
jpayne@69
|
3741 ** URI filename are interpreted, they are encoded using UTF-8 and all
|
|
jpayne@69
|
3742 ** hexadecimal escape sequences replaced by a single byte containing the
|
|
jpayne@69
|
3743 ** corresponding octet. If this process generates an invalid UTF-8 encoding,
|
|
jpayne@69
|
3744 ** the results are undefined.
|
|
jpayne@69
|
3745 **
|
|
jpayne@69
|
3746 ** <b>Note to Windows users:</b> The encoding used for the filename argument
|
|
jpayne@69
|
3747 ** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever
|
|
jpayne@69
|
3748 ** codepage is currently defined. Filenames containing international
|
|
jpayne@69
|
3749 ** characters must be converted to UTF-8 prior to passing them into
|
|
jpayne@69
|
3750 ** sqlite3_open() or sqlite3_open_v2().
|
|
jpayne@69
|
3751 **
|
|
jpayne@69
|
3752 ** <b>Note to Windows Runtime users:</b> The temporary directory must be set
|
|
jpayne@69
|
3753 ** prior to calling sqlite3_open() or sqlite3_open_v2(). Otherwise, various
|
|
jpayne@69
|
3754 ** features that require the use of temporary files may fail.
|
|
jpayne@69
|
3755 **
|
|
jpayne@69
|
3756 ** See also: [sqlite3_temp_directory]
|
|
jpayne@69
|
3757 */
|
|
jpayne@69
|
3758 SQLITE_API int sqlite3_open(
|
|
jpayne@69
|
3759 const char *filename, /* Database filename (UTF-8) */
|
|
jpayne@69
|
3760 sqlite3 **ppDb /* OUT: SQLite db handle */
|
|
jpayne@69
|
3761 );
|
|
jpayne@69
|
3762 SQLITE_API int sqlite3_open16(
|
|
jpayne@69
|
3763 const void *filename, /* Database filename (UTF-16) */
|
|
jpayne@69
|
3764 sqlite3 **ppDb /* OUT: SQLite db handle */
|
|
jpayne@69
|
3765 );
|
|
jpayne@69
|
3766 SQLITE_API int sqlite3_open_v2(
|
|
jpayne@69
|
3767 const char *filename, /* Database filename (UTF-8) */
|
|
jpayne@69
|
3768 sqlite3 **ppDb, /* OUT: SQLite db handle */
|
|
jpayne@69
|
3769 int flags, /* Flags */
|
|
jpayne@69
|
3770 const char *zVfs /* Name of VFS module to use */
|
|
jpayne@69
|
3771 );
|
|
jpayne@69
|
3772
|
|
jpayne@69
|
3773 /*
|
|
jpayne@69
|
3774 ** CAPI3REF: Obtain Values For URI Parameters
|
|
jpayne@69
|
3775 **
|
|
jpayne@69
|
3776 ** These are utility routines, useful to [VFS|custom VFS implementations],
|
|
jpayne@69
|
3777 ** that check if a database file was a URI that contained a specific query
|
|
jpayne@69
|
3778 ** parameter, and if so obtains the value of that query parameter.
|
|
jpayne@69
|
3779 **
|
|
jpayne@69
|
3780 ** The first parameter to these interfaces (hereafter referred to
|
|
jpayne@69
|
3781 ** as F) must be one of:
|
|
jpayne@69
|
3782 ** <ul>
|
|
jpayne@69
|
3783 ** <li> A database filename pointer created by the SQLite core and
|
|
jpayne@69
|
3784 ** passed into the xOpen() method of a VFS implementation, or
|
|
jpayne@69
|
3785 ** <li> A filename obtained from [sqlite3_db_filename()], or
|
|
jpayne@69
|
3786 ** <li> A new filename constructed using [sqlite3_create_filename()].
|
|
jpayne@69
|
3787 ** </ul>
|
|
jpayne@69
|
3788 ** If the F parameter is not one of the above, then the behavior is
|
|
jpayne@69
|
3789 ** undefined and probably undesirable. Older versions of SQLite were
|
|
jpayne@69
|
3790 ** more tolerant of invalid F parameters than newer versions.
|
|
jpayne@69
|
3791 **
|
|
jpayne@69
|
3792 ** If F is a suitable filename (as described in the previous paragraph)
|
|
jpayne@69
|
3793 ** and if P is the name of the query parameter, then
|
|
jpayne@69
|
3794 ** sqlite3_uri_parameter(F,P) returns the value of the P
|
|
jpayne@69
|
3795 ** parameter if it exists or a NULL pointer if P does not appear as a
|
|
jpayne@69
|
3796 ** query parameter on F. If P is a query parameter of F and it
|
|
jpayne@69
|
3797 ** has no explicit value, then sqlite3_uri_parameter(F,P) returns
|
|
jpayne@69
|
3798 ** a pointer to an empty string.
|
|
jpayne@69
|
3799 **
|
|
jpayne@69
|
3800 ** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean
|
|
jpayne@69
|
3801 ** parameter and returns true (1) or false (0) according to the value
|
|
jpayne@69
|
3802 ** of P. The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the
|
|
jpayne@69
|
3803 ** value of query parameter P is one of "yes", "true", or "on" in any
|
|
jpayne@69
|
3804 ** case or if the value begins with a non-zero number. The
|
|
jpayne@69
|
3805 ** sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of
|
|
jpayne@69
|
3806 ** query parameter P is one of "no", "false", or "off" in any case or
|
|
jpayne@69
|
3807 ** if the value begins with a numeric zero. If P is not a query
|
|
jpayne@69
|
3808 ** parameter on F or if the value of P does not match any of the
|
|
jpayne@69
|
3809 ** above, then sqlite3_uri_boolean(F,P,B) returns (B!=0).
|
|
jpayne@69
|
3810 **
|
|
jpayne@69
|
3811 ** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a
|
|
jpayne@69
|
3812 ** 64-bit signed integer and returns that integer, or D if P does not
|
|
jpayne@69
|
3813 ** exist. If the value of P is something other than an integer, then
|
|
jpayne@69
|
3814 ** zero is returned.
|
|
jpayne@69
|
3815 **
|
|
jpayne@69
|
3816 ** The sqlite3_uri_key(F,N) returns a pointer to the name (not
|
|
jpayne@69
|
3817 ** the value) of the N-th query parameter for filename F, or a NULL
|
|
jpayne@69
|
3818 ** pointer if N is less than zero or greater than the number of query
|
|
jpayne@69
|
3819 ** parameters minus 1. The N value is zero-based so N should be 0 to obtain
|
|
jpayne@69
|
3820 ** the name of the first query parameter, 1 for the second parameter, and
|
|
jpayne@69
|
3821 ** so forth.
|
|
jpayne@69
|
3822 **
|
|
jpayne@69
|
3823 ** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and
|
|
jpayne@69
|
3824 ** sqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and
|
|
jpayne@69
|
3825 ** is not a database file pathname pointer that the SQLite core passed
|
|
jpayne@69
|
3826 ** into the xOpen VFS method, then the behavior of this routine is undefined
|
|
jpayne@69
|
3827 ** and probably undesirable.
|
|
jpayne@69
|
3828 **
|
|
jpayne@69
|
3829 ** Beginning with SQLite [version 3.31.0] ([dateof:3.31.0]) the input F
|
|
jpayne@69
|
3830 ** parameter can also be the name of a rollback journal file or WAL file
|
|
jpayne@69
|
3831 ** in addition to the main database file. Prior to version 3.31.0, these
|
|
jpayne@69
|
3832 ** routines would only work if F was the name of the main database file.
|
|
jpayne@69
|
3833 ** When the F parameter is the name of the rollback journal or WAL file,
|
|
jpayne@69
|
3834 ** it has access to all the same query parameters as were found on the
|
|
jpayne@69
|
3835 ** main database file.
|
|
jpayne@69
|
3836 **
|
|
jpayne@69
|
3837 ** See the [URI filename] documentation for additional information.
|
|
jpayne@69
|
3838 */
|
|
jpayne@69
|
3839 SQLITE_API const char *sqlite3_uri_parameter(sqlite3_filename z, const char *zParam);
|
|
jpayne@69
|
3840 SQLITE_API int sqlite3_uri_boolean(sqlite3_filename z, const char *zParam, int bDefault);
|
|
jpayne@69
|
3841 SQLITE_API sqlite3_int64 sqlite3_uri_int64(sqlite3_filename, const char*, sqlite3_int64);
|
|
jpayne@69
|
3842 SQLITE_API const char *sqlite3_uri_key(sqlite3_filename z, int N);
|
|
jpayne@69
|
3843
|
|
jpayne@69
|
3844 /*
|
|
jpayne@69
|
3845 ** CAPI3REF: Translate filenames
|
|
jpayne@69
|
3846 **
|
|
jpayne@69
|
3847 ** These routines are available to [VFS|custom VFS implementations] for
|
|
jpayne@69
|
3848 ** translating filenames between the main database file, the journal file,
|
|
jpayne@69
|
3849 ** and the WAL file.
|
|
jpayne@69
|
3850 **
|
|
jpayne@69
|
3851 ** If F is the name of an sqlite database file, journal file, or WAL file
|
|
jpayne@69
|
3852 ** passed by the SQLite core into the VFS, then sqlite3_filename_database(F)
|
|
jpayne@69
|
3853 ** returns the name of the corresponding database file.
|
|
jpayne@69
|
3854 **
|
|
jpayne@69
|
3855 ** If F is the name of an sqlite database file, journal file, or WAL file
|
|
jpayne@69
|
3856 ** passed by the SQLite core into the VFS, or if F is a database filename
|
|
jpayne@69
|
3857 ** obtained from [sqlite3_db_filename()], then sqlite3_filename_journal(F)
|
|
jpayne@69
|
3858 ** returns the name of the corresponding rollback journal file.
|
|
jpayne@69
|
3859 **
|
|
jpayne@69
|
3860 ** If F is the name of an sqlite database file, journal file, or WAL file
|
|
jpayne@69
|
3861 ** that was passed by the SQLite core into the VFS, or if F is a database
|
|
jpayne@69
|
3862 ** filename obtained from [sqlite3_db_filename()], then
|
|
jpayne@69
|
3863 ** sqlite3_filename_wal(F) returns the name of the corresponding
|
|
jpayne@69
|
3864 ** WAL file.
|
|
jpayne@69
|
3865 **
|
|
jpayne@69
|
3866 ** In all of the above, if F is not the name of a database, journal or WAL
|
|
jpayne@69
|
3867 ** filename passed into the VFS from the SQLite core and F is not the
|
|
jpayne@69
|
3868 ** return value from [sqlite3_db_filename()], then the result is
|
|
jpayne@69
|
3869 ** undefined and is likely a memory access violation.
|
|
jpayne@69
|
3870 */
|
|
jpayne@69
|
3871 SQLITE_API const char *sqlite3_filename_database(sqlite3_filename);
|
|
jpayne@69
|
3872 SQLITE_API const char *sqlite3_filename_journal(sqlite3_filename);
|
|
jpayne@69
|
3873 SQLITE_API const char *sqlite3_filename_wal(sqlite3_filename);
|
|
jpayne@69
|
3874
|
|
jpayne@69
|
3875 /*
|
|
jpayne@69
|
3876 ** CAPI3REF: Database File Corresponding To A Journal
|
|
jpayne@69
|
3877 **
|
|
jpayne@69
|
3878 ** ^If X is the name of a rollback or WAL-mode journal file that is
|
|
jpayne@69
|
3879 ** passed into the xOpen method of [sqlite3_vfs], then
|
|
jpayne@69
|
3880 ** sqlite3_database_file_object(X) returns a pointer to the [sqlite3_file]
|
|
jpayne@69
|
3881 ** object that represents the main database file.
|
|
jpayne@69
|
3882 **
|
|
jpayne@69
|
3883 ** This routine is intended for use in custom [VFS] implementations
|
|
jpayne@69
|
3884 ** only. It is not a general-purpose interface.
|
|
jpayne@69
|
3885 ** The argument sqlite3_file_object(X) must be a filename pointer that
|
|
jpayne@69
|
3886 ** has been passed into [sqlite3_vfs].xOpen method where the
|
|
jpayne@69
|
3887 ** flags parameter to xOpen contains one of the bits
|
|
jpayne@69
|
3888 ** [SQLITE_OPEN_MAIN_JOURNAL] or [SQLITE_OPEN_WAL]. Any other use
|
|
jpayne@69
|
3889 ** of this routine results in undefined and probably undesirable
|
|
jpayne@69
|
3890 ** behavior.
|
|
jpayne@69
|
3891 */
|
|
jpayne@69
|
3892 SQLITE_API sqlite3_file *sqlite3_database_file_object(const char*);
|
|
jpayne@69
|
3893
|
|
jpayne@69
|
3894 /*
|
|
jpayne@69
|
3895 ** CAPI3REF: Create and Destroy VFS Filenames
|
|
jpayne@69
|
3896 **
|
|
jpayne@69
|
3897 ** These interfaces are provided for use by [VFS shim] implementations and
|
|
jpayne@69
|
3898 ** are not useful outside of that context.
|
|
jpayne@69
|
3899 **
|
|
jpayne@69
|
3900 ** The sqlite3_create_filename(D,J,W,N,P) allocates memory to hold a version of
|
|
jpayne@69
|
3901 ** database filename D with corresponding journal file J and WAL file W and
|
|
jpayne@69
|
3902 ** with N URI parameters key/values pairs in the array P. The result from
|
|
jpayne@69
|
3903 ** sqlite3_create_filename(D,J,W,N,P) is a pointer to a database filename that
|
|
jpayne@69
|
3904 ** is safe to pass to routines like:
|
|
jpayne@69
|
3905 ** <ul>
|
|
jpayne@69
|
3906 ** <li> [sqlite3_uri_parameter()],
|
|
jpayne@69
|
3907 ** <li> [sqlite3_uri_boolean()],
|
|
jpayne@69
|
3908 ** <li> [sqlite3_uri_int64()],
|
|
jpayne@69
|
3909 ** <li> [sqlite3_uri_key()],
|
|
jpayne@69
|
3910 ** <li> [sqlite3_filename_database()],
|
|
jpayne@69
|
3911 ** <li> [sqlite3_filename_journal()], or
|
|
jpayne@69
|
3912 ** <li> [sqlite3_filename_wal()].
|
|
jpayne@69
|
3913 ** </ul>
|
|
jpayne@69
|
3914 ** If a memory allocation error occurs, sqlite3_create_filename() might
|
|
jpayne@69
|
3915 ** return a NULL pointer. The memory obtained from sqlite3_create_filename(X)
|
|
jpayne@69
|
3916 ** must be released by a corresponding call to sqlite3_free_filename(Y).
|
|
jpayne@69
|
3917 **
|
|
jpayne@69
|
3918 ** The P parameter in sqlite3_create_filename(D,J,W,N,P) should be an array
|
|
jpayne@69
|
3919 ** of 2*N pointers to strings. Each pair of pointers in this array corresponds
|
|
jpayne@69
|
3920 ** to a key and value for a query parameter. The P parameter may be a NULL
|
|
jpayne@69
|
3921 ** pointer if N is zero. None of the 2*N pointers in the P array may be
|
|
jpayne@69
|
3922 ** NULL pointers and key pointers should not be empty strings.
|
|
jpayne@69
|
3923 ** None of the D, J, or W parameters to sqlite3_create_filename(D,J,W,N,P) may
|
|
jpayne@69
|
3924 ** be NULL pointers, though they can be empty strings.
|
|
jpayne@69
|
3925 **
|
|
jpayne@69
|
3926 ** The sqlite3_free_filename(Y) routine releases a memory allocation
|
|
jpayne@69
|
3927 ** previously obtained from sqlite3_create_filename(). Invoking
|
|
jpayne@69
|
3928 ** sqlite3_free_filename(Y) where Y is a NULL pointer is a harmless no-op.
|
|
jpayne@69
|
3929 **
|
|
jpayne@69
|
3930 ** If the Y parameter to sqlite3_free_filename(Y) is anything other
|
|
jpayne@69
|
3931 ** than a NULL pointer or a pointer previously acquired from
|
|
jpayne@69
|
3932 ** sqlite3_create_filename(), then bad things such as heap
|
|
jpayne@69
|
3933 ** corruption or segfaults may occur. The value Y should not be
|
|
jpayne@69
|
3934 ** used again after sqlite3_free_filename(Y) has been called. This means
|
|
jpayne@69
|
3935 ** that if the [sqlite3_vfs.xOpen()] method of a VFS has been called using Y,
|
|
jpayne@69
|
3936 ** then the corresponding [sqlite3_module.xClose() method should also be
|
|
jpayne@69
|
3937 ** invoked prior to calling sqlite3_free_filename(Y).
|
|
jpayne@69
|
3938 */
|
|
jpayne@69
|
3939 SQLITE_API sqlite3_filename sqlite3_create_filename(
|
|
jpayne@69
|
3940 const char *zDatabase,
|
|
jpayne@69
|
3941 const char *zJournal,
|
|
jpayne@69
|
3942 const char *zWal,
|
|
jpayne@69
|
3943 int nParam,
|
|
jpayne@69
|
3944 const char **azParam
|
|
jpayne@69
|
3945 );
|
|
jpayne@69
|
3946 SQLITE_API void sqlite3_free_filename(sqlite3_filename);
|
|
jpayne@69
|
3947
|
|
jpayne@69
|
3948 /*
|
|
jpayne@69
|
3949 ** CAPI3REF: Error Codes And Messages
|
|
jpayne@69
|
3950 ** METHOD: sqlite3
|
|
jpayne@69
|
3951 **
|
|
jpayne@69
|
3952 ** ^If the most recent sqlite3_* API call associated with
|
|
jpayne@69
|
3953 ** [database connection] D failed, then the sqlite3_errcode(D) interface
|
|
jpayne@69
|
3954 ** returns the numeric [result code] or [extended result code] for that
|
|
jpayne@69
|
3955 ** API call.
|
|
jpayne@69
|
3956 ** ^The sqlite3_extended_errcode()
|
|
jpayne@69
|
3957 ** interface is the same except that it always returns the
|
|
jpayne@69
|
3958 ** [extended result code] even when extended result codes are
|
|
jpayne@69
|
3959 ** disabled.
|
|
jpayne@69
|
3960 **
|
|
jpayne@69
|
3961 ** The values returned by sqlite3_errcode() and/or
|
|
jpayne@69
|
3962 ** sqlite3_extended_errcode() might change with each API call.
|
|
jpayne@69
|
3963 ** Except, there are some interfaces that are guaranteed to never
|
|
jpayne@69
|
3964 ** change the value of the error code. The error-code preserving
|
|
jpayne@69
|
3965 ** interfaces include the following:
|
|
jpayne@69
|
3966 **
|
|
jpayne@69
|
3967 ** <ul>
|
|
jpayne@69
|
3968 ** <li> sqlite3_errcode()
|
|
jpayne@69
|
3969 ** <li> sqlite3_extended_errcode()
|
|
jpayne@69
|
3970 ** <li> sqlite3_errmsg()
|
|
jpayne@69
|
3971 ** <li> sqlite3_errmsg16()
|
|
jpayne@69
|
3972 ** <li> sqlite3_error_offset()
|
|
jpayne@69
|
3973 ** </ul>
|
|
jpayne@69
|
3974 **
|
|
jpayne@69
|
3975 ** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language
|
|
jpayne@69
|
3976 ** text that describes the error, as either UTF-8 or UTF-16 respectively,
|
|
jpayne@69
|
3977 ** or NULL if no error message is available.
|
|
jpayne@69
|
3978 ** (See how SQLite handles [invalid UTF] for exceptions to this rule.)
|
|
jpayne@69
|
3979 ** ^(Memory to hold the error message string is managed internally.
|
|
jpayne@69
|
3980 ** The application does not need to worry about freeing the result.
|
|
jpayne@69
|
3981 ** However, the error string might be overwritten or deallocated by
|
|
jpayne@69
|
3982 ** subsequent calls to other SQLite interface functions.)^
|
|
jpayne@69
|
3983 **
|
|
jpayne@69
|
3984 ** ^The sqlite3_errstr(E) interface returns the English-language text
|
|
jpayne@69
|
3985 ** that describes the [result code] E, as UTF-8, or NULL if E is not an
|
|
jpayne@69
|
3986 ** result code for which a text error message is available.
|
|
jpayne@69
|
3987 ** ^(Memory to hold the error message string is managed internally
|
|
jpayne@69
|
3988 ** and must not be freed by the application)^.
|
|
jpayne@69
|
3989 **
|
|
jpayne@69
|
3990 ** ^If the most recent error references a specific token in the input
|
|
jpayne@69
|
3991 ** SQL, the sqlite3_error_offset() interface returns the byte offset
|
|
jpayne@69
|
3992 ** of the start of that token. ^The byte offset returned by
|
|
jpayne@69
|
3993 ** sqlite3_error_offset() assumes that the input SQL is UTF8.
|
|
jpayne@69
|
3994 ** ^If the most recent error does not reference a specific token in the input
|
|
jpayne@69
|
3995 ** SQL, then the sqlite3_error_offset() function returns -1.
|
|
jpayne@69
|
3996 **
|
|
jpayne@69
|
3997 ** When the serialized [threading mode] is in use, it might be the
|
|
jpayne@69
|
3998 ** case that a second error occurs on a separate thread in between
|
|
jpayne@69
|
3999 ** the time of the first error and the call to these interfaces.
|
|
jpayne@69
|
4000 ** When that happens, the second error will be reported since these
|
|
jpayne@69
|
4001 ** interfaces always report the most recent result. To avoid
|
|
jpayne@69
|
4002 ** this, each thread can obtain exclusive use of the [database connection] D
|
|
jpayne@69
|
4003 ** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning
|
|
jpayne@69
|
4004 ** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after
|
|
jpayne@69
|
4005 ** all calls to the interfaces listed here are completed.
|
|
jpayne@69
|
4006 **
|
|
jpayne@69
|
4007 ** If an interface fails with SQLITE_MISUSE, that means the interface
|
|
jpayne@69
|
4008 ** was invoked incorrectly by the application. In that case, the
|
|
jpayne@69
|
4009 ** error code and message may or may not be set.
|
|
jpayne@69
|
4010 */
|
|
jpayne@69
|
4011 SQLITE_API int sqlite3_errcode(sqlite3 *db);
|
|
jpayne@69
|
4012 SQLITE_API int sqlite3_extended_errcode(sqlite3 *db);
|
|
jpayne@69
|
4013 SQLITE_API const char *sqlite3_errmsg(sqlite3*);
|
|
jpayne@69
|
4014 SQLITE_API const void *sqlite3_errmsg16(sqlite3*);
|
|
jpayne@69
|
4015 SQLITE_API const char *sqlite3_errstr(int);
|
|
jpayne@69
|
4016 SQLITE_API int sqlite3_error_offset(sqlite3 *db);
|
|
jpayne@69
|
4017
|
|
jpayne@69
|
4018 /*
|
|
jpayne@69
|
4019 ** CAPI3REF: Prepared Statement Object
|
|
jpayne@69
|
4020 ** KEYWORDS: {prepared statement} {prepared statements}
|
|
jpayne@69
|
4021 **
|
|
jpayne@69
|
4022 ** An instance of this object represents a single SQL statement that
|
|
jpayne@69
|
4023 ** has been compiled into binary form and is ready to be evaluated.
|
|
jpayne@69
|
4024 **
|
|
jpayne@69
|
4025 ** Think of each SQL statement as a separate computer program. The
|
|
jpayne@69
|
4026 ** original SQL text is source code. A prepared statement object
|
|
jpayne@69
|
4027 ** is the compiled object code. All SQL must be converted into a
|
|
jpayne@69
|
4028 ** prepared statement before it can be run.
|
|
jpayne@69
|
4029 **
|
|
jpayne@69
|
4030 ** The life-cycle of a prepared statement object usually goes like this:
|
|
jpayne@69
|
4031 **
|
|
jpayne@69
|
4032 ** <ol>
|
|
jpayne@69
|
4033 ** <li> Create the prepared statement object using [sqlite3_prepare_v2()].
|
|
jpayne@69
|
4034 ** <li> Bind values to [parameters] using the sqlite3_bind_*()
|
|
jpayne@69
|
4035 ** interfaces.
|
|
jpayne@69
|
4036 ** <li> Run the SQL by calling [sqlite3_step()] one or more times.
|
|
jpayne@69
|
4037 ** <li> Reset the prepared statement using [sqlite3_reset()] then go back
|
|
jpayne@69
|
4038 ** to step 2. Do this zero or more times.
|
|
jpayne@69
|
4039 ** <li> Destroy the object using [sqlite3_finalize()].
|
|
jpayne@69
|
4040 ** </ol>
|
|
jpayne@69
|
4041 */
|
|
jpayne@69
|
4042 typedef struct sqlite3_stmt sqlite3_stmt;
|
|
jpayne@69
|
4043
|
|
jpayne@69
|
4044 /*
|
|
jpayne@69
|
4045 ** CAPI3REF: Run-time Limits
|
|
jpayne@69
|
4046 ** METHOD: sqlite3
|
|
jpayne@69
|
4047 **
|
|
jpayne@69
|
4048 ** ^(This interface allows the size of various constructs to be limited
|
|
jpayne@69
|
4049 ** on a connection by connection basis. The first parameter is the
|
|
jpayne@69
|
4050 ** [database connection] whose limit is to be set or queried. The
|
|
jpayne@69
|
4051 ** second parameter is one of the [limit categories] that define a
|
|
jpayne@69
|
4052 ** class of constructs to be size limited. The third parameter is the
|
|
jpayne@69
|
4053 ** new limit for that construct.)^
|
|
jpayne@69
|
4054 **
|
|
jpayne@69
|
4055 ** ^If the new limit is a negative number, the limit is unchanged.
|
|
jpayne@69
|
4056 ** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a
|
|
jpayne@69
|
4057 ** [limits | hard upper bound]
|
|
jpayne@69
|
4058 ** set at compile-time by a C preprocessor macro called
|
|
jpayne@69
|
4059 ** [limits | SQLITE_MAX_<i>NAME</i>].
|
|
jpayne@69
|
4060 ** (The "_LIMIT_" in the name is changed to "_MAX_".))^
|
|
jpayne@69
|
4061 ** ^Attempts to increase a limit above its hard upper bound are
|
|
jpayne@69
|
4062 ** silently truncated to the hard upper bound.
|
|
jpayne@69
|
4063 **
|
|
jpayne@69
|
4064 ** ^Regardless of whether or not the limit was changed, the
|
|
jpayne@69
|
4065 ** [sqlite3_limit()] interface returns the prior value of the limit.
|
|
jpayne@69
|
4066 ** ^Hence, to find the current value of a limit without changing it,
|
|
jpayne@69
|
4067 ** simply invoke this interface with the third parameter set to -1.
|
|
jpayne@69
|
4068 **
|
|
jpayne@69
|
4069 ** Run-time limits are intended for use in applications that manage
|
|
jpayne@69
|
4070 ** both their own internal database and also databases that are controlled
|
|
jpayne@69
|
4071 ** by untrusted external sources. An example application might be a
|
|
jpayne@69
|
4072 ** web browser that has its own databases for storing history and
|
|
jpayne@69
|
4073 ** separate databases controlled by JavaScript applications downloaded
|
|
jpayne@69
|
4074 ** off the Internet. The internal databases can be given the
|
|
jpayne@69
|
4075 ** large, default limits. Databases managed by external sources can
|
|
jpayne@69
|
4076 ** be given much smaller limits designed to prevent a denial of service
|
|
jpayne@69
|
4077 ** attack. Developers might also want to use the [sqlite3_set_authorizer()]
|
|
jpayne@69
|
4078 ** interface to further control untrusted SQL. The size of the database
|
|
jpayne@69
|
4079 ** created by an untrusted script can be contained using the
|
|
jpayne@69
|
4080 ** [max_page_count] [PRAGMA].
|
|
jpayne@69
|
4081 **
|
|
jpayne@69
|
4082 ** New run-time limit categories may be added in future releases.
|
|
jpayne@69
|
4083 */
|
|
jpayne@69
|
4084 SQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal);
|
|
jpayne@69
|
4085
|
|
jpayne@69
|
4086 /*
|
|
jpayne@69
|
4087 ** CAPI3REF: Run-Time Limit Categories
|
|
jpayne@69
|
4088 ** KEYWORDS: {limit category} {*limit categories}
|
|
jpayne@69
|
4089 **
|
|
jpayne@69
|
4090 ** These constants define various performance limits
|
|
jpayne@69
|
4091 ** that can be lowered at run-time using [sqlite3_limit()].
|
|
jpayne@69
|
4092 ** The synopsis of the meanings of the various limits is shown below.
|
|
jpayne@69
|
4093 ** Additional information is available at [limits | Limits in SQLite].
|
|
jpayne@69
|
4094 **
|
|
jpayne@69
|
4095 ** <dl>
|
|
jpayne@69
|
4096 ** [[SQLITE_LIMIT_LENGTH]] ^(<dt>SQLITE_LIMIT_LENGTH</dt>
|
|
jpayne@69
|
4097 ** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^
|
|
jpayne@69
|
4098 **
|
|
jpayne@69
|
4099 ** [[SQLITE_LIMIT_SQL_LENGTH]] ^(<dt>SQLITE_LIMIT_SQL_LENGTH</dt>
|
|
jpayne@69
|
4100 ** <dd>The maximum length of an SQL statement, in bytes.</dd>)^
|
|
jpayne@69
|
4101 **
|
|
jpayne@69
|
4102 ** [[SQLITE_LIMIT_COLUMN]] ^(<dt>SQLITE_LIMIT_COLUMN</dt>
|
|
jpayne@69
|
4103 ** <dd>The maximum number of columns in a table definition or in the
|
|
jpayne@69
|
4104 ** result set of a [SELECT] or the maximum number of columns in an index
|
|
jpayne@69
|
4105 ** or in an ORDER BY or GROUP BY clause.</dd>)^
|
|
jpayne@69
|
4106 **
|
|
jpayne@69
|
4107 ** [[SQLITE_LIMIT_EXPR_DEPTH]] ^(<dt>SQLITE_LIMIT_EXPR_DEPTH</dt>
|
|
jpayne@69
|
4108 ** <dd>The maximum depth of the parse tree on any expression.</dd>)^
|
|
jpayne@69
|
4109 **
|
|
jpayne@69
|
4110 ** [[SQLITE_LIMIT_COMPOUND_SELECT]] ^(<dt>SQLITE_LIMIT_COMPOUND_SELECT</dt>
|
|
jpayne@69
|
4111 ** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^
|
|
jpayne@69
|
4112 **
|
|
jpayne@69
|
4113 ** [[SQLITE_LIMIT_VDBE_OP]] ^(<dt>SQLITE_LIMIT_VDBE_OP</dt>
|
|
jpayne@69
|
4114 ** <dd>The maximum number of instructions in a virtual machine program
|
|
jpayne@69
|
4115 ** used to implement an SQL statement. If [sqlite3_prepare_v2()] or
|
|
jpayne@69
|
4116 ** the equivalent tries to allocate space for more than this many opcodes
|
|
jpayne@69
|
4117 ** in a single prepared statement, an SQLITE_NOMEM error is returned.</dd>)^
|
|
jpayne@69
|
4118 **
|
|
jpayne@69
|
4119 ** [[SQLITE_LIMIT_FUNCTION_ARG]] ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt>
|
|
jpayne@69
|
4120 ** <dd>The maximum number of arguments on a function.</dd>)^
|
|
jpayne@69
|
4121 **
|
|
jpayne@69
|
4122 ** [[SQLITE_LIMIT_ATTACHED]] ^(<dt>SQLITE_LIMIT_ATTACHED</dt>
|
|
jpayne@69
|
4123 ** <dd>The maximum number of [ATTACH | attached databases].)^</dd>
|
|
jpayne@69
|
4124 **
|
|
jpayne@69
|
4125 ** [[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]]
|
|
jpayne@69
|
4126 ** ^(<dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt>
|
|
jpayne@69
|
4127 ** <dd>The maximum length of the pattern argument to the [LIKE] or
|
|
jpayne@69
|
4128 ** [GLOB] operators.</dd>)^
|
|
jpayne@69
|
4129 **
|
|
jpayne@69
|
4130 ** [[SQLITE_LIMIT_VARIABLE_NUMBER]]
|
|
jpayne@69
|
4131 ** ^(<dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt>
|
|
jpayne@69
|
4132 ** <dd>The maximum index number of any [parameter] in an SQL statement.)^
|
|
jpayne@69
|
4133 **
|
|
jpayne@69
|
4134 ** [[SQLITE_LIMIT_TRIGGER_DEPTH]] ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt>
|
|
jpayne@69
|
4135 ** <dd>The maximum depth of recursion for triggers.</dd>)^
|
|
jpayne@69
|
4136 **
|
|
jpayne@69
|
4137 ** [[SQLITE_LIMIT_WORKER_THREADS]] ^(<dt>SQLITE_LIMIT_WORKER_THREADS</dt>
|
|
jpayne@69
|
4138 ** <dd>The maximum number of auxiliary worker threads that a single
|
|
jpayne@69
|
4139 ** [prepared statement] may start.</dd>)^
|
|
jpayne@69
|
4140 ** </dl>
|
|
jpayne@69
|
4141 */
|
|
jpayne@69
|
4142 #define SQLITE_LIMIT_LENGTH 0
|
|
jpayne@69
|
4143 #define SQLITE_LIMIT_SQL_LENGTH 1
|
|
jpayne@69
|
4144 #define SQLITE_LIMIT_COLUMN 2
|
|
jpayne@69
|
4145 #define SQLITE_LIMIT_EXPR_DEPTH 3
|
|
jpayne@69
|
4146 #define SQLITE_LIMIT_COMPOUND_SELECT 4
|
|
jpayne@69
|
4147 #define SQLITE_LIMIT_VDBE_OP 5
|
|
jpayne@69
|
4148 #define SQLITE_LIMIT_FUNCTION_ARG 6
|
|
jpayne@69
|
4149 #define SQLITE_LIMIT_ATTACHED 7
|
|
jpayne@69
|
4150 #define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8
|
|
jpayne@69
|
4151 #define SQLITE_LIMIT_VARIABLE_NUMBER 9
|
|
jpayne@69
|
4152 #define SQLITE_LIMIT_TRIGGER_DEPTH 10
|
|
jpayne@69
|
4153 #define SQLITE_LIMIT_WORKER_THREADS 11
|
|
jpayne@69
|
4154
|
|
jpayne@69
|
4155 /*
|
|
jpayne@69
|
4156 ** CAPI3REF: Prepare Flags
|
|
jpayne@69
|
4157 **
|
|
jpayne@69
|
4158 ** These constants define various flags that can be passed into
|
|
jpayne@69
|
4159 ** "prepFlags" parameter of the [sqlite3_prepare_v3()] and
|
|
jpayne@69
|
4160 ** [sqlite3_prepare16_v3()] interfaces.
|
|
jpayne@69
|
4161 **
|
|
jpayne@69
|
4162 ** New flags may be added in future releases of SQLite.
|
|
jpayne@69
|
4163 **
|
|
jpayne@69
|
4164 ** <dl>
|
|
jpayne@69
|
4165 ** [[SQLITE_PREPARE_PERSISTENT]] ^(<dt>SQLITE_PREPARE_PERSISTENT</dt>
|
|
jpayne@69
|
4166 ** <dd>The SQLITE_PREPARE_PERSISTENT flag is a hint to the query planner
|
|
jpayne@69
|
4167 ** that the prepared statement will be retained for a long time and
|
|
jpayne@69
|
4168 ** probably reused many times.)^ ^Without this flag, [sqlite3_prepare_v3()]
|
|
jpayne@69
|
4169 ** and [sqlite3_prepare16_v3()] assume that the prepared statement will
|
|
jpayne@69
|
4170 ** be used just once or at most a few times and then destroyed using
|
|
jpayne@69
|
4171 ** [sqlite3_finalize()] relatively soon. The current implementation acts
|
|
jpayne@69
|
4172 ** on this hint by avoiding the use of [lookaside memory] so as not to
|
|
jpayne@69
|
4173 ** deplete the limited store of lookaside memory. Future versions of
|
|
jpayne@69
|
4174 ** SQLite may act on this hint differently.
|
|
jpayne@69
|
4175 **
|
|
jpayne@69
|
4176 ** [[SQLITE_PREPARE_NORMALIZE]] <dt>SQLITE_PREPARE_NORMALIZE</dt>
|
|
jpayne@69
|
4177 ** <dd>The SQLITE_PREPARE_NORMALIZE flag is a no-op. This flag used
|
|
jpayne@69
|
4178 ** to be required for any prepared statement that wanted to use the
|
|
jpayne@69
|
4179 ** [sqlite3_normalized_sql()] interface. However, the
|
|
jpayne@69
|
4180 ** [sqlite3_normalized_sql()] interface is now available to all
|
|
jpayne@69
|
4181 ** prepared statements, regardless of whether or not they use this
|
|
jpayne@69
|
4182 ** flag.
|
|
jpayne@69
|
4183 **
|
|
jpayne@69
|
4184 ** [[SQLITE_PREPARE_NO_VTAB]] <dt>SQLITE_PREPARE_NO_VTAB</dt>
|
|
jpayne@69
|
4185 ** <dd>The SQLITE_PREPARE_NO_VTAB flag causes the SQL compiler
|
|
jpayne@69
|
4186 ** to return an error (error code SQLITE_ERROR) if the statement uses
|
|
jpayne@69
|
4187 ** any virtual tables.
|
|
jpayne@69
|
4188 ** </dl>
|
|
jpayne@69
|
4189 */
|
|
jpayne@69
|
4190 #define SQLITE_PREPARE_PERSISTENT 0x01
|
|
jpayne@69
|
4191 #define SQLITE_PREPARE_NORMALIZE 0x02
|
|
jpayne@69
|
4192 #define SQLITE_PREPARE_NO_VTAB 0x04
|
|
jpayne@69
|
4193
|
|
jpayne@69
|
4194 /*
|
|
jpayne@69
|
4195 ** CAPI3REF: Compiling An SQL Statement
|
|
jpayne@69
|
4196 ** KEYWORDS: {SQL statement compiler}
|
|
jpayne@69
|
4197 ** METHOD: sqlite3
|
|
jpayne@69
|
4198 ** CONSTRUCTOR: sqlite3_stmt
|
|
jpayne@69
|
4199 **
|
|
jpayne@69
|
4200 ** To execute an SQL statement, it must first be compiled into a byte-code
|
|
jpayne@69
|
4201 ** program using one of these routines. Or, in other words, these routines
|
|
jpayne@69
|
4202 ** are constructors for the [prepared statement] object.
|
|
jpayne@69
|
4203 **
|
|
jpayne@69
|
4204 ** The preferred routine to use is [sqlite3_prepare_v2()]. The
|
|
jpayne@69
|
4205 ** [sqlite3_prepare()] interface is legacy and should be avoided.
|
|
jpayne@69
|
4206 ** [sqlite3_prepare_v3()] has an extra "prepFlags" option that is used
|
|
jpayne@69
|
4207 ** for special purposes.
|
|
jpayne@69
|
4208 **
|
|
jpayne@69
|
4209 ** The use of the UTF-8 interfaces is preferred, as SQLite currently
|
|
jpayne@69
|
4210 ** does all parsing using UTF-8. The UTF-16 interfaces are provided
|
|
jpayne@69
|
4211 ** as a convenience. The UTF-16 interfaces work by converting the
|
|
jpayne@69
|
4212 ** input text into UTF-8, then invoking the corresponding UTF-8 interface.
|
|
jpayne@69
|
4213 **
|
|
jpayne@69
|
4214 ** The first argument, "db", is a [database connection] obtained from a
|
|
jpayne@69
|
4215 ** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or
|
|
jpayne@69
|
4216 ** [sqlite3_open16()]. The database connection must not have been closed.
|
|
jpayne@69
|
4217 **
|
|
jpayne@69
|
4218 ** The second argument, "zSql", is the statement to be compiled, encoded
|
|
jpayne@69
|
4219 ** as either UTF-8 or UTF-16. The sqlite3_prepare(), sqlite3_prepare_v2(),
|
|
jpayne@69
|
4220 ** and sqlite3_prepare_v3()
|
|
jpayne@69
|
4221 ** interfaces use UTF-8, and sqlite3_prepare16(), sqlite3_prepare16_v2(),
|
|
jpayne@69
|
4222 ** and sqlite3_prepare16_v3() use UTF-16.
|
|
jpayne@69
|
4223 **
|
|
jpayne@69
|
4224 ** ^If the nByte argument is negative, then zSql is read up to the
|
|
jpayne@69
|
4225 ** first zero terminator. ^If nByte is positive, then it is the
|
|
jpayne@69
|
4226 ** number of bytes read from zSql. ^If nByte is zero, then no prepared
|
|
jpayne@69
|
4227 ** statement is generated.
|
|
jpayne@69
|
4228 ** If the caller knows that the supplied string is nul-terminated, then
|
|
jpayne@69
|
4229 ** there is a small performance advantage to passing an nByte parameter that
|
|
jpayne@69
|
4230 ** is the number of bytes in the input string <i>including</i>
|
|
jpayne@69
|
4231 ** the nul-terminator.
|
|
jpayne@69
|
4232 **
|
|
jpayne@69
|
4233 ** ^If pzTail is not NULL then *pzTail is made to point to the first byte
|
|
jpayne@69
|
4234 ** past the end of the first SQL statement in zSql. These routines only
|
|
jpayne@69
|
4235 ** compile the first statement in zSql, so *pzTail is left pointing to
|
|
jpayne@69
|
4236 ** what remains uncompiled.
|
|
jpayne@69
|
4237 **
|
|
jpayne@69
|
4238 ** ^*ppStmt is left pointing to a compiled [prepared statement] that can be
|
|
jpayne@69
|
4239 ** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set
|
|
jpayne@69
|
4240 ** to NULL. ^If the input text contains no SQL (if the input is an empty
|
|
jpayne@69
|
4241 ** string or a comment) then *ppStmt is set to NULL.
|
|
jpayne@69
|
4242 ** The calling procedure is responsible for deleting the compiled
|
|
jpayne@69
|
4243 ** SQL statement using [sqlite3_finalize()] after it has finished with it.
|
|
jpayne@69
|
4244 ** ppStmt may not be NULL.
|
|
jpayne@69
|
4245 **
|
|
jpayne@69
|
4246 ** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK];
|
|
jpayne@69
|
4247 ** otherwise an [error code] is returned.
|
|
jpayne@69
|
4248 **
|
|
jpayne@69
|
4249 ** The sqlite3_prepare_v2(), sqlite3_prepare_v3(), sqlite3_prepare16_v2(),
|
|
jpayne@69
|
4250 ** and sqlite3_prepare16_v3() interfaces are recommended for all new programs.
|
|
jpayne@69
|
4251 ** The older interfaces (sqlite3_prepare() and sqlite3_prepare16())
|
|
jpayne@69
|
4252 ** are retained for backwards compatibility, but their use is discouraged.
|
|
jpayne@69
|
4253 ** ^In the "vX" interfaces, the prepared statement
|
|
jpayne@69
|
4254 ** that is returned (the [sqlite3_stmt] object) contains a copy of the
|
|
jpayne@69
|
4255 ** original SQL text. This causes the [sqlite3_step()] interface to
|
|
jpayne@69
|
4256 ** behave differently in three ways:
|
|
jpayne@69
|
4257 **
|
|
jpayne@69
|
4258 ** <ol>
|
|
jpayne@69
|
4259 ** <li>
|
|
jpayne@69
|
4260 ** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it
|
|
jpayne@69
|
4261 ** always used to do, [sqlite3_step()] will automatically recompile the SQL
|
|
jpayne@69
|
4262 ** statement and try to run it again. As many as [SQLITE_MAX_SCHEMA_RETRY]
|
|
jpayne@69
|
4263 ** retries will occur before sqlite3_step() gives up and returns an error.
|
|
jpayne@69
|
4264 ** </li>
|
|
jpayne@69
|
4265 **
|
|
jpayne@69
|
4266 ** <li>
|
|
jpayne@69
|
4267 ** ^When an error occurs, [sqlite3_step()] will return one of the detailed
|
|
jpayne@69
|
4268 ** [error codes] or [extended error codes]. ^The legacy behavior was that
|
|
jpayne@69
|
4269 ** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code
|
|
jpayne@69
|
4270 ** and the application would have to make a second call to [sqlite3_reset()]
|
|
jpayne@69
|
4271 ** in order to find the underlying cause of the problem. With the "v2" prepare
|
|
jpayne@69
|
4272 ** interfaces, the underlying reason for the error is returned immediately.
|
|
jpayne@69
|
4273 ** </li>
|
|
jpayne@69
|
4274 **
|
|
jpayne@69
|
4275 ** <li>
|
|
jpayne@69
|
4276 ** ^If the specific value bound to a [parameter | host parameter] in the
|
|
jpayne@69
|
4277 ** WHERE clause might influence the choice of query plan for a statement,
|
|
jpayne@69
|
4278 ** then the statement will be automatically recompiled, as if there had been
|
|
jpayne@69
|
4279 ** a schema change, on the first [sqlite3_step()] call following any change
|
|
jpayne@69
|
4280 ** to the [sqlite3_bind_text | bindings] of that [parameter].
|
|
jpayne@69
|
4281 ** ^The specific value of a WHERE-clause [parameter] might influence the
|
|
jpayne@69
|
4282 ** choice of query plan if the parameter is the left-hand side of a [LIKE]
|
|
jpayne@69
|
4283 ** or [GLOB] operator or if the parameter is compared to an indexed column
|
|
jpayne@69
|
4284 ** and the [SQLITE_ENABLE_STAT4] compile-time option is enabled.
|
|
jpayne@69
|
4285 ** </li>
|
|
jpayne@69
|
4286 ** </ol>
|
|
jpayne@69
|
4287 **
|
|
jpayne@69
|
4288 ** <p>^sqlite3_prepare_v3() differs from sqlite3_prepare_v2() only in having
|
|
jpayne@69
|
4289 ** the extra prepFlags parameter, which is a bit array consisting of zero or
|
|
jpayne@69
|
4290 ** more of the [SQLITE_PREPARE_PERSISTENT|SQLITE_PREPARE_*] flags. ^The
|
|
jpayne@69
|
4291 ** sqlite3_prepare_v2() interface works exactly the same as
|
|
jpayne@69
|
4292 ** sqlite3_prepare_v3() with a zero prepFlags parameter.
|
|
jpayne@69
|
4293 */
|
|
jpayne@69
|
4294 SQLITE_API int sqlite3_prepare(
|
|
jpayne@69
|
4295 sqlite3 *db, /* Database handle */
|
|
jpayne@69
|
4296 const char *zSql, /* SQL statement, UTF-8 encoded */
|
|
jpayne@69
|
4297 int nByte, /* Maximum length of zSql in bytes. */
|
|
jpayne@69
|
4298 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
|
|
jpayne@69
|
4299 const char **pzTail /* OUT: Pointer to unused portion of zSql */
|
|
jpayne@69
|
4300 );
|
|
jpayne@69
|
4301 SQLITE_API int sqlite3_prepare_v2(
|
|
jpayne@69
|
4302 sqlite3 *db, /* Database handle */
|
|
jpayne@69
|
4303 const char *zSql, /* SQL statement, UTF-8 encoded */
|
|
jpayne@69
|
4304 int nByte, /* Maximum length of zSql in bytes. */
|
|
jpayne@69
|
4305 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
|
|
jpayne@69
|
4306 const char **pzTail /* OUT: Pointer to unused portion of zSql */
|
|
jpayne@69
|
4307 );
|
|
jpayne@69
|
4308 SQLITE_API int sqlite3_prepare_v3(
|
|
jpayne@69
|
4309 sqlite3 *db, /* Database handle */
|
|
jpayne@69
|
4310 const char *zSql, /* SQL statement, UTF-8 encoded */
|
|
jpayne@69
|
4311 int nByte, /* Maximum length of zSql in bytes. */
|
|
jpayne@69
|
4312 unsigned int prepFlags, /* Zero or more SQLITE_PREPARE_ flags */
|
|
jpayne@69
|
4313 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
|
|
jpayne@69
|
4314 const char **pzTail /* OUT: Pointer to unused portion of zSql */
|
|
jpayne@69
|
4315 );
|
|
jpayne@69
|
4316 SQLITE_API int sqlite3_prepare16(
|
|
jpayne@69
|
4317 sqlite3 *db, /* Database handle */
|
|
jpayne@69
|
4318 const void *zSql, /* SQL statement, UTF-16 encoded */
|
|
jpayne@69
|
4319 int nByte, /* Maximum length of zSql in bytes. */
|
|
jpayne@69
|
4320 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
|
|
jpayne@69
|
4321 const void **pzTail /* OUT: Pointer to unused portion of zSql */
|
|
jpayne@69
|
4322 );
|
|
jpayne@69
|
4323 SQLITE_API int sqlite3_prepare16_v2(
|
|
jpayne@69
|
4324 sqlite3 *db, /* Database handle */
|
|
jpayne@69
|
4325 const void *zSql, /* SQL statement, UTF-16 encoded */
|
|
jpayne@69
|
4326 int nByte, /* Maximum length of zSql in bytes. */
|
|
jpayne@69
|
4327 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
|
|
jpayne@69
|
4328 const void **pzTail /* OUT: Pointer to unused portion of zSql */
|
|
jpayne@69
|
4329 );
|
|
jpayne@69
|
4330 SQLITE_API int sqlite3_prepare16_v3(
|
|
jpayne@69
|
4331 sqlite3 *db, /* Database handle */
|
|
jpayne@69
|
4332 const void *zSql, /* SQL statement, UTF-16 encoded */
|
|
jpayne@69
|
4333 int nByte, /* Maximum length of zSql in bytes. */
|
|
jpayne@69
|
4334 unsigned int prepFlags, /* Zero or more SQLITE_PREPARE_ flags */
|
|
jpayne@69
|
4335 sqlite3_stmt **ppStmt, /* OUT: Statement handle */
|
|
jpayne@69
|
4336 const void **pzTail /* OUT: Pointer to unused portion of zSql */
|
|
jpayne@69
|
4337 );
|
|
jpayne@69
|
4338
|
|
jpayne@69
|
4339 /*
|
|
jpayne@69
|
4340 ** CAPI3REF: Retrieving Statement SQL
|
|
jpayne@69
|
4341 ** METHOD: sqlite3_stmt
|
|
jpayne@69
|
4342 **
|
|
jpayne@69
|
4343 ** ^The sqlite3_sql(P) interface returns a pointer to a copy of the UTF-8
|
|
jpayne@69
|
4344 ** SQL text used to create [prepared statement] P if P was
|
|
jpayne@69
|
4345 ** created by [sqlite3_prepare_v2()], [sqlite3_prepare_v3()],
|
|
jpayne@69
|
4346 ** [sqlite3_prepare16_v2()], or [sqlite3_prepare16_v3()].
|
|
jpayne@69
|
4347 ** ^The sqlite3_expanded_sql(P) interface returns a pointer to a UTF-8
|
|
jpayne@69
|
4348 ** string containing the SQL text of prepared statement P with
|
|
jpayne@69
|
4349 ** [bound parameters] expanded.
|
|
jpayne@69
|
4350 ** ^The sqlite3_normalized_sql(P) interface returns a pointer to a UTF-8
|
|
jpayne@69
|
4351 ** string containing the normalized SQL text of prepared statement P. The
|
|
jpayne@69
|
4352 ** semantics used to normalize a SQL statement are unspecified and subject
|
|
jpayne@69
|
4353 ** to change. At a minimum, literal values will be replaced with suitable
|
|
jpayne@69
|
4354 ** placeholders.
|
|
jpayne@69
|
4355 **
|
|
jpayne@69
|
4356 ** ^(For example, if a prepared statement is created using the SQL
|
|
jpayne@69
|
4357 ** text "SELECT $abc,:xyz" and if parameter $abc is bound to integer 2345
|
|
jpayne@69
|
4358 ** and parameter :xyz is unbound, then sqlite3_sql() will return
|
|
jpayne@69
|
4359 ** the original string, "SELECT $abc,:xyz" but sqlite3_expanded_sql()
|
|
jpayne@69
|
4360 ** will return "SELECT 2345,NULL".)^
|
|
jpayne@69
|
4361 **
|
|
jpayne@69
|
4362 ** ^The sqlite3_expanded_sql() interface returns NULL if insufficient memory
|
|
jpayne@69
|
4363 ** is available to hold the result, or if the result would exceed the
|
|
jpayne@69
|
4364 ** the maximum string length determined by the [SQLITE_LIMIT_LENGTH].
|
|
jpayne@69
|
4365 **
|
|
jpayne@69
|
4366 ** ^The [SQLITE_TRACE_SIZE_LIMIT] compile-time option limits the size of
|
|
jpayne@69
|
4367 ** bound parameter expansions. ^The [SQLITE_OMIT_TRACE] compile-time
|
|
jpayne@69
|
4368 ** option causes sqlite3_expanded_sql() to always return NULL.
|
|
jpayne@69
|
4369 **
|
|
jpayne@69
|
4370 ** ^The strings returned by sqlite3_sql(P) and sqlite3_normalized_sql(P)
|
|
jpayne@69
|
4371 ** are managed by SQLite and are automatically freed when the prepared
|
|
jpayne@69
|
4372 ** statement is finalized.
|
|
jpayne@69
|
4373 ** ^The string returned by sqlite3_expanded_sql(P), on the other hand,
|
|
jpayne@69
|
4374 ** is obtained from [sqlite3_malloc()] and must be freed by the application
|
|
jpayne@69
|
4375 ** by passing it to [sqlite3_free()].
|
|
jpayne@69
|
4376 **
|
|
jpayne@69
|
4377 ** ^The sqlite3_normalized_sql() interface is only available if
|
|
jpayne@69
|
4378 ** the [SQLITE_ENABLE_NORMALIZE] compile-time option is defined.
|
|
jpayne@69
|
4379 */
|
|
jpayne@69
|
4380 SQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt);
|
|
jpayne@69
|
4381 SQLITE_API char *sqlite3_expanded_sql(sqlite3_stmt *pStmt);
|
|
jpayne@69
|
4382 #ifdef SQLITE_ENABLE_NORMALIZE
|
|
jpayne@69
|
4383 SQLITE_API const char *sqlite3_normalized_sql(sqlite3_stmt *pStmt);
|
|
jpayne@69
|
4384 #endif
|
|
jpayne@69
|
4385
|
|
jpayne@69
|
4386 /*
|
|
jpayne@69
|
4387 ** CAPI3REF: Determine If An SQL Statement Writes The Database
|
|
jpayne@69
|
4388 ** METHOD: sqlite3_stmt
|
|
jpayne@69
|
4389 **
|
|
jpayne@69
|
4390 ** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if
|
|
jpayne@69
|
4391 ** and only if the [prepared statement] X makes no direct changes to
|
|
jpayne@69
|
4392 ** the content of the database file.
|
|
jpayne@69
|
4393 **
|
|
jpayne@69
|
4394 ** Note that [application-defined SQL functions] or
|
|
jpayne@69
|
4395 ** [virtual tables] might change the database indirectly as a side effect.
|
|
jpayne@69
|
4396 ** ^(For example, if an application defines a function "eval()" that
|
|
jpayne@69
|
4397 ** calls [sqlite3_exec()], then the following SQL statement would
|
|
jpayne@69
|
4398 ** change the database file through side-effects:
|
|
jpayne@69
|
4399 **
|
|
jpayne@69
|
4400 ** <blockquote><pre>
|
|
jpayne@69
|
4401 ** SELECT eval('DELETE FROM t1') FROM t2;
|
|
jpayne@69
|
4402 ** </pre></blockquote>
|
|
jpayne@69
|
4403 **
|
|
jpayne@69
|
4404 ** But because the [SELECT] statement does not change the database file
|
|
jpayne@69
|
4405 ** directly, sqlite3_stmt_readonly() would still return true.)^
|
|
jpayne@69
|
4406 **
|
|
jpayne@69
|
4407 ** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK],
|
|
jpayne@69
|
4408 ** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true,
|
|
jpayne@69
|
4409 ** since the statements themselves do not actually modify the database but
|
|
jpayne@69
|
4410 ** rather they control the timing of when other statements modify the
|
|
jpayne@69
|
4411 ** database. ^The [ATTACH] and [DETACH] statements also cause
|
|
jpayne@69
|
4412 ** sqlite3_stmt_readonly() to return true since, while those statements
|
|
jpayne@69
|
4413 ** change the configuration of a database connection, they do not make
|
|
jpayne@69
|
4414 ** changes to the content of the database files on disk.
|
|
jpayne@69
|
4415 ** ^The sqlite3_stmt_readonly() interface returns true for [BEGIN] since
|
|
jpayne@69
|
4416 ** [BEGIN] merely sets internal flags, but the [BEGIN|BEGIN IMMEDIATE] and
|
|
jpayne@69
|
4417 ** [BEGIN|BEGIN EXCLUSIVE] commands do touch the database and so
|
|
jpayne@69
|
4418 ** sqlite3_stmt_readonly() returns false for those commands.
|
|
jpayne@69
|
4419 **
|
|
jpayne@69
|
4420 ** ^This routine returns false if there is any possibility that the
|
|
jpayne@69
|
4421 ** statement might change the database file. ^A false return does
|
|
jpayne@69
|
4422 ** not guarantee that the statement will change the database file.
|
|
jpayne@69
|
4423 ** ^For example, an UPDATE statement might have a WHERE clause that
|
|
jpayne@69
|
4424 ** makes it a no-op, but the sqlite3_stmt_readonly() result would still
|
|
jpayne@69
|
4425 ** be false. ^Similarly, a CREATE TABLE IF NOT EXISTS statement is a
|
|
jpayne@69
|
4426 ** read-only no-op if the table already exists, but
|
|
jpayne@69
|
4427 ** sqlite3_stmt_readonly() still returns false for such a statement.
|
|
jpayne@69
|
4428 **
|
|
jpayne@69
|
4429 ** ^If prepared statement X is an [EXPLAIN] or [EXPLAIN QUERY PLAN]
|
|
jpayne@69
|
4430 ** statement, then sqlite3_stmt_readonly(X) returns the same value as
|
|
jpayne@69
|
4431 ** if the EXPLAIN or EXPLAIN QUERY PLAN prefix were omitted.
|
|
jpayne@69
|
4432 */
|
|
jpayne@69
|
4433 SQLITE_API int sqlite3_stmt_readonly(sqlite3_stmt *pStmt);
|
|
jpayne@69
|
4434
|
|
jpayne@69
|
4435 /*
|
|
jpayne@69
|
4436 ** CAPI3REF: Query The EXPLAIN Setting For A Prepared Statement
|
|
jpayne@69
|
4437 ** METHOD: sqlite3_stmt
|
|
jpayne@69
|
4438 **
|
|
jpayne@69
|
4439 ** ^The sqlite3_stmt_isexplain(S) interface returns 1 if the
|
|
jpayne@69
|
4440 ** prepared statement S is an EXPLAIN statement, or 2 if the
|
|
jpayne@69
|
4441 ** statement S is an EXPLAIN QUERY PLAN.
|
|
jpayne@69
|
4442 ** ^The sqlite3_stmt_isexplain(S) interface returns 0 if S is
|
|
jpayne@69
|
4443 ** an ordinary statement or a NULL pointer.
|
|
jpayne@69
|
4444 */
|
|
jpayne@69
|
4445 SQLITE_API int sqlite3_stmt_isexplain(sqlite3_stmt *pStmt);
|
|
jpayne@69
|
4446
|
|
jpayne@69
|
4447 /*
|
|
jpayne@69
|
4448 ** CAPI3REF: Change The EXPLAIN Setting For A Prepared Statement
|
|
jpayne@69
|
4449 ** METHOD: sqlite3_stmt
|
|
jpayne@69
|
4450 **
|
|
jpayne@69
|
4451 ** The sqlite3_stmt_explain(S,E) interface changes the EXPLAIN
|
|
jpayne@69
|
4452 ** setting for [prepared statement] S. If E is zero, then S becomes
|
|
jpayne@69
|
4453 ** a normal prepared statement. If E is 1, then S behaves as if
|
|
jpayne@69
|
4454 ** its SQL text began with "[EXPLAIN]". If E is 2, then S behaves as if
|
|
jpayne@69
|
4455 ** its SQL text began with "[EXPLAIN QUERY PLAN]".
|
|
jpayne@69
|
4456 **
|
|
jpayne@69
|
4457 ** Calling sqlite3_stmt_explain(S,E) might cause S to be reprepared.
|
|
jpayne@69
|
4458 ** SQLite tries to avoid a reprepare, but a reprepare might be necessary
|
|
jpayne@69
|
4459 ** on the first transition into EXPLAIN or EXPLAIN QUERY PLAN mode.
|
|
jpayne@69
|
4460 **
|
|
jpayne@69
|
4461 ** Because of the potential need to reprepare, a call to
|
|
jpayne@69
|
4462 ** sqlite3_stmt_explain(S,E) will fail with SQLITE_ERROR if S cannot be
|
|
jpayne@69
|
4463 ** reprepared because it was created using [sqlite3_prepare()] instead of
|
|
jpayne@69
|
4464 ** the newer [sqlite3_prepare_v2()] or [sqlite3_prepare_v3()] interfaces and
|
|
jpayne@69
|
4465 ** hence has no saved SQL text with which to reprepare.
|
|
jpayne@69
|
4466 **
|
|
jpayne@69
|
4467 ** Changing the explain setting for a prepared statement does not change
|
|
jpayne@69
|
4468 ** the original SQL text for the statement. Hence, if the SQL text originally
|
|
jpayne@69
|
4469 ** began with EXPLAIN or EXPLAIN QUERY PLAN, but sqlite3_stmt_explain(S,0)
|
|
jpayne@69
|
4470 ** is called to convert the statement into an ordinary statement, the EXPLAIN
|
|
jpayne@69
|
4471 ** or EXPLAIN QUERY PLAN keywords will still appear in the sqlite3_sql(S)
|
|
jpayne@69
|
4472 ** output, even though the statement now acts like a normal SQL statement.
|
|
jpayne@69
|
4473 **
|
|
jpayne@69
|
4474 ** This routine returns SQLITE_OK if the explain mode is successfully
|
|
jpayne@69
|
4475 ** changed, or an error code if the explain mode could not be changed.
|
|
jpayne@69
|
4476 ** The explain mode cannot be changed while a statement is active.
|
|
jpayne@69
|
4477 ** Hence, it is good practice to call [sqlite3_reset(S)]
|
|
jpayne@69
|
4478 ** immediately prior to calling sqlite3_stmt_explain(S,E).
|
|
jpayne@69
|
4479 */
|
|
jpayne@69
|
4480 SQLITE_API int sqlite3_stmt_explain(sqlite3_stmt *pStmt, int eMode);
|
|
jpayne@69
|
4481
|
|
jpayne@69
|
4482 /*
|
|
jpayne@69
|
4483 ** CAPI3REF: Determine If A Prepared Statement Has Been Reset
|
|
jpayne@69
|
4484 ** METHOD: sqlite3_stmt
|
|
jpayne@69
|
4485 **
|
|
jpayne@69
|
4486 ** ^The sqlite3_stmt_busy(S) interface returns true (non-zero) if the
|
|
jpayne@69
|
4487 ** [prepared statement] S has been stepped at least once using
|
|
jpayne@69
|
4488 ** [sqlite3_step(S)] but has neither run to completion (returned
|
|
jpayne@69
|
4489 ** [SQLITE_DONE] from [sqlite3_step(S)]) nor
|
|
jpayne@69
|
4490 ** been reset using [sqlite3_reset(S)]. ^The sqlite3_stmt_busy(S)
|
|
jpayne@69
|
4491 ** interface returns false if S is a NULL pointer. If S is not a
|
|
jpayne@69
|
4492 ** NULL pointer and is not a pointer to a valid [prepared statement]
|
|
jpayne@69
|
4493 ** object, then the behavior is undefined and probably undesirable.
|
|
jpayne@69
|
4494 **
|
|
jpayne@69
|
4495 ** This interface can be used in combination [sqlite3_next_stmt()]
|
|
jpayne@69
|
4496 ** to locate all prepared statements associated with a database
|
|
jpayne@69
|
4497 ** connection that are in need of being reset. This can be used,
|
|
jpayne@69
|
4498 ** for example, in diagnostic routines to search for prepared
|
|
jpayne@69
|
4499 ** statements that are holding a transaction open.
|
|
jpayne@69
|
4500 */
|
|
jpayne@69
|
4501 SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*);
|
|
jpayne@69
|
4502
|
|
jpayne@69
|
4503 /*
|
|
jpayne@69
|
4504 ** CAPI3REF: Dynamically Typed Value Object
|
|
jpayne@69
|
4505 ** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value}
|
|
jpayne@69
|
4506 **
|
|
jpayne@69
|
4507 ** SQLite uses the sqlite3_value object to represent all values
|
|
jpayne@69
|
4508 ** that can be stored in a database table. SQLite uses dynamic typing
|
|
jpayne@69
|
4509 ** for the values it stores. ^Values stored in sqlite3_value objects
|
|
jpayne@69
|
4510 ** can be integers, floating point values, strings, BLOBs, or NULL.
|
|
jpayne@69
|
4511 **
|
|
jpayne@69
|
4512 ** An sqlite3_value object may be either "protected" or "unprotected".
|
|
jpayne@69
|
4513 ** Some interfaces require a protected sqlite3_value. Other interfaces
|
|
jpayne@69
|
4514 ** will accept either a protected or an unprotected sqlite3_value.
|
|
jpayne@69
|
4515 ** Every interface that accepts sqlite3_value arguments specifies
|
|
jpayne@69
|
4516 ** whether or not it requires a protected sqlite3_value. The
|
|
jpayne@69
|
4517 ** [sqlite3_value_dup()] interface can be used to construct a new
|
|
jpayne@69
|
4518 ** protected sqlite3_value from an unprotected sqlite3_value.
|
|
jpayne@69
|
4519 **
|
|
jpayne@69
|
4520 ** The terms "protected" and "unprotected" refer to whether or not
|
|
jpayne@69
|
4521 ** a mutex is held. An internal mutex is held for a protected
|
|
jpayne@69
|
4522 ** sqlite3_value object but no mutex is held for an unprotected
|
|
jpayne@69
|
4523 ** sqlite3_value object. If SQLite is compiled to be single-threaded
|
|
jpayne@69
|
4524 ** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0)
|
|
jpayne@69
|
4525 ** or if SQLite is run in one of reduced mutex modes
|
|
jpayne@69
|
4526 ** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD]
|
|
jpayne@69
|
4527 ** then there is no distinction between protected and unprotected
|
|
jpayne@69
|
4528 ** sqlite3_value objects and they can be used interchangeably. However,
|
|
jpayne@69
|
4529 ** for maximum code portability it is recommended that applications
|
|
jpayne@69
|
4530 ** still make the distinction between protected and unprotected
|
|
jpayne@69
|
4531 ** sqlite3_value objects even when not strictly required.
|
|
jpayne@69
|
4532 **
|
|
jpayne@69
|
4533 ** ^The sqlite3_value objects that are passed as parameters into the
|
|
jpayne@69
|
4534 ** implementation of [application-defined SQL functions] are protected.
|
|
jpayne@69
|
4535 ** ^The sqlite3_value objects returned by [sqlite3_vtab_rhs_value()]
|
|
jpayne@69
|
4536 ** are protected.
|
|
jpayne@69
|
4537 ** ^The sqlite3_value object returned by
|
|
jpayne@69
|
4538 ** [sqlite3_column_value()] is unprotected.
|
|
jpayne@69
|
4539 ** Unprotected sqlite3_value objects may only be used as arguments
|
|
jpayne@69
|
4540 ** to [sqlite3_result_value()], [sqlite3_bind_value()], and
|
|
jpayne@69
|
4541 ** [sqlite3_value_dup()].
|
|
jpayne@69
|
4542 ** The [sqlite3_value_blob | sqlite3_value_type()] family of
|
|
jpayne@69
|
4543 ** interfaces require protected sqlite3_value objects.
|
|
jpayne@69
|
4544 */
|
|
jpayne@69
|
4545 typedef struct sqlite3_value sqlite3_value;
|
|
jpayne@69
|
4546
|
|
jpayne@69
|
4547 /*
|
|
jpayne@69
|
4548 ** CAPI3REF: SQL Function Context Object
|
|
jpayne@69
|
4549 **
|
|
jpayne@69
|
4550 ** The context in which an SQL function executes is stored in an
|
|
jpayne@69
|
4551 ** sqlite3_context object. ^A pointer to an sqlite3_context object
|
|
jpayne@69
|
4552 ** is always first parameter to [application-defined SQL functions].
|
|
jpayne@69
|
4553 ** The application-defined SQL function implementation will pass this
|
|
jpayne@69
|
4554 ** pointer through into calls to [sqlite3_result_int | sqlite3_result()],
|
|
jpayne@69
|
4555 ** [sqlite3_aggregate_context()], [sqlite3_user_data()],
|
|
jpayne@69
|
4556 ** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()],
|
|
jpayne@69
|
4557 ** and/or [sqlite3_set_auxdata()].
|
|
jpayne@69
|
4558 */
|
|
jpayne@69
|
4559 typedef struct sqlite3_context sqlite3_context;
|
|
jpayne@69
|
4560
|
|
jpayne@69
|
4561 /*
|
|
jpayne@69
|
4562 ** CAPI3REF: Binding Values To Prepared Statements
|
|
jpayne@69
|
4563 ** KEYWORDS: {host parameter} {host parameters} {host parameter name}
|
|
jpayne@69
|
4564 ** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding}
|
|
jpayne@69
|
4565 ** METHOD: sqlite3_stmt
|
|
jpayne@69
|
4566 **
|
|
jpayne@69
|
4567 ** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants,
|
|
jpayne@69
|
4568 ** literals may be replaced by a [parameter] that matches one of following
|
|
jpayne@69
|
4569 ** templates:
|
|
jpayne@69
|
4570 **
|
|
jpayne@69
|
4571 ** <ul>
|
|
jpayne@69
|
4572 ** <li> ?
|
|
jpayne@69
|
4573 ** <li> ?NNN
|
|
jpayne@69
|
4574 ** <li> :VVV
|
|
jpayne@69
|
4575 ** <li> @VVV
|
|
jpayne@69
|
4576 ** <li> $VVV
|
|
jpayne@69
|
4577 ** </ul>
|
|
jpayne@69
|
4578 **
|
|
jpayne@69
|
4579 ** In the templates above, NNN represents an integer literal,
|
|
jpayne@69
|
4580 ** and VVV represents an alphanumeric identifier.)^ ^The values of these
|
|
jpayne@69
|
4581 ** parameters (also called "host parameter names" or "SQL parameters")
|
|
jpayne@69
|
4582 ** can be set using the sqlite3_bind_*() routines defined here.
|
|
jpayne@69
|
4583 **
|
|
jpayne@69
|
4584 ** ^The first argument to the sqlite3_bind_*() routines is always
|
|
jpayne@69
|
4585 ** a pointer to the [sqlite3_stmt] object returned from
|
|
jpayne@69
|
4586 ** [sqlite3_prepare_v2()] or its variants.
|
|
jpayne@69
|
4587 **
|
|
jpayne@69
|
4588 ** ^The second argument is the index of the SQL parameter to be set.
|
|
jpayne@69
|
4589 ** ^The leftmost SQL parameter has an index of 1. ^When the same named
|
|
jpayne@69
|
4590 ** SQL parameter is used more than once, second and subsequent
|
|
jpayne@69
|
4591 ** occurrences have the same index as the first occurrence.
|
|
jpayne@69
|
4592 ** ^The index for named parameters can be looked up using the
|
|
jpayne@69
|
4593 ** [sqlite3_bind_parameter_index()] API if desired. ^The index
|
|
jpayne@69
|
4594 ** for "?NNN" parameters is the value of NNN.
|
|
jpayne@69
|
4595 ** ^The NNN value must be between 1 and the [sqlite3_limit()]
|
|
jpayne@69
|
4596 ** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 32766).
|
|
jpayne@69
|
4597 **
|
|
jpayne@69
|
4598 ** ^The third argument is the value to bind to the parameter.
|
|
jpayne@69
|
4599 ** ^If the third parameter to sqlite3_bind_text() or sqlite3_bind_text16()
|
|
jpayne@69
|
4600 ** or sqlite3_bind_blob() is a NULL pointer then the fourth parameter
|
|
jpayne@69
|
4601 ** is ignored and the end result is the same as sqlite3_bind_null().
|
|
jpayne@69
|
4602 ** ^If the third parameter to sqlite3_bind_text() is not NULL, then
|
|
jpayne@69
|
4603 ** it should be a pointer to well-formed UTF8 text.
|
|
jpayne@69
|
4604 ** ^If the third parameter to sqlite3_bind_text16() is not NULL, then
|
|
jpayne@69
|
4605 ** it should be a pointer to well-formed UTF16 text.
|
|
jpayne@69
|
4606 ** ^If the third parameter to sqlite3_bind_text64() is not NULL, then
|
|
jpayne@69
|
4607 ** it should be a pointer to a well-formed unicode string that is
|
|
jpayne@69
|
4608 ** either UTF8 if the sixth parameter is SQLITE_UTF8, or UTF16
|
|
jpayne@69
|
4609 ** otherwise.
|
|
jpayne@69
|
4610 **
|
|
jpayne@69
|
4611 ** [[byte-order determination rules]] ^The byte-order of
|
|
jpayne@69
|
4612 ** UTF16 input text is determined by the byte-order mark (BOM, U+FEFF)
|
|
jpayne@69
|
4613 ** found in first character, which is removed, or in the absence of a BOM
|
|
jpayne@69
|
4614 ** the byte order is the native byte order of the host
|
|
jpayne@69
|
4615 ** machine for sqlite3_bind_text16() or the byte order specified in
|
|
jpayne@69
|
4616 ** the 6th parameter for sqlite3_bind_text64().)^
|
|
jpayne@69
|
4617 ** ^If UTF16 input text contains invalid unicode
|
|
jpayne@69
|
4618 ** characters, then SQLite might change those invalid characters
|
|
jpayne@69
|
4619 ** into the unicode replacement character: U+FFFD.
|
|
jpayne@69
|
4620 **
|
|
jpayne@69
|
4621 ** ^(In those routines that have a fourth argument, its value is the
|
|
jpayne@69
|
4622 ** number of bytes in the parameter. To be clear: the value is the
|
|
jpayne@69
|
4623 ** number of <u>bytes</u> in the value, not the number of characters.)^
|
|
jpayne@69
|
4624 ** ^If the fourth parameter to sqlite3_bind_text() or sqlite3_bind_text16()
|
|
jpayne@69
|
4625 ** is negative, then the length of the string is
|
|
jpayne@69
|
4626 ** the number of bytes up to the first zero terminator.
|
|
jpayne@69
|
4627 ** If the fourth parameter to sqlite3_bind_blob() is negative, then
|
|
jpayne@69
|
4628 ** the behavior is undefined.
|
|
jpayne@69
|
4629 ** If a non-negative fourth parameter is provided to sqlite3_bind_text()
|
|
jpayne@69
|
4630 ** or sqlite3_bind_text16() or sqlite3_bind_text64() then
|
|
jpayne@69
|
4631 ** that parameter must be the byte offset
|
|
jpayne@69
|
4632 ** where the NUL terminator would occur assuming the string were NUL
|
|
jpayne@69
|
4633 ** terminated. If any NUL characters occurs at byte offsets less than
|
|
jpayne@69
|
4634 ** the value of the fourth parameter then the resulting string value will
|
|
jpayne@69
|
4635 ** contain embedded NULs. The result of expressions involving strings
|
|
jpayne@69
|
4636 ** with embedded NULs is undefined.
|
|
jpayne@69
|
4637 **
|
|
jpayne@69
|
4638 ** ^The fifth argument to the BLOB and string binding interfaces controls
|
|
jpayne@69
|
4639 ** or indicates the lifetime of the object referenced by the third parameter.
|
|
jpayne@69
|
4640 ** These three options exist:
|
|
jpayne@69
|
4641 ** ^ (1) A destructor to dispose of the BLOB or string after SQLite has finished
|
|
jpayne@69
|
4642 ** with it may be passed. ^It is called to dispose of the BLOB or string even
|
|
jpayne@69
|
4643 ** if the call to the bind API fails, except the destructor is not called if
|
|
jpayne@69
|
4644 ** the third parameter is a NULL pointer or the fourth parameter is negative.
|
|
jpayne@69
|
4645 ** ^ (2) The special constant, [SQLITE_STATIC], may be passed to indicate that
|
|
jpayne@69
|
4646 ** the application remains responsible for disposing of the object. ^In this
|
|
jpayne@69
|
4647 ** case, the object and the provided pointer to it must remain valid until
|
|
jpayne@69
|
4648 ** either the prepared statement is finalized or the same SQL parameter is
|
|
jpayne@69
|
4649 ** bound to something else, whichever occurs sooner.
|
|
jpayne@69
|
4650 ** ^ (3) The constant, [SQLITE_TRANSIENT], may be passed to indicate that the
|
|
jpayne@69
|
4651 ** object is to be copied prior to the return from sqlite3_bind_*(). ^The
|
|
jpayne@69
|
4652 ** object and pointer to it must remain valid until then. ^SQLite will then
|
|
jpayne@69
|
4653 ** manage the lifetime of its private copy.
|
|
jpayne@69
|
4654 **
|
|
jpayne@69
|
4655 ** ^The sixth argument to sqlite3_bind_text64() must be one of
|
|
jpayne@69
|
4656 ** [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE]
|
|
jpayne@69
|
4657 ** to specify the encoding of the text in the third parameter. If
|
|
jpayne@69
|
4658 ** the sixth argument to sqlite3_bind_text64() is not one of the
|
|
jpayne@69
|
4659 ** allowed values shown above, or if the text encoding is different
|
|
jpayne@69
|
4660 ** from the encoding specified by the sixth parameter, then the behavior
|
|
jpayne@69
|
4661 ** is undefined.
|
|
jpayne@69
|
4662 **
|
|
jpayne@69
|
4663 ** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that
|
|
jpayne@69
|
4664 ** is filled with zeroes. ^A zeroblob uses a fixed amount of memory
|
|
jpayne@69
|
4665 ** (just an integer to hold its size) while it is being processed.
|
|
jpayne@69
|
4666 ** Zeroblobs are intended to serve as placeholders for BLOBs whose
|
|
jpayne@69
|
4667 ** content is later written using
|
|
jpayne@69
|
4668 ** [sqlite3_blob_open | incremental BLOB I/O] routines.
|
|
jpayne@69
|
4669 ** ^A negative value for the zeroblob results in a zero-length BLOB.
|
|
jpayne@69
|
4670 **
|
|
jpayne@69
|
4671 ** ^The sqlite3_bind_pointer(S,I,P,T,D) routine causes the I-th parameter in
|
|
jpayne@69
|
4672 ** [prepared statement] S to have an SQL value of NULL, but to also be
|
|
jpayne@69
|
4673 ** associated with the pointer P of type T. ^D is either a NULL pointer or
|
|
jpayne@69
|
4674 ** a pointer to a destructor function for P. ^SQLite will invoke the
|
|
jpayne@69
|
4675 ** destructor D with a single argument of P when it is finished using
|
|
jpayne@69
|
4676 ** P. The T parameter should be a static string, preferably a string
|
|
jpayne@69
|
4677 ** literal. The sqlite3_bind_pointer() routine is part of the
|
|
jpayne@69
|
4678 ** [pointer passing interface] added for SQLite 3.20.0.
|
|
jpayne@69
|
4679 **
|
|
jpayne@69
|
4680 ** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer
|
|
jpayne@69
|
4681 ** for the [prepared statement] or with a prepared statement for which
|
|
jpayne@69
|
4682 ** [sqlite3_step()] has been called more recently than [sqlite3_reset()],
|
|
jpayne@69
|
4683 ** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_()
|
|
jpayne@69
|
4684 ** routine is passed a [prepared statement] that has been finalized, the
|
|
jpayne@69
|
4685 ** result is undefined and probably harmful.
|
|
jpayne@69
|
4686 **
|
|
jpayne@69
|
4687 ** ^Bindings are not cleared by the [sqlite3_reset()] routine.
|
|
jpayne@69
|
4688 ** ^Unbound parameters are interpreted as NULL.
|
|
jpayne@69
|
4689 **
|
|
jpayne@69
|
4690 ** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an
|
|
jpayne@69
|
4691 ** [error code] if anything goes wrong.
|
|
jpayne@69
|
4692 ** ^[SQLITE_TOOBIG] might be returned if the size of a string or BLOB
|
|
jpayne@69
|
4693 ** exceeds limits imposed by [sqlite3_limit]([SQLITE_LIMIT_LENGTH]) or
|
|
jpayne@69
|
4694 ** [SQLITE_MAX_LENGTH].
|
|
jpayne@69
|
4695 ** ^[SQLITE_RANGE] is returned if the parameter
|
|
jpayne@69
|
4696 ** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails.
|
|
jpayne@69
|
4697 **
|
|
jpayne@69
|
4698 ** See also: [sqlite3_bind_parameter_count()],
|
|
jpayne@69
|
4699 ** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()].
|
|
jpayne@69
|
4700 */
|
|
jpayne@69
|
4701 SQLITE_API int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*));
|
|
jpayne@69
|
4702 SQLITE_API int sqlite3_bind_blob64(sqlite3_stmt*, int, const void*, sqlite3_uint64,
|
|
jpayne@69
|
4703 void(*)(void*));
|
|
jpayne@69
|
4704 SQLITE_API int sqlite3_bind_double(sqlite3_stmt*, int, double);
|
|
jpayne@69
|
4705 SQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int);
|
|
jpayne@69
|
4706 SQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64);
|
|
jpayne@69
|
4707 SQLITE_API int sqlite3_bind_null(sqlite3_stmt*, int);
|
|
jpayne@69
|
4708 SQLITE_API int sqlite3_bind_text(sqlite3_stmt*,int,const char*,int,void(*)(void*));
|
|
jpayne@69
|
4709 SQLITE_API int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*));
|
|
jpayne@69
|
4710 SQLITE_API int sqlite3_bind_text64(sqlite3_stmt*, int, const char*, sqlite3_uint64,
|
|
jpayne@69
|
4711 void(*)(void*), unsigned char encoding);
|
|
jpayne@69
|
4712 SQLITE_API int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);
|
|
jpayne@69
|
4713 SQLITE_API int sqlite3_bind_pointer(sqlite3_stmt*, int, void*, const char*,void(*)(void*));
|
|
jpayne@69
|
4714 SQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n);
|
|
jpayne@69
|
4715 SQLITE_API int sqlite3_bind_zeroblob64(sqlite3_stmt*, int, sqlite3_uint64);
|
|
jpayne@69
|
4716
|
|
jpayne@69
|
4717 /*
|
|
jpayne@69
|
4718 ** CAPI3REF: Number Of SQL Parameters
|
|
jpayne@69
|
4719 ** METHOD: sqlite3_stmt
|
|
jpayne@69
|
4720 **
|
|
jpayne@69
|
4721 ** ^This routine can be used to find the number of [SQL parameters]
|
|
jpayne@69
|
4722 ** in a [prepared statement]. SQL parameters are tokens of the
|
|
jpayne@69
|
4723 ** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as
|
|
jpayne@69
|
4724 ** placeholders for values that are [sqlite3_bind_blob | bound]
|
|
jpayne@69
|
4725 ** to the parameters at a later time.
|
|
jpayne@69
|
4726 **
|
|
jpayne@69
|
4727 ** ^(This routine actually returns the index of the largest (rightmost)
|
|
jpayne@69
|
4728 ** parameter. For all forms except ?NNN, this will correspond to the
|
|
jpayne@69
|
4729 ** number of unique parameters. If parameters of the ?NNN form are used,
|
|
jpayne@69
|
4730 ** there may be gaps in the list.)^
|
|
jpayne@69
|
4731 **
|
|
jpayne@69
|
4732 ** See also: [sqlite3_bind_blob|sqlite3_bind()],
|
|
jpayne@69
|
4733 ** [sqlite3_bind_parameter_name()], and
|
|
jpayne@69
|
4734 ** [sqlite3_bind_parameter_index()].
|
|
jpayne@69
|
4735 */
|
|
jpayne@69
|
4736 SQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt*);
|
|
jpayne@69
|
4737
|
|
jpayne@69
|
4738 /*
|
|
jpayne@69
|
4739 ** CAPI3REF: Name Of A Host Parameter
|
|
jpayne@69
|
4740 ** METHOD: sqlite3_stmt
|
|
jpayne@69
|
4741 **
|
|
jpayne@69
|
4742 ** ^The sqlite3_bind_parameter_name(P,N) interface returns
|
|
jpayne@69
|
4743 ** the name of the N-th [SQL parameter] in the [prepared statement] P.
|
|
jpayne@69
|
4744 ** ^(SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA"
|
|
jpayne@69
|
4745 ** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA"
|
|
jpayne@69
|
4746 ** respectively.
|
|
jpayne@69
|
4747 ** In other words, the initial ":" or "$" or "@" or "?"
|
|
jpayne@69
|
4748 ** is included as part of the name.)^
|
|
jpayne@69
|
4749 ** ^Parameters of the form "?" without a following integer have no name
|
|
jpayne@69
|
4750 ** and are referred to as "nameless" or "anonymous parameters".
|
|
jpayne@69
|
4751 **
|
|
jpayne@69
|
4752 ** ^The first host parameter has an index of 1, not 0.
|
|
jpayne@69
|
4753 **
|
|
jpayne@69
|
4754 ** ^If the value N is out of range or if the N-th parameter is
|
|
jpayne@69
|
4755 ** nameless, then NULL is returned. ^The returned string is
|
|
jpayne@69
|
4756 ** always in UTF-8 encoding even if the named parameter was
|
|
jpayne@69
|
4757 ** originally specified as UTF-16 in [sqlite3_prepare16()],
|
|
jpayne@69
|
4758 ** [sqlite3_prepare16_v2()], or [sqlite3_prepare16_v3()].
|
|
jpayne@69
|
4759 **
|
|
jpayne@69
|
4760 ** See also: [sqlite3_bind_blob|sqlite3_bind()],
|
|
jpayne@69
|
4761 ** [sqlite3_bind_parameter_count()], and
|
|
jpayne@69
|
4762 ** [sqlite3_bind_parameter_index()].
|
|
jpayne@69
|
4763 */
|
|
jpayne@69
|
4764 SQLITE_API const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int);
|
|
jpayne@69
|
4765
|
|
jpayne@69
|
4766 /*
|
|
jpayne@69
|
4767 ** CAPI3REF: Index Of A Parameter With A Given Name
|
|
jpayne@69
|
4768 ** METHOD: sqlite3_stmt
|
|
jpayne@69
|
4769 **
|
|
jpayne@69
|
4770 ** ^Return the index of an SQL parameter given its name. ^The
|
|
jpayne@69
|
4771 ** index value returned is suitable for use as the second
|
|
jpayne@69
|
4772 ** parameter to [sqlite3_bind_blob|sqlite3_bind()]. ^A zero
|
|
jpayne@69
|
4773 ** is returned if no matching parameter is found. ^The parameter
|
|
jpayne@69
|
4774 ** name must be given in UTF-8 even if the original statement
|
|
jpayne@69
|
4775 ** was prepared from UTF-16 text using [sqlite3_prepare16_v2()] or
|
|
jpayne@69
|
4776 ** [sqlite3_prepare16_v3()].
|
|
jpayne@69
|
4777 **
|
|
jpayne@69
|
4778 ** See also: [sqlite3_bind_blob|sqlite3_bind()],
|
|
jpayne@69
|
4779 ** [sqlite3_bind_parameter_count()], and
|
|
jpayne@69
|
4780 ** [sqlite3_bind_parameter_name()].
|
|
jpayne@69
|
4781 */
|
|
jpayne@69
|
4782 SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName);
|
|
jpayne@69
|
4783
|
|
jpayne@69
|
4784 /*
|
|
jpayne@69
|
4785 ** CAPI3REF: Reset All Bindings On A Prepared Statement
|
|
jpayne@69
|
4786 ** METHOD: sqlite3_stmt
|
|
jpayne@69
|
4787 **
|
|
jpayne@69
|
4788 ** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset
|
|
jpayne@69
|
4789 ** the [sqlite3_bind_blob | bindings] on a [prepared statement].
|
|
jpayne@69
|
4790 ** ^Use this routine to reset all host parameters to NULL.
|
|
jpayne@69
|
4791 */
|
|
jpayne@69
|
4792 SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*);
|
|
jpayne@69
|
4793
|
|
jpayne@69
|
4794 /*
|
|
jpayne@69
|
4795 ** CAPI3REF: Number Of Columns In A Result Set
|
|
jpayne@69
|
4796 ** METHOD: sqlite3_stmt
|
|
jpayne@69
|
4797 **
|
|
jpayne@69
|
4798 ** ^Return the number of columns in the result set returned by the
|
|
jpayne@69
|
4799 ** [prepared statement]. ^If this routine returns 0, that means the
|
|
jpayne@69
|
4800 ** [prepared statement] returns no data (for example an [UPDATE]).
|
|
jpayne@69
|
4801 ** ^However, just because this routine returns a positive number does not
|
|
jpayne@69
|
4802 ** mean that one or more rows of data will be returned. ^A SELECT statement
|
|
jpayne@69
|
4803 ** will always have a positive sqlite3_column_count() but depending on the
|
|
jpayne@69
|
4804 ** WHERE clause constraints and the table content, it might return no rows.
|
|
jpayne@69
|
4805 **
|
|
jpayne@69
|
4806 ** See also: [sqlite3_data_count()]
|
|
jpayne@69
|
4807 */
|
|
jpayne@69
|
4808 SQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt);
|
|
jpayne@69
|
4809
|
|
jpayne@69
|
4810 /*
|
|
jpayne@69
|
4811 ** CAPI3REF: Column Names In A Result Set
|
|
jpayne@69
|
4812 ** METHOD: sqlite3_stmt
|
|
jpayne@69
|
4813 **
|
|
jpayne@69
|
4814 ** ^These routines return the name assigned to a particular column
|
|
jpayne@69
|
4815 ** in the result set of a [SELECT] statement. ^The sqlite3_column_name()
|
|
jpayne@69
|
4816 ** interface returns a pointer to a zero-terminated UTF-8 string
|
|
jpayne@69
|
4817 ** and sqlite3_column_name16() returns a pointer to a zero-terminated
|
|
jpayne@69
|
4818 ** UTF-16 string. ^The first parameter is the [prepared statement]
|
|
jpayne@69
|
4819 ** that implements the [SELECT] statement. ^The second parameter is the
|
|
jpayne@69
|
4820 ** column number. ^The leftmost column is number 0.
|
|
jpayne@69
|
4821 **
|
|
jpayne@69
|
4822 ** ^The returned string pointer is valid until either the [prepared statement]
|
|
jpayne@69
|
4823 ** is destroyed by [sqlite3_finalize()] or until the statement is automatically
|
|
jpayne@69
|
4824 ** reprepared by the first call to [sqlite3_step()] for a particular run
|
|
jpayne@69
|
4825 ** or until the next call to
|
|
jpayne@69
|
4826 ** sqlite3_column_name() or sqlite3_column_name16() on the same column.
|
|
jpayne@69
|
4827 **
|
|
jpayne@69
|
4828 ** ^If sqlite3_malloc() fails during the processing of either routine
|
|
jpayne@69
|
4829 ** (for example during a conversion from UTF-8 to UTF-16) then a
|
|
jpayne@69
|
4830 ** NULL pointer is returned.
|
|
jpayne@69
|
4831 **
|
|
jpayne@69
|
4832 ** ^The name of a result column is the value of the "AS" clause for
|
|
jpayne@69
|
4833 ** that column, if there is an AS clause. If there is no AS clause
|
|
jpayne@69
|
4834 ** then the name of the column is unspecified and may change from
|
|
jpayne@69
|
4835 ** one release of SQLite to the next.
|
|
jpayne@69
|
4836 */
|
|
jpayne@69
|
4837 SQLITE_API const char *sqlite3_column_name(sqlite3_stmt*, int N);
|
|
jpayne@69
|
4838 SQLITE_API const void *sqlite3_column_name16(sqlite3_stmt*, int N);
|
|
jpayne@69
|
4839
|
|
jpayne@69
|
4840 /*
|
|
jpayne@69
|
4841 ** CAPI3REF: Source Of Data In A Query Result
|
|
jpayne@69
|
4842 ** METHOD: sqlite3_stmt
|
|
jpayne@69
|
4843 **
|
|
jpayne@69
|
4844 ** ^These routines provide a means to determine the database, table, and
|
|
jpayne@69
|
4845 ** table column that is the origin of a particular result column in
|
|
jpayne@69
|
4846 ** [SELECT] statement.
|
|
jpayne@69
|
4847 ** ^The name of the database or table or column can be returned as
|
|
jpayne@69
|
4848 ** either a UTF-8 or UTF-16 string. ^The _database_ routines return
|
|
jpayne@69
|
4849 ** the database name, the _table_ routines return the table name, and
|
|
jpayne@69
|
4850 ** the origin_ routines return the column name.
|
|
jpayne@69
|
4851 ** ^The returned string is valid until the [prepared statement] is destroyed
|
|
jpayne@69
|
4852 ** using [sqlite3_finalize()] or until the statement is automatically
|
|
jpayne@69
|
4853 ** reprepared by the first call to [sqlite3_step()] for a particular run
|
|
jpayne@69
|
4854 ** or until the same information is requested
|
|
jpayne@69
|
4855 ** again in a different encoding.
|
|
jpayne@69
|
4856 **
|
|
jpayne@69
|
4857 ** ^The names returned are the original un-aliased names of the
|
|
jpayne@69
|
4858 ** database, table, and column.
|
|
jpayne@69
|
4859 **
|
|
jpayne@69
|
4860 ** ^The first argument to these interfaces is a [prepared statement].
|
|
jpayne@69
|
4861 ** ^These functions return information about the Nth result column returned by
|
|
jpayne@69
|
4862 ** the statement, where N is the second function argument.
|
|
jpayne@69
|
4863 ** ^The left-most column is column 0 for these routines.
|
|
jpayne@69
|
4864 **
|
|
jpayne@69
|
4865 ** ^If the Nth column returned by the statement is an expression or
|
|
jpayne@69
|
4866 ** subquery and is not a column value, then all of these functions return
|
|
jpayne@69
|
4867 ** NULL. ^These routines might also return NULL if a memory allocation error
|
|
jpayne@69
|
4868 ** occurs. ^Otherwise, they return the name of the attached database, table,
|
|
jpayne@69
|
4869 ** or column that query result column was extracted from.
|
|
jpayne@69
|
4870 **
|
|
jpayne@69
|
4871 ** ^As with all other SQLite APIs, those whose names end with "16" return
|
|
jpayne@69
|
4872 ** UTF-16 encoded strings and the other functions return UTF-8.
|
|
jpayne@69
|
4873 **
|
|
jpayne@69
|
4874 ** ^These APIs are only available if the library was compiled with the
|
|
jpayne@69
|
4875 ** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol.
|
|
jpayne@69
|
4876 **
|
|
jpayne@69
|
4877 ** If two or more threads call one or more
|
|
jpayne@69
|
4878 ** [sqlite3_column_database_name | column metadata interfaces]
|
|
jpayne@69
|
4879 ** for the same [prepared statement] and result column
|
|
jpayne@69
|
4880 ** at the same time then the results are undefined.
|
|
jpayne@69
|
4881 */
|
|
jpayne@69
|
4882 SQLITE_API const char *sqlite3_column_database_name(sqlite3_stmt*,int);
|
|
jpayne@69
|
4883 SQLITE_API const void *sqlite3_column_database_name16(sqlite3_stmt*,int);
|
|
jpayne@69
|
4884 SQLITE_API const char *sqlite3_column_table_name(sqlite3_stmt*,int);
|
|
jpayne@69
|
4885 SQLITE_API const void *sqlite3_column_table_name16(sqlite3_stmt*,int);
|
|
jpayne@69
|
4886 SQLITE_API const char *sqlite3_column_origin_name(sqlite3_stmt*,int);
|
|
jpayne@69
|
4887 SQLITE_API const void *sqlite3_column_origin_name16(sqlite3_stmt*,int);
|
|
jpayne@69
|
4888
|
|
jpayne@69
|
4889 /*
|
|
jpayne@69
|
4890 ** CAPI3REF: Declared Datatype Of A Query Result
|
|
jpayne@69
|
4891 ** METHOD: sqlite3_stmt
|
|
jpayne@69
|
4892 **
|
|
jpayne@69
|
4893 ** ^(The first parameter is a [prepared statement].
|
|
jpayne@69
|
4894 ** If this statement is a [SELECT] statement and the Nth column of the
|
|
jpayne@69
|
4895 ** returned result set of that [SELECT] is a table column (not an
|
|
jpayne@69
|
4896 ** expression or subquery) then the declared type of the table
|
|
jpayne@69
|
4897 ** column is returned.)^ ^If the Nth column of the result set is an
|
|
jpayne@69
|
4898 ** expression or subquery, then a NULL pointer is returned.
|
|
jpayne@69
|
4899 ** ^The returned string is always UTF-8 encoded.
|
|
jpayne@69
|
4900 **
|
|
jpayne@69
|
4901 ** ^(For example, given the database schema:
|
|
jpayne@69
|
4902 **
|
|
jpayne@69
|
4903 ** CREATE TABLE t1(c1 VARIANT);
|
|
jpayne@69
|
4904 **
|
|
jpayne@69
|
4905 ** and the following statement to be compiled:
|
|
jpayne@69
|
4906 **
|
|
jpayne@69
|
4907 ** SELECT c1 + 1, c1 FROM t1;
|
|
jpayne@69
|
4908 **
|
|
jpayne@69
|
4909 ** this routine would return the string "VARIANT" for the second result
|
|
jpayne@69
|
4910 ** column (i==1), and a NULL pointer for the first result column (i==0).)^
|
|
jpayne@69
|
4911 **
|
|
jpayne@69
|
4912 ** ^SQLite uses dynamic run-time typing. ^So just because a column
|
|
jpayne@69
|
4913 ** is declared to contain a particular type does not mean that the
|
|
jpayne@69
|
4914 ** data stored in that column is of the declared type. SQLite is
|
|
jpayne@69
|
4915 ** strongly typed, but the typing is dynamic not static. ^Type
|
|
jpayne@69
|
4916 ** is associated with individual values, not with the containers
|
|
jpayne@69
|
4917 ** used to hold those values.
|
|
jpayne@69
|
4918 */
|
|
jpayne@69
|
4919 SQLITE_API const char *sqlite3_column_decltype(sqlite3_stmt*,int);
|
|
jpayne@69
|
4920 SQLITE_API const void *sqlite3_column_decltype16(sqlite3_stmt*,int);
|
|
jpayne@69
|
4921
|
|
jpayne@69
|
4922 /*
|
|
jpayne@69
|
4923 ** CAPI3REF: Evaluate An SQL Statement
|
|
jpayne@69
|
4924 ** METHOD: sqlite3_stmt
|
|
jpayne@69
|
4925 **
|
|
jpayne@69
|
4926 ** After a [prepared statement] has been prepared using any of
|
|
jpayne@69
|
4927 ** [sqlite3_prepare_v2()], [sqlite3_prepare_v3()], [sqlite3_prepare16_v2()],
|
|
jpayne@69
|
4928 ** or [sqlite3_prepare16_v3()] or one of the legacy
|
|
jpayne@69
|
4929 ** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function
|
|
jpayne@69
|
4930 ** must be called one or more times to evaluate the statement.
|
|
jpayne@69
|
4931 **
|
|
jpayne@69
|
4932 ** The details of the behavior of the sqlite3_step() interface depend
|
|
jpayne@69
|
4933 ** on whether the statement was prepared using the newer "vX" interfaces
|
|
jpayne@69
|
4934 ** [sqlite3_prepare_v3()], [sqlite3_prepare_v2()], [sqlite3_prepare16_v3()],
|
|
jpayne@69
|
4935 ** [sqlite3_prepare16_v2()] or the older legacy
|
|
jpayne@69
|
4936 ** interfaces [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the
|
|
jpayne@69
|
4937 ** new "vX" interface is recommended for new applications but the legacy
|
|
jpayne@69
|
4938 ** interface will continue to be supported.
|
|
jpayne@69
|
4939 **
|
|
jpayne@69
|
4940 ** ^In the legacy interface, the return value will be either [SQLITE_BUSY],
|
|
jpayne@69
|
4941 ** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE].
|
|
jpayne@69
|
4942 ** ^With the "v2" interface, any of the other [result codes] or
|
|
jpayne@69
|
4943 ** [extended result codes] might be returned as well.
|
|
jpayne@69
|
4944 **
|
|
jpayne@69
|
4945 ** ^[SQLITE_BUSY] means that the database engine was unable to acquire the
|
|
jpayne@69
|
4946 ** database locks it needs to do its job. ^If the statement is a [COMMIT]
|
|
jpayne@69
|
4947 ** or occurs outside of an explicit transaction, then you can retry the
|
|
jpayne@69
|
4948 ** statement. If the statement is not a [COMMIT] and occurs within an
|
|
jpayne@69
|
4949 ** explicit transaction then you should rollback the transaction before
|
|
jpayne@69
|
4950 ** continuing.
|
|
jpayne@69
|
4951 **
|
|
jpayne@69
|
4952 ** ^[SQLITE_DONE] means that the statement has finished executing
|
|
jpayne@69
|
4953 ** successfully. sqlite3_step() should not be called again on this virtual
|
|
jpayne@69
|
4954 ** machine without first calling [sqlite3_reset()] to reset the virtual
|
|
jpayne@69
|
4955 ** machine back to its initial state.
|
|
jpayne@69
|
4956 **
|
|
jpayne@69
|
4957 ** ^If the SQL statement being executed returns any data, then [SQLITE_ROW]
|
|
jpayne@69
|
4958 ** is returned each time a new row of data is ready for processing by the
|
|
jpayne@69
|
4959 ** caller. The values may be accessed using the [column access functions].
|
|
jpayne@69
|
4960 ** sqlite3_step() is called again to retrieve the next row of data.
|
|
jpayne@69
|
4961 **
|
|
jpayne@69
|
4962 ** ^[SQLITE_ERROR] means that a run-time error (such as a constraint
|
|
jpayne@69
|
4963 ** violation) has occurred. sqlite3_step() should not be called again on
|
|
jpayne@69
|
4964 ** the VM. More information may be found by calling [sqlite3_errmsg()].
|
|
jpayne@69
|
4965 ** ^With the legacy interface, a more specific error code (for example,
|
|
jpayne@69
|
4966 ** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth)
|
|
jpayne@69
|
4967 ** can be obtained by calling [sqlite3_reset()] on the
|
|
jpayne@69
|
4968 ** [prepared statement]. ^In the "v2" interface,
|
|
jpayne@69
|
4969 ** the more specific error code is returned directly by sqlite3_step().
|
|
jpayne@69
|
4970 **
|
|
jpayne@69
|
4971 ** [SQLITE_MISUSE] means that the this routine was called inappropriately.
|
|
jpayne@69
|
4972 ** Perhaps it was called on a [prepared statement] that has
|
|
jpayne@69
|
4973 ** already been [sqlite3_finalize | finalized] or on one that had
|
|
jpayne@69
|
4974 ** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could
|
|
jpayne@69
|
4975 ** be the case that the same database connection is being used by two or
|
|
jpayne@69
|
4976 ** more threads at the same moment in time.
|
|
jpayne@69
|
4977 **
|
|
jpayne@69
|
4978 ** For all versions of SQLite up to and including 3.6.23.1, a call to
|
|
jpayne@69
|
4979 ** [sqlite3_reset()] was required after sqlite3_step() returned anything
|
|
jpayne@69
|
4980 ** other than [SQLITE_ROW] before any subsequent invocation of
|
|
jpayne@69
|
4981 ** sqlite3_step(). Failure to reset the prepared statement using
|
|
jpayne@69
|
4982 ** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from
|
|
jpayne@69
|
4983 ** sqlite3_step(). But after [version 3.6.23.1] ([dateof:3.6.23.1],
|
|
jpayne@69
|
4984 ** sqlite3_step() began
|
|
jpayne@69
|
4985 ** calling [sqlite3_reset()] automatically in this circumstance rather
|
|
jpayne@69
|
4986 ** than returning [SQLITE_MISUSE]. This is not considered a compatibility
|
|
jpayne@69
|
4987 ** break because any application that ever receives an SQLITE_MISUSE error
|
|
jpayne@69
|
4988 ** is broken by definition. The [SQLITE_OMIT_AUTORESET] compile-time option
|
|
jpayne@69
|
4989 ** can be used to restore the legacy behavior.
|
|
jpayne@69
|
4990 **
|
|
jpayne@69
|
4991 ** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step()
|
|
jpayne@69
|
4992 ** API always returns a generic error code, [SQLITE_ERROR], following any
|
|
jpayne@69
|
4993 ** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call
|
|
jpayne@69
|
4994 ** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the
|
|
jpayne@69
|
4995 ** specific [error codes] that better describes the error.
|
|
jpayne@69
|
4996 ** We admit that this is a goofy design. The problem has been fixed
|
|
jpayne@69
|
4997 ** with the "v2" interface. If you prepare all of your SQL statements
|
|
jpayne@69
|
4998 ** using [sqlite3_prepare_v3()] or [sqlite3_prepare_v2()]
|
|
jpayne@69
|
4999 ** or [sqlite3_prepare16_v2()] or [sqlite3_prepare16_v3()] instead
|
|
jpayne@69
|
5000 ** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces,
|
|
jpayne@69
|
5001 ** then the more specific [error codes] are returned directly
|
|
jpayne@69
|
5002 ** by sqlite3_step(). The use of the "vX" interfaces is recommended.
|
|
jpayne@69
|
5003 */
|
|
jpayne@69
|
5004 SQLITE_API int sqlite3_step(sqlite3_stmt*);
|
|
jpayne@69
|
5005
|
|
jpayne@69
|
5006 /*
|
|
jpayne@69
|
5007 ** CAPI3REF: Number of columns in a result set
|
|
jpayne@69
|
5008 ** METHOD: sqlite3_stmt
|
|
jpayne@69
|
5009 **
|
|
jpayne@69
|
5010 ** ^The sqlite3_data_count(P) interface returns the number of columns in the
|
|
jpayne@69
|
5011 ** current row of the result set of [prepared statement] P.
|
|
jpayne@69
|
5012 ** ^If prepared statement P does not have results ready to return
|
|
jpayne@69
|
5013 ** (via calls to the [sqlite3_column_int | sqlite3_column()] family of
|
|
jpayne@69
|
5014 ** interfaces) then sqlite3_data_count(P) returns 0.
|
|
jpayne@69
|
5015 ** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer.
|
|
jpayne@69
|
5016 ** ^The sqlite3_data_count(P) routine returns 0 if the previous call to
|
|
jpayne@69
|
5017 ** [sqlite3_step](P) returned [SQLITE_DONE]. ^The sqlite3_data_count(P)
|
|
jpayne@69
|
5018 ** will return non-zero if previous call to [sqlite3_step](P) returned
|
|
jpayne@69
|
5019 ** [SQLITE_ROW], except in the case of the [PRAGMA incremental_vacuum]
|
|
jpayne@69
|
5020 ** where it always returns zero since each step of that multi-step
|
|
jpayne@69
|
5021 ** pragma returns 0 columns of data.
|
|
jpayne@69
|
5022 **
|
|
jpayne@69
|
5023 ** See also: [sqlite3_column_count()]
|
|
jpayne@69
|
5024 */
|
|
jpayne@69
|
5025 SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt);
|
|
jpayne@69
|
5026
|
|
jpayne@69
|
5027 /*
|
|
jpayne@69
|
5028 ** CAPI3REF: Fundamental Datatypes
|
|
jpayne@69
|
5029 ** KEYWORDS: SQLITE_TEXT
|
|
jpayne@69
|
5030 **
|
|
jpayne@69
|
5031 ** ^(Every value in SQLite has one of five fundamental datatypes:
|
|
jpayne@69
|
5032 **
|
|
jpayne@69
|
5033 ** <ul>
|
|
jpayne@69
|
5034 ** <li> 64-bit signed integer
|
|
jpayne@69
|
5035 ** <li> 64-bit IEEE floating point number
|
|
jpayne@69
|
5036 ** <li> string
|
|
jpayne@69
|
5037 ** <li> BLOB
|
|
jpayne@69
|
5038 ** <li> NULL
|
|
jpayne@69
|
5039 ** </ul>)^
|
|
jpayne@69
|
5040 **
|
|
jpayne@69
|
5041 ** These constants are codes for each of those types.
|
|
jpayne@69
|
5042 **
|
|
jpayne@69
|
5043 ** Note that the SQLITE_TEXT constant was also used in SQLite version 2
|
|
jpayne@69
|
5044 ** for a completely different meaning. Software that links against both
|
|
jpayne@69
|
5045 ** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not
|
|
jpayne@69
|
5046 ** SQLITE_TEXT.
|
|
jpayne@69
|
5047 */
|
|
jpayne@69
|
5048 #define SQLITE_INTEGER 1
|
|
jpayne@69
|
5049 #define SQLITE_FLOAT 2
|
|
jpayne@69
|
5050 #define SQLITE_BLOB 4
|
|
jpayne@69
|
5051 #define SQLITE_NULL 5
|
|
jpayne@69
|
5052 #ifdef SQLITE_TEXT
|
|
jpayne@69
|
5053 # undef SQLITE_TEXT
|
|
jpayne@69
|
5054 #else
|
|
jpayne@69
|
5055 # define SQLITE_TEXT 3
|
|
jpayne@69
|
5056 #endif
|
|
jpayne@69
|
5057 #define SQLITE3_TEXT 3
|
|
jpayne@69
|
5058
|
|
jpayne@69
|
5059 /*
|
|
jpayne@69
|
5060 ** CAPI3REF: Result Values From A Query
|
|
jpayne@69
|
5061 ** KEYWORDS: {column access functions}
|
|
jpayne@69
|
5062 ** METHOD: sqlite3_stmt
|
|
jpayne@69
|
5063 **
|
|
jpayne@69
|
5064 ** <b>Summary:</b>
|
|
jpayne@69
|
5065 ** <blockquote><table border=0 cellpadding=0 cellspacing=0>
|
|
jpayne@69
|
5066 ** <tr><td><b>sqlite3_column_blob</b><td>→<td>BLOB result
|
|
jpayne@69
|
5067 ** <tr><td><b>sqlite3_column_double</b><td>→<td>REAL result
|
|
jpayne@69
|
5068 ** <tr><td><b>sqlite3_column_int</b><td>→<td>32-bit INTEGER result
|
|
jpayne@69
|
5069 ** <tr><td><b>sqlite3_column_int64</b><td>→<td>64-bit INTEGER result
|
|
jpayne@69
|
5070 ** <tr><td><b>sqlite3_column_text</b><td>→<td>UTF-8 TEXT result
|
|
jpayne@69
|
5071 ** <tr><td><b>sqlite3_column_text16</b><td>→<td>UTF-16 TEXT result
|
|
jpayne@69
|
5072 ** <tr><td><b>sqlite3_column_value</b><td>→<td>The result as an
|
|
jpayne@69
|
5073 ** [sqlite3_value|unprotected sqlite3_value] object.
|
|
jpayne@69
|
5074 ** <tr><td> <td> <td>
|
|
jpayne@69
|
5075 ** <tr><td><b>sqlite3_column_bytes</b><td>→<td>Size of a BLOB
|
|
jpayne@69
|
5076 ** or a UTF-8 TEXT result in bytes
|
|
jpayne@69
|
5077 ** <tr><td><b>sqlite3_column_bytes16 </b>
|
|
jpayne@69
|
5078 ** <td>→ <td>Size of UTF-16
|
|
jpayne@69
|
5079 ** TEXT in bytes
|
|
jpayne@69
|
5080 ** <tr><td><b>sqlite3_column_type</b><td>→<td>Default
|
|
jpayne@69
|
5081 ** datatype of the result
|
|
jpayne@69
|
5082 ** </table></blockquote>
|
|
jpayne@69
|
5083 **
|
|
jpayne@69
|
5084 ** <b>Details:</b>
|
|
jpayne@69
|
5085 **
|
|
jpayne@69
|
5086 ** ^These routines return information about a single column of the current
|
|
jpayne@69
|
5087 ** result row of a query. ^In every case the first argument is a pointer
|
|
jpayne@69
|
5088 ** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*]
|
|
jpayne@69
|
5089 ** that was returned from [sqlite3_prepare_v2()] or one of its variants)
|
|
jpayne@69
|
5090 ** and the second argument is the index of the column for which information
|
|
jpayne@69
|
5091 ** should be returned. ^The leftmost column of the result set has the index 0.
|
|
jpayne@69
|
5092 ** ^The number of columns in the result can be determined using
|
|
jpayne@69
|
5093 ** [sqlite3_column_count()].
|
|
jpayne@69
|
5094 **
|
|
jpayne@69
|
5095 ** If the SQL statement does not currently point to a valid row, or if the
|
|
jpayne@69
|
5096 ** column index is out of range, the result is undefined.
|
|
jpayne@69
|
5097 ** These routines may only be called when the most recent call to
|
|
jpayne@69
|
5098 ** [sqlite3_step()] has returned [SQLITE_ROW] and neither
|
|
jpayne@69
|
5099 ** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently.
|
|
jpayne@69
|
5100 ** If any of these routines are called after [sqlite3_reset()] or
|
|
jpayne@69
|
5101 ** [sqlite3_finalize()] or after [sqlite3_step()] has returned
|
|
jpayne@69
|
5102 ** something other than [SQLITE_ROW], the results are undefined.
|
|
jpayne@69
|
5103 ** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()]
|
|
jpayne@69
|
5104 ** are called from a different thread while any of these routines
|
|
jpayne@69
|
5105 ** are pending, then the results are undefined.
|
|
jpayne@69
|
5106 **
|
|
jpayne@69
|
5107 ** The first six interfaces (_blob, _double, _int, _int64, _text, and _text16)
|
|
jpayne@69
|
5108 ** each return the value of a result column in a specific data format. If
|
|
jpayne@69
|
5109 ** the result column is not initially in the requested format (for example,
|
|
jpayne@69
|
5110 ** if the query returns an integer but the sqlite3_column_text() interface
|
|
jpayne@69
|
5111 ** is used to extract the value) then an automatic type conversion is performed.
|
|
jpayne@69
|
5112 **
|
|
jpayne@69
|
5113 ** ^The sqlite3_column_type() routine returns the
|
|
jpayne@69
|
5114 ** [SQLITE_INTEGER | datatype code] for the initial data type
|
|
jpayne@69
|
5115 ** of the result column. ^The returned value is one of [SQLITE_INTEGER],
|
|
jpayne@69
|
5116 ** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL].
|
|
jpayne@69
|
5117 ** The return value of sqlite3_column_type() can be used to decide which
|
|
jpayne@69
|
5118 ** of the first six interface should be used to extract the column value.
|
|
jpayne@69
|
5119 ** The value returned by sqlite3_column_type() is only meaningful if no
|
|
jpayne@69
|
5120 ** automatic type conversions have occurred for the value in question.
|
|
jpayne@69
|
5121 ** After a type conversion, the result of calling sqlite3_column_type()
|
|
jpayne@69
|
5122 ** is undefined, though harmless. Future
|
|
jpayne@69
|
5123 ** versions of SQLite may change the behavior of sqlite3_column_type()
|
|
jpayne@69
|
5124 ** following a type conversion.
|
|
jpayne@69
|
5125 **
|
|
jpayne@69
|
5126 ** If the result is a BLOB or a TEXT string, then the sqlite3_column_bytes()
|
|
jpayne@69
|
5127 ** or sqlite3_column_bytes16() interfaces can be used to determine the size
|
|
jpayne@69
|
5128 ** of that BLOB or string.
|
|
jpayne@69
|
5129 **
|
|
jpayne@69
|
5130 ** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes()
|
|
jpayne@69
|
5131 ** routine returns the number of bytes in that BLOB or string.
|
|
jpayne@69
|
5132 ** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts
|
|
jpayne@69
|
5133 ** the string to UTF-8 and then returns the number of bytes.
|
|
jpayne@69
|
5134 ** ^If the result is a numeric value then sqlite3_column_bytes() uses
|
|
jpayne@69
|
5135 ** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns
|
|
jpayne@69
|
5136 ** the number of bytes in that string.
|
|
jpayne@69
|
5137 ** ^If the result is NULL, then sqlite3_column_bytes() returns zero.
|
|
jpayne@69
|
5138 **
|
|
jpayne@69
|
5139 ** ^If the result is a BLOB or UTF-16 string then the sqlite3_column_bytes16()
|
|
jpayne@69
|
5140 ** routine returns the number of bytes in that BLOB or string.
|
|
jpayne@69
|
5141 ** ^If the result is a UTF-8 string, then sqlite3_column_bytes16() converts
|
|
jpayne@69
|
5142 ** the string to UTF-16 and then returns the number of bytes.
|
|
jpayne@69
|
5143 ** ^If the result is a numeric value then sqlite3_column_bytes16() uses
|
|
jpayne@69
|
5144 ** [sqlite3_snprintf()] to convert that value to a UTF-16 string and returns
|
|
jpayne@69
|
5145 ** the number of bytes in that string.
|
|
jpayne@69
|
5146 ** ^If the result is NULL, then sqlite3_column_bytes16() returns zero.
|
|
jpayne@69
|
5147 **
|
|
jpayne@69
|
5148 ** ^The values returned by [sqlite3_column_bytes()] and
|
|
jpayne@69
|
5149 ** [sqlite3_column_bytes16()] do not include the zero terminators at the end
|
|
jpayne@69
|
5150 ** of the string. ^For clarity: the values returned by
|
|
jpayne@69
|
5151 ** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of
|
|
jpayne@69
|
5152 ** bytes in the string, not the number of characters.
|
|
jpayne@69
|
5153 **
|
|
jpayne@69
|
5154 ** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(),
|
|
jpayne@69
|
5155 ** even empty strings, are always zero-terminated. ^The return
|
|
jpayne@69
|
5156 ** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer.
|
|
jpayne@69
|
5157 **
|
|
jpayne@69
|
5158 ** ^Strings returned by sqlite3_column_text16() always have the endianness
|
|
jpayne@69
|
5159 ** which is native to the platform, regardless of the text encoding set
|
|
jpayne@69
|
5160 ** for the database.
|
|
jpayne@69
|
5161 **
|
|
jpayne@69
|
5162 ** <b>Warning:</b> ^The object returned by [sqlite3_column_value()] is an
|
|
jpayne@69
|
5163 ** [unprotected sqlite3_value] object. In a multithreaded environment,
|
|
jpayne@69
|
5164 ** an unprotected sqlite3_value object may only be used safely with
|
|
jpayne@69
|
5165 ** [sqlite3_bind_value()] and [sqlite3_result_value()].
|
|
jpayne@69
|
5166 ** If the [unprotected sqlite3_value] object returned by
|
|
jpayne@69
|
5167 ** [sqlite3_column_value()] is used in any other way, including calls
|
|
jpayne@69
|
5168 ** to routines like [sqlite3_value_int()], [sqlite3_value_text()],
|
|
jpayne@69
|
5169 ** or [sqlite3_value_bytes()], the behavior is not threadsafe.
|
|
jpayne@69
|
5170 ** Hence, the sqlite3_column_value() interface
|
|
jpayne@69
|
5171 ** is normally only useful within the implementation of
|
|
jpayne@69
|
5172 ** [application-defined SQL functions] or [virtual tables], not within
|
|
jpayne@69
|
5173 ** top-level application code.
|
|
jpayne@69
|
5174 **
|
|
jpayne@69
|
5175 ** These routines may attempt to convert the datatype of the result.
|
|
jpayne@69
|
5176 ** ^For example, if the internal representation is FLOAT and a text result
|
|
jpayne@69
|
5177 ** is requested, [sqlite3_snprintf()] is used internally to perform the
|
|
jpayne@69
|
5178 ** conversion automatically. ^(The following table details the conversions
|
|
jpayne@69
|
5179 ** that are applied:
|
|
jpayne@69
|
5180 **
|
|
jpayne@69
|
5181 ** <blockquote>
|
|
jpayne@69
|
5182 ** <table border="1">
|
|
jpayne@69
|
5183 ** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion
|
|
jpayne@69
|
5184 **
|
|
jpayne@69
|
5185 ** <tr><td> NULL <td> INTEGER <td> Result is 0
|
|
jpayne@69
|
5186 ** <tr><td> NULL <td> FLOAT <td> Result is 0.0
|
|
jpayne@69
|
5187 ** <tr><td> NULL <td> TEXT <td> Result is a NULL pointer
|
|
jpayne@69
|
5188 ** <tr><td> NULL <td> BLOB <td> Result is a NULL pointer
|
|
jpayne@69
|
5189 ** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float
|
|
jpayne@69
|
5190 ** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer
|
|
jpayne@69
|
5191 ** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT
|
|
jpayne@69
|
5192 ** <tr><td> FLOAT <td> INTEGER <td> [CAST] to INTEGER
|
|
jpayne@69
|
5193 ** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float
|
|
jpayne@69
|
5194 ** <tr><td> FLOAT <td> BLOB <td> [CAST] to BLOB
|
|
jpayne@69
|
5195 ** <tr><td> TEXT <td> INTEGER <td> [CAST] to INTEGER
|
|
jpayne@69
|
5196 ** <tr><td> TEXT <td> FLOAT <td> [CAST] to REAL
|
|
jpayne@69
|
5197 ** <tr><td> TEXT <td> BLOB <td> No change
|
|
jpayne@69
|
5198 ** <tr><td> BLOB <td> INTEGER <td> [CAST] to INTEGER
|
|
jpayne@69
|
5199 ** <tr><td> BLOB <td> FLOAT <td> [CAST] to REAL
|
|
jpayne@69
|
5200 ** <tr><td> BLOB <td> TEXT <td> [CAST] to TEXT, ensure zero terminator
|
|
jpayne@69
|
5201 ** </table>
|
|
jpayne@69
|
5202 ** </blockquote>)^
|
|
jpayne@69
|
5203 **
|
|
jpayne@69
|
5204 ** Note that when type conversions occur, pointers returned by prior
|
|
jpayne@69
|
5205 ** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or
|
|
jpayne@69
|
5206 ** sqlite3_column_text16() may be invalidated.
|
|
jpayne@69
|
5207 ** Type conversions and pointer invalidations might occur
|
|
jpayne@69
|
5208 ** in the following cases:
|
|
jpayne@69
|
5209 **
|
|
jpayne@69
|
5210 ** <ul>
|
|
jpayne@69
|
5211 ** <li> The initial content is a BLOB and sqlite3_column_text() or
|
|
jpayne@69
|
5212 ** sqlite3_column_text16() is called. A zero-terminator might
|
|
jpayne@69
|
5213 ** need to be added to the string.</li>
|
|
jpayne@69
|
5214 ** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or
|
|
jpayne@69
|
5215 ** sqlite3_column_text16() is called. The content must be converted
|
|
jpayne@69
|
5216 ** to UTF-16.</li>
|
|
jpayne@69
|
5217 ** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or
|
|
jpayne@69
|
5218 ** sqlite3_column_text() is called. The content must be converted
|
|
jpayne@69
|
5219 ** to UTF-8.</li>
|
|
jpayne@69
|
5220 ** </ul>
|
|
jpayne@69
|
5221 **
|
|
jpayne@69
|
5222 ** ^Conversions between UTF-16be and UTF-16le are always done in place and do
|
|
jpayne@69
|
5223 ** not invalidate a prior pointer, though of course the content of the buffer
|
|
jpayne@69
|
5224 ** that the prior pointer references will have been modified. Other kinds
|
|
jpayne@69
|
5225 ** of conversion are done in place when it is possible, but sometimes they
|
|
jpayne@69
|
5226 ** are not possible and in those cases prior pointers are invalidated.
|
|
jpayne@69
|
5227 **
|
|
jpayne@69
|
5228 ** The safest policy is to invoke these routines
|
|
jpayne@69
|
5229 ** in one of the following ways:
|
|
jpayne@69
|
5230 **
|
|
jpayne@69
|
5231 ** <ul>
|
|
jpayne@69
|
5232 ** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li>
|
|
jpayne@69
|
5233 ** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li>
|
|
jpayne@69
|
5234 ** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li>
|
|
jpayne@69
|
5235 ** </ul>
|
|
jpayne@69
|
5236 **
|
|
jpayne@69
|
5237 ** In other words, you should call sqlite3_column_text(),
|
|
jpayne@69
|
5238 ** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result
|
|
jpayne@69
|
5239 ** into the desired format, then invoke sqlite3_column_bytes() or
|
|
jpayne@69
|
5240 ** sqlite3_column_bytes16() to find the size of the result. Do not mix calls
|
|
jpayne@69
|
5241 ** to sqlite3_column_text() or sqlite3_column_blob() with calls to
|
|
jpayne@69
|
5242 ** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16()
|
|
jpayne@69
|
5243 ** with calls to sqlite3_column_bytes().
|
|
jpayne@69
|
5244 **
|
|
jpayne@69
|
5245 ** ^The pointers returned are valid until a type conversion occurs as
|
|
jpayne@69
|
5246 ** described above, or until [sqlite3_step()] or [sqlite3_reset()] or
|
|
jpayne@69
|
5247 ** [sqlite3_finalize()] is called. ^The memory space used to hold strings
|
|
jpayne@69
|
5248 ** and BLOBs is freed automatically. Do not pass the pointers returned
|
|
jpayne@69
|
5249 ** from [sqlite3_column_blob()], [sqlite3_column_text()], etc. into
|
|
jpayne@69
|
5250 ** [sqlite3_free()].
|
|
jpayne@69
|
5251 **
|
|
jpayne@69
|
5252 ** As long as the input parameters are correct, these routines will only
|
|
jpayne@69
|
5253 ** fail if an out-of-memory error occurs during a format conversion.
|
|
jpayne@69
|
5254 ** Only the following subset of interfaces are subject to out-of-memory
|
|
jpayne@69
|
5255 ** errors:
|
|
jpayne@69
|
5256 **
|
|
jpayne@69
|
5257 ** <ul>
|
|
jpayne@69
|
5258 ** <li> sqlite3_column_blob()
|
|
jpayne@69
|
5259 ** <li> sqlite3_column_text()
|
|
jpayne@69
|
5260 ** <li> sqlite3_column_text16()
|
|
jpayne@69
|
5261 ** <li> sqlite3_column_bytes()
|
|
jpayne@69
|
5262 ** <li> sqlite3_column_bytes16()
|
|
jpayne@69
|
5263 ** </ul>
|
|
jpayne@69
|
5264 **
|
|
jpayne@69
|
5265 ** If an out-of-memory error occurs, then the return value from these
|
|
jpayne@69
|
5266 ** routines is the same as if the column had contained an SQL NULL value.
|
|
jpayne@69
|
5267 ** Valid SQL NULL returns can be distinguished from out-of-memory errors
|
|
jpayne@69
|
5268 ** by invoking the [sqlite3_errcode()] immediately after the suspect
|
|
jpayne@69
|
5269 ** return value is obtained and before any
|
|
jpayne@69
|
5270 ** other SQLite interface is called on the same [database connection].
|
|
jpayne@69
|
5271 */
|
|
jpayne@69
|
5272 SQLITE_API const void *sqlite3_column_blob(sqlite3_stmt*, int iCol);
|
|
jpayne@69
|
5273 SQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol);
|
|
jpayne@69
|
5274 SQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol);
|
|
jpayne@69
|
5275 SQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol);
|
|
jpayne@69
|
5276 SQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol);
|
|
jpayne@69
|
5277 SQLITE_API const void *sqlite3_column_text16(sqlite3_stmt*, int iCol);
|
|
jpayne@69
|
5278 SQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol);
|
|
jpayne@69
|
5279 SQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
|
|
jpayne@69
|
5280 SQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
|
|
jpayne@69
|
5281 SQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol);
|
|
jpayne@69
|
5282
|
|
jpayne@69
|
5283 /*
|
|
jpayne@69
|
5284 ** CAPI3REF: Destroy A Prepared Statement Object
|
|
jpayne@69
|
5285 ** DESTRUCTOR: sqlite3_stmt
|
|
jpayne@69
|
5286 **
|
|
jpayne@69
|
5287 ** ^The sqlite3_finalize() function is called to delete a [prepared statement].
|
|
jpayne@69
|
5288 ** ^If the most recent evaluation of the statement encountered no errors
|
|
jpayne@69
|
5289 ** or if the statement is never been evaluated, then sqlite3_finalize() returns
|
|
jpayne@69
|
5290 ** SQLITE_OK. ^If the most recent evaluation of statement S failed, then
|
|
jpayne@69
|
5291 ** sqlite3_finalize(S) returns the appropriate [error code] or
|
|
jpayne@69
|
5292 ** [extended error code].
|
|
jpayne@69
|
5293 **
|
|
jpayne@69
|
5294 ** ^The sqlite3_finalize(S) routine can be called at any point during
|
|
jpayne@69
|
5295 ** the life cycle of [prepared statement] S:
|
|
jpayne@69
|
5296 ** before statement S is ever evaluated, after
|
|
jpayne@69
|
5297 ** one or more calls to [sqlite3_reset()], or after any call
|
|
jpayne@69
|
5298 ** to [sqlite3_step()] regardless of whether or not the statement has
|
|
jpayne@69
|
5299 ** completed execution.
|
|
jpayne@69
|
5300 **
|
|
jpayne@69
|
5301 ** ^Invoking sqlite3_finalize() on a NULL pointer is a harmless no-op.
|
|
jpayne@69
|
5302 **
|
|
jpayne@69
|
5303 ** The application must finalize every [prepared statement] in order to avoid
|
|
jpayne@69
|
5304 ** resource leaks. It is a grievous error for the application to try to use
|
|
jpayne@69
|
5305 ** a prepared statement after it has been finalized. Any use of a prepared
|
|
jpayne@69
|
5306 ** statement after it has been finalized can result in undefined and
|
|
jpayne@69
|
5307 ** undesirable behavior such as segfaults and heap corruption.
|
|
jpayne@69
|
5308 */
|
|
jpayne@69
|
5309 SQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt);
|
|
jpayne@69
|
5310
|
|
jpayne@69
|
5311 /*
|
|
jpayne@69
|
5312 ** CAPI3REF: Reset A Prepared Statement Object
|
|
jpayne@69
|
5313 ** METHOD: sqlite3_stmt
|
|
jpayne@69
|
5314 **
|
|
jpayne@69
|
5315 ** The sqlite3_reset() function is called to reset a [prepared statement]
|
|
jpayne@69
|
5316 ** object back to its initial state, ready to be re-executed.
|
|
jpayne@69
|
5317 ** ^Any SQL statement variables that had values bound to them using
|
|
jpayne@69
|
5318 ** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values.
|
|
jpayne@69
|
5319 ** Use [sqlite3_clear_bindings()] to reset the bindings.
|
|
jpayne@69
|
5320 **
|
|
jpayne@69
|
5321 ** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S
|
|
jpayne@69
|
5322 ** back to the beginning of its program.
|
|
jpayne@69
|
5323 **
|
|
jpayne@69
|
5324 ** ^The return code from [sqlite3_reset(S)] indicates whether or not
|
|
jpayne@69
|
5325 ** the previous evaluation of prepared statement S completed successfully.
|
|
jpayne@69
|
5326 ** ^If [sqlite3_step(S)] has never before been called on S or if
|
|
jpayne@69
|
5327 ** [sqlite3_step(S)] has not been called since the previous call
|
|
jpayne@69
|
5328 ** to [sqlite3_reset(S)], then [sqlite3_reset(S)] will return
|
|
jpayne@69
|
5329 ** [SQLITE_OK].
|
|
jpayne@69
|
5330 **
|
|
jpayne@69
|
5331 ** ^If the most recent call to [sqlite3_step(S)] for the
|
|
jpayne@69
|
5332 ** [prepared statement] S indicated an error, then
|
|
jpayne@69
|
5333 ** [sqlite3_reset(S)] returns an appropriate [error code].
|
|
jpayne@69
|
5334 ** ^The [sqlite3_reset(S)] interface might also return an [error code]
|
|
jpayne@69
|
5335 ** if there were no prior errors but the process of resetting
|
|
jpayne@69
|
5336 ** the prepared statement caused a new error. ^For example, if an
|
|
jpayne@69
|
5337 ** [INSERT] statement with a [RETURNING] clause is only stepped one time,
|
|
jpayne@69
|
5338 ** that one call to [sqlite3_step(S)] might return SQLITE_ROW but
|
|
jpayne@69
|
5339 ** the overall statement might still fail and the [sqlite3_reset(S)] call
|
|
jpayne@69
|
5340 ** might return SQLITE_BUSY if locking constraints prevent the
|
|
jpayne@69
|
5341 ** database change from committing. Therefore, it is important that
|
|
jpayne@69
|
5342 ** applications check the return code from [sqlite3_reset(S)] even if
|
|
jpayne@69
|
5343 ** no prior call to [sqlite3_step(S)] indicated a problem.
|
|
jpayne@69
|
5344 **
|
|
jpayne@69
|
5345 ** ^The [sqlite3_reset(S)] interface does not change the values
|
|
jpayne@69
|
5346 ** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S.
|
|
jpayne@69
|
5347 */
|
|
jpayne@69
|
5348 SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
|
|
jpayne@69
|
5349
|
|
jpayne@69
|
5350
|
|
jpayne@69
|
5351 /*
|
|
jpayne@69
|
5352 ** CAPI3REF: Create Or Redefine SQL Functions
|
|
jpayne@69
|
5353 ** KEYWORDS: {function creation routines}
|
|
jpayne@69
|
5354 ** METHOD: sqlite3
|
|
jpayne@69
|
5355 **
|
|
jpayne@69
|
5356 ** ^These functions (collectively known as "function creation routines")
|
|
jpayne@69
|
5357 ** are used to add SQL functions or aggregates or to redefine the behavior
|
|
jpayne@69
|
5358 ** of existing SQL functions or aggregates. The only differences between
|
|
jpayne@69
|
5359 ** the three "sqlite3_create_function*" routines are the text encoding
|
|
jpayne@69
|
5360 ** expected for the second parameter (the name of the function being
|
|
jpayne@69
|
5361 ** created) and the presence or absence of a destructor callback for
|
|
jpayne@69
|
5362 ** the application data pointer. Function sqlite3_create_window_function()
|
|
jpayne@69
|
5363 ** is similar, but allows the user to supply the extra callback functions
|
|
jpayne@69
|
5364 ** needed by [aggregate window functions].
|
|
jpayne@69
|
5365 **
|
|
jpayne@69
|
5366 ** ^The first parameter is the [database connection] to which the SQL
|
|
jpayne@69
|
5367 ** function is to be added. ^If an application uses more than one database
|
|
jpayne@69
|
5368 ** connection then application-defined SQL functions must be added
|
|
jpayne@69
|
5369 ** to each database connection separately.
|
|
jpayne@69
|
5370 **
|
|
jpayne@69
|
5371 ** ^The second parameter is the name of the SQL function to be created or
|
|
jpayne@69
|
5372 ** redefined. ^The length of the name is limited to 255 bytes in a UTF-8
|
|
jpayne@69
|
5373 ** representation, exclusive of the zero-terminator. ^Note that the name
|
|
jpayne@69
|
5374 ** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes.
|
|
jpayne@69
|
5375 ** ^Any attempt to create a function with a longer name
|
|
jpayne@69
|
5376 ** will result in [SQLITE_MISUSE] being returned.
|
|
jpayne@69
|
5377 **
|
|
jpayne@69
|
5378 ** ^The third parameter (nArg)
|
|
jpayne@69
|
5379 ** is the number of arguments that the SQL function or
|
|
jpayne@69
|
5380 ** aggregate takes. ^If this parameter is -1, then the SQL function or
|
|
jpayne@69
|
5381 ** aggregate may take any number of arguments between 0 and the limit
|
|
jpayne@69
|
5382 ** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third
|
|
jpayne@69
|
5383 ** parameter is less than -1 or greater than 127 then the behavior is
|
|
jpayne@69
|
5384 ** undefined.
|
|
jpayne@69
|
5385 **
|
|
jpayne@69
|
5386 ** ^The fourth parameter, eTextRep, specifies what
|
|
jpayne@69
|
5387 ** [SQLITE_UTF8 | text encoding] this SQL function prefers for
|
|
jpayne@69
|
5388 ** its parameters. The application should set this parameter to
|
|
jpayne@69
|
5389 ** [SQLITE_UTF16LE] if the function implementation invokes
|
|
jpayne@69
|
5390 ** [sqlite3_value_text16le()] on an input, or [SQLITE_UTF16BE] if the
|
|
jpayne@69
|
5391 ** implementation invokes [sqlite3_value_text16be()] on an input, or
|
|
jpayne@69
|
5392 ** [SQLITE_UTF16] if [sqlite3_value_text16()] is used, or [SQLITE_UTF8]
|
|
jpayne@69
|
5393 ** otherwise. ^The same SQL function may be registered multiple times using
|
|
jpayne@69
|
5394 ** different preferred text encodings, with different implementations for
|
|
jpayne@69
|
5395 ** each encoding.
|
|
jpayne@69
|
5396 ** ^When multiple implementations of the same function are available, SQLite
|
|
jpayne@69
|
5397 ** will pick the one that involves the least amount of data conversion.
|
|
jpayne@69
|
5398 **
|
|
jpayne@69
|
5399 ** ^The fourth parameter may optionally be ORed with [SQLITE_DETERMINISTIC]
|
|
jpayne@69
|
5400 ** to signal that the function will always return the same result given
|
|
jpayne@69
|
5401 ** the same inputs within a single SQL statement. Most SQL functions are
|
|
jpayne@69
|
5402 ** deterministic. The built-in [random()] SQL function is an example of a
|
|
jpayne@69
|
5403 ** function that is not deterministic. The SQLite query planner is able to
|
|
jpayne@69
|
5404 ** perform additional optimizations on deterministic functions, so use
|
|
jpayne@69
|
5405 ** of the [SQLITE_DETERMINISTIC] flag is recommended where possible.
|
|
jpayne@69
|
5406 **
|
|
jpayne@69
|
5407 ** ^The fourth parameter may also optionally include the [SQLITE_DIRECTONLY]
|
|
jpayne@69
|
5408 ** flag, which if present prevents the function from being invoked from
|
|
jpayne@69
|
5409 ** within VIEWs, TRIGGERs, CHECK constraints, generated column expressions,
|
|
jpayne@69
|
5410 ** index expressions, or the WHERE clause of partial indexes.
|
|
jpayne@69
|
5411 **
|
|
jpayne@69
|
5412 ** For best security, the [SQLITE_DIRECTONLY] flag is recommended for
|
|
jpayne@69
|
5413 ** all application-defined SQL functions that do not need to be
|
|
jpayne@69
|
5414 ** used inside of triggers, view, CHECK constraints, or other elements of
|
|
jpayne@69
|
5415 ** the database schema. This flags is especially recommended for SQL
|
|
jpayne@69
|
5416 ** functions that have side effects or reveal internal application state.
|
|
jpayne@69
|
5417 ** Without this flag, an attacker might be able to modify the schema of
|
|
jpayne@69
|
5418 ** a database file to include invocations of the function with parameters
|
|
jpayne@69
|
5419 ** chosen by the attacker, which the application will then execute when
|
|
jpayne@69
|
5420 ** the database file is opened and read.
|
|
jpayne@69
|
5421 **
|
|
jpayne@69
|
5422 ** ^(The fifth parameter is an arbitrary pointer. The implementation of the
|
|
jpayne@69
|
5423 ** function can gain access to this pointer using [sqlite3_user_data()].)^
|
|
jpayne@69
|
5424 **
|
|
jpayne@69
|
5425 ** ^The sixth, seventh and eighth parameters passed to the three
|
|
jpayne@69
|
5426 ** "sqlite3_create_function*" functions, xFunc, xStep and xFinal, are
|
|
jpayne@69
|
5427 ** pointers to C-language functions that implement the SQL function or
|
|
jpayne@69
|
5428 ** aggregate. ^A scalar SQL function requires an implementation of the xFunc
|
|
jpayne@69
|
5429 ** callback only; NULL pointers must be passed as the xStep and xFinal
|
|
jpayne@69
|
5430 ** parameters. ^An aggregate SQL function requires an implementation of xStep
|
|
jpayne@69
|
5431 ** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing
|
|
jpayne@69
|
5432 ** SQL function or aggregate, pass NULL pointers for all three function
|
|
jpayne@69
|
5433 ** callbacks.
|
|
jpayne@69
|
5434 **
|
|
jpayne@69
|
5435 ** ^The sixth, seventh, eighth and ninth parameters (xStep, xFinal, xValue
|
|
jpayne@69
|
5436 ** and xInverse) passed to sqlite3_create_window_function are pointers to
|
|
jpayne@69
|
5437 ** C-language callbacks that implement the new function. xStep and xFinal
|
|
jpayne@69
|
5438 ** must both be non-NULL. xValue and xInverse may either both be NULL, in
|
|
jpayne@69
|
5439 ** which case a regular aggregate function is created, or must both be
|
|
jpayne@69
|
5440 ** non-NULL, in which case the new function may be used as either an aggregate
|
|
jpayne@69
|
5441 ** or aggregate window function. More details regarding the implementation
|
|
jpayne@69
|
5442 ** of aggregate window functions are
|
|
jpayne@69
|
5443 ** [user-defined window functions|available here].
|
|
jpayne@69
|
5444 **
|
|
jpayne@69
|
5445 ** ^(If the final parameter to sqlite3_create_function_v2() or
|
|
jpayne@69
|
5446 ** sqlite3_create_window_function() is not NULL, then it is destructor for
|
|
jpayne@69
|
5447 ** the application data pointer. The destructor is invoked when the function
|
|
jpayne@69
|
5448 ** is deleted, either by being overloaded or when the database connection
|
|
jpayne@69
|
5449 ** closes.)^ ^The destructor is also invoked if the call to
|
|
jpayne@69
|
5450 ** sqlite3_create_function_v2() fails. ^When the destructor callback is
|
|
jpayne@69
|
5451 ** invoked, it is passed a single argument which is a copy of the application
|
|
jpayne@69
|
5452 ** data pointer which was the fifth parameter to sqlite3_create_function_v2().
|
|
jpayne@69
|
5453 **
|
|
jpayne@69
|
5454 ** ^It is permitted to register multiple implementations of the same
|
|
jpayne@69
|
5455 ** functions with the same name but with either differing numbers of
|
|
jpayne@69
|
5456 ** arguments or differing preferred text encodings. ^SQLite will use
|
|
jpayne@69
|
5457 ** the implementation that most closely matches the way in which the
|
|
jpayne@69
|
5458 ** SQL function is used. ^A function implementation with a non-negative
|
|
jpayne@69
|
5459 ** nArg parameter is a better match than a function implementation with
|
|
jpayne@69
|
5460 ** a negative nArg. ^A function where the preferred text encoding
|
|
jpayne@69
|
5461 ** matches the database encoding is a better
|
|
jpayne@69
|
5462 ** match than a function where the encoding is different.
|
|
jpayne@69
|
5463 ** ^A function where the encoding difference is between UTF16le and UTF16be
|
|
jpayne@69
|
5464 ** is a closer match than a function where the encoding difference is
|
|
jpayne@69
|
5465 ** between UTF8 and UTF16.
|
|
jpayne@69
|
5466 **
|
|
jpayne@69
|
5467 ** ^Built-in functions may be overloaded by new application-defined functions.
|
|
jpayne@69
|
5468 **
|
|
jpayne@69
|
5469 ** ^An application-defined function is permitted to call other
|
|
jpayne@69
|
5470 ** SQLite interfaces. However, such calls must not
|
|
jpayne@69
|
5471 ** close the database connection nor finalize or reset the prepared
|
|
jpayne@69
|
5472 ** statement in which the function is running.
|
|
jpayne@69
|
5473 */
|
|
jpayne@69
|
5474 SQLITE_API int sqlite3_create_function(
|
|
jpayne@69
|
5475 sqlite3 *db,
|
|
jpayne@69
|
5476 const char *zFunctionName,
|
|
jpayne@69
|
5477 int nArg,
|
|
jpayne@69
|
5478 int eTextRep,
|
|
jpayne@69
|
5479 void *pApp,
|
|
jpayne@69
|
5480 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
|
|
jpayne@69
|
5481 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
|
|
jpayne@69
|
5482 void (*xFinal)(sqlite3_context*)
|
|
jpayne@69
|
5483 );
|
|
jpayne@69
|
5484 SQLITE_API int sqlite3_create_function16(
|
|
jpayne@69
|
5485 sqlite3 *db,
|
|
jpayne@69
|
5486 const void *zFunctionName,
|
|
jpayne@69
|
5487 int nArg,
|
|
jpayne@69
|
5488 int eTextRep,
|
|
jpayne@69
|
5489 void *pApp,
|
|
jpayne@69
|
5490 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
|
|
jpayne@69
|
5491 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
|
|
jpayne@69
|
5492 void (*xFinal)(sqlite3_context*)
|
|
jpayne@69
|
5493 );
|
|
jpayne@69
|
5494 SQLITE_API int sqlite3_create_function_v2(
|
|
jpayne@69
|
5495 sqlite3 *db,
|
|
jpayne@69
|
5496 const char *zFunctionName,
|
|
jpayne@69
|
5497 int nArg,
|
|
jpayne@69
|
5498 int eTextRep,
|
|
jpayne@69
|
5499 void *pApp,
|
|
jpayne@69
|
5500 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
|
|
jpayne@69
|
5501 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
|
|
jpayne@69
|
5502 void (*xFinal)(sqlite3_context*),
|
|
jpayne@69
|
5503 void(*xDestroy)(void*)
|
|
jpayne@69
|
5504 );
|
|
jpayne@69
|
5505 SQLITE_API int sqlite3_create_window_function(
|
|
jpayne@69
|
5506 sqlite3 *db,
|
|
jpayne@69
|
5507 const char *zFunctionName,
|
|
jpayne@69
|
5508 int nArg,
|
|
jpayne@69
|
5509 int eTextRep,
|
|
jpayne@69
|
5510 void *pApp,
|
|
jpayne@69
|
5511 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
|
|
jpayne@69
|
5512 void (*xFinal)(sqlite3_context*),
|
|
jpayne@69
|
5513 void (*xValue)(sqlite3_context*),
|
|
jpayne@69
|
5514 void (*xInverse)(sqlite3_context*,int,sqlite3_value**),
|
|
jpayne@69
|
5515 void(*xDestroy)(void*)
|
|
jpayne@69
|
5516 );
|
|
jpayne@69
|
5517
|
|
jpayne@69
|
5518 /*
|
|
jpayne@69
|
5519 ** CAPI3REF: Text Encodings
|
|
jpayne@69
|
5520 **
|
|
jpayne@69
|
5521 ** These constant define integer codes that represent the various
|
|
jpayne@69
|
5522 ** text encodings supported by SQLite.
|
|
jpayne@69
|
5523 */
|
|
jpayne@69
|
5524 #define SQLITE_UTF8 1 /* IMP: R-37514-35566 */
|
|
jpayne@69
|
5525 #define SQLITE_UTF16LE 2 /* IMP: R-03371-37637 */
|
|
jpayne@69
|
5526 #define SQLITE_UTF16BE 3 /* IMP: R-51971-34154 */
|
|
jpayne@69
|
5527 #define SQLITE_UTF16 4 /* Use native byte order */
|
|
jpayne@69
|
5528 #define SQLITE_ANY 5 /* Deprecated */
|
|
jpayne@69
|
5529 #define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */
|
|
jpayne@69
|
5530
|
|
jpayne@69
|
5531 /*
|
|
jpayne@69
|
5532 ** CAPI3REF: Function Flags
|
|
jpayne@69
|
5533 **
|
|
jpayne@69
|
5534 ** These constants may be ORed together with the
|
|
jpayne@69
|
5535 ** [SQLITE_UTF8 | preferred text encoding] as the fourth argument
|
|
jpayne@69
|
5536 ** to [sqlite3_create_function()], [sqlite3_create_function16()], or
|
|
jpayne@69
|
5537 ** [sqlite3_create_function_v2()].
|
|
jpayne@69
|
5538 **
|
|
jpayne@69
|
5539 ** <dl>
|
|
jpayne@69
|
5540 ** [[SQLITE_DETERMINISTIC]] <dt>SQLITE_DETERMINISTIC</dt><dd>
|
|
jpayne@69
|
5541 ** The SQLITE_DETERMINISTIC flag means that the new function always gives
|
|
jpayne@69
|
5542 ** the same output when the input parameters are the same.
|
|
jpayne@69
|
5543 ** The [abs|abs() function] is deterministic, for example, but
|
|
jpayne@69
|
5544 ** [randomblob|randomblob()] is not. Functions must
|
|
jpayne@69
|
5545 ** be deterministic in order to be used in certain contexts such as
|
|
jpayne@69
|
5546 ** with the WHERE clause of [partial indexes] or in [generated columns].
|
|
jpayne@69
|
5547 ** SQLite might also optimize deterministic functions by factoring them
|
|
jpayne@69
|
5548 ** out of inner loops.
|
|
jpayne@69
|
5549 ** </dd>
|
|
jpayne@69
|
5550 **
|
|
jpayne@69
|
5551 ** [[SQLITE_DIRECTONLY]] <dt>SQLITE_DIRECTONLY</dt><dd>
|
|
jpayne@69
|
5552 ** The SQLITE_DIRECTONLY flag means that the function may only be invoked
|
|
jpayne@69
|
5553 ** from top-level SQL, and cannot be used in VIEWs or TRIGGERs nor in
|
|
jpayne@69
|
5554 ** schema structures such as [CHECK constraints], [DEFAULT clauses],
|
|
jpayne@69
|
5555 ** [expression indexes], [partial indexes], or [generated columns].
|
|
jpayne@69
|
5556 ** <p>
|
|
jpayne@69
|
5557 ** The SQLITE_DIRECTONLY flag is recommended for any
|
|
jpayne@69
|
5558 ** [application-defined SQL function]
|
|
jpayne@69
|
5559 ** that has side-effects or that could potentially leak sensitive information.
|
|
jpayne@69
|
5560 ** This will prevent attacks in which an application is tricked
|
|
jpayne@69
|
5561 ** into using a database file that has had its schema surreptitiously
|
|
jpayne@69
|
5562 ** modified to invoke the application-defined function in ways that are
|
|
jpayne@69
|
5563 ** harmful.
|
|
jpayne@69
|
5564 ** <p>
|
|
jpayne@69
|
5565 ** Some people say it is good practice to set SQLITE_DIRECTONLY on all
|
|
jpayne@69
|
5566 ** [application-defined SQL functions], regardless of whether or not they
|
|
jpayne@69
|
5567 ** are security sensitive, as doing so prevents those functions from being used
|
|
jpayne@69
|
5568 ** inside of the database schema, and thus ensures that the database
|
|
jpayne@69
|
5569 ** can be inspected and modified using generic tools (such as the [CLI])
|
|
jpayne@69
|
5570 ** that do not have access to the application-defined functions.
|
|
jpayne@69
|
5571 ** </dd>
|
|
jpayne@69
|
5572 **
|
|
jpayne@69
|
5573 ** [[SQLITE_INNOCUOUS]] <dt>SQLITE_INNOCUOUS</dt><dd>
|
|
jpayne@69
|
5574 ** The SQLITE_INNOCUOUS flag means that the function is unlikely
|
|
jpayne@69
|
5575 ** to cause problems even if misused. An innocuous function should have
|
|
jpayne@69
|
5576 ** no side effects and should not depend on any values other than its
|
|
jpayne@69
|
5577 ** input parameters. The [abs|abs() function] is an example of an
|
|
jpayne@69
|
5578 ** innocuous function.
|
|
jpayne@69
|
5579 ** The [load_extension() SQL function] is not innocuous because of its
|
|
jpayne@69
|
5580 ** side effects.
|
|
jpayne@69
|
5581 ** <p> SQLITE_INNOCUOUS is similar to SQLITE_DETERMINISTIC, but is not
|
|
jpayne@69
|
5582 ** exactly the same. The [random|random() function] is an example of a
|
|
jpayne@69
|
5583 ** function that is innocuous but not deterministic.
|
|
jpayne@69
|
5584 ** <p>Some heightened security settings
|
|
jpayne@69
|
5585 ** ([SQLITE_DBCONFIG_TRUSTED_SCHEMA] and [PRAGMA trusted_schema=OFF])
|
|
jpayne@69
|
5586 ** disable the use of SQL functions inside views and triggers and in
|
|
jpayne@69
|
5587 ** schema structures such as [CHECK constraints], [DEFAULT clauses],
|
|
jpayne@69
|
5588 ** [expression indexes], [partial indexes], and [generated columns] unless
|
|
jpayne@69
|
5589 ** the function is tagged with SQLITE_INNOCUOUS. Most built-in functions
|
|
jpayne@69
|
5590 ** are innocuous. Developers are advised to avoid using the
|
|
jpayne@69
|
5591 ** SQLITE_INNOCUOUS flag for application-defined functions unless the
|
|
jpayne@69
|
5592 ** function has been carefully audited and found to be free of potentially
|
|
jpayne@69
|
5593 ** security-adverse side-effects and information-leaks.
|
|
jpayne@69
|
5594 ** </dd>
|
|
jpayne@69
|
5595 **
|
|
jpayne@69
|
5596 ** [[SQLITE_SUBTYPE]] <dt>SQLITE_SUBTYPE</dt><dd>
|
|
jpayne@69
|
5597 ** The SQLITE_SUBTYPE flag indicates to SQLite that a function might call
|
|
jpayne@69
|
5598 ** [sqlite3_value_subtype()] to inspect the sub-types of its arguments.
|
|
jpayne@69
|
5599 ** This flag instructs SQLite to omit some corner-case optimizations that
|
|
jpayne@69
|
5600 ** might disrupt the operation of the [sqlite3_value_subtype()] function,
|
|
jpayne@69
|
5601 ** causing it to return zero rather than the correct subtype().
|
|
jpayne@69
|
5602 ** SQL functions that invokes [sqlite3_value_subtype()] should have this
|
|
jpayne@69
|
5603 ** property. If the SQLITE_SUBTYPE property is omitted, then the return
|
|
jpayne@69
|
5604 ** value from [sqlite3_value_subtype()] might sometimes be zero even though
|
|
jpayne@69
|
5605 ** a non-zero subtype was specified by the function argument expression.
|
|
jpayne@69
|
5606 **
|
|
jpayne@69
|
5607 ** [[SQLITE_RESULT_SUBTYPE]] <dt>SQLITE_RESULT_SUBTYPE</dt><dd>
|
|
jpayne@69
|
5608 ** The SQLITE_RESULT_SUBTYPE flag indicates to SQLite that a function might call
|
|
jpayne@69
|
5609 ** [sqlite3_result_subtype()] to cause a sub-type to be associated with its
|
|
jpayne@69
|
5610 ** result.
|
|
jpayne@69
|
5611 ** Every function that invokes [sqlite3_result_subtype()] should have this
|
|
jpayne@69
|
5612 ** property. If it does not, then the call to [sqlite3_result_subtype()]
|
|
jpayne@69
|
5613 ** might become a no-op if the function is used as term in an
|
|
jpayne@69
|
5614 ** [expression index]. On the other hand, SQL functions that never invoke
|
|
jpayne@69
|
5615 ** [sqlite3_result_subtype()] should avoid setting this property, as the
|
|
jpayne@69
|
5616 ** purpose of this property is to disable certain optimizations that are
|
|
jpayne@69
|
5617 ** incompatible with subtypes.
|
|
jpayne@69
|
5618 ** </dd>
|
|
jpayne@69
|
5619 ** </dl>
|
|
jpayne@69
|
5620 */
|
|
jpayne@69
|
5621 #define SQLITE_DETERMINISTIC 0x000000800
|
|
jpayne@69
|
5622 #define SQLITE_DIRECTONLY 0x000080000
|
|
jpayne@69
|
5623 #define SQLITE_SUBTYPE 0x000100000
|
|
jpayne@69
|
5624 #define SQLITE_INNOCUOUS 0x000200000
|
|
jpayne@69
|
5625 #define SQLITE_RESULT_SUBTYPE 0x001000000
|
|
jpayne@69
|
5626
|
|
jpayne@69
|
5627 /*
|
|
jpayne@69
|
5628 ** CAPI3REF: Deprecated Functions
|
|
jpayne@69
|
5629 ** DEPRECATED
|
|
jpayne@69
|
5630 **
|
|
jpayne@69
|
5631 ** These functions are [deprecated]. In order to maintain
|
|
jpayne@69
|
5632 ** backwards compatibility with older code, these functions continue
|
|
jpayne@69
|
5633 ** to be supported. However, new applications should avoid
|
|
jpayne@69
|
5634 ** the use of these functions. To encourage programmers to avoid
|
|
jpayne@69
|
5635 ** these functions, we will not explain what they do.
|
|
jpayne@69
|
5636 */
|
|
jpayne@69
|
5637 #ifndef SQLITE_OMIT_DEPRECATED
|
|
jpayne@69
|
5638 SQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*);
|
|
jpayne@69
|
5639 SQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*);
|
|
jpayne@69
|
5640 SQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*);
|
|
jpayne@69
|
5641 SQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void);
|
|
jpayne@69
|
5642 SQLITE_API SQLITE_DEPRECATED void sqlite3_thread_cleanup(void);
|
|
jpayne@69
|
5643 SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),
|
|
jpayne@69
|
5644 void*,sqlite3_int64);
|
|
jpayne@69
|
5645 #endif
|
|
jpayne@69
|
5646
|
|
jpayne@69
|
5647 /*
|
|
jpayne@69
|
5648 ** CAPI3REF: Obtaining SQL Values
|
|
jpayne@69
|
5649 ** METHOD: sqlite3_value
|
|
jpayne@69
|
5650 **
|
|
jpayne@69
|
5651 ** <b>Summary:</b>
|
|
jpayne@69
|
5652 ** <blockquote><table border=0 cellpadding=0 cellspacing=0>
|
|
jpayne@69
|
5653 ** <tr><td><b>sqlite3_value_blob</b><td>→<td>BLOB value
|
|
jpayne@69
|
5654 ** <tr><td><b>sqlite3_value_double</b><td>→<td>REAL value
|
|
jpayne@69
|
5655 ** <tr><td><b>sqlite3_value_int</b><td>→<td>32-bit INTEGER value
|
|
jpayne@69
|
5656 ** <tr><td><b>sqlite3_value_int64</b><td>→<td>64-bit INTEGER value
|
|
jpayne@69
|
5657 ** <tr><td><b>sqlite3_value_pointer</b><td>→<td>Pointer value
|
|
jpayne@69
|
5658 ** <tr><td><b>sqlite3_value_text</b><td>→<td>UTF-8 TEXT value
|
|
jpayne@69
|
5659 ** <tr><td><b>sqlite3_value_text16</b><td>→<td>UTF-16 TEXT value in
|
|
jpayne@69
|
5660 ** the native byteorder
|
|
jpayne@69
|
5661 ** <tr><td><b>sqlite3_value_text16be</b><td>→<td>UTF-16be TEXT value
|
|
jpayne@69
|
5662 ** <tr><td><b>sqlite3_value_text16le</b><td>→<td>UTF-16le TEXT value
|
|
jpayne@69
|
5663 ** <tr><td> <td> <td>
|
|
jpayne@69
|
5664 ** <tr><td><b>sqlite3_value_bytes</b><td>→<td>Size of a BLOB
|
|
jpayne@69
|
5665 ** or a UTF-8 TEXT in bytes
|
|
jpayne@69
|
5666 ** <tr><td><b>sqlite3_value_bytes16 </b>
|
|
jpayne@69
|
5667 ** <td>→ <td>Size of UTF-16
|
|
jpayne@69
|
5668 ** TEXT in bytes
|
|
jpayne@69
|
5669 ** <tr><td><b>sqlite3_value_type</b><td>→<td>Default
|
|
jpayne@69
|
5670 ** datatype of the value
|
|
jpayne@69
|
5671 ** <tr><td><b>sqlite3_value_numeric_type </b>
|
|
jpayne@69
|
5672 ** <td>→ <td>Best numeric datatype of the value
|
|
jpayne@69
|
5673 ** <tr><td><b>sqlite3_value_nochange </b>
|
|
jpayne@69
|
5674 ** <td>→ <td>True if the column is unchanged in an UPDATE
|
|
jpayne@69
|
5675 ** against a virtual table.
|
|
jpayne@69
|
5676 ** <tr><td><b>sqlite3_value_frombind </b>
|
|
jpayne@69
|
5677 ** <td>→ <td>True if value originated from a [bound parameter]
|
|
jpayne@69
|
5678 ** </table></blockquote>
|
|
jpayne@69
|
5679 **
|
|
jpayne@69
|
5680 ** <b>Details:</b>
|
|
jpayne@69
|
5681 **
|
|
jpayne@69
|
5682 ** These routines extract type, size, and content information from
|
|
jpayne@69
|
5683 ** [protected sqlite3_value] objects. Protected sqlite3_value objects
|
|
jpayne@69
|
5684 ** are used to pass parameter information into the functions that
|
|
jpayne@69
|
5685 ** implement [application-defined SQL functions] and [virtual tables].
|
|
jpayne@69
|
5686 **
|
|
jpayne@69
|
5687 ** These routines work only with [protected sqlite3_value] objects.
|
|
jpayne@69
|
5688 ** Any attempt to use these routines on an [unprotected sqlite3_value]
|
|
jpayne@69
|
5689 ** is not threadsafe.
|
|
jpayne@69
|
5690 **
|
|
jpayne@69
|
5691 ** ^These routines work just like the corresponding [column access functions]
|
|
jpayne@69
|
5692 ** except that these routines take a single [protected sqlite3_value] object
|
|
jpayne@69
|
5693 ** pointer instead of a [sqlite3_stmt*] pointer and an integer column number.
|
|
jpayne@69
|
5694 **
|
|
jpayne@69
|
5695 ** ^The sqlite3_value_text16() interface extracts a UTF-16 string
|
|
jpayne@69
|
5696 ** in the native byte-order of the host machine. ^The
|
|
jpayne@69
|
5697 ** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces
|
|
jpayne@69
|
5698 ** extract UTF-16 strings as big-endian and little-endian respectively.
|
|
jpayne@69
|
5699 **
|
|
jpayne@69
|
5700 ** ^If [sqlite3_value] object V was initialized
|
|
jpayne@69
|
5701 ** using [sqlite3_bind_pointer(S,I,P,X,D)] or [sqlite3_result_pointer(C,P,X,D)]
|
|
jpayne@69
|
5702 ** and if X and Y are strings that compare equal according to strcmp(X,Y),
|
|
jpayne@69
|
5703 ** then sqlite3_value_pointer(V,Y) will return the pointer P. ^Otherwise,
|
|
jpayne@69
|
5704 ** sqlite3_value_pointer(V,Y) returns a NULL. The sqlite3_bind_pointer()
|
|
jpayne@69
|
5705 ** routine is part of the [pointer passing interface] added for SQLite 3.20.0.
|
|
jpayne@69
|
5706 **
|
|
jpayne@69
|
5707 ** ^(The sqlite3_value_type(V) interface returns the
|
|
jpayne@69
|
5708 ** [SQLITE_INTEGER | datatype code] for the initial datatype of the
|
|
jpayne@69
|
5709 ** [sqlite3_value] object V. The returned value is one of [SQLITE_INTEGER],
|
|
jpayne@69
|
5710 ** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL].)^
|
|
jpayne@69
|
5711 ** Other interfaces might change the datatype for an sqlite3_value object.
|
|
jpayne@69
|
5712 ** For example, if the datatype is initially SQLITE_INTEGER and
|
|
jpayne@69
|
5713 ** sqlite3_value_text(V) is called to extract a text value for that
|
|
jpayne@69
|
5714 ** integer, then subsequent calls to sqlite3_value_type(V) might return
|
|
jpayne@69
|
5715 ** SQLITE_TEXT. Whether or not a persistent internal datatype conversion
|
|
jpayne@69
|
5716 ** occurs is undefined and may change from one release of SQLite to the next.
|
|
jpayne@69
|
5717 **
|
|
jpayne@69
|
5718 ** ^(The sqlite3_value_numeric_type() interface attempts to apply
|
|
jpayne@69
|
5719 ** numeric affinity to the value. This means that an attempt is
|
|
jpayne@69
|
5720 ** made to convert the value to an integer or floating point. If
|
|
jpayne@69
|
5721 ** such a conversion is possible without loss of information (in other
|
|
jpayne@69
|
5722 ** words, if the value is a string that looks like a number)
|
|
jpayne@69
|
5723 ** then the conversion is performed. Otherwise no conversion occurs.
|
|
jpayne@69
|
5724 ** The [SQLITE_INTEGER | datatype] after conversion is returned.)^
|
|
jpayne@69
|
5725 **
|
|
jpayne@69
|
5726 ** ^Within the [xUpdate] method of a [virtual table], the
|
|
jpayne@69
|
5727 ** sqlite3_value_nochange(X) interface returns true if and only if
|
|
jpayne@69
|
5728 ** the column corresponding to X is unchanged by the UPDATE operation
|
|
jpayne@69
|
5729 ** that the xUpdate method call was invoked to implement and if
|
|
jpayne@69
|
5730 ** and the prior [xColumn] method call that was invoked to extracted
|
|
jpayne@69
|
5731 ** the value for that column returned without setting a result (probably
|
|
jpayne@69
|
5732 ** because it queried [sqlite3_vtab_nochange()] and found that the column
|
|
jpayne@69
|
5733 ** was unchanging). ^Within an [xUpdate] method, any value for which
|
|
jpayne@69
|
5734 ** sqlite3_value_nochange(X) is true will in all other respects appear
|
|
jpayne@69
|
5735 ** to be a NULL value. If sqlite3_value_nochange(X) is invoked anywhere other
|
|
jpayne@69
|
5736 ** than within an [xUpdate] method call for an UPDATE statement, then
|
|
jpayne@69
|
5737 ** the return value is arbitrary and meaningless.
|
|
jpayne@69
|
5738 **
|
|
jpayne@69
|
5739 ** ^The sqlite3_value_frombind(X) interface returns non-zero if the
|
|
jpayne@69
|
5740 ** value X originated from one of the [sqlite3_bind_int|sqlite3_bind()]
|
|
jpayne@69
|
5741 ** interfaces. ^If X comes from an SQL literal value, or a table column,
|
|
jpayne@69
|
5742 ** or an expression, then sqlite3_value_frombind(X) returns zero.
|
|
jpayne@69
|
5743 **
|
|
jpayne@69
|
5744 ** Please pay particular attention to the fact that the pointer returned
|
|
jpayne@69
|
5745 ** from [sqlite3_value_blob()], [sqlite3_value_text()], or
|
|
jpayne@69
|
5746 ** [sqlite3_value_text16()] can be invalidated by a subsequent call to
|
|
jpayne@69
|
5747 ** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()],
|
|
jpayne@69
|
5748 ** or [sqlite3_value_text16()].
|
|
jpayne@69
|
5749 **
|
|
jpayne@69
|
5750 ** These routines must be called from the same thread as
|
|
jpayne@69
|
5751 ** the SQL function that supplied the [sqlite3_value*] parameters.
|
|
jpayne@69
|
5752 **
|
|
jpayne@69
|
5753 ** As long as the input parameter is correct, these routines can only
|
|
jpayne@69
|
5754 ** fail if an out-of-memory error occurs during a format conversion.
|
|
jpayne@69
|
5755 ** Only the following subset of interfaces are subject to out-of-memory
|
|
jpayne@69
|
5756 ** errors:
|
|
jpayne@69
|
5757 **
|
|
jpayne@69
|
5758 ** <ul>
|
|
jpayne@69
|
5759 ** <li> sqlite3_value_blob()
|
|
jpayne@69
|
5760 ** <li> sqlite3_value_text()
|
|
jpayne@69
|
5761 ** <li> sqlite3_value_text16()
|
|
jpayne@69
|
5762 ** <li> sqlite3_value_text16le()
|
|
jpayne@69
|
5763 ** <li> sqlite3_value_text16be()
|
|
jpayne@69
|
5764 ** <li> sqlite3_value_bytes()
|
|
jpayne@69
|
5765 ** <li> sqlite3_value_bytes16()
|
|
jpayne@69
|
5766 ** </ul>
|
|
jpayne@69
|
5767 **
|
|
jpayne@69
|
5768 ** If an out-of-memory error occurs, then the return value from these
|
|
jpayne@69
|
5769 ** routines is the same as if the column had contained an SQL NULL value.
|
|
jpayne@69
|
5770 ** Valid SQL NULL returns can be distinguished from out-of-memory errors
|
|
jpayne@69
|
5771 ** by invoking the [sqlite3_errcode()] immediately after the suspect
|
|
jpayne@69
|
5772 ** return value is obtained and before any
|
|
jpayne@69
|
5773 ** other SQLite interface is called on the same [database connection].
|
|
jpayne@69
|
5774 */
|
|
jpayne@69
|
5775 SQLITE_API const void *sqlite3_value_blob(sqlite3_value*);
|
|
jpayne@69
|
5776 SQLITE_API double sqlite3_value_double(sqlite3_value*);
|
|
jpayne@69
|
5777 SQLITE_API int sqlite3_value_int(sqlite3_value*);
|
|
jpayne@69
|
5778 SQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value*);
|
|
jpayne@69
|
5779 SQLITE_API void *sqlite3_value_pointer(sqlite3_value*, const char*);
|
|
jpayne@69
|
5780 SQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value*);
|
|
jpayne@69
|
5781 SQLITE_API const void *sqlite3_value_text16(sqlite3_value*);
|
|
jpayne@69
|
5782 SQLITE_API const void *sqlite3_value_text16le(sqlite3_value*);
|
|
jpayne@69
|
5783 SQLITE_API const void *sqlite3_value_text16be(sqlite3_value*);
|
|
jpayne@69
|
5784 SQLITE_API int sqlite3_value_bytes(sqlite3_value*);
|
|
jpayne@69
|
5785 SQLITE_API int sqlite3_value_bytes16(sqlite3_value*);
|
|
jpayne@69
|
5786 SQLITE_API int sqlite3_value_type(sqlite3_value*);
|
|
jpayne@69
|
5787 SQLITE_API int sqlite3_value_numeric_type(sqlite3_value*);
|
|
jpayne@69
|
5788 SQLITE_API int sqlite3_value_nochange(sqlite3_value*);
|
|
jpayne@69
|
5789 SQLITE_API int sqlite3_value_frombind(sqlite3_value*);
|
|
jpayne@69
|
5790
|
|
jpayne@69
|
5791 /*
|
|
jpayne@69
|
5792 ** CAPI3REF: Report the internal text encoding state of an sqlite3_value object
|
|
jpayne@69
|
5793 ** METHOD: sqlite3_value
|
|
jpayne@69
|
5794 **
|
|
jpayne@69
|
5795 ** ^(The sqlite3_value_encoding(X) interface returns one of [SQLITE_UTF8],
|
|
jpayne@69
|
5796 ** [SQLITE_UTF16BE], or [SQLITE_UTF16LE] according to the current text encoding
|
|
jpayne@69
|
5797 ** of the value X, assuming that X has type TEXT.)^ If sqlite3_value_type(X)
|
|
jpayne@69
|
5798 ** returns something other than SQLITE_TEXT, then the return value from
|
|
jpayne@69
|
5799 ** sqlite3_value_encoding(X) is meaningless. ^Calls to
|
|
jpayne@69
|
5800 ** [sqlite3_value_text(X)], [sqlite3_value_text16(X)], [sqlite3_value_text16be(X)],
|
|
jpayne@69
|
5801 ** [sqlite3_value_text16le(X)], [sqlite3_value_bytes(X)], or
|
|
jpayne@69
|
5802 ** [sqlite3_value_bytes16(X)] might change the encoding of the value X and
|
|
jpayne@69
|
5803 ** thus change the return from subsequent calls to sqlite3_value_encoding(X).
|
|
jpayne@69
|
5804 **
|
|
jpayne@69
|
5805 ** This routine is intended for used by applications that test and validate
|
|
jpayne@69
|
5806 ** the SQLite implementation. This routine is inquiring about the opaque
|
|
jpayne@69
|
5807 ** internal state of an [sqlite3_value] object. Ordinary applications should
|
|
jpayne@69
|
5808 ** not need to know what the internal state of an sqlite3_value object is and
|
|
jpayne@69
|
5809 ** hence should not need to use this interface.
|
|
jpayne@69
|
5810 */
|
|
jpayne@69
|
5811 SQLITE_API int sqlite3_value_encoding(sqlite3_value*);
|
|
jpayne@69
|
5812
|
|
jpayne@69
|
5813 /*
|
|
jpayne@69
|
5814 ** CAPI3REF: Finding The Subtype Of SQL Values
|
|
jpayne@69
|
5815 ** METHOD: sqlite3_value
|
|
jpayne@69
|
5816 **
|
|
jpayne@69
|
5817 ** The sqlite3_value_subtype(V) function returns the subtype for
|
|
jpayne@69
|
5818 ** an [application-defined SQL function] argument V. The subtype
|
|
jpayne@69
|
5819 ** information can be used to pass a limited amount of context from
|
|
jpayne@69
|
5820 ** one SQL function to another. Use the [sqlite3_result_subtype()]
|
|
jpayne@69
|
5821 ** routine to set the subtype for the return value of an SQL function.
|
|
jpayne@69
|
5822 **
|
|
jpayne@69
|
5823 ** Every [application-defined SQL function] that invoke this interface
|
|
jpayne@69
|
5824 ** should include the [SQLITE_SUBTYPE] property in the text
|
|
jpayne@69
|
5825 ** encoding argument when the function is [sqlite3_create_function|registered].
|
|
jpayne@69
|
5826 ** If the [SQLITE_SUBTYPE] property is omitted, then sqlite3_value_subtype()
|
|
jpayne@69
|
5827 ** might return zero instead of the upstream subtype in some corner cases.
|
|
jpayne@69
|
5828 */
|
|
jpayne@69
|
5829 SQLITE_API unsigned int sqlite3_value_subtype(sqlite3_value*);
|
|
jpayne@69
|
5830
|
|
jpayne@69
|
5831 /*
|
|
jpayne@69
|
5832 ** CAPI3REF: Copy And Free SQL Values
|
|
jpayne@69
|
5833 ** METHOD: sqlite3_value
|
|
jpayne@69
|
5834 **
|
|
jpayne@69
|
5835 ** ^The sqlite3_value_dup(V) interface makes a copy of the [sqlite3_value]
|
|
jpayne@69
|
5836 ** object D and returns a pointer to that copy. ^The [sqlite3_value] returned
|
|
jpayne@69
|
5837 ** is a [protected sqlite3_value] object even if the input is not.
|
|
jpayne@69
|
5838 ** ^The sqlite3_value_dup(V) interface returns NULL if V is NULL or if a
|
|
jpayne@69
|
5839 ** memory allocation fails. ^If V is a [pointer value], then the result
|
|
jpayne@69
|
5840 ** of sqlite3_value_dup(V) is a NULL value.
|
|
jpayne@69
|
5841 **
|
|
jpayne@69
|
5842 ** ^The sqlite3_value_free(V) interface frees an [sqlite3_value] object
|
|
jpayne@69
|
5843 ** previously obtained from [sqlite3_value_dup()]. ^If V is a NULL pointer
|
|
jpayne@69
|
5844 ** then sqlite3_value_free(V) is a harmless no-op.
|
|
jpayne@69
|
5845 */
|
|
jpayne@69
|
5846 SQLITE_API sqlite3_value *sqlite3_value_dup(const sqlite3_value*);
|
|
jpayne@69
|
5847 SQLITE_API void sqlite3_value_free(sqlite3_value*);
|
|
jpayne@69
|
5848
|
|
jpayne@69
|
5849 /*
|
|
jpayne@69
|
5850 ** CAPI3REF: Obtain Aggregate Function Context
|
|
jpayne@69
|
5851 ** METHOD: sqlite3_context
|
|
jpayne@69
|
5852 **
|
|
jpayne@69
|
5853 ** Implementations of aggregate SQL functions use this
|
|
jpayne@69
|
5854 ** routine to allocate memory for storing their state.
|
|
jpayne@69
|
5855 **
|
|
jpayne@69
|
5856 ** ^The first time the sqlite3_aggregate_context(C,N) routine is called
|
|
jpayne@69
|
5857 ** for a particular aggregate function, SQLite allocates
|
|
jpayne@69
|
5858 ** N bytes of memory, zeroes out that memory, and returns a pointer
|
|
jpayne@69
|
5859 ** to the new memory. ^On second and subsequent calls to
|
|
jpayne@69
|
5860 ** sqlite3_aggregate_context() for the same aggregate function instance,
|
|
jpayne@69
|
5861 ** the same buffer is returned. Sqlite3_aggregate_context() is normally
|
|
jpayne@69
|
5862 ** called once for each invocation of the xStep callback and then one
|
|
jpayne@69
|
5863 ** last time when the xFinal callback is invoked. ^(When no rows match
|
|
jpayne@69
|
5864 ** an aggregate query, the xStep() callback of the aggregate function
|
|
jpayne@69
|
5865 ** implementation is never called and xFinal() is called exactly once.
|
|
jpayne@69
|
5866 ** In those cases, sqlite3_aggregate_context() might be called for the
|
|
jpayne@69
|
5867 ** first time from within xFinal().)^
|
|
jpayne@69
|
5868 **
|
|
jpayne@69
|
5869 ** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer
|
|
jpayne@69
|
5870 ** when first called if N is less than or equal to zero or if a memory
|
|
jpayne@69
|
5871 ** allocation error occurs.
|
|
jpayne@69
|
5872 **
|
|
jpayne@69
|
5873 ** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is
|
|
jpayne@69
|
5874 ** determined by the N parameter on first successful call. Changing the
|
|
jpayne@69
|
5875 ** value of N in any subsequent call to sqlite3_aggregate_context() within
|
|
jpayne@69
|
5876 ** the same aggregate function instance will not resize the memory
|
|
jpayne@69
|
5877 ** allocation.)^ Within the xFinal callback, it is customary to set
|
|
jpayne@69
|
5878 ** N=0 in calls to sqlite3_aggregate_context(C,N) so that no
|
|
jpayne@69
|
5879 ** pointless memory allocations occur.
|
|
jpayne@69
|
5880 **
|
|
jpayne@69
|
5881 ** ^SQLite automatically frees the memory allocated by
|
|
jpayne@69
|
5882 ** sqlite3_aggregate_context() when the aggregate query concludes.
|
|
jpayne@69
|
5883 **
|
|
jpayne@69
|
5884 ** The first parameter must be a copy of the
|
|
jpayne@69
|
5885 ** [sqlite3_context | SQL function context] that is the first parameter
|
|
jpayne@69
|
5886 ** to the xStep or xFinal callback routine that implements the aggregate
|
|
jpayne@69
|
5887 ** function.
|
|
jpayne@69
|
5888 **
|
|
jpayne@69
|
5889 ** This routine must be called from the same thread in which
|
|
jpayne@69
|
5890 ** the aggregate SQL function is running.
|
|
jpayne@69
|
5891 */
|
|
jpayne@69
|
5892 SQLITE_API void *sqlite3_aggregate_context(sqlite3_context*, int nBytes);
|
|
jpayne@69
|
5893
|
|
jpayne@69
|
5894 /*
|
|
jpayne@69
|
5895 ** CAPI3REF: User Data For Functions
|
|
jpayne@69
|
5896 ** METHOD: sqlite3_context
|
|
jpayne@69
|
5897 **
|
|
jpayne@69
|
5898 ** ^The sqlite3_user_data() interface returns a copy of
|
|
jpayne@69
|
5899 ** the pointer that was the pUserData parameter (the 5th parameter)
|
|
jpayne@69
|
5900 ** of the [sqlite3_create_function()]
|
|
jpayne@69
|
5901 ** and [sqlite3_create_function16()] routines that originally
|
|
jpayne@69
|
5902 ** registered the application defined function.
|
|
jpayne@69
|
5903 **
|
|
jpayne@69
|
5904 ** This routine must be called from the same thread in which
|
|
jpayne@69
|
5905 ** the application-defined function is running.
|
|
jpayne@69
|
5906 */
|
|
jpayne@69
|
5907 SQLITE_API void *sqlite3_user_data(sqlite3_context*);
|
|
jpayne@69
|
5908
|
|
jpayne@69
|
5909 /*
|
|
jpayne@69
|
5910 ** CAPI3REF: Database Connection For Functions
|
|
jpayne@69
|
5911 ** METHOD: sqlite3_context
|
|
jpayne@69
|
5912 **
|
|
jpayne@69
|
5913 ** ^The sqlite3_context_db_handle() interface returns a copy of
|
|
jpayne@69
|
5914 ** the pointer to the [database connection] (the 1st parameter)
|
|
jpayne@69
|
5915 ** of the [sqlite3_create_function()]
|
|
jpayne@69
|
5916 ** and [sqlite3_create_function16()] routines that originally
|
|
jpayne@69
|
5917 ** registered the application defined function.
|
|
jpayne@69
|
5918 */
|
|
jpayne@69
|
5919 SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_context*);
|
|
jpayne@69
|
5920
|
|
jpayne@69
|
5921 /*
|
|
jpayne@69
|
5922 ** CAPI3REF: Function Auxiliary Data
|
|
jpayne@69
|
5923 ** METHOD: sqlite3_context
|
|
jpayne@69
|
5924 **
|
|
jpayne@69
|
5925 ** These functions may be used by (non-aggregate) SQL functions to
|
|
jpayne@69
|
5926 ** associate auxiliary data with argument values. If the same argument
|
|
jpayne@69
|
5927 ** value is passed to multiple invocations of the same SQL function during
|
|
jpayne@69
|
5928 ** query execution, under some circumstances the associated auxiliary data
|
|
jpayne@69
|
5929 ** might be preserved. An example of where this might be useful is in a
|
|
jpayne@69
|
5930 ** regular-expression matching function. The compiled version of the regular
|
|
jpayne@69
|
5931 ** expression can be stored as auxiliary data associated with the pattern string.
|
|
jpayne@69
|
5932 ** Then as long as the pattern string remains the same,
|
|
jpayne@69
|
5933 ** the compiled regular expression can be reused on multiple
|
|
jpayne@69
|
5934 ** invocations of the same function.
|
|
jpayne@69
|
5935 **
|
|
jpayne@69
|
5936 ** ^The sqlite3_get_auxdata(C,N) interface returns a pointer to the auxiliary data
|
|
jpayne@69
|
5937 ** associated by the sqlite3_set_auxdata(C,N,P,X) function with the Nth argument
|
|
jpayne@69
|
5938 ** value to the application-defined function. ^N is zero for the left-most
|
|
jpayne@69
|
5939 ** function argument. ^If there is no auxiliary data
|
|
jpayne@69
|
5940 ** associated with the function argument, the sqlite3_get_auxdata(C,N) interface
|
|
jpayne@69
|
5941 ** returns a NULL pointer.
|
|
jpayne@69
|
5942 **
|
|
jpayne@69
|
5943 ** ^The sqlite3_set_auxdata(C,N,P,X) interface saves P as auxiliary data for the
|
|
jpayne@69
|
5944 ** N-th argument of the application-defined function. ^Subsequent
|
|
jpayne@69
|
5945 ** calls to sqlite3_get_auxdata(C,N) return P from the most recent
|
|
jpayne@69
|
5946 ** sqlite3_set_auxdata(C,N,P,X) call if the auxiliary data is still valid or
|
|
jpayne@69
|
5947 ** NULL if the auxiliary data has been discarded.
|
|
jpayne@69
|
5948 ** ^After each call to sqlite3_set_auxdata(C,N,P,X) where X is not NULL,
|
|
jpayne@69
|
5949 ** SQLite will invoke the destructor function X with parameter P exactly
|
|
jpayne@69
|
5950 ** once, when the auxiliary data is discarded.
|
|
jpayne@69
|
5951 ** SQLite is free to discard the auxiliary data at any time, including: <ul>
|
|
jpayne@69
|
5952 ** <li> ^(when the corresponding function parameter changes)^, or
|
|
jpayne@69
|
5953 ** <li> ^(when [sqlite3_reset()] or [sqlite3_finalize()] is called for the
|
|
jpayne@69
|
5954 ** SQL statement)^, or
|
|
jpayne@69
|
5955 ** <li> ^(when sqlite3_set_auxdata() is invoked again on the same
|
|
jpayne@69
|
5956 ** parameter)^, or
|
|
jpayne@69
|
5957 ** <li> ^(during the original sqlite3_set_auxdata() call when a memory
|
|
jpayne@69
|
5958 ** allocation error occurs.)^
|
|
jpayne@69
|
5959 ** <li> ^(during the original sqlite3_set_auxdata() call if the function
|
|
jpayne@69
|
5960 ** is evaluated during query planning instead of during query execution,
|
|
jpayne@69
|
5961 ** as sometimes happens with [SQLITE_ENABLE_STAT4].)^ </ul>
|
|
jpayne@69
|
5962 **
|
|
jpayne@69
|
5963 ** Note the last two bullets in particular. The destructor X in
|
|
jpayne@69
|
5964 ** sqlite3_set_auxdata(C,N,P,X) might be called immediately, before the
|
|
jpayne@69
|
5965 ** sqlite3_set_auxdata() interface even returns. Hence sqlite3_set_auxdata()
|
|
jpayne@69
|
5966 ** should be called near the end of the function implementation and the
|
|
jpayne@69
|
5967 ** function implementation should not make any use of P after
|
|
jpayne@69
|
5968 ** sqlite3_set_auxdata() has been called. Furthermore, a call to
|
|
jpayne@69
|
5969 ** sqlite3_get_auxdata() that occurs immediately after a corresponding call
|
|
jpayne@69
|
5970 ** to sqlite3_set_auxdata() might still return NULL if an out-of-memory
|
|
jpayne@69
|
5971 ** condition occurred during the sqlite3_set_auxdata() call or if the
|
|
jpayne@69
|
5972 ** function is being evaluated during query planning rather than during
|
|
jpayne@69
|
5973 ** query execution.
|
|
jpayne@69
|
5974 **
|
|
jpayne@69
|
5975 ** ^(In practice, auxiliary data is preserved between function calls for
|
|
jpayne@69
|
5976 ** function parameters that are compile-time constants, including literal
|
|
jpayne@69
|
5977 ** values and [parameters] and expressions composed from the same.)^
|
|
jpayne@69
|
5978 **
|
|
jpayne@69
|
5979 ** The value of the N parameter to these interfaces should be non-negative.
|
|
jpayne@69
|
5980 ** Future enhancements may make use of negative N values to define new
|
|
jpayne@69
|
5981 ** kinds of function caching behavior.
|
|
jpayne@69
|
5982 **
|
|
jpayne@69
|
5983 ** These routines must be called from the same thread in which
|
|
jpayne@69
|
5984 ** the SQL function is running.
|
|
jpayne@69
|
5985 **
|
|
jpayne@69
|
5986 ** See also: [sqlite3_get_clientdata()] and [sqlite3_set_clientdata()].
|
|
jpayne@69
|
5987 */
|
|
jpayne@69
|
5988 SQLITE_API void *sqlite3_get_auxdata(sqlite3_context*, int N);
|
|
jpayne@69
|
5989 SQLITE_API void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*));
|
|
jpayne@69
|
5990
|
|
jpayne@69
|
5991 /*
|
|
jpayne@69
|
5992 ** CAPI3REF: Database Connection Client Data
|
|
jpayne@69
|
5993 ** METHOD: sqlite3
|
|
jpayne@69
|
5994 **
|
|
jpayne@69
|
5995 ** These functions are used to associate one or more named pointers
|
|
jpayne@69
|
5996 ** with a [database connection].
|
|
jpayne@69
|
5997 ** A call to sqlite3_set_clientdata(D,N,P,X) causes the pointer P
|
|
jpayne@69
|
5998 ** to be attached to [database connection] D using name N. Subsequent
|
|
jpayne@69
|
5999 ** calls to sqlite3_get_clientdata(D,N) will return a copy of pointer P
|
|
jpayne@69
|
6000 ** or a NULL pointer if there were no prior calls to
|
|
jpayne@69
|
6001 ** sqlite3_set_clientdata() with the same values of D and N.
|
|
jpayne@69
|
6002 ** Names are compared using strcmp() and are thus case sensitive.
|
|
jpayne@69
|
6003 **
|
|
jpayne@69
|
6004 ** If P and X are both non-NULL, then the destructor X is invoked with
|
|
jpayne@69
|
6005 ** argument P on the first of the following occurrences:
|
|
jpayne@69
|
6006 ** <ul>
|
|
jpayne@69
|
6007 ** <li> An out-of-memory error occurs during the call to
|
|
jpayne@69
|
6008 ** sqlite3_set_clientdata() which attempts to register pointer P.
|
|
jpayne@69
|
6009 ** <li> A subsequent call to sqlite3_set_clientdata(D,N,P,X) is made
|
|
jpayne@69
|
6010 ** with the same D and N parameters.
|
|
jpayne@69
|
6011 ** <li> The database connection closes. SQLite does not make any guarantees
|
|
jpayne@69
|
6012 ** about the order in which destructors are called, only that all
|
|
jpayne@69
|
6013 ** destructors will be called exactly once at some point during the
|
|
jpayne@69
|
6014 ** database connection closing process.
|
|
jpayne@69
|
6015 ** </ul>
|
|
jpayne@69
|
6016 **
|
|
jpayne@69
|
6017 ** SQLite does not do anything with client data other than invoke
|
|
jpayne@69
|
6018 ** destructors on the client data at the appropriate time. The intended
|
|
jpayne@69
|
6019 ** use for client data is to provide a mechanism for wrapper libraries
|
|
jpayne@69
|
6020 ** to store additional information about an SQLite database connection.
|
|
jpayne@69
|
6021 **
|
|
jpayne@69
|
6022 ** There is no limit (other than available memory) on the number of different
|
|
jpayne@69
|
6023 ** client data pointers (with different names) that can be attached to a
|
|
jpayne@69
|
6024 ** single database connection. However, the implementation is optimized
|
|
jpayne@69
|
6025 ** for the case of having only one or two different client data names.
|
|
jpayne@69
|
6026 ** Applications and wrapper libraries are discouraged from using more than
|
|
jpayne@69
|
6027 ** one client data name each.
|
|
jpayne@69
|
6028 **
|
|
jpayne@69
|
6029 ** There is no way to enumerate the client data pointers
|
|
jpayne@69
|
6030 ** associated with a database connection. The N parameter can be thought
|
|
jpayne@69
|
6031 ** of as a secret key such that only code that knows the secret key is able
|
|
jpayne@69
|
6032 ** to access the associated data.
|
|
jpayne@69
|
6033 **
|
|
jpayne@69
|
6034 ** Security Warning: These interfaces should not be exposed in scripting
|
|
jpayne@69
|
6035 ** languages or in other circumstances where it might be possible for an
|
|
jpayne@69
|
6036 ** an attacker to invoke them. Any agent that can invoke these interfaces
|
|
jpayne@69
|
6037 ** can probably also take control of the process.
|
|
jpayne@69
|
6038 **
|
|
jpayne@69
|
6039 ** Database connection client data is only available for SQLite
|
|
jpayne@69
|
6040 ** version 3.44.0 ([dateof:3.44.0]) and later.
|
|
jpayne@69
|
6041 **
|
|
jpayne@69
|
6042 ** See also: [sqlite3_set_auxdata()] and [sqlite3_get_auxdata()].
|
|
jpayne@69
|
6043 */
|
|
jpayne@69
|
6044 SQLITE_API void *sqlite3_get_clientdata(sqlite3*,const char*);
|
|
jpayne@69
|
6045 SQLITE_API int sqlite3_set_clientdata(sqlite3*, const char*, void*, void(*)(void*));
|
|
jpayne@69
|
6046
|
|
jpayne@69
|
6047 /*
|
|
jpayne@69
|
6048 ** CAPI3REF: Constants Defining Special Destructor Behavior
|
|
jpayne@69
|
6049 **
|
|
jpayne@69
|
6050 ** These are special values for the destructor that is passed in as the
|
|
jpayne@69
|
6051 ** final argument to routines like [sqlite3_result_blob()]. ^If the destructor
|
|
jpayne@69
|
6052 ** argument is SQLITE_STATIC, it means that the content pointer is constant
|
|
jpayne@69
|
6053 ** and will never change. It does not need to be destroyed. ^The
|
|
jpayne@69
|
6054 ** SQLITE_TRANSIENT value means that the content will likely change in
|
|
jpayne@69
|
6055 ** the near future and that SQLite should make its own private copy of
|
|
jpayne@69
|
6056 ** the content before returning.
|
|
jpayne@69
|
6057 **
|
|
jpayne@69
|
6058 ** The typedef is necessary to work around problems in certain
|
|
jpayne@69
|
6059 ** C++ compilers.
|
|
jpayne@69
|
6060 */
|
|
jpayne@69
|
6061 typedef void (*sqlite3_destructor_type)(void*);
|
|
jpayne@69
|
6062 #define SQLITE_STATIC ((sqlite3_destructor_type)0)
|
|
jpayne@69
|
6063 #define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1)
|
|
jpayne@69
|
6064
|
|
jpayne@69
|
6065 /*
|
|
jpayne@69
|
6066 ** CAPI3REF: Setting The Result Of An SQL Function
|
|
jpayne@69
|
6067 ** METHOD: sqlite3_context
|
|
jpayne@69
|
6068 **
|
|
jpayne@69
|
6069 ** These routines are used by the xFunc or xFinal callbacks that
|
|
jpayne@69
|
6070 ** implement SQL functions and aggregates. See
|
|
jpayne@69
|
6071 ** [sqlite3_create_function()] and [sqlite3_create_function16()]
|
|
jpayne@69
|
6072 ** for additional information.
|
|
jpayne@69
|
6073 **
|
|
jpayne@69
|
6074 ** These functions work very much like the [parameter binding] family of
|
|
jpayne@69
|
6075 ** functions used to bind values to host parameters in prepared statements.
|
|
jpayne@69
|
6076 ** Refer to the [SQL parameter] documentation for additional information.
|
|
jpayne@69
|
6077 **
|
|
jpayne@69
|
6078 ** ^The sqlite3_result_blob() interface sets the result from
|
|
jpayne@69
|
6079 ** an application-defined function to be the BLOB whose content is pointed
|
|
jpayne@69
|
6080 ** to by the second parameter and which is N bytes long where N is the
|
|
jpayne@69
|
6081 ** third parameter.
|
|
jpayne@69
|
6082 **
|
|
jpayne@69
|
6083 ** ^The sqlite3_result_zeroblob(C,N) and sqlite3_result_zeroblob64(C,N)
|
|
jpayne@69
|
6084 ** interfaces set the result of the application-defined function to be
|
|
jpayne@69
|
6085 ** a BLOB containing all zero bytes and N bytes in size.
|
|
jpayne@69
|
6086 **
|
|
jpayne@69
|
6087 ** ^The sqlite3_result_double() interface sets the result from
|
|
jpayne@69
|
6088 ** an application-defined function to be a floating point value specified
|
|
jpayne@69
|
6089 ** by its 2nd argument.
|
|
jpayne@69
|
6090 **
|
|
jpayne@69
|
6091 ** ^The sqlite3_result_error() and sqlite3_result_error16() functions
|
|
jpayne@69
|
6092 ** cause the implemented SQL function to throw an exception.
|
|
jpayne@69
|
6093 ** ^SQLite uses the string pointed to by the
|
|
jpayne@69
|
6094 ** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16()
|
|
jpayne@69
|
6095 ** as the text of an error message. ^SQLite interprets the error
|
|
jpayne@69
|
6096 ** message string from sqlite3_result_error() as UTF-8. ^SQLite
|
|
jpayne@69
|
6097 ** interprets the string from sqlite3_result_error16() as UTF-16 using
|
|
jpayne@69
|
6098 ** the same [byte-order determination rules] as [sqlite3_bind_text16()].
|
|
jpayne@69
|
6099 ** ^If the third parameter to sqlite3_result_error()
|
|
jpayne@69
|
6100 ** or sqlite3_result_error16() is negative then SQLite takes as the error
|
|
jpayne@69
|
6101 ** message all text up through the first zero character.
|
|
jpayne@69
|
6102 ** ^If the third parameter to sqlite3_result_error() or
|
|
jpayne@69
|
6103 ** sqlite3_result_error16() is non-negative then SQLite takes that many
|
|
jpayne@69
|
6104 ** bytes (not characters) from the 2nd parameter as the error message.
|
|
jpayne@69
|
6105 ** ^The sqlite3_result_error() and sqlite3_result_error16()
|
|
jpayne@69
|
6106 ** routines make a private copy of the error message text before
|
|
jpayne@69
|
6107 ** they return. Hence, the calling function can deallocate or
|
|
jpayne@69
|
6108 ** modify the text after they return without harm.
|
|
jpayne@69
|
6109 ** ^The sqlite3_result_error_code() function changes the error code
|
|
jpayne@69
|
6110 ** returned by SQLite as a result of an error in a function. ^By default,
|
|
jpayne@69
|
6111 ** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error()
|
|
jpayne@69
|
6112 ** or sqlite3_result_error16() resets the error code to SQLITE_ERROR.
|
|
jpayne@69
|
6113 **
|
|
jpayne@69
|
6114 ** ^The sqlite3_result_error_toobig() interface causes SQLite to throw an
|
|
jpayne@69
|
6115 ** error indicating that a string or BLOB is too long to represent.
|
|
jpayne@69
|
6116 **
|
|
jpayne@69
|
6117 ** ^The sqlite3_result_error_nomem() interface causes SQLite to throw an
|
|
jpayne@69
|
6118 ** error indicating that a memory allocation failed.
|
|
jpayne@69
|
6119 **
|
|
jpayne@69
|
6120 ** ^The sqlite3_result_int() interface sets the return value
|
|
jpayne@69
|
6121 ** of the application-defined function to be the 32-bit signed integer
|
|
jpayne@69
|
6122 ** value given in the 2nd argument.
|
|
jpayne@69
|
6123 ** ^The sqlite3_result_int64() interface sets the return value
|
|
jpayne@69
|
6124 ** of the application-defined function to be the 64-bit signed integer
|
|
jpayne@69
|
6125 ** value given in the 2nd argument.
|
|
jpayne@69
|
6126 **
|
|
jpayne@69
|
6127 ** ^The sqlite3_result_null() interface sets the return value
|
|
jpayne@69
|
6128 ** of the application-defined function to be NULL.
|
|
jpayne@69
|
6129 **
|
|
jpayne@69
|
6130 ** ^The sqlite3_result_text(), sqlite3_result_text16(),
|
|
jpayne@69
|
6131 ** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces
|
|
jpayne@69
|
6132 ** set the return value of the application-defined function to be
|
|
jpayne@69
|
6133 ** a text string which is represented as UTF-8, UTF-16 native byte order,
|
|
jpayne@69
|
6134 ** UTF-16 little endian, or UTF-16 big endian, respectively.
|
|
jpayne@69
|
6135 ** ^The sqlite3_result_text64() interface sets the return value of an
|
|
jpayne@69
|
6136 ** application-defined function to be a text string in an encoding
|
|
jpayne@69
|
6137 ** specified by the fifth (and last) parameter, which must be one
|
|
jpayne@69
|
6138 ** of [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE].
|
|
jpayne@69
|
6139 ** ^SQLite takes the text result from the application from
|
|
jpayne@69
|
6140 ** the 2nd parameter of the sqlite3_result_text* interfaces.
|
|
jpayne@69
|
6141 ** ^If the 3rd parameter to any of the sqlite3_result_text* interfaces
|
|
jpayne@69
|
6142 ** other than sqlite3_result_text64() is negative, then SQLite computes
|
|
jpayne@69
|
6143 ** the string length itself by searching the 2nd parameter for the first
|
|
jpayne@69
|
6144 ** zero character.
|
|
jpayne@69
|
6145 ** ^If the 3rd parameter to the sqlite3_result_text* interfaces
|
|
jpayne@69
|
6146 ** is non-negative, then as many bytes (not characters) of the text
|
|
jpayne@69
|
6147 ** pointed to by the 2nd parameter are taken as the application-defined
|
|
jpayne@69
|
6148 ** function result. If the 3rd parameter is non-negative, then it
|
|
jpayne@69
|
6149 ** must be the byte offset into the string where the NUL terminator would
|
|
jpayne@69
|
6150 ** appear if the string where NUL terminated. If any NUL characters occur
|
|
jpayne@69
|
6151 ** in the string at a byte offset that is less than the value of the 3rd
|
|
jpayne@69
|
6152 ** parameter, then the resulting string will contain embedded NULs and the
|
|
jpayne@69
|
6153 ** result of expressions operating on strings with embedded NULs is undefined.
|
|
jpayne@69
|
6154 ** ^If the 4th parameter to the sqlite3_result_text* interfaces
|
|
jpayne@69
|
6155 ** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that
|
|
jpayne@69
|
6156 ** function as the destructor on the text or BLOB result when it has
|
|
jpayne@69
|
6157 ** finished using that result.
|
|
jpayne@69
|
6158 ** ^If the 4th parameter to the sqlite3_result_text* interfaces or to
|
|
jpayne@69
|
6159 ** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite
|
|
jpayne@69
|
6160 ** assumes that the text or BLOB result is in constant space and does not
|
|
jpayne@69
|
6161 ** copy the content of the parameter nor call a destructor on the content
|
|
jpayne@69
|
6162 ** when it has finished using that result.
|
|
jpayne@69
|
6163 ** ^If the 4th parameter to the sqlite3_result_text* interfaces
|
|
jpayne@69
|
6164 ** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT
|
|
jpayne@69
|
6165 ** then SQLite makes a copy of the result into space obtained
|
|
jpayne@69
|
6166 ** from [sqlite3_malloc()] before it returns.
|
|
jpayne@69
|
6167 **
|
|
jpayne@69
|
6168 ** ^For the sqlite3_result_text16(), sqlite3_result_text16le(), and
|
|
jpayne@69
|
6169 ** sqlite3_result_text16be() routines, and for sqlite3_result_text64()
|
|
jpayne@69
|
6170 ** when the encoding is not UTF8, if the input UTF16 begins with a
|
|
jpayne@69
|
6171 ** byte-order mark (BOM, U+FEFF) then the BOM is removed from the
|
|
jpayne@69
|
6172 ** string and the rest of the string is interpreted according to the
|
|
jpayne@69
|
6173 ** byte-order specified by the BOM. ^The byte-order specified by
|
|
jpayne@69
|
6174 ** the BOM at the beginning of the text overrides the byte-order
|
|
jpayne@69
|
6175 ** specified by the interface procedure. ^So, for example, if
|
|
jpayne@69
|
6176 ** sqlite3_result_text16le() is invoked with text that begins
|
|
jpayne@69
|
6177 ** with bytes 0xfe, 0xff (a big-endian byte-order mark) then the
|
|
jpayne@69
|
6178 ** first two bytes of input are skipped and the remaining input
|
|
jpayne@69
|
6179 ** is interpreted as UTF16BE text.
|
|
jpayne@69
|
6180 **
|
|
jpayne@69
|
6181 ** ^For UTF16 input text to the sqlite3_result_text16(),
|
|
jpayne@69
|
6182 ** sqlite3_result_text16be(), sqlite3_result_text16le(), and
|
|
jpayne@69
|
6183 ** sqlite3_result_text64() routines, if the text contains invalid
|
|
jpayne@69
|
6184 ** UTF16 characters, the invalid characters might be converted
|
|
jpayne@69
|
6185 ** into the unicode replacement character, U+FFFD.
|
|
jpayne@69
|
6186 **
|
|
jpayne@69
|
6187 ** ^The sqlite3_result_value() interface sets the result of
|
|
jpayne@69
|
6188 ** the application-defined function to be a copy of the
|
|
jpayne@69
|
6189 ** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The
|
|
jpayne@69
|
6190 ** sqlite3_result_value() interface makes a copy of the [sqlite3_value]
|
|
jpayne@69
|
6191 ** so that the [sqlite3_value] specified in the parameter may change or
|
|
jpayne@69
|
6192 ** be deallocated after sqlite3_result_value() returns without harm.
|
|
jpayne@69
|
6193 ** ^A [protected sqlite3_value] object may always be used where an
|
|
jpayne@69
|
6194 ** [unprotected sqlite3_value] object is required, so either
|
|
jpayne@69
|
6195 ** kind of [sqlite3_value] object can be used with this interface.
|
|
jpayne@69
|
6196 **
|
|
jpayne@69
|
6197 ** ^The sqlite3_result_pointer(C,P,T,D) interface sets the result to an
|
|
jpayne@69
|
6198 ** SQL NULL value, just like [sqlite3_result_null(C)], except that it
|
|
jpayne@69
|
6199 ** also associates the host-language pointer P or type T with that
|
|
jpayne@69
|
6200 ** NULL value such that the pointer can be retrieved within an
|
|
jpayne@69
|
6201 ** [application-defined SQL function] using [sqlite3_value_pointer()].
|
|
jpayne@69
|
6202 ** ^If the D parameter is not NULL, then it is a pointer to a destructor
|
|
jpayne@69
|
6203 ** for the P parameter. ^SQLite invokes D with P as its only argument
|
|
jpayne@69
|
6204 ** when SQLite is finished with P. The T parameter should be a static
|
|
jpayne@69
|
6205 ** string and preferably a string literal. The sqlite3_result_pointer()
|
|
jpayne@69
|
6206 ** routine is part of the [pointer passing interface] added for SQLite 3.20.0.
|
|
jpayne@69
|
6207 **
|
|
jpayne@69
|
6208 ** If these routines are called from within the different thread
|
|
jpayne@69
|
6209 ** than the one containing the application-defined function that received
|
|
jpayne@69
|
6210 ** the [sqlite3_context] pointer, the results are undefined.
|
|
jpayne@69
|
6211 */
|
|
jpayne@69
|
6212 SQLITE_API void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*));
|
|
jpayne@69
|
6213 SQLITE_API void sqlite3_result_blob64(sqlite3_context*,const void*,
|
|
jpayne@69
|
6214 sqlite3_uint64,void(*)(void*));
|
|
jpayne@69
|
6215 SQLITE_API void sqlite3_result_double(sqlite3_context*, double);
|
|
jpayne@69
|
6216 SQLITE_API void sqlite3_result_error(sqlite3_context*, const char*, int);
|
|
jpayne@69
|
6217 SQLITE_API void sqlite3_result_error16(sqlite3_context*, const void*, int);
|
|
jpayne@69
|
6218 SQLITE_API void sqlite3_result_error_toobig(sqlite3_context*);
|
|
jpayne@69
|
6219 SQLITE_API void sqlite3_result_error_nomem(sqlite3_context*);
|
|
jpayne@69
|
6220 SQLITE_API void sqlite3_result_error_code(sqlite3_context*, int);
|
|
jpayne@69
|
6221 SQLITE_API void sqlite3_result_int(sqlite3_context*, int);
|
|
jpayne@69
|
6222 SQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64);
|
|
jpayne@69
|
6223 SQLITE_API void sqlite3_result_null(sqlite3_context*);
|
|
jpayne@69
|
6224 SQLITE_API void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*));
|
|
jpayne@69
|
6225 SQLITE_API void sqlite3_result_text64(sqlite3_context*, const char*,sqlite3_uint64,
|
|
jpayne@69
|
6226 void(*)(void*), unsigned char encoding);
|
|
jpayne@69
|
6227 SQLITE_API void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*));
|
|
jpayne@69
|
6228 SQLITE_API void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*));
|
|
jpayne@69
|
6229 SQLITE_API void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*));
|
|
jpayne@69
|
6230 SQLITE_API void sqlite3_result_value(sqlite3_context*, sqlite3_value*);
|
|
jpayne@69
|
6231 SQLITE_API void sqlite3_result_pointer(sqlite3_context*, void*,const char*,void(*)(void*));
|
|
jpayne@69
|
6232 SQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n);
|
|
jpayne@69
|
6233 SQLITE_API int sqlite3_result_zeroblob64(sqlite3_context*, sqlite3_uint64 n);
|
|
jpayne@69
|
6234
|
|
jpayne@69
|
6235
|
|
jpayne@69
|
6236 /*
|
|
jpayne@69
|
6237 ** CAPI3REF: Setting The Subtype Of An SQL Function
|
|
jpayne@69
|
6238 ** METHOD: sqlite3_context
|
|
jpayne@69
|
6239 **
|
|
jpayne@69
|
6240 ** The sqlite3_result_subtype(C,T) function causes the subtype of
|
|
jpayne@69
|
6241 ** the result from the [application-defined SQL function] with
|
|
jpayne@69
|
6242 ** [sqlite3_context] C to be the value T. Only the lower 8 bits
|
|
jpayne@69
|
6243 ** of the subtype T are preserved in current versions of SQLite;
|
|
jpayne@69
|
6244 ** higher order bits are discarded.
|
|
jpayne@69
|
6245 ** The number of subtype bytes preserved by SQLite might increase
|
|
jpayne@69
|
6246 ** in future releases of SQLite.
|
|
jpayne@69
|
6247 **
|
|
jpayne@69
|
6248 ** Every [application-defined SQL function] that invokes this interface
|
|
jpayne@69
|
6249 ** should include the [SQLITE_RESULT_SUBTYPE] property in its
|
|
jpayne@69
|
6250 ** text encoding argument when the SQL function is
|
|
jpayne@69
|
6251 ** [sqlite3_create_function|registered]. If the [SQLITE_RESULT_SUBTYPE]
|
|
jpayne@69
|
6252 ** property is omitted from the function that invokes sqlite3_result_subtype(),
|
|
jpayne@69
|
6253 ** then in some cases the sqlite3_result_subtype() might fail to set
|
|
jpayne@69
|
6254 ** the result subtype.
|
|
jpayne@69
|
6255 **
|
|
jpayne@69
|
6256 ** If SQLite is compiled with -DSQLITE_STRICT_SUBTYPE=1, then any
|
|
jpayne@69
|
6257 ** SQL function that invokes the sqlite3_result_subtype() interface
|
|
jpayne@69
|
6258 ** and that does not have the SQLITE_RESULT_SUBTYPE property will raise
|
|
jpayne@69
|
6259 ** an error. Future versions of SQLite might enable -DSQLITE_STRICT_SUBTYPE=1
|
|
jpayne@69
|
6260 ** by default.
|
|
jpayne@69
|
6261 */
|
|
jpayne@69
|
6262 SQLITE_API void sqlite3_result_subtype(sqlite3_context*,unsigned int);
|
|
jpayne@69
|
6263
|
|
jpayne@69
|
6264 /*
|
|
jpayne@69
|
6265 ** CAPI3REF: Define New Collating Sequences
|
|
jpayne@69
|
6266 ** METHOD: sqlite3
|
|
jpayne@69
|
6267 **
|
|
jpayne@69
|
6268 ** ^These functions add, remove, or modify a [collation] associated
|
|
jpayne@69
|
6269 ** with the [database connection] specified as the first argument.
|
|
jpayne@69
|
6270 **
|
|
jpayne@69
|
6271 ** ^The name of the collation is a UTF-8 string
|
|
jpayne@69
|
6272 ** for sqlite3_create_collation() and sqlite3_create_collation_v2()
|
|
jpayne@69
|
6273 ** and a UTF-16 string in native byte order for sqlite3_create_collation16().
|
|
jpayne@69
|
6274 ** ^Collation names that compare equal according to [sqlite3_strnicmp()] are
|
|
jpayne@69
|
6275 ** considered to be the same name.
|
|
jpayne@69
|
6276 **
|
|
jpayne@69
|
6277 ** ^(The third argument (eTextRep) must be one of the constants:
|
|
jpayne@69
|
6278 ** <ul>
|
|
jpayne@69
|
6279 ** <li> [SQLITE_UTF8],
|
|
jpayne@69
|
6280 ** <li> [SQLITE_UTF16LE],
|
|
jpayne@69
|
6281 ** <li> [SQLITE_UTF16BE],
|
|
jpayne@69
|
6282 ** <li> [SQLITE_UTF16], or
|
|
jpayne@69
|
6283 ** <li> [SQLITE_UTF16_ALIGNED].
|
|
jpayne@69
|
6284 ** </ul>)^
|
|
jpayne@69
|
6285 ** ^The eTextRep argument determines the encoding of strings passed
|
|
jpayne@69
|
6286 ** to the collating function callback, xCompare.
|
|
jpayne@69
|
6287 ** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep
|
|
jpayne@69
|
6288 ** force strings to be UTF16 with native byte order.
|
|
jpayne@69
|
6289 ** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin
|
|
jpayne@69
|
6290 ** on an even byte address.
|
|
jpayne@69
|
6291 **
|
|
jpayne@69
|
6292 ** ^The fourth argument, pArg, is an application data pointer that is passed
|
|
jpayne@69
|
6293 ** through as the first argument to the collating function callback.
|
|
jpayne@69
|
6294 **
|
|
jpayne@69
|
6295 ** ^The fifth argument, xCompare, is a pointer to the collating function.
|
|
jpayne@69
|
6296 ** ^Multiple collating functions can be registered using the same name but
|
|
jpayne@69
|
6297 ** with different eTextRep parameters and SQLite will use whichever
|
|
jpayne@69
|
6298 ** function requires the least amount of data transformation.
|
|
jpayne@69
|
6299 ** ^If the xCompare argument is NULL then the collating function is
|
|
jpayne@69
|
6300 ** deleted. ^When all collating functions having the same name are deleted,
|
|
jpayne@69
|
6301 ** that collation is no longer usable.
|
|
jpayne@69
|
6302 **
|
|
jpayne@69
|
6303 ** ^The collating function callback is invoked with a copy of the pArg
|
|
jpayne@69
|
6304 ** application data pointer and with two strings in the encoding specified
|
|
jpayne@69
|
6305 ** by the eTextRep argument. The two integer parameters to the collating
|
|
jpayne@69
|
6306 ** function callback are the length of the two strings, in bytes. The collating
|
|
jpayne@69
|
6307 ** function must return an integer that is negative, zero, or positive
|
|
jpayne@69
|
6308 ** if the first string is less than, equal to, or greater than the second,
|
|
jpayne@69
|
6309 ** respectively. A collating function must always return the same answer
|
|
jpayne@69
|
6310 ** given the same inputs. If two or more collating functions are registered
|
|
jpayne@69
|
6311 ** to the same collation name (using different eTextRep values) then all
|
|
jpayne@69
|
6312 ** must give an equivalent answer when invoked with equivalent strings.
|
|
jpayne@69
|
6313 ** The collating function must obey the following properties for all
|
|
jpayne@69
|
6314 ** strings A, B, and C:
|
|
jpayne@69
|
6315 **
|
|
jpayne@69
|
6316 ** <ol>
|
|
jpayne@69
|
6317 ** <li> If A==B then B==A.
|
|
jpayne@69
|
6318 ** <li> If A==B and B==C then A==C.
|
|
jpayne@69
|
6319 ** <li> If A<B THEN B>A.
|
|
jpayne@69
|
6320 ** <li> If A<B and B<C then A<C.
|
|
jpayne@69
|
6321 ** </ol>
|
|
jpayne@69
|
6322 **
|
|
jpayne@69
|
6323 ** If a collating function fails any of the above constraints and that
|
|
jpayne@69
|
6324 ** collating function is registered and used, then the behavior of SQLite
|
|
jpayne@69
|
6325 ** is undefined.
|
|
jpayne@69
|
6326 **
|
|
jpayne@69
|
6327 ** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation()
|
|
jpayne@69
|
6328 ** with the addition that the xDestroy callback is invoked on pArg when
|
|
jpayne@69
|
6329 ** the collating function is deleted.
|
|
jpayne@69
|
6330 ** ^Collating functions are deleted when they are overridden by later
|
|
jpayne@69
|
6331 ** calls to the collation creation functions or when the
|
|
jpayne@69
|
6332 ** [database connection] is closed using [sqlite3_close()].
|
|
jpayne@69
|
6333 **
|
|
jpayne@69
|
6334 ** ^The xDestroy callback is <u>not</u> called if the
|
|
jpayne@69
|
6335 ** sqlite3_create_collation_v2() function fails. Applications that invoke
|
|
jpayne@69
|
6336 ** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should
|
|
jpayne@69
|
6337 ** check the return code and dispose of the application data pointer
|
|
jpayne@69
|
6338 ** themselves rather than expecting SQLite to deal with it for them.
|
|
jpayne@69
|
6339 ** This is different from every other SQLite interface. The inconsistency
|
|
jpayne@69
|
6340 ** is unfortunate but cannot be changed without breaking backwards
|
|
jpayne@69
|
6341 ** compatibility.
|
|
jpayne@69
|
6342 **
|
|
jpayne@69
|
6343 ** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()].
|
|
jpayne@69
|
6344 */
|
|
jpayne@69
|
6345 SQLITE_API int sqlite3_create_collation(
|
|
jpayne@69
|
6346 sqlite3*,
|
|
jpayne@69
|
6347 const char *zName,
|
|
jpayne@69
|
6348 int eTextRep,
|
|
jpayne@69
|
6349 void *pArg,
|
|
jpayne@69
|
6350 int(*xCompare)(void*,int,const void*,int,const void*)
|
|
jpayne@69
|
6351 );
|
|
jpayne@69
|
6352 SQLITE_API int sqlite3_create_collation_v2(
|
|
jpayne@69
|
6353 sqlite3*,
|
|
jpayne@69
|
6354 const char *zName,
|
|
jpayne@69
|
6355 int eTextRep,
|
|
jpayne@69
|
6356 void *pArg,
|
|
jpayne@69
|
6357 int(*xCompare)(void*,int,const void*,int,const void*),
|
|
jpayne@69
|
6358 void(*xDestroy)(void*)
|
|
jpayne@69
|
6359 );
|
|
jpayne@69
|
6360 SQLITE_API int sqlite3_create_collation16(
|
|
jpayne@69
|
6361 sqlite3*,
|
|
jpayne@69
|
6362 const void *zName,
|
|
jpayne@69
|
6363 int eTextRep,
|
|
jpayne@69
|
6364 void *pArg,
|
|
jpayne@69
|
6365 int(*xCompare)(void*,int,const void*,int,const void*)
|
|
jpayne@69
|
6366 );
|
|
jpayne@69
|
6367
|
|
jpayne@69
|
6368 /*
|
|
jpayne@69
|
6369 ** CAPI3REF: Collation Needed Callbacks
|
|
jpayne@69
|
6370 ** METHOD: sqlite3
|
|
jpayne@69
|
6371 **
|
|
jpayne@69
|
6372 ** ^To avoid having to register all collation sequences before a database
|
|
jpayne@69
|
6373 ** can be used, a single callback function may be registered with the
|
|
jpayne@69
|
6374 ** [database connection] to be invoked whenever an undefined collation
|
|
jpayne@69
|
6375 ** sequence is required.
|
|
jpayne@69
|
6376 **
|
|
jpayne@69
|
6377 ** ^If the function is registered using the sqlite3_collation_needed() API,
|
|
jpayne@69
|
6378 ** then it is passed the names of undefined collation sequences as strings
|
|
jpayne@69
|
6379 ** encoded in UTF-8. ^If sqlite3_collation_needed16() is used,
|
|
jpayne@69
|
6380 ** the names are passed as UTF-16 in machine native byte order.
|
|
jpayne@69
|
6381 ** ^A call to either function replaces the existing collation-needed callback.
|
|
jpayne@69
|
6382 **
|
|
jpayne@69
|
6383 ** ^(When the callback is invoked, the first argument passed is a copy
|
|
jpayne@69
|
6384 ** of the second argument to sqlite3_collation_needed() or
|
|
jpayne@69
|
6385 ** sqlite3_collation_needed16(). The second argument is the database
|
|
jpayne@69
|
6386 ** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE],
|
|
jpayne@69
|
6387 ** or [SQLITE_UTF16LE], indicating the most desirable form of the collation
|
|
jpayne@69
|
6388 ** sequence function required. The fourth parameter is the name of the
|
|
jpayne@69
|
6389 ** required collation sequence.)^
|
|
jpayne@69
|
6390 **
|
|
jpayne@69
|
6391 ** The callback function should register the desired collation using
|
|
jpayne@69
|
6392 ** [sqlite3_create_collation()], [sqlite3_create_collation16()], or
|
|
jpayne@69
|
6393 ** [sqlite3_create_collation_v2()].
|
|
jpayne@69
|
6394 */
|
|
jpayne@69
|
6395 SQLITE_API int sqlite3_collation_needed(
|
|
jpayne@69
|
6396 sqlite3*,
|
|
jpayne@69
|
6397 void*,
|
|
jpayne@69
|
6398 void(*)(void*,sqlite3*,int eTextRep,const char*)
|
|
jpayne@69
|
6399 );
|
|
jpayne@69
|
6400 SQLITE_API int sqlite3_collation_needed16(
|
|
jpayne@69
|
6401 sqlite3*,
|
|
jpayne@69
|
6402 void*,
|
|
jpayne@69
|
6403 void(*)(void*,sqlite3*,int eTextRep,const void*)
|
|
jpayne@69
|
6404 );
|
|
jpayne@69
|
6405
|
|
jpayne@69
|
6406 #ifdef SQLITE_ENABLE_CEROD
|
|
jpayne@69
|
6407 /*
|
|
jpayne@69
|
6408 ** Specify the activation key for a CEROD database. Unless
|
|
jpayne@69
|
6409 ** activated, none of the CEROD routines will work.
|
|
jpayne@69
|
6410 */
|
|
jpayne@69
|
6411 SQLITE_API void sqlite3_activate_cerod(
|
|
jpayne@69
|
6412 const char *zPassPhrase /* Activation phrase */
|
|
jpayne@69
|
6413 );
|
|
jpayne@69
|
6414 #endif
|
|
jpayne@69
|
6415
|
|
jpayne@69
|
6416 /*
|
|
jpayne@69
|
6417 ** CAPI3REF: Suspend Execution For A Short Time
|
|
jpayne@69
|
6418 **
|
|
jpayne@69
|
6419 ** The sqlite3_sleep() function causes the current thread to suspend execution
|
|
jpayne@69
|
6420 ** for at least a number of milliseconds specified in its parameter.
|
|
jpayne@69
|
6421 **
|
|
jpayne@69
|
6422 ** If the operating system does not support sleep requests with
|
|
jpayne@69
|
6423 ** millisecond time resolution, then the time will be rounded up to
|
|
jpayne@69
|
6424 ** the nearest second. The number of milliseconds of sleep actually
|
|
jpayne@69
|
6425 ** requested from the operating system is returned.
|
|
jpayne@69
|
6426 **
|
|
jpayne@69
|
6427 ** ^SQLite implements this interface by calling the xSleep()
|
|
jpayne@69
|
6428 ** method of the default [sqlite3_vfs] object. If the xSleep() method
|
|
jpayne@69
|
6429 ** of the default VFS is not implemented correctly, or not implemented at
|
|
jpayne@69
|
6430 ** all, then the behavior of sqlite3_sleep() may deviate from the description
|
|
jpayne@69
|
6431 ** in the previous paragraphs.
|
|
jpayne@69
|
6432 **
|
|
jpayne@69
|
6433 ** If a negative argument is passed to sqlite3_sleep() the results vary by
|
|
jpayne@69
|
6434 ** VFS and operating system. Some system treat a negative argument as an
|
|
jpayne@69
|
6435 ** instruction to sleep forever. Others understand it to mean do not sleep
|
|
jpayne@69
|
6436 ** at all. ^In SQLite version 3.42.0 and later, a negative
|
|
jpayne@69
|
6437 ** argument passed into sqlite3_sleep() is changed to zero before it is relayed
|
|
jpayne@69
|
6438 ** down into the xSleep method of the VFS.
|
|
jpayne@69
|
6439 */
|
|
jpayne@69
|
6440 SQLITE_API int sqlite3_sleep(int);
|
|
jpayne@69
|
6441
|
|
jpayne@69
|
6442 /*
|
|
jpayne@69
|
6443 ** CAPI3REF: Name Of The Folder Holding Temporary Files
|
|
jpayne@69
|
6444 **
|
|
jpayne@69
|
6445 ** ^(If this global variable is made to point to a string which is
|
|
jpayne@69
|
6446 ** the name of a folder (a.k.a. directory), then all temporary files
|
|
jpayne@69
|
6447 ** created by SQLite when using a built-in [sqlite3_vfs | VFS]
|
|
jpayne@69
|
6448 ** will be placed in that directory.)^ ^If this variable
|
|
jpayne@69
|
6449 ** is a NULL pointer, then SQLite performs a search for an appropriate
|
|
jpayne@69
|
6450 ** temporary file directory.
|
|
jpayne@69
|
6451 **
|
|
jpayne@69
|
6452 ** Applications are strongly discouraged from using this global variable.
|
|
jpayne@69
|
6453 ** It is required to set a temporary folder on Windows Runtime (WinRT).
|
|
jpayne@69
|
6454 ** But for all other platforms, it is highly recommended that applications
|
|
jpayne@69
|
6455 ** neither read nor write this variable. This global variable is a relic
|
|
jpayne@69
|
6456 ** that exists for backwards compatibility of legacy applications and should
|
|
jpayne@69
|
6457 ** be avoided in new projects.
|
|
jpayne@69
|
6458 **
|
|
jpayne@69
|
6459 ** It is not safe to read or modify this variable in more than one
|
|
jpayne@69
|
6460 ** thread at a time. It is not safe to read or modify this variable
|
|
jpayne@69
|
6461 ** if a [database connection] is being used at the same time in a separate
|
|
jpayne@69
|
6462 ** thread.
|
|
jpayne@69
|
6463 ** It is intended that this variable be set once
|
|
jpayne@69
|
6464 ** as part of process initialization and before any SQLite interface
|
|
jpayne@69
|
6465 ** routines have been called and that this variable remain unchanged
|
|
jpayne@69
|
6466 ** thereafter.
|
|
jpayne@69
|
6467 **
|
|
jpayne@69
|
6468 ** ^The [temp_store_directory pragma] may modify this variable and cause
|
|
jpayne@69
|
6469 ** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
|
|
jpayne@69
|
6470 ** the [temp_store_directory pragma] always assumes that any string
|
|
jpayne@69
|
6471 ** that this variable points to is held in memory obtained from
|
|
jpayne@69
|
6472 ** [sqlite3_malloc] and the pragma may attempt to free that memory
|
|
jpayne@69
|
6473 ** using [sqlite3_free].
|
|
jpayne@69
|
6474 ** Hence, if this variable is modified directly, either it should be
|
|
jpayne@69
|
6475 ** made NULL or made to point to memory obtained from [sqlite3_malloc]
|
|
jpayne@69
|
6476 ** or else the use of the [temp_store_directory pragma] should be avoided.
|
|
jpayne@69
|
6477 ** Except when requested by the [temp_store_directory pragma], SQLite
|
|
jpayne@69
|
6478 ** does not free the memory that sqlite3_temp_directory points to. If
|
|
jpayne@69
|
6479 ** the application wants that memory to be freed, it must do
|
|
jpayne@69
|
6480 ** so itself, taking care to only do so after all [database connection]
|
|
jpayne@69
|
6481 ** objects have been destroyed.
|
|
jpayne@69
|
6482 **
|
|
jpayne@69
|
6483 ** <b>Note to Windows Runtime users:</b> The temporary directory must be set
|
|
jpayne@69
|
6484 ** prior to calling [sqlite3_open] or [sqlite3_open_v2]. Otherwise, various
|
|
jpayne@69
|
6485 ** features that require the use of temporary files may fail. Here is an
|
|
jpayne@69
|
6486 ** example of how to do this using C++ with the Windows Runtime:
|
|
jpayne@69
|
6487 **
|
|
jpayne@69
|
6488 ** <blockquote><pre>
|
|
jpayne@69
|
6489 ** LPCWSTR zPath = Windows::Storage::ApplicationData::Current->
|
|
jpayne@69
|
6490 ** TemporaryFolder->Path->Data();
|
|
jpayne@69
|
6491 ** char zPathBuf[MAX_PATH + 1];
|
|
jpayne@69
|
6492 ** memset(zPathBuf, 0, sizeof(zPathBuf));
|
|
jpayne@69
|
6493 ** WideCharToMultiByte(CP_UTF8, 0, zPath, -1, zPathBuf, sizeof(zPathBuf),
|
|
jpayne@69
|
6494 ** NULL, NULL);
|
|
jpayne@69
|
6495 ** sqlite3_temp_directory = sqlite3_mprintf("%s", zPathBuf);
|
|
jpayne@69
|
6496 ** </pre></blockquote>
|
|
jpayne@69
|
6497 */
|
|
jpayne@69
|
6498 SQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory;
|
|
jpayne@69
|
6499
|
|
jpayne@69
|
6500 /*
|
|
jpayne@69
|
6501 ** CAPI3REF: Name Of The Folder Holding Database Files
|
|
jpayne@69
|
6502 **
|
|
jpayne@69
|
6503 ** ^(If this global variable is made to point to a string which is
|
|
jpayne@69
|
6504 ** the name of a folder (a.k.a. directory), then all database files
|
|
jpayne@69
|
6505 ** specified with a relative pathname and created or accessed by
|
|
jpayne@69
|
6506 ** SQLite when using a built-in windows [sqlite3_vfs | VFS] will be assumed
|
|
jpayne@69
|
6507 ** to be relative to that directory.)^ ^If this variable is a NULL
|
|
jpayne@69
|
6508 ** pointer, then SQLite assumes that all database files specified
|
|
jpayne@69
|
6509 ** with a relative pathname are relative to the current directory
|
|
jpayne@69
|
6510 ** for the process. Only the windows VFS makes use of this global
|
|
jpayne@69
|
6511 ** variable; it is ignored by the unix VFS.
|
|
jpayne@69
|
6512 **
|
|
jpayne@69
|
6513 ** Changing the value of this variable while a database connection is
|
|
jpayne@69
|
6514 ** open can result in a corrupt database.
|
|
jpayne@69
|
6515 **
|
|
jpayne@69
|
6516 ** It is not safe to read or modify this variable in more than one
|
|
jpayne@69
|
6517 ** thread at a time. It is not safe to read or modify this variable
|
|
jpayne@69
|
6518 ** if a [database connection] is being used at the same time in a separate
|
|
jpayne@69
|
6519 ** thread.
|
|
jpayne@69
|
6520 ** It is intended that this variable be set once
|
|
jpayne@69
|
6521 ** as part of process initialization and before any SQLite interface
|
|
jpayne@69
|
6522 ** routines have been called and that this variable remain unchanged
|
|
jpayne@69
|
6523 ** thereafter.
|
|
jpayne@69
|
6524 **
|
|
jpayne@69
|
6525 ** ^The [data_store_directory pragma] may modify this variable and cause
|
|
jpayne@69
|
6526 ** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
|
|
jpayne@69
|
6527 ** the [data_store_directory pragma] always assumes that any string
|
|
jpayne@69
|
6528 ** that this variable points to is held in memory obtained from
|
|
jpayne@69
|
6529 ** [sqlite3_malloc] and the pragma may attempt to free that memory
|
|
jpayne@69
|
6530 ** using [sqlite3_free].
|
|
jpayne@69
|
6531 ** Hence, if this variable is modified directly, either it should be
|
|
jpayne@69
|
6532 ** made NULL or made to point to memory obtained from [sqlite3_malloc]
|
|
jpayne@69
|
6533 ** or else the use of the [data_store_directory pragma] should be avoided.
|
|
jpayne@69
|
6534 */
|
|
jpayne@69
|
6535 SQLITE_API SQLITE_EXTERN char *sqlite3_data_directory;
|
|
jpayne@69
|
6536
|
|
jpayne@69
|
6537 /*
|
|
jpayne@69
|
6538 ** CAPI3REF: Win32 Specific Interface
|
|
jpayne@69
|
6539 **
|
|
jpayne@69
|
6540 ** These interfaces are available only on Windows. The
|
|
jpayne@69
|
6541 ** [sqlite3_win32_set_directory] interface is used to set the value associated
|
|
jpayne@69
|
6542 ** with the [sqlite3_temp_directory] or [sqlite3_data_directory] variable, to
|
|
jpayne@69
|
6543 ** zValue, depending on the value of the type parameter. The zValue parameter
|
|
jpayne@69
|
6544 ** should be NULL to cause the previous value to be freed via [sqlite3_free];
|
|
jpayne@69
|
6545 ** a non-NULL value will be copied into memory obtained from [sqlite3_malloc]
|
|
jpayne@69
|
6546 ** prior to being used. The [sqlite3_win32_set_directory] interface returns
|
|
jpayne@69
|
6547 ** [SQLITE_OK] to indicate success, [SQLITE_ERROR] if the type is unsupported,
|
|
jpayne@69
|
6548 ** or [SQLITE_NOMEM] if memory could not be allocated. The value of the
|
|
jpayne@69
|
6549 ** [sqlite3_data_directory] variable is intended to act as a replacement for
|
|
jpayne@69
|
6550 ** the current directory on the sub-platforms of Win32 where that concept is
|
|
jpayne@69
|
6551 ** not present, e.g. WinRT and UWP. The [sqlite3_win32_set_directory8] and
|
|
jpayne@69
|
6552 ** [sqlite3_win32_set_directory16] interfaces behave exactly the same as the
|
|
jpayne@69
|
6553 ** sqlite3_win32_set_directory interface except the string parameter must be
|
|
jpayne@69
|
6554 ** UTF-8 or UTF-16, respectively.
|
|
jpayne@69
|
6555 */
|
|
jpayne@69
|
6556 SQLITE_API int sqlite3_win32_set_directory(
|
|
jpayne@69
|
6557 unsigned long type, /* Identifier for directory being set or reset */
|
|
jpayne@69
|
6558 void *zValue /* New value for directory being set or reset */
|
|
jpayne@69
|
6559 );
|
|
jpayne@69
|
6560 SQLITE_API int sqlite3_win32_set_directory8(unsigned long type, const char *zValue);
|
|
jpayne@69
|
6561 SQLITE_API int sqlite3_win32_set_directory16(unsigned long type, const void *zValue);
|
|
jpayne@69
|
6562
|
|
jpayne@69
|
6563 /*
|
|
jpayne@69
|
6564 ** CAPI3REF: Win32 Directory Types
|
|
jpayne@69
|
6565 **
|
|
jpayne@69
|
6566 ** These macros are only available on Windows. They define the allowed values
|
|
jpayne@69
|
6567 ** for the type argument to the [sqlite3_win32_set_directory] interface.
|
|
jpayne@69
|
6568 */
|
|
jpayne@69
|
6569 #define SQLITE_WIN32_DATA_DIRECTORY_TYPE 1
|
|
jpayne@69
|
6570 #define SQLITE_WIN32_TEMP_DIRECTORY_TYPE 2
|
|
jpayne@69
|
6571
|
|
jpayne@69
|
6572 /*
|
|
jpayne@69
|
6573 ** CAPI3REF: Test For Auto-Commit Mode
|
|
jpayne@69
|
6574 ** KEYWORDS: {autocommit mode}
|
|
jpayne@69
|
6575 ** METHOD: sqlite3
|
|
jpayne@69
|
6576 **
|
|
jpayne@69
|
6577 ** ^The sqlite3_get_autocommit() interface returns non-zero or
|
|
jpayne@69
|
6578 ** zero if the given database connection is or is not in autocommit mode,
|
|
jpayne@69
|
6579 ** respectively. ^Autocommit mode is on by default.
|
|
jpayne@69
|
6580 ** ^Autocommit mode is disabled by a [BEGIN] statement.
|
|
jpayne@69
|
6581 ** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK].
|
|
jpayne@69
|
6582 **
|
|
jpayne@69
|
6583 ** If certain kinds of errors occur on a statement within a multi-statement
|
|
jpayne@69
|
6584 ** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR],
|
|
jpayne@69
|
6585 ** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the
|
|
jpayne@69
|
6586 ** transaction might be rolled back automatically. The only way to
|
|
jpayne@69
|
6587 ** find out whether SQLite automatically rolled back the transaction after
|
|
jpayne@69
|
6588 ** an error is to use this function.
|
|
jpayne@69
|
6589 **
|
|
jpayne@69
|
6590 ** If another thread changes the autocommit status of the database
|
|
jpayne@69
|
6591 ** connection while this routine is running, then the return value
|
|
jpayne@69
|
6592 ** is undefined.
|
|
jpayne@69
|
6593 */
|
|
jpayne@69
|
6594 SQLITE_API int sqlite3_get_autocommit(sqlite3*);
|
|
jpayne@69
|
6595
|
|
jpayne@69
|
6596 /*
|
|
jpayne@69
|
6597 ** CAPI3REF: Find The Database Handle Of A Prepared Statement
|
|
jpayne@69
|
6598 ** METHOD: sqlite3_stmt
|
|
jpayne@69
|
6599 **
|
|
jpayne@69
|
6600 ** ^The sqlite3_db_handle interface returns the [database connection] handle
|
|
jpayne@69
|
6601 ** to which a [prepared statement] belongs. ^The [database connection]
|
|
jpayne@69
|
6602 ** returned by sqlite3_db_handle is the same [database connection]
|
|
jpayne@69
|
6603 ** that was the first argument
|
|
jpayne@69
|
6604 ** to the [sqlite3_prepare_v2()] call (or its variants) that was used to
|
|
jpayne@69
|
6605 ** create the statement in the first place.
|
|
jpayne@69
|
6606 */
|
|
jpayne@69
|
6607 SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*);
|
|
jpayne@69
|
6608
|
|
jpayne@69
|
6609 /*
|
|
jpayne@69
|
6610 ** CAPI3REF: Return The Schema Name For A Database Connection
|
|
jpayne@69
|
6611 ** METHOD: sqlite3
|
|
jpayne@69
|
6612 **
|
|
jpayne@69
|
6613 ** ^The sqlite3_db_name(D,N) interface returns a pointer to the schema name
|
|
jpayne@69
|
6614 ** for the N-th database on database connection D, or a NULL pointer of N is
|
|
jpayne@69
|
6615 ** out of range. An N value of 0 means the main database file. An N of 1 is
|
|
jpayne@69
|
6616 ** the "temp" schema. Larger values of N correspond to various ATTACH-ed
|
|
jpayne@69
|
6617 ** databases.
|
|
jpayne@69
|
6618 **
|
|
jpayne@69
|
6619 ** Space to hold the string that is returned by sqlite3_db_name() is managed
|
|
jpayne@69
|
6620 ** by SQLite itself. The string might be deallocated by any operation that
|
|
jpayne@69
|
6621 ** changes the schema, including [ATTACH] or [DETACH] or calls to
|
|
jpayne@69
|
6622 ** [sqlite3_serialize()] or [sqlite3_deserialize()], even operations that
|
|
jpayne@69
|
6623 ** occur on a different thread. Applications that need to
|
|
jpayne@69
|
6624 ** remember the string long-term should make their own copy. Applications that
|
|
jpayne@69
|
6625 ** are accessing the same database connection simultaneously on multiple
|
|
jpayne@69
|
6626 ** threads should mutex-protect calls to this API and should make their own
|
|
jpayne@69
|
6627 ** private copy of the result prior to releasing the mutex.
|
|
jpayne@69
|
6628 */
|
|
jpayne@69
|
6629 SQLITE_API const char *sqlite3_db_name(sqlite3 *db, int N);
|
|
jpayne@69
|
6630
|
|
jpayne@69
|
6631 /*
|
|
jpayne@69
|
6632 ** CAPI3REF: Return The Filename For A Database Connection
|
|
jpayne@69
|
6633 ** METHOD: sqlite3
|
|
jpayne@69
|
6634 **
|
|
jpayne@69
|
6635 ** ^The sqlite3_db_filename(D,N) interface returns a pointer to the filename
|
|
jpayne@69
|
6636 ** associated with database N of connection D.
|
|
jpayne@69
|
6637 ** ^If there is no attached database N on the database
|
|
jpayne@69
|
6638 ** connection D, or if database N is a temporary or in-memory database, then
|
|
jpayne@69
|
6639 ** this function will return either a NULL pointer or an empty string.
|
|
jpayne@69
|
6640 **
|
|
jpayne@69
|
6641 ** ^The string value returned by this routine is owned and managed by
|
|
jpayne@69
|
6642 ** the database connection. ^The value will be valid until the database N
|
|
jpayne@69
|
6643 ** is [DETACH]-ed or until the database connection closes.
|
|
jpayne@69
|
6644 **
|
|
jpayne@69
|
6645 ** ^The filename returned by this function is the output of the
|
|
jpayne@69
|
6646 ** xFullPathname method of the [VFS]. ^In other words, the filename
|
|
jpayne@69
|
6647 ** will be an absolute pathname, even if the filename used
|
|
jpayne@69
|
6648 ** to open the database originally was a URI or relative pathname.
|
|
jpayne@69
|
6649 **
|
|
jpayne@69
|
6650 ** If the filename pointer returned by this routine is not NULL, then it
|
|
jpayne@69
|
6651 ** can be used as the filename input parameter to these routines:
|
|
jpayne@69
|
6652 ** <ul>
|
|
jpayne@69
|
6653 ** <li> [sqlite3_uri_parameter()]
|
|
jpayne@69
|
6654 ** <li> [sqlite3_uri_boolean()]
|
|
jpayne@69
|
6655 ** <li> [sqlite3_uri_int64()]
|
|
jpayne@69
|
6656 ** <li> [sqlite3_filename_database()]
|
|
jpayne@69
|
6657 ** <li> [sqlite3_filename_journal()]
|
|
jpayne@69
|
6658 ** <li> [sqlite3_filename_wal()]
|
|
jpayne@69
|
6659 ** </ul>
|
|
jpayne@69
|
6660 */
|
|
jpayne@69
|
6661 SQLITE_API sqlite3_filename sqlite3_db_filename(sqlite3 *db, const char *zDbName);
|
|
jpayne@69
|
6662
|
|
jpayne@69
|
6663 /*
|
|
jpayne@69
|
6664 ** CAPI3REF: Determine if a database is read-only
|
|
jpayne@69
|
6665 ** METHOD: sqlite3
|
|
jpayne@69
|
6666 **
|
|
jpayne@69
|
6667 ** ^The sqlite3_db_readonly(D,N) interface returns 1 if the database N
|
|
jpayne@69
|
6668 ** of connection D is read-only, 0 if it is read/write, or -1 if N is not
|
|
jpayne@69
|
6669 ** the name of a database on connection D.
|
|
jpayne@69
|
6670 */
|
|
jpayne@69
|
6671 SQLITE_API int sqlite3_db_readonly(sqlite3 *db, const char *zDbName);
|
|
jpayne@69
|
6672
|
|
jpayne@69
|
6673 /*
|
|
jpayne@69
|
6674 ** CAPI3REF: Determine the transaction state of a database
|
|
jpayne@69
|
6675 ** METHOD: sqlite3
|
|
jpayne@69
|
6676 **
|
|
jpayne@69
|
6677 ** ^The sqlite3_txn_state(D,S) interface returns the current
|
|
jpayne@69
|
6678 ** [transaction state] of schema S in database connection D. ^If S is NULL,
|
|
jpayne@69
|
6679 ** then the highest transaction state of any schema on database connection D
|
|
jpayne@69
|
6680 ** is returned. Transaction states are (in order of lowest to highest):
|
|
jpayne@69
|
6681 ** <ol>
|
|
jpayne@69
|
6682 ** <li value="0"> SQLITE_TXN_NONE
|
|
jpayne@69
|
6683 ** <li value="1"> SQLITE_TXN_READ
|
|
jpayne@69
|
6684 ** <li value="2"> SQLITE_TXN_WRITE
|
|
jpayne@69
|
6685 ** </ol>
|
|
jpayne@69
|
6686 ** ^If the S argument to sqlite3_txn_state(D,S) is not the name of
|
|
jpayne@69
|
6687 ** a valid schema, then -1 is returned.
|
|
jpayne@69
|
6688 */
|
|
jpayne@69
|
6689 SQLITE_API int sqlite3_txn_state(sqlite3*,const char *zSchema);
|
|
jpayne@69
|
6690
|
|
jpayne@69
|
6691 /*
|
|
jpayne@69
|
6692 ** CAPI3REF: Allowed return values from sqlite3_txn_state()
|
|
jpayne@69
|
6693 ** KEYWORDS: {transaction state}
|
|
jpayne@69
|
6694 **
|
|
jpayne@69
|
6695 ** These constants define the current transaction state of a database file.
|
|
jpayne@69
|
6696 ** ^The [sqlite3_txn_state(D,S)] interface returns one of these
|
|
jpayne@69
|
6697 ** constants in order to describe the transaction state of schema S
|
|
jpayne@69
|
6698 ** in [database connection] D.
|
|
jpayne@69
|
6699 **
|
|
jpayne@69
|
6700 ** <dl>
|
|
jpayne@69
|
6701 ** [[SQLITE_TXN_NONE]] <dt>SQLITE_TXN_NONE</dt>
|
|
jpayne@69
|
6702 ** <dd>The SQLITE_TXN_NONE state means that no transaction is currently
|
|
jpayne@69
|
6703 ** pending.</dd>
|
|
jpayne@69
|
6704 **
|
|
jpayne@69
|
6705 ** [[SQLITE_TXN_READ]] <dt>SQLITE_TXN_READ</dt>
|
|
jpayne@69
|
6706 ** <dd>The SQLITE_TXN_READ state means that the database is currently
|
|
jpayne@69
|
6707 ** in a read transaction. Content has been read from the database file
|
|
jpayne@69
|
6708 ** but nothing in the database file has changed. The transaction state
|
|
jpayne@69
|
6709 ** will advanced to SQLITE_TXN_WRITE if any changes occur and there are
|
|
jpayne@69
|
6710 ** no other conflicting concurrent write transactions. The transaction
|
|
jpayne@69
|
6711 ** state will revert to SQLITE_TXN_NONE following a [ROLLBACK] or
|
|
jpayne@69
|
6712 ** [COMMIT].</dd>
|
|
jpayne@69
|
6713 **
|
|
jpayne@69
|
6714 ** [[SQLITE_TXN_WRITE]] <dt>SQLITE_TXN_WRITE</dt>
|
|
jpayne@69
|
6715 ** <dd>The SQLITE_TXN_WRITE state means that the database is currently
|
|
jpayne@69
|
6716 ** in a write transaction. Content has been written to the database file
|
|
jpayne@69
|
6717 ** but has not yet committed. The transaction state will change to
|
|
jpayne@69
|
6718 ** to SQLITE_TXN_NONE at the next [ROLLBACK] or [COMMIT].</dd>
|
|
jpayne@69
|
6719 */
|
|
jpayne@69
|
6720 #define SQLITE_TXN_NONE 0
|
|
jpayne@69
|
6721 #define SQLITE_TXN_READ 1
|
|
jpayne@69
|
6722 #define SQLITE_TXN_WRITE 2
|
|
jpayne@69
|
6723
|
|
jpayne@69
|
6724 /*
|
|
jpayne@69
|
6725 ** CAPI3REF: Find the next prepared statement
|
|
jpayne@69
|
6726 ** METHOD: sqlite3
|
|
jpayne@69
|
6727 **
|
|
jpayne@69
|
6728 ** ^This interface returns a pointer to the next [prepared statement] after
|
|
jpayne@69
|
6729 ** pStmt associated with the [database connection] pDb. ^If pStmt is NULL
|
|
jpayne@69
|
6730 ** then this interface returns a pointer to the first prepared statement
|
|
jpayne@69
|
6731 ** associated with the database connection pDb. ^If no prepared statement
|
|
jpayne@69
|
6732 ** satisfies the conditions of this routine, it returns NULL.
|
|
jpayne@69
|
6733 **
|
|
jpayne@69
|
6734 ** The [database connection] pointer D in a call to
|
|
jpayne@69
|
6735 ** [sqlite3_next_stmt(D,S)] must refer to an open database
|
|
jpayne@69
|
6736 ** connection and in particular must not be a NULL pointer.
|
|
jpayne@69
|
6737 */
|
|
jpayne@69
|
6738 SQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt);
|
|
jpayne@69
|
6739
|
|
jpayne@69
|
6740 /*
|
|
jpayne@69
|
6741 ** CAPI3REF: Commit And Rollback Notification Callbacks
|
|
jpayne@69
|
6742 ** METHOD: sqlite3
|
|
jpayne@69
|
6743 **
|
|
jpayne@69
|
6744 ** ^The sqlite3_commit_hook() interface registers a callback
|
|
jpayne@69
|
6745 ** function to be invoked whenever a transaction is [COMMIT | committed].
|
|
jpayne@69
|
6746 ** ^Any callback set by a previous call to sqlite3_commit_hook()
|
|
jpayne@69
|
6747 ** for the same database connection is overridden.
|
|
jpayne@69
|
6748 ** ^The sqlite3_rollback_hook() interface registers a callback
|
|
jpayne@69
|
6749 ** function to be invoked whenever a transaction is [ROLLBACK | rolled back].
|
|
jpayne@69
|
6750 ** ^Any callback set by a previous call to sqlite3_rollback_hook()
|
|
jpayne@69
|
6751 ** for the same database connection is overridden.
|
|
jpayne@69
|
6752 ** ^The pArg argument is passed through to the callback.
|
|
jpayne@69
|
6753 ** ^If the callback on a commit hook function returns non-zero,
|
|
jpayne@69
|
6754 ** then the commit is converted into a rollback.
|
|
jpayne@69
|
6755 **
|
|
jpayne@69
|
6756 ** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions
|
|
jpayne@69
|
6757 ** return the P argument from the previous call of the same function
|
|
jpayne@69
|
6758 ** on the same [database connection] D, or NULL for
|
|
jpayne@69
|
6759 ** the first call for each function on D.
|
|
jpayne@69
|
6760 **
|
|
jpayne@69
|
6761 ** The commit and rollback hook callbacks are not reentrant.
|
|
jpayne@69
|
6762 ** The callback implementation must not do anything that will modify
|
|
jpayne@69
|
6763 ** the database connection that invoked the callback. Any actions
|
|
jpayne@69
|
6764 ** to modify the database connection must be deferred until after the
|
|
jpayne@69
|
6765 ** completion of the [sqlite3_step()] call that triggered the commit
|
|
jpayne@69
|
6766 ** or rollback hook in the first place.
|
|
jpayne@69
|
6767 ** Note that running any other SQL statements, including SELECT statements,
|
|
jpayne@69
|
6768 ** or merely calling [sqlite3_prepare_v2()] and [sqlite3_step()] will modify
|
|
jpayne@69
|
6769 ** the database connections for the meaning of "modify" in this paragraph.
|
|
jpayne@69
|
6770 **
|
|
jpayne@69
|
6771 ** ^Registering a NULL function disables the callback.
|
|
jpayne@69
|
6772 **
|
|
jpayne@69
|
6773 ** ^When the commit hook callback routine returns zero, the [COMMIT]
|
|
jpayne@69
|
6774 ** operation is allowed to continue normally. ^If the commit hook
|
|
jpayne@69
|
6775 ** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK].
|
|
jpayne@69
|
6776 ** ^The rollback hook is invoked on a rollback that results from a commit
|
|
jpayne@69
|
6777 ** hook returning non-zero, just as it would be with any other rollback.
|
|
jpayne@69
|
6778 **
|
|
jpayne@69
|
6779 ** ^For the purposes of this API, a transaction is said to have been
|
|
jpayne@69
|
6780 ** rolled back if an explicit "ROLLBACK" statement is executed, or
|
|
jpayne@69
|
6781 ** an error or constraint causes an implicit rollback to occur.
|
|
jpayne@69
|
6782 ** ^The rollback callback is not invoked if a transaction is
|
|
jpayne@69
|
6783 ** automatically rolled back because the database connection is closed.
|
|
jpayne@69
|
6784 **
|
|
jpayne@69
|
6785 ** See also the [sqlite3_update_hook()] interface.
|
|
jpayne@69
|
6786 */
|
|
jpayne@69
|
6787 SQLITE_API void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
|
|
jpayne@69
|
6788 SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);
|
|
jpayne@69
|
6789
|
|
jpayne@69
|
6790 /*
|
|
jpayne@69
|
6791 ** CAPI3REF: Autovacuum Compaction Amount Callback
|
|
jpayne@69
|
6792 ** METHOD: sqlite3
|
|
jpayne@69
|
6793 **
|
|
jpayne@69
|
6794 ** ^The sqlite3_autovacuum_pages(D,C,P,X) interface registers a callback
|
|
jpayne@69
|
6795 ** function C that is invoked prior to each autovacuum of the database
|
|
jpayne@69
|
6796 ** file. ^The callback is passed a copy of the generic data pointer (P),
|
|
jpayne@69
|
6797 ** the schema-name of the attached database that is being autovacuumed,
|
|
jpayne@69
|
6798 ** the size of the database file in pages, the number of free pages,
|
|
jpayne@69
|
6799 ** and the number of bytes per page, respectively. The callback should
|
|
jpayne@69
|
6800 ** return the number of free pages that should be removed by the
|
|
jpayne@69
|
6801 ** autovacuum. ^If the callback returns zero, then no autovacuum happens.
|
|
jpayne@69
|
6802 ** ^If the value returned is greater than or equal to the number of
|
|
jpayne@69
|
6803 ** free pages, then a complete autovacuum happens.
|
|
jpayne@69
|
6804 **
|
|
jpayne@69
|
6805 ** <p>^If there are multiple ATTACH-ed database files that are being
|
|
jpayne@69
|
6806 ** modified as part of a transaction commit, then the autovacuum pages
|
|
jpayne@69
|
6807 ** callback is invoked separately for each file.
|
|
jpayne@69
|
6808 **
|
|
jpayne@69
|
6809 ** <p><b>The callback is not reentrant.</b> The callback function should
|
|
jpayne@69
|
6810 ** not attempt to invoke any other SQLite interface. If it does, bad
|
|
jpayne@69
|
6811 ** things may happen, including segmentation faults and corrupt database
|
|
jpayne@69
|
6812 ** files. The callback function should be a simple function that
|
|
jpayne@69
|
6813 ** does some arithmetic on its input parameters and returns a result.
|
|
jpayne@69
|
6814 **
|
|
jpayne@69
|
6815 ** ^The X parameter to sqlite3_autovacuum_pages(D,C,P,X) is an optional
|
|
jpayne@69
|
6816 ** destructor for the P parameter. ^If X is not NULL, then X(P) is
|
|
jpayne@69
|
6817 ** invoked whenever the database connection closes or when the callback
|
|
jpayne@69
|
6818 ** is overwritten by another invocation of sqlite3_autovacuum_pages().
|
|
jpayne@69
|
6819 **
|
|
jpayne@69
|
6820 ** <p>^There is only one autovacuum pages callback per database connection.
|
|
jpayne@69
|
6821 ** ^Each call to the sqlite3_autovacuum_pages() interface overrides all
|
|
jpayne@69
|
6822 ** previous invocations for that database connection. ^If the callback
|
|
jpayne@69
|
6823 ** argument (C) to sqlite3_autovacuum_pages(D,C,P,X) is a NULL pointer,
|
|
jpayne@69
|
6824 ** then the autovacuum steps callback is canceled. The return value
|
|
jpayne@69
|
6825 ** from sqlite3_autovacuum_pages() is normally SQLITE_OK, but might
|
|
jpayne@69
|
6826 ** be some other error code if something goes wrong. The current
|
|
jpayne@69
|
6827 ** implementation will only return SQLITE_OK or SQLITE_MISUSE, but other
|
|
jpayne@69
|
6828 ** return codes might be added in future releases.
|
|
jpayne@69
|
6829 **
|
|
jpayne@69
|
6830 ** <p>If no autovacuum pages callback is specified (the usual case) or
|
|
jpayne@69
|
6831 ** a NULL pointer is provided for the callback,
|
|
jpayne@69
|
6832 ** then the default behavior is to vacuum all free pages. So, in other
|
|
jpayne@69
|
6833 ** words, the default behavior is the same as if the callback function
|
|
jpayne@69
|
6834 ** were something like this:
|
|
jpayne@69
|
6835 **
|
|
jpayne@69
|
6836 ** <blockquote><pre>
|
|
jpayne@69
|
6837 ** unsigned int demonstration_autovac_pages_callback(
|
|
jpayne@69
|
6838 ** void *pClientData,
|
|
jpayne@69
|
6839 ** const char *zSchema,
|
|
jpayne@69
|
6840 ** unsigned int nDbPage,
|
|
jpayne@69
|
6841 ** unsigned int nFreePage,
|
|
jpayne@69
|
6842 ** unsigned int nBytePerPage
|
|
jpayne@69
|
6843 ** ){
|
|
jpayne@69
|
6844 ** return nFreePage;
|
|
jpayne@69
|
6845 ** }
|
|
jpayne@69
|
6846 ** </pre></blockquote>
|
|
jpayne@69
|
6847 */
|
|
jpayne@69
|
6848 SQLITE_API int sqlite3_autovacuum_pages(
|
|
jpayne@69
|
6849 sqlite3 *db,
|
|
jpayne@69
|
6850 unsigned int(*)(void*,const char*,unsigned int,unsigned int,unsigned int),
|
|
jpayne@69
|
6851 void*,
|
|
jpayne@69
|
6852 void(*)(void*)
|
|
jpayne@69
|
6853 );
|
|
jpayne@69
|
6854
|
|
jpayne@69
|
6855
|
|
jpayne@69
|
6856 /*
|
|
jpayne@69
|
6857 ** CAPI3REF: Data Change Notification Callbacks
|
|
jpayne@69
|
6858 ** METHOD: sqlite3
|
|
jpayne@69
|
6859 **
|
|
jpayne@69
|
6860 ** ^The sqlite3_update_hook() interface registers a callback function
|
|
jpayne@69
|
6861 ** with the [database connection] identified by the first argument
|
|
jpayne@69
|
6862 ** to be invoked whenever a row is updated, inserted or deleted in
|
|
jpayne@69
|
6863 ** a [rowid table].
|
|
jpayne@69
|
6864 ** ^Any callback set by a previous call to this function
|
|
jpayne@69
|
6865 ** for the same database connection is overridden.
|
|
jpayne@69
|
6866 **
|
|
jpayne@69
|
6867 ** ^The second argument is a pointer to the function to invoke when a
|
|
jpayne@69
|
6868 ** row is updated, inserted or deleted in a rowid table.
|
|
jpayne@69
|
6869 ** ^The first argument to the callback is a copy of the third argument
|
|
jpayne@69
|
6870 ** to sqlite3_update_hook().
|
|
jpayne@69
|
6871 ** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE],
|
|
jpayne@69
|
6872 ** or [SQLITE_UPDATE], depending on the operation that caused the callback
|
|
jpayne@69
|
6873 ** to be invoked.
|
|
jpayne@69
|
6874 ** ^The third and fourth arguments to the callback contain pointers to the
|
|
jpayne@69
|
6875 ** database and table name containing the affected row.
|
|
jpayne@69
|
6876 ** ^The final callback parameter is the [rowid] of the row.
|
|
jpayne@69
|
6877 ** ^In the case of an update, this is the [rowid] after the update takes place.
|
|
jpayne@69
|
6878 **
|
|
jpayne@69
|
6879 ** ^(The update hook is not invoked when internal system tables are
|
|
jpayne@69
|
6880 ** modified (i.e. sqlite_sequence).)^
|
|
jpayne@69
|
6881 ** ^The update hook is not invoked when [WITHOUT ROWID] tables are modified.
|
|
jpayne@69
|
6882 **
|
|
jpayne@69
|
6883 ** ^In the current implementation, the update hook
|
|
jpayne@69
|
6884 ** is not invoked when conflicting rows are deleted because of an
|
|
jpayne@69
|
6885 ** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook
|
|
jpayne@69
|
6886 ** invoked when rows are deleted using the [truncate optimization].
|
|
jpayne@69
|
6887 ** The exceptions defined in this paragraph might change in a future
|
|
jpayne@69
|
6888 ** release of SQLite.
|
|
jpayne@69
|
6889 **
|
|
jpayne@69
|
6890 ** Whether the update hook is invoked before or after the
|
|
jpayne@69
|
6891 ** corresponding change is currently unspecified and may differ
|
|
jpayne@69
|
6892 ** depending on the type of change. Do not rely on the order of the
|
|
jpayne@69
|
6893 ** hook call with regards to the final result of the operation which
|
|
jpayne@69
|
6894 ** triggers the hook.
|
|
jpayne@69
|
6895 **
|
|
jpayne@69
|
6896 ** The update hook implementation must not do anything that will modify
|
|
jpayne@69
|
6897 ** the database connection that invoked the update hook. Any actions
|
|
jpayne@69
|
6898 ** to modify the database connection must be deferred until after the
|
|
jpayne@69
|
6899 ** completion of the [sqlite3_step()] call that triggered the update hook.
|
|
jpayne@69
|
6900 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
|
|
jpayne@69
|
6901 ** database connections for the meaning of "modify" in this paragraph.
|
|
jpayne@69
|
6902 **
|
|
jpayne@69
|
6903 ** ^The sqlite3_update_hook(D,C,P) function
|
|
jpayne@69
|
6904 ** returns the P argument from the previous call
|
|
jpayne@69
|
6905 ** on the same [database connection] D, or NULL for
|
|
jpayne@69
|
6906 ** the first call on D.
|
|
jpayne@69
|
6907 **
|
|
jpayne@69
|
6908 ** See also the [sqlite3_commit_hook()], [sqlite3_rollback_hook()],
|
|
jpayne@69
|
6909 ** and [sqlite3_preupdate_hook()] interfaces.
|
|
jpayne@69
|
6910 */
|
|
jpayne@69
|
6911 SQLITE_API void *sqlite3_update_hook(
|
|
jpayne@69
|
6912 sqlite3*,
|
|
jpayne@69
|
6913 void(*)(void *,int ,char const *,char const *,sqlite3_int64),
|
|
jpayne@69
|
6914 void*
|
|
jpayne@69
|
6915 );
|
|
jpayne@69
|
6916
|
|
jpayne@69
|
6917 /*
|
|
jpayne@69
|
6918 ** CAPI3REF: Enable Or Disable Shared Pager Cache
|
|
jpayne@69
|
6919 **
|
|
jpayne@69
|
6920 ** ^(This routine enables or disables the sharing of the database cache
|
|
jpayne@69
|
6921 ** and schema data structures between [database connection | connections]
|
|
jpayne@69
|
6922 ** to the same database. Sharing is enabled if the argument is true
|
|
jpayne@69
|
6923 ** and disabled if the argument is false.)^
|
|
jpayne@69
|
6924 **
|
|
jpayne@69
|
6925 ** This interface is omitted if SQLite is compiled with
|
|
jpayne@69
|
6926 ** [-DSQLITE_OMIT_SHARED_CACHE]. The [-DSQLITE_OMIT_SHARED_CACHE]
|
|
jpayne@69
|
6927 ** compile-time option is recommended because the
|
|
jpayne@69
|
6928 ** [use of shared cache mode is discouraged].
|
|
jpayne@69
|
6929 **
|
|
jpayne@69
|
6930 ** ^Cache sharing is enabled and disabled for an entire process.
|
|
jpayne@69
|
6931 ** This is a change as of SQLite [version 3.5.0] ([dateof:3.5.0]).
|
|
jpayne@69
|
6932 ** In prior versions of SQLite,
|
|
jpayne@69
|
6933 ** sharing was enabled or disabled for each thread separately.
|
|
jpayne@69
|
6934 **
|
|
jpayne@69
|
6935 ** ^(The cache sharing mode set by this interface effects all subsequent
|
|
jpayne@69
|
6936 ** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()].
|
|
jpayne@69
|
6937 ** Existing database connections continue to use the sharing mode
|
|
jpayne@69
|
6938 ** that was in effect at the time they were opened.)^
|
|
jpayne@69
|
6939 **
|
|
jpayne@69
|
6940 ** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled
|
|
jpayne@69
|
6941 ** successfully. An [error code] is returned otherwise.)^
|
|
jpayne@69
|
6942 **
|
|
jpayne@69
|
6943 ** ^Shared cache is disabled by default. It is recommended that it stay
|
|
jpayne@69
|
6944 ** that way. In other words, do not use this routine. This interface
|
|
jpayne@69
|
6945 ** continues to be provided for historical compatibility, but its use is
|
|
jpayne@69
|
6946 ** discouraged. Any use of shared cache is discouraged. If shared cache
|
|
jpayne@69
|
6947 ** must be used, it is recommended that shared cache only be enabled for
|
|
jpayne@69
|
6948 ** individual database connections using the [sqlite3_open_v2()] interface
|
|
jpayne@69
|
6949 ** with the [SQLITE_OPEN_SHAREDCACHE] flag.
|
|
jpayne@69
|
6950 **
|
|
jpayne@69
|
6951 ** Note: This method is disabled on MacOS X 10.7 and iOS version 5.0
|
|
jpayne@69
|
6952 ** and will always return SQLITE_MISUSE. On those systems,
|
|
jpayne@69
|
6953 ** shared cache mode should be enabled per-database connection via
|
|
jpayne@69
|
6954 ** [sqlite3_open_v2()] with [SQLITE_OPEN_SHAREDCACHE].
|
|
jpayne@69
|
6955 **
|
|
jpayne@69
|
6956 ** This interface is threadsafe on processors where writing a
|
|
jpayne@69
|
6957 ** 32-bit integer is atomic.
|
|
jpayne@69
|
6958 **
|
|
jpayne@69
|
6959 ** See Also: [SQLite Shared-Cache Mode]
|
|
jpayne@69
|
6960 */
|
|
jpayne@69
|
6961 SQLITE_API int sqlite3_enable_shared_cache(int);
|
|
jpayne@69
|
6962
|
|
jpayne@69
|
6963 /*
|
|
jpayne@69
|
6964 ** CAPI3REF: Attempt To Free Heap Memory
|
|
jpayne@69
|
6965 **
|
|
jpayne@69
|
6966 ** ^The sqlite3_release_memory() interface attempts to free N bytes
|
|
jpayne@69
|
6967 ** of heap memory by deallocating non-essential memory allocations
|
|
jpayne@69
|
6968 ** held by the database library. Memory used to cache database
|
|
jpayne@69
|
6969 ** pages to improve performance is an example of non-essential memory.
|
|
jpayne@69
|
6970 ** ^sqlite3_release_memory() returns the number of bytes actually freed,
|
|
jpayne@69
|
6971 ** which might be more or less than the amount requested.
|
|
jpayne@69
|
6972 ** ^The sqlite3_release_memory() routine is a no-op returning zero
|
|
jpayne@69
|
6973 ** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT].
|
|
jpayne@69
|
6974 **
|
|
jpayne@69
|
6975 ** See also: [sqlite3_db_release_memory()]
|
|
jpayne@69
|
6976 */
|
|
jpayne@69
|
6977 SQLITE_API int sqlite3_release_memory(int);
|
|
jpayne@69
|
6978
|
|
jpayne@69
|
6979 /*
|
|
jpayne@69
|
6980 ** CAPI3REF: Free Memory Used By A Database Connection
|
|
jpayne@69
|
6981 ** METHOD: sqlite3
|
|
jpayne@69
|
6982 **
|
|
jpayne@69
|
6983 ** ^The sqlite3_db_release_memory(D) interface attempts to free as much heap
|
|
jpayne@69
|
6984 ** memory as possible from database connection D. Unlike the
|
|
jpayne@69
|
6985 ** [sqlite3_release_memory()] interface, this interface is in effect even
|
|
jpayne@69
|
6986 ** when the [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is
|
|
jpayne@69
|
6987 ** omitted.
|
|
jpayne@69
|
6988 **
|
|
jpayne@69
|
6989 ** See also: [sqlite3_release_memory()]
|
|
jpayne@69
|
6990 */
|
|
jpayne@69
|
6991 SQLITE_API int sqlite3_db_release_memory(sqlite3*);
|
|
jpayne@69
|
6992
|
|
jpayne@69
|
6993 /*
|
|
jpayne@69
|
6994 ** CAPI3REF: Impose A Limit On Heap Size
|
|
jpayne@69
|
6995 **
|
|
jpayne@69
|
6996 ** These interfaces impose limits on the amount of heap memory that will be
|
|
jpayne@69
|
6997 ** by all database connections within a single process.
|
|
jpayne@69
|
6998 **
|
|
jpayne@69
|
6999 ** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the
|
|
jpayne@69
|
7000 ** soft limit on the amount of heap memory that may be allocated by SQLite.
|
|
jpayne@69
|
7001 ** ^SQLite strives to keep heap memory utilization below the soft heap
|
|
jpayne@69
|
7002 ** limit by reducing the number of pages held in the page cache
|
|
jpayne@69
|
7003 ** as heap memory usages approaches the limit.
|
|
jpayne@69
|
7004 ** ^The soft heap limit is "soft" because even though SQLite strives to stay
|
|
jpayne@69
|
7005 ** below the limit, it will exceed the limit rather than generate
|
|
jpayne@69
|
7006 ** an [SQLITE_NOMEM] error. In other words, the soft heap limit
|
|
jpayne@69
|
7007 ** is advisory only.
|
|
jpayne@69
|
7008 **
|
|
jpayne@69
|
7009 ** ^The sqlite3_hard_heap_limit64(N) interface sets a hard upper bound of
|
|
jpayne@69
|
7010 ** N bytes on the amount of memory that will be allocated. ^The
|
|
jpayne@69
|
7011 ** sqlite3_hard_heap_limit64(N) interface is similar to
|
|
jpayne@69
|
7012 ** sqlite3_soft_heap_limit64(N) except that memory allocations will fail
|
|
jpayne@69
|
7013 ** when the hard heap limit is reached.
|
|
jpayne@69
|
7014 **
|
|
jpayne@69
|
7015 ** ^The return value from both sqlite3_soft_heap_limit64() and
|
|
jpayne@69
|
7016 ** sqlite3_hard_heap_limit64() is the size of
|
|
jpayne@69
|
7017 ** the heap limit prior to the call, or negative in the case of an
|
|
jpayne@69
|
7018 ** error. ^If the argument N is negative
|
|
jpayne@69
|
7019 ** then no change is made to the heap limit. Hence, the current
|
|
jpayne@69
|
7020 ** size of heap limits can be determined by invoking
|
|
jpayne@69
|
7021 ** sqlite3_soft_heap_limit64(-1) or sqlite3_hard_heap_limit(-1).
|
|
jpayne@69
|
7022 **
|
|
jpayne@69
|
7023 ** ^Setting the heap limits to zero disables the heap limiter mechanism.
|
|
jpayne@69
|
7024 **
|
|
jpayne@69
|
7025 ** ^The soft heap limit may not be greater than the hard heap limit.
|
|
jpayne@69
|
7026 ** ^If the hard heap limit is enabled and if sqlite3_soft_heap_limit(N)
|
|
jpayne@69
|
7027 ** is invoked with a value of N that is greater than the hard heap limit,
|
|
jpayne@69
|
7028 ** the soft heap limit is set to the value of the hard heap limit.
|
|
jpayne@69
|
7029 ** ^The soft heap limit is automatically enabled whenever the hard heap
|
|
jpayne@69
|
7030 ** limit is enabled. ^When sqlite3_hard_heap_limit64(N) is invoked and
|
|
jpayne@69
|
7031 ** the soft heap limit is outside the range of 1..N, then the soft heap
|
|
jpayne@69
|
7032 ** limit is set to N. ^Invoking sqlite3_soft_heap_limit64(0) when the
|
|
jpayne@69
|
7033 ** hard heap limit is enabled makes the soft heap limit equal to the
|
|
jpayne@69
|
7034 ** hard heap limit.
|
|
jpayne@69
|
7035 **
|
|
jpayne@69
|
7036 ** The memory allocation limits can also be adjusted using
|
|
jpayne@69
|
7037 ** [PRAGMA soft_heap_limit] and [PRAGMA hard_heap_limit].
|
|
jpayne@69
|
7038 **
|
|
jpayne@69
|
7039 ** ^(The heap limits are not enforced in the current implementation
|
|
jpayne@69
|
7040 ** if one or more of following conditions are true:
|
|
jpayne@69
|
7041 **
|
|
jpayne@69
|
7042 ** <ul>
|
|
jpayne@69
|
7043 ** <li> The limit value is set to zero.
|
|
jpayne@69
|
7044 ** <li> Memory accounting is disabled using a combination of the
|
|
jpayne@69
|
7045 ** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and
|
|
jpayne@69
|
7046 ** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option.
|
|
jpayne@69
|
7047 ** <li> An alternative page cache implementation is specified using
|
|
jpayne@69
|
7048 ** [sqlite3_config]([SQLITE_CONFIG_PCACHE2],...).
|
|
jpayne@69
|
7049 ** <li> The page cache allocates from its own memory pool supplied
|
|
jpayne@69
|
7050 ** by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than
|
|
jpayne@69
|
7051 ** from the heap.
|
|
jpayne@69
|
7052 ** </ul>)^
|
|
jpayne@69
|
7053 **
|
|
jpayne@69
|
7054 ** The circumstances under which SQLite will enforce the heap limits may
|
|
jpayne@69
|
7055 ** changes in future releases of SQLite.
|
|
jpayne@69
|
7056 */
|
|
jpayne@69
|
7057 SQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N);
|
|
jpayne@69
|
7058 SQLITE_API sqlite3_int64 sqlite3_hard_heap_limit64(sqlite3_int64 N);
|
|
jpayne@69
|
7059
|
|
jpayne@69
|
7060 /*
|
|
jpayne@69
|
7061 ** CAPI3REF: Deprecated Soft Heap Limit Interface
|
|
jpayne@69
|
7062 ** DEPRECATED
|
|
jpayne@69
|
7063 **
|
|
jpayne@69
|
7064 ** This is a deprecated version of the [sqlite3_soft_heap_limit64()]
|
|
jpayne@69
|
7065 ** interface. This routine is provided for historical compatibility
|
|
jpayne@69
|
7066 ** only. All new applications should use the
|
|
jpayne@69
|
7067 ** [sqlite3_soft_heap_limit64()] interface rather than this one.
|
|
jpayne@69
|
7068 */
|
|
jpayne@69
|
7069 SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_limit(int N);
|
|
jpayne@69
|
7070
|
|
jpayne@69
|
7071
|
|
jpayne@69
|
7072 /*
|
|
jpayne@69
|
7073 ** CAPI3REF: Extract Metadata About A Column Of A Table
|
|
jpayne@69
|
7074 ** METHOD: sqlite3
|
|
jpayne@69
|
7075 **
|
|
jpayne@69
|
7076 ** ^(The sqlite3_table_column_metadata(X,D,T,C,....) routine returns
|
|
jpayne@69
|
7077 ** information about column C of table T in database D
|
|
jpayne@69
|
7078 ** on [database connection] X.)^ ^The sqlite3_table_column_metadata()
|
|
jpayne@69
|
7079 ** interface returns SQLITE_OK and fills in the non-NULL pointers in
|
|
jpayne@69
|
7080 ** the final five arguments with appropriate values if the specified
|
|
jpayne@69
|
7081 ** column exists. ^The sqlite3_table_column_metadata() interface returns
|
|
jpayne@69
|
7082 ** SQLITE_ERROR if the specified column does not exist.
|
|
jpayne@69
|
7083 ** ^If the column-name parameter to sqlite3_table_column_metadata() is a
|
|
jpayne@69
|
7084 ** NULL pointer, then this routine simply checks for the existence of the
|
|
jpayne@69
|
7085 ** table and returns SQLITE_OK if the table exists and SQLITE_ERROR if it
|
|
jpayne@69
|
7086 ** does not. If the table name parameter T in a call to
|
|
jpayne@69
|
7087 ** sqlite3_table_column_metadata(X,D,T,C,...) is NULL then the result is
|
|
jpayne@69
|
7088 ** undefined behavior.
|
|
jpayne@69
|
7089 **
|
|
jpayne@69
|
7090 ** ^The column is identified by the second, third and fourth parameters to
|
|
jpayne@69
|
7091 ** this function. ^(The second parameter is either the name of the database
|
|
jpayne@69
|
7092 ** (i.e. "main", "temp", or an attached database) containing the specified
|
|
jpayne@69
|
7093 ** table or NULL.)^ ^If it is NULL, then all attached databases are searched
|
|
jpayne@69
|
7094 ** for the table using the same algorithm used by the database engine to
|
|
jpayne@69
|
7095 ** resolve unqualified table references.
|
|
jpayne@69
|
7096 **
|
|
jpayne@69
|
7097 ** ^The third and fourth parameters to this function are the table and column
|
|
jpayne@69
|
7098 ** name of the desired column, respectively.
|
|
jpayne@69
|
7099 **
|
|
jpayne@69
|
7100 ** ^Metadata is returned by writing to the memory locations passed as the 5th
|
|
jpayne@69
|
7101 ** and subsequent parameters to this function. ^Any of these arguments may be
|
|
jpayne@69
|
7102 ** NULL, in which case the corresponding element of metadata is omitted.
|
|
jpayne@69
|
7103 **
|
|
jpayne@69
|
7104 ** ^(<blockquote>
|
|
jpayne@69
|
7105 ** <table border="1">
|
|
jpayne@69
|
7106 ** <tr><th> Parameter <th> Output<br>Type <th> Description
|
|
jpayne@69
|
7107 **
|
|
jpayne@69
|
7108 ** <tr><td> 5th <td> const char* <td> Data type
|
|
jpayne@69
|
7109 ** <tr><td> 6th <td> const char* <td> Name of default collation sequence
|
|
jpayne@69
|
7110 ** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint
|
|
jpayne@69
|
7111 ** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY
|
|
jpayne@69
|
7112 ** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT]
|
|
jpayne@69
|
7113 ** </table>
|
|
jpayne@69
|
7114 ** </blockquote>)^
|
|
jpayne@69
|
7115 **
|
|
jpayne@69
|
7116 ** ^The memory pointed to by the character pointers returned for the
|
|
jpayne@69
|
7117 ** declaration type and collation sequence is valid until the next
|
|
jpayne@69
|
7118 ** call to any SQLite API function.
|
|
jpayne@69
|
7119 **
|
|
jpayne@69
|
7120 ** ^If the specified table is actually a view, an [error code] is returned.
|
|
jpayne@69
|
7121 **
|
|
jpayne@69
|
7122 ** ^If the specified column is "rowid", "oid" or "_rowid_" and the table
|
|
jpayne@69
|
7123 ** is not a [WITHOUT ROWID] table and an
|
|
jpayne@69
|
7124 ** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output
|
|
jpayne@69
|
7125 ** parameters are set for the explicitly declared column. ^(If there is no
|
|
jpayne@69
|
7126 ** [INTEGER PRIMARY KEY] column, then the outputs
|
|
jpayne@69
|
7127 ** for the [rowid] are set as follows:
|
|
jpayne@69
|
7128 **
|
|
jpayne@69
|
7129 ** <pre>
|
|
jpayne@69
|
7130 ** data type: "INTEGER"
|
|
jpayne@69
|
7131 ** collation sequence: "BINARY"
|
|
jpayne@69
|
7132 ** not null: 0
|
|
jpayne@69
|
7133 ** primary key: 1
|
|
jpayne@69
|
7134 ** auto increment: 0
|
|
jpayne@69
|
7135 ** </pre>)^
|
|
jpayne@69
|
7136 **
|
|
jpayne@69
|
7137 ** ^This function causes all database schemas to be read from disk and
|
|
jpayne@69
|
7138 ** parsed, if that has not already been done, and returns an error if
|
|
jpayne@69
|
7139 ** any errors are encountered while loading the schema.
|
|
jpayne@69
|
7140 */
|
|
jpayne@69
|
7141 SQLITE_API int sqlite3_table_column_metadata(
|
|
jpayne@69
|
7142 sqlite3 *db, /* Connection handle */
|
|
jpayne@69
|
7143 const char *zDbName, /* Database name or NULL */
|
|
jpayne@69
|
7144 const char *zTableName, /* Table name */
|
|
jpayne@69
|
7145 const char *zColumnName, /* Column name */
|
|
jpayne@69
|
7146 char const **pzDataType, /* OUTPUT: Declared data type */
|
|
jpayne@69
|
7147 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
|
|
jpayne@69
|
7148 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
|
|
jpayne@69
|
7149 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
|
|
jpayne@69
|
7150 int *pAutoinc /* OUTPUT: True if column is auto-increment */
|
|
jpayne@69
|
7151 );
|
|
jpayne@69
|
7152
|
|
jpayne@69
|
7153 /*
|
|
jpayne@69
|
7154 ** CAPI3REF: Load An Extension
|
|
jpayne@69
|
7155 ** METHOD: sqlite3
|
|
jpayne@69
|
7156 **
|
|
jpayne@69
|
7157 ** ^This interface loads an SQLite extension library from the named file.
|
|
jpayne@69
|
7158 **
|
|
jpayne@69
|
7159 ** ^The sqlite3_load_extension() interface attempts to load an
|
|
jpayne@69
|
7160 ** [SQLite extension] library contained in the file zFile. If
|
|
jpayne@69
|
7161 ** the file cannot be loaded directly, attempts are made to load
|
|
jpayne@69
|
7162 ** with various operating-system specific extensions added.
|
|
jpayne@69
|
7163 ** So for example, if "samplelib" cannot be loaded, then names like
|
|
jpayne@69
|
7164 ** "samplelib.so" or "samplelib.dylib" or "samplelib.dll" might
|
|
jpayne@69
|
7165 ** be tried also.
|
|
jpayne@69
|
7166 **
|
|
jpayne@69
|
7167 ** ^The entry point is zProc.
|
|
jpayne@69
|
7168 ** ^(zProc may be 0, in which case SQLite will try to come up with an
|
|
jpayne@69
|
7169 ** entry point name on its own. It first tries "sqlite3_extension_init".
|
|
jpayne@69
|
7170 ** If that does not work, it constructs a name "sqlite3_X_init" where the
|
|
jpayne@69
|
7171 ** X is consists of the lower-case equivalent of all ASCII alphabetic
|
|
jpayne@69
|
7172 ** characters in the filename from the last "/" to the first following
|
|
jpayne@69
|
7173 ** "." and omitting any initial "lib".)^
|
|
jpayne@69
|
7174 ** ^The sqlite3_load_extension() interface returns
|
|
jpayne@69
|
7175 ** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.
|
|
jpayne@69
|
7176 ** ^If an error occurs and pzErrMsg is not 0, then the
|
|
jpayne@69
|
7177 ** [sqlite3_load_extension()] interface shall attempt to
|
|
jpayne@69
|
7178 ** fill *pzErrMsg with error message text stored in memory
|
|
jpayne@69
|
7179 ** obtained from [sqlite3_malloc()]. The calling function
|
|
jpayne@69
|
7180 ** should free this memory by calling [sqlite3_free()].
|
|
jpayne@69
|
7181 **
|
|
jpayne@69
|
7182 ** ^Extension loading must be enabled using
|
|
jpayne@69
|
7183 ** [sqlite3_enable_load_extension()] or
|
|
jpayne@69
|
7184 ** [sqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],1,NULL)
|
|
jpayne@69
|
7185 ** prior to calling this API,
|
|
jpayne@69
|
7186 ** otherwise an error will be returned.
|
|
jpayne@69
|
7187 **
|
|
jpayne@69
|
7188 ** <b>Security warning:</b> It is recommended that the
|
|
jpayne@69
|
7189 ** [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method be used to enable only this
|
|
jpayne@69
|
7190 ** interface. The use of the [sqlite3_enable_load_extension()] interface
|
|
jpayne@69
|
7191 ** should be avoided. This will keep the SQL function [load_extension()]
|
|
jpayne@69
|
7192 ** disabled and prevent SQL injections from giving attackers
|
|
jpayne@69
|
7193 ** access to extension loading capabilities.
|
|
jpayne@69
|
7194 **
|
|
jpayne@69
|
7195 ** See also the [load_extension() SQL function].
|
|
jpayne@69
|
7196 */
|
|
jpayne@69
|
7197 SQLITE_API int sqlite3_load_extension(
|
|
jpayne@69
|
7198 sqlite3 *db, /* Load the extension into this database connection */
|
|
jpayne@69
|
7199 const char *zFile, /* Name of the shared library containing extension */
|
|
jpayne@69
|
7200 const char *zProc, /* Entry point. Derived from zFile if 0 */
|
|
jpayne@69
|
7201 char **pzErrMsg /* Put error message here if not 0 */
|
|
jpayne@69
|
7202 );
|
|
jpayne@69
|
7203
|
|
jpayne@69
|
7204 /*
|
|
jpayne@69
|
7205 ** CAPI3REF: Enable Or Disable Extension Loading
|
|
jpayne@69
|
7206 ** METHOD: sqlite3
|
|
jpayne@69
|
7207 **
|
|
jpayne@69
|
7208 ** ^So as not to open security holes in older applications that are
|
|
jpayne@69
|
7209 ** unprepared to deal with [extension loading], and as a means of disabling
|
|
jpayne@69
|
7210 ** [extension loading] while evaluating user-entered SQL, the following API
|
|
jpayne@69
|
7211 ** is provided to turn the [sqlite3_load_extension()] mechanism on and off.
|
|
jpayne@69
|
7212 **
|
|
jpayne@69
|
7213 ** ^Extension loading is off by default.
|
|
jpayne@69
|
7214 ** ^Call the sqlite3_enable_load_extension() routine with onoff==1
|
|
jpayne@69
|
7215 ** to turn extension loading on and call it with onoff==0 to turn
|
|
jpayne@69
|
7216 ** it back off again.
|
|
jpayne@69
|
7217 **
|
|
jpayne@69
|
7218 ** ^This interface enables or disables both the C-API
|
|
jpayne@69
|
7219 ** [sqlite3_load_extension()] and the SQL function [load_extension()].
|
|
jpayne@69
|
7220 ** ^(Use [sqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],..)
|
|
jpayne@69
|
7221 ** to enable or disable only the C-API.)^
|
|
jpayne@69
|
7222 **
|
|
jpayne@69
|
7223 ** <b>Security warning:</b> It is recommended that extension loading
|
|
jpayne@69
|
7224 ** be enabled using the [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method
|
|
jpayne@69
|
7225 ** rather than this interface, so the [load_extension()] SQL function
|
|
jpayne@69
|
7226 ** remains disabled. This will prevent SQL injections from giving attackers
|
|
jpayne@69
|
7227 ** access to extension loading capabilities.
|
|
jpayne@69
|
7228 */
|
|
jpayne@69
|
7229 SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff);
|
|
jpayne@69
|
7230
|
|
jpayne@69
|
7231 /*
|
|
jpayne@69
|
7232 ** CAPI3REF: Automatically Load Statically Linked Extensions
|
|
jpayne@69
|
7233 **
|
|
jpayne@69
|
7234 ** ^This interface causes the xEntryPoint() function to be invoked for
|
|
jpayne@69
|
7235 ** each new [database connection] that is created. The idea here is that
|
|
jpayne@69
|
7236 ** xEntryPoint() is the entry point for a statically linked [SQLite extension]
|
|
jpayne@69
|
7237 ** that is to be automatically loaded into all new database connections.
|
|
jpayne@69
|
7238 **
|
|
jpayne@69
|
7239 ** ^(Even though the function prototype shows that xEntryPoint() takes
|
|
jpayne@69
|
7240 ** no arguments and returns void, SQLite invokes xEntryPoint() with three
|
|
jpayne@69
|
7241 ** arguments and expects an integer result as if the signature of the
|
|
jpayne@69
|
7242 ** entry point where as follows:
|
|
jpayne@69
|
7243 **
|
|
jpayne@69
|
7244 ** <blockquote><pre>
|
|
jpayne@69
|
7245 ** int xEntryPoint(
|
|
jpayne@69
|
7246 ** sqlite3 *db,
|
|
jpayne@69
|
7247 ** const char **pzErrMsg,
|
|
jpayne@69
|
7248 ** const struct sqlite3_api_routines *pThunk
|
|
jpayne@69
|
7249 ** );
|
|
jpayne@69
|
7250 ** </pre></blockquote>)^
|
|
jpayne@69
|
7251 **
|
|
jpayne@69
|
7252 ** If the xEntryPoint routine encounters an error, it should make *pzErrMsg
|
|
jpayne@69
|
7253 ** point to an appropriate error message (obtained from [sqlite3_mprintf()])
|
|
jpayne@69
|
7254 ** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg
|
|
jpayne@69
|
7255 ** is NULL before calling the xEntryPoint(). ^SQLite will invoke
|
|
jpayne@69
|
7256 ** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any
|
|
jpayne@69
|
7257 ** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()],
|
|
jpayne@69
|
7258 ** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail.
|
|
jpayne@69
|
7259 **
|
|
jpayne@69
|
7260 ** ^Calling sqlite3_auto_extension(X) with an entry point X that is already
|
|
jpayne@69
|
7261 ** on the list of automatic extensions is a harmless no-op. ^No entry point
|
|
jpayne@69
|
7262 ** will be called more than once for each database connection that is opened.
|
|
jpayne@69
|
7263 **
|
|
jpayne@69
|
7264 ** See also: [sqlite3_reset_auto_extension()]
|
|
jpayne@69
|
7265 ** and [sqlite3_cancel_auto_extension()]
|
|
jpayne@69
|
7266 */
|
|
jpayne@69
|
7267 SQLITE_API int sqlite3_auto_extension(void(*xEntryPoint)(void));
|
|
jpayne@69
|
7268
|
|
jpayne@69
|
7269 /*
|
|
jpayne@69
|
7270 ** CAPI3REF: Cancel Automatic Extension Loading
|
|
jpayne@69
|
7271 **
|
|
jpayne@69
|
7272 ** ^The [sqlite3_cancel_auto_extension(X)] interface unregisters the
|
|
jpayne@69
|
7273 ** initialization routine X that was registered using a prior call to
|
|
jpayne@69
|
7274 ** [sqlite3_auto_extension(X)]. ^The [sqlite3_cancel_auto_extension(X)]
|
|
jpayne@69
|
7275 ** routine returns 1 if initialization routine X was successfully
|
|
jpayne@69
|
7276 ** unregistered and it returns 0 if X was not on the list of initialization
|
|
jpayne@69
|
7277 ** routines.
|
|
jpayne@69
|
7278 */
|
|
jpayne@69
|
7279 SQLITE_API int sqlite3_cancel_auto_extension(void(*xEntryPoint)(void));
|
|
jpayne@69
|
7280
|
|
jpayne@69
|
7281 /*
|
|
jpayne@69
|
7282 ** CAPI3REF: Reset Automatic Extension Loading
|
|
jpayne@69
|
7283 **
|
|
jpayne@69
|
7284 ** ^This interface disables all automatic extensions previously
|
|
jpayne@69
|
7285 ** registered using [sqlite3_auto_extension()].
|
|
jpayne@69
|
7286 */
|
|
jpayne@69
|
7287 SQLITE_API void sqlite3_reset_auto_extension(void);
|
|
jpayne@69
|
7288
|
|
jpayne@69
|
7289 /*
|
|
jpayne@69
|
7290 ** Structures used by the virtual table interface
|
|
jpayne@69
|
7291 */
|
|
jpayne@69
|
7292 typedef struct sqlite3_vtab sqlite3_vtab;
|
|
jpayne@69
|
7293 typedef struct sqlite3_index_info sqlite3_index_info;
|
|
jpayne@69
|
7294 typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor;
|
|
jpayne@69
|
7295 typedef struct sqlite3_module sqlite3_module;
|
|
jpayne@69
|
7296
|
|
jpayne@69
|
7297 /*
|
|
jpayne@69
|
7298 ** CAPI3REF: Virtual Table Object
|
|
jpayne@69
|
7299 ** KEYWORDS: sqlite3_module {virtual table module}
|
|
jpayne@69
|
7300 **
|
|
jpayne@69
|
7301 ** This structure, sometimes called a "virtual table module",
|
|
jpayne@69
|
7302 ** defines the implementation of a [virtual table].
|
|
jpayne@69
|
7303 ** This structure consists mostly of methods for the module.
|
|
jpayne@69
|
7304 **
|
|
jpayne@69
|
7305 ** ^A virtual table module is created by filling in a persistent
|
|
jpayne@69
|
7306 ** instance of this structure and passing a pointer to that instance
|
|
jpayne@69
|
7307 ** to [sqlite3_create_module()] or [sqlite3_create_module_v2()].
|
|
jpayne@69
|
7308 ** ^The registration remains valid until it is replaced by a different
|
|
jpayne@69
|
7309 ** module or until the [database connection] closes. The content
|
|
jpayne@69
|
7310 ** of this structure must not change while it is registered with
|
|
jpayne@69
|
7311 ** any database connection.
|
|
jpayne@69
|
7312 */
|
|
jpayne@69
|
7313 struct sqlite3_module {
|
|
jpayne@69
|
7314 int iVersion;
|
|
jpayne@69
|
7315 int (*xCreate)(sqlite3*, void *pAux,
|
|
jpayne@69
|
7316 int argc, const char *const*argv,
|
|
jpayne@69
|
7317 sqlite3_vtab **ppVTab, char**);
|
|
jpayne@69
|
7318 int (*xConnect)(sqlite3*, void *pAux,
|
|
jpayne@69
|
7319 int argc, const char *const*argv,
|
|
jpayne@69
|
7320 sqlite3_vtab **ppVTab, char**);
|
|
jpayne@69
|
7321 int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*);
|
|
jpayne@69
|
7322 int (*xDisconnect)(sqlite3_vtab *pVTab);
|
|
jpayne@69
|
7323 int (*xDestroy)(sqlite3_vtab *pVTab);
|
|
jpayne@69
|
7324 int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor);
|
|
jpayne@69
|
7325 int (*xClose)(sqlite3_vtab_cursor*);
|
|
jpayne@69
|
7326 int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr,
|
|
jpayne@69
|
7327 int argc, sqlite3_value **argv);
|
|
jpayne@69
|
7328 int (*xNext)(sqlite3_vtab_cursor*);
|
|
jpayne@69
|
7329 int (*xEof)(sqlite3_vtab_cursor*);
|
|
jpayne@69
|
7330 int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int);
|
|
jpayne@69
|
7331 int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid);
|
|
jpayne@69
|
7332 int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *);
|
|
jpayne@69
|
7333 int (*xBegin)(sqlite3_vtab *pVTab);
|
|
jpayne@69
|
7334 int (*xSync)(sqlite3_vtab *pVTab);
|
|
jpayne@69
|
7335 int (*xCommit)(sqlite3_vtab *pVTab);
|
|
jpayne@69
|
7336 int (*xRollback)(sqlite3_vtab *pVTab);
|
|
jpayne@69
|
7337 int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName,
|
|
jpayne@69
|
7338 void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),
|
|
jpayne@69
|
7339 void **ppArg);
|
|
jpayne@69
|
7340 int (*xRename)(sqlite3_vtab *pVtab, const char *zNew);
|
|
jpayne@69
|
7341 /* The methods above are in version 1 of the sqlite_module object. Those
|
|
jpayne@69
|
7342 ** below are for version 2 and greater. */
|
|
jpayne@69
|
7343 int (*xSavepoint)(sqlite3_vtab *pVTab, int);
|
|
jpayne@69
|
7344 int (*xRelease)(sqlite3_vtab *pVTab, int);
|
|
jpayne@69
|
7345 int (*xRollbackTo)(sqlite3_vtab *pVTab, int);
|
|
jpayne@69
|
7346 /* The methods above are in versions 1 and 2 of the sqlite_module object.
|
|
jpayne@69
|
7347 ** Those below are for version 3 and greater. */
|
|
jpayne@69
|
7348 int (*xShadowName)(const char*);
|
|
jpayne@69
|
7349 /* The methods above are in versions 1 through 3 of the sqlite_module object.
|
|
jpayne@69
|
7350 ** Those below are for version 4 and greater. */
|
|
jpayne@69
|
7351 int (*xIntegrity)(sqlite3_vtab *pVTab, const char *zSchema,
|
|
jpayne@69
|
7352 const char *zTabName, int mFlags, char **pzErr);
|
|
jpayne@69
|
7353 };
|
|
jpayne@69
|
7354
|
|
jpayne@69
|
7355 /*
|
|
jpayne@69
|
7356 ** CAPI3REF: Virtual Table Indexing Information
|
|
jpayne@69
|
7357 ** KEYWORDS: sqlite3_index_info
|
|
jpayne@69
|
7358 **
|
|
jpayne@69
|
7359 ** The sqlite3_index_info structure and its substructures is used as part
|
|
jpayne@69
|
7360 ** of the [virtual table] interface to
|
|
jpayne@69
|
7361 ** pass information into and receive the reply from the [xBestIndex]
|
|
jpayne@69
|
7362 ** method of a [virtual table module]. The fields under **Inputs** are the
|
|
jpayne@69
|
7363 ** inputs to xBestIndex and are read-only. xBestIndex inserts its
|
|
jpayne@69
|
7364 ** results into the **Outputs** fields.
|
|
jpayne@69
|
7365 **
|
|
jpayne@69
|
7366 ** ^(The aConstraint[] array records WHERE clause constraints of the form:
|
|
jpayne@69
|
7367 **
|
|
jpayne@69
|
7368 ** <blockquote>column OP expr</blockquote>
|
|
jpayne@69
|
7369 **
|
|
jpayne@69
|
7370 ** where OP is =, <, <=, >, or >=.)^ ^(The particular operator is
|
|
jpayne@69
|
7371 ** stored in aConstraint[].op using one of the
|
|
jpayne@69
|
7372 ** [SQLITE_INDEX_CONSTRAINT_EQ | SQLITE_INDEX_CONSTRAINT_ values].)^
|
|
jpayne@69
|
7373 ** ^(The index of the column is stored in
|
|
jpayne@69
|
7374 ** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the
|
|
jpayne@69
|
7375 ** expr on the right-hand side can be evaluated (and thus the constraint
|
|
jpayne@69
|
7376 ** is usable) and false if it cannot.)^
|
|
jpayne@69
|
7377 **
|
|
jpayne@69
|
7378 ** ^The optimizer automatically inverts terms of the form "expr OP column"
|
|
jpayne@69
|
7379 ** and makes other simplifications to the WHERE clause in an attempt to
|
|
jpayne@69
|
7380 ** get as many WHERE clause terms into the form shown above as possible.
|
|
jpayne@69
|
7381 ** ^The aConstraint[] array only reports WHERE clause terms that are
|
|
jpayne@69
|
7382 ** relevant to the particular virtual table being queried.
|
|
jpayne@69
|
7383 **
|
|
jpayne@69
|
7384 ** ^Information about the ORDER BY clause is stored in aOrderBy[].
|
|
jpayne@69
|
7385 ** ^Each term of aOrderBy records a column of the ORDER BY clause.
|
|
jpayne@69
|
7386 **
|
|
jpayne@69
|
7387 ** The colUsed field indicates which columns of the virtual table may be
|
|
jpayne@69
|
7388 ** required by the current scan. Virtual table columns are numbered from
|
|
jpayne@69
|
7389 ** zero in the order in which they appear within the CREATE TABLE statement
|
|
jpayne@69
|
7390 ** passed to sqlite3_declare_vtab(). For the first 63 columns (columns 0-62),
|
|
jpayne@69
|
7391 ** the corresponding bit is set within the colUsed mask if the column may be
|
|
jpayne@69
|
7392 ** required by SQLite. If the table has at least 64 columns and any column
|
|
jpayne@69
|
7393 ** to the right of the first 63 is required, then bit 63 of colUsed is also
|
|
jpayne@69
|
7394 ** set. In other words, column iCol may be required if the expression
|
|
jpayne@69
|
7395 ** (colUsed & ((sqlite3_uint64)1 << (iCol>=63 ? 63 : iCol))) evaluates to
|
|
jpayne@69
|
7396 ** non-zero.
|
|
jpayne@69
|
7397 **
|
|
jpayne@69
|
7398 ** The [xBestIndex] method must fill aConstraintUsage[] with information
|
|
jpayne@69
|
7399 ** about what parameters to pass to xFilter. ^If argvIndex>0 then
|
|
jpayne@69
|
7400 ** the right-hand side of the corresponding aConstraint[] is evaluated
|
|
jpayne@69
|
7401 ** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit
|
|
jpayne@69
|
7402 ** is true, then the constraint is assumed to be fully handled by the
|
|
jpayne@69
|
7403 ** virtual table and might not be checked again by the byte code.)^ ^(The
|
|
jpayne@69
|
7404 ** aConstraintUsage[].omit flag is an optimization hint. When the omit flag
|
|
jpayne@69
|
7405 ** is left in its default setting of false, the constraint will always be
|
|
jpayne@69
|
7406 ** checked separately in byte code. If the omit flag is change to true, then
|
|
jpayne@69
|
7407 ** the constraint may or may not be checked in byte code. In other words,
|
|
jpayne@69
|
7408 ** when the omit flag is true there is no guarantee that the constraint will
|
|
jpayne@69
|
7409 ** not be checked again using byte code.)^
|
|
jpayne@69
|
7410 **
|
|
jpayne@69
|
7411 ** ^The idxNum and idxStr values are recorded and passed into the
|
|
jpayne@69
|
7412 ** [xFilter] method.
|
|
jpayne@69
|
7413 ** ^[sqlite3_free()] is used to free idxStr if and only if
|
|
jpayne@69
|
7414 ** needToFreeIdxStr is true.
|
|
jpayne@69
|
7415 **
|
|
jpayne@69
|
7416 ** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in
|
|
jpayne@69
|
7417 ** the correct order to satisfy the ORDER BY clause so that no separate
|
|
jpayne@69
|
7418 ** sorting step is required.
|
|
jpayne@69
|
7419 **
|
|
jpayne@69
|
7420 ** ^The estimatedCost value is an estimate of the cost of a particular
|
|
jpayne@69
|
7421 ** strategy. A cost of N indicates that the cost of the strategy is similar
|
|
jpayne@69
|
7422 ** to a linear scan of an SQLite table with N rows. A cost of log(N)
|
|
jpayne@69
|
7423 ** indicates that the expense of the operation is similar to that of a
|
|
jpayne@69
|
7424 ** binary search on a unique indexed field of an SQLite table with N rows.
|
|
jpayne@69
|
7425 **
|
|
jpayne@69
|
7426 ** ^The estimatedRows value is an estimate of the number of rows that
|
|
jpayne@69
|
7427 ** will be returned by the strategy.
|
|
jpayne@69
|
7428 **
|
|
jpayne@69
|
7429 ** The xBestIndex method may optionally populate the idxFlags field with a
|
|
jpayne@69
|
7430 ** mask of SQLITE_INDEX_SCAN_* flags. Currently there is only one such flag -
|
|
jpayne@69
|
7431 ** SQLITE_INDEX_SCAN_UNIQUE. If the xBestIndex method sets this flag, SQLite
|
|
jpayne@69
|
7432 ** assumes that the strategy may visit at most one row.
|
|
jpayne@69
|
7433 **
|
|
jpayne@69
|
7434 ** Additionally, if xBestIndex sets the SQLITE_INDEX_SCAN_UNIQUE flag, then
|
|
jpayne@69
|
7435 ** SQLite also assumes that if a call to the xUpdate() method is made as
|
|
jpayne@69
|
7436 ** part of the same statement to delete or update a virtual table row and the
|
|
jpayne@69
|
7437 ** implementation returns SQLITE_CONSTRAINT, then there is no need to rollback
|
|
jpayne@69
|
7438 ** any database changes. In other words, if the xUpdate() returns
|
|
jpayne@69
|
7439 ** SQLITE_CONSTRAINT, the database contents must be exactly as they were
|
|
jpayne@69
|
7440 ** before xUpdate was called. By contrast, if SQLITE_INDEX_SCAN_UNIQUE is not
|
|
jpayne@69
|
7441 ** set and xUpdate returns SQLITE_CONSTRAINT, any database changes made by
|
|
jpayne@69
|
7442 ** the xUpdate method are automatically rolled back by SQLite.
|
|
jpayne@69
|
7443 **
|
|
jpayne@69
|
7444 ** IMPORTANT: The estimatedRows field was added to the sqlite3_index_info
|
|
jpayne@69
|
7445 ** structure for SQLite [version 3.8.2] ([dateof:3.8.2]).
|
|
jpayne@69
|
7446 ** If a virtual table extension is
|
|
jpayne@69
|
7447 ** used with an SQLite version earlier than 3.8.2, the results of attempting
|
|
jpayne@69
|
7448 ** to read or write the estimatedRows field are undefined (but are likely
|
|
jpayne@69
|
7449 ** to include crashing the application). The estimatedRows field should
|
|
jpayne@69
|
7450 ** therefore only be used if [sqlite3_libversion_number()] returns a
|
|
jpayne@69
|
7451 ** value greater than or equal to 3008002. Similarly, the idxFlags field
|
|
jpayne@69
|
7452 ** was added for [version 3.9.0] ([dateof:3.9.0]).
|
|
jpayne@69
|
7453 ** It may therefore only be used if
|
|
jpayne@69
|
7454 ** sqlite3_libversion_number() returns a value greater than or equal to
|
|
jpayne@69
|
7455 ** 3009000.
|
|
jpayne@69
|
7456 */
|
|
jpayne@69
|
7457 struct sqlite3_index_info {
|
|
jpayne@69
|
7458 /* Inputs */
|
|
jpayne@69
|
7459 int nConstraint; /* Number of entries in aConstraint */
|
|
jpayne@69
|
7460 struct sqlite3_index_constraint {
|
|
jpayne@69
|
7461 int iColumn; /* Column constrained. -1 for ROWID */
|
|
jpayne@69
|
7462 unsigned char op; /* Constraint operator */
|
|
jpayne@69
|
7463 unsigned char usable; /* True if this constraint is usable */
|
|
jpayne@69
|
7464 int iTermOffset; /* Used internally - xBestIndex should ignore */
|
|
jpayne@69
|
7465 } *aConstraint; /* Table of WHERE clause constraints */
|
|
jpayne@69
|
7466 int nOrderBy; /* Number of terms in the ORDER BY clause */
|
|
jpayne@69
|
7467 struct sqlite3_index_orderby {
|
|
jpayne@69
|
7468 int iColumn; /* Column number */
|
|
jpayne@69
|
7469 unsigned char desc; /* True for DESC. False for ASC. */
|
|
jpayne@69
|
7470 } *aOrderBy; /* The ORDER BY clause */
|
|
jpayne@69
|
7471 /* Outputs */
|
|
jpayne@69
|
7472 struct sqlite3_index_constraint_usage {
|
|
jpayne@69
|
7473 int argvIndex; /* if >0, constraint is part of argv to xFilter */
|
|
jpayne@69
|
7474 unsigned char omit; /* Do not code a test for this constraint */
|
|
jpayne@69
|
7475 } *aConstraintUsage;
|
|
jpayne@69
|
7476 int idxNum; /* Number used to identify the index */
|
|
jpayne@69
|
7477 char *idxStr; /* String, possibly obtained from sqlite3_malloc */
|
|
jpayne@69
|
7478 int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */
|
|
jpayne@69
|
7479 int orderByConsumed; /* True if output is already ordered */
|
|
jpayne@69
|
7480 double estimatedCost; /* Estimated cost of using this index */
|
|
jpayne@69
|
7481 /* Fields below are only available in SQLite 3.8.2 and later */
|
|
jpayne@69
|
7482 sqlite3_int64 estimatedRows; /* Estimated number of rows returned */
|
|
jpayne@69
|
7483 /* Fields below are only available in SQLite 3.9.0 and later */
|
|
jpayne@69
|
7484 int idxFlags; /* Mask of SQLITE_INDEX_SCAN_* flags */
|
|
jpayne@69
|
7485 /* Fields below are only available in SQLite 3.10.0 and later */
|
|
jpayne@69
|
7486 sqlite3_uint64 colUsed; /* Input: Mask of columns used by statement */
|
|
jpayne@69
|
7487 };
|
|
jpayne@69
|
7488
|
|
jpayne@69
|
7489 /*
|
|
jpayne@69
|
7490 ** CAPI3REF: Virtual Table Scan Flags
|
|
jpayne@69
|
7491 **
|
|
jpayne@69
|
7492 ** Virtual table implementations are allowed to set the
|
|
jpayne@69
|
7493 ** [sqlite3_index_info].idxFlags field to some combination of
|
|
jpayne@69
|
7494 ** these bits.
|
|
jpayne@69
|
7495 */
|
|
jpayne@69
|
7496 #define SQLITE_INDEX_SCAN_UNIQUE 1 /* Scan visits at most 1 row */
|
|
jpayne@69
|
7497
|
|
jpayne@69
|
7498 /*
|
|
jpayne@69
|
7499 ** CAPI3REF: Virtual Table Constraint Operator Codes
|
|
jpayne@69
|
7500 **
|
|
jpayne@69
|
7501 ** These macros define the allowed values for the
|
|
jpayne@69
|
7502 ** [sqlite3_index_info].aConstraint[].op field. Each value represents
|
|
jpayne@69
|
7503 ** an operator that is part of a constraint term in the WHERE clause of
|
|
jpayne@69
|
7504 ** a query that uses a [virtual table].
|
|
jpayne@69
|
7505 **
|
|
jpayne@69
|
7506 ** ^The left-hand operand of the operator is given by the corresponding
|
|
jpayne@69
|
7507 ** aConstraint[].iColumn field. ^An iColumn of -1 indicates the left-hand
|
|
jpayne@69
|
7508 ** operand is the rowid.
|
|
jpayne@69
|
7509 ** The SQLITE_INDEX_CONSTRAINT_LIMIT and SQLITE_INDEX_CONSTRAINT_OFFSET
|
|
jpayne@69
|
7510 ** operators have no left-hand operand, and so for those operators the
|
|
jpayne@69
|
7511 ** corresponding aConstraint[].iColumn is meaningless and should not be
|
|
jpayne@69
|
7512 ** used.
|
|
jpayne@69
|
7513 **
|
|
jpayne@69
|
7514 ** All operator values from SQLITE_INDEX_CONSTRAINT_FUNCTION through
|
|
jpayne@69
|
7515 ** value 255 are reserved to represent functions that are overloaded
|
|
jpayne@69
|
7516 ** by the [xFindFunction|xFindFunction method] of the virtual table
|
|
jpayne@69
|
7517 ** implementation.
|
|
jpayne@69
|
7518 **
|
|
jpayne@69
|
7519 ** The right-hand operands for each constraint might be accessible using
|
|
jpayne@69
|
7520 ** the [sqlite3_vtab_rhs_value()] interface. Usually the right-hand
|
|
jpayne@69
|
7521 ** operand is only available if it appears as a single constant literal
|
|
jpayne@69
|
7522 ** in the input SQL. If the right-hand operand is another column or an
|
|
jpayne@69
|
7523 ** expression (even a constant expression) or a parameter, then the
|
|
jpayne@69
|
7524 ** sqlite3_vtab_rhs_value() probably will not be able to extract it.
|
|
jpayne@69
|
7525 ** ^The SQLITE_INDEX_CONSTRAINT_ISNULL and
|
|
jpayne@69
|
7526 ** SQLITE_INDEX_CONSTRAINT_ISNOTNULL operators have no right-hand operand
|
|
jpayne@69
|
7527 ** and hence calls to sqlite3_vtab_rhs_value() for those operators will
|
|
jpayne@69
|
7528 ** always return SQLITE_NOTFOUND.
|
|
jpayne@69
|
7529 **
|
|
jpayne@69
|
7530 ** The collating sequence to be used for comparison can be found using
|
|
jpayne@69
|
7531 ** the [sqlite3_vtab_collation()] interface. For most real-world virtual
|
|
jpayne@69
|
7532 ** tables, the collating sequence of constraints does not matter (for example
|
|
jpayne@69
|
7533 ** because the constraints are numeric) and so the sqlite3_vtab_collation()
|
|
jpayne@69
|
7534 ** interface is not commonly needed.
|
|
jpayne@69
|
7535 */
|
|
jpayne@69
|
7536 #define SQLITE_INDEX_CONSTRAINT_EQ 2
|
|
jpayne@69
|
7537 #define SQLITE_INDEX_CONSTRAINT_GT 4
|
|
jpayne@69
|
7538 #define SQLITE_INDEX_CONSTRAINT_LE 8
|
|
jpayne@69
|
7539 #define SQLITE_INDEX_CONSTRAINT_LT 16
|
|
jpayne@69
|
7540 #define SQLITE_INDEX_CONSTRAINT_GE 32
|
|
jpayne@69
|
7541 #define SQLITE_INDEX_CONSTRAINT_MATCH 64
|
|
jpayne@69
|
7542 #define SQLITE_INDEX_CONSTRAINT_LIKE 65
|
|
jpayne@69
|
7543 #define SQLITE_INDEX_CONSTRAINT_GLOB 66
|
|
jpayne@69
|
7544 #define SQLITE_INDEX_CONSTRAINT_REGEXP 67
|
|
jpayne@69
|
7545 #define SQLITE_INDEX_CONSTRAINT_NE 68
|
|
jpayne@69
|
7546 #define SQLITE_INDEX_CONSTRAINT_ISNOT 69
|
|
jpayne@69
|
7547 #define SQLITE_INDEX_CONSTRAINT_ISNOTNULL 70
|
|
jpayne@69
|
7548 #define SQLITE_INDEX_CONSTRAINT_ISNULL 71
|
|
jpayne@69
|
7549 #define SQLITE_INDEX_CONSTRAINT_IS 72
|
|
jpayne@69
|
7550 #define SQLITE_INDEX_CONSTRAINT_LIMIT 73
|
|
jpayne@69
|
7551 #define SQLITE_INDEX_CONSTRAINT_OFFSET 74
|
|
jpayne@69
|
7552 #define SQLITE_INDEX_CONSTRAINT_FUNCTION 150
|
|
jpayne@69
|
7553
|
|
jpayne@69
|
7554 /*
|
|
jpayne@69
|
7555 ** CAPI3REF: Register A Virtual Table Implementation
|
|
jpayne@69
|
7556 ** METHOD: sqlite3
|
|
jpayne@69
|
7557 **
|
|
jpayne@69
|
7558 ** ^These routines are used to register a new [virtual table module] name.
|
|
jpayne@69
|
7559 ** ^Module names must be registered before
|
|
jpayne@69
|
7560 ** creating a new [virtual table] using the module and before using a
|
|
jpayne@69
|
7561 ** preexisting [virtual table] for the module.
|
|
jpayne@69
|
7562 **
|
|
jpayne@69
|
7563 ** ^The module name is registered on the [database connection] specified
|
|
jpayne@69
|
7564 ** by the first parameter. ^The name of the module is given by the
|
|
jpayne@69
|
7565 ** second parameter. ^The third parameter is a pointer to
|
|
jpayne@69
|
7566 ** the implementation of the [virtual table module]. ^The fourth
|
|
jpayne@69
|
7567 ** parameter is an arbitrary client data pointer that is passed through
|
|
jpayne@69
|
7568 ** into the [xCreate] and [xConnect] methods of the virtual table module
|
|
jpayne@69
|
7569 ** when a new virtual table is be being created or reinitialized.
|
|
jpayne@69
|
7570 **
|
|
jpayne@69
|
7571 ** ^The sqlite3_create_module_v2() interface has a fifth parameter which
|
|
jpayne@69
|
7572 ** is a pointer to a destructor for the pClientData. ^SQLite will
|
|
jpayne@69
|
7573 ** invoke the destructor function (if it is not NULL) when SQLite
|
|
jpayne@69
|
7574 ** no longer needs the pClientData pointer. ^The destructor will also
|
|
jpayne@69
|
7575 ** be invoked if the call to sqlite3_create_module_v2() fails.
|
|
jpayne@69
|
7576 ** ^The sqlite3_create_module()
|
|
jpayne@69
|
7577 ** interface is equivalent to sqlite3_create_module_v2() with a NULL
|
|
jpayne@69
|
7578 ** destructor.
|
|
jpayne@69
|
7579 **
|
|
jpayne@69
|
7580 ** ^If the third parameter (the pointer to the sqlite3_module object) is
|
|
jpayne@69
|
7581 ** NULL then no new module is created and any existing modules with the
|
|
jpayne@69
|
7582 ** same name are dropped.
|
|
jpayne@69
|
7583 **
|
|
jpayne@69
|
7584 ** See also: [sqlite3_drop_modules()]
|
|
jpayne@69
|
7585 */
|
|
jpayne@69
|
7586 SQLITE_API int sqlite3_create_module(
|
|
jpayne@69
|
7587 sqlite3 *db, /* SQLite connection to register module with */
|
|
jpayne@69
|
7588 const char *zName, /* Name of the module */
|
|
jpayne@69
|
7589 const sqlite3_module *p, /* Methods for the module */
|
|
jpayne@69
|
7590 void *pClientData /* Client data for xCreate/xConnect */
|
|
jpayne@69
|
7591 );
|
|
jpayne@69
|
7592 SQLITE_API int sqlite3_create_module_v2(
|
|
jpayne@69
|
7593 sqlite3 *db, /* SQLite connection to register module with */
|
|
jpayne@69
|
7594 const char *zName, /* Name of the module */
|
|
jpayne@69
|
7595 const sqlite3_module *p, /* Methods for the module */
|
|
jpayne@69
|
7596 void *pClientData, /* Client data for xCreate/xConnect */
|
|
jpayne@69
|
7597 void(*xDestroy)(void*) /* Module destructor function */
|
|
jpayne@69
|
7598 );
|
|
jpayne@69
|
7599
|
|
jpayne@69
|
7600 /*
|
|
jpayne@69
|
7601 ** CAPI3REF: Remove Unnecessary Virtual Table Implementations
|
|
jpayne@69
|
7602 ** METHOD: sqlite3
|
|
jpayne@69
|
7603 **
|
|
jpayne@69
|
7604 ** ^The sqlite3_drop_modules(D,L) interface removes all virtual
|
|
jpayne@69
|
7605 ** table modules from database connection D except those named on list L.
|
|
jpayne@69
|
7606 ** The L parameter must be either NULL or a pointer to an array of pointers
|
|
jpayne@69
|
7607 ** to strings where the array is terminated by a single NULL pointer.
|
|
jpayne@69
|
7608 ** ^If the L parameter is NULL, then all virtual table modules are removed.
|
|
jpayne@69
|
7609 **
|
|
jpayne@69
|
7610 ** See also: [sqlite3_create_module()]
|
|
jpayne@69
|
7611 */
|
|
jpayne@69
|
7612 SQLITE_API int sqlite3_drop_modules(
|
|
jpayne@69
|
7613 sqlite3 *db, /* Remove modules from this connection */
|
|
jpayne@69
|
7614 const char **azKeep /* Except, do not remove the ones named here */
|
|
jpayne@69
|
7615 );
|
|
jpayne@69
|
7616
|
|
jpayne@69
|
7617 /*
|
|
jpayne@69
|
7618 ** CAPI3REF: Virtual Table Instance Object
|
|
jpayne@69
|
7619 ** KEYWORDS: sqlite3_vtab
|
|
jpayne@69
|
7620 **
|
|
jpayne@69
|
7621 ** Every [virtual table module] implementation uses a subclass
|
|
jpayne@69
|
7622 ** of this object to describe a particular instance
|
|
jpayne@69
|
7623 ** of the [virtual table]. Each subclass will
|
|
jpayne@69
|
7624 ** be tailored to the specific needs of the module implementation.
|
|
jpayne@69
|
7625 ** The purpose of this superclass is to define certain fields that are
|
|
jpayne@69
|
7626 ** common to all module implementations.
|
|
jpayne@69
|
7627 **
|
|
jpayne@69
|
7628 ** ^Virtual tables methods can set an error message by assigning a
|
|
jpayne@69
|
7629 ** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should
|
|
jpayne@69
|
7630 ** take care that any prior string is freed by a call to [sqlite3_free()]
|
|
jpayne@69
|
7631 ** prior to assigning a new string to zErrMsg. ^After the error message
|
|
jpayne@69
|
7632 ** is delivered up to the client application, the string will be automatically
|
|
jpayne@69
|
7633 ** freed by sqlite3_free() and the zErrMsg field will be zeroed.
|
|
jpayne@69
|
7634 */
|
|
jpayne@69
|
7635 struct sqlite3_vtab {
|
|
jpayne@69
|
7636 const sqlite3_module *pModule; /* The module for this virtual table */
|
|
jpayne@69
|
7637 int nRef; /* Number of open cursors */
|
|
jpayne@69
|
7638 char *zErrMsg; /* Error message from sqlite3_mprintf() */
|
|
jpayne@69
|
7639 /* Virtual table implementations will typically add additional fields */
|
|
jpayne@69
|
7640 };
|
|
jpayne@69
|
7641
|
|
jpayne@69
|
7642 /*
|
|
jpayne@69
|
7643 ** CAPI3REF: Virtual Table Cursor Object
|
|
jpayne@69
|
7644 ** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor}
|
|
jpayne@69
|
7645 **
|
|
jpayne@69
|
7646 ** Every [virtual table module] implementation uses a subclass of the
|
|
jpayne@69
|
7647 ** following structure to describe cursors that point into the
|
|
jpayne@69
|
7648 ** [virtual table] and are used
|
|
jpayne@69
|
7649 ** to loop through the virtual table. Cursors are created using the
|
|
jpayne@69
|
7650 ** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed
|
|
jpayne@69
|
7651 ** by the [sqlite3_module.xClose | xClose] method. Cursors are used
|
|
jpayne@69
|
7652 ** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods
|
|
jpayne@69
|
7653 ** of the module. Each module implementation will define
|
|
jpayne@69
|
7654 ** the content of a cursor structure to suit its own needs.
|
|
jpayne@69
|
7655 **
|
|
jpayne@69
|
7656 ** This superclass exists in order to define fields of the cursor that
|
|
jpayne@69
|
7657 ** are common to all implementations.
|
|
jpayne@69
|
7658 */
|
|
jpayne@69
|
7659 struct sqlite3_vtab_cursor {
|
|
jpayne@69
|
7660 sqlite3_vtab *pVtab; /* Virtual table of this cursor */
|
|
jpayne@69
|
7661 /* Virtual table implementations will typically add additional fields */
|
|
jpayne@69
|
7662 };
|
|
jpayne@69
|
7663
|
|
jpayne@69
|
7664 /*
|
|
jpayne@69
|
7665 ** CAPI3REF: Declare The Schema Of A Virtual Table
|
|
jpayne@69
|
7666 **
|
|
jpayne@69
|
7667 ** ^The [xCreate] and [xConnect] methods of a
|
|
jpayne@69
|
7668 ** [virtual table module] call this interface
|
|
jpayne@69
|
7669 ** to declare the format (the names and datatypes of the columns) of
|
|
jpayne@69
|
7670 ** the virtual tables they implement.
|
|
jpayne@69
|
7671 */
|
|
jpayne@69
|
7672 SQLITE_API int sqlite3_declare_vtab(sqlite3*, const char *zSQL);
|
|
jpayne@69
|
7673
|
|
jpayne@69
|
7674 /*
|
|
jpayne@69
|
7675 ** CAPI3REF: Overload A Function For A Virtual Table
|
|
jpayne@69
|
7676 ** METHOD: sqlite3
|
|
jpayne@69
|
7677 **
|
|
jpayne@69
|
7678 ** ^(Virtual tables can provide alternative implementations of functions
|
|
jpayne@69
|
7679 ** using the [xFindFunction] method of the [virtual table module].
|
|
jpayne@69
|
7680 ** But global versions of those functions
|
|
jpayne@69
|
7681 ** must exist in order to be overloaded.)^
|
|
jpayne@69
|
7682 **
|
|
jpayne@69
|
7683 ** ^(This API makes sure a global version of a function with a particular
|
|
jpayne@69
|
7684 ** name and number of parameters exists. If no such function exists
|
|
jpayne@69
|
7685 ** before this API is called, a new function is created.)^ ^The implementation
|
|
jpayne@69
|
7686 ** of the new function always causes an exception to be thrown. So
|
|
jpayne@69
|
7687 ** the new function is not good for anything by itself. Its only
|
|
jpayne@69
|
7688 ** purpose is to be a placeholder function that can be overloaded
|
|
jpayne@69
|
7689 ** by a [virtual table].
|
|
jpayne@69
|
7690 */
|
|
jpayne@69
|
7691 SQLITE_API int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg);
|
|
jpayne@69
|
7692
|
|
jpayne@69
|
7693 /*
|
|
jpayne@69
|
7694 ** CAPI3REF: A Handle To An Open BLOB
|
|
jpayne@69
|
7695 ** KEYWORDS: {BLOB handle} {BLOB handles}
|
|
jpayne@69
|
7696 **
|
|
jpayne@69
|
7697 ** An instance of this object represents an open BLOB on which
|
|
jpayne@69
|
7698 ** [sqlite3_blob_open | incremental BLOB I/O] can be performed.
|
|
jpayne@69
|
7699 ** ^Objects of this type are created by [sqlite3_blob_open()]
|
|
jpayne@69
|
7700 ** and destroyed by [sqlite3_blob_close()].
|
|
jpayne@69
|
7701 ** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces
|
|
jpayne@69
|
7702 ** can be used to read or write small subsections of the BLOB.
|
|
jpayne@69
|
7703 ** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes.
|
|
jpayne@69
|
7704 */
|
|
jpayne@69
|
7705 typedef struct sqlite3_blob sqlite3_blob;
|
|
jpayne@69
|
7706
|
|
jpayne@69
|
7707 /*
|
|
jpayne@69
|
7708 ** CAPI3REF: Open A BLOB For Incremental I/O
|
|
jpayne@69
|
7709 ** METHOD: sqlite3
|
|
jpayne@69
|
7710 ** CONSTRUCTOR: sqlite3_blob
|
|
jpayne@69
|
7711 **
|
|
jpayne@69
|
7712 ** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located
|
|
jpayne@69
|
7713 ** in row iRow, column zColumn, table zTable in database zDb;
|
|
jpayne@69
|
7714 ** in other words, the same BLOB that would be selected by:
|
|
jpayne@69
|
7715 **
|
|
jpayne@69
|
7716 ** <pre>
|
|
jpayne@69
|
7717 ** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow;
|
|
jpayne@69
|
7718 ** </pre>)^
|
|
jpayne@69
|
7719 **
|
|
jpayne@69
|
7720 ** ^(Parameter zDb is not the filename that contains the database, but
|
|
jpayne@69
|
7721 ** rather the symbolic name of the database. For attached databases, this is
|
|
jpayne@69
|
7722 ** the name that appears after the AS keyword in the [ATTACH] statement.
|
|
jpayne@69
|
7723 ** For the main database file, the database name is "main". For TEMP
|
|
jpayne@69
|
7724 ** tables, the database name is "temp".)^
|
|
jpayne@69
|
7725 **
|
|
jpayne@69
|
7726 ** ^If the flags parameter is non-zero, then the BLOB is opened for read
|
|
jpayne@69
|
7727 ** and write access. ^If the flags parameter is zero, the BLOB is opened for
|
|
jpayne@69
|
7728 ** read-only access.
|
|
jpayne@69
|
7729 **
|
|
jpayne@69
|
7730 ** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is stored
|
|
jpayne@69
|
7731 ** in *ppBlob. Otherwise an [error code] is returned and, unless the error
|
|
jpayne@69
|
7732 ** code is SQLITE_MISUSE, *ppBlob is set to NULL.)^ ^This means that, provided
|
|
jpayne@69
|
7733 ** the API is not misused, it is always safe to call [sqlite3_blob_close()]
|
|
jpayne@69
|
7734 ** on *ppBlob after this function it returns.
|
|
jpayne@69
|
7735 **
|
|
jpayne@69
|
7736 ** This function fails with SQLITE_ERROR if any of the following are true:
|
|
jpayne@69
|
7737 ** <ul>
|
|
jpayne@69
|
7738 ** <li> ^(Database zDb does not exist)^,
|
|
jpayne@69
|
7739 ** <li> ^(Table zTable does not exist within database zDb)^,
|
|
jpayne@69
|
7740 ** <li> ^(Table zTable is a WITHOUT ROWID table)^,
|
|
jpayne@69
|
7741 ** <li> ^(Column zColumn does not exist)^,
|
|
jpayne@69
|
7742 ** <li> ^(Row iRow is not present in the table)^,
|
|
jpayne@69
|
7743 ** <li> ^(The specified column of row iRow contains a value that is not
|
|
jpayne@69
|
7744 ** a TEXT or BLOB value)^,
|
|
jpayne@69
|
7745 ** <li> ^(Column zColumn is part of an index, PRIMARY KEY or UNIQUE
|
|
jpayne@69
|
7746 ** constraint and the blob is being opened for read/write access)^,
|
|
jpayne@69
|
7747 ** <li> ^([foreign key constraints | Foreign key constraints] are enabled,
|
|
jpayne@69
|
7748 ** column zColumn is part of a [child key] definition and the blob is
|
|
jpayne@69
|
7749 ** being opened for read/write access)^.
|
|
jpayne@69
|
7750 ** </ul>
|
|
jpayne@69
|
7751 **
|
|
jpayne@69
|
7752 ** ^Unless it returns SQLITE_MISUSE, this function sets the
|
|
jpayne@69
|
7753 ** [database connection] error code and message accessible via
|
|
jpayne@69
|
7754 ** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions.
|
|
jpayne@69
|
7755 **
|
|
jpayne@69
|
7756 ** A BLOB referenced by sqlite3_blob_open() may be read using the
|
|
jpayne@69
|
7757 ** [sqlite3_blob_read()] interface and modified by using
|
|
jpayne@69
|
7758 ** [sqlite3_blob_write()]. The [BLOB handle] can be moved to a
|
|
jpayne@69
|
7759 ** different row of the same table using the [sqlite3_blob_reopen()]
|
|
jpayne@69
|
7760 ** interface. However, the column, table, or database of a [BLOB handle]
|
|
jpayne@69
|
7761 ** cannot be changed after the [BLOB handle] is opened.
|
|
jpayne@69
|
7762 **
|
|
jpayne@69
|
7763 ** ^(If the row that a BLOB handle points to is modified by an
|
|
jpayne@69
|
7764 ** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects
|
|
jpayne@69
|
7765 ** then the BLOB handle is marked as "expired".
|
|
jpayne@69
|
7766 ** This is true if any column of the row is changed, even a column
|
|
jpayne@69
|
7767 ** other than the one the BLOB handle is open on.)^
|
|
jpayne@69
|
7768 ** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for
|
|
jpayne@69
|
7769 ** an expired BLOB handle fail with a return code of [SQLITE_ABORT].
|
|
jpayne@69
|
7770 ** ^(Changes written into a BLOB prior to the BLOB expiring are not
|
|
jpayne@69
|
7771 ** rolled back by the expiration of the BLOB. Such changes will eventually
|
|
jpayne@69
|
7772 ** commit if the transaction continues to completion.)^
|
|
jpayne@69
|
7773 **
|
|
jpayne@69
|
7774 ** ^Use the [sqlite3_blob_bytes()] interface to determine the size of
|
|
jpayne@69
|
7775 ** the opened blob. ^The size of a blob may not be changed by this
|
|
jpayne@69
|
7776 ** interface. Use the [UPDATE] SQL command to change the size of a
|
|
jpayne@69
|
7777 ** blob.
|
|
jpayne@69
|
7778 **
|
|
jpayne@69
|
7779 ** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces
|
|
jpayne@69
|
7780 ** and the built-in [zeroblob] SQL function may be used to create a
|
|
jpayne@69
|
7781 ** zero-filled blob to read or write using the incremental-blob interface.
|
|
jpayne@69
|
7782 **
|
|
jpayne@69
|
7783 ** To avoid a resource leak, every open [BLOB handle] should eventually
|
|
jpayne@69
|
7784 ** be released by a call to [sqlite3_blob_close()].
|
|
jpayne@69
|
7785 **
|
|
jpayne@69
|
7786 ** See also: [sqlite3_blob_close()],
|
|
jpayne@69
|
7787 ** [sqlite3_blob_reopen()], [sqlite3_blob_read()],
|
|
jpayne@69
|
7788 ** [sqlite3_blob_bytes()], [sqlite3_blob_write()].
|
|
jpayne@69
|
7789 */
|
|
jpayne@69
|
7790 SQLITE_API int sqlite3_blob_open(
|
|
jpayne@69
|
7791 sqlite3*,
|
|
jpayne@69
|
7792 const char *zDb,
|
|
jpayne@69
|
7793 const char *zTable,
|
|
jpayne@69
|
7794 const char *zColumn,
|
|
jpayne@69
|
7795 sqlite3_int64 iRow,
|
|
jpayne@69
|
7796 int flags,
|
|
jpayne@69
|
7797 sqlite3_blob **ppBlob
|
|
jpayne@69
|
7798 );
|
|
jpayne@69
|
7799
|
|
jpayne@69
|
7800 /*
|
|
jpayne@69
|
7801 ** CAPI3REF: Move a BLOB Handle to a New Row
|
|
jpayne@69
|
7802 ** METHOD: sqlite3_blob
|
|
jpayne@69
|
7803 **
|
|
jpayne@69
|
7804 ** ^This function is used to move an existing [BLOB handle] so that it points
|
|
jpayne@69
|
7805 ** to a different row of the same database table. ^The new row is identified
|
|
jpayne@69
|
7806 ** by the rowid value passed as the second argument. Only the row can be
|
|
jpayne@69
|
7807 ** changed. ^The database, table and column on which the blob handle is open
|
|
jpayne@69
|
7808 ** remain the same. Moving an existing [BLOB handle] to a new row is
|
|
jpayne@69
|
7809 ** faster than closing the existing handle and opening a new one.
|
|
jpayne@69
|
7810 **
|
|
jpayne@69
|
7811 ** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] -
|
|
jpayne@69
|
7812 ** it must exist and there must be either a blob or text value stored in
|
|
jpayne@69
|
7813 ** the nominated column.)^ ^If the new row is not present in the table, or if
|
|
jpayne@69
|
7814 ** it does not contain a blob or text value, or if another error occurs, an
|
|
jpayne@69
|
7815 ** SQLite error code is returned and the blob handle is considered aborted.
|
|
jpayne@69
|
7816 ** ^All subsequent calls to [sqlite3_blob_read()], [sqlite3_blob_write()] or
|
|
jpayne@69
|
7817 ** [sqlite3_blob_reopen()] on an aborted blob handle immediately return
|
|
jpayne@69
|
7818 ** SQLITE_ABORT. ^Calling [sqlite3_blob_bytes()] on an aborted blob handle
|
|
jpayne@69
|
7819 ** always returns zero.
|
|
jpayne@69
|
7820 **
|
|
jpayne@69
|
7821 ** ^This function sets the database handle error code and message.
|
|
jpayne@69
|
7822 */
|
|
jpayne@69
|
7823 SQLITE_API int sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64);
|
|
jpayne@69
|
7824
|
|
jpayne@69
|
7825 /*
|
|
jpayne@69
|
7826 ** CAPI3REF: Close A BLOB Handle
|
|
jpayne@69
|
7827 ** DESTRUCTOR: sqlite3_blob
|
|
jpayne@69
|
7828 **
|
|
jpayne@69
|
7829 ** ^This function closes an open [BLOB handle]. ^(The BLOB handle is closed
|
|
jpayne@69
|
7830 ** unconditionally. Even if this routine returns an error code, the
|
|
jpayne@69
|
7831 ** handle is still closed.)^
|
|
jpayne@69
|
7832 **
|
|
jpayne@69
|
7833 ** ^If the blob handle being closed was opened for read-write access, and if
|
|
jpayne@69
|
7834 ** the database is in auto-commit mode and there are no other open read-write
|
|
jpayne@69
|
7835 ** blob handles or active write statements, the current transaction is
|
|
jpayne@69
|
7836 ** committed. ^If an error occurs while committing the transaction, an error
|
|
jpayne@69
|
7837 ** code is returned and the transaction rolled back.
|
|
jpayne@69
|
7838 **
|
|
jpayne@69
|
7839 ** Calling this function with an argument that is not a NULL pointer or an
|
|
jpayne@69
|
7840 ** open blob handle results in undefined behavior. ^Calling this routine
|
|
jpayne@69
|
7841 ** with a null pointer (such as would be returned by a failed call to
|
|
jpayne@69
|
7842 ** [sqlite3_blob_open()]) is a harmless no-op. ^Otherwise, if this function
|
|
jpayne@69
|
7843 ** is passed a valid open blob handle, the values returned by the
|
|
jpayne@69
|
7844 ** sqlite3_errcode() and sqlite3_errmsg() functions are set before returning.
|
|
jpayne@69
|
7845 */
|
|
jpayne@69
|
7846 SQLITE_API int sqlite3_blob_close(sqlite3_blob *);
|
|
jpayne@69
|
7847
|
|
jpayne@69
|
7848 /*
|
|
jpayne@69
|
7849 ** CAPI3REF: Return The Size Of An Open BLOB
|
|
jpayne@69
|
7850 ** METHOD: sqlite3_blob
|
|
jpayne@69
|
7851 **
|
|
jpayne@69
|
7852 ** ^Returns the size in bytes of the BLOB accessible via the
|
|
jpayne@69
|
7853 ** successfully opened [BLOB handle] in its only argument. ^The
|
|
jpayne@69
|
7854 ** incremental blob I/O routines can only read or overwriting existing
|
|
jpayne@69
|
7855 ** blob content; they cannot change the size of a blob.
|
|
jpayne@69
|
7856 **
|
|
jpayne@69
|
7857 ** This routine only works on a [BLOB handle] which has been created
|
|
jpayne@69
|
7858 ** by a prior successful call to [sqlite3_blob_open()] and which has not
|
|
jpayne@69
|
7859 ** been closed by [sqlite3_blob_close()]. Passing any other pointer in
|
|
jpayne@69
|
7860 ** to this routine results in undefined and probably undesirable behavior.
|
|
jpayne@69
|
7861 */
|
|
jpayne@69
|
7862 SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *);
|
|
jpayne@69
|
7863
|
|
jpayne@69
|
7864 /*
|
|
jpayne@69
|
7865 ** CAPI3REF: Read Data From A BLOB Incrementally
|
|
jpayne@69
|
7866 ** METHOD: sqlite3_blob
|
|
jpayne@69
|
7867 **
|
|
jpayne@69
|
7868 ** ^(This function is used to read data from an open [BLOB handle] into a
|
|
jpayne@69
|
7869 ** caller-supplied buffer. N bytes of data are copied into buffer Z
|
|
jpayne@69
|
7870 ** from the open BLOB, starting at offset iOffset.)^
|
|
jpayne@69
|
7871 **
|
|
jpayne@69
|
7872 ** ^If offset iOffset is less than N bytes from the end of the BLOB,
|
|
jpayne@69
|
7873 ** [SQLITE_ERROR] is returned and no data is read. ^If N or iOffset is
|
|
jpayne@69
|
7874 ** less than zero, [SQLITE_ERROR] is returned and no data is read.
|
|
jpayne@69
|
7875 ** ^The size of the blob (and hence the maximum value of N+iOffset)
|
|
jpayne@69
|
7876 ** can be determined using the [sqlite3_blob_bytes()] interface.
|
|
jpayne@69
|
7877 **
|
|
jpayne@69
|
7878 ** ^An attempt to read from an expired [BLOB handle] fails with an
|
|
jpayne@69
|
7879 ** error code of [SQLITE_ABORT].
|
|
jpayne@69
|
7880 **
|
|
jpayne@69
|
7881 ** ^(On success, sqlite3_blob_read() returns SQLITE_OK.
|
|
jpayne@69
|
7882 ** Otherwise, an [error code] or an [extended error code] is returned.)^
|
|
jpayne@69
|
7883 **
|
|
jpayne@69
|
7884 ** This routine only works on a [BLOB handle] which has been created
|
|
jpayne@69
|
7885 ** by a prior successful call to [sqlite3_blob_open()] and which has not
|
|
jpayne@69
|
7886 ** been closed by [sqlite3_blob_close()]. Passing any other pointer in
|
|
jpayne@69
|
7887 ** to this routine results in undefined and probably undesirable behavior.
|
|
jpayne@69
|
7888 **
|
|
jpayne@69
|
7889 ** See also: [sqlite3_blob_write()].
|
|
jpayne@69
|
7890 */
|
|
jpayne@69
|
7891 SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset);
|
|
jpayne@69
|
7892
|
|
jpayne@69
|
7893 /*
|
|
jpayne@69
|
7894 ** CAPI3REF: Write Data Into A BLOB Incrementally
|
|
jpayne@69
|
7895 ** METHOD: sqlite3_blob
|
|
jpayne@69
|
7896 **
|
|
jpayne@69
|
7897 ** ^(This function is used to write data into an open [BLOB handle] from a
|
|
jpayne@69
|
7898 ** caller-supplied buffer. N bytes of data are copied from the buffer Z
|
|
jpayne@69
|
7899 ** into the open BLOB, starting at offset iOffset.)^
|
|
jpayne@69
|
7900 **
|
|
jpayne@69
|
7901 ** ^(On success, sqlite3_blob_write() returns SQLITE_OK.
|
|
jpayne@69
|
7902 ** Otherwise, an [error code] or an [extended error code] is returned.)^
|
|
jpayne@69
|
7903 ** ^Unless SQLITE_MISUSE is returned, this function sets the
|
|
jpayne@69
|
7904 ** [database connection] error code and message accessible via
|
|
jpayne@69
|
7905 ** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions.
|
|
jpayne@69
|
7906 **
|
|
jpayne@69
|
7907 ** ^If the [BLOB handle] passed as the first argument was not opened for
|
|
jpayne@69
|
7908 ** writing (the flags parameter to [sqlite3_blob_open()] was zero),
|
|
jpayne@69
|
7909 ** this function returns [SQLITE_READONLY].
|
|
jpayne@69
|
7910 **
|
|
jpayne@69
|
7911 ** This function may only modify the contents of the BLOB; it is
|
|
jpayne@69
|
7912 ** not possible to increase the size of a BLOB using this API.
|
|
jpayne@69
|
7913 ** ^If offset iOffset is less than N bytes from the end of the BLOB,
|
|
jpayne@69
|
7914 ** [SQLITE_ERROR] is returned and no data is written. The size of the
|
|
jpayne@69
|
7915 ** BLOB (and hence the maximum value of N+iOffset) can be determined
|
|
jpayne@69
|
7916 ** using the [sqlite3_blob_bytes()] interface. ^If N or iOffset are less
|
|
jpayne@69
|
7917 ** than zero [SQLITE_ERROR] is returned and no data is written.
|
|
jpayne@69
|
7918 **
|
|
jpayne@69
|
7919 ** ^An attempt to write to an expired [BLOB handle] fails with an
|
|
jpayne@69
|
7920 ** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred
|
|
jpayne@69
|
7921 ** before the [BLOB handle] expired are not rolled back by the
|
|
jpayne@69
|
7922 ** expiration of the handle, though of course those changes might
|
|
jpayne@69
|
7923 ** have been overwritten by the statement that expired the BLOB handle
|
|
jpayne@69
|
7924 ** or by other independent statements.
|
|
jpayne@69
|
7925 **
|
|
jpayne@69
|
7926 ** This routine only works on a [BLOB handle] which has been created
|
|
jpayne@69
|
7927 ** by a prior successful call to [sqlite3_blob_open()] and which has not
|
|
jpayne@69
|
7928 ** been closed by [sqlite3_blob_close()]. Passing any other pointer in
|
|
jpayne@69
|
7929 ** to this routine results in undefined and probably undesirable behavior.
|
|
jpayne@69
|
7930 **
|
|
jpayne@69
|
7931 ** See also: [sqlite3_blob_read()].
|
|
jpayne@69
|
7932 */
|
|
jpayne@69
|
7933 SQLITE_API int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset);
|
|
jpayne@69
|
7934
|
|
jpayne@69
|
7935 /*
|
|
jpayne@69
|
7936 ** CAPI3REF: Virtual File System Objects
|
|
jpayne@69
|
7937 **
|
|
jpayne@69
|
7938 ** A virtual filesystem (VFS) is an [sqlite3_vfs] object
|
|
jpayne@69
|
7939 ** that SQLite uses to interact
|
|
jpayne@69
|
7940 ** with the underlying operating system. Most SQLite builds come with a
|
|
jpayne@69
|
7941 ** single default VFS that is appropriate for the host computer.
|
|
jpayne@69
|
7942 ** New VFSes can be registered and existing VFSes can be unregistered.
|
|
jpayne@69
|
7943 ** The following interfaces are provided.
|
|
jpayne@69
|
7944 **
|
|
jpayne@69
|
7945 ** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name.
|
|
jpayne@69
|
7946 ** ^Names are case sensitive.
|
|
jpayne@69
|
7947 ** ^Names are zero-terminated UTF-8 strings.
|
|
jpayne@69
|
7948 ** ^If there is no match, a NULL pointer is returned.
|
|
jpayne@69
|
7949 ** ^If zVfsName is NULL then the default VFS is returned.
|
|
jpayne@69
|
7950 **
|
|
jpayne@69
|
7951 ** ^New VFSes are registered with sqlite3_vfs_register().
|
|
jpayne@69
|
7952 ** ^Each new VFS becomes the default VFS if the makeDflt flag is set.
|
|
jpayne@69
|
7953 ** ^The same VFS can be registered multiple times without injury.
|
|
jpayne@69
|
7954 ** ^To make an existing VFS into the default VFS, register it again
|
|
jpayne@69
|
7955 ** with the makeDflt flag set. If two different VFSes with the
|
|
jpayne@69
|
7956 ** same name are registered, the behavior is undefined. If a
|
|
jpayne@69
|
7957 ** VFS is registered with a name that is NULL or an empty string,
|
|
jpayne@69
|
7958 ** then the behavior is undefined.
|
|
jpayne@69
|
7959 **
|
|
jpayne@69
|
7960 ** ^Unregister a VFS with the sqlite3_vfs_unregister() interface.
|
|
jpayne@69
|
7961 ** ^(If the default VFS is unregistered, another VFS is chosen as
|
|
jpayne@69
|
7962 ** the default. The choice for the new VFS is arbitrary.)^
|
|
jpayne@69
|
7963 */
|
|
jpayne@69
|
7964 SQLITE_API sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName);
|
|
jpayne@69
|
7965 SQLITE_API int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);
|
|
jpayne@69
|
7966 SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);
|
|
jpayne@69
|
7967
|
|
jpayne@69
|
7968 /*
|
|
jpayne@69
|
7969 ** CAPI3REF: Mutexes
|
|
jpayne@69
|
7970 **
|
|
jpayne@69
|
7971 ** The SQLite core uses these routines for thread
|
|
jpayne@69
|
7972 ** synchronization. Though they are intended for internal
|
|
jpayne@69
|
7973 ** use by SQLite, code that links against SQLite is
|
|
jpayne@69
|
7974 ** permitted to use any of these routines.
|
|
jpayne@69
|
7975 **
|
|
jpayne@69
|
7976 ** The SQLite source code contains multiple implementations
|
|
jpayne@69
|
7977 ** of these mutex routines. An appropriate implementation
|
|
jpayne@69
|
7978 ** is selected automatically at compile-time. The following
|
|
jpayne@69
|
7979 ** implementations are available in the SQLite core:
|
|
jpayne@69
|
7980 **
|
|
jpayne@69
|
7981 ** <ul>
|
|
jpayne@69
|
7982 ** <li> SQLITE_MUTEX_PTHREADS
|
|
jpayne@69
|
7983 ** <li> SQLITE_MUTEX_W32
|
|
jpayne@69
|
7984 ** <li> SQLITE_MUTEX_NOOP
|
|
jpayne@69
|
7985 ** </ul>
|
|
jpayne@69
|
7986 **
|
|
jpayne@69
|
7987 ** The SQLITE_MUTEX_NOOP implementation is a set of routines
|
|
jpayne@69
|
7988 ** that does no real locking and is appropriate for use in
|
|
jpayne@69
|
7989 ** a single-threaded application. The SQLITE_MUTEX_PTHREADS and
|
|
jpayne@69
|
7990 ** SQLITE_MUTEX_W32 implementations are appropriate for use on Unix
|
|
jpayne@69
|
7991 ** and Windows.
|
|
jpayne@69
|
7992 **
|
|
jpayne@69
|
7993 ** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor
|
|
jpayne@69
|
7994 ** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex
|
|
jpayne@69
|
7995 ** implementation is included with the library. In this case the
|
|
jpayne@69
|
7996 ** application must supply a custom mutex implementation using the
|
|
jpayne@69
|
7997 ** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function
|
|
jpayne@69
|
7998 ** before calling sqlite3_initialize() or any other public sqlite3_
|
|
jpayne@69
|
7999 ** function that calls sqlite3_initialize().
|
|
jpayne@69
|
8000 **
|
|
jpayne@69
|
8001 ** ^The sqlite3_mutex_alloc() routine allocates a new
|
|
jpayne@69
|
8002 ** mutex and returns a pointer to it. ^The sqlite3_mutex_alloc()
|
|
jpayne@69
|
8003 ** routine returns NULL if it is unable to allocate the requested
|
|
jpayne@69
|
8004 ** mutex. The argument to sqlite3_mutex_alloc() must one of these
|
|
jpayne@69
|
8005 ** integer constants:
|
|
jpayne@69
|
8006 **
|
|
jpayne@69
|
8007 ** <ul>
|
|
jpayne@69
|
8008 ** <li> SQLITE_MUTEX_FAST
|
|
jpayne@69
|
8009 ** <li> SQLITE_MUTEX_RECURSIVE
|
|
jpayne@69
|
8010 ** <li> SQLITE_MUTEX_STATIC_MAIN
|
|
jpayne@69
|
8011 ** <li> SQLITE_MUTEX_STATIC_MEM
|
|
jpayne@69
|
8012 ** <li> SQLITE_MUTEX_STATIC_OPEN
|
|
jpayne@69
|
8013 ** <li> SQLITE_MUTEX_STATIC_PRNG
|
|
jpayne@69
|
8014 ** <li> SQLITE_MUTEX_STATIC_LRU
|
|
jpayne@69
|
8015 ** <li> SQLITE_MUTEX_STATIC_PMEM
|
|
jpayne@69
|
8016 ** <li> SQLITE_MUTEX_STATIC_APP1
|
|
jpayne@69
|
8017 ** <li> SQLITE_MUTEX_STATIC_APP2
|
|
jpayne@69
|
8018 ** <li> SQLITE_MUTEX_STATIC_APP3
|
|
jpayne@69
|
8019 ** <li> SQLITE_MUTEX_STATIC_VFS1
|
|
jpayne@69
|
8020 ** <li> SQLITE_MUTEX_STATIC_VFS2
|
|
jpayne@69
|
8021 ** <li> SQLITE_MUTEX_STATIC_VFS3
|
|
jpayne@69
|
8022 ** </ul>
|
|
jpayne@69
|
8023 **
|
|
jpayne@69
|
8024 ** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE)
|
|
jpayne@69
|
8025 ** cause sqlite3_mutex_alloc() to create
|
|
jpayne@69
|
8026 ** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
|
|
jpayne@69
|
8027 ** is used but not necessarily so when SQLITE_MUTEX_FAST is used.
|
|
jpayne@69
|
8028 ** The mutex implementation does not need to make a distinction
|
|
jpayne@69
|
8029 ** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
|
|
jpayne@69
|
8030 ** not want to. SQLite will only request a recursive mutex in
|
|
jpayne@69
|
8031 ** cases where it really needs one. If a faster non-recursive mutex
|
|
jpayne@69
|
8032 ** implementation is available on the host platform, the mutex subsystem
|
|
jpayne@69
|
8033 ** might return such a mutex in response to SQLITE_MUTEX_FAST.
|
|
jpayne@69
|
8034 **
|
|
jpayne@69
|
8035 ** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other
|
|
jpayne@69
|
8036 ** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return
|
|
jpayne@69
|
8037 ** a pointer to a static preexisting mutex. ^Nine static mutexes are
|
|
jpayne@69
|
8038 ** used by the current version of SQLite. Future versions of SQLite
|
|
jpayne@69
|
8039 ** may add additional static mutexes. Static mutexes are for internal
|
|
jpayne@69
|
8040 ** use by SQLite only. Applications that use SQLite mutexes should
|
|
jpayne@69
|
8041 ** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
|
|
jpayne@69
|
8042 ** SQLITE_MUTEX_RECURSIVE.
|
|
jpayne@69
|
8043 **
|
|
jpayne@69
|
8044 ** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
|
|
jpayne@69
|
8045 ** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
|
|
jpayne@69
|
8046 ** returns a different mutex on every call. ^For the static
|
|
jpayne@69
|
8047 ** mutex types, the same mutex is returned on every call that has
|
|
jpayne@69
|
8048 ** the same type number.
|
|
jpayne@69
|
8049 **
|
|
jpayne@69
|
8050 ** ^The sqlite3_mutex_free() routine deallocates a previously
|
|
jpayne@69
|
8051 ** allocated dynamic mutex. Attempting to deallocate a static
|
|
jpayne@69
|
8052 ** mutex results in undefined behavior.
|
|
jpayne@69
|
8053 **
|
|
jpayne@69
|
8054 ** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
|
|
jpayne@69
|
8055 ** to enter a mutex. ^If another thread is already within the mutex,
|
|
jpayne@69
|
8056 ** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
|
|
jpayne@69
|
8057 ** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK]
|
|
jpayne@69
|
8058 ** upon successful entry. ^(Mutexes created using
|
|
jpayne@69
|
8059 ** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread.
|
|
jpayne@69
|
8060 ** In such cases, the
|
|
jpayne@69
|
8061 ** mutex must be exited an equal number of times before another thread
|
|
jpayne@69
|
8062 ** can enter.)^ If the same thread tries to enter any mutex other
|
|
jpayne@69
|
8063 ** than an SQLITE_MUTEX_RECURSIVE more than once, the behavior is undefined.
|
|
jpayne@69
|
8064 **
|
|
jpayne@69
|
8065 ** ^(Some systems (for example, Windows 95) do not support the operation
|
|
jpayne@69
|
8066 ** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try()
|
|
jpayne@69
|
8067 ** will always return SQLITE_BUSY. In most cases the SQLite core only uses
|
|
jpayne@69
|
8068 ** sqlite3_mutex_try() as an optimization, so this is acceptable
|
|
jpayne@69
|
8069 ** behavior. The exceptions are unix builds that set the
|
|
jpayne@69
|
8070 ** SQLITE_ENABLE_SETLK_TIMEOUT build option. In that case a working
|
|
jpayne@69
|
8071 ** sqlite3_mutex_try() is required.)^
|
|
jpayne@69
|
8072 **
|
|
jpayne@69
|
8073 ** ^The sqlite3_mutex_leave() routine exits a mutex that was
|
|
jpayne@69
|
8074 ** previously entered by the same thread. The behavior
|
|
jpayne@69
|
8075 ** is undefined if the mutex is not currently entered by the
|
|
jpayne@69
|
8076 ** calling thread or is not currently allocated.
|
|
jpayne@69
|
8077 **
|
|
jpayne@69
|
8078 ** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(),
|
|
jpayne@69
|
8079 ** sqlite3_mutex_leave(), or sqlite3_mutex_free() is a NULL pointer,
|
|
jpayne@69
|
8080 ** then any of the four routines behaves as a no-op.
|
|
jpayne@69
|
8081 **
|
|
jpayne@69
|
8082 ** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()].
|
|
jpayne@69
|
8083 */
|
|
jpayne@69
|
8084 SQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int);
|
|
jpayne@69
|
8085 SQLITE_API void sqlite3_mutex_free(sqlite3_mutex*);
|
|
jpayne@69
|
8086 SQLITE_API void sqlite3_mutex_enter(sqlite3_mutex*);
|
|
jpayne@69
|
8087 SQLITE_API int sqlite3_mutex_try(sqlite3_mutex*);
|
|
jpayne@69
|
8088 SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*);
|
|
jpayne@69
|
8089
|
|
jpayne@69
|
8090 /*
|
|
jpayne@69
|
8091 ** CAPI3REF: Mutex Methods Object
|
|
jpayne@69
|
8092 **
|
|
jpayne@69
|
8093 ** An instance of this structure defines the low-level routines
|
|
jpayne@69
|
8094 ** used to allocate and use mutexes.
|
|
jpayne@69
|
8095 **
|
|
jpayne@69
|
8096 ** Usually, the default mutex implementations provided by SQLite are
|
|
jpayne@69
|
8097 ** sufficient, however the application has the option of substituting a custom
|
|
jpayne@69
|
8098 ** implementation for specialized deployments or systems for which SQLite
|
|
jpayne@69
|
8099 ** does not provide a suitable implementation. In this case, the application
|
|
jpayne@69
|
8100 ** creates and populates an instance of this structure to pass
|
|
jpayne@69
|
8101 ** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option.
|
|
jpayne@69
|
8102 ** Additionally, an instance of this structure can be used as an
|
|
jpayne@69
|
8103 ** output variable when querying the system for the current mutex
|
|
jpayne@69
|
8104 ** implementation, using the [SQLITE_CONFIG_GETMUTEX] option.
|
|
jpayne@69
|
8105 **
|
|
jpayne@69
|
8106 ** ^The xMutexInit method defined by this structure is invoked as
|
|
jpayne@69
|
8107 ** part of system initialization by the sqlite3_initialize() function.
|
|
jpayne@69
|
8108 ** ^The xMutexInit routine is called by SQLite exactly once for each
|
|
jpayne@69
|
8109 ** effective call to [sqlite3_initialize()].
|
|
jpayne@69
|
8110 **
|
|
jpayne@69
|
8111 ** ^The xMutexEnd method defined by this structure is invoked as
|
|
jpayne@69
|
8112 ** part of system shutdown by the sqlite3_shutdown() function. The
|
|
jpayne@69
|
8113 ** implementation of this method is expected to release all outstanding
|
|
jpayne@69
|
8114 ** resources obtained by the mutex methods implementation, especially
|
|
jpayne@69
|
8115 ** those obtained by the xMutexInit method. ^The xMutexEnd()
|
|
jpayne@69
|
8116 ** interface is invoked exactly once for each call to [sqlite3_shutdown()].
|
|
jpayne@69
|
8117 **
|
|
jpayne@69
|
8118 ** ^(The remaining seven methods defined by this structure (xMutexAlloc,
|
|
jpayne@69
|
8119 ** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and
|
|
jpayne@69
|
8120 ** xMutexNotheld) implement the following interfaces (respectively):
|
|
jpayne@69
|
8121 **
|
|
jpayne@69
|
8122 ** <ul>
|
|
jpayne@69
|
8123 ** <li> [sqlite3_mutex_alloc()] </li>
|
|
jpayne@69
|
8124 ** <li> [sqlite3_mutex_free()] </li>
|
|
jpayne@69
|
8125 ** <li> [sqlite3_mutex_enter()] </li>
|
|
jpayne@69
|
8126 ** <li> [sqlite3_mutex_try()] </li>
|
|
jpayne@69
|
8127 ** <li> [sqlite3_mutex_leave()] </li>
|
|
jpayne@69
|
8128 ** <li> [sqlite3_mutex_held()] </li>
|
|
jpayne@69
|
8129 ** <li> [sqlite3_mutex_notheld()] </li>
|
|
jpayne@69
|
8130 ** </ul>)^
|
|
jpayne@69
|
8131 **
|
|
jpayne@69
|
8132 ** The only difference is that the public sqlite3_XXX functions enumerated
|
|
jpayne@69
|
8133 ** above silently ignore any invocations that pass a NULL pointer instead
|
|
jpayne@69
|
8134 ** of a valid mutex handle. The implementations of the methods defined
|
|
jpayne@69
|
8135 ** by this structure are not required to handle this case. The results
|
|
jpayne@69
|
8136 ** of passing a NULL pointer instead of a valid mutex handle are undefined
|
|
jpayne@69
|
8137 ** (i.e. it is acceptable to provide an implementation that segfaults if
|
|
jpayne@69
|
8138 ** it is passed a NULL pointer).
|
|
jpayne@69
|
8139 **
|
|
jpayne@69
|
8140 ** The xMutexInit() method must be threadsafe. It must be harmless to
|
|
jpayne@69
|
8141 ** invoke xMutexInit() multiple times within the same process and without
|
|
jpayne@69
|
8142 ** intervening calls to xMutexEnd(). Second and subsequent calls to
|
|
jpayne@69
|
8143 ** xMutexInit() must be no-ops.
|
|
jpayne@69
|
8144 **
|
|
jpayne@69
|
8145 ** xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()]
|
|
jpayne@69
|
8146 ** and its associates). Similarly, xMutexAlloc() must not use SQLite memory
|
|
jpayne@69
|
8147 ** allocation for a static mutex. ^However xMutexAlloc() may use SQLite
|
|
jpayne@69
|
8148 ** memory allocation for a fast or recursive mutex.
|
|
jpayne@69
|
8149 **
|
|
jpayne@69
|
8150 ** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is
|
|
jpayne@69
|
8151 ** called, but only if the prior call to xMutexInit returned SQLITE_OK.
|
|
jpayne@69
|
8152 ** If xMutexInit fails in any way, it is expected to clean up after itself
|
|
jpayne@69
|
8153 ** prior to returning.
|
|
jpayne@69
|
8154 */
|
|
jpayne@69
|
8155 typedef struct sqlite3_mutex_methods sqlite3_mutex_methods;
|
|
jpayne@69
|
8156 struct sqlite3_mutex_methods {
|
|
jpayne@69
|
8157 int (*xMutexInit)(void);
|
|
jpayne@69
|
8158 int (*xMutexEnd)(void);
|
|
jpayne@69
|
8159 sqlite3_mutex *(*xMutexAlloc)(int);
|
|
jpayne@69
|
8160 void (*xMutexFree)(sqlite3_mutex *);
|
|
jpayne@69
|
8161 void (*xMutexEnter)(sqlite3_mutex *);
|
|
jpayne@69
|
8162 int (*xMutexTry)(sqlite3_mutex *);
|
|
jpayne@69
|
8163 void (*xMutexLeave)(sqlite3_mutex *);
|
|
jpayne@69
|
8164 int (*xMutexHeld)(sqlite3_mutex *);
|
|
jpayne@69
|
8165 int (*xMutexNotheld)(sqlite3_mutex *);
|
|
jpayne@69
|
8166 };
|
|
jpayne@69
|
8167
|
|
jpayne@69
|
8168 /*
|
|
jpayne@69
|
8169 ** CAPI3REF: Mutex Verification Routines
|
|
jpayne@69
|
8170 **
|
|
jpayne@69
|
8171 ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines
|
|
jpayne@69
|
8172 ** are intended for use inside assert() statements. The SQLite core
|
|
jpayne@69
|
8173 ** never uses these routines except inside an assert() and applications
|
|
jpayne@69
|
8174 ** are advised to follow the lead of the core. The SQLite core only
|
|
jpayne@69
|
8175 ** provides implementations for these routines when it is compiled
|
|
jpayne@69
|
8176 ** with the SQLITE_DEBUG flag. External mutex implementations
|
|
jpayne@69
|
8177 ** are only required to provide these routines if SQLITE_DEBUG is
|
|
jpayne@69
|
8178 ** defined and if NDEBUG is not defined.
|
|
jpayne@69
|
8179 **
|
|
jpayne@69
|
8180 ** These routines should return true if the mutex in their argument
|
|
jpayne@69
|
8181 ** is held or not held, respectively, by the calling thread.
|
|
jpayne@69
|
8182 **
|
|
jpayne@69
|
8183 ** The implementation is not required to provide versions of these
|
|
jpayne@69
|
8184 ** routines that actually work. If the implementation does not provide working
|
|
jpayne@69
|
8185 ** versions of these routines, it should at least provide stubs that always
|
|
jpayne@69
|
8186 ** return true so that one does not get spurious assertion failures.
|
|
jpayne@69
|
8187 **
|
|
jpayne@69
|
8188 ** If the argument to sqlite3_mutex_held() is a NULL pointer then
|
|
jpayne@69
|
8189 ** the routine should return 1. This seems counter-intuitive since
|
|
jpayne@69
|
8190 ** clearly the mutex cannot be held if it does not exist. But
|
|
jpayne@69
|
8191 ** the reason the mutex does not exist is because the build is not
|
|
jpayne@69
|
8192 ** using mutexes. And we do not want the assert() containing the
|
|
jpayne@69
|
8193 ** call to sqlite3_mutex_held() to fail, so a non-zero return is
|
|
jpayne@69
|
8194 ** the appropriate thing to do. The sqlite3_mutex_notheld()
|
|
jpayne@69
|
8195 ** interface should also return 1 when given a NULL pointer.
|
|
jpayne@69
|
8196 */
|
|
jpayne@69
|
8197 #ifndef NDEBUG
|
|
jpayne@69
|
8198 SQLITE_API int sqlite3_mutex_held(sqlite3_mutex*);
|
|
jpayne@69
|
8199 SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*);
|
|
jpayne@69
|
8200 #endif
|
|
jpayne@69
|
8201
|
|
jpayne@69
|
8202 /*
|
|
jpayne@69
|
8203 ** CAPI3REF: Mutex Types
|
|
jpayne@69
|
8204 **
|
|
jpayne@69
|
8205 ** The [sqlite3_mutex_alloc()] interface takes a single argument
|
|
jpayne@69
|
8206 ** which is one of these integer constants.
|
|
jpayne@69
|
8207 **
|
|
jpayne@69
|
8208 ** The set of static mutexes may change from one SQLite release to the
|
|
jpayne@69
|
8209 ** next. Applications that override the built-in mutex logic must be
|
|
jpayne@69
|
8210 ** prepared to accommodate additional static mutexes.
|
|
jpayne@69
|
8211 */
|
|
jpayne@69
|
8212 #define SQLITE_MUTEX_FAST 0
|
|
jpayne@69
|
8213 #define SQLITE_MUTEX_RECURSIVE 1
|
|
jpayne@69
|
8214 #define SQLITE_MUTEX_STATIC_MAIN 2
|
|
jpayne@69
|
8215 #define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */
|
|
jpayne@69
|
8216 #define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */
|
|
jpayne@69
|
8217 #define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */
|
|
jpayne@69
|
8218 #define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_randomness() */
|
|
jpayne@69
|
8219 #define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */
|
|
jpayne@69
|
8220 #define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */
|
|
jpayne@69
|
8221 #define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */
|
|
jpayne@69
|
8222 #define SQLITE_MUTEX_STATIC_APP1 8 /* For use by application */
|
|
jpayne@69
|
8223 #define SQLITE_MUTEX_STATIC_APP2 9 /* For use by application */
|
|
jpayne@69
|
8224 #define SQLITE_MUTEX_STATIC_APP3 10 /* For use by application */
|
|
jpayne@69
|
8225 #define SQLITE_MUTEX_STATIC_VFS1 11 /* For use by built-in VFS */
|
|
jpayne@69
|
8226 #define SQLITE_MUTEX_STATIC_VFS2 12 /* For use by extension VFS */
|
|
jpayne@69
|
8227 #define SQLITE_MUTEX_STATIC_VFS3 13 /* For use by application VFS */
|
|
jpayne@69
|
8228
|
|
jpayne@69
|
8229 /* Legacy compatibility: */
|
|
jpayne@69
|
8230 #define SQLITE_MUTEX_STATIC_MASTER 2
|
|
jpayne@69
|
8231
|
|
jpayne@69
|
8232
|
|
jpayne@69
|
8233 /*
|
|
jpayne@69
|
8234 ** CAPI3REF: Retrieve the mutex for a database connection
|
|
jpayne@69
|
8235 ** METHOD: sqlite3
|
|
jpayne@69
|
8236 **
|
|
jpayne@69
|
8237 ** ^This interface returns a pointer the [sqlite3_mutex] object that
|
|
jpayne@69
|
8238 ** serializes access to the [database connection] given in the argument
|
|
jpayne@69
|
8239 ** when the [threading mode] is Serialized.
|
|
jpayne@69
|
8240 ** ^If the [threading mode] is Single-thread or Multi-thread then this
|
|
jpayne@69
|
8241 ** routine returns a NULL pointer.
|
|
jpayne@69
|
8242 */
|
|
jpayne@69
|
8243 SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*);
|
|
jpayne@69
|
8244
|
|
jpayne@69
|
8245 /*
|
|
jpayne@69
|
8246 ** CAPI3REF: Low-Level Control Of Database Files
|
|
jpayne@69
|
8247 ** METHOD: sqlite3
|
|
jpayne@69
|
8248 ** KEYWORDS: {file control}
|
|
jpayne@69
|
8249 **
|
|
jpayne@69
|
8250 ** ^The [sqlite3_file_control()] interface makes a direct call to the
|
|
jpayne@69
|
8251 ** xFileControl method for the [sqlite3_io_methods] object associated
|
|
jpayne@69
|
8252 ** with a particular database identified by the second argument. ^The
|
|
jpayne@69
|
8253 ** name of the database is "main" for the main database or "temp" for the
|
|
jpayne@69
|
8254 ** TEMP database, or the name that appears after the AS keyword for
|
|
jpayne@69
|
8255 ** databases that are added using the [ATTACH] SQL command.
|
|
jpayne@69
|
8256 ** ^A NULL pointer can be used in place of "main" to refer to the
|
|
jpayne@69
|
8257 ** main database file.
|
|
jpayne@69
|
8258 ** ^The third and fourth parameters to this routine
|
|
jpayne@69
|
8259 ** are passed directly through to the second and third parameters of
|
|
jpayne@69
|
8260 ** the xFileControl method. ^The return value of the xFileControl
|
|
jpayne@69
|
8261 ** method becomes the return value of this routine.
|
|
jpayne@69
|
8262 **
|
|
jpayne@69
|
8263 ** A few opcodes for [sqlite3_file_control()] are handled directly
|
|
jpayne@69
|
8264 ** by the SQLite core and never invoke the
|
|
jpayne@69
|
8265 ** sqlite3_io_methods.xFileControl method.
|
|
jpayne@69
|
8266 ** ^The [SQLITE_FCNTL_FILE_POINTER] value for the op parameter causes
|
|
jpayne@69
|
8267 ** a pointer to the underlying [sqlite3_file] object to be written into
|
|
jpayne@69
|
8268 ** the space pointed to by the 4th parameter. The
|
|
jpayne@69
|
8269 ** [SQLITE_FCNTL_JOURNAL_POINTER] works similarly except that it returns
|
|
jpayne@69
|
8270 ** the [sqlite3_file] object associated with the journal file instead of
|
|
jpayne@69
|
8271 ** the main database. The [SQLITE_FCNTL_VFS_POINTER] opcode returns
|
|
jpayne@69
|
8272 ** a pointer to the underlying [sqlite3_vfs] object for the file.
|
|
jpayne@69
|
8273 ** The [SQLITE_FCNTL_DATA_VERSION] returns the data version counter
|
|
jpayne@69
|
8274 ** from the pager.
|
|
jpayne@69
|
8275 **
|
|
jpayne@69
|
8276 ** ^If the second parameter (zDbName) does not match the name of any
|
|
jpayne@69
|
8277 ** open database file, then SQLITE_ERROR is returned. ^This error
|
|
jpayne@69
|
8278 ** code is not remembered and will not be recalled by [sqlite3_errcode()]
|
|
jpayne@69
|
8279 ** or [sqlite3_errmsg()]. The underlying xFileControl method might
|
|
jpayne@69
|
8280 ** also return SQLITE_ERROR. There is no way to distinguish between
|
|
jpayne@69
|
8281 ** an incorrect zDbName and an SQLITE_ERROR return from the underlying
|
|
jpayne@69
|
8282 ** xFileControl method.
|
|
jpayne@69
|
8283 **
|
|
jpayne@69
|
8284 ** See also: [file control opcodes]
|
|
jpayne@69
|
8285 */
|
|
jpayne@69
|
8286 SQLITE_API int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*);
|
|
jpayne@69
|
8287
|
|
jpayne@69
|
8288 /*
|
|
jpayne@69
|
8289 ** CAPI3REF: Testing Interface
|
|
jpayne@69
|
8290 **
|
|
jpayne@69
|
8291 ** ^The sqlite3_test_control() interface is used to read out internal
|
|
jpayne@69
|
8292 ** state of SQLite and to inject faults into SQLite for testing
|
|
jpayne@69
|
8293 ** purposes. ^The first parameter is an operation code that determines
|
|
jpayne@69
|
8294 ** the number, meaning, and operation of all subsequent parameters.
|
|
jpayne@69
|
8295 **
|
|
jpayne@69
|
8296 ** This interface is not for use by applications. It exists solely
|
|
jpayne@69
|
8297 ** for verifying the correct operation of the SQLite library. Depending
|
|
jpayne@69
|
8298 ** on how the SQLite library is compiled, this interface might not exist.
|
|
jpayne@69
|
8299 **
|
|
jpayne@69
|
8300 ** The details of the operation codes, their meanings, the parameters
|
|
jpayne@69
|
8301 ** they take, and what they do are all subject to change without notice.
|
|
jpayne@69
|
8302 ** Unlike most of the SQLite API, this function is not guaranteed to
|
|
jpayne@69
|
8303 ** operate consistently from one release to the next.
|
|
jpayne@69
|
8304 */
|
|
jpayne@69
|
8305 SQLITE_API int sqlite3_test_control(int op, ...);
|
|
jpayne@69
|
8306
|
|
jpayne@69
|
8307 /*
|
|
jpayne@69
|
8308 ** CAPI3REF: Testing Interface Operation Codes
|
|
jpayne@69
|
8309 **
|
|
jpayne@69
|
8310 ** These constants are the valid operation code parameters used
|
|
jpayne@69
|
8311 ** as the first argument to [sqlite3_test_control()].
|
|
jpayne@69
|
8312 **
|
|
jpayne@69
|
8313 ** These parameters and their meanings are subject to change
|
|
jpayne@69
|
8314 ** without notice. These values are for testing purposes only.
|
|
jpayne@69
|
8315 ** Applications should not use any of these parameters or the
|
|
jpayne@69
|
8316 ** [sqlite3_test_control()] interface.
|
|
jpayne@69
|
8317 */
|
|
jpayne@69
|
8318 #define SQLITE_TESTCTRL_FIRST 5
|
|
jpayne@69
|
8319 #define SQLITE_TESTCTRL_PRNG_SAVE 5
|
|
jpayne@69
|
8320 #define SQLITE_TESTCTRL_PRNG_RESTORE 6
|
|
jpayne@69
|
8321 #define SQLITE_TESTCTRL_PRNG_RESET 7 /* NOT USED */
|
|
jpayne@69
|
8322 #define SQLITE_TESTCTRL_FK_NO_ACTION 7
|
|
jpayne@69
|
8323 #define SQLITE_TESTCTRL_BITVEC_TEST 8
|
|
jpayne@69
|
8324 #define SQLITE_TESTCTRL_FAULT_INSTALL 9
|
|
jpayne@69
|
8325 #define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10
|
|
jpayne@69
|
8326 #define SQLITE_TESTCTRL_PENDING_BYTE 11
|
|
jpayne@69
|
8327 #define SQLITE_TESTCTRL_ASSERT 12
|
|
jpayne@69
|
8328 #define SQLITE_TESTCTRL_ALWAYS 13
|
|
jpayne@69
|
8329 #define SQLITE_TESTCTRL_RESERVE 14 /* NOT USED */
|
|
jpayne@69
|
8330 #define SQLITE_TESTCTRL_JSON_SELFCHECK 14
|
|
jpayne@69
|
8331 #define SQLITE_TESTCTRL_OPTIMIZATIONS 15
|
|
jpayne@69
|
8332 #define SQLITE_TESTCTRL_ISKEYWORD 16 /* NOT USED */
|
|
jpayne@69
|
8333 #define SQLITE_TESTCTRL_SCRATCHMALLOC 17 /* NOT USED */
|
|
jpayne@69
|
8334 #define SQLITE_TESTCTRL_INTERNAL_FUNCTIONS 17
|
|
jpayne@69
|
8335 #define SQLITE_TESTCTRL_LOCALTIME_FAULT 18
|
|
jpayne@69
|
8336 #define SQLITE_TESTCTRL_EXPLAIN_STMT 19 /* NOT USED */
|
|
jpayne@69
|
8337 #define SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD 19
|
|
jpayne@69
|
8338 #define SQLITE_TESTCTRL_NEVER_CORRUPT 20
|
|
jpayne@69
|
8339 #define SQLITE_TESTCTRL_VDBE_COVERAGE 21
|
|
jpayne@69
|
8340 #define SQLITE_TESTCTRL_BYTEORDER 22
|
|
jpayne@69
|
8341 #define SQLITE_TESTCTRL_ISINIT 23
|
|
jpayne@69
|
8342 #define SQLITE_TESTCTRL_SORTER_MMAP 24
|
|
jpayne@69
|
8343 #define SQLITE_TESTCTRL_IMPOSTER 25
|
|
jpayne@69
|
8344 #define SQLITE_TESTCTRL_PARSER_COVERAGE 26
|
|
jpayne@69
|
8345 #define SQLITE_TESTCTRL_RESULT_INTREAL 27
|
|
jpayne@69
|
8346 #define SQLITE_TESTCTRL_PRNG_SEED 28
|
|
jpayne@69
|
8347 #define SQLITE_TESTCTRL_EXTRA_SCHEMA_CHECKS 29
|
|
jpayne@69
|
8348 #define SQLITE_TESTCTRL_SEEK_COUNT 30
|
|
jpayne@69
|
8349 #define SQLITE_TESTCTRL_TRACEFLAGS 31
|
|
jpayne@69
|
8350 #define SQLITE_TESTCTRL_TUNE 32
|
|
jpayne@69
|
8351 #define SQLITE_TESTCTRL_LOGEST 33
|
|
jpayne@69
|
8352 #define SQLITE_TESTCTRL_USELONGDOUBLE 34
|
|
jpayne@69
|
8353 #define SQLITE_TESTCTRL_LAST 34 /* Largest TESTCTRL */
|
|
jpayne@69
|
8354
|
|
jpayne@69
|
8355 /*
|
|
jpayne@69
|
8356 ** CAPI3REF: SQL Keyword Checking
|
|
jpayne@69
|
8357 **
|
|
jpayne@69
|
8358 ** These routines provide access to the set of SQL language keywords
|
|
jpayne@69
|
8359 ** recognized by SQLite. Applications can uses these routines to determine
|
|
jpayne@69
|
8360 ** whether or not a specific identifier needs to be escaped (for example,
|
|
jpayne@69
|
8361 ** by enclosing in double-quotes) so as not to confuse the parser.
|
|
jpayne@69
|
8362 **
|
|
jpayne@69
|
8363 ** The sqlite3_keyword_count() interface returns the number of distinct
|
|
jpayne@69
|
8364 ** keywords understood by SQLite.
|
|
jpayne@69
|
8365 **
|
|
jpayne@69
|
8366 ** The sqlite3_keyword_name(N,Z,L) interface finds the 0-based N-th keyword and
|
|
jpayne@69
|
8367 ** makes *Z point to that keyword expressed as UTF8 and writes the number
|
|
jpayne@69
|
8368 ** of bytes in the keyword into *L. The string that *Z points to is not
|
|
jpayne@69
|
8369 ** zero-terminated. The sqlite3_keyword_name(N,Z,L) routine returns
|
|
jpayne@69
|
8370 ** SQLITE_OK if N is within bounds and SQLITE_ERROR if not. If either Z
|
|
jpayne@69
|
8371 ** or L are NULL or invalid pointers then calls to
|
|
jpayne@69
|
8372 ** sqlite3_keyword_name(N,Z,L) result in undefined behavior.
|
|
jpayne@69
|
8373 **
|
|
jpayne@69
|
8374 ** The sqlite3_keyword_check(Z,L) interface checks to see whether or not
|
|
jpayne@69
|
8375 ** the L-byte UTF8 identifier that Z points to is a keyword, returning non-zero
|
|
jpayne@69
|
8376 ** if it is and zero if not.
|
|
jpayne@69
|
8377 **
|
|
jpayne@69
|
8378 ** The parser used by SQLite is forgiving. It is often possible to use
|
|
jpayne@69
|
8379 ** a keyword as an identifier as long as such use does not result in a
|
|
jpayne@69
|
8380 ** parsing ambiguity. For example, the statement
|
|
jpayne@69
|
8381 ** "CREATE TABLE BEGIN(REPLACE,PRAGMA,END);" is accepted by SQLite, and
|
|
jpayne@69
|
8382 ** creates a new table named "BEGIN" with three columns named
|
|
jpayne@69
|
8383 ** "REPLACE", "PRAGMA", and "END". Nevertheless, best practice is to avoid
|
|
jpayne@69
|
8384 ** using keywords as identifiers. Common techniques used to avoid keyword
|
|
jpayne@69
|
8385 ** name collisions include:
|
|
jpayne@69
|
8386 ** <ul>
|
|
jpayne@69
|
8387 ** <li> Put all identifier names inside double-quotes. This is the official
|
|
jpayne@69
|
8388 ** SQL way to escape identifier names.
|
|
jpayne@69
|
8389 ** <li> Put identifier names inside [...]. This is not standard SQL,
|
|
jpayne@69
|
8390 ** but it is what SQL Server does and so lots of programmers use this
|
|
jpayne@69
|
8391 ** technique.
|
|
jpayne@69
|
8392 ** <li> Begin every identifier with the letter "Z" as no SQL keywords start
|
|
jpayne@69
|
8393 ** with "Z".
|
|
jpayne@69
|
8394 ** <li> Include a digit somewhere in every identifier name.
|
|
jpayne@69
|
8395 ** </ul>
|
|
jpayne@69
|
8396 **
|
|
jpayne@69
|
8397 ** Note that the number of keywords understood by SQLite can depend on
|
|
jpayne@69
|
8398 ** compile-time options. For example, "VACUUM" is not a keyword if
|
|
jpayne@69
|
8399 ** SQLite is compiled with the [-DSQLITE_OMIT_VACUUM] option. Also,
|
|
jpayne@69
|
8400 ** new keywords may be added to future releases of SQLite.
|
|
jpayne@69
|
8401 */
|
|
jpayne@69
|
8402 SQLITE_API int sqlite3_keyword_count(void);
|
|
jpayne@69
|
8403 SQLITE_API int sqlite3_keyword_name(int,const char**,int*);
|
|
jpayne@69
|
8404 SQLITE_API int sqlite3_keyword_check(const char*,int);
|
|
jpayne@69
|
8405
|
|
jpayne@69
|
8406 /*
|
|
jpayne@69
|
8407 ** CAPI3REF: Dynamic String Object
|
|
jpayne@69
|
8408 ** KEYWORDS: {dynamic string}
|
|
jpayne@69
|
8409 **
|
|
jpayne@69
|
8410 ** An instance of the sqlite3_str object contains a dynamically-sized
|
|
jpayne@69
|
8411 ** string under construction.
|
|
jpayne@69
|
8412 **
|
|
jpayne@69
|
8413 ** The lifecycle of an sqlite3_str object is as follows:
|
|
jpayne@69
|
8414 ** <ol>
|
|
jpayne@69
|
8415 ** <li> ^The sqlite3_str object is created using [sqlite3_str_new()].
|
|
jpayne@69
|
8416 ** <li> ^Text is appended to the sqlite3_str object using various
|
|
jpayne@69
|
8417 ** methods, such as [sqlite3_str_appendf()].
|
|
jpayne@69
|
8418 ** <li> ^The sqlite3_str object is destroyed and the string it created
|
|
jpayne@69
|
8419 ** is returned using the [sqlite3_str_finish()] interface.
|
|
jpayne@69
|
8420 ** </ol>
|
|
jpayne@69
|
8421 */
|
|
jpayne@69
|
8422 typedef struct sqlite3_str sqlite3_str;
|
|
jpayne@69
|
8423
|
|
jpayne@69
|
8424 /*
|
|
jpayne@69
|
8425 ** CAPI3REF: Create A New Dynamic String Object
|
|
jpayne@69
|
8426 ** CONSTRUCTOR: sqlite3_str
|
|
jpayne@69
|
8427 **
|
|
jpayne@69
|
8428 ** ^The [sqlite3_str_new(D)] interface allocates and initializes
|
|
jpayne@69
|
8429 ** a new [sqlite3_str] object. To avoid memory leaks, the object returned by
|
|
jpayne@69
|
8430 ** [sqlite3_str_new()] must be freed by a subsequent call to
|
|
jpayne@69
|
8431 ** [sqlite3_str_finish(X)].
|
|
jpayne@69
|
8432 **
|
|
jpayne@69
|
8433 ** ^The [sqlite3_str_new(D)] interface always returns a pointer to a
|
|
jpayne@69
|
8434 ** valid [sqlite3_str] object, though in the event of an out-of-memory
|
|
jpayne@69
|
8435 ** error the returned object might be a special singleton that will
|
|
jpayne@69
|
8436 ** silently reject new text, always return SQLITE_NOMEM from
|
|
jpayne@69
|
8437 ** [sqlite3_str_errcode()], always return 0 for
|
|
jpayne@69
|
8438 ** [sqlite3_str_length()], and always return NULL from
|
|
jpayne@69
|
8439 ** [sqlite3_str_finish(X)]. It is always safe to use the value
|
|
jpayne@69
|
8440 ** returned by [sqlite3_str_new(D)] as the sqlite3_str parameter
|
|
jpayne@69
|
8441 ** to any of the other [sqlite3_str] methods.
|
|
jpayne@69
|
8442 **
|
|
jpayne@69
|
8443 ** The D parameter to [sqlite3_str_new(D)] may be NULL. If the
|
|
jpayne@69
|
8444 ** D parameter in [sqlite3_str_new(D)] is not NULL, then the maximum
|
|
jpayne@69
|
8445 ** length of the string contained in the [sqlite3_str] object will be
|
|
jpayne@69
|
8446 ** the value set for [sqlite3_limit](D,[SQLITE_LIMIT_LENGTH]) instead
|
|
jpayne@69
|
8447 ** of [SQLITE_MAX_LENGTH].
|
|
jpayne@69
|
8448 */
|
|
jpayne@69
|
8449 SQLITE_API sqlite3_str *sqlite3_str_new(sqlite3*);
|
|
jpayne@69
|
8450
|
|
jpayne@69
|
8451 /*
|
|
jpayne@69
|
8452 ** CAPI3REF: Finalize A Dynamic String
|
|
jpayne@69
|
8453 ** DESTRUCTOR: sqlite3_str
|
|
jpayne@69
|
8454 **
|
|
jpayne@69
|
8455 ** ^The [sqlite3_str_finish(X)] interface destroys the sqlite3_str object X
|
|
jpayne@69
|
8456 ** and returns a pointer to a memory buffer obtained from [sqlite3_malloc64()]
|
|
jpayne@69
|
8457 ** that contains the constructed string. The calling application should
|
|
jpayne@69
|
8458 ** pass the returned value to [sqlite3_free()] to avoid a memory leak.
|
|
jpayne@69
|
8459 ** ^The [sqlite3_str_finish(X)] interface may return a NULL pointer if any
|
|
jpayne@69
|
8460 ** errors were encountered during construction of the string. ^The
|
|
jpayne@69
|
8461 ** [sqlite3_str_finish(X)] interface will also return a NULL pointer if the
|
|
jpayne@69
|
8462 ** string in [sqlite3_str] object X is zero bytes long.
|
|
jpayne@69
|
8463 */
|
|
jpayne@69
|
8464 SQLITE_API char *sqlite3_str_finish(sqlite3_str*);
|
|
jpayne@69
|
8465
|
|
jpayne@69
|
8466 /*
|
|
jpayne@69
|
8467 ** CAPI3REF: Add Content To A Dynamic String
|
|
jpayne@69
|
8468 ** METHOD: sqlite3_str
|
|
jpayne@69
|
8469 **
|
|
jpayne@69
|
8470 ** These interfaces add content to an sqlite3_str object previously obtained
|
|
jpayne@69
|
8471 ** from [sqlite3_str_new()].
|
|
jpayne@69
|
8472 **
|
|
jpayne@69
|
8473 ** ^The [sqlite3_str_appendf(X,F,...)] and
|
|
jpayne@69
|
8474 ** [sqlite3_str_vappendf(X,F,V)] interfaces uses the [built-in printf]
|
|
jpayne@69
|
8475 ** functionality of SQLite to append formatted text onto the end of
|
|
jpayne@69
|
8476 ** [sqlite3_str] object X.
|
|
jpayne@69
|
8477 **
|
|
jpayne@69
|
8478 ** ^The [sqlite3_str_append(X,S,N)] method appends exactly N bytes from string S
|
|
jpayne@69
|
8479 ** onto the end of the [sqlite3_str] object X. N must be non-negative.
|
|
jpayne@69
|
8480 ** S must contain at least N non-zero bytes of content. To append a
|
|
jpayne@69
|
8481 ** zero-terminated string in its entirety, use the [sqlite3_str_appendall()]
|
|
jpayne@69
|
8482 ** method instead.
|
|
jpayne@69
|
8483 **
|
|
jpayne@69
|
8484 ** ^The [sqlite3_str_appendall(X,S)] method appends the complete content of
|
|
jpayne@69
|
8485 ** zero-terminated string S onto the end of [sqlite3_str] object X.
|
|
jpayne@69
|
8486 **
|
|
jpayne@69
|
8487 ** ^The [sqlite3_str_appendchar(X,N,C)] method appends N copies of the
|
|
jpayne@69
|
8488 ** single-byte character C onto the end of [sqlite3_str] object X.
|
|
jpayne@69
|
8489 ** ^This method can be used, for example, to add whitespace indentation.
|
|
jpayne@69
|
8490 **
|
|
jpayne@69
|
8491 ** ^The [sqlite3_str_reset(X)] method resets the string under construction
|
|
jpayne@69
|
8492 ** inside [sqlite3_str] object X back to zero bytes in length.
|
|
jpayne@69
|
8493 **
|
|
jpayne@69
|
8494 ** These methods do not return a result code. ^If an error occurs, that fact
|
|
jpayne@69
|
8495 ** is recorded in the [sqlite3_str] object and can be recovered by a
|
|
jpayne@69
|
8496 ** subsequent call to [sqlite3_str_errcode(X)].
|
|
jpayne@69
|
8497 */
|
|
jpayne@69
|
8498 SQLITE_API void sqlite3_str_appendf(sqlite3_str*, const char *zFormat, ...);
|
|
jpayne@69
|
8499 SQLITE_API void sqlite3_str_vappendf(sqlite3_str*, const char *zFormat, va_list);
|
|
jpayne@69
|
8500 SQLITE_API void sqlite3_str_append(sqlite3_str*, const char *zIn, int N);
|
|
jpayne@69
|
8501 SQLITE_API void sqlite3_str_appendall(sqlite3_str*, const char *zIn);
|
|
jpayne@69
|
8502 SQLITE_API void sqlite3_str_appendchar(sqlite3_str*, int N, char C);
|
|
jpayne@69
|
8503 SQLITE_API void sqlite3_str_reset(sqlite3_str*);
|
|
jpayne@69
|
8504
|
|
jpayne@69
|
8505 /*
|
|
jpayne@69
|
8506 ** CAPI3REF: Status Of A Dynamic String
|
|
jpayne@69
|
8507 ** METHOD: sqlite3_str
|
|
jpayne@69
|
8508 **
|
|
jpayne@69
|
8509 ** These interfaces return the current status of an [sqlite3_str] object.
|
|
jpayne@69
|
8510 **
|
|
jpayne@69
|
8511 ** ^If any prior errors have occurred while constructing the dynamic string
|
|
jpayne@69
|
8512 ** in sqlite3_str X, then the [sqlite3_str_errcode(X)] method will return
|
|
jpayne@69
|
8513 ** an appropriate error code. ^The [sqlite3_str_errcode(X)] method returns
|
|
jpayne@69
|
8514 ** [SQLITE_NOMEM] following any out-of-memory error, or
|
|
jpayne@69
|
8515 ** [SQLITE_TOOBIG] if the size of the dynamic string exceeds
|
|
jpayne@69
|
8516 ** [SQLITE_MAX_LENGTH], or [SQLITE_OK] if there have been no errors.
|
|
jpayne@69
|
8517 **
|
|
jpayne@69
|
8518 ** ^The [sqlite3_str_length(X)] method returns the current length, in bytes,
|
|
jpayne@69
|
8519 ** of the dynamic string under construction in [sqlite3_str] object X.
|
|
jpayne@69
|
8520 ** ^The length returned by [sqlite3_str_length(X)] does not include the
|
|
jpayne@69
|
8521 ** zero-termination byte.
|
|
jpayne@69
|
8522 **
|
|
jpayne@69
|
8523 ** ^The [sqlite3_str_value(X)] method returns a pointer to the current
|
|
jpayne@69
|
8524 ** content of the dynamic string under construction in X. The value
|
|
jpayne@69
|
8525 ** returned by [sqlite3_str_value(X)] is managed by the sqlite3_str object X
|
|
jpayne@69
|
8526 ** and might be freed or altered by any subsequent method on the same
|
|
jpayne@69
|
8527 ** [sqlite3_str] object. Applications must not used the pointer returned
|
|
jpayne@69
|
8528 ** [sqlite3_str_value(X)] after any subsequent method call on the same
|
|
jpayne@69
|
8529 ** object. ^Applications may change the content of the string returned
|
|
jpayne@69
|
8530 ** by [sqlite3_str_value(X)] as long as they do not write into any bytes
|
|
jpayne@69
|
8531 ** outside the range of 0 to [sqlite3_str_length(X)] and do not read or
|
|
jpayne@69
|
8532 ** write any byte after any subsequent sqlite3_str method call.
|
|
jpayne@69
|
8533 */
|
|
jpayne@69
|
8534 SQLITE_API int sqlite3_str_errcode(sqlite3_str*);
|
|
jpayne@69
|
8535 SQLITE_API int sqlite3_str_length(sqlite3_str*);
|
|
jpayne@69
|
8536 SQLITE_API char *sqlite3_str_value(sqlite3_str*);
|
|
jpayne@69
|
8537
|
|
jpayne@69
|
8538 /*
|
|
jpayne@69
|
8539 ** CAPI3REF: SQLite Runtime Status
|
|
jpayne@69
|
8540 **
|
|
jpayne@69
|
8541 ** ^These interfaces are used to retrieve runtime status information
|
|
jpayne@69
|
8542 ** about the performance of SQLite, and optionally to reset various
|
|
jpayne@69
|
8543 ** highwater marks. ^The first argument is an integer code for
|
|
jpayne@69
|
8544 ** the specific parameter to measure. ^(Recognized integer codes
|
|
jpayne@69
|
8545 ** are of the form [status parameters | SQLITE_STATUS_...].)^
|
|
jpayne@69
|
8546 ** ^The current value of the parameter is returned into *pCurrent.
|
|
jpayne@69
|
8547 ** ^The highest recorded value is returned in *pHighwater. ^If the
|
|
jpayne@69
|
8548 ** resetFlag is true, then the highest record value is reset after
|
|
jpayne@69
|
8549 ** *pHighwater is written. ^(Some parameters do not record the highest
|
|
jpayne@69
|
8550 ** value. For those parameters
|
|
jpayne@69
|
8551 ** nothing is written into *pHighwater and the resetFlag is ignored.)^
|
|
jpayne@69
|
8552 ** ^(Other parameters record only the highwater mark and not the current
|
|
jpayne@69
|
8553 ** value. For these latter parameters nothing is written into *pCurrent.)^
|
|
jpayne@69
|
8554 **
|
|
jpayne@69
|
8555 ** ^The sqlite3_status() and sqlite3_status64() routines return
|
|
jpayne@69
|
8556 ** SQLITE_OK on success and a non-zero [error code] on failure.
|
|
jpayne@69
|
8557 **
|
|
jpayne@69
|
8558 ** If either the current value or the highwater mark is too large to
|
|
jpayne@69
|
8559 ** be represented by a 32-bit integer, then the values returned by
|
|
jpayne@69
|
8560 ** sqlite3_status() are undefined.
|
|
jpayne@69
|
8561 **
|
|
jpayne@69
|
8562 ** See also: [sqlite3_db_status()]
|
|
jpayne@69
|
8563 */
|
|
jpayne@69
|
8564 SQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag);
|
|
jpayne@69
|
8565 SQLITE_API int sqlite3_status64(
|
|
jpayne@69
|
8566 int op,
|
|
jpayne@69
|
8567 sqlite3_int64 *pCurrent,
|
|
jpayne@69
|
8568 sqlite3_int64 *pHighwater,
|
|
jpayne@69
|
8569 int resetFlag
|
|
jpayne@69
|
8570 );
|
|
jpayne@69
|
8571
|
|
jpayne@69
|
8572
|
|
jpayne@69
|
8573 /*
|
|
jpayne@69
|
8574 ** CAPI3REF: Status Parameters
|
|
jpayne@69
|
8575 ** KEYWORDS: {status parameters}
|
|
jpayne@69
|
8576 **
|
|
jpayne@69
|
8577 ** These integer constants designate various run-time status parameters
|
|
jpayne@69
|
8578 ** that can be returned by [sqlite3_status()].
|
|
jpayne@69
|
8579 **
|
|
jpayne@69
|
8580 ** <dl>
|
|
jpayne@69
|
8581 ** [[SQLITE_STATUS_MEMORY_USED]] ^(<dt>SQLITE_STATUS_MEMORY_USED</dt>
|
|
jpayne@69
|
8582 ** <dd>This parameter is the current amount of memory checked out
|
|
jpayne@69
|
8583 ** using [sqlite3_malloc()], either directly or indirectly. The
|
|
jpayne@69
|
8584 ** figure includes calls made to [sqlite3_malloc()] by the application
|
|
jpayne@69
|
8585 ** and internal memory usage by the SQLite library. Auxiliary page-cache
|
|
jpayne@69
|
8586 ** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in
|
|
jpayne@69
|
8587 ** this parameter. The amount returned is the sum of the allocation
|
|
jpayne@69
|
8588 ** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^
|
|
jpayne@69
|
8589 **
|
|
jpayne@69
|
8590 ** [[SQLITE_STATUS_MALLOC_SIZE]] ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt>
|
|
jpayne@69
|
8591 ** <dd>This parameter records the largest memory allocation request
|
|
jpayne@69
|
8592 ** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their
|
|
jpayne@69
|
8593 ** internal equivalents). Only the value returned in the
|
|
jpayne@69
|
8594 ** *pHighwater parameter to [sqlite3_status()] is of interest.
|
|
jpayne@69
|
8595 ** The value written into the *pCurrent parameter is undefined.</dd>)^
|
|
jpayne@69
|
8596 **
|
|
jpayne@69
|
8597 ** [[SQLITE_STATUS_MALLOC_COUNT]] ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt>
|
|
jpayne@69
|
8598 ** <dd>This parameter records the number of separate memory allocations
|
|
jpayne@69
|
8599 ** currently checked out.</dd>)^
|
|
jpayne@69
|
8600 **
|
|
jpayne@69
|
8601 ** [[SQLITE_STATUS_PAGECACHE_USED]] ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt>
|
|
jpayne@69
|
8602 ** <dd>This parameter returns the number of pages used out of the
|
|
jpayne@69
|
8603 ** [pagecache memory allocator] that was configured using
|
|
jpayne@69
|
8604 ** [SQLITE_CONFIG_PAGECACHE]. The
|
|
jpayne@69
|
8605 ** value returned is in pages, not in bytes.</dd>)^
|
|
jpayne@69
|
8606 **
|
|
jpayne@69
|
8607 ** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]]
|
|
jpayne@69
|
8608 ** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt>
|
|
jpayne@69
|
8609 ** <dd>This parameter returns the number of bytes of page cache
|
|
jpayne@69
|
8610 ** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE]
|
|
jpayne@69
|
8611 ** buffer and where forced to overflow to [sqlite3_malloc()]. The
|
|
jpayne@69
|
8612 ** returned value includes allocations that overflowed because they
|
|
jpayne@69
|
8613 ** where too large (they were larger than the "sz" parameter to
|
|
jpayne@69
|
8614 ** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because
|
|
jpayne@69
|
8615 ** no space was left in the page cache.</dd>)^
|
|
jpayne@69
|
8616 **
|
|
jpayne@69
|
8617 ** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt>
|
|
jpayne@69
|
8618 ** <dd>This parameter records the largest memory allocation request
|
|
jpayne@69
|
8619 ** handed to the [pagecache memory allocator]. Only the value returned in the
|
|
jpayne@69
|
8620 ** *pHighwater parameter to [sqlite3_status()] is of interest.
|
|
jpayne@69
|
8621 ** The value written into the *pCurrent parameter is undefined.</dd>)^
|
|
jpayne@69
|
8622 **
|
|
jpayne@69
|
8623 ** [[SQLITE_STATUS_SCRATCH_USED]] <dt>SQLITE_STATUS_SCRATCH_USED</dt>
|
|
jpayne@69
|
8624 ** <dd>No longer used.</dd>
|
|
jpayne@69
|
8625 **
|
|
jpayne@69
|
8626 ** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt>
|
|
jpayne@69
|
8627 ** <dd>No longer used.</dd>
|
|
jpayne@69
|
8628 **
|
|
jpayne@69
|
8629 ** [[SQLITE_STATUS_SCRATCH_SIZE]] <dt>SQLITE_STATUS_SCRATCH_SIZE</dt>
|
|
jpayne@69
|
8630 ** <dd>No longer used.</dd>
|
|
jpayne@69
|
8631 **
|
|
jpayne@69
|
8632 ** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt>
|
|
jpayne@69
|
8633 ** <dd>The *pHighwater parameter records the deepest parser stack.
|
|
jpayne@69
|
8634 ** The *pCurrent value is undefined. The *pHighwater value is only
|
|
jpayne@69
|
8635 ** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^
|
|
jpayne@69
|
8636 ** </dl>
|
|
jpayne@69
|
8637 **
|
|
jpayne@69
|
8638 ** New status parameters may be added from time to time.
|
|
jpayne@69
|
8639 */
|
|
jpayne@69
|
8640 #define SQLITE_STATUS_MEMORY_USED 0
|
|
jpayne@69
|
8641 #define SQLITE_STATUS_PAGECACHE_USED 1
|
|
jpayne@69
|
8642 #define SQLITE_STATUS_PAGECACHE_OVERFLOW 2
|
|
jpayne@69
|
8643 #define SQLITE_STATUS_SCRATCH_USED 3 /* NOT USED */
|
|
jpayne@69
|
8644 #define SQLITE_STATUS_SCRATCH_OVERFLOW 4 /* NOT USED */
|
|
jpayne@69
|
8645 #define SQLITE_STATUS_MALLOC_SIZE 5
|
|
jpayne@69
|
8646 #define SQLITE_STATUS_PARSER_STACK 6
|
|
jpayne@69
|
8647 #define SQLITE_STATUS_PAGECACHE_SIZE 7
|
|
jpayne@69
|
8648 #define SQLITE_STATUS_SCRATCH_SIZE 8 /* NOT USED */
|
|
jpayne@69
|
8649 #define SQLITE_STATUS_MALLOC_COUNT 9
|
|
jpayne@69
|
8650
|
|
jpayne@69
|
8651 /*
|
|
jpayne@69
|
8652 ** CAPI3REF: Database Connection Status
|
|
jpayne@69
|
8653 ** METHOD: sqlite3
|
|
jpayne@69
|
8654 **
|
|
jpayne@69
|
8655 ** ^This interface is used to retrieve runtime status information
|
|
jpayne@69
|
8656 ** about a single [database connection]. ^The first argument is the
|
|
jpayne@69
|
8657 ** database connection object to be interrogated. ^The second argument
|
|
jpayne@69
|
8658 ** is an integer constant, taken from the set of
|
|
jpayne@69
|
8659 ** [SQLITE_DBSTATUS options], that
|
|
jpayne@69
|
8660 ** determines the parameter to interrogate. The set of
|
|
jpayne@69
|
8661 ** [SQLITE_DBSTATUS options] is likely
|
|
jpayne@69
|
8662 ** to grow in future releases of SQLite.
|
|
jpayne@69
|
8663 **
|
|
jpayne@69
|
8664 ** ^The current value of the requested parameter is written into *pCur
|
|
jpayne@69
|
8665 ** and the highest instantaneous value is written into *pHiwtr. ^If
|
|
jpayne@69
|
8666 ** the resetFlg is true, then the highest instantaneous value is
|
|
jpayne@69
|
8667 ** reset back down to the current value.
|
|
jpayne@69
|
8668 **
|
|
jpayne@69
|
8669 ** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a
|
|
jpayne@69
|
8670 ** non-zero [error code] on failure.
|
|
jpayne@69
|
8671 **
|
|
jpayne@69
|
8672 ** See also: [sqlite3_status()] and [sqlite3_stmt_status()].
|
|
jpayne@69
|
8673 */
|
|
jpayne@69
|
8674 SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg);
|
|
jpayne@69
|
8675
|
|
jpayne@69
|
8676 /*
|
|
jpayne@69
|
8677 ** CAPI3REF: Status Parameters for database connections
|
|
jpayne@69
|
8678 ** KEYWORDS: {SQLITE_DBSTATUS options}
|
|
jpayne@69
|
8679 **
|
|
jpayne@69
|
8680 ** These constants are the available integer "verbs" that can be passed as
|
|
jpayne@69
|
8681 ** the second argument to the [sqlite3_db_status()] interface.
|
|
jpayne@69
|
8682 **
|
|
jpayne@69
|
8683 ** New verbs may be added in future releases of SQLite. Existing verbs
|
|
jpayne@69
|
8684 ** might be discontinued. Applications should check the return code from
|
|
jpayne@69
|
8685 ** [sqlite3_db_status()] to make sure that the call worked.
|
|
jpayne@69
|
8686 ** The [sqlite3_db_status()] interface will return a non-zero error code
|
|
jpayne@69
|
8687 ** if a discontinued or unsupported verb is invoked.
|
|
jpayne@69
|
8688 **
|
|
jpayne@69
|
8689 ** <dl>
|
|
jpayne@69
|
8690 ** [[SQLITE_DBSTATUS_LOOKASIDE_USED]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt>
|
|
jpayne@69
|
8691 ** <dd>This parameter returns the number of lookaside memory slots currently
|
|
jpayne@69
|
8692 ** checked out.</dd>)^
|
|
jpayne@69
|
8693 **
|
|
jpayne@69
|
8694 ** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt>
|
|
jpayne@69
|
8695 ** <dd>This parameter returns the number of malloc attempts that were
|
|
jpayne@69
|
8696 ** satisfied using lookaside memory. Only the high-water value is meaningful;
|
|
jpayne@69
|
8697 ** the current value is always zero.)^
|
|
jpayne@69
|
8698 **
|
|
jpayne@69
|
8699 ** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE]]
|
|
jpayne@69
|
8700 ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt>
|
|
jpayne@69
|
8701 ** <dd>This parameter returns the number malloc attempts that might have
|
|
jpayne@69
|
8702 ** been satisfied using lookaside memory but failed due to the amount of
|
|
jpayne@69
|
8703 ** memory requested being larger than the lookaside slot size.
|
|
jpayne@69
|
8704 ** Only the high-water value is meaningful;
|
|
jpayne@69
|
8705 ** the current value is always zero.)^
|
|
jpayne@69
|
8706 **
|
|
jpayne@69
|
8707 ** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL]]
|
|
jpayne@69
|
8708 ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt>
|
|
jpayne@69
|
8709 ** <dd>This parameter returns the number malloc attempts that might have
|
|
jpayne@69
|
8710 ** been satisfied using lookaside memory but failed due to all lookaside
|
|
jpayne@69
|
8711 ** memory already being in use.
|
|
jpayne@69
|
8712 ** Only the high-water value is meaningful;
|
|
jpayne@69
|
8713 ** the current value is always zero.)^
|
|
jpayne@69
|
8714 **
|
|
jpayne@69
|
8715 ** [[SQLITE_DBSTATUS_CACHE_USED]] ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt>
|
|
jpayne@69
|
8716 ** <dd>This parameter returns the approximate number of bytes of heap
|
|
jpayne@69
|
8717 ** memory used by all pager caches associated with the database connection.)^
|
|
jpayne@69
|
8718 ** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0.
|
|
jpayne@69
|
8719 **
|
|
jpayne@69
|
8720 ** [[SQLITE_DBSTATUS_CACHE_USED_SHARED]]
|
|
jpayne@69
|
8721 ** ^(<dt>SQLITE_DBSTATUS_CACHE_USED_SHARED</dt>
|
|
jpayne@69
|
8722 ** <dd>This parameter is similar to DBSTATUS_CACHE_USED, except that if a
|
|
jpayne@69
|
8723 ** pager cache is shared between two or more connections the bytes of heap
|
|
jpayne@69
|
8724 ** memory used by that pager cache is divided evenly between the attached
|
|
jpayne@69
|
8725 ** connections.)^ In other words, if none of the pager caches associated
|
|
jpayne@69
|
8726 ** with the database connection are shared, this request returns the same
|
|
jpayne@69
|
8727 ** value as DBSTATUS_CACHE_USED. Or, if one or more or the pager caches are
|
|
jpayne@69
|
8728 ** shared, the value returned by this call will be smaller than that returned
|
|
jpayne@69
|
8729 ** by DBSTATUS_CACHE_USED. ^The highwater mark associated with
|
|
jpayne@69
|
8730 ** SQLITE_DBSTATUS_CACHE_USED_SHARED is always 0.
|
|
jpayne@69
|
8731 **
|
|
jpayne@69
|
8732 ** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt>
|
|
jpayne@69
|
8733 ** <dd>This parameter returns the approximate number of bytes of heap
|
|
jpayne@69
|
8734 ** memory used to store the schema for all databases associated
|
|
jpayne@69
|
8735 ** with the connection - main, temp, and any [ATTACH]-ed databases.)^
|
|
jpayne@69
|
8736 ** ^The full amount of memory used by the schemas is reported, even if the
|
|
jpayne@69
|
8737 ** schema memory is shared with other database connections due to
|
|
jpayne@69
|
8738 ** [shared cache mode] being enabled.
|
|
jpayne@69
|
8739 ** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0.
|
|
jpayne@69
|
8740 **
|
|
jpayne@69
|
8741 ** [[SQLITE_DBSTATUS_STMT_USED]] ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt>
|
|
jpayne@69
|
8742 ** <dd>This parameter returns the approximate number of bytes of heap
|
|
jpayne@69
|
8743 ** and lookaside memory used by all prepared statements associated with
|
|
jpayne@69
|
8744 ** the database connection.)^
|
|
jpayne@69
|
8745 ** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0.
|
|
jpayne@69
|
8746 ** </dd>
|
|
jpayne@69
|
8747 **
|
|
jpayne@69
|
8748 ** [[SQLITE_DBSTATUS_CACHE_HIT]] ^(<dt>SQLITE_DBSTATUS_CACHE_HIT</dt>
|
|
jpayne@69
|
8749 ** <dd>This parameter returns the number of pager cache hits that have
|
|
jpayne@69
|
8750 ** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT
|
|
jpayne@69
|
8751 ** is always 0.
|
|
jpayne@69
|
8752 ** </dd>
|
|
jpayne@69
|
8753 **
|
|
jpayne@69
|
8754 ** [[SQLITE_DBSTATUS_CACHE_MISS]] ^(<dt>SQLITE_DBSTATUS_CACHE_MISS</dt>
|
|
jpayne@69
|
8755 ** <dd>This parameter returns the number of pager cache misses that have
|
|
jpayne@69
|
8756 ** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS
|
|
jpayne@69
|
8757 ** is always 0.
|
|
jpayne@69
|
8758 ** </dd>
|
|
jpayne@69
|
8759 **
|
|
jpayne@69
|
8760 ** [[SQLITE_DBSTATUS_CACHE_WRITE]] ^(<dt>SQLITE_DBSTATUS_CACHE_WRITE</dt>
|
|
jpayne@69
|
8761 ** <dd>This parameter returns the number of dirty cache entries that have
|
|
jpayne@69
|
8762 ** been written to disk. Specifically, the number of pages written to the
|
|
jpayne@69
|
8763 ** wal file in wal mode databases, or the number of pages written to the
|
|
jpayne@69
|
8764 ** database file in rollback mode databases. Any pages written as part of
|
|
jpayne@69
|
8765 ** transaction rollback or database recovery operations are not included.
|
|
jpayne@69
|
8766 ** If an IO or other error occurs while writing a page to disk, the effect
|
|
jpayne@69
|
8767 ** on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined.)^ ^The
|
|
jpayne@69
|
8768 ** highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0.
|
|
jpayne@69
|
8769 ** </dd>
|
|
jpayne@69
|
8770 **
|
|
jpayne@69
|
8771 ** [[SQLITE_DBSTATUS_CACHE_SPILL]] ^(<dt>SQLITE_DBSTATUS_CACHE_SPILL</dt>
|
|
jpayne@69
|
8772 ** <dd>This parameter returns the number of dirty cache entries that have
|
|
jpayne@69
|
8773 ** been written to disk in the middle of a transaction due to the page
|
|
jpayne@69
|
8774 ** cache overflowing. Transactions are more efficient if they are written
|
|
jpayne@69
|
8775 ** to disk all at once. When pages spill mid-transaction, that introduces
|
|
jpayne@69
|
8776 ** additional overhead. This parameter can be used help identify
|
|
jpayne@69
|
8777 ** inefficiencies that can be resolved by increasing the cache size.
|
|
jpayne@69
|
8778 ** </dd>
|
|
jpayne@69
|
8779 **
|
|
jpayne@69
|
8780 ** [[SQLITE_DBSTATUS_DEFERRED_FKS]] ^(<dt>SQLITE_DBSTATUS_DEFERRED_FKS</dt>
|
|
jpayne@69
|
8781 ** <dd>This parameter returns zero for the current value if and only if
|
|
jpayne@69
|
8782 ** all foreign key constraints (deferred or immediate) have been
|
|
jpayne@69
|
8783 ** resolved.)^ ^The highwater mark is always 0.
|
|
jpayne@69
|
8784 ** </dd>
|
|
jpayne@69
|
8785 ** </dl>
|
|
jpayne@69
|
8786 */
|
|
jpayne@69
|
8787 #define SQLITE_DBSTATUS_LOOKASIDE_USED 0
|
|
jpayne@69
|
8788 #define SQLITE_DBSTATUS_CACHE_USED 1
|
|
jpayne@69
|
8789 #define SQLITE_DBSTATUS_SCHEMA_USED 2
|
|
jpayne@69
|
8790 #define SQLITE_DBSTATUS_STMT_USED 3
|
|
jpayne@69
|
8791 #define SQLITE_DBSTATUS_LOOKASIDE_HIT 4
|
|
jpayne@69
|
8792 #define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE 5
|
|
jpayne@69
|
8793 #define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6
|
|
jpayne@69
|
8794 #define SQLITE_DBSTATUS_CACHE_HIT 7
|
|
jpayne@69
|
8795 #define SQLITE_DBSTATUS_CACHE_MISS 8
|
|
jpayne@69
|
8796 #define SQLITE_DBSTATUS_CACHE_WRITE 9
|
|
jpayne@69
|
8797 #define SQLITE_DBSTATUS_DEFERRED_FKS 10
|
|
jpayne@69
|
8798 #define SQLITE_DBSTATUS_CACHE_USED_SHARED 11
|
|
jpayne@69
|
8799 #define SQLITE_DBSTATUS_CACHE_SPILL 12
|
|
jpayne@69
|
8800 #define SQLITE_DBSTATUS_MAX 12 /* Largest defined DBSTATUS */
|
|
jpayne@69
|
8801
|
|
jpayne@69
|
8802
|
|
jpayne@69
|
8803 /*
|
|
jpayne@69
|
8804 ** CAPI3REF: Prepared Statement Status
|
|
jpayne@69
|
8805 ** METHOD: sqlite3_stmt
|
|
jpayne@69
|
8806 **
|
|
jpayne@69
|
8807 ** ^(Each prepared statement maintains various
|
|
jpayne@69
|
8808 ** [SQLITE_STMTSTATUS counters] that measure the number
|
|
jpayne@69
|
8809 ** of times it has performed specific operations.)^ These counters can
|
|
jpayne@69
|
8810 ** be used to monitor the performance characteristics of the prepared
|
|
jpayne@69
|
8811 ** statements. For example, if the number of table steps greatly exceeds
|
|
jpayne@69
|
8812 ** the number of table searches or result rows, that would tend to indicate
|
|
jpayne@69
|
8813 ** that the prepared statement is using a full table scan rather than
|
|
jpayne@69
|
8814 ** an index.
|
|
jpayne@69
|
8815 **
|
|
jpayne@69
|
8816 ** ^(This interface is used to retrieve and reset counter values from
|
|
jpayne@69
|
8817 ** a [prepared statement]. The first argument is the prepared statement
|
|
jpayne@69
|
8818 ** object to be interrogated. The second argument
|
|
jpayne@69
|
8819 ** is an integer code for a specific [SQLITE_STMTSTATUS counter]
|
|
jpayne@69
|
8820 ** to be interrogated.)^
|
|
jpayne@69
|
8821 ** ^The current value of the requested counter is returned.
|
|
jpayne@69
|
8822 ** ^If the resetFlg is true, then the counter is reset to zero after this
|
|
jpayne@69
|
8823 ** interface call returns.
|
|
jpayne@69
|
8824 **
|
|
jpayne@69
|
8825 ** See also: [sqlite3_status()] and [sqlite3_db_status()].
|
|
jpayne@69
|
8826 */
|
|
jpayne@69
|
8827 SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg);
|
|
jpayne@69
|
8828
|
|
jpayne@69
|
8829 /*
|
|
jpayne@69
|
8830 ** CAPI3REF: Status Parameters for prepared statements
|
|
jpayne@69
|
8831 ** KEYWORDS: {SQLITE_STMTSTATUS counter} {SQLITE_STMTSTATUS counters}
|
|
jpayne@69
|
8832 **
|
|
jpayne@69
|
8833 ** These preprocessor macros define integer codes that name counter
|
|
jpayne@69
|
8834 ** values associated with the [sqlite3_stmt_status()] interface.
|
|
jpayne@69
|
8835 ** The meanings of the various counters are as follows:
|
|
jpayne@69
|
8836 **
|
|
jpayne@69
|
8837 ** <dl>
|
|
jpayne@69
|
8838 ** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]] <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt>
|
|
jpayne@69
|
8839 ** <dd>^This is the number of times that SQLite has stepped forward in
|
|
jpayne@69
|
8840 ** a table as part of a full table scan. Large numbers for this counter
|
|
jpayne@69
|
8841 ** may indicate opportunities for performance improvement through
|
|
jpayne@69
|
8842 ** careful use of indices.</dd>
|
|
jpayne@69
|
8843 **
|
|
jpayne@69
|
8844 ** [[SQLITE_STMTSTATUS_SORT]] <dt>SQLITE_STMTSTATUS_SORT</dt>
|
|
jpayne@69
|
8845 ** <dd>^This is the number of sort operations that have occurred.
|
|
jpayne@69
|
8846 ** A non-zero value in this counter may indicate an opportunity to
|
|
jpayne@69
|
8847 ** improvement performance through careful use of indices.</dd>
|
|
jpayne@69
|
8848 **
|
|
jpayne@69
|
8849 ** [[SQLITE_STMTSTATUS_AUTOINDEX]] <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt>
|
|
jpayne@69
|
8850 ** <dd>^This is the number of rows inserted into transient indices that
|
|
jpayne@69
|
8851 ** were created automatically in order to help joins run faster.
|
|
jpayne@69
|
8852 ** A non-zero value in this counter may indicate an opportunity to
|
|
jpayne@69
|
8853 ** improvement performance by adding permanent indices that do not
|
|
jpayne@69
|
8854 ** need to be reinitialized each time the statement is run.</dd>
|
|
jpayne@69
|
8855 **
|
|
jpayne@69
|
8856 ** [[SQLITE_STMTSTATUS_VM_STEP]] <dt>SQLITE_STMTSTATUS_VM_STEP</dt>
|
|
jpayne@69
|
8857 ** <dd>^This is the number of virtual machine operations executed
|
|
jpayne@69
|
8858 ** by the prepared statement if that number is less than or equal
|
|
jpayne@69
|
8859 ** to 2147483647. The number of virtual machine operations can be
|
|
jpayne@69
|
8860 ** used as a proxy for the total work done by the prepared statement.
|
|
jpayne@69
|
8861 ** If the number of virtual machine operations exceeds 2147483647
|
|
jpayne@69
|
8862 ** then the value returned by this statement status code is undefined.
|
|
jpayne@69
|
8863 **
|
|
jpayne@69
|
8864 ** [[SQLITE_STMTSTATUS_REPREPARE]] <dt>SQLITE_STMTSTATUS_REPREPARE</dt>
|
|
jpayne@69
|
8865 ** <dd>^This is the number of times that the prepare statement has been
|
|
jpayne@69
|
8866 ** automatically regenerated due to schema changes or changes to
|
|
jpayne@69
|
8867 ** [bound parameters] that might affect the query plan.
|
|
jpayne@69
|
8868 **
|
|
jpayne@69
|
8869 ** [[SQLITE_STMTSTATUS_RUN]] <dt>SQLITE_STMTSTATUS_RUN</dt>
|
|
jpayne@69
|
8870 ** <dd>^This is the number of times that the prepared statement has
|
|
jpayne@69
|
8871 ** been run. A single "run" for the purposes of this counter is one
|
|
jpayne@69
|
8872 ** or more calls to [sqlite3_step()] followed by a call to [sqlite3_reset()].
|
|
jpayne@69
|
8873 ** The counter is incremented on the first [sqlite3_step()] call of each
|
|
jpayne@69
|
8874 ** cycle.
|
|
jpayne@69
|
8875 **
|
|
jpayne@69
|
8876 ** [[SQLITE_STMTSTATUS_FILTER_MISS]]
|
|
jpayne@69
|
8877 ** [[SQLITE_STMTSTATUS_FILTER HIT]]
|
|
jpayne@69
|
8878 ** <dt>SQLITE_STMTSTATUS_FILTER_HIT<br>
|
|
jpayne@69
|
8879 ** SQLITE_STMTSTATUS_FILTER_MISS</dt>
|
|
jpayne@69
|
8880 ** <dd>^SQLITE_STMTSTATUS_FILTER_HIT is the number of times that a join
|
|
jpayne@69
|
8881 ** step was bypassed because a Bloom filter returned not-found. The
|
|
jpayne@69
|
8882 ** corresponding SQLITE_STMTSTATUS_FILTER_MISS value is the number of
|
|
jpayne@69
|
8883 ** times that the Bloom filter returned a find, and thus the join step
|
|
jpayne@69
|
8884 ** had to be processed as normal.
|
|
jpayne@69
|
8885 **
|
|
jpayne@69
|
8886 ** [[SQLITE_STMTSTATUS_MEMUSED]] <dt>SQLITE_STMTSTATUS_MEMUSED</dt>
|
|
jpayne@69
|
8887 ** <dd>^This is the approximate number of bytes of heap memory
|
|
jpayne@69
|
8888 ** used to store the prepared statement. ^This value is not actually
|
|
jpayne@69
|
8889 ** a counter, and so the resetFlg parameter to sqlite3_stmt_status()
|
|
jpayne@69
|
8890 ** is ignored when the opcode is SQLITE_STMTSTATUS_MEMUSED.
|
|
jpayne@69
|
8891 ** </dd>
|
|
jpayne@69
|
8892 ** </dl>
|
|
jpayne@69
|
8893 */
|
|
jpayne@69
|
8894 #define SQLITE_STMTSTATUS_FULLSCAN_STEP 1
|
|
jpayne@69
|
8895 #define SQLITE_STMTSTATUS_SORT 2
|
|
jpayne@69
|
8896 #define SQLITE_STMTSTATUS_AUTOINDEX 3
|
|
jpayne@69
|
8897 #define SQLITE_STMTSTATUS_VM_STEP 4
|
|
jpayne@69
|
8898 #define SQLITE_STMTSTATUS_REPREPARE 5
|
|
jpayne@69
|
8899 #define SQLITE_STMTSTATUS_RUN 6
|
|
jpayne@69
|
8900 #define SQLITE_STMTSTATUS_FILTER_MISS 7
|
|
jpayne@69
|
8901 #define SQLITE_STMTSTATUS_FILTER_HIT 8
|
|
jpayne@69
|
8902 #define SQLITE_STMTSTATUS_MEMUSED 99
|
|
jpayne@69
|
8903
|
|
jpayne@69
|
8904 /*
|
|
jpayne@69
|
8905 ** CAPI3REF: Custom Page Cache Object
|
|
jpayne@69
|
8906 **
|
|
jpayne@69
|
8907 ** The sqlite3_pcache type is opaque. It is implemented by
|
|
jpayne@69
|
8908 ** the pluggable module. The SQLite core has no knowledge of
|
|
jpayne@69
|
8909 ** its size or internal structure and never deals with the
|
|
jpayne@69
|
8910 ** sqlite3_pcache object except by holding and passing pointers
|
|
jpayne@69
|
8911 ** to the object.
|
|
jpayne@69
|
8912 **
|
|
jpayne@69
|
8913 ** See [sqlite3_pcache_methods2] for additional information.
|
|
jpayne@69
|
8914 */
|
|
jpayne@69
|
8915 typedef struct sqlite3_pcache sqlite3_pcache;
|
|
jpayne@69
|
8916
|
|
jpayne@69
|
8917 /*
|
|
jpayne@69
|
8918 ** CAPI3REF: Custom Page Cache Object
|
|
jpayne@69
|
8919 **
|
|
jpayne@69
|
8920 ** The sqlite3_pcache_page object represents a single page in the
|
|
jpayne@69
|
8921 ** page cache. The page cache will allocate instances of this
|
|
jpayne@69
|
8922 ** object. Various methods of the page cache use pointers to instances
|
|
jpayne@69
|
8923 ** of this object as parameters or as their return value.
|
|
jpayne@69
|
8924 **
|
|
jpayne@69
|
8925 ** See [sqlite3_pcache_methods2] for additional information.
|
|
jpayne@69
|
8926 */
|
|
jpayne@69
|
8927 typedef struct sqlite3_pcache_page sqlite3_pcache_page;
|
|
jpayne@69
|
8928 struct sqlite3_pcache_page {
|
|
jpayne@69
|
8929 void *pBuf; /* The content of the page */
|
|
jpayne@69
|
8930 void *pExtra; /* Extra information associated with the page */
|
|
jpayne@69
|
8931 };
|
|
jpayne@69
|
8932
|
|
jpayne@69
|
8933 /*
|
|
jpayne@69
|
8934 ** CAPI3REF: Application Defined Page Cache.
|
|
jpayne@69
|
8935 ** KEYWORDS: {page cache}
|
|
jpayne@69
|
8936 **
|
|
jpayne@69
|
8937 ** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE2], ...) interface can
|
|
jpayne@69
|
8938 ** register an alternative page cache implementation by passing in an
|
|
jpayne@69
|
8939 ** instance of the sqlite3_pcache_methods2 structure.)^
|
|
jpayne@69
|
8940 ** In many applications, most of the heap memory allocated by
|
|
jpayne@69
|
8941 ** SQLite is used for the page cache.
|
|
jpayne@69
|
8942 ** By implementing a
|
|
jpayne@69
|
8943 ** custom page cache using this API, an application can better control
|
|
jpayne@69
|
8944 ** the amount of memory consumed by SQLite, the way in which
|
|
jpayne@69
|
8945 ** that memory is allocated and released, and the policies used to
|
|
jpayne@69
|
8946 ** determine exactly which parts of a database file are cached and for
|
|
jpayne@69
|
8947 ** how long.
|
|
jpayne@69
|
8948 **
|
|
jpayne@69
|
8949 ** The alternative page cache mechanism is an
|
|
jpayne@69
|
8950 ** extreme measure that is only needed by the most demanding applications.
|
|
jpayne@69
|
8951 ** The built-in page cache is recommended for most uses.
|
|
jpayne@69
|
8952 **
|
|
jpayne@69
|
8953 ** ^(The contents of the sqlite3_pcache_methods2 structure are copied to an
|
|
jpayne@69
|
8954 ** internal buffer by SQLite within the call to [sqlite3_config]. Hence
|
|
jpayne@69
|
8955 ** the application may discard the parameter after the call to
|
|
jpayne@69
|
8956 ** [sqlite3_config()] returns.)^
|
|
jpayne@69
|
8957 **
|
|
jpayne@69
|
8958 ** [[the xInit() page cache method]]
|
|
jpayne@69
|
8959 ** ^(The xInit() method is called once for each effective
|
|
jpayne@69
|
8960 ** call to [sqlite3_initialize()])^
|
|
jpayne@69
|
8961 ** (usually only once during the lifetime of the process). ^(The xInit()
|
|
jpayne@69
|
8962 ** method is passed a copy of the sqlite3_pcache_methods2.pArg value.)^
|
|
jpayne@69
|
8963 ** The intent of the xInit() method is to set up global data structures
|
|
jpayne@69
|
8964 ** required by the custom page cache implementation.
|
|
jpayne@69
|
8965 ** ^(If the xInit() method is NULL, then the
|
|
jpayne@69
|
8966 ** built-in default page cache is used instead of the application defined
|
|
jpayne@69
|
8967 ** page cache.)^
|
|
jpayne@69
|
8968 **
|
|
jpayne@69
|
8969 ** [[the xShutdown() page cache method]]
|
|
jpayne@69
|
8970 ** ^The xShutdown() method is called by [sqlite3_shutdown()].
|
|
jpayne@69
|
8971 ** It can be used to clean up
|
|
jpayne@69
|
8972 ** any outstanding resources before process shutdown, if required.
|
|
jpayne@69
|
8973 ** ^The xShutdown() method may be NULL.
|
|
jpayne@69
|
8974 **
|
|
jpayne@69
|
8975 ** ^SQLite automatically serializes calls to the xInit method,
|
|
jpayne@69
|
8976 ** so the xInit method need not be threadsafe. ^The
|
|
jpayne@69
|
8977 ** xShutdown method is only called from [sqlite3_shutdown()] so it does
|
|
jpayne@69
|
8978 ** not need to be threadsafe either. All other methods must be threadsafe
|
|
jpayne@69
|
8979 ** in multithreaded applications.
|
|
jpayne@69
|
8980 **
|
|
jpayne@69
|
8981 ** ^SQLite will never invoke xInit() more than once without an intervening
|
|
jpayne@69
|
8982 ** call to xShutdown().
|
|
jpayne@69
|
8983 **
|
|
jpayne@69
|
8984 ** [[the xCreate() page cache methods]]
|
|
jpayne@69
|
8985 ** ^SQLite invokes the xCreate() method to construct a new cache instance.
|
|
jpayne@69
|
8986 ** SQLite will typically create one cache instance for each open database file,
|
|
jpayne@69
|
8987 ** though this is not guaranteed. ^The
|
|
jpayne@69
|
8988 ** first parameter, szPage, is the size in bytes of the pages that must
|
|
jpayne@69
|
8989 ** be allocated by the cache. ^szPage will always a power of two. ^The
|
|
jpayne@69
|
8990 ** second parameter szExtra is a number of bytes of extra storage
|
|
jpayne@69
|
8991 ** associated with each page cache entry. ^The szExtra parameter will
|
|
jpayne@69
|
8992 ** a number less than 250. SQLite will use the
|
|
jpayne@69
|
8993 ** extra szExtra bytes on each page to store metadata about the underlying
|
|
jpayne@69
|
8994 ** database page on disk. The value passed into szExtra depends
|
|
jpayne@69
|
8995 ** on the SQLite version, the target platform, and how SQLite was compiled.
|
|
jpayne@69
|
8996 ** ^The third argument to xCreate(), bPurgeable, is true if the cache being
|
|
jpayne@69
|
8997 ** created will be used to cache database pages of a file stored on disk, or
|
|
jpayne@69
|
8998 ** false if it is used for an in-memory database. The cache implementation
|
|
jpayne@69
|
8999 ** does not have to do anything special based with the value of bPurgeable;
|
|
jpayne@69
|
9000 ** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will
|
|
jpayne@69
|
9001 ** never invoke xUnpin() except to deliberately delete a page.
|
|
jpayne@69
|
9002 ** ^In other words, calls to xUnpin() on a cache with bPurgeable set to
|
|
jpayne@69
|
9003 ** false will always have the "discard" flag set to true.
|
|
jpayne@69
|
9004 ** ^Hence, a cache created with bPurgeable false will
|
|
jpayne@69
|
9005 ** never contain any unpinned pages.
|
|
jpayne@69
|
9006 **
|
|
jpayne@69
|
9007 ** [[the xCachesize() page cache method]]
|
|
jpayne@69
|
9008 ** ^(The xCachesize() method may be called at any time by SQLite to set the
|
|
jpayne@69
|
9009 ** suggested maximum cache-size (number of pages stored by) the cache
|
|
jpayne@69
|
9010 ** instance passed as the first argument. This is the value configured using
|
|
jpayne@69
|
9011 ** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable
|
|
jpayne@69
|
9012 ** parameter, the implementation is not required to do anything with this
|
|
jpayne@69
|
9013 ** value; it is advisory only.
|
|
jpayne@69
|
9014 **
|
|
jpayne@69
|
9015 ** [[the xPagecount() page cache methods]]
|
|
jpayne@69
|
9016 ** The xPagecount() method must return the number of pages currently
|
|
jpayne@69
|
9017 ** stored in the cache, both pinned and unpinned.
|
|
jpayne@69
|
9018 **
|
|
jpayne@69
|
9019 ** [[the xFetch() page cache methods]]
|
|
jpayne@69
|
9020 ** The xFetch() method locates a page in the cache and returns a pointer to
|
|
jpayne@69
|
9021 ** an sqlite3_pcache_page object associated with that page, or a NULL pointer.
|
|
jpayne@69
|
9022 ** The pBuf element of the returned sqlite3_pcache_page object will be a
|
|
jpayne@69
|
9023 ** pointer to a buffer of szPage bytes used to store the content of a
|
|
jpayne@69
|
9024 ** single database page. The pExtra element of sqlite3_pcache_page will be
|
|
jpayne@69
|
9025 ** a pointer to the szExtra bytes of extra storage that SQLite has requested
|
|
jpayne@69
|
9026 ** for each entry in the page cache.
|
|
jpayne@69
|
9027 **
|
|
jpayne@69
|
9028 ** The page to be fetched is determined by the key. ^The minimum key value
|
|
jpayne@69
|
9029 ** is 1. After it has been retrieved using xFetch, the page is considered
|
|
jpayne@69
|
9030 ** to be "pinned".
|
|
jpayne@69
|
9031 **
|
|
jpayne@69
|
9032 ** If the requested page is already in the page cache, then the page cache
|
|
jpayne@69
|
9033 ** implementation must return a pointer to the page buffer with its content
|
|
jpayne@69
|
9034 ** intact. If the requested page is not already in the cache, then the
|
|
jpayne@69
|
9035 ** cache implementation should use the value of the createFlag
|
|
jpayne@69
|
9036 ** parameter to help it determined what action to take:
|
|
jpayne@69
|
9037 **
|
|
jpayne@69
|
9038 ** <table border=1 width=85% align=center>
|
|
jpayne@69
|
9039 ** <tr><th> createFlag <th> Behavior when page is not already in cache
|
|
jpayne@69
|
9040 ** <tr><td> 0 <td> Do not allocate a new page. Return NULL.
|
|
jpayne@69
|
9041 ** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so.
|
|
jpayne@69
|
9042 ** Otherwise return NULL.
|
|
jpayne@69
|
9043 ** <tr><td> 2 <td> Make every effort to allocate a new page. Only return
|
|
jpayne@69
|
9044 ** NULL if allocating a new page is effectively impossible.
|
|
jpayne@69
|
9045 ** </table>
|
|
jpayne@69
|
9046 **
|
|
jpayne@69
|
9047 ** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite
|
|
jpayne@69
|
9048 ** will only use a createFlag of 2 after a prior call with a createFlag of 1
|
|
jpayne@69
|
9049 ** failed.)^ In between the xFetch() calls, SQLite may
|
|
jpayne@69
|
9050 ** attempt to unpin one or more cache pages by spilling the content of
|
|
jpayne@69
|
9051 ** pinned pages to disk and synching the operating system disk cache.
|
|
jpayne@69
|
9052 **
|
|
jpayne@69
|
9053 ** [[the xUnpin() page cache method]]
|
|
jpayne@69
|
9054 ** ^xUnpin() is called by SQLite with a pointer to a currently pinned page
|
|
jpayne@69
|
9055 ** as its second argument. If the third parameter, discard, is non-zero,
|
|
jpayne@69
|
9056 ** then the page must be evicted from the cache.
|
|
jpayne@69
|
9057 ** ^If the discard parameter is
|
|
jpayne@69
|
9058 ** zero, then the page may be discarded or retained at the discretion of
|
|
jpayne@69
|
9059 ** page cache implementation. ^The page cache implementation
|
|
jpayne@69
|
9060 ** may choose to evict unpinned pages at any time.
|
|
jpayne@69
|
9061 **
|
|
jpayne@69
|
9062 ** The cache must not perform any reference counting. A single
|
|
jpayne@69
|
9063 ** call to xUnpin() unpins the page regardless of the number of prior calls
|
|
jpayne@69
|
9064 ** to xFetch().
|
|
jpayne@69
|
9065 **
|
|
jpayne@69
|
9066 ** [[the xRekey() page cache methods]]
|
|
jpayne@69
|
9067 ** The xRekey() method is used to change the key value associated with the
|
|
jpayne@69
|
9068 ** page passed as the second argument. If the cache
|
|
jpayne@69
|
9069 ** previously contains an entry associated with newKey, it must be
|
|
jpayne@69
|
9070 ** discarded. ^Any prior cache entry associated with newKey is guaranteed not
|
|
jpayne@69
|
9071 ** to be pinned.
|
|
jpayne@69
|
9072 **
|
|
jpayne@69
|
9073 ** When SQLite calls the xTruncate() method, the cache must discard all
|
|
jpayne@69
|
9074 ** existing cache entries with page numbers (keys) greater than or equal
|
|
jpayne@69
|
9075 ** to the value of the iLimit parameter passed to xTruncate(). If any
|
|
jpayne@69
|
9076 ** of these pages are pinned, they are implicitly unpinned, meaning that
|
|
jpayne@69
|
9077 ** they can be safely discarded.
|
|
jpayne@69
|
9078 **
|
|
jpayne@69
|
9079 ** [[the xDestroy() page cache method]]
|
|
jpayne@69
|
9080 ** ^The xDestroy() method is used to delete a cache allocated by xCreate().
|
|
jpayne@69
|
9081 ** All resources associated with the specified cache should be freed. ^After
|
|
jpayne@69
|
9082 ** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*]
|
|
jpayne@69
|
9083 ** handle invalid, and will not use it with any other sqlite3_pcache_methods2
|
|
jpayne@69
|
9084 ** functions.
|
|
jpayne@69
|
9085 **
|
|
jpayne@69
|
9086 ** [[the xShrink() page cache method]]
|
|
jpayne@69
|
9087 ** ^SQLite invokes the xShrink() method when it wants the page cache to
|
|
jpayne@69
|
9088 ** free up as much of heap memory as possible. The page cache implementation
|
|
jpayne@69
|
9089 ** is not obligated to free any memory, but well-behaved implementations should
|
|
jpayne@69
|
9090 ** do their best.
|
|
jpayne@69
|
9091 */
|
|
jpayne@69
|
9092 typedef struct sqlite3_pcache_methods2 sqlite3_pcache_methods2;
|
|
jpayne@69
|
9093 struct sqlite3_pcache_methods2 {
|
|
jpayne@69
|
9094 int iVersion;
|
|
jpayne@69
|
9095 void *pArg;
|
|
jpayne@69
|
9096 int (*xInit)(void*);
|
|
jpayne@69
|
9097 void (*xShutdown)(void*);
|
|
jpayne@69
|
9098 sqlite3_pcache *(*xCreate)(int szPage, int szExtra, int bPurgeable);
|
|
jpayne@69
|
9099 void (*xCachesize)(sqlite3_pcache*, int nCachesize);
|
|
jpayne@69
|
9100 int (*xPagecount)(sqlite3_pcache*);
|
|
jpayne@69
|
9101 sqlite3_pcache_page *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
|
|
jpayne@69
|
9102 void (*xUnpin)(sqlite3_pcache*, sqlite3_pcache_page*, int discard);
|
|
jpayne@69
|
9103 void (*xRekey)(sqlite3_pcache*, sqlite3_pcache_page*,
|
|
jpayne@69
|
9104 unsigned oldKey, unsigned newKey);
|
|
jpayne@69
|
9105 void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);
|
|
jpayne@69
|
9106 void (*xDestroy)(sqlite3_pcache*);
|
|
jpayne@69
|
9107 void (*xShrink)(sqlite3_pcache*);
|
|
jpayne@69
|
9108 };
|
|
jpayne@69
|
9109
|
|
jpayne@69
|
9110 /*
|
|
jpayne@69
|
9111 ** This is the obsolete pcache_methods object that has now been replaced
|
|
jpayne@69
|
9112 ** by sqlite3_pcache_methods2. This object is not used by SQLite. It is
|
|
jpayne@69
|
9113 ** retained in the header file for backwards compatibility only.
|
|
jpayne@69
|
9114 */
|
|
jpayne@69
|
9115 typedef struct sqlite3_pcache_methods sqlite3_pcache_methods;
|
|
jpayne@69
|
9116 struct sqlite3_pcache_methods {
|
|
jpayne@69
|
9117 void *pArg;
|
|
jpayne@69
|
9118 int (*xInit)(void*);
|
|
jpayne@69
|
9119 void (*xShutdown)(void*);
|
|
jpayne@69
|
9120 sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable);
|
|
jpayne@69
|
9121 void (*xCachesize)(sqlite3_pcache*, int nCachesize);
|
|
jpayne@69
|
9122 int (*xPagecount)(sqlite3_pcache*);
|
|
jpayne@69
|
9123 void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
|
|
jpayne@69
|
9124 void (*xUnpin)(sqlite3_pcache*, void*, int discard);
|
|
jpayne@69
|
9125 void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey);
|
|
jpayne@69
|
9126 void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);
|
|
jpayne@69
|
9127 void (*xDestroy)(sqlite3_pcache*);
|
|
jpayne@69
|
9128 };
|
|
jpayne@69
|
9129
|
|
jpayne@69
|
9130
|
|
jpayne@69
|
9131 /*
|
|
jpayne@69
|
9132 ** CAPI3REF: Online Backup Object
|
|
jpayne@69
|
9133 **
|
|
jpayne@69
|
9134 ** The sqlite3_backup object records state information about an ongoing
|
|
jpayne@69
|
9135 ** online backup operation. ^The sqlite3_backup object is created by
|
|
jpayne@69
|
9136 ** a call to [sqlite3_backup_init()] and is destroyed by a call to
|
|
jpayne@69
|
9137 ** [sqlite3_backup_finish()].
|
|
jpayne@69
|
9138 **
|
|
jpayne@69
|
9139 ** See Also: [Using the SQLite Online Backup API]
|
|
jpayne@69
|
9140 */
|
|
jpayne@69
|
9141 typedef struct sqlite3_backup sqlite3_backup;
|
|
jpayne@69
|
9142
|
|
jpayne@69
|
9143 /*
|
|
jpayne@69
|
9144 ** CAPI3REF: Online Backup API.
|
|
jpayne@69
|
9145 **
|
|
jpayne@69
|
9146 ** The backup API copies the content of one database into another.
|
|
jpayne@69
|
9147 ** It is useful either for creating backups of databases or
|
|
jpayne@69
|
9148 ** for copying in-memory databases to or from persistent files.
|
|
jpayne@69
|
9149 **
|
|
jpayne@69
|
9150 ** See Also: [Using the SQLite Online Backup API]
|
|
jpayne@69
|
9151 **
|
|
jpayne@69
|
9152 ** ^SQLite holds a write transaction open on the destination database file
|
|
jpayne@69
|
9153 ** for the duration of the backup operation.
|
|
jpayne@69
|
9154 ** ^The source database is read-locked only while it is being read;
|
|
jpayne@69
|
9155 ** it is not locked continuously for the entire backup operation.
|
|
jpayne@69
|
9156 ** ^Thus, the backup may be performed on a live source database without
|
|
jpayne@69
|
9157 ** preventing other database connections from
|
|
jpayne@69
|
9158 ** reading or writing to the source database while the backup is underway.
|
|
jpayne@69
|
9159 **
|
|
jpayne@69
|
9160 ** ^(To perform a backup operation:
|
|
jpayne@69
|
9161 ** <ol>
|
|
jpayne@69
|
9162 ** <li><b>sqlite3_backup_init()</b> is called once to initialize the
|
|
jpayne@69
|
9163 ** backup,
|
|
jpayne@69
|
9164 ** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer
|
|
jpayne@69
|
9165 ** the data between the two databases, and finally
|
|
jpayne@69
|
9166 ** <li><b>sqlite3_backup_finish()</b> is called to release all resources
|
|
jpayne@69
|
9167 ** associated with the backup operation.
|
|
jpayne@69
|
9168 ** </ol>)^
|
|
jpayne@69
|
9169 ** There should be exactly one call to sqlite3_backup_finish() for each
|
|
jpayne@69
|
9170 ** successful call to sqlite3_backup_init().
|
|
jpayne@69
|
9171 **
|
|
jpayne@69
|
9172 ** [[sqlite3_backup_init()]] <b>sqlite3_backup_init()</b>
|
|
jpayne@69
|
9173 **
|
|
jpayne@69
|
9174 ** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the
|
|
jpayne@69
|
9175 ** [database connection] associated with the destination database
|
|
jpayne@69
|
9176 ** and the database name, respectively.
|
|
jpayne@69
|
9177 ** ^The database name is "main" for the main database, "temp" for the
|
|
jpayne@69
|
9178 ** temporary database, or the name specified after the AS keyword in
|
|
jpayne@69
|
9179 ** an [ATTACH] statement for an attached database.
|
|
jpayne@69
|
9180 ** ^The S and M arguments passed to
|
|
jpayne@69
|
9181 ** sqlite3_backup_init(D,N,S,M) identify the [database connection]
|
|
jpayne@69
|
9182 ** and database name of the source database, respectively.
|
|
jpayne@69
|
9183 ** ^The source and destination [database connections] (parameters S and D)
|
|
jpayne@69
|
9184 ** must be different or else sqlite3_backup_init(D,N,S,M) will fail with
|
|
jpayne@69
|
9185 ** an error.
|
|
jpayne@69
|
9186 **
|
|
jpayne@69
|
9187 ** ^A call to sqlite3_backup_init() will fail, returning NULL, if
|
|
jpayne@69
|
9188 ** there is already a read or read-write transaction open on the
|
|
jpayne@69
|
9189 ** destination database.
|
|
jpayne@69
|
9190 **
|
|
jpayne@69
|
9191 ** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is
|
|
jpayne@69
|
9192 ** returned and an error code and error message are stored in the
|
|
jpayne@69
|
9193 ** destination [database connection] D.
|
|
jpayne@69
|
9194 ** ^The error code and message for the failed call to sqlite3_backup_init()
|
|
jpayne@69
|
9195 ** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or
|
|
jpayne@69
|
9196 ** [sqlite3_errmsg16()] functions.
|
|
jpayne@69
|
9197 ** ^A successful call to sqlite3_backup_init() returns a pointer to an
|
|
jpayne@69
|
9198 ** [sqlite3_backup] object.
|
|
jpayne@69
|
9199 ** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and
|
|
jpayne@69
|
9200 ** sqlite3_backup_finish() functions to perform the specified backup
|
|
jpayne@69
|
9201 ** operation.
|
|
jpayne@69
|
9202 **
|
|
jpayne@69
|
9203 ** [[sqlite3_backup_step()]] <b>sqlite3_backup_step()</b>
|
|
jpayne@69
|
9204 **
|
|
jpayne@69
|
9205 ** ^Function sqlite3_backup_step(B,N) will copy up to N pages between
|
|
jpayne@69
|
9206 ** the source and destination databases specified by [sqlite3_backup] object B.
|
|
jpayne@69
|
9207 ** ^If N is negative, all remaining source pages are copied.
|
|
jpayne@69
|
9208 ** ^If sqlite3_backup_step(B,N) successfully copies N pages and there
|
|
jpayne@69
|
9209 ** are still more pages to be copied, then the function returns [SQLITE_OK].
|
|
jpayne@69
|
9210 ** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages
|
|
jpayne@69
|
9211 ** from source to destination, then it returns [SQLITE_DONE].
|
|
jpayne@69
|
9212 ** ^If an error occurs while running sqlite3_backup_step(B,N),
|
|
jpayne@69
|
9213 ** then an [error code] is returned. ^As well as [SQLITE_OK] and
|
|
jpayne@69
|
9214 ** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY],
|
|
jpayne@69
|
9215 ** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an
|
|
jpayne@69
|
9216 ** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code.
|
|
jpayne@69
|
9217 **
|
|
jpayne@69
|
9218 ** ^(The sqlite3_backup_step() might return [SQLITE_READONLY] if
|
|
jpayne@69
|
9219 ** <ol>
|
|
jpayne@69
|
9220 ** <li> the destination database was opened read-only, or
|
|
jpayne@69
|
9221 ** <li> the destination database is using write-ahead-log journaling
|
|
jpayne@69
|
9222 ** and the destination and source page sizes differ, or
|
|
jpayne@69
|
9223 ** <li> the destination database is an in-memory database and the
|
|
jpayne@69
|
9224 ** destination and source page sizes differ.
|
|
jpayne@69
|
9225 ** </ol>)^
|
|
jpayne@69
|
9226 **
|
|
jpayne@69
|
9227 ** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then
|
|
jpayne@69
|
9228 ** the [sqlite3_busy_handler | busy-handler function]
|
|
jpayne@69
|
9229 ** is invoked (if one is specified). ^If the
|
|
jpayne@69
|
9230 ** busy-handler returns non-zero before the lock is available, then
|
|
jpayne@69
|
9231 ** [SQLITE_BUSY] is returned to the caller. ^In this case the call to
|
|
jpayne@69
|
9232 ** sqlite3_backup_step() can be retried later. ^If the source
|
|
jpayne@69
|
9233 ** [database connection]
|
|
jpayne@69
|
9234 ** is being used to write to the source database when sqlite3_backup_step()
|
|
jpayne@69
|
9235 ** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this
|
|
jpayne@69
|
9236 ** case the call to sqlite3_backup_step() can be retried later on. ^(If
|
|
jpayne@69
|
9237 ** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or
|
|
jpayne@69
|
9238 ** [SQLITE_READONLY] is returned, then
|
|
jpayne@69
|
9239 ** there is no point in retrying the call to sqlite3_backup_step(). These
|
|
jpayne@69
|
9240 ** errors are considered fatal.)^ The application must accept
|
|
jpayne@69
|
9241 ** that the backup operation has failed and pass the backup operation handle
|
|
jpayne@69
|
9242 ** to the sqlite3_backup_finish() to release associated resources.
|
|
jpayne@69
|
9243 **
|
|
jpayne@69
|
9244 ** ^The first call to sqlite3_backup_step() obtains an exclusive lock
|
|
jpayne@69
|
9245 ** on the destination file. ^The exclusive lock is not released until either
|
|
jpayne@69
|
9246 ** sqlite3_backup_finish() is called or the backup operation is complete
|
|
jpayne@69
|
9247 ** and sqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to
|
|
jpayne@69
|
9248 ** sqlite3_backup_step() obtains a [shared lock] on the source database that
|
|
jpayne@69
|
9249 ** lasts for the duration of the sqlite3_backup_step() call.
|
|
jpayne@69
|
9250 ** ^Because the source database is not locked between calls to
|
|
jpayne@69
|
9251 ** sqlite3_backup_step(), the source database may be modified mid-way
|
|
jpayne@69
|
9252 ** through the backup process. ^If the source database is modified by an
|
|
jpayne@69
|
9253 ** external process or via a database connection other than the one being
|
|
jpayne@69
|
9254 ** used by the backup operation, then the backup will be automatically
|
|
jpayne@69
|
9255 ** restarted by the next call to sqlite3_backup_step(). ^If the source
|
|
jpayne@69
|
9256 ** database is modified by the using the same database connection as is used
|
|
jpayne@69
|
9257 ** by the backup operation, then the backup database is automatically
|
|
jpayne@69
|
9258 ** updated at the same time.
|
|
jpayne@69
|
9259 **
|
|
jpayne@69
|
9260 ** [[sqlite3_backup_finish()]] <b>sqlite3_backup_finish()</b>
|
|
jpayne@69
|
9261 **
|
|
jpayne@69
|
9262 ** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the
|
|
jpayne@69
|
9263 ** application wishes to abandon the backup operation, the application
|
|
jpayne@69
|
9264 ** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish().
|
|
jpayne@69
|
9265 ** ^The sqlite3_backup_finish() interfaces releases all
|
|
jpayne@69
|
9266 ** resources associated with the [sqlite3_backup] object.
|
|
jpayne@69
|
9267 ** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any
|
|
jpayne@69
|
9268 ** active write-transaction on the destination database is rolled back.
|
|
jpayne@69
|
9269 ** The [sqlite3_backup] object is invalid
|
|
jpayne@69
|
9270 ** and may not be used following a call to sqlite3_backup_finish().
|
|
jpayne@69
|
9271 **
|
|
jpayne@69
|
9272 ** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no
|
|
jpayne@69
|
9273 ** sqlite3_backup_step() errors occurred, regardless or whether or not
|
|
jpayne@69
|
9274 ** sqlite3_backup_step() completed.
|
|
jpayne@69
|
9275 ** ^If an out-of-memory condition or IO error occurred during any prior
|
|
jpayne@69
|
9276 ** sqlite3_backup_step() call on the same [sqlite3_backup] object, then
|
|
jpayne@69
|
9277 ** sqlite3_backup_finish() returns the corresponding [error code].
|
|
jpayne@69
|
9278 **
|
|
jpayne@69
|
9279 ** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step()
|
|
jpayne@69
|
9280 ** is not a permanent error and does not affect the return value of
|
|
jpayne@69
|
9281 ** sqlite3_backup_finish().
|
|
jpayne@69
|
9282 **
|
|
jpayne@69
|
9283 ** [[sqlite3_backup_remaining()]] [[sqlite3_backup_pagecount()]]
|
|
jpayne@69
|
9284 ** <b>sqlite3_backup_remaining() and sqlite3_backup_pagecount()</b>
|
|
jpayne@69
|
9285 **
|
|
jpayne@69
|
9286 ** ^The sqlite3_backup_remaining() routine returns the number of pages still
|
|
jpayne@69
|
9287 ** to be backed up at the conclusion of the most recent sqlite3_backup_step().
|
|
jpayne@69
|
9288 ** ^The sqlite3_backup_pagecount() routine returns the total number of pages
|
|
jpayne@69
|
9289 ** in the source database at the conclusion of the most recent
|
|
jpayne@69
|
9290 ** sqlite3_backup_step().
|
|
jpayne@69
|
9291 ** ^(The values returned by these functions are only updated by
|
|
jpayne@69
|
9292 ** sqlite3_backup_step(). If the source database is modified in a way that
|
|
jpayne@69
|
9293 ** changes the size of the source database or the number of pages remaining,
|
|
jpayne@69
|
9294 ** those changes are not reflected in the output of sqlite3_backup_pagecount()
|
|
jpayne@69
|
9295 ** and sqlite3_backup_remaining() until after the next
|
|
jpayne@69
|
9296 ** sqlite3_backup_step().)^
|
|
jpayne@69
|
9297 **
|
|
jpayne@69
|
9298 ** <b>Concurrent Usage of Database Handles</b>
|
|
jpayne@69
|
9299 **
|
|
jpayne@69
|
9300 ** ^The source [database connection] may be used by the application for other
|
|
jpayne@69
|
9301 ** purposes while a backup operation is underway or being initialized.
|
|
jpayne@69
|
9302 ** ^If SQLite is compiled and configured to support threadsafe database
|
|
jpayne@69
|
9303 ** connections, then the source database connection may be used concurrently
|
|
jpayne@69
|
9304 ** from within other threads.
|
|
jpayne@69
|
9305 **
|
|
jpayne@69
|
9306 ** However, the application must guarantee that the destination
|
|
jpayne@69
|
9307 ** [database connection] is not passed to any other API (by any thread) after
|
|
jpayne@69
|
9308 ** sqlite3_backup_init() is called and before the corresponding call to
|
|
jpayne@69
|
9309 ** sqlite3_backup_finish(). SQLite does not currently check to see
|
|
jpayne@69
|
9310 ** if the application incorrectly accesses the destination [database connection]
|
|
jpayne@69
|
9311 ** and so no error code is reported, but the operations may malfunction
|
|
jpayne@69
|
9312 ** nevertheless. Use of the destination database connection while a
|
|
jpayne@69
|
9313 ** backup is in progress might also cause a mutex deadlock.
|
|
jpayne@69
|
9314 **
|
|
jpayne@69
|
9315 ** If running in [shared cache mode], the application must
|
|
jpayne@69
|
9316 ** guarantee that the shared cache used by the destination database
|
|
jpayne@69
|
9317 ** is not accessed while the backup is running. In practice this means
|
|
jpayne@69
|
9318 ** that the application must guarantee that the disk file being
|
|
jpayne@69
|
9319 ** backed up to is not accessed by any connection within the process,
|
|
jpayne@69
|
9320 ** not just the specific connection that was passed to sqlite3_backup_init().
|
|
jpayne@69
|
9321 **
|
|
jpayne@69
|
9322 ** The [sqlite3_backup] object itself is partially threadsafe. Multiple
|
|
jpayne@69
|
9323 ** threads may safely make multiple concurrent calls to sqlite3_backup_step().
|
|
jpayne@69
|
9324 ** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount()
|
|
jpayne@69
|
9325 ** APIs are not strictly speaking threadsafe. If they are invoked at the
|
|
jpayne@69
|
9326 ** same time as another thread is invoking sqlite3_backup_step() it is
|
|
jpayne@69
|
9327 ** possible that they return invalid values.
|
|
jpayne@69
|
9328 */
|
|
jpayne@69
|
9329 SQLITE_API sqlite3_backup *sqlite3_backup_init(
|
|
jpayne@69
|
9330 sqlite3 *pDest, /* Destination database handle */
|
|
jpayne@69
|
9331 const char *zDestName, /* Destination database name */
|
|
jpayne@69
|
9332 sqlite3 *pSource, /* Source database handle */
|
|
jpayne@69
|
9333 const char *zSourceName /* Source database name */
|
|
jpayne@69
|
9334 );
|
|
jpayne@69
|
9335 SQLITE_API int sqlite3_backup_step(sqlite3_backup *p, int nPage);
|
|
jpayne@69
|
9336 SQLITE_API int sqlite3_backup_finish(sqlite3_backup *p);
|
|
jpayne@69
|
9337 SQLITE_API int sqlite3_backup_remaining(sqlite3_backup *p);
|
|
jpayne@69
|
9338 SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p);
|
|
jpayne@69
|
9339
|
|
jpayne@69
|
9340 /*
|
|
jpayne@69
|
9341 ** CAPI3REF: Unlock Notification
|
|
jpayne@69
|
9342 ** METHOD: sqlite3
|
|
jpayne@69
|
9343 **
|
|
jpayne@69
|
9344 ** ^When running in shared-cache mode, a database operation may fail with
|
|
jpayne@69
|
9345 ** an [SQLITE_LOCKED] error if the required locks on the shared-cache or
|
|
jpayne@69
|
9346 ** individual tables within the shared-cache cannot be obtained. See
|
|
jpayne@69
|
9347 ** [SQLite Shared-Cache Mode] for a description of shared-cache locking.
|
|
jpayne@69
|
9348 ** ^This API may be used to register a callback that SQLite will invoke
|
|
jpayne@69
|
9349 ** when the connection currently holding the required lock relinquishes it.
|
|
jpayne@69
|
9350 ** ^This API is only available if the library was compiled with the
|
|
jpayne@69
|
9351 ** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined.
|
|
jpayne@69
|
9352 **
|
|
jpayne@69
|
9353 ** See Also: [Using the SQLite Unlock Notification Feature].
|
|
jpayne@69
|
9354 **
|
|
jpayne@69
|
9355 ** ^Shared-cache locks are released when a database connection concludes
|
|
jpayne@69
|
9356 ** its current transaction, either by committing it or rolling it back.
|
|
jpayne@69
|
9357 **
|
|
jpayne@69
|
9358 ** ^When a connection (known as the blocked connection) fails to obtain a
|
|
jpayne@69
|
9359 ** shared-cache lock and SQLITE_LOCKED is returned to the caller, the
|
|
jpayne@69
|
9360 ** identity of the database connection (the blocking connection) that
|
|
jpayne@69
|
9361 ** has locked the required resource is stored internally. ^After an
|
|
jpayne@69
|
9362 ** application receives an SQLITE_LOCKED error, it may call the
|
|
jpayne@69
|
9363 ** sqlite3_unlock_notify() method with the blocked connection handle as
|
|
jpayne@69
|
9364 ** the first argument to register for a callback that will be invoked
|
|
jpayne@69
|
9365 ** when the blocking connections current transaction is concluded. ^The
|
|
jpayne@69
|
9366 ** callback is invoked from within the [sqlite3_step] or [sqlite3_close]
|
|
jpayne@69
|
9367 ** call that concludes the blocking connection's transaction.
|
|
jpayne@69
|
9368 **
|
|
jpayne@69
|
9369 ** ^(If sqlite3_unlock_notify() is called in a multi-threaded application,
|
|
jpayne@69
|
9370 ** there is a chance that the blocking connection will have already
|
|
jpayne@69
|
9371 ** concluded its transaction by the time sqlite3_unlock_notify() is invoked.
|
|
jpayne@69
|
9372 ** If this happens, then the specified callback is invoked immediately,
|
|
jpayne@69
|
9373 ** from within the call to sqlite3_unlock_notify().)^
|
|
jpayne@69
|
9374 **
|
|
jpayne@69
|
9375 ** ^If the blocked connection is attempting to obtain a write-lock on a
|
|
jpayne@69
|
9376 ** shared-cache table, and more than one other connection currently holds
|
|
jpayne@69
|
9377 ** a read-lock on the same table, then SQLite arbitrarily selects one of
|
|
jpayne@69
|
9378 ** the other connections to use as the blocking connection.
|
|
jpayne@69
|
9379 **
|
|
jpayne@69
|
9380 ** ^(There may be at most one unlock-notify callback registered by a
|
|
jpayne@69
|
9381 ** blocked connection. If sqlite3_unlock_notify() is called when the
|
|
jpayne@69
|
9382 ** blocked connection already has a registered unlock-notify callback,
|
|
jpayne@69
|
9383 ** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is
|
|
jpayne@69
|
9384 ** called with a NULL pointer as its second argument, then any existing
|
|
jpayne@69
|
9385 ** unlock-notify callback is canceled. ^The blocked connections
|
|
jpayne@69
|
9386 ** unlock-notify callback may also be canceled by closing the blocked
|
|
jpayne@69
|
9387 ** connection using [sqlite3_close()].
|
|
jpayne@69
|
9388 **
|
|
jpayne@69
|
9389 ** The unlock-notify callback is not reentrant. If an application invokes
|
|
jpayne@69
|
9390 ** any sqlite3_xxx API functions from within an unlock-notify callback, a
|
|
jpayne@69
|
9391 ** crash or deadlock may be the result.
|
|
jpayne@69
|
9392 **
|
|
jpayne@69
|
9393 ** ^Unless deadlock is detected (see below), sqlite3_unlock_notify() always
|
|
jpayne@69
|
9394 ** returns SQLITE_OK.
|
|
jpayne@69
|
9395 **
|
|
jpayne@69
|
9396 ** <b>Callback Invocation Details</b>
|
|
jpayne@69
|
9397 **
|
|
jpayne@69
|
9398 ** When an unlock-notify callback is registered, the application provides a
|
|
jpayne@69
|
9399 ** single void* pointer that is passed to the callback when it is invoked.
|
|
jpayne@69
|
9400 ** However, the signature of the callback function allows SQLite to pass
|
|
jpayne@69
|
9401 ** it an array of void* context pointers. The first argument passed to
|
|
jpayne@69
|
9402 ** an unlock-notify callback is a pointer to an array of void* pointers,
|
|
jpayne@69
|
9403 ** and the second is the number of entries in the array.
|
|
jpayne@69
|
9404 **
|
|
jpayne@69
|
9405 ** When a blocking connection's transaction is concluded, there may be
|
|
jpayne@69
|
9406 ** more than one blocked connection that has registered for an unlock-notify
|
|
jpayne@69
|
9407 ** callback. ^If two or more such blocked connections have specified the
|
|
jpayne@69
|
9408 ** same callback function, then instead of invoking the callback function
|
|
jpayne@69
|
9409 ** multiple times, it is invoked once with the set of void* context pointers
|
|
jpayne@69
|
9410 ** specified by the blocked connections bundled together into an array.
|
|
jpayne@69
|
9411 ** This gives the application an opportunity to prioritize any actions
|
|
jpayne@69
|
9412 ** related to the set of unblocked database connections.
|
|
jpayne@69
|
9413 **
|
|
jpayne@69
|
9414 ** <b>Deadlock Detection</b>
|
|
jpayne@69
|
9415 **
|
|
jpayne@69
|
9416 ** Assuming that after registering for an unlock-notify callback a
|
|
jpayne@69
|
9417 ** database waits for the callback to be issued before taking any further
|
|
jpayne@69
|
9418 ** action (a reasonable assumption), then using this API may cause the
|
|
jpayne@69
|
9419 ** application to deadlock. For example, if connection X is waiting for
|
|
jpayne@69
|
9420 ** connection Y's transaction to be concluded, and similarly connection
|
|
jpayne@69
|
9421 ** Y is waiting on connection X's transaction, then neither connection
|
|
jpayne@69
|
9422 ** will proceed and the system may remain deadlocked indefinitely.
|
|
jpayne@69
|
9423 **
|
|
jpayne@69
|
9424 ** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock
|
|
jpayne@69
|
9425 ** detection. ^If a given call to sqlite3_unlock_notify() would put the
|
|
jpayne@69
|
9426 ** system in a deadlocked state, then SQLITE_LOCKED is returned and no
|
|
jpayne@69
|
9427 ** unlock-notify callback is registered. The system is said to be in
|
|
jpayne@69
|
9428 ** a deadlocked state if connection A has registered for an unlock-notify
|
|
jpayne@69
|
9429 ** callback on the conclusion of connection B's transaction, and connection
|
|
jpayne@69
|
9430 ** B has itself registered for an unlock-notify callback when connection
|
|
jpayne@69
|
9431 ** A's transaction is concluded. ^Indirect deadlock is also detected, so
|
|
jpayne@69
|
9432 ** the system is also considered to be deadlocked if connection B has
|
|
jpayne@69
|
9433 ** registered for an unlock-notify callback on the conclusion of connection
|
|
jpayne@69
|
9434 ** C's transaction, where connection C is waiting on connection A. ^Any
|
|
jpayne@69
|
9435 ** number of levels of indirection are allowed.
|
|
jpayne@69
|
9436 **
|
|
jpayne@69
|
9437 ** <b>The "DROP TABLE" Exception</b>
|
|
jpayne@69
|
9438 **
|
|
jpayne@69
|
9439 ** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost
|
|
jpayne@69
|
9440 ** always appropriate to call sqlite3_unlock_notify(). There is however,
|
|
jpayne@69
|
9441 ** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement,
|
|
jpayne@69
|
9442 ** SQLite checks if there are any currently executing SELECT statements
|
|
jpayne@69
|
9443 ** that belong to the same connection. If there are, SQLITE_LOCKED is
|
|
jpayne@69
|
9444 ** returned. In this case there is no "blocking connection", so invoking
|
|
jpayne@69
|
9445 ** sqlite3_unlock_notify() results in the unlock-notify callback being
|
|
jpayne@69
|
9446 ** invoked immediately. If the application then re-attempts the "DROP TABLE"
|
|
jpayne@69
|
9447 ** or "DROP INDEX" query, an infinite loop might be the result.
|
|
jpayne@69
|
9448 **
|
|
jpayne@69
|
9449 ** One way around this problem is to check the extended error code returned
|
|
jpayne@69
|
9450 ** by an sqlite3_step() call. ^(If there is a blocking connection, then the
|
|
jpayne@69
|
9451 ** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in
|
|
jpayne@69
|
9452 ** the special "DROP TABLE/INDEX" case, the extended error code is just
|
|
jpayne@69
|
9453 ** SQLITE_LOCKED.)^
|
|
jpayne@69
|
9454 */
|
|
jpayne@69
|
9455 SQLITE_API int sqlite3_unlock_notify(
|
|
jpayne@69
|
9456 sqlite3 *pBlocked, /* Waiting connection */
|
|
jpayne@69
|
9457 void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */
|
|
jpayne@69
|
9458 void *pNotifyArg /* Argument to pass to xNotify */
|
|
jpayne@69
|
9459 );
|
|
jpayne@69
|
9460
|
|
jpayne@69
|
9461
|
|
jpayne@69
|
9462 /*
|
|
jpayne@69
|
9463 ** CAPI3REF: String Comparison
|
|
jpayne@69
|
9464 **
|
|
jpayne@69
|
9465 ** ^The [sqlite3_stricmp()] and [sqlite3_strnicmp()] APIs allow applications
|
|
jpayne@69
|
9466 ** and extensions to compare the contents of two buffers containing UTF-8
|
|
jpayne@69
|
9467 ** strings in a case-independent fashion, using the same definition of "case
|
|
jpayne@69
|
9468 ** independence" that SQLite uses internally when comparing identifiers.
|
|
jpayne@69
|
9469 */
|
|
jpayne@69
|
9470 SQLITE_API int sqlite3_stricmp(const char *, const char *);
|
|
jpayne@69
|
9471 SQLITE_API int sqlite3_strnicmp(const char *, const char *, int);
|
|
jpayne@69
|
9472
|
|
jpayne@69
|
9473 /*
|
|
jpayne@69
|
9474 ** CAPI3REF: String Globbing
|
|
jpayne@69
|
9475 *
|
|
jpayne@69
|
9476 ** ^The [sqlite3_strglob(P,X)] interface returns zero if and only if
|
|
jpayne@69
|
9477 ** string X matches the [GLOB] pattern P.
|
|
jpayne@69
|
9478 ** ^The definition of [GLOB] pattern matching used in
|
|
jpayne@69
|
9479 ** [sqlite3_strglob(P,X)] is the same as for the "X GLOB P" operator in the
|
|
jpayne@69
|
9480 ** SQL dialect understood by SQLite. ^The [sqlite3_strglob(P,X)] function
|
|
jpayne@69
|
9481 ** is case sensitive.
|
|
jpayne@69
|
9482 **
|
|
jpayne@69
|
9483 ** Note that this routine returns zero on a match and non-zero if the strings
|
|
jpayne@69
|
9484 ** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()].
|
|
jpayne@69
|
9485 **
|
|
jpayne@69
|
9486 ** See also: [sqlite3_strlike()].
|
|
jpayne@69
|
9487 */
|
|
jpayne@69
|
9488 SQLITE_API int sqlite3_strglob(const char *zGlob, const char *zStr);
|
|
jpayne@69
|
9489
|
|
jpayne@69
|
9490 /*
|
|
jpayne@69
|
9491 ** CAPI3REF: String LIKE Matching
|
|
jpayne@69
|
9492 *
|
|
jpayne@69
|
9493 ** ^The [sqlite3_strlike(P,X,E)] interface returns zero if and only if
|
|
jpayne@69
|
9494 ** string X matches the [LIKE] pattern P with escape character E.
|
|
jpayne@69
|
9495 ** ^The definition of [LIKE] pattern matching used in
|
|
jpayne@69
|
9496 ** [sqlite3_strlike(P,X,E)] is the same as for the "X LIKE P ESCAPE E"
|
|
jpayne@69
|
9497 ** operator in the SQL dialect understood by SQLite. ^For "X LIKE P" without
|
|
jpayne@69
|
9498 ** the ESCAPE clause, set the E parameter of [sqlite3_strlike(P,X,E)] to 0.
|
|
jpayne@69
|
9499 ** ^As with the LIKE operator, the [sqlite3_strlike(P,X,E)] function is case
|
|
jpayne@69
|
9500 ** insensitive - equivalent upper and lower case ASCII characters match
|
|
jpayne@69
|
9501 ** one another.
|
|
jpayne@69
|
9502 **
|
|
jpayne@69
|
9503 ** ^The [sqlite3_strlike(P,X,E)] function matches Unicode characters, though
|
|
jpayne@69
|
9504 ** only ASCII characters are case folded.
|
|
jpayne@69
|
9505 **
|
|
jpayne@69
|
9506 ** Note that this routine returns zero on a match and non-zero if the strings
|
|
jpayne@69
|
9507 ** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()].
|
|
jpayne@69
|
9508 **
|
|
jpayne@69
|
9509 ** See also: [sqlite3_strglob()].
|
|
jpayne@69
|
9510 */
|
|
jpayne@69
|
9511 SQLITE_API int sqlite3_strlike(const char *zGlob, const char *zStr, unsigned int cEsc);
|
|
jpayne@69
|
9512
|
|
jpayne@69
|
9513 /*
|
|
jpayne@69
|
9514 ** CAPI3REF: Error Logging Interface
|
|
jpayne@69
|
9515 **
|
|
jpayne@69
|
9516 ** ^The [sqlite3_log()] interface writes a message into the [error log]
|
|
jpayne@69
|
9517 ** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()].
|
|
jpayne@69
|
9518 ** ^If logging is enabled, the zFormat string and subsequent arguments are
|
|
jpayne@69
|
9519 ** used with [sqlite3_snprintf()] to generate the final output string.
|
|
jpayne@69
|
9520 **
|
|
jpayne@69
|
9521 ** The sqlite3_log() interface is intended for use by extensions such as
|
|
jpayne@69
|
9522 ** virtual tables, collating functions, and SQL functions. While there is
|
|
jpayne@69
|
9523 ** nothing to prevent an application from calling sqlite3_log(), doing so
|
|
jpayne@69
|
9524 ** is considered bad form.
|
|
jpayne@69
|
9525 **
|
|
jpayne@69
|
9526 ** The zFormat string must not be NULL.
|
|
jpayne@69
|
9527 **
|
|
jpayne@69
|
9528 ** To avoid deadlocks and other threading problems, the sqlite3_log() routine
|
|
jpayne@69
|
9529 ** will not use dynamically allocated memory. The log message is stored in
|
|
jpayne@69
|
9530 ** a fixed-length buffer on the stack. If the log message is longer than
|
|
jpayne@69
|
9531 ** a few hundred characters, it will be truncated to the length of the
|
|
jpayne@69
|
9532 ** buffer.
|
|
jpayne@69
|
9533 */
|
|
jpayne@69
|
9534 SQLITE_API void sqlite3_log(int iErrCode, const char *zFormat, ...);
|
|
jpayne@69
|
9535
|
|
jpayne@69
|
9536 /*
|
|
jpayne@69
|
9537 ** CAPI3REF: Write-Ahead Log Commit Hook
|
|
jpayne@69
|
9538 ** METHOD: sqlite3
|
|
jpayne@69
|
9539 **
|
|
jpayne@69
|
9540 ** ^The [sqlite3_wal_hook()] function is used to register a callback that
|
|
jpayne@69
|
9541 ** is invoked each time data is committed to a database in wal mode.
|
|
jpayne@69
|
9542 **
|
|
jpayne@69
|
9543 ** ^(The callback is invoked by SQLite after the commit has taken place and
|
|
jpayne@69
|
9544 ** the associated write-lock on the database released)^, so the implementation
|
|
jpayne@69
|
9545 ** may read, write or [checkpoint] the database as required.
|
|
jpayne@69
|
9546 **
|
|
jpayne@69
|
9547 ** ^The first parameter passed to the callback function when it is invoked
|
|
jpayne@69
|
9548 ** is a copy of the third parameter passed to sqlite3_wal_hook() when
|
|
jpayne@69
|
9549 ** registering the callback. ^The second is a copy of the database handle.
|
|
jpayne@69
|
9550 ** ^The third parameter is the name of the database that was written to -
|
|
jpayne@69
|
9551 ** either "main" or the name of an [ATTACH]-ed database. ^The fourth parameter
|
|
jpayne@69
|
9552 ** is the number of pages currently in the write-ahead log file,
|
|
jpayne@69
|
9553 ** including those that were just committed.
|
|
jpayne@69
|
9554 **
|
|
jpayne@69
|
9555 ** The callback function should normally return [SQLITE_OK]. ^If an error
|
|
jpayne@69
|
9556 ** code is returned, that error will propagate back up through the
|
|
jpayne@69
|
9557 ** SQLite code base to cause the statement that provoked the callback
|
|
jpayne@69
|
9558 ** to report an error, though the commit will have still occurred. If the
|
|
jpayne@69
|
9559 ** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value
|
|
jpayne@69
|
9560 ** that does not correspond to any valid SQLite error code, the results
|
|
jpayne@69
|
9561 ** are undefined.
|
|
jpayne@69
|
9562 **
|
|
jpayne@69
|
9563 ** A single database handle may have at most a single write-ahead log callback
|
|
jpayne@69
|
9564 ** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any
|
|
jpayne@69
|
9565 ** previously registered write-ahead log callback. ^The return value is
|
|
jpayne@69
|
9566 ** a copy of the third parameter from the previous call, if any, or 0.
|
|
jpayne@69
|
9567 ** ^Note that the [sqlite3_wal_autocheckpoint()] interface and the
|
|
jpayne@69
|
9568 ** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will
|
|
jpayne@69
|
9569 ** overwrite any prior [sqlite3_wal_hook()] settings.
|
|
jpayne@69
|
9570 */
|
|
jpayne@69
|
9571 SQLITE_API void *sqlite3_wal_hook(
|
|
jpayne@69
|
9572 sqlite3*,
|
|
jpayne@69
|
9573 int(*)(void *,sqlite3*,const char*,int),
|
|
jpayne@69
|
9574 void*
|
|
jpayne@69
|
9575 );
|
|
jpayne@69
|
9576
|
|
jpayne@69
|
9577 /*
|
|
jpayne@69
|
9578 ** CAPI3REF: Configure an auto-checkpoint
|
|
jpayne@69
|
9579 ** METHOD: sqlite3
|
|
jpayne@69
|
9580 **
|
|
jpayne@69
|
9581 ** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around
|
|
jpayne@69
|
9582 ** [sqlite3_wal_hook()] that causes any database on [database connection] D
|
|
jpayne@69
|
9583 ** to automatically [checkpoint]
|
|
jpayne@69
|
9584 ** after committing a transaction if there are N or
|
|
jpayne@69
|
9585 ** more frames in the [write-ahead log] file. ^Passing zero or
|
|
jpayne@69
|
9586 ** a negative value as the nFrame parameter disables automatic
|
|
jpayne@69
|
9587 ** checkpoints entirely.
|
|
jpayne@69
|
9588 **
|
|
jpayne@69
|
9589 ** ^The callback registered by this function replaces any existing callback
|
|
jpayne@69
|
9590 ** registered using [sqlite3_wal_hook()]. ^Likewise, registering a callback
|
|
jpayne@69
|
9591 ** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism
|
|
jpayne@69
|
9592 ** configured by this function.
|
|
jpayne@69
|
9593 **
|
|
jpayne@69
|
9594 ** ^The [wal_autocheckpoint pragma] can be used to invoke this interface
|
|
jpayne@69
|
9595 ** from SQL.
|
|
jpayne@69
|
9596 **
|
|
jpayne@69
|
9597 ** ^Checkpoints initiated by this mechanism are
|
|
jpayne@69
|
9598 ** [sqlite3_wal_checkpoint_v2|PASSIVE].
|
|
jpayne@69
|
9599 **
|
|
jpayne@69
|
9600 ** ^Every new [database connection] defaults to having the auto-checkpoint
|
|
jpayne@69
|
9601 ** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT]
|
|
jpayne@69
|
9602 ** pages. The use of this interface
|
|
jpayne@69
|
9603 ** is only necessary if the default setting is found to be suboptimal
|
|
jpayne@69
|
9604 ** for a particular application.
|
|
jpayne@69
|
9605 */
|
|
jpayne@69
|
9606 SQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db, int N);
|
|
jpayne@69
|
9607
|
|
jpayne@69
|
9608 /*
|
|
jpayne@69
|
9609 ** CAPI3REF: Checkpoint a database
|
|
jpayne@69
|
9610 ** METHOD: sqlite3
|
|
jpayne@69
|
9611 **
|
|
jpayne@69
|
9612 ** ^(The sqlite3_wal_checkpoint(D,X) is equivalent to
|
|
jpayne@69
|
9613 ** [sqlite3_wal_checkpoint_v2](D,X,[SQLITE_CHECKPOINT_PASSIVE],0,0).)^
|
|
jpayne@69
|
9614 **
|
|
jpayne@69
|
9615 ** In brief, sqlite3_wal_checkpoint(D,X) causes the content in the
|
|
jpayne@69
|
9616 ** [write-ahead log] for database X on [database connection] D to be
|
|
jpayne@69
|
9617 ** transferred into the database file and for the write-ahead log to
|
|
jpayne@69
|
9618 ** be reset. See the [checkpointing] documentation for addition
|
|
jpayne@69
|
9619 ** information.
|
|
jpayne@69
|
9620 **
|
|
jpayne@69
|
9621 ** This interface used to be the only way to cause a checkpoint to
|
|
jpayne@69
|
9622 ** occur. But then the newer and more powerful [sqlite3_wal_checkpoint_v2()]
|
|
jpayne@69
|
9623 ** interface was added. This interface is retained for backwards
|
|
jpayne@69
|
9624 ** compatibility and as a convenience for applications that need to manually
|
|
jpayne@69
|
9625 ** start a callback but which do not need the full power (and corresponding
|
|
jpayne@69
|
9626 ** complication) of [sqlite3_wal_checkpoint_v2()].
|
|
jpayne@69
|
9627 */
|
|
jpayne@69
|
9628 SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb);
|
|
jpayne@69
|
9629
|
|
jpayne@69
|
9630 /*
|
|
jpayne@69
|
9631 ** CAPI3REF: Checkpoint a database
|
|
jpayne@69
|
9632 ** METHOD: sqlite3
|
|
jpayne@69
|
9633 **
|
|
jpayne@69
|
9634 ** ^(The sqlite3_wal_checkpoint_v2(D,X,M,L,C) interface runs a checkpoint
|
|
jpayne@69
|
9635 ** operation on database X of [database connection] D in mode M. Status
|
|
jpayne@69
|
9636 ** information is written back into integers pointed to by L and C.)^
|
|
jpayne@69
|
9637 ** ^(The M parameter must be a valid [checkpoint mode]:)^
|
|
jpayne@69
|
9638 **
|
|
jpayne@69
|
9639 ** <dl>
|
|
jpayne@69
|
9640 ** <dt>SQLITE_CHECKPOINT_PASSIVE<dd>
|
|
jpayne@69
|
9641 ** ^Checkpoint as many frames as possible without waiting for any database
|
|
jpayne@69
|
9642 ** readers or writers to finish, then sync the database file if all frames
|
|
jpayne@69
|
9643 ** in the log were checkpointed. ^The [busy-handler callback]
|
|
jpayne@69
|
9644 ** is never invoked in the SQLITE_CHECKPOINT_PASSIVE mode.
|
|
jpayne@69
|
9645 ** ^On the other hand, passive mode might leave the checkpoint unfinished
|
|
jpayne@69
|
9646 ** if there are concurrent readers or writers.
|
|
jpayne@69
|
9647 **
|
|
jpayne@69
|
9648 ** <dt>SQLITE_CHECKPOINT_FULL<dd>
|
|
jpayne@69
|
9649 ** ^This mode blocks (it invokes the
|
|
jpayne@69
|
9650 ** [sqlite3_busy_handler|busy-handler callback]) until there is no
|
|
jpayne@69
|
9651 ** database writer and all readers are reading from the most recent database
|
|
jpayne@69
|
9652 ** snapshot. ^It then checkpoints all frames in the log file and syncs the
|
|
jpayne@69
|
9653 ** database file. ^This mode blocks new database writers while it is pending,
|
|
jpayne@69
|
9654 ** but new database readers are allowed to continue unimpeded.
|
|
jpayne@69
|
9655 **
|
|
jpayne@69
|
9656 ** <dt>SQLITE_CHECKPOINT_RESTART<dd>
|
|
jpayne@69
|
9657 ** ^This mode works the same way as SQLITE_CHECKPOINT_FULL with the addition
|
|
jpayne@69
|
9658 ** that after checkpointing the log file it blocks (calls the
|
|
jpayne@69
|
9659 ** [busy-handler callback])
|
|
jpayne@69
|
9660 ** until all readers are reading from the database file only. ^This ensures
|
|
jpayne@69
|
9661 ** that the next writer will restart the log file from the beginning.
|
|
jpayne@69
|
9662 ** ^Like SQLITE_CHECKPOINT_FULL, this mode blocks new
|
|
jpayne@69
|
9663 ** database writer attempts while it is pending, but does not impede readers.
|
|
jpayne@69
|
9664 **
|
|
jpayne@69
|
9665 ** <dt>SQLITE_CHECKPOINT_TRUNCATE<dd>
|
|
jpayne@69
|
9666 ** ^This mode works the same way as SQLITE_CHECKPOINT_RESTART with the
|
|
jpayne@69
|
9667 ** addition that it also truncates the log file to zero bytes just prior
|
|
jpayne@69
|
9668 ** to a successful return.
|
|
jpayne@69
|
9669 ** </dl>
|
|
jpayne@69
|
9670 **
|
|
jpayne@69
|
9671 ** ^If pnLog is not NULL, then *pnLog is set to the total number of frames in
|
|
jpayne@69
|
9672 ** the log file or to -1 if the checkpoint could not run because
|
|
jpayne@69
|
9673 ** of an error or because the database is not in [WAL mode]. ^If pnCkpt is not
|
|
jpayne@69
|
9674 ** NULL,then *pnCkpt is set to the total number of checkpointed frames in the
|
|
jpayne@69
|
9675 ** log file (including any that were already checkpointed before the function
|
|
jpayne@69
|
9676 ** was called) or to -1 if the checkpoint could not run due to an error or
|
|
jpayne@69
|
9677 ** because the database is not in WAL mode. ^Note that upon successful
|
|
jpayne@69
|
9678 ** completion of an SQLITE_CHECKPOINT_TRUNCATE, the log file will have been
|
|
jpayne@69
|
9679 ** truncated to zero bytes and so both *pnLog and *pnCkpt will be set to zero.
|
|
jpayne@69
|
9680 **
|
|
jpayne@69
|
9681 ** ^All calls obtain an exclusive "checkpoint" lock on the database file. ^If
|
|
jpayne@69
|
9682 ** any other process is running a checkpoint operation at the same time, the
|
|
jpayne@69
|
9683 ** lock cannot be obtained and SQLITE_BUSY is returned. ^Even if there is a
|
|
jpayne@69
|
9684 ** busy-handler configured, it will not be invoked in this case.
|
|
jpayne@69
|
9685 **
|
|
jpayne@69
|
9686 ** ^The SQLITE_CHECKPOINT_FULL, RESTART and TRUNCATE modes also obtain the
|
|
jpayne@69
|
9687 ** exclusive "writer" lock on the database file. ^If the writer lock cannot be
|
|
jpayne@69
|
9688 ** obtained immediately, and a busy-handler is configured, it is invoked and
|
|
jpayne@69
|
9689 ** the writer lock retried until either the busy-handler returns 0 or the lock
|
|
jpayne@69
|
9690 ** is successfully obtained. ^The busy-handler is also invoked while waiting for
|
|
jpayne@69
|
9691 ** database readers as described above. ^If the busy-handler returns 0 before
|
|
jpayne@69
|
9692 ** the writer lock is obtained or while waiting for database readers, the
|
|
jpayne@69
|
9693 ** checkpoint operation proceeds from that point in the same way as
|
|
jpayne@69
|
9694 ** SQLITE_CHECKPOINT_PASSIVE - checkpointing as many frames as possible
|
|
jpayne@69
|
9695 ** without blocking any further. ^SQLITE_BUSY is returned in this case.
|
|
jpayne@69
|
9696 **
|
|
jpayne@69
|
9697 ** ^If parameter zDb is NULL or points to a zero length string, then the
|
|
jpayne@69
|
9698 ** specified operation is attempted on all WAL databases [attached] to
|
|
jpayne@69
|
9699 ** [database connection] db. In this case the
|
|
jpayne@69
|
9700 ** values written to output parameters *pnLog and *pnCkpt are undefined. ^If
|
|
jpayne@69
|
9701 ** an SQLITE_BUSY error is encountered when processing one or more of the
|
|
jpayne@69
|
9702 ** attached WAL databases, the operation is still attempted on any remaining
|
|
jpayne@69
|
9703 ** attached databases and SQLITE_BUSY is returned at the end. ^If any other
|
|
jpayne@69
|
9704 ** error occurs while processing an attached database, processing is abandoned
|
|
jpayne@69
|
9705 ** and the error code is returned to the caller immediately. ^If no error
|
|
jpayne@69
|
9706 ** (SQLITE_BUSY or otherwise) is encountered while processing the attached
|
|
jpayne@69
|
9707 ** databases, SQLITE_OK is returned.
|
|
jpayne@69
|
9708 **
|
|
jpayne@69
|
9709 ** ^If database zDb is the name of an attached database that is not in WAL
|
|
jpayne@69
|
9710 ** mode, SQLITE_OK is returned and both *pnLog and *pnCkpt set to -1. ^If
|
|
jpayne@69
|
9711 ** zDb is not NULL (or a zero length string) and is not the name of any
|
|
jpayne@69
|
9712 ** attached database, SQLITE_ERROR is returned to the caller.
|
|
jpayne@69
|
9713 **
|
|
jpayne@69
|
9714 ** ^Unless it returns SQLITE_MISUSE,
|
|
jpayne@69
|
9715 ** the sqlite3_wal_checkpoint_v2() interface
|
|
jpayne@69
|
9716 ** sets the error information that is queried by
|
|
jpayne@69
|
9717 ** [sqlite3_errcode()] and [sqlite3_errmsg()].
|
|
jpayne@69
|
9718 **
|
|
jpayne@69
|
9719 ** ^The [PRAGMA wal_checkpoint] command can be used to invoke this interface
|
|
jpayne@69
|
9720 ** from SQL.
|
|
jpayne@69
|
9721 */
|
|
jpayne@69
|
9722 SQLITE_API int sqlite3_wal_checkpoint_v2(
|
|
jpayne@69
|
9723 sqlite3 *db, /* Database handle */
|
|
jpayne@69
|
9724 const char *zDb, /* Name of attached database (or NULL) */
|
|
jpayne@69
|
9725 int eMode, /* SQLITE_CHECKPOINT_* value */
|
|
jpayne@69
|
9726 int *pnLog, /* OUT: Size of WAL log in frames */
|
|
jpayne@69
|
9727 int *pnCkpt /* OUT: Total number of frames checkpointed */
|
|
jpayne@69
|
9728 );
|
|
jpayne@69
|
9729
|
|
jpayne@69
|
9730 /*
|
|
jpayne@69
|
9731 ** CAPI3REF: Checkpoint Mode Values
|
|
jpayne@69
|
9732 ** KEYWORDS: {checkpoint mode}
|
|
jpayne@69
|
9733 **
|
|
jpayne@69
|
9734 ** These constants define all valid values for the "checkpoint mode" passed
|
|
jpayne@69
|
9735 ** as the third parameter to the [sqlite3_wal_checkpoint_v2()] interface.
|
|
jpayne@69
|
9736 ** See the [sqlite3_wal_checkpoint_v2()] documentation for details on the
|
|
jpayne@69
|
9737 ** meaning of each of these checkpoint modes.
|
|
jpayne@69
|
9738 */
|
|
jpayne@69
|
9739 #define SQLITE_CHECKPOINT_PASSIVE 0 /* Do as much as possible w/o blocking */
|
|
jpayne@69
|
9740 #define SQLITE_CHECKPOINT_FULL 1 /* Wait for writers, then checkpoint */
|
|
jpayne@69
|
9741 #define SQLITE_CHECKPOINT_RESTART 2 /* Like FULL but wait for readers */
|
|
jpayne@69
|
9742 #define SQLITE_CHECKPOINT_TRUNCATE 3 /* Like RESTART but also truncate WAL */
|
|
jpayne@69
|
9743
|
|
jpayne@69
|
9744 /*
|
|
jpayne@69
|
9745 ** CAPI3REF: Virtual Table Interface Configuration
|
|
jpayne@69
|
9746 **
|
|
jpayne@69
|
9747 ** This function may be called by either the [xConnect] or [xCreate] method
|
|
jpayne@69
|
9748 ** of a [virtual table] implementation to configure
|
|
jpayne@69
|
9749 ** various facets of the virtual table interface.
|
|
jpayne@69
|
9750 **
|
|
jpayne@69
|
9751 ** If this interface is invoked outside the context of an xConnect or
|
|
jpayne@69
|
9752 ** xCreate virtual table method then the behavior is undefined.
|
|
jpayne@69
|
9753 **
|
|
jpayne@69
|
9754 ** In the call sqlite3_vtab_config(D,C,...) the D parameter is the
|
|
jpayne@69
|
9755 ** [database connection] in which the virtual table is being created and
|
|
jpayne@69
|
9756 ** which is passed in as the first argument to the [xConnect] or [xCreate]
|
|
jpayne@69
|
9757 ** method that is invoking sqlite3_vtab_config(). The C parameter is one
|
|
jpayne@69
|
9758 ** of the [virtual table configuration options]. The presence and meaning
|
|
jpayne@69
|
9759 ** of parameters after C depend on which [virtual table configuration option]
|
|
jpayne@69
|
9760 ** is used.
|
|
jpayne@69
|
9761 */
|
|
jpayne@69
|
9762 SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, ...);
|
|
jpayne@69
|
9763
|
|
jpayne@69
|
9764 /*
|
|
jpayne@69
|
9765 ** CAPI3REF: Virtual Table Configuration Options
|
|
jpayne@69
|
9766 ** KEYWORDS: {virtual table configuration options}
|
|
jpayne@69
|
9767 ** KEYWORDS: {virtual table configuration option}
|
|
jpayne@69
|
9768 **
|
|
jpayne@69
|
9769 ** These macros define the various options to the
|
|
jpayne@69
|
9770 ** [sqlite3_vtab_config()] interface that [virtual table] implementations
|
|
jpayne@69
|
9771 ** can use to customize and optimize their behavior.
|
|
jpayne@69
|
9772 **
|
|
jpayne@69
|
9773 ** <dl>
|
|
jpayne@69
|
9774 ** [[SQLITE_VTAB_CONSTRAINT_SUPPORT]]
|
|
jpayne@69
|
9775 ** <dt>SQLITE_VTAB_CONSTRAINT_SUPPORT</dt>
|
|
jpayne@69
|
9776 ** <dd>Calls of the form
|
|
jpayne@69
|
9777 ** [sqlite3_vtab_config](db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported,
|
|
jpayne@69
|
9778 ** where X is an integer. If X is zero, then the [virtual table] whose
|
|
jpayne@69
|
9779 ** [xCreate] or [xConnect] method invoked [sqlite3_vtab_config()] does not
|
|
jpayne@69
|
9780 ** support constraints. In this configuration (which is the default) if
|
|
jpayne@69
|
9781 ** a call to the [xUpdate] method returns [SQLITE_CONSTRAINT], then the entire
|
|
jpayne@69
|
9782 ** statement is rolled back as if [ON CONFLICT | OR ABORT] had been
|
|
jpayne@69
|
9783 ** specified as part of the users SQL statement, regardless of the actual
|
|
jpayne@69
|
9784 ** ON CONFLICT mode specified.
|
|
jpayne@69
|
9785 **
|
|
jpayne@69
|
9786 ** If X is non-zero, then the virtual table implementation guarantees
|
|
jpayne@69
|
9787 ** that if [xUpdate] returns [SQLITE_CONSTRAINT], it will do so before
|
|
jpayne@69
|
9788 ** any modifications to internal or persistent data structures have been made.
|
|
jpayne@69
|
9789 ** If the [ON CONFLICT] mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite
|
|
jpayne@69
|
9790 ** is able to roll back a statement or database transaction, and abandon
|
|
jpayne@69
|
9791 ** or continue processing the current SQL statement as appropriate.
|
|
jpayne@69
|
9792 ** If the ON CONFLICT mode is REPLACE and the [xUpdate] method returns
|
|
jpayne@69
|
9793 ** [SQLITE_CONSTRAINT], SQLite handles this as if the ON CONFLICT mode
|
|
jpayne@69
|
9794 ** had been ABORT.
|
|
jpayne@69
|
9795 **
|
|
jpayne@69
|
9796 ** Virtual table implementations that are required to handle OR REPLACE
|
|
jpayne@69
|
9797 ** must do so within the [xUpdate] method. If a call to the
|
|
jpayne@69
|
9798 ** [sqlite3_vtab_on_conflict()] function indicates that the current ON
|
|
jpayne@69
|
9799 ** CONFLICT policy is REPLACE, the virtual table implementation should
|
|
jpayne@69
|
9800 ** silently replace the appropriate rows within the xUpdate callback and
|
|
jpayne@69
|
9801 ** return SQLITE_OK. Or, if this is not possible, it may return
|
|
jpayne@69
|
9802 ** SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT
|
|
jpayne@69
|
9803 ** constraint handling.
|
|
jpayne@69
|
9804 ** </dd>
|
|
jpayne@69
|
9805 **
|
|
jpayne@69
|
9806 ** [[SQLITE_VTAB_DIRECTONLY]]<dt>SQLITE_VTAB_DIRECTONLY</dt>
|
|
jpayne@69
|
9807 ** <dd>Calls of the form
|
|
jpayne@69
|
9808 ** [sqlite3_vtab_config](db,SQLITE_VTAB_DIRECTONLY) from within the
|
|
jpayne@69
|
9809 ** the [xConnect] or [xCreate] methods of a [virtual table] implementation
|
|
jpayne@69
|
9810 ** prohibits that virtual table from being used from within triggers and
|
|
jpayne@69
|
9811 ** views.
|
|
jpayne@69
|
9812 ** </dd>
|
|
jpayne@69
|
9813 **
|
|
jpayne@69
|
9814 ** [[SQLITE_VTAB_INNOCUOUS]]<dt>SQLITE_VTAB_INNOCUOUS</dt>
|
|
jpayne@69
|
9815 ** <dd>Calls of the form
|
|
jpayne@69
|
9816 ** [sqlite3_vtab_config](db,SQLITE_VTAB_INNOCUOUS) from within the
|
|
jpayne@69
|
9817 ** the [xConnect] or [xCreate] methods of a [virtual table] implementation
|
|
jpayne@69
|
9818 ** identify that virtual table as being safe to use from within triggers
|
|
jpayne@69
|
9819 ** and views. Conceptually, the SQLITE_VTAB_INNOCUOUS tag means that the
|
|
jpayne@69
|
9820 ** virtual table can do no serious harm even if it is controlled by a
|
|
jpayne@69
|
9821 ** malicious hacker. Developers should avoid setting the SQLITE_VTAB_INNOCUOUS
|
|
jpayne@69
|
9822 ** flag unless absolutely necessary.
|
|
jpayne@69
|
9823 ** </dd>
|
|
jpayne@69
|
9824 **
|
|
jpayne@69
|
9825 ** [[SQLITE_VTAB_USES_ALL_SCHEMAS]]<dt>SQLITE_VTAB_USES_ALL_SCHEMAS</dt>
|
|
jpayne@69
|
9826 ** <dd>Calls of the form
|
|
jpayne@69
|
9827 ** [sqlite3_vtab_config](db,SQLITE_VTAB_USES_ALL_SCHEMA) from within the
|
|
jpayne@69
|
9828 ** the [xConnect] or [xCreate] methods of a [virtual table] implementation
|
|
jpayne@69
|
9829 ** instruct the query planner to begin at least a read transaction on
|
|
jpayne@69
|
9830 ** all schemas ("main", "temp", and any ATTACH-ed databases) whenever the
|
|
jpayne@69
|
9831 ** virtual table is used.
|
|
jpayne@69
|
9832 ** </dd>
|
|
jpayne@69
|
9833 ** </dl>
|
|
jpayne@69
|
9834 */
|
|
jpayne@69
|
9835 #define SQLITE_VTAB_CONSTRAINT_SUPPORT 1
|
|
jpayne@69
|
9836 #define SQLITE_VTAB_INNOCUOUS 2
|
|
jpayne@69
|
9837 #define SQLITE_VTAB_DIRECTONLY 3
|
|
jpayne@69
|
9838 #define SQLITE_VTAB_USES_ALL_SCHEMAS 4
|
|
jpayne@69
|
9839
|
|
jpayne@69
|
9840 /*
|
|
jpayne@69
|
9841 ** CAPI3REF: Determine The Virtual Table Conflict Policy
|
|
jpayne@69
|
9842 **
|
|
jpayne@69
|
9843 ** This function may only be called from within a call to the [xUpdate] method
|
|
jpayne@69
|
9844 ** of a [virtual table] implementation for an INSERT or UPDATE operation. ^The
|
|
jpayne@69
|
9845 ** value returned is one of [SQLITE_ROLLBACK], [SQLITE_IGNORE], [SQLITE_FAIL],
|
|
jpayne@69
|
9846 ** [SQLITE_ABORT], or [SQLITE_REPLACE], according to the [ON CONFLICT] mode
|
|
jpayne@69
|
9847 ** of the SQL statement that triggered the call to the [xUpdate] method of the
|
|
jpayne@69
|
9848 ** [virtual table].
|
|
jpayne@69
|
9849 */
|
|
jpayne@69
|
9850 SQLITE_API int sqlite3_vtab_on_conflict(sqlite3 *);
|
|
jpayne@69
|
9851
|
|
jpayne@69
|
9852 /*
|
|
jpayne@69
|
9853 ** CAPI3REF: Determine If Virtual Table Column Access Is For UPDATE
|
|
jpayne@69
|
9854 **
|
|
jpayne@69
|
9855 ** If the sqlite3_vtab_nochange(X) routine is called within the [xColumn]
|
|
jpayne@69
|
9856 ** method of a [virtual table], then it might return true if the
|
|
jpayne@69
|
9857 ** column is being fetched as part of an UPDATE operation during which the
|
|
jpayne@69
|
9858 ** column value will not change. The virtual table implementation can use
|
|
jpayne@69
|
9859 ** this hint as permission to substitute a return value that is less
|
|
jpayne@69
|
9860 ** expensive to compute and that the corresponding
|
|
jpayne@69
|
9861 ** [xUpdate] method understands as a "no-change" value.
|
|
jpayne@69
|
9862 **
|
|
jpayne@69
|
9863 ** If the [xColumn] method calls sqlite3_vtab_nochange() and finds that
|
|
jpayne@69
|
9864 ** the column is not changed by the UPDATE statement, then the xColumn
|
|
jpayne@69
|
9865 ** method can optionally return without setting a result, without calling
|
|
jpayne@69
|
9866 ** any of the [sqlite3_result_int|sqlite3_result_xxxxx() interfaces].
|
|
jpayne@69
|
9867 ** In that case, [sqlite3_value_nochange(X)] will return true for the
|
|
jpayne@69
|
9868 ** same column in the [xUpdate] method.
|
|
jpayne@69
|
9869 **
|
|
jpayne@69
|
9870 ** The sqlite3_vtab_nochange() routine is an optimization. Virtual table
|
|
jpayne@69
|
9871 ** implementations should continue to give a correct answer even if the
|
|
jpayne@69
|
9872 ** sqlite3_vtab_nochange() interface were to always return false. In the
|
|
jpayne@69
|
9873 ** current implementation, the sqlite3_vtab_nochange() interface does always
|
|
jpayne@69
|
9874 ** returns false for the enhanced [UPDATE FROM] statement.
|
|
jpayne@69
|
9875 */
|
|
jpayne@69
|
9876 SQLITE_API int sqlite3_vtab_nochange(sqlite3_context*);
|
|
jpayne@69
|
9877
|
|
jpayne@69
|
9878 /*
|
|
jpayne@69
|
9879 ** CAPI3REF: Determine The Collation For a Virtual Table Constraint
|
|
jpayne@69
|
9880 ** METHOD: sqlite3_index_info
|
|
jpayne@69
|
9881 **
|
|
jpayne@69
|
9882 ** This function may only be called from within a call to the [xBestIndex]
|
|
jpayne@69
|
9883 ** method of a [virtual table]. This function returns a pointer to a string
|
|
jpayne@69
|
9884 ** that is the name of the appropriate collation sequence to use for text
|
|
jpayne@69
|
9885 ** comparisons on the constraint identified by its arguments.
|
|
jpayne@69
|
9886 **
|
|
jpayne@69
|
9887 ** The first argument must be the pointer to the [sqlite3_index_info] object
|
|
jpayne@69
|
9888 ** that is the first parameter to the xBestIndex() method. The second argument
|
|
jpayne@69
|
9889 ** must be an index into the aConstraint[] array belonging to the
|
|
jpayne@69
|
9890 ** sqlite3_index_info structure passed to xBestIndex.
|
|
jpayne@69
|
9891 **
|
|
jpayne@69
|
9892 ** Important:
|
|
jpayne@69
|
9893 ** The first parameter must be the same pointer that is passed into the
|
|
jpayne@69
|
9894 ** xBestMethod() method. The first parameter may not be a pointer to a
|
|
jpayne@69
|
9895 ** different [sqlite3_index_info] object, even an exact copy.
|
|
jpayne@69
|
9896 **
|
|
jpayne@69
|
9897 ** The return value is computed as follows:
|
|
jpayne@69
|
9898 **
|
|
jpayne@69
|
9899 ** <ol>
|
|
jpayne@69
|
9900 ** <li><p> If the constraint comes from a WHERE clause expression that contains
|
|
jpayne@69
|
9901 ** a [COLLATE operator], then the name of the collation specified by
|
|
jpayne@69
|
9902 ** that COLLATE operator is returned.
|
|
jpayne@69
|
9903 ** <li><p> If there is no COLLATE operator, but the column that is the subject
|
|
jpayne@69
|
9904 ** of the constraint specifies an alternative collating sequence via
|
|
jpayne@69
|
9905 ** a [COLLATE clause] on the column definition within the CREATE TABLE
|
|
jpayne@69
|
9906 ** statement that was passed into [sqlite3_declare_vtab()], then the
|
|
jpayne@69
|
9907 ** name of that alternative collating sequence is returned.
|
|
jpayne@69
|
9908 ** <li><p> Otherwise, "BINARY" is returned.
|
|
jpayne@69
|
9909 ** </ol>
|
|
jpayne@69
|
9910 */
|
|
jpayne@69
|
9911 SQLITE_API const char *sqlite3_vtab_collation(sqlite3_index_info*,int);
|
|
jpayne@69
|
9912
|
|
jpayne@69
|
9913 /*
|
|
jpayne@69
|
9914 ** CAPI3REF: Determine if a virtual table query is DISTINCT
|
|
jpayne@69
|
9915 ** METHOD: sqlite3_index_info
|
|
jpayne@69
|
9916 **
|
|
jpayne@69
|
9917 ** This API may only be used from within an [xBestIndex|xBestIndex method]
|
|
jpayne@69
|
9918 ** of a [virtual table] implementation. The result of calling this
|
|
jpayne@69
|
9919 ** interface from outside of xBestIndex() is undefined and probably harmful.
|
|
jpayne@69
|
9920 **
|
|
jpayne@69
|
9921 ** ^The sqlite3_vtab_distinct() interface returns an integer between 0 and
|
|
jpayne@69
|
9922 ** 3. The integer returned by sqlite3_vtab_distinct()
|
|
jpayne@69
|
9923 ** gives the virtual table additional information about how the query
|
|
jpayne@69
|
9924 ** planner wants the output to be ordered. As long as the virtual table
|
|
jpayne@69
|
9925 ** can meet the ordering requirements of the query planner, it may set
|
|
jpayne@69
|
9926 ** the "orderByConsumed" flag.
|
|
jpayne@69
|
9927 **
|
|
jpayne@69
|
9928 ** <ol><li value="0"><p>
|
|
jpayne@69
|
9929 ** ^If the sqlite3_vtab_distinct() interface returns 0, that means
|
|
jpayne@69
|
9930 ** that the query planner needs the virtual table to return all rows in the
|
|
jpayne@69
|
9931 ** sort order defined by the "nOrderBy" and "aOrderBy" fields of the
|
|
jpayne@69
|
9932 ** [sqlite3_index_info] object. This is the default expectation. If the
|
|
jpayne@69
|
9933 ** virtual table outputs all rows in sorted order, then it is always safe for
|
|
jpayne@69
|
9934 ** the xBestIndex method to set the "orderByConsumed" flag, regardless of
|
|
jpayne@69
|
9935 ** the return value from sqlite3_vtab_distinct().
|
|
jpayne@69
|
9936 ** <li value="1"><p>
|
|
jpayne@69
|
9937 ** ^(If the sqlite3_vtab_distinct() interface returns 1, that means
|
|
jpayne@69
|
9938 ** that the query planner does not need the rows to be returned in sorted order
|
|
jpayne@69
|
9939 ** as long as all rows with the same values in all columns identified by the
|
|
jpayne@69
|
9940 ** "aOrderBy" field are adjacent.)^ This mode is used when the query planner
|
|
jpayne@69
|
9941 ** is doing a GROUP BY.
|
|
jpayne@69
|
9942 ** <li value="2"><p>
|
|
jpayne@69
|
9943 ** ^(If the sqlite3_vtab_distinct() interface returns 2, that means
|
|
jpayne@69
|
9944 ** that the query planner does not need the rows returned in any particular
|
|
jpayne@69
|
9945 ** order, as long as rows with the same values in all columns identified
|
|
jpayne@69
|
9946 ** by "aOrderBy" are adjacent.)^ ^(Furthermore, when two or more rows
|
|
jpayne@69
|
9947 ** contain the same values for all columns identified by "colUsed", all but
|
|
jpayne@69
|
9948 ** one such row may optionally be omitted from the result.)^
|
|
jpayne@69
|
9949 ** The virtual table is not required to omit rows that are duplicates
|
|
jpayne@69
|
9950 ** over the "colUsed" columns, but if the virtual table can do that without
|
|
jpayne@69
|
9951 ** too much extra effort, it could potentially help the query to run faster.
|
|
jpayne@69
|
9952 ** This mode is used for a DISTINCT query.
|
|
jpayne@69
|
9953 ** <li value="3"><p>
|
|
jpayne@69
|
9954 ** ^(If the sqlite3_vtab_distinct() interface returns 3, that means the
|
|
jpayne@69
|
9955 ** virtual table must return rows in the order defined by "aOrderBy" as
|
|
jpayne@69
|
9956 ** if the sqlite3_vtab_distinct() interface had returned 0. However if
|
|
jpayne@69
|
9957 ** two or more rows in the result have the same values for all columns
|
|
jpayne@69
|
9958 ** identified by "colUsed", then all but one such row may optionally be
|
|
jpayne@69
|
9959 ** omitted.)^ Like when the return value is 2, the virtual table
|
|
jpayne@69
|
9960 ** is not required to omit rows that are duplicates over the "colUsed"
|
|
jpayne@69
|
9961 ** columns, but if the virtual table can do that without
|
|
jpayne@69
|
9962 ** too much extra effort, it could potentially help the query to run faster.
|
|
jpayne@69
|
9963 ** This mode is used for queries
|
|
jpayne@69
|
9964 ** that have both DISTINCT and ORDER BY clauses.
|
|
jpayne@69
|
9965 ** </ol>
|
|
jpayne@69
|
9966 **
|
|
jpayne@69
|
9967 ** <p>The following table summarizes the conditions under which the
|
|
jpayne@69
|
9968 ** virtual table is allowed to set the "orderByConsumed" flag based on
|
|
jpayne@69
|
9969 ** the value returned by sqlite3_vtab_distinct(). This table is a
|
|
jpayne@69
|
9970 ** restatement of the previous four paragraphs:
|
|
jpayne@69
|
9971 **
|
|
jpayne@69
|
9972 ** <table border=1 cellspacing=0 cellpadding=10 width="90%">
|
|
jpayne@69
|
9973 ** <tr>
|
|
jpayne@69
|
9974 ** <td valign="top">sqlite3_vtab_distinct() return value
|
|
jpayne@69
|
9975 ** <td valign="top">Rows are returned in aOrderBy order
|
|
jpayne@69
|
9976 ** <td valign="top">Rows with the same value in all aOrderBy columns are adjacent
|
|
jpayne@69
|
9977 ** <td valign="top">Duplicates over all colUsed columns may be omitted
|
|
jpayne@69
|
9978 ** <tr><td>0<td>yes<td>yes<td>no
|
|
jpayne@69
|
9979 ** <tr><td>1<td>no<td>yes<td>no
|
|
jpayne@69
|
9980 ** <tr><td>2<td>no<td>yes<td>yes
|
|
jpayne@69
|
9981 ** <tr><td>3<td>yes<td>yes<td>yes
|
|
jpayne@69
|
9982 ** </table>
|
|
jpayne@69
|
9983 **
|
|
jpayne@69
|
9984 ** ^For the purposes of comparing virtual table output values to see if the
|
|
jpayne@69
|
9985 ** values are same value for sorting purposes, two NULL values are considered
|
|
jpayne@69
|
9986 ** to be the same. In other words, the comparison operator is "IS"
|
|
jpayne@69
|
9987 ** (or "IS NOT DISTINCT FROM") and not "==".
|
|
jpayne@69
|
9988 **
|
|
jpayne@69
|
9989 ** If a virtual table implementation is unable to meet the requirements
|
|
jpayne@69
|
9990 ** specified above, then it must not set the "orderByConsumed" flag in the
|
|
jpayne@69
|
9991 ** [sqlite3_index_info] object or an incorrect answer may result.
|
|
jpayne@69
|
9992 **
|
|
jpayne@69
|
9993 ** ^A virtual table implementation is always free to return rows in any order
|
|
jpayne@69
|
9994 ** it wants, as long as the "orderByConsumed" flag is not set. ^When the
|
|
jpayne@69
|
9995 ** the "orderByConsumed" flag is unset, the query planner will add extra
|
|
jpayne@69
|
9996 ** [bytecode] to ensure that the final results returned by the SQL query are
|
|
jpayne@69
|
9997 ** ordered correctly. The use of the "orderByConsumed" flag and the
|
|
jpayne@69
|
9998 ** sqlite3_vtab_distinct() interface is merely an optimization. ^Careful
|
|
jpayne@69
|
9999 ** use of the sqlite3_vtab_distinct() interface and the "orderByConsumed"
|
|
jpayne@69
|
10000 ** flag might help queries against a virtual table to run faster. Being
|
|
jpayne@69
|
10001 ** overly aggressive and setting the "orderByConsumed" flag when it is not
|
|
jpayne@69
|
10002 ** valid to do so, on the other hand, might cause SQLite to return incorrect
|
|
jpayne@69
|
10003 ** results.
|
|
jpayne@69
|
10004 */
|
|
jpayne@69
|
10005 SQLITE_API int sqlite3_vtab_distinct(sqlite3_index_info*);
|
|
jpayne@69
|
10006
|
|
jpayne@69
|
10007 /*
|
|
jpayne@69
|
10008 ** CAPI3REF: Identify and handle IN constraints in xBestIndex
|
|
jpayne@69
|
10009 **
|
|
jpayne@69
|
10010 ** This interface may only be used from within an
|
|
jpayne@69
|
10011 ** [xBestIndex|xBestIndex() method] of a [virtual table] implementation.
|
|
jpayne@69
|
10012 ** The result of invoking this interface from any other context is
|
|
jpayne@69
|
10013 ** undefined and probably harmful.
|
|
jpayne@69
|
10014 **
|
|
jpayne@69
|
10015 ** ^(A constraint on a virtual table of the form
|
|
jpayne@69
|
10016 ** "[IN operator|column IN (...)]" is
|
|
jpayne@69
|
10017 ** communicated to the xBestIndex method as a
|
|
jpayne@69
|
10018 ** [SQLITE_INDEX_CONSTRAINT_EQ] constraint.)^ If xBestIndex wants to use
|
|
jpayne@69
|
10019 ** this constraint, it must set the corresponding
|
|
jpayne@69
|
10020 ** aConstraintUsage[].argvIndex to a positive integer. ^(Then, under
|
|
jpayne@69
|
10021 ** the usual mode of handling IN operators, SQLite generates [bytecode]
|
|
jpayne@69
|
10022 ** that invokes the [xFilter|xFilter() method] once for each value
|
|
jpayne@69
|
10023 ** on the right-hand side of the IN operator.)^ Thus the virtual table
|
|
jpayne@69
|
10024 ** only sees a single value from the right-hand side of the IN operator
|
|
jpayne@69
|
10025 ** at a time.
|
|
jpayne@69
|
10026 **
|
|
jpayne@69
|
10027 ** In some cases, however, it would be advantageous for the virtual
|
|
jpayne@69
|
10028 ** table to see all values on the right-hand of the IN operator all at
|
|
jpayne@69
|
10029 ** once. The sqlite3_vtab_in() interfaces facilitates this in two ways:
|
|
jpayne@69
|
10030 **
|
|
jpayne@69
|
10031 ** <ol>
|
|
jpayne@69
|
10032 ** <li><p>
|
|
jpayne@69
|
10033 ** ^A call to sqlite3_vtab_in(P,N,-1) will return true (non-zero)
|
|
jpayne@69
|
10034 ** if and only if the [sqlite3_index_info|P->aConstraint][N] constraint
|
|
jpayne@69
|
10035 ** is an [IN operator] that can be processed all at once. ^In other words,
|
|
jpayne@69
|
10036 ** sqlite3_vtab_in() with -1 in the third argument is a mechanism
|
|
jpayne@69
|
10037 ** by which the virtual table can ask SQLite if all-at-once processing
|
|
jpayne@69
|
10038 ** of the IN operator is even possible.
|
|
jpayne@69
|
10039 **
|
|
jpayne@69
|
10040 ** <li><p>
|
|
jpayne@69
|
10041 ** ^A call to sqlite3_vtab_in(P,N,F) with F==1 or F==0 indicates
|
|
jpayne@69
|
10042 ** to SQLite that the virtual table does or does not want to process
|
|
jpayne@69
|
10043 ** the IN operator all-at-once, respectively. ^Thus when the third
|
|
jpayne@69
|
10044 ** parameter (F) is non-negative, this interface is the mechanism by
|
|
jpayne@69
|
10045 ** which the virtual table tells SQLite how it wants to process the
|
|
jpayne@69
|
10046 ** IN operator.
|
|
jpayne@69
|
10047 ** </ol>
|
|
jpayne@69
|
10048 **
|
|
jpayne@69
|
10049 ** ^The sqlite3_vtab_in(P,N,F) interface can be invoked multiple times
|
|
jpayne@69
|
10050 ** within the same xBestIndex method call. ^For any given P,N pair,
|
|
jpayne@69
|
10051 ** the return value from sqlite3_vtab_in(P,N,F) will always be the same
|
|
jpayne@69
|
10052 ** within the same xBestIndex call. ^If the interface returns true
|
|
jpayne@69
|
10053 ** (non-zero), that means that the constraint is an IN operator
|
|
jpayne@69
|
10054 ** that can be processed all-at-once. ^If the constraint is not an IN
|
|
jpayne@69
|
10055 ** operator or cannot be processed all-at-once, then the interface returns
|
|
jpayne@69
|
10056 ** false.
|
|
jpayne@69
|
10057 **
|
|
jpayne@69
|
10058 ** ^(All-at-once processing of the IN operator is selected if both of the
|
|
jpayne@69
|
10059 ** following conditions are met:
|
|
jpayne@69
|
10060 **
|
|
jpayne@69
|
10061 ** <ol>
|
|
jpayne@69
|
10062 ** <li><p> The P->aConstraintUsage[N].argvIndex value is set to a positive
|
|
jpayne@69
|
10063 ** integer. This is how the virtual table tells SQLite that it wants to
|
|
jpayne@69
|
10064 ** use the N-th constraint.
|
|
jpayne@69
|
10065 **
|
|
jpayne@69
|
10066 ** <li><p> The last call to sqlite3_vtab_in(P,N,F) for which F was
|
|
jpayne@69
|
10067 ** non-negative had F>=1.
|
|
jpayne@69
|
10068 ** </ol>)^
|
|
jpayne@69
|
10069 **
|
|
jpayne@69
|
10070 ** ^If either or both of the conditions above are false, then SQLite uses
|
|
jpayne@69
|
10071 ** the traditional one-at-a-time processing strategy for the IN constraint.
|
|
jpayne@69
|
10072 ** ^If both conditions are true, then the argvIndex-th parameter to the
|
|
jpayne@69
|
10073 ** xFilter method will be an [sqlite3_value] that appears to be NULL,
|
|
jpayne@69
|
10074 ** but which can be passed to [sqlite3_vtab_in_first()] and
|
|
jpayne@69
|
10075 ** [sqlite3_vtab_in_next()] to find all values on the right-hand side
|
|
jpayne@69
|
10076 ** of the IN constraint.
|
|
jpayne@69
|
10077 */
|
|
jpayne@69
|
10078 SQLITE_API int sqlite3_vtab_in(sqlite3_index_info*, int iCons, int bHandle);
|
|
jpayne@69
|
10079
|
|
jpayne@69
|
10080 /*
|
|
jpayne@69
|
10081 ** CAPI3REF: Find all elements on the right-hand side of an IN constraint.
|
|
jpayne@69
|
10082 **
|
|
jpayne@69
|
10083 ** These interfaces are only useful from within the
|
|
jpayne@69
|
10084 ** [xFilter|xFilter() method] of a [virtual table] implementation.
|
|
jpayne@69
|
10085 ** The result of invoking these interfaces from any other context
|
|
jpayne@69
|
10086 ** is undefined and probably harmful.
|
|
jpayne@69
|
10087 **
|
|
jpayne@69
|
10088 ** The X parameter in a call to sqlite3_vtab_in_first(X,P) or
|
|
jpayne@69
|
10089 ** sqlite3_vtab_in_next(X,P) should be one of the parameters to the
|
|
jpayne@69
|
10090 ** xFilter method which invokes these routines, and specifically
|
|
jpayne@69
|
10091 ** a parameter that was previously selected for all-at-once IN constraint
|
|
jpayne@69
|
10092 ** processing use the [sqlite3_vtab_in()] interface in the
|
|
jpayne@69
|
10093 ** [xBestIndex|xBestIndex method]. ^(If the X parameter is not
|
|
jpayne@69
|
10094 ** an xFilter argument that was selected for all-at-once IN constraint
|
|
jpayne@69
|
10095 ** processing, then these routines return [SQLITE_ERROR].)^
|
|
jpayne@69
|
10096 **
|
|
jpayne@69
|
10097 ** ^(Use these routines to access all values on the right-hand side
|
|
jpayne@69
|
10098 ** of the IN constraint using code like the following:
|
|
jpayne@69
|
10099 **
|
|
jpayne@69
|
10100 ** <blockquote><pre>
|
|
jpayne@69
|
10101 ** for(rc=sqlite3_vtab_in_first(pList, &pVal);
|
|
jpayne@69
|
10102 ** rc==SQLITE_OK && pVal;
|
|
jpayne@69
|
10103 ** rc=sqlite3_vtab_in_next(pList, &pVal)
|
|
jpayne@69
|
10104 ** ){
|
|
jpayne@69
|
10105 ** // do something with pVal
|
|
jpayne@69
|
10106 ** }
|
|
jpayne@69
|
10107 ** if( rc!=SQLITE_OK ){
|
|
jpayne@69
|
10108 ** // an error has occurred
|
|
jpayne@69
|
10109 ** }
|
|
jpayne@69
|
10110 ** </pre></blockquote>)^
|
|
jpayne@69
|
10111 **
|
|
jpayne@69
|
10112 ** ^On success, the sqlite3_vtab_in_first(X,P) and sqlite3_vtab_in_next(X,P)
|
|
jpayne@69
|
10113 ** routines return SQLITE_OK and set *P to point to the first or next value
|
|
jpayne@69
|
10114 ** on the RHS of the IN constraint. ^If there are no more values on the
|
|
jpayne@69
|
10115 ** right hand side of the IN constraint, then *P is set to NULL and these
|
|
jpayne@69
|
10116 ** routines return [SQLITE_DONE]. ^The return value might be
|
|
jpayne@69
|
10117 ** some other value, such as SQLITE_NOMEM, in the event of a malfunction.
|
|
jpayne@69
|
10118 **
|
|
jpayne@69
|
10119 ** The *ppOut values returned by these routines are only valid until the
|
|
jpayne@69
|
10120 ** next call to either of these routines or until the end of the xFilter
|
|
jpayne@69
|
10121 ** method from which these routines were called. If the virtual table
|
|
jpayne@69
|
10122 ** implementation needs to retain the *ppOut values for longer, it must make
|
|
jpayne@69
|
10123 ** copies. The *ppOut values are [protected sqlite3_value|protected].
|
|
jpayne@69
|
10124 */
|
|
jpayne@69
|
10125 SQLITE_API int sqlite3_vtab_in_first(sqlite3_value *pVal, sqlite3_value **ppOut);
|
|
jpayne@69
|
10126 SQLITE_API int sqlite3_vtab_in_next(sqlite3_value *pVal, sqlite3_value **ppOut);
|
|
jpayne@69
|
10127
|
|
jpayne@69
|
10128 /*
|
|
jpayne@69
|
10129 ** CAPI3REF: Constraint values in xBestIndex()
|
|
jpayne@69
|
10130 ** METHOD: sqlite3_index_info
|
|
jpayne@69
|
10131 **
|
|
jpayne@69
|
10132 ** This API may only be used from within the [xBestIndex|xBestIndex method]
|
|
jpayne@69
|
10133 ** of a [virtual table] implementation. The result of calling this interface
|
|
jpayne@69
|
10134 ** from outside of an xBestIndex method are undefined and probably harmful.
|
|
jpayne@69
|
10135 **
|
|
jpayne@69
|
10136 ** ^When the sqlite3_vtab_rhs_value(P,J,V) interface is invoked from within
|
|
jpayne@69
|
10137 ** the [xBestIndex] method of a [virtual table] implementation, with P being
|
|
jpayne@69
|
10138 ** a copy of the [sqlite3_index_info] object pointer passed into xBestIndex and
|
|
jpayne@69
|
10139 ** J being a 0-based index into P->aConstraint[], then this routine
|
|
jpayne@69
|
10140 ** attempts to set *V to the value of the right-hand operand of
|
|
jpayne@69
|
10141 ** that constraint if the right-hand operand is known. ^If the
|
|
jpayne@69
|
10142 ** right-hand operand is not known, then *V is set to a NULL pointer.
|
|
jpayne@69
|
10143 ** ^The sqlite3_vtab_rhs_value(P,J,V) interface returns SQLITE_OK if
|
|
jpayne@69
|
10144 ** and only if *V is set to a value. ^The sqlite3_vtab_rhs_value(P,J,V)
|
|
jpayne@69
|
10145 ** inteface returns SQLITE_NOTFOUND if the right-hand side of the J-th
|
|
jpayne@69
|
10146 ** constraint is not available. ^The sqlite3_vtab_rhs_value() interface
|
|
jpayne@69
|
10147 ** can return an result code other than SQLITE_OK or SQLITE_NOTFOUND if
|
|
jpayne@69
|
10148 ** something goes wrong.
|
|
jpayne@69
|
10149 **
|
|
jpayne@69
|
10150 ** The sqlite3_vtab_rhs_value() interface is usually only successful if
|
|
jpayne@69
|
10151 ** the right-hand operand of a constraint is a literal value in the original
|
|
jpayne@69
|
10152 ** SQL statement. If the right-hand operand is an expression or a reference
|
|
jpayne@69
|
10153 ** to some other column or a [host parameter], then sqlite3_vtab_rhs_value()
|
|
jpayne@69
|
10154 ** will probably return [SQLITE_NOTFOUND].
|
|
jpayne@69
|
10155 **
|
|
jpayne@69
|
10156 ** ^(Some constraints, such as [SQLITE_INDEX_CONSTRAINT_ISNULL] and
|
|
jpayne@69
|
10157 ** [SQLITE_INDEX_CONSTRAINT_ISNOTNULL], have no right-hand operand. For such
|
|
jpayne@69
|
10158 ** constraints, sqlite3_vtab_rhs_value() always returns SQLITE_NOTFOUND.)^
|
|
jpayne@69
|
10159 **
|
|
jpayne@69
|
10160 ** ^The [sqlite3_value] object returned in *V is a protected sqlite3_value
|
|
jpayne@69
|
10161 ** and remains valid for the duration of the xBestIndex method call.
|
|
jpayne@69
|
10162 ** ^When xBestIndex returns, the sqlite3_value object returned by
|
|
jpayne@69
|
10163 ** sqlite3_vtab_rhs_value() is automatically deallocated.
|
|
jpayne@69
|
10164 **
|
|
jpayne@69
|
10165 ** The "_rhs_" in the name of this routine is an abbreviation for
|
|
jpayne@69
|
10166 ** "Right-Hand Side".
|
|
jpayne@69
|
10167 */
|
|
jpayne@69
|
10168 SQLITE_API int sqlite3_vtab_rhs_value(sqlite3_index_info*, int, sqlite3_value **ppVal);
|
|
jpayne@69
|
10169
|
|
jpayne@69
|
10170 /*
|
|
jpayne@69
|
10171 ** CAPI3REF: Conflict resolution modes
|
|
jpayne@69
|
10172 ** KEYWORDS: {conflict resolution mode}
|
|
jpayne@69
|
10173 **
|
|
jpayne@69
|
10174 ** These constants are returned by [sqlite3_vtab_on_conflict()] to
|
|
jpayne@69
|
10175 ** inform a [virtual table] implementation what the [ON CONFLICT] mode
|
|
jpayne@69
|
10176 ** is for the SQL statement being evaluated.
|
|
jpayne@69
|
10177 **
|
|
jpayne@69
|
10178 ** Note that the [SQLITE_IGNORE] constant is also used as a potential
|
|
jpayne@69
|
10179 ** return value from the [sqlite3_set_authorizer()] callback and that
|
|
jpayne@69
|
10180 ** [SQLITE_ABORT] is also a [result code].
|
|
jpayne@69
|
10181 */
|
|
jpayne@69
|
10182 #define SQLITE_ROLLBACK 1
|
|
jpayne@69
|
10183 /* #define SQLITE_IGNORE 2 // Also used by sqlite3_authorizer() callback */
|
|
jpayne@69
|
10184 #define SQLITE_FAIL 3
|
|
jpayne@69
|
10185 /* #define SQLITE_ABORT 4 // Also an error code */
|
|
jpayne@69
|
10186 #define SQLITE_REPLACE 5
|
|
jpayne@69
|
10187
|
|
jpayne@69
|
10188 /*
|
|
jpayne@69
|
10189 ** CAPI3REF: Prepared Statement Scan Status Opcodes
|
|
jpayne@69
|
10190 ** KEYWORDS: {scanstatus options}
|
|
jpayne@69
|
10191 **
|
|
jpayne@69
|
10192 ** The following constants can be used for the T parameter to the
|
|
jpayne@69
|
10193 ** [sqlite3_stmt_scanstatus(S,X,T,V)] interface. Each constant designates a
|
|
jpayne@69
|
10194 ** different metric for sqlite3_stmt_scanstatus() to return.
|
|
jpayne@69
|
10195 **
|
|
jpayne@69
|
10196 ** When the value returned to V is a string, space to hold that string is
|
|
jpayne@69
|
10197 ** managed by the prepared statement S and will be automatically freed when
|
|
jpayne@69
|
10198 ** S is finalized.
|
|
jpayne@69
|
10199 **
|
|
jpayne@69
|
10200 ** Not all values are available for all query elements. When a value is
|
|
jpayne@69
|
10201 ** not available, the output variable is set to -1 if the value is numeric,
|
|
jpayne@69
|
10202 ** or to NULL if it is a string (SQLITE_SCANSTAT_NAME).
|
|
jpayne@69
|
10203 **
|
|
jpayne@69
|
10204 ** <dl>
|
|
jpayne@69
|
10205 ** [[SQLITE_SCANSTAT_NLOOP]] <dt>SQLITE_SCANSTAT_NLOOP</dt>
|
|
jpayne@69
|
10206 ** <dd>^The [sqlite3_int64] variable pointed to by the V parameter will be
|
|
jpayne@69
|
10207 ** set to the total number of times that the X-th loop has run.</dd>
|
|
jpayne@69
|
10208 **
|
|
jpayne@69
|
10209 ** [[SQLITE_SCANSTAT_NVISIT]] <dt>SQLITE_SCANSTAT_NVISIT</dt>
|
|
jpayne@69
|
10210 ** <dd>^The [sqlite3_int64] variable pointed to by the V parameter will be set
|
|
jpayne@69
|
10211 ** to the total number of rows examined by all iterations of the X-th loop.</dd>
|
|
jpayne@69
|
10212 **
|
|
jpayne@69
|
10213 ** [[SQLITE_SCANSTAT_EST]] <dt>SQLITE_SCANSTAT_EST</dt>
|
|
jpayne@69
|
10214 ** <dd>^The "double" variable pointed to by the V parameter will be set to the
|
|
jpayne@69
|
10215 ** query planner's estimate for the average number of rows output from each
|
|
jpayne@69
|
10216 ** iteration of the X-th loop. If the query planner's estimates was accurate,
|
|
jpayne@69
|
10217 ** then this value will approximate the quotient NVISIT/NLOOP and the
|
|
jpayne@69
|
10218 ** product of this value for all prior loops with the same SELECTID will
|
|
jpayne@69
|
10219 ** be the NLOOP value for the current loop.
|
|
jpayne@69
|
10220 **
|
|
jpayne@69
|
10221 ** [[SQLITE_SCANSTAT_NAME]] <dt>SQLITE_SCANSTAT_NAME</dt>
|
|
jpayne@69
|
10222 ** <dd>^The "const char *" variable pointed to by the V parameter will be set
|
|
jpayne@69
|
10223 ** to a zero-terminated UTF-8 string containing the name of the index or table
|
|
jpayne@69
|
10224 ** used for the X-th loop.
|
|
jpayne@69
|
10225 **
|
|
jpayne@69
|
10226 ** [[SQLITE_SCANSTAT_EXPLAIN]] <dt>SQLITE_SCANSTAT_EXPLAIN</dt>
|
|
jpayne@69
|
10227 ** <dd>^The "const char *" variable pointed to by the V parameter will be set
|
|
jpayne@69
|
10228 ** to a zero-terminated UTF-8 string containing the [EXPLAIN QUERY PLAN]
|
|
jpayne@69
|
10229 ** description for the X-th loop.
|
|
jpayne@69
|
10230 **
|
|
jpayne@69
|
10231 ** [[SQLITE_SCANSTAT_SELECTID]] <dt>SQLITE_SCANSTAT_SELECTID</dt>
|
|
jpayne@69
|
10232 ** <dd>^The "int" variable pointed to by the V parameter will be set to the
|
|
jpayne@69
|
10233 ** id for the X-th query plan element. The id value is unique within the
|
|
jpayne@69
|
10234 ** statement. The select-id is the same value as is output in the first
|
|
jpayne@69
|
10235 ** column of an [EXPLAIN QUERY PLAN] query.
|
|
jpayne@69
|
10236 **
|
|
jpayne@69
|
10237 ** [[SQLITE_SCANSTAT_PARENTID]] <dt>SQLITE_SCANSTAT_PARENTID</dt>
|
|
jpayne@69
|
10238 ** <dd>The "int" variable pointed to by the V parameter will be set to the
|
|
jpayne@69
|
10239 ** the id of the parent of the current query element, if applicable, or
|
|
jpayne@69
|
10240 ** to zero if the query element has no parent. This is the same value as
|
|
jpayne@69
|
10241 ** returned in the second column of an [EXPLAIN QUERY PLAN] query.
|
|
jpayne@69
|
10242 **
|
|
jpayne@69
|
10243 ** [[SQLITE_SCANSTAT_NCYCLE]] <dt>SQLITE_SCANSTAT_NCYCLE</dt>
|
|
jpayne@69
|
10244 ** <dd>The sqlite3_int64 output value is set to the number of cycles,
|
|
jpayne@69
|
10245 ** according to the processor time-stamp counter, that elapsed while the
|
|
jpayne@69
|
10246 ** query element was being processed. This value is not available for
|
|
jpayne@69
|
10247 ** all query elements - if it is unavailable the output variable is
|
|
jpayne@69
|
10248 ** set to -1.
|
|
jpayne@69
|
10249 ** </dl>
|
|
jpayne@69
|
10250 */
|
|
jpayne@69
|
10251 #define SQLITE_SCANSTAT_NLOOP 0
|
|
jpayne@69
|
10252 #define SQLITE_SCANSTAT_NVISIT 1
|
|
jpayne@69
|
10253 #define SQLITE_SCANSTAT_EST 2
|
|
jpayne@69
|
10254 #define SQLITE_SCANSTAT_NAME 3
|
|
jpayne@69
|
10255 #define SQLITE_SCANSTAT_EXPLAIN 4
|
|
jpayne@69
|
10256 #define SQLITE_SCANSTAT_SELECTID 5
|
|
jpayne@69
|
10257 #define SQLITE_SCANSTAT_PARENTID 6
|
|
jpayne@69
|
10258 #define SQLITE_SCANSTAT_NCYCLE 7
|
|
jpayne@69
|
10259
|
|
jpayne@69
|
10260 /*
|
|
jpayne@69
|
10261 ** CAPI3REF: Prepared Statement Scan Status
|
|
jpayne@69
|
10262 ** METHOD: sqlite3_stmt
|
|
jpayne@69
|
10263 **
|
|
jpayne@69
|
10264 ** These interfaces return information about the predicted and measured
|
|
jpayne@69
|
10265 ** performance for pStmt. Advanced applications can use this
|
|
jpayne@69
|
10266 ** interface to compare the predicted and the measured performance and
|
|
jpayne@69
|
10267 ** issue warnings and/or rerun [ANALYZE] if discrepancies are found.
|
|
jpayne@69
|
10268 **
|
|
jpayne@69
|
10269 ** Since this interface is expected to be rarely used, it is only
|
|
jpayne@69
|
10270 ** available if SQLite is compiled using the [SQLITE_ENABLE_STMT_SCANSTATUS]
|
|
jpayne@69
|
10271 ** compile-time option.
|
|
jpayne@69
|
10272 **
|
|
jpayne@69
|
10273 ** The "iScanStatusOp" parameter determines which status information to return.
|
|
jpayne@69
|
10274 ** The "iScanStatusOp" must be one of the [scanstatus options] or the behavior
|
|
jpayne@69
|
10275 ** of this interface is undefined. ^The requested measurement is written into
|
|
jpayne@69
|
10276 ** a variable pointed to by the "pOut" parameter.
|
|
jpayne@69
|
10277 **
|
|
jpayne@69
|
10278 ** The "flags" parameter must be passed a mask of flags. At present only
|
|
jpayne@69
|
10279 ** one flag is defined - SQLITE_SCANSTAT_COMPLEX. If SQLITE_SCANSTAT_COMPLEX
|
|
jpayne@69
|
10280 ** is specified, then status information is available for all elements
|
|
jpayne@69
|
10281 ** of a query plan that are reported by "EXPLAIN QUERY PLAN" output. If
|
|
jpayne@69
|
10282 ** SQLITE_SCANSTAT_COMPLEX is not specified, then only query plan elements
|
|
jpayne@69
|
10283 ** that correspond to query loops (the "SCAN..." and "SEARCH..." elements of
|
|
jpayne@69
|
10284 ** the EXPLAIN QUERY PLAN output) are available. Invoking API
|
|
jpayne@69
|
10285 ** sqlite3_stmt_scanstatus() is equivalent to calling
|
|
jpayne@69
|
10286 ** sqlite3_stmt_scanstatus_v2() with a zeroed flags parameter.
|
|
jpayne@69
|
10287 **
|
|
jpayne@69
|
10288 ** Parameter "idx" identifies the specific query element to retrieve statistics
|
|
jpayne@69
|
10289 ** for. Query elements are numbered starting from zero. A value of -1 may be
|
|
jpayne@69
|
10290 ** to query for statistics regarding the entire query. ^If idx is out of range
|
|
jpayne@69
|
10291 ** - less than -1 or greater than or equal to the total number of query
|
|
jpayne@69
|
10292 ** elements used to implement the statement - a non-zero value is returned and
|
|
jpayne@69
|
10293 ** the variable that pOut points to is unchanged.
|
|
jpayne@69
|
10294 **
|
|
jpayne@69
|
10295 ** See also: [sqlite3_stmt_scanstatus_reset()]
|
|
jpayne@69
|
10296 */
|
|
jpayne@69
|
10297 SQLITE_API int sqlite3_stmt_scanstatus(
|
|
jpayne@69
|
10298 sqlite3_stmt *pStmt, /* Prepared statement for which info desired */
|
|
jpayne@69
|
10299 int idx, /* Index of loop to report on */
|
|
jpayne@69
|
10300 int iScanStatusOp, /* Information desired. SQLITE_SCANSTAT_* */
|
|
jpayne@69
|
10301 void *pOut /* Result written here */
|
|
jpayne@69
|
10302 );
|
|
jpayne@69
|
10303 SQLITE_API int sqlite3_stmt_scanstatus_v2(
|
|
jpayne@69
|
10304 sqlite3_stmt *pStmt, /* Prepared statement for which info desired */
|
|
jpayne@69
|
10305 int idx, /* Index of loop to report on */
|
|
jpayne@69
|
10306 int iScanStatusOp, /* Information desired. SQLITE_SCANSTAT_* */
|
|
jpayne@69
|
10307 int flags, /* Mask of flags defined below */
|
|
jpayne@69
|
10308 void *pOut /* Result written here */
|
|
jpayne@69
|
10309 );
|
|
jpayne@69
|
10310
|
|
jpayne@69
|
10311 /*
|
|
jpayne@69
|
10312 ** CAPI3REF: Prepared Statement Scan Status
|
|
jpayne@69
|
10313 ** KEYWORDS: {scan status flags}
|
|
jpayne@69
|
10314 */
|
|
jpayne@69
|
10315 #define SQLITE_SCANSTAT_COMPLEX 0x0001
|
|
jpayne@69
|
10316
|
|
jpayne@69
|
10317 /*
|
|
jpayne@69
|
10318 ** CAPI3REF: Zero Scan-Status Counters
|
|
jpayne@69
|
10319 ** METHOD: sqlite3_stmt
|
|
jpayne@69
|
10320 **
|
|
jpayne@69
|
10321 ** ^Zero all [sqlite3_stmt_scanstatus()] related event counters.
|
|
jpayne@69
|
10322 **
|
|
jpayne@69
|
10323 ** This API is only available if the library is built with pre-processor
|
|
jpayne@69
|
10324 ** symbol [SQLITE_ENABLE_STMT_SCANSTATUS] defined.
|
|
jpayne@69
|
10325 */
|
|
jpayne@69
|
10326 SQLITE_API void sqlite3_stmt_scanstatus_reset(sqlite3_stmt*);
|
|
jpayne@69
|
10327
|
|
jpayne@69
|
10328 /*
|
|
jpayne@69
|
10329 ** CAPI3REF: Flush caches to disk mid-transaction
|
|
jpayne@69
|
10330 ** METHOD: sqlite3
|
|
jpayne@69
|
10331 **
|
|
jpayne@69
|
10332 ** ^If a write-transaction is open on [database connection] D when the
|
|
jpayne@69
|
10333 ** [sqlite3_db_cacheflush(D)] interface invoked, any dirty
|
|
jpayne@69
|
10334 ** pages in the pager-cache that are not currently in use are written out
|
|
jpayne@69
|
10335 ** to disk. A dirty page may be in use if a database cursor created by an
|
|
jpayne@69
|
10336 ** active SQL statement is reading from it, or if it is page 1 of a database
|
|
jpayne@69
|
10337 ** file (page 1 is always "in use"). ^The [sqlite3_db_cacheflush(D)]
|
|
jpayne@69
|
10338 ** interface flushes caches for all schemas - "main", "temp", and
|
|
jpayne@69
|
10339 ** any [attached] databases.
|
|
jpayne@69
|
10340 **
|
|
jpayne@69
|
10341 ** ^If this function needs to obtain extra database locks before dirty pages
|
|
jpayne@69
|
10342 ** can be flushed to disk, it does so. ^If those locks cannot be obtained
|
|
jpayne@69
|
10343 ** immediately and there is a busy-handler callback configured, it is invoked
|
|
jpayne@69
|
10344 ** in the usual manner. ^If the required lock still cannot be obtained, then
|
|
jpayne@69
|
10345 ** the database is skipped and an attempt made to flush any dirty pages
|
|
jpayne@69
|
10346 ** belonging to the next (if any) database. ^If any databases are skipped
|
|
jpayne@69
|
10347 ** because locks cannot be obtained, but no other error occurs, this
|
|
jpayne@69
|
10348 ** function returns SQLITE_BUSY.
|
|
jpayne@69
|
10349 **
|
|
jpayne@69
|
10350 ** ^If any other error occurs while flushing dirty pages to disk (for
|
|
jpayne@69
|
10351 ** example an IO error or out-of-memory condition), then processing is
|
|
jpayne@69
|
10352 ** abandoned and an SQLite [error code] is returned to the caller immediately.
|
|
jpayne@69
|
10353 **
|
|
jpayne@69
|
10354 ** ^Otherwise, if no error occurs, [sqlite3_db_cacheflush()] returns SQLITE_OK.
|
|
jpayne@69
|
10355 **
|
|
jpayne@69
|
10356 ** ^This function does not set the database handle error code or message
|
|
jpayne@69
|
10357 ** returned by the [sqlite3_errcode()] and [sqlite3_errmsg()] functions.
|
|
jpayne@69
|
10358 */
|
|
jpayne@69
|
10359 SQLITE_API int sqlite3_db_cacheflush(sqlite3*);
|
|
jpayne@69
|
10360
|
|
jpayne@69
|
10361 /*
|
|
jpayne@69
|
10362 ** CAPI3REF: The pre-update hook.
|
|
jpayne@69
|
10363 ** METHOD: sqlite3
|
|
jpayne@69
|
10364 **
|
|
jpayne@69
|
10365 ** ^These interfaces are only available if SQLite is compiled using the
|
|
jpayne@69
|
10366 ** [SQLITE_ENABLE_PREUPDATE_HOOK] compile-time option.
|
|
jpayne@69
|
10367 **
|
|
jpayne@69
|
10368 ** ^The [sqlite3_preupdate_hook()] interface registers a callback function
|
|
jpayne@69
|
10369 ** that is invoked prior to each [INSERT], [UPDATE], and [DELETE] operation
|
|
jpayne@69
|
10370 ** on a database table.
|
|
jpayne@69
|
10371 ** ^At most one preupdate hook may be registered at a time on a single
|
|
jpayne@69
|
10372 ** [database connection]; each call to [sqlite3_preupdate_hook()] overrides
|
|
jpayne@69
|
10373 ** the previous setting.
|
|
jpayne@69
|
10374 ** ^The preupdate hook is disabled by invoking [sqlite3_preupdate_hook()]
|
|
jpayne@69
|
10375 ** with a NULL pointer as the second parameter.
|
|
jpayne@69
|
10376 ** ^The third parameter to [sqlite3_preupdate_hook()] is passed through as
|
|
jpayne@69
|
10377 ** the first parameter to callbacks.
|
|
jpayne@69
|
10378 **
|
|
jpayne@69
|
10379 ** ^The preupdate hook only fires for changes to real database tables; the
|
|
jpayne@69
|
10380 ** preupdate hook is not invoked for changes to [virtual tables] or to
|
|
jpayne@69
|
10381 ** system tables like sqlite_sequence or sqlite_stat1.
|
|
jpayne@69
|
10382 **
|
|
jpayne@69
|
10383 ** ^The second parameter to the preupdate callback is a pointer to
|
|
jpayne@69
|
10384 ** the [database connection] that registered the preupdate hook.
|
|
jpayne@69
|
10385 ** ^The third parameter to the preupdate callback is one of the constants
|
|
jpayne@69
|
10386 ** [SQLITE_INSERT], [SQLITE_DELETE], or [SQLITE_UPDATE] to identify the
|
|
jpayne@69
|
10387 ** kind of update operation that is about to occur.
|
|
jpayne@69
|
10388 ** ^(The fourth parameter to the preupdate callback is the name of the
|
|
jpayne@69
|
10389 ** database within the database connection that is being modified. This
|
|
jpayne@69
|
10390 ** will be "main" for the main database or "temp" for TEMP tables or
|
|
jpayne@69
|
10391 ** the name given after the AS keyword in the [ATTACH] statement for attached
|
|
jpayne@69
|
10392 ** databases.)^
|
|
jpayne@69
|
10393 ** ^The fifth parameter to the preupdate callback is the name of the
|
|
jpayne@69
|
10394 ** table that is being modified.
|
|
jpayne@69
|
10395 **
|
|
jpayne@69
|
10396 ** For an UPDATE or DELETE operation on a [rowid table], the sixth
|
|
jpayne@69
|
10397 ** parameter passed to the preupdate callback is the initial [rowid] of the
|
|
jpayne@69
|
10398 ** row being modified or deleted. For an INSERT operation on a rowid table,
|
|
jpayne@69
|
10399 ** or any operation on a WITHOUT ROWID table, the value of the sixth
|
|
jpayne@69
|
10400 ** parameter is undefined. For an INSERT or UPDATE on a rowid table the
|
|
jpayne@69
|
10401 ** seventh parameter is the final rowid value of the row being inserted
|
|
jpayne@69
|
10402 ** or updated. The value of the seventh parameter passed to the callback
|
|
jpayne@69
|
10403 ** function is not defined for operations on WITHOUT ROWID tables, or for
|
|
jpayne@69
|
10404 ** DELETE operations on rowid tables.
|
|
jpayne@69
|
10405 **
|
|
jpayne@69
|
10406 ** ^The sqlite3_preupdate_hook(D,C,P) function returns the P argument from
|
|
jpayne@69
|
10407 ** the previous call on the same [database connection] D, or NULL for
|
|
jpayne@69
|
10408 ** the first call on D.
|
|
jpayne@69
|
10409 **
|
|
jpayne@69
|
10410 ** The [sqlite3_preupdate_old()], [sqlite3_preupdate_new()],
|
|
jpayne@69
|
10411 ** [sqlite3_preupdate_count()], and [sqlite3_preupdate_depth()] interfaces
|
|
jpayne@69
|
10412 ** provide additional information about a preupdate event. These routines
|
|
jpayne@69
|
10413 ** may only be called from within a preupdate callback. Invoking any of
|
|
jpayne@69
|
10414 ** these routines from outside of a preupdate callback or with a
|
|
jpayne@69
|
10415 ** [database connection] pointer that is different from the one supplied
|
|
jpayne@69
|
10416 ** to the preupdate callback results in undefined and probably undesirable
|
|
jpayne@69
|
10417 ** behavior.
|
|
jpayne@69
|
10418 **
|
|
jpayne@69
|
10419 ** ^The [sqlite3_preupdate_count(D)] interface returns the number of columns
|
|
jpayne@69
|
10420 ** in the row that is being inserted, updated, or deleted.
|
|
jpayne@69
|
10421 **
|
|
jpayne@69
|
10422 ** ^The [sqlite3_preupdate_old(D,N,P)] interface writes into P a pointer to
|
|
jpayne@69
|
10423 ** a [protected sqlite3_value] that contains the value of the Nth column of
|
|
jpayne@69
|
10424 ** the table row before it is updated. The N parameter must be between 0
|
|
jpayne@69
|
10425 ** and one less than the number of columns or the behavior will be
|
|
jpayne@69
|
10426 ** undefined. This must only be used within SQLITE_UPDATE and SQLITE_DELETE
|
|
jpayne@69
|
10427 ** preupdate callbacks; if it is used by an SQLITE_INSERT callback then the
|
|
jpayne@69
|
10428 ** behavior is undefined. The [sqlite3_value] that P points to
|
|
jpayne@69
|
10429 ** will be destroyed when the preupdate callback returns.
|
|
jpayne@69
|
10430 **
|
|
jpayne@69
|
10431 ** ^The [sqlite3_preupdate_new(D,N,P)] interface writes into P a pointer to
|
|
jpayne@69
|
10432 ** a [protected sqlite3_value] that contains the value of the Nth column of
|
|
jpayne@69
|
10433 ** the table row after it is updated. The N parameter must be between 0
|
|
jpayne@69
|
10434 ** and one less than the number of columns or the behavior will be
|
|
jpayne@69
|
10435 ** undefined. This must only be used within SQLITE_INSERT and SQLITE_UPDATE
|
|
jpayne@69
|
10436 ** preupdate callbacks; if it is used by an SQLITE_DELETE callback then the
|
|
jpayne@69
|
10437 ** behavior is undefined. The [sqlite3_value] that P points to
|
|
jpayne@69
|
10438 ** will be destroyed when the preupdate callback returns.
|
|
jpayne@69
|
10439 **
|
|
jpayne@69
|
10440 ** ^The [sqlite3_preupdate_depth(D)] interface returns 0 if the preupdate
|
|
jpayne@69
|
10441 ** callback was invoked as a result of a direct insert, update, or delete
|
|
jpayne@69
|
10442 ** operation; or 1 for inserts, updates, or deletes invoked by top-level
|
|
jpayne@69
|
10443 ** triggers; or 2 for changes resulting from triggers called by top-level
|
|
jpayne@69
|
10444 ** triggers; and so forth.
|
|
jpayne@69
|
10445 **
|
|
jpayne@69
|
10446 ** When the [sqlite3_blob_write()] API is used to update a blob column,
|
|
jpayne@69
|
10447 ** the pre-update hook is invoked with SQLITE_DELETE. This is because the
|
|
jpayne@69
|
10448 ** in this case the new values are not available. In this case, when a
|
|
jpayne@69
|
10449 ** callback made with op==SQLITE_DELETE is actually a write using the
|
|
jpayne@69
|
10450 ** sqlite3_blob_write() API, the [sqlite3_preupdate_blobwrite()] returns
|
|
jpayne@69
|
10451 ** the index of the column being written. In other cases, where the
|
|
jpayne@69
|
10452 ** pre-update hook is being invoked for some other reason, including a
|
|
jpayne@69
|
10453 ** regular DELETE, sqlite3_preupdate_blobwrite() returns -1.
|
|
jpayne@69
|
10454 **
|
|
jpayne@69
|
10455 ** See also: [sqlite3_update_hook()]
|
|
jpayne@69
|
10456 */
|
|
jpayne@69
|
10457 #if defined(SQLITE_ENABLE_PREUPDATE_HOOK)
|
|
jpayne@69
|
10458 SQLITE_API void *sqlite3_preupdate_hook(
|
|
jpayne@69
|
10459 sqlite3 *db,
|
|
jpayne@69
|
10460 void(*xPreUpdate)(
|
|
jpayne@69
|
10461 void *pCtx, /* Copy of third arg to preupdate_hook() */
|
|
jpayne@69
|
10462 sqlite3 *db, /* Database handle */
|
|
jpayne@69
|
10463 int op, /* SQLITE_UPDATE, DELETE or INSERT */
|
|
jpayne@69
|
10464 char const *zDb, /* Database name */
|
|
jpayne@69
|
10465 char const *zName, /* Table name */
|
|
jpayne@69
|
10466 sqlite3_int64 iKey1, /* Rowid of row about to be deleted/updated */
|
|
jpayne@69
|
10467 sqlite3_int64 iKey2 /* New rowid value (for a rowid UPDATE) */
|
|
jpayne@69
|
10468 ),
|
|
jpayne@69
|
10469 void*
|
|
jpayne@69
|
10470 );
|
|
jpayne@69
|
10471 SQLITE_API int sqlite3_preupdate_old(sqlite3 *, int, sqlite3_value **);
|
|
jpayne@69
|
10472 SQLITE_API int sqlite3_preupdate_count(sqlite3 *);
|
|
jpayne@69
|
10473 SQLITE_API int sqlite3_preupdate_depth(sqlite3 *);
|
|
jpayne@69
|
10474 SQLITE_API int sqlite3_preupdate_new(sqlite3 *, int, sqlite3_value **);
|
|
jpayne@69
|
10475 SQLITE_API int sqlite3_preupdate_blobwrite(sqlite3 *);
|
|
jpayne@69
|
10476 #endif
|
|
jpayne@69
|
10477
|
|
jpayne@69
|
10478 /*
|
|
jpayne@69
|
10479 ** CAPI3REF: Low-level system error code
|
|
jpayne@69
|
10480 ** METHOD: sqlite3
|
|
jpayne@69
|
10481 **
|
|
jpayne@69
|
10482 ** ^Attempt to return the underlying operating system error code or error
|
|
jpayne@69
|
10483 ** number that caused the most recent I/O error or failure to open a file.
|
|
jpayne@69
|
10484 ** The return value is OS-dependent. For example, on unix systems, after
|
|
jpayne@69
|
10485 ** [sqlite3_open_v2()] returns [SQLITE_CANTOPEN], this interface could be
|
|
jpayne@69
|
10486 ** called to get back the underlying "errno" that caused the problem, such
|
|
jpayne@69
|
10487 ** as ENOSPC, EAUTH, EISDIR, and so forth.
|
|
jpayne@69
|
10488 */
|
|
jpayne@69
|
10489 SQLITE_API int sqlite3_system_errno(sqlite3*);
|
|
jpayne@69
|
10490
|
|
jpayne@69
|
10491 /*
|
|
jpayne@69
|
10492 ** CAPI3REF: Database Snapshot
|
|
jpayne@69
|
10493 ** KEYWORDS: {snapshot} {sqlite3_snapshot}
|
|
jpayne@69
|
10494 **
|
|
jpayne@69
|
10495 ** An instance of the snapshot object records the state of a [WAL mode]
|
|
jpayne@69
|
10496 ** database for some specific point in history.
|
|
jpayne@69
|
10497 **
|
|
jpayne@69
|
10498 ** In [WAL mode], multiple [database connections] that are open on the
|
|
jpayne@69
|
10499 ** same database file can each be reading a different historical version
|
|
jpayne@69
|
10500 ** of the database file. When a [database connection] begins a read
|
|
jpayne@69
|
10501 ** transaction, that connection sees an unchanging copy of the database
|
|
jpayne@69
|
10502 ** as it existed for the point in time when the transaction first started.
|
|
jpayne@69
|
10503 ** Subsequent changes to the database from other connections are not seen
|
|
jpayne@69
|
10504 ** by the reader until a new read transaction is started.
|
|
jpayne@69
|
10505 **
|
|
jpayne@69
|
10506 ** The sqlite3_snapshot object records state information about an historical
|
|
jpayne@69
|
10507 ** version of the database file so that it is possible to later open a new read
|
|
jpayne@69
|
10508 ** transaction that sees that historical version of the database rather than
|
|
jpayne@69
|
10509 ** the most recent version.
|
|
jpayne@69
|
10510 */
|
|
jpayne@69
|
10511 typedef struct sqlite3_snapshot {
|
|
jpayne@69
|
10512 unsigned char hidden[48];
|
|
jpayne@69
|
10513 } sqlite3_snapshot;
|
|
jpayne@69
|
10514
|
|
jpayne@69
|
10515 /*
|
|
jpayne@69
|
10516 ** CAPI3REF: Record A Database Snapshot
|
|
jpayne@69
|
10517 ** CONSTRUCTOR: sqlite3_snapshot
|
|
jpayne@69
|
10518 **
|
|
jpayne@69
|
10519 ** ^The [sqlite3_snapshot_get(D,S,P)] interface attempts to make a
|
|
jpayne@69
|
10520 ** new [sqlite3_snapshot] object that records the current state of
|
|
jpayne@69
|
10521 ** schema S in database connection D. ^On success, the
|
|
jpayne@69
|
10522 ** [sqlite3_snapshot_get(D,S,P)] interface writes a pointer to the newly
|
|
jpayne@69
|
10523 ** created [sqlite3_snapshot] object into *P and returns SQLITE_OK.
|
|
jpayne@69
|
10524 ** If there is not already a read-transaction open on schema S when
|
|
jpayne@69
|
10525 ** this function is called, one is opened automatically.
|
|
jpayne@69
|
10526 **
|
|
jpayne@69
|
10527 ** The following must be true for this function to succeed. If any of
|
|
jpayne@69
|
10528 ** the following statements are false when sqlite3_snapshot_get() is
|
|
jpayne@69
|
10529 ** called, SQLITE_ERROR is returned. The final value of *P is undefined
|
|
jpayne@69
|
10530 ** in this case.
|
|
jpayne@69
|
10531 **
|
|
jpayne@69
|
10532 ** <ul>
|
|
jpayne@69
|
10533 ** <li> The database handle must not be in [autocommit mode].
|
|
jpayne@69
|
10534 **
|
|
jpayne@69
|
10535 ** <li> Schema S of [database connection] D must be a [WAL mode] database.
|
|
jpayne@69
|
10536 **
|
|
jpayne@69
|
10537 ** <li> There must not be a write transaction open on schema S of database
|
|
jpayne@69
|
10538 ** connection D.
|
|
jpayne@69
|
10539 **
|
|
jpayne@69
|
10540 ** <li> One or more transactions must have been written to the current wal
|
|
jpayne@69
|
10541 ** file since it was created on disk (by any connection). This means
|
|
jpayne@69
|
10542 ** that a snapshot cannot be taken on a wal mode database with no wal
|
|
jpayne@69
|
10543 ** file immediately after it is first opened. At least one transaction
|
|
jpayne@69
|
10544 ** must be written to it first.
|
|
jpayne@69
|
10545 ** </ul>
|
|
jpayne@69
|
10546 **
|
|
jpayne@69
|
10547 ** This function may also return SQLITE_NOMEM. If it is called with the
|
|
jpayne@69
|
10548 ** database handle in autocommit mode but fails for some other reason,
|
|
jpayne@69
|
10549 ** whether or not a read transaction is opened on schema S is undefined.
|
|
jpayne@69
|
10550 **
|
|
jpayne@69
|
10551 ** The [sqlite3_snapshot] object returned from a successful call to
|
|
jpayne@69
|
10552 ** [sqlite3_snapshot_get()] must be freed using [sqlite3_snapshot_free()]
|
|
jpayne@69
|
10553 ** to avoid a memory leak.
|
|
jpayne@69
|
10554 **
|
|
jpayne@69
|
10555 ** The [sqlite3_snapshot_get()] interface is only available when the
|
|
jpayne@69
|
10556 ** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used.
|
|
jpayne@69
|
10557 */
|
|
jpayne@69
|
10558 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_get(
|
|
jpayne@69
|
10559 sqlite3 *db,
|
|
jpayne@69
|
10560 const char *zSchema,
|
|
jpayne@69
|
10561 sqlite3_snapshot **ppSnapshot
|
|
jpayne@69
|
10562 );
|
|
jpayne@69
|
10563
|
|
jpayne@69
|
10564 /*
|
|
jpayne@69
|
10565 ** CAPI3REF: Start a read transaction on an historical snapshot
|
|
jpayne@69
|
10566 ** METHOD: sqlite3_snapshot
|
|
jpayne@69
|
10567 **
|
|
jpayne@69
|
10568 ** ^The [sqlite3_snapshot_open(D,S,P)] interface either starts a new read
|
|
jpayne@69
|
10569 ** transaction or upgrades an existing one for schema S of
|
|
jpayne@69
|
10570 ** [database connection] D such that the read transaction refers to
|
|
jpayne@69
|
10571 ** historical [snapshot] P, rather than the most recent change to the
|
|
jpayne@69
|
10572 ** database. ^The [sqlite3_snapshot_open()] interface returns SQLITE_OK
|
|
jpayne@69
|
10573 ** on success or an appropriate [error code] if it fails.
|
|
jpayne@69
|
10574 **
|
|
jpayne@69
|
10575 ** ^In order to succeed, the database connection must not be in
|
|
jpayne@69
|
10576 ** [autocommit mode] when [sqlite3_snapshot_open(D,S,P)] is called. If there
|
|
jpayne@69
|
10577 ** is already a read transaction open on schema S, then the database handle
|
|
jpayne@69
|
10578 ** must have no active statements (SELECT statements that have been passed
|
|
jpayne@69
|
10579 ** to sqlite3_step() but not sqlite3_reset() or sqlite3_finalize()).
|
|
jpayne@69
|
10580 ** SQLITE_ERROR is returned if either of these conditions is violated, or
|
|
jpayne@69
|
10581 ** if schema S does not exist, or if the snapshot object is invalid.
|
|
jpayne@69
|
10582 **
|
|
jpayne@69
|
10583 ** ^A call to sqlite3_snapshot_open() will fail to open if the specified
|
|
jpayne@69
|
10584 ** snapshot has been overwritten by a [checkpoint]. In this case
|
|
jpayne@69
|
10585 ** SQLITE_ERROR_SNAPSHOT is returned.
|
|
jpayne@69
|
10586 **
|
|
jpayne@69
|
10587 ** If there is already a read transaction open when this function is
|
|
jpayne@69
|
10588 ** invoked, then the same read transaction remains open (on the same
|
|
jpayne@69
|
10589 ** database snapshot) if SQLITE_ERROR, SQLITE_BUSY or SQLITE_ERROR_SNAPSHOT
|
|
jpayne@69
|
10590 ** is returned. If another error code - for example SQLITE_PROTOCOL or an
|
|
jpayne@69
|
10591 ** SQLITE_IOERR error code - is returned, then the final state of the
|
|
jpayne@69
|
10592 ** read transaction is undefined. If SQLITE_OK is returned, then the
|
|
jpayne@69
|
10593 ** read transaction is now open on database snapshot P.
|
|
jpayne@69
|
10594 **
|
|
jpayne@69
|
10595 ** ^(A call to [sqlite3_snapshot_open(D,S,P)] will fail if the
|
|
jpayne@69
|
10596 ** database connection D does not know that the database file for
|
|
jpayne@69
|
10597 ** schema S is in [WAL mode]. A database connection might not know
|
|
jpayne@69
|
10598 ** that the database file is in [WAL mode] if there has been no prior
|
|
jpayne@69
|
10599 ** I/O on that database connection, or if the database entered [WAL mode]
|
|
jpayne@69
|
10600 ** after the most recent I/O on the database connection.)^
|
|
jpayne@69
|
10601 ** (Hint: Run "[PRAGMA application_id]" against a newly opened
|
|
jpayne@69
|
10602 ** database connection in order to make it ready to use snapshots.)
|
|
jpayne@69
|
10603 **
|
|
jpayne@69
|
10604 ** The [sqlite3_snapshot_open()] interface is only available when the
|
|
jpayne@69
|
10605 ** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used.
|
|
jpayne@69
|
10606 */
|
|
jpayne@69
|
10607 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_open(
|
|
jpayne@69
|
10608 sqlite3 *db,
|
|
jpayne@69
|
10609 const char *zSchema,
|
|
jpayne@69
|
10610 sqlite3_snapshot *pSnapshot
|
|
jpayne@69
|
10611 );
|
|
jpayne@69
|
10612
|
|
jpayne@69
|
10613 /*
|
|
jpayne@69
|
10614 ** CAPI3REF: Destroy a snapshot
|
|
jpayne@69
|
10615 ** DESTRUCTOR: sqlite3_snapshot
|
|
jpayne@69
|
10616 **
|
|
jpayne@69
|
10617 ** ^The [sqlite3_snapshot_free(P)] interface destroys [sqlite3_snapshot] P.
|
|
jpayne@69
|
10618 ** The application must eventually free every [sqlite3_snapshot] object
|
|
jpayne@69
|
10619 ** using this routine to avoid a memory leak.
|
|
jpayne@69
|
10620 **
|
|
jpayne@69
|
10621 ** The [sqlite3_snapshot_free()] interface is only available when the
|
|
jpayne@69
|
10622 ** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used.
|
|
jpayne@69
|
10623 */
|
|
jpayne@69
|
10624 SQLITE_API SQLITE_EXPERIMENTAL void sqlite3_snapshot_free(sqlite3_snapshot*);
|
|
jpayne@69
|
10625
|
|
jpayne@69
|
10626 /*
|
|
jpayne@69
|
10627 ** CAPI3REF: Compare the ages of two snapshot handles.
|
|
jpayne@69
|
10628 ** METHOD: sqlite3_snapshot
|
|
jpayne@69
|
10629 **
|
|
jpayne@69
|
10630 ** The sqlite3_snapshot_cmp(P1, P2) interface is used to compare the ages
|
|
jpayne@69
|
10631 ** of two valid snapshot handles.
|
|
jpayne@69
|
10632 **
|
|
jpayne@69
|
10633 ** If the two snapshot handles are not associated with the same database
|
|
jpayne@69
|
10634 ** file, the result of the comparison is undefined.
|
|
jpayne@69
|
10635 **
|
|
jpayne@69
|
10636 ** Additionally, the result of the comparison is only valid if both of the
|
|
jpayne@69
|
10637 ** snapshot handles were obtained by calling sqlite3_snapshot_get() since the
|
|
jpayne@69
|
10638 ** last time the wal file was deleted. The wal file is deleted when the
|
|
jpayne@69
|
10639 ** database is changed back to rollback mode or when the number of database
|
|
jpayne@69
|
10640 ** clients drops to zero. If either snapshot handle was obtained before the
|
|
jpayne@69
|
10641 ** wal file was last deleted, the value returned by this function
|
|
jpayne@69
|
10642 ** is undefined.
|
|
jpayne@69
|
10643 **
|
|
jpayne@69
|
10644 ** Otherwise, this API returns a negative value if P1 refers to an older
|
|
jpayne@69
|
10645 ** snapshot than P2, zero if the two handles refer to the same database
|
|
jpayne@69
|
10646 ** snapshot, and a positive value if P1 is a newer snapshot than P2.
|
|
jpayne@69
|
10647 **
|
|
jpayne@69
|
10648 ** This interface is only available if SQLite is compiled with the
|
|
jpayne@69
|
10649 ** [SQLITE_ENABLE_SNAPSHOT] option.
|
|
jpayne@69
|
10650 */
|
|
jpayne@69
|
10651 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_cmp(
|
|
jpayne@69
|
10652 sqlite3_snapshot *p1,
|
|
jpayne@69
|
10653 sqlite3_snapshot *p2
|
|
jpayne@69
|
10654 );
|
|
jpayne@69
|
10655
|
|
jpayne@69
|
10656 /*
|
|
jpayne@69
|
10657 ** CAPI3REF: Recover snapshots from a wal file
|
|
jpayne@69
|
10658 ** METHOD: sqlite3_snapshot
|
|
jpayne@69
|
10659 **
|
|
jpayne@69
|
10660 ** If a [WAL file] remains on disk after all database connections close
|
|
jpayne@69
|
10661 ** (either through the use of the [SQLITE_FCNTL_PERSIST_WAL] [file control]
|
|
jpayne@69
|
10662 ** or because the last process to have the database opened exited without
|
|
jpayne@69
|
10663 ** calling [sqlite3_close()]) and a new connection is subsequently opened
|
|
jpayne@69
|
10664 ** on that database and [WAL file], the [sqlite3_snapshot_open()] interface
|
|
jpayne@69
|
10665 ** will only be able to open the last transaction added to the WAL file
|
|
jpayne@69
|
10666 ** even though the WAL file contains other valid transactions.
|
|
jpayne@69
|
10667 **
|
|
jpayne@69
|
10668 ** This function attempts to scan the WAL file associated with database zDb
|
|
jpayne@69
|
10669 ** of database handle db and make all valid snapshots available to
|
|
jpayne@69
|
10670 ** sqlite3_snapshot_open(). It is an error if there is already a read
|
|
jpayne@69
|
10671 ** transaction open on the database, or if the database is not a WAL mode
|
|
jpayne@69
|
10672 ** database.
|
|
jpayne@69
|
10673 **
|
|
jpayne@69
|
10674 ** SQLITE_OK is returned if successful, or an SQLite error code otherwise.
|
|
jpayne@69
|
10675 **
|
|
jpayne@69
|
10676 ** This interface is only available if SQLite is compiled with the
|
|
jpayne@69
|
10677 ** [SQLITE_ENABLE_SNAPSHOT] option.
|
|
jpayne@69
|
10678 */
|
|
jpayne@69
|
10679 SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_recover(sqlite3 *db, const char *zDb);
|
|
jpayne@69
|
10680
|
|
jpayne@69
|
10681 /*
|
|
jpayne@69
|
10682 ** CAPI3REF: Serialize a database
|
|
jpayne@69
|
10683 **
|
|
jpayne@69
|
10684 ** The sqlite3_serialize(D,S,P,F) interface returns a pointer to memory
|
|
jpayne@69
|
10685 ** that is a serialization of the S database on [database connection] D.
|
|
jpayne@69
|
10686 ** If P is not a NULL pointer, then the size of the database in bytes
|
|
jpayne@69
|
10687 ** is written into *P.
|
|
jpayne@69
|
10688 **
|
|
jpayne@69
|
10689 ** For an ordinary on-disk database file, the serialization is just a
|
|
jpayne@69
|
10690 ** copy of the disk file. For an in-memory database or a "TEMP" database,
|
|
jpayne@69
|
10691 ** the serialization is the same sequence of bytes which would be written
|
|
jpayne@69
|
10692 ** to disk if that database where backed up to disk.
|
|
jpayne@69
|
10693 **
|
|
jpayne@69
|
10694 ** The usual case is that sqlite3_serialize() copies the serialization of
|
|
jpayne@69
|
10695 ** the database into memory obtained from [sqlite3_malloc64()] and returns
|
|
jpayne@69
|
10696 ** a pointer to that memory. The caller is responsible for freeing the
|
|
jpayne@69
|
10697 ** returned value to avoid a memory leak. However, if the F argument
|
|
jpayne@69
|
10698 ** contains the SQLITE_SERIALIZE_NOCOPY bit, then no memory allocations
|
|
jpayne@69
|
10699 ** are made, and the sqlite3_serialize() function will return a pointer
|
|
jpayne@69
|
10700 ** to the contiguous memory representation of the database that SQLite
|
|
jpayne@69
|
10701 ** is currently using for that database, or NULL if the no such contiguous
|
|
jpayne@69
|
10702 ** memory representation of the database exists. A contiguous memory
|
|
jpayne@69
|
10703 ** representation of the database will usually only exist if there has
|
|
jpayne@69
|
10704 ** been a prior call to [sqlite3_deserialize(D,S,...)] with the same
|
|
jpayne@69
|
10705 ** values of D and S.
|
|
jpayne@69
|
10706 ** The size of the database is written into *P even if the
|
|
jpayne@69
|
10707 ** SQLITE_SERIALIZE_NOCOPY bit is set but no contiguous copy
|
|
jpayne@69
|
10708 ** of the database exists.
|
|
jpayne@69
|
10709 **
|
|
jpayne@69
|
10710 ** After the call, if the SQLITE_SERIALIZE_NOCOPY bit had been set,
|
|
jpayne@69
|
10711 ** the returned buffer content will remain accessible and unchanged
|
|
jpayne@69
|
10712 ** until either the next write operation on the connection or when
|
|
jpayne@69
|
10713 ** the connection is closed, and applications must not modify the
|
|
jpayne@69
|
10714 ** buffer. If the bit had been clear, the returned buffer will not
|
|
jpayne@69
|
10715 ** be accessed by SQLite after the call.
|
|
jpayne@69
|
10716 **
|
|
jpayne@69
|
10717 ** A call to sqlite3_serialize(D,S,P,F) might return NULL even if the
|
|
jpayne@69
|
10718 ** SQLITE_SERIALIZE_NOCOPY bit is omitted from argument F if a memory
|
|
jpayne@69
|
10719 ** allocation error occurs.
|
|
jpayne@69
|
10720 **
|
|
jpayne@69
|
10721 ** This interface is omitted if SQLite is compiled with the
|
|
jpayne@69
|
10722 ** [SQLITE_OMIT_DESERIALIZE] option.
|
|
jpayne@69
|
10723 */
|
|
jpayne@69
|
10724 SQLITE_API unsigned char *sqlite3_serialize(
|
|
jpayne@69
|
10725 sqlite3 *db, /* The database connection */
|
|
jpayne@69
|
10726 const char *zSchema, /* Which DB to serialize. ex: "main", "temp", ... */
|
|
jpayne@69
|
10727 sqlite3_int64 *piSize, /* Write size of the DB here, if not NULL */
|
|
jpayne@69
|
10728 unsigned int mFlags /* Zero or more SQLITE_SERIALIZE_* flags */
|
|
jpayne@69
|
10729 );
|
|
jpayne@69
|
10730
|
|
jpayne@69
|
10731 /*
|
|
jpayne@69
|
10732 ** CAPI3REF: Flags for sqlite3_serialize
|
|
jpayne@69
|
10733 **
|
|
jpayne@69
|
10734 ** Zero or more of the following constants can be OR-ed together for
|
|
jpayne@69
|
10735 ** the F argument to [sqlite3_serialize(D,S,P,F)].
|
|
jpayne@69
|
10736 **
|
|
jpayne@69
|
10737 ** SQLITE_SERIALIZE_NOCOPY means that [sqlite3_serialize()] will return
|
|
jpayne@69
|
10738 ** a pointer to contiguous in-memory database that it is currently using,
|
|
jpayne@69
|
10739 ** without making a copy of the database. If SQLite is not currently using
|
|
jpayne@69
|
10740 ** a contiguous in-memory database, then this option causes
|
|
jpayne@69
|
10741 ** [sqlite3_serialize()] to return a NULL pointer. SQLite will only be
|
|
jpayne@69
|
10742 ** using a contiguous in-memory database if it has been initialized by a
|
|
jpayne@69
|
10743 ** prior call to [sqlite3_deserialize()].
|
|
jpayne@69
|
10744 */
|
|
jpayne@69
|
10745 #define SQLITE_SERIALIZE_NOCOPY 0x001 /* Do no memory allocations */
|
|
jpayne@69
|
10746
|
|
jpayne@69
|
10747 /*
|
|
jpayne@69
|
10748 ** CAPI3REF: Deserialize a database
|
|
jpayne@69
|
10749 **
|
|
jpayne@69
|
10750 ** The sqlite3_deserialize(D,S,P,N,M,F) interface causes the
|
|
jpayne@69
|
10751 ** [database connection] D to disconnect from database S and then
|
|
jpayne@69
|
10752 ** reopen S as an in-memory database based on the serialization contained
|
|
jpayne@69
|
10753 ** in P. The serialized database P is N bytes in size. M is the size of
|
|
jpayne@69
|
10754 ** the buffer P, which might be larger than N. If M is larger than N, and
|
|
jpayne@69
|
10755 ** the SQLITE_DESERIALIZE_READONLY bit is not set in F, then SQLite is
|
|
jpayne@69
|
10756 ** permitted to add content to the in-memory database as long as the total
|
|
jpayne@69
|
10757 ** size does not exceed M bytes.
|
|
jpayne@69
|
10758 **
|
|
jpayne@69
|
10759 ** If the SQLITE_DESERIALIZE_FREEONCLOSE bit is set in F, then SQLite will
|
|
jpayne@69
|
10760 ** invoke sqlite3_free() on the serialization buffer when the database
|
|
jpayne@69
|
10761 ** connection closes. If the SQLITE_DESERIALIZE_RESIZEABLE bit is set, then
|
|
jpayne@69
|
10762 ** SQLite will try to increase the buffer size using sqlite3_realloc64()
|
|
jpayne@69
|
10763 ** if writes on the database cause it to grow larger than M bytes.
|
|
jpayne@69
|
10764 **
|
|
jpayne@69
|
10765 ** Applications must not modify the buffer P or invalidate it before
|
|
jpayne@69
|
10766 ** the database connection D is closed.
|
|
jpayne@69
|
10767 **
|
|
jpayne@69
|
10768 ** The sqlite3_deserialize() interface will fail with SQLITE_BUSY if the
|
|
jpayne@69
|
10769 ** database is currently in a read transaction or is involved in a backup
|
|
jpayne@69
|
10770 ** operation.
|
|
jpayne@69
|
10771 **
|
|
jpayne@69
|
10772 ** It is not possible to deserialized into the TEMP database. If the
|
|
jpayne@69
|
10773 ** S argument to sqlite3_deserialize(D,S,P,N,M,F) is "temp" then the
|
|
jpayne@69
|
10774 ** function returns SQLITE_ERROR.
|
|
jpayne@69
|
10775 **
|
|
jpayne@69
|
10776 ** The deserialized database should not be in [WAL mode]. If the database
|
|
jpayne@69
|
10777 ** is in WAL mode, then any attempt to use the database file will result
|
|
jpayne@69
|
10778 ** in an [SQLITE_CANTOPEN] error. The application can set the
|
|
jpayne@69
|
10779 ** [file format version numbers] (bytes 18 and 19) of the input database P
|
|
jpayne@69
|
10780 ** to 0x01 prior to invoking sqlite3_deserialize(D,S,P,N,M,F) to force the
|
|
jpayne@69
|
10781 ** database file into rollback mode and work around this limitation.
|
|
jpayne@69
|
10782 **
|
|
jpayne@69
|
10783 ** If sqlite3_deserialize(D,S,P,N,M,F) fails for any reason and if the
|
|
jpayne@69
|
10784 ** SQLITE_DESERIALIZE_FREEONCLOSE bit is set in argument F, then
|
|
jpayne@69
|
10785 ** [sqlite3_free()] is invoked on argument P prior to returning.
|
|
jpayne@69
|
10786 **
|
|
jpayne@69
|
10787 ** This interface is omitted if SQLite is compiled with the
|
|
jpayne@69
|
10788 ** [SQLITE_OMIT_DESERIALIZE] option.
|
|
jpayne@69
|
10789 */
|
|
jpayne@69
|
10790 SQLITE_API int sqlite3_deserialize(
|
|
jpayne@69
|
10791 sqlite3 *db, /* The database connection */
|
|
jpayne@69
|
10792 const char *zSchema, /* Which DB to reopen with the deserialization */
|
|
jpayne@69
|
10793 unsigned char *pData, /* The serialized database content */
|
|
jpayne@69
|
10794 sqlite3_int64 szDb, /* Number bytes in the deserialization */
|
|
jpayne@69
|
10795 sqlite3_int64 szBuf, /* Total size of buffer pData[] */
|
|
jpayne@69
|
10796 unsigned mFlags /* Zero or more SQLITE_DESERIALIZE_* flags */
|
|
jpayne@69
|
10797 );
|
|
jpayne@69
|
10798
|
|
jpayne@69
|
10799 /*
|
|
jpayne@69
|
10800 ** CAPI3REF: Flags for sqlite3_deserialize()
|
|
jpayne@69
|
10801 **
|
|
jpayne@69
|
10802 ** The following are allowed values for 6th argument (the F argument) to
|
|
jpayne@69
|
10803 ** the [sqlite3_deserialize(D,S,P,N,M,F)] interface.
|
|
jpayne@69
|
10804 **
|
|
jpayne@69
|
10805 ** The SQLITE_DESERIALIZE_FREEONCLOSE means that the database serialization
|
|
jpayne@69
|
10806 ** in the P argument is held in memory obtained from [sqlite3_malloc64()]
|
|
jpayne@69
|
10807 ** and that SQLite should take ownership of this memory and automatically
|
|
jpayne@69
|
10808 ** free it when it has finished using it. Without this flag, the caller
|
|
jpayne@69
|
10809 ** is responsible for freeing any dynamically allocated memory.
|
|
jpayne@69
|
10810 **
|
|
jpayne@69
|
10811 ** The SQLITE_DESERIALIZE_RESIZEABLE flag means that SQLite is allowed to
|
|
jpayne@69
|
10812 ** grow the size of the database using calls to [sqlite3_realloc64()]. This
|
|
jpayne@69
|
10813 ** flag should only be used if SQLITE_DESERIALIZE_FREEONCLOSE is also used.
|
|
jpayne@69
|
10814 ** Without this flag, the deserialized database cannot increase in size beyond
|
|
jpayne@69
|
10815 ** the number of bytes specified by the M parameter.
|
|
jpayne@69
|
10816 **
|
|
jpayne@69
|
10817 ** The SQLITE_DESERIALIZE_READONLY flag means that the deserialized database
|
|
jpayne@69
|
10818 ** should be treated as read-only.
|
|
jpayne@69
|
10819 */
|
|
jpayne@69
|
10820 #define SQLITE_DESERIALIZE_FREEONCLOSE 1 /* Call sqlite3_free() on close */
|
|
jpayne@69
|
10821 #define SQLITE_DESERIALIZE_RESIZEABLE 2 /* Resize using sqlite3_realloc64() */
|
|
jpayne@69
|
10822 #define SQLITE_DESERIALIZE_READONLY 4 /* Database is read-only */
|
|
jpayne@69
|
10823
|
|
jpayne@69
|
10824 /*
|
|
jpayne@69
|
10825 ** Undo the hack that converts floating point types to integer for
|
|
jpayne@69
|
10826 ** builds on processors without floating point support.
|
|
jpayne@69
|
10827 */
|
|
jpayne@69
|
10828 #ifdef SQLITE_OMIT_FLOATING_POINT
|
|
jpayne@69
|
10829 # undef double
|
|
jpayne@69
|
10830 #endif
|
|
jpayne@69
|
10831
|
|
jpayne@69
|
10832 #if defined(__wasi__)
|
|
jpayne@69
|
10833 # undef SQLITE_WASI
|
|
jpayne@69
|
10834 # define SQLITE_WASI 1
|
|
jpayne@69
|
10835 # undef SQLITE_OMIT_WAL
|
|
jpayne@69
|
10836 # define SQLITE_OMIT_WAL 1/* because it requires shared memory APIs */
|
|
jpayne@69
|
10837 # ifndef SQLITE_OMIT_LOAD_EXTENSION
|
|
jpayne@69
|
10838 # define SQLITE_OMIT_LOAD_EXTENSION
|
|
jpayne@69
|
10839 # endif
|
|
jpayne@69
|
10840 # ifndef SQLITE_THREADSAFE
|
|
jpayne@69
|
10841 # define SQLITE_THREADSAFE 0
|
|
jpayne@69
|
10842 # endif
|
|
jpayne@69
|
10843 #endif
|
|
jpayne@69
|
10844
|
|
jpayne@69
|
10845 #ifdef __cplusplus
|
|
jpayne@69
|
10846 } /* End of the 'extern "C"' block */
|
|
jpayne@69
|
10847 #endif
|
|
jpayne@69
|
10848 #endif /* SQLITE3_H */
|
|
jpayne@69
|
10849
|
|
jpayne@69
|
10850 /******** Begin file sqlite3rtree.h *********/
|
|
jpayne@69
|
10851 /*
|
|
jpayne@69
|
10852 ** 2010 August 30
|
|
jpayne@69
|
10853 **
|
|
jpayne@69
|
10854 ** The author disclaims copyright to this source code. In place of
|
|
jpayne@69
|
10855 ** a legal notice, here is a blessing:
|
|
jpayne@69
|
10856 **
|
|
jpayne@69
|
10857 ** May you do good and not evil.
|
|
jpayne@69
|
10858 ** May you find forgiveness for yourself and forgive others.
|
|
jpayne@69
|
10859 ** May you share freely, never taking more than you give.
|
|
jpayne@69
|
10860 **
|
|
jpayne@69
|
10861 *************************************************************************
|
|
jpayne@69
|
10862 */
|
|
jpayne@69
|
10863
|
|
jpayne@69
|
10864 #ifndef _SQLITE3RTREE_H_
|
|
jpayne@69
|
10865 #define _SQLITE3RTREE_H_
|
|
jpayne@69
|
10866
|
|
jpayne@69
|
10867
|
|
jpayne@69
|
10868 #ifdef __cplusplus
|
|
jpayne@69
|
10869 extern "C" {
|
|
jpayne@69
|
10870 #endif
|
|
jpayne@69
|
10871
|
|
jpayne@69
|
10872 typedef struct sqlite3_rtree_geometry sqlite3_rtree_geometry;
|
|
jpayne@69
|
10873 typedef struct sqlite3_rtree_query_info sqlite3_rtree_query_info;
|
|
jpayne@69
|
10874
|
|
jpayne@69
|
10875 /* The double-precision datatype used by RTree depends on the
|
|
jpayne@69
|
10876 ** SQLITE_RTREE_INT_ONLY compile-time option.
|
|
jpayne@69
|
10877 */
|
|
jpayne@69
|
10878 #ifdef SQLITE_RTREE_INT_ONLY
|
|
jpayne@69
|
10879 typedef sqlite3_int64 sqlite3_rtree_dbl;
|
|
jpayne@69
|
10880 #else
|
|
jpayne@69
|
10881 typedef double sqlite3_rtree_dbl;
|
|
jpayne@69
|
10882 #endif
|
|
jpayne@69
|
10883
|
|
jpayne@69
|
10884 /*
|
|
jpayne@69
|
10885 ** Register a geometry callback named zGeom that can be used as part of an
|
|
jpayne@69
|
10886 ** R-Tree geometry query as follows:
|
|
jpayne@69
|
10887 **
|
|
jpayne@69
|
10888 ** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zGeom(... params ...)
|
|
jpayne@69
|
10889 */
|
|
jpayne@69
|
10890 SQLITE_API int sqlite3_rtree_geometry_callback(
|
|
jpayne@69
|
10891 sqlite3 *db,
|
|
jpayne@69
|
10892 const char *zGeom,
|
|
jpayne@69
|
10893 int (*xGeom)(sqlite3_rtree_geometry*, int, sqlite3_rtree_dbl*,int*),
|
|
jpayne@69
|
10894 void *pContext
|
|
jpayne@69
|
10895 );
|
|
jpayne@69
|
10896
|
|
jpayne@69
|
10897
|
|
jpayne@69
|
10898 /*
|
|
jpayne@69
|
10899 ** A pointer to a structure of the following type is passed as the first
|
|
jpayne@69
|
10900 ** argument to callbacks registered using rtree_geometry_callback().
|
|
jpayne@69
|
10901 */
|
|
jpayne@69
|
10902 struct sqlite3_rtree_geometry {
|
|
jpayne@69
|
10903 void *pContext; /* Copy of pContext passed to s_r_g_c() */
|
|
jpayne@69
|
10904 int nParam; /* Size of array aParam[] */
|
|
jpayne@69
|
10905 sqlite3_rtree_dbl *aParam; /* Parameters passed to SQL geom function */
|
|
jpayne@69
|
10906 void *pUser; /* Callback implementation user data */
|
|
jpayne@69
|
10907 void (*xDelUser)(void *); /* Called by SQLite to clean up pUser */
|
|
jpayne@69
|
10908 };
|
|
jpayne@69
|
10909
|
|
jpayne@69
|
10910 /*
|
|
jpayne@69
|
10911 ** Register a 2nd-generation geometry callback named zScore that can be
|
|
jpayne@69
|
10912 ** used as part of an R-Tree geometry query as follows:
|
|
jpayne@69
|
10913 **
|
|
jpayne@69
|
10914 ** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zQueryFunc(... params ...)
|
|
jpayne@69
|
10915 */
|
|
jpayne@69
|
10916 SQLITE_API int sqlite3_rtree_query_callback(
|
|
jpayne@69
|
10917 sqlite3 *db,
|
|
jpayne@69
|
10918 const char *zQueryFunc,
|
|
jpayne@69
|
10919 int (*xQueryFunc)(sqlite3_rtree_query_info*),
|
|
jpayne@69
|
10920 void *pContext,
|
|
jpayne@69
|
10921 void (*xDestructor)(void*)
|
|
jpayne@69
|
10922 );
|
|
jpayne@69
|
10923
|
|
jpayne@69
|
10924
|
|
jpayne@69
|
10925 /*
|
|
jpayne@69
|
10926 ** A pointer to a structure of the following type is passed as the
|
|
jpayne@69
|
10927 ** argument to scored geometry callback registered using
|
|
jpayne@69
|
10928 ** sqlite3_rtree_query_callback().
|
|
jpayne@69
|
10929 **
|
|
jpayne@69
|
10930 ** Note that the first 5 fields of this structure are identical to
|
|
jpayne@69
|
10931 ** sqlite3_rtree_geometry. This structure is a subclass of
|
|
jpayne@69
|
10932 ** sqlite3_rtree_geometry.
|
|
jpayne@69
|
10933 */
|
|
jpayne@69
|
10934 struct sqlite3_rtree_query_info {
|
|
jpayne@69
|
10935 void *pContext; /* pContext from when function registered */
|
|
jpayne@69
|
10936 int nParam; /* Number of function parameters */
|
|
jpayne@69
|
10937 sqlite3_rtree_dbl *aParam; /* value of function parameters */
|
|
jpayne@69
|
10938 void *pUser; /* callback can use this, if desired */
|
|
jpayne@69
|
10939 void (*xDelUser)(void*); /* function to free pUser */
|
|
jpayne@69
|
10940 sqlite3_rtree_dbl *aCoord; /* Coordinates of node or entry to check */
|
|
jpayne@69
|
10941 unsigned int *anQueue; /* Number of pending entries in the queue */
|
|
jpayne@69
|
10942 int nCoord; /* Number of coordinates */
|
|
jpayne@69
|
10943 int iLevel; /* Level of current node or entry */
|
|
jpayne@69
|
10944 int mxLevel; /* The largest iLevel value in the tree */
|
|
jpayne@69
|
10945 sqlite3_int64 iRowid; /* Rowid for current entry */
|
|
jpayne@69
|
10946 sqlite3_rtree_dbl rParentScore; /* Score of parent node */
|
|
jpayne@69
|
10947 int eParentWithin; /* Visibility of parent node */
|
|
jpayne@69
|
10948 int eWithin; /* OUT: Visibility */
|
|
jpayne@69
|
10949 sqlite3_rtree_dbl rScore; /* OUT: Write the score here */
|
|
jpayne@69
|
10950 /* The following fields are only available in 3.8.11 and later */
|
|
jpayne@69
|
10951 sqlite3_value **apSqlParam; /* Original SQL values of parameters */
|
|
jpayne@69
|
10952 };
|
|
jpayne@69
|
10953
|
|
jpayne@69
|
10954 /*
|
|
jpayne@69
|
10955 ** Allowed values for sqlite3_rtree_query.eWithin and .eParentWithin.
|
|
jpayne@69
|
10956 */
|
|
jpayne@69
|
10957 #define NOT_WITHIN 0 /* Object completely outside of query region */
|
|
jpayne@69
|
10958 #define PARTLY_WITHIN 1 /* Object partially overlaps query region */
|
|
jpayne@69
|
10959 #define FULLY_WITHIN 2 /* Object fully contained within query region */
|
|
jpayne@69
|
10960
|
|
jpayne@69
|
10961
|
|
jpayne@69
|
10962 #ifdef __cplusplus
|
|
jpayne@69
|
10963 } /* end of the 'extern "C"' block */
|
|
jpayne@69
|
10964 #endif
|
|
jpayne@69
|
10965
|
|
jpayne@69
|
10966 #endif /* ifndef _SQLITE3RTREE_H_ */
|
|
jpayne@69
|
10967
|
|
jpayne@69
|
10968 /******** End of sqlite3rtree.h *********/
|
|
jpayne@69
|
10969 /******** Begin file sqlite3session.h *********/
|
|
jpayne@69
|
10970
|
|
jpayne@69
|
10971 #if !defined(__SQLITESESSION_H_) && defined(SQLITE_ENABLE_SESSION)
|
|
jpayne@69
|
10972 #define __SQLITESESSION_H_ 1
|
|
jpayne@69
|
10973
|
|
jpayne@69
|
10974 /*
|
|
jpayne@69
|
10975 ** Make sure we can call this stuff from C++.
|
|
jpayne@69
|
10976 */
|
|
jpayne@69
|
10977 #ifdef __cplusplus
|
|
jpayne@69
|
10978 extern "C" {
|
|
jpayne@69
|
10979 #endif
|
|
jpayne@69
|
10980
|
|
jpayne@69
|
10981
|
|
jpayne@69
|
10982 /*
|
|
jpayne@69
|
10983 ** CAPI3REF: Session Object Handle
|
|
jpayne@69
|
10984 **
|
|
jpayne@69
|
10985 ** An instance of this object is a [session] that can be used to
|
|
jpayne@69
|
10986 ** record changes to a database.
|
|
jpayne@69
|
10987 */
|
|
jpayne@69
|
10988 typedef struct sqlite3_session sqlite3_session;
|
|
jpayne@69
|
10989
|
|
jpayne@69
|
10990 /*
|
|
jpayne@69
|
10991 ** CAPI3REF: Changeset Iterator Handle
|
|
jpayne@69
|
10992 **
|
|
jpayne@69
|
10993 ** An instance of this object acts as a cursor for iterating
|
|
jpayne@69
|
10994 ** over the elements of a [changeset] or [patchset].
|
|
jpayne@69
|
10995 */
|
|
jpayne@69
|
10996 typedef struct sqlite3_changeset_iter sqlite3_changeset_iter;
|
|
jpayne@69
|
10997
|
|
jpayne@69
|
10998 /*
|
|
jpayne@69
|
10999 ** CAPI3REF: Create A New Session Object
|
|
jpayne@69
|
11000 ** CONSTRUCTOR: sqlite3_session
|
|
jpayne@69
|
11001 **
|
|
jpayne@69
|
11002 ** Create a new session object attached to database handle db. If successful,
|
|
jpayne@69
|
11003 ** a pointer to the new object is written to *ppSession and SQLITE_OK is
|
|
jpayne@69
|
11004 ** returned. If an error occurs, *ppSession is set to NULL and an SQLite
|
|
jpayne@69
|
11005 ** error code (e.g. SQLITE_NOMEM) is returned.
|
|
jpayne@69
|
11006 **
|
|
jpayne@69
|
11007 ** It is possible to create multiple session objects attached to a single
|
|
jpayne@69
|
11008 ** database handle.
|
|
jpayne@69
|
11009 **
|
|
jpayne@69
|
11010 ** Session objects created using this function should be deleted using the
|
|
jpayne@69
|
11011 ** [sqlite3session_delete()] function before the database handle that they
|
|
jpayne@69
|
11012 ** are attached to is itself closed. If the database handle is closed before
|
|
jpayne@69
|
11013 ** the session object is deleted, then the results of calling any session
|
|
jpayne@69
|
11014 ** module function, including [sqlite3session_delete()] on the session object
|
|
jpayne@69
|
11015 ** are undefined.
|
|
jpayne@69
|
11016 **
|
|
jpayne@69
|
11017 ** Because the session module uses the [sqlite3_preupdate_hook()] API, it
|
|
jpayne@69
|
11018 ** is not possible for an application to register a pre-update hook on a
|
|
jpayne@69
|
11019 ** database handle that has one or more session objects attached. Nor is
|
|
jpayne@69
|
11020 ** it possible to create a session object attached to a database handle for
|
|
jpayne@69
|
11021 ** which a pre-update hook is already defined. The results of attempting
|
|
jpayne@69
|
11022 ** either of these things are undefined.
|
|
jpayne@69
|
11023 **
|
|
jpayne@69
|
11024 ** The session object will be used to create changesets for tables in
|
|
jpayne@69
|
11025 ** database zDb, where zDb is either "main", or "temp", or the name of an
|
|
jpayne@69
|
11026 ** attached database. It is not an error if database zDb is not attached
|
|
jpayne@69
|
11027 ** to the database when the session object is created.
|
|
jpayne@69
|
11028 */
|
|
jpayne@69
|
11029 SQLITE_API int sqlite3session_create(
|
|
jpayne@69
|
11030 sqlite3 *db, /* Database handle */
|
|
jpayne@69
|
11031 const char *zDb, /* Name of db (e.g. "main") */
|
|
jpayne@69
|
11032 sqlite3_session **ppSession /* OUT: New session object */
|
|
jpayne@69
|
11033 );
|
|
jpayne@69
|
11034
|
|
jpayne@69
|
11035 /*
|
|
jpayne@69
|
11036 ** CAPI3REF: Delete A Session Object
|
|
jpayne@69
|
11037 ** DESTRUCTOR: sqlite3_session
|
|
jpayne@69
|
11038 **
|
|
jpayne@69
|
11039 ** Delete a session object previously allocated using
|
|
jpayne@69
|
11040 ** [sqlite3session_create()]. Once a session object has been deleted, the
|
|
jpayne@69
|
11041 ** results of attempting to use pSession with any other session module
|
|
jpayne@69
|
11042 ** function are undefined.
|
|
jpayne@69
|
11043 **
|
|
jpayne@69
|
11044 ** Session objects must be deleted before the database handle to which they
|
|
jpayne@69
|
11045 ** are attached is closed. Refer to the documentation for
|
|
jpayne@69
|
11046 ** [sqlite3session_create()] for details.
|
|
jpayne@69
|
11047 */
|
|
jpayne@69
|
11048 SQLITE_API void sqlite3session_delete(sqlite3_session *pSession);
|
|
jpayne@69
|
11049
|
|
jpayne@69
|
11050 /*
|
|
jpayne@69
|
11051 ** CAPI3REF: Configure a Session Object
|
|
jpayne@69
|
11052 ** METHOD: sqlite3_session
|
|
jpayne@69
|
11053 **
|
|
jpayne@69
|
11054 ** This method is used to configure a session object after it has been
|
|
jpayne@69
|
11055 ** created. At present the only valid values for the second parameter are
|
|
jpayne@69
|
11056 ** [SQLITE_SESSION_OBJCONFIG_SIZE] and [SQLITE_SESSION_OBJCONFIG_ROWID].
|
|
jpayne@69
|
11057 **
|
|
jpayne@69
|
11058 */
|
|
jpayne@69
|
11059 SQLITE_API int sqlite3session_object_config(sqlite3_session*, int op, void *pArg);
|
|
jpayne@69
|
11060
|
|
jpayne@69
|
11061 /*
|
|
jpayne@69
|
11062 ** CAPI3REF: Options for sqlite3session_object_config
|
|
jpayne@69
|
11063 **
|
|
jpayne@69
|
11064 ** The following values may passed as the the 2nd parameter to
|
|
jpayne@69
|
11065 ** sqlite3session_object_config().
|
|
jpayne@69
|
11066 **
|
|
jpayne@69
|
11067 ** <dt>SQLITE_SESSION_OBJCONFIG_SIZE <dd>
|
|
jpayne@69
|
11068 ** This option is used to set, clear or query the flag that enables
|
|
jpayne@69
|
11069 ** the [sqlite3session_changeset_size()] API. Because it imposes some
|
|
jpayne@69
|
11070 ** computational overhead, this API is disabled by default. Argument
|
|
jpayne@69
|
11071 ** pArg must point to a value of type (int). If the value is initially
|
|
jpayne@69
|
11072 ** 0, then the sqlite3session_changeset_size() API is disabled. If it
|
|
jpayne@69
|
11073 ** is greater than 0, then the same API is enabled. Or, if the initial
|
|
jpayne@69
|
11074 ** value is less than zero, no change is made. In all cases the (int)
|
|
jpayne@69
|
11075 ** variable is set to 1 if the sqlite3session_changeset_size() API is
|
|
jpayne@69
|
11076 ** enabled following the current call, or 0 otherwise.
|
|
jpayne@69
|
11077 **
|
|
jpayne@69
|
11078 ** It is an error (SQLITE_MISUSE) to attempt to modify this setting after
|
|
jpayne@69
|
11079 ** the first table has been attached to the session object.
|
|
jpayne@69
|
11080 **
|
|
jpayne@69
|
11081 ** <dt>SQLITE_SESSION_OBJCONFIG_ROWID <dd>
|
|
jpayne@69
|
11082 ** This option is used to set, clear or query the flag that enables
|
|
jpayne@69
|
11083 ** collection of data for tables with no explicit PRIMARY KEY.
|
|
jpayne@69
|
11084 **
|
|
jpayne@69
|
11085 ** Normally, tables with no explicit PRIMARY KEY are simply ignored
|
|
jpayne@69
|
11086 ** by the sessions module. However, if this flag is set, it behaves
|
|
jpayne@69
|
11087 ** as if such tables have a column "_rowid_ INTEGER PRIMARY KEY" inserted
|
|
jpayne@69
|
11088 ** as their leftmost columns.
|
|
jpayne@69
|
11089 **
|
|
jpayne@69
|
11090 ** It is an error (SQLITE_MISUSE) to attempt to modify this setting after
|
|
jpayne@69
|
11091 ** the first table has been attached to the session object.
|
|
jpayne@69
|
11092 */
|
|
jpayne@69
|
11093 #define SQLITE_SESSION_OBJCONFIG_SIZE 1
|
|
jpayne@69
|
11094 #define SQLITE_SESSION_OBJCONFIG_ROWID 2
|
|
jpayne@69
|
11095
|
|
jpayne@69
|
11096 /*
|
|
jpayne@69
|
11097 ** CAPI3REF: Enable Or Disable A Session Object
|
|
jpayne@69
|
11098 ** METHOD: sqlite3_session
|
|
jpayne@69
|
11099 **
|
|
jpayne@69
|
11100 ** Enable or disable the recording of changes by a session object. When
|
|
jpayne@69
|
11101 ** enabled, a session object records changes made to the database. When
|
|
jpayne@69
|
11102 ** disabled - it does not. A newly created session object is enabled.
|
|
jpayne@69
|
11103 ** Refer to the documentation for [sqlite3session_changeset()] for further
|
|
jpayne@69
|
11104 ** details regarding how enabling and disabling a session object affects
|
|
jpayne@69
|
11105 ** the eventual changesets.
|
|
jpayne@69
|
11106 **
|
|
jpayne@69
|
11107 ** Passing zero to this function disables the session. Passing a value
|
|
jpayne@69
|
11108 ** greater than zero enables it. Passing a value less than zero is a
|
|
jpayne@69
|
11109 ** no-op, and may be used to query the current state of the session.
|
|
jpayne@69
|
11110 **
|
|
jpayne@69
|
11111 ** The return value indicates the final state of the session object: 0 if
|
|
jpayne@69
|
11112 ** the session is disabled, or 1 if it is enabled.
|
|
jpayne@69
|
11113 */
|
|
jpayne@69
|
11114 SQLITE_API int sqlite3session_enable(sqlite3_session *pSession, int bEnable);
|
|
jpayne@69
|
11115
|
|
jpayne@69
|
11116 /*
|
|
jpayne@69
|
11117 ** CAPI3REF: Set Or Clear the Indirect Change Flag
|
|
jpayne@69
|
11118 ** METHOD: sqlite3_session
|
|
jpayne@69
|
11119 **
|
|
jpayne@69
|
11120 ** Each change recorded by a session object is marked as either direct or
|
|
jpayne@69
|
11121 ** indirect. A change is marked as indirect if either:
|
|
jpayne@69
|
11122 **
|
|
jpayne@69
|
11123 ** <ul>
|
|
jpayne@69
|
11124 ** <li> The session object "indirect" flag is set when the change is
|
|
jpayne@69
|
11125 ** made, or
|
|
jpayne@69
|
11126 ** <li> The change is made by an SQL trigger or foreign key action
|
|
jpayne@69
|
11127 ** instead of directly as a result of a users SQL statement.
|
|
jpayne@69
|
11128 ** </ul>
|
|
jpayne@69
|
11129 **
|
|
jpayne@69
|
11130 ** If a single row is affected by more than one operation within a session,
|
|
jpayne@69
|
11131 ** then the change is considered indirect if all operations meet the criteria
|
|
jpayne@69
|
11132 ** for an indirect change above, or direct otherwise.
|
|
jpayne@69
|
11133 **
|
|
jpayne@69
|
11134 ** This function is used to set, clear or query the session object indirect
|
|
jpayne@69
|
11135 ** flag. If the second argument passed to this function is zero, then the
|
|
jpayne@69
|
11136 ** indirect flag is cleared. If it is greater than zero, the indirect flag
|
|
jpayne@69
|
11137 ** is set. Passing a value less than zero does not modify the current value
|
|
jpayne@69
|
11138 ** of the indirect flag, and may be used to query the current state of the
|
|
jpayne@69
|
11139 ** indirect flag for the specified session object.
|
|
jpayne@69
|
11140 **
|
|
jpayne@69
|
11141 ** The return value indicates the final state of the indirect flag: 0 if
|
|
jpayne@69
|
11142 ** it is clear, or 1 if it is set.
|
|
jpayne@69
|
11143 */
|
|
jpayne@69
|
11144 SQLITE_API int sqlite3session_indirect(sqlite3_session *pSession, int bIndirect);
|
|
jpayne@69
|
11145
|
|
jpayne@69
|
11146 /*
|
|
jpayne@69
|
11147 ** CAPI3REF: Attach A Table To A Session Object
|
|
jpayne@69
|
11148 ** METHOD: sqlite3_session
|
|
jpayne@69
|
11149 **
|
|
jpayne@69
|
11150 ** If argument zTab is not NULL, then it is the name of a table to attach
|
|
jpayne@69
|
11151 ** to the session object passed as the first argument. All subsequent changes
|
|
jpayne@69
|
11152 ** made to the table while the session object is enabled will be recorded. See
|
|
jpayne@69
|
11153 ** documentation for [sqlite3session_changeset()] for further details.
|
|
jpayne@69
|
11154 **
|
|
jpayne@69
|
11155 ** Or, if argument zTab is NULL, then changes are recorded for all tables
|
|
jpayne@69
|
11156 ** in the database. If additional tables are added to the database (by
|
|
jpayne@69
|
11157 ** executing "CREATE TABLE" statements) after this call is made, changes for
|
|
jpayne@69
|
11158 ** the new tables are also recorded.
|
|
jpayne@69
|
11159 **
|
|
jpayne@69
|
11160 ** Changes can only be recorded for tables that have a PRIMARY KEY explicitly
|
|
jpayne@69
|
11161 ** defined as part of their CREATE TABLE statement. It does not matter if the
|
|
jpayne@69
|
11162 ** PRIMARY KEY is an "INTEGER PRIMARY KEY" (rowid alias) or not. The PRIMARY
|
|
jpayne@69
|
11163 ** KEY may consist of a single column, or may be a composite key.
|
|
jpayne@69
|
11164 **
|
|
jpayne@69
|
11165 ** It is not an error if the named table does not exist in the database. Nor
|
|
jpayne@69
|
11166 ** is it an error if the named table does not have a PRIMARY KEY. However,
|
|
jpayne@69
|
11167 ** no changes will be recorded in either of these scenarios.
|
|
jpayne@69
|
11168 **
|
|
jpayne@69
|
11169 ** Changes are not recorded for individual rows that have NULL values stored
|
|
jpayne@69
|
11170 ** in one or more of their PRIMARY KEY columns.
|
|
jpayne@69
|
11171 **
|
|
jpayne@69
|
11172 ** SQLITE_OK is returned if the call completes without error. Or, if an error
|
|
jpayne@69
|
11173 ** occurs, an SQLite error code (e.g. SQLITE_NOMEM) is returned.
|
|
jpayne@69
|
11174 **
|
|
jpayne@69
|
11175 ** <h3>Special sqlite_stat1 Handling</h3>
|
|
jpayne@69
|
11176 **
|
|
jpayne@69
|
11177 ** As of SQLite version 3.22.0, the "sqlite_stat1" table is an exception to
|
|
jpayne@69
|
11178 ** some of the rules above. In SQLite, the schema of sqlite_stat1 is:
|
|
jpayne@69
|
11179 ** <pre>
|
|
jpayne@69
|
11180 ** CREATE TABLE sqlite_stat1(tbl,idx,stat)
|
|
jpayne@69
|
11181 ** </pre>
|
|
jpayne@69
|
11182 **
|
|
jpayne@69
|
11183 ** Even though sqlite_stat1 does not have a PRIMARY KEY, changes are
|
|
jpayne@69
|
11184 ** recorded for it as if the PRIMARY KEY is (tbl,idx). Additionally, changes
|
|
jpayne@69
|
11185 ** are recorded for rows for which (idx IS NULL) is true. However, for such
|
|
jpayne@69
|
11186 ** rows a zero-length blob (SQL value X'') is stored in the changeset or
|
|
jpayne@69
|
11187 ** patchset instead of a NULL value. This allows such changesets to be
|
|
jpayne@69
|
11188 ** manipulated by legacy implementations of sqlite3changeset_invert(),
|
|
jpayne@69
|
11189 ** concat() and similar.
|
|
jpayne@69
|
11190 **
|
|
jpayne@69
|
11191 ** The sqlite3changeset_apply() function automatically converts the
|
|
jpayne@69
|
11192 ** zero-length blob back to a NULL value when updating the sqlite_stat1
|
|
jpayne@69
|
11193 ** table. However, if the application calls sqlite3changeset_new(),
|
|
jpayne@69
|
11194 ** sqlite3changeset_old() or sqlite3changeset_conflict on a changeset
|
|
jpayne@69
|
11195 ** iterator directly (including on a changeset iterator passed to a
|
|
jpayne@69
|
11196 ** conflict-handler callback) then the X'' value is returned. The application
|
|
jpayne@69
|
11197 ** must translate X'' to NULL itself if required.
|
|
jpayne@69
|
11198 **
|
|
jpayne@69
|
11199 ** Legacy (older than 3.22.0) versions of the sessions module cannot capture
|
|
jpayne@69
|
11200 ** changes made to the sqlite_stat1 table. Legacy versions of the
|
|
jpayne@69
|
11201 ** sqlite3changeset_apply() function silently ignore any modifications to the
|
|
jpayne@69
|
11202 ** sqlite_stat1 table that are part of a changeset or patchset.
|
|
jpayne@69
|
11203 */
|
|
jpayne@69
|
11204 SQLITE_API int sqlite3session_attach(
|
|
jpayne@69
|
11205 sqlite3_session *pSession, /* Session object */
|
|
jpayne@69
|
11206 const char *zTab /* Table name */
|
|
jpayne@69
|
11207 );
|
|
jpayne@69
|
11208
|
|
jpayne@69
|
11209 /*
|
|
jpayne@69
|
11210 ** CAPI3REF: Set a table filter on a Session Object.
|
|
jpayne@69
|
11211 ** METHOD: sqlite3_session
|
|
jpayne@69
|
11212 **
|
|
jpayne@69
|
11213 ** The second argument (xFilter) is the "filter callback". For changes to rows
|
|
jpayne@69
|
11214 ** in tables that are not attached to the Session object, the filter is called
|
|
jpayne@69
|
11215 ** to determine whether changes to the table's rows should be tracked or not.
|
|
jpayne@69
|
11216 ** If xFilter returns 0, changes are not tracked. Note that once a table is
|
|
jpayne@69
|
11217 ** attached, xFilter will not be called again.
|
|
jpayne@69
|
11218 */
|
|
jpayne@69
|
11219 SQLITE_API void sqlite3session_table_filter(
|
|
jpayne@69
|
11220 sqlite3_session *pSession, /* Session object */
|
|
jpayne@69
|
11221 int(*xFilter)(
|
|
jpayne@69
|
11222 void *pCtx, /* Copy of third arg to _filter_table() */
|
|
jpayne@69
|
11223 const char *zTab /* Table name */
|
|
jpayne@69
|
11224 ),
|
|
jpayne@69
|
11225 void *pCtx /* First argument passed to xFilter */
|
|
jpayne@69
|
11226 );
|
|
jpayne@69
|
11227
|
|
jpayne@69
|
11228 /*
|
|
jpayne@69
|
11229 ** CAPI3REF: Generate A Changeset From A Session Object
|
|
jpayne@69
|
11230 ** METHOD: sqlite3_session
|
|
jpayne@69
|
11231 **
|
|
jpayne@69
|
11232 ** Obtain a changeset containing changes to the tables attached to the
|
|
jpayne@69
|
11233 ** session object passed as the first argument. If successful,
|
|
jpayne@69
|
11234 ** set *ppChangeset to point to a buffer containing the changeset
|
|
jpayne@69
|
11235 ** and *pnChangeset to the size of the changeset in bytes before returning
|
|
jpayne@69
|
11236 ** SQLITE_OK. If an error occurs, set both *ppChangeset and *pnChangeset to
|
|
jpayne@69
|
11237 ** zero and return an SQLite error code.
|
|
jpayne@69
|
11238 **
|
|
jpayne@69
|
11239 ** A changeset consists of zero or more INSERT, UPDATE and/or DELETE changes,
|
|
jpayne@69
|
11240 ** each representing a change to a single row of an attached table. An INSERT
|
|
jpayne@69
|
11241 ** change contains the values of each field of a new database row. A DELETE
|
|
jpayne@69
|
11242 ** contains the original values of each field of a deleted database row. An
|
|
jpayne@69
|
11243 ** UPDATE change contains the original values of each field of an updated
|
|
jpayne@69
|
11244 ** database row along with the updated values for each updated non-primary-key
|
|
jpayne@69
|
11245 ** column. It is not possible for an UPDATE change to represent a change that
|
|
jpayne@69
|
11246 ** modifies the values of primary key columns. If such a change is made, it
|
|
jpayne@69
|
11247 ** is represented in a changeset as a DELETE followed by an INSERT.
|
|
jpayne@69
|
11248 **
|
|
jpayne@69
|
11249 ** Changes are not recorded for rows that have NULL values stored in one or
|
|
jpayne@69
|
11250 ** more of their PRIMARY KEY columns. If such a row is inserted or deleted,
|
|
jpayne@69
|
11251 ** no corresponding change is present in the changesets returned by this
|
|
jpayne@69
|
11252 ** function. If an existing row with one or more NULL values stored in
|
|
jpayne@69
|
11253 ** PRIMARY KEY columns is updated so that all PRIMARY KEY columns are non-NULL,
|
|
jpayne@69
|
11254 ** only an INSERT is appears in the changeset. Similarly, if an existing row
|
|
jpayne@69
|
11255 ** with non-NULL PRIMARY KEY values is updated so that one or more of its
|
|
jpayne@69
|
11256 ** PRIMARY KEY columns are set to NULL, the resulting changeset contains a
|
|
jpayne@69
|
11257 ** DELETE change only.
|
|
jpayne@69
|
11258 **
|
|
jpayne@69
|
11259 ** The contents of a changeset may be traversed using an iterator created
|
|
jpayne@69
|
11260 ** using the [sqlite3changeset_start()] API. A changeset may be applied to
|
|
jpayne@69
|
11261 ** a database with a compatible schema using the [sqlite3changeset_apply()]
|
|
jpayne@69
|
11262 ** API.
|
|
jpayne@69
|
11263 **
|
|
jpayne@69
|
11264 ** Within a changeset generated by this function, all changes related to a
|
|
jpayne@69
|
11265 ** single table are grouped together. In other words, when iterating through
|
|
jpayne@69
|
11266 ** a changeset or when applying a changeset to a database, all changes related
|
|
jpayne@69
|
11267 ** to a single table are processed before moving on to the next table. Tables
|
|
jpayne@69
|
11268 ** are sorted in the same order in which they were attached (or auto-attached)
|
|
jpayne@69
|
11269 ** to the sqlite3_session object. The order in which the changes related to
|
|
jpayne@69
|
11270 ** a single table are stored is undefined.
|
|
jpayne@69
|
11271 **
|
|
jpayne@69
|
11272 ** Following a successful call to this function, it is the responsibility of
|
|
jpayne@69
|
11273 ** the caller to eventually free the buffer that *ppChangeset points to using
|
|
jpayne@69
|
11274 ** [sqlite3_free()].
|
|
jpayne@69
|
11275 **
|
|
jpayne@69
|
11276 ** <h3>Changeset Generation</h3>
|
|
jpayne@69
|
11277 **
|
|
jpayne@69
|
11278 ** Once a table has been attached to a session object, the session object
|
|
jpayne@69
|
11279 ** records the primary key values of all new rows inserted into the table.
|
|
jpayne@69
|
11280 ** It also records the original primary key and other column values of any
|
|
jpayne@69
|
11281 ** deleted or updated rows. For each unique primary key value, data is only
|
|
jpayne@69
|
11282 ** recorded once - the first time a row with said primary key is inserted,
|
|
jpayne@69
|
11283 ** updated or deleted in the lifetime of the session.
|
|
jpayne@69
|
11284 **
|
|
jpayne@69
|
11285 ** There is one exception to the previous paragraph: when a row is inserted,
|
|
jpayne@69
|
11286 ** updated or deleted, if one or more of its primary key columns contain a
|
|
jpayne@69
|
11287 ** NULL value, no record of the change is made.
|
|
jpayne@69
|
11288 **
|
|
jpayne@69
|
11289 ** The session object therefore accumulates two types of records - those
|
|
jpayne@69
|
11290 ** that consist of primary key values only (created when the user inserts
|
|
jpayne@69
|
11291 ** a new record) and those that consist of the primary key values and the
|
|
jpayne@69
|
11292 ** original values of other table columns (created when the users deletes
|
|
jpayne@69
|
11293 ** or updates a record).
|
|
jpayne@69
|
11294 **
|
|
jpayne@69
|
11295 ** When this function is called, the requested changeset is created using
|
|
jpayne@69
|
11296 ** both the accumulated records and the current contents of the database
|
|
jpayne@69
|
11297 ** file. Specifically:
|
|
jpayne@69
|
11298 **
|
|
jpayne@69
|
11299 ** <ul>
|
|
jpayne@69
|
11300 ** <li> For each record generated by an insert, the database is queried
|
|
jpayne@69
|
11301 ** for a row with a matching primary key. If one is found, an INSERT
|
|
jpayne@69
|
11302 ** change is added to the changeset. If no such row is found, no change
|
|
jpayne@69
|
11303 ** is added to the changeset.
|
|
jpayne@69
|
11304 **
|
|
jpayne@69
|
11305 ** <li> For each record generated by an update or delete, the database is
|
|
jpayne@69
|
11306 ** queried for a row with a matching primary key. If such a row is
|
|
jpayne@69
|
11307 ** found and one or more of the non-primary key fields have been
|
|
jpayne@69
|
11308 ** modified from their original values, an UPDATE change is added to
|
|
jpayne@69
|
11309 ** the changeset. Or, if no such row is found in the table, a DELETE
|
|
jpayne@69
|
11310 ** change is added to the changeset. If there is a row with a matching
|
|
jpayne@69
|
11311 ** primary key in the database, but all fields contain their original
|
|
jpayne@69
|
11312 ** values, no change is added to the changeset.
|
|
jpayne@69
|
11313 ** </ul>
|
|
jpayne@69
|
11314 **
|
|
jpayne@69
|
11315 ** This means, amongst other things, that if a row is inserted and then later
|
|
jpayne@69
|
11316 ** deleted while a session object is active, neither the insert nor the delete
|
|
jpayne@69
|
11317 ** will be present in the changeset. Or if a row is deleted and then later a
|
|
jpayne@69
|
11318 ** row with the same primary key values inserted while a session object is
|
|
jpayne@69
|
11319 ** active, the resulting changeset will contain an UPDATE change instead of
|
|
jpayne@69
|
11320 ** a DELETE and an INSERT.
|
|
jpayne@69
|
11321 **
|
|
jpayne@69
|
11322 ** When a session object is disabled (see the [sqlite3session_enable()] API),
|
|
jpayne@69
|
11323 ** it does not accumulate records when rows are inserted, updated or deleted.
|
|
jpayne@69
|
11324 ** This may appear to have some counter-intuitive effects if a single row
|
|
jpayne@69
|
11325 ** is written to more than once during a session. For example, if a row
|
|
jpayne@69
|
11326 ** is inserted while a session object is enabled, then later deleted while
|
|
jpayne@69
|
11327 ** the same session object is disabled, no INSERT record will appear in the
|
|
jpayne@69
|
11328 ** changeset, even though the delete took place while the session was disabled.
|
|
jpayne@69
|
11329 ** Or, if one field of a row is updated while a session is disabled, and
|
|
jpayne@69
|
11330 ** another field of the same row is updated while the session is enabled, the
|
|
jpayne@69
|
11331 ** resulting changeset will contain an UPDATE change that updates both fields.
|
|
jpayne@69
|
11332 */
|
|
jpayne@69
|
11333 SQLITE_API int sqlite3session_changeset(
|
|
jpayne@69
|
11334 sqlite3_session *pSession, /* Session object */
|
|
jpayne@69
|
11335 int *pnChangeset, /* OUT: Size of buffer at *ppChangeset */
|
|
jpayne@69
|
11336 void **ppChangeset /* OUT: Buffer containing changeset */
|
|
jpayne@69
|
11337 );
|
|
jpayne@69
|
11338
|
|
jpayne@69
|
11339 /*
|
|
jpayne@69
|
11340 ** CAPI3REF: Return An Upper-limit For The Size Of The Changeset
|
|
jpayne@69
|
11341 ** METHOD: sqlite3_session
|
|
jpayne@69
|
11342 **
|
|
jpayne@69
|
11343 ** By default, this function always returns 0. For it to return
|
|
jpayne@69
|
11344 ** a useful result, the sqlite3_session object must have been configured
|
|
jpayne@69
|
11345 ** to enable this API using sqlite3session_object_config() with the
|
|
jpayne@69
|
11346 ** SQLITE_SESSION_OBJCONFIG_SIZE verb.
|
|
jpayne@69
|
11347 **
|
|
jpayne@69
|
11348 ** When enabled, this function returns an upper limit, in bytes, for the size
|
|
jpayne@69
|
11349 ** of the changeset that might be produced if sqlite3session_changeset() were
|
|
jpayne@69
|
11350 ** called. The final changeset size might be equal to or smaller than the
|
|
jpayne@69
|
11351 ** size in bytes returned by this function.
|
|
jpayne@69
|
11352 */
|
|
jpayne@69
|
11353 SQLITE_API sqlite3_int64 sqlite3session_changeset_size(sqlite3_session *pSession);
|
|
jpayne@69
|
11354
|
|
jpayne@69
|
11355 /*
|
|
jpayne@69
|
11356 ** CAPI3REF: Load The Difference Between Tables Into A Session
|
|
jpayne@69
|
11357 ** METHOD: sqlite3_session
|
|
jpayne@69
|
11358 **
|
|
jpayne@69
|
11359 ** If it is not already attached to the session object passed as the first
|
|
jpayne@69
|
11360 ** argument, this function attaches table zTbl in the same manner as the
|
|
jpayne@69
|
11361 ** [sqlite3session_attach()] function. If zTbl does not exist, or if it
|
|
jpayne@69
|
11362 ** does not have a primary key, this function is a no-op (but does not return
|
|
jpayne@69
|
11363 ** an error).
|
|
jpayne@69
|
11364 **
|
|
jpayne@69
|
11365 ** Argument zFromDb must be the name of a database ("main", "temp" etc.)
|
|
jpayne@69
|
11366 ** attached to the same database handle as the session object that contains
|
|
jpayne@69
|
11367 ** a table compatible with the table attached to the session by this function.
|
|
jpayne@69
|
11368 ** A table is considered compatible if it:
|
|
jpayne@69
|
11369 **
|
|
jpayne@69
|
11370 ** <ul>
|
|
jpayne@69
|
11371 ** <li> Has the same name,
|
|
jpayne@69
|
11372 ** <li> Has the same set of columns declared in the same order, and
|
|
jpayne@69
|
11373 ** <li> Has the same PRIMARY KEY definition.
|
|
jpayne@69
|
11374 ** </ul>
|
|
jpayne@69
|
11375 **
|
|
jpayne@69
|
11376 ** If the tables are not compatible, SQLITE_SCHEMA is returned. If the tables
|
|
jpayne@69
|
11377 ** are compatible but do not have any PRIMARY KEY columns, it is not an error
|
|
jpayne@69
|
11378 ** but no changes are added to the session object. As with other session
|
|
jpayne@69
|
11379 ** APIs, tables without PRIMARY KEYs are simply ignored.
|
|
jpayne@69
|
11380 **
|
|
jpayne@69
|
11381 ** This function adds a set of changes to the session object that could be
|
|
jpayne@69
|
11382 ** used to update the table in database zFrom (call this the "from-table")
|
|
jpayne@69
|
11383 ** so that its content is the same as the table attached to the session
|
|
jpayne@69
|
11384 ** object (call this the "to-table"). Specifically:
|
|
jpayne@69
|
11385 **
|
|
jpayne@69
|
11386 ** <ul>
|
|
jpayne@69
|
11387 ** <li> For each row (primary key) that exists in the to-table but not in
|
|
jpayne@69
|
11388 ** the from-table, an INSERT record is added to the session object.
|
|
jpayne@69
|
11389 **
|
|
jpayne@69
|
11390 ** <li> For each row (primary key) that exists in the to-table but not in
|
|
jpayne@69
|
11391 ** the from-table, a DELETE record is added to the session object.
|
|
jpayne@69
|
11392 **
|
|
jpayne@69
|
11393 ** <li> For each row (primary key) that exists in both tables, but features
|
|
jpayne@69
|
11394 ** different non-PK values in each, an UPDATE record is added to the
|
|
jpayne@69
|
11395 ** session.
|
|
jpayne@69
|
11396 ** </ul>
|
|
jpayne@69
|
11397 **
|
|
jpayne@69
|
11398 ** To clarify, if this function is called and then a changeset constructed
|
|
jpayne@69
|
11399 ** using [sqlite3session_changeset()], then after applying that changeset to
|
|
jpayne@69
|
11400 ** database zFrom the contents of the two compatible tables would be
|
|
jpayne@69
|
11401 ** identical.
|
|
jpayne@69
|
11402 **
|
|
jpayne@69
|
11403 ** It an error if database zFrom does not exist or does not contain the
|
|
jpayne@69
|
11404 ** required compatible table.
|
|
jpayne@69
|
11405 **
|
|
jpayne@69
|
11406 ** If the operation is successful, SQLITE_OK is returned. Otherwise, an SQLite
|
|
jpayne@69
|
11407 ** error code. In this case, if argument pzErrMsg is not NULL, *pzErrMsg
|
|
jpayne@69
|
11408 ** may be set to point to a buffer containing an English language error
|
|
jpayne@69
|
11409 ** message. It is the responsibility of the caller to free this buffer using
|
|
jpayne@69
|
11410 ** sqlite3_free().
|
|
jpayne@69
|
11411 */
|
|
jpayne@69
|
11412 SQLITE_API int sqlite3session_diff(
|
|
jpayne@69
|
11413 sqlite3_session *pSession,
|
|
jpayne@69
|
11414 const char *zFromDb,
|
|
jpayne@69
|
11415 const char *zTbl,
|
|
jpayne@69
|
11416 char **pzErrMsg
|
|
jpayne@69
|
11417 );
|
|
jpayne@69
|
11418
|
|
jpayne@69
|
11419
|
|
jpayne@69
|
11420 /*
|
|
jpayne@69
|
11421 ** CAPI3REF: Generate A Patchset From A Session Object
|
|
jpayne@69
|
11422 ** METHOD: sqlite3_session
|
|
jpayne@69
|
11423 **
|
|
jpayne@69
|
11424 ** The differences between a patchset and a changeset are that:
|
|
jpayne@69
|
11425 **
|
|
jpayne@69
|
11426 ** <ul>
|
|
jpayne@69
|
11427 ** <li> DELETE records consist of the primary key fields only. The
|
|
jpayne@69
|
11428 ** original values of other fields are omitted.
|
|
jpayne@69
|
11429 ** <li> The original values of any modified fields are omitted from
|
|
jpayne@69
|
11430 ** UPDATE records.
|
|
jpayne@69
|
11431 ** </ul>
|
|
jpayne@69
|
11432 **
|
|
jpayne@69
|
11433 ** A patchset blob may be used with up to date versions of all
|
|
jpayne@69
|
11434 ** sqlite3changeset_xxx API functions except for sqlite3changeset_invert(),
|
|
jpayne@69
|
11435 ** which returns SQLITE_CORRUPT if it is passed a patchset. Similarly,
|
|
jpayne@69
|
11436 ** attempting to use a patchset blob with old versions of the
|
|
jpayne@69
|
11437 ** sqlite3changeset_xxx APIs also provokes an SQLITE_CORRUPT error.
|
|
jpayne@69
|
11438 **
|
|
jpayne@69
|
11439 ** Because the non-primary key "old.*" fields are omitted, no
|
|
jpayne@69
|
11440 ** SQLITE_CHANGESET_DATA conflicts can be detected or reported if a patchset
|
|
jpayne@69
|
11441 ** is passed to the sqlite3changeset_apply() API. Other conflict types work
|
|
jpayne@69
|
11442 ** in the same way as for changesets.
|
|
jpayne@69
|
11443 **
|
|
jpayne@69
|
11444 ** Changes within a patchset are ordered in the same way as for changesets
|
|
jpayne@69
|
11445 ** generated by the sqlite3session_changeset() function (i.e. all changes for
|
|
jpayne@69
|
11446 ** a single table are grouped together, tables appear in the order in which
|
|
jpayne@69
|
11447 ** they were attached to the session object).
|
|
jpayne@69
|
11448 */
|
|
jpayne@69
|
11449 SQLITE_API int sqlite3session_patchset(
|
|
jpayne@69
|
11450 sqlite3_session *pSession, /* Session object */
|
|
jpayne@69
|
11451 int *pnPatchset, /* OUT: Size of buffer at *ppPatchset */
|
|
jpayne@69
|
11452 void **ppPatchset /* OUT: Buffer containing patchset */
|
|
jpayne@69
|
11453 );
|
|
jpayne@69
|
11454
|
|
jpayne@69
|
11455 /*
|
|
jpayne@69
|
11456 ** CAPI3REF: Test if a changeset has recorded any changes.
|
|
jpayne@69
|
11457 **
|
|
jpayne@69
|
11458 ** Return non-zero if no changes to attached tables have been recorded by
|
|
jpayne@69
|
11459 ** the session object passed as the first argument. Otherwise, if one or
|
|
jpayne@69
|
11460 ** more changes have been recorded, return zero.
|
|
jpayne@69
|
11461 **
|
|
jpayne@69
|
11462 ** Even if this function returns zero, it is possible that calling
|
|
jpayne@69
|
11463 ** [sqlite3session_changeset()] on the session handle may still return a
|
|
jpayne@69
|
11464 ** changeset that contains no changes. This can happen when a row in
|
|
jpayne@69
|
11465 ** an attached table is modified and then later on the original values
|
|
jpayne@69
|
11466 ** are restored. However, if this function returns non-zero, then it is
|
|
jpayne@69
|
11467 ** guaranteed that a call to sqlite3session_changeset() will return a
|
|
jpayne@69
|
11468 ** changeset containing zero changes.
|
|
jpayne@69
|
11469 */
|
|
jpayne@69
|
11470 SQLITE_API int sqlite3session_isempty(sqlite3_session *pSession);
|
|
jpayne@69
|
11471
|
|
jpayne@69
|
11472 /*
|
|
jpayne@69
|
11473 ** CAPI3REF: Query for the amount of heap memory used by a session object.
|
|
jpayne@69
|
11474 **
|
|
jpayne@69
|
11475 ** This API returns the total amount of heap memory in bytes currently
|
|
jpayne@69
|
11476 ** used by the session object passed as the only argument.
|
|
jpayne@69
|
11477 */
|
|
jpayne@69
|
11478 SQLITE_API sqlite3_int64 sqlite3session_memory_used(sqlite3_session *pSession);
|
|
jpayne@69
|
11479
|
|
jpayne@69
|
11480 /*
|
|
jpayne@69
|
11481 ** CAPI3REF: Create An Iterator To Traverse A Changeset
|
|
jpayne@69
|
11482 ** CONSTRUCTOR: sqlite3_changeset_iter
|
|
jpayne@69
|
11483 **
|
|
jpayne@69
|
11484 ** Create an iterator used to iterate through the contents of a changeset.
|
|
jpayne@69
|
11485 ** If successful, *pp is set to point to the iterator handle and SQLITE_OK
|
|
jpayne@69
|
11486 ** is returned. Otherwise, if an error occurs, *pp is set to zero and an
|
|
jpayne@69
|
11487 ** SQLite error code is returned.
|
|
jpayne@69
|
11488 **
|
|
jpayne@69
|
11489 ** The following functions can be used to advance and query a changeset
|
|
jpayne@69
|
11490 ** iterator created by this function:
|
|
jpayne@69
|
11491 **
|
|
jpayne@69
|
11492 ** <ul>
|
|
jpayne@69
|
11493 ** <li> [sqlite3changeset_next()]
|
|
jpayne@69
|
11494 ** <li> [sqlite3changeset_op()]
|
|
jpayne@69
|
11495 ** <li> [sqlite3changeset_new()]
|
|
jpayne@69
|
11496 ** <li> [sqlite3changeset_old()]
|
|
jpayne@69
|
11497 ** </ul>
|
|
jpayne@69
|
11498 **
|
|
jpayne@69
|
11499 ** It is the responsibility of the caller to eventually destroy the iterator
|
|
jpayne@69
|
11500 ** by passing it to [sqlite3changeset_finalize()]. The buffer containing the
|
|
jpayne@69
|
11501 ** changeset (pChangeset) must remain valid until after the iterator is
|
|
jpayne@69
|
11502 ** destroyed.
|
|
jpayne@69
|
11503 **
|
|
jpayne@69
|
11504 ** Assuming the changeset blob was created by one of the
|
|
jpayne@69
|
11505 ** [sqlite3session_changeset()], [sqlite3changeset_concat()] or
|
|
jpayne@69
|
11506 ** [sqlite3changeset_invert()] functions, all changes within the changeset
|
|
jpayne@69
|
11507 ** that apply to a single table are grouped together. This means that when
|
|
jpayne@69
|
11508 ** an application iterates through a changeset using an iterator created by
|
|
jpayne@69
|
11509 ** this function, all changes that relate to a single table are visited
|
|
jpayne@69
|
11510 ** consecutively. There is no chance that the iterator will visit a change
|
|
jpayne@69
|
11511 ** the applies to table X, then one for table Y, and then later on visit
|
|
jpayne@69
|
11512 ** another change for table X.
|
|
jpayne@69
|
11513 **
|
|
jpayne@69
|
11514 ** The behavior of sqlite3changeset_start_v2() and its streaming equivalent
|
|
jpayne@69
|
11515 ** may be modified by passing a combination of
|
|
jpayne@69
|
11516 ** [SQLITE_CHANGESETSTART_INVERT | supported flags] as the 4th parameter.
|
|
jpayne@69
|
11517 **
|
|
jpayne@69
|
11518 ** Note that the sqlite3changeset_start_v2() API is still <b>experimental</b>
|
|
jpayne@69
|
11519 ** and therefore subject to change.
|
|
jpayne@69
|
11520 */
|
|
jpayne@69
|
11521 SQLITE_API int sqlite3changeset_start(
|
|
jpayne@69
|
11522 sqlite3_changeset_iter **pp, /* OUT: New changeset iterator handle */
|
|
jpayne@69
|
11523 int nChangeset, /* Size of changeset blob in bytes */
|
|
jpayne@69
|
11524 void *pChangeset /* Pointer to blob containing changeset */
|
|
jpayne@69
|
11525 );
|
|
jpayne@69
|
11526 SQLITE_API int sqlite3changeset_start_v2(
|
|
jpayne@69
|
11527 sqlite3_changeset_iter **pp, /* OUT: New changeset iterator handle */
|
|
jpayne@69
|
11528 int nChangeset, /* Size of changeset blob in bytes */
|
|
jpayne@69
|
11529 void *pChangeset, /* Pointer to blob containing changeset */
|
|
jpayne@69
|
11530 int flags /* SESSION_CHANGESETSTART_* flags */
|
|
jpayne@69
|
11531 );
|
|
jpayne@69
|
11532
|
|
jpayne@69
|
11533 /*
|
|
jpayne@69
|
11534 ** CAPI3REF: Flags for sqlite3changeset_start_v2
|
|
jpayne@69
|
11535 **
|
|
jpayne@69
|
11536 ** The following flags may passed via the 4th parameter to
|
|
jpayne@69
|
11537 ** [sqlite3changeset_start_v2] and [sqlite3changeset_start_v2_strm]:
|
|
jpayne@69
|
11538 **
|
|
jpayne@69
|
11539 ** <dt>SQLITE_CHANGESETAPPLY_INVERT <dd>
|
|
jpayne@69
|
11540 ** Invert the changeset while iterating through it. This is equivalent to
|
|
jpayne@69
|
11541 ** inverting a changeset using sqlite3changeset_invert() before applying it.
|
|
jpayne@69
|
11542 ** It is an error to specify this flag with a patchset.
|
|
jpayne@69
|
11543 */
|
|
jpayne@69
|
11544 #define SQLITE_CHANGESETSTART_INVERT 0x0002
|
|
jpayne@69
|
11545
|
|
jpayne@69
|
11546
|
|
jpayne@69
|
11547 /*
|
|
jpayne@69
|
11548 ** CAPI3REF: Advance A Changeset Iterator
|
|
jpayne@69
|
11549 ** METHOD: sqlite3_changeset_iter
|
|
jpayne@69
|
11550 **
|
|
jpayne@69
|
11551 ** This function may only be used with iterators created by the function
|
|
jpayne@69
|
11552 ** [sqlite3changeset_start()]. If it is called on an iterator passed to
|
|
jpayne@69
|
11553 ** a conflict-handler callback by [sqlite3changeset_apply()], SQLITE_MISUSE
|
|
jpayne@69
|
11554 ** is returned and the call has no effect.
|
|
jpayne@69
|
11555 **
|
|
jpayne@69
|
11556 ** Immediately after an iterator is created by sqlite3changeset_start(), it
|
|
jpayne@69
|
11557 ** does not point to any change in the changeset. Assuming the changeset
|
|
jpayne@69
|
11558 ** is not empty, the first call to this function advances the iterator to
|
|
jpayne@69
|
11559 ** point to the first change in the changeset. Each subsequent call advances
|
|
jpayne@69
|
11560 ** the iterator to point to the next change in the changeset (if any). If
|
|
jpayne@69
|
11561 ** no error occurs and the iterator points to a valid change after a call
|
|
jpayne@69
|
11562 ** to sqlite3changeset_next() has advanced it, SQLITE_ROW is returned.
|
|
jpayne@69
|
11563 ** Otherwise, if all changes in the changeset have already been visited,
|
|
jpayne@69
|
11564 ** SQLITE_DONE is returned.
|
|
jpayne@69
|
11565 **
|
|
jpayne@69
|
11566 ** If an error occurs, an SQLite error code is returned. Possible error
|
|
jpayne@69
|
11567 ** codes include SQLITE_CORRUPT (if the changeset buffer is corrupt) or
|
|
jpayne@69
|
11568 ** SQLITE_NOMEM.
|
|
jpayne@69
|
11569 */
|
|
jpayne@69
|
11570 SQLITE_API int sqlite3changeset_next(sqlite3_changeset_iter *pIter);
|
|
jpayne@69
|
11571
|
|
jpayne@69
|
11572 /*
|
|
jpayne@69
|
11573 ** CAPI3REF: Obtain The Current Operation From A Changeset Iterator
|
|
jpayne@69
|
11574 ** METHOD: sqlite3_changeset_iter
|
|
jpayne@69
|
11575 **
|
|
jpayne@69
|
11576 ** The pIter argument passed to this function may either be an iterator
|
|
jpayne@69
|
11577 ** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator
|
|
jpayne@69
|
11578 ** created by [sqlite3changeset_start()]. In the latter case, the most recent
|
|
jpayne@69
|
11579 ** call to [sqlite3changeset_next()] must have returned [SQLITE_ROW]. If this
|
|
jpayne@69
|
11580 ** is not the case, this function returns [SQLITE_MISUSE].
|
|
jpayne@69
|
11581 **
|
|
jpayne@69
|
11582 ** Arguments pOp, pnCol and pzTab may not be NULL. Upon return, three
|
|
jpayne@69
|
11583 ** outputs are set through these pointers:
|
|
jpayne@69
|
11584 **
|
|
jpayne@69
|
11585 ** *pOp is set to one of [SQLITE_INSERT], [SQLITE_DELETE] or [SQLITE_UPDATE],
|
|
jpayne@69
|
11586 ** depending on the type of change that the iterator currently points to;
|
|
jpayne@69
|
11587 **
|
|
jpayne@69
|
11588 ** *pnCol is set to the number of columns in the table affected by the change; and
|
|
jpayne@69
|
11589 **
|
|
jpayne@69
|
11590 ** *pzTab is set to point to a nul-terminated utf-8 encoded string containing
|
|
jpayne@69
|
11591 ** the name of the table affected by the current change. The buffer remains
|
|
jpayne@69
|
11592 ** valid until either sqlite3changeset_next() is called on the iterator
|
|
jpayne@69
|
11593 ** or until the conflict-handler function returns.
|
|
jpayne@69
|
11594 **
|
|
jpayne@69
|
11595 ** If pbIndirect is not NULL, then *pbIndirect is set to true (1) if the change
|
|
jpayne@69
|
11596 ** is an indirect change, or false (0) otherwise. See the documentation for
|
|
jpayne@69
|
11597 ** [sqlite3session_indirect()] for a description of direct and indirect
|
|
jpayne@69
|
11598 ** changes.
|
|
jpayne@69
|
11599 **
|
|
jpayne@69
|
11600 ** If no error occurs, SQLITE_OK is returned. If an error does occur, an
|
|
jpayne@69
|
11601 ** SQLite error code is returned. The values of the output variables may not
|
|
jpayne@69
|
11602 ** be trusted in this case.
|
|
jpayne@69
|
11603 */
|
|
jpayne@69
|
11604 SQLITE_API int sqlite3changeset_op(
|
|
jpayne@69
|
11605 sqlite3_changeset_iter *pIter, /* Iterator object */
|
|
jpayne@69
|
11606 const char **pzTab, /* OUT: Pointer to table name */
|
|
jpayne@69
|
11607 int *pnCol, /* OUT: Number of columns in table */
|
|
jpayne@69
|
11608 int *pOp, /* OUT: SQLITE_INSERT, DELETE or UPDATE */
|
|
jpayne@69
|
11609 int *pbIndirect /* OUT: True for an 'indirect' change */
|
|
jpayne@69
|
11610 );
|
|
jpayne@69
|
11611
|
|
jpayne@69
|
11612 /*
|
|
jpayne@69
|
11613 ** CAPI3REF: Obtain The Primary Key Definition Of A Table
|
|
jpayne@69
|
11614 ** METHOD: sqlite3_changeset_iter
|
|
jpayne@69
|
11615 **
|
|
jpayne@69
|
11616 ** For each modified table, a changeset includes the following:
|
|
jpayne@69
|
11617 **
|
|
jpayne@69
|
11618 ** <ul>
|
|
jpayne@69
|
11619 ** <li> The number of columns in the table, and
|
|
jpayne@69
|
11620 ** <li> Which of those columns make up the tables PRIMARY KEY.
|
|
jpayne@69
|
11621 ** </ul>
|
|
jpayne@69
|
11622 **
|
|
jpayne@69
|
11623 ** This function is used to find which columns comprise the PRIMARY KEY of
|
|
jpayne@69
|
11624 ** the table modified by the change that iterator pIter currently points to.
|
|
jpayne@69
|
11625 ** If successful, *pabPK is set to point to an array of nCol entries, where
|
|
jpayne@69
|
11626 ** nCol is the number of columns in the table. Elements of *pabPK are set to
|
|
jpayne@69
|
11627 ** 0x01 if the corresponding column is part of the tables primary key, or
|
|
jpayne@69
|
11628 ** 0x00 if it is not.
|
|
jpayne@69
|
11629 **
|
|
jpayne@69
|
11630 ** If argument pnCol is not NULL, then *pnCol is set to the number of columns
|
|
jpayne@69
|
11631 ** in the table.
|
|
jpayne@69
|
11632 **
|
|
jpayne@69
|
11633 ** If this function is called when the iterator does not point to a valid
|
|
jpayne@69
|
11634 ** entry, SQLITE_MISUSE is returned and the output variables zeroed. Otherwise,
|
|
jpayne@69
|
11635 ** SQLITE_OK is returned and the output variables populated as described
|
|
jpayne@69
|
11636 ** above.
|
|
jpayne@69
|
11637 */
|
|
jpayne@69
|
11638 SQLITE_API int sqlite3changeset_pk(
|
|
jpayne@69
|
11639 sqlite3_changeset_iter *pIter, /* Iterator object */
|
|
jpayne@69
|
11640 unsigned char **pabPK, /* OUT: Array of boolean - true for PK cols */
|
|
jpayne@69
|
11641 int *pnCol /* OUT: Number of entries in output array */
|
|
jpayne@69
|
11642 );
|
|
jpayne@69
|
11643
|
|
jpayne@69
|
11644 /*
|
|
jpayne@69
|
11645 ** CAPI3REF: Obtain old.* Values From A Changeset Iterator
|
|
jpayne@69
|
11646 ** METHOD: sqlite3_changeset_iter
|
|
jpayne@69
|
11647 **
|
|
jpayne@69
|
11648 ** The pIter argument passed to this function may either be an iterator
|
|
jpayne@69
|
11649 ** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator
|
|
jpayne@69
|
11650 ** created by [sqlite3changeset_start()]. In the latter case, the most recent
|
|
jpayne@69
|
11651 ** call to [sqlite3changeset_next()] must have returned SQLITE_ROW.
|
|
jpayne@69
|
11652 ** Furthermore, it may only be called if the type of change that the iterator
|
|
jpayne@69
|
11653 ** currently points to is either [SQLITE_DELETE] or [SQLITE_UPDATE]. Otherwise,
|
|
jpayne@69
|
11654 ** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL.
|
|
jpayne@69
|
11655 **
|
|
jpayne@69
|
11656 ** Argument iVal must be greater than or equal to 0, and less than the number
|
|
jpayne@69
|
11657 ** of columns in the table affected by the current change. Otherwise,
|
|
jpayne@69
|
11658 ** [SQLITE_RANGE] is returned and *ppValue is set to NULL.
|
|
jpayne@69
|
11659 **
|
|
jpayne@69
|
11660 ** If successful, this function sets *ppValue to point to a protected
|
|
jpayne@69
|
11661 ** sqlite3_value object containing the iVal'th value from the vector of
|
|
jpayne@69
|
11662 ** original row values stored as part of the UPDATE or DELETE change and
|
|
jpayne@69
|
11663 ** returns SQLITE_OK. The name of the function comes from the fact that this
|
|
jpayne@69
|
11664 ** is similar to the "old.*" columns available to update or delete triggers.
|
|
jpayne@69
|
11665 **
|
|
jpayne@69
|
11666 ** If some other error occurs (e.g. an OOM condition), an SQLite error code
|
|
jpayne@69
|
11667 ** is returned and *ppValue is set to NULL.
|
|
jpayne@69
|
11668 */
|
|
jpayne@69
|
11669 SQLITE_API int sqlite3changeset_old(
|
|
jpayne@69
|
11670 sqlite3_changeset_iter *pIter, /* Changeset iterator */
|
|
jpayne@69
|
11671 int iVal, /* Column number */
|
|
jpayne@69
|
11672 sqlite3_value **ppValue /* OUT: Old value (or NULL pointer) */
|
|
jpayne@69
|
11673 );
|
|
jpayne@69
|
11674
|
|
jpayne@69
|
11675 /*
|
|
jpayne@69
|
11676 ** CAPI3REF: Obtain new.* Values From A Changeset Iterator
|
|
jpayne@69
|
11677 ** METHOD: sqlite3_changeset_iter
|
|
jpayne@69
|
11678 **
|
|
jpayne@69
|
11679 ** The pIter argument passed to this function may either be an iterator
|
|
jpayne@69
|
11680 ** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator
|
|
jpayne@69
|
11681 ** created by [sqlite3changeset_start()]. In the latter case, the most recent
|
|
jpayne@69
|
11682 ** call to [sqlite3changeset_next()] must have returned SQLITE_ROW.
|
|
jpayne@69
|
11683 ** Furthermore, it may only be called if the type of change that the iterator
|
|
jpayne@69
|
11684 ** currently points to is either [SQLITE_UPDATE] or [SQLITE_INSERT]. Otherwise,
|
|
jpayne@69
|
11685 ** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL.
|
|
jpayne@69
|
11686 **
|
|
jpayne@69
|
11687 ** Argument iVal must be greater than or equal to 0, and less than the number
|
|
jpayne@69
|
11688 ** of columns in the table affected by the current change. Otherwise,
|
|
jpayne@69
|
11689 ** [SQLITE_RANGE] is returned and *ppValue is set to NULL.
|
|
jpayne@69
|
11690 **
|
|
jpayne@69
|
11691 ** If successful, this function sets *ppValue to point to a protected
|
|
jpayne@69
|
11692 ** sqlite3_value object containing the iVal'th value from the vector of
|
|
jpayne@69
|
11693 ** new row values stored as part of the UPDATE or INSERT change and
|
|
jpayne@69
|
11694 ** returns SQLITE_OK. If the change is an UPDATE and does not include
|
|
jpayne@69
|
11695 ** a new value for the requested column, *ppValue is set to NULL and
|
|
jpayne@69
|
11696 ** SQLITE_OK returned. The name of the function comes from the fact that
|
|
jpayne@69
|
11697 ** this is similar to the "new.*" columns available to update or delete
|
|
jpayne@69
|
11698 ** triggers.
|
|
jpayne@69
|
11699 **
|
|
jpayne@69
|
11700 ** If some other error occurs (e.g. an OOM condition), an SQLite error code
|
|
jpayne@69
|
11701 ** is returned and *ppValue is set to NULL.
|
|
jpayne@69
|
11702 */
|
|
jpayne@69
|
11703 SQLITE_API int sqlite3changeset_new(
|
|
jpayne@69
|
11704 sqlite3_changeset_iter *pIter, /* Changeset iterator */
|
|
jpayne@69
|
11705 int iVal, /* Column number */
|
|
jpayne@69
|
11706 sqlite3_value **ppValue /* OUT: New value (or NULL pointer) */
|
|
jpayne@69
|
11707 );
|
|
jpayne@69
|
11708
|
|
jpayne@69
|
11709 /*
|
|
jpayne@69
|
11710 ** CAPI3REF: Obtain Conflicting Row Values From A Changeset Iterator
|
|
jpayne@69
|
11711 ** METHOD: sqlite3_changeset_iter
|
|
jpayne@69
|
11712 **
|
|
jpayne@69
|
11713 ** This function should only be used with iterator objects passed to a
|
|
jpayne@69
|
11714 ** conflict-handler callback by [sqlite3changeset_apply()] with either
|
|
jpayne@69
|
11715 ** [SQLITE_CHANGESET_DATA] or [SQLITE_CHANGESET_CONFLICT]. If this function
|
|
jpayne@69
|
11716 ** is called on any other iterator, [SQLITE_MISUSE] is returned and *ppValue
|
|
jpayne@69
|
11717 ** is set to NULL.
|
|
jpayne@69
|
11718 **
|
|
jpayne@69
|
11719 ** Argument iVal must be greater than or equal to 0, and less than the number
|
|
jpayne@69
|
11720 ** of columns in the table affected by the current change. Otherwise,
|
|
jpayne@69
|
11721 ** [SQLITE_RANGE] is returned and *ppValue is set to NULL.
|
|
jpayne@69
|
11722 **
|
|
jpayne@69
|
11723 ** If successful, this function sets *ppValue to point to a protected
|
|
jpayne@69
|
11724 ** sqlite3_value object containing the iVal'th value from the
|
|
jpayne@69
|
11725 ** "conflicting row" associated with the current conflict-handler callback
|
|
jpayne@69
|
11726 ** and returns SQLITE_OK.
|
|
jpayne@69
|
11727 **
|
|
jpayne@69
|
11728 ** If some other error occurs (e.g. an OOM condition), an SQLite error code
|
|
jpayne@69
|
11729 ** is returned and *ppValue is set to NULL.
|
|
jpayne@69
|
11730 */
|
|
jpayne@69
|
11731 SQLITE_API int sqlite3changeset_conflict(
|
|
jpayne@69
|
11732 sqlite3_changeset_iter *pIter, /* Changeset iterator */
|
|
jpayne@69
|
11733 int iVal, /* Column number */
|
|
jpayne@69
|
11734 sqlite3_value **ppValue /* OUT: Value from conflicting row */
|
|
jpayne@69
|
11735 );
|
|
jpayne@69
|
11736
|
|
jpayne@69
|
11737 /*
|
|
jpayne@69
|
11738 ** CAPI3REF: Determine The Number Of Foreign Key Constraint Violations
|
|
jpayne@69
|
11739 ** METHOD: sqlite3_changeset_iter
|
|
jpayne@69
|
11740 **
|
|
jpayne@69
|
11741 ** This function may only be called with an iterator passed to an
|
|
jpayne@69
|
11742 ** SQLITE_CHANGESET_FOREIGN_KEY conflict handler callback. In this case
|
|
jpayne@69
|
11743 ** it sets the output variable to the total number of known foreign key
|
|
jpayne@69
|
11744 ** violations in the destination database and returns SQLITE_OK.
|
|
jpayne@69
|
11745 **
|
|
jpayne@69
|
11746 ** In all other cases this function returns SQLITE_MISUSE.
|
|
jpayne@69
|
11747 */
|
|
jpayne@69
|
11748 SQLITE_API int sqlite3changeset_fk_conflicts(
|
|
jpayne@69
|
11749 sqlite3_changeset_iter *pIter, /* Changeset iterator */
|
|
jpayne@69
|
11750 int *pnOut /* OUT: Number of FK violations */
|
|
jpayne@69
|
11751 );
|
|
jpayne@69
|
11752
|
|
jpayne@69
|
11753
|
|
jpayne@69
|
11754 /*
|
|
jpayne@69
|
11755 ** CAPI3REF: Finalize A Changeset Iterator
|
|
jpayne@69
|
11756 ** METHOD: sqlite3_changeset_iter
|
|
jpayne@69
|
11757 **
|
|
jpayne@69
|
11758 ** This function is used to finalize an iterator allocated with
|
|
jpayne@69
|
11759 ** [sqlite3changeset_start()].
|
|
jpayne@69
|
11760 **
|
|
jpayne@69
|
11761 ** This function should only be called on iterators created using the
|
|
jpayne@69
|
11762 ** [sqlite3changeset_start()] function. If an application calls this
|
|
jpayne@69
|
11763 ** function with an iterator passed to a conflict-handler by
|
|
jpayne@69
|
11764 ** [sqlite3changeset_apply()], [SQLITE_MISUSE] is immediately returned and the
|
|
jpayne@69
|
11765 ** call has no effect.
|
|
jpayne@69
|
11766 **
|
|
jpayne@69
|
11767 ** If an error was encountered within a call to an sqlite3changeset_xxx()
|
|
jpayne@69
|
11768 ** function (for example an [SQLITE_CORRUPT] in [sqlite3changeset_next()] or an
|
|
jpayne@69
|
11769 ** [SQLITE_NOMEM] in [sqlite3changeset_new()]) then an error code corresponding
|
|
jpayne@69
|
11770 ** to that error is returned by this function. Otherwise, SQLITE_OK is
|
|
jpayne@69
|
11771 ** returned. This is to allow the following pattern (pseudo-code):
|
|
jpayne@69
|
11772 **
|
|
jpayne@69
|
11773 ** <pre>
|
|
jpayne@69
|
11774 ** sqlite3changeset_start();
|
|
jpayne@69
|
11775 ** while( SQLITE_ROW==sqlite3changeset_next() ){
|
|
jpayne@69
|
11776 ** // Do something with change.
|
|
jpayne@69
|
11777 ** }
|
|
jpayne@69
|
11778 ** rc = sqlite3changeset_finalize();
|
|
jpayne@69
|
11779 ** if( rc!=SQLITE_OK ){
|
|
jpayne@69
|
11780 ** // An error has occurred
|
|
jpayne@69
|
11781 ** }
|
|
jpayne@69
|
11782 ** </pre>
|
|
jpayne@69
|
11783 */
|
|
jpayne@69
|
11784 SQLITE_API int sqlite3changeset_finalize(sqlite3_changeset_iter *pIter);
|
|
jpayne@69
|
11785
|
|
jpayne@69
|
11786 /*
|
|
jpayne@69
|
11787 ** CAPI3REF: Invert A Changeset
|
|
jpayne@69
|
11788 **
|
|
jpayne@69
|
11789 ** This function is used to "invert" a changeset object. Applying an inverted
|
|
jpayne@69
|
11790 ** changeset to a database reverses the effects of applying the uninverted
|
|
jpayne@69
|
11791 ** changeset. Specifically:
|
|
jpayne@69
|
11792 **
|
|
jpayne@69
|
11793 ** <ul>
|
|
jpayne@69
|
11794 ** <li> Each DELETE change is changed to an INSERT, and
|
|
jpayne@69
|
11795 ** <li> Each INSERT change is changed to a DELETE, and
|
|
jpayne@69
|
11796 ** <li> For each UPDATE change, the old.* and new.* values are exchanged.
|
|
jpayne@69
|
11797 ** </ul>
|
|
jpayne@69
|
11798 **
|
|
jpayne@69
|
11799 ** This function does not change the order in which changes appear within
|
|
jpayne@69
|
11800 ** the changeset. It merely reverses the sense of each individual change.
|
|
jpayne@69
|
11801 **
|
|
jpayne@69
|
11802 ** If successful, a pointer to a buffer containing the inverted changeset
|
|
jpayne@69
|
11803 ** is stored in *ppOut, the size of the same buffer is stored in *pnOut, and
|
|
jpayne@69
|
11804 ** SQLITE_OK is returned. If an error occurs, both *pnOut and *ppOut are
|
|
jpayne@69
|
11805 ** zeroed and an SQLite error code returned.
|
|
jpayne@69
|
11806 **
|
|
jpayne@69
|
11807 ** It is the responsibility of the caller to eventually call sqlite3_free()
|
|
jpayne@69
|
11808 ** on the *ppOut pointer to free the buffer allocation following a successful
|
|
jpayne@69
|
11809 ** call to this function.
|
|
jpayne@69
|
11810 **
|
|
jpayne@69
|
11811 ** WARNING/TODO: This function currently assumes that the input is a valid
|
|
jpayne@69
|
11812 ** changeset. If it is not, the results are undefined.
|
|
jpayne@69
|
11813 */
|
|
jpayne@69
|
11814 SQLITE_API int sqlite3changeset_invert(
|
|
jpayne@69
|
11815 int nIn, const void *pIn, /* Input changeset */
|
|
jpayne@69
|
11816 int *pnOut, void **ppOut /* OUT: Inverse of input */
|
|
jpayne@69
|
11817 );
|
|
jpayne@69
|
11818
|
|
jpayne@69
|
11819 /*
|
|
jpayne@69
|
11820 ** CAPI3REF: Concatenate Two Changeset Objects
|
|
jpayne@69
|
11821 **
|
|
jpayne@69
|
11822 ** This function is used to concatenate two changesets, A and B, into a
|
|
jpayne@69
|
11823 ** single changeset. The result is a changeset equivalent to applying
|
|
jpayne@69
|
11824 ** changeset A followed by changeset B.
|
|
jpayne@69
|
11825 **
|
|
jpayne@69
|
11826 ** This function combines the two input changesets using an
|
|
jpayne@69
|
11827 ** sqlite3_changegroup object. Calling it produces similar results as the
|
|
jpayne@69
|
11828 ** following code fragment:
|
|
jpayne@69
|
11829 **
|
|
jpayne@69
|
11830 ** <pre>
|
|
jpayne@69
|
11831 ** sqlite3_changegroup *pGrp;
|
|
jpayne@69
|
11832 ** rc = sqlite3_changegroup_new(&pGrp);
|
|
jpayne@69
|
11833 ** if( rc==SQLITE_OK ) rc = sqlite3changegroup_add(pGrp, nA, pA);
|
|
jpayne@69
|
11834 ** if( rc==SQLITE_OK ) rc = sqlite3changegroup_add(pGrp, nB, pB);
|
|
jpayne@69
|
11835 ** if( rc==SQLITE_OK ){
|
|
jpayne@69
|
11836 ** rc = sqlite3changegroup_output(pGrp, pnOut, ppOut);
|
|
jpayne@69
|
11837 ** }else{
|
|
jpayne@69
|
11838 ** *ppOut = 0;
|
|
jpayne@69
|
11839 ** *pnOut = 0;
|
|
jpayne@69
|
11840 ** }
|
|
jpayne@69
|
11841 ** </pre>
|
|
jpayne@69
|
11842 **
|
|
jpayne@69
|
11843 ** Refer to the sqlite3_changegroup documentation below for details.
|
|
jpayne@69
|
11844 */
|
|
jpayne@69
|
11845 SQLITE_API int sqlite3changeset_concat(
|
|
jpayne@69
|
11846 int nA, /* Number of bytes in buffer pA */
|
|
jpayne@69
|
11847 void *pA, /* Pointer to buffer containing changeset A */
|
|
jpayne@69
|
11848 int nB, /* Number of bytes in buffer pB */
|
|
jpayne@69
|
11849 void *pB, /* Pointer to buffer containing changeset B */
|
|
jpayne@69
|
11850 int *pnOut, /* OUT: Number of bytes in output changeset */
|
|
jpayne@69
|
11851 void **ppOut /* OUT: Buffer containing output changeset */
|
|
jpayne@69
|
11852 );
|
|
jpayne@69
|
11853
|
|
jpayne@69
|
11854
|
|
jpayne@69
|
11855 /*
|
|
jpayne@69
|
11856 ** CAPI3REF: Upgrade the Schema of a Changeset/Patchset
|
|
jpayne@69
|
11857 */
|
|
jpayne@69
|
11858 SQLITE_API int sqlite3changeset_upgrade(
|
|
jpayne@69
|
11859 sqlite3 *db,
|
|
jpayne@69
|
11860 const char *zDb,
|
|
jpayne@69
|
11861 int nIn, const void *pIn, /* Input changeset */
|
|
jpayne@69
|
11862 int *pnOut, void **ppOut /* OUT: Inverse of input */
|
|
jpayne@69
|
11863 );
|
|
jpayne@69
|
11864
|
|
jpayne@69
|
11865
|
|
jpayne@69
|
11866
|
|
jpayne@69
|
11867 /*
|
|
jpayne@69
|
11868 ** CAPI3REF: Changegroup Handle
|
|
jpayne@69
|
11869 **
|
|
jpayne@69
|
11870 ** A changegroup is an object used to combine two or more
|
|
jpayne@69
|
11871 ** [changesets] or [patchsets]
|
|
jpayne@69
|
11872 */
|
|
jpayne@69
|
11873 typedef struct sqlite3_changegroup sqlite3_changegroup;
|
|
jpayne@69
|
11874
|
|
jpayne@69
|
11875 /*
|
|
jpayne@69
|
11876 ** CAPI3REF: Create A New Changegroup Object
|
|
jpayne@69
|
11877 ** CONSTRUCTOR: sqlite3_changegroup
|
|
jpayne@69
|
11878 **
|
|
jpayne@69
|
11879 ** An sqlite3_changegroup object is used to combine two or more changesets
|
|
jpayne@69
|
11880 ** (or patchsets) into a single changeset (or patchset). A single changegroup
|
|
jpayne@69
|
11881 ** object may combine changesets or patchsets, but not both. The output is
|
|
jpayne@69
|
11882 ** always in the same format as the input.
|
|
jpayne@69
|
11883 **
|
|
jpayne@69
|
11884 ** If successful, this function returns SQLITE_OK and populates (*pp) with
|
|
jpayne@69
|
11885 ** a pointer to a new sqlite3_changegroup object before returning. The caller
|
|
jpayne@69
|
11886 ** should eventually free the returned object using a call to
|
|
jpayne@69
|
11887 ** sqlite3changegroup_delete(). If an error occurs, an SQLite error code
|
|
jpayne@69
|
11888 ** (i.e. SQLITE_NOMEM) is returned and *pp is set to NULL.
|
|
jpayne@69
|
11889 **
|
|
jpayne@69
|
11890 ** The usual usage pattern for an sqlite3_changegroup object is as follows:
|
|
jpayne@69
|
11891 **
|
|
jpayne@69
|
11892 ** <ul>
|
|
jpayne@69
|
11893 ** <li> It is created using a call to sqlite3changegroup_new().
|
|
jpayne@69
|
11894 **
|
|
jpayne@69
|
11895 ** <li> Zero or more changesets (or patchsets) are added to the object
|
|
jpayne@69
|
11896 ** by calling sqlite3changegroup_add().
|
|
jpayne@69
|
11897 **
|
|
jpayne@69
|
11898 ** <li> The result of combining all input changesets together is obtained
|
|
jpayne@69
|
11899 ** by the application via a call to sqlite3changegroup_output().
|
|
jpayne@69
|
11900 **
|
|
jpayne@69
|
11901 ** <li> The object is deleted using a call to sqlite3changegroup_delete().
|
|
jpayne@69
|
11902 ** </ul>
|
|
jpayne@69
|
11903 **
|
|
jpayne@69
|
11904 ** Any number of calls to add() and output() may be made between the calls to
|
|
jpayne@69
|
11905 ** new() and delete(), and in any order.
|
|
jpayne@69
|
11906 **
|
|
jpayne@69
|
11907 ** As well as the regular sqlite3changegroup_add() and
|
|
jpayne@69
|
11908 ** sqlite3changegroup_output() functions, also available are the streaming
|
|
jpayne@69
|
11909 ** versions sqlite3changegroup_add_strm() and sqlite3changegroup_output_strm().
|
|
jpayne@69
|
11910 */
|
|
jpayne@69
|
11911 SQLITE_API int sqlite3changegroup_new(sqlite3_changegroup **pp);
|
|
jpayne@69
|
11912
|
|
jpayne@69
|
11913 /*
|
|
jpayne@69
|
11914 ** CAPI3REF: Add a Schema to a Changegroup
|
|
jpayne@69
|
11915 ** METHOD: sqlite3_changegroup_schema
|
|
jpayne@69
|
11916 **
|
|
jpayne@69
|
11917 ** This method may be used to optionally enforce the rule that the changesets
|
|
jpayne@69
|
11918 ** added to the changegroup handle must match the schema of database zDb
|
|
jpayne@69
|
11919 ** ("main", "temp", or the name of an attached database). If
|
|
jpayne@69
|
11920 ** sqlite3changegroup_add() is called to add a changeset that is not compatible
|
|
jpayne@69
|
11921 ** with the configured schema, SQLITE_SCHEMA is returned and the changegroup
|
|
jpayne@69
|
11922 ** object is left in an undefined state.
|
|
jpayne@69
|
11923 **
|
|
jpayne@69
|
11924 ** A changeset schema is considered compatible with the database schema in
|
|
jpayne@69
|
11925 ** the same way as for sqlite3changeset_apply(). Specifically, for each
|
|
jpayne@69
|
11926 ** table in the changeset, there exists a database table with:
|
|
jpayne@69
|
11927 **
|
|
jpayne@69
|
11928 ** <ul>
|
|
jpayne@69
|
11929 ** <li> The name identified by the changeset, and
|
|
jpayne@69
|
11930 ** <li> at least as many columns as recorded in the changeset, and
|
|
jpayne@69
|
11931 ** <li> the primary key columns in the same position as recorded in
|
|
jpayne@69
|
11932 ** the changeset.
|
|
jpayne@69
|
11933 ** </ul>
|
|
jpayne@69
|
11934 **
|
|
jpayne@69
|
11935 ** The output of the changegroup object always has the same schema as the
|
|
jpayne@69
|
11936 ** database nominated using this function. In cases where changesets passed
|
|
jpayne@69
|
11937 ** to sqlite3changegroup_add() have fewer columns than the corresponding table
|
|
jpayne@69
|
11938 ** in the database schema, these are filled in using the default column
|
|
jpayne@69
|
11939 ** values from the database schema. This makes it possible to combined
|
|
jpayne@69
|
11940 ** changesets that have different numbers of columns for a single table
|
|
jpayne@69
|
11941 ** within a changegroup, provided that they are otherwise compatible.
|
|
jpayne@69
|
11942 */
|
|
jpayne@69
|
11943 SQLITE_API int sqlite3changegroup_schema(sqlite3_changegroup*, sqlite3*, const char *zDb);
|
|
jpayne@69
|
11944
|
|
jpayne@69
|
11945 /*
|
|
jpayne@69
|
11946 ** CAPI3REF: Add A Changeset To A Changegroup
|
|
jpayne@69
|
11947 ** METHOD: sqlite3_changegroup
|
|
jpayne@69
|
11948 **
|
|
jpayne@69
|
11949 ** Add all changes within the changeset (or patchset) in buffer pData (size
|
|
jpayne@69
|
11950 ** nData bytes) to the changegroup.
|
|
jpayne@69
|
11951 **
|
|
jpayne@69
|
11952 ** If the buffer contains a patchset, then all prior calls to this function
|
|
jpayne@69
|
11953 ** on the same changegroup object must also have specified patchsets. Or, if
|
|
jpayne@69
|
11954 ** the buffer contains a changeset, so must have the earlier calls to this
|
|
jpayne@69
|
11955 ** function. Otherwise, SQLITE_ERROR is returned and no changes are added
|
|
jpayne@69
|
11956 ** to the changegroup.
|
|
jpayne@69
|
11957 **
|
|
jpayne@69
|
11958 ** Rows within the changeset and changegroup are identified by the values in
|
|
jpayne@69
|
11959 ** their PRIMARY KEY columns. A change in the changeset is considered to
|
|
jpayne@69
|
11960 ** apply to the same row as a change already present in the changegroup if
|
|
jpayne@69
|
11961 ** the two rows have the same primary key.
|
|
jpayne@69
|
11962 **
|
|
jpayne@69
|
11963 ** Changes to rows that do not already appear in the changegroup are
|
|
jpayne@69
|
11964 ** simply copied into it. Or, if both the new changeset and the changegroup
|
|
jpayne@69
|
11965 ** contain changes that apply to a single row, the final contents of the
|
|
jpayne@69
|
11966 ** changegroup depends on the type of each change, as follows:
|
|
jpayne@69
|
11967 **
|
|
jpayne@69
|
11968 ** <table border=1 style="margin-left:8ex;margin-right:8ex">
|
|
jpayne@69
|
11969 ** <tr><th style="white-space:pre">Existing Change </th>
|
|
jpayne@69
|
11970 ** <th style="white-space:pre">New Change </th>
|
|
jpayne@69
|
11971 ** <th>Output Change
|
|
jpayne@69
|
11972 ** <tr><td>INSERT <td>INSERT <td>
|
|
jpayne@69
|
11973 ** The new change is ignored. This case does not occur if the new
|
|
jpayne@69
|
11974 ** changeset was recorded immediately after the changesets already
|
|
jpayne@69
|
11975 ** added to the changegroup.
|
|
jpayne@69
|
11976 ** <tr><td>INSERT <td>UPDATE <td>
|
|
jpayne@69
|
11977 ** The INSERT change remains in the changegroup. The values in the
|
|
jpayne@69
|
11978 ** INSERT change are modified as if the row was inserted by the
|
|
jpayne@69
|
11979 ** existing change and then updated according to the new change.
|
|
jpayne@69
|
11980 ** <tr><td>INSERT <td>DELETE <td>
|
|
jpayne@69
|
11981 ** The existing INSERT is removed from the changegroup. The DELETE is
|
|
jpayne@69
|
11982 ** not added.
|
|
jpayne@69
|
11983 ** <tr><td>UPDATE <td>INSERT <td>
|
|
jpayne@69
|
11984 ** The new change is ignored. This case does not occur if the new
|
|
jpayne@69
|
11985 ** changeset was recorded immediately after the changesets already
|
|
jpayne@69
|
11986 ** added to the changegroup.
|
|
jpayne@69
|
11987 ** <tr><td>UPDATE <td>UPDATE <td>
|
|
jpayne@69
|
11988 ** The existing UPDATE remains within the changegroup. It is amended
|
|
jpayne@69
|
11989 ** so that the accompanying values are as if the row was updated once
|
|
jpayne@69
|
11990 ** by the existing change and then again by the new change.
|
|
jpayne@69
|
11991 ** <tr><td>UPDATE <td>DELETE <td>
|
|
jpayne@69
|
11992 ** The existing UPDATE is replaced by the new DELETE within the
|
|
jpayne@69
|
11993 ** changegroup.
|
|
jpayne@69
|
11994 ** <tr><td>DELETE <td>INSERT <td>
|
|
jpayne@69
|
11995 ** If one or more of the column values in the row inserted by the
|
|
jpayne@69
|
11996 ** new change differ from those in the row deleted by the existing
|
|
jpayne@69
|
11997 ** change, the existing DELETE is replaced by an UPDATE within the
|
|
jpayne@69
|
11998 ** changegroup. Otherwise, if the inserted row is exactly the same
|
|
jpayne@69
|
11999 ** as the deleted row, the existing DELETE is simply discarded.
|
|
jpayne@69
|
12000 ** <tr><td>DELETE <td>UPDATE <td>
|
|
jpayne@69
|
12001 ** The new change is ignored. This case does not occur if the new
|
|
jpayne@69
|
12002 ** changeset was recorded immediately after the changesets already
|
|
jpayne@69
|
12003 ** added to the changegroup.
|
|
jpayne@69
|
12004 ** <tr><td>DELETE <td>DELETE <td>
|
|
jpayne@69
|
12005 ** The new change is ignored. This case does not occur if the new
|
|
jpayne@69
|
12006 ** changeset was recorded immediately after the changesets already
|
|
jpayne@69
|
12007 ** added to the changegroup.
|
|
jpayne@69
|
12008 ** </table>
|
|
jpayne@69
|
12009 **
|
|
jpayne@69
|
12010 ** If the new changeset contains changes to a table that is already present
|
|
jpayne@69
|
12011 ** in the changegroup, then the number of columns and the position of the
|
|
jpayne@69
|
12012 ** primary key columns for the table must be consistent. If this is not the
|
|
jpayne@69
|
12013 ** case, this function fails with SQLITE_SCHEMA. Except, if the changegroup
|
|
jpayne@69
|
12014 ** object has been configured with a database schema using the
|
|
jpayne@69
|
12015 ** sqlite3changegroup_schema() API, then it is possible to combine changesets
|
|
jpayne@69
|
12016 ** with different numbers of columns for a single table, provided that
|
|
jpayne@69
|
12017 ** they are otherwise compatible.
|
|
jpayne@69
|
12018 **
|
|
jpayne@69
|
12019 ** If the input changeset appears to be corrupt and the corruption is
|
|
jpayne@69
|
12020 ** detected, SQLITE_CORRUPT is returned. Or, if an out-of-memory condition
|
|
jpayne@69
|
12021 ** occurs during processing, this function returns SQLITE_NOMEM.
|
|
jpayne@69
|
12022 **
|
|
jpayne@69
|
12023 ** In all cases, if an error occurs the state of the final contents of the
|
|
jpayne@69
|
12024 ** changegroup is undefined. If no error occurs, SQLITE_OK is returned.
|
|
jpayne@69
|
12025 */
|
|
jpayne@69
|
12026 SQLITE_API int sqlite3changegroup_add(sqlite3_changegroup*, int nData, void *pData);
|
|
jpayne@69
|
12027
|
|
jpayne@69
|
12028 /*
|
|
jpayne@69
|
12029 ** CAPI3REF: Add A Single Change To A Changegroup
|
|
jpayne@69
|
12030 ** METHOD: sqlite3_changegroup
|
|
jpayne@69
|
12031 **
|
|
jpayne@69
|
12032 ** This function adds the single change currently indicated by the iterator
|
|
jpayne@69
|
12033 ** passed as the second argument to the changegroup object. The rules for
|
|
jpayne@69
|
12034 ** adding the change are just as described for [sqlite3changegroup_add()].
|
|
jpayne@69
|
12035 **
|
|
jpayne@69
|
12036 ** If the change is successfully added to the changegroup, SQLITE_OK is
|
|
jpayne@69
|
12037 ** returned. Otherwise, an SQLite error code is returned.
|
|
jpayne@69
|
12038 **
|
|
jpayne@69
|
12039 ** The iterator must point to a valid entry when this function is called.
|
|
jpayne@69
|
12040 ** If it does not, SQLITE_ERROR is returned and no change is added to the
|
|
jpayne@69
|
12041 ** changegroup. Additionally, the iterator must not have been opened with
|
|
jpayne@69
|
12042 ** the SQLITE_CHANGESETAPPLY_INVERT flag. In this case SQLITE_ERROR is also
|
|
jpayne@69
|
12043 ** returned.
|
|
jpayne@69
|
12044 */
|
|
jpayne@69
|
12045 SQLITE_API int sqlite3changegroup_add_change(
|
|
jpayne@69
|
12046 sqlite3_changegroup*,
|
|
jpayne@69
|
12047 sqlite3_changeset_iter*
|
|
jpayne@69
|
12048 );
|
|
jpayne@69
|
12049
|
|
jpayne@69
|
12050
|
|
jpayne@69
|
12051
|
|
jpayne@69
|
12052 /*
|
|
jpayne@69
|
12053 ** CAPI3REF: Obtain A Composite Changeset From A Changegroup
|
|
jpayne@69
|
12054 ** METHOD: sqlite3_changegroup
|
|
jpayne@69
|
12055 **
|
|
jpayne@69
|
12056 ** Obtain a buffer containing a changeset (or patchset) representing the
|
|
jpayne@69
|
12057 ** current contents of the changegroup. If the inputs to the changegroup
|
|
jpayne@69
|
12058 ** were themselves changesets, the output is a changeset. Or, if the
|
|
jpayne@69
|
12059 ** inputs were patchsets, the output is also a patchset.
|
|
jpayne@69
|
12060 **
|
|
jpayne@69
|
12061 ** As with the output of the sqlite3session_changeset() and
|
|
jpayne@69
|
12062 ** sqlite3session_patchset() functions, all changes related to a single
|
|
jpayne@69
|
12063 ** table are grouped together in the output of this function. Tables appear
|
|
jpayne@69
|
12064 ** in the same order as for the very first changeset added to the changegroup.
|
|
jpayne@69
|
12065 ** If the second or subsequent changesets added to the changegroup contain
|
|
jpayne@69
|
12066 ** changes for tables that do not appear in the first changeset, they are
|
|
jpayne@69
|
12067 ** appended onto the end of the output changeset, again in the order in
|
|
jpayne@69
|
12068 ** which they are first encountered.
|
|
jpayne@69
|
12069 **
|
|
jpayne@69
|
12070 ** If an error occurs, an SQLite error code is returned and the output
|
|
jpayne@69
|
12071 ** variables (*pnData) and (*ppData) are set to 0. Otherwise, SQLITE_OK
|
|
jpayne@69
|
12072 ** is returned and the output variables are set to the size of and a
|
|
jpayne@69
|
12073 ** pointer to the output buffer, respectively. In this case it is the
|
|
jpayne@69
|
12074 ** responsibility of the caller to eventually free the buffer using a
|
|
jpayne@69
|
12075 ** call to sqlite3_free().
|
|
jpayne@69
|
12076 */
|
|
jpayne@69
|
12077 SQLITE_API int sqlite3changegroup_output(
|
|
jpayne@69
|
12078 sqlite3_changegroup*,
|
|
jpayne@69
|
12079 int *pnData, /* OUT: Size of output buffer in bytes */
|
|
jpayne@69
|
12080 void **ppData /* OUT: Pointer to output buffer */
|
|
jpayne@69
|
12081 );
|
|
jpayne@69
|
12082
|
|
jpayne@69
|
12083 /*
|
|
jpayne@69
|
12084 ** CAPI3REF: Delete A Changegroup Object
|
|
jpayne@69
|
12085 ** DESTRUCTOR: sqlite3_changegroup
|
|
jpayne@69
|
12086 */
|
|
jpayne@69
|
12087 SQLITE_API void sqlite3changegroup_delete(sqlite3_changegroup*);
|
|
jpayne@69
|
12088
|
|
jpayne@69
|
12089 /*
|
|
jpayne@69
|
12090 ** CAPI3REF: Apply A Changeset To A Database
|
|
jpayne@69
|
12091 **
|
|
jpayne@69
|
12092 ** Apply a changeset or patchset to a database. These functions attempt to
|
|
jpayne@69
|
12093 ** update the "main" database attached to handle db with the changes found in
|
|
jpayne@69
|
12094 ** the changeset passed via the second and third arguments.
|
|
jpayne@69
|
12095 **
|
|
jpayne@69
|
12096 ** The fourth argument (xFilter) passed to these functions is the "filter
|
|
jpayne@69
|
12097 ** callback". If it is not NULL, then for each table affected by at least one
|
|
jpayne@69
|
12098 ** change in the changeset, the filter callback is invoked with
|
|
jpayne@69
|
12099 ** the table name as the second argument, and a copy of the context pointer
|
|
jpayne@69
|
12100 ** passed as the sixth argument as the first. If the "filter callback"
|
|
jpayne@69
|
12101 ** returns zero, then no attempt is made to apply any changes to the table.
|
|
jpayne@69
|
12102 ** Otherwise, if the return value is non-zero or the xFilter argument to
|
|
jpayne@69
|
12103 ** is NULL, all changes related to the table are attempted.
|
|
jpayne@69
|
12104 **
|
|
jpayne@69
|
12105 ** For each table that is not excluded by the filter callback, this function
|
|
jpayne@69
|
12106 ** tests that the target database contains a compatible table. A table is
|
|
jpayne@69
|
12107 ** considered compatible if all of the following are true:
|
|
jpayne@69
|
12108 **
|
|
jpayne@69
|
12109 ** <ul>
|
|
jpayne@69
|
12110 ** <li> The table has the same name as the name recorded in the
|
|
jpayne@69
|
12111 ** changeset, and
|
|
jpayne@69
|
12112 ** <li> The table has at least as many columns as recorded in the
|
|
jpayne@69
|
12113 ** changeset, and
|
|
jpayne@69
|
12114 ** <li> The table has primary key columns in the same position as
|
|
jpayne@69
|
12115 ** recorded in the changeset.
|
|
jpayne@69
|
12116 ** </ul>
|
|
jpayne@69
|
12117 **
|
|
jpayne@69
|
12118 ** If there is no compatible table, it is not an error, but none of the
|
|
jpayne@69
|
12119 ** changes associated with the table are applied. A warning message is issued
|
|
jpayne@69
|
12120 ** via the sqlite3_log() mechanism with the error code SQLITE_SCHEMA. At most
|
|
jpayne@69
|
12121 ** one such warning is issued for each table in the changeset.
|
|
jpayne@69
|
12122 **
|
|
jpayne@69
|
12123 ** For each change for which there is a compatible table, an attempt is made
|
|
jpayne@69
|
12124 ** to modify the table contents according to the UPDATE, INSERT or DELETE
|
|
jpayne@69
|
12125 ** change. If a change cannot be applied cleanly, the conflict handler
|
|
jpayne@69
|
12126 ** function passed as the fifth argument to sqlite3changeset_apply() may be
|
|
jpayne@69
|
12127 ** invoked. A description of exactly when the conflict handler is invoked for
|
|
jpayne@69
|
12128 ** each type of change is below.
|
|
jpayne@69
|
12129 **
|
|
jpayne@69
|
12130 ** Unlike the xFilter argument, xConflict may not be passed NULL. The results
|
|
jpayne@69
|
12131 ** of passing anything other than a valid function pointer as the xConflict
|
|
jpayne@69
|
12132 ** argument are undefined.
|
|
jpayne@69
|
12133 **
|
|
jpayne@69
|
12134 ** Each time the conflict handler function is invoked, it must return one
|
|
jpayne@69
|
12135 ** of [SQLITE_CHANGESET_OMIT], [SQLITE_CHANGESET_ABORT] or
|
|
jpayne@69
|
12136 ** [SQLITE_CHANGESET_REPLACE]. SQLITE_CHANGESET_REPLACE may only be returned
|
|
jpayne@69
|
12137 ** if the second argument passed to the conflict handler is either
|
|
jpayne@69
|
12138 ** SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If the conflict-handler
|
|
jpayne@69
|
12139 ** returns an illegal value, any changes already made are rolled back and
|
|
jpayne@69
|
12140 ** the call to sqlite3changeset_apply() returns SQLITE_MISUSE. Different
|
|
jpayne@69
|
12141 ** actions are taken by sqlite3changeset_apply() depending on the value
|
|
jpayne@69
|
12142 ** returned by each invocation of the conflict-handler function. Refer to
|
|
jpayne@69
|
12143 ** the documentation for the three
|
|
jpayne@69
|
12144 ** [SQLITE_CHANGESET_OMIT|available return values] for details.
|
|
jpayne@69
|
12145 **
|
|
jpayne@69
|
12146 ** <dl>
|
|
jpayne@69
|
12147 ** <dt>DELETE Changes<dd>
|
|
jpayne@69
|
12148 ** For each DELETE change, the function checks if the target database
|
|
jpayne@69
|
12149 ** contains a row with the same primary key value (or values) as the
|
|
jpayne@69
|
12150 ** original row values stored in the changeset. If it does, and the values
|
|
jpayne@69
|
12151 ** stored in all non-primary key columns also match the values stored in
|
|
jpayne@69
|
12152 ** the changeset the row is deleted from the target database.
|
|
jpayne@69
|
12153 **
|
|
jpayne@69
|
12154 ** If a row with matching primary key values is found, but one or more of
|
|
jpayne@69
|
12155 ** the non-primary key fields contains a value different from the original
|
|
jpayne@69
|
12156 ** row value stored in the changeset, the conflict-handler function is
|
|
jpayne@69
|
12157 ** invoked with [SQLITE_CHANGESET_DATA] as the second argument. If the
|
|
jpayne@69
|
12158 ** database table has more columns than are recorded in the changeset,
|
|
jpayne@69
|
12159 ** only the values of those non-primary key fields are compared against
|
|
jpayne@69
|
12160 ** the current database contents - any trailing database table columns
|
|
jpayne@69
|
12161 ** are ignored.
|
|
jpayne@69
|
12162 **
|
|
jpayne@69
|
12163 ** If no row with matching primary key values is found in the database,
|
|
jpayne@69
|
12164 ** the conflict-handler function is invoked with [SQLITE_CHANGESET_NOTFOUND]
|
|
jpayne@69
|
12165 ** passed as the second argument.
|
|
jpayne@69
|
12166 **
|
|
jpayne@69
|
12167 ** If the DELETE operation is attempted, but SQLite returns SQLITE_CONSTRAINT
|
|
jpayne@69
|
12168 ** (which can only happen if a foreign key constraint is violated), the
|
|
jpayne@69
|
12169 ** conflict-handler function is invoked with [SQLITE_CHANGESET_CONSTRAINT]
|
|
jpayne@69
|
12170 ** passed as the second argument. This includes the case where the DELETE
|
|
jpayne@69
|
12171 ** operation is attempted because an earlier call to the conflict handler
|
|
jpayne@69
|
12172 ** function returned [SQLITE_CHANGESET_REPLACE].
|
|
jpayne@69
|
12173 **
|
|
jpayne@69
|
12174 ** <dt>INSERT Changes<dd>
|
|
jpayne@69
|
12175 ** For each INSERT change, an attempt is made to insert the new row into
|
|
jpayne@69
|
12176 ** the database. If the changeset row contains fewer fields than the
|
|
jpayne@69
|
12177 ** database table, the trailing fields are populated with their default
|
|
jpayne@69
|
12178 ** values.
|
|
jpayne@69
|
12179 **
|
|
jpayne@69
|
12180 ** If the attempt to insert the row fails because the database already
|
|
jpayne@69
|
12181 ** contains a row with the same primary key values, the conflict handler
|
|
jpayne@69
|
12182 ** function is invoked with the second argument set to
|
|
jpayne@69
|
12183 ** [SQLITE_CHANGESET_CONFLICT].
|
|
jpayne@69
|
12184 **
|
|
jpayne@69
|
12185 ** If the attempt to insert the row fails because of some other constraint
|
|
jpayne@69
|
12186 ** violation (e.g. NOT NULL or UNIQUE), the conflict handler function is
|
|
jpayne@69
|
12187 ** invoked with the second argument set to [SQLITE_CHANGESET_CONSTRAINT].
|
|
jpayne@69
|
12188 ** This includes the case where the INSERT operation is re-attempted because
|
|
jpayne@69
|
12189 ** an earlier call to the conflict handler function returned
|
|
jpayne@69
|
12190 ** [SQLITE_CHANGESET_REPLACE].
|
|
jpayne@69
|
12191 **
|
|
jpayne@69
|
12192 ** <dt>UPDATE Changes<dd>
|
|
jpayne@69
|
12193 ** For each UPDATE change, the function checks if the target database
|
|
jpayne@69
|
12194 ** contains a row with the same primary key value (or values) as the
|
|
jpayne@69
|
12195 ** original row values stored in the changeset. If it does, and the values
|
|
jpayne@69
|
12196 ** stored in all modified non-primary key columns also match the values
|
|
jpayne@69
|
12197 ** stored in the changeset the row is updated within the target database.
|
|
jpayne@69
|
12198 **
|
|
jpayne@69
|
12199 ** If a row with matching primary key values is found, but one or more of
|
|
jpayne@69
|
12200 ** the modified non-primary key fields contains a value different from an
|
|
jpayne@69
|
12201 ** original row value stored in the changeset, the conflict-handler function
|
|
jpayne@69
|
12202 ** is invoked with [SQLITE_CHANGESET_DATA] as the second argument. Since
|
|
jpayne@69
|
12203 ** UPDATE changes only contain values for non-primary key fields that are
|
|
jpayne@69
|
12204 ** to be modified, only those fields need to match the original values to
|
|
jpayne@69
|
12205 ** avoid the SQLITE_CHANGESET_DATA conflict-handler callback.
|
|
jpayne@69
|
12206 **
|
|
jpayne@69
|
12207 ** If no row with matching primary key values is found in the database,
|
|
jpayne@69
|
12208 ** the conflict-handler function is invoked with [SQLITE_CHANGESET_NOTFOUND]
|
|
jpayne@69
|
12209 ** passed as the second argument.
|
|
jpayne@69
|
12210 **
|
|
jpayne@69
|
12211 ** If the UPDATE operation is attempted, but SQLite returns
|
|
jpayne@69
|
12212 ** SQLITE_CONSTRAINT, the conflict-handler function is invoked with
|
|
jpayne@69
|
12213 ** [SQLITE_CHANGESET_CONSTRAINT] passed as the second argument.
|
|
jpayne@69
|
12214 ** This includes the case where the UPDATE operation is attempted after
|
|
jpayne@69
|
12215 ** an earlier call to the conflict handler function returned
|
|
jpayne@69
|
12216 ** [SQLITE_CHANGESET_REPLACE].
|
|
jpayne@69
|
12217 ** </dl>
|
|
jpayne@69
|
12218 **
|
|
jpayne@69
|
12219 ** It is safe to execute SQL statements, including those that write to the
|
|
jpayne@69
|
12220 ** table that the callback related to, from within the xConflict callback.
|
|
jpayne@69
|
12221 ** This can be used to further customize the application's conflict
|
|
jpayne@69
|
12222 ** resolution strategy.
|
|
jpayne@69
|
12223 **
|
|
jpayne@69
|
12224 ** All changes made by these functions are enclosed in a savepoint transaction.
|
|
jpayne@69
|
12225 ** If any other error (aside from a constraint failure when attempting to
|
|
jpayne@69
|
12226 ** write to the target database) occurs, then the savepoint transaction is
|
|
jpayne@69
|
12227 ** rolled back, restoring the target database to its original state, and an
|
|
jpayne@69
|
12228 ** SQLite error code returned.
|
|
jpayne@69
|
12229 **
|
|
jpayne@69
|
12230 ** If the output parameters (ppRebase) and (pnRebase) are non-NULL and
|
|
jpayne@69
|
12231 ** the input is a changeset (not a patchset), then sqlite3changeset_apply_v2()
|
|
jpayne@69
|
12232 ** may set (*ppRebase) to point to a "rebase" that may be used with the
|
|
jpayne@69
|
12233 ** sqlite3_rebaser APIs buffer before returning. In this case (*pnRebase)
|
|
jpayne@69
|
12234 ** is set to the size of the buffer in bytes. It is the responsibility of the
|
|
jpayne@69
|
12235 ** caller to eventually free any such buffer using sqlite3_free(). The buffer
|
|
jpayne@69
|
12236 ** is only allocated and populated if one or more conflicts were encountered
|
|
jpayne@69
|
12237 ** while applying the patchset. See comments surrounding the sqlite3_rebaser
|
|
jpayne@69
|
12238 ** APIs for further details.
|
|
jpayne@69
|
12239 **
|
|
jpayne@69
|
12240 ** The behavior of sqlite3changeset_apply_v2() and its streaming equivalent
|
|
jpayne@69
|
12241 ** may be modified by passing a combination of
|
|
jpayne@69
|
12242 ** [SQLITE_CHANGESETAPPLY_NOSAVEPOINT | supported flags] as the 9th parameter.
|
|
jpayne@69
|
12243 **
|
|
jpayne@69
|
12244 ** Note that the sqlite3changeset_apply_v2() API is still <b>experimental</b>
|
|
jpayne@69
|
12245 ** and therefore subject to change.
|
|
jpayne@69
|
12246 */
|
|
jpayne@69
|
12247 SQLITE_API int sqlite3changeset_apply(
|
|
jpayne@69
|
12248 sqlite3 *db, /* Apply change to "main" db of this handle */
|
|
jpayne@69
|
12249 int nChangeset, /* Size of changeset in bytes */
|
|
jpayne@69
|
12250 void *pChangeset, /* Changeset blob */
|
|
jpayne@69
|
12251 int(*xFilter)(
|
|
jpayne@69
|
12252 void *pCtx, /* Copy of sixth arg to _apply() */
|
|
jpayne@69
|
12253 const char *zTab /* Table name */
|
|
jpayne@69
|
12254 ),
|
|
jpayne@69
|
12255 int(*xConflict)(
|
|
jpayne@69
|
12256 void *pCtx, /* Copy of sixth arg to _apply() */
|
|
jpayne@69
|
12257 int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
|
|
jpayne@69
|
12258 sqlite3_changeset_iter *p /* Handle describing change and conflict */
|
|
jpayne@69
|
12259 ),
|
|
jpayne@69
|
12260 void *pCtx /* First argument passed to xConflict */
|
|
jpayne@69
|
12261 );
|
|
jpayne@69
|
12262 SQLITE_API int sqlite3changeset_apply_v2(
|
|
jpayne@69
|
12263 sqlite3 *db, /* Apply change to "main" db of this handle */
|
|
jpayne@69
|
12264 int nChangeset, /* Size of changeset in bytes */
|
|
jpayne@69
|
12265 void *pChangeset, /* Changeset blob */
|
|
jpayne@69
|
12266 int(*xFilter)(
|
|
jpayne@69
|
12267 void *pCtx, /* Copy of sixth arg to _apply() */
|
|
jpayne@69
|
12268 const char *zTab /* Table name */
|
|
jpayne@69
|
12269 ),
|
|
jpayne@69
|
12270 int(*xConflict)(
|
|
jpayne@69
|
12271 void *pCtx, /* Copy of sixth arg to _apply() */
|
|
jpayne@69
|
12272 int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
|
|
jpayne@69
|
12273 sqlite3_changeset_iter *p /* Handle describing change and conflict */
|
|
jpayne@69
|
12274 ),
|
|
jpayne@69
|
12275 void *pCtx, /* First argument passed to xConflict */
|
|
jpayne@69
|
12276 void **ppRebase, int *pnRebase, /* OUT: Rebase data */
|
|
jpayne@69
|
12277 int flags /* SESSION_CHANGESETAPPLY_* flags */
|
|
jpayne@69
|
12278 );
|
|
jpayne@69
|
12279
|
|
jpayne@69
|
12280 /*
|
|
jpayne@69
|
12281 ** CAPI3REF: Flags for sqlite3changeset_apply_v2
|
|
jpayne@69
|
12282 **
|
|
jpayne@69
|
12283 ** The following flags may passed via the 9th parameter to
|
|
jpayne@69
|
12284 ** [sqlite3changeset_apply_v2] and [sqlite3changeset_apply_v2_strm]:
|
|
jpayne@69
|
12285 **
|
|
jpayne@69
|
12286 ** <dl>
|
|
jpayne@69
|
12287 ** <dt>SQLITE_CHANGESETAPPLY_NOSAVEPOINT <dd>
|
|
jpayne@69
|
12288 ** Usually, the sessions module encloses all operations performed by
|
|
jpayne@69
|
12289 ** a single call to apply_v2() or apply_v2_strm() in a [SAVEPOINT]. The
|
|
jpayne@69
|
12290 ** SAVEPOINT is committed if the changeset or patchset is successfully
|
|
jpayne@69
|
12291 ** applied, or rolled back if an error occurs. Specifying this flag
|
|
jpayne@69
|
12292 ** causes the sessions module to omit this savepoint. In this case, if the
|
|
jpayne@69
|
12293 ** caller has an open transaction or savepoint when apply_v2() is called,
|
|
jpayne@69
|
12294 ** it may revert the partially applied changeset by rolling it back.
|
|
jpayne@69
|
12295 **
|
|
jpayne@69
|
12296 ** <dt>SQLITE_CHANGESETAPPLY_INVERT <dd>
|
|
jpayne@69
|
12297 ** Invert the changeset before applying it. This is equivalent to inverting
|
|
jpayne@69
|
12298 ** a changeset using sqlite3changeset_invert() before applying it. It is
|
|
jpayne@69
|
12299 ** an error to specify this flag with a patchset.
|
|
jpayne@69
|
12300 **
|
|
jpayne@69
|
12301 ** <dt>SQLITE_CHANGESETAPPLY_IGNORENOOP <dd>
|
|
jpayne@69
|
12302 ** Do not invoke the conflict handler callback for any changes that
|
|
jpayne@69
|
12303 ** would not actually modify the database even if they were applied.
|
|
jpayne@69
|
12304 ** Specifically, this means that the conflict handler is not invoked
|
|
jpayne@69
|
12305 ** for:
|
|
jpayne@69
|
12306 ** <ul>
|
|
jpayne@69
|
12307 ** <li>a delete change if the row being deleted cannot be found,
|
|
jpayne@69
|
12308 ** <li>an update change if the modified fields are already set to
|
|
jpayne@69
|
12309 ** their new values in the conflicting row, or
|
|
jpayne@69
|
12310 ** <li>an insert change if all fields of the conflicting row match
|
|
jpayne@69
|
12311 ** the row being inserted.
|
|
jpayne@69
|
12312 ** </ul>
|
|
jpayne@69
|
12313 **
|
|
jpayne@69
|
12314 ** <dt>SQLITE_CHANGESETAPPLY_FKNOACTION <dd>
|
|
jpayne@69
|
12315 ** If this flag it set, then all foreign key constraints in the target
|
|
jpayne@69
|
12316 ** database behave as if they were declared with "ON UPDATE NO ACTION ON
|
|
jpayne@69
|
12317 ** DELETE NO ACTION", even if they are actually CASCADE, RESTRICT, SET NULL
|
|
jpayne@69
|
12318 ** or SET DEFAULT.
|
|
jpayne@69
|
12319 */
|
|
jpayne@69
|
12320 #define SQLITE_CHANGESETAPPLY_NOSAVEPOINT 0x0001
|
|
jpayne@69
|
12321 #define SQLITE_CHANGESETAPPLY_INVERT 0x0002
|
|
jpayne@69
|
12322 #define SQLITE_CHANGESETAPPLY_IGNORENOOP 0x0004
|
|
jpayne@69
|
12323 #define SQLITE_CHANGESETAPPLY_FKNOACTION 0x0008
|
|
jpayne@69
|
12324
|
|
jpayne@69
|
12325 /*
|
|
jpayne@69
|
12326 ** CAPI3REF: Constants Passed To The Conflict Handler
|
|
jpayne@69
|
12327 **
|
|
jpayne@69
|
12328 ** Values that may be passed as the second argument to a conflict-handler.
|
|
jpayne@69
|
12329 **
|
|
jpayne@69
|
12330 ** <dl>
|
|
jpayne@69
|
12331 ** <dt>SQLITE_CHANGESET_DATA<dd>
|
|
jpayne@69
|
12332 ** The conflict handler is invoked with CHANGESET_DATA as the second argument
|
|
jpayne@69
|
12333 ** when processing a DELETE or UPDATE change if a row with the required
|
|
jpayne@69
|
12334 ** PRIMARY KEY fields is present in the database, but one or more other
|
|
jpayne@69
|
12335 ** (non primary-key) fields modified by the update do not contain the
|
|
jpayne@69
|
12336 ** expected "before" values.
|
|
jpayne@69
|
12337 **
|
|
jpayne@69
|
12338 ** The conflicting row, in this case, is the database row with the matching
|
|
jpayne@69
|
12339 ** primary key.
|
|
jpayne@69
|
12340 **
|
|
jpayne@69
|
12341 ** <dt>SQLITE_CHANGESET_NOTFOUND<dd>
|
|
jpayne@69
|
12342 ** The conflict handler is invoked with CHANGESET_NOTFOUND as the second
|
|
jpayne@69
|
12343 ** argument when processing a DELETE or UPDATE change if a row with the
|
|
jpayne@69
|
12344 ** required PRIMARY KEY fields is not present in the database.
|
|
jpayne@69
|
12345 **
|
|
jpayne@69
|
12346 ** There is no conflicting row in this case. The results of invoking the
|
|
jpayne@69
|
12347 ** sqlite3changeset_conflict() API are undefined.
|
|
jpayne@69
|
12348 **
|
|
jpayne@69
|
12349 ** <dt>SQLITE_CHANGESET_CONFLICT<dd>
|
|
jpayne@69
|
12350 ** CHANGESET_CONFLICT is passed as the second argument to the conflict
|
|
jpayne@69
|
12351 ** handler while processing an INSERT change if the operation would result
|
|
jpayne@69
|
12352 ** in duplicate primary key values.
|
|
jpayne@69
|
12353 **
|
|
jpayne@69
|
12354 ** The conflicting row in this case is the database row with the matching
|
|
jpayne@69
|
12355 ** primary key.
|
|
jpayne@69
|
12356 **
|
|
jpayne@69
|
12357 ** <dt>SQLITE_CHANGESET_FOREIGN_KEY<dd>
|
|
jpayne@69
|
12358 ** If foreign key handling is enabled, and applying a changeset leaves the
|
|
jpayne@69
|
12359 ** database in a state containing foreign key violations, the conflict
|
|
jpayne@69
|
12360 ** handler is invoked with CHANGESET_FOREIGN_KEY as the second argument
|
|
jpayne@69
|
12361 ** exactly once before the changeset is committed. If the conflict handler
|
|
jpayne@69
|
12362 ** returns CHANGESET_OMIT, the changes, including those that caused the
|
|
jpayne@69
|
12363 ** foreign key constraint violation, are committed. Or, if it returns
|
|
jpayne@69
|
12364 ** CHANGESET_ABORT, the changeset is rolled back.
|
|
jpayne@69
|
12365 **
|
|
jpayne@69
|
12366 ** No current or conflicting row information is provided. The only function
|
|
jpayne@69
|
12367 ** it is possible to call on the supplied sqlite3_changeset_iter handle
|
|
jpayne@69
|
12368 ** is sqlite3changeset_fk_conflicts().
|
|
jpayne@69
|
12369 **
|
|
jpayne@69
|
12370 ** <dt>SQLITE_CHANGESET_CONSTRAINT<dd>
|
|
jpayne@69
|
12371 ** If any other constraint violation occurs while applying a change (i.e.
|
|
jpayne@69
|
12372 ** a UNIQUE, CHECK or NOT NULL constraint), the conflict handler is
|
|
jpayne@69
|
12373 ** invoked with CHANGESET_CONSTRAINT as the second argument.
|
|
jpayne@69
|
12374 **
|
|
jpayne@69
|
12375 ** There is no conflicting row in this case. The results of invoking the
|
|
jpayne@69
|
12376 ** sqlite3changeset_conflict() API are undefined.
|
|
jpayne@69
|
12377 **
|
|
jpayne@69
|
12378 ** </dl>
|
|
jpayne@69
|
12379 */
|
|
jpayne@69
|
12380 #define SQLITE_CHANGESET_DATA 1
|
|
jpayne@69
|
12381 #define SQLITE_CHANGESET_NOTFOUND 2
|
|
jpayne@69
|
12382 #define SQLITE_CHANGESET_CONFLICT 3
|
|
jpayne@69
|
12383 #define SQLITE_CHANGESET_CONSTRAINT 4
|
|
jpayne@69
|
12384 #define SQLITE_CHANGESET_FOREIGN_KEY 5
|
|
jpayne@69
|
12385
|
|
jpayne@69
|
12386 /*
|
|
jpayne@69
|
12387 ** CAPI3REF: Constants Returned By The Conflict Handler
|
|
jpayne@69
|
12388 **
|
|
jpayne@69
|
12389 ** A conflict handler callback must return one of the following three values.
|
|
jpayne@69
|
12390 **
|
|
jpayne@69
|
12391 ** <dl>
|
|
jpayne@69
|
12392 ** <dt>SQLITE_CHANGESET_OMIT<dd>
|
|
jpayne@69
|
12393 ** If a conflict handler returns this value no special action is taken. The
|
|
jpayne@69
|
12394 ** change that caused the conflict is not applied. The session module
|
|
jpayne@69
|
12395 ** continues to the next change in the changeset.
|
|
jpayne@69
|
12396 **
|
|
jpayne@69
|
12397 ** <dt>SQLITE_CHANGESET_REPLACE<dd>
|
|
jpayne@69
|
12398 ** This value may only be returned if the second argument to the conflict
|
|
jpayne@69
|
12399 ** handler was SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If this
|
|
jpayne@69
|
12400 ** is not the case, any changes applied so far are rolled back and the
|
|
jpayne@69
|
12401 ** call to sqlite3changeset_apply() returns SQLITE_MISUSE.
|
|
jpayne@69
|
12402 **
|
|
jpayne@69
|
12403 ** If CHANGESET_REPLACE is returned by an SQLITE_CHANGESET_DATA conflict
|
|
jpayne@69
|
12404 ** handler, then the conflicting row is either updated or deleted, depending
|
|
jpayne@69
|
12405 ** on the type of change.
|
|
jpayne@69
|
12406 **
|
|
jpayne@69
|
12407 ** If CHANGESET_REPLACE is returned by an SQLITE_CHANGESET_CONFLICT conflict
|
|
jpayne@69
|
12408 ** handler, then the conflicting row is removed from the database and a
|
|
jpayne@69
|
12409 ** second attempt to apply the change is made. If this second attempt fails,
|
|
jpayne@69
|
12410 ** the original row is restored to the database before continuing.
|
|
jpayne@69
|
12411 **
|
|
jpayne@69
|
12412 ** <dt>SQLITE_CHANGESET_ABORT<dd>
|
|
jpayne@69
|
12413 ** If this value is returned, any changes applied so far are rolled back
|
|
jpayne@69
|
12414 ** and the call to sqlite3changeset_apply() returns SQLITE_ABORT.
|
|
jpayne@69
|
12415 ** </dl>
|
|
jpayne@69
|
12416 */
|
|
jpayne@69
|
12417 #define SQLITE_CHANGESET_OMIT 0
|
|
jpayne@69
|
12418 #define SQLITE_CHANGESET_REPLACE 1
|
|
jpayne@69
|
12419 #define SQLITE_CHANGESET_ABORT 2
|
|
jpayne@69
|
12420
|
|
jpayne@69
|
12421 /*
|
|
jpayne@69
|
12422 ** CAPI3REF: Rebasing changesets
|
|
jpayne@69
|
12423 ** EXPERIMENTAL
|
|
jpayne@69
|
12424 **
|
|
jpayne@69
|
12425 ** Suppose there is a site hosting a database in state S0. And that
|
|
jpayne@69
|
12426 ** modifications are made that move that database to state S1 and a
|
|
jpayne@69
|
12427 ** changeset recorded (the "local" changeset). Then, a changeset based
|
|
jpayne@69
|
12428 ** on S0 is received from another site (the "remote" changeset) and
|
|
jpayne@69
|
12429 ** applied to the database. The database is then in state
|
|
jpayne@69
|
12430 ** (S1+"remote"), where the exact state depends on any conflict
|
|
jpayne@69
|
12431 ** resolution decisions (OMIT or REPLACE) made while applying "remote".
|
|
jpayne@69
|
12432 ** Rebasing a changeset is to update it to take those conflict
|
|
jpayne@69
|
12433 ** resolution decisions into account, so that the same conflicts
|
|
jpayne@69
|
12434 ** do not have to be resolved elsewhere in the network.
|
|
jpayne@69
|
12435 **
|
|
jpayne@69
|
12436 ** For example, if both the local and remote changesets contain an
|
|
jpayne@69
|
12437 ** INSERT of the same key on "CREATE TABLE t1(a PRIMARY KEY, b)":
|
|
jpayne@69
|
12438 **
|
|
jpayne@69
|
12439 ** local: INSERT INTO t1 VALUES(1, 'v1');
|
|
jpayne@69
|
12440 ** remote: INSERT INTO t1 VALUES(1, 'v2');
|
|
jpayne@69
|
12441 **
|
|
jpayne@69
|
12442 ** and the conflict resolution is REPLACE, then the INSERT change is
|
|
jpayne@69
|
12443 ** removed from the local changeset (it was overridden). Or, if the
|
|
jpayne@69
|
12444 ** conflict resolution was "OMIT", then the local changeset is modified
|
|
jpayne@69
|
12445 ** to instead contain:
|
|
jpayne@69
|
12446 **
|
|
jpayne@69
|
12447 ** UPDATE t1 SET b = 'v2' WHERE a=1;
|
|
jpayne@69
|
12448 **
|
|
jpayne@69
|
12449 ** Changes within the local changeset are rebased as follows:
|
|
jpayne@69
|
12450 **
|
|
jpayne@69
|
12451 ** <dl>
|
|
jpayne@69
|
12452 ** <dt>Local INSERT<dd>
|
|
jpayne@69
|
12453 ** This may only conflict with a remote INSERT. If the conflict
|
|
jpayne@69
|
12454 ** resolution was OMIT, then add an UPDATE change to the rebased
|
|
jpayne@69
|
12455 ** changeset. Or, if the conflict resolution was REPLACE, add
|
|
jpayne@69
|
12456 ** nothing to the rebased changeset.
|
|
jpayne@69
|
12457 **
|
|
jpayne@69
|
12458 ** <dt>Local DELETE<dd>
|
|
jpayne@69
|
12459 ** This may conflict with a remote UPDATE or DELETE. In both cases the
|
|
jpayne@69
|
12460 ** only possible resolution is OMIT. If the remote operation was a
|
|
jpayne@69
|
12461 ** DELETE, then add no change to the rebased changeset. If the remote
|
|
jpayne@69
|
12462 ** operation was an UPDATE, then the old.* fields of change are updated
|
|
jpayne@69
|
12463 ** to reflect the new.* values in the UPDATE.
|
|
jpayne@69
|
12464 **
|
|
jpayne@69
|
12465 ** <dt>Local UPDATE<dd>
|
|
jpayne@69
|
12466 ** This may conflict with a remote UPDATE or DELETE. If it conflicts
|
|
jpayne@69
|
12467 ** with a DELETE, and the conflict resolution was OMIT, then the update
|
|
jpayne@69
|
12468 ** is changed into an INSERT. Any undefined values in the new.* record
|
|
jpayne@69
|
12469 ** from the update change are filled in using the old.* values from
|
|
jpayne@69
|
12470 ** the conflicting DELETE. Or, if the conflict resolution was REPLACE,
|
|
jpayne@69
|
12471 ** the UPDATE change is simply omitted from the rebased changeset.
|
|
jpayne@69
|
12472 **
|
|
jpayne@69
|
12473 ** If conflict is with a remote UPDATE and the resolution is OMIT, then
|
|
jpayne@69
|
12474 ** the old.* values are rebased using the new.* values in the remote
|
|
jpayne@69
|
12475 ** change. Or, if the resolution is REPLACE, then the change is copied
|
|
jpayne@69
|
12476 ** into the rebased changeset with updates to columns also updated by
|
|
jpayne@69
|
12477 ** the conflicting remote UPDATE removed. If this means no columns would
|
|
jpayne@69
|
12478 ** be updated, the change is omitted.
|
|
jpayne@69
|
12479 ** </dl>
|
|
jpayne@69
|
12480 **
|
|
jpayne@69
|
12481 ** A local change may be rebased against multiple remote changes
|
|
jpayne@69
|
12482 ** simultaneously. If a single key is modified by multiple remote
|
|
jpayne@69
|
12483 ** changesets, they are combined as follows before the local changeset
|
|
jpayne@69
|
12484 ** is rebased:
|
|
jpayne@69
|
12485 **
|
|
jpayne@69
|
12486 ** <ul>
|
|
jpayne@69
|
12487 ** <li> If there has been one or more REPLACE resolutions on a
|
|
jpayne@69
|
12488 ** key, it is rebased according to a REPLACE.
|
|
jpayne@69
|
12489 **
|
|
jpayne@69
|
12490 ** <li> If there have been no REPLACE resolutions on a key, then
|
|
jpayne@69
|
12491 ** the local changeset is rebased according to the most recent
|
|
jpayne@69
|
12492 ** of the OMIT resolutions.
|
|
jpayne@69
|
12493 ** </ul>
|
|
jpayne@69
|
12494 **
|
|
jpayne@69
|
12495 ** Note that conflict resolutions from multiple remote changesets are
|
|
jpayne@69
|
12496 ** combined on a per-field basis, not per-row. This means that in the
|
|
jpayne@69
|
12497 ** case of multiple remote UPDATE operations, some fields of a single
|
|
jpayne@69
|
12498 ** local change may be rebased for REPLACE while others are rebased for
|
|
jpayne@69
|
12499 ** OMIT.
|
|
jpayne@69
|
12500 **
|
|
jpayne@69
|
12501 ** In order to rebase a local changeset, the remote changeset must first
|
|
jpayne@69
|
12502 ** be applied to the local database using sqlite3changeset_apply_v2() and
|
|
jpayne@69
|
12503 ** the buffer of rebase information captured. Then:
|
|
jpayne@69
|
12504 **
|
|
jpayne@69
|
12505 ** <ol>
|
|
jpayne@69
|
12506 ** <li> An sqlite3_rebaser object is created by calling
|
|
jpayne@69
|
12507 ** sqlite3rebaser_create().
|
|
jpayne@69
|
12508 ** <li> The new object is configured with the rebase buffer obtained from
|
|
jpayne@69
|
12509 ** sqlite3changeset_apply_v2() by calling sqlite3rebaser_configure().
|
|
jpayne@69
|
12510 ** If the local changeset is to be rebased against multiple remote
|
|
jpayne@69
|
12511 ** changesets, then sqlite3rebaser_configure() should be called
|
|
jpayne@69
|
12512 ** multiple times, in the same order that the multiple
|
|
jpayne@69
|
12513 ** sqlite3changeset_apply_v2() calls were made.
|
|
jpayne@69
|
12514 ** <li> Each local changeset is rebased by calling sqlite3rebaser_rebase().
|
|
jpayne@69
|
12515 ** <li> The sqlite3_rebaser object is deleted by calling
|
|
jpayne@69
|
12516 ** sqlite3rebaser_delete().
|
|
jpayne@69
|
12517 ** </ol>
|
|
jpayne@69
|
12518 */
|
|
jpayne@69
|
12519 typedef struct sqlite3_rebaser sqlite3_rebaser;
|
|
jpayne@69
|
12520
|
|
jpayne@69
|
12521 /*
|
|
jpayne@69
|
12522 ** CAPI3REF: Create a changeset rebaser object.
|
|
jpayne@69
|
12523 ** EXPERIMENTAL
|
|
jpayne@69
|
12524 **
|
|
jpayne@69
|
12525 ** Allocate a new changeset rebaser object. If successful, set (*ppNew) to
|
|
jpayne@69
|
12526 ** point to the new object and return SQLITE_OK. Otherwise, if an error
|
|
jpayne@69
|
12527 ** occurs, return an SQLite error code (e.g. SQLITE_NOMEM) and set (*ppNew)
|
|
jpayne@69
|
12528 ** to NULL.
|
|
jpayne@69
|
12529 */
|
|
jpayne@69
|
12530 SQLITE_API int sqlite3rebaser_create(sqlite3_rebaser **ppNew);
|
|
jpayne@69
|
12531
|
|
jpayne@69
|
12532 /*
|
|
jpayne@69
|
12533 ** CAPI3REF: Configure a changeset rebaser object.
|
|
jpayne@69
|
12534 ** EXPERIMENTAL
|
|
jpayne@69
|
12535 **
|
|
jpayne@69
|
12536 ** Configure the changeset rebaser object to rebase changesets according
|
|
jpayne@69
|
12537 ** to the conflict resolutions described by buffer pRebase (size nRebase
|
|
jpayne@69
|
12538 ** bytes), which must have been obtained from a previous call to
|
|
jpayne@69
|
12539 ** sqlite3changeset_apply_v2().
|
|
jpayne@69
|
12540 */
|
|
jpayne@69
|
12541 SQLITE_API int sqlite3rebaser_configure(
|
|
jpayne@69
|
12542 sqlite3_rebaser*,
|
|
jpayne@69
|
12543 int nRebase, const void *pRebase
|
|
jpayne@69
|
12544 );
|
|
jpayne@69
|
12545
|
|
jpayne@69
|
12546 /*
|
|
jpayne@69
|
12547 ** CAPI3REF: Rebase a changeset
|
|
jpayne@69
|
12548 ** EXPERIMENTAL
|
|
jpayne@69
|
12549 **
|
|
jpayne@69
|
12550 ** Argument pIn must point to a buffer containing a changeset nIn bytes
|
|
jpayne@69
|
12551 ** in size. This function allocates and populates a buffer with a copy
|
|
jpayne@69
|
12552 ** of the changeset rebased according to the configuration of the
|
|
jpayne@69
|
12553 ** rebaser object passed as the first argument. If successful, (*ppOut)
|
|
jpayne@69
|
12554 ** is set to point to the new buffer containing the rebased changeset and
|
|
jpayne@69
|
12555 ** (*pnOut) to its size in bytes and SQLITE_OK returned. It is the
|
|
jpayne@69
|
12556 ** responsibility of the caller to eventually free the new buffer using
|
|
jpayne@69
|
12557 ** sqlite3_free(). Otherwise, if an error occurs, (*ppOut) and (*pnOut)
|
|
jpayne@69
|
12558 ** are set to zero and an SQLite error code returned.
|
|
jpayne@69
|
12559 */
|
|
jpayne@69
|
12560 SQLITE_API int sqlite3rebaser_rebase(
|
|
jpayne@69
|
12561 sqlite3_rebaser*,
|
|
jpayne@69
|
12562 int nIn, const void *pIn,
|
|
jpayne@69
|
12563 int *pnOut, void **ppOut
|
|
jpayne@69
|
12564 );
|
|
jpayne@69
|
12565
|
|
jpayne@69
|
12566 /*
|
|
jpayne@69
|
12567 ** CAPI3REF: Delete a changeset rebaser object.
|
|
jpayne@69
|
12568 ** EXPERIMENTAL
|
|
jpayne@69
|
12569 **
|
|
jpayne@69
|
12570 ** Delete the changeset rebaser object and all associated resources. There
|
|
jpayne@69
|
12571 ** should be one call to this function for each successful invocation
|
|
jpayne@69
|
12572 ** of sqlite3rebaser_create().
|
|
jpayne@69
|
12573 */
|
|
jpayne@69
|
12574 SQLITE_API void sqlite3rebaser_delete(sqlite3_rebaser *p);
|
|
jpayne@69
|
12575
|
|
jpayne@69
|
12576 /*
|
|
jpayne@69
|
12577 ** CAPI3REF: Streaming Versions of API functions.
|
|
jpayne@69
|
12578 **
|
|
jpayne@69
|
12579 ** The six streaming API xxx_strm() functions serve similar purposes to the
|
|
jpayne@69
|
12580 ** corresponding non-streaming API functions:
|
|
jpayne@69
|
12581 **
|
|
jpayne@69
|
12582 ** <table border=1 style="margin-left:8ex;margin-right:8ex">
|
|
jpayne@69
|
12583 ** <tr><th>Streaming function<th>Non-streaming equivalent</th>
|
|
jpayne@69
|
12584 ** <tr><td>sqlite3changeset_apply_strm<td>[sqlite3changeset_apply]
|
|
jpayne@69
|
12585 ** <tr><td>sqlite3changeset_apply_strm_v2<td>[sqlite3changeset_apply_v2]
|
|
jpayne@69
|
12586 ** <tr><td>sqlite3changeset_concat_strm<td>[sqlite3changeset_concat]
|
|
jpayne@69
|
12587 ** <tr><td>sqlite3changeset_invert_strm<td>[sqlite3changeset_invert]
|
|
jpayne@69
|
12588 ** <tr><td>sqlite3changeset_start_strm<td>[sqlite3changeset_start]
|
|
jpayne@69
|
12589 ** <tr><td>sqlite3session_changeset_strm<td>[sqlite3session_changeset]
|
|
jpayne@69
|
12590 ** <tr><td>sqlite3session_patchset_strm<td>[sqlite3session_patchset]
|
|
jpayne@69
|
12591 ** </table>
|
|
jpayne@69
|
12592 **
|
|
jpayne@69
|
12593 ** Non-streaming functions that accept changesets (or patchsets) as input
|
|
jpayne@69
|
12594 ** require that the entire changeset be stored in a single buffer in memory.
|
|
jpayne@69
|
12595 ** Similarly, those that return a changeset or patchset do so by returning
|
|
jpayne@69
|
12596 ** a pointer to a single large buffer allocated using sqlite3_malloc().
|
|
jpayne@69
|
12597 ** Normally this is convenient. However, if an application running in a
|
|
jpayne@69
|
12598 ** low-memory environment is required to handle very large changesets, the
|
|
jpayne@69
|
12599 ** large contiguous memory allocations required can become onerous.
|
|
jpayne@69
|
12600 **
|
|
jpayne@69
|
12601 ** In order to avoid this problem, instead of a single large buffer, input
|
|
jpayne@69
|
12602 ** is passed to a streaming API functions by way of a callback function that
|
|
jpayne@69
|
12603 ** the sessions module invokes to incrementally request input data as it is
|
|
jpayne@69
|
12604 ** required. In all cases, a pair of API function parameters such as
|
|
jpayne@69
|
12605 **
|
|
jpayne@69
|
12606 ** <pre>
|
|
jpayne@69
|
12607 ** int nChangeset,
|
|
jpayne@69
|
12608 ** void *pChangeset,
|
|
jpayne@69
|
12609 ** </pre>
|
|
jpayne@69
|
12610 **
|
|
jpayne@69
|
12611 ** Is replaced by:
|
|
jpayne@69
|
12612 **
|
|
jpayne@69
|
12613 ** <pre>
|
|
jpayne@69
|
12614 ** int (*xInput)(void *pIn, void *pData, int *pnData),
|
|
jpayne@69
|
12615 ** void *pIn,
|
|
jpayne@69
|
12616 ** </pre>
|
|
jpayne@69
|
12617 **
|
|
jpayne@69
|
12618 ** Each time the xInput callback is invoked by the sessions module, the first
|
|
jpayne@69
|
12619 ** argument passed is a copy of the supplied pIn context pointer. The second
|
|
jpayne@69
|
12620 ** argument, pData, points to a buffer (*pnData) bytes in size. Assuming no
|
|
jpayne@69
|
12621 ** error occurs the xInput method should copy up to (*pnData) bytes of data
|
|
jpayne@69
|
12622 ** into the buffer and set (*pnData) to the actual number of bytes copied
|
|
jpayne@69
|
12623 ** before returning SQLITE_OK. If the input is completely exhausted, (*pnData)
|
|
jpayne@69
|
12624 ** should be set to zero to indicate this. Or, if an error occurs, an SQLite
|
|
jpayne@69
|
12625 ** error code should be returned. In all cases, if an xInput callback returns
|
|
jpayne@69
|
12626 ** an error, all processing is abandoned and the streaming API function
|
|
jpayne@69
|
12627 ** returns a copy of the error code to the caller.
|
|
jpayne@69
|
12628 **
|
|
jpayne@69
|
12629 ** In the case of sqlite3changeset_start_strm(), the xInput callback may be
|
|
jpayne@69
|
12630 ** invoked by the sessions module at any point during the lifetime of the
|
|
jpayne@69
|
12631 ** iterator. If such an xInput callback returns an error, the iterator enters
|
|
jpayne@69
|
12632 ** an error state, whereby all subsequent calls to iterator functions
|
|
jpayne@69
|
12633 ** immediately fail with the same error code as returned by xInput.
|
|
jpayne@69
|
12634 **
|
|
jpayne@69
|
12635 ** Similarly, streaming API functions that return changesets (or patchsets)
|
|
jpayne@69
|
12636 ** return them in chunks by way of a callback function instead of via a
|
|
jpayne@69
|
12637 ** pointer to a single large buffer. In this case, a pair of parameters such
|
|
jpayne@69
|
12638 ** as:
|
|
jpayne@69
|
12639 **
|
|
jpayne@69
|
12640 ** <pre>
|
|
jpayne@69
|
12641 ** int *pnChangeset,
|
|
jpayne@69
|
12642 ** void **ppChangeset,
|
|
jpayne@69
|
12643 ** </pre>
|
|
jpayne@69
|
12644 **
|
|
jpayne@69
|
12645 ** Is replaced by:
|
|
jpayne@69
|
12646 **
|
|
jpayne@69
|
12647 ** <pre>
|
|
jpayne@69
|
12648 ** int (*xOutput)(void *pOut, const void *pData, int nData),
|
|
jpayne@69
|
12649 ** void *pOut
|
|
jpayne@69
|
12650 ** </pre>
|
|
jpayne@69
|
12651 **
|
|
jpayne@69
|
12652 ** The xOutput callback is invoked zero or more times to return data to
|
|
jpayne@69
|
12653 ** the application. The first parameter passed to each call is a copy of the
|
|
jpayne@69
|
12654 ** pOut pointer supplied by the application. The second parameter, pData,
|
|
jpayne@69
|
12655 ** points to a buffer nData bytes in size containing the chunk of output
|
|
jpayne@69
|
12656 ** data being returned. If the xOutput callback successfully processes the
|
|
jpayne@69
|
12657 ** supplied data, it should return SQLITE_OK to indicate success. Otherwise,
|
|
jpayne@69
|
12658 ** it should return some other SQLite error code. In this case processing
|
|
jpayne@69
|
12659 ** is immediately abandoned and the streaming API function returns a copy
|
|
jpayne@69
|
12660 ** of the xOutput error code to the application.
|
|
jpayne@69
|
12661 **
|
|
jpayne@69
|
12662 ** The sessions module never invokes an xOutput callback with the third
|
|
jpayne@69
|
12663 ** parameter set to a value less than or equal to zero. Other than this,
|
|
jpayne@69
|
12664 ** no guarantees are made as to the size of the chunks of data returned.
|
|
jpayne@69
|
12665 */
|
|
jpayne@69
|
12666 SQLITE_API int sqlite3changeset_apply_strm(
|
|
jpayne@69
|
12667 sqlite3 *db, /* Apply change to "main" db of this handle */
|
|
jpayne@69
|
12668 int (*xInput)(void *pIn, void *pData, int *pnData), /* Input function */
|
|
jpayne@69
|
12669 void *pIn, /* First arg for xInput */
|
|
jpayne@69
|
12670 int(*xFilter)(
|
|
jpayne@69
|
12671 void *pCtx, /* Copy of sixth arg to _apply() */
|
|
jpayne@69
|
12672 const char *zTab /* Table name */
|
|
jpayne@69
|
12673 ),
|
|
jpayne@69
|
12674 int(*xConflict)(
|
|
jpayne@69
|
12675 void *pCtx, /* Copy of sixth arg to _apply() */
|
|
jpayne@69
|
12676 int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
|
|
jpayne@69
|
12677 sqlite3_changeset_iter *p /* Handle describing change and conflict */
|
|
jpayne@69
|
12678 ),
|
|
jpayne@69
|
12679 void *pCtx /* First argument passed to xConflict */
|
|
jpayne@69
|
12680 );
|
|
jpayne@69
|
12681 SQLITE_API int sqlite3changeset_apply_v2_strm(
|
|
jpayne@69
|
12682 sqlite3 *db, /* Apply change to "main" db of this handle */
|
|
jpayne@69
|
12683 int (*xInput)(void *pIn, void *pData, int *pnData), /* Input function */
|
|
jpayne@69
|
12684 void *pIn, /* First arg for xInput */
|
|
jpayne@69
|
12685 int(*xFilter)(
|
|
jpayne@69
|
12686 void *pCtx, /* Copy of sixth arg to _apply() */
|
|
jpayne@69
|
12687 const char *zTab /* Table name */
|
|
jpayne@69
|
12688 ),
|
|
jpayne@69
|
12689 int(*xConflict)(
|
|
jpayne@69
|
12690 void *pCtx, /* Copy of sixth arg to _apply() */
|
|
jpayne@69
|
12691 int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
|
|
jpayne@69
|
12692 sqlite3_changeset_iter *p /* Handle describing change and conflict */
|
|
jpayne@69
|
12693 ),
|
|
jpayne@69
|
12694 void *pCtx, /* First argument passed to xConflict */
|
|
jpayne@69
|
12695 void **ppRebase, int *pnRebase,
|
|
jpayne@69
|
12696 int flags
|
|
jpayne@69
|
12697 );
|
|
jpayne@69
|
12698 SQLITE_API int sqlite3changeset_concat_strm(
|
|
jpayne@69
|
12699 int (*xInputA)(void *pIn, void *pData, int *pnData),
|
|
jpayne@69
|
12700 void *pInA,
|
|
jpayne@69
|
12701 int (*xInputB)(void *pIn, void *pData, int *pnData),
|
|
jpayne@69
|
12702 void *pInB,
|
|
jpayne@69
|
12703 int (*xOutput)(void *pOut, const void *pData, int nData),
|
|
jpayne@69
|
12704 void *pOut
|
|
jpayne@69
|
12705 );
|
|
jpayne@69
|
12706 SQLITE_API int sqlite3changeset_invert_strm(
|
|
jpayne@69
|
12707 int (*xInput)(void *pIn, void *pData, int *pnData),
|
|
jpayne@69
|
12708 void *pIn,
|
|
jpayne@69
|
12709 int (*xOutput)(void *pOut, const void *pData, int nData),
|
|
jpayne@69
|
12710 void *pOut
|
|
jpayne@69
|
12711 );
|
|
jpayne@69
|
12712 SQLITE_API int sqlite3changeset_start_strm(
|
|
jpayne@69
|
12713 sqlite3_changeset_iter **pp,
|
|
jpayne@69
|
12714 int (*xInput)(void *pIn, void *pData, int *pnData),
|
|
jpayne@69
|
12715 void *pIn
|
|
jpayne@69
|
12716 );
|
|
jpayne@69
|
12717 SQLITE_API int sqlite3changeset_start_v2_strm(
|
|
jpayne@69
|
12718 sqlite3_changeset_iter **pp,
|
|
jpayne@69
|
12719 int (*xInput)(void *pIn, void *pData, int *pnData),
|
|
jpayne@69
|
12720 void *pIn,
|
|
jpayne@69
|
12721 int flags
|
|
jpayne@69
|
12722 );
|
|
jpayne@69
|
12723 SQLITE_API int sqlite3session_changeset_strm(
|
|
jpayne@69
|
12724 sqlite3_session *pSession,
|
|
jpayne@69
|
12725 int (*xOutput)(void *pOut, const void *pData, int nData),
|
|
jpayne@69
|
12726 void *pOut
|
|
jpayne@69
|
12727 );
|
|
jpayne@69
|
12728 SQLITE_API int sqlite3session_patchset_strm(
|
|
jpayne@69
|
12729 sqlite3_session *pSession,
|
|
jpayne@69
|
12730 int (*xOutput)(void *pOut, const void *pData, int nData),
|
|
jpayne@69
|
12731 void *pOut
|
|
jpayne@69
|
12732 );
|
|
jpayne@69
|
12733 SQLITE_API int sqlite3changegroup_add_strm(sqlite3_changegroup*,
|
|
jpayne@69
|
12734 int (*xInput)(void *pIn, void *pData, int *pnData),
|
|
jpayne@69
|
12735 void *pIn
|
|
jpayne@69
|
12736 );
|
|
jpayne@69
|
12737 SQLITE_API int sqlite3changegroup_output_strm(sqlite3_changegroup*,
|
|
jpayne@69
|
12738 int (*xOutput)(void *pOut, const void *pData, int nData),
|
|
jpayne@69
|
12739 void *pOut
|
|
jpayne@69
|
12740 );
|
|
jpayne@69
|
12741 SQLITE_API int sqlite3rebaser_rebase_strm(
|
|
jpayne@69
|
12742 sqlite3_rebaser *pRebaser,
|
|
jpayne@69
|
12743 int (*xInput)(void *pIn, void *pData, int *pnData),
|
|
jpayne@69
|
12744 void *pIn,
|
|
jpayne@69
|
12745 int (*xOutput)(void *pOut, const void *pData, int nData),
|
|
jpayne@69
|
12746 void *pOut
|
|
jpayne@69
|
12747 );
|
|
jpayne@69
|
12748
|
|
jpayne@69
|
12749 /*
|
|
jpayne@69
|
12750 ** CAPI3REF: Configure global parameters
|
|
jpayne@69
|
12751 **
|
|
jpayne@69
|
12752 ** The sqlite3session_config() interface is used to make global configuration
|
|
jpayne@69
|
12753 ** changes to the sessions module in order to tune it to the specific needs
|
|
jpayne@69
|
12754 ** of the application.
|
|
jpayne@69
|
12755 **
|
|
jpayne@69
|
12756 ** The sqlite3session_config() interface is not threadsafe. If it is invoked
|
|
jpayne@69
|
12757 ** while any other thread is inside any other sessions method then the
|
|
jpayne@69
|
12758 ** results are undefined. Furthermore, if it is invoked after any sessions
|
|
jpayne@69
|
12759 ** related objects have been created, the results are also undefined.
|
|
jpayne@69
|
12760 **
|
|
jpayne@69
|
12761 ** The first argument to the sqlite3session_config() function must be one
|
|
jpayne@69
|
12762 ** of the SQLITE_SESSION_CONFIG_XXX constants defined below. The
|
|
jpayne@69
|
12763 ** interpretation of the (void*) value passed as the second parameter and
|
|
jpayne@69
|
12764 ** the effect of calling this function depends on the value of the first
|
|
jpayne@69
|
12765 ** parameter.
|
|
jpayne@69
|
12766 **
|
|
jpayne@69
|
12767 ** <dl>
|
|
jpayne@69
|
12768 ** <dt>SQLITE_SESSION_CONFIG_STRMSIZE<dd>
|
|
jpayne@69
|
12769 ** By default, the sessions module streaming interfaces attempt to input
|
|
jpayne@69
|
12770 ** and output data in approximately 1 KiB chunks. This operand may be used
|
|
jpayne@69
|
12771 ** to set and query the value of this configuration setting. The pointer
|
|
jpayne@69
|
12772 ** passed as the second argument must point to a value of type (int).
|
|
jpayne@69
|
12773 ** If this value is greater than 0, it is used as the new streaming data
|
|
jpayne@69
|
12774 ** chunk size for both input and output. Before returning, the (int) value
|
|
jpayne@69
|
12775 ** pointed to by pArg is set to the final value of the streaming interface
|
|
jpayne@69
|
12776 ** chunk size.
|
|
jpayne@69
|
12777 ** </dl>
|
|
jpayne@69
|
12778 **
|
|
jpayne@69
|
12779 ** This function returns SQLITE_OK if successful, or an SQLite error code
|
|
jpayne@69
|
12780 ** otherwise.
|
|
jpayne@69
|
12781 */
|
|
jpayne@69
|
12782 SQLITE_API int sqlite3session_config(int op, void *pArg);
|
|
jpayne@69
|
12783
|
|
jpayne@69
|
12784 /*
|
|
jpayne@69
|
12785 ** CAPI3REF: Values for sqlite3session_config().
|
|
jpayne@69
|
12786 */
|
|
jpayne@69
|
12787 #define SQLITE_SESSION_CONFIG_STRMSIZE 1
|
|
jpayne@69
|
12788
|
|
jpayne@69
|
12789 /*
|
|
jpayne@69
|
12790 ** Make sure we can call this stuff from C++.
|
|
jpayne@69
|
12791 */
|
|
jpayne@69
|
12792 #ifdef __cplusplus
|
|
jpayne@69
|
12793 }
|
|
jpayne@69
|
12794 #endif
|
|
jpayne@69
|
12795
|
|
jpayne@69
|
12796 #endif /* !defined(__SQLITESESSION_H_) && defined(SQLITE_ENABLE_SESSION) */
|
|
jpayne@69
|
12797
|
|
jpayne@69
|
12798 /******** End of sqlite3session.h *********/
|
|
jpayne@69
|
12799 /******** Begin file fts5.h *********/
|
|
jpayne@69
|
12800 /*
|
|
jpayne@69
|
12801 ** 2014 May 31
|
|
jpayne@69
|
12802 **
|
|
jpayne@69
|
12803 ** The author disclaims copyright to this source code. In place of
|
|
jpayne@69
|
12804 ** a legal notice, here is a blessing:
|
|
jpayne@69
|
12805 **
|
|
jpayne@69
|
12806 ** May you do good and not evil.
|
|
jpayne@69
|
12807 ** May you find forgiveness for yourself and forgive others.
|
|
jpayne@69
|
12808 ** May you share freely, never taking more than you give.
|
|
jpayne@69
|
12809 **
|
|
jpayne@69
|
12810 ******************************************************************************
|
|
jpayne@69
|
12811 **
|
|
jpayne@69
|
12812 ** Interfaces to extend FTS5. Using the interfaces defined in this file,
|
|
jpayne@69
|
12813 ** FTS5 may be extended with:
|
|
jpayne@69
|
12814 **
|
|
jpayne@69
|
12815 ** * custom tokenizers, and
|
|
jpayne@69
|
12816 ** * custom auxiliary functions.
|
|
jpayne@69
|
12817 */
|
|
jpayne@69
|
12818
|
|
jpayne@69
|
12819
|
|
jpayne@69
|
12820 #ifndef _FTS5_H
|
|
jpayne@69
|
12821 #define _FTS5_H
|
|
jpayne@69
|
12822
|
|
jpayne@69
|
12823
|
|
jpayne@69
|
12824 #ifdef __cplusplus
|
|
jpayne@69
|
12825 extern "C" {
|
|
jpayne@69
|
12826 #endif
|
|
jpayne@69
|
12827
|
|
jpayne@69
|
12828 /*************************************************************************
|
|
jpayne@69
|
12829 ** CUSTOM AUXILIARY FUNCTIONS
|
|
jpayne@69
|
12830 **
|
|
jpayne@69
|
12831 ** Virtual table implementations may overload SQL functions by implementing
|
|
jpayne@69
|
12832 ** the sqlite3_module.xFindFunction() method.
|
|
jpayne@69
|
12833 */
|
|
jpayne@69
|
12834
|
|
jpayne@69
|
12835 typedef struct Fts5ExtensionApi Fts5ExtensionApi;
|
|
jpayne@69
|
12836 typedef struct Fts5Context Fts5Context;
|
|
jpayne@69
|
12837 typedef struct Fts5PhraseIter Fts5PhraseIter;
|
|
jpayne@69
|
12838
|
|
jpayne@69
|
12839 typedef void (*fts5_extension_function)(
|
|
jpayne@69
|
12840 const Fts5ExtensionApi *pApi, /* API offered by current FTS version */
|
|
jpayne@69
|
12841 Fts5Context *pFts, /* First arg to pass to pApi functions */
|
|
jpayne@69
|
12842 sqlite3_context *pCtx, /* Context for returning result/error */
|
|
jpayne@69
|
12843 int nVal, /* Number of values in apVal[] array */
|
|
jpayne@69
|
12844 sqlite3_value **apVal /* Array of trailing arguments */
|
|
jpayne@69
|
12845 );
|
|
jpayne@69
|
12846
|
|
jpayne@69
|
12847 struct Fts5PhraseIter {
|
|
jpayne@69
|
12848 const unsigned char *a;
|
|
jpayne@69
|
12849 const unsigned char *b;
|
|
jpayne@69
|
12850 };
|
|
jpayne@69
|
12851
|
|
jpayne@69
|
12852 /*
|
|
jpayne@69
|
12853 ** EXTENSION API FUNCTIONS
|
|
jpayne@69
|
12854 **
|
|
jpayne@69
|
12855 ** xUserData(pFts):
|
|
jpayne@69
|
12856 ** Return a copy of the pUserData pointer passed to the xCreateFunction()
|
|
jpayne@69
|
12857 ** API when the extension function was registered.
|
|
jpayne@69
|
12858 **
|
|
jpayne@69
|
12859 ** xColumnTotalSize(pFts, iCol, pnToken):
|
|
jpayne@69
|
12860 ** If parameter iCol is less than zero, set output variable *pnToken
|
|
jpayne@69
|
12861 ** to the total number of tokens in the FTS5 table. Or, if iCol is
|
|
jpayne@69
|
12862 ** non-negative but less than the number of columns in the table, return
|
|
jpayne@69
|
12863 ** the total number of tokens in column iCol, considering all rows in
|
|
jpayne@69
|
12864 ** the FTS5 table.
|
|
jpayne@69
|
12865 **
|
|
jpayne@69
|
12866 ** If parameter iCol is greater than or equal to the number of columns
|
|
jpayne@69
|
12867 ** in the table, SQLITE_RANGE is returned. Or, if an error occurs (e.g.
|
|
jpayne@69
|
12868 ** an OOM condition or IO error), an appropriate SQLite error code is
|
|
jpayne@69
|
12869 ** returned.
|
|
jpayne@69
|
12870 **
|
|
jpayne@69
|
12871 ** xColumnCount(pFts):
|
|
jpayne@69
|
12872 ** Return the number of columns in the table.
|
|
jpayne@69
|
12873 **
|
|
jpayne@69
|
12874 ** xColumnSize(pFts, iCol, pnToken):
|
|
jpayne@69
|
12875 ** If parameter iCol is less than zero, set output variable *pnToken
|
|
jpayne@69
|
12876 ** to the total number of tokens in the current row. Or, if iCol is
|
|
jpayne@69
|
12877 ** non-negative but less than the number of columns in the table, set
|
|
jpayne@69
|
12878 ** *pnToken to the number of tokens in column iCol of the current row.
|
|
jpayne@69
|
12879 **
|
|
jpayne@69
|
12880 ** If parameter iCol is greater than or equal to the number of columns
|
|
jpayne@69
|
12881 ** in the table, SQLITE_RANGE is returned. Or, if an error occurs (e.g.
|
|
jpayne@69
|
12882 ** an OOM condition or IO error), an appropriate SQLite error code is
|
|
jpayne@69
|
12883 ** returned.
|
|
jpayne@69
|
12884 **
|
|
jpayne@69
|
12885 ** This function may be quite inefficient if used with an FTS5 table
|
|
jpayne@69
|
12886 ** created with the "columnsize=0" option.
|
|
jpayne@69
|
12887 **
|
|
jpayne@69
|
12888 ** xColumnText:
|
|
jpayne@69
|
12889 ** If parameter iCol is less than zero, or greater than or equal to the
|
|
jpayne@69
|
12890 ** number of columns in the table, SQLITE_RANGE is returned.
|
|
jpayne@69
|
12891 **
|
|
jpayne@69
|
12892 ** Otherwise, this function attempts to retrieve the text of column iCol of
|
|
jpayne@69
|
12893 ** the current document. If successful, (*pz) is set to point to a buffer
|
|
jpayne@69
|
12894 ** containing the text in utf-8 encoding, (*pn) is set to the size in bytes
|
|
jpayne@69
|
12895 ** (not characters) of the buffer and SQLITE_OK is returned. Otherwise,
|
|
jpayne@69
|
12896 ** if an error occurs, an SQLite error code is returned and the final values
|
|
jpayne@69
|
12897 ** of (*pz) and (*pn) are undefined.
|
|
jpayne@69
|
12898 **
|
|
jpayne@69
|
12899 ** xPhraseCount:
|
|
jpayne@69
|
12900 ** Returns the number of phrases in the current query expression.
|
|
jpayne@69
|
12901 **
|
|
jpayne@69
|
12902 ** xPhraseSize:
|
|
jpayne@69
|
12903 ** If parameter iCol is less than zero, or greater than or equal to the
|
|
jpayne@69
|
12904 ** number of phrases in the current query, as returned by xPhraseCount,
|
|
jpayne@69
|
12905 ** 0 is returned. Otherwise, this function returns the number of tokens in
|
|
jpayne@69
|
12906 ** phrase iPhrase of the query. Phrases are numbered starting from zero.
|
|
jpayne@69
|
12907 **
|
|
jpayne@69
|
12908 ** xInstCount:
|
|
jpayne@69
|
12909 ** Set *pnInst to the total number of occurrences of all phrases within
|
|
jpayne@69
|
12910 ** the query within the current row. Return SQLITE_OK if successful, or
|
|
jpayne@69
|
12911 ** an error code (i.e. SQLITE_NOMEM) if an error occurs.
|
|
jpayne@69
|
12912 **
|
|
jpayne@69
|
12913 ** This API can be quite slow if used with an FTS5 table created with the
|
|
jpayne@69
|
12914 ** "detail=none" or "detail=column" option. If the FTS5 table is created
|
|
jpayne@69
|
12915 ** with either "detail=none" or "detail=column" and "content=" option
|
|
jpayne@69
|
12916 ** (i.e. if it is a contentless table), then this API always returns 0.
|
|
jpayne@69
|
12917 **
|
|
jpayne@69
|
12918 ** xInst:
|
|
jpayne@69
|
12919 ** Query for the details of phrase match iIdx within the current row.
|
|
jpayne@69
|
12920 ** Phrase matches are numbered starting from zero, so the iIdx argument
|
|
jpayne@69
|
12921 ** should be greater than or equal to zero and smaller than the value
|
|
jpayne@69
|
12922 ** output by xInstCount(). If iIdx is less than zero or greater than
|
|
jpayne@69
|
12923 ** or equal to the value returned by xInstCount(), SQLITE_RANGE is returned.
|
|
jpayne@69
|
12924 **
|
|
jpayne@69
|
12925 ** Otherwise, output parameter *piPhrase is set to the phrase number, *piCol
|
|
jpayne@69
|
12926 ** to the column in which it occurs and *piOff the token offset of the
|
|
jpayne@69
|
12927 ** first token of the phrase. SQLITE_OK is returned if successful, or an
|
|
jpayne@69
|
12928 ** error code (i.e. SQLITE_NOMEM) if an error occurs.
|
|
jpayne@69
|
12929 **
|
|
jpayne@69
|
12930 ** This API can be quite slow if used with an FTS5 table created with the
|
|
jpayne@69
|
12931 ** "detail=none" or "detail=column" option.
|
|
jpayne@69
|
12932 **
|
|
jpayne@69
|
12933 ** xRowid:
|
|
jpayne@69
|
12934 ** Returns the rowid of the current row.
|
|
jpayne@69
|
12935 **
|
|
jpayne@69
|
12936 ** xTokenize:
|
|
jpayne@69
|
12937 ** Tokenize text using the tokenizer belonging to the FTS5 table.
|
|
jpayne@69
|
12938 **
|
|
jpayne@69
|
12939 ** xQueryPhrase(pFts5, iPhrase, pUserData, xCallback):
|
|
jpayne@69
|
12940 ** This API function is used to query the FTS table for phrase iPhrase
|
|
jpayne@69
|
12941 ** of the current query. Specifically, a query equivalent to:
|
|
jpayne@69
|
12942 **
|
|
jpayne@69
|
12943 ** ... FROM ftstable WHERE ftstable MATCH $p ORDER BY rowid
|
|
jpayne@69
|
12944 **
|
|
jpayne@69
|
12945 ** with $p set to a phrase equivalent to the phrase iPhrase of the
|
|
jpayne@69
|
12946 ** current query is executed. Any column filter that applies to
|
|
jpayne@69
|
12947 ** phrase iPhrase of the current query is included in $p. For each
|
|
jpayne@69
|
12948 ** row visited, the callback function passed as the fourth argument
|
|
jpayne@69
|
12949 ** is invoked. The context and API objects passed to the callback
|
|
jpayne@69
|
12950 ** function may be used to access the properties of each matched row.
|
|
jpayne@69
|
12951 ** Invoking Api.xUserData() returns a copy of the pointer passed as
|
|
jpayne@69
|
12952 ** the third argument to pUserData.
|
|
jpayne@69
|
12953 **
|
|
jpayne@69
|
12954 ** If parameter iPhrase is less than zero, or greater than or equal to
|
|
jpayne@69
|
12955 ** the number of phrases in the query, as returned by xPhraseCount(),
|
|
jpayne@69
|
12956 ** this function returns SQLITE_RANGE.
|
|
jpayne@69
|
12957 **
|
|
jpayne@69
|
12958 ** If the callback function returns any value other than SQLITE_OK, the
|
|
jpayne@69
|
12959 ** query is abandoned and the xQueryPhrase function returns immediately.
|
|
jpayne@69
|
12960 ** If the returned value is SQLITE_DONE, xQueryPhrase returns SQLITE_OK.
|
|
jpayne@69
|
12961 ** Otherwise, the error code is propagated upwards.
|
|
jpayne@69
|
12962 **
|
|
jpayne@69
|
12963 ** If the query runs to completion without incident, SQLITE_OK is returned.
|
|
jpayne@69
|
12964 ** Or, if some error occurs before the query completes or is aborted by
|
|
jpayne@69
|
12965 ** the callback, an SQLite error code is returned.
|
|
jpayne@69
|
12966 **
|
|
jpayne@69
|
12967 **
|
|
jpayne@69
|
12968 ** xSetAuxdata(pFts5, pAux, xDelete)
|
|
jpayne@69
|
12969 **
|
|
jpayne@69
|
12970 ** Save the pointer passed as the second argument as the extension function's
|
|
jpayne@69
|
12971 ** "auxiliary data". The pointer may then be retrieved by the current or any
|
|
jpayne@69
|
12972 ** future invocation of the same fts5 extension function made as part of
|
|
jpayne@69
|
12973 ** the same MATCH query using the xGetAuxdata() API.
|
|
jpayne@69
|
12974 **
|
|
jpayne@69
|
12975 ** Each extension function is allocated a single auxiliary data slot for
|
|
jpayne@69
|
12976 ** each FTS query (MATCH expression). If the extension function is invoked
|
|
jpayne@69
|
12977 ** more than once for a single FTS query, then all invocations share a
|
|
jpayne@69
|
12978 ** single auxiliary data context.
|
|
jpayne@69
|
12979 **
|
|
jpayne@69
|
12980 ** If there is already an auxiliary data pointer when this function is
|
|
jpayne@69
|
12981 ** invoked, then it is replaced by the new pointer. If an xDelete callback
|
|
jpayne@69
|
12982 ** was specified along with the original pointer, it is invoked at this
|
|
jpayne@69
|
12983 ** point.
|
|
jpayne@69
|
12984 **
|
|
jpayne@69
|
12985 ** The xDelete callback, if one is specified, is also invoked on the
|
|
jpayne@69
|
12986 ** auxiliary data pointer after the FTS5 query has finished.
|
|
jpayne@69
|
12987 **
|
|
jpayne@69
|
12988 ** If an error (e.g. an OOM condition) occurs within this function,
|
|
jpayne@69
|
12989 ** the auxiliary data is set to NULL and an error code returned. If the
|
|
jpayne@69
|
12990 ** xDelete parameter was not NULL, it is invoked on the auxiliary data
|
|
jpayne@69
|
12991 ** pointer before returning.
|
|
jpayne@69
|
12992 **
|
|
jpayne@69
|
12993 **
|
|
jpayne@69
|
12994 ** xGetAuxdata(pFts5, bClear)
|
|
jpayne@69
|
12995 **
|
|
jpayne@69
|
12996 ** Returns the current auxiliary data pointer for the fts5 extension
|
|
jpayne@69
|
12997 ** function. See the xSetAuxdata() method for details.
|
|
jpayne@69
|
12998 **
|
|
jpayne@69
|
12999 ** If the bClear argument is non-zero, then the auxiliary data is cleared
|
|
jpayne@69
|
13000 ** (set to NULL) before this function returns. In this case the xDelete,
|
|
jpayne@69
|
13001 ** if any, is not invoked.
|
|
jpayne@69
|
13002 **
|
|
jpayne@69
|
13003 **
|
|
jpayne@69
|
13004 ** xRowCount(pFts5, pnRow)
|
|
jpayne@69
|
13005 **
|
|
jpayne@69
|
13006 ** This function is used to retrieve the total number of rows in the table.
|
|
jpayne@69
|
13007 ** In other words, the same value that would be returned by:
|
|
jpayne@69
|
13008 **
|
|
jpayne@69
|
13009 ** SELECT count(*) FROM ftstable;
|
|
jpayne@69
|
13010 **
|
|
jpayne@69
|
13011 ** xPhraseFirst()
|
|
jpayne@69
|
13012 ** This function is used, along with type Fts5PhraseIter and the xPhraseNext
|
|
jpayne@69
|
13013 ** method, to iterate through all instances of a single query phrase within
|
|
jpayne@69
|
13014 ** the current row. This is the same information as is accessible via the
|
|
jpayne@69
|
13015 ** xInstCount/xInst APIs. While the xInstCount/xInst APIs are more convenient
|
|
jpayne@69
|
13016 ** to use, this API may be faster under some circumstances. To iterate
|
|
jpayne@69
|
13017 ** through instances of phrase iPhrase, use the following code:
|
|
jpayne@69
|
13018 **
|
|
jpayne@69
|
13019 ** Fts5PhraseIter iter;
|
|
jpayne@69
|
13020 ** int iCol, iOff;
|
|
jpayne@69
|
13021 ** for(pApi->xPhraseFirst(pFts, iPhrase, &iter, &iCol, &iOff);
|
|
jpayne@69
|
13022 ** iCol>=0;
|
|
jpayne@69
|
13023 ** pApi->xPhraseNext(pFts, &iter, &iCol, &iOff)
|
|
jpayne@69
|
13024 ** ){
|
|
jpayne@69
|
13025 ** // An instance of phrase iPhrase at offset iOff of column iCol
|
|
jpayne@69
|
13026 ** }
|
|
jpayne@69
|
13027 **
|
|
jpayne@69
|
13028 ** The Fts5PhraseIter structure is defined above. Applications should not
|
|
jpayne@69
|
13029 ** modify this structure directly - it should only be used as shown above
|
|
jpayne@69
|
13030 ** with the xPhraseFirst() and xPhraseNext() API methods (and by
|
|
jpayne@69
|
13031 ** xPhraseFirstColumn() and xPhraseNextColumn() as illustrated below).
|
|
jpayne@69
|
13032 **
|
|
jpayne@69
|
13033 ** This API can be quite slow if used with an FTS5 table created with the
|
|
jpayne@69
|
13034 ** "detail=none" or "detail=column" option. If the FTS5 table is created
|
|
jpayne@69
|
13035 ** with either "detail=none" or "detail=column" and "content=" option
|
|
jpayne@69
|
13036 ** (i.e. if it is a contentless table), then this API always iterates
|
|
jpayne@69
|
13037 ** through an empty set (all calls to xPhraseFirst() set iCol to -1).
|
|
jpayne@69
|
13038 **
|
|
jpayne@69
|
13039 ** xPhraseNext()
|
|
jpayne@69
|
13040 ** See xPhraseFirst above.
|
|
jpayne@69
|
13041 **
|
|
jpayne@69
|
13042 ** xPhraseFirstColumn()
|
|
jpayne@69
|
13043 ** This function and xPhraseNextColumn() are similar to the xPhraseFirst()
|
|
jpayne@69
|
13044 ** and xPhraseNext() APIs described above. The difference is that instead
|
|
jpayne@69
|
13045 ** of iterating through all instances of a phrase in the current row, these
|
|
jpayne@69
|
13046 ** APIs are used to iterate through the set of columns in the current row
|
|
jpayne@69
|
13047 ** that contain one or more instances of a specified phrase. For example:
|
|
jpayne@69
|
13048 **
|
|
jpayne@69
|
13049 ** Fts5PhraseIter iter;
|
|
jpayne@69
|
13050 ** int iCol;
|
|
jpayne@69
|
13051 ** for(pApi->xPhraseFirstColumn(pFts, iPhrase, &iter, &iCol);
|
|
jpayne@69
|
13052 ** iCol>=0;
|
|
jpayne@69
|
13053 ** pApi->xPhraseNextColumn(pFts, &iter, &iCol)
|
|
jpayne@69
|
13054 ** ){
|
|
jpayne@69
|
13055 ** // Column iCol contains at least one instance of phrase iPhrase
|
|
jpayne@69
|
13056 ** }
|
|
jpayne@69
|
13057 **
|
|
jpayne@69
|
13058 ** This API can be quite slow if used with an FTS5 table created with the
|
|
jpayne@69
|
13059 ** "detail=none" option. If the FTS5 table is created with either
|
|
jpayne@69
|
13060 ** "detail=none" "content=" option (i.e. if it is a contentless table),
|
|
jpayne@69
|
13061 ** then this API always iterates through an empty set (all calls to
|
|
jpayne@69
|
13062 ** xPhraseFirstColumn() set iCol to -1).
|
|
jpayne@69
|
13063 **
|
|
jpayne@69
|
13064 ** The information accessed using this API and its companion
|
|
jpayne@69
|
13065 ** xPhraseFirstColumn() may also be obtained using xPhraseFirst/xPhraseNext
|
|
jpayne@69
|
13066 ** (or xInst/xInstCount). The chief advantage of this API is that it is
|
|
jpayne@69
|
13067 ** significantly more efficient than those alternatives when used with
|
|
jpayne@69
|
13068 ** "detail=column" tables.
|
|
jpayne@69
|
13069 **
|
|
jpayne@69
|
13070 ** xPhraseNextColumn()
|
|
jpayne@69
|
13071 ** See xPhraseFirstColumn above.
|
|
jpayne@69
|
13072 **
|
|
jpayne@69
|
13073 ** xQueryToken(pFts5, iPhrase, iToken, ppToken, pnToken)
|
|
jpayne@69
|
13074 ** This is used to access token iToken of phrase iPhrase of the current
|
|
jpayne@69
|
13075 ** query. Before returning, output parameter *ppToken is set to point
|
|
jpayne@69
|
13076 ** to a buffer containing the requested token, and *pnToken to the
|
|
jpayne@69
|
13077 ** size of this buffer in bytes.
|
|
jpayne@69
|
13078 **
|
|
jpayne@69
|
13079 ** If iPhrase or iToken are less than zero, or if iPhrase is greater than
|
|
jpayne@69
|
13080 ** or equal to the number of phrases in the query as reported by
|
|
jpayne@69
|
13081 ** xPhraseCount(), or if iToken is equal to or greater than the number of
|
|
jpayne@69
|
13082 ** tokens in the phrase, SQLITE_RANGE is returned and *ppToken and *pnToken
|
|
jpayne@69
|
13083 are both zeroed.
|
|
jpayne@69
|
13084 **
|
|
jpayne@69
|
13085 ** The output text is not a copy of the query text that specified the
|
|
jpayne@69
|
13086 ** token. It is the output of the tokenizer module. For tokendata=1
|
|
jpayne@69
|
13087 ** tables, this includes any embedded 0x00 and trailing data.
|
|
jpayne@69
|
13088 **
|
|
jpayne@69
|
13089 ** xInstToken(pFts5, iIdx, iToken, ppToken, pnToken)
|
|
jpayne@69
|
13090 ** This is used to access token iToken of phrase hit iIdx within the
|
|
jpayne@69
|
13091 ** current row. If iIdx is less than zero or greater than or equal to the
|
|
jpayne@69
|
13092 ** value returned by xInstCount(), SQLITE_RANGE is returned. Otherwise,
|
|
jpayne@69
|
13093 ** output variable (*ppToken) is set to point to a buffer containing the
|
|
jpayne@69
|
13094 ** matching document token, and (*pnToken) to the size of that buffer in
|
|
jpayne@69
|
13095 ** bytes. This API is not available if the specified token matches a
|
|
jpayne@69
|
13096 ** prefix query term. In that case both output variables are always set
|
|
jpayne@69
|
13097 ** to 0.
|
|
jpayne@69
|
13098 **
|
|
jpayne@69
|
13099 ** The output text is not a copy of the document text that was tokenized.
|
|
jpayne@69
|
13100 ** It is the output of the tokenizer module. For tokendata=1 tables, this
|
|
jpayne@69
|
13101 ** includes any embedded 0x00 and trailing data.
|
|
jpayne@69
|
13102 **
|
|
jpayne@69
|
13103 ** This API can be quite slow if used with an FTS5 table created with the
|
|
jpayne@69
|
13104 ** "detail=none" or "detail=column" option.
|
|
jpayne@69
|
13105 */
|
|
jpayne@69
|
13106 struct Fts5ExtensionApi {
|
|
jpayne@69
|
13107 int iVersion; /* Currently always set to 3 */
|
|
jpayne@69
|
13108
|
|
jpayne@69
|
13109 void *(*xUserData)(Fts5Context*);
|
|
jpayne@69
|
13110
|
|
jpayne@69
|
13111 int (*xColumnCount)(Fts5Context*);
|
|
jpayne@69
|
13112 int (*xRowCount)(Fts5Context*, sqlite3_int64 *pnRow);
|
|
jpayne@69
|
13113 int (*xColumnTotalSize)(Fts5Context*, int iCol, sqlite3_int64 *pnToken);
|
|
jpayne@69
|
13114
|
|
jpayne@69
|
13115 int (*xTokenize)(Fts5Context*,
|
|
jpayne@69
|
13116 const char *pText, int nText, /* Text to tokenize */
|
|
jpayne@69
|
13117 void *pCtx, /* Context passed to xToken() */
|
|
jpayne@69
|
13118 int (*xToken)(void*, int, const char*, int, int, int) /* Callback */
|
|
jpayne@69
|
13119 );
|
|
jpayne@69
|
13120
|
|
jpayne@69
|
13121 int (*xPhraseCount)(Fts5Context*);
|
|
jpayne@69
|
13122 int (*xPhraseSize)(Fts5Context*, int iPhrase);
|
|
jpayne@69
|
13123
|
|
jpayne@69
|
13124 int (*xInstCount)(Fts5Context*, int *pnInst);
|
|
jpayne@69
|
13125 int (*xInst)(Fts5Context*, int iIdx, int *piPhrase, int *piCol, int *piOff);
|
|
jpayne@69
|
13126
|
|
jpayne@69
|
13127 sqlite3_int64 (*xRowid)(Fts5Context*);
|
|
jpayne@69
|
13128 int (*xColumnText)(Fts5Context*, int iCol, const char **pz, int *pn);
|
|
jpayne@69
|
13129 int (*xColumnSize)(Fts5Context*, int iCol, int *pnToken);
|
|
jpayne@69
|
13130
|
|
jpayne@69
|
13131 int (*xQueryPhrase)(Fts5Context*, int iPhrase, void *pUserData,
|
|
jpayne@69
|
13132 int(*)(const Fts5ExtensionApi*,Fts5Context*,void*)
|
|
jpayne@69
|
13133 );
|
|
jpayne@69
|
13134 int (*xSetAuxdata)(Fts5Context*, void *pAux, void(*xDelete)(void*));
|
|
jpayne@69
|
13135 void *(*xGetAuxdata)(Fts5Context*, int bClear);
|
|
jpayne@69
|
13136
|
|
jpayne@69
|
13137 int (*xPhraseFirst)(Fts5Context*, int iPhrase, Fts5PhraseIter*, int*, int*);
|
|
jpayne@69
|
13138 void (*xPhraseNext)(Fts5Context*, Fts5PhraseIter*, int *piCol, int *piOff);
|
|
jpayne@69
|
13139
|
|
jpayne@69
|
13140 int (*xPhraseFirstColumn)(Fts5Context*, int iPhrase, Fts5PhraseIter*, int*);
|
|
jpayne@69
|
13141 void (*xPhraseNextColumn)(Fts5Context*, Fts5PhraseIter*, int *piCol);
|
|
jpayne@69
|
13142
|
|
jpayne@69
|
13143 /* Below this point are iVersion>=3 only */
|
|
jpayne@69
|
13144 int (*xQueryToken)(Fts5Context*,
|
|
jpayne@69
|
13145 int iPhrase, int iToken,
|
|
jpayne@69
|
13146 const char **ppToken, int *pnToken
|
|
jpayne@69
|
13147 );
|
|
jpayne@69
|
13148 int (*xInstToken)(Fts5Context*, int iIdx, int iToken, const char**, int*);
|
|
jpayne@69
|
13149 };
|
|
jpayne@69
|
13150
|
|
jpayne@69
|
13151 /*
|
|
jpayne@69
|
13152 ** CUSTOM AUXILIARY FUNCTIONS
|
|
jpayne@69
|
13153 *************************************************************************/
|
|
jpayne@69
|
13154
|
|
jpayne@69
|
13155 /*************************************************************************
|
|
jpayne@69
|
13156 ** CUSTOM TOKENIZERS
|
|
jpayne@69
|
13157 **
|
|
jpayne@69
|
13158 ** Applications may also register custom tokenizer types. A tokenizer
|
|
jpayne@69
|
13159 ** is registered by providing fts5 with a populated instance of the
|
|
jpayne@69
|
13160 ** following structure. All structure methods must be defined, setting
|
|
jpayne@69
|
13161 ** any member of the fts5_tokenizer struct to NULL leads to undefined
|
|
jpayne@69
|
13162 ** behaviour. The structure methods are expected to function as follows:
|
|
jpayne@69
|
13163 **
|
|
jpayne@69
|
13164 ** xCreate:
|
|
jpayne@69
|
13165 ** This function is used to allocate and initialize a tokenizer instance.
|
|
jpayne@69
|
13166 ** A tokenizer instance is required to actually tokenize text.
|
|
jpayne@69
|
13167 **
|
|
jpayne@69
|
13168 ** The first argument passed to this function is a copy of the (void*)
|
|
jpayne@69
|
13169 ** pointer provided by the application when the fts5_tokenizer object
|
|
jpayne@69
|
13170 ** was registered with FTS5 (the third argument to xCreateTokenizer()).
|
|
jpayne@69
|
13171 ** The second and third arguments are an array of nul-terminated strings
|
|
jpayne@69
|
13172 ** containing the tokenizer arguments, if any, specified following the
|
|
jpayne@69
|
13173 ** tokenizer name as part of the CREATE VIRTUAL TABLE statement used
|
|
jpayne@69
|
13174 ** to create the FTS5 table.
|
|
jpayne@69
|
13175 **
|
|
jpayne@69
|
13176 ** The final argument is an output variable. If successful, (*ppOut)
|
|
jpayne@69
|
13177 ** should be set to point to the new tokenizer handle and SQLITE_OK
|
|
jpayne@69
|
13178 ** returned. If an error occurs, some value other than SQLITE_OK should
|
|
jpayne@69
|
13179 ** be returned. In this case, fts5 assumes that the final value of *ppOut
|
|
jpayne@69
|
13180 ** is undefined.
|
|
jpayne@69
|
13181 **
|
|
jpayne@69
|
13182 ** xDelete:
|
|
jpayne@69
|
13183 ** This function is invoked to delete a tokenizer handle previously
|
|
jpayne@69
|
13184 ** allocated using xCreate(). Fts5 guarantees that this function will
|
|
jpayne@69
|
13185 ** be invoked exactly once for each successful call to xCreate().
|
|
jpayne@69
|
13186 **
|
|
jpayne@69
|
13187 ** xTokenize:
|
|
jpayne@69
|
13188 ** This function is expected to tokenize the nText byte string indicated
|
|
jpayne@69
|
13189 ** by argument pText. pText may or may not be nul-terminated. The first
|
|
jpayne@69
|
13190 ** argument passed to this function is a pointer to an Fts5Tokenizer object
|
|
jpayne@69
|
13191 ** returned by an earlier call to xCreate().
|
|
jpayne@69
|
13192 **
|
|
jpayne@69
|
13193 ** The second argument indicates the reason that FTS5 is requesting
|
|
jpayne@69
|
13194 ** tokenization of the supplied text. This is always one of the following
|
|
jpayne@69
|
13195 ** four values:
|
|
jpayne@69
|
13196 **
|
|
jpayne@69
|
13197 ** <ul><li> <b>FTS5_TOKENIZE_DOCUMENT</b> - A document is being inserted into
|
|
jpayne@69
|
13198 ** or removed from the FTS table. The tokenizer is being invoked to
|
|
jpayne@69
|
13199 ** determine the set of tokens to add to (or delete from) the
|
|
jpayne@69
|
13200 ** FTS index.
|
|
jpayne@69
|
13201 **
|
|
jpayne@69
|
13202 ** <li> <b>FTS5_TOKENIZE_QUERY</b> - A MATCH query is being executed
|
|
jpayne@69
|
13203 ** against the FTS index. The tokenizer is being called to tokenize
|
|
jpayne@69
|
13204 ** a bareword or quoted string specified as part of the query.
|
|
jpayne@69
|
13205 **
|
|
jpayne@69
|
13206 ** <li> <b>(FTS5_TOKENIZE_QUERY | FTS5_TOKENIZE_PREFIX)</b> - Same as
|
|
jpayne@69
|
13207 ** FTS5_TOKENIZE_QUERY, except that the bareword or quoted string is
|
|
jpayne@69
|
13208 ** followed by a "*" character, indicating that the last token
|
|
jpayne@69
|
13209 ** returned by the tokenizer will be treated as a token prefix.
|
|
jpayne@69
|
13210 **
|
|
jpayne@69
|
13211 ** <li> <b>FTS5_TOKENIZE_AUX</b> - The tokenizer is being invoked to
|
|
jpayne@69
|
13212 ** satisfy an fts5_api.xTokenize() request made by an auxiliary
|
|
jpayne@69
|
13213 ** function. Or an fts5_api.xColumnSize() request made by the same
|
|
jpayne@69
|
13214 ** on a columnsize=0 database.
|
|
jpayne@69
|
13215 ** </ul>
|
|
jpayne@69
|
13216 **
|
|
jpayne@69
|
13217 ** For each token in the input string, the supplied callback xToken() must
|
|
jpayne@69
|
13218 ** be invoked. The first argument to it should be a copy of the pointer
|
|
jpayne@69
|
13219 ** passed as the second argument to xTokenize(). The third and fourth
|
|
jpayne@69
|
13220 ** arguments are a pointer to a buffer containing the token text, and the
|
|
jpayne@69
|
13221 ** size of the token in bytes. The 4th and 5th arguments are the byte offsets
|
|
jpayne@69
|
13222 ** of the first byte of and first byte immediately following the text from
|
|
jpayne@69
|
13223 ** which the token is derived within the input.
|
|
jpayne@69
|
13224 **
|
|
jpayne@69
|
13225 ** The second argument passed to the xToken() callback ("tflags") should
|
|
jpayne@69
|
13226 ** normally be set to 0. The exception is if the tokenizer supports
|
|
jpayne@69
|
13227 ** synonyms. In this case see the discussion below for details.
|
|
jpayne@69
|
13228 **
|
|
jpayne@69
|
13229 ** FTS5 assumes the xToken() callback is invoked for each token in the
|
|
jpayne@69
|
13230 ** order that they occur within the input text.
|
|
jpayne@69
|
13231 **
|
|
jpayne@69
|
13232 ** If an xToken() callback returns any value other than SQLITE_OK, then
|
|
jpayne@69
|
13233 ** the tokenization should be abandoned and the xTokenize() method should
|
|
jpayne@69
|
13234 ** immediately return a copy of the xToken() return value. Or, if the
|
|
jpayne@69
|
13235 ** input buffer is exhausted, xTokenize() should return SQLITE_OK. Finally,
|
|
jpayne@69
|
13236 ** if an error occurs with the xTokenize() implementation itself, it
|
|
jpayne@69
|
13237 ** may abandon the tokenization and return any error code other than
|
|
jpayne@69
|
13238 ** SQLITE_OK or SQLITE_DONE.
|
|
jpayne@69
|
13239 **
|
|
jpayne@69
|
13240 ** SYNONYM SUPPORT
|
|
jpayne@69
|
13241 **
|
|
jpayne@69
|
13242 ** Custom tokenizers may also support synonyms. Consider a case in which a
|
|
jpayne@69
|
13243 ** user wishes to query for a phrase such as "first place". Using the
|
|
jpayne@69
|
13244 ** built-in tokenizers, the FTS5 query 'first + place' will match instances
|
|
jpayne@69
|
13245 ** of "first place" within the document set, but not alternative forms
|
|
jpayne@69
|
13246 ** such as "1st place". In some applications, it would be better to match
|
|
jpayne@69
|
13247 ** all instances of "first place" or "1st place" regardless of which form
|
|
jpayne@69
|
13248 ** the user specified in the MATCH query text.
|
|
jpayne@69
|
13249 **
|
|
jpayne@69
|
13250 ** There are several ways to approach this in FTS5:
|
|
jpayne@69
|
13251 **
|
|
jpayne@69
|
13252 ** <ol><li> By mapping all synonyms to a single token. In this case, using
|
|
jpayne@69
|
13253 ** the above example, this means that the tokenizer returns the
|
|
jpayne@69
|
13254 ** same token for inputs "first" and "1st". Say that token is in
|
|
jpayne@69
|
13255 ** fact "first", so that when the user inserts the document "I won
|
|
jpayne@69
|
13256 ** 1st place" entries are added to the index for tokens "i", "won",
|
|
jpayne@69
|
13257 ** "first" and "place". If the user then queries for '1st + place',
|
|
jpayne@69
|
13258 ** the tokenizer substitutes "first" for "1st" and the query works
|
|
jpayne@69
|
13259 ** as expected.
|
|
jpayne@69
|
13260 **
|
|
jpayne@69
|
13261 ** <li> By querying the index for all synonyms of each query term
|
|
jpayne@69
|
13262 ** separately. In this case, when tokenizing query text, the
|
|
jpayne@69
|
13263 ** tokenizer may provide multiple synonyms for a single term
|
|
jpayne@69
|
13264 ** within the document. FTS5 then queries the index for each
|
|
jpayne@69
|
13265 ** synonym individually. For example, faced with the query:
|
|
jpayne@69
|
13266 **
|
|
jpayne@69
|
13267 ** <codeblock>
|
|
jpayne@69
|
13268 ** ... MATCH 'first place'</codeblock>
|
|
jpayne@69
|
13269 **
|
|
jpayne@69
|
13270 ** the tokenizer offers both "1st" and "first" as synonyms for the
|
|
jpayne@69
|
13271 ** first token in the MATCH query and FTS5 effectively runs a query
|
|
jpayne@69
|
13272 ** similar to:
|
|
jpayne@69
|
13273 **
|
|
jpayne@69
|
13274 ** <codeblock>
|
|
jpayne@69
|
13275 ** ... MATCH '(first OR 1st) place'</codeblock>
|
|
jpayne@69
|
13276 **
|
|
jpayne@69
|
13277 ** except that, for the purposes of auxiliary functions, the query
|
|
jpayne@69
|
13278 ** still appears to contain just two phrases - "(first OR 1st)"
|
|
jpayne@69
|
13279 ** being treated as a single phrase.
|
|
jpayne@69
|
13280 **
|
|
jpayne@69
|
13281 ** <li> By adding multiple synonyms for a single term to the FTS index.
|
|
jpayne@69
|
13282 ** Using this method, when tokenizing document text, the tokenizer
|
|
jpayne@69
|
13283 ** provides multiple synonyms for each token. So that when a
|
|
jpayne@69
|
13284 ** document such as "I won first place" is tokenized, entries are
|
|
jpayne@69
|
13285 ** added to the FTS index for "i", "won", "first", "1st" and
|
|
jpayne@69
|
13286 ** "place".
|
|
jpayne@69
|
13287 **
|
|
jpayne@69
|
13288 ** This way, even if the tokenizer does not provide synonyms
|
|
jpayne@69
|
13289 ** when tokenizing query text (it should not - to do so would be
|
|
jpayne@69
|
13290 ** inefficient), it doesn't matter if the user queries for
|
|
jpayne@69
|
13291 ** 'first + place' or '1st + place', as there are entries in the
|
|
jpayne@69
|
13292 ** FTS index corresponding to both forms of the first token.
|
|
jpayne@69
|
13293 ** </ol>
|
|
jpayne@69
|
13294 **
|
|
jpayne@69
|
13295 ** Whether it is parsing document or query text, any call to xToken that
|
|
jpayne@69
|
13296 ** specifies a <i>tflags</i> argument with the FTS5_TOKEN_COLOCATED bit
|
|
jpayne@69
|
13297 ** is considered to supply a synonym for the previous token. For example,
|
|
jpayne@69
|
13298 ** when parsing the document "I won first place", a tokenizer that supports
|
|
jpayne@69
|
13299 ** synonyms would call xToken() 5 times, as follows:
|
|
jpayne@69
|
13300 **
|
|
jpayne@69
|
13301 ** <codeblock>
|
|
jpayne@69
|
13302 ** xToken(pCtx, 0, "i", 1, 0, 1);
|
|
jpayne@69
|
13303 ** xToken(pCtx, 0, "won", 3, 2, 5);
|
|
jpayne@69
|
13304 ** xToken(pCtx, 0, "first", 5, 6, 11);
|
|
jpayne@69
|
13305 ** xToken(pCtx, FTS5_TOKEN_COLOCATED, "1st", 3, 6, 11);
|
|
jpayne@69
|
13306 ** xToken(pCtx, 0, "place", 5, 12, 17);
|
|
jpayne@69
|
13307 **</codeblock>
|
|
jpayne@69
|
13308 **
|
|
jpayne@69
|
13309 ** It is an error to specify the FTS5_TOKEN_COLOCATED flag the first time
|
|
jpayne@69
|
13310 ** xToken() is called. Multiple synonyms may be specified for a single token
|
|
jpayne@69
|
13311 ** by making multiple calls to xToken(FTS5_TOKEN_COLOCATED) in sequence.
|
|
jpayne@69
|
13312 ** There is no limit to the number of synonyms that may be provided for a
|
|
jpayne@69
|
13313 ** single token.
|
|
jpayne@69
|
13314 **
|
|
jpayne@69
|
13315 ** In many cases, method (1) above is the best approach. It does not add
|
|
jpayne@69
|
13316 ** extra data to the FTS index or require FTS5 to query for multiple terms,
|
|
jpayne@69
|
13317 ** so it is efficient in terms of disk space and query speed. However, it
|
|
jpayne@69
|
13318 ** does not support prefix queries very well. If, as suggested above, the
|
|
jpayne@69
|
13319 ** token "first" is substituted for "1st" by the tokenizer, then the query:
|
|
jpayne@69
|
13320 **
|
|
jpayne@69
|
13321 ** <codeblock>
|
|
jpayne@69
|
13322 ** ... MATCH '1s*'</codeblock>
|
|
jpayne@69
|
13323 **
|
|
jpayne@69
|
13324 ** will not match documents that contain the token "1st" (as the tokenizer
|
|
jpayne@69
|
13325 ** will probably not map "1s" to any prefix of "first").
|
|
jpayne@69
|
13326 **
|
|
jpayne@69
|
13327 ** For full prefix support, method (3) may be preferred. In this case,
|
|
jpayne@69
|
13328 ** because the index contains entries for both "first" and "1st", prefix
|
|
jpayne@69
|
13329 ** queries such as 'fi*' or '1s*' will match correctly. However, because
|
|
jpayne@69
|
13330 ** extra entries are added to the FTS index, this method uses more space
|
|
jpayne@69
|
13331 ** within the database.
|
|
jpayne@69
|
13332 **
|
|
jpayne@69
|
13333 ** Method (2) offers a midpoint between (1) and (3). Using this method,
|
|
jpayne@69
|
13334 ** a query such as '1s*' will match documents that contain the literal
|
|
jpayne@69
|
13335 ** token "1st", but not "first" (assuming the tokenizer is not able to
|
|
jpayne@69
|
13336 ** provide synonyms for prefixes). However, a non-prefix query like '1st'
|
|
jpayne@69
|
13337 ** will match against "1st" and "first". This method does not require
|
|
jpayne@69
|
13338 ** extra disk space, as no extra entries are added to the FTS index.
|
|
jpayne@69
|
13339 ** On the other hand, it may require more CPU cycles to run MATCH queries,
|
|
jpayne@69
|
13340 ** as separate queries of the FTS index are required for each synonym.
|
|
jpayne@69
|
13341 **
|
|
jpayne@69
|
13342 ** When using methods (2) or (3), it is important that the tokenizer only
|
|
jpayne@69
|
13343 ** provide synonyms when tokenizing document text (method (3)) or query
|
|
jpayne@69
|
13344 ** text (method (2)), not both. Doing so will not cause any errors, but is
|
|
jpayne@69
|
13345 ** inefficient.
|
|
jpayne@69
|
13346 */
|
|
jpayne@69
|
13347 typedef struct Fts5Tokenizer Fts5Tokenizer;
|
|
jpayne@69
|
13348 typedef struct fts5_tokenizer fts5_tokenizer;
|
|
jpayne@69
|
13349 struct fts5_tokenizer {
|
|
jpayne@69
|
13350 int (*xCreate)(void*, const char **azArg, int nArg, Fts5Tokenizer **ppOut);
|
|
jpayne@69
|
13351 void (*xDelete)(Fts5Tokenizer*);
|
|
jpayne@69
|
13352 int (*xTokenize)(Fts5Tokenizer*,
|
|
jpayne@69
|
13353 void *pCtx,
|
|
jpayne@69
|
13354 int flags, /* Mask of FTS5_TOKENIZE_* flags */
|
|
jpayne@69
|
13355 const char *pText, int nText,
|
|
jpayne@69
|
13356 int (*xToken)(
|
|
jpayne@69
|
13357 void *pCtx, /* Copy of 2nd argument to xTokenize() */
|
|
jpayne@69
|
13358 int tflags, /* Mask of FTS5_TOKEN_* flags */
|
|
jpayne@69
|
13359 const char *pToken, /* Pointer to buffer containing token */
|
|
jpayne@69
|
13360 int nToken, /* Size of token in bytes */
|
|
jpayne@69
|
13361 int iStart, /* Byte offset of token within input text */
|
|
jpayne@69
|
13362 int iEnd /* Byte offset of end of token within input text */
|
|
jpayne@69
|
13363 )
|
|
jpayne@69
|
13364 );
|
|
jpayne@69
|
13365 };
|
|
jpayne@69
|
13366
|
|
jpayne@69
|
13367 /* Flags that may be passed as the third argument to xTokenize() */
|
|
jpayne@69
|
13368 #define FTS5_TOKENIZE_QUERY 0x0001
|
|
jpayne@69
|
13369 #define FTS5_TOKENIZE_PREFIX 0x0002
|
|
jpayne@69
|
13370 #define FTS5_TOKENIZE_DOCUMENT 0x0004
|
|
jpayne@69
|
13371 #define FTS5_TOKENIZE_AUX 0x0008
|
|
jpayne@69
|
13372
|
|
jpayne@69
|
13373 /* Flags that may be passed by the tokenizer implementation back to FTS5
|
|
jpayne@69
|
13374 ** as the third argument to the supplied xToken callback. */
|
|
jpayne@69
|
13375 #define FTS5_TOKEN_COLOCATED 0x0001 /* Same position as prev. token */
|
|
jpayne@69
|
13376
|
|
jpayne@69
|
13377 /*
|
|
jpayne@69
|
13378 ** END OF CUSTOM TOKENIZERS
|
|
jpayne@69
|
13379 *************************************************************************/
|
|
jpayne@69
|
13380
|
|
jpayne@69
|
13381 /*************************************************************************
|
|
jpayne@69
|
13382 ** FTS5 EXTENSION REGISTRATION API
|
|
jpayne@69
|
13383 */
|
|
jpayne@69
|
13384 typedef struct fts5_api fts5_api;
|
|
jpayne@69
|
13385 struct fts5_api {
|
|
jpayne@69
|
13386 int iVersion; /* Currently always set to 2 */
|
|
jpayne@69
|
13387
|
|
jpayne@69
|
13388 /* Create a new tokenizer */
|
|
jpayne@69
|
13389 int (*xCreateTokenizer)(
|
|
jpayne@69
|
13390 fts5_api *pApi,
|
|
jpayne@69
|
13391 const char *zName,
|
|
jpayne@69
|
13392 void *pUserData,
|
|
jpayne@69
|
13393 fts5_tokenizer *pTokenizer,
|
|
jpayne@69
|
13394 void (*xDestroy)(void*)
|
|
jpayne@69
|
13395 );
|
|
jpayne@69
|
13396
|
|
jpayne@69
|
13397 /* Find an existing tokenizer */
|
|
jpayne@69
|
13398 int (*xFindTokenizer)(
|
|
jpayne@69
|
13399 fts5_api *pApi,
|
|
jpayne@69
|
13400 const char *zName,
|
|
jpayne@69
|
13401 void **ppUserData,
|
|
jpayne@69
|
13402 fts5_tokenizer *pTokenizer
|
|
jpayne@69
|
13403 );
|
|
jpayne@69
|
13404
|
|
jpayne@69
|
13405 /* Create a new auxiliary function */
|
|
jpayne@69
|
13406 int (*xCreateFunction)(
|
|
jpayne@69
|
13407 fts5_api *pApi,
|
|
jpayne@69
|
13408 const char *zName,
|
|
jpayne@69
|
13409 void *pUserData,
|
|
jpayne@69
|
13410 fts5_extension_function xFunction,
|
|
jpayne@69
|
13411 void (*xDestroy)(void*)
|
|
jpayne@69
|
13412 );
|
|
jpayne@69
|
13413 };
|
|
jpayne@69
|
13414
|
|
jpayne@69
|
13415 /*
|
|
jpayne@69
|
13416 ** END OF REGISTRATION API
|
|
jpayne@69
|
13417 *************************************************************************/
|
|
jpayne@69
|
13418
|
|
jpayne@69
|
13419 #ifdef __cplusplus
|
|
jpayne@69
|
13420 } /* end of the 'extern "C"' block */
|
|
jpayne@69
|
13421 #endif
|
|
jpayne@69
|
13422
|
|
jpayne@69
|
13423 #endif /* _FTS5_H */
|
|
jpayne@69
|
13424
|
|
jpayne@69
|
13425 /******** End of fts5.h *********/
|
