src/sqlite3.c
author Volker Birk <vb@pep-project.org>
Mon, 06 Jun 2016 17:35:13 +0200
changeset 716 498156bf9993
parent 491 d32c60ada438
child 1912 b2f4e198adef
permissions -rw-r--r--
new sqlite3
vb@130
     1
/******************************************************************************
vb@130
     2
** This file is an amalgamation of many separate C source files from SQLite
vb@716
     3
** version 3.13.0.  By combining all the individual C code files into this 
vb@130
     4
** single large file, the entire code can be compiled as a single translation
vb@130
     5
** unit.  This allows many compilers to do optimizations that would not be
vb@130
     6
** possible if the files were compiled separately.  Performance improvements
vb@130
     7
** of 5% or more are commonly seen when SQLite is compiled as a single
vb@130
     8
** translation unit.
vb@130
     9
**
vb@130
    10
** This file is all you need to compile SQLite.  To use SQLite in other
vb@130
    11
** programs, you need this file and the "sqlite3.h" header file that defines
vb@130
    12
** the programming interface to the SQLite library.  (If you do not have 
vb@130
    13
** the "sqlite3.h" header file at hand, you will find a copy embedded within
vb@130
    14
** the text of this file.  Search for "Begin file sqlite3.h" to find the start
vb@130
    15
** of the embedded sqlite3.h header file.) Additional code files may be needed
vb@130
    16
** if you want a wrapper to interface SQLite with your choice of programming
vb@130
    17
** language. The code for the "sqlite3" command-line shell is also in a
vb@130
    18
** separate file. This file contains only code for the core SQLite library.
vb@130
    19
*/
vb@130
    20
#define SQLITE_CORE 1
vb@130
    21
#define SQLITE_AMALGAMATION 1
vb@130
    22
#ifndef SQLITE_PRIVATE
vb@130
    23
# define SQLITE_PRIVATE static
vb@130
    24
#endif
vb@130
    25
/************** Begin file sqliteInt.h ***************************************/
vb@130
    26
/*
vb@130
    27
** 2001 September 15
vb@130
    28
**
vb@130
    29
** The author disclaims copyright to this source code.  In place of
vb@130
    30
** a legal notice, here is a blessing:
vb@130
    31
**
vb@130
    32
**    May you do good and not evil.
vb@130
    33
**    May you find forgiveness for yourself and forgive others.
vb@130
    34
**    May you share freely, never taking more than you give.
vb@130
    35
**
vb@130
    36
*************************************************************************
vb@130
    37
** Internal interface definitions for SQLite.
vb@130
    38
**
vb@130
    39
*/
vb@130
    40
#ifndef _SQLITEINT_H_
vb@130
    41
#define _SQLITEINT_H_
vb@130
    42
vb@716
    43
/* Special Comments:
vb@716
    44
**
vb@716
    45
** Some comments have special meaning to the tools that measure test
vb@716
    46
** coverage:
vb@716
    47
**
vb@716
    48
**    NO_TEST                     - The branches on this line are not
vb@716
    49
**                                  measured by branch coverage.  This is
vb@716
    50
**                                  used on lines of code that actually
vb@716
    51
**                                  implement parts of coverage testing.
vb@716
    52
**
vb@716
    53
**    OPTIMIZATION-IF-TRUE        - This branch is allowed to alway be false
vb@716
    54
**                                  and the correct answer is still obtained,
vb@716
    55
**                                  though perhaps more slowly.
vb@716
    56
**
vb@716
    57
**    OPTIMIZATION-IF-FALSE       - This branch is allowed to alway be true
vb@716
    58
**                                  and the correct answer is still obtained,
vb@716
    59
**                                  though perhaps more slowly.
vb@716
    60
**
vb@716
    61
**    PREVENTS-HARMLESS-OVERREAD  - This branch prevents a buffer overread
vb@716
    62
**                                  that would be harmless and undetectable
vb@716
    63
**                                  if it did occur.  
vb@716
    64
**
vb@716
    65
** In all cases, the special comment must be enclosed in the usual
vb@716
    66
** slash-asterisk...asterisk-slash comment marks, with no spaces between the 
vb@716
    67
** asterisks and the comment text.
vb@716
    68
*/
vb@716
    69
vb@716
    70
/*
vb@716
    71
** Make sure that rand_s() is available on Windows systems with MSVC 2005
vb@716
    72
** or higher.
vb@716
    73
*/
vb@716
    74
#if defined(_MSC_VER) && _MSC_VER>=1400
vb@716
    75
#  define _CRT_RAND_S
vb@716
    76
#endif
vb@716
    77
vb@130
    78
/*
Edouard@491
    79
** Include the header file used to customize the compiler options for MSVC.
Edouard@491
    80
** This should be done first so that it can successfully prevent spurious
Edouard@491
    81
** compiler warnings due to subsequent content in this file and other files
Edouard@491
    82
** that are included by this file.
Edouard@491
    83
*/
Edouard@491
    84
/************** Include msvc.h in the middle of sqliteInt.h ******************/
Edouard@491
    85
/************** Begin file msvc.h ********************************************/
Edouard@491
    86
/*
Edouard@491
    87
** 2015 January 12
Edouard@491
    88
**
Edouard@491
    89
** The author disclaims copyright to this source code.  In place of
Edouard@491
    90
** a legal notice, here is a blessing:
Edouard@491
    91
**
Edouard@491
    92
**    May you do good and not evil.
Edouard@491
    93
**    May you find forgiveness for yourself and forgive others.
Edouard@491
    94
**    May you share freely, never taking more than you give.
Edouard@491
    95
**
Edouard@491
    96
******************************************************************************
Edouard@491
    97
**
Edouard@491
    98
** This file contains code that is specific to MSVC.
Edouard@491
    99
*/
Edouard@491
   100
#ifndef _MSVC_H_
Edouard@491
   101
#define _MSVC_H_
Edouard@491
   102
Edouard@491
   103
#if defined(_MSC_VER)
Edouard@491
   104
#pragma warning(disable : 4054)
Edouard@491
   105
#pragma warning(disable : 4055)
Edouard@491
   106
#pragma warning(disable : 4100)
Edouard@491
   107
#pragma warning(disable : 4127)
Edouard@491
   108
#pragma warning(disable : 4130)
Edouard@491
   109
#pragma warning(disable : 4152)
Edouard@491
   110
#pragma warning(disable : 4189)
Edouard@491
   111
#pragma warning(disable : 4206)
Edouard@491
   112
#pragma warning(disable : 4210)
Edouard@491
   113
#pragma warning(disable : 4232)
Edouard@491
   114
#pragma warning(disable : 4244)
Edouard@491
   115
#pragma warning(disable : 4305)
Edouard@491
   116
#pragma warning(disable : 4306)
Edouard@491
   117
#pragma warning(disable : 4702)
Edouard@491
   118
#pragma warning(disable : 4706)
Edouard@491
   119
#endif /* defined(_MSC_VER) */
Edouard@491
   120
Edouard@491
   121
#endif /* _MSVC_H_ */
Edouard@491
   122
Edouard@491
   123
/************** End of msvc.h ************************************************/
Edouard@491
   124
/************** Continuing where we left off in sqliteInt.h ******************/
Edouard@491
   125
Edouard@491
   126
/*
Edouard@491
   127
** Special setup for VxWorks
Edouard@491
   128
*/
Edouard@491
   129
/************** Include vxworks.h in the middle of sqliteInt.h ***************/
Edouard@491
   130
/************** Begin file vxworks.h *****************************************/
Edouard@491
   131
/*
Edouard@491
   132
** 2015-03-02
Edouard@491
   133
**
Edouard@491
   134
** The author disclaims copyright to this source code.  In place of
Edouard@491
   135
** a legal notice, here is a blessing:
Edouard@491
   136
**
Edouard@491
   137
**    May you do good and not evil.
Edouard@491
   138
**    May you find forgiveness for yourself and forgive others.
Edouard@491
   139
**    May you share freely, never taking more than you give.
Edouard@491
   140
**
Edouard@491
   141
******************************************************************************
Edouard@491
   142
**
Edouard@491
   143
** This file contains code that is specific to Wind River's VxWorks
Edouard@491
   144
*/
Edouard@491
   145
#if defined(__RTP__) || defined(_WRS_KERNEL)
Edouard@491
   146
/* This is VxWorks.  Set up things specially for that OS
Edouard@491
   147
*/
Edouard@491
   148
#include <vxWorks.h>
Edouard@491
   149
#include <pthread.h>  /* amalgamator: dontcache */
Edouard@491
   150
#define OS_VXWORKS 1
Edouard@491
   151
#define SQLITE_OS_OTHER 0
Edouard@491
   152
#define SQLITE_HOMEGROWN_RECURSIVE_MUTEX 1
Edouard@491
   153
#define SQLITE_OMIT_LOAD_EXTENSION 1
Edouard@491
   154
#define SQLITE_ENABLE_LOCKING_STYLE 0
Edouard@491
   155
#define HAVE_UTIME 1
Edouard@491
   156
#else
Edouard@491
   157
/* This is not VxWorks. */
Edouard@491
   158
#define OS_VXWORKS 0
Edouard@491
   159
#define HAVE_FCHOWN 1
Edouard@491
   160
#define HAVE_READLINK 1
Edouard@491
   161
#define HAVE_LSTAT 1
Edouard@491
   162
#endif /* defined(_WRS_KERNEL) */
Edouard@491
   163
Edouard@491
   164
/************** End of vxworks.h *********************************************/
Edouard@491
   165
/************** Continuing where we left off in sqliteInt.h ******************/
Edouard@491
   166
Edouard@491
   167
/*
vb@130
   168
** These #defines should enable >2GB file support on POSIX if the
vb@130
   169
** underlying operating system supports it.  If the OS lacks
vb@130
   170
** large file support, or if the OS is windows, these should be no-ops.
vb@130
   171
**
vb@130
   172
** Ticket #2739:  The _LARGEFILE_SOURCE macro must appear before any
vb@130
   173
** system #includes.  Hence, this block of code must be the very first
vb@130
   174
** code in all source files.
vb@130
   175
**
vb@130
   176
** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
vb@130
   177
** on the compiler command line.  This is necessary if you are compiling
vb@130
   178
** on a recent machine (ex: Red Hat 7.2) but you want your code to work
vb@130
   179
** on an older machine (ex: Red Hat 6.0).  If you compile on Red Hat 7.2
vb@130
   180
** without this option, LFS is enable.  But LFS does not exist in the kernel
vb@130
   181
** in Red Hat 6.0, so the code won't work.  Hence, for maximum binary
vb@130
   182
** portability you should omit LFS.
vb@130
   183
**
vb@130
   184
** The previous paragraph was written in 2005.  (This paragraph is written
vb@130
   185
** on 2008-11-28.) These days, all Linux kernels support large files, so
vb@130
   186
** you should probably leave LFS enabled.  But some embedded platforms might
vb@130
   187
** lack LFS in which case the SQLITE_DISABLE_LFS macro might still be useful.
vb@130
   188
**
vb@130
   189
** Similar is true for Mac OS X.  LFS is only supported on Mac OS X 9 and later.
vb@130
   190
*/
vb@130
   191
#ifndef SQLITE_DISABLE_LFS
vb@130
   192
# define _LARGE_FILE       1
vb@130
   193
# ifndef _FILE_OFFSET_BITS
vb@130
   194
#   define _FILE_OFFSET_BITS 64
vb@130
   195
# endif
vb@130
   196
# define _LARGEFILE_SOURCE 1
vb@130
   197
#endif
vb@130
   198
Edouard@491
   199
/* What version of GCC is being used.  0 means GCC is not being used */
Edouard@491
   200
#ifdef __GNUC__
Edouard@491
   201
# define GCC_VERSION (__GNUC__*1000000+__GNUC_MINOR__*1000+__GNUC_PATCHLEVEL__)
Edouard@491
   202
#else
Edouard@491
   203
# define GCC_VERSION 0
Edouard@491
   204
#endif
Edouard@491
   205
Edouard@491
   206
/* Needed for various definitions... */
Edouard@491
   207
#if defined(__GNUC__) && !defined(_GNU_SOURCE)
Edouard@491
   208
# define _GNU_SOURCE
Edouard@491
   209
#endif
Edouard@491
   210
Edouard@491
   211
#if defined(__OpenBSD__) && !defined(_BSD_SOURCE)
Edouard@491
   212
# define _BSD_SOURCE
Edouard@491
   213
#endif
Edouard@491
   214
vb@130
   215
/*
vb@130
   216
** For MinGW, check to see if we can include the header file containing its
vb@130
   217
** version information, among other things.  Normally, this internal MinGW
vb@130
   218
** header file would [only] be included automatically by other MinGW header
vb@130
   219
** files; however, the contained version information is now required by this
vb@130
   220
** header file to work around binary compatibility issues (see below) and
vb@130
   221
** this is the only known way to reliably obtain it.  This entire #if block
vb@130
   222
** would be completely unnecessary if there was any other way of detecting
vb@130
   223
** MinGW via their preprocessor (e.g. if they customized their GCC to define
vb@130
   224
** some MinGW-specific macros).  When compiling for MinGW, either the
vb@130
   225
** _HAVE_MINGW_H or _HAVE__MINGW_H (note the extra underscore) macro must be
vb@130
   226
** defined; otherwise, detection of conditions specific to MinGW will be
vb@130
   227
** disabled.
vb@130
   228
*/
vb@130
   229
#if defined(_HAVE_MINGW_H)
vb@130
   230
# include "mingw.h"
vb@130
   231
#elif defined(_HAVE__MINGW_H)
vb@130
   232
# include "_mingw.h"
vb@130
   233
#endif
vb@130
   234
vb@130
   235
/*
vb@130
   236
** For MinGW version 4.x (and higher), check to see if the _USE_32BIT_TIME_T
vb@130
   237
** define is required to maintain binary compatibility with the MSVC runtime
vb@130
   238
** library in use (e.g. for Windows XP).
vb@130
   239
*/
vb@130
   240
#if !defined(_USE_32BIT_TIME_T) && !defined(_USE_64BIT_TIME_T) && \
vb@130
   241
    defined(_WIN32) && !defined(_WIN64) && \
vb@130
   242
    defined(__MINGW_MAJOR_VERSION) && __MINGW_MAJOR_VERSION >= 4 && \
vb@130
   243
    defined(__MSVCRT__)
vb@130
   244
# define _USE_32BIT_TIME_T
vb@130
   245
#endif
vb@130
   246
vb@130
   247
/* The public SQLite interface.  The _FILE_OFFSET_BITS macro must appear
vb@130
   248
** first in QNX.  Also, the _USE_32BIT_TIME_T macro must appear first for
vb@130
   249
** MinGW.
vb@130
   250
*/
vb@130
   251
/************** Include sqlite3.h in the middle of sqliteInt.h ***************/
vb@130
   252
/************** Begin file sqlite3.h *****************************************/
vb@130
   253
/*
vb@130
   254
** 2001 September 15
vb@130
   255
**
vb@130
   256
** The author disclaims copyright to this source code.  In place of
vb@130
   257
** a legal notice, here is a blessing:
vb@130
   258
**
vb@130
   259
**    May you do good and not evil.
vb@130
   260
**    May you find forgiveness for yourself and forgive others.
vb@130
   261
**    May you share freely, never taking more than you give.
vb@130
   262
**
vb@130
   263
*************************************************************************
vb@130
   264
** This header file defines the interface that the SQLite library
vb@130
   265
** presents to client programs.  If a C-function, structure, datatype,
vb@130
   266
** or constant definition does not appear in this file, then it is
vb@130
   267
** not a published API of SQLite, is subject to change without
vb@130
   268
** notice, and should not be referenced by programs that use SQLite.
vb@130
   269
**
vb@130
   270
** Some of the definitions that are in this file are marked as
vb@130
   271
** "experimental".  Experimental interfaces are normally new
vb@130
   272
** features recently added to SQLite.  We do not anticipate changes
vb@130
   273
** to experimental interfaces but reserve the right to make minor changes
vb@130
   274
** if experience from use "in the wild" suggest such changes are prudent.
vb@130
   275
**
vb@130
   276
** The official C-language API documentation for SQLite is derived
vb@130
   277
** from comments in this file.  This file is the authoritative source
Edouard@491
   278
** on how SQLite interfaces are supposed to operate.
vb@130
   279
**
vb@130
   280
** The name of this file under configuration management is "sqlite.h.in".
vb@130
   281
** The makefile makes some minor changes to this file (such as inserting
vb@130
   282
** the version number) and changes its name to "sqlite3.h" as
vb@130
   283
** part of the build process.
vb@130
   284
*/
vb@130
   285
#ifndef _SQLITE3_H_
vb@130
   286
#define _SQLITE3_H_
vb@130
   287
#include <stdarg.h>     /* Needed for the definition of va_list */
vb@130
   288
vb@130
   289
/*
vb@130
   290
** Make sure we can call this stuff from C++.
vb@130
   291
*/
vb@130
   292
#if 0
vb@130
   293
