USB/UHCI - Cleanup
[tpg/acess2.git] / Usermode / include / sqlite3.h
1 /*
2 ** 2001 September 15
3 **
4 ** The author disclaims copyright to this source code.  In place of
5 ** a legal notice, here is a blessing:
6 **
7 **    May you do good and not evil.
8 **    May you find forgiveness for yourself and forgive others.
9 **    May you share freely, never taking more than you give.
10 **
11 *************************************************************************
12 ** This header file defines the interface that the SQLite library
13 ** presents to client programs.  If a C-function, structure, datatype,
14 ** or constant definition does not appear in this file, then it is
15 ** not a published API of SQLite, is subject to change without
16 ** notice, and should not be referenced by programs that use SQLite.
17 **
18 ** Some of the definitions that are in this file are marked as
19 ** "experimental".  Experimental interfaces are normally new
20 ** features recently added to SQLite.  We do not anticipate changes 
21 ** to experimental interfaces but reserve to make minor changes if
22 ** experience from use "in the wild" suggest such changes are prudent.
23 **
24 ** The official C-language API documentation for SQLite is derived
25 ** from comments in this file.  This file is the authoritative source
26 ** on how SQLite interfaces are suppose to operate.
27 **
28 ** The name of this file under configuration management is "sqlite.h.in".
29 ** The makefile makes some minor changes to this file (such as inserting
30 ** the version number) and changes its name to "sqlite3.h" as
31 ** part of the build process.
32 **
33 ** @(#) $Id: sqlite.h.in,v 1.284 2008/02/06 14:11:35 drh Exp $
34 */
35 #ifndef _SQLITE3_H_
36 #define _SQLITE3_H_
37 #include <stdarg.h>     /* Needed for the definition of va_list */
38
39 /*
40 ** Make sure we can call this stuff from C++.
41 */
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45
46
47 /*
48 ** Add the ability to override 'extern'
49 */
50 #ifndef SQLITE_EXTERN
51 # define SQLITE_EXTERN extern
52 #endif
53
54 /*
55 ** Make sure these symbols where not defined by some previous header
56 ** file.
57 */
58 #ifdef SQLITE_VERSION
59 # undef SQLITE_VERSION
60 #endif
61 #ifdef SQLITE_VERSION_NUMBER
62 # undef SQLITE_VERSION_NUMBER
63 #endif
64
65 /*
66 ** CAPI3REF: Compile-Time Library Version Numbers {F10010}
67 **
68 ** The SQLITE_VERSION and SQLITE_VERSION_NUMBER #defines in
69 ** the sqlite3.h file specify the version of SQLite with which
70 ** that header file is associated.
71 **
72 ** The "version" of SQLite is a strong of the form "X.Y.Z".
73 ** The phrase "alpha" or "beta" might be appended after the Z.
74 ** The X value is major version number always 3 in SQLite3.
75 ** The X value only changes when  backwards compatibility is
76 ** broken and we intend to never break
77 ** backwards compatibility.  The Y value is the minor version
78 ** number and only changes when
79 ** there are major feature enhancements that are forwards compatible
80 ** but not backwards compatible.  The Z value is release number
81 ** and is incremented with
82 ** each release but resets back to 0 when Y is incremented.
83 **
84 ** See also: [sqlite3_libversion()] and [sqlite3_libversion_number()].
85 **
86 ** INVARIANTS:
87 **
88 ** {F10011} The SQLITE_VERSION #define in the sqlite3.h header file
89 **          evaluates to a string literal that is the SQLite version
90 **          with which the header file is associated.
91 **
92 ** {F10014} The SQLITE_VERSION_NUMBER #define resolves to an integer
93 **          with the value  (X*1000000 + Y*1000 + Z) where X, Y, and
94 **          Z are the major version, minor version, and release number.
95 */
96 #define SQLITE_VERSION         "3.5.6"
97 #define SQLITE_VERSION_NUMBER 3005006
98
99 /*
100 ** CAPI3REF: Run-Time Library Version Numbers {F10020}
101 ** KEYWORDS: sqlite3_version
102 **
103 ** These features provide the same information as the [SQLITE_VERSION]
104 ** and [SQLITE_VERSION_NUMBER] #defines in the header, but are associated
105 ** with the library instead of the header file.  Cautious programmers might
106 ** include a check in their application to verify that 
107 ** sqlite3_libversion_number() always returns the value 
108 ** [SQLITE_VERSION_NUMBER].
109 **
110 ** The sqlite3_libversion() function returns the same information as is
111 ** in the sqlite3_version[] string constant.  The function is provided
112 ** for use in DLLs since DLL users usually do not have direct access to string
113 ** constants within the DLL.
114 **
115 ** INVARIANTS:
116 **
117 ** {F10021} The [sqlite3_libversion_number()] interface returns an integer
118 **          equal to [SQLITE_VERSION_NUMBER]. 
119 **
120 ** {F10022} The [sqlite3_version] string constant contains the text of the
121 **          [SQLITE_VERSION] string. 
122 **
123 ** {F10023} The [sqlite3_libversion()] function returns
124 **          a pointer to the [sqlite3_version] string constant.
125 */
126 SQLITE_EXTERN const char sqlite3_version[];
127 const char *sqlite3_libversion(void);
128 int sqlite3_libversion_number(void);
129
130 /*
131 ** CAPI3REF: Test To See If The Library Is Threadsafe {F10100}
132 **
133 ** SQLite can be compiled with or without mutexes.  When
134 ** the SQLITE_THREADSAFE C preprocessor macro is true, mutexes
135 ** are enabled and SQLite is threadsafe.  When that macro os false,
136 ** the mutexes are omitted.  Without the mutexes, it is not safe
137 ** to use SQLite from more than one thread.
138 **
139 ** There is a measurable performance penalty for enabling mutexes.
140 ** So if speed is of utmost importance, it makes sense to disable
141 ** the mutexes.  But for maximum safety, mutexes should be enabled.
142 ** The default behavior is for mutexes to be enabled.
143 **
144 ** This interface can be used by a program to make sure that the
145 ** version of SQLite that it is linking against was compiled with
146 ** the desired setting of the SQLITE_THREADSAFE macro.
147 **
148 ** INVARIANTS:
149 **
150 ** {F10101} The [sqlite3_threadsafe()] function returns nonzero if
151 **          SQLite was compiled with its mutexes enabled or zero
152 **          if SQLite was compiled with mutexes disabled.
153 */
154 int sqlite3_threadsafe(void);
155
156 /*
157 ** CAPI3REF: Database Connection Handle {F12000}
158 ** KEYWORDS: {database connection}
159 **
160 ** Each open SQLite database is represented by pointer to an instance of the
161 ** opaque structure named "sqlite3".  It is useful to think of an sqlite3
162 ** pointer as an object.  The [sqlite3_open()], [sqlite3_open16()], and
163 ** [sqlite3_open_v2()] interfaces are its constructors
164 ** and [sqlite3_close()] is its destructor.  There are many other interfaces
165 ** (such as [sqlite3_prepare_v2()], [sqlite3_create_function()], and
166 ** [sqlite3_busy_timeout()] to name but three) that are methods on this
167 ** object.
168 */
169 typedef struct sqlite3 sqlite3;
170
171
172 /*
173 ** CAPI3REF: 64-Bit Integer Types {F10200}
174 ** KEYWORDS: sqlite_int64 sqlite_uint64
175 **
176 ** Because there is no cross-platform way to specify 64-bit integer types
177 ** SQLite includes typedefs for 64-bit signed and unsigned integers.
178 **
179 ** The sqlite3_int64 and sqlite3_uint64 are the preferred type
180 ** definitions.  The sqlite_int64 and sqlite_uint64 types are
181 ** supported for backwards compatibility only.
182 **
183 ** INVARIANTS:
184 **
185 ** {F10201} The [sqlite_int64] and [sqlite3_int64] types specify a
186 **          64-bit signed integer.
187 **
188 ** {F10202} The [sqlite_uint64] and [sqlite3_uint64] types specify
189 **          a 64-bit unsigned integer.
190 */
191 #ifdef SQLITE_INT64_TYPE
192   typedef SQLITE_INT64_TYPE sqlite_int64;
193   typedef unsigned SQLITE_INT64_TYPE sqlite_uint64;
194 #elif defined(_MSC_VER) || defined(__BORLANDC__)
195   typedef __int64 sqlite_int64;
196   typedef unsigned __int64 sqlite_uint64;
197 #else
198   typedef long long int sqlite_int64;
199   typedef unsigned long long int sqlite_uint64;
200 #endif
201 typedef sqlite_int64 sqlite3_int64;
202 typedef sqlite_uint64 sqlite3_uint64;
203
204 /*
205 ** If compiling for a processor that lacks floating point support,
206 ** substitute integer for floating-point
207 */
208 #ifdef SQLITE_OMIT_FLOATING_POINT
209 # define double sqlite3_int64
210 #endif
211
212 /*
213 ** CAPI3REF: Closing A Database Connection {F12010}
214 **
215 ** This routine is the destructor for the [sqlite3] object.  
216 **
217 ** Applications should [sqlite3_finalize | finalize] all
218 ** [prepared statements] and
219 ** [sqlite3_blob_close | close] all [sqlite3_blob | BLOBs] 
220 ** associated with the [sqlite3] object prior
221 ** to attempting to close the [sqlite3] object.
222 **
223 ** <todo>What happens to pending transactions?  Are they
224 ** rolled back, or abandoned?</todo>
225 **
226 ** INVARIANTS:
227 **
228 ** {F12011} The [sqlite3_close()] interface destroys an [sqlite3] object
229 **          allocated by a prior call to [sqlite3_open()],
230 **          [sqlite3_open16()], or [sqlite3_open_v2()].
231 **
232 ** {F12012} The [sqlite3_close()] function releases all memory used by the
233 **          connection and closes all open files.
234 **
235 ** {F12013} If the database connection contains
236 **          [prepared statements] that have not been
237 **          finalized by [sqlite3_finalize()], then [sqlite3_close()]
238 **          returns [SQLITE_BUSY] and leaves the connection open.
239 **
240 ** {F12014} Giving sqlite3_close() a NULL pointer is a harmless no-op.
241 **
242 ** LIMITATIONS:
243 **
244 ** {U12015} The parameter to [sqlite3_close()] must be an [sqlite3] object
245 **          pointer previously obtained from [sqlite3_open()] or the 
246 **          equivalent, or NULL.
247 **
248 ** {U12016} The parameter to [sqlite3_close()] must not have been previously
249 **          closed.
250 */
251 int sqlite3_close(sqlite3 *);
252
253 /*
254 ** The type for a callback function.
255 ** This is legacy and deprecated.  It is included for historical
256 ** compatibility and is not documented.
257 */
258 typedef int (*sqlite3_callback)(void*,int,char**, char**);
259
260 /*
261 ** CAPI3REF: One-Step Query Execution Interface {F12100}
262 **
263 ** The sqlite3_exec() interface is a convenient way of running
264 ** one or more SQL statements without a lot of C code.  The
265 ** SQL statements are passed in as the second parameter to
266 ** sqlite3_exec().  The statements are evaluated one by one
267 ** until either an error or an interrupt is encountered or
268 ** until they are all done.  The 3rd parameter is an optional
269 ** callback that is invoked once for each row of any query results
270 ** produced by the SQL statements.  The 5th parameter tells where
271 ** to write any error messages.
272 **
273 ** The sqlite3_exec() interface is implemented in terms of
274 ** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()].
275 ** The sqlite3_exec() routine does nothing that cannot be done
276 ** by [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()].
277 ** The sqlite3_exec() is just a convenient wrapper.
278 **
279 ** INVARIANTS:
280 ** 
281 ** {F12101} The [sqlite3_exec()] interface evaluates zero or more UTF-8
282 **          encoded, semicolon-separated, SQL statements in the
283 **          zero-terminated string of its 2nd parameter within the
284 **          context of the [sqlite3] object given in the 1st parameter.
285 **
286 ** {F12104} The return value of [sqlite3_exec()] is SQLITE_OK if all
287 **          SQL statements run successfully.
288 **
289 ** {F12105} The return value of [sqlite3_exec()] is an appropriate 
290 **          non-zero error code if any SQL statement fails.
291 **
292 ** {F12107} If one or more of the SQL statements handed to [sqlite3_exec()]
293 **          return results and the 3rd parameter is not NULL, then
294 **          the callback function specified by the 3rd parameter is
295 **          invoked once for each row of result.
296 **
297 ** {F12110} If the callback returns a non-zero value then [sqlite3_exec()]
298 **          will aborted the SQL statement it is currently evaluating,
299 **          skip all subsequent SQL statements, and return [SQLITE_ABORT].
300 **          <todo>What happens to *errmsg here?  Does the result code for
301 **          sqlite3_errcode() get set?</todo>
302 **
303 ** {F12113} The [sqlite3_exec()] routine will pass its 4th parameter through
304 **          as the 1st parameter of the callback.
305 **
306 ** {F12116} The [sqlite3_exec()] routine sets the 2nd parameter of its
307 **          callback to be the number of columns in the current row of
308 **          result.
309 **
310 ** {F12119} The [sqlite3_exec()] routine sets the 3rd parameter of its 
311 **          callback to be an array of pointers to strings holding the
312 **          values for each column in the current result set row as
313 **          obtained from [sqlite3_column_text()].
314 **
315 ** {F12122} The [sqlite3_exec()] routine sets the 4th parameter of its
316 **          callback to be an array of pointers to strings holding the
317 **          names of result columns as obtained from [sqlite3_column_name()].
318 **
319 ** {F12125} If the 3rd parameter to [sqlite3_exec()] is NULL then
320 **          [sqlite3_exec()] never invokes a callback.  All query
321 **          results are silently discarded.
322 **
323 ** {F12128} If an error occurs while parsing or evaluating any of the SQL
324 **          statements handed to [sqlite3_exec()] then [sqlite3_exec()] will
325 **          return an [error code] other than [SQLITE_OK].
326 **
327 ** {F12131} If an error occurs while parsing or evaluating any of the SQL
328 **          handed to [sqlite3_exec()] and if the 5th parameter (errmsg)
329 **          to [sqlite3_exec()] is not NULL, then an error message is
330 **          allocated using the equivalent of [sqlite3_mprintf()] and
331 **          *errmsg is made to point to that message.
332 **
333 ** {F12134} The [sqlite3_exec()] routine does not change the value of
334 **          *errmsg if errmsg is NULL or if there are no errors.
335 **
336 ** {F12137} The [sqlite3_exec()] function sets the error code and message
337 **          accessible via [sqlite3_errcode()] and [sqlite3_errmsg()].
338 **
339 ** LIMITATIONS:
340 **
341 ** {U12141} The first parameter to [sqlite3_exec()] must be an valid and open
342 **          [database connection].
343 **
344 ** {U12142} The database connection must not be closed while
345 **          [sqlite3_exec()] is running.
346 ** 
347 ** {U12143} The calling function is should use [sqlite3_free()] to free
348 **          the memory that *errmsg is left pointing at once the error
349 **          message is no longer needed.
350 **
351 ** {U12145} The SQL statement text in the 2nd parameter to [sqlite3_exec()]
352 **          must remain unchanged while [sqlite3_exec()] is running.
353 */
354 int sqlite3_exec(
355   sqlite3*,                                  /* An open database */
356   const char *sql,                           /* SQL to be evaluted */
357   int (*callback)(void*,int,char**,char**),  /* Callback function */
358   void *,                                    /* 1st argument to callback */
359   char **errmsg                              /* Error msg written here */
360 );
361
362 /*
363 ** CAPI3REF: Result Codes {F10210}
364 ** KEYWORDS: SQLITE_OK {error code} {error codes}
365 **
366 ** Many SQLite functions return an integer result code from the set shown
367 ** here in order to indicates success or failure.
368 **
369 ** See also: [SQLITE_IOERR_READ | extended result codes]
370 */
371 #define SQLITE_OK           0   /* Successful result */
372 /* beginning-of-error-codes */
373 #define SQLITE_ERROR        1   /* SQL error or missing database */
374 #define SQLITE_INTERNAL     2   /* Internal logic error in SQLite */
375 #define SQLITE_PERM         3   /* Access permission denied */
376 #define SQLITE_ABORT        4   /* Callback routine requested an abort */
377 #define SQLITE_BUSY         5   /* The database file is locked */
378 #define SQLITE_LOCKED       6   /* A table in the database is locked */
379 #define SQLITE_NOMEM        7   /* A malloc() failed */
380 #define SQLITE_READONLY     8   /* Attempt to write a readonly database */
381 #define SQLITE_INTERRUPT    9   /* Operation terminated by sqlite3_interrupt()*/
382 #define SQLITE_IOERR       10   /* Some kind of disk I/O error occurred */
383 #define SQLITE_CORRUPT     11   /* The database disk image is malformed */
384 #define SQLITE_NOTFOUND    12   /* NOT USED. Table or record not found */
385 #define SQLITE_FULL        13   /* Insertion failed because database is full */
386 #define SQLITE_CANTOPEN    14   /* Unable to open the database file */
387 #define SQLITE_PROTOCOL    15   /* NOT USED. Database lock protocol error */
388 #define SQLITE_EMPTY       16   /* Database is empty */
389 #define SQLITE_SCHEMA      17   /* The database schema changed */
390 #define SQLITE_TOOBIG      18   /* String or BLOB exceeds size limit */
391 #define SQLITE_CONSTRAINT  19   /* Abort due to constraint violation */
392 #define SQLITE_MISMATCH    20   /* Data type mismatch */
393 #define SQLITE_MISUSE      21   /* Library used incorrectly */
394 #define SQLITE_NOLFS       22   /* Uses OS features not supported on host */
395 #define SQLITE_AUTH        23   /* Authorization denied */
396 #define SQLITE_FORMAT      24   /* Auxiliary database format error */
397 #define SQLITE_RANGE       25   /* 2nd parameter to sqlite3_bind out of range */
398 #define SQLITE_NOTADB      26   /* File opened that is not a database file */
399 #define SQLITE_ROW         100  /* sqlite3_step() has another row ready */
400 #define SQLITE_DONE        101  /* sqlite3_step() has finished executing */
401 /* end-of-error-codes */
402
403 /*
404 ** CAPI3REF: Extended Result Codes {F10220}
405 ** KEYWORDS: {extended error code} {extended error codes}
406 ** KEYWORDS: {extended result codes}
407 **
408 ** In its default configuration, SQLite API routines return one of 26 integer
409 ** [SQLITE_OK | result codes].  However, experience has shown that
410 ** many of these result codes are too course-grained.  They do not provide as
411 ** much information about problems as programmers might like.  In an effort to
412 ** address this, newer versions of SQLite (version 3.3.8 and later) include
413 ** support for additional result codes that provide more detailed information
414 ** about errors. The extended result codes are enabled or disabled
415 ** for each database connection using the [sqlite3_extended_result_codes()]
416 ** API.
417 ** 
418 ** Some of the available extended result codes are listed here.
419 ** One may expect the number of extended result codes will be expand
420 ** over time.  Software that uses extended result codes should expect
421 ** to see new result codes in future releases of SQLite.
422 **
423 ** The SQLITE_OK result code will never be extended.  It will always
424 ** be exactly zero.
425 ** 
426 ** INVARIANTS:
427 **
428 ** {F10223} The symbolic name for an extended result code always contains
429 **          a related primary result code as a prefix.
430 **
431 ** {F10224} Primary result code names contain a single "_" character.
432 **
433 ** {F10225} Extended result code names contain two or more "_" characters.
434 **
435 ** {F10226} The numeric value of an extended result code contains the
436 **          numeric value of its corresponding primary result code it
437 **          its least significant 8 bits.
438 */
439 #define SQLITE_IOERR_READ          (SQLITE_IOERR | (1<<8))
440 #define SQLITE_IOERR_SHORT_READ    (SQLITE_IOERR | (2<<8))
441 #define SQLITE_IOERR_WRITE         (SQLITE_IOERR | (3<<8))
442 #define SQLITE_IOERR_FSYNC         (SQLITE_IOERR | (4<<8))
443 #define SQLITE_IOERR_DIR_FSYNC     (SQLITE_IOERR | (5<<8))
444 #define SQLITE_IOERR_TRUNCATE      (SQLITE_IOERR | (6<<8))
445 #define SQLITE_IOERR_FSTAT         (SQLITE_IOERR | (7<<8))
446 #define SQLITE_IOERR_UNLOCK        (SQLITE_IOERR | (8<<8))
447 #define SQLITE_IOERR_RDLOCK        (SQLITE_IOERR | (9<<8))
448 #define SQLITE_IOERR_DELETE        (SQLITE_IOERR | (10<<8))
449 #define SQLITE_IOERR_BLOCKED       (SQLITE_IOERR | (11<<8))
450 #define SQLITE_IOERR_NOMEM         (SQLITE_IOERR | (12<<8))
451
452 /*
453 ** CAPI3REF: Flags For File Open Operations {F10230}
454 **
455 ** These bit values are intended for use in then
456 ** 3rd parameter to the [sqlite3_open_v2()] interface and
457 ** in the 4th parameter to the xOpen method of the
458 ** [sqlite3_vfs] object.
459 */
460 #define SQLITE_OPEN_READONLY         0x00000001
461 #define SQLITE_OPEN_READWRITE        0x00000002
462 #define SQLITE_OPEN_CREATE           0x00000004
463 #define SQLITE_OPEN_DELETEONCLOSE    0x00000008
464 #define SQLITE_OPEN_EXCLUSIVE        0x00000010
465 #define SQLITE_OPEN_MAIN_DB          0x00000100
466 #define SQLITE_OPEN_TEMP_DB          0x00000200
467 #define SQLITE_OPEN_TRANSIENT_DB     0x00000400
468 #define SQLITE_OPEN_MAIN_JOURNAL     0x00000800
469 #define SQLITE_OPEN_TEMP_JOURNAL     0x00001000
470 #define SQLITE_OPEN_SUBJOURNAL       0x00002000
471 #define SQLITE_OPEN_MASTER_JOURNAL   0x00004000
472
473 /*
474 ** CAPI3REF: Device Characteristics {F10240}
475 **
476 ** The xDeviceCapabilities method of the [sqlite3_io_methods]
477 ** object returns an integer which is a vector of the these
478 ** bit values expressing I/O characteristics of the mass storage
479 ** device that holds the file that the [sqlite3_io_methods]
480 ** refers to.
481 **
482 ** The SQLITE_IOCAP_ATOMIC property means that all writes of
483 ** any size are atomic.  The SQLITE_IOCAP_ATOMICnnn values
484 ** mean that writes of blocks that are nnn bytes in size and
485 ** are aligned to an address which is an integer multiple of
486 ** nnn are atomic.  The SQLITE_IOCAP_SAFE_APPEND value means
487 ** that when data is appended to a file, the data is appended
488 ** first then the size of the file is extended, never the other
489 ** way around.  The SQLITE_IOCAP_SEQUENTIAL property means that
490 ** information is written to disk in the same order as calls
491 ** to xWrite().
492 */
493 #define SQLITE_IOCAP_ATOMIC          0x00000001
494 #define SQLITE_IOCAP_ATOMIC512       0x00000002
495 #define SQLITE_IOCAP_ATOMIC1K        0x00000004
496 #define SQLITE_IOCAP_ATOMIC2K        0x00000008
497 #define SQLITE_IOCAP_ATOMIC4K        0x00000010
498 #define SQLITE_IOCAP_ATOMIC8K        0x00000020
499 #define SQLITE_IOCAP_ATOMIC16K       0x00000040
500 #define SQLITE_IOCAP_ATOMIC32K       0x00000080
501 #define SQLITE_IOCAP_ATOMIC64K       0x00000100
502 #define SQLITE_IOCAP_SAFE_APPEND     0x00000200
503 #define SQLITE_IOCAP_SEQUENTIAL      0x00000400
504
505 /*
506 ** CAPI3REF: File Locking Levels {F10250}
507 **
508 ** SQLite uses one of these integer values as the second
509 ** argument to calls it makes to the xLock() and xUnlock() methods
510 ** of an [sqlite3_io_methods] object.
511 */
512 #define SQLITE_LOCK_NONE          0
513 #define SQLITE_LOCK_SHARED        1
514 #define SQLITE_LOCK_RESERVED      2
515 #define SQLITE_LOCK_PENDING       3
516 #define SQLITE_LOCK_EXCLUSIVE     4
517
518 /*
519 ** CAPI3REF: Synchronization Type Flags {F10260}
520 **
521 ** When SQLite invokes the xSync() method of an
522 ** [sqlite3_io_methods] object it uses a combination of the
523 ** these integer values as the second argument.
524 **
525 ** When the SQLITE_SYNC_DATAONLY flag is used, it means that the
526 ** sync operation only needs to flush data to mass storage.  Inode
527 ** information need not be flushed. The SQLITE_SYNC_NORMAL means 
528 ** to use normal fsync() semantics. The SQLITE_SYNC_FULL flag means 
529 ** to use Mac OS-X style fullsync instead of fsync().
530 */
531 #define SQLITE_SYNC_NORMAL        0x00002
532 #define SQLITE_SYNC_FULL          0x00003
533 #define SQLITE_SYNC_DATAONLY      0x00010
534
535
536 /*
537 ** CAPI3REF: OS Interface Open File Handle {F11110}
538 **
539 ** An [sqlite3_file] object represents an open file in the OS
540 ** interface layer.  Individual OS interface implementations will
541 ** want to subclass this object by appending additional fields
542 ** for their own use.  The pMethods entry is a pointer to an
543 ** [sqlite3_io_methods] object that defines methods for performing
544 ** I/O operations on the open file.
545 */
546 typedef struct sqlite3_file sqlite3_file;
547 struct sqlite3_file {
548   const struct sqlite3_io_methods *pMethods;  /* Methods for an open file */
549 };
550
551 /*
552 ** CAPI3REF: OS Interface File Virtual Methods Object {F11120}
553 **
554 ** Every file opened by the [sqlite3_vfs] xOpen method contains a pointer to
555 ** an instance of the this object.  This object defines the
556 ** methods used to perform various operations against the open file.
557 **
558 ** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or
559 ** [SQLITE_SYNC_FULL].  The first choice is the normal fsync().
560 *  The second choice is an
561 ** OS-X style fullsync.  The SQLITE_SYNC_DATA flag may be ORed in to
562 ** indicate that only the data of the file and not its inode needs to be
563 ** synced.
564 ** 
565 ** The integer values to xLock() and xUnlock() are one of
566 ** <ul>
567 ** <li> [SQLITE_LOCK_NONE],
568 ** <li> [SQLITE_LOCK_SHARED],
569 ** <li> [SQLITE_LOCK_RESERVED],
570 ** <li> [SQLITE_LOCK_PENDING], or
571 ** <li> [SQLITE_LOCK_EXCLUSIVE].
572 ** </ul>
573 ** xLock() increases the lock. xUnlock() decreases the lock.  
574 ** The xCheckReservedLock() method looks
575 ** to see if any database connection, either in this
576 ** process or in some other process, is holding an RESERVED,
577 ** PENDING, or EXCLUSIVE lock on the file.  It returns true
578 ** if such a lock exists and false if not.
579 ** 
580 ** The xFileControl() method is a generic interface that allows custom
581 ** VFS implementations to directly control an open file using the
582 ** [sqlite3_file_control()] interface.  The second "op" argument
583 ** is an integer opcode.   The third
584 ** argument is a generic pointer which is intended to be a pointer
585 ** to a structure that may contain arguments or space in which to
586 ** write return values.  Potential uses for xFileControl() might be
587 ** functions to enable blocking locks with timeouts, to change the
588 ** locking strategy (for example to use dot-file locks), to inquire
589 ** about the status of a lock, or to break stale locks.  The SQLite
590 ** core reserves opcodes less than 100 for its own use. 
591 ** A [SQLITE_FCNTL_LOCKSTATE | list of opcodes] less than 100 is available.
592 ** Applications that define a custom xFileControl method should use opcodes 
593 ** greater than 100 to avoid conflicts.
594 **
595 ** The xSectorSize() method returns the sector size of the
596 ** device that underlies the file.  The sector size is the
597 ** minimum write that can be performed without disturbing
598 ** other bytes in the file.  The xDeviceCharacteristics()
599 ** method returns a bit vector describing behaviors of the
600 ** underlying device:
601 **
602 ** <ul>
603 ** <li> [SQLITE_IOCAP_ATOMIC]
604 ** <li> [SQLITE_IOCAP_ATOMIC512]
605 ** <li> [SQLITE_IOCAP_ATOMIC1K]
606 ** <li> [SQLITE_IOCAP_ATOMIC2K]
607 ** <li> [SQLITE_IOCAP_ATOMIC4K]
608 ** <li> [SQLITE_IOCAP_ATOMIC8K]
609 ** <li> [SQLITE_IOCAP_ATOMIC16K]
610 ** <li> [SQLITE_IOCAP_ATOMIC32K]
611 ** <li> [SQLITE_IOCAP_ATOMIC64K]
612 ** <li> [SQLITE_IOCAP_SAFE_APPEND]
613 ** <li> [SQLITE_IOCAP_SEQUENTIAL]
614 ** </ul>
615 **
616 ** The SQLITE_IOCAP_ATOMIC property means that all writes of
617 ** any size are atomic.  The SQLITE_IOCAP_ATOMICnnn values
618 ** mean that writes of blocks that are nnn bytes in size and
619 ** are aligned to an address which is an integer multiple of
620 ** nnn are atomic.  The SQLITE_IOCAP_SAFE_APPEND value means
621 ** that when data is appended to a file, the data is appended
622 ** first then the size of the file is extended, never the other
623 ** way around.  The SQLITE_IOCAP_SEQUENTIAL property means that
624 ** information is written to disk in the same order as calls
625 ** to xWrite().
626 */
627 typedef struct sqlite3_io_methods sqlite3_io_methods;
628 struct sqlite3_io_methods {
629   int iVersion;
630   int (*xClose)(sqlite3_file*);
631   int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst);
632   int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst);
633   int (*xTruncate)(sqlite3_file*, sqlite3_int64 size);
634   int (*xSync)(sqlite3_file*, int flags);
635   int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize);
636   int (*xLock)(sqlite3_file*, int);
637   int (*xUnlock)(sqlite3_file*, int);
638   int (*xCheckReservedLock)(sqlite3_file*);
639   int (*xFileControl)(sqlite3_file*, int op, void *pArg);
640   int (*xSectorSize)(sqlite3_file*);
641   int (*xDeviceCharacteristics)(sqlite3_file*);
642   /* Additional methods may be added in future releases */
643 };
644
645 /*
646 ** CAPI3REF: Standard File Control Opcodes {F11310}
647 **
648 ** These integer constants are opcodes for the xFileControl method
649 ** of the [sqlite3_io_methods] object and to the [sqlite3_file_control()]
650 ** interface.
651 **
652 ** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging.  This
653 ** opcode cases the xFileControl method to write the current state of
654 ** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED],
655 ** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE])
656 ** into an integer that the pArg argument points to. This capability
657 ** is used during testing and only needs to be supported when SQLITE_TEST
658 ** is defined.
659 */
660 #define SQLITE_FCNTL_LOCKSTATE        1
661
662 /*
663 ** CAPI3REF: Mutex Handle {F17110}
664 **
665 ** The mutex module within SQLite defines [sqlite3_mutex] to be an
666 ** abstract type for a mutex object.  The SQLite core never looks
667 ** at the internal representation of an [sqlite3_mutex].  It only
668 ** deals with pointers to the [sqlite3_mutex] object.
669 **
670 ** Mutexes are created using [sqlite3_mutex_alloc()].
671 */
672 typedef struct sqlite3_mutex sqlite3_mutex;
673
674 /*
675 ** CAPI3REF: OS Interface Object {F11140}
676 **
677 ** An instance of this object defines the interface between the
678 ** SQLite core and the underlying operating system.  The "vfs"
679 ** in the name of the object stands for "virtual file system".
680 **
681 ** The iVersion field is initially 1 but may be larger for future
682 ** versions of SQLite.  Additional fields may be appended to this
683 ** object when the iVersion value is increased.
684 **
685 ** The szOsFile field is the size of the subclassed [sqlite3_file]
686 ** structure used by this VFS.  mxPathname is the maximum length of
687 ** a pathname in this VFS.
688 **
689 ** Registered vfs modules are kept on a linked list formed by
690 ** the pNext pointer.  The [sqlite3_vfs_register()]
691 ** and [sqlite3_vfs_unregister()] interfaces manage this list
692 ** in a thread-safe way.  The [sqlite3_vfs_find()] interface
693 ** searches the list.
694 **
695 ** The pNext field is the only fields in the sqlite3_vfs 
696 ** structure that SQLite will ever modify.  SQLite will only access
697 ** or modify this field while holding a particular static mutex.
698 ** The application should never modify anything within the sqlite3_vfs
699 ** object once the object has been registered.
700 **
701 ** The zName field holds the name of the VFS module.  The name must
702 ** be unique across all VFS modules.
703 **
704 ** {F11141} SQLite will guarantee that the zFilename string passed to
705 ** xOpen() is a full pathname as generated by xFullPathname() and
706 ** that the string will be valid and unchanged until xClose() is
707 ** called.  {END} So the [sqlite3_file] can store a pointer to the
708 ** filename if it needs to remember the filename for some reason.
709 **
710 ** {F11142} The flags argument to xOpen() includes all bits set in
711 ** the flags argument to [sqlite3_open_v2()].  Or if [sqlite3_open()]
712 ** or [sqlite3_open16()] is used, then flags includes at least
713 ** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. {END}
714 ** If xOpen() opens a file read-only then it sets *pOutFlags to
715 ** include [SQLITE_OPEN_READONLY].  Other bits in *pOutFlags may be
716 ** set.
717 ** 
718 ** {F11143} SQLite will also add one of the following flags to the xOpen()
719 ** call, depending on the object being opened:
720 ** 
721 ** <ul>
722 ** <li>  [SQLITE_OPEN_MAIN_DB]
723 ** <li>  [SQLITE_OPEN_MAIN_JOURNAL]
724 ** <li>  [SQLITE_OPEN_TEMP_DB]
725 ** <li>  [SQLITE_OPEN_TEMP_JOURNAL]
726 ** <li>  [SQLITE_OPEN_TRANSIENT_DB]
727 ** <li>  [SQLITE_OPEN_SUBJOURNAL]
728 ** <li>  [SQLITE_OPEN_MASTER_JOURNAL]
729 ** </ul> {END}
730 **
731 ** The file I/O implementation can use the object type flags to
732 ** changes the way it deals with files.  For example, an application
733 ** that does not care about crash recovery or rollback, might make
734 ** the open of a journal file a no-op.  Writes to this journal are
735 ** also a no-op.  Any attempt to read the journal return SQLITE_IOERR.
736 ** Or the implementation might recognize the a database file will
737 ** be doing page-aligned sector reads and writes in a random order
738 ** and set up its I/O subsystem accordingly.
739 ** 
740 ** SQLite might also add one of the following flags to the xOpen
741 ** method:
742 ** 
743 ** <ul>
744 ** <li> [SQLITE_OPEN_DELETEONCLOSE]
745 ** <li> [SQLITE_OPEN_EXCLUSIVE]
746 ** </ul>
747 ** 
748 ** {F11145} The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be
749 ** deleted when it is closed.  {F11146} The [SQLITE_OPEN_DELETEONCLOSE]
750 ** will be set for TEMP  databases, journals and for subjournals. 
751 ** {F11147} The [SQLITE_OPEN_EXCLUSIVE] flag means the file should be opened
752 ** for exclusive access.  This flag is set for all files except
753 ** for the main database file. {END}
754 ** 
755 ** {F11148} At least szOsFile bytes of memory is allocated by SQLite 
756 ** to hold the  [sqlite3_file] structure passed as the third 
757 ** argument to xOpen.  {END}  The xOpen method does not have to
758 ** allocate the structure; it should just fill it in.
759 ** 
760 ** {F11149} The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS] 
761 ** to test for the existance of a file,
762 ** or [SQLITE_ACCESS_READWRITE] to test to see
763 ** if a file is readable and writable, or [SQLITE_ACCESS_READ]
764 ** to test to see if a file is at least readable.  {END} The file can be a 
765 ** directory.
766 ** 
767 ** {F11150} SQLite will always allocate at least mxPathname+1 byte for
768 ** the output buffers for xGetTempname and xFullPathname. {F11151} The exact
769 ** size of the output buffer is also passed as a parameter to both 
770 ** methods. {END} If the output buffer is not large enough, SQLITE_CANTOPEN
771 ** should be returned. As this is handled as a fatal error by SQLite,
772 ** vfs implementations should endeavor to prevent this by setting 
773 ** mxPathname to a sufficiently large value.
774 ** 
775 ** The xRandomness(), xSleep(), and xCurrentTime() interfaces
776 ** are not strictly a part of the filesystem, but they are
777 ** included in the VFS structure for completeness.
778 ** The xRandomness() function attempts to return nBytes bytes
779 ** of good-quality randomness into zOut.  The return value is
780 ** the actual number of bytes of randomness obtained.  The
781 ** xSleep() method cause the calling thread to sleep for at
782 ** least the number of microseconds given.  The xCurrentTime()
783 ** method returns a Julian Day Number for the current date and
784 ** time.
785 */
786 typedef struct sqlite3_vfs sqlite3_vfs;
787 struct sqlite3_vfs {
788   int iVersion;            /* Structure version number */
789   int szOsFile;            /* Size of subclassed sqlite3_file */
790   int mxPathname;          /* Maximum file pathname length */
791   sqlite3_vfs *pNext;      /* Next registered VFS */
792   const char *zName;       /* Name of this virtual file system */
793   void *pAppData;          /* Pointer to application-specific data */
794   int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*,
795                int flags, int *pOutFlags);
796   int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir);
797   int (*xAccess)(sqlite3_vfs*, const char *zName, int flags);
798   int (*xGetTempname)(sqlite3_vfs*, int nOut, char *zOut);
799   int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut);
800   void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename);
801   void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg);
802   void *(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol);
803   void (*xDlClose)(sqlite3_vfs*, void*);
804   int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut);
805   int (*xSleep)(sqlite3_vfs*, int microseconds);
806   int (*xCurrentTime)(sqlite3_vfs*, double*);
807   /* New fields may be appended in figure versions.  The iVersion
808   ** value will increment whenever this happens. */
809 };
810
811 /*
812 ** CAPI3REF: Flags for the xAccess VFS method {F11190}
813 **
814 ** {F11191} These integer constants can be used as the third parameter to
815 ** the xAccess method of an [sqlite3_vfs] object. {END}  They determine
816 ** the kind of what kind of permissions the xAccess method is
817 ** looking for.  {F11192} With SQLITE_ACCESS_EXISTS, the xAccess method
818 ** simply checks to see if the file exists. {F11193} With
819 ** SQLITE_ACCESS_READWRITE, the xAccess method checks to see
820 ** if the file is both readable and writable.  {F11194} With
821 ** SQLITE_ACCESS_READ the xAccess method
822 ** checks to see if the file is readable.
823 */
824 #define SQLITE_ACCESS_EXISTS    0
825 #define SQLITE_ACCESS_READWRITE 1
826 #define SQLITE_ACCESS_READ      2
827
828 /*
829 ** CAPI3REF: Enable Or Disable Extended Result Codes {F12200}
830 **
831 ** The sqlite3_extended_result_codes() routine enables or disables the
832 ** [SQLITE_IOERR_READ | extended result codes] feature of SQLite.
833 ** The extended result codes are disabled by default for historical
834 ** compatibility.
835 **
836 ** INVARIANTS:
837 **
838 ** {F12201} Each new [database connection] has the 
839 **          [extended result codes] feature
840 **          disabled by default.
841 **
842 ** {F12202} The [sqlite3_extended_result_codes(D,F)] interface will enable
843 **          [extended result codes] for the 
844 **          [database connection] D if the F parameter
845 **          is true, or disable them if F is false.
846 */
847 int sqlite3_extended_result_codes(sqlite3*, int onoff);
848
849 /*
850 ** CAPI3REF: Last Insert Rowid {F12220}
851 **
852 ** Each entry in an SQLite table has a unique 64-bit signed
853 ** integer key called the "rowid". The rowid is always available
854 ** as an undeclared column named ROWID, OID, or _ROWID_ as long as those
855 ** names are not also used by explicitly declared columns. If
856 ** the table has a column of type INTEGER PRIMARY KEY then that column
857 ** is another an alias for the rowid.
858 **
859 ** This routine returns the rowid of the most recent
860 ** successful INSERT into the database from the database connection
861 ** shown in the first argument.  If no successful inserts
862 ** have ever occurred on this database connection, zero is returned.
863 **
864 ** If an INSERT occurs within a trigger, then the rowid of the
865 ** inserted row is returned by this routine as long as the trigger
866 ** is running.  But once the trigger terminates, the value returned
867 ** by this routine reverts to the last value inserted before the
868 ** trigger fired.
869 **
870 ** An INSERT that fails due to a constraint violation is not a
871 ** successful insert and does not change the value returned by this
872 ** routine.  Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK,
873 ** and INSERT OR ABORT make no changes to the return value of this
874 ** routine when their insertion fails.  When INSERT OR REPLACE 
875 ** encounters a constraint violation, it does not fail.  The
876 ** INSERT continues to completion after deleting rows that caused
877 ** the constraint problem so INSERT OR REPLACE will always change
878 ** the return value of this interface. 
879 **
880 ** For the purposes of this routine, an insert is considered to
881 ** be successful even if it is subsequently rolled back.
882 **
883 ** INVARIANTS:
884 **
885 ** {F12221} The [sqlite3_last_insert_rowid()] function returns the
886 **          rowid of the most recent successful insert done
887 **          on the same database connection and within the same
888 **          trigger context, or zero if there have
889 **          been no qualifying inserts on that connection.
890 **
891 ** {F12223} The [sqlite3_last_insert_rowid()] function returns
892 **          same value when called from the same trigger context
893 **          immediately before and after a ROLLBACK.
894 **
895 ** LIMITATIONS:
896 **
897 ** {U12232} If separate thread does a new insert on the same
898 **          database connection while the [sqlite3_last_insert_rowid()]
899 **          function is running and thus changes the last insert rowid,
900 **          then the value returned by [sqlite3_last_insert_rowid()] is
901 **          unpredictable and might not equal either the old or the new
902 **          last insert rowid.
903 */
904 sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*);
905
906 /*
907 ** CAPI3REF: Count The Number Of Rows Modified {F12240}
908 **
909 ** This function returns the number of database rows that were changed
910 ** or inserted or deleted by the most recently completed SQL statement
911 ** on the connection specified by the first parameter.  Only
912 ** changes that are directly specified by the INSERT, UPDATE, or
913 ** DELETE statement are counted.  Auxiliary changes caused by
914 ** triggers are not counted. Use the [sqlite3_total_changes()] function
915 ** to find the total number of changes including changes caused by triggers.
916 **
917 ** A "row changes" is a change to a single row of a single table
918 ** caused by an INSERT, DELETE, or UPDATE statement.  Rows that
919 ** are changed as side effects of REPLACE constraint resolution,
920 ** rollback, ABORT processing, DROP TABLE, or by any other
921 ** mechanisms do not count as direct row changes.
922 **
923 ** A "trigger context" is a scope of execution that begins and
924 ** ends with the script of a trigger.  Most SQL statements are
925 ** evaluated outside of any trigger.  This is the "top level"
926 ** trigger context.  If a trigger fires from the top level, a
927 ** new trigger context is entered for the duration of that one
928 ** trigger.  Subtriggers create subcontexts for their duration.
929 **
930 ** Calling [sqlite3_exec()] or [sqlite3_step()] recursively does
931 ** not create a new trigger context.
932 **
933 ** This function returns the number of direct row changes in the
934 ** most recent INSERT, UPDATE, or DELETE statement within the same
935 ** trigger context.
936 **
937 ** So when called from the top level, this function returns the
938 ** number of changes in the most recent INSERT, UPDATE, or DELETE
939 ** that also occurred at the top level.
940 ** Within the body of a trigger, the sqlite3_changes() interface
941 ** can be called to find the number of
942 ** changes in the most recently completed INSERT, UPDATE, or DELETE
943 ** statement within the body of the same trigger.
944 ** However, the number returned does not include in changes
945 ** caused by subtriggers since they have their own context.
946 **
947 ** SQLite implements the command "DELETE FROM table" without
948 ** a WHERE clause by dropping and recreating the table.  (This is much
949 ** faster than going through and deleting individual elements from the
950 ** table.)  Because of this optimization, the deletions in
951 ** "DELETE FROM table" are not row changes and will not be counted
952 ** by the sqlite3_changes() or [sqlite3_total_changes()] functions.
953 ** To get an accurate count of the number of rows deleted, use
954 ** "DELETE FROM table WHERE 1" instead.
955 **
956 ** INVARIANTS:
957 **
958 ** {F12241} The [sqlite3_changes()] function returns the number of
959 **          row changes caused by the most recent INSERT, UPDATE,
960 **          or DELETE statement on the same database connection and
961 **          within the same trigger context, or zero if there have
962 **          not been any qualifying row changes.
963 **
964 ** LIMITATIONS:
965 **
966 ** {U12252} If a separate thread makes changes on the same database connection
967 **          while [sqlite3_changes()] is running then the value returned
968 **          is unpredictable and unmeaningful.
969 */
970 int sqlite3_changes(sqlite3*);
971
972 /*
973 ** CAPI3REF: Total Number Of Rows Modified {F12260}
974 ***
975 ** This function returns the number of row changes caused
976 ** by INSERT, UPDATE or DELETE statements since the database handle
977 ** was opened.  The count includes all changes from all trigger
978 ** contexts.  But the count does not include changes used to
979 ** implement REPLACE constraints, do rollbacks or ABORT processing,
980 ** or DROP table processing.
981 ** The changes
982 ** are counted as soon as the statement that makes them is completed 
983 ** (when the statement handle is passed to [sqlite3_reset()] or 
984 ** [sqlite3_finalize()]).
985 **
986 ** SQLite implements the command "DELETE FROM table" without
987 ** a WHERE clause by dropping and recreating the table.  (This is much
988 ** faster than going
989 ** through and deleting individual elements form the table.)  Because of
990 ** this optimization, the change count for "DELETE FROM table" will be
991 ** zero regardless of the number of elements that were originally in the
992 ** table. To get an accurate count of the number of rows deleted, use
993 ** "DELETE FROM table WHERE 1" instead.
994 **
995 ** See also the [sqlite3_changes()] interface.
996 **
997 ** INVARIANTS:
998 ** 
999 ** {F12261} The [sqlite3_total_changes()] returns the total number
1000 **          of row changes caused by INSERT, UPDATE, and/or DELETE
1001 **          statements on the same [database connection], in any
1002 **          trigger context, since the database connection was
1003 **          created.
1004 **
1005 ** LIMITATIONS:
1006 **
1007 ** {U12264} If a separate thread makes changes on the same database connection
1008 **          while [sqlite3_total_changes()] is running then the value 
1009 **          returned is unpredictable and unmeaningful.
1010 */
1011 int sqlite3_total_changes(sqlite3*);
1012
1013 /*
1014 ** CAPI3REF: Interrupt A Long-Running Query {F12270}
1015 **
1016 ** This function causes any pending database operation to abort and
1017 ** return at its earliest opportunity. This routine is typically
1018 ** called in response to a user action such as pressing "Cancel"
1019 ** or Ctrl-C where the user wants a long query operation to halt
1020 ** immediately.
1021 **
1022 ** It is safe to call this routine from a thread different from the
1023 ** thread that is currently running the database operation.  But it
1024 ** is not safe to call this routine with a database connection that
1025 ** is closed or might close before sqlite3_interrupt() returns.
1026 **
1027 ** If an SQL is very nearly finished at the time when sqlite3_interrupt()
1028 ** is called, then it might not have an opportunity to be interrupted.
1029 ** It might continue to completion.
1030 ** An SQL operation that is interrupted will return
1031 ** [SQLITE_INTERRUPT].  If the interrupted SQL operation is an
1032 ** INSERT, UPDATE, or DELETE that is inside an explicit transaction, 
1033 ** then the entire transaction will be rolled back automatically.
1034 ** A call to sqlite3_interrupt() has no effect on SQL statements
1035 ** that are started after sqlite3_interrupt() returns.
1036 **
1037 ** INVARIANTS:
1038 **
1039 ** {F12271} The [sqlite3_interrupt()] interface will force all running
1040 **          SQL statements associated with the same database connection
1041 **          to halt after processing at most one additional row of
1042 **          data.
1043 **
1044 ** {F12272} Any SQL statement that is interrupted by [sqlite3_interrupt()]
1045 **          will return [SQLITE_INTERRUPT].
1046 **
1047 ** LIMITATIONS:
1048 **
1049 ** {U12279} If the database connection closes while [sqlite3_interrupt()]
1050 **          is running then bad things will likely happen.
1051 */
1052 void sqlite3_interrupt(sqlite3*);
1053
1054 /*
1055 ** CAPI3REF: Determine If An SQL Statement Is Complete {F10510}
1056 **
1057 ** These routines are useful for command-line input to determine if the
1058 ** currently entered text seems to form complete a SQL statement or
1059 ** if additional input is needed before sending the text into
1060 ** SQLite for parsing.  These routines return true if the input string
1061 ** appears to be a complete SQL statement.  A statement is judged to be
1062 ** complete if it ends with a semicolon token and is not a fragment of a
1063 ** CREATE TRIGGER statement.  Semicolons that are embedded within
1064 ** string literals or quoted identifier names or comments are not
1065 ** independent tokens (they are part of the token in which they are
1066 ** embedded) and thus do not count as a statement terminator.
1067 **
1068 ** These routines do not parse the SQL and
1069 ** so will not detect syntactically incorrect SQL.
1070 **
1071 ** INVARIANTS:
1072 **
1073 ** {F10511} The sqlite3_complete() and sqlite3_complete16() functions
1074 **          return true (non-zero) if and only if the last
1075 **          non-whitespace token in their input is a semicolon that
1076 **          is not in between the BEGIN and END of a CREATE TRIGGER
1077 **          statement.
1078 **
1079 ** LIMITATIONS:
1080 **
1081 ** {U10512} The input to sqlite3_complete() must be a zero-terminated
1082 **          UTF-8 string.
1083 **
1084 ** {U10513} The input to sqlite3_complete16() must be a zero-terminated
1085 **          UTF-16 string in native byte order.
1086 */
1087 int sqlite3_complete(const char *sql);
1088 int sqlite3_complete16(const void *sql);
1089
1090 /*
1091 ** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors {F12310}
1092 **
1093 ** This routine identifies a callback function that might be
1094 ** invoked whenever an attempt is made to open a database table 
1095 ** that another thread or process has locked.
1096 ** If the busy callback is NULL, then [SQLITE_BUSY]
1097 ** or [SQLITE_IOERR_BLOCKED]
1098 ** is returned immediately upon encountering the lock.
1099 ** If the busy callback is not NULL, then the
1100 ** callback will be invoked with two arguments.  The
1101 ** first argument to the handler is a copy of the void* pointer which
1102 ** is the third argument to this routine.  The second argument to
1103 ** the handler is the number of times that the busy handler has
1104 ** been invoked for this locking event.   If the
1105 ** busy callback returns 0, then no additional attempts are made to
1106 ** access the database and [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED] is returned.
1107 ** If the callback returns non-zero, then another attempt
1108 ** is made to open the database for reading and the cycle repeats.
1109 **
1110 ** The presence of a busy handler does not guarantee that
1111 ** it will be invoked when there is lock contention.
1112 ** If SQLite determines that invoking the busy handler could result in
1113 ** a deadlock, it will go ahead and return [SQLITE_BUSY] or
1114 ** [SQLITE_IOERR_BLOCKED] instead of invoking the
1115 ** busy handler.
1116 ** Consider a scenario where one process is holding a read lock that
1117 ** it is trying to promote to a reserved lock and
1118 ** a second process is holding a reserved lock that it is trying
1119 ** to promote to an exclusive lock.  The first process cannot proceed
1120 ** because it is blocked by the second and the second process cannot
1121 ** proceed because it is blocked by the first.  If both processes
1122 ** invoke the busy handlers, neither will make any progress.  Therefore,
1123 ** SQLite returns [SQLITE_BUSY] for the first process, hoping that this
1124 ** will induce the first process to release its read lock and allow
1125 ** the second process to proceed.
1126 **
1127 ** The default busy callback is NULL.
1128 **
1129 ** The [SQLITE_BUSY] error is converted to [SQLITE_IOERR_BLOCKED]
1130 ** when SQLite is in the middle of a large transaction where all the
1131 ** changes will not fit into the in-memory cache.  SQLite will
1132 ** already hold a RESERVED lock on the database file, but it needs
1133 ** to promote this lock to EXCLUSIVE so that it can spill cache
1134 ** pages into the database file without harm to concurrent
1135 ** readers.  If it is unable to promote the lock, then the in-memory
1136 ** cache will be left in an inconsistent state and so the error
1137 ** code is promoted from the relatively benign [SQLITE_BUSY] to
1138 ** the more severe [SQLITE_IOERR_BLOCKED].  This error code promotion
1139 ** forces an automatic rollback of the changes.  See the
1140 ** <a href="http://www.sqlite.org/cvstrac/wiki?p=CorruptionFollowingBusyError">
1141 ** CorruptionFollowingBusyError</a> wiki page for a discussion of why
1142 ** this is important.
1143 **      
1144 ** There can only be a single busy handler defined for each database
1145 ** connection.  Setting a new busy handler clears any previous one. 
1146 ** Note that calling [sqlite3_busy_timeout()] will also set or clear
1147 ** the busy handler.
1148 **
1149 ** INVARIANTS:
1150 **
1151 ** {F12311} The [sqlite3_busy_handler()] function replaces the busy handler
1152 **          callback in the database connection identified by the 1st
1153 **          parameter with a new busy handler identified by the 2nd and 3rd
1154 **          parameters.
1155 **
1156 ** {F12312} The default busy handler for new database connections is NULL.
1157 **
1158 ** {F12314} When two or more database connection share a common cache,
1159 **          the busy handler for the database connection currently using
1160 **          the cache is invoked when the cache encounters a lock.
1161 **
1162 ** {F12316} If a busy handler callback returns zero, then the SQLite
1163 **          interface that provoked the locking event will return
1164 **          [SQLITE_BUSY].
1165 **
1166 ** {F12318} SQLite will invokes the busy handler with two argument which
1167 **          are a copy of the pointer supplied by the 3rd parameter to
1168 **          [sqlite3_busy_handler()] and a count of the number of prior
1169 **          invocations of the busy handler for the same locking event.
1170 **
1171 ** LIMITATIONS:
1172 **
1173 ** {U12319} A busy handler should not call close the database connection
1174 **          or prepared statement that invoked the busy handler.
1175 */
1176 int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*);
1177
1178 /*
1179 ** CAPI3REF: Set A Busy Timeout {F12340}
1180 **
1181 ** This routine sets a [sqlite3_busy_handler | busy handler]
1182 ** that sleeps for a while when a
1183 ** table is locked.  The handler will sleep multiple times until 
1184 ** at least "ms" milliseconds of sleeping have been done. {F12343} After
1185 ** "ms" milliseconds of sleeping, the handler returns 0 which
1186 ** causes [sqlite3_step()] to return [SQLITE_BUSY] or [SQLITE_IOERR_BLOCKED].
1187 **
1188 ** Calling this routine with an argument less than or equal to zero
1189 ** turns off all busy handlers.
1190 **
1191 ** There can only be a single busy handler for a particular database
1192 ** connection.  If another busy handler was defined  
1193 ** (using [sqlite3_busy_handler()]) prior to calling
1194 ** this routine, that other busy handler is cleared.
1195 **
1196 ** INVARIANTS:
1197 **
1198 ** {F12341} The [sqlite3_busy_timeout()] function overrides any prior
1199 **          [sqlite3_busy_timeout()] or [sqlite3_busy_handler()] setting
1200 **          on the same database connection.
1201 **
1202 ** {F12343} If the 2nd parameter to [sqlite3_busy_timeout()] is less than
1203 **          or equal to zero, then the busy handler is cleared so that
1204 **          all subsequent locking events immediately return [SQLITE_BUSY].
1205 **
1206 ** {F12344} If the 2nd parameter to [sqlite3_busy_timeout()] is a positive
1207 **          number N, then a busy handler is set that repeatedly calls
1208 **          the xSleep() method in the VFS interface until either the
1209 **          lock clears or until the cumulative sleep time reported back
1210 **          by xSleep() exceeds N milliseconds.
1211 */
1212 int sqlite3_busy_timeout(sqlite3*, int ms);
1213
1214 /*
1215 ** CAPI3REF: Convenience Routines For Running Queries {F12370}
1216 **
1217 ** Definition: A <b>result table</b> is memory data structure created by the
1218 ** [sqlite3_get_table()] interface.  A result table records the
1219 ** complete query results from one or more queries.
1220 **
1221 ** The table conceptually has a number of rows and columns.  But
1222 ** these numbers are not part of the result table itself.  These
1223 ** numbers are obtained separately.  Let N be the number of rows
1224 ** and M be the number of columns.
1225 **
1226 ** A result table is an array of pointers to zero-terminated
1227 ** UTF-8 strings.  There are (N+1)*M elements in the array.  
1228 ** The first M pointers point to zero-terminated strings that 
1229 ** contain the names of the columns.
1230 ** The remaining entries all point to query results.  NULL
1231 ** values are give a NULL pointer.  All other values are in
1232 ** their UTF-8 zero-terminated string representation as returned by
1233 ** [sqlite3_column_text()].
1234 **
1235 ** A result table might consists of one or more memory allocations.
1236 ** It is not safe to pass a result table directly to [sqlite3_free()].
1237 ** A result table should be deallocated using [sqlite3_free_table()].
1238 **
1239 ** As an example of the result table format, suppose a query result
1240 ** is as follows:
1241 **
1242 ** <blockquote><pre>
1243 **        Name        | Age
1244 **        -----------------------
1245 **        Alice       | 43
1246 **        Bob         | 28
1247 **        Cindy       | 21
1248 ** </pre></blockquote>
1249 **
1250 ** There are two column (M==2) and three rows (N==3).  Thus the
1251 ** result table has 8 entries.  Suppose the result table is stored
1252 ** in an array names azResult.  Then azResult holds this content:
1253 **
1254 ** <blockquote><pre>
1255 **        azResult&#91;0] = "Name";
1256 **        azResult&#91;1] = "Age";
1257 **        azResult&#91;2] = "Alice";
1258 **        azResult&#91;3] = "43";
1259 **        azResult&#91;4] = "Bob";
1260 **        azResult&#91;5] = "28";
1261 **        azResult&#91;6] = "Cindy";
1262 **        azResult&#91;7] = "21";
1263 ** </pre></blockquote>
1264 **
1265 ** The sqlite3_get_table() function evaluates one or more
1266 ** semicolon-separated SQL statements in the zero-terminated UTF-8
1267 ** string of its 2nd parameter.  It returns a result table to the
1268 ** pointer given in its 3rd parameter.
1269 **
1270 ** After the calling function has finished using the result, it should 
1271 ** pass the pointer to the result table to sqlite3_free_table() in order to 
1272 ** release the memory that was malloc-ed.  Because of the way the 
1273 ** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling
1274 ** function must not try to call [sqlite3_free()] directly.  Only 
1275 ** [sqlite3_free_table()] is able to release the memory properly and safely.
1276 **
1277 ** The sqlite3_get_table() interface is implemented as a wrapper around
1278 ** [sqlite3_exec()].  The sqlite3_get_table() routine does not have access
1279 ** to any internal data structures of SQLite.  It uses only the public
1280 ** interface defined here.  As a consequence, errors that occur in the
1281 ** wrapper layer outside of the internal [sqlite3_exec()] call are not
1282 ** reflected in subsequent calls to [sqlite3_errcode()] or
1283 ** [sqlite3_errmsg()].
1284 **
1285 ** INVARIANTS:
1286 **
1287 ** {F12371} If a [sqlite3_get_table()] fails a memory allocation, then
1288 **          it frees the result table under construction, aborts the
1289 **          query in process, skips any subsequent queries, sets the
1290 **          *resultp output pointer to NULL and returns [SQLITE_NOMEM].
1291 **
1292 ** {F12373} If the ncolumn parameter to [sqlite3_get_table()] is not NULL
1293 **          then [sqlite3_get_table()] write the number of columns in the
1294 **          result set of the query into *ncolumn if the query is
1295 **          successful (if the function returns SQLITE_OK).
1296 **
1297 ** {F12374} If the nrow parameter to [sqlite3_get_table()] is not NULL
1298 **          then [sqlite3_get_table()] write the number of rows in the
1299 **          result set of the query into *nrow if the query is
1300 **          successful (if the function returns SQLITE_OK).
1301 **
1302 ** {F12376} The [sqlite3_get_table()] function sets its *ncolumn value
1303 **          to the number of columns in the result set of the query in the
1304 **          sql parameter, or to zero if the query in sql has an empty
1305 **          result set.
1306 */
1307 int sqlite3_get_table(
1308   sqlite3*,             /* An open database */
1309   const char *sql,      /* SQL to be evaluated */
1310   char ***pResult,      /* Results of the query */
1311   int *nrow,            /* Number of result rows written here */
1312   int *ncolumn,         /* Number of result columns written here */
1313   char **errmsg         /* Error msg written here */
1314 );
1315 void sqlite3_free_table(char **result);
1316
1317 /*
1318 ** CAPI3REF: Formatted String Printing Functions {F17400}
1319 **
1320 ** These routines are workalikes of the "printf()" family of functions
1321 ** from the standard C library.
1322 **
1323 ** The sqlite3_mprintf() and sqlite3_vmprintf() routines write their
1324 ** results into memory obtained from [sqlite3_malloc()].
1325 ** The strings returned by these two routines should be
1326 ** released by [sqlite3_free()].   Both routines return a
1327 ** NULL pointer if [sqlite3_malloc()] is unable to allocate enough
1328 ** memory to hold the resulting string.
1329 **
1330 ** In sqlite3_snprintf() routine is similar to "snprintf()" from
1331 ** the standard C library.  The result is written into the
1332 ** buffer supplied as the second parameter whose size is given by
1333 ** the first parameter. Note that the order of the
1334 ** first two parameters is reversed from snprintf().  This is an
1335 ** historical accident that cannot be fixed without breaking
1336 ** backwards compatibility.  Note also that sqlite3_snprintf()
1337 ** returns a pointer to its buffer instead of the number of
1338 ** characters actually written into the buffer.  We admit that
1339 ** the number of characters written would be a more useful return
1340 ** value but we cannot change the implementation of sqlite3_snprintf()
1341 ** now without breaking compatibility.
1342 **
1343 ** As long as the buffer size is greater than zero, sqlite3_snprintf()
1344 ** guarantees that the buffer is always zero-terminated.  The first
1345 ** parameter "n" is the total size of the buffer, including space for
1346 ** the zero terminator.  So the longest string that can be completely
1347 ** written will be n-1 characters.
1348 **
1349 ** These routines all implement some additional formatting
1350 ** options that are useful for constructing SQL statements.
1351 ** All of the usual printf formatting options apply.  In addition, there
1352 ** is are "%q", "%Q", and "%z" options.
1353 **
1354 ** The %q option works like %s in that it substitutes a null-terminated
1355 ** string from the argument list.  But %q also doubles every '\'' character.
1356 ** %q is designed for use inside a string literal.  By doubling each '\''
1357 ** character it escapes that character and allows it to be inserted into
1358 ** the string.
1359 **
1360 ** For example, so some string variable contains text as follows:
1361 **
1362 ** <blockquote><pre>
1363 **  char *zText = "It's a happy day!";
1364 ** </pre></blockquote>
1365 **
1366 ** One can use this text in an SQL statement as follows:
1367 **
1368 ** <blockquote><pre>
1369 **  char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText);
1370 **  sqlite3_exec(db, zSQL, 0, 0, 0);
1371 **  sqlite3_free(zSQL);
1372 ** </pre></blockquote>
1373 **
1374 ** Because the %q format string is used, the '\'' character in zText
1375 ** is escaped and the SQL generated is as follows:
1376 **
1377 ** <blockquote><pre>
1378 **  INSERT INTO table1 VALUES('It''s a happy day!')
1379 ** </pre></blockquote>
1380 **
1381 ** This is correct.  Had we used %s instead of %q, the generated SQL
1382 ** would have looked like this:
1383 **
1384 ** <blockquote><pre>
1385 **  INSERT INTO table1 VALUES('It's a happy day!');
1386 ** </pre></blockquote>
1387 **
1388 ** This second example is an SQL syntax error.  As a general rule you
1389 ** should always use %q instead of %s when inserting text into a string 
1390 ** literal.
1391 **
1392 ** The %Q option works like %q except it also adds single quotes around
1393 ** the outside of the total string.  Or if the parameter in the argument
1394 ** list is a NULL pointer, %Q substitutes the text "NULL" (without single
1395 ** quotes) in place of the %Q option. {END}  So, for example, one could say:
1396 **
1397 ** <blockquote><pre>
1398 **  char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText);
1399 **  sqlite3_exec(db, zSQL, 0, 0, 0);
1400 **  sqlite3_free(zSQL);
1401 ** </pre></blockquote>
1402 **
1403 ** The code above will render a correct SQL statement in the zSQL
1404 ** variable even if the zText variable is a NULL pointer.
1405 **
1406 ** The "%z" formatting option works exactly like "%s" with the
1407 ** addition that after the string has been read and copied into
1408 ** the result, [sqlite3_free()] is called on the input string. {END}
1409 **
1410 ** INVARIANTS:
1411 **
1412 ** {F17403}  The [sqlite3_mprintf()] and [sqlite3_vmprintf()] interfaces
1413 **           return either pointers to zero-terminated UTF-8 strings held in
1414 **           memory obtained from [sqlite3_malloc()] or NULL pointers if
1415 **           a call to [sqlite3_malloc()] fails.
1416 **
1417 ** {F17406}  The [sqlite3_snprintf()] interface writes a zero-terminated
1418 **           UTF-8 string into the buffer pointed to by the second parameter
1419 **           provided that the first parameter is greater than zero.
1420 **
1421 ** {F17407}  The [sqlite3_snprintf()] interface does not writes slots of
1422 **           its output buffer (the second parameter) outside the range
1423 **           of 0 through N-1 (where N is the first parameter)
1424 **           regardless of the length of the string
1425 **           requested by the format specification.
1426 **   
1427 */
1428 char *sqlite3_mprintf(const char*,...);
1429 char *sqlite3_vmprintf(const char*, va_list);
1430 char *sqlite3_snprintf(int,char*,const char*, ...);
1431
1432 /*
1433 ** CAPI3REF: Memory Allocation Subsystem {F17300}
1434 **
1435 ** The SQLite core  uses these three routines for all of its own
1436 ** internal memory allocation needs. "Core" in the previous sentence
1437 ** does not include operating-system specific VFS implementation.  The
1438 ** windows VFS uses native malloc and free for some operations.
1439 **
1440 ** The sqlite3_malloc() routine returns a pointer to a block
1441 ** of memory at least N bytes in length, where N is the parameter.
1442 ** If sqlite3_malloc() is unable to obtain sufficient free
1443 ** memory, it returns a NULL pointer.  If the parameter N to
1444 ** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns
1445 ** a NULL pointer.
1446 **
1447 ** Calling sqlite3_free() with a pointer previously returned
1448 ** by sqlite3_malloc() or sqlite3_realloc() releases that memory so
1449 ** that it might be reused.  The sqlite3_free() routine is
1450 ** a no-op if is called with a NULL pointer.  Passing a NULL pointer
1451 ** to sqlite3_free() is harmless.  After being freed, memory
1452 ** should neither be read nor written.  Even reading previously freed
1453 ** memory might result in a segmentation fault or other severe error.
1454 ** Memory corruption, a segmentation fault, or other severe error
1455 ** might result if sqlite3_free() is called with a non-NULL pointer that
1456 ** was not obtained from sqlite3_malloc() or sqlite3_free().
1457 **
1458 ** The sqlite3_realloc() interface attempts to resize a
1459 ** prior memory allocation to be at least N bytes, where N is the
1460 ** second parameter.  The memory allocation to be resized is the first
1461 ** parameter.  If the first parameter to sqlite3_realloc()
1462 ** is a NULL pointer then its behavior is identical to calling
1463 ** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc().
1464 ** If the second parameter to sqlite3_realloc() is zero or
1465 ** negative then the behavior is exactly the same as calling
1466 ** sqlite3_free(P) where P is the first parameter to sqlite3_realloc().
1467 ** Sqlite3_realloc() returns a pointer to a memory allocation
1468 ** of at least N bytes in size or NULL if sufficient memory is unavailable.
1469 ** If M is the size of the prior allocation, then min(N,M) bytes
1470 ** of the prior allocation are copied into the beginning of buffer returned
1471 ** by sqlite3_realloc() and the prior allocation is freed.
1472 ** If sqlite3_realloc() returns NULL, then the prior allocation
1473 ** is not freed.
1474 **
1475 ** The memory returned by sqlite3_malloc() and sqlite3_realloc()
1476 ** is always aligned to at least an 8 byte boundary. {END}
1477 **
1478 ** The default implementation
1479 ** of the memory allocation subsystem uses the malloc(), realloc()
1480 ** and free() provided by the standard C library. {F17382} However, if 
1481 ** SQLite is compiled with the following C preprocessor macro
1482 **
1483 ** <blockquote> SQLITE_MEMORY_SIZE=<i>NNN</i> </blockquote>
1484 **
1485 ** where <i>NNN</i> is an integer, then SQLite create a static
1486 ** array of at least <i>NNN</i> bytes in size and use that array
1487 ** for all of its dynamic memory allocation needs. {END}  Additional
1488 ** memory allocator options may be added in future releases.
1489 **
1490 ** In SQLite version 3.5.0 and 3.5.1, it was possible to define
1491 ** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in
1492 ** implementation of these routines to be omitted.  That capability
1493 ** is no longer provided.  Only built-in memory allocators can be
1494 ** used.
1495 **
1496 ** The windows OS interface layer calls
1497 ** the system malloc() and free() directly when converting
1498 ** filenames between the UTF-8 encoding used by SQLite
1499 ** and whatever filename encoding is used by the particular windows
1500 ** installation.  Memory allocation errors are detected, but
1501 ** they are reported back as [SQLITE_CANTOPEN] or
1502 ** [SQLITE_IOERR] rather than [SQLITE_NOMEM].
1503 **
1504 ** INVARIANTS:
1505 **
1506 ** {F17303}  The [sqlite3_malloc(N)] interface returns either a pointer to 
1507 **           newly checked-out block of at least N bytes of memory
1508 **           that is 8-byte aligned, 
1509 **           or it returns NULL if it is unable to fulfill the request.
1510 **
1511 ** {F17304}  The [sqlite3_malloc(N)] interface returns a NULL pointer if
1512 **           N is less than or equal to zero.
1513 **
1514 ** {F17305}  The [sqlite3_free(P)] interface releases memory previously
1515 **           returned from [sqlite3_malloc()] or [sqlite3_realloc()],
1516 **           making it available for reuse.
1517 **
1518 ** {F17306}  A call to [sqlite3_free(NULL)] is a harmless no-op.
1519 **
1520 ** {F17310}  A call to [sqlite3_realloc(0,N)] is equivalent to a call
1521 **           to [sqlite3_malloc(N)].
1522 **
1523 ** {F17312}  A call to [sqlite3_realloc(P,0)] is equivalent to a call
1524 **           to [sqlite3_free(P)].
1525 **
1526 ** {F17315}  The SQLite core uses [sqlite3_malloc()], [sqlite3_realloc()],
1527 **           and [sqlite3_free()] for all of its memory allocation and
1528 **           deallocation needs.
1529 **
1530 ** {F17318}  The [sqlite3_realloc(P,N)] interface returns either a pointer
1531 **           to a block of checked-out memory of at least N bytes in size
1532 **           that is 8-byte aligned, or a NULL pointer.
1533 **
1534 ** {F17321}  When [sqlite3_realloc(P,N)] returns a non-NULL pointer, it first
1535 **           copies the first K bytes of content from P into the newly allocated
1536 **           where K is the lessor of N and the size of the buffer P.
1537 **
1538 ** {F17322}  When [sqlite3_realloc(P,N)] returns a non-NULL pointer, it first
1539 **           releases the buffer P.
1540 **
1541 ** {F17323}  When [sqlite3_realloc(P,N)] returns NULL, the buffer P is
1542 **           not modified or released.
1543 **
1544 ** LIMITATIONS:
1545 **
1546 ** {U17350}  The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()]
1547 **           must be either NULL or else a pointer obtained from a prior
1548 **           invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that has
1549 **           not been released.
1550 **
1551 ** {U17351}  The application must not read or write any part of 
1552 **           a block of memory after it has been released using
1553 **           [sqlite3_free()] or [sqlite3_realloc()].
1554 **
1555 */
1556 void *sqlite3_malloc(int);
1557 void *sqlite3_realloc(void*, int);
1558 void sqlite3_free(void*);
1559
1560 /*
1561 ** CAPI3REF: Memory Allocator Statistics {F17370}
1562 **
1563 ** SQLite provides these two interfaces for reporting on the status
1564 ** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()]
1565 ** the memory allocation subsystem included within the SQLite.
1566 **
1567 ** INVARIANTS:
1568 **
1569 ** {F17371} The [sqlite3_memory_used()] routine returns the
1570 **          number of bytes of memory currently outstanding 
1571 **          (malloced but not freed).
1572 **
1573 ** {F17373} The [sqlite3_memory_highwater()] routine returns the maximum
1574 **          value of [sqlite3_memory_used()] 
1575 **          since the highwater mark was last reset.
1576 **
1577 ** {F17374} The values returned by [sqlite3_memory_used()] and
1578 **          [sqlite3_memory_highwater()] include any overhead
1579 **          added by SQLite in its implementation of [sqlite3_malloc()],
1580 **          but not overhead added by the any underlying system library
1581 **          routines that [sqlite3_malloc()] may call.
1582 ** 
1583 ** {F17375} The memory highwater mark is reset to the current value of
1584 **          [sqlite3_memory_used()] if and only if the parameter to
1585 **          [sqlite3_memory_highwater()] is true.  The value returned
1586 **          by [sqlite3_memory_highwater(1)] is the highwater mark
1587 **          prior to the reset.
1588 */
1589 sqlite3_int64 sqlite3_memory_used(void);
1590 sqlite3_int64 sqlite3_memory_highwater(int resetFlag);
1591
1592 /*
1593 ** CAPI3REF: Compile-Time Authorization Callbacks {F12500}
1594 **
1595 ** This routine registers a authorizer callback with a particular
1596 ** database connection, supplied in the first argument.
1597 ** The authorizer callback is invoked as SQL statements are being compiled
1598 ** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()],
1599 ** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()].  At various
1600 ** points during the compilation process, as logic is being created
1601 ** to perform various actions, the authorizer callback is invoked to
1602 ** see if those actions are allowed.  The authorizer callback should
1603 ** return SQLITE_OK to allow the action, [SQLITE_IGNORE] to disallow the
1604 ** specific action but allow the SQL statement to continue to be
1605 ** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be
1606 ** rejected with an error.   If the authorizer callback returns
1607 ** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY]
1608 ** then [sqlite3_prepare_v2()] or equivalent call that triggered
1609 ** the authorizer will fail with an error message.
1610 **
1611 ** When the callback returns [SQLITE_OK], that means the operation
1612 ** requested is ok.  When the callback returns [SQLITE_DENY], the
1613 ** [sqlite3_prepare_v2()] or equivalent call that triggered the
1614 ** authorizer will fail with an error message explaining that
1615 ** access is denied.  If the authorizer code is [SQLITE_READ]
1616 ** and the callback returns [SQLITE_IGNORE] then the prepared
1617 ** statement is constructed to insert a NULL value in place of
1618 ** the table column that would have
1619 ** been read if [SQLITE_OK] had been returned.  The [SQLITE_IGNORE]
1620 ** return can be used to deny an untrusted user access to individual
1621 ** columns of a table.
1622 **
1623 ** The first parameter to the authorizer callback is a copy of
1624 ** the third parameter to the sqlite3_set_authorizer() interface.
1625 ** The second parameter to the callback is an integer 
1626 ** [SQLITE_COPY | action code] that specifies the particular action
1627 ** to be authorized. The third through sixth
1628 ** parameters to the callback are zero-terminated strings that contain 
1629 ** additional details about the action to be authorized.
1630 **
1631 ** An authorizer is used when preparing SQL statements from an untrusted
1632 ** source, to ensure that the SQL statements do not try to access data
1633 ** that they are not allowed to see, or that they do not try to
1634 ** execute malicious statements that damage the database.  For
1635 ** example, an application may allow a user to enter arbitrary
1636 ** SQL queries for evaluation by a database.  But the application does
1637 ** not want the user to be able to make arbitrary changes to the
1638 ** database.  An authorizer could then be put in place while the
1639 ** user-entered SQL is being prepared that disallows everything
1640 ** except SELECT statements.  
1641 **
1642 ** Only a single authorizer can be in place on a database connection
1643 ** at a time.  Each call to sqlite3_set_authorizer overrides the
1644 ** previous call.  Disable the authorizer by installing a NULL callback.
1645 ** The authorizer is disabled by default.
1646 **
1647 ** Note that the authorizer callback is invoked only during 
1648 ** [sqlite3_prepare()] or its variants.  Authorization is not
1649 ** performed during statement evaluation in [sqlite3_step()].
1650 **
1651 ** INVARIANTS:
1652 **
1653 ** {F12501} The [sqlite3_set_authorizer(D,...)] interface registers a
1654 **          authorizer callback with database connection D.
1655 **
1656 ** {F12502} The authorizer callback is invoked as SQL statements are
1657 **          being compiled
1658 **
1659 ** {F12503} If the authorizer callback returns any value other than
1660 **          [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY] then
1661 **          the [sqlite3_prepare_v2()] or equivalent call that caused
1662 **          the authorizer callback to run shall fail with an
1663 **          [SQLITE_ERROR] error code and an appropriate error message.
1664 **
1665 ** {F12504} When the authorizer callback returns [SQLITE_OK], the operation
1666 **          described is coded normally.
1667 **
1668 ** {F12505} When the authorizer callback returns [SQLITE_DENY], the
1669 **          [sqlite3_prepare_v2()] or equivalent call that caused the
1670 **          authorizer callback to run shall fail
1671 **          with an [SQLITE_ERROR] error code and an error message
1672 **          explaining that access is denied.
1673 **
1674 ** {F12506} If the authorizer code (the 2nd parameter to the authorizer
1675 **          callback) is [SQLITE_READ] and the authorizer callback returns
1676 **          [SQLITE_IGNORE] then the prepared statement is constructed to
1677 **          insert a NULL value in place of the table column that would have
1678 **          been read if [SQLITE_OK] had been returned.
1679 **
1680 ** {F12507} If the authorizer code (the 2nd parameter to the authorizer
1681 **          callback) is anything other than [SQLITE_READ], then
1682 **          a return of [SQLITE_IGNORE] has the same effect as [SQLITE_DENY]. 
1683 **
1684 ** {F12510} The first parameter to the authorizer callback is a copy of
1685 **          the third parameter to the [sqlite3_set_authorizer()] interface.
1686 **
1687 ** {F12511} The second parameter to the callback is an integer 
1688 **          [SQLITE_COPY | action code] that specifies the particular action
1689 **          to be authorized.
1690 **
1691 ** {F12512} The third through sixth parameters to the callback are
1692 **          zero-terminated strings that contain 
1693 **          additional details about the action to be authorized.
1694 **
1695 ** {F12520} Each call to [sqlite3_set_authorizer()] overrides the
1696 **          any previously installed authorizer.
1697 **
1698 ** {F12521} A NULL authorizer means that no authorization
1699 **          callback is invoked.
1700 **
1701 ** {F12522} The default authorizer is NULL.
1702 */
1703 int sqlite3_set_authorizer(
1704   sqlite3*,
1705   int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
1706   void *pUserData
1707 );
1708
1709 /*
1710 ** CAPI3REF: Authorizer Return Codes {F12590}
1711 **
1712 ** The [sqlite3_set_authorizer | authorizer callback function] must
1713 ** return either [SQLITE_OK] or one of these two constants in order
1714 ** to signal SQLite whether or not the action is permitted.  See the
1715 ** [sqlite3_set_authorizer | authorizer documentation] for additional
1716 ** information.
1717 */
1718 #define SQLITE_DENY   1   /* Abort the SQL statement with an error */
1719 #define SQLITE_IGNORE 2   /* Don't allow access, but don't generate an error */
1720
1721 /*
1722 ** CAPI3REF: Authorizer Action Codes {F12550}
1723 **
1724 ** The [sqlite3_set_authorizer()] interface registers a callback function
1725 ** that is invoked to authorizer certain SQL statement actions.  The
1726 ** second parameter to the callback is an integer code that specifies
1727 ** what action is being authorized.  These are the integer action codes that
1728 ** the authorizer callback may be passed.
1729 **
1730 ** These action code values signify what kind of operation is to be 
1731 ** authorized.  The 3rd and 4th parameters to the authorization
1732 ** callback function will be parameters or NULL depending on which of these
1733 ** codes is used as the second parameter.  The 5th parameter to the
1734 ** authorizer callback is the name of the database ("main", "temp", 
1735 ** etc.) if applicable.  The 6th parameter to the authorizer callback
1736 ** is the name of the inner-most trigger or view that is responsible for
1737 ** the access attempt or NULL if this access attempt is directly from 
1738 ** top-level SQL code.
1739 **
1740 ** INVARIANTS:
1741 **
1742 ** {F12551} The second parameter to an 
1743 **          [sqlite3_set_authorizer | authorizer callback is always an integer
1744 **          [SQLITE_COPY | authorizer code] that specifies what action
1745 **          is being authorized.
1746 **
1747 ** {F12552} The 3rd and 4th parameters to the 
1748 **          [sqlite3_set_authorizer | authorization callback function]
1749 **          will be parameters or NULL depending on which 
1750 **          [SQLITE_COPY | authorizer code] is used as the second parameter.
1751 **
1752 ** {F12553} The 5th parameter to the
1753 **          [sqlite3_set_authorizer | authorizer callback] is the name
1754 **          of the database (example: "main", "temp", etc.) if applicable.
1755 **
1756 ** {F12554} The 6th parameter to the
1757 **          [sqlite3_set_authorizer | authorizer callback] is the name
1758 **          of the inner-most trigger or view that is responsible for
1759 **          the access attempt or NULL if this access attempt is directly from 
1760 **          top-level SQL code.
1761 */
1762 /******************************************* 3rd ************ 4th ***********/
1763 #define SQLITE_CREATE_INDEX          1   /* Index Name      Table Name      */
1764 #define SQLITE_CREATE_TABLE          2   /* Table Name      NULL            */
1765 #define SQLITE_CREATE_TEMP_INDEX     3   /* Index Name      Table Name      */
1766 #define SQLITE_CREATE_TEMP_TABLE     4   /* Table Name      NULL            */
1767 #define SQLITE_CREATE_TEMP_TRIGGER   5   /* Trigger Name    Table Name      */
1768 #define SQLITE_CREATE_TEMP_VIEW      6   /* View Name       NULL            */
1769 #define SQLITE_CREATE_TRIGGER        7   /* Trigger Name    Table Name      */
1770 #define SQLITE_CREATE_VIEW           8   /* View Name       NULL            */
1771 #define SQLITE_DELETE                9   /* Table Name      NULL            */
1772 #define SQLITE_DROP_INDEX           10   /* Index Name      Table Name      */
1773 #define SQLITE_DROP_TABLE           11   /* Table Name      NULL            */
1774 #define SQLITE_DROP_TEMP_INDEX      12   /* Index Name      Table Name      */
1775 #define SQLITE_DROP_TEMP_TABLE      13   /* Table Name      NULL            */
1776 #define SQLITE_DROP_TEMP_TRIGGER    14   /* Trigger Name    Table Name      */
1777 #define SQLITE_DROP_TEMP_VIEW       15   /* View Name       NULL            */
1778 #define SQLITE_DROP_TRIGGER         16   /* Trigger Name    Table Name      */
1779 #define SQLITE_DROP_VIEW            17   /* View Name       NULL            */
1780 #define SQLITE_INSERT               18   /* Table Name      NULL            */
1781 #define SQLITE_PRAGMA               19   /* Pragma Name     1st arg or NULL */
1782 #define SQLITE_READ                 20   /* Table Name      Column Name     */
1783 #define SQLITE_SELECT               21   /* NULL            NULL            */
1784 #define SQLITE_TRANSACTION          22   /* NULL            NULL            */
1785 #define SQLITE_UPDATE               23   /* Table Name      Column Name     */
1786 #define SQLITE_ATTACH               24   /* Filename        NULL            */
1787 #define SQLITE_DETACH               25   /* Database Name   NULL            */
1788 #define SQLITE_ALTER_TABLE          26   /* Database Name   Table Name      */
1789 #define SQLITE_REINDEX              27   /* Index Name      NULL            */
1790 #define SQLITE_ANALYZE              28   /* Table Name      NULL            */
1791 #define SQLITE_CREATE_VTABLE        29   /* Table Name      Module Name     */
1792 #define SQLITE_DROP_VTABLE          30   /* Table Name      Module Name     */
1793 #define SQLITE_FUNCTION             31   /* Function Name   NULL            */
1794 #define SQLITE_COPY                  0   /* No longer used */
1795
1796 /*
1797 ** CAPI3REF: Tracing And Profiling Functions {F12280}
1798 **
1799 ** These routines register callback functions that can be used for
1800 ** tracing and profiling the execution of SQL statements.
1801 **
1802 ** The callback function registered by sqlite3_trace() is invoked at
1803 ** various times when an SQL statement is being run by [sqlite3_step()].
1804 ** The callback returns a UTF-8 rendering of the SQL statement text
1805 ** as the statement first begins executing.  Additional callbacks occur
1806 ** as each triggersubprogram is entered.  The callbacks for triggers
1807 ** contain a UTF-8 SQL comment that identifies the trigger.
1808 ** 
1809 ** The callback function registered by sqlite3_profile() is invoked
1810 ** as each SQL statement finishes.  The profile callback contains
1811 ** the original statement text and an estimate of wall-clock time
1812 ** of how long that statement took to run.
1813 **
1814 ** The sqlite3_profile() API is currently considered experimental and
1815 ** is subject to change or removal in a future release.
1816 **
1817 ** The trigger reporting feature of the trace callback is considered
1818 ** experimental and is subject to change or removal in future releases.
1819 ** Future versions of SQLite might also add new trace callback 
1820 ** invocations.
1821 **
1822 ** INVARIANTS:
1823 **
1824 ** {F12281} The callback function registered by [sqlite3_trace()] is
1825 **          whenever an SQL statement first begins to execute and
1826 **          whenever a trigger subprogram first begins to run.
1827 **
1828 ** {F12282} Each call to [sqlite3_trace()] overrides the previously
1829 **          registered trace callback.
1830 **
1831 ** {F12283} A NULL trace callback disables tracing.
1832 **
1833 ** {F12284} The first argument to the trace callback is a copy of
1834 **          the pointer which was the 3rd argument to [sqlite3_trace()].
1835 **
1836 ** {F12285} The second argument to the trace callback is a
1837 **          zero-terminated UTF8 string containing the original text
1838 **          of the SQL statement as it was passed into [sqlite3_prepare_v2()]
1839 **          or the equivalent, or an SQL comment indicating the beginning
1840 **          of a trigger subprogram.
1841 **
1842 ** {F12287} The callback function registered by [sqlite3_profile()] is invoked
1843 **          as each SQL statement finishes.
1844 **
1845 ** {F12288} The first parameter to the profile callback is a copy of
1846 **          the 3rd parameter to [sqlite3_profile()].
1847 **
1848 ** {F12289} The second parameter to the profile callback is a
1849 **          zero-terminated UTF-8 string that contains the complete text of
1850 **          the SQL statement as it was processed by [sqlite3_prepare_v2()]
1851 **          or the equivalent.
1852 **
1853 ** {F12290} The third parameter to the profile  callback is an estimate
1854 **          of the number of nanoseconds of wall-clock time required to
1855 **          run the SQL statement from start to finish.
1856 */
1857 void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*);
1858 void *sqlite3_profile(sqlite3*,
1859    void(*xProfile)(void*,const char*,sqlite3_uint64), void*);
1860
1861 /*
1862 ** CAPI3REF: Query Progress Callbacks {F12910}
1863 **
1864 ** This routine configures a callback function - the
1865 ** progress callback - that is invoked periodically during long
1866 ** running calls to [sqlite3_exec()], [sqlite3_step()] and
1867 ** [sqlite3_get_table()].   An example use for this 
1868 ** interface is to keep a GUI updated during a large query.
1869 **
1870 ** If the progress callback returns non-zero, the opertion is
1871 ** interrupted.  This feature can be used to implement a
1872 ** "Cancel" button on a GUI dialog box.
1873 **
1874 ** INVARIANTS:
1875 **
1876 ** {F12911} The callback function registered by [sqlite3_progress_handler()]
1877 **          is invoked periodically during long running calls to
1878 **          [sqlite3_step()].
1879 **
1880 ** {F12912} The progress callback is invoked once for every N virtual
1881 **          machine opcodes, where N is the second argument to 
1882 **          the [sqlite3_progress_handler()] call that registered
1883 **          the callback.  <todo>What if N is less than 1?</todo>
1884 **
1885 ** {F12913} The progress callback itself is identified by the third
1886 **          argument to [sqlite3_progress_handler()].
1887 **
1888 ** {F12914} The fourth argument [sqlite3_progress_handler()] is a
1889 ***         void pointer passed to the progress callback
1890 **          function each time it is invoked.
1891 **
1892 ** {F12915} If a call to [sqlite3_step()] results in fewer than
1893 **          N opcodes being executed,
1894 **          then the progress callback is never invoked. {END}
1895 ** 
1896 ** {F12916} Every call to [sqlite3_progress_handler()]
1897 **          overwrites any previously registere progress handler.
1898 **
1899 ** {F12917} If the progress handler callback is NULL then no progress
1900 **          handler is invoked.
1901 **
1902 ** {F12918} If the progress callback returns a result other than 0, then
1903 **          the behavior is a if [sqlite3_interrupt()] had been called.
1904 */
1905 void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
1906
1907 /*
1908 ** CAPI3REF: Opening A New Database Connection {F12700}
1909 **
1910 ** These routines open an SQLite database file whose name
1911 ** is given by the filename argument.
1912 ** The filename argument is interpreted as UTF-8
1913 ** for [sqlite3_open()] and [sqlite3_open_v2()] and as UTF-16
1914 ** in the native byte order for [sqlite3_open16()].
1915 ** An [sqlite3*] handle is usually returned in *ppDb, even
1916 ** if an error occurs.  The only exception is if SQLite is unable
1917 ** to allocate memory to hold the [sqlite3] object, a NULL will
1918 ** be written into *ppDb instead of a pointer to the [sqlite3] object.
1919 ** If the database is opened (and/or created)
1920 ** successfully, then [SQLITE_OK] is returned.  Otherwise an
1921 ** error code is returned.  The
1922 ** [sqlite3_errmsg()] or [sqlite3_errmsg16()]  routines can be used to obtain
1923 ** an English language description of the error.
1924 **
1925 ** The default encoding for the database will be UTF-8 if
1926 ** [sqlite3_open()] or [sqlite3_open_v2()] is called and
1927 ** UTF-16 in the native byte order if [sqlite3_open16()] is used.
1928 **
1929 ** Whether or not an error occurs when it is opened, resources
1930 ** associated with the [sqlite3*] handle should be released by passing it
1931 ** to [sqlite3_close()] when it is no longer required.
1932 **
1933 ** The [sqlite3_open_v2()] interface works like [sqlite3_open()] 
1934 ** except that it acccepts two additional parameters for additional control
1935 ** over the new database connection.  The flags parameter can be
1936 ** one of:
1937 **
1938 ** <ol>
1939 ** <li>  [SQLITE_OPEN_READONLY]
1940 ** <li>  [SQLITE_OPEN_READWRITE]
1941 ** <li>  [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]
1942 ** </ol>
1943 **
1944 ** The first value opens the database read-only. 
1945 ** If the database does not previously exist, an error is returned.
1946 ** The second option opens
1947 ** the database for reading and writing if possible, or reading only if
1948 ** if the file is write protected.  In either case the database
1949 ** must already exist or an error is returned.  The third option
1950 ** opens the database for reading and writing and creates it if it does
1951 ** not already exist.
1952 ** The third options is behavior that is always used for [sqlite3_open()]
1953 ** and [sqlite3_open16()].
1954 **
1955 ** If the filename is ":memory:", then an private
1956 ** in-memory database is created for the connection.  This in-memory
1957 ** database will vanish when the database connection is closed.  Future
1958 ** version of SQLite might make use of additional special filenames
1959 ** that begin with the ":" character.  It is recommended that 
1960 ** when a database filename really does begin with
1961 ** ":" that you prefix the filename with a pathname like "./" to
1962 ** avoid ambiguity.
1963 **
1964 ** If the filename is an empty string, then a private temporary
1965 ** on-disk database will be created.  This private database will be
1966 ** automatically deleted as soon as the database connection is closed.
1967 **
1968 ** The fourth parameter to sqlite3_open_v2() is the name of the
1969 ** [sqlite3_vfs] object that defines the operating system 
1970 ** interface that the new database connection should use.  If the
1971 ** fourth parameter is a NULL pointer then the default [sqlite3_vfs]
1972 ** object is used.
1973 **
1974 ** <b>Note to windows users:</b>  The encoding used for the filename argument
1975 ** of [sqlite3_open()] and [sqlite3_open_v2()] must be UTF-8, not whatever
1976 ** codepage is currently defined.  Filenames containing international
1977 ** characters must be converted to UTF-8 prior to passing them into
1978 ** [sqlite3_open()] or [sqlite3_open_v2()].
1979 **
1980 ** INVARIANTS:
1981 **
1982 ** {F12701} The [sqlite3_open()], [sqlite3_open16()], and
1983 **          [sqlite3_open_v2()] interfaces create a new
1984 **          [database connection] associated with
1985 **          the database file given in their first parameter.
1986 **
1987 ** {F12702} The filename argument is interpreted as UTF-8
1988 **          for [sqlite3_open()] and [sqlite3_open_v2()] and as UTF-16
1989 **          in the native byte order for [sqlite3_open16()].
1990 **
1991 ** {F12703} A successful invocation of [sqlite3_open()], [sqlite3_open16()], 
1992 **          or [sqlite3_open_v2()] writes a pointer to a new
1993 **          [database connection] into *ppDb.
1994 **
1995 ** {F12704} The [sqlite3_open()], [sqlite3_open16()], and
1996 **          [sqlite3_open_v2()] interfaces return [SQLITE_OK] upon success,
1997 **          or an appropriate [error code] on failure.
1998 **
1999 ** {F12706} The default text encoding for a new database created using
2000 **          [sqlite3_open()] or [sqlite3_open_v2()] will be UTF-8.
2001 **
2002 ** {F12707} The default text encoding for a new database created using
2003 **          [sqlite3_open16()] will be UTF-16.
2004 **
2005 ** {F12709} The [sqlite3_open(F,D)] interface is equivalent to
2006 **          [sqlite3_open_v2(F,D,G,0)] where the G parameter is
2007 **          [SQLITE_OPEN_READWRITE]|[SQLITE_OPEN_CREATE].
2008 **
2009 ** {F12711} If the G parameter to [sqlite3_open_v2(F,D,G,V)] contains the
2010 **          bit value [SQLITE_OPEN_READONLY] then the database is opened
2011 **          for reading only.
2012 **
2013 ** {F12712} If the G parameter to [sqlite3_open_v2(F,D,G,V)] contains the
2014 **          bit value [SQLITE_OPEN_READWRITE] then the database is opened
2015 **          reading and writing if possible, or for reading only if the
2016 **          file is write protected by the operating system.
2017 **
2018 ** {F12713} If the G parameter to [sqlite3_open(v2(F,D,G,V)] omits the
2019 **          bit value [SQLITE_OPEN_CREATE] and the database does not
2020 **          previously exist, an error is returned.
2021 **
2022 ** {F12714} If the G parameter to [sqlite3_open(v2(F,D,G,V)] contains the
2023 **          bit value [SQLITE_OPEN_CREATE] and the database does not
2024 **          previously exist, then an attempt is made to create and
2025 **          initialize the database.
2026 **
2027 ** {F12717} If the filename argument to [sqlite3_open()], [sqlite3_open16()],
2028 **          or [sqlite3_open_v2()] is ":memory:", then an private,
2029 **          ephemeral, in-memory database is created for the connection.
2030 **          <todo>Is SQLITE_OPEN_CREATE|SQLITE_OPEN_READWRITE required
2031 **          in sqlite3_open_v2()?</todo>
2032 **
2033 ** {F12719} If the filename is an empty string, then a private, ephermeral
2034 **          on-disk database will be created.
2035 **          <todo>Is SQLITE_OPEN_CREATE|SQLITE_OPEN_READWRITE required
2036 **          in sqlite3_open_v2()?</todo>
2037 **
2038 ** {F12721} The [database connection] created by 
2039 **          [sqlite3_open_v2(F,D,G,V)] will use the
2040 **          [sqlite3_vfs] object identified by the V parameter, or
2041 **          the default [sqlite3_vfs] object is V is a NULL pointer.
2042 */
2043 int sqlite3_open(
2044   const char *filename,   /* Database filename (UTF-8) */
2045   sqlite3 **ppDb          /* OUT: SQLite db handle */
2046 );
2047 int sqlite3_open16(
2048   const void *filename,   /* Database filename (UTF-16) */
2049   sqlite3 **ppDb          /* OUT: SQLite db handle */
2050 );
2051 int sqlite3_open_v2(
2052   const char *filename,   /* Database filename (UTF-8) */
2053   sqlite3 **ppDb,         /* OUT: SQLite db handle */
2054   int flags,              /* Flags */
2055   const char *zVfs        /* Name of VFS module to use */
2056 );
2057
2058 /*
2059 ** CAPI3REF: Error Codes And Messages {F12800}
2060 **
2061 ** The sqlite3_errcode() interface returns the numeric
2062 ** [SQLITE_OK | result code] or [SQLITE_IOERR_READ | extended result code]
2063 ** for the most recent failed sqlite3_* API call associated
2064 ** with [sqlite3] handle 'db'. If a prior API call failed but the
2065 ** most recent API call succeeded, the return value from sqlite3_errcode()
2066 ** is undefined.
2067 **
2068 ** The sqlite3_errmsg() and sqlite3_errmsg16() return English-language
2069 ** text that describes the error, as either UTF8 or UTF16 respectively.
2070 ** Memory to hold the error message string is managed internally.
2071 ** The application does not need to worry with freeing the result.
2072 ** However, the error string might be overwritten or deallocated b
2073 ** subsequent calls to other SQLite interface functions.
2074 **
2075 ** INVARIANTS:
2076 **
2077 ** {F12801} The [sqlite3_errcode(D)] interface returns the numeric
2078 **          [SQLITE_OK | result code] or
2079 **          [SQLITE_IOERR_READ | extended result code]
2080 **          for the most recent failed interface call associated
2081 **          with [sqlite3] handle D.
2082 **
2083 ** {U12802} If a prior API call failed but the most recent API call
2084 **          succeeded, the return value from [sqlite3_errcode()],
2085 **          [sqlite3_errmsg()], and [sqlite3_errmsg16()] are undefined.
2086 **
2087 ** {F12803} The [sqlite3_errmsg(D)] and [sqlite3_errmsg16(D)]
2088 **          interfaces return English-language text that describes
2089 **          the error in the mostly recently failed interface call,
2090 **          encoded as either UTF8 or UTF16 respectively.
2091 **
2092 ** {U12804} The strings returned by [sqlite3_errmsg()] and [sqlite3_errmsg16()]
2093 **          are only valid until the next SQLite interface call.
2094 **
2095 ** {F12807} Calls to [sqlite3_errcode()], [sqlite3_errmsg()], and
2096 **          [sqlite3_errmsg16()] themselves do not affect the
2097 **          results of future invocations of these routines.
2098 **
2099 ** {F12808} Calls to API routines that do not return an error code
2100 **          (example: [sqlite3_data_count()]) do not
2101 **          change the error code or message returned by
2102 **          [sqlite3_errcode()], [sqlite3_errmsg()], or [sqlite3_errmsg16()].
2103 **
2104 ** {F12809} Interfaces that are not associated with a specific
2105 **          [database connection] (examples:
2106 **          [sqlite3_mprintf()] or [sqlite3_enable_shared_cache()]
2107 **          do not change the values returned by
2108 **          [sqlite3_errcode()], [sqlite3_errmsg()], or [sqlite3_errmsg16()].
2109 */
2110 int sqlite3_errcode(sqlite3 *db);
2111 const char *sqlite3_errmsg(sqlite3*);
2112 const void *sqlite3_errmsg16(sqlite3*);
2113
2114 /*
2115 ** CAPI3REF: SQL Statement Object {F13000}
2116 ** KEYWORDS: {prepared statement} {prepared statements}
2117 **
2118 ** An instance of this object represent single SQL statements.  This
2119 ** object is variously known as a "prepared statement" or a 
2120 ** "compiled SQL statement" or simply as a "statement".
2121 ** 
2122 ** The life of a statement object goes something like this:
2123 **
2124 ** <ol>
2125 ** <li> Create the object using [sqlite3_prepare_v2()] or a related
2126 **      function.
2127 ** <li> Bind values to host parameters using
2128 **      [sqlite3_bind_blob | sqlite3_bind_* interfaces].
2129 ** <li> Run the SQL by calling [sqlite3_step()] one or more times.
2130 ** <li> Reset the statement using [sqlite3_reset()] then go back
2131 **      to step 2.  Do this zero or more times.
2132 ** <li> Destroy the object using [sqlite3_finalize()].
2133 ** </ol>
2134 **
2135 ** Refer to documentation on individual methods above for additional
2136 ** information.
2137 */
2138 typedef struct sqlite3_stmt sqlite3_stmt;
2139
2140 /*
2141 ** CAPI3REF: Compiling An SQL Statement {F13010}
2142 **
2143 ** To execute an SQL query, it must first be compiled into a byte-code
2144 ** program using one of these routines. 
2145 **
2146 ** The first argument "db" is an [database connection] 
2147 ** obtained from a prior call to [sqlite3_open()], [sqlite3_open_v2()]
2148 ** or [sqlite3_open16()]. 
2149 ** The second argument "zSql" is the statement to be compiled, encoded
2150 ** as either UTF-8 or UTF-16.  The sqlite3_prepare() and sqlite3_prepare_v2()
2151 ** interfaces uses UTF-8 and sqlite3_prepare16() and sqlite3_prepare16_v2()
2152 ** use UTF-16. {END}
2153 **
2154 ** If the nByte argument is less
2155 ** than zero, then zSql is read up to the first zero terminator.
2156 ** If nByte is non-negative, then it is the maximum number of 
2157 ** bytes read from zSql.  When nByte is non-negative, the
2158 ** zSql string ends at either the first '\000' or '\u0000' character or 
2159 ** until the nByte-th byte, whichever comes first. {END}
2160 **
2161 ** *pzTail is made to point to the first byte past the end of the
2162 ** first SQL statement in zSql.  These routines only compiles the first
2163 ** statement in zSql, so *pzTail is left pointing to what remains
2164 ** uncompiled.
2165 **
2166 ** *ppStmt is left pointing to a compiled [prepared statement] that can be
2167 ** executed using [sqlite3_step()].  Or if there is an error, *ppStmt may be
2168 ** set to NULL.  If the input text contains no SQL (if the input
2169 ** is and empty string or a comment) then *ppStmt is set to NULL.
2170 ** {U13018} The calling procedure is responsible for deleting the
2171 ** compiled SQL statement
2172 ** using [sqlite3_finalize()] after it has finished with it.
2173 **
2174 ** On success, [SQLITE_OK] is returned.  Otherwise an 
2175 ** [error code] is returned.
2176 **
2177 ** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are
2178 ** recommended for all new programs. The two older interfaces are retained
2179 ** for backwards compatibility, but their use is discouraged.
2180 ** In the "v2" interfaces, the prepared statement
2181 ** that is returned (the [sqlite3_stmt] object) contains a copy of the 
2182 ** original SQL text. {END} This causes the [sqlite3_step()] interface to
2183 ** behave a differently in two ways:
2184 **
2185 ** <ol>
2186 ** <li>
2187 ** If the database schema changes, instead of returning [SQLITE_SCHEMA] as it
2188 ** always used to do, [sqlite3_step()] will automatically recompile the SQL
2189 ** statement and try to run it again.  If the schema has changed in
2190 ** a way that makes the statement no longer valid, [sqlite3_step()] will still
2191 ** return [SQLITE_SCHEMA].  But unlike the legacy behavior, 
2192 ** [SQLITE_SCHEMA] is now a fatal error.  Calling
2193 ** [sqlite3_prepare_v2()] again will not make the
2194 ** error go away.  Note: use [sqlite3_errmsg()] to find the text
2195 ** of the parsing error that results in an [SQLITE_SCHEMA] return. {END}
2196 ** </li>
2197 **
2198 ** <li>
2199 ** When an error occurs, 
2200 ** [sqlite3_step()] will return one of the detailed 
2201 ** [error codes] or [extended error codes]. 
2202 ** The legacy behavior was that [sqlite3_step()] would only return a generic
2203 ** [SQLITE_ERROR] result code and you would have to make a second call to
2204 ** [sqlite3_reset()] in order to find the underlying cause of the problem.
2205 ** With the "v2" prepare interfaces, the underlying reason for the error is
2206 ** returned immediately.
2207 ** </li>
2208 ** </ol>
2209 **
2210 ** INVARIANTS:
2211 **
2212 ** {F13011} The [sqlite3_prepare(db,zSql,...)] and
2213 **          [sqlite3_prepare_v2(db,zSql,...)] interfaces interpret the
2214 **          text in their zSql parameter as UTF-8.
2215 **
2216 ** {F13012} The [sqlite3_prepare16(db,zSql,...)] and
2217 **          [sqlite3_prepare16_v2(db,zSql,...)] interfaces interpret the
2218 **          text in their zSql parameter as UTF-16 in the native byte order.
2219 **
2220 ** {F13013} If the nByte argument to [sqlite3_prepare_v2(db,zSql,nByte,...)]
2221 **          and its variants is less than zero, then SQL text is
2222 **          read from zSql is read up to the first zero terminator.
2223 **
2224 ** {F13014} If the nByte argument to [sqlite3_prepare_v2(db,zSql,nByte,...)]
2225 **          and its variants is non-negative, then nBytes bytes
2226 **          SQL text is read from zSql.
2227 **
2228 ** {F13015} In [sqlite3_prepare_v2(db,zSql,N,P,pzTail)] and its variants
2229 **          if the zSql input text contains more than one SQL statement
2230 **          and pzTail is not NULL, then *pzTail is made to point to the
2231 **          first byte past the end of the first SQL statement in zSql.
2232 **          <todo>What does *pzTail point to if there is one statement?</todo>
2233 **
2234 ** {F13016} A successful call to [sqlite3_prepare_v2(db,zSql,N,ppStmt,...)]
2235 **          or one of its variants writes into *ppStmt a pointer to a new
2236 **          [prepared statement] or a pointer to NULL
2237 **          if zSql contains nothing other than whitespace or comments. 
2238 **
2239 ** {F13019} The [sqlite3_prepare_v2()] interface and its variants return
2240 **          [SQLITE_OK] or an appropriate [error code] upon failure.
2241 */
2242 int sqlite3_prepare(
2243   sqlite3 *db,            /* Database handle */
2244   const char *zSql,       /* SQL statement, UTF-8 encoded */
2245   int nByte,              /* Maximum length of zSql in bytes. */
2246   sqlite3_stmt **ppStmt,  /* OUT: Statement handle */
2247   const char **pzTail     /* OUT: Pointer to unused portion of zSql */
2248 );
2249 int sqlite3_prepare_v2(
2250   sqlite3 *db,            /* Database handle */
2251   const char *zSql,       /* SQL statement, UTF-8 encoded */
2252   int nByte,              /* Maximum length of zSql in bytes. */
2253   sqlite3_stmt **ppStmt,  /* OUT: Statement handle */
2254   const char **pzTail     /* OUT: Pointer to unused portion of zSql */
2255 );
2256 int sqlite3_prepare16(
2257   sqlite3 *db,            /* Database handle */
2258   const void *zSql,       /* SQL statement, UTF-16 encoded */
2259   int nByte,              /* Maximum length of zSql in bytes. */
2260   sqlite3_stmt **ppStmt,  /* OUT: Statement handle */
2261   const void **pzTail     /* OUT: Pointer to unused portion of zSql */
2262 );
2263 int sqlite3_prepare16_v2(
2264   sqlite3 *db,            /* Database handle */
2265   const void *zSql,       /* SQL statement, UTF-16 encoded */
2266   int nByte,              /* Maximum length of zSql in bytes. */
2267   sqlite3_stmt **ppStmt,  /* OUT: Statement handle */
2268   const void **pzTail     /* OUT: Pointer to unused portion of zSql */
2269 );
2270
2271 /*
2272 ** CAPIREF: Retrieving Statement SQL {F13100}
2273 **
2274 ** This intereface can be used to retrieve a saved copy of the original
2275 ** SQL text used to create a [prepared statement].
2276 **
2277 ** INVARIANTS:
2278 **
2279 ** {F13101} If the [prepared statement] passed as 
2280 **          the an argument to [sqlite3_sql()] was compiled
2281 **          compiled using either [sqlite3_prepare_v2()] or
2282 **          [sqlite3_prepare16_v2()],
2283 **          then [sqlite3_sql()] function returns a pointer to a
2284 **          zero-terminated string containing a UTF-8 rendering
2285 **          of the original SQL statement.
2286 **
2287 ** {F13102} If the [prepared statement] passed as 
2288 **          the an argument to [sqlite3_sql()] was compiled
2289 **          compiled using either [sqlite3_prepare()] or
2290 **          [sqlite3_prepare16()],
2291 **          then [sqlite3_sql()] function returns a NULL pointer.
2292 **
2293 ** {F13103} The string returned by [sqlite3_sql(S)] is valid until the
2294 **          [prepared statement] S is deleted using [sqlite3_finalize(S)].
2295 */
2296 const char *sqlite3_sql(sqlite3_stmt *pStmt);
2297
2298 /*
2299 ** CAPI3REF:  Dynamically Typed Value Object  {F15000}
2300 **
2301 ** SQLite uses the sqlite3_value object to represent all values
2302 ** that are or can be stored in a database table.
2303 ** SQLite uses dynamic typing for the values it stores.  
2304 ** Values stored in sqlite3_value objects can be
2305 ** be integers, floating point values, strings, BLOBs, or NULL.
2306 */
2307 typedef struct Mem sqlite3_value;
2308
2309 /*
2310 ** CAPI3REF:  SQL Function Context Object {F16001}
2311 **
2312 ** The context in which an SQL function executes is stored in an
2313 ** sqlite3_context object.  A pointer to an sqlite3_context
2314 ** object is always first parameter to application-defined SQL functions.
2315 */
2316 typedef struct sqlite3_context sqlite3_context;
2317
2318 /*
2319 ** CAPI3REF:  Binding Values To Prepared Statements {F13500}
2320 **
2321 ** In the SQL strings input to [sqlite3_prepare_v2()] and its
2322 ** variants, literals may be replace by a parameter in one
2323 ** of these forms:
2324 **
2325 ** <ul>
2326 ** <li>  ?
2327 ** <li>  ?NNN
2328 ** <li>  :VVV
2329 ** <li>  @VVV
2330 ** <li>  $VVV
2331 ** </ul>
2332 **
2333 ** In the parameter forms shown above NNN is an integer literal,
2334 ** VVV alpha-numeric parameter name.
2335 ** The values of these parameters (also called "host parameter names"
2336 ** or "SQL parameters")
2337 ** can be set using the sqlite3_bind_*() routines defined here.
2338 **
2339 ** The first argument to the sqlite3_bind_*() routines always
2340 ** is a pointer to the [sqlite3_stmt] object returned from
2341 ** [sqlite3_prepare_v2()] or its variants. The second
2342 ** argument is the index of the parameter to be set. The
2343 ** first parameter has an index of 1.  When the same named
2344 ** parameter is used more than once, second and subsequent
2345 ** occurrences have the same index as the first occurrence. 
2346 ** The index for named parameters can be looked up using the
2347 ** [sqlite3_bind_parameter_name()] API if desired.  The index
2348 ** for "?NNN" parameters is the value of NNN.
2349 ** The NNN value must be between 1 and the compile-time
2350 ** parameter SQLITE_MAX_VARIABLE_NUMBER (default value: 999).
2351 **
2352 ** The third argument is the value to bind to the parameter.
2353 **
2354 ** In those
2355 ** routines that have a fourth argument, its value is the number of bytes
2356 ** in the parameter.  To be clear: the value is the number of <u>bytes</u>
2357 ** in the value, not the number of characters.   The number
2358 ** of bytes does not include the zero-terminator at the end of strings.
2359 ** If the fourth parameter is negative, the length of the string is
2360 ** number of bytes up to the first zero terminator.
2361 **
2362 ** The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and
2363 ** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or
2364 ** string after SQLite has finished with it. If the fifth argument is
2365 ** the special value [SQLITE_STATIC], then SQLite assumes that the
2366 ** information is in static, unmanaged space and does not need to be freed.
2367 ** If the fifth argument has the value [SQLITE_TRANSIENT], then
2368 ** SQLite makes its own private copy of the data immediately, before
2369 ** the sqlite3_bind_*() routine returns.
2370 **
2371 ** The sqlite3_bind_zeroblob() routine binds a BLOB of length N that
2372 ** is filled with zeros.  A zeroblob uses a fixed amount of memory
2373 ** (just an integer to hold it size) while it is being processed.
2374 ** Zeroblobs are intended to serve as place-holders for BLOBs whose
2375 ** content is later written using 
2376 ** [sqlite3_blob_open | increment BLOB I/O] routines. A negative
2377 ** value for the zeroblob results in a zero-length BLOB.
2378 **
2379 ** The sqlite3_bind_*() routines must be called after
2380 ** [sqlite3_prepare_v2()] (and its variants) or [sqlite3_reset()] and
2381 ** before [sqlite3_step()].
2382 ** Bindings are not cleared by the [sqlite3_reset()] routine.
2383 ** Unbound parameters are interpreted as NULL.
2384 **
2385 ** These routines return [SQLITE_OK] on success or an error code if
2386 ** anything goes wrong.  [SQLITE_RANGE] is returned if the parameter
2387 ** index is out of range.  [SQLITE_NOMEM] is returned if malloc fails.
2388 ** [SQLITE_MISUSE] might be returned if these routines are called on a
2389 ** virtual machine that is the wrong state or which has already been finalized.
2390 ** Detection of misuse is unreliable.  Applications should not depend
2391 ** on SQLITE_MISUSE returns.  SQLITE_MISUSE is intended to indicate a
2392 ** a logic error in the application.  Future versions of SQLite might
2393 ** panic rather than return SQLITE_MISUSE.
2394 **
2395 ** See also: [sqlite3_bind_parameter_count()],
2396 ** [sqlite3_bind_parameter_name()], and
2397 ** [sqlite3_bind_parameter_index()].
2398 **
2399 ** INVARIANTS:
2400 **
2401 ** {F13506} The [sqlite3_prepare | SQL statement compiler] recognizes
2402 **          tokens of the forms "?", "?NNN", "$VVV", ":VVV", and "@VVV"
2403 **          as SQL parameters, where NNN is any sequence of one or more
2404 **          digits and where VVV is any sequence of one or more 
2405 **          alphanumeric characters or "::" optionally followed by
2406 **          a string containing no spaces and contained within parentheses.
2407 **
2408 ** {F13509} The initial value of an SQL parameter is NULL.
2409 **
2410 ** {F13512} The index of an "?" SQL parameter is one larger than the
2411 **          largest index of SQL parameter to the left, or 1 if
2412 **          the "?" is the leftmost SQL parameter.
2413 **
2414 ** {F13515} The index of an "?NNN" SQL parameter is the integer NNN.
2415 **
2416 ** {F13518} The index of an ":VVV", "$VVV", or "@VVV" SQL parameter is
2417 **          the same as the index of leftmost occurances of the same
2418 **          parameter, or one more than the largest index over all
2419 **          parameters to the left if this is the first occurrance
2420 **          of this parameter, or 1 if this is the leftmost parameter.
2421 **
2422 ** {F13521} The [sqlite3_prepare | SQL statement compiler] fail with
2423 **          an [SQLITE_RANGE] error if the index of an SQL parameter
2424 **          is less than 1 or greater than SQLITE_MAX_VARIABLE_NUMBER.
2425 **
2426 ** {F13524} Calls to [sqlite3_bind_text | sqlite3_bind(S,N,V,...)]
2427 **          associate the value V with all SQL parameters having an
2428 **          index of N in the [prepared statement] S.
2429 **
2430 ** {F13527} Calls to [sqlite3_bind_text | sqlite3_bind(S,N,...)]
2431 **          override prior calls with the same values of S and N.
2432 **
2433 ** {F13530} Bindings established by [sqlite3_bind_text | sqlite3_bind(S,...)]
2434 **          persist across calls to [sqlite3_reset(S)].
2435 **
2436 ** {F13533} In calls to [sqlite3_bind_blob(S,N,V,L,D)],
2437 **          [sqlite3_bind_text(S,N,V,L,D)], or
2438 **          [sqlite3_bind_text16(S,N,V,L,D)] SQLite binds the first L
2439 **          bytes of the blob or string pointed to by V, when L
2440 **          is non-negative.
2441 **
2442 ** {F13536} In calls to [sqlite3_bind_text(S,N,V,L,D)] or
2443 **          [sqlite3_bind_text16(S,N,V,L,D)] SQLite binds characters
2444 **          from V through the first zero character when L is negative.
2445 **
2446 ** {F13539} In calls to [sqlite3_bind_blob(S,N,V,L,D)],
2447 **          [sqlite3_bind_text(S,N,V,L,D)], or
2448 **          [sqlite3_bind_text16(S,N,V,L,D)] when D is the special
2449 **          constant [SQLITE_STATIC], SQLite assumes that the value V
2450 **          is held in static unmanaged space that will not change
2451 **          during the lifetime of the binding.
2452 **
2453 ** {F13542} In calls to [sqlite3_bind_blob(S,N,V,L,D)],
2454 **          [sqlite3_bind_text(S,N,V,L,D)], or
2455 **          [sqlite3_bind_text16(S,N,V,L,D)] when D is the special
2456 **          constant [SQLITE_TRANSIENT], the routine makes a 
2457 **          private copy of V value before it returns.
2458 **
2459 ** {F13545} In calls to [sqlite3_bind_blob(S,N,V,L,D)],
2460 **          [sqlite3_bind_text(S,N,V,L,D)], or
2461 **          [sqlite3_bind_text16(S,N,V,L,D)] when D is a pointer to
2462 **          a function, SQLite invokes that function to destroy the
2463 **          V value after it has finished using the V value.
2464 **
2465 ** {F13548} In calls to [sqlite3_bind_zeroblob(S,N,V,L)] the value bound
2466 **          is a blob of L bytes, or a zero-length blob if L is negative.
2467 */
2468 int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*));
2469 int sqlite3_bind_double(sqlite3_stmt*, int, double);
2470 int sqlite3_bind_int(sqlite3_stmt*, int, int);
2471 int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64);
2472 int sqlite3_bind_null(sqlite3_stmt*, int);
2473 int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*));
2474 int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*));
2475 int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);
2476 int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n);
2477
2478 /*
2479 ** CAPI3REF: Number Of SQL Parameters {F13600}
2480 **
2481 ** This routine can be used to find the number of SQL parameters
2482 ** in a prepared statement.  SQL parameters are tokens of the
2483 ** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as
2484 ** place-holders for values that are [sqlite3_bind_blob | bound]
2485 ** to the parameters at a later time.
2486 **
2487 ** This routine actually returns the index of the largest parameter.
2488 ** For all forms except ?NNN, this will correspond to the number of
2489 ** unique parameters.  If parameters of the ?NNN are used, there may
2490 ** be gaps in the list.
2491 **
2492 ** See also: [sqlite3_bind_blob|sqlite3_bind()],
2493 ** [sqlite3_bind_parameter_name()], and
2494 ** [sqlite3_bind_parameter_index()].
2495 **
2496 ** INVARIANTS:
2497 **
2498 ** {F13601} The [sqlite3_bind_parameter_count(S)] interface returns
2499 **          the largest index of all SQL parameters in the
2500 **          [prepared statement] S, or 0 if S
2501 **          contains no SQL parameters.
2502 */
2503 int sqlite3_bind_parameter_count(sqlite3_stmt*);
2504
2505 /*
2506 ** CAPI3REF: Name Of A Host Parameter {F13620}
2507 **
2508 ** This routine returns a pointer to the name of the n-th
2509 ** SQL parameter in a [prepared statement].
2510 ** SQL parameters of the form ":AAA" or "@AAA" or "$AAA" have a name
2511 ** which is the string ":AAA" or "@AAA" or "$VVV". 
2512 ** In other words, the initial ":" or "$" or "@"
2513 ** is included as part of the name.
2514 ** Parameters of the form "?" or "?NNN" have no name.
2515 **
2516 ** The first host parameter has an index of 1, not 0.
2517 **
2518 ** If the value n is out of range or if the n-th parameter is
2519 ** nameless, then NULL is returned.  The returned string is
2520 ** always in the UTF-8 encoding even if the named parameter was
2521 ** originally specified as UTF-16 in [sqlite3_prepare16()] or
2522 ** [sqlite3_prepare16_v2()].
2523 **
2524 ** See also: [sqlite3_bind_blob|sqlite3_bind()],
2525 ** [sqlite3_bind_parameter_count()], and
2526 ** [sqlite3_bind_parameter_index()].
2527 **
2528 ** INVARIANTS:
2529 **
2530 ** {F13621} The [sqlite3_bind_parameter_name(S,N)] interface returns
2531 **          a UTF-8 rendering of the name of the SQL parameter in
2532 **          [prepared statement] S having index N, or
2533 **          NULL if there is no SQL parameter with index N or if the
2534 **          parameter with index N is an anonymous parameter "?" or
2535 **          a numbered parameter "?NNN".
2536 */
2537 const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int);
2538
2539 /*
2540 ** CAPI3REF: Index Of A Parameter With A Given Name {F13640}
2541 **
2542 ** Return the index of an SQL parameter given its name.  The
2543 ** index value returned is suitable for use as the second
2544 ** parameter to [sqlite3_bind_blob|sqlite3_bind()].  A zero
2545 ** is returned if no matching parameter is found.  The parameter
2546 ** name must be given in UTF-8 even if the original statement
2547 ** was prepared from UTF-16 text using [sqlite3_prepare16_v2()].
2548 **
2549 ** See also: [sqlite3_bind_blob|sqlite3_bind()],
2550 ** [sqlite3_bind_parameter_count()], and
2551 ** [sqlite3_bind_parameter_index()].
2552 **
2553 ** INVARIANTS:
2554 **
2555 ** {F13641} The [sqlite3_bind_parameter_index(S,N)] interface returns
2556 **          the index of SQL parameter in [prepared statement]
2557 **          S whose name matches the UTF-8 string N, or 0 if there is
2558 **          no match.
2559 */
2560 int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName);
2561
2562 /*
2563 ** CAPI3REF: Reset All Bindings On A Prepared Statement {F13660}
2564 **
2565 ** Contrary to the intuition of many, [sqlite3_reset()] does not
2566 ** reset the [sqlite3_bind_blob | bindings] on a 
2567 ** [prepared statement].  Use this routine to
2568 ** reset all host parameters to NULL.
2569 **
2570 ** INVARIANTS:
2571 **
2572 ** {F13661} The [sqlite3_clear_bindings(S)] interface resets all
2573 **          SQL parameter bindings in [prepared statement] S
2574 **          back to NULL.
2575 */
2576 int sqlite3_clear_bindings(sqlite3_stmt*);
2577
2578 /*
2579 ** CAPI3REF: Number Of Columns In A Result Set {F13710}
2580 **
2581 ** Return the number of columns in the result set returned by the 
2582 ** [prepared statement]. This routine returns 0
2583 ** if pStmt is an SQL statement that does not return data (for 
2584 ** example an UPDATE).
2585 **
2586 ** INVARIANTS:
2587 **
2588 ** {F13711} The [sqlite3_column_count(S)] interface returns the number of
2589 **          columns in the result set generated by the
2590 **          [prepared statement] S, or 0 if S does not generate
2591 **          a result set.
2592 */
2593 int sqlite3_column_count(sqlite3_stmt *pStmt);
2594
2595 /*
2596 ** CAPI3REF: Column Names In A Result Set {F13720}
2597 **
2598 ** These routines return the name assigned to a particular column
2599 ** in the result set of a SELECT statement.  The sqlite3_column_name()
2600 ** interface returns a pointer to a zero-terminated UTF8 string
2601 ** and sqlite3_column_name16() returns a pointer to a zero-terminated
2602 ** UTF16 string.  The first parameter is the
2603 ** [prepared statement] that implements the SELECT statement.
2604 ** The second parameter is the column number.  The left-most column is
2605 ** number 0.
2606 **
2607 ** The returned string pointer is valid until either the 
2608 ** [prepared statement] is destroyed by [sqlite3_finalize()]
2609 ** or until the next call sqlite3_column_name() or sqlite3_column_name16()
2610 ** on the same column.
2611 **
2612 ** If sqlite3_malloc() fails during the processing of either routine
2613 ** (for example during a conversion from UTF-8 to UTF-16) then a
2614 ** NULL pointer is returned.
2615 **
2616 ** The name of a result column is the value of the "AS" clause for
2617 ** that column, if there is an AS clause.  If there is no AS clause
2618 ** then the name of the column is unspecified and may change from
2619 ** one release of SQLite to the next.
2620 **
2621 ** INVARIANTS:
2622 **
2623 ** {F13721} A successful invocation of the [sqlite3_column_name(S,N)]
2624 **          interface returns the name
2625 **          of the Nth column (where 0 is the left-most column) for the
2626 **          result set of [prepared statement] S as a
2627 **          zero-terminated UTF-8 string.
2628 **
2629 ** {F13723} A successful invocation of the [sqlite3_column_name16(S,N)]
2630 **          interface returns the name
2631 **          of the Nth column (where 0 is the left-most column) for the
2632 **          result set of [prepared statement] S as a
2633 **          zero-terminated UTF-16 string in the native byte order.
2634 **
2635 ** {F13724} The [sqlite3_column_name()] and [sqlite3_column_name16()]
2636 **          interfaces return a NULL pointer if they are unable to
2637 **          allocate memory memory to hold there normal return strings.
2638 **
2639 ** {F13725} If the N parameter to [sqlite3_column_name(S,N)] or
2640 **          [sqlite3_column_name16(S,N)] is out of range, then the
2641 **          interfaces returns a NULL pointer.
2642 ** 
2643 ** {F13726} The strings returned by [sqlite3_column_name(S,N)] and
2644 **          [sqlite3_column_name16(S,N)] are valid until the next
2645 **          call to either routine with the same S and N parameters
2646 **          or until [sqlite3_finalize(S)] is called.
2647 **
2648 ** {F13727} When a result column of a [SELECT] statement contains
2649 **          an AS clause, the name of that column is the indentifier
2650 **          to the right of the AS keyword.
2651 */
2652 const char *sqlite3_column_name(sqlite3_stmt*, int N);
2653 const void *sqlite3_column_name16(sqlite3_stmt*, int N);
2654
2655 /*
2656 ** CAPI3REF: Source Of Data In A Query Result {F13740}
2657 **
2658 ** These routines provide a means to determine what column of what
2659 ** table in which database a result of a SELECT statement comes from.
2660 ** The name of the database or table or column can be returned as
2661 ** either a UTF8 or UTF16 string.  The _database_ routines return
2662 ** the database name, the _table_ routines return the table name, and
2663 ** the origin_ routines return the column name.
2664 ** The returned string is valid until
2665 ** the [prepared statement] is destroyed using
2666 ** [sqlite3_finalize()] or until the same information is requested
2667 ** again in a different encoding.
2668 **
2669 ** The names returned are the original un-aliased names of the
2670 ** database, table, and column.
2671 **
2672 ** The first argument to the following calls is a [prepared statement].
2673 ** These functions return information about the Nth column returned by 
2674 ** the statement, where N is the second function argument.
2675 **
2676 ** If the Nth column returned by the statement is an expression
2677 ** or subquery and is not a column value, then all of these functions
2678 ** return NULL.  These routine might also return NULL if a memory
2679 ** allocation error occurs.  Otherwise, they return the 
2680 ** name of the attached database, table and column that query result
2681 ** column was extracted from.
2682 **
2683 ** As with all other SQLite APIs, those postfixed with "16" return
2684 ** UTF-16 encoded strings, the other functions return UTF-8. {END}
2685 **
2686 ** These APIs are only available if the library was compiled with the 
2687 ** SQLITE_ENABLE_COLUMN_METADATA preprocessor symbol defined.
2688 **
2689 ** {U13751}
2690 ** If two or more threads call one or more of these routines against the same
2691 ** prepared statement and column at the same time then the results are
2692 ** undefined.
2693 **
2694 ** INVARIANTS:
2695 **
2696 ** {F13741} The [sqlite3_column_database_name(S,N)] interface returns either
2697 **          the UTF-8 zero-terminated name of the database from which the 
2698 **          Nth result column of [prepared statement] S 
2699 **          is extracted, or NULL if the the Nth column of S is a
2700 **          general expression or if unable to allocate memory
2701 **          to store the name.
2702 **          
2703 ** {F13742} The [sqlite3_column_database_name16(S,N)] interface returns either
2704 **          the UTF-16 native byte order
2705 **          zero-terminated name of the database from which the 
2706 **          Nth result column of [prepared statement] S 
2707 **          is extracted, or NULL if the the Nth column of S is a
2708 **          general expression or if unable to allocate memory
2709 **          to store the name.
2710 **          
2711 ** {F13743} The [sqlite3_column_table_name(S,N)] interface returns either
2712 **          the UTF-8 zero-terminated name of the table from which the 
2713 **          Nth result column of [prepared statement] S 
2714 **          is extracted, or NULL if the the Nth column of S is a
2715 **          general expression or if unable to allocate memory
2716 **          to store the name.
2717 **          
2718 ** {F13744} The [sqlite3_column_table_name16(S,N)] interface returns either
2719 **          the UTF-16 native byte order
2720 **          zero-terminated name of the table from which the 
2721 **          Nth result column of [prepared statement] S 
2722 **          is extracted, or NULL if the the Nth column of S is a
2723 **          general expression or if unable to allocate memory
2724 **          to store the name.
2725 **          
2726 ** {F13745} The [sqlite3_column_origin_name(S,N)] interface returns either
2727 **          the UTF-8 zero-terminated name of the table column from which the 
2728 **          Nth result column of [prepared statement] S 
2729 **          is extracted, or NULL if the the Nth column of S is a
2730 **          general expression or if unable to allocate memory
2731 **          to store the name.
2732 **          
2733 ** {F13746} The [sqlite3_column_origin_name16(S,N)] interface returns either
2734 **          the UTF-16 native byte order
2735 **          zero-terminated name of the table column from which the 
2736 **          Nth result column of [prepared statement] S 
2737 **          is extracted, or NULL if the the Nth column of S is a
2738 **          general expression or if unable to allocate memory
2739 **          to store the name.
2740 **          
2741 ** {F13748} The return values from
2742 **          [sqlite3_column_database_name|column metadata interfaces]
2743 **          are valid
2744 **          for the lifetime of the [prepared statement]
2745 **          or until the encoding is changed by another metadata
2746 **          interface call for the same prepared statement and column.
2747 **
2748 ** LIMITATIONS:
2749 **
2750 ** {U13751} If two or more threads call one or more
2751 **          [sqlite3_column_database_name|column metadata interfaces]
2752 **          the same [prepared statement] and result column
2753 **          at the same time then the results are undefined.
2754 */
2755 const char *sqlite3_column_database_name(sqlite3_stmt*,int);
2756 const void *sqlite3_column_database_name16(sqlite3_stmt*,int);
2757 const char *sqlite3_column_table_name(sqlite3_stmt*,int);
2758 const void *sqlite3_column_table_name16(sqlite3_stmt*,int);
2759 const char *sqlite3_column_origin_name(sqlite3_stmt*,int);
2760 const void *sqlite3_column_origin_name16(sqlite3_stmt*,int);
2761
2762 /*
2763 ** CAPI3REF: Declared Datatype Of A Query Result {F13760}
2764 **
2765 ** The first parameter is a [prepared statement]. 
2766 ** If this statement is a SELECT statement and the Nth column of the 
2767 ** returned result set of that SELECT is a table column (not an
2768 ** expression or subquery) then the declared type of the table
2769 ** column is returned.  If the Nth column of the result set is an
2770 ** expression or subquery, then a NULL pointer is returned.
2771 ** The returned string is always UTF-8 encoded.  {END} 
2772 ** For example, in the database schema:
2773 **
2774 ** CREATE TABLE t1(c1 VARIANT);
2775 **
2776 ** And the following statement compiled:
2777 **
2778 ** SELECT c1 + 1, c1 FROM t1;
2779 **
2780 ** Then this routine would return the string "VARIANT" for the second
2781 ** result column (i==1), and a NULL pointer for the first result column
2782 ** (i==0).
2783 **
2784 ** SQLite uses dynamic run-time typing.  So just because a column
2785 ** is declared to contain a particular type does not mean that the
2786 ** data stored in that column is of the declared type.  SQLite is
2787 ** strongly typed, but the typing is dynamic not static.  Type
2788 ** is associated with individual values, not with the containers
2789 ** used to hold those values.
2790 **
2791 ** INVARIANTS:
2792 **
2793 ** {F13761}  A successful call to [sqlite3_column_decltype(S,N)]
2794 **           returns a zero-terminated UTF-8 string containing the
2795 **           the declared datatype of the table column that appears
2796 **           as the Nth column (numbered from 0) of the result set to the
2797 **           [prepared statement] S.
2798 **
2799 ** {F13762}  A successful call to [sqlite3_column_decltype16(S,N)]
2800 **           returns a zero-terminated UTF-16 native byte order string
2801 **           containing the declared datatype of the table column that appears
2802 **           as the Nth column (numbered from 0) of the result set to the
2803 **           [prepared statement] S.
2804 **
2805 ** {F13763}  If N is less than 0 or N is greater than or equal to
2806 **           the number of columns in [prepared statement] S
2807 **           or if the Nth column of S is an expression or subquery rather
2808 **           than a table column or if a memory allocation failure
2809 **           occurs during encoding conversions, then
2810 **           calls to [sqlite3_column_decltype(S,N)] or
2811 **           [sqlite3_column_decltype16(S,N)] return NULL.
2812 */
2813 const char *sqlite3_column_decltype(sqlite3_stmt*,int);
2814 const void *sqlite3_column_decltype16(sqlite3_stmt*,int);
2815
2816 /* 
2817 ** CAPI3REF:  Evaluate An SQL Statement {F13200}
2818 **
2819 ** After an [prepared statement] has been prepared with a call
2820 ** to either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or to one of
2821 ** the legacy interfaces [sqlite3_prepare()] or [sqlite3_prepare16()],
2822 ** then this function must be called one or more times to evaluate the 
2823 ** statement.
2824 **
2825 ** The details of the behavior of this sqlite3_step() interface depend
2826 ** on whether the statement was prepared using the newer "v2" interface
2827 ** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy
2828 ** interface [sqlite3_prepare()] and [sqlite3_prepare16()].  The use of the
2829 ** new "v2" interface is recommended for new applications but the legacy
2830 ** interface will continue to be supported.
2831 **
2832 ** In the lagacy interface, the return value will be either [SQLITE_BUSY], 
2833 ** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE].
2834 ** With the "v2" interface, any of the other [SQLITE_OK | result code]
2835 ** or [SQLITE_IOERR_READ | extended result code] might be returned as
2836 ** well.
2837 **
2838 ** [SQLITE_BUSY] means that the database engine was unable to acquire the
2839 ** database locks it needs to do its job.  If the statement is a COMMIT
2840 ** or occurs outside of an explicit transaction, then you can retry the
2841 ** statement.  If the statement is not a COMMIT and occurs within a
2842 ** explicit transaction then you should rollback the transaction before
2843 ** continuing.
2844 **
2845 ** [SQLITE_DONE] means that the statement has finished executing
2846 ** successfully.  sqlite3_step() should not be called again on this virtual
2847 ** machine without first calling [sqlite3_reset()] to reset the virtual
2848 ** machine back to its initial state.
2849 **
2850 ** If the SQL statement being executed returns any data, then 
2851 ** [SQLITE_ROW] is returned each time a new row of data is ready
2852 ** for processing by the caller. The values may be accessed using
2853 ** the [sqlite3_column_int | column access functions].
2854 ** sqlite3_step() is called again to retrieve the next row of data.
2855 ** 
2856 ** [SQLITE_ERROR] means that a run-time error (such as a constraint
2857 ** violation) has occurred.  sqlite3_step() should not be called again on
2858 ** the VM. More information may be found by calling [sqlite3_errmsg()].
2859 ** With the legacy interface, a more specific error code (example:
2860 ** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth)
2861 ** can be obtained by calling [sqlite3_reset()] on the
2862 ** [prepared statement].  In the "v2" interface,
2863 ** the more specific error code is returned directly by sqlite3_step().
2864 **
2865 ** [SQLITE_MISUSE] means that the this routine was called inappropriately.
2866 ** Perhaps it was called on a [prepared statement] that has
2867 ** already been [sqlite3_finalize | finalized] or on one that had 
2868 ** previously returned [SQLITE_ERROR] or [SQLITE_DONE].  Or it could
2869 ** be the case that the same database connection is being used by two or
2870 ** more threads at the same moment in time.
2871 **
2872 ** <b>Goofy Interface Alert:</b>
2873 ** In the legacy interface, 
2874 ** the sqlite3_step() API always returns a generic error code,
2875 ** [SQLITE_ERROR], following any error other than [SQLITE_BUSY]
2876 ** and [SQLITE_MISUSE].  You must call [sqlite3_reset()] or
2877 ** [sqlite3_finalize()] in order to find one of the specific
2878 ** [error codes] that better describes the error.
2879 ** We admit that this is a goofy design.  The problem has been fixed
2880 ** with the "v2" interface.  If you prepare all of your SQL statements
2881 ** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead
2882 ** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()], then the 
2883 ** more specific [error codes] are returned directly
2884 ** by sqlite3_step().  The use of the "v2" interface is recommended.
2885 **
2886 ** INVARIANTS:
2887 **
2888 ** {F13202}  If [prepared statement] S is ready to be
2889 **           run, then [sqlite3_step(S)] advances that prepared statement
2890 **           until to completion or until it is ready to return another
2891 **           row of the result set or an interrupt or run-time error occurs.
2892 **
2893 ** {F15304}  When a call to [sqlite3_step(S)] causes the 
2894 **           [prepared statement] S to run to completion,
2895 **           the function returns [SQLITE_DONE].
2896 **
2897 ** {F15306}  When a call to [sqlite3_step(S)] stops because it is ready
2898 **           to return another row of the result set, it returns
2899 **           [SQLITE_ROW].
2900 **
2901 ** {F15308}  If a call to [sqlite3_step(S)] encounters an
2902 **           [sqlite3_interrupt|interrupt] or a run-time error,
2903 **           it returns an appropraite error code that is not one of
2904 **           [SQLITE_OK], [SQLITE_ROW], or [SQLITE_DONE].
2905 **
2906 ** {F15310}  If an [sqlite3_interrupt|interrupt] or run-time error
2907 **           occurs during a call to [sqlite3_step(S)]
2908 **           for a [prepared statement] S created using
2909 **           legacy interfaces [sqlite3_prepare()] or
2910 **           [sqlite3_prepare16()] then the function returns either
2911 **           [SQLITE_ERROR], [SQLITE_BUSY], or [SQLITE_MISUSE].
2912 */
2913 int sqlite3_step(sqlite3_stmt*);
2914
2915 /*
2916 ** CAPI3REF: Number of columns in a result set {F13770}
2917 **
2918 ** Return the number of values in the current row of the result set.
2919 **
2920 ** INVARIANTS:
2921 **
2922 ** {F13771}  After a call to [sqlite3_step(S)] that returns
2923 **           [SQLITE_ROW], the [sqlite3_data_count(S)] routine
2924 **           will return the same value as the
2925 **           [sqlite3_column_count(S)] function.
2926 **
2927 ** {F13772}  After [sqlite3_step(S)] has returned any value other than
2928 **           [SQLITE_ROW] or before [sqlite3_step(S)] has been 
2929 **           called on the [prepared statement] for
2930 **           the first time since it was [sqlite3_prepare|prepared]
2931 **           or [sqlite3_reset|reset], the [sqlite3_data_count(S)]
2932 **           routine returns zero.
2933 */
2934 int sqlite3_data_count(sqlite3_stmt *pStmt);
2935
2936 /*
2937 ** CAPI3REF: Fundamental Datatypes {F10265}
2938 ** KEYWORDS: SQLITE_TEXT
2939 **
2940 ** {F10266}Every value in SQLite has one of five fundamental datatypes:
2941 **
2942 ** <ul>
2943 ** <li> 64-bit signed integer
2944 ** <li> 64-bit IEEE floating point number
2945 ** <li> string
2946 ** <li> BLOB
2947 ** <li> NULL
2948 ** </ul> {END}
2949 **
2950 ** These constants are codes for each of those types.
2951 **
2952 ** Note that the SQLITE_TEXT constant was also used in SQLite version 2
2953 ** for a completely different meaning.  Software that links against both
2954 ** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT not
2955 ** SQLITE_TEXT.
2956 */
2957 #define SQLITE_INTEGER  1
2958 #define SQLITE_FLOAT    2
2959 #define SQLITE_BLOB     4
2960 #define SQLITE_NULL     5
2961 #ifdef SQLITE_TEXT
2962 # undef SQLITE_TEXT
2963 #else
2964 # define SQLITE_TEXT     3
2965 #endif
2966 #define SQLITE3_TEXT     3
2967
2968 /*
2969 ** CAPI3REF: Results Values From A Query {F13800}
2970 **
2971 ** These routines form the "result set query" interface.
2972 **
2973 ** These routines return information about
2974 ** a single column of the current result row of a query.  In every
2975 ** case the first argument is a pointer to the 
2976 ** [prepared statement] that is being
2977 ** evaluated (the [sqlite3_stmt*] that was returned from 
2978 ** [sqlite3_prepare_v2()] or one of its variants) and
2979 ** the second argument is the index of the column for which information 
2980 ** should be returned.  The left-most column of the result set
2981 ** has an index of 0.
2982 **
2983 ** If the SQL statement is not currently point to a valid row, or if the
2984 ** the column index is out of range, the result is undefined. 
2985 ** These routines may only be called when the most recent call to
2986 ** [sqlite3_step()] has returned [SQLITE_ROW] and neither
2987 ** [sqlite3_reset()] nor [sqlite3_finalize()] has been call subsequently.
2988 ** If any of these routines are called after [sqlite3_reset()] or
2989 ** [sqlite3_finalize()] or after [sqlite3_step()] has returned
2990 ** something other than [SQLITE_ROW], the results are undefined.
2991 ** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()]
2992 ** are called from a different thread while any of these routines
2993 ** are pending, then the results are undefined.  
2994 **
2995 ** The sqlite3_column_type() routine returns 
2996 ** [SQLITE_INTEGER | datatype code] for the initial data type
2997 ** of the result column.  The returned value is one of [SQLITE_INTEGER],
2998 ** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL].  The value
2999 ** returned by sqlite3_column_type() is only meaningful if no type
3000 ** conversions have occurred as described below.  After a type conversion,
3001 ** the value returned by sqlite3_column_type() is undefined.  Future
3002 ** versions of SQLite may change the behavior of sqlite3_column_type()
3003 ** following a type conversion.
3004 **
3005 ** If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes() 
3006 ** routine returns the number of bytes in that BLOB or string.
3007 ** If the result is a UTF-16 string, then sqlite3_column_bytes() converts
3008 ** the string to UTF-8 and then returns the number of bytes.
3009 ** If the result is a numeric value then sqlite3_column_bytes() uses
3010 ** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns
3011 ** the number of bytes in that string.
3012 ** The value returned does not include the zero terminator at the end
3013 ** of the string.  For clarity: the value returned is the number of
3014 ** bytes in the string, not the number of characters.
3015 **
3016 ** Strings returned by sqlite3_column_text() and sqlite3_column_text16(),
3017 ** even empty strings, are always zero terminated.  The return
3018 ** value from sqlite3_column_blob() for a zero-length blob is an arbitrary
3019 ** pointer, possibly even a NULL pointer.
3020 **
3021 ** The sqlite3_column_bytes16() routine is similar to sqlite3_column_bytes()
3022 ** but leaves the result in UTF-16 in native byte order instead of UTF-8.  
3023 ** The zero terminator is not included in this count.
3024 **
3025 ** These routines attempt to convert the value where appropriate.  For
3026 ** example, if the internal representation is FLOAT and a text result
3027 ** is requested, [sqlite3_snprintf()] is used internally to do the conversion
3028 ** automatically.  The following table details the conversions that
3029 ** are applied:
3030 **
3031 ** <blockquote>
3032 ** <table border="1">
3033 ** <tr><th> Internal<br>Type <th> Requested<br>Type <th>  Conversion
3034 **
3035 ** <tr><td>  NULL    <td> INTEGER   <td> Result is 0
3036 ** <tr><td>  NULL    <td>  FLOAT    <td> Result is 0.0
3037 ** <tr><td>  NULL    <td>   TEXT    <td> Result is NULL pointer
3038 ** <tr><td>  NULL    <td>   BLOB    <td> Result is NULL pointer
3039 ** <tr><td> INTEGER  <td>  FLOAT    <td> Convert from integer to float
3040 ** <tr><td> INTEGER  <td>   TEXT    <td> ASCII rendering of the integer
3041 ** <tr><td> INTEGER  <td>   BLOB    <td> Same as for INTEGER->TEXT
3042 ** <tr><td>  FLOAT   <td> INTEGER   <td> Convert from float to integer
3043 ** <tr><td>  FLOAT   <td>   TEXT    <td> ASCII rendering of the float
3044 ** <tr><td>  FLOAT   <td>   BLOB    <td> Same as FLOAT->TEXT
3045 ** <tr><td>  TEXT    <td> INTEGER   <td> Use atoi()
3046 ** <tr><td>  TEXT    <td>  FLOAT    <td> Use atof()
3047 ** <tr><td>  TEXT    <td>   BLOB    <td> No change
3048 ** <tr><td>  BLOB    <td> INTEGER   <td> Convert to TEXT then use atoi()
3049 ** <tr><td>  BLOB    <td>  FLOAT    <td> Convert to TEXT then use atof()
3050 ** <tr><td>  BLOB    <td>   TEXT    <td> Add a zero terminator if needed
3051 ** </table>
3052 ** </blockquote>
3053 **
3054 ** The table above makes reference to standard C library functions atoi()
3055 ** and atof().  SQLite does not really use these functions.  It has its
3056 ** on equavalent internal routines.  The atoi() and atof() names are
3057 ** used in the table for brevity and because they are familiar to most
3058 ** C programmers.
3059 **
3060 ** Note that when type conversions occur, pointers returned by prior
3061 ** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or
3062 ** sqlite3_column_text16() may be invalidated. 
3063 ** Type conversions and pointer invalidations might occur
3064 ** in the following cases:
3065 **
3066 ** <ul>
3067 ** <li><p>  The initial content is a BLOB and sqlite3_column_text() 
3068 **          or sqlite3_column_text16() is called.  A zero-terminator might
3069 **          need to be added to the string.</p></li>
3070 **
3071 ** <li><p>  The initial content is UTF-8 text and sqlite3_column_bytes16() or
3072 **          sqlite3_column_text16() is called.  The content must be converted
3073 **          to UTF-16.</p></li>
3074 **
3075 ** <li><p>  The initial content is UTF-16 text and sqlite3_column_bytes() or
3076 **          sqlite3_column_text() is called.  The content must be converted
3077 **          to UTF-8.</p></li>
3078 ** </ul>
3079 **
3080 ** Conversions between UTF-16be and UTF-16le are always done in place and do
3081 ** not invalidate a prior pointer, though of course the content of the buffer
3082 ** that the prior pointer points to will have been modified.  Other kinds
3083 ** of conversion are done in place when it is possible, but sometime it is
3084 ** not possible and in those cases prior pointers are invalidated.  
3085 **
3086 ** The safest and easiest to remember policy is to invoke these routines
3087 ** in one of the following ways:
3088 **
3089 **  <ul>
3090 **  <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li>
3091 **  <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li>
3092 **  <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li>
3093 **  </ul>
3094 **
3095 ** In other words, you should call sqlite3_column_text(), sqlite3_column_blob(),
3096 ** or sqlite3_column_text16() first to force the result into the desired
3097 ** format, then invoke sqlite3_column_bytes() or sqlite3_column_bytes16() to
3098 ** find the size of the result.  Do not mix call to sqlite3_column_text() or
3099 ** sqlite3_column_blob() with calls to sqlite3_column_bytes16().  And do not
3100 ** mix calls to sqlite3_column_text16() with calls to sqlite3_column_bytes().
3101 **
3102 ** The pointers returned are valid until a type conversion occurs as
3103 ** described above, or until [sqlite3_step()] or [sqlite3_reset()] or
3104 ** [sqlite3_finalize()] is called.  The memory space used to hold strings
3105 ** and blobs is freed automatically.  Do <b>not</b> pass the pointers returned
3106 ** [sqlite3_column_blob()], [sqlite3_column_text()], etc. into 
3107 ** [sqlite3_free()].
3108 **
3109 ** If a memory allocation error occurs during the evaluation of any
3110 ** of these routines, a default value is returned.  The default value
3111 ** is either the integer 0, the floating point number 0.0, or a NULL
3112 ** pointer.  Subsequent calls to [sqlite3_errcode()] will return
3113 ** [SQLITE_NOMEM].
3114 **
3115 ** INVARIANTS:
3116 **
3117 ** {F13803} The [sqlite3_column_blob(S,N)] interface converts the
3118 **          Nth column in the current row of the result set for
3119 **          [prepared statement] S into a blob and then returns a
3120 **          pointer to the converted value.
3121 **
3122 ** {F13806} The [sqlite3_column_bytes(S,N)] interface returns the
3123 **          number of bytes in the blob or string (exclusive of the
3124 **          zero terminator on the string) that was returned by the
3125 **          most recent call to [sqlite3_column_blob(S,N)] or
3126 **          [sqlite3_column_text(S,N)].
3127 **
3128 ** {F13809} The [sqlite3_column_bytes16(S,N)] interface returns the
3129 **          number of bytes in the string (exclusive of the
3130 **          zero terminator on the string) that was returned by the
3131 **          most recent call to [sqlite3_column_text16(S,N)].
3132 **
3133 ** {F13812} The [sqlite3_column_double(S,N)] interface converts the
3134 **          Nth column in the current row of the result set for
3135 **          [prepared statement] S into a floating point value and
3136 **          returns a copy of that value.
3137 **
3138 ** {F13815} The [sqlite3_column_int(S,N)] interface converts the
3139 **          Nth column in the current row of the result set for
3140 **          [prepared statement] S into a 32-bit signed integer and
3141 **          returns a copy of that integer.
3142 **
3143 ** {F13818} The [sqlite3_column_int64(S,N)] interface converts the
3144 **          Nth column in the current row of the result set for
3145 **          [prepared statement] S into a 64-bit signed integer and
3146 **          returns a copy of that integer.
3147 **
3148 ** {F13821} The [sqlite3_column_text(S,N)] interface converts the
3149 **          Nth column in the current row of the result set for
3150 **          [prepared statement] S into a zero-terminated UTF-8 
3151 **          string and returns a pointer to that string.
3152 **
3153 ** {F13824} The [sqlite3_column_text16(S,N)] interface converts the
3154 **          Nth column in the current row of the result set for
3155 **          [prepared statement] S into a zero-terminated 2-byte
3156 **          aligned UTF-16 native byte order
3157 **          string and returns a pointer to that string.
3158 **
3159 ** {F13827} The [sqlite3_column_type(S,N)] interface returns
3160 **          one of [SQLITE_NULL], [SQLITE_INTEGER], [SQLITE_FLOAT],
3161 **          [SQLITE_TEXT], or [SQLITE_BLOB] as appropriate for
3162 **          the Nth column in the current row of the result set for
3163 **          [prepared statement] S.
3164 **
3165 ** {F13830} The [sqlite3_column_value(S,N)] interface returns a
3166 **          pointer to the [sqlite3_value] object that for the
3167 **          Nth column in the current row of the result set for
3168 **          [prepared statement] S.
3169 */
3170 const void *sqlite3_column_blob(sqlite3_stmt*, int iCol);
3171 int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
3172 int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
3173 double sqlite3_column_double(sqlite3_stmt*, int iCol);
3174 int sqlite3_column_int(sqlite3_stmt*, int iCol);
3175 sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol);
3176 const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol);
3177 const void *sqlite3_column_text16(sqlite3_stmt*, int iCol);
3178 int sqlite3_column_type(sqlite3_stmt*, int iCol);
3179 sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol);
3180
3181 /*
3182 ** CAPI3REF: Destroy A Prepared Statement Object {F13300}
3183 **
3184 ** The sqlite3_finalize() function is called to delete a 
3185 ** [prepared statement]. If the statement was
3186 ** executed successfully, or not executed at all, then SQLITE_OK is returned.
3187 ** If execution of the statement failed then an 
3188 ** [error code] or [extended error code]
3189 ** is returned. 
3190 **
3191 ** This routine can be called at any point during the execution of the
3192 ** [prepared statement].  If the virtual machine has not 
3193 ** completed execution when this routine is called, that is like
3194 ** encountering an error or an interrupt.  (See [sqlite3_interrupt()].) 
3195 ** Incomplete updates may be rolled back and transactions cancelled,  
3196 ** depending on the circumstances, and the 
3197 ** [error code] returned will be [SQLITE_ABORT].
3198 **
3199 ** INVARIANTS:
3200 **
3201 ** {F11302} The [sqlite3_finalize(S)] interface destroys the
3202 **          [prepared statement] S and releases all
3203 **          memory and file resources held by that object.
3204 **
3205 ** {F11304} If the most recent call to [sqlite3_step(S)] for the
3206 **          [prepared statement] S returned an error,
3207 **          then [sqlite3_finalize(S)] returns that same error.
3208 */
3209 int sqlite3_finalize(sqlite3_stmt *pStmt);
3210
3211 /*
3212 ** CAPI3REF: Reset A Prepared Statement Object {F13330}
3213 **
3214 ** The sqlite3_reset() function is called to reset a 
3215 ** [prepared statement] object.
3216 ** back to its initial state, ready to be re-executed.
3217 ** Any SQL statement variables that had values bound to them using
3218 ** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values.
3219 ** Use [sqlite3_clear_bindings()] to reset the bindings.
3220 **
3221 ** {F11332} The [sqlite3_reset(S)] interface resets the [prepared statement] S
3222 **          back to the beginning of its program.
3223 **
3224 ** {F11334} If the most recent call to [sqlite3_step(S)] for 
3225 **          [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE],
3226 **          or if [sqlite3_step(S)] has never before been called on S,
3227 **          then [sqlite3_reset(S)] returns [SQLITE_OK].
3228 **
3229 ** {F11336} If the most recent call to [sqlite3_step(S)] for
3230 **          [prepared statement] S indicated an error, then
3231 **          [sqlite3_reset(S)] returns an appropriate [error code].
3232 **
3233 ** {F11338} The [sqlite3_reset(S)] interface does not change the values
3234 **          of any [sqlite3_bind_blob|bindings] on [prepared statement] S.
3235 */
3236 int sqlite3_reset(sqlite3_stmt *pStmt);
3237
3238 /*
3239 ** CAPI3REF: Create Or Redefine SQL Functions {F16100}
3240 ** KEYWORDS: {function creation routines} 
3241 **
3242 ** These two functions (collectively known as
3243 ** "function creation routines") are used to add SQL functions or aggregates
3244 ** or to redefine the behavior of existing SQL functions or aggregates.  The
3245 ** difference only between the two is that the second parameter, the
3246 ** name of the (scalar) function or aggregate, is encoded in UTF-8 for
3247 ** sqlite3_create_function() and UTF-16 for sqlite3_create_function16().
3248 **
3249 ** The first argument is the [database connection] that holds the
3250 ** SQL function or aggregate is to be added or redefined. If a single
3251 ** program uses more than one database handle internally, then SQL
3252 ** functions or aggregates must be added individually to each database
3253 ** handle with which they will be used.
3254 **
3255 ** The second parameter is the name of the SQL function to be created
3256 ** or redefined.
3257 ** The length of the name is limited to 255 bytes, exclusive of the 
3258 ** zero-terminator.  Note that the name length limit is in bytes, not
3259 ** characters.  Any attempt to create a function with a longer name
3260 ** will result in an SQLITE_ERROR error.
3261 **
3262 ** The third parameter is the number of arguments that the SQL function or
3263 ** aggregate takes. If this parameter is negative, then the SQL function or
3264 ** aggregate may take any number of arguments.
3265 **
3266 ** The fourth parameter, eTextRep, specifies what 
3267 ** [SQLITE_UTF8 | text encoding] this SQL function prefers for
3268 ** its parameters.  Any SQL function implementation should be able to work
3269 ** work with UTF-8, UTF-16le, or UTF-16be.  But some implementations may be
3270 ** more efficient with one encoding than another.  It is allowed to
3271 ** invoke sqlite3_create_function() or sqlite3_create_function16() multiple
3272 ** times with the same function but with different values of eTextRep.
3273 ** When multiple implementations of the same function are available, SQLite
3274 ** will pick the one that involves the least amount of data conversion.
3275 ** If there is only a single implementation which does not care what
3276 ** text encoding is used, then the fourth argument should be
3277 ** [SQLITE_ANY].
3278 **
3279 ** The fifth parameter is an arbitrary pointer.  The implementation
3280 ** of the function can gain access to this pointer using
3281 ** [sqlite3_user_data()].
3282 **
3283 ** The seventh, eighth and ninth parameters, xFunc, xStep and xFinal, are
3284 ** pointers to C-language functions that implement the SQL
3285 ** function or aggregate. A scalar SQL function requires an implementation of
3286 ** the xFunc callback only, NULL pointers should be passed as the xStep
3287 ** and xFinal parameters. An aggregate SQL function requires an implementation
3288 ** of xStep and xFinal and NULL should be passed for xFunc. To delete an
3289 ** existing SQL function or aggregate, pass NULL for all three function
3290 ** callback.
3291 **
3292 ** It is permitted to register multiple implementations of the same
3293 ** functions with the same name but with either differing numbers of
3294 ** arguments or differing perferred text encodings.  SQLite will use
3295 ** the implementation most closely matches the way in which the
3296 ** SQL function is used.
3297 **
3298 ** INVARIANTS:
3299 **
3300 ** {F16103} The [sqlite3_create_function16()] interface behaves exactly
3301 **          like [sqlite3_create_function()] in every way except that it
3302 **          interprets the zFunctionName argument as
3303 **          zero-terminated UTF-16 native byte order instead of as a
3304 **          zero-terminated UTF-8.
3305 **
3306 ** {F16106} 
3307 */
3308 int sqlite3_create_function(
3309   sqlite3 *db,
3310   const char *zFunctionName,
3311   int nArg,
3312   int eTextRep,
3313   void *pApp,
3314   void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
3315   void (*xStep)(sqlite3_context*,int,sqlite3_value**),
3316   void (*xFinal)(sqlite3_context*)
3317 );
3318 int sqlite3_create_function16(
3319   sqlite3 *db,
3320   const void *zFunctionName,
3321   int nArg,
3322   int eTextRep,
3323   void *pApp,
3324   void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
3325   void (*xStep)(sqlite3_context*,int,sqlite3_value**),
3326   void (*xFinal)(sqlite3_context*)
3327 );
3328
3329 /*
3330 ** CAPI3REF: Text Encodings {F10267}
3331 **
3332 ** These constant define integer codes that represent the various
3333 ** text encodings supported by SQLite.
3334 */
3335 #define SQLITE_UTF8           1
3336 #define SQLITE_UTF16LE        2
3337 #define SQLITE_UTF16BE        3
3338 #define SQLITE_UTF16          4    /* Use native byte order */
3339 #define SQLITE_ANY            5    /* sqlite3_create_function only */
3340 #define SQLITE_UTF16_ALIGNED  8    /* sqlite3_create_collation only */
3341
3342 /*
3343 ** CAPI3REF: Obsolete Functions
3344 **
3345 ** These functions are all now obsolete.  In order to maintain
3346 ** backwards compatibility with older code, we continue to support
3347 ** these functions.  However, new development projects should avoid
3348 ** the use of these functions.  To help encourage people to avoid
3349 ** using these functions, we are not going to tell you want they do.
3350 */
3351 int sqlite3_aggregate_count(sqlite3_context*);
3352 int sqlite3_expired(sqlite3_stmt*);
3353 int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*);
3354 int sqlite3_global_recover(void);
3355 void sqlite3_thread_cleanup(void);
3356 int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),void*,sqlite3_int64);
3357
3358 /*
3359 ** CAPI3REF: Obtaining SQL Function Parameter Values {F15100}
3360 **
3361 ** The C-language implementation of SQL functions and aggregates uses
3362 ** this set of interface routines to access the parameter values on
3363 ** the function or aggregate.
3364 **
3365 ** The xFunc (for scalar functions) or xStep (for aggregates) parameters
3366 ** to [sqlite3_create_function()] and [sqlite3_create_function16()]
3367 ** define callbacks that implement the SQL functions and aggregates.
3368 ** The 4th parameter to these callbacks is an array of pointers to
3369 ** [sqlite3_value] objects.  There is one [sqlite3_value] object for
3370 ** each parameter to the SQL function.  These routines are used to
3371 ** extract values from the [sqlite3_value] objects.
3372 **
3373 ** These routines work just like the corresponding 
3374 ** [sqlite3_column_blob | sqlite3_column_* routines] except that 
3375 ** these routines take a single [sqlite3_value*] pointer instead
3376 ** of an [sqlite3_stmt*] pointer and an integer column number.
3377 **
3378 ** The sqlite3_value_text16() interface extracts a UTF16 string
3379 ** in the native byte-order of the host machine.  The
3380 ** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces
3381 ** extract UTF16 strings as big-endian and little-endian respectively.
3382 **
3383 ** The sqlite3_value_numeric_type() interface attempts to apply
3384 ** numeric affinity to the value.  This means that an attempt is
3385 ** made to convert the value to an integer or floating point.  If
3386 ** such a conversion is possible without loss of information (in other
3387 ** words if the value is a string that looks like a number)
3388 ** then the conversion is done.  Otherwise no conversion occurs.  The 
3389 ** [SQLITE_INTEGER | datatype] after conversion is returned.
3390 **
3391 ** Please pay particular attention to the fact that the pointer that
3392 ** is returned from [sqlite3_value_blob()], [sqlite3_value_text()], or
3393 ** [sqlite3_value_text16()] can be invalidated by a subsequent call to
3394 ** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()],
3395 ** or [sqlite3_value_text16()].  
3396 **
3397 ** These routines must be called from the same thread as
3398 ** the SQL function that supplied the sqlite3_value* parameters.
3399 ** Or, if the sqlite3_value* argument comes from the [sqlite3_column_value()]
3400 ** interface, then these routines should be called from the same thread
3401 ** that ran [sqlite3_column_value()].
3402 **
3403 */
3404 const void *sqlite3_value_blob(sqlite3_value*);
3405 int sqlite3_value_bytes(sqlite3_value*);
3406 int sqlite3_value_bytes16(sqlite3_value*);
3407 double sqlite3_value_double(sqlite3_value*);
3408 int sqlite3_value_int(sqlite3_value*);
3409 sqlite3_int64 sqlite3_value_int64(sqlite3_value*);
3410 const unsigned char *sqlite3_value_text(sqlite3_value*);
3411 const void *sqlite3_value_text16(sqlite3_value*);
3412 const void *sqlite3_value_text16le(sqlite3_value*);
3413 const void *sqlite3_value_text16be(sqlite3_value*);
3414 int sqlite3_value_type(sqlite3_value*);
3415 int sqlite3_value_numeric_type(sqlite3_value*);
3416
3417 /*
3418 ** CAPI3REF: Obtain Aggregate Function Context {F16210}
3419 **
3420 ** The implementation of aggregate SQL functions use this routine to allocate
3421 ** a structure for storing their state.  
3422 ** {F16211} The first time the sqlite3_aggregate_context() routine is
3423 ** is called for a particular aggregate, SQLite allocates nBytes of memory
3424 ** zeros that memory, and returns a pointer to it.
3425 ** {F16212} On second and subsequent calls to sqlite3_aggregate_context()
3426 ** for the same aggregate function index, the same buffer is returned. {END}
3427 ** The implementation
3428 ** of the aggregate can use the returned buffer to accumulate data.
3429 **
3430 ** {F16213} SQLite automatically frees the allocated buffer when the aggregate
3431 ** query concludes. {END}
3432 **
3433 ** The first parameter should be a copy of the 
3434 ** [sqlite3_context | SQL function context] that is the first
3435 ** parameter to the callback routine that implements the aggregate
3436 ** function.
3437 **
3438 ** This routine must be called from the same thread in which
3439 ** the aggregate SQL function is running.
3440 */
3441 void *sqlite3_aggregate_context(sqlite3_context*, int nBytes);
3442
3443 /*
3444 ** CAPI3REF: User Data For Functions {F16240}
3445 **
3446 ** {F16241} The sqlite3_user_data() interface returns a copy of
3447 ** the pointer that was the pUserData parameter (the 5th parameter)
3448 ** of the the [sqlite3_create_function()]
3449 ** and [sqlite3_create_function16()] routines that originally
3450 ** registered the application defined function. {END}
3451 **
3452 ** {U16243} This routine must be called from the same thread in which
3453 ** the application-defined function is running.
3454 */
3455 void *sqlite3_user_data(sqlite3_context*);
3456
3457 /*
3458 ** CAPI3REF: Function Auxiliary Data {F16270}
3459 **
3460 ** The following two functions may be used by scalar SQL functions to
3461 ** associate meta-data with argument values. If the same value is passed to
3462 ** multiple invocations of the same SQL function during query execution, under
3463 ** some circumstances the associated meta-data may be preserved. This may
3464 ** be used, for example, to add a regular-expression matching scalar
3465 ** function. The compiled version of the regular expression is stored as
3466 ** meta-data associated with the SQL value passed as the regular expression
3467 ** pattern.  The compiled regular expression can be reused on multiple
3468 ** invocations of the same function so that the original pattern string
3469 ** does not need to be recompiled on each invocation.
3470 **
3471 ** {F16271}
3472 ** The sqlite3_get_auxdata() interface returns a pointer to the meta-data
3473 ** associated by the sqlite3_set_auxdata() function with the Nth argument
3474 ** value to the application-defined function.
3475 ** {F16272} If no meta-data has been ever been set for the Nth
3476 ** argument of the function, or if the cooresponding function parameter
3477 ** has changed since the meta-data was set, then sqlite3_get_auxdata()
3478 ** returns a NULL pointer.
3479 **
3480 ** {F16275} The sqlite3_set_auxdata() interface saves the meta-data
3481 ** pointed to by its 3rd parameter as the meta-data for the N-th
3482 ** argument of the application-defined function. {END} Subsequent
3483 ** calls to sqlite3_get_auxdata() might return this data, if it has
3484 ** not been destroyed. 
3485 ** {F16277} If it is not NULL, SQLite will invoke the destructor 
3486 ** function given by the 4th parameter to sqlite3_set_auxdata() on
3487 ** the meta-data when the corresponding function parameter changes
3488 ** or when the SQL statement completes, whichever comes first. {END}
3489 **
3490 ** In practice, meta-data is preserved between function calls for
3491 ** expressions that are constant at compile time. This includes literal
3492 ** values and SQL variables.
3493 **
3494 ** These routines must be called from the same thread in which
3495 ** the SQL function is running.
3496 */
3497 void *sqlite3_get_auxdata(sqlite3_context*, int N);
3498 void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*));
3499
3500
3501 /*
3502 ** CAPI3REF: Constants Defining Special Destructor Behavior {F10280}
3503 **
3504 ** These are special value for the destructor that is passed in as the
3505 ** final argument to routines like [sqlite3_result_blob()].  If the destructor
3506 ** argument is SQLITE_STATIC, it means that the content pointer is constant
3507 ** and will never change.  It does not need to be destroyed.  The 
3508 ** SQLITE_TRANSIENT value means that the content will likely change in
3509 ** the near future and that SQLite should make its own private copy of
3510 ** the content before returning.
3511 **
3512 ** The typedef is necessary to work around problems in certain
3513 ** C++ compilers.  See ticket #2191.
3514 */
3515 typedef void (*sqlite3_destructor_type)(void*);
3516 #define SQLITE_STATIC      ((sqlite3_destructor_type)0)
3517 #define SQLITE_TRANSIENT   ((sqlite3_destructor_type)-1)
3518
3519 /*
3520 ** CAPI3REF: Setting The Result Of An SQL Function {F16400}
3521 **
3522 ** These routines are used by the xFunc or xFinal callbacks that
3523 ** implement SQL functions and aggregates.  See
3524 ** [sqlite3_create_function()] and [sqlite3_create_function16()]
3525 ** for additional information.
3526 **
3527 ** These functions work very much like the 
3528 ** [sqlite3_bind_blob | sqlite3_bind_*] family of functions used
3529 ** to bind values to host parameters in prepared statements.
3530 ** Refer to the
3531 ** [sqlite3_bind_blob | sqlite3_bind_* documentation] for
3532 ** additional information.
3533 **
3534 ** {F16402} The sqlite3_result_blob() interface sets the result from
3535 ** an application defined function to be the BLOB whose content is pointed
3536 ** to by the second parameter and which is N bytes long where N is the
3537 ** third parameter. 
3538 ** {F16403} The sqlite3_result_zeroblob() inerfaces set the result of
3539 ** the application defined function to be a BLOB containing all zero
3540 ** bytes and N bytes in size, where N is the value of the 2nd parameter.
3541 **
3542 ** {F16407} The sqlite3_result_double() interface sets the result from
3543 ** an application defined function to be a floating point value specified
3544 ** by its 2nd argument.
3545 **
3546 ** {F16409} The sqlite3_result_error() and sqlite3_result_error16() functions
3547 ** cause the implemented SQL function to throw an exception.
3548 ** {F16411} SQLite uses the string pointed to by the
3549 ** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16()
3550 ** as the text of an error message. {F16412} SQLite interprets the error
3551 ** message string from sqlite3_result_error() as UTF8.  {F16413} SQLite
3552 ** interprets the string from sqlite3_result_error16() as UTF16 in native
3553 ** byte order.  {F16414} If the third parameter to sqlite3_result_error()
3554 ** or sqlite3_result_error16() is negative then SQLite takes as the error
3555 ** message all text up through the first zero character.
3556 ** {F16415} If the third parameter to sqlite3_result_error() or
3557 ** sqlite3_result_error16() is non-negative then SQLite takes that many
3558 ** bytes (not characters) from the 2nd parameter as the error message.
3559 ** {F16417} The sqlite3_result_error() and sqlite3_result_error16()
3560 ** routines make a copy private copy of the error message text before
3561 ** they return.  {END} Hence, the calling function can deallocate or
3562 ** modify the text after they return without harm.
3563 ** The sqlite3_result_error_code() function changes the error code
3564 ** returned by SQLite as a result of an error in a function.  By default,
3565 ** the error code is SQLITE_ERROR. 
3566 **
3567 ** {F16421} The sqlite3_result_toobig() interface causes SQLite
3568 ** to throw an error indicating that a string or BLOB is to long
3569 ** to represent.  {F16422} The sqlite3_result_nomem() interface
3570 ** causes SQLite to throw an exception indicating that the a
3571 ** memory allocation failed.
3572 **
3573 ** {F16431} The sqlite3_result_int() interface sets the return value
3574 ** of the application-defined function to be the 32-bit signed integer
3575 ** value given in the 2nd argument.
3576 ** {F16432} The sqlite3_result_int64() interface sets the return value
3577 ** of the application-defined function to be the 64-bit signed integer
3578 ** value given in the 2nd argument.
3579 **
3580 ** {F16437} The sqlite3_result_null() interface sets the return value
3581 ** of the application-defined function to be NULL.
3582 **
3583 ** {F16441} The sqlite3_result_text(), sqlite3_result_text16(), 
3584 ** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces
3585 ** set the return value of the application-defined function to be
3586 ** a text string which is represented as UTF-8, UTF-16 native byte order,
3587 ** UTF-16 little endian, or UTF-16 big endian, respectively.
3588 ** {F16442} SQLite takes the text result from the application from
3589 ** the 2nd parameter of the sqlite3_result_text* interfaces.
3590 ** {F16444} If the 3rd parameter to the sqlite3_result_text* interfaces
3591 ** is negative, then SQLite takes result text from the 2nd parameter 
3592 ** through the first zero character.
3593 ** {F16447} If the 3rd parameter to the sqlite3_result_text* interfaces
3594 ** is non-negative, then as many bytes (not characters) of the text
3595 ** pointed to by the 2nd parameter are taken as the application-defined
3596 ** function result.
3597 ** {F16451} If the 4th parameter to the sqlite3_result_text* interfaces
3598 ** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that
3599 ** function as the destructor on the text or blob result when it has
3600 ** finished using that result.
3601 ** {F16453} If the 4th parameter to the sqlite3_result_text* interfaces
3602 ** or sqlite3_result_blob is the special constant SQLITE_STATIC, then
3603 ** SQLite assumes that the text or blob result is constant space and
3604 ** does not copy the space or call a destructor when it has
3605 ** finished using that result.
3606 ** {F16454} If the 4th parameter to the sqlite3_result_text* interfaces
3607 ** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT
3608 ** then SQLite makes a copy of the result into space obtained from
3609 ** from [sqlite3_malloc()] before it returns.
3610 **
3611 ** {F16461} The sqlite3_result_value() interface sets the result of
3612 ** the application-defined function to be a copy the [sqlite3_value]
3613 ** object specified by the 2nd parameter.  {F16463} The
3614 ** sqlite3_result_value() interface makes a copy of the [sqlite3_value]
3615 ** so that [sqlite3_value] specified in the parameter may change or
3616 ** be deallocated after sqlite3_result_value() returns without harm.
3617 **
3618 ** {U16491} These routines are called from within the different thread 
3619 ** than the one containing the application-defined function that recieved
3620 ** the [sqlite3_context] pointer, the results are undefined.
3621 */
3622 void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*));
3623 void sqlite3_result_double(sqlite3_context*, double);
3624 void sqlite3_result_error(sqlite3_context*, const char*, int);
3625 void sqlite3_result_error16(sqlite3_context*, const void*, int);
3626 void sqlite3_result_error_toobig(sqlite3_context*);
3627 void sqlite3_result_error_nomem(sqlite3_context*);
3628 void sqlite3_result_error_code(sqlite3_context*, int);
3629 void sqlite3_result_int(sqlite3_context*, int);
3630 void sqlite3_result_int64(sqlite3_context*, sqlite3_int64);
3631 void sqlite3_result_null(sqlite3_context*);
3632 void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*));
3633 void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*));
3634 void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*));
3635 void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*));
3636 void sqlite3_result_value(sqlite3_context*, sqlite3_value*);
3637 void sqlite3_result_zeroblob(sqlite3_context*, int n);
3638
3639 /*
3640 ** CAPI3REF: Define New Collating Sequences {F16600}
3641 **
3642 ** {F16601}
3643 ** These functions are used to add new collation sequences to the
3644 ** [sqlite3*] handle specified as the first argument. 
3645 **
3646 ** {F16602}
3647 ** The name of the new collation sequence is specified as a UTF-8 string
3648 ** for sqlite3_create_collation() and sqlite3_create_collation_v2()
3649 ** and a UTF-16 string for sqlite3_create_collation16(). {F16603} In all cases
3650 ** the name is passed as the second function argument.
3651 **
3652 ** {F16604}
3653 ** The third argument may be one of the constants [SQLITE_UTF8],
3654 ** [SQLITE_UTF16LE] or [SQLITE_UTF16BE], indicating that the user-supplied
3655 ** routine expects to be passed pointers to strings encoded using UTF-8,
3656 ** UTF-16 little-endian or UTF-16 big-endian respectively. {F16605} The
3657 ** third argument might also be [SQLITE_UTF16_ALIGNED] to indicate that
3658 ** the routine expects pointers to 16-bit word aligned strings
3659 ** of UTF16 in the native byte order of the host computer.
3660 **
3661 ** {F16607}
3662 ** A pointer to the user supplied routine must be passed as the fifth
3663 ** argument. {F16609} If it is NULL, this is the same as deleting the collation
3664 ** sequence (so that SQLite cannot call it anymore).
3665 ** {F16611} Each time the application
3666 ** supplied function is invoked, it is passed a copy of the void* passed as
3667 ** the fourth argument to sqlite3_create_collation() or
3668 ** sqlite3_create_collation16() as its first parameter.
3669 **
3670 ** {F16612}
3671 ** The remaining arguments to the application-supplied routine are two strings,
3672 ** each represented by a (length, data) pair and encoded in the encoding
3673 ** that was passed as the third argument when the collation sequence was
3674 ** registered. {END} The application defined collation routine should
3675 ** return negative, zero or positive if
3676 ** the first string is less than, equal to, or greater than the second
3677 ** string. i.e. (STRING1 - STRING2).
3678 **
3679 ** {F16615}
3680 ** The sqlite3_create_collation_v2() works like sqlite3_create_collation()
3681 ** excapt that it takes an extra argument which is a destructor for
3682 ** the collation.  {F16617} The destructor is called when the collation is
3683 ** destroyed and is passed a copy of the fourth parameter void* pointer
3684 ** of the sqlite3_create_collation_v2().
3685 ** {F16618}  Collations are destroyed when
3686 ** they are overridden by later calls to the collation creation functions
3687 ** or when the [sqlite3*] database handle is closed using [sqlite3_close()].
3688 */
3689 int sqlite3_create_collation(
3690   sqlite3*, 
3691   const char *zName, 
3692   int eTextRep, 
3693   void*,
3694   int(*xCompare)(void*,int,const void*,int,const void*)
3695 );
3696 int sqlite3_create_collation_v2(
3697   sqlite3*, 
3698   const char *zName, 
3699   int eTextRep, 
3700   void*,
3701   int(*xCompare)(void*,int,const void*,int,const void*),
3702   void(*xDestroy)(void*)
3703 );
3704 int sqlite3_create_collation16(
3705   sqlite3*, 
3706   const char *zName, 
3707   int eTextRep, 
3708   void*,
3709   int(*xCompare)(void*,int,const void*,int,const void*)
3710 );
3711
3712 /*
3713 ** CAPI3REF: Collation Needed Callbacks {F16700}
3714 **
3715 ** {F16701}
3716 ** To avoid having to register all collation sequences before a database
3717 ** can be used, a single callback function may be registered with the
3718 ** database handle to be called whenever an undefined collation sequence is
3719 ** required.
3720 **
3721 ** {F16702}
3722 ** If the function is registered using the sqlite3_collation_needed() API,
3723 ** then it is passed the names of undefined collation sequences as strings
3724 ** encoded in UTF-8. {F16703} If sqlite3_collation_needed16() is used, the names
3725 ** are passed as UTF-16 in machine native byte order. {F16704} A call to either
3726 ** function replaces any existing callback.
3727 **
3728 ** {F16705} When the callback is invoked, the first argument passed is a copy
3729 ** of the second argument to sqlite3_collation_needed() or
3730 ** sqlite3_collation_needed16(). {F16706} The second argument is the database
3731 ** handle.  {F16707} The third argument is one of [SQLITE_UTF8],
3732 ** [SQLITE_UTF16BE], or [SQLITE_UTF16LE], indicating the most
3733 ** desirable form of the collation sequence function required.
3734 ** {F16708} The fourth parameter is the name of the
3735 ** required collation sequence. {END}
3736 **
3737 ** The callback function should register the desired collation using
3738 ** [sqlite3_create_collation()], [sqlite3_create_collation16()], or
3739 ** [sqlite3_create_collation_v2()].
3740 */
3741 int sqlite3_collation_needed(
3742   sqlite3*, 
3743   void*, 
3744   void(*)(void*,sqlite3*,int eTextRep,const char*)
3745 );
3746 int sqlite3_collation_needed16(
3747   sqlite3*, 
3748   void*,
3749   void(*)(void*,sqlite3*,int eTextRep,const void*)
3750 );
3751
3752 /*
3753 ** Specify the key for an encrypted database.  This routine should be
3754 ** called right after sqlite3_open().
3755 **
3756 ** The code to implement this API is not available in the public release
3757 ** of SQLite.
3758 */
3759 int sqlite3_key(
3760   sqlite3 *db,                   /* Database to be rekeyed */
3761   const void *pKey, int nKey     /* The key */
3762 );
3763
3764 /*
3765 ** Change the key on an open database.  If the current database is not
3766 ** encrypted, this routine will encrypt it.  If pNew==0 or nNew==0, the
3767 ** database is decrypted.
3768 **
3769 ** The code to implement this API is not available in the public release
3770 ** of SQLite.
3771 */
3772 int sqlite3_rekey(
3773   sqlite3 *db,                   /* Database to be rekeyed */
3774   const void *pKey, int nKey     /* The new key */
3775 );
3776
3777 /*
3778 ** CAPI3REF:  Suspend Execution For A Short Time {F10530}
3779 **
3780 ** {F10531} The sqlite3_sleep() function
3781 ** causes the current thread to suspend execution
3782 ** for at least a number of milliseconds specified in its parameter.
3783 **
3784 ** {F10532} If the operating system does not support sleep requests with 
3785 ** millisecond time resolution, then the time will be rounded up to 
3786 ** the nearest second. {F10533} The number of milliseconds of sleep actually 
3787 ** requested from the operating system is returned.
3788 **
3789 ** {F10534} SQLite implements this interface by calling the xSleep()
3790 ** method of the default [sqlite3_vfs] object. {END}
3791 */
3792 int sqlite3_sleep(int);
3793
3794 /*
3795 ** CAPI3REF:  Name Of The Folder Holding Temporary Files {F10310}
3796 **
3797 ** If this global variable is made to point to a string which is
3798 ** the name of a folder (a.ka. directory), then all temporary files
3799 ** created by SQLite will be placed in that directory.  If this variable
3800 ** is NULL pointer, then SQLite does a search for an appropriate temporary
3801 ** file directory.
3802 **
3803 ** It is not safe to modify this variable once a database connection
3804 ** has been opened.  It is intended that this variable be set once
3805 ** as part of process initialization and before any SQLite interface
3806 ** routines have been call and remain unchanged thereafter.
3807 */
3808 SQLITE_EXTERN char *sqlite3_temp_directory;
3809
3810 /*
3811 ** CAPI3REF:  Test To See If The Database Is In Auto-Commit Mode {F12930}
3812 **
3813 ** The sqlite3_get_autocommit() interfaces returns non-zero or
3814 ** zero if the given database connection is or is not in autocommit mode,
3815 ** respectively.   Autocommit mode is on
3816 ** by default.  Autocommit mode is disabled by a [BEGIN] statement.
3817 ** Autocommit mode is reenabled by a [COMMIT] or [ROLLBACK].
3818 **
3819 ** If certain kinds of errors occur on a statement within a multi-statement
3820 ** transactions (errors including [SQLITE_FULL], [SQLITE_IOERR], 
3821 ** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the
3822 ** transaction might be rolled back automatically.  The only way to
3823 ** find out if SQLite automatically rolled back the transaction after
3824 ** an error is to use this function.
3825 **
3826 ** INVARIANTS:
3827 **
3828 ** {F12931} The [sqlite3_get_autocommit()] interface returns non-zero or
3829 **          zero if the given database connection is or is not in autocommit
3830 **          mode, respectively.
3831 **
3832 ** {F12932} Autocommit mode is on by default.
3833 **
3834 ** {F12933} Autocommit mode is disabled by a successful [BEGIN] statement.
3835 **
3836 ** {F12934} Autocommit mode is enabled by a successful [COMMIT] or [ROLLBACK]
3837 **          statement.
3838 ** 
3839 **
3840 ** LIMITATIONS:
3841 ***
3842 ** {U12936} If another thread changes the autocommit status of the database
3843 **          connection while this routine is running, then the return value
3844 **          is undefined.
3845 */
3846 int sqlite3_get_autocommit(sqlite3*);
3847
3848 /*
3849 ** CAPI3REF:  Find The Database Handle Of A Prepared Statement {F13120}
3850 **
3851 ** {F13121} The sqlite3_db_handle interface
3852 ** returns the [sqlite3*] database handle to which a
3853 ** [prepared statement] belongs.
3854 ** {F13122} the database handle returned by sqlite3_db_handle
3855 ** is the same database handle that was
3856 ** the first argument to the [sqlite3_prepare_v2()] or its variants
3857 ** that was used to create the statement in the first place.
3858 */
3859 sqlite3 *sqlite3_db_handle(sqlite3_stmt*);
3860
3861
3862 /*
3863 ** CAPI3REF: Commit And Rollback Notification Callbacks {F12950}
3864 **
3865 ** {F12951} The sqlite3_commit_hook() interface registers a callback
3866 ** function to be invoked whenever a transaction is committed.
3867 ** {F12952} Any callback set by a previous call to sqlite3_commit_hook()
3868 ** for the same database connection is overridden.
3869 ** {F12953} The sqlite3_rollback_hook() interface registers a callback
3870 ** function to be invoked whenever a transaction is committed.
3871 ** {F12954} Any callback set by a previous call to sqlite3_commit_hook()
3872 ** for the same database connection is overridden.
3873 ** {F12956} The pArg argument is passed through
3874 ** to the callback.  {F12957} If the callback on a commit hook function 
3875 ** returns non-zero, then the commit is converted into a rollback.
3876 **
3877 ** {F12958} If another function was previously registered, its
3878 ** pArg value is returned.  Otherwise NULL is returned.
3879 **
3880 ** {F12959} Registering a NULL function disables the callback.
3881 **
3882 ** {F12961} For the purposes of this API, a transaction is said to have been 
3883 ** rolled back if an explicit "ROLLBACK" statement is executed, or
3884 ** an error or constraint causes an implicit rollback to occur.
3885 ** {F12962} The rollback callback is not invoked if a transaction is
3886 ** automatically rolled back because the database connection is closed.
3887 ** {F12964} The rollback callback is not invoked if a transaction is
3888 ** rolled back because a commit callback returned non-zero.
3889 ** <todo> Check on this </todo> {END}
3890 **
3891 ** These are experimental interfaces and are subject to change.
3892 */
3893 void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
3894 void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);
3895
3896 /*
3897 ** CAPI3REF: Data Change Notification Callbacks {F12970}
3898 **
3899 ** {F12971} The sqlite3_update_hook() interface
3900 ** registers a callback function with the database connection identified by the 
3901 ** first argument to be invoked whenever a row is updated, inserted or deleted.
3902 ** {F12972} Any callback set by a previous call to this function for the same 
3903 ** database connection is overridden.
3904 **
3905 ** {F12974} The second argument is a pointer to the function to invoke when a 
3906 ** row is updated, inserted or deleted. 
3907 ** {F12976} The first argument to the callback is
3908 ** a copy of the third argument to sqlite3_update_hook().
3909 ** {F12977} The second callback 
3910 ** argument is one of [SQLITE_INSERT], [SQLITE_DELETE] or [SQLITE_UPDATE],
3911 ** depending on the operation that caused the callback to be invoked.
3912 ** {F12978} The third and 
3913 ** fourth arguments to the callback contain pointers to the database and 
3914 ** table name containing the affected row.
3915 ** {F12979} The final callback parameter is 
3916 ** the rowid of the row.
3917 ** {F12981} In the case of an update, this is the rowid after 
3918 ** the update takes place.
3919 **
3920 ** {F12983} The update hook is not invoked when internal system tables are
3921 ** modified (i.e. sqlite_master and sqlite_sequence).
3922 **
3923 ** {F12984} If another function was previously registered, its pArg value
3924 ** is returned.  {F12985} Otherwise NULL is returned.
3925 */
3926 void *sqlite3_update_hook(
3927   sqlite3*, 
3928   void(*)(void *,int ,char const *,char const *,sqlite3_int64),
3929   void*
3930 );
3931
3932 /*
3933 ** CAPI3REF:  Enable Or Disable Shared Pager Cache {F10330}
3934 **
3935 ** {F10331}
3936 ** This routine enables or disables the sharing of the database cache
3937 ** and schema data structures between connections to the same database.
3938 ** {F10332}
3939 ** Sharing is enabled if the argument is true and disabled if the argument
3940 ** is false.
3941 **
3942 ** {F10333} Cache sharing is enabled and disabled
3943 ** for an entire process. {END} This is a change as of SQLite version 3.5.0.
3944 ** In prior versions of SQLite, sharing was
3945 ** enabled or disabled for each thread separately.
3946 **
3947 ** {F10334}
3948 ** The cache sharing mode set by this interface effects all subsequent
3949 ** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()].
3950 ** {F10335} Existing database connections continue use the sharing mode
3951 ** that was in effect at the time they were opened. {END}
3952 **
3953 ** Virtual tables cannot be used with a shared cache.  {F10336} When shared
3954 ** cache is enabled, the [sqlite3_create_module()] API used to register
3955 ** virtual tables will always return an error. {END}
3956 **
3957 ** {F10337} This routine returns [SQLITE_OK] if shared cache was
3958 ** enabled or disabled successfully.  {F10338} An [error code]
3959 ** is returned otherwise. {END}
3960 **
3961 ** {F10339} Shared cache is disabled by default. {END} But this might change in
3962 ** future releases of SQLite.  Applications that care about shared
3963 ** cache setting should set it explicitly.
3964 */
3965 int sqlite3_enable_shared_cache(int);
3966
3967 /*
3968 ** CAPI3REF:  Attempt To Free Heap Memory {F17340}
3969 **
3970 ** {F17341} The sqlite3_release_memory() interface attempts to
3971 ** free N bytes of heap memory by deallocating non-essential memory
3972 ** allocations held by the database labrary. {END}  Memory used
3973 ** to cache database pages to improve performance is an example of
3974 ** non-essential memory.  {F16342} sqlite3_release_memory() returns
3975 ** the number of bytes actually freed, which might be more or less
3976 ** than the amount requested.
3977 */
3978 int sqlite3_release_memory(int);
3979
3980 /*
3981 ** CAPI3REF:  Impose A Limit On Heap Size {F17350}
3982 **
3983 ** {F16351} The sqlite3_soft_heap_limit() interface
3984 ** places a "soft" limit on the amount of heap memory that may be allocated
3985 ** by SQLite. {F16352} If an internal allocation is requested 
3986 ** that would exceed the soft heap limit, [sqlite3_release_memory()] is
3987 ** invoked one or more times to free up some space before the allocation
3988 ** is made. {END}
3989 **
3990 ** {F16353} The limit is called "soft", because if
3991 ** [sqlite3_release_memory()] cannot
3992 ** free sufficient memory to prevent the limit from being exceeded,
3993 ** the memory is allocated anyway and the current operation proceeds.
3994 **
3995 ** {F16354}
3996 ** A negative or zero value for N means that there is no soft heap limit and
3997 ** [sqlite3_release_memory()] will only be called when memory is exhausted.
3998 ** {F16355} The default value for the soft heap limit is zero.
3999 **
4000 ** SQLite makes a best effort to honor the soft heap limit.  
4001 ** {F16356} But if the soft heap limit cannot honored, execution will
4002 ** continue without error or notification. {END}  This is why the limit is 
4003 ** called a "soft" limit.  It is advisory only.
4004 **
4005 ** Prior to SQLite version 3.5.0, this routine only constrained the memory
4006 ** allocated by a single thread - the same thread in which this routine
4007 ** runs.  Beginning with SQLite version 3.5.0, the soft heap limit is
4008 ** applied to all threads. {F16357} The value specified for the soft heap limit
4009 ** is an upper bound on the total memory allocation for all threads. {END}  In
4010 ** version 3.5.0 there is no mechanism for limiting the heap usage for
4011 ** individual threads.
4012 */
4013 void sqlite3_soft_heap_limit(int);
4014
4015 /*
4016 ** CAPI3REF:  Extract Metadata About A Column Of A Table {F12850}
4017 **
4018 ** This routine
4019 ** returns meta-data about a specific column of a specific database
4020 ** table accessible using the connection handle passed as the first function 
4021 ** argument.
4022 **
4023 ** The column is identified by the second, third and fourth parameters to 
4024 ** this function. The second parameter is either the name of the database
4025 ** (i.e. "main", "temp" or an attached database) containing the specified
4026 ** table or NULL. If it is NULL, then all attached databases are searched
4027 ** for the table using the same algorithm as the database engine uses to 
4028 ** resolve unqualified table references.
4029 **
4030 ** The third and fourth parameters to this function are the table and column 
4031 ** name of the desired column, respectively. Neither of these parameters 
4032 ** may be NULL.
4033 **
4034 ** Meta information is returned by writing to the memory locations passed as
4035 ** the 5th and subsequent parameters to this function. Any of these 
4036 ** arguments may be NULL, in which case the corresponding element of meta 
4037 ** information is ommitted.
4038 **
4039 ** <pre>
4040 ** Parameter     Output Type      Description
4041 ** -----------------------------------
4042 **
4043 **   5th         const char*      Data type
4044 **   6th         const char*      Name of the default collation sequence 
4045 **   7th         int              True if the column has a NOT NULL constraint
4046 **   8th         int              True if the column is part of the PRIMARY KEY
4047 **   9th         int              True if the column is AUTOINCREMENT
4048 ** </pre>
4049 **
4050 **
4051 ** The memory pointed to by the character pointers returned for the 
4052 ** declaration type and collation sequence is valid only until the next 
4053 ** call to any sqlite API function.
4054 **
4055 ** If the specified table is actually a view, then an error is returned.
4056 **
4057 ** If the specified column is "rowid", "oid" or "_rowid_" and an 
4058 ** INTEGER PRIMARY KEY column has been explicitly declared, then the output 
4059 ** parameters are set for the explicitly declared column. If there is no
4060 ** explicitly declared IPK column, then the output parameters are set as 
4061 ** follows:
4062 **
4063 ** <pre>
4064 **     data type: "INTEGER"
4065 **     collation sequence: "BINARY"
4066 **     not null: 0
4067 **     primary key: 1
4068 **     auto increment: 0
4069 ** </pre>
4070 **
4071 ** This function may load one or more schemas from database files. If an
4072 ** error occurs during this process, or if the requested table or column
4073 ** cannot be found, an SQLITE error code is returned and an error message
4074 ** left in the database handle (to be retrieved using sqlite3_errmsg()).
4075 **
4076 ** This API is only available if the library was compiled with the
4077 ** SQLITE_ENABLE_COLUMN_METADATA preprocessor symbol defined.
4078 */
4079 int sqlite3_table_column_metadata(
4080   sqlite3 *db,                /* Connection handle */
4081   const char *zDbName,        /* Database name or NULL */
4082   const char *zTableName,     /* Table name */
4083   const char *zColumnName,    /* Column name */
4084   char const **pzDataType,    /* OUTPUT: Declared data type */
4085   char const **pzCollSeq,     /* OUTPUT: Collation sequence name */
4086   int *pNotNull,              /* OUTPUT: True if NOT NULL constraint exists */
4087   int *pPrimaryKey,           /* OUTPUT: True if column part of PK */
4088   int *pAutoinc               /* OUTPUT: True if column is auto-increment */
4089 );
4090
4091 /*
4092 ** CAPI3REF: Load An Extension {F12600}
4093 **
4094 ** {F12601} The sqlite3_load_extension() interface
4095 ** attempts to load an SQLite extension library contained in the file
4096 ** zFile. {F12602} The entry point is zProc. {F12603} zProc may be 0
4097 ** in which case the name of the entry point defaults
4098 ** to "sqlite3_extension_init".
4099 **
4100 ** {F12604} The sqlite3_load_extension() interface shall
4101 ** return [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.
4102 **
4103 ** {F12605}
4104 ** If an error occurs and pzErrMsg is not 0, then the
4105 ** sqlite3_load_extension() interface shall attempt to fill *pzErrMsg with 
4106 ** error message text stored in memory obtained from [sqlite3_malloc()].
4107 ** {END}  The calling function should free this memory
4108 ** by calling [sqlite3_free()].
4109 **
4110 ** {F12606}
4111 ** Extension loading must be enabled using [sqlite3_enable_load_extension()]
4112 ** prior to calling this API or an error will be returned.
4113 */
4114 int sqlite3_load_extension(
4115   sqlite3 *db,          /* Load the extension into this database connection */
4116   const char *zFile,    /* Name of the shared library containing extension */
4117   const char *zProc,    /* Entry point.  Derived from zFile if 0 */
4118   char **pzErrMsg       /* Put error message here if not 0 */
4119 );
4120
4121 /*
4122 ** CAPI3REF:  Enable Or Disable Extension Loading {F12620}
4123 **
4124 ** So as not to open security holes in older applications that are
4125 ** unprepared to deal with extension loading, and as a means of disabling
4126 ** extension loading while evaluating user-entered SQL, the following
4127 ** API is provided to turn the [sqlite3_load_extension()] mechanism on and
4128 ** off.  {F12622} It is off by default. {END} See ticket #1863.
4129 **
4130 ** {F12621} Call the sqlite3_enable_load_extension() routine
4131 ** with onoff==1 to turn extension loading on
4132 ** and call it with onoff==0 to turn it back off again. {END}
4133 */
4134 int sqlite3_enable_load_extension(sqlite3 *db, int onoff);
4135
4136 /*
4137 ** CAPI3REF: Make Arrangements To Automatically Load An Extension {F12640}
4138 **
4139 ** {F12641} This function
4140 ** registers an extension entry point that is automatically invoked
4141 ** whenever a new database connection is opened using
4142 ** [sqlite3_open()], [sqlite3_open16()], or [sqlite3_open_v2()]. {END}
4143 **
4144 ** This API can be invoked at program startup in order to register
4145 ** one or more statically linked extensions that will be available
4146 ** to all new database connections.
4147 **
4148 ** {F12642} Duplicate extensions are detected so calling this routine multiple
4149 ** times with the same extension is harmless.
4150 **
4151 ** {F12643} This routine stores a pointer to the extension in an array
4152 ** that is obtained from sqlite_malloc(). {END} If you run a memory leak
4153 ** checker on your program and it reports a leak because of this
4154 ** array, then invoke [sqlite3_reset_auto_extension()] prior
4155 ** to shutdown to free the memory.
4156 **
4157 ** {F12644} Automatic extensions apply across all threads. {END}
4158 **
4159 ** This interface is experimental and is subject to change or
4160 ** removal in future releases of SQLite.
4161 */
4162 int sqlite3_auto_extension(void *xEntryPoint);
4163
4164
4165 /*
4166 ** CAPI3REF: Reset Automatic Extension Loading {F12660}
4167 **
4168 ** {F12661} This function disables all previously registered
4169 ** automatic extensions. {END}  This
4170 ** routine undoes the effect of all prior [sqlite3_auto_extension()]
4171 ** calls.
4172 **
4173 ** {F12662} This call disabled automatic extensions in all threads. {END}
4174 **
4175 ** This interface is experimental and is subject to change or
4176 ** removal in future releases of SQLite.
4177 */
4178 void sqlite3_reset_auto_extension(void);
4179
4180
4181 /*
4182 ****** EXPERIMENTAL - subject to change without notice **************
4183 **
4184 ** The interface to the virtual-table mechanism is currently considered
4185 ** to be experimental.  The interface might change in incompatible ways.
4186 ** If this is a problem for you, do not use the interface at this time.
4187 **
4188 ** When the virtual-table mechanism stablizes, we will declare the
4189 ** interface fixed, support it indefinitely, and remove this comment.
4190 */
4191
4192 /*
4193 ** Structures used by the virtual table interface
4194 */
4195 typedef struct sqlite3_vtab sqlite3_vtab;
4196 typedef struct sqlite3_index_info sqlite3_index_info;
4197 typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor;
4198 typedef struct sqlite3_module sqlite3_module;
4199
4200 /*
4201 ** A module is a class of virtual tables.  Each module is defined
4202 ** by an instance of the following structure.  This structure consists
4203 ** mostly of methods for the module.
4204 */
4205 struct sqlite3_module {
4206   int iVersion;
4207   int (*xCreate)(sqlite3*, void *pAux,
4208                int argc, const char *const*argv,
4209                sqlite3_vtab **ppVTab, char**);
4210   int (*xConnect)(sqlite3*, void *pAux,
4211                int argc, const char *const*argv,
4212                sqlite3_vtab **ppVTab, char**);
4213   int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*);
4214   int (*xDisconnect)(sqlite3_vtab *pVTab);
4215   int (*xDestroy)(sqlite3_vtab *pVTab);
4216   int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor);
4217   int (*xClose)(sqlite3_vtab_cursor*);
4218   int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr,
4219                 int argc, sqlite3_value **argv);
4220   int (*xNext)(sqlite3_vtab_cursor*);
4221   int (*xEof)(sqlite3_vtab_cursor*);
4222   int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int);
4223   int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid);
4224   int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *);
4225   int (*xBegin)(sqlite3_vtab *pVTab);
4226   int (*xSync)(sqlite3_vtab *pVTab);
4227   int (*xCommit)(sqlite3_vtab *pVTab);
4228   int (*xRollback)(sqlite3_vtab *pVTab);
4229   int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName,
4230                        void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),
4231                        void **ppArg);
4232
4233   int (*xRename)(sqlite3_vtab *pVtab, const char *zNew);
4234 };
4235
4236 /*
4237 ** The sqlite3_index_info structure and its substructures is used to
4238 ** pass information into and receive the reply from the xBestIndex
4239 ** method of an sqlite3_module.  The fields under **Inputs** are the
4240 ** inputs to xBestIndex and are read-only.  xBestIndex inserts its
4241 ** results into the **Outputs** fields.
4242 **
4243 ** The aConstraint[] array records WHERE clause constraints of the
4244 ** form:
4245 **
4246 **         column OP expr
4247 **
4248 ** Where OP is =, &lt;, &lt;=, &gt;, or &gt;=.  
4249 ** The particular operator is stored
4250 ** in aConstraint[].op.  The index of the column is stored in 
4251 ** aConstraint[].iColumn.  aConstraint[].usable is TRUE if the
4252 ** expr on the right-hand side can be evaluated (and thus the constraint
4253 ** is usable) and false if it cannot.
4254 **
4255 ** The optimizer automatically inverts terms of the form "expr OP column"
4256 ** and makes other simplifications to the WHERE clause in an attempt to
4257 ** get as many WHERE clause terms into the form shown above as possible.
4258 ** The aConstraint[] array only reports WHERE clause terms in the correct
4259 ** form that refer to the particular virtual table being queried.
4260 **
4261 ** Information about the ORDER BY clause is stored in aOrderBy[].
4262 ** Each term of aOrderBy records a column of the ORDER BY clause.
4263 **
4264 ** The xBestIndex method must fill aConstraintUsage[] with information
4265 ** about what parameters to pass to xFilter.  If argvIndex>0 then
4266 ** the right-hand side of the corresponding aConstraint[] is evaluated
4267 ** and becomes the argvIndex-th entry in argv.  If aConstraintUsage[].omit
4268 ** is true, then the constraint is assumed to be fully handled by the
4269 ** virtual table and is not checked again by SQLite.
4270 **
4271 ** The idxNum and idxPtr values are recorded and passed into xFilter.
4272 ** sqlite3_free() is used to free idxPtr if needToFreeIdxPtr is true.
4273 **
4274 ** The orderByConsumed means that output from xFilter will occur in
4275 ** the correct order to satisfy the ORDER BY clause so that no separate
4276 ** sorting step is required.
4277 **
4278 ** The estimatedCost value is an estimate of the cost of doing the
4279 ** particular lookup.  A full scan of a table with N entries should have
4280 ** a cost of N.  A binary search of a table of N entries should have a
4281 ** cost of approximately log(N).
4282 */
4283 struct sqlite3_index_info {
4284   /* Inputs */
4285   int nConstraint;           /* Number of entries in aConstraint */
4286   struct sqlite3_index_constraint {
4287      int iColumn;              /* Column on left-hand side of constraint */
4288      unsigned char op;         /* Constraint operator */
4289      unsigned char usable;     /* True if this constraint is usable */
4290      int iTermOffset;          /* Used internally - xBestIndex should ignore */
4291   } *aConstraint;            /* Table of WHERE clause constraints */
4292   int nOrderBy;              /* Number of terms in the ORDER BY clause */
4293   struct sqlite3_index_orderby {
4294      int iColumn;              /* Column number */
4295      unsigned char desc;       /* True for DESC.  False for ASC. */
4296   } *aOrderBy;               /* The ORDER BY clause */
4297
4298   /* Outputs */
4299   struct sqlite3_index_constraint_usage {
4300     int argvIndex;           /* if >0, constraint is part of argv to xFilter */
4301     unsigned char omit;      /* Do not code a test for this constraint */
4302   } *aConstraintUsage;
4303   int idxNum;                /* Number used to identify the index */
4304   char *idxStr;              /* String, possibly obtained from sqlite3_malloc */
4305   int needToFreeIdxStr;      /* Free idxStr using sqlite3_free() if true */
4306   int orderByConsumed;       /* True if output is already ordered */
4307   double estimatedCost;      /* Estimated cost of using this index */
4308 };
4309 #define SQLITE_INDEX_CONSTRAINT_EQ    2
4310 #define SQLITE_INDEX_CONSTRAINT_GT    4
4311 #define SQLITE_INDEX_CONSTRAINT_LE    8
4312 #define SQLITE_INDEX_CONSTRAINT_LT    16
4313 #define SQLITE_INDEX_CONSTRAINT_GE    32
4314 #define SQLITE_INDEX_CONSTRAINT_MATCH 64
4315
4316 /*
4317 ** This routine is used to register a new module name with an SQLite
4318 ** connection.  Module names must be registered before creating new
4319 ** virtual tables on the module, or before using preexisting virtual
4320 ** tables of the module.
4321 */
4322 int sqlite3_create_module(
4323   sqlite3 *db,               /* SQLite connection to register module with */
4324   const char *zName,         /* Name of the module */
4325   const sqlite3_module *,    /* Methods for the module */
4326   void *                     /* Client data for xCreate/xConnect */
4327 );
4328
4329 /*
4330 ** This routine is identical to the sqlite3_create_module() method above,
4331 ** except that it allows a destructor function to be specified. It is
4332 ** even more experimental than the rest of the virtual tables API.
4333 */
4334 int sqlite3_create_module_v2(
4335   sqlite3 *db,               /* SQLite connection to register module with */
4336   const char *zName,         /* Name of the module */
4337   const sqlite3_module *,    /* Methods for the module */
4338   void *,                    /* Client data for xCreate/xConnect */
4339   void(*xDestroy)(void*)     /* Module destructor function */
4340 );
4341
4342 /*
4343 ** Every module implementation uses a subclass of the following structure
4344 ** to describe a particular instance of the module.  Each subclass will
4345 ** be tailored to the specific needs of the module implementation.   The
4346 ** purpose of this superclass is to define certain fields that are common
4347 ** to all module implementations.
4348 **
4349 ** Virtual tables methods can set an error message by assigning a
4350 ** string obtained from sqlite3_mprintf() to zErrMsg.  The method should
4351 ** take care that any prior string is freed by a call to sqlite3_free()
4352 ** prior to assigning a new string to zErrMsg.  After the error message
4353 ** is delivered up to the client application, the string will be automatically
4354 ** freed by sqlite3_free() and the zErrMsg field will be zeroed.  Note
4355 ** that sqlite3_mprintf() and sqlite3_free() are used on the zErrMsg field
4356 ** since virtual tables are commonly implemented in loadable extensions which
4357 ** do not have access to sqlite3MPrintf() or sqlite3Free().
4358 */
4359 struct sqlite3_vtab {
4360   const sqlite3_module *pModule;  /* The module for this virtual table */
4361   int nRef;                       /* Used internally */
4362   char *zErrMsg;                  /* Error message from sqlite3_mprintf() */
4363   /* Virtual table implementations will typically add additional fields */
4364 };
4365
4366 /* Every module implementation uses a subclass of the following structure
4367 ** to describe cursors that point into the virtual table and are used
4368 ** to loop through the virtual table.  Cursors are created using the
4369 ** xOpen method of the module.  Each module implementation will define
4370 ** the content of a cursor structure to suit its own needs.
4371 **
4372 ** This superclass exists in order to define fields of the cursor that
4373 ** are common to all implementations.
4374 */
4375 struct sqlite3_vtab_cursor {
4376   sqlite3_vtab *pVtab;      /* Virtual table of this cursor */
4377   /* Virtual table implementations will typically add additional fields */
4378 };
4379
4380 /*
4381 ** The xCreate and xConnect methods of a module use the following API
4382 ** to declare the format (the names and datatypes of the columns) of
4383 ** the virtual tables they implement.
4384 */
4385 int sqlite3_declare_vtab(sqlite3*, const char *zCreateTable);
4386
4387 /*
4388 ** Virtual tables can provide alternative implementations of functions
4389 ** using the xFindFunction method.  But global versions of those functions
4390 ** must exist in order to be overloaded.
4391 **
4392 ** This API makes sure a global version of a function with a particular
4393 ** name and number of parameters exists.  If no such function exists
4394 ** before this API is called, a new function is created.  The implementation
4395 ** of the new function always causes an exception to be thrown.  So
4396 ** the new function is not good for anything by itself.  Its only
4397 ** purpose is to be a place-holder function that can be overloaded
4398 ** by virtual tables.
4399 **
4400 ** This API should be considered part of the virtual table interface,
4401 ** which is experimental and subject to change.
4402 */
4403 int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg);
4404
4405 /*
4406 ** The interface to the virtual-table mechanism defined above (back up
4407 ** to a comment remarkably similar to this one) is currently considered
4408 ** to be experimental.  The interface might change in incompatible ways.
4409 ** If this is a problem for you, do not use the interface at this time.
4410 **
4411 ** When the virtual-table mechanism stabilizes, we will declare the
4412 ** interface fixed, support it indefinitely, and remove this comment.
4413 **
4414 ****** EXPERIMENTAL - subject to change without notice **************
4415 */
4416
4417 /*
4418 ** CAPI3REF: A Handle To An Open BLOB {F17800}
4419 **
4420 ** An instance of the following opaque structure is used to 
4421 ** represent an blob-handle.  A blob-handle is created by
4422 ** [sqlite3_blob_open()] and destroyed by [sqlite3_blob_close()].
4423 ** The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces
4424 ** can be used to read or write small subsections of the blob.
4425 ** The [sqlite3_blob_bytes()] interface returns the size of the
4426 ** blob in bytes.
4427 */
4428 typedef struct sqlite3_blob sqlite3_blob;
4429
4430 /*
4431 ** CAPI3REF: Open A BLOB For Incremental I/O {F17810}
4432 **
4433 ** {F17811} This interfaces opens a handle to the blob located
4434 ** in row iRow,, column zColumn, table zTable in database zDb;
4435 ** in other words,  the same blob that would be selected by:
4436 **
4437 ** <pre>
4438 **     SELECT zColumn FROM zDb.zTable WHERE rowid = iRow;
4439 ** </pre> {END}
4440 **
4441 ** {F17812} If the flags parameter is non-zero, the blob is opened for 
4442 ** read and write access. If it is zero, the blob is opened for read 
4443 ** access. {END}
4444 **
4445 ** {F17813} On success, [SQLITE_OK] is returned and the new 
4446 ** [sqlite3_blob | blob handle] is written to *ppBlob. 
4447 ** {F17814} Otherwise an error code is returned and 
4448 ** any value written to *ppBlob should not be used by the caller.
4449 ** {F17815} This function sets the database-handle error code and message
4450 ** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()].
4451 ** <todo>We should go through and mark all interfaces that behave this
4452 ** way with a similar statement</todo>
4453 */
4454 int sqlite3_blob_open(
4455   sqlite3*,
4456   const char *zDb,
4457   const char *zTable,
4458   const char *zColumn,
4459   sqlite3_int64 iRow,
4460   int flags,
4461   sqlite3_blob **ppBlob
4462 );
4463
4464 /*
4465 ** CAPI3REF:  Close A BLOB Handle {F17830}
4466 **
4467 ** Close an open [sqlite3_blob | blob handle].
4468 **
4469 ** {F17831} Closing a BLOB shall cause the current transaction to commit
4470 ** if there are no other BLOBs, no pending prepared statements, and the
4471 ** database connection is in autocommit mode.
4472 ** {F17832} If any writes were made to the BLOB, they might be held in cache
4473 ** until the close operation if they will fit. {END}
4474 ** Closing the BLOB often forces the changes
4475 ** out to disk and so if any I/O errors occur, they will likely occur
4476 ** at the time when the BLOB is closed.  {F17833} Any errors that occur during
4477 ** closing are reported as a non-zero return value.
4478 **
4479 ** {F17839} The BLOB is closed unconditionally.  Even if this routine returns
4480 ** an error code, the BLOB is still closed.
4481 */
4482 int sqlite3_blob_close(sqlite3_blob *);
4483
4484 /*
4485 ** CAPI3REF:  Return The Size Of An Open BLOB {F17805}
4486 **
4487 ** {F16806} Return the size in bytes of the blob accessible via the open 
4488 ** [sqlite3_blob | blob-handle] passed as an argument.
4489 */
4490 int sqlite3_blob_bytes(sqlite3_blob *);
4491
4492 /*
4493 ** CAPI3REF:  Read Data From A BLOB Incrementally {F17850}
4494 **
4495 ** This function is used to read data from an open 
4496 ** [sqlite3_blob | blob-handle] into a caller supplied buffer.
4497 ** {F17851} n bytes of data are copied into buffer
4498 ** z from the open blob, starting at offset iOffset.
4499 **
4500 ** {F17852} If offset iOffset is less than n bytes from the end of the blob, 
4501 ** [SQLITE_ERROR] is returned and no data is read.  {F17853} If n is
4502 ** less than zero [SQLITE_ERROR] is returned and no data is read.
4503 **
4504 ** {F17854} On success, SQLITE_OK is returned. Otherwise, an 
4505 ** [error code] or an [extended error code] is returned.
4506 */
4507 int sqlite3_blob_read(sqlite3_blob *, void *z, int n, int iOffset);
4508
4509 /*
4510 ** CAPI3REF:  Write Data Into A BLOB Incrementally {F17870}
4511 **
4512 ** This function is used to write data into an open 
4513 ** [sqlite3_blob | blob-handle] from a user supplied buffer.
4514 ** {F17871} n bytes of data are copied from the buffer
4515 ** pointed to by z into the open blob, starting at offset iOffset.
4516 **
4517 ** {F17872} If the [sqlite3_blob | blob-handle] passed as the first argument
4518 ** was not opened for writing (the flags parameter to [sqlite3_blob_open()]
4519 *** was zero), this function returns [SQLITE_READONLY].
4520 **
4521 ** {F17873} This function may only modify the contents of the blob; it is
4522 ** not possible to increase the size of a blob using this API.
4523 ** {F17874} If offset iOffset is less than n bytes from the end of the blob, 
4524 ** [SQLITE_ERROR] is returned and no data is written.  {F17875} If n is
4525 ** less than zero [SQLITE_ERROR] is returned and no data is written.
4526 **
4527 ** {F17876} On success, SQLITE_OK is returned. Otherwise, an 
4528 ** [error code] or an [extended error code] is returned.
4529 */
4530 int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset);
4531
4532 /*
4533 ** CAPI3REF:  Virtual File System Objects {F11200}
4534 **
4535 ** A virtual filesystem (VFS) is an [sqlite3_vfs] object
4536 ** that SQLite uses to interact
4537 ** with the underlying operating system.  Most builds come with a
4538 ** single default VFS that is appropriate for the host computer.
4539 ** New VFSes can be registered and existing VFSes can be unregistered.
4540 ** The following interfaces are provided.
4541 **
4542 ** {F11201} The sqlite3_vfs_find() interface returns a pointer to 
4543 ** a VFS given its name.  {F11202} Names are case sensitive.
4544 ** {F11203} Names are zero-terminated UTF-8 strings.
4545 ** {F11204} If there is no match, a NULL
4546 ** pointer is returned. {F11205} If zVfsName is NULL then the default 
4547 ** VFS is returned. {END}
4548 **
4549 ** {F11210} New VFSes are registered with sqlite3_vfs_register().
4550 ** {F11211} Each new VFS becomes the default VFS if the makeDflt flag is set.
4551 ** {F11212} The same VFS can be registered multiple times without injury.
4552 ** {F11213} To make an existing VFS into the default VFS, register it again
4553 ** with the makeDflt flag set. {U11214} If two different VFSes with the
4554 ** same name are registered, the behavior is undefined.  {U11215} If a
4555 ** VFS is registered with a name that is NULL or an empty string,
4556 ** then the behavior is undefined.
4557 ** 
4558 ** {F11220} Unregister a VFS with the sqlite3_vfs_unregister() interface.
4559 ** {F11221} If the default VFS is unregistered, another VFS is chosen as
4560 ** the default.  The choice for the new VFS is arbitrary.
4561 */
4562 sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName);
4563 int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);
4564 int sqlite3_vfs_unregister(sqlite3_vfs*);
4565
4566 /*
4567 ** CAPI3REF: Mutexes {F17000}
4568 **
4569 ** The SQLite core uses these routines for thread
4570 ** synchronization.  Though they are intended for internal
4571 ** use by SQLite, code that links against SQLite is
4572 ** permitted to use any of these routines.
4573 **
4574 ** The SQLite source code contains multiple implementations 
4575 ** of these mutex routines.  An appropriate implementation
4576 ** is selected automatically at compile-time.  The following
4577 ** implementations are available in the SQLite core:
4578 **
4579 ** <ul>
4580 ** <li>   SQLITE_MUTEX_OS2
4581 ** <li>   SQLITE_MUTEX_PTHREAD
4582 ** <li>   SQLITE_MUTEX_W32
4583 ** <li>   SQLITE_MUTEX_NOOP
4584 ** </ul>
4585 **
4586 ** The SQLITE_MUTEX_NOOP implementation is a set of routines 
4587 ** that does no real locking and is appropriate for use in 
4588 ** a single-threaded application.  The SQLITE_MUTEX_OS2,
4589 ** SQLITE_MUTEX_PTHREAD, and SQLITE_MUTEX_W32 implementations
4590 ** are appropriate for use on os/2, unix, and windows.
4591 ** 
4592 ** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor
4593 ** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex
4594 ** implementation is included with the library.  The
4595 ** mutex interface routines defined here become external
4596 ** references in the SQLite library for which implementations
4597 ** must be provided by the application.  This facility allows an
4598 ** application that links against SQLite to provide its own mutex
4599 ** implementation without having to modify the SQLite core.
4600 **
4601 ** {F17011} The sqlite3_mutex_alloc() routine allocates a new
4602 ** mutex and returns a pointer to it. {F17012} If it returns NULL
4603 ** that means that a mutex could not be allocated. {F17013} SQLite
4604 ** will unwind its stack and return an error. {F17014} The argument
4605 ** to sqlite3_mutex_alloc() is one of these integer constants:
4606 **
4607 ** <ul>
4608 ** <li>  SQLITE_MUTEX_FAST
4609 ** <li>  SQLITE_MUTEX_RECURSIVE
4610 ** <li>  SQLITE_MUTEX_STATIC_MASTER
4611 ** <li>  SQLITE_MUTEX_STATIC_MEM
4612 ** <li>  SQLITE_MUTEX_STATIC_MEM2
4613 ** <li>  SQLITE_MUTEX_STATIC_PRNG
4614 ** <li>  SQLITE_MUTEX_STATIC_LRU
4615 ** </ul> {END}
4616 **
4617 ** {F17015} The first two constants cause sqlite3_mutex_alloc() to create
4618 ** a new mutex.  The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
4619 ** is used but not necessarily so when SQLITE_MUTEX_FAST is used. {END}
4620 ** The mutex implementation does not need to make a distinction
4621 ** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
4622 ** not want to.  {F17016} But SQLite will only request a recursive mutex in
4623 ** cases where it really needs one.  {END} If a faster non-recursive mutex
4624 ** implementation is available on the host platform, the mutex subsystem
4625 ** might return such a mutex in response to SQLITE_MUTEX_FAST.
4626 **
4627 ** {F17017} The other allowed parameters to sqlite3_mutex_alloc() each return
4628 ** a pointer to a static preexisting mutex. {END}  Four static mutexes are
4629 ** used by the current version of SQLite.  Future versions of SQLite
4630 ** may add additional static mutexes.  Static mutexes are for internal
4631 ** use by SQLite only.  Applications that use SQLite mutexes should
4632 ** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
4633 ** SQLITE_MUTEX_RECURSIVE.
4634 **
4635 ** {F17018} Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
4636 ** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
4637 ** returns a different mutex on every call.  {F17034} But for the static 
4638 ** mutex types, the same mutex is returned on every call that has
4639 ** the same type number. {END}
4640 **
4641 ** {F17019} The sqlite3_mutex_free() routine deallocates a previously
4642 ** allocated dynamic mutex. {F17020} SQLite is careful to deallocate every
4643 ** dynamic mutex that it allocates. {U17021} The dynamic mutexes must not be in 
4644 ** use when they are deallocated. {U17022} Attempting to deallocate a static
4645 ** mutex results in undefined behavior. {F17023} SQLite never deallocates
4646 ** a static mutex. {END}
4647 **
4648 ** The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
4649 ** to enter a mutex. {F17024} If another thread is already within the mutex,
4650 ** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
4651 ** SQLITE_BUSY. {F17025}  The sqlite3_mutex_try() interface returns SQLITE_OK
4652 ** upon successful entry.  {F17026} Mutexes created using
4653 ** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread.
4654 ** {F17027} In such cases the,
4655 ** mutex must be exited an equal number of times before another thread
4656 ** can enter.  {U17028} If the same thread tries to enter any other
4657 ** kind of mutex more than once, the behavior is undefined.
4658 ** {F17029} SQLite will never exhibit
4659 ** such behavior in its own use of mutexes. {END}
4660 **
4661 ** Some systems (ex: windows95) do not the operation implemented by
4662 ** sqlite3_mutex_try().  On those systems, sqlite3_mutex_try() will
4663 ** always return SQLITE_BUSY.  {F17030} The SQLite core only ever uses
4664 ** sqlite3_mutex_try() as an optimization so this is acceptable behavior. {END}
4665 **
4666 ** {F17031} The sqlite3_mutex_leave() routine exits a mutex that was
4667 ** previously entered by the same thread.  {U17032} The behavior
4668 ** is undefined if the mutex is not currently entered by the
4669 ** calling thread or is not currently allocated.  {F17033} SQLite will
4670 ** never do either. {END}
4671 **
4672 ** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()].
4673 */
4674 sqlite3_mutex *sqlite3_mutex_alloc(int);
4675 void sqlite3_mutex_free(sqlite3_mutex*);
4676 void sqlite3_mutex_enter(sqlite3_mutex*);
4677 int sqlite3_mutex_try(sqlite3_mutex*);
4678 void sqlite3_mutex_leave(sqlite3_mutex*);
4679
4680 /*
4681 ** CAPI3REF: Mutex Verifcation Routines {F17080}
4682 **
4683 ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines
4684 ** are intended for use inside assert() statements. {F17081} The SQLite core
4685 ** never uses these routines except inside an assert() and applications
4686 ** are advised to follow the lead of the core.  {F17082} The core only
4687 ** provides implementations for these routines when it is compiled
4688 ** with the SQLITE_DEBUG flag.  {U17087} External mutex implementations
4689 ** are only required to provide these routines if SQLITE_DEBUG is
4690 ** defined and if NDEBUG is not defined.
4691 **
4692 ** {F17083} These routines should return true if the mutex in their argument
4693 ** is held or not held, respectively, by the calling thread. {END}
4694 **
4695 ** {X17084} The implementation is not required to provided versions of these
4696 ** routines that actually work.
4697 ** If the implementation does not provide working
4698 ** versions of these routines, it should at least provide stubs
4699 ** that always return true so that one does not get spurious
4700 ** assertion failures. {END}
4701 **
4702 ** {F17085} If the argument to sqlite3_mutex_held() is a NULL pointer then
4703 ** the routine should return 1.  {END} This seems counter-intuitive since
4704 ** clearly the mutex cannot be held if it does not exist.  But the
4705 ** the reason the mutex does not exist is because the build is not
4706 ** using mutexes.  And we do not want the assert() containing the
4707 ** call to sqlite3_mutex_held() to fail, so a non-zero return is
4708 ** the appropriate thing to do.  {F17086} The sqlite3_mutex_notheld() 
4709 ** interface should also return 1 when given a NULL pointer.
4710 */
4711 int sqlite3_mutex_held(sqlite3_mutex*);
4712 int sqlite3_mutex_notheld(sqlite3_mutex*);
4713
4714 /*
4715 ** CAPI3REF: Mutex Types {F17001}
4716 **
4717 ** {F17002} The [sqlite3_mutex_alloc()] interface takes a single argument
4718 ** which is one of these integer constants. {END}
4719 */
4720 #define SQLITE_MUTEX_FAST             0
4721 #define SQLITE_MUTEX_RECURSIVE        1
4722 #define SQLITE_MUTEX_STATIC_MASTER    2
4723 #define SQLITE_MUTEX_STATIC_MEM       3  /* sqlite3_malloc() */
4724 #define SQLITE_MUTEX_STATIC_MEM2      4  /* sqlite3_release_memory() */
4725 #define SQLITE_MUTEX_STATIC_PRNG      5  /* sqlite3_random() */
4726 #define SQLITE_MUTEX_STATIC_LRU       6  /* lru page list */
4727
4728 /*
4729 ** CAPI3REF: Low-Level Control Of Database Files {F11300}
4730 **
4731 ** {F11301} The [sqlite3_file_control()] interface makes a direct call to the
4732 ** xFileControl method for the [sqlite3_io_methods] object associated
4733 ** with a particular database identified by the second argument. {F11302} The
4734 ** name of the database is the name assigned to the database by the
4735 ** <a href="lang_attach.html">ATTACH</a> SQL command that opened the
4736 ** database. {F11303} To control the main database file, use the name "main"
4737 ** or a NULL pointer. {F11304} The third and fourth parameters to this routine
4738 ** are passed directly through to the second and third parameters of
4739 ** the xFileControl method.  {F11305} The return value of the xFileControl
4740 ** method becomes the return value of this routine.
4741 **
4742 ** {F11306} If the second parameter (zDbName) does not match the name of any
4743 ** open database file, then SQLITE_ERROR is returned. {F11307} This error
4744 ** code is not remembered and will not be recalled by [sqlite3_errcode()]
4745 ** or [sqlite3_errmsg()]. {U11308} The underlying xFileControl method might
4746 ** also return SQLITE_ERROR.  {U11309} There is no way to distinguish between
4747 ** an incorrect zDbName and an SQLITE_ERROR return from the underlying
4748 ** xFileControl method. {END}
4749 **
4750 ** See also: [SQLITE_FCNTL_LOCKSTATE]
4751 */
4752 int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*);
4753
4754 /*
4755 ** CAPI3REF: Testing Interface {F11400}
4756 **
4757 ** The sqlite3_test_control() interface is used to read out internal
4758 ** state of SQLite and to inject faults into SQLite for testing
4759 ** purposes.  The first parameter a operation code that determines
4760 ** the number, meaning, and operation of all subsequent parameters.
4761 **
4762 ** This interface is not for use by applications.  It exists solely
4763 ** for verifying the correct operation of the SQLite library.  Depending
4764 ** on how the SQLite library is compiled, this interface might not exist.
4765 **
4766 ** The details of the operation codes, their meanings, the parameters
4767 ** they take, and what they do are all subject to change without notice.
4768 ** Unlike most of the SQLite API, this function is not guaranteed to
4769 ** operate consistently from one release to the next.
4770 */
4771 int sqlite3_test_control(int op, ...);
4772
4773 /*
4774 ** CAPI3REF: Testing Interface Operation Codes {F11410}
4775 **
4776 ** These constants are the valid operation code parameters used
4777 ** as the first argument to [sqlite3_test_control()].
4778 **
4779 ** These parameters and their meansing are subject to change
4780 ** without notice.  These values are for testing purposes only.
4781 ** Applications should not use any of these parameters or the
4782 ** [sqlite3_test_control()] interface.
4783 */
4784 #define SQLITE_TESTCTRL_FAULT_CONFIG             1
4785 #define SQLITE_TESTCTRL_FAULT_FAILURES           2
4786 #define SQLITE_TESTCTRL_FAULT_BENIGN_FAILURES    3
4787 #define SQLITE_TESTCTRL_FAULT_PENDING            4
4788
4789
4790
4791
4792
4793 /*
4794 ** Undo the hack that converts floating point types to integer for
4795 ** builds on processors without floating point support.
4796 */
4797 #ifdef SQLITE_OMIT_FLOATING_POINT
4798 # undef double
4799 #endif
4800
4801 #ifdef __cplusplus
4802 }  /* End of the 'extern "C"' block */
4803 #endif
4804 #endif

UCC git Repository :: git.ucc.asn.au