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