extern "C" {
vb@130
   294
#endif
vb@130
   295
vb@130
   296
vb@130
   297
/*
Edouard@491
   298
** Provide the ability to override linkage features of the interface.
vb@130
   299
*/
vb@130
   300
#ifndef SQLITE_EXTERN
vb@130
   301
# define SQLITE_EXTERN extern
vb@130
   302
#endif
vb@130
   303
#ifndef SQLITE_API
vb@130
   304
# define SQLITE_API
vb@130
   305
#endif
Edouard@491
   306
#ifndef SQLITE_CDECL
Edouard@491
   307
# define SQLITE_CDECL
Edouard@491
   308
#endif
Edouard@491
   309
#ifndef SQLITE_STDCALL
Edouard@491
   310
# define SQLITE_STDCALL
Edouard@491
   311
#endif
vb@130
   312
vb@130
   313
/*
vb@130
   314
** These no-op macros are used in front of interfaces to mark those
vb@130
   315
** interfaces as either deprecated or experimental.  New applications
Edouard@491
   316
** should not use deprecated interfaces - they are supported for backwards
vb@130
   317
** compatibility only.  Application writers should be aware that
vb@130
   318
** experimental interfaces are subject to change in point releases.
vb@130
   319
**
vb@130
   320
** These macros used to resolve to various kinds of compiler magic that
vb@130
   321
** would generate warning messages when they were used.  But that
vb@130
   322
** compiler magic ended up generating such a flurry of bug reports
vb@130
   323
** that we have taken it all out and gone back to using simple
vb@130
   324
** noop macros.
vb@130
   325
*/
vb@130
   326
#define SQLITE_DEPRECATED
vb@130
   327
#define SQLITE_EXPERIMENTAL
vb@130
   328
vb@130
   329
/*
vb@130
   330
** Ensure these symbols were not defined by some previous header file.
vb@130
   331
*/
vb@130
   332
#ifdef SQLITE_VERSION
vb@130
   333
# undef SQLITE_VERSION
vb@130
   334
#endif
vb@130
   335
#ifdef SQLITE_VERSION_NUMBER
vb@130
   336
# undef SQLITE_VERSION_NUMBER
vb@130
   337
#endif
vb@130
   338
vb@130
   339
/*
vb@130
   340
** CAPI3REF: Compile-Time Library Version Numbers
vb@130
   341
**
vb@130
   342
** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header
vb@130
   343
** evaluates to a string literal that is the SQLite version in the
vb@130
   344
** format "X.Y.Z" where X is the major version number (always 3 for
vb@130
   345
** SQLite3) and Y is the minor version number and Z is the release number.)^
vb@130
   346
** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer
vb@130
   347
** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z are the same
vb@130
   348
** numbers used in [SQLITE_VERSION].)^
vb@130
   349
** The SQLITE_VERSION_NUMBER for any given release of SQLite will also
vb@130
   350
** be larger than the release from which it is derived.  Either Y will
vb@130
   351
** be held constant and Z will be incremented or else Y will be incremented
vb@130
   352
** and Z will be reset to zero.
vb@130
   353
**
vb@130
   354
** Since version 3.6.18, SQLite source code has been stored in the
vb@130
   355
** <a href="http://www.fossil-scm.org/">Fossil configuration management
vb@130
   356
** system</a>.  ^The SQLITE_SOURCE_ID macro evaluates to
vb@130
   357
** a string which identifies a particular check-in of SQLite
vb@130
   358
** within its configuration management system.  ^The SQLITE_SOURCE_ID
vb@130
   359
** string contains the date and time of the check-in (UTC) and an SHA1
vb@130
   360
** hash of the entire source tree.
vb@130
   361
**
vb@130
   362
** See also: [sqlite3_libversion()],
vb@130
   363
** [sqlite3_libversion_number()], [sqlite3_sourceid()],
vb@130
   364
** [sqlite_version()] and [sqlite_source_id()].
vb@130
   365
*/
vb@716
   366
#define SQLITE_VERSION        "3.13.0"
vb@716
   367
#define SQLITE_VERSION_NUMBER 3013000
vb@716
   368
#define SQLITE_SOURCE_ID      "2016-05-18 10:57:30 fc49f556e48970561d7ab6a2f24fdd7d9eb81ff2"
vb@130
   369
vb@130
   370
/*
vb@130
   371
** CAPI3REF: Run-Time Library Version Numbers
vb@130
   372
** KEYWORDS: sqlite3_version, sqlite3_sourceid
vb@130
   373
**
vb@130
   374
** These interfaces provide the same information as the [SQLITE_VERSION],
vb@130
   375
** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros
vb@130
   376
** but are associated with the library instead of the header file.  ^(Cautious
vb@130
   377
** programmers might include assert() statements in their application to
vb@130
   378
** verify that values returned by these interfaces match the macros in
Edouard@491
   379
** the header, and thus ensure that the application is
vb@130
   380
** compiled with matching library and header files.
vb@130
   381
**
vb@130
   382
** <blockquote><pre>
vb@130
   383
** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER );
vb@130
   384
** assert( strcmp(sqlite3_sourceid(),SQLITE_SOURCE_ID)==0 );
vb@130
   385
** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 );
vb@130
   386
** </pre></blockquote>)^
vb@130
   387
**
vb@130
   388
** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION]
vb@130
   389
** macro.  ^The sqlite3_libversion() function returns a pointer to the
vb@130
   390
** to the sqlite3_version[] string constant.  The sqlite3_libversion()
vb@130
   391
** function is provided for use in DLLs since DLL users usually do not have
vb@130
   392
** direct access to string constants within the DLL.  ^The
vb@130
   393
** sqlite3_libversion_number() function returns an integer equal to
vb@130
   394
** [SQLITE_VERSION_NUMBER].  ^The sqlite3_sourceid() function returns 
vb@130
   395
** a pointer to a string constant whose value is the same as the 
vb@130
   396
** [SQLITE_SOURCE_ID] C preprocessor macro.
vb@130
   397
**
vb@130
   398
** See also: [sqlite_version()] and [sqlite_source_id()].
vb@130
   399
*/
vb@130
   400
SQLITE_API const char sqlite3_version[] = SQLITE_VERSION;
Edouard@491
   401
SQLITE_API const char *SQLITE_STDCALL sqlite3_libversion(void);
Edouard@491
   402
SQLITE_API const char *SQLITE_STDCALL sqlite3_sourceid(void);
Edouard@491
   403
SQLITE_API int SQLITE_STDCALL sqlite3_libversion_number(void);
vb@130
   404
vb@130
   405
/*
vb@130
   406
** CAPI3REF: Run-Time Library Compilation Options Diagnostics
vb@130
   407
**
vb@130
   408
** ^The sqlite3_compileoption_used() function returns 0 or 1 
vb@130
   409
** indicating whether the specified option was defined at 
vb@130
   410
** compile time.  ^The SQLITE_ prefix may be omitted from the 
vb@130
   411
** option name passed to sqlite3_compileoption_used().  
vb@130
   412
**
vb@130
   413
** ^The sqlite3_compileoption_get() function allows iterating
vb@130
   414
** over the list of options that were defined at compile time by
vb@130
   415
** returning the N-th compile time option string.  ^If N is out of range,
vb@130
   416
** sqlite3_compileoption_get() returns a NULL pointer.  ^The SQLITE_ 
vb@130
   417
** prefix is omitted from any strings returned by 
vb@130
   418
** sqlite3_compileoption_get().
vb@130
   419
**
vb@130
   420
** ^Support for the diagnostic functions sqlite3_compileoption_used()
vb@130
   421
** and sqlite3_compileoption_get() may be omitted by specifying the 
vb@130
   422
** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time.
vb@130
   423
**
vb@130
   424
** See also: SQL functions [sqlite_compileoption_used()] and
vb@130
   425
** [sqlite_compileoption_get()] and the [compile_options pragma].
vb@130
   426
*/
vb@130
   427
#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
Edouard@491
   428
SQLITE_API int SQLITE_STDCALL sqlite3_compileoption_used(const char *zOptName);
Edouard@491
   429
SQLITE_API const char *SQLITE_STDCALL sqlite3_compileoption_get(int N);
vb@130
   430
#endif
vb@130
   431
vb@130
   432
/*
vb@130
   433
** CAPI3REF: Test To See If The Library Is Threadsafe
vb@130
   434
**
vb@130
   435
** ^The sqlite3_threadsafe() function returns zero if and only if
vb@130
   436
** SQLite was compiled with mutexing code omitted due to the
vb@130
   437
** [SQLITE_THREADSAFE] compile-time option being set to 0.
vb@130
   438
**
vb@130
   439
** SQLite can be compiled with or without mutexes.  When
vb@130
   440
** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes
vb@130
   441
** are enabled and SQLite is threadsafe.  When the
vb@130
   442
** [SQLITE_THREADSAFE] macro is 0, 
vb@130
   443
** the mutexes are omitted.  Without the mutexes, it is not safe
vb@130
   444
** to use SQLite concurrently from more than one thread.
vb@130
   445
**
vb@130
   446
** Enabling mutexes incurs a measurable performance penalty.
vb@130
   447
** So if speed is of utmost importance, it makes sense to disable
vb@130
   448
** the mutexes.  But for maximum safety, mutexes should be enabled.
vb@130
   449
** ^The default behavior is for mutexes to be enabled.
vb@130
   450
**
vb@130
   451
** This interface can be used by an application to make sure that the
vb@130
   452
** version of SQLite that it is linking against was compiled with
vb@130
   453
** the desired setting of the [SQLITE_THREADSAFE] macro.
vb@130
   454
**
vb@130
   455
** This interface only reports on the compile-time mutex setting
vb@130
   456
** of the [SQLITE_THREADSAFE] flag.  If SQLite is compiled with
vb@130
   457
** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but
vb@130
   458
** can be fully or partially disabled using a call to [sqlite3_config()]
vb@130
   459
** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD],
Edouard@491
   460
** or [SQLITE_CONFIG_SERIALIZED].  ^(The return value of the
vb@130
   461
** sqlite3_threadsafe() function shows only the compile-time setting of
vb@130
   462
** thread safety, not any run-time changes to that setting made by
vb@130
   463
** sqlite3_config(). In other words, the return value from sqlite3_threadsafe()
vb@130
   464
** is unchanged by calls to sqlite3_config().)^
vb@130
   465
**
vb@130
   466
** See the [threading mode] documentation for additional information.
vb@130
   467
*/
Edouard@491
   468
SQLITE_API int SQLITE_STDCALL sqlite3_threadsafe(void);
vb@130
   469
vb@130
   470
/*
vb@130
   471
** CAPI3REF: Database Connection Handle
vb@130
   472
** KEYWORDS: {database connection} {database connections}
vb@130
   473
**
vb@130
   474
** Each open SQLite database is represented by a pointer to an instance of
vb@130
   475
** the opaque structure named "sqlite3".  It is useful to think of an sqlite3
vb@130
   476
** pointer as an object.  The [sqlite3_open()], [sqlite3_open16()], and
vb@130
   477
** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()]
vb@130
   478
** and [sqlite3_close_v2()] are its destructors.  There are many other
vb@130
   479
** interfaces (such as
vb@130
   480
** [sqlite3_prepare_v2()], [sqlite3_create_function()], and
vb@130
   481
** [sqlite3_busy_timeout()] to name but three) that are methods on an
vb@130
   482
** sqlite3 object.
vb@130
   483
*/
vb@130
   484
typedef struct sqlite3 sqlite3;
vb@130
   485
vb@130
   486
/*
vb@130
   487
** CAPI3REF: 64-Bit Integer Types
vb@130
   488
** KEYWORDS: sqlite_int64 sqlite_uint64
vb@130
   489
**
vb@130
   490
** Because there is no cross-platform way to specify 64-bit integer types
vb@130
   491
** SQLite includes typedefs for 64-bit signed and unsigned integers.
vb@130
   492
**
vb@130
   493
** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions.
vb@130
   494
** The sqlite_int64 and sqlite_uint64 types are supported for backwards
vb@130
   495
** compatibility only.
vb@130
   496
**
vb@130
   497
** ^The sqlite3_int64 and sqlite_int64 types can store integer values
vb@130
   498
** between -9223372036854775808 and +9223372036854775807 inclusive.  ^The
vb@130
   499
** sqlite3_uint64 and sqlite_uint64 types can store integer values 
vb@130
   500
** between 0 and +18446744073709551615 inclusive.
vb@130
   501
*/
vb@130
   502
#ifdef SQLITE_INT64_TYPE
vb@130
   503
  typedef SQLITE_INT64_TYPE sqlite_int64;
vb@130
   504
  typedef unsigned SQLITE_INT64_TYPE sqlite_uint64;
vb@130
   505
#elif defined(_MSC_VER) || defined(__BORLANDC__)
vb@130
   506
  typedef __int64 sqlite_int64;
vb@130
   507
  typedef unsigned __int64 sqlite_uint64;
vb@130
   508
#else
vb@130
   509
  typedef long long int sqlite_int64;
vb@130
   510
  typedef unsigned long long int sqlite_uint64;
vb@130
   511
#endif
vb@130
   512
typedef sqlite_int64 sqlite3_int64;
vb@130
   513
typedef sqlite_uint64 sqlite3_uint64;
vb@130
   514
vb@130
   515
/*
vb@130
   516
** If compiling for a processor that lacks floating point support,
vb@130
   517
** substitute integer for floating-point.
vb@130
   518
*/
vb@130
   519
#ifdef SQLITE_OMIT_FLOATING_POINT
vb@130
   520
# define double sqlite3_int64
vb@130
   521
#endif
vb@130
   522
vb@130
   523
/*
vb@130
   524
** CAPI3REF: Closing A Database Connection
Edouard@491
   525
** DESTRUCTOR: sqlite3
vb@130
   526
**
vb@130
   527
** ^The sqlite3_close() and sqlite3_close_v2() routines are destructors
vb@130
   528
** for the [sqlite3] object.
vb@130
   529
** ^Calls to sqlite3_close() and sqlite3_close_v2() return [SQLITE_OK] if
vb@130
   530
** the [sqlite3] object is successfully destroyed and all associated
vb@130
   531
** resources are deallocated.
vb@130
   532
**
vb@130
   533
** ^If the database connection is associated with unfinalized prepared
vb@130
   534
** statements or unfinished sqlite3_backup objects then sqlite3_close()
vb@130
   535
** will leave the database connection open and return [SQLITE_BUSY].
vb@130
   536
** ^If sqlite3_close_v2() is called with unfinalized prepared statements
vb@130
   537
** and/or unfinished sqlite3_backups, then the database connection becomes
vb@130
   538
** an unusable "zombie" which will automatically be deallocated when the
vb@130
   539
** last prepared statement is finalized or the last sqlite3_backup is
vb@130
   540
** finished.  The sqlite3_close_v2() interface is intended for use with
vb@130
   541
** host languages that are garbage collected, and where the order in which
vb@130
   542
** destructors are called is arbitrary.
vb@130
   543
**
vb@130
   544
** Applications should [sqlite3_finalize | finalize] all [prepared statements],
vb@130
   545
** [sqlite3_blob_close | close] all [BLOB handles], and 
vb@130
   546
** [sqlite3_backup_finish | finish] all [sqlite3_backup] objects associated
vb@130
   547
** with the [sqlite3] object prior to attempting to close the object.  ^If
vb@130
   548
** sqlite3_close_v2() is called on a [database connection] that still has
vb@130
   549
** outstanding [prepared statements], [BLOB handles], and/or
vb@130
   550
** [sqlite3_backup] objects then it returns [SQLITE_OK] and the deallocation
vb@130
   551
** of resources is deferred until all [prepared statements], [BLOB handles],
vb@130
   552
** and [sqlite3_backup] objects are also destroyed.
vb@130
   553
**
vb@130
   554
** ^If an [sqlite3] object is destroyed while a transaction is open,
vb@130
   555
** the transaction is automatically rolled back.
vb@130
   556
**
vb@130
   557
** The C parameter to [sqlite3_close(C)] and [sqlite3_close_v2(C)]
vb@130
   558
** must be either a NULL
vb@130
   559
** pointer or an [sqlite3] object pointer obtained
vb@130
   560
** from [sqlite3_open()], [sqlite3_open16()], or
vb@130
   561
** [sqlite3_open_v2()], and not previously closed.
vb@130
   562
** ^Calling sqlite3_close() or sqlite3_close_v2() with a NULL pointer
vb@130
   563
** argument is a harmless no-op.
vb@130
   564
*/
Edouard@491
   565
SQLITE_API int SQLITE_STDCALL sqlite3_close(sqlite3*);
Edouard@491
   566
SQLITE_API int SQLITE_STDCALL sqlite3_close_v2(sqlite3*);
vb@130
   567
vb@130
   568
/*
vb@130
   569
** The type for a callback function.
vb@130
   570
** This is legacy and deprecated.  It is included for historical
vb@130
   571
** compatibility and is not documented.
vb@130
   572
*/
vb@130
   573
typedef int (*sqlite3_callback)(void*,int,char**, char**);
vb@130
   574
vb@130
   575
/*
vb@130
   576
** CAPI3REF: One-Step Query Execution Interface
Edouard@491
   577
** METHOD: sqlite3
vb@130
   578
**
vb@130
   579
** The sqlite3_exec() interface is a convenience wrapper around
vb@130
   580
** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()],
vb@130
   581
** that allows an application to run multiple statements of SQL
vb@130
   582
** without having to use a lot of C code. 
vb@130
   583
**
vb@130
   584
** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded,
vb@130
   585
** semicolon-separate SQL statements passed into its 2nd argument,
vb@130
   586
** in the context of the [database connection] passed in as its 1st
vb@130
   587
** argument.  ^If the callback function of the 3rd argument to
vb@130
   588
** sqlite3_exec() is not NULL, then it is invoked for each result row
vb@130
   589
** coming out of the evaluated SQL statements.  ^The 4th argument to
vb@130
   590
** sqlite3_exec() is relayed through to the 1st argument of each
vb@130
   591
** callback invocation.  ^If the callback pointer to sqlite3_exec()
vb@130
   592
** is NULL, then no callback is ever invoked and result rows are
vb@130
   593
** ignored.
vb@130
   594
**
vb@130
   595
** ^If an error occurs while evaluating the SQL statements passed into
vb@130
   596
** sqlite3_exec(), then execution of the current statement stops and
vb@130
   597
** subsequent statements are skipped.  ^If the 5th parameter to sqlite3_exec()
vb@130
   598
** is not NULL then any error message is written into memory obtained
vb@130
   599
** from [sqlite3_malloc()] and passed back through the 5th parameter.
vb@130
   600
** To avoid memory leaks, the application should invoke [sqlite3_free()]
vb@130
   601
** on error message strings returned through the 5th parameter of
Edouard@491
   602
** sqlite3_exec() after the error message string is no longer needed.
vb@130
   603
** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors
vb@130
   604
** occur, then sqlite3_exec() sets the pointer in its 5th parameter to
vb@130
   605
** NULL before returning.
vb@130
   606
**
vb@130
   607
** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec()
vb@130
   608
** routine returns SQLITE_ABORT without invoking the callback again and
vb@130
   609
** without running any subsequent SQL statements.
vb@130
   610
**
vb@130
   611
** ^The 2nd argument to the sqlite3_exec() callback function is the
vb@130
   612
** number of columns in the result.  ^The 3rd argument to the sqlite3_exec()
vb@130
   613
** callback is an array of pointers to strings obtained as if from
vb@130
   614
** [sqlite3_column_text()], one for each column.  ^If an element of a
vb@130
   615
** result row is NULL then the corresponding string pointer for the
vb@130
   616
** sqlite3_exec() callback is a NULL pointer.  ^The 4th argument to the
vb@130
   617
** sqlite3_exec() callback is an array of pointers to strings where each
vb@130
   618
** entry represents the name of corresponding result column as obtained
vb@130
   619
** from [sqlite3_column_name()].
vb@130
   620
**
vb@130
   621
** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer
vb@130
   622
** to an empty string, or a pointer that contains only whitespace and/or 
vb@130
   623
** SQL comments, then no SQL statements are evaluated and the database
vb@130
   624
** is not changed.
vb@130
   625
**
vb@130
   626
** Restrictions:
vb@130
   627
**
vb@130
   628
** <ul>
Edouard@491
   629
** <li> The application must ensure that the 1st parameter to sqlite3_exec()
vb@130
   630
**      is a valid and open [database connection].
vb@130
   631
** <li> The application must not close the [database connection] specified by
vb@130
   632
**      the 1st parameter to sqlite3_exec() while sqlite3_exec() is running.
vb@130
   633
** <li> The application must not modify the SQL statement text passed into
vb@130
   634
**      the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running.
vb@130
   635
** </ul>
vb@130
   636
*/
Edouard@491
   637
SQLITE_API int SQLITE_STDCALL sqlite3_exec(
vb@130
   638
  sqlite3*,                                  /* An open database */
vb@130
   639
  const char *sql,                           /* SQL to be evaluated */
vb@130
   640
  int (*callback)(void*,int,char**,char**),  /* Callback function */
vb@130
   641
  void *,                                    /* 1st argument to callback */
vb@130
   642
  char **errmsg                              /* Error msg written here */
vb@130
   643
);
vb@130
   644
vb@130
   645
/*
vb@130
   646
** CAPI3REF: Result Codes
vb@130
   647
** KEYWORDS: {result code definitions}
vb@130
   648
**
vb@130
   649
** Many SQLite functions return an integer result code from the set shown
vb@130
   650
** here in order to indicate success or failure.
vb@130
   651
**
vb@130
   652
** New error codes may be added in future versions of SQLite.
vb@130
   653
**
vb@130
   654
** See also: [extended result code definitions]
vb@130
   655
*/
vb@130
   656
#define SQLITE_OK           0   /* Successful result */
vb@130
   657
/* beginning-of-error-codes */
vb@130
   658
#define SQLITE_ERROR        1   /* SQL error or missing database */
vb@130
   659
#define SQLITE_INTERNAL     2   /* Internal logic error in SQLite */
vb@130
   660
#define SQLITE_PERM         3   /* Access permission denied */
vb@130
   661
#define SQLITE_ABORT        4   /* Callback routine requested an abort */
vb@130
   662
#define SQLITE_BUSY         5   /* The database file is locked */
vb@130
   663
#define SQLITE_LOCKED       6   /* A table in the database is locked */
vb@130
   664
#define SQLITE_NOMEM        7   /* A malloc() failed */
vb@130
   665
#define SQLITE_READONLY     8   /* Attempt to write a readonly database */
vb@130
   666
#define SQLITE_INTERRUPT    9   /* Operation terminated by sqlite3_interrupt()*/
vb@130
   667
#define SQLITE_IOERR       10   /* Some kind of disk I/O error occurred */
vb@130
   668
#define SQLITE_CORRUPT     11   /* The database disk image is malformed */
vb@130
   669
#define SQLITE_NOTFOUND    12   /* Unknown opcode in sqlite3_file_control() */
vb@130
   670
#define SQLITE_FULL        13   /* Insertion failed because database is full */
vb@130
   671
#define SQLITE_CANTOPEN    14   /* Unable to open the database file */
vb@130
   672
#define SQLITE_PROTOCOL    15   /* Database lock protocol error */
vb@130
   673
#define SQLITE_EMPTY       16   /* Database is empty */
vb@130
   674
#define SQLITE_SCHEMA      17   /* The database schema changed */
vb@130
   675
#define SQLITE_TOOBIG      18   /* String or BLOB exceeds size limit */
vb@130
   676
#define SQLITE_CONSTRAINT  19   /* Abort due to constraint violation */
vb@130
   677
#define SQLITE_MISMATCH    20   /* Data type mismatch */
vb@130
   678
#define SQLITE_MISUSE      21   /* Library used incorrectly */
vb@130
   679
#define SQLITE_NOLFS       22   /* Uses OS features not supported on host */
vb@130
   680
#define SQLITE_AUTH        23   /* Authorization denied */
vb@130
   681
#define SQLITE_FORMAT      24   /* Auxiliary database format error */
vb@130
   682
#define SQLITE_RANGE       25   /* 2nd parameter to sqlite3_bind out of range */
vb@130
   683
#define SQLITE_NOTADB      26   /* File opened that is not a database file */
vb@130
   684
#define SQLITE_NOTICE      27   /* Notifications from sqlite3_log() */
vb@130
   685
#define SQLITE_WARNING     28   /* Warnings from sqlite3_log() */
vb@130
   686
#define SQLITE_ROW         100  /* sqlite3_step() has another row ready */
vb@130
   687
#define SQLITE_DONE        101  /* sqlite3_step() has finished executing */
vb@130
   688
/* end-of-error-codes */
vb@130
   689
vb@130
   690
/*
vb@130
   691
** CAPI3REF: Extended Result Codes
vb@130
   692
** KEYWORDS: {extended result code definitions}
vb@130
   693
**
vb@130
   694
** In its default configuration, SQLite API routines return one of 30 integer
vb@130
   695
** [result codes].  However, experience has shown that many of
vb@130
   696
** these result codes are too coarse-grained.  They do not provide as
vb@130
   697
** much information about problems as programmers might like.  In an effort to
vb@130
   698
** address this, newer versions of SQLite (version 3.3.8 and later) include
vb@130
   699
** support for additional result codes that provide more detailed information
vb@130
   700
** about errors. These [extended result codes] are enabled or disabled
vb@130
   701
** on a per database connection basis using the
vb@130
   702
** [sqlite3_extended_result_codes()] API.  Or, the extended code for
vb@130
   703
** the most recent error can be obtained using
vb@130
   704
** [sqlite3_extended_errcode()].
vb@130
   705
*/
vb@130
   706
#define SQLITE_IOERR_READ              (SQLITE_IOERR | (1<<8))
vb@130
   707
#define SQLITE_IOERR_SHORT_READ        (SQLITE_IOERR | (2<<8))
vb@130
   708
#define SQLITE_IOERR_WRITE             (SQLITE_IOERR | (3<<8))
vb@130
   709
#define SQLITE_IOERR_FSYNC             (SQLITE_IOERR | (4<<8))
vb@130
   710
#define SQLITE_IOERR_DIR_FSYNC         (SQLITE_IOERR | (5<<8))
vb@130
   711
#define SQLITE_IOERR_TRUNCATE          (SQLITE_IOERR | (6<<8))
vb@130
   712
#define SQLITE_IOERR_FSTAT             (SQLITE_IOERR | (7<<8))
vb@130
   713
#define SQLITE_IOERR_UNLOCK            (SQLITE_IOERR | (8<<8))
vb@130
   714
#define SQLITE_IOERR_RDLOCK            (SQLITE_IOERR | (9<<8))
vb@130
   715
#define SQLITE_IOERR_DELETE            (SQLITE_IOERR | (10<<8))
vb@130
   716
#define SQLITE_IOERR_BLOCKED           (SQLITE_IOERR | (11<<8))
vb@130
   717
#define SQLITE_IOERR_NOMEM             (SQLITE_IOERR | (12<<8))
vb@130
   718
#define SQLITE_IOERR_ACCESS            (SQLITE_IOERR | (13<<8))
vb@130
   719
#define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8))
vb@130
   720
#define SQLITE_IOERR_LOCK              (SQLITE_IOERR | (15<<8))
vb@130
   721
#define SQLITE_IOERR_CLOSE             (SQLITE_IOERR | (16<<8))
vb@130
   722
#define SQLITE_IOERR_DIR_CLOSE         (SQLITE_IOERR | (17<<8))
vb@130
   723
#define SQLITE_IOERR_SHMOPEN           (SQLITE_IOERR | (18<<8))
vb@130
   724
#define SQLITE_IOERR_SHMSIZE           (SQLITE_IOERR | (19<<8))
vb@130
   725
#define SQLITE_IOERR_SHMLOCK           (SQLITE_IOERR | (20<<8))
vb@130
   726
#define SQLITE_IOERR_SHMMAP            (SQLITE_IOERR | (21<<8))
vb@130
   727
#define SQLITE_IOERR_SEEK              (SQLITE_IOERR | (22<<8))
vb@130
   728
#define SQLITE_IOERR_DELETE_NOENT      (SQLITE_IOERR | (23<<8))
vb@130
   729
#define SQLITE_IOERR_MMAP              (SQLITE_IOERR | (24<<8))
vb@130
   730
#define SQLITE_IOERR_GETTEMPPATH       (SQLITE_IOERR | (25<<8))
vb@130
   731
#define SQLITE_IOERR_CONVPATH          (SQLITE_IOERR | (26<<8))
Edouard@491
   732
#define SQLITE_IOERR_VNODE             (SQLITE_IOERR | (27<<8))
Edouard@491
   733
#define SQLITE_IOERR_AUTH              (SQLITE_IOERR | (28<<8))
vb@130
   734
#define SQLITE_LOCKED_SHAREDCACHE      (SQLITE_LOCKED |  (1<<8))
vb@130
   735
#define SQLITE_BUSY_RECOVERY           (SQLITE_BUSY   |  (1<<8))
vb@130
   736
#define SQLITE_BUSY_SNAPSHOT           (SQLITE_BUSY   |  (2<<8))
vb@130
   737
#define SQLITE_CANTOPEN_NOTEMPDIR      (SQLITE_CANTOPEN | (1<<8))
vb@130
   738
#define SQLITE_CANTOPEN_ISDIR          (SQLITE_CANTOPEN | (2<<8))
vb@130
   739
#define SQLITE_CANTOPEN_FULLPATH       (SQLITE_CANTOPEN | (3<<8))
vb@130
   740
#define SQLITE_CANTOPEN_CONVPATH       (SQLITE_CANTOPEN | (4<<8))
vb@130
   741
#define SQLITE_CORRUPT_VTAB            (SQLITE_CORRUPT | (1<<8))
vb@130
   742
#define SQLITE_READONLY_RECOVERY       (SQLITE_READONLY | (1<<8))
vb@130
   743
#define SQLITE_READONLY_CANTLOCK       (SQLITE_READONLY | (2<<8))
vb@130
   744
#define SQLITE_READONLY_ROLLBACK       (SQLITE_READONLY | (3<<8))
vb@130
   745
#define SQLITE_READONLY_DBMOVED        (SQLITE_READONLY | (4<<8))
vb@130
   746
#define SQLITE_ABORT_ROLLBACK          (SQLITE_ABORT | (2<<8))
vb@130
   747
#define SQLITE_CONSTRAINT_CHECK        (SQLITE_CONSTRAINT | (1<<8))
vb@130
   748
#define SQLITE_CONSTRAINT_COMMITHOOK   (SQLITE_CONSTRAINT | (2<<8))
vb@130
   749
#define SQLITE_CONSTRAINT_FOREIGNKEY   (SQLITE_CONSTRAINT | (3<<8))
vb@130
   750
#define SQLITE_CONSTRAINT_FUNCTION     (SQLITE_CONSTRAINT | (4<<8))
vb@130
   751
#define SQLITE_CONSTRAINT_NOTNULL      (SQLITE_CONSTRAINT | (5<<8))
vb@130
   752
#define SQLITE_CONSTRAINT_PRIMARYKEY   (SQLITE_CONSTRAINT | (6<<8))
vb@130
   753
#define SQLITE_CONSTRAINT_TRIGGER      (SQLITE_CONSTRAINT | (7<<8))
vb@130
   754
#define SQLITE_CONSTRAINT_UNIQUE       (SQLITE_CONSTRAINT | (8<<8))
vb@130
   755
#define SQLITE_CONSTRAINT_VTAB         (SQLITE_CONSTRAINT | (9<<8))
vb@130
   756
#define SQLITE_CONSTRAINT_ROWID        (SQLITE_CONSTRAINT |(10<<8))
vb@130
   757
#define SQLITE_NOTICE_RECOVER_WAL      (SQLITE_NOTICE | (1<<8))
vb@130
   758
#define SQLITE_NOTICE_RECOVER_ROLLBACK (SQLITE_NOTICE | (2<<8))
vb@130
   759
#define SQLITE_WARNING_AUTOINDEX       (SQLITE_WARNING | (1<<8))
Edouard@491
   760
#define SQLITE_AUTH_USER               (SQLITE_AUTH | (1<<8))
vb@130
   761
vb@130
   762
/*
vb@130
   763
** CAPI3REF: Flags For File Open Operations
vb@130
   764
**
vb@130
   765
** These bit values are intended for use in the
vb@130
   766
** 3rd parameter to the [sqlite3_open_v2()] interface and
vb@130
   767
** in the 4th parameter to the [sqlite3_vfs.xOpen] method.
vb@130
   768
*/
vb@130
   769
#define SQLITE_OPEN_READONLY         0x00000001  /* Ok for sqlite3_open_v2() */
vb@130
   770
#define SQLITE_OPEN_READWRITE        0x00000002  /* Ok for sqlite3_open_v2() */
vb@130
   771
#define SQLITE_OPEN_CREATE           0x00000004  /* Ok for sqlite3_open_v2() */
vb@130
   772
#define SQLITE_OPEN_DELETEONCLOSE    0x00000008  /* VFS only */
vb@130
   773
#define SQLITE_OPEN_EXCLUSIVE        0x00000010  /* VFS only */
vb@130
   774
#define SQLITE_OPEN_AUTOPROXY        0x00000020  /* VFS only */
vb@130
   775
#define SQLITE_OPEN_URI              0x00000040  /* Ok for sqlite3_open_v2() */
vb@130
   776
#define SQLITE_OPEN_MEMORY           0x00000080  /* Ok for sqlite3_open_v2() */
vb@130
   777
#define SQLITE_OPEN_MAIN_DB          0x00000100  /* VFS only */
vb@130
   778
#define SQLITE_OPEN_TEMP_DB          0x00000200  /* VFS only */
vb@130
   779
#define SQLITE_OPEN_TRANSIENT_DB     0x00000400  /* VFS only */
vb@130
   780
#define SQLITE_OPEN_MAIN_JOURNAL     0x00000800  /* VFS only */
vb@130
   781
#define SQLITE_OPEN_TEMP_JOURNAL     0x00001000  /* VFS only */
vb@130
   782
#define SQLITE_OPEN_SUBJOURNAL       0x00002000  /* VFS only */
vb@130
   783
#define SQLITE_OPEN_MASTER_JOURNAL   0x00004000  /* VFS only */
vb@130
   784
#define SQLITE_OPEN_NOMUTEX          0x00008000  /* Ok for sqlite3_open_v2() */
vb@130
   785
#define SQLITE_OPEN_FULLMUTEX        0x00010000  /* Ok for sqlite3_open_v2() */
vb@130
   786
#define SQLITE_OPEN_SHAREDCACHE      0x00020000  /* Ok for sqlite3_open_v2() */
vb@130
   787
#define SQLITE_OPEN_PRIVATECACHE     0x00040000  /* Ok for sqlite3_open_v2() */
vb@130
   788
#define SQLITE_OPEN_WAL              0x00080000  /* VFS only */
vb@130
   789
vb@130
   790
/* Reserved:                         0x00F00000 */
vb@130
   791
vb@130
   792
/*
vb@130
   793
** CAPI3REF: Device Characteristics
vb@130
   794
**
vb@130
   795
** The xDeviceCharacteristics method of the [sqlite3_io_methods]
vb@130
   796
** object returns an integer which is a vector of these
vb@130
   797
** bit values expressing I/O characteristics of the mass storage
vb@130
   798
** device that holds the file that the [sqlite3_io_methods]
vb@130
   799
** refers to.
vb@130
   800
**
vb@130
   801
** The SQLITE_IOCAP_ATOMIC property means that all writes of
vb@130
   802
** any size are atomic.  The SQLITE_IOCAP_ATOMICnnn values
vb@130
   803
** mean that writes of blocks that are nnn bytes in size and
vb@130
   804
** are aligned to an address which is an integer multiple of
vb@130
   805
** nnn are atomic.  The SQLITE_IOCAP_SAFE_APPEND value means
vb@130
   806
** that when data is appended to a file, the data is appended
vb@130
   807
** first then the size of the file is extended, never the other
vb@130
   808
** way around.  The SQLITE_IOCAP_SEQUENTIAL property means that
vb@130
   809
** information is written to disk in the same order as calls
vb@130
   810
** to xWrite().  The SQLITE_IOCAP_POWERSAFE_OVERWRITE property means that
vb@130
   811
** after reboot following a crash or power loss, the only bytes in a
vb@130
   812
** file that were written at the application level might have changed
vb@130
   813
** and that adjacent bytes, even bytes within the same sector are
vb@130
   814
** guaranteed to be unchanged.  The SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN
vb@130
   815
** flag indicate that a file cannot be deleted when open.  The
vb@130
   816
** SQLITE_IOCAP_IMMUTABLE flag indicates that the file is on
vb@130
   817
** read-only media and cannot be changed even by processes with
vb@130
   818
** elevated privileges.
vb@130
   819
*/
vb@130
   820
#define SQLITE_IOCAP_ATOMIC                 0x00000001
vb@130
   821
#define SQLITE_IOCAP_ATOMIC512              0x00000002
vb@130
   822
#define SQLITE_IOCAP_ATOMIC1K               0x00000004
vb@130
   823
#define SQLITE_IOCAP_ATOMIC2K               0x00000008
vb@130
   824
#define SQLITE_IOCAP_ATOMIC4K               0x00000010
vb@130
   825
#define SQLITE_IOCAP_ATOMIC8K               0x00000020
vb@130
   826
#define SQLITE_IOCAP_ATOMIC16K              0x00000040
vb@130
   827
#define SQLITE_IOCAP_ATOMIC32K              0x00000080
vb@130
   828
#define SQLITE_IOCAP_ATOMIC64K              0x00000100
vb@130
   829
#define SQLITE_IOCAP_SAFE_APPEND            0x00000200
vb@130
   830
#define SQLITE_IOCAP_SEQUENTIAL             0x00000400
vb@130
   831
#define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN  0x00000800
vb@130
   832
#define SQLITE_IOCAP_POWERSAFE_OVERWRITE    0x00001000
vb@130
   833
#define SQLITE_IOCAP_IMMUTABLE              0x00002000
vb@130
   834
vb@130
   835
/*
vb@130
   836
** CAPI3REF: File Locking Levels
vb@130
   837
**
vb@130
   838
** SQLite uses one of these integer values as the second
vb@130
   839
** argument to calls it makes to the xLock() and xUnlock() methods
vb@130
   840
** of an [sqlite3_io_methods] object.
vb@130
   841
*/
vb@130
   842
#define SQLITE_LOCK_NONE          0
vb@130
   843
#define SQLITE_LOCK_SHARED        1
vb@130
   844
#define SQLITE_LOCK_RESERVED      2
vb@130
   845
#define SQLITE_LOCK_PENDING       3
vb@130
   846
#define SQLITE_LOCK_EXCLUSIVE     4
vb@130
   847
vb@130
   848
/*
vb@130
   849
** CAPI3REF: Synchronization Type Flags
vb@130
   850
**
vb@130
   851
** When SQLite invokes the xSync() method of an
vb@130
   852
** [sqlite3_io_methods] object it uses a combination of
vb@130
   853
** these integer values as the second argument.
vb@130
   854
**
vb@130
   855
** When the SQLITE_SYNC_DATAONLY flag is used, it means that the
vb@130
   856
** sync operation only needs to flush data to mass storage.  Inode
vb@130
   857
** information need not be flushed. If the lower four bits of the flag
vb@130
   858
** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics.
vb@130
   859
** If the lower four bits equal SQLITE_SYNC_FULL, that means
vb@130
   860
** to use Mac OS X style fullsync instead of fsync().
vb@130
   861
**
vb@130
   862
** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags
vb@130
   863
** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL
vb@130
   864
** settings.  The [synchronous pragma] determines when calls to the
vb@130
   865
** xSync VFS method occur and applies uniformly across all platforms.
vb@130
   866
** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how
vb@130
   867
** energetic or rigorous or forceful the sync operations are and
vb@130
   868
** only make a difference on Mac OSX for the default SQLite code.
vb@130
   869
** (Third-party VFS implementations might also make the distinction
vb@130
   870
** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the
vb@130
   871
** operating systems natively supported by SQLite, only Mac OSX
vb@130
   872
** cares about the difference.)
vb@130
   873
*/
vb@130
   874
#define SQLITE_SYNC_NORMAL        0x00002
vb@130
   875
#define SQLITE_SYNC_FULL          0x00003
vb@130
   876
#define SQLITE_SYNC_DATAONLY      0x00010
vb@130
   877
vb@130
   878
/*
vb@130
   879
** CAPI3REF: OS Interface Open File Handle
vb@130
   880
**
vb@130
   881
** An [sqlite3_file] object represents an open file in the 
vb@130
   882
** [sqlite3_vfs | OS interface layer].  Individual OS interface
vb@130
   883
** implementations will
vb@130
   884
** want to subclass this object by appending additional fields
vb@130
   885
** for their own use.  The pMethods entry is a pointer to an
vb@130
   886
** [sqlite3_io_methods] object that defines methods for performing
vb@130
   887
** I/O operations on the open file.
vb@130
   888
*/
vb@130
   889
typedef struct sqlite3_file sqlite3_file;
vb@130
   890
struct sqlite3_file {
vb@130
   891
  const struct sqlite3_io_methods *pMethods;  /* Methods for an open file */
vb@130
   892
};
vb@130
   893
vb@130
   894
/*
vb@130
   895
** CAPI3REF: OS Interface File Virtual Methods Object
vb@130
   896
**
vb@130
   897
** Every file opened by the [sqlite3_vfs.xOpen] method populates an
vb@130
   898
** [sqlite3_file] object (or, more commonly, a subclass of the
vb@130
   899
** [sqlite3_file] object) with a pointer to an instance of this object.
vb@130
   900
** This object defines the methods used to perform various operations
vb@130
   901
** against the open file represented by the [sqlite3_file] object.
vb@130
   902
**
vb@130
   903
** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element 
vb@130
   904
** to a non-NULL pointer, then the sqlite3_io_methods.xClose method
vb@130
   905
** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed.  The
vb@130
   906
** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen]
vb@130
   907
** is for the [sqlite3_vfs.xOpen] to set the sqlite3_file.pMethods element
vb@130
   908
** to NULL.
vb@130
   909
**
vb@130
   910
** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or
vb@130
   911
** [SQLITE_SYNC_FULL].  The first choice is the normal fsync().
vb@130
   912
** The second choice is a Mac OS X style fullsync.  The [SQLITE_SYNC_DATAONLY]
vb@130
   913
** flag may be ORed in to indicate that only the data of the file
vb@130
   914
** and not its inode needs to be synced.
vb@130
   915
**
vb@130
   916
** The integer values to xLock() and xUnlock() are one of
vb@130
   917
** <ul>
vb@130
   918
** <li> [SQLITE_LOCK_NONE],
vb@130
   919
** <li> [SQLITE_LOCK_SHARED],
vb@130
   920
** <li> [SQLITE_LOCK_RESERVED],
vb@130
   921
** <li> [SQLITE_LOCK_PENDING], or
vb@130
   922
** <li> [SQLITE_LOCK_EXCLUSIVE].
vb@130
   923
** </ul>
vb@130
   924
** xLock() increases the lock. xUnlock() decreases the lock.
vb@130
   925
** The xCheckReservedLock() method checks whether any database connection,
vb@130
   926
** either in this process or in some other process, is holding a RESERVED,
vb@130
   927
** PENDING, or EXCLUSIVE lock on the file.  It returns true
vb@130
   928
** if such a lock exists and false otherwise.
vb@130
   929
**
vb@130
   930
** The xFileControl() method is a generic interface that allows custom
vb@130
   931
** VFS implementations to directly control an open file using the
vb@130
   932
** [sqlite3_file_control()] interface.  The second "op" argument is an
vb@130
   933
** integer opcode.  The third argument is a generic pointer intended to
vb@130
   934
** point to a structure that may contain arguments or space in which to
vb@130
   935
** write return values.  Potential uses for xFileControl() might be
vb@130
   936
** functions to enable blocking locks with timeouts, to change the
vb@130
   937
** locking strategy (for example to use dot-file locks), to inquire
vb@130
   938
** about the status of a lock, or to break stale locks.  The SQLite
vb@130
   939
** core reserves all opcodes less than 100 for its own use.
vb@130
   940
** A [file control opcodes | list of opcodes] less than 100 is available.
vb@130
   941
** Applications that define a custom xFileControl method should use opcodes
vb@130
   942
** greater than 100 to avoid conflicts.  VFS implementations should
vb@130
   943
** return [SQLITE_NOTFOUND] for file control opcodes that they do not
vb@130
   944
** recognize.
vb@130
   945
**
vb@130
   946
** The xSectorSize() method returns the sector size of the
vb@130
   947
** device that underlies the file.  The sector size is the
vb@130
   948
** minimum write that can be performed without disturbing
vb@130
   949
** other bytes in the file.  The xDeviceCharacteristics()
vb@130
   950
** method returns a bit vector describing behaviors of the
vb@130
   951
** underlying device:
vb@130
   952
**
vb@130
   953
** <ul>
vb@130
   954
** <li> [SQLITE_IOCAP_ATOMIC]
vb@130
   955
** <li> [SQLITE_IOCAP_ATOMIC512]
vb@130
   956
** <li> [SQLITE_IOCAP_ATOMIC1K]
vb@130
   957
** <li> [SQLITE_IOCAP_ATOMIC2K]
vb@130
   958
** <li> [SQLITE_IOCAP_ATOMIC4K]
vb@130
   959
** <li> [SQLITE_IOCAP_ATOMIC8K]
vb@130
   960
** <li> [SQLITE_IOCAP_ATOMIC16K]
vb@130
   961
** <li> [SQLITE_IOCAP_ATOMIC32K]
vb@130
   962
** <li> [SQLITE_IOCAP_ATOMIC64K]
vb@130
   963
** <li> [SQLITE_IOCAP_SAFE_APPEND]
vb@130
   964
** <li> [SQLITE_IOCAP_SEQUENTIAL]
vb@130
   965
** </ul>
vb@130
   966
**
vb@130
   967
** The SQLITE_IOCAP_ATOMIC property means that all writes of
vb@130
   968
** any size are atomic.  The SQLITE_IOCAP_ATOMICnnn values
vb@130
   969
** mean that writes of blocks that are nnn bytes in size and
vb@130
   970
** are aligned to an address which is an integer multiple of
vb@130
   971
** nnn are atomic.  The SQLITE_IOCAP_SAFE_APPEND value means
vb@130
   972
** that when data is appended to a file, the data is appended
vb@130
   973
** first then the size of the file is extended, never the other
vb@130
   974
** way around.  The SQLITE_IOCAP_SEQUENTIAL property means that
vb@130
   975
** information is written to disk in the same order as calls
vb@130
   976
** to xWrite().
vb@130
   977
**
vb@130
   978
** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill
vb@130
   979
** in the unread portions of the buffer with zeros.  A VFS that
vb@130
   980
** fails to zero-fill short reads might seem to work.  However,
vb@130
   981
** failure to zero-fill short reads will eventually lead to
vb@130
   982
** database corruption.
vb@130
   983
*/
vb@130
   984
typedef struct sqlite3_io_methods sqlite3_io_methods;
vb@130
   985
struct sqlite3_io_methods {
vb@130
   986
  int iVersion;
vb@130
   987
  int (*xClose)(sqlite3_file*);
vb@130
   988
  int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst);
vb@130
   989
  int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst);
