wasCSharpSQLite – Blame information for rev
?pathlinks?
Rev | Author | Line No. | Line |
---|---|---|---|
1 | office | 1 | using u8 = System.Byte; |
2 | using System.Diagnostics; |
||
3 | |||
4 | namespace Community.CsharpSqlite |
||
5 | { |
||
6 | public partial class Sqlite3 |
||
7 | { |
||
8 | /* |
||
9 | ** 2001 September 15 |
||
10 | ** |
||
11 | ** The author disclaims copyright to this source code. In place of |
||
12 | ** a legal notice, here is a blessing: |
||
13 | ** |
||
14 | ** May you do good and not evil. |
||
15 | ** May you find forgiveness for yourself and forgive others. |
||
16 | ** May you share freely, never taking more than you give. |
||
17 | ** |
||
18 | ************************************************************************* |
||
19 | ** This header file defines the interface that the SQLite library |
||
20 | ** presents to client programs. If a C-function, structure, datatype, |
||
21 | ** or constant definition does not appear in this file, then it is |
||
22 | ** not a published API of SQLite, is subject to change without |
||
23 | ** notice, and should not be referenced by programs that use SQLite. |
||
24 | ** |
||
25 | ** Some of the definitions that are in this file are marked as |
||
26 | ** "experimental". Experimental interfaces are normally new |
||
27 | ** features recently added to SQLite. We do not anticipate changes |
||
28 | ** to experimental interfaces but reserve the right to make minor changes |
||
29 | ** if experience from use "in the wild" suggest such changes are prudent. |
||
30 | ** |
||
31 | ** The official C-language API documentation for SQLite is derived |
||
32 | ** from comments in this file. This file is the authoritative source |
||
33 | ** on how SQLite interfaces are suppose to operate. |
||
34 | ** |
||
35 | ** The name of this file under configuration management is "sqlite.h.in". |
||
36 | ** The makefile makes some minor changes to this file (such as inserting |
||
37 | ** the version number) and changes its name to "sqlite3.h" as |
||
38 | ** part of the build process. |
||
39 | ************************************************************************* |
||
40 | ** Included in SQLite3 port to C#-SQLite; 2008 Noah B Hart |
||
41 | ** C#-SQLite is an independent reimplementation of the SQLite software library |
||
42 | ** |
||
43 | ** SQLITE_SOURCE_ID: 2011-06-23 19:49:22 4374b7e83ea0a3fbc3691f9c0c936272862f32f2 |
||
44 | ** |
||
45 | ************************************************************************* |
||
46 | */ |
||
47 | //#if !_SQLITE3_H_ |
||
48 | //#define _SQLITE3_H_ |
||
49 | //#include <stdarg.h> /* Needed for the definition of va_list */ |
||
50 | |||
51 | /* |
||
52 | ** Make sure we can call this stuff from C++. |
||
53 | */ |
||
54 | //#if __cplusplus |
||
55 | //extern "C" { |
||
56 | //#endif |
||
57 | |||
58 | |||
59 | /* |
||
60 | ** Add the ability to override 'extern' |
||
61 | */ |
||
62 | //#if !SQLITE_EXTERN |
||
63 | //# define SQLITE_EXTERN extern |
||
64 | //#endif |
||
65 | |||
66 | //#if !SQLITE_API |
||
67 | //# define SQLITE_API |
||
68 | //#endif |
||
69 | |||
70 | |||
71 | /* |
||
72 | ** These no-op macros are used in front of interfaces to mark those |
||
73 | ** interfaces as either deprecated or experimental. New applications |
||
74 | ** should not use deprecated interfaces - they are support for backwards |
||
75 | ** compatibility only. Application writers should be aware that |
||
76 | ** experimental interfaces are subject to change in point releases. |
||
77 | ** |
||
78 | ** These macros used to resolve to various kinds of compiler magic that |
||
79 | ** would generate warning messages when they were used. But that |
||
80 | ** compiler magic ended up generating such a flurry of bug reports |
||
81 | ** that we have taken it all out and gone back to using simple |
||
82 | ** noop macros. |
||
83 | */ |
||
84 | //#define SQLITE_DEPRECATED |
||
85 | //#define SQLITE_EXPERIMENTAL |
||
86 | |||
87 | /* |
||
88 | ** Ensure these symbols were not defined by some previous header file. |
||
89 | */ |
||
90 | //#if SQLITE_VERSION |
||
91 | //# undef SQLITE_VERSION |
||
92 | //#endif |
||
93 | //#if SQLITE_VERSION_NUMBER |
||
94 | //# undef SQLITE_VERSION_NUMBER |
||
95 | //#endif |
||
96 | |||
97 | /* |
||
98 | ** CAPI3REF: Compile-Time Library Version Numbers |
||
99 | ** |
||
100 | ** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header |
||
101 | ** evaluates to a string literal that is the SQLite version in the |
||
102 | ** format "X.Y.Z" where X is the major version number (always 3 for |
||
103 | ** SQLite3) and Y is the minor version number and Z is the release number.)^ |
||
104 | ** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer |
||
105 | ** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z are the same |
||
106 | ** numbers used in [SQLITE_VERSION].)^ |
||
107 | ** The SQLITE_VERSION_NUMBER for any given release of SQLite will also |
||
108 | ** be larger than the release from which it is derived. Either Y will |
||
109 | ** be held constant and Z will be incremented or else Y will be incremented |
||
110 | ** and Z will be reset to zero. |
||
111 | ** |
||
112 | ** Since version 3.6.18, SQLite source code has been stored in the |
||
113 | ** <a href="http://www.fossil-scm.org/">Fossil configuration management |
||
114 | ** system</a>. ^The SQLITE_SOURCE_ID macro evaluates to |
||
115 | ** a string which identifies a particular check-in of SQLite |
||
116 | ** within its configuration management system. ^The SQLITE_SOURCE_ID |
||
117 | ** string contains the date and time of the check-in (UTC) and an SHA1 |
||
118 | ** hash of the entire source tree. |
||
119 | ** |
||
120 | ** See also: [sqlite3_libversion()], |
||
121 | ** [sqlite3_libversion_number()], [sqlite3_sourceid()], |
||
122 | ** [sqlite_version()] and [sqlite_source_id()]. |
||
123 | */ |
||
124 | //#define SQLITE_VERSION "3.7.7" |
||
125 | //#define SQLITE_VERSION_NUMBER 3007007 |
||
126 | //#define SQLITE_SOURCE_ID "2011-06-23 19:49:22 4374b7e83ea0a3fbc3691f9c0c936272862f32f2" |
||
127 | const string SQLITE_VERSION = "3.7.7(C#)"; |
||
128 | const int SQLITE_VERSION_NUMBER = 300700701; |
||
129 | const string SQLITE_SOURCE_ID = "Ported to C# from 2011-06-23 19:49:22 4374b7e83ea0a3fbc3691f9c0c936272862f32f2"; |
||
130 | |||
131 | /* |
||
132 | ** CAPI3REF: Run-Time Library Version Numbers |
||
133 | ** KEYWORDS: sqlite3_version, sqlite3_sourceid |
||
134 | ** |
||
135 | ** These interfaces provide the same information as the [SQLITE_VERSION], |
||
136 | ** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros |
||
137 | ** but are associated with the library instead of the header file. ^(Cautious |
||
138 | ** programmers might include Debug.Assert() statements in their application to |
||
139 | ** verify that values returned by these interfaces match the macros in |
||
140 | ** the header, and thus insure that the application is |
||
141 | ** compiled with matching library and header files. |
||
142 | ** |
||
143 | ** <blockquote><pre> |
||
144 | ** Debug.Assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER ); |
||
145 | ** Debug.Assert( strcmp(sqlite3_sourceid(),SQLITE_SOURCE_ID)==0 ); |
||
146 | ** Debug.Assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 ); |
||
147 | ** </pre></blockquote>)^ |
||
148 | ** |
||
149 | ** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION] |
||
150 | ** macro. ^The sqlite3_libversion() function returns a pointer to the |
||
151 | ** to the sqlite3_version[] string constant. The sqlite3_libversion() |
||
152 | ** function is provided for use in DLLs since DLL users usually do not have |
||
153 | ** direct access to string constants within the DLL. ^The |
||
154 | ** sqlite3_libversion_number() function returns an integer equal to |
||
155 | ** [SQLITE_VERSION_NUMBER]. ^The sqlite3_sourceid() function returns |
||
156 | ** a pointer to a string constant whose value is the same as the |
||
157 | ** [SQLITE_SOURCE_ID] C preprocessor macro. |
||
158 | ** |
||
159 | ** See also: [sqlite_version()] and [sqlite_source_id()]. |
||
160 | */ |
||
161 | //SQLITE_API SQLITE_EXTERN const char sqlite3_version[]; |
||
162 | //SQLITE_API string sqlite3_libversion(void); |
||
163 | //SQLITE_API string sqlite3_sourceid(void); |
||
164 | //SQLITE_API int sqlite3_libversion_number(void); |
||
165 | |||
166 | /* |
||
167 | ** CAPI3REF: Run-Time Library Compilation Options Diagnostics |
||
168 | ** |
||
169 | ** ^The sqlite3_compileoption_used() function returns 0 or 1 |
||
170 | ** indicating whether the specified option was defined at |
||
171 | ** compile time. ^The SQLITE_ prefix may be omitted from the |
||
172 | ** option name passed to sqlite3_compileoption_used(). |
||
173 | ** |
||
174 | ** ^The sqlite3_compileoption_get() function allows iterating |
||
175 | ** over the list of options that were defined at compile time by |
||
176 | ** returning the N-th compile time option string. ^If N is out of range, |
||
177 | ** sqlite3_compileoption_get() returns a NULL pointer. ^The SQLITE_ |
||
178 | ** prefix is omitted from any strings returned by |
||
179 | ** sqlite3_compileoption_get(). |
||
180 | ** |
||
181 | ** ^Support for the diagnostic functions sqlite3_compileoption_used() |
||
182 | ** and sqlite3_compileoption_get() may be omitted by specifying the |
||
183 | ** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time. |
||
184 | ** |
||
185 | ** See also: SQL functions [sqlite_compileoption_used()] and |
||
186 | ** [sqlite_compileoption_get()] and the [compile_options pragma]. |
||
187 | */ |
||
188 | //#if !SQLITE_OMIT_COMPILEOPTION_DIAGS |
||
189 | //SQLITE_API int sqlite3_compileoption_used(string zOptName); |
||
190 | //SQLITE_API string sqlite3_compileoption_get(int N); |
||
191 | //#endif |
||
192 | |||
193 | /* |
||
194 | ** CAPI3REF: Test To See If The Library Is Threadsafe |
||
195 | ** |
||
196 | ** ^The sqlite3_threadsafe() function returns zero if and only if |
||
197 | ** SQLite was compiled mutexing code omitted due to the |
||
198 | ** [SQLITE_THREADSAFE] compile-time option being set to 0. |
||
199 | ** |
||
200 | ** SQLite can be compiled with or without mutexes. When |
||
201 | ** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes |
||
202 | ** are enabled and SQLite is threadsafe. When the |
||
203 | ** [SQLITE_THREADSAFE] macro is 0, |
||
204 | ** the mutexes are omitted. Without the mutexes, it is not safe |
||
205 | ** to use SQLite concurrently from more than one thread. |
||
206 | ** |
||
207 | ** Enabling mutexes incurs a measurable performance penalty. |
||
208 | ** So if speed is of utmost importance, it makes sense to disable |
||
209 | ** the mutexes. But for maximum safety, mutexes should be enabled. |
||
210 | ** ^The default behavior is for mutexes to be enabled. |
||
211 | ** |
||
212 | ** This interface can be used by an application to make sure that the |
||
213 | ** version of SQLite that it is linking against was compiled with |
||
214 | ** the desired setting of the [SQLITE_THREADSAFE] macro. |
||
215 | ** |
||
216 | ** This interface only reports on the compile-time mutex setting |
||
217 | ** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with |
||
218 | ** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but |
||
219 | ** can be fully or partially disabled using a call to [sqlite3_config()] |
||
220 | ** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD], |
||
221 | ** or [SQLITE_CONFIG_MUTEX]. ^(The return value of the |
||
222 | ** sqlite3_threadsafe() function shows only the compile-time setting of |
||
223 | ** thread safety, not any run-time changes to that setting made by |
||
224 | ** sqlite3_config(). In other words, the return value from sqlite3_threadsafe() |
||
225 | ** is unchanged by calls to sqlite3_config().)^ |
||
226 | ** |
||
227 | ** See the [threading mode] documentation for additional information. |
||
228 | */ |
||
229 | //SQLITE_API int sqlite3_threadsafe(void); |
||
230 | |||
231 | /* |
||
232 | ** CAPI3REF: Database Connection Handle |
||
233 | ** KEYWORDS: {database connection} {database connections} |
||
234 | ** |
||
235 | ** Each open SQLite database is represented by a pointer to an instance of |
||
236 | ** the opaque structure named "sqlite3". It is useful to think of an sqlite3 |
||
237 | ** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and |
||
238 | ** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()] |
||
239 | ** is its destructor. There are many other interfaces (such as |
||
240 | ** [sqlite3_prepare_v2()], [sqlite3_create_function()], and |
||
241 | ** [sqlite3_busy_timeout()] to name but three) that are methods on an |
||
242 | ** sqlite3 object. |
||
243 | */ |
||
244 | //typedef struct sqlite3 sqlite3; |
||
245 | |||
246 | /* |
||
247 | ** CAPI3REF: 64-Bit Integer Types |
||
248 | ** KEYWORDS: sqlite_int64 sqlite_uint64 |
||
249 | ** |
||
250 | ** Because there is no cross-platform way to specify 64-bit integer types |
||
251 | ** SQLite includes typedefs for 64-bit signed and unsigned integers. |
||
252 | ** |
||
253 | ** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions. |
||
254 | ** The sqlite_int64 and sqlite_uint64 types are supported for backwards |
||
255 | ** compatibility only. |
||
256 | ** |
||
257 | ** ^The sqlite3_int64 and sqlite_int64 types can store integer values |
||
258 | ** between -9223372036854775808 and +9223372036854775807 inclusive. ^The |
||
259 | ** sqlite3_uint64 and sqlite_uint64 types can store integer values |
||
260 | ** between 0 and +18446744073709551615 inclusive. |
||
261 | */ |
||
262 | //#if SQLITE_INT64_TYPE |
||
263 | // typedef SQLITE_INT64_TYPE sqlite_int64; |
||
264 | // typedef unsigned SQLITE_INT64_TYPE sqlite_uint64; |
||
265 | //#elif defined(_MSC_VER) || defined(__BORLANDC__) |
||
266 | // typedef __int64 sqlite_int64; |
||
267 | // typedef unsigned __int64 sqlite_uint64; |
||
268 | //#else |
||
269 | // typedef long long int sqlite_int64; |
||
270 | // typedef unsigned long long int sqlite_uint64; |
||
271 | //#endif |
||
272 | //typedef sqlite_int64 sqlite3_int64; |
||
273 | //typedef sqlite_uint64 sqlite3_uint64; |
||
274 | |||
275 | /* |
||
276 | ** If compiling for a processor that lacks floating point support, |
||
277 | ** substitute integer for floating-point. |
||
278 | */ |
||
279 | //#if SQLITE_OMIT_FLOATING_POINT |
||
280 | //# define double sqlite3_int64 |
||
281 | //#endif |
||
282 | |||
283 | /* |
||
284 | ** CAPI3REF: Closing A Database Connection |
||
285 | ** |
||
286 | ** ^The sqlite3_close() routine is the destructor for the [sqlite3] object. |
||
287 | ** ^Calls to sqlite3_close() return SQLITE_OK if the [sqlite3] object is |
||
288 | ** successfully destroyed and all associated resources are deallocated. |
||
289 | ** |
||
290 | ** Applications must [sqlite3_finalize | finalize] all [prepared statements] |
||
291 | ** and [sqlite3_blob_close | close] all [BLOB handles] associated with |
||
292 | ** the [sqlite3] object prior to attempting to close the object. ^If |
||
293 | ** sqlite3_close() is called on a [database connection] that still has |
||
294 | ** outstanding [prepared statements] or [BLOB handles], then it returns |
||
295 | ** SQLITE_BUSY. |
||
296 | ** |
||
297 | ** ^If [sqlite3_close()] is invoked while a transaction is open, |
||
298 | ** the transaction is automatically rolled back. |
||
299 | ** |
||
300 | ** The C parameter to [sqlite3_close(C)] must be either a NULL |
||
301 | ** pointer or an [sqlite3] object pointer obtained |
||
302 | ** from [sqlite3_open()], [sqlite3_open16()], or |
||
303 | ** [sqlite3_open_v2()], and not previously closed. |
||
304 | ** ^Calling sqlite3_close() with a NULL pointer argument is a |
||
305 | ** harmless no-op. |
||
306 | */ |
||
307 | //SQLITE_API int sqlite3_close(sqlite3 ); |
||
308 | |||
309 | /* |
||
310 | ** The type for a callback function. |
||
311 | ** This is legacy and deprecated. It is included for historical |
||
312 | ** compatibility and is not documented. |
||
313 | */ |
||
314 | //typedef int (*sqlite3_callback)(void*,int,char**, char*); |
||
315 | |||
316 | /* |
||
317 | ** CAPI3REF: One-Step Query Execution Interface |
||
318 | ** |
||
319 | ** The sqlite3_exec() interface is a convenience wrapper around |
||
320 | ** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()], |
||
321 | ** that allows an application to run multiple statements of SQL |
||
322 | ** without having to use a lot of C code. |
||
323 | ** |
||
324 | ** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded, |
||
325 | ** semicolon-separate SQL statements passed into its 2nd argument, |
||
326 | ** in the context of the [database connection] passed in as its 1st |
||
327 | ** argument. ^If the callback function of the 3rd argument to |
||
328 | ** sqlite3_exec() is not NULL, then it is invoked for each result row |
||
329 | ** coming out of the evaluated SQL statements. ^The 4th argument to |
||
330 | ** sqlite3_exec() is relayed through to the 1st argument of each |
||
331 | ** callback invocation. ^If the callback pointer to sqlite3_exec() |
||
332 | ** is NULL, then no callback is ever invoked and result rows are |
||
333 | ** ignored. |
||
334 | ** |
||
335 | ** ^If an error occurs while evaluating the SQL statements passed into |
||
336 | ** sqlite3_exec(), then execution of the current statement stops and |
||
337 | ** subsequent statements are skipped. ^If the 5th parameter to sqlite3_exec() |
||
338 | ** is not NULL then any error message is written into memory obtained |
||
339 | ** from [sqlite3_malloc()] and passed back through the 5th parameter. |
||
340 | ** To avoid memory leaks, the application should invoke [sqlite3_free()] |
||
341 | ** on error message strings returned through the 5th parameter of |
||
342 | ** of sqlite3_exec() after the error message string is no longer needed. |
||
343 | ** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors |
||
344 | ** occur, then sqlite3_exec() sets the pointer in its 5th parameter to |
||
345 | ** NULL before returning. |
||
346 | ** |
||
347 | ** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec() |
||
348 | ** routine returns SQLITE_ABORT without invoking the callback again and |
||
349 | ** without running any subsequent SQL statements. |
||
350 | ** |
||
351 | ** ^The 2nd argument to the sqlite3_exec() callback function is the |
||
352 | ** number of columns in the result. ^The 3rd argument to the sqlite3_exec() |
||
353 | ** callback is an array of pointers to strings obtained as if from |
||
354 | ** [sqlite3_column_text()], one for each column. ^If an element of a |
||
355 | ** result row is NULL then the corresponding string pointer for the |
||
356 | ** sqlite3_exec() callback is a NULL pointer. ^The 4th argument to the |
||
357 | ** sqlite3_exec() callback is an array of pointers to strings where each |
||
358 | ** entry represents the name of corresponding result column as obtained |
||
359 | ** from [sqlite3_column_name()]. |
||
360 | ** |
||
361 | ** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer |
||
362 | ** to an empty string, or a pointer that contains only whitespace and/or |
||
363 | ** SQL comments, then no SQL statements are evaluated and the database |
||
364 | ** is not changed. |
||
365 | ** |
||
366 | ** Restrictions: |
||
367 | ** |
||
368 | ** <ul> |
||
369 | ** <li> The application must insure that the 1st parameter to sqlite3_exec() |
||
370 | ** is a valid and open [database connection]. |
||
371 | ** <li> The application must not close [database connection] specified by |
||
372 | ** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running. |
||
373 | ** <li> The application must not modify the SQL statement text passed into |
||
374 | ** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running. |
||
375 | ** </ul> |
||
376 | */ |
||
377 | //SQLITE_API int sqlite3_exec( |
||
378 | // sqlite3*, /* An open database */ |
||
379 | // string sql, /* SQL to be evaluated */ |
||
380 | // int (*callback)(void*,int,char**,char*), /* Callback function */ |
||
381 | // void *, /* 1st argument to callback */ |
||
382 | // char **errmsg /* Error msg written here */ |
||
383 | //); |
||
384 | |||
385 | /* |
||
386 | ** CAPI3REF: Result Codes |
||
387 | ** KEYWORDS: SQLITE_OK {error code} {error codes} |
||
388 | ** KEYWORDS: {result code} {result codes} |
||
389 | ** |
||
390 | ** Many SQLite functions return an integer result code from the set shown |
||
391 | ** here in order to indicates success or failure. |
||
392 | ** |
||
393 | ** New error codes may be added in future versions of SQLite. |
||
394 | ** |
||
395 | ** See also: [SQLITE_IOERR_READ | extended result codes], |
||
396 | ** [sqlite3_vtab_on_conflict()] [SQLITE_ROLLBACK | result codes]. |
||
397 | */ |
||
398 | //#define SQLITE_OK 0 /* Successful result */ |
||
399 | ///* beginning-of-error-codes */ |
||
400 | //#define SQLITE_ERROR 1 /* SQL error or missing database */ |
||
401 | //#define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */ |
||
402 | //#define SQLITE_PERM 3 /* Access permission denied */ |
||
403 | //#define SQLITE_ABORT 4 /* Callback routine requested an abort */ |
||
404 | //#define SQLITE_BUSY 5 /* The database file is locked */ |
||
405 | //#define SQLITE_LOCKED 6 /* A table in the database is locked */ |
||
406 | //#define SQLITE_NOMEM 7 /* A malloc() failed */ |
||
407 | //#define SQLITE_READONLY 8 /* Attempt to write a readonly database */ |
||
408 | //#define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/ |
||
409 | //#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */ |
||
410 | //#define SQLITE_CORRUPT 11 /* The database disk image is malformed */ |
||
411 | //#define SQLITE_NOTFOUND 12 /* Unknown opcode in sqlite3_file_control() */ |
||
412 | //#define SQLITE_FULL 13 /* Insertion failed because database is full */ |
||
413 | //#define SQLITE_CANTOPEN 14 /* Unable to open the database file */ |
||
414 | //#define SQLITE_PROTOCOL 15 /* Database lock protocol error */ |
||
415 | //#define SQLITE_EMPTY 16 /* Database is empty */ |
||
416 | //#define SQLITE_SCHEMA 17 /* The database schema changed */ |
||
417 | //#define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */ |
||
418 | //#define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */ |
||
419 | //#define SQLITE_MISMATCH 20 /* Data type mismatch */ |
||
420 | //#define SQLITE_MISUSE 21 /* Library used incorrectly */ |
||
421 | //#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */ |
||
422 | //#define SQLITE_AUTH 23 /* Authorization denied */ |
||
423 | //#define SQLITE_FORMAT 24 /* Auxiliary database format error */ |
||
424 | //#define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */ |
||
425 | //#define SQLITE_NOTADB 26 /* File opened that is not a database file */ |
||
426 | //#define SQLITE_ROW 100 /* sqlite3_step() has another row ready */ |
||
427 | //#define SQLITE_DONE 101 /* sqlite3_step() has finished executing */ |
||
428 | /* end-of-error-codes */ |
||
429 | public const int SQLITE_OK = 0; |
||
430 | public const int SQLITE_ERROR = 1; |
||
431 | public const int SQLITE_INTERNAL = 2; |
||
432 | public const int SQLITE_PERM = 3; |
||
433 | public const int SQLITE_ABORT = 4; |
||
434 | public const int SQLITE_BUSY = 5; |
||
435 | public const int SQLITE_LOCKED = 6; |
||
436 | public const int SQLITE_NOMEM = 7; |
||
437 | public const int SQLITE_READONLY = 8; |
||
438 | public const int SQLITE_INTERRUPT = 9; |
||
439 | public const int SQLITE_IOERR = 10; |
||
440 | public const int SQLITE_CORRUPT = 11; |
||
441 | public const int SQLITE_NOTFOUND = 12; |
||
442 | public const int SQLITE_FULL = 13; |
||
443 | public const int SQLITE_CANTOPEN = 14; |
||
444 | public const int SQLITE_PROTOCOL = 15; |
||
445 | public const int SQLITE_EMPTY = 16; |
||
446 | public const int SQLITE_SCHEMA = 17; |
||
447 | public const int SQLITE_TOOBIG = 18; |
||
448 | public const int SQLITE_CONSTRAINT = 19; |
||
449 | public const int SQLITE_MISMATCH = 20; |
||
450 | public const int SQLITE_MISUSE = 21; |
||
451 | public const int SQLITE_NOLFS = 22; |
||
452 | public const int SQLITE_AUTH = 23; |
||
453 | public const int SQLITE_FORMAT = 24; |
||
454 | public const int SQLITE_RANGE = 25; |
||
455 | public const int SQLITE_NOTADB = 26; |
||
456 | public const int SQLITE_ROW = 100; |
||
457 | public const int SQLITE_DONE = 101; |
||
458 | |||
459 | /* |
||
460 | ** CAPI3REF: Extended Result Codes |
||
461 | ** KEYWORDS: {extended error code} {extended error codes} |
||
462 | ** KEYWORDS: {extended result code} {extended result codes} |
||
463 | ** |
||
464 | ** In its default configuration, SQLite API routines return one of 26 integer |
||
465 | ** [SQLITE_OK | result codes]. However, experience has shown that many of |
||
466 | ** these result codes are too coarse-grained. They do not provide as |
||
467 | ** much information about problems as programmers might like. In an effort to |
||
468 | ** address this, newer versions of SQLite (version 3.3.8 and later) include |
||
469 | ** support for additional result codes that provide more detailed information |
||
470 | ** about errors. The extended result codes are enabled or disabled |
||
471 | ** on a per database connection basis using the |
||
472 | ** [sqlite3_extended_result_codes()] API. |
||
473 | ** |
||
474 | ** Some of the available extended result codes are listed here. |
||
475 | ** One may expect the number of extended result codes will be expand |
||
476 | ** over time. Software that uses extended result codes should expect |
||
477 | ** to see new result codes in future releases of SQLite. |
||
478 | ** |
||
479 | ** The SQLITE_OK result code will never be extended. It will always |
||
480 | ** be exactly zero. |
||
481 | */ |
||
482 | //#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8)) |
||
483 | //#define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8)) |
||
484 | //#define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8)) |
||
485 | //#define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8)) |
||
486 | //#define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8)) |
||
487 | //#define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8)) |
||
488 | //#define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8)) |
||
489 | //#define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8)) |
||
490 | //#define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8)) |
||
491 | //#define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8)) |
||
492 | //#define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8)) |
||
493 | //#define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8)) |
||
494 | //#define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8)) |
||
495 | //#define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8)) |
||
496 | //#define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8)) |
||
497 | //#define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8)) |
||
498 | //#define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8)) |
||
499 | //#define SQLITE_IOERR_SHMOPEN (SQLITE_IOERR | (18<<8)) |
||
500 | //#define SQLITE_IOERR_SHMSIZE (SQLITE_IOERR | (19<<8)) |
||
501 | //#define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR | (20<<8)) |
||
502 | //#define SQLITE_IOERR_SHMMAP (SQLITE_IOERR | (21<<8)) |
||
503 | //#define SQLITE_IOERR_SEEK (SQLITE_IOERR | (22<<8)) |
||
504 | //#define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8)) |
||
505 | //#define SQLITE_BUSY_RECOVERY (SQLITE_BUSY | (1<<8)) |
||
506 | //#define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN | (1<<8)) |
||
507 | //#define SQLITE_CORRUPT_VTAB (SQLITE_CORRUPT | (1<<8)) |
||
508 | //#define SQLITE_READONLY_RECOVERY (SQLITE_READONLY | (1<<8)) |
||
509 | //#define SQLITE_READONLY_CANTLOCK (SQLITE_READONLY | (2<<8)) |
||
510 | const int SQLITE_IOERR_READ = ( SQLITE_IOERR | ( 1 << 8 ) ); |
||
511 | const int SQLITE_IOERR_SHORT_READ = ( SQLITE_IOERR | ( 2 << 8 ) ); |
||
512 | const int SQLITE_IOERR_WRITE = ( SQLITE_IOERR | ( 3 << 8 ) ); |
||
513 | const int SQLITE_IOERR_FSYNC = ( SQLITE_IOERR | ( 4 << 8 ) ); |
||
514 | const int SQLITE_IOERR_DIR_FSYNC = ( SQLITE_IOERR | ( 5 << 8 ) ); |
||
515 | const int SQLITE_IOERR_TRUNCATE = ( SQLITE_IOERR | ( 6 << 8 ) ); |
||
516 | const int SQLITE_IOERR_FSTAT = ( SQLITE_IOERR | ( 7 << 8 ) ); |
||
517 | const int SQLITE_IOERR_UNLOCK = ( SQLITE_IOERR | ( 8 << 8 ) ); |
||
518 | const int SQLITE_IOERR_RDLOCK = ( SQLITE_IOERR | ( 9 << 8 ) ); |
||
519 | const int SQLITE_IOERR_DELETE = ( SQLITE_IOERR | ( 10 << 8 ) ); |
||
520 | const int SQLITE_IOERR_BLOCKED = ( SQLITE_IOERR | ( 11 << 8 ) ); |
||
521 | const int SQLITE_IOERR_NOMEM = ( SQLITE_IOERR | ( 12 << 8 ) ); |
||
522 | const int SQLITE_IOERR_ACCESS = ( SQLITE_IOERR | ( 13 << 8 ) ); |
||
523 | const int SQLITE_IOERR_CHECKRESERVEDLOCK = ( SQLITE_IOERR | ( 14 << 8 ) ); |
||
524 | const int SQLITE_IOERR_LOCK = ( SQLITE_IOERR | ( 15 << 8 ) ); |
||
525 | const int SQLITE_IOERR_CLOSE = ( SQLITE_IOERR | ( 16 << 8 ) ); |
||
526 | const int SQLITE_IOERR_DIR_CLOSE = ( SQLITE_IOERR | ( 17 << 8 ) ); |
||
527 | const int SQLITE_IOERR_SHMOPEN = ( SQLITE_IOERR | ( 18 << 8 ) ); |
||
528 | const int SQLITE_IOERR_SHMSIZE = ( SQLITE_IOERR | ( 19 << 8 ) ); |
||
529 | const int SQLITE_IOERR_SHMLOCK = ( SQLITE_IOERR | ( 20 << 8 ) ); |
||
530 | const int SQLITE_IOERR_SHMMAP = ( SQLITE_IOERR | ( 21 << 8 ) ); |
||
531 | const int SQLITE_IOERR_SEEK = ( SQLITE_IOERR | ( 22 << 8 ) ); |
||
532 | const int SQLITE_LOCKED_SHAREDCACHE = ( SQLITE_LOCKED | ( 1 << 8 ) ); |
||
533 | const int SQLITE_BUSY_RECOVERY = ( SQLITE_BUSY | ( 1 << 8 ) ); |
||
534 | const int SQLITE_CANTOPEN_NOTEMPDIR = ( SQLITE_CANTOPEN | ( 1 << 8 ) ); |
||
535 | const int SQLITE_CORRUPT_VTAB = ( SQLITE_CORRUPT | ( 1 << 8 ) ); |
||
536 | const int SQLITE_READONLY_RECOVERY = ( SQLITE_READONLY | ( 1 << 8 ) ); |
||
537 | const int SQLITE_READONLY_CANTLOCK = ( SQLITE_READONLY | ( 2 << 8 ) ); |
||
538 | |||
539 | /* |
||
540 | ** CAPI3REF: Flags For File Open Operations |
||
541 | ** |
||
542 | ** These bit values are intended for use in the |
||
543 | ** 3rd parameter to the [sqlite3_open_v2()] interface and |
||
544 | ** in the 4th parameter to the [sqlite3_vfs.xOpen] method. |
||
545 | */ |
||
546 | //#define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */ |
||
547 | //#define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */ |
||
548 | //#define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */ |
||
549 | //#define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */ |
||
550 | //#define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */ |
||
551 | //#define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */ |
||
552 | //#define SQLITE_OPEN_URI 0x00000040 /* Ok for sqlite3_open_v2() */ |
||
553 | //#define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */ |
||
554 | //#define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */ |
||
555 | //#define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */ |
||
556 | //#define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */ |
||
557 | //#define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */ |
||
558 | //#define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */ |
||
559 | //#define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */ |
||
560 | //#define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */ |
||
561 | //#define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */ |
||
562 | //#define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */ |
||
563 | //#define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */ |
||
564 | //#define SQLITE_OPEN_WAL 0x00080000 /* VFS only */ |
||
565 | |||
566 | /* Reserved: 0x00F00000 */ |
||
567 | |||
568 | public const int SQLITE_OPEN_READONLY = 0x00000001; |
||
569 | public const int SQLITE_OPEN_READWRITE = 0x00000002; |
||
570 | public const int SQLITE_OPEN_CREATE = 0x00000004; |
||
571 | public const int SQLITE_OPEN_DELETEONCLOSE = 0x00000008; |
||
572 | public const int SQLITE_OPEN_EXCLUSIVE = 0x00000010; |
||
573 | public const int SQLITE_OPEN_AUTOPROXY = 0x00000020; |
||
574 | public const int SQLITE_OPEN_URI = 0x00000040; |
||
575 | public const int SQLITE_OPEN_MAIN_DB = 0x00000100; |
||
576 | public const int SQLITE_OPEN_TEMP_DB = 0x00000200; |
||
577 | public const int SQLITE_OPEN_TRANSIENT_DB = 0x00000400; |
||
578 | public const int SQLITE_OPEN_MAIN_JOURNAL = 0x00000800; |
||
579 | public const int SQLITE_OPEN_TEMP_JOURNAL = 0x00001000; |
||
580 | public const int SQLITE_OPEN_SUBJOURNAL = 0x00002000; |
||
581 | public const int SQLITE_OPEN_MASTER_JOURNAL = 0x00004000; |
||
582 | public const int SQLITE_OPEN_NOMUTEX = 0x00008000; |
||
583 | public const int SQLITE_OPEN_FULLMUTEX = 0x00010000; |
||
584 | public const int SQLITE_OPEN_SHAREDCACHE = 0x00020000; |
||
585 | public const int SQLITE_OPEN_PRIVATECACHE = 0x00040000; |
||
586 | public const int SQLITE_OPEN_WAL = 0x00080000; |
||
587 | |||
588 | /* |
||
589 | ** CAPI3REF: Device Characteristics |
||
590 | ** |
||
591 | ** The xDeviceCharacteristics method of the [sqlite3_io_methods] |
||
592 | ** object returns an integer which is a vector of the these |
||
593 | ** bit values expressing I/O characteristics of the mass storage |
||
594 | ** device that holds the file that the [sqlite3_io_methods] |
||
595 | ** refers to. |
||
596 | ** |
||
597 | ** The SQLITE_IOCAP_ATOMIC property means that all writes of |
||
598 | ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values |
||
599 | ** mean that writes of blocks that are nnn bytes in size and |
||
600 | ** are aligned to an address which is an integer multiple of |
||
601 | ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means |
||
602 | ** that when data is appended to a file, the data is appended |
||
603 | ** first then the size of the file is extended, never the other |
||
604 | ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that |
||
605 | ** information is written to disk in the same order as calls |
||
606 | ** to xWrite(). |
||
607 | */ |
||
608 | //#define SQLITE_IOCAP_ATOMIC 0x00000001 |
||
609 | //#define SQLITE_IOCAP_ATOMIC512 0x00000002 |
||
610 | //#define SQLITE_IOCAP_ATOMIC1K 0x00000004 |
||
611 | //#define SQLITE_IOCAP_ATOMIC2K 0x00000008 |
||
612 | //#define SQLITE_IOCAP_ATOMIC4K 0x00000010 |
||
613 | //#define SQLITE_IOCAP_ATOMIC8K 0x00000020 |
||
614 | //#define SQLITE_IOCAP_ATOMIC16K 0x00000040 |
||
615 | //#define SQLITE_IOCAP_ATOMIC32K 0x00000080 |
||
616 | //#define SQLITE_IOCAP_ATOMIC64K 0x00000100 |
||
617 | //#define SQLITE_IOCAP_SAFE_APPEND 0x00000200 |
||
618 | //#define SQLITE_IOCAP_SEQUENTIAL 0x00000400 |
||
619 | //#define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800 |
||
620 | const int SQLITE_IOCAP_ATOMIC = 0x00000001; |
||
621 | const int SQLITE_IOCAP_ATOMIC512 = 0x00000002; |
||
622 | const int SQLITE_IOCAP_ATOMIC1K = 0x00000004; |
||
623 | const int SQLITE_IOCAP_ATOMIC2K = 0x00000008; |
||
624 | const int SQLITE_IOCAP_ATOMIC4K = 0x00000010; |
||
625 | const int SQLITE_IOCAP_ATOMIC8K = 0x00000020; |
||
626 | const int SQLITE_IOCAP_ATOMIC16K = 0x00000040; |
||
627 | const int SQLITE_IOCAP_ATOMIC32K = 0x00000080; |
||
628 | const int SQLITE_IOCAP_ATOMIC64K = 0x00000100; |
||
629 | const int SQLITE_IOCAP_SAFE_APPEND = 0x00000200; |
||
630 | const int SQLITE_IOCAP_SEQUENTIAL = 0x00000400; |
||
631 | const int SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN = 0x00000800; |
||
632 | |||
633 | /* |
||
634 | ** CAPI3REF: File Locking Levels |
||
635 | ** |
||
636 | ** SQLite uses one of these integer values as the second |
||
637 | ** argument to calls it makes to the xLock() and xUnlock() methods |
||
638 | ** of an [sqlite3_io_methods] object. |
||
639 | */ |
||
640 | //#define SQLITE_LOCK_NONE 0 |
||
641 | //#define SQLITE_LOCK_SHARED 1 |
||
642 | //#define SQLITE_LOCK_RESERVED 2 |
||
643 | //#define SQLITE_LOCK_PENDING 3 |
||
644 | //#define SQLITE_LOCK_EXCLUSIVE 4 |
||
645 | const int SQLITE_LOCK_NONE = 0; |
||
646 | const int SQLITE_LOCK_SHARED = 1; |
||
647 | const int SQLITE_LOCK_RESERVED = 2; |
||
648 | const int SQLITE_LOCK_PENDING = 3; |
||
649 | const int SQLITE_LOCK_EXCLUSIVE = 4; |
||
650 | |||
651 | /* |
||
652 | ** CAPI3REF: Synchronization Type Flags |
||
653 | ** |
||
654 | ** When SQLite invokes the xSync() method of an |
||
655 | ** [sqlite3_io_methods] object it uses a combination of |
||
656 | ** these integer values as the second argument. |
||
657 | ** |
||
658 | ** When the SQLITE_SYNC_DATAONLY flag is used, it means that the |
||
659 | ** sync operation only needs to flush data to mass storage. Inode |
||
660 | ** information need not be flushed. If the lower four bits of the flag |
||
661 | ** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics. |
||
662 | ** If the lower four bits equal SQLITE_SYNC_FULL, that means |
||
663 | ** to use Mac OS X style fullsync instead of fsync(). |
||
664 | ** |
||
665 | ** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags |
||
666 | ** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL |
||
667 | ** settings. The [synchronous pragma] determines when calls to the |
||
668 | ** xSync VFS method occur and applies uniformly across all platforms. |
||
669 | ** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how |
||
670 | ** energetic or rigorous or forceful the sync operations are and |
||
671 | ** only make a difference on Mac OSX for the default SQLite code. |
||
672 | ** (Third-party VFS implementations might also make the distinction |
||
673 | ** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the |
||
674 | ** operating systems natively supported by SQLite, only Mac OSX |
||
675 | ** cares about the difference.) |
||
676 | */ |
||
677 | //#define SQLITE_SYNC_NORMAL 0x00002 |
||
678 | //#define SQLITE_SYNC_FULL 0x00003 |
||
679 | //#define SQLITE_SYNC_DATAONLY 0x00010 |
||
680 | const int SQLITE_SYNC_NORMAL = 0x00002; |
||
681 | const int SQLITE_SYNC_FULL = 0x00003; |
||
682 | const int SQLITE_SYNC_DATAONLY = 0x00010; |
||
683 | |||
684 | /* |
||
685 | ** CAPI3REF: OS Interface Open File Handle |
||
686 | ** |
||
687 | ** An [sqlite3_file] object represents an open file in the |
||
688 | ** [sqlite3_vfs | OS interface layer]. Individual OS interface |
||
689 | ** implementations will |
||
690 | ** want to subclass this object by appending additional fields |
||
691 | ** for their own use. The pMethods entry is a pointer to an |
||
692 | ** [sqlite3_io_methods] object that defines methods for performing |
||
693 | ** I/O operations on the open file. |
||
694 | */ |
||
695 | //typedef struct sqlite3_file sqlite3_file; |
||
696 | //struct sqlite3_file { |
||
697 | // const struct sqlite3_io_methods *pMethods; /* Methods for an open file */ |
||
698 | //}; |
||
699 | public partial class sqlite3_file |
||
700 | { |
||
701 | public sqlite3_io_methods pMethods;/* Must be first */ |
||
702 | } |
||
703 | |||
704 | /* |
||
705 | ** CAPI3REF: OS Interface File Virtual Methods Object |
||
706 | ** |
||
707 | ** Every file opened by the [sqlite3_vfs.xOpen] method populates an |
||
708 | ** [sqlite3_file] object (or, more commonly, a subclass of the |
||
709 | ** [sqlite3_file] object) with a pointer to an instance of this object. |
||
710 | ** This object defines the methods used to perform various operations |
||
711 | ** against the open file represented by the [sqlite3_file] object. |
||
712 | ** |
||
713 | ** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element |
||
714 | ** to a non-NULL pointer, then the sqlite3_io_methods.xClose method |
||
715 | ** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed. The |
||
716 | ** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen] |
||
717 | ** is for the [sqlite3_vfs.xOpen] to set the sqlite3_file.pMethods element |
||
718 | ** to NULL. |
||
719 | ** |
||
720 | ** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or |
||
721 | ** [SQLITE_SYNC_FULL]. The first choice is the normal fsync(). |
||
722 | ** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY] |
||
723 | ** flag may be ORed in to indicate that only the data of the file |
||
724 | ** and not its inode needs to be synced. |
||
725 | ** |
||
726 | ** The integer values to xLock() and xUnlock() are one of |
||
727 | ** <ul> |
||
728 | ** <li> [SQLITE_LOCK_NONE], |
||
729 | ** <li> [SQLITE_LOCK_SHARED], |
||
730 | ** <li> [SQLITE_LOCK_RESERVED], |
||
731 | ** <li> [SQLITE_LOCK_PENDING], or |
||
732 | ** <li> [SQLITE_LOCK_EXCLUSIVE]. |
||
733 | ** </ul> |
||
734 | ** xLock() increases the lock. xUnlock() decreases the lock. |
||
735 | ** The xCheckReservedLock() method checks whether any database connection, |
||
736 | ** either in this process or in some other process, is holding a RESERVED, |
||
737 | ** PENDING, or EXCLUSIVE lock on the file. It returns true |
||
738 | ** if such a lock exists and false otherwise. |
||
739 | ** |
||
740 | ** The xFileControl() method is a generic interface that allows custom |
||
741 | ** VFS implementations to directly control an open file using the |
||
742 | ** [sqlite3_file_control()] interface. The second "op" argument is an |
||
743 | ** integer opcode. The third argument is a generic pointer intended to |
||
744 | ** point to a structure that may contain arguments or space in which to |
||
745 | ** write return values. Potential uses for xFileControl() might be |
||
746 | ** functions to enable blocking locks with timeouts, to change the |
||
747 | ** locking strategy (for example to use dot-file locks), to inquire |
||
748 | ** about the status of a lock, or to break stale locks. The SQLite |
||
749 | ** core reserves all opcodes less than 100 for its own use. |
||
750 | ** A [SQLITE_FCNTL_LOCKSTATE | list of opcodes] less than 100 is available. |
||
751 | ** Applications that define a custom xFileControl method should use opcodes |
||
752 | ** greater than 100 to avoid conflicts. VFS implementations should |
||
753 | ** return [SQLITE_NOTFOUND] for file control opcodes that they do not |
||
754 | ** recognize. |
||
755 | ** |
||
756 | ** The xSectorSize() method returns the sector size of the |
||
757 | ** device that underlies the file. The sector size is the |
||
758 | ** minimum write that can be performed without disturbing |
||
759 | ** other bytes in the file. The xDeviceCharacteristics() |
||
760 | ** method returns a bit vector describing behaviors of the |
||
761 | ** underlying device: |
||
762 | ** |
||
763 | ** <ul> |
||
764 | ** <li> [SQLITE_IOCAP_ATOMIC] |
||
765 | ** <li> [SQLITE_IOCAP_ATOMIC512] |
||
766 | ** <li> [SQLITE_IOCAP_ATOMIC1K] |
||
767 | ** <li> [SQLITE_IOCAP_ATOMIC2K] |
||
768 | ** <li> [SQLITE_IOCAP_ATOMIC4K] |
||
769 | ** <li> [SQLITE_IOCAP_ATOMIC8K] |
||
770 | ** <li> [SQLITE_IOCAP_ATOMIC16K] |
||
771 | ** <li> [SQLITE_IOCAP_ATOMIC32K] |
||
772 | ** <li> [SQLITE_IOCAP_ATOMIC64K] |
||
773 | ** <li> [SQLITE_IOCAP_SAFE_APPEND] |
||
774 | ** <li> [SQLITE_IOCAP_SEQUENTIAL] |
||
775 | ** </ul> |
||
776 | ** |
||
777 | ** The SQLITE_IOCAP_ATOMIC property means that all writes of |
||
778 | ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values |
||
779 | ** mean that writes of blocks that are nnn bytes in size and |
||
780 | ** are aligned to an address which is an integer multiple of |
||
781 | ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means |
||
782 | ** that when data is appended to a file, the data is appended |
||
783 | ** first then the size of the file is extended, never the other |
||
784 | ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that |
||
785 | ** information is written to disk in the same order as calls |
||
786 | ** to xWrite(). |
||
787 | ** |
||
788 | ** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill |
||
789 | ** in the unread portions of the buffer with zeros. A VFS that |
||
790 | ** fails to zero-fill short reads might seem to work. However, |
||
791 | ** failure to zero-fill short reads will eventually lead to |
||
792 | ** database corruption. |
||
793 | */ |
||
794 | //typedef struct sqlite3_io_methods sqlite3_io_methods; |
||
795 | //struct sqlite3_io_methods { |
||
796 | // int iVersion; |
||
797 | // int (*xClose)(sqlite3_file); |
||
798 | // int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst); |
||
799 | // int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst); |
||
800 | // int (*xTruncate)(sqlite3_file*, sqlite3_int64 size); |
||
801 | // int (*xSync)(sqlite3_file*, int flags); |
||
802 | // int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize); |
||
803 | // int (*xLock)(sqlite3_file*, int); |
||
804 | // int (*xUnlock)(sqlite3_file*, int); |
||
805 | // int (*xCheckReservedLock)(sqlite3_file*, int *pResOut); |
||
806 | // int (*xFileControl)(sqlite3_file*, int op, object *pArg); |
||
807 | // int (*xSectorSize)(sqlite3_file); |
||
808 | // int (*xDeviceCharacteristics)(sqlite3_file); |
||
809 | // /* Methods above are valid for version 1 */ |
||
810 | // int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, object volatile*); |
||
811 | // int (*xShmLock)(sqlite3_file*, int offset, int n, int flags); |
||
812 | // void (*xShmBarrier)(sqlite3_file); |
||
813 | // int (*xShmUnmap)(sqlite3_file*, int deleteFlag); |
||
814 | // /* Methods above are valid for version 2 */ |
||
815 | // /* Additional methods may be added in future releases */ |
||
816 | //}; |
||
817 | public class sqlite3_io_methods |
||
818 | { |
||
819 | public int iVersion; |
||
820 | public dxClose xClose; |
||
821 | public dxRead xRead; |
||
822 | public dxWrite xWrite; |
||
823 | public dxTruncate xTruncate; |
||
824 | public dxSync xSync; |
||
825 | public dxFileSize xFileSize; |
||
826 | public dxLock xLock; |
||
827 | public dxUnlock xUnlock; |
||
828 | public dxCheckReservedLock xCheckReservedLock; |
||
829 | public dxFileControl xFileControl; |
||
830 | public dxSectorSize xSectorSize; |
||
831 | public dxDeviceCharacteristics xDeviceCharacteristics; |
||
832 | public dxShmMap xShmMap;//int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, object volatile*); |
||
833 | public dxShmLock xShmLock;//int (*xShmLock)(sqlite3_file*, int offset, int n, int flags); |
||
834 | public dxShmBarrier xShmBarrier;//void (*xShmBarrier)(sqlite3_file); |
||
835 | public dxShmUnmap xShmUnmap;//int (*xShmUnmap)(sqlite3_file*, int deleteFlag); |
||
836 | /* Additional methods may be added in future releases */ |
||
837 | |||
838 | public sqlite3_io_methods( int iVersion, |
||
839 | dxClose xClose, |
||
840 | dxRead xRead, |
||
841 | dxWrite xWrite, |
||
842 | dxTruncate xTruncate, |
||
843 | dxSync xSync, |
||
844 | dxFileSize xFileSize, |
||
845 | dxLock xLock, |
||
846 | dxUnlock xUnlock, |
||
847 | dxCheckReservedLock xCheckReservedLock, |
||
848 | dxFileControl xFileControl, |
||
849 | dxSectorSize xSectorSize, |
||
850 | dxDeviceCharacteristics xDeviceCharacteristics, |
||
851 | dxShmMap xShmMap, |
||
852 | dxShmLock xShmLock, |
||
853 | dxShmBarrier xShmBarrier, |
||
854 | dxShmUnmap xShmUnmap |
||
855 | ) |
||
856 | { |
||
857 | this.iVersion = iVersion; |
||
858 | this.xClose = xClose; |
||
859 | this.xRead = xRead; |
||
860 | this.xWrite = xWrite; |
||
861 | this.xTruncate = xTruncate; |
||
862 | this.xSync = xSync; |
||
863 | this.xFileSize = xFileSize; |
||
864 | this.xLock = xLock; |
||
865 | this.xUnlock = xUnlock; |
||
866 | this.xCheckReservedLock = xCheckReservedLock; |
||
867 | this.xFileControl = xFileControl; |
||
868 | this.xSectorSize = xSectorSize; |
||
869 | this.xDeviceCharacteristics = xDeviceCharacteristics; |
||
870 | this.xShmMap = xShmMap; |
||
871 | this.xShmLock = xShmLock; |
||
872 | this.xShmBarrier = xShmBarrier; |
||
873 | this.xShmUnmap = xShmUnmap; |
||
874 | } |
||
875 | } |
||
876 | |||
877 | /* |
||
878 | ** CAPI3REF: Standard File Control Opcodes |
||
879 | ** |
||
880 | ** These integer constants are opcodes for the xFileControl method |
||
881 | ** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()] |
||
882 | ** interface. |
||
883 | ** |
||
884 | ** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This |
||
885 | ** opcode causes the xFileControl method to write the current state of |
||
886 | ** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED], |
||
887 | ** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE]) |
||
888 | ** into an integer that the pArg argument points to. This capability |
||
889 | ** is used during testing and only needs to be supported when SQLITE_TEST |
||
890 | ** is defined. |
||
891 | ** |
||
892 | ** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS |
||
893 | ** layer a hint of how large the database file will grow to be during the |
||
894 | ** current transaction. This hint is not guaranteed to be accurate but it |
||
895 | ** is often close. The underlying VFS might choose to preallocate database |
||
896 | ** file space based on this hint in order to help writes to the database |
||
897 | ** file run faster. |
||
898 | ** |
||
899 | ** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS |
||
900 | ** extends and truncates the database file in chunks of a size specified |
||
901 | ** by the user. The fourth argument to [sqlite3_file_control()] should |
||
902 | ** point to an integer (type int) containing the new chunk-size to use |
||
903 | ** for the nominated database. Allocating database file space in large |
||
904 | ** chunks (say 1MB at a time), may reduce file-system fragmentation and |
||
905 | ** improve performance on some systems. |
||
906 | ** |
||
907 | ** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer |
||
908 | ** to the [sqlite3_file] object associated with a particular database |
||
909 | ** connection. See the [sqlite3_file_control()] documentation for |
||
910 | ** additional information. |
||
911 | ** |
||
912 | ** ^(The [SQLITE_FCNTL_SYNC_OMITTED] opcode is generated internally by |
||
913 | ** SQLite and sent to all VFSes in place of a call to the xSync method |
||
914 | ** when the database connection has [PRAGMA synchronous] set to OFF.)^ |
||
915 | ** Some specialized VFSes need this signal in order to operate correctly |
||
916 | ** when [PRAGMA synchronous | PRAGMA synchronous=OFF] is set, but most |
||
917 | ** VFSes do not need this signal and should silently ignore this opcode. |
||
918 | ** Applications should not call [sqlite3_file_control()] with this |
||
919 | ** opcode as doing so may disrupt the operation of the specialized VFSes |
||
920 | ** that do require it. |
||
921 | */ |
||
922 | //#define SQLITE_FCNTL_LOCKSTATE 1 |
||
923 | //#define SQLITE_GET_LOCKPROXYFILE 2 |
||
924 | //#define SQLITE_SET_LOCKPROXYFILE 3 |
||
925 | //#define SQLITE_LAST_ERRNO 4 |
||
926 | //#define SQLITE_FCNTL_SIZE_HINT 5 |
||
927 | //#define SQLITE_FCNTL_CHUNK_SIZE 6 |
||
928 | //#define SQLITE_FCNTL_FILE_POINTER 7 |
||
929 | //#define SQLITE_FCNTL_SYNC_OMITTED 8 |
||
930 | |||
931 | const int SQLITE_FCNTL_LOCKSTATE = 1; |
||
932 | const int SQLITE_GET_LOCKPROXYFILE = 2; |
||
933 | const int SQLITE_SET_LOCKPROXYFILE = 3; |
||
934 | const int SQLITE_LAST_ERRNO = 4; |
||
935 | const int SQLITE_FCNTL_SIZE_HINT = 5; |
||
936 | const int SQLITE_FCNTL_CHUNK_SIZE = 6; |
||
937 | const int SQLITE_FCNTL_FILE_POINTER = 7; |
||
938 | const int SQLITE_FCNTL_SYNC_OMITTED = 8; |
||
939 | |||
940 | /* |
||
941 | ** CAPI3REF: Mutex Handle |
||
942 | ** |
||
943 | ** The mutex module within SQLite defines [sqlite3_mutex] to be an |
||
944 | ** abstract type for a mutex object. The SQLite core never looks |
||
945 | ** at the internal representation of an [sqlite3_mutex]. It only |
||
946 | ** deals with pointers to the [sqlite3_mutex] object. |
||
947 | ** |
||
948 | ** Mutexes are created using [sqlite3_mutex_alloc()]. |
||
949 | */ |
||
950 | //typedef struct sqlite3_mutex sqlite3_mutex; |
||
951 | |||
952 | /* |
||
953 | ** CAPI3REF: OS Interface Object |
||
954 | ** |
||
955 | ** An instance of the sqlite3_vfs object defines the interface between |
||
956 | ** the SQLite core and the underlying operating system. The "vfs" |
||
957 | ** in the name of the object stands for "virtual file system". See |
||
958 | ** the [VFS | VFS documentation] for further information. |
||
959 | ** |
||
960 | ** The value of the iVersion field is initially 1 but may be larger in |
||
961 | ** future versions of SQLite. Additional fields may be appended to this |
||
962 | ** object when the iVersion value is increased. Note that the structure |
||
963 | ** of the sqlite3_vfs object changes in the transaction between |
||
964 | ** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not |
||
965 | ** modified. |
||
966 | ** |
||
967 | ** The szOsFile field is the size of the subclassed [sqlite3_file] |
||
968 | ** structure used by this VFS. mxPathname is the maximum length of |
||
969 | ** a pathname in this VFS. |
||
970 | ** |
||
971 | ** Registered sqlite3_vfs objects are kept on a linked list formed by |
||
972 | ** the pNext pointer. The [sqlite3_vfs_register()] |
||
973 | ** and [sqlite3_vfs_unregister()] interfaces manage this list |
||
974 | ** in a thread-safe way. The [sqlite3_vfs_find()] interface |
||
975 | ** searches the list. Neither the application code nor the VFS |
||
976 | ** implementation should use the pNext pointer. |
||
977 | ** |
||
978 | ** The pNext field is the only field in the sqlite3_vfs |
||
979 | ** structure that SQLite will ever modify. SQLite will only access |
||
980 | ** or modify this field while holding a particular static mutex. |
||
981 | ** The application should never modify anything within the sqlite3_vfs |
||
982 | ** object once the object has been registered. |
||
983 | ** |
||
984 | ** The zName field holds the name of the VFS module. The name must |
||
985 | ** be unique across all VFS modules. |
||
986 | ** |
||
987 | ** [[sqlite3_vfs.xOpen] |
||
988 | ** ^SQLite guarantees that the zFilename parameter to xOpen |
||
989 | ** is either a NULL pointer or string obtained |
||
990 | ** from xFullPathname() with an optional suffix added. |
||
991 | ** ^If a suffix is added to the zFilename parameter, it will |
||
992 | ** consist of a single "-" character followed by no more than |
||
993 | ** 10 alphanumeric and/or "-" characters. |
||
994 | ** ^SQLite further guarantees that |
||
995 | ** the string will be valid and unchanged until xClose() is |
||
996 | ** called. Because of the previous sentence, |
||
997 | ** the [sqlite3_file] can safely store a pointer to the |
||
998 | ** filename if it needs to remember the filename for some reason. |
||
999 | ** If the zFilename parameter to xOpen is a NULL pointer then xOpen |
||
1000 | ** must invent its own temporary name for the file. ^Whenever the |
||
1001 | ** xFilename parameter is NULL it will also be the case that the |
||
1002 | ** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE]. |
||
1003 | ** |
||
1004 | ** The flags argument to xOpen() includes all bits set in |
||
1005 | ** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()] |
||
1006 | ** or [sqlite3_open16()] is used, then flags includes at least |
||
1007 | ** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. |
||
1008 | ** If xOpen() opens a file read-only then it sets *pOutFlags to |
||
1009 | ** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set. |
||
1010 | ** |
||
1011 | ** ^(SQLite will also add one of the following flags to the xOpen() |
||
1012 | ** call, depending on the object being opened: |
||
1013 | ** |
||
1014 | ** <ul> |
||
1015 | ** <li> [SQLITE_OPEN_MAIN_DB] |
||
1016 | ** <li> [SQLITE_OPEN_MAIN_JOURNAL] |
||
1017 | ** <li> [SQLITE_OPEN_TEMP_DB] |
||
1018 | ** <li> [SQLITE_OPEN_TEMP_JOURNAL] |
||
1019 | ** <li> [SQLITE_OPEN_TRANSIENT_DB] |
||
1020 | ** <li> [SQLITE_OPEN_SUBJOURNAL] |
||
1021 | ** <li> [SQLITE_OPEN_MASTER_JOURNAL] |
||
1022 | ** <li> [SQLITE_OPEN_WAL] |
||
1023 | ** </ul>)^ |
||
1024 | ** |
||
1025 | ** The file I/O implementation can use the object type flags to |
||
1026 | ** change the way it deals with files. For example, an application |
||
1027 | ** that does not care about crash recovery or rollback might make |
||
1028 | ** the open of a journal file a no-op. Writes to this journal would |
||
1029 | ** also be no-ops, and any attempt to read the journal would return |
||
1030 | ** SQLITE_IOERR. Or the implementation might recognize that a database |
||
1031 | ** file will be doing page-aligned sector reads and writes in a random |
||
1032 | ** order and set up its I/O subsystem accordingly. |
||
1033 | ** |
||
1034 | ** SQLite might also add one of the following flags to the xOpen method: |
||
1035 | ** |
||
1036 | ** <ul> |
||
1037 | ** <li> [SQLITE_OPEN_DELETEONCLOSE] |
||
1038 | ** <li> [SQLITE_OPEN_EXCLUSIVE] |
||
1039 | ** </ul> |
||
1040 | ** |
||
1041 | ** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be |
||
1042 | ** deleted when it is closed. ^The [SQLITE_OPEN_DELETEONCLOSE] |
||
1043 | ** will be set for TEMP databases and their journals, transient |
||
1044 | ** databases, and subjournals. |
||
1045 | ** |
||
1046 | ** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction |
||
1047 | ** with the [SQLITE_OPEN_CREATE] flag, which are both directly |
||
1048 | ** analogous to the O_EXCL and O_CREAT flags of the POSIX open() |
||
1049 | ** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the |
||
1050 | ** SQLITE_OPEN_CREATE, is used to indicate that file should always |
||
1051 | ** be created, and that it is an error if it already exists. |
||
1052 | ** It is <i>not</i> used to indicate the file should be opened |
||
1053 | ** for exclusive access. |
||
1054 | ** |
||
1055 | ** ^At least szOsFile bytes of memory are allocated by SQLite |
||
1056 | ** to hold the [sqlite3_file] structure passed as the third |
||
1057 | ** argument to xOpen. The xOpen method does not have to |
||
1058 | ** allocate the structure; it should just fill it in. Note that |
||
1059 | ** the xOpen method must set the sqlite3_file.pMethods to either |
||
1060 | ** a valid [sqlite3_io_methods] object or to NULL. xOpen must do |
||
1061 | ** this even if the open fails. SQLite expects that the sqlite3_file.pMethods |
||
1062 | ** element will be valid after xOpen returns regardless of the success |
||
1063 | ** or failure of the xOpen call. |
||
1064 | ** |
||
1065 | ** [[sqlite3_vfs.xAccess] |
||
1066 | ** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS] |
||
1067 | ** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to |
||
1068 | ** test whether a file is readable and writable, or [SQLITE_ACCESS_READ] |
||
1069 | ** to test whether a file is at least readable. The file can be a |
||
1070 | ** directory. |
||
1071 | ** |
||
1072 | ** ^SQLite will always allocate at least mxPathname+1 bytes for the |
||
1073 | ** output buffer xFullPathname. The exact size of the output buffer |
||
1074 | ** is also passed as a parameter to both methods. If the output buffer |
||
1075 | ** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is |
||
1076 | ** handled as a fatal error by SQLite, vfs implementations should endeavor |
||
1077 | ** to prevent this by setting mxPathname to a sufficiently large value. |
||
1078 | ** |
||
1079 | ** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64() |
||
1080 | ** interfaces are not strictly a part of the filesystem, but they are |
||
1081 | ** included in the VFS structure for completeness. |
||
1082 | ** The xRandomness() function attempts to return nBytes bytes |
||
1083 | ** of good-quality randomness into zOut. The return value is |
||
1084 | ** the actual number of bytes of randomness obtained. |
||
1085 | ** The xSleep() method causes the calling thread to sleep for at |
||
1086 | ** least the number of microseconds given. ^The xCurrentTime() |
||
1087 | ** method returns a Julian Day Number for the current date and time as |
||
1088 | ** a floating point value. |
||
1089 | ** ^The xCurrentTimeInt64() method returns, as an integer, the Julian |
||
1090 | ** Day Number multiplied by 86400000 (the number of milliseconds in |
||
1091 | ** a 24-hour day). |
||
1092 | ** ^SQLite will use the xCurrentTimeInt64() method to get the current |
||
1093 | ** date and time if that method is available (if iVersion is 2 or |
||
1094 | ** greater and the function pointer is not NULL) and will fall back |
||
1095 | ** to xCurrentTime() if xCurrentTimeInt64() is unavailable. |
||
1096 | ** |
||
1097 | ** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces |
||
1098 | ** are not used by the SQLite core. These optional interfaces are provided |
||
1099 | ** by some VFSes to facilitate testing of the VFS code. By overriding |
||
1100 | ** system calls with functions under its control, a test program can |
||
1101 | ** simulate faults and error conditions that would otherwise be difficult |
||
1102 | ** or impossible to induce. The set of system calls that can be overridden |
||
1103 | ** varies from one VFS to another, and from one version of the same VFS to the |
||
1104 | ** next. Applications that use these interfaces must be prepared for any |
||
1105 | ** or all of these interfaces to be NULL or for their behavior to change |
||
1106 | ** from one release to the next. Applications must not attempt to access |
||
1107 | ** any of these methods if the iVersion of the VFS is less than 3. |
||
1108 | */ |
||
1109 | //typedef struct sqlite3_vfs sqlite3_vfs; |
||
1110 | //typedef void (*sqlite3_syscall_ptr)(void); |
||
1111 | //struct sqlite3_vfs { |
||
1112 | // int iVersion; /* Structure version number (currently 3) */ |
||
1113 | // int szOsFile; /* Size of subclassed sqlite3_file */ |
||
1114 | // int mxPathname; /* Maximum file pathname length */ |
||
1115 | // sqlite3_vfs *pNext; /* Next registered VFS */ |
||
1116 | // string zName; /* Name of this virtual file system */ |
||
1117 | // void *pAppData; /* Pointer to application-specific data */ |
||
1118 | // int (*xOpen)(sqlite3_vfs*, string zName, sqlite3_file*, |
||
1119 | // int flags, int *pOutFlags); |
||
1120 | // int (*xDelete)(sqlite3_vfs*, string zName, int syncDir); |
||
1121 | // int (*xAccess)(sqlite3_vfs*, string zName, int flags, int *pResOut); |
||
1122 | // int (*xFullPathname)(sqlite3_vfs*, string zName, int nOut, string zOut); |
||
1123 | // void *(*xDlOpen)(sqlite3_vfs*, string zFilename); |
||
1124 | // void (*xDlError)(sqlite3_vfs*, int nByte, string zErrMsg); |
||
1125 | // void (*(*xDlSym)(sqlite3_vfs*,void*, string zSymbol))(void); |
||
1126 | // void (*xDlClose)(sqlite3_vfs*, void); |
||
1127 | // int (*xRandomness)(sqlite3_vfs*, int nByte, string zOut); |
||
1128 | // int (*xSleep)(sqlite3_vfs*, int microseconds); |
||
1129 | // int (*xCurrentTime)(sqlite3_vfs*, double); |
||
1130 | // int (*xGetLastError)(sqlite3_vfs*, int, char ); |
||
1131 | // /* |
||
1132 | // ** The methods above are in version 1 of the sqlite_vfs object |
||
1133 | // ** definition. Those that follow are added in version 2 or later |
||
1134 | // */ |
||
1135 | // int (*xCurrentTimeInt64)(sqlite3_vfs*, sqlite3_int64); |
||
1136 | // /* |
||
1137 | // ** The methods above are in versions 1 and 2 of the sqlite_vfs object. |
||
1138 | // ** New fields may be appended in figure versions. The iVersion |
||
1139 | // ** value will increment whenever this happens. |
||
1140 | // */ |
||
1141 | //}; |
||
1142 | public class sqlite3_vfs |
||
1143 | { |
||
1144 | public int iVersion; /* Structure version number (currently 3) */ |
||
1145 | public int szOsFile; /* Size of subclassed sqlite3_file */ |
||
1146 | public int mxPathname; /* Maximum file pathname length */ |
||
1147 | public sqlite3_vfs pNext; /* Next registered VFS */ |
||
1148 | public string zName; /* Name of this virtual file system */ |
||
1149 | public object pAppData; /* Pointer to application-specific data */ |
||
1150 | public dxOpen xOpen; |
||
1151 | public dxDelete xDelete; |
||
1152 | public dxAccess xAccess; |
||
1153 | public dxFullPathname xFullPathname; |
||
1154 | public dxDlOpen xDlOpen; |
||
1155 | public dxDlError xDlError; |
||
1156 | public dxDlSym xDlSym; |
||
1157 | public dxDlClose xDlClose; |
||
1158 | public dxRandomness xRandomness; |
||
1159 | public dxSleep xSleep; |
||
1160 | public dxCurrentTime xCurrentTime; |
||
1161 | public dxGetLastError xGetLastError; |
||
1162 | /* |
||
1163 | ** The methods above are in version 1 of the sqlite_vfs object |
||
1164 | ** definition. Those that follow are added in version 2 or later |
||
1165 | */ |
||
1166 | public dxCurrentTimeInt64 xCurrentTimeInt64; |
||
1167 | /* |
||
1168 | ** The methods above are in versions 1 and 2 of the sqlite_vfs object. |
||
1169 | ** Those below are for version 3 and greater. |
||
1170 | */ |
||
1171 | //int (*xSetSystemCall)(sqlite3_vfs*, string zName, sqlite3_syscall_ptr); |
||
1172 | public dxSetSystemCall xSetSystemCall; |
||
1173 | //sqlite3_syscall_ptr (*xGetSystemCall)(sqlite3_vfs*, string zName); |
||
1174 | public dxGetSystemCall xGetSystemCall; |
||
1175 | //string (*xNextSystemCall)(sqlite3_vfs*, string zName); |
||
1176 | public dxNextSystemCall xNextSystemCall; |
||
1177 | /* |
||
1178 | ** The methods above are in versions 1 through 3 of the sqlite_vfs object. |
||
1179 | ** New fields may be appended in figure versions. The iVersion |
||
1180 | ** value will increment whenever this happens. |
||
1181 | */ |
||
1182 | /* New fields may be appended in figure versions. The iVersion |
||
1183 | ** value will increment whenever this happens. */ |
||
1184 | |||
1185 | public sqlite3_vfs() |
||
1186 | { |
||
1187 | } |
||
1188 | |||
1189 | public sqlite3_vfs( int iVersion, |
||
1190 | int szOsFile, |
||
1191 | int mxPathname, |
||
1192 | sqlite3_vfs pNext, |
||
1193 | string zName, |
||
1194 | object pAppData, |
||
1195 | dxOpen xOpen, |
||
1196 | dxDelete xDelete, |
||
1197 | dxAccess xAccess, |
||
1198 | dxFullPathname xFullPathname, |
||
1199 | dxDlOpen xDlOpen, |
||
1200 | dxDlError xDlError, |
||
1201 | dxDlSym xDlSym, |
||
1202 | dxDlClose xDlClose, |
||
1203 | dxRandomness xRandomness, |
||
1204 | dxSleep xSleep, |
||
1205 | dxCurrentTime xCurrentTime, |
||
1206 | dxGetLastError xGetLastError, |
||
1207 | dxCurrentTimeInt64 xCurrentTimeInt64, |
||
1208 | dxSetSystemCall xSetSystemCall, |
||
1209 | dxGetSystemCall xGetSystemCall, |
||
1210 | dxNextSystemCall xNextSystemCall) |
||
1211 | { |
||
1212 | this.iVersion = iVersion; |
||
1213 | this.szOsFile = szOsFile; |
||
1214 | this.mxPathname = mxPathname; |
||
1215 | this.pNext = pNext; |
||
1216 | this.zName = zName; |
||
1217 | this.pAppData = pAppData; |
||
1218 | this.xOpen = xOpen; |
||
1219 | this.xDelete = xDelete; |
||
1220 | this.xAccess = xAccess; |
||
1221 | this.xFullPathname = xFullPathname; |
||
1222 | this.xDlOpen = xDlOpen; |
||
1223 | this.xDlError = xDlError; |
||
1224 | this.xDlSym = xDlSym; |
||
1225 | this.xDlClose = xDlClose; |
||
1226 | this.xRandomness = xRandomness; |
||
1227 | this.xSleep = xSleep; |
||
1228 | this.xCurrentTime = xCurrentTime; |
||
1229 | this.xGetLastError = xGetLastError; |
||
1230 | this.xCurrentTimeInt64 = xCurrentTimeInt64; |
||
1231 | } |
||
1232 | public void CopyTo(sqlite3_vfs ct) |
||
1233 | { |
||
1234 | ct.iVersion = this.iVersion; |
||
1235 | ct.szOsFile = this.szOsFile; |
||
1236 | ct.mxPathname = this.mxPathname; |
||
1237 | ct.pNext = this.pNext; |
||
1238 | ct.zName = this.zName; |
||
1239 | ct.pAppData = this.pAppData; |
||
1240 | ct.xOpen = this.xOpen; |
||
1241 | ct.xDelete = this.xDelete; |
||
1242 | ct.xAccess = this.xAccess; |
||
1243 | ct.xFullPathname = this.xFullPathname; |
||
1244 | ct.xDlOpen = this.xDlOpen; |
||
1245 | ct.xDlError = this.xDlError; |
||
1246 | ct.xDlSym = this.xDlSym; |
||
1247 | ct.xDlClose = this.xDlClose; |
||
1248 | ct.xRandomness = this.xRandomness; |
||
1249 | ct.xSleep = this.xSleep; |
||
1250 | ct.xCurrentTime = this.xCurrentTime; |
||
1251 | ct.xGetLastError = this.xGetLastError; |
||
1252 | ct.xCurrentTimeInt64 = this.xCurrentTimeInt64; |
||
1253 | } |
||
1254 | } |
||
1255 | |||
1256 | |||
1257 | /* |
||
1258 | ** CAPI3REF: Flags for the xAccess VFS method |
||
1259 | ** |
||
1260 | ** These integer constants can be used as the third parameter to |
||
1261 | ** the xAccess method of an [sqlite3_vfs] object. They determine |
||
1262 | ** what kind of permissions the xAccess method is looking for. |
||
1263 | ** With SQLITE_ACCESS_EXISTS, the xAccess method |
||
1264 | ** simply checks whether the file exists. |
||
1265 | ** With SQLITE_ACCESS_READWRITE, the xAccess method |
||
1266 | ** checks whether the named directory is both readable and writable |
||
1267 | ** (in other words, if files can be added, removed, and renamed within |
||
1268 | ** the directory). |
||
1269 | ** The SQLITE_ACCESS_READWRITE constant is currently used only by the |
||
1270 | ** [temp_store_directory pragma], though this could change in a future |
||
1271 | ** release of SQLite. |
||
1272 | ** With SQLITE_ACCESS_READ, the xAccess method |
||
1273 | ** checks whether the file is readable. The SQLITE_ACCESS_READ constant is |
||
1274 | ** currently unused, though it might be used in a future release of |
||
1275 | ** SQLite. |
||
1276 | */ |
||
1277 | //#define SQLITE_ACCESS_EXISTS 0 |
||
1278 | //#define SQLITE_ACCESS_READWRITE 1 /* Used by PRAGMA temp_store_directory */ |
||
1279 | //#define SQLITE_ACCESS_READ 2 /* Unused */ |
||
1280 | const int SQLITE_ACCESS_EXISTS = 0; |
||
1281 | const int SQLITE_ACCESS_READWRITE = 1; |
||
1282 | const int SQLITE_ACCESS_READ = 2; |
||
1283 | |||
1284 | |||
1285 | /* |
||
1286 | ** CAPI3REF: Flags for the xShmLock VFS method |
||
1287 | ** |
||
1288 | ** These integer constants define the various locking operations |
||
1289 | ** allowed by the xShmLock method of [sqlite3_io_methods]. The |
||
1290 | ** following are the only legal combinations of flags to the |
||
1291 | ** xShmLock method: |
||
1292 | ** |
||
1293 | ** <ul> |
||
1294 | ** <li> SQLITE_SHM_LOCK | SQLITE_SHM_SHARED |
||
1295 | ** <li> SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE |
||
1296 | ** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED |
||
1297 | ** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE |
||
1298 | ** </ul> |
||
1299 | ** |
||
1300 | ** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as |
||
1301 | ** was given no the corresponding lock. |
||
1302 | ** |
||
1303 | ** The xShmLock method can transition between unlocked and SHARED or |
||
1304 | ** between unlocked and EXCLUSIVE. It cannot transition between SHARED |
||
1305 | ** and EXCLUSIVE. |
||
1306 | */ |
||
1307 | //#define SQLITE_SHM_UNLOCK 1 |
||
1308 | //#define SQLITE_SHM_LOCK 2 |
||
1309 | //#define SQLITE_SHM_SHARED 4 |
||
1310 | //#define SQLITE_SHM_EXCLUSIVE 8 |
||
1311 | const int SQLITE_SHM_UNLOCK = 1; |
||
1312 | const int SQLITE_SHM_LOCK = 2; |
||
1313 | const int SQLITE_SHM_SHARED = 4; |
||
1314 | const int SQLITE_SHM_EXCLUSIVE = 8; |
||
1315 | |||
1316 | |||
1317 | /* |
||
1318 | ** CAPI3REF: Maximum xShmLock index |
||
1319 | ** |
||
1320 | ** The xShmLock method on [sqlite3_io_methods] may use values |
||
1321 | ** between 0 and this upper bound as its "offset" argument. |
||
1322 | ** The SQLite core will never attempt to acquire or release a |
||
1323 | ** lock outside of this range |
||
1324 | */ |
||
1325 | //#define SQLITE_SHM_NLOCK 8 |
||
1326 | const int SQLITE_SHM_NLOCK = 8; |
||
1327 | |||
1328 | /* |
||
1329 | ** CAPI3REF: Initialize The SQLite Library |
||
1330 | ** |
||
1331 | ** ^The sqlite3_initialize() routine initializes the |
||
1332 | ** SQLite library. ^The sqlite3_shutdown() routine |
||
1333 | ** deallocates any resources that were allocated by sqlite3_initialize(). |
||
1334 | ** These routines are designed to aid in process initialization and |
||
1335 | ** shutdown on embedded systems. Workstation applications using |
||
1336 | ** SQLite normally do not need to invoke either of these routines. |
||
1337 | ** |
||
1338 | ** A call to sqlite3_initialize() is an "effective" call if it is |
||
1339 | ** the first time sqlite3_initialize() is invoked during the lifetime of |
||
1340 | ** the process, or if it is the first time sqlite3_initialize() is invoked |
||
1341 | ** following a call to sqlite3_shutdown(). ^(Only an effective call |
||
1342 | ** of sqlite3_initialize() does any initialization. All other calls |
||
1343 | ** are harmless no-ops.)^ |
||
1344 | ** |
||
1345 | ** A call to sqlite3_shutdown() is an "effective" call if it is the first |
||
1346 | ** call to sqlite3_shutdown() since the last sqlite3_initialize(). ^(Only |
||
1347 | ** an effective call to sqlite3_shutdown() does any deinitialization. |
||
1348 | ** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^ |
||
1349 | ** |
||
1350 | ** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown() |
||
1351 | ** is not. The sqlite3_shutdown() interface must only be called from a |
||
1352 | ** single thread. All open [database connections] must be closed and all |
||
1353 | ** other SQLite resources must be deallocated prior to invoking |
||
1354 | ** sqlite3_shutdown(). |
||
1355 | ** |
||
1356 | ** Among other things, ^sqlite3_initialize() will invoke |
||
1357 | ** sqlite3_os_init(). Similarly, ^sqlite3_shutdown() |
||
1358 | ** will invoke sqlite3_os_end(). |
||
1359 | ** |
||
1360 | ** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success. |
||
1361 | ** ^If for some reason, sqlite3_initialize() is unable to initialize |
||
1362 | ** the library (perhaps it is unable to allocate a needed resource such |
||
1363 | ** as a mutex) it returns an [error code] other than [SQLITE_OK]. |
||
1364 | ** |
||
1365 | ** ^The sqlite3_initialize() routine is called internally by many other |
||
1366 | ** SQLite interfaces so that an application usually does not need to |
||
1367 | ** invoke sqlite3_initialize() directly. For example, [sqlite3_open()] |
||
1368 | ** calls sqlite3_initialize() so the SQLite library will be automatically |
||
1369 | ** initialized when [sqlite3_open()] is called if it has not be initialized |
||
1370 | ** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT] |
||
1371 | ** compile-time option, then the automatic calls to sqlite3_initialize() |
||
1372 | ** are omitted and the application must call sqlite3_initialize() directly |
||
1373 | ** prior to using any other SQLite interface. For maximum portability, |
||
1374 | ** it is recommended that applications always invoke sqlite3_initialize() |
||
1375 | ** directly prior to using any other SQLite interface. Future releases |
||
1376 | ** of SQLite may require this. In other words, the behavior exhibited |
||
1377 | ** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the |
||
1378 | ** default behavior in some future release of SQLite. |
||
1379 | ** |
||
1380 | ** The sqlite3_os_init() routine does operating-system specific |
||
1381 | ** initialization of the SQLite library. The sqlite3_os_end() |
||
1382 | ** routine undoes the effect of sqlite3_os_init(). Typical tasks |
||
1383 | ** performed by these routines include allocation or deallocation |
||
1384 | ** of static resources, initialization of global variables, |
||
1385 | ** setting up a default [sqlite3_vfs] module, or setting up |
||
1386 | ** a default configuration using [sqlite3_config()]. |
||
1387 | ** |
||
1388 | ** The application should never invoke either sqlite3_os_init() |
||
1389 | ** or sqlite3_os_end() directly. The application should only invoke |
||
1390 | ** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init() |
||
1391 | ** interface is called automatically by sqlite3_initialize() and |
||
1392 | ** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate |
||
1393 | ** implementations for sqlite3_os_init() and sqlite3_os_end() |
||
1394 | ** are built into SQLite when it is compiled for Unix, Windows, or OS/2. |
||
1395 | ** When [custom builds | built for other platforms] |
||
1396 | ** (using the [SQLITE_OS_OTHER=1] compile-time |
||
1397 | ** option) the application must supply a suitable implementation for |
||
1398 | ** sqlite3_os_init() and sqlite3_os_end(). An application-supplied |
||
1399 | ** implementation of sqlite3_os_init() or sqlite3_os_end() |
||
1400 | ** must return [SQLITE_OK] on success and some other [error code] upon |
||
1401 | ** failure. |
||
1402 | */ |
||
1403 | //SQLITE_API int sqlite3_initialize(void); |
||
1404 | //SQLITE_API int sqlite3_shutdown(void); |
||
1405 | //SQLITE_API int sqlite3_os_init(void); |
||
1406 | //SQLITE_API int sqlite3_os_end(void); |
||
1407 | |||
1408 | /* |
||
1409 | ** CAPI3REF: Configuring The SQLite Library |
||
1410 | ** |
||
1411 | ** The sqlite3_config() interface is used to make global configuration |
||
1412 | ** changes to SQLite in order to tune SQLite to the specific needs of |
||
1413 | ** the application. The default configuration is recommended for most |
||
1414 | ** applications and so this routine is usually not necessary. It is |
||
1415 | ** provided to support rare applications with unusual needs. |
||
1416 | ** |
||
1417 | ** The sqlite3_config() interface is not threadsafe. The application |
||
1418 | ** must insure that no other SQLite interfaces are invoked by other |
||
1419 | ** threads while sqlite3_config() is running. Furthermore, sqlite3_config() |
||
1420 | ** may only be invoked prior to library initialization using |
||
1421 | ** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()]. |
||
1422 | ** ^If sqlite3_config() is called after [sqlite3_initialize()] and before |
||
1423 | ** [sqlite3_shutdown()] then it will return SQLITE_MISUSE. |
||
1424 | ** Note, however, that ^sqlite3_config() can be called as part of the |
||
1425 | ** implementation of an application-defined [sqlite3_os_init()]. |
||
1426 | ** |
||
1427 | ** The first argument to sqlite3_config() is an integer |
||
1428 | ** [configuration option] that determines |
||
1429 | ** what property of SQLite is to be configured. Subsequent arguments |
||
1430 | ** vary depending on the [configuration option] |
||
1431 | ** in the first argument. |
||
1432 | ** |
||
1433 | ** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK]. |
||
1434 | ** ^If the option is unknown or SQLite is unable to set the option |
||
1435 | ** then this routine returns a non-zero [error code]. |
||
1436 | */ |
||
1437 | //SQLITE_API int sqlite3_config(int, ...); |
||
1438 | |||
1439 | /* |
||
1440 | ** CAPI3REF: Configure database connections |
||
1441 | ** |
||
1442 | ** The sqlite3_db_config() interface is used to make configuration |
||
1443 | ** changes to a [database connection]. The interface is similar to |
||
1444 | ** [sqlite3_config()] except that the changes apply to a single |
||
1445 | ** [database connection] (specified in the first argument). |
||
1446 | ** |
||
1447 | ** The second argument to sqlite3_db_config(D,V,...) is the |
||
1448 | ** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code |
||
1449 | ** that indicates what aspect of the [database connection] is being configured. |
||
1450 | ** Subsequent arguments vary depending on the configuration verb. |
||
1451 | ** |
||
1452 | ** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if |
||
1453 | ** the call is considered successful. |
||
1454 | */ |
||
1455 | //SQLITE_API int sqlite3_db_config(sqlite3*, int op, ...); |
||
1456 | |||
1457 | /* |
||
1458 | ** CAPI3REF: Memory Allocation Routines |
||
1459 | ** |
||
1460 | ** An instance of this object defines the interface between SQLite |
||
1461 | ** and low-level memory allocation routines. |
||
1462 | ** |
||
1463 | ** This object is used in only one place in the SQLite interface. |
||
1464 | ** A pointer to an instance of this object is the argument to |
||
1465 | ** [sqlite3_config()] when the configuration option is |
||
1466 | ** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC]. |
||
1467 | ** By creating an instance of this object |
||
1468 | ** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC]) |
||
1469 | ** during configuration, an application can specify an alternative |
||
1470 | ** memory allocation subsystem for SQLite to use for all of its |
||
1471 | ** dynamic memory needs. |
||
1472 | ** |
||
1473 | ** Note that SQLite comes with several [built-in memory allocators] |
||
1474 | ** that are perfectly adequate for the overwhelming majority of applications |
||
1475 | ** and that this object is only useful to a tiny minority of applications |
||
1476 | ** with specialized memory allocation requirements. This object is |
||
1477 | ** also used during testing of SQLite in order to specify an alternative |
||
1478 | ** memory allocator that simulates memory out-of-memory conditions in |
||
1479 | ** order to verify that SQLite recovers gracefully from such |
||
1480 | ** conditions. |
||
1481 | ** |
||
1482 | ** The xMalloc and xFree methods must work like the |
||
1483 | ** malloc() and free() functions from the standard C library. |
||
1484 | ** The xRealloc method must work like realloc() from the standard C library |
||
1485 | ** with the exception that if the second argument to xRealloc is zero, |
||
1486 | ** xRealloc must be a no-op - it must not perform any allocation or |
||
1487 | ** deallocation. ^SQLite guarantees that the second argument to |
||
1488 | ** xRealloc is always a value returned by a prior call to xRoundup. |
||
1489 | ** And so in cases where xRoundup always returns a positive number, |
||
1490 | ** xRealloc can perform exactly as the standard library realloc() and |
||
1491 | ** still be in compliance with this specification. |
||
1492 | ** |
||
1493 | ** xSize should return the allocated size of a memory allocation |
||
1494 | ** previously obtained from xMalloc or xRealloc. The allocated size |
||
1495 | ** is always at least as big as the requested size but may be larger. |
||
1496 | ** |
||
1497 | ** The xRoundup method returns what would be the allocated size of |
||
1498 | ** a memory allocation given a particular requested size. Most memory |
||
1499 | ** allocators round up memory allocations at least to the next multiple |
||
1500 | ** of 8. Some allocators round up to a larger multiple or to a power of 2. |
||
1501 | ** Every memory allocation request coming in through [sqlite3_malloc()] |
||
1502 | ** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0, |
||
1503 | ** that causes the corresponding memory allocation to fail. |
||
1504 | ** |
||
1505 | ** The xInit method initializes the memory allocator. (For example, |
||
1506 | ** it might allocate any require mutexes or initialize internal data |
||
1507 | ** structures. The xShutdown method is invoked (indirectly) by |
||
1508 | ** [sqlite3_shutdown()] and should deallocate any resources acquired |
||
1509 | ** by xInit. The pAppData pointer is used as the only parameter to |
||
1510 | ** xInit and xShutdown. |
||
1511 | ** |
||
1512 | ** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes |
||
1513 | ** the xInit method, so the xInit method need not be threadsafe. The |
||
1514 | ** xShutdown method is only called from [sqlite3_shutdown()] so it does |
||
1515 | ** not need to be threadsafe either. For all other methods, SQLite |
||
1516 | ** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the |
||
1517 | ** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which |
||
1518 | ** it is by default) and so the methods are automatically serialized. |
||
1519 | ** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other |
||
1520 | ** methods must be threadsafe or else make their own arrangements for |
||
1521 | ** serialization. |
||
1522 | ** |
||
1523 | ** SQLite will never invoke xInit() more than once without an intervening |
||
1524 | ** call to xShutdown(). |
||
1525 | */ |
||
1526 | //typedef struct sqlite3_mem_methods sqlite3_mem_methods; |
||
1527 | //struct sqlite3_mem_methods { |
||
1528 | // void *(*xMalloc)(int); /* Memory allocation function */ |
||
1529 | // void (*xFree)(void); /* Free a prior allocation */ |
||
1530 | // void *(*xRealloc)(void*,int); /* Resize an allocation */ |
||
1531 | // int (*xSize)(void); /* Return the size of an allocation */ |
||
1532 | // int (*xRoundup)(int); /* Round up request size to allocation size */ |
||
1533 | // int (*xInit)(void); /* Initialize the memory allocator */ |
||
1534 | // void (*xShutdown)(void); /* Deinitialize the memory allocator */ |
||
1535 | // void *pAppData; /* Argument to xInit() and xShutdown() */ |
||
1536 | //}; |
||
1537 | public class sqlite3_mem_methods |
||
1538 | { |
||
1539 | public dxMalloc xMalloc; //void *(*xMalloc)(int); /* Memory allocation function */ |
||
1540 | public dxMallocInt xMallocInt; //void *(*xMalloc)(int); /* Memory allocation function */ |
||
1541 | public dxMallocMem xMallocMem; //void *(*xMalloc)(int); /* Memory allocation function */ |
||
1542 | public dxFree xFree; //void (*xFree)(void); /* Free a prior allocation */ |
||
1543 | public dxFreeInt xFreeInt; //void (*xFree)(void); /* Free a prior allocation */ |
||
1544 | public dxFreeMem xFreeMem; //void (*xFree)(void); /* Free a prior allocation */ |
||
1545 | public dxRealloc xRealloc; //void *(*xRealloc)(void*,int); /* Resize an allocation */ |
||
1546 | public dxSize xSize; //int (*xSize)(void); /* Return the size of an allocation */ |
||
1547 | public dxRoundup xRoundup; //int (*xRoundup)(int); /* Round up request size to allocation size */ |
||
1548 | public dxMemInit xInit; //int (*xInit)(void); /* Initialize the memory allocator */ |
||
1549 | public dxMemShutdown xShutdown; //void (*xShutdown)(void); /* Deinitialize the memory allocator */ |
||
1550 | public object pAppData; /* Argument to xInit() and xShutdown() */ |
||
1551 | |||
1552 | public sqlite3_mem_methods() |
||
1553 | { |
||
1554 | } |
||
1555 | |||
1556 | public sqlite3_mem_methods( |
||
1557 | dxMalloc xMalloc, |
||
1558 | dxMallocInt xMallocInt, |
||
1559 | dxMallocMem xMallocMem, |
||
1560 | dxFree xFree, |
||
1561 | dxFreeInt xFreeInt, |
||
1562 | dxFreeMem xFreeMem, |
||
1563 | dxRealloc xRealloc, |
||
1564 | dxSize xSize, |
||
1565 | dxRoundup xRoundup, |
||
1566 | dxMemInit xInit, |
||
1567 | dxMemShutdown xShutdown, |
||
1568 | object pAppData |
||
1569 | ) |
||
1570 | { |
||
1571 | this.xMalloc = xMalloc; |
||
1572 | this.xMallocInt = xMallocInt; |
||
1573 | this.xMallocMem = xMallocMem; |
||
1574 | this.xFree = xFree; |
||
1575 | this.xFreeInt = xFreeInt; |
||
1576 | this.xFreeMem = xFreeMem; |
||
1577 | this.xRealloc = xRealloc; |
||
1578 | this.xSize = xSize; |
||
1579 | this.xRoundup = xRoundup; |
||
1580 | this.xInit = xInit; |
||
1581 | this.xShutdown = xShutdown; |
||
1582 | this.pAppData = pAppData; |
||
1583 | } |
||
1584 | } |
||
1585 | |||
1586 | |||
1587 | /* |
||
1588 | ** CAPI3REF: Configuration Options |
||
1589 | ** KEYWORDS: {configuration option} |
||
1590 | ** |
||
1591 | ** These constants are the available integer configuration options that |
||
1592 | ** can be passed as the first argument to the [sqlite3_config()] interface. |
||
1593 | ** |
||
1594 | ** New configuration options may be added in future releases of SQLite. |
||
1595 | ** Existing configuration options might be discontinued. Applications |
||
1596 | ** should check the return code from [sqlite3_config()] to make sure that |
||
1597 | ** the call worked. The [sqlite3_config()] interface will return a |
||
1598 | ** non-zero [error code] if a discontinued or unsupported configuration option |
||
1599 | ** is invoked. |
||
1600 | ** |
||
1601 | ** <dl> |
||
1602 | ** [[SQLITE_CONFIG_SINGLETHREAD]] <dt>SQLITE_CONFIG_SINGLETHREAD</dt> |
||
1603 | ** <dd>There are no arguments to this option. ^This option sets the |
||
1604 | ** [threading mode] to Single-thread. In other words, it disables |
||
1605 | ** all mutexing and puts SQLite into a mode where it can only be used |
||
1606 | ** by a single thread. ^If SQLite is compiled with |
||
1607 | ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then |
||
1608 | ** it is not possible to change the [threading mode] from its default |
||
1609 | ** value of Single-thread and so [sqlite3_config()] will return |
||
1610 | ** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD |
||
1611 | ** configuration option.</dd> |
||
1612 | ** |
||
1613 | ** [[SQLITE_CONFIG_MULTITHREAD]] <dt>SQLITE_CONFIG_MULTITHREAD</dt> |
||
1614 | ** <dd>There are no arguments to this option. ^This option sets the |
||
1615 | ** [threading mode] to Multi-thread. In other words, it disables |
||
1616 | ** mutexing on [database connection] and [prepared statement] objects. |
||
1617 | ** The application is responsible for serializing access to |
||
1618 | ** [database connections] and [prepared statements]. But other mutexes |
||
1619 | ** are enabled so that SQLite will be safe to use in a multi-threaded |
||
1620 | ** environment as long as no two threads attempt to use the same |
||
1621 | ** [database connection] at the same time. ^If SQLite is compiled with |
||
1622 | ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then |
||
1623 | ** it is not possible to set the Multi-thread [threading mode] and |
||
1624 | ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the |
||
1625 | ** SQLITE_CONFIG_MULTITHREAD configuration option.</dd> |
||
1626 | ** |
||
1627 | ** [[SQLITE_CONFIG_SERIALIZED]] <dt>SQLITE_CONFIG_SERIALIZED</dt> |
||
1628 | ** <dd>There are no arguments to this option. ^This option sets the |
||
1629 | ** [threading mode] to Serialized. In other words, this option enables |
||
1630 | ** all mutexes including the recursive |
||
1631 | ** mutexes on [database connection] and [prepared statement] objects. |
||
1632 | ** In this mode (which is the default when SQLite is compiled with |
||
1633 | ** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access |
||
1634 | ** to [database connections] and [prepared statements] so that the |
||
1635 | ** application is free to use the same [database connection] or the |
||
1636 | ** same [prepared statement] in different threads at the same time. |
||
1637 | ** ^If SQLite is compiled with |
||
1638 | ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then |
||
1639 | ** it is not possible to set the Serialized [threading mode] and |
||
1640 | ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the |
||
1641 | ** SQLITE_CONFIG_SERIALIZED configuration option.</dd> |
||
1642 | ** |
||
1643 | ** [[SQLITE_CONFIG_MALLOC]] <dt>SQLITE_CONFIG_MALLOC</dt> |
||
1644 | ** <dd> ^(This option takes a single argument which is a pointer to an |
||
1645 | ** instance of the [sqlite3_mem_methods] structure. The argument specifies |
||
1646 | ** alternative low-level memory allocation routines to be used in place of |
||
1647 | ** the memory allocation routines built into SQLite.)^ ^SQLite makes |
||
1648 | ** its own private copy of the content of the [sqlite3_mem_methods] structure |
||
1649 | ** before the [sqlite3_config()] call returns.</dd> |
||
1650 | ** |
||
1651 | ** [[SQLITE_CONFIG_GETMALLOC]] <dt>SQLITE_CONFIG_GETMALLOC</dt> |
||
1652 | ** <dd> ^(This option takes a single argument which is a pointer to an |
||
1653 | ** instance of the [sqlite3_mem_methods] structure. The [sqlite3_mem_methods] |
||
1654 | ** structure is filled with the currently defined memory allocation routines.)^ |
||
1655 | ** This option can be used to overload the default memory allocation |
||
1656 | ** routines with a wrapper that simulations memory allocation failure or |
||
1657 | ** tracks memory usage, for example. </dd> |
||
1658 | ** |
||
1659 | ** [[SQLITE_CONFIG_MEMSTATUS]] <dt>SQLITE_CONFIG_MEMSTATUS</dt> |
||
1660 | ** <dd> ^This option takes single argument of type int, interpreted as a |
||
1661 | ** boolean, which enables or disables the collection of memory allocation |
||
1662 | ** statistics. ^(When memory allocation statistics are disabled, the |
||
1663 | ** following SQLite interfaces become non-operational: |
||
1664 | ** <ul> |
||
1665 | ** <li> [sqlite3_memory_used()] |
||
1666 | ** <li> [sqlite3_memory_highwater()] |
||
1667 | ** <li> [sqlite3_soft_heap_limit64()] |
||
1668 | ** <li> [sqlite3_status()] |
||
1669 | ** </ul>)^ |
||
1670 | ** ^Memory allocation statistics are enabled by default unless SQLite is |
||
1671 | ** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory |
||
1672 | ** allocation statistics are disabled by default. |
||
1673 | ** </dd> |
||
1674 | ** |
||
1675 | ** [[SQLITE_CONFIG_SCRATCH]] <dt>SQLITE_CONFIG_SCRATCH</dt> |
||
1676 | ** <dd> ^This option specifies a static memory buffer that SQLite can use for |
||
1677 | ** scratch memory. There are three arguments: A pointer an 8-byte |
||
1678 | ** aligned memory buffer from which the scratch allocations will be |
||
1679 | ** drawn, the size of each scratch allocation (sz), |
||
1680 | ** and the maximum number of scratch allocations (N). The sz |
||
1681 | ** argument must be a multiple of 16. |
||
1682 | ** The first argument must be a pointer to an 8-byte aligned buffer |
||
1683 | ** of at least sz*N bytes of memory. |
||
1684 | ** ^SQLite will use no more than two scratch buffers per thread. So |
||
1685 | ** N should be set to twice the expected maximum number of threads. |
||
1686 | ** ^SQLite will never require a scratch buffer that is more than 6 |
||
1687 | ** times the database page size. ^If SQLite needs needs additional |
||
1688 | ** scratch memory beyond what is provided by this configuration option, then |
||
1689 | ** [sqlite3_malloc()] will be used to obtain the memory needed.</dd> |
||
1690 | ** |
||
1691 | ** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt> |
||
1692 | ** <dd> ^This option specifies a static memory buffer that SQLite can use for |
||
1693 | ** the database page cache with the default page cache implementation. |
||
1694 | ** This configuration should not be used if an application-define page |
||
1695 | ** cache implementation is loaded using the SQLITE_CONFIG_PCACHE option. |
||
1696 | ** There are three arguments to this option: A pointer to 8-byte aligned |
||
1697 | ** memory, the size of each page buffer (sz), and the number of pages (N). |
||
1698 | ** The sz argument should be the size of the largest database page |
||
1699 | ** (a power of two between 512 and 32768) plus a little extra for each |
||
1700 | ** page header. ^The page header size is 20 to 40 bytes depending on |
||
1701 | ** the host architecture. ^It is harmless, apart from the wasted memory, |
||
1702 | ** to make sz a little too large. The first |
||
1703 | ** argument should point to an allocation of at least sz*N bytes of memory. |
||
1704 | ** ^SQLite will use the memory provided by the first argument to satisfy its |
||
1705 | ** memory needs for the first N pages that it adds to cache. ^If additional |
||
1706 | ** page cache memory is needed beyond what is provided by this option, then |
||
1707 | ** SQLite goes to [sqlite3_malloc()] for the additional storage space. |
||
1708 | ** The pointer in the first argument must |
||
1709 | ** be aligned to an 8-byte boundary or subsequent behavior of SQLite |
||
1710 | ** will be undefined.</dd> |
||
1711 | ** |
||
1712 | ** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt> |
||
1713 | ** <dd> ^This option specifies a static memory buffer that SQLite will use |
||
1714 | ** for all of its dynamic memory allocation needs beyond those provided |
||
1715 | ** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE]. |
||
1716 | ** There are three arguments: An 8-byte aligned pointer to the memory, |
||
1717 | ** the number of bytes in the memory buffer, and the minimum allocation size. |
||
1718 | ** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts |
||
1719 | ** to using its default memory allocator (the system malloc() implementation), |
||
1720 | ** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the |
||
1721 | ** memory pointer is not NULL and either [SQLITE_ENABLE_MEMSYS3] or |
||
1722 | ** [SQLITE_ENABLE_MEMSYS5] are defined, then the alternative memory |
||
1723 | ** allocator is engaged to handle all of SQLites memory allocation needs. |
||
1724 | ** The first pointer (the memory pointer) must be aligned to an 8-byte |
||
1725 | ** boundary or subsequent behavior of SQLite will be undefined. |
||
1726 | ** The minimum allocation size is capped at 2^12. Reasonable values |
||
1727 | ** for the minimum allocation size are 2^5 through 2^8.</dd> |
||
1728 | ** |
||
1729 | ** [[SQLITE_CONFIG_MUTEX]] <dt>SQLITE_CONFIG_MUTEX</dt> |
||
1730 | ** <dd> ^(This option takes a single argument which is a pointer to an |
||
1731 | ** instance of the [sqlite3_mutex_methods] structure. The argument specifies |
||
1732 | ** alternative low-level mutex routines to be used in place |
||
1733 | ** the mutex routines built into SQLite.)^ ^SQLite makes a copy of the |
||
1734 | ** content of the [sqlite3_mutex_methods] structure before the call to |
||
1735 | ** [sqlite3_config()] returns. ^If SQLite is compiled with |
||
1736 | ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then |
||
1737 | ** the entire mutexing subsystem is omitted from the build and hence calls to |
||
1738 | ** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will |
||
1739 | ** return [SQLITE_ERROR].</dd> |
||
1740 | ** |
||
1741 | ** [[SQLITE_CONFIG_GETMUTEX]] <dt>SQLITE_CONFIG_GETMUTEX</dt> |
||
1742 | ** <dd> ^(This option takes a single argument which is a pointer to an |
||
1743 | ** instance of the [sqlite3_mutex_methods] structure. The |
||
1744 | ** [sqlite3_mutex_methods] |
||
1745 | ** structure is filled with the currently defined mutex routines.)^ |
||
1746 | ** This option can be used to overload the default mutex allocation |
||
1747 | ** routines with a wrapper used to track mutex usage for performance |
||
1748 | ** profiling or testing, for example. ^If SQLite is compiled with |
||
1749 | ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then |
||
1750 | ** the entire mutexing subsystem is omitted from the build and hence calls to |
||
1751 | ** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will |
||
1752 | ** return [SQLITE_ERROR].</dd> |
||
1753 | ** |
||
1754 | ** [[SQLITE_CONFIG_LOOKASIDE]] <dt>SQLITE_CONFIG_LOOKASIDE</dt> |
||
1755 | ** <dd> ^(This option takes two arguments that determine the default |
||
1756 | ** memory allocation for the lookaside memory allocator on each |
||
1757 | ** [database connection]. The first argument is the |
||
1758 | ** size of each lookaside buffer slot and the second is the number of |
||
1759 | ** slots allocated to each database connection.)^ ^(This option sets the |
||
1760 | ** <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE] |
||
1761 | ** verb to [sqlite3_db_config()] can be used to change the lookaside |
||
1762 | ** configuration on individual connections.)^ </dd> |
||
1763 | ** |
||
1764 | ** [[SQLITE_CONFIG_PCACHE]] <dt>SQLITE_CONFIG_PCACHE</dt> |
||
1765 | ** <dd> ^(This option takes a single argument which is a pointer to |
||
1766 | ** an [sqlite3_pcache_methods] object. This object specifies the interface |
||
1767 | ** to a custom page cache implementation.)^ ^SQLite makes a copy of the |
||
1768 | ** object and uses it for page cache memory allocations.</dd> |
||
1769 | ** |
||
1770 | ** [[SQLITE_CONFIG_GETPCACHE]] <dt>SQLITE_CONFIG_GETPCACHE</dt> |
||
1771 | ** <dd> ^(This option takes a single argument which is a pointer to an |
||
1772 | ** [sqlite3_pcache_methods] object. SQLite copies of the current |
||
1773 | ** page cache implementation into that object.)^ </dd> |
||
1774 | ** |
||
1775 | ** [[SQLITE_CONFIG_LOG]] <dt>SQLITE_CONFIG_LOG</dt> |
||
1776 | ** <dd> ^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a |
||
1777 | ** function with a call signature of void()(void*,int,const char), |
||
1778 | ** and a pointer to void. ^If the function pointer is not NULL, it is |
||
1779 | ** invoked by [sqlite3_log()] to process each logging event. ^If the |
||
1780 | ** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op. |
||
1781 | ** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is |
||
1782 | ** passed through as the first parameter to the application-defined logger |
||
1783 | ** function whenever that function is invoked. ^The second parameter to |
||
1784 | ** the logger function is a copy of the first parameter to the corresponding |
||
1785 | ** [sqlite3_log()] call and is intended to be a [result code] or an |
||
1786 | ** [extended result code]. ^The third parameter passed to the logger is |
||
1787 | ** log message after formatting via [sqlite3_snprintf()]. |
||
1788 | ** The SQLite logging interface is not reentrant; the logger function |
||
1789 | ** supplied by the application must not invoke any SQLite interface. |
||
1790 | ** In a multi-threaded application, the application-defined logger |
||
1791 | ** function must be threadsafe. </dd> |
||
1792 | ** |
||
1793 | ** [[SQLITE_CONFIG_URI]] <dt>SQLITE_CONFIG_URI |
||
1794 | ** <dd> This option takes a single argument of type int. If non-zero, then |
||
1795 | ** URI handling is globally enabled. If the parameter is zero, then URI handling |
||
1796 | ** is globally disabled. If URI handling is globally enabled, all filenames |
||
1797 | ** passed to [sqlite3_open()], [sqlite3_open_v2()], [sqlite3_open16()] or |
||
1798 | ** specified as part of [ATTACH] commands are interpreted as URIs, regardless |
||
1799 | ** of whether or not the [SQLITE_OPEN_URI] flag is set when the database |
||
1800 | ** connection is opened. If it is globally disabled, filenames are |
||
1801 | ** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the |
||
1802 | ** database connection is opened. By default, URI handling is globally |
||
1803 | ** disabled. The default value may be changed by compiling with the |
||
1804 | ** [SQLITE_USE_URI] symbol defined. |
||
1805 | ** </dl> |
||
1806 | */ |
||
1807 | //#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */ |
||
1808 | //#define SQLITE_CONFIG_MULTITHREAD 2 /* nil */ |
||
1809 | //#define SQLITE_CONFIG_SERIALIZED 3 /* nil */ |
||
1810 | //#define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */ |
||
1811 | //#define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */ |
||
1812 | //#define SQLITE_CONFIG_SCRATCH 6 /* void*, int sz, int N */ |
||
1813 | //#define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */ |
||
1814 | //#define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */ |
||
1815 | //#define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */ |
||
1816 | //#define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */ |
||
1817 | //#define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */ |
||
1818 | ///* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */ |
||
1819 | //#define SQLITE_CONFIG_LOOKASIDE 13 /* int int */ |
||
1820 | //#define SQLITE_CONFIG_PCACHE 14 /* sqlite3_pcache_methods* */ |
||
1821 | //#define SQLITE_CONFIG_GETPCACHE 15 /* sqlite3_pcache_methods* */ |
||
1822 | //#define SQLITE_CONFIG_LOG 16 /* xFunc, void* */ |
||
1823 | //#define SQLITE_CONFIG_URI 17 /* int */ |
||
1824 | const int SQLITE_CONFIG_SINGLETHREAD = 1; |
||
1825 | const int SQLITE_CONFIG_MULTITHREAD = 2; |
||
1826 | const int SQLITE_CONFIG_SERIALIZED = 3; |
||
1827 | const int SQLITE_CONFIG_MALLOC = 4; |
||
1828 | const int SQLITE_CONFIG_GETMALLOC = 5; |
||
1829 | const int SQLITE_CONFIG_SCRATCH = 6; |
||
1830 | const int SQLITE_CONFIG_PAGECACHE = 7; |
||
1831 | const int SQLITE_CONFIG_HEAP = 8; |
||
1832 | const int SQLITE_CONFIG_MEMSTATUS = 9; |
||
1833 | const int SQLITE_CONFIG_MUTEX = 10; |
||
1834 | const int SQLITE_CONFIG_GETMUTEX = 11; |
||
1835 | const int SQLITE_CONFIG_LOOKASIDE = 13; |
||
1836 | const int SQLITE_CONFIG_PCACHE = 14; |
||
1837 | const int SQLITE_CONFIG_GETPCACHE = 15; |
||
1838 | const int SQLITE_CONFIG_LOG = 16; |
||
1839 | const int SQLITE_CONFIG_URI = 17; |
||
1840 | |||
1841 | /* |
||
1842 | ** CAPI3REF: Database Connection Configuration Options |
||
1843 | ** |
||
1844 | ** These constants are the available integer configuration options that |
||
1845 | ** can be passed as the second argument to the [sqlite3_db_config()] interface. |
||
1846 | ** |
||
1847 | ** New configuration options may be added in future releases of SQLite. |
||
1848 | ** Existing configuration options might be discontinued. Applications |
||
1849 | ** should check the return code from [sqlite3_db_config()] to make sure that |
||
1850 | ** the call worked. ^The [sqlite3_db_config()] interface will return a |
||
1851 | ** non-zero [error code] if a discontinued or unsupported configuration option |
||
1852 | ** is invoked. |
||
1853 | ** |
||
1854 | ** <dl> |
||
1855 | ** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt> |
||
1856 | ** <dd> ^This option takes three additional arguments that determine the |
||
1857 | ** [lookaside memory allocator] configuration for the [database connection]. |
||
1858 | ** ^The first argument (the third parameter to [sqlite3_db_config()] is a |
||
1859 | ** pointer to a memory buffer to use for lookaside memory. |
||
1860 | ** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb |
||
1861 | ** may be NULL in which case SQLite will allocate the |
||
1862 | ** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the |
||
1863 | ** size of each lookaside buffer slot. ^The third argument is the number of |
||
1864 | ** slots. The size of the buffer in the first argument must be greater than |
||
1865 | ** or equal to the product of the second and third arguments. The buffer |
||
1866 | ** must be aligned to an 8-byte boundary. ^If the second argument to |
||
1867 | ** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally |
||
1868 | ** rounded down to the next smaller multiple of 8. ^(The lookaside memory |
||
1869 | ** configuration for a database connection can only be changed when that |
||
1870 | ** connection is not currently using lookaside memory, or in other words |
||
1871 | ** when the "current value" returned by |
||
1872 | ** [sqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero. |
||
1873 | ** Any attempt to change the lookaside memory configuration when lookaside |
||
1874 | ** memory is in use leaves the configuration unchanged and returns |
||
1875 | ** [SQLITE_BUSY].)^</dd> |
||
1876 | ** |
||
1877 | ** <dt>SQLITE_DBCONFIG_ENABLE_FKEY</dt> |
||
1878 | ** <dd> ^This option is used to enable or disable the enforcement of |
||
1879 | ** [foreign key constraints]. There should be two additional arguments. |
||
1880 | ** The first argument is an integer which is 0 to disable FK enforcement, |
||
1881 | ** positive to enable FK enforcement or negative to leave FK enforcement |
||
1882 | ** unchanged. The second parameter is a pointer to an integer into which |
||
1883 | ** is written 0 or 1 to indicate whether FK enforcement is off or on |
||
1884 | ** following this call. The second parameter may be a NULL pointer, in |
||
1885 | ** which case the FK enforcement setting is not reported back. </dd> |
||
1886 | ** |
||
1887 | ** <dt>SQLITE_DBCONFIG_ENABLE_TRIGGER</dt> |
||
1888 | ** <dd> ^This option is used to enable or disable [CREATE TRIGGER | triggers]. |
||
1889 | ** There should be two additional arguments. |
||
1890 | ** The first argument is an integer which is 0 to disable triggers, |
||
1891 | ** positive to enable triggers or negative to leave the setting unchanged. |
||
1892 | ** The second parameter is a pointer to an integer into which |
||
1893 | ** is written 0 or 1 to indicate whether triggers are disabled or enabled |
||
1894 | ** following this call. The second parameter may be a NULL pointer, in |
||
1895 | ** which case the trigger setting is not reported back. </dd> |
||
1896 | ** |
||
1897 | ** </dl> |
||
1898 | */ |
||
1899 | //#define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */ |
||
1900 | //#define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */ |
||
1901 | //#define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */ |
||
1902 | const int SQLITE_DBCONFIG_LOOKASIDE = 1001; |
||
1903 | const int SQLITE_DBCONFIG_ENABLE_FKEY = 1002; |
||
1904 | const int SQLITE_DBCONFIG_ENABLE_TRIGGER = 1003; |
||
1905 | |||
1906 | /* |
||
1907 | ** CAPI3REF: Enable Or Disable Extended Result Codes |
||
1908 | ** |
||
1909 | ** ^The sqlite3_extended_result_codes() routine enables or disables the |
||
1910 | ** [extended result codes] feature of SQLite. ^The extended result |
||
1911 | ** codes are disabled by default for historical compatibility. |
||
1912 | */ |
||
1913 | //SQLITE_API int sqlite3_extended_result_codes(sqlite3*, int onoff); |
||
1914 | |||
1915 | /* |
||
1916 | ** CAPI3REF: Last Insert Rowid |
||
1917 | ** |
||
1918 | ** ^Each entry in an SQLite table has a unique 64-bit signed |
||
1919 | ** integer key called the [ROWID | "rowid"]. ^The rowid is always available |
||
1920 | ** as an undeclared column named ROWID, OID, or _ROWID_ as long as those |
||
1921 | ** names are not also used by explicitly declared columns. ^If |
||
1922 | ** the table has a column of type [INTEGER PRIMARY KEY] then that column |
||
1923 | ** is another alias for the rowid. |
||
1924 | ** |
||
1925 | ** ^This routine returns the [rowid] of the most recent |
||
1926 | ** successful [INSERT] into the database from the [database connection] |
||
1927 | ** in the first argument. ^As of SQLite version 3.7.7, this routines |
||
1928 | ** records the last insert rowid of both ordinary tables and [virtual tables]. |
||
1929 | ** ^If no successful [INSERT]s |
||
1930 | ** have ever occurred on that database connection, zero is returned. |
||
1931 | ** |
||
1932 | ** ^(If an [INSERT] occurs within a trigger or within a [virtual table] |
||
1933 | ** method, then this routine will return the [rowid] of the inserted |
||
1934 | ** row as long as the trigger or virtual table method is running. |
||
1935 | ** But once the trigger or virtual table method ends, the value returned |
||
1936 | ** by this routine reverts to what it was before the trigger or virtual |
||
1937 | ** table method began.)^ |
||
1938 | ** |
||
1939 | ** ^An [INSERT] that fails due to a constraint violation is not a |
||
1940 | ** successful [INSERT] and does not change the value returned by this |
||
1941 | ** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK, |
||
1942 | ** and INSERT OR ABORT make no changes to the return value of this |
||
1943 | ** routine when their insertion fails. ^(When INSERT OR REPLACE |
||
1944 | ** encounters a constraint violation, it does not fail. The |
||
1945 | ** INSERT continues to completion after deleting rows that caused |
||
1946 | ** the constraint problem so INSERT OR REPLACE will always change |
||
1947 | ** the return value of this interface.)^ |
||
1948 | ** |
||
1949 | ** ^For the purposes of this routine, an [INSERT] is considered to |
||
1950 | ** be successful even if it is subsequently rolled back. |
||
1951 | ** |
||
1952 | ** This function is accessible to SQL statements via the |
||
1953 | ** [last_insert_rowid() SQL function]. |
||
1954 | ** |
||
1955 | ** If a separate thread performs a new [INSERT] on the same |
||
1956 | ** database connection while the [sqlite3_last_insert_rowid()] |
||
1957 | ** function is running and thus changes the last insert [rowid], |
||
1958 | ** then the value returned by [sqlite3_last_insert_rowid()] is |
||
1959 | ** unpredictable and might not equal either the old or the new |
||
1960 | ** last insert [rowid]. |
||
1961 | */ |
||
1962 | //SQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3); |
||
1963 | |||
1964 | /* |
||
1965 | ** CAPI3REF: Count The Number Of Rows Modified |
||
1966 | ** |
||
1967 | ** ^This function returns the number of database rows that were changed |
||
1968 | ** or inserted or deleted by the most recently completed SQL statement |
||
1969 | ** on the [database connection] specified by the first parameter. |
||
1970 | ** ^(Only changes that are directly specified by the [INSERT], [UPDATE], |
||
1971 | ** or [DELETE] statement are counted. Auxiliary changes caused by |
||
1972 | ** triggers or [foreign key actions] are not counted.)^ Use the |
||
1973 | ** [sqlite3_total_changes()] function to find the total number of changes |
||
1974 | ** including changes caused by triggers and foreign key actions. |
||
1975 | ** |
||
1976 | ** ^Changes to a view that are simulated by an [INSTEAD OF trigger] |
||
1977 | ** are not counted. Only real table changes are counted. |
||
1978 | ** |
||
1979 | ** ^(A "row change" is a change to a single row of a single table |
||
1980 | ** caused by an INSERT, DELETE, or UPDATE statement. Rows that |
||
1981 | ** are changed as side effects of [REPLACE] constraint resolution, |
||
1982 | ** rollback, ABORT processing, [DROP TABLE], or by any other |
||
1983 | ** mechanisms do not count as direct row changes.)^ |
||
1984 | ** |
||
1985 | ** A "trigger context" is a scope of execution that begins and |
||
1986 | ** ends with the script of a [CREATE TRIGGER | trigger]. |
||
1987 | ** Most SQL statements are |
||
1988 | ** evaluated outside of any trigger. This is the "top level" |
||
1989 | ** trigger context. If a trigger fires from the top level, a |
||
1990 | ** new trigger context is entered for the duration of that one |
||
1991 | ** trigger. Subtriggers create subcontexts for their duration. |
||
1992 | ** |
||
1993 | ** ^Calling [sqlite3_exec()] or [sqlite3_step()] recursively does |
||
1994 | ** not create a new trigger context. |
||
1995 | ** |
||
1996 | ** ^This function returns the number of direct row changes in the |
||
1997 | ** most recent INSERT, UPDATE, or DELETE statement within the same |
||
1998 | ** trigger context. |
||
1999 | ** |
||
2000 | ** ^Thus, when called from the top level, this function returns the |
||
2001 | ** number of changes in the most recent INSERT, UPDATE, or DELETE |
||
2002 | ** that also occurred at the top level. ^(Within the body of a trigger, |
||
2003 | ** the sqlite3_changes() interface can be called to find the number of |
||
2004 | ** changes in the most recently completed INSERT, UPDATE, or DELETE |
||
2005 | ** statement within the body of the same trigger. |
||
2006 | ** However, the number returned does not include changes |
||
2007 | ** caused by subtriggers since those have their own context.)^ |
||
2008 | ** |
||
2009 | ** See also the [sqlite3_total_changes()] interface, the |
||
2010 | ** [count_changes pragma], and the [changes() SQL function]. |
||
2011 | ** |
||
2012 | ** If a separate thread makes changes on the same database connection |
||
2013 | ** while [sqlite3_changes()] is running then the value returned |
||
2014 | ** is unpredictable and not meaningful. |
||
2015 | */ |
||
2016 | //SQLITE_API int sqlite3_changes(sqlite3); |
||
2017 | |||
2018 | /* |
||
2019 | ** CAPI3REF: Total Number Of Rows Modified |
||
2020 | ** |
||
2021 | ** ^This function returns the number of row changes caused by [INSERT], |
||
2022 | ** [UPDATE] or [DELETE] statements since the [database connection] was opened. |
||
2023 | ** ^(The count returned by sqlite3_total_changes() includes all changes |
||
2024 | ** from all [CREATE TRIGGER | trigger] contexts and changes made by |
||
2025 | ** [foreign key actions]. However, |
||
2026 | ** the count does not include changes used to implement [REPLACE] constraints, |
||
2027 | ** do rollbacks or ABORT processing, or [DROP TABLE] processing. The |
||
2028 | ** count does not include rows of views that fire an [INSTEAD OF trigger], |
||
2029 | ** though if the INSTEAD OF trigger makes changes of its own, those changes |
||
2030 | ** are counted.)^ |
||
2031 | ** ^The sqlite3_total_changes() function counts the changes as soon as |
||
2032 | ** the statement that makes them is completed (when the statement handle |
||
2033 | ** is passed to [sqlite3_reset()] or [sqlite3_finalize()]). |
||
2034 | ** |
||
2035 | ** See also the [sqlite3_changes()] interface, the |
||
2036 | ** [count_changes pragma], and the [total_changes() SQL function]. |
||
2037 | ** |
||
2038 | ** If a separate thread makes changes on the same database connection |
||
2039 | ** while [sqlite3_total_changes()] is running then the value |
||
2040 | ** returned is unpredictable and not meaningful. |
||
2041 | */ |
||
2042 | //SQLITE_API int sqlite3_total_changes(sqlite3); |
||
2043 | |||
2044 | /* |
||
2045 | ** CAPI3REF: Interrupt A Long-Running Query |
||
2046 | ** |
||
2047 | ** ^This function causes any pending database operation to abort and |
||
2048 | ** return at its earliest opportunity. This routine is typically |
||
2049 | ** called in response to a user action such as pressing "Cancel" |
||
2050 | ** or Ctrl-C where the user wants a long query operation to halt |
||
2051 | ** immediately. |
||
2052 | ** |
||
2053 | ** ^It is safe to call this routine from a thread different from the |
||
2054 | ** thread that is currently running the database operation. But it |
||
2055 | ** is not safe to call this routine with a [database connection] that |
||
2056 | ** is closed or might close before sqlite3_interrupt() returns. |
||
2057 | ** |
||
2058 | ** ^If an SQL operation is very nearly finished at the time when |
||
2059 | ** sqlite3_interrupt() is called, then it might not have an opportunity |
||
2060 | ** to be interrupted and might continue to completion. |
||
2061 | ** |
||
2062 | ** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT]. |
||
2063 | ** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE |
||
2064 | ** that is inside an explicit transaction, then the entire transaction |
||
2065 | ** will be rolled back automatically. |
||
2066 | ** |
||
2067 | ** ^The sqlite3_interrupt(D) call is in effect until all currently running |
||
2068 | ** SQL statements on [database connection] D complete. ^Any new SQL statements |
||
2069 | ** that are started after the sqlite3_interrupt() call and before the |
||
2070 | ** running statements reaches zero are interrupted as if they had been |
||
2071 | ** running prior to the sqlite3_interrupt() call. ^New SQL statements |
||
2072 | ** that are started after the running statement count reaches zero are |
||
2073 | ** not effected by the sqlite3_interrupt(). |
||
2074 | ** ^A call to sqlite3_interrupt(D) that occurs when there are no running |
||
2075 | ** SQL statements is a no-op and has no effect on SQL statements |
||
2076 | ** that are started after the sqlite3_interrupt() call returns. |
||
2077 | ** |
||
2078 | ** If the database connection closes while [sqlite3_interrupt()] |
||
2079 | ** is running then bad things will likely happen. |
||
2080 | */ |
||
2081 | //SQLITE_API void sqlite3_interrupt(sqlite3); |
||
2082 | |||
2083 | /* |
||
2084 | ** CAPI3REF: Determine If An SQL Statement Is Complete |
||
2085 | ** |
||
2086 | ** These routines are useful during command-line input to determine if the |
||
2087 | ** currently entered text seems to form a complete SQL statement or |
||
2088 | ** if additional input is needed before sending the text into |
||
2089 | ** SQLite for parsing. ^These routines return 1 if the input string |
||
2090 | ** appears to be a complete SQL statement. ^A statement is judged to be |
||
2091 | ** complete if it ends with a semicolon token and is not a prefix of a |
||
2092 | ** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within |
||
2093 | ** string literals or quoted identifier names or comments are not |
||
2094 | ** independent tokens (they are part of the token in which they are |
||
2095 | ** embedded) and thus do not count as a statement terminator. ^Whitespace |
||
2096 | ** and comments that follow the final semicolon are ignored. |
||
2097 | ** |
||
2098 | ** ^These routines return 0 if the statement is incomplete. ^If a |
||
2099 | ** memory allocation fails, then SQLITE_NOMEM is returned. |
||
2100 | ** |
||
2101 | ** ^These routines do not parse the SQL statements thus |
||
2102 | ** will not detect syntactically incorrect SQL. |
||
2103 | ** |
||
2104 | ** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior |
||
2105 | ** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked |
||
2106 | ** automatically by sqlite3_complete16(). If that initialization fails, |
||
2107 | ** then the return value from sqlite3_complete16() will be non-zero |
||
2108 | ** regardless of whether or not the input SQL is complete.)^ |
||
2109 | ** |
||
2110 | ** The input to [sqlite3_complete()] must be a zero-terminated |
||
2111 | ** UTF-8 string. |
||
2112 | ** |
||
2113 | ** The input to [sqlite3_complete16()] must be a zero-terminated |
||
2114 | ** UTF-16 string in native byte order. |
||
2115 | */ |
||
2116 | //SQLITE_API int sqlite3_complete(string sql); |
||
2117 | //SQLITE_API int sqlite3_complete16(const void *sql); |
||
2118 | |||
2119 | /* |
||
2120 | ** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors |
||
2121 | ** |
||
2122 | ** ^This routine sets a callback function that might be invoked whenever |
||
2123 | ** an attempt is made to open a database table that another thread |
||
2124 | ** or process has locked. |
||
2125 | ** |
||
2126 | ** ^If the busy callback is NULL, then [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] |
||
2127 | ** is returned immediately upon encountering the lock. ^If the busy callback |
||
2128 | ** is not NULL, then the callback might be invoked with two arguments. |
||
2129 | ** |
||
2130 | ** ^The first argument to the busy handler is a copy of the void* pointer which |
||
2131 | ** is the third argument to sqlite3_busy_handler(). ^The second argument to |
||
2132 | ** the busy handler callback is the number of times that the busy handler has |
||
2133 | ** been invoked for this locking event. ^If the |
||
2134 | ** busy callback returns 0, then no additional attempts are made to |
||
2135 | ** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned. |
||
2136 | ** ^If the callback returns non-zero, then another attempt |
||
2137 | ** is made to open the database for reading and the cycle repeats. |
||
2138 | ** |
||
2139 | ** The presence of a busy handler does not guarantee that it will be invoked |
||
2140 | ** when there is lock contention. ^If SQLite determines that invoking the busy |
||
2141 | ** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY] |
||
2142 | ** or [SQLITE_IOERR_BLOCKED] instead of invoking the busy handler. |
||
2143 | ** Consider a scenario where one process is holding a read lock that |
||
2144 | ** it is trying to promote to a reserved lock and |
||
2145 | ** a second process is holding a reserved lock that it is trying |
||
2146 | ** to promote to an exclusive lock. The first process cannot proceed |
||
2147 | ** because it is blocked by the second and the second process cannot |
||
2148 | ** proceed because it is blocked by the first. If both processes |
||
2149 | ** invoke the busy handlers, neither will make any progress. Therefore, |
||
2150 | ** SQLite returns [SQLITE_BUSY] for the first process, hoping that this |
||
2151 | ** will induce the first process to release its read lock and allow |
||
2152 | ** the second process to proceed. |
||
2153 | ** |
||
2154 | ** ^The default busy callback is NULL. |
||
2155 | ** |
||
2156 | ** ^The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED] |
||
2157 | ** when SQLite is in the middle of a large transaction where all the |
||
2158 | ** changes will not fit into the in-memory cache. SQLite will |
||
2159 | ** already hold a RESERVED lock on the database file, but it needs |
||
2160 | ** to promote this lock to EXCLUSIVE so that it can spill cache |
||
2161 | ** pages into the database file without harm to concurrent |
||
2162 | ** readers. ^If it is unable to promote the lock, then the in-memory |
||
2163 | ** cache will be left in an inconsistent state and so the error |
||
2164 | ** code is promoted from the relatively benign [SQLITE_BUSY] to |
||
2165 | ** the more severe [SQLITE_IOERR_BLOCKED]. ^This error code promotion |
||
2166 | ** forces an automatic rollback of the changes. See the |
||
2167 | ** <a href="/cvstrac/wiki?p=CorruptionFollowingBusyError"> |
||
2168 | ** CorruptionFollowingBusyError</a> wiki page for a discussion of why |
||
2169 | ** this is important. |
||
2170 | ** |
||
2171 | ** ^(There can only be a single busy handler defined for each |
||
2172 | ** [database connection]. Setting a new busy handler clears any |
||
2173 | ** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()] |
||
2174 | ** will also set or clear the busy handler. |
||
2175 | ** |
||
2176 | ** The busy callback should not take any actions which modify the |
||
2177 | ** database connection that invoked the busy handler. Any such actions |
||
2178 | ** result in undefined behavior. |
||
2179 | ** |
||
2180 | ** A busy handler must not close the database connection |
||
2181 | ** or [prepared statement] that invoked the busy handler. |
||
2182 | */ |
||
2183 | //SQLITE_API int sqlite3_busy_handler(sqlite3*, int()(void*,int), void); |
||
2184 | |||
2185 | /* |
||
2186 | ** CAPI3REF: Set A Busy Timeout |
||
2187 | ** |
||
2188 | ** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps |
||
2189 | ** for a specified amount of time when a table is locked. ^The handler |
||
2190 | ** will sleep multiple times until at least "ms" milliseconds of sleeping |
||
2191 | ** have accumulated. ^After at least "ms" milliseconds of sleeping, |
||
2192 | ** the handler returns 0 which causes [sqlite3_step()] to return |
||
2193 | ** [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED]. |
||
2194 | ** |
||
2195 | ** ^Calling this routine with an argument less than or equal to zero |
||
2196 | ** turns off all busy handlers. |
||
2197 | ** |
||
2198 | ** ^(There can only be a single busy handler for a particular |
||
2199 | ** [database connection] any any given moment. If another busy handler |
||
2200 | ** was defined (using [sqlite3_busy_handler()]) prior to calling |
||
2201 | ** this routine, that other busy handler is cleared.)^ |
||
2202 | */ |
||
2203 | //SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms); |
||
2204 | |||
2205 | /* |
||
2206 | ** CAPI3REF: Convenience Routines For Running Queries |
||
2207 | ** |
||
2208 | ** This is a legacy interface that is preserved for backwards compatibility. |
||
2209 | ** Use of this interface is not recommended. |
||
2210 | ** |
||
2211 | ** Definition: A <b>result table</b> is memory data structure created by the |
||
2212 | ** [sqlite3_get_table()] interface. A result table records the |
||
2213 | ** complete query results from one or more queries. |
||
2214 | ** |
||
2215 | ** The table conceptually has a number of rows and columns. But |
||
2216 | ** these numbers are not part of the result table itself. These |
||
2217 | ** numbers are obtained separately. Let N be the number of rows |
||
2218 | ** and M be the number of columns. |
||
2219 | ** |
||
2220 | ** A result table is an array of pointers to zero-terminated UTF-8 strings. |
||
2221 | ** There are (N+1)*M elements in the array. The first M pointers point |
||
2222 | ** to zero-terminated strings that contain the names of the columns. |
||
2223 | ** The remaining entries all point to query results. NULL values result |
||
2224 | ** in NULL pointers. All other values are in their UTF-8 zero-terminated |
||
2225 | ** string representation as returned by [sqlite3_column_text()]. |
||
2226 | ** |
||
2227 | ** A result table might consist of one or more memory allocations. |
||
2228 | ** It is not safe to pass a result table directly to [sqlite3_free()]. |
||
2229 | ** A result table should be deallocated using [sqlite3_free_table()]. |
||
2230 | ** |
||
2231 | ** ^(As an example of the result table format, suppose a query result |
||
2232 | ** is as follows: |
||
2233 | ** |
||
2234 | ** <blockquote><pre> |
||
2235 | ** Name | Age |
||
2236 | ** ----------------------- |
||
2237 | ** Alice | 43 |
||
2238 | ** Bob | 28 |
||
2239 | ** Cindy | 21 |
||
2240 | ** </pre></blockquote> |
||
2241 | ** |
||
2242 | ** There are two column (M==2) and three rows (N==3). Thus the |
||
2243 | ** result table has 8 entries. Suppose the result table is stored |
||
2244 | ** in an array names azResult. Then azResult holds this content: |
||
2245 | ** |
||
2246 | ** <blockquote><pre> |
||
2247 | ** azResult[0] = "Name"; |
||
2248 | ** azResult[1] = "Age"; |
||
2249 | ** azResult[2] = "Alice"; |
||
2250 | ** azResult[3] = "43"; |
||
2251 | ** azResult[4] = "Bob"; |
||
2252 | ** azResult[5] = "28"; |
||
2253 | ** azResult[6] = "Cindy"; |
||
2254 | ** azResult[7] = "21"; |
||
2255 | ** </pre></blockquote>)^ |
||
2256 | ** |
||
2257 | ** ^The sqlite3_get_table() function evaluates one or more |
||
2258 | ** semicolon-separated SQL statements in the zero-terminated UTF-8 |
||
2259 | ** string of its 2nd parameter and returns a result table to the |
||
2260 | ** pointer given in its 3rd parameter. |
||
2261 | ** |
||
2262 | ** After the application has finished with the result from sqlite3_get_table(), |
||
2263 | ** it must pass the result table pointer to sqlite3_free_table() in order to |
||
2264 | ** release the memory that was malloced. Because of the way the |
||
2265 | ** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling |
||
2266 | ** function must not try to call [sqlite3_free()] directly. Only |
||
2267 | ** [sqlite3_free_table()] is able to release the memory properly and safely. |
||
2268 | ** |
||
2269 | ** The sqlite3_get_table() interface is implemented as a wrapper around |
||
2270 | ** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access |
||
2271 | ** to any internal data structures of SQLite. It uses only the public |
||
2272 | ** interface defined here. As a consequence, errors that occur in the |
||
2273 | ** wrapper layer outside of the internal [sqlite3_exec()] call are not |
||
2274 | ** reflected in subsequent calls to [sqlite3_errcode()] or |
||
2275 | ** [sqlite3_errmsg()]. |
||
2276 | */ |
||
2277 | //SQLITE_API int sqlite3_get_table( |
||
2278 | // sqlite3 db, /* An open database */ |
||
2279 | // string zSql, /* SQL to be evaluated */ |
||
2280 | // char ***pazResult, /* Results of the query */ |
||
2281 | // int *pnRow, /* Number of result rows written here */ |
||
2282 | // int *pnColumn, /* Number of result columns written here */ |
||
2283 | // char **pzErrmsg /* Error msg written here */ |
||
2284 | //); |
||
2285 | //SQLITE_API void sqlite3_free_table(char **result); |
||
2286 | |||
2287 | /* |
||
2288 | ** CAPI3REF: Formatted String Printing Functions |
||
2289 | ** |
||
2290 | ** These routines are work-alikes of the "printf()" family of functions |
||
2291 | ** from the standard C library. |
||
2292 | ** |
||
2293 | ** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their |
||
2294 | ** results into memory obtained from [sqlite3_malloc()]. |
||
2295 | ** The strings returned by these two routines should be |
||
2296 | ** released by [sqlite3_free()]. ^Both routines return a |
||
2297 | ** NULL pointer if [sqlite3_malloc()] is unable to allocate enough |
||
2298 | ** memory to hold the resulting string. |
||
2299 | ** |
||
2300 | ** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from |
||
2301 | ** the standard C library. The result is written into the |
||
2302 | ** buffer supplied as the second parameter whose size is given by |
||
2303 | ** the first parameter. Note that the order of the |
||
2304 | ** first two parameters is reversed from snprintf().)^ This is an |
||
2305 | ** historical accident that cannot be fixed without breaking |
||
2306 | ** backwards compatibility. ^(Note also that sqlite3_snprintf() |
||
2307 | ** returns a pointer to its buffer instead of the number of |
||
2308 | ** characters actually written into the buffer.)^ We admit that |
||
2309 | ** the number of characters written would be a more useful return |
||
2310 | ** value but we cannot change the implementation of sqlite3_snprintf() |
||
2311 | ** now without breaking compatibility. |
||
2312 | ** |
||
2313 | ** ^As long as the buffer size is greater than zero, sqlite3_snprintf() |
||
2314 | ** guarantees that the buffer is always zero-terminated. ^The first |
||
2315 | ** parameter "n" is the total size of the buffer, including space for |
||
2316 | ** the zero terminator. So the longest string that can be completely |
||
2317 | ** written will be n-1 characters. |
||
2318 | ** |
||
2319 | ** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf(). |
||
2320 | ** |
||
2321 | ** These routines all implement some additional formatting |
||
2322 | ** options that are useful for constructing SQL statements. |
||
2323 | ** All of the usual printf() formatting options apply. In addition, there |
||
2324 | ** is are "%q", "%Q", and "%z" options. |
||
2325 | ** |
||
2326 | ** ^(The %q option works like %s in that it substitutes a null-terminated |
||
2327 | ** string from the argument list. But %q also doubles every '\'' character. |
||
2328 | ** %q is designed for use inside a string literal.)^ By doubling each '\'' |
||
2329 | ** character it escapes that character and allows it to be inserted into |
||
2330 | ** the string. |
||
2331 | ** |
||
2332 | ** For example, assume the string variable zText contains text as follows: |
||
2333 | ** |
||
2334 | ** <blockquote><pre> |
||
2335 | ** string zText = "It's a happy day!"; |
||
2336 | ** </pre></blockquote> |
||
2337 | ** |
||
2338 | ** One can use this text in an SQL statement as follows: |
||
2339 | ** |
||
2340 | ** <blockquote><pre> |
||
2341 | ** string zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText); |
||
2342 | ** sqlite3_exec(db, zSQL, 0, 0, 0); |
||
2343 | ** sqlite3_free(zSQL); |
||
2344 | ** </pre></blockquote> |
||
2345 | ** |
||
2346 | ** Because the %q format string is used, the '\'' character in zText |
||
2347 | ** is escaped and the SQL generated is as follows: |
||
2348 | ** |
||
2349 | ** <blockquote><pre> |
||
2350 | ** INSERT INTO table1 VALUES('It''s a happy day!') |
||
2351 | ** </pre></blockquote> |
||
2352 | ** |
||
2353 | ** This is correct. Had we used %s instead of %q, the generated SQL |
||
2354 | ** would have looked like this: |
||
2355 | ** |
||
2356 | ** <blockquote><pre> |
||
2357 | ** INSERT INTO table1 VALUES('It's a happy day!'); |
||
2358 | ** </pre></blockquote> |
||
2359 | ** |
||
2360 | ** This second example is an SQL syntax error. As a general rule you should |
||
2361 | ** always use %q instead of %s when inserting text into a string literal. |
||
2362 | ** |
||
2363 | ** ^(The %Q option works like %q except it also adds single quotes around |
||
2364 | ** the outside of the total string. Additionally, if the parameter in the |
||
2365 | ** argument list is a NULL pointer, %Q substitutes the text "NULL" (without |
||
2366 | ** single quotes).)^ So, for example, one could say: |
||
2367 | ** |
||
2368 | ** <blockquote><pre> |
||
2369 | ** string zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText); |
||
2370 | ** sqlite3_exec(db, zSQL, 0, 0, 0); |
||
2371 | ** sqlite3_free(zSQL); |
||
2372 | ** </pre></blockquote> |
||
2373 | ** |
||
2374 | ** The code above will render a correct SQL statement in the zSQL |
||
2375 | ** variable even if the zText variable is a NULL pointer. |
||
2376 | ** |
||
2377 | ** ^(The "%z" formatting option works like "%s" but with the |
||
2378 | ** addition that after the string has been read and copied into |
||
2379 | ** the result, [sqlite3_free()] is called on the input string.)^ |
||
2380 | */ |
||
2381 | //SQLITE_API char *sqlite3_mprintf(const char*,...); |
||
2382 | //SQLITE_API char *sqlite3_vmprintf(const char*, va_list); |
||
2383 | //SQLITE_API char *sqlite3_snprintf(int,char*,const char*, ...); |
||
2384 | //SQLITE_API char *sqlite3_vsnprintf(int,char*,const char*, va_list); |
||
2385 | |||
2386 | |||
2387 | /* |
||
2388 | ** CAPI3REF: Memory Allocation Subsystem |
||
2389 | ** |
||
2390 | ** The SQLite core uses these three routines for all of its own |
||
2391 | ** internal memory allocation needs. "Core" in the previous sentence |
||
2392 | ** does not include operating-system specific VFS implementation. The |
||
2393 | ** Windows VFS uses native malloc() and free() for some operations. |
||
2394 | ** |
||
2395 | ** ^The sqlite3_malloc() routine returns a pointer to a block |
||
2396 | ** of memory at least N bytes in length, where N is the parameter. |
||
2397 | ** ^If sqlite3_malloc() is unable to obtain sufficient free |
||
2398 | ** memory, it returns a NULL pointer. ^If the parameter N to |
||
2399 | ** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns |
||
2400 | ** a NULL pointer. |
||
2401 | ** |
||
2402 | ** ^Calling sqlite3_free() with a pointer previously returned |
||
2403 | ** by sqlite3_malloc() or sqlite3_realloc() releases that memory so |
||
2404 | ** that it might be reused. ^The sqlite3_free() routine is |
||
2405 | ** a no-op if is called with a NULL pointer. Passing a NULL pointer |
||
2406 | ** to sqlite3_free() is harmless. After being freed, memory |
||
2407 | ** should neither be read nor written. Even reading previously freed |
||
2408 | ** memory might result in a segmentation fault or other severe error. |
||
2409 | ** Memory corruption, a segmentation fault, or other severe error |
||
2410 | ** might result if sqlite3_free() is called with a non-NULL pointer that |
||
2411 | ** was not obtained from sqlite3_malloc() or sqlite3_realloc(). |
||
2412 | ** |
||
2413 | ** ^(The sqlite3_realloc() interface attempts to resize a |
||
2414 | ** prior memory allocation to be at least N bytes, where N is the |
||
2415 | ** second parameter. The memory allocation to be resized is the first |
||
2416 | ** parameter.)^ ^ If the first parameter to sqlite3_realloc() |
||
2417 | ** is a NULL pointer then its behavior is identical to calling |
||
2418 | ** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc(). |
||
2419 | ** ^If the second parameter to sqlite3_realloc() is zero or |
||
2420 | ** negative then the behavior is exactly the same as calling |
||
2421 | ** sqlite3_free(P) where P is the first parameter to sqlite3_realloc(). |
||
2422 | ** ^sqlite3_realloc() returns a pointer to a memory allocation |
||
2423 | ** of at least N bytes in size or NULL if sufficient memory is unavailable. |
||
2424 | ** ^If M is the size of the prior allocation, then min(N,M) bytes |
||
2425 | ** of the prior allocation are copied into the beginning of buffer returned |
||
2426 | ** by sqlite3_realloc() and the prior allocation is freed. |
||
2427 | ** ^If sqlite3_realloc() returns NULL, then the prior allocation |
||
2428 | ** is not freed. |
||
2429 | ** |
||
2430 | ** ^The memory returned by sqlite3_malloc() and sqlite3_realloc() |
||
2431 | ** is always aligned to at least an 8 byte boundary, or to a |
||
2432 | ** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time |
||
2433 | ** option is used. |
||
2434 | ** |
||
2435 | ** In SQLite version 3.5.0 and 3.5.1, it was possible to define |
||
2436 | ** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in |
||
2437 | ** implementation of these routines to be omitted. That capability |
||
2438 | ** is no longer provided. Only built-in memory allocators can be used. |
||
2439 | ** |
||
2440 | ** The Windows OS interface layer calls |
||
2441 | ** the system malloc() and free() directly when converting |
||
2442 | ** filenames between the UTF-8 encoding used by SQLite |
||
2443 | ** and whatever filename encoding is used by the particular Windows |
||
2444 | ** installation. Memory allocation errors are detected, but |
||
2445 | ** they are reported back as [SQLITE_CANTOPEN] or |
||
2446 | ** [SQLITE_IOERR] rather than [SQLITE_NOMEM]. |
||
2447 | ** |
||
2448 | ** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()] |
||
2449 | ** must be either NULL or else pointers obtained from a prior |
||
2450 | ** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have |
||
2451 | ** not yet been released. |
||
2452 | ** |
||
2453 | ** The application must not read or write any part of |
||
2454 | ** a block of memory after it has been released using |
||
2455 | ** [sqlite3_free()] or [sqlite3_realloc()]. |
||
2456 | */ |
||
2457 | //SQLITE_API void *sqlite3_malloc(int); |
||
2458 | //SQLITE_API void *sqlite3_realloc(void*, int); |
||
2459 | //SQLITE_API void sqlite3_free(void); |
||
2460 | |||
2461 | /* |
||
2462 | ** CAPI3REF: Memory Allocator Statistics |
||
2463 | ** |
||
2464 | ** SQLite provides these two interfaces for reporting on the status |
||
2465 | ** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()] |
||
2466 | ** routines, which form the built-in memory allocation subsystem. |
||
2467 | ** |
||
2468 | ** ^The [sqlite3_memory_used()] routine returns the number of bytes |
||
2469 | ** of memory currently outstanding (malloced but not freed). |
||
2470 | ** ^The [sqlite3_memory_highwater()] routine returns the maximum |
||
2471 | ** value of [sqlite3_memory_used()] since the high-water mark |
||
2472 | ** was last reset. ^The values returned by [sqlite3_memory_used()] and |
||
2473 | ** [sqlite3_memory_highwater()] include any overhead |
||
2474 | ** added by SQLite in its implementation of [sqlite3_malloc()], |
||
2475 | ** but not overhead added by the any underlying system library |
||
2476 | ** routines that [sqlite3_malloc()] may call. |
||
2477 | ** |
||
2478 | ** ^The memory high-water mark is reset to the current value of |
||
2479 | ** [sqlite3_memory_used()] if and only if the parameter to |
||
2480 | ** [sqlite3_memory_highwater()] is true. ^The value returned |
||
2481 | ** by [sqlite3_memory_highwater(1)] is the high-water mark |
||
2482 | ** prior to the reset. |
||
2483 | */ |
||
2484 | //SQLITE_API sqlite3_int64 sqlite3_memory_used(void); |
||
2485 | //SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag); |
||
2486 | |||
2487 | /* |
||
2488 | ** CAPI3REF: Pseudo-Random Number Generator |
||
2489 | ** |
||
2490 | ** SQLite contains a high-quality pseudo-random number generator (PRNG) used to |
||
2491 | ** select random [ROWID | ROWIDs] when inserting new records into a table that |
||
2492 | ** already uses the largest possible [ROWID]. The PRNG is also used for |
||
2493 | ** the build-in random() and randomblob() SQL functions. This interface allows |
||
2494 | ** applications to access the same PRNG for other purposes. |
||
2495 | ** |
||
2496 | ** ^A call to this routine stores N bytes of randomness into buffer P. |
||
2497 | ** |
||
2498 | ** ^The first time this routine is invoked (either internally or by |
||
2499 | ** the application) the PRNG is seeded using randomness obtained |
||
2500 | ** from the xRandomness method of the default [sqlite3_vfs] object. |
||
2501 | ** ^On all subsequent invocations, the pseudo-randomness is generated |
||
2502 | ** internally and without recourse to the [sqlite3_vfs] xRandomness |
||
2503 | ** method. |
||
2504 | */ |
||
2505 | //SQLITE_API void sqlite3_randomness(int N, object *P); |
||
2506 | |||
2507 | /* |
||
2508 | ** CAPI3REF: Compile-Time Authorization Callbacks |
||
2509 | ** |
||
2510 | ** ^This routine registers an authorizer callback with a particular |
||
2511 | ** [database connection], supplied in the first argument. |
||
2512 | ** ^The authorizer callback is invoked as SQL statements are being compiled |
||
2513 | ** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()], |
||
2514 | ** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()]. ^At various |
||
2515 | ** points during the compilation process, as logic is being created |
||
2516 | ** to perform various actions, the authorizer callback is invoked to |
||
2517 | ** see if those actions are allowed. ^The authorizer callback should |
||
2518 | ** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the |
||
2519 | ** specific action but allow the SQL statement to continue to be |
||
2520 | ** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be |
||
2521 | ** rejected with an error. ^If the authorizer callback returns |
||
2522 | ** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY] |
||
2523 | ** then the [sqlite3_prepare_v2()] or equivalent call that triggered |
||
2524 | ** the authorizer will fail with an error message. |
||
2525 | ** |
||
2526 | ** When the callback returns [SQLITE_OK], that means the operation |
||
2527 | ** requested is ok. ^When the callback returns [SQLITE_DENY], the |
||
2528 | ** [sqlite3_prepare_v2()] or equivalent call that triggered the |
||
2529 | ** authorizer will fail with an error message explaining that |
||
2530 | ** access is denied. |
||
2531 | ** |
||
2532 | ** ^The first parameter to the authorizer callback is a copy of the third |
||
2533 | ** parameter to the sqlite3_set_authorizer() interface. ^The second parameter |
||
2534 | ** to the callback is an integer [SQLITE_COPY | action code] that specifies |
||
2535 | ** the particular action to be authorized. ^The third through sixth parameters |
||
2536 | ** to the callback are zero-terminated strings that contain additional |
||
2537 | ** details about the action to be authorized. |
||
2538 | ** |
||
2539 | ** ^If the action code is [SQLITE_READ] |
||
2540 | ** and the callback returns [SQLITE_IGNORE] then the |
||
2541 | ** [prepared statement] statement is constructed to substitute |
||
2542 | ** a NULL value in place of the table column that would have |
||
2543 | ** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE] |
||
2544 | ** return can be used to deny an untrusted user access to individual |
||
2545 | ** columns of a table. |
||
2546 | ** ^If the action code is [SQLITE_DELETE] and the callback returns |
||
2547 | ** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the |
||
2548 | ** [truncate optimization] is disabled and all rows are deleted individually. |
||
2549 | ** |
||
2550 | ** An authorizer is used when [sqlite3_prepare | preparing] |
||
2551 | ** SQL statements from an untrusted source, to ensure that the SQL statements |
||
2552 | ** do not try to access data they are not allowed to see, or that they do not |
||
2553 | ** try to execute malicious statements that damage the database. For |
||
2554 | ** example, an application may allow a user to enter arbitrary |
||
2555 | ** SQL queries for evaluation by a database. But the application does |
||
2556 | ** not want the user to be able to make arbitrary changes to the |
||
2557 | ** database. An authorizer could then be put in place while the |
||
2558 | ** user-entered SQL is being [sqlite3_prepare | prepared] that |
||
2559 | ** disallows everything except [SELECT] statements. |
||
2560 | ** |
||
2561 | ** Applications that need to process SQL from untrusted sources |
||
2562 | ** might also consider lowering resource limits using [sqlite3_limit()] |
||
2563 | ** and limiting database size using the [max_page_count] [PRAGMA] |
||
2564 | ** in addition to using an authorizer. |
||
2565 | ** |
||
2566 | ** ^(Only a single authorizer can be in place on a database connection |
||
2567 | ** at a time. Each call to sqlite3_set_authorizer overrides the |
||
2568 | ** previous call.)^ ^Disable the authorizer by installing a NULL callback. |
||
2569 | ** The authorizer is disabled by default. |
||
2570 | ** |
||
2571 | ** The authorizer callback must not do anything that will modify |
||
2572 | ** the database connection that invoked the authorizer callback. |
||
2573 | ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their |
||
2574 | ** database connections for the meaning of "modify" in this paragraph. |
||
2575 | ** |
||
2576 | ** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the |
||
2577 | ** statement might be re-prepared during [sqlite3_step()] due to a |
||
2578 | ** schema change. Hence, the application should ensure that the |
||
2579 | ** correct authorizer callback remains in place during the [sqlite3_step()]. |
||
2580 | ** |
||
2581 | ** ^Note that the authorizer callback is invoked only during |
||
2582 | ** [sqlite3_prepare()] or its variants. Authorization is not |
||
2583 | ** performed during statement evaluation in [sqlite3_step()], unless |
||
2584 | ** as stated in the previous paragraph, sqlite3_step() invokes |
||
2585 | ** sqlite3_prepare_v2() to reprepare a statement after a schema change. |
||
2586 | */ |
||
2587 | //SQLITE_API int sqlite3_set_authorizer( |
||
2588 | // sqlite3*, |
||
2589 | // int (*xAuth)(void*,int,const char*,const char*,const char*,const char), |
||
2590 | // void *pUserData |
||
2591 | //); |
||
2592 | |||
2593 | /* |
||
2594 | ** CAPI3REF: Authorizer Return Codes |
||
2595 | ** |
||
2596 | ** The [sqlite3_set_authorizer | authorizer callback function] must |
||
2597 | ** return either [SQLITE_OK] or one of these two constants in order |
||
2598 | ** to signal SQLite whether or not the action is permitted. See the |
||
2599 | ** [sqlite3_set_authorizer | authorizer documentation] for additional |
||
2600 | ** information. |
||
2601 | ** |
||
2602 | ** Note that SQLITE_IGNORE is also used as a [SQLITE_ROLLBACK | return code] |
||
2603 | ** from the [sqlite3_vtab_on_conflict()] interface. |
||
2604 | */ |
||
2605 | //#define SQLITE_DENY 1 /* Abort the SQL statement with an error */ |
||
2606 | //#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */ |
||
2607 | const int SQLITE_DENY = 1; |
||
2608 | const int SQLITE_IGNORE = 2; |
||
2609 | |||
2610 | /* |
||
2611 | ** CAPI3REF: Authorizer Action Codes |
||
2612 | ** |
||
2613 | ** The [sqlite3_set_authorizer()] interface registers a callback function |
||
2614 | ** that is invoked to authorize certain SQL statement actions. The |
||
2615 | ** second parameter to the callback is an integer code that specifies |
||
2616 | ** what action is being authorized. These are the integer action codes that |
||
2617 | ** the authorizer callback may be passed. |
||
2618 | ** |
||
2619 | ** These action code values signify what kind of operation is to be |
||
2620 | ** authorized. The 3rd and 4th parameters to the authorization |
||
2621 | ** callback function will be parameters or NULL depending on which of these |
||
2622 | ** codes is used as the second parameter. ^(The 5th parameter to the |
||
2623 | ** authorizer callback is the name of the database ("main", "temp", |
||
2624 | ** etc.) if applicable.)^ ^The 6th parameter to the authorizer callback |
||
2625 | ** is the name of the inner-most trigger or view that is responsible for |
||
2626 | ** the access attempt or NULL if this access attempt is directly from |
||
2627 | ** top-level SQL code. |
||
2628 | */ |
||
2629 | /******************************************* 3rd ************ 4th ***********/ |
||
2630 | //#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */ |
||
2631 | //#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */ |
||
2632 | //#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */ |
||
2633 | //#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */ |
||
2634 | //#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */ |
||
2635 | //#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */ |
||
2636 | //#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */ |
||
2637 | //#define SQLITE_CREATE_VIEW 8 /* View Name NULL */ |
||
2638 | //#define SQLITE_DELETE 9 /* Table Name NULL */ |
||
2639 | //#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */ |
||
2640 | //#define SQLITE_DROP_TABLE 11 /* Table Name NULL */ |
||
2641 | //#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */ |
||
2642 | //#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */ |
||
2643 | //#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */ |
||
2644 | //#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */ |
||
2645 | //#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */ |
||
2646 | //#define SQLITE_DROP_VIEW 17 /* View Name NULL */ |
||
2647 | //#define SQLITE_INSERT 18 /* Table Name NULL */ |
||
2648 | //#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */ |
||
2649 | //#define SQLITE_READ 20 /* Table Name Column Name */ |
||
2650 | //#define SQLITE_SELECT 21 /* NULL NULL */ |
||
2651 | //#define SQLITE_TRANSACTION 22 /* Operation NULL */ |
||
2652 | //#define SQLITE_UPDATE 23 /* Table Name Column Name */ |
||
2653 | //#define SQLITE_ATTACH 24 /* Filename NULL */ |
||
2654 | //#define SQLITE_DETACH 25 /* Database Name NULL */ |
||
2655 | //#define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */ |
||
2656 | //#define SQLITE_REINDEX 27 /* Index Name NULL */ |
||
2657 | //#define SQLITE_ANALYZE 28 /* Table Name NULL */ |
||
2658 | //#define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */ |
||
2659 | //#define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */ |
||
2660 | //#define SQLITE_FUNCTION 31 /* NULL Function Name */ |
||
2661 | //#define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */ |
||
2662 | //#define SQLITE_COPY 0 /* No longer used */ |
||
2663 | const int SQLITE_CREATE_INDEX = 1; |
||
2664 | const int SQLITE_CREATE_TABLE = 2; |
||
2665 | const int SQLITE_CREATE_TEMP_INDEX = 3; |
||
2666 | const int SQLITE_CREATE_TEMP_TABLE = 4; |
||
2667 | const int SQLITE_CREATE_TEMP_TRIGGER = 5; |
||
2668 | const int SQLITE_CREATE_TEMP_VIEW = 6; |
||
2669 | const int SQLITE_CREATE_TRIGGER = 7; |
||
2670 | const int SQLITE_CREATE_VIEW = 8; |
||
2671 | const int SQLITE_DELETE = 9; |
||
2672 | const int SQLITE_DROP_INDEX = 10; |
||
2673 | const int SQLITE_DROP_TABLE = 11; |
||
2674 | const int SQLITE_DROP_TEMP_INDEX = 12; |
||
2675 | const int SQLITE_DROP_TEMP_TABLE = 13; |
||
2676 | const int SQLITE_DROP_TEMP_TRIGGER = 14; |
||
2677 | const int SQLITE_DROP_TEMP_VIEW = 15; |
||
2678 | const int SQLITE_DROP_TRIGGER = 16; |
||
2679 | const int SQLITE_DROP_VIEW = 17; |
||
2680 | const int SQLITE_INSERT = 18; |
||
2681 | const int SQLITE_PRAGMA = 19; |
||
2682 | const int SQLITE_READ = 20; |
||
2683 | const int SQLITE_SELECT = 21; |
||
2684 | const int SQLITE_TRANSACTION = 22; |
||
2685 | const int SQLITE_UPDATE = 23; |
||
2686 | const int SQLITE_ATTACH = 24; |
||
2687 | const int SQLITE_DETACH = 25; |
||
2688 | const int SQLITE_ALTER_TABLE = 26; |
||
2689 | const int SQLITE_REINDEX = 27; |
||
2690 | const int SQLITE_ANALYZE = 28; |
||
2691 | const int SQLITE_CREATE_VTABLE = 29; |
||
2692 | const int SQLITE_DROP_VTABLE = 30; |
||
2693 | const int SQLITE_FUNCTION = 31; |
||
2694 | const int SQLITE_SAVEPOINT = 32; |
||
2695 | const int SQLITE_COPY = 0; |
||
2696 | |||
2697 | /* |
||
2698 | ** CAPI3REF: Tracing And Profiling Functions |
||
2699 | ** |
||
2700 | ** These routines register callback functions that can be used for |
||
2701 | ** tracing and profiling the execution of SQL statements. |
||
2702 | ** |
||
2703 | ** ^The callback function registered by sqlite3_trace() is invoked at |
||
2704 | ** various times when an SQL statement is being run by [sqlite3_step()]. |
||
2705 | ** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the |
||
2706 | ** SQL statement text as the statement first begins executing. |
||
2707 | ** ^(Additional sqlite3_trace() callbacks might occur |
||
2708 | ** as each triggered subprogram is entered. The callbacks for triggers |
||
2709 | ** contain a UTF-8 SQL comment that identifies the trigger.)^ |
||
2710 | ** |
||
2711 | ** ^The callback function registered by sqlite3_profile() is invoked |
||
2712 | ** as each SQL statement finishes. ^The profile callback contains |
||
2713 | ** the original statement text and an estimate of wall-clock time |
||
2714 | ** of how long that statement took to run. ^The profile callback |
||
2715 | ** time is in units of nanoseconds, however the current implementation |
||
2716 | ** is only capable of millisecond resolution so the six least significant |
||
2717 | ** digits in the time are meaningless. Future versions of SQLite |
||
2718 | ** might provide greater resolution on the profiler callback. The |
||
2719 | ** sqlite3_profile() function is considered experimental and is |
||
2720 | ** subject to change in future versions of SQLite. |
||
2721 | */ |
||
2722 | //SQLITE_API void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char), void); |
||
2723 | //SQLITE_API SQLITE_EXPERIMENTAL void *sqlite3_profile(sqlite3*, |
||
2724 | // void(*xProfile)(void*,const char*,sqlite3_uint64), void); |
||
2725 | |||
2726 | /* |
||
2727 | ** CAPI3REF: Query Progress Callbacks |
||
2728 | ** |
||
2729 | ** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback |
||
2730 | ** function X to be invoked periodically during long running calls to |
||
2731 | ** [sqlite3_exec()], [sqlite3_step()] and [sqlite3_get_table()] for |
||
2732 | ** database connection D. An example use for this |
||
2733 | ** interface is to keep a GUI updated during a large query. |
||
2734 | ** |
||
2735 | ** ^The parameter P is passed through as the only parameter to the |
||
2736 | ** callback function X. ^The parameter N is the number of |
||
2737 | ** [virtual machine instructions] that are evaluated between successive |
||
2738 | ** invocations of the callback X. |
||
2739 | ** |
||
2740 | ** ^Only a single progress handler may be defined at one time per |
||
2741 | ** [database connection]; setting a new progress handler cancels the |
||
2742 | ** old one. ^Setting parameter X to NULL disables the progress handler. |
||
2743 | ** ^The progress handler is also disabled by setting N to a value less |
||
2744 | ** than 1. |
||
2745 | ** |
||
2746 | ** ^If the progress callback returns non-zero, the operation is |
||
2747 | ** interrupted. This feature can be used to implement a |
||
2748 | ** "Cancel" button on a GUI progress dialog box. |
||
2749 | ** |
||
2750 | ** The progress handler callback must not do anything that will modify |
||
2751 | ** the database connection that invoked the progress handler. |
||
2752 | ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their |
||
2753 | ** database connections for the meaning of "modify" in this paragraph. |
||
2754 | ** |
||
2755 | */ |
||
2756 | //SQLITE_API void sqlite3_progress_handler(sqlite3*, int, int()(void), void); |
||
2757 | |||
2758 | /* |
||
2759 | ** CAPI3REF: Opening A New Database Connection |
||
2760 | ** |
||
2761 | ** ^These routines open an SQLite database file as specified by the |
||
2762 | ** filename argument. ^The filename argument is interpreted as UTF-8 for |
||
2763 | ** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte |
||
2764 | ** order for sqlite3_open16(). ^(A [database connection] handle is usually |
||
2765 | ** returned in *ppDb, even if an error occurs. The only exception is that |
||
2766 | ** if SQLite is unable to allocate memory to hold the [sqlite3] object, |
||
2767 | ** a NULL will be written into *ppDb instead of a pointer to the [sqlite3] |
||
2768 | ** object.)^ ^(If the database is opened (and/or created) successfully, then |
||
2769 | ** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The |
||
2770 | ** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain |
||
2771 | ** an English language description of the error following a failure of any |
||
2772 | ** of the sqlite3_open() routines. |
||
2773 | ** |
||
2774 | ** ^The default encoding for the database will be UTF-8 if |
||
2775 | ** sqlite3_open() or sqlite3_open_v2() is called and |
||
2776 | ** UTF-16 in the native byte order if sqlite3_open16() is used. |
||
2777 | ** |
||
2778 | ** Whether or not an error occurs when it is opened, resources |
||
2779 | ** associated with the [database connection] handle should be released by |
||
2780 | ** passing it to [sqlite3_close()] when it is no longer required. |
||
2781 | ** |
||
2782 | ** The sqlite3_open_v2() interface works like sqlite3_open() |
||
2783 | ** except that it accepts two additional parameters for additional control |
||
2784 | ** over the new database connection. ^(The flags parameter to |
||
2785 | ** sqlite3_open_v2() can take one of |
||
2786 | ** the following three values, optionally combined with the |
||
2787 | ** [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], [SQLITE_OPEN_SHAREDCACHE], |
||
2788 | ** [SQLITE_OPEN_PRIVATECACHE], and/or [SQLITE_OPEN_URI] flags:)^ |
||
2789 | ** |
||
2790 | ** <dl> |
||
2791 | ** ^(<dt>[SQLITE_OPEN_READONLY]</dt> |
||
2792 | ** <dd>The database is opened in read-only mode. If the database does not |
||
2793 | ** already exist, an error is returned.</dd>)^ |
||
2794 | ** |
||
2795 | ** ^(<dt>[SQLITE_OPEN_READWRITE]</dt> |
||
2796 | ** <dd>The database is opened for reading and writing if possible, or reading |
||
2797 | ** only if the file is write protected by the operating system. In either |
||
2798 | ** case the database must already exist, otherwise an error is returned.</dd>)^ |
||
2799 | ** |
||
2800 | ** ^(<dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt> |
||
2801 | ** <dd>The database is opened for reading and writing, and is created if |
||
2802 | ** it does not already exist. This is the behavior that is always used for |
||
2803 | ** sqlite3_open() and sqlite3_open16().</dd>)^ |
||
2804 | ** </dl> |
||
2805 | ** |
||
2806 | ** If the 3rd parameter to sqlite3_open_v2() is not one of the |
||
2807 | ** combinations shown above optionally combined with other |
||
2808 | ** [SQLITE_OPEN_READONLY | SQLITE_OPEN_* bits] |
||
2809 | ** then the behavior is undefined. |
||
2810 | ** |
||
2811 | ** ^If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection |
||
2812 | ** opens in the multi-thread [threading mode] as long as the single-thread |
||
2813 | ** mode has not been set at compile-time or start-time. ^If the |
||
2814 | ** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens |
||
2815 | ** in the serialized [threading mode] unless single-thread was |
||
2816 | ** previously selected at compile-time or start-time. |
||
2817 | ** ^The [SQLITE_OPEN_SHAREDCACHE] flag causes the database connection to be |
||
2818 | ** eligible to use [shared cache mode], regardless of whether or not shared |
||
2819 | ** cache is enabled using [sqlite3_enable_shared_cache()]. ^The |
||
2820 | ** [SQLITE_OPEN_PRIVATECACHE] flag causes the database connection to not |
||
2821 | ** participate in [shared cache mode] even if it is enabled. |
||
2822 | ** |
||
2823 | ** ^The fourth parameter to sqlite3_open_v2() is the name of the |
||
2824 | ** [sqlite3_vfs] object that defines the operating system interface that |
||
2825 | ** the new database connection should use. ^If the fourth parameter is |
||
2826 | ** a NULL pointer then the default [sqlite3_vfs] object is used. |
||
2827 | ** |
||
2828 | ** ^If the filename is ":memory:", then a private, temporary in-memory database |
||
2829 | ** is created for the connection. ^This in-memory database will vanish when |
||
2830 | ** the database connection is closed. Future versions of SQLite might |
||
2831 | ** make use of additional special filenames that begin with the ":" character. |
||
2832 | ** It is recommended that when a database filename actually does begin with |
||
2833 | ** a ":" character you should prefix the filename with a pathname such as |
||
2834 | ** "./" to avoid ambiguity. |
||
2835 | ** |
||
2836 | ** ^If the filename is an empty string, then a private, temporary |
||
2837 | ** on-disk database will be created. ^This private database will be |
||
2838 | ** automatically deleted as soon as the database connection is closed. |
||
2839 | ** |
||
2840 | ** [[URI filenames in sqlite3_open()]] <h3>URI Filenames</h3> |
||
2841 | ** |
||
2842 | ** ^If [URI filename] interpretation is enabled, and the filename argument |
||
2843 | ** begins with "file:", then the filename is interpreted as a URI. ^URI |
||
2844 | ** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is |
||
2845 | ** set in the fourth argument to sqlite3_open_v2(), or if it has |
||
2846 | ** been enabled globally using the [SQLITE_CONFIG_URI] option with the |
||
2847 | ** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option. |
||
2848 | ** As of SQLite version 3.7.7, URI filename interpretation is turned off |
||
2849 | ** by default, but future releases of SQLite might enable URI filename |
||
2850 | ** interpretation by default. See "[URI filenames]" for additional |
||
2851 | ** information. |
||
2852 | ** |
||
2853 | ** URI filenames are parsed according to RFC 3986. ^If the URI contains an |
||
2854 | ** authority, then it must be either an empty string or the string |
||
2855 | ** "localhost". ^If the authority is not an empty string or "localhost", an |
||
2856 | ** error is returned to the caller. ^The fragment component of a URI, if |
||
2857 | ** present, is ignored. |
||
2858 | ** |
||
2859 | ** ^SQLite uses the path component of the URI as the name of the disk file |
||
2860 | ** which contains the database. ^If the path begins with a '/' character, |
||
2861 | ** then it is interpreted as an absolute path. ^If the path does not begin |
||
2862 | ** with a '/' (meaning that the authority section is omitted from the URI) |
||
2863 | ** then the path is interpreted as a relative path. |
||
2864 | ** ^On windows, the first component of an absolute path |
||
2865 | ** is a drive specification (e.g. "C:"). |
||
2866 | ** |
||
2867 | ** [[core URI query parameters]] |
||
2868 | ** The query component of a URI may contain parameters that are interpreted |
||
2869 | ** either by SQLite itself, or by a [VFS | custom VFS implementation]. |
||
2870 | ** SQLite interprets the following three query parameters: |
||
2871 | ** |
||
2872 | ** <ul> |
||
2873 | ** <li> <b>vfs</b>: ^The "vfs" parameter may be used to specify the name of |
||
2874 | ** a VFS object that provides the operating system interface that should |
||
2875 | ** be used to access the database file on disk. ^If this option is set to |
||
2876 | ** an empty string the default VFS object is used. ^Specifying an unknown |
||
2877 | ** VFS is an error. ^If sqlite3_open_v2() is used and the vfs option is |
||
2878 | ** present, then the VFS specified by the option takes precedence over |
||
2879 | ** the value passed as the fourth parameter to sqlite3_open_v2(). |
||
2880 | ** |
||
2881 | ** <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw" or |
||
2882 | ** "rwc". Attempting to set it to any other value is an error)^. |
||
2883 | ** ^If "ro" is specified, then the database is opened for read-only |
||
2884 | ** access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the |
||
2885 | ** third argument to sqlite3_prepare_v2(). ^If the mode option is set to |
||
2886 | ** "rw", then the database is opened for read-write (but not create) |
||
2887 | ** access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had |
||
2888 | ** been set. ^Value "rwc" is equivalent to setting both |
||
2889 | ** SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE. ^If sqlite3_open_v2() is |
||
2890 | ** used, it is an error to specify a value for the mode parameter that is |
||
2891 | ** less restrictive than that specified by the flags passed as the third |
||
2892 | ** parameter. |
||
2893 | ** |
||
2894 | ** <li> <b>cache</b>: ^The cache parameter may be set to either "shared" or |
||
2895 | ** "private". ^Setting it to "shared" is equivalent to setting the |
||
2896 | ** SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to |
||
2897 | ** sqlite3_open_v2(). ^Setting the cache parameter to "private" is |
||
2898 | ** equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit. |
||
2899 | ** ^If sqlite3_open_v2() is used and the "cache" parameter is present in |
||
2900 | ** a URI filename, its value overrides any behaviour requested by setting |
||
2901 | ** SQLITE_OPEN_PRIVATECACHE or SQLITE_OPEN_SHAREDCACHE flag. |
||
2902 | ** </ul> |
||
2903 | ** |
||
2904 | ** ^Specifying an unknown parameter in the query component of a URI is not an |
||
2905 | ** error. Future versions of SQLite might understand additional query |
||
2906 | ** parameters. See "[query parameters with special meaning to SQLite]" for |
||
2907 | ** additional information. |
||
2908 | ** |
||
2909 | ** [[URI filename examples]] <h3>URI filename examples</h3> |
||
2910 | ** |
||
2911 | ** <table border="1" align=center cellpadding=5> |
||
2912 | ** <tr><th> URI filenames <th> Results |
||
2913 | ** <tr><td> file:data.db <td> |
||
2914 | ** Open the file "data.db" in the current directory. |
||
2915 | ** <tr><td> file:/home/fred/data.db<br> |
||
2916 | ** file:///home/fred/data.db <br> |
||
2917 | ** file://localhost/home/fred/data.db <br> <td> |
||
2918 | ** Open the database file "/home/fred/data.db". |
||
2919 | ** <tr><td> file://darkstar/home/fred/data.db <td> |
||
2920 | ** An error. "darkstar" is not a recognized authority. |
||
2921 | ** <tr><td style="white-space:nowrap"> |
||
2922 | ** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db |
||
2923 | ** <td> Windows only: Open the file "data.db" on fred's desktop on drive |
||
2924 | ** C:. Note that the %20 escaping in this example is not strictly |
||
2925 | ** necessary - space characters can be used literally |
||
2926 | ** in URI filenames. |
||
2927 | ** <tr><td> file:data.db?mode=ro&cache=private <td> |
||
2928 | ** Open file "data.db" in the current directory for read-only access. |
||
2929 | ** Regardless of whether or not shared-cache mode is enabled by |
||
2930 | ** default, use a private cache. |
||
2931 | ** <tr><td> file:/home/fred/data.db?vfs=unix-nolock <td> |
||
2932 | ** Open file "/home/fred/data.db". Use the special VFS "unix-nolock". |
||
2933 | ** <tr><td> file:data.db?mode=readonly <td> |
||
2934 | ** An error. "readonly" is not a valid option for the "mode" parameter. |
||
2935 | ** </table> |
||
2936 | ** |
||
2937 | ** ^URI hexadecimal escape sequences (%HH) are supported within the path and |
||
2938 | ** query components of a URI. A hexadecimal escape sequence consists of a |
||
2939 | ** percent sign - "%" - followed by exactly two hexadecimal digits |
||
2940 | ** specifying an octet value. ^Before the path or query components of a |
||
2941 | ** URI filename are interpreted, they are encoded using UTF-8 and all |
||
2942 | ** hexadecimal escape sequences replaced by a single byte containing the |
||
2943 | ** corresponding octet. If this process generates an invalid UTF-8 encoding, |
||
2944 | ** the results are undefined. |
||
2945 | ** |
||
2946 | ** <b>Note to Windows users:</b> The encoding used for the filename argument |
||
2947 | ** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever |
||
2948 | ** codepage is currently defined. Filenames containing international |
||
2949 | ** characters must be converted to UTF-8 prior to passing them into |
||
2950 | ** sqlite3_open() or sqlite3_open_v2(). |
||
2951 | */ |
||
2952 | //SQLITE_API int sqlite3_open( |
||
2953 | // string filename, /* Database filename (UTF-8) */ |
||
2954 | // sqlite3 **ppDb /* OUT: SQLite db handle */ |
||
2955 | //); |
||
2956 | //SQLITE_API int sqlite3_open16( |
||
2957 | // const void *filename, /* Database filename (UTF-16) */ |
||
2958 | // sqlite3 **ppDb /* OUT: SQLite db handle */ |
||
2959 | //); |
||
2960 | //SQLITE_API int sqlite3_open_v2( |
||
2961 | // string filename, /* Database filename (UTF-8) */ |
||
2962 | // sqlite3 **ppDb, /* OUT: SQLite db handle */ |
||
2963 | // int flags, /* Flags */ |
||
2964 | // string zVfs /* Name of VFS module to use */ |
||
2965 | //); |
||
2966 | |||
2967 | /* |
||
2968 | ** CAPI3REF: Obtain Values For URI Parameters |
||
2969 | ** |
||
2970 | ** This is a utility routine, useful to VFS implementations, that checks |
||
2971 | ** to see if a database file was a URI that contained a specific query |
||
2972 | ** parameter, and if so obtains the value of the query parameter. |
||
2973 | ** |
||
2974 | ** The zFilename argument is the filename pointer passed into the xOpen() |
||
2975 | ** method of a VFS implementation. The zParam argument is the name of the |
||
2976 | ** query parameter we seek. This routine returns the value of the zParam |
||
2977 | ** parameter if it exists. If the parameter does not exist, this routine |
||
2978 | ** returns a NULL pointer. |
||
2979 | ** |
||
2980 | ** If the zFilename argument to this function is not a pointer that SQLite |
||
2981 | ** passed into the xOpen VFS method, then the behavior of this routine |
||
2982 | ** is undefined and probably undesirable. |
||
2983 | */ |
||
2984 | //SQLITE_API string sqlite3_uri_parameter(string zFilename, string zParam); |
||
2985 | |||
2986 | |||
2987 | /* |
||
2988 | ** CAPI3REF: Error Codes And Messages |
||
2989 | ** |
||
2990 | ** ^The sqlite3_errcode() interface returns the numeric [result code] or |
||
2991 | ** [extended result code] for the most recent failed sqlite3_* API call |
||
2992 | ** associated with a [database connection]. If a prior API call failed |
||
2993 | ** but the most recent API call succeeded, the return value from |
||
2994 | ** sqlite3_errcode() is undefined. ^The sqlite3_extended_errcode() |
||
2995 | ** interface is the same except that it always returns the |
||
2996 | ** [extended result code] even when extended result codes are |
||
2997 | ** disabled. |
||
2998 | ** |
||
2999 | ** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language |
||
3000 | ** text that describes the error, as either UTF-8 or UTF-16 respectively. |
||
3001 | ** ^(Memory to hold the error message string is managed internally. |
||
3002 | ** The application does not need to worry about freeing the result. |
||
3003 | ** However, the error string might be overwritten or deallocated by |
||
3004 | ** subsequent calls to other SQLite interface functions.)^ |
||
3005 | ** |
||
3006 | ** When the serialized [threading mode] is in use, it might be the |
||
3007 | ** case that a second error occurs on a separate thread in between |
||
3008 | ** the time of the first error and the call to these interfaces. |
||
3009 | ** When that happens, the second error will be reported since these |
||
3010 | ** interfaces always report the most recent result. To avoid |
||
3011 | ** this, each thread can obtain exclusive use of the [database connection] D |
||
3012 | ** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning |
||
3013 | ** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after |
||
3014 | ** all calls to the interfaces listed here are completed. |
||
3015 | ** |
||
3016 | ** If an interface fails with SQLITE_MISUSE, that means the interface |
||
3017 | ** was invoked incorrectly by the application. In that case, the |
||
3018 | ** error code and message may or may not be set. |
||
3019 | */ |
||
3020 | //SQLITE_API int sqlite3_errcode(sqlite3 db); |
||
3021 | //SQLITE_API int sqlite3_extended_errcode(sqlite3 db); |
||
3022 | //SQLITE_API string sqlite3_errmsg(sqlite3); |
||
3023 | //SQLITE_API const void *sqlite3_errmsg16(sqlite3); |
||
3024 | |||
3025 | /* |
||
3026 | ** CAPI3REF: SQL Statement Object |
||
3027 | ** KEYWORDS: {prepared statement} {prepared statements} |
||
3028 | ** |
||
3029 | ** An instance of this object represents a single SQL statement. |
||
3030 | ** This object is variously known as a "prepared statement" or a |
||
3031 | ** "compiled SQL statement" or simply as a "statement". |
||
3032 | ** |
||
3033 | ** The life of a statement object goes something like this: |
||
3034 | ** |
||
3035 | ** <ol> |
||
3036 | ** <li> Create the object using [sqlite3_prepare_v2()] or a related |
||
3037 | ** function. |
||
3038 | ** <li> Bind values to [host parameters] using the sqlite3_bind_*() |
||
3039 | ** interfaces. |
||
3040 | ** <li> Run the SQL by calling [sqlite3_step()] one or more times. |
||
3041 | ** <li> Reset the statement using [sqlite3_reset()] then go back |
||
3042 | ** to step 2. Do this zero or more times. |
||
3043 | ** <li> Destroy the object using [sqlite3_finalize()]. |
||
3044 | ** </ol> |
||
3045 | ** |
||
3046 | ** Refer to documentation on individual methods above for additional |
||
3047 | ** information. |
||
3048 | */ |
||
3049 | //typedef struct sqlite3_stmt sqlite3_stmt; |
||
3050 | |||
3051 | /* |
||
3052 | ** CAPI3REF: Run-time Limits |
||
3053 | ** |
||
3054 | ** ^(This interface allows the size of various constructs to be limited |
||
3055 | ** on a connection by connection basis. The first parameter is the |
||
3056 | ** [database connection] whose limit is to be set or queried. The |
||
3057 | ** second parameter is one of the [limit categories] that define a |
||
3058 | ** class of constructs to be size limited. The third parameter is the |
||
3059 | ** new limit for that construct.)^ |
||
3060 | ** |
||
3061 | ** ^If the new limit is a negative number, the limit is unchanged. |
||
3062 | ** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a |
||
3063 | ** [limits | hard upper bound] |
||
3064 | ** set at compile-time by a C preprocessor macro called |
||
3065 | ** [limits | SQLITE_MAX_<i>NAME</i>]. |
||
3066 | ** (The "_LIMIT_" in the name is changed to "_MAX_".))^ |
||
3067 | ** ^Attempts to increase a limit above its hard upper bound are |
||
3068 | ** silently truncated to the hard upper bound. |
||
3069 | ** |
||
3070 | ** ^Regardless of whether or not the limit was changed, the |
||
3071 | ** [sqlite3_limit()] interface returns the prior value of the limit. |
||
3072 | ** ^Hence, to find the current value of a limit without changing it, |
||
3073 | ** simply invoke this interface with the third parameter set to -1. |
||
3074 | ** |
||
3075 | ** Run-time limits are intended for use in applications that manage |
||
3076 | ** both their own internal database and also databases that are controlled |
||
3077 | ** by untrusted external sources. An example application might be a |
||
3078 | ** web browser that has its own databases for storing history and |
||
3079 | ** separate databases controlled by JavaScript applications downloaded |
||
3080 | ** off the Internet. The internal databases can be given the |
||
3081 | ** large, default limits. Databases managed by external sources can |
||
3082 | ** be given much smaller limits designed to prevent a denial of service |
||
3083 | ** attack. Developers might also want to use the [sqlite3_set_authorizer()] |
||
3084 | ** interface to further control untrusted SQL. The size of the database |
||
3085 | ** created by an untrusted script can be contained using the |
||
3086 | ** [max_page_count] [PRAGMA]. |
||
3087 | ** |
||
3088 | ** New run-time limit categories may be added in future releases. |
||
3089 | */ |
||
3090 | //SQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal); |
||
3091 | |||
3092 | /* |
||
3093 | ** CAPI3REF: Run-Time Limit Categories |
||
3094 | ** KEYWORDS: {limit category} {*limit categories} |
||
3095 | ** |
||
3096 | ** These constants define various performance limits |
||
3097 | ** that can be lowered at run-time using [sqlite3_limit()]. |
||
3098 | ** The synopsis of the meanings of the various limits is shown below. |
||
3099 | ** Additional information is available at [limits | Limits in SQLite]. |
||
3100 | ** |
||
3101 | ** <dl> |
||
3102 | ** [[SQLITE_LIMIT_LENGTH]] ^(<dt>SQLITE_LIMIT_LENGTH</dt> |
||
3103 | ** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^ |
||
3104 | ** |
||
3105 | ** [[SQLITE_LIMIT_SQL_LENGTH]] ^(<dt>SQLITE_LIMIT_SQL_LENGTH</dt> |
||
3106 | ** <dd>The maximum length of an SQL statement, in bytes.</dd>)^ |
||
3107 | ** |
||
3108 | ** [[SQLITE_LIMIT_COLUMN]] ^(<dt>SQLITE_LIMIT_COLUMN</dt> |
||
3109 | ** <dd>The maximum number of columns in a table definition or in the |
||
3110 | ** result set of a [SELECT] or the maximum number of columns in an index |
||
3111 | ** or in an ORDER BY or GROUP BY clause.</dd>)^ |
||
3112 | ** |
||
3113 | ** [[SQLITE_LIMIT_EXPR_DEPTH]] ^(<dt>SQLITE_LIMIT_EXPR_DEPTH</dt> |
||
3114 | ** <dd>The maximum depth of the parse tree on any expression.</dd>)^ |
||
3115 | ** |
||
3116 | ** [[SQLITE_LIMIT_COMPOUND_SELECT]] ^(<dt>SQLITE_LIMIT_COMPOUND_SELECT</dt> |
||
3117 | ** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^ |
||
3118 | ** |
||
3119 | ** [[SQLITE_LIMIT_VDBE_OP]] ^(<dt>SQLITE_LIMIT_VDBE_OP</dt> |
||
3120 | ** <dd>The maximum number of instructions in a virtual machine program |
||
3121 | ** used to implement an SQL statement. This limit is not currently |
||
3122 | ** enforced, though that might be added in some future release of |
||
3123 | ** SQLite.</dd>)^ |
||
3124 | ** |
||
3125 | ** [[SQLITE_LIMIT_FUNCTION_ARG]] ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt> |
||
3126 | ** <dd>The maximum number of arguments on a function.</dd>)^ |
||
3127 | ** |
||
3128 | ** [[SQLITE_LIMIT_ATTACHED]] ^(<dt>SQLITE_LIMIT_ATTACHED</dt> |
||
3129 | ** <dd>The maximum number of [ATTACH | attached databases].)^</dd> |
||
3130 | ** |
||
3131 | ** [[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]] |
||
3132 | ** ^(<dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt> |
||
3133 | ** <dd>The maximum length of the pattern argument to the [LIKE] or |
||
3134 | ** [GLOB] operators.</dd>)^ |
||
3135 | ** |
||
3136 | ** [[SQLITE_LIMIT_VARIABLE_NUMBER]] |
||
3137 | ** ^(<dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt> |
||
3138 | ** <dd>The maximum index number of any [parameter] in an SQL statement.)^ |
||
3139 | ** |
||
3140 | ** [[SQLITE_LIMIT_TRIGGER_DEPTH]] ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt> |
||
3141 | ** <dd>The maximum depth of recursion for triggers.</dd>)^ |
||
3142 | ** </dl> |
||
3143 | */ |
||
3144 | //#define SQLITE_LIMIT_LENGTH 0 |
||
3145 | //#define SQLITE_LIMIT_SQL_LENGTH 1 |
||
3146 | //#define SQLITE_LIMIT_COLUMN 2 |
||
3147 | //#define SQLITE_LIMIT_EXPR_DEPTH 3 |
||
3148 | //#define SQLITE_LIMIT_COMPOUND_SELECT 4 |
||
3149 | //#define SQLITE_LIMIT_VDBE_OP 5 |
||
3150 | //#define SQLITE_LIMIT_FUNCTION_ARG 6 |
||
3151 | //#define SQLITE_LIMIT_ATTACHED 7 |
||
3152 | //#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8 |
||
3153 | //#define SQLITE_LIMIT_VARIABLE_NUMBER 9 |
||
3154 | //#define SQLITE_LIMIT_TRIGGER_DEPTH 10 |
||
3155 | const int SQLITE_LIMIT_LENGTH = 0; |
||
3156 | const int SQLITE_LIMIT_SQL_LENGTH = 1; |
||
3157 | const int SQLITE_LIMIT_COLUMN = 2; |
||
3158 | const int SQLITE_LIMIT_EXPR_DEPTH = 3; |
||
3159 | const int SQLITE_LIMIT_COMPOUND_SELECT = 4; |
||
3160 | const int SQLITE_LIMIT_VDBE_OP = 5; |
||
3161 | const int SQLITE_LIMIT_FUNCTION_ARG = 6; |
||
3162 | const int SQLITE_LIMIT_ATTACHED = 7; |
||
3163 | const int SQLITE_LIMIT_LIKE_PATTERN_LENGTH = 8; |
||
3164 | const int SQLITE_LIMIT_VARIABLE_NUMBER = 9; |
||
3165 | const int SQLITE_LIMIT_TRIGGER_DEPTH = 10; |
||
3166 | |||
3167 | /* |
||
3168 | ** CAPI3REF: Compiling An SQL Statement |
||
3169 | ** KEYWORDS: {SQL statement compiler} |
||
3170 | ** |
||
3171 | ** To execute an SQL query, it must first be compiled into a byte-code |
||
3172 | ** program using one of these routines. |
||
3173 | ** |
||
3174 | ** The first argument, "db", is a [database connection] obtained from a |
||
3175 | ** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or |
||
3176 | ** [sqlite3_open16()]. The database connection must not have been closed. |
||
3177 | ** |
||
3178 | ** The second argument, "zSql", is the statement to be compiled, encoded |
||
3179 | ** as either UTF-8 or UTF-16. The sqlite3_prepare() and sqlite3_prepare_v2() |
||
3180 | ** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2() |
||
3181 | ** use UTF-16. |
||
3182 | ** |
||
3183 | ** ^If the nByte argument is less than zero, then zSql is read up to the |
||
3184 | ** first zero terminator. ^If nByte is non-negative, then it is the maximum |
||
3185 | ** number of bytes read from zSql. ^When nByte is non-negative, the |
||
3186 | ** zSql string ends at either the first '\000' or '\u0000' character or |
||
3187 | ** the nByte-th byte, whichever comes first. If the caller knows |
||
3188 | ** that the supplied string is nul-terminated, then there is a small |
||
3189 | ** performance advantage to be gained by passing an nByte parameter that |
||
3190 | ** is equal to the number of bytes in the input string <i>including</i> |
||
3191 | ** the nul-terminator bytes. |
||
3192 | ** |
||
3193 | ** ^If pzTail is not NULL then *pzTail is made to point to the first byte |
||
3194 | ** past the end of the first SQL statement in zSql. These routines only |
||
3195 | ** compile the first statement in zSql, so *pzTail is left pointing to |
||
3196 | ** what remains uncompiled. |
||
3197 | ** |
||
3198 | ** ^*ppStmt is left pointing to a compiled [prepared statement] that can be |
||
3199 | ** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set |
||
3200 | ** to NULL. ^If the input text contains no SQL (if the input is an empty |
||
3201 | ** string or a comment) then *ppStmt is set to NULL. |
||
3202 | ** The calling procedure is responsible for deleting the compiled |
||
3203 | ** SQL statement using [sqlite3_finalize()] after it has finished with it. |
||
3204 | ** ppStmt may not be NULL. |
||
3205 | ** |
||
3206 | ** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK]; |
||
3207 | ** otherwise an [error code] is returned. |
||
3208 | ** |
||
3209 | ** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are |
||
3210 | ** recommended for all new programs. The two older interfaces are retained |
||
3211 | ** for backwards compatibility, but their use is discouraged. |
||
3212 | ** ^In the "v2" interfaces, the prepared statement |
||
3213 | ** that is returned (the [sqlite3_stmt] object) contains a copy of the |
||
3214 | ** original SQL text. This causes the [sqlite3_step()] interface to |
||
3215 | ** behave differently in three ways: |
||
3216 | ** |
||
3217 | ** <ol> |
||
3218 | ** <li> |
||
3219 | ** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it |
||
3220 | ** always used to do, [sqlite3_step()] will automatically recompile the SQL |
||
3221 | ** statement and try to run it again. |
||
3222 | ** </li> |
||
3223 | ** |
||
3224 | ** <li> |
||
3225 | ** ^When an error occurs, [sqlite3_step()] will return one of the detailed |
||
3226 | ** [error codes] or [extended error codes]. ^The legacy behavior was that |
||
3227 | ** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code |
||
3228 | ** and the application would have to make a second call to [sqlite3_reset()] |
||
3229 | ** in order to find the underlying cause of the problem. With the "v2" prepare |
||
3230 | ** interfaces, the underlying reason for the error is returned immediately. |
||
3231 | ** </li> |
||
3232 | ** |
||
3233 | ** <li> |
||
3234 | ** ^If the specific value bound to [parameter | host parameter] in the |
||
3235 | ** WHERE clause might influence the choice of query plan for a statement, |
||
3236 | ** then the statement will be automatically recompiled, as if there had been |
||
3237 | ** a schema change, on the first [sqlite3_step()] call following any change |
||
3238 | ** to the [sqlite3_bind_text | bindings] of that [parameter]. |
||
3239 | ** ^The specific value of WHERE-clause [parameter] might influence the |
||
3240 | ** choice of query plan if the parameter is the left-hand side of a [LIKE] |
||
3241 | ** or [GLOB] operator or if the parameter is compared to an indexed column |
||
3242 | ** and the [SQLITE_ENABLE_STAT2] compile-time option is enabled. |
||
3243 | ** the |
||
3244 | ** </li> |
||
3245 | ** </ol> |
||
3246 | */ |
||
3247 | //SQLITE_API int sqlite3_prepare( |
||
3248 | // sqlite3 db, /* Database handle */ |
||
3249 | // string zSql, /* SQL statement, UTF-8 encoded */ |
||
3250 | // int nByte, /* Maximum length of zSql in bytes. */ |
||
3251 | // sqlite3_stmt **ppStmt, /* OUT: Statement handle */ |
||
3252 | // string *pzTail /* OUT: Pointer to unused portion of zSql */ |
||
3253 | //); |
||
3254 | //SQLITE_API int sqlite3_prepare_v2( |
||
3255 | // sqlite3 db, /* Database handle */ |
||
3256 | // string zSql, /* SQL statement, UTF-8 encoded */ |
||
3257 | // int nByte, /* Maximum length of zSql in bytes. */ |
||
3258 | // sqlite3_stmt **ppStmt, /* OUT: Statement handle */ |
||
3259 | // string *pzTail /* OUT: Pointer to unused portion of zSql */ |
||
3260 | //); |
||
3261 | //SQLITE_API int sqlite3_prepare16( |
||
3262 | // sqlite3 db, /* Database handle */ |
||
3263 | // string zSql, /* SQL statement, UTF-16 encoded */ |
||
3264 | // int nByte, /* Maximum length of zSql in bytes. */ |
||
3265 | // sqlite3_stmt **ppStmt, /* OUT: Statement handle */ |
||
3266 | // const void **pzTail /* OUT: Pointer to unused portion of zSql */ |
||
3267 | //); |
||
3268 | //SQLITE_API int sqlite3_prepare16_v2( |
||
3269 | // sqlite3 db, /* Database handle */ |
||
3270 | // string zSql, /* SQL statement, UTF-16 encoded */ |
||
3271 | // int nByte, /* Maximum length of zSql in bytes. */ |
||
3272 | // sqlite3_stmt **ppStmt, /* OUT: Statement handle */ |
||
3273 | // const void **pzTail /* OUT: Pointer to unused portion of zSql */ |
||
3274 | //); |
||
3275 | |||
3276 | /* |
||
3277 | ** CAPI3REF: Retrieving Statement SQL |
||
3278 | ** |
||
3279 | ** ^This interface can be used to retrieve a saved copy of the original |
||
3280 | ** SQL text used to create a [prepared statement] if that statement was |
||
3281 | ** compiled using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()]. |
||
3282 | */ |
||
3283 | //SQLITE_API string sqlite3_sql(sqlite3_stmt *pStmt); |
||
3284 | |||
3285 | /* |
||
3286 | ** CAPI3REF: Determine If An SQL Statement Writes The Database |
||
3287 | ** |
||
3288 | ** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if |
||
3289 | ** and only if the [prepared statement] X makes no direct changes to |
||
3290 | ** the content of the database file. |
||
3291 | ** |
||
3292 | ** Note that [application-defined SQL functions] or |
||
3293 | ** [virtual tables] might change the database indirectly as a side effect. |
||
3294 | ** ^(For example, if an application defines a function "eval()" that |
||
3295 | ** calls [sqlite3_exec()], then the following SQL statement would |
||
3296 | ** change the database file through side-effects: |
||
3297 | ** |
||
3298 | ** <blockquote><pre> |
||
3299 | ** SELECT eval('DELETE FROM t1') FROM t2; |
||
3300 | ** </pre></blockquote> |
||
3301 | ** |
||
3302 | ** But because the [SELECT] statement does not change the database file |
||
3303 | ** directly, sqlite3_stmt_readonly() would still return true.)^ |
||
3304 | ** |
||
3305 | ** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK], |
||
3306 | ** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true, |
||
3307 | ** since the statements themselves do not actually modify the database but |
||
3308 | ** rather they control the timing of when other statements modify the |
||
3309 | ** database. ^The [ATTACH] and [DETACH] statements also cause |
||
3310 | ** sqlite3_stmt_readonly() to return true since, while those statements |
||
3311 | ** change the configuration of a database connection, they do not make |
||
3312 | ** changes to the content of the database files on disk. |
||
3313 | */ |
||
3314 | //SQLITE_API int sqlite3_stmt_readonly(sqlite3_stmt *pStmt); |
||
3315 | |||
3316 | /* |
||
3317 | ** CAPI3REF: Dynamically Typed Value Object |
||
3318 | ** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value} |
||
3319 | ** |
||
3320 | ** SQLite uses the sqlite3_value object to represent all values |
||
3321 | ** that can be stored in a database table. SQLite uses dynamic typing |
||
3322 | ** for the values it stores. ^Values stored in sqlite3_value objects |
||
3323 | ** can be integers, floating point values, strings, BLOBs, or NULL. |
||
3324 | ** |
||
3325 | ** An sqlite3_value object may be either "protected" or "unprotected". |
||
3326 | ** Some interfaces require a protected sqlite3_value. Other interfaces |
||
3327 | ** will accept either a protected or an unprotected sqlite3_value. |
||
3328 | ** Every interface that accepts sqlite3_value arguments specifies |
||
3329 | ** whether or not it requires a protected sqlite3_value. |
||
3330 | ** |
||
3331 | ** The terms "protected" and "unprotected" refer to whether or not |
||
3332 | ** a mutex is held. An internal mutex is held for a protected |
||
3333 | ** sqlite3_value object but no mutex is held for an unprotected |
||
3334 | ** sqlite3_value object. If SQLite is compiled to be single-threaded |
||
3335 | ** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0) |
||
3336 | ** or if SQLite is run in one of reduced mutex modes |
||
3337 | ** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD] |
||
3338 | ** then there is no distinction between protected and unprotected |
||
3339 | ** sqlite3_value objects and they can be used interchangeably. However, |
||
3340 | ** for maximum code portability it is recommended that applications |
||
3341 | ** still make the distinction between protected and unprotected |
||
3342 | ** sqlite3_value objects even when not strictly required. |
||
3343 | ** |
||
3344 | ** ^The sqlite3_value objects that are passed as parameters into the |
||
3345 | ** implementation of [application-defined SQL functions] are protected. |
||
3346 | ** ^The sqlite3_value object returned by |
||
3347 | ** [sqlite3_column_value()] is unprotected. |
||
3348 | ** Unprotected sqlite3_value objects may only be used with |
||
3349 | ** [sqlite3_result_value()] and [sqlite3_bind_value()]. |
||
3350 | ** The [sqlite3_value_blob | sqlite3_value_type()] family of |
||
3351 | ** interfaces require protected sqlite3_value objects. |
||
3352 | */ |
||
3353 | //typedef struct Mem sqlite3_value; |
||
3354 | |||
3355 | /* |
||
3356 | ** CAPI3REF: SQL Function Context Object |
||
3357 | ** |
||
3358 | ** The context in which an SQL function executes is stored in an |
||
3359 | ** sqlite3_context object. ^A pointer to an sqlite3_context object |
||
3360 | ** is always first parameter to [application-defined SQL functions]. |
||
3361 | ** The application-defined SQL function implementation will pass this |
||
3362 | ** pointer through into calls to [sqlite3_result_int | sqlite3_result()], |
||
3363 | ** [sqlite3_aggregate_context()], [sqlite3_user_data()], |
||
3364 | ** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()], |
||
3365 | ** and/or [sqlite3_set_auxdata()]. |
||
3366 | */ |
||
3367 | //typedef struct sqlite3_context sqlite3_context; |
||
3368 | |||
3369 | /* |
||
3370 | ** CAPI3REF: Binding Values To Prepared Statements |
||
3371 | ** KEYWORDS: {host parameter} {host parameters} {host parameter name} |
||
3372 | ** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding} |
||
3373 | ** |
||
3374 | ** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants, |
||
3375 | ** literals may be replaced by a [parameter] that matches one of following |
||
3376 | ** templates: |
||
3377 | ** |
||
3378 | ** <ul> |
||
3379 | ** <li> ? |
||
3380 | ** <li> ?NNN |
||
3381 | ** <li> :VVV |
||
3382 | ** <li> @VVV |
||
3383 | ** <li> $VVV |
||
3384 | ** </ul> |
||
3385 | ** |
||
3386 | ** In the templates above, NNN represents an integer literal, |
||
3387 | ** and VVV represents an alphanumeric identifier.)^ ^The values of these |
||
3388 | ** parameters (also called "host parameter names" or "SQL parameters") |
||
3389 | ** can be set using the sqlite3_bind_*() routines defined here. |
||
3390 | ** |
||
3391 | ** ^The first argument to the sqlite3_bind_*() routines is always |
||
3392 | ** a pointer to the [sqlite3_stmt] object returned from |
||
3393 | ** [sqlite3_prepare_v2()] or its variants. |
||
3394 | ** |
||
3395 | ** ^The second argument is the index of the SQL parameter to be set. |
||
3396 | ** ^The leftmost SQL parameter has an index of 1. ^When the same named |
||
3397 | ** SQL parameter is used more than once, second and subsequent |
||
3398 | ** occurrences have the same index as the first occurrence. |
||
3399 | ** ^The index for named parameters can be looked up using the |
||
3400 | ** [sqlite3_bind_parameter_index()] API if desired. ^The index |
||
3401 | ** for "?NNN" parameters is the value of NNN. |
||
3402 | ** ^The NNN value must be between 1 and the [sqlite3_limit()] |
||
3403 | ** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999). |
||
3404 | ** |
||
3405 | ** ^The third argument is the value to bind to the parameter. |
||
3406 | ** |
||
3407 | ** ^(In those routines that have a fourth argument, its value is the |
||
3408 | ** number of bytes in the parameter. To be clear: the value is the |
||
3409 | ** number of <u>bytes</u> in the value, not the number of characters.)^ |
||
3410 | ** ^If the fourth parameter is negative, the length of the string is |
||
3411 | ** the number of bytes up to the first zero terminator. |
||
3412 | ** |
||
3413 | ** ^The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and |
||
3414 | ** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or |
||
3415 | ** string after SQLite has finished with it. ^The destructor is called |
||
3416 | ** to dispose of the BLOB or string even if the call to sqlite3_bind_blob(), |
||
3417 | ** sqlite3_bind_text(), or sqlite3_bind_text16() fails. |
||
3418 | ** ^If the fifth argument is |
||
3419 | ** the special value [SQLITE_STATIC], then SQLite assumes that the |
||
3420 | ** information is in static, unmanaged space and does not need to be freed. |
||
3421 | ** ^If the fifth argument has the value [SQLITE_TRANSIENT], then |
||
3422 | ** SQLite makes its own private copy of the data immediately, before |
||
3423 | ** the sqlite3_bind_*() routine returns. |
||
3424 | ** |
||
3425 | ** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that |
||
3426 | ** is filled with zeroes. ^A zeroblob uses a fixed amount of memory |
||
3427 | ** (just an integer to hold its size) while it is being processed. |
||
3428 | ** Zeroblobs are intended to serve as placeholders for BLOBs whose |
||
3429 | ** content is later written using |
||
3430 | ** [sqlite3_blob_open | incremental BLOB I/O] routines. |
||
3431 | ** ^A negative value for the zeroblob results in a zero-length BLOB. |
||
3432 | ** |
||
3433 | ** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer |
||
3434 | ** for the [prepared statement] or with a prepared statement for which |
||
3435 | ** [sqlite3_step()] has been called more recently than [sqlite3_reset()], |
||
3436 | ** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_() |
||
3437 | ** routine is passed a [prepared statement] that has been finalized, the |
||
3438 | ** result is undefined and probably harmful. |
||
3439 | ** |
||
3440 | ** ^Bindings are not cleared by the [sqlite3_reset()] routine. |
||
3441 | ** ^Unbound parameters are interpreted as NULL. |
||
3442 | ** |
||
3443 | ** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an |
||
3444 | ** [error code] if anything goes wrong. |
||
3445 | ** ^[SQLITE_RANGE] is returned if the parameter |
||
3446 | ** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails. |
||
3447 | ** |
||
3448 | ** See also: [sqlite3_bind_parameter_count()], |
||
3449 | ** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()]. |
||
3450 | */ |
||
3451 | //SQLITE_API int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void()(void)); |
||
3452 | //SQLITE_API int sqlite3_bind_double(sqlite3_stmt*, int, double); |
||
3453 | //SQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int); |
||
3454 | //SQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64); |
||
3455 | //SQLITE_API int sqlite3_bind_null(sqlite3_stmt*, int); |
||
3456 | //SQLITE_API int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void()(void)); |
||
3457 | //SQLITE_API int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void()(void)); |
||
3458 | //SQLITE_API int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value); |
||
3459 | //SQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n); |
||
3460 | |||
3461 | /* |
||
3462 | ** CAPI3REF: Number Of SQL Parameters |
||
3463 | ** |
||
3464 | ** ^This routine can be used to find the number of [SQL parameters] |
||
3465 | ** in a [prepared statement]. SQL parameters are tokens of the |
||
3466 | ** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as |
||
3467 | ** placeholders for values that are [sqlite3_bind_blob | bound] |
||
3468 | ** to the parameters at a later time. |
||
3469 | ** |
||
3470 | ** ^(This routine actually returns the index of the largest (rightmost) |
||
3471 | ** parameter. For all forms except ?NNN, this will correspond to the |
||
3472 | ** number of unique parameters. If parameters of the ?NNN form are used, |
||
3473 | ** there may be gaps in the list.)^ |
||
3474 | ** |
||
3475 | ** See also: [sqlite3_bind_blob|sqlite3_bind()], |
||
3476 | ** [sqlite3_bind_parameter_name()], and |
||
3477 | ** [sqlite3_bind_parameter_index()]. |
||
3478 | */ |
||
3479 | //SQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt); |
||
3480 | |||
3481 | /* |
||
3482 | ** CAPI3REF: Name Of A Host Parameter |
||
3483 | ** |
||
3484 | ** ^The sqlite3_bind_parameter_name(P,N) interface returns |
||
3485 | ** the name of the N-th [SQL parameter] in the [prepared statement] P. |
||
3486 | ** ^(SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA" |
||
3487 | ** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA" |
||
3488 | ** respectively. |
||
3489 | ** In other words, the initial ":" or "$" or "@" or "?" |
||
3490 | ** is included as part of the name.)^ |
||
3491 | ** ^Parameters of the form "?" without a following integer have no name |
||
3492 | ** and are referred to as "nameless" or "anonymous parameters". |
||
3493 | ** |
||
3494 | ** ^The first host parameter has an index of 1, not 0. |
||
3495 | ** |
||
3496 | ** ^If the value N is out of range or if the N-th parameter is |
||
3497 | ** nameless, then NULL is returned. ^The returned string is |
||
3498 | ** always in UTF-8 encoding even if the named parameter was |
||
3499 | ** originally specified as UTF-16 in [sqlite3_prepare16()] or |
||
3500 | ** [sqlite3_prepare16_v2()]. |
||
3501 | ** |
||
3502 | ** See also: [sqlite3_bind_blob|sqlite3_bind()], |
||
3503 | ** [sqlite3_bind_parameter_count()], and |
||
3504 | ** [sqlite3_bind_parameter_index()]. |
||
3505 | */ |
||
3506 | //SQLITE_API string sqlite3_bind_parameter_name(sqlite3_stmt*, int); |
||
3507 | |||
3508 | /* |
||
3509 | ** CAPI3REF: Index Of A Parameter With A Given Name |
||
3510 | ** |
||
3511 | ** ^Return the index of an SQL parameter given its name. ^The |
||
3512 | ** index value returned is suitable for use as the second |
||
3513 | ** parameter to [sqlite3_bind_blob|sqlite3_bind()]. ^A zero |
||
3514 | ** is returned if no matching parameter is found. ^The parameter |
||
3515 | ** name must be given in UTF-8 even if the original statement |
||
3516 | ** was prepared from UTF-16 text using [sqlite3_prepare16_v2()]. |
||
3517 | ** |
||
3518 | ** See also: [sqlite3_bind_blob|sqlite3_bind()], |
||
3519 | ** [sqlite3_bind_parameter_count()], and |
||
3520 | ** [sqlite3_bind_parameter_index()]. |
||
3521 | */ |
||
3522 | //SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt*, string zName); |
||
3523 | |||
3524 | /* |
||
3525 | ** CAPI3REF: Reset All Bindings On A Prepared Statement |
||
3526 | ** |
||
3527 | ** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset |
||
3528 | ** the [sqlite3_bind_blob | bindings] on a [prepared statement]. |
||
3529 | ** ^Use this routine to reset all host parameters to NULL. |
||
3530 | */ |
||
3531 | //SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt); |
||
3532 | |||
3533 | /* |
||
3534 | ** CAPI3REF: Number Of Columns In A Result Set |
||
3535 | ** |
||
3536 | ** ^Return the number of columns in the result set returned by the |
||
3537 | ** [prepared statement]. ^This routine returns 0 if pStmt is an SQL |
||
3538 | ** statement that does not return data (for example an [UPDATE]). |
||
3539 | ** |
||
3540 | ** See also: [sqlite3_data_count()] |
||
3541 | */ |
||
3542 | //SQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt); |
||
3543 | |||
3544 | /* |
||
3545 | ** CAPI3REF: Column Names In A Result Set |
||
3546 | ** |
||
3547 | ** ^These routines return the name assigned to a particular column |
||
3548 | ** in the result set of a [SELECT] statement. ^The sqlite3_column_name() |
||
3549 | ** interface returns a pointer to a zero-terminated UTF-8 string |
||
3550 | ** and sqlite3_column_name16() returns a pointer to a zero-terminated |
||
3551 | ** UTF-16 string. ^The first parameter is the [prepared statement] |
||
3552 | ** that implements the [SELECT] statement. ^The second parameter is the |
||
3553 | ** column number. ^The leftmost column is number 0. |
||
3554 | ** |
||
3555 | ** ^The returned string pointer is valid until either the [prepared statement] |
||
3556 | ** is destroyed by [sqlite3_finalize()] or until the statement is automatically |
||
3557 | ** reprepared by the first call to [sqlite3_step()] for a particular run |
||
3558 | ** or until the next call to |
||
3559 | ** sqlite3_column_name() or sqlite3_column_name16() on the same column. |
||
3560 | ** |
||
3561 | ** ^If sqlite3_malloc() fails during the processing of either routine |
||
3562 | ** (for example during a conversion from UTF-8 to UTF-16) then a |
||
3563 | ** NULL pointer is returned. |
||
3564 | ** |
||
3565 | ** ^The name of a result column is the value of the "AS" clause for |
||
3566 | ** that column, if there is an AS clause. If there is no AS clause |
||
3567 | ** then the name of the column is unspecified and may change from |
||
3568 | ** one release of SQLite to the next. |
||
3569 | */ |
||
3570 | //SQLITE_API string sqlite3_column_name(sqlite3_stmt*, int N); |
||
3571 | //SQLITE_API const void *sqlite3_column_name16(sqlite3_stmt*, int N); |
||
3572 | |||
3573 | /* |
||
3574 | ** CAPI3REF: Source Of Data In A Query Result |
||
3575 | ** |
||
3576 | ** ^These routines provide a means to determine the database, table, and |
||
3577 | ** table column that is the origin of a particular result column in |
||
3578 | ** [SELECT] statement. |
||
3579 | ** ^The name of the database or table or column can be returned as |
||
3580 | ** either a UTF-8 or UTF-16 string. ^The _database_ routines return |
||
3581 | ** the database name, the _table_ routines return the table name, and |
||
3582 | ** the origin_ routines return the column name. |
||
3583 | ** ^The returned string is valid until the [prepared statement] is destroyed |
||
3584 | ** using [sqlite3_finalize()] or until the statement is automatically |
||
3585 | ** reprepared by the first call to [sqlite3_step()] for a particular run |
||
3586 | ** or until the same information is requested |
||
3587 | ** again in a different encoding. |
||
3588 | ** |
||
3589 | ** ^The names returned are the original un-aliased names of the |
||
3590 | ** database, table, and column. |
||
3591 | ** |
||
3592 | ** ^The first argument to these interfaces is a [prepared statement]. |
||
3593 | ** ^These functions return information about the Nth result column returned by |
||
3594 | ** the statement, where N is the second function argument. |
||
3595 | ** ^The left-most column is column 0 for these routines. |
||
3596 | ** |
||
3597 | ** ^If the Nth column returned by the statement is an expression or |
||
3598 | ** subquery and is not a column value, then all of these functions return |
||
3599 | ** NULL. ^These routine might also return NULL if a memory allocation error |
||
3600 | ** occurs. ^Otherwise, they return the name of the attached database, table, |
||
3601 | ** or column that query result column was extracted from. |
||
3602 | ** |
||
3603 | ** ^As with all other SQLite APIs, those whose names end with "16" return |
||
3604 | ** UTF-16 encoded strings and the other functions return UTF-8. |
||
3605 | ** |
||
3606 | ** ^These APIs are only available if the library was compiled with the |
||
3607 | ** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol. |
||
3608 | ** |
||
3609 | ** If two or more threads call one or more of these routines against the same |
||
3610 | ** prepared statement and column at the same time then the results are |
||
3611 | ** undefined. |
||
3612 | ** |
||
3613 | ** If two or more threads call one or more |
||
3614 | ** [sqlite3_column_database_name | column metadata interfaces] |
||
3615 | ** for the same [prepared statement] and result column |
||
3616 | ** at the same time then the results are undefined. |
||
3617 | */ |
||
3618 | //SQLITE_API string sqlite3_column_database_name(sqlite3_stmt*,int); |
||
3619 | //SQLITE_API const void *sqlite3_column_database_name16(sqlite3_stmt*,int); |
||
3620 | //SQLITE_API string sqlite3_column_table_name(sqlite3_stmt*,int); |
||
3621 | //SQLITE_API const void *sqlite3_column_table_name16(sqlite3_stmt*,int); |
||
3622 | //SQLITE_API string sqlite3_column_origin_name(sqlite3_stmt*,int); |
||
3623 | //SQLITE_API const void *sqlite3_column_origin_name16(sqlite3_stmt*,int); |
||
3624 | |||
3625 | /* |
||
3626 | ** CAPI3REF: Declared Datatype Of A Query Result |
||
3627 | ** |
||
3628 | ** ^(The first parameter is a [prepared statement]. |
||
3629 | ** If this statement is a [SELECT] statement and the Nth column of the |
||
3630 | ** returned result set of that [SELECT] is a table column (not an |
||
3631 | ** expression or subquery) then the declared type of the table |
||
3632 | ** column is returned.)^ ^If the Nth column of the result set is an |
||
3633 | ** expression or subquery, then a NULL pointer is returned. |
||
3634 | ** ^The returned string is always UTF-8 encoded. |
||
3635 | ** |
||
3636 | ** ^(For example, given the database schema: |
||
3637 | ** |
||
3638 | ** CREATE TABLE t1(c1 VARIANT); |
||
3639 | ** |
||
3640 | ** and the following statement to be compiled: |
||
3641 | ** |
||
3642 | ** SELECT c1 + 1, c1 FROM t1; |
||
3643 | ** |
||
3644 | ** this routine would return the string "VARIANT" for the second result |
||
3645 | ** column (i==1), and a NULL pointer for the first result column (i==0).)^ |
||
3646 | ** |
||
3647 | ** ^SQLite uses dynamic run-time typing. ^So just because a column |
||
3648 | ** is declared to contain a particular type does not mean that the |
||
3649 | ** data stored in that column is of the declared type. SQLite is |
||
3650 | ** strongly typed, but the typing is dynamic not static. ^Type |
||
3651 | ** is associated with individual values, not with the containers |
||
3652 | ** used to hold those values. |
||
3653 | */ |
||
3654 | //SQLITE_API string sqlite3_column_decltype(sqlite3_stmt*,int); |
||
3655 | //SQLITE_API const void *sqlite3_column_decltype16(sqlite3_stmt*,int); |
||
3656 | |||
3657 | /* |
||
3658 | ** CAPI3REF: Evaluate An SQL Statement |
||
3659 | ** |
||
3660 | ** After a [prepared statement] has been prepared using either |
||
3661 | ** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy |
||
3662 | ** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function |
||
3663 | ** must be called one or more times to evaluate the statement. |
||
3664 | ** |
||
3665 | ** The details of the behavior of the sqlite3_step() interface depend |
||
3666 | ** on whether the statement was prepared using the newer "v2" interface |
||
3667 | ** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy |
||
3668 | ** interface [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the |
||
3669 | ** new "v2" interface is recommended for new applications but the legacy |
||
3670 | ** interface will continue to be supported. |
||
3671 | ** |
||
3672 | ** ^In the legacy interface, the return value will be either [SQLITE_BUSY], |
||
3673 | ** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE]. |
||
3674 | ** ^With the "v2" interface, any of the other [result codes] or |
||
3675 | ** [extended result codes] might be returned as well. |
||
3676 | ** |
||
3677 | ** ^[SQLITE_BUSY] means that the database engine was unable to acquire the |
||
3678 | ** database locks it needs to do its job. ^If the statement is a [COMMIT] |
||
3679 | ** or occurs outside of an explicit transaction, then you can retry the |
||
3680 | ** statement. If the statement is not a [COMMIT] and occurs within an |
||
3681 | ** explicit transaction then you should rollback the transaction before |
||
3682 | ** continuing. |
||
3683 | ** |
||
3684 | ** ^[SQLITE_DONE] means that the statement has finished executing |
||
3685 | ** successfully. sqlite3_step() should not be called again on this virtual |
||
3686 | ** machine without first calling [sqlite3_reset()] to reset the virtual |
||
3687 | ** machine back to its initial state. |
||
3688 | ** |
||
3689 | ** ^If the SQL statement being executed returns any data, then [SQLITE_ROW] |
||
3690 | ** is returned each time a new row of data is ready for processing by the |
||
3691 | ** caller. The values may be accessed using the [column access functions]. |
||
3692 | ** sqlite3_step() is called again to retrieve the next row of data. |
||
3693 | ** |
||
3694 | ** ^[SQLITE_ERROR] means that a run-time error (such as a constraint |
||
3695 | ** violation) has occurred. sqlite3_step() should not be called again on |
||
3696 | ** the VM. More information may be found by calling [sqlite3_errmsg()]. |
||
3697 | ** ^With the legacy interface, a more specific error code (for example, |
||
3698 | ** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth) |
||
3699 | ** can be obtained by calling [sqlite3_reset()] on the |
||
3700 | ** [prepared statement]. ^In the "v2" interface, |
||
3701 | ** the more specific error code is returned directly by sqlite3_step(). |
||
3702 | ** |
||
3703 | ** [SQLITE_MISUSE] means that the this routine was called inappropriately. |
||
3704 | ** Perhaps it was called on a [prepared statement] that has |
||
3705 | ** already been [sqlite3_finalize | finalized] or on one that had |
||
3706 | ** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could |
||
3707 | ** be the case that the same database connection is being used by two or |
||
3708 | ** more threads at the same moment in time. |
||
3709 | ** |
||
3710 | ** For all versions of SQLite up to and including 3.6.23.1, a call to |
||
3711 | ** [sqlite3_reset()] was required after sqlite3_step() returned anything |
||
3712 | ** other than [SQLITE_ROW] before any subsequent invocation of |
||
3713 | ** sqlite3_step(). Failure to reset the prepared statement using |
||
3714 | ** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from |
||
3715 | ** sqlite3_step(). But after version 3.6.23.1, sqlite3_step() began |
||
3716 | ** calling [sqlite3_reset()] automatically in this circumstance rather |
||
3717 | ** than returning [SQLITE_MISUSE]. This is not considered a compatibility |
||
3718 | ** break because any application that ever receives an SQLITE_MISUSE error |
||
3719 | ** is broken by definition. The [SQLITE_OMIT_AUTORESET] compile-time option |
||
3720 | ** can be used to restore the legacy behavior. |
||
3721 | ** |
||
3722 | ** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step() |
||
3723 | ** API always returns a generic error code, [SQLITE_ERROR], following any |
||
3724 | ** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call |
||
3725 | ** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the |
||
3726 | ** specific [error codes] that better describes the error. |
||
3727 | ** We admit that this is a goofy design. The problem has been fixed |
||
3728 | ** with the "v2" interface. If you prepare all of your SQL statements |
||
3729 | ** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead |
||
3730 | ** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces, |
||
3731 | ** then the more specific [error codes] are returned directly |
||
3732 | ** by sqlite3_step(). The use of the "v2" interface is recommended. |
||
3733 | */ |
||
3734 | //SQLITE_API int sqlite3_step(sqlite3_stmt); |
||
3735 | |||
3736 | /* |
||
3737 | ** CAPI3REF: Number of columns in a result set |
||
3738 | ** |
||
3739 | ** ^The sqlite3_data_count(P) interface returns the number of columns in the |
||
3740 | ** current row of the result set of [prepared statement] P. |
||
3741 | ** ^If prepared statement P does not have results ready to return |
||
3742 | ** (via calls to the [sqlite3_column_int | sqlite3_column_*()] of |
||
3743 | ** interfaces) then sqlite3_data_count(P) returns 0. |
||
3744 | ** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer. |
||
3745 | ** |
||
3746 | ** See also: [sqlite3_column_count()] |
||
3747 | */ |
||
3748 | //SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt); |
||
3749 | |||
3750 | /* |
||
3751 | ** CAPI3REF: Fundamental Datatypes |
||
3752 | ** KEYWORDS: SQLITE_TEXT |
||
3753 | ** |
||
3754 | ** ^(Every value in SQLite has one of five fundamental datatypes: |
||
3755 | ** |
||
3756 | ** <ul> |
||
3757 | ** <li> 64-bit signed integer |
||
3758 | ** <li> 64-bit IEEE floating point number |
||
3759 | ** <li> string |
||
3760 | ** <li> BLOB |
||
3761 | ** <li> NULL |
||
3762 | ** </ul>)^ |
||
3763 | ** |
||
3764 | ** These constants are codes for each of those types. |
||
3765 | ** |
||
3766 | ** Note that the SQLITE_TEXT constant was also used in SQLite version 2 |
||
3767 | ** for a completely different meaning. Software that links against both |
||
3768 | ** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not |
||
3769 | ** SQLITE_TEXT. |
||
3770 | */ |
||
3771 | //#define SQLITE_INTEGER 1 |
||
3772 | //#define SQLITE_FLOAT 2 |
||
3773 | //#define SQLITE_BLOB 4 |
||
3774 | //#define SQLITE_NULL 5 |
||
3775 | //#if SQLITE_TEXT |
||
3776 | //# undef SQLITE_TEXT |
||
3777 | //#else |
||
3778 | //# define SQLITE_TEXT 3 |
||
3779 | //#endif |
||
3780 | //#define SQLITE3_TEXT 3 |
||
3781 | public const u8 SQLITE_INTEGER = 1; |
||
3782 | public const u8 SQLITE_FLOAT = 2; |
||
3783 | public const u8 SQLITE_BLOB = 4; |
||
3784 | public const u8 SQLITE_NULL = 5; |
||
3785 | public const u8 SQLITE_TEXT = 3; |
||
3786 | public const u8 SQLITE3_TEXT = 3; |
||
3787 | |||
3788 | /* |
||
3789 | ** CAPI3REF: Result Values From A Query |
||
3790 | ** KEYWORDS: {column access functions} |
||
3791 | ** |
||
3792 | ** These routines form the "result set" interface. |
||
3793 | ** |
||
3794 | ** ^These routines return information about a single column of the current |
||
3795 | ** result row of a query. ^In every case the first argument is a pointer |
||
3796 | ** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*] |
||
3797 | ** that was returned from [sqlite3_prepare_v2()] or one of its variants) |
||
3798 | ** and the second argument is the index of the column for which information |
||
3799 | ** should be returned. ^The leftmost column of the result set has the index 0. |
||
3800 | ** ^The number of columns in the result can be determined using |
||
3801 | ** [sqlite3_column_count()]. |
||
3802 | ** |
||
3803 | ** If the SQL statement does not currently point to a valid row, or if the |
||
3804 | ** column index is out of range, the result is undefined. |
||
3805 | ** These routines may only be called when the most recent call to |
||
3806 | ** [sqlite3_step()] has returned [SQLITE_ROW] and neither |
||
3807 | ** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently. |
||
3808 | ** If any of these routines are called after [sqlite3_reset()] or |
||
3809 | ** [sqlite3_finalize()] or after [sqlite3_step()] has returned |
||
3810 | ** something other than [SQLITE_ROW], the results are undefined. |
||
3811 | ** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()] |
||
3812 | ** are called from a different thread while any of these routines |
||
3813 | ** are pending, then the results are undefined. |
||
3814 | ** |
||
3815 | ** ^The sqlite3_column_type() routine returns the |
||
3816 | ** [SQLITE_INTEGER | datatype code] for the initial data type |
||
3817 | ** of the result column. ^The returned value is one of [SQLITE_INTEGER], |
||
3818 | ** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. The value |
||
3819 | ** returned by sqlite3_column_type() is only meaningful if no type |
||
3820 | ** conversions have occurred as described below. After a type conversion, |
||
3821 | ** the value returned by sqlite3_column_type() is undefined. Future |
||
3822 | ** versions of SQLite may change the behavior of sqlite3_column_type() |
||
3823 | ** following a type conversion. |
||
3824 | ** |
||
3825 | ** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes() |
||
3826 | ** routine returns the number of bytes in that BLOB or string. |
||
3827 | ** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts |
||
3828 | ** the string to UTF-8 and then returns the number of bytes. |
||
3829 | ** ^If the result is a numeric value then sqlite3_column_bytes() uses |
||
3830 | ** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns |
||
3831 | ** the number of bytes in that string. |
||
3832 | ** ^If the result is NULL, then sqlite3_column_bytes() returns zero. |
||
3833 | ** |
||
3834 | ** ^If the result is a BLOB or UTF-16 string then the sqlite3_column_bytes16() |
||
3835 | ** routine returns the number of bytes in that BLOB or string. |
||
3836 | ** ^If the result is a UTF-8 string, then sqlite3_column_bytes16() converts |
||
3837 | ** the string to UTF-16 and then returns the number of bytes. |
||
3838 | ** ^If the result is a numeric value then sqlite3_column_bytes16() uses |
||
3839 | ** [sqlite3_snprintf()] to convert that value to a UTF-16 string and returns |
||
3840 | ** the number of bytes in that string. |
||
3841 | ** ^If the result is NULL, then sqlite3_column_bytes16() returns zero. |
||
3842 | ** |
||
3843 | ** ^The values returned by [sqlite3_column_bytes()] and |
||
3844 | ** [sqlite3_column_bytes16()] do not include the zero terminators at the end |
||
3845 | ** of the string. ^For clarity: the values returned by |
||
3846 | ** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of |
||
3847 | ** bytes in the string, not the number of characters. |
||
3848 | ** |
||
3849 | ** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(), |
||
3850 | ** even empty strings, are always zero terminated. ^The return |
||
3851 | ** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer. |
||
3852 | ** |
||
3853 | ** ^The object returned by [sqlite3_column_value()] is an |
||
3854 | ** [unprotected sqlite3_value] object. An unprotected sqlite3_value object |
||
3855 | ** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()]. |
||
3856 | ** If the [unprotected sqlite3_value] object returned by |
||
3857 | ** [sqlite3_column_value()] is used in any other way, including calls |
||
3858 | ** to routines like [sqlite3_value_int()], [sqlite3_value_text()], |
||
3859 | ** or [sqlite3_value_bytes()], then the behavior is undefined. |
||
3860 | ** |
||
3861 | ** These routines attempt to convert the value where appropriate. ^For |
||
3862 | ** example, if the internal representation is FLOAT and a text result |
||
3863 | ** is requested, [sqlite3_snprintf()] is used internally to perform the |
||
3864 | ** conversion automatically. ^(The following table details the conversions |
||
3865 | ** that are applied: |
||
3866 | ** |
||
3867 | ** <blockquote> |
||
3868 | ** <table border="1"> |
||
3869 | ** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion |
||
3870 | ** |
||
3871 | ** <tr><td> NULL <td> INTEGER <td> Result is 0 |
||
3872 | ** <tr><td> NULL <td> FLOAT <td> Result is 0.0 |
||
3873 | ** <tr><td> NULL <td> TEXT <td> Result is NULL pointer |
||
3874 | ** <tr><td> NULL <td> BLOB <td> Result is NULL pointer |
||
3875 | ** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float |
||
3876 | ** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer |
||
3877 | ** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT |
||
3878 | ** <tr><td> FLOAT <td> INTEGER <td> Convert from float to integer |
||
3879 | ** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float |
||
3880 | ** <tr><td> FLOAT <td> BLOB <td> Same as FLOAT->TEXT |
||
3881 | ** <tr><td> TEXT <td> INTEGER <td> Use atoi() |
||
3882 | ** <tr><td> TEXT <td> FLOAT <td> Use atof() |
||
3883 | ** <tr><td> TEXT <td> BLOB <td> No change |
||
3884 | ** <tr><td> BLOB <td> INTEGER <td> Convert to TEXT then use atoi() |
||
3885 | ** <tr><td> BLOB <td> FLOAT <td> Convert to TEXT then use atof() |
||
3886 | ** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed |
||
3887 | ** </table> |
||
3888 | ** </blockquote>)^ |
||
3889 | ** |
||
3890 | ** The table above makes reference to standard C library functions atoi() |
||
3891 | ** and atof(). SQLite does not really use these functions. It has its |
||
3892 | ** own equivalent internal routines. The atoi() and atof() names are |
||
3893 | ** used in the table for brevity and because they are familiar to most |
||
3894 | ** C programmers. |
||
3895 | ** |
||
3896 | ** Note that when type conversions occur, pointers returned by prior |
||
3897 | ** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or |
||
3898 | ** sqlite3_column_text16() may be invalidated. |
||
3899 | ** Type conversions and pointer invalidations might occur |
||
3900 | ** in the following cases: |
||
3901 | ** |
||
3902 | ** <ul> |
||
3903 | ** <li> The initial content is a BLOB and sqlite3_column_text() or |
||
3904 | ** sqlite3_column_text16() is called. A zero-terminator might |
||
3905 | ** need to be added to the string.</li> |
||
3906 | ** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or |
||
3907 | ** sqlite3_column_text16() is called. The content must be converted |
||
3908 | ** to UTF-16.</li> |
||
3909 | ** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or |
||
3910 | ** sqlite3_column_text() is called. The content must be converted |
||
3911 | ** to UTF-8.</li> |
||
3912 | ** </ul> |
||
3913 | ** |
||
3914 | ** ^Conversions between UTF-16be and UTF-16le are always done in place and do |
||
3915 | ** not invalidate a prior pointer, though of course the content of the buffer |
||
3916 | ** that the prior pointer references will have been modified. Other kinds |
||
3917 | ** of conversion are done in place when it is possible, but sometimes they |
||
3918 | ** are not possible and in those cases prior pointers are invalidated. |
||
3919 | ** |
||
3920 | ** The safest and easiest to remember policy is to invoke these routines |
||
3921 | ** in one of the following ways: |
||
3922 | ** |
||
3923 | ** <ul> |
||
3924 | ** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li> |
||
3925 | ** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li> |
||
3926 | ** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li> |
||
3927 | ** </ul> |
||
3928 | ** |
||
3929 | ** In other words, you should call sqlite3_column_text(), |
||
3930 | ** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result |
||
3931 | ** into the desired format, then invoke sqlite3_column_bytes() or |
||
3932 | ** sqlite3_column_bytes16() to find the size of the result. Do not mix calls |
||
3933 | ** to sqlite3_column_text() or sqlite3_column_blob() with calls to |
||
3934 | ** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16() |
||
3935 | ** with calls to sqlite3_column_bytes(). |
||
3936 | ** |
||
3937 | ** ^The pointers returned are valid until a type conversion occurs as |
||
3938 | ** described above, or until [sqlite3_step()] or [sqlite3_reset()] or |
||
3939 | ** [sqlite3_finalize()] is called. ^The memory space used to hold strings |
||
3940 | ** and BLOBs is freed automatically. Do <b>not</b> pass the pointers returned |
||
3941 | ** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into |
||
3942 | ** [sqlite3_free()]. |
||
3943 | ** |
||
3944 | ** ^(If a memory allocation error occurs during the evaluation of any |
||
3945 | ** of these routines, a default value is returned. The default value |
||
3946 | ** is either the integer 0, the floating point number 0.0, or a NULL |
||
3947 | ** pointer. Subsequent calls to [sqlite3_errcode()] will return |
||
3948 | ** [SQLITE_NOMEM].)^ |
||
3949 | */ |
||
3950 | //SQLITE_API const void *sqlite3_column_blob(sqlite3_stmt*, int iCol); |
||
3951 | //SQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol); |
||
3952 | //SQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol); |
||
3953 | //SQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol); |
||
3954 | //SQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol); |
||
3955 | //SQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol); |
||
3956 | //SQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol); |
||
3957 | //SQLITE_API const void *sqlite3_column_text16(sqlite3_stmt*, int iCol); |
||
3958 | //SQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol); |
||
3959 | //SQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol); |
||
3960 | |||
3961 | /* |
||
3962 | ** CAPI3REF: Destroy A Prepared Statement Object |
||
3963 | ** |
||
3964 | ** ^The sqlite3_finalize() function is called to delete a [prepared statement]. |
||
3965 | ** ^If the most recent evaluation of the statement encountered no errors |
||
3966 | ** or if the statement is never been evaluated, then sqlite3_finalize() returns |
||
3967 | ** SQLITE_OK. ^If the most recent evaluation of statement S failed, then |
||
3968 | ** sqlite3_finalize(S) returns the appropriate [error code] or |
||
3969 | ** [extended error code]. |
||
3970 | ** |
||
3971 | ** ^The sqlite3_finalize(S) routine can be called at any point during |
||
3972 | ** the life cycle of [prepared statement] S: |
||
3973 | ** before statement S is ever evaluated, after |
||
3974 | ** one or more calls to [sqlite3_reset()], or after any call |
||
3975 | ** to [sqlite3_step()] regardless of whether or not the statement has |
||
3976 | ** completed execution. |
||
3977 | ** |
||
3978 | ** ^Invoking sqlite3_finalize() on a NULL pointer is a harmless no-op. |
||
3979 | ** |
||
3980 | ** The application must finalize every [prepared statement] in order to avoid |
||
3981 | ** resource leaks. It is a grievous error for the application to try to use |
||
3982 | ** a prepared statement after it has been finalized. Any use of a prepared |
||
3983 | ** statement after it has been finalized can result in undefined and |
||
3984 | ** undesirable behavior such as segfaults and heap corruption. |
||
3985 | */ |
||
3986 | //SQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt); |
||
3987 | |||
3988 | /* |
||
3989 | ** CAPI3REF: Reset A Prepared Statement Object |
||
3990 | ** |
||
3991 | ** The sqlite3_reset() function is called to reset a [prepared statement] |
||
3992 | ** object back to its initial state, ready to be re-executed. |
||
3993 | ** ^Any SQL statement variables that had values bound to them using |
||
3994 | ** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values. |
||
3995 | ** Use [sqlite3_clear_bindings()] to reset the bindings. |
||
3996 | ** |
||
3997 | ** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S |
||
3998 | ** back to the beginning of its program. |
||
3999 | ** |
||
4000 | ** ^If the most recent call to [sqlite3_step(S)] for the |
||
4001 | ** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE], |
||
4002 | ** or if [sqlite3_step(S)] has never before been called on S, |
||
4003 | ** then [sqlite3_reset(S)] returns [SQLITE_OK]. |
||
4004 | ** |
||
4005 | ** ^If the most recent call to [sqlite3_step(S)] for the |
||
4006 | ** [prepared statement] S indicated an error, then |
||
4007 | ** [sqlite3_reset(S)] returns an appropriate [error code]. |
||
4008 | ** |
||
4009 | ** ^The [sqlite3_reset(S)] interface does not change the values |
||
4010 | ** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S. |
||
4011 | */ |
||
4012 | //SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt); |
||
4013 | |||
4014 | /* |
||
4015 | ** CAPI3REF: Create Or Redefine SQL Functions |
||
4016 | ** KEYWORDS: {function creation routines} |
||
4017 | ** KEYWORDS: {application-defined SQL function} |
||
4018 | ** KEYWORDS: {application-defined SQL functions} |
||
4019 | ** |
||
4020 | ** ^These functions (collectively known as "function creation routines") |
||
4021 | ** are used to add SQL functions or aggregates or to redefine the behavior |
||
4022 | ** of existing SQL functions or aggregates. The only differences between |
||
4023 | ** these routines are the text encoding expected for |
||
4024 | ** the second parameter (the name of the function being created) |
||
4025 | ** and the presence or absence of a destructor callback for |
||
4026 | ** the application data pointer. |
||
4027 | ** |
||
4028 | ** ^The first parameter is the [database connection] to which the SQL |
||
4029 | ** function is to be added. ^If an application uses more than one database |
||
4030 | ** connection then application-defined SQL functions must be added |
||
4031 | ** to each database connection separately. |
||
4032 | ** |
||
4033 | ** ^The second parameter is the name of the SQL function to be created or |
||
4034 | ** redefined. ^The length of the name is limited to 255 bytes in a UTF-8 |
||
4035 | ** representation, exclusive of the zero-terminator. ^Note that the name |
||
4036 | ** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes. |
||
4037 | ** ^Any attempt to create a function with a longer name |
||
4038 | ** will result in [SQLITE_MISUSE] being returned. |
||
4039 | ** |
||
4040 | ** ^The third parameter (nArg) |
||
4041 | ** is the number of arguments that the SQL function or |
||
4042 | ** aggregate takes. ^If this parameter is -1, then the SQL function or |
||
4043 | ** aggregate may take any number of arguments between 0 and the limit |
||
4044 | ** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third |
||
4045 | ** parameter is less than -1 or greater than 127 then the behavior is |
||
4046 | ** undefined. |
||
4047 | ** |
||
4048 | ** ^The fourth parameter, eTextRep, specifies what |
||
4049 | ** [SQLITE_UTF8 | text encoding] this SQL function prefers for |
||
4050 | ** its parameters. Every SQL function implementation must be able to work |
||
4051 | ** with UTF-8, UTF-16le, or UTF-16be. But some implementations may be |
||
4052 | ** more efficient with one encoding than another. ^An application may |
||
4053 | ** invoke sqlite3_create_function() or sqlite3_create_function16() multiple |
||
4054 | ** times with the same function but with different values of eTextRep. |
||
4055 | ** ^When multiple implementations of the same function are available, SQLite |
||
4056 | ** will pick the one that involves the least amount of data conversion. |
||
4057 | ** If there is only a single implementation which does not care what text |
||
4058 | ** encoding is used, then the fourth argument should be [SQLITE_ANY]. |
||
4059 | ** |
||
4060 | ** ^(The fifth parameter is an arbitrary pointer. The implementation of the |
||
4061 | ** function can gain access to this pointer using [sqlite3_user_data()].)^ |
||
4062 | ** |
||
4063 | ** ^The sixth, seventh and eighth parameters, xFunc, xStep and xFinal, are |
||
4064 | ** pointers to C-language functions that implement the SQL function or |
||
4065 | ** aggregate. ^A scalar SQL function requires an implementation of the xFunc |
||
4066 | ** callback only; NULL pointers must be passed as the xStep and xFinal |
||
4067 | ** parameters. ^An aggregate SQL function requires an implementation of xStep |
||
4068 | ** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing |
||
4069 | ** SQL function or aggregate, pass NULL pointers for all three function |
||
4070 | ** callbacks. |
||
4071 | ** |
||
4072 | ** ^(If the ninth parameter to sqlite3_create_function_v2() is not NULL, |
||
4073 | ** then it is destructor for the application data pointer. |
||
4074 | ** The destructor is invoked when the function is deleted, either by being |
||
4075 | ** overloaded or when the database connection closes.)^ |
||
4076 | ** ^The destructor is also invoked if the call to |
||
4077 | ** sqlite3_create_function_v2() fails. |
||
4078 | ** ^When the destructor callback of the tenth parameter is invoked, it |
||
4079 | ** is passed a single argument which is a copy of the application data |
||
4080 | ** pointer which was the fifth parameter to sqlite3_create_function_v2(). |
||
4081 | ** |
||
4082 | ** ^It is permitted to register multiple implementations of the same |
||
4083 | ** functions with the same name but with either differing numbers of |
||
4084 | ** arguments or differing preferred text encodings. ^SQLite will use |
||
4085 | ** the implementation that most closely matches the way in which the |
||
4086 | ** SQL function is used. ^A function implementation with a non-negative |
||
4087 | ** nArg parameter is a better match than a function implementation with |
||
4088 | ** a negative nArg. ^A function where the preferred text encoding |
||
4089 | ** matches the database encoding is a better |
||
4090 | ** match than a function where the encoding is different. |
||
4091 | ** ^A function where the encoding difference is between UTF16le and UTF16be |
||
4092 | ** is a closer match than a function where the encoding difference is |
||
4093 | ** between UTF8 and UTF16. |
||
4094 | ** |
||
4095 | ** ^Built-in functions may be overloaded by new application-defined functions. |
||
4096 | ** |
||
4097 | ** ^An application-defined function is permitted to call other |
||
4098 | ** SQLite interfaces. However, such calls must not |
||
4099 | ** close the database connection nor finalize or reset the prepared |
||
4100 | ** statement in which the function is running. |
||
4101 | */ |
||
4102 | //SQLITE_API int sqlite3_create_function( |
||
4103 | // sqlite3 db, |
||
4104 | // string zFunctionName, |
||
4105 | // int nArg, |
||
4106 | // int eTextRep, |
||
4107 | // void *pApp, |
||
4108 | // void (*xFunc)(sqlite3_context*,int,sqlite3_value*), |
||
4109 | // void (*xStep)(sqlite3_context*,int,sqlite3_value*), |
||
4110 | // void (*xFinal)(sqlite3_context) |
||
4111 | //); |
||
4112 | //SQLITE_API int sqlite3_create_function16( |
||
4113 | // sqlite3 db, |
||
4114 | // string zFunctionName, |
||
4115 | // int nArg, |
||
4116 | // int eTextRep, |
||
4117 | // void *pApp, |
||
4118 | // void (*xFunc)(sqlite3_context*,int,sqlite3_value*), |
||
4119 | // void (*xStep)(sqlite3_context*,int,sqlite3_value*), |
||
4120 | // void (*xFinal)(sqlite3_context) |
||
4121 | //); |
||
4122 | //SQLITE_API int sqlite3_create_function_v2( |
||
4123 | // sqlite3 db, |
||
4124 | // string zFunctionName, |
||
4125 | // int nArg, |
||
4126 | // int eTextRep, |
||
4127 | // void *pApp, |
||
4128 | // void (*xFunc)(sqlite3_context*,int,sqlite3_value*), |
||
4129 | // void (*xStep)(sqlite3_context*,int,sqlite3_value*), |
||
4130 | // void (*xFinal)(sqlite3_context), |
||
4131 | // void(*xDestroy)(void) |
||
4132 | //); |
||
4133 | |||
4134 | /* |
||
4135 | ** CAPI3REF: Text Encodings |
||
4136 | ** |
||
4137 | ** These constant define integer codes that represent the various |
||
4138 | ** text encodings supported by SQLite. |
||
4139 | */ |
||
4140 | //#define SQLITE_UTF8 1 |
||
4141 | //#define SQLITE_UTF16LE 2 |
||
4142 | //#define SQLITE_UTF16BE 3 |
||
4143 | //#define SQLITE_UTF16 4 /* Use native byte order */ |
||
4144 | //#define SQLITE_ANY 5 /* sqlite3_create_function only */ |
||
4145 | //#define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */ |
||
4146 | public const u8 SQLITE_UTF8 = 1; |
||
4147 | public const u8 SQLITE_UTF16LE = 2; |
||
4148 | public const u8 SQLITE_UTF16BE = 3; |
||
4149 | public const u8 SQLITE_UTF16 = 4; |
||
4150 | public const u8 SQLITE_ANY = 5; |
||
4151 | public const u8 SQLITE_UTF16_ALIGNED = 8; |
||
4152 | |||
4153 | |||
4154 | /* |
||
4155 | ** CAPI3REF: Deprecated Functions |
||
4156 | ** DEPRECATED |
||
4157 | ** |
||
4158 | ** These functions are [deprecated]. In order to maintain |
||
4159 | ** backwards compatibility with older code, these functions continue |
||
4160 | ** to be supported. However, new applications should avoid |
||
4161 | ** the use of these functions. To help encourage people to avoid |
||
4162 | ** using these functions, we are not going to tell you what they do. |
||
4163 | */ |
||
4164 | //#if !SQLITE_OMIT_DEPRECATED |
||
4165 | //SQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context); |
||
4166 | //SQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt); |
||
4167 | //SQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt); |
||
4168 | //SQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void); |
||
4169 | //SQLITE_API SQLITE_DEPRECATED void sqlite3_thread_cleanup(void); |
||
4170 | //SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void()(void*,sqlite3_int64,int),void*,sqlite3_int64); |
||
4171 | //#endif |
||
4172 | |||
4173 | /* |
||
4174 | ** CAPI3REF: Obtaining SQL Function Parameter Values |
||
4175 | ** |
||
4176 | ** The C-language implementation of SQL functions and aggregates uses |
||
4177 | ** this set of interface routines to access the parameter values on |
||
4178 | ** the function or aggregate. |
||
4179 | ** |
||
4180 | ** The xFunc (for scalar functions) or xStep (for aggregates) parameters |
||
4181 | ** to [sqlite3_create_function()] and [sqlite3_create_function16()] |
||
4182 | ** define callbacks that implement the SQL functions and aggregates. |
||
4183 | ** The 3rd parameter to these callbacks is an array of pointers to |
||
4184 | ** [protected sqlite3_value] objects. There is one [sqlite3_value] object for |
||
4185 | ** each parameter to the SQL function. These routines are used to |
||
4186 | ** extract values from the [sqlite3_value] objects. |
||
4187 | ** |
||
4188 | ** These routines work only with [protected sqlite3_value] objects. |
||
4189 | ** Any attempt to use these routines on an [unprotected sqlite3_value] |
||
4190 | ** object results in undefined behavior. |
||
4191 | ** |
||
4192 | ** ^These routines work just like the corresponding [column access functions] |
||
4193 | ** except that these routines take a single [protected sqlite3_value] object |
||
4194 | ** pointer instead of a [sqlite3_stmt*] pointer and an integer column number. |
||
4195 | ** |
||
4196 | ** ^The sqlite3_value_text16() interface extracts a UTF-16 string |
||
4197 | ** in the native byte-order of the host machine. ^The |
||
4198 | ** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces |
||
4199 | ** extract UTF-16 strings as big-endian and little-endian respectively. |
||
4200 | ** |
||
4201 | ** ^(The sqlite3_value_numeric_type() interface attempts to apply |
||
4202 | ** numeric affinity to the value. This means that an attempt is |
||
4203 | ** made to convert the value to an integer or floating point. If |
||
4204 | ** such a conversion is possible without loss of information (in other |
||
4205 | ** words, if the value is a string that looks like a number) |
||
4206 | ** then the conversion is performed. Otherwise no conversion occurs. |
||
4207 | ** The [SQLITE_INTEGER | datatype] after conversion is returned.)^ |
||
4208 | ** |
||
4209 | ** Please pay particular attention to the fact that the pointer returned |
||
4210 | ** from [sqlite3_value_blob()], [sqlite3_value_text()], or |
||
4211 | ** [sqlite3_value_text16()] can be invalidated by a subsequent call to |
||
4212 | ** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()], |
||
4213 | ** or [sqlite3_value_text16()]. |
||
4214 | ** |
||
4215 | ** These routines must be called from the same thread as |
||
4216 | ** the SQL function that supplied the [sqlite3_value*] parameters. |
||
4217 | */ |
||
4218 | //SQLITE_API const void *sqlite3_value_blob(sqlite3_value); |
||
4219 | //SQLITE_API int sqlite3_value_bytes(sqlite3_value); |
||
4220 | //SQLITE_API int sqlite3_value_bytes16(sqlite3_value); |
||
4221 | //SQLITE_API double sqlite3_value_double(sqlite3_value); |
||
4222 | //SQLITE_API int sqlite3_value_int(sqlite3_value); |
||
4223 | //SQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value); |
||
4224 | //SQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value); |
||
4225 | //SQLITE_API const void *sqlite3_value_text16(sqlite3_value); |
||
4226 | //SQLITE_API const void *sqlite3_value_text16le(sqlite3_value); |
||
4227 | //SQLITE_API const void *sqlite3_value_text16be(sqlite3_value); |
||
4228 | //SQLITE_API int sqlite3_value_type(sqlite3_value); |
||
4229 | //SQLITE_API int sqlite3_value_numeric_type(sqlite3_value); |
||
4230 | |||
4231 | /* |
||
4232 | ** CAPI3REF: Obtain Aggregate Function Context |
||
4233 | ** |
||
4234 | ** Implementations of aggregate SQL functions use this |
||
4235 | ** routine to allocate memory for storing their state. |
||
4236 | ** |
||
4237 | ** ^The first time the sqlite3_aggregate_context(C,N) routine is called |
||
4238 | ** for a particular aggregate function, SQLite |
||
4239 | ** allocates N of memory, zeroes out that memory, and returns a pointer |
||
4240 | ** to the new memory. ^On second and subsequent calls to |
||
4241 | ** sqlite3_aggregate_context() for the same aggregate function instance, |
||
4242 | ** the same buffer is returned. Sqlite3_aggregate_context() is normally |
||
4243 | ** called once for each invocation of the xStep callback and then one |
||
4244 | ** last time when the xFinal callback is invoked. ^(When no rows match |
||
4245 | ** an aggregate query, the xStep() callback of the aggregate function |
||
4246 | ** implementation is never called and xFinal() is called exactly once. |
||
4247 | ** In those cases, sqlite3_aggregate_context() might be called for the |
||
4248 | ** first time from within xFinal().)^ |
||
4249 | ** |
||
4250 | ** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer if N is |
||
4251 | ** less than or equal to zero or if a memory allocate error occurs. |
||
4252 | ** |
||
4253 | ** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is |
||
4254 | ** determined by the N parameter on first successful call. Changing the |
||
4255 | ** value of N in subsequent call to sqlite3_aggregate_context() within |
||
4256 | ** the same aggregate function instance will not resize the memory |
||
4257 | ** allocation.)^ |
||
4258 | ** |
||
4259 | ** ^SQLite automatically frees the memory allocated by |
||
4260 | ** sqlite3_aggregate_context() when the aggregate query concludes. |
||
4261 | ** |
||
4262 | ** The first parameter must be a copy of the |
||
4263 | ** [sqlite3_context | SQL function context] that is the first parameter |
||
4264 | ** to the xStep or xFinal callback routine that implements the aggregate |
||
4265 | ** function. |
||
4266 | ** |
||
4267 | ** This routine must be called from the same thread in which |
||
4268 | ** the aggregate SQL function is running. |
||
4269 | */ |
||
4270 | //SQLITE_API void *sqlite3_aggregate_context(sqlite3_context*, int nBytes); |
||
4271 | |||
4272 | /* |
||
4273 | ** CAPI3REF: User Data For Functions |
||
4274 | ** |
||
4275 | ** ^The sqlite3_user_data() interface returns a copy of |
||
4276 | ** the pointer that was the pUserData parameter (the 5th parameter) |
||
4277 | ** of the [sqlite3_create_function()] |
||
4278 | ** and [sqlite3_create_function16()] routines that originally |
||
4279 | ** registered the application defined function. |
||
4280 | ** |
||
4281 | ** This routine must be called from the same thread in which |
||
4282 | ** the application-defined function is running. |
||
4283 | */ |
||
4284 | //SQLITE_API void *sqlite3_user_data(sqlite3_context); |
||
4285 | |||
4286 | /* |
||
4287 | ** CAPI3REF: Database Connection For Functions |
||
4288 | ** |
||
4289 | ** ^The sqlite3_context_db_handle() interface returns a copy of |
||
4290 | ** the pointer to the [database connection] (the 1st parameter) |
||
4291 | ** of the [sqlite3_create_function()] |
||
4292 | ** and [sqlite3_create_function16()] routines that originally |
||
4293 | ** registered the application defined function. |
||
4294 | */ |
||
4295 | //SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_context); |
||
4296 | |||
4297 | /* |
||
4298 | ** CAPI3REF: Function Auxiliary Data |
||
4299 | ** |
||
4300 | ** The following two functions may be used by scalar SQL functions to |
||
4301 | ** associate metadata with argument values. If the same value is passed to |
||
4302 | ** multiple invocations of the same SQL function during query execution, under |
||
4303 | ** some circumstances the associated metadata may be preserved. This may |
||
4304 | ** be used, for example, to add a regular-expression matching scalar |
||
4305 | ** function. The compiled version of the regular expression is stored as |
||
4306 | ** metadata associated with the SQL value passed as the regular expression |
||
4307 | ** pattern. The compiled regular expression can be reused on multiple |
||
4308 | ** invocations of the same function so that the original pattern string |
||
4309 | ** does not need to be recompiled on each invocation. |
||
4310 | ** |
||
4311 | ** ^The sqlite3_get_auxdata() interface returns a pointer to the metadata |
||
4312 | ** associated by the sqlite3_set_auxdata() function with the Nth argument |
||
4313 | ** value to the application-defined function. ^If no metadata has been ever |
||
4314 | ** been set for the Nth argument of the function, or if the corresponding |
||
4315 | ** function parameter has changed since the meta-data was set, |
||
4316 | ** then sqlite3_get_auxdata() returns a NULL pointer. |
||
4317 | ** |
||
4318 | ** ^The sqlite3_set_auxdata() interface saves the metadata |
||
4319 | ** pointed to by its 3rd parameter as the metadata for the N-th |
||
4320 | ** argument of the application-defined function. Subsequent |
||
4321 | ** calls to sqlite3_get_auxdata() might return this data, if it has |
||
4322 | ** not been destroyed. |
||
4323 | ** ^If it is not NULL, SQLite will invoke the destructor |
||
4324 | ** function given by the 4th parameter to sqlite3_set_auxdata() on |
||
4325 | ** the metadata when the corresponding function parameter changes |
||
4326 | ** or when the SQL statement completes, whichever comes first. |
||
4327 | ** |
||
4328 | ** SQLite is free to call the destructor and drop metadata on any |
||
4329 | ** parameter of any function at any time. ^The only guarantee is that |
||
4330 | ** the destructor will be called before the metadata is dropped. |
||
4331 | ** |
||
4332 | ** ^(In practice, metadata is preserved between function calls for |
||
4333 | ** expressions that are constant at compile time. This includes literal |
||
4334 | ** values and [parameters].)^ |
||
4335 | ** |
||
4336 | ** These routines must be called from the same thread in which |
||
4337 | ** the SQL function is running. |
||
4338 | */ |
||
4339 | //SQLITE_API void *sqlite3_get_auxdata(sqlite3_context*, int N); |
||
4340 | //SQLITE_API void sqlite3_set_auxdata(sqlite3_context*, int N, void*, object ()(void)); |
||
4341 | |||
4342 | |||
4343 | /* |
||
4344 | ** CAPI3REF: Constants Defining Special Destructor Behavior |
||
4345 | ** |
||
4346 | ** These are special values for the destructor that is passed in as the |
||
4347 | ** final argument to routines like [sqlite3_result_blob()]. ^If the destructor |
||
4348 | ** argument is SQLITE_STATIC, it means that the content pointer is constant |
||
4349 | ** and will never change. It does not need to be destroyed. ^The |
||
4350 | ** SQLITE_TRANSIENT value means that the content will likely change in |
||
4351 | ** the near future and that SQLite should make its own private copy of |
||
4352 | ** the content before returning. |
||
4353 | ** |
||
4354 | ** The typedef is necessary to work around problems in certain |
||
4355 | ** C++ compilers. See ticket #2191. |
||
4356 | */ |
||
4357 | //typedef void (*sqlite3_destructor_type)(void); |
||
4358 | //#define SQLITE_STATIC ((sqlite3_destructor_type)0) |
||
4359 | //#define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1) |
||
4360 | static public dxDel SQLITE_STATIC; |
||
4361 | static public dxDel SQLITE_TRANSIENT; |
||
4362 | /* |
||
4363 | ** CAPI3REF: Setting The Result Of An SQL Function |
||
4364 | ** |
||
4365 | ** These routines are used by the xFunc or xFinal callbacks that |
||
4366 | ** implement SQL functions and aggregates. See |
||
4367 | ** [sqlite3_create_function()] and [sqlite3_create_function16()] |
||
4368 | ** for additional information. |
||
4369 | ** |
||
4370 | ** These functions work very much like the [parameter binding] family of |
||
4371 | ** functions used to bind values to host parameters in prepared statements. |
||
4372 | ** Refer to the [SQL parameter] documentation for additional information. |
||
4373 | ** |
||
4374 | ** ^The sqlite3_result_blob() interface sets the result from |
||
4375 | ** an application-defined function to be the BLOB whose content is pointed |
||
4376 | ** to by the second parameter and which is N bytes long where N is the |
||
4377 | ** third parameter. |
||
4378 | ** |
||
4379 | ** ^The sqlite3_result_zeroblob() interfaces set the result of |
||
4380 | ** the application-defined function to be a BLOB containing all zero |
||
4381 | ** bytes and N bytes in size, where N is the value of the 2nd parameter. |
||
4382 | ** |
||
4383 | ** ^The sqlite3_result_double() interface sets the result from |
||
4384 | ** an application-defined function to be a floating point value specified |
||
4385 | ** by its 2nd argument. |
||
4386 | ** |
||
4387 | ** ^The sqlite3_result_error() and sqlite3_result_error16() functions |
||
4388 | ** cause the implemented SQL function to throw an exception. |
||
4389 | ** ^SQLite uses the string pointed to by the |
||
4390 | ** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16() |
||
4391 | ** as the text of an error message. ^SQLite interprets the error |
||
4392 | ** message string from sqlite3_result_error() as UTF-8. ^SQLite |
||
4393 | ** interprets the string from sqlite3_result_error16() as UTF-16 in native |
||
4394 | ** byte order. ^If the third parameter to sqlite3_result_error() |
||
4395 | ** or sqlite3_result_error16() is negative then SQLite takes as the error |
||
4396 | ** message all text up through the first zero character. |
||
4397 | ** ^If the third parameter to sqlite3_result_error() or |
||
4398 | ** sqlite3_result_error16() is non-negative then SQLite takes that many |
||
4399 | ** bytes (not characters) from the 2nd parameter as the error message. |
||
4400 | ** ^The sqlite3_result_error() and sqlite3_result_error16() |
||
4401 | ** routines make a private copy of the error message text before |
||
4402 | ** they return. Hence, the calling function can deallocate or |
||
4403 | ** modify the text after they return without harm. |
||
4404 | ** ^The sqlite3_result_error_code() function changes the error code |
||
4405 | ** returned by SQLite as a result of an error in a function. ^By default, |
||
4406 | ** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error() |
||
4407 | ** or sqlite3_result_error16() resets the error code to SQLITE_ERROR. |
||
4408 | ** |
||
4409 | ** ^The sqlite3_result_toobig() interface causes SQLite to throw an error |
||
4410 | ** indicating that a string or BLOB is too long to represent. |
||
4411 | ** |
||
4412 | ** ^The sqlite3_result_nomem() interface causes SQLite to throw an error |
||
4413 | ** indicating that a memory allocation failed. |
||
4414 | ** |
||
4415 | ** ^The sqlite3_result_int() interface sets the return value |
||
4416 | ** of the application-defined function to be the 32-bit signed integer |
||
4417 | ** value given in the 2nd argument. |
||
4418 | ** ^The sqlite3_result_int64() interface sets the return value |
||
4419 | ** of the application-defined function to be the 64-bit signed integer |
||
4420 | ** value given in the 2nd argument. |
||
4421 | ** |
||
4422 | ** ^The sqlite3_result_null() interface sets the return value |
||
4423 | ** of the application-defined function to be NULL. |
||
4424 | ** |
||
4425 | ** ^The sqlite3_result_text(), sqlite3_result_text16(), |
||
4426 | ** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces |
||
4427 | ** set the return value of the application-defined function to be |
||
4428 | ** a text string which is represented as UTF-8, UTF-16 native byte order, |
||
4429 | ** UTF-16 little endian, or UTF-16 big endian, respectively. |
||
4430 | ** ^SQLite takes the text result from the application from |
||
4431 | ** the 2nd parameter of the sqlite3_result_text* interfaces. |
||
4432 | ** ^If the 3rd parameter to the sqlite3_result_text* interfaces |
||
4433 | ** is negative, then SQLite takes result text from the 2nd parameter |
||
4434 | ** through the first zero character. |
||
4435 | ** ^If the 3rd parameter to the sqlite3_result_text* interfaces |
||
4436 | ** is non-negative, then as many bytes (not characters) of the text |
||
4437 | ** pointed to by the 2nd parameter are taken as the application-defined |
||
4438 | ** function result. |
||
4439 | ** ^If the 4th parameter to the sqlite3_result_text* interfaces |
||
4440 | ** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that |
||
4441 | ** function as the destructor on the text or BLOB result when it has |
||
4442 | ** finished using that result. |
||
4443 | ** ^If the 4th parameter to the sqlite3_result_text* interfaces or to |
||
4444 | ** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite |
||
4445 | ** assumes that the text or BLOB result is in constant space and does not |
||
4446 | ** copy the content of the parameter nor call a destructor on the content |
||
4447 | ** when it has finished using that result. |
||
4448 | ** ^If the 4th parameter to the sqlite3_result_text* interfaces |
||
4449 | ** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT |
||
4450 | ** then SQLite makes a copy of the result into space obtained from |
||
4451 | ** from [sqlite3_malloc()] before it returns. |
||
4452 | ** |
||
4453 | ** ^The sqlite3_result_value() interface sets the result of |
||
4454 | ** the application-defined function to be a copy the |
||
4455 | ** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The |
||
4456 | ** sqlite3_result_value() interface makes a copy of the [sqlite3_value] |
||
4457 | ** so that the [sqlite3_value] specified in the parameter may change or |
||
4458 | ** be deallocated after sqlite3_result_value() returns without harm. |
||
4459 | ** ^A [protected sqlite3_value] object may always be used where an |
||
4460 | ** [unprotected sqlite3_value] object is required, so either |
||
4461 | ** kind of [sqlite3_value] object can be used with this interface. |
||
4462 | ** |
||
4463 | ** If these routines are called from within the different thread |
||
4464 | ** than the one containing the application-defined function that received |
||
4465 | ** the [sqlite3_context] pointer, the results are undefined. |
||
4466 | */ |
||
4467 | //SQLITE_API void sqlite3_result_blob(sqlite3_context*, const void*, int, void()(void)); |
||
4468 | //SQLITE_API void sqlite3_result_double(sqlite3_context*, double); |
||
4469 | //SQLITE_API void sqlite3_result_error(sqlite3_context*, const char*, int); |
||
4470 | //SQLITE_API void sqlite3_result_error16(sqlite3_context*, const void*, int); |
||
4471 | //SQLITE_API void sqlite3_result_error_toobig(sqlite3_context); |
||
4472 | //SQLITE_API void sqlite3_result_error_nomem(sqlite3_context); |
||
4473 | //SQLITE_API void sqlite3_result_error_code(sqlite3_context*, int); |
||
4474 | //SQLITE_API void sqlite3_result_int(sqlite3_context*, int); |
||
4475 | //SQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64); |
||
4476 | //SQLITE_API void sqlite3_result_null(sqlite3_context); |
||
4477 | //SQLITE_API void sqlite3_result_text(sqlite3_context*, const char*, int, void()(void)); |
||
4478 | //SQLITE_API void sqlite3_result_text16(sqlite3_context*, const void*, int, void()(void)); |
||
4479 | //SQLITE_API void sqlite3_result_text16le(sqlite3_context*, const void*, int,void()(void)); |
||
4480 | //SQLITE_API void sqlite3_result_text16be(sqlite3_context*, const void*, int,void()(void)); |
||
4481 | //SQLITE_API void sqlite3_result_value(sqlite3_context*, sqlite3_value); |
||
4482 | //SQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n); |
||
4483 | |||
4484 | /* |
||
4485 | ** CAPI3REF: Define New Collating Sequences |
||
4486 | ** |
||
4487 | ** ^These functions add, remove, or modify a [collation] associated |
||
4488 | ** with the [database connection] specified as the first argument. |
||
4489 | ** |
||
4490 | ** ^The name of the collation is a UTF-8 string |
||
4491 | ** for sqlite3_create_collation() and sqlite3_create_collation_v2() |
||
4492 | ** and a UTF-16 string in native byte order for sqlite3_create_collation16(). |
||
4493 | ** ^Collation names that compare equal according to [sqlite3_strnicmp()] are |
||
4494 | ** considered to be the same name. |
||
4495 | ** |
||
4496 | ** ^(The third argument (eTextRep) must be one of the constants: |
||
4497 | ** <ul> |
||
4498 | ** <li> [SQLITE_UTF8], |
||
4499 | ** <li> [SQLITE_UTF16LE], |
||
4500 | ** <li> [SQLITE_UTF16BE], |
||
4501 | ** <li> [SQLITE_UTF16], or |
||
4502 | ** <li> [SQLITE_UTF16_ALIGNED]. |
||
4503 | ** </ul>)^ |
||
4504 | ** ^The eTextRep argument determines the encoding of strings passed |
||
4505 | ** to the collating function callback, xCallback. |
||
4506 | ** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep |
||
4507 | ** force strings to be UTF16 with native byte order. |
||
4508 | ** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin |
||
4509 | ** on an even byte address. |
||
4510 | ** |
||
4511 | ** ^The fourth argument, pArg, is an application data pointer that is passed |
||
4512 | ** through as the first argument to the collating function callback. |
||
4513 | ** |
||
4514 | ** ^The fifth argument, xCallback, is a pointer to the collating function. |
||
4515 | ** ^Multiple collating functions can be registered using the same name but |
||
4516 | ** with different eTextRep parameters and SQLite will use whichever |
||
4517 | ** function requires the least amount of data transformation. |
||
4518 | ** ^If the xCallback argument is NULL then the collating function is |
||
4519 | ** deleted. ^When all collating functions having the same name are deleted, |
||
4520 | ** that collation is no longer usable. |
||
4521 | ** |
||
4522 | ** ^The collating function callback is invoked with a copy of the pArg |
||
4523 | ** application data pointer and with two strings in the encoding specified |
||
4524 | ** by the eTextRep argument. The collating function must return an |
||
4525 | ** integer that is negative, zero, or positive |
||
4526 | ** if the first string is less than, equal to, or greater than the second, |
||
4527 | ** respectively. A collating function must always return the same answer |
||
4528 | ** given the same inputs. If two or more collating functions are registered |
||
4529 | ** to the same collation name (using different eTextRep values) then all |
||
4530 | ** must give an equivalent answer when invoked with equivalent strings. |
||
4531 | ** The collating function must obey the following properties for all |
||
4532 | ** strings A, B, and C: |
||
4533 | ** |
||
4534 | ** <ol> |
||
4535 | ** <li> If A==B then B==A. |
||
4536 | ** <li> If A==B and B==C then A==C. |
||
4537 | ** <li> If A<B THEN B>A. |
||
4538 | ** <li> If A<B and B<C then A<C. |
||
4539 | ** </ol> |
||
4540 | ** |
||
4541 | ** If a collating function fails any of the above constraints and that |
||
4542 | ** collating function is registered and used, then the behavior of SQLite |
||
4543 | ** is undefined. |
||
4544 | ** |
||
4545 | ** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation() |
||
4546 | ** with the addition that the xDestroy callback is invoked on pArg when |
||
4547 | ** the collating function is deleted. |
||
4548 | ** ^Collating functions are deleted when they are overridden by later |
||
4549 | ** calls to the collation creation functions or when the |
||
4550 | ** [database connection] is closed using [sqlite3_close()]. |
||
4551 | ** |
||
4552 | ** ^The xDestroy callback is <u>not</u> called if the |
||
4553 | ** sqlite3_create_collation_v2() function fails. Applications that invoke |
||
4554 | ** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should |
||
4555 | ** check the return code and dispose of the application data pointer |
||
4556 | ** themselves rather than expecting SQLite to deal with it for them. |
||
4557 | ** This is different from every other SQLite interface. The inconsistency |
||
4558 | ** is unfortunate but cannot be changed without breaking backwards |
||
4559 | ** compatibility. |
||
4560 | ** |
||
4561 | ** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()]. |
||
4562 | */ |
||
4563 | //SQLITE_API int sqlite3_create_collation( |
||
4564 | // sqlite3*, |
||
4565 | // string zName, |
||
4566 | // int eTextRep, |
||
4567 | // void *pArg, |
||
4568 | // int(*xCompare)(void*,int,const void*,int,const void) |
||
4569 | //); |
||
4570 | //SQLITE_API int sqlite3_create_collation_v2( |
||
4571 | // sqlite3*, |
||
4572 | // string zName, |
||
4573 | // int eTextRep, |
||
4574 | // void *pArg, |
||
4575 | // int(*xCompare)(void*,int,const void*,int,const void), |
||
4576 | // void(*xDestroy)(void) |
||
4577 | //); |
||
4578 | //SQLITE_API int sqlite3_create_collation16( |
||
4579 | // sqlite3*, |
||
4580 | // string zName, |
||
4581 | // int eTextRep, |
||
4582 | // void *pArg, |
||
4583 | // int(*xCompare)(void*,int,const void*,int,const void) |
||
4584 | //); |
||
4585 | |||
4586 | /* |
||
4587 | ** CAPI3REF: Collation Needed Callbacks |
||
4588 | ** |
||
4589 | ** ^To avoid having to register all collation sequences before a database |
||
4590 | ** can be used, a single callback function may be registered with the |
||
4591 | ** [database connection] to be invoked whenever an undefined collation |
||
4592 | ** sequence is required. |
||
4593 | ** |
||
4594 | ** ^If the function is registered using the sqlite3_collation_needed() API, |
||
4595 | ** then it is passed the names of undefined collation sequences as strings |
||
4596 | ** encoded in UTF-8. ^If sqlite3_collation_needed16() is used, |
||
4597 | ** the names are passed as UTF-16 in machine native byte order. |
||
4598 | ** ^A call to either function replaces the existing collation-needed callback. |
||
4599 | ** |
||
4600 | ** ^(When the callback is invoked, the first argument passed is a copy |
||
4601 | ** of the second argument to sqlite3_collation_needed() or |
||
4602 | ** sqlite3_collation_needed16(). The second argument is the database |
||
4603 | ** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE], |
||
4604 | ** or [SQLITE_UTF16LE], indicating the most desirable form of the collation |
||
4605 | ** sequence function required. The fourth parameter is the name of the |
||
4606 | ** required collation sequence.)^ |
||
4607 | ** |
||
4608 | ** The callback function should register the desired collation using |
||
4609 | ** [sqlite3_create_collation()], [sqlite3_create_collation16()], or |
||
4610 | ** [sqlite3_create_collation_v2()]. |
||
4611 | */ |
||
4612 | //SQLITE_API int sqlite3_collation_needed( |
||
4613 | // sqlite3*, |
||
4614 | // void*, |
||
4615 | // void()(void*,sqlite3*,int eTextRep,const char) |
||
4616 | //); |
||
4617 | //SQLITE_API int sqlite3_collation_needed16( |
||
4618 | // sqlite3*, |
||
4619 | // void*, |
||
4620 | // void()(void*,sqlite3*,int eTextRep,const void) |
||
4621 | //); |
||
4622 | |||
4623 | //#if SQLITE_HAS_CODEC |
||
4624 | /* |
||
4625 | ** Specify the key for an encrypted database. This routine should be |
||
4626 | ** called right after sqlite3_open(). |
||
4627 | ** |
||
4628 | ** The code to implement this API is not available in the public release |
||
4629 | ** of SQLite. |
||
4630 | */ |
||
4631 | //SQLITE_API int sqlite3_key( |
||
4632 | // sqlite3 db, /* Database to be rekeyed */ |
||
4633 | // const void *pKey, int nKey /* The key */ |
||
4634 | //); |
||
4635 | |||
4636 | /* |
||
4637 | ** Change the key on an open database. If the current database is not |
||
4638 | ** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the |
||
4639 | ** database is decrypted. |
||
4640 | ** |
||
4641 | ** The code to implement this API is not available in the public release |
||
4642 | ** of SQLite. |
||
4643 | */ |
||
4644 | //SQLITE_API int sqlite3_rekey( |
||
4645 | // sqlite3 db, /* Database to be rekeyed */ |
||
4646 | // const void *pKey, int nKey /* The new key */ |
||
4647 | //); |
||
4648 | |||
4649 | /* |
||
4650 | ** Specify the activation key for a SEE database. Unless |
||
4651 | ** activated, none of the SEE routines will work. |
||
4652 | */ |
||
4653 | //SQLITE_API void sqlite3_activate_see( |
||
4654 | // string zPassPhrase /* Activation phrase */ |
||
4655 | //); |
||
4656 | //#endif |
||
4657 | |||
4658 | //#if SQLITE_ENABLE_CEROD |
||
4659 | /* |
||
4660 | ** Specify the activation key for a CEROD database. Unless |
||
4661 | ** activated, none of the CEROD routines will work. |
||
4662 | */ |
||
4663 | //SQLITE_API void sqlite3_activate_cerod( |
||
4664 | // string zPassPhrase /* Activation phrase */ |
||
4665 | //); |
||
4666 | //#endif |
||
4667 | |||
4668 | /* |
||
4669 | ** CAPI3REF: Suspend Execution For A Short Time |
||
4670 | ** |
||
4671 | ** The sqlite3_sleep() function causes the current thread to suspend execution |
||
4672 | ** for at least a number of milliseconds specified in its parameter. |
||
4673 | ** |
||
4674 | ** If the operating system does not support sleep requests with |
||
4675 | ** millisecond time resolution, then the time will be rounded up to |
||
4676 | ** the nearest second. The number of milliseconds of sleep actually |
||
4677 | ** requested from the operating system is returned. |
||
4678 | ** |
||
4679 | ** ^SQLite implements this interface by calling the xSleep() |
||
4680 | ** method of the default [sqlite3_vfs] object. If the xSleep() method |
||
4681 | ** of the default VFS is not implemented correctly, or not implemented at |
||
4682 | ** all, then the behavior of sqlite3_sleep() may deviate from the description |
||
4683 | ** in the previous paragraphs. |
||
4684 | */ |
||
4685 | //SQLITE_API int sqlite3_sleep(int); |
||
4686 | |||
4687 | /* |
||
4688 | ** CAPI3REF: Name Of The Folder Holding Temporary Files |
||
4689 | ** |
||
4690 | ** ^(If this global variable is made to point to a string which is |
||
4691 | ** the name of a folder (a.k.a. directory), then all temporary files |
||
4692 | ** created by SQLite when using a built-in [sqlite3_vfs | VFS] |
||
4693 | ** will be placed in that directory.)^ ^If this variable |
||
4694 | ** is a NULL pointer, then SQLite performs a search for an appropriate |
||
4695 | ** temporary file directory. |
||
4696 | ** |
||
4697 | ** It is not safe to read or modify this variable in more than one |
||
4698 | ** thread at a time. It is not safe to read or modify this variable |
||
4699 | ** if a [database connection] is being used at the same time in a separate |
||
4700 | ** thread. |
||
4701 | ** It is intended that this variable be set once |
||
4702 | ** as part of process initialization and before any SQLite interface |
||
4703 | ** routines have been called and that this variable remain unchanged |
||
4704 | ** thereafter. |
||
4705 | ** |
||
4706 | ** ^The [temp_store_directory pragma] may modify this variable and cause |
||
4707 | ** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore, |
||
4708 | ** the [temp_store_directory pragma] always assumes that any string |
||
4709 | ** that this variable points to is held in memory obtained from |
||
4710 | ** [sqlite3_malloc] and the pragma may attempt to free that memory |
||
4711 | ** using [sqlite3_free]. |
||
4712 | ** Hence, if this variable is modified directly, either it should be |
||
4713 | ** made NULL or made to point to memory obtained from [sqlite3_malloc] |
||
4714 | ** or else the use of the [temp_store_directory pragma] should be avoided. |
||
4715 | */ |
||
4716 | //SQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory; |
||
4717 | |||
4718 | /* |
||
4719 | ** CAPI3REF: Test For Auto-Commit Mode |
||
4720 | ** KEYWORDS: {autocommit mode} |
||
4721 | ** |
||
4722 | ** ^The sqlite3_get_autocommit() interface returns non-zero or |
||
4723 | ** zero if the given database connection is or is not in autocommit mode, |
||
4724 | ** respectively. ^Autocommit mode is on by default. |
||
4725 | ** ^Autocommit mode is disabled by a [BEGIN] statement. |
||
4726 | ** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK]. |
||
4727 | ** |
||
4728 | ** If certain kinds of errors occur on a statement within a multi-statement |
||
4729 | ** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR], |
||
4730 | ** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the |
||
4731 | ** transaction might be rolled back automatically. The only way to |
||
4732 | ** find out whether SQLite automatically rolled back the transaction after |
||
4733 | ** an error is to use this function. |
||
4734 | ** |
||
4735 | ** If another thread changes the autocommit status of the database |
||
4736 | ** connection while this routine is running, then the return value |
||
4737 | ** is undefined. |
||
4738 | */ |
||
4739 | //SQLITE_API int sqlite3_get_autocommit(sqlite3); |
||
4740 | |||
4741 | /* |
||
4742 | ** CAPI3REF: Find The Database Handle Of A Prepared Statement |
||
4743 | ** |
||
4744 | ** ^The sqlite3_db_handle interface returns the [database connection] handle |
||
4745 | ** to which a [prepared statement] belongs. ^The [database connection] |
||
4746 | ** returned by sqlite3_db_handle is the same [database connection] |
||
4747 | ** that was the first argument |
||
4748 | ** to the [sqlite3_prepare_v2()] call (or its variants) that was used to |
||
4749 | ** create the statement in the first place. |
||
4750 | */ |
||
4751 | //SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt); |
||
4752 | |||
4753 | /* |
||
4754 | ** CAPI3REF: Find the next prepared statement |
||
4755 | ** |
||
4756 | ** ^This interface returns a pointer to the next [prepared statement] after |
||
4757 | ** pStmt associated with the [database connection] pDb. ^If pStmt is NULL |
||
4758 | ** then this interface returns a pointer to the first prepared statement |
||
4759 | ** associated with the database connection pDb. ^If no prepared statement |
||
4760 | ** satisfies the conditions of this routine, it returns NULL. |
||
4761 | ** |
||
4762 | ** The [database connection] pointer D in a call to |
||
4763 | ** [sqlite3_next_stmt(D,S)] must refer to an open database |
||
4764 | ** connection and in particular must not be a NULL pointer. |
||
4765 | */ |
||
4766 | //SQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt); |
||
4767 | |||
4768 | /* |
||
4769 | ** CAPI3REF: Commit And Rollback Notification Callbacks |
||
4770 | ** |
||
4771 | ** ^The sqlite3_commit_hook() interface registers a callback |
||
4772 | ** function to be invoked whenever a transaction is [COMMIT | committed]. |
||
4773 | ** ^Any callback set by a previous call to sqlite3_commit_hook() |
||
4774 | ** for the same database connection is overridden. |
||
4775 | ** ^The sqlite3_rollback_hook() interface registers a callback |
||
4776 | ** function to be invoked whenever a transaction is [ROLLBACK | rolled back]. |
||
4777 | ** ^Any callback set by a previous call to sqlite3_rollback_hook() |
||
4778 | ** for the same database connection is overridden. |
||
4779 | ** ^The pArg argument is passed through to the callback. |
||
4780 | ** ^If the callback on a commit hook function returns non-zero, |
||
4781 | ** then the commit is converted into a rollback. |
||
4782 | ** |
||
4783 | ** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions |
||
4784 | ** return the P argument from the previous call of the same function |
||
4785 | ** on the same [database connection] D, or NULL for |
||
4786 | ** the first call for each function on D. |
||
4787 | ** |
||
4788 | ** The callback implementation must not do anything that will modify |
||
4789 | ** the database connection that invoked the callback. Any actions |
||
4790 | ** to modify the database connection must be deferred until after the |
||
4791 | ** completion of the [sqlite3_step()] call that triggered the commit |
||
4792 | ** or rollback hook in the first place. |
||
4793 | ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their |
||
4794 | ** database connections for the meaning of "modify" in this paragraph. |
||
4795 | ** |
||
4796 | ** ^Registering a NULL function disables the callback. |
||
4797 | ** |
||
4798 | ** ^When the commit hook callback routine returns zero, the [COMMIT] |
||
4799 | ** operation is allowed to continue normally. ^If the commit hook |
||
4800 | ** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK]. |
||
4801 | ** ^The rollback hook is invoked on a rollback that results from a commit |
||
4802 | ** hook returning non-zero, just as it would be with any other rollback. |
||
4803 | ** |
||
4804 | ** ^For the purposes of this API, a transaction is said to have been |
||
4805 | ** rolled back if an explicit "ROLLBACK" statement is executed, or |
||
4806 | ** an error or constraint causes an implicit rollback to occur. |
||
4807 | ** ^The rollback callback is not invoked if a transaction is |
||
4808 | ** automatically rolled back because the database connection is closed. |
||
4809 | ** |
||
4810 | ** See also the [sqlite3_update_hook()] interface. |
||
4811 | */ |
||
4812 | //SQLITE_API void *sqlite3_commit_hook(sqlite3*, int()(void), void); |
||
4813 | //SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void()(void ), void); |
||
4814 | |||
4815 | /* |
||
4816 | ** CAPI3REF: Data Change Notification Callbacks |
||
4817 | ** |
||
4818 | ** ^The sqlite3_update_hook() interface registers a callback function |
||
4819 | ** with the [database connection] identified by the first argument |
||
4820 | ** to be invoked whenever a row is updated, inserted or deleted. |
||
4821 | ** ^Any callback set by a previous call to this function |
||
4822 | ** for the same database connection is overridden. |
||
4823 | ** |
||
4824 | ** ^The second argument is a pointer to the function to invoke when a |
||
4825 | ** row is updated, inserted or deleted. |
||
4826 | ** ^The first argument to the callback is a copy of the third argument |
||
4827 | ** to sqlite3_update_hook(). |
||
4828 | ** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE], |
||
4829 | ** or [SQLITE_UPDATE], depending on the operation that caused the callback |
||
4830 | ** to be invoked. |
||
4831 | ** ^The third and fourth arguments to the callback contain pointers to the |
||
4832 | ** database and table name containing the affected row. |
||
4833 | ** ^The final callback parameter is the [rowid] of the row. |
||
4834 | ** ^In the case of an update, this is the [rowid] after the update takes place. |
||
4835 | ** |
||
4836 | ** ^(The update hook is not invoked when internal system tables are |
||
4837 | ** modified (i.e. sqlite_master and sqlite_sequence).)^ |
||
4838 | ** |
||
4839 | ** ^In the current implementation, the update hook |
||
4840 | ** is not invoked when duplication rows are deleted because of an |
||
4841 | ** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook |
||
4842 | ** invoked when rows are deleted using the [truncate optimization]. |
||
4843 | ** The exceptions defined in this paragraph might change in a future |
||
4844 | ** release of SQLite. |
||
4845 | ** |
||
4846 | ** The update hook implementation must not do anything that will modify |
||
4847 | ** the database connection that invoked the update hook. Any actions |
||
4848 | ** to modify the database connection must be deferred until after the |
||
4849 | ** completion of the [sqlite3_step()] call that triggered the update hook. |
||
4850 | ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their |
||
4851 | ** database connections for the meaning of "modify" in this paragraph. |
||
4852 | ** |
||
4853 | ** ^The sqlite3_update_hook(D,C,P) function |
||
4854 | ** returns the P argument from the previous call |
||
4855 | ** on the same [database connection] D, or NULL for |
||
4856 | ** the first call on D. |
||
4857 | ** |
||
4858 | ** See also the [sqlite3_commit_hook()] and [sqlite3_rollback_hook()] |
||
4859 | ** interfaces. |
||
4860 | */ |
||
4861 | //SQLITE_API void *sqlite3_update_hook( |
||
4862 | // sqlite3*, |
||
4863 | // void()(void *,int ,char const *,char const *,sqlite3_int64), |
||
4864 | // void* |
||
4865 | //); |
||
4866 | |||
4867 | /* |
||
4868 | ** CAPI3REF: Enable Or Disable Shared Pager Cache |
||
4869 | ** KEYWORDS: {shared cache} |
||
4870 | ** |
||
4871 | ** ^(This routine enables or disables the sharing of the database cache |
||
4872 | ** and schema data structures between [database connection | connections] |
||
4873 | ** to the same database. Sharing is enabled if the argument is true |
||
4874 | ** and disabled if the argument is false.)^ |
||
4875 | ** |
||
4876 | ** ^Cache sharing is enabled and disabled for an entire process. |
||
4877 | ** This is a change as of SQLite version 3.5.0. In prior versions of SQLite, |
||
4878 | ** sharing was enabled or disabled for each thread separately. |
||
4879 | ** |
||
4880 | ** ^(The cache sharing mode set by this interface effects all subsequent |
||
4881 | ** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()]. |
||
4882 | ** Existing database connections continue use the sharing mode |
||
4883 | ** that was in effect at the time they were opened.)^ |
||
4884 | ** |
||
4885 | ** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled |
||
4886 | ** successfully. An [error code] is returned otherwise.)^ |
||
4887 | ** |
||
4888 | ** ^Shared cache is disabled by default. But this might change in |
||
4889 | ** future releases of SQLite. Applications that care about shared |
||
4890 | ** cache setting should set it explicitly. |
||
4891 | ** |
||
4892 | ** See Also: [SQLite Shared-Cache Mode] |
||
4893 | */ |
||
4894 | //SQLITE_API int sqlite3_enable_shared_cache(int); |
||
4895 | |||
4896 | /* |
||
4897 | ** CAPI3REF: Attempt To Free Heap Memory |
||
4898 | ** |
||
4899 | ** ^The sqlite3_release_memory() interface attempts to free N bytes |
||
4900 | ** of heap memory by deallocating non-essential memory allocations |
||
4901 | ** held by the database library. Memory used to cache database |
||
4902 | ** pages to improve performance is an example of non-essential memory. |
||
4903 | ** ^sqlite3_release_memory() returns the number of bytes actually freed, |
||
4904 | ** which might be more or less than the amount requested. |
||
4905 | ** ^The sqlite3_release_memory() routine is a no-op returning zero |
||
4906 | ** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT]. |
||
4907 | */ |
||
4908 | //SQLITE_API int sqlite3_release_memory(int); |
||
4909 | |||
4910 | /* |
||
4911 | ** CAPI3REF: Impose A Limit On Heap Size |
||
4912 | ** |
||
4913 | ** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the |
||
4914 | ** soft limit on the amount of heap memory that may be allocated by SQLite. |
||
4915 | ** ^SQLite strives to keep heap memory utilization below the soft heap |
||
4916 | ** limit by reducing the number of pages held in the page cache |
||
4917 | ** as heap memory usages approaches the limit. |
||
4918 | ** ^The soft heap limit is "soft" because even though SQLite strives to stay |
||
4919 | ** below the limit, it will exceed the limit rather than generate |
||
4920 | ** an [SQLITE_NOMEM] error. In other words, the soft heap limit |
||
4921 | ** is advisory only. |
||
4922 | ** |
||
4923 | ** ^The return value from sqlite3_soft_heap_limit64() is the size of |
||
4924 | ** the soft heap limit prior to the call. ^If the argument N is negative |
||
4925 | ** then no change is made to the soft heap limit. Hence, the current |
||
4926 | ** size of the soft heap limit can be determined by invoking |
||
4927 | ** sqlite3_soft_heap_limit64() with a negative argument. |
||
4928 | ** |
||
4929 | ** ^If the argument N is zero then the soft heap limit is disabled. |
||
4930 | ** |
||
4931 | ** ^(The soft heap limit is not enforced in the current implementation |
||
4932 | ** if one or more of following conditions are true: |
||
4933 | ** |
||
4934 | ** <ul> |
||
4935 | ** <li> The soft heap limit is set to zero. |
||
4936 | ** <li> Memory accounting is disabled using a combination of the |
||
4937 | ** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and |
||
4938 | ** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option. |
||
4939 | ** <li> An alternative page cache implementation is specified using |
||
4940 | ** [sqlite3_config]([SQLITE_CONFIG_PCACHE],...). |
||
4941 | ** <li> The page cache allocates from its own memory pool supplied |
||
4942 | ** by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than |
||
4943 | ** from the heap. |
||
4944 | ** </ul>)^ |
||
4945 | ** |
||
4946 | ** Beginning with SQLite version 3.7.3, the soft heap limit is enforced |
||
4947 | ** regardless of whether or not the [SQLITE_ENABLE_MEMORY_MANAGEMENT] |
||
4948 | ** compile-time option is invoked. With [SQLITE_ENABLE_MEMORY_MANAGEMENT], |
||
4949 | ** the soft heap limit is enforced on every memory allocation. Without |
||
4950 | ** [SQLITE_ENABLE_MEMORY_MANAGEMENT], the soft heap limit is only enforced |
||
4951 | ** when memory is allocated by the page cache. Testing suggests that because |
||
4952 | ** the page cache is the predominate memory user in SQLite, most |
||
4953 | ** applications will achieve adequate soft heap limit enforcement without |
||
4954 | ** the use of [SQLITE_ENABLE_MEMORY_MANAGEMENT]. |
||
4955 | ** |
||
4956 | ** The circumstances under which SQLite will enforce the soft heap limit may |
||
4957 | ** changes in future releases of SQLite. |
||
4958 | */ |
||
4959 | //SQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N); |
||
4960 | |||
4961 | /* |
||
4962 | ** CAPI3REF: Deprecated Soft Heap Limit Interface |
||
4963 | ** DEPRECATED |
||
4964 | ** |
||
4965 | ** This is a deprecated version of the [sqlite3_soft_heap_limit64()] |
||
4966 | ** interface. This routine is provided for historical compatibility |
||
4967 | ** only. All new applications should use the |
||
4968 | ** [sqlite3_soft_heap_limit64()] interface rather than this one. |
||
4969 | */ |
||
4970 | //SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_limit(int N); |
||
4971 | |||
4972 | |||
4973 | /* |
||
4974 | ** CAPI3REF: Extract Metadata About A Column Of A Table |
||
4975 | ** |
||
4976 | ** ^This routine returns metadata about a specific column of a specific |
||
4977 | ** database table accessible using the [database connection] handle |
||
4978 | ** passed as the first function argument. |
||
4979 | ** |
||
4980 | ** ^The column is identified by the second, third and fourth parameters to |
||
4981 | ** this function. ^The second parameter is either the name of the database |
||
4982 | ** (i.e. "main", "temp", or an attached database) containing the specified |
||
4983 | ** table or NULL. ^If it is NULL, then all attached databases are searched |
||
4984 | ** for the table using the same algorithm used by the database engine to |
||
4985 | ** resolve unqualified table references. |
||
4986 | ** |
||
4987 | ** ^The third and fourth parameters to this function are the table and column |
||
4988 | ** name of the desired column, respectively. Neither of these parameters |
||
4989 | ** may be NULL. |
||
4990 | ** |
||
4991 | ** ^Metadata is returned by writing to the memory locations passed as the 5th |
||
4992 | ** and subsequent parameters to this function. ^Any of these arguments may be |
||
4993 | ** NULL, in which case the corresponding element of metadata is omitted. |
||
4994 | ** |
||
4995 | ** ^(<blockquote> |
||
4996 | ** <table border="1"> |
||
4997 | ** <tr><th> Parameter <th> Output<br>Type <th> Description |
||
4998 | ** |
||
4999 | ** <tr><td> 5th <td> const char* <td> Data type |
||
5000 | ** <tr><td> 6th <td> const char* <td> Name of default collation sequence |
||
5001 | ** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint |
||
5002 | ** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY |
||
5003 | ** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT] |
||
5004 | ** </table> |
||
5005 | ** </blockquote>)^ |
||
5006 | ** |
||
5007 | ** ^The memory pointed to by the character pointers returned for the |
||
5008 | ** declaration type and collation sequence is valid only until the next |
||
5009 | ** call to any SQLite API function. |
||
5010 | ** |
||
5011 | ** ^If the specified table is actually a view, an [error code] is returned. |
||
5012 | ** |
||
5013 | ** ^If the specified column is "rowid", "oid" or "_rowid_" and an |
||
5014 | ** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output |
||
5015 | ** parameters are set for the explicitly declared column. ^(If there is no |
||
5016 | ** explicitly declared [INTEGER PRIMARY KEY] column, then the output |
||
5017 | ** parameters are set as follows: |
||
5018 | ** |
||
5019 | ** <pre> |
||
5020 | ** data type: "INTEGER" |
||
5021 | ** collation sequence: "BINARY" |
||
5022 | ** not null: 0 |
||
5023 | ** primary key: 1 |
||
5024 | ** auto increment: 0 |
||
5025 | ** </pre>)^ |
||
5026 | ** |
||
5027 | ** ^(This function may load one or more schemas from database files. If an |
||
5028 | ** error occurs during this process, or if the requested table or column |
||
5029 | ** cannot be found, an [error code] is returned and an error message left |
||
5030 | ** in the [database connection] (to be retrieved using sqlite3_errmsg()).)^ |
||
5031 | ** |
||
5032 | ** ^This API is only available if the library was compiled with the |
||
5033 | ** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined. |
||
5034 | */ |
||
5035 | //SQLITE_API int sqlite3_table_column_metadata( |
||
5036 | // sqlite3 db, /* Connection handle */ |
||
5037 | // string zDbName, /* Database name or NULL */ |
||
5038 | // string zTableName, /* Table name */ |
||
5039 | // string zColumnName, /* Column name */ |
||
5040 | // char const **pzDataType, /* OUTPUT: Declared data type */ |
||
5041 | // char const **pzCollSeq, /* OUTPUT: Collation sequence name */ |
||
5042 | // int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */ |
||
5043 | // int *pPrimaryKey, /* OUTPUT: True if column part of PK */ |
||
5044 | // int *pAutoinc /* OUTPUT: True if column is auto-increment */ |
||
5045 | //); |
||
5046 | |||
5047 | /* |
||
5048 | ** CAPI3REF: Load An Extension |
||
5049 | ** |
||
5050 | ** ^This interface loads an SQLite extension library from the named file. |
||
5051 | ** |
||
5052 | ** ^The sqlite3_load_extension() interface attempts to load an |
||
5053 | ** SQLite extension library contained in the file zFile. |
||
5054 | ** |
||
5055 | ** ^The entry point is zProc. |
||
5056 | ** ^zProc may be 0, in which case the name of the entry point |
||
5057 | ** defaults to "sqlite3_extension_init". |
||
5058 | ** ^The sqlite3_load_extension() interface returns |
||
5059 | ** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong. |
||
5060 | ** ^If an error occurs and pzErrMsg is not 0, then the |
||
5061 | ** [sqlite3_load_extension()] interface shall attempt to |
||
5062 | ** fill *pzErrMsg with error message text stored in memory |
||
5063 | ** obtained from [sqlite3_malloc()]. The calling function |
||
5064 | ** should free this memory by calling [sqlite3_free()]. |
||
5065 | ** |
||
5066 | ** ^Extension loading must be enabled using |
||
5067 | ** [sqlite3_enable_load_extension()] prior to calling this API, |
||
5068 | ** otherwise an error will be returned. |
||
5069 | ** |
||
5070 | ** See also the [load_extension() SQL function]. |
||
5071 | */ |
||
5072 | //SQLITE_API int sqlite3_load_extension( |
||
5073 | // sqlite3 db, /* Load the extension into this database connection */ |
||
5074 | // string zFile, /* Name of the shared library containing extension */ |
||
5075 | // string zProc, /* Entry point. Derived from zFile if 0 */ |
||
5076 | // char **pzErrMsg /* Put error message here if not 0 */ |
||
5077 | //); |
||
5078 | |||
5079 | /* |
||
5080 | ** CAPI3REF: Enable Or Disable Extension Loading |
||
5081 | ** |
||
5082 | ** ^So as not to open security holes in older applications that are |
||
5083 | ** unprepared to deal with extension loading, and as a means of disabling |
||
5084 | ** extension loading while evaluating user-entered SQL, the following API |
||
5085 | ** is provided to turn the [sqlite3_load_extension()] mechanism on and off. |
||
5086 | ** |
||
5087 | ** ^Extension loading is off by default. See ticket #1863. |
||
5088 | ** ^Call the sqlite3_enable_load_extension() routine with onoff==1 |
||
5089 | ** to turn extension loading on and call it with onoff==0 to turn |
||
5090 | ** it back off again. |
||
5091 | */ |
||
5092 | //SQLITE_API int sqlite3_enable_load_extension(sqlite3 db, int onoff); |
||
5093 | |||
5094 | /* |
||
5095 | ** CAPI3REF: Automatically Load Statically Linked Extensions |
||
5096 | ** |
||
5097 | ** ^This interface causes the xEntryPoint() function to be invoked for |
||
5098 | ** each new [database connection] that is created. The idea here is that |
||
5099 | ** xEntryPoint() is the entry point for a statically linked SQLite extension |
||
5100 | ** that is to be automatically loaded into all new database connections. |
||
5101 | ** |
||
5102 | ** ^(Even though the function prototype shows that xEntryPoint() takes |
||
5103 | ** no arguments and returns void, SQLite invokes xEntryPoint() with three |
||
5104 | ** arguments and expects and integer result as if the signature of the |
||
5105 | ** entry point where as follows: |
||
5106 | ** |
||
5107 | ** <blockquote><pre> |
||
5108 | ** int xEntryPoint( |
||
5109 | ** sqlite3 db, |
||
5110 | ** string *pzErrMsg, |
||
5111 | ** const struct sqlite3_api_routines *pThunk |
||
5112 | ** ); |
||
5113 | ** </pre></blockquote>)^ |
||
5114 | ** |
||
5115 | ** If the xEntryPoint routine encounters an error, it should make *pzErrMsg |
||
5116 | ** point to an appropriate error message (obtained from [sqlite3_mprintf()]) |
||
5117 | ** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg |
||
5118 | ** is NULL before calling the xEntryPoint(). ^SQLite will invoke |
||
5119 | ** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any |
||
5120 | ** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()], |
||
5121 | ** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail. |
||
5122 | ** |
||
5123 | ** ^Calling sqlite3_auto_extension(X) with an entry point X that is already |
||
5124 | ** on the list of automatic extensions is a harmless no-op. ^No entry point |
||
5125 | ** will be called more than once for each database connection that is opened. |
||
5126 | ** |
||
5127 | ** See also: [sqlite3_reset_auto_extension()]. |
||
5128 | */ |
||
5129 | //SQLITE_API int sqlite3_auto_extension(void (*xEntryPoint)(void)); |
||
5130 | |||
5131 | /* |
||
5132 | ** CAPI3REF: Reset Automatic Extension Loading |
||
5133 | ** |
||
5134 | ** ^This interface disables all automatic extensions previously |
||
5135 | ** registered using [sqlite3_auto_extension()]. |
||
5136 | */ |
||
5137 | //SQLITE_API void sqlite3_reset_auto_extension(void); |
||
5138 | |||
5139 | /* |
||
5140 | ** The interface to the virtual-table mechanism is currently considered |
||
5141 | ** to be experimental. The interface might change in incompatible ways. |
||
5142 | ** If this is a problem for you, do not use the interface at this time. |
||
5143 | ** |
||
5144 | ** When the virtual-table mechanism stabilizes, we will declare the |
||
5145 | ** interface fixed, support it indefinitely, and remove this comment. |
||
5146 | */ |
||
5147 | |||
5148 | /* |
||
5149 | ** Structures used by the virtual table interface |
||
5150 | */ |
||
5151 | //typedef struct sqlite3_vtab sqlite3_vtab; |
||
5152 | //typedef struct sqlite3_index_info sqlite3_index_info; |
||
5153 | //typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor; |
||
5154 | //typedef struct sqlite3_module sqlite3_module; |
||
5155 | |||
5156 | /* |
||
5157 | ** CAPI3REF: Virtual Table Object |
||
5158 | ** KEYWORDS: sqlite3_module {virtual table module} |
||
5159 | ** |
||
5160 | ** This structure, sometimes called a "virtual table module", |
||
5161 | ** defines the implementation of a [virtual tables]. |
||
5162 | ** This structure consists mostly of methods for the module. |
||
5163 | ** |
||
5164 | ** ^A virtual table module is created by filling in a persistent |
||
5165 | ** instance of this structure and passing a pointer to that instance |
||
5166 | ** to [sqlite3_create_module()] or [sqlite3_create_module_v2()]. |
||
5167 | ** ^The registration remains valid until it is replaced by a different |
||
5168 | ** module or until the [database connection] closes. The content |
||
5169 | ** of this structure must not change while it is registered with |
||
5170 | ** any database connection. |
||
5171 | */ |
||
5172 | //struct sqlite3_module { |
||
5173 | // int iVersion; |
||
5174 | // int (*xCreate)(sqlite3*, object *pAux, |
||
5175 | // int argc, string[] argv, |
||
5176 | // sqlite3_vtab **ppVTab, char*); |
||
5177 | // int (*xConnect)(sqlite3*, object *pAux, |
||
5178 | // int argc, string[] argv, |
||
5179 | // sqlite3_vtab **ppVTab, char*); |
||
5180 | // int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info); |
||
5181 | // int (*xDisconnect)(sqlite3_vtab *pVTab); |
||
5182 | // int (*xDestroy)(sqlite3_vtab *pVTab); |
||
5183 | // int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor); |
||
5184 | // int (*xClose)(sqlite3_vtab_cursor); |
||
5185 | // int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, string idxStr, |
||
5186 | // int argc, sqlite3_value **argv); |
||
5187 | // int (*xNext)(sqlite3_vtab_cursor); |
||
5188 | // int (*xEof)(sqlite3_vtab_cursor); |
||
5189 | // int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int); |
||
5190 | // int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid); |
||
5191 | // int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 ); |
||
5192 | // int (*xBegin)(sqlite3_vtab *pVTab); |
||
5193 | // int (*xSync)(sqlite3_vtab *pVTab); |
||
5194 | // int (*xCommit)(sqlite3_vtab *pVTab); |
||
5195 | // int (*xRollback)(sqlite3_vtab *pVTab); |
||
5196 | // int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, string zName, |
||
5197 | // void (**pxFunc)(sqlite3_context*,int,sqlite3_value*), |
||
5198 | // void **ppArg); |
||
5199 | // int (*xRename)(sqlite3_vtab *pVtab, string zNew); |
||
5200 | ///* The methods above are in version 1 of the sqlite_module object. Those |
||
5201 | //** below are for version 2 and greater. */ |
||
5202 | //int (*xSavepoint)(sqlite3_vtab *pVTab, int); |
||
5203 | //int (*xRelease)(sqlite3_vtab *pVTab, int); |
||
5204 | //int (*xRollbackTo)(sqlite3_vtab *pVTab, int); |
||
5205 | //}; |
||
5206 | // MINIMAL STRUCTURE |
||
5207 | public class sqlite3_module |
||
5208 | { |
||
5209 | public int iVersion; |
||
5210 | public smdxCreateConnect xCreate; |
||
5211 | public smdxCreateConnect xConnect; |
||
5212 | public smdxBestIndex xBestIndex; |
||
5213 | public smdxDisconnect xDisconnect; |
||
5214 | public smdxDestroy xDestroy; |
||
5215 | public smdxOpen xOpen; |
||
5216 | public smdxClose xClose; |
||
5217 | public smdxFilter xFilter; |
||
5218 | public smdxNext xNext; |
||
5219 | public smdxEof xEof; |
||
5220 | public smdxColumn xColumn; |
||
5221 | public smdxRowid xRowid; |
||
5222 | public smdxUpdate xUpdate; |
||
5223 | public smdxFunction xBegin; |
||
5224 | public smdxFunction xSync; |
||
5225 | public smdxFunction xCommit; |
||
5226 | public smdxFunction xRollback; |
||
5227 | public smdxFindFunction xFindFunction; |
||
5228 | public smdxRename xRename; |
||
5229 | /* The methods above are in version 1 of the sqlite_module object. Those |
||
5230 | ** below are for version 2 and greater. */ |
||
5231 | public smdxFunctionArg xSavepoint; |
||
5232 | public smdxFunctionArg xRelease; |
||
5233 | public smdxFunctionArg xRollbackTo; |
||
5234 | |||
5235 | //Version 1 |
||
5236 | public sqlite3_module( |
||
5237 | int iVersion, |
||
5238 | smdxCreateConnect xCreate, |
||
5239 | smdxCreateConnect xConnect, |
||
5240 | smdxBestIndex xBestIndex, |
||
5241 | smdxDisconnect xDisconnect, |
||
5242 | smdxDestroy xDestroy, |
||
5243 | smdxOpen xOpen, |
||
5244 | smdxClose xClose, |
||
5245 | smdxFilter xFilter, |
||
5246 | smdxNext xNext, |
||
5247 | smdxEof xEof, |
||
5248 | smdxColumn xColumn, |
||
5249 | smdxRowid xRowid, |
||
5250 | smdxUpdate xUpdate, |
||
5251 | smdxFunction xBegin, |
||
5252 | smdxFunction xSync, |
||
5253 | smdxFunction xCommit, |
||
5254 | smdxFunction xRollback, |
||
5255 | smdxFindFunction xFindFunction, |
||
5256 | smdxRename xRename ) |
||
5257 | { |
||
5258 | this.iVersion = iVersion; |
||
5259 | this.xCreate = xCreate; |
||
5260 | this.xConnect = xConnect; |
||
5261 | this.xBestIndex = xBestIndex; |
||
5262 | this.xDisconnect = xDisconnect; |
||
5263 | this.xDestroy = xDestroy; |
||
5264 | this.xOpen = xOpen; |
||
5265 | this.xClose = xClose; |
||
5266 | this.xFilter = xFilter; |
||
5267 | this.xNext = xNext; |
||
5268 | this.xEof = xEof; |
||
5269 | this.xColumn = xColumn; |
||
5270 | this.xRowid = xRowid; |
||
5271 | this.xUpdate = xUpdate; |
||
5272 | this.xBegin = xBegin; |
||
5273 | this.xSync = xSync; |
||
5274 | this.xCommit = xCommit; |
||
5275 | this.xRollback = xRollback; |
||
5276 | this.xFindFunction = xFindFunction; |
||
5277 | this.xRename = xRename; |
||
5278 | } |
||
5279 | |||
5280 | //Version 2 |
||
5281 | public sqlite3_module( |
||
5282 | int iVersion, |
||
5283 | smdxCreateConnect xCreate, |
||
5284 | smdxCreateConnect xConnect, |
||
5285 | smdxBestIndex xBestIndex, |
||
5286 | smdxDisconnect xDisconnect, |
||
5287 | smdxDestroy xDestroy, |
||
5288 | smdxOpen xOpen, |
||
5289 | smdxClose xClose, |
||
5290 | smdxFilter xFilter, |
||
5291 | smdxNext xNext, |
||
5292 | smdxEof xEof, |
||
5293 | smdxColumn xColumn, |
||
5294 | smdxRowid xRowid, |
||
5295 | smdxUpdate xUpdate, |
||
5296 | smdxFunction xBegin, |
||
5297 | smdxFunction xSync, |
||
5298 | smdxFunction xCommit, |
||
5299 | smdxFunction xRollback, |
||
5300 | smdxFindFunction xFindFunction, |
||
5301 | smdxRename xRename, |
||
5302 | /* The methods above are in version 1 of the sqlite_module object. Those |
||
5303 | ** below are for version 2 and greater. */ |
||
5304 | smdxFunctionArg xSavepoint, |
||
5305 | smdxFunctionArg xRelease, |
||
5306 | smdxFunctionArg xRollbackTo |
||
5307 | ) |
||
5308 | { |
||
5309 | this.iVersion = iVersion; |
||
5310 | this.xCreate = xCreate; |
||
5311 | this.xConnect = xConnect; |
||
5312 | this.xBestIndex = xBestIndex; |
||
5313 | this.xDisconnect = xDisconnect; |
||
5314 | this.xDestroy = xDestroy; |
||
5315 | this.xOpen = xOpen; |
||
5316 | this.xClose = xClose; |
||
5317 | this.xFilter = xFilter; |
||
5318 | this.xNext = xNext; |
||
5319 | this.xEof = xEof; |
||
5320 | this.xColumn = xColumn; |
||
5321 | this.xRowid = xRowid; |
||
5322 | this.xUpdate = xUpdate; |
||
5323 | this.xBegin = xBegin; |
||
5324 | this.xSync = xSync; |
||
5325 | this.xCommit = xCommit; |
||
5326 | this.xRollback = xRollback; |
||
5327 | this.xFindFunction = xFindFunction; |
||
5328 | this.xRename = xRename; |
||
5329 | this.xSavepoint = xSavepoint; |
||
5330 | this.xRelease = xRelease; |
||
5331 | this.xRollbackTo = xRollbackTo; |
||
5332 | } |
||
5333 | } |
||
5334 | |||
5335 | |||
5336 | /* |
||
5337 | ** CAPI3REF: Virtual Table Indexing Information |
||
5338 | ** KEYWORDS: sqlite3_index_info |
||
5339 | ** |
||
5340 | ** The sqlite3_index_info structure and its substructures is used as part |
||
5341 | ** of the [virtual table] interface to |
||
5342 | ** pass information into and receive the reply from the [xBestIndex] |
||
5343 | ** method of a [virtual table module]. The fields under **Inputs** are the |
||
5344 | ** inputs to xBestIndex and are read-only. xBestIndex inserts its |
||
5345 | ** results into the **Outputs** fields. |
||
5346 | ** |
||
5347 | ** ^(The aConstraint[] array records WHERE clause constraints of the form: |
||
5348 | ** |
||
5349 | ** <blockquote>column OP expr</blockquote> |
||
5350 | ** |
||
5351 | ** where OP is =, <, <=, >, or >=.)^ ^(The particular operator is |
||
5352 | ** stored in aConstraint[].op using one of the |
||
5353 | ** [SQLITE_INDEX_CONSTRAINT_EQ | SQLITE_INDEX_CONSTRAINT_ values].)^ |
||
5354 | ** ^(The index of the column is stored in |
||
5355 | ** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the |
||
5356 | ** expr on the right-hand side can be evaluated (and thus the constraint |
||
5357 | ** is usable) and false if it cannot.)^ |
||
5358 | ** |
||
5359 | ** ^The optimizer automatically inverts terms of the form "expr OP column" |
||
5360 | ** and makes other simplifications to the WHERE clause in an attempt to |
||
5361 | ** get as many WHERE clause terms into the form shown above as possible. |
||
5362 | ** ^The aConstraint[] array only reports WHERE clause terms that are |
||
5363 | ** relevant to the particular virtual table being queried. |
||
5364 | ** |
||
5365 | ** ^Information about the ORDER BY clause is stored in aOrderBy[]. |
||
5366 | ** ^Each term of aOrderBy records a column of the ORDER BY clause. |
||
5367 | ** |
||
5368 | ** The [xBestIndex] method must fill aConstraintUsage[] with information |
||
5369 | ** about what parameters to pass to xFilter. ^If argvIndex>0 then |
||
5370 | ** the right-hand side of the corresponding aConstraint[] is evaluated |
||
5371 | ** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit |
||
5372 | ** is true, then the constraint is assumed to be fully handled by the |
||
5373 | ** virtual table and is not checked again by SQLite.)^ |
||
5374 | ** |
||
5375 | ** ^The idxNum and idxPtr values are recorded and passed into the |
||
5376 | ** [xFilter] method. |
||
5377 | ** ^[sqlite3_free()] is used to free idxPtr if and only if |
||
5378 | ** needToFreeIdxPtr is true. |
||
5379 | ** |
||
5380 | ** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in |
||
5381 | ** the correct order to satisfy the ORDER BY clause so that no separate |
||
5382 | ** sorting step is required. |
||
5383 | ** |
||
5384 | ** ^The estimatedCost value is an estimate of the cost of doing the |
||
5385 | ** particular lookup. A full scan of a table with N entries should have |
||
5386 | ** a cost of N. A binary search of a table of N entries should have a |
||
5387 | ** cost of approximately log(N). |
||
5388 | */ |
||
5389 | //struct sqlite3_index_info { |
||
5390 | // /* Inputs */ |
||
5391 | // int nConstraint; /* Number of entries in aConstraint */ |
||
5392 | // struct sqlite3_index_constraint { |
||
5393 | // int iColumn; /* Column on left-hand side of constraint */ |
||
5394 | // unsigned char op; /* Constraint operator */ |
||
5395 | // unsigned char usable; /* True if this constraint is usable */ |
||
5396 | // int iTermOffset; /* Used internally - xBestIndex should ignore */ |
||
5397 | // } *aConstraint; /* Table of WHERE clause constraints */ |
||
5398 | // int nOrderBy; /* Number of terms in the ORDER BY clause */ |
||
5399 | // struct sqlite3_index_orderby { |
||
5400 | // int iColumn; /* Column number */ |
||
5401 | // unsigned char desc; /* True for DESC. False for ASC. */ |
||
5402 | // } *aOrderBy; /* The ORDER BY clause */ |
||
5403 | // /* Outputs */ |
||
5404 | // struct sqlite3_index_constraint_usage { |
||
5405 | // int argvIndex; /* if >0, constraint is part of argv to xFilter */ |
||
5406 | // unsigned char omit; /* Do not code a test for this constraint */ |
||
5407 | // } *aConstraintUsage; |
||
5408 | // int idxNum; /* Number used to identify the index */ |
||
5409 | // char *idxStr; /* String, possibly obtained from sqlite3_malloc */ |
||
5410 | // int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ |
||
5411 | // int orderByConsumed; /* True if output is already ordered */ |
||
5412 | // double estimatedCost; /* Estimated cost of using this index */ |
||
5413 | //}; |
||
5414 | public class sqlite3_index_constraint |
||
5415 | { |
||
5416 | public int iColumn; /* Column on left-hand side of constraint */ |
||
5417 | public int op; /* Constraint operator */ |
||
5418 | public bool usable; /* True if this constraint is usable */ |
||
5419 | public int iTermOffset; /* Used internally - xBestIndex should ignore */ |
||
5420 | } |
||
5421 | public class sqlite3_index_orderby |
||
5422 | { |
||
5423 | public int iColumn; /* Column number */ |
||
5424 | public bool desc; /* True for DESC. False for ASC. */ |
||
5425 | } |
||
5426 | public class sqlite3_index_constraint_usage |
||
5427 | { |
||
5428 | public int argvIndex; /* if >0, constraint is part of argv to xFilter */ |
||
5429 | public bool omit; /* Do not code a test for this constraint */ |
||
5430 | } |
||
5431 | |||
5432 | public class sqlite3_index_info |
||
5433 | { |
||
5434 | /* Inputs */ |
||
5435 | public int nConstraint; /* Number of entries in aConstraint */ |
||
5436 | public sqlite3_index_constraint[] aConstraint; /* Table of WHERE clause constraints */ |
||
5437 | public int nOrderBy; /* Number of terms in the ORDER BY clause */ |
||
5438 | public sqlite3_index_orderby[] aOrderBy;/* The ORDER BY clause */ |
||
5439 | |||
5440 | /* Outputs */ |
||
5441 | |||
5442 | public sqlite3_index_constraint_usage[] aConstraintUsage; |
||
5443 | public int idxNum; /* Number used to identify the index */ |
||
5444 | public string idxStr; /* String, possibly obtained from sqlite3Malloc */ |
||
5445 | public int needToFreeIdxStr; /* Free idxStr using sqlite3DbFree(db,) if true */ |
||
5446 | public bool orderByConsumed; /* True if output is already ordered */ |
||
5447 | public double estimatedCost; /* Estimated cost of using this index */ |
||
5448 | } |
||
5449 | |||
5450 | /* |
||
5451 | ** CAPI3REF: Virtual Table Constraint Operator Codes |
||
5452 | ** |
||
5453 | ** These macros defined the allowed values for the |
||
5454 | ** [sqlite3_index_info].aConstraint[].op field. Each value represents |
||
5455 | ** an operator that is part of a constraint term in the wHERE clause of |
||
5456 | ** a query that uses a [virtual table]. |
||
5457 | */ |
||
5458 | //#define SQLITE_INDEX_CONSTRAINT_EQ 2 |
||
5459 | //#define SQLITE_INDEX_CONSTRAINT_GT 4 |
||
5460 | //#define SQLITE_INDEX_CONSTRAINT_LE 8 |
||
5461 | //#define SQLITE_INDEX_CONSTRAINT_LT 16 |
||
5462 | //#define SQLITE_INDEX_CONSTRAINT_GE 32 |
||
5463 | //#define SQLITE_INDEX_CONSTRAINT_MATCH 64 |
||
5464 | const int SQLITE_INDEX_CONSTRAINT_EQ = 2; |
||
5465 | const int SQLITE_INDEX_CONSTRAINT_GT = 4; |
||
5466 | const int SQLITE_INDEX_CONSTRAINT_LE = 8; |
||
5467 | const int SQLITE_INDEX_CONSTRAINT_LT = 16; |
||
5468 | const int SQLITE_INDEX_CONSTRAINT_GE = 32; |
||
5469 | const int SQLITE_INDEX_CONSTRAINT_MATCH = 64; |
||
5470 | |||
5471 | /* |
||
5472 | ** CAPI3REF: Register A Virtual Table Implementation |
||
5473 | ** |
||
5474 | ** ^These routines are used to register a new [virtual table module] name. |
||
5475 | ** ^Module names must be registered before |
||
5476 | ** creating a new [virtual table] using the module and before using a |
||
5477 | ** preexisting [virtual table] for the module. |
||
5478 | ** |
||
5479 | ** ^The module name is registered on the [database connection] specified |
||
5480 | ** by the first parameter. ^The name of the module is given by the |
||
5481 | ** second parameter. ^The third parameter is a pointer to |
||
5482 | ** the implementation of the [virtual table module]. ^The fourth |
||
5483 | ** parameter is an arbitrary client data pointer that is passed through |
||
5484 | ** into the [xCreate] and [xConnect] methods of the virtual table module |
||
5485 | ** when a new virtual table is be being created or reinitialized. |
||
5486 | ** |
||
5487 | ** ^The sqlite3_create_module_v2() interface has a fifth parameter which |
||
5488 | ** is a pointer to a destructor for the pClientData. ^SQLite will |
||
5489 | ** invoke the destructor function (if it is not NULL) when SQLite |
||
5490 | ** no longer needs the pClientData pointer. ^The destructor will also |
||
5491 | ** be invoked if the call to sqlite3_create_module_v2() fails. |
||
5492 | ** ^The sqlite3_create_module() |
||
5493 | ** interface is equivalent to sqlite3_create_module_v2() with a NULL |
||
5494 | ** destructor. |
||
5495 | */ |
||
5496 | //SQLITE_API int sqlite3_create_module( |
||
5497 | // sqlite3 db, /* SQLite connection to register module with */ |
||
5498 | // string zName, /* Name of the module */ |
||
5499 | // const sqlite3_module *p, /* Methods for the module */ |
||
5500 | // void *pClientData /* Client data for xCreate/xConnect */ |
||
5501 | //); |
||
5502 | //SQLITE_API int sqlite3_create_module_v2( |
||
5503 | // sqlite3 db, /* SQLite connection to register module with */ |
||
5504 | // string zName, /* Name of the module */ |
||
5505 | // const sqlite3_module *p, /* Methods for the module */ |
||
5506 | // void *pClientData, /* Client data for xCreate/xConnect */ |
||
5507 | // void(*xDestroy)(void) /* Module destructor function */ |
||
5508 | //); |
||
5509 | |||
5510 | /* |
||
5511 | ** CAPI3REF: Virtual Table Instance Object |
||
5512 | ** KEYWORDS: sqlite3_vtab |
||
5513 | ** |
||
5514 | ** Every [virtual table module] implementation uses a subclass |
||
5515 | ** of this object to describe a particular instance |
||
5516 | ** of the [virtual table]. Each subclass will |
||
5517 | ** be tailored to the specific needs of the module implementation. |
||
5518 | ** The purpose of this superclass is to define certain fields that are |
||
5519 | ** common to all module implementations. |
||
5520 | ** |
||
5521 | ** ^Virtual tables methods can set an error message by assigning a |
||
5522 | ** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should |
||
5523 | ** take care that any prior string is freed by a call to [sqlite3_free()] |
||
5524 | ** prior to assigning a new string to zErrMsg. ^After the error message |
||
5525 | ** is delivered up to the client application, the string will be automatically |
||
5526 | ** freed by sqlite3_free() and the zErrMsg field will be zeroed. |
||
5527 | */ |
||
5528 | //struct sqlite3_vtab { |
||
5529 | // const sqlite3_module *pModule; /* The module for this virtual table */ |
||
5530 | // int nRef; /* NO LONGER USED */ |
||
5531 | // string zErrMsg; /* Error message from sqlite3_mprintf() */ |
||
5532 | // /* Virtual table implementations will typically add additional fields */ |
||
5533 | //}; |
||
5534 | public class sqlite3_vtab |
||
5535 | { |
||
5536 | public sqlite3_module pModule; /* The module for this virtual table */ |
||
5537 | public int nRef; /* Used internally */ |
||
5538 | public string zErrMsg; /* Error message from sqlite3_mprintf() */ |
||
5539 | /* Virtual table implementations will typically add additional fields */ |
||
5540 | }; |
||
5541 | |||
5542 | /* |
||
5543 | ** CAPI3REF: Virtual Table Cursor Object |
||
5544 | ** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor} |
||
5545 | ** |
||
5546 | ** Every [virtual table module] implementation uses a subclass of the |
||
5547 | ** following structure to describe cursors that point into the |
||
5548 | ** [virtual table] and are used |
||
5549 | ** to loop through the virtual table. Cursors are created using the |
||
5550 | ** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed |
||
5551 | ** by the [sqlite3_module.xClose | xClose] method. Cursors are used |
||
5552 | ** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods |
||
5553 | ** of the module. Each module implementation will define |
||
5554 | ** the content of a cursor structure to suit its own needs. |
||
5555 | ** |
||
5556 | ** This superclass exists in order to define fields of the cursor that |
||
5557 | ** are common to all implementations. |
||
5558 | */ |
||
5559 | //struct sqlite3_vtab_cursor { |
||
5560 | // sqlite3_vtab *pVtab; /* Virtual table of this cursor */ |
||
5561 | // /* Virtual table implementations will typically add additional fields */ |
||
5562 | //}; |
||
5563 | public class sqlite3_vtab_cursor |
||
5564 | { |
||
5565 | public sqlite3_vtab pVtab; /* Virtual table of this cursor */ |
||
5566 | /* Virtual table implementations will typically add additional fields */ |
||
5567 | }; |
||
5568 | |||
5569 | /* |
||
5570 | ** CAPI3REF: Declare The Schema Of A Virtual Table |
||
5571 | ** |
||
5572 | ** ^The [xCreate] and [xConnect] methods of a |
||
5573 | ** [virtual table module] call this interface |
||
5574 | ** to declare the format (the names and datatypes of the columns) of |
||
5575 | ** the virtual tables they implement. |
||
5576 | */ |
||
5577 | //SQLITE_API int sqlite3_declare_vtab(sqlite3*, string zSQL); |
||
5578 | |||
5579 | /* |
||
5580 | ** CAPI3REF: Overload A Function For A Virtual Table |
||
5581 | ** |
||
5582 | ** ^(Virtual tables can provide alternative implementations of functions |
||
5583 | ** using the [xFindFunction] method of the [virtual table module]. |
||
5584 | ** But global versions of those functions |
||
5585 | ** must exist in order to be overloaded.)^ |
||
5586 | ** |
||
5587 | ** ^(This API makes sure a global version of a function with a particular |
||
5588 | ** name and number of parameters exists. If no such function exists |
||
5589 | ** before this API is called, a new function is created.)^ ^The implementation |
||
5590 | ** of the new function always causes an exception to be thrown. So |
||
5591 | ** the new function is not good for anything by itself. Its only |
||
5592 | ** purpose is to be a placeholder function that can be overloaded |
||
5593 | ** by a [virtual table]. |
||
5594 | */ |
||
5595 | //SQLITE_API int sqlite3_overload_function(sqlite3*, string zFuncName, int nArg); |
||
5596 | |||
5597 | /* |
||
5598 | ** The interface to the virtual-table mechanism defined above (back up |
||
5599 | ** to a comment remarkably similar to this one) is currently considered |
||
5600 | ** to be experimental. The interface might change in incompatible ways. |
||
5601 | ** If this is a problem for you, do not use the interface at this time. |
||
5602 | ** |
||
5603 | ** When the virtual-table mechanism stabilizes, we will declare the |
||
5604 | ** interface fixed, support it indefinitely, and remove this comment. |
||
5605 | */ |
||
5606 | |||
5607 | /* |
||
5608 | ** CAPI3REF: A Handle To An Open BLOB |
||
5609 | ** KEYWORDS: {BLOB handle} {BLOB handles} |
||
5610 | ** |
||
5611 | ** An instance of this object represents an open BLOB on which |
||
5612 | ** [sqlite3_blob_open | incremental BLOB I/O] can be performed. |
||
5613 | ** ^Objects of this type are created by [sqlite3_blob_open()] |
||
5614 | ** and destroyed by [sqlite3_blob_close()]. |
||
5615 | ** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces |
||
5616 | ** can be used to read or write small subsections of the BLOB. |
||
5617 | ** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes. |
||
5618 | */ |
||
5619 | //typedef struct sqlite3_blob sqlite3_blob; |
||
5620 | |||
5621 | /* |
||
5622 | ** CAPI3REF: Open A BLOB For Incremental I/O |
||
5623 | ** |
||
5624 | ** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located |
||
5625 | ** in row iRow, column zColumn, table zTable in database zDb; |
||
5626 | ** in other words, the same BLOB that would be selected by: |
||
5627 | ** |
||
5628 | ** <pre> |
||
5629 | ** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow; |
||
5630 | ** </pre>)^ |
||
5631 | ** |
||
5632 | ** ^If the flags parameter is non-zero, then the BLOB is opened for read |
||
5633 | ** and write access. ^If it is zero, the BLOB is opened for read access. |
||
5634 | ** ^It is not possible to open a column that is part of an index or primary |
||
5635 | ** key for writing. ^If [foreign key constraints] are enabled, it is |
||
5636 | ** not possible to open a column that is part of a [child key] for writing. |
||
5637 | ** |
||
5638 | ** ^Note that the database name is not the filename that contains |
||
5639 | ** the database but rather the symbolic name of the database that |
||
5640 | ** appears after the AS keyword when the database is connected using [ATTACH]. |
||
5641 | ** ^For the main database file, the database name is "main". |
||
5642 | ** ^For TEMP tables, the database name is "temp". |
||
5643 | ** |
||
5644 | ** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is written |
||
5645 | ** to *ppBlob. Otherwise an [error code] is returned and *ppBlob is set |
||
5646 | ** to be a null pointer.)^ |
||
5647 | ** ^This function sets the [database connection] error code and message |
||
5648 | ** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()] and related |
||
5649 | ** functions. ^Note that the *ppBlob variable is always initialized in a |
||
5650 | ** way that makes it safe to invoke [sqlite3_blob_close()] on *ppBlob |
||
5651 | ** regardless of the success or failure of this routine. |
||
5652 | ** |
||
5653 | ** ^(If the row that a BLOB handle points to is modified by an |
||
5654 | ** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects |
||
5655 | ** then the BLOB handle is marked as "expired". |
||
5656 | ** This is true if any column of the row is changed, even a column |
||
5657 | ** other than the one the BLOB handle is open on.)^ |
||
5658 | ** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for |
||
5659 | ** a expired BLOB handle fail with a return code of [SQLITE_ABORT]. |
||
5660 | ** ^(Changes written into a BLOB prior to the BLOB expiring are not |
||
5661 | ** rolled back by the expiration of the BLOB. Such changes will eventually |
||
5662 | ** commit if the transaction continues to completion.)^ |
||
5663 | ** |
||
5664 | ** ^Use the [sqlite3_blob_bytes()] interface to determine the size of |
||
5665 | ** the opened blob. ^The size of a blob may not be changed by this |
||
5666 | ** interface. Use the [UPDATE] SQL command to change the size of a |
||
5667 | ** blob. |
||
5668 | ** |
||
5669 | ** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces |
||
5670 | ** and the built-in [zeroblob] SQL function can be used, if desired, |
||
5671 | ** to create an empty, zero-filled blob in which to read or write using |
||
5672 | ** this interface. |
||
5673 | ** |
||
5674 | ** To avoid a resource leak, every open [BLOB handle] should eventually |
||
5675 | ** be released by a call to [sqlite3_blob_close()]. |
||
5676 | */ |
||
5677 | //SQLITE_API int sqlite3_blob_open( |
||
5678 | // sqlite3*, |
||
5679 | // string zDb, |
||
5680 | // string zTable, |
||
5681 | // string zColumn, |
||
5682 | // sqlite3_int64 iRow, |
||
5683 | // int flags, |
||
5684 | // sqlite3_blob **ppBlob |
||
5685 | //); |
||
5686 | |||
5687 | /* |
||
5688 | ** CAPI3REF: Move a BLOB Handle to a New Row |
||
5689 | ** |
||
5690 | ** ^This function is used to move an existing blob handle so that it points |
||
5691 | ** to a different row of the same database table. ^The new row is identified |
||
5692 | ** by the rowid value passed as the second argument. Only the row can be |
||
5693 | ** changed. ^The database, table and column on which the blob handle is open |
||
5694 | ** remain the same. Moving an existing blob handle to a new row can be |
||
5695 | ** faster than closing the existing handle and opening a new one. |
||
5696 | ** |
||
5697 | ** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] - |
||
5698 | ** it must exist and there must be either a blob or text value stored in |
||
5699 | ** the nominated column.)^ ^If the new row is not present in the table, or if |
||
5700 | ** it does not contain a blob or text value, or if another error occurs, an |
||
5701 | ** SQLite error code is returned and the blob handle is considered aborted. |
||
5702 | ** ^All subsequent calls to [sqlite3_blob_read()], [sqlite3_blob_write()] or |
||
5703 | ** [sqlite3_blob_reopen()] on an aborted blob handle immediately return |
||
5704 | ** SQLITE_ABORT. ^Calling [sqlite3_blob_bytes()] on an aborted blob handle |
||
5705 | ** always returns zero. |
||
5706 | ** |
||
5707 | ** ^This function sets the database handle error code and message. |
||
5708 | */ |
||
5709 | //SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64); |
||
5710 | |||
5711 | /* |
||
5712 | ** CAPI3REF: Close A BLOB Handle |
||
5713 | ** |
||
5714 | ** ^Closes an open [BLOB handle]. |
||
5715 | ** |
||
5716 | ** ^Closing a BLOB shall cause the current transaction to commit |
||
5717 | ** if there are no other BLOBs, no pending prepared statements, and the |
||
5718 | ** database connection is in [autocommit mode]. |
||
5719 | ** ^If any writes were made to the BLOB, they might be held in cache |
||
5720 | ** until the close operation if they will fit. |
||
5721 | ** |
||
5722 | ** ^(Closing the BLOB often forces the changes |
||
5723 | ** out to disk and so if any I/O errors occur, they will likely occur |
||
5724 | ** at the time when the BLOB is closed. Any errors that occur during |
||
5725 | ** closing are reported as a non-zero return value.)^ |
||
5726 | ** |
||
5727 | ** ^(The BLOB is closed unconditionally. Even if this routine returns |
||
5728 | ** an error code, the BLOB is still closed.)^ |
||
5729 | ** |
||
5730 | ** ^Calling this routine with a null pointer (such as would be returned |
||
5731 | ** by a failed call to [sqlite3_blob_open()]) is a harmless no-op. |
||
5732 | */ |
||
5733 | //SQLITE_API int sqlite3_blob_close(sqlite3_blob ); |
||
5734 | |||
5735 | /* |
||
5736 | ** CAPI3REF: Return The Size Of An Open BLOB |
||
5737 | ** |
||
5738 | ** ^Returns the size in bytes of the BLOB accessible via the |
||
5739 | ** successfully opened [BLOB handle] in its only argument. ^The |
||
5740 | ** incremental blob I/O routines can only read or overwriting existing |
||
5741 | ** blob content; they cannot change the size of a blob. |
||
5742 | ** |
||
5743 | ** This routine only works on a [BLOB handle] which has been created |
||
5744 | ** by a prior successful call to [sqlite3_blob_open()] and which has not |
||
5745 | ** been closed by [sqlite3_blob_close()]. Passing any other pointer in |
||
5746 | ** to this routine results in undefined and probably undesirable behavior. |
||
5747 | */ |
||
5748 | //SQLITE_API int sqlite3_blob_bytes(sqlite3_blob ); |
||
5749 | |||
5750 | /* |
||
5751 | ** CAPI3REF: Read Data From A BLOB Incrementally |
||
5752 | ** |
||
5753 | ** ^(This function is used to read data from an open [BLOB handle] into a |
||
5754 | ** caller-supplied buffer. N bytes of data are copied into buffer Z |
||
5755 | ** from the open BLOB, starting at offset iOffset.)^ |
||
5756 | ** |
||
5757 | ** ^If offset iOffset is less than N bytes from the end of the BLOB, |
||
5758 | ** [SQLITE_ERROR] is returned and no data is read. ^If N or iOffset is |
||
5759 | ** less than zero, [SQLITE_ERROR] is returned and no data is read. |
||
5760 | ** ^The size of the blob (and hence the maximum value of N+iOffset) |
||
5761 | ** can be determined using the [sqlite3_blob_bytes()] interface. |
||
5762 | ** |
||
5763 | ** ^An attempt to read from an expired [BLOB handle] fails with an |
||
5764 | ** error code of [SQLITE_ABORT]. |
||
5765 | ** |
||
5766 | ** ^(On success, sqlite3_blob_read() returns SQLITE_OK. |
||
5767 | ** Otherwise, an [error code] or an [extended error code] is returned.)^ |
||
5768 | ** |
||
5769 | ** This routine only works on a [BLOB handle] which has been created |
||
5770 | ** by a prior successful call to [sqlite3_blob_open()] and which has not |
||
5771 | ** been closed by [sqlite3_blob_close()]. Passing any other pointer in |
||
5772 | ** to this routine results in undefined and probably undesirable behavior. |
||
5773 | ** |
||
5774 | ** See also: [sqlite3_blob_write()]. |
||
5775 | */ |
||
5776 | //SQLITE_API int sqlite3_blob_read(sqlite3_blob *, object *Z, int N, int iOffset); |
||
5777 | |||
5778 | /* |
||
5779 | ** CAPI3REF: Write Data Into A BLOB Incrementally |
||
5780 | ** |
||
5781 | ** ^This function is used to write data into an open [BLOB handle] from a |
||
5782 | ** caller-supplied buffer. ^N bytes of data are copied from the buffer Z |
||
5783 | ** into the open BLOB, starting at offset iOffset. |
||
5784 | ** |
||
5785 | ** ^If the [BLOB handle] passed as the first argument was not opened for |
||
5786 | ** writing (the flags parameter to [sqlite3_blob_open()] was zero), |
||
5787 | ** this function returns [SQLITE_READONLY]. |
||
5788 | ** |
||
5789 | ** ^This function may only modify the contents of the BLOB; it is |
||
5790 | ** not possible to increase the size of a BLOB using this API. |
||
5791 | ** ^If offset iOffset is less than N bytes from the end of the BLOB, |
||
5792 | ** [SQLITE_ERROR] is returned and no data is written. ^If N is |
||
5793 | ** less than zero [SQLITE_ERROR] is returned and no data is written. |
||
5794 | ** The size of the BLOB (and hence the maximum value of N+iOffset) |
||
5795 | ** can be determined using the [sqlite3_blob_bytes()] interface. |
||
5796 | ** |
||
5797 | ** ^An attempt to write to an expired [BLOB handle] fails with an |
||
5798 | ** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred |
||
5799 | ** before the [BLOB handle] expired are not rolled back by the |
||
5800 | ** expiration of the handle, though of course those changes might |
||
5801 | ** have been overwritten by the statement that expired the BLOB handle |
||
5802 | ** or by other independent statements. |
||
5803 | ** |
||
5804 | ** ^(On success, sqlite3_blob_write() returns SQLITE_OK. |
||
5805 | ** Otherwise, an [error code] or an [extended error code] is returned.)^ |
||
5806 | ** |
||
5807 | ** This routine only works on a [BLOB handle] which has been created |
||
5808 | ** by a prior successful call to [sqlite3_blob_open()] and which has not |
||
5809 | ** been closed by [sqlite3_blob_close()]. Passing any other pointer in |
||
5810 | ** to this routine results in undefined and probably undesirable behavior. |
||
5811 | ** |
||
5812 | ** See also: [sqlite3_blob_read()]. |
||
5813 | */ |
||
5814 | //SQLITE_API int sqlite3_blob_write(sqlite3_blob *, string z, int n, int iOffset); |
||
5815 | |||
5816 | /* |
||
5817 | ** CAPI3REF: Virtual File System Objects |
||
5818 | ** |
||
5819 | ** A virtual filesystem (VFS) is an [sqlite3_vfs] object |
||
5820 | ** that SQLite uses to interact |
||
5821 | ** with the underlying operating system. Most SQLite builds come with a |
||
5822 | ** single default VFS that is appropriate for the host computer. |
||
5823 | ** New VFSes can be registered and existing VFSes can be unregistered. |
||
5824 | ** The following interfaces are provided. |
||
5825 | ** |
||
5826 | ** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name. |
||
5827 | ** ^Names are case sensitive. |
||
5828 | ** ^Names are zero-terminated UTF-8 strings. |
||
5829 | ** ^If there is no match, a NULL pointer is returned. |
||
5830 | ** ^If zVfsName is NULL then the default VFS is returned. |
||
5831 | ** |
||
5832 | ** ^New VFSes are registered with sqlite3_vfs_register(). |
||
5833 | ** ^Each new VFS becomes the default VFS if the makeDflt flag is set. |
||
5834 | ** ^The same VFS can be registered multiple times without injury. |
||
5835 | ** ^To make an existing VFS into the default VFS, register it again |
||
5836 | ** with the makeDflt flag set. If two different VFSes with the |
||
5837 | ** same name are registered, the behavior is undefined. If a |
||
5838 | ** VFS is registered with a name that is NULL or an empty string, |
||
5839 | ** then the behavior is undefined. |
||
5840 | ** |
||
5841 | ** ^Unregister a VFS with the sqlite3_vfs_unregister() interface. |
||
5842 | ** ^(If the default VFS is unregistered, another VFS is chosen as |
||
5843 | ** the default. The choice for the new VFS is arbitrary.)^ |
||
5844 | */ |
||
5845 | //SQLITE_API sqlite3_vfs *sqlite3_vfs_find(string zVfsName); |
||
5846 | //SQLITE_API int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt); |
||
5847 | //SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs); |
||
5848 | |||
5849 | /* |
||
5850 | ** CAPI3REF: Mutexes |
||
5851 | ** |
||
5852 | ** The SQLite core uses these routines for thread |
||
5853 | ** synchronization. Though they are intended for internal |
||
5854 | ** use by SQLite, code that links against SQLite is |
||
5855 | ** permitted to use any of these routines. |
||
5856 | ** |
||
5857 | ** The SQLite source code contains multiple implementations |
||
5858 | ** of these mutex routines. An appropriate implementation |
||
5859 | ** is selected automatically at compile-time. ^(The following |
||
5860 | ** implementations are available in the SQLite core: |
||
5861 | ** |
||
5862 | ** <ul> |
||
5863 | ** <li> SQLITE_MUTEX_OS2 |
||
5864 | ** <li> SQLITE_MUTEX_PTHREAD |
||
5865 | ** <li> SQLITE_MUTEX_W32 |
||
5866 | ** <li> SQLITE_MUTEX_NOOP |
||
5867 | ** </ul>)^ |
||
5868 | ** |
||
5869 | ** ^The SQLITE_MUTEX_NOOP implementation is a set of routines |
||
5870 | ** that does no real locking and is appropriate for use in |
||
5871 | ** a single-threaded application. ^The SQLITE_MUTEX_OS2, |
||
5872 | ** SQLITE_MUTEX_PTHREAD, and SQLITE_MUTEX_W32 implementations |
||
5873 | ** are appropriate for use on OS/2, Unix, and Windows. |
||
5874 | ** |
||
5875 | ** ^(If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor |
||
5876 | ** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex |
||
5877 | ** implementation is included with the library. In this case the |
||
5878 | ** application must supply a custom mutex implementation using the |
||
5879 | ** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function |
||
5880 | ** before calling sqlite3_initialize() or any other public sqlite3_ |
||
5881 | ** function that calls sqlite3_initialize().)^ |
||
5882 | ** |
||
5883 | ** ^The sqlite3_mutex_alloc() routine allocates a new |
||
5884 | ** mutex and returns a pointer to it. ^If it returns NULL |
||
5885 | ** that means that a mutex could not be allocated. ^SQLite |
||
5886 | ** will unwind its stack and return an error. ^(The argument |
||
5887 | ** to sqlite3_mutex_alloc() is one of these integer constants: |
||
5888 | ** |
||
5889 | ** <ul> |
||
5890 | ** <li> SQLITE_MUTEX_FAST |
||
5891 | ** <li> SQLITE_MUTEX_RECURSIVE |
||
5892 | ** <li> SQLITE_MUTEX_STATIC_MASTER |
||
5893 | ** <li> SQLITE_MUTEX_STATIC_MEM |
||
5894 | ** <li> SQLITE_MUTEX_STATIC_MEM2 |
||
5895 | ** <li> SQLITE_MUTEX_STATIC_PRNG |
||
5896 | ** <li> SQLITE_MUTEX_STATIC_LRU |
||
5897 | ** <li> SQLITE_MUTEX_STATIC_LRU2 |
||
5898 | ** </ul>)^ |
||
5899 | ** |
||
5900 | ** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) |
||
5901 | ** cause sqlite3_mutex_alloc() to create |
||
5902 | ** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE |
||
5903 | ** is used but not necessarily so when SQLITE_MUTEX_FAST is used. |
||
5904 | ** The mutex implementation does not need to make a distinction |
||
5905 | ** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does |
||
5906 | ** not want to. ^SQLite will only request a recursive mutex in |
||
5907 | ** cases where it really needs one. ^If a faster non-recursive mutex |
||
5908 | ** implementation is available on the host platform, the mutex subsystem |
||
5909 | ** might return such a mutex in response to SQLITE_MUTEX_FAST. |
||
5910 | ** |
||
5911 | ** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other |
||
5912 | ** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return |
||
5913 | ** a pointer to a static preexisting mutex. ^Six static mutexes are |
||
5914 | ** used by the current version of SQLite. Future versions of SQLite |
||
5915 | ** may add additional static mutexes. Static mutexes are for internal |
||
5916 | ** use by SQLite only. Applications that use SQLite mutexes should |
||
5917 | ** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or |
||
5918 | ** SQLITE_MUTEX_RECURSIVE. |
||
5919 | ** |
||
5920 | ** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST |
||
5921 | ** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc() |
||
5922 | ** returns a different mutex on every call. ^But for the static |
||
5923 | ** mutex types, the same mutex is returned on every call that has |
||
5924 | ** the same type number. |
||
5925 | ** |
||
5926 | ** ^The sqlite3_mutex_free() routine deallocates a previously |
||
5927 | ** allocated dynamic mutex. ^SQLite is careful to deallocate every |
||
5928 | ** dynamic mutex that it allocates. The dynamic mutexes must not be in |
||
5929 | ** use when they are deallocated. Attempting to deallocate a static |
||
5930 | ** mutex results in undefined behavior. ^SQLite never deallocates |
||
5931 | ** a static mutex. |
||
5932 | ** |
||
5933 | ** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt |
||
5934 | ** to enter a mutex. ^If another thread is already within the mutex, |
||
5935 | ** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return |
||
5936 | ** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK] |
||
5937 | ** upon successful entry. ^(Mutexes created using |
||
5938 | ** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread. |
||
5939 | ** In such cases the, |
||
5940 | ** mutex must be exited an equal number of times before another thread |
||
5941 | ** can enter.)^ ^(If the same thread tries to enter any other |
||
5942 | ** kind of mutex more than once, the behavior is undefined. |
||
5943 | ** SQLite will never exhibit |
||
5944 | ** such behavior in its own use of mutexes.)^ |
||
5945 | ** |
||
5946 | ** ^(Some systems (for example, Windows 95) do not support the operation |
||
5947 | ** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try() |
||
5948 | ** will always return SQLITE_BUSY. The SQLite core only ever uses |
||
5949 | ** sqlite3_mutex_try() as an optimization so this is acceptable behavior.)^ |
||
5950 | ** |
||
5951 | ** ^The sqlite3_mutex_leave() routine exits a mutex that was |
||
5952 | ** previously entered by the same thread. ^(The behavior |
||
5953 | ** is undefined if the mutex is not currently entered by the |
||
5954 | ** calling thread or is not currently allocated. SQLite will |
||
5955 | ** never do either.)^ |
||
5956 | ** |
||
5957 | ** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or |
||
5958 | ** sqlite3_mutex_leave() is a NULL pointer, then all three routines |
||
5959 | ** behave as no-ops. |
||
5960 | ** |
||
5961 | ** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()]. |
||
5962 | */ |
||
5963 | //SQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int); |
||
5964 | //SQLITE_API void sqlite3_mutex_free(sqlite3_mutex); |
||
5965 | //SQLITE_API void sqlite3_mutex_enter(sqlite3_mutex); |
||
5966 | //SQLITE_API int sqlite3_mutex_try(sqlite3_mutex); |
||
5967 | //SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex); |
||
5968 | |||
5969 | /* |
||
5970 | ** CAPI3REF: Mutex Methods Object |
||
5971 | ** |
||
5972 | ** An instance of this structure defines the low-level routines |
||
5973 | ** used to allocate and use mutexes. |
||
5974 | ** |
||
5975 | ** Usually, the default mutex implementations provided by SQLite are |
||
5976 | ** sufficient, however the user has the option of substituting a custom |
||
5977 | ** implementation for specialized deployments or systems for which SQLite |
||
5978 | ** does not provide a suitable implementation. In this case, the user |
||
5979 | ** creates and populates an instance of this structure to pass |
||
5980 | ** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option. |
||
5981 | ** Additionally, an instance of this structure can be used as an |
||
5982 | ** output variable when querying the system for the current mutex |
||
5983 | ** implementation, using the [SQLITE_CONFIG_GETMUTEX] option. |
||
5984 | ** |
||
5985 | ** ^The xMutexInit method defined by this structure is invoked as |
||
5986 | ** part of system initialization by the sqlite3_initialize() function. |
||
5987 | ** ^The xMutexInit routine is called by SQLite exactly once for each |
||
5988 | ** effective call to [sqlite3_initialize()]. |
||
5989 | ** |
||
5990 | ** ^The xMutexEnd method defined by this structure is invoked as |
||
5991 | ** part of system shutdown by the sqlite3_shutdown() function. The |
||
5992 | ** implementation of this method is expected to release all outstanding |
||
5993 | ** resources obtained by the mutex methods implementation, especially |
||
5994 | ** those obtained by the xMutexInit method. ^The xMutexEnd() |
||
5995 | ** interface is invoked exactly once for each call to [sqlite3_shutdown()]. |
||
5996 | ** |
||
5997 | ** ^(The remaining seven methods defined by this structure (xMutexAlloc, |
||
5998 | ** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and |
||
5999 | ** xMutexNotheld) implement the following interfaces (respectively): |
||
6000 | ** |
||
6001 | ** <ul> |
||
6002 | ** <li> [sqlite3_mutex_alloc()] </li> |
||
6003 | ** <li> [sqlite3_mutex_free()] </li> |
||
6004 | ** <li> [sqlite3_mutex_enter()] </li> |
||
6005 | ** <li> [sqlite3_mutex_try()] </li> |
||
6006 | ** <li> [sqlite3_mutex_leave()] </li> |
||
6007 | ** <li> [sqlite3_mutex_held()] </li> |
||
6008 | ** <li> [sqlite3_mutex_notheld()] </li> |
||
6009 | ** </ul>)^ |
||
6010 | ** |
||
6011 | ** The only difference is that the public sqlite3_XXX functions enumerated |
||
6012 | ** above silently ignore any invocations that pass a NULL pointer instead |
||
6013 | ** of a valid mutex handle. The implementations of the methods defined |
||
6014 | ** by this structure are not required to handle this case, the results |
||
6015 | ** of passing a NULL pointer instead of a valid mutex handle are undefined |
||
6016 | ** (i.e. it is acceptable to provide an implementation that segfaults if |
||
6017 | ** it is passed a NULL pointer). |
||
6018 | ** |
||
6019 | ** The xMutexInit() method must be threadsafe. ^It must be harmless to |
||
6020 | ** invoke xMutexInit() multiple times within the same process and without |
||
6021 | ** intervening calls to xMutexEnd(). Second and subsequent calls to |
||
6022 | ** xMutexInit() must be no-ops. |
||
6023 | ** |
||
6024 | ** ^xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()] |
||
6025 | ** and its associates). ^Similarly, xMutexAlloc() must not use SQLite memory |
||
6026 | ** allocation for a static mutex. ^However xMutexAlloc() may use SQLite |
||
6027 | ** memory allocation for a fast or recursive mutex. |
||
6028 | ** |
||
6029 | ** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is |
||
6030 | ** called, but only if the prior call to xMutexInit returned SQLITE_OK. |
||
6031 | ** If xMutexInit fails in any way, it is expected to clean up after itself |
||
6032 | ** prior to returning. |
||
6033 | */ |
||
6034 | //typedef struct sqlite3_mutex_methods sqlite3_mutex_methods; |
||
6035 | //struct sqlite3_mutex_methods { |
||
6036 | // int (*xMutexInit)(void); |
||
6037 | // int (*xMutexEnd)(void); |
||
6038 | // sqlite3_mutex *(*xMutexAlloc)(int); |
||
6039 | // void (*xMutexFree)(sqlite3_mutex ); |
||
6040 | // void (*xMutexEnter)(sqlite3_mutex ); |
||
6041 | // int (*xMutexTry)(sqlite3_mutex ); |
||
6042 | // void (*xMutexLeave)(sqlite3_mutex ); |
||
6043 | // int (*xMutexHeld)(sqlite3_mutex ); |
||
6044 | // int (*xMutexNotheld)(sqlite3_mutex ); |
||
6045 | //}; |
||
6046 | public class sqlite3_mutex_methods |
||
6047 | { |
||
6048 | public dxMutexInit xMutexInit; |
||
6049 | public dxMutexEnd xMutexEnd; |
||
6050 | public dxMutexAlloc xMutexAlloc; |
||
6051 | public dxMutexFree xMutexFree; |
||
6052 | public dxMutexEnter xMutexEnter; |
||
6053 | public dxMutexTry xMutexTry; |
||
6054 | public dxMutexLeave xMutexLeave; |
||
6055 | public dxMutexHeld xMutexHeld; |
||
6056 | public dxMutexNotheld xMutexNotheld; |
||
6057 | |||
6058 | public sqlite3_mutex_methods() |
||
6059 | { |
||
6060 | } |
||
6061 | |||
6062 | public sqlite3_mutex_methods( |
||
6063 | dxMutexInit xMutexInit, |
||
6064 | dxMutexEnd xMutexEnd, |
||
6065 | dxMutexAlloc xMutexAlloc, |
||
6066 | dxMutexFree xMutexFree, |
||
6067 | dxMutexEnter xMutexEnter, |
||
6068 | dxMutexTry xMutexTry, |
||
6069 | dxMutexLeave xMutexLeave, |
||
6070 | dxMutexHeld xMutexHeld, |
||
6071 | dxMutexNotheld xMutexNotheld |
||
6072 | ) |
||
6073 | { |
||
6074 | this.xMutexInit = xMutexInit; |
||
6075 | this.xMutexEnd = xMutexEnd; |
||
6076 | this.xMutexAlloc = xMutexAlloc; |
||
6077 | this.xMutexFree = xMutexFree; |
||
6078 | this.xMutexEnter = xMutexEnter; |
||
6079 | this.xMutexTry = xMutexTry; |
||
6080 | this.xMutexLeave = xMutexLeave; |
||
6081 | this.xMutexHeld = xMutexHeld; |
||
6082 | this.xMutexNotheld = xMutexNotheld; |
||
6083 | } |
||
6084 | |||
6085 | //Copy sqlite3_mutex_methods from existing |
||
6086 | public void Copy( sqlite3_mutex_methods cp ) |
||
6087 | { |
||
6088 | Debug.Assert( cp != null ); |
||
6089 | this.xMutexInit = cp.xMutexInit; |
||
6090 | this.xMutexEnd = cp.xMutexEnd; |
||
6091 | this.xMutexAlloc = cp.xMutexAlloc; |
||
6092 | this.xMutexFree = cp.xMutexFree; |
||
6093 | this.xMutexEnter = cp.xMutexEnter; |
||
6094 | this.xMutexTry = cp.xMutexTry; |
||
6095 | this.xMutexLeave = cp.xMutexLeave; |
||
6096 | this.xMutexHeld = cp.xMutexHeld; |
||
6097 | this.xMutexNotheld = cp.xMutexNotheld; |
||
6098 | } |
||
6099 | } |
||
6100 | /* |
||
6101 | ** CAPI3REF: Mutex Verification Routines |
||
6102 | ** |
||
6103 | ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines |
||
6104 | ** are intended for use inside Debug.Assert() statements. ^The SQLite core |
||
6105 | ** never uses these routines except inside an Debug.Assert() and applications |
||
6106 | ** are advised to follow the lead of the core. ^The SQLite core only |
||
6107 | ** provides implementations for these routines when it is compiled |
||
6108 | ** with the SQLITE_DEBUG flag. ^External mutex implementations |
||
6109 | ** are only required to provide these routines if SQLITE_DEBUG is |
||
6110 | ** defined and if NDEBUG is not defined. |
||
6111 | ** |
||
6112 | ** ^These routines should return true if the mutex in their argument |
||
6113 | ** is held or not held, respectively, by the calling thread. |
||
6114 | ** |
||
6115 | ** ^The implementation is not required to provided versions of these |
||
6116 | ** routines that actually work. If the implementation does not provide working |
||
6117 | ** versions of these routines, it should at least provide stubs that always |
||
6118 | ** return true so that one does not get spurious assertion failures. |
||
6119 | ** |
||
6120 | ** ^If the argument to sqlite3_mutex_held() is a NULL pointer then |
||
6121 | ** the routine should return 1. This seems counter-intuitive since |
||
6122 | ** clearly the mutex cannot be held if it does not exist. But |
||
6123 | ** the reason the mutex does not exist is because the build is not |
||
6124 | ** using mutexes. And we do not want the Debug.Assert() containing the |
||
6125 | ** call to sqlite3_mutex_held() to fail, so a non-zero return is |
||
6126 | ** the appropriate thing to do. ^The sqlite3_mutex_notheld() |
||
6127 | ** interface should also return 1 when given a NULL pointer. |
||
6128 | */ |
||
6129 | //#if !NDEBUG |
||
6130 | //SQLITE_API int sqlite3_mutex_held(sqlite3_mutex); |
||
6131 | //SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex); |
||
6132 | //#endif |
||
6133 | |||
6134 | /* |
||
6135 | ** CAPI3REF: Mutex Types |
||
6136 | ** |
||
6137 | ** The [sqlite3_mutex_alloc()] interface takes a single argument |
||
6138 | ** which is one of these integer constants. |
||
6139 | ** |
||
6140 | ** The set of static mutexes may change from one SQLite release to the |
||
6141 | ** next. Applications that override the built-in mutex logic must be |
||
6142 | ** prepared to accommodate additional static mutexes. |
||
6143 | */ |
||
6144 | //#define SQLITE_MUTEX_FAST 0 |
||
6145 | //#define SQLITE_MUTEX_RECURSIVE 1 |
||
6146 | //#define SQLITE_MUTEX_STATIC_MASTER 2 |
||
6147 | //#define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */ |
||
6148 | //#define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */ |
||
6149 | //#define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */ |
||
6150 | //#define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_random() */ |
||
6151 | //#define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */ |
||
6152 | //#define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */ |
||
6153 | //#define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */ |
||
6154 | const int SQLITE_MUTEX_FAST = 0; |
||
6155 | const int SQLITE_MUTEX_RECURSIVE = 1; |
||
6156 | const int SQLITE_MUTEX_STATIC_MASTER = 2; |
||
6157 | const int SQLITE_MUTEX_STATIC_MEM = 3; |
||
6158 | const int SQLITE_MUTEX_STATIC_MEM2 = 4; |
||
6159 | const int SQLITE_MUTEX_STATIC_OPEN = 4; |
||
6160 | const int SQLITE_MUTEX_STATIC_PRNG = 5; |
||
6161 | const int SQLITE_MUTEX_STATIC_LRU = 6; |
||
6162 | const int SQLITE_MUTEX_STATIC_LRU2 = 7; |
||
6163 | const int SQLITE_MUTEX_STATIC_PMEM = 7; |
||
6164 | |||
6165 | /* |
||
6166 | ** CAPI3REF: Retrieve the mutex for a database connection |
||
6167 | ** |
||
6168 | ** ^This interface returns a pointer the [sqlite3_mutex] object that |
||
6169 | ** serializes access to the [database connection] given in the argument |
||
6170 | ** when the [threading mode] is Serialized. |
||
6171 | ** ^If the [threading mode] is Single-thread or Multi-thread then this |
||
6172 | ** routine returns a NULL pointer. |
||
6173 | */ |
||
6174 | //SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3); |
||
6175 | |||
6176 | /* |
||
6177 | ** CAPI3REF: Low-Level Control Of Database Files |
||
6178 | ** |
||
6179 | ** ^The [sqlite3_file_control()] interface makes a direct call to the |
||
6180 | ** xFileControl method for the [sqlite3_io_methods] object associated |
||
6181 | ** with a particular database identified by the second argument. ^The |
||
6182 | ** name of the database is "main" for the main database or "temp" for the |
||
6183 | ** TEMP database, or the name that appears after the AS keyword for |
||
6184 | ** databases that are added using the [ATTACH] SQL command. |
||
6185 | ** ^A NULL pointer can be used in place of "main" to refer to the |
||
6186 | ** main database file. |
||
6187 | ** ^The third and fourth parameters to this routine |
||
6188 | ** are passed directly through to the second and third parameters of |
||
6189 | ** the xFileControl method. ^The return value of the xFileControl |
||
6190 | ** method becomes the return value of this routine. |
||
6191 | ** |
||
6192 | ** ^The SQLITE_FCNTL_FILE_POINTER value for the op parameter causes |
||
6193 | ** a pointer to the underlying [sqlite3_file] object to be written into |
||
6194 | ** the space pointed to by the 4th parameter. ^The SQLITE_FCNTL_FILE_POINTER |
||
6195 | ** case is a short-circuit path which does not actually invoke the |
||
6196 | ** underlying sqlite3_io_methods.xFileControl method. |
||
6197 | ** |
||
6198 | ** ^If the second parameter (zDbName) does not match the name of any |
||
6199 | ** open database file, then SQLITE_ERROR is returned. ^This error |
||
6200 | ** code is not remembered and will not be recalled by [sqlite3_errcode()] |
||
6201 | ** or [sqlite3_errmsg()]. The underlying xFileControl method might |
||
6202 | ** also return SQLITE_ERROR. There is no way to distinguish between |
||
6203 | ** an incorrect zDbName and an SQLITE_ERROR return from the underlying |
||
6204 | ** xFileControl method. |
||
6205 | ** |
||
6206 | ** See also: [SQLITE_FCNTL_LOCKSTATE] |
||
6207 | */ |
||
6208 | //SQLITE_API int sqlite3_file_control(sqlite3*, string zDbName, int op, void); |
||
6209 | |||
6210 | /* |
||
6211 | ** CAPI3REF: Testing Interface |
||
6212 | ** |
||
6213 | ** ^The sqlite3_test_control() interface is used to read out internal |
||
6214 | ** state of SQLite and to inject faults into SQLite for testing |
||
6215 | ** purposes. ^The first parameter is an operation code that determines |
||
6216 | ** the number, meaning, and operation of all subsequent parameters. |
||
6217 | ** |
||
6218 | ** This interface is not for use by applications. It exists solely |
||
6219 | ** for verifying the correct operation of the SQLite library. Depending |
||
6220 | ** on how the SQLite library is compiled, this interface might not exist. |
||
6221 | ** |
||
6222 | ** The details of the operation codes, their meanings, the parameters |
||
6223 | ** they take, and what they do are all subject to change without notice. |
||
6224 | ** Unlike most of the SQLite API, this function is not guaranteed to |
||
6225 | ** operate consistently from one release to the next. |
||
6226 | */ |
||
6227 | //SQLITE_API int sqlite3_test_control(int op, ...); |
||
6228 | |||
6229 | /* |
||
6230 | ** CAPI3REF: Testing Interface Operation Codes |
||
6231 | ** |
||
6232 | ** These constants are the valid operation code parameters used |
||
6233 | ** as the first argument to [sqlite3_test_control()]. |
||
6234 | ** |
||
6235 | ** These parameters and their meanings are subject to change |
||
6236 | ** without notice. These values are for testing purposes only. |
||
6237 | ** Applications should not use any of these parameters or the |
||
6238 | ** [sqlite3_test_control()] interface. |
||
6239 | */ |
||
6240 | //#define SQLITE_TESTCTRL_FIRST 5 |
||
6241 | //#define SQLITE_TESTCTRL_PRNG_SAVE 5 |
||
6242 | //#define SQLITE_TESTCTRL_PRNG_RESTORE 6 |
||
6243 | //#define SQLITE_TESTCTRL_PRNG_RESET 7 |
||
6244 | //#define SQLITE_TESTCTRL_BITVEC_TEST 8 |
||
6245 | //#define SQLITE_TESTCTRL_FAULT_INSTALL 9 |
||
6246 | //#define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10 |
||
6247 | //#define SQLITE_TESTCTRL_PENDING_BYTE 11 |
||
6248 | //#define SQLITE_TESTCTRL_ASSERT 12 |
||
6249 | //#define SQLITE_TESTCTRL_ALWAYS 13 |
||
6250 | //#define SQLITE_TESTCTRL_RESERVE 14 |
||
6251 | //#define SQLITE_TESTCTRL_OPTIMIZATIONS 15 |
||
6252 | //#define SQLITE_TESTCTRL_ISKEYWORD 16 |
||
6253 | //#define SQLITE_TESTCTRL_PGHDRSZ 17 |
||
6254 | //#define SQLITE_TESTCTRL_SCRATCHMALLOC 18 |
||
6255 | //#define SQLITE_TESTCTRL_LOCALTIME_FAULT 19 |
||
6256 | //#define SQLITE_TESTCTRL_LAST 19 |
||
6257 | const int SQLITE_TESTCTRL_FIRST = 5; |
||
6258 | const int SQLITE_TESTCTRL_PRNG_SAVE = 5; |
||
6259 | const int SQLITE_TESTCTRL_PRNG_RESTORE = 6; |
||
6260 | const int SQLITE_TESTCTRL_PRNG_RESET = 7; |
||
6261 | const int SQLITE_TESTCTRL_BITVEC_TEST = 8; |
||
6262 | const int SQLITE_TESTCTRL_FAULT_INSTALL = 9; |
||
6263 | const int SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS = 10; |
||
6264 | const int SQLITE_TESTCTRL_PENDING_BYTE = 11; |
||
6265 | const int SQLITE_TESTCTRL_ASSERT = 12; |
||
6266 | const int SQLITE_TESTCTRL_ALWAYS = 13; |
||
6267 | const int SQLITE_TESTCTRL_RESERVE = 14; |
||
6268 | const int SQLITE_TESTCTRL_OPTIMIZATIONS = 15; |
||
6269 | const int SQLITE_TESTCTRL_ISKEYWORD = 16; |
||
6270 | const int SQLITE_TESTCTRL_PGHDRSZ = 17; |
||
6271 | const int SQLITE_TESTCTRL_SCRATCHMALLOC = 18; |
||
6272 | const int SQLITE_TESTCTRL_LOCALTIME_FAULT = 19; |
||
6273 | const int SQLITE_TESTCTRL_LAST = 19; |
||
6274 | |||
6275 | /* |
||
6276 | ** CAPI3REF: SQLite Runtime Status |
||
6277 | ** |
||
6278 | ** ^This interface is used to retrieve runtime status information |
||
6279 | ** about the performance of SQLite, and optionally to reset various |
||
6280 | ** highwater marks. ^The first argument is an integer code for |
||
6281 | ** the specific parameter to measure. ^(Recognized integer codes |
||
6282 | ** are of the form [status parameters | SQLITE_STATUS_...].)^ |
||
6283 | ** ^The current value of the parameter is returned into *pCurrent. |
||
6284 | ** ^The highest recorded value is returned in *pHighwater. ^If the |
||
6285 | ** resetFlag is true, then the highest record value is reset after |
||
6286 | ** *pHighwater is written. ^(Some parameters do not record the highest |
||
6287 | ** value. For those parameters |
||
6288 | ** nothing is written into *pHighwater and the resetFlag is ignored.)^ |
||
6289 | ** ^(Other parameters record only the highwater mark and not the current |
||
6290 | ** value. For these latter parameters nothing is written into *pCurrent.)^ |
||
6291 | ** |
||
6292 | ** ^The sqlite3_status() routine returns SQLITE_OK on success and a |
||
6293 | ** non-zero [error code] on failure. |
||
6294 | ** |
||
6295 | ** This routine is threadsafe but is not atomic. This routine can be |
||
6296 | ** called while other threads are running the same or different SQLite |
||
6297 | ** interfaces. However the values returned in *pCurrent and |
||
6298 | ** *pHighwater reflect the status of SQLite at different points in time |
||
6299 | ** and it is possible that another thread might change the parameter |
||
6300 | ** in between the times when *pCurrent and *pHighwater are written. |
||
6301 | ** |
||
6302 | ** See also: [sqlite3_db_status()] |
||
6303 | */ |
||
6304 | //SQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag); |
||
6305 | |||
6306 | |||
6307 | /* |
||
6308 | ** CAPI3REF: Status Parameters |
||
6309 | ** KEYWORDS: {status parameters} |
||
6310 | ** |
||
6311 | ** These integer constants designate various run-time status parameters |
||
6312 | ** that can be returned by [sqlite3_status()]. |
||
6313 | ** |
||
6314 | ** <dl> |
||
6315 | ** [[SQLITE_STATUS_MEMORY_USED]] ^(<dt>SQLITE_STATUS_MEMORY_USED</dt> |
||
6316 | ** <dd>This parameter is the current amount of memory checked out |
||
6317 | ** using [sqlite3_malloc()], either directly or indirectly. The |
||
6318 | ** figure includes calls made to [sqlite3_malloc()] by the application |
||
6319 | ** and internal memory usage by the SQLite library. Scratch memory |
||
6320 | ** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache |
||
6321 | ** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in |
||
6322 | ** this parameter. The amount returned is the sum of the allocation |
||
6323 | ** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^ |
||
6324 | ** |
||
6325 | ** [[SQLITE_STATUS_MALLOC_SIZE]] ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt> |
||
6326 | ** <dd>This parameter records the largest memory allocation request |
||
6327 | ** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their |
||
6328 | ** internal equivalents). Only the value returned in the |
||
6329 | ** *pHighwater parameter to [sqlite3_status()] is of interest. |
||
6330 | ** The value written into the *pCurrent parameter is undefined.</dd>)^ |
||
6331 | ** |
||
6332 | ** [[SQLITE_STATUS_MALLOC_COUNT]] ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt> |
||
6333 | ** <dd>This parameter records the number of separate memory allocations |
||
6334 | ** currently checked out.</dd>)^ |
||
6335 | ** |
||
6336 | ** [[SQLITE_STATUS_PAGECACHE_USED]] ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt> |
||
6337 | ** <dd>This parameter returns the number of pages used out of the |
||
6338 | ** [pagecache memory allocator] that was configured using |
||
6339 | ** [SQLITE_CONFIG_PAGECACHE]. The |
||
6340 | ** value returned is in pages, not in bytes.</dd>)^ |
||
6341 | ** |
||
6342 | ** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]] |
||
6343 | ** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt> |
||
6344 | ** <dd>This parameter returns the number of bytes of page cache |
||
6345 | ** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE] |
||
6346 | ** buffer and where forced to overflow to [sqlite3_malloc()]. The |
||
6347 | ** returned value includes allocations that overflowed because they |
||
6348 | ** where too large (they were larger than the "sz" parameter to |
||
6349 | ** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because |
||
6350 | ** no space was left in the page cache.</dd>)^ |
||
6351 | ** |
||
6352 | ** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt> |
||
6353 | ** <dd>This parameter records the largest memory allocation request |
||
6354 | ** handed to [pagecache memory allocator]. Only the value returned in the |
||
6355 | ** *pHighwater parameter to [sqlite3_status()] is of interest. |
||
6356 | ** The value written into the *pCurrent parameter is undefined.</dd>)^ |
||
6357 | ** |
||
6358 | ** [[SQLITE_STATUS_SCRATCH_USED]] ^(<dt>SQLITE_STATUS_SCRATCH_USED</dt> |
||
6359 | ** <dd>This parameter returns the number of allocations used out of the |
||
6360 | ** [scratch memory allocator] configured using |
||
6361 | ** [SQLITE_CONFIG_SCRATCH]. The value returned is in allocations, not |
||
6362 | ** in bytes. Since a single thread may only have one scratch allocation |
||
6363 | ** outstanding at time, this parameter also reports the number of threads |
||
6364 | ** using scratch memory at the same time.</dd>)^ |
||
6365 | ** |
||
6366 | ** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt> |
||
6367 | ** <dd>This parameter returns the number of bytes of scratch memory |
||
6368 | ** allocation which could not be satisfied by the [SQLITE_CONFIG_SCRATCH] |
||
6369 | ** buffer and where forced to overflow to [sqlite3_malloc()]. The values |
||
6370 | ** returned include overflows because the requested allocation was too |
||
6371 | ** larger (that is, because the requested allocation was larger than the |
||
6372 | ** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer |
||
6373 | ** slots were available. |
||
6374 | ** </dd>)^ |
||
6375 | ** |
||
6376 | ** [[SQLITE_STATUS_SCRATCH_SIZE]] ^(<dt>SQLITE_STATUS_SCRATCH_SIZE</dt> |
||
6377 | ** <dd>This parameter records the largest memory allocation request |
||
6378 | ** handed to [scratch memory allocator]. Only the value returned in the |
||
6379 | ** *pHighwater parameter to [sqlite3_status()] is of interest. |
||
6380 | ** The value written into the *pCurrent parameter is undefined.</dd>)^ |
||
6381 | ** |
||
6382 | ** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt> |
||
6383 | ** <dd>This parameter records the deepest parser stack. It is only |
||
6384 | ** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^ |
||
6385 | ** </dl> |
||
6386 | ** |
||
6387 | ** New status parameters may be added from time to time. |
||
6388 | */ |
||
6389 | //#define SQLITE_STATUS_MEMORY_USED 0 |
||
6390 | //#define SQLITE_STATUS_PAGECACHE_USED 1 |
||
6391 | //#define SQLITE_STATUS_PAGECACHE_OVERFLOW 2 |
||
6392 | //#define SQLITE_STATUS_SCRATCH_USED 3 |
||
6393 | //#define SQLITE_STATUS_SCRATCH_OVERFLOW 4 |
||
6394 | //#define SQLITE_STATUS_MALLOC_SIZE 5 |
||
6395 | //#define SQLITE_STATUS_PARSER_STACK 6 |
||
6396 | //#define SQLITE_STATUS_PAGECACHE_SIZE 7 |
||
6397 | //#define SQLITE_STATUS_SCRATCH_SIZE 8 |
||
6398 | //#define SQLITE_STATUS_MALLOC_COUNT 9 |
||
6399 | const int SQLITE_STATUS_MEMORY_USED = 0; |
||
6400 | const int SQLITE_STATUS_PAGECACHE_USED = 1; |
||
6401 | const int SQLITE_STATUS_PAGECACHE_OVERFLOW = 2; |
||
6402 | const int SQLITE_STATUS_SCRATCH_USED = 3; |
||
6403 | const int SQLITE_STATUS_SCRATCH_OVERFLOW = 4; |
||
6404 | const int SQLITE_STATUS_MALLOC_SIZE = 5; |
||
6405 | const int SQLITE_STATUS_PARSER_STACK = 6; |
||
6406 | const int SQLITE_STATUS_PAGECACHE_SIZE = 7; |
||
6407 | const int SQLITE_STATUS_SCRATCH_SIZE = 8; |
||
6408 | const int SQLITE_STATUS_MALLOC_COUNT = 9; |
||
6409 | |||
6410 | /* |
||
6411 | ** CAPI3REF: Database Connection Status |
||
6412 | ** |
||
6413 | ** ^This interface is used to retrieve runtime status information |
||
6414 | ** about a single [database connection]. ^The first argument is the |
||
6415 | ** database connection object to be interrogated. ^The second argument |
||
6416 | ** is an integer constant, taken from the set of |
||
6417 | ** [SQLITE_DBSTATUS options], that |
||
6418 | ** determines the parameter to interrogate. The set of |
||
6419 | ** [SQLITE_DBSTATUS options] is likely |
||
6420 | ** to grow in future releases of SQLite. |
||
6421 | ** |
||
6422 | ** ^The current value of the requested parameter is written into *pCur |
||
6423 | ** and the highest instantaneous value is written into *pHiwtr. ^If |
||
6424 | ** the resetFlg is true, then the highest instantaneous value is |
||
6425 | ** reset back down to the current value. |
||
6426 | ** |
||
6427 | ** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a |
||
6428 | ** non-zero [error code] on failure. |
||
6429 | ** |
||
6430 | ** See also: [sqlite3_status()] and [sqlite3_stmt_status()]. |
||
6431 | */ |
||
6432 | //SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg); |
||
6433 | |||
6434 | /* |
||
6435 | ** CAPI3REF: Status Parameters for database connections |
||
6436 | ** KEYWORDS: {SQLITE_DBSTATUS options} |
||
6437 | ** |
||
6438 | ** These constants are the available integer "verbs" that can be passed as |
||
6439 | ** the second argument to the [sqlite3_db_status()] interface. |
||
6440 | ** |
||
6441 | ** New verbs may be added in future releases of SQLite. Existing verbs |
||
6442 | ** might be discontinued. Applications should check the return code from |
||
6443 | ** [sqlite3_db_status()] to make sure that the call worked. |
||
6444 | ** The [sqlite3_db_status()] interface will return a non-zero error code |
||
6445 | ** if a discontinued or unsupported verb is invoked. |
||
6446 | ** |
||
6447 | ** <dl> |
||
6448 | ** [[SQLITE_DBSTATUS_LOOKASIDE_USED]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt> |
||
6449 | ** <dd>This parameter returns the number of lookaside memory slots currently |
||
6450 | ** checked out.</dd>)^ |
||
6451 | ** |
||
6452 | ** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt> |
||
6453 | ** <dd>This parameter returns the number malloc attempts that were |
||
6454 | ** satisfied using lookaside memory. Only the high-water value is meaningful; |
||
6455 | ** the current value is always zero.)^ |
||
6456 | ** |
||
6457 | ** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE]] |
||
6458 | ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt> |
||
6459 | ** <dd>This parameter returns the number malloc attempts that might have |
||
6460 | ** been satisfied using lookaside memory but failed due to the amount of |
||
6461 | ** memory requested being larger than the lookaside slot size. |
||
6462 | ** Only the high-water value is meaningful; |
||
6463 | ** the current value is always zero.)^ |
||
6464 | ** |
||
6465 | ** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL]] |
||
6466 | ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt> |
||
6467 | ** <dd>This parameter returns the number malloc attempts that might have |
||
6468 | ** been satisfied using lookaside memory but failed due to all lookaside |
||
6469 | ** memory already being in use. |
||
6470 | ** Only the high-water value is meaningful; |
||
6471 | ** the current value is always zero.)^ |
||
6472 | ** |
||
6473 | ** [[SQLITE_DBSTATUS_CACHE_USED]] ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt> |
||
6474 | ** <dd>This parameter returns the approximate number of of bytes of heap |
||
6475 | ** memory used by all pager caches associated with the database connection.)^ |
||
6476 | ** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0. |
||
6477 | ** |
||
6478 | ** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt> |
||
6479 | ** <dd>This parameter returns the approximate number of of bytes of heap |
||
6480 | ** memory used to store the schema for all databases associated |
||
6481 | ** with the connection - main, temp, and any [ATTACH]-ed databases.)^ |
||
6482 | ** ^The full amount of memory used by the schemas is reported, even if the |
||
6483 | ** schema memory is shared with other database connections due to |
||
6484 | ** [shared cache mode] being enabled. |
||
6485 | ** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0. |
||
6486 | ** |
||
6487 | ** [[SQLITE_DBSTATUS_STMT_USED]] ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt> |
||
6488 | ** <dd>This parameter returns the approximate number of of bytes of heap |
||
6489 | ** and lookaside memory used by all prepared statements associated with |
||
6490 | ** the database connection.)^ |
||
6491 | ** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0. |
||
6492 | ** </dd> |
||
6493 | ** </dl> |
||
6494 | */ |
||
6495 | //#define SQLITE_DBSTATUS_LOOKASIDE_USED 0 |
||
6496 | //#define SQLITE_DBSTATUS_CACHE_USED 1 |
||
6497 | //#define SQLITE_DBSTATUS_SCHEMA_USED 2 |
||
6498 | //#define SQLITE_DBSTATUS_STMT_USED 3 |
||
6499 | //#define SQLITE_DBSTATUS_LOOKASIDE_HIT 4 |
||
6500 | //#define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE 5 |
||
6501 | //#define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6 |
||
6502 | //#define SQLITE_DBSTATUS_MAX 6 /* Largest defined DBSTATUS */ |
||
6503 | const int SQLITE_DBSTATUS_LOOKASIDE_USED = 0; |
||
6504 | const int SQLITE_DBSTATUS_CACHE_USED = 1; |
||
6505 | const int SQLITE_DBSTATUS_SCHEMA_USED = 2; |
||
6506 | const int SQLITE_DBSTATUS_STMT_USED = 3; |
||
6507 | const int SQLITE_DBSTATUS_LOOKASIDE_HIT = 4; |
||
6508 | const int SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE = 5; |
||
6509 | const int SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL = 6; |
||
6510 | const int SQLITE_DBSTATUS_MAX = 6; |
||
6511 | |||
6512 | |||
6513 | /* |
||
6514 | ** CAPI3REF: Prepared Statement Status |
||
6515 | ** |
||
6516 | ** ^(Each prepared statement maintains various |
||
6517 | ** [SQLITE_STMTSTATUS counters] that measure the number |
||
6518 | ** of times it has performed specific operations.)^ These counters can |
||
6519 | ** be used to monitor the performance characteristics of the prepared |
||
6520 | ** statements. For example, if the number of table steps greatly exceeds |
||
6521 | ** the number of table searches or result rows, that would tend to indicate |
||
6522 | ** that the prepared statement is using a full table scan rather than |
||
6523 | ** an index. |
||
6524 | ** |
||
6525 | ** ^(This interface is used to retrieve and reset counter values from |
||
6526 | ** a [prepared statement]. The first argument is the prepared statement |
||
6527 | ** object to be interrogated. The second argument |
||
6528 | ** is an integer code for a specific [SQLITE_STMTSTATUS counte |
||
6529 | ** to be interrogated.)^ |
||
6530 | ** ^The current value of the requested counter is returned. |
||
6531 | ** ^If the resetFlg is true, then the counter is reset to zero after this |
||
6532 | ** interface call returns. |
||
6533 | ** |
||
6534 | ** See also: [sqlite3_status()] and [sqlite3_db_status()]. |
||
6535 | */ |
||
6536 | //SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg); |
||
6537 | |||
6538 | /* |
||
6539 | ** CAPI3REF: Status Parameters for prepared statements |
||
6540 | ** KEYWORDS: {SQLITE_STMTSTATUS counter} {SQLITE_STMTSTATUS counters} |
||
6541 | ** |
||
6542 | ** These preprocessor macros define integer codes that name counter |
||
6543 | ** values associated with the [sqlite3_stmt_status()] interface. |
||
6544 | ** The meanings of the various counters are as follows: |
||
6545 | ** |
||
6546 | ** <dl> |
||
6547 | ** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]] <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt> |
||
6548 | ** <dd>^This is the number of times that SQLite has stepped forward in |
||
6549 | ** a table as part of a full table scan. Large numbers for this counter |
||
6550 | ** may indicate opportunities for performance improvement through |
||
6551 | ** careful use of indices.</dd> |
||
6552 | ** |
||
6553 | ** [[SQLITE_STMTSTATUS_SORT]] <dt>SQLITE_STMTSTATUS_SORT</dt> |
||
6554 | ** <dd>^This is the number of sort operations that have occurred. |
||
6555 | ** A non-zero value in this counter may indicate an opportunity to |
||
6556 | ** improvement performance through careful use of indices.</dd> |
||
6557 | ** |
||
6558 | ** [[SQLITE_STMTSTATUS_AUTOINDEX]] <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt> |
||
6559 | ** <dd>^This is the number of rows inserted into transient indices that |
||
6560 | ** were created automatically in order to help joins run faster. |
||
6561 | ** A non-zero value in this counter may indicate an opportunity to |
||
6562 | ** improvement performance by adding permanent indices that do not |
||
6563 | ** need to be reinitialized each time the statement is run.</dd> |
||
6564 | ** |
||
6565 | ** </dl> |
||
6566 | */ |
||
6567 | //#define SQLITE_STMTSTATUS_FULLSCAN_STEP 1 |
||
6568 | //#define SQLITE_STMTSTATUS_SORT 2 |
||
6569 | //#define SQLITE_STMTSTATUS_AUTOINDEX 3 |
||
6570 | const int SQLITE_STMTSTATUS_FULLSCAN_STEP = 1; |
||
6571 | const int SQLITE_STMTSTATUS_SORT = 2; |
||
6572 | const int SQLITE_STMTSTATUS_AUTOINDEX = 3; |
||
6573 | |||
6574 | /* |
||
6575 | ** CAPI3REF: Custom Page Cache Object |
||
6576 | ** |
||
6577 | ** The sqlite3_pcache type is opaque. It is implemented by |
||
6578 | ** the pluggable module. The SQLite core has no knowledge of |
||
6579 | ** its size or internal structure and never deals with the |
||
6580 | ** sqlite3_pcache object except by holding and passing pointers |
||
6581 | ** to the object. |
||
6582 | ** |
||
6583 | ** See [sqlite3_pcache_methods] for additional information. |
||
6584 | */ |
||
6585 | //typedef struct sqlite3_pcache sqlite3_pcache; |
||
6586 | |||
6587 | /* |
||
6588 | ** CAPI3REF: Application Defined Page Cache. |
||
6589 | ** KEYWORDS: {page cache} |
||
6590 | ** |
||
6591 | ** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE], ...) interface can |
||
6592 | ** register an alternative page cache implementation by passing in an |
||
6593 | ** instance of the sqlite3_pcache_methods structure.)^ |
||
6594 | ** In many applications, most of the heap memory allocated by |
||
6595 | ** SQLite is used for the page cache. |
||
6596 | ** By implementing a |
||
6597 | ** custom page cache using this API, an application can better control |
||
6598 | ** the amount of memory consumed by SQLite, the way in which |
||
6599 | ** that memory is allocated and released, and the policies used to |
||
6600 | ** determine exactly which parts of a database file are cached and for |
||
6601 | ** how long. |
||
6602 | ** |
||
6603 | ** The alternative page cache mechanism is an |
||
6604 | ** extreme measure that is only needed by the most demanding applications. |
||
6605 | ** The built-in page cache is recommended for most uses. |
||
6606 | ** |
||
6607 | ** ^(The contents of the sqlite3_pcache_methods structure are copied to an |
||
6608 | ** internal buffer by SQLite within the call to [sqlite3_config]. Hence |
||
6609 | ** the application may discard the parameter after the call to |
||
6610 | ** [sqlite3_config()] returns.)^ |
||
6611 | ** |
||
6612 | ** [[the xInit() page cache method]] |
||
6613 | ** ^(The xInit() method is called once for each effective |
||
6614 | ** call to [sqlite3_initialize()])^ |
||
6615 | ** (usually only once during the lifetime of the process). ^(The xInit() |
||
6616 | ** method is passed a copy of the sqlite3_pcache_methods.pArg value.)^ |
||
6617 | ** The intent of the xInit() method is to set up global data structures |
||
6618 | ** required by the custom page cache implementation. |
||
6619 | ** ^(If the xInit() method is NULL, then the |
||
6620 | ** built-in default page cache is used instead of the application defined |
||
6621 | ** page cache.)^ |
||
6622 | ** |
||
6623 | ** [[the xShutdown() page cache method]] |
||
6624 | ** ^The xShutdown() method is called by [sqlite3_shutdown()]. |
||
6625 | ** It can be used to clean up |
||
6626 | ** any outstanding resources before process shutdown, if required. |
||
6627 | ** ^The xShutdown() method may be NULL. |
||
6628 | ** |
||
6629 | ** ^SQLite automatically serializes calls to the xInit method, |
||
6630 | ** so the xInit method need not be threadsafe. ^The |
||
6631 | ** xShutdown method is only called from [sqlite3_shutdown()] so it does |
||
6632 | ** not need to be threadsafe either. All other methods must be threadsafe |
||
6633 | ** in multithreaded applications. |
||
6634 | ** |
||
6635 | ** ^SQLite will never invoke xInit() more than once without an intervening |
||
6636 | ** call to xShutdown(). |
||
6637 | ** |
||
6638 | ** [[the xCreate() page cache methods]] |
||
6639 | ** ^SQLite invokes the xCreate() method to construct a new cache instance. |
||
6640 | ** SQLite will typically create one cache instance for each open database file, |
||
6641 | ** though this is not guaranteed. ^The |
||
6642 | ** first parameter, szPage, is the size in bytes of the pages that must |
||
6643 | ** be allocated by the cache. ^szPage will not be a power of two. ^szPage |
||
6644 | ** will the page size of the database file that is to be cached plus an |
||
6645 | ** increment (here called "R") of less than 250. SQLite will use the |
||
6646 | ** extra R bytes on each page to store metadata about the underlying |
||
6647 | ** database page on disk. The value of R depends |
||
6648 | ** on the SQLite version, the target platform, and how SQLite was compiled. |
||
6649 | ** ^(R is constant for a particular build of SQLite. Except, there are two |
||
6650 | ** distinct values of R when SQLite is compiled with the proprietary |
||
6651 | ** ZIPVFS extension.)^ ^The second argument to |
||
6652 | ** xCreate(), bPurgeable, is true if the cache being created will |
||
6653 | ** be used to cache database pages of a file stored on disk, or |
||
6654 | ** false if it is used for an in-memory database. The cache implementation |
||
6655 | ** does not have to do anything special based with the value of bPurgeable; |
||
6656 | ** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will |
||
6657 | ** never invoke xUnpin() except to deliberately delete a page. |
||
6658 | ** ^In other words, calls to xUnpin() on a cache with bPurgeable set to |
||
6659 | ** false will always have the "discard" flag set to true. |
||
6660 | ** ^Hence, a cache created with bPurgeable false will |
||
6661 | ** never contain any unpinned pages. |
||
6662 | ** |
||
6663 | ** [[the xCachesize() page cache method]] |
||
6664 | ** ^(The xCachesize() method may be called at any time by SQLite to set the |
||
6665 | ** suggested maximum cache-size (number of pages stored by) the cache |
||
6666 | ** instance passed as the first argument. This is the value configured using |
||
6667 | ** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable |
||
6668 | ** parameter, the implementation is not required to do anything with this |
||
6669 | ** value; it is advisory only. |
||
6670 | ** |
||
6671 | ** [[the xPagecount() page cache methods]] |
||
6672 | ** The xPagecount() method must return the number of pages currently |
||
6673 | ** stored in the cache, both pinned and unpinned. |
||
6674 | ** |
||
6675 | ** [[the xFetch() page cache methods]] |
||
6676 | ** The xFetch() method locates a page in the cache and returns a pointer to |
||
6677 | ** the page, or a NULL pointer. |
||
6678 | ** A "page", in this context, means a buffer of szPage bytes aligned at an |
||
6679 | ** 8-byte boundary. The page to be fetched is determined by the key. ^The |
||
6680 | ** minimum key value is 1. After it has been retrieved using xFetch, the page |
||
6681 | ** is considered to be "pinned". |
||
6682 | ** |
||
6683 | ** If the requested page is already in the page cache, then the page cache |
||
6684 | ** implementation must return a pointer to the page buffer with its content |
||
6685 | ** intact. If the requested page is not already in the cache, then the |
||
6686 | ** cache implementation should use the value of the createFlag |
||
6687 | ** parameter to help it determined what action to take: |
||
6688 | ** |
||
6689 | ** <table border=1 width=85% align=center> |
||
6690 | ** <tr><th> createFlag <th> Behaviour when page is not already in cache |
||
6691 | ** <tr><td> 0 <td> Do not allocate a new page. Return NULL. |
||
6692 | ** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so. |
||
6693 | ** Otherwise return NULL. |
||
6694 | ** <tr><td> 2 <td> Make every effort to allocate a new page. Only return |
||
6695 | ** NULL if allocating a new page is effectively impossible. |
||
6696 | ** </table> |
||
6697 | ** |
||
6698 | ** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite |
||
6699 | ** will only use a createFlag of 2 after a prior call with a createFlag of 1 |
||
6700 | ** failed.)^ In between the to xFetch() calls, SQLite may |
||
6701 | ** attempt to unpin one or more cache pages by spilling the content of |
||
6702 | ** pinned pages to disk and synching the operating system disk cache. |
||
6703 | ** |
||
6704 | ** [[the xUnpin() page cache method]] |
||
6705 | ** ^xUnpin() is called by SQLite with a pointer to a currently pinned page |
||
6706 | ** as its second argument. If the third parameter, discard, is non-zero, |
||
6707 | ** then the page must be evicted from the cache. |
||
6708 | ** ^If the discard parameter is |
||
6709 | ** zero, then the page may be discarded or retained at the discretion of |
||
6710 | ** page cache implementation. ^The page cache implementation |
||
6711 | ** may choose to evict unpinned pages at any time. |
||
6712 | ** |
||
6713 | ** The cache must not perform any reference counting. A single |
||
6714 | ** call to xUnpin() unpins the page regardless of the number of prior calls |
||
6715 | ** to xFetch(). |
||
6716 | ** |
||
6717 | ** [[the xRekey() page cache methods]] |
||
6718 | ** The xRekey() method is used to change the key value associated with the |
||
6719 | ** page passed as the second argument. If the cache |
||
6720 | ** previously contains an entry associated with newKey, it must be |
||
6721 | ** discarded. ^Any prior cache entry associated with newKey is guaranteed not |
||
6722 | ** to be pinned. |
||
6723 | ** |
||
6724 | ** When SQLite calls the xTruncate() method, the cache must discard all |
||
6725 | ** existing cache entries with page numbers (keys) greater than or equal |
||
6726 | ** to the value of the iLimit parameter passed to xTruncate(). If any |
||
6727 | ** of these pages are pinned, they are implicitly unpinned, meaning that |
||
6728 | ** they can be safely discarded. |
||
6729 | ** |
||
6730 | ** [[the xDestroy() page cache method]] |
||
6731 | ** ^The xDestroy() method is used to delete a cache allocated by xCreate(). |
||
6732 | ** All resources associated with the specified cache should be freed. ^After |
||
6733 | ** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*] |
||
6734 | ** handle invalid, and will not use it with any other sqlite3_pcache_methods |
||
6735 | ** functions. |
||
6736 | */ |
||
6737 | //typedef struct sqlite3_pcache_methods sqlite3_pcache_methods; |
||
6738 | //struct sqlite3_pcache_methods { |
||
6739 | // void *pArg; |
||
6740 | // int (*xInit)(void); |
||
6741 | // void (*xShutdown)(void); |
||
6742 | // sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable); |
||
6743 | // void (*xCachesize)(sqlite3_pcache*, int nCachesize); |
||
6744 | // int (*xPagecount)(sqlite3_pcache); |
||
6745 | // void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); |
||
6746 | // void (*xUnpin)(sqlite3_pcache*, void*, int discard); |
||
6747 | // void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey); |
||
6748 | // void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); |
||
6749 | // void (*xDestroy)(sqlite3_pcache); |
||
6750 | //}; |
||
6751 | public class sqlite3_pcache_methods |
||
6752 | { |
||
6753 | public object pArg; |
||
6754 | public dxPC_Init xInit;//int (*xInit)(void); |
||
6755 | public dxPC_Shutdown xShutdown;//public void (*xShutdown)(void); |
||
6756 | public dxPC_Create xCreate;//public sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable); |
||
6757 | public dxPC_Cachesize xCachesize;//public void (*xCachesize)(sqlite3_pcache*, int nCachesize); |
||
6758 | public dxPC_Pagecount xPagecount;//public int (*xPagecount)(sqlite3_pcache); |
||
6759 | public dxPC_Fetch xFetch;//public void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag); |
||
6760 | public dxPC_Unpin xUnpin;//public void (*xUnpin)(sqlite3_pcache*, void*, int discard); |
||
6761 | public dxPC_Rekey xRekey;//public void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey); |
||
6762 | public dxPC_Truncate xTruncate;//public void (*xTruncate)(sqlite3_pcache*, unsigned iLimit); |
||
6763 | public dxPC_Destroy xDestroy;//public void (*xDestroy)(sqlite3_pcache); |
||
6764 | |||
6765 | public sqlite3_pcache_methods() |
||
6766 | { |
||
6767 | } |
||
6768 | |||
6769 | public sqlite3_pcache_methods( object pArg, dxPC_Init xInit, dxPC_Shutdown xShutdown, dxPC_Create xCreate, dxPC_Cachesize xCachesize, dxPC_Pagecount xPagecount, dxPC_Fetch xFetch, dxPC_Unpin xUnpin, dxPC_Rekey xRekey, dxPC_Truncate xTruncate, dxPC_Destroy xDestroy ) |
||
6770 | { |
||
6771 | this.pArg = pArg; |
||
6772 | this.xInit = xInit; |
||
6773 | this.xShutdown = xShutdown; |
||
6774 | this.xCreate = xCreate; |
||
6775 | this.xCachesize = xCachesize; |
||
6776 | this.xPagecount = xPagecount; |
||
6777 | this.xFetch = xFetch; |
||
6778 | this.xUnpin = xUnpin; |
||
6779 | this.xRekey = xRekey; |
||
6780 | this.xTruncate = xTruncate; |
||
6781 | this.xDestroy = xDestroy; |
||
6782 | } |
||
6783 | }; |
||
6784 | |||
6785 | |||
6786 | /* |
||
6787 | ** CAPI3REF: Online Backup Object |
||
6788 | ** |
||
6789 | ** The sqlite3_backup object records state information about an ongoing |
||
6790 | ** online backup operation. ^The sqlite3_backup object is created by |
||
6791 | ** a call to [sqlite3_backup_init()] and is destroyed by a call to |
||
6792 | ** [sqlite3_backup_finish()]. |
||
6793 | ** |
||
6794 | ** See Also: [Using the SQLite Online Backup API] |
||
6795 | */ |
||
6796 | //typedef struct sqlite3_backup sqlite3_backup; |
||
6797 | |||
6798 | /* |
||
6799 | ** CAPI3REF: Online Backup API. |
||
6800 | ** |
||
6801 | ** The backup API copies the content of one database into another. |
||
6802 | ** It is useful either for creating backups of databases or |
||
6803 | ** for copying in-memory databases to or from persistent files. |
||
6804 | ** |
||
6805 | ** See Also: [Using the SQLite Online Backup API] |
||
6806 | ** |
||
6807 | ** ^SQLite holds a write transaction open on the destination database file |
||
6808 | ** for the duration of the backup operation. |
||
6809 | ** ^The source database is read-locked only while it is being read; |
||
6810 | ** it is not locked continuously for the entire backup operation. |
||
6811 | ** ^Thus, the backup may be performed on a live source database without |
||
6812 | ** preventing other database connections from |
||
6813 | ** reading or writing to the source database while the backup is underway. |
||
6814 | ** |
||
6815 | ** ^(To perform a backup operation: |
||
6816 | ** <ol> |
||
6817 | ** <li><b>sqlite3_backup_init()</b> is called once to initialize the |
||
6818 | ** backup, |
||
6819 | ** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer |
||
6820 | ** the data between the two databases, and finally |
||
6821 | ** <li><b>sqlite3_backup_finish()</b> is called to release all resources |
||
6822 | ** associated with the backup operation. |
||
6823 | ** </ol>)^ |
||
6824 | ** There should be exactly one call to sqlite3_backup_finish() for each |
||
6825 | ** successful call to sqlite3_backup_init(). |
||
6826 | ** |
||
6827 | ** [[sqlite3_backup_init()]] <b>sqlite3_backup_init()</b> |
||
6828 | ** |
||
6829 | ** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the |
||
6830 | ** [database connection] associated with the destination database |
||
6831 | ** and the database name, respectively. |
||
6832 | ** ^The database name is "main" for the main database, "temp" for the |
||
6833 | ** temporary database, or the name specified after the AS keyword in |
||
6834 | ** an [ATTACH] statement for an attached database. |
||
6835 | ** ^The S and M arguments passed to |
||
6836 | ** sqlite3_backup_init(D,N,S,M) identify the [database connection] |
||
6837 | ** and database name of the source database, respectively. |
||
6838 | ** ^The source and destination [database connections] (parameters S and D) |
||
6839 | ** must be different or else sqlite3_backup_init(D,N,S,M) will fail with |
||
6840 | ** an error. |
||
6841 | ** |
||
6842 | ** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is |
||
6843 | ** returned and an error code and error message are stored in the |
||
6844 | ** destination [database connection] D. |
||
6845 | ** ^The error code and message for the failed call to sqlite3_backup_init() |
||
6846 | ** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or |
||
6847 | ** [sqlite3_errmsg16()] functions. |
||
6848 | ** ^A successful call to sqlite3_backup_init() returns a pointer to an |
||
6849 | ** [sqlite3_backup] object. |
||
6850 | ** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and |
||
6851 | ** sqlite3_backup_finish() functions to perform the specified backup |
||
6852 | ** operation. |
||
6853 | ** |
||
6854 | ** [[sqlite3_backup_step()]] <b>sqlite3_backup_step()</b> |
||
6855 | ** |
||
6856 | ** ^Function sqlite3_backup_step(B,N) will copy up to N pages between |
||
6857 | ** the source and destination databases specified by [sqlite3_backup] object B. |
||
6858 | ** ^If N is negative, all remaining source pages are copied. |
||
6859 | ** ^If sqlite3_backup_step(B,N) successfully copies N pages and there |
||
6860 | ** are still more pages to be copied, then the function returns [SQLITE_OK]. |
||
6861 | ** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages |
||
6862 | ** from source to destination, then it returns [SQLITE_DONE]. |
||
6863 | ** ^If an error occurs while running sqlite3_backup_step(B,N), |
||
6864 | ** then an [error code] is returned. ^As well as [SQLITE_OK] and |
||
6865 | ** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY], |
||
6866 | ** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an |
||
6867 | ** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code. |
||
6868 | ** |
||
6869 | ** ^(The sqlite3_backup_step() might return [SQLITE_READONLY] if |
||
6870 | ** <ol> |
||
6871 | ** <li> the destination database was opened read-only, or |
||
6872 | ** <li> the destination database is using write-ahead-log journaling |
||
6873 | ** and the destination and source page sizes differ, or |
||
6874 | ** <li> the destination database is an in-memory database and the |
||
6875 | ** destination and source page sizes differ. |
||
6876 | ** </ol>)^ |
||
6877 | ** |
||
6878 | ** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then |
||
6879 | ** the [sqlite3_busy_handler | busy-handler function] |
||
6880 | ** is invoked (if one is specified). ^If the |
||
6881 | ** busy-handler returns non-zero before the lock is available, then |
||
6882 | ** [SQLITE_BUSY] is returned to the caller. ^In this case the call to |
||
6883 | ** sqlite3_backup_step() can be retried later. ^If the source |
||
6884 | ** [database connection] |
||
6885 | ** is being used to write to the source database when sqlite3_backup_step() |
||
6886 | ** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this |
||
6887 | ** case the call to sqlite3_backup_step() can be retried later on. ^(If |
||
6888 | ** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or |
||
6889 | ** [SQLITE_READONLY] is returned, then |
||
6890 | ** there is no point in retrying the call to sqlite3_backup_step(). These |
||
6891 | ** errors are considered fatal.)^ The application must accept |
||
6892 | ** that the backup operation has failed and pass the backup operation handle |
||
6893 | ** to the sqlite3_backup_finish() to release associated resources. |
||
6894 | ** |
||
6895 | ** ^The first call to sqlite3_backup_step() obtains an exclusive lock |
||
6896 | ** on the destination file. ^The exclusive lock is not released until either |
||
6897 | ** sqlite3_backup_finish() is called or the backup operation is complete |
||
6898 | ** and sqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to |
||
6899 | ** sqlite3_backup_step() obtains a [shared lock] on the source database that |
||
6900 | ** lasts for the duration of the sqlite3_backup_step() call. |
||
6901 | ** ^Because the source database is not locked between calls to |
||
6902 | ** sqlite3_backup_step(), the source database may be modified mid-way |
||
6903 | ** through the backup process. ^If the source database is modified by an |
||
6904 | ** external process or via a database connection other than the one being |
||
6905 | ** used by the backup operation, then the backup will be automatically |
||
6906 | ** restarted by the next call to sqlite3_backup_step(). ^If the source |
||
6907 | ** database is modified by the using the same database connection as is used |
||
6908 | ** by the backup operation, then the backup database is automatically |
||
6909 | ** updated at the same time. |
||
6910 | ** |
||
6911 | ** [[sqlite3_backup_finish()]] <b>sqlite3_backup_finish()</b> |
||
6912 | ** |
||
6913 | ** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the |
||
6914 | ** application wishes to abandon the backup operation, the application |
||
6915 | ** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish(). |
||
6916 | ** ^The sqlite3_backup_finish() interfaces releases all |
||
6917 | ** resources associated with the [sqlite3_backup] object. |
||
6918 | ** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any |
||
6919 | ** active write-transaction on the destination database is rolled back. |
||
6920 | ** The [sqlite3_backup] object is invalid |
||
6921 | ** and may not be used following a call to sqlite3_backup_finish(). |
||
6922 | ** |
||
6923 | ** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no |
||
6924 | ** sqlite3_backup_step() errors occurred, regardless or whether or not |
||
6925 | ** sqlite3_backup_step() completed. |
||
6926 | ** ^If an out-of-memory condition or IO error occurred during any prior |
||
6927 | ** sqlite3_backup_step() call on the same [sqlite3_backup] object, then |
||
6928 | ** sqlite3_backup_finish() returns the corresponding [error code]. |
||
6929 | ** |
||
6930 | ** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step() |
||
6931 | ** is not a permanent error and does not affect the return value of |
||
6932 | ** sqlite3_backup_finish(). |
||
6933 | ** |
||
6934 | ** [[sqlite3_backup__remaining()]] [[sqlite3_backup_pagecount()]] |
||
6935 | ** <b>sqlite3_backup_remaining() and sqlite3_backup_pagecount()</b> |
||
6936 | ** |
||
6937 | ** ^Each call to sqlite3_backup_step() sets two values inside |
||
6938 | ** the [sqlite3_backup] object: the number of pages still to be backed |
||
6939 | ** up and the total number of pages in the source database file. |
||
6940 | ** The sqlite3_backup_remaining() and sqlite3_backup_pagecount() interfaces |
||
6941 | ** retrieve these two values, respectively. |
||
6942 | ** |
||
6943 | ** ^The values returned by these functions are only updated by |
||
6944 | ** sqlite3_backup_step(). ^If the source database is modified during a backup |
||
6945 | ** operation, then the values are not updated to account for any extra |
||
6946 | ** pages that need to be updated or the size of the source database file |
||
6947 | ** changing. |
||
6948 | ** |
||
6949 | ** <b>Concurrent Usage of Database Handles</b> |
||
6950 | ** |
||
6951 | ** ^The source [database connection] may be used by the application for other |
||
6952 | ** purposes while a backup operation is underway or being initialized. |
||
6953 | ** ^If SQLite is compiled and configured to support threadsafe database |
||
6954 | ** connections, then the source database connection may be used concurrently |
||
6955 | ** from within other threads. |
||
6956 | ** |
||
6957 | ** However, the application must guarantee that the destination |
||
6958 | ** [database connection] is not passed to any other API (by any thread) after |
||
6959 | ** sqlite3_backup_init() is called and before the corresponding call to |
||
6960 | ** sqlite3_backup_finish(). SQLite does not currently check to see |
||
6961 | ** if the application incorrectly accesses the destination [database connection] |
||
6962 | ** and so no error code is reported, but the operations may malfunction |
||
6963 | ** nevertheless. Use of the destination database connection while a |
||
6964 | ** backup is in progress might also also cause a mutex deadlock. |
||
6965 | ** |
||
6966 | ** If running in [shared cache mode], the application must |
||
6967 | ** guarantee that the shared cache used by the destination database |
||
6968 | ** is not accessed while the backup is running. In practice this means |
||
6969 | ** that the application must guarantee that the disk file being |
||
6970 | ** backed up to is not accessed by any connection within the process, |
||
6971 | ** not just the specific connection that was passed to sqlite3_backup_init(). |
||
6972 | ** |
||
6973 | ** The [sqlite3_backup] object itself is partially threadsafe. Multiple |
||
6974 | ** threads may safely make multiple concurrent calls to sqlite3_backup_step(). |
||
6975 | ** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount() |
||
6976 | ** APIs are not strictly speaking threadsafe. If they are invoked at the |
||
6977 | ** same time as another thread is invoking sqlite3_backup_step() it is |
||
6978 | ** possible that they return invalid values. |
||
6979 | */ |
||
6980 | //SQLITE_API sqlite3_backup *sqlite3_backup_init( |
||
6981 | // sqlite3 *pDest, /* Destination database handle */ |
||
6982 | // string zDestName, /* Destination database name */ |
||
6983 | // sqlite3 *pSource, /* Source database handle */ |
||
6984 | // string zSourceName /* Source database name */ |
||
6985 | //); |
||
6986 | //SQLITE_API int sqlite3_backup_step(sqlite3_backup *p, int nPage); |
||
6987 | //SQLITE_API int sqlite3_backup_finish(sqlite3_backup *p); |
||
6988 | //SQLITE_API int sqlite3_backup_remaining(sqlite3_backup *p); |
||
6989 | //SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p); |
||
6990 | |||
6991 | /* |
||
6992 | ** CAPI3REF: Unlock Notification |
||
6993 | ** |
||
6994 | ** ^When running in shared-cache mode, a database operation may fail with |
||
6995 | ** an [SQLITE_LOCKED] error if the required locks on the shared-cache or |
||
6996 | ** individual tables within the shared-cache cannot be obtained. See |
||
6997 | ** [SQLite Shared-Cache Mode] for a description of shared-cache locking. |
||
6998 | ** ^This API may be used to register a callback that SQLite will invoke |
||
6999 | ** when the connection currently holding the required lock relinquishes it. |
||
7000 | ** ^This API is only available if the library was compiled with the |
||
7001 | ** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined. |
||
7002 | ** |
||
7003 | ** See Also: [Using the SQLite Unlock Notification Feature]. |
||
7004 | ** |
||
7005 | ** ^Shared-cache locks are released when a database connection concludes |
||
7006 | ** its current transaction, either by committing it or rolling it back. |
||
7007 | ** |
||
7008 | ** ^When a connection (known as the blocked connection) fails to obtain a |
||
7009 | ** shared-cache lock and SQLITE_LOCKED is returned to the caller, the |
||
7010 | ** identity of the database connection (the blocking connection) that |
||
7011 | ** has locked the required resource is stored internally. ^After an |
||
7012 | ** application receives an SQLITE_LOCKED error, it may call the |
||
7013 | ** sqlite3_unlock_notify() method with the blocked connection handle as |
||
7014 | ** the first argument to register for a callback that will be invoked |
||
7015 | ** when the blocking connections current transaction is concluded. ^The |
||
7016 | ** callback is invoked from within the [sqlite3_step] or [sqlite3_close] |
||
7017 | ** call that concludes the blocking connections transaction. |
||
7018 | ** |
||
7019 | ** ^(If sqlite3_unlock_notify() is called in a multi-threaded application, |
||
7020 | ** there is a chance that the blocking connection will have already |
||
7021 | ** concluded its transaction by the time sqlite3_unlock_notify() is invoked. |
||
7022 | ** If this happens, then the specified callback is invoked immediately, |
||
7023 | ** from within the call to sqlite3_unlock_notify().)^ |
||
7024 | ** |
||
7025 | ** ^If the blocked connection is attempting to obtain a write-lock on a |
||
7026 | ** shared-cache table, and more than one other connection currently holds |
||
7027 | ** a read-lock on the same table, then SQLite arbitrarily selects one of |
||
7028 | ** the other connections to use as the blocking connection. |
||
7029 | ** |
||
7030 | ** ^(There may be at most one unlock-notify callback registered by a |
||
7031 | ** blocked connection. If sqlite3_unlock_notify() is called when the |
||
7032 | ** blocked connection already has a registered unlock-notify callback, |
||
7033 | ** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is |
||
7034 | ** called with a NULL pointer as its second argument, then any existing |
||
7035 | ** unlock-notify callback is canceled. ^The blocked connections |
||
7036 | ** unlock-notify callback may also be canceled by closing the blocked |
||
7037 | ** connection using [sqlite3_close()]. |
||
7038 | ** |
||
7039 | ** The unlock-notify callback is not reentrant. If an application invokes |
||
7040 | ** any sqlite3_xxx API functions from within an unlock-notify callback, a |
||
7041 | ** crash or deadlock may be the result. |
||
7042 | ** |
||
7043 | ** ^Unless deadlock is detected (see below), sqlite3_unlock_notify() always |
||
7044 | ** returns SQLITE_OK. |
||
7045 | ** |
||
7046 | ** <b>Callback Invocation Details</b> |
||
7047 | ** |
||
7048 | ** When an unlock-notify callback is registered, the application provides a |
||
7049 | ** single void* pointer that is passed to the callback when it is invoked. |
||
7050 | ** However, the signature of the callback function allows SQLite to pass |
||
7051 | ** it an array of void* context pointers. The first argument passed to |
||
7052 | ** an unlock-notify callback is a pointer to an array of void* pointers, |
||
7053 | ** and the second is the number of entries in the array. |
||
7054 | ** |
||
7055 | ** When a blocking connections transaction is concluded, there may be |
||
7056 | ** more than one blocked connection that has registered for an unlock-notify |
||
7057 | ** callback. ^If two or more such blocked connections have specified the |
||
7058 | ** same callback function, then instead of invoking the callback function |
||
7059 | ** multiple times, it is invoked once with the set of void* context pointers |
||
7060 | ** specified by the blocked connections bundled together into an array. |
||
7061 | ** This gives the application an opportunity to prioritize any actions |
||
7062 | ** related to the set of unblocked database connections. |
||
7063 | ** |
||
7064 | ** <b>Deadlock Detection</b> |
||
7065 | ** |
||
7066 | ** Assuming that after registering for an unlock-notify callback a |
||
7067 | ** database waits for the callback to be issued before taking any further |
||
7068 | ** action (a reasonable assumption), then using this API may cause the |
||
7069 | ** application to deadlock. For example, if connection X is waiting for |
||
7070 | ** connection Y's transaction to be concluded, and similarly connection |
||
7071 | ** Y is waiting on connection X's transaction, then neither connection |
||
7072 | ** will proceed and the system may remain deadlocked indefinitely. |
||
7073 | ** |
||
7074 | ** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock |
||
7075 | ** detection. ^If a given call to sqlite3_unlock_notify() would put the |
||
7076 | ** system in a deadlocked state, then SQLITE_LOCKED is returned and no |
||
7077 | ** unlock-notify callback is registered. The system is said to be in |
||
7078 | ** a deadlocked state if connection A has registered for an unlock-notify |
||
7079 | ** callback on the conclusion of connection B's transaction, and connection |
||
7080 | ** B has itself registered for an unlock-notify callback when connection |
||
7081 | ** A's transaction is concluded. ^Indirect deadlock is also detected, so |
||
7082 | ** the system is also considered to be deadlocked if connection B has |
||
7083 | ** registered for an unlock-notify callback on the conclusion of connection |
||
7084 | ** C's transaction, where connection C is waiting on connection A. ^Any |
||
7085 | ** number of levels of indirection are allowed. |
||
7086 | ** |
||
7087 | ** <b>The "DROP TABLE" Exception</b> |
||
7088 | ** |
||
7089 | ** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost |
||
7090 | ** always appropriate to call sqlite3_unlock_notify(). There is however, |
||
7091 | ** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement, |
||
7092 | ** SQLite checks if there are any currently executing SELECT statements |
||
7093 | ** that belong to the same connection. If there are, SQLITE_LOCKED is |
||
7094 | ** returned. In this case there is no "blocking connection", so invoking |
||
7095 | ** sqlite3_unlock_notify() results in the unlock-notify callback being |
||
7096 | ** invoked immediately. If the application then re-attempts the "DROP TABLE" |
||
7097 | ** or "DROP INDEX" query, an infinite loop might be the result. |
||
7098 | ** |
||
7099 | ** One way around this problem is to check the extended error code returned |
||
7100 | ** by an sqlite3_step() call. ^(If there is a blocking connection, then the |
||
7101 | ** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in |
||
7102 | ** the special "DROP TABLE/INDEX" case, the extended error code is just |
||
7103 | ** SQLITE_LOCKED.)^ |
||
7104 | */ |
||
7105 | //SQLITE_API int sqlite3_unlock_notify( |
||
7106 | // sqlite3 *pBlocked, /* Waiting connection */ |
||
7107 | // void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */ |
||
7108 | // void *pNotifyArg /* Argument to pass to xNotify */ |
||
7109 | //); |
||
7110 | |||
7111 | |||
7112 | /* |
||
7113 | ** CAPI3REF: String Comparison |
||
7114 | ** |
||
7115 | ** ^The [sqlite3_strnicmp()] API allows applications and extensions to |
||
7116 | ** compare the contents of two buffers containing UTF-8 strings in a |
||
7117 | ** case-independent fashion, using the same definition of case independence |
||
7118 | ** that SQLite uses internally when comparing identifiers. |
||
7119 | */ |
||
7120 | //SQLITE_API int sqlite3_strnicmp(string , string , int); |
||
7121 | |||
7122 | /* |
||
7123 | ** CAPI3REF: Error Logging Interface |
||
7124 | ** |
||
7125 | ** ^The [sqlite3_log()] interface writes a message into the error log |
||
7126 | ** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()]. |
||
7127 | ** ^If logging is enabled, the zFormat string and subsequent arguments are |
||
7128 | ** used with [sqlite3_snprintf()] to generate the final output string. |
||
7129 | ** |
||
7130 | ** The sqlite3_log() interface is intended for use by extensions such as |
||
7131 | ** virtual tables, collating functions, and SQL functions. While there is |
||
7132 | ** nothing to prevent an application from calling sqlite3_log(), doing so |
||
7133 | ** is considered bad form. |
||
7134 | ** |
||
7135 | ** The zFormat string must not be NULL. |
||
7136 | ** |
||
7137 | ** To avoid deadlocks and other threading problems, the sqlite3_log() routine |
||
7138 | ** will not use dynamically allocated memory. The log message is stored in |
||
7139 | ** a fixed-length buffer on the stack. If the log message is longer than |
||
7140 | ** a few hundred characters, it will be truncated to the length of the |
||
7141 | ** buffer. |
||
7142 | */ |
||
7143 | //SQLITE_API void sqlite3_log(int iErrCode, string zFormat, ...); |
||
7144 | |||
7145 | /* |
||
7146 | ** CAPI3REF: Write-Ahead Log Commit Hook |
||
7147 | ** |
||
7148 | ** ^The [sqlite3_wal_hook()] function is used to register a callback that |
||
7149 | ** will be invoked each time a database connection commits data to a |
||
7150 | ** [write-ahead log] (i.e. whenever a transaction is committed in |
||
7151 | ** [journal_mode | journal_mode=WAL mode]). |
||
7152 | ** |
||
7153 | ** ^The callback is invoked by SQLite after the commit has taken place and |
||
7154 | ** the associated write-lock on the database released, so the implementation |
||
7155 | ** may read, write or [checkpoint] the database as required. |
||
7156 | ** |
||
7157 | ** ^The first parameter passed to the callback function when it is invoked |
||
7158 | ** is a copy of the third parameter passed to sqlite3_wal_hook() when |
||
7159 | ** registering the callback. ^The second is a copy of the database handle. |
||
7160 | ** ^The third parameter is the name of the database that was written to - |
||
7161 | ** either "main" or the name of an [ATTACH]-ed database. ^The fourth parameter |
||
7162 | ** is the number of pages currently in the write-ahead log file, |
||
7163 | ** including those that were just committed. |
||
7164 | ** |
||
7165 | ** The callback function should normally return [SQLITE_OK]. ^If an error |
||
7166 | ** code is returned, that error will propagate back up through the |
||
7167 | ** SQLite code base to cause the statement that provoked the callback |
||
7168 | ** to report an error, though the commit will have still occurred. If the |
||
7169 | ** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value |
||
7170 | ** that does not correspond to any valid SQLite error code, the results |
||
7171 | ** are undefined. |
||
7172 | ** |
||
7173 | ** A single database handle may have at most a single write-ahead log callback |
||
7174 | ** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any |
||
7175 | ** previously registered write-ahead log callback. ^Note that the |
||
7176 | ** [sqlite3_wal_autocheckpoint()] interface and the |
||
7177 | ** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will |
||
7178 | ** those overwrite any prior [sqlite3_wal_hook()] settings. |
||
7179 | */ |
||
7180 | //SQLITE_API void *sqlite3_wal_hook( |
||
7181 | // sqlite3*, |
||
7182 | // int()(void *,sqlite3*,const char*,int), |
||
7183 | // void* |
||
7184 | //); |
||
7185 | |||
7186 | /* |
||
7187 | ** CAPI3REF: Configure an auto-checkpoint |
||
7188 | ** |
||
7189 | ** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around |
||
7190 | ** [sqlite3_wal_hook()] that causes any database on [database connection] D |
||
7191 | ** to automatically [checkpoint] |
||
7192 | ** after committing a transaction if there are N or |
||
7193 | ** more frames in the [write-ahead log] file. ^Passing zero or |
||
7194 | ** a negative value as the nFrame parameter disables automatic |
||
7195 | ** checkpoints entirely. |
||
7196 | ** |
||
7197 | ** ^The callback registered by this function replaces any existing callback |
||
7198 | ** registered using [sqlite3_wal_hook()]. ^Likewise, registering a callback |
||
7199 | ** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism |
||
7200 | ** configured by this function. |
||
7201 | ** |
||
7202 | ** ^The [wal_autocheckpoint pragma] can be used to invoke this interface |
||
7203 | ** from SQL. |
||
7204 | ** |
||
7205 | ** ^Every new [database connection] defaults to having the auto-checkpoint |
||
7206 | ** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT] |
||
7207 | ** pages. The use of this interface |
||
7208 | ** for a particular application. |
||
7209 | */ |
||
7210 | //SQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 db, int N); |
||
7211 | |||
7212 | /* |
||
7213 | ** CAPI3REF: Checkpoint a database |
||
7214 | ** |
||
7215 | ** ^The [sqlite3_wal_checkpoint(D,X)] interface causes database named X |
||
7216 | ** on [database connection] D to be [checkpointed]. ^If X is NULL or an |
||
7217 | ** empty string, then a checkpoint is run on all databases of |
||
7218 | ** connection D. ^If the database connection D is not in |
||
7219 | ** [WAL | write-ahead log mode] then this interface is a harmless no-op. |
||
7220 | ** |
||
7221 | ** ^The [wal_checkpoint pragma] can be used to invoke this interface |
||
7222 | ** from SQL. ^The [sqlite3_wal_autocheckpoint()] interface and the |
||
7223 | ** [wal_autocheckpoint pragma] can be used to cause this interface to be |
||
7224 | ** run whenever the WAL reaches a certain size threshold. |
||
7225 | ** |
||
7226 | ** See also: [sqlite3_wal_checkpoint_v2()] |
||
7227 | */ |
||
7228 | //SQLITE_API int sqlite3_wal_checkpoint(sqlite3 db, string zDb); |
||
7229 | |||
7230 | /* |
||
7231 | ** CAPI3REF: Checkpoint a database |
||
7232 | ** |
||
7233 | ** Run a checkpoint operation on WAL database zDb attached to database |
||
7234 | ** handle db. The specific operation is determined by the value of the |
||
7235 | ** eMode parameter: |
||
7236 | ** |
||
7237 | ** <dl> |
||
7238 | ** <dt>SQLITE_CHECKPOINT_PASSIVE<dd> |
||
7239 | ** Checkpoint as many frames as possible without waiting for any database |
||
7240 | ** readers or writers to finish. Sync the db file if all frames in the log |
||
7241 | ** are checkpointed. This mode is the same as calling |
||
7242 | ** sqlite3_wal_checkpoint(). The busy-handler callback is never invoked. |
||
7243 | ** |
||
7244 | ** <dt>SQLITE_CHECKPOINT_FULL<dd> |
||
7245 | ** This mode blocks (calls the busy-handler callback) until there is no |
||
7246 | ** database writer and all readers are reading from the most recent database |
||
7247 | ** snapshot. It then checkpoints all frames in the log file and syncs the |
||
7248 | ** database file. This call blocks database writers while it is running, |
||
7249 | ** but not database readers. |
||
7250 | ** |
||
7251 | ** <dt>SQLITE_CHECKPOINT_RESTART<dd> |
||
7252 | ** This mode works the same way as SQLITE_CHECKPOINT_FULL, except after |
||
7253 | ** checkpointing the log file it blocks (calls the busy-handler callback) |
||
7254 | ** until all readers are reading from the database file only. This ensures |
||
7255 | ** that the next client to write to the database file restarts the log file |
||
7256 | ** from the beginning. This call blocks database writers while it is running, |
||
7257 | ** but not database readers. |
||
7258 | ** </dl> |
||
7259 | ** |
||
7260 | ** If pnLog is not NULL, then *pnLog is set to the total number of frames in |
||
7261 | ** the log file before returning. If pnCkpt is not NULL, then *pnCkpt is set to |
||
7262 | ** the total number of checkpointed frames (including any that were already |
||
7263 | ** checkpointed when this function is called). *pnLog and *pnCkpt may be |
||
7264 | ** populated even if sqlite3_wal_checkpoint_v2() returns other than SQLITE_OK. |
||
7265 | ** If no values are available because of an error, they are both set to -1 |
||
7266 | ** before returning to communicate this to the caller. |
||
7267 | ** |
||
7268 | ** All calls obtain an exclusive "checkpoint" lock on the database file. If |
||
7269 | ** any other process is running a checkpoint operation at the same time, the |
||
7270 | ** lock cannot be obtained and SQLITE_BUSY is returned. Even if there is a |
||
7271 | ** busy-handler configured, it will not be invoked in this case. |
||
7272 | ** |
||
7273 | ** The SQLITE_CHECKPOINT_FULL and RESTART modes also obtain the exclusive |
||
7274 | ** "writer" lock on the database file. If the writer lock cannot be obtained |
||
7275 | ** immediately, and a busy-handler is configured, it is invoked and the writer |
||
7276 | ** lock retried until either the busy-handler returns 0 or the lock is |
||
7277 | ** successfully obtained. The busy-handler is also invoked while waiting for |
||
7278 | ** database readers as described above. If the busy-handler returns 0 before |
||
7279 | ** the writer lock is obtained or while waiting for database readers, the |
||
7280 | ** checkpoint operation proceeds from that point in the same way as |
||
7281 | ** SQLITE_CHECKPOINT_PASSIVE - checkpointing as many frames as possible |
||
7282 | ** without blocking any further. SQLITE_BUSY is returned in this case. |
||
7283 | ** |
||
7284 | ** If parameter zDb is NULL or points to a zero length string, then the |
||
7285 | ** specified operation is attempted on all WAL databases. In this case the |
||
7286 | ** values written to output parameters *pnLog and *pnCkpt are undefined. If |
||
7287 | ** an SQLITE_BUSY error is encountered when processing one or more of the |
||
7288 | ** attached WAL databases, the operation is still attempted on any remaining |
||
7289 | ** attached databases and SQLITE_BUSY is returned to the caller. If any other |
||
7290 | ** error occurs while processing an attached database, processing is abandoned |
||
7291 | ** and the error code returned to the caller immediately. If no error |
||
7292 | ** (SQLITE_BUSY or otherwise) is encountered while processing the attached |
||
7293 | ** databases, SQLITE_OK is returned. |
||
7294 | ** |
||
7295 | ** If database zDb is the name of an attached database that is not in WAL |
||
7296 | ** mode, SQLITE_OK is returned and both *pnLog and *pnCkpt set to -1. If |
||
7297 | ** zDb is not NULL (or a zero length string) and is not the name of any |
||
7298 | ** attached database, SQLITE_ERROR is returned to the caller. |
||
7299 | */ |
||
7300 | //SQLITE_API int sqlite3_wal_checkpoint_v2( |
||
7301 | // sqlite3 db, /* Database handle */ |
||
7302 | // string zDb, /* Name of attached database (or NULL) */ |
||
7303 | // int eMode, /* SQLITE_CHECKPOINT_* value */ |
||
7304 | // int *pnLog, /* OUT: Size of WAL log in frames */ |
||
7305 | // int *pnCkpt /* OUT: Total number of frames checkpointed */ |
||
7306 | //); |
||
7307 | |||
7308 | /* |
||
7309 | ** CAPI3REF: Checkpoint operation parameters |
||
7310 | ** |
||
7311 | ** These constants can be used as the 3rd parameter to |
||
7312 | ** [sqlite3_wal_checkpoint_v2()]. See the [sqlite3_wal_checkpoint_v2()] |
||
7313 | ** documentation for additional information about the meaning and use of |
||
7314 | ** each of these values. |
||
7315 | */ |
||
7316 | //#define SQLITE_CHECKPOINT_PASSIVE 0 |
||
7317 | //#define SQLITE_CHECKPOINT_FULL 1 |
||
7318 | //#define SQLITE_CHECKPOINT_RESTART 2 |
||
7319 | static public int SQLITE_CHECKPOINT_PASSIVE = 0; |
||
7320 | static public int SQLITE_CHECKPOINT_FULL = 1; |
||
7321 | static public int SQLITE_CHECKPOINT_RESTART = 2; |
||
7322 | |||
7323 | |||
7324 | /* |
||
7325 | ** CAPI3REF: Virtual Table Interface Configuration |
||
7326 | ** |
||
7327 | ** This function may be called by either the [xConnect] or [xCreate] method |
||
7328 | ** of a [virtual table] implementation to configure |
||
7329 | ** various facets of the virtual table interface. |
||
7330 | ** |
||
7331 | ** If this interface is invoked outside the context of an xConnect or |
||
7332 | ** xCreate virtual table method then the behavior is undefined. |
||
7333 | ** |
||
7334 | ** At present, there is only one option that may be configured using |
||
7335 | ** this function. (See [SQLITE_VTAB_CONSTRAINT_SUPPORT].) Further options |
||
7336 | ** may be added in the future. |
||
7337 | */ |
||
7338 | //SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, ...); |
||
7339 | |||
7340 | /* |
||
7341 | ** CAPI3REF: Virtual Table Configuration Options |
||
7342 | ** |
||
7343 | ** These macros define the various options to the |
||
7344 | ** [sqlite3_vtab_config()] interface that [virtual table] implementations |
||
7345 | ** can use to customize and optimize their behavior. |
||
7346 | ** |
||
7347 | ** <dl> |
||
7348 | ** <dt>SQLITE_VTAB_CONSTRAINT_SUPPORT |
||
7349 | ** <dd>Calls of the form |
||
7350 | ** [sqlite3_vtab_config](db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported, |
||
7351 | ** where X is an integer. If X is zero, then the [virtual table] whose |
||
7352 | ** [xCreate] or [xConnect] method invoked [sqlite3_vtab_config()] does not |
||
7353 | ** support constraints. In this configuration (which is the default) if |
||
7354 | ** a call to the [xUpdate] method returns [SQLITE_CONSTRAINT], then the entire |
||
7355 | ** statement is rolled back as if [ON CONFLICT | OR ABORT] had been |
||
7356 | ** specified as part of the users SQL statement, regardless of the actual |
||
7357 | ** ON CONFLICT mode specified. |
||
7358 | ** |
||
7359 | ** If X is non-zero, then the virtual table implementation guarantees |
||
7360 | ** that if [xUpdate] returns [SQLITE_CONSTRAINT], it will do so before |
||
7361 | ** any modifications to internal or persistent data structures have been made. |
||
7362 | ** If the [ON CONFLICT] mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite |
||
7363 | ** is able to roll back a statement or database transaction, and abandon |
||
7364 | ** or continue processing the current SQL statement as appropriate. |
||
7365 | ** If the ON CONFLICT mode is REPLACE and the [xUpdate] method returns |
||
7366 | ** [SQLITE_CONSTRAINT], SQLite handles this as if the ON CONFLICT mode |
||
7367 | ** had been ABORT. |
||
7368 | ** |
||
7369 | ** Virtual table implementations that are required to handle OR REPLACE |
||
7370 | ** must do so within the [xUpdate] method. If a call to the |
||
7371 | ** [sqlite3_vtab_on_conflict()] function indicates that the current ON |
||
7372 | ** CONFLICT policy is REPLACE, the virtual table implementation should |
||
7373 | ** silently replace the appropriate rows within the xUpdate callback and |
||
7374 | ** return SQLITE_OK. Or, if this is not possible, it may return |
||
7375 | ** SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT |
||
7376 | ** constraint handling. |
||
7377 | ** </dl> |
||
7378 | */ |
||
7379 | //#define SQLITE_VTAB_CONSTRAINT_SUPPORT 1 |
||
7380 | public const int SQLITE_VTAB_CONSTRAINT_SUPPORT = 1; |
||
7381 | |||
7382 | /* |
||
7383 | ** CAPI3REF: Determine The Virtual Table Conflict Policy |
||
7384 | ** |
||
7385 | ** This function may only be called from within a call to the [xUpdate] method |
||
7386 | ** of a [virtual table] implementation for an INSERT or UPDATE operation. ^The |
||
7387 | ** value returned is one of [SQLITE_ROLLBACK], [SQLITE_IGNORE], [SQLITE_FAIL], |
||
7388 | ** [SQLITE_ABORT], or [SQLITE_REPLACE], according to the [ON CONFLICT] mode |
||
7389 | ** of the SQL statement that triggered the call to the [xUpdate] method of the |
||
7390 | ** [virtual table]. |
||
7391 | */ |
||
7392 | //SQLITE_API int sqlite3_vtab_on_conflict(sqlite3 ); |
||
7393 | |||
7394 | /* |
||
7395 | ** CAPI3REF: Conflict resolution modes |
||
7396 | ** |
||
7397 | ** These constants are returned by [sqlite3_vtab_on_conflict()] to |
||
7398 | ** inform a [virtual table] implementation what the [ON CONFLICT] mode |
||
7399 | ** is for the SQL statement being evaluated. |
||
7400 | ** |
||
7401 | ** Note that the [SQLITE_IGNORE] constant is also used as a potential |
||
7402 | ** return value from the [sqlite3_set_authorizer()] callback and that |
||
7403 | ** [SQLITE_ABORT] is also a [result code]. |
||
7404 | */ |
||
7405 | //#define SQLITE_ROLLBACK 1 |
||
7406 | public const int SQLITE_ROLLBACK = 1; |
||
7407 | /* #define SQLITE_IGNORE 2 // Also used by sqlite3_authorizer() callback */ |
||
7408 | //#define SQLITE_FAIL 3 |
||
7409 | public const int SQLITE_FAIL = 3; |
||
7410 | /* #define SQLITE_ABORT 4 // Also an error code */ |
||
7411 | //#define SQLITE_REPLACE 5 |
||
7412 | public const int SQLITE_REPLACE = 5; |
||
7413 | |||
7414 | |||
7415 | /* |
||
7416 | ** Undo the hack that converts floating point types to integer for |
||
7417 | ** builds on processors without floating point support. |
||
7418 | */ |
||
7419 | //#if SQLITE_OMIT_FLOATING_POINT |
||
7420 | //# undef double |
||
7421 | //#endif |
||
7422 | |||
7423 | //#if __cplusplus |
||
7424 | //} /* End of the 'extern "C"' block */ |
||
7425 | //#endif |
||
7426 | //#endif |
||
7427 | |||
7428 | /* |
||
7429 | ** 2010 August 30 |
||
7430 | ** |
||
7431 | ** The author disclaims copyright to this source code. In place of |
||
7432 | ** a legal notice, here is a blessing: |
||
7433 | ** |
||
7434 | ** May you do good and not evil. |
||
7435 | ** May you find forgiveness for yourself and forgive others. |
||
7436 | ** May you share freely, never taking more than you give. |
||
7437 | ** |
||
7438 | ************************************************************************* |
||
7439 | */ |
||
7440 | |||
7441 | //#if !_SQLITE3RTREE_H_ |
||
7442 | //#define _SQLITE3RTREE_H_ |
||
7443 | |||
7444 | |||
7445 | //#if __cplusplus |
||
7446 | //extern "C" { |
||
7447 | //#endif |
||
7448 | |||
7449 | //typedef struct sqlite3_rtree_geometry sqlite3_rtree_geometry; |
||
7450 | |||
7451 | /* |
||
7452 | ** Register a geometry callback named zGeom that can be used as part of an |
||
7453 | ** R-Tree geometry query as follows: |
||
7454 | ** |
||
7455 | ** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zGeom(... params ...) |
||
7456 | */ |
||
7457 | //SQLITE_API int sqlite3_rtree_geometry_callback( |
||
7458 | // sqlite3 db, |
||
7459 | // string zGeom, |
||
7460 | // int (*xGeom)(sqlite3_rtree_geometry *, int nCoord, double *aCoord, int *pRes), |
||
7461 | // void *pContext |
||
7462 | //); |
||
7463 | |||
7464 | |||
7465 | /* |
||
7466 | ** A pointer to a structure of the following type is passed as the first |
||
7467 | ** argument to callbacks registered using rtree_geometry_callback(). |
||
7468 | */ |
||
7469 | //struct sqlite3_rtree_geometry { |
||
7470 | // void *pContext; /* Copy of pContext passed to s_r_g_c() */ |
||
7471 | // int nParam; /* Size of array aParam[] */ |
||
7472 | // double *aParam; /* Parameters passed to SQL geom function */ |
||
7473 | // void *pUser; /* Callback implementation user data */ |
||
7474 | // void (*xDelUser)(void ); /* Called by SQLite to clean up pUser */ |
||
7475 | //}; |
||
7476 | |||
7477 | |||
7478 | //#if __cplusplus |
||
7479 | //} /* end of the 'extern "C"' block */ |
||
7480 | //#endif |
||
7481 | |||
7482 | //#endif /* ifndef _SQLITE3RTREE_H_ */ |
||
7483 | |||
7484 | } |
||
7485 | } |