modifications for Windoze
authorVolker Birk <vb@pep-project.org>
Thu, 26 Mar 2015 15:30:21 +0100
changeset 130507895068f83
parent 129 c680ad2bf2f6
child 131 05b08196271c
modifications for Windoze
pEpEngine.vcxproj
pEpEngine.vcxproj.filters
src/etpan_mime.c
src/keymanagement.c
src/message_api.c
src/mime.c
src/pEp_internal.h
src/pgp_gpg.c
src/platform.h
src/platform_unix.h
src/platform_windows.cpp
src/platform_windows.h
src/sqlite3.c
src/sqlite3.h
src/wrappers.h
     1.1 --- a/pEpEngine.vcxproj	Wed Mar 25 15:35:08 2015 +0100
     1.2 +++ b/pEpEngine.vcxproj	Thu Mar 26 15:30:21 2015 +0100
     1.3 @@ -41,8 +41,9 @@
     1.4    <PropertyGroup Label="UserMacros" />
     1.5    <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
     1.6      <LinkIncremental>true</LinkIncremental>
     1.7 -    <IncludePath>C:\Program Files %28x86%29\GNU\GnuPG\include;$(IncludePath)</IncludePath>
     1.8 +    <IncludePath>C:\Users\vb\Documents\Visual Studio 2013\Projects\libetpan\build-windows\include;C:\Program Files %28x86%29\GNU\GnuPG\include;$(IncludePath)</IncludePath>
     1.9      <RunCodeAnalysis>false</RunCodeAnalysis>
    1.10 +    <LibraryPath>C:\Users\vb\Documents\Visual Studio 2013\Projects\libetpan\build-windows\Debug;$(LibraryPath)</LibraryPath>
    1.11    </PropertyGroup>
    1.12    <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
    1.13      <LinkIncremental>false</LinkIncremental>
    1.14 @@ -60,6 +61,7 @@
    1.15      <Link>
    1.16        <SubSystem>Windows</SubSystem>
    1.17        <GenerateDebugInformation>true</GenerateDebugInformation>
    1.18 +      <AdditionalDependencies>%(AdditionalDependencies)</AdditionalDependencies>
    1.19      </Link>
    1.20    </ItemDefinitionGroup>
    1.21    <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
    1.22 @@ -115,6 +117,7 @@
    1.23      <ClInclude Include="src\pEp_internal.h" />
    1.24      <ClInclude Include="src\pgp_gpg.h" />
    1.25      <ClInclude Include="src\pgp_gpg_internal.h" />
    1.26 +    <ClInclude Include="src\platform.h" />
    1.27      <ClInclude Include="src\platform_windows.h" />
    1.28      <ClInclude Include="src\resource.h" />
    1.29      <ClInclude Include="src\sqlite3.h" />
    1.30 @@ -128,6 +131,11 @@
    1.31    <ItemGroup>
    1.32      <Text Include="LICENSE.txt" />
    1.33    </ItemGroup>
    1.34 +  <ItemGroup>
    1.35 +    <ProjectReference Include="..\libetpan\build-windows\libetpan\libetpan.vcxproj">
    1.36 +      <Project>{ba4ded3c-e56f-4484-bfc3-9c13e461a1be}</Project>
    1.37 +    </ProjectReference>
    1.38 +  </ItemGroup>
    1.39    <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
    1.40    <ImportGroup Label="ExtensionTargets">
    1.41    </ImportGroup>
     2.1 --- a/pEpEngine.vcxproj.filters	Wed Mar 25 15:35:08 2015 +0100
     2.2 +++ b/pEpEngine.vcxproj.filters	Thu Mar 26 15:30:21 2015 +0100
     2.3 @@ -140,6 +140,9 @@
     2.4      <ClInclude Include="src\mime.h">
     2.5        <Filter>Headerdateien</Filter>
     2.6      </ClInclude>
     2.7 +    <ClInclude Include="src\platform.h">
     2.8 +      <Filter>Headerdateien</Filter>
     2.9 +    </ClInclude>
    2.10    </ItemGroup>
    2.11    <ItemGroup>
    2.12      <Text Include="LICENSE.txt" />
     3.1 --- a/src/etpan_mime.c	Wed Mar 25 15:35:08 2015 +0100
     3.2 +++ b/src/etpan_mime.c	Thu Mar 26 15:30:21 2015 +0100
     3.3 @@ -1,15 +1,15 @@
     3.4 -#include <string.h>
     3.5 -#include <stdlib.h>
     3.6 -#ifndef WIN32
     3.7 -#include <unistd.h>
     3.8 -#endif
     3.9 -#include <assert.h>
    3.10 -
    3.11  #include "etpan_mime.h"
    3.12  #ifndef mailmime_param_new_with_data
    3.13  #include <libetpan/mailprivacy_tools.h>
    3.14  #endif
    3.15  
    3.16 +#include "platform.h"
    3.17 +
    3.18 +#include <string.h>
    3.19 +#include <stdlib.h>
    3.20 +#include <assert.h>
    3.21 +
    3.22 +
    3.23  time_t mail_mkgmtime(struct tm * tmp);
    3.24  
    3.25  #define MAX_MESSAGE_ID 512
    3.26 @@ -21,7 +21,6 @@
    3.27      long value2;
    3.28      long value3;
    3.29      long value4;
    3.30 -    int r;
    3.31   
    3.32      // no random needed here
    3.33  
    3.34 @@ -448,8 +447,9 @@
    3.35      result->dt_day = ts->tm_mday;
    3.36      result->dt_month = ts->tm_mon + 1;
    3.37      result->dt_year = ts->tm_year + 1900;
    3.38 +#ifndef WIN32
    3.39      result->dt_zone = (int) (ts->tm_gmtoff / 36L);
    3.40 -
    3.41 +#endif
    3.42      return result;
    3.43  }
    3.44  
    3.45 @@ -468,8 +468,9 @@
    3.46      result->tm_mday = et->dt_day;
    3.47      result->tm_mon = et->dt_month - 1;
    3.48      result->tm_year = et->dt_year - 1900;
    3.49 +#ifndef WIN32
    3.50      result->tm_gmtoff = 36L * (long) et->dt_zone;
    3.51 -
    3.52 +#endif
    3.53      return result;
    3.54  }
    3.55  
     4.1 --- a/src/keymanagement.c	Wed Mar 25 15:35:08 2015 +0100
     4.2 +++ b/src/keymanagement.c	Thu Mar 26 15:30:21 2015 +0100
     4.3 @@ -1,8 +1,4 @@
     4.4 -#ifndef WIN32 // POSIX
     4.5 -#define _POSIX_C_SOURCE 200809L
     4.6 -#else
     4.7 -#include "platform_windows.h"
     4.8 -#endif
     4.9 +#include "platform.h"
    4.10  
    4.11  #include <string.h>
    4.12  #include <stdio.h>
     5.1 --- a/src/message_api.c	Wed Mar 25 15:35:08 2015 +0100
     5.2 +++ b/src/message_api.c	Thu Mar 26 15:30:21 2015 +0100
     5.3 @@ -1,12 +1,7 @@
     5.4  #include "pEp_internal.h"
     5.5  #include "message_api.h"
     5.6  
     5.7 -#ifndef WIN32 // POSIX
     5.8 -#define _POSIX_C_SOURCE 200809L
     5.9 -#include <strings.h>
    5.10 -#else
    5.11 -#include "platform_windows.h"
    5.12 -#endif
    5.13 +#include "platform.h"
    5.14  
    5.15  #include <assert.h>
    5.16  #include <string.h>
     6.1 --- a/src/mime.c	Wed Mar 25 15:35:08 2015 +0100
     6.2 +++ b/src/mime.c	Thu Mar 26 15:30:21 2015 +0100
     6.3 @@ -5,9 +5,7 @@
     6.4  #include <stdlib.h>
     6.5  #include <assert.h>
     6.6  #include <errno.h>
     6.7 -#ifndef WIN32
     6.8 -#include <unistd.h>
     6.9 -#endif
    6.10 +
    6.11  #include "etpan_mime.h"
    6.12  #include "wrappers.h"
    6.13  
     7.1 --- a/src/pEp_internal.h	Wed Mar 25 15:35:08 2015 +0100
     7.2 +++ b/src/pEp_internal.h	Thu Mar 26 15:30:21 2015 +0100
     7.3 @@ -15,15 +15,15 @@
     7.4  // default keyserver
     7.5  #define DEFAULT_KEYSERVER "hkp://keys.gnupg.net"
     7.6  
     7.7 +#include "platform.h"
     7.8 +
     7.9  #ifdef WIN32
    7.10 -#include "platform_windows.h"
    7.11  #define LOCAL_DB windoze_local_db()
    7.12  #define SYSTEM_DB windoze_system_db()
    7.13  #define LIBGPGME "libgpgme-11.dll"
    7.14  #else // UNIX
    7.15  #define _POSIX_C_SOURCE 200809L
    7.16  #include <dlfcn.h>
    7.17 -#include "platform_unix.h"
    7.18  #define LOCAL_DB unix_local_db()
    7.19  #ifndef SYSTEM_DB
    7.20  #define SYSTEM_DB "/usr/share/pEp/system.db"
     8.1 --- a/src/pgp_gpg.c	Wed Mar 25 15:35:08 2015 +0100
     8.2 +++ b/src/pgp_gpg.c	Thu Mar 26 15:30:21 2015 +0100
     8.3 @@ -1,5 +1,5 @@
     8.4 +#include "pEp_internal.h"
     8.5  #include "pgp_gpg.h"
     8.6 -#include "pEp_internal.h"
     8.7  
     8.8  #include <limits.h>
     8.9  
     9.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     9.2 +++ b/src/platform.h	Thu Mar 26 15:30:21 2015 +0100
     9.3 @@ -0,0 +1,15 @@
     9.4 +#pragma once
     9.5 +
     9.6 +#ifdef __cplusplus
     9.7 +extern "C" {
     9.8 +#endif
     9.9 +
    9.10 +#ifdef WIN32
    9.11 +#include "platform_windows.h"
    9.12 +#else
    9.13 +#include "platform_unix.h"
    9.14 +#endif
    9.15 +
    9.16 +#ifdef __cplusplus
    9.17 +}
    9.18 +#endif
    10.1 --- a/src/platform_unix.h	Wed Mar 25 15:35:08 2015 +0100
    10.2 +++ b/src/platform_unix.h	Thu Mar 26 15:30:21 2015 +0100
    10.3 @@ -1,2 +1,16 @@
    10.4 +#define _POSIX_C_SOURCE 200809L
    10.5 +
    10.6 +#include <unistd.h>
    10.7 +#include <strings.h>
    10.8 +#include <sys/select.h>
    10.9 +
   10.10 +#ifdef __cplusplus
   10.11 +extern "C" {
   10.12 +#endif
   10.13 +
   10.14  const char *unix_local_db(void);
   10.15  const char *gpg_conf(void);
   10.16 +
   10.17 +#ifdef __cplusplus
   10.18 +}
   10.19 +#endif
    11.1 --- a/src/platform_windows.cpp	Wed Mar 25 15:35:08 2015 +0100
    11.2 +++ b/src/platform_windows.cpp	Thu Mar 26 15:30:21 2015 +0100
    11.3 @@ -14,6 +14,8 @@
    11.4  #include <string>
    11.5  #include <stdexcept>
    11.6  #include "platform_windows.h"
    11.7 +#include <fcntl.h>
    11.8 +#include <sys\stat.h>
    11.9  
   11.10  #ifndef WC_ERR_INVALID_CHARS
   11.11  #define WC_ERR_INVALID_CHARS      0x00000080  // error for invalid chars
   11.12 @@ -200,12 +202,12 @@
   11.13          e = rand_s(&r);
   11.14      } while (e);
   11.15  
   11.16 -    return (long) (r & ((1<<31)-1));
   11.17 +    return (long) (r & ((1U<<31)-1));
   11.18  }
   11.19  
   11.20  char *strndup(const char *s1, size_t n)
   11.21  {
   11.22 -    char *str = calloc(n + 1, 1);
   11.23 +    char *str = (char *) calloc(n + 1, 1);
   11.24      if (str == NULL)
   11.25          return NULL;
   11.26  
   11.27 @@ -213,5 +215,12 @@
   11.28      return str;
   11.29  }
   11.30  
   11.31 +int mkstemp(char *templ)
   11.32 +{
   11.33 +    char *pathname = _mktemp(templ);
   11.34 +    if (errno)
   11.35 +        return -1;
   11.36 +    return _open(pathname, _O_RDWR | _O_CREAT | _O_EXCL, _S_IREAD | _S_IWRITE);
   11.37 +}
   11.38 +
   11.39  } // "C"
   11.40 -
    12.1 --- a/src/platform_windows.h	Wed Mar 25 15:35:08 2015 +0100
    12.2 +++ b/src/platform_windows.h	Thu Mar 26 15:30:21 2015 +0100
    12.3 @@ -5,16 +5,19 @@
    12.4  #pragma warning(disable : 4996)
    12.5  
    12.6  #include <string.h>
    12.7 +#include <io.h>
    12.8  
    12.9  #ifdef __cplusplus
   12.10  extern "C" {
   12.11  #endif
   12.12  
   12.13  #define RTLD_LAZY 1
   12.14 +#define mode_t int
   12.15  
   12.16  void *dlopen(const char *filename, int flag);
   12.17  int dlclose(void *handle);
   12.18  void *dlsym(void *handle, const char *symbol);
   12.19 +int mkstemp(char *templ);
   12.20  
   12.21  #ifndef strdup
   12.22  #define strdup(A) _strdup((A))
   12.23 @@ -30,6 +33,12 @@
   12.24  #endif
   12.25  #ifndef gmtime_r
   12.26  #define gmtime_r(A, B) gmtime_s((B), (A))
   12.27 +#endif
   12.28 +#ifndef ftruncate
   12.29 +#define ftruncate(A, B) _chsize((A), (B))
   12.30 +#endif
   12.31 +#ifndef ftello
   12.32 +#define ftello(A) ((off_t) _ftelli64(A))
   12.33  #endif
   12.34  
   12.35  char *strndup(const char *s1, size_t n);
   12.36 @@ -41,7 +50,7 @@
   12.37  long random(void);
   12.38  
   12.39  #ifndef inline
   12.40 -#define inline _inline
   12.41 +#define inline __inline
   12.42  #endif
   12.43  
   12.44  #ifdef __cplusplus
    13.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
    13.2 +++ b/src/sqlite3.c	Thu Mar 26 15:30:21 2015 +0100
    13.3 @@ -0,0 +1,148882 @@
    13.4 +/******************************************************************************
    13.5 +** This file is an amalgamation of many separate C source files from SQLite
    13.6 +** version 3.8.6.  By combining all the individual C code files into this 
    13.7 +** single large file, the entire code can be compiled as a single translation
    13.8 +** unit.  This allows many compilers to do optimizations that would not be
    13.9 +** possible if the files were compiled separately.  Performance improvements
   13.10 +** of 5% or more are commonly seen when SQLite is compiled as a single
   13.11 +** translation unit.
   13.12 +**
   13.13 +** This file is all you need to compile SQLite.  To use SQLite in other
   13.14 +** programs, you need this file and the "sqlite3.h" header file that defines
   13.15 +** the programming interface to the SQLite library.  (If you do not have 
   13.16 +** the "sqlite3.h" header file at hand, you will find a copy embedded within
   13.17 +** the text of this file.  Search for "Begin file sqlite3.h" to find the start
   13.18 +** of the embedded sqlite3.h header file.) Additional code files may be needed
   13.19 +** if you want a wrapper to interface SQLite with your choice of programming
   13.20 +** language. The code for the "sqlite3" command-line shell is also in a
   13.21 +** separate file. This file contains only code for the core SQLite library.
   13.22 +*/
   13.23 +#define SQLITE_CORE 1
   13.24 +#define SQLITE_AMALGAMATION 1
   13.25 +#ifndef SQLITE_PRIVATE
   13.26 +# define SQLITE_PRIVATE static
   13.27 +#endif
   13.28 +#ifndef SQLITE_API
   13.29 +# define SQLITE_API
   13.30 +#endif
   13.31 +/************** Begin file sqliteInt.h ***************************************/
   13.32 +/*
   13.33 +** 2001 September 15
   13.34 +**
   13.35 +** The author disclaims copyright to this source code.  In place of
   13.36 +** a legal notice, here is a blessing:
   13.37 +**
   13.38 +**    May you do good and not evil.
   13.39 +**    May you find forgiveness for yourself and forgive others.
   13.40 +**    May you share freely, never taking more than you give.
   13.41 +**
   13.42 +*************************************************************************
   13.43 +** Internal interface definitions for SQLite.
   13.44 +**
   13.45 +*/
   13.46 +#ifndef _SQLITEINT_H_
   13.47 +#define _SQLITEINT_H_
   13.48 +
   13.49 +/*
   13.50 +** These #defines should enable >2GB file support on POSIX if the
   13.51 +** underlying operating system supports it.  If the OS lacks
   13.52 +** large file support, or if the OS is windows, these should be no-ops.
   13.53 +**
   13.54 +** Ticket #2739:  The _LARGEFILE_SOURCE macro must appear before any
   13.55 +** system #includes.  Hence, this block of code must be the very first
   13.56 +** code in all source files.
   13.57 +**
   13.58 +** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
   13.59 +** on the compiler command line.  This is necessary if you are compiling
   13.60 +** on a recent machine (ex: Red Hat 7.2) but you want your code to work
   13.61 +** on an older machine (ex: Red Hat 6.0).  If you compile on Red Hat 7.2
   13.62 +** without this option, LFS is enable.  But LFS does not exist in the kernel
   13.63 +** in Red Hat 6.0, so the code won't work.  Hence, for maximum binary
   13.64 +** portability you should omit LFS.
   13.65 +**
   13.66 +** The previous paragraph was written in 2005.  (This paragraph is written
   13.67 +** on 2008-11-28.) These days, all Linux kernels support large files, so
   13.68 +** you should probably leave LFS enabled.  But some embedded platforms might
   13.69 +** lack LFS in which case the SQLITE_DISABLE_LFS macro might still be useful.
   13.70 +**
   13.71 +** Similar is true for Mac OS X.  LFS is only supported on Mac OS X 9 and later.
   13.72 +*/
   13.73 +#ifndef SQLITE_DISABLE_LFS
   13.74 +# define _LARGE_FILE       1
   13.75 +# ifndef _FILE_OFFSET_BITS
   13.76 +#   define _FILE_OFFSET_BITS 64
   13.77 +# endif
   13.78 +# define _LARGEFILE_SOURCE 1
   13.79 +#endif
   13.80 +
   13.81 +/*
   13.82 +** For MinGW, check to see if we can include the header file containing its
   13.83 +** version information, among other things.  Normally, this internal MinGW
   13.84 +** header file would [only] be included automatically by other MinGW header
   13.85 +** files; however, the contained version information is now required by this
   13.86 +** header file to work around binary compatibility issues (see below) and
   13.87 +** this is the only known way to reliably obtain it.  This entire #if block
   13.88 +** would be completely unnecessary if there was any other way of detecting
   13.89 +** MinGW via their preprocessor (e.g. if they customized their GCC to define
   13.90 +** some MinGW-specific macros).  When compiling for MinGW, either the
   13.91 +** _HAVE_MINGW_H or _HAVE__MINGW_H (note the extra underscore) macro must be
   13.92 +** defined; otherwise, detection of conditions specific to MinGW will be
   13.93 +** disabled.
   13.94 +*/
   13.95 +#if defined(_HAVE_MINGW_H)
   13.96 +# include "mingw.h"
   13.97 +#elif defined(_HAVE__MINGW_H)
   13.98 +# include "_mingw.h"
   13.99 +#endif
  13.100 +
  13.101 +/*
  13.102 +** For MinGW version 4.x (and higher), check to see if the _USE_32BIT_TIME_T
  13.103 +** define is required to maintain binary compatibility with the MSVC runtime
  13.104 +** library in use (e.g. for Windows XP).
  13.105 +*/
  13.106 +#if !defined(_USE_32BIT_TIME_T) && !defined(_USE_64BIT_TIME_T) && \
  13.107 +    defined(_WIN32) && !defined(_WIN64) && \
  13.108 +    defined(__MINGW_MAJOR_VERSION) && __MINGW_MAJOR_VERSION >= 4 && \
  13.109 +    defined(__MSVCRT__)
  13.110 +# define _USE_32BIT_TIME_T
  13.111 +#endif
  13.112 +
  13.113 +/* The public SQLite interface.  The _FILE_OFFSET_BITS macro must appear
  13.114 +** first in QNX.  Also, the _USE_32BIT_TIME_T macro must appear first for
  13.115 +** MinGW.
  13.116 +*/
  13.117 +/************** Include sqlite3.h in the middle of sqliteInt.h ***************/
  13.118 +/************** Begin file sqlite3.h *****************************************/
  13.119 +/*
  13.120 +** 2001 September 15
  13.121 +**
  13.122 +** The author disclaims copyright to this source code.  In place of
  13.123 +** a legal notice, here is a blessing:
  13.124 +**
  13.125 +**    May you do good and not evil.
  13.126 +**    May you find forgiveness for yourself and forgive others.
  13.127 +**    May you share freely, never taking more than you give.
  13.128 +**
  13.129 +*************************************************************************
  13.130 +** This header file defines the interface that the SQLite library
  13.131 +** presents to client programs.  If a C-function, structure, datatype,
  13.132 +** or constant definition does not appear in this file, then it is
  13.133 +** not a published API of SQLite, is subject to change without
  13.134 +** notice, and should not be referenced by programs that use SQLite.
  13.135 +**
  13.136 +** Some of the definitions that are in this file are marked as
  13.137 +** "experimental".  Experimental interfaces are normally new
  13.138 +** features recently added to SQLite.  We do not anticipate changes
  13.139 +** to experimental interfaces but reserve the right to make minor changes
  13.140 +** if experience from use "in the wild" suggest such changes are prudent.
  13.141 +**
  13.142 +** The official C-language API documentation for SQLite is derived
  13.143 +** from comments in this file.  This file is the authoritative source
  13.144 +** on how SQLite interfaces are suppose to operate.
  13.145 +**
  13.146 +** The name of this file under configuration management is "sqlite.h.in".
  13.147 +** The makefile makes some minor changes to this file (such as inserting
  13.148 +** the version number) and changes its name to "sqlite3.h" as
  13.149 +** part of the build process.
  13.150 +*/
  13.151 +#ifndef _SQLITE3_H_
  13.152 +#define _SQLITE3_H_
  13.153 +#include <stdarg.h>     /* Needed for the definition of va_list */
  13.154 +
  13.155 +/*
  13.156 +** Make sure we can call this stuff from C++.
  13.157 +*/
  13.158 +#if 0
  13.159 +extern "C" {
  13.160 +#endif
  13.161 +
  13.162 +
  13.163 +/*
  13.164 +** Add the ability to override 'extern'
  13.165 +*/
  13.166 +#ifndef SQLITE_EXTERN
  13.167 +# define SQLITE_EXTERN extern
  13.168 +#endif
  13.169 +
  13.170 +#ifndef SQLITE_API
  13.171 +# define SQLITE_API
  13.172 +#endif
  13.173 +
  13.174 +
  13.175 +/*
  13.176 +** These no-op macros are used in front of interfaces to mark those
  13.177 +** interfaces as either deprecated or experimental.  New applications
  13.178 +** should not use deprecated interfaces - they are support for backwards
  13.179 +** compatibility only.  Application writers should be aware that
  13.180 +** experimental interfaces are subject to change in point releases.
  13.181 +**
  13.182 +** These macros used to resolve to various kinds of compiler magic that
  13.183 +** would generate warning messages when they were used.  But that
  13.184 +** compiler magic ended up generating such a flurry of bug reports
  13.185 +** that we have taken it all out and gone back to using simple
  13.186 +** noop macros.
  13.187 +*/
  13.188 +#define SQLITE_DEPRECATED
  13.189 +#define SQLITE_EXPERIMENTAL
  13.190 +
  13.191 +/*
  13.192 +** Ensure these symbols were not defined by some previous header file.
  13.193 +*/
  13.194 +#ifdef SQLITE_VERSION
  13.195 +# undef SQLITE_VERSION
  13.196 +#endif
  13.197 +#ifdef SQLITE_VERSION_NUMBER
  13.198 +# undef SQLITE_VERSION_NUMBER
  13.199 +#endif
  13.200 +
  13.201 +/*
  13.202 +** CAPI3REF: Compile-Time Library Version Numbers
  13.203 +**
  13.204 +** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header
  13.205 +** evaluates to a string literal that is the SQLite version in the
  13.206 +** format "X.Y.Z" where X is the major version number (always 3 for
  13.207 +** SQLite3) and Y is the minor version number and Z is the release number.)^
  13.208 +** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer
  13.209 +** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z are the same
  13.210 +** numbers used in [SQLITE_VERSION].)^
  13.211 +** The SQLITE_VERSION_NUMBER for any given release of SQLite will also
  13.212 +** be larger than the release from which it is derived.  Either Y will
  13.213 +** be held constant and Z will be incremented or else Y will be incremented
  13.214 +** and Z will be reset to zero.
  13.215 +**
  13.216 +** Since version 3.6.18, SQLite source code has been stored in the
  13.217 +** <a href="http://www.fossil-scm.org/">Fossil configuration management
  13.218 +** system</a>.  ^The SQLITE_SOURCE_ID macro evaluates to
  13.219 +** a string which identifies a particular check-in of SQLite
  13.220 +** within its configuration management system.  ^The SQLITE_SOURCE_ID
  13.221 +** string contains the date and time of the check-in (UTC) and an SHA1
  13.222 +** hash of the entire source tree.
  13.223 +**
  13.224 +** See also: [sqlite3_libversion()],
  13.225 +** [sqlite3_libversion_number()], [sqlite3_sourceid()],
  13.226 +** [sqlite_version()] and [sqlite_source_id()].
  13.227 +*/
  13.228 +#define SQLITE_VERSION        "3.8.6"
  13.229 +#define SQLITE_VERSION_NUMBER 3008006
  13.230 +#define SQLITE_SOURCE_ID      "2014-08-15 11:46:33 9491ba7d738528f168657adb43a198238abde19e"
  13.231 +
  13.232 +/*
  13.233 +** CAPI3REF: Run-Time Library Version Numbers
  13.234 +** KEYWORDS: sqlite3_version, sqlite3_sourceid
  13.235 +**
  13.236 +** These interfaces provide the same information as the [SQLITE_VERSION],
  13.237 +** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros
  13.238 +** but are associated with the library instead of the header file.  ^(Cautious
  13.239 +** programmers might include assert() statements in their application to
  13.240 +** verify that values returned by these interfaces match the macros in
  13.241 +** the header, and thus insure that the application is
  13.242 +** compiled with matching library and header files.
  13.243 +**
  13.244 +** <blockquote><pre>
  13.245 +** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER );
  13.246 +** assert( strcmp(sqlite3_sourceid(),SQLITE_SOURCE_ID)==0 );
  13.247 +** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 );
  13.248 +** </pre></blockquote>)^
  13.249 +**
  13.250 +** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION]
  13.251 +** macro.  ^The sqlite3_libversion() function returns a pointer to the
  13.252 +** to the sqlite3_version[] string constant.  The sqlite3_libversion()
  13.253 +** function is provided for use in DLLs since DLL users usually do not have
  13.254 +** direct access to string constants within the DLL.  ^The
  13.255 +** sqlite3_libversion_number() function returns an integer equal to
  13.256 +** [SQLITE_VERSION_NUMBER].  ^The sqlite3_sourceid() function returns 
  13.257 +** a pointer to a string constant whose value is the same as the 
  13.258 +** [SQLITE_SOURCE_ID] C preprocessor macro.
  13.259 +**
  13.260 +** See also: [sqlite_version()] and [sqlite_source_id()].
  13.261 +*/
  13.262 +SQLITE_API const char sqlite3_version[] = SQLITE_VERSION;
  13.263 +SQLITE_API const char *sqlite3_libversion(void);
  13.264 +SQLITE_API const char *sqlite3_sourceid(void);
  13.265 +SQLITE_API int sqlite3_libversion_number(void);
  13.266 +
  13.267 +/*
  13.268 +** CAPI3REF: Run-Time Library Compilation Options Diagnostics
  13.269 +**
  13.270 +** ^The sqlite3_compileoption_used() function returns 0 or 1 
  13.271 +** indicating whether the specified option was defined at 
  13.272 +** compile time.  ^The SQLITE_ prefix may be omitted from the 
  13.273 +** option name passed to sqlite3_compileoption_used().  
  13.274 +**
  13.275 +** ^The sqlite3_compileoption_get() function allows iterating
  13.276 +** over the list of options that were defined at compile time by
  13.277 +** returning the N-th compile time option string.  ^If N is out of range,
  13.278 +** sqlite3_compileoption_get() returns a NULL pointer.  ^The SQLITE_ 
  13.279 +** prefix is omitted from any strings returned by 
  13.280 +** sqlite3_compileoption_get().
  13.281 +**
  13.282 +** ^Support for the diagnostic functions sqlite3_compileoption_used()
  13.283 +** and sqlite3_compileoption_get() may be omitted by specifying the 
  13.284 +** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time.
  13.285 +**
  13.286 +** See also: SQL functions [sqlite_compileoption_used()] and
  13.287 +** [sqlite_compileoption_get()] and the [compile_options pragma].
  13.288 +*/
  13.289 +#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
  13.290 +SQLITE_API int sqlite3_compileoption_used(const char *zOptName);
  13.291 +SQLITE_API const char *sqlite3_compileoption_get(int N);
  13.292 +#endif
  13.293 +
  13.294 +/*
  13.295 +** CAPI3REF: Test To See If The Library Is Threadsafe
  13.296 +**
  13.297 +** ^The sqlite3_threadsafe() function returns zero if and only if
  13.298 +** SQLite was compiled with mutexing code omitted due to the
  13.299 +** [SQLITE_THREADSAFE] compile-time option being set to 0.
  13.300 +**
  13.301 +** SQLite can be compiled with or without mutexes.  When
  13.302 +** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes
  13.303 +** are enabled and SQLite is threadsafe.  When the
  13.304 +** [SQLITE_THREADSAFE] macro is 0, 
  13.305 +** the mutexes are omitted.  Without the mutexes, it is not safe
  13.306 +** to use SQLite concurrently from more than one thread.
  13.307 +**
  13.308 +** Enabling mutexes incurs a measurable performance penalty.
  13.309 +** So if speed is of utmost importance, it makes sense to disable
  13.310 +** the mutexes.  But for maximum safety, mutexes should be enabled.
  13.311 +** ^The default behavior is for mutexes to be enabled.
  13.312 +**
  13.313 +** This interface can be used by an application to make sure that the
  13.314 +** version of SQLite that it is linking against was compiled with
  13.315 +** the desired setting of the [SQLITE_THREADSAFE] macro.
  13.316 +**
  13.317 +** This interface only reports on the compile-time mutex setting
  13.318 +** of the [SQLITE_THREADSAFE] flag.  If SQLite is compiled with
  13.319 +** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but
  13.320 +** can be fully or partially disabled using a call to [sqlite3_config()]
  13.321 +** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD],
  13.322 +** or [SQLITE_CONFIG_MUTEX].  ^(The return value of the
  13.323 +** sqlite3_threadsafe() function shows only the compile-time setting of
  13.324 +** thread safety, not any run-time changes to that setting made by
  13.325 +** sqlite3_config(). In other words, the return value from sqlite3_threadsafe()
  13.326 +** is unchanged by calls to sqlite3_config().)^
  13.327 +**
  13.328 +** See the [threading mode] documentation for additional information.
  13.329 +*/
  13.330 +SQLITE_API int sqlite3_threadsafe(void);
  13.331 +
  13.332 +/*
  13.333 +** CAPI3REF: Database Connection Handle
  13.334 +** KEYWORDS: {database connection} {database connections}
  13.335 +**
  13.336 +** Each open SQLite database is represented by a pointer to an instance of
  13.337 +** the opaque structure named "sqlite3".  It is useful to think of an sqlite3
  13.338 +** pointer as an object.  The [sqlite3_open()], [sqlite3_open16()], and
  13.339 +** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()]
  13.340 +** and [sqlite3_close_v2()] are its destructors.  There are many other
  13.341 +** interfaces (such as
  13.342 +** [sqlite3_prepare_v2()], [sqlite3_create_function()], and
  13.343 +** [sqlite3_busy_timeout()] to name but three) that are methods on an
  13.344 +** sqlite3 object.
  13.345 +*/
  13.346 +typedef struct sqlite3 sqlite3;
  13.347 +
  13.348 +/*
  13.349 +** CAPI3REF: 64-Bit Integer Types
  13.350 +** KEYWORDS: sqlite_int64 sqlite_uint64
  13.351 +**
  13.352 +** Because there is no cross-platform way to specify 64-bit integer types
  13.353 +** SQLite includes typedefs for 64-bit signed and unsigned integers.
  13.354 +**
  13.355 +** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions.
  13.356 +** The sqlite_int64 and sqlite_uint64 types are supported for backwards
  13.357 +** compatibility only.
  13.358 +**
  13.359 +** ^The sqlite3_int64 and sqlite_int64 types can store integer values
  13.360 +** between -9223372036854775808 and +9223372036854775807 inclusive.  ^The
  13.361 +** sqlite3_uint64 and sqlite_uint64 types can store integer values 
  13.362 +** between 0 and +18446744073709551615 inclusive.
  13.363 +*/
  13.364 +#ifdef SQLITE_INT64_TYPE
  13.365 +  typedef SQLITE_INT64_TYPE sqlite_int64;
  13.366 +  typedef unsigned SQLITE_INT64_TYPE sqlite_uint64;
  13.367 +#elif defined(_MSC_VER) || defined(__BORLANDC__)
  13.368 +  typedef __int64 sqlite_int64;
  13.369 +  typedef unsigned __int64 sqlite_uint64;
  13.370 +#else
  13.371 +  typedef long long int sqlite_int64;
  13.372 +  typedef unsigned long long int sqlite_uint64;
  13.373 +#endif
  13.374 +typedef sqlite_int64 sqlite3_int64;
  13.375 +typedef sqlite_uint64 sqlite3_uint64;
  13.376 +
  13.377 +/*
  13.378 +** If compiling for a processor that lacks floating point support,
  13.379 +** substitute integer for floating-point.
  13.380 +*/
  13.381 +#ifdef SQLITE_OMIT_FLOATING_POINT
  13.382 +# define double sqlite3_int64
  13.383 +#endif
  13.384 +
  13.385 +/*
  13.386 +** CAPI3REF: Closing A Database Connection
  13.387 +**
  13.388 +** ^The sqlite3_close() and sqlite3_close_v2() routines are destructors
  13.389 +** for the [sqlite3] object.
  13.390 +** ^Calls to sqlite3_close() and sqlite3_close_v2() return [SQLITE_OK] if
  13.391 +** the [sqlite3] object is successfully destroyed and all associated
  13.392 +** resources are deallocated.
  13.393 +**
  13.394 +** ^If the database connection is associated with unfinalized prepared
  13.395 +** statements or unfinished sqlite3_backup objects then sqlite3_close()
  13.396 +** will leave the database connection open and return [SQLITE_BUSY].
  13.397 +** ^If sqlite3_close_v2() is called with unfinalized prepared statements
  13.398 +** and/or unfinished sqlite3_backups, then the database connection becomes
  13.399 +** an unusable "zombie" which will automatically be deallocated when the
  13.400 +** last prepared statement is finalized or the last sqlite3_backup is
  13.401 +** finished.  The sqlite3_close_v2() interface is intended for use with
  13.402 +** host languages that are garbage collected, and where the order in which
  13.403 +** destructors are called is arbitrary.
  13.404 +**
  13.405 +** Applications should [sqlite3_finalize | finalize] all [prepared statements],
  13.406 +** [sqlite3_blob_close | close] all [BLOB handles], and 
  13.407 +** [sqlite3_backup_finish | finish] all [sqlite3_backup] objects associated
  13.408 +** with the [sqlite3] object prior to attempting to close the object.  ^If
  13.409 +** sqlite3_close_v2() is called on a [database connection] that still has
  13.410 +** outstanding [prepared statements], [BLOB handles], and/or
  13.411 +** [sqlite3_backup] objects then it returns [SQLITE_OK] and the deallocation
  13.412 +** of resources is deferred until all [prepared statements], [BLOB handles],
  13.413 +** and [sqlite3_backup] objects are also destroyed.
  13.414 +**
  13.415 +** ^If an [sqlite3] object is destroyed while a transaction is open,
  13.416 +** the transaction is automatically rolled back.
  13.417 +**
  13.418 +** The C parameter to [sqlite3_close(C)] and [sqlite3_close_v2(C)]
  13.419 +** must be either a NULL
  13.420 +** pointer or an [sqlite3] object pointer obtained
  13.421 +** from [sqlite3_open()], [sqlite3_open16()], or
  13.422 +** [sqlite3_open_v2()], and not previously closed.
  13.423 +** ^Calling sqlite3_close() or sqlite3_close_v2() with a NULL pointer
  13.424 +** argument is a harmless no-op.
  13.425 +*/
  13.426 +SQLITE_API int sqlite3_close(sqlite3*);
  13.427 +SQLITE_API int sqlite3_close_v2(sqlite3*);
  13.428 +
  13.429 +/*
  13.430 +** The type for a callback function.
  13.431 +** This is legacy and deprecated.  It is included for historical
  13.432 +** compatibility and is not documented.
  13.433 +*/
  13.434 +typedef int (*sqlite3_callback)(void*,int,char**, char**);
  13.435 +
  13.436 +/*
  13.437 +** CAPI3REF: One-Step Query Execution Interface
  13.438 +**
  13.439 +** The sqlite3_exec() interface is a convenience wrapper around
  13.440 +** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()],
  13.441 +** that allows an application to run multiple statements of SQL
  13.442 +** without having to use a lot of C code. 
  13.443 +**
  13.444 +** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded,
  13.445 +** semicolon-separate SQL statements passed into its 2nd argument,
  13.446 +** in the context of the [database connection] passed in as its 1st
  13.447 +** argument.  ^If the callback function of the 3rd argument to
  13.448 +** sqlite3_exec() is not NULL, then it is invoked for each result row
  13.449 +** coming out of the evaluated SQL statements.  ^The 4th argument to
  13.450 +** sqlite3_exec() is relayed through to the 1st argument of each
  13.451 +** callback invocation.  ^If the callback pointer to sqlite3_exec()
  13.452 +** is NULL, then no callback is ever invoked and result rows are
  13.453 +** ignored.
  13.454 +**
  13.455 +** ^If an error occurs while evaluating the SQL statements passed into
  13.456 +** sqlite3_exec(), then execution of the current statement stops and
  13.457 +** subsequent statements are skipped.  ^If the 5th parameter to sqlite3_exec()
  13.458 +** is not NULL then any error message is written into memory obtained
  13.459 +** from [sqlite3_malloc()] and passed back through the 5th parameter.
  13.460 +** To avoid memory leaks, the application should invoke [sqlite3_free()]
  13.461 +** on error message strings returned through the 5th parameter of
  13.462 +** of sqlite3_exec() after the error message string is no longer needed.
  13.463 +** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors
  13.464 +** occur, then sqlite3_exec() sets the pointer in its 5th parameter to
  13.465 +** NULL before returning.
  13.466 +**
  13.467 +** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec()
  13.468 +** routine returns SQLITE_ABORT without invoking the callback again and
  13.469 +** without running any subsequent SQL statements.
  13.470 +**
  13.471 +** ^The 2nd argument to the sqlite3_exec() callback function is the
  13.472 +** number of columns in the result.  ^The 3rd argument to the sqlite3_exec()
  13.473 +** callback is an array of pointers to strings obtained as if from
  13.474 +** [sqlite3_column_text()], one for each column.  ^If an element of a
  13.475 +** result row is NULL then the corresponding string pointer for the
  13.476 +** sqlite3_exec() callback is a NULL pointer.  ^The 4th argument to the
  13.477 +** sqlite3_exec() callback is an array of pointers to strings where each
  13.478 +** entry represents the name of corresponding result column as obtained
  13.479 +** from [sqlite3_column_name()].
  13.480 +**
  13.481 +** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer
  13.482 +** to an empty string, or a pointer that contains only whitespace and/or 
  13.483 +** SQL comments, then no SQL statements are evaluated and the database
  13.484 +** is not changed.
  13.485 +**
  13.486 +** Restrictions:
  13.487 +**
  13.488 +** <ul>
  13.489 +** <li> The application must insure that the 1st parameter to sqlite3_exec()
  13.490 +**      is a valid and open [database connection].
  13.491 +** <li> The application must not close the [database connection] specified by
  13.492 +**      the 1st parameter to sqlite3_exec() while sqlite3_exec() is running.
  13.493 +** <li> The application must not modify the SQL statement text passed into
  13.494 +**      the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running.
  13.495 +** </ul>
  13.496 +*/
  13.497 +SQLITE_API int sqlite3_exec(
  13.498 +  sqlite3*,                                  /* An open database */
  13.499 +  const char *sql,                           /* SQL to be evaluated */
  13.500 +  int (*callback)(void*,int,char**,char**),  /* Callback function */
  13.501 +  void *,                                    /* 1st argument to callback */
  13.502 +  char **errmsg                              /* Error msg written here */
  13.503 +);
  13.504 +
  13.505 +/*
  13.506 +** CAPI3REF: Result Codes
  13.507 +** KEYWORDS: {result code definitions}
  13.508 +**
  13.509 +** Many SQLite functions return an integer result code from the set shown
  13.510 +** here in order to indicate success or failure.
  13.511 +**
  13.512 +** New error codes may be added in future versions of SQLite.
  13.513 +**
  13.514 +** See also: [extended result code definitions]
  13.515 +*/
  13.516 +#define SQLITE_OK           0   /* Successful result */
  13.517 +/* beginning-of-error-codes */
  13.518 +#define SQLITE_ERROR        1   /* SQL error or missing database */
  13.519 +#define SQLITE_INTERNAL     2   /* Internal logic error in SQLite */
  13.520 +#define SQLITE_PERM         3   /* Access permission denied */
  13.521 +#define SQLITE_ABORT        4   /* Callback routine requested an abort */
  13.522 +#define SQLITE_BUSY         5   /* The database file is locked */
  13.523 +#define SQLITE_LOCKED       6   /* A table in the database is locked */
  13.524 +#define SQLITE_NOMEM        7   /* A malloc() failed */
  13.525 +#define SQLITE_READONLY     8   /* Attempt to write a readonly database */
  13.526 +#define SQLITE_INTERRUPT    9   /* Operation terminated by sqlite3_interrupt()*/
  13.527 +#define SQLITE_IOERR       10   /* Some kind of disk I/O error occurred */
  13.528 +#define SQLITE_CORRUPT     11   /* The database disk image is malformed */
  13.529 +#define SQLITE_NOTFOUND    12   /* Unknown opcode in sqlite3_file_control() */
  13.530 +#define SQLITE_FULL        13   /* Insertion failed because database is full */
  13.531 +#define SQLITE_CANTOPEN    14   /* Unable to open the database file */
  13.532 +#define SQLITE_PROTOCOL    15   /* Database lock protocol error */
  13.533 +#define SQLITE_EMPTY       16   /* Database is empty */
  13.534 +#define SQLITE_SCHEMA      17   /* The database schema changed */
  13.535 +#define SQLITE_TOOBIG      18   /* String or BLOB exceeds size limit */
  13.536 +#define SQLITE_CONSTRAINT  19   /* Abort due to constraint violation */
  13.537 +#define SQLITE_MISMATCH    20   /* Data type mismatch */
  13.538 +#define SQLITE_MISUSE      21   /* Library used incorrectly */
  13.539 +#define SQLITE_NOLFS       22   /* Uses OS features not supported on host */
  13.540 +#define SQLITE_AUTH        23   /* Authorization denied */
  13.541 +#define SQLITE_FORMAT      24   /* Auxiliary database format error */
  13.542 +#define SQLITE_RANGE       25   /* 2nd parameter to sqlite3_bind out of range */
  13.543 +#define SQLITE_NOTADB      26   /* File opened that is not a database file */
  13.544 +#define SQLITE_NOTICE      27   /* Notifications from sqlite3_log() */
  13.545 +#define SQLITE_WARNING     28   /* Warnings from sqlite3_log() */
  13.546 +#define SQLITE_ROW         100  /* sqlite3_step() has another row ready */
  13.547 +#define SQLITE_DONE        101  /* sqlite3_step() has finished executing */
  13.548 +/* end-of-error-codes */
  13.549 +
  13.550 +/*
  13.551 +** CAPI3REF: Extended Result Codes
  13.552 +** KEYWORDS: {extended result code definitions}
  13.553 +**
  13.554 +** In its default configuration, SQLite API routines return one of 30 integer
  13.555 +** [result codes].  However, experience has shown that many of
  13.556 +** these result codes are too coarse-grained.  They do not provide as
  13.557 +** much information about problems as programmers might like.  In an effort to
  13.558 +** address this, newer versions of SQLite (version 3.3.8 and later) include
  13.559 +** support for additional result codes that provide more detailed information
  13.560 +** about errors. These [extended result codes] are enabled or disabled
  13.561 +** on a per database connection basis using the
  13.562 +** [sqlite3_extended_result_codes()] API.  Or, the extended code for
  13.563 +** the most recent error can be obtained using
  13.564 +** [sqlite3_extended_errcode()].
  13.565 +*/
  13.566 +#define SQLITE_IOERR_READ              (SQLITE_IOERR | (1<<8))
  13.567 +#define SQLITE_IOERR_SHORT_READ        (SQLITE_IOERR | (2<<8))
  13.568 +#define SQLITE_IOERR_WRITE             (SQLITE_IOERR | (3<<8))
  13.569 +#define SQLITE_IOERR_FSYNC             (SQLITE_IOERR | (4<<8))
  13.570 +#define SQLITE_IOERR_DIR_FSYNC         (SQLITE_IOERR | (5<<8))
  13.571 +#define SQLITE_IOERR_TRUNCATE          (SQLITE_IOERR | (6<<8))
  13.572 +#define SQLITE_IOERR_FSTAT             (SQLITE_IOERR | (7<<8))
  13.573 +#define SQLITE_IOERR_UNLOCK            (SQLITE_IOERR | (8<<8))
  13.574 +#define SQLITE_IOERR_RDLOCK            (SQLITE_IOERR | (9<<8))
  13.575 +#define SQLITE_IOERR_DELETE            (SQLITE_IOERR | (10<<8))
  13.576 +#define SQLITE_IOERR_BLOCKED           (SQLITE_IOERR | (11<<8))
  13.577 +#define SQLITE_IOERR_NOMEM             (SQLITE_IOERR | (12<<8))
  13.578 +#define SQLITE_IOERR_ACCESS            (SQLITE_IOERR | (13<<8))
  13.579 +#define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8))
  13.580 +#define SQLITE_IOERR_LOCK              (SQLITE_IOERR | (15<<8))
  13.581 +#define SQLITE_IOERR_CLOSE             (SQLITE_IOERR | (16<<8))
  13.582 +#define SQLITE_IOERR_DIR_CLOSE         (SQLITE_IOERR | (17<<8))
  13.583 +#define SQLITE_IOERR_SHMOPEN           (SQLITE_IOERR | (18<<8))
  13.584 +#define SQLITE_IOERR_SHMSIZE           (SQLITE_IOERR | (19<<8))
  13.585 +#define SQLITE_IOERR_SHMLOCK           (SQLITE_IOERR | (20<<8))
  13.586 +#define SQLITE_IOERR_SHMMAP            (SQLITE_IOERR | (21<<8))
  13.587 +#define SQLITE_IOERR_SEEK              (SQLITE_IOERR | (22<<8))
  13.588 +#define SQLITE_IOERR_DELETE_NOENT      (SQLITE_IOERR | (23<<8))
  13.589 +#define SQLITE_IOERR_MMAP              (SQLITE_IOERR | (24<<8))
  13.590 +#define SQLITE_IOERR_GETTEMPPATH       (SQLITE_IOERR | (25<<8))
  13.591 +#define SQLITE_IOERR_CONVPATH          (SQLITE_IOERR | (26<<8))
  13.592 +#define SQLITE_LOCKED_SHAREDCACHE      (SQLITE_LOCKED |  (1<<8))
  13.593 +#define SQLITE_BUSY_RECOVERY           (SQLITE_BUSY   |  (1<<8))
  13.594 +#define SQLITE_BUSY_SNAPSHOT           (SQLITE_BUSY   |  (2<<8))
  13.595 +#define SQLITE_CANTOPEN_NOTEMPDIR      (SQLITE_CANTOPEN | (1<<8))
  13.596 +#define SQLITE_CANTOPEN_ISDIR          (SQLITE_CANTOPEN | (2<<8))
  13.597 +#define SQLITE_CANTOPEN_FULLPATH       (SQLITE_CANTOPEN | (3<<8))
  13.598 +#define SQLITE_CANTOPEN_CONVPATH       (SQLITE_CANTOPEN | (4<<8))
  13.599 +#define SQLITE_CORRUPT_VTAB            (SQLITE_CORRUPT | (1<<8))
  13.600 +#define SQLITE_READONLY_RECOVERY       (SQLITE_READONLY | (1<<8))
  13.601 +#define SQLITE_READONLY_CANTLOCK       (SQLITE_READONLY | (2<<8))
  13.602 +#define SQLITE_READONLY_ROLLBACK       (SQLITE_READONLY | (3<<8))
  13.603 +#define SQLITE_READONLY_DBMOVED        (SQLITE_READONLY | (4<<8))
  13.604 +#define SQLITE_ABORT_ROLLBACK          (SQLITE_ABORT | (2<<8))
  13.605 +#define SQLITE_CONSTRAINT_CHECK        (SQLITE_CONSTRAINT | (1<<8))
  13.606 +#define SQLITE_CONSTRAINT_COMMITHOOK   (SQLITE_CONSTRAINT | (2<<8))
  13.607 +#define SQLITE_CONSTRAINT_FOREIGNKEY   (SQLITE_CONSTRAINT | (3<<8))
  13.608 +#define SQLITE_CONSTRAINT_FUNCTION     (SQLITE_CONSTRAINT | (4<<8))
  13.609 +#define SQLITE_CONSTRAINT_NOTNULL      (SQLITE_CONSTRAINT | (5<<8))
  13.610 +#define SQLITE_CONSTRAINT_PRIMARYKEY   (SQLITE_CONSTRAINT | (6<<8))
  13.611 +#define SQLITE_CONSTRAINT_TRIGGER      (SQLITE_CONSTRAINT | (7<<8))
  13.612 +#define SQLITE_CONSTRAINT_UNIQUE       (SQLITE_CONSTRAINT | (8<<8))
  13.613 +#define SQLITE_CONSTRAINT_VTAB         (SQLITE_CONSTRAINT | (9<<8))
  13.614 +#define SQLITE_CONSTRAINT_ROWID        (SQLITE_CONSTRAINT |(10<<8))
  13.615 +#define SQLITE_NOTICE_RECOVER_WAL      (SQLITE_NOTICE | (1<<8))
  13.616 +#define SQLITE_NOTICE_RECOVER_ROLLBACK (SQLITE_NOTICE | (2<<8))
  13.617 +#define SQLITE_WARNING_AUTOINDEX       (SQLITE_WARNING | (1<<8))
  13.618 +
  13.619 +/*
  13.620 +** CAPI3REF: Flags For File Open Operations
  13.621 +**
  13.622 +** These bit values are intended for use in the
  13.623 +** 3rd parameter to the [sqlite3_open_v2()] interface and
  13.624 +** in the 4th parameter to the [sqlite3_vfs.xOpen] method.
  13.625 +*/
  13.626 +#define SQLITE_OPEN_READONLY         0x00000001  /* Ok for sqlite3_open_v2() */
  13.627 +#define SQLITE_OPEN_READWRITE        0x00000002  /* Ok for sqlite3_open_v2() */
  13.628 +#define SQLITE_OPEN_CREATE           0x00000004  /* Ok for sqlite3_open_v2() */
  13.629 +#define SQLITE_OPEN_DELETEONCLOSE    0x00000008  /* VFS only */
  13.630 +#define SQLITE_OPEN_EXCLUSIVE        0x00000010  /* VFS only */
  13.631 +#define SQLITE_OPEN_AUTOPROXY        0x00000020  /* VFS only */
  13.632 +#define SQLITE_OPEN_URI              0x00000040  /* Ok for sqlite3_open_v2() */
  13.633 +#define SQLITE_OPEN_MEMORY           0x00000080  /* Ok for sqlite3_open_v2() */
  13.634 +#define SQLITE_OPEN_MAIN_DB          0x00000100  /* VFS only */
  13.635 +#define SQLITE_OPEN_TEMP_DB          0x00000200  /* VFS only */
  13.636 +#define SQLITE_OPEN_TRANSIENT_DB     0x00000400  /* VFS only */
  13.637 +#define SQLITE_OPEN_MAIN_JOURNAL     0x00000800  /* VFS only */
  13.638 +#define SQLITE_OPEN_TEMP_JOURNAL     0x00001000  /* VFS only */
  13.639 +#define SQLITE_OPEN_SUBJOURNAL       0x00002000  /* VFS only */
  13.640 +#define SQLITE_OPEN_MASTER_JOURNAL   0x00004000  /* VFS only */
  13.641 +#define SQLITE_OPEN_NOMUTEX          0x00008000  /* Ok for sqlite3_open_v2() */
  13.642 +#define SQLITE_OPEN_FULLMUTEX        0x00010000  /* Ok for sqlite3_open_v2() */
  13.643 +#define SQLITE_OPEN_SHAREDCACHE      0x00020000  /* Ok for sqlite3_open_v2() */
  13.644 +#define SQLITE_OPEN_PRIVATECACHE     0x00040000  /* Ok for sqlite3_open_v2() */
  13.645 +#define SQLITE_OPEN_WAL              0x00080000  /* VFS only */
  13.646 +
  13.647 +/* Reserved:                         0x00F00000 */
  13.648 +
  13.649 +/*
  13.650 +** CAPI3REF: Device Characteristics
  13.651 +**
  13.652 +** The xDeviceCharacteristics method of the [sqlite3_io_methods]
  13.653 +** object returns an integer which is a vector of these
  13.654 +** bit values expressing I/O characteristics of the mass storage
  13.655 +** device that holds the file that the [sqlite3_io_methods]
  13.656 +** refers to.
  13.657 +**
  13.658 +** The SQLITE_IOCAP_ATOMIC property means that all writes of
  13.659 +** any size are atomic.  The SQLITE_IOCAP_ATOMICnnn values
  13.660 +** mean that writes of blocks that are nnn bytes in size and
  13.661 +** are aligned to an address which is an integer multiple of
  13.662 +** nnn are atomic.  The SQLITE_IOCAP_SAFE_APPEND value means
  13.663 +** that when data is appended to a file, the data is appended
  13.664 +** first then the size of the file is extended, never the other
  13.665 +** way around.  The SQLITE_IOCAP_SEQUENTIAL property means that
  13.666 +** information is written to disk in the same order as calls
  13.667 +** to xWrite().  The SQLITE_IOCAP_POWERSAFE_OVERWRITE property means that
  13.668 +** after reboot following a crash or power loss, the only bytes in a
  13.669 +** file that were written at the application level might have changed
  13.670 +** and that adjacent bytes, even bytes within the same sector are
  13.671 +** guaranteed to be unchanged.  The SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN
  13.672 +** flag indicate that a file cannot be deleted when open.  The
  13.673 +** SQLITE_IOCAP_IMMUTABLE flag indicates that the file is on
  13.674 +** read-only media and cannot be changed even by processes with
  13.675 +** elevated privileges.
  13.676 +*/
  13.677 +#define SQLITE_IOCAP_ATOMIC                 0x00000001
  13.678 +#define SQLITE_IOCAP_ATOMIC512              0x00000002
  13.679 +#define SQLITE_IOCAP_ATOMIC1K               0x00000004
  13.680 +#define SQLITE_IOCAP_ATOMIC2K               0x00000008
  13.681 +#define SQLITE_IOCAP_ATOMIC4K               0x00000010
  13.682 +#define SQLITE_IOCAP_ATOMIC8K               0x00000020
  13.683 +#define SQLITE_IOCAP_ATOMIC16K              0x00000040
  13.684 +#define SQLITE_IOCAP_ATOMIC32K              0x00000080
  13.685 +#define SQLITE_IOCAP_ATOMIC64K              0x00000100
  13.686 +#define SQLITE_IOCAP_SAFE_APPEND            0x00000200
  13.687 +#define SQLITE_IOCAP_SEQUENTIAL             0x00000400
  13.688 +#define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN  0x00000800
  13.689 +#define SQLITE_IOCAP_POWERSAFE_OVERWRITE    0x00001000
  13.690 +#define SQLITE_IOCAP_IMMUTABLE              0x00002000
  13.691 +
  13.692 +/*
  13.693 +** CAPI3REF: File Locking Levels
  13.694 +**
  13.695 +** SQLite uses one of these integer values as the second
  13.696 +** argument to calls it makes to the xLock() and xUnlock() methods
  13.697 +** of an [sqlite3_io_methods] object.
  13.698 +*/
  13.699 +#define SQLITE_LOCK_NONE          0
  13.700 +#define SQLITE_LOCK_SHARED        1
  13.701 +#define SQLITE_LOCK_RESERVED      2
  13.702 +#define SQLITE_LOCK_PENDING       3
  13.703 +#define SQLITE_LOCK_EXCLUSIVE     4
  13.704 +
  13.705 +/*
  13.706 +** CAPI3REF: Synchronization Type Flags
  13.707 +**
  13.708 +** When SQLite invokes the xSync() method of an
  13.709 +** [sqlite3_io_methods] object it uses a combination of
  13.710 +** these integer values as the second argument.
  13.711 +**
  13.712 +** When the SQLITE_SYNC_DATAONLY flag is used, it means that the
  13.713 +** sync operation only needs to flush data to mass storage.  Inode
  13.714 +** information need not be flushed. If the lower four bits of the flag
  13.715 +** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics.
  13.716 +** If the lower four bits equal SQLITE_SYNC_FULL, that means
  13.717 +** to use Mac OS X style fullsync instead of fsync().
  13.718 +**
  13.719 +** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags
  13.720 +** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL
  13.721 +** settings.  The [synchronous pragma] determines when calls to the
  13.722 +** xSync VFS method occur and applies uniformly across all platforms.
  13.723 +** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how
  13.724 +** energetic or rigorous or forceful the sync operations are and
  13.725 +** only make a difference on Mac OSX for the default SQLite code.
  13.726 +** (Third-party VFS implementations might also make the distinction
  13.727 +** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the
  13.728 +** operating systems natively supported by SQLite, only Mac OSX
  13.729 +** cares about the difference.)
  13.730 +*/
  13.731 +#define SQLITE_SYNC_NORMAL        0x00002
  13.732 +#define SQLITE_SYNC_FULL          0x00003
  13.733 +#define SQLITE_SYNC_DATAONLY      0x00010
  13.734 +
  13.735 +/*
  13.736 +** CAPI3REF: OS Interface Open File Handle
  13.737 +**
  13.738 +** An [sqlite3_file] object represents an open file in the 
  13.739 +** [sqlite3_vfs | OS interface layer].  Individual OS interface
  13.740 +** implementations will
  13.741 +** want to subclass this object by appending additional fields
  13.742 +** for their own use.  The pMethods entry is a pointer to an
  13.743 +** [sqlite3_io_methods] object that defines methods for performing
  13.744 +** I/O operations on the open file.
  13.745 +*/
  13.746 +typedef struct sqlite3_file sqlite3_file;
  13.747 +struct sqlite3_file {
  13.748 +  const struct sqlite3_io_methods *pMethods;  /* Methods for an open file */
  13.749 +};
  13.750 +
  13.751 +/*
  13.752 +** CAPI3REF: OS Interface File Virtual Methods Object
  13.753 +**
  13.754 +** Every file opened by the [sqlite3_vfs.xOpen] method populates an
  13.755 +** [sqlite3_file] object (or, more commonly, a subclass of the
  13.756 +** [sqlite3_file] object) with a pointer to an instance of this object.
  13.757 +** This object defines the methods used to perform various operations
  13.758 +** against the open file represented by the [sqlite3_file] object.
  13.759 +**
  13.760 +** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element 
  13.761 +** to a non-NULL pointer, then the sqlite3_io_methods.xClose method
  13.762 +** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed.  The
  13.763 +** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen]
  13.764 +** is for the [sqlite3_vfs.xOpen] to set the sqlite3_file.pMethods element
  13.765 +** to NULL.
  13.766 +**
  13.767 +** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or
  13.768 +** [SQLITE_SYNC_FULL].  The first choice is the normal fsync().
  13.769 +** The second choice is a Mac OS X style fullsync.  The [SQLITE_SYNC_DATAONLY]
  13.770 +** flag may be ORed in to indicate that only the data of the file
  13.771 +** and not its inode needs to be synced.
  13.772 +**
  13.773 +** The integer values to xLock() and xUnlock() are one of
  13.774 +** <ul>
  13.775 +** <li> [SQLITE_LOCK_NONE],
  13.776 +** <li> [SQLITE_LOCK_SHARED],
  13.777 +** <li> [SQLITE_LOCK_RESERVED],
  13.778 +** <li> [SQLITE_LOCK_PENDING], or
  13.779 +** <li> [SQLITE_LOCK_EXCLUSIVE].
  13.780 +** </ul>
  13.781 +** xLock() increases the lock. xUnlock() decreases the lock.
  13.782 +** The xCheckReservedLock() method checks whether any database connection,
  13.783 +** either in this process or in some other process, is holding a RESERVED,
  13.784 +** PENDING, or EXCLUSIVE lock on the file.  It returns true
  13.785 +** if such a lock exists and false otherwise.
  13.786 +**
  13.787 +** The xFileControl() method is a generic interface that allows custom
  13.788 +** VFS implementations to directly control an open file using the
  13.789 +** [sqlite3_file_control()] interface.  The second "op" argument is an
  13.790 +** integer opcode.  The third argument is a generic pointer intended to
  13.791 +** point to a structure that may contain arguments or space in which to
  13.792 +** write return values.  Potential uses for xFileControl() might be
  13.793 +** functions to enable blocking locks with timeouts, to change the
  13.794 +** locking strategy (for example to use dot-file locks), to inquire
  13.795 +** about the status of a lock, or to break stale locks.  The SQLite
  13.796 +** core reserves all opcodes less than 100 for its own use.
  13.797 +** A [file control opcodes | list of opcodes] less than 100 is available.
  13.798 +** Applications that define a custom xFileControl method should use opcodes
  13.799 +** greater than 100 to avoid conflicts.  VFS implementations should
  13.800 +** return [SQLITE_NOTFOUND] for file control opcodes that they do not
  13.801 +** recognize.
  13.802 +**
  13.803 +** The xSectorSize() method returns the sector size of the
  13.804 +** device that underlies the file.  The sector size is the
  13.805 +** minimum write that can be performed without disturbing
  13.806 +** other bytes in the file.  The xDeviceCharacteristics()
  13.807 +** method returns a bit vector describing behaviors of the
  13.808 +** underlying device:
  13.809 +**
  13.810 +** <ul>
  13.811 +** <li> [SQLITE_IOCAP_ATOMIC]
  13.812 +** <li> [SQLITE_IOCAP_ATOMIC512]
  13.813 +** <li> [SQLITE_IOCAP_ATOMIC1K]
  13.814 +** <li> [SQLITE_IOCAP_ATOMIC2K]
  13.815 +** <li> [SQLITE_IOCAP_ATOMIC4K]
  13.816 +** <li> [SQLITE_IOCAP_ATOMIC8K]
  13.817 +** <li> [SQLITE_IOCAP_ATOMIC16K]
  13.818 +** <li> [SQLITE_IOCAP_ATOMIC32K]
  13.819 +** <li> [SQLITE_IOCAP_ATOMIC64K]
  13.820 +** <li> [SQLITE_IOCAP_SAFE_APPEND]
  13.821 +** <li> [SQLITE_IOCAP_SEQUENTIAL]
  13.822 +** </ul>
  13.823 +**
  13.824 +** The SQLITE_IOCAP_ATOMIC property means that all writes of
  13.825 +** any size are atomic.  The SQLITE_IOCAP_ATOMICnnn values
  13.826 +** mean that writes of blocks that are nnn bytes in size and
  13.827 +** are aligned to an address which is an integer multiple of
  13.828 +** nnn are atomic.  The SQLITE_IOCAP_SAFE_APPEND value means
  13.829 +** that when data is appended to a file, the data is appended
  13.830 +** first then the size of the file is extended, never the other
  13.831 +** way around.  The SQLITE_IOCAP_SEQUENTIAL property means that
  13.832 +** information is written to disk in the same order as calls
  13.833 +** to xWrite().
  13.834 +**
  13.835 +** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill
  13.836 +** in the unread portions of the buffer with zeros.  A VFS that
  13.837 +** fails to zero-fill short reads might seem to work.  However,
  13.838 +** failure to zero-fill short reads will eventually lead to
  13.839 +** database corruption.
  13.840 +*/
  13.841 +typedef struct sqlite3_io_methods sqlite3_io_methods;
  13.842 +struct sqlite3_io_methods {
  13.843 +  int iVersion;
  13.844 +  int (*xClose)(sqlite3_file*);
  13.845 +  int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst);
  13.846 +  int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst);
  13.847 +  int (*xTruncate)(sqlite3_file*, sqlite3_int64 size);
  13.848 +  int (*xSync)(sqlite3_file*, int flags);
  13.849 +  int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize);
  13.850 +  int (*xLock)(sqlite3_file*, int);
  13.851 +  int (*xUnlock)(sqlite3_file*, int);
  13.852 +  int (*xCheckReservedLock)(sqlite3_file*, int *pResOut);
  13.853 +  int (*xFileControl)(sqlite3_file*, int op, void *pArg);
  13.854 +  int (*xSectorSize)(sqlite3_file*);
  13.855 +  int (*xDeviceCharacteristics)(sqlite3_file*);
  13.856 +  /* Methods above are valid for version 1 */
  13.857 +  int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, void volatile**);
  13.858 +  int (*xShmLock)(sqlite3_file*, int offset, int n, int flags);
  13.859 +  void (*xShmBarrier)(sqlite3_file*);
  13.860 +  int (*xShmUnmap)(sqlite3_file*, int deleteFlag);
  13.861 +  /* Methods above are valid for version 2 */
  13.862 +  int (*xFetch)(sqlite3_file*, sqlite3_int64 iOfst, int iAmt, void **pp);
  13.863 +  int (*xUnfetch)(sqlite3_file*, sqlite3_int64 iOfst, void *p);
  13.864 +  /* Methods above are valid for version 3 */
  13.865 +  /* Additional methods may be added in future releases */
  13.866 +};
  13.867 +
  13.868 +/*
  13.869 +** CAPI3REF: Standard File Control Opcodes
  13.870 +** KEYWORDS: {file control opcodes} {file control opcode}
  13.871 +**
  13.872 +** These integer constants are opcodes for the xFileControl method
  13.873 +** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()]
  13.874 +** interface.
  13.875 +**
  13.876 +** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging.  This
  13.877 +** opcode causes the xFileControl method to write the current state of
  13.878 +** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED],
  13.879 +** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE])
  13.880 +** into an integer that the pArg argument points to. This capability
  13.881 +** is used during testing and only needs to be supported when SQLITE_TEST
  13.882 +** is defined.
  13.883 +** <ul>
  13.884 +** <li>[[SQLITE_FCNTL_SIZE_HINT]]
  13.885 +** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS
  13.886 +** layer a hint of how large the database file will grow to be during the
  13.887 +** current transaction.  This hint is not guaranteed to be accurate but it
  13.888 +** is often close.  The underlying VFS might choose to preallocate database
  13.889 +** file space based on this hint in order to help writes to the database
  13.890 +** file run faster.
  13.891 +**
  13.892 +** <li>[[SQLITE_FCNTL_CHUNK_SIZE]]
  13.893 +** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS
  13.894 +** extends and truncates the database file in chunks of a size specified
  13.895 +** by the user. The fourth argument to [sqlite3_file_control()] should 
  13.896 +** point to an integer (type int) containing the new chunk-size to use
  13.897 +** for the nominated database. Allocating database file space in large
  13.898 +** chunks (say 1MB at a time), may reduce file-system fragmentation and
  13.899 +** improve performance on some systems.
  13.900 +**
  13.901 +** <li>[[SQLITE_FCNTL_FILE_POINTER]]
  13.902 +** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer
  13.903 +** to the [sqlite3_file] object associated with a particular database
  13.904 +** connection.  See the [sqlite3_file_control()] documentation for
  13.905 +** additional information.
  13.906 +**
  13.907 +** <li>[[SQLITE_FCNTL_SYNC_OMITTED]]
  13.908 +** No longer in use.
  13.909 +**
  13.910 +** <li>[[SQLITE_FCNTL_SYNC]]
  13.911 +** The [SQLITE_FCNTL_SYNC] opcode is generated internally by SQLite and
  13.912 +** sent to the VFS immediately before the xSync method is invoked on a
  13.913 +** database file descriptor. Or, if the xSync method is not invoked 
  13.914 +** because the user has configured SQLite with 
  13.915 +** [PRAGMA synchronous | PRAGMA synchronous=OFF] it is invoked in place 
  13.916 +** of the xSync method. In most cases, the pointer argument passed with
  13.917 +** this file-control is NULL. However, if the database file is being synced
  13.918 +** as part of a multi-database commit, the argument points to a nul-terminated
  13.919 +** string containing the transactions master-journal file name. VFSes that 
  13.920 +** do not need this signal should silently ignore this opcode. Applications 
  13.921 +** should not call [sqlite3_file_control()] with this opcode as doing so may 
  13.922 +** disrupt the operation of the specialized VFSes that do require it.  
  13.923 +**
  13.924 +** <li>[[SQLITE_FCNTL_COMMIT_PHASETWO]]
  13.925 +** The [SQLITE_FCNTL_COMMIT_PHASETWO] opcode is generated internally by SQLite
  13.926 +** and sent to the VFS after a transaction has been committed immediately
  13.927 +** but before the database is unlocked. VFSes that do not need this signal
  13.928 +** should silently ignore this opcode. Applications should not call
  13.929 +** [sqlite3_file_control()] with this opcode as doing so may disrupt the 
  13.930 +** operation of the specialized VFSes that do require it.  
  13.931 +**
  13.932 +** <li>[[SQLITE_FCNTL_WIN32_AV_RETRY]]
  13.933 +** ^The [SQLITE_FCNTL_WIN32_AV_RETRY] opcode is used to configure automatic
  13.934 +** retry counts and intervals for certain disk I/O operations for the
  13.935 +** windows [VFS] in order to provide robustness in the presence of
  13.936 +** anti-virus programs.  By default, the windows VFS will retry file read,
  13.937 +** file write, and file delete operations up to 10 times, with a delay
  13.938 +** of 25 milliseconds before the first retry and with the delay increasing
  13.939 +** by an additional 25 milliseconds with each subsequent retry.  This
  13.940 +** opcode allows these two values (10 retries and 25 milliseconds of delay)
  13.941 +** to be adjusted.  The values are changed for all database connections
  13.942 +** within the same process.  The argument is a pointer to an array of two
  13.943 +** integers where the first integer i the new retry count and the second
  13.944 +** integer is the delay.  If either integer is negative, then the setting
  13.945 +** is not changed but instead the prior value of that setting is written
  13.946 +** into the array entry, allowing the current retry settings to be
  13.947 +** interrogated.  The zDbName parameter is ignored.
  13.948 +**
  13.949 +** <li>[[SQLITE_FCNTL_PERSIST_WAL]]
  13.950 +** ^The [SQLITE_FCNTL_PERSIST_WAL] opcode is used to set or query the
  13.951 +** persistent [WAL | Write Ahead Log] setting.  By default, the auxiliary
  13.952 +** write ahead log and shared memory files used for transaction control
  13.953 +** are automatically deleted when the latest connection to the database
  13.954 +** closes.  Setting persistent WAL mode causes those files to persist after
  13.955 +** close.  Persisting the files is useful when other processes that do not
  13.956 +** have write permission on the directory containing the database file want
  13.957 +** to read the database file, as the WAL and shared memory files must exist
  13.958 +** in order for the database to be readable.  The fourth parameter to
  13.959 +** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
  13.960 +** That integer is 0 to disable persistent WAL mode or 1 to enable persistent
  13.961 +** WAL mode.  If the integer is -1, then it is overwritten with the current
  13.962 +** WAL persistence setting.
  13.963 +**
  13.964 +** <li>[[SQLITE_FCNTL_POWERSAFE_OVERWRITE]]
  13.965 +** ^The [SQLITE_FCNTL_POWERSAFE_OVERWRITE] opcode is used to set or query the
  13.966 +** persistent "powersafe-overwrite" or "PSOW" setting.  The PSOW setting
  13.967 +** determines the [SQLITE_IOCAP_POWERSAFE_OVERWRITE] bit of the
  13.968 +** xDeviceCharacteristics methods. The fourth parameter to
  13.969 +** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
  13.970 +** That integer is 0 to disable zero-damage mode or 1 to enable zero-damage
  13.971 +** mode.  If the integer is -1, then it is overwritten with the current
  13.972 +** zero-damage mode setting.
  13.973 +**
  13.974 +** <li>[[SQLITE_FCNTL_OVERWRITE]]
  13.975 +** ^The [SQLITE_FCNTL_OVERWRITE] opcode is invoked by SQLite after opening
  13.976 +** a write transaction to indicate that, unless it is rolled back for some
  13.977 +** reason, the entire database file will be overwritten by the current 
  13.978 +** transaction. This is used by VACUUM operations.
  13.979 +**
  13.980 +** <li>[[SQLITE_FCNTL_VFSNAME]]
  13.981 +** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of
  13.982 +** all [VFSes] in the VFS stack.  The names are of all VFS shims and the
  13.983 +** final bottom-level VFS are written into memory obtained from 
  13.984 +** [sqlite3_malloc()] and the result is stored in the char* variable
  13.985 +** that the fourth parameter of [sqlite3_file_control()] points to.
  13.986 +** The caller is responsible for freeing the memory when done.  As with
  13.987 +** all file-control actions, there is no guarantee that this will actually
  13.988 +** do anything.  Callers should initialize the char* variable to a NULL
  13.989 +** pointer in case this file-control is not implemented.  This file-control
  13.990 +** is intended for diagnostic use only.
  13.991 +**
  13.992 +** <li>[[SQLITE_FCNTL_PRAGMA]]
  13.993 +** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA] 
  13.994 +** file control is sent to the open [sqlite3_file] object corresponding
  13.995 +** to the database file to which the pragma statement refers. ^The argument
  13.996 +** to the [SQLITE_FCNTL_PRAGMA] file control is an array of
  13.997 +** pointers to strings (char**) in which the second element of the array
  13.998 +** is the name of the pragma and the third element is the argument to the
  13.999 +** pragma or NULL if the pragma has no argument.  ^The handler for an
 13.1000 +** [SQLITE_FCNTL_PRAGMA] file control can optionally make the first element
 13.1001 +** of the char** argument point to a string obtained from [sqlite3_mprintf()]
 13.1002 +** or the equivalent and that string will become the result of the pragma or
 13.1003 +** the error message if the pragma fails. ^If the
 13.1004 +** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal 
 13.1005 +** [PRAGMA] processing continues.  ^If the [SQLITE_FCNTL_PRAGMA]
 13.1006 +** file control returns [SQLITE_OK], then the parser assumes that the
 13.1007 +** VFS has handled the PRAGMA itself and the parser generates a no-op
 13.1008 +** prepared statement.  ^If the [SQLITE_FCNTL_PRAGMA] file control returns
 13.1009 +** any result code other than [SQLITE_OK] or [SQLITE_NOTFOUND], that means
 13.1010 +** that the VFS encountered an error while handling the [PRAGMA] and the
 13.1011 +** compilation of the PRAGMA fails with an error.  ^The [SQLITE_FCNTL_PRAGMA]
 13.1012 +** file control occurs at the beginning of pragma statement analysis and so
 13.1013 +** it is able to override built-in [PRAGMA] statements.
 13.1014 +**
 13.1015 +** <li>[[SQLITE_FCNTL_BUSYHANDLER]]
 13.1016 +** ^The [SQLITE_FCNTL_BUSYHANDLER]
 13.1017 +** file-control may be invoked by SQLite on the database file handle
 13.1018 +** shortly after it is opened in order to provide a custom VFS with access
 13.1019 +** to the connections busy-handler callback. The argument is of type (void **)
 13.1020 +** - an array of two (void *) values. The first (void *) actually points
 13.1021 +** to a function of type (int (*)(void *)). In order to invoke the connections
 13.1022 +** busy-handler, this function should be invoked with the second (void *) in
 13.1023 +** the array as the only argument. If it returns non-zero, then the operation
 13.1024 +** should be retried. If it returns zero, the custom VFS should abandon the
 13.1025 +** current operation.
 13.1026 +**
 13.1027 +** <li>[[SQLITE_FCNTL_TEMPFILENAME]]
 13.1028 +** ^Application can invoke the [SQLITE_FCNTL_TEMPFILENAME] file-control
 13.1029 +** to have SQLite generate a
 13.1030 +** temporary filename using the same algorithm that is followed to generate
 13.1031 +** temporary filenames for TEMP tables and other internal uses.  The
 13.1032 +** argument should be a char** which will be filled with the filename
 13.1033 +** written into memory obtained from [sqlite3_malloc()].  The caller should
 13.1034 +** invoke [sqlite3_free()] on the result to avoid a memory leak.
 13.1035 +**
 13.1036 +** <li>[[SQLITE_FCNTL_MMAP_SIZE]]
 13.1037 +** The [SQLITE_FCNTL_MMAP_SIZE] file control is used to query or set the
 13.1038 +** maximum number of bytes that will be used for memory-mapped I/O.
 13.1039 +** The argument is a pointer to a value of type sqlite3_int64 that
 13.1040 +** is an advisory maximum number of bytes in the file to memory map.  The
 13.1041 +** pointer is overwritten with the old value.  The limit is not changed if
 13.1042 +** the value originally pointed to is negative, and so the current limit 
 13.1043 +** can be queried by passing in a pointer to a negative number.  This
 13.1044 +** file-control is used internally to implement [PRAGMA mmap_size].
 13.1045 +**
 13.1046 +** <li>[[SQLITE_FCNTL_TRACE]]
 13.1047 +** The [SQLITE_FCNTL_TRACE] file control provides advisory information
 13.1048 +** to the VFS about what the higher layers of the SQLite stack are doing.
 13.1049 +** This file control is used by some VFS activity tracing [shims].
 13.1050 +** The argument is a zero-terminated string.  Higher layers in the
 13.1051 +** SQLite stack may generate instances of this file control if
 13.1052 +** the [SQLITE_USE_FCNTL_TRACE] compile-time option is enabled.
 13.1053 +**
 13.1054 +** <li>[[SQLITE_FCNTL_HAS_MOVED]]
 13.1055 +** The [SQLITE_FCNTL_HAS_MOVED] file control interprets its argument as a
 13.1056 +** pointer to an integer and it writes a boolean into that integer depending
 13.1057 +** on whether or not the file has been renamed, moved, or deleted since it
 13.1058 +** was first opened.
 13.1059 +**
 13.1060 +** <li>[[SQLITE_FCNTL_WIN32_SET_HANDLE]]
 13.1061 +** The [SQLITE_FCNTL_WIN32_SET_HANDLE] opcode is used for debugging.  This
 13.1062 +** opcode causes the xFileControl method to swap the file handle with the one
 13.1063 +** pointed to by the pArg argument.  This capability is used during testing
 13.1064 +** and only needs to be supported when SQLITE_TEST is defined.
 13.1065 +**
 13.1066 +** </ul>
 13.1067 +*/
 13.1068 +#define SQLITE_FCNTL_LOCKSTATE               1
 13.1069 +#define SQLITE_GET_LOCKPROXYFILE             2
 13.1070 +#define SQLITE_SET_LOCKPROXYFILE             3
 13.1071 +#define SQLITE_LAST_ERRNO                    4
 13.1072 +#define SQLITE_FCNTL_SIZE_HINT               5
 13.1073 +#define SQLITE_FCNTL_CHUNK_SIZE              6
 13.1074 +#define SQLITE_FCNTL_FILE_POINTER            7
 13.1075 +#define SQLITE_FCNTL_SYNC_OMITTED            8
 13.1076 +#define SQLITE_FCNTL_WIN32_AV_RETRY          9
 13.1077 +#define SQLITE_FCNTL_PERSIST_WAL            10
 13.1078 +#define SQLITE_FCNTL_OVERWRITE              11
 13.1079 +#define SQLITE_FCNTL_VFSNAME                12
 13.1080 +#define SQLITE_FCNTL_POWERSAFE_OVERWRITE    13
 13.1081 +#define SQLITE_FCNTL_PRAGMA                 14
 13.1082 +#define SQLITE_FCNTL_BUSYHANDLER            15
 13.1083 +#define SQLITE_FCNTL_TEMPFILENAME           16
 13.1084 +#define SQLITE_FCNTL_MMAP_SIZE              18
 13.1085 +#define SQLITE_FCNTL_TRACE                  19
 13.1086 +#define SQLITE_FCNTL_HAS_MOVED              20
 13.1087 +#define SQLITE_FCNTL_SYNC                   21
 13.1088 +#define SQLITE_FCNTL_COMMIT_PHASETWO        22
 13.1089 +#define SQLITE_FCNTL_WIN32_SET_HANDLE       23
 13.1090 +
 13.1091 +/*
 13.1092 +** CAPI3REF: Mutex Handle
 13.1093 +**
 13.1094 +** The mutex module within SQLite defines [sqlite3_mutex] to be an
 13.1095 +** abstract type for a mutex object.  The SQLite core never looks
 13.1096 +** at the internal representation of an [sqlite3_mutex].  It only
 13.1097 +** deals with pointers to the [sqlite3_mutex] object.
 13.1098 +**
 13.1099 +** Mutexes are created using [sqlite3_mutex_alloc()].
 13.1100 +*/
 13.1101 +typedef struct sqlite3_mutex sqlite3_mutex;
 13.1102 +
 13.1103 +/*
 13.1104 +** CAPI3REF: OS Interface Object
 13.1105 +**
 13.1106 +** An instance of the sqlite3_vfs object defines the interface between
 13.1107 +** the SQLite core and the underlying operating system.  The "vfs"
 13.1108 +** in the name of the object stands for "virtual file system".  See
 13.1109 +** the [VFS | VFS documentation] for further information.
 13.1110 +**
 13.1111 +** The value of the iVersion field is initially 1 but may be larger in
 13.1112 +** future versions of SQLite.  Additional fields may be appended to this
 13.1113 +** object when the iVersion value is increased.  Note that the structure
 13.1114 +** of the sqlite3_vfs object changes in the transaction between
 13.1115 +** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not
 13.1116 +** modified.
 13.1117 +**
 13.1118 +** The szOsFile field is the size of the subclassed [sqlite3_file]
 13.1119 +** structure used by this VFS.  mxPathname is the maximum length of
 13.1120 +** a pathname in this VFS.
 13.1121 +**
 13.1122 +** Registered sqlite3_vfs objects are kept on a linked list formed by
 13.1123 +** the pNext pointer.  The [sqlite3_vfs_register()]
 13.1124 +** and [sqlite3_vfs_unregister()] interfaces manage this list
 13.1125 +** in a thread-safe way.  The [sqlite3_vfs_find()] interface
 13.1126 +** searches the list.  Neither the application code nor the VFS
 13.1127 +** implementation should use the pNext pointer.
 13.1128 +**
 13.1129 +** The pNext field is the only field in the sqlite3_vfs
 13.1130 +** structure that SQLite will ever modify.  SQLite will only access
 13.1131 +** or modify this field while holding a particular static mutex.
 13.1132 +** The application should never modify anything within the sqlite3_vfs
 13.1133 +** object once the object has been registered.
 13.1134 +**
 13.1135 +** The zName field holds the name of the VFS module.  The name must
 13.1136 +** be unique across all VFS modules.
 13.1137 +**
 13.1138 +** [[sqlite3_vfs.xOpen]]
 13.1139 +** ^SQLite guarantees that the zFilename parameter to xOpen
 13.1140 +** is either a NULL pointer or string obtained
 13.1141 +** from xFullPathname() with an optional suffix added.
 13.1142 +** ^If a suffix is added to the zFilename parameter, it will
 13.1143 +** consist of a single "-" character followed by no more than
 13.1144 +** 11 alphanumeric and/or "-" characters.
 13.1145 +** ^SQLite further guarantees that
 13.1146 +** the string will be valid and unchanged until xClose() is
 13.1147 +** called. Because of the previous sentence,
 13.1148 +** the [sqlite3_file] can safely store a pointer to the
 13.1149 +** filename if it needs to remember the filename for some reason.
 13.1150 +** If the zFilename parameter to xOpen is a NULL pointer then xOpen
 13.1151 +** must invent its own temporary name for the file.  ^Whenever the 
 13.1152 +** xFilename parameter is NULL it will also be the case that the
 13.1153 +** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE].
 13.1154 +**
 13.1155 +** The flags argument to xOpen() includes all bits set in
 13.1156 +** the flags argument to [sqlite3_open_v2()].  Or if [sqlite3_open()]
 13.1157 +** or [sqlite3_open16()] is used, then flags includes at least
 13.1158 +** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. 
 13.1159 +** If xOpen() opens a file read-only then it sets *pOutFlags to
 13.1160 +** include [SQLITE_OPEN_READONLY].  Other bits in *pOutFlags may be set.
 13.1161 +**
 13.1162 +** ^(SQLite will also add one of the following flags to the xOpen()
 13.1163 +** call, depending on the object being opened:
 13.1164 +**
 13.1165 +** <ul>
 13.1166 +** <li>  [SQLITE_OPEN_MAIN_DB]
 13.1167 +** <li>  [SQLITE_OPEN_MAIN_JOURNAL]
 13.1168 +** <li>  [SQLITE_OPEN_TEMP_DB]
 13.1169 +** <li>  [SQLITE_OPEN_TEMP_JOURNAL]
 13.1170 +** <li>  [SQLITE_OPEN_TRANSIENT_DB]
 13.1171 +** <li>  [SQLITE_OPEN_SUBJOURNAL]
 13.1172 +** <li>  [SQLITE_OPEN_MASTER_JOURNAL]
 13.1173 +** <li>  [SQLITE_OPEN_WAL]
 13.1174 +** </ul>)^
 13.1175 +**
 13.1176 +** The file I/O implementation can use the object type flags to
 13.1177 +** change the way it deals with files.  For example, an application
 13.1178 +** that does not care about crash recovery or rollback might make
 13.1179 +** the open of a journal file a no-op.  Writes to this journal would
 13.1180 +** also be no-ops, and any attempt to read the journal would return
 13.1181 +** SQLITE_IOERR.  Or the implementation might recognize that a database
 13.1182 +** file will be doing page-aligned sector reads and writes in a random
 13.1183 +** order and set up its I/O subsystem accordingly.
 13.1184 +**
 13.1185 +** SQLite might also add one of the following flags to the xOpen method:
 13.1186 +**
 13.1187 +** <ul>
 13.1188 +** <li> [SQLITE_OPEN_DELETEONCLOSE]
 13.1189 +** <li> [SQLITE_OPEN_EXCLUSIVE]
 13.1190 +** </ul>
 13.1191 +**
 13.1192 +** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be
 13.1193 +** deleted when it is closed.  ^The [SQLITE_OPEN_DELETEONCLOSE]
 13.1194 +** will be set for TEMP databases and their journals, transient
 13.1195 +** databases, and subjournals.
 13.1196 +**
 13.1197 +** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction
 13.1198 +** with the [SQLITE_OPEN_CREATE] flag, which are both directly
 13.1199 +** analogous to the O_EXCL and O_CREAT flags of the POSIX open()
 13.1200 +** API.  The SQLITE_OPEN_EXCLUSIVE flag, when paired with the 
 13.1201 +** SQLITE_OPEN_CREATE, is used to indicate that file should always
 13.1202 +** be created, and that it is an error if it already exists.
 13.1203 +** It is <i>not</i> used to indicate the file should be opened 
 13.1204 +** for exclusive access.
 13.1205 +**
 13.1206 +** ^At least szOsFile bytes of memory are allocated by SQLite
 13.1207 +** to hold the  [sqlite3_file] structure passed as the third
 13.1208 +** argument to xOpen.  The xOpen method does not have to
 13.1209 +** allocate the structure; it should just fill it in.  Note that
 13.1210 +** the xOpen method must set the sqlite3_file.pMethods to either
 13.1211 +** a valid [sqlite3_io_methods] object or to NULL.  xOpen must do
 13.1212 +** this even if the open fails.  SQLite expects that the sqlite3_file.pMethods
 13.1213 +** element will be valid after xOpen returns regardless of the success
 13.1214 +** or failure of the xOpen call.
 13.1215 +**
 13.1216 +** [[sqlite3_vfs.xAccess]]
 13.1217 +** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS]
 13.1218 +** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to
 13.1219 +** test whether a file is readable and writable, or [SQLITE_ACCESS_READ]
 13.1220 +** to test whether a file is at least readable.   The file can be a
 13.1221 +** directory.
 13.1222 +**
 13.1223 +** ^SQLite will always allocate at least mxPathname+1 bytes for the
 13.1224 +** output buffer xFullPathname.  The exact size of the output buffer
 13.1225 +** is also passed as a parameter to both  methods. If the output buffer
 13.1226 +** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is
 13.1227 +** handled as a fatal error by SQLite, vfs implementations should endeavor
 13.1228 +** to prevent this by setting mxPathname to a sufficiently large value.
 13.1229 +**
 13.1230 +** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64()
 13.1231 +** interfaces are not strictly a part of the filesystem, but they are
 13.1232 +** included in the VFS structure for completeness.
 13.1233 +** The xRandomness() function attempts to return nBytes bytes
 13.1234 +** of good-quality randomness into zOut.  The return value is
 13.1235 +** the actual number of bytes of randomness obtained.
 13.1236 +** The xSleep() method causes the calling thread to sleep for at
 13.1237 +** least the number of microseconds given.  ^The xCurrentTime()
 13.1238 +** method returns a Julian Day Number for the current date and time as
 13.1239 +** a floating point value.
 13.1240 +** ^The xCurrentTimeInt64() method returns, as an integer, the Julian
 13.1241 +** Day Number multiplied by 86400000 (the number of milliseconds in 
 13.1242 +** a 24-hour day).  
 13.1243 +** ^SQLite will use the xCurrentTimeInt64() method to get the current
 13.1244 +** date and time if that method is available (if iVersion is 2 or 
 13.1245 +** greater and the function pointer is not NULL) and will fall back
 13.1246 +** to xCurrentTime() if xCurrentTimeInt64() is unavailable.
 13.1247 +**
 13.1248 +** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces
 13.1249 +** are not used by the SQLite core.  These optional interfaces are provided
 13.1250 +** by some VFSes to facilitate testing of the VFS code. By overriding 
 13.1251 +** system calls with functions under its control, a test program can
 13.1252 +** simulate faults and error conditions that would otherwise be difficult
 13.1253 +** or impossible to induce.  The set of system calls that can be overridden
 13.1254 +** varies from one VFS to another, and from one version of the same VFS to the
 13.1255 +** next.  Applications that use these interfaces must be prepared for any
 13.1256 +** or all of these interfaces to be NULL or for their behavior to change
 13.1257 +** from one release to the next.  Applications must not attempt to access
 13.1258 +** any of these methods if the iVersion of the VFS is less than 3.
 13.1259 +*/
 13.1260 +typedef struct sqlite3_vfs sqlite3_vfs;
 13.1261 +typedef void (*sqlite3_syscall_ptr)(void);
 13.1262 +struct sqlite3_vfs {
 13.1263 +  int iVersion;            /* Structure version number (currently 3) */
 13.1264 +  int szOsFile;            /* Size of subclassed sqlite3_file */
 13.1265 +  int mxPathname;          /* Maximum file pathname length */
 13.1266 +  sqlite3_vfs *pNext;      /* Next registered VFS */
 13.1267 +  const char *zName;       /* Name of this virtual file system */
 13.1268 +  void *pAppData;          /* Pointer to application-specific data */
 13.1269 +  int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*,
 13.1270 +               int flags, int *pOutFlags);
 13.1271 +  int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir);
 13.1272 +  int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut);
 13.1273 +  int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut);
 13.1274 +  void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename);
 13.1275 +  void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg);
 13.1276 +  void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void);
 13.1277 +  void (*xDlClose)(sqlite3_vfs*, void*);
 13.1278 +  int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut);
 13.1279 +  int (*xSleep)(sqlite3_vfs*, int microseconds);
 13.1280 +  int (*xCurrentTime)(sqlite3_vfs*, double*);
 13.1281 +  int (*xGetLastError)(sqlite3_vfs*, int, char *);
 13.1282 +  /*
 13.1283 +  ** The methods above are in version 1 of the sqlite_vfs object
 13.1284 +  ** definition.  Those that follow are added in version 2 or later
 13.1285 +  */
 13.1286 +  int (*xCurrentTimeInt64)(sqlite3_vfs*, sqlite3_int64*);
 13.1287 +  /*
 13.1288 +  ** The methods above are in versions 1 and 2 of the sqlite_vfs object.
 13.1289 +  ** Those below are for version 3 and greater.
 13.1290 +  */
 13.1291 +  int (*xSetSystemCall)(sqlite3_vfs*, const char *zName, sqlite3_syscall_ptr);
 13.1292 +  sqlite3_syscall_ptr (*xGetSystemCall)(sqlite3_vfs*, const char *zName);
 13.1293 +  const char *(*xNextSystemCall)(sqlite3_vfs*, const char *zName);
 13.1294 +  /*
 13.1295 +  ** The methods above are in versions 1 through 3 of the sqlite_vfs object.
 13.1296 +  ** New fields may be appended in figure versions.  The iVersion
 13.1297 +  ** value will increment whenever this happens. 
 13.1298 +  */
 13.1299 +};
 13.1300 +
 13.1301 +/*
 13.1302 +** CAPI3REF: Flags for the xAccess VFS method
 13.1303 +**
 13.1304 +** These integer constants can be used as the third parameter to
 13.1305 +** the xAccess method of an [sqlite3_vfs] object.  They determine
 13.1306 +** what kind of permissions the xAccess method is looking for.
 13.1307 +** With SQLITE_ACCESS_EXISTS, the xAccess method
 13.1308 +** simply checks whether the file exists.
 13.1309 +** With SQLITE_ACCESS_READWRITE, the xAccess method
 13.1310 +** checks whether the named directory is both readable and writable
 13.1311 +** (in other words, if files can be added, removed, and renamed within
 13.1312 +** the directory).
 13.1313 +** The SQLITE_ACCESS_READWRITE constant is currently used only by the
 13.1314 +** [temp_store_directory pragma], though this could change in a future
 13.1315 +** release of SQLite.
 13.1316 +** With SQLITE_ACCESS_READ, the xAccess method
 13.1317 +** checks whether the file is readable.  The SQLITE_ACCESS_READ constant is
 13.1318 +** currently unused, though it might be used in a future release of
 13.1319 +** SQLite.
 13.1320 +*/
 13.1321 +#define SQLITE_ACCESS_EXISTS    0
 13.1322 +#define SQLITE_ACCESS_READWRITE 1   /* Used by PRAGMA temp_store_directory */
 13.1323 +#define SQLITE_ACCESS_READ      2   /* Unused */
 13.1324 +
 13.1325 +/*
 13.1326 +** CAPI3REF: Flags for the xShmLock VFS method
 13.1327 +**
 13.1328 +** These integer constants define the various locking operations
 13.1329 +** allowed by the xShmLock method of [sqlite3_io_methods].  The
 13.1330 +** following are the only legal combinations of flags to the
 13.1331 +** xShmLock method:
 13.1332 +**
 13.1333 +** <ul>
 13.1334 +** <li>  SQLITE_SHM_LOCK | SQLITE_SHM_SHARED
 13.1335 +** <li>  SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE
 13.1336 +** <li>  SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED
 13.1337 +** <li>  SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE
 13.1338 +** </ul>
 13.1339 +**
 13.1340 +** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as
 13.1341 +** was given no the corresponding lock.  
 13.1342 +**
 13.1343 +** The xShmLock method can transition between unlocked and SHARED or
 13.1344 +** between unlocked and EXCLUSIVE.  It cannot transition between SHARED
 13.1345 +** and EXCLUSIVE.
 13.1346 +*/
 13.1347 +#define SQLITE_SHM_UNLOCK       1
 13.1348 +#define SQLITE_SHM_LOCK         2
 13.1349 +#define SQLITE_SHM_SHARED       4
 13.1350 +#define SQLITE_SHM_EXCLUSIVE    8
 13.1351 +
 13.1352 +/*
 13.1353 +** CAPI3REF: Maximum xShmLock index
 13.1354 +**
 13.1355 +** The xShmLock method on [sqlite3_io_methods] may use values
 13.1356 +** between 0 and this upper bound as its "offset" argument.
 13.1357 +** The SQLite core will never attempt to acquire or release a
 13.1358 +** lock outside of this range
 13.1359 +*/
 13.1360 +#define SQLITE_SHM_NLOCK        8
 13.1361 +
 13.1362 +
 13.1363 +/*
 13.1364 +** CAPI3REF: Initialize The SQLite Library
 13.1365 +**
 13.1366 +** ^The sqlite3_initialize() routine initializes the
 13.1367 +** SQLite library.  ^The sqlite3_shutdown() routine
 13.1368 +** deallocates any resources that were allocated by sqlite3_initialize().
 13.1369 +** These routines are designed to aid in process initialization and
 13.1370 +** shutdown on embedded systems.  Workstation applications using
 13.1371 +** SQLite normally do not need to invoke either of these routines.
 13.1372 +**
 13.1373 +** A call to sqlite3_initialize() is an "effective" call if it is
 13.1374 +** the first time sqlite3_initialize() is invoked during the lifetime of
 13.1375 +** the process, or if it is the first time sqlite3_initialize() is invoked
 13.1376 +** following a call to sqlite3_shutdown().  ^(Only an effective call
 13.1377 +** of sqlite3_initialize() does any initialization.  All other calls
 13.1378 +** are harmless no-ops.)^
 13.1379 +**
 13.1380 +** A call to sqlite3_shutdown() is an "effective" call if it is the first
 13.1381 +** call to sqlite3_shutdown() since the last sqlite3_initialize().  ^(Only
 13.1382 +** an effective call to sqlite3_shutdown() does any deinitialization.
 13.1383 +** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^
 13.1384 +**
 13.1385 +** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown()
 13.1386 +** is not.  The sqlite3_shutdown() interface must only be called from a
 13.1387 +** single thread.  All open [database connections] must be closed and all
 13.1388 +** other SQLite resources must be deallocated prior to invoking
 13.1389 +** sqlite3_shutdown().
 13.1390 +**
 13.1391 +** Among other things, ^sqlite3_initialize() will invoke
 13.1392 +** sqlite3_os_init().  Similarly, ^sqlite3_shutdown()
 13.1393 +** will invoke sqlite3_os_end().
 13.1394 +**
 13.1395 +** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success.
 13.1396 +** ^If for some reason, sqlite3_initialize() is unable to initialize
 13.1397 +** the library (perhaps it is unable to allocate a needed resource such
 13.1398 +** as a mutex) it returns an [error code] other than [SQLITE_OK].
 13.1399 +**
 13.1400 +** ^The sqlite3_initialize() routine is called internally by many other
 13.1401 +** SQLite interfaces so that an application usually does not need to
 13.1402 +** invoke sqlite3_initialize() directly.  For example, [sqlite3_open()]
 13.1403 +** calls sqlite3_initialize() so the SQLite library will be automatically
 13.1404 +** initialized when [sqlite3_open()] is called if it has not be initialized
 13.1405 +** already.  ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT]
 13.1406 +** compile-time option, then the automatic calls to sqlite3_initialize()
 13.1407 +** are omitted and the application must call sqlite3_initialize() directly
 13.1408 +** prior to using any other SQLite interface.  For maximum portability,
 13.1409 +** it is recommended that applications always invoke sqlite3_initialize()
 13.1410 +** directly prior to using any other SQLite interface.  Future releases
 13.1411 +** of SQLite may require this.  In other words, the behavior exhibited
 13.1412 +** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the
 13.1413 +** default behavior in some future release of SQLite.
 13.1414 +**
 13.1415 +** The sqlite3_os_init() routine does operating-system specific
 13.1416 +** initialization of the SQLite library.  The sqlite3_os_end()
 13.1417 +** routine undoes the effect of sqlite3_os_init().  Typical tasks
 13.1418 +** performed by these routines include allocation or deallocation
 13.1419 +** of static resources, initialization of global variables,
 13.1420 +** setting up a default [sqlite3_vfs] module, or setting up
 13.1421 +** a default configuration using [sqlite3_config()].
 13.1422 +**
 13.1423 +** The application should never invoke either sqlite3_os_init()
 13.1424 +** or sqlite3_os_end() directly.  The application should only invoke
 13.1425 +** sqlite3_initialize() and sqlite3_shutdown().  The sqlite3_os_init()
 13.1426 +** interface is called automatically by sqlite3_initialize() and
 13.1427 +** sqlite3_os_end() is called by sqlite3_shutdown().  Appropriate
 13.1428 +** implementations for sqlite3_os_init() and sqlite3_os_end()
 13.1429 +** are built into SQLite when it is compiled for Unix, Windows, or OS/2.
 13.1430 +** When [custom builds | built for other platforms]
 13.1431 +** (using the [SQLITE_OS_OTHER=1] compile-time
 13.1432 +** option) the application must supply a suitable implementation for
 13.1433 +** sqlite3_os_init() and sqlite3_os_end().  An application-supplied
 13.1434 +** implementation of sqlite3_os_init() or sqlite3_os_end()
 13.1435 +** must return [SQLITE_OK] on success and some other [error code] upon
 13.1436 +** failure.
 13.1437 +*/
 13.1438 +SQLITE_API int sqlite3_initialize(void);
 13.1439 +SQLITE_API int sqlite3_shutdown(void);
 13.1440 +SQLITE_API int sqlite3_os_init(void);
 13.1441 +SQLITE_API int sqlite3_os_end(void);
 13.1442 +
 13.1443 +/*
 13.1444 +** CAPI3REF: Configuring The SQLite Library
 13.1445 +**
 13.1446 +** The sqlite3_config() interface is used to make global configuration
 13.1447 +** changes to SQLite in order to tune SQLite to the specific needs of
 13.1448 +** the application.  The default configuration is recommended for most
 13.1449 +** applications and so this routine is usually not necessary.  It is
 13.1450 +** provided to support rare applications with unusual needs.
 13.1451 +**
 13.1452 +** The sqlite3_config() interface is not threadsafe.  The application
 13.1453 +** must insure that no other SQLite interfaces are invoked by other
 13.1454 +** threads while sqlite3_config() is running.  Furthermore, sqlite3_config()
 13.1455 +** may only be invoked prior to library initialization using
 13.1456 +** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()].
 13.1457 +** ^If sqlite3_config() is called after [sqlite3_initialize()] and before
 13.1458 +** [sqlite3_shutdown()] then it will return SQLITE_MISUSE.
 13.1459 +** Note, however, that ^sqlite3_config() can be called as part of the
 13.1460 +** implementation of an application-defined [sqlite3_os_init()].
 13.1461 +**
 13.1462 +** The first argument to sqlite3_config() is an integer
 13.1463 +** [configuration option] that determines
 13.1464 +** what property of SQLite is to be configured.  Subsequent arguments
 13.1465 +** vary depending on the [configuration option]
 13.1466 +** in the first argument.
 13.1467 +**
 13.1468 +** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK].
 13.1469 +** ^If the option is unknown or SQLite is unable to set the option
 13.1470 +** then this routine returns a non-zero [error code].
 13.1471 +*/
 13.1472 +SQLITE_API int sqlite3_config(int, ...);
 13.1473 +
 13.1474 +/*
 13.1475 +** CAPI3REF: Configure database connections
 13.1476 +**
 13.1477 +** The sqlite3_db_config() interface is used to make configuration
 13.1478 +** changes to a [database connection].  The interface is similar to
 13.1479 +** [sqlite3_config()] except that the changes apply to a single
 13.1480 +** [database connection] (specified in the first argument).
 13.1481 +**
 13.1482 +** The second argument to sqlite3_db_config(D,V,...)  is the
 13.1483 +** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code 
 13.1484 +** that indicates what aspect of the [database connection] is being configured.
 13.1485 +** Subsequent arguments vary depending on the configuration verb.
 13.1486 +**
 13.1487 +** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if
 13.1488 +** the call is considered successful.
 13.1489 +*/
 13.1490 +SQLITE_API int sqlite3_db_config(sqlite3*, int op, ...);
 13.1491 +
 13.1492 +/*
 13.1493 +** CAPI3REF: Memory Allocation Routines
 13.1494 +**
 13.1495 +** An instance of this object defines the interface between SQLite
 13.1496 +** and low-level memory allocation routines.
 13.1497 +**
 13.1498 +** This object is used in only one place in the SQLite interface.
 13.1499 +** A pointer to an instance of this object is the argument to
 13.1500 +** [sqlite3_config()] when the configuration option is
 13.1501 +** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC].  
 13.1502 +** By creating an instance of this object
 13.1503 +** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC])
 13.1504 +** during configuration, an application can specify an alternative
 13.1505 +** memory allocation subsystem for SQLite to use for all of its
 13.1506 +** dynamic memory needs.
 13.1507 +**
 13.1508 +** Note that SQLite comes with several [built-in memory allocators]
 13.1509 +** that are perfectly adequate for the overwhelming majority of applications
 13.1510 +** and that this object is only useful to a tiny minority of applications
 13.1511 +** with specialized memory allocation requirements.  This object is
 13.1512 +** also used during testing of SQLite in order to specify an alternative
 13.1513 +** memory allocator that simulates memory out-of-memory conditions in
 13.1514 +** order to verify that SQLite recovers gracefully from such
 13.1515 +** conditions.
 13.1516 +**
 13.1517 +** The xMalloc, xRealloc, and xFree methods must work like the
 13.1518 +** malloc(), realloc() and free() functions from the standard C library.
 13.1519 +** ^SQLite guarantees that the second argument to
 13.1520 +** xRealloc is always a value returned by a prior call to xRoundup.
 13.1521 +**
 13.1522 +** xSize should return the allocated size of a memory allocation
 13.1523 +** previously obtained from xMalloc or xRealloc.  The allocated size
 13.1524 +** is always at least as big as the requested size but may be larger.
 13.1525 +**
 13.1526 +** The xRoundup method returns what would be the allocated size of
 13.1527 +** a memory allocation given a particular requested size.  Most memory
 13.1528 +** allocators round up memory allocations at least to the next multiple
 13.1529 +** of 8.  Some allocators round up to a larger multiple or to a power of 2.
 13.1530 +** Every memory allocation request coming in through [sqlite3_malloc()]
 13.1531 +** or [sqlite3_realloc()] first calls xRoundup.  If xRoundup returns 0, 
 13.1532 +** that causes the corresponding memory allocation to fail.
 13.1533 +**
 13.1534 +** The xInit method initializes the memory allocator.  For example,
 13.1535 +** it might allocate any require mutexes or initialize internal data
 13.1536 +** structures.  The xShutdown method is invoked (indirectly) by
 13.1537 +** [sqlite3_shutdown()] and should deallocate any resources acquired
 13.1538 +** by xInit.  The pAppData pointer is used as the only parameter to
 13.1539 +** xInit and xShutdown.
 13.1540 +**
 13.1541 +** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes
 13.1542 +** the xInit method, so the xInit method need not be threadsafe.  The
 13.1543 +** xShutdown method is only called from [sqlite3_shutdown()] so it does
 13.1544 +** not need to be threadsafe either.  For all other methods, SQLite
 13.1545 +** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the
 13.1546 +** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which
 13.1547 +** it is by default) and so the methods are automatically serialized.
 13.1548 +** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other
 13.1549 +** methods must be threadsafe or else make their own arrangements for
 13.1550 +** serialization.
 13.1551 +**
 13.1552 +** SQLite will never invoke xInit() more than once without an intervening
 13.1553 +** call to xShutdown().
 13.1554 +*/
 13.1555 +typedef struct sqlite3_mem_methods sqlite3_mem_methods;
 13.1556 +struct sqlite3_mem_methods {
 13.1557 +  void *(*xMalloc)(int);         /* Memory allocation function */
 13.1558 +  void (*xFree)(void*);          /* Free a prior allocation */
 13.1559 +  void *(*xRealloc)(void*,int);  /* Resize an allocation */
 13.1560 +  int (*xSize)(void*);           /* Return the size of an allocation */
 13.1561 +  int (*xRoundup)(int);          /* Round up request size to allocation size */
 13.1562 +  int (*xInit)(void*);           /* Initialize the memory allocator */
 13.1563 +  void (*xShutdown)(void*);      /* Deinitialize the memory allocator */
 13.1564 +  void *pAppData;                /* Argument to xInit() and xShutdown() */
 13.1565 +};
 13.1566 +
 13.1567 +/*
 13.1568 +** CAPI3REF: Configuration Options
 13.1569 +** KEYWORDS: {configuration option}
 13.1570 +**
 13.1571 +** These constants are the available integer configuration options that
 13.1572 +** can be passed as the first argument to the [sqlite3_config()] interface.
 13.1573 +**
 13.1574 +** New configuration options may be added in future releases of SQLite.
 13.1575 +** Existing configuration options might be discontinued.  Applications
 13.1576 +** should check the return code from [sqlite3_config()] to make sure that
 13.1577 +** the call worked.  The [sqlite3_config()] interface will return a
 13.1578 +** non-zero [error code] if a discontinued or unsupported configuration option
 13.1579 +** is invoked.
 13.1580 +**
 13.1581 +** <dl>
 13.1582 +** [[SQLITE_CONFIG_SINGLETHREAD]] <dt>SQLITE_CONFIG_SINGLETHREAD</dt>
 13.1583 +** <dd>There are no arguments to this option.  ^This option sets the
 13.1584 +** [threading mode] to Single-thread.  In other words, it disables
 13.1585 +** all mutexing and puts SQLite into a mode where it can only be used
 13.1586 +** by a single thread.   ^If SQLite is compiled with
 13.1587 +** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
 13.1588 +** it is not possible to change the [threading mode] from its default
 13.1589 +** value of Single-thread and so [sqlite3_config()] will return 
 13.1590 +** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD
 13.1591 +** configuration option.</dd>
 13.1592 +**
 13.1593 +** [[SQLITE_CONFIG_MULTITHREAD]] <dt>SQLITE_CONFIG_MULTITHREAD</dt>
 13.1594 +** <dd>There are no arguments to this option.  ^This option sets the
 13.1595 +** [threading mode] to Multi-thread.  In other words, it disables
 13.1596 +** mutexing on [database connection] and [prepared statement] objects.
 13.1597 +** The application is responsible for serializing access to
 13.1598 +** [database connections] and [prepared statements].  But other mutexes
 13.1599 +** are enabled so that SQLite will be safe to use in a multi-threaded
 13.1600 +** environment as long as no two threads attempt to use the same
 13.1601 +** [database connection] at the same time.  ^If SQLite is compiled with
 13.1602 +** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
 13.1603 +** it is not possible to set the Multi-thread [threading mode] and
 13.1604 +** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
 13.1605 +** SQLITE_CONFIG_MULTITHREAD configuration option.</dd>
 13.1606 +**
 13.1607 +** [[SQLITE_CONFIG_SERIALIZED]] <dt>SQLITE_CONFIG_SERIALIZED</dt>
 13.1608 +** <dd>There are no arguments to this option.  ^This option sets the
 13.1609 +** [threading mode] to Serialized. In other words, this option enables
 13.1610 +** all mutexes including the recursive
 13.1611 +** mutexes on [database connection] and [prepared statement] objects.
 13.1612 +** In this mode (which is the default when SQLite is compiled with
 13.1613 +** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access
 13.1614 +** to [database connections] and [prepared statements] so that the
 13.1615 +** application is free to use the same [database connection] or the
 13.1616 +** same [prepared statement] in different threads at the same time.
 13.1617 +** ^If SQLite is compiled with
 13.1618 +** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
 13.1619 +** it is not possible to set the Serialized [threading mode] and
 13.1620 +** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
 13.1621 +** SQLITE_CONFIG_SERIALIZED configuration option.</dd>
 13.1622 +**
 13.1623 +** [[SQLITE_CONFIG_MALLOC]] <dt>SQLITE_CONFIG_MALLOC</dt>
 13.1624 +** <dd> ^(This option takes a single argument which is a pointer to an
 13.1625 +** instance of the [sqlite3_mem_methods] structure.  The argument specifies
 13.1626 +** alternative low-level memory allocation routines to be used in place of
 13.1627 +** the memory allocation routines built into SQLite.)^ ^SQLite makes
 13.1628 +** its own private copy of the content of the [sqlite3_mem_methods] structure
 13.1629 +** before the [sqlite3_config()] call returns.</dd>
 13.1630 +**
 13.1631 +** [[SQLITE_CONFIG_GETMALLOC]] <dt>SQLITE_CONFIG_GETMALLOC</dt>
 13.1632 +** <dd> ^(This option takes a single argument which is a pointer to an
 13.1633 +** instance of the [sqlite3_mem_methods] structure.  The [sqlite3_mem_methods]
 13.1634 +** structure is filled with the currently defined memory allocation routines.)^
 13.1635 +** This option can be used to overload the default memory allocation
 13.1636 +** routines with a wrapper that simulations memory allocation failure or
 13.1637 +** tracks memory usage, for example. </dd>
 13.1638 +**
 13.1639 +** [[SQLITE_CONFIG_MEMSTATUS]] <dt>SQLITE_CONFIG_MEMSTATUS</dt>
 13.1640 +** <dd> ^This option takes single argument of type int, interpreted as a 
 13.1641 +** boolean, which enables or disables the collection of memory allocation 
 13.1642 +** statistics. ^(When memory allocation statistics are disabled, the 
 13.1643 +** following SQLite interfaces become non-operational:
 13.1644 +**   <ul>
 13.1645 +**   <li> [sqlite3_memory_used()]
 13.1646 +**   <li> [sqlite3_memory_highwater()]
 13.1647 +**   <li> [sqlite3_soft_heap_limit64()]
 13.1648 +**   <li> [sqlite3_status()]
 13.1649 +**   </ul>)^
 13.1650 +** ^Memory allocation statistics are enabled by default unless SQLite is
 13.1651 +** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory
 13.1652 +** allocation statistics are disabled by default.
 13.1653 +** </dd>
 13.1654 +**
 13.1655 +** [[SQLITE_CONFIG_SCRATCH]] <dt>SQLITE_CONFIG_SCRATCH</dt>
 13.1656 +** <dd> ^This option specifies a static memory buffer that SQLite can use for
 13.1657 +** scratch memory.  There are three arguments:  A pointer an 8-byte
 13.1658 +** aligned memory buffer from which the scratch allocations will be
 13.1659 +** drawn, the size of each scratch allocation (sz),
 13.1660 +** and the maximum number of scratch allocations (N).  The sz
 13.1661 +** argument must be a multiple of 16.
 13.1662 +** The first argument must be a pointer to an 8-byte aligned buffer
 13.1663 +** of at least sz*N bytes of memory.
 13.1664 +** ^SQLite will use no more than two scratch buffers per thread.  So
 13.1665 +** N should be set to twice the expected maximum number of threads.
 13.1666 +** ^SQLite will never require a scratch buffer that is more than 6
 13.1667 +** times the database page size. ^If SQLite needs needs additional
 13.1668 +** scratch memory beyond what is provided by this configuration option, then 
 13.1669 +** [sqlite3_malloc()] will be used to obtain the memory needed.</dd>
 13.1670 +**
 13.1671 +** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt>
 13.1672 +** <dd> ^This option specifies a static memory buffer that SQLite can use for
 13.1673 +** the database page cache with the default page cache implementation.  
 13.1674 +** This configuration should not be used if an application-define page
 13.1675 +** cache implementation is loaded using the SQLITE_CONFIG_PCACHE2 option.
 13.1676 +** There are three arguments to this option: A pointer to 8-byte aligned
 13.1677 +** memory, the size of each page buffer (sz), and the number of pages (N).
 13.1678 +** The sz argument should be the size of the largest database page
 13.1679 +** (a power of two between 512 and 32768) plus a little extra for each
 13.1680 +** page header.  ^The page header size is 20 to 40 bytes depending on
 13.1681 +** the host architecture.  ^It is harmless, apart from the wasted memory,
 13.1682 +** to make sz a little too large.  The first
 13.1683 +** argument should point to an allocation of at least sz*N bytes of memory.
 13.1684 +** ^SQLite will use the memory provided by the first argument to satisfy its
 13.1685 +** memory needs for the first N pages that it adds to cache.  ^If additional
 13.1686 +** page cache memory is needed beyond what is provided by this option, then
 13.1687 +** SQLite goes to [sqlite3_malloc()] for the additional storage space.
 13.1688 +** The pointer in the first argument must
 13.1689 +** be aligned to an 8-byte boundary or subsequent behavior of SQLite
 13.1690 +** will be undefined.</dd>
 13.1691 +**
 13.1692 +** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt>
 13.1693 +** <dd> ^This option specifies a static memory buffer that SQLite will use
 13.1694 +** for all of its dynamic memory allocation needs beyond those provided
 13.1695 +** for by [SQLITE_CONFIG_SCRATCH] and [SQLITE_CONFIG_PAGECACHE].
 13.1696 +** There are three arguments: An 8-byte aligned pointer to the memory,
 13.1697 +** the number of bytes in the memory buffer, and the minimum allocation size.
 13.1698 +** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts
 13.1699 +** to using its default memory allocator (the system malloc() implementation),
 13.1700 +** undoing any prior invocation of [SQLITE_CONFIG_MALLOC].  ^If the
 13.1701 +** memory pointer is not NULL and either [SQLITE_ENABLE_MEMSYS3] or
 13.1702 +** [SQLITE_ENABLE_MEMSYS5] are defined, then the alternative memory
 13.1703 +** allocator is engaged to handle all of SQLites memory allocation needs.
 13.1704 +** The first pointer (the memory pointer) must be aligned to an 8-byte
 13.1705 +** boundary or subsequent behavior of SQLite will be undefined.
 13.1706 +** The minimum allocation size is capped at 2**12. Reasonable values
 13.1707 +** for the minimum allocation size are 2**5 through 2**8.</dd>
 13.1708 +**
 13.1709 +** [[SQLITE_CONFIG_MUTEX]] <dt>SQLITE_CONFIG_MUTEX</dt>
 13.1710 +** <dd> ^(This option takes a single argument which is a pointer to an
 13.1711 +** instance of the [sqlite3_mutex_methods] structure.  The argument specifies
 13.1712 +** alternative low-level mutex routines to be used in place
 13.1713 +** the mutex routines built into SQLite.)^  ^SQLite makes a copy of the
 13.1714 +** content of the [sqlite3_mutex_methods] structure before the call to
 13.1715 +** [sqlite3_config()] returns. ^If SQLite is compiled with
 13.1716 +** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
 13.1717 +** the entire mutexing subsystem is omitted from the build and hence calls to
 13.1718 +** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will
 13.1719 +** return [SQLITE_ERROR].</dd>
 13.1720 +**
 13.1721 +** [[SQLITE_CONFIG_GETMUTEX]] <dt>SQLITE_CONFIG_GETMUTEX</dt>
 13.1722 +** <dd> ^(This option takes a single argument which is a pointer to an
 13.1723 +** instance of the [sqlite3_mutex_methods] structure.  The
 13.1724 +** [sqlite3_mutex_methods]
 13.1725 +** structure is filled with the currently defined mutex routines.)^
 13.1726 +** This option can be used to overload the default mutex allocation
 13.1727 +** routines with a wrapper used to track mutex usage for performance
 13.1728 +** profiling or testing, for example.   ^If SQLite is compiled with
 13.1729 +** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
 13.1730 +** the entire mutexing subsystem is omitted from the build and hence calls to
 13.1731 +** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will
 13.1732 +** return [SQLITE_ERROR].</dd>
 13.1733 +**
 13.1734 +** [[SQLITE_CONFIG_LOOKASIDE]] <dt>SQLITE_CONFIG_LOOKASIDE</dt>
 13.1735 +** <dd> ^(This option takes two arguments that determine the default
 13.1736 +** memory allocation for the lookaside memory allocator on each
 13.1737 +** [database connection].  The first argument is the
 13.1738 +** size of each lookaside buffer slot and the second is the number of
 13.1739 +** slots allocated to each database connection.)^  ^(This option sets the
 13.1740 +** <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE]
 13.1741 +** verb to [sqlite3_db_config()] can be used to change the lookaside
 13.1742 +** configuration on individual connections.)^ </dd>
 13.1743 +**
 13.1744 +** [[SQLITE_CONFIG_PCACHE2]] <dt>SQLITE_CONFIG_PCACHE2</dt>
 13.1745 +** <dd> ^(This option takes a single argument which is a pointer to
 13.1746 +** an [sqlite3_pcache_methods2] object.  This object specifies the interface
 13.1747 +** to a custom page cache implementation.)^  ^SQLite makes a copy of the
 13.1748 +** object and uses it for page cache memory allocations.</dd>
 13.1749 +**
 13.1750 +** [[SQLITE_CONFIG_GETPCACHE2]] <dt>SQLITE_CONFIG_GETPCACHE2</dt>
 13.1751 +** <dd> ^(This option takes a single argument which is a pointer to an
 13.1752 +** [sqlite3_pcache_methods2] object.  SQLite copies of the current
 13.1753 +** page cache implementation into that object.)^ </dd>
 13.1754 +**
 13.1755 +** [[SQLITE_CONFIG_LOG]] <dt>SQLITE_CONFIG_LOG</dt>
 13.1756 +** <dd> The SQLITE_CONFIG_LOG option is used to configure the SQLite
 13.1757 +** global [error log].
 13.1758 +** (^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a
 13.1759 +** function with a call signature of void(*)(void*,int,const char*), 
 13.1760 +** and a pointer to void. ^If the function pointer is not NULL, it is
 13.1761 +** invoked by [sqlite3_log()] to process each logging event.  ^If the
 13.1762 +** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op.
 13.1763 +** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is
 13.1764 +** passed through as the first parameter to the application-defined logger
 13.1765 +** function whenever that function is invoked.  ^The second parameter to
 13.1766 +** the logger function is a copy of the first parameter to the corresponding
 13.1767 +** [sqlite3_log()] call and is intended to be a [result code] or an
 13.1768 +** [extended result code].  ^The third parameter passed to the logger is
 13.1769 +** log message after formatting via [sqlite3_snprintf()].
 13.1770 +** The SQLite logging interface is not reentrant; the logger function
 13.1771 +** supplied by the application must not invoke any SQLite interface.
 13.1772 +** In a multi-threaded application, the application-defined logger
 13.1773 +** function must be threadsafe. </dd>
 13.1774 +**
 13.1775 +** [[SQLITE_CONFIG_URI]] <dt>SQLITE_CONFIG_URI
 13.1776 +** <dd>^(This option takes a single argument of type int. If non-zero, then
 13.1777 +** URI handling is globally enabled. If the parameter is zero, then URI handling
 13.1778 +** is globally disabled.)^ ^If URI handling is globally enabled, all filenames
 13.1779 +** passed to [sqlite3_open()], [sqlite3_open_v2()], [sqlite3_open16()] or
 13.1780 +** specified as part of [ATTACH] commands are interpreted as URIs, regardless
 13.1781 +** of whether or not the [SQLITE_OPEN_URI] flag is set when the database
 13.1782 +** connection is opened. ^If it is globally disabled, filenames are
 13.1783 +** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the
 13.1784 +** database connection is opened. ^(By default, URI handling is globally
 13.1785 +** disabled. The default value may be changed by compiling with the
 13.1786 +** [SQLITE_USE_URI] symbol defined.)^
 13.1787 +**
 13.1788 +** [[SQLITE_CONFIG_COVERING_INDEX_SCAN]] <dt>SQLITE_CONFIG_COVERING_INDEX_SCAN
 13.1789 +** <dd>^This option takes a single integer argument which is interpreted as
 13.1790 +** a boolean in order to enable or disable the use of covering indices for
 13.1791 +** full table scans in the query optimizer.  ^The default setting is determined
 13.1792 +** by the [SQLITE_ALLOW_COVERING_INDEX_SCAN] compile-time option, or is "on"
 13.1793 +** if that compile-time option is omitted.
 13.1794 +** The ability to disable the use of covering indices for full table scans
 13.1795 +** is because some incorrectly coded legacy applications might malfunction
 13.1796 +** when the optimization is enabled.  Providing the ability to
 13.1797 +** disable the optimization allows the older, buggy application code to work
 13.1798 +** without change even with newer versions of SQLite.
 13.1799 +**
 13.1800 +** [[SQLITE_CONFIG_PCACHE]] [[SQLITE_CONFIG_GETPCACHE]]
 13.1801 +** <dt>SQLITE_CONFIG_PCACHE and SQLITE_CONFIG_GETPCACHE
 13.1802 +** <dd> These options are obsolete and should not be used by new code.
 13.1803 +** They are retained for backwards compatibility but are now no-ops.
 13.1804 +** </dd>
 13.1805 +**
 13.1806 +** [[SQLITE_CONFIG_SQLLOG]]
 13.1807 +** <dt>SQLITE_CONFIG_SQLLOG
 13.1808 +** <dd>This option is only available if sqlite is compiled with the
 13.1809 +** [SQLITE_ENABLE_SQLLOG] pre-processor macro defined. The first argument should
 13.1810 +** be a pointer to a function of type void(*)(void*,sqlite3*,const char*, int).
 13.1811 +** The second should be of type (void*). The callback is invoked by the library
 13.1812 +** in three separate circumstances, identified by the value passed as the
 13.1813 +** fourth parameter. If the fourth parameter is 0, then the database connection
 13.1814 +** passed as the second argument has just been opened. The third argument
 13.1815 +** points to a buffer containing the name of the main database file. If the
 13.1816 +** fourth parameter is 1, then the SQL statement that the third parameter
 13.1817 +** points to has just been executed. Or, if the fourth parameter is 2, then
 13.1818 +** the connection being passed as the second parameter is being closed. The
 13.1819 +** third parameter is passed NULL In this case.  An example of using this
 13.1820 +** configuration option can be seen in the "test_sqllog.c" source file in
 13.1821 +** the canonical SQLite source tree.</dd>
 13.1822 +**
 13.1823 +** [[SQLITE_CONFIG_MMAP_SIZE]]
 13.1824 +** <dt>SQLITE_CONFIG_MMAP_SIZE
 13.1825 +** <dd>^SQLITE_CONFIG_MMAP_SIZE takes two 64-bit integer (sqlite3_int64) values
 13.1826 +** that are the default mmap size limit (the default setting for
 13.1827 +** [PRAGMA mmap_size]) and the maximum allowed mmap size limit.
 13.1828 +** ^The default setting can be overridden by each database connection using
 13.1829 +** either the [PRAGMA mmap_size] command, or by using the
 13.1830 +** [SQLITE_FCNTL_MMAP_SIZE] file control.  ^(The maximum allowed mmap size
 13.1831 +** cannot be changed at run-time.  Nor may the maximum allowed mmap size
 13.1832 +** exceed the compile-time maximum mmap size set by the
 13.1833 +** [SQLITE_MAX_MMAP_SIZE] compile-time option.)^
 13.1834 +** ^If either argument to this option is negative, then that argument is
 13.1835 +** changed to its compile-time default.
 13.1836 +**
 13.1837 +** [[SQLITE_CONFIG_WIN32_HEAPSIZE]]
 13.1838 +** <dt>SQLITE_CONFIG_WIN32_HEAPSIZE
 13.1839 +** <dd>^This option is only available if SQLite is compiled for Windows
 13.1840 +** with the [SQLITE_WIN32_MALLOC] pre-processor macro defined.
 13.1841 +** SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit unsigned integer value
 13.1842 +** that specifies the maximum size of the created heap.
 13.1843 +** </dl>
 13.1844 +*/
 13.1845 +#define SQLITE_CONFIG_SINGLETHREAD  1  /* nil */
 13.1846 +#define SQLITE_CONFIG_MULTITHREAD   2  /* nil */
 13.1847 +#define SQLITE_CONFIG_SERIALIZED    3  /* nil */
 13.1848 +#define SQLITE_CONFIG_MALLOC        4  /* sqlite3_mem_methods* */
 13.1849 +#define SQLITE_CONFIG_GETMALLOC     5  /* sqlite3_mem_methods* */
 13.1850 +#define SQLITE_CONFIG_SCRATCH       6  /* void*, int sz, int N */
 13.1851 +#define SQLITE_CONFIG_PAGECACHE     7  /* void*, int sz, int N */
 13.1852 +#define SQLITE_CONFIG_HEAP          8  /* void*, int nByte, int min */
 13.1853 +#define SQLITE_CONFIG_MEMSTATUS     9  /* boolean */
 13.1854 +#define SQLITE_CONFIG_MUTEX        10  /* sqlite3_mutex_methods* */
 13.1855 +#define SQLITE_CONFIG_GETMUTEX     11  /* sqlite3_mutex_methods* */
 13.1856 +/* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */ 
 13.1857 +#define SQLITE_CONFIG_LOOKASIDE    13  /* int int */
 13.1858 +#define SQLITE_CONFIG_PCACHE       14  /* no-op */
 13.1859 +#define SQLITE_CONFIG_GETPCACHE    15  /* no-op */
 13.1860 +#define SQLITE_CONFIG_LOG          16  /* xFunc, void* */
 13.1861 +#define SQLITE_CONFIG_URI          17  /* int */
 13.1862 +#define SQLITE_CONFIG_PCACHE2      18  /* sqlite3_pcache_methods2* */
 13.1863 +#define SQLITE_CONFIG_GETPCACHE2   19  /* sqlite3_pcache_methods2* */
 13.1864 +#define SQLITE_CONFIG_COVERING_INDEX_SCAN 20  /* int */
 13.1865 +#define SQLITE_CONFIG_SQLLOG       21  /* xSqllog, void* */
 13.1866 +#define SQLITE_CONFIG_MMAP_SIZE    22  /* sqlite3_int64, sqlite3_int64 */
 13.1867 +#define SQLITE_CONFIG_WIN32_HEAPSIZE      23  /* int nByte */
 13.1868 +
 13.1869 +/*
 13.1870 +** CAPI3REF: Database Connection Configuration Options
 13.1871 +**
 13.1872 +** These constants are the available integer configuration options that
 13.1873 +** can be passed as the second argument to the [sqlite3_db_config()] interface.
 13.1874 +**
 13.1875 +** New configuration options may be added in future releases of SQLite.
 13.1876 +** Existing configuration options might be discontinued.  Applications
 13.1877 +** should check the return code from [sqlite3_db_config()] to make sure that
 13.1878 +** the call worked.  ^The [sqlite3_db_config()] interface will return a
 13.1879 +** non-zero [error code] if a discontinued or unsupported configuration option
 13.1880 +** is invoked.
 13.1881 +**
 13.1882 +** <dl>
 13.1883 +** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt>
 13.1884 +** <dd> ^This option takes three additional arguments that determine the 
 13.1885 +** [lookaside memory allocator] configuration for the [database connection].
 13.1886 +** ^The first argument (the third parameter to [sqlite3_db_config()] is a
 13.1887 +** pointer to a memory buffer to use for lookaside memory.
 13.1888 +** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb
 13.1889 +** may be NULL in which case SQLite will allocate the
 13.1890 +** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the
 13.1891 +** size of each lookaside buffer slot.  ^The third argument is the number of
 13.1892 +** slots.  The size of the buffer in the first argument must be greater than
 13.1893 +** or equal to the product of the second and third arguments.  The buffer
 13.1894 +** must be aligned to an 8-byte boundary.  ^If the second argument to
 13.1895 +** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally
 13.1896 +** rounded down to the next smaller multiple of 8.  ^(The lookaside memory
 13.1897 +** configuration for a database connection can only be changed when that
 13.1898 +** connection is not currently using lookaside memory, or in other words
 13.1899 +** when the "current value" returned by
 13.1900 +** [sqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero.
 13.1901 +** Any attempt to change the lookaside memory configuration when lookaside
 13.1902 +** memory is in use leaves the configuration unchanged and returns 
 13.1903 +** [SQLITE_BUSY].)^</dd>
 13.1904 +**
 13.1905 +** <dt>SQLITE_DBCONFIG_ENABLE_FKEY</dt>
 13.1906 +** <dd> ^This option is used to enable or disable the enforcement of
 13.1907 +** [foreign key constraints].  There should be two additional arguments.
 13.1908 +** The first argument is an integer which is 0 to disable FK enforcement,
 13.1909 +** positive to enable FK enforcement or negative to leave FK enforcement
 13.1910 +** unchanged.  The second parameter is a pointer to an integer into which
 13.1911 +** is written 0 or 1 to indicate whether FK enforcement is off or on
 13.1912 +** following this call.  The second parameter may be a NULL pointer, in
 13.1913 +** which case the FK enforcement setting is not reported back. </dd>
 13.1914 +**
 13.1915 +** <dt>SQLITE_DBCONFIG_ENABLE_TRIGGER</dt>
 13.1916 +** <dd> ^This option is used to enable or disable [CREATE TRIGGER | triggers].
 13.1917 +** There should be two additional arguments.
 13.1918 +** The first argument is an integer which is 0 to disable triggers,
 13.1919 +** positive to enable triggers or negative to leave the setting unchanged.
 13.1920 +** The second parameter is a pointer to an integer into which
 13.1921 +** is written 0 or 1 to indicate whether triggers are disabled or enabled
 13.1922 +** following this call.  The second parameter may be a NULL pointer, in
 13.1923 +** which case the trigger setting is not reported back. </dd>
 13.1924 +**
 13.1925 +** </dl>
 13.1926 +*/
 13.1927 +#define SQLITE_DBCONFIG_LOOKASIDE       1001  /* void* int int */
 13.1928 +#define SQLITE_DBCONFIG_ENABLE_FKEY     1002  /* int int* */
 13.1929 +#define SQLITE_DBCONFIG_ENABLE_TRIGGER  1003  /* int int* */
 13.1930 +
 13.1931 +
 13.1932 +/*
 13.1933 +** CAPI3REF: Enable Or Disable Extended Result Codes
 13.1934 +**
 13.1935 +** ^The sqlite3_extended_result_codes() routine enables or disables the
 13.1936 +** [extended result codes] feature of SQLite. ^The extended result
 13.1937 +** codes are disabled by default for historical compatibility.
 13.1938 +*/
 13.1939 +SQLITE_API int sqlite3_extended_result_codes(sqlite3*, int onoff);
 13.1940 +
 13.1941 +/*
 13.1942 +** CAPI3REF: Last Insert Rowid
 13.1943 +**
 13.1944 +** ^Each entry in most SQLite tables (except for [WITHOUT ROWID] tables)
 13.1945 +** has a unique 64-bit signed
 13.1946 +** integer key called the [ROWID | "rowid"]. ^The rowid is always available
 13.1947 +** as an undeclared column named ROWID, OID, or _ROWID_ as long as those
 13.1948 +** names are not also used by explicitly declared columns. ^If
 13.1949 +** the table has a column of type [INTEGER PRIMARY KEY] then that column
 13.1950 +** is another alias for the rowid.
 13.1951 +**
 13.1952 +** ^The sqlite3_last_insert_rowid(D) interface returns the [rowid] of the 
 13.1953 +** most recent successful [INSERT] into a rowid table or [virtual table]
 13.1954 +** on database connection D.
 13.1955 +** ^Inserts into [WITHOUT ROWID] tables are not recorded.
 13.1956 +** ^If no successful [INSERT]s into rowid tables
 13.1957 +** have ever occurred on the database connection D, 
 13.1958 +** then sqlite3_last_insert_rowid(D) returns zero.
 13.1959 +**
 13.1960 +** ^(If an [INSERT] occurs within a trigger or within a [virtual table]
 13.1961 +** method, then this routine will return the [rowid] of the inserted
 13.1962 +** row as long as the trigger or virtual table method is running.
 13.1963 +** But once the trigger or virtual table method ends, the value returned 
 13.1964 +** by this routine reverts to what it was before the trigger or virtual
 13.1965 +** table method began.)^
 13.1966 +**
 13.1967 +** ^An [INSERT] that fails due to a constraint violation is not a
 13.1968 +** successful [INSERT] and does not change the value returned by this
 13.1969 +** routine.  ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK,
 13.1970 +** and INSERT OR ABORT make no changes to the return value of this
 13.1971 +** routine when their insertion fails.  ^(When INSERT OR REPLACE
 13.1972 +** encounters a constraint violation, it does not fail.  The
 13.1973 +** INSERT continues to completion after deleting rows that caused
 13.1974 +** the constraint problem so INSERT OR REPLACE will always change
 13.1975 +** the return value of this interface.)^
 13.1976 +**
 13.1977 +** ^For the purposes of this routine, an [INSERT] is considered to
 13.1978 +** be successful even if it is subsequently rolled back.
 13.1979 +**
 13.1980 +** This function is accessible to SQL statements via the
 13.1981 +** [last_insert_rowid() SQL function].
 13.1982 +**
 13.1983 +** If a separate thread performs a new [INSERT] on the same
 13.1984 +** database connection while the [sqlite3_last_insert_rowid()]
 13.1985 +** function is running and thus changes the last insert [rowid],
 13.1986 +** then the value returned by [sqlite3_last_insert_rowid()] is
 13.1987 +** unpredictable and might not equal either the old or the new
 13.1988 +** last insert [rowid].
 13.1989 +*/
 13.1990 +SQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*);
 13.1991 +
 13.1992 +/*
 13.1993 +** CAPI3REF: Count The Number Of Rows Modified
 13.1994 +**
 13.1995 +** ^This function returns the number of database rows that were changed
 13.1996 +** or inserted or deleted by the most recently completed SQL statement
 13.1997 +** on the [database connection] specified by the first parameter.
 13.1998 +** ^(Only changes that are directly specified by the [INSERT], [UPDATE],
 13.1999 +** or [DELETE] statement are counted.  Auxiliary changes caused by
 13.2000 +** triggers or [foreign key actions] are not counted.)^ Use the
 13.2001 +** [sqlite3_total_changes()] function to find the total number of changes
 13.2002 +** including changes caused by triggers and foreign key actions.
 13.2003 +**
 13.2004 +** ^Changes to a view that are simulated by an [INSTEAD OF trigger]
 13.2005 +** are not counted.  Only real table changes are counted.
 13.2006 +**
 13.2007 +** ^(A "row change" is a change to a single row of a single table
 13.2008 +** caused by an INSERT, DELETE, or UPDATE statement.  Rows that
 13.2009 +** are changed as side effects of [REPLACE] constraint resolution,
 13.2010 +** rollback, ABORT processing, [DROP TABLE], or by any other
 13.2011 +** mechanisms do not count as direct row changes.)^
 13.2012 +**
 13.2013 +** A "trigger context" is a scope of execution that begins and
 13.2014 +** ends with the script of a [CREATE TRIGGER | trigger]. 
 13.2015 +** Most SQL statements are
 13.2016 +** evaluated outside of any trigger.  This is the "top level"
 13.2017 +** trigger context.  If a trigger fires from the top level, a
 13.2018 +** new trigger context is entered for the duration of that one
 13.2019 +** trigger.  Subtriggers create subcontexts for their duration.
 13.2020 +**
 13.2021 +** ^Calling [sqlite3_exec()] or [sqlite3_step()] recursively does
 13.2022 +** not create a new trigger context.
 13.2023 +**
 13.2024 +** ^This function returns the number of direct row changes in the
 13.2025 +** most recent INSERT, UPDATE, or DELETE statement within the same
 13.2026 +** trigger context.
 13.2027 +**
 13.2028 +** ^Thus, when called from the top level, this function returns the
 13.2029 +** number of changes in the most recent INSERT, UPDATE, or DELETE
 13.2030 +** that also occurred at the top level.  ^(Within the body of a trigger,
 13.2031 +** the sqlite3_changes() interface can be called to find the number of
 13.2032 +** changes in the most recently completed INSERT, UPDATE, or DELETE
 13.2033 +** statement within the body of the same trigger.
 13.2034 +** However, the number returned does not include changes
 13.2035 +** caused by subtriggers since those have their own context.)^
 13.2036 +**
 13.2037 +** See also the [sqlite3_total_changes()] interface, the
 13.2038 +** [count_changes pragma], and the [changes() SQL function].
 13.2039 +**
 13.2040 +** If a separate thread makes changes on the same database connection
 13.2041 +** while [sqlite3_changes()] is running then the value returned
 13.2042 +** is unpredictable and not meaningful.
 13.2043 +*/
 13.2044 +SQLITE_API int sqlite3_changes(sqlite3*);
 13.2045 +
 13.2046 +/*
 13.2047 +** CAPI3REF: Total Number Of Rows Modified
 13.2048 +**
 13.2049 +** ^This function returns the number of row changes caused by [INSERT],
 13.2050 +** [UPDATE] or [DELETE] statements since the [database connection] was opened.
 13.2051 +** ^(The count returned by sqlite3_total_changes() includes all changes
 13.2052 +** from all [CREATE TRIGGER | trigger] contexts and changes made by
 13.2053 +** [foreign key actions]. However,
 13.2054 +** the count does not include changes used to implement [REPLACE] constraints,
 13.2055 +** do rollbacks or ABORT processing, or [DROP TABLE] processing.  The
 13.2056 +** count does not include rows of views that fire an [INSTEAD OF trigger],
 13.2057 +** though if the INSTEAD OF trigger makes changes of its own, those changes 
 13.2058 +** are counted.)^
 13.2059 +** ^The sqlite3_total_changes() function counts the changes as soon as
 13.2060 +** the statement that makes them is completed (when the statement handle
 13.2061 +** is passed to [sqlite3_reset()] or [sqlite3_finalize()]).
 13.2062 +**
 13.2063 +** See also the [sqlite3_changes()] interface, the
 13.2064 +** [count_changes pragma], and the [total_changes() SQL function].
 13.2065 +**
 13.2066 +** If a separate thread makes changes on the same database connection
 13.2067 +** while [sqlite3_total_changes()] is running then the value
 13.2068 +** returned is unpredictable and not meaningful.
 13.2069 +*/
 13.2070 +SQLITE_API int sqlite3_total_changes(sqlite3*);
 13.2071 +
 13.2072 +/*
 13.2073 +** CAPI3REF: Interrupt A Long-Running Query
 13.2074 +**
 13.2075 +** ^This function causes any pending database operation to abort and
 13.2076 +** return at its earliest opportunity. This routine is typically
 13.2077 +** called in response to a user action such as pressing "Cancel"
 13.2078 +** or Ctrl-C where the user wants a long query operation to halt
 13.2079 +** immediately.
 13.2080 +**
 13.2081 +** ^It is safe to call this routine from a thread different from the
 13.2082 +** thread that is currently running the database operation.  But it
 13.2083 +** is not safe to call this routine with a [database connection] that
 13.2084 +** is closed or might close before sqlite3_interrupt() returns.
 13.2085 +**
 13.2086 +** ^If an SQL operation is very nearly finished at the time when
 13.2087 +** sqlite3_interrupt() is called, then it might not have an opportunity
 13.2088 +** to be interrupted and might continue to completion.
 13.2089 +**
 13.2090 +** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT].
 13.2091 +** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE
 13.2092 +** that is inside an explicit transaction, then the entire transaction
 13.2093 +** will be rolled back automatically.
 13.2094 +**
 13.2095 +** ^The sqlite3_interrupt(D) call is in effect until all currently running
 13.2096 +** SQL statements on [database connection] D complete.  ^Any new SQL statements
 13.2097 +** that are started after the sqlite3_interrupt() call and before the 
 13.2098 +** running statements reaches zero are interrupted as if they had been
 13.2099 +** running prior to the sqlite3_interrupt() call.  ^New SQL statements
 13.2100 +** that are started after the running statement count reaches zero are
 13.2101 +** not effected by the sqlite3_interrupt().
 13.2102 +** ^A call to sqlite3_interrupt(D) that occurs when there are no running
 13.2103 +** SQL statements is a no-op and has no effect on SQL statements
 13.2104 +** that are started after the sqlite3_interrupt() call returns.
 13.2105 +**
 13.2106 +** If the database connection closes while [sqlite3_interrupt()]
 13.2107 +** is running then bad things will likely happen.
 13.2108 +*/
 13.2109 +SQLITE_API void sqlite3_interrupt(sqlite3*);
 13.2110 +
 13.2111 +/*
 13.2112 +** CAPI3REF: Determine If An SQL Statement Is Complete
 13.2113 +**
 13.2114 +** These routines are useful during command-line input to determine if the
 13.2115 +** currently entered text seems to form a complete SQL statement or
 13.2116 +** if additional input is needed before sending the text into
 13.2117 +** SQLite for parsing.  ^These routines return 1 if the input string
 13.2118 +** appears to be a complete SQL statement.  ^A statement is judged to be
 13.2119 +** complete if it ends with a semicolon token and is not a prefix of a
 13.2120 +** well-formed CREATE TRIGGER statement.  ^Semicolons that are embedded within
 13.2121 +** string literals or quoted identifier names or comments are not
 13.2122 +** independent tokens (they are part of the token in which they are
 13.2123 +** embedded) and thus do not count as a statement terminator.  ^Whitespace
 13.2124 +** and comments that follow the final semicolon are ignored.
 13.2125 +**
 13.2126 +** ^These routines return 0 if the statement is incomplete.  ^If a
 13.2127 +** memory allocation fails, then SQLITE_NOMEM is returned.
 13.2128 +**
 13.2129 +** ^These routines do not parse the SQL statements thus
 13.2130 +** will not detect syntactically incorrect SQL.
 13.2131 +**
 13.2132 +** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior 
 13.2133 +** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked
 13.2134 +** automatically by sqlite3_complete16().  If that initialization fails,
 13.2135 +** then the return value from sqlite3_complete16() will be non-zero
 13.2136 +** regardless of whether or not the input SQL is complete.)^
 13.2137 +**
 13.2138 +** The input to [sqlite3_complete()] must be a zero-terminated
 13.2139 +** UTF-8 string.
 13.2140 +**
 13.2141 +** The input to [sqlite3_complete16()] must be a zero-terminated
 13.2142 +** UTF-16 string in native byte order.
 13.2143 +*/
 13.2144 +SQLITE_API int sqlite3_complete(const char *sql);
 13.2145 +SQLITE_API int sqlite3_complete16(const void *sql);
 13.2146 +
 13.2147 +/*
 13.2148 +** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors
 13.2149 +**
 13.2150 +** ^The sqlite3_busy_handler(D,X,P) routine sets a callback function X
 13.2151 +** that might be invoked with argument P whenever
 13.2152 +** an attempt is made to access a database table associated with
 13.2153 +** [database connection] D when another thread
 13.2154 +** or process has the table locked.
 13.2155 +** The sqlite3_busy_handler() interface is used to implement
 13.2156 +** [sqlite3_busy_timeout()] and [PRAGMA busy_timeout].
 13.2157 +**
 13.2158 +** ^If the busy callback is NULL, then [SQLITE_BUSY]
 13.2159 +** is returned immediately upon encountering the lock.  ^If the busy callback
 13.2160 +** is not NULL, then the callback might be invoked with two arguments.
 13.2161 +**
 13.2162 +** ^The first argument to the busy handler is a copy of the void* pointer which
 13.2163 +** is the third argument to sqlite3_busy_handler().  ^The second argument to
 13.2164 +** the busy handler callback is the number of times that the busy handler has
 13.2165 +** been invoked for the same locking event.  ^If the
 13.2166 +** busy callback returns 0, then no additional attempts are made to
 13.2167 +** access the database and [SQLITE_BUSY] is returned
 13.2168 +** to the application.
 13.2169 +** ^If the callback returns non-zero, then another attempt
 13.2170 +** is made to access the database and the cycle repeats.
 13.2171 +**
 13.2172 +** The presence of a busy handler does not guarantee that it will be invoked
 13.2173 +** when there is lock contention. ^If SQLite determines that invoking the busy
 13.2174 +** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY]
 13.2175 +** to the application instead of invoking the 
 13.2176 +** busy handler.
 13.2177 +** Consider a scenario where one process is holding a read lock that
 13.2178 +** it is trying to promote to a reserved lock and
 13.2179 +** a second process is holding a reserved lock that it is trying
 13.2180 +** to promote to an exclusive lock.  The first process cannot proceed
 13.2181 +** because it is blocked by the second and the second process cannot
 13.2182 +** proceed because it is blocked by the first.  If both processes
 13.2183 +** invoke the busy handlers, neither will make any progress.  Therefore,
 13.2184 +** SQLite returns [SQLITE_BUSY] for the first process, hoping that this
 13.2185 +** will induce the first process to release its read lock and allow
 13.2186 +** the second process to proceed.
 13.2187 +**
 13.2188 +** ^The default busy callback is NULL.
 13.2189 +**
 13.2190 +** ^(There can only be a single busy handler defined for each
 13.2191 +** [database connection].  Setting a new busy handler clears any
 13.2192 +** previously set handler.)^  ^Note that calling [sqlite3_busy_timeout()]
 13.2193 +** or evaluating [PRAGMA busy_timeout=N] will change the
 13.2194 +** busy handler and thus clear any previously set busy handler.
 13.2195 +**
 13.2196 +** The busy callback should not take any actions which modify the
 13.2197 +** database connection that invoked the busy handler.  In other words,
 13.2198 +** the busy handler is not reentrant.  Any such actions
 13.2199 +** result in undefined behavior.
 13.2200 +** 
 13.2201 +** A busy handler must not close the database connection
 13.2202 +** or [prepared statement] that invoked the busy handler.
 13.2203 +*/
 13.2204 +SQLITE_API int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*);
 13.2205 +
 13.2206 +/*
 13.2207 +** CAPI3REF: Set A Busy Timeout
 13.2208 +**
 13.2209 +** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps
 13.2210 +** for a specified amount of time when a table is locked.  ^The handler
 13.2211 +** will sleep multiple times until at least "ms" milliseconds of sleeping
 13.2212 +** have accumulated.  ^After at least "ms" milliseconds of sleeping,
 13.2213 +** the handler returns 0 which causes [sqlite3_step()] to return
 13.2214 +** [SQLITE_BUSY].
 13.2215 +**
 13.2216 +** ^Calling this routine with an argument less than or equal to zero
 13.2217 +** turns off all busy handlers.
 13.2218 +**
 13.2219 +** ^(There can only be a single busy handler for a particular
 13.2220 +** [database connection] any any given moment.  If another busy handler
 13.2221 +** was defined  (using [sqlite3_busy_handler()]) prior to calling
 13.2222 +** this routine, that other busy handler is cleared.)^
 13.2223 +**
 13.2224 +** See also:  [PRAGMA busy_timeout]
 13.2225 +*/
 13.2226 +SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms);
 13.2227 +
 13.2228 +/*
 13.2229 +** CAPI3REF: Convenience Routines For Running Queries
 13.2230 +**
 13.2231 +** This is a legacy interface that is preserved for backwards compatibility.
 13.2232 +** Use of this interface is not recommended.
 13.2233 +**
 13.2234 +** Definition: A <b>result table</b> is memory data structure created by the
 13.2235 +** [sqlite3_get_table()] interface.  A result table records the
 13.2236 +** complete query results from one or more queries.
 13.2237 +**
 13.2238 +** The table conceptually has a number of rows and columns.  But
 13.2239 +** these numbers are not part of the result table itself.  These
 13.2240 +** numbers are obtained separately.  Let N be the number of rows
 13.2241 +** and M be the number of columns.
 13.2242 +**
 13.2243 +** A result table is an array of pointers to zero-terminated UTF-8 strings.
 13.2244 +** There are (N+1)*M elements in the array.  The first M pointers point
 13.2245 +** to zero-terminated strings that  contain the names of the columns.
 13.2246 +** The remaining entries all point to query results.  NULL values result
 13.2247 +** in NULL pointers.  All other values are in their UTF-8 zero-terminated
 13.2248 +** string representation as returned by [sqlite3_column_text()].
 13.2249 +**
 13.2250 +** A result table might consist of one or more memory allocations.
 13.2251 +** It is not safe to pass a result table directly to [sqlite3_free()].
 13.2252 +** A result table should be deallocated using [sqlite3_free_table()].
 13.2253 +**
 13.2254 +** ^(As an example of the result table format, suppose a query result
 13.2255 +** is as follows:
 13.2256 +**
 13.2257 +** <blockquote><pre>
 13.2258 +**        Name        | Age
 13.2259 +**        -----------------------
 13.2260 +**        Alice       | 43
 13.2261 +**        Bob         | 28
 13.2262 +**        Cindy       | 21
 13.2263 +** </pre></blockquote>
 13.2264 +**
 13.2265 +** There are two column (M==2) and three rows (N==3).  Thus the
 13.2266 +** result table has 8 entries.  Suppose the result table is stored
 13.2267 +** in an array names azResult.  Then azResult holds this content:
 13.2268 +**
 13.2269 +** <blockquote><pre>
 13.2270 +**        azResult&#91;0] = "Name";
 13.2271 +**        azResult&#91;1] = "Age";
 13.2272 +**        azResult&#91;2] = "Alice";
 13.2273 +**        azResult&#91;3] = "43";
 13.2274 +**        azResult&#91;4] = "Bob";
 13.2275 +**        azResult&#91;5] = "28";
 13.2276 +**        azResult&#91;6] = "Cindy";
 13.2277 +**        azResult&#91;7] = "21";
 13.2278 +** </pre></blockquote>)^
 13.2279 +**
 13.2280 +** ^The sqlite3_get_table() function evaluates one or more
 13.2281 +** semicolon-separated SQL statements in the zero-terminated UTF-8
 13.2282 +** string of its 2nd parameter and returns a result table to the
 13.2283 +** pointer given in its 3rd parameter.
 13.2284 +**
 13.2285 +** After the application has finished with the result from sqlite3_get_table(),
 13.2286 +** it must pass the result table pointer to sqlite3_free_table() in order to
 13.2287 +** release the memory that was malloced.  Because of the way the
 13.2288 +** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling
 13.2289 +** function must not try to call [sqlite3_free()] directly.  Only
 13.2290 +** [sqlite3_free_table()] is able to release the memory properly and safely.
 13.2291 +**
 13.2292 +** The sqlite3_get_table() interface is implemented as a wrapper around
 13.2293 +** [sqlite3_exec()].  The sqlite3_get_table() routine does not have access
 13.2294 +** to any internal data structures of SQLite.  It uses only the public
 13.2295 +** interface defined here.  As a consequence, errors that occur in the
 13.2296 +** wrapper layer outside of the internal [sqlite3_exec()] call are not
 13.2297 +** reflected in subsequent calls to [sqlite3_errcode()] or
 13.2298 +** [sqlite3_errmsg()].
 13.2299 +*/
 13.2300 +SQLITE_API int sqlite3_get_table(
 13.2301 +  sqlite3 *db,          /* An open database */
 13.2302 +  const char *zSql,     /* SQL to be evaluated */
 13.2303 +  char ***pazResult,    /* Results of the query */
 13.2304 +  int *pnRow,           /* Number of result rows written here */
 13.2305 +  int *pnColumn,        /* Number of result columns written here */
 13.2306 +  char **pzErrmsg       /* Error msg written here */
 13.2307 +);
 13.2308 +SQLITE_API void sqlite3_free_table(char **result);
 13.2309 +
 13.2310 +/*
 13.2311 +** CAPI3REF: Formatted String Printing Functions
 13.2312 +**
 13.2313 +** These routines are work-alikes of the "printf()" family of functions
 13.2314 +** from the standard C library.
 13.2315 +**
 13.2316 +** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their
 13.2317 +** results into memory obtained from [sqlite3_malloc()].
 13.2318 +** The strings returned by these two routines should be
 13.2319 +** released by [sqlite3_free()].  ^Both routines return a
 13.2320 +** NULL pointer if [sqlite3_malloc()] is unable to allocate enough
 13.2321 +** memory to hold the resulting string.
 13.2322 +**
 13.2323 +** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from
 13.2324 +** the standard C library.  The result is written into the
 13.2325 +** buffer supplied as the second parameter whose size is given by
 13.2326 +** the first parameter. Note that the order of the
 13.2327 +** first two parameters is reversed from snprintf().)^  This is an
 13.2328 +** historical accident that cannot be fixed without breaking
 13.2329 +** backwards compatibility.  ^(Note also that sqlite3_snprintf()
 13.2330 +** returns a pointer to its buffer instead of the number of
 13.2331 +** characters actually written into the buffer.)^  We admit that
 13.2332 +** the number of characters written would be a more useful return
 13.2333 +** value but we cannot change the implementation of sqlite3_snprintf()
 13.2334 +** now without breaking compatibility.
 13.2335 +**
 13.2336 +** ^As long as the buffer size is greater than zero, sqlite3_snprintf()
 13.2337 +** guarantees that the buffer is always zero-terminated.  ^The first
 13.2338 +** parameter "n" is the total size of the buffer, including space for
 13.2339 +** the zero terminator.  So the longest string that can be completely
 13.2340 +** written will be n-1 characters.
 13.2341 +**
 13.2342 +** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf().
 13.2343 +**
 13.2344 +** These routines all implement some additional formatting
 13.2345 +** options that are useful for constructing SQL statements.
 13.2346 +** All of the usual printf() formatting options apply.  In addition, there
 13.2347 +** is are "%q", "%Q", and "%z" options.
 13.2348 +**
 13.2349 +** ^(The %q option works like %s in that it substitutes a nul-terminated
 13.2350 +** string from the argument list.  But %q also doubles every '\'' character.
 13.2351 +** %q is designed for use inside a string literal.)^  By doubling each '\''
 13.2352 +** character it escapes that character and allows it to be inserted into
 13.2353 +** the string.
 13.2354 +**
 13.2355 +** For example, assume the string variable zText contains text as follows:
 13.2356 +**
 13.2357 +** <blockquote><pre>
 13.2358 +**  char *zText = "It's a happy day!";
 13.2359 +** </pre></blockquote>
 13.2360 +**
 13.2361 +** One can use this text in an SQL statement as follows:
 13.2362 +**
 13.2363 +** <blockquote><pre>
 13.2364 +**  char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText);
 13.2365 +**  sqlite3_exec(db, zSQL, 0, 0, 0);
 13.2366 +**  sqlite3_free(zSQL);
 13.2367 +** </pre></blockquote>
 13.2368 +**
 13.2369 +** Because the %q format string is used, the '\'' character in zText
 13.2370 +** is escaped and the SQL generated is as follows:
 13.2371 +**
 13.2372 +** <blockquote><pre>
 13.2373 +**  INSERT INTO table1 VALUES('It''s a happy day!')
 13.2374 +** </pre></blockquote>
 13.2375 +**
 13.2376 +** This is correct.  Had we used %s instead of %q, the generated SQL
 13.2377 +** would have looked like this:
 13.2378 +**
 13.2379 +** <blockquote><pre>
 13.2380 +**  INSERT INTO table1 VALUES('It's a happy day!');
 13.2381 +** </pre></blockquote>
 13.2382 +**
 13.2383 +** This second example is an SQL syntax error.  As a general rule you should
 13.2384 +** always use %q instead of %s when inserting text into a string literal.
 13.2385 +**
 13.2386 +** ^(The %Q option works like %q except it also adds single quotes around
 13.2387 +** the outside of the total string.  Additionally, if the parameter in the
 13.2388 +** argument list is a NULL pointer, %Q substitutes the text "NULL" (without
 13.2389 +** single quotes).)^  So, for example, one could say:
 13.2390 +**
 13.2391 +** <blockquote><pre>
 13.2392 +**  char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText);
 13.2393 +**  sqlite3_exec(db, zSQL, 0, 0, 0);
 13.2394 +**  sqlite3_free(zSQL);
 13.2395 +** </pre></blockquote>
 13.2396 +**
 13.2397 +** The code above will render a correct SQL statement in the zSQL
 13.2398 +** variable even if the zText variable is a NULL pointer.
 13.2399 +**
 13.2400 +** ^(The "%z" formatting option works like "%s" but with the
 13.2401 +** addition that after the string has been read and copied into
 13.2402 +** the result, [sqlite3_free()] is called on the input string.)^
 13.2403 +*/
 13.2404 +SQLITE_API char *sqlite3_mprintf(const char*,...);
 13.2405 +SQLITE_API char *sqlite3_vmprintf(const char*, va_list);
 13.2406 +SQLITE_API char *sqlite3_snprintf(int,char*,const char*, ...);
 13.2407 +SQLITE_API char *sqlite3_vsnprintf(int,char*,const char*, va_list);
 13.2408 +
 13.2409 +/*
 13.2410 +** CAPI3REF: Memory Allocation Subsystem
 13.2411 +**
 13.2412 +** The SQLite core uses these three routines for all of its own
 13.2413 +** internal memory allocation needs. "Core" in the previous sentence
 13.2414 +** does not include operating-system specific VFS implementation.  The
 13.2415 +** Windows VFS uses native malloc() and free() for some operations.
 13.2416 +**
 13.2417 +** ^The sqlite3_malloc() routine returns a pointer to a block
 13.2418 +** of memory at least N bytes in length, where N is the parameter.
 13.2419 +** ^If sqlite3_malloc() is unable to obtain sufficient free
 13.2420 +** memory, it returns a NULL pointer.  ^If the parameter N to
 13.2421 +** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns
 13.2422 +** a NULL pointer.
 13.2423 +**
 13.2424 +** ^Calling sqlite3_free() with a pointer previously returned
 13.2425 +** by sqlite3_malloc() or sqlite3_realloc() releases that memory so
 13.2426 +** that it might be reused.  ^The sqlite3_free() routine is
 13.2427 +** a no-op if is called with a NULL pointer.  Passing a NULL pointer
 13.2428 +** to sqlite3_free() is harmless.  After being freed, memory
 13.2429 +** should neither be read nor written.  Even reading previously freed
 13.2430 +** memory might result in a segmentation fault or other severe error.
 13.2431 +** Memory corruption, a segmentation fault, or other severe error
 13.2432 +** might result if sqlite3_free() is called with a non-NULL pointer that
 13.2433 +** was not obtained from sqlite3_malloc() or sqlite3_realloc().
 13.2434 +**
 13.2435 +** ^(The sqlite3_realloc() interface attempts to resize a
 13.2436 +** prior memory allocation to be at least N bytes, where N is the
 13.2437 +** second parameter.  The memory allocation to be resized is the first
 13.2438 +** parameter.)^ ^ If the first parameter to sqlite3_realloc()
 13.2439 +** is a NULL pointer then its behavior is identical to calling
 13.2440 +** sqlite3_malloc(N) where N is the second parameter to sqlite3_realloc().
 13.2441 +** ^If the second parameter to sqlite3_realloc() is zero or
 13.2442 +** negative then the behavior is exactly the same as calling
 13.2443 +** sqlite3_free(P) where P is the first parameter to sqlite3_realloc().
 13.2444 +** ^sqlite3_realloc() returns a pointer to a memory allocation
 13.2445 +** of at least N bytes in size or NULL if sufficient memory is unavailable.
 13.2446 +** ^If M is the size of the prior allocation, then min(N,M) bytes
 13.2447 +** of the prior allocation are copied into the beginning of buffer returned
 13.2448 +** by sqlite3_realloc() and the prior allocation is freed.
 13.2449 +** ^If sqlite3_realloc() returns NULL, then the prior allocation
 13.2450 +** is not freed.
 13.2451 +**
 13.2452 +** ^The memory returned by sqlite3_malloc() and sqlite3_realloc()
 13.2453 +** is always aligned to at least an 8 byte boundary, or to a
 13.2454 +** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time
 13.2455 +** option is used.
 13.2456 +**
 13.2457 +** In SQLite version 3.5.0 and 3.5.1, it was possible to define
 13.2458 +** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in
 13.2459 +** implementation of these routines to be omitted.  That capability
 13.2460 +** is no longer provided.  Only built-in memory allocators can be used.
 13.2461 +**
 13.2462 +** Prior to SQLite version 3.7.10, the Windows OS interface layer called
 13.2463 +** the system malloc() and free() directly when converting
 13.2464 +** filenames between the UTF-8 encoding used by SQLite
 13.2465 +** and whatever filename encoding is used by the particular Windows
 13.2466 +** installation.  Memory allocation errors were detected, but
 13.2467 +** they were reported back as [SQLITE_CANTOPEN] or
 13.2468 +** [SQLITE_IOERR] rather than [SQLITE_NOMEM].
 13.2469 +**
 13.2470 +** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()]
 13.2471 +** must be either NULL or else pointers obtained from a prior
 13.2472 +** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have
 13.2473 +** not yet been released.
 13.2474 +**
 13.2475 +** The application must not read or write any part of
 13.2476 +** a block of memory after it has been released using
 13.2477 +** [sqlite3_free()] or [sqlite3_realloc()].
 13.2478 +*/
 13.2479 +SQLITE_API void *sqlite3_malloc(int);
 13.2480 +SQLITE_API void *sqlite3_realloc(void*, int);
 13.2481 +SQLITE_API void sqlite3_free(void*);
 13.2482 +
 13.2483 +/*
 13.2484 +** CAPI3REF: Memory Allocator Statistics
 13.2485 +**
 13.2486 +** SQLite provides these two interfaces for reporting on the status
 13.2487 +** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()]
 13.2488 +** routines, which form the built-in memory allocation subsystem.
 13.2489 +**
 13.2490 +** ^The [sqlite3_memory_used()] routine returns the number of bytes
 13.2491 +** of memory currently outstanding (malloced but not freed).
 13.2492 +** ^The [sqlite3_memory_highwater()] routine returns the maximum
 13.2493 +** value of [sqlite3_memory_used()] since the high-water mark
 13.2494 +** was last reset.  ^The values returned by [sqlite3_memory_used()] and
 13.2495 +** [sqlite3_memory_highwater()] include any overhead
 13.2496 +** added by SQLite in its implementation of [sqlite3_malloc()],
 13.2497 +** but not overhead added by the any underlying system library
 13.2498 +** routines that [sqlite3_malloc()] may call.
 13.2499 +**
 13.2500 +** ^The memory high-water mark is reset to the current value of
 13.2501 +** [sqlite3_memory_used()] if and only if the parameter to
 13.2502 +** [sqlite3_memory_highwater()] is true.  ^The value returned
 13.2503 +** by [sqlite3_memory_highwater(1)] is the high-water mark
 13.2504 +** prior to the reset.
 13.2505 +*/
 13.2506 +SQLITE_API sqlite3_int64 sqlite3_memory_used(void);
 13.2507 +SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag);
 13.2508 +
 13.2509 +/*
 13.2510 +** CAPI3REF: Pseudo-Random Number Generator
 13.2511 +**
 13.2512 +** SQLite contains a high-quality pseudo-random number generator (PRNG) used to
 13.2513 +** select random [ROWID | ROWIDs] when inserting new records into a table that
 13.2514 +** already uses the largest possible [ROWID].  The PRNG is also used for
 13.2515 +** the build-in random() and randomblob() SQL functions.  This interface allows
 13.2516 +** applications to access the same PRNG for other purposes.
 13.2517 +**
 13.2518 +** ^A call to this routine stores N bytes of randomness into buffer P.
 13.2519 +** ^If N is less than one, then P can be a NULL pointer.
 13.2520 +**
 13.2521 +** ^If this routine has not been previously called or if the previous
 13.2522 +** call had N less than one, then the PRNG is seeded using randomness
 13.2523 +** obtained from the xRandomness method of the default [sqlite3_vfs] object.
 13.2524 +** ^If the previous call to this routine had an N of 1 or more then
 13.2525 +** the pseudo-randomness is generated
 13.2526 +** internally and without recourse to the [sqlite3_vfs] xRandomness
 13.2527 +** method.
 13.2528 +*/
 13.2529 +SQLITE_API void sqlite3_randomness(int N, void *P);
 13.2530 +
 13.2531 +/*
 13.2532 +** CAPI3REF: Compile-Time Authorization Callbacks
 13.2533 +**
 13.2534 +** ^This routine registers an authorizer callback with a particular
 13.2535 +** [database connection], supplied in the first argument.
 13.2536 +** ^The authorizer callback is invoked as SQL statements are being compiled
 13.2537 +** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()],
 13.2538 +** [sqlite3_prepare16()] and [sqlite3_prepare16_v2()].  ^At various
 13.2539 +** points during the compilation process, as logic is being created
 13.2540 +** to perform various actions, the authorizer callback is invoked to
 13.2541 +** see if those actions are allowed.  ^The authorizer callback should
 13.2542 +** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the
 13.2543 +** specific action but allow the SQL statement to continue to be
 13.2544 +** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be
 13.2545 +** rejected with an error.  ^If the authorizer callback returns
 13.2546 +** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY]
 13.2547 +** then the [sqlite3_prepare_v2()] or equivalent call that triggered
 13.2548 +** the authorizer will fail with an error message.
 13.2549 +**
 13.2550 +** When the callback returns [SQLITE_OK], that means the operation
 13.2551 +** requested is ok.  ^When the callback returns [SQLITE_DENY], the
 13.2552 +** [sqlite3_prepare_v2()] or equivalent call that triggered the
 13.2553 +** authorizer will fail with an error message explaining that
 13.2554 +** access is denied. 
 13.2555 +**
 13.2556 +** ^The first parameter to the authorizer callback is a copy of the third
 13.2557 +** parameter to the sqlite3_set_authorizer() interface. ^The second parameter
 13.2558 +** to the callback is an integer [SQLITE_COPY | action code] that specifies
 13.2559 +** the particular action to be authorized. ^The third through sixth parameters
 13.2560 +** to the callback are zero-terminated strings that contain additional
 13.2561 +** details about the action to be authorized.
 13.2562 +**
 13.2563 +** ^If the action code is [SQLITE_READ]
 13.2564 +** and the callback returns [SQLITE_IGNORE] then the
 13.2565 +** [prepared statement] statement is constructed to substitute
 13.2566 +** a NULL value in place of the table column that would have
 13.2567 +** been read if [SQLITE_OK] had been returned.  The [SQLITE_IGNORE]
 13.2568 +** return can be used to deny an untrusted user access to individual
 13.2569 +** columns of a table.
 13.2570 +** ^If the action code is [SQLITE_DELETE] and the callback returns
 13.2571 +** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the
 13.2572 +** [truncate optimization] is disabled and all rows are deleted individually.
 13.2573 +**
 13.2574 +** An authorizer is used when [sqlite3_prepare | preparing]
 13.2575 +** SQL statements from an untrusted source, to ensure that the SQL statements
 13.2576 +** do not try to access data they are not allowed to see, or that they do not
 13.2577 +** try to execute malicious statements that damage the database.  For
 13.2578 +** example, an application may allow a user to enter arbitrary
 13.2579 +** SQL queries for evaluation by a database.  But the application does
 13.2580 +** not want the user to be able to make arbitrary changes to the
 13.2581 +** database.  An authorizer could then be put in place while the
 13.2582 +** user-entered SQL is being [sqlite3_prepare | prepared] that
 13.2583 +** disallows everything except [SELECT] statements.
 13.2584 +**
 13.2585 +** Applications that need to process SQL from untrusted sources
 13.2586 +** might also consider lowering resource limits using [sqlite3_limit()]
 13.2587 +** and limiting database size using the [max_page_count] [PRAGMA]
 13.2588 +** in addition to using an authorizer.
 13.2589 +**
 13.2590 +** ^(Only a single authorizer can be in place on a database connection
 13.2591 +** at a time.  Each call to sqlite3_set_authorizer overrides the
 13.2592 +** previous call.)^  ^Disable the authorizer by installing a NULL callback.
 13.2593 +** The authorizer is disabled by default.
 13.2594 +**
 13.2595 +** The authorizer callback must not do anything that will modify
 13.2596 +** the database connection that invoked the authorizer callback.
 13.2597 +** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
 13.2598 +** database connections for the meaning of "modify" in this paragraph.
 13.2599 +**
 13.2600 +** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the
 13.2601 +** statement might be re-prepared during [sqlite3_step()] due to a 
 13.2602 +** schema change.  Hence, the application should ensure that the
 13.2603 +** correct authorizer callback remains in place during the [sqlite3_step()].
 13.2604 +**
 13.2605 +** ^Note that the authorizer callback is invoked only during
 13.2606 +** [sqlite3_prepare()] or its variants.  Authorization is not
 13.2607 +** performed during statement evaluation in [sqlite3_step()], unless
 13.2608 +** as stated in the previous paragraph, sqlite3_step() invokes
 13.2609 +** sqlite3_prepare_v2() to reprepare a statement after a schema change.
 13.2610 +*/
 13.2611 +SQLITE_API int sqlite3_set_authorizer(
 13.2612 +  sqlite3*,
 13.2613 +  int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
 13.2614 +  void *pUserData
 13.2615 +);
 13.2616 +
 13.2617 +/*
 13.2618 +** CAPI3REF: Authorizer Return Codes
 13.2619 +**
 13.2620 +** The [sqlite3_set_authorizer | authorizer callback function] must
 13.2621 +** return either [SQLITE_OK] or one of these two constants in order
 13.2622 +** to signal SQLite whether or not the action is permitted.  See the
 13.2623 +** [sqlite3_set_authorizer | authorizer documentation] for additional
 13.2624 +** information.
 13.2625 +**
 13.2626 +** Note that SQLITE_IGNORE is also used as a [conflict resolution mode]
 13.2627 +** returned from the [sqlite3_vtab_on_conflict()] interface.
 13.2628 +*/
 13.2629 +#define SQLITE_DENY   1   /* Abort the SQL statement with an error */
 13.2630 +#define SQLITE_IGNORE 2   /* Don't allow access, but don't generate an error */
 13.2631 +
 13.2632 +/*
 13.2633 +** CAPI3REF: Authorizer Action Codes
 13.2634 +**
 13.2635 +** The [sqlite3_set_authorizer()] interface registers a callback function
 13.2636 +** that is invoked to authorize certain SQL statement actions.  The
 13.2637 +** second parameter to the callback is an integer code that specifies
 13.2638 +** what action is being authorized.  These are the integer action codes that
 13.2639 +** the authorizer callback may be passed.
 13.2640 +**
 13.2641 +** These action code values signify what kind of operation is to be
 13.2642 +** authorized.  The 3rd and 4th parameters to the authorization
 13.2643 +** callback function will be parameters or NULL depending on which of these
 13.2644 +** codes is used as the second parameter.  ^(The 5th parameter to the
 13.2645 +** authorizer callback is the name of the database ("main", "temp",
 13.2646 +** etc.) if applicable.)^  ^The 6th parameter to the authorizer callback
 13.2647 +** is the name of the inner-most trigger or view that is responsible for
 13.2648 +** the access attempt or NULL if this access attempt is directly from
 13.2649 +** top-level SQL code.
 13.2650 +*/
 13.2651 +/******************************************* 3rd ************ 4th ***********/
 13.2652 +#define SQLITE_CREATE_INDEX          1   /* Index Name      Table Name      */
 13.2653 +#define SQLITE_CREATE_TABLE          2   /* Table Name      NULL            */
 13.2654 +#define SQLITE_CREATE_TEMP_INDEX     3   /* Index Name      Table Name      */
 13.2655 +#define SQLITE_CREATE_TEMP_TABLE     4   /* Table Name      NULL            */
 13.2656 +#define SQLITE_CREATE_TEMP_TRIGGER   5   /* Trigger Name    Table Name      */
 13.2657 +#define SQLITE_CREATE_TEMP_VIEW      6   /* View Name       NULL            */
 13.2658 +#define SQLITE_CREATE_TRIGGER        7   /* Trigger Name    Table Name      */
 13.2659 +#define SQLITE_CREATE_VIEW           8   /* View Name       NULL            */
 13.2660 +#define SQLITE_DELETE                9   /* Table Name      NULL            */
 13.2661 +#define SQLITE_DROP_INDEX           10   /* Index Name      Table Name      */
 13.2662 +#define SQLITE_DROP_TABLE           11   /* Table Name      NULL            */
 13.2663 +#define SQLITE_DROP_TEMP_INDEX      12   /* Index Name      Table Name      */
 13.2664 +#define SQLITE_DROP_TEMP_TABLE      13   /* Table Name      NULL            */
 13.2665 +#define SQLITE_DROP_TEMP_TRIGGER    14   /* Trigger Name    Table Name      */
 13.2666 +#define SQLITE_DROP_TEMP_VIEW       15   /* View Name       NULL            */
 13.2667 +#define SQLITE_DROP_TRIGGER         16   /* Trigger Name    Table Name      */
 13.2668 +#define SQLITE_DROP_VIEW            17   /* View Name       NULL            */
 13.2669 +#define SQLITE_INSERT               18   /* Table Name      NULL            */
 13.2670 +#define SQLITE_PRAGMA               19   /* Pragma Name     1st arg or NULL */
 13.2671 +#define SQLITE_READ                 20   /* Table Name      Column Name     */
 13.2672 +#define SQLITE_SELECT               21   /* NULL            NULL            */
 13.2673 +#define SQLITE_TRANSACTION          22   /* Operation       NULL            */
 13.2674 +#define SQLITE_UPDATE               23   /* Table Name      Column Name     */
 13.2675 +#define SQLITE_ATTACH               24   /* Filename        NULL            */
 13.2676 +#define SQLITE_DETACH               25   /* Database Name   NULL            */
 13.2677 +#define SQLITE_ALTER_TABLE          26   /* Database Name   Table Name      */
 13.2678 +#define SQLITE_REINDEX              27   /* Index Name      NULL            */
 13.2679 +#define SQLITE_ANALYZE              28   /* Table Name      NULL            */
 13.2680 +#define SQLITE_CREATE_VTABLE        29   /* Table Name      Module Name     */
 13.2681 +#define SQLITE_DROP_VTABLE          30   /* Table Name      Module Name     */
 13.2682 +#define SQLITE_FUNCTION             31   /* NULL            Function Name   */
 13.2683 +#define SQLITE_SAVEPOINT            32   /* Operation       Savepoint Name  */
 13.2684 +#define SQLITE_COPY                  0   /* No longer used */
 13.2685 +#define SQLITE_RECURSIVE            33   /* NULL            NULL            */
 13.2686 +
 13.2687 +/*
 13.2688 +** CAPI3REF: Tracing And Profiling Functions
 13.2689 +**
 13.2690 +** These routines register callback functions that can be used for
 13.2691 +** tracing and profiling the execution of SQL statements.
 13.2692 +**
 13.2693 +** ^The callback function registered by sqlite3_trace() is invoked at
 13.2694 +** various times when an SQL statement is being run by [sqlite3_step()].
 13.2695 +** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the
 13.2696 +** SQL statement text as the statement first begins executing.
 13.2697 +** ^(Additional sqlite3_trace() callbacks might occur
 13.2698 +** as each triggered subprogram is entered.  The callbacks for triggers
 13.2699 +** contain a UTF-8 SQL comment that identifies the trigger.)^
 13.2700 +**
 13.2701 +** The [SQLITE_TRACE_SIZE_LIMIT] compile-time option can be used to limit
 13.2702 +** the length of [bound parameter] expansion in the output of sqlite3_trace().
 13.2703 +**
 13.2704 +** ^The callback function registered by sqlite3_profile() is invoked
 13.2705 +** as each SQL statement finishes.  ^The profile callback contains
 13.2706 +** the original statement text and an estimate of wall-clock time
 13.2707 +** of how long that statement took to run.  ^The profile callback
 13.2708 +** time is in units of nanoseconds, however the current implementation
 13.2709 +** is only capable of millisecond resolution so the six least significant
 13.2710 +** digits in the time are meaningless.  Future versions of SQLite
 13.2711 +** might provide greater resolution on the profiler callback.  The
 13.2712 +** sqlite3_profile() function is considered experimental and is
 13.2713 +** subject to change in future versions of SQLite.
 13.2714 +*/
 13.2715 +SQLITE_API void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*);
 13.2716 +SQLITE_API SQLITE_EXPERIMENTAL void *sqlite3_profile(sqlite3*,
 13.2717 +   void(*xProfile)(void*,const char*,sqlite3_uint64), void*);
 13.2718 +
 13.2719 +/*
 13.2720 +** CAPI3REF: Query Progress Callbacks
 13.2721 +**
 13.2722 +** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback
 13.2723 +** function X to be invoked periodically during long running calls to
 13.2724 +** [sqlite3_exec()], [sqlite3_step()] and [sqlite3_get_table()] for
 13.2725 +** database connection D.  An example use for this
 13.2726 +** interface is to keep a GUI updated during a large query.
 13.2727 +**
 13.2728 +** ^The parameter P is passed through as the only parameter to the 
 13.2729 +** callback function X.  ^The parameter N is the approximate number of 
 13.2730 +** [virtual machine instructions] that are evaluated between successive
 13.2731 +** invocations of the callback X.  ^If N is less than one then the progress
 13.2732 +** handler is disabled.
 13.2733 +**
 13.2734 +** ^Only a single progress handler may be defined at one time per
 13.2735 +** [database connection]; setting a new progress handler cancels the
 13.2736 +** old one.  ^Setting parameter X to NULL disables the progress handler.
 13.2737 +** ^The progress handler is also disabled by setting N to a value less
 13.2738 +** than 1.
 13.2739 +**
 13.2740 +** ^If the progress callback returns non-zero, the operation is
 13.2741 +** interrupted.  This feature can be used to implement a
 13.2742 +** "Cancel" button on a GUI progress dialog box.
 13.2743 +**
 13.2744 +** The progress handler callback must not do anything that will modify
 13.2745 +** the database connection that invoked the progress handler.
 13.2746 +** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
 13.2747 +** database connections for the meaning of "modify" in this paragraph.
 13.2748 +**
 13.2749 +*/
 13.2750 +SQLITE_API void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
 13.2751 +
 13.2752 +/*
 13.2753 +** CAPI3REF: Opening A New Database Connection
 13.2754 +**
 13.2755 +** ^These routines open an SQLite database file as specified by the 
 13.2756 +** filename argument. ^The filename argument is interpreted as UTF-8 for
 13.2757 +** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte
 13.2758 +** order for sqlite3_open16(). ^(A [database connection] handle is usually
 13.2759 +** returned in *ppDb, even if an error occurs.  The only exception is that
 13.2760 +** if SQLite is unable to allocate memory to hold the [sqlite3] object,
 13.2761 +** a NULL will be written into *ppDb instead of a pointer to the [sqlite3]
 13.2762 +** object.)^ ^(If the database is opened (and/or created) successfully, then
 13.2763 +** [SQLITE_OK] is returned.  Otherwise an [error code] is returned.)^ ^The
 13.2764 +** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain
 13.2765 +** an English language description of the error following a failure of any
 13.2766 +** of the sqlite3_open() routines.
 13.2767 +**
 13.2768 +** ^The default encoding for the database will be UTF-8 if
 13.2769 +** sqlite3_open() or sqlite3_open_v2() is called and
 13.2770 +** UTF-16 in the native byte order if sqlite3_open16() is used.
 13.2771 +**
 13.2772 +** Whether or not an error occurs when it is opened, resources
 13.2773 +** associated with the [database connection] handle should be released by
 13.2774 +** passing it to [sqlite3_close()] when it is no longer required.
 13.2775 +**
 13.2776 +** The sqlite3_open_v2() interface works like sqlite3_open()
 13.2777 +** except that it accepts two additional parameters for additional control
 13.2778 +** over the new database connection.  ^(The flags parameter to
 13.2779 +** sqlite3_open_v2() can take one of
 13.2780 +** the following three values, optionally combined with the 
 13.2781 +** [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], [SQLITE_OPEN_SHAREDCACHE],
 13.2782 +** [SQLITE_OPEN_PRIVATECACHE], and/or [SQLITE_OPEN_URI] flags:)^
 13.2783 +**
 13.2784 +** <dl>
 13.2785 +** ^(<dt>[SQLITE_OPEN_READONLY]</dt>
 13.2786 +** <dd>The database is opened in read-only mode.  If the database does not
 13.2787 +** already exist, an error is returned.</dd>)^
 13.2788 +**
 13.2789 +** ^(<dt>[SQLITE_OPEN_READWRITE]</dt>
 13.2790 +** <dd>The database is opened for reading and writing if possible, or reading
 13.2791 +** only if the file is write protected by the operating system.  In either
 13.2792 +** case the database must already exist, otherwise an error is returned.</dd>)^
 13.2793 +**
 13.2794 +** ^(<dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt>
 13.2795 +** <dd>The database is opened for reading and writing, and is created if
 13.2796 +** it does not already exist. This is the behavior that is always used for
 13.2797 +** sqlite3_open() and sqlite3_open16().</dd>)^
 13.2798 +** </dl>
 13.2799 +**
 13.2800 +** If the 3rd parameter to sqlite3_open_v2() is not one of the
 13.2801 +** combinations shown above optionally combined with other
 13.2802 +** [SQLITE_OPEN_READONLY | SQLITE_OPEN_* bits]
 13.2803 +** then the behavior is undefined.
 13.2804 +**
 13.2805 +** ^If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection
 13.2806 +** opens in the multi-thread [threading mode] as long as the single-thread
 13.2807 +** mode has not been set at compile-time or start-time.  ^If the
 13.2808 +** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens
 13.2809 +** in the serialized [threading mode] unless single-thread was
 13.2810 +** previously selected at compile-time or start-time.
 13.2811 +** ^The [SQLITE_OPEN_SHAREDCACHE] flag causes the database connection to be
 13.2812 +** eligible to use [shared cache mode], regardless of whether or not shared
 13.2813 +** cache is enabled using [sqlite3_enable_shared_cache()].  ^The
 13.2814 +** [SQLITE_OPEN_PRIVATECACHE] flag causes the database connection to not
 13.2815 +** participate in [shared cache mode] even if it is enabled.
 13.2816 +**
 13.2817 +** ^The fourth parameter to sqlite3_open_v2() is the name of the
 13.2818 +** [sqlite3_vfs] object that defines the operating system interface that
 13.2819 +** the new database connection should use.  ^If the fourth parameter is
 13.2820 +** a NULL pointer then the default [sqlite3_vfs] object is used.
 13.2821 +**
 13.2822 +** ^If the filename is ":memory:", then a private, temporary in-memory database
 13.2823 +** is created for the connection.  ^This in-memory database will vanish when
 13.2824 +** the database connection is closed.  Future versions of SQLite might
 13.2825 +** make use of additional special filenames that begin with the ":" character.
 13.2826 +** It is recommended that when a database filename actually does begin with
 13.2827 +** a ":" character you should prefix the filename with a pathname such as
 13.2828 +** "./" to avoid ambiguity.
 13.2829 +**
 13.2830 +** ^If the filename is an empty string, then a private, temporary
 13.2831 +** on-disk database will be created.  ^This private database will be
 13.2832 +** automatically deleted as soon as the database connection is closed.
 13.2833 +**
 13.2834 +** [[URI filenames in sqlite3_open()]] <h3>URI Filenames</h3>
 13.2835 +**
 13.2836 +** ^If [URI filename] interpretation is enabled, and the filename argument
 13.2837 +** begins with "file:", then the filename is interpreted as a URI. ^URI
 13.2838 +** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is
 13.2839 +** set in the fourth argument to sqlite3_open_v2(), or if it has
 13.2840 +** been enabled globally using the [SQLITE_CONFIG_URI] option with the
 13.2841 +** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option.
 13.2842 +** As of SQLite version 3.7.7, URI filename interpretation is turned off
 13.2843 +** by default, but future releases of SQLite might enable URI filename
 13.2844 +** interpretation by default.  See "[URI filenames]" for additional
 13.2845 +** information.
 13.2846 +**
 13.2847 +** URI filenames are parsed according to RFC 3986. ^If the URI contains an
 13.2848 +** authority, then it must be either an empty string or the string 
 13.2849 +** "localhost". ^If the authority is not an empty string or "localhost", an 
 13.2850 +** error is returned to the caller. ^The fragment component of a URI, if 
 13.2851 +** present, is ignored.
 13.2852 +**
 13.2853 +** ^SQLite uses the path component of the URI as the name of the disk file
 13.2854 +** which contains the database. ^If the path begins with a '/' character, 
 13.2855 +** then it is interpreted as an absolute path. ^If the path does not begin 
 13.2856 +** with a '/' (meaning that the authority section is omitted from the URI)
 13.2857 +** then the path is interpreted as a relative path. 
 13.2858 +** ^On windows, the first component of an absolute path 
 13.2859 +** is a drive specification (e.g. "C:").
 13.2860 +**
 13.2861 +** [[core URI query parameters]]
 13.2862 +** The query component of a URI may contain parameters that are interpreted
 13.2863 +** either by SQLite itself, or by a [VFS | custom VFS implementation].
 13.2864 +** SQLite interprets the following three query parameters:
 13.2865 +**
 13.2866 +** <ul>
 13.2867 +**   <li> <b>vfs</b>: ^The "vfs" parameter may be used to specify the name of
 13.2868 +**     a VFS object that provides the operating system interface that should
 13.2869 +**     be used to access the database file on disk. ^If this option is set to
 13.2870 +**     an empty string the default VFS object is used. ^Specifying an unknown
 13.2871 +**     VFS is an error. ^If sqlite3_open_v2() is used and the vfs option is
 13.2872 +**     present, then the VFS specified by the option takes precedence over
 13.2873 +**     the value passed as the fourth parameter to sqlite3_open_v2().
 13.2874 +**
 13.2875 +**   <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw",
 13.2876 +**     "rwc", or "memory". Attempting to set it to any other value is
 13.2877 +**     an error)^. 
 13.2878 +**     ^If "ro" is specified, then the database is opened for read-only 
 13.2879 +**     access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the 
 13.2880 +**     third argument to sqlite3_open_v2(). ^If the mode option is set to 
 13.2881 +**     "rw", then the database is opened for read-write (but not create) 
 13.2882 +**     access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had 
 13.2883 +**     been set. ^Value "rwc" is equivalent to setting both 
 13.2884 +**     SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE.  ^If the mode option is
 13.2885 +**     set to "memory" then a pure [in-memory database] that never reads
 13.2886 +**     or writes from disk is used. ^It is an error to specify a value for
 13.2887 +**     the mode parameter that is less restrictive than that specified by
 13.2888 +**     the flags passed in the third parameter to sqlite3_open_v2().
 13.2889 +**
 13.2890 +**   <li> <b>cache</b>: ^The cache parameter may be set to either "shared" or
 13.2891 +**     "private". ^Setting it to "shared" is equivalent to setting the
 13.2892 +**     SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to
 13.2893 +**     sqlite3_open_v2(). ^Setting the cache parameter to "private" is 
 13.2894 +**     equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit.
 13.2895 +**     ^If sqlite3_open_v2() is used and the "cache" parameter is present in
 13.2896 +**     a URI filename, its value overrides any behavior requested by setting
 13.2897 +**     SQLITE_OPEN_PRIVATECACHE or SQLITE_OPEN_SHAREDCACHE flag.
 13.2898 +**
 13.2899 +**  <li> <b>psow</b>: ^The psow parameter may be "true" (or "on" or "yes" or
 13.2900 +**     "1") or "false" (or "off" or "no" or "0") to indicate that the
 13.2901 +**     [powersafe overwrite] property does or does not apply to the
 13.2902 +**     storage media on which the database file resides.  ^The psow query
 13.2903 +**     parameter only works for the built-in unix and Windows VFSes.
 13.2904 +**
 13.2905 +**  <li> <b>nolock</b>: ^The nolock parameter is a boolean query parameter
 13.2906 +**     which if set disables file locking in rollback journal modes.  This
 13.2907 +**     is useful for accessing a database on a filesystem that does not
 13.2908 +**     support locking.  Caution:  Database corruption might result if two
 13.2909 +**     or more processes write to the same database and any one of those
 13.2910 +**     processes uses nolock=1.
 13.2911 +**
 13.2912 +**  <li> <b>immutable</b>: ^The immutable parameter is a boolean query
 13.2913 +**     parameter that indicates that the database file is stored on
 13.2914 +**     read-only media.  ^When immutable is set, SQLite assumes that the
 13.2915 +**     database file cannot be changed, even by a process with higher
 13.2916 +**     privilege, and so the database is opened read-only and all locking
 13.2917 +**     and change detection is disabled.  Caution: Setting the immutable
 13.2918 +**     property on a database file that does in fact change can result
 13.2919 +**     in incorrect query results and/or [SQLITE_CORRUPT] errors.
 13.2920 +**     See also: [SQLITE_IOCAP_IMMUTABLE].
 13.2921 +**       
 13.2922 +** </ul>
 13.2923 +**
 13.2924 +** ^Specifying an unknown parameter in the query component of a URI is not an
 13.2925 +** error.  Future versions of SQLite might understand additional query
 13.2926 +** parameters.  See "[query parameters with special meaning to SQLite]" for
 13.2927 +** additional information.
 13.2928 +**
 13.2929 +** [[URI filename examples]] <h3>URI filename examples</h3>
 13.2930 +**
 13.2931 +** <table border="1" align=center cellpadding=5>
 13.2932 +** <tr><th> URI filenames <th> Results
 13.2933 +** <tr><td> file:data.db <td> 
 13.2934 +**          Open the file "data.db" in the current directory.
 13.2935 +** <tr><td> file:/home/fred/data.db<br>
 13.2936 +**          file:///home/fred/data.db <br> 
 13.2937 +**          file://localhost/home/fred/data.db <br> <td> 
 13.2938 +**          Open the database file "/home/fred/data.db".
 13.2939 +** <tr><td> file://darkstar/home/fred/data.db <td> 
 13.2940 +**          An error. "darkstar" is not a recognized authority.
 13.2941 +** <tr><td style="white-space:nowrap"> 
 13.2942 +**          file:///C:/Documents%20and%20Settings/fred/Desktop/data.db
 13.2943 +**     <td> Windows only: Open the file "data.db" on fred's desktop on drive
 13.2944 +**          C:. Note that the %20 escaping in this example is not strictly 
 13.2945 +**          necessary - space characters can be used literally
 13.2946 +**          in URI filenames.
 13.2947 +** <tr><td> file:data.db?mode=ro&cache=private <td> 
 13.2948 +**          Open file "data.db" in the current directory for read-only access.
 13.2949 +**          Regardless of whether or not shared-cache mode is enabled by
 13.2950 +**          default, use a private cache.
 13.2951 +** <tr><td> file:/home/fred/data.db?vfs=unix-dotfile <td>
 13.2952 +**          Open file "/home/fred/data.db". Use the special VFS "unix-dotfile"
 13.2953 +**          that uses dot-files in place of posix advisory locking.
 13.2954 +** <tr><td> file:data.db?mode=readonly <td> 
 13.2955 +**          An error. "readonly" is not a valid option for the "mode" parameter.
 13.2956 +** </table>
 13.2957 +**
 13.2958 +** ^URI hexadecimal escape sequences (%HH) are supported within the path and
 13.2959 +** query components of a URI. A hexadecimal escape sequence consists of a
 13.2960 +** percent sign - "%" - followed by exactly two hexadecimal digits 
 13.2961 +** specifying an octet value. ^Before the path or query components of a
 13.2962 +** URI filename are interpreted, they are encoded using UTF-8 and all 
 13.2963 +** hexadecimal escape sequences replaced by a single byte containing the
 13.2964 +** corresponding octet. If this process generates an invalid UTF-8 encoding,
 13.2965 +** the results are undefined.
 13.2966 +**
 13.2967 +** <b>Note to Windows users:</b>  The encoding used for the filename argument
 13.2968 +** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever
 13.2969 +** codepage is currently defined.  Filenames containing international
 13.2970 +** characters must be converted to UTF-8 prior to passing them into
 13.2971 +** sqlite3_open() or sqlite3_open_v2().
 13.2972 +**
 13.2973 +** <b>Note to Windows Runtime users:</b>  The temporary directory must be set
 13.2974 +** prior to calling sqlite3_open() or sqlite3_open_v2().  Otherwise, various
 13.2975 +** features that require the use of temporary files may fail.
 13.2976 +**
 13.2977 +** See also: [sqlite3_temp_directory]
 13.2978 +*/
 13.2979 +SQLITE_API int sqlite3_open(
 13.2980 +  const char *filename,   /* Database filename (UTF-8) */
 13.2981 +  sqlite3 **ppDb          /* OUT: SQLite db handle */
 13.2982 +);
 13.2983 +SQLITE_API int sqlite3_open16(
 13.2984 +  const void *filename,   /* Database filename (UTF-16) */
 13.2985 +  sqlite3 **ppDb          /* OUT: SQLite db handle */
 13.2986 +);
 13.2987 +SQLITE_API int sqlite3_open_v2(
 13.2988 +  const char *filename,   /* Database filename (UTF-8) */
 13.2989 +  sqlite3 **ppDb,         /* OUT: SQLite db handle */
 13.2990 +  int flags,              /* Flags */
 13.2991 +  const char *zVfs        /* Name of VFS module to use */
 13.2992 +);
 13.2993 +
 13.2994 +/*
 13.2995 +** CAPI3REF: Obtain Values For URI Parameters
 13.2996 +**
 13.2997 +** These are utility routines, useful to VFS implementations, that check
 13.2998 +** to see if a database file was a URI that contained a specific query 
 13.2999 +** parameter, and if so obtains the value of that query parameter.
 13.3000 +**
 13.3001 +** If F is the database filename pointer passed into the xOpen() method of 
 13.3002 +** a VFS implementation when the flags parameter to xOpen() has one or 
 13.3003 +** more of the [SQLITE_OPEN_URI] or [SQLITE_OPEN_MAIN_DB] bits set and
 13.3004 +** P is the name of the query parameter, then
 13.3005 +** sqlite3_uri_parameter(F,P) returns the value of the P
 13.3006 +** parameter if it exists or a NULL pointer if P does not appear as a 
 13.3007 +** query parameter on F.  If P is a query parameter of F
 13.3008 +** has no explicit value, then sqlite3_uri_parameter(F,P) returns
 13.3009 +** a pointer to an empty string.
 13.3010 +**
 13.3011 +** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean
 13.3012 +** parameter and returns true (1) or false (0) according to the value
 13.3013 +** of P.  The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the
 13.3014 +** value of query parameter P is one of "yes", "true", or "on" in any
 13.3015 +** case or if the value begins with a non-zero number.  The 
 13.3016 +** sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of
 13.3017 +** query parameter P is one of "no", "false", or "off" in any case or
 13.3018 +** if the value begins with a numeric zero.  If P is not a query
 13.3019 +** parameter on F or if the value of P is does not match any of the
 13.3020 +** above, then sqlite3_uri_boolean(F,P,B) returns (B!=0).
 13.3021 +**
 13.3022 +** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a
 13.3023 +** 64-bit signed integer and returns that integer, or D if P does not
 13.3024 +** exist.  If the value of P is something other than an integer, then
 13.3025 +** zero is returned.
 13.3026 +** 
 13.3027 +** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and
 13.3028 +** sqlite3_uri_boolean(F,P,B) returns B.  If F is not a NULL pointer and
 13.3029 +** is not a database file pathname pointer that SQLite passed into the xOpen
 13.3030 +** VFS method, then the behavior of this routine is undefined and probably
 13.3031 +** undesirable.
 13.3032 +*/
 13.3033 +SQLITE_API const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam);
 13.3034 +SQLITE_API int sqlite3_uri_boolean(const char *zFile, const char *zParam, int bDefault);
 13.3035 +SQLITE_API sqlite3_int64 sqlite3_uri_int64(const char*, const char*, sqlite3_int64);
 13.3036 +
 13.3037 +
 13.3038 +/*
 13.3039 +** CAPI3REF: Error Codes And Messages
 13.3040 +**
 13.3041 +** ^The sqlite3_errcode() interface returns the numeric [result code] or
 13.3042 +** [extended result code] for the most recent failed sqlite3_* API call
 13.3043 +** associated with a [database connection]. If a prior API call failed
 13.3044 +** but the most recent API call succeeded, the return value from
 13.3045 +** sqlite3_errcode() is undefined.  ^The sqlite3_extended_errcode()
 13.3046 +** interface is the same except that it always returns the 
 13.3047 +** [extended result code] even when extended result codes are
 13.3048 +** disabled.
 13.3049 +**
 13.3050 +** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language
 13.3051 +** text that describes the error, as either UTF-8 or UTF-16 respectively.
 13.3052 +** ^(Memory to hold the error message string is managed internally.
 13.3053 +** The application does not need to worry about freeing the result.
 13.3054 +** However, the error string might be overwritten or deallocated by
 13.3055 +** subsequent calls to other SQLite interface functions.)^
 13.3056 +**
 13.3057 +** ^The sqlite3_errstr() interface returns the English-language text
 13.3058 +** that describes the [result code], as UTF-8.
 13.3059 +** ^(Memory to hold the error message string is managed internally
 13.3060 +** and must not be freed by the application)^.
 13.3061 +**
 13.3062 +** When the serialized [threading mode] is in use, it might be the
 13.3063 +** case that a second error occurs on a separate thread in between
 13.3064 +** the time of the first error and the call to these interfaces.
 13.3065 +** When that happens, the second error will be reported since these
 13.3066 +** interfaces always report the most recent result.  To avoid
 13.3067 +** this, each thread can obtain exclusive use of the [database connection] D
 13.3068 +** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning
 13.3069 +** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after
 13.3070 +** all calls to the interfaces listed here are completed.
 13.3071 +**
 13.3072 +** If an interface fails with SQLITE_MISUSE, that means the interface
 13.3073 +** was invoked incorrectly by the application.  In that case, the
 13.3074 +** error code and message may or may not be set.
 13.3075 +*/
 13.3076 +SQLITE_API int sqlite3_errcode(sqlite3 *db);
 13.3077 +SQLITE_API int sqlite3_extended_errcode(sqlite3 *db);
 13.3078 +SQLITE_API const char *sqlite3_errmsg(sqlite3*);
 13.3079 +SQLITE_API const void *sqlite3_errmsg16(sqlite3*);
 13.3080 +SQLITE_API const char *sqlite3_errstr(int);
 13.3081 +
 13.3082 +/*
 13.3083 +** CAPI3REF: SQL Statement Object
 13.3084 +** KEYWORDS: {prepared statement} {prepared statements}
 13.3085 +**
 13.3086 +** An instance of this object represents a single SQL statement.
 13.3087 +** This object is variously known as a "prepared statement" or a
 13.3088 +** "compiled SQL statement" or simply as a "statement".
 13.3089 +**
 13.3090 +** The life of a statement object goes something like this:
 13.3091 +**
 13.3092 +** <ol>
 13.3093 +** <li> Create the object using [sqlite3_prepare_v2()] or a related
 13.3094 +**      function.
 13.3095 +** <li> Bind values to [host parameters] using the sqlite3_bind_*()
 13.3096 +**      interfaces.
 13.3097 +** <li> Run the SQL by calling [sqlite3_step()] one or more times.
 13.3098 +** <li> Reset the statement using [sqlite3_reset()] then go back
 13.3099 +**      to step 2.  Do this zero or more times.
 13.3100 +** <li> Destroy the object using [sqlite3_finalize()].
 13.3101 +** </ol>
 13.3102 +**
 13.3103 +** Refer to documentation on individual methods above for additional
 13.3104 +** information.
 13.3105 +*/
 13.3106 +typedef struct sqlite3_stmt sqlite3_stmt;
 13.3107 +
 13.3108 +/*
 13.3109 +** CAPI3REF: Run-time Limits
 13.3110 +**
 13.3111 +** ^(This interface allows the size of various constructs to be limited
 13.3112 +** on a connection by connection basis.  The first parameter is the
 13.3113 +** [database connection] whose limit is to be set or queried.  The
 13.3114 +** second parameter is one of the [limit categories] that define a
 13.3115 +** class of constructs to be size limited.  The third parameter is the
 13.3116 +** new limit for that construct.)^
 13.3117 +**
 13.3118 +** ^If the new limit is a negative number, the limit is unchanged.
 13.3119 +** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a 
 13.3120 +** [limits | hard upper bound]
 13.3121 +** set at compile-time by a C preprocessor macro called
 13.3122 +** [limits | SQLITE_MAX_<i>NAME</i>].
 13.3123 +** (The "_LIMIT_" in the name is changed to "_MAX_".))^
 13.3124 +** ^Attempts to increase a limit above its hard upper bound are
 13.3125 +** silently truncated to the hard upper bound.
 13.3126 +**
 13.3127 +** ^Regardless of whether or not the limit was changed, the 
 13.3128 +** [sqlite3_limit()] interface returns the prior value of the limit.
 13.3129 +** ^Hence, to find the current value of a limit without changing it,
 13.3130 +** simply invoke this interface with the third parameter set to -1.
 13.3131 +**
 13.3132 +** Run-time limits are intended for use in applications that manage
 13.3133 +** both their own internal database and also databases that are controlled
 13.3134 +** by untrusted external sources.  An example application might be a
 13.3135 +** web browser that has its own databases for storing history and
 13.3136 +** separate databases controlled by JavaScript applications downloaded
 13.3137 +** off the Internet.  The internal databases can be given the
 13.3138 +** large, default limits.  Databases managed by external sources can
 13.3139 +** be given much smaller limits designed to prevent a denial of service
 13.3140 +** attack.  Developers might also want to use the [sqlite3_set_authorizer()]
 13.3141 +** interface to further control untrusted SQL.  The size of the database
 13.3142 +** created by an untrusted script can be contained using the
 13.3143 +** [max_page_count] [PRAGMA].
 13.3144 +**
 13.3145 +** New run-time limit categories may be added in future releases.
 13.3146 +*/
 13.3147 +SQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal);
 13.3148 +
 13.3149 +/*
 13.3150 +** CAPI3REF: Run-Time Limit Categories
 13.3151 +** KEYWORDS: {limit category} {*limit categories}
 13.3152 +**
 13.3153 +** These constants define various performance limits
 13.3154 +** that can be lowered at run-time using [sqlite3_limit()].
 13.3155 +** The synopsis of the meanings of the various limits is shown below.
 13.3156 +** Additional information is available at [limits | Limits in SQLite].
 13.3157 +**
 13.3158 +** <dl>
 13.3159 +** [[SQLITE_LIMIT_LENGTH]] ^(<dt>SQLITE_LIMIT_LENGTH</dt>
 13.3160 +** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^
 13.3161 +**
 13.3162 +** [[SQLITE_LIMIT_SQL_LENGTH]] ^(<dt>SQLITE_LIMIT_SQL_LENGTH</dt>
 13.3163 +** <dd>The maximum length of an SQL statement, in bytes.</dd>)^
 13.3164 +**
 13.3165 +** [[SQLITE_LIMIT_COLUMN]] ^(<dt>SQLITE_LIMIT_COLUMN</dt>
 13.3166 +** <dd>The maximum number of columns in a table definition or in the
 13.3167 +** result set of a [SELECT] or the maximum number of columns in an index
 13.3168 +** or in an ORDER BY or GROUP BY clause.</dd>)^
 13.3169 +**
 13.3170 +** [[SQLITE_LIMIT_EXPR_DEPTH]] ^(<dt>SQLITE_LIMIT_EXPR_DEPTH</dt>
 13.3171 +** <dd>The maximum depth of the parse tree on any expression.</dd>)^
 13.3172 +**
 13.3173 +** [[SQLITE_LIMIT_COMPOUND_SELECT]] ^(<dt>SQLITE_LIMIT_COMPOUND_SELECT</dt>
 13.3174 +** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^
 13.3175 +**
 13.3176 +** [[SQLITE_LIMIT_VDBE_OP]] ^(<dt>SQLITE_LIMIT_VDBE_OP</dt>
 13.3177 +** <dd>The maximum number of instructions in a virtual machine program
 13.3178 +** used to implement an SQL statement.  This limit is not currently
 13.3179 +** enforced, though that might be added in some future release of
 13.3180 +** SQLite.</dd>)^
 13.3181 +**
 13.3182 +** [[SQLITE_LIMIT_FUNCTION_ARG]] ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt>
 13.3183 +** <dd>The maximum number of arguments on a function.</dd>)^
 13.3184 +**
 13.3185 +** [[SQLITE_LIMIT_ATTACHED]] ^(<dt>SQLITE_LIMIT_ATTACHED</dt>
 13.3186 +** <dd>The maximum number of [ATTACH | attached databases].)^</dd>
 13.3187 +**
 13.3188 +** [[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]]
 13.3189 +** ^(<dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt>
 13.3190 +** <dd>The maximum length of the pattern argument to the [LIKE] or
 13.3191 +** [GLOB] operators.</dd>)^
 13.3192 +**
 13.3193 +** [[SQLITE_LIMIT_VARIABLE_NUMBER]]
 13.3194 +** ^(<dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt>
 13.3195 +** <dd>The maximum index number of any [parameter] in an SQL statement.)^
 13.3196 +**
 13.3197 +** [[SQLITE_LIMIT_TRIGGER_DEPTH]] ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt>
 13.3198 +** <dd>The maximum depth of recursion for triggers.</dd>)^
 13.3199 +** </dl>
 13.3200 +*/
 13.3201 +#define SQLITE_LIMIT_LENGTH                    0
 13.3202 +#define SQLITE_LIMIT_SQL_LENGTH                1
 13.3203 +#define SQLITE_LIMIT_COLUMN                    2
 13.3204 +#define SQLITE_LIMIT_EXPR_DEPTH                3
 13.3205 +#define SQLITE_LIMIT_COMPOUND_SELECT           4
 13.3206 +#define SQLITE_LIMIT_VDBE_OP                   5
 13.3207 +#define SQLITE_LIMIT_FUNCTION_ARG              6
 13.3208 +#define SQLITE_LIMIT_ATTACHED                  7
 13.3209 +#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH       8
 13.3210 +#define SQLITE_LIMIT_VARIABLE_NUMBER           9
 13.3211 +#define SQLITE_LIMIT_TRIGGER_DEPTH            10
 13.3212 +
 13.3213 +/*
 13.3214 +** CAPI3REF: Compiling An SQL Statement
 13.3215 +** KEYWORDS: {SQL statement compiler}
 13.3216 +**
 13.3217 +** To execute an SQL query, it must first be compiled into a byte-code
 13.3218 +** program using one of these routines.
 13.3219 +**
 13.3220 +** The first argument, "db", is a [database connection] obtained from a
 13.3221 +** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or
 13.3222 +** [sqlite3_open16()].  The database connection must not have been closed.
 13.3223 +**
 13.3224 +** The second argument, "zSql", is the statement to be compiled, encoded
 13.3225 +** as either UTF-8 or UTF-16.  The sqlite3_prepare() and sqlite3_prepare_v2()
 13.3226 +** interfaces use UTF-8, and sqlite3_prepare16() and sqlite3_prepare16_v2()
 13.3227 +** use UTF-16.
 13.3228 +**
 13.3229 +** ^If the nByte argument is less than zero, then zSql is read up to the
 13.3230 +** first zero terminator. ^If nByte is non-negative, then it is the maximum
 13.3231 +** number of  bytes read from zSql.  ^When nByte is non-negative, the
 13.3232 +** zSql string ends at either the first '\000' or '\u0000' character or
 13.3233 +** the nByte-th byte, whichever comes first. If the caller knows
 13.3234 +** that the supplied string is nul-terminated, then there is a small
 13.3235 +** performance advantage to be gained by passing an nByte parameter that
 13.3236 +** is equal to the number of bytes in the input string <i>including</i>
 13.3237 +** the nul-terminator bytes as this saves SQLite from having to
 13.3238 +** make a copy of the input string.
 13.3239 +**
 13.3240 +** ^If pzTail is not NULL then *pzTail is made to point to the first byte
 13.3241 +** past the end of the first SQL statement in zSql.  These routines only
 13.3242 +** compile the first statement in zSql, so *pzTail is left pointing to
 13.3243 +** what remains uncompiled.
 13.3244 +**
 13.3245 +** ^*ppStmt is left pointing to a compiled [prepared statement] that can be
 13.3246 +** executed using [sqlite3_step()].  ^If there is an error, *ppStmt is set
 13.3247 +** to NULL.  ^If the input text contains no SQL (if the input is an empty
 13.3248 +** string or a comment) then *ppStmt is set to NULL.
 13.3249 +** The calling procedure is responsible for deleting the compiled
 13.3250 +** SQL statement using [sqlite3_finalize()] after it has finished with it.
 13.3251 +** ppStmt may not be NULL.
 13.3252 +**
 13.3253 +** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK];
 13.3254 +** otherwise an [error code] is returned.
 13.3255 +**
 13.3256 +** The sqlite3_prepare_v2() and sqlite3_prepare16_v2() interfaces are
 13.3257 +** recommended for all new programs. The two older interfaces are retained
 13.3258 +** for backwards compatibility, but their use is discouraged.
 13.3259 +** ^In the "v2" interfaces, the prepared statement
 13.3260 +** that is returned (the [sqlite3_stmt] object) contains a copy of the
 13.3261 +** original SQL text. This causes the [sqlite3_step()] interface to
 13.3262 +** behave differently in three ways:
 13.3263 +**
 13.3264 +** <ol>
 13.3265 +** <li>
 13.3266 +** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it
 13.3267 +** always used to do, [sqlite3_step()] will automatically recompile the SQL
 13.3268 +** statement and try to run it again. As many as [SQLITE_MAX_SCHEMA_RETRY]
 13.3269 +** retries will occur before sqlite3_step() gives up and returns an error.
 13.3270 +** </li>
 13.3271 +**
 13.3272 +** <li>
 13.3273 +** ^When an error occurs, [sqlite3_step()] will return one of the detailed
 13.3274 +** [error codes] or [extended error codes].  ^The legacy behavior was that
 13.3275 +** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code
 13.3276 +** and the application would have to make a second call to [sqlite3_reset()]
 13.3277 +** in order to find the underlying cause of the problem. With the "v2" prepare
 13.3278 +** interfaces, the underlying reason for the error is returned immediately.
 13.3279 +** </li>
 13.3280 +**
 13.3281 +** <li>
 13.3282 +** ^If the specific value bound to [parameter | host parameter] in the 
 13.3283 +** WHERE clause might influence the choice of query plan for a statement,
 13.3284 +** then the statement will be automatically recompiled, as if there had been 
 13.3285 +** a schema change, on the first  [sqlite3_step()] call following any change
 13.3286 +** to the [sqlite3_bind_text | bindings] of that [parameter]. 
 13.3287 +** ^The specific value of WHERE-clause [parameter] might influence the 
 13.3288 +** choice of query plan if the parameter is the left-hand side of a [LIKE]
 13.3289 +** or [GLOB] operator or if the parameter is compared to an indexed column
 13.3290 +** and the [SQLITE_ENABLE_STAT3] compile-time option is enabled.
 13.3291 +** </li>
 13.3292 +** </ol>
 13.3293 +*/
 13.3294 +SQLITE_API int sqlite3_prepare(
 13.3295 +  sqlite3 *db,            /* Database handle */
 13.3296 +  const char *zSql,       /* SQL statement, UTF-8 encoded */
 13.3297 +  int nByte,              /* Maximum length of zSql in bytes. */
 13.3298 +  sqlite3_stmt **ppStmt,  /* OUT: Statement handle */
 13.3299 +  const char **pzTail     /* OUT: Pointer to unused portion of zSql */
 13.3300 +);
 13.3301 +SQLITE_API int sqlite3_prepare_v2(
 13.3302 +  sqlite3 *db,            /* Database handle */
 13.3303 +  const char *zSql,       /* SQL statement, UTF-8 encoded */
 13.3304 +  int nByte,              /* Maximum length of zSql in bytes. */
 13.3305 +  sqlite3_stmt **ppStmt,  /* OUT: Statement handle */
 13.3306 +  const char **pzTail     /* OUT: Pointer to unused portion of zSql */
 13.3307 +);
 13.3308 +SQLITE_API int sqlite3_prepare16(
 13.3309 +  sqlite3 *db,            /* Database handle */
 13.3310 +  const void *zSql,       /* SQL statement, UTF-16 encoded */
 13.3311 +  int nByte,              /* Maximum length of zSql in bytes. */
 13.3312 +  sqlite3_stmt **ppStmt,  /* OUT: Statement handle */
 13.3313 +  const void **pzTail     /* OUT: Pointer to unused portion of zSql */
 13.3314 +);
 13.3315 +SQLITE_API int sqlite3_prepare16_v2(
 13.3316 +  sqlite3 *db,            /* Database handle */
 13.3317 +  const void *zSql,       /* SQL statement, UTF-16 encoded */
 13.3318 +  int nByte,              /* Maximum length of zSql in bytes. */
 13.3319 +  sqlite3_stmt **ppStmt,  /* OUT: Statement handle */
 13.3320 +  const void **pzTail     /* OUT: Pointer to unused portion of zSql */
 13.3321 +);
 13.3322 +
 13.3323 +/*
 13.3324 +** CAPI3REF: Retrieving Statement SQL
 13.3325 +**
 13.3326 +** ^This interface can be used to retrieve a saved copy of the original
 13.3327 +** SQL text used to create a [prepared statement] if that statement was
 13.3328 +** compiled using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()].
 13.3329 +*/
 13.3330 +SQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt);
 13.3331 +
 13.3332 +/*
 13.3333 +** CAPI3REF: Determine If An SQL Statement Writes The Database
 13.3334 +**
 13.3335 +** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if
 13.3336 +** and only if the [prepared statement] X makes no direct changes to
 13.3337 +** the content of the database file.
 13.3338 +**
 13.3339 +** Note that [application-defined SQL functions] or
 13.3340 +** [virtual tables] might change the database indirectly as a side effect.  
 13.3341 +** ^(For example, if an application defines a function "eval()" that 
 13.3342 +** calls [sqlite3_exec()], then the following SQL statement would
 13.3343 +** change the database file through side-effects:
 13.3344 +**
 13.3345 +** <blockquote><pre>
 13.3346 +**    SELECT eval('DELETE FROM t1') FROM t2;
 13.3347 +** </pre></blockquote>
 13.3348 +**
 13.3349 +** But because the [SELECT] statement does not change the database file
 13.3350 +** directly, sqlite3_stmt_readonly() would still return true.)^
 13.3351 +**
 13.3352 +** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK],
 13.3353 +** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true,
 13.3354 +** since the statements themselves do not actually modify the database but
 13.3355 +** rather they control the timing of when other statements modify the 
 13.3356 +** database.  ^The [ATTACH] and [DETACH] statements also cause
 13.3357 +** sqlite3_stmt_readonly() to return true since, while those statements
 13.3358 +** change the configuration of a database connection, they do not make 
 13.3359 +** changes to the content of the database files on disk.
 13.3360 +*/
 13.3361 +SQLITE_API int sqlite3_stmt_readonly(sqlite3_stmt *pStmt);
 13.3362 +
 13.3363 +/*
 13.3364 +** CAPI3REF: Determine If A Prepared Statement Has Been Reset
 13.3365 +**
 13.3366 +** ^The sqlite3_stmt_busy(S) interface returns true (non-zero) if the
 13.3367 +** [prepared statement] S has been stepped at least once using 
 13.3368 +** [sqlite3_step(S)] but has not run to completion and/or has not 
 13.3369 +** been reset using [sqlite3_reset(S)].  ^The sqlite3_stmt_busy(S)
 13.3370 +** interface returns false if S is a NULL pointer.  If S is not a 
 13.3371 +** NULL pointer and is not a pointer to a valid [prepared statement]
 13.3372 +** object, then the behavior is undefined and probably undesirable.
 13.3373 +**
 13.3374 +** This interface can be used in combination [sqlite3_next_stmt()]
 13.3375 +** to locate all prepared statements associated with a database 
 13.3376 +** connection that are in need of being reset.  This can be used,
 13.3377 +** for example, in diagnostic routines to search for prepared 
 13.3378 +** statements that are holding a transaction open.
 13.3379 +*/
 13.3380 +SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*);
 13.3381 +
 13.3382 +/*
 13.3383 +** CAPI3REF: Dynamically Typed Value Object
 13.3384 +** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value}
 13.3385 +**
 13.3386 +** SQLite uses the sqlite3_value object to represent all values
 13.3387 +** that can be stored in a database table. SQLite uses dynamic typing
 13.3388 +** for the values it stores.  ^Values stored in sqlite3_value objects
 13.3389 +** can be integers, floating point values, strings, BLOBs, or NULL.
 13.3390 +**
 13.3391 +** An sqlite3_value object may be either "protected" or "unprotected".
 13.3392 +** Some interfaces require a protected sqlite3_value.  Other interfaces
 13.3393 +** will accept either a protected or an unprotected sqlite3_value.
 13.3394 +** Every interface that accepts sqlite3_value arguments specifies
 13.3395 +** whether or not it requires a protected sqlite3_value.
 13.3396 +**
 13.3397 +** The terms "protected" and "unprotected" refer to whether or not
 13.3398 +** a mutex is held.  An internal mutex is held for a protected
 13.3399 +** sqlite3_value object but no mutex is held for an unprotected
 13.3400 +** sqlite3_value object.  If SQLite is compiled to be single-threaded
 13.3401 +** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0)
 13.3402 +** or if SQLite is run in one of reduced mutex modes 
 13.3403 +** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD]
 13.3404 +** then there is no distinction between protected and unprotected
 13.3405 +** sqlite3_value objects and they can be used interchangeably.  However,
 13.3406 +** for maximum code portability it is recommended that applications
 13.3407 +** still make the distinction between protected and unprotected
 13.3408 +** sqlite3_value objects even when not strictly required.
 13.3409 +**
 13.3410 +** ^The sqlite3_value objects that are passed as parameters into the
 13.3411 +** implementation of [application-defined SQL functions] are protected.
 13.3412 +** ^The sqlite3_value object returned by
 13.3413 +** [sqlite3_column_value()] is unprotected.
 13.3414 +** Unprotected sqlite3_value objects may only be used with
 13.3415 +** [sqlite3_result_value()] and [sqlite3_bind_value()].
 13.3416 +** The [sqlite3_value_blob | sqlite3_value_type()] family of
 13.3417 +** interfaces require protected sqlite3_value objects.
 13.3418 +*/
 13.3419 +typedef struct Mem sqlite3_value;
 13.3420 +
 13.3421 +/*
 13.3422 +** CAPI3REF: SQL Function Context Object
 13.3423 +**
 13.3424 +** The context in which an SQL function executes is stored in an
 13.3425 +** sqlite3_context object.  ^A pointer to an sqlite3_context object
 13.3426 +** is always first parameter to [application-defined SQL functions].
 13.3427 +** The application-defined SQL function implementation will pass this
 13.3428 +** pointer through into calls to [sqlite3_result_int | sqlite3_result()],
 13.3429 +** [sqlite3_aggregate_context()], [sqlite3_user_data()],
 13.3430 +** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()],
 13.3431 +** and/or [sqlite3_set_auxdata()].
 13.3432 +*/
 13.3433 +typedef struct sqlite3_context sqlite3_context;
 13.3434 +
 13.3435 +/*
 13.3436 +** CAPI3REF: Binding Values To Prepared Statements
 13.3437 +** KEYWORDS: {host parameter} {host parameters} {host parameter name}
 13.3438 +** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding}
 13.3439 +**
 13.3440 +** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants,
 13.3441 +** literals may be replaced by a [parameter] that matches one of following
 13.3442 +** templates:
 13.3443 +**
 13.3444 +** <ul>
 13.3445 +** <li>  ?
 13.3446 +** <li>  ?NNN
 13.3447 +** <li>  :VVV
 13.3448 +** <li>  @VVV
 13.3449 +** <li>  $VVV
 13.3450 +** </ul>
 13.3451 +**
 13.3452 +** In the templates above, NNN represents an integer literal,
 13.3453 +** and VVV represents an alphanumeric identifier.)^  ^The values of these
 13.3454 +** parameters (also called "host parameter names" or "SQL parameters")
 13.3455 +** can be set using the sqlite3_bind_*() routines defined here.
 13.3456 +**
 13.3457 +** ^The first argument to the sqlite3_bind_*() routines is always
 13.3458 +** a pointer to the [sqlite3_stmt] object returned from
 13.3459 +** [sqlite3_prepare_v2()] or its variants.
 13.3460 +**
 13.3461 +** ^The second argument is the index of the SQL parameter to be set.
 13.3462 +** ^The leftmost SQL parameter has an index of 1.  ^When the same named
 13.3463 +** SQL parameter is used more than once, second and subsequent
 13.3464 +** occurrences have the same index as the first occurrence.
 13.3465 +** ^The index for named parameters can be looked up using the
 13.3466 +** [sqlite3_bind_parameter_index()] API if desired.  ^The index
 13.3467 +** for "?NNN" parameters is the value of NNN.
 13.3468 +** ^The NNN value must be between 1 and the [sqlite3_limit()]
 13.3469 +** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999).
 13.3470 +**
 13.3471 +** ^The third argument is the value to bind to the parameter.
 13.3472 +** ^If the third parameter to sqlite3_bind_text() or sqlite3_bind_text16()
 13.3473 +** or sqlite3_bind_blob() is a NULL pointer then the fourth parameter
 13.3474 +** is ignored and the end result is the same as sqlite3_bind_null().
 13.3475 +**
 13.3476 +** ^(In those routines that have a fourth argument, its value is the
 13.3477 +** number of bytes in the parameter.  To be clear: the value is the
 13.3478 +** number of <u>bytes</u> in the value, not the number of characters.)^
 13.3479 +** ^If the fourth parameter to sqlite3_bind_text() or sqlite3_bind_text16()
 13.3480 +** is negative, then the length of the string is
 13.3481 +** the number of bytes up to the first zero terminator.
 13.3482 +** If the fourth parameter to sqlite3_bind_blob() is negative, then
 13.3483 +** the behavior is undefined.
 13.3484 +** If a non-negative fourth parameter is provided to sqlite3_bind_text()
 13.3485 +** or sqlite3_bind_text16() then that parameter must be the byte offset
 13.3486 +** where the NUL terminator would occur assuming the string were NUL
 13.3487 +** terminated.  If any NUL characters occur at byte offsets less than 
 13.3488 +** the value of the fourth parameter then the resulting string value will
 13.3489 +** contain embedded NULs.  The result of expressions involving strings
 13.3490 +** with embedded NULs is undefined.
 13.3491 +**
 13.3492 +** ^The fifth argument to sqlite3_bind_blob(), sqlite3_bind_text(), and
 13.3493 +** sqlite3_bind_text16() is a destructor used to dispose of the BLOB or
 13.3494 +** string after SQLite has finished with it.  ^The destructor is called
 13.3495 +** to dispose of the BLOB or string even if the call to sqlite3_bind_blob(),
 13.3496 +** sqlite3_bind_text(), or sqlite3_bind_text16() fails.  
 13.3497 +** ^If the fifth argument is
 13.3498 +** the special value [SQLITE_STATIC], then SQLite assumes that the
 13.3499 +** information is in static, unmanaged space and does not need to be freed.
 13.3500 +** ^If the fifth argument has the value [SQLITE_TRANSIENT], then
 13.3501 +** SQLite makes its own private copy of the data immediately, before
 13.3502 +** the sqlite3_bind_*() routine returns.
 13.3503 +**
 13.3504 +** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that
 13.3505 +** is filled with zeroes.  ^A zeroblob uses a fixed amount of memory
 13.3506 +** (just an integer to hold its size) while it is being processed.
 13.3507 +** Zeroblobs are intended to serve as placeholders for BLOBs whose
 13.3508 +** content is later written using
 13.3509 +** [sqlite3_blob_open | incremental BLOB I/O] routines.
 13.3510 +** ^A negative value for the zeroblob results in a zero-length BLOB.
 13.3511 +**
 13.3512 +** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer
 13.3513 +** for the [prepared statement] or with a prepared statement for which
 13.3514 +** [sqlite3_step()] has been called more recently than [sqlite3_reset()],
 13.3515 +** then the call will return [SQLITE_MISUSE].  If any sqlite3_bind_()
 13.3516 +** routine is passed a [prepared statement] that has been finalized, the
 13.3517 +** result is undefined and probably harmful.
 13.3518 +**
 13.3519 +** ^Bindings are not cleared by the [sqlite3_reset()] routine.
 13.3520 +** ^Unbound parameters are interpreted as NULL.
 13.3521 +**
 13.3522 +** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an
 13.3523 +** [error code] if anything goes wrong.
 13.3524 +** ^[SQLITE_RANGE] is returned if the parameter
 13.3525 +** index is out of range.  ^[SQLITE_NOMEM] is returned if malloc() fails.
 13.3526 +**
 13.3527 +** See also: [sqlite3_bind_parameter_count()],
 13.3528 +** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()].
 13.3529 +*/
 13.3530 +SQLITE_API int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*));
 13.3531 +SQLITE_API int sqlite3_bind_double(sqlite3_stmt*, int, double);
 13.3532 +SQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int);
 13.3533 +SQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64);
 13.3534 +SQLITE_API int sqlite3_bind_null(sqlite3_stmt*, int);
 13.3535 +SQLITE_API int sqlite3_bind_text(sqlite3_stmt*, int, const char*, int n, void(*)(void*));
 13.3536 +SQLITE_API int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*));
 13.3537 +SQLITE_API int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);
 13.3538 +SQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n);
 13.3539 +
 13.3540 +/*
 13.3541 +** CAPI3REF: Number Of SQL Parameters
 13.3542 +**
 13.3543 +** ^This routine can be used to find the number of [SQL parameters]
 13.3544 +** in a [prepared statement].  SQL parameters are tokens of the
 13.3545 +** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as
 13.3546 +** placeholders for values that are [sqlite3_bind_blob | bound]
 13.3547 +** to the parameters at a later time.
 13.3548 +**
 13.3549 +** ^(This routine actually returns the index of the largest (rightmost)
 13.3550 +** parameter. For all forms except ?NNN, this will correspond to the
 13.3551 +** number of unique parameters.  If parameters of the ?NNN form are used,
 13.3552 +** there may be gaps in the list.)^
 13.3553 +**
 13.3554 +** See also: [sqlite3_bind_blob|sqlite3_bind()],
 13.3555 +** [sqlite3_bind_parameter_name()], and
 13.3556 +** [sqlite3_bind_parameter_index()].
 13.3557 +*/
 13.3558 +SQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt*);
 13.3559 +
 13.3560 +/*
 13.3561 +** CAPI3REF: Name Of A Host Parameter
 13.3562 +**
 13.3563 +** ^The sqlite3_bind_parameter_name(P,N) interface returns
 13.3564 +** the name of the N-th [SQL parameter] in the [prepared statement] P.
 13.3565 +** ^(SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA"
 13.3566 +** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA"
 13.3567 +** respectively.
 13.3568 +** In other words, the initial ":" or "$" or "@" or "?"
 13.3569 +** is included as part of the name.)^
 13.3570 +** ^Parameters of the form "?" without a following integer have no name
 13.3571 +** and are referred to as "nameless" or "anonymous parameters".
 13.3572 +**
 13.3573 +** ^The first host parameter has an index of 1, not 0.
 13.3574 +**
 13.3575 +** ^If the value N is out of range or if the N-th parameter is
 13.3576 +** nameless, then NULL is returned.  ^The returned string is
 13.3577 +** always in UTF-8 encoding even if the named parameter was
 13.3578 +** originally specified as UTF-16 in [sqlite3_prepare16()] or
 13.3579 +** [sqlite3_prepare16_v2()].
 13.3580 +**
 13.3581 +** See also: [sqlite3_bind_blob|sqlite3_bind()],
 13.3582 +** [sqlite3_bind_parameter_count()], and
 13.3583 +** [sqlite3_bind_parameter_index()].
 13.3584 +*/
 13.3585 +SQLITE_API const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int);
 13.3586 +
 13.3587 +/*
 13.3588 +** CAPI3REF: Index Of A Parameter With A Given Name
 13.3589 +**
 13.3590 +** ^Return the index of an SQL parameter given its name.  ^The
 13.3591 +** index value returned is suitable for use as the second
 13.3592 +** parameter to [sqlite3_bind_blob|sqlite3_bind()].  ^A zero
 13.3593 +** is returned if no matching parameter is found.  ^The parameter
 13.3594 +** name must be given in UTF-8 even if the original statement
 13.3595 +** was prepared from UTF-16 text using [sqlite3_prepare16_v2()].
 13.3596 +**
 13.3597 +** See also: [sqlite3_bind_blob|sqlite3_bind()],
 13.3598 +** [sqlite3_bind_parameter_count()], and
 13.3599 +** [sqlite3_bind_parameter_index()].
 13.3600 +*/
 13.3601 +SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName);
 13.3602 +
 13.3603 +/*
 13.3604 +** CAPI3REF: Reset All Bindings On A Prepared Statement
 13.3605 +**
 13.3606 +** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset
 13.3607 +** the [sqlite3_bind_blob | bindings] on a [prepared statement].
 13.3608 +** ^Use this routine to reset all host parameters to NULL.
 13.3609 +*/
 13.3610 +SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*);
 13.3611 +
 13.3612 +/*
 13.3613 +** CAPI3REF: Number Of Columns In A Result Set
 13.3614 +**
 13.3615 +** ^Return the number of columns in the result set returned by the
 13.3616 +** [prepared statement]. ^This routine returns 0 if pStmt is an SQL
 13.3617 +** statement that does not return data (for example an [UPDATE]).
 13.3618 +**
 13.3619 +** See also: [sqlite3_data_count()]
 13.3620 +*/
 13.3621 +SQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt);
 13.3622 +
 13.3623 +/*
 13.3624 +** CAPI3REF: Column Names In A Result Set
 13.3625 +**
 13.3626 +** ^These routines return the name assigned to a particular column
 13.3627 +** in the result set of a [SELECT] statement.  ^The sqlite3_column_name()
 13.3628 +** interface returns a pointer to a zero-terminated UTF-8 string
 13.3629 +** and sqlite3_column_name16() returns a pointer to a zero-terminated
 13.3630 +** UTF-16 string.  ^The first parameter is the [prepared statement]
 13.3631 +** that implements the [SELECT] statement. ^The second parameter is the
 13.3632 +** column number.  ^The leftmost column is number 0.
 13.3633 +**
 13.3634 +** ^The returned string pointer is valid until either the [prepared statement]
 13.3635 +** is destroyed by [sqlite3_finalize()] or until the statement is automatically
 13.3636 +** reprepared by the first call to [sqlite3_step()] for a particular run
 13.3637 +** or until the next call to
 13.3638 +** sqlite3_column_name() or sqlite3_column_name16() on the same column.
 13.3639 +**
 13.3640 +** ^If sqlite3_malloc() fails during the processing of either routine
 13.3641 +** (for example during a conversion from UTF-8 to UTF-16) then a
 13.3642 +** NULL pointer is returned.
 13.3643 +**
 13.3644 +** ^The name of a result column is the value of the "AS" clause for
 13.3645 +** that column, if there is an AS clause.  If there is no AS clause
 13.3646 +** then the name of the column is unspecified and may change from
 13.3647 +** one release of SQLite to the next.
 13.3648 +*/
 13.3649 +SQLITE_API const char *sqlite3_column_name(sqlite3_stmt*, int N);
 13.3650 +SQLITE_API const void *sqlite3_column_name16(sqlite3_stmt*, int N);
 13.3651 +
 13.3652 +/*
 13.3653 +** CAPI3REF: Source Of Data In A Query Result
 13.3654 +**
 13.3655 +** ^These routines provide a means to determine the database, table, and
 13.3656 +** table column that is the origin of a particular result column in
 13.3657 +** [SELECT] statement.
 13.3658 +** ^The name of the database or table or column can be returned as
 13.3659 +** either a UTF-8 or UTF-16 string.  ^The _database_ routines return
 13.3660 +** the database name, the _table_ routines return the table name, and
 13.3661 +** the origin_ routines return the column name.
 13.3662 +** ^The returned string is valid until the [prepared statement] is destroyed
 13.3663 +** using [sqlite3_finalize()] or until the statement is automatically
 13.3664 +** reprepared by the first call to [sqlite3_step()] for a particular run
 13.3665 +** or until the same information is requested
 13.3666 +** again in a different encoding.
 13.3667 +**
 13.3668 +** ^The names returned are the original un-aliased names of the
 13.3669 +** database, table, and column.
 13.3670 +**
 13.3671 +** ^The first argument to these interfaces is a [prepared statement].
 13.3672 +** ^These functions return information about the Nth result column returned by
 13.3673 +** the statement, where N is the second function argument.
 13.3674 +** ^The left-most column is column 0 for these routines.
 13.3675 +**
 13.3676 +** ^If the Nth column returned by the statement is an expression or
 13.3677 +** subquery and is not a column value, then all of these functions return
 13.3678 +** NULL.  ^These routine might also return NULL if a memory allocation error
 13.3679 +** occurs.  ^Otherwise, they return the name of the attached database, table,
 13.3680 +** or column that query result column was extracted from.
 13.3681 +**
 13.3682 +** ^As with all other SQLite APIs, those whose names end with "16" return
 13.3683 +** UTF-16 encoded strings and the other functions return UTF-8.
 13.3684 +**
 13.3685 +** ^These APIs are only available if the library was compiled with the
 13.3686 +** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol.
 13.3687 +**
 13.3688 +** If two or more threads call one or more of these routines against the same
 13.3689 +** prepared statement and column at the same time then the results are
 13.3690 +** undefined.
 13.3691 +**
 13.3692 +** If two or more threads call one or more
 13.3693 +** [sqlite3_column_database_name | column metadata interfaces]
 13.3694 +** for the same [prepared statement] and result column
 13.3695 +** at the same time then the results are undefined.
 13.3696 +*/
 13.3697 +SQLITE_API const char *sqlite3_column_database_name(sqlite3_stmt*,int);
 13.3698 +SQLITE_API const void *sqlite3_column_database_name16(sqlite3_stmt*,int);
 13.3699 +SQLITE_API const char *sqlite3_column_table_name(sqlite3_stmt*,int);
 13.3700 +SQLITE_API const void *sqlite3_column_table_name16(sqlite3_stmt*,int);
 13.3701 +SQLITE_API const char *sqlite3_column_origin_name(sqlite3_stmt*,int);
 13.3702 +SQLITE_API const void *sqlite3_column_origin_name16(sqlite3_stmt*,int);
 13.3703 +
 13.3704 +/*
 13.3705 +** CAPI3REF: Declared Datatype Of A Query Result
 13.3706 +**
 13.3707 +** ^(The first parameter is a [prepared statement].
 13.3708 +** If this statement is a [SELECT] statement and the Nth column of the
 13.3709 +** returned result set of that [SELECT] is a table column (not an
 13.3710 +** expression or subquery) then the declared type of the table
 13.3711 +** column is returned.)^  ^If the Nth column of the result set is an
 13.3712 +** expression or subquery, then a NULL pointer is returned.
 13.3713 +** ^The returned string is always UTF-8 encoded.
 13.3714 +**
 13.3715 +** ^(For example, given the database schema:
 13.3716 +**
 13.3717 +** CREATE TABLE t1(c1 VARIANT);
 13.3718 +**
 13.3719 +** and the following statement to be compiled:
 13.3720 +**
 13.3721 +** SELECT c1 + 1, c1 FROM t1;
 13.3722 +**
 13.3723 +** this routine would return the string "VARIANT" for the second result
 13.3724 +** column (i==1), and a NULL pointer for the first result column (i==0).)^
 13.3725 +**
 13.3726 +** ^SQLite uses dynamic run-time typing.  ^So just because a column
 13.3727 +** is declared to contain a particular type does not mean that the
 13.3728 +** data stored in that column is of the declared type.  SQLite is
 13.3729 +** strongly typed, but the typing is dynamic not static.  ^Type
 13.3730 +** is associated with individual values, not with the containers
 13.3731 +** used to hold those values.
 13.3732 +*/
 13.3733 +SQLITE_API const char *sqlite3_column_decltype(sqlite3_stmt*,int);
 13.3734 +SQLITE_API const void *sqlite3_column_decltype16(sqlite3_stmt*,int);
 13.3735 +
 13.3736 +/*
 13.3737 +** CAPI3REF: Evaluate An SQL Statement
 13.3738 +**
 13.3739 +** After a [prepared statement] has been prepared using either
 13.3740 +** [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] or one of the legacy
 13.3741 +** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function
 13.3742 +** must be called one or more times to evaluate the statement.
 13.3743 +**
 13.3744 +** The details of the behavior of the sqlite3_step() interface depend
 13.3745 +** on whether the statement was prepared using the newer "v2" interface
 13.3746 +** [sqlite3_prepare_v2()] and [sqlite3_prepare16_v2()] or the older legacy
 13.3747 +** interface [sqlite3_prepare()] and [sqlite3_prepare16()].  The use of the
 13.3748 +** new "v2" interface is recommended for new applications but the legacy
 13.3749 +** interface will continue to be supported.
 13.3750 +**
 13.3751 +** ^In the legacy interface, the return value will be either [SQLITE_BUSY],
 13.3752 +** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE].
 13.3753 +** ^With the "v2" interface, any of the other [result codes] or
 13.3754 +** [extended result codes] might be returned as well.
 13.3755 +**
 13.3756 +** ^[SQLITE_BUSY] means that the database engine was unable to acquire the
 13.3757 +** database locks it needs to do its job.  ^If the statement is a [COMMIT]
 13.3758 +** or occurs outside of an explicit transaction, then you can retry the
 13.3759 +** statement.  If the statement is not a [COMMIT] and occurs within an
 13.3760 +** explicit transaction then you should rollback the transaction before
 13.3761 +** continuing.
 13.3762 +**
 13.3763 +** ^[SQLITE_DONE] means that the statement has finished executing
 13.3764 +** successfully.  sqlite3_step() should not be called again on this virtual
 13.3765 +** machine without first calling [sqlite3_reset()] to reset the virtual
 13.3766 +** machine back to its initial state.
 13.3767 +**
 13.3768 +** ^If the SQL statement being executed returns any data, then [SQLITE_ROW]
 13.3769 +** is returned each time a new row of data is ready for processing by the
 13.3770 +** caller. The values may be accessed using the [column access functions].
 13.3771 +** sqlite3_step() is called again to retrieve the next row of data.
 13.3772 +**
 13.3773 +** ^[SQLITE_ERROR] means that a run-time error (such as a constraint
 13.3774 +** violation) has occurred.  sqlite3_step() should not be called again on
 13.3775 +** the VM. More information may be found by calling [sqlite3_errmsg()].
 13.3776 +** ^With the legacy interface, a more specific error code (for example,
 13.3777 +** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth)
 13.3778 +** can be obtained by calling [sqlite3_reset()] on the
 13.3779 +** [prepared statement].  ^In the "v2" interface,
 13.3780 +** the more specific error code is returned directly by sqlite3_step().
 13.3781 +**
 13.3782 +** [SQLITE_MISUSE] means that the this routine was called inappropriately.
 13.3783 +** Perhaps it was called on a [prepared statement] that has
 13.3784 +** already been [sqlite3_finalize | finalized] or on one that had
 13.3785 +** previously returned [SQLITE_ERROR] or [SQLITE_DONE].  Or it could
 13.3786 +** be the case that the same database connection is being used by two or
 13.3787 +** more threads at the same moment in time.
 13.3788 +**
 13.3789 +** For all versions of SQLite up to and including 3.6.23.1, a call to
 13.3790 +** [sqlite3_reset()] was required after sqlite3_step() returned anything
 13.3791 +** other than [SQLITE_ROW] before any subsequent invocation of
 13.3792 +** sqlite3_step().  Failure to reset the prepared statement using 
 13.3793 +** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from
 13.3794 +** sqlite3_step().  But after version 3.6.23.1, sqlite3_step() began
 13.3795 +** calling [sqlite3_reset()] automatically in this circumstance rather
 13.3796 +** than returning [SQLITE_MISUSE].  This is not considered a compatibility
 13.3797 +** break because any application that ever receives an SQLITE_MISUSE error
 13.3798 +** is broken by definition.  The [SQLITE_OMIT_AUTORESET] compile-time option
 13.3799 +** can be used to restore the legacy behavior.
 13.3800 +**
 13.3801 +** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step()
 13.3802 +** API always returns a generic error code, [SQLITE_ERROR], following any
 13.3803 +** error other than [SQLITE_BUSY] and [SQLITE_MISUSE].  You must call
 13.3804 +** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the
 13.3805 +** specific [error codes] that better describes the error.
 13.3806 +** We admit that this is a goofy design.  The problem has been fixed
 13.3807 +** with the "v2" interface.  If you prepare all of your SQL statements
 13.3808 +** using either [sqlite3_prepare_v2()] or [sqlite3_prepare16_v2()] instead
 13.3809 +** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces,
 13.3810 +** then the more specific [error codes] are returned directly
 13.3811 +** by sqlite3_step().  The use of the "v2" interface is recommended.
 13.3812 +*/
 13.3813 +SQLITE_API int sqlite3_step(sqlite3_stmt*);
 13.3814 +
 13.3815 +/*
 13.3816 +** CAPI3REF: Number of columns in a result set
 13.3817 +**
 13.3818 +** ^The sqlite3_data_count(P) interface returns the number of columns in the
 13.3819 +** current row of the result set of [prepared statement] P.
 13.3820 +** ^If prepared statement P does not have results ready to return
 13.3821 +** (via calls to the [sqlite3_column_int | sqlite3_column_*()] of
 13.3822 +** interfaces) then sqlite3_data_count(P) returns 0.
 13.3823 +** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer.
 13.3824 +** ^The sqlite3_data_count(P) routine returns 0 if the previous call to
 13.3825 +** [sqlite3_step](P) returned [SQLITE_DONE].  ^The sqlite3_data_count(P)
 13.3826 +** will return non-zero if previous call to [sqlite3_step](P) returned
 13.3827 +** [SQLITE_ROW], except in the case of the [PRAGMA incremental_vacuum]
 13.3828 +** where it always returns zero since each step of that multi-step
 13.3829 +** pragma returns 0 columns of data.
 13.3830 +**
 13.3831 +** See also: [sqlite3_column_count()]
 13.3832 +*/
 13.3833 +SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt);
 13.3834 +
 13.3835 +/*
 13.3836 +** CAPI3REF: Fundamental Datatypes
 13.3837 +** KEYWORDS: SQLITE_TEXT
 13.3838 +**
 13.3839 +** ^(Every value in SQLite has one of five fundamental datatypes:
 13.3840 +**
 13.3841 +** <ul>
 13.3842 +** <li> 64-bit signed integer
 13.3843 +** <li> 64-bit IEEE floating point number
 13.3844 +** <li> string
 13.3845 +** <li> BLOB
 13.3846 +** <li> NULL
 13.3847 +** </ul>)^
 13.3848 +**
 13.3849 +** These constants are codes for each of those types.
 13.3850 +**
 13.3851 +** Note that the SQLITE_TEXT constant was also used in SQLite version 2
 13.3852 +** for a completely different meaning.  Software that links against both
 13.3853 +** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not
 13.3854 +** SQLITE_TEXT.
 13.3855 +*/
 13.3856 +#define SQLITE_INTEGER  1
 13.3857 +#define SQLITE_FLOAT    2
 13.3858 +#define SQLITE_BLOB     4
 13.3859 +#define SQLITE_NULL     5
 13.3860 +#ifdef SQLITE_TEXT
 13.3861 +# undef SQLITE_TEXT
 13.3862 +#else
 13.3863 +# define SQLITE_TEXT     3
 13.3864 +#endif
 13.3865 +#define SQLITE3_TEXT     3
 13.3866 +
 13.3867 +/*
 13.3868 +** CAPI3REF: Result Values From A Query
 13.3869 +** KEYWORDS: {column access functions}
 13.3870 +**
 13.3871 +** These routines form the "result set" interface.
 13.3872 +**
 13.3873 +** ^These routines return information about a single column of the current
 13.3874 +** result row of a query.  ^In every case the first argument is a pointer
 13.3875 +** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*]
 13.3876 +** that was returned from [sqlite3_prepare_v2()] or one of its variants)
 13.3877 +** and the second argument is the index of the column for which information
 13.3878 +** should be returned. ^The leftmost column of the result set has the index 0.
 13.3879 +** ^The number of columns in the result can be determined using
 13.3880 +** [sqlite3_column_count()].
 13.3881 +**
 13.3882 +** If the SQL statement does not currently point to a valid row, or if the
 13.3883 +** column index is out of range, the result is undefined.
 13.3884 +** These routines may only be called when the most recent call to
 13.3885 +** [sqlite3_step()] has returned [SQLITE_ROW] and neither
 13.3886 +** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently.
 13.3887 +** If any of these routines are called after [sqlite3_reset()] or
 13.3888 +** [sqlite3_finalize()] or after [sqlite3_step()] has returned
 13.3889 +** something other than [SQLITE_ROW], the results are undefined.
 13.3890 +** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()]
 13.3891 +** are called from a different thread while any of these routines
 13.3892 +** are pending, then the results are undefined.
 13.3893 +**
 13.3894 +** ^The sqlite3_column_type() routine returns the
 13.3895 +** [SQLITE_INTEGER | datatype code] for the initial data type
 13.3896 +** of the result column.  ^The returned value is one of [SQLITE_INTEGER],
 13.3897 +** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL].  The value
 13.3898 +** returned by sqlite3_column_type() is only meaningful if no type
 13.3899 +** conversions have occurred as described below.  After a type conversion,
 13.3900 +** the value returned by sqlite3_column_type() is undefined.  Future
 13.3901 +** versions of SQLite may change the behavior of sqlite3_column_type()
 13.3902 +** following a type conversion.
 13.3903 +**
 13.3904 +** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes()
 13.3905 +** routine returns the number of bytes in that BLOB or string.
 13.3906 +** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts
 13.3907 +** the string to UTF-8 and then returns the number of bytes.
 13.3908 +** ^If the result is a numeric value then sqlite3_column_bytes() uses
 13.3909 +** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns
 13.3910 +** the number of bytes in that string.
 13.3911 +** ^If the result is NULL, then sqlite3_column_bytes() returns zero.
 13.3912 +**
 13.3913 +** ^If the result is a BLOB or UTF-16 string then the sqlite3_column_bytes16()
 13.3914 +** routine returns the number of bytes in that BLOB or string.
 13.3915 +** ^If the result is a UTF-8 string, then sqlite3_column_bytes16() converts
 13.3916 +** the string to UTF-16 and then returns the number of bytes.
 13.3917 +** ^If the result is a numeric value then sqlite3_column_bytes16() uses
 13.3918 +** [sqlite3_snprintf()] to convert that value to a UTF-16 string and returns
 13.3919 +** the number of bytes in that string.
 13.3920 +** ^If the result is NULL, then sqlite3_column_bytes16() returns zero.
 13.3921 +**
 13.3922 +** ^The values returned by [sqlite3_column_bytes()] and 
 13.3923 +** [sqlite3_column_bytes16()] do not include the zero terminators at the end
 13.3924 +** of the string.  ^For clarity: the values returned by
 13.3925 +** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of
 13.3926 +** bytes in the string, not the number of characters.
 13.3927 +**
 13.3928 +** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(),
 13.3929 +** even empty strings, are always zero-terminated.  ^The return
 13.3930 +** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer.
 13.3931 +**
 13.3932 +** ^The object returned by [sqlite3_column_value()] is an
 13.3933 +** [unprotected sqlite3_value] object.  An unprotected sqlite3_value object
 13.3934 +** may only be used with [sqlite3_bind_value()] and [sqlite3_result_value()].
 13.3935 +** If the [unprotected sqlite3_value] object returned by
 13.3936 +** [sqlite3_column_value()] is used in any other way, including calls
 13.3937 +** to routines like [sqlite3_value_int()], [sqlite3_value_text()],
 13.3938 +** or [sqlite3_value_bytes()], then the behavior is undefined.
 13.3939 +**
 13.3940 +** These routines attempt to convert the value where appropriate.  ^For
 13.3941 +** example, if the internal representation is FLOAT and a text result
 13.3942 +** is requested, [sqlite3_snprintf()] is used internally to perform the
 13.3943 +** conversion automatically.  ^(The following table details the conversions
 13.3944 +** that are applied:
 13.3945 +**
 13.3946 +** <blockquote>
 13.3947 +** <table border="1">
 13.3948 +** <tr><th> Internal<br>Type <th> Requested<br>Type <th>  Conversion
 13.3949 +**
 13.3950 +** <tr><td>  NULL    <td> INTEGER   <td> Result is 0
 13.3951 +** <tr><td>  NULL    <td>  FLOAT    <td> Result is 0.0
 13.3952 +** <tr><td>  NULL    <td>   TEXT    <td> Result is a NULL pointer
 13.3953 +** <tr><td>  NULL    <td>   BLOB    <td> Result is a NULL pointer
 13.3954 +** <tr><td> INTEGER  <td>  FLOAT    <td> Convert from integer to float
 13.3955 +** <tr><td> INTEGER  <td>   TEXT    <td> ASCII rendering of the integer
 13.3956 +** <tr><td> INTEGER  <td>   BLOB    <td> Same as INTEGER->TEXT
 13.3957 +** <tr><td>  FLOAT   <td> INTEGER   <td> [CAST] to INTEGER
 13.3958 +** <tr><td>  FLOAT   <td>   TEXT    <td> ASCII rendering of the float
 13.3959 +** <tr><td>  FLOAT   <td>   BLOB    <td> [CAST] to BLOB
 13.3960 +** <tr><td>  TEXT    <td> INTEGER   <td> [CAST] to INTEGER
 13.3961 +** <tr><td>  TEXT    <td>  FLOAT    <td> [CAST] to REAL
 13.3962 +** <tr><td>  TEXT    <td>   BLOB    <td> No change
 13.3963 +** <tr><td>  BLOB    <td> INTEGER   <td> [CAST] to INTEGER
 13.3964 +** <tr><td>  BLOB    <td>  FLOAT    <td> [CAST] to REAL
 13.3965 +** <tr><td>  BLOB    <td>   TEXT    <td> Add a zero terminator if needed
 13.3966 +** </table>
 13.3967 +** </blockquote>)^
 13.3968 +**
 13.3969 +** The table above makes reference to standard C library functions atoi()
 13.3970 +** and atof().  SQLite does not really use these functions.  It has its
 13.3971 +** own equivalent internal routines.  The atoi() and atof() names are
 13.3972 +** used in the table for brevity and because they are familiar to most
 13.3973 +** C programmers.
 13.3974 +**
 13.3975 +** Note that when type conversions occur, pointers returned by prior
 13.3976 +** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or
 13.3977 +** sqlite3_column_text16() may be invalidated.
 13.3978 +** Type conversions and pointer invalidations might occur
 13.3979 +** in the following cases:
 13.3980 +**
 13.3981 +** <ul>
 13.3982 +** <li> The initial content is a BLOB and sqlite3_column_text() or
 13.3983 +**      sqlite3_column_text16() is called.  A zero-terminator might
 13.3984 +**      need to be added to the string.</li>
 13.3985 +** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or
 13.3986 +**      sqlite3_column_text16() is called.  The content must be converted
 13.3987 +**      to UTF-16.</li>
 13.3988 +** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or
 13.3989 +**      sqlite3_column_text() is called.  The content must be converted
 13.3990 +**      to UTF-8.</li>
 13.3991 +** </ul>
 13.3992 +**
 13.3993 +** ^Conversions between UTF-16be and UTF-16le are always done in place and do
 13.3994 +** not invalidate a prior pointer, though of course the content of the buffer
 13.3995 +** that the prior pointer references will have been modified.  Other kinds
 13.3996 +** of conversion are done in place when it is possible, but sometimes they
 13.3997 +** are not possible and in those cases prior pointers are invalidated.
 13.3998 +**
 13.3999 +** The safest and easiest to remember policy is to invoke these routines
 13.4000 +** in one of the following ways:
 13.4001 +**
 13.4002 +** <ul>
 13.4003 +**  <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li>
 13.4004 +**  <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li>
 13.4005 +**  <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li>
 13.4006 +** </ul>
 13.4007 +**
 13.4008 +** In other words, you should call sqlite3_column_text(),
 13.4009 +** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result
 13.4010 +** into the desired format, then invoke sqlite3_column_bytes() or
 13.4011 +** sqlite3_column_bytes16() to find the size of the result.  Do not mix calls
 13.4012 +** to sqlite3_column_text() or sqlite3_column_blob() with calls to
 13.4013 +** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16()
 13.4014 +** with calls to sqlite3_column_bytes().
 13.4015 +**
 13.4016 +** ^The pointers returned are valid until a type conversion occurs as
 13.4017 +** described above, or until [sqlite3_step()] or [sqlite3_reset()] or
 13.4018 +** [sqlite3_finalize()] is called.  ^The memory space used to hold strings
 13.4019 +** and BLOBs is freed automatically.  Do <b>not</b> pass the pointers returned
 13.4020 +** from [sqlite3_column_blob()], [sqlite3_column_text()], etc. into
 13.4021 +** [sqlite3_free()].
 13.4022 +**
 13.4023 +** ^(If a memory allocation error occurs during the evaluation of any
 13.4024 +** of these routines, a default value is returned.  The default value
 13.4025 +** is either the integer 0, the floating point number 0.0, or a NULL
 13.4026 +** pointer.  Subsequent calls to [sqlite3_errcode()] will return
 13.4027 +** [SQLITE_NOMEM].)^
 13.4028 +*/
 13.4029 +SQLITE_API const void *sqlite3_column_blob(sqlite3_stmt*, int iCol);
 13.4030 +SQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
 13.4031 +SQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
 13.4032 +SQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol);
 13.4033 +SQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol);
 13.4034 +SQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol);
 13.4035 +SQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol);
 13.4036 +SQLITE_API const void *sqlite3_column_text16(sqlite3_stmt*, int iCol);
 13.4037 +SQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol);
 13.4038 +SQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol);
 13.4039 +
 13.4040 +/*
 13.4041 +** CAPI3REF: Destroy A Prepared Statement Object
 13.4042 +**
 13.4043 +** ^The sqlite3_finalize() function is called to delete a [prepared statement].
 13.4044 +** ^If the most recent evaluation of the statement encountered no errors
 13.4045 +** or if the statement is never been evaluated, then sqlite3_finalize() returns
 13.4046 +** SQLITE_OK.  ^If the most recent evaluation of statement S failed, then
 13.4047 +** sqlite3_finalize(S) returns the appropriate [error code] or
 13.4048 +** [extended error code].
 13.4049 +**
 13.4050 +** ^The sqlite3_finalize(S) routine can be called at any point during
 13.4051 +** the life cycle of [prepared statement] S:
 13.4052 +** before statement S is ever evaluated, after
 13.4053 +** one or more calls to [sqlite3_reset()], or after any call
 13.4054 +** to [sqlite3_step()] regardless of whether or not the statement has
 13.4055 +** completed execution.
 13.4056 +**
 13.4057 +** ^Invoking sqlite3_finalize() on a NULL pointer is a harmless no-op.
 13.4058 +**
 13.4059 +** The application must finalize every [prepared statement] in order to avoid
 13.4060 +** resource leaks.  It is a grievous error for the application to try to use
 13.4061 +** a prepared statement after it has been finalized.  Any use of a prepared
 13.4062 +** statement after it has been finalized can result in undefined and
 13.4063 +** undesirable behavior such as segfaults and heap corruption.
 13.4064 +*/
 13.4065 +SQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt);
 13.4066 +
 13.4067 +/*
 13.4068 +** CAPI3REF: Reset A Prepared Statement Object
 13.4069 +**
 13.4070 +** The sqlite3_reset() function is called to reset a [prepared statement]
 13.4071 +** object back to its initial state, ready to be re-executed.
 13.4072 +** ^Any SQL statement variables that had values bound to them using
 13.4073 +** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values.
 13.4074 +** Use [sqlite3_clear_bindings()] to reset the bindings.
 13.4075 +**
 13.4076 +** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S
 13.4077 +** back to the beginning of its program.
 13.4078 +**
 13.4079 +** ^If the most recent call to [sqlite3_step(S)] for the
 13.4080 +** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE],
 13.4081 +** or if [sqlite3_step(S)] has never before been called on S,
 13.4082 +** then [sqlite3_reset(S)] returns [SQLITE_OK].
 13.4083 +**
 13.4084 +** ^If the most recent call to [sqlite3_step(S)] for the
 13.4085 +** [prepared statement] S indicated an error, then
 13.4086 +** [sqlite3_reset(S)] returns an appropriate [error code].
 13.4087 +**
 13.4088 +** ^The [sqlite3_reset(S)] interface does not change the values
 13.4089 +** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S.
 13.4090 +*/
 13.4091 +SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
 13.4092 +
 13.4093 +/*
 13.4094 +** CAPI3REF: Create Or Redefine SQL Functions
 13.4095 +** KEYWORDS: {function creation routines}
 13.4096 +** KEYWORDS: {application-defined SQL function}
 13.4097 +** KEYWORDS: {application-defined SQL functions}
 13.4098 +**
 13.4099 +** ^These functions (collectively known as "function creation routines")
 13.4100 +** are used to add SQL functions or aggregates or to redefine the behavior
 13.4101 +** of existing SQL functions or aggregates.  The only differences between
 13.4102 +** these routines are the text encoding expected for
 13.4103 +** the second parameter (the name of the function being created)
 13.4104 +** and the presence or absence of a destructor callback for
 13.4105 +** the application data pointer.
 13.4106 +**
 13.4107 +** ^The first parameter is the [database connection] to which the SQL
 13.4108 +** function is to be added.  ^If an application uses more than one database
 13.4109 +** connection then application-defined SQL functions must be added
 13.4110 +** to each database connection separately.
 13.4111 +**
 13.4112 +** ^The second parameter is the name of the SQL function to be created or
 13.4113 +** redefined.  ^The length of the name is limited to 255 bytes in a UTF-8
 13.4114 +** representation, exclusive of the zero-terminator.  ^Note that the name
 13.4115 +** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes.  
 13.4116 +** ^Any attempt to create a function with a longer name
 13.4117 +** will result in [SQLITE_MISUSE] being returned.
 13.4118 +**
 13.4119 +** ^The third parameter (nArg)
 13.4120 +** is the number of arguments that the SQL function or
 13.4121 +** aggregate takes. ^If this parameter is -1, then the SQL function or
 13.4122 +** aggregate may take any number of arguments between 0 and the limit
 13.4123 +** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]).  If the third
 13.4124 +** parameter is less than -1 or greater than 127 then the behavior is
 13.4125 +** undefined.
 13.4126 +**
 13.4127 +** ^The fourth parameter, eTextRep, specifies what
 13.4128 +** [SQLITE_UTF8 | text encoding] this SQL function prefers for
 13.4129 +** its parameters.  The application should set this parameter to
 13.4130 +** [SQLITE_UTF16LE] if the function implementation invokes 
 13.4131 +** [sqlite3_value_text16le()] on an input, or [SQLITE_UTF16BE] if the
 13.4132 +** implementation invokes [sqlite3_value_text16be()] on an input, or
 13.4133 +** [SQLITE_UTF16] if [sqlite3_value_text16()] is used, or [SQLITE_UTF8]
 13.4134 +** otherwise.  ^The same SQL function may be registered multiple times using
 13.4135 +** different preferred text encodings, with different implementations for
 13.4136 +** each encoding.
 13.4137 +** ^When multiple implementations of the same function are available, SQLite
 13.4138 +** will pick the one that involves the least amount of data conversion.
 13.4139 +**
 13.4140 +** ^The fourth parameter may optionally be ORed with [SQLITE_DETERMINISTIC]
 13.4141 +** to signal that the function will always return the same result given
 13.4142 +** the same inputs within a single SQL statement.  Most SQL functions are
 13.4143 +** deterministic.  The built-in [random()] SQL function is an example of a
 13.4144 +** function that is not deterministic.  The SQLite query planner is able to
 13.4145 +** perform additional optimizations on deterministic functions, so use
 13.4146 +** of the [SQLITE_DETERMINISTIC] flag is recommended where possible.
 13.4147 +**
 13.4148 +** ^(The fifth parameter is an arbitrary pointer.  The implementation of the
 13.4149 +** function can gain access to this pointer using [sqlite3_user_data()].)^
 13.4150 +**
 13.4151 +** ^The sixth, seventh and eighth parameters, xFunc, xStep and xFinal, are
 13.4152 +** pointers to C-language functions that implement the SQL function or
 13.4153 +** aggregate. ^A scalar SQL function requires an implementation of the xFunc
 13.4154 +** callback only; NULL pointers must be passed as the xStep and xFinal
 13.4155 +** parameters. ^An aggregate SQL function requires an implementation of xStep
 13.4156 +** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing
 13.4157 +** SQL function or aggregate, pass NULL pointers for all three function
 13.4158 +** callbacks.
 13.4159 +**
 13.4160 +** ^(If the ninth parameter to sqlite3_create_function_v2() is not NULL,
 13.4161 +** then it is destructor for the application data pointer. 
 13.4162 +** The destructor is invoked when the function is deleted, either by being
 13.4163 +** overloaded or when the database connection closes.)^
 13.4164 +** ^The destructor is also invoked if the call to
 13.4165 +** sqlite3_create_function_v2() fails.
 13.4166 +** ^When the destructor callback of the tenth parameter is invoked, it
 13.4167 +** is passed a single argument which is a copy of the application data 
 13.4168 +** pointer which was the fifth parameter to sqlite3_create_function_v2().
 13.4169 +**
 13.4170 +** ^It is permitted to register multiple implementations of the same
 13.4171 +** functions with the same name but with either differing numbers of
 13.4172 +** arguments or differing preferred text encodings.  ^SQLite will use
 13.4173 +** the implementation that most closely matches the way in which the
 13.4174 +** SQL function is used.  ^A function implementation with a non-negative
 13.4175 +** nArg parameter is a better match than a function implementation with
 13.4176 +** a negative nArg.  ^A function where the preferred text encoding
 13.4177 +** matches the database encoding is a better
 13.4178 +** match than a function where the encoding is different.  
 13.4179 +** ^A function where the encoding difference is between UTF16le and UTF16be
 13.4180 +** is a closer match than a function where the encoding difference is
 13.4181 +** between UTF8 and UTF16.
 13.4182 +**
 13.4183 +** ^Built-in functions may be overloaded by new application-defined functions.
 13.4184 +**
 13.4185 +** ^An application-defined function is permitted to call other
 13.4186 +** SQLite interfaces.  However, such calls must not
 13.4187 +** close the database connection nor finalize or reset the prepared
 13.4188 +** statement in which the function is running.
 13.4189 +*/
 13.4190 +SQLITE_API int sqlite3_create_function(
 13.4191 +  sqlite3 *db,
 13.4192 +  const char *zFunctionName,
 13.4193 +  int nArg,
 13.4194 +  int eTextRep,
 13.4195 +  void *pApp,
 13.4196 +  void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
 13.4197 +  void (*xStep)(sqlite3_context*,int,sqlite3_value**),
 13.4198 +  void (*xFinal)(sqlite3_context*)
 13.4199 +);
 13.4200 +SQLITE_API int sqlite3_create_function16(
 13.4201 +  sqlite3 *db,
 13.4202 +  const void *zFunctionName,
 13.4203 +  int nArg,
 13.4204 +  int eTextRep,
 13.4205 +  void *pApp,
 13.4206 +  void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
 13.4207 +  void (*xStep)(sqlite3_context*,int,sqlite3_value**),
 13.4208 +  void (*xFinal)(sqlite3_context*)
 13.4209 +);
 13.4210 +SQLITE_API int sqlite3_create_function_v2(
 13.4211 +  sqlite3 *db,
 13.4212 +  const char *zFunctionName,
 13.4213 +  int nArg,
 13.4214 +  int eTextRep,
 13.4215 +  void *pApp,
 13.4216 +  void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
 13.4217 +  void (*xStep)(sqlite3_context*,int,sqlite3_value**),
 13.4218 +  void (*xFinal)(sqlite3_context*),
 13.4219 +  void(*xDestroy)(void*)
 13.4220 +);
 13.4221 +
 13.4222 +/*
 13.4223 +** CAPI3REF: Text Encodings
 13.4224 +**
 13.4225 +** These constant define integer codes that represent the various
 13.4226 +** text encodings supported by SQLite.
 13.4227 +*/
 13.4228 +#define SQLITE_UTF8           1
 13.4229 +#define SQLITE_UTF16LE        2
 13.4230 +#define SQLITE_UTF16BE        3
 13.4231 +#define SQLITE_UTF16          4    /* Use native byte order */
 13.4232 +#define SQLITE_ANY            5    /* Deprecated */
 13.4233 +#define SQLITE_UTF16_ALIGNED  8    /* sqlite3_create_collation only */
 13.4234 +
 13.4235 +/*
 13.4236 +** CAPI3REF: Function Flags
 13.4237 +**
 13.4238 +** These constants may be ORed together with the 
 13.4239 +** [SQLITE_UTF8 | preferred text encoding] as the fourth argument
 13.4240 +** to [sqlite3_create_function()], [sqlite3_create_function16()], or
 13.4241 +** [sqlite3_create_function_v2()].
 13.4242 +*/
 13.4243 +#define SQLITE_DETERMINISTIC    0x800
 13.4244 +
 13.4245 +/*
 13.4246 +** CAPI3REF: Deprecated Functions
 13.4247 +** DEPRECATED
 13.4248 +**
 13.4249 +** These functions are [deprecated].  In order to maintain
 13.4250 +** backwards compatibility with older code, these functions continue 
 13.4251 +** to be supported.  However, new applications should avoid
 13.4252 +** the use of these functions.  To help encourage people to avoid
 13.4253 +** using these functions, we are not going to tell you what they do.
 13.4254 +*/
 13.4255 +#ifndef SQLITE_OMIT_DEPRECATED
 13.4256 +SQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*);
 13.4257 +SQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*);
 13.4258 +SQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*);
 13.4259 +SQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void);
 13.4260 +SQLITE_API SQLITE_DEPRECATED void sqlite3_thread_cleanup(void);
 13.4261 +SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),
 13.4262 +                      void*,sqlite3_int64);
 13.4263 +#endif
 13.4264 +
 13.4265 +/*
 13.4266 +** CAPI3REF: Obtaining SQL Function Parameter Values
 13.4267 +**
 13.4268 +** The C-language implementation of SQL functions and aggregates uses
 13.4269 +** this set of interface routines to access the parameter values on
 13.4270 +** the function or aggregate.
 13.4271 +**
 13.4272 +** The xFunc (for scalar functions) or xStep (for aggregates) parameters
 13.4273 +** to [sqlite3_create_function()] and [sqlite3_create_function16()]
 13.4274 +** define callbacks that implement the SQL functions and aggregates.
 13.4275 +** The 3rd parameter to these callbacks is an array of pointers to
 13.4276 +** [protected sqlite3_value] objects.  There is one [sqlite3_value] object for
 13.4277 +** each parameter to the SQL function.  These routines are used to
 13.4278 +** extract values from the [sqlite3_value] objects.
 13.4279 +**
 13.4280 +** These routines work only with [protected sqlite3_value] objects.
 13.4281 +** Any attempt to use these routines on an [unprotected sqlite3_value]
 13.4282 +** object results in undefined behavior.
 13.4283 +**
 13.4284 +** ^These routines work just like the corresponding [column access functions]
 13.4285 +** except that  these routines take a single [protected sqlite3_value] object
 13.4286 +** pointer instead of a [sqlite3_stmt*] pointer and an integer column number.
 13.4287 +**
 13.4288 +** ^The sqlite3_value_text16() interface extracts a UTF-16 string
 13.4289 +** in the native byte-order of the host machine.  ^The
 13.4290 +** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces
 13.4291 +** extract UTF-16 strings as big-endian and little-endian respectively.
 13.4292 +**
 13.4293 +** ^(The sqlite3_value_numeric_type() interface attempts to apply
 13.4294 +** numeric affinity to the value.  This means that an attempt is
 13.4295 +** made to convert the value to an integer or floating point.  If
 13.4296 +** such a conversion is possible without loss of information (in other
 13.4297 +** words, if the value is a string that looks like a number)
 13.4298 +** then the conversion is performed.  Otherwise no conversion occurs.
 13.4299 +** The [SQLITE_INTEGER | datatype] after conversion is returned.)^
 13.4300 +**
 13.4301 +** Please pay particular attention to the fact that the pointer returned
 13.4302 +** from [sqlite3_value_blob()], [sqlite3_value_text()], or
 13.4303 +** [sqlite3_value_text16()] can be invalidated by a subsequent call to
 13.4304 +** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()],
 13.4305 +** or [sqlite3_value_text16()].
 13.4306 +**
 13.4307 +** These routines must be called from the same thread as
 13.4308 +** the SQL function that supplied the [sqlite3_value*] parameters.
 13.4309 +*/
 13.4310 +SQLITE_API const void *sqlite3_value_blob(sqlite3_value*);
 13.4311 +SQLITE_API int sqlite3_value_bytes(sqlite3_value*);
 13.4312 +SQLITE_API int sqlite3_value_bytes16(sqlite3_value*);
 13.4313 +SQLITE_API double sqlite3_value_double(sqlite3_value*);
 13.4314 +SQLITE_API int sqlite3_value_int(sqlite3_value*);
 13.4315 +SQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value*);
 13.4316 +SQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value*);
 13.4317 +SQLITE_API const void *sqlite3_value_text16(sqlite3_value*);
 13.4318 +SQLITE_API const void *sqlite3_value_text16le(sqlite3_value*);
 13.4319 +SQLITE_API const void *sqlite3_value_text16be(sqlite3_value*);
 13.4320 +SQLITE_API int sqlite3_value_type(sqlite3_value*);
 13.4321 +SQLITE_API int sqlite3_value_numeric_type(sqlite3_value*);
 13.4322 +
 13.4323 +/*
 13.4324 +** CAPI3REF: Obtain Aggregate Function Context
 13.4325 +**
 13.4326 +** Implementations of aggregate SQL functions use this
 13.4327 +** routine to allocate memory for storing their state.
 13.4328 +**
 13.4329 +** ^The first time the sqlite3_aggregate_context(C,N) routine is called 
 13.4330 +** for a particular aggregate function, SQLite
 13.4331 +** allocates N of memory, zeroes out that memory, and returns a pointer
 13.4332 +** to the new memory. ^On second and subsequent calls to
 13.4333 +** sqlite3_aggregate_context() for the same aggregate function instance,
 13.4334 +** the same buffer is returned.  Sqlite3_aggregate_context() is normally
 13.4335 +** called once for each invocation of the xStep callback and then one
 13.4336 +** last time when the xFinal callback is invoked.  ^(When no rows match
 13.4337 +** an aggregate query, the xStep() callback of the aggregate function
 13.4338 +** implementation is never called and xFinal() is called exactly once.
 13.4339 +** In those cases, sqlite3_aggregate_context() might be called for the
 13.4340 +** first time from within xFinal().)^
 13.4341 +**
 13.4342 +** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer 
 13.4343 +** when first called if N is less than or equal to zero or if a memory
 13.4344 +** allocate error occurs.
 13.4345 +**
 13.4346 +** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is
 13.4347 +** determined by the N parameter on first successful call.  Changing the
 13.4348 +** value of N in subsequent call to sqlite3_aggregate_context() within
 13.4349 +** the same aggregate function instance will not resize the memory
 13.4350 +** allocation.)^  Within the xFinal callback, it is customary to set
 13.4351 +** N=0 in calls to sqlite3_aggregate_context(C,N) so that no 
 13.4352 +** pointless memory allocations occur.
 13.4353 +**
 13.4354 +** ^SQLite automatically frees the memory allocated by 
 13.4355 +** sqlite3_aggregate_context() when the aggregate query concludes.
 13.4356 +**
 13.4357 +** The first parameter must be a copy of the
 13.4358 +** [sqlite3_context | SQL function context] that is the first parameter
 13.4359 +** to the xStep or xFinal callback routine that implements the aggregate
 13.4360 +** function.
 13.4361 +**
 13.4362 +** This routine must be called from the same thread in which
 13.4363 +** the aggregate SQL function is running.
 13.4364 +*/
 13.4365 +SQLITE_API void *sqlite3_aggregate_context(sqlite3_context*, int nBytes);
 13.4366 +
 13.4367 +/*
 13.4368 +** CAPI3REF: User Data For Functions
 13.4369 +**
 13.4370 +** ^The sqlite3_user_data() interface returns a copy of
 13.4371 +** the pointer that was the pUserData parameter (the 5th parameter)
 13.4372 +** of the [sqlite3_create_function()]
 13.4373 +** and [sqlite3_create_function16()] routines that originally
 13.4374 +** registered the application defined function.
 13.4375 +**
 13.4376 +** This routine must be called from the same thread in which
 13.4377 +** the application-defined function is running.
 13.4378 +*/
 13.4379 +SQLITE_API void *sqlite3_user_data(sqlite3_context*);
 13.4380 +
 13.4381 +/*
 13.4382 +** CAPI3REF: Database Connection For Functions
 13.4383 +**
 13.4384 +** ^The sqlite3_context_db_handle() interface returns a copy of
 13.4385 +** the pointer to the [database connection] (the 1st parameter)
 13.4386 +** of the [sqlite3_create_function()]
 13.4387 +** and [sqlite3_create_function16()] routines that originally
 13.4388 +** registered the application defined function.
 13.4389 +*/
 13.4390 +SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_context*);
 13.4391 +
 13.4392 +/*
 13.4393 +** CAPI3REF: Function Auxiliary Data
 13.4394 +**
 13.4395 +** These functions may be used by (non-aggregate) SQL functions to
 13.4396 +** associate metadata with argument values. If the same value is passed to
 13.4397 +** multiple invocations of the same SQL function during query execution, under
 13.4398 +** some circumstances the associated metadata may be preserved.  An example
 13.4399 +** of where this might be useful is in a regular-expression matching
 13.4400 +** function. The compiled version of the regular expression can be stored as
 13.4401 +** metadata associated with the pattern string.  
 13.4402 +** Then as long as the pattern string remains the same,
 13.4403 +** the compiled regular expression can be reused on multiple
 13.4404 +** invocations of the same function.
 13.4405 +**
 13.4406 +** ^The sqlite3_get_auxdata() interface returns a pointer to the metadata
 13.4407 +** associated by the sqlite3_set_auxdata() function with the Nth argument
 13.4408 +** value to the application-defined function. ^If there is no metadata
 13.4409 +** associated with the function argument, this sqlite3_get_auxdata() interface
 13.4410 +** returns a NULL pointer.
 13.4411 +**
 13.4412 +** ^The sqlite3_set_auxdata(C,N,P,X) interface saves P as metadata for the N-th
 13.4413 +** argument of the application-defined function.  ^Subsequent
 13.4414 +** calls to sqlite3_get_auxdata(C,N) return P from the most recent
 13.4415 +** sqlite3_set_auxdata(C,N,P,X) call if the metadata is still valid or
 13.4416 +** NULL if the metadata has been discarded.
 13.4417 +** ^After each call to sqlite3_set_auxdata(C,N,P,X) where X is not NULL,
 13.4418 +** SQLite will invoke the destructor function X with parameter P exactly
 13.4419 +** once, when the metadata is discarded.
 13.4420 +** SQLite is free to discard the metadata at any time, including: <ul>
 13.4421 +** <li> when the corresponding function parameter changes, or
 13.4422 +** <li> when [sqlite3_reset()] or [sqlite3_finalize()] is called for the
 13.4423 +**      SQL statement, or
 13.4424 +** <li> when sqlite3_set_auxdata() is invoked again on the same parameter, or
 13.4425 +** <li> during the original sqlite3_set_auxdata() call when a memory 
 13.4426 +**      allocation error occurs. </ul>)^
 13.4427 +**
 13.4428 +** Note the last bullet in particular.  The destructor X in 
 13.4429 +** sqlite3_set_auxdata(C,N,P,X) might be called immediately, before the
 13.4430 +** sqlite3_set_auxdata() interface even returns.  Hence sqlite3_set_auxdata()
 13.4431 +** should be called near the end of the function implementation and the
 13.4432 +** function implementation should not make any use of P after
 13.4433 +** sqlite3_set_auxdata() has been called.
 13.4434 +**
 13.4435 +** ^(In practice, metadata is preserved between function calls for
 13.4436 +** function parameters that are compile-time constants, including literal
 13.4437 +** values and [parameters] and expressions composed from the same.)^
 13.4438 +**
 13.4439 +** These routines must be called from the same thread in which
 13.4440 +** the SQL function is running.
 13.4441 +*/
 13.4442 +SQLITE_API void *sqlite3_get_auxdata(sqlite3_context*, int N);
 13.4443 +SQLITE_API void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*));
 13.4444 +
 13.4445 +
 13.4446 +/*
 13.4447 +** CAPI3REF: Constants Defining Special Destructor Behavior
 13.4448 +**
 13.4449 +** These are special values for the destructor that is passed in as the
 13.4450 +** final argument to routines like [sqlite3_result_blob()].  ^If the destructor
 13.4451 +** argument is SQLITE_STATIC, it means that the content pointer is constant
 13.4452 +** and will never change.  It does not need to be destroyed.  ^The
 13.4453 +** SQLITE_TRANSIENT value means that the content will likely change in
 13.4454 +** the near future and that SQLite should make its own private copy of
 13.4455 +** the content before returning.
 13.4456 +**
 13.4457 +** The typedef is necessary to work around problems in certain
 13.4458 +** C++ compilers.
 13.4459 +*/
 13.4460 +typedef void (*sqlite3_destructor_type)(void*);
 13.4461 +#define SQLITE_STATIC      ((sqlite3_destructor_type)0)
 13.4462 +#define SQLITE_TRANSIENT   ((sqlite3_destructor_type)-1)
 13.4463 +
 13.4464 +/*
 13.4465 +** CAPI3REF: Setting The Result Of An SQL Function
 13.4466 +**
 13.4467 +** These routines are used by the xFunc or xFinal callbacks that
 13.4468 +** implement SQL functions and aggregates.  See
 13.4469 +** [sqlite3_create_function()] and [sqlite3_create_function16()]
 13.4470 +** for additional information.
 13.4471 +**
 13.4472 +** These functions work very much like the [parameter binding] family of
 13.4473 +** functions used to bind values to host parameters in prepared statements.
 13.4474 +** Refer to the [SQL parameter] documentation for additional information.
 13.4475 +**
 13.4476 +** ^The sqlite3_result_blob() interface sets the result from
 13.4477 +** an application-defined function to be the BLOB whose content is pointed
 13.4478 +** to by the second parameter and which is N bytes long where N is the
 13.4479 +** third parameter.
 13.4480 +**
 13.4481 +** ^The sqlite3_result_zeroblob() interfaces set the result of
 13.4482 +** the application-defined function to be a BLOB containing all zero
 13.4483 +** bytes and N bytes in size, where N is the value of the 2nd parameter.
 13.4484 +**
 13.4485 +** ^The sqlite3_result_double() interface sets the result from
 13.4486 +** an application-defined function to be a floating point value specified
 13.4487 +** by its 2nd argument.
 13.4488 +**
 13.4489 +** ^The sqlite3_result_error() and sqlite3_result_error16() functions
 13.4490 +** cause the implemented SQL function to throw an exception.
 13.4491 +** ^SQLite uses the string pointed to by the
 13.4492 +** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16()
 13.4493 +** as the text of an error message.  ^SQLite interprets the error
 13.4494 +** message string from sqlite3_result_error() as UTF-8. ^SQLite
 13.4495 +** interprets the string from sqlite3_result_error16() as UTF-16 in native
 13.4496 +** byte order.  ^If the third parameter to sqlite3_result_error()
 13.4497 +** or sqlite3_result_error16() is negative then SQLite takes as the error
 13.4498 +** message all text up through the first zero character.
 13.4499 +** ^If the third parameter to sqlite3_result_error() or
 13.4500 +** sqlite3_result_error16() is non-negative then SQLite takes that many
 13.4501 +** bytes (not characters) from the 2nd parameter as the error message.
 13.4502 +** ^The sqlite3_result_error() and sqlite3_result_error16()
 13.4503 +** routines make a private copy of the error message text before
 13.4504 +** they return.  Hence, the calling function can deallocate or
 13.4505 +** modify the text after they return without harm.
 13.4506 +** ^The sqlite3_result_error_code() function changes the error code
 13.4507 +** returned by SQLite as a result of an error in a function.  ^By default,
 13.4508 +** the error code is SQLITE_ERROR.  ^A subsequent call to sqlite3_result_error()
 13.4509 +** or sqlite3_result_error16() resets the error code to SQLITE_ERROR.
 13.4510 +**
 13.4511 +** ^The sqlite3_result_error_toobig() interface causes SQLite to throw an
 13.4512 +** error indicating that a string or BLOB is too long to represent.
 13.4513 +**
 13.4514 +** ^The sqlite3_result_error_nomem() interface causes SQLite to throw an
 13.4515 +** error indicating that a memory allocation failed.
 13.4516 +**
 13.4517 +** ^The sqlite3_result_int() interface sets the return value
 13.4518 +** of the application-defined function to be the 32-bit signed integer
 13.4519 +** value given in the 2nd argument.
 13.4520 +** ^The sqlite3_result_int64() interface sets the return value
 13.4521 +** of the application-defined function to be the 64-bit signed integer
 13.4522 +** value given in the 2nd argument.
 13.4523 +**
 13.4524 +** ^The sqlite3_result_null() interface sets the return value
 13.4525 +** of the application-defined function to be NULL.
 13.4526 +**
 13.4527 +** ^The sqlite3_result_text(), sqlite3_result_text16(),
 13.4528 +** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces
 13.4529 +** set the return value of the application-defined function to be
 13.4530 +** a text string which is represented as UTF-8, UTF-16 native byte order,
 13.4531 +** UTF-16 little endian, or UTF-16 big endian, respectively.
 13.4532 +** ^SQLite takes the text result from the application from
 13.4533 +** the 2nd parameter of the sqlite3_result_text* interfaces.
 13.4534 +** ^If the 3rd parameter to the sqlite3_result_text* interfaces
 13.4535 +** is negative, then SQLite takes result text from the 2nd parameter
 13.4536 +** through the first zero character.
 13.4537 +** ^If the 3rd parameter to the sqlite3_result_text* interfaces
 13.4538 +** is non-negative, then as many bytes (not characters) of the text
 13.4539 +** pointed to by the 2nd parameter are taken as the application-defined
 13.4540 +** function result.  If the 3rd parameter is non-negative, then it
 13.4541 +** must be the byte offset into the string where the NUL terminator would
 13.4542 +** appear if the string where NUL terminated.  If any NUL characters occur
 13.4543 +** in the string at a byte offset that is less than the value of the 3rd
 13.4544 +** parameter, then the resulting string will contain embedded NULs and the
 13.4545 +** result of expressions operating on strings with embedded NULs is undefined.
 13.4546 +** ^If the 4th parameter to the sqlite3_result_text* interfaces
 13.4547 +** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that
 13.4548 +** function as the destructor on the text or BLOB result when it has
 13.4549 +** finished using that result.
 13.4550 +** ^If the 4th parameter to the sqlite3_result_text* interfaces or to
 13.4551 +** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite
 13.4552 +** assumes that the text or BLOB result is in constant space and does not
 13.4553 +** copy the content of the parameter nor call a destructor on the content
 13.4554 +** when it has finished using that result.
 13.4555 +** ^If the 4th parameter to the sqlite3_result_text* interfaces
 13.4556 +** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT
 13.4557 +** then SQLite makes a copy of the result into space obtained from
 13.4558 +** from [sqlite3_malloc()] before it returns.
 13.4559 +**
 13.4560 +** ^The sqlite3_result_value() interface sets the result of
 13.4561 +** the application-defined function to be a copy the
 13.4562 +** [unprotected sqlite3_value] object specified by the 2nd parameter.  ^The
 13.4563 +** sqlite3_result_value() interface makes a copy of the [sqlite3_value]
 13.4564 +** so that the [sqlite3_value] specified in the parameter may change or
 13.4565 +** be deallocated after sqlite3_result_value() returns without harm.
 13.4566 +** ^A [protected sqlite3_value] object may always be used where an
 13.4567 +** [unprotected sqlite3_value] object is required, so either
 13.4568 +** kind of [sqlite3_value] object can be used with this interface.
 13.4569 +**
 13.4570 +** If these routines are called from within the different thread
 13.4571 +** than the one containing the application-defined function that received
 13.4572 +** the [sqlite3_context] pointer, the results are undefined.
 13.4573 +*/
 13.4574 +SQLITE_API void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*));
 13.4575 +SQLITE_API void sqlite3_result_double(sqlite3_context*, double);
 13.4576 +SQLITE_API void sqlite3_result_error(sqlite3_context*, const char*, int);
 13.4577 +SQLITE_API void sqlite3_result_error16(sqlite3_context*, const void*, int);
 13.4578 +SQLITE_API void sqlite3_result_error_toobig(sqlite3_context*);
 13.4579 +SQLITE_API void sqlite3_result_error_nomem(sqlite3_context*);
 13.4580 +SQLITE_API void sqlite3_result_error_code(sqlite3_context*, int);
 13.4581 +SQLITE_API void sqlite3_result_int(sqlite3_context*, int);
 13.4582 +SQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64);
 13.4583 +SQLITE_API void sqlite3_result_null(sqlite3_context*);
 13.4584 +SQLITE_API void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*));
 13.4585 +SQLITE_API void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*));
 13.4586 +SQLITE_API void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*));
 13.4587 +SQLITE_API void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*));
 13.4588 +SQLITE_API void sqlite3_result_value(sqlite3_context*, sqlite3_value*);
 13.4589 +SQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n);
 13.4590 +
 13.4591 +/*
 13.4592 +** CAPI3REF: Define New Collating Sequences
 13.4593 +**
 13.4594 +** ^These functions add, remove, or modify a [collation] associated
 13.4595 +** with the [database connection] specified as the first argument.
 13.4596 +**
 13.4597 +** ^The name of the collation is a UTF-8 string
 13.4598 +** for sqlite3_create_collation() and sqlite3_create_collation_v2()
 13.4599 +** and a UTF-16 string in native byte order for sqlite3_create_collation16().
 13.4600 +** ^Collation names that compare equal according to [sqlite3_strnicmp()] are
 13.4601 +** considered to be the same name.
 13.4602 +**
 13.4603 +** ^(The third argument (eTextRep) must be one of the constants:
 13.4604 +** <ul>
 13.4605 +** <li> [SQLITE_UTF8],
 13.4606 +** <li> [SQLITE_UTF16LE],
 13.4607 +** <li> [SQLITE_UTF16BE],
 13.4608 +** <li> [SQLITE_UTF16], or
 13.4609 +** <li> [SQLITE_UTF16_ALIGNED].
 13.4610 +** </ul>)^
 13.4611 +** ^The eTextRep argument determines the encoding of strings passed
 13.4612 +** to the collating function callback, xCallback.
 13.4613 +** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep
 13.4614 +** force strings to be UTF16 with native byte order.
 13.4615 +** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin
 13.4616 +** on an even byte address.
 13.4617 +**
 13.4618 +** ^The fourth argument, pArg, is an application data pointer that is passed
 13.4619 +** through as the first argument to the collating function callback.
 13.4620 +**
 13.4621 +** ^The fifth argument, xCallback, is a pointer to the collating function.
 13.4622 +** ^Multiple collating functions can be registered using the same name but
 13.4623 +** with different eTextRep parameters and SQLite will use whichever
 13.4624 +** function requires the least amount of data transformation.
 13.4625 +** ^If the xCallback argument is NULL then the collating function is
 13.4626 +** deleted.  ^When all collating functions having the same name are deleted,
 13.4627 +** that collation is no longer usable.
 13.4628 +**
 13.4629 +** ^The collating function callback is invoked with a copy of the pArg 
 13.4630 +** application data pointer and with two strings in the encoding specified
 13.4631 +** by the eTextRep argument.  The collating function must return an
 13.4632 +** integer that is negative, zero, or positive
 13.4633 +** if the first string is less than, equal to, or greater than the second,
 13.4634 +** respectively.  A collating function must always return the same answer
 13.4635 +** given the same inputs.  If two or more collating functions are registered
 13.4636 +** to the same collation name (using different eTextRep values) then all
 13.4637 +** must give an equivalent answer when invoked with equivalent strings.
 13.4638 +** The collating function must obey the following properties for all
 13.4639 +** strings A, B, and C:
 13.4640 +**
 13.4641 +** <ol>
 13.4642 +** <li> If A==B then B==A.
 13.4643 +** <li> If A==B and B==C then A==C.
 13.4644 +** <li> If A&lt;B THEN B&gt;A.
 13.4645 +** <li> If A&lt;B and B&lt;C then A&lt;C.
 13.4646 +** </ol>
 13.4647 +**
 13.4648 +** If a collating function fails any of the above constraints and that
 13.4649 +** collating function is  registered and used, then the behavior of SQLite
 13.4650 +** is undefined.
 13.4651 +**
 13.4652 +** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation()
 13.4653 +** with the addition that the xDestroy callback is invoked on pArg when
 13.4654 +** the collating function is deleted.
 13.4655 +** ^Collating functions are deleted when they are overridden by later
 13.4656 +** calls to the collation creation functions or when the
 13.4657 +** [database connection] is closed using [sqlite3_close()].
 13.4658 +**
 13.4659 +** ^The xDestroy callback is <u>not</u> called if the 
 13.4660 +** sqlite3_create_collation_v2() function fails.  Applications that invoke
 13.4661 +** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should 
 13.4662 +** check the return code and dispose of the application data pointer
 13.4663 +** themselves rather than expecting SQLite to deal with it for them.
 13.4664 +** This is different from every other SQLite interface.  The inconsistency 
 13.4665 +** is unfortunate but cannot be changed without breaking backwards 
 13.4666 +** compatibility.
 13.4667 +**
 13.4668 +** See also:  [sqlite3_collation_needed()] and [sqlite3_collation_needed16()].
 13.4669 +*/
 13.4670 +SQLITE_API int sqlite3_create_collation(
 13.4671 +  sqlite3*, 
 13.4672 +  const char *zName, 
 13.4673 +  int eTextRep, 
 13.4674 +  void *pArg,
 13.4675 +  int(*xCompare)(void*,int,const void*,int,const void*)
 13.4676 +);
 13.4677 +SQLITE_API int sqlite3_create_collation_v2(
 13.4678 +  sqlite3*, 
 13.4679 +  const char *zName, 
 13.4680 +  int eTextRep, 
 13.4681 +  void *pArg,
 13.4682 +  int(*xCompare)(void*,int,const void*,int,const void*),
 13.4683 +  void(*xDestroy)(void*)
 13.4684 +);
 13.4685 +SQLITE_API int sqlite3_create_collation16(
 13.4686 +  sqlite3*, 
 13.4687 +  const void *zName,
 13.4688 +  int eTextRep, 
 13.4689 +  void *pArg,
 13.4690 +  int(*xCompare)(void*,int,const void*,int,const void*)
 13.4691 +);
 13.4692 +
 13.4693 +/*
 13.4694 +** CAPI3REF: Collation Needed Callbacks
 13.4695 +**
 13.4696 +** ^To avoid having to register all collation sequences before a database
 13.4697 +** can be used, a single callback function may be registered with the
 13.4698 +** [database connection] to be invoked whenever an undefined collation
 13.4699 +** sequence is required.
 13.4700 +**
 13.4701 +** ^If the function is registered using the sqlite3_collation_needed() API,
 13.4702 +** then it is passed the names of undefined collation sequences as strings
 13.4703 +** encoded in UTF-8. ^If sqlite3_collation_needed16() is used,
 13.4704 +** the names are passed as UTF-16 in machine native byte order.
 13.4705 +** ^A call to either function replaces the existing collation-needed callback.
 13.4706 +**
 13.4707 +** ^(When the callback is invoked, the first argument passed is a copy
 13.4708 +** of the second argument to sqlite3_collation_needed() or
 13.4709 +** sqlite3_collation_needed16().  The second argument is the database
 13.4710 +** connection.  The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE],
 13.4711 +** or [SQLITE_UTF16LE], indicating the most desirable form of the collation
 13.4712 +** sequence function required.  The fourth parameter is the name of the
 13.4713 +** required collation sequence.)^
 13.4714 +**
 13.4715 +** The callback function should register the desired collation using
 13.4716 +** [sqlite3_create_collation()], [sqlite3_create_collation16()], or
 13.4717 +** [sqlite3_create_collation_v2()].
 13.4718 +*/
 13.4719 +SQLITE_API int sqlite3_collation_needed(
 13.4720 +  sqlite3*, 
 13.4721 +  void*, 
 13.4722 +  void(*)(void*,sqlite3*,int eTextRep,const char*)
 13.4723 +);
 13.4724 +SQLITE_API int sqlite3_collation_needed16(
 13.4725 +  sqlite3*, 
 13.4726 +  void*,
 13.4727 +  void(*)(void*,sqlite3*,int eTextRep,const void*)
 13.4728 +);
 13.4729 +
 13.4730 +#ifdef SQLITE_HAS_CODEC
 13.4731 +/*
 13.4732 +** Specify the key for an encrypted database.  This routine should be
 13.4733 +** called right after sqlite3_open().
 13.4734 +**
 13.4735 +** The code to implement this API is not available in the public release
 13.4736 +** of SQLite.
 13.4737 +*/
 13.4738 +SQLITE_API int sqlite3_key(
 13.4739 +  sqlite3 *db,                   /* Database to be rekeyed */
 13.4740 +  const void *pKey, int nKey     /* The key */
 13.4741 +);
 13.4742 +SQLITE_API int sqlite3_key_v2(
 13.4743 +  sqlite3 *db,                   /* Database to be rekeyed */
 13.4744 +  const char *zDbName,           /* Name of the database */
 13.4745 +  const void *pKey, int nKey     /* The key */
 13.4746 +);
 13.4747 +
 13.4748 +/*
 13.4749 +** Change the key on an open database.  If the current database is not
 13.4750 +** encrypted, this routine will encrypt it.  If pNew==0 or nNew==0, the
 13.4751 +** database is decrypted.
 13.4752 +**
 13.4753 +** The code to implement this API is not available in the public release
 13.4754 +** of SQLite.
 13.4755 +*/
 13.4756 +SQLITE_API int sqlite3_rekey(
 13.4757 +  sqlite3 *db,                   /* Database to be rekeyed */
 13.4758 +  const void *pKey, int nKey     /* The new key */
 13.4759 +);
 13.4760 +SQLITE_API int sqlite3_rekey_v2(
 13.4761 +  sqlite3 *db,                   /* Database to be rekeyed */
 13.4762 +  const char *zDbName,           /* Name of the database */
 13.4763 +  const void *pKey, int nKey     /* The new key */
 13.4764 +);
 13.4765 +
 13.4766 +/*
 13.4767 +** Specify the activation key for a SEE database.  Unless 
 13.4768 +** activated, none of the SEE routines will work.
 13.4769 +*/
 13.4770 +SQLITE_API void sqlite3_activate_see(
 13.4771 +  const char *zPassPhrase        /* Activation phrase */
 13.4772 +);
 13.4773 +#endif
 13.4774 +
 13.4775 +#ifdef SQLITE_ENABLE_CEROD
 13.4776 +/*
 13.4777 +** Specify the activation key for a CEROD database.  Unless 
 13.4778 +** activated, none of the CEROD routines will work.
 13.4779 +*/
 13.4780 +SQLITE_API void sqlite3_activate_cerod(
 13.4781 +  const char *zPassPhrase        /* Activation phrase */
 13.4782 +);
 13.4783 +#endif
 13.4784 +
 13.4785 +/*
 13.4786 +** CAPI3REF: Suspend Execution For A Short Time
 13.4787 +**
 13.4788 +** The sqlite3_sleep() function causes the current thread to suspend execution
 13.4789 +** for at least a number of milliseconds specified in its parameter.
 13.4790 +**
 13.4791 +** If the operating system does not support sleep requests with
 13.4792 +** millisecond time resolution, then the time will be rounded up to
 13.4793 +** the nearest second. The number of milliseconds of sleep actually
 13.4794 +** requested from the operating system is returned.
 13.4795 +**
 13.4796 +** ^SQLite implements this interface by calling the xSleep()
 13.4797 +** method of the default [sqlite3_vfs] object.  If the xSleep() method
 13.4798 +** of the default VFS is not implemented correctly, or not implemented at
 13.4799 +** all, then the behavior of sqlite3_sleep() may deviate from the description
 13.4800 +** in the previous paragraphs.
 13.4801 +*/
 13.4802 +SQLITE_API int sqlite3_sleep(int);
 13.4803 +
 13.4804 +/*
 13.4805 +** CAPI3REF: Name Of The Folder Holding Temporary Files
 13.4806 +**
 13.4807 +** ^(If this global variable is made to point to a string which is
 13.4808 +** the name of a folder (a.k.a. directory), then all temporary files
 13.4809 +** created by SQLite when using a built-in [sqlite3_vfs | VFS]
 13.4810 +** will be placed in that directory.)^  ^If this variable
 13.4811 +** is a NULL pointer, then SQLite performs a search for an appropriate
 13.4812 +** temporary file directory.
 13.4813 +**
 13.4814 +** Applications are strongly discouraged from using this global variable.
 13.4815 +** It is required to set a temporary folder on Windows Runtime (WinRT).
 13.4816 +** But for all other platforms, it is highly recommended that applications
 13.4817 +** neither read nor write this variable.  This global variable is a relic
 13.4818 +** that exists for backwards compatibility of legacy applications and should
 13.4819 +** be avoided in new projects.
 13.4820 +**
 13.4821 +** It is not safe to read or modify this variable in more than one
 13.4822 +** thread at a time.  It is not safe to read or modify this variable
 13.4823 +** if a [database connection] is being used at the same time in a separate
 13.4824 +** thread.
 13.4825 +** It is intended that this variable be set once
 13.4826 +** as part of process initialization and before any SQLite interface
 13.4827 +** routines have been called and that this variable remain unchanged
 13.4828 +** thereafter.
 13.4829 +**
 13.4830 +** ^The [temp_store_directory pragma] may modify this variable and cause
 13.4831 +** it to point to memory obtained from [sqlite3_malloc].  ^Furthermore,
 13.4832 +** the [temp_store_directory pragma] always assumes that any string
 13.4833 +** that this variable points to is held in memory obtained from 
 13.4834 +** [sqlite3_malloc] and the pragma may attempt to free that memory
 13.4835 +** using [sqlite3_free].
 13.4836 +** Hence, if this variable is modified directly, either it should be
 13.4837 +** made NULL or made to point to memory obtained from [sqlite3_malloc]
 13.4838 +** or else the use of the [temp_store_directory pragma] should be avoided.
 13.4839 +** Except when requested by the [temp_store_directory pragma], SQLite
 13.4840 +** does not free the memory that sqlite3_temp_directory points to.  If
 13.4841 +** the application wants that memory to be freed, it must do
 13.4842 +** so itself, taking care to only do so after all [database connection]
 13.4843 +** objects have been destroyed.
 13.4844 +**
 13.4845 +** <b>Note to Windows Runtime users:</b>  The temporary directory must be set
 13.4846 +** prior to calling [sqlite3_open] or [sqlite3_open_v2].  Otherwise, various
 13.4847 +** features that require the use of temporary files may fail.  Here is an
 13.4848 +** example of how to do this using C++ with the Windows Runtime:
 13.4849 +**
 13.4850 +** <blockquote><pre>
 13.4851 +** LPCWSTR zPath = Windows::Storage::ApplicationData::Current->
 13.4852 +** &nbsp;     TemporaryFolder->Path->Data();
 13.4853 +** char zPathBuf&#91;MAX_PATH + 1&#93;;
 13.4854 +** memset(zPathBuf, 0, sizeof(zPathBuf));
 13.4855 +** WideCharToMultiByte(CP_UTF8, 0, zPath, -1, zPathBuf, sizeof(zPathBuf),
 13.4856 +** &nbsp;     NULL, NULL);
 13.4857 +** sqlite3_temp_directory = sqlite3_mprintf("%s", zPathBuf);
 13.4858 +** </pre></blockquote>
 13.4859 +*/
 13.4860 +SQLITE_API char *sqlite3_temp_directory;
 13.4861 +
 13.4862 +/*
 13.4863 +** CAPI3REF: Name Of The Folder Holding Database Files
 13.4864 +**
 13.4865 +** ^(If this global variable is made to point to a string which is
 13.4866 +** the name of a folder (a.k.a. directory), then all database files
 13.4867 +** specified with a relative pathname and created or accessed by
 13.4868 +** SQLite when using a built-in windows [sqlite3_vfs | VFS] will be assumed
 13.4869 +** to be relative to that directory.)^ ^If this variable is a NULL
 13.4870 +** pointer, then SQLite assumes that all database files specified
 13.4871 +** with a relative pathname are relative to the current directory
 13.4872 +** for the process.  Only the windows VFS makes use of this global
 13.4873 +** variable; it is ignored by the unix VFS.
 13.4874 +**
 13.4875 +** Changing the value of this variable while a database connection is
 13.4876 +** open can result in a corrupt database.
 13.4877 +**
 13.4878 +** It is not safe to read or modify this variable in more than one
 13.4879 +** thread at a time.  It is not safe to read or modify this variable
 13.4880 +** if a [database connection] is being used at the same time in a separate
 13.4881 +** thread.
 13.4882 +** It is intended that this variable be set once
 13.4883 +** as part of process initialization and before any SQLite interface
 13.4884 +** routines have been called and that this variable remain unchanged
 13.4885 +** thereafter.
 13.4886 +**
 13.4887 +** ^The [data_store_directory pragma] may modify this variable and cause
 13.4888 +** it to point to memory obtained from [sqlite3_malloc].  ^Furthermore,
 13.4889 +** the [data_store_directory pragma] always assumes that any string
 13.4890 +** that this variable points to is held in memory obtained from 
 13.4891 +** [sqlite3_malloc] and the pragma may attempt to free that memory
 13.4892 +** using [sqlite3_free].
 13.4893 +** Hence, if this variable is modified directly, either it should be
 13.4894 +** made NULL or made to point to memory obtained from [sqlite3_malloc]
 13.4895 +** or else the use of the [data_store_directory pragma] should be avoided.
 13.4896 +*/
 13.4897 +SQLITE_API char *sqlite3_data_directory;
 13.4898 +
 13.4899 +/*
 13.4900 +** CAPI3REF: Test For Auto-Commit Mode
 13.4901 +** KEYWORDS: {autocommit mode}
 13.4902 +**
 13.4903 +** ^The sqlite3_get_autocommit() interface returns non-zero or
 13.4904 +** zero if the given database connection is or is not in autocommit mode,
 13.4905 +** respectively.  ^Autocommit mode is on by default.
 13.4906 +** ^Autocommit mode is disabled by a [BEGIN] statement.
 13.4907 +** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK].
 13.4908 +**
 13.4909 +** If certain kinds of errors occur on a statement within a multi-statement
 13.4910 +** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR],
 13.4911 +** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the
 13.4912 +** transaction might be rolled back automatically.  The only way to
 13.4913 +** find out whether SQLite automatically rolled back the transaction after
 13.4914 +** an error is to use this function.
 13.4915 +**
 13.4916 +** If another thread changes the autocommit status of the database
 13.4917 +** connection while this routine is running, then the return value
 13.4918 +** is undefined.
 13.4919 +*/
 13.4920 +SQLITE_API int sqlite3_get_autocommit(sqlite3*);
 13.4921 +
 13.4922 +/*
 13.4923 +** CAPI3REF: Find The Database Handle Of A Prepared Statement
 13.4924 +**
 13.4925 +** ^The sqlite3_db_handle interface returns the [database connection] handle
 13.4926 +** to which a [prepared statement] belongs.  ^The [database connection]
 13.4927 +** returned by sqlite3_db_handle is the same [database connection]
 13.4928 +** that was the first argument
 13.4929 +** to the [sqlite3_prepare_v2()] call (or its variants) that was used to
 13.4930 +** create the statement in the first place.
 13.4931 +*/
 13.4932 +SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*);
 13.4933 +
 13.4934 +/*
 13.4935 +** CAPI3REF: Return The Filename For A Database Connection
 13.4936 +**
 13.4937 +** ^The sqlite3_db_filename(D,N) interface returns a pointer to a filename
 13.4938 +** associated with database N of connection D.  ^The main database file
 13.4939 +** has the name "main".  If there is no attached database N on the database
 13.4940 +** connection D, or if database N is a temporary or in-memory database, then
 13.4941 +** a NULL pointer is returned.
 13.4942 +**
 13.4943 +** ^The filename returned by this function is the output of the
 13.4944 +** xFullPathname method of the [VFS].  ^In other words, the filename
 13.4945 +** will be an absolute pathname, even if the filename used
 13.4946 +** to open the database originally was a URI or relative pathname.
 13.4947 +*/
 13.4948 +SQLITE_API const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName);
 13.4949 +
 13.4950 +/*
 13.4951 +** CAPI3REF: Determine if a database is read-only
 13.4952 +**
 13.4953 +** ^The sqlite3_db_readonly(D,N) interface returns 1 if the database N
 13.4954 +** of connection D is read-only, 0 if it is read/write, or -1 if N is not
 13.4955 +** the name of a database on connection D.
 13.4956 +*/
 13.4957 +SQLITE_API int sqlite3_db_readonly(sqlite3 *db, const char *zDbName);
 13.4958 +
 13.4959 +/*
 13.4960 +** CAPI3REF: Find the next prepared statement
 13.4961 +**
 13.4962 +** ^This interface returns a pointer to the next [prepared statement] after
 13.4963 +** pStmt associated with the [database connection] pDb.  ^If pStmt is NULL
 13.4964 +** then this interface returns a pointer to the first prepared statement
 13.4965 +** associated with the database connection pDb.  ^If no prepared statement
 13.4966 +** satisfies the conditions of this routine, it returns NULL.
 13.4967 +**
 13.4968 +** The [database connection] pointer D in a call to
 13.4969 +** [sqlite3_next_stmt(D,S)] must refer to an open database
 13.4970 +** connection and in particular must not be a NULL pointer.
 13.4971 +*/
 13.4972 +SQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt);
 13.4973 +
 13.4974 +/*
 13.4975 +** CAPI3REF: Commit And Rollback Notification Callbacks
 13.4976 +**
 13.4977 +** ^The sqlite3_commit_hook() interface registers a callback
 13.4978 +** function to be invoked whenever a transaction is [COMMIT | committed].
 13.4979 +** ^Any callback set by a previous call to sqlite3_commit_hook()
 13.4980 +** for the same database connection is overridden.
 13.4981 +** ^The sqlite3_rollback_hook() interface registers a callback
 13.4982 +** function to be invoked whenever a transaction is [ROLLBACK | rolled back].
 13.4983 +** ^Any callback set by a previous call to sqlite3_rollback_hook()
 13.4984 +** for the same database connection is overridden.
 13.4985 +** ^The pArg argument is passed through to the callback.
 13.4986 +** ^If the callback on a commit hook function returns non-zero,
 13.4987 +** then the commit is converted into a rollback.
 13.4988 +**
 13.4989 +** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions
 13.4990 +** return the P argument from the previous call of the same function
 13.4991 +** on the same [database connection] D, or NULL for
 13.4992 +** the first call for each function on D.
 13.4993 +**
 13.4994 +** The commit and rollback hook callbacks are not reentrant.
 13.4995 +** The callback implementation must not do anything that will modify
 13.4996 +** the database connection that invoked the callback.  Any actions
 13.4997 +** to modify the database connection must be deferred until after the
 13.4998 +** completion of the [sqlite3_step()] call that triggered the commit
 13.4999 +** or rollback hook in the first place.
 13.5000 +** Note that running any other SQL statements, including SELECT statements,
 13.5001 +** or merely calling [sqlite3_prepare_v2()] and [sqlite3_step()] will modify
 13.5002 +** the database connections for the meaning of "modify" in this paragraph.
 13.5003 +**
 13.5004 +** ^Registering a NULL function disables the callback.
 13.5005 +**
 13.5006 +** ^When the commit hook callback routine returns zero, the [COMMIT]
 13.5007 +** operation is allowed to continue normally.  ^If the commit hook
 13.5008 +** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK].
 13.5009 +** ^The rollback hook is invoked on a rollback that results from a commit
 13.5010 +** hook returning non-zero, just as it would be with any other rollback.
 13.5011 +**
 13.5012 +** ^For the purposes of this API, a transaction is said to have been
 13.5013 +** rolled back if an explicit "ROLLBACK" statement is executed, or
 13.5014 +** an error or constraint causes an implicit rollback to occur.
 13.5015 +** ^The rollback callback is not invoked if a transaction is
 13.5016 +** automatically rolled back because the database connection is closed.
 13.5017 +**
 13.5018 +** See also the [sqlite3_update_hook()] interface.
 13.5019 +*/
 13.5020 +SQLITE_API void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
 13.5021 +SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);
 13.5022 +
 13.5023 +/*
 13.5024 +** CAPI3REF: Data Change Notification Callbacks
 13.5025 +**
 13.5026 +** ^The sqlite3_update_hook() interface registers a callback function
 13.5027 +** with the [database connection] identified by the first argument
 13.5028 +** to be invoked whenever a row is updated, inserted or deleted in
 13.5029 +** a rowid table.
 13.5030 +** ^Any callback set by a previous call to this function
 13.5031 +** for the same database connection is overridden.
 13.5032 +**
 13.5033 +** ^The second argument is a pointer to the function to invoke when a
 13.5034 +** row is updated, inserted or deleted in a rowid table.
 13.5035 +** ^The first argument to the callback is a copy of the third argument
 13.5036 +** to sqlite3_update_hook().
 13.5037 +** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE],
 13.5038 +** or [SQLITE_UPDATE], depending on the operation that caused the callback
 13.5039 +** to be invoked.
 13.5040 +** ^The third and fourth arguments to the callback contain pointers to the
 13.5041 +** database and table name containing the affected row.
 13.5042 +** ^The final callback parameter is the [rowid] of the row.
 13.5043 +** ^In the case of an update, this is the [rowid] after the update takes place.
 13.5044 +**
 13.5045 +** ^(The update hook is not invoked when internal system tables are
 13.5046 +** modified (i.e. sqlite_master and sqlite_sequence).)^
 13.5047 +** ^The update hook is not invoked when [WITHOUT ROWID] tables are modified.
 13.5048 +**
 13.5049 +** ^In the current implementation, the update hook
 13.5050 +** is not invoked when duplication rows are deleted because of an
 13.5051 +** [ON CONFLICT | ON CONFLICT REPLACE] clause.  ^Nor is the update hook
 13.5052 +** invoked when rows are deleted using the [truncate optimization].
 13.5053 +** The exceptions defined in this paragraph might change in a future
 13.5054 +** release of SQLite.
 13.5055 +**
 13.5056 +** The update hook implementation must not do anything that will modify
 13.5057 +** the database connection that invoked the update hook.  Any actions
 13.5058 +** to modify the database connection must be deferred until after the
 13.5059 +** completion of the [sqlite3_step()] call that triggered the update hook.
 13.5060 +** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
 13.5061 +** database connections for the meaning of "modify" in this paragraph.
 13.5062 +**
 13.5063 +** ^The sqlite3_update_hook(D,C,P) function
 13.5064 +** returns the P argument from the previous call
 13.5065 +** on the same [database connection] D, or NULL for
 13.5066 +** the first call on D.
 13.5067 +**
 13.5068 +** See also the [sqlite3_commit_hook()] and [sqlite3_rollback_hook()]
 13.5069 +** interfaces.
 13.5070 +*/
 13.5071 +SQLITE_API void *sqlite3_update_hook(
 13.5072 +  sqlite3*, 
 13.5073 +  void(*)(void *,int ,char const *,char const *,sqlite3_int64),
 13.5074 +  void*
 13.5075 +);
 13.5076 +
 13.5077 +/*
 13.5078 +** CAPI3REF: Enable Or Disable Shared Pager Cache
 13.5079 +**
 13.5080 +** ^(This routine enables or disables the sharing of the database cache
 13.5081 +** and schema data structures between [database connection | connections]
 13.5082 +** to the same database. Sharing is enabled if the argument is true
 13.5083 +** and disabled if the argument is false.)^
 13.5084 +**
 13.5085 +** ^Cache sharing is enabled and disabled for an entire process.
 13.5086 +** This is a change as of SQLite version 3.5.0. In prior versions of SQLite,
 13.5087 +** sharing was enabled or disabled for each thread separately.
 13.5088 +**
 13.5089 +** ^(The cache sharing mode set by this interface effects all subsequent
 13.5090 +** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()].
 13.5091 +** Existing database connections continue use the sharing mode
 13.5092 +** that was in effect at the time they were opened.)^
 13.5093 +**
 13.5094 +** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled
 13.5095 +** successfully.  An [error code] is returned otherwise.)^
 13.5096 +**
 13.5097 +** ^Shared cache is disabled by default. But this might change in
 13.5098 +** future releases of SQLite.  Applications that care about shared
 13.5099 +** cache setting should set it explicitly.
 13.5100 +**
 13.5101 +** This interface is threadsafe on processors where writing a
 13.5102 +** 32-bit integer is atomic.
 13.5103 +**
 13.5104 +** See Also:  [SQLite Shared-Cache Mode]
 13.5105 +*/
 13.5106 +SQLITE_API int sqlite3_enable_shared_cache(int);
 13.5107 +
 13.5108 +/*
 13.5109 +** CAPI3REF: Attempt To Free Heap Memory
 13.5110 +**
 13.5111 +** ^The sqlite3_release_memory() interface attempts to free N bytes
 13.5112 +** of heap memory by deallocating non-essential memory allocations
 13.5113 +** held by the database library.   Memory used to cache database
 13.5114 +** pages to improve performance is an example of non-essential memory.
 13.5115 +** ^sqlite3_release_memory() returns the number of bytes actually freed,
 13.5116 +** which might be more or less than the amount requested.
 13.5117 +** ^The sqlite3_release_memory() routine is a no-op returning zero
 13.5118 +** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT].
 13.5119 +**
 13.5120 +** See also: [sqlite3_db_release_memory()]
 13.5121 +*/
 13.5122 +SQLITE_API int sqlite3_release_memory(int);
 13.5123 +
 13.5124 +/*
 13.5125 +** CAPI3REF: Free Memory Used By A Database Connection
 13.5126 +**
 13.5127 +** ^The sqlite3_db_release_memory(D) interface attempts to free as much heap
 13.5128 +** memory as possible from database connection D. Unlike the
 13.5129 +** [sqlite3_release_memory()] interface, this interface is in effect even
 13.5130 +** when the [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is
 13.5131 +** omitted.
 13.5132 +**
 13.5133 +** See also: [sqlite3_release_memory()]
 13.5134 +*/
 13.5135 +SQLITE_API int sqlite3_db_release_memory(sqlite3*);
 13.5136 +
 13.5137 +/*
 13.5138 +** CAPI3REF: Impose A Limit On Heap Size
 13.5139 +**
 13.5140 +** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the
 13.5141 +** soft limit on the amount of heap memory that may be allocated by SQLite.
 13.5142 +** ^SQLite strives to keep heap memory utilization below the soft heap
 13.5143 +** limit by reducing the number of pages held in the page cache
 13.5144 +** as heap memory usages approaches the limit.
 13.5145 +** ^The soft heap limit is "soft" because even though SQLite strives to stay
 13.5146 +** below the limit, it will exceed the limit rather than generate
 13.5147 +** an [SQLITE_NOMEM] error.  In other words, the soft heap limit 
 13.5148 +** is advisory only.
 13.5149 +**
 13.5150 +** ^The return value from sqlite3_soft_heap_limit64() is the size of
 13.5151 +** the soft heap limit prior to the call, or negative in the case of an
 13.5152 +** error.  ^If the argument N is negative
 13.5153 +** then no change is made to the soft heap limit.  Hence, the current
 13.5154 +** size of the soft heap limit can be determined by invoking
 13.5155 +** sqlite3_soft_heap_limit64() with a negative argument.
 13.5156 +**
 13.5157 +** ^If the argument N is zero then the soft heap limit is disabled.
 13.5158 +**
 13.5159 +** ^(The soft heap limit is not enforced in the current implementation
 13.5160 +** if one or more of following conditions are true:
 13.5161 +**
 13.5162 +** <ul>
 13.5163 +** <li> The soft heap limit is set to zero.
 13.5164 +** <li> Memory accounting is disabled using a combination of the
 13.5165 +**      [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and
 13.5166 +**      the [SQLITE_DEFAULT_MEMSTATUS] compile-time option.
 13.5167 +** <li> An alternative page cache implementation is specified using
 13.5168 +**      [sqlite3_config]([SQLITE_CONFIG_PCACHE2],...).
 13.5169 +** <li> The page cache allocates from its own memory pool supplied
 13.5170 +**      by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than
 13.5171 +**      from the heap.
 13.5172 +** </ul>)^
 13.5173 +**
 13.5174 +** Beginning with SQLite version 3.7.3, the soft heap limit is enforced
 13.5175 +** regardless of whether or not the [SQLITE_ENABLE_MEMORY_MANAGEMENT]
 13.5176 +** compile-time option is invoked.  With [SQLITE_ENABLE_MEMORY_MANAGEMENT],
 13.5177 +** the soft heap limit is enforced on every memory allocation.  Without
 13.5178 +** [SQLITE_ENABLE_MEMORY_MANAGEMENT], the soft heap limit is only enforced
 13.5179 +** when memory is allocated by the page cache.  Testing suggests that because
 13.5180 +** the page cache is the predominate memory user in SQLite, most
 13.5181 +** applications will achieve adequate soft heap limit enforcement without
 13.5182 +** the use of [SQLITE_ENABLE_MEMORY_MANAGEMENT].
 13.5183 +**
 13.5184 +** The circumstances under which SQLite will enforce the soft heap limit may
 13.5185 +** changes in future releases of SQLite.
 13.5186 +*/
 13.5187 +SQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N);
 13.5188 +
 13.5189 +/*
 13.5190 +** CAPI3REF: Deprecated Soft Heap Limit Interface
 13.5191 +** DEPRECATED
 13.5192 +**
 13.5193 +** This is a deprecated version of the [sqlite3_soft_heap_limit64()]
 13.5194 +** interface.  This routine is provided for historical compatibility
 13.5195 +** only.  All new applications should use the
 13.5196 +** [sqlite3_soft_heap_limit64()] interface rather than this one.
 13.5197 +*/
 13.5198 +SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_limit(int N);
 13.5199 +
 13.5200 +
 13.5201 +/*
 13.5202 +** CAPI3REF: Extract Metadata About A Column Of A Table
 13.5203 +**
 13.5204 +** ^This routine returns metadata about a specific column of a specific
 13.5205 +** database table accessible using the [database connection] handle
 13.5206 +** passed as the first function argument.
 13.5207 +**
 13.5208 +** ^The column is identified by the second, third and fourth parameters to
 13.5209 +** this function. ^The second parameter is either the name of the database
 13.5210 +** (i.e. "main", "temp", or an attached database) containing the specified
 13.5211 +** table or NULL. ^If it is NULL, then all attached databases are searched
 13.5212 +** for the table using the same algorithm used by the database engine to
 13.5213 +** resolve unqualified table references.
 13.5214 +**
 13.5215 +** ^The third and fourth parameters to this function are the table and column
 13.5216 +** name of the desired column, respectively. Neither of these parameters
 13.5217 +** may be NULL.
 13.5218 +**
 13.5219 +** ^Metadata is returned by writing to the memory locations passed as the 5th
 13.5220 +** and subsequent parameters to this function. ^Any of these arguments may be
 13.5221 +** NULL, in which case the corresponding element of metadata is omitted.
 13.5222 +**
 13.5223 +** ^(<blockquote>
 13.5224 +** <table border="1">
 13.5225 +** <tr><th> Parameter <th> Output<br>Type <th>  Description
 13.5226 +**
 13.5227 +** <tr><td> 5th <td> const char* <td> Data type
 13.5228 +** <tr><td> 6th <td> const char* <td> Name of default collation sequence
 13.5229 +** <tr><td> 7th <td> int         <td> True if column has a NOT NULL constraint
 13.5230 +** <tr><td> 8th <td> int         <td> True if column is part of the PRIMARY KEY
 13.5231 +** <tr><td> 9th <td> int         <td> True if column is [AUTOINCREMENT]
 13.5232 +** </table>
 13.5233 +** </blockquote>)^
 13.5234 +**
 13.5235 +** ^The memory pointed to by the character pointers returned for the
 13.5236 +** declaration type and collation sequence is valid only until the next
 13.5237 +** call to any SQLite API function.
 13.5238 +**
 13.5239 +** ^If the specified table is actually a view, an [error code] is returned.
 13.5240 +**
 13.5241 +** ^If the specified column is "rowid", "oid" or "_rowid_" and an
 13.5242 +** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output
 13.5243 +** parameters are set for the explicitly declared column. ^(If there is no
 13.5244 +** explicitly declared [INTEGER PRIMARY KEY] column, then the output
 13.5245 +** parameters are set as follows:
 13.5246 +**
 13.5247 +** <pre>
 13.5248 +**     data type: "INTEGER"
 13.5249 +**     collation sequence: "BINARY"
 13.5250 +**     not null: 0
 13.5251 +**     primary key: 1
 13.5252 +**     auto increment: 0
 13.5253 +** </pre>)^
 13.5254 +**
 13.5255 +** ^(This function may load one or more schemas from database files. If an
 13.5256 +** error occurs during this process, or if the requested table or column
 13.5257 +** cannot be found, an [error code] is returned and an error message left
 13.5258 +** in the [database connection] (to be retrieved using sqlite3_errmsg()).)^
 13.5259 +**
 13.5260 +** ^This API is only available if the library was compiled with the
 13.5261 +** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined.
 13.5262 +*/
 13.5263 +SQLITE_API int sqlite3_table_column_metadata(
 13.5264 +  sqlite3 *db,                /* Connection handle */
 13.5265 +  const char *zDbName,        /* Database name or NULL */
 13.5266 +  const char *zTableName,     /* Table name */
 13.5267 +  const char *zColumnName,    /* Column name */
 13.5268 +  char const **pzDataType,    /* OUTPUT: Declared data type */
 13.5269 +  char const **pzCollSeq,     /* OUTPUT: Collation sequence name */
 13.5270 +  int *pNotNull,              /* OUTPUT: True if NOT NULL constraint exists */
 13.5271 +  int *pPrimaryKey,           /* OUTPUT: True if column part of PK */
 13.5272 +  int *pAutoinc               /* OUTPUT: True if column is auto-increment */
 13.5273 +);
 13.5274 +
 13.5275 +/*
 13.5276 +** CAPI3REF: Load An Extension
 13.5277 +**
 13.5278 +** ^This interface loads an SQLite extension library from the named file.
 13.5279 +**
 13.5280 +** ^The sqlite3_load_extension() interface attempts to load an
 13.5281 +** [SQLite extension] library contained in the file zFile.  If
 13.5282 +** the file cannot be loaded directly, attempts are made to load
 13.5283 +** with various operating-system specific extensions added.
 13.5284 +** So for example, if "samplelib" cannot be loaded, then names like
 13.5285 +** "samplelib.so" or "samplelib.dylib" or "samplelib.dll" might
 13.5286 +** be tried also.
 13.5287 +**
 13.5288 +** ^The entry point is zProc.
 13.5289 +** ^(zProc may be 0, in which case SQLite will try to come up with an
 13.5290 +** entry point name on its own.  It first tries "sqlite3_extension_init".
 13.5291 +** If that does not work, it constructs a name "sqlite3_X_init" where the
 13.5292 +** X is consists of the lower-case equivalent of all ASCII alphabetic
 13.5293 +** characters in the filename from the last "/" to the first following
 13.5294 +** "." and omitting any initial "lib".)^
 13.5295 +** ^The sqlite3_load_extension() interface returns
 13.5296 +** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.
 13.5297 +** ^If an error occurs and pzErrMsg is not 0, then the
 13.5298 +** [sqlite3_load_extension()] interface shall attempt to
 13.5299 +** fill *pzErrMsg with error message text stored in memory
 13.5300 +** obtained from [sqlite3_malloc()]. The calling function
 13.5301 +** should free this memory by calling [sqlite3_free()].
 13.5302 +**
 13.5303 +** ^Extension loading must be enabled using
 13.5304 +** [sqlite3_enable_load_extension()] prior to calling this API,
 13.5305 +** otherwise an error will be returned.
 13.5306 +**
 13.5307 +** See also the [load_extension() SQL function].
 13.5308 +*/
 13.5309 +SQLITE_API int sqlite3_load_extension(
 13.5310 +  sqlite3 *db,          /* Load the extension into this database connection */
 13.5311 +  const char *zFile,    /* Name of the shared library containing extension */
 13.5312 +  const char *zProc,    /* Entry point.  Derived from zFile if 0 */
 13.5313 +  char **pzErrMsg       /* Put error message here if not 0 */
 13.5314 +);
 13.5315 +
 13.5316 +/*
 13.5317 +** CAPI3REF: Enable Or Disable Extension Loading
 13.5318 +**
 13.5319 +** ^So as not to open security holes in older applications that are
 13.5320 +** unprepared to deal with [extension loading], and as a means of disabling
 13.5321 +** [extension loading] while evaluating user-entered SQL, the following API
 13.5322 +** is provided to turn the [sqlite3_load_extension()] mechanism on and off.
 13.5323 +**
 13.5324 +** ^Extension loading is off by default.
 13.5325 +** ^Call the sqlite3_enable_load_extension() routine with onoff==1
 13.5326 +** to turn extension loading on and call it with onoff==0 to turn
 13.5327 +** it back off again.
 13.5328 +*/
 13.5329 +SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff);
 13.5330 +
 13.5331 +/*
 13.5332 +** CAPI3REF: Automatically Load Statically Linked Extensions
 13.5333 +**
 13.5334 +** ^This interface causes the xEntryPoint() function to be invoked for
 13.5335 +** each new [database connection] that is created.  The idea here is that
 13.5336 +** xEntryPoint() is the entry point for a statically linked [SQLite extension]
 13.5337 +** that is to be automatically loaded into all new database connections.
 13.5338 +**
 13.5339 +** ^(Even though the function prototype shows that xEntryPoint() takes
 13.5340 +** no arguments and returns void, SQLite invokes xEntryPoint() with three
 13.5341 +** arguments and expects and integer result as if the signature of the
 13.5342 +** entry point where as follows:
 13.5343 +**
 13.5344 +** <blockquote><pre>
 13.5345 +** &nbsp;  int xEntryPoint(
 13.5346 +** &nbsp;    sqlite3 *db,
 13.5347 +** &nbsp;    const char **pzErrMsg,
 13.5348 +** &nbsp;    const struct sqlite3_api_routines *pThunk
 13.5349 +** &nbsp;  );
 13.5350 +** </pre></blockquote>)^
 13.5351 +**
 13.5352 +** If the xEntryPoint routine encounters an error, it should make *pzErrMsg
 13.5353 +** point to an appropriate error message (obtained from [sqlite3_mprintf()])
 13.5354 +** and return an appropriate [error code].  ^SQLite ensures that *pzErrMsg
 13.5355 +** is NULL before calling the xEntryPoint().  ^SQLite will invoke
 13.5356 +** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns.  ^If any
 13.5357 +** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()],
 13.5358 +** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail.
 13.5359 +**
 13.5360 +** ^Calling sqlite3_auto_extension(X) with an entry point X that is already
 13.5361 +** on the list of automatic extensions is a harmless no-op. ^No entry point
 13.5362 +** will be called more than once for each database connection that is opened.
 13.5363 +**
 13.5364 +** See also: [sqlite3_reset_auto_extension()]
 13.5365 +** and [sqlite3_cancel_auto_extension()]
 13.5366 +*/
 13.5367 +SQLITE_API int sqlite3_auto_extension(void (*xEntryPoint)(void));
 13.5368 +
 13.5369 +/*
 13.5370 +** CAPI3REF: Cancel Automatic Extension Loading
 13.5371 +**
 13.5372 +** ^The [sqlite3_cancel_auto_extension(X)] interface unregisters the
 13.5373 +** initialization routine X that was registered using a prior call to
 13.5374 +** [sqlite3_auto_extension(X)].  ^The [sqlite3_cancel_auto_extension(X)]
 13.5375 +** routine returns 1 if initialization routine X was successfully 
 13.5376 +** unregistered and it returns 0 if X was not on the list of initialization
 13.5377 +** routines.
 13.5378 +*/
 13.5379 +SQLITE_API int sqlite3_cancel_auto_extension(void (*xEntryPoint)(void));
 13.5380 +
 13.5381 +/*
 13.5382 +** CAPI3REF: Reset Automatic Extension Loading
 13.5383 +**
 13.5384 +** ^This interface disables all automatic extensions previously
 13.5385 +** registered using [sqlite3_auto_extension()].
 13.5386 +*/
 13.5387 +SQLITE_API void sqlite3_reset_auto_extension(void);
 13.5388 +
 13.5389 +/*
 13.5390 +** The interface to the virtual-table mechanism is currently considered
 13.5391 +** to be experimental.  The interface might change in incompatible ways.
 13.5392 +** If this is a problem for you, do not use the interface at this time.
 13.5393 +**
 13.5394 +** When the virtual-table mechanism stabilizes, we will declare the
 13.5395 +** interface fixed, support it indefinitely, and remove this comment.
 13.5396 +*/
 13.5397 +
 13.5398 +/*
 13.5399 +** Structures used by the virtual table interface
 13.5400 +*/
 13.5401 +typedef struct sqlite3_vtab sqlite3_vtab;
 13.5402 +typedef struct sqlite3_index_info sqlite3_index_info;
 13.5403 +typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor;
 13.5404 +typedef struct sqlite3_module sqlite3_module;
 13.5405 +
 13.5406 +/*
 13.5407 +** CAPI3REF: Virtual Table Object
 13.5408 +** KEYWORDS: sqlite3_module {virtual table module}
 13.5409 +**
 13.5410 +** This structure, sometimes called a "virtual table module", 
 13.5411 +** defines the implementation of a [virtual tables].  
 13.5412 +** This structure consists mostly of methods for the module.
 13.5413 +**
 13.5414 +** ^A virtual table module is created by filling in a persistent
 13.5415 +** instance of this structure and passing a pointer to that instance
 13.5416 +** to [sqlite3_create_module()] or [sqlite3_create_module_v2()].
 13.5417 +** ^The registration remains valid until it is replaced by a different
 13.5418 +** module or until the [database connection] closes.  The content
 13.5419 +** of this structure must not change while it is registered with
 13.5420 +** any database connection.
 13.5421 +*/
 13.5422 +struct sqlite3_module {
 13.5423 +  int iVersion;
 13.5424 +  int (*xCreate)(sqlite3*, void *pAux,
 13.5425 +               int argc, const char *const*argv,
 13.5426 +               sqlite3_vtab **ppVTab, char**);
 13.5427 +  int (*xConnect)(sqlite3*, void *pAux,
 13.5428 +               int argc, const char *const*argv,
 13.5429 +               sqlite3_vtab **ppVTab, char**);
 13.5430 +  int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*);
 13.5431 +  int (*xDisconnect)(sqlite3_vtab *pVTab);
 13.5432 +  int (*xDestroy)(sqlite3_vtab *pVTab);
 13.5433 +  int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor);
 13.5434 +  int (*xClose)(sqlite3_vtab_cursor*);
 13.5435 +  int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr,
 13.5436 +                int argc, sqlite3_value **argv);
 13.5437 +  int (*xNext)(sqlite3_vtab_cursor*);
 13.5438 +  int (*xEof)(sqlite3_vtab_cursor*);
 13.5439 +  int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int);
 13.5440 +  int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid);
 13.5441 +  int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *);
 13.5442 +  int (*xBegin)(sqlite3_vtab *pVTab);
 13.5443 +  int (*xSync)(sqlite3_vtab *pVTab);
 13.5444 +  int (*xCommit)(sqlite3_vtab *pVTab);
 13.5445 +  int (*xRollback)(sqlite3_vtab *pVTab);
 13.5446 +  int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName,
 13.5447 +                       void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),
 13.5448 +                       void **ppArg);
 13.5449 +  int (*xRename)(sqlite3_vtab *pVtab, const char *zNew);
 13.5450 +  /* The methods above are in version 1 of the sqlite_module object. Those 
 13.5451 +  ** below are for version 2 and greater. */
 13.5452 +  int (*xSavepoint)(sqlite3_vtab *pVTab, int);
 13.5453 +  int (*xRelease)(sqlite3_vtab *pVTab, int);
 13.5454 +  int (*xRollbackTo)(sqlite3_vtab *pVTab, int);
 13.5455 +};
 13.5456 +
 13.5457 +/*
 13.5458 +** CAPI3REF: Virtual Table Indexing Information
 13.5459 +** KEYWORDS: sqlite3_index_info
 13.5460 +**
 13.5461 +** The sqlite3_index_info structure and its substructures is used as part
 13.5462 +** of the [virtual table] interface to
 13.5463 +** pass information into and receive the reply from the [xBestIndex]
 13.5464 +** method of a [virtual table module].  The fields under **Inputs** are the
 13.5465 +** inputs to xBestIndex and are read-only.  xBestIndex inserts its
 13.5466 +** results into the **Outputs** fields.
 13.5467 +**
 13.5468 +** ^(The aConstraint[] array records WHERE clause constraints of the form:
 13.5469 +**
 13.5470 +** <blockquote>column OP expr</blockquote>
 13.5471 +**
 13.5472 +** where OP is =, &lt;, &lt;=, &gt;, or &gt;=.)^  ^(The particular operator is
 13.5473 +** stored in aConstraint[].op using one of the
 13.5474 +** [SQLITE_INDEX_CONSTRAINT_EQ | SQLITE_INDEX_CONSTRAINT_ values].)^
 13.5475 +** ^(The index of the column is stored in
 13.5476 +** aConstraint[].iColumn.)^  ^(aConstraint[].usable is TRUE if the
 13.5477 +** expr on the right-hand side can be evaluated (and thus the constraint
 13.5478 +** is usable) and false if it cannot.)^
 13.5479 +**
 13.5480 +** ^The optimizer automatically inverts terms of the form "expr OP column"
 13.5481 +** and makes other simplifications to the WHERE clause in an attempt to
 13.5482 +** get as many WHERE clause terms into the form shown above as possible.
 13.5483 +** ^The aConstraint[] array only reports WHERE clause terms that are
 13.5484 +** relevant to the particular virtual table being queried.
 13.5485 +**
 13.5486 +** ^Information about the ORDER BY clause is stored in aOrderBy[].
 13.5487 +** ^Each term of aOrderBy records a column of the ORDER BY clause.
 13.5488 +**
 13.5489 +** The [xBestIndex] method must fill aConstraintUsage[] with information
 13.5490 +** about what parameters to pass to xFilter.  ^If argvIndex>0 then
 13.5491 +** the right-hand side of the corresponding aConstraint[] is evaluated
 13.5492 +** and becomes the argvIndex-th entry in argv.  ^(If aConstraintUsage[].omit
 13.5493 +** is true, then the constraint is assumed to be fully handled by the
 13.5494 +** virtual table and is not checked again by SQLite.)^
 13.5495 +**
 13.5496 +** ^The idxNum and idxPtr values are recorded and passed into the
 13.5497 +** [xFilter] method.
 13.5498 +** ^[sqlite3_free()] is used to free idxPtr if and only if
 13.5499 +** needToFreeIdxPtr is true.
 13.5500 +**
 13.5501 +** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in
 13.5502 +** the correct order to satisfy the ORDER BY clause so that no separate
 13.5503 +** sorting step is required.
 13.5504 +**
 13.5505 +** ^The estimatedCost value is an estimate of the cost of a particular
 13.5506 +** strategy. A cost of N indicates that the cost of the strategy is similar
 13.5507 +** to a linear scan of an SQLite table with N rows. A cost of log(N) 
 13.5508 +** indicates that the expense of the operation is similar to that of a
 13.5509 +** binary search on a unique indexed field of an SQLite table with N rows.
 13.5510 +**
 13.5511 +** ^The estimatedRows value is an estimate of the number of rows that
 13.5512 +** will be returned by the strategy.
 13.5513 +**
 13.5514 +** IMPORTANT: The estimatedRows field was added to the sqlite3_index_info
 13.5515 +** structure for SQLite version 3.8.2. If a virtual table extension is
 13.5516 +** used with an SQLite version earlier than 3.8.2, the results of attempting 
 13.5517 +** to read or write the estimatedRows field are undefined (but are likely 
 13.5518 +** to included crashing the application). The estimatedRows field should
 13.5519 +** therefore only be used if [sqlite3_libversion_number()] returns a
 13.5520 +** value greater than or equal to 3008002.
 13.5521 +*/
 13.5522 +struct sqlite3_index_info {
 13.5523 +  /* Inputs */
 13.5524 +  int nConstraint;           /* Number of entries in aConstraint */
 13.5525 +  struct sqlite3_index_constraint {
 13.5526 +     int iColumn;              /* Column on left-hand side of constraint */
 13.5527 +     unsigned char op;         /* Constraint operator */
 13.5528 +     unsigned char usable;     /* True if this constraint is usable */
 13.5529 +     int iTermOffset;          /* Used internally - xBestIndex should ignore */
 13.5530 +  } *aConstraint;            /* Table of WHERE clause constraints */
 13.5531 +  int nOrderBy;              /* Number of terms in the ORDER BY clause */
 13.5532 +  struct sqlite3_index_orderby {
 13.5533 +     int iColumn;              /* Column number */
 13.5534 +     unsigned char desc;       /* True for DESC.  False for ASC. */
 13.5535 +  } *aOrderBy;               /* The ORDER BY clause */
 13.5536 +  /* Outputs */
 13.5537 +  struct sqlite3_index_constraint_usage {
 13.5538 +    int argvIndex;           /* if >0, constraint is part of argv to xFilter */
 13.5539 +    unsigned char omit;      /* Do not code a test for this constraint */
 13.5540 +  } *aConstraintUsage;
 13.5541 +  int idxNum;                /* Number used to identify the index */
 13.5542 +  char *idxStr;              /* String, possibly obtained from sqlite3_malloc */
 13.5543 +  int needToFreeIdxStr;      /* Free idxStr using sqlite3_free() if true */
 13.5544 +  int orderByConsumed;       /* True if output is already ordered */
 13.5545 +  double estimatedCost;           /* Estimated cost of using this index */
 13.5546 +  /* Fields below are only available in SQLite 3.8.2 and later */
 13.5547 +  sqlite3_int64 estimatedRows;    /* Estimated number of rows returned */
 13.5548 +};
 13.5549 +
 13.5550 +/*
 13.5551 +** CAPI3REF: Virtual Table Constraint Operator Codes
 13.5552 +**
 13.5553 +** These macros defined the allowed values for the
 13.5554 +** [sqlite3_index_info].aConstraint[].op field.  Each value represents
 13.5555 +** an operator that is part of a constraint term in the wHERE clause of
 13.5556 +** a query that uses a [virtual table].
 13.5557 +*/
 13.5558 +#define SQLITE_INDEX_CONSTRAINT_EQ    2
 13.5559 +#define SQLITE_INDEX_CONSTRAINT_GT    4
 13.5560 +#define SQLITE_INDEX_CONSTRAINT_LE    8
 13.5561 +#define SQLITE_INDEX_CONSTRAINT_LT    16
 13.5562 +#define SQLITE_INDEX_CONSTRAINT_GE    32
 13.5563 +#define SQLITE_INDEX_CONSTRAINT_MATCH 64
 13.5564 +
 13.5565 +/*
 13.5566 +** CAPI3REF: Register A Virtual Table Implementation
 13.5567 +**
 13.5568 +** ^These routines are used to register a new [virtual table module] name.
 13.5569 +** ^Module names must be registered before
 13.5570 +** creating a new [virtual table] using the module and before using a
 13.5571 +** preexisting [virtual table] for the module.
 13.5572 +**
 13.5573 +** ^The module name is registered on the [database connection] specified
 13.5574 +** by the first parameter.  ^The name of the module is given by the 
 13.5575 +** second parameter.  ^The third parameter is a pointer to
 13.5576 +** the implementation of the [virtual table module].   ^The fourth
 13.5577 +** parameter is an arbitrary client data pointer that is passed through
 13.5578 +** into the [xCreate] and [xConnect] methods of the virtual table module
 13.5579 +** when a new virtual table is be being created or reinitialized.
 13.5580 +**
 13.5581 +** ^The sqlite3_create_module_v2() interface has a fifth parameter which
 13.5582 +** is a pointer to a destructor for the pClientData.  ^SQLite will
 13.5583 +** invoke the destructor function (if it is not NULL) when SQLite
 13.5584 +** no longer needs the pClientData pointer.  ^The destructor will also
 13.5585 +** be invoked if the call to sqlite3_create_module_v2() fails.
 13.5586 +** ^The sqlite3_create_module()
 13.5587 +** interface is equivalent to sqlite3_create_module_v2() with a NULL
 13.5588 +** destructor.
 13.5589 +*/
 13.5590 +SQLITE_API int sqlite3_create_module(
 13.5591 +  sqlite3 *db,               /* SQLite connection to register module with */
 13.5592 +  const char *zName,         /* Name of the module */
 13.5593 +  const sqlite3_module *p,   /* Methods for the module */
 13.5594 +  void *pClientData          /* Client data for xCreate/xConnect */
 13.5595 +);
 13.5596 +SQLITE_API int sqlite3_create_module_v2(
 13.5597 +  sqlite3 *db,               /* SQLite connection to register module with */
 13.5598 +  const char *zName,         /* Name of the module */
 13.5599 +  const sqlite3_module *p,   /* Methods for the module */
 13.5600 +  void *pClientData,         /* Client data for xCreate/xConnect */
 13.5601 +  void(*xDestroy)(void*)     /* Module destructor function */
 13.5602 +);
 13.5603 +
 13.5604 +/*
 13.5605 +** CAPI3REF: Virtual Table Instance Object
 13.5606 +** KEYWORDS: sqlite3_vtab
 13.5607 +**
 13.5608 +** Every [virtual table module] implementation uses a subclass
 13.5609 +** of this object to describe a particular instance
 13.5610 +** of the [virtual table].  Each subclass will
 13.5611 +** be tailored to the specific needs of the module implementation.
 13.5612 +** The purpose of this superclass is to define certain fields that are
 13.5613 +** common to all module implementations.
 13.5614 +**
 13.5615 +** ^Virtual tables methods can set an error message by assigning a
 13.5616 +** string obtained from [sqlite3_mprintf()] to zErrMsg.  The method should
 13.5617 +** take care that any prior string is freed by a call to [sqlite3_free()]
 13.5618 +** prior to assigning a new string to zErrMsg.  ^After the error message
 13.5619 +** is delivered up to the client application, the string will be automatically
 13.5620 +** freed by sqlite3_free() and the zErrMsg field will be zeroed.
 13.5621 +*/
 13.5622 +struct sqlite3_vtab {
 13.5623 +  const sqlite3_module *pModule;  /* The module for this virtual table */
 13.5624 +  int nRef;                       /* NO LONGER USED */
 13.5625 +  char *zErrMsg;                  /* Error message from sqlite3_mprintf() */
 13.5626 +  /* Virtual table implementations will typically add additional fields */
 13.5627 +};
 13.5628 +
 13.5629 +/*
 13.5630 +** CAPI3REF: Virtual Table Cursor Object
 13.5631 +** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor}
 13.5632 +**
 13.5633 +** Every [virtual table module] implementation uses a subclass of the
 13.5634 +** following structure to describe cursors that point into the
 13.5635 +** [virtual table] and are used
 13.5636 +** to loop through the virtual table.  Cursors are created using the
 13.5637 +** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed
 13.5638 +** by the [sqlite3_module.xClose | xClose] method.  Cursors are used
 13.5639 +** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods
 13.5640 +** of the module.  Each module implementation will define
 13.5641 +** the content of a cursor structure to suit its own needs.
 13.5642 +**
 13.5643 +** This superclass exists in order to define fields of the cursor that
 13.5644 +** are common to all implementations.
 13.5645 +*/
 13.5646 +struct sqlite3_vtab_cursor {
 13.5647 +  sqlite3_vtab *pVtab;      /* Virtual table of this cursor */
 13.5648 +  /* Virtual table implementations will typically add additional fields */
 13.5649 +};
 13.5650 +
 13.5651 +/*
 13.5652 +** CAPI3REF: Declare The Schema Of A Virtual Table
 13.5653 +**
 13.5654 +** ^The [xCreate] and [xConnect] methods of a
 13.5655 +** [virtual table module] call this interface
 13.5656 +** to declare the format (the names and datatypes of the columns) of
 13.5657 +** the virtual tables they implement.
 13.5658 +*/
 13.5659 +SQLITE_API int sqlite3_declare_vtab(sqlite3*, const char *zSQL);
 13.5660 +
 13.5661 +/*
 13.5662 +** CAPI3REF: Overload A Function For A Virtual Table
 13.5663 +**
 13.5664 +** ^(Virtual tables can provide alternative implementations of functions
 13.5665 +** using the [xFindFunction] method of the [virtual table module].  
 13.5666 +** But global versions of those functions
 13.5667 +** must exist in order to be overloaded.)^
 13.5668 +**
 13.5669 +** ^(This API makes sure a global version of a function with a particular
 13.5670 +** name and number of parameters exists.  If no such function exists
 13.5671 +** before this API is called, a new function is created.)^  ^The implementation
 13.5672 +** of the new function always causes an exception to be thrown.  So
 13.5673 +** the new function is not good for anything by itself.  Its only
 13.5674 +** purpose is to be a placeholder function that can be overloaded
 13.5675 +** by a [virtual table].
 13.5676 +*/
 13.5677 +SQLITE_API int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg);
 13.5678 +
 13.5679 +/*
 13.5680 +** The interface to the virtual-table mechanism defined above (back up
 13.5681 +** to a comment remarkably similar to this one) is currently considered
 13.5682 +** to be experimental.  The interface might change in incompatible ways.
 13.5683 +** If this is a problem for you, do not use the interface at this time.
 13.5684 +**
 13.5685 +** When the virtual-table mechanism stabilizes, we will declare the
 13.5686 +** interface fixed, support it indefinitely, and remove this comment.
 13.5687 +*/
 13.5688 +
 13.5689 +/*
 13.5690 +** CAPI3REF: A Handle To An Open BLOB
 13.5691 +** KEYWORDS: {BLOB handle} {BLOB handles}
 13.5692 +**
 13.5693 +** An instance of this object represents an open BLOB on which
 13.5694 +** [sqlite3_blob_open | incremental BLOB I/O] can be performed.
 13.5695 +** ^Objects of this type are created by [sqlite3_blob_open()]
 13.5696 +** and destroyed by [sqlite3_blob_close()].
 13.5697 +** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces
 13.5698 +** can be used to read or write small subsections of the BLOB.
 13.5699 +** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes.
 13.5700 +*/
 13.5701 +typedef struct sqlite3_blob sqlite3_blob;
 13.5702 +
 13.5703 +/*
 13.5704 +** CAPI3REF: Open A BLOB For Incremental I/O
 13.5705 +**
 13.5706 +** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located
 13.5707 +** in row iRow, column zColumn, table zTable in database zDb;
 13.5708 +** in other words, the same BLOB that would be selected by:
 13.5709 +**
 13.5710 +** <pre>
 13.5711 +**     SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow;
 13.5712 +** </pre>)^
 13.5713 +**
 13.5714 +** ^If the flags parameter is non-zero, then the BLOB is opened for read
 13.5715 +** and write access. ^If it is zero, the BLOB is opened for read access.
 13.5716 +** ^It is not possible to open a column that is part of an index or primary 
 13.5717 +** key for writing. ^If [foreign key constraints] are enabled, it is 
 13.5718 +** not possible to open a column that is part of a [child key] for writing.
 13.5719 +**
 13.5720 +** ^Note that the database name is not the filename that contains
 13.5721 +** the database but rather the symbolic name of the database that
 13.5722 +** appears after the AS keyword when the database is connected using [ATTACH].
 13.5723 +** ^For the main database file, the database name is "main".
 13.5724 +** ^For TEMP tables, the database name is "temp".
 13.5725 +**
 13.5726 +** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is written
 13.5727 +** to *ppBlob. Otherwise an [error code] is returned and *ppBlob is set
 13.5728 +** to be a null pointer.)^
 13.5729 +** ^This function sets the [database connection] error code and message
 13.5730 +** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()] and related
 13.5731 +** functions. ^Note that the *ppBlob variable is always initialized in a
 13.5732 +** way that makes it safe to invoke [sqlite3_blob_close()] on *ppBlob
 13.5733 +** regardless of the success or failure of this routine.
 13.5734 +**
 13.5735 +** ^(If the row that a BLOB handle points to is modified by an
 13.5736 +** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects
 13.5737 +** then the BLOB handle is marked as "expired".
 13.5738 +** This is true if any column of the row is changed, even a column
 13.5739 +** other than the one the BLOB handle is open on.)^
 13.5740 +** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for
 13.5741 +** an expired BLOB handle fail with a return code of [SQLITE_ABORT].
 13.5742 +** ^(Changes written into a BLOB prior to the BLOB expiring are not
 13.5743 +** rolled back by the expiration of the BLOB.  Such changes will eventually
 13.5744 +** commit if the transaction continues to completion.)^
 13.5745 +**
 13.5746 +** ^Use the [sqlite3_blob_bytes()] interface to determine the size of
 13.5747 +** the opened blob.  ^The size of a blob may not be changed by this
 13.5748 +** interface.  Use the [UPDATE] SQL command to change the size of a
 13.5749 +** blob.
 13.5750 +**
 13.5751 +** ^The [sqlite3_blob_open()] interface will fail for a [WITHOUT ROWID]
 13.5752 +** table.  Incremental BLOB I/O is not possible on [WITHOUT ROWID] tables.
 13.5753 +**
 13.5754 +** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces
 13.5755 +** and the built-in [zeroblob] SQL function can be used, if desired,
 13.5756 +** to create an empty, zero-filled blob in which to read or write using
 13.5757 +** this interface.
 13.5758 +**
 13.5759 +** To avoid a resource leak, every open [BLOB handle] should eventually
 13.5760 +** be released by a call to [sqlite3_blob_close()].
 13.5761 +*/
 13.5762 +SQLITE_API int sqlite3_blob_open(
 13.5763 +  sqlite3*,
 13.5764 +  const char *zDb,
 13.5765 +  const char *zTable,
 13.5766 +  const char *zColumn,
 13.5767 +  sqlite3_int64 iRow,
 13.5768 +  int flags,
 13.5769 +  sqlite3_blob **ppBlob
 13.5770 +);
 13.5771 +
 13.5772 +/*
 13.5773 +** CAPI3REF: Move a BLOB Handle to a New Row
 13.5774 +**
 13.5775 +** ^This function is used to move an existing blob handle so that it points
 13.5776 +** to a different row of the same database table. ^The new row is identified
 13.5777 +** by the rowid value passed as the second argument. Only the row can be
 13.5778 +** changed. ^The database, table and column on which the blob handle is open
 13.5779 +** remain the same. Moving an existing blob handle to a new row can be
 13.5780 +** faster than closing the existing handle and opening a new one.
 13.5781 +**
 13.5782 +** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] -
 13.5783 +** it must exist and there must be either a blob or text value stored in
 13.5784 +** the nominated column.)^ ^If the new row is not present in the table, or if
 13.5785 +** it does not contain a blob or text value, or if another error occurs, an
 13.5786 +** SQLite error code is returned and the blob handle is considered aborted.
 13.5787 +** ^All subsequent calls to [sqlite3_blob_read()], [sqlite3_blob_write()] or
 13.5788 +** [sqlite3_blob_reopen()] on an aborted blob handle immediately return
 13.5789 +** SQLITE_ABORT. ^Calling [sqlite3_blob_bytes()] on an aborted blob handle
 13.5790 +** always returns zero.
 13.5791 +**
 13.5792 +** ^This function sets the database handle error code and message.
 13.5793 +*/
 13.5794 +SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64);
 13.5795 +
 13.5796 +/*
 13.5797 +** CAPI3REF: Close A BLOB Handle
 13.5798 +**
 13.5799 +** ^Closes an open [BLOB handle].
 13.5800 +**
 13.5801 +** ^Closing a BLOB shall cause the current transaction to commit
 13.5802 +** if there are no other BLOBs, no pending prepared statements, and the
 13.5803 +** database connection is in [autocommit mode].
 13.5804 +** ^If any writes were made to the BLOB, they might be held in cache
 13.5805 +** until the close operation if they will fit.
 13.5806 +**
 13.5807 +** ^(Closing the BLOB often forces the changes
 13.5808 +** out to disk and so if any I/O errors occur, they will likely occur
 13.5809 +** at the time when the BLOB is closed.  Any errors that occur during
 13.5810 +** closing are reported as a non-zero return value.)^
 13.5811 +**
 13.5812 +** ^(The BLOB is closed unconditionally.  Even if this routine returns
 13.5813 +** an error code, the BLOB is still closed.)^
 13.5814 +**
 13.5815 +** ^Calling this routine with a null pointer (such as would be returned
 13.5816 +** by a failed call to [sqlite3_blob_open()]) is a harmless no-op.
 13.5817 +*/
 13.5818 +SQLITE_API int sqlite3_blob_close(sqlite3_blob *);
 13.5819 +
 13.5820 +/*
 13.5821 +** CAPI3REF: Return The Size Of An Open BLOB
 13.5822 +**
 13.5823 +** ^Returns the size in bytes of the BLOB accessible via the 
 13.5824 +** successfully opened [BLOB handle] in its only argument.  ^The
 13.5825 +** incremental blob I/O routines can only read or overwriting existing
 13.5826 +** blob content; they cannot change the size of a blob.
 13.5827 +**
 13.5828 +** This routine only works on a [BLOB handle] which has been created
 13.5829 +** by a prior successful call to [sqlite3_blob_open()] and which has not
 13.5830 +** been closed by [sqlite3_blob_close()].  Passing any other pointer in
 13.5831 +** to this routine results in undefined and probably undesirable behavior.
 13.5832 +*/
 13.5833 +SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *);
 13.5834 +
 13.5835 +/*
 13.5836 +** CAPI3REF: Read Data From A BLOB Incrementally
 13.5837 +**
 13.5838 +** ^(This function is used to read data from an open [BLOB handle] into a
 13.5839 +** caller-supplied buffer. N bytes of data are copied into buffer Z
 13.5840 +** from the open BLOB, starting at offset iOffset.)^
 13.5841 +**
 13.5842 +** ^If offset iOffset is less than N bytes from the end of the BLOB,
 13.5843 +** [SQLITE_ERROR] is returned and no data is read.  ^If N or iOffset is
 13.5844 +** less than zero, [SQLITE_ERROR] is returned and no data is read.
 13.5845 +** ^The size of the blob (and hence the maximum value of N+iOffset)
 13.5846 +** can be determined using the [sqlite3_blob_bytes()] interface.
 13.5847 +**
 13.5848 +** ^An attempt to read from an expired [BLOB handle] fails with an
 13.5849 +** error code of [SQLITE_ABORT].
 13.5850 +**
 13.5851 +** ^(On success, sqlite3_blob_read() returns SQLITE_OK.
 13.5852 +** Otherwise, an [error code] or an [extended error code] is returned.)^
 13.5853 +**
 13.5854 +** This routine only works on a [BLOB handle] which has been created
 13.5855 +** by a prior successful call to [sqlite3_blob_open()] and which has not
 13.5856 +** been closed by [sqlite3_blob_close()].  Passing any other pointer in
 13.5857 +** to this routine results in undefined and probably undesirable behavior.
 13.5858 +**
 13.5859 +** See also: [sqlite3_blob_write()].
 13.5860 +*/
 13.5861 +SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset);
 13.5862 +
 13.5863 +/*
 13.5864 +** CAPI3REF: Write Data Into A BLOB Incrementally
 13.5865 +**
 13.5866 +** ^This function is used to write data into an open [BLOB handle] from a
 13.5867 +** caller-supplied buffer. ^N bytes of data are copied from the buffer Z
 13.5868 +** into the open BLOB, starting at offset iOffset.
 13.5869 +**
 13.5870 +** ^If the [BLOB handle] passed as the first argument was not opened for
 13.5871 +** writing (the flags parameter to [sqlite3_blob_open()] was zero),
 13.5872 +** this function returns [SQLITE_READONLY].
 13.5873 +**
 13.5874 +** ^This function may only modify the contents of the BLOB; it is
 13.5875 +** not possible to increase the size of a BLOB using this API.
 13.5876 +** ^If offset iOffset is less than N bytes from the end of the BLOB,
 13.5877 +** [SQLITE_ERROR] is returned and no data is written.  ^If N is
 13.5878 +** less than zero [SQLITE_ERROR] is returned and no data is written.
 13.5879 +** The size of the BLOB (and hence the maximum value of N+iOffset)
 13.5880 +** can be determined using the [sqlite3_blob_bytes()] interface.
 13.5881 +**
 13.5882 +** ^An attempt to write to an expired [BLOB handle] fails with an
 13.5883 +** error code of [SQLITE_ABORT].  ^Writes to the BLOB that occurred
 13.5884 +** before the [BLOB handle] expired are not rolled back by the
 13.5885 +** expiration of the handle, though of course those changes might
 13.5886 +** have been overwritten by the statement that expired the BLOB handle
 13.5887 +** or by other independent statements.
 13.5888 +**
 13.5889 +** ^(On success, sqlite3_blob_write() returns SQLITE_OK.
 13.5890 +** Otherwise, an  [error code] or an [extended error code] is returned.)^
 13.5891 +**
 13.5892 +** This routine only works on a [BLOB handle] which has been created
 13.5893 +** by a prior successful call to [sqlite3_blob_open()] and which has not
 13.5894 +** been closed by [sqlite3_blob_close()].  Passing any other pointer in
 13.5895 +** to this routine results in undefined and probably undesirable behavior.
 13.5896 +**
 13.5897 +** See also: [sqlite3_blob_read()].
 13.5898 +*/
 13.5899 +SQLITE_API int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset);
 13.5900 +
 13.5901 +/*
 13.5902 +** CAPI3REF: Virtual File System Objects
 13.5903 +**
 13.5904 +** A virtual filesystem (VFS) is an [sqlite3_vfs] object
 13.5905 +** that SQLite uses to interact
 13.5906 +** with the underlying operating system.  Most SQLite builds come with a
 13.5907 +** single default VFS that is appropriate for the host computer.
 13.5908 +** New VFSes can be registered and existing VFSes can be unregistered.
 13.5909 +** The following interfaces are provided.
 13.5910 +**
 13.5911 +** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name.
 13.5912 +** ^Names are case sensitive.
 13.5913 +** ^Names are zero-terminated UTF-8 strings.
 13.5914 +** ^If there is no match, a NULL pointer is returned.
 13.5915 +** ^If zVfsName is NULL then the default VFS is returned.
 13.5916 +**
 13.5917 +** ^New VFSes are registered with sqlite3_vfs_register().
 13.5918 +** ^Each new VFS becomes the default VFS if the makeDflt flag is set.
 13.5919 +** ^The same VFS can be registered multiple times without injury.
 13.5920 +** ^To make an existing VFS into the default VFS, register it again
 13.5921 +** with the makeDflt flag set.  If two different VFSes with the
 13.5922 +** same name are registered, the behavior is undefined.  If a
 13.5923 +** VFS is registered with a name that is NULL or an empty string,
 13.5924 +** then the behavior is undefined.
 13.5925 +**
 13.5926 +** ^Unregister a VFS with the sqlite3_vfs_unregister() interface.
 13.5927 +** ^(If the default VFS is unregistered, another VFS is chosen as
 13.5928 +** the default.  The choice for the new VFS is arbitrary.)^
 13.5929 +*/
 13.5930 +SQLITE_API sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName);
 13.5931 +SQLITE_API int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);
 13.5932 +SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);
 13.5933 +
 13.5934 +/*
 13.5935 +** CAPI3REF: Mutexes
 13.5936 +**
 13.5937 +** The SQLite core uses these routines for thread
 13.5938 +** synchronization. Though they are intended for internal
 13.5939 +** use by SQLite, code that links against SQLite is
 13.5940 +** permitted to use any of these routines.
 13.5941 +**
 13.5942 +** The SQLite source code contains multiple implementations
 13.5943 +** of these mutex routines.  An appropriate implementation
 13.5944 +** is selected automatically at compile-time.  ^(The following
 13.5945 +** implementations are available in the SQLite core:
 13.5946 +**
 13.5947 +** <ul>
 13.5948 +** <li>   SQLITE_MUTEX_PTHREADS
 13.5949 +** <li>   SQLITE_MUTEX_W32
 13.5950 +** <li>   SQLITE_MUTEX_NOOP
 13.5951 +** </ul>)^
 13.5952 +**
 13.5953 +** ^The SQLITE_MUTEX_NOOP implementation is a set of routines
 13.5954 +** that does no real locking and is appropriate for use in
 13.5955 +** a single-threaded application.  ^The SQLITE_MUTEX_PTHREADS and
 13.5956 +** SQLITE_MUTEX_W32 implementations are appropriate for use on Unix
 13.5957 +** and Windows.
 13.5958 +**
 13.5959 +** ^(If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor
 13.5960 +** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex
 13.5961 +** implementation is included with the library. In this case the
 13.5962 +** application must supply a custom mutex implementation using the
 13.5963 +** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function
 13.5964 +** before calling sqlite3_initialize() or any other public sqlite3_
 13.5965 +** function that calls sqlite3_initialize().)^
 13.5966 +**
 13.5967 +** ^The sqlite3_mutex_alloc() routine allocates a new
 13.5968 +** mutex and returns a pointer to it. ^If it returns NULL
 13.5969 +** that means that a mutex could not be allocated.  ^SQLite
 13.5970 +** will unwind its stack and return an error.  ^(The argument
 13.5971 +** to sqlite3_mutex_alloc() is one of these integer constants:
 13.5972 +**
 13.5973 +** <ul>
 13.5974 +** <li>  SQLITE_MUTEX_FAST
 13.5975 +** <li>  SQLITE_MUTEX_RECURSIVE
 13.5976 +** <li>  SQLITE_MUTEX_STATIC_MASTER
 13.5977 +** <li>  SQLITE_MUTEX_STATIC_MEM
 13.5978 +** <li>  SQLITE_MUTEX_STATIC_OPEN
 13.5979 +** <li>  SQLITE_MUTEX_STATIC_PRNG
 13.5980 +** <li>  SQLITE_MUTEX_STATIC_LRU
 13.5981 +** <li>  SQLITE_MUTEX_STATIC_PMEM
 13.5982 +** <li>  SQLITE_MUTEX_STATIC_APP1
 13.5983 +** <li>  SQLITE_MUTEX_STATIC_APP2
 13.5984 +** </ul>)^
 13.5985 +**
 13.5986 +** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE)
 13.5987 +** cause sqlite3_mutex_alloc() to create
 13.5988 +** a new mutex.  ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
 13.5989 +** is used but not necessarily so when SQLITE_MUTEX_FAST is used.
 13.5990 +** The mutex implementation does not need to make a distinction
 13.5991 +** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
 13.5992 +** not want to.  ^SQLite will only request a recursive mutex in
 13.5993 +** cases where it really needs one.  ^If a faster non-recursive mutex
 13.5994 +** implementation is available on the host platform, the mutex subsystem
 13.5995 +** might return such a mutex in response to SQLITE_MUTEX_FAST.
 13.5996 +**
 13.5997 +** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other
 13.5998 +** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return
 13.5999 +** a pointer to a static preexisting mutex.  ^Six static mutexes are
 13.6000 +** used by the current version of SQLite.  Future versions of SQLite
 13.6001 +** may add additional static mutexes.  Static mutexes are for internal
 13.6002 +** use by SQLite only.  Applications that use SQLite mutexes should
 13.6003 +** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
 13.6004 +** SQLITE_MUTEX_RECURSIVE.
 13.6005 +**
 13.6006 +** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
 13.6007 +** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
 13.6008 +** returns a different mutex on every call.  ^But for the static
 13.6009 +** mutex types, the same mutex is returned on every call that has
 13.6010 +** the same type number.
 13.6011 +**
 13.6012 +** ^The sqlite3_mutex_free() routine deallocates a previously
 13.6013 +** allocated dynamic mutex.  ^SQLite is careful to deallocate every
 13.6014 +** dynamic mutex that it allocates.  The dynamic mutexes must not be in
 13.6015 +** use when they are deallocated.  Attempting to deallocate a static
 13.6016 +** mutex results in undefined behavior.  ^SQLite never deallocates
 13.6017 +** a static mutex.
 13.6018 +**
 13.6019 +** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
 13.6020 +** to enter a mutex.  ^If another thread is already within the mutex,
 13.6021 +** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
 13.6022 +** SQLITE_BUSY.  ^The sqlite3_mutex_try() interface returns [SQLITE_OK]
 13.6023 +** upon successful entry.  ^(Mutexes created using
 13.6024 +** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread.
 13.6025 +** In such cases the,
 13.6026 +** mutex must be exited an equal number of times before another thread
 13.6027 +** can enter.)^  ^(If the same thread tries to enter any other
 13.6028 +** kind of mutex more than once, the behavior is undefined.
 13.6029 +** SQLite will never exhibit
 13.6030 +** such behavior in its own use of mutexes.)^
 13.6031 +**
 13.6032 +** ^(Some systems (for example, Windows 95) do not support the operation
 13.6033 +** implemented by sqlite3_mutex_try().  On those systems, sqlite3_mutex_try()
 13.6034 +** will always return SQLITE_BUSY.  The SQLite core only ever uses
 13.6035 +** sqlite3_mutex_try() as an optimization so this is acceptable behavior.)^
 13.6036 +**
 13.6037 +** ^The sqlite3_mutex_leave() routine exits a mutex that was
 13.6038 +** previously entered by the same thread.   ^(The behavior
 13.6039 +** is undefined if the mutex is not currently entered by the
 13.6040 +** calling thread or is not currently allocated.  SQLite will
 13.6041 +** never do either.)^
 13.6042 +**
 13.6043 +** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or
 13.6044 +** sqlite3_mutex_leave() is a NULL pointer, then all three routines
 13.6045 +** behave as no-ops.
 13.6046 +**
 13.6047 +** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()].
 13.6048 +*/
 13.6049 +SQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int);
 13.6050 +SQLITE_API void sqlite3_mutex_free(sqlite3_mutex*);
 13.6051 +SQLITE_API void sqlite3_mutex_enter(sqlite3_mutex*);
 13.6052 +SQLITE_API int sqlite3_mutex_try(sqlite3_mutex*);
 13.6053 +SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*);
 13.6054 +
 13.6055 +/*
 13.6056 +** CAPI3REF: Mutex Methods Object
 13.6057 +**
 13.6058 +** An instance of this structure defines the low-level routines
 13.6059 +** used to allocate and use mutexes.
 13.6060 +**
 13.6061 +** Usually, the default mutex implementations provided by SQLite are
 13.6062 +** sufficient, however the user has the option of substituting a custom
 13.6063 +** implementation for specialized deployments or systems for which SQLite
 13.6064 +** does not provide a suitable implementation. In this case, the user
 13.6065 +** creates and populates an instance of this structure to pass
 13.6066 +** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option.
 13.6067 +** Additionally, an instance of this structure can be used as an
 13.6068 +** output variable when querying the system for the current mutex
 13.6069 +** implementation, using the [SQLITE_CONFIG_GETMUTEX] option.
 13.6070 +**
 13.6071 +** ^The xMutexInit method defined by this structure is invoked as
 13.6072 +** part of system initialization by the sqlite3_initialize() function.
 13.6073 +** ^The xMutexInit routine is called by SQLite exactly once for each
 13.6074 +** effective call to [sqlite3_initialize()].
 13.6075 +**
 13.6076 +** ^The xMutexEnd method defined by this structure is invoked as
 13.6077 +** part of system shutdown by the sqlite3_shutdown() function. The
 13.6078 +** implementation of this method is expected to release all outstanding
 13.6079 +** resources obtained by the mutex methods implementation, especially
 13.6080 +** those obtained by the xMutexInit method.  ^The xMutexEnd()
 13.6081 +** interface is invoked exactly once for each call to [sqlite3_shutdown()].
 13.6082 +**
 13.6083 +** ^(The remaining seven methods defined by this structure (xMutexAlloc,
 13.6084 +** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and
 13.6085 +** xMutexNotheld) implement the following interfaces (respectively):
 13.6086 +**
 13.6087 +** <ul>
 13.6088 +**   <li>  [sqlite3_mutex_alloc()] </li>
 13.6089 +**   <li>  [sqlite3_mutex_free()] </li>
 13.6090 +**   <li>  [sqlite3_mutex_enter()] </li>
 13.6091 +**   <li>  [sqlite3_mutex_try()] </li>
 13.6092 +**   <li>  [sqlite3_mutex_leave()] </li>
 13.6093 +**   <li>  [sqlite3_mutex_held()] </li>
 13.6094 +**   <li>  [sqlite3_mutex_notheld()] </li>
 13.6095 +** </ul>)^
 13.6096 +**
 13.6097 +** The only difference is that the public sqlite3_XXX functions enumerated
 13.6098 +** above silently ignore any invocations that pass a NULL pointer instead
 13.6099 +** of a valid mutex handle. The implementations of the methods defined
 13.6100 +** by this structure are not required to handle this case, the results
 13.6101 +** of passing a NULL pointer instead of a valid mutex handle are undefined
 13.6102 +** (i.e. it is acceptable to provide an implementation that segfaults if
 13.6103 +** it is passed a NULL pointer).
 13.6104 +**
 13.6105 +** The xMutexInit() method must be threadsafe.  ^It must be harmless to
 13.6106 +** invoke xMutexInit() multiple times within the same process and without
 13.6107 +** intervening calls to xMutexEnd().  Second and subsequent calls to
 13.6108 +** xMutexInit() must be no-ops.
 13.6109 +**
 13.6110 +** ^xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()]
 13.6111 +** and its associates).  ^Similarly, xMutexAlloc() must not use SQLite memory
 13.6112 +** allocation for a static mutex.  ^However xMutexAlloc() may use SQLite
 13.6113 +** memory allocation for a fast or recursive mutex.
 13.6114 +**
 13.6115 +** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is
 13.6116 +** called, but only if the prior call to xMutexInit returned SQLITE_OK.
 13.6117 +** If xMutexInit fails in any way, it is expected to clean up after itself
 13.6118 +** prior to returning.
 13.6119 +*/
 13.6120 +typedef struct sqlite3_mutex_methods sqlite3_mutex_methods;
 13.6121 +struct sqlite3_mutex_methods {
 13.6122 +  int (*xMutexInit)(void);
 13.6123 +  int (*xMutexEnd)(void);
 13.6124 +  sqlite3_mutex *(*xMutexAlloc)(int);
 13.6125 +  void (*xMutexFree)(sqlite3_mutex *);
 13.6126 +  void (*xMutexEnter)(sqlite3_mutex *);
 13.6127 +  int (*xMutexTry)(sqlite3_mutex *);
 13.6128 +  void (*xMutexLeave)(sqlite3_mutex *);
 13.6129 +  int (*xMutexHeld)(sqlite3_mutex *);
 13.6130 +  int (*xMutexNotheld)(sqlite3_mutex *);
 13.6131 +};
 13.6132 +
 13.6133 +/*
 13.6134 +** CAPI3REF: Mutex Verification Routines
 13.6135 +**
 13.6136 +** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines
 13.6137 +** are intended for use inside assert() statements.  ^The SQLite core
 13.6138 +** never uses these routines except inside an assert() and applications
 13.6139 +** are advised to follow the lead of the core.  ^The SQLite core only
 13.6140 +** provides implementations for these routines when it is compiled
 13.6141 +** with the SQLITE_DEBUG flag.  ^External mutex implementations
 13.6142 +** are only required to provide these routines if SQLITE_DEBUG is
 13.6143 +** defined and if NDEBUG is not defined.
 13.6144 +**
 13.6145 +** ^These routines should return true if the mutex in their argument
 13.6146 +** is held or not held, respectively, by the calling thread.
 13.6147 +**
 13.6148 +** ^The implementation is not required to provide versions of these
 13.6149 +** routines that actually work. If the implementation does not provide working
 13.6150 +** versions of these routines, it should at least provide stubs that always
 13.6151 +** return true so that one does not get spurious assertion failures.
 13.6152 +**
 13.6153 +** ^If the argument to sqlite3_mutex_held() is a NULL pointer then
 13.6154 +** the routine should return 1.   This seems counter-intuitive since
 13.6155 +** clearly the mutex cannot be held if it does not exist.  But
 13.6156 +** the reason the mutex does not exist is because the build is not
 13.6157 +** using mutexes.  And we do not want the assert() containing the
 13.6158 +** call to sqlite3_mutex_held() to fail, so a non-zero return is
 13.6159 +** the appropriate thing to do.  ^The sqlite3_mutex_notheld()
 13.6160 +** interface should also return 1 when given a NULL pointer.
 13.6161 +*/
 13.6162 +#ifndef NDEBUG
 13.6163 +SQLITE_API int sqlite3_mutex_held(sqlite3_mutex*);
 13.6164 +SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*);
 13.6165 +#endif
 13.6166 +
 13.6167 +/*
 13.6168 +** CAPI3REF: Mutex Types
 13.6169 +**
 13.6170 +** The [sqlite3_mutex_alloc()] interface takes a single argument
 13.6171 +** which is one of these integer constants.
 13.6172 +**
 13.6173 +** The set of static mutexes may change from one SQLite release to the
 13.6174 +** next.  Applications that override the built-in mutex logic must be
 13.6175 +** prepared to accommodate additional static mutexes.
 13.6176 +*/
 13.6177 +#define SQLITE_MUTEX_FAST             0
 13.6178 +#define SQLITE_MUTEX_RECURSIVE        1
 13.6179 +#define SQLITE_MUTEX_STATIC_MASTER    2
 13.6180 +#define SQLITE_MUTEX_STATIC_MEM       3  /* sqlite3_malloc() */
 13.6181 +#define SQLITE_MUTEX_STATIC_MEM2      4  /* NOT USED */
 13.6182 +#define SQLITE_MUTEX_STATIC_OPEN      4  /* sqlite3BtreeOpen() */
 13.6183 +#define SQLITE_MUTEX_STATIC_PRNG      5  /* sqlite3_random() */
 13.6184 +#define SQLITE_MUTEX_STATIC_LRU       6  /* lru page list */
 13.6185 +#define SQLITE_MUTEX_STATIC_LRU2      7  /* NOT USED */
 13.6186 +#define SQLITE_MUTEX_STATIC_PMEM      7  /* sqlite3PageMalloc() */
 13.6187 +#define SQLITE_MUTEX_STATIC_APP1      8  /* For use by application */
 13.6188 +#define SQLITE_MUTEX_STATIC_APP2      9  /* For use by application */
 13.6189 +#define SQLITE_MUTEX_STATIC_APP3     10  /* For use by application */
 13.6190 +
 13.6191 +/*
 13.6192 +** CAPI3REF: Retrieve the mutex for a database connection
 13.6193 +**
 13.6194 +** ^This interface returns a pointer the [sqlite3_mutex] object that 
 13.6195 +** serializes access to the [database connection] given in the argument
 13.6196 +** when the [threading mode] is Serialized.
 13.6197 +** ^If the [threading mode] is Single-thread or Multi-thread then this
 13.6198 +** routine returns a NULL pointer.
 13.6199 +*/
 13.6200 +SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*);
 13.6201 +
 13.6202 +/*
 13.6203 +** CAPI3REF: Low-Level Control Of Database Files
 13.6204 +**
 13.6205 +** ^The [sqlite3_file_control()] interface makes a direct call to the
 13.6206 +** xFileControl method for the [sqlite3_io_methods] object associated
 13.6207 +** with a particular database identified by the second argument. ^The
 13.6208 +** name of the database is "main" for the main database or "temp" for the
 13.6209 +** TEMP database, or the name that appears after the AS keyword for
 13.6210 +** databases that are added using the [ATTACH] SQL command.
 13.6211 +** ^A NULL pointer can be used in place of "main" to refer to the
 13.6212 +** main database file.
 13.6213 +** ^The third and fourth parameters to this routine
 13.6214 +** are passed directly through to the second and third parameters of
 13.6215 +** the xFileControl method.  ^The return value of the xFileControl
 13.6216 +** method becomes the return value of this routine.
 13.6217 +**
 13.6218 +** ^The SQLITE_FCNTL_FILE_POINTER value for the op parameter causes
 13.6219 +** a pointer to the underlying [sqlite3_file] object to be written into
 13.6220 +** the space pointed to by the 4th parameter.  ^The SQLITE_FCNTL_FILE_POINTER
 13.6221 +** case is a short-circuit path which does not actually invoke the
 13.6222 +** underlying sqlite3_io_methods.xFileControl method.
 13.6223 +**
 13.6224 +** ^If the second parameter (zDbName) does not match the name of any
 13.6225 +** open database file, then SQLITE_ERROR is returned.  ^This error
 13.6226 +** code is not remembered and will not be recalled by [sqlite3_errcode()]
 13.6227 +** or [sqlite3_errmsg()].  The underlying xFileControl method might
 13.6228 +** also return SQLITE_ERROR.  There is no way to distinguish between
 13.6229 +** an incorrect zDbName and an SQLITE_ERROR return from the underlying
 13.6230 +** xFileControl method.
 13.6231 +**
 13.6232 +** See also: [SQLITE_FCNTL_LOCKSTATE]
 13.6233 +*/
 13.6234 +SQLITE_API int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*);
 13.6235 +
 13.6236 +/*
 13.6237 +** CAPI3REF: Testing Interface
 13.6238 +**
 13.6239 +** ^The sqlite3_test_control() interface is used to read out internal
 13.6240 +** state of SQLite and to inject faults into SQLite for testing
 13.6241 +** purposes.  ^The first parameter is an operation code that determines
 13.6242 +** the number, meaning, and operation of all subsequent parameters.
 13.6243 +**
 13.6244 +** This interface is not for use by applications.  It exists solely
 13.6245 +** for verifying the correct operation of the SQLite library.  Depending
 13.6246 +** on how the SQLite library is compiled, this interface might not exist.
 13.6247 +**
 13.6248 +** The details of the operation codes, their meanings, the parameters
 13.6249 +** they take, and what they do are all subject to change without notice.
 13.6250 +** Unlike most of the SQLite API, this function is not guaranteed to
 13.6251 +** operate consistently from one release to the next.
 13.6252 +*/
 13.6253 +SQLITE_API int sqlite3_test_control(int op, ...);
 13.6254 +
 13.6255 +/*
 13.6256 +** CAPI3REF: Testing Interface Operation Codes
 13.6257 +**
 13.6258 +** These constants are the valid operation code parameters used
 13.6259 +** as the first argument to [sqlite3_test_control()].
 13.6260 +**
 13.6261 +** These parameters and their meanings are subject to change
 13.6262 +** without notice.  These values are for testing purposes only.
 13.6263 +** Applications should not use any of these parameters or the
 13.6264 +** [sqlite3_test_control()] interface.
 13.6265 +*/
 13.6266 +#define SQLITE_TESTCTRL_FIRST                    5
 13.6267 +#define SQLITE_TESTCTRL_PRNG_SAVE                5
 13.6268 +#define SQLITE_TESTCTRL_PRNG_RESTORE             6
 13.6269 +#define SQLITE_TESTCTRL_PRNG_RESET               7
 13.6270 +#define SQLITE_TESTCTRL_BITVEC_TEST              8
 13.6271 +#define SQLITE_TESTCTRL_FAULT_INSTALL            9
 13.6272 +#define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS     10
 13.6273 +#define SQLITE_TESTCTRL_PENDING_BYTE            11
 13.6274 +#define SQLITE_TESTCTRL_ASSERT                  12
 13.6275 +#define SQLITE_TESTCTRL_ALWAYS                  13
 13.6276 +#define SQLITE_TESTCTRL_RESERVE                 14
 13.6277 +#define SQLITE_TESTCTRL_OPTIMIZATIONS           15
 13.6278 +#define SQLITE_TESTCTRL_ISKEYWORD               16
 13.6279 +#define SQLITE_TESTCTRL_SCRATCHMALLOC           17
 13.6280 +#define SQLITE_TESTCTRL_LOCALTIME_FAULT         18
 13.6281 +#define SQLITE_TESTCTRL_EXPLAIN_STMT            19
 13.6282 +#define SQLITE_TESTCTRL_NEVER_CORRUPT           20
 13.6283 +#define SQLITE_TESTCTRL_VDBE_COVERAGE           21
 13.6284 +#define SQLITE_TESTCTRL_BYTEORDER               22
 13.6285 +#define SQLITE_TESTCTRL_ISINIT                  23
 13.6286 +#define SQLITE_TESTCTRL_LAST                    23
 13.6287 +
 13.6288 +/*
 13.6289 +** CAPI3REF: SQLite Runtime Status
 13.6290 +**
 13.6291 +** ^This interface is used to retrieve runtime status information
 13.6292 +** about the performance of SQLite, and optionally to reset various
 13.6293 +** highwater marks.  ^The first argument is an integer code for
 13.6294 +** the specific parameter to measure.  ^(Recognized integer codes
 13.6295 +** are of the form [status parameters | SQLITE_STATUS_...].)^
 13.6296 +** ^The current value of the parameter is returned into *pCurrent.
 13.6297 +** ^The highest recorded value is returned in *pHighwater.  ^If the
 13.6298 +** resetFlag is true, then the highest record value is reset after
 13.6299 +** *pHighwater is written.  ^(Some parameters do not record the highest
 13.6300 +** value.  For those parameters
 13.6301 +** nothing is written into *pHighwater and the resetFlag is ignored.)^
 13.6302 +** ^(Other parameters record only the highwater mark and not the current
 13.6303 +** value.  For these latter parameters nothing is written into *pCurrent.)^
 13.6304 +**
 13.6305 +** ^The sqlite3_status() routine returns SQLITE_OK on success and a
 13.6306 +** non-zero [error code] on failure.
 13.6307 +**
 13.6308 +** This routine is threadsafe but is not atomic.  This routine can be
 13.6309 +** called while other threads are running the same or different SQLite
 13.6310 +** interfaces.  However the values returned in *pCurrent and
 13.6311 +** *pHighwater reflect the status of SQLite at different points in time
 13.6312 +** and it is possible that another thread might change the parameter
 13.6313 +** in between the times when *pCurrent and *pHighwater are written.
 13.6314 +**
 13.6315 +** See also: [sqlite3_db_status()]
 13.6316 +*/
 13.6317 +SQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag);
 13.6318 +
 13.6319 +
 13.6320 +/*
 13.6321 +** CAPI3REF: Status Parameters
 13.6322 +** KEYWORDS: {status parameters}
 13.6323 +**
 13.6324 +** These integer constants designate various run-time status parameters
 13.6325 +** that can be returned by [sqlite3_status()].
 13.6326 +**
 13.6327 +** <dl>
 13.6328 +** [[SQLITE_STATUS_MEMORY_USED]] ^(<dt>SQLITE_STATUS_MEMORY_USED</dt>
 13.6329 +** <dd>This parameter is the current amount of memory checked out
 13.6330 +** using [sqlite3_malloc()], either directly or indirectly.  The
 13.6331 +** figure includes calls made to [sqlite3_malloc()] by the application
 13.6332 +** and internal memory usage by the SQLite library.  Scratch memory
 13.6333 +** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache
 13.6334 +** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in
 13.6335 +** this parameter.  The amount returned is the sum of the allocation
 13.6336 +** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^
 13.6337 +**
 13.6338 +** [[SQLITE_STATUS_MALLOC_SIZE]] ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt>
 13.6339 +** <dd>This parameter records the largest memory allocation request
 13.6340 +** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their
 13.6341 +** internal equivalents).  Only the value returned in the
 13.6342 +** *pHighwater parameter to [sqlite3_status()] is of interest.  
 13.6343 +** The value written into the *pCurrent parameter is undefined.</dd>)^
 13.6344 +**
 13.6345 +** [[SQLITE_STATUS_MALLOC_COUNT]] ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt>
 13.6346 +** <dd>This parameter records the number of separate memory allocations
 13.6347 +** currently checked out.</dd>)^
 13.6348 +**
 13.6349 +** [[SQLITE_STATUS_PAGECACHE_USED]] ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt>
 13.6350 +** <dd>This parameter returns the number of pages used out of the
 13.6351 +** [pagecache memory allocator] that was configured using 
 13.6352 +** [SQLITE_CONFIG_PAGECACHE].  The
 13.6353 +** value returned is in pages, not in bytes.</dd>)^
 13.6354 +**
 13.6355 +** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]] 
 13.6356 +** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt>
 13.6357 +** <dd>This parameter returns the number of bytes of page cache
 13.6358 +** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE]
 13.6359 +** buffer and where forced to overflow to [sqlite3_malloc()].  The
 13.6360 +** returned value includes allocations that overflowed because they
 13.6361 +** where too large (they were larger than the "sz" parameter to
 13.6362 +** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because
 13.6363 +** no space was left in the page cache.</dd>)^
 13.6364 +**
 13.6365 +** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt>
 13.6366 +** <dd>This parameter records the largest memory allocation request
 13.6367 +** handed to [pagecache memory allocator].  Only the value returned in the
 13.6368 +** *pHighwater parameter to [sqlite3_status()] is of interest.  
 13.6369 +** The value written into the *pCurrent parameter is undefined.</dd>)^
 13.6370 +**
 13.6371 +** [[SQLITE_STATUS_SCRATCH_USED]] ^(<dt>SQLITE_STATUS_SCRATCH_USED</dt>
 13.6372 +** <dd>This parameter returns the number of allocations used out of the
 13.6373 +** [scratch memory allocator] configured using
 13.6374 +** [SQLITE_CONFIG_SCRATCH].  The value returned is in allocations, not
 13.6375 +** in bytes.  Since a single thread may only have one scratch allocation
 13.6376 +** outstanding at time, this parameter also reports the number of threads
 13.6377 +** using scratch memory at the same time.</dd>)^
 13.6378 +**
 13.6379 +** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt>
 13.6380 +** <dd>This parameter returns the number of bytes of scratch memory
 13.6381 +** allocation which could not be satisfied by the [SQLITE_CONFIG_SCRATCH]
 13.6382 +** buffer and where forced to overflow to [sqlite3_malloc()].  The values
 13.6383 +** returned include overflows because the requested allocation was too
 13.6384 +** larger (that is, because the requested allocation was larger than the
 13.6385 +** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer
 13.6386 +** slots were available.
 13.6387 +** </dd>)^
 13.6388 +**
 13.6389 +** [[SQLITE_STATUS_SCRATCH_SIZE]] ^(<dt>SQLITE_STATUS_SCRATCH_SIZE</dt>
 13.6390 +** <dd>This parameter records the largest memory allocation request
 13.6391 +** handed to [scratch memory allocator].  Only the value returned in the
 13.6392 +** *pHighwater parameter to [sqlite3_status()] is of interest.  
 13.6393 +** The value written into the *pCurrent parameter is undefined.</dd>)^
 13.6394 +**
 13.6395 +** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt>
 13.6396 +** <dd>This parameter records the deepest parser stack.  It is only
 13.6397 +** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^
 13.6398 +** </dl>
 13.6399 +**
 13.6400 +** New status parameters may be added from time to time.
 13.6401 +*/
 13.6402 +#define SQLITE_STATUS_MEMORY_USED          0
 13.6403 +#define SQLITE_STATUS_PAGECACHE_USED       1
 13.6404 +#define SQLITE_STATUS_PAGECACHE_OVERFLOW   2
 13.6405 +#define SQLITE_STATUS_SCRATCH_USED         3
 13.6406 +#define SQLITE_STATUS_SCRATCH_OVERFLOW     4
 13.6407 +#define SQLITE_STATUS_MALLOC_SIZE          5
 13.6408 +#define SQLITE_STATUS_PARSER_STACK         6
 13.6409 +#define SQLITE_STATUS_PAGECACHE_SIZE       7
 13.6410 +#define SQLITE_STATUS_SCRATCH_SIZE         8
 13.6411 +#define SQLITE_STATUS_MALLOC_COUNT         9
 13.6412 +
 13.6413 +/*
 13.6414 +** CAPI3REF: Database Connection Status
 13.6415 +**
 13.6416 +** ^This interface is used to retrieve runtime status information 
 13.6417 +** about a single [database connection].  ^The first argument is the
 13.6418 +** database connection object to be interrogated.  ^The second argument
 13.6419 +** is an integer constant, taken from the set of
 13.6420 +** [SQLITE_DBSTATUS options], that
 13.6421 +** determines the parameter to interrogate.  The set of 
 13.6422 +** [SQLITE_DBSTATUS options] is likely
 13.6423 +** to grow in future releases of SQLite.
 13.6424 +**
 13.6425 +** ^The current value of the requested parameter is written into *pCur
 13.6426 +** and the highest instantaneous value is written into *pHiwtr.  ^If
 13.6427 +** the resetFlg is true, then the highest instantaneous value is
 13.6428 +** reset back down to the current value.
 13.6429 +**
 13.6430 +** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a
 13.6431 +** non-zero [error code] on failure.
 13.6432 +**
 13.6433 +** See also: [sqlite3_status()] and [sqlite3_stmt_status()].
 13.6434 +*/
 13.6435 +SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg);
 13.6436 +
 13.6437 +/*
 13.6438 +** CAPI3REF: Status Parameters for database connections
 13.6439 +** KEYWORDS: {SQLITE_DBSTATUS options}
 13.6440 +**
 13.6441 +** These constants are the available integer "verbs" that can be passed as
 13.6442 +** the second argument to the [sqlite3_db_status()] interface.
 13.6443 +**
 13.6444 +** New verbs may be added in future releases of SQLite. Existing verbs
 13.6445 +** might be discontinued. Applications should check the return code from
 13.6446 +** [sqlite3_db_status()] to make sure that the call worked.
 13.6447 +** The [sqlite3_db_status()] interface will return a non-zero error code
 13.6448 +** if a discontinued or unsupported verb is invoked.
 13.6449 +**
 13.6450 +** <dl>
 13.6451 +** [[SQLITE_DBSTATUS_LOOKASIDE_USED]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt>
 13.6452 +** <dd>This parameter returns the number of lookaside memory slots currently
 13.6453 +** checked out.</dd>)^
 13.6454 +**
 13.6455 +** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt>
 13.6456 +** <dd>This parameter returns the number malloc attempts that were 
 13.6457 +** satisfied using lookaside memory. Only the high-water value is meaningful;
 13.6458 +** the current value is always zero.)^
 13.6459 +**
 13.6460 +** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE]]
 13.6461 +** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt>
 13.6462 +** <dd>This parameter returns the number malloc attempts that might have
 13.6463 +** been satisfied using lookaside memory but failed due to the amount of
 13.6464 +** memory requested being larger than the lookaside slot size.
 13.6465 +** Only the high-water value is meaningful;
 13.6466 +** the current value is always zero.)^
 13.6467 +**
 13.6468 +** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL]]
 13.6469 +** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt>
 13.6470 +** <dd>This parameter returns the number malloc attempts that might have
 13.6471 +** been satisfied using lookaside memory but failed due to all lookaside
 13.6472 +** memory already being in use.
 13.6473 +** Only the high-water value is meaningful;
 13.6474 +** the current value is always zero.)^
 13.6475 +**
 13.6476 +** [[SQLITE_DBSTATUS_CACHE_USED]] ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt>
 13.6477 +** <dd>This parameter returns the approximate number of of bytes of heap
 13.6478 +** memory used by all pager caches associated with the database connection.)^
 13.6479 +** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0.
 13.6480 +**
 13.6481 +** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt>
 13.6482 +** <dd>This parameter returns the approximate number of of bytes of heap
 13.6483 +** memory used to store the schema for all databases associated
 13.6484 +** with the connection - main, temp, and any [ATTACH]-ed databases.)^ 
 13.6485 +** ^The full amount of memory used by the schemas is reported, even if the
 13.6486 +** schema memory is shared with other database connections due to
 13.6487 +** [shared cache mode] being enabled.
 13.6488 +** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0.
 13.6489 +**
 13.6490 +** [[SQLITE_DBSTATUS_STMT_USED]] ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt>
 13.6491 +** <dd>This parameter returns the approximate number of of bytes of heap
 13.6492 +** and lookaside memory used by all prepared statements associated with
 13.6493 +** the database connection.)^
 13.6494 +** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0.
 13.6495 +** </dd>
 13.6496 +**
 13.6497 +** [[SQLITE_DBSTATUS_CACHE_HIT]] ^(<dt>SQLITE_DBSTATUS_CACHE_HIT</dt>
 13.6498 +** <dd>This parameter returns the number of pager cache hits that have
 13.6499 +** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT 
 13.6500 +** is always 0.
 13.6501 +** </dd>
 13.6502 +**
 13.6503 +** [[SQLITE_DBSTATUS_CACHE_MISS]] ^(<dt>SQLITE_DBSTATUS_CACHE_MISS</dt>
 13.6504 +** <dd>This parameter returns the number of pager cache misses that have
 13.6505 +** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS 
 13.6506 +** is always 0.
 13.6507 +** </dd>
 13.6508 +**
 13.6509 +** [[SQLITE_DBSTATUS_CACHE_WRITE]] ^(<dt>SQLITE_DBSTATUS_CACHE_WRITE</dt>
 13.6510 +** <dd>This parameter returns the number of dirty cache entries that have
 13.6511 +** been written to disk. Specifically, the number of pages written to the
 13.6512 +** wal file in wal mode databases, or the number of pages written to the
 13.6513 +** database file in rollback mode databases. Any pages written as part of
 13.6514 +** transaction rollback or database recovery operations are not included.
 13.6515 +** If an IO or other error occurs while writing a page to disk, the effect
 13.6516 +** on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined.)^ ^The
 13.6517 +** highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0.
 13.6518 +** </dd>
 13.6519 +**
 13.6520 +** [[SQLITE_DBSTATUS_DEFERRED_FKS]] ^(<dt>SQLITE_DBSTATUS_DEFERRED_FKS</dt>
 13.6521 +** <dd>This parameter returns zero for the current value if and only if
 13.6522 +** all foreign key constraints (deferred or immediate) have been
 13.6523 +** resolved.)^  ^The highwater mark is always 0.
 13.6524 +** </dd>
 13.6525 +** </dl>
 13.6526 +*/
 13.6527 +#define SQLITE_DBSTATUS_LOOKASIDE_USED       0
 13.6528 +#define SQLITE_DBSTATUS_CACHE_USED           1
 13.6529 +#define SQLITE_DBSTATUS_SCHEMA_USED          2
 13.6530 +#define SQLITE_DBSTATUS_STMT_USED            3
 13.6531 +#define SQLITE_DBSTATUS_LOOKASIDE_HIT        4
 13.6532 +#define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE  5
 13.6533 +#define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL  6
 13.6534 +#define SQLITE_DBSTATUS_CACHE_HIT            7
 13.6535 +#define SQLITE_DBSTATUS_CACHE_MISS           8
 13.6536 +#define SQLITE_DBSTATUS_CACHE_WRITE          9
 13.6537 +#define SQLITE_DBSTATUS_DEFERRED_FKS        10
 13.6538 +#define SQLITE_DBSTATUS_MAX                 10   /* Largest defined DBSTATUS */
 13.6539 +
 13.6540 +
 13.6541 +/*
 13.6542 +** CAPI3REF: Prepared Statement Status
 13.6543 +**
 13.6544 +** ^(Each prepared statement maintains various
 13.6545 +** [SQLITE_STMTSTATUS counters] that measure the number
 13.6546 +** of times it has performed specific operations.)^  These counters can
 13.6547 +** be used to monitor the performance characteristics of the prepared
 13.6548 +** statements.  For example, if the number of table steps greatly exceeds
 13.6549 +** the number of table searches or result rows, that would tend to indicate
 13.6550 +** that the prepared statement is using a full table scan rather than
 13.6551 +** an index.  
 13.6552 +**
 13.6553 +** ^(This interface is used to retrieve and reset counter values from
 13.6554 +** a [prepared statement].  The first argument is the prepared statement
 13.6555 +** object to be interrogated.  The second argument
 13.6556 +** is an integer code for a specific [SQLITE_STMTSTATUS counter]
 13.6557 +** to be interrogated.)^
 13.6558 +** ^The current value of the requested counter is returned.
 13.6559 +** ^If the resetFlg is true, then the counter is reset to zero after this
 13.6560 +** interface call returns.
 13.6561 +**
 13.6562 +** See also: [sqlite3_status()] and [sqlite3_db_status()].
 13.6563 +*/
 13.6564 +SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg);
 13.6565 +
 13.6566 +/*
 13.6567 +** CAPI3REF: Status Parameters for prepared statements
 13.6568 +** KEYWORDS: {SQLITE_STMTSTATUS counter} {SQLITE_STMTSTATUS counters}
 13.6569 +**
 13.6570 +** These preprocessor macros define integer codes that name counter
 13.6571 +** values associated with the [sqlite3_stmt_status()] interface.
 13.6572 +** The meanings of the various counters are as follows:
 13.6573 +**
 13.6574 +** <dl>
 13.6575 +** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]] <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt>
 13.6576 +** <dd>^This is the number of times that SQLite has stepped forward in
 13.6577 +** a table as part of a full table scan.  Large numbers for this counter
 13.6578 +** may indicate opportunities for performance improvement through 
 13.6579 +** careful use of indices.</dd>
 13.6580 +**
 13.6581 +** [[SQLITE_STMTSTATUS_SORT]] <dt>SQLITE_STMTSTATUS_SORT</dt>
 13.6582 +** <dd>^This is the number of sort operations that have occurred.
 13.6583 +** A non-zero value in this counter may indicate an opportunity to
 13.6584 +** improvement performance through careful use of indices.</dd>
 13.6585 +**
 13.6586 +** [[SQLITE_STMTSTATUS_AUTOINDEX]] <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt>
 13.6587 +** <dd>^This is the number of rows inserted into transient indices that
 13.6588 +** were created automatically in order to help joins run faster.
 13.6589 +** A non-zero value in this counter may indicate an opportunity to
 13.6590 +** improvement performance by adding permanent indices that do not
 13.6591 +** need to be reinitialized each time the statement is run.</dd>
 13.6592 +**
 13.6593 +** [[SQLITE_STMTSTATUS_VM_STEP]] <dt>SQLITE_STMTSTATUS_VM_STEP</dt>
 13.6594 +** <dd>^This is the number of virtual machine operations executed
 13.6595 +** by the prepared statement if that number is less than or equal
 13.6596 +** to 2147483647.  The number of virtual machine operations can be 
 13.6597 +** used as a proxy for the total work done by the prepared statement.
 13.6598 +** If the number of virtual machine operations exceeds 2147483647
 13.6599 +** then the value returned by this statement status code is undefined.
 13.6600 +** </dd>
 13.6601 +** </dl>
 13.6602 +*/
 13.6603 +#define SQLITE_STMTSTATUS_FULLSCAN_STEP     1
 13.6604 +#define SQLITE_STMTSTATUS_SORT              2
 13.6605 +#define SQLITE_STMTSTATUS_AUTOINDEX         3
 13.6606 +#define SQLITE_STMTSTATUS_VM_STEP           4
 13.6607 +
 13.6608 +/*
 13.6609 +** CAPI3REF: Custom Page Cache Object
 13.6610 +**
 13.6611 +** The sqlite3_pcache type is opaque.  It is implemented by
 13.6612 +** the pluggable module.  The SQLite core has no knowledge of
 13.6613 +** its size or internal structure and never deals with the
 13.6614 +** sqlite3_pcache object except by holding and passing pointers
 13.6615 +** to the object.
 13.6616 +**
 13.6617 +** See [sqlite3_pcache_methods2] for additional information.
 13.6618 +*/
 13.6619 +typedef struct sqlite3_pcache sqlite3_pcache;
 13.6620 +
 13.6621 +/*
 13.6622 +** CAPI3REF: Custom Page Cache Object
 13.6623 +**
 13.6624 +** The sqlite3_pcache_page object represents a single page in the
 13.6625 +** page cache.  The page cache will allocate instances of this
 13.6626 +** object.  Various methods of the page cache use pointers to instances
 13.6627 +** of this object as parameters or as their return value.
 13.6628 +**
 13.6629 +** See [sqlite3_pcache_methods2] for additional information.
 13.6630 +*/
 13.6631 +typedef struct sqlite3_pcache_page sqlite3_pcache_page;
 13.6632 +struct sqlite3_pcache_page {
 13.6633 +  void *pBuf;        /* The content of the page */
 13.6634 +  void *pExtra;      /* Extra information associated with the page */
 13.6635 +};
 13.6636 +
 13.6637 +/*
 13.6638 +** CAPI3REF: Application Defined Page Cache.
 13.6639 +** KEYWORDS: {page cache}
 13.6640 +**
 13.6641 +** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE2], ...) interface can
 13.6642 +** register an alternative page cache implementation by passing in an 
 13.6643 +** instance of the sqlite3_pcache_methods2 structure.)^
 13.6644 +** In many applications, most of the heap memory allocated by 
 13.6645 +** SQLite is used for the page cache.
 13.6646 +** By implementing a 
 13.6647 +** custom page cache using this API, an application can better control
 13.6648 +** the amount of memory consumed by SQLite, the way in which 
 13.6649 +** that memory is allocated and released, and the policies used to 
 13.6650 +** determine exactly which parts of a database file are cached and for 
 13.6651 +** how long.
 13.6652 +**
 13.6653 +** The alternative page cache mechanism is an
 13.6654 +** extreme measure that is only needed by the most demanding applications.
 13.6655 +** The built-in page cache is recommended for most uses.
 13.6656 +**
 13.6657 +** ^(The contents of the sqlite3_pcache_methods2 structure are copied to an
 13.6658 +** internal buffer by SQLite within the call to [sqlite3_config].  Hence
 13.6659 +** the application may discard the parameter after the call to
 13.6660 +** [sqlite3_config()] returns.)^
 13.6661 +**
 13.6662 +** [[the xInit() page cache method]]
 13.6663 +** ^(The xInit() method is called once for each effective 
 13.6664 +** call to [sqlite3_initialize()])^
 13.6665 +** (usually only once during the lifetime of the process). ^(The xInit()
 13.6666 +** method is passed a copy of the sqlite3_pcache_methods2.pArg value.)^
 13.6667 +** The intent of the xInit() method is to set up global data structures 
 13.6668 +** required by the custom page cache implementation. 
 13.6669 +** ^(If the xInit() method is NULL, then the 
 13.6670 +** built-in default page cache is used instead of the application defined
 13.6671 +** page cache.)^
 13.6672 +**
 13.6673 +** [[the xShutdown() page cache method]]
 13.6674 +** ^The xShutdown() method is called by [sqlite3_shutdown()].
 13.6675 +** It can be used to clean up 
 13.6676 +** any outstanding resources before process shutdown, if required.
 13.6677 +** ^The xShutdown() method may be NULL.
 13.6678 +**
 13.6679 +** ^SQLite automatically serializes calls to the xInit method,
 13.6680 +** so the xInit method need not be threadsafe.  ^The
 13.6681 +** xShutdown method is only called from [sqlite3_shutdown()] so it does
 13.6682 +** not need to be threadsafe either.  All other methods must be threadsafe
 13.6683 +** in multithreaded applications.
 13.6684 +**
 13.6685 +** ^SQLite will never invoke xInit() more than once without an intervening
 13.6686 +** call to xShutdown().
 13.6687 +**
 13.6688 +** [[the xCreate() page cache methods]]
 13.6689 +** ^SQLite invokes the xCreate() method to construct a new cache instance.
 13.6690 +** SQLite will typically create one cache instance for each open database file,
 13.6691 +** though this is not guaranteed. ^The
 13.6692 +** first parameter, szPage, is the size in bytes of the pages that must
 13.6693 +** be allocated by the cache.  ^szPage will always a power of two.  ^The
 13.6694 +** second parameter szExtra is a number of bytes of extra storage 
 13.6695 +** associated with each page cache entry.  ^The szExtra parameter will
 13.6696 +** a number less than 250.  SQLite will use the
 13.6697 +** extra szExtra bytes on each page to store metadata about the underlying
 13.6698 +** database page on disk.  The value passed into szExtra depends
 13.6699 +** on the SQLite version, the target platform, and how SQLite was compiled.
 13.6700 +** ^The third argument to xCreate(), bPurgeable, is true if the cache being
 13.6701 +** created will be used to cache database pages of a file stored on disk, or
 13.6702 +** false if it is used for an in-memory database. The cache implementation
 13.6703 +** does not have to do anything special based with the value of bPurgeable;
 13.6704 +** it is purely advisory.  ^On a cache where bPurgeable is false, SQLite will
 13.6705 +** never invoke xUnpin() except to deliberately delete a page.
 13.6706 +** ^In other words, calls to xUnpin() on a cache with bPurgeable set to
 13.6707 +** false will always have the "discard" flag set to true.  
 13.6708 +** ^Hence, a cache created with bPurgeable false will
 13.6709 +** never contain any unpinned pages.
 13.6710 +**
 13.6711 +** [[the xCachesize() page cache method]]
 13.6712 +** ^(The xCachesize() method may be called at any time by SQLite to set the
 13.6713 +** suggested maximum cache-size (number of pages stored by) the cache
 13.6714 +** instance passed as the first argument. This is the value configured using
 13.6715 +** the SQLite "[PRAGMA cache_size]" command.)^  As with the bPurgeable
 13.6716 +** parameter, the implementation is not required to do anything with this
 13.6717 +** value; it is advisory only.
 13.6718 +**
 13.6719 +** [[the xPagecount() page cache methods]]
 13.6720 +** The xPagecount() method must return the number of pages currently
 13.6721 +** stored in the cache, both pinned and unpinned.
 13.6722 +** 
 13.6723 +** [[the xFetch() page cache methods]]
 13.6724 +** The xFetch() method locates a page in the cache and returns a pointer to 
 13.6725 +** an sqlite3_pcache_page object associated with that page, or a NULL pointer.
 13.6726 +** The pBuf element of the returned sqlite3_pcache_page object will be a
 13.6727 +** pointer to a buffer of szPage bytes used to store the content of a 
 13.6728 +** single database page.  The pExtra element of sqlite3_pcache_page will be
 13.6729 +** a pointer to the szExtra bytes of extra storage that SQLite has requested
 13.6730 +** for each entry in the page cache.
 13.6731 +**
 13.6732 +** The page to be fetched is determined by the key. ^The minimum key value
 13.6733 +** is 1.  After it has been retrieved using xFetch, the page is considered
 13.6734 +** to be "pinned".
 13.6735 +**
 13.6736 +** If the requested page is already in the page cache, then the page cache
 13.6737 +** implementation must return a pointer to the page buffer with its content
 13.6738 +** intact.  If the requested page is not already in the cache, then the
 13.6739 +** cache implementation should use the value of the createFlag
 13.6740 +** parameter to help it determined what action to take:
 13.6741 +**
 13.6742 +** <table border=1 width=85% align=center>
 13.6743 +** <tr><th> createFlag <th> Behavior when page is not already in cache
 13.6744 +** <tr><td> 0 <td> Do not allocate a new page.  Return NULL.
 13.6745 +** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so.
 13.6746 +**                 Otherwise return NULL.
 13.6747 +** <tr><td> 2 <td> Make every effort to allocate a new page.  Only return
 13.6748 +**                 NULL if allocating a new page is effectively impossible.
 13.6749 +** </table>
 13.6750 +**
 13.6751 +** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1.  SQLite
 13.6752 +** will only use a createFlag of 2 after a prior call with a createFlag of 1
 13.6753 +** failed.)^  In between the to xFetch() calls, SQLite may
 13.6754 +** attempt to unpin one or more cache pages by spilling the content of
 13.6755 +** pinned pages to disk and synching the operating system disk cache.
 13.6756 +**
 13.6757 +** [[the xUnpin() page cache method]]
 13.6758 +** ^xUnpin() is called by SQLite with a pointer to a currently pinned page
 13.6759 +** as its second argument.  If the third parameter, discard, is non-zero,
 13.6760 +** then the page must be evicted from the cache.
 13.6761 +** ^If the discard parameter is
 13.6762 +** zero, then the page may be discarded or retained at the discretion of
 13.6763 +** page cache implementation. ^The page cache implementation
 13.6764 +** may choose to evict unpinned pages at any time.
 13.6765 +**
 13.6766 +** The cache must not perform any reference counting. A single 
 13.6767 +** call to xUnpin() unpins the page regardless of the number of prior calls 
 13.6768 +** to xFetch().
 13.6769 +**
 13.6770 +** [[the xRekey() page cache methods]]
 13.6771 +** The xRekey() method is used to change the key value associated with the
 13.6772 +** page passed as the second argument. If the cache
 13.6773 +** previously contains an entry associated with newKey, it must be
 13.6774 +** discarded. ^Any prior cache entry associated with newKey is guaranteed not
 13.6775 +** to be pinned.
 13.6776 +**
 13.6777 +** When SQLite calls the xTruncate() method, the cache must discard all
 13.6778 +** existing cache entries with page numbers (keys) greater than or equal
 13.6779 +** to the value of the iLimit parameter passed to xTruncate(). If any
 13.6780 +** of these pages are pinned, they are implicitly unpinned, meaning that
 13.6781 +** they can be safely discarded.
 13.6782 +**
 13.6783 +** [[the xDestroy() page cache method]]
 13.6784 +** ^The xDestroy() method is used to delete a cache allocated by xCreate().
 13.6785 +** All resources associated with the specified cache should be freed. ^After
 13.6786 +** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*]
 13.6787 +** handle invalid, and will not use it with any other sqlite3_pcache_methods2
 13.6788 +** functions.
 13.6789 +**
 13.6790 +** [[the xShrink() page cache method]]
 13.6791 +** ^SQLite invokes the xShrink() method when it wants the page cache to
 13.6792 +** free up as much of heap memory as possible.  The page cache implementation
 13.6793 +** is not obligated to free any memory, but well-behaved implementations should
 13.6794 +** do their best.
 13.6795 +*/
 13.6796 +typedef struct sqlite3_pcache_methods2 sqlite3_pcache_methods2;