vb@130
   990
  int (*xTruncate)(sqlite3_file*, sqlite3_int64 size);
vb@130
   991
  int (*xSync)(sqlite3_file*, int flags);
vb@130
   992
  int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize);
vb@130
   993
  int (*xLock)(sqlite3_file*, int);
vb@130
   994
  int (*xUnlock)(sqlite3_file*, int);
vb@130
   995
  int (*xCheckReservedLock)(sqlite3_file*, int *pResOut);
vb@130
   996
  int (*xFileControl)(sqlite3_file*, int op, void *pArg);
vb@130
   997
  int (*xSectorSize)(sqlite3_file*);
vb@130
   998
  int (*xDeviceCharacteristics)(sqlite3_file*);
vb@130
   999
  /* Methods above are valid for version 1 */
vb@130
  1000
  int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, void volatile**);
vb@130
  1001
  int (*xShmLock)(sqlite3_file*, int offset, int n, int flags);
vb@130
  1002
  void (*xShmBarrier)(sqlite3_file*);
vb@130
  1003
  int (*xShmUnmap)(sqlite3_file*, int deleteFlag);
vb@130
  1004
  /* Methods above are valid for version 2 */
vb@130
  1005
  int (*xFetch)(sqlite3_file*, sqlite3_int64 iOfst, int iAmt, void **pp);
vb@130
  1006
  int (*xUnfetch)(sqlite3_file*, sqlite3_int64 iOfst, void *p);
vb@130
  1007
  /* Methods above are valid for version 3 */
vb@130
  1008
  /* Additional methods may be added in future releases */
vb@130
  1009
};
vb@130
  1010
vb@130
  1011
/*
vb@130
  1012
** CAPI3REF: Standard File Control Opcodes
vb@130
  1013
** KEYWORDS: {file control opcodes} {file control opcode}
vb@130
  1014
**
vb@130
  1015
** These integer constants are opcodes for the xFileControl method
vb@130
  1016
** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()]
vb@130
  1017
** interface.
vb@130
  1018
**
Edouard@491
  1019
** <ul>
Edouard@491
  1020
** <li>[[SQLITE_FCNTL_LOCKSTATE]]
vb@130
  1021
** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging.  This
vb@130
  1022
** opcode causes the xFileControl method to write the current state of
vb@130
  1023
** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED],
vb@130
  1024
** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE])
vb@130
  1025
** into an integer that the pArg argument points to. This capability
Edouard@491
  1026
** is used during testing and is only available when the SQLITE_TEST
Edouard@491
  1027
** compile-time option is used.
Edouard@491
  1028
**
vb@130
  1029
** <li>[[SQLITE_FCNTL_SIZE_HINT]]
vb@130
  1030
** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS
vb@130
  1031
** layer a hint of how large the database file will grow to be during the
vb@130
  1032
** current transaction.  This hint is not guaranteed to be accurate but it
vb@130
  1033
** is often close.  The underlying VFS might choose to preallocate database
vb@130
  1034
** file space based on this hint in order to help writes to the database
vb@130
  1035
** file run faster.
vb@130
  1036
**
vb@130
  1037
** <li>[[SQLITE_FCNTL_CHUNK_SIZE]]
vb@130
  1038
** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS
vb@130
  1039
** extends and truncates the database file in chunks of a size specified
vb@130
  1040
** by the user. The fourth argument to [sqlite3_file_control()] should 
vb@130
  1041
** point to an integer (type int) containing the new chunk-size to use
vb@130
  1042
** for the nominated database. Allocating database file space in large
vb@130
  1043
** chunks (say 1MB at a time), may reduce file-system fragmentation and
vb@130
  1044
** improve performance on some systems.
vb@130
  1045
**
vb@130
  1046
** <li>[[SQLITE_FCNTL_FILE_POINTER]]
vb@130
  1047
** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer
vb@130
  1048
** to the [sqlite3_file] object associated with a particular database
Edouard@491
  1049
** connection.  See also [SQLITE_FCNTL_JOURNAL_POINTER].
Edouard@491
  1050
**
Edouard@491
  1051
** <li>[[SQLITE_FCNTL_JOURNAL_POINTER]]
Edouard@491
  1052
** The [SQLITE_FCNTL_JOURNAL_POINTER] opcode is used to obtain a pointer
Edouard@491
  1053
** to the [sqlite3_file] object associated with the journal file (either
Edouard@491
  1054
** the [rollback journal] or the [write-ahead log]) for a particular database
Edouard@491
  1055
** connection.  See also [SQLITE_FCNTL_FILE_POINTER].
vb@130
  1056
**
vb@130
  1057
** <li>[[SQLITE_FCNTL_SYNC_OMITTED]]
vb@130
  1058
** No longer in use.
vb@130
  1059
**
vb@130
  1060
** <li>[[SQLITE_FCNTL_SYNC]]
vb@130
  1061
** The [SQLITE_FCNTL_SYNC] opcode is generated internally by SQLite and
vb@130
  1062
** sent to the VFS immediately before the xSync method is invoked on a
vb@130
  1063
** database file descriptor. Or, if the xSync method is not invoked 
vb@130
  1064
** because the user has configured SQLite with 
vb@130
  1065
** [PRAGMA synchronous | PRAGMA synchronous=OFF] it is invoked in place 
vb@130
  1066
** of the xSync method. In most cases, the pointer argument passed with
vb@130
  1067
** this file-control is NULL. However, if the database file is being synced
vb@130
  1068
** as part of a multi-database commit, the argument points to a nul-terminated
vb@130
  1069
** string containing the transactions master-journal file name. VFSes that 
vb@130
  1070
** do not need this signal should silently ignore this opcode. Applications 
vb@130
  1071
** should not call [sqlite3_file_control()] with this opcode as doing so may 
vb@130
  1072
** disrupt the operation of the specialized VFSes that do require it.  
vb@130
  1073
**
vb@130
  1074
** <li>[[SQLITE_FCNTL_COMMIT_PHASETWO]]
vb@130
  1075
** The [SQLITE_FCNTL_COMMIT_PHASETWO] opcode is generated internally by SQLite
vb@130
  1076
** and sent to the VFS after a transaction has been committed immediately
vb@130
  1077
** but before the database is unlocked. VFSes that do not need this signal
vb@130
  1078
** should silently ignore this opcode. Applications should not call
vb@130
  1079
** [sqlite3_file_control()] with this opcode as doing so may disrupt the 
vb@130
  1080
** operation of the specialized VFSes that do require it.  
vb@130
  1081
**
vb@130
  1082
** <li>[[SQLITE_FCNTL_WIN32_AV_RETRY]]
vb@130
  1083
** ^The [SQLITE_FCNTL_WIN32_AV_RETRY] opcode is used to configure automatic
vb@130
  1084
** retry counts and intervals for certain disk I/O operations for the
vb@130
  1085
** windows [VFS] in order to provide robustness in the presence of
vb@130
  1086
** anti-virus programs.  By default, the windows VFS will retry file read,
vb@130
  1087
** file write, and file delete operations up to 10 times, with a delay
vb@130
  1088
** of 25 milliseconds before the first retry and with the delay increasing
vb@130
  1089
** by an additional 25 milliseconds with each subsequent retry.  This
vb@130
  1090
** opcode allows these two values (10 retries and 25 milliseconds of delay)
vb@130
  1091
** to be adjusted.  The values are changed for all database connections
vb@130
  1092
** within the same process.  The argument is a pointer to an array of two
vb@130
  1093
** integers where the first integer i the new retry count and the second
vb@130
  1094
** integer is the delay.  If either integer is negative, then the setting
vb@130
  1095
** is not changed but instead the prior value of that setting is written
vb@130
  1096
** into the array entry, allowing the current retry settings to be
vb@130
  1097
** interrogated.  The zDbName parameter is ignored.
vb@130
  1098
**
vb@130
  1099
** <li>[[SQLITE_FCNTL_PERSIST_WAL]]
vb@130
  1100
** ^The [SQLITE_FCNTL_PERSIST_WAL] opcode is used to set or query the
vb@130
  1101
** persistent [WAL | Write Ahead Log] setting.  By default, the auxiliary
vb@130
  1102
** write ahead log and shared memory files used for transaction control
vb@130
  1103
** are automatically deleted when the latest connection to the database
vb@130
  1104
** closes.  Setting persistent WAL mode causes those files to persist after
vb@130
  1105
** close.  Persisting the files is useful when other processes that do not
vb@130
  1106
** have write permission on the directory containing the database file want
vb@130
  1107
** to read the database file, as the WAL and shared memory files must exist
vb@130
  1108
** in order for the database to be readable.  The fourth parameter to
vb@130
  1109
** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
vb@130
  1110
** That integer is 0 to disable persistent WAL mode or 1 to enable persistent
vb@130
  1111
** WAL mode.  If the integer is -1, then it is overwritten with the current
vb@130
  1112
** WAL persistence setting.
vb@130
  1113
**
vb@130
  1114
** <li>[[SQLITE_FCNTL_POWERSAFE_OVERWRITE]]
vb@130
  1115
** ^The [SQLITE_FCNTL_POWERSAFE_OVERWRITE] opcode is used to set or query the
vb@130
  1116
** persistent "powersafe-overwrite" or "PSOW" setting.  The PSOW setting
vb@130
  1117
** determines the [SQLITE_IOCAP_POWERSAFE_OVERWRITE] bit of the
vb@130
  1118
** xDeviceCharacteristics methods. The fourth parameter to
vb@130
  1119
** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
vb@130
  1120
** That integer is 0 to disable zero-damage mode or 1 to enable zero-damage
vb@130
  1121
** mode.  If the integer is -1, then it is overwritten with the current
vb@130
  1122
** zero-damage mode setting.
vb@130
  1123
**
vb@130
  1124
** <li>[[SQLITE_FCNTL_OVERWRITE]]
vb@130
  1125
** ^The [SQLITE_FCNTL_OVERWRITE] opcode is invoked by SQLite after opening
vb@130
  1126
** a write transaction to indicate that, unless it is rolled back for some
vb@130
  1127
** reason, the entire database file will be overwritten by the current 
vb@130
  1128
** transaction. This is used by VACUUM operations.
vb@130
  1129
**
vb@130
  1130
** <li>[[SQLITE_FCNTL_VFSNAME]]
vb@130
  1131
** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of
vb@130
  1132
** all [VFSes] in the VFS stack.  The names are of all VFS shims and the
vb@130
  1133
** final bottom-level VFS are written into memory obtained from 
vb@130
  1134
** [sqlite3_malloc()] and the result is stored in the char* variable
vb@130
  1135
** that the fourth parameter of [sqlite3_file_control()] points to.
vb@130
  1136
** The caller is responsible for freeing the memory when done.  As with
vb@130
  1137
** all file-control actions, there is no guarantee that this will actually
vb@130
  1138
** do anything.  Callers should initialize the char* variable to a NULL
vb@130
  1139
** pointer in case this file-control is not implemented.  This file-control
vb@130
  1140
** is intended for diagnostic use only.
vb@130
  1141
**
Edouard@491
  1142
** <li>[[SQLITE_FCNTL_VFS_POINTER]]
Edouard@491
  1143
** ^The [SQLITE_FCNTL_VFS_POINTER] opcode finds a pointer to the top-level
Edouard@491
  1144
** [VFSes] currently in use.  ^(The argument X in
Edouard@491
  1145
** sqlite3_file_control(db,SQLITE_FCNTL_VFS_POINTER,X) must be
Edouard@491
  1146
** of type "[sqlite3_vfs] **".  This opcodes will set *X
Edouard@491
  1147
** to a pointer to the top-level VFS.)^
Edouard@491
  1148
** ^When there are multiple VFS shims in the stack, this opcode finds the
Edouard@491
  1149
** upper-most shim only.
Edouard@491
  1150
**
vb@130
  1151
** <li>[[SQLITE_FCNTL_PRAGMA]]
vb@130
  1152
** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA] 
vb@130
  1153
** file control is sent to the open [sqlite3_file] object corresponding
vb@130
  1154
** to the database file to which the pragma statement refers. ^The argument
vb@130
  1155
** to the [SQLITE_FCNTL_PRAGMA] file control is an array of
vb@130
  1156
** pointers to strings (char**) in which the second element of the array
vb@130
  1157
** is the name of the pragma and the third element is the argument to the
vb@130
  1158
** pragma or NULL if the pragma has no argument.  ^The handler for an
vb@130
  1159
** [SQLITE_FCNTL_PRAGMA] file control can optionally make the first element
vb@130
  1160
** of the char** argument point to a string obtained from [sqlite3_mprintf()]
vb@130
  1161
** or the equivalent and that string will become the result of the pragma or
vb@130
  1162
** the error message if the pragma fails. ^If the
vb@130
  1163
** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal 
vb@130
  1164
** [PRAGMA] processing continues.  ^If the [SQLITE_FCNTL_PRAGMA]
vb@130
  1165
** file control returns [SQLITE_OK], then the parser assumes that the
vb@130
  1166
** VFS has handled the PRAGMA itself and the parser generates a no-op
Edouard@491
  1167
** prepared statement if result string is NULL, or that returns a copy
Edouard@491
  1168
** of the result string if the string is non-NULL.
Edouard@491
  1169
** ^If the [SQLITE_FCNTL_PRAGMA] file control returns
vb@130
  1170
** any result code other than [SQLITE_OK] or [SQLITE_NOTFOUND], that means
vb@130
  1171
** that the VFS encountered an error while handling the [PRAGMA] and the
vb@130
  1172
** compilation of the PRAGMA fails with an error.  ^The [SQLITE_FCNTL_PRAGMA]
vb@130
  1173
** file control occurs at the beginning of pragma statement analysis and so
vb@130
  1174
** it is able to override built-in [PRAGMA] statements.
vb@130
  1175
**
vb@130
  1176
** <li>[[SQLITE_FCNTL_BUSYHANDLER]]
vb@130
  1177
** ^The [SQLITE_FCNTL_BUSYHANDLER]
vb@130
  1178
** file-control may be invoked by SQLite on the database file handle
vb@130
  1179
** shortly after it is opened in order to provide a custom VFS with access
vb@130
  1180
** to the connections busy-handler callback. The argument is of type (void **)
vb@130
  1181
** - an array of two (void *) values. The first (void *) actually points
vb@130
  1182
** to a function of type (int (*)(void *)). In order to invoke the connections
vb@130
  1183
** busy-handler, this function should be invoked with the second (void *) in
vb@130
  1184
** the array as the only argument. If it returns non-zero, then the operation
vb@130
  1185
** should be retried. If it returns zero, the custom VFS should abandon the
vb@130
  1186
** current operation.
vb@130
  1187
**
vb@130
  1188
** <li>[[SQLITE_FCNTL_TEMPFILENAME]]
vb@130
  1189
** ^Application can invoke the [SQLITE_FCNTL_TEMPFILENAME] file-control
vb@130
  1190
** to have SQLite generate a
vb@130
  1191
** temporary filename using the same algorithm that is followed to generate
vb@130
  1192
** temporary filenames for TEMP tables and other internal uses.  The
vb@130
  1193
** argument should be a char** which will be filled with the filename
vb@130
  1194
** written into memory obtained from [sqlite3_malloc()].  The caller should
vb@130
  1195
** invoke [sqlite3_free()] on the result to avoid a memory leak.
vb@130
  1196
**
vb@130
  1197
** <li>[[SQLITE_FCNTL_MMAP_SIZE]]
vb@130
  1198
** The [SQLITE_FCNTL_MMAP_SIZE] file control is used to query or set the
vb@130
  1199
** maximum number of bytes that will be used for memory-mapped I/O.
vb@130
  1200
** The argument is a pointer to a value of type sqlite3_int64 that
vb@130
  1201
** is an advisory maximum number of bytes in the file to memory map.  The
vb@130
  1202
** pointer is overwritten with the old value.  The limit is not changed if
vb@130
  1203
** the value originally pointed to is negative, and so the current limit 
vb@130
  1204
** can be queried by passing in a pointer to a negative number.  This
vb@130
  1205
** file-control is used internally to implement [PRAGMA mmap_size].
vb@130
  1206
**
vb@130
  1207
** <li>[[SQLITE_FCNTL_TRACE]]
vb@130
  1208
** The [SQLITE_FCNTL_TRACE] file control provides advisory information
vb@130
  1209
** to the VFS about what the higher layers of the SQLite stack are doing.
vb@130
  1210
** This file control is used by some VFS activity tracing [shims].
vb@130
  1211
** The argument is a zero-terminated string.  Higher layers in the
vb@130
  1212
** SQLite stack may generate instances of this file control if
vb@130
  1213
** the [SQLITE_USE_FCNTL_TRACE] compile-time option is enabled.
vb@130
  1214
**
vb@130
  1215
** <li>[[SQLITE_FCNTL_HAS_MOVED]]
vb@130
  1216
** The [SQLITE_FCNTL_HAS_MOVED] file control interprets its argument as a
vb@130
  1217
** pointer to an integer and it writes a boolean into that integer depending
vb@130
  1218
** on whether or not the file has been renamed, moved, or deleted since it
vb@130
  1219
** was first opened.
vb@130
  1220
**
vb@130
  1221
** <li>[[SQLITE_FCNTL_WIN32_SET_HANDLE]]
vb@130
  1222
** The [SQLITE_FCNTL_WIN32_SET_HANDLE] opcode is used for debugging.  This
vb@130
  1223
** opcode causes the xFileControl method to swap the file handle with the one
vb@130
  1224
** pointed to by the pArg argument.  This capability is used during testing
vb@130
  1225
** and only needs to be supported when SQLITE_TEST is defined.
vb@130
  1226
**
Edouard@491
  1227
** <li>[[SQLITE_FCNTL_WAL_BLOCK]]
Edouard@491
  1228
** The [SQLITE_FCNTL_WAL_BLOCK] is a signal to the VFS layer that it might
Edouard@491
  1229
** be advantageous to block on the next WAL lock if the lock is not immediately
Edouard@491
  1230
** available.  The WAL subsystem issues this signal during rare
Edouard@491
  1231
** circumstances in order to fix a problem with priority inversion.
Edouard@491
  1232
** Applications should <em>not</em> use this file-control.
Edouard@491
  1233
**
Edouard@491
  1234
** <li>[[SQLITE_FCNTL_ZIPVFS]]
Edouard@491
  1235
** The [SQLITE_FCNTL_ZIPVFS] opcode is implemented by zipvfs only. All other
Edouard@491
  1236
** VFS should return SQLITE_NOTFOUND for this opcode.
Edouard@491
  1237
**
Edouard@491
  1238
** <li>[[SQLITE_FCNTL_RBU]]
Edouard@491
  1239
** The [SQLITE_FCNTL_RBU] opcode is implemented by the special VFS used by
Edouard@491
  1240
** the RBU extension only.  All other VFS should return SQLITE_NOTFOUND for
Edouard@491
  1241
** this opcode.  
vb@130
  1242
** </ul>
vb@130
  1243
*/
vb@130
  1244
#define SQLITE_FCNTL_LOCKSTATE               1
Edouard@491
  1245
#define SQLITE_FCNTL_GET_LOCKPROXYFILE       2
Edouard@491
  1246
#define SQLITE_FCNTL_SET_LOCKPROXYFILE       3
Edouard@491
  1247
#define SQLITE_FCNTL_LAST_ERRNO              4
vb@130
  1248
#define SQLITE_FCNTL_SIZE_HINT               5
vb@130
  1249
#define SQLITE_FCNTL_CHUNK_SIZE              6
vb@130
  1250
#define SQLITE_FCNTL_FILE_POINTER            7
vb@130
  1251
#define SQLITE_FCNTL_SYNC_OMITTED            8
vb@130
  1252
#define SQLITE_FCNTL_WIN32_AV_RETRY          9
vb@130
  1253
#define SQLITE_FCNTL_PERSIST_WAL            10
vb@130
  1254
#define SQLITE_FCNTL_OVERWRITE              11
vb@130
  1255
#define SQLITE_FCNTL_VFSNAME                12
vb@130
  1256
#define SQLITE_FCNTL_POWERSAFE_OVERWRITE    13
vb@130
  1257
#define SQLITE_FCNTL_PRAGMA                 14
vb@130
  1258
#define SQLITE_FCNTL_BUSYHANDLER            15
vb@130
  1259
#define SQLITE_FCNTL_TEMPFILENAME           16
vb@130
  1260
#define SQLITE_FCNTL_MMAP_SIZE              18
vb@130
  1261
#define SQLITE_FCNTL_TRACE                  19
vb@130
  1262
#define SQLITE_FCNTL_HAS_MOVED              20
vb@130
  1263
#define SQLITE_FCNTL_SYNC                   21
vb@130
  1264
#define SQLITE_FCNTL_COMMIT_PHASETWO        22
vb@130
  1265
#define SQLITE_FCNTL_WIN32_SET_HANDLE       23
Edouard@491
  1266
#define SQLITE_FCNTL_WAL_BLOCK              24
Edouard@491
  1267
#define SQLITE_FCNTL_ZIPVFS                 25
Edouard@491
  1268
#define SQLITE_FCNTL_RBU                    26
Edouard@491
  1269
#define SQLITE_FCNTL_VFS_POINTER            27
Edouard@491
  1270
#define SQLITE_FCNTL_JOURNAL_POINTER        28
Edouard@491
  1271
Edouard@491
  1272
/* deprecated names */
Edouard@491
  1273
#define SQLITE_GET_LOCKPROXYFILE      SQLITE_FCNTL_GET_LOCKPROXYFILE
Edouard@491
  1274
#define SQLITE_SET_LOCKPROXYFILE      SQLITE_FCNTL_SET_LOCKPROXYFILE
Edouard@491
  1275
#define SQLITE_LAST_ERRNO             SQLITE_FCNTL_LAST_ERRNO
Edouard@491
  1276
vb@130
  1277
vb@130
  1278
/*
vb@130
  1279
** CAPI3REF: Mutex Handle
vb@130
  1280
**
vb@130
  1281
** The mutex module within SQLite defines [sqlite3_mutex] to be an
vb@130
  1282
** abstract type for a mutex object.  The SQLite core never looks
vb@130
  1283
** at the internal representation of an [sqlite3_mutex].  It only
vb@130
  1284
** deals with pointers to the [sqlite3_mutex] object.
vb@130
  1285
**
vb@130
  1286
** Mutexes are created using [sqlite3_mutex_alloc()].
vb@130
  1287
*/
vb@130
  1288
typedef struct sqlite3_mutex sqlite3_mutex;
vb@130
  1289
vb@130
  1290
/*
vb@130
  1291
** CAPI3REF: OS Interface Object
vb@130
  1292
**
vb@130
  1293
** An instance of the sqlite3_vfs object defines the interface between
vb@130
  1294
** the SQLite core and the underlying operating system.  The "vfs"
vb@130
  1295
** in the name of the object stands for "virtual file system".  See
vb@130
  1296
** the [VFS | VFS documentation] for further information.
vb@130
  1297
**
vb@130
  1298
** The value of the iVersion field is initially 1 but may be larger in
vb@130
  1299
** future versions of SQLite.  Additional fields may be appended to this
vb@130
  1300
** object when the iVersion value is increased.  Note that the structure
vb@130
  1301
** of the sqlite3_vfs object changes in the transaction between
vb@130
  1302
** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not
vb@130
  1303
** modified.
vb@130
  1304
**
vb@130
  1305
** The szOsFile field is the size of the subclassed [sqlite3_file]
vb@130
  1306
** structure used by this VFS.  mxPathname is the maximum length of
vb@130
  1307
** a pathname in this VFS.
vb@130
  1308
**
vb@130
  1309
** Registered sqlite3_vfs objects are kept on a linked list formed by
vb@130
  1310
** the pNext pointer.  The [sqlite3_vfs_register()]
vb@130
  1311
** and [sqlite3_vfs_unregister()] interfaces manage this list
vb@130
  1312
** in a thread-safe way.  The [sqlite3_vfs_find()] interface
vb@130
  1313
** searches the list.  Neither the application code nor the VFS
vb@130
  1314
** implementation should use the pNext pointer.
vb@130
  1315
**
vb@130
  1316
** The pNext field is the only field in the sqlite3_vfs
vb@130
  1317
** structure that SQLite will ever modify.  SQLite will only access
vb@130
  1318
** or modify this field while holding a particular static mutex.
vb@130
  1319
** The application should never modify anything within the sqlite3_vfs
vb@130
  1320
** object once the object has been registered.
vb@130
  1321
**
vb@130
  1322
** The zName field holds the name of the VFS module.  The name must
vb@130
  1323
** be unique across all VFS modules.
vb@130
  1324
**
vb@130
  1325
** [[sqlite3_vfs.xOpen]]
vb@130
  1326
** ^SQLite guarantees that the zFilename parameter to xOpen
vb@130
  1327
** is either a NULL pointer or string obtained
vb@130
  1328
** from xFullPathname() with an optional suffix added.
vb@130
  1329
** ^If a suffix is added to the zFilename parameter, it will
vb@130
  1330
** consist of a single "-" character followed by no more than
vb@130
  1331
** 11 alphanumeric and/or "-" characters.
vb@130
  1332
** ^SQLite further guarantees that
vb@130
  1333
** the string will be valid and unchanged until xClose() is
vb@130
  1334
** called. Because of the previous sentence,
vb@130
  1335
** the [sqlite3_file] can safely store a pointer to the
vb@130
  1336
** filename if it needs to remember the filename for some reason.
vb@130
  1337
** If the zFilename parameter to xOpen is a NULL pointer then xOpen
vb@130
  1338
** must invent its own temporary name for the file.  ^Whenever the 
vb@130
  1339
** xFilename parameter is NULL it will also be the case that the
vb@130
  1340
** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE].
vb@130
  1341
**
vb@130
  1342
** The flags argument to xOpen() includes all bits set in
vb@130
  1343
** the flags argument to [sqlite3_open_v2()].  Or if [sqlite3_open()]
vb@130
  1344
** or [sqlite3_open16()] is used, then flags includes at least
vb@130
  1345
** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. 
vb@130
  1346
** If xOpen() opens a file read-only then it sets *pOutFlags to
vb@130
  1347
** include [SQLITE_OPEN_READONLY].  Other bits in *pOutFlags may be set.
vb@130
  1348
**
vb@130
  1349
** ^(SQLite will also add one of the following flags to the xOpen()
vb@130
  1350
** call, depending on the object being opened:
vb@130
  1351
**
vb@130
  1352
** <ul>
vb@130
  1353
** <li>  [SQLITE_OPEN_MAIN_DB]
vb@130
  1354
** <li>  [SQLITE_OPEN_MAIN_JOURNAL]
vb@130
  1355
** <li>  [SQLITE_OPEN_TEMP_DB]
vb@130
  1356
** <li>  [SQLITE_OPEN_TEMP_JOURNAL]
vb@130
  1357
** <li>  [SQLITE_OPEN_TRANSIENT_DB]
vb@130
  1358
** <li>  [SQLITE_OPEN_SUBJOURNAL]
vb@130
  1359
** <li>  [SQLITE_OPEN_MASTER_JOURNAL]
vb@130
  1360
** <li>  [SQLITE_OPEN_WAL]
vb@130
  1361
** </ul>)^
vb@130
  1362
**
vb@130
  1363
** The file I/O implementation can use the object type flags to
vb@130
  1364
** change the way it deals with files.  For example, an application
vb@130
  1365
** that does not care about crash recovery or rollback might make
vb@130
  1366
** the open of a journal file a no-op.  Writes to this journal would
vb@130
  1367
** also be no-ops, and any attempt to read the journal would return
vb@130
  1368
** SQLITE_IOERR.  Or the implementation might recognize that a database
vb@130
  1369
** file will be doing page-aligned sector reads and writes in a random
vb@130
  1370
** order and set up its I/O subsystem accordingly.
vb@130
  1371
**
vb@130
  1372
** SQLite might also add one of the following flags to the xOpen method:
vb@130
  1373
**
vb@130
  1374
** <ul>
vb@130
  1375
** <li> [SQLITE_OPEN_DELETEONCLOSE]
vb@130
  1376
** <li> [SQLITE_OPEN_EXCLUSIVE]
vb@130
  1377
** </ul>
vb@130
  1378
**
vb@130
  1379
** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be
vb@130
  1380
** deleted when it is closed.  ^The [SQLITE_OPEN_DELETEONCLOSE]
vb@130
  1381
** will be set for TEMP databases and their journals, transient
vb@130
  1382
** databases, and subjournals.
vb@130
  1383
**
vb@130
  1384
** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction
vb@130
  1385
** with the [SQLITE_OPEN_CREATE] flag, which are both directly
vb@130
  1386
** analogous to the O_EXCL and O_CREAT flags of the POSIX open()
vb@130
  1387
** API.  The SQLITE_OPEN_EXCLUSIVE flag, when paired with the 
vb@130
  1388
** SQLITE_OPEN_CREATE, is used to indicate that file should always
vb@130
  1389
** be created, and that it is an error if it already exists.
vb@130
  1390
** It is <i>not</i> used to indicate the file should be opened 
vb@130
  1391
** for exclusive access.
vb@130
  1392
**
vb@130
  1393
** ^At least szOsFile bytes of memory are allocated by SQLite
vb@130
  1394
** to hold the  [sqlite3_file] structure passed as the third
vb@130
  1395
** argument to xOpen.  The xOpen method does not have to
vb@130
  1396
** allocate the structure; it should just fill it in.  Note that
vb@130
  1397
** the xOpen method must set the sqlite3_file.pMethods to either
vb@130
  1398
** a valid [sqlite3_io_methods] object or to NULL.  xOpen must do
vb@130
  1399
** this even if the open fails.  SQLite expects that the sqlite3_file.pMethods
vb@130
  1400
** element will be valid after xOpen returns regardless of the success
vb@130
  1401
** or failure of the xOpen call.
vb@130
  1402
**
vb@130
  1403
** [[sqlite3_vfs.xAccess]]
vb@130
  1404
** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS]
vb@130
  1405
** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to
vb@130
  1406
** test whether a file is readable and writable, or [SQLITE_ACCESS_READ]
vb@130
  1407
** to test whether a file is at least readable.   The file can be a
vb@130
  1408
** directory.
vb@130
  1409
**
vb@130
  1410
** ^SQLite will always allocate at least mxPathname+1 bytes for the
vb@130
  1411
** output buffer xFullPathname.  The exact size of the output buffer
vb@130
  1412
** is also passed as a parameter to both  methods. If the output buffer
vb@130
  1413
** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is
vb@130
  1414
** handled as a fatal error by SQLite, vfs implementations should endeavor
vb@130
  1415
** to prevent this by setting mxPathname to a sufficiently large value.
vb@130
  1416
**
vb@130
  1417
** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64()
vb@130
  1418
** interfaces are not strictly a part of the filesystem, but they are
vb@130
  1419
** included in the VFS structure for completeness.
vb@130
  1420
** The xRandomness() function attempts to return nBytes bytes
vb@130
  1421
** of good-quality randomness into zOut.  The return value is
vb@130
  1422
** the actual number of bytes of randomness obtained.
vb@130
  1423
** The xSleep() method causes the calling thread to sleep for at
vb@130
  1424
** least the number of microseconds given.  ^The xCurrentTime()
vb@130
  1425
** method returns a Julian Day Number for the current date and time as
vb@130
  1426
** a floating point value.
vb@130
  1427
** ^The xCurrentTimeInt64() method returns, as an integer, the Julian
vb@130
  1428
** Day Number multiplied by 86400000 (the number of milliseconds in 
vb@130
  1429
** a 24-hour day).  
vb@130
  1430
** ^SQLite will use the xCurrentTimeInt64() method to get the current
vb@130
  1431
** date and time if that method is available (if iVersion is 2 or 
vb@130
  1432
** greater and the function pointer is not NULL) and will fall back
vb@130
  1433
** to xCurrentTime() if xCurrentTimeInt64() is unavailable.
vb@130
  1434
**
vb@130
  1435
** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces
vb@130
  1436
** are not used by the SQLite core.  These optional interfaces are provided
vb@130
  1437
** by some VFSes to facilitate testing of the VFS code. By overriding 
vb@130
  1438
** system calls with functions under its control, a test program can
vb@130
  1439
** simulate faults and error conditions that would otherwise be difficult
vb@130
  1440
** or impossible to induce.  The set of system calls that can be overridden
vb@130
  1441
** varies from one VFS to another, and from one version of the same VFS to the
vb@130
  1442
** next.  Applications that use these interfaces must be prepared for any
vb@130
  1443
** or all of these interfaces to be NULL or for their behavior to change
vb@130
  1444
** from one release to the next.  Applications must not attempt to access
vb@130
  1445
** any of these methods if the iVersion of the VFS is less than 3.
vb@130
  1446
*/
vb@130
  1447
typedef struct sqlite3_vfs sqlite3_vfs;
vb@130
  1448
typedef void (*sqlite3_syscall_ptr)(void);
vb@130
  1449
struct sqlite3_vfs {
vb@130
  1450
  int iVersion;            /* Structure version number (currently 3) */
vb@130
  1451
  int szOsFile;            /* Size of subclassed sqlite3_file */
vb@130
  1452
  int mxPathname;          /* Maximum file pathname length */
vb@130
  1453
  sqlite3_vfs *pNext;      /* Next registered VFS */
vb@130
  1454
  const char *zName;       /* Name of this virtual file system */
vb@130
  1455
  void *pAppData;          /* Pointer to application-specific data */
vb@130
  1456
  int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*,
vb@130
  1457
               int flags, int *pOutFlags);
vb@130
  1458
  int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir);
vb@130
  1459
  int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut);
vb@130
  1460
  int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut);
vb@130
  1461
  void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename);
vb@130
  1462
  void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg);
vb@130
  1463
  void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void);
vb@130
  1464
  void (*xDlClose)(sqlite3_vfs*, void*);
vb@130
  1465
  int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut);
vb@130
  1466
  int (*xSleep)(sqlite3_vfs*, int microseconds);
vb@130
  1467
  int (*xCurrentTime)(sqlite3_vfs*, double*);
vb@130
  1468
  int (*xGetLastError)(sqlite3_vfs*, int, char *);
vb@130
  1469
  /*
vb@130
  1470
  ** The methods above are in version 1 of the sqlite_vfs object
vb@130
  1471
  ** definition.  Those that follow are added in version 2 or later
vb@130
  1472
  */
vb@130
  1473
  int (*xCurrentTimeInt64)(sqlite3_vfs*, sqlite3_int64*);
vb@130
  1474
  /*
vb@130
  1475
  ** The methods above are in versions 1 and 2 of the sqlite_vfs object.
vb@130
  1476
  ** Those below are for version 3 and greater.
vb@130
  1477
  */
vb@130
  1478
  int (*xSetSystemCall)(sqlite3_vfs*, const char *zName, sqlite3_syscall_ptr);
vb@130
  1479
  sqlite3_syscall_ptr (*xGetSystemCall)(sqlite3_vfs*, const char *zName);
vb@130
  1480
  const char *(*xNextSystemCall)(sqlite3_vfs*, const char *zName);
vb@130
  1481
  /*
vb@130
  1482
  ** The methods above are in versions 1 through 3 of the sqlite_vfs object.
vb@716
  1483
  ** New fields may be appended in future versions.  The iVersion
vb@130
  1484
  ** value will increment whenever this happens. 
vb@130
  1485
  */
vb@130
  1486
};
vb@130
  1487
vb@130
  1488
/*
vb@130
  1489
** CAPI3REF: Flags for the xAccess VFS method
vb@130
  1490
**
vb@130
  1491
** These integer constants can be used as the third parameter to
vb@130
  1492
** the xAccess method of an [sqlite3_vfs] object.  They determine
vb@130
  1493
** what kind of permissions the xAccess method is looking for.
vb@130
  1494
** With SQLITE_ACCESS_EXISTS, the xAccess method
vb@130
  1495
** simply checks whether the file exists.
vb@130
  1496
** With SQLITE_ACCESS_READWRITE, the xAccess method
vb@130
  1497
** checks whether the named directory is both readable and writable
vb@130
  1498
** (in other words, if files can be added, removed, and renamed within
vb@130
  1499
** the directory).
vb@130
  1500
** The SQLITE_ACCESS_READWRITE constant is currently used only by the
vb@130
  1501
** [temp_store_directory pragma], though this could change in a future
vb@130
  1502
** release of SQLite.
vb@130
  1503
** With SQLITE_ACCESS_READ, the xAccess method
vb@130
  1504
** checks whether the file is readable.  The SQLITE_ACCESS_READ constant is
vb@130
  1505
** currently unused, though it might be used in a future release of
vb@130
  1506
** SQLite.
vb@130
  1507
*/
vb@130
  1508
#define SQLITE_ACCESS_EXISTS    0
vb@130
  1509
#define SQLITE_ACCESS_READWRITE 1   /* Used by PRAGMA temp_store_directory */
vb@130
  1510
#define SQLITE_ACCESS_READ      2   /* Unused */
vb@130
  1511
vb@130
  1512
/*
vb@130
  1513
** CAPI3REF: Flags for the xShmLock VFS method
vb@130
  1514
**
vb@130
  1515
** These integer constants define the various locking operations
vb@130
  1516
** allowed by the xShmLock method of [sqlite3_io_methods].  The
vb@130
  1517
** following are the only legal combinations of flags to the
vb@130
  1518
** xShmLock method:
vb@130
  1519
**
vb@130
  1520
** <ul>
vb@130
  1521
** <li>  SQLITE_SHM_LOCK | SQLITE_SHM_SHARED
vb@130
  1522
** <li>  SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE
vb@130
  1523
** <li>  SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED
vb@130
  1524
** <li>  SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE
vb@130
  1525
** </ul>
vb@130
  1526
**
vb@130
  1527
** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as
Edouard@491
  1528
** was given on the corresponding lock.  
vb@130
  1529
**
vb@130
  1530
** The xShmLock method can transition between unlocked and SHARED or
vb@130
  1531
** between unlocked and EXCLUSIVE.  It cannot transition between SHARED
vb@130
  1532
** and EXCLUSIVE.
vb@130
  1533
*/
vb@130
  1534
#define SQLITE_SHM_UNLOCK       1
vb@130
  1535
#define SQLITE_SHM_LOCK         2
vb@130
  1536
#define SQLITE_SHM_SHARED       4
vb@130
  1537
#define SQLITE_SHM_EXCLUSIVE    8
vb@130
  1538
vb@130
  1539
/*
vb@130
  1540
** CAPI3REF: Maximum xShmLock index
vb@130
  1541
**
vb@130
  1542
** The xShmLock method on [sqlite3_io_methods] may use values
vb@130
  1543
** between 0 and this upper bound as its "offset" argument.
vb@130
  1544
** The SQLite core will never attempt to acquire or release a
vb@130
  1545
** lock outside of this range
vb@130
  1546
*/
vb@130
  1547
#define SQLITE_SHM_NLOCK        8
vb@130
  1548
vb@130
  1549
vb@130
  1550
/*
vb@130
  1551
** CAPI3REF: Initialize The SQLite Library
vb@130
  1552
**
vb@130
  1553
** ^The sqlite3_initialize() routine initializes the
vb@130
  1554
** SQLite library.  ^The sqlite3_shutdown() routine
vb@130
  1555
** deallocates any resources that were allocated by sqlite3_initialize().
vb@130
  1556
** These routines are designed to aid in process initialization and
vb@130
  1557
** shutdown on embedded systems.  Workstation applications using
vb@130
  1558
** SQLite normally do not need to invoke either of these routines.
vb@130
  1559
**
vb@130
  1560
** A call to sqlite3_initialize() is an "effective" call if it is
vb@130
  1561
** the first time sqlite3_initialize() is invoked during the lifetime of
vb@130
  1562
** the process, or if it is the first time sqlite3_initialize() is invoked
vb@130
  1563
** following a call to sqlite3_shutdown().  ^(Only an effective call
vb@130
  1564
** of sqlite3_initialize() does any initialization.  All other calls
vb@130
  1565
** are harmless no-ops.)^
vb@130
  1566
**
vb@130
  1567
** A call to sqlite3_shutdown() is an "effective" call if it is the first
vb@130
  1568
** call to sqlite3_shutdown() since the last sqlite3_initialize().  ^(Only
vb@130
  1569
** an effective call to sqlite3_shutdown() does any deinitialization.
vb@130
  1570
** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^
vb@130
  1571
**
vb@130
  1572
** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown()
vb@130
  1573
** is not.  The sqlite3_shutdown() interface must only be called from a
vb@130
  1574
** single thread.  All open [database connections] must be closed and all
vb@130
  1575
** other SQLite resources must be deallocated prior to invoking
vb@130
  1576
** sqlite3_shutdown().
vb@130
  1577
**
vb@130
  1578
** Among other things, ^sqlite3_initialize() will invoke
vb@130
  1579
** sqlite3_os_init().  Similarly, ^sqlite3_shutdown()
vb@130
  1580
** will invoke sqlite3_os_end().
vb@130
  1581
**
vb@130
  1582
** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success.
vb@130
  1583
** ^If for some reason, sqlite3_initialize() is unable to initialize
vb@130
  1584
** the library (perhaps it is unable to allocate a needed resource such
vb@130
  1585
** as a mutex) it returns an [error code] other than [SQLITE_OK].
vb@130
  1586
**
vb@130
  1587
** ^The sqlite3_initialize() routine is called internally by many other
vb@130
  1588
** SQLite interfaces so that an application usually does not need to
vb@130
  1589
** invoke sqlite3_initialize() directly.  For example, [sqlite3_open()]
vb@130
  1590
** calls sqlite3_initialize() so the SQLite library will be automatically
vb@130
  1591
** initialized when [sqlite3_open()] is called if it has not be initialized
vb@130
  1592
** already.  ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT]
vb@130
  1593
** compile-time option, then the automatic calls to sqlite3_initialize()
vb@130
  1594
** are omitted and the application must call sqlite3_initialize() directly
vb@130
  1595
** prior to using any other SQLite interface.  For maximum portability,
vb@130
  1596
** it is recommended that applications always invoke sqlite3_initialize()
vb@130
  1597
** directly prior to using any other SQLite interface.  Future releases
vb@130
  1598
** of SQLite may require this.  In other words, the behavior exhibited
vb@130
  1599
** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the
vb@130
  1600
** default behavior in some future release of SQLite.
vb@130
  1601
**
vb@130
  1602
** The sqlite3_os_init() routine does operating-system specific
vb@130
  1603
** initialization of the SQLite library.  The sqlite3_os_end()
vb@130
  1604
** routine undoes the effect of sqlite3_os_init().  Typical tasks
vb@130
  1605
** performed by these routines include allocation or deallocation
vb@130
  1606
** of static resources, initialization of global variables,
vb@130
  1607
** setting up a default [sqlite3_vfs] module, or setting up
vb@130
  1608
** a default configuration using [sqlite3_config()].
vb@130
  1609
**
vb@130
  1610
** The application should never invoke either sqlite3_os_init()
vb@130
  1611
** or sqlite3_os_end() directly.  The application should only invoke
vb@130
  1612
** sqlite3_initialize() and sqlite3_shutdown().  The sqlite3_os_init()
vb@130
  1613
** interface is called automatically by sqlite3_initialize() and
vb@130
  1614
** sqlite3_os_end() is called by sqlite3_shutdown().  Appropriate
vb@130
  1615
** implementations for sqlite3_os_init() and sqlite3_os_end()
vb@130
  1616
** are built into SQLite when it is compiled for Unix, Windows, or OS/2.
vb@130
  1617
** When [custom builds | built for other platforms]
vb@130
  1618
** (using the [SQLITE_OS_OTHER=1] compile-time
vb@130
  1619
** option) the application must supply a suitable implementation for
vb@130
  1620
** sqlite3_os_init() and sqlite3_os_end().  An application-supplied
vb@130
  1621
** implementation of sqlite3_os_init() or sqlite3_os_end()
vb@130
  1622
** must return [SQLITE_OK] on success and some other [error code] upon
vb@130
  1623
** failure.
vb@130
  1624
*/
Edouard@491
  1625
SQLITE_API int SQLITE_STDCALL sqlite3_initialize(void);
Edouard@491
  1626
SQLITE_API int SQLITE_STDCALL sqlite3_shutdown(void);
Edouard@491
  1627
SQLITE_API int SQLITE_STDCALL sqlite3_os_init(void);
Edouard@491
  1628
SQLITE_API int SQLITE_STDCALL sqlite3_os_end(void);
vb@130
  1629
vb@130
  1630
/*
vb@130
  1631
** CAPI3REF: Configuring The SQLite Library
vb@130
  1632
**
vb@130
  1633
** The sqlite3_config() interface is used to make global configuration
vb@130
  1634
** changes to SQLite in order to tune SQLite to the specific needs of
vb@130
  1635
** the application.  The default configuration is recommended for most
vb@130
  1636
** applications and so this routine is usually not necessary.  It is
vb@130
  1637
** provided to support rare applications with unusual needs.
vb@130
  1638
**
Edouard@491
  1639
** <b>The sqlite3_config() interface is not threadsafe. The application
Edouard@491
  1640
** must ensure that no other SQLite interfaces are invoked by other
Edouard@491
  1641
** threads while sqlite3_config() is running.</b>
Edouard@491
  1642
**
Edouard@491
  1643
** The sqlite3_config() interface
vb@130
  1644
** may only be invoked prior to library initialization using
vb@130
  1645
** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()].
vb@130
  1646
** ^If sqlite3_config() is called after [sqlite3_initialize()] and before
vb@130
  1647
** [sqlite3_shutdown()] then it will return SQLITE_MISUSE.
vb@130
  1648
** Note, however, that ^sqlite3_config() can be called as part of the
vb@130
  1649
** implementation of an application-defined [sqlite3_os_init()].
vb@130
  1650
**
vb@130
  1651
** The first argument to sqlite3_config() is an integer
vb@130
  1652
** [configuration option] that determines
vb@130
  1653
** what property of SQLite is to be configured.  Subsequent arguments
vb@130
  1654
** vary depending on the [configuration option]
vb@130
  1655
** in the first argument.
vb@130
  1656
**
vb@130
  1657
** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK].
vb@130
  1658
** ^If the option is unknown or SQLite is unable to set the option
vb@130
  1659
** then this routine returns a non-zero [error code].
vb@130
  1660
*/
Edouard@491
  1661
SQLITE_API int SQLITE_CDECL sqlite3_config(int, ...);
vb@130
  1662
vb@130
  1663
/*
vb@130
  1664
** CAPI3REF: Configure database connections
Edouard@491
  1665
** METHOD: sqlite3
vb@130
  1666
**
vb@130
  1667
** The sqlite3_db_config() interface is used to make configuration
vb@130
  1668
** changes to a [database connection].  The interface is similar to
vb@130
  1669
** [sqlite3_config()] except that the changes apply to a single
vb@130
  1670
** [database connection] (specified in the first argument).
vb@130
  1671
**
vb@130
  1672
** The second argument to sqlite3_db_config(D,V,...)  is the
vb@130
  1673
** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code 
vb@130
  1674
** that indicates what aspect of the [database connection] is being configured.
vb@130
  1675
** Subsequent arguments vary depending on the configuration verb.
vb@130
  1676
**
vb@130
  1677
** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if
vb@130
  1678
** the call is considered successful.
vb@130
  1679
*/
Edouard@491
  1680
SQLITE_API int SQLITE_CDECL sqlite3_db_config(sqlite3*, int op, ...);
vb@130
  1681
vb@130
  1682
/*
vb@130
  1683
** CAPI3REF: Memory Allocation Routines
vb@130
  1684
**
vb@130
  1685
** An instance of this object defines the interface between SQLite
vb@130
  1686
** and low-level memory allocation routines.
vb@130
  1687
**
vb@130
  1688
** This object is used in only one place in the SQLite interface.
vb@130
  1689
** A pointer to an instance of this object is the argument to
vb@130
  1690
** [sqlite3_config()] when the configuration option is
vb@130
  1691
** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC].  
vb@130
  1692
** By creating an instance of this object
vb@130
  1693
** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC])
vb@130
  1694
** during configuration, an application can specify an alternative
vb@130
  1695
** memory allocation subsystem for SQLite to use for all of its
vb@130
  1696
** dynamic memory needs.
vb@130
  1697
**
vb@130
  1698
** Note that SQLite comes with several [built-in memory allocators]
vb@130
  1699
** that are perfectly adequate for the overwhelming majority of applications
vb@130
  1700
** and that this object is only useful to a tiny minority of applications
vb@130
  1701
** with specialized memory allocation requirements.  This object is
vb@130
  1702
** also used during testing of SQLite in order to specify an alternative
vb@130
  1703
** memory allocator that simulates memory out-of-memory conditions in
vb@130
  1704
** order to verify that SQLite recovers gracefully from such
vb@130
  1705
** conditions.
vb@130
  1706
**
vb@130
  1707
** The xMalloc, xRealloc, and xFree methods must work like the
vb@130
  1708
** malloc(), realloc() and free() functions from the standard C library.
vb@130
  1709
** ^SQLite guarantees that the second argument to
vb@130
  1710
** xRealloc is always a value returned by a prior call to xRoundup.
vb@130
  1711
**
vb@130
  1712
** xSize should return the allocated size of a memory allocation
vb@130
  1713
** previously obtained from xMalloc or xRealloc.  The allocated size
vb@130
  1714
** is always at least as big as the requested size but may be larger.
vb@130
  1715
**
vb@130
  1716
** The xRoundup method returns what would be the allocated size of
vb@130
  1717
** a memory allocation given a particular requested size.  Most memory
vb@130
  1718
** allocators round up memory allocations at least to the next multiple
vb@130
  1719
** of 8.  Some allocators round up to a larger multiple or to a power of 2.
vb@130
  1720
** Every memory allocation request coming in through [sqlite3_malloc()]
vb@130
  1721
** or [sqlite3_realloc()] first calls xRoundup.  If xRoundup returns 0, 
vb@130
  1722
** that causes the corresponding memory allocation to fail.
vb@130
  1723
**
vb@130
  1724
** The xInit method initializes the memory allocator.  For example,
vb@130
  1725
** it might allocate any require mutexes or initialize internal data
vb@130
  1726
** structures.  The xShutdown method is invoked (indirectly) by
vb@130
  1727
** [sqlite3_shutdown()] and should deallocate any resources acquired
vb@130
  1728
** by xInit.  The pAppData pointer is used as the only parameter to
vb@130
  1729
** xInit and xShutdown.
vb@130
  1730
**
vb@130
  1731
** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes
vb@130
  1732
** the xInit method, so the xInit method need not be threadsafe.  The
vb@130
  1733
** xShutdown method is only called from [sqlite3_shutdown()] so it does
vb@130
  1734
** not need to be threadsafe either.  For all other methods, SQLite
vb@130
  1735
** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the
vb@130
  1736
** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which
vb@130
  1737
** it is by default) and so the methods are automatically serialized.
vb@130
  1738
** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other
vb@130
  1739
** methods must be threadsafe or else make their own arrangements for
vb@130
  1740
** serialization.
vb@130
  1741
**
vb@130
  1742
** SQLite will never invoke xInit() more than once without an intervening
vb@130
  1743
** call to xShutdown().
vb@130
  1744
*/
vb@130
  1745
typedef struct sqlite3_mem_methods sqlite3_mem_methods;
vb@130
  1746
struct sqlite3_mem_methods {
vb@130
  1747
  void *(*xMalloc)(int);         /* Memory allocation function */
vb@130
  1748
  void (*xFree)(void*);          /* Free a prior allocation */
vb@130
  1749
  void *(*xRealloc)(void*,int);  /* Resize an allocation */
vb@130
  1750
  int (*xSize)(void*);           /* Return the size of an allocation */
vb@130
  1751
  int (*xRoundup)(int);          /* Round up request size to allocation size */
vb@130
  1752
  int (*xInit)(void*);           /* Initialize the memory allocator */
vb@130
  1753
  void (*xShutdown)(void*);      /* Deinitialize the memory allocator */
vb@130
  1754
  void *pAppData;                /* Argument to xInit() and xShutdown() */
vb@130
  1755
};
vb@130
  1756
vb@130
  1757
/*
vb@130
  1758
** CAPI3REF: Configuration Options
vb@130
  1759
** KEYWORDS: {configuration option}
vb@130
  1760
**
vb@130
  1761
** These constants are the available integer configuration options that
vb@130
  1762
** can be passed as the first argument to the [sqlite3_config()] interface.
vb@130
  1763
**
vb@130
  1764
** New configuration options may be added in future releases of SQLite.
vb@130
  1765
** Existing configuration options might be discontinued.  Applications
vb@130
  1766
** should check the return code from [sqlite3_config()] to make sure that
vb@130
  1767
** the call worked.  The [sqlite3_config()] interface will return a
vb@130
  1768
** non-zero [error code] if a discontinued or unsupported configuration option
vb@130
  1769
** is invoked.
vb@130
  1770
**
vb@130
  1771
** <dl>
vb@130
  1772
** [[SQLITE_CONFIG_SINGLETHREAD]] <dt>SQLITE_CONFIG_SINGLETHREAD</dt>
vb@130
  1773
** <dd>There are no arguments to this option.  ^This option sets the
vb@130
  1774
** [threading mode] to Single-thread.  In other words, it disables
vb@130
  1775
** all mutexing and puts SQLite into a mode where it can only be used
vb@130
  1776
** by a single thread.   ^If SQLite is compiled with
vb@130
  1777
** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
vb@130
  1778
** it is not possible to change the [threading mode] from its default
vb@130
  1779
** value of Single-thread and so [sqlite3_config()] will return 
vb@130
  1780
** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD
vb@130
  1781
** configuration option.</dd>
vb@130
  1782
**
vb@130
  1783
** [[SQLITE_CONFIG_MULTITHREAD]] <dt>SQLITE_CONFIG_MULTITHREAD</dt>
vb@130
  1784
** <dd>There are no arguments to this option.  ^This option sets the
vb@130
  1785
** [threading mode] to Multi-thread.  In other words, it disables
vb@130
  1786
** mutexing on [database connection] and [prepared statement] objects.
vb@130
  1787
** The application is responsible for serializing access to
vb@130
  1788
** [database connections] and [prepared statements].  But other mutexes
vb@130
  1789
** are enabled so that SQLite will be safe to use in a multi-threaded
vb@130
  1790
** environment as long as no two threads attempt to use the same
vb@130
  1791
** [database connection] at the same time.  ^If SQLite is compiled with
vb@130
  1792
** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
vb@130
  1793
** it is not possible to set the Multi-thread [threading mode] and
vb@130
  1794
** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
vb@130
  1795
** SQLITE_CONFIG_MULTITHREAD configuration option.</dd>
vb@130
  1796
**
vb@130
  1797
** [[SQLITE_CONFIG_SERIALIZED]] <dt>SQLITE_CONFIG_SERIALIZED</dt>
vb@130
  1798
** <dd>There are no arguments to this option.  ^This option sets the
vb@130
  1799
** [threading mode] to Serialized. In other words, this option enables
vb@130
  1800
** all mutexes including the recursive
vb@130
  1801
** mutexes on [database connection] and [prepared statement] objects.
vb@130
  1802
** In this mode (which is the default when SQLite is compiled with
vb@130
  1803
** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access
vb@130
  1804
** to [database connections] and [prepared statements] so that the
vb@130
  1805
** application is free to use the same [database connection] or the
vb@130
  1806
** same [prepared statement] in different threads at the same time.
vb@130
  1807
** ^If SQLite is compiled with
vb@130
  1808
** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
vb@130
  1809
** it is not possible to set the Serialized [threading mode] and
vb@130
  1810
** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
vb@130
  1811
** SQLITE_CONFIG_SERIALIZED configuration option.</dd>
vb@130
  1812
**
vb@130
  1813
** [[SQLITE_CONFIG_MALLOC]] <dt>SQLITE_CONFIG_MALLOC</dt>
Edouard@491
  1814
** <dd> ^(The SQLITE_CONFIG_MALLOC option takes a single argument which is 
Edouard@491
  1815
** a pointer to an instance of the [sqlite3_mem_methods] structure.
Edouard@491
  1816
** The argument specifies
vb@130
  1817
** alternative low-level memory allocation routines to be used in place of
vb@130
  1818
** the memory allocation routines built into SQLite.)^ ^SQLite makes
vb@130
  1819
** its own private copy of the content of the [sqlite3_mem_methods] structure
vb@130
  1820
** before the [sqlite3_config()] call returns.</dd>
vb@130
  1821
**
vb@130
  1822
** [[SQLITE_CONFIG_GETMALLOC]] <dt>SQLITE_CONFIG_GETMALLOC</dt>
Edouard@491
  1823
** <dd> ^(The SQLITE_CONFIG_GETMALLOC option takes a single argument which
Edouard@491
  1824
** is a pointer to an instance of the [sqlite3_mem_methods] structure.
Edouard@491
  1825
** The [sqlite3_mem_methods]
vb@130
  1826
** structure is filled with the currently defined memory allocation routines.)^
vb@130
  1827
** This option can be used to overload the default memory allocation
vb@130
  1828
** routines with a wrapper that simulations memory allocation failure or
vb@130
  1829
** tracks memory usage, for example. </dd>
vb@130
  1830
**
vb@130
  1831
** [[SQLITE_CONFIG_MEMSTATUS]] <dt>SQLITE_CONFIG_MEMSTATUS</dt>
Edouard@491
  1832
** <dd> ^The SQLITE_CONFIG_MEMSTATUS option takes single argument of type int,
Edouard@491
  1833
** interpreted as a boolean, which enables or disables the collection of
Edouard@491
  1834
** memory allocation statistics. ^(When memory allocation statistics are
Edouard@491
  1835
** disabled, the following SQLite interfaces become non-operational:
vb@130
  1836
**   <ul>
vb@130
  1837
**   <li> [sqlite3_memory_used()]
vb@130
  1838
**   <li> [sqlite3_memory_highwater()]
vb@130
  1839
**   <li> [sqlite3_soft_heap_limit64()]
Edouard@491
  1840
**   <li> [sqlite3_status64()]
vb@130
  1841
**   </ul>)^
vb@130
  1842
** ^Memory allocation statistics are enabled by default unless SQLite is
vb@130
  1843
** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory
vb@130
  1844
** allocation statistics are disabled by default.
vb@130
  1845
** </dd>
vb@130
  1846
**
vb@130
  1847
** [[SQLITE_CONFIG_SCRATCH]] <dt>SQLITE_CONFIG_SCRATCH</dt>
Edouard@491
  1848
** <dd> ^The SQLITE_CONFIG_SCRATCH option specifies a static memory buffer
Edouard@491
  1849
** that SQLite can use for scratch memory.  ^(There are three arguments
Edouard@491
  1850
** to SQLITE_CONFIG_SCRATCH:  A pointer an 8-byte
vb@130
  1851
** aligned memory buffer from which the scratch allocations will be
vb@130
  1852
** drawn, the size of each scratch allocation (sz),
Edouard@491
  1853
** and the maximum number of scratch allocations (N).)^
vb@130
  1854
** The first argument must be a pointer to an 8-byte aligned buffer
vb@130
  1855
** of at least sz*N bytes of memory.
Edouard@491
  1856
** ^SQLite will not use more than one scratch buffers per thread.
Edouard@491
  1857
** ^SQLite will never request a scratch buffer that is more than 6
Edouard@491
  1858
** times the database page size.
Edouard@491
  1859
** ^If SQLite needs needs additional
vb@130
  1860
** scratch memory beyond what is provided by this configuration option, then 
Edouard@491
  1861
** [sqlite3_malloc()] will be used to obtain the memory needed.<p>
Edouard@491
  1862
** ^When the application provides any amount of scratch memory using
Edouard@491
  1863
** SQLITE_CONFIG_SCRATCH, SQLite avoids unnecessary large
Edouard@491
  1864
** [sqlite3_malloc|heap allocations].
Edouard@491
  1865
** This can help [Robson proof|prevent memory allocation failures] due to heap
Edouard@491
  1866
** fragmentation in low-memory embedded systems.
Edouard@491
  1867
** </dd>
vb@130
  1868
**
vb@130
  1869
** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt>
Edouard@491
  1870
** <dd> ^The SQLITE_CONFIG_PAGECACHE option specifies a memory pool
Edouard@491
  1871
** that SQLite can use for the database page cache with the default page
Edouard@491
  1872
** cache implementation.  
Edouard@491
  1873
** This configuration option is a no-op if an application-define page
Edouard@491
  1874
** cache implementation is loaded using the [SQLITE_CONFIG_PCACHE2].
Edouard@491
  1875
** ^There are three arguments to SQLITE_CONFIG_PAGECACHE: A pointer to
Edouard@491
  1876
** 8-byte aligned memory (pMem), the size of each page cache line (sz),
Edouard@491
  1877
** and the number of cache lines (N).
vb@130
  1878
** The sz argument should be the size of the largest database page
Edouard@491
  1879
** (a power of two between 512 and 65536) plus some extra bytes for each
Edouard@491
  1880
** page header.  ^The number of extra bytes needed by the page header
Edouard@491
  1881
** can be determined using [SQLITE_CONFIG_PCACHE_HDRSZ].
Edouard@491
  1882
** ^It is harmless, apart from the wasted memory,
Edouard@491
  1883
** for the sz parameter to be larger than necessary.  The pMem
Edouard@491
  1884
** argument must be either a NULL pointer or a pointer to an 8-byte
Edouard@491
  1885
** aligned block of memory of at least sz*N bytes, otherwise
Edouard@491
  1886
** subsequent behavior is undefined.
Edouard@491
  1887
** ^When pMem is not NULL, SQLite will strive to use the memory provided
Edouard@491
  1888
** to satisfy page cache needs, falling back to [sqlite3_malloc()] if
Edouard@491
  1889
** a page cache line is larger than sz bytes or if all of the pMem buffer
Edouard@491
  1890
** is exhausted.
Edouard@491
  1891
** ^If pMem is NULL and N is non-zero, then each database connection
Edouard@491
  1892
** does an initial bulk allocation for page cache memory
Edouard@491
  1893
** from [sqlite3_malloc()] sufficient for N cache lines if N is positive or
Edouard@491
  1894
** of -1024*N bytes if N is negative, . ^If additional
Edouard@491
  1895
** page cache memory is needed beyond what is provided by the initial
Edouard@491
  1896
** allocation, then SQLite goes to [sqlite3_malloc()] separately for each
Edouard@491
  1897
** additional cache line. </dd>
vb@130
  1898
**
vb@130
  1899
** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt>
Edouard@491
  1900
** <dd> ^The SQLITE_CONFIG_HEAP option specifies a static memory buffer 
Edouard@491
  1901
** that SQLite will use for all of its dynamic memory allocation needs
Edouard@491
  1902
** beyond those provided for by [SQLITE_CONFIG_SCRATCH] and
Edouard@491
  1903
** [SQLITE_CONFIG_PAGECACHE].
Edouard@491
  1904
** ^The SQLITE_CONFIG_HEAP option is only available if SQLite is compiled
Edouard@491
  1905
** with either [SQLITE_ENABLE_MEMSYS3] or [SQLITE_ENABLE_MEMSYS5] and returns
Edouard@491
  1906
** [SQLITE_ERROR] if invoked otherwise.
Edouard@491
  1907
** ^There are three arguments to SQLITE_CONFIG_HEAP:
Edouard@491
  1908
** An 8-byte aligned pointer to the memory,
vb@130
  1909
** the number of bytes in the memory buffer, and the minimum allocation size.
vb@130
  1910
** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts
vb@130
  1911
** to using its default memory allocator (the system malloc() implementation),
vb@130
  1912
** undoing any prior invocation of [SQLITE_CONFIG_MALLOC].  ^If the
Edouard@491
  1913
** memory pointer is not NULL then the alternative memory
vb@130
  1914
** allocator is engaged to handle all of SQLites memory allocation needs.
vb@130
  1915
** The first pointer (the memory pointer) must be aligned to an 8-byte
vb@130
  1916
** boundary or subsequent behavior of SQLite will be undefined.
vb@130
  1917
** The minimum allocation size is capped at 2**12. Reasonable values
vb@130
  1918
** for the minimum allocation size are 2**5 through 2**8.</dd>
vb@130
  1919
**
vb@130
  1920
** [[SQLITE_CONFIG_MUTEX]] <dt>SQLITE_CONFIG_MUTEX</dt>
Edouard@491
  1921
** <dd> ^(The SQLITE_CONFIG_MUTEX option takes a single argument which is a
Edouard@491
  1922
** pointer to an instance of the [sqlite3_mutex_methods] structure.
Edouard@491
  1923
** The argument specifies alternative low-level mutex routines to be used
Edouard@491
  1924
** in place the mutex routines built into SQLite.)^  ^SQLite makes a copy of
Edouard@491
  1925
** the content of the [sqlite3_mutex_methods] structure before the call to
vb@130
  1926
** [sqlite3_config()] returns. ^If SQLite is compiled with
vb@130
  1927
** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
vb@130
  1928
** the entire mutexing subsystem is omitted from the build and hence calls to
vb@130
  1929
** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will
vb@130
  1930
** return [SQLITE_ERROR].</dd>
vb@130
  1931
**
vb@130
  1932
** [[SQLITE_CONFIG_GETMUTEX]] <dt>SQLITE_CONFIG_GETMUTEX</dt>
Edouard@491
  1933
** <dd> ^(The SQLITE_CONFIG_GETMUTEX option takes a single argument which
Edouard@491
  1934
** is a pointer to an instance of the [sqlite3_mutex_methods] structure.  The
vb@130
  1935
** [sqlite3_mutex_methods]
vb@130
  1936
** structure is filled with the currently defined mutex routines.)^
vb@130
  1937
** This option can be used to overload the default mutex allocation
vb@130
  1938
** routines with a wrapper used to track mutex usage for performance
vb@130
  1939
** profiling or testing, for example.   ^If SQLite is compiled with
vb@130
  1940
** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
vb@130
  1941
** the entire mutexing subsystem is omitted from the build and hence calls to
vb@130
  1942
** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will
vb@130
  1943
** return [SQLITE_ERROR].</dd>
vb@130
  1944
**
vb@130
  1945
** [[SQLITE_CONFIG_LOOKASIDE]] <dt>SQLITE_CONFIG_LOOKASIDE</dt>
Edouard@491
  1946
** <dd> ^(The SQLITE_CONFIG_LOOKASIDE option takes two arguments that determine
Edouard@491
  1947
** the default size of lookaside memory on each [database connection].
Edouard@491
  1948
** The first argument is the
vb@130
  1949
** size of each lookaside buffer slot and the second is the number of
Edouard@491
  1950
** slots allocated to each database connection.)^  ^(SQLITE_CONFIG_LOOKASIDE
Edouard@491
  1951
** sets the <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE]
Edouard@491
  1952
** option to [sqlite3_db_config()] can be used to change the lookaside
vb@130
  1953
** configuration on individual connections.)^ </dd>
vb@130
  1954
**
vb@130
  1955
** [[SQLITE_CONFIG_PCACHE2]] <dt>SQLITE_CONFIG_PCACHE2</dt>
Edouard@491
  1956
** <dd> ^(The SQLITE_CONFIG_PCACHE2 option takes a single argument which is 
Edouard@491
  1957
** a pointer to an [sqlite3_pcache_methods2] object.  This object specifies
Edouard@491
  1958
** the interface to a custom page cache implementation.)^
Edouard@491
  1959
** ^SQLite makes a copy of the [sqlite3_pcache_methods2] object.</dd>
vb@130
  1960
**
vb@130
  1961
** [[SQLITE_CONFIG_GETPCACHE2]] <dt>SQLITE_CONFIG_GETPCACHE2</dt>
Edouard@491
  1962
** <dd> ^(The SQLITE_CONFIG_GETPCACHE2 option takes a single argument which
Edouard@491
  1963
** is a pointer to an [sqlite3_pcache_methods2] object.  SQLite copies of
Edouard@491
  1964
** the current page cache implementation into that object.)^ </dd>
vb@130
  1965
**
vb@130
  1966
** [[SQLITE_CONFIG_LOG]] <dt>SQLITE_CONFIG_LOG</dt>
vb@130
  1967
** <dd> The SQLITE_CONFIG_LOG option is used to configure the SQLite
vb@130
  1968
** global [error log].
vb@130
  1969
** (^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a
vb@130
  1970
** function with a call signature of void(*)(void*,int,const char*), 
vb@130
  1971
** and a pointer to void. ^If the function pointer is not NULL, it is
vb@130
  1972
** invoked by [sqlite3_log()] to process each logging event.  ^If the
vb@130
  1973
** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op.
vb@130
  1974
** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is
vb@130
  1975
** passed through as the first parameter to the application-defined logger
vb@130
  1976
** function whenever that function is invoked.  ^The second parameter to
vb@130
  1977
** the logger function is a copy of the first parameter to the corresponding
vb@130
  1978
** [sqlite3_log()] call and is intended to be a [result code] or an
vb@130
  1979
** [extended result code].  ^The third parameter passed to the logger is
vb@130
  1980
** log message after formatting via [sqlite3_snprintf()].
vb@130
  1981
** The SQLite logging interface is not reentrant; the logger function
vb@130
  1982
** supplied by the application must not invoke any SQLite interface.
vb@130
  1983
** In a multi-threaded application, the application-defined logger
vb@130
  1984
** function must be threadsafe. </dd>
vb@130
  1985
**
vb@130
  1986
** [[SQLITE_CONFIG_URI]] <dt>SQLITE_CONFIG_URI
Edouard@491
  1987
** <dd>^(The SQLITE_CONFIG_URI option takes a single argument of type int.
Edouard@491
  1988
** If non-zero, then URI handling is globally enabled. If the parameter is zero,
Edouard@491
  1989
** then URI handling is globally disabled.)^ ^If URI handling is globally
Edouard@491
  1990
** enabled, all filenames passed to [sqlite3_open()], [sqlite3_open_v2()],
Edouard@491
  1991
** [sqlite3_open16()] or
vb@130
  1992
** specified as part of [ATTACH] commands are interpreted as URIs, regardless
vb@130
  1993
** of whether or not the [SQLITE_OPEN_URI] flag is set when the database
vb@130
  1994
** connection is opened. ^If it is globally disabled, filenames are
vb@130
  1995
** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the
vb@130
  1996
** database connection is opened. ^(By default, URI handling is globally
vb@130
  1997
** disabled. The default value may be changed by compiling with the
vb@130
  1998
** [SQLITE_USE_URI] symbol defined.)^
vb@130
  1999
**
vb@130
  2000
** [[SQLITE_CONFIG_COVERING_INDEX_SCAN]] <dt>SQLITE_CONFIG_COVERING_INDEX_SCAN
Edouard@491
  2001
** <dd>^The SQLITE_CONFIG_COVERING_INDEX_SCAN option takes a single integer
Edouard@491
  2002
** argument which is interpreted as a boolean in order to enable or disable
Edouard@491
  2003
** the use of covering indices for full table scans in the query optimizer.
Edouard@491
  2004
** ^The default setting is determined
vb@130
  2005
** by the [SQLITE_ALLOW_COVERING_INDEX_SCAN] compile-time option, or is "on"
vb@130
  2006
** if that compile-time option is omitted.
vb@130
  2007
** The ability to disable the use of covering indices for full table scans
vb@130
  2008
** is because some incorrectly coded legacy applications might malfunction
vb@130
  2009
** when the optimization is enabled.  Providing the ability to
vb@130
  2010
** disable the optimization allows the older, buggy application code to work
vb@130
  2011
** without change even with newer versions of SQLite.
vb@130
  2012
**
vb@130
  2013
** [[SQLITE_CONFIG_PCACHE]] [[SQLITE_CONFIG_GETPCACHE]]
vb@130
  2014
** <dt>SQLITE_CONFIG_PCACHE and SQLITE_CONFIG_GETPCACHE
vb@130
  2015
** <dd> These options are obsolete and should not be used by new code.
vb@130
  2016
** They are retained for backwards compatibility but are now no-ops.
vb@130
  2017
** </dd>
vb@130
  2018
**
vb@130
  2019
** [[SQLITE_CONFIG_SQLLOG]]
vb@130
  2020
** <dt>SQLITE_CONFIG_SQLLOG
vb@130
  2021
** <dd>This option is only available if sqlite is compiled with the
vb@130
  2022
** [SQLITE_ENABLE_SQLLOG] pre-processor macro defined. The first argument should
vb@130
  2023
** be a pointer to a function of type void(*)(void*,sqlite3*,const char*, int).
vb@130
  2024
** The second should be of type (void*). The callback is invoked by the library
vb@130
  2025
** in three separate circumstances, identified by the value passed as the
vb@130
  2026
** fourth parameter. If the fourth parameter is 0, then the database connection
vb@130
  2027
** passed as the second argument has just been opened. The third argument
vb@130
  2028
** points to a buffer containing the name of the main database file. If the
vb@130
  2029
** fourth parameter is 1, then the SQL statement that the third parameter
vb@130
  2030
** points to has just been executed. Or, if the fourth parameter is 2, then
vb@130
  2031
** the connection being passed as the second parameter is being closed. The
vb@130
  2032
** third parameter is passed NULL In this case.  An example of using this
vb@130
  2033
** configuration option can be seen in the "test_sqllog.c" source file in
vb@130
  2034
** the canonical SQLite source tree.</dd>
vb@130
  2035
**
vb@130
  2036
** [[SQLITE_CONFIG_MMAP_SIZE]]
vb@130
  2037
** <dt>SQLITE_CONFIG_MMAP_SIZE
vb@130
  2038
** <dd>^SQLITE_CONFIG_MMAP_SIZE takes two 64-bit integer (sqlite3_int64) values
vb@130
  2039
** that are the default mmap size limit (the default setting for
vb@130
  2040
** [PRAGMA mmap_size]) and the maximum allowed mmap size limit.
vb@130
  2041
** ^The default setting can be overridden by each database connection using
vb@130
  2042
** either the [PRAGMA mmap_size] command, or by using the
vb@130
  2043
** [SQLITE_FCNTL_MMAP_SIZE] file control.  ^(The maximum allowed mmap size
Edouard@491
  2044
** will be silently truncated if necessary so that it does not exceed the
Edouard@491
  2045
** compile-time maximum mmap size set by the
vb@130
  2046
** [SQLITE_MAX_MMAP_SIZE] compile-time option.)^
vb@130
  2047
** ^If either argument to this option is negative, then that argument is
vb@130
  2048
** changed to its compile-time default.
vb@130
  2049
**
vb@130
  2050
** [[SQLITE_CONFIG_WIN32_HEAPSIZE]]
vb@130
  2051
** <dt>SQLITE_CONFIG_WIN32_HEAPSIZE
Edouard@491
  2052
** <dd>^The SQLITE_CONFIG_WIN32_HEAPSIZE option is only available if SQLite is
Edouard@491
  2053
** compiled for Windows with the [SQLITE_WIN32_MALLOC] pre-processor macro
Edouard@491
  2054
** defined. ^SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit unsigned integer value
vb@130
  2055
** that specifies the maximum size of the created heap.
Edouard@491
  2056
**
Edouard@491
  2057
** [[SQLITE_CONFIG_PCACHE_HDRSZ]]
Edouard@491
  2058
** <dt>SQLITE_CONFIG_PCACHE_HDRSZ
Edouard@491
  2059
** <dd>^The SQLITE_CONFIG_PCACHE_HDRSZ option takes a single parameter which
Edouard@491
  2060
** is a pointer to an integer and writes into that integer the number of extra
Edouard@491
  2061
** bytes per page required for each page in [SQLITE_CONFIG_PAGECACHE].
Edouard@491
  2062
** The amount of extra space required can change depending on the compiler,
Edouard@491
  2063
** target platform, and SQLite version.
Edouard@491
  2064
**
Edouard@491
  2065
** [[SQLITE_CONFIG_PMASZ]]
Edouard@491
  2066
** <dt>SQLITE_CONFIG_PMASZ
Edouard@491
  2067
** <dd>^The SQLITE_CONFIG_PMASZ option takes a single parameter which
Edouard@491
  2068
** is an unsigned integer and sets the "Minimum PMA Size" for the multithreaded
Edouard@491
  2069
** sorter to that integer.  The default minimum PMA Size is set by the
Edouard@491
  2070
** [SQLITE_SORTER_PMASZ] compile-time option.  New threads are launched
Edouard@491
  2071
** to help with sort operations when multithreaded sorting
Edouard@491
  2072
** is enabled (using the [PRAGMA threads] command) and the amount of content
Edouard@491
  2073
** to be sorted exceeds the page size times the minimum of the
Edouard@491
  2074
** [PRAGMA cache_size] setting and this value.
vb@716
  2075
**
vb@716
  2076
** [[SQLITE_CONFIG_STMTJRNL_SPILL]]
vb@716
  2077
** <dt>SQLITE_CONFIG_STMTJRNL_SPILL
vb@716
  2078
** <dd>^The SQLITE_CONFIG_STMTJRNL_SPILL option takes a single parameter which
vb@716
  2079
** becomes the [statement journal] spill-to-disk threshold.  
vb@716
  2080
** [Statement journals] are held in memory until their size (in bytes)
vb@716
  2081
** exceeds this threshold, at which point they are written to disk.
vb@716
  2082
** Or if the threshold is -1, statement journals are always held
vb@716
  2083
** exclusively in memory.
vb@716
  2084
** Since many statement journals never become large, setting the spill
vb@716
  2085
** threshold to a value such as 64KiB can greatly reduce the amount of
vb@716
  2086
** I/O required to support statement rollback.
vb@716
  2087
** The default value for this setting is controlled by the
vb@716
  2088
** [SQLITE_STMTJRNL_SPILL] compile-time option.
vb@130
  2089
** </dl>
vb@130
  2090
*/
vb@130
  2091
#define SQLITE_CONFIG_SINGLETHREAD  1  /* nil */
vb@130
  2092
#define SQLITE_CONFIG_MULTITHREAD   2  /* nil */
vb@130
  2093
#define SQLITE_CONFIG_SERIALIZED    3  /* nil */
vb@130
  2094
#define SQLITE_CONFIG_MALLOC        4  /* sqlite3_mem_methods* */
vb@130
  2095
#define SQLITE_CONFIG_GETMALLOC     5  /* sqlite3_mem_methods* */
vb@130
  2096
#define SQLITE_CONFIG_SCRATCH       6  /* void*, int sz, int N */
vb@130
  2097
#define SQLITE_CONFIG_PAGECACHE     7  /* void*, int sz, int N */
vb@130
  2098
#define SQLITE_CONFIG_HEAP          8  /* void*, int nByte, int min */
vb@130
  2099
#define SQLITE_CONFIG_MEMSTATUS     9  /* boolean */
vb@130
  2100
#define SQLITE_CONFIG_MUTEX        10  /* sqlite3_mutex_methods* */
vb@130
  2101
#define SQLITE_CONFIG_GETMUTEX     11  /* sqlite3_mutex_methods* */
vb@130
  2102
/* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */ 
vb@130
  2103
#define SQLITE_CONFIG_LOOKASIDE    13  /* int int */
vb@130
  2104
#define SQLITE_CONFIG_PCACHE       14  /* no-op */
vb@130
  2105
#define SQLITE_CONFIG_GETPCACHE    15  /* no-op */
vb@130
  2106
#define SQLITE_CONFIG_LOG          16  /* xFunc, void* */
vb@130
  2107
#define SQLITE_CONFIG_URI          17  /* int */
vb@130
  2108
#define SQLITE_CONFIG_PCACHE2      18  /* sqlite3_pcache_methods2* */
vb@130
  2109
#define SQLITE_CONFIG_GETPCACHE2   19  /* sqlite3_pcache_methods2* */
vb@130
  2110
#define SQLITE_CONFIG_COVERING_INDEX_SCAN 20  /* int */
vb@130
  2111
#define SQLITE_CONFIG_SQLLOG       21  /* xSqllog, void* */
vb@130
  2112
#define SQLITE_CONFIG_MMAP_SIZE    22  /* sqlite3_int64, sqlite3_int64 */
vb@130
  2113
#define SQLITE_CONFIG_WIN32_HEAPSIZE      23  /* int nByte */
Edouard@491
  2114
#define SQLITE_CONFIG_PCACHE_HDRSZ        24  /* int *psz */
Edouard@491
  2115
#define SQLITE_CONFIG_PMASZ               25  /* unsigned int szPma */
vb@716
  2116
#define SQLITE_CONFIG_STMTJRNL_SPILL      26  /* int nByte */
vb@130
  2117
vb@130
  2118
/*
vb@130
  2119
** CAPI3REF: Database Connection Configuration Options
vb@130
  2120
**
vb@130
  2121
** These constants are the available integer configuration options that
vb@130
  2122
** can be passed as the second argument to the [sqlite3_db_config()] interface.
vb@130
  2123
**
vb@130
  2124
** New configuration options may be added in future releases of SQLite.
vb@130
  2125
** Existing configuration options might be discontinued.  Applications
vb@130
  2126
** should check the return code from [sqlite3_db_config()] to make sure that
vb@130
  2127
** the call worked.  ^The [sqlite3_db_config()] interface will return a
vb@130
  2128
** non-zero [error code] if a discontinued or unsupported configuration option
vb@130
  2129
** is invoked.
vb@130
  2130
**
vb@130
  2131
** <dl>
vb@130
  2132
** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt>
vb@130
  2133
** <dd> ^This option takes three additional arguments that determine the 
vb@130
  2134
** [lookaside memory allocator] configuration for the [database connection].
vb@130
  2135
** ^The first argument (the third parameter to [sqlite3_db_config()] is a
vb@130
  2136
** pointer to a memory buffer to use for lookaside memory.
vb@130
  2137
** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb
vb@130
  2138
** may be NULL in which case SQLite will allocate the
vb@130
  2139
** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the
vb@130
  2140
** size of each lookaside buffer slot.  ^The third argument is the number of
vb@130
  2141
** slots.  The size of the buffer in the first argument must be greater than
vb@130
  2142
** or equal to the product of the second and third arguments.  The buffer
vb@130
  2143
** must be aligned to an 8-byte boundary.  ^If the second argument to
vb@130
  2144
** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally
vb@130
  2145
** rounded down to the next smaller multiple of 8.  ^(The lookaside memory
vb@130
  2146
** configuration for a database connection can only be changed when that
vb@130
  2147
** connection is not currently using lookaside memory, or in other words
vb@130
  2148
** when the "current value" returned by
vb@130
  2149
** [sqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero.
vb@130
  2150
** Any attempt to change the lookaside memory configuration when lookaside
vb@130
  2151
** memory is in use leaves the configuration unchanged and returns 
vb@130
  2152
** [SQLITE_BUSY].)^</dd>
vb@130
  2153
**
vb@130
  2154
** <dt>SQLITE_DBCONFIG_ENABLE_FKEY</dt>
vb@130
  2155
** <dd> ^This option is used to enable or disable the enforcement of
vb@130
  2156
** [foreign key constraints].  There should be two additional arguments.
vb@130
  2157
** The first argument is an integer which is 0 to disable FK enforcement,
vb@130
  2158
** positive to enable FK enforcement or negative to leave FK enforcement
vb@130
  2159
** unchanged.  The second parameter is a pointer to an integer into which
vb@130
  2160
** is written 0 or 1 to indicate whether FK enforcement is off or on
vb@130
  2161
** following this call.  The second parameter may be a NULL pointer, in
vb@130
  2162
** which case the FK enforcement setting is not reported back. </dd>
vb@130
  2163
**
vb@130
  2164
** <dt>SQLITE_DBCONFIG_ENABLE_TRIGGER</dt>
vb@130
  2165
** <dd> ^This option is used to enable or disable [CREATE TRIGGER | triggers].
vb@130
  2166
** There should be two additional arguments.
vb@130
  2167
** The first argument is an integer which is 0 to disable triggers,
vb@130
  2168
** positive to enable triggers or negative to leave the setting unchanged.
vb@130
  2169
** The second parameter is a pointer to an integer into which
vb@130
  2170
** is written 0 or 1 to indicate whether triggers are disabled or enabled
vb@130
  2171
** following this call.  The second parameter may be a NULL pointer, in
vb@130
  2172
** which case the trigger setting is not reported back. </dd>
vb@130
  2173
**
vb@716
  2174
** <dt>SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER</dt>
vb@716
  2175
** <dd> ^This option is used to enable or disable the two-argument
vb@716
  2176
** version of the [fts3_tokenizer()] function which is part of the
vb@716
  2177
** [FTS3] full-text search engine extension.
vb@716
  2178
** There should be two additional arguments.
vb@716
  2179
** The first argument is an integer which is 0 to disable fts3_tokenizer() or
vb@716
  2180
** positive to enable fts3_tokenizer() or negative to leave the setting
vb@716
  2181
** unchanged.
vb@716
  2182
** The second parameter is a pointer to an integer into which
vb@716
  2183
** is written 0 or 1 to indicate whether fts3_tokenizer is disabled or enabled
vb@716
  2184
** following this call.  The second parameter may be a NULL pointer, in
vb@716
  2185
** which case the new setting is not reported back. </dd>
vb@716
  2186
**
vb@716
  2187
** <dt>SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION</dt>
vb@716
  2188
** <dd> ^This option is used to enable or disable the [sqlite3_load_extension()]
vb@716
  2189
** interface independently of the [load_extension()] SQL function.
vb@716
  2190
** The [sqlite3_enable_load_extension()] API enables or disables both the
vb@716
  2191
** C-API [sqlite3_load_extension()] and the SQL function [load_extension()].
vb@716
  2192
** There should be two additional arguments.
vb@716
  2193
** When the first argument to this interface is 1, then only the C-API is
vb@716
  2194
** enabled and the SQL function remains disabled.  If the first argment to
vb@716
  2195
** this interface is 0, then both the C-API and the SQL function are disabled.
vb@716
  2196
** If the first argument is -1, then no changes are made to state of either the
vb@716
  2197
** C-API or the SQL function.
vb@716
  2198
** The second parameter is a pointer to an integer into which
vb@716
  2199
** is written 0 or 1 to indicate whether [sqlite3_load_extension()] interface
vb@716
  2200
** is disabled or enabled following this call.  The second parameter may
vb@716
  2201
** be a NULL pointer, in which case the new setting is not reported back.
vb@716
  2202
** </dd>
vb@716
  2203
**
vb@130
  2204
** </dl>
vb@130
  2205
*/
vb@716
  2206
#define SQLITE_DBCONFIG_LOOKASIDE             1001 /* void* int int */
vb@716
  2207
#define SQLITE_DBCONFIG_ENABLE_FKEY           1002 /* int int* */
vb@716
  2208
#define SQLITE_DBCONFIG_ENABLE_TRIGGER        1003 /* int int* */
vb@716
  2209
#define SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER 1004 /* int int* */
vb@716
  2210
#define SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION 1005 /* int int* */
vb@130
  2211
vb@130
  2212
vb@130
  2213
/*
vb@130
  2214
** CAPI3REF: Enable Or Disable Extended Result Codes
Edouard@491
  2215
** METHOD: sqlite3
vb@130
  2216
**
vb@130
  2217
** ^The sqlite3_extended_result_codes() routine enables or disables the
vb@130
  2218
** [extended result codes] feature of SQLite. ^The extended result
vb@130
  2219
** codes are disabled by default for historical compatibility.
vb@130
  2220
*/
Edouard@491
  2221
SQLITE_API int SQLITE_STDCALL sqlite3_extended_result_codes(sqlite3*, int onoff);
vb@130
  2222
vb@130
  2223
/*
vb@130
  2224
** CAPI3REF: Last Insert Rowid
Edouard@491
  2225
** METHOD: sqlite3
vb@130
  2226
**
vb@130
  2227
** ^Each entry in most SQLite tables (except for [WITHOUT ROWID] tables)
vb@130
  2228
** has a unique 64-bit signed
vb@130
  2229
** integer key called the [ROWID | "rowid"]. ^The rowid is always available
vb@130
  2230
** as an undeclared column named ROWID, OID, or _ROWID_ as long as those
vb@130
  2231
** names are not also used by explicitly declared columns. ^If
vb@130
  2232
** the table has a column of type [INTEGER PRIMARY KEY] then that column
vb@130
  2233
** is another alias for the rowid.
vb@130
  2234
**
vb@130
  2235
** ^The sqlite3_last_insert_rowid(D) interface returns the [rowid] of the 
vb@130
  2236
** most recent successful [INSERT] into a rowid table or [virtual table]
vb@130
  2237
** on database connection D.
vb@130
  2238
** ^Inserts into [WITHOUT ROWID] tables are not recorded.
vb@130
  2239
** ^If no successful [INSERT]s into rowid tables
vb@130
  2240
** have ever occurred on the database connection D, 
vb@130
  2241
** then sqlite3_last_insert_rowid(D) returns zero.
vb@130
  2242
**
vb@130
  2243
** ^(If an [INSERT] occurs within a trigger or within a [virtual table]
vb@130
  2244
** method, then this routine will return the [rowid] of the inserted
vb@130
  2245
** row as long as the trigger or virtual table method is running.
vb@130
  2246
** But once the trigger or virtual table method ends, the value returned 
vb@130
  2247
** by this routine reverts to what it was before the trigger or virtual
vb@130
  2248
** table method began.)^
vb@130
  2249
**
vb@130
  2250
** ^An [INSERT] that fails due to a constraint violation is not a
vb@130
  2251
** successful [INSERT] and does not change the value returned by this
vb@130
  2252
** routine.  ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK,
vb@130
  2253
** and INSERT OR ABORT make no changes to the return value of this
vb@130
  2254
** routine when their insertion fails.  ^(When INSERT OR REPLACE
vb@130
  2255
** encounters a constraint violation, it does not fail.  The
vb@130
  2256
** INSERT continues to completion after deleting rows that caused
vb@130
  2257
** the constraint problem so INSERT OR REPLACE will always change
vb@130
  2258
** the return value of this interface.)^
vb@130
  2259
**
vb@130
  2260
** ^For the purposes of this routine, an [INSERT] is considered to
vb@130
  2261
** be successful even if it is subsequently rolled back.
vb@130
  2262
**
vb@130
  2263
** This function is accessible to SQL statements via the
vb@130
  2264
** [last_insert_rowid() SQL function].
vb@130
  2265
**
vb@130
  2266
** If a separate thread performs a new [INSERT] on the same
vb@130
  2267
** database connection while the [sqlite3_last_insert_rowid()]
vb@130
  2268
** function is running and thus changes the last insert [rowid],
vb@130
  2269
** then the value returned by [sqlite3_last_insert_rowid()] is
vb@130
  2270
** unpredictable and might not equal either the old or the new
vb@130
  2271
** last insert [rowid].
vb@130
  2272
*/
Edouard@491
  2273
SQLITE_API sqlite3_int64 SQLITE_STDCALL sqlite3_last_insert_rowid(sqlite3*);
vb@130
  2274
vb@130
  2275
/*
vb@130
  2276
** CAPI3REF: Count The Number Of Rows Modified
Edouard@491
  2277
** METHOD: sqlite3
Edouard@491
  2278
**
Edouard@491
  2279
** ^This function returns the number of rows modified, inserted or
Edouard@491
  2280
** deleted by the most recently completed INSERT, UPDATE or DELETE
Edouard@491
  2281
** statement on the database connection specified by the only parameter.
Edouard@491
  2282
** ^Executing any other type of SQL statement does not modify the value
Edouard@491
  2283
** returned by this function.
Edouard@491
  2284
**
Edouard@491
  2285
** ^Only changes made directly by the INSERT, UPDATE or DELETE statement are
Edouard@491
  2286
** considered - auxiliary changes caused by [CREATE TRIGGER | triggers], 
Edouard@491
  2287
** [foreign key actions] or [REPLACE] constraint resolution are not counted.
Edouard@491
  2288
** 
Edouard@491
  2289
** Changes to a view that are intercepted by 
Edouard@491
  2290
** [INSTEAD OF trigger | INSTEAD OF triggers] are not counted. ^The value 
Edouard@491
  2291
** returned by sqlite3_changes() immediately after an INSERT, UPDATE or 
Edouard@491
  2292
** DELETE statement run on a view is always zero. Only changes made to real 
Edouard@491
  2293
** tables are counted.
Edouard@491
  2294
**
Edouard@491
  2295
** Things are more complicated if the sqlite3_changes() function is
Edouard@491
  2296
** executed while a trigger program is running. This may happen if the
Edouard@491
  2297
** program uses the [changes() SQL function], or if some other callback
Edouard@491
  2298
** function invokes sqlite3_changes() directly. Essentially:
Edouard@491
  2299
** 
Edouard@491
  2300
** <ul>
Edouard@491
  2301
**   <li> ^(Before entering a trigger program the value returned by
Edouard@491
  2302
**        sqlite3_changes() function is saved. After the trigger program 
Edouard@491
  2303
**        has finished, the original value is restored.)^
Edouard@491
  2304
** 
Edouard@491
  2305
**   <li> ^(Within a trigger program each INSERT, UPDATE and DELETE 
Edouard@491
  2306
**        statement sets the value returned by sqlite3_changes() 
Edouard@491
  2307
**        upon completion as normal. Of course, this value will not include 
Edouard@491
  2308
**        any changes performed by sub-triggers, as the sqlite3_changes() 
Edouard@491
  2309
**        value will be saved and restored after each sub-trigger has run.)^
Edouard@491
  2310
** </ul>
Edouard@491
  2311
** 
Edouard@491
  2312
** ^This means that if the changes() SQL function (or similar) is used
Edouard@491
  2313
** by the first INSERT, UPDATE or DELETE statement within a trigger, it 
Edouard@491
  2314
** returns the value as set when the calling statement began executing.
Edouard@491
  2315
** ^If it is used by the second or subsequent such statement within a trigger 
Edouard@491
  2316
** program, the value returned reflects the number of rows modified by the 
Edouard@491
  2317
** previous INSERT, UPDATE or DELETE statement within the same trigger.
vb@130
  2318
**
vb@130
  2319
** See also the [sqlite3_total_changes()] interface, the
vb@130
  2320
** [count_changes pragma], and the [changes() SQL function].
vb@130
  2321
**
vb@130
  2322
** If a separate thread makes changes on the same database connection
vb@130
  2323
** while [sqlite3_changes()] is running then the value returned
vb@130
  2324
** is unpredictable and not meaningful.
vb@130
  2325
*/
Edouard@491
  2326
SQLITE_API int SQLITE_STDCALL sqlite3_changes(sqlite3*);
vb@130
  2327
vb@130
  2328
/*
vb@130
  2329
** CAPI3REF: Total Number Of Rows Modified
Edouard@491
  2330
** METHOD: sqlite3
Edouard@491
  2331
**
Edouard@491
  2332
** ^This function returns the total number of rows inserted, modified or
Edouard@491
  2333
** deleted by all [INSERT], [UPDATE] or [DELETE] statements completed
Edouard@491
  2334
** since the database connection was opened, including those executed as
Edouard@491
  2335
** part of trigger programs. ^Executing any other type of SQL statement
Edouard@491
  2336
** does not affect the value returned by sqlite3_total_changes().
Edouard@491
  2337
** 
Edouard@491
  2338
** ^Changes made as part of [foreign key actions] are included in the
Edouard@491
  2339
** count, but those made as part of REPLACE constraint resolution are
Edouard@491
  2340
** not. ^Changes to a view that are intercepted by INSTEAD OF triggers 
Edouard@491
  2341
** are not counted.
Edouard@491
  2342
** 
vb@130
  2343
** See also the [sqlite3_changes()] interface, the
vb@130
  2344
** [count_changes pragma], and the [total_changes() SQL function].
vb@130
  2345
**
vb@130
  2346
** If a separate thread makes changes on the same database connection
vb@130
  2347
** while [sqlite3_total_changes()] is running then the value
vb@130
  2348
** returned is unpredictable and not meaningful.
vb@130
  2349
*/
Edouard@491
  2350
SQLITE_API int SQLITE_STDCALL sqlite3_total_changes(sqlite3*);
vb@130
  2351
vb@130
  2352
/*
vb@130
  2353
** CAPI3REF: Interrupt A Long-Running Query
Edouard@491
  2354
** METHOD: sqlite3
vb@130
  2355
**
vb@130
  2356
** ^This function causes any pending database operation to abort and
vb@130
  2357
** return at its earliest opportunity. This routine is typically
vb@130
  2358
** called in response to a user action such as pressing "Cancel"
vb@130
  2359
** or Ctrl-C where the user wants a long query operation to halt
vb@130
  2360
** immediately.
vb@130
  2361
**
vb@130
  2362
** ^It is safe to call this routine from a thread different from the
vb@130
  2363
** thread that is currently running the database operation.  But it
vb@130
  2364
** is not safe to call this routine with a [database connection] that
vb@130
  2365
** is closed or might close before sqlite3_interrupt() returns.
vb@130
  2366
**
vb@130
  2367
** ^If an SQL operation is very nearly finished at the time when
vb@130
  2368
** sqlite3_interrupt() is called, then it might not have an opportunity
vb@130
  2369
** to be interrupted and might continue to completion.
vb@130
  2370
**
vb@130
  2371
** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT].
vb@130
  2372
** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE
vb@130
  2373
** that is inside an explicit transaction, then the entire transaction
vb@130
  2374
** will be rolled back automatically.
vb@130
  2375
**
vb@130
  2376
** ^The sqlite3_interrupt(D) call is in effect until all currently running
vb@130
  2377
** SQL statements on [database connection] D complete.  ^Any new SQL statements
vb@130
  2378
** that are started after the sqlite3_interrupt() call and before the 
vb@130
  2379
** running statements reaches zero are interrupted as if they had been
vb@130
  2380
** running prior to the sqlite3_interrupt() call.  ^New SQL statements
vb@130
  2381
** that are started after the running statement count reaches zero are
vb@130
  2382
** not effected by the sqlite3_interrupt().
vb@130
  2383
** ^A call to sqlite3_interrupt(D) that occurs when there are no running
vb@130
  2384
** SQL statements is a no-op and has no effect on SQL statements
vb@130
  2385
** that are started after the sqlite3_interrupt() call returns.
vb@130
  2386
**
vb@130
  2387
** If the database connection closes while [sqlite3_interrupt()]
vb@130
  2388
** is running then bad things will likely happen.
vb@130
  2389
*/
Edouard@491
  2390
SQLITE_API void SQLITE_STDCALL sqlite3_interrupt(sqlite3*);
vb@130
  2391
vb@130
  2392
/*
vb@130
  2393
** CAPI3REF: Determine If An SQL Statement Is Complete
vb@130
  2394
**
vb@130
  2395
** These routines are useful during command-line input to determine if the
vb@130
  2396
** currently entered text seems to form a complete SQL statement or
vb@130
  2397
** if additional input is needed before sending the text into
vb@130
  2398
** SQLite for parsing.  ^These routines return 1 if the input string
vb@130
  2399
** appears to be a complete SQL statement.  ^A statement is judged to be
vb@130
  2400
** complete if it ends with a semicolon token and is not a prefix of a
vb@130
  2401
** well-formed CREATE TRIGGER statement.  ^Semicolons that are embedded within
vb@130
  2402
** string literals or quoted identifier names or comments are not
vb@130
  2403
** independent tokens (they are part of the token in which they are
vb@130
  2404
** embedded) and thus do not count as a statement terminator.  ^Whitespace
vb@130
  2405
** and comments that follow the final semicolon are ignored.
vb@130
  2406
**
vb@130
  2407
** ^These routines return 0 if the statement is incomplete.  ^If a
vb@130
  2408
** memory allocation fails, then SQLITE_NOMEM is returned.
vb@130
  2409
**
vb@130
  2410
** ^These routines do not parse the SQL statements thus
vb@130
  2411
** will not detect syntactically incorrect SQL.
vb@130
  2412
**
vb@130
  2413
** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior 
vb@130
  2414
** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked
vb@130
  2415
** automatically by sqlite3_complete16().  If that initialization fails,
vb@130
  2416
** then the return value from sqlite3_complete16() will be non-zero
vb@130
  2417
** regardless of whether or not the input SQL is complete.)^
vb@130
  2418
**
vb@130
  2419
** The input to [sqlite3_complete()] must be a zero-terminated
vb@130
  2420
** UTF-8 string.
vb@130
  2421
**
vb@130
  2422
** The input to [sqlite3_complete16()] must be a zero-terminated
vb@130
  2423
** UTF-16 string in native byte order.
vb@130
  2424
*/
Edouard@491
  2425
SQLITE_API int SQLITE_STDCALL sqlite3_complete(const char *sql);
Edouard@491
  2426
SQLITE_API int SQLITE_STDCALL sqlite3_complete16(const void *sql);
vb@130
  2427
vb@130
  2428
/*
vb@130
  2429
** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors
Edouard@491
  2430
** KEYWORDS: {busy-handler callback} {busy handler}
Edouard@491
  2431
** METHOD: sqlite3
vb@130
  2432
**
vb@130
  2433
** ^The sqlite3_busy_handler(D,X,P) routine sets a callback function X
vb@130
  2434
** that might be invoked with argument P whenever
vb@130
  2435
** an attempt is made to access a database table associated with
vb@130
  2436
** [database connection] D when another thread
vb@130
  2437
** or process has the table locked.
vb@130
  2438
** The sqlite3_busy_handler() interface is used to implement
vb@130
  2439
** [sqlite3_busy_timeout()] and [PRAGMA busy_timeout].
vb@130
  2440
**
vb@130
  2441
** ^If the busy callback is NULL, then [SQLITE_BUSY]
vb@130
  2442
** is returned immediately upon encountering the lock.  ^If the busy callback
vb@130
  2443
** is not NULL, then the callback might be invoked with two arguments.
vb@130
  2444
**
vb@130
  2445
** ^The first argument to the busy handler is a copy of the void* pointer which
vb@130
  2446
** is the third argument to sqlite3_busy_handler().  ^The second argument to
vb@130
  2447
** the busy handler callback is the number of times that the busy handler has
Edouard@491
  2448
** been invoked previously for the same locking event.  ^If the
vb@130
  2449
** busy callback returns 0, then no additional attempts are made to
vb@130
  2450
** access the database and [SQLITE_BUSY] is returned
vb@130
  2451
** to the application.
vb@130
  2452
** ^If the callback returns non-zero, then another attempt
vb@130
  2453
** is made to access the database and the cycle repeats.
vb@130
  2454
**
vb@130
  2455
** The presence of a busy handler does not guarantee that it will be invoked
vb@130
  2456
** when there is lock contention. ^If SQLite determines that invoking the busy
vb@130
  2457
** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY]
vb@130
  2458
** to the application instead of invoking the 
vb@130
  2459
** busy handler.
vb@130
  2460
** Consider a scenario where one process is holding a read lock that
vb@130
  2461
** it is trying to promote to a reserved lock and
vb@130
  2462
** a second process is holding a reserved lock that it is trying
vb@130
  2463
** to promote to an exclusive lock.  The first process cannot proceed
vb@130
  2464
** because it is blocked by the second and the second process cannot
vb@130
  2465
** proceed because it is blocked by the first.  If both processes
vb@130
  2466
** invoke the busy handlers, neither will make any progress.  Therefore,
vb@130
  2467
** SQLite returns [SQLITE_BUSY] for the first process, hoping that this
vb@130
  2468
** will induce the first process to release its read lock and allow
vb@130
  2469
** the second process to proceed.
vb@130
  2470
**
vb@130
  2471
** ^The default busy callback is NULL.
vb@130
  2472
**
vb@130
  2473
** ^(There can only be a single busy handler defined for each
vb@130
  2474
** [database connection].  Setting a new busy handler clears any
vb@130
  2475
** previously set handler.)^  ^Note that calling [sqlite3_busy_timeout()]
vb@130
  2476
** or evaluating [PRAGMA busy_timeout=N] will change the
vb@130
  2477
** busy handler and thus clear any previously set busy handler.
vb@130
  2478
**
vb@130
  2479
** The busy callback should not take any actions which modify the
vb@130
  2480
** database connection that invoked the busy handler.  In other words,
vb@130
  2481
** the busy handler is not reentrant.  Any such actions
vb@130
  2482
** result in undefined behavior.
vb@130
  2483
** 
vb@130
  2484
** A busy handler must not close the database connection
vb@130
  2485
** or [prepared statement] that invoked the busy handler.
vb@130
  2486
*/
Edouard@491
  2487
SQLITE_API int SQLITE_STDCALL sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*);
vb@130
  2488
vb@130
  2489
/*
vb@130
  2490
** CAPI3REF: Set A Busy Timeout
Edouard@491
  2491
** METHOD: sqlite3
vb@130
  2492
**
vb@130
  2493
** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps
vb@130
  2494
** for a specified amount of time when a table is locked.  ^The handler
vb@130
  2495
** will sleep multiple times until at least "ms" milliseconds of sleeping
vb@130
  2496
** have accumulated.  ^After at least "ms" milliseconds of sleeping,
vb@130
  2497
** the handler returns 0 which causes [sqlite3_step()] to return
vb@130
  2498
** [SQLITE_BUSY].
vb@130
  2499
**
vb@130
  2500
** ^Calling this routine with an argument less than or equal to zero
vb@130
  2501
** turns off all busy handlers.
vb@130
  2502
**
vb@130
  2503
** ^(There can only be a single busy handler for a particular
Edouard@491
  2504
** [database connection] at any given moment.  If another busy handler
vb@130
  2505
** was defined  (using [sqlite3_busy_handler()]) prior to calling
vb@130
  2506
** this routine, that other busy handler is cleared.)^
vb@130
  2507
**
vb@130
  2508
** See also:  [PRAGMA busy_timeout]
vb@130
  2509
*/
Edouard@491
  2510
SQLITE_API int SQLITE_STDCALL sqlite3_busy_timeout(sqlite3*, int ms);
vb@130
  2511
vb@130
  2512
/*
vb@130
  2513
** CAPI3REF: Convenience Routines For Running Queries
Edouard@491
  2514
** METHOD: sqlite3
vb@130
  2515
**
vb@130
  2516
** This is a legacy interface that is preserved for backwards compatibility.
vb@130
  2517
** Use of this interface is not recommended.
vb@130
  2518
**
vb@130
  2519
** Definition: A <b>result table</b> is memory data structure created by the
vb@130
  2520
** [sqlite3_get_table()] interface.  A result table records the
vb@130
  2521
** complete query results from one or more queries.
vb@130
  2522
**
vb@130
  2523
** The table conceptually has a number of rows and columns.  But
vb@130
  2524
** these numbers are not part of the result table itself.  These
vb@130
  2525
** numbers are obtained separately.  Let N be the number of rows
vb@130
  2526
** and M be the number of columns.
vb@130
  2527
**
vb@130
  2528
** A result table is an array of pointers to zero-terminated UTF-8 strings.
vb@130
  2529
** There are (N+1)*M elements in the array.  The first M pointers point
vb@130
  2530
** to zero-terminated strings that  contain the names of the columns.
vb@130
  2531
** The remaining entries all point to query results.  NULL values result
vb@130
  2532
** in NULL pointers.  All other values are in their UTF-8 zero-terminated
vb@130
  2533
** string representation as returned by [sqlite3_column_text()].
vb@130
  2534
**
vb@130
  2535
** A result table might consist of one or more memory allocations.
vb@130
  2536
** It is not safe to pass a result table directly to [sqlite3_free()].
vb@130
  2537
** A result table should be deallocated using [sqlite3_free_table()].
vb@130
  2538
**
vb@130
  2539
** ^(As an example of the result table format, suppose a query result
vb@130
  2540
** is as follows:
vb@130
  2541
**
vb@130
  2542
** <blockquote><pre>
vb@130
  2543
**        Name        | Age
vb@130
  2544
**        -----------------------
vb@130
  2545
**        Alice       | 43
vb@130
  2546
**        Bob         | 28
vb@130
  2547
**        Cindy       | 21
vb@130
  2548
** </pre></blockquote>
vb@130
  2549
**
vb@130
  2550
** There are two column (M==2) and three rows (N==3).  Thus the
vb@130
  2551
** result table has 8 entries.  Suppose the result table is stored
vb@130
  2552
** in an array names azResult.  Then azResult holds this content:
vb@130
  2553
**
vb@130
  2554
** <blockquote><pre>
vb@130
  2555
**        azResult&#91;0] = "Name";
vb@130
  2556
**        azResult&#91;1] = "Age";
vb@130
  2557
**        azResult&#91;2] = "Alice";
vb@130
  2558
**        azResult&#91;3] = "43";
vb@130
  2559
**        azResult&#91;4] = "Bob";
vb@130
  2560
**        azResult&#91;5] = "28";
vb@130
  2561
**        azResult&#91;6] = "Cindy";
vb@130
  2562
**        azResult&#91;7] = "21";
vb@130
  2563
** </pre></blockquote>)^
vb@130
  2564
**
vb@130
  2565
** ^The sqlite3_get_table() function evaluates one or more
vb@130
  2566
** semicolon-separated SQL statements in the zero-terminated UTF-8
vb@130
  2567
** string of its 2nd parameter and returns a result table to the
vb@130
  2568
** pointer given in its 3rd parameter.
vb@130
  2569
**
vb@130
  2570
** After the application has finished with the result from sqlite3_get_table(),
vb@130
  2571
** it must pass the result table pointer to sqlite3_free_table() in order to
vb@130
  2572
** release the memory that was malloced.  Because of the way the
vb@130
  2573
** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling
vb@130
  2574
** function must not try to call [sqlite3_free()] directly.  Only
vb@130
  2575
** [sqlite3_free_table()] is able to release the memory properly and safely.
vb@130
  2576
**
vb@130
  2577
** The sqlite3_get_table() interface is implemented as a wrapper around
vb@130
  2578
** [sqlite3_exec()].  The sqlite3_get_table() routine does not have access
vb@130
  2579
** to any internal data structures of SQLite.  It uses only the public
vb@130
  2580
** interface defined here.  As a consequence, errors that occur in the
vb@130
  2581
** wrapper layer outside of the internal [sqlite3_exec()] call are not
vb@130
  2582
** reflected in subsequent calls to [sqlite3_errcode()] or
vb@130
  2583
** [sqlite3_errmsg()].
vb@130
  2584
*/
Edouard@491
  2585
SQLITE_API int SQLITE_STDCALL sqlite3_get_table(
vb@130
  2586
  sqlite3 *db,          /* An open database */
vb@130
  2587
  const char *zSql,     /* SQL to be evaluated */
vb@130
  2588
  char ***pazResult,    /* Results of the query */
vb@130
  2589
  int *pnRow,           /* Number of result rows written here */
vb@130
  2590
  int *pnColumn,        /* Number of result columns written here */
vb@130
  2591
  char **pzErrmsg       /* Error msg written here */
vb@130
  2592
);
Edouard@491
  2593
SQLITE_API void SQLITE_STDCALL sqlite3_free_table(char **result);
vb@130
  2594
vb@130
  2595
/*
vb@130
  2596
** CAPI3REF: Formatted String Printing Functions
vb@130
  2597
**
vb@130
  2598
** These routines are work-alikes of the "printf()" family of functions
vb@130
  2599
** from the standard C library.
Edouard@491
  2600
** These routines understand most of the common K&R formatting options,
Edouard@491
  2601
** plus some additional non-standard formats, detailed below.
Edouard@491
  2602
** Note that some of the more obscure formatting options from recent
Edouard@491
  2603
** C-library standards are omitted from this implementation.
vb@130
  2604
**
vb@130
  2605
** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their
vb@130
  2606
** results into memory obtained from [sqlite3_malloc()].
vb@130
  2607
** The strings returned by these two routines should be
vb@130
  2608
** released by [sqlite3_free()].  ^Both routines return a
vb@130
  2609
** NULL pointer if [sqlite3_malloc()] is unable to allocate enough
vb@130
  2610
** memory to hold the resulting string.
vb@130
  2611
**
vb@130
  2612
** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from
vb@130
  2613
** the standard C library.  The result is written into the
vb@130
  2614
** buffer supplied as the second parameter whose size is given by
vb@130
  2615
** the first parameter. Note that the order of the
vb@130
  2616
** first two parameters is reversed from snprintf().)^  This is an
vb@130
  2617
** historical accident that cannot be fixed without breaking
vb@130
  2618
** backwards compatibility.  ^(Note also that sqlite3_snprintf()
vb@130
  2619
** returns a pointer to its buffer instead of the number of
vb@130
  2620
** characters actually written into the buffer.)^  We admit that
vb@130
  2621
** the number of characters written would be a more useful return
vb@130
  2622
** value but we cannot change the implementation of sqlite3_snprintf()
vb@130
  2623
** now without breaking compatibility.
vb@130
  2624
**
vb@130
  2625
** ^As long as the buffer size is greater than zero, sqlite3_snprintf()
vb@130
  2626
** guarantees that the buffer is always zero-terminated.  ^The first
vb@130
  2627
** parameter "n" is the total size of the buffer, including space for
vb@130
  2628
** the zero terminator.  So the longest string that can be completely
vb@130
  2629
** written will be n-1 characters.
vb@130
  2630
**
vb@130
  2631
** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf().
vb@130
  2632
**
vb@130
  2633
** These routines all implement some additional formatting
vb@130
  2634
** options that are useful for constructing SQL statements.
vb@130
  2635
** All of the usual printf() formatting options apply.  In addition, there
Edouard@491
  2636
** is are "%q", "%Q", "%w" and "%z" options.
vb@130
  2637
**
vb@130
  2638
** ^(The %q option works like %s in that it substitutes a nul-terminated
vb@130
  2639
** string from the argument list.  But %q also doubles every '\'' character.
vb@130
  2640
** %q is designed for use inside a string literal.)^  By doubling each '\''
vb@130
  2641
** character it escapes that character and allows it to be inserted into
vb@130
  2642
** the string.
vb@130
  2643
**
vb@130
  2644
** For example, assume the string variable zText contains text as follows:
vb@130
  2645
**
vb@130
  2646
** <blockquote><pre>
vb@130
  2647
**  char *zText = "It's a happy day!";
vb@130
  2648
** </pre></blockquote>
vb@130
  2649
**
vb@130
  2650
** One can use this text in an SQL statement as follows:
vb@130
  2651
**
vb@130
  2652
** <blockquote><pre>
vb@130
  2653
**  char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES('%q')", zText);
vb@130
  2654
**  sqlite3_exec(db, zSQL, 0, 0, 0);
vb@130
  2655
**  sqlite3_free(zSQL);
vb@130
  2656
** </pre></blockquote>
vb@130
  2657
**
vb@130
  2658
** Because the %q format string is used, the '\'' character in zText
vb@130
  2659
** is escaped and the SQL generated is as follows:
vb@130
  2660
**
vb@130
  2661
** <blockquote><pre>
vb@130
  2662
**  INSERT INTO table1 VALUES('It''s a happy day!')
vb@130
  2663
** </pre></blockquote>
vb@130
  2664
**
vb@130
  2665
** This is correct.  Had we used %s instead of %q, the generated SQL
vb@130
  2666
** would have looked like this:
vb@130
  2667
**
vb@130
  2668
** <blockquote><pre>
vb@130
  2669
**  INSERT INTO table1 VALUES('It's a happy day!');
vb@130
  2670
** </pre></blockquote>
vb@130
  2671
**
vb@130
  2672
** This second example is an SQL syntax error.  As a general rule you should
vb@130
  2673
** always use %q instead of %s when inserting text into a string literal.
vb@130
  2674
**
vb@130
  2675
** ^(The %Q option works like %q except it also adds single quotes around
vb@130
  2676
** the outside of the total string.  Additionally, if the parameter in the
vb@130
  2677
** argument list is a NULL pointer, %Q substitutes the text "NULL" (without
vb@130
  2678
** single quotes).)^  So, for example, one could say:
vb@130
  2679
**
vb@130
  2680
** <blockquote><pre>
vb@130
  2681
**  char *zSQL = sqlite3_mprintf("INSERT INTO table VALUES(%Q)", zText);
vb@130
  2682
**  sqlite3_exec(db, zSQL, 0, 0, 0);
vb@130
  2683
**  sqlite3_free(zSQL);
vb@130
  2684
** </pre></blockquote>
vb@130
  2685
**
vb@130
  2686
** The code above will render a correct SQL statement in the zSQL
vb@130
  2687
** variable even if the zText variable is a NULL pointer.
vb@130
  2688
**
Edouard@491
  2689
** ^(The "%w" formatting option is like "%q" except that it expects to
Edouard@491
  2690
** be contained within double-quotes instead of single quotes, and it
Edouard@491
  2691
** escapes the double-quote character instead of the single-quote
Edouard@491
  2692
** character.)^  The "%w" formatting option is intended for safely inserting
Edouard@491
  2693
** table and column names into a constructed SQL statement.
Edouard@491
  2694
**
vb@130
  2695
** ^(The "%z" formatting option works like "%s" but with the
vb@130
  2696
** addition that after the string has been read and copied into
vb@130
  2697
** the result, [sqlite3_free()] is called on the input string.)^
vb@130
  2698
*/
Edouard@491
  2699
SQLITE_API char *SQLITE_CDECL sqlite3_mprintf(const char*,...);
Edouard@491
  2700
SQLITE_API char *SQLITE_STDCALL sqlite3_vmprintf(const char*, va_list);
Edouard@491
  2701
SQLITE_API char *SQLITE_CDECL sqlite3_snprintf(int,char*,const char*, ...);
Edouard@491
  2702
SQLITE_API char *SQLITE_STDCALL sqlite3_vsnprintf(int,char*,const char*, va_list);
vb@130
  2703
vb@130
  2704
/*