/ Hex Artifact Content
Login
SQLite training in Houston TX on 2019-11-05 (details)
Part of the 2019 Tcl Conference

Artifact 3dc7317ded4bf66facd845705f45f21d03517940:


0000: 2f 2a 0a 2a 2a 20 32 30 30 31 20 53 65 70 74 65  /*.** 2001 Septe
0010: 6d 62 65 72 20 31 35 0a 2a 2a 0a 2a 2a 20 54 68  mber 15.**.** Th
0020: 65 20 61 75 74 68 6f 72 20 64 69 73 63 6c 61 69  e author disclai
0030: 6d 73 20 63 6f 70 79 72 69 67 68 74 20 74 6f 20  ms copyright to 
0040: 74 68 69 73 20 73 6f 75 72 63 65 20 63 6f 64 65  this source code
0050: 2e 20 20 49 6e 20 70 6c 61 63 65 20 6f 66 0a 2a  .  In place of.*
0060: 2a 20 61 20 6c 65 67 61 6c 20 6e 6f 74 69 63 65  * a legal notice
0070: 2c 20 68 65 72 65 20 69 73 20 61 20 62 6c 65 73  , here is a bles
0080: 73 69 6e 67 3a 0a 2a 2a 0a 2a 2a 20 20 20 20 4d  sing:.**.**    M
0090: 61 79 20 79 6f 75 20 64 6f 20 67 6f 6f 64 20 61  ay you do good a
00a0: 6e 64 20 6e 6f 74 20 65 76 69 6c 2e 0a 2a 2a 20  nd not evil..** 
00b0: 20 20 20 4d 61 79 20 79 6f 75 20 66 69 6e 64 20     May you find 
00c0: 66 6f 72 67 69 76 65 6e 65 73 73 20 66 6f 72 20  forgiveness for 
00d0: 79 6f 75 72 73 65 6c 66 20 61 6e 64 20 66 6f 72  yourself and for
00e0: 67 69 76 65 20 6f 74 68 65 72 73 2e 0a 2a 2a 20  give others..** 
00f0: 20 20 20 4d 61 79 20 79 6f 75 20 73 68 61 72 65     May you share
0100: 20 66 72 65 65 6c 79 2c 20 6e 65 76 65 72 20 74   freely, never t
0110: 61 6b 69 6e 67 20 6d 6f 72 65 20 74 68 61 6e 20  aking more than 
0120: 79 6f 75 20 67 69 76 65 2e 0a 2a 2a 0a 2a 2a 2a  you give..**.***
0130: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0140: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0150: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0160: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0170: 2a 2a 2a 2a 2a 2a 0a 2a 2a 20 54 68 69 73 20 68  ******.** This h
0180: 65 61 64 65 72 20 66 69 6c 65 20 64 65 66 69 6e  eader file defin
0190: 65 73 20 74 68 65 20 69 6e 74 65 72 66 61 63 65  es the interface
01a0: 20 74 68 61 74 20 74 68 65 20 53 51 4c 69 74 65   that the SQLite
01b0: 20 6c 69 62 72 61 72 79 0a 2a 2a 20 70 72 65 73   library.** pres
01c0: 65 6e 74 73 20 74 6f 20 63 6c 69 65 6e 74 20 70  ents to client p
01d0: 72 6f 67 72 61 6d 73 2e 20 20 49 66 20 61 20 43  rograms.  If a C
01e0: 2d 66 75 6e 63 74 69 6f 6e 2c 20 73 74 72 75 63  -function, struc
01f0: 74 75 72 65 2c 20 64 61 74 61 74 79 70 65 2c 0a  ture, datatype,.
0200: 2a 2a 20 6f 72 20 63 6f 6e 73 74 61 6e 74 20 64  ** or constant d
0210: 65 66 69 6e 69 74 69 6f 6e 20 64 6f 65 73 20 6e  efinition does n
0220: 6f 74 20 61 70 70 65 61 72 20 69 6e 20 74 68 69  ot appear in thi
0230: 73 20 66 69 6c 65 2c 20 74 68 65 6e 20 69 74 20  s file, then it 
0240: 69 73 0a 2a 2a 20 6e 6f 74 20 61 20 70 75 62 6c  is.** not a publ
0250: 69 73 68 65 64 20 41 50 49 20 6f 66 20 53 51 4c  ished API of SQL
0260: 69 74 65 2c 20 69 73 20 73 75 62 6a 65 63 74 20  ite, is subject 
0270: 74 6f 20 63 68 61 6e 67 65 20 77 69 74 68 6f 75  to change withou
0280: 74 0a 2a 2a 20 6e 6f 74 69 63 65 2c 20 61 6e 64  t.** notice, and
0290: 20 73 68 6f 75 6c 64 20 6e 6f 74 20 62 65 20 72   should not be r
02a0: 65 66 65 72 65 6e 63 65 64 20 62 79 20 70 72 6f  eferenced by pro
02b0: 67 72 61 6d 73 20 74 68 61 74 20 75 73 65 20 53  grams that use S
02c0: 51 4c 69 74 65 2e 0a 2a 2a 0a 2a 2a 20 53 6f 6d  QLite..**.** Som
02d0: 65 20 6f 66 20 74 68 65 20 64 65 66 69 6e 69 74  e of the definit
02e0: 69 6f 6e 73 20 74 68 61 74 20 61 72 65 20 69 6e  ions that are in
02f0: 20 74 68 69 73 20 66 69 6c 65 20 61 72 65 20 6d   this file are m
0300: 61 72 6b 65 64 20 61 73 0a 2a 2a 20 22 65 78 70  arked as.** "exp
0310: 65 72 69 6d 65 6e 74 61 6c 22 2e 20 20 45 78 70  erimental".  Exp
0320: 65 72 69 6d 65 6e 74 61 6c 20 69 6e 74 65 72 66  erimental interf
0330: 61 63 65 73 20 61 72 65 20 6e 6f 72 6d 61 6c 6c  aces are normall
0340: 79 20 6e 65 77 0a 2a 2a 20 66 65 61 74 75 72 65  y new.** feature
0350: 73 20 72 65 63 65 6e 74 6c 79 20 61 64 64 65 64  s recently added
0360: 20 74 6f 20 53 51 4c 69 74 65 2e 20 20 57 65 20   to SQLite.  We 
0370: 64 6f 20 6e 6f 74 20 61 6e 74 69 63 69 70 61 74  do not anticipat
0380: 65 20 63 68 61 6e 67 65 73 0a 2a 2a 20 74 6f 20  e changes.** to 
0390: 65 78 70 65 72 69 6d 65 6e 74 61 6c 20 69 6e 74  experimental int
03a0: 65 72 66 61 63 65 73 20 62 75 74 20 72 65 73 65  erfaces but rese
03b0: 72 76 65 20 74 68 65 20 72 69 67 68 74 20 74 6f  rve the right to
03c0: 20 6d 61 6b 65 20 6d 69 6e 6f 72 20 63 68 61 6e   make minor chan
03d0: 67 65 73 0a 2a 2a 20 69 66 20 65 78 70 65 72 69  ges.** if experi
03e0: 65 6e 63 65 20 66 72 6f 6d 20 75 73 65 20 22 69  ence from use "i
03f0: 6e 20 74 68 65 20 77 69 6c 64 22 20 73 75 67 67  n the wild" sugg
0400: 65 73 74 20 73 75 63 68 20 63 68 61 6e 67 65 73  est such changes
0410: 20 61 72 65 20 70 72 75 64 65 6e 74 2e 0a 2a 2a   are prudent..**
0420: 0a 2a 2a 20 54 68 65 20 6f 66 66 69 63 69 61 6c  .** The official
0430: 20 43 2d 6c 61 6e 67 75 61 67 65 20 41 50 49 20   C-language API 
0440: 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 66 6f  documentation fo
0450: 72 20 53 51 4c 69 74 65 20 69 73 20 64 65 72 69  r SQLite is deri
0460: 76 65 64 0a 2a 2a 20 66 72 6f 6d 20 63 6f 6d 6d  ved.** from comm
0470: 65 6e 74 73 20 69 6e 20 74 68 69 73 20 66 69 6c  ents in this fil
0480: 65 2e 20 20 54 68 69 73 20 66 69 6c 65 20 69 73  e.  This file is
0490: 20 74 68 65 20 61 75 74 68 6f 72 69 74 61 74 69   the authoritati
04a0: 76 65 20 73 6f 75 72 63 65 0a 2a 2a 20 6f 6e 20  ve source.** on 
04b0: 68 6f 77 20 53 51 4c 69 74 65 20 69 6e 74 65 72  how SQLite inter
04c0: 66 61 63 65 73 20 61 72 65 20 73 75 70 70 6f 73  faces are suppos
04d0: 65 64 20 74 6f 20 6f 70 65 72 61 74 65 2e 0a 2a  ed to operate..*
04e0: 2a 0a 2a 2a 20 54 68 65 20 6e 61 6d 65 20 6f 66  *.** The name of
04f0: 20 74 68 69 73 20 66 69 6c 65 20 75 6e 64 65 72   this file under
0500: 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6d   configuration m
0510: 61 6e 61 67 65 6d 65 6e 74 20 69 73 20 22 73 71  anagement is "sq
0520: 6c 69 74 65 2e 68 2e 69 6e 22 2e 0a 2a 2a 20 54  lite.h.in"..** T
0530: 68 65 20 6d 61 6b 65 66 69 6c 65 20 6d 61 6b 65  he makefile make
0540: 73 20 73 6f 6d 65 20 6d 69 6e 6f 72 20 63 68 61  s some minor cha
0550: 6e 67 65 73 20 74 6f 20 74 68 69 73 20 66 69 6c  nges to this fil
0560: 65 20 28 73 75 63 68 20 61 73 20 69 6e 73 65 72  e (such as inser
0570: 74 69 6e 67 0a 2a 2a 20 74 68 65 20 76 65 72 73  ting.** the vers
0580: 69 6f 6e 20 6e 75 6d 62 65 72 29 20 61 6e 64 20  ion number) and 
0590: 63 68 61 6e 67 65 73 20 69 74 73 20 6e 61 6d 65  changes its name
05a0: 20 74 6f 20 22 73 71 6c 69 74 65 33 2e 68 22 20   to "sqlite3.h" 
05b0: 61 73 0a 2a 2a 20 70 61 72 74 20 6f 66 20 74 68  as.** part of th
05c0: 65 20 62 75 69 6c 64 20 70 72 6f 63 65 73 73 2e  e build process.
05d0: 0a 2a 2f 0a 23 69 66 6e 64 65 66 20 53 51 4c 49  .*/.#ifndef SQLI
05e0: 54 45 33 5f 48 0a 23 64 65 66 69 6e 65 20 53 51  TE3_H.#define SQ
05f0: 4c 49 54 45 33 5f 48 0a 23 69 6e 63 6c 75 64 65  LITE3_H.#include
0600: 20 3c 73 74 64 61 72 67 2e 68 3e 20 20 20 20 20   <stdarg.h>     
0610: 2f 2a 20 4e 65 65 64 65 64 20 66 6f 72 20 74 68  /* Needed for th
0620: 65 20 64 65 66 69 6e 69 74 69 6f 6e 20 6f 66 20  e definition of 
0630: 76 61 5f 6c 69 73 74 20 2a 2f 0a 0a 2f 2a 0a 2a  va_list */../*.*
0640: 2a 20 4d 61 6b 65 20 73 75 72 65 20 77 65 20 63  * Make sure we c
0650: 61 6e 20 63 61 6c 6c 20 74 68 69 73 20 73 74 75  an call this stu
0660: 66 66 20 66 72 6f 6d 20 43 2b 2b 2e 0a 2a 2f 0a  ff from C++..*/.
0670: 23 69 66 64 65 66 20 5f 5f 63 70 6c 75 73 70 6c  #ifdef __cpluspl
0680: 75 73 0a 65 78 74 65 72 6e 20 22 43 22 20 7b 0a  us.extern "C" {.
0690: 23 65 6e 64 69 66 0a 0a 0a 2f 2a 0a 2a 2a 20 50  #endif.../*.** P
06a0: 72 6f 76 69 64 65 20 74 68 65 20 61 62 69 6c 69  rovide the abili
06b0: 74 79 20 74 6f 20 6f 76 65 72 72 69 64 65 20 6c  ty to override l
06c0: 69 6e 6b 61 67 65 20 66 65 61 74 75 72 65 73 20  inkage features 
06d0: 6f 66 20 74 68 65 20 69 6e 74 65 72 66 61 63 65  of the interface
06e0: 2e 0a 2a 2f 0a 23 69 66 6e 64 65 66 20 53 51 4c  ..*/.#ifndef SQL
06f0: 49 54 45 5f 45 58 54 45 52 4e 0a 23 20 64 65 66  ITE_EXTERN.# def
0700: 69 6e 65 20 53 51 4c 49 54 45 5f 45 58 54 45 52  ine SQLITE_EXTER
0710: 4e 20 65 78 74 65 72 6e 0a 23 65 6e 64 69 66 0a  N extern.#endif.
0720: 23 69 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 41  #ifndef SQLITE_A
0730: 50 49 0a 23 20 64 65 66 69 6e 65 20 53 51 4c 49  PI.# define SQLI
0740: 54 45 5f 41 50 49 0a 23 65 6e 64 69 66 0a 23 69  TE_API.#endif.#i
0750: 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 43 44 45  fndef SQLITE_CDE
0760: 43 4c 0a 23 20 64 65 66 69 6e 65 20 53 51 4c 49  CL.# define SQLI
0770: 54 45 5f 43 44 45 43 4c 0a 23 65 6e 64 69 66 0a  TE_CDECL.#endif.
0780: 23 69 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 53  #ifndef SQLITE_S
0790: 54 44 43 41 4c 4c 0a 23 20 64 65 66 69 6e 65 20  TDCALL.# define 
07a0: 53 51 4c 49 54 45 5f 53 54 44 43 41 4c 4c 0a 23  SQLITE_STDCALL.#
07b0: 65 6e 64 69 66 0a 0a 2f 2a 0a 2a 2a 20 54 68 65  endif../*.** The
07c0: 73 65 20 6e 6f 2d 6f 70 20 6d 61 63 72 6f 73 20  se no-op macros 
07d0: 61 72 65 20 75 73 65 64 20 69 6e 20 66 72 6f 6e  are used in fron
07e0: 74 20 6f 66 20 69 6e 74 65 72 66 61 63 65 73 20  t of interfaces 
07f0: 74 6f 20 6d 61 72 6b 20 74 68 6f 73 65 0a 2a 2a  to mark those.**
0800: 20 69 6e 74 65 72 66 61 63 65 73 20 61 73 20 65   interfaces as e
0810: 69 74 68 65 72 20 64 65 70 72 65 63 61 74 65 64  ither deprecated
0820: 20 6f 72 20 65 78 70 65 72 69 6d 65 6e 74 61 6c   or experimental
0830: 2e 20 20 4e 65 77 20 61 70 70 6c 69 63 61 74 69  .  New applicati
0840: 6f 6e 73 0a 2a 2a 20 73 68 6f 75 6c 64 20 6e 6f  ons.** should no
0850: 74 20 75 73 65 20 64 65 70 72 65 63 61 74 65 64  t use deprecated
0860: 20 69 6e 74 65 72 66 61 63 65 73 20 2d 20 74 68   interfaces - th
0870: 65 79 20 61 72 65 20 73 75 70 70 6f 72 74 65 64  ey are supported
0880: 20 66 6f 72 20 62 61 63 6b 77 61 72 64 73 0a 2a   for backwards.*
0890: 2a 20 63 6f 6d 70 61 74 69 62 69 6c 69 74 79 20  * compatibility 
08a0: 6f 6e 6c 79 2e 20 20 41 70 70 6c 69 63 61 74 69  only.  Applicati
08b0: 6f 6e 20 77 72 69 74 65 72 73 20 73 68 6f 75 6c  on writers shoul
08c0: 64 20 62 65 20 61 77 61 72 65 20 74 68 61 74 0a  d be aware that.
08d0: 2a 2a 20 65 78 70 65 72 69 6d 65 6e 74 61 6c 20  ** experimental 
08e0: 69 6e 74 65 72 66 61 63 65 73 20 61 72 65 20 73  interfaces are s
08f0: 75 62 6a 65 63 74 20 74 6f 20 63 68 61 6e 67 65  ubject to change
0900: 20 69 6e 20 70 6f 69 6e 74 20 72 65 6c 65 61 73   in point releas
0910: 65 73 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20  es..**.** These 
0920: 6d 61 63 72 6f 73 20 75 73 65 64 20 74 6f 20 72  macros used to r
0930: 65 73 6f 6c 76 65 20 74 6f 20 76 61 72 69 6f 75  esolve to variou
0940: 73 20 6b 69 6e 64 73 20 6f 66 20 63 6f 6d 70 69  s kinds of compi
0950: 6c 65 72 20 6d 61 67 69 63 20 74 68 61 74 0a 2a  ler magic that.*
0960: 2a 20 77 6f 75 6c 64 20 67 65 6e 65 72 61 74 65  * would generate
0970: 20 77 61 72 6e 69 6e 67 20 6d 65 73 73 61 67 65   warning message
0980: 73 20 77 68 65 6e 20 74 68 65 79 20 77 65 72 65  s when they were
0990: 20 75 73 65 64 2e 20 20 42 75 74 20 74 68 61 74   used.  But that
09a0: 0a 2a 2a 20 63 6f 6d 70 69 6c 65 72 20 6d 61 67  .** compiler mag
09b0: 69 63 20 65 6e 64 65 64 20 75 70 20 67 65 6e 65  ic ended up gene
09c0: 72 61 74 69 6e 67 20 73 75 63 68 20 61 20 66 6c  rating such a fl
09d0: 75 72 72 79 20 6f 66 20 62 75 67 20 72 65 70 6f  urry of bug repo
09e0: 72 74 73 0a 2a 2a 20 74 68 61 74 20 77 65 20 68  rts.** that we h
09f0: 61 76 65 20 74 61 6b 65 6e 20 69 74 20 61 6c 6c  ave taken it all
0a00: 20 6f 75 74 20 61 6e 64 20 67 6f 6e 65 20 62 61   out and gone ba
0a10: 63 6b 20 74 6f 20 75 73 69 6e 67 20 73 69 6d 70  ck to using simp
0a20: 6c 65 0a 2a 2a 20 6e 6f 6f 70 20 6d 61 63 72 6f  le.** noop macro
0a30: 73 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51  s..*/.#define SQ
0a40: 4c 49 54 45 5f 44 45 50 52 45 43 41 54 45 44 0a  LITE_DEPRECATED.
0a50: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 45  #define SQLITE_E
0a60: 58 50 45 52 49 4d 45 4e 54 41 4c 0a 0a 2f 2a 0a  XPERIMENTAL../*.
0a70: 2a 2a 20 45 6e 73 75 72 65 20 74 68 65 73 65 20  ** Ensure these 
0a80: 73 79 6d 62 6f 6c 73 20 77 65 72 65 20 6e 6f 74  symbols were not
0a90: 20 64 65 66 69 6e 65 64 20 62 79 20 73 6f 6d 65   defined by some
0aa0: 20 70 72 65 76 69 6f 75 73 20 68 65 61 64 65 72   previous header
0ab0: 20 66 69 6c 65 2e 0a 2a 2f 0a 23 69 66 64 65 66   file..*/.#ifdef
0ac0: 20 53 51 4c 49 54 45 5f 56 45 52 53 49 4f 4e 0a   SQLITE_VERSION.
0ad0: 23 20 75 6e 64 65 66 20 53 51 4c 49 54 45 5f 56  # undef SQLITE_V
0ae0: 45 52 53 49 4f 4e 0a 23 65 6e 64 69 66 0a 23 69  ERSION.#endif.#i
0af0: 66 64 65 66 20 53 51 4c 49 54 45 5f 56 45 52 53  fdef SQLITE_VERS
0b00: 49 4f 4e 5f 4e 55 4d 42 45 52 0a 23 20 75 6e 64  ION_NUMBER.# und
0b10: 65 66 20 53 51 4c 49 54 45 5f 56 45 52 53 49 4f  ef SQLITE_VERSIO
0b20: 4e 5f 4e 55 4d 42 45 52 0a 23 65 6e 64 69 66 0a  N_NUMBER.#endif.
0b30: 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
0b40: 20 43 6f 6d 70 69 6c 65 2d 54 69 6d 65 20 4c 69   Compile-Time Li
0b50: 62 72 61 72 79 20 56 65 72 73 69 6f 6e 20 4e 75  brary Version Nu
0b60: 6d 62 65 72 73 0a 2a 2a 0a 2a 2a 20 5e 28 54 68  mbers.**.** ^(Th
0b70: 65 20 5b 53 51 4c 49 54 45 5f 56 45 52 53 49 4f  e [SQLITE_VERSIO
0b80: 4e 5d 20 43 20 70 72 65 70 72 6f 63 65 73 73 6f  N] C preprocesso
0b90: 72 20 6d 61 63 72 6f 20 69 6e 20 74 68 65 20 73  r macro in the s
0ba0: 71 6c 69 74 65 33 2e 68 20 68 65 61 64 65 72 0a  qlite3.h header.
0bb0: 2a 2a 20 65 76 61 6c 75 61 74 65 73 20 74 6f 20  ** evaluates to 
0bc0: 61 20 73 74 72 69 6e 67 20 6c 69 74 65 72 61 6c  a string literal
0bd0: 20 74 68 61 74 20 69 73 20 74 68 65 20 53 51 4c   that is the SQL
0be0: 69 74 65 20 76 65 72 73 69 6f 6e 20 69 6e 20 74  ite version in t
0bf0: 68 65 0a 2a 2a 20 66 6f 72 6d 61 74 20 22 58 2e  he.** format "X.
0c00: 59 2e 5a 22 20 77 68 65 72 65 20 58 20 69 73 20  Y.Z" where X is 
0c10: 74 68 65 20 6d 61 6a 6f 72 20 76 65 72 73 69 6f  the major versio
0c20: 6e 20 6e 75 6d 62 65 72 20 28 61 6c 77 61 79 73  n number (always
0c30: 20 33 20 66 6f 72 0a 2a 2a 20 53 51 4c 69 74 65   3 for.** SQLite
0c40: 33 29 20 61 6e 64 20 59 20 69 73 20 74 68 65 20  3) and Y is the 
0c50: 6d 69 6e 6f 72 20 76 65 72 73 69 6f 6e 20 6e 75  minor version nu
0c60: 6d 62 65 72 20 61 6e 64 20 5a 20 69 73 20 74 68  mber and Z is th
0c70: 65 20 72 65 6c 65 61 73 65 20 6e 75 6d 62 65 72  e release number
0c80: 2e 29 5e 0a 2a 2a 20 5e 28 54 68 65 20 5b 53 51  .)^.** ^(The [SQ
0c90: 4c 49 54 45 5f 56 45 52 53 49 4f 4e 5f 4e 55 4d  LITE_VERSION_NUM
0ca0: 42 45 52 5d 20 43 20 70 72 65 70 72 6f 63 65 73  BER] C preproces
0cb0: 73 6f 72 20 6d 61 63 72 6f 20 72 65 73 6f 6c 76  sor macro resolv
0cc0: 65 73 20 74 6f 20 61 6e 20 69 6e 74 65 67 65 72  es to an integer
0cd0: 0a 2a 2a 20 77 69 74 68 20 74 68 65 20 76 61 6c  .** with the val
0ce0: 75 65 20 28 58 2a 31 30 30 30 30 30 30 20 2b 20  ue (X*1000000 + 
0cf0: 59 2a 31 30 30 30 20 2b 20 5a 29 20 77 68 65 72  Y*1000 + Z) wher
0d00: 65 20 58 2c 20 59 2c 20 61 6e 64 20 5a 20 61 72  e X, Y, and Z ar
0d10: 65 20 74 68 65 20 73 61 6d 65 0a 2a 2a 20 6e 75  e the same.** nu
0d20: 6d 62 65 72 73 20 75 73 65 64 20 69 6e 20 5b 53  mbers used in [S
0d30: 51 4c 49 54 45 5f 56 45 52 53 49 4f 4e 5d 2e 29  QLITE_VERSION].)
0d40: 5e 0a 2a 2a 20 54 68 65 20 53 51 4c 49 54 45 5f  ^.** The SQLITE_
0d50: 56 45 52 53 49 4f 4e 5f 4e 55 4d 42 45 52 20 66  VERSION_NUMBER f
0d60: 6f 72 20 61 6e 79 20 67 69 76 65 6e 20 72 65 6c  or any given rel
0d70: 65 61 73 65 20 6f 66 20 53 51 4c 69 74 65 20 77  ease of SQLite w
0d80: 69 6c 6c 20 61 6c 73 6f 0a 2a 2a 20 62 65 20 6c  ill also.** be l
0d90: 61 72 67 65 72 20 74 68 61 6e 20 74 68 65 20 72  arger than the r
0da0: 65 6c 65 61 73 65 20 66 72 6f 6d 20 77 68 69 63  elease from whic
0db0: 68 20 69 74 20 69 73 20 64 65 72 69 76 65 64 2e  h it is derived.
0dc0: 20 20 45 69 74 68 65 72 20 59 20 77 69 6c 6c 0a    Either Y will.
0dd0: 2a 2a 20 62 65 20 68 65 6c 64 20 63 6f 6e 73 74  ** be held const
0de0: 61 6e 74 20 61 6e 64 20 5a 20 77 69 6c 6c 20 62  ant and Z will b
0df0: 65 20 69 6e 63 72 65 6d 65 6e 74 65 64 20 6f 72  e incremented or
0e00: 20 65 6c 73 65 20 59 20 77 69 6c 6c 20 62 65 20   else Y will be 
0e10: 69 6e 63 72 65 6d 65 6e 74 65 64 0a 2a 2a 20 61  incremented.** a
0e20: 6e 64 20 5a 20 77 69 6c 6c 20 62 65 20 72 65 73  nd Z will be res
0e30: 65 74 20 74 6f 20 7a 65 72 6f 2e 0a 2a 2a 0a 2a  et to zero..**.*
0e40: 2a 20 53 69 6e 63 65 20 76 65 72 73 69 6f 6e 20  * Since version 
0e50: 33 2e 36 2e 31 38 2c 20 53 51 4c 69 74 65 20 73  3.6.18, SQLite s
0e60: 6f 75 72 63 65 20 63 6f 64 65 20 68 61 73 20 62  ource code has b
0e70: 65 65 6e 20 73 74 6f 72 65 64 20 69 6e 20 74 68  een stored in th
0e80: 65 0a 2a 2a 20 3c 61 20 68 72 65 66 3d 22 68 74  e.** <a href="ht
0e90: 74 70 3a 2f 2f 77 77 77 2e 66 6f 73 73 69 6c 2d  tp://www.fossil-
0ea0: 73 63 6d 2e 6f 72 67 2f 22 3e 46 6f 73 73 69 6c  scm.org/">Fossil
0eb0: 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6d   configuration m
0ec0: 61 6e 61 67 65 6d 65 6e 74 0a 2a 2a 20 73 79 73  anagement.** sys
0ed0: 74 65 6d 3c 2f 61 3e 2e 20 20 5e 54 68 65 20 53  tem</a>.  ^The S
0ee0: 51 4c 49 54 45 5f 53 4f 55 52 43 45 5f 49 44 20  QLITE_SOURCE_ID 
0ef0: 6d 61 63 72 6f 20 65 76 61 6c 75 61 74 65 73 20  macro evaluates 
0f00: 74 6f 0a 2a 2a 20 61 20 73 74 72 69 6e 67 20 77  to.** a string w
0f10: 68 69 63 68 20 69 64 65 6e 74 69 66 69 65 73 20  hich identifies 
0f20: 61 20 70 61 72 74 69 63 75 6c 61 72 20 63 68 65  a particular che
0f30: 63 6b 2d 69 6e 20 6f 66 20 53 51 4c 69 74 65 0a  ck-in of SQLite.
0f40: 2a 2a 20 77 69 74 68 69 6e 20 69 74 73 20 63 6f  ** within its co
0f50: 6e 66 69 67 75 72 61 74 69 6f 6e 20 6d 61 6e 61  nfiguration mana
0f60: 67 65 6d 65 6e 74 20 73 79 73 74 65 6d 2e 20 20  gement system.  
0f70: 5e 54 68 65 20 53 51 4c 49 54 45 5f 53 4f 55 52  ^The SQLITE_SOUR
0f80: 43 45 5f 49 44 0a 2a 2a 20 73 74 72 69 6e 67 20  CE_ID.** string 
0f90: 63 6f 6e 74 61 69 6e 73 20 74 68 65 20 64 61 74  contains the dat
0fa0: 65 20 61 6e 64 20 74 69 6d 65 20 6f 66 20 74 68  e and time of th
0fb0: 65 20 63 68 65 63 6b 2d 69 6e 20 28 55 54 43 29  e check-in (UTC)
0fc0: 20 61 6e 64 20 61 6e 20 53 48 41 31 0a 2a 2a 20   and an SHA1.** 
0fd0: 68 61 73 68 20 6f 66 20 74 68 65 20 65 6e 74 69  hash of the enti
0fe0: 72 65 20 73 6f 75 72 63 65 20 74 72 65 65 2e 0a  re source tree..
0ff0: 2a 2a 0a 2a 2a 20 53 65 65 20 61 6c 73 6f 3a 20  **.** See also: 
1000: 5b 73 71 6c 69 74 65 33 5f 6c 69 62 76 65 72 73  [sqlite3_libvers
1010: 69 6f 6e 28 29 5d 2c 0a 2a 2a 20 5b 73 71 6c 69  ion()],.** [sqli
1020: 74 65 33 5f 6c 69 62 76 65 72 73 69 6f 6e 5f 6e  te3_libversion_n
1030: 75 6d 62 65 72 28 29 5d 2c 20 5b 73 71 6c 69 74  umber()], [sqlit
1040: 65 33 5f 73 6f 75 72 63 65 69 64 28 29 5d 2c 0a  e3_sourceid()],.
1050: 2a 2a 20 5b 73 71 6c 69 74 65 5f 76 65 72 73 69  ** [sqlite_versi
1060: 6f 6e 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74  on()] and [sqlit
1070: 65 5f 73 6f 75 72 63 65 5f 69 64 28 29 5d 2e 0a  e_source_id()]..
1080: 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
1090: 45 5f 56 45 52 53 49 4f 4e 20 20 20 20 20 20 20  E_VERSION       
10a0: 20 22 2d 2d 56 45 52 53 2d 2d 22 0a 23 64 65 66   "--VERS--".#def
10b0: 69 6e 65 20 53 51 4c 49 54 45 5f 56 45 52 53 49  ine SQLITE_VERSI
10c0: 4f 4e 5f 4e 55 4d 42 45 52 20 2d 2d 56 45 52 53  ON_NUMBER --VERS
10d0: 49 4f 4e 2d 4e 55 4d 42 45 52 2d 2d 0a 23 64 65  ION-NUMBER--.#de
10e0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 53 4f 55 52  fine SQLITE_SOUR
10f0: 43 45 5f 49 44 20 20 20 20 20 20 22 2d 2d 53 4f  CE_ID      "--SO
1100: 55 52 43 45 2d 49 44 2d 2d 22 0a 0a 2f 2a 0a 2a  URCE-ID--"../*.*
1110: 2a 20 43 41 50 49 33 52 45 46 3a 20 52 75 6e 2d  * CAPI3REF: Run-
1120: 54 69 6d 65 20 4c 69 62 72 61 72 79 20 56 65 72  Time Library Ver
1130: 73 69 6f 6e 20 4e 75 6d 62 65 72 73 0a 2a 2a 20  sion Numbers.** 
1140: 4b 45 59 57 4f 52 44 53 3a 20 73 71 6c 69 74 65  KEYWORDS: sqlite
1150: 33 5f 76 65 72 73 69 6f 6e 2c 20 73 71 6c 69 74  3_version, sqlit
1160: 65 33 5f 73 6f 75 72 63 65 69 64 0a 2a 2a 0a 2a  e3_sourceid.**.*
1170: 2a 20 54 68 65 73 65 20 69 6e 74 65 72 66 61 63  * These interfac
1180: 65 73 20 70 72 6f 76 69 64 65 20 74 68 65 20 73  es provide the s
1190: 61 6d 65 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20  ame information 
11a0: 61 73 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 56  as the [SQLITE_V
11b0: 45 52 53 49 4f 4e 5d 2c 0a 2a 2a 20 5b 53 51 4c  ERSION],.** [SQL
11c0: 49 54 45 5f 56 45 52 53 49 4f 4e 5f 4e 55 4d 42  ITE_VERSION_NUMB
11d0: 45 52 5d 2c 20 61 6e 64 20 5b 53 51 4c 49 54 45  ER], and [SQLITE
11e0: 5f 53 4f 55 52 43 45 5f 49 44 5d 20 43 20 70 72  _SOURCE_ID] C pr
11f0: 65 70 72 6f 63 65 73 73 6f 72 20 6d 61 63 72 6f  eprocessor macro
1200: 73 0a 2a 2a 20 62 75 74 20 61 72 65 20 61 73 73  s.** but are ass
1210: 6f 63 69 61 74 65 64 20 77 69 74 68 20 74 68 65  ociated with the
1220: 20 6c 69 62 72 61 72 79 20 69 6e 73 74 65 61 64   library instead
1230: 20 6f 66 20 74 68 65 20 68 65 61 64 65 72 20 66   of the header f
1240: 69 6c 65 2e 20 20 5e 28 43 61 75 74 69 6f 75 73  ile.  ^(Cautious
1250: 0a 2a 2a 20 70 72 6f 67 72 61 6d 6d 65 72 73 20  .** programmers 
1260: 6d 69 67 68 74 20 69 6e 63 6c 75 64 65 20 61 73  might include as
1270: 73 65 72 74 28 29 20 73 74 61 74 65 6d 65 6e 74  sert() statement
1280: 73 20 69 6e 20 74 68 65 69 72 20 61 70 70 6c 69  s in their appli
1290: 63 61 74 69 6f 6e 20 74 6f 0a 2a 2a 20 76 65 72  cation to.** ver
12a0: 69 66 79 20 74 68 61 74 20 76 61 6c 75 65 73 20  ify that values 
12b0: 72 65 74 75 72 6e 65 64 20 62 79 20 74 68 65 73  returned by thes
12c0: 65 20 69 6e 74 65 72 66 61 63 65 73 20 6d 61 74  e interfaces mat
12d0: 63 68 20 74 68 65 20 6d 61 63 72 6f 73 20 69 6e  ch the macros in
12e0: 0a 2a 2a 20 74 68 65 20 68 65 61 64 65 72 2c 20  .** the header, 
12f0: 61 6e 64 20 74 68 75 73 20 65 6e 73 75 72 65 20  and thus ensure 
1300: 74 68 61 74 20 74 68 65 20 61 70 70 6c 69 63 61  that the applica
1310: 74 69 6f 6e 20 69 73 0a 2a 2a 20 63 6f 6d 70 69  tion is.** compi
1320: 6c 65 64 20 77 69 74 68 20 6d 61 74 63 68 69 6e  led with matchin
1330: 67 20 6c 69 62 72 61 72 79 20 61 6e 64 20 68 65  g library and he
1340: 61 64 65 72 20 66 69 6c 65 73 2e 0a 2a 2a 0a 2a  ader files..**.*
1350: 2a 20 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70  * <blockquote><p
1360: 72 65 3e 0a 2a 2a 20 61 73 73 65 72 74 28 20 73  re>.** assert( s
1370: 71 6c 69 74 65 33 5f 6c 69 62 76 65 72 73 69 6f  qlite3_libversio
1380: 6e 5f 6e 75 6d 62 65 72 28 29 3d 3d 53 51 4c 49  n_number()==SQLI
1390: 54 45 5f 56 45 52 53 49 4f 4e 5f 4e 55 4d 42 45  TE_VERSION_NUMBE
13a0: 52 20 29 3b 0a 2a 2a 20 61 73 73 65 72 74 28 20  R );.** assert( 
13b0: 73 74 72 63 6d 70 28 73 71 6c 69 74 65 33 5f 73  strcmp(sqlite3_s
13c0: 6f 75 72 63 65 69 64 28 29 2c 53 51 4c 49 54 45  ourceid(),SQLITE
13d0: 5f 53 4f 55 52 43 45 5f 49 44 29 3d 3d 30 20 29  _SOURCE_ID)==0 )
13e0: 3b 0a 2a 2a 20 61 73 73 65 72 74 28 20 73 74 72  ;.** assert( str
13f0: 63 6d 70 28 73 71 6c 69 74 65 33 5f 6c 69 62 76  cmp(sqlite3_libv
1400: 65 72 73 69 6f 6e 28 29 2c 53 51 4c 49 54 45 5f  ersion(),SQLITE_
1410: 56 45 52 53 49 4f 4e 29 3d 3d 30 20 29 3b 0a 2a  VERSION)==0 );.*
1420: 2a 20 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71  * </pre></blockq
1430: 75 6f 74 65 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 54  uote>)^.**.** ^T
1440: 68 65 20 73 71 6c 69 74 65 33 5f 76 65 72 73 69  he sqlite3_versi
1450: 6f 6e 5b 5d 20 73 74 72 69 6e 67 20 63 6f 6e 73  on[] string cons
1460: 74 61 6e 74 20 63 6f 6e 74 61 69 6e 73 20 74 68  tant contains th
1470: 65 20 74 65 78 74 20 6f 66 20 5b 53 51 4c 49 54  e text of [SQLIT
1480: 45 5f 56 45 52 53 49 4f 4e 5d 0a 2a 2a 20 6d 61  E_VERSION].** ma
1490: 63 72 6f 2e 20 20 5e 54 68 65 20 73 71 6c 69 74  cro.  ^The sqlit
14a0: 65 33 5f 6c 69 62 76 65 72 73 69 6f 6e 28 29 20  e3_libversion() 
14b0: 66 75 6e 63 74 69 6f 6e 20 72 65 74 75 72 6e 73  function returns
14c0: 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 74 68   a pointer to th
14d0: 65 0a 2a 2a 20 74 6f 20 74 68 65 20 73 71 6c 69  e.** to the sqli
14e0: 74 65 33 5f 76 65 72 73 69 6f 6e 5b 5d 20 73 74  te3_version[] st
14f0: 72 69 6e 67 20 63 6f 6e 73 74 61 6e 74 2e 20 20  ring constant.  
1500: 54 68 65 20 73 71 6c 69 74 65 33 5f 6c 69 62 76  The sqlite3_libv
1510: 65 72 73 69 6f 6e 28 29 0a 2a 2a 20 66 75 6e 63  ersion().** func
1520: 74 69 6f 6e 20 69 73 20 70 72 6f 76 69 64 65 64  tion is provided
1530: 20 66 6f 72 20 75 73 65 20 69 6e 20 44 4c 4c 73   for use in DLLs
1540: 20 73 69 6e 63 65 20 44 4c 4c 20 75 73 65 72 73   since DLL users
1550: 20 75 73 75 61 6c 6c 79 20 64 6f 20 6e 6f 74 20   usually do not 
1560: 68 61 76 65 0a 2a 2a 20 64 69 72 65 63 74 20 61  have.** direct a
1570: 63 63 65 73 73 20 74 6f 20 73 74 72 69 6e 67 20  ccess to string 
1580: 63 6f 6e 73 74 61 6e 74 73 20 77 69 74 68 69 6e  constants within
1590: 20 74 68 65 20 44 4c 4c 2e 20 20 5e 54 68 65 0a   the DLL.  ^The.
15a0: 2a 2a 20 73 71 6c 69 74 65 33 5f 6c 69 62 76 65  ** sqlite3_libve
15b0: 72 73 69 6f 6e 5f 6e 75 6d 62 65 72 28 29 20 66  rsion_number() f
15c0: 75 6e 63 74 69 6f 6e 20 72 65 74 75 72 6e 73 20  unction returns 
15d0: 61 6e 20 69 6e 74 65 67 65 72 20 65 71 75 61 6c  an integer equal
15e0: 20 74 6f 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 56   to.** [SQLITE_V
15f0: 45 52 53 49 4f 4e 5f 4e 55 4d 42 45 52 5d 2e 20  ERSION_NUMBER]. 
1600: 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 73 6f   ^The sqlite3_so
1610: 75 72 63 65 69 64 28 29 20 66 75 6e 63 74 69 6f  urceid() functio
1620: 6e 20 72 65 74 75 72 6e 73 20 0a 2a 2a 20 61 20  n returns .** a 
1630: 70 6f 69 6e 74 65 72 20 74 6f 20 61 20 73 74 72  pointer to a str
1640: 69 6e 67 20 63 6f 6e 73 74 61 6e 74 20 77 68 6f  ing constant who
1650: 73 65 20 76 61 6c 75 65 20 69 73 20 74 68 65 20  se value is the 
1660: 73 61 6d 65 20 61 73 20 74 68 65 20 0a 2a 2a 20  same as the .** 
1670: 5b 53 51 4c 49 54 45 5f 53 4f 55 52 43 45 5f 49  [SQLITE_SOURCE_I
1680: 44 5d 20 43 20 70 72 65 70 72 6f 63 65 73 73 6f  D] C preprocesso
1690: 72 20 6d 61 63 72 6f 2e 0a 2a 2a 0a 2a 2a 20 53  r macro..**.** S
16a0: 65 65 20 61 6c 73 6f 3a 20 5b 73 71 6c 69 74 65  ee also: [sqlite
16b0: 5f 76 65 72 73 69 6f 6e 28 29 5d 20 61 6e 64 20  _version()] and 
16c0: 5b 73 71 6c 69 74 65 5f 73 6f 75 72 63 65 5f 69  [sqlite_source_i
16d0: 64 28 29 5d 2e 0a 2a 2f 0a 53 51 4c 49 54 45 5f  d()]..*/.SQLITE_
16e0: 45 58 54 45 52 4e 20 63 6f 6e 73 74 20 63 68 61  EXTERN const cha
16f0: 72 20 73 71 6c 69 74 65 33 5f 76 65 72 73 69 6f  r sqlite3_versio
1700: 6e 5b 5d 3b 0a 63 6f 6e 73 74 20 63 68 61 72 20  n[];.const char 
1710: 2a 73 71 6c 69 74 65 33 5f 6c 69 62 76 65 72 73  *sqlite3_libvers
1720: 69 6f 6e 28 76 6f 69 64 29 3b 0a 63 6f 6e 73 74  ion(void);.const
1730: 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f 73   char *sqlite3_s
1740: 6f 75 72 63 65 69 64 28 76 6f 69 64 29 3b 0a 69  ourceid(void);.i
1750: 6e 74 20 73 71 6c 69 74 65 33 5f 6c 69 62 76 65  nt sqlite3_libve
1760: 72 73 69 6f 6e 5f 6e 75 6d 62 65 72 28 76 6f 69  rsion_number(voi
1770: 64 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33  d);../*.** CAPI3
1780: 52 45 46 3a 20 52 75 6e 2d 54 69 6d 65 20 4c 69  REF: Run-Time Li
1790: 62 72 61 72 79 20 43 6f 6d 70 69 6c 61 74 69 6f  brary Compilatio
17a0: 6e 20 4f 70 74 69 6f 6e 73 20 44 69 61 67 6e 6f  n Options Diagno
17b0: 73 74 69 63 73 0a 2a 2a 0a 2a 2a 20 5e 54 68 65  stics.**.** ^The
17c0: 20 73 71 6c 69 74 65 33 5f 63 6f 6d 70 69 6c 65   sqlite3_compile
17d0: 6f 70 74 69 6f 6e 5f 75 73 65 64 28 29 20 66 75  option_used() fu
17e0: 6e 63 74 69 6f 6e 20 72 65 74 75 72 6e 73 20 30  nction returns 0
17f0: 20 6f 72 20 31 20 0a 2a 2a 20 69 6e 64 69 63 61   or 1 .** indica
1800: 74 69 6e 67 20 77 68 65 74 68 65 72 20 74 68 65  ting whether the
1810: 20 73 70 65 63 69 66 69 65 64 20 6f 70 74 69 6f   specified optio
1820: 6e 20 77 61 73 20 64 65 66 69 6e 65 64 20 61 74  n was defined at
1830: 20 0a 2a 2a 20 63 6f 6d 70 69 6c 65 20 74 69 6d   .** compile tim
1840: 65 2e 20 20 5e 54 68 65 20 53 51 4c 49 54 45 5f  e.  ^The SQLITE_
1850: 20 70 72 65 66 69 78 20 6d 61 79 20 62 65 20 6f   prefix may be o
1860: 6d 69 74 74 65 64 20 66 72 6f 6d 20 74 68 65 20  mitted from the 
1870: 0a 2a 2a 20 6f 70 74 69 6f 6e 20 6e 61 6d 65 20  .** option name 
1880: 70 61 73 73 65 64 20 74 6f 20 73 71 6c 69 74 65  passed to sqlite
1890: 33 5f 63 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f  3_compileoption_
18a0: 75 73 65 64 28 29 2e 20 20 0a 2a 2a 0a 2a 2a 20  used().  .**.** 
18b0: 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 63 6f 6d  ^The sqlite3_com
18c0: 70 69 6c 65 6f 70 74 69 6f 6e 5f 67 65 74 28 29  pileoption_get()
18d0: 20 66 75 6e 63 74 69 6f 6e 20 61 6c 6c 6f 77 73   function allows
18e0: 20 69 74 65 72 61 74 69 6e 67 0a 2a 2a 20 6f 76   iterating.** ov
18f0: 65 72 20 74 68 65 20 6c 69 73 74 20 6f 66 20 6f  er the list of o
1900: 70 74 69 6f 6e 73 20 74 68 61 74 20 77 65 72 65  ptions that were
1910: 20 64 65 66 69 6e 65 64 20 61 74 20 63 6f 6d 70   defined at comp
1920: 69 6c 65 20 74 69 6d 65 20 62 79 0a 2a 2a 20 72  ile time by.** r
1930: 65 74 75 72 6e 69 6e 67 20 74 68 65 20 4e 2d 74  eturning the N-t
1940: 68 20 63 6f 6d 70 69 6c 65 20 74 69 6d 65 20 6f  h compile time o
1950: 70 74 69 6f 6e 20 73 74 72 69 6e 67 2e 20 20 5e  ption string.  ^
1960: 49 66 20 4e 20 69 73 20 6f 75 74 20 6f 66 20 72  If N is out of r
1970: 61 6e 67 65 2c 0a 2a 2a 20 73 71 6c 69 74 65 33  ange,.** sqlite3
1980: 5f 63 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f 67  _compileoption_g
1990: 65 74 28 29 20 72 65 74 75 72 6e 73 20 61 20 4e  et() returns a N
19a0: 55 4c 4c 20 70 6f 69 6e 74 65 72 2e 20 20 5e 54  ULL pointer.  ^T
19b0: 68 65 20 53 51 4c 49 54 45 5f 20 0a 2a 2a 20 70  he SQLITE_ .** p
19c0: 72 65 66 69 78 20 69 73 20 6f 6d 69 74 74 65 64  refix is omitted
19d0: 20 66 72 6f 6d 20 61 6e 79 20 73 74 72 69 6e 67   from any string
19e0: 73 20 72 65 74 75 72 6e 65 64 20 62 79 20 0a 2a  s returned by .*
19f0: 2a 20 73 71 6c 69 74 65 33 5f 63 6f 6d 70 69 6c  * sqlite3_compil
1a00: 65 6f 70 74 69 6f 6e 5f 67 65 74 28 29 2e 0a 2a  eoption_get()..*
1a10: 2a 0a 2a 2a 20 5e 53 75 70 70 6f 72 74 20 66 6f  *.** ^Support fo
1a20: 72 20 74 68 65 20 64 69 61 67 6e 6f 73 74 69 63  r the diagnostic
1a30: 20 66 75 6e 63 74 69 6f 6e 73 20 73 71 6c 69 74   functions sqlit
1a40: 65 33 5f 63 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e  e3_compileoption
1a50: 5f 75 73 65 64 28 29 0a 2a 2a 20 61 6e 64 20 73  _used().** and s
1a60: 71 6c 69 74 65 33 5f 63 6f 6d 70 69 6c 65 6f 70  qlite3_compileop
1a70: 74 69 6f 6e 5f 67 65 74 28 29 20 6d 61 79 20 62  tion_get() may b
1a80: 65 20 6f 6d 69 74 74 65 64 20 62 79 20 73 70 65  e omitted by spe
1a90: 63 69 66 79 69 6e 67 20 74 68 65 20 0a 2a 2a 20  cifying the .** 
1aa0: 5b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 43 4f 4d  [SQLITE_OMIT_COM
1ab0: 50 49 4c 45 4f 50 54 49 4f 4e 5f 44 49 41 47 53  PILEOPTION_DIAGS
1ac0: 5d 20 6f 70 74 69 6f 6e 20 61 74 20 63 6f 6d 70  ] option at comp
1ad0: 69 6c 65 20 74 69 6d 65 2e 0a 2a 2a 0a 2a 2a 20  ile time..**.** 
1ae0: 53 65 65 20 61 6c 73 6f 3a 20 53 51 4c 20 66 75  See also: SQL fu
1af0: 6e 63 74 69 6f 6e 73 20 5b 73 71 6c 69 74 65 5f  nctions [sqlite_
1b00: 63 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f 75 73  compileoption_us
1b10: 65 64 28 29 5d 20 61 6e 64 0a 2a 2a 20 5b 73 71  ed()] and.** [sq
1b20: 6c 69 74 65 5f 63 6f 6d 70 69 6c 65 6f 70 74 69  lite_compileopti
1b30: 6f 6e 5f 67 65 74 28 29 5d 20 61 6e 64 20 74 68  on_get()] and th
1b40: 65 20 5b 63 6f 6d 70 69 6c 65 5f 6f 70 74 69 6f  e [compile_optio
1b50: 6e 73 20 70 72 61 67 6d 61 5d 2e 0a 2a 2f 0a 23  ns pragma]..*/.#
1b60: 69 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 4f 4d  ifndef SQLITE_OM
1b70: 49 54 5f 43 4f 4d 50 49 4c 45 4f 50 54 49 4f 4e  IT_COMPILEOPTION
1b80: 5f 44 49 41 47 53 0a 69 6e 74 20 73 71 6c 69 74  _DIAGS.int sqlit
1b90: 65 33 5f 63 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e  e3_compileoption
1ba0: 5f 75 73 65 64 28 63 6f 6e 73 74 20 63 68 61 72  _used(const char
1bb0: 20 2a 7a 4f 70 74 4e 61 6d 65 29 3b 0a 63 6f 6e   *zOptName);.con
1bc0: 73 74 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33  st char *sqlite3
1bd0: 5f 63 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f 67  _compileoption_g
1be0: 65 74 28 69 6e 74 20 4e 29 3b 0a 23 65 6e 64 69  et(int N);.#endi
1bf0: 66 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  f../*.** CAPI3RE
1c00: 46 3a 20 54 65 73 74 20 54 6f 20 53 65 65 20 49  F: Test To See I
1c10: 66 20 54 68 65 20 4c 69 62 72 61 72 79 20 49 73  f The Library Is
1c20: 20 54 68 72 65 61 64 73 61 66 65 0a 2a 2a 0a 2a   Threadsafe.**.*
1c30: 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 74  * ^The sqlite3_t
1c40: 68 72 65 61 64 73 61 66 65 28 29 20 66 75 6e 63  hreadsafe() func
1c50: 74 69 6f 6e 20 72 65 74 75 72 6e 73 20 7a 65 72  tion returns zer
1c60: 6f 20 69 66 20 61 6e 64 20 6f 6e 6c 79 20 69 66  o if and only if
1c70: 0a 2a 2a 20 53 51 4c 69 74 65 20 77 61 73 20 63  .** SQLite was c
1c80: 6f 6d 70 69 6c 65 64 20 77 69 74 68 20 6d 75 74  ompiled with mut
1c90: 65 78 69 6e 67 20 63 6f 64 65 20 6f 6d 69 74 74  exing code omitt
1ca0: 65 64 20 64 75 65 20 74 6f 20 74 68 65 0a 2a 2a  ed due to the.**
1cb0: 20 5b 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53   [SQLITE_THREADS
1cc0: 41 46 45 5d 20 63 6f 6d 70 69 6c 65 2d 74 69 6d  AFE] compile-tim
1cd0: 65 20 6f 70 74 69 6f 6e 20 62 65 69 6e 67 20 73  e option being s
1ce0: 65 74 20 74 6f 20 30 2e 0a 2a 2a 0a 2a 2a 20 53  et to 0..**.** S
1cf0: 51 4c 69 74 65 20 63 61 6e 20 62 65 20 63 6f 6d  QLite can be com
1d00: 70 69 6c 65 64 20 77 69 74 68 20 6f 72 20 77 69  piled with or wi
1d10: 74 68 6f 75 74 20 6d 75 74 65 78 65 73 2e 20 20  thout mutexes.  
1d20: 57 68 65 6e 0a 2a 2a 20 74 68 65 20 5b 53 51 4c  When.** the [SQL
1d30: 49 54 45 5f 54 48 52 45 41 44 53 41 46 45 5d 20  ITE_THREADSAFE] 
1d40: 43 20 70 72 65 70 72 6f 63 65 73 73 6f 72 20 6d  C preprocessor m
1d50: 61 63 72 6f 20 69 73 20 31 20 6f 72 20 32 2c 20  acro is 1 or 2, 
1d60: 6d 75 74 65 78 65 73 0a 2a 2a 20 61 72 65 20 65  mutexes.** are e
1d70: 6e 61 62 6c 65 64 20 61 6e 64 20 53 51 4c 69 74  nabled and SQLit
1d80: 65 20 69 73 20 74 68 72 65 61 64 73 61 66 65 2e  e is threadsafe.
1d90: 20 20 57 68 65 6e 20 74 68 65 0a 2a 2a 20 5b 53    When the.** [S
1da0: 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46 45  QLITE_THREADSAFE
1db0: 5d 20 6d 61 63 72 6f 20 69 73 20 30 2c 20 0a 2a  ] macro is 0, .*
1dc0: 2a 20 74 68 65 20 6d 75 74 65 78 65 73 20 61 72  * the mutexes ar
1dd0: 65 20 6f 6d 69 74 74 65 64 2e 20 20 57 69 74 68  e omitted.  With
1de0: 6f 75 74 20 74 68 65 20 6d 75 74 65 78 65 73 2c  out the mutexes,
1df0: 20 69 74 20 69 73 20 6e 6f 74 20 73 61 66 65 0a   it is not safe.
1e00: 2a 2a 20 74 6f 20 75 73 65 20 53 51 4c 69 74 65  ** to use SQLite
1e10: 20 63 6f 6e 63 75 72 72 65 6e 74 6c 79 20 66 72   concurrently fr
1e20: 6f 6d 20 6d 6f 72 65 20 74 68 61 6e 20 6f 6e 65  om more than one
1e30: 20 74 68 72 65 61 64 2e 0a 2a 2a 0a 2a 2a 20 45   thread..**.** E
1e40: 6e 61 62 6c 69 6e 67 20 6d 75 74 65 78 65 73 20  nabling mutexes 
1e50: 69 6e 63 75 72 73 20 61 20 6d 65 61 73 75 72 61  incurs a measura
1e60: 62 6c 65 20 70 65 72 66 6f 72 6d 61 6e 63 65 20  ble performance 
1e70: 70 65 6e 61 6c 74 79 2e 0a 2a 2a 20 53 6f 20 69  penalty..** So i
1e80: 66 20 73 70 65 65 64 20 69 73 20 6f 66 20 75 74  f speed is of ut
1e90: 6d 6f 73 74 20 69 6d 70 6f 72 74 61 6e 63 65 2c  most importance,
1ea0: 20 69 74 20 6d 61 6b 65 73 20 73 65 6e 73 65 20   it makes sense 
1eb0: 74 6f 20 64 69 73 61 62 6c 65 0a 2a 2a 20 74 68  to disable.** th
1ec0: 65 20 6d 75 74 65 78 65 73 2e 20 20 42 75 74 20  e mutexes.  But 
1ed0: 66 6f 72 20 6d 61 78 69 6d 75 6d 20 73 61 66 65  for maximum safe
1ee0: 74 79 2c 20 6d 75 74 65 78 65 73 20 73 68 6f 75  ty, mutexes shou
1ef0: 6c 64 20 62 65 20 65 6e 61 62 6c 65 64 2e 0a 2a  ld be enabled..*
1f00: 2a 20 5e 54 68 65 20 64 65 66 61 75 6c 74 20 62  * ^The default b
1f10: 65 68 61 76 69 6f 72 20 69 73 20 66 6f 72 20 6d  ehavior is for m
1f20: 75 74 65 78 65 73 20 74 6f 20 62 65 20 65 6e 61  utexes to be ena
1f30: 62 6c 65 64 2e 0a 2a 2a 0a 2a 2a 20 54 68 69 73  bled..**.** This
1f40: 20 69 6e 74 65 72 66 61 63 65 20 63 61 6e 20 62   interface can b
1f50: 65 20 75 73 65 64 20 62 79 20 61 6e 20 61 70 70  e used by an app
1f60: 6c 69 63 61 74 69 6f 6e 20 74 6f 20 6d 61 6b 65  lication to make
1f70: 20 73 75 72 65 20 74 68 61 74 20 74 68 65 0a 2a   sure that the.*
1f80: 2a 20 76 65 72 73 69 6f 6e 20 6f 66 20 53 51 4c  * version of SQL
1f90: 69 74 65 20 74 68 61 74 20 69 74 20 69 73 20 6c  ite that it is l
1fa0: 69 6e 6b 69 6e 67 20 61 67 61 69 6e 73 74 20 77  inking against w
1fb0: 61 73 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 68  as compiled with
1fc0: 0a 2a 2a 20 74 68 65 20 64 65 73 69 72 65 64 20  .** the desired 
1fd0: 73 65 74 74 69 6e 67 20 6f 66 20 74 68 65 20 5b  setting of the [
1fe0: 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46  SQLITE_THREADSAF
1ff0: 45 5d 20 6d 61 63 72 6f 2e 0a 2a 2a 0a 2a 2a 20  E] macro..**.** 
2000: 54 68 69 73 20 69 6e 74 65 72 66 61 63 65 20 6f  This interface o
2010: 6e 6c 79 20 72 65 70 6f 72 74 73 20 6f 6e 20 74  nly reports on t
2020: 68 65 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20  he compile-time 
2030: 6d 75 74 65 78 20 73 65 74 74 69 6e 67 0a 2a 2a  mutex setting.**
2040: 20 6f 66 20 74 68 65 20 5b 53 51 4c 49 54 45 5f   of the [SQLITE_
2050: 54 48 52 45 41 44 53 41 46 45 5d 20 66 6c 61 67  THREADSAFE] flag
2060: 2e 20 20 49 66 20 53 51 4c 69 74 65 20 69 73 20  .  If SQLite is 
2070: 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 0a 2a 2a  compiled with.**
2080: 20 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41   SQLITE_THREADSA
2090: 46 45 3d 31 20 6f 72 20 3d 32 20 74 68 65 6e 20  FE=1 or =2 then 
20a0: 6d 75 74 65 78 65 73 20 61 72 65 20 65 6e 61 62  mutexes are enab
20b0: 6c 65 64 20 62 79 20 64 65 66 61 75 6c 74 20 62  led by default b
20c0: 75 74 0a 2a 2a 20 63 61 6e 20 62 65 20 66 75 6c  ut.** can be ful
20d0: 6c 79 20 6f 72 20 70 61 72 74 69 61 6c 6c 79 20  ly or partially 
20e0: 64 69 73 61 62 6c 65 64 20 75 73 69 6e 67 20 61  disabled using a
20f0: 20 63 61 6c 6c 20 74 6f 20 5b 73 71 6c 69 74 65   call to [sqlite
2100: 33 5f 63 6f 6e 66 69 67 28 29 5d 0a 2a 2a 20 77  3_config()].** w
2110: 69 74 68 20 74 68 65 20 76 65 72 62 73 20 5b 53  ith the verbs [S
2120: 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53 49 4e  QLITE_CONFIG_SIN
2130: 47 4c 45 54 48 52 45 41 44 5d 2c 20 5b 53 51 4c  GLETHREAD], [SQL
2140: 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 55 4c 54 49  ITE_CONFIG_MULTI
2150: 54 48 52 45 41 44 5d 2c 0a 2a 2a 20 6f 72 20 5b  THREAD],.** or [
2160: 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53 45  SQLITE_CONFIG_SE
2170: 52 49 41 4c 49 5a 45 44 5d 2e 20 20 5e 28 54 68  RIALIZED].  ^(Th
2180: 65 20 72 65 74 75 72 6e 20 76 61 6c 75 65 20 6f  e return value o
2190: 66 20 74 68 65 0a 2a 2a 20 73 71 6c 69 74 65 33  f the.** sqlite3
21a0: 5f 74 68 72 65 61 64 73 61 66 65 28 29 20 66 75  _threadsafe() fu
21b0: 6e 63 74 69 6f 6e 20 73 68 6f 77 73 20 6f 6e 6c  nction shows onl
21c0: 79 20 74 68 65 20 63 6f 6d 70 69 6c 65 2d 74 69  y the compile-ti
21d0: 6d 65 20 73 65 74 74 69 6e 67 20 6f 66 0a 2a 2a  me setting of.**
21e0: 20 74 68 72 65 61 64 20 73 61 66 65 74 79 2c 20   thread safety, 
21f0: 6e 6f 74 20 61 6e 79 20 72 75 6e 2d 74 69 6d 65  not any run-time
2200: 20 63 68 61 6e 67 65 73 20 74 6f 20 74 68 61 74   changes to that
2210: 20 73 65 74 74 69 6e 67 20 6d 61 64 65 20 62 79   setting made by
2220: 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 63 6f 6e 66  .** sqlite3_conf
2230: 69 67 28 29 2e 20 49 6e 20 6f 74 68 65 72 20 77  ig(). In other w
2240: 6f 72 64 73 2c 20 74 68 65 20 72 65 74 75 72 6e  ords, the return
2250: 20 76 61 6c 75 65 20 66 72 6f 6d 20 73 71 6c 69   value from sqli
2260: 74 65 33 5f 74 68 72 65 61 64 73 61 66 65 28 29  te3_threadsafe()
2270: 0a 2a 2a 20 69 73 20 75 6e 63 68 61 6e 67 65 64  .** is unchanged
2280: 20 62 79 20 63 61 6c 6c 73 20 74 6f 20 73 71 6c   by calls to sql
2290: 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 2e 29 5e  ite3_config().)^
22a0: 0a 2a 2a 0a 2a 2a 20 53 65 65 20 74 68 65 20 5b  .**.** See the [
22b0: 74 68 72 65 61 64 69 6e 67 20 6d 6f 64 65 5d 20  threading mode] 
22c0: 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 66 6f  documentation fo
22d0: 72 20 61 64 64 69 74 69 6f 6e 61 6c 20 69 6e 66  r additional inf
22e0: 6f 72 6d 61 74 69 6f 6e 2e 0a 2a 2f 0a 69 6e 74  ormation..*/.int
22f0: 20 73 71 6c 69 74 65 33 5f 74 68 72 65 61 64 73   sqlite3_threads
2300: 61 66 65 28 76 6f 69 64 29 3b 0a 0a 2f 2a 0a 2a  afe(void);../*.*
2310: 2a 20 43 41 50 49 33 52 45 46 3a 20 44 61 74 61  * CAPI3REF: Data
2320: 62 61 73 65 20 43 6f 6e 6e 65 63 74 69 6f 6e 20  base Connection 
2330: 48 61 6e 64 6c 65 0a 2a 2a 20 4b 45 59 57 4f 52  Handle.** KEYWOR
2340: 44 53 3a 20 7b 64 61 74 61 62 61 73 65 20 63 6f  DS: {database co
2350: 6e 6e 65 63 74 69 6f 6e 7d 20 7b 64 61 74 61 62  nnection} {datab
2360: 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 73 7d  ase connections}
2370: 0a 2a 2a 0a 2a 2a 20 45 61 63 68 20 6f 70 65 6e  .**.** Each open
2380: 20 53 51 4c 69 74 65 20 64 61 74 61 62 61 73 65   SQLite database
2390: 20 69 73 20 72 65 70 72 65 73 65 6e 74 65 64 20   is represented 
23a0: 62 79 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20  by a pointer to 
23b0: 61 6e 20 69 6e 73 74 61 6e 63 65 20 6f 66 0a 2a  an instance of.*
23c0: 2a 20 74 68 65 20 6f 70 61 71 75 65 20 73 74 72  * the opaque str
23d0: 75 63 74 75 72 65 20 6e 61 6d 65 64 20 22 73 71  ucture named "sq
23e0: 6c 69 74 65 33 22 2e 20 20 49 74 20 69 73 20 75  lite3".  It is u
23f0: 73 65 66 75 6c 20 74 6f 20 74 68 69 6e 6b 20 6f  seful to think o
2400: 66 20 61 6e 20 73 71 6c 69 74 65 33 0a 2a 2a 20  f an sqlite3.** 
2410: 70 6f 69 6e 74 65 72 20 61 73 20 61 6e 20 6f 62  pointer as an ob
2420: 6a 65 63 74 2e 20 20 54 68 65 20 5b 73 71 6c 69  ject.  The [sqli
2430: 74 65 33 5f 6f 70 65 6e 28 29 5d 2c 20 5b 73 71  te3_open()], [sq
2440: 6c 69 74 65 33 5f 6f 70 65 6e 31 36 28 29 5d 2c  lite3_open16()],
2450: 20 61 6e 64 0a 2a 2a 20 5b 73 71 6c 69 74 65 33   and.** [sqlite3
2460: 5f 6f 70 65 6e 5f 76 32 28 29 5d 20 69 6e 74 65  _open_v2()] inte
2470: 72 66 61 63 65 73 20 61 72 65 20 69 74 73 20 63  rfaces are its c
2480: 6f 6e 73 74 72 75 63 74 6f 72 73 2c 20 61 6e 64  onstructors, and
2490: 20 5b 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65 28   [sqlite3_close(
24a0: 29 5d 0a 2a 2a 20 61 6e 64 20 5b 73 71 6c 69 74  )].** and [sqlit
24b0: 65 33 5f 63 6c 6f 73 65 5f 76 32 28 29 5d 20 61  e3_close_v2()] a
24c0: 72 65 20 69 74 73 20 64 65 73 74 72 75 63 74 6f  re its destructo
24d0: 72 73 2e 20 20 54 68 65 72 65 20 61 72 65 20 6d  rs.  There are m
24e0: 61 6e 79 20 6f 74 68 65 72 0a 2a 2a 20 69 6e 74  any other.** int
24f0: 65 72 66 61 63 65 73 20 28 73 75 63 68 20 61 73  erfaces (such as
2500: 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 70 72 65  .** [sqlite3_pre
2510: 70 61 72 65 5f 76 32 28 29 5d 2c 20 5b 73 71 6c  pare_v2()], [sql
2520: 69 74 65 33 5f 63 72 65 61 74 65 5f 66 75 6e 63  ite3_create_func
2530: 74 69 6f 6e 28 29 5d 2c 20 61 6e 64 0a 2a 2a 20  tion()], and.** 
2540: 5b 73 71 6c 69 74 65 33 5f 62 75 73 79 5f 74 69  [sqlite3_busy_ti
2550: 6d 65 6f 75 74 28 29 5d 20 74 6f 20 6e 61 6d 65  meout()] to name
2560: 20 62 75 74 20 74 68 72 65 65 29 20 74 68 61 74   but three) that
2570: 20 61 72 65 20 6d 65 74 68 6f 64 73 20 6f 6e 20   are methods on 
2580: 61 6e 0a 2a 2a 20 73 71 6c 69 74 65 33 20 6f 62  an.** sqlite3 ob
2590: 6a 65 63 74 2e 0a 2a 2f 0a 74 79 70 65 64 65 66  ject..*/.typedef
25a0: 20 73 74 72 75 63 74 20 73 71 6c 69 74 65 33 20   struct sqlite3 
25b0: 73 71 6c 69 74 65 33 3b 0a 0a 2f 2a 0a 2a 2a 20  sqlite3;../*.** 
25c0: 43 41 50 49 33 52 45 46 3a 20 36 34 2d 42 69 74  CAPI3REF: 64-Bit
25d0: 20 49 6e 74 65 67 65 72 20 54 79 70 65 73 0a 2a   Integer Types.*
25e0: 2a 20 4b 45 59 57 4f 52 44 53 3a 20 73 71 6c 69  * KEYWORDS: sqli
25f0: 74 65 5f 69 6e 74 36 34 20 73 71 6c 69 74 65 5f  te_int64 sqlite_
2600: 75 69 6e 74 36 34 0a 2a 2a 0a 2a 2a 20 42 65 63  uint64.**.** Bec
2610: 61 75 73 65 20 74 68 65 72 65 20 69 73 20 6e 6f  ause there is no
2620: 20 63 72 6f 73 73 2d 70 6c 61 74 66 6f 72 6d 20   cross-platform 
2630: 77 61 79 20 74 6f 20 73 70 65 63 69 66 79 20 36  way to specify 6
2640: 34 2d 62 69 74 20 69 6e 74 65 67 65 72 20 74 79  4-bit integer ty
2650: 70 65 73 0a 2a 2a 20 53 51 4c 69 74 65 20 69 6e  pes.** SQLite in
2660: 63 6c 75 64 65 73 20 74 79 70 65 64 65 66 73 20  cludes typedefs 
2670: 66 6f 72 20 36 34 2d 62 69 74 20 73 69 67 6e 65  for 64-bit signe
2680: 64 20 61 6e 64 20 75 6e 73 69 67 6e 65 64 20 69  d and unsigned i
2690: 6e 74 65 67 65 72 73 2e 0a 2a 2a 0a 2a 2a 20 54  ntegers..**.** T
26a0: 68 65 20 73 71 6c 69 74 65 33 5f 69 6e 74 36 34  he sqlite3_int64
26b0: 20 61 6e 64 20 73 71 6c 69 74 65 33 5f 75 69 6e   and sqlite3_uin
26c0: 74 36 34 20 61 72 65 20 74 68 65 20 70 72 65 66  t64 are the pref
26d0: 65 72 72 65 64 20 74 79 70 65 20 64 65 66 69 6e  erred type defin
26e0: 69 74 69 6f 6e 73 2e 0a 2a 2a 20 54 68 65 20 73  itions..** The s
26f0: 71 6c 69 74 65 5f 69 6e 74 36 34 20 61 6e 64 20  qlite_int64 and 
2700: 73 71 6c 69 74 65 5f 75 69 6e 74 36 34 20 74 79  sqlite_uint64 ty
2710: 70 65 73 20 61 72 65 20 73 75 70 70 6f 72 74 65  pes are supporte
2720: 64 20 66 6f 72 20 62 61 63 6b 77 61 72 64 73 0a  d for backwards.
2730: 2a 2a 20 63 6f 6d 70 61 74 69 62 69 6c 69 74 79  ** compatibility
2740: 20 6f 6e 6c 79 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68   only..**.** ^Th
2750: 65 20 73 71 6c 69 74 65 33 5f 69 6e 74 36 34 20  e sqlite3_int64 
2760: 61 6e 64 20 73 71 6c 69 74 65 5f 69 6e 74 36 34  and sqlite_int64
2770: 20 74 79 70 65 73 20 63 61 6e 20 73 74 6f 72 65   types can store
2780: 20 69 6e 74 65 67 65 72 20 76 61 6c 75 65 73 0a   integer values.
2790: 2a 2a 20 62 65 74 77 65 65 6e 20 2d 39 32 32 33  ** between -9223
27a0: 33 37 32 30 33 36 38 35 34 37 37 35 38 30 38 20  372036854775808 
27b0: 61 6e 64 20 2b 39 32 32 33 33 37 32 30 33 36 38  and +92233720368
27c0: 35 34 37 37 35 38 30 37 20 69 6e 63 6c 75 73 69  54775807 inclusi
27d0: 76 65 2e 20 20 5e 54 68 65 0a 2a 2a 20 73 71 6c  ve.  ^The.** sql
27e0: 69 74 65 33 5f 75 69 6e 74 36 34 20 61 6e 64 20  ite3_uint64 and 
27f0: 73 71 6c 69 74 65 5f 75 69 6e 74 36 34 20 74 79  sqlite_uint64 ty
2800: 70 65 73 20 63 61 6e 20 73 74 6f 72 65 20 69 6e  pes can store in
2810: 74 65 67 65 72 20 76 61 6c 75 65 73 20 0a 2a 2a  teger values .**
2820: 20 62 65 74 77 65 65 6e 20 30 20 61 6e 64 20 2b   between 0 and +
2830: 31 38 34 34 36 37 34 34 30 37 33 37 30 39 35 35  1844674407370955
2840: 31 36 31 35 20 69 6e 63 6c 75 73 69 76 65 2e 0a  1615 inclusive..
2850: 2a 2f 0a 23 69 66 64 65 66 20 53 51 4c 49 54 45  */.#ifdef SQLITE
2860: 5f 49 4e 54 36 34 5f 54 59 50 45 0a 20 20 74 79  _INT64_TYPE.  ty
2870: 70 65 64 65 66 20 53 51 4c 49 54 45 5f 49 4e 54  pedef SQLITE_INT
2880: 36 34 5f 54 59 50 45 20 73 71 6c 69 74 65 5f 69  64_TYPE sqlite_i
2890: 6e 74 36 34 3b 0a 20 20 74 79 70 65 64 65 66 20  nt64;.  typedef 
28a0: 75 6e 73 69 67 6e 65 64 20 53 51 4c 49 54 45 5f  unsigned SQLITE_
28b0: 49 4e 54 36 34 5f 54 59 50 45 20 73 71 6c 69 74  INT64_TYPE sqlit
28c0: 65 5f 75 69 6e 74 36 34 3b 0a 23 65 6c 69 66 20  e_uint64;.#elif 
28d0: 64 65 66 69 6e 65 64 28 5f 4d 53 43 5f 56 45 52  defined(_MSC_VER
28e0: 29 20 7c 7c 20 64 65 66 69 6e 65 64 28 5f 5f 42  ) || defined(__B
28f0: 4f 52 4c 41 4e 44 43 5f 5f 29 0a 20 20 74 79 70  ORLANDC__).  typ
2900: 65 64 65 66 20 5f 5f 69 6e 74 36 34 20 73 71 6c  edef __int64 sql
2910: 69 74 65 5f 69 6e 74 36 34 3b 0a 20 20 74 79 70  ite_int64;.  typ
2920: 65 64 65 66 20 75 6e 73 69 67 6e 65 64 20 5f 5f  edef unsigned __
2930: 69 6e 74 36 34 20 73 71 6c 69 74 65 5f 75 69 6e  int64 sqlite_uin
2940: 74 36 34 3b 0a 23 65 6c 73 65 0a 20 20 74 79 70  t64;.#else.  typ
2950: 65 64 65 66 20 6c 6f 6e 67 20 6c 6f 6e 67 20 69  edef long long i
2960: 6e 74 20 73 71 6c 69 74 65 5f 69 6e 74 36 34 3b  nt sqlite_int64;
2970: 0a 20 20 74 79 70 65 64 65 66 20 75 6e 73 69 67  .  typedef unsig
2980: 6e 65 64 20 6c 6f 6e 67 20 6c 6f 6e 67 20 69 6e  ned long long in
2990: 74 20 73 71 6c 69 74 65 5f 75 69 6e 74 36 34 3b  t sqlite_uint64;
29a0: 0a 23 65 6e 64 69 66 0a 74 79 70 65 64 65 66 20  .#endif.typedef 
29b0: 73 71 6c 69 74 65 5f 69 6e 74 36 34 20 73 71 6c  sqlite_int64 sql
29c0: 69 74 65 33 5f 69 6e 74 36 34 3b 0a 74 79 70 65  ite3_int64;.type
29d0: 64 65 66 20 73 71 6c 69 74 65 5f 75 69 6e 74 36  def sqlite_uint6
29e0: 34 20 73 71 6c 69 74 65 33 5f 75 69 6e 74 36 34  4 sqlite3_uint64
29f0: 3b 0a 0a 2f 2a 0a 2a 2a 20 49 66 20 63 6f 6d 70  ;../*.** If comp
2a00: 69 6c 69 6e 67 20 66 6f 72 20 61 20 70 72 6f 63  iling for a proc
2a10: 65 73 73 6f 72 20 74 68 61 74 20 6c 61 63 6b 73  essor that lacks
2a20: 20 66 6c 6f 61 74 69 6e 67 20 70 6f 69 6e 74 20   floating point 
2a30: 73 75 70 70 6f 72 74 2c 0a 2a 2a 20 73 75 62 73  support,.** subs
2a40: 74 69 74 75 74 65 20 69 6e 74 65 67 65 72 20 66  titute integer f
2a50: 6f 72 20 66 6c 6f 61 74 69 6e 67 2d 70 6f 69 6e  or floating-poin
2a60: 74 2e 0a 2a 2f 0a 23 69 66 64 65 66 20 53 51 4c  t..*/.#ifdef SQL
2a70: 49 54 45 5f 4f 4d 49 54 5f 46 4c 4f 41 54 49 4e  ITE_OMIT_FLOATIN
2a80: 47 5f 50 4f 49 4e 54 0a 23 20 64 65 66 69 6e 65  G_POINT.# define
2a90: 20 64 6f 75 62 6c 65 20 73 71 6c 69 74 65 33 5f   double sqlite3_
2aa0: 69 6e 74 36 34 0a 23 65 6e 64 69 66 0a 0a 2f 2a  int64.#endif../*
2ab0: 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 43 6c  .** CAPI3REF: Cl
2ac0: 6f 73 69 6e 67 20 41 20 44 61 74 61 62 61 73 65  osing A Database
2ad0: 20 43 6f 6e 6e 65 63 74 69 6f 6e 0a 2a 2a 20 44   Connection.** D
2ae0: 45 53 54 52 55 43 54 4f 52 3a 20 73 71 6c 69 74  ESTRUCTOR: sqlit
2af0: 65 33 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71  e3.**.** ^The sq
2b00: 6c 69 74 65 33 5f 63 6c 6f 73 65 28 29 20 61 6e  lite3_close() an
2b10: 64 20 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65 5f  d sqlite3_close_
2b20: 76 32 28 29 20 72 6f 75 74 69 6e 65 73 20 61 72  v2() routines ar
2b30: 65 20 64 65 73 74 72 75 63 74 6f 72 73 0a 2a 2a  e destructors.**
2b40: 20 66 6f 72 20 74 68 65 20 5b 73 71 6c 69 74 65   for the [sqlite
2b50: 33 5d 20 6f 62 6a 65 63 74 2e 0a 2a 2a 20 5e 43  3] object..** ^C
2b60: 61 6c 6c 73 20 74 6f 20 73 71 6c 69 74 65 33 5f  alls to sqlite3_
2b70: 63 6c 6f 73 65 28 29 20 61 6e 64 20 73 71 6c 69  close() and sqli
2b80: 74 65 33 5f 63 6c 6f 73 65 5f 76 32 28 29 20 72  te3_close_v2() r
2b90: 65 74 75 72 6e 20 5b 53 51 4c 49 54 45 5f 4f 4b  eturn [SQLITE_OK
2ba0: 5d 20 69 66 0a 2a 2a 20 74 68 65 20 5b 73 71 6c  ] if.** the [sql
2bb0: 69 74 65 33 5d 20 6f 62 6a 65 63 74 20 69 73 20  ite3] object is 
2bc0: 73 75 63 63 65 73 73 66 75 6c 6c 79 20 64 65 73  successfully des
2bd0: 74 72 6f 79 65 64 20 61 6e 64 20 61 6c 6c 20 61  troyed and all a
2be0: 73 73 6f 63 69 61 74 65 64 0a 2a 2a 20 72 65 73  ssociated.** res
2bf0: 6f 75 72 63 65 73 20 61 72 65 20 64 65 61 6c 6c  ources are deall
2c00: 6f 63 61 74 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 49  ocated..**.** ^I
2c10: 66 20 74 68 65 20 64 61 74 61 62 61 73 65 20 63  f the database c
2c20: 6f 6e 6e 65 63 74 69 6f 6e 20 69 73 20 61 73 73  onnection is ass
2c30: 6f 63 69 61 74 65 64 20 77 69 74 68 20 75 6e 66  ociated with unf
2c40: 69 6e 61 6c 69 7a 65 64 20 70 72 65 70 61 72 65  inalized prepare
2c50: 64 0a 2a 2a 20 73 74 61 74 65 6d 65 6e 74 73 20  d.** statements 
2c60: 6f 72 20 75 6e 66 69 6e 69 73 68 65 64 20 73 71  or unfinished sq
2c70: 6c 69 74 65 33 5f 62 61 63 6b 75 70 20 6f 62 6a  lite3_backup obj
2c80: 65 63 74 73 20 74 68 65 6e 20 73 71 6c 69 74 65  ects then sqlite
2c90: 33 5f 63 6c 6f 73 65 28 29 0a 2a 2a 20 77 69 6c  3_close().** wil
2ca0: 6c 20 6c 65 61 76 65 20 74 68 65 20 64 61 74 61  l leave the data
2cb0: 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20  base connection 
2cc0: 6f 70 65 6e 20 61 6e 64 20 72 65 74 75 72 6e 20  open and return 
2cd0: 5b 53 51 4c 49 54 45 5f 42 55 53 59 5d 2e 0a 2a  [SQLITE_BUSY]..*
2ce0: 2a 20 5e 49 66 20 73 71 6c 69 74 65 33 5f 63 6c  * ^If sqlite3_cl
2cf0: 6f 73 65 5f 76 32 28 29 20 69 73 20 63 61 6c 6c  ose_v2() is call
2d00: 65 64 20 77 69 74 68 20 75 6e 66 69 6e 61 6c 69  ed with unfinali
2d10: 7a 65 64 20 70 72 65 70 61 72 65 64 20 73 74 61  zed prepared sta
2d20: 74 65 6d 65 6e 74 73 0a 2a 2a 20 61 6e 64 2f 6f  tements.** and/o
2d30: 72 20 75 6e 66 69 6e 69 73 68 65 64 20 73 71 6c  r unfinished sql
2d40: 69 74 65 33 5f 62 61 63 6b 75 70 73 2c 20 74 68  ite3_backups, th
2d50: 65 6e 20 74 68 65 20 64 61 74 61 62 61 73 65 20  en the database 
2d60: 63 6f 6e 6e 65 63 74 69 6f 6e 20 62 65 63 6f 6d  connection becom
2d70: 65 73 0a 2a 2a 20 61 6e 20 75 6e 75 73 61 62 6c  es.** an unusabl
2d80: 65 20 22 7a 6f 6d 62 69 65 22 20 77 68 69 63 68  e "zombie" which
2d90: 20 77 69 6c 6c 20 61 75 74 6f 6d 61 74 69 63 61   will automatica
2da0: 6c 6c 79 20 62 65 20 64 65 61 6c 6c 6f 63 61 74  lly be deallocat
2db0: 65 64 20 77 68 65 6e 20 74 68 65 0a 2a 2a 20 6c  ed when the.** l
2dc0: 61 73 74 20 70 72 65 70 61 72 65 64 20 73 74 61  ast prepared sta
2dd0: 74 65 6d 65 6e 74 20 69 73 20 66 69 6e 61 6c 69  tement is finali
2de0: 7a 65 64 20 6f 72 20 74 68 65 20 6c 61 73 74 20  zed or the last 
2df0: 73 71 6c 69 74 65 33 5f 62 61 63 6b 75 70 20 69  sqlite3_backup i
2e00: 73 0a 2a 2a 20 66 69 6e 69 73 68 65 64 2e 20 20  s.** finished.  
2e10: 54 68 65 20 73 71 6c 69 74 65 33 5f 63 6c 6f 73  The sqlite3_clos
2e20: 65 5f 76 32 28 29 20 69 6e 74 65 72 66 61 63 65  e_v2() interface
2e30: 20 69 73 20 69 6e 74 65 6e 64 65 64 20 66 6f 72   is intended for
2e40: 20 75 73 65 20 77 69 74 68 0a 2a 2a 20 68 6f 73   use with.** hos
2e50: 74 20 6c 61 6e 67 75 61 67 65 73 20 74 68 61 74  t languages that
2e60: 20 61 72 65 20 67 61 72 62 61 67 65 20 63 6f 6c   are garbage col
2e70: 6c 65 63 74 65 64 2c 20 61 6e 64 20 77 68 65 72  lected, and wher
2e80: 65 20 74 68 65 20 6f 72 64 65 72 20 69 6e 20 77  e the order in w
2e90: 68 69 63 68 0a 2a 2a 20 64 65 73 74 72 75 63 74  hich.** destruct
2ea0: 6f 72 73 20 61 72 65 20 63 61 6c 6c 65 64 20 69  ors are called i
2eb0: 73 20 61 72 62 69 74 72 61 72 79 2e 0a 2a 2a 0a  s arbitrary..**.
2ec0: 2a 2a 20 41 70 70 6c 69 63 61 74 69 6f 6e 73 20  ** Applications 
2ed0: 73 68 6f 75 6c 64 20 5b 73 71 6c 69 74 65 33 5f  should [sqlite3_
2ee0: 66 69 6e 61 6c 69 7a 65 20 7c 20 66 69 6e 61 6c  finalize | final
2ef0: 69 7a 65 5d 20 61 6c 6c 20 5b 70 72 65 70 61 72  ize] all [prepar
2f00: 65 64 20 73 74 61 74 65 6d 65 6e 74 73 5d 2c 0a  ed statements],.
2f10: 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 62 6c 6f 62  ** [sqlite3_blob
2f20: 5f 63 6c 6f 73 65 20 7c 20 63 6c 6f 73 65 5d 20  _close | close] 
2f30: 61 6c 6c 20 5b 42 4c 4f 42 20 68 61 6e 64 6c 65  all [BLOB handle
2f40: 73 5d 2c 20 61 6e 64 20 0a 2a 2a 20 5b 73 71 6c  s], and .** [sql
2f50: 69 74 65 33 5f 62 61 63 6b 75 70 5f 66 69 6e 69  ite3_backup_fini
2f60: 73 68 20 7c 20 66 69 6e 69 73 68 5d 20 61 6c 6c  sh | finish] all
2f70: 20 5b 73 71 6c 69 74 65 33 5f 62 61 63 6b 75 70   [sqlite3_backup
2f80: 5d 20 6f 62 6a 65 63 74 73 20 61 73 73 6f 63 69  ] objects associ
2f90: 61 74 65 64 0a 2a 2a 20 77 69 74 68 20 74 68 65  ated.** with the
2fa0: 20 5b 73 71 6c 69 74 65 33 5d 20 6f 62 6a 65 63   [sqlite3] objec
2fb0: 74 20 70 72 69 6f 72 20 74 6f 20 61 74 74 65 6d  t prior to attem
2fc0: 70 74 69 6e 67 20 74 6f 20 63 6c 6f 73 65 20 74  pting to close t
2fd0: 68 65 20 6f 62 6a 65 63 74 2e 20 20 5e 49 66 0a  he object.  ^If.
2fe0: 2a 2a 20 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65  ** sqlite3_close
2ff0: 5f 76 32 28 29 20 69 73 20 63 61 6c 6c 65 64 20  _v2() is called 
3000: 6f 6e 20 61 20 5b 64 61 74 61 62 61 73 65 20 63  on a [database c
3010: 6f 6e 6e 65 63 74 69 6f 6e 5d 20 74 68 61 74 20  onnection] that 
3020: 73 74 69 6c 6c 20 68 61 73 0a 2a 2a 20 6f 75 74  still has.** out
3030: 73 74 61 6e 64 69 6e 67 20 5b 70 72 65 70 61 72  standing [prepar
3040: 65 64 20 73 74 61 74 65 6d 65 6e 74 73 5d 2c 20  ed statements], 
3050: 5b 42 4c 4f 42 20 68 61 6e 64 6c 65 73 5d 2c 20  [BLOB handles], 
3060: 61 6e 64 2f 6f 72 0a 2a 2a 20 5b 73 71 6c 69 74  and/or.** [sqlit
3070: 65 33 5f 62 61 63 6b 75 70 5d 20 6f 62 6a 65 63  e3_backup] objec
3080: 74 73 20 74 68 65 6e 20 69 74 20 72 65 74 75 72  ts then it retur
3090: 6e 73 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d 20 61  ns [SQLITE_OK] a
30a0: 6e 64 20 74 68 65 20 64 65 61 6c 6c 6f 63 61 74  nd the deallocat
30b0: 69 6f 6e 0a 2a 2a 20 6f 66 20 72 65 73 6f 75 72  ion.** of resour
30c0: 63 65 73 20 69 73 20 64 65 66 65 72 72 65 64 20  ces is deferred 
30d0: 75 6e 74 69 6c 20 61 6c 6c 20 5b 70 72 65 70 61  until all [prepa
30e0: 72 65 64 20 73 74 61 74 65 6d 65 6e 74 73 5d 2c  red statements],
30f0: 20 5b 42 4c 4f 42 20 68 61 6e 64 6c 65 73 5d 2c   [BLOB handles],
3100: 0a 2a 2a 20 61 6e 64 20 5b 73 71 6c 69 74 65 33  .** and [sqlite3
3110: 5f 62 61 63 6b 75 70 5d 20 6f 62 6a 65 63 74 73  _backup] objects
3120: 20 61 72 65 20 61 6c 73 6f 20 64 65 73 74 72 6f   are also destro
3130: 79 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 61  yed..**.** ^If a
3140: 6e 20 5b 73 71 6c 69 74 65 33 5d 20 6f 62 6a 65  n [sqlite3] obje
3150: 63 74 20 69 73 20 64 65 73 74 72 6f 79 65 64 20  ct is destroyed 
3160: 77 68 69 6c 65 20 61 20 74 72 61 6e 73 61 63 74  while a transact
3170: 69 6f 6e 20 69 73 20 6f 70 65 6e 2c 0a 2a 2a 20  ion is open,.** 
3180: 74 68 65 20 74 72 61 6e 73 61 63 74 69 6f 6e 20  the transaction 
3190: 69 73 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79  is automatically
31a0: 20 72 6f 6c 6c 65 64 20 62 61 63 6b 2e 0a 2a 2a   rolled back..**
31b0: 0a 2a 2a 20 54 68 65 20 43 20 70 61 72 61 6d 65  .** The C parame
31c0: 74 65 72 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f  ter to [sqlite3_
31d0: 63 6c 6f 73 65 28 43 29 5d 20 61 6e 64 20 5b 73  close(C)] and [s
31e0: 71 6c 69 74 65 33 5f 63 6c 6f 73 65 5f 76 32 28  qlite3_close_v2(
31f0: 43 29 5d 0a 2a 2a 20 6d 75 73 74 20 62 65 20 65  C)].** must be e
3200: 69 74 68 65 72 20 61 20 4e 55 4c 4c 0a 2a 2a 20  ither a NULL.** 
3210: 70 6f 69 6e 74 65 72 20 6f 72 20 61 6e 20 5b 73  pointer or an [s
3220: 71 6c 69 74 65 33 5d 20 6f 62 6a 65 63 74 20 70  qlite3] object p
3230: 6f 69 6e 74 65 72 20 6f 62 74 61 69 6e 65 64 0a  ointer obtained.
3240: 2a 2a 20 66 72 6f 6d 20 5b 73 71 6c 69 74 65 33  ** from [sqlite3
3250: 5f 6f 70 65 6e 28 29 5d 2c 20 5b 73 71 6c 69 74  _open()], [sqlit
3260: 65 33 5f 6f 70 65 6e 31 36 28 29 5d 2c 20 6f 72  e3_open16()], or
3270: 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65  .** [sqlite3_ope
3280: 6e 5f 76 32 28 29 5d 2c 20 61 6e 64 20 6e 6f 74  n_v2()], and not
3290: 20 70 72 65 76 69 6f 75 73 6c 79 20 63 6c 6f 73   previously clos
32a0: 65 64 2e 0a 2a 2a 20 5e 43 61 6c 6c 69 6e 67 20  ed..** ^Calling 
32b0: 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65 28 29 20  sqlite3_close() 
32c0: 6f 72 20 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65  or sqlite3_close
32d0: 5f 76 32 28 29 20 77 69 74 68 20 61 20 4e 55 4c  _v2() with a NUL
32e0: 4c 20 70 6f 69 6e 74 65 72 0a 2a 2a 20 61 72 67  L pointer.** arg
32f0: 75 6d 65 6e 74 20 69 73 20 61 20 68 61 72 6d 6c  ument is a harml
3300: 65 73 73 20 6e 6f 2d 6f 70 2e 0a 2a 2f 0a 69 6e  ess no-op..*/.in
3310: 74 20 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65 28  t sqlite3_close(
3320: 73 71 6c 69 74 65 33 2a 29 3b 0a 69 6e 74 20 73  sqlite3*);.int s
3330: 71 6c 69 74 65 33 5f 63 6c 6f 73 65 5f 76 32 28  qlite3_close_v2(
3340: 73 71 6c 69 74 65 33 2a 29 3b 0a 0a 2f 2a 0a 2a  sqlite3*);../*.*
3350: 2a 20 54 68 65 20 74 79 70 65 20 66 6f 72 20 61  * The type for a
3360: 20 63 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69   callback functi
3370: 6f 6e 2e 0a 2a 2a 20 54 68 69 73 20 69 73 20 6c  on..** This is l
3380: 65 67 61 63 79 20 61 6e 64 20 64 65 70 72 65 63  egacy and deprec
3390: 61 74 65 64 2e 20 20 49 74 20 69 73 20 69 6e 63  ated.  It is inc
33a0: 6c 75 64 65 64 20 66 6f 72 20 68 69 73 74 6f 72  luded for histor
33b0: 69 63 61 6c 0a 2a 2a 20 63 6f 6d 70 61 74 69 62  ical.** compatib
33c0: 69 6c 69 74 79 20 61 6e 64 20 69 73 20 6e 6f 74  ility and is not
33d0: 20 64 6f 63 75 6d 65 6e 74 65 64 2e 0a 2a 2f 0a   documented..*/.
33e0: 74 79 70 65 64 65 66 20 69 6e 74 20 28 2a 73 71  typedef int (*sq
33f0: 6c 69 74 65 33 5f 63 61 6c 6c 62 61 63 6b 29 28  lite3_callback)(
3400: 76 6f 69 64 2a 2c 69 6e 74 2c 63 68 61 72 2a 2a  void*,int,char**
3410: 2c 20 63 68 61 72 2a 2a 29 3b 0a 0a 2f 2a 0a 2a  , char**);../*.*
3420: 2a 20 43 41 50 49 33 52 45 46 3a 20 4f 6e 65 2d  * CAPI3REF: One-
3430: 53 74 65 70 20 51 75 65 72 79 20 45 78 65 63 75  Step Query Execu
3440: 74 69 6f 6e 20 49 6e 74 65 72 66 61 63 65 0a 2a  tion Interface.*
3450: 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65  * METHOD: sqlite
3460: 33 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69  3.**.** The sqli
3470: 74 65 33 5f 65 78 65 63 28 29 20 69 6e 74 65 72  te3_exec() inter
3480: 66 61 63 65 20 69 73 20 61 20 63 6f 6e 76 65 6e  face is a conven
3490: 69 65 6e 63 65 20 77 72 61 70 70 65 72 20 61 72  ience wrapper ar
34a0: 6f 75 6e 64 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  ound.** [sqlite3
34b0: 5f 70 72 65 70 61 72 65 5f 76 32 28 29 5d 2c 20  _prepare_v2()], 
34c0: 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d  [sqlite3_step()]
34d0: 2c 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 66  , and [sqlite3_f
34e0: 69 6e 61 6c 69 7a 65 28 29 5d 2c 0a 2a 2a 20 74  inalize()],.** t
34f0: 68 61 74 20 61 6c 6c 6f 77 73 20 61 6e 20 61 70  hat allows an ap
3500: 70 6c 69 63 61 74 69 6f 6e 20 74 6f 20 72 75 6e  plication to run
3510: 20 6d 75 6c 74 69 70 6c 65 20 73 74 61 74 65 6d   multiple statem
3520: 65 6e 74 73 20 6f 66 20 53 51 4c 0a 2a 2a 20 77  ents of SQL.** w
3530: 69 74 68 6f 75 74 20 68 61 76 69 6e 67 20 74 6f  ithout having to
3540: 20 75 73 65 20 61 20 6c 6f 74 20 6f 66 20 43 20   use a lot of C 
3550: 63 6f 64 65 2e 20 0a 2a 2a 0a 2a 2a 20 5e 54 68  code. .**.** ^Th
3560: 65 20 73 71 6c 69 74 65 33 5f 65 78 65 63 28 29  e sqlite3_exec()
3570: 20 69 6e 74 65 72 66 61 63 65 20 72 75 6e 73 20   interface runs 
3580: 7a 65 72 6f 20 6f 72 20 6d 6f 72 65 20 55 54 46  zero or more UTF
3590: 2d 38 20 65 6e 63 6f 64 65 64 2c 0a 2a 2a 20 73  -8 encoded,.** s
35a0: 65 6d 69 63 6f 6c 6f 6e 2d 73 65 70 61 72 61 74  emicolon-separat
35b0: 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73  e SQL statements
35c0: 20 70 61 73 73 65 64 20 69 6e 74 6f 20 69 74 73   passed into its
35d0: 20 32 6e 64 20 61 72 67 75 6d 65 6e 74 2c 0a 2a   2nd argument,.*
35e0: 2a 20 69 6e 20 74 68 65 20 63 6f 6e 74 65 78 74  * in the context
35f0: 20 6f 66 20 74 68 65 20 5b 64 61 74 61 62 61 73   of the [databas
3600: 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 70 61  e connection] pa
3610: 73 73 65 64 20 69 6e 20 61 73 20 69 74 73 20 31  ssed in as its 1
3620: 73 74 0a 2a 2a 20 61 72 67 75 6d 65 6e 74 2e 20  st.** argument. 
3630: 20 5e 49 66 20 74 68 65 20 63 61 6c 6c 62 61 63   ^If the callbac
3640: 6b 20 66 75 6e 63 74 69 6f 6e 20 6f 66 20 74 68  k function of th
3650: 65 20 33 72 64 20 61 72 67 75 6d 65 6e 74 20 74  e 3rd argument t
3660: 6f 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 65 78 65  o.** sqlite3_exe
3670: 63 28 29 20 69 73 20 6e 6f 74 20 4e 55 4c 4c 2c  c() is not NULL,
3680: 20 74 68 65 6e 20 69 74 20 69 73 20 69 6e 76 6f   then it is invo
3690: 6b 65 64 20 66 6f 72 20 65 61 63 68 20 72 65 73  ked for each res
36a0: 75 6c 74 20 72 6f 77 0a 2a 2a 20 63 6f 6d 69 6e  ult row.** comin
36b0: 67 20 6f 75 74 20 6f 66 20 74 68 65 20 65 76 61  g out of the eva
36c0: 6c 75 61 74 65 64 20 53 51 4c 20 73 74 61 74 65  luated SQL state
36d0: 6d 65 6e 74 73 2e 20 20 5e 54 68 65 20 34 74 68  ments.  ^The 4th
36e0: 20 61 72 67 75 6d 65 6e 74 20 74 6f 0a 2a 2a 20   argument to.** 
36f0: 73 71 6c 69 74 65 33 5f 65 78 65 63 28 29 20 69  sqlite3_exec() i
3700: 73 20 72 65 6c 61 79 65 64 20 74 68 72 6f 75 67  s relayed throug
3710: 68 20 74 6f 20 74 68 65 20 31 73 74 20 61 72 67  h to the 1st arg
3720: 75 6d 65 6e 74 20 6f 66 20 65 61 63 68 0a 2a 2a  ument of each.**
3730: 20 63 61 6c 6c 62 61 63 6b 20 69 6e 76 6f 63 61   callback invoca
3740: 74 69 6f 6e 2e 20 20 5e 49 66 20 74 68 65 20 63  tion.  ^If the c
3750: 61 6c 6c 62 61 63 6b 20 70 6f 69 6e 74 65 72 20  allback pointer 
3760: 74 6f 20 73 71 6c 69 74 65 33 5f 65 78 65 63 28  to sqlite3_exec(
3770: 29 0a 2a 2a 20 69 73 20 4e 55 4c 4c 2c 20 74 68  ).** is NULL, th
3780: 65 6e 20 6e 6f 20 63 61 6c 6c 62 61 63 6b 20 69  en no callback i
3790: 73 20 65 76 65 72 20 69 6e 76 6f 6b 65 64 20 61  s ever invoked a
37a0: 6e 64 20 72 65 73 75 6c 74 20 72 6f 77 73 20 61  nd result rows a
37b0: 72 65 0a 2a 2a 20 69 67 6e 6f 72 65 64 2e 0a 2a  re.** ignored..*
37c0: 2a 0a 2a 2a 20 5e 49 66 20 61 6e 20 65 72 72 6f  *.** ^If an erro
37d0: 72 20 6f 63 63 75 72 73 20 77 68 69 6c 65 20 65  r occurs while e
37e0: 76 61 6c 75 61 74 69 6e 67 20 74 68 65 20 53 51  valuating the SQ
37f0: 4c 20 73 74 61 74 65 6d 65 6e 74 73 20 70 61 73  L statements pas
3800: 73 65 64 20 69 6e 74 6f 0a 2a 2a 20 73 71 6c 69  sed into.** sqli
3810: 74 65 33 5f 65 78 65 63 28 29 2c 20 74 68 65 6e  te3_exec(), then
3820: 20 65 78 65 63 75 74 69 6f 6e 20 6f 66 20 74 68   execution of th
3830: 65 20 63 75 72 72 65 6e 74 20 73 74 61 74 65 6d  e current statem
3840: 65 6e 74 20 73 74 6f 70 73 20 61 6e 64 0a 2a 2a  ent stops and.**
3850: 20 73 75 62 73 65 71 75 65 6e 74 20 73 74 61 74   subsequent stat
3860: 65 6d 65 6e 74 73 20 61 72 65 20 73 6b 69 70 70  ements are skipp
3870: 65 64 2e 20 20 5e 49 66 20 74 68 65 20 35 74 68  ed.  ^If the 5th
3880: 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 73 71   parameter to sq
3890: 6c 69 74 65 33 5f 65 78 65 63 28 29 0a 2a 2a 20  lite3_exec().** 
38a0: 69 73 20 6e 6f 74 20 4e 55 4c 4c 20 74 68 65 6e  is not NULL then
38b0: 20 61 6e 79 20 65 72 72 6f 72 20 6d 65 73 73 61   any error messa
38c0: 67 65 20 69 73 20 77 72 69 74 74 65 6e 20 69 6e  ge is written in
38d0: 74 6f 20 6d 65 6d 6f 72 79 20 6f 62 74 61 69 6e  to memory obtain
38e0: 65 64 0a 2a 2a 20 66 72 6f 6d 20 5b 73 71 6c 69  ed.** from [sqli
38f0: 74 65 33 5f 6d 61 6c 6c 6f 63 28 29 5d 20 61 6e  te3_malloc()] an
3900: 64 20 70 61 73 73 65 64 20 62 61 63 6b 20 74 68  d passed back th
3910: 72 6f 75 67 68 20 74 68 65 20 35 74 68 20 70 61  rough the 5th pa
3920: 72 61 6d 65 74 65 72 2e 0a 2a 2a 20 54 6f 20 61  rameter..** To a
3930: 76 6f 69 64 20 6d 65 6d 6f 72 79 20 6c 65 61 6b  void memory leak
3940: 73 2c 20 74 68 65 20 61 70 70 6c 69 63 61 74 69  s, the applicati
3950: 6f 6e 20 73 68 6f 75 6c 64 20 69 6e 76 6f 6b 65  on should invoke
3960: 20 5b 73 71 6c 69 74 65 33 5f 66 72 65 65 28 29   [sqlite3_free()
3970: 5d 0a 2a 2a 20 6f 6e 20 65 72 72 6f 72 20 6d 65  ].** on error me
3980: 73 73 61 67 65 20 73 74 72 69 6e 67 73 20 72 65  ssage strings re
3990: 74 75 72 6e 65 64 20 74 68 72 6f 75 67 68 20 74  turned through t
39a0: 68 65 20 35 74 68 20 70 61 72 61 6d 65 74 65 72  he 5th parameter
39b0: 20 6f 66 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 65   of.** sqlite3_e
39c0: 78 65 63 28 29 20 61 66 74 65 72 20 74 68 65 20  xec() after the 
39d0: 65 72 72 6f 72 20 6d 65 73 73 61 67 65 20 73 74  error message st
39e0: 72 69 6e 67 20 69 73 20 6e 6f 20 6c 6f 6e 67 65  ring is no longe
39f0: 72 20 6e 65 65 64 65 64 2e 0a 2a 2a 20 5e 49 66  r needed..** ^If
3a00: 20 74 68 65 20 35 74 68 20 70 61 72 61 6d 65 74   the 5th paramet
3a10: 65 72 20 74 6f 20 73 71 6c 69 74 65 33 5f 65 78  er to sqlite3_ex
3a20: 65 63 28 29 20 69 73 20 6e 6f 74 20 4e 55 4c 4c  ec() is not NULL
3a30: 20 61 6e 64 20 6e 6f 20 65 72 72 6f 72 73 0a 2a   and no errors.*
3a40: 2a 20 6f 63 63 75 72 2c 20 74 68 65 6e 20 73 71  * occur, then sq
3a50: 6c 69 74 65 33 5f 65 78 65 63 28 29 20 73 65 74  lite3_exec() set
3a60: 73 20 74 68 65 20 70 6f 69 6e 74 65 72 20 69 6e  s the pointer in
3a70: 20 69 74 73 20 35 74 68 20 70 61 72 61 6d 65 74   its 5th paramet
3a80: 65 72 20 74 6f 0a 2a 2a 20 4e 55 4c 4c 20 62 65  er to.** NULL be
3a90: 66 6f 72 65 20 72 65 74 75 72 6e 69 6e 67 2e 0a  fore returning..
3aa0: 2a 2a 0a 2a 2a 20 5e 49 66 20 61 6e 20 73 71 6c  **.** ^If an sql
3ab0: 69 74 65 33 5f 65 78 65 63 28 29 20 63 61 6c 6c  ite3_exec() call
3ac0: 62 61 63 6b 20 72 65 74 75 72 6e 73 20 6e 6f 6e  back returns non
3ad0: 2d 7a 65 72 6f 2c 20 74 68 65 20 73 71 6c 69 74  -zero, the sqlit
3ae0: 65 33 5f 65 78 65 63 28 29 0a 2a 2a 20 72 6f 75  e3_exec().** rou
3af0: 74 69 6e 65 20 72 65 74 75 72 6e 73 20 53 51 4c  tine returns SQL
3b00: 49 54 45 5f 41 42 4f 52 54 20 77 69 74 68 6f 75  ITE_ABORT withou
3b10: 74 20 69 6e 76 6f 6b 69 6e 67 20 74 68 65 20 63  t invoking the c
3b20: 61 6c 6c 62 61 63 6b 20 61 67 61 69 6e 20 61 6e  allback again an
3b30: 64 0a 2a 2a 20 77 69 74 68 6f 75 74 20 72 75 6e  d.** without run
3b40: 6e 69 6e 67 20 61 6e 79 20 73 75 62 73 65 71 75  ning any subsequ
3b50: 65 6e 74 20 53 51 4c 20 73 74 61 74 65 6d 65 6e  ent SQL statemen
3b60: 74 73 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 32  ts..**.** ^The 2
3b70: 6e 64 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 74  nd argument to t
3b80: 68 65 20 73 71 6c 69 74 65 33 5f 65 78 65 63 28  he sqlite3_exec(
3b90: 29 20 63 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74  ) callback funct
3ba0: 69 6f 6e 20 69 73 20 74 68 65 0a 2a 2a 20 6e 75  ion is the.** nu
3bb0: 6d 62 65 72 20 6f 66 20 63 6f 6c 75 6d 6e 73 20  mber of columns 
3bc0: 69 6e 20 74 68 65 20 72 65 73 75 6c 74 2e 20 20  in the result.  
3bd0: 5e 54 68 65 20 33 72 64 20 61 72 67 75 6d 65 6e  ^The 3rd argumen
3be0: 74 20 74 6f 20 74 68 65 20 73 71 6c 69 74 65 33  t to the sqlite3
3bf0: 5f 65 78 65 63 28 29 0a 2a 2a 20 63 61 6c 6c 62  _exec().** callb
3c00: 61 63 6b 20 69 73 20 61 6e 20 61 72 72 61 79 20  ack is an array 
3c10: 6f 66 20 70 6f 69 6e 74 65 72 73 20 74 6f 20 73  of pointers to s
3c20: 74 72 69 6e 67 73 20 6f 62 74 61 69 6e 65 64 20  trings obtained 
3c30: 61 73 20 69 66 20 66 72 6f 6d 0a 2a 2a 20 5b 73  as if from.** [s
3c40: 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65  qlite3_column_te
3c50: 78 74 28 29 5d 2c 20 6f 6e 65 20 66 6f 72 20 65  xt()], one for e
3c60: 61 63 68 20 63 6f 6c 75 6d 6e 2e 20 20 5e 49 66  ach column.  ^If
3c70: 20 61 6e 20 65 6c 65 6d 65 6e 74 20 6f 66 20 61   an element of a
3c80: 0a 2a 2a 20 72 65 73 75 6c 74 20 72 6f 77 20 69  .** result row i
3c90: 73 20 4e 55 4c 4c 20 74 68 65 6e 20 74 68 65 20  s NULL then the 
3ca0: 63 6f 72 72 65 73 70 6f 6e 64 69 6e 67 20 73 74  corresponding st
3cb0: 72 69 6e 67 20 70 6f 69 6e 74 65 72 20 66 6f 72  ring pointer for
3cc0: 20 74 68 65 0a 2a 2a 20 73 71 6c 69 74 65 33 5f   the.** sqlite3_
3cd0: 65 78 65 63 28 29 20 63 61 6c 6c 62 61 63 6b 20  exec() callback 
3ce0: 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  is a NULL pointe
3cf0: 72 2e 20 20 5e 54 68 65 20 34 74 68 20 61 72 67  r.  ^The 4th arg
3d00: 75 6d 65 6e 74 20 74 6f 20 74 68 65 0a 2a 2a 20  ument to the.** 
3d10: 73 71 6c 69 74 65 33 5f 65 78 65 63 28 29 20 63  sqlite3_exec() c
3d20: 61 6c 6c 62 61 63 6b 20 69 73 20 61 6e 20 61 72  allback is an ar
3d30: 72 61 79 20 6f 66 20 70 6f 69 6e 74 65 72 73 20  ray of pointers 
3d40: 74 6f 20 73 74 72 69 6e 67 73 20 77 68 65 72 65  to strings where
3d50: 20 65 61 63 68 0a 2a 2a 20 65 6e 74 72 79 20 72   each.** entry r
3d60: 65 70 72 65 73 65 6e 74 73 20 74 68 65 20 6e 61  epresents the na
3d70: 6d 65 20 6f 66 20 63 6f 72 72 65 73 70 6f 6e 64  me of correspond
3d80: 69 6e 67 20 72 65 73 75 6c 74 20 63 6f 6c 75 6d  ing result colum
3d90: 6e 20 61 73 20 6f 62 74 61 69 6e 65 64 0a 2a 2a  n as obtained.**
3da0: 20 66 72 6f 6d 20 5b 73 71 6c 69 74 65 33 5f 63   from [sqlite3_c
3db0: 6f 6c 75 6d 6e 5f 6e 61 6d 65 28 29 5d 2e 0a 2a  olumn_name()]..*
3dc0: 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20 32 6e 64  *.** ^If the 2nd
3dd0: 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 73 71   parameter to sq
3de0: 6c 69 74 65 33 5f 65 78 65 63 28 29 20 69 73 20  lite3_exec() is 
3df0: 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 2c 20  a NULL pointer, 
3e00: 61 20 70 6f 69 6e 74 65 72 0a 2a 2a 20 74 6f 20  a pointer.** to 
3e10: 61 6e 20 65 6d 70 74 79 20 73 74 72 69 6e 67 2c  an empty string,
3e20: 20 6f 72 20 61 20 70 6f 69 6e 74 65 72 20 74 68   or a pointer th
3e30: 61 74 20 63 6f 6e 74 61 69 6e 73 20 6f 6e 6c 79  at contains only
3e40: 20 77 68 69 74 65 73 70 61 63 65 20 61 6e 64 2f   whitespace and/
3e50: 6f 72 20 0a 2a 2a 20 53 51 4c 20 63 6f 6d 6d 65  or .** SQL comme
3e60: 6e 74 73 2c 20 74 68 65 6e 20 6e 6f 20 53 51 4c  nts, then no SQL
3e70: 20 73 74 61 74 65 6d 65 6e 74 73 20 61 72 65 20   statements are 
3e80: 65 76 61 6c 75 61 74 65 64 20 61 6e 64 20 74 68  evaluated and th
3e90: 65 20 64 61 74 61 62 61 73 65 0a 2a 2a 20 69 73  e database.** is
3ea0: 20 6e 6f 74 20 63 68 61 6e 67 65 64 2e 0a 2a 2a   not changed..**
3eb0: 0a 2a 2a 20 52 65 73 74 72 69 63 74 69 6f 6e 73  .** Restrictions
3ec0: 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a 20  :.**.** <ul>.** 
3ed0: 3c 6c 69 3e 20 54 68 65 20 61 70 70 6c 69 63 61  <li> The applica
3ee0: 74 69 6f 6e 20 6d 75 73 74 20 65 6e 73 75 72 65  tion must ensure
3ef0: 20 74 68 61 74 20 74 68 65 20 31 73 74 20 70 61   that the 1st pa
3f00: 72 61 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74  rameter to sqlit
3f10: 65 33 5f 65 78 65 63 28 29 0a 2a 2a 20 20 20 20  e3_exec().**    
3f20: 20 20 69 73 20 61 20 76 61 6c 69 64 20 61 6e 64    is a valid and
3f30: 20 6f 70 65 6e 20 5b 64 61 74 61 62 61 73 65 20   open [database 
3f40: 63 6f 6e 6e 65 63 74 69 6f 6e 5d 2e 0a 2a 2a 20  connection]..** 
3f50: 3c 6c 69 3e 20 54 68 65 20 61 70 70 6c 69 63 61  <li> The applica
3f60: 74 69 6f 6e 20 6d 75 73 74 20 6e 6f 74 20 63 6c  tion must not cl
3f70: 6f 73 65 20 74 68 65 20 5b 64 61 74 61 62 61 73  ose the [databas
3f80: 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 73 70  e connection] sp
3f90: 65 63 69 66 69 65 64 20 62 79 0a 2a 2a 20 20 20  ecified by.**   
3fa0: 20 20 20 74 68 65 20 31 73 74 20 70 61 72 61 6d     the 1st param
3fb0: 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33 5f  eter to sqlite3_
3fc0: 65 78 65 63 28 29 20 77 68 69 6c 65 20 73 71 6c  exec() while sql
3fd0: 69 74 65 33 5f 65 78 65 63 28 29 20 69 73 20 72  ite3_exec() is r
3fe0: 75 6e 6e 69 6e 67 2e 0a 2a 2a 20 3c 6c 69 3e 20  unning..** <li> 
3ff0: 54 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20  The application 
4000: 6d 75 73 74 20 6e 6f 74 20 6d 6f 64 69 66 79 20  must not modify 
4010: 74 68 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e  the SQL statemen
4020: 74 20 74 65 78 74 20 70 61 73 73 65 64 20 69 6e  t text passed in
4030: 74 6f 0a 2a 2a 20 20 20 20 20 20 74 68 65 20 32  to.**      the 2
4040: 6e 64 20 70 61 72 61 6d 65 74 65 72 20 6f 66 20  nd parameter of 
4050: 73 71 6c 69 74 65 33 5f 65 78 65 63 28 29 20 77  sqlite3_exec() w
4060: 68 69 6c 65 20 73 71 6c 69 74 65 33 5f 65 78 65  hile sqlite3_exe
4070: 63 28 29 20 69 73 20 72 75 6e 6e 69 6e 67 2e 0a  c() is running..
4080: 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2f 0a 69 6e 74 20  ** </ul>.*/.int 
4090: 73 71 6c 69 74 65 33 5f 65 78 65 63 28 0a 20 20  sqlite3_exec(.  
40a0: 73 71 6c 69 74 65 33 2a 2c 20 20 20 20 20 20 20  sqlite3*,       
40b0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
40c0: 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 41 6e             /* An
40d0: 20 6f 70 65 6e 20 64 61 74 61 62 61 73 65 20 2a   open database *
40e0: 2f 0a 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a  /.  const char *
40f0: 73 71 6c 2c 20 20 20 20 20 20 20 20 20 20 20 20  sql,            
4100: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f                 /
4110: 2a 20 53 51 4c 20 74 6f 20 62 65 20 65 76 61 6c  * SQL to be eval
4120: 75 61 74 65 64 20 2a 2f 0a 20 20 69 6e 74 20 28  uated */.  int (
4130: 2a 63 61 6c 6c 62 61 63 6b 29 28 76 6f 69 64 2a  *callback)(void*
4140: 2c 69 6e 74 2c 63 68 61 72 2a 2a 2c 63 68 61 72  ,int,char**,char
4150: 2a 2a 29 2c 20 20 2f 2a 20 43 61 6c 6c 62 61 63  **),  /* Callbac
4160: 6b 20 66 75 6e 63 74 69 6f 6e 20 2a 2f 0a 20 20  k function */.  
4170: 76 6f 69 64 20 2a 2c 20 20 20 20 20 20 20 20 20  void *,         
4180: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
4190: 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 31 73             /* 1s
41a0: 74 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 63 61  t argument to ca
41b0: 6c 6c 62 61 63 6b 20 2a 2f 0a 20 20 63 68 61 72  llback */.  char
41c0: 20 2a 2a 65 72 72 6d 73 67 20 20 20 20 20 20 20   **errmsg       
41d0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
41e0: 20 20 20 20 20 20 20 2f 2a 20 45 72 72 6f 72 20         /* Error 
41f0: 6d 73 67 20 77 72 69 74 74 65 6e 20 68 65 72 65  msg written here
4200: 20 2a 2f 0a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41   */.);../*.** CA
4210: 50 49 33 52 45 46 3a 20 52 65 73 75 6c 74 20 43  PI3REF: Result C
4220: 6f 64 65 73 0a 2a 2a 20 4b 45 59 57 4f 52 44 53  odes.** KEYWORDS
4230: 3a 20 7b 72 65 73 75 6c 74 20 63 6f 64 65 20 64  : {result code d
4240: 65 66 69 6e 69 74 69 6f 6e 73 7d 0a 2a 2a 0a 2a  efinitions}.**.*
4250: 2a 20 4d 61 6e 79 20 53 51 4c 69 74 65 20 66 75  * Many SQLite fu
4260: 6e 63 74 69 6f 6e 73 20 72 65 74 75 72 6e 20 61  nctions return a
4270: 6e 20 69 6e 74 65 67 65 72 20 72 65 73 75 6c 74  n integer result
4280: 20 63 6f 64 65 20 66 72 6f 6d 20 74 68 65 20 73   code from the s
4290: 65 74 20 73 68 6f 77 6e 0a 2a 2a 20 68 65 72 65  et shown.** here
42a0: 20 69 6e 20 6f 72 64 65 72 20 74 6f 20 69 6e 64   in order to ind
42b0: 69 63 61 74 65 20 73 75 63 63 65 73 73 20 6f 72  icate success or
42c0: 20 66 61 69 6c 75 72 65 2e 0a 2a 2a 0a 2a 2a 20   failure..**.** 
42d0: 4e 65 77 20 65 72 72 6f 72 20 63 6f 64 65 73 20  New error codes 
42e0: 6d 61 79 20 62 65 20 61 64 64 65 64 20 69 6e 20  may be added in 
42f0: 66 75 74 75 72 65 20 76 65 72 73 69 6f 6e 73 20  future versions 
4300: 6f 66 20 53 51 4c 69 74 65 2e 0a 2a 2a 0a 2a 2a  of SQLite..**.**
4310: 20 53 65 65 20 61 6c 73 6f 3a 20 5b 65 78 74 65   See also: [exte
4320: 6e 64 65 64 20 72 65 73 75 6c 74 20 63 6f 64 65  nded result code
4330: 20 64 65 66 69 6e 69 74 69 6f 6e 73 5d 0a 2a 2f   definitions].*/
4340: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
4350: 4f 4b 20 20 20 20 20 20 20 20 20 20 20 30 20 20  OK           0  
4360: 20 2f 2a 20 53 75 63 63 65 73 73 66 75 6c 20 72   /* Successful r
4370: 65 73 75 6c 74 20 2a 2f 0a 2f 2a 20 62 65 67 69  esult */./* begi
4380: 6e 6e 69 6e 67 2d 6f 66 2d 65 72 72 6f 72 2d 63  nning-of-error-c
4390: 6f 64 65 73 20 2a 2f 0a 23 64 65 66 69 6e 65 20  odes */.#define 
43a0: 53 51 4c 49 54 45 5f 45 52 52 4f 52 20 20 20 20  SQLITE_ERROR    
43b0: 20 20 20 20 31 20 20 20 2f 2a 20 53 51 4c 20 65      1   /* SQL e
43c0: 72 72 6f 72 20 6f 72 20 6d 69 73 73 69 6e 67 20  rror or missing 
43d0: 64 61 74 61 62 61 73 65 20 2a 2f 0a 23 64 65 66  database */.#def
43e0: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4e 54 45 52  ine SQLITE_INTER
43f0: 4e 41 4c 20 20 20 20 20 32 20 20 20 2f 2a 20 49  NAL     2   /* I
4400: 6e 74 65 72 6e 61 6c 20 6c 6f 67 69 63 20 65 72  nternal logic er
4410: 72 6f 72 20 69 6e 20 53 51 4c 69 74 65 20 2a 2f  ror in SQLite */
4420: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
4430: 50 45 52 4d 20 20 20 20 20 20 20 20 20 33 20 20  PERM         3  
4440: 20 2f 2a 20 41 63 63 65 73 73 20 70 65 72 6d 69   /* Access permi
4450: 73 73 69 6f 6e 20 64 65 6e 69 65 64 20 2a 2f 0a  ssion denied */.
4460: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 41  #define SQLITE_A
4470: 42 4f 52 54 20 20 20 20 20 20 20 20 34 20 20 20  BORT        4   
4480: 2f 2a 20 43 61 6c 6c 62 61 63 6b 20 72 6f 75 74  /* Callback rout
4490: 69 6e 65 20 72 65 71 75 65 73 74 65 64 20 61 6e  ine requested an
44a0: 20 61 62 6f 72 74 20 2a 2f 0a 23 64 65 66 69 6e   abort */.#defin
44b0: 65 20 53 51 4c 49 54 45 5f 42 55 53 59 20 20 20  e SQLITE_BUSY   
44c0: 20 20 20 20 20 20 35 20 20 20 2f 2a 20 54 68 65        5   /* The
44d0: 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 20 69   database file i
44e0: 73 20 6c 6f 63 6b 65 64 20 2a 2f 0a 23 64 65 66  s locked */.#def
44f0: 69 6e 65 20 53 51 4c 49 54 45 5f 4c 4f 43 4b 45  ine SQLITE_LOCKE
4500: 44 20 20 20 20 20 20 20 36 20 20 20 2f 2a 20 41  D       6   /* A
4510: 20 74 61 62 6c 65 20 69 6e 20 74 68 65 20 64 61   table in the da
4520: 74 61 62 61 73 65 20 69 73 20 6c 6f 63 6b 65 64  tabase is locked
4530: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
4540: 54 45 5f 4e 4f 4d 45 4d 20 20 20 20 20 20 20 20  TE_NOMEM        
4550: 37 20 20 20 2f 2a 20 41 20 6d 61 6c 6c 6f 63 28  7   /* A malloc(
4560: 29 20 66 61 69 6c 65 64 20 2a 2f 0a 23 64 65 66  ) failed */.#def
4570: 69 6e 65 20 53 51 4c 49 54 45 5f 52 45 41 44 4f  ine SQLITE_READO
4580: 4e 4c 59 20 20 20 20 20 38 20 20 20 2f 2a 20 41  NLY     8   /* A
4590: 74 74 65 6d 70 74 20 74 6f 20 77 72 69 74 65 20  ttempt to write 
45a0: 61 20 72 65 61 64 6f 6e 6c 79 20 64 61 74 61 62  a readonly datab
45b0: 61 73 65 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53  ase */.#define S
45c0: 51 4c 49 54 45 5f 49 4e 54 45 52 52 55 50 54 20  QLITE_INTERRUPT 
45d0: 20 20 20 39 20 20 20 2f 2a 20 4f 70 65 72 61 74     9   /* Operat
45e0: 69 6f 6e 20 74 65 72 6d 69 6e 61 74 65 64 20 62  ion terminated b
45f0: 79 20 73 71 6c 69 74 65 33 5f 69 6e 74 65 72 72  y sqlite3_interr
4600: 75 70 74 28 29 2a 2f 0a 23 64 65 66 69 6e 65 20  upt()*/.#define 
4610: 53 51 4c 49 54 45 5f 49 4f 45 52 52 20 20 20 20  SQLITE_IOERR    
4620: 20 20 20 31 30 20 20 20 2f 2a 20 53 6f 6d 65 20     10   /* Some 
4630: 6b 69 6e 64 20 6f 66 20 64 69 73 6b 20 49 2f 4f  kind of disk I/O
4640: 20 65 72 72 6f 72 20 6f 63 63 75 72 72 65 64 20   error occurred 
4650: 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
4660: 45 5f 43 4f 52 52 55 50 54 20 20 20 20 20 31 31  E_CORRUPT     11
4670: 20 20 20 2f 2a 20 54 68 65 20 64 61 74 61 62 61     /* The databa
4680: 73 65 20 64 69 73 6b 20 69 6d 61 67 65 20 69 73  se disk image is
4690: 20 6d 61 6c 66 6f 72 6d 65 64 20 2a 2f 0a 23 64   malformed */.#d
46a0: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4e 4f 54  efine SQLITE_NOT
46b0: 46 4f 55 4e 44 20 20 20 20 31 32 20 20 20 2f 2a  FOUND    12   /*
46c0: 20 55 6e 6b 6e 6f 77 6e 20 6f 70 63 6f 64 65 20   Unknown opcode 
46d0: 69 6e 20 73 71 6c 69 74 65 33 5f 66 69 6c 65 5f  in sqlite3_file_
46e0: 63 6f 6e 74 72 6f 6c 28 29 20 2a 2f 0a 23 64 65  control() */.#de
46f0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 55 4c 4c  fine SQLITE_FULL
4700: 20 20 20 20 20 20 20 20 31 33 20 20 20 2f 2a 20          13   /* 
4710: 49 6e 73 65 72 74 69 6f 6e 20 66 61 69 6c 65 64  Insertion failed
4720: 20 62 65 63 61 75 73 65 20 64 61 74 61 62 61 73   because databas
4730: 65 20 69 73 20 66 75 6c 6c 20 2a 2f 0a 23 64 65  e is full */.#de
4740: 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 41 4e 54  fine SQLITE_CANT
4750: 4f 50 45 4e 20 20 20 20 31 34 20 20 20 2f 2a 20  OPEN    14   /* 
4760: 55 6e 61 62 6c 65 20 74 6f 20 6f 70 65 6e 20 74  Unable to open t
4770: 68 65 20 64 61 74 61 62 61 73 65 20 66 69 6c 65  he database file
4780: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
4790: 54 45 5f 50 52 4f 54 4f 43 4f 4c 20 20 20 20 31  TE_PROTOCOL    1
47a0: 35 20 20 20 2f 2a 20 44 61 74 61 62 61 73 65 20  5   /* Database 
47b0: 6c 6f 63 6b 20 70 72 6f 74 6f 63 6f 6c 20 65 72  lock protocol er
47c0: 72 6f 72 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53  ror */.#define S
47d0: 51 4c 49 54 45 5f 45 4d 50 54 59 20 20 20 20 20  QLITE_EMPTY     
47e0: 20 20 31 36 20 20 20 2f 2a 20 44 61 74 61 62 61    16   /* Databa
47f0: 73 65 20 69 73 20 65 6d 70 74 79 20 2a 2f 0a 23  se is empty */.#
4800: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 53 43  define SQLITE_SC
4810: 48 45 4d 41 20 20 20 20 20 20 31 37 20 20 20 2f  HEMA      17   /
4820: 2a 20 54 68 65 20 64 61 74 61 62 61 73 65 20 73  * The database s
4830: 63 68 65 6d 61 20 63 68 61 6e 67 65 64 20 2a 2f  chema changed */
4840: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
4850: 54 4f 4f 42 49 47 20 20 20 20 20 20 31 38 20 20  TOOBIG      18  
4860: 20 2f 2a 20 53 74 72 69 6e 67 20 6f 72 20 42 4c   /* String or BL
4870: 4f 42 20 65 78 63 65 65 64 73 20 73 69 7a 65 20  OB exceeds size 
4880: 6c 69 6d 69 74 20 2a 2f 0a 23 64 65 66 69 6e 65  limit */.#define
4890: 20 53 51 4c 49 54 45 5f 43 4f 4e 53 54 52 41 49   SQLITE_CONSTRAI
48a0: 4e 54 20 20 31 39 20 20 20 2f 2a 20 41 62 6f 72  NT  19   /* Abor
48b0: 74 20 64 75 65 20 74 6f 20 63 6f 6e 73 74 72 61  t due to constra
48c0: 69 6e 74 20 76 69 6f 6c 61 74 69 6f 6e 20 2a 2f  int violation */
48d0: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
48e0: 4d 49 53 4d 41 54 43 48 20 20 20 20 32 30 20 20  MISMATCH    20  
48f0: 20 2f 2a 20 44 61 74 61 20 74 79 70 65 20 6d 69   /* Data type mi
4900: 73 6d 61 74 63 68 20 2a 2f 0a 23 64 65 66 69 6e  smatch */.#defin
4910: 65 20 53 51 4c 49 54 45 5f 4d 49 53 55 53 45 20  e SQLITE_MISUSE 
4920: 20 20 20 20 20 32 31 20 20 20 2f 2a 20 4c 69 62       21   /* Lib
4930: 72 61 72 79 20 75 73 65 64 20 69 6e 63 6f 72 72  rary used incorr
4940: 65 63 74 6c 79 20 2a 2f 0a 23 64 65 66 69 6e 65  ectly */.#define
4950: 20 53 51 4c 49 54 45 5f 4e 4f 4c 46 53 20 20 20   SQLITE_NOLFS   
4960: 20 20 20 20 32 32 20 20 20 2f 2a 20 55 73 65 73      22   /* Uses
4970: 20 4f 53 20 66 65 61 74 75 72 65 73 20 6e 6f 74   OS features not
4980: 20 73 75 70 70 6f 72 74 65 64 20 6f 6e 20 68 6f   supported on ho
4990: 73 74 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51  st */.#define SQ
49a0: 4c 49 54 45 5f 41 55 54 48 20 20 20 20 20 20 20  LITE_AUTH       
49b0: 20 32 33 20 20 20 2f 2a 20 41 75 74 68 6f 72 69   23   /* Authori
49c0: 7a 61 74 69 6f 6e 20 64 65 6e 69 65 64 20 2a 2f  zation denied */
49d0: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
49e0: 46 4f 52 4d 41 54 20 20 20 20 20 20 32 34 20 20  FORMAT      24  
49f0: 20 2f 2a 20 41 75 78 69 6c 69 61 72 79 20 64 61   /* Auxiliary da
4a00: 74 61 62 61 73 65 20 66 6f 72 6d 61 74 20 65 72  tabase format er
4a10: 72 6f 72 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53  ror */.#define S
4a20: 51 4c 49 54 45 5f 52 41 4e 47 45 20 20 20 20 20  QLITE_RANGE     
4a30: 20 20 32 35 20 20 20 2f 2a 20 32 6e 64 20 70 61    25   /* 2nd pa
4a40: 72 61 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74  rameter to sqlit
4a50: 65 33 5f 62 69 6e 64 20 6f 75 74 20 6f 66 20 72  e3_bind out of r
4a60: 61 6e 67 65 20 2a 2f 0a 23 64 65 66 69 6e 65 20  ange */.#define 
4a70: 53 51 4c 49 54 45 5f 4e 4f 54 41 44 42 20 20 20  SQLITE_NOTADB   
4a80: 20 20 20 32 36 20 20 20 2f 2a 20 46 69 6c 65 20     26   /* File 
4a90: 6f 70 65 6e 65 64 20 74 68 61 74 20 69 73 20 6e  opened that is n
4aa0: 6f 74 20 61 20 64 61 74 61 62 61 73 65 20 66 69  ot a database fi
4ab0: 6c 65 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51  le */.#define SQ
4ac0: 4c 49 54 45 5f 4e 4f 54 49 43 45 20 20 20 20 20  LITE_NOTICE     
4ad0: 20 32 37 20 20 20 2f 2a 20 4e 6f 74 69 66 69 63   27   /* Notific
4ae0: 61 74 69 6f 6e 73 20 66 72 6f 6d 20 73 71 6c 69  ations from sqli
4af0: 74 65 33 5f 6c 6f 67 28 29 20 2a 2f 0a 23 64 65  te3_log() */.#de
4b00: 66 69 6e 65 20 53 51 4c 49 54 45 5f 57 41 52 4e  fine SQLITE_WARN
4b10: 49 4e 47 20 20 20 20 20 32 38 20 20 20 2f 2a 20  ING     28   /* 
4b20: 57 61 72 6e 69 6e 67 73 20 66 72 6f 6d 20 73 71  Warnings from sq
4b30: 6c 69 74 65 33 5f 6c 6f 67 28 29 20 2a 2f 0a 23  lite3_log() */.#
4b40: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 52 4f  define SQLITE_RO
4b50: 57 20 20 20 20 20 20 20 20 20 31 30 30 20 20 2f  W         100  /
4b60: 2a 20 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29  * sqlite3_step()
4b70: 20 68 61 73 20 61 6e 6f 74 68 65 72 20 72 6f 77   has another row
4b80: 20 72 65 61 64 79 20 2a 2f 0a 23 64 65 66 69 6e   ready */.#defin
4b90: 65 20 53 51 4c 49 54 45 5f 44 4f 4e 45 20 20 20  e SQLITE_DONE   
4ba0: 20 20 20 20 20 31 30 31 20 20 2f 2a 20 73 71 6c       101  /* sql
4bb0: 69 74 65 33 5f 73 74 65 70 28 29 20 68 61 73 20  ite3_step() has 
4bc0: 66 69 6e 69 73 68 65 64 20 65 78 65 63 75 74 69  finished executi
4bd0: 6e 67 20 2a 2f 0a 2f 2a 20 65 6e 64 2d 6f 66 2d  ng */./* end-of-
4be0: 65 72 72 6f 72 2d 63 6f 64 65 73 20 2a 2f 0a 0a  error-codes */..
4bf0: 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20  /*.** CAPI3REF: 
4c00: 45 78 74 65 6e 64 65 64 20 52 65 73 75 6c 74 20  Extended Result 
4c10: 43 6f 64 65 73 0a 2a 2a 20 4b 45 59 57 4f 52 44  Codes.** KEYWORD
4c20: 53 3a 20 7b 65 78 74 65 6e 64 65 64 20 72 65 73  S: {extended res
4c30: 75 6c 74 20 63 6f 64 65 20 64 65 66 69 6e 69 74  ult code definit
4c40: 69 6f 6e 73 7d 0a 2a 2a 0a 2a 2a 20 49 6e 20 69  ions}.**.** In i
4c50: 74 73 20 64 65 66 61 75 6c 74 20 63 6f 6e 66 69  ts default confi
4c60: 67 75 72 61 74 69 6f 6e 2c 20 53 51 4c 69 74 65  guration, SQLite
4c70: 20 41 50 49 20 72 6f 75 74 69 6e 65 73 20 72 65   API routines re
4c80: 74 75 72 6e 20 6f 6e 65 20 6f 66 20 33 30 20 69  turn one of 30 i
4c90: 6e 74 65 67 65 72 0a 2a 2a 20 5b 72 65 73 75 6c  nteger.** [resul
4ca0: 74 20 63 6f 64 65 73 5d 2e 20 20 48 6f 77 65 76  t codes].  Howev
4cb0: 65 72 2c 20 65 78 70 65 72 69 65 6e 63 65 20 68  er, experience h
4cc0: 61 73 20 73 68 6f 77 6e 20 74 68 61 74 20 6d 61  as shown that ma
4cd0: 6e 79 20 6f 66 0a 2a 2a 20 74 68 65 73 65 20 72  ny of.** these r
4ce0: 65 73 75 6c 74 20 63 6f 64 65 73 20 61 72 65 20  esult codes are 
4cf0: 74 6f 6f 20 63 6f 61 72 73 65 2d 67 72 61 69 6e  too coarse-grain
4d00: 65 64 2e 20 20 54 68 65 79 20 64 6f 20 6e 6f 74  ed.  They do not
4d10: 20 70 72 6f 76 69 64 65 20 61 73 0a 2a 2a 20 6d   provide as.** m
4d20: 75 63 68 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20  uch information 
4d30: 61 62 6f 75 74 20 70 72 6f 62 6c 65 6d 73 20 61  about problems a
4d40: 73 20 70 72 6f 67 72 61 6d 6d 65 72 73 20 6d 69  s programmers mi
4d50: 67 68 74 20 6c 69 6b 65 2e 20 20 49 6e 20 61 6e  ght like.  In an
4d60: 20 65 66 66 6f 72 74 20 74 6f 0a 2a 2a 20 61 64   effort to.** ad
4d70: 64 72 65 73 73 20 74 68 69 73 2c 20 6e 65 77 65  dress this, newe
4d80: 72 20 76 65 72 73 69 6f 6e 73 20 6f 66 20 53 51  r versions of SQ
4d90: 4c 69 74 65 20 28 76 65 72 73 69 6f 6e 20 33 2e  Lite (version 3.
4da0: 33 2e 38 20 61 6e 64 20 6c 61 74 65 72 29 20 69  3.8 and later) i
4db0: 6e 63 6c 75 64 65 0a 2a 2a 20 73 75 70 70 6f 72  nclude.** suppor
4dc0: 74 20 66 6f 72 20 61 64 64 69 74 69 6f 6e 61 6c  t for additional
4dd0: 20 72 65 73 75 6c 74 20 63 6f 64 65 73 20 74 68   result codes th
4de0: 61 74 20 70 72 6f 76 69 64 65 20 6d 6f 72 65 20  at provide more 
4df0: 64 65 74 61 69 6c 65 64 20 69 6e 66 6f 72 6d 61  detailed informa
4e00: 74 69 6f 6e 0a 2a 2a 20 61 62 6f 75 74 20 65 72  tion.** about er
4e10: 72 6f 72 73 2e 20 54 68 65 73 65 20 5b 65 78 74  rors. These [ext
4e20: 65 6e 64 65 64 20 72 65 73 75 6c 74 20 63 6f 64  ended result cod
4e30: 65 73 5d 20 61 72 65 20 65 6e 61 62 6c 65 64 20  es] are enabled 
4e40: 6f 72 20 64 69 73 61 62 6c 65 64 0a 2a 2a 20 6f  or disabled.** o
4e50: 6e 20 61 20 70 65 72 20 64 61 74 61 62 61 73 65  n a per database
4e60: 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 62 61 73 69   connection basi
4e70: 73 20 75 73 69 6e 67 20 74 68 65 0a 2a 2a 20 5b  s using the.** [
4e80: 73 71 6c 69 74 65 33 5f 65 78 74 65 6e 64 65 64  sqlite3_extended
4e90: 5f 72 65 73 75 6c 74 5f 63 6f 64 65 73 28 29 5d  _result_codes()]
4ea0: 20 41 50 49 2e 20 20 4f 72 2c 20 74 68 65 20 65   API.  Or, the e
4eb0: 78 74 65 6e 64 65 64 20 63 6f 64 65 20 66 6f 72  xtended code for
4ec0: 0a 2a 2a 20 74 68 65 20 6d 6f 73 74 20 72 65 63  .** the most rec
4ed0: 65 6e 74 20 65 72 72 6f 72 20 63 61 6e 20 62 65  ent error can be
4ee0: 20 6f 62 74 61 69 6e 65 64 20 75 73 69 6e 67 0a   obtained using.
4ef0: 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 65 78 74 65  ** [sqlite3_exte
4f00: 6e 64 65 64 5f 65 72 72 63 6f 64 65 28 29 5d 2e  nded_errcode()].
4f10: 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  .*/.#define SQLI
4f20: 54 45 5f 49 4f 45 52 52 5f 52 45 41 44 20 20 20  TE_IOERR_READ   
4f30: 20 20 20 20 20 20 20 20 20 20 20 28 53 51 4c 49             (SQLI
4f40: 54 45 5f 49 4f 45 52 52 20 7c 20 28 31 3c 3c 38  TE_IOERR | (1<<8
4f50: 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  )).#define SQLIT
4f60: 45 5f 49 4f 45 52 52 5f 53 48 4f 52 54 5f 52 45  E_IOERR_SHORT_RE
4f70: 41 44 20 20 20 20 20 20 20 20 28 53 51 4c 49 54  AD        (SQLIT
4f80: 45 5f 49 4f 45 52 52 20 7c 20 28 32 3c 3c 38 29  E_IOERR | (2<<8)
4f90: 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  ).#define SQLITE
4fa0: 5f 49 4f 45 52 52 5f 57 52 49 54 45 20 20 20 20  _IOERR_WRITE    
4fb0: 20 20 20 20 20 20 20 20 20 28 53 51 4c 49 54 45           (SQLITE
4fc0: 5f 49 4f 45 52 52 20 7c 20 28 33 3c 3c 38 29 29  _IOERR | (3<<8))
4fd0: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
4fe0: 49 4f 45 52 52 5f 46 53 59 4e 43 20 20 20 20 20  IOERR_FSYNC     
4ff0: 20 20 20 20 20 20 20 20 28 53 51 4c 49 54 45 5f          (SQLITE_
5000: 49 4f 45 52 52 20 7c 20 28 34 3c 3c 38 29 29 0a  IOERR | (4<<8)).
5010: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49  #define SQLITE_I
5020: 4f 45 52 52 5f 44 49 52 5f 46 53 59 4e 43 20 20  OERR_DIR_FSYNC  
5030: 20 20 20 20 20 20 20 28 53 51 4c 49 54 45 5f 49         (SQLITE_I
5040: 4f 45 52 52 20 7c 20 28 35 3c 3c 38 29 29 0a 23  OERR | (5<<8)).#
5050: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f  define SQLITE_IO
5060: 45 52 52 5f 54 52 55 4e 43 41 54 45 20 20 20 20  ERR_TRUNCATE    
5070: 20 20 20 20 20 20 28 53 51 4c 49 54 45 5f 49 4f        (SQLITE_IO
5080: 45 52 52 20 7c 20 28 36 3c 3c 38 29 29 0a 23 64  ERR | (6<<8)).#d
5090: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45  efine SQLITE_IOE
50a0: 52 52 5f 46 53 54 41 54 20 20 20 20 20 20 20 20  RR_FSTAT        
50b0: 20 20 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45       (SQLITE_IOE
50c0: 52 52 20 7c 20 28 37 3c 3c 38 29 29 0a 23 64 65  RR | (7<<8)).#de
50d0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52  fine SQLITE_IOER
50e0: 52 5f 55 4e 4c 4f 43 4b 20 20 20 20 20 20 20 20  R_UNLOCK        
50f0: 20 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52      (SQLITE_IOER
5100: 52 20 7c 20 28 38 3c 3c 38 29 29 0a 23 64 65 66  R | (8<<8)).#def
5110: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  ine SQLITE_IOERR
5120: 5f 52 44 4c 4f 43 4b 20 20 20 20 20 20 20 20 20  _RDLOCK         
5130: 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52     (SQLITE_IOERR
5140: 20 7c 20 28 39 3c 3c 38 29 29 0a 23 64 65 66 69   | (9<<8)).#defi
5150: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
5160: 44 45 4c 45 54 45 20 20 20 20 20 20 20 20 20 20  DELETE          
5170: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5180: 7c 20 28 31 30 3c 3c 38 29 29 0a 23 64 65 66 69  | (10<<8)).#defi
5190: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
51a0: 42 4c 4f 43 4b 45 44 20 20 20 20 20 20 20 20 20  BLOCKED         
51b0: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
51c0: 7c 20 28 31 31 3c 3c 38 29 29 0a 23 64 65 66 69  | (11<<8)).#defi
51d0: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
51e0: 4e 4f 4d 45 4d 20 20 20 20 20 20 20 20 20 20 20  NOMEM           
51f0: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5200: 7c 20 28 31 32 3c 3c 38 29 29 0a 23 64 65 66 69  | (12<<8)).#defi
5210: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
5220: 41 43 43 45 53 53 20 20 20 20 20 20 20 20 20 20  ACCESS          
5230: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5240: 7c 20 28 31 33 3c 3c 38 29 29 0a 23 64 65 66 69  | (13<<8)).#defi
5250: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
5260: 43 48 45 43 4b 52 45 53 45 52 56 45 44 4c 4f 43  CHECKRESERVEDLOC
5270: 4b 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20  K (SQLITE_IOERR 
5280: 7c 20 28 31 34 3c 3c 38 29 29 0a 23 64 65 66 69  | (14<<8)).#defi
5290: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
52a0: 4c 4f 43 4b 20 20 20 20 20 20 20 20 20 20 20 20  LOCK            
52b0: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
52c0: 7c 20 28 31 35 3c 3c 38 29 29 0a 23 64 65 66 69  | (15<<8)).#defi
52d0: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
52e0: 43 4c 4f 53 45 20 20 20 20 20 20 20 20 20 20 20  CLOSE           
52f0: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5300: 7c 20 28 31 36 3c 3c 38 29 29 0a 23 64 65 66 69  | (16<<8)).#defi
5310: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
5320: 44 49 52 5f 43 4c 4f 53 45 20 20 20 20 20 20 20  DIR_CLOSE       
5330: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5340: 7c 20 28 31 37 3c 3c 38 29 29 0a 23 64 65 66 69  | (17<<8)).#defi
5350: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
5360: 53 48 4d 4f 50 45 4e 20 20 20 20 20 20 20 20 20  SHMOPEN         
5370: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5380: 7c 20 28 31 38 3c 3c 38 29 29 0a 23 64 65 66 69  | (18<<8)).#defi
5390: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
53a0: 53 48 4d 53 49 5a 45 20 20 20 20 20 20 20 20 20  SHMSIZE         
53b0: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
53c0: 7c 20 28 31 39 3c 3c 38 29 29 0a 23 64 65 66 69  | (19<<8)).#defi
53d0: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
53e0: 53 48 4d 4c 4f 43 4b 20 20 20 20 20 20 20 20 20  SHMLOCK         
53f0: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5400: 7c 20 28 32 30 3c 3c 38 29 29 0a 23 64 65 66 69  | (20<<8)).#defi
5410: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
5420: 53 48 4d 4d 41 50 20 20 20 20 20 20 20 20 20 20  SHMMAP          
5430: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5440: 7c 20 28 32 31 3c 3c 38 29 29 0a 23 64 65 66 69  | (21<<8)).#defi
5450: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
5460: 53 45 45 4b 20 20 20 20 20 20 20 20 20 20 20 20  SEEK            
5470: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5480: 7c 20 28 32 32 3c 3c 38 29 29 0a 23 64 65 66 69  | (22<<8)).#defi
5490: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
54a0: 44 45 4c 45 54 45 5f 4e 4f 45 4e 54 20 20 20 20  DELETE_NOENT    
54b0: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
54c0: 7c 20 28 32 33 3c 3c 38 29 29 0a 23 64 65 66 69  | (23<<8)).#defi
54d0: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
54e0: 4d 4d 41 50 20 20 20 20 20 20 20 20 20 20 20 20  MMAP            
54f0: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5500: 7c 20 28 32 34 3c 3c 38 29 29 0a 23 64 65 66 69  | (24<<8)).#defi
5510: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
5520: 47 45 54 54 45 4d 50 50 41 54 48 20 20 20 20 20  GETTEMPPATH     
5530: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5540: 7c 20 28 32 35 3c 3c 38 29 29 0a 23 64 65 66 69  | (25<<8)).#defi
5550: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
5560: 43 4f 4e 56 50 41 54 48 20 20 20 20 20 20 20 20  CONVPATH        
5570: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5580: 7c 20 28 32 36 3c 3c 38 29 29 0a 23 64 65 66 69  | (26<<8)).#defi
5590: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
55a0: 56 4e 4f 44 45 20 20 20 20 20 20 20 20 20 20 20  VNODE           
55b0: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
55c0: 7c 20 28 32 37 3c 3c 38 29 29 0a 23 64 65 66 69  | (27<<8)).#defi
55d0: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
55e0: 41 55 54 48 20 20 20 20 20 20 20 20 20 20 20 20  AUTH            
55f0: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5600: 7c 20 28 32 38 3c 3c 38 29 29 0a 23 64 65 66 69  | (28<<8)).#defi
5610: 6e 65 20 53 51 4c 49 54 45 5f 4c 4f 43 4b 45 44  ne SQLITE_LOCKED
5620: 5f 53 48 41 52 45 44 43 41 43 48 45 20 20 20 20  _SHAREDCACHE    
5630: 20 20 28 53 51 4c 49 54 45 5f 4c 4f 43 4b 45 44    (SQLITE_LOCKED
5640: 20 7c 20 20 28 31 3c 3c 38 29 29 0a 23 64 65 66   |  (1<<8)).#def
5650: 69 6e 65 20 53 51 4c 49 54 45 5f 42 55 53 59 5f  ine SQLITE_BUSY_
5660: 52 45 43 4f 56 45 52 59 20 20 20 20 20 20 20 20  RECOVERY        
5670: 20 20 20 28 53 51 4c 49 54 45 5f 42 55 53 59 20     (SQLITE_BUSY 
5680: 20 20 7c 20 20 28 31 3c 3c 38 29 29 0a 23 64 65    |  (1<<8)).#de
5690: 66 69 6e 65 20 53 51 4c 49 54 45 5f 42 55 53 59  fine SQLITE_BUSY
56a0: 5f 53 4e 41 50 53 48 4f 54 20 20 20 20 20 20 20  _SNAPSHOT       
56b0: 20 20 20 20 28 53 51 4c 49 54 45 5f 42 55 53 59      (SQLITE_BUSY
56c0: 20 20 20 7c 20 20 28 32 3c 3c 38 29 29 0a 23 64     |  (2<<8)).#d
56d0: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 41 4e  efine SQLITE_CAN
56e0: 54 4f 50 45 4e 5f 4e 4f 54 45 4d 50 44 49 52 20  TOPEN_NOTEMPDIR 
56f0: 20 20 20 20 20 28 53 51 4c 49 54 45 5f 43 41 4e       (SQLITE_CAN
5700: 54 4f 50 45 4e 20 7c 20 28 31 3c 3c 38 29 29 0a  TOPEN | (1<<8)).
5710: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43  #define SQLITE_C
5720: 41 4e 54 4f 50 45 4e 5f 49 53 44 49 52 20 20 20  ANTOPEN_ISDIR   
5730: 20 20 20 20 20 20 20 28 53 51 4c 49 54 45 5f 43         (SQLITE_C
5740: 41 4e 54 4f 50 45 4e 20 7c 20 28 32 3c 3c 38 29  ANTOPEN | (2<<8)
5750: 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  ).#define SQLITE
5760: 5f 43 41 4e 54 4f 50 45 4e 5f 46 55 4c 4c 50 41  _CANTOPEN_FULLPA
5770: 54 48 20 20 20 20 20 20 20 28 53 51 4c 49 54 45  TH       (SQLITE
5780: 5f 43 41 4e 54 4f 50 45 4e 20 7c 20 28 33 3c 3c  _CANTOPEN | (3<<
5790: 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  8)).#define SQLI
57a0: 54 45 5f 43 41 4e 54 4f 50 45 4e 5f 43 4f 4e 56  TE_CANTOPEN_CONV
57b0: 50 41 54 48 20 20 20 20 20 20 20 28 53 51 4c 49  PATH       (SQLI
57c0: 54 45 5f 43 41 4e 54 4f 50 45 4e 20 7c 20 28 34  TE_CANTOPEN | (4
57d0: 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51  <<8)).#define SQ
57e0: 4c 49 54 45 5f 43 4f 52 52 55 50 54 5f 56 54 41  LITE_CORRUPT_VTA
57f0: 42 20 20 20 20 20 20 20 20 20 20 20 20 28 53 51  B            (SQ
5800: 4c 49 54 45 5f 43 4f 52 52 55 50 54 20 7c 20 28  LITE_CORRUPT | (
5810: 31 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53  1<<8)).#define S
5820: 51 4c 49 54 45 5f 52 45 41 44 4f 4e 4c 59 5f 52  QLITE_READONLY_R
5830: 45 43 4f 56 45 52 59 20 20 20 20 20 20 20 28 53  ECOVERY       (S
5840: 51 4c 49 54 45 5f 52 45 41 44 4f 4e 4c 59 20 7c  QLITE_READONLY |
5850: 20 28 31 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65   (1<<8)).#define
5860: 20 53 51 4c 49 54 45 5f 52 45 41 44 4f 4e 4c 59   SQLITE_READONLY
5870: 5f 43 41 4e 54 4c 4f 43 4b 20 20 20 20 20 20 20  _CANTLOCK       
5880: 28 53 51 4c 49 54 45 5f 52 45 41 44 4f 4e 4c 59  (SQLITE_READONLY
5890: 20 7c 20 28 32 3c 3c 38 29 29 0a 23 64 65 66 69   | (2<<8)).#defi
58a0: 6e 65 20 53 51 4c 49 54 45 5f 52 45 41 44 4f 4e  ne SQLITE_READON
58b0: 4c 59 5f 52 4f 4c 4c 42 41 43 4b 20 20 20 20 20  LY_ROLLBACK     
58c0: 20 20 28 53 51 4c 49 54 45 5f 52 45 41 44 4f 4e    (SQLITE_READON
58d0: 4c 59 20 7c 20 28 33 3c 3c 38 29 29 0a 23 64 65  LY | (3<<8)).#de
58e0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 52 45 41 44  fine SQLITE_READ
58f0: 4f 4e 4c 59 5f 44 42 4d 4f 56 45 44 20 20 20 20  ONLY_DBMOVED    
5900: 20 20 20 20 28 53 51 4c 49 54 45 5f 52 45 41 44      (SQLITE_READ
5910: 4f 4e 4c 59 20 7c 20 28 34 3c 3c 38 29 29 0a 23  ONLY | (4<<8)).#
5920: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 41 42  define SQLITE_AB
5930: 4f 52 54 5f 52 4f 4c 4c 42 41 43 4b 20 20 20 20  ORT_ROLLBACK    
5940: 20 20 20 20 20 20 28 53 51 4c 49 54 45 5f 41 42        (SQLITE_AB
5950: 4f 52 54 20 7c 20 28 32 3c 3c 38 29 29 0a 23 64  ORT | (2<<8)).#d
5960: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e  efine SQLITE_CON
5970: 53 54 52 41 49 4e 54 5f 43 48 45 43 4b 20 20 20  STRAINT_CHECK   
5980: 20 20 20 20 20 28 53 51 4c 49 54 45 5f 43 4f 4e       (SQLITE_CON
5990: 53 54 52 41 49 4e 54 20 7c 20 28 31 3c 3c 38 29  STRAINT | (1<<8)
59a0: 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  ).#define SQLITE
59b0: 5f 43 4f 4e 53 54 52 41 49 4e 54 5f 43 4f 4d 4d  _CONSTRAINT_COMM
59c0: 49 54 48 4f 4f 4b 20 20 20 28 53 51 4c 49 54 45  ITHOOK   (SQLITE
59d0: 5f 43 4f 4e 53 54 52 41 49 4e 54 20 7c 20 28 32  _CONSTRAINT | (2
59e0: 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51  <<8)).#define SQ
59f0: 4c 49 54 45 5f 43 4f 4e 53 54 52 41 49 4e 54 5f  LITE_CONSTRAINT_
5a00: 46 4f 52 45 49 47 4e 4b 45 59 20 20 20 28 53 51  FOREIGNKEY   (SQ
5a10: 4c 49 54 45 5f 43 4f 4e 53 54 52 41 49 4e 54 20  LITE_CONSTRAINT 
5a20: 7c 20 28 33 3c 3c 38 29 29 0a 23 64 65 66 69 6e  | (3<<8)).#defin
5a30: 65 20 53 51 4c 49 54 45 5f 43 4f 4e 53 54 52 41  e SQLITE_CONSTRA
5a40: 49 4e 54 5f 46 55 4e 43 54 49 4f 4e 20 20 20 20  INT_FUNCTION    
5a50: 20 28 53 51 4c 49 54 45 5f 43 4f 4e 53 54 52 41   (SQLITE_CONSTRA
5a60: 49 4e 54 20 7c 20 28 34 3c 3c 38 29 29 0a 23 64  INT | (4<<8)).#d
5a70: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e  efine SQLITE_CON
5a80: 53 54 52 41 49 4e 54 5f 4e 4f 54 4e 55 4c 4c 20  STRAINT_NOTNULL 
5a90: 20 20 20 20 20 28 53 51 4c 49 54 45 5f 43 4f 4e       (SQLITE_CON
5aa0: 53 54 52 41 49 4e 54 20 7c 20 28 35 3c 3c 38 29  STRAINT | (5<<8)
5ab0: 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  ).#define SQLITE
5ac0: 5f 43 4f 4e 53 54 52 41 49 4e 54 5f 50 52 49 4d  _CONSTRAINT_PRIM
5ad0: 41 52 59 4b 45 59 20 20 20 28 53 51 4c 49 54 45  ARYKEY   (SQLITE
5ae0: 5f 43 4f 4e 53 54 52 41 49 4e 54 20 7c 20 28 36  _CONSTRAINT | (6
5af0: 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51  <<8)).#define SQ
5b00: 4c 49 54 45 5f 43 4f 4e 53 54 52 41 49 4e 54 5f  LITE_CONSTRAINT_
5b10: 54 52 49 47 47 45 52 20 20 20 20 20 20 28 53 51  TRIGGER      (SQ
5b20: 4c 49 54 45 5f 43 4f 4e 53 54 52 41 49 4e 54 20  LITE_CONSTRAINT 
5b30: 7c 20 28 37 3c 3c 38 29 29 0a 23 64 65 66 69 6e  | (7<<8)).#defin
5b40: 65 20 53 51 4c 49 54 45 5f 43 4f 4e 53 54 52 41  e SQLITE_CONSTRA
5b50: 49 4e 54 5f 55 4e 49 51 55 45 20 20 20 20 20 20  INT_UNIQUE      
5b60: 20 28 53 51 4c 49 54 45 5f 43 4f 4e 53 54 52 41   (SQLITE_CONSTRA
5b70: 49 4e 54 20 7c 20 28 38 3c 3c 38 29 29 0a 23 64  INT | (8<<8)).#d
5b80: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e  efine SQLITE_CON
5b90: 53 54 52 41 49 4e 54 5f 56 54 41 42 20 20 20 20  STRAINT_VTAB    
5ba0: 20 20 20 20 20 28 53 51 4c 49 54 45 5f 43 4f 4e       (SQLITE_CON
5bb0: 53 54 52 41 49 4e 54 20 7c 20 28 39 3c 3c 38 29  STRAINT | (9<<8)
5bc0: 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  ).#define SQLITE
5bd0: 5f 43 4f 4e 53 54 52 41 49 4e 54 5f 52 4f 57 49  _CONSTRAINT_ROWI
5be0: 44 20 20 20 20 20 20 20 20 28 53 51 4c 49 54 45  D        (SQLITE
5bf0: 5f 43 4f 4e 53 54 52 41 49 4e 54 20 7c 28 31 30  _CONSTRAINT |(10
5c00: 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51  <<8)).#define SQ
5c10: 4c 49 54 45 5f 4e 4f 54 49 43 45 5f 52 45 43 4f  LITE_NOTICE_RECO
5c20: 56 45 52 5f 57 41 4c 20 20 20 20 20 20 28 53 51  VER_WAL      (SQ
5c30: 4c 49 54 45 5f 4e 4f 54 49 43 45 20 7c 20 28 31  LITE_NOTICE | (1
5c40: 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51  <<8)).#define SQ
5c50: 4c 49 54 45 5f 4e 4f 54 49 43 45 5f 52 45 43 4f  LITE_NOTICE_RECO
5c60: 56 45 52 5f 52 4f 4c 4c 42 41 43 4b 20 28 53 51  VER_ROLLBACK (SQ
5c70: 4c 49 54 45 5f 4e 4f 54 49 43 45 20 7c 20 28 32  LITE_NOTICE | (2
5c80: 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51  <<8)).#define SQ
5c90: 4c 49 54 45 5f 57 41 52 4e 49 4e 47 5f 41 55 54  LITE_WARNING_AUT
5ca0: 4f 49 4e 44 45 58 20 20 20 20 20 20 20 28 53 51  OINDEX       (SQ
5cb0: 4c 49 54 45 5f 57 41 52 4e 49 4e 47 20 7c 20 28  LITE_WARNING | (
5cc0: 31 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53  1<<8)).#define S
5cd0: 51 4c 49 54 45 5f 41 55 54 48 5f 55 53 45 52 20  QLITE_AUTH_USER 
5ce0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 28 53                (S
5cf0: 51 4c 49 54 45 5f 41 55 54 48 20 7c 20 28 31 3c  QLITE_AUTH | (1<
5d00: 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c  <8)).#define SQL
5d10: 49 54 45 5f 4f 4b 5f 4c 4f 41 44 5f 50 45 52 4d  ITE_OK_LOAD_PERM
5d20: 41 4e 45 4e 54 4c 59 20 20 20 20 20 28 53 51 4c  ANENTLY     (SQL
5d30: 49 54 45 5f 4f 4b 20 7c 20 28 31 3c 3c 38 29 29  ITE_OK | (1<<8))
5d40: 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46  ../*.** CAPI3REF
5d50: 3a 20 46 6c 61 67 73 20 46 6f 72 20 46 69 6c 65  : Flags For File
5d60: 20 4f 70 65 6e 20 4f 70 65 72 61 74 69 6f 6e 73   Open Operations
5d70: 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 62 69 74  .**.** These bit
5d80: 20 76 61 6c 75 65 73 20 61 72 65 20 69 6e 74 65   values are inte
5d90: 6e 64 65 64 20 66 6f 72 20 75 73 65 20 69 6e 20  nded for use in 
5da0: 74 68 65 0a 2a 2a 20 33 72 64 20 70 61 72 61 6d  the.** 3rd param
5db0: 65 74 65 72 20 74 6f 20 74 68 65 20 5b 73 71 6c  eter to the [sql
5dc0: 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29 5d 20  ite3_open_v2()] 
5dd0: 69 6e 74 65 72 66 61 63 65 20 61 6e 64 0a 2a 2a  interface and.**
5de0: 20 69 6e 20 74 68 65 20 34 74 68 20 70 61 72 61   in the 4th para
5df0: 6d 65 74 65 72 20 74 6f 20 74 68 65 20 5b 73 71  meter to the [sq
5e00: 6c 69 74 65 33 5f 76 66 73 2e 78 4f 70 65 6e 5d  lite3_vfs.xOpen]
5e10: 20 6d 65 74 68 6f 64 2e 0a 2a 2f 0a 23 64 65 66   method..*/.#def
5e20: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
5e30: 52 45 41 44 4f 4e 4c 59 20 20 20 20 20 20 20 20  READONLY        
5e40: 20 30 78 30 30 30 30 30 30 30 31 20 20 2f 2a 20   0x00000001  /* 
5e50: 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f 6f  Ok for sqlite3_o
5e60: 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65 66  pen_v2() */.#def
5e70: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
5e80: 52 45 41 44 57 52 49 54 45 20 20 20 20 20 20 20  READWRITE       
5e90: 20 30 78 30 30 30 30 30 30 30 32 20 20 2f 2a 20   0x00000002  /* 
5ea0: 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f 6f  Ok for sqlite3_o
5eb0: 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65 66  pen_v2() */.#def
5ec0: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
5ed0: 43 52 45 41 54 45 20 20 20 20 20 20 20 20 20 20  CREATE          
5ee0: 20 30 78 30 30 30 30 30 30 30 34 20 20 2f 2a 20   0x00000004  /* 
5ef0: 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f 6f  Ok for sqlite3_o
5f00: 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65 66  pen_v2() */.#def
5f10: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
5f20: 44 45 4c 45 54 45 4f 4e 43 4c 4f 53 45 20 20 20  DELETEONCLOSE   
5f30: 20 30 78 30 30 30 30 30 30 30 38 20 20 2f 2a 20   0x00000008  /* 
5f40: 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65 66  VFS only */.#def
5f50: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
5f60: 45 58 43 4c 55 53 49 56 45 20 20 20 20 20 20 20  EXCLUSIVE       
5f70: 20 30 78 30 30 30 30 30 30 31 30 20 20 2f 2a 20   0x00000010  /* 
5f80: 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65 66  VFS only */.#def
5f90: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
5fa0: 41 55 54 4f 50 52 4f 58 59 20 20 20 20 20 20 20  AUTOPROXY       
5fb0: 20 30 78 30 30 30 30 30 30 32 30 20 20 2f 2a 20   0x00000020  /* 
5fc0: 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65 66  VFS only */.#def
5fd0: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
5fe0: 55 52 49 20 20 20 20 20 20 20 20 20 20 20 20 20  URI             
5ff0: 20 30 78 30 30 30 30 30 30 34 30 20 20 2f 2a 20   0x00000040  /* 
6000: 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f 6f  Ok for sqlite3_o
6010: 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65 66  pen_v2() */.#def
6020: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
6030: 4d 45 4d 4f 52 59 20 20 20 20 20 20 20 20 20 20  MEMORY          
6040: 20 30 78 30 30 30 30 30 30 38 30 20 20 2f 2a 20   0x00000080  /* 
6050: 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f 6f  Ok for sqlite3_o
6060: 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65 66  pen_v2() */.#def
6070: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
6080: 4d 41 49 4e 5f 44 42 20 20 20 20 20 20 20 20 20  MAIN_DB         
6090: 20 30 78 30 30 30 30 30 31 30 30 20 20 2f 2a 20   0x00000100  /* 
60a0: 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65 66  VFS only */.#def
60b0: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
60c0: 54 45 4d 50 5f 44 42 20 20 20 20 20 20 20 20 20  TEMP_DB         
60d0: 20 30 78 30 30 30 30 30 32 30 30 20 20 2f 2a 20   0x00000200  /* 
60e0: 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65 66  VFS only */.#def
60f0: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
6100: 54 52 41 4e 53 49 45 4e 54 5f 44 42 20 20 20 20  TRANSIENT_DB    
6110: 20 30 78 30 30 30 30 30 34 30 30 20 20 2f 2a 20   0x00000400  /* 
6120: 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65 66  VFS only */.#def
6130: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
6140: 4d 41 49 4e 5f 4a 4f 55 52 4e 41 4c 20 20 20 20  MAIN_JOURNAL    
6150: 20 30 78 30 30 30 30 30 38 30 30 20 20 2f 2a 20   0x00000800  /* 
6160: 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65 66  VFS only */.#def
6170: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
6180: 54 45 4d 50 5f 4a 4f 55 52 4e 41 4c 20 20 20 20  TEMP_JOURNAL    
6190: 20 30 78 30 30 30 30 31 30 30 30 20 20 2f 2a 20   0x00001000  /* 
61a0: 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65 66  VFS only */.#def
61b0: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
61c0: 53 55 42 4a 4f 55 52 4e 41 4c 20 20 20 20 20 20  SUBJOURNAL      
61d0: 20 30 78 30 30 30 30 32 30 30 30 20 20 2f 2a 20   0x00002000  /* 
61e0: 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65 66  VFS only */.#def
61f0: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
6200: 4d 41 53 54 45 52 5f 4a 4f 55 52 4e 41 4c 20 20  MASTER_JOURNAL  
6210: 20 30 78 30 30 30 30 34 30 30 30 20 20 2f 2a 20   0x00004000  /* 
6220: 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65 66  VFS only */.#def
6230: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
6240: 4e 4f 4d 55 54 45 58 20 20 20 20 20 20 20 20 20  NOMUTEX         
6250: 20 30 78 30 30 30 30 38 30 30 30 20 20 2f 2a 20   0x00008000  /* 
6260: 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f 6f  Ok for sqlite3_o
6270: 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65 66  pen_v2() */.#def
6280: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
6290: 46 55 4c 4c 4d 55 54 45 58 20 20 20 20 20 20 20  FULLMUTEX       
62a0: 20 30 78 30 30 30 31 30 30 30 30 20 20 2f 2a 20   0x00010000  /* 
62b0: 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f 6f  Ok for sqlite3_o
62c0: 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65 66  pen_v2() */.#def
62d0: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
62e0: 53 48 41 52 45 44 43 41 43 48 45 20 20 20 20 20  SHAREDCACHE     
62f0: 20 30 78 30 30 30 32 30 30 30 30 20 20 2f 2a 20   0x00020000  /* 
6300: 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f 6f  Ok for sqlite3_o
6310: 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65 66  pen_v2() */.#def
6320: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
6330: 50 52 49 56 41 54 45 43 41 43 48 45 20 20 20 20  PRIVATECACHE    
6340: 20 30 78 30 30 30 34 30 30 30 30 20 20 2f 2a 20   0x00040000  /* 
6350: 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f 6f  Ok for sqlite3_o
6360: 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65 66  pen_v2() */.#def
6370: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
6380: 57 41 4c 20 20 20 20 20 20 20 20 20 20 20 20 20  WAL             
6390: 20 30 78 30 30 30 38 30 30 30 30 20 20 2f 2a 20   0x00080000  /* 
63a0: 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 0a 2f 2a 20  VFS only */../* 
63b0: 52 65 73 65 72 76 65 64 3a 20 20 20 20 20 20 20  Reserved:       
63c0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
63d0: 20 20 30 78 30 30 46 30 30 30 30 30 20 2a 2f 0a    0x00F00000 */.
63e0: 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
63f0: 20 44 65 76 69 63 65 20 43 68 61 72 61 63 74 65   Device Characte
6400: 72 69 73 74 69 63 73 0a 2a 2a 0a 2a 2a 20 54 68  ristics.**.** Th
6410: 65 20 78 44 65 76 69 63 65 43 68 61 72 61 63 74  e xDeviceCharact
6420: 65 72 69 73 74 69 63 73 20 6d 65 74 68 6f 64 20  eristics method 
6430: 6f 66 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  of the [sqlite3_
6440: 69 6f 5f 6d 65 74 68 6f 64 73 5d 0a 2a 2a 20 6f  io_methods].** o
6450: 62 6a 65 63 74 20 72 65 74 75 72 6e 73 20 61 6e  bject returns an
6460: 20 69 6e 74 65 67 65 72 20 77 68 69 63 68 20 69   integer which i
6470: 73 20 61 20 76 65 63 74 6f 72 20 6f 66 20 74 68  s a vector of th
6480: 65 73 65 0a 2a 2a 20 62 69 74 20 76 61 6c 75 65  ese.** bit value
6490: 73 20 65 78 70 72 65 73 73 69 6e 67 20 49 2f 4f  s expressing I/O
64a0: 20 63 68 61 72 61 63 74 65 72 69 73 74 69 63 73   characteristics
64b0: 20 6f 66 20 74 68 65 20 6d 61 73 73 20 73 74 6f   of the mass sto
64c0: 72 61 67 65 0a 2a 2a 20 64 65 76 69 63 65 20 74  rage.** device t
64d0: 68 61 74 20 68 6f 6c 64 73 20 74 68 65 20 66 69  hat holds the fi
64e0: 6c 65 20 74 68 61 74 20 74 68 65 20 5b 73 71 6c  le that the [sql
64f0: 69 74 65 33 5f 69 6f 5f 6d 65 74 68 6f 64 73 5d  ite3_io_methods]
6500: 0a 2a 2a 20 72 65 66 65 72 73 20 74 6f 2e 0a 2a  .** refers to..*
6510: 2a 0a 2a 2a 20 54 68 65 20 53 51 4c 49 54 45 5f  *.** The SQLITE_
6520: 49 4f 43 41 50 5f 41 54 4f 4d 49 43 20 70 72 6f  IOCAP_ATOMIC pro
6530: 70 65 72 74 79 20 6d 65 61 6e 73 20 74 68 61 74  perty means that
6540: 20 61 6c 6c 20 77 72 69 74 65 73 20 6f 66 0a 2a   all writes of.*
6550: 2a 20 61 6e 79 20 73 69 7a 65 20 61 72 65 20 61  * any size are a
6560: 74 6f 6d 69 63 2e 20 20 54 68 65 20 53 51 4c 49  tomic.  The SQLI
6570: 54 45 5f 49 4f 43 41 50 5f 41 54 4f 4d 49 43 6e  TE_IOCAP_ATOMICn
6580: 6e 6e 20 76 61 6c 75 65 73 0a 2a 2a 20 6d 65 61  nn values.** mea
6590: 6e 20 74 68 61 74 20 77 72 69 74 65 73 20 6f 66  n that writes of
65a0: 20 62 6c 6f 63 6b 73 20 74 68 61 74 20 61 72 65   blocks that are
65b0: 20 6e 6e 6e 20 62 79 74 65 73 20 69 6e 20 73 69   nnn bytes in si
65c0: 7a 65 20 61 6e 64 0a 2a 2a 20 61 72 65 20 61 6c  ze and.** are al
65d0: 69 67 6e 65 64 20 74 6f 20 61 6e 20 61 64 64 72  igned to an addr
65e0: 65 73 73 20 77 68 69 63 68 20 69 73 20 61 6e 20  ess which is an 
65f0: 69 6e 74 65 67 65 72 20 6d 75 6c 74 69 70 6c 65  integer multiple
6600: 20 6f 66 0a 2a 2a 20 6e 6e 6e 20 61 72 65 20 61   of.** nnn are a
6610: 74 6f 6d 69 63 2e 20 20 54 68 65 20 53 51 4c 49  tomic.  The SQLI
6620: 54 45 5f 49 4f 43 41 50 5f 53 41 46 45 5f 41 50  TE_IOCAP_SAFE_AP
6630: 50 45 4e 44 20 76 61 6c 75 65 20 6d 65 61 6e 73  PEND value means
6640: 0a 2a 2a 20 74 68 61 74 20 77 68 65 6e 20 64 61  .** that when da
6650: 74 61 20 69 73 20 61 70 70 65 6e 64 65 64 20 74  ta is appended t
6660: 6f 20 61 20 66 69 6c 65 2c 20 74 68 65 20 64 61  o a file, the da
6670: 74 61 20 69 73 20 61 70 70 65 6e 64 65 64 0a 2a  ta is appended.*
6680: 2a 20 66 69 72 73 74 20 74 68 65 6e 20 74 68 65  * first then the
6690: 20 73 69 7a 65 20 6f 66 20 74 68 65 20 66 69 6c   size of the fil
66a0: 65 20 69 73 20 65 78 74 65 6e 64 65 64 2c 20 6e  e is extended, n
66b0: 65 76 65 72 20 74 68 65 20 6f 74 68 65 72 0a 2a  ever the other.*
66c0: 2a 20 77 61 79 20 61 72 6f 75 6e 64 2e 20 20 54  * way around.  T
66d0: 68 65 20 53 51 4c 49 54 45 5f 49 4f 43 41 50 5f  he SQLITE_IOCAP_
66e0: 53 45 51 55 45 4e 54 49 41 4c 20 70 72 6f 70 65  SEQUENTIAL prope
66f0: 72 74 79 20 6d 65 61 6e 73 20 74 68 61 74 0a 2a  rty means that.*
6700: 2a 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 69 73  * information is
6710: 20 77 72 69 74 74 65 6e 20 74 6f 20 64 69 73 6b   written to disk
6720: 20 69 6e 20 74 68 65 20 73 61 6d 65 20 6f 72 64   in the same ord
6730: 65 72 20 61 73 20 63 61 6c 6c 73 0a 2a 2a 20 74  er as calls.** t
6740: 6f 20 78 57 72 69 74 65 28 29 2e 20 20 54 68 65  o xWrite().  The
6750: 20 53 51 4c 49 54 45 5f 49 4f 43 41 50 5f 50 4f   SQLITE_IOCAP_PO
6760: 57 45 52 53 41 46 45 5f 4f 56 45 52 57 52 49 54  WERSAFE_OVERWRIT
6770: 45 20 70 72 6f 70 65 72 74 79 20 6d 65 61 6e 73  E property means
6780: 20 74 68 61 74 0a 2a 2a 20 61 66 74 65 72 20 72   that.** after r
6790: 65 62 6f 6f 74 20 66 6f 6c 6c 6f 77 69 6e 67 20  eboot following 
67a0: 61 20 63 72 61 73 68 20 6f 72 20 70 6f 77 65 72  a crash or power
67b0: 20 6c 6f 73 73 2c 20 74 68 65 20 6f 6e 6c 79 20   loss, the only 
67c0: 62 79 74 65 73 20 69 6e 20 61 0a 2a 2a 20 66 69  bytes in a.** fi
67d0: 6c 65 20 74 68 61 74 20 77 65 72 65 20 77 72 69  le that were wri
67e0: 74 74 65 6e 20 61 74 20 74 68 65 20 61 70 70 6c  tten at the appl
67f0: 69 63 61 74 69 6f 6e 20 6c 65 76 65 6c 20 6d 69  ication level mi
6800: 67 68 74 20 68 61 76 65 20 63 68 61 6e 67 65 64  ght have changed
6810: 0a 2a 2a 20 61 6e 64 20 74 68 61 74 20 61 64 6a  .** and that adj
6820: 61 63 65 6e 74 20 62 79 74 65 73 2c 20 65 76 65  acent bytes, eve
6830: 6e 20 62 79 74 65 73 20 77 69 74 68 69 6e 20 74  n bytes within t
6840: 68 65 20 73 61 6d 65 20 73 65 63 74 6f 72 20 61  he same sector a
6850: 72 65 0a 2a 2a 20 67 75 61 72 61 6e 74 65 65 64  re.** guaranteed
6860: 20 74 6f 20 62 65 20 75 6e 63 68 61 6e 67 65 64   to be unchanged
6870: 2e 20 20 54 68 65 20 53 51 4c 49 54 45 5f 49 4f  .  The SQLITE_IO
6880: 43 41 50 5f 55 4e 44 45 4c 45 54 41 42 4c 45 5f  CAP_UNDELETABLE_
6890: 57 48 45 4e 5f 4f 50 45 4e 0a 2a 2a 20 66 6c 61  WHEN_OPEN.** fla
68a0: 67 20 69 6e 64 69 63 61 74 65 20 74 68 61 74 20  g indicate that 
68b0: 61 20 66 69 6c 65 20 63 61 6e 6e 6f 74 20 62 65  a file cannot be
68c0: 20 64 65 6c 65 74 65 64 20 77 68 65 6e 20 6f 70   deleted when op
68d0: 65 6e 2e 20 20 54 68 65 0a 2a 2a 20 53 51 4c 49  en.  The.** SQLI
68e0: 54 45 5f 49 4f 43 41 50 5f 49 4d 4d 55 54 41 42  TE_IOCAP_IMMUTAB
68f0: 4c 45 20 66 6c 61 67 20 69 6e 64 69 63 61 74 65  LE flag indicate
6900: 73 20 74 68 61 74 20 74 68 65 20 66 69 6c 65 20  s that the file 
6910: 69 73 20 6f 6e 0a 2a 2a 20 72 65 61 64 2d 6f 6e  is on.** read-on
6920: 6c 79 20 6d 65 64 69 61 20 61 6e 64 20 63 61 6e  ly media and can
6930: 6e 6f 74 20 62 65 20 63 68 61 6e 67 65 64 20 65  not be changed e
6940: 76 65 6e 20 62 79 20 70 72 6f 63 65 73 73 65 73  ven by processes
6950: 20 77 69 74 68 0a 2a 2a 20 65 6c 65 76 61 74 65   with.** elevate
6960: 64 20 70 72 69 76 69 6c 65 67 65 73 2e 0a 2a 2f  d privileges..*/
6970: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
6980: 49 4f 43 41 50 5f 41 54 4f 4d 49 43 20 20 20 20  IOCAP_ATOMIC    
6990: 20 20 20 20 20 20 20 20 20 20 20 20 20 30 78 30               0x0
69a0: 30 30 30 30 30 30 31 0a 23 64 65 66 69 6e 65 20  0000001.#define 
69b0: 53 51 4c 49 54 45 5f 49 4f 43 41 50 5f 41 54 4f  SQLITE_IOCAP_ATO
69c0: 4d 49 43 35 31 32 20 20 20 20 20 20 20 20 20 20  MIC512          
69d0: 20 20 20 20 30 78 30 30 30 30 30 30 30 32 0a 23      0x00000002.#
69e0: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f  define SQLITE_IO
69f0: 43 41 50 5f 41 54 4f 4d 49 43 31 4b 20 20 20 20  CAP_ATOMIC1K    
6a00: 20 20 20 20 20 20 20 20 20 20 20 30 78 30 30 30             0x000
6a10: 30 30 30 30 34 0a 23 64 65 66 69 6e 65 20 53 51  00004.#define SQ
6a20: 4c 49 54 45 5f 49 4f 43 41 50 5f 41 54 4f 4d 49  LITE_IOCAP_ATOMI
6a30: 43 32 4b 20 20 20 20 20 20 20 20 20 20 20 20 20  C2K             
6a40: 20 20 30 78 30 30 30 30 30 30 30 38 0a 23 64 65    0x00000008.#de
6a50: 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 43 41  fine SQLITE_IOCA
6a60: 50 5f 41 54 4f 4d 49 43 34 4b 20 20 20 20 20 20  P_ATOMIC4K      
6a70: 20 20 20 20 20 20 20 20 20 30 78 30 30 30 30 30           0x00000
6a80: 30 31 30 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  010.#define SQLI
6a90: 54 45 5f 49 4f 43 41 50 5f 41 54 4f 4d 49 43 38  TE_IOCAP_ATOMIC8
6aa0: 4b 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  K               
6ab0: 30 78 30 30 30 30 30 30 32 30 0a 23 64 65 66 69  0x00000020.#defi
6ac0: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 43 41 50 5f  ne SQLITE_IOCAP_
6ad0: 41 54 4f 4d 49 43 31 36 4b 20 20 20 20 20 20 20  ATOMIC16K       
6ae0: 20 20 20 20 20 20 20 30 78 30 30 30 30 30 30 34         0x0000004
6af0: 30 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  0.#define SQLITE
6b00: 5f 49 4f 43 41 50 5f 41 54 4f 4d 49 43 33 32 4b  _IOCAP_ATOMIC32K
6b10: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 30 78                0x
6b20: 30 30 30 30 30 30 38 30 0a 23 64 65 66 69 6e 65  00000080.#define
6b30: 20 53 51 4c 49 54 45 5f 49 4f 43 41 50 5f 41 54   SQLITE_IOCAP_AT
6b40: 4f 4d 49 43 36 34 4b 20 20 20 20 20 20 20 20 20  OMIC64K         
6b50: 20 20 20 20 20 30 78 30 30 30 30 30 31 30 30 0a       0x00000100.
6b60: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49  #define SQLITE_I
6b70: 4f 43 41 50 5f 53 41 46 45 5f 41 50 50 45 4e 44  OCAP_SAFE_APPEND
6b80: 20 20 20 20 20 20 20 20 20 20 20 20 30 78 30 30              0x00
6b90: 30 30 30 32 30 30 0a 23 64 65 66 69 6e 65 20 53  000200.#define S
6ba0: 51 4c 49 54 45 5f 49 4f 43 41 50 5f 53 45 51 55  QLITE_IOCAP_SEQU
6bb0: 45 4e 54 49 41 4c 20 20 20 20 20 20 20 20 20 20  ENTIAL          
6bc0: 20 20 20 30 78 30 30 30 30 30 34 30 30 0a 23 64     0x00000400.#d
6bd0: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 43  efine SQLITE_IOC
6be0: 41 50 5f 55 4e 44 45 4c 45 54 41 42 4c 45 5f 57  AP_UNDELETABLE_W
6bf0: 48 45 4e 5f 4f 50 45 4e 20 20 30 78 30 30 30 30  HEN_OPEN  0x0000
6c00: 30 38 30 30 0a 23 64 65 66 69 6e 65 20 53 51 4c  0800.#define SQL
6c10: 49 54 45 5f 49 4f 43 41 50 5f 50 4f 57 45 52 53  ITE_IOCAP_POWERS
6c20: 41 46 45 5f 4f 56 45 52 57 52 49 54 45 20 20 20  AFE_OVERWRITE   
6c30: 20 30 78 30 30 30 30 31 30 30 30 0a 23 64 65 66   0x00001000.#def
6c40: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 43 41 50  ine SQLITE_IOCAP
6c50: 5f 49 4d 4d 55 54 41 42 4c 45 20 20 20 20 20 20  _IMMUTABLE      
6c60: 20 20 20 20 20 20 20 20 30 78 30 30 30 30 32 30          0x000020
6c70: 30 30 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  00../*.** CAPI3R
6c80: 45 46 3a 20 46 69 6c 65 20 4c 6f 63 6b 69 6e 67  EF: File Locking
6c90: 20 4c 65 76 65 6c 73 0a 2a 2a 0a 2a 2a 20 53 51   Levels.**.** SQ
6ca0: 4c 69 74 65 20 75 73 65 73 20 6f 6e 65 20 6f 66  Lite uses one of
6cb0: 20 74 68 65 73 65 20 69 6e 74 65 67 65 72 20 76   these integer v
6cc0: 61 6c 75 65 73 20 61 73 20 74 68 65 20 73 65 63  alues as the sec
6cd0: 6f 6e 64 0a 2a 2a 20 61 72 67 75 6d 65 6e 74 20  ond.** argument 
6ce0: 74 6f 20 63 61 6c 6c 73 20 69 74 20 6d 61 6b 65  to calls it make
6cf0: 73 20 74 6f 20 74 68 65 20 78 4c 6f 63 6b 28 29  s to the xLock()
6d00: 20 61 6e 64 20 78 55 6e 6c 6f 63 6b 28 29 20 6d   and xUnlock() m
6d10: 65 74 68 6f 64 73 0a 2a 2a 20 6f 66 20 61 6e 20  ethods.** of an 
6d20: 5b 73 71 6c 69 74 65 33 5f 69 6f 5f 6d 65 74 68  [sqlite3_io_meth
6d30: 6f 64 73 5d 20 6f 62 6a 65 63 74 2e 0a 2a 2f 0a  ods] object..*/.
6d40: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c  #define SQLITE_L
6d50: 4f 43 4b 5f 4e 4f 4e 45 20 20 20 20 20 20 20 20  OCK_NONE        
6d60: 20 20 30 0a 23 64 65 66 69 6e 65 20 53 51 4c 49    0.#define SQLI
6d70: 54 45 5f 4c 4f 43 4b 5f 53 48 41 52 45 44 20 20  TE_LOCK_SHARED  
6d80: 20 20 20 20 20 20 31 0a 23 64 65 66 69 6e 65 20        1.#define 
6d90: 53 51 4c 49 54 45 5f 4c 4f 43 4b 5f 52 45 53 45  SQLITE_LOCK_RESE
6da0: 52 56 45 44 20 20 20 20 20 20 32 0a 23 64 65 66  RVED      2.#def
6db0: 69 6e 65 20 53 51 4c 49 54 45 5f 4c 4f 43 4b 5f  ine SQLITE_LOCK_
6dc0: 50 45 4e 44 49 4e 47 20 20 20 20 20 20 20 33 0a  PENDING       3.
6dd0: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c  #define SQLITE_L
6de0: 4f 43 4b 5f 45 58 43 4c 55 53 49 56 45 20 20 20  OCK_EXCLUSIVE   
6df0: 20 20 34 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33    4../*.** CAPI3
6e00: 52 45 46 3a 20 53 79 6e 63 68 72 6f 6e 69 7a 61  REF: Synchroniza
6e10: 74 69 6f 6e 20 54 79 70 65 20 46 6c 61 67 73 0a  tion Type Flags.
6e20: 2a 2a 0a 2a 2a 20 57 68 65 6e 20 53 51 4c 69 74  **.** When SQLit
6e30: 65 20 69 6e 76 6f 6b 65 73 20 74 68 65 20 78 53  e invokes the xS
6e40: 79 6e 63 28 29 20 6d 65 74 68 6f 64 20 6f 66 20  ync() method of 
6e50: 61 6e 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 69  an.** [sqlite3_i
6e60: 6f 5f 6d 65 74 68 6f 64 73 5d 20 6f 62 6a 65 63  o_methods] objec
6e70: 74 20 69 74 20 75 73 65 73 20 61 20 63 6f 6d 62  t it uses a comb
6e80: 69 6e 61 74 69 6f 6e 20 6f 66 0a 2a 2a 20 74 68  ination of.** th
6e90: 65 73 65 20 69 6e 74 65 67 65 72 20 76 61 6c 75  ese integer valu
6ea0: 65 73 20 61 73 20 74 68 65 20 73 65 63 6f 6e 64  es as the second
6eb0: 20 61 72 67 75 6d 65 6e 74 2e 0a 2a 2a 0a 2a 2a   argument..**.**
6ec0: 20 57 68 65 6e 20 74 68 65 20 53 51 4c 49 54 45   When the SQLITE
6ed0: 5f 53 59 4e 43 5f 44 41 54 41 4f 4e 4c 59 20 66  _SYNC_DATAONLY f
6ee0: 6c 61 67 20 69 73 20 75 73 65 64 2c 20 69 74 20  lag is used, it 
6ef0: 6d 65 61 6e 73 20 74 68 61 74 20 74 68 65 0a 2a  means that the.*
6f00: 2a 20 73 79 6e 63 20 6f 70 65 72 61 74 69 6f 6e  * sync operation
6f10: 20 6f 6e 6c 79 20 6e 65 65 64 73 20 74 6f 20 66   only needs to f
6f20: 6c 75 73 68 20 64 61 74 61 20 74 6f 20 6d 61 73  lush data to mas
6f30: 73 20 73 74 6f 72 61 67 65 2e 20 20 49 6e 6f 64  s storage.  Inod
6f40: 65 0a 2a 2a 20 69 6e 66 6f 72 6d 61 74 69 6f 6e  e.** information
6f50: 20 6e 65 65 64 20 6e 6f 74 20 62 65 20 66 6c 75   need not be flu
6f60: 73 68 65 64 2e 20 49 66 20 74 68 65 20 6c 6f 77  shed. If the low
6f70: 65 72 20 66 6f 75 72 20 62 69 74 73 20 6f 66 20  er four bits of 
6f80: 74 68 65 20 66 6c 61 67 0a 2a 2a 20 65 71 75 61  the flag.** equa
6f90: 6c 20 53 51 4c 49 54 45 5f 53 59 4e 43 5f 4e 4f  l SQLITE_SYNC_NO
6fa0: 52 4d 41 4c 2c 20 74 68 61 74 20 6d 65 61 6e 73  RMAL, that means
6fb0: 20 74 6f 20 75 73 65 20 6e 6f 72 6d 61 6c 20 66   to use normal f
6fc0: 73 79 6e 63 28 29 20 73 65 6d 61 6e 74 69 63 73  sync() semantics
6fd0: 2e 0a 2a 2a 20 49 66 20 74 68 65 20 6c 6f 77 65  ..** If the lowe
6fe0: 72 20 66 6f 75 72 20 62 69 74 73 20 65 71 75 61  r four bits equa
6ff0: 6c 20 53 51 4c 49 54 45 5f 53 59 4e 43 5f 46 55  l SQLITE_SYNC_FU
7000: 4c 4c 2c 20 74 68 61 74 20 6d 65 61 6e 73 0a 2a  LL, that means.*
7010: 2a 20 74 6f 20 75 73 65 20 4d 61 63 20 4f 53 20  * to use Mac OS 
7020: 58 20 73 74 79 6c 65 20 66 75 6c 6c 73 79 6e 63  X style fullsync
7030: 20 69 6e 73 74 65 61 64 20 6f 66 20 66 73 79 6e   instead of fsyn
7040: 63 28 29 2e 0a 2a 2a 0a 2a 2a 20 44 6f 20 6e 6f  c()..**.** Do no
7050: 74 20 63 6f 6e 66 75 73 65 20 74 68 65 20 53 51  t confuse the SQ
7060: 4c 49 54 45 5f 53 59 4e 43 5f 4e 4f 52 4d 41 4c  LITE_SYNC_NORMAL
7070: 20 61 6e 64 20 53 51 4c 49 54 45 5f 53 59 4e 43   and SQLITE_SYNC
7080: 5f 46 55 4c 4c 20 66 6c 61 67 73 0a 2a 2a 20 77  _FULL flags.** w
7090: 69 74 68 20 74 68 65 20 5b 50 52 41 47 4d 41 20  ith the [PRAGMA 
70a0: 73 79 6e 63 68 72 6f 6e 6f 75 73 5d 3d 4e 4f 52  synchronous]=NOR
70b0: 4d 41 4c 20 61 6e 64 20 5b 50 52 41 47 4d 41 20  MAL and [PRAGMA 
70c0: 73 79 6e 63 68 72 6f 6e 6f 75 73 5d 3d 46 55 4c  synchronous]=FUL
70d0: 4c 0a 2a 2a 20 73 65 74 74 69 6e 67 73 2e 20 20  L.** settings.  
70e0: 54 68 65 20 5b 73 79 6e 63 68 72 6f 6e 6f 75 73  The [synchronous
70f0: 20 70 72 61 67 6d 61 5d 20 64 65 74 65 72 6d 69   pragma] determi
7100: 6e 65 73 20 77 68 65 6e 20 63 61 6c 6c 73 20 74  nes when calls t
7110: 6f 20 74 68 65 0a 2a 2a 20 78 53 79 6e 63 20 56  o the.** xSync V
7120: 46 53 20 6d 65 74 68 6f 64 20 6f 63 63 75 72 20  FS method occur 
7130: 61 6e 64 20 61 70 70 6c 69 65 73 20 75 6e 69 66  and applies unif
7140: 6f 72 6d 6c 79 20 61 63 72 6f 73 73 20 61 6c 6c  ormly across all
7150: 20 70 6c 61 74 66 6f 72 6d 73 2e 0a 2a 2a 20 54   platforms..** T
7160: 68 65 20 53 51 4c 49 54 45 5f 53 59 4e 43 5f 4e  he SQLITE_SYNC_N
7170: 4f 52 4d 41 4c 20 61 6e 64 20 53 51 4c 49 54 45  ORMAL and SQLITE
7180: 5f 53 59 4e 43 5f 46 55 4c 4c 20 66 6c 61 67 73  _SYNC_FULL flags
7190: 20 64 65 74 65 72 6d 69 6e 65 20 68 6f 77 0a 2a   determine how.*
71a0: 2a 20 65 6e 65 72 67 65 74 69 63 20 6f 72 20 72  * energetic or r
71b0: 69 67 6f 72 6f 75 73 20 6f 72 20 66 6f 72 63 65  igorous or force
71c0: 66 75 6c 20 74 68 65 20 73 79 6e 63 20 6f 70 65  ful the sync ope
71d0: 72 61 74 69 6f 6e 73 20 61 72 65 20 61 6e 64 0a  rations are and.
71e0: 2a 2a 20 6f 6e 6c 79 20 6d 61 6b 65 20 61 20 64  ** only make a d
71f0: 69 66 66 65 72 65 6e 63 65 20 6f 6e 20 4d 61 63  ifference on Mac
7200: 20 4f 53 58 20 66 6f 72 20 74 68 65 20 64 65 66   OSX for the def
7210: 61 75 6c 74 20 53 51 4c 69 74 65 20 63 6f 64 65  ault SQLite code
7220: 2e 0a 2a 2a 20 28 54 68 69 72 64 2d 70 61 72 74  ..** (Third-part
7230: 79 20 56 46 53 20 69 6d 70 6c 65 6d 65 6e 74 61  y VFS implementa
7240: 74 69 6f 6e 73 20 6d 69 67 68 74 20 61 6c 73 6f  tions might also
7250: 20 6d 61 6b 65 20 74 68 65 20 64 69 73 74 69 6e   make the distin
7260: 63 74 69 6f 6e 0a 2a 2a 20 62 65 74 77 65 65 6e  ction.** between
7270: 20 53 51 4c 49 54 45 5f 53 59 4e 43 5f 4e 4f 52   SQLITE_SYNC_NOR
7280: 4d 41 4c 20 61 6e 64 20 53 51 4c 49 54 45 5f 53  MAL and SQLITE_S
7290: 59 4e 43 5f 46 55 4c 4c 2c 20 62 75 74 20 61 6d  YNC_FULL, but am
72a0: 6f 6e 67 20 74 68 65 0a 2a 2a 20 6f 70 65 72 61  ong the.** opera
72b0: 74 69 6e 67 20 73 79 73 74 65 6d 73 20 6e 61 74  ting systems nat
72c0: 69 76 65 6c 79 20 73 75 70 70 6f 72 74 65 64 20  ively supported 
72d0: 62 79 20 53 51 4c 69 74 65 2c 20 6f 6e 6c 79 20  by SQLite, only 
72e0: 4d 61 63 20 4f 53 58 0a 2a 2a 20 63 61 72 65 73  Mac OSX.** cares
72f0: 20 61 62 6f 75 74 20 74 68 65 20 64 69 66 66 65   about the diffe
7300: 72 65 6e 63 65 2e 29 0a 2a 2f 0a 23 64 65 66 69  rence.).*/.#defi
7310: 6e 65 20 53 51 4c 49 54 45 5f 53 59 4e 43 5f 4e  ne SQLITE_SYNC_N
7320: 4f 52 4d 41 4c 20 20 20 20 20 20 20 20 30 78 30  ORMAL        0x0
7330: 30 30 30 32 0a 23 64 65 66 69 6e 65 20 53 51 4c  0002.#define SQL
7340: 49 54 45 5f 53 59 4e 43 5f 46 55 4c 4c 20 20 20  ITE_SYNC_FULL   
7350: 20 20 20 20 20 20 20 30 78 30 30 30 30 33 0a 23         0x00003.#
7360: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 53 59  define SQLITE_SY
7370: 4e 43 5f 44 41 54 41 4f 4e 4c 59 20 20 20 20 20  NC_DATAONLY     
7380: 20 30 78 30 30 30 31 30 0a 0a 2f 2a 0a 2a 2a 20   0x00010../*.** 
7390: 43 41 50 49 33 52 45 46 3a 20 4f 53 20 49 6e 74  CAPI3REF: OS Int
73a0: 65 72 66 61 63 65 20 4f 70 65 6e 20 46 69 6c 65  erface Open File
73b0: 20 48 61 6e 64 6c 65 0a 2a 2a 0a 2a 2a 20 41 6e   Handle.**.** An
73c0: 20 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65 5d 20   [sqlite3_file] 
73d0: 6f 62 6a 65 63 74 20 72 65 70 72 65 73 65 6e 74  object represent
73e0: 73 20 61 6e 20 6f 70 65 6e 20 66 69 6c 65 20 69  s an open file i
73f0: 6e 20 74 68 65 20 0a 2a 2a 20 5b 73 71 6c 69 74  n the .** [sqlit
7400: 65 33 5f 76 66 73 20 7c 20 4f 53 20 69 6e 74 65  e3_vfs | OS inte
7410: 72 66 61 63 65 20 6c 61 79 65 72 5d 2e 20 20 49  rface layer].  I
7420: 6e 64 69 76 69 64 75 61 6c 20 4f 53 20 69 6e 74  ndividual OS int
7430: 65 72 66 61 63 65 0a 2a 2a 20 69 6d 70 6c 65 6d  erface.** implem
7440: 65 6e 74 61 74 69 6f 6e 73 20 77 69 6c 6c 0a 2a  entations will.*
7450: 2a 20 77 61 6e 74 20 74 6f 20 73 75 62 63 6c 61  * want to subcla
7460: 73 73 20 74 68 69 73 20 6f 62 6a 65 63 74 20 62  ss this object b
7470: 79 20 61 70 70 65 6e 64 69 6e 67 20 61 64 64 69  y appending addi
7480: 74 69 6f 6e 61 6c 20 66 69 65 6c 64 73 0a 2a 2a  tional fields.**
7490: 20 66 6f 72 20 74 68 65 69 72 20 6f 77 6e 20 75   for their own u
74a0: 73 65 2e 20 20 54 68 65 20 70 4d 65 74 68 6f 64  se.  The pMethod
74b0: 73 20 65 6e 74 72 79 20 69 73 20 61 20 70 6f 69  s entry is a poi
74c0: 6e 74 65 72 20 74 6f 20 61 6e 0a 2a 2a 20 5b 73  nter to an.** [s
74d0: 71 6c 69 74 65 33 5f 69 6f 5f 6d 65 74 68 6f 64  qlite3_io_method
74e0: 73 5d 20 6f 62 6a 65 63 74 20 74 68 61 74 20 64  s] object that d
74f0: 65 66 69 6e 65 73 20 6d 65 74 68 6f 64 73 20 66  efines methods f
7500: 6f 72 20 70 65 72 66 6f 72 6d 69 6e 67 0a 2a 2a  or performing.**
7510: 20 49 2f 4f 20 6f 70 65 72 61 74 69 6f 6e 73 20   I/O operations 
7520: 6f 6e 20 74 68 65 20 6f 70 65 6e 20 66 69 6c 65  on the open file
7530: 2e 0a 2a 2f 0a 74 79 70 65 64 65 66 20 73 74 72  ..*/.typedef str
7540: 75 63 74 20 73 71 6c 69 74 65 33 5f 66 69 6c 65  uct sqlite3_file
7550: 20 73 71 6c 69 74 65 33 5f 66 69 6c 65 3b 0a 73   sqlite3_file;.s
7560: 74 72 75 63 74 20 73 71 6c 69 74 65 33 5f 66 69  truct sqlite3_fi
7570: 6c 65 20 7b 0a 20 20 63 6f 6e 73 74 20 73 74 72  le {.  const str
7580: 75 63 74 20 73 71 6c 69 74 65 33 5f 69 6f 5f 6d  uct sqlite3_io_m
7590: 65 74 68 6f 64 73 20 2a 70 4d 65 74 68 6f 64 73  ethods *pMethods
75a0: 3b 20 20 2f 2a 20 4d 65 74 68 6f 64 73 20 66 6f  ;  /* Methods fo
75b0: 72 20 61 6e 20 6f 70 65 6e 20 66 69 6c 65 20 2a  r an open file *
75c0: 2f 0a 7d 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49  /.};../*.** CAPI
75d0: 33 52 45 46 3a 20 4f 53 20 49 6e 74 65 72 66 61  3REF: OS Interfa
75e0: 63 65 20 46 69 6c 65 20 56 69 72 74 75 61 6c 20  ce File Virtual 
75f0: 4d 65 74 68 6f 64 73 20 4f 62 6a 65 63 74 0a 2a  Methods Object.*
7600: 2a 0a 2a 2a 20 45 76 65 72 79 20 66 69 6c 65 20  *.** Every file 
7610: 6f 70 65 6e 65 64 20 62 79 20 74 68 65 20 5b 73  opened by the [s
7620: 71 6c 69 74 65 33 5f 76 66 73 2e 78 4f 70 65 6e  qlite3_vfs.xOpen
7630: 5d 20 6d 65 74 68 6f 64 20 70 6f 70 75 6c 61 74  ] method populat
7640: 65 73 20 61 6e 0a 2a 2a 20 5b 73 71 6c 69 74 65  es an.** [sqlite
7650: 33 5f 66 69 6c 65 5d 20 6f 62 6a 65 63 74 20 28  3_file] object (
7660: 6f 72 2c 20 6d 6f 72 65 20 63 6f 6d 6d 6f 6e 6c  or, more commonl
7670: 79 2c 20 61 20 73 75 62 63 6c 61 73 73 20 6f 66  y, a subclass of
7680: 20 74 68 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33   the.** [sqlite3
7690: 5f 66 69 6c 65 5d 20 6f 62 6a 65 63 74 29 20 77  _file] object) w
76a0: 69 74 68 20 61 20 70 6f 69 6e 74 65 72 20 74 6f  ith a pointer to
76b0: 20 61 6e 20 69 6e 73 74 61 6e 63 65 20 6f 66 20   an instance of 
76c0: 74 68 69 73 20 6f 62 6a 65 63 74 2e 0a 2a 2a 20  this object..** 
76d0: 54 68 69 73 20 6f 62 6a 65 63 74 20 64 65 66 69  This object defi
76e0: 6e 65 73 20 74 68 65 20 6d 65 74 68 6f 64 73 20  nes the methods 
76f0: 75 73 65 64 20 74 6f 20 70 65 72 66 6f 72 6d 20  used to perform 
7700: 76 61 72 69 6f 75 73 20 6f 70 65 72 61 74 69 6f  various operatio
7710: 6e 73 0a 2a 2a 20 61 67 61 69 6e 73 74 20 74 68  ns.** against th
7720: 65 20 6f 70 65 6e 20 66 69 6c 65 20 72 65 70 72  e open file repr
7730: 65 73 65 6e 74 65 64 20 62 79 20 74 68 65 20 5b  esented by the [
7740: 73 71 6c 69 74 65 33 5f 66 69 6c 65 5d 20 6f 62  sqlite3_file] ob
7750: 6a 65 63 74 2e 0a 2a 2a 0a 2a 2a 20 49 66 20 74  ject..**.** If t
7760: 68 65 20 5b 73 71 6c 69 74 65 33 5f 76 66 73 2e  he [sqlite3_vfs.
7770: 78 4f 70 65 6e 5d 20 6d 65 74 68 6f 64 20 73 65  xOpen] method se
7780: 74 73 20 74 68 65 20 73 71 6c 69 74 65 33 5f 66  ts the sqlite3_f
7790: 69 6c 65 2e 70 4d 65 74 68 6f 64 73 20 65 6c 65  ile.pMethods ele
77a0: 6d 65 6e 74 20 0a 2a 2a 20 74 6f 20 61 20 6e 6f  ment .** to a no
77b0: 6e 2d 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 2c 20  n-NULL pointer, 
77c0: 74 68 65 6e 20 74 68 65 20 73 71 6c 69 74 65 33  then the sqlite3
77d0: 5f 69 6f 5f 6d 65 74 68 6f 64 73 2e 78 43 6c 6f  _io_methods.xClo
77e0: 73 65 20 6d 65 74 68 6f 64 0a 2a 2a 20 6d 61 79  se method.** may
77f0: 20 62 65 20 69 6e 76 6f 6b 65 64 20 65 76 65 6e   be invoked even
7800: 20 69 66 20 74 68 65 20 5b 73 71 6c 69 74 65 33   if the [sqlite3
7810: 5f 76 66 73 2e 78 4f 70 65 6e 5d 20 72 65 70 6f  _vfs.xOpen] repo
7820: 72 74 65 64 20 74 68 61 74 20 69 74 20 66 61 69  rted that it fai
7830: 6c 65 64 2e 20 20 54 68 65 0a 2a 2a 20 6f 6e 6c  led.  The.** onl
7840: 79 20 77 61 79 20 74 6f 20 70 72 65 76 65 6e 74  y way to prevent
7850: 20 61 20 63 61 6c 6c 20 74 6f 20 78 43 6c 6f 73   a call to xClos
7860: 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 61 20 66 61  e following a fa
7870: 69 6c 65 64 20 5b 73 71 6c 69 74 65 33 5f 76 66  iled [sqlite3_vf
7880: 73 2e 78 4f 70 65 6e 5d 0a 2a 2a 20 69 73 20 66  s.xOpen].** is f
7890: 6f 72 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  or the [sqlite3_
78a0: 76 66 73 2e 78 4f 70 65 6e 5d 20 74 6f 20 73 65  vfs.xOpen] to se
78b0: 74 20 74 68 65 20 73 71 6c 69 74 65 33 5f 66 69  t the sqlite3_fi
78c0: 6c 65 2e 70 4d 65 74 68 6f 64 73 20 65 6c 65 6d  le.pMethods elem
78d0: 65 6e 74 0a 2a 2a 20 74 6f 20 4e 55 4c 4c 2e 0a  ent.** to NULL..
78e0: 2a 2a 0a 2a 2a 20 54 68 65 20 66 6c 61 67 73 20  **.** The flags 
78f0: 61 72 67 75 6d 65 6e 74 20 74 6f 20 78 53 79 6e  argument to xSyn
7900: 63 20 6d 61 79 20 62 65 20 6f 6e 65 20 6f 66 20  c may be one of 
7910: 5b 53 51 4c 49 54 45 5f 53 59 4e 43 5f 4e 4f 52  [SQLITE_SYNC_NOR
7920: 4d 41 4c 5d 20 6f 72 0a 2a 2a 20 5b 53 51 4c 49  MAL] or.** [SQLI
7930: 54 45 5f 53 59 4e 43 5f 46 55 4c 4c 5d 2e 20 20  TE_SYNC_FULL].  
7940: 54 68 65 20 66 69 72 73 74 20 63 68 6f 69 63 65  The first choice
7950: 20 69 73 20 74 68 65 20 6e 6f 72 6d 61 6c 20 66   is the normal f
7960: 73 79 6e 63 28 29 2e 0a 2a 2a 20 54 68 65 20 73  sync()..** The s
7970: 65 63 6f 6e 64 20 63 68 6f 69 63 65 20 69 73 20  econd choice is 
7980: 61 20 4d 61 63 20 4f 53 20 58 20 73 74 79 6c 65  a Mac OS X style
7990: 20 66 75 6c 6c 73 79 6e 63 2e 20 20 54 68 65 20   fullsync.  The 
79a0: 5b 53 51 4c 49 54 45 5f 53 59 4e 43 5f 44 41 54  [SQLITE_SYNC_DAT
79b0: 41 4f 4e 4c 59 5d 0a 2a 2a 20 66 6c 61 67 20 6d  AONLY].** flag m
79c0: 61 79 20 62 65 20 4f 52 65 64 20 69 6e 20 74 6f  ay be ORed in to
79d0: 20 69 6e 64 69 63 61 74 65 20 74 68 61 74 20 6f   indicate that o
79e0: 6e 6c 79 20 74 68 65 20 64 61 74 61 20 6f 66 20  nly the data of 
79f0: 74 68 65 20 66 69 6c 65 0a 2a 2a 20 61 6e 64 20  the file.** and 
7a00: 6e 6f 74 20 69 74 73 20 69 6e 6f 64 65 20 6e 65  not its inode ne
7a10: 65 64 73 20 74 6f 20 62 65 20 73 79 6e 63 65 64  eds to be synced
7a20: 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 69 6e 74 65  ..**.** The inte
7a30: 67 65 72 20 76 61 6c 75 65 73 20 74 6f 20 78 4c  ger values to xL
7a40: 6f 63 6b 28 29 20 61 6e 64 20 78 55 6e 6c 6f 63  ock() and xUnloc
7a50: 6b 28 29 20 61 72 65 20 6f 6e 65 20 6f 66 0a 2a  k() are one of.*
7a60: 2a 20 3c 75 6c 3e 0a 2a 2a 20 3c 6c 69 3e 20 5b  * <ul>.** <li> [
7a70: 53 51 4c 49 54 45 5f 4c 4f 43 4b 5f 4e 4f 4e 45  SQLITE_LOCK_NONE
7a80: 5d 2c 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49  ],.** <li> [SQLI
7a90: 54 45 5f 4c 4f 43 4b 5f 53 48 41 52 45 44 5d 2c  TE_LOCK_SHARED],
7aa0: 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45  .** <li> [SQLITE
7ab0: 5f 4c 4f 43 4b 5f 52 45 53 45 52 56 45 44 5d 2c  _LOCK_RESERVED],
7ac0: 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45  .** <li> [SQLITE
7ad0: 5f 4c 4f 43 4b 5f 50 45 4e 44 49 4e 47 5d 2c 20  _LOCK_PENDING], 
7ae0: 6f 72 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49  or.** <li> [SQLI
7af0: 54 45 5f 4c 4f 43 4b 5f 45 58 43 4c 55 53 49 56  TE_LOCK_EXCLUSIV
7b00: 45 5d 2e 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2a 20  E]..** </ul>.** 
7b10: 78 4c 6f 63 6b 28 29 20 69 6e 63 72 65 61 73 65  xLock() increase
7b20: 73 20 74 68 65 20 6c 6f 63 6b 2e 20 78 55 6e 6c  s the lock. xUnl
7b30: 6f 63 6b 28 29 20 64 65 63 72 65 61 73 65 73 20  ock() decreases 
7b40: 74 68 65 20 6c 6f 63 6b 2e 0a 2a 2a 20 54 68 65  the lock..** The
7b50: 20 78 43 68 65 63 6b 52 65 73 65 72 76 65 64 4c   xCheckReservedL
7b60: 6f 63 6b 28 29 20 6d 65 74 68 6f 64 20 63 68 65  ock() method che
7b70: 63 6b 73 20 77 68 65 74 68 65 72 20 61 6e 79 20  cks whether any 
7b80: 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74  database connect
7b90: 69 6f 6e 2c 0a 2a 2a 20 65 69 74 68 65 72 20 69  ion,.** either i
7ba0: 6e 20 74 68 69 73 20 70 72 6f 63 65 73 73 20 6f  n this process o
7bb0: 72 20 69 6e 20 73 6f 6d 65 20 6f 74 68 65 72 20  r in some other 
7bc0: 70 72 6f 63 65 73 73 2c 20 69 73 20 68 6f 6c 64  process, is hold
7bd0: 69 6e 67 20 61 20 52 45 53 45 52 56 45 44 2c 0a  ing a RESERVED,.
7be0: 2a 2a 20 50 45 4e 44 49 4e 47 2c 20 6f 72 20 45  ** PENDING, or E
7bf0: 58 43 4c 55 53 49 56 45 20 6c 6f 63 6b 20 6f 6e  XCLUSIVE lock on
7c00: 20 74 68 65 20 66 69 6c 65 2e 20 20 49 74 20 72   the file.  It r
7c10: 65 74 75 72 6e 73 20 74 72 75 65 0a 2a 2a 20 69  eturns true.** i
7c20: 66 20 73 75 63 68 20 61 20 6c 6f 63 6b 20 65 78  f such a lock ex
7c30: 69 73 74 73 20 61 6e 64 20 66 61 6c 73 65 20 6f  ists and false o
7c40: 74 68 65 72 77 69 73 65 2e 0a 2a 2a 0a 2a 2a 20  therwise..**.** 
7c50: 54 68 65 20 78 46 69 6c 65 43 6f 6e 74 72 6f 6c  The xFileControl
7c60: 28 29 20 6d 65 74 68 6f 64 20 69 73 20 61 20 67  () method is a g
7c70: 65 6e 65 72 69 63 20 69 6e 74 65 72 66 61 63 65  eneric interface
7c80: 20 74 68 61 74 20 61 6c 6c 6f 77 73 20 63 75 73   that allows cus
7c90: 74 6f 6d 0a 2a 2a 20 56 46 53 20 69 6d 70 6c 65  tom.** VFS imple
7ca0: 6d 65 6e 74 61 74 69 6f 6e 73 20 74 6f 20 64 69  mentations to di
7cb0: 72 65 63 74 6c 79 20 63 6f 6e 74 72 6f 6c 20 61  rectly control a
7cc0: 6e 20 6f 70 65 6e 20 66 69 6c 65 20 75 73 69 6e  n open file usin
7cd0: 67 20 74 68 65 0a 2a 2a 20 5b 73 71 6c 69 74 65  g the.** [sqlite
7ce0: 33 5f 66 69 6c 65 5f 63 6f 6e 74 72 6f 6c 28 29  3_file_control()
7cf0: 5d 20 69 6e 74 65 72 66 61 63 65 2e 20 20 54 68  ] interface.  Th
7d00: 65 20 73 65 63 6f 6e 64 20 22 6f 70 22 20 61 72  e second "op" ar
7d10: 67 75 6d 65 6e 74 20 69 73 20 61 6e 0a 2a 2a 20  gument is an.** 
7d20: 69 6e 74 65 67 65 72 20 6f 70 63 6f 64 65 2e 20  integer opcode. 
7d30: 20 54 68 65 20 74 68 69 72 64 20 61 72 67 75 6d   The third argum
7d40: 65 6e 74 20 69 73 20 61 20 67 65 6e 65 72 69 63  ent is a generic
7d50: 20 70 6f 69 6e 74 65 72 20 69 6e 74 65 6e 64 65   pointer intende
7d60: 64 20 74 6f 0a 2a 2a 20 70 6f 69 6e 74 20 74 6f  d to.** point to
7d70: 20 61 20 73 74 72 75 63 74 75 72 65 20 74 68 61   a structure tha
7d80: 74 20 6d 61 79 20 63 6f 6e 74 61 69 6e 20 61 72  t may contain ar
7d90: 67 75 6d 65 6e 74 73 20 6f 72 20 73 70 61 63 65  guments or space
7da0: 20 69 6e 20 77 68 69 63 68 20 74 6f 0a 2a 2a 20   in which to.** 
7db0: 77 72 69 74 65 20 72 65 74 75 72 6e 20 76 61 6c  write return val
7dc0: 75 65 73 2e 20 20 50 6f 74 65 6e 74 69 61 6c 20  ues.  Potential 
7dd0: 75 73 65 73 20 66 6f 72 20 78 46 69 6c 65 43 6f  uses for xFileCo
7de0: 6e 74 72 6f 6c 28 29 20 6d 69 67 68 74 20 62 65  ntrol() might be
7df0: 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 73 20 74 6f  .** functions to
7e00: 20 65 6e 61 62 6c 65 20 62 6c 6f 63 6b 69 6e 67   enable blocking
7e10: 20 6c 6f 63 6b 73 20 77 69 74 68 20 74 69 6d 65   locks with time
7e20: 6f 75 74 73 2c 20 74 6f 20 63 68 61 6e 67 65 20  outs, to change 
7e30: 74 68 65 0a 2a 2a 20 6c 6f 63 6b 69 6e 67 20 73  the.** locking s
7e40: 74 72 61 74 65 67 79 20 28 66 6f 72 20 65 78 61  trategy (for exa
7e50: 6d 70 6c 65 20 74 6f 20 75 73 65 20 64 6f 74 2d  mple to use dot-
7e60: 66 69 6c 65 20 6c 6f 63 6b 73 29 2c 20 74 6f 20  file locks), to 
7e70: 69 6e 71 75 69 72 65 0a 2a 2a 20 61 62 6f 75 74  inquire.** about
7e80: 20 74 68 65 20 73 74 61 74 75 73 20 6f 66 20 61   the status of a
7e90: 20 6c 6f 63 6b 2c 20 6f 72 20 74 6f 20 62 72 65   lock, or to bre
7ea0: 61 6b 20 73 74 61 6c 65 20 6c 6f 63 6b 73 2e 20  ak stale locks. 
7eb0: 20 54 68 65 20 53 51 4c 69 74 65 0a 2a 2a 20 63   The SQLite.** c
7ec0: 6f 72 65 20 72 65 73 65 72 76 65 73 20 61 6c 6c  ore reserves all
7ed0: 20 6f 70 63 6f 64 65 73 20 6c 65 73 73 20 74 68   opcodes less th
7ee0: 61 6e 20 31 30 30 20 66 6f 72 20 69 74 73 20 6f  an 100 for its o
7ef0: 77 6e 20 75 73 65 2e 0a 2a 2a 20 41 20 5b 66 69  wn use..** A [fi
7f00: 6c 65 20 63 6f 6e 74 72 6f 6c 20 6f 70 63 6f 64  le control opcod
7f10: 65 73 20 7c 20 6c 69 73 74 20 6f 66 20 6f 70 63  es | list of opc
7f20: 6f 64 65 73 5d 20 6c 65 73 73 20 74 68 61 6e 20  odes] less than 
7f30: 31 30 30 20 69 73 20 61 76 61 69 6c 61 62 6c 65  100 is available
7f40: 2e 0a 2a 2a 20 41 70 70 6c 69 63 61 74 69 6f 6e  ..** Application
7f50: 73 20 74 68 61 74 20 64 65 66 69 6e 65 20 61 20  s that define a 
7f60: 63 75 73 74 6f 6d 20 78 46 69 6c 65 43 6f 6e 74  custom xFileCont
7f70: 72 6f 6c 20 6d 65 74 68 6f 64 20 73 68 6f 75 6c  rol method shoul
7f80: 64 20 75 73 65 20 6f 70 63 6f 64 65 73 0a 2a 2a  d use opcodes.**
7f90: 20 67 72 65 61 74 65 72 20 74 68 61 6e 20 31 30   greater than 10
7fa0: 30 20 74 6f 20 61 76 6f 69 64 20 63 6f 6e 66 6c  0 to avoid confl
7fb0: 69 63 74 73 2e 20 20 56 46 53 20 69 6d 70 6c 65  icts.  VFS imple
7fc0: 6d 65 6e 74 61 74 69 6f 6e 73 20 73 68 6f 75 6c  mentations shoul
7fd0: 64 0a 2a 2a 20 72 65 74 75 72 6e 20 5b 53 51 4c  d.** return [SQL
7fe0: 49 54 45 5f 4e 4f 54 46 4f 55 4e 44 5d 20 66 6f  ITE_NOTFOUND] fo
7ff0: 72 20 66 69 6c 65 20 63 6f 6e 74 72 6f 6c 20 6f  r file control o
8000: 70 63 6f 64 65 73 20 74 68 61 74 20 74 68 65 79  pcodes that they
8010: 20 64 6f 20 6e 6f 74 0a 2a 2a 20 72 65 63 6f 67   do not.** recog
8020: 6e 69 7a 65 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20  nize..**.** The 
8030: 78 53 65 63 74 6f 72 53 69 7a 65 28 29 20 6d 65  xSectorSize() me
8040: 74 68 6f 64 20 72 65 74 75 72 6e 73 20 74 68 65  thod returns the
8050: 20 73 65 63 74 6f 72 20 73 69 7a 65 20 6f 66 20   sector size of 
8060: 74 68 65 0a 2a 2a 20 64 65 76 69 63 65 20 74 68  the.** device th
8070: 61 74 20 75 6e 64 65 72 6c 69 65 73 20 74 68 65  at underlies the
8080: 20 66 69 6c 65 2e 20 20 54 68 65 20 73 65 63 74   file.  The sect
8090: 6f 72 20 73 69 7a 65 20 69 73 20 74 68 65 0a 2a  or size is the.*
80a0: 2a 20 6d 69 6e 69 6d 75 6d 20 77 72 69 74 65 20  * minimum write 
80b0: 74 68 61 74 20 63 61 6e 20 62 65 20 70 65 72 66  that can be perf
80c0: 6f 72 6d 65 64 20 77 69 74 68 6f 75 74 20 64 69  ormed without di
80d0: 73 74 75 72 62 69 6e 67 0a 2a 2a 20 6f 74 68 65  sturbing.** othe
80e0: 72 20 62 79 74 65 73 20 69 6e 20 74 68 65 20 66  r bytes in the f
80f0: 69 6c 65 2e 20 20 54 68 65 20 78 44 65 76 69 63  ile.  The xDevic
8100: 65 43 68 61 72 61 63 74 65 72 69 73 74 69 63 73  eCharacteristics
8110: 28 29 0a 2a 2a 20 6d 65 74 68 6f 64 20 72 65 74  ().** method ret
8120: 75 72 6e 73 20 61 20 62 69 74 20 76 65 63 74 6f  urns a bit vecto
8130: 72 20 64 65 73 63 72 69 62 69 6e 67 20 62 65 68  r describing beh
8140: 61 76 69 6f 72 73 20 6f 66 20 74 68 65 0a 2a 2a  aviors of the.**
8150: 20 75 6e 64 65 72 6c 79 69 6e 67 20 64 65 76 69   underlying devi
8160: 63 65 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a  ce:.**.** <ul>.*
8170: 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49  * <li> [SQLITE_I
8180: 4f 43 41 50 5f 41 54 4f 4d 49 43 5d 0a 2a 2a 20  OCAP_ATOMIC].** 
8190: 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49 4f 43  <li> [SQLITE_IOC
81a0: 41 50 5f 41 54 4f 4d 49 43 35 31 32 5d 0a 2a 2a  AP_ATOMIC512].**
81b0: 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49 4f   <li> [SQLITE_IO
81c0: 43 41 50 5f 41 54 4f 4d 49 43 31 4b 5d 0a 2a 2a  CAP_ATOMIC1K].**
81d0: 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49 4f   <li> [SQLITE_IO
81e0: 43 41 50 5f 41 54 4f 4d 49 43 32 4b 5d 0a 2a 2a  CAP_ATOMIC2K].**
81f0: 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49 4f   <li> [SQLITE_IO
8200: 43 41 50 5f 41 54 4f 4d 49 43 34 4b 5d 0a 2a 2a  CAP_ATOMIC4K].**
8210: 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49 4f   <li> [SQLITE_IO
8220: 43 41 50 5f 41 54 4f 4d 49 43 38 4b 5d 0a 2a 2a  CAP_ATOMIC8K].**
8230: 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49 4f   <li> [SQLITE_IO
8240: 43 41 50 5f 41 54 4f 4d 49 43 31 36 4b 5d 0a 2a  CAP_ATOMIC16K].*
8250: 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49  * <li> [SQLITE_I
8260: 4f 43 41 50 5f 41 54 4f 4d 49 43 33 32 4b 5d 0a  OCAP_ATOMIC32K].
8270: 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f  ** <li> [SQLITE_
8280: 49 4f 43 41 50 5f 41 54 4f 4d 49 43 36 34 4b 5d  IOCAP_ATOMIC64K]
8290: 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45  .** <li> [SQLITE
82a0: 5f 49 4f 43 41 50 5f 53 41 46 45 5f 41 50 50 45  _IOCAP_SAFE_APPE
82b0: 4e 44 5d 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c  ND].** <li> [SQL
82c0: 49 54 45 5f 49 4f 43 41 50 5f 53 45 51 55 45 4e  ITE_IOCAP_SEQUEN
82d0: 54 49 41 4c 5d 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a  TIAL].** </ul>.*
82e0: 2a 0a 2a 2a 20 54 68 65 20 53 51 4c 49 54 45 5f  *.** The SQLITE_
82f0: 49 4f 43 41 50 5f 41 54 4f 4d 49 43 20 70 72 6f  IOCAP_ATOMIC pro
8300: 70 65 72 74 79 20 6d 65 61 6e 73 20 74 68 61 74  perty means that
8310: 20 61 6c 6c 20 77 72 69 74 65 73 20 6f 66 0a 2a   all writes of.*
8320: 2a 20 61 6e 79 20 73 69 7a 65 20 61 72 65 20 61  * any size are a
8330: 74 6f 6d 69 63 2e 20 20 54 68 65 20 53 51 4c 49  tomic.  The SQLI
8340: 54 45 5f 49 4f 43 41 50 5f 41 54 4f 4d 49 43 6e  TE_IOCAP_ATOMICn
8350: 6e 6e 20 76 61 6c 75 65 73 0a 2a 2a 20 6d 65 61  nn values.** mea
8360: 6e 20 74 68 61 74 20 77 72 69 74 65 73 20 6f 66  n that writes of
8370: 20 62 6c 6f 63 6b 73 20 74 68 61 74 20 61 72 65   blocks that are
8380: 20 6e 6e 6e 20 62 79 74 65 73 20 69 6e 20 73 69   nnn bytes in si
8390: 7a 65 20 61 6e 64 0a 2a 2a 20 61 72 65 20 61 6c  ze and.** are al
83a0: 69 67 6e 65 64 20 74 6f 20 61 6e 20 61 64 64 72  igned to an addr
83b0: 65 73 73 20 77 68 69 63 68 20 69 73 20 61 6e 20  ess which is an 
83c0: 69 6e 74 65 67 65 72 20 6d 75 6c 74 69 70 6c 65  integer multiple
83d0: 20 6f 66 0a 2a 2a 20 6e 6e 6e 20 61 72 65 20 61   of.** nnn are a
83e0: 74 6f 6d 69 63 2e 20 20 54 68 65 20 53 51 4c 49  tomic.  The SQLI
83f0: 54 45 5f 49 4f 43 41 50 5f 53 41 46 45 5f 41 50  TE_IOCAP_SAFE_AP
8400: 50 45 4e 44 20 76 61 6c 75 65 20 6d 65 61 6e 73  PEND value means
8410: 0a 2a 2a 20 74 68 61 74 20 77 68 65 6e 20 64 61  .** that when da
8420: 74 61 20 69 73 20 61 70 70 65 6e 64 65 64 20 74  ta is appended t
8430: 6f 20 61 20 66 69 6c 65 2c 20 74 68 65 20 64 61  o a file, the da
8440: 74 61 20 69 73 20 61 70 70 65 6e 64 65 64 0a 2a  ta is appended.*
8450: 2a 20 66 69 72 73 74 20 74 68 65 6e 20 74 68 65  * first then the
8460: 20 73 69 7a 65 20 6f 66 20 74 68 65 20 66 69 6c   size of the fil
8470: 65 20 69 73 20 65 78 74 65 6e 64 65 64 2c 20 6e  e is extended, n
8480: 65 76 65 72 20 74 68 65 20 6f 74 68 65 72 0a 2a  ever the other.*
8490: 2a 20 77 61 79 20 61 72 6f 75 6e 64 2e 20 20 54  * way around.  T
84a0: 68 65 20 53 51 4c 49 54 45 5f 49 4f 43 41 50 5f  he SQLITE_IOCAP_
84b0: 53 45 51 55 45 4e 54 49 41 4c 20 70 72 6f 70 65  SEQUENTIAL prope
84c0: 72 74 79 20 6d 65 61 6e 73 20 74 68 61 74 0a 2a  rty means that.*
84d0: 2a 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 69 73  * information is
84e0: 20 77 72 69 74 74 65 6e 20 74 6f 20 64 69 73 6b   written to disk
84f0: 20 69 6e 20 74 68 65 20 73 61 6d 65 20 6f 72 64   in the same ord
8500: 65 72 20 61 73 20 63 61 6c 6c 73 0a 2a 2a 20 74  er as calls.** t
8510: 6f 20 78 57 72 69 74 65 28 29 2e 0a 2a 2a 0a 2a  o xWrite()..**.*
8520: 2a 20 49 66 20 78 52 65 61 64 28 29 20 72 65 74  * If xRead() ret
8530: 75 72 6e 73 20 53 51 4c 49 54 45 5f 49 4f 45 52  urns SQLITE_IOER
8540: 52 5f 53 48 4f 52 54 5f 52 45 41 44 20 69 74 20  R_SHORT_READ it 
8550: 6d 75 73 74 20 61 6c 73 6f 20 66 69 6c 6c 0a 2a  must also fill.*
8560: 2a 20 69 6e 20 74 68 65 20 75 6e 72 65 61 64 20  * in the unread 
8570: 70 6f 72 74 69 6f 6e 73 20 6f 66 20 74 68 65 20  portions of the 
8580: 62 75 66 66 65 72 20 77 69 74 68 20 7a 65 72 6f  buffer with zero
8590: 73 2e 20 20 41 20 56 46 53 20 74 68 61 74 0a 2a  s.  A VFS that.*
85a0: 2a 20 66 61 69 6c 73 20 74 6f 20 7a 65 72 6f 2d  * fails to zero-
85b0: 66 69 6c 6c 20 73 68 6f 72 74 20 72 65 61 64 73  fill short reads
85c0: 20 6d 69 67 68 74 20 73 65 65 6d 20 74 6f 20 77   might seem to w
85d0: 6f 72 6b 2e 20 20 48 6f 77 65 76 65 72 2c 0a 2a  ork.  However,.*
85e0: 2a 20 66 61 69 6c 75 72 65 20 74 6f 20 7a 65 72  * failure to zer
85f0: 6f 2d 66 69 6c 6c 20 73 68 6f 72 74 20 72 65 61  o-fill short rea
8600: 64 73 20 77 69 6c 6c 20 65 76 65 6e 74 75 61 6c  ds will eventual
8610: 6c 79 20 6c 65 61 64 20 74 6f 0a 2a 2a 20 64 61  ly lead to.** da
8620: 74 61 62 61 73 65 20 63 6f 72 72 75 70 74 69 6f  tabase corruptio
8630: 6e 2e 0a 2a 2f 0a 74 79 70 65 64 65 66 20 73 74  n..*/.typedef st
8640: 72 75 63 74 20 73 71 6c 69 74 65 33 5f 69 6f 5f  ruct sqlite3_io_
8650: 6d 65 74 68 6f 64 73 20 73 71 6c 69 74 65 33 5f  methods sqlite3_
8660: 69 6f 5f 6d 65 74 68 6f 64 73 3b 0a 73 74 72 75  io_methods;.stru
8670: 63 74 20 73 71 6c 69 74 65 33 5f 69 6f 5f 6d 65  ct sqlite3_io_me
8680: 74 68 6f 64 73 20 7b 0a 20 20 69 6e 74 20 69 56  thods {.  int iV
8690: 65 72 73 69 6f 6e 3b 0a 20 20 69 6e 74 20 28 2a  ersion;.  int (*
86a0: 78 43 6c 6f 73 65 29 28 73 71 6c 69 74 65 33 5f  xClose)(sqlite3_
86b0: 66 69 6c 65 2a 29 3b 0a 20 20 69 6e 74 20 28 2a  file*);.  int (*
86c0: 78 52 65 61 64 29 28 73 71 6c 69 74 65 33 5f 66  xRead)(sqlite3_f
86d0: 69 6c 65 2a 2c 20 76 6f 69 64 2a 2c 20 69 6e 74  ile*, void*, int
86e0: 20 69 41 6d 74 2c 20 73 71 6c 69 74 65 33 5f 69   iAmt, sqlite3_i
86f0: 6e 74 36 34 20 69 4f 66 73 74 29 3b 0a 20 20 69  nt64 iOfst);.  i
8700: 6e 74 20 28 2a 78 57 72 69 74 65 29 28 73 71 6c  nt (*xWrite)(sql
8710: 69 74 65 33 5f 66 69 6c 65 2a 2c 20 63 6f 6e 73  ite3_file*, cons
8720: 74 20 76 6f 69 64 2a 2c 20 69 6e 74 20 69 41 6d  t void*, int iAm
8730: 74 2c 20 73 71 6c 69 74 65 33 5f 69 6e 74 36 34  t, sqlite3_int64
8740: 20 69 4f 66 73 74 29 3b 0a 20 20 69 6e 74 20 28   iOfst);.  int (
8750: 2a 78 54 72 75 6e 63 61 74 65 29 28 73 71 6c 69  *xTruncate)(sqli
8760: 74 65 33 5f 66 69 6c 65 2a 2c 20 73 71 6c 69 74  te3_file*, sqlit
8770: 65 33 5f 69 6e 74 36 34 20 73 69 7a 65 29 3b 0a  e3_int64 size);.
8780: 20 20 69 6e 74 20 28 2a 78 53 79 6e 63 29 28 73    int (*xSync)(s
8790: 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 20 69 6e  qlite3_file*, in
87a0: 74 20 66 6c 61 67 73 29 3b 0a 20 20 69 6e 74 20  t flags);.  int 
87b0: 28 2a 78 46 69 6c 65 53 69 7a 65 29 28 73 71 6c  (*xFileSize)(sql
87c0: 69 74 65 33 5f 66 69 6c 65 2a 2c 20 73 71 6c 69  ite3_file*, sqli
87d0: 74 65 33 5f 69 6e 74 36 34 20 2a 70 53 69 7a 65  te3_int64 *pSize
87e0: 29 3b 0a 20 20 69 6e 74 20 28 2a 78 4c 6f 63 6b  );.  int (*xLock
87f0: 29 28 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c  )(sqlite3_file*,
8800: 20 69 6e 74 29 3b 0a 20 20 69 6e 74 20 28 2a 78   int);.  int (*x
8810: 55 6e 6c 6f 63 6b 29 28 73 71 6c 69 74 65 33 5f  Unlock)(sqlite3_
8820: 66 69 6c 65 2a 2c 20 69 6e 74 29 3b 0a 20 20 69  file*, int);.  i
8830: 6e 74 20 28 2a 78 43 68 65 63 6b 52 65 73 65 72  nt (*xCheckReser
8840: 76 65 64 4c 6f 63 6b 29 28 73 71 6c 69 74 65 33  vedLock)(sqlite3
8850: 5f 66 69 6c 65 2a 2c 20 69 6e 74 20 2a 70 52 65  _file*, int *pRe
8860: 73 4f 75 74 29 3b 0a 20 20 69 6e 74 20 28 2a 78  sOut);.  int (*x
8870: 46 69 6c 65 43 6f 6e 74 72 6f 6c 29 28 73 71 6c  FileControl)(sql
8880: 69 74 65 33 5f 66 69 6c 65 2a 2c 20 69 6e 74 20  ite3_file*, int 
8890: 6f 70 2c 20 76 6f 69 64 20 2a 70 41 72 67 29 3b  op, void *pArg);
88a0: 0a 20 20 69 6e 74 20 28 2a 78 53 65 63 74 6f 72  .  int (*xSector
88b0: 53 69 7a 65 29 28 73 71 6c 69 74 65 33 5f 66 69  Size)(sqlite3_fi
88c0: 6c 65 2a 29 3b 0a 20 20 69 6e 74 20 28 2a 78 44  le*);.  int (*xD
88d0: 65 76 69 63 65 43 68 61 72 61 63 74 65 72 69 73  eviceCharacteris
88e0: 74 69 63 73 29 28 73 71 6c 69 74 65 33 5f 66 69  tics)(sqlite3_fi
88f0: 6c 65 2a 29 3b 0a 20 20 2f 2a 20 4d 65 74 68 6f  le*);.  /* Metho
8900: 64 73 20 61 62 6f 76 65 20 61 72 65 20 76 61 6c  ds above are val
8910: 69 64 20 66 6f 72 20 76 65 72 73 69 6f 6e 20 31  id for version 1
8920: 20 2a 2f 0a 20 20 69 6e 74 20 28 2a 78 53 68 6d   */.  int (*xShm
8930: 4d 61 70 29 28 73 71 6c 69 74 65 33 5f 66 69 6c  Map)(sqlite3_fil
8940: 65 2a 2c 20 69 6e 74 20 69 50 67 2c 20 69 6e 74  e*, int iPg, int
8950: 20 70 67 73 7a 2c 20 69 6e 74 2c 20 76 6f 69 64   pgsz, int, void
8960: 20 76 6f 6c 61 74 69 6c 65 2a 2a 29 3b 0a 20 20   volatile**);.  
8970: 69 6e 74 20 28 2a 78 53 68 6d 4c 6f 63 6b 29 28  int (*xShmLock)(
8980: 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 20 69  sqlite3_file*, i
8990: 6e 74 20 6f 66 66 73 65 74 2c 20 69 6e 74 20 6e  nt offset, int n
89a0: 2c 20 69 6e 74 20 66 6c 61 67 73 29 3b 0a 20 20  , int flags);.  
89b0: 76 6f 69 64 20 28 2a 78 53 68 6d 42 61 72 72 69  void (*xShmBarri
89c0: 65 72 29 28 73 71 6c 69 74 65 33 5f 66 69 6c 65  er)(sqlite3_file
89d0: 2a 29 3b 0a 20 20 69 6e 74 20 28 2a 78 53 68 6d  *);.  int (*xShm
89e0: 55 6e 6d 61 70 29 28 73 71 6c 69 74 65 33 5f 66  Unmap)(sqlite3_f
89f0: 69 6c 65 2a 2c 20 69 6e 74 20 64 65 6c 65 74 65  ile*, int delete
8a00: 46 6c 61 67 29 3b 0a 20 20 2f 2a 20 4d 65 74 68  Flag);.  /* Meth
8a10: 6f 64 73 20 61 62 6f 76 65 20 61 72 65 20 76 61  ods above are va
8a20: 6c 69 64 20 66 6f 72 20 76 65 72 73 69 6f 6e 20  lid for version 
8a30: 32 20 2a 2f 0a 20 20 69 6e 74 20 28 2a 78 46 65  2 */.  int (*xFe
8a40: 74 63 68 29 28 73 71 6c 69 74 65 33 5f 66 69 6c  tch)(sqlite3_fil
8a50: 65 2a 2c 20 73 71 6c 69 74 65 33 5f 69 6e 74 36  e*, sqlite3_int6
8a60: 34 20 69 4f 66 73 74 2c 20 69 6e 74 20 69 41 6d  4 iOfst, int iAm
8a70: 74 2c 20 76 6f 69 64 20 2a 2a 70 70 29 3b 0a 20  t, void **pp);. 
8a80: 20 69 6e 74 20 28 2a 78 55 6e 66 65 74 63 68 29   int (*xUnfetch)
8a90: 28 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 20  (sqlite3_file*, 
8aa0: 73 71 6c 69 74 65 33 5f 69 6e 74 36 34 20 69 4f  sqlite3_int64 iO
8ab0: 66 73 74 2c 20 76 6f 69 64 20 2a 70 29 3b 0a 20  fst, void *p);. 
8ac0: 20 2f 2a 20 4d 65 74 68 6f 64 73 20 61 62 6f 76   /* Methods abov
8ad0: 65 20 61 72 65 20 76 61 6c 69 64 20 66 6f 72 20  e are valid for 
8ae0: 76 65 72 73 69 6f 6e 20 33 20 2a 2f 0a 20 20 2f  version 3 */.  /
8af0: 2a 20 41 64 64 69 74 69 6f 6e 61 6c 20 6d 65 74  * Additional met
8b00: 68 6f 64 73 20 6d 61 79 20 62 65 20 61 64 64 65  hods may be adde
8b10: 64 20 69 6e 20 66 75 74 75 72 65 20 72 65 6c 65  d in future rele
8b20: 61 73 65 73 20 2a 2f 0a 7d 3b 0a 0a 2f 2a 0a 2a  ases */.};../*.*
8b30: 2a 20 43 41 50 49 33 52 45 46 3a 20 53 74 61 6e  * CAPI3REF: Stan
8b40: 64 61 72 64 20 46 69 6c 65 20 43 6f 6e 74 72 6f  dard File Contro
8b50: 6c 20 4f 70 63 6f 64 65 73 0a 2a 2a 20 4b 45 59  l Opcodes.** KEY
8b60: 57 4f 52 44 53 3a 20 7b 66 69 6c 65 20 63 6f 6e  WORDS: {file con
8b70: 74 72 6f 6c 20 6f 70 63 6f 64 65 73 7d 20 7b 66  trol opcodes} {f
8b80: 69 6c 65 20 63 6f 6e 74 72 6f 6c 20 6f 70 63 6f  ile control opco
8b90: 64 65 7d 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20  de}.**.** These 
8ba0: 69 6e 74 65 67 65 72 20 63 6f 6e 73 74 61 6e 74  integer constant
8bb0: 73 20 61 72 65 20 6f 70 63 6f 64 65 73 20 66 6f  s are opcodes fo
8bc0: 72 20 74 68 65 20 78 46 69 6c 65 43 6f 6e 74 72  r the xFileContr
8bd0: 6f 6c 20 6d 65 74 68 6f 64 0a 2a 2a 20 6f 66 20  ol method.** of 
8be0: 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 69 6f 5f  the [sqlite3_io_
8bf0: 6d 65 74 68 6f 64 73 5d 20 6f 62 6a 65 63 74 20  methods] object 
8c00: 61 6e 64 20 66 6f 72 20 74 68 65 20 5b 73 71 6c  and for the [sql
8c10: 69 74 65 33 5f 66 69 6c 65 5f 63 6f 6e 74 72 6f  ite3_file_contro
8c20: 6c 28 29 5d 0a 2a 2a 20 69 6e 74 65 72 66 61 63  l()].** interfac
8c30: 65 2e 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a  e..**.** <ul>.**
8c40: 20 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43   <li>[[SQLITE_FC
8c50: 4e 54 4c 5f 4c 4f 43 4b 53 54 41 54 45 5d 5d 0a  NTL_LOCKSTATE]].
8c60: 2a 2a 20 54 68 65 20 5b 53 51 4c 49 54 45 5f 46  ** The [SQLITE_F
8c70: 43 4e 54 4c 5f 4c 4f 43 4b 53 54 41 54 45 5d 20  CNTL_LOCKSTATE] 
8c80: 6f 70 63 6f 64 65 20 69 73 20 75 73 65 64 20 66  opcode is used f
8c90: 6f 72 20 64 65 62 75 67 67 69 6e 67 2e 20 20 54  or debugging.  T
8ca0: 68 69 73 0a 2a 2a 20 6f 70 63 6f 64 65 20 63 61  his.** opcode ca
8cb0: 75 73 65 73 20 74 68 65 20 78 46 69 6c 65 43 6f  uses the xFileCo
8cc0: 6e 74 72 6f 6c 20 6d 65 74 68 6f 64 20 74 6f 20  ntrol method to 
8cd0: 77 72 69 74 65 20 74 68 65 20 63 75 72 72 65 6e  write the curren
8ce0: 74 20 73 74 61 74 65 20 6f 66 0a 2a 2a 20 74 68  t state of.** th
8cf0: 65 20 6c 6f 63 6b 20 28 6f 6e 65 20 6f 66 20 5b  e lock (one of [
8d00: 53 51 4c 49 54 45 5f 4c 4f 43 4b 5f 4e 4f 4e 45  SQLITE_LOCK_NONE
8d10: 5d 2c 20 5b 53 51 4c 49 54 45 5f 4c 4f 43 4b 5f  ], [SQLITE_LOCK_
8d20: 53 48 41 52 45 44 5d 2c 0a 2a 2a 20 5b 53 51 4c  SHARED],.** [SQL
8d30: 49 54 45 5f 4c 4f 43 4b 5f 52 45 53 45 52 56 45  ITE_LOCK_RESERVE
8d40: 44 5d 2c 20 5b 53 51 4c 49 54 45 5f 4c 4f 43 4b  D], [SQLITE_LOCK
8d50: 5f 50 45 4e 44 49 4e 47 5d 2c 20 6f 72 20 5b 53  _PENDING], or [S
8d60: 51 4c 49 54 45 5f 4c 4f 43 4b 5f 45 58 43 4c 55  QLITE_LOCK_EXCLU
8d70: 53 49 56 45 5d 29 0a 2a 2a 20 69 6e 74 6f 20 61  SIVE]).** into a
8d80: 6e 20 69 6e 74 65 67 65 72 20 74 68 61 74 20 74  n integer that t
8d90: 68 65 20 70 41 72 67 20 61 72 67 75 6d 65 6e 74  he pArg argument
8da0: 20 70 6f 69 6e 74 73 20 74 6f 2e 20 54 68 69 73   points to. This
8db0: 20 63 61 70 61 62 69 6c 69 74 79 0a 2a 2a 20 69   capability.** i
8dc0: 73 20 75 73 65 64 20 64 75 72 69 6e 67 20 74 65  s used during te
8dd0: 73 74 69 6e 67 20 61 6e 64 20 69 73 20 6f 6e 6c  sting and is onl
8de0: 79 20 61 76 61 69 6c 61 62 6c 65 20 77 68 65 6e  y available when
8df0: 20 74 68 65 20 53 51 4c 49 54 45 5f 54 45 53 54   the SQLITE_TEST
8e00: 0a 2a 2a 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65  .** compile-time
8e10: 20 6f 70 74 69 6f 6e 20 69 73 20 75 73 65 64 2e   option is used.
8e20: 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e 5b 5b 53 51 4c  .**.** <li>[[SQL
8e30: 49 54 45 5f 46 43 4e 54 4c 5f 53 49 5a 45 5f 48  ITE_FCNTL_SIZE_H
8e40: 49 4e 54 5d 5d 0a 2a 2a 20 54 68 65 20 5b 53 51  INT]].** The [SQ
8e50: 4c 49 54 45 5f 46 43 4e 54 4c 5f 53 49 5a 45 5f  LITE_FCNTL_SIZE_
8e60: 48 49 4e 54 5d 20 6f 70 63 6f 64 65 20 69 73 20  HINT] opcode is 
8e70: 75 73 65 64 20 62 79 20 53 51 4c 69 74 65 20 74  used by SQLite t
8e80: 6f 20 67 69 76 65 20 74 68 65 20 56 46 53 0a 2a  o give the VFS.*
8e90: 2a 20 6c 61 79 65 72 20 61 20 68 69 6e 74 20 6f  * layer a hint o
8ea0: 66 20 68 6f 77 20 6c 61 72 67 65 20 74 68 65 20  f how large the 
8eb0: 64 61 74 61 62 61 73 65 20 66 69 6c 65 20 77 69  database file wi
8ec0: 6c 6c 20 67 72 6f 77 20 74 6f 20 62 65 20 64 75  ll grow to be du
8ed0: 72 69 6e 67 20 74 68 65 0a 2a 2a 20 63 75 72 72  ring the.** curr
8ee0: 65 6e 74 20 74 72 61 6e 73 61 63 74 69 6f 6e 2e  ent transaction.
8ef0: 20 20 54 68 69 73 20 68 69 6e 74 20 69 73 20 6e    This hint is n
8f00: 6f 74 20 67 75 61 72 61 6e 74 65 65 64 20 74 6f  ot guaranteed to
8f10: 20 62 65 20 61 63 63 75 72 61 74 65 20 62 75 74   be accurate but
8f20: 20 69 74 0a 2a 2a 20 69 73 20 6f 66 74 65 6e 20   it.** is often 
8f30: 63 6c 6f 73 65 2e 20 20 54 68 65 20 75 6e 64 65  close.  The unde
8f40: 72 6c 79 69 6e 67 20 56 46 53 20 6d 69 67 68 74  rlying VFS might
8f50: 20 63 68 6f 6f 73 65 20 74 6f 20 70 72 65 61 6c   choose to preal
8f60: 6c 6f 63 61 74 65 20 64 61 74 61 62 61 73 65 0a  locate database.
8f70: 2a 2a 20 66 69 6c 65 20 73 70 61 63 65 20 62 61  ** file space ba
8f80: 73 65 64 20 6f 6e 20 74 68 69 73 20 68 69 6e 74  sed on this hint
8f90: 20 69 6e 20 6f 72 64 65 72 20 74 6f 20 68 65 6c   in order to hel
8fa0: 70 20 77 72 69 74 65 73 20 74 6f 20 74 68 65 20  p writes to the 
8fb0: 64 61 74 61 62 61 73 65 0a 2a 2a 20 66 69 6c 65  database.** file
8fc0: 20 72 75 6e 20 66 61 73 74 65 72 2e 0a 2a 2a 0a   run faster..**.
8fd0: 2a 2a 20 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f  ** <li>[[SQLITE_
8fe0: 46 43 4e 54 4c 5f 43 48 55 4e 4b 5f 53 49 5a 45  FCNTL_CHUNK_SIZE
8ff0: 5d 5d 0a 2a 2a 20 54 68 65 20 5b 53 51 4c 49 54  ]].** The [SQLIT
9000: 45 5f 46 43 4e 54 4c 5f 43 48 55 4e 4b 5f 53 49  E_FCNTL_CHUNK_SI
9010: 5a 45 5d 20 6f 70 63 6f 64 65 20 69 73 20 75 73  ZE] opcode is us
9020: 65 64 20 74 6f 20 72 65 71 75 65 73 74 20 74 68  ed to request th
9030: 61 74 20 74 68 65 20 56 46 53 0a 2a 2a 20 65 78  at the VFS.** ex
9040: 74 65 6e 64 73 20 61 6e 64 20 74 72 75 6e 63 61  tends and trunca
9050: 74 65 73 20 74 68 65 20 64 61 74 61 62 61 73 65  tes the database
9060: 20 66 69 6c 65 20 69 6e 20 63 68 75 6e 6b 73 20   file in chunks 
9070: 6f 66 20 61 20 73 69 7a 65 20 73 70 65 63 69 66  of a size specif
9080: 69 65 64 0a 2a 2a 20 62 79 20 74 68 65 20 75 73  ied.** by the us
9090: 65 72 2e 20 54 68 65 20 66 6f 75 72 74 68 20 61  er. The fourth a
90a0: 72 67 75 6d 65 6e 74 20 74 6f 20 5b 73 71 6c 69  rgument to [sqli
90b0: 74 65 33 5f 66 69 6c 65 5f 63 6f 6e 74 72 6f 6c  te3_file_control
90c0: 28 29 5d 20 73 68 6f 75 6c 64 20 0a 2a 2a 20 70  ()] should .** p
90d0: 6f 69 6e 74 20 74 6f 20 61 6e 20 69 6e 74 65 67  oint to an integ
90e0: 65 72 20 28 74 79 70 65 20 69 6e 74 29 20 63 6f  er (type int) co
90f0: 6e 74 61 69 6e 69 6e 67 20 74 68 65 20 6e 65 77  ntaining the new
9100: 20 63 68 75 6e 6b 2d 73 69 7a 65 20 74 6f 20 75   chunk-size to u
9110: 73 65 0a 2a 2a 20 66 6f 72 20 74 68 65 20 6e 6f  se.** for the no
9120: 6d 69 6e 61 74 65 64 20 64 61 74 61 62 61 73 65  minated database
9130: 2e 20 41 6c 6c 6f 63 61 74 69 6e 67 20 64 61 74  . Allocating dat
9140: 61 62 61 73 65 20 66 69 6c 65 20 73 70 61 63 65  abase file space
9150: 20 69 6e 20 6c 61 72 67 65 0a 2a 2a 20 63 68 75   in large.** chu
9160: 6e 6b 73 20 28 73 61 79 20 31 4d 42 20 61 74 20  nks (say 1MB at 
9170: 61 20 74 69 6d 65 29 2c 20 6d 61 79 20 72 65 64  a time), may red
9180: 75 63 65 20 66 69 6c 65 2d 73 79 73 74 65 6d 20  uce file-system 
9190: 66 72 61 67 6d 65 6e 74 61 74 69 6f 6e 20 61 6e  fragmentation an
91a0: 64 0a 2a 2a 20 69 6d 70 72 6f 76 65 20 70 65 72  d.** improve per
91b0: 66 6f 72 6d 61 6e 63 65 20 6f 6e 20 73 6f 6d 65  formance on some
91c0: 20 73 79 73 74 65 6d 73 2e 0a 2a 2a 0a 2a 2a 20   systems..**.** 
91d0: 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e  <li>[[SQLITE_FCN
91e0: 54 4c 5f 46 49 4c 45 5f 50 4f 49 4e 54 45 52 5d  TL_FILE_POINTER]
91f0: 5d 0a 2a 2a 20 54 68 65 20 5b 53 51 4c 49 54 45  ].** The [SQLITE
9200: 5f 46 43 4e 54 4c 5f 46 49 4c 45 5f 50 4f 49 4e  _FCNTL_FILE_POIN
9210: 54 45 52 5d 20 6f 70 63 6f 64 65 20 69 73 20 75  TER] opcode is u
9220: 73 65 64 20 74 6f 20 6f 62 74 61 69 6e 20 61 20  sed to obtain a 
9230: 70 6f 69 6e 74 65 72 0a 2a 2a 20 74 6f 20 74 68  pointer.** to th
9240: 65 20 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65 5d  e [sqlite3_file]
9250: 20 6f 62 6a 65 63 74 20 61 73 73 6f 63 69 61 74   object associat
9260: 65 64 20 77 69 74 68 20 61 20 70 61 72 74 69 63  ed with a partic
9270: 75 6c 61 72 20 64 61 74 61 62 61 73 65 0a 2a 2a  ular database.**
9280: 20 63 6f 6e 6e 65 63 74 69 6f 6e 2e 20 20 53 65   connection.  Se
9290: 65 20 61 6c 73 6f 20 5b 53 51 4c 49 54 45 5f 46  e also [SQLITE_F
92a0: 43 4e 54 4c 5f 4a 4f 55 52 4e 41 4c 5f 50 4f 49  CNTL_JOURNAL_POI
92b0: 4e 54 45 52 5d 2e 0a 2a 2a 0a 2a 2a 20 3c 6c 69  NTER]..**.** <li
92c0: 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f  >[[SQLITE_FCNTL_
92d0: 4a 4f 55 52 4e 41 4c 5f 50 4f 49 4e 54 45 52 5d  JOURNAL_POINTER]
92e0: 5d 0a 2a 2a 20 54 68 65 20 5b 53 51 4c 49 54 45  ].** The [SQLITE
92f0: 5f 46 43 4e 54 4c 5f 4a 4f 55 52 4e 41 4c 5f 50  _FCNTL_JOURNAL_P
9300: 4f 49 4e 54 45 52 5d 20 6f 70 63 6f 64 65 20 69  OINTER] opcode i
9310: 73 20 75 73 65 64 20 74 6f 20 6f 62 74 61 69 6e  s used to obtain
9320: 20 61 20 70 6f 69 6e 74 65 72 0a 2a 2a 20 74 6f   a pointer.** to
9330: 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 66 69   the [sqlite3_fi
9340: 6c 65 5d 20 6f 62 6a 65 63 74 20 61 73 73 6f 63  le] object assoc
9350: 69 61 74 65 64 20 77 69 74 68 20 74 68 65 20 6a  iated with the j
9360: 6f 75 72 6e 61 6c 20 66 69 6c 65 20 28 65 69 74  ournal file (eit
9370: 68 65 72 0a 2a 2a 20 74 68 65 20 5b 72 6f 6c 6c  her.** the [roll
9380: 62 61 63 6b 20 6a 6f 75 72 6e 61 6c 5d 20 6f 72  back journal] or
9390: 20 74 68 65 20 5b 77 72 69 74 65 2d 61 68 65 61   the [write-ahea
93a0: 64 20 6c 6f 67 5d 29 20 66 6f 72 20 61 20 70 61  d log]) for a pa
93b0: 72 74 69 63 75 6c 61 72 20 64 61 74 61 62 61 73  rticular databas
93c0: 65 0a 2a 2a 20 63 6f 6e 6e 65 63 74 69 6f 6e 2e  e.** connection.
93d0: 20 20 53 65 65 20 61 6c 73 6f 20 5b 53 51 4c 49    See also [SQLI
93e0: 54 45 5f 46 43 4e 54 4c 5f 46 49 4c 45 5f 50 4f  TE_FCNTL_FILE_PO
93f0: 49 4e 54 45 52 5d 2e 0a 2a 2a 0a 2a 2a 20 3c 6c  INTER]..**.** <l
9400: 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c  i>[[SQLITE_FCNTL
9410: 5f 53 59 4e 43 5f 4f 4d 49 54 54 45 44 5d 5d 0a  _SYNC_OMITTED]].
9420: 2a 2a 20 4e 6f 20 6c 6f 6e 67 65 72 20 69 6e 20  ** No longer in 
9430: 75 73 65 2e 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e 5b  use..**.** <li>[
9440: 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 53 59  [SQLITE_FCNTL_SY
9450: 4e 43 5d 5d 0a 2a 2a 20 54 68 65 20 5b 53 51 4c  NC]].** The [SQL
9460: 49 54 45 5f 46 43 4e 54 4c 5f 53 59 4e 43 5d 20  ITE_FCNTL_SYNC] 
9470: 6f 70 63 6f 64 65 20 69 73 20 67 65 6e 65 72 61  opcode is genera
9480: 74 65 64 20 69 6e 74 65 72 6e 61 6c 6c 79 20 62  ted internally b
9490: 79 20 53 51 4c 69 74 65 20 61 6e 64 0a 2a 2a 20  y SQLite and.** 
94a0: 73 65 6e 74 20 74 6f 20 74 68 65 20 56 46 53 20  sent to the VFS 
94b0: 69 6d 6d 65 64 69 61 74 65 6c 79 20 62 65 66 6f  immediately befo
94c0: 72 65 20 74 68 65 20 78 53 79 6e 63 20 6d 65 74  re the xSync met
94d0: 68 6f 64 20 69 73 20 69 6e 76 6f 6b 65 64 20 6f  hod is invoked o
94e0: 6e 20 61 0a 2a 2a 20 64 61 74 61 62 61 73 65 20  n a.** database 
94f0: 66 69 6c 65 20 64 65 73 63 72 69 70 74 6f 72 2e  file descriptor.
9500: 20 4f 72 2c 20 69 66 20 74 68 65 20 78 53 79 6e   Or, if the xSyn
9510: 63 20 6d 65 74 68 6f 64 20 69 73 20 6e 6f 74 20  c method is not 
9520: 69 6e 76 6f 6b 65 64 20 0a 2a 2a 20 62 65 63 61  invoked .** beca
9530: 75 73 65 20 74 68 65 20 75 73 65 72 20 68 61 73  use the user has
9540: 20 63 6f 6e 66 69 67 75 72 65 64 20 53 51 4c 69   configured SQLi
9550: 74 65 20 77 69 74 68 20 0a 2a 2a 20 5b 50 52 41  te with .** [PRA
9560: 47 4d 41 20 73 79 6e 63 68 72 6f 6e 6f 75 73 20  GMA synchronous 
9570: 7c 20 50 52 41 47 4d 41 20 73 79 6e 63 68 72 6f  | PRAGMA synchro
9580: 6e 6f 75 73 3d 4f 46 46 5d 20 69 74 20 69 73 20  nous=OFF] it is 
9590: 69 6e 76 6f 6b 65 64 20 69 6e 20 70 6c 61 63 65  invoked in place
95a0: 20 0a 2a 2a 20 6f 66 20 74 68 65 20 78 53 79 6e   .** of the xSyn
95b0: 63 20 6d 65 74 68 6f 64 2e 20 49 6e 20 6d 6f 73  c method. In mos
95c0: 74 20 63 61 73 65 73 2c 20 74 68 65 20 70 6f 69  t cases, the poi
95d0: 6e 74 65 72 20 61 72 67 75 6d 65 6e 74 20 70 61  nter argument pa
95e0: 73 73 65 64 20 77 69 74 68 0a 2a 2a 20 74 68 69  ssed with.** thi
95f0: 73 20 66 69 6c 65 2d 63 6f 6e 74 72 6f 6c 20 69  s file-control i
9600: 73 20 4e 55 4c 4c 2e 20 48 6f 77 65 76 65 72 2c  s NULL. However,
9610: 20 69 66 20 74 68 65 20 64 61 74 61 62 61 73 65   if the database
9620: 20 66 69 6c 65 20 69 73 20 62 65 69 6e 67 20 73   file is being s
9630: 79 6e 63 65 64 0a 2a 2a 20 61 73 20 70 61 72 74  ynced.** as part
9640: 20 6f 66 20 61 20 6d 75 6c 74 69 2d 64 61 74 61   of a multi-data
9650: 62 61 73 65 20 63 6f 6d 6d 69 74 2c 20 74 68 65  base commit, the
9660: 20 61 72 67 75 6d 65 6e 74 20 70 6f 69 6e 74 73   argument points
9670: 20 74 6f 20 61 20 6e 75 6c 2d 74 65 72 6d 69 6e   to a nul-termin
9680: 61 74 65 64 0a 2a 2a 20 73 74 72 69 6e 67 20 63  ated.** string c
9690: 6f 6e 74 61 69 6e 69 6e 67 20 74 68 65 20 74 72  ontaining the tr
96a0: 61 6e 73 61 63 74 69 6f 6e 73 20 6d 61 73 74 65  ansactions maste
96b0: 72 2d 6a 6f 75 72 6e 61 6c 20 66 69 6c 65 20 6e  r-journal file n
96c0: 61 6d 65 2e 20 56 46 53 65 73 20 74 68 61 74 20  ame. VFSes that 
96d0: 0a 2a 2a 20 64 6f 20 6e 6f 74 20 6e 65 65 64 20  .** do not need 
96e0: 74 68 69 73 20 73 69 67 6e 61 6c 20 73 68 6f 75  this signal shou
96f0: 6c 64 20 73 69 6c 65 6e 74 6c 79 20 69 67 6e 6f  ld silently igno
9700: 72 65 20 74 68 69 73 20 6f 70 63 6f 64 65 2e 20  re this opcode. 
9710: 41 70 70 6c 69 63 61 74 69 6f 6e 73 20 0a 2a 2a  Applications .**
9720: 20 73 68 6f 75 6c 64 20 6e 6f 74 20 63 61 6c 6c   should not call
9730: 20 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65 5f 63   [sqlite3_file_c
9740: 6f 6e 74 72 6f 6c 28 29 5d 20 77 69 74 68 20 74  ontrol()] with t
9750: 68 69 73 20 6f 70 63 6f 64 65 20 61 73 20 64 6f  his opcode as do
9760: 69 6e 67 20 73 6f 20 6d 61 79 20 0a 2a 2a 20 64  ing so may .** d
9770: 69 73 72 75 70 74 20 74 68 65 20 6f 70 65 72 61  isrupt the opera
9780: 74 69 6f 6e 20 6f 66 20 74 68 65 20 73 70 65 63  tion of the spec
9790: 69 61 6c 69 7a 65 64 20 56 46 53 65 73 20 74 68  ialized VFSes th
97a0: 61 74 20 64 6f 20 72 65 71 75 69 72 65 20 69 74  at do require it
97b0: 2e 20 20 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e 5b 5b  .  .**.** <li>[[
97c0: 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 43 4f 4d  SQLITE_FCNTL_COM
97d0: 4d 49 54 5f 50 48 41 53 45 54 57 4f 5d 5d 0a 2a  MIT_PHASETWO]].*
97e0: 2a 20 54 68 65 20 5b 53 51 4c 49 54 45 5f 46 43  * The [SQLITE_FC
97f0: 4e 54 4c 5f 43 4f 4d 4d 49 54 5f 50 48 41 53 45  NTL_COMMIT_PHASE
9800: 54 57 4f 5d 20 6f 70 63 6f 64 65 20 69 73 20 67  TWO] opcode is g
9810: 65 6e 65 72 61 74 65 64 20 69 6e 74 65 72 6e 61  enerated interna
9820: 6c 6c 79 20 62 79 20 53 51 4c 69 74 65 0a 2a 2a  lly by SQLite.**
9830: 20 61 6e 64 20 73 65 6e 74 20 74 6f 20 74 68 65   and sent to the
9840: 20 56 46 53 20 61 66 74 65 72 20 61 20 74 72 61   VFS after a tra
9850: 6e 73 61 63 74 69 6f 6e 20 68 61 73 20 62 65 65  nsaction has bee
9860: 6e 20 63 6f 6d 6d 69 74 74 65 64 20 69 6d 6d 65  n committed imme
9870: 64 69 61 74 65 6c 79 0a 2a 2a 20 62 75 74 20 62  diately.** but b
9880: 65 66 6f 72 65 20 74 68 65 20 64 61 74 61 62 61  efore the databa
9890: 73 65 20 69 73 20 75 6e 6c 6f 63 6b 65 64 2e 20  se is unlocked. 
98a0: 56 46 53 65 73 20 74 68 61 74 20 64 6f 20 6e 6f  VFSes that do no
98b0: 74 20 6e 65 65 64 20 74 68 69 73 20 73 69 67 6e  t need this sign
98c0: 61 6c 0a 2a 2a 20 73 68 6f 75 6c 64 20 73 69 6c  al.** should sil
98d0: 65 6e 74 6c 79 20 69 67 6e 6f 72 65 20 74 68 69  ently ignore thi
98e0: 73 20 6f 70 63 6f 64 65 2e 20 41 70 70 6c 69 63  s opcode. Applic
98f0: 61 74 69 6f 6e 73 20 73 68 6f 75 6c 64 20 6e 6f  ations should no
9900: 74 20 63 61 6c 6c 0a 2a 2a 20 5b 73 71 6c 69 74  t call.** [sqlit
9910: 65 33 5f 66 69 6c 65 5f 63 6f 6e 74 72 6f 6c 28  e3_file_control(
9920: 29 5d 20 77 69 74 68 20 74 68 69 73 20 6f 70 63  )] with this opc
9930: 6f 64 65 20 61 73 20 64 6f 69 6e 67 20 73 6f 20  ode as doing so 
9940: 6d 61 79 20 64 69 73 72 75 70 74 20 74 68 65 20  may disrupt the 
9950: 0a 2a 2a 20 6f 70 65 72 61 74 69 6f 6e 20 6f 66  .** operation of
9960: 20 74 68 65 20 73 70 65 63 69 61 6c 69 7a 65 64   the specialized
9970: 20 56 46 53 65 73 20 74 68 61 74 20 64 6f 20 72   VFSes that do r
9980: 65 71 75 69 72 65 20 69 74 2e 20 20 0a 2a 2a 0a  equire it.  .**.
9990: 2a 2a 20 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f  ** <li>[[SQLITE_
99a0: 46 43 4e 54 4c 5f 57 49 4e 33 32 5f 41 56 5f 52  FCNTL_WIN32_AV_R
99b0: 45 54 52 59 5d 5d 0a 2a 2a 20 5e 54 68 65 20 5b  ETRY]].** ^The [
99c0: 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 57 49 4e  SQLITE_FCNTL_WIN
99d0: 33 32 5f 41 56 5f 52 45 54 52 59 5d 20 6f 70 63  32_AV_RETRY] opc
99e0: 6f 64 65 20 69 73 20 75 73 65 64 20 74 6f 20 63  ode is used to c
99f0: 6f 6e 66 69 67 75 72 65 20 61 75 74 6f 6d 61 74  onfigure automat
9a00: 69 63 0a 2a 2a 20 72 65 74 72 79 20 63 6f 75 6e  ic.** retry coun
9a10: 74 73 20 61 6e 64 20 69 6e 74 65 72 76 61 6c 73  ts and intervals
9a20: 20 66 6f 72 20 63 65 72 74 61 69 6e 20 64 69 73   for certain dis
9a30: 6b 20 49 2f 4f 20 6f 70 65 72 61 74 69 6f 6e 73  k I/O operations
9a40: 20 66 6f 72 20 74 68 65 0a 2a 2a 20 77 69 6e 64   for the.** wind
9a50: 6f 77 73 20 5b 56 46 53 5d 20 69 6e 20 6f 72 64  ows [VFS] in ord
9a60: 65 72 20 74 6f 20 70 72 6f 76 69 64 65 20 72 6f  er to provide ro
9a70: 62 75 73 74 6e 65 73 73 20 69 6e 20 74 68 65 20  bustness in the 
9a80: 70 72 65 73 65 6e 63 65 20 6f 66 0a 2a 2a 20 61  presence of.** a
9a90: 6e 74 69 2d 76 69 72 75 73 20 70 72 6f 67 72 61  nti-virus progra
9aa0: 6d 73 2e 20 20 42 79 20 64 65 66 61 75 6c 74 2c  ms.  By default,
9ab0: 20 74 68 65 20 77 69 6e 64 6f 77 73 20 56 46 53   the windows VFS
9ac0: 20 77 69 6c 6c 20 72 65 74 72 79 20 66 69 6c 65   will retry file
9ad0: 20 72 65 61 64 2c 0a 2a 2a 20 66 69 6c 65 20 77   read,.** file w
9ae0: 72 69 74 65 2c 20 61 6e 64 20 66 69 6c 65 20 64  rite, and file d
9af0: 65 6c 65 74 65 20 6f 70 65 72 61 74 69 6f 6e 73  elete operations
9b00: 20 75 70 20 74 6f 20 31 30 20 74 69 6d 65 73 2c   up to 10 times,
9b10: 20 77 69 74 68 20 61 20 64 65 6c 61 79 0a 2a 2a   with a delay.**
9b20: 20 6f 66 20 32 35 20 6d 69 6c 6c 69 73 65 63 6f   of 25 milliseco
9b30: 6e 64 73 20 62 65 66 6f 72 65 20 74 68 65 20 66  nds before the f
9b40: 69 72 73 74 20 72 65 74 72 79 20 61 6e 64 20 77  irst retry and w
9b50: 69 74 68 20 74 68 65 20 64 65 6c 61 79 20 69 6e  ith the delay in
9b60: 63 72 65 61 73 69 6e 67 0a 2a 2a 20 62 79 20 61  creasing.** by a
9b70: 6e 20 61 64 64 69 74 69 6f 6e 61 6c 20 32 35 20  n additional 25 
9b80: 6d 69 6c 6c 69 73 65 63 6f 6e 64 73 20 77 69 74  milliseconds wit
9b90: 68 20 65 61 63 68 20 73 75 62 73 65 71 75 65 6e  h each subsequen
9ba0: 74 20 72 65 74 72 79 2e 20 20 54 68 69 73 0a 2a  t retry.  This.*
9bb0: 2a 20 6f 70 63 6f 64 65 20 61 6c 6c 6f 77 73 20  * opcode allows 
9bc0: 74 68 65 73 65 20 74 77 6f 20 76 61 6c 75 65 73  these two values
9bd0: 20 28 31 30 20 72 65 74 72 69 65 73 20 61 6e 64   (10 retries and
9be0: 20 32 35 20 6d 69 6c 6c 69 73 65 63 6f 6e 64 73   25 milliseconds
9bf0: 20 6f 66 20 64 65 6c 61 79 29 0a 2a 2a 20 74 6f   of delay).** to
9c00: 20 62 65 20 61 64 6a 75 73 74 65 64 2e 20 20 54   be adjusted.  T
9c10: 68 65 20 76 61 6c 75 65 73 20 61 72 65 20 63 68  he values are ch
9c20: 61 6e 67 65 64 20 66 6f 72 20 61 6c 6c 20 64 61  anged for all da
9c30: 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
9c40: 6e 73 0a 2a 2a 20 77 69 74 68 69 6e 20 74 68 65  ns.** within the
9c50: 20 73 61 6d 65 20 70 72 6f 63 65 73 73 2e 20 20   same process.  
9c60: 54 68 65 20 61 72 67 75 6d 65 6e 74 20 69 73 20  The argument is 
9c70: 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 6e 20  a pointer to an 
9c80: 61 72 72 61 79 20 6f 66 20 74 77 6f 0a 2a 2a 20  array of two.** 
9c90: 69 6e 74 65 67 65 72 73 20 77 68 65 72 65 20 74  integers where t
9ca0: 68 65 20 66 69 72 73 74 20 69 6e 74 65 67 65 72  he first integer
9cb0: 20 69 20 74 68 65 20 6e 65 77 20 72 65 74 72 79   i the new retry
9cc0: 20 63 6f 75 6e 74 20 61 6e 64 20 74 68 65 20 73   count and the s
9cd0: 65 63 6f 6e 64 0a 2a 2a 20 69 6e 74 65 67 65 72  econd.** integer
9ce0: 20 69 73 20 74 68 65 20 64 65 6c 61 79 2e 20 20   is the delay.  
9cf0: 49 66 20 65 69 74 68 65 72 20 69 6e 74 65 67 65  If either intege
9d00: 72 20 69 73 20 6e 65 67 61 74 69 76 65 2c 20 74  r is negative, t
9d10: 68 65 6e 20 74 68 65 20 73 65 74 74 69 6e 67 0a  hen the setting.
9d20: 2a 2a 20 69 73 20 6e 6f 74 20 63 68 61 6e 67 65  ** is not change
9d30: 64 20 62 75 74 20 69 6e 73 74 65 61 64 20 74 68  d but instead th
9d40: 65 20 70 72 69 6f 72 20 76 61 6c 75 65 20 6f 66  e prior value of
9d50: 20 74 68 61 74 20 73 65 74 74 69 6e 67 20 69 73   that setting is
9d60: 20 77 72 69 74 74 65 6e 0a 2a 2a 20 69 6e 74 6f   written.** into
9d70: 20 74 68 65 20 61 72 72 61 79 20 65 6e 74 72 79   the array entry
9d80: 2c 20 61 6c 6c 6f 77 69 6e 67 20 74 68 65 20 63  , allowing the c
9d90: 75 72 72 65 6e 74 20 72 65 74 72 79 20 73 65 74  urrent retry set
9da0: 74 69 6e 67 73 20 74 6f 20 62 65 0a 2a 2a 20 69  tings to be.** i
9db0: 6e 74 65 72 72 6f 67 61 74 65 64 2e 20 20 54 68  nterrogated.  Th
9dc0: 65 20 7a 44 62 4e 61 6d 65 20 70 61 72 61 6d 65  e zDbName parame
9dd0: 74 65 72 20 69 73 20 69 67 6e 6f 72 65 64 2e 0a  ter is ignored..
9de0: 2a 2a 0a 2a 2a 20 3c 6c 69 3e 5b 5b 53 51 4c 49  **.** <li>[[SQLI
9df0: 54 45 5f 46 43 4e 54 4c 5f 50 45 52 53 49 53 54  TE_FCNTL_PERSIST
9e00: 5f 57 41 4c 5d 5d 0a 2a 2a 20 5e 54 68 65 20 5b  _WAL]].** ^The [
9e10: 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 50 45 52  SQLITE_FCNTL_PER
9e20: 53 49 53 54 5f 57 41 4c 5d 20 6f 70 63 6f 64 65  SIST_WAL] opcode
9e30: 20 69 73 20 75 73 65 64 20 74 6f 20 73 65 74 20   is used to set 
9e40: 6f 72 20 71 75 65 72 79 20 74 68 65 0a 2a 2a 20  or query the.** 
9e50: 70 65 72 73 69 73 74 65 6e 74 20 5b 57 41 4c 20  persistent [WAL 
9e60: 7c 20 57 72 69 74 65 20 41 68 65 61 64 20 4c 6f  | Write Ahead Lo
9e70: 67 5d 20 73 65 74 74 69 6e 67 2e 20 20 42 79 20  g] setting.  By 
9e80: 64 65 66 61 75 6c 74 2c 20 74 68 65 20 61 75 78  default, the aux
9e90: 69 6c 69 61 72 79 0a 2a 2a 20 77 72 69 74 65 20  iliary.** write 
9ea0: 61 68 65 61 64 20 6c 6f 67 20 61 6e 64 20 73 68  ahead log and sh
9eb0: 61 72 65 64 20 6d 65 6d 6f 72 79 20 66 69 6c 65  ared memory file
9ec0: 73 20 75 73 65 64 20 66 6f 72 20 74 72 61 6e 73  s used for trans
9ed0: 61 63 74 69 6f 6e 20 63 6f 6e 74 72 6f 6c 0a 2a  action control.*
9ee0: 2a 20 61 72 65 20 61 75 74 6f 6d 61 74 69 63 61  * are automatica
9ef0: 6c 6c 79 20 64 65 6c 65 74 65 64 20 77 68 65 6e  lly deleted when
9f00: 20 74 68 65 20 6c 61 74 65 73 74 20 63 6f 6e 6e   the latest conn
9f10: 65 63 74 69 6f 6e 20 74 6f 20 74 68 65 20 64 61  ection to the da
9f20: 74 61 62 61 73 65 0a 2a 2a 20 63 6c 6f 73 65 73  tabase.** closes
9f30: 2e 20 20 53 65 74 74 69 6e 67 20 70 65 72 73 69  .  Setting persi
9f40: 73 74 65 6e 74 20 57 41 4c 20 6d 6f 64 65 20 63  stent WAL mode c
9f50: 61 75 73 65 73 20 74 68 6f 73 65 20 66 69 6c 65  auses those file
9f60: 73 20 74 6f 20 70 65 72 73 69 73 74 20 61 66 74  s to persist aft
9f70: 65 72 0a 2a 2a 20 63 6c 6f 73 65 2e 20 20 50 65  er.** close.  Pe
9f80: 72 73 69 73 74 69 6e 67 20 74 68 65 20 66 69 6c  rsisting the fil
9f90: 65 73 20 69 73 20 75 73 65 66 75 6c 20 77 68 65  es is useful whe
9fa0: 6e 20 6f 74 68 65 72 20 70 72 6f 63 65 73 73 65  n other processe
9fb0: 73 20 74 68 61 74 20 64 6f 20 6e 6f 74 0a 2a 2a  s that do not.**
9fc0: 20 68 61 76 65 20 77 72 69 74 65 20 70 65 72 6d   have write perm
9fd0: 69 73 73 69 6f 6e 20 6f 6e 20 74 68 65 20 64 69  ission on the di
9fe0: 72 65 63 74 6f 72 79 20 63 6f 6e 74 61 69 6e 69  rectory containi
9ff0: 6e 67 20 74 68 65 20 64 61 74 61 62 61 73 65 20  ng the database 
a000: 66 69 6c 65 20 77 61 6e 74 0a 2a 2a 20 74 6f 20  file want.** to 
a010: 72 65 61 64 20 74 68 65 20 64 61 74 61 62 61 73  read the databas
a020: 65 20 66 69 6c 65 2c 20 61 73 20 74 68 65 20 57  e file, as the W
a030: 41 4c 20 61 6e 64 20 73 68 61 72 65 64 20 6d 65  AL and shared me
a040: 6d 6f 72 79 20 66 69 6c 65 73 20 6d 75 73 74 20  mory files must 
a050: 65 78 69 73 74 0a 2a 2a 20 69 6e 20 6f 72 64 65  exist.** in orde
a060: 72 20 66 6f 72 20 74 68 65 20 64 61 74 61 62 61  r for the databa
a070: 73 65 20 74 6f 20 62 65 20 72 65 61 64 61 62 6c  se to be readabl
a080: 65 2e 20 20 54 68 65 20 66 6f 75 72 74 68 20 70  e.  The fourth p
a090: 61 72 61 6d 65 74 65 72 20 74 6f 0a 2a 2a 20 5b  arameter to.** [
a0a0: 73 71 6c 69 74 65 33 5f 66 69 6c 65 5f 63 6f 6e  sqlite3_file_con
a0b0: 74 72 6f 6c 28 29 5d 20 66 6f 72 20 74 68 69 73  trol()] for this
a0c0: 20 6f 70 63 6f 64 65 20 73 68 6f 75 6c 64 20 62   opcode should b
a0d0: 65 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61  e a pointer to a
a0e0: 6e 20 69 6e 74 65 67 65 72 2e 0a 2a 2a 20 54 68  n integer..** Th
a0f0: 61 74 20 69 6e 74 65 67 65 72 20 69 73 20 30 20  at integer is 0 
a100: 74 6f 20 64 69 73 61 62 6c 65 20 70 65 72 73 69  to disable persi
a110: 73 74 65 6e 74 20 57 41 4c 20 6d 6f 64 65 20 6f  stent WAL mode o
a120: 72 20 31 20 74 6f 20 65 6e 61 62 6c 65 20 70 65  r 1 to enable pe
a130: 72 73 69 73 74 65 6e 74 0a 2a 2a 20 57 41 4c 20  rsistent.** WAL 
a140: 6d 6f 64 65 2e 20 20 49 66 20 74 68 65 20 69 6e  mode.  If the in
a150: 74 65 67 65 72 20 69 73 20 2d 31 2c 20 74 68 65  teger is -1, the
a160: 6e 20 69 74 20 69 73 20 6f 76 65 72 77 72 69 74  n it is overwrit
a170: 74 65 6e 20 77 69 74 68 20 74 68 65 20 63 75 72  ten with the cur
a180: 72 65 6e 74 0a 2a 2a 20 57 41 4c 20 70 65 72 73  rent.** WAL pers
a190: 69 73 74 65 6e 63 65 20 73 65 74 74 69 6e 67 2e  istence setting.
a1a0: 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e 5b 5b 53 51 4c  .**.** <li>[[SQL
a1b0: 49 54 45 5f 46 43 4e 54 4c 5f 50 4f 57 45 52 53  ITE_FCNTL_POWERS
a1c0: 41 46 45 5f 4f 56 45 52 57 52 49 54 45 5d 5d 0a  AFE_OVERWRITE]].
a1d0: 2a 2a 20 5e 54 68 65 20 5b 53 51 4c 49 54 45 5f  ** ^The [SQLITE_
a1e0: 46 43 4e 54 4c 5f 50 4f 57 45 52 53 41 46 45 5f  FCNTL_POWERSAFE_
a1f0: 4f 56 45 52 57 52 49 54 45 5d 20 6f 70 63 6f 64  OVERWRITE] opcod
a200: 65 20 69 73 20 75 73 65 64 20 74 6f 20 73 65 74  e is used to set
a210: 20 6f 72 20 71 75 65 72 79 20 74 68 65 0a 2a 2a   or query the.**
a220: 20 70 65 72 73 69 73 74 65 6e 74 20 22 70 6f 77   persistent "pow
a230: 65 72 73 61 66 65 2d 6f 76 65 72 77 72 69 74 65  ersafe-overwrite
a240: 22 20 6f 72 20 22 50 53 4f 57 22 20 73 65 74 74  " or "PSOW" sett
a250: 69 6e 67 2e 20 20 54 68 65 20 50 53 4f 57 20 73  ing.  The PSOW s
a260: 65 74 74 69 6e 67 0a 2a 2a 20 64 65 74 65 72 6d  etting.** determ
a270: 69 6e 65 73 20 74 68 65 20 5b 53 51 4c 49 54 45  ines the [SQLITE
a280: 5f 49 4f 43 41 50 5f 50 4f 57 45 52 53 41 46 45  _IOCAP_POWERSAFE
a290: 5f 4f 56 45 52 57 52 49 54 45 5d 20 62 69 74 20  _OVERWRITE] bit 
a2a0: 6f 66 20 74 68 65 0a 2a 2a 20 78 44 65 76 69 63  of the.** xDevic
a2b0: 65 43 68 61 72 61 63 74 65 72 69 73 74 69 63 73  eCharacteristics
a2c0: 20 6d 65 74 68 6f 64 73 2e 20 54 68 65 20 66 6f   methods. The fo
a2d0: 75 72 74 68 20 70 61 72 61 6d 65 74 65 72 20 74  urth parameter t
a2e0: 6f 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 66 69  o.** [sqlite3_fi
a2f0: 6c 65 5f 63 6f 6e 74 72 6f 6c 28 29 5d 20 66 6f  le_control()] fo
a300: 72 20 74 68 69 73 20 6f 70 63 6f 64 65 20 73 68  r this opcode sh
a310: 6f 75 6c 64 20 62 65 20 61 20 70 6f 69 6e 74 65  ould be a pointe
a320: 72 20 74 6f 20 61 6e 20 69 6e 74 65 67 65 72 2e  r to an integer.
a330: 0a 2a 2a 20 54 68 61 74 20 69 6e 74 65 67 65 72  .** That integer
a340: 20 69 73 20 30 20 74 6f 20 64 69 73 61 62 6c 65   is 0 to disable
a350: 20 7a 65 72 6f 2d 64 61 6d 61 67 65 20 6d 6f 64   zero-damage mod
a360: 65 20 6f 72 20 31 20 74 6f 20 65 6e 61 62 6c 65  e or 1 to enable
a370: 20 7a 65 72 6f 2d 64 61 6d 61 67 65 0a 2a 2a 20   zero-damage.** 
a380: 6d 6f 64 65 2e 20 20 49 66 20 74 68 65 20 69 6e  mode.  If the in
a390: 74 65 67 65 72 20 69 73 20 2d 31 2c 20 74 68 65  teger is -1, the
a3a0: 6e 20 69 74 20 69 73 20 6f 76 65 72 77 72 69 74  n it is overwrit
a3b0: 74 65 6e 20 77 69 74 68 20 74 68 65 20 63 75 72  ten with the cur
a3c0: 72 65 6e 74 0a 2a 2a 20 7a 65 72 6f 2d 64 61 6d  rent.** zero-dam
a3d0: 61 67 65 20 6d 6f 64 65 20 73 65 74 74 69 6e 67  age mode setting
a3e0: 2e 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e 5b 5b 53 51  ..**.** <li>[[SQ
a3f0: 4c 49 54 45 5f 46 43 4e 54 4c 5f 4f 56 45 52 57  LITE_FCNTL_OVERW
a400: 52 49 54 45 5d 5d 0a 2a 2a 20 5e 54 68 65 20 5b  RITE]].** ^The [
a410: 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 4f 56 45  SQLITE_FCNTL_OVE
a420: 52 57 52 49 54 45 5d 20 6f 70 63 6f 64 65 20 69  RWRITE] opcode i
a430: 73 20 69 6e 76 6f 6b 65 64 20 62 79 20 53 51 4c  s invoked by SQL
a440: 69 74 65 20 61 66 74 65 72 20 6f 70 65 6e 69 6e  ite after openin
a450: 67 0a 2a 2a 20 61 20 77 72 69 74 65 20 74 72 61  g.** a write tra
a460: 6e 73 61 63 74 69 6f 6e 20 74 6f 20 69 6e 64 69  nsaction to indi
a470: 63 61 74 65 20 74 68 61 74 2c 20 75 6e 6c 65 73  cate that, unles
a480: 73 20 69 74 20 69 73 20 72 6f 6c 6c 65 64 20 62  s it is rolled b
a490: 61 63 6b 20 66 6f 72 20 73 6f 6d 65 0a 2a 2a 20  ack for some.** 
a4a0: 72 65 61 73 6f 6e 2c 20 74 68 65 20 65 6e 74 69  reason, the enti
a4b0: 72 65 20 64 61 74 61 62 61 73 65 20 66 69 6c 65  re database file
a4c0: 20 77 69 6c 6c 20 62 65 20 6f 76 65 72 77 72 69   will be overwri
a4d0: 74 74 65 6e 20 62 79 20 74 68 65 20 63 75 72 72  tten by the curr
a4e0: 65 6e 74 20 0a 2a 2a 20 74 72 61 6e 73 61 63 74  ent .** transact
a4f0: 69 6f 6e 2e 20 54 68 69 73 20 69 73 20 75 73 65  ion. This is use
a500: 64 20 62 79 20 56 41 43 55 55 4d 20 6f 70 65 72  d by VACUUM oper
a510: 61 74 69 6f 6e 73 2e 0a 2a 2a 0a 2a 2a 20 3c 6c  ations..**.** <l
a520: 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c  i>[[SQLITE_FCNTL
a530: 5f 56 46 53 4e 41 4d 45 5d 5d 0a 2a 2a 20 5e 54  _VFSNAME]].** ^T
a540: 68 65 20 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c  he [SQLITE_FCNTL
a550: 5f 56 46 53 4e 41 4d 45 5d 20 6f 70 63 6f 64 65  _VFSNAME] opcode
a560: 20 63 61 6e 20 62 65 20 75 73 65 64 20 74 6f 20   can be used to 
a570: 6f 62 74 61 69 6e 20 74 68 65 20 6e 61 6d 65 73  obtain the names
a580: 20 6f 66 0a 2a 2a 20 61 6c 6c 20 5b 56 46 53 65   of.** all [VFSe
a590: 73 5d 20 69 6e 20 74 68 65 20 56 46 53 20 73 74  s] in the VFS st
a5a0: 61 63 6b 2e 20 20 54 68 65 20 6e 61 6d 65 73 20  ack.  The names 
a5b0: 61 72 65 20 6f 66 20 61 6c 6c 20 56 46 53 20 73  are of all VFS s
a5c0: 68 69 6d 73 20 61 6e 64 20 74 68 65 0a 2a 2a 20  hims and the.** 
a5d0: 66 69 6e 61 6c 20 62 6f 74 74 6f 6d 2d 6c 65 76  final bottom-lev
a5e0: 65 6c 20 56 46 53 20 61 72 65 20 77 72 69 74 74  el VFS are writt
a5f0: 65 6e 20 69 6e 74 6f 20 6d 65 6d 6f 72 79 20 6f  en into memory o
a600: 62 74 61 69 6e 65 64 20 66 72 6f 6d 20 0a 2a 2a  btained from .**
a610: 20 5b 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63   [sqlite3_malloc
a620: 28 29 5d 20 61 6e 64 20 74 68 65 20 72 65 73 75  ()] and the resu
a630: 6c 74 20 69 73 20 73 74 6f 72 65 64 20 69 6e 20  lt is stored in 
a640: 74 68 65 20 63 68 61 72 2a 20 76 61 72 69 61 62  the char* variab
a650: 6c 65 0a 2a 2a 20 74 68 61 74 20 74 68 65 20 66  le.** that the f
a660: 6f 75 72 74 68 20 70 61 72 61 6d 65 74 65 72 20  ourth parameter 
a670: 6f 66 20 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65  of [sqlite3_file
a680: 5f 63 6f 6e 74 72 6f 6c 28 29 5d 20 70 6f 69 6e  _control()] poin
a690: 74 73 20 74 6f 2e 0a 2a 2a 20 54 68 65 20 63 61  ts to..** The ca
a6a0: 6c 6c 65 72 20 69 73 20 72 65 73 70 6f 6e 73 69  ller is responsi
a6b0: 62 6c 65 20 66 6f 72 20 66 72 65 65 69 6e 67 20  ble for freeing 
a6c0: 74 68 65 20 6d 65 6d 6f 72 79 20 77 68 65 6e 20  the memory when 
a6d0: 64 6f 6e 65 2e 20 20 41 73 20 77 69 74 68 0a 2a  done.  As with.*
a6e0: 2a 20 61 6c 6c 20 66 69 6c 65 2d 63 6f 6e 74 72  * all file-contr
a6f0: 6f 6c 20 61 63 74 69 6f 6e 73 2c 20 74 68 65 72  ol actions, ther
a700: 65 20 69 73 20 6e 6f 20 67 75 61 72 61 6e 74 65  e is no guarante
a710: 65 20 74 68 61 74 20 74 68 69 73 20 77 69 6c 6c  e that this will
a720: 20 61 63 74 75 61 6c 6c 79 0a 2a 2a 20 64 6f 20   actually.** do 
a730: 61 6e 79 74 68 69 6e 67 2e 20 20 43 61 6c 6c 65  anything.  Calle
a740: 72 73 20 73 68 6f 75 6c 64 20 69 6e 69 74 69 61  rs should initia
a750: 6c 69 7a 65 20 74 68 65 20 63 68 61 72 2a 20 76  lize the char* v
a760: 61 72 69 61 62 6c 65 20 74 6f 20 61 20 4e 55 4c  ariable to a NUL
a770: 4c 0a 2a 2a 20 70 6f 69 6e 74 65 72 20 69 6e 20  L.** pointer in 
a780: 63 61 73 65 20 74 68 69 73 20 66 69 6c 65 2d 63  case this file-c
a790: 6f 6e 74 72 6f 6c 20 69 73 20 6e 6f 74 20 69 6d  ontrol is not im
a7a0: 70 6c 65 6d 65 6e 74 65 64 2e 20 20 54 68 69 73  plemented.  This
a7b0: 20 66 69 6c 65 2d 63 6f 6e 74 72 6f 6c 0a 2a 2a   file-control.**
a7c0: 20 69 73 20 69 6e 74 65 6e 64 65 64 20 66 6f 72   is intended for
a7d0: 20 64 69 61 67 6e 6f 73 74 69 63 20 75 73 65 20   diagnostic use 
a7e0: 6f 6e 6c 79 2e 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e  only..**.** <li>
a7f0: 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 56  [[SQLITE_FCNTL_V
a800: 46 53 5f 50 4f 49 4e 54 45 52 5d 5d 0a 2a 2a 20  FS_POINTER]].** 
a810: 5e 54 68 65 20 5b 53 51 4c 49 54 45 5f 46 43 4e  ^The [SQLITE_FCN
a820: 54 4c 5f 56 46 53 5f 50 4f 49 4e 54 45 52 5d 20  TL_VFS_POINTER] 
a830: 6f 70 63 6f 64 65 20 66 69 6e 64 73 20 61 20 70  opcode finds a p
a840: 6f 69 6e 74 65 72 20 74 6f 20 74 68 65 20 74 6f  ointer to the to
a850: 70 2d 6c 65 76 65 6c 0a 2a 2a 20 5b 56 46 53 65  p-level.** [VFSe
a860: 73 5d 20 63 75 72 72 65 6e 74 6c 79 20 69 6e 20  s] currently in 
a870: 75 73 65 2e 20 20 5e 28 54 68 65 20 61 72 67 75  use.  ^(The argu
a880: 6d 65 6e 74 20 58 20 69 6e 0a 2a 2a 20 73 71 6c  ment X in.** sql
a890: 69 74 65 33 5f 66 69 6c 65 5f 63 6f 6e 74 72 6f  ite3_file_contro
a8a0: 6c 28 64 62 2c 53 51 4c 49 54 45 5f 46 43 4e 54  l(db,SQLITE_FCNT
a8b0: 4c 5f 56 46 53 5f 50 4f 49 4e 54 45 52 2c 58 29  L_VFS_POINTER,X)
a8c0: 20 6d 75 73 74 20 62 65 0a 2a 2a 20 6f 66 20 74   must be.** of t
a8d0: 79 70 65 20 22 5b 73 71 6c 69 74 65 33 5f 76 66  ype "[sqlite3_vf
a8e0: 73 5d 20 2a 2a 22 2e 20 20 54 68 69 73 20 6f 70  s] **".  This op
a8f0: 63 6f 64 65 73 20 77 69 6c 6c 20 73 65 74 20 2a  codes will set *
a900: 58 0a 2a 2a 20 74 6f 20 61 20 70 6f 69 6e 74 65  X.** to a pointe
a910: 72 20 74 6f 20 74 68 65 20 74 6f 70 2d 6c 65 76  r to the top-lev
a920: 65 6c 20 56 46 53 2e 29 5e 0a 2a 2a 20 5e 57 68  el VFS.)^.** ^Wh
a930: 65 6e 20 74 68 65 72 65 20 61 72 65 20 6d 75 6c  en there are mul
a940: 74 69 70 6c 65 20 56 46 53 20 73 68 69 6d 73 20  tiple VFS shims 
a950: 69 6e 20 74 68 65 20 73 74 61 63 6b 2c 20 74 68  in the stack, th
a960: 69 73 20 6f 70 63 6f 64 65 20 66 69 6e 64 73 20  is opcode finds 
a970: 74 68 65 0a 2a 2a 20 75 70 70 65 72 2d 6d 6f 73  the.** upper-mos
a980: 74 20 73 68 69 6d 20 6f 6e 6c 79 2e 0a 2a 2a 0a  t shim only..**.
a990: 2a 2a 20 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f  ** <li>[[SQLITE_
a9a0: 46 43 4e 54 4c 5f 50 52 41 47 4d 41 5d 5d 0a 2a  FCNTL_PRAGMA]].*
a9b0: 2a 20 5e 57 68 65 6e 65 76 65 72 20 61 20 5b 50  * ^Whenever a [P
a9c0: 52 41 47 4d 41 5d 20 73 74 61 74 65 6d 65 6e 74  RAGMA] statement
a9d0: 20 69 73 20 70 61 72 73 65 64 2c 20 61 6e 20 5b   is parsed, an [
a9e0: 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 50 52 41  SQLITE_FCNTL_PRA
a9f0: 47 4d 41 5d 20 0a 2a 2a 20 66 69 6c 65 20 63 6f  GMA] .** file co
aa00: 6e 74 72 6f 6c 20 69 73 20 73 65 6e 74 20 74 6f  ntrol is sent to
aa10: 20 74 68 65 20 6f 70 65 6e 20 5b 73 71 6c 69 74   the open [sqlit
aa20: 65 33 5f 66 69 6c 65 5d 20 6f 62 6a 65 63 74 20  e3_file] object 
aa30: 63 6f 72 72 65 73 70 6f 6e 64 69 6e 67 0a 2a 2a  corresponding.**
aa40: 20 74 6f 20 74 68 65 20 64 61 74 61 62 61 73 65   to the database
aa50: 20 66 69 6c 65 20 74 6f 20 77 68 69 63 68 20 74   file to which t
aa60: 68 65 20 70 72 61 67 6d 61 20 73 74 61 74 65 6d  he pragma statem
aa70: 65 6e 74 20 72 65 66 65 72 73 2e 20 5e 54 68 65  ent refers. ^The
aa80: 20 61 72 67 75 6d 65 6e 74 0a 2a 2a 20 74 6f 20   argument.** to 
aa90: 74 68 65 20 5b 53 51 4c 49 54 45 5f 46 43 4e 54  the [SQLITE_FCNT
aaa0: 4c 5f 50 52 41 47 4d 41 5d 20 66 69 6c 65 20 63  L_PRAGMA] file c
aab0: 6f 6e 74 72 6f 6c 20 69 73 20 61 6e 20 61 72 72  ontrol is an arr
aac0: 61 79 20 6f 66 0a 2a 2a 20 70 6f 69 6e 74 65 72  ay of.** pointer
aad0: 73 20 74 6f 20 73 74 72 69 6e 67 73 20 28 63 68  s to strings (ch
aae0: 61 72 2a 2a 29 20 69 6e 20 77 68 69 63 68 20 74  ar**) in which t
aaf0: 68 65 20 73 65 63 6f 6e 64 20 65 6c 65 6d 65 6e  he second elemen
ab00: 74 20 6f 66 20 74 68 65 20 61 72 72 61 79 0a 2a  t of the array.*
ab10: 2a 20 69 73 20 74 68 65 20 6e 61 6d 65 20 6f 66  * is the name of
ab20: 20 74 68 65 20 70 72 61 67 6d 61 20 61 6e 64 20   the pragma and 
ab30: 74 68 65 20 74 68 69 72 64 20 65 6c 65 6d 65 6e  the third elemen
ab40: 74 20 69 73 20 74 68 65 20 61 72 67 75 6d 65 6e  t is the argumen
ab50: 74 20 74 6f 20 74 68 65 0a 2a 2a 20 70 72 61 67  t to the.** prag
ab60: 6d 61 20 6f 72 20 4e 55 4c 4c 20 69 66 20 74 68  ma or NULL if th
ab70: 65 20 70 72 61 67 6d 61 20 68 61 73 20 6e 6f 20  e pragma has no 
ab80: 61 72 67 75 6d 65 6e 74 2e 20 20 5e 54 68 65 20  argument.  ^The 
ab90: 68 61 6e 64 6c 65 72 20 66 6f 72 20 61 6e 0a 2a  handler for an.*
aba0: 2a 20 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f  * [SQLITE_FCNTL_
abb0: 50 52 41 47 4d 41 5d 20 66 69 6c 65 20 63 6f 6e  PRAGMA] file con
abc0: 74 72 6f 6c 20 63 61 6e 20 6f 70 74 69 6f 6e 61  trol can optiona
abd0: 6c 6c 79 20 6d 61 6b 65 20 74 68 65 20 66 69 72  lly make the fir
abe0: 73 74 20 65 6c 65 6d 65 6e 74 0a 2a 2a 20 6f 66  st element.** of
abf0: 20 74 68 65 20 63 68 61 72 2a 2a 20 61 72 67 75   the char** argu
ac00: 6d 65 6e 74 20 70 6f 69 6e 74 20 74 6f 20 61 20  ment point to a 
ac10: 73 74 72 69 6e 67 20 6f 62 74 61 69 6e 65 64 20  string obtained 
ac20: 66 72 6f 6d 20 5b 73 71 6c 69 74 65 33 5f 6d 70  from [sqlite3_mp
ac30: 72 69 6e 74 66 28 29 5d 0a 2a 2a 20 6f 72 20 74  rintf()].** or t
ac40: 68 65 20 65 71 75 69 76 61 6c 65 6e 74 20 61 6e  he equivalent an
ac50: 64 20 74 68 61 74 20 73 74 72 69 6e 67 20 77 69  d that string wi
ac60: 6c 6c 20 62 65 63 6f 6d 65 20 74 68 65 20 72 65  ll become the re
ac70: 73 75 6c 74 20 6f 66 20 74 68 65 20 70 72 61 67  sult of the prag
ac80: 6d 61 20 6f 72 0a 2a 2a 20 74 68 65 20 65 72 72  ma or.** the err
ac90: 6f 72 20 6d 65 73 73 61 67 65 20 69 66 20 74 68  or message if th
aca0: 65 20 70 72 61 67 6d 61 20 66 61 69 6c 73 2e 20  e pragma fails. 
acb0: 5e 49 66 20 74 68 65 0a 2a 2a 20 5b 53 51 4c 49  ^If the.** [SQLI
acc0: 54 45 5f 46 43 4e 54 4c 5f 50 52 41 47 4d 41 5d  TE_FCNTL_PRAGMA]
acd0: 20 66 69 6c 65 20 63 6f 6e 74 72 6f 6c 20 72 65   file control re
ace0: 74 75 72 6e 73 20 5b 53 51 4c 49 54 45 5f 4e 4f  turns [SQLITE_NO
acf0: 54 46 4f 55 4e 44 5d 2c 20 74 68 65 6e 20 6e 6f  TFOUND], then no
ad00: 72 6d 61 6c 20 0a 2a 2a 20 5b 50 52 41 47 4d 41  rmal .** [PRAGMA
ad10: 5d 20 70 72 6f 63 65 73 73 69 6e 67 20 63 6f 6e  ] processing con
ad20: 74 69 6e 75 65 73 2e 20 20 5e 49 66 20 74 68 65  tinues.  ^If the
ad30: 20 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 50   [SQLITE_FCNTL_P
ad40: 52 41 47 4d 41 5d 0a 2a 2a 20 66 69 6c 65 20 63  RAGMA].** file c
ad50: 6f 6e 74 72 6f 6c 20 72 65 74 75 72 6e 73 20 5b  ontrol returns [
ad60: 53 51 4c 49 54 45 5f 4f 4b 5d 2c 20 74 68 65 6e  SQLITE_OK], then
ad70: 20 74 68 65 20 70 61 72 73 65 72 20 61 73 73 75   the parser assu
ad80: 6d 65 73 20 74 68 61 74 20 74 68 65 0a 2a 2a 20  mes that the.** 
ad90: 56 46 53 20 68 61 73 20 68 61 6e 64 6c 65 64 20  VFS has handled 
ada0: 74 68 65 20 50 52 41 47 4d 41 20 69 74 73 65 6c  the PRAGMA itsel
adb0: 66 20 61 6e 64 20 74 68 65 20 70 61 72 73 65 72  f and the parser
adc0: 20 67 65 6e 65 72 61 74 65 73 20 61 20 6e 6f 2d   generates a no-
add0: 6f 70 0a 2a 2a 20 70 72 65 70 61 72 65 64 20 73  op.** prepared s
ade0: 74 61 74 65 6d 65 6e 74 20 69 66 20 72 65 73 75  tatement if resu
adf0: 6c 74 20 73 74 72 69 6e 67 20 69 73 20 4e 55 4c  lt string is NUL
ae00: 4c 2c 20 6f 72 20 74 68 61 74 20 72 65 74 75 72  L, or that retur
ae10: 6e 73 20 61 20 63 6f 70 79 0a 2a 2a 20 6f 66 20  ns a copy.** of 
ae20: 74 68 65 20 72 65 73 75 6c 74 20 73 74 72 69 6e  the result strin
ae30: 67 20 69 66 20 74 68 65 20 73 74 72 69 6e 67 20  g if the string 
ae40: 69 73 20 6e 6f 6e 2d 4e 55 4c 4c 2e 0a 2a 2a 20  is non-NULL..** 
ae50: 5e 49 66 20 74 68 65 20 5b 53 51 4c 49 54 45 5f  ^If the [SQLITE_
ae60: 46 43 4e 54 4c 5f 50 52 41 47 4d 41 5d 20 66 69  FCNTL_PRAGMA] fi
ae70: 6c 65 20 63 6f 6e 74 72 6f 6c 20 72 65 74 75 72  le control retur
ae80: 6e 73 0a 2a 2a 20 61 6e 79 20 72 65 73 75 6c 74  ns.** any result
ae90: 20 63 6f 64 65 20 6f 74 68 65 72 20 74 68 61 6e   code other than
aea0: 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d 20 6f 72 20   [SQLITE_OK] or 
aeb0: 5b 53 51 4c 49 54 45 5f 4e 4f 54 46 4f 55 4e 44  [SQLITE_NOTFOUND
aec0: 5d 2c 20 74 68 61 74 20 6d 65 61 6e 73 0a 2a 2a  ], that means.**
aed0: 20 74 68 61 74 20 74 68 65 20 56 46 53 20 65 6e   that the VFS en
aee0: 63 6f 75 6e 74 65 72 65 64 20 61 6e 20 65 72 72  countered an err
aef0: 6f 72 20 77 68 69 6c 65 20 68 61 6e 64 6c 69 6e  or while handlin
af00: 67 20 74 68 65 20 5b 50 52 41 47 4d 41 5d 20 61  g the [PRAGMA] a
af10: 6e 64 20 74 68 65 0a 2a 2a 20 63 6f 6d 70 69 6c  nd the.** compil
af20: 61 74 69 6f 6e 20 6f 66 20 74 68 65 20 50 52 41  ation of the PRA
af30: 47 4d 41 20 66 61 69 6c 73 20 77 69 74 68 20 61  GMA fails with a
af40: 6e 20 65 72 72 6f 72 2e 20 20 5e 54 68 65 20 5b  n error.  ^The [
af50: 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 50 52 41  SQLITE_FCNTL_PRA
af60: 47 4d 41 5d 0a 2a 2a 20 66 69 6c 65 20 63 6f 6e  GMA].** file con
af70: 74 72 6f 6c 20 6f 63 63 75 72 73 20 61 74 20 74  trol occurs at t
af80: 68 65 20 62 65 67 69 6e 6e 69 6e 67 20 6f 66 20  he beginning of 
af90: 70 72 61 67 6d 61 20 73 74 61 74 65 6d 65 6e 74  pragma statement
afa0: 20 61 6e 61 6c 79 73 69 73 20 61 6e 64 20 73 6f   analysis and so
afb0: 0a 2a 2a 20 69 74 20 69 73 20 61 62 6c 65 20 74  .** it is able t
afc0: 6f 20 6f 76 65 72 72 69 64 65 20 62 75 69 6c 74  o override built
afd0: 2d 69 6e 20 5b 50 52 41 47 4d 41 5d 20 73 74 61  -in [PRAGMA] sta
afe0: 74 65 6d 65 6e 74 73 2e 0a 2a 2a 0a 2a 2a 20 3c  tements..**.** <
aff0: 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54  li>[[SQLITE_FCNT
b000: 4c 5f 42 55 53 59 48 41 4e 44 4c 45 52 5d 5d 0a  L_BUSYHANDLER]].
b010: 2a 2a 20 5e 54 68 65 20 5b 53 51 4c 49 54 45 5f  ** ^The [SQLITE_
b020: 46 43 4e 54 4c 5f 42 55 53 59 48 41 4e 44 4c 45  FCNTL_BUSYHANDLE
b030: 52 5d 0a 2a 2a 20 66 69 6c 65 2d 63 6f 6e 74 72  R].** file-contr
b040: 6f 6c 20 6d 61 79 20 62 65 20 69 6e 76 6f 6b 65  ol may be invoke
b050: 64 20 62 79 20 53 51 4c 69 74 65 20 6f 6e 20 74  d by SQLite on t
b060: 68 65 20 64 61 74 61 62 61 73 65 20 66 69 6c 65  he database file
b070: 20 68 61 6e 64 6c 65 0a 2a 2a 20 73 68 6f 72 74   handle.** short
b080: 6c 79 20 61 66 74 65 72 20 69 74 20 69 73 20 6f  ly after it is o
b090: 70 65 6e 65 64 20 69 6e 20 6f 72 64 65 72 20 74  pened in order t
b0a0: 6f 20 70 72 6f 76 69 64 65 20 61 20 63 75 73 74  o provide a cust
b0b0: 6f 6d 20 56 46 53 20 77 69 74 68 20 61 63 63 65  om VFS with acce
b0c0: 73 73 0a 2a 2a 20 74 6f 20 74 68 65 20 63 6f 6e  ss.** to the con
b0d0: 6e 65 63 74 69 6f 6e 73 20 62 75 73 79 2d 68 61  nections busy-ha
b0e0: 6e 64 6c 65 72 20 63 61 6c 6c 62 61 63 6b 2e 20  ndler callback. 
b0f0: 54 68 65 20 61 72 67 75 6d 65 6e 74 20 69 73 20  The argument is 
b100: 6f 66 20 74 79 70 65 20 28 76 6f 69 64 20 2a 2a  of type (void **
b110: 29 0a 2a 2a 20 2d 20 61 6e 20 61 72 72 61 79 20  ).** - an array 
b120: 6f 66 20 74 77 6f 20 28 76 6f 69 64 20 2a 29 20  of two (void *) 
b130: 76 61 6c 75 65 73 2e 20 54 68 65 20 66 69 72 73  values. The firs
b140: 74 20 28 76 6f 69 64 20 2a 29 20 61 63 74 75 61  t (void *) actua
b150: 6c 6c 79 20 70 6f 69 6e 74 73 0a 2a 2a 20 74 6f  lly points.** to
b160: 20 61 20 66 75 6e 63 74 69 6f 6e 20 6f 66 20 74   a function of t
b170: 79 70 65 20 28 69 6e 74 20 28 2a 29 28 76 6f 69  ype (int (*)(voi
b180: 64 20 2a 29 29 2e 20 49 6e 20 6f 72 64 65 72 20  d *)). In order 
b190: 74 6f 20 69 6e 76 6f 6b 65 20 74 68 65 20 63 6f  to invoke the co
b1a0: 6e 6e 65 63 74 69 6f 6e 73 0a 2a 2a 20 62 75 73  nnections.** bus
b1b0: 79 2d 68 61 6e 64 6c 65 72 2c 20 74 68 69 73 20  y-handler, this 
b1c0: 66 75 6e 63 74 69 6f 6e 20 73 68 6f 75 6c 64 20  function should 
b1d0: 62 65 20 69 6e 76 6f 6b 65 64 20 77 69 74 68 20  be invoked with 
b1e0: 74 68 65 20 73 65 63 6f 6e 64 20 28 76 6f 69 64  the second (void
b1f0: 20 2a 29 20 69 6e 0a 2a 2a 20 74 68 65 20 61 72   *) in.** the ar
b200: 72 61 79 20 61 73 20 74 68 65 20 6f 6e 6c 79 20  ray as the only 
b210: 61 72 67 75 6d 65 6e 74 2e 20 49 66 20 69 74 20  argument. If it 
b220: 72 65 74 75 72 6e 73 20 6e 6f 6e 2d 7a 65 72 6f  returns non-zero
b230: 2c 20 74 68 65 6e 20 74 68 65 20 6f 70 65 72 61  , then the opera
b240: 74 69 6f 6e 0a 2a 2a 20 73 68 6f 75 6c 64 20 62  tion.** should b
b250: 65 20 72 65 74 72 69 65 64 2e 20 49 66 20 69 74  e retried. If it
b260: 20 72 65 74 75 72 6e 73 20 7a 65 72 6f 2c 20 74   returns zero, t
b270: 68 65 20 63 75 73 74 6f 6d 20 56 46 53 20 73 68  he custom VFS sh
b280: 6f 75 6c 64 20 61 62 61 6e 64 6f 6e 20 74 68 65  ould abandon the
b290: 0a 2a 2a 20 63 75 72 72 65 6e 74 20 6f 70 65 72  .** current oper
b2a0: 61 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 3c 6c 69  ation..**.** <li
b2b0: 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f  >[[SQLITE_FCNTL_
b2c0: 54 45 4d 50 46 49 4c 45 4e 41 4d 45 5d 5d 0a 2a  TEMPFILENAME]].*
b2d0: 2a 20 5e 41 70 70 6c 69 63 61 74 69 6f 6e 20 63  * ^Application c
b2e0: 61 6e 20 69 6e 76 6f 6b 65 20 74 68 65 20 5b 53  an invoke the [S
b2f0: 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 54 45 4d 50  QLITE_FCNTL_TEMP
b300: 46 49 4c 45 4e 41 4d 45 5d 20 66 69 6c 65 2d 63  FILENAME] file-c
b310: 6f 6e 74 72 6f 6c 0a 2a 2a 20 74 6f 20 68 61 76  ontrol.** to hav
b320: 65 20 53 51 4c 69 74 65 20 67 65 6e 65 72 61 74  e SQLite generat
b330: 65 20 61 0a 2a 2a 20 74 65 6d 70 6f 72 61 72 79  e a.** temporary
b340: 20 66 69 6c 65 6e 61 6d 65 20 75 73 69 6e 67 20   filename using 
b350: 74 68 65 20 73 61 6d 65 20 61 6c 67 6f 72 69 74  the same algorit
b360: 68 6d 20 74 68 61 74 20 69 73 20 66 6f 6c 6c 6f  hm that is follo
b370: 77 65 64 20 74 6f 20 67 65 6e 65 72 61 74 65 0a  wed to generate.
b380: 2a 2a 20 74 65 6d 70 6f 72 61 72 79 20 66 69 6c  ** temporary fil
b390: 65 6e 61 6d 65 73 20 66 6f 72 20 54 45 4d 50 20  enames for TEMP 
b3a0: 74 61 62 6c 65 73 20 61 6e 64 20 6f 74 68 65 72  tables and other
b3b0: 20 69 6e 74 65 72 6e 61 6c 20 75 73 65 73 2e 20   internal uses. 
b3c0: 20 54 68 65 0a 2a 2a 20 61 72 67 75 6d 65 6e 74   The.** argument
b3d0: 20 73 68 6f 75 6c 64 20 62 65 20 61 20 63 68 61   should be a cha
b3e0: 72 2a 2a 20 77 68 69 63 68 20 77 69 6c 6c 20 62  r** which will b
b3f0: 65 20 66 69 6c 6c 65 64 20 77 69 74 68 20 74 68  e filled with th
b400: 65 20 66 69 6c 65 6e 61 6d 65 0a 2a 2a 20 77 72  e filename.** wr
b410: 69 74 74 65 6e 20 69 6e 74 6f 20 6d 65 6d 6f 72  itten into memor
b420: 79 20 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d 20  y obtained from 
b430: 5b 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28  [sqlite3_malloc(
b440: 29 5d 2e 20 20 54 68 65 20 63 61 6c 6c 65 72 20  )].  The caller 
b450: 73 68 6f 75 6c 64 0a 2a 2a 20 69 6e 76 6f 6b 65  should.** invoke
b460: 20 5b 73 71 6c 69 74 65 33 5f 66 72 65 65 28 29   [sqlite3_free()
b470: 5d 20 6f 6e 20 74 68 65 20 72 65 73 75 6c 74 20  ] on the result 
b480: 74 6f 20 61 76 6f 69 64 20 61 20 6d 65 6d 6f 72  to avoid a memor
b490: 79 20 6c 65 61 6b 2e 0a 2a 2a 0a 2a 2a 20 3c 6c  y leak..**.** <l
b4a0: 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c  i>[[SQLITE_FCNTL
b4b0: 5f 4d 4d 41 50 5f 53 49 5a 45 5d 5d 0a 2a 2a 20  _MMAP_SIZE]].** 
b4c0: 54 68 65 20 5b 53 51 4c 49 54 45 5f 46 43 4e 54  The [SQLITE_FCNT
b4d0: 4c 5f 4d 4d 41 50 5f 53 49 5a 45 5d 20 66 69 6c  L_MMAP_SIZE] fil
b4e0: 65 20 63 6f 6e 74 72 6f 6c 20 69 73 20 75 73 65  e control is use
b4f0: 64 20 74 6f 20 71 75 65 72 79 20 6f 72 20 73 65  d to query or se
b500: 74 20 74 68 65 0a 2a 2a 20 6d 61 78 69 6d 75 6d  t the.** maximum
b510: 20 6e 75 6d 62 65 72 20 6f 66 20 62 79 74 65 73   number of bytes
b520: 20 74 68 61 74 20 77 69 6c 6c 20 62 65 20 75 73   that will be us
b530: 65 64 20 66 6f 72 20 6d 65 6d 6f 72 79 2d 6d 61  ed for memory-ma
b540: 70 70 65 64 20 49 2f 4f 2e 0a 2a 2a 20 54 68 65  pped I/O..** The
b550: 20 61 72 67 75 6d 65 6e 74 20 69 73 20 61 20 70   argument is a p
b560: 6f 69 6e 74 65 72 20 74 6f 20 61 20 76 61 6c 75  ointer to a valu
b570: 65 20 6f 66 20 74 79 70 65 20 73 71 6c 69 74 65  e of type sqlite
b580: 33 5f 69 6e 74 36 34 20 74 68 61 74 0a 2a 2a 20  3_int64 that.** 
b590: 69 73 20 61 6e 20 61 64 76 69 73 6f 72 79 20 6d  is an advisory m
b5a0: 61 78 69 6d 75 6d 20 6e 75 6d 62 65 72 20 6f 66  aximum number of
b5b0: 20 62 79 74 65 73 20 69 6e 20 74 68 65 20 66 69   bytes in the fi
b5c0: 6c 65 20 74 6f 20 6d 65 6d 6f 72 79 20 6d 61 70  le to memory map
b5d0: 2e 20 20 54 68 65 0a 2a 2a 20 70 6f 69 6e 74 65  .  The.** pointe
b5e0: 72 20 69 73 20 6f 76 65 72 77 72 69 74 74 65 6e  r is overwritten
b5f0: 20 77 69 74 68 20 74 68 65 20 6f 6c 64 20 76 61   with the old va
b600: 6c 75 65 2e 20 20 54 68 65 20 6c 69 6d 69 74 20  lue.  The limit 
b610: 69 73 20 6e 6f 74 20 63 68 61 6e 67 65 64 20 69  is not changed i
b620: 66 0a 2a 2a 20 74 68 65 20 76 61 6c 75 65 20 6f  f.** the value o
b630: 72 69 67 69 6e 61 6c 6c 79 20 70 6f 69 6e 74 65  riginally pointe
b640: 64 20 74 6f 20 69 73 20 6e 65 67 61 74 69 76 65  d to is negative
b650: 2c 20 61 6e 64 20 73 6f 20 74 68 65 20 63 75 72  , and so the cur
b660: 72 65 6e 74 20 6c 69 6d 69 74 20 0a 2a 2a 20 63  rent limit .** c
b670: 61 6e 20 62 65 20 71 75 65 72 69 65 64 20 62 79  an be queried by
b680: 20 70 61 73 73 69 6e 67 20 69 6e 20 61 20 70 6f   passing in a po
b690: 69 6e 74 65 72 20 74 6f 20 61 20 6e 65 67 61 74  inter to a negat
b6a0: 69 76 65 20 6e 75 6d 62 65 72 2e 20 20 54 68 69  ive number.  Thi
b6b0: 73 0a 2a 2a 20 66 69 6c 65 2d 63 6f 6e 74 72 6f  s.** file-contro
b6c0: 6c 20 69 73 20 75 73 65 64 20 69 6e 74 65 72 6e  l is used intern
b6d0: 61 6c 6c 79 20 74 6f 20 69 6d 70 6c 65 6d 65 6e  ally to implemen
b6e0: 74 20 5b 50 52 41 47 4d 41 20 6d 6d 61 70 5f 73  t [PRAGMA mmap_s
b6f0: 69 7a 65 5d 2e 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e  ize]..**.** <li>
b700: 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 54  [[SQLITE_FCNTL_T
b710: 52 41 43 45 5d 5d 0a 2a 2a 20 54 68 65 20 5b 53  RACE]].** The [S
b720: 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 54 52 41 43  QLITE_FCNTL_TRAC
b730: 45 5d 20 66 69 6c 65 20 63 6f 6e 74 72 6f 6c 20  E] file control 
b740: 70 72 6f 76 69 64 65 73 20 61 64 76 69 73 6f 72  provides advisor
b750: 79 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 0a 2a 2a  y information.**
b760: 20 74 6f 20 74 68 65 20 56 46 53 20 61 62 6f 75   to the VFS abou
b770: 74 20 77 68 61 74 20 74 68 65 20 68 69 67 68 65  t what the highe
b780: 72 20 6c 61 79 65 72 73 20 6f 66 20 74 68 65 20  r layers of the 
b790: 53 51 4c 69 74 65 20 73 74 61 63 6b 20 61 72 65  SQLite stack are
b7a0: 20 64 6f 69 6e 67 2e 0a 2a 2a 20 54 68 69 73 20   doing..** This 
b7b0: 66 69 6c 65 20 63 6f 6e 74 72 6f 6c 20 69 73 20  file control is 
b7c0: 75 73 65 64 20 62 79 20 73 6f 6d 65 20 56 46 53  used by some VFS
b7d0: 20 61 63 74 69 76 69 74 79 20 74 72 61 63 69 6e   activity tracin
b7e0: 67 20 5b 73 68 69 6d 73 5d 2e 0a 2a 2a 20 54 68  g [shims]..** Th
b7f0: 65 20 61 72 67 75 6d 65 6e 74 20 69 73 20 61 20  e argument is a 
b800: 7a 65 72 6f 2d 74 65 72 6d 69 6e 61 74 65 64 20  zero-terminated 
b810: 73 74 72 69 6e 67 2e 20 20 48 69 67 68 65 72 20  string.  Higher 
b820: 6c 61 79 65 72 73 20 69 6e 20 74 68 65 0a 2a 2a  layers in the.**
b830: 20 53 51 4c 69 74 65 20 73 74 61 63 6b 20 6d 61   SQLite stack ma
b840: 79 20 67 65 6e 65 72 61 74 65 20 69 6e 73 74 61  y generate insta
b850: 6e 63 65 73 20 6f 66 20 74 68 69 73 20 66 69 6c  nces of this fil
b860: 65 20 63 6f 6e 74 72 6f 6c 20 69 66 0a 2a 2a 20  e control if.** 
b870: 74 68 65 20 5b 53 51 4c 49 54 45 5f 55 53 45 5f  the [SQLITE_USE_
b880: 46 43 4e 54 4c 5f 54 52 41 43 45 5d 20 63 6f 6d  FCNTL_TRACE] com
b890: 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e  pile-time option
b8a0: 20 69 73 20 65 6e 61 62 6c 65 64 2e 0a 2a 2a 0a   is enabled..**.
b8b0: 2a 2a 20 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f  ** <li>[[SQLITE_
b8c0: 46 43 4e 54 4c 5f 48 41 53 5f 4d 4f 56 45 44 5d  FCNTL_HAS_MOVED]
b8d0: 5d 0a 2a 2a 20 54 68 65 20 5b 53 51 4c 49 54 45  ].** The [SQLITE
b8e0: 5f 46 43 4e 54 4c 5f 48 41 53 5f 4d 4f 56 45 44  _FCNTL_HAS_MOVED
b8f0: 5d 20 66 69 6c 65 20 63 6f 6e 74 72 6f 6c 20 69  ] file control i
b900: 6e 74 65 72 70 72 65 74 73 20 69 74 73 20 61 72  nterprets its ar
b910: 67 75 6d 65 6e 74 20 61 73 20 61 0a 2a 2a 20 70  gument as a.** p
b920: 6f 69 6e 74 65 72 20 74 6f 20 61 6e 20 69 6e 74  ointer to an int
b930: 65 67 65 72 20 61 6e 64 20 69 74 20 77 72 69 74  eger and it writ
b940: 65 73 20 61 20 62 6f 6f 6c 65 61 6e 20 69 6e 74  es a boolean int
b950: 6f 20 74 68 61 74 20 69 6e 74 65 67 65 72 20 64  o that integer d
b960: 65 70 65 6e 64 69 6e 67 0a 2a 2a 20 6f 6e 20 77  epending.** on w
b970: 68 65 74 68 65 72 20 6f 72 20 6e 6f 74 20 74 68  hether or not th
b980: 65 20 66 69 6c 65 20 68 61 73 20 62 65 65 6e 20  e file has been 
b990: 72 65 6e 61 6d 65 64 2c 20 6d 6f 76 65 64 2c 20  renamed, moved, 
b9a0: 6f 72 20 64 65 6c 65 74 65 64 20 73 69 6e 63 65  or deleted since
b9b0: 20 69 74 0a 2a 2a 20 77 61 73 20 66 69 72 73 74   it.** was first
b9c0: 20 6f 70 65 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 3c   opened..**.** <
b9d0: 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54  li>[[SQLITE_FCNT
b9e0: 4c 5f 57 49 4e 33 32 5f 53 45 54 5f 48 41 4e 44  L_WIN32_SET_HAND
b9f0: 4c 45 5d 5d 0a 2a 2a 20 54 68 65 20 5b 53 51 4c  LE]].** The [SQL
ba00: 49 54 45 5f 46 43 4e 54 4c 5f 57 49 4e 33 32 5f  ITE_FCNTL_WIN32_
ba10: 53 45 54 5f 48 41 4e 44 4c 45 5d 20 6f 70 63 6f  SET_HANDLE] opco
ba20: 64 65 20 69 73 20 75 73 65 64 20 66 6f 72 20 64  de is used for d
ba30: 65 62 75 67 67 69 6e 67 2e 20 20 54 68 69 73 0a  ebugging.  This.
ba40: 2a 2a 20 6f 70 63 6f 64 65 20 63 61 75 73 65 73  ** opcode causes
ba50: 20 74 68 65 20 78 46 69 6c 65 43 6f 6e 74 72 6f   the xFileContro
ba60: 6c 20 6d 65 74 68 6f 64 20 74 6f 20 73 77 61 70  l method to swap
ba70: 20 74 68 65 20 66 69 6c 65 20 68 61 6e 64 6c 65   the file handle
ba80: 20 77 69 74 68 20 74 68 65 20 6f 6e 65 0a 2a 2a   with the one.**
ba90: 20 70 6f 69 6e 74 65 64 20 74 6f 20 62 79 20 74   pointed to by t
baa0: 68 65 20 70 41 72 67 20 61 72 67 75 6d 65 6e 74  he pArg argument
bab0: 2e 20 20 54 68 69 73 20 63 61 70 61 62 69 6c 69  .  This capabili
bac0: 74 79 20 69 73 20 75 73 65 64 20 64 75 72 69 6e  ty is used durin
bad0: 67 20 74 65 73 74 69 6e 67 0a 2a 2a 20 61 6e 64  g testing.** and
bae0: 20 6f 6e 6c 79 20 6e 65 65 64 73 20 74 6f 20 62   only needs to b
baf0: 65 20 73 75 70 70 6f 72 74 65 64 20 77 68 65 6e  e supported when
bb00: 20 53 51 4c 49 54 45 5f 54 45 53 54 20 69 73 20   SQLITE_TEST is 
bb10: 64 65 66 69 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 3c  defined..**.** <
bb20: 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54  li>[[SQLITE_FCNT
bb30: 4c 5f 57 41 4c 5f 42 4c 4f 43 4b 5d 5d 0a 2a 2a  L_WAL_BLOCK]].**
bb40: 20 54 68 65 20 5b 53 51 4c 49 54 45 5f 46 43 4e   The [SQLITE_FCN
bb50: 54 4c 5f 57 41 4c 5f 42 4c 4f 43 4b 5d 20 69 73  TL_WAL_BLOCK] is
bb60: 20 61 20 73 69 67 6e 61 6c 20 74 6f 20 74 68 65   a signal to the
bb70: 20 56 46 53 20 6c 61 79 65 72 20 74 68 61 74 20   VFS layer that 
bb80: 69 74 20 6d 69 67 68 74 0a 2a 2a 20 62 65 20 61  it might.** be a
bb90: 64 76 61 6e 74 61 67 65 6f 75 73 20 74 6f 20 62  dvantageous to b
bba0: 6c 6f 63 6b 20 6f 6e 20 74 68 65 20 6e 65 78 74  lock on the next
bbb0: 20 57 41 4c 20 6c 6f 63 6b 20 69 66 20 74 68 65   WAL lock if the
bbc0: 20 6c 6f 63 6b 20 69 73 20 6e 6f 74 20 69 6d 6d   lock is not imm
bbd0: 65 64 69 61 74 65 6c 79 0a 2a 2a 20 61 76 61 69  ediately.** avai
bbe0: 6c 61 62 6c 65 2e 20 20 54 68 65 20 57 41 4c 20  lable.  The WAL 
bbf0: 73 75 62 73 79 73 74 65 6d 20 69 73 73 75 65 73  subsystem issues
bc00: 20 74 68 69 73 20 73 69 67 6e 61 6c 20 64 75 72   this signal dur
bc10: 69 6e 67 20 72 61 72 65 0a 2a 2a 20 63 69 72 63  ing rare.** circ
bc20: 75 6d 73 74 61 6e 63 65 73 20 69 6e 20 6f 72 64  umstances in ord
bc30: 65 72 20 74 6f 20 66 69 78 20 61 20 70 72 6f 62  er to fix a prob
bc40: 6c 65 6d 20 77 69 74 68 20 70 72 69 6f 72 69 74  lem with priorit
bc50: 79 20 69 6e 76 65 72 73 69 6f 6e 2e 0a 2a 2a 20  y inversion..** 
bc60: 41 70 70 6c 69 63 61 74 69 6f 6e 73 20 73 68 6f  Applications sho
bc70: 75 6c 64 20 3c 65 6d 3e 6e 6f 74 3c 2f 65 6d 3e  uld <em>not</em>
bc80: 20 75 73 65 20 74 68 69 73 20 66 69 6c 65 2d 63   use this file-c
bc90: 6f 6e 74 72 6f 6c 2e 0a 2a 2a 0a 2a 2a 20 3c 6c  ontrol..**.** <l
bca0: 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c  i>[[SQLITE_FCNTL
bcb0: 5f 5a 49 50 56 46 53 5d 5d 0a 2a 2a 20 54 68 65  _ZIPVFS]].** The
bcc0: 20 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 5a   [SQLITE_FCNTL_Z
bcd0: 49 50 56 46 53 5d 20 6f 70 63 6f 64 65 20 69 73  IPVFS] opcode is
bce0: 20 69 6d 70 6c 65 6d 65 6e 74 65 64 20 62 79 20   implemented by 
bcf0: 7a 69 70 76 66 73 20 6f 6e 6c 79 2e 20 41 6c 6c  zipvfs only. All
bd00: 20 6f 74 68 65 72 0a 2a 2a 20 56 46 53 20 73 68   other.** VFS sh
bd10: 6f 75 6c 64 20 72 65 74 75 72 6e 20 53 51 4c 49  ould return SQLI
bd20: 54 45 5f 4e 4f 54 46 4f 55 4e 44 20 66 6f 72 20  TE_NOTFOUND for 
bd30: 74 68 69 73 20 6f 70 63 6f 64 65 2e 0a 2a 2a 0a  this opcode..**.
bd40: 2a 2a 20 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f  ** <li>[[SQLITE_
bd50: 46 43 4e 54 4c 5f 52 42 55 5d 5d 0a 2a 2a 20 54  FCNTL_RBU]].** T
bd60: 68 65 20 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c  he [SQLITE_FCNTL
bd70: 5f 52 42 55 5d 20 6f 70 63 6f 64 65 20 69 73 20  _RBU] opcode is 
bd80: 69 6d 70 6c 65 6d 65 6e 74 65 64 20 62 79 20 74  implemented by t
bd90: 68 65 20 73 70 65 63 69 61 6c 20 56 46 53 20 75  he special VFS u
bda0: 73 65 64 20 62 79 0a 2a 2a 20 74 68 65 20 52 42  sed by.** the RB
bdb0: 55 20 65 78 74 65 6e 73 69 6f 6e 20 6f 6e 6c 79  U extension only
bdc0: 2e 20 20 41 6c 6c 20 6f 74 68 65 72 20 56 46 53  .  All other VFS
bdd0: 20 73 68 6f 75 6c 64 20 72 65 74 75 72 6e 20 53   should return S
bde0: 51 4c 49 54 45 5f 4e 4f 54 46 4f 55 4e 44 20 66  QLITE_NOTFOUND f
bdf0: 6f 72 0a 2a 2a 20 74 68 69 73 20 6f 70 63 6f 64  or.** this opcod
be00: 65 2e 20 20 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2f  e.  .** </ul>.*/
be10: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
be20: 46 43 4e 54 4c 5f 4c 4f 43 4b 53 54 41 54 45 20  FCNTL_LOCKSTATE 
be30: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 31 0a                1.
be40: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 46  #define SQLITE_F
be50: 43 4e 54 4c 5f 47 45 54 5f 4c 4f 43 4b 50 52 4f  CNTL_GET_LOCKPRO
be60: 58 59 46 49 4c 45 20 20 20 20 20 20 20 32 0a 23  XYFILE       2.#
be70: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 43  define SQLITE_FC
be80: 4e 54 4c 5f 53 45 54 5f 4c 4f 43 4b 50 52 4f 58  NTL_SET_LOCKPROX
be90: 59 46 49 4c 45 20 20 20 20 20 20 20 33 0a 23 64  YFILE       3.#d
bea0: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e  efine SQLITE_FCN
beb0: 54 4c 5f 4c 41 53 54 5f 45 52 52 4e 4f 20 20 20  TL_LAST_ERRNO   
bec0: 20 20 20 20 20 20 20 20 20 20 20 34 0a 23 64 65             4.#de
bed0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e 54  fine SQLITE_FCNT
bee0: 4c 5f 53 49 5a 45 5f 48 49 4e 54 20 20 20 20 20  L_SIZE_HINT     
bef0: 20 20 20 20 20 20 20 20 20 20 35 0a 23 64 65 66            5.#def
bf00: 69 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c  ine SQLITE_FCNTL
bf10: 5f 43 48 55 4e 4b 5f 53 49 5a 45 20 20 20 20 20  _CHUNK_SIZE     
bf20: 20 20 20 20 20 20 20 20 20 36 0a 23 64 65 66 69           6.#defi
bf30: 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f  ne SQLITE_FCNTL_
bf40: 46 49 4c 45 5f 50 4f 49 4e 54 45 52 20 20 20 20  FILE_POINTER    
bf50: 20 20 20 20 20 20 20 20 37 0a 23 64 65 66 69 6e          7.#defin
bf60: 65 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 53  e SQLITE_FCNTL_S
bf70: 59 4e 43 5f 4f 4d 49 54 54 45 44 20 20 20 20 20  YNC_OMITTED     
bf80: 20 20 20 20 20 20 20 38 0a 23 64 65 66 69 6e 65         8.#define
bf90: 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 57 49   SQLITE_FCNTL_WI
bfa0: 4e 33 32 5f 41 56 5f 52 45 54 52 59 20 20 20 20  N32_AV_RETRY    
bfb0: 20 20 20 20 20 20 39 0a 23 64 65 66 69 6e 65 20        9.#define 
bfc0: 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 50 45 52  SQLITE_FCNTL_PER
bfd0: 53 49 53 54 5f 57 41 4c 20 20 20 20 20 20 20 20  SIST_WAL        
bfe0: 20 20 20 20 31 30 0a 23 64 65 66 69 6e 65 20 53      10.#define S
bff0: 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 4f 56 45 52  QLITE_FCNTL_OVER
c000: 57 52 49 54 45 20 20 20 20 20 20 20 20 20 20 20  WRITE           
c010: 20 20 20 31 31 0a 23 64 65 66 69 6e 65 20 53 51     11.#define SQ
c020: 4c 49 54 45 5f 46 43 4e 54 4c 5f 56 46 53 4e 41  LITE_FCNTL_VFSNA
c030: 4d 45 20 20 20 20 20 20 20 20 20 20 20 20 20 20  ME              
c040: 20 20 31 32 0a 23 64 65 66 69 6e 65 20 53 51 4c    12.#define SQL
c050: 49 54 45 5f 46 43 4e 54 4c 5f 50 4f 57 45 52 53  ITE_FCNTL_POWERS
c060: 41 46 45 5f 4f 56 45 52 57 52 49 54 45 20 20 20  AFE_OVERWRITE   
c070: 20 31 33 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   13.#define SQLI
c080: 54 45 5f 46 43 4e 54 4c 5f 50 52 41 47 4d 41 20  TE_FCNTL_PRAGMA 
c090: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
c0a0: 31 34 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  14.#define SQLIT
c0b0: 45 5f 46 43 4e 54 4c 5f 42 55 53 59 48 41 4e 44  E_FCNTL_BUSYHAND
c0c0: 4c 45 52 20 20 20 20 20 20 20 20 20 20 20 20 31  LER            1
c0d0: 35 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  5.#define SQLITE
c0e0: 5f 46 43 4e 54 4c 5f 54 45 4d 50 46 49 4c 45 4e  _FCNTL_TEMPFILEN
c0f0: 41 4d 45 20 20 20 20 20 20 20 20 20 20 20 31 36  AME           16
c100: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
c110: 46 43 4e 54 4c 5f 4d 4d 41 50 5f 53 49 5a 45 20  FCNTL_MMAP_SIZE 
c120: 20 20 20 20 20 20 20 20 20 20 20 20 20 31 38 0a               18.
c130: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 46  #define SQLITE_F
c140: 43 4e 54 4c 5f 54 52 41 43 45 20 20 20 20 20 20  CNTL_TRACE      
c150: 20 20 20 20 20 20 20 20 20 20 20 20 31 39 0a 23              19.#
c160: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 43  define SQLITE_FC
c170: 4e 54 4c 5f 48 41 53 5f 4d 4f 56 45 44 20 20 20  NTL_HAS_MOVED   
c180: 20 20 20 20 20 20 20 20 20 20 20 32 30 0a 23 64             20.#d
c190: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e  efine SQLITE_FCN
c1a0: 54 4c 5f 53 59 4e 43 20 20 20 20 20 20 20 20 20  TL_SYNC         
c1b0: 20 20 20 20 20 20 20 20 20 20 32 31 0a 23 64 65            21.#de
c1c0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e 54  fine SQLITE_FCNT
c1d0: 4c 5f 43 4f 4d 4d 49 54 5f 50 48 41 53 45 54 57  L_COMMIT_PHASETW
c1e0: 4f 20 20 20 20 20 20 20 20 32 32 0a 23 64 65 66  O        22.#def
c1f0: 69 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c  ine SQLITE_FCNTL
c200: 5f 57 49 4e 33 32 5f 53 45 54 5f 48 41 4e 44 4c  _WIN32_SET_HANDL
c210: 45 20 20 20 20 20 20 20 32 33 0a 23 64 65 66 69  E       23.#defi
c220: 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f  ne SQLITE_FCNTL_
c230: 57 41 4c 5f 42 4c 4f 43 4b 20 20 20 20 20 20 20  WAL_BLOCK       
c240: 20 20 20 20 20 20 20 32 34 0a 23 64 65 66 69 6e         24.#defin
c250: 65 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 5a  e SQLITE_FCNTL_Z
c260: 49 50 56 46 53 20 20 20 20 20 20 20 20 20 20 20  IPVFS           
c270: 20 20 20 20 20 20 32 35 0a 23 64 65 66 69 6e 65        25.#define
c280: 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 52 42   SQLITE_FCNTL_RB
c290: 55 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  U               
c2a0: 20 20 20 20 20 32 36 0a 23 64 65 66 69 6e 65 20       26.#define 
c2b0: 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 56 46 53  SQLITE_FCNTL_VFS
c2c0: 5f 50 4f 49 4e 54 45 52 20 20 20 20 20 20 20 20  _POINTER        
c2d0: 20 20 20 20 32 37 0a 23 64 65 66 69 6e 65 20 53      27.#define S
c2e0: 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 4a 4f 55 52  QLITE_FCNTL_JOUR
c2f0: 4e 41 4c 5f 50 4f 49 4e 54 45 52 20 20 20 20 20  NAL_POINTER     
c300: 20 20 20 32 38 0a 0a 2f 2a 20 64 65 70 72 65 63     28../* deprec
c310: 61 74 65 64 20 6e 61 6d 65 73 20 2a 2f 0a 23 64  ated names */.#d
c320: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 47 45 54  efine SQLITE_GET
c330: 5f 4c 4f 43 4b 50 52 4f 58 59 46 49 4c 45 20 20  _LOCKPROXYFILE  
c340: 20 20 20 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c      SQLITE_FCNTL
c350: 5f 47 45 54 5f 4c 4f 43 4b 50 52 4f 58 59 46 49  _GET_LOCKPROXYFI
c360: 4c 45 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  LE.#define SQLIT
c370: 45 5f 53 45 54 5f 4c 4f 43 4b 50 52 4f 58 59 46  E_SET_LOCKPROXYF
c380: 49 4c 45 20 20 20 20 20 20 53 51 4c 49 54 45 5f  ILE      SQLITE_
c390: 46 43 4e 54 4c 5f 53 45 54 5f 4c 4f 43 4b 50 52  FCNTL_SET_LOCKPR
c3a0: 4f 58 59 46 49 4c 45 0a 23 64 65 66 69 6e 65 20  OXYFILE.#define 
c3b0: 53 51 4c 49 54 45 5f 4c 41 53 54 5f 45 52 52 4e  SQLITE_LAST_ERRN
c3c0: 4f 20 20 20 20 20 20 20 20 20 20 20 20 20 53 51  O             SQ
c3d0: 4c 49 54 45 5f 46 43 4e 54 4c 5f 4c 41 53 54 5f  LITE_FCNTL_LAST_
c3e0: 45 52 52 4e 4f 0a 0a 0a 2f 2a 0a 2a 2a 20 43 41  ERRNO.../*.** CA
c3f0: 50 49 33 52 45 46 3a 20 4d 75 74 65 78 20 48 61  PI3REF: Mutex Ha
c400: 6e 64 6c 65 0a 2a 2a 0a 2a 2a 20 54 68 65 20 6d  ndle.**.** The m
c410: 75 74 65 78 20 6d 6f 64 75 6c 65 20 77 69 74 68  utex module with
c420: 69 6e 20 53 51 4c 69 74 65 20 64 65 66 69 6e 65  in SQLite define
c430: 73 20 5b 73 71 6c 69 74 65 33 5f 6d 75 74 65 78  s [sqlite3_mutex
c440: 5d 20 74 6f 20 62 65 20 61 6e 0a 2a 2a 20 61 62  ] to be an.** ab
c450: 73 74 72 61 63 74 20 74 79 70 65 20 66 6f 72 20  stract type for 
c460: 61 20 6d 75 74 65 78 20 6f 62 6a 65 63 74 2e 20  a mutex object. 
c470: 20 54 68 65 20 53 51 4c 69 74 65 20 63 6f 72 65   The SQLite core
c480: 20 6e 65 76 65 72 20 6c 6f 6f 6b 73 0a 2a 2a 20   never looks.** 
c490: 61 74 20 74 68 65 20 69 6e 74 65 72 6e 61 6c 20  at the internal 
c4a0: 72 65 70 72 65 73 65 6e 74 61 74 69 6f 6e 20 6f  representation o
c4b0: 66 20 61 6e 20 5b 73 71 6c 69 74 65 33 5f 6d 75  f an [sqlite3_mu
c4c0: 74 65 78 5d 2e 20 20 49 74 20 6f 6e 6c 79 0a 2a  tex].  It only.*
c4d0: 2a 20 64 65 61 6c 73 20 77 69 74 68 20 70 6f 69  * deals with poi
c4e0: 6e 74 65 72 73 20 74 6f 20 74 68 65 20 5b 73 71  nters to the [sq
c4f0: 6c 69 74 65 33 5f 6d 75 74 65 78 5d 20 6f 62 6a  lite3_mutex] obj
c500: 65 63 74 2e 0a 2a 2a 0a 2a 2a 20 4d 75 74 65 78  ect..**.** Mutex
c510: 65 73 20 61 72 65 20 63 72 65 61 74 65 64 20 75  es are created u
c520: 73 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 6d 75  sing [sqlite3_mu
c530: 74 65 78 5f 61 6c 6c 6f 63 28 29 5d 2e 0a 2a 2f  tex_alloc()]..*/
c540: 0a 74 79 70 65 64 65 66 20 73 74 72 75 63 74 20  .typedef struct 
c550: 73 71 6c 69 74 65 33 5f 6d 75 74 65 78 20 73 71  sqlite3_mutex sq
c560: 6c 69 74 65 33 5f 6d 75 74 65 78 3b 0a 0a 2f 2a  lite3_mutex;../*
c570: 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 4f 53  .** CAPI3REF: OS
c580: 20 49 6e 74 65 72 66 61 63 65 20 4f 62 6a 65 63   Interface Objec
c590: 74 0a 2a 2a 0a 2a 2a 20 41 6e 20 69 6e 73 74 61  t.**.** An insta
c5a0: 6e 63 65 20 6f 66 20 74 68 65 20 73 71 6c 69 74  nce of the sqlit
c5b0: 65 33 5f 76 66 73 20 6f 62 6a 65 63 74 20 64 65  e3_vfs object de
c5c0: 66 69 6e 65 73 20 74 68 65 20 69 6e 74 65 72 66  fines the interf
c5d0: 61 63 65 20 62 65 74 77 65 65 6e 0a 2a 2a 20 74  ace between.** t
c5e0: 68 65 20 53 51 4c 69 74 65 20 63 6f 72 65 20 61  he SQLite core a
c5f0: 6e 64 20 74 68 65 20 75 6e 64 65 72 6c 79 69 6e  nd the underlyin
c600: 67 20 6f 70 65 72 61 74 69 6e 67 20 73 79 73 74  g operating syst
c610: 65 6d 2e 20 20 54 68 65 20 22 76 66 73 22 0a 2a  em.  The "vfs".*
c620: 2a 20 69 6e 20 74 68 65 20 6e 61 6d 65 20 6f 66  * in the name of
c630: 20 74 68 65 20 6f 62 6a 65 63 74 20 73 74 61 6e   the object stan
c640: 64 73 20 66 6f 72 20 22 76 69 72 74 75 61 6c 20  ds for "virtual 
c650: 66 69 6c 65 20 73 79 73 74 65 6d 22 2e 20 20 53  file system".  S
c660: 65 65 0a 2a 2a 20 74 68 65 20 5b 56 46 53 20 7c  ee.** the [VFS |
c670: 20 56 46 53 20 64 6f 63 75 6d 65 6e 74 61 74 69   VFS documentati
c680: 6f 6e 5d 20 66 6f 72 20 66 75 72 74 68 65 72 20  on] for further 
c690: 69 6e 66 6f 72 6d 61 74 69 6f 6e 2e 0a 2a 2a 0a  information..**.
c6a0: 2a 2a 20 54 68 65 20 76 61 6c 75 65 20 6f 66 20  ** The value of 
c6b0: 74 68 65 20 69 56 65 72 73 69 6f 6e 20 66 69 65  the iVersion fie
c6c0: 6c 64 20 69 73 20 69 6e 69 74 69 61 6c 6c 79 20  ld is initially 
c6d0: 31 20 62 75 74 20 6d 61 79 20 62 65 20 6c 61 72  1 but may be lar
c6e0: 67 65 72 20 69 6e 0a 2a 2a 20 66 75 74 75 72 65  ger in.** future
c6f0: 20 76 65 72 73 69 6f 6e 73 20 6f 66 20 53 51 4c   versions of SQL
c700: 69 74 65 2e 20 20 41 64 64 69 74 69 6f 6e 61 6c  ite.  Additional
c710: 20 66 69 65 6c 64 73 20 6d 61 79 20 62 65 20 61   fields may be a
c720: 70 70 65 6e 64 65 64 20 74 6f 20 74 68 69 73 0a  ppended to this.
c730: 2a 2a 20 6f 62 6a 65 63 74 20 77 68 65 6e 20 74  ** object when t
c740: 68 65 20 69 56 65 72 73 69 6f 6e 20 76 61 6c 75  he iVersion valu
c750: 65 20 69 73 20 69 6e 63 72 65 61 73 65 64 2e 20  e is increased. 
c760: 20 4e 6f 74 65 20 74 68 61 74 20 74 68 65 20 73   Note that the s
c770: 74 72 75 63 74 75 72 65 0a 2a 2a 20 6f 66 20 74  tructure.** of t
c780: 68 65 20 73 71 6c 69 74 65 33 5f 76 66 73 20 6f  he sqlite3_vfs o
c790: 62 6a 65 63 74 20 63 68 61 6e 67 65 73 20 69 6e  bject changes in
c7a0: 20 74 68 65 20 74 72 61 6e 73 61 63 74 69 6f 6e   the transaction
c7b0: 20 62 65 74 77 65 65 6e 0a 2a 2a 20 53 51 4c 69   between.** SQLi
c7c0: 74 65 20 76 65 72 73 69 6f 6e 20 33 2e 35 2e 39  te version 3.5.9
c7d0: 20 61 6e 64 20 33 2e 36 2e 30 20 61 6e 64 20 79   and 3.6.0 and y
c7e0: 65 74 20 74 68 65 20 69 56 65 72 73 69 6f 6e 20  et the iVersion 
c7f0: 66 69 65 6c 64 20 77 61 73 20 6e 6f 74 0a 2a 2a  field was not.**
c800: 20 6d 6f 64 69 66 69 65 64 2e 0a 2a 2a 0a 2a 2a   modified..**.**
c810: 20 54 68 65 20 73 7a 4f 73 46 69 6c 65 20 66 69   The szOsFile fi
c820: 65 6c 64 20 69 73 20 74 68 65 20 73 69 7a 65 20  eld is the size 
c830: 6f 66 20 74 68 65 20 73 75 62 63 6c 61 73 73 65  of the subclasse
c840: 64 20 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65 5d  d [sqlite3_file]
c850: 0a 2a 2a 20 73 74 72 75 63 74 75 72 65 20 75 73  .** structure us
c860: 65 64 20 62 79 20 74 68 69 73 20 56 46 53 2e 20  ed by this VFS. 
c870: 20 6d 78 50 61 74 68 6e 61 6d 65 20 69 73 20 74   mxPathname is t
c880: 68 65 20 6d 61 78 69 6d 75 6d 20 6c 65 6e 67 74  he maximum lengt
c890: 68 20 6f 66 0a 2a 2a 20 61 20 70 61 74 68 6e 61  h of.** a pathna
c8a0: 6d 65 20 69 6e 20 74 68 69 73 20 56 46 53 2e 0a  me in this VFS..
c8b0: 2a 2a 0a 2a 2a 20 52 65 67 69 73 74 65 72 65 64  **.** Registered
c8c0: 20 73 71 6c 69 74 65 33 5f 76 66 73 20 6f 62 6a   sqlite3_vfs obj
c8d0: 65 63 74 73 20 61 72 65 20 6b 65 70 74 20 6f 6e  ects are kept on
c8e0: 20 61 20 6c 69 6e 6b 65 64 20 6c 69 73 74 20 66   a linked list f
c8f0: 6f 72 6d 65 64 20 62 79 0a 2a 2a 20 74 68 65 20  ormed by.** the 
c900: 70 4e 65 78 74 20 70 6f 69 6e 74 65 72 2e 20 20  pNext pointer.  
c910: 54 68 65 20 5b 73 71 6c 69 74 65 33 5f 76 66 73  The [sqlite3_vfs
c920: 5f 72 65 67 69 73 74 65 72 28 29 5d 0a 2a 2a 20  _register()].** 
c930: 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 76 66 73  and [sqlite3_vfs
c940: 5f 75 6e 72 65 67 69 73 74 65 72 28 29 5d 20 69  _unregister()] i
c950: 6e 74 65 72 66 61 63 65 73 20 6d 61 6e 61 67 65  nterfaces manage
c960: 20 74 68 69 73 20 6c 69 73 74 0a 2a 2a 20 69 6e   this list.** in
c970: 20 61 20 74 68 72 65 61 64 2d 73 61 66 65 20 77   a thread-safe w
c980: 61 79 2e 20 20 54 68 65 20 5b 73 71 6c 69 74 65  ay.  The [sqlite
c990: 33 5f 76 66 73 5f 66 69 6e 64 28 29 5d 20 69 6e  3_vfs_find()] in
c9a0: 74 65 72 66 61 63 65 0a 2a 2a 20 73 65 61 72 63  terface.** searc
c9b0: 68 65 73 20 74 68 65 20 6c 69 73 74 2e 20 20 4e  hes the list.  N
c9c0: 65 69 74 68 65 72 20 74 68 65 20 61 70 70 6c 69  either the appli
c9d0: 63 61 74 69 6f 6e 20 63 6f 64 65 20 6e 6f 72 20  cation code nor 
c9e0: 74 68 65 20 56 46 53 0a 2a 2a 20 69 6d 70 6c 65  the VFS.** imple
c9f0: 6d 65 6e 74 61 74 69 6f 6e 20 73 68 6f 75 6c 64  mentation should
ca00: 20 75 73 65 20 74 68 65 20 70 4e 65 78 74 20 70   use the pNext p
ca10: 6f 69 6e 74 65 72 2e 0a 2a 2a 0a 2a 2a 20 54 68  ointer..**.** Th
ca20: 65 20 70 4e 65 78 74 20 66 69 65 6c 64 20 69 73  e pNext field is
ca30: 20 74 68 65 20 6f 6e 6c 79 20 66 69 65 6c 64 20   the only field 
ca40: 69 6e 20 74 68 65 20 73 71 6c 69 74 65 33 5f 76  in the sqlite3_v
ca50: 66 73 0a 2a 2a 20 73 74 72 75 63 74 75 72 65 20  fs.** structure 
ca60: 74 68 61 74 20 53 51 4c 69 74 65 20 77 69 6c 6c  that SQLite will
ca70: 20 65 76 65 72 20 6d 6f 64 69 66 79 2e 20 20 53   ever modify.  S
ca80: 51 4c 69 74 65 20 77 69 6c 6c 20 6f 6e 6c 79 20  QLite will only 
ca90: 61 63 63 65 73 73 0a 2a 2a 20 6f 72 20 6d 6f 64  access.** or mod
caa0: 69 66 79 20 74 68 69 73 20 66 69 65 6c 64 20 77  ify this field w
cab0: 68 69 6c 65 20 68 6f 6c 64 69 6e 67 20 61 20 70  hile holding a p
cac0: 61 72 74 69 63 75 6c 61 72 20 73 74 61 74 69 63  articular static
cad0: 20 6d 75 74 65 78 2e 0a 2a 2a 20 54 68 65 20 61   mutex..** The a
cae0: 70 70 6c 69 63 61 74 69 6f 6e 20 73 68 6f 75 6c  pplication shoul
caf0: 64 20 6e 65 76 65 72 20 6d 6f 64 69 66 79 20 61  d never modify a
cb00: 6e 79 74 68 69 6e 67 20 77 69 74 68 69 6e 20 74  nything within t
cb10: 68 65 20 73 71 6c 69 74 65 33 5f 76 66 73 0a 2a  he sqlite3_vfs.*
cb20: 2a 20 6f 62 6a 65 63 74 20 6f 6e 63 65 20 74 68  * object once th
cb30: 65 20 6f 62 6a 65 63 74 20 68 61 73 20 62 65 65  e object has bee
cb40: 6e 20 72 65 67 69 73 74 65 72 65 64 2e 0a 2a 2a  n registered..**
cb50: 0a 2a 2a 20 54 68 65 20 7a 4e 61 6d 65 20 66 69  .** The zName fi
cb60: 65 6c 64 20 68 6f 6c 64 73 20 74 68 65 20 6e 61  eld holds the na
cb70: 6d 65 20 6f 66 20 74 68 65 20 56 46 53 20 6d 6f  me of the VFS mo
cb80: 64 75 6c 65 2e 20 20 54 68 65 20 6e 61 6d 65 20  dule.  The name 
cb90: 6d 75 73 74 0a 2a 2a 20 62 65 20 75 6e 69 71 75  must.** be uniqu
cba0: 65 20 61 63 72 6f 73 73 20 61 6c 6c 20 56 46 53  e across all VFS
cbb0: 20 6d 6f 64 75 6c 65 73 2e 0a 2a 2a 0a 2a 2a 20   modules..**.** 
cbc0: 5b 5b 73 71 6c 69 74 65 33 5f 76 66 73 2e 78 4f  [[sqlite3_vfs.xO
cbd0: 70 65 6e 5d 5d 0a 2a 2a 20 5e 53 51 4c 69 74 65  pen]].** ^SQLite
cbe0: 20 67 75 61 72 61 6e 74 65 65 73 20 74 68 61 74   guarantees that
cbf0: 20 74 68 65 20 7a 46 69 6c 65 6e 61 6d 65 20 70   the zFilename p
cc00: 61 72 61 6d 65 74 65 72 20 74 6f 20 78 4f 70 65  arameter to xOpe
cc10: 6e 0a 2a 2a 20 69 73 20 65 69 74 68 65 72 20 61  n.** is either a
cc20: 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 20 6f 72   NULL pointer or
cc30: 20 73 74 72 69 6e 67 20 6f 62 74 61 69 6e 65 64   string obtained
cc40: 0a 2a 2a 20 66 72 6f 6d 20 78 46 75 6c 6c 50 61  .** from xFullPa
cc50: 74 68 6e 61 6d 65 28 29 20 77 69 74 68 20 61 6e  thname() with an
cc60: 20 6f 70 74 69 6f 6e 61 6c 20 73 75 66 66 69 78   optional suffix
cc70: 20 61 64 64 65 64 2e 0a 2a 2a 20 5e 49 66 20 61   added..** ^If a
cc80: 20 73 75 66 66 69 78 20 69 73 20 61 64 64 65 64   suffix is added
cc90: 20 74 6f 20 74 68 65 20 7a 46 69 6c 65 6e 61 6d   to the zFilenam
cca0: 65 20 70 61 72 61 6d 65 74 65 72 2c 20 69 74 20  e parameter, it 
ccb0: 77 69 6c 6c 0a 2a 2a 20 63 6f 6e 73 69 73 74 20  will.** consist 
ccc0: 6f 66 20 61 20 73 69 6e 67 6c 65 20 22 2d 22 20  of a single "-" 
ccd0: 63 68 61 72 61 63 74 65 72 20 66 6f 6c 6c 6f 77  character follow
cce0: 65 64 20 62 79 20 6e 6f 20 6d 6f 72 65 20 74 68  ed by no more th
ccf0: 61 6e 0a 2a 2a 20 31 31 20 61 6c 70 68 61 6e 75  an.** 11 alphanu
cd00: 6d 65 72 69 63 20 61 6e 64 2f 6f 72 20 22 2d 22  meric and/or "-"
cd10: 20 63 68 61 72 61 63 74 65 72 73 2e 0a 2a 2a 20   characters..** 
cd20: 5e 53 51 4c 69 74 65 20 66 75 72 74 68 65 72 20  ^SQLite further 
cd30: 67 75 61 72 61 6e 74 65 65 73 20 74 68 61 74 0a  guarantees that.
cd40: 2a 2a 20 74 68 65 20 73 74 72 69 6e 67 20 77 69  ** the string wi
cd50: 6c 6c 20 62 65 20 76 61 6c 69 64 20 61 6e 64 20  ll be valid and 
cd60: 75 6e 63 68 61 6e 67 65 64 20 75 6e 74 69 6c 20  unchanged until 
cd70: 78 43 6c 6f 73 65 28 29 20 69 73 0a 2a 2a 20 63  xClose() is.** c
cd80: 61 6c 6c 65 64 2e 20 42 65 63 61 75 73 65 20 6f  alled. Because o
cd90: 66 20 74 68 65 20 70 72 65 76 69 6f 75 73 20 73  f the previous s
cda0: 65 6e 74 65 6e 63 65 2c 0a 2a 2a 20 74 68 65 20  entence,.** the 
cdb0: 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65 5d 20 63  [sqlite3_file] c
cdc0: 61 6e 20 73 61 66 65 6c 79 20 73 74 6f 72 65 20  an safely store 
cdd0: 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 74 68 65  a pointer to the
cde0: 0a 2a 2a 20 66 69 6c 65 6e 61 6d 65 20 69 66 20  .** filename if 
cdf0: 69 74 20 6e 65 65 64 73 20 74 6f 20 72 65 6d 65  it needs to reme
ce00: 6d 62 65 72 20 74 68 65 20 66 69 6c 65 6e 61 6d  mber the filenam
ce10: 65 20 66 6f 72 20 73 6f 6d 65 20 72 65 61 73 6f  e for some reaso
ce20: 6e 2e 0a 2a 2a 20 49 66 20 74 68 65 20 7a 46 69  n..** If the zFi
ce30: 6c 65 6e 61 6d 65 20 70 61 72 61 6d 65 74 65 72  lename parameter
ce40: 20 74 6f 20 78 4f 70 65 6e 20 69 73 20 61 20 4e   to xOpen is a N
ce50: 55 4c 4c 20 70 6f 69 6e 74 65 72 20 74 68 65 6e  ULL pointer then
ce60: 20 78 4f 70 65 6e 0a 2a 2a 20 6d 75 73 74 20 69   xOpen.** must i
ce70: 6e 76 65 6e 74 20 69 74 73 20 6f 77 6e 20 74 65  nvent its own te
ce80: 6d 70 6f 72 61 72 79 20 6e 61 6d 65 20 66 6f 72  mporary name for
ce90: 20 74 68 65 20 66 69 6c 65 2e 20 20 5e 57 68 65   the file.  ^Whe
cea0: 6e 65 76 65 72 20 74 68 65 20 0a 2a 2a 20 78 46  never the .** xF
ceb0: 69 6c 65 6e 61 6d 65 20 70 61 72 61 6d 65 74 65  ilename paramete
cec0: 72 20 69 73 20 4e 55 4c 4c 20 69 74 20 77 69 6c  r is NULL it wil
ced0: 6c 20 61 6c 73 6f 20 62 65 20 74 68 65 20 63 61  l also be the ca
cee0: 73 65 20 74 68 61 74 20 74 68 65 0a 2a 2a 20 66  se that the.** f
cef0: 6c 61 67 73 20 70 61 72 61 6d 65 74 65 72 20 77  lags parameter w
cf00: 69 6c 6c 20 69 6e 63 6c 75 64 65 20 5b 53 51 4c  ill include [SQL
cf10: 49 54 45 5f 4f 50 45 4e 5f 44 45 4c 45 54 45 4f  ITE_OPEN_DELETEO
cf20: 4e 43 4c 4f 53 45 5d 2e 0a 2a 2a 0a 2a 2a 20 54  NCLOSE]..**.** T
cf30: 68 65 20 66 6c 61 67 73 20 61 72 67 75 6d 65 6e  he flags argumen
cf40: 74 20 74 6f 20 78 4f 70 65 6e 28 29 20 69 6e 63  t to xOpen() inc
cf50: 6c 75 64 65 73 20 61 6c 6c 20 62 69 74 73 20 73  ludes all bits s
cf60: 65 74 20 69 6e 0a 2a 2a 20 74 68 65 20 66 6c 61  et in.** the fla
cf70: 67 73 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 5b  gs argument to [
cf80: 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28  sqlite3_open_v2(
cf90: 29 5d 2e 20 20 4f 72 20 69 66 20 5b 73 71 6c 69  )].  Or if [sqli
cfa0: 74 65 33 5f 6f 70 65 6e 28 29 5d 0a 2a 2a 20 6f  te3_open()].** o
cfb0: 72 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 31  r [sqlite3_open1
cfc0: 36 28 29 5d 20 69 73 20 75 73 65 64 2c 20 74 68  6()] is used, th
cfd0: 65 6e 20 66 6c 61 67 73 20 69 6e 63 6c 75 64 65  en flags include
cfe0: 73 20 61 74 20 6c 65 61 73 74 0a 2a 2a 20 5b 53  s at least.** [S
cff0: 51 4c 49 54 45 5f 4f 50 45 4e 5f 52 45 41 44 57  QLITE_OPEN_READW
d000: 52 49 54 45 5d 20 7c 20 5b 53 51 4c 49 54 45 5f  RITE] | [SQLITE_
d010: 4f 50 45 4e 5f 43 52 45 41 54 45 5d 2e 20 0a 2a  OPEN_CREATE]. .*
d020: 2a 20 49 66 20 78 4f 70 65 6e 28 29 20 6f 70 65  * If xOpen() ope
d030: 6e 73 20 61 20 66 69 6c 65 20 72 65 61 64 2d 6f  ns a file read-o
d040: 6e 6c 79 20 74 68 65 6e 20 69 74 20 73 65 74 73  nly then it sets
d050: 20 2a 70 4f 75 74 46 6c 61 67 73 20 74 6f 0a 2a   *pOutFlags to.*
d060: 2a 20 69 6e 63 6c 75 64 65 20 5b 53 51 4c 49 54  * include [SQLIT
d070: 45 5f 4f 50 45 4e 5f 52 45 41 44 4f 4e 4c 59 5d  E_OPEN_READONLY]
d080: 2e 20 20 4f 74 68 65 72 20 62 69 74 73 20 69 6e  .  Other bits in
d090: 20 2a 70 4f 75 74 46 6c 61 67 73 20 6d 61 79 20   *pOutFlags may 
d0a0: 62 65 20 73 65 74 2e 0a 2a 2a 0a 2a 2a 20 5e 28  be set..**.** ^(
d0b0: 53 51 4c 69 74 65 20 77 69 6c 6c 20 61 6c 73 6f  SQLite will also
d0c0: 20 61 64 64 20 6f 6e 65 20 6f 66 20 74 68 65 20   add one of the 
d0d0: 66 6f 6c 6c 6f 77 69 6e 67 20 66 6c 61 67 73 20  following flags 
d0e0: 74 6f 20 74 68 65 20 78 4f 70 65 6e 28 29 0a 2a  to the xOpen().*
d0f0: 2a 20 63 61 6c 6c 2c 20 64 65 70 65 6e 64 69 6e  * call, dependin
d100: 67 20 6f 6e 20 74 68 65 20 6f 62 6a 65 63 74 20  g on the object 
d110: 62 65 69 6e 67 20 6f 70 65 6e 65 64 3a 0a 2a 2a  being opened:.**
d120: 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a 20 3c 6c 69 3e  .** <ul>.** <li>
d130: 20 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 4d    [SQLITE_OPEN_M
d140: 41 49 4e 5f 44 42 5d 0a 2a 2a 20 3c 6c 69 3e 20  AIN_DB].** <li> 
d150: 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 4d 41   [SQLITE_OPEN_MA
d160: 49 4e 5f 4a 4f 55 52 4e 41 4c 5d 0a 2a 2a 20 3c  IN_JOURNAL].** <
d170: 6c 69 3e 20 20 5b 53 51 4c 49 54 45 5f 4f 50 45  li>  [SQLITE_OPE
d180: 4e 5f 54 45 4d 50 5f 44 42 5d 0a 2a 2a 20 3c 6c  N_TEMP_DB].** <l
d190: 69 3e 20 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e  i>  [SQLITE_OPEN
d1a0: 5f 54 45 4d 50 5f 4a 4f 55 52 4e 41 4c 5d 0a 2a  _TEMP_JOURNAL].*
d1b0: 2a 20 3c 6c 69 3e 20 20 5b 53 51 4c 49 54 45 5f  * <li>  [SQLITE_
d1c0: 4f 50 45 4e 5f 54 52 41 4e 53 49 45 4e 54 5f 44  OPEN_TRANSIENT_D
d1d0: 42 5d 0a 2a 2a 20 3c 6c 69 3e 20 20 5b 53 51 4c  B].** <li>  [SQL
d1e0: 49 54 45 5f 4f 50 45 4e 5f 53 55 42 4a 4f 55 52  ITE_OPEN_SUBJOUR
d1f0: 4e 41 4c 5d 0a 2a 2a 20 3c 6c 69 3e 20 20 5b 53  NAL].** <li>  [S
d200: 51 4c 49 54 45 5f 4f 50 45 4e 5f 4d 41 53 54 45  QLITE_OPEN_MASTE
d210: 52 5f 4a 4f 55 52 4e 41 4c 5d 0a 2a 2a 20 3c 6c  R_JOURNAL].** <l
d220: 69 3e 20 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e  i>  [SQLITE_OPEN
d230: 5f 57 41 4c 5d 0a 2a 2a 20 3c 2f 75 6c 3e 29 5e  _WAL].** </ul>)^
d240: 0a 2a 2a 0a 2a 2a 20 54 68 65 20 66 69 6c 65 20  .**.** The file 
d250: 49 2f 4f 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69  I/O implementati
d260: 6f 6e 20 63 61 6e 20 75 73 65 20 74 68 65 20 6f  on can use the o
d270: 62 6a 65 63 74 20 74 79 70 65 20 66 6c 61 67 73  bject type flags
d280: 20 74 6f 0a 2a 2a 20 63 68 61 6e 67 65 20 74 68   to.** change th
d290: 65 20 77 61 79 20 69 74 20 64 65 61 6c 73 20 77  e way it deals w
d2a0: 69 74 68 20 66 69 6c 65 73 2e 20 20 46 6f 72 20  ith files.  For 
d2b0: 65 78 61 6d 70 6c 65 2c 20 61 6e 20 61 70 70 6c  example, an appl
d2c0: 69 63 61 74 69 6f 6e 0a 2a 2a 20 74 68 61 74 20  ication.** that 
d2d0: 64 6f 65 73 20 6e 6f 74 20 63 61 72 65 20 61 62  does not care ab
d2e0: 6f 75 74 20 63 72 61 73 68 20 72 65 63 6f 76 65  out crash recove
d2f0: 72 79 20 6f 72 20 72 6f 6c 6c 62 61 63 6b 20 6d  ry or rollback m
d300: 69 67 68 74 20 6d 61 6b 65 0a 2a 2a 20 74 68 65  ight make.** the
d310: 20 6f 70 65 6e 20 6f 66 20 61 20 6a 6f 75 72 6e   open of a journ
d320: 61 6c 20 66 69 6c 65 20 61 20 6e 6f 2d 6f 70 2e  al file a no-op.
d330: 20 20 57 72 69 74 65 73 20 74 6f 20 74 68 69 73    Writes to this
d340: 20 6a 6f 75 72 6e 61 6c 20 77 6f 75 6c 64 0a 2a   journal would.*
d350: 2a 20 61 6c 73 6f 20 62 65 20 6e 6f 2d 6f 70 73  * also be no-ops
d360: 2c 20 61 6e 64 20 61 6e 79 20 61 74 74 65 6d 70  , and any attemp
d370: 74 20 74 6f 20 72 65 61 64 20 74 68 65 20 6a 6f  t to read the jo
d380: 75 72 6e 61 6c 20 77 6f 75 6c 64 20 72 65 74 75  urnal would retu
d390: 72 6e 0a 2a 2a 20 53 51 4c 49 54 45 5f 49 4f 45  rn.** SQLITE_IOE
d3a0: 52 52 2e 20 20 4f 72 20 74 68 65 20 69 6d 70 6c  RR.  Or the impl
d3b0: 65 6d 65 6e 74 61 74 69 6f 6e 20 6d 69 67 68 74  ementation might
d3c0: 20 72 65 63 6f 67 6e 69 7a 65 20 74 68 61 74 20   recognize that 
d3d0: 61 20 64 61 74 61 62 61 73 65 0a 2a 2a 20 66 69  a database.** fi
d3e0: 6c 65 20 77 69 6c 6c 20 62 65 20 64 6f 69 6e 67  le will be doing
d3f0: 20 70 61 67 65 2d 61 6c 69 67 6e 65 64 20 73 65   page-aligned se
d400: 63 74 6f 72 20 72 65 61 64 73 20 61 6e 64 20 77  ctor reads and w
d410: 72 69 74 65 73 20 69 6e 20 61 20 72 61 6e 64 6f  rites in a rando
d420: 6d 0a 2a 2a 20 6f 72 64 65 72 20 61 6e 64 20 73  m.** order and s
d430: 65 74 20 75 70 20 69 74 73 20 49 2f 4f 20 73 75  et up its I/O su
d440: 62 73 79 73 74 65 6d 20 61 63 63 6f 72 64 69 6e  bsystem accordin
d450: 67 6c 79 2e 0a 2a 2a 0a 2a 2a 20 53 51 4c 69 74  gly..**.** SQLit
d460: 65 20 6d 69 67 68 74 20 61 6c 73 6f 20 61 64 64  e might also add
d470: 20 6f 6e 65 20 6f 66 20 74 68 65 20 66 6f 6c 6c   one of the foll
d480: 6f 77 69 6e 67 20 66 6c 61 67 73 20 74 6f 20 74  owing flags to t
d490: 68 65 20 78 4f 70 65 6e 20 6d 65 74 68 6f 64 3a  he xOpen method:
d4a0: 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a 20 3c  .**.** <ul>.** <
d4b0: 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e  li> [SQLITE_OPEN
d4c0: 5f 44 45 4c 45 54 45 4f 4e 43 4c 4f 53 45 5d 0a  _DELETEONCLOSE].
d4d0: 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f  ** <li> [SQLITE_
d4e0: 4f 50 45 4e 5f 45 58 43 4c 55 53 49 56 45 5d 0a  OPEN_EXCLUSIVE].
d4f0: 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2a 0a 2a 2a 20 54  ** </ul>.**.** T
d500: 68 65 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  he [SQLITE_OPEN_
d510: 44 45 4c 45 54 45 4f 4e 43 4c 4f 53 45 5d 20 66  DELETEONCLOSE] f
d520: 6c 61 67 20 6d 65 61 6e 73 20 74 68 65 20 66 69  lag means the fi
d530: 6c 65 20 73 68 6f 75 6c 64 20 62 65 0a 2a 2a 20  le should be.** 
d540: 64 65 6c 65 74 65 64 20 77 68 65 6e 20 69 74 20  deleted when it 
d550: 69 73 20 63 6c 6f 73 65 64 2e 20 20 5e 54 68 65  is closed.  ^The
d560: 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 44 45   [SQLITE_OPEN_DE
d570: 4c 45 54 45 4f 4e 43 4c 4f 53 45 5d 0a 2a 2a 20  LETEONCLOSE].** 
d580: 77 69 6c 6c 20 62 65 20 73 65 74 20 66 6f 72 20  will be set for 
d590: 54 45 4d 50 20 64 61 74 61 62 61 73 65 73 20 61  TEMP databases a
d5a0: 6e 64 20 74 68 65 69 72 20 6a 6f 75 72 6e 61 6c  nd their journal
d5b0: 73 2c 20 74 72 61 6e 73 69 65 6e 74 0a 2a 2a 20  s, transient.** 
d5c0: 64 61 74 61 62 61 73 65 73 2c 20 61 6e 64 20 73  databases, and s
d5d0: 75 62 6a 6f 75 72 6e 61 6c 73 2e 0a 2a 2a 0a 2a  ubjournals..**.*
d5e0: 2a 20 5e 54 68 65 20 5b 53 51 4c 49 54 45 5f 4f  * ^The [SQLITE_O
d5f0: 50 45 4e 5f 45 58 43 4c 55 53 49 56 45 5d 20 66  PEN_EXCLUSIVE] f
d600: 6c 61 67 20 69 73 20 61 6c 77 61 79 73 20 75 73  lag is always us
d610: 65 64 20 69 6e 20 63 6f 6e 6a 75 6e 63 74 69 6f  ed in conjunctio
d620: 6e 0a 2a 2a 20 77 69 74 68 20 74 68 65 20 5b 53  n.** with the [S
d630: 51 4c 49 54 45 5f 4f 50 45 4e 5f 43 52 45 41 54  QLITE_OPEN_CREAT
d640: 45 5d 20 66 6c 61 67 2c 20 77 68 69 63 68 20 61  E] flag, which a
d650: 72 65 20 62 6f 74 68 20 64 69 72 65 63 74 6c 79  re both directly
d660: 0a 2a 2a 20 61 6e 61 6c 6f 67 6f 75 73 20 74 6f  .** analogous to
d670: 20 74 68 65 20 4f 5f 45 58 43 4c 20 61 6e 64 20   the O_EXCL and 
d680: 4f 5f 43 52 45 41 54 20 66 6c 61 67 73 20 6f 66  O_CREAT flags of
d690: 20 74 68 65 20 50 4f 53 49 58 20 6f 70 65 6e 28   the POSIX open(
d6a0: 29 0a 2a 2a 20 41 50 49 2e 20 20 54 68 65 20 53  ).** API.  The S
d6b0: 51 4c 49 54 45 5f 4f 50 45 4e 5f 45 58 43 4c 55  QLITE_OPEN_EXCLU
d6c0: 53 49 56 45 20 66 6c 61 67 2c 20 77 68 65 6e 20  SIVE flag, when 
d6d0: 70 61 69 72 65 64 20 77 69 74 68 20 74 68 65 20  paired with the 
d6e0: 0a 2a 2a 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  .** SQLITE_OPEN_
d6f0: 43 52 45 41 54 45 2c 20 69 73 20 75 73 65 64 20  CREATE, is used 
d700: 74 6f 20 69 6e 64 69 63 61 74 65 20 74 68 61 74  to indicate that
d710: 20 66 69 6c 65 20 73 68 6f 75 6c 64 20 61 6c 77   file should alw
d720: 61 79 73 0a 2a 2a 20 62 65 20 63 72 65 61 74 65  ays.** be create
d730: 64 2c 20 61 6e 64 20 74 68 61 74 20 69 74 20 69  d, and that it i
d740: 73 20 61 6e 20 65 72 72 6f 72 20 69 66 20 69 74  s an error if it
d750: 20 61 6c 72 65 61 64 79 20 65 78 69 73 74 73 2e   already exists.
d760: 0a 2a 2a 20 49 74 20 69 73 20 3c 69 3e 6e 6f 74  .** It is <i>not
d770: 3c 2f 69 3e 20 75 73 65 64 20 74 6f 20 69 6e 64  </i> used to ind
d780: 69 63 61 74 65 20 74 68 65 20 66 69 6c 65 20 73  icate the file s
d790: 68 6f 75 6c 64 20 62 65 20 6f 70 65 6e 65 64 20  hould be opened 
d7a0: 0a 2a 2a 20 66 6f 72 20 65 78 63 6c 75 73 69 76  .** for exclusiv
d7b0: 65 20 61 63 63 65 73 73 2e 0a 2a 2a 0a 2a 2a 20  e access..**.** 
d7c0: 5e 41 74 20 6c 65 61 73 74 20 73 7a 4f 73 46 69  ^At least szOsFi
d7d0: 6c 65 20 62 79 74 65 73 20 6f 66 20 6d 65 6d 6f  le bytes of memo
d7e0: 72 79 20 61 72 65 20 61 6c 6c 6f 63 61 74 65 64  ry are allocated
d7f0: 20 62 79 20 53 51 4c 69 74 65 0a 2a 2a 20 74 6f   by SQLite.** to
d800: 20 68 6f 6c 64 20 74 68 65 20 20 5b 73 71 6c 69   hold the  [sqli
d810: 74 65 33 5f 66 69 6c 65 5d 20 73 74 72 75 63 74  te3_file] struct
d820: 75 72 65 20 70 61 73 73 65 64 20 61 73 20 74 68  ure passed as th
d830: 65 20 74 68 69 72 64 0a 2a 2a 20 61 72 67 75 6d  e third.** argum
d840: 65 6e 74 20 74 6f 20 78 4f 70 65 6e 2e 20 20 54  ent to xOpen.  T
d850: 68 65 20 78 4f 70 65 6e 20 6d 65 74 68 6f 64 20  he xOpen method 
d860: 64 6f 65 73 20 6e 6f 74 20 68 61 76 65 20 74 6f  does not have to
d870: 0a 2a 2a 20 61 6c 6c 6f 63 61 74 65 20 74 68 65  .** allocate the
d880: 20 73 74 72 75 63 74 75 72 65 3b 20 69 74 20 73   structure; it s
d890: 68 6f 75 6c 64 20 6a 75 73 74 20 66 69 6c 6c 20  hould just fill 
d8a0: 69 74 20 69 6e 2e 20 20 4e 6f 74 65 20 74 68 61  it in.  Note tha
d8b0: 74 0a 2a 2a 20 74 68 65 20 78 4f 70 65 6e 20 6d  t.** the xOpen m
d8c0: 65 74 68 6f 64 20 6d 75 73 74 20 73 65 74 20 74  ethod must set t
d8d0: 68 65 20 73 71 6c 69 74 65 33 5f 66 69 6c 65 2e  he sqlite3_file.
d8e0: 70 4d 65 74 68 6f 64 73 20 74 6f 20 65 69 74 68  pMethods to eith
d8f0: 65 72 0a 2a 2a 20 61 20 76 61 6c 69 64 20 5b 73  er.** a valid [s
d900: 71 6c 69 74 65 33 5f 69 6f 5f 6d 65 74 68 6f 64  qlite3_io_method
d910: 73 5d 20 6f 62 6a 65 63 74 20 6f 72 20 74 6f 20  s] object or to 
d920: 4e 55 4c 4c 2e 20 20 78 4f 70 65 6e 20 6d 75 73  NULL.  xOpen mus
d930: 74 20 64 6f 0a 2a 2a 20 74 68 69 73 20 65 76 65  t do.** this eve
d940: 6e 20 69 66 20 74 68 65 20 6f 70 65 6e 20 66 61  n if the open fa
d950: 69 6c 73 2e 20 20 53 51 4c 69 74 65 20 65 78 70  ils.  SQLite exp
d960: 65 63 74 73 20 74 68 61 74 20 74 68 65 20 73 71  ects that the sq
d970: 6c 69 74 65 33 5f 66 69 6c 65 2e 70 4d 65 74 68  lite3_file.pMeth
d980: 6f 64 73 0a 2a 2a 20 65 6c 65 6d 65 6e 74 20 77  ods.** element w
d990: 69 6c 6c 20 62 65 20 76 61 6c 69 64 20 61 66 74  ill be valid aft
d9a0: 65 72 20 78 4f 70 65 6e 20 72 65 74 75 72 6e 73  er xOpen returns
d9b0: 20 72 65 67 61 72 64 6c 65 73 73 20 6f 66 20 74   regardless of t
d9c0: 68 65 20 73 75 63 63 65 73 73 0a 2a 2a 20 6f 72  he success.** or
d9d0: 20 66 61 69 6c 75 72 65 20 6f 66 20 74 68 65 20   failure of the 
d9e0: 78 4f 70 65 6e 20 63 61 6c 6c 2e 0a 2a 2a 0a 2a  xOpen call..**.*
d9f0: 2a 20 5b 5b 73 71 6c 69 74 65 33 5f 76 66 73 2e  * [[sqlite3_vfs.
da00: 78 41 63 63 65 73 73 5d 5d 0a 2a 2a 20 5e 54 68  xAccess]].** ^Th
da10: 65 20 66 6c 61 67 73 20 61 72 67 75 6d 65 6e 74  e flags argument
da20: 20 74 6f 20 78 41 63 63 65 73 73 28 29 20 6d 61   to xAccess() ma
da30: 79 20 62 65 20 5b 53 51 4c 49 54 45 5f 41 43 43  y be [SQLITE_ACC
da40: 45 53 53 5f 45 58 49 53 54 53 5d 0a 2a 2a 20 74  ESS_EXISTS].** t
da50: 6f 20 74 65 73 74 20 66 6f 72 20 74 68 65 20 65  o test for the e
da60: 78 69 73 74 65 6e 63 65 20 6f 66 20 61 20 66 69  xistence of a fi
da70: 6c 65 2c 20 6f 72 20 5b 53 51 4c 49 54 45 5f 41  le, or [SQLITE_A
da80: 43 43 45 53 53 5f 52 45 41 44 57 52 49 54 45 5d  CCESS_READWRITE]
da90: 20 74 6f 0a 2a 2a 20 74 65 73 74 20 77 68 65 74   to.** test whet
daa0: 68 65 72 20 61 20 66 69 6c 65 20 69 73 20 72 65  her a file is re
dab0: 61 64 61 62 6c 65 20 61 6e 64 20 77 72 69 74 61  adable and writa
dac0: 62 6c 65 2c 20 6f 72 20 5b 53 51 4c 49 54 45 5f  ble, or [SQLITE_
dad0: 41 43 43 45 53 53 5f 52 45 41 44 5d 0a 2a 2a 20  ACCESS_READ].** 
dae0: 74 6f 20 74 65 73 74 20 77 68 65 74 68 65 72 20  to test whether 
daf0: 61 20 66 69 6c 65 20 69 73 20 61 74 20 6c 65 61  a file is at lea
db00: 73 74 20 72 65 61 64 61 62 6c 65 2e 20 20 20 54  st readable.   T
db10: 68 65 20 66 69 6c 65 20 63 61 6e 20 62 65 20 61  he file can be a
db20: 0a 2a 2a 20 64 69 72 65 63 74 6f 72 79 2e 0a 2a  .** directory..*
db30: 2a 0a 2a 2a 20 5e 53 51 4c 69 74 65 20 77 69 6c  *.** ^SQLite wil
db40: 6c 20 61 6c 77 61 79 73 20 61 6c 6c 6f 63 61 74  l always allocat
db50: 65 20 61 74 20 6c 65 61 73 74 20 6d 78 50 61 74  e at least mxPat
db60: 68 6e 61 6d 65 2b 31 20 62 79 74 65 73 20 66 6f  hname+1 bytes fo
db70: 72 20 74 68 65 0a 2a 2a 20 6f 75 74 70 75 74 20  r the.** output 
db80: 62 75 66 66 65 72 20 78 46 75 6c 6c 50 61 74 68  buffer xFullPath
db90: 6e 61 6d 65 2e 20 20 54 68 65 20 65 78 61 63 74  name.  The exact
dba0: 20 73 69 7a 65 20 6f 66 20 74 68 65 20 6f 75 74   size of the out
dbb0: 70 75 74 20 62 75 66 66 65 72 0a 2a 2a 20 69 73  put buffer.** is
dbc0: 20 61 6c 73 6f 20 70 61 73 73 65 64 20 61 73 20   also passed as 
dbd0: 61 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 62  a parameter to b
dbe0: 6f 74 68 20 20 6d 65 74 68 6f 64 73 2e 20 49 66  oth  methods. If
dbf0: 20 74 68 65 20 6f 75 74 70 75 74 20 62 75 66 66   the output buff
dc00: 65 72 0a 2a 2a 20 69 73 20 6e 6f 74 20 6c 61 72  er.** is not lar
dc10: 67 65 20 65 6e 6f 75 67 68 2c 20 5b 53 51 4c 49  ge enough, [SQLI
dc20: 54 45 5f 43 41 4e 54 4f 50 45 4e 5d 20 73 68 6f  TE_CANTOPEN] sho
dc30: 75 6c 64 20 62 65 20 72 65 74 75 72 6e 65 64 2e  uld be returned.
dc40: 20 53 69 6e 63 65 20 74 68 69 73 20 69 73 0a 2a   Since this is.*
dc50: 2a 20 68 61 6e 64 6c 65 64 20 61 73 20 61 20 66  * handled as a f
dc60: 61 74 61 6c 20 65 72 72 6f 72 20 62 79 20 53 51  atal error by SQ
dc70: 4c 69 74 65 2c 20 76 66 73 20 69 6d 70 6c 65 6d  Lite, vfs implem
dc80: 65 6e 74 61 74 69 6f 6e 73 20 73 68 6f 75 6c 64  entations should
dc90: 20 65 6e 64 65 61 76 6f 72 0a 2a 2a 20 74 6f 20   endeavor.** to 
dca0: 70 72 65 76 65 6e 74 20 74 68 69 73 20 62 79 20  prevent this by 
dcb0: 73 65 74 74 69 6e 67 20 6d 78 50 61 74 68 6e 61  setting mxPathna
dcc0: 6d 65 20 74 6f 20 61 20 73 75 66 66 69 63 69 65  me to a sufficie
dcd0: 6e 74 6c 79 20 6c 61 72 67 65 20 76 61 6c 75 65  ntly large value
dce0: 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 78 52 61 6e  ..**.** The xRan
dcf0: 64 6f 6d 6e 65 73 73 28 29 2c 20 78 53 6c 65 65  domness(), xSlee
dd00: 70 28 29 2c 20 78 43 75 72 72 65 6e 74 54 69 6d  p(), xCurrentTim
dd10: 65 28 29 2c 20 61 6e 64 20 78 43 75 72 72 65 6e  e(), and xCurren
dd20: 74 54 69 6d 65 49 6e 74 36 34 28 29 0a 2a 2a 20  tTimeInt64().** 
dd30: 69 6e 74 65 72 66 61 63 65 73 20 61 72 65 20 6e  interfaces are n
dd40: 6f 74 20 73 74 72 69 63 74 6c 79 20 61 20 70 61  ot strictly a pa
dd50: 72 74 20 6f 66 20 74 68 65 20 66 69 6c 65 73 79  rt of the filesy
dd60: 73 74 65 6d 2c 20 62 75 74 20 74 68 65 79 20 61  stem, but they a
dd70: 72 65 0a 2a 2a 20 69 6e 63 6c 75 64 65 64 20 69  re.** included i
dd80: 6e 20 74 68 65 20 56 46 53 20 73 74 72 75 63 74  n the VFS struct
dd90: 75 72 65 20 66 6f 72 20 63 6f 6d 70 6c 65 74 65  ure for complete
dda0: 6e 65 73 73 2e 0a 2a 2a 20 54 68 65 20 78 52 61  ness..** The xRa
ddb0: 6e 64 6f 6d 6e 65 73 73 28 29 20 66 75 6e 63 74  ndomness() funct
ddc0: 69 6f 6e 20 61 74 74 65 6d 70 74 73 20 74 6f 20  ion attempts to 
ddd0: 72 65 74 75 72 6e 20 6e 42 79 74 65 73 20 62 79  return nBytes by
dde0: 74 65 73 0a 2a 2a 20 6f 66 20 67 6f 6f 64 2d 71  tes.** of good-q
ddf0: 75 61 6c 69 74 79 20 72 61 6e 64 6f 6d 6e 65 73  uality randomnes
de00: 73 20 69 6e 74 6f 20 7a 4f 75 74 2e 20 20 54 68  s into zOut.  Th
de10: 65 20 72 65 74 75 72 6e 20 76 61 6c 75 65 20 69  e return value i
de20: 73 0a 2a 2a 20 74 68 65 20 61 63 74 75 61 6c 20  s.** the actual 
de30: 6e 75 6d 62 65 72 20 6f 66 20 62 79 74 65 73 20  number of bytes 
de40: 6f 66 20 72 61 6e 64 6f 6d 6e 65 73 73 20 6f 62  of randomness ob
de50: 74 61 69 6e 65 64 2e 0a 2a 2a 20 54 68 65 20 78  tained..** The x
de60: 53 6c 65 65 70 28 29 20 6d 65 74 68 6f 64 20 63  Sleep() method c
de70: 61 75 73 65 73 20 74 68 65 20 63 61 6c 6c 69 6e  auses the callin
de80: 67 20 74 68 72 65 61 64 20 74 6f 20 73 6c 65 65  g thread to slee
de90: 70 20 66 6f 72 20 61 74 0a 2a 2a 20 6c 65 61 73  p for at.** leas
dea0: 74 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20  t the number of 
deb0: 6d 69 63 72 6f 73 65 63 6f 6e 64 73 20 67 69 76  microseconds giv
dec0: 65 6e 2e 20 20 5e 54 68 65 20 78 43 75 72 72 65  en.  ^The xCurre
ded0: 6e 74 54 69 6d 65 28 29 0a 2a 2a 20 6d 65 74 68  ntTime().** meth
dee0: 6f 64 20 72 65 74 75 72 6e 73 20 61 20 4a 75 6c  od returns a Jul
def0: 69 61 6e 20 44 61 79 20 4e 75 6d 62 65 72 20 66  ian Day Number f
df00: 6f 72 20 74 68 65 20 63 75 72 72 65 6e 74 20 64  or the current d
df10: 61 74 65 20 61 6e 64 20 74 69 6d 65 20 61 73 0a  ate and time as.
df20: 2a 2a 20 61 20 66 6c 6f 61 74 69 6e 67 20 70 6f  ** a floating po
df30: 69 6e 74 20 76 61 6c 75 65 2e 0a 2a 2a 20 5e 54  int value..** ^T
df40: 68 65 20 78 43 75 72 72 65 6e 74 54 69 6d 65 49  he xCurrentTimeI
df50: 6e 74 36 34 28 29 20 6d 65 74 68 6f 64 20 72 65  nt64() method re
df60: 74 75 72 6e 73 2c 20 61 73 20 61 6e 20 69 6e 74  turns, as an int
df70: 65 67 65 72 2c 20 74 68 65 20 4a 75 6c 69 61 6e  eger, the Julian
df80: 0a 2a 2a 20 44 61 79 20 4e 75 6d 62 65 72 20 6d  .** Day Number m
df90: 75 6c 74 69 70 6c 69 65 64 20 62 79 20 38 36 34  ultiplied by 864
dfa0: 30 30 30 30 30 20 28 74 68 65 20 6e 75 6d 62 65  00000 (the numbe
dfb0: 72 20 6f 66 20 6d 69 6c 6c 69 73 65 63 6f 6e 64  r of millisecond
dfc0: 73 20 69 6e 20 0a 2a 2a 20 61 20 32 34 2d 68 6f  s in .** a 24-ho
dfd0: 75 72 20 64 61 79 29 2e 20 20 0a 2a 2a 20 5e 53  ur day).  .** ^S
dfe0: 51 4c 69 74 65 20 77 69 6c 6c 20 75 73 65 20 74  QLite will use t
dff0: 68 65 20 78 43 75 72 72 65 6e 74 54 69 6d 65 49  he xCurrentTimeI
e000: 6e 74 36 34 28 29 20 6d 65 74 68 6f 64 20 74 6f  nt64() method to
e010: 20 67 65 74 20 74 68 65 20 63 75 72 72 65 6e 74   get the current
e020: 0a 2a 2a 20 64 61 74 65 20 61 6e 64 20 74 69 6d  .** date and tim
e030: 65 20 69 66 20 74 68 61 74 20 6d 65 74 68 6f 64  e if that method
e040: 20 69 73 20 61 76 61 69 6c 61 62 6c 65 20 28 69   is available (i
e050: 66 20 69 56 65 72 73 69 6f 6e 20 69 73 20 32 20  f iVersion is 2 
e060: 6f 72 20 0a 2a 2a 20 67 72 65 61 74 65 72 20 61  or .** greater a
e070: 6e 64 20 74 68 65 20 66 75 6e 63 74 69 6f 6e 20  nd the function 
e080: 70 6f 69 6e 74 65 72 20 69 73 20 6e 6f 74 20 4e  pointer is not N
e090: 55 4c 4c 29 20 61 6e 64 20 77 69 6c 6c 20 66 61  ULL) and will fa
e0a0: 6c 6c 20 62 61 63 6b 0a 2a 2a 20 74 6f 20 78 43  ll back.** to xC
e0b0: 75 72 72 65 6e 74 54 69 6d 65 28 29 20 69 66 20  urrentTime() if 
e0c0: 78 43 75 72 72 65 6e 74 54 69 6d 65 49 6e 74 36  xCurrentTimeInt6
e0d0: 34 28 29 20 69 73 20 75 6e 61 76 61 69 6c 61 62  4() is unavailab
e0e0: 6c 65 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 78  le..**.** ^The x
e0f0: 53 65 74 53 79 73 74 65 6d 43 61 6c 6c 28 29 2c  SetSystemCall(),
e100: 20 78 47 65 74 53 79 73 74 65 6d 43 61 6c 6c 28   xGetSystemCall(
e110: 29 2c 20 61 6e 64 20 78 4e 65 73 74 53 79 73 74  ), and xNestSyst
e120: 65 6d 43 61 6c 6c 28 29 20 69 6e 74 65 72 66 61  emCall() interfa
e130: 63 65 73 0a 2a 2a 20 61 72 65 20 6e 6f 74 20 75  ces.** are not u
e140: 73 65 64 20 62 79 20 74 68 65 20 53 51 4c 69 74  sed by the SQLit
e150: 65 20 63 6f 72 65 2e 20 20 54 68 65 73 65 20 6f  e core.  These o
e160: 70 74 69 6f 6e 61 6c 20 69 6e 74 65 72 66 61 63  ptional interfac
e170: 65 73 20 61 72 65 20 70 72 6f 76 69 64 65 64 0a  es are provided.
e180: 2a 2a 20 62 79 20 73 6f 6d 65 20 56 46 53 65 73  ** by some VFSes
e190: 20 74 6f 20 66 61 63 69 6c 69 74 61 74 65 20 74   to facilitate t
e1a0: 65 73 74 69 6e 67 20 6f 66 20 74 68 65 20 56 46  esting of the VF
e1b0: 53 20 63 6f 64 65 2e 20 42 79 20 6f 76 65 72 72  S code. By overr
e1c0: 69 64 69 6e 67 20 0a 2a 2a 20 73 79 73 74 65 6d  iding .** system
e1d0: 20 63 61 6c 6c 73 20 77 69 74 68 20 66 75 6e 63   calls with func
e1e0: 74 69 6f 6e 73 20 75 6e 64 65 72 20 69 74 73 20  tions under its 
e1f0: 63 6f 6e 74 72 6f 6c 2c 20 61 20 74 65 73 74 20  control, a test 
e200: 70 72 6f 67 72 61 6d 20 63 61 6e 0a 2a 2a 20 73  program can.** s
e210: 69 6d 75 6c 61 74 65 20 66 61 75 6c 74 73 20 61  imulate faults a
e220: 6e 64 20 65 72 72 6f 72 20 63 6f 6e 64 69 74 69  nd error conditi
e230: 6f 6e 73 20 74 68 61 74 20 77 6f 75 6c 64 20 6f  ons that would o
e240: 74 68 65 72 77 69 73 65 20 62 65 20 64 69 66 66  therwise be diff
e250: 69 63 75 6c 74 0a 2a 2a 20 6f 72 20 69 6d 70 6f  icult.** or impo
e260: 73 73 69 62 6c 65 20 74 6f 20 69 6e 64 75 63 65  ssible to induce
e270: 2e 20 20 54 68 65 20 73 65 74 20 6f 66 20 73 79  .  The set of sy
e280: 73 74 65 6d 20 63 61 6c 6c 73 20 74 68 61 74 20  stem calls that 
e290: 63 61 6e 20 62 65 20 6f 76 65 72 72 69 64 64 65  can be overridde
e2a0: 6e 0a 2a 2a 20 76 61 72 69 65 73 20 66 72 6f 6d  n.** varies from
e2b0: 20 6f 6e 65 20 56 46 53 20 74 6f 20 61 6e 6f 74   one VFS to anot
e2c0: 68 65 72 2c 20 61 6e 64 20 66 72 6f 6d 20 6f 6e  her, and from on
e2d0: 65 20 76 65 72 73 69 6f 6e 20 6f 66 20 74 68 65  e version of the
e2e0: 20 73 61 6d 65 20 56 46 53 20 74 6f 20 74 68 65   same VFS to the
e2f0: 0a 2a 2a 20 6e 65 78 74 2e 20 20 41 70 70 6c 69  .** next.  Appli
e300: 63 61 74 69 6f 6e 73 20 74 68 61 74 20 75 73 65  cations that use
e310: 20 74 68 65 73 65 20 69 6e 74 65 72 66 61 63 65   these interface
e320: 73 20 6d 75 73 74 20 62 65 20 70 72 65 70 61 72  s must be prepar
e330: 65 64 20 66 6f 72 20 61 6e 79 0a 2a 2a 20 6f 72  ed for any.** or
e340: 20 61 6c 6c 20 6f 66 20 74 68 65 73 65 20 69 6e   all of these in
e350: 74 65 72 66 61 63 65 73 20 74 6f 20 62 65 20 4e  terfaces to be N
e360: 55 4c 4c 20 6f 72 20 66 6f 72 20 74 68 65 69 72  ULL or for their
e370: 20 62 65 68 61 76 69 6f 72 20 74 6f 20 63 68 61   behavior to cha
e380: 6e 67 65 0a 2a 2a 20 66 72 6f 6d 20 6f 6e 65 20  nge.** from one 
e390: 72 65 6c 65 61 73 65 20 74 6f 20 74 68 65 20 6e  release to the n
e3a0: 65 78 74 2e 20 20 41 70 70 6c 69 63 61 74 69 6f  ext.  Applicatio
e3b0: 6e 73 20 6d 75 73 74 20 6e 6f 74 20 61 74 74 65  ns must not atte
e3c0: 6d 70 74 20 74 6f 20 61 63 63 65 73 73 0a 2a 2a  mpt to access.**
e3d0: 20 61 6e 79 20 6f 66 20 74 68 65 73 65 20 6d 65   any of these me
e3e0: 74 68 6f 64 73 20 69 66 20 74 68 65 20 69 56 65  thods if the iVe
e3f0: 72 73 69 6f 6e 20 6f 66 20 74 68 65 20 56 46 53  rsion of the VFS
e400: 20 69 73 20 6c 65 73 73 20 74 68 61 6e 20 33 2e   is less than 3.
e410: 0a 2a 2f 0a 74 79 70 65 64 65 66 20 73 74 72 75  .*/.typedef stru
e420: 63 74 20 73 71 6c 69 74 65 33 5f 76 66 73 20 73  ct sqlite3_vfs s
e430: 71 6c 69 74 65 33 5f 76 66 73 3b 0a 74 79 70 65  qlite3_vfs;.type
e440: 64 65 66 20 76 6f 69 64 20 28 2a 73 71 6c 69 74  def void (*sqlit
e450: 65 33 5f 73 79 73 63 61 6c 6c 5f 70 74 72 29 28  e3_syscall_ptr)(
e460: 76 6f 69 64 29 3b 0a 73 74 72 75 63 74 20 73 71  void);.struct sq
e470: 6c 69 74 65 33 5f 76 66 73 20 7b 0a 20 20 69 6e  lite3_vfs {.  in
e480: 74 20 69 56 65 72 73 69 6f 6e 3b 20 20 20 20 20  t iVersion;     
e490: 20 20 20 20 20 20 20 2f 2a 20 53 74 72 75 63 74         /* Struct
e4a0: 75 72 65 20 76 65 72 73 69 6f 6e 20 6e 75 6d 62  ure version numb
e4b0: 65 72 20 28 63 75 72 72 65 6e 74 6c 79 20 33 29  er (currently 3)
e4c0: 20 2a 2f 0a 20 20 69 6e 74 20 73 7a 4f 73 46 69   */.  int szOsFi
e4d0: 6c 65 3b 20 20 20 20 20 20 20 20 20 20 20 20 2f  le;            /
e4e0: 2a 20 53 69 7a 65 20 6f 66 20 73 75 62 63 6c 61  * Size of subcla
e4f0: 73 73 65 64 20 73 71 6c 69 74 65 33 5f 66 69 6c  ssed sqlite3_fil
e500: 65 20 2a 2f 0a 20 20 69 6e 74 20 6d 78 50 61 74  e */.  int mxPat
e510: 68 6e 61 6d 65 3b 20 20 20 20 20 20 20 20 20 20  hname;          
e520: 2f 2a 20 4d 61 78 69 6d 75 6d 20 66 69 6c 65 20  /* Maximum file 
e530: 70 61 74 68 6e 61 6d 65 20 6c 65 6e 67 74 68 20  pathname length 
e540: 2a 2f 0a 20 20 73 71 6c 69 74 65 33 5f 76 66 73  */.  sqlite3_vfs
e550: 20 2a 70 4e 65 78 74 3b 20 20 20 20 20 20 2f 2a   *pNext;      /*
e560: 20 4e 65 78 74 20 72 65 67 69 73 74 65 72 65 64   Next registered
e570: 20 56 46 53 20 2a 2f 0a 20 20 63 6f 6e 73 74 20   VFS */.  const 
e580: 63 68 61 72 20 2a 7a 4e 61 6d 65 3b 20 20 20 20  char *zName;    
e590: 20 20 20 2f 2a 20 4e 61 6d 65 20 6f 66 20 74 68     /* Name of th
e5a0: 69 73 20 76 69 72 74 75 61 6c 20 66 69 6c 65 20  is virtual file 
e5b0: 73 79 73 74 65 6d 20 2a 2f 0a 20 20 76 6f 69 64  system */.  void
e5c0: 20 2a 70 41 70 70 44 61 74 61 3b 20 20 20 20 20   *pAppData;     
e5d0: 20 20 20 20 20 2f 2a 20 50 6f 69 6e 74 65 72 20       /* Pointer 
e5e0: 74 6f 20 61 70 70 6c 69 63 61 74 69 6f 6e 2d 73  to application-s
e5f0: 70 65 63 69 66 69 63 20 64 61 74 61 20 2a 2f 0a  pecific data */.
e600: 20 20 69 6e 74 20 28 2a 78 4f 70 65 6e 29 28 73    int (*xOpen)(s
e610: 71 6c 69 74 65 33 5f 76 66 73 2a 2c 20 63 6f 6e  qlite3_vfs*, con
e620: 73 74 20 63 68 61 72 20 2a 7a 4e 61 6d 65 2c 20  st char *zName, 
e630: 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 0a 20  sqlite3_file*,. 
e640: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 69 6e                in
e650: 74 20 66 6c 61 67 73 2c 20 69 6e 74 20 2a 70 4f  t flags, int *pO
e660: 75 74 46 6c 61 67 73 29 3b 0a 20 20 69 6e 74 20  utFlags);.  int 
e670: 28 2a 78 44 65 6c 65 74 65 29 28 73 71 6c 69 74  (*xDelete)(sqlit
e680: 65 33 5f 76 66 73 2a 2c 20 63 6f 6e 73 74 20 63  e3_vfs*, const c
e690: 68 61 72 20 2a 7a 4e 61 6d 65 2c 20 69 6e 74 20  har *zName, int 
e6a0: 73 79 6e 63 44 69 72 29 3b 0a 20 20 69 6e 74 20  syncDir);.  int 
e6b0: 28 2a 78 41 63 63 65 73 73 29 28 73 71 6c 69 74  (*xAccess)(sqlit
e6c0: 65 33 5f 76 66 73 2a 2c 20 63 6f 6e 73 74 20 63  e3_vfs*, const c
e6d0: 68 61 72 20 2a 7a 4e 61 6d 65 2c 20 69 6e 74 20  har *zName, int 
e6e0: 66 6c 61 67 73 2c 20 69 6e 74 20 2a 70 52 65 73  flags, int *pRes
e6f0: 4f 75 74 29 3b 0a 20 20 69 6e 74 20 28 2a 78 46  Out);.  int (*xF
e700: 75 6c 6c 50 61 74 68 6e 61 6d 65 29 28 73 71 6c  ullPathname)(sql
e710: 69 74 65 33 5f 76 66 73 2a 2c 20 63 6f 6e 73 74  ite3_vfs*, const
e720: 20 63 68 61 72 20 2a 7a 4e 61 6d 65 2c 20 69 6e   char *zName, in
e730: 74 20 6e 4f 75 74 2c 20 63 68 61 72 20 2a 7a 4f  t nOut, char *zO
e740: 75 74 29 3b 0a 20 20 76 6f 69 64 20 2a 28 2a 78  ut);.  void *(*x
e750: 44 6c 4f 70 65 6e 29 28 73 71 6c 69 74 65 33 5f  DlOpen)(sqlite3_
e760: 76 66 73 2a 2c 20 63 6f 6e 73 74 20 63 68 61 72  vfs*, const char
e770: 20 2a 7a 46 69 6c 65 6e 61 6d 65 29 3b 0a 20 20   *zFilename);.  
e780: 76 6f 69 64 20 28 2a 78 44 6c 45 72 72 6f 72 29  void (*xDlError)
e790: 28 73 71 6c 69 74 65 33 5f 76 66 73 2a 2c 20 69  (sqlite3_vfs*, i
e7a0: 6e 74 20 6e 42 79 74 65 2c 20 63 68 61 72 20 2a  nt nByte, char *
e7b0: 7a 45 72 72 4d 73 67 29 3b 0a 20 20 76 6f 69 64  zErrMsg);.  void
e7c0: 20 28 2a 28 2a 78 44 6c 53 79 6d 29 28 73 71 6c   (*(*xDlSym)(sql
e7d0: 69 74 65 33 5f 76 66 73 2a 2c 76 6f 69 64 2a 2c  ite3_vfs*,void*,
e7e0: 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 53 79   const char *zSy
e7f0: 6d 62 6f 6c 29 29 28 76 6f 69 64 29 3b 0a 20 20  mbol))(void);.  
e800: 76 6f 69 64 20 28 2a 78 44 6c 43 6c 6f 73 65 29  void (*xDlClose)
e810: 28 73 71 6c 69 74 65 33 5f 76 66 73 2a 2c 20 76  (sqlite3_vfs*, v
e820: 6f 69 64 2a 29 3b 0a 20 20 69 6e 74 20 28 2a 78  oid*);.  int (*x
e830: 52 61 6e 64 6f 6d 6e 65 73 73 29 28 73 71 6c 69  Randomness)(sqli
e840: 74 65 33 5f 76 66 73 2a 2c 20 69 6e 74 20 6e 42  te3_vfs*, int nB
e850: 79 74 65 2c 20 63 68 61 72 20 2a 7a 4f 75 74 29  yte, char *zOut)
e860: 3b 0a 20 20 69 6e 74 20 28 2a 78 53 6c 65 65 70  ;.  int (*xSleep
e870: 29 28 73 71 6c 69 74 65 33 5f 76 66 73 2a 2c 20  )(sqlite3_vfs*, 
e880: 69 6e 74 20 6d 69 63 72 6f 73 65 63 6f 6e 64 73  int microseconds
e890: 29 3b 0a 20 20 69 6e 74 20 28 2a 78 43 75 72 72  );.  int (*xCurr
e8a0: 65 6e 74 54 69 6d 65 29 28 73 71 6c 69 74 65 33  entTime)(sqlite3
e8b0: 5f 76 66 73 2a 2c 20 64 6f 75 62 6c 65 2a 29 3b  _vfs*, double*);
e8c0: 0a 20 20 69 6e 74 20 28 2a 78 47 65 74 4c 61 73  .  int (*xGetLas
e8d0: 74 45 72 72 6f 72 29 28 73 71 6c 69 74 65 33 5f  tError)(sqlite3_
e8e0: 76 66 73 2a 2c 20 69 6e 74 2c 20 63 68 61 72 20  vfs*, int, char 
e8f0: 2a 29 3b 0a 20 20 2f 2a 0a 20 20 2a 2a 20 54 68  *);.  /*.  ** Th
e900: 65 20 6d 65 74 68 6f 64 73 20 61 62 6f 76 65 20  e methods above 
e910: 61 72 65 20 69 6e 20 76 65 72 73 69 6f 6e 20 31  are in version 1
e920: 20 6f 66 20 74 68 65 20 73 71 6c 69 74 65 5f 76   of the sqlite_v
e930: 66 73 20 6f 62 6a 65 63 74 0a 20 20 2a 2a 20 64  fs object.  ** d
e940: 65 66 69 6e 69 74 69 6f 6e 2e 20 20 54 68 6f 73  efinition.  Thos
e950: 65 20 74 68 61 74 20 66 6f 6c 6c 6f 77 20 61 72  e that follow ar
e960: 65 20 61 64 64 65 64 20 69 6e 20 76 65 72 73 69  e added in versi
e970: 6f 6e 20 32 20 6f 72 20 6c 61 74 65 72 0a 20 20  on 2 or later.  
e980: 2a 2f 0a 20 20 69 6e 74 20 28 2a 78 43 75 72 72  */.  int (*xCurr
e990: 65 6e 74 54 69 6d 65 49 6e 74 36 34 29 28 73 71  entTimeInt64)(sq
e9a0: 6c 69 74 65 33 5f 76 66 73 2a 2c 20 73 71 6c 69  lite3_vfs*, sqli
e9b0: 74 65 33 5f 69 6e 74 36 34 2a 29 3b 0a 20 20 2f  te3_int64*);.  /
e9c0: 2a 0a 20 20 2a 2a 20 54 68 65 20 6d 65 74 68 6f  *.  ** The metho
e9d0: 64 73 20 61 62 6f 76 65 20 61 72 65 20 69 6e 20  ds above are in 
e9e0: 76 65 72 73 69 6f 6e 73 20 31 20 61 6e 64 20 32  versions 1 and 2
e9f0: 20 6f 66 20 74 68 65 20 73 71 6c 69 74 65 5f 76   of the sqlite_v
ea00: 66 73 20 6f 62 6a 65 63 74 2e 0a 20 20 2a 2a 20  fs object..  ** 
ea10: 54 68 6f 73 65 20 62 65 6c 6f 77 20 61 72 65 20  Those below are 
ea20: 66 6f 72 20 76 65 72 73 69 6f 6e 20 33 20 61 6e  for version 3 an
ea30: 64 20 67 72 65 61 74 65 72 2e 0a 20 20 2a 2f 0a  d greater..  */.
ea40: 20 20 69 6e 74 20 28 2a 78 53 65 74 53 79 73 74    int (*xSetSyst
ea50: 65 6d 43 61 6c 6c 29 28 73 71 6c 69 74 65 33 5f  emCall)(sqlite3_
ea60: 76 66 73 2a 2c 20 63 6f 6e 73 74 20 63 68 61 72  vfs*, const char
ea70: 20 2a 7a 4e 61 6d 65 2c 20 73 71 6c 69 74 65 33   *zName, sqlite3
ea80: 5f 73 79 73 63 61 6c 6c 5f 70 74 72 29 3b 0a 20  _syscall_ptr);. 
ea90: 20 73 71 6c 69 74 65 33 5f 73 79 73 63 61 6c 6c   sqlite3_syscall
eaa0: 5f 70 74 72 20 28 2a 78 47 65 74 53 79 73 74 65  _ptr (*xGetSyste
eab0: 6d 43 61 6c 6c 29 28 73 71 6c 69 74 65 33 5f 76  mCall)(sqlite3_v
eac0: 66 73 2a 2c 20 63 6f 6e 73 74 20 63 68 61 72 20  fs*, const char 
ead0: 2a 7a 4e 61 6d 65 29 3b 0a 20 20 63 6f 6e 73 74  *zName);.  const
eae0: 20 63 68 61 72 20 2a 28 2a 78 4e 65 78 74 53 79   char *(*xNextSy
eaf0: 73 74 65 6d 43 61 6c 6c 29 28 73 71 6c 69 74 65  stemCall)(sqlite
eb00: 33 5f 76 66 73 2a 2c 20 63 6f 6e 73 74 20 63 68  3_vfs*, const ch
eb10: 61 72 20 2a 7a 4e 61 6d 65 29 3b 0a 20 20 2f 2a  ar *zName);.  /*
eb20: 0a 20 20 2a 2a 20 54 68 65 20 6d 65 74 68 6f 64  .  ** The method
eb30: 73 20 61 62 6f 76 65 20 61 72 65 20 69 6e 20 76  s above are in v
eb40: 65 72 73 69 6f 6e 73 20 31 20 74 68 72 6f 75 67  ersions 1 throug
eb50: 68 20 33 20 6f 66 20 74 68 65 20 73 71 6c 69 74  h 3 of the sqlit
eb60: 65 5f 76 66 73 20 6f 62 6a 65 63 74 2e 0a 20 20  e_vfs object..  
eb70: 2a 2a 20 4e 65 77 20 66 69 65 6c 64 73 20 6d 61  ** New fields ma
eb80: 79 20 62 65 20 61 70 70 65 6e 64 65 64 20 69 6e  y be appended in
eb90: 20 66 75 74 75 72 65 20 76 65 72 73 69 6f 6e 73   future versions
eba0: 2e 20 20 54 68 65 20 69 56 65 72 73 69 6f 6e 0a  .  The iVersion.
ebb0: 20 20 2a 2a 20 76 61 6c 75 65 20 77 69 6c 6c 20    ** value will 
ebc0: 69 6e 63 72 65 6d 65 6e 74 20 77 68 65 6e 65 76  increment whenev
ebd0: 65 72 20 74 68 69 73 20 68 61 70 70 65 6e 73 2e  er this happens.
ebe0: 20 0a 20 20 2a 2f 0a 7d 3b 0a 0a 2f 2a 0a 2a 2a   .  */.};../*.**
ebf0: 20 43 41 50 49 33 52 45 46 3a 20 46 6c 61 67 73   CAPI3REF: Flags
ec00: 20 66 6f 72 20 74 68 65 20 78 41 63 63 65 73 73   for the xAccess
ec10: 20 56 46 53 20 6d 65 74 68 6f 64 0a 2a 2a 0a 2a   VFS method.**.*
ec20: 2a 20 54 68 65 73 65 20 69 6e 74 65 67 65 72 20  * These integer 
ec30: 63 6f 6e 73 74 61 6e 74 73 20 63 61 6e 20 62 65  constants can be
ec40: 20 75 73 65 64 20 61 73 20 74 68 65 20 74 68 69   used as the thi
ec50: 72 64 20 70 61 72 61 6d 65 74 65 72 20 74 6f 0a  rd parameter to.
ec60: 2a 2a 20 74 68 65 20 78 41 63 63 65 73 73 20 6d  ** the xAccess m
ec70: 65 74 68 6f 64 20 6f 66 20 61 6e 20 5b 73 71 6c  ethod of an [sql
ec80: 69 74 65 33 5f 76 66 73 5d 20 6f 62 6a 65 63 74  ite3_vfs] object
ec90: 2e 20 20 54 68 65 79 20 64 65 74 65 72 6d 69 6e  .  They determin
eca0: 65 0a 2a 2a 20 77 68 61 74 20 6b 69 6e 64 20 6f  e.** what kind o
ecb0: 66 20 70 65 72 6d 69 73 73 69 6f 6e 73 20 74 68  f permissions th
ecc0: 65 20 78 41 63 63 65 73 73 20 6d 65 74 68 6f 64  e xAccess method
ecd0: 20 69 73 20 6c 6f 6f 6b 69 6e 67 20 66 6f 72 2e   is looking for.
ece0: 0a 2a 2a 20 57 69 74 68 20 53 51 4c 49 54 45 5f  .** With SQLITE_
ecf0: 41 43 43 45 53 53 5f 45 58 49 53 54 53 2c 20 74  ACCESS_EXISTS, t
ed00: 68 65 20 78 41 63 63 65 73 73 20 6d 65 74 68 6f  he xAccess metho
ed10: 64 0a 2a 2a 20 73 69 6d 70 6c 79 20 63 68 65 63  d.** simply chec
ed20: 6b 73 20 77 68 65 74 68 65 72 20 74 68 65 20 66  ks whether the f
ed30: 69 6c 65 20 65 78 69 73 74 73 2e 0a 2a 2a 20 57  ile exists..** W
ed40: 69 74 68 20 53 51 4c 49 54 45 5f 41 43 43 45 53  ith SQLITE_ACCES
ed50: 53 5f 52 45 41 44 57 52 49 54 45 2c 20 74 68 65  S_READWRITE, the
ed60: 20 78 41 63 63 65 73 73 20 6d 65 74 68 6f 64 0a   xAccess method.
ed70: 2a 2a 20 63 68 65 63 6b 73 20 77 68 65 74 68 65  ** checks whethe
ed80: 72 20 74 68 65 20 6e 61 6d 65 64 20 64 69 72 65  r the named dire
ed90: 63 74 6f 72 79 20 69 73 20 62 6f 74 68 20 72 65  ctory is both re
eda0: 61 64 61 62 6c 65 20 61 6e 64 20 77 72 69 74 61  adable and writa
edb0: 62 6c 65 0a 2a 2a 20 28 69 6e 20 6f 74 68 65 72  ble.** (in other
edc0: 20 77 6f 72 64 73 2c 20 69 66 20 66 69 6c 65 73   words, if files
edd0: 20 63 61 6e 20 62 65 20 61 64 64 65 64 2c 20 72   can be added, r
ede0: 65 6d 6f 76 65 64 2c 20 61 6e 64 20 72 65 6e 61  emoved, and rena
edf0: 6d 65 64 20 77 69 74 68 69 6e 0a 2a 2a 20 74 68  med within.** th
ee00: 65 20 64 69 72 65 63 74 6f 72 79 29 2e 0a 2a 2a  e directory)..**
ee10: 20 54 68 65 20 53 51 4c 49 54 45 5f 41 43 43 45   The SQLITE_ACCE
ee20: 53 53 5f 52 45 41 44 57 52 49 54 45 20 63 6f 6e  SS_READWRITE con
ee30: 73 74 61 6e 74 20 69 73 20 63 75 72 72 65 6e 74  stant is current
ee40: 6c 79 20 75 73 65 64 20 6f 6e 6c 79 20 62 79 20  ly used only by 
ee50: 74 68 65 0a 2a 2a 20 5b 74 65 6d 70 5f 73 74 6f  the.** [temp_sto
ee60: 72 65 5f 64 69 72 65 63 74 6f 72 79 20 70 72 61  re_directory pra
ee70: 67 6d 61 5d 2c 20 74 68 6f 75 67 68 20 74 68 69  gma], though thi
ee80: 73 20 63 6f 75 6c 64 20 63 68 61 6e 67 65 20 69  s could change i
ee90: 6e 20 61 20 66 75 74 75 72 65 0a 2a 2a 20 72 65  n a future.** re
eea0: 6c 65 61 73 65 20 6f 66 20 53 51 4c 69 74 65 2e  lease of SQLite.
eeb0: 0a 2a 2a 20 57 69 74 68 20 53 51 4c 49 54 45 5f  .** With SQLITE_
eec0: 41 43 43 45 53 53 5f 52 45 41 44 2c 20 74 68 65  ACCESS_READ, the
eed0: 20 78 41 63 63 65 73 73 20 6d 65 74 68 6f 64 0a   xAccess method.
eee0: 2a 2a 20 63 68 65 63 6b 73 20 77 68 65 74 68 65  ** checks whethe
eef0: 72 20 74 68 65 20 66 69 6c 65 20 69 73 20 72 65  r the file is re
ef00: 61 64 61 62 6c 65 2e 20 20 54 68 65 20 53 51 4c  adable.  The SQL
ef10: 49 54 45 5f 41 43 43 45 53 53 5f 52 45 41 44 20  ITE_ACCESS_READ 
ef20: 63 6f 6e 73 74 61 6e 74 20 69 73 0a 2a 2a 20 63  constant is.** c
ef30: 75 72 72 65 6e 74 6c 79 20 75 6e 75 73 65 64 2c  urrently unused,
ef40: 20 74 68 6f 75 67 68 20 69 74 20 6d 69 67 68 74   though it might
ef50: 20 62 65 20 75 73 65 64 20 69 6e 20 61 20 66 75   be used in a fu
ef60: 74 75 72 65 20 72 65 6c 65 61 73 65 20 6f 66 0a  ture release of.
ef70: 2a 2a 20 53 51 4c 69 74 65 2e 0a 2a 2f 0a 23 64  ** SQLite..*/.#d
ef80: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 41 43 43  efine SQLITE_ACC
ef90: 45 53 53 5f 45 58 49 53 54 53 20 20 20 20 30 0a  ESS_EXISTS    0.
efa0: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 41  #define SQLITE_A
efb0: 43 43 45 53 53 5f 52 45 41 44 57 52 49 54 45 20  CCESS_READWRITE 
efc0: 31 20 20 20 2f 2a 20 55 73 65 64 20 62 79 20 50  1   /* Used by P
efd0: 52 41 47 4d 41 20 74 65 6d 70 5f 73 74 6f 72 65  RAGMA temp_store
efe0: 5f 64 69 72 65 63 74 6f 72 79 20 2a 2f 0a 23 64  _directory */.#d
eff0: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 41 43 43  efine SQLITE_ACC
f000: 45 53 53 5f 52 45 41 44 20 20 20 20 20 20 32 20  ESS_READ      2 
f010: 20 20 2f 2a 20 55 6e 75 73 65 64 20 2a 2f 0a 0a    /* Unused */..
f020: 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20  /*.** CAPI3REF: 
f030: 46 6c 61 67 73 20 66 6f 72 20 74 68 65 20 78 53  Flags for the xS
f040: 68 6d 4c 6f 63 6b 20 56 46 53 20 6d 65 74 68 6f  hmLock VFS metho
f050: 64 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 69 6e  d.**.** These in
f060: 74 65 67 65 72 20 63 6f 6e 73 74 61 6e 74 73 20  teger constants 
f070: 64 65 66 69 6e 65 20 74 68 65 20 76 61 72 69 6f  define the vario
f080: 75 73 20 6c 6f 63 6b 69 6e 67 20 6f 70 65 72 61  us locking opera
f090: 74 69 6f 6e 73 0a 2a 2a 20 61 6c 6c 6f 77 65 64  tions.** allowed
f0a0: 20 62 79 20 74 68 65 20 78 53 68 6d 4c 6f 63 6b   by the xShmLock
f0b0: 20 6d 65 74 68 6f 64 20 6f 66 20 5b 73 71 6c 69   method of [sqli
f0c0: 74 65 33 5f 69 6f 5f 6d 65 74 68 6f 64 73 5d 2e  te3_io_methods].
f0d0: 20 20 54 68 65 0a 2a 2a 20 66 6f 6c 6c 6f 77 69    The.** followi
f0e0: 6e 67 20 61 72 65 20 74 68 65 20 6f 6e 6c 79 20  ng are the only 
f0f0: 6c 65 67 61 6c 20 63 6f 6d 62 69 6e 61 74 69 6f  legal combinatio
f100: 6e 73 20 6f 66 20 66 6c 61 67 73 20 74 6f 20 74  ns of flags to t
f110: 68 65 0a 2a 2a 20 78 53 68 6d 4c 6f 63 6b 20 6d  he.** xShmLock m
f120: 65 74 68 6f 64 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c  ethod:.**.** <ul
f130: 3e 0a 2a 2a 20 3c 6c 69 3e 20 20 53 51 4c 49 54  >.** <li>  SQLIT
f140: 45 5f 53 48 4d 5f 4c 4f 43 4b 20 7c 20 53 51 4c  E_SHM_LOCK | SQL
f150: 49 54 45 5f 53 48 4d 5f 53 48 41 52 45 44 0a 2a  ITE_SHM_SHARED.*
f160: 2a 20 3c 6c 69 3e 20 20 53 51 4c 49 54 45 5f 53  * <li>  SQLITE_S
f170: 48 4d 5f 4c 4f 43 4b 20 7c 20 53 51 4c 49 54 45  HM_LOCK | SQLITE
f180: 5f 53 48 4d 5f 45 58 43 4c 55 53 49 56 45 0a 2a  _SHM_EXCLUSIVE.*
f190: 2a 20 3c 6c 69 3e 20 20 53 51 4c 49 54 45 5f 53  * <li>  SQLITE_S
f1a0: 48 4d 5f 55 4e 4c 4f 43 4b 20 7c 20 53 51 4c 49  HM_UNLOCK | SQLI
f1b0: 54 45 5f 53 48 4d 5f 53 48 41 52 45 44 0a 2a 2a  TE_SHM_SHARED.**
f1c0: 20 3c 6c 69 3e 20 20 53 51 4c 49 54 45 5f 53 48   <li>  SQLITE_SH
f1d0: 4d 5f 55 4e 4c 4f 43 4b 20 7c 20 53 51 4c 49 54  M_UNLOCK | SQLIT
f1e0: 45 5f 53 48 4d 5f 45 58 43 4c 55 53 49 56 45 0a  E_SHM_EXCLUSIVE.
f1f0: 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2a 0a 2a 2a 20 57  ** </ul>.**.** W
f200: 68 65 6e 20 75 6e 6c 6f 63 6b 69 6e 67 2c 20 74  hen unlocking, t
f210: 68 65 20 73 61 6d 65 20 53 48 41 52 45 44 20 6f  he same SHARED o
f220: 72 20 45 58 43 4c 55 53 49 56 45 20 66 6c 61 67  r EXCLUSIVE flag
f230: 20 6d 75 73 74 20 62 65 20 73 75 70 70 6c 69 65   must be supplie
f240: 64 20 61 73 0a 2a 2a 20 77 61 73 20 67 69 76 65  d as.** was give
f250: 6e 20 6f 6e 20 74 68 65 20 63 6f 72 72 65 73 70  n on the corresp
f260: 6f 6e 64 69 6e 67 20 6c 6f 63 6b 2e 20 20 0a 2a  onding lock.  .*
f270: 2a 0a 2a 2a 20 54 68 65 20 78 53 68 6d 4c 6f 63  *.** The xShmLoc
f280: 6b 20 6d 65 74 68 6f 64 20 63 61 6e 20 74 72 61  k method can tra
f290: 6e 73 69 74 69 6f 6e 20 62 65 74 77 65 65 6e 20  nsition between 
f2a0: 75 6e 6c 6f 63 6b 65 64 20 61 6e 64 20 53 48 41  unlocked and SHA
f2b0: 52 45 44 20 6f 72 0a 2a 2a 20 62 65 74 77 65 65  RED or.** betwee
f2c0: 6e 20 75 6e 6c 6f 63 6b 65 64 20 61 6e 64 20 45  n unlocked and E
f2d0: 58 43 4c 55 53 49 56 45 2e 20 20 49 74 20 63 61  XCLUSIVE.  It ca
f2e0: 6e 6e 6f 74 20 74 72 61 6e 73 69 74 69 6f 6e 20  nnot transition 
f2f0: 62 65 74 77 65 65 6e 20 53 48 41 52 45 44 0a 2a  between SHARED.*
f300: 2a 20 61 6e 64 20 45 58 43 4c 55 53 49 56 45 2e  * and EXCLUSIVE.
f310: 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  .*/.#define SQLI
f320: 54 45 5f 53 48 4d 5f 55 4e 4c 4f 43 4b 20 20 20  TE_SHM_UNLOCK   
f330: 20 20 20 20 31 0a 23 64 65 66 69 6e 65 20 53 51      1.#define SQ
f340: 4c 49 54 45 5f 53 48 4d 5f 4c 4f 43 4b 20 20 20  LITE_SHM_LOCK   
f350: 20 20 20 20 20 20 32 0a 23 64 65 66 69 6e 65 20        2.#define 
f360: 53 51 4c 49 54 45 5f 53 48 4d 5f 53 48 41 52 45  SQLITE_SHM_SHARE
f370: 44 20 20 20 20 20 20 20 34 0a 23 64 65 66 69 6e  D       4.#defin
f380: 65 20 53 51 4c 49 54 45 5f 53 48 4d 5f 45 58 43  e SQLITE_SHM_EXC
f390: 4c 55 53 49 56 45 20 20 20 20 38 0a 0a 2f 2a 0a  LUSIVE    8../*.
f3a0: 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 4d 61 78  ** CAPI3REF: Max
f3b0: 69 6d 75 6d 20 78 53 68 6d 4c 6f 63 6b 20 69 6e  imum xShmLock in
f3c0: 64 65 78 0a 2a 2a 0a 2a 2a 20 54 68 65 20 78 53  dex.**.** The xS
f3d0: 68 6d 4c 6f 63 6b 20 6d 65 74 68 6f 64 20 6f 6e  hmLock method on
f3e0: 20 5b 73 71 6c 69 74 65 33 5f 69 6f 5f 6d 65 74   [sqlite3_io_met
f3f0: 68 6f 64 73 5d 20 6d 61 79 20 75 73 65 20 76 61  hods] may use va
f400: 6c 75 65 73 0a 2a 2a 20 62 65 74 77 65 65 6e 20  lues.** between 
f410: 30 20 61 6e 64 20 74 68 69 73 20 75 70 70 65 72  0 and this upper
f420: 20 62 6f 75 6e 64 20 61 73 20 69 74 73 20 22 6f   bound as its "o
f430: 66 66 73 65 74 22 20 61 72 67 75 6d 65 6e 74 2e  ffset" argument.
f440: 0a 2a 2a 20 54 68 65 20 53 51 4c 69 74 65 20 63  .** The SQLite c
f450: 6f 72 65 20 77 69 6c 6c 20 6e 65 76 65 72 20 61  ore will never a
f460: 74 74 65 6d 70 74 20 74 6f 20 61 63 71 75 69 72  ttempt to acquir
f470: 65 20 6f 72 20 72 65 6c 65 61 73 65 20 61 0a 2a  e or release a.*
f480: 2a 20 6c 6f 63 6b 20 6f 75 74 73 69 64 65 20 6f  * lock outside o
f490: 66 20 74 68 69 73 20 72 61 6e 67 65 0a 2a 2f 0a  f this range.*/.
f4a0: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 53  #define SQLITE_S
f4b0: 48 4d 5f 4e 4c 4f 43 4b 20 20 20 20 20 20 20 20  HM_NLOCK        
f4c0: 38 0a 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  8.../*.** CAPI3R
f4d0: 45 46 3a 20 49 6e 69 74 69 61 6c 69 7a 65 20 54  EF: Initialize T
f4e0: 68 65 20 53 51 4c 69 74 65 20 4c 69 62 72 61 72  he SQLite Librar
f4f0: 79 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c  y.**.** ^The sql
f500: 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28  ite3_initialize(
f510: 29 20 72 6f 75 74 69 6e 65 20 69 6e 69 74 69 61  ) routine initia
f520: 6c 69 7a 65 73 20 74 68 65 0a 2a 2a 20 53 51 4c  lizes the.** SQL
f530: 69 74 65 20 6c 69 62 72 61 72 79 2e 20 20 5e 54  ite library.  ^T
f540: 68 65 20 73 71 6c 69 74 65 33 5f 73 68 75 74 64  he sqlite3_shutd
f550: 6f 77 6e 28 29 20 72 6f 75 74 69 6e 65 0a 2a 2a  own() routine.**
f560: 20 64 65 61 6c 6c 6f 63 61 74 65 73 20 61 6e 79   deallocates any
f570: 20 72 65 73 6f 75 72 63 65 73 20 74 68 61 74 20   resources that 
f580: 77 65 72 65 20 61 6c 6c 6f 63 61 74 65 64 20 62  were allocated b
f590: 79 20 73 71 6c 69 74 65 33 5f 69 6e 69 74 69 61  y sqlite3_initia
f5a0: 6c 69 7a 65 28 29 2e 0a 2a 2a 20 54 68 65 73 65  lize()..** These
f5b0: 20 72 6f 75 74 69 6e 65 73 20 61 72 65 20 64 65   routines are de
f5c0: 73 69 67 6e 65 64 20 74 6f 20 61 69 64 20 69 6e  signed to aid in
f5d0: 20 70 72 6f 63 65 73 73 20 69 6e 69 74 69 61 6c   process initial
f5e0: 69 7a 61 74 69 6f 6e 20 61 6e 64 0a 2a 2a 20 73  ization and.** s
f5f0: 68 75 74 64 6f 77 6e 20 6f 6e 20 65 6d 62 65 64  hutdown on embed
f600: 64 65 64 20 73 79 73 74 65 6d 73 2e 20 20 57 6f  ded systems.  Wo
f610: 72 6b 73 74 61 74 69 6f 6e 20 61 70 70 6c 69 63  rkstation applic
f620: 61 74 69 6f 6e 73 20 75 73 69 6e 67 0a 2a 2a 20  ations using.** 
f630: 53 51 4c 69 74 65 20 6e 6f 72 6d 61 6c 6c 79 20  SQLite normally 
f640: 64 6f 20 6e 6f 74 20 6e 65 65 64 20 74 6f 20 69  do not need to i
f650: 6e 76 6f 6b 65 20 65 69 74 68 65 72 20 6f 66 20  nvoke either of 
f660: 74 68 65 73 65 20 72 6f 75 74 69 6e 65 73 2e 0a  these routines..
f670: 2a 2a 0a 2a 2a 20 41 20 63 61 6c 6c 20 74 6f 20  **.** A call to 
f680: 73 71 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69  sqlite3_initiali
f690: 7a 65 28 29 20 69 73 20 61 6e 20 22 65 66 66 65  ze() is an "effe
f6a0: 63 74 69 76 65 22 20 63 61 6c 6c 20 69 66 20 69  ctive" call if i
f6b0: 74 20 69 73 0a 2a 2a 20 74 68 65 20 66 69 72 73  t is.** the firs
f6c0: 74 20 74 69 6d 65 20 73 71 6c 69 74 65 33 5f 69  t time sqlite3_i
f6d0: 6e 69 74 69 61 6c 69 7a 65 28 29 20 69 73 20 69  nitialize() is i
f6e0: 6e 76 6f 6b 65 64 20 64 75 72 69 6e 67 20 74 68  nvoked during th
f6f0: 65 20 6c 69 66 65 74 69 6d 65 20 6f 66 0a 2a 2a  e lifetime of.**
f700: 20 74 68 65 20 70 72 6f 63 65 73 73 2c 20 6f 72   the process, or
f710: 20 69 66 20 69 74 20 69 73 20 74 68 65 20 66 69   if it is the fi
f720: 72 73 74 20 74 69 6d 65 20 73 71 6c 69 74 65 33  rst time sqlite3
f730: 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29 20 69 73  _initialize() is
f740: 20 69 6e 76 6f 6b 65 64 0a 2a 2a 20 66 6f 6c 6c   invoked.** foll
f750: 6f 77 69 6e 67 20 61 20 63 61 6c 6c 20 74 6f 20  owing a call to 
f760: 73 71 6c 69 74 65 33 5f 73 68 75 74 64 6f 77 6e  sqlite3_shutdown
f770: 28 29 2e 20 20 5e 28 4f 6e 6c 79 20 61 6e 20 65  ().  ^(Only an e
f780: 66 66 65 63 74 69 76 65 20 63 61 6c 6c 0a 2a 2a  ffective call.**
f790: 20 6f 66 20 73 71 6c 69 74 65 33 5f 69 6e 69 74   of sqlite3_init
f7a0: 69 61 6c 69 7a 65 28 29 20 64 6f 65 73 20 61 6e  ialize() does an
f7b0: 79 20 69 6e 69 74 69 61 6c 69 7a 61 74 69 6f 6e  y initialization
f7c0: 2e 20 20 41 6c 6c 20 6f 74 68 65 72 20 63 61 6c  .  All other cal
f7d0: 6c 73 0a 2a 2a 20 61 72 65 20 68 61 72 6d 6c 65  ls.** are harmle
f7e0: 73 73 20 6e 6f 2d 6f 70 73 2e 29 5e 0a 2a 2a 0a  ss no-ops.)^.**.
f7f0: 2a 2a 20 41 20 63 61 6c 6c 20 74 6f 20 73 71 6c  ** A call to sql
f800: 69 74 65 33 5f 73 68 75 74 64 6f 77 6e 28 29 20  ite3_shutdown() 
f810: 69 73 20 61 6e 20 22 65 66 66 65 63 74 69 76 65  is an "effective
f820: 22 20 63 61 6c 6c 20 69 66 20 69 74 20 69 73 20  " call if it is 
f830: 74 68 65 20 66 69 72 73 74 0a 2a 2a 20 63 61 6c  the first.** cal
f840: 6c 20 74 6f 20 73 71 6c 69 74 65 33 5f 73 68 75  l to sqlite3_shu
f850: 74 64 6f 77 6e 28 29 20 73 69 6e 63 65 20 74 68  tdown() since th
f860: 65 20 6c 61 73 74 20 73 71 6c 69 74 65 33 5f 69  e last sqlite3_i
f870: 6e 69 74 69 61 6c 69 7a 65 28 29 2e 20 20 5e 28  nitialize().  ^(
f880: 4f 6e 6c 79 0a 2a 2a 20 61 6e 20 65 66 66 65 63  Only.** an effec
f890: 74 69 76 65 20 63 61 6c 6c 20 74 6f 20 73 71 6c  tive call to sql
f8a0: 69 74 65 33 5f 73 68 75 74 64 6f 77 6e 28 29 20  ite3_shutdown() 
f8b0: 64 6f 65 73 20 61 6e 79 20 64 65 69 6e 69 74 69  does any deiniti
f8c0: 61 6c 69 7a 61 74 69 6f 6e 2e 0a 2a 2a 20 41 6c  alization..** Al
f8d0: 6c 20 6f 74 68 65 72 20 76 61 6c 69 64 20 63 61  l other valid ca
f8e0: 6c 6c 73 20 74 6f 20 73 71 6c 69 74 65 33 5f 73  lls to sqlite3_s
f8f0: 68 75 74 64 6f 77 6e 28 29 20 61 72 65 20 68 61  hutdown() are ha
f900: 72 6d 6c 65 73 73 20 6e 6f 2d 6f 70 73 2e 29 5e  rmless no-ops.)^
f910: 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74  .**.** The sqlit
f920: 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29 20  e3_initialize() 
f930: 69 6e 74 65 72 66 61 63 65 20 69 73 20 74 68 72  interface is thr
f940: 65 61 64 73 61 66 65 2c 20 62 75 74 20 73 71 6c  eadsafe, but sql
f950: 69 74 65 33 5f 73 68 75 74 64 6f 77 6e 28 29 0a  ite3_shutdown().
f960: 2a 2a 20 69 73 20 6e 6f 74 2e 20 20 54 68 65 20  ** is not.  The 
f970: 73 71 6c 69 74 65 33 5f 73 68 75 74 64 6f 77 6e  sqlite3_shutdown
f980: 28 29 20 69 6e 74 65 72 66 61 63 65 20 6d 75 73  () interface mus
f990: 74 20 6f 6e 6c 79 20 62 65 20 63 61 6c 6c 65 64  t only be called
f9a0: 20 66 72 6f 6d 20 61 0a 2a 2a 20 73 69 6e 67 6c   from a.** singl
f9b0: 65 20 74 68 72 65 61 64 2e 20 20 41 6c 6c 20 6f  e thread.  All o
f9c0: 70 65 6e 20 5b 64 61 74 61 62 61 73 65 20 63 6f  pen [database co
f9d0: 6e 6e 65 63 74 69 6f 6e 73 5d 20 6d 75 73 74 20  nnections] must 
f9e0: 62 65 20 63 6c 6f 73 65 64 20 61 6e 64 20 61 6c  be closed and al
f9f0: 6c 0a 2a 2a 20 6f 74 68 65 72 20 53 51 4c 69 74  l.** other SQLit
fa00: 65 20 72 65 73 6f 75 72 63 65 73 20 6d 75 73 74  e resources must
fa10: 20 62 65 20 64 65 61 6c 6c 6f 63 61 74 65 64 20   be deallocated 
fa20: 70 72 69 6f 72 20 74 6f 20 69 6e 76 6f 6b 69 6e  prior to invokin
fa30: 67 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 73 68 75  g.** sqlite3_shu
fa40: 74 64 6f 77 6e 28 29 2e 0a 2a 2a 0a 2a 2a 20 41  tdown()..**.** A
fa50: 6d 6f 6e 67 20 6f 74 68 65 72 20 74 68 69 6e 67  mong other thing
fa60: 73 2c 20 5e 73 71 6c 69 74 65 33 5f 69 6e 69 74  s, ^sqlite3_init
fa70: 69 61 6c 69 7a 65 28 29 20 77 69 6c 6c 20 69 6e  ialize() will in
fa80: 76 6f 6b 65 0a 2a 2a 20 73 71 6c 69 74 65 33 5f  voke.** sqlite3_
fa90: 6f 73 5f 69 6e 69 74 28 29 2e 20 20 53 69 6d 69  os_init().  Simi
faa0: 6c 61 72 6c 79 2c 20 5e 73 71 6c 69 74 65 33 5f  larly, ^sqlite3_
fab0: 73 68 75 74 64 6f 77 6e 28 29 0a 2a 2a 20 77 69  shutdown().** wi
fac0: 6c 6c 20 69 6e 76 6f 6b 65 20 73 71 6c 69 74 65  ll invoke sqlite
fad0: 33 5f 6f 73 5f 65 6e 64 28 29 2e 0a 2a 2a 0a 2a  3_os_end()..**.*
fae0: 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 69  * ^The sqlite3_i
faf0: 6e 69 74 69 61 6c 69 7a 65 28 29 20 72 6f 75 74  nitialize() rout
fb00: 69 6e 65 20 72 65 74 75 72 6e 73 20 5b 53 51 4c  ine returns [SQL
fb10: 49 54 45 5f 4f 4b 5d 20 6f 6e 20 73 75 63 63 65  ITE_OK] on succe
fb20: 73 73 2e 0a 2a 2a 20 5e 49 66 20 66 6f 72 20 73  ss..** ^If for s
fb30: 6f 6d 65 20 72 65 61 73 6f 6e 2c 20 73 71 6c 69  ome reason, sqli
fb40: 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29  te3_initialize()
fb50: 20 69 73 20 75 6e 61 62 6c 65 20 74 6f 20 69 6e   is unable to in
fb60: 69 74 69 61 6c 69 7a 65 0a 2a 2a 20 74 68 65 20  itialize.** the 
fb70: 6c 69 62 72 61 72 79 20 28 70 65 72 68 61 70 73  library (perhaps
fb80: 20 69 74 20 69 73 20 75 6e 61 62 6c 65 20 74 6f   it is unable to
fb90: 20 61 6c 6c 6f 63 61 74 65 20 61 20 6e 65 65 64   allocate a need
fba0: 65 64 20 72 65 73 6f 75 72 63 65 20 73 75 63 68  ed resource such
fbb0: 0a 2a 2a 20 61 73 20 61 20 6d 75 74 65 78 29 20  .** as a mutex) 
fbc0: 69 74 20 72 65 74 75 72 6e 73 20 61 6e 20 5b 65  it returns an [e
fbd0: 72 72 6f 72 20 63 6f 64 65 5d 20 6f 74 68 65 72  rror code] other
fbe0: 20 74 68 61 6e 20 5b 53 51 4c 49 54 45 5f 4f 4b   than [SQLITE_OK
fbf0: 5d 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71  ]..**.** ^The sq
fc00: 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65  lite3_initialize
fc10: 28 29 20 72 6f 75 74 69 6e 65 20 69 73 20 63 61  () routine is ca
fc20: 6c 6c 65 64 20 69 6e 74 65 72 6e 61 6c 6c 79 20  lled internally 
fc30: 62 79 20 6d 61 6e 79 20 6f 74 68 65 72 0a 2a 2a  by many other.**
fc40: 20 53 51 4c 69 74 65 20 69 6e 74 65 72 66 61 63   SQLite interfac
fc50: 65 73 20 73 6f 20 74 68 61 74 20 61 6e 20 61 70  es so that an ap
fc60: 70 6c 69 63 61 74 69 6f 6e 20 75 73 75 61 6c 6c  plication usuall
fc70: 79 20 64 6f 65 73 20 6e 6f 74 20 6e 65 65 64 20  y does not need 
fc80: 74 6f 0a 2a 2a 20 69 6e 76 6f 6b 65 20 73 71 6c  to.** invoke sql
fc90: 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28  ite3_initialize(
fca0: 29 20 64 69 72 65 63 74 6c 79 2e 20 20 46 6f 72  ) directly.  For
fcb0: 20 65 78 61 6d 70 6c 65 2c 20 5b 73 71 6c 69 74   example, [sqlit
fcc0: 65 33 5f 6f 70 65 6e 28 29 5d 0a 2a 2a 20 63 61  e3_open()].** ca
fcd0: 6c 6c 73 20 73 71 6c 69 74 65 33 5f 69 6e 69 74  lls sqlite3_init
fce0: 69 61 6c 69 7a 65 28 29 20 73 6f 20 74 68 65 20  ialize() so the 
fcf0: 53 51 4c 69 74 65 20 6c 69 62 72 61 72 79 20 77  SQLite library w
fd00: 69 6c 6c 20 62 65 20 61 75 74 6f 6d 61 74 69 63  ill be automatic
fd10: 61 6c 6c 79 0a 2a 2a 20 69 6e 69 74 69 61 6c 69  ally.** initiali
fd20: 7a 65 64 20 77 68 65 6e 20 5b 73 71 6c 69 74 65  zed when [sqlite
fd30: 33 5f 6f 70 65 6e 28 29 5d 20 69 73 20 63 61 6c  3_open()] is cal
fd40: 6c 65 64 20 69 66 20 69 74 20 68 61 73 20 6e 6f  led if it has no
fd50: 74 20 62 65 20 69 6e 69 74 69 61 6c 69 7a 65 64  t be initialized
fd60: 0a 2a 2a 20 61 6c 72 65 61 64 79 2e 20 20 5e 48  .** already.  ^H
fd70: 6f 77 65 76 65 72 2c 20 69 66 20 53 51 4c 69 74  owever, if SQLit
fd80: 65 20 69 73 20 63 6f 6d 70 69 6c 65 64 20 77 69  e is compiled wi
fd90: 74 68 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 4f  th the [SQLITE_O
fda0: 4d 49 54 5f 41 55 54 4f 49 4e 49 54 5d 0a 2a 2a  MIT_AUTOINIT].**
fdb0: 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70   compile-time op
fdc0: 74 69 6f 6e 2c 20 74 68 65 6e 20 74 68 65 20 61  tion, then the a
fdd0: 75 74 6f 6d 61 74 69 63 20 63 61 6c 6c 73 20 74  utomatic calls t
fde0: 6f 20 73 71 6c 69 74 65 33 5f 69 6e 69 74 69 61  o sqlite3_initia
fdf0: 6c 69 7a 65 28 29 0a 2a 2a 20 61 72 65 20 6f 6d  lize().** are om
fe00: 69 74 74 65 64 20 61 6e 64 20 74 68 65 20 61 70  itted and the ap
fe10: 70 6c 69 63 61 74 69 6f 6e 20 6d 75 73 74 20 63  plication must c
fe20: 61 6c 6c 20 73 71 6c 69 74 65 33 5f 69 6e 69 74  all sqlite3_init
fe30: 69 61 6c 69 7a 65 28 29 20 64 69 72 65 63 74 6c  ialize() directl
fe40: 79 0a 2a 2a 20 70 72 69 6f 72 20 74 6f 20 75 73  y.** prior to us
fe50: 69 6e 67 20 61 6e 79 20 6f 74 68 65 72 20 53 51  ing any other SQ
fe60: 4c 69 74 65 20 69 6e 74 65 72 66 61 63 65 2e 20  Lite interface. 
fe70: 20 46 6f 72 20 6d 61 78 69 6d 75 6d 20 70 6f 72   For maximum por
fe80: 74 61 62 69 6c 69 74 79 2c 0a 2a 2a 20 69 74 20  tability,.** it 
fe90: 69 73 20 72 65 63 6f 6d 6d 65 6e 64 65 64 20 74  is recommended t
fea0: 68 61 74 20 61 70 70 6c 69 63 61 74 69 6f 6e 73  hat applications
feb0: 20 61 6c 77 61 79 73 20 69 6e 76 6f 6b 65 20 73   always invoke s
fec0: 71 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a  qlite3_initializ
fed0: 65 28 29 0a 2a 2a 20 64 69 72 65 63 74 6c 79 20  e().** directly 
fee0: 70 72 69 6f 72 20 74 6f 20 75 73 69 6e 67 20 61  prior to using a
fef0: 6e 79 20 6f 74 68 65 72 20 53 51 4c 69 74 65 20  ny other SQLite 
ff00: 69 6e 74 65 72 66 61 63 65 2e 20 20 46 75 74 75  interface.  Futu
ff10: 72 65 20 72 65 6c 65 61 73 65 73 0a 2a 2a 20 6f  re releases.** o
ff20: 66 20 53 51 4c 69 74 65 20 6d 61 79 20 72 65 71  f SQLite may req
ff30: 75 69 72 65 20 74 68 69 73 2e 20 20 49 6e 20 6f  uire this.  In o
ff40: 74 68 65 72 20 77 6f 72 64 73 2c 20 74 68 65 20  ther words, the 
ff50: 62 65 68 61 76 69 6f 72 20 65 78 68 69 62 69 74  behavior exhibit
ff60: 65 64 0a 2a 2a 20 77 68 65 6e 20 53 51 4c 69 74  ed.** when SQLit
ff70: 65 20 69 73 20 63 6f 6d 70 69 6c 65 64 20 77 69  e is compiled wi
ff80: 74 68 20 5b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f  th [SQLITE_OMIT_
ff90: 41 55 54 4f 49 4e 49 54 5d 20 6d 69 67 68 74 20  AUTOINIT] might 
ffa0: 62 65 63 6f 6d 65 20 74 68 65 0a 2a 2a 20 64 65  become the.** de
ffb0: 66 61 75 6c 74 20 62 65 68 61 76 69 6f 72 20 69  fault behavior i
ffc0: 6e 20 73 6f 6d 65 20 66 75 74 75 72 65 20 72 65  n some future re
ffd0: 6c 65 61 73 65 20 6f 66 20 53 51 4c 69 74 65 2e  lease of SQLite.
ffe0: 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74  .**.** The sqlit
fff0: 65 33 5f 6f 73 5f 69 6e 69 74 28 29 20 72 6f 75  e3_os_init() rou
10000 74 69 6e 65 20 64 6f 65 73 20 6f 70 65 72 61 74  tine does operat
10010 69 6e 67 2d 73 79 73 74 65 6d 20 73 70 65 63 69  ing-system speci
10020 66 69 63 0a 2a 2a 20 69 6e 69 74 69 61 6c 69 7a  fic.** initializ
10030 61 74 69 6f 6e 20 6f 66 20 74 68 65 20 53 51 4c  ation of the SQL
10040 69 74 65 20 6c 69 62 72 61 72 79 2e 20 20 54 68  ite library.  Th
10050 65 20 73 71 6c 69 74 65 33 5f 6f 73 5f 65 6e 64  e sqlite3_os_end
10060 28 29 0a 2a 2a 20 72 6f 75 74 69 6e 65 20 75 6e  ().** routine un
10070 64 6f 65 73 20 74 68 65 20 65 66 66 65 63 74 20  does the effect 
10080 6f 66 20 73 71 6c 69 74 65 33 5f 6f 73 5f 69 6e  of sqlite3_os_in
10090 69 74 28 29 2e 20 20 54 79 70 69 63 61 6c 20 74  it().  Typical t
100a0 61 73 6b 73 0a 2a 2a 20 70 65 72 66 6f 72 6d 65  asks.** performe
100b0 64 20 62 79 20 74 68 65 73 65 20 72 6f 75 74 69  d by these routi
100c0 6e 65 73 20 69 6e 63 6c 75 64 65 20 61 6c 6c 6f  nes include allo
100d0 63 61 74 69 6f 6e 20 6f 72 20 64 65 61 6c 6c 6f  cation or deallo
100e0 63 61 74 69 6f 6e 0a 2a 2a 20 6f 66 20 73 74 61  cation.** of sta
100f0 74 69 63 20 72 65 73 6f 75 72 63 65 73 2c 20 69  tic resources, i
10100 6e 69 74 69 61 6c 69 7a 61 74 69 6f 6e 20 6f 66  nitialization of
10110 20 67 6c 6f 62 61 6c 20 76 61 72 69 61 62 6c 65   global variable
10120 73 2c 0a 2a 2a 20 73 65 74 74 69 6e 67 20 75 70  s,.** setting up
10130 20 61 20 64 65 66 61 75 6c 74 20 5b 73 71 6c 69   a default [sqli
10140 74 65 33 5f 76 66 73 5d 20 6d 6f 64 75 6c 65 2c  te3_vfs] module,
10150 20 6f 72 20 73 65 74 74 69 6e 67 20 75 70 0a 2a   or setting up.*
10160 2a 20 61 20 64 65 66 61 75 6c 74 20 63 6f 6e 66  * a default conf
10170 69 67 75 72 61 74 69 6f 6e 20 75 73 69 6e 67 20  iguration using 
10180 5b 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28  [sqlite3_config(
10190 29 5d 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 61 70  )]..**.** The ap
101a0 70 6c 69 63 61 74 69 6f 6e 20 73 68 6f 75 6c 64  plication should
101b0 20 6e 65 76 65 72 20 69 6e 76 6f 6b 65 20 65 69   never invoke ei
101c0 74 68 65 72 20 73 71 6c 69 74 65 33 5f 6f 73 5f  ther sqlite3_os_
101d0 69 6e 69 74 28 29 0a 2a 2a 20 6f 72 20 73 71 6c  init().** or sql
101e0 69 74 65 33 5f 6f 73 5f 65 6e 64 28 29 20 64 69  ite3_os_end() di
101f0 72 65 63 74 6c 79 2e 20 20 54 68 65 20 61 70 70  rectly.  The app
10200 6c 69 63 61 74 69 6f 6e 20 73 68 6f 75 6c 64 20  lication should 
10210 6f 6e 6c 79 20 69 6e 76 6f 6b 65 0a 2a 2a 20 73  only invoke.** s
10220 71 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a  qlite3_initializ
10230 65 28 29 20 61 6e 64 20 73 71 6c 69 74 65 33 5f  e() and sqlite3_
10240 73 68 75 74 64 6f 77 6e 28 29 2e 20 20 54 68 65  shutdown().  The
10250 20 73 71 6c 69 74 65 33 5f 6f 73 5f 69 6e 69 74   sqlite3_os_init
10260 28 29 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 20  ().** interface 
10270 69 73 20 63 61 6c 6c 65 64 20 61 75 74 6f 6d 61  is called automa
10280 74 69 63 61 6c 6c 79 20 62 79 20 73 71 6c 69 74  tically by sqlit
10290 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29 20  e3_initialize() 
102a0 61 6e 64 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 6f  and.** sqlite3_o
102b0 73 5f 65 6e 64 28 29 20 69 73 20 63 61 6c 6c 65  s_end() is calle
102c0 64 20 62 79 20 73 71 6c 69 74 65 33 5f 73 68 75  d by sqlite3_shu
102d0 74 64 6f 77 6e 28 29 2e 20 20 41 70 70 72 6f 70  tdown().  Approp
102e0 72 69 61 74 65 0a 2a 2a 20 69 6d 70 6c 65 6d 65  riate.** impleme
102f0 6e 74 61 74 69 6f 6e 73 20 66 6f 72 20 73 71 6c  ntations for sql
10300 69 74 65 33 5f 6f 73 5f 69 6e 69 74 28 29 20 61  ite3_os_init() a
10310 6e 64 20 73 71 6c 69 74 65 33 5f 6f 73 5f 65 6e  nd sqlite3_os_en
10320 64 28 29 0a 2a 2a 20 61 72 65 20 62 75 69 6c 74  d().** are built
10330 20 69 6e 74 6f 20 53 51 4c 69 74 65 20 77 68 65   into SQLite whe
10340 6e 20 69 74 20 69 73 20 63 6f 6d 70 69 6c 65 64  n it is compiled
10350 20 66 6f 72 20 55 6e 69 78 2c 20 57 69 6e 64 6f   for Unix, Windo
10360 77 73 2c 20 6f 72 20 4f 53 2f 32 2e 0a 2a 2a 20  ws, or OS/2..** 
10370 57 68 65 6e 20 5b 63 75 73 74 6f 6d 20 62 75 69  When [custom bui
10380 6c 64 73 20 7c 20 62 75 69 6c 74 20 66 6f 72 20  lds | built for 
10390 6f 74 68 65 72 20 70 6c 61 74 66 6f 72 6d 73 5d  other platforms]
103a0 0a 2a 2a 20 28 75 73 69 6e 67 20 74 68 65 20 5b  .** (using the [
103b0 53 51 4c 49 54 45 5f 4f 53 5f 4f 54 48 45 52 3d  SQLITE_OS_OTHER=
103c0 31 5d 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 0a  1] compile-time.
103d0 2a 2a 20 6f 70 74 69 6f 6e 29 20 74 68 65 20 61  ** option) the a
103e0 70 70 6c 69 63 61 74 69 6f 6e 20 6d 75 73 74 20  pplication must 
103f0 73 75 70 70 6c 79 20 61 20 73 75 69 74 61 62 6c  supply a suitabl
10400 65 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e  e implementation
10410 20 66 6f 72 0a 2a 2a 20 73 71 6c 69 74 65 33 5f   for.** sqlite3_
10420 6f 73 5f 69 6e 69 74 28 29 20 61 6e 64 20 73 71  os_init() and sq
10430 6c 69 74 65 33 5f 6f 73 5f 65 6e 64 28 29 2e 20  lite3_os_end(). 
10440 20 41 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e 2d   An application-
10450 73 75 70 70 6c 69 65 64 0a 2a 2a 20 69 6d 70 6c  supplied.** impl
10460 65 6d 65 6e 74 61 74 69 6f 6e 20 6f 66 20 73 71  ementation of sq
10470 6c 69 74 65 33 5f 6f 73 5f 69 6e 69 74 28 29 20  lite3_os_init() 
10480 6f 72 20 73 71 6c 69 74 65 33 5f 6f 73 5f 65 6e  or sqlite3_os_en
10490 64 28 29 0a 2a 2a 20 6d 75 73 74 20 72 65 74 75  d().** must retu
104a0 72 6e 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d 20 6f  rn [SQLITE_OK] o
104b0 6e 20 73 75 63 63 65 73 73 20 61 6e 64 20 73 6f  n success and so
104c0 6d 65 20 6f 74 68 65 72 20 5b 65 72 72 6f 72 20  me other [error 
104d0 63 6f 64 65 5d 20 75 70 6f 6e 0a 2a 2a 20 66 61  code] upon.** fa
104e0 69 6c 75 72 65 2e 0a 2a 2f 0a 69 6e 74 20 73 71  ilure..*/.int sq
104f0 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65  lite3_initialize
10500 28 76 6f 69 64 29 3b 0a 69 6e 74 20 73 71 6c 69  (void);.int sqli
10510 74 65 33 5f 73 68 75 74 64 6f 77 6e 28 76 6f 69  te3_shutdown(voi
10520 64 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  d);.int sqlite3_
10530 6f 73 5f 69 6e 69 74 28 76 6f 69 64 29 3b 0a 69  os_init(void);.i
10540 6e 74 20 73 71 6c 69 74 65 33 5f 6f 73 5f 65 6e  nt sqlite3_os_en
10550 64 28 76 6f 69 64 29 3b 0a 0a 2f 2a 0a 2a 2a 20  d(void);../*.** 
10560 43 41 50 49 33 52 45 46 3a 20 43 6f 6e 66 69 67  CAPI3REF: Config
10570 75 72 69 6e 67 20 54 68 65 20 53 51 4c 69 74 65  uring The SQLite
10580 20 4c 69 62 72 61 72 79 0a 2a 2a 0a 2a 2a 20 54   Library.**.** T
10590 68 65 20 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69  he sqlite3_confi
105a0 67 28 29 20 69 6e 74 65 72 66 61 63 65 20 69 73  g() interface is
105b0 20 75 73 65 64 20 74 6f 20 6d 61 6b 65 20 67 6c   used to make gl
105c0 6f 62 61 6c 20 63 6f 6e 66 69 67 75 72 61 74 69  obal configurati
105d0 6f 6e 0a 2a 2a 20 63 68 61 6e 67 65 73 20 74 6f  on.** changes to
105e0 20 53 51 4c 69 74 65 20 69 6e 20 6f 72 64 65 72   SQLite in order
105f0 20 74 6f 20 74 75 6e 65 20 53 51 4c 69 74 65 20   to tune SQLite 
10600 74 6f 20 74 68 65 20 73 70 65 63 69 66 69 63 20  to the specific 
10610 6e 65 65 64 73 20 6f 66 0a 2a 2a 20 74 68 65 20  needs of.** the 
10620 61 70 70 6c 69 63 61 74 69 6f 6e 2e 20 20 54 68  application.  Th
10630 65 20 64 65 66 61 75 6c 74 20 63 6f 6e 66 69 67  e default config
10640 75 72 61 74 69 6f 6e 20 69 73 20 72 65 63 6f 6d  uration is recom
10650 6d 65 6e 64 65 64 20 66 6f 72 20 6d 6f 73 74 0a  mended for most.
10660 2a 2a 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 20  ** applications 
10670 61 6e 64 20 73 6f 20 74 68 69 73 20 72 6f 75 74  and so this rout
10680 69 6e 65 20 69 73 20 75 73 75 61 6c 6c 79 20 6e  ine is usually n
10690 6f 74 20 6e 65 63 65 73 73 61 72 79 2e 20 20 49  ot necessary.  I
106a0 74 20 69 73 0a 2a 2a 20 70 72 6f 76 69 64 65 64  t is.** provided
106b0 20 74 6f 20 73 75 70 70 6f 72 74 20 72 61 72 65   to support rare
106c0 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 77 69   applications wi
106d0 74 68 20 75 6e 75 73 75 61 6c 20 6e 65 65 64 73  th unusual needs
106e0 2e 0a 2a 2a 0a 2a 2a 20 3c 62 3e 54 68 65 20 73  ..**.** <b>The s
106f0 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 20  qlite3_config() 
10700 69 6e 74 65 72 66 61 63 65 20 69 73 20 6e 6f 74  interface is not
10710 20 74 68 72 65 61 64 73 61 66 65 2e 20 54 68 65   threadsafe. The
10720 20 61 70 70 6c 69 63 61 74 69 6f 6e 0a 2a 2a 20   application.** 
10730 6d 75 73 74 20 65 6e 73 75 72 65 20 74 68 61 74  must ensure that
10740 20 6e 6f 20 6f 74 68 65 72 20 53 51 4c 69 74 65   no other SQLite
10750 20 69 6e 74 65 72 66 61 63 65 73 20 61 72 65 20   interfaces are 
10760 69 6e 76 6f 6b 65 64 20 62 79 20 6f 74 68 65 72  invoked by other
10770 0a 2a 2a 20 74 68 72 65 61 64 73 20 77 68 69 6c  .** threads whil
10780 65 20 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67  e sqlite3_config
10790 28 29 20 69 73 20 72 75 6e 6e 69 6e 67 2e 3c 2f  () is running.</
107a0 62 3e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c  b>.**.** The sql
107b0 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 20 69 6e  ite3_config() in
107c0 74 65 72 66 61 63 65 0a 2a 2a 20 6d 61 79 20 6f  terface.** may o
107d0 6e 6c 79 20 62 65 20 69 6e 76 6f 6b 65 64 20 70  nly be invoked p
107e0 72 69 6f 72 20 74 6f 20 6c 69 62 72 61 72 79 20  rior to library 
107f0 69 6e 69 74 69 61 6c 69 7a 61 74 69 6f 6e 20 75  initialization u
10800 73 69 6e 67 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  sing.** [sqlite3
10810 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29 5d 20 6f  _initialize()] o
10820 72 20 61 66 74 65 72 20 73 68 75 74 64 6f 77 6e  r after shutdown
10830 20 62 79 20 5b 73 71 6c 69 74 65 33 5f 73 68 75   by [sqlite3_shu
10840 74 64 6f 77 6e 28 29 5d 2e 0a 2a 2a 20 5e 49 66  tdown()]..** ^If
10850 20 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28   sqlite3_config(
10860 29 20 69 73 20 63 61 6c 6c 65 64 20 61 66 74 65  ) is called afte
10870 72 20 5b 73 71 6c 69 74 65 33 5f 69 6e 69 74 69  r [sqlite3_initi
10880 61 6c 69 7a 65 28 29 5d 20 61 6e 64 20 62 65 66  alize()] and bef
10890 6f 72 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f  ore.** [sqlite3_
108a0 73 68 75 74 64 6f 77 6e 28 29 5d 20 74 68 65 6e  shutdown()] then
108b0 20 69 74 20 77 69 6c 6c 20 72 65 74 75 72 6e 20   it will return 
108c0 53 51 4c 49 54 45 5f 4d 49 53 55 53 45 2e 0a 2a  SQLITE_MISUSE..*
108d0 2a 20 4e 6f 74 65 2c 20 68 6f 77 65 76 65 72 2c  * Note, however,
108e0 20 74 68 61 74 20 5e 73 71 6c 69 74 65 33 5f 63   that ^sqlite3_c
108f0 6f 6e 66 69 67 28 29 20 63 61 6e 20 62 65 20 63  onfig() can be c
10900 61 6c 6c 65 64 20 61 73 20 70 61 72 74 20 6f 66  alled as part of
10910 20 74 68 65 0a 2a 2a 20 69 6d 70 6c 65 6d 65 6e   the.** implemen
10920 74 61 74 69 6f 6e 20 6f 66 20 61 6e 20 61 70 70  tation of an app
10930 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64  lication-defined
10940 20 5b 73 71 6c 69 74 65 33 5f 6f 73 5f 69 6e 69   [sqlite3_os_ini
10950 74 28 29 5d 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20  t()]..**.** The 
10960 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20 74  first argument t
10970 6f 20 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67  o sqlite3_config
10980 28 29 20 69 73 20 61 6e 20 69 6e 74 65 67 65 72  () is an integer
10990 0a 2a 2a 20 5b 63 6f 6e 66 69 67 75 72 61 74 69  .** [configurati
109a0 6f 6e 20 6f 70 74 69 6f 6e 5d 20 74 68 61 74 20  on option] that 
109b0 64 65 74 65 72 6d 69 6e 65 73 0a 2a 2a 20 77 68  determines.** wh
109c0 61 74 20 70 72 6f 70 65 72 74 79 20 6f 66 20 53  at property of S
109d0 51 4c 69 74 65 20 69 73 20 74 6f 20 62 65 20 63  QLite is to be c
109e0 6f 6e 66 69 67 75 72 65 64 2e 20 20 53 75 62 73  onfigured.  Subs
109f0 65 71 75 65 6e 74 20 61 72 67 75 6d 65 6e 74 73  equent arguments
10a00 0a 2a 2a 20 76 61 72 79 20 64 65 70 65 6e 64 69  .** vary dependi
10a10 6e 67 20 6f 6e 20 74 68 65 20 5b 63 6f 6e 66 69  ng on the [confi
10a20 67 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 5d  guration option]
10a30 0a 2a 2a 20 69 6e 20 74 68 65 20 66 69 72 73 74  .** in the first
10a40 20 61 72 67 75 6d 65 6e 74 2e 0a 2a 2a 0a 2a 2a   argument..**.**
10a50 20 5e 57 68 65 6e 20 61 20 63 6f 6e 66 69 67 75   ^When a configu
10a60 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 20 69 73  ration option is
10a70 20 73 65 74 2c 20 73 71 6c 69 74 65 33 5f 63 6f   set, sqlite3_co
10a80 6e 66 69 67 28 29 20 72 65 74 75 72 6e 73 20 5b  nfig() returns [
10a90 53 51 4c 49 54 45 5f 4f 4b 5d 2e 0a 2a 2a 20 5e  SQLITE_OK]..** ^
10aa0 49 66 20 74 68 65 20 6f 70 74 69 6f 6e 20 69 73  If the option is
10ab0 20 75 6e 6b 6e 6f 77 6e 20 6f 72 20 53 51 4c 69   unknown or SQLi
10ac0 74 65 20 69 73 20 75 6e 61 62 6c 65 20 74 6f 20  te is unable to 
10ad0 73 65 74 20 74 68 65 20 6f 70 74 69 6f 6e 0a 2a  set the option.*
10ae0 2a 20 74 68 65 6e 20 74 68 69 73 20 72 6f 75 74  * then this rout
10af0 69 6e 65 20 72 65 74 75 72 6e 73 20 61 20 6e 6f  ine returns a no
10b00 6e 2d 7a 65 72 6f 20 5b 65 72 72 6f 72 20 63 6f  n-zero [error co
10b10 64 65 5d 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69  de]..*/.int sqli
10b20 74 65 33 5f 63 6f 6e 66 69 67 28 69 6e 74 2c 20  te3_config(int, 
10b30 2e 2e 2e 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50  ...);../*.** CAP
10b40 49 33 52 45 46 3a 20 43 6f 6e 66 69 67 75 72 65  I3REF: Configure
10b50 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63   database connec
10b60 74 69 6f 6e 73 0a 2a 2a 20 4d 45 54 48 4f 44 3a  tions.** METHOD:
10b70 20 73 71 6c 69 74 65 33 0a 2a 2a 0a 2a 2a 20 54   sqlite3.**.** T
10b80 68 65 20 73 71 6c 69 74 65 33 5f 64 62 5f 63 6f  he sqlite3_db_co
10b90 6e 66 69 67 28 29 20 69 6e 74 65 72 66 61 63 65  nfig() interface
10ba0 20 69 73 20 75 73 65 64 20 74 6f 20 6d 61 6b 65   is used to make
10bb0 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 0a 2a   configuration.*
10bc0 2a 20 63 68 61 6e 67 65 73 20 74 6f 20 61 20 5b  * changes to a [
10bd0 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74  database connect
10be0 69 6f 6e 5d 2e 20 20 54 68 65 20 69 6e 74 65 72  ion].  The inter
10bf0 66 61 63 65 20 69 73 20 73 69 6d 69 6c 61 72 20  face is similar 
10c00 74 6f 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63  to.** [sqlite3_c
10c10 6f 6e 66 69 67 28 29 5d 20 65 78 63 65 70 74 20  onfig()] except 
10c20 74 68 61 74 20 74 68 65 20 63 68 61 6e 67 65 73  that the changes
10c30 20 61 70 70 6c 79 20 74 6f 20 61 20 73 69 6e 67   apply to a sing
10c40 6c 65 0a 2a 2a 20 5b 64 61 74 61 62 61 73 65 20  le.** [database 
10c50 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 28 73 70 65  connection] (spe
10c60 63 69 66 69 65 64 20 69 6e 20 74 68 65 20 66 69  cified in the fi
10c70 72 73 74 20 61 72 67 75 6d 65 6e 74 29 2e 0a 2a  rst argument)..*
10c80 2a 0a 2a 2a 20 54 68 65 20 73 65 63 6f 6e 64 20  *.** The second 
10c90 61 72 67 75 6d 65 6e 74 20 74 6f 20 73 71 6c 69  argument to sqli
10ca0 74 65 33 5f 64 62 5f 63 6f 6e 66 69 67 28 44 2c  te3_db_config(D,
10cb0 56 2c 2e 2e 2e 29 20 20 69 73 20 74 68 65 0a 2a  V,...)  is the.*
10cc0 2a 20 5b 53 51 4c 49 54 45 5f 44 42 43 4f 4e 46  * [SQLITE_DBCONF
10cd0 49 47 5f 4c 4f 4f 4b 41 53 49 44 45 20 7c 20 63  IG_LOOKASIDE | c
10ce0 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 76 65 72  onfiguration ver
10cf0 62 5d 20 2d 20 61 6e 20 69 6e 74 65 67 65 72 20  b] - an integer 
10d00 63 6f 64 65 20 0a 2a 2a 20 74 68 61 74 20 69 6e  code .** that in
10d10 64 69 63 61 74 65 73 20 77 68 61 74 20 61 73 70  dicates what asp
10d20 65 63 74 20 6f 66 20 74 68 65 20 5b 64 61 74 61  ect of the [data
10d30 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d  base connection]
10d40 20 69 73 20 62 65 69 6e 67 20 63 6f 6e 66 69 67   is being config
10d50 75 72 65 64 2e 0a 2a 2a 20 53 75 62 73 65 71 75  ured..** Subsequ
10d60 65 6e 74 20 61 72 67 75 6d 65 6e 74 73 20 76 61  ent arguments va
10d70 72 79 20 64 65 70 65 6e 64 69 6e 67 20 6f 6e 20  ry depending on 
10d80 74 68 65 20 63 6f 6e 66 69 67 75 72 61 74 69 6f  the configuratio
10d90 6e 20 76 65 72 62 2e 0a 2a 2a 0a 2a 2a 20 5e 43  n verb..**.** ^C
10da0 61 6c 6c 73 20 74 6f 20 73 71 6c 69 74 65 33 5f  alls to sqlite3_
10db0 64 62 5f 63 6f 6e 66 69 67 28 29 20 72 65 74 75  db_config() retu
10dc0 72 6e 20 53 51 4c 49 54 45 5f 4f 4b 20 69 66 20  rn SQLITE_OK if 
10dd0 61 6e 64 20 6f 6e 6c 79 20 69 66 0a 2a 2a 20 74  and only if.** t
10de0 68 65 20 63 61 6c 6c 20 69 73 20 63 6f 6e 73 69  he call is consi
10df0 64 65 72 65 64 20 73 75 63 63 65 73 73 66 75 6c  dered successful
10e00 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33  ..*/.int sqlite3
10e10 5f 64 62 5f 63 6f 6e 66 69 67 28 73 71 6c 69 74  _db_config(sqlit
10e20 65 33 2a 2c 20 69 6e 74 20 6f 70 2c 20 2e 2e 2e  e3*, int op, ...
10e30 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  );../*.** CAPI3R
10e40 45 46 3a 20 4d 65 6d 6f 72 79 20 41 6c 6c 6f 63  EF: Memory Alloc
10e50 61 74 69 6f 6e 20 52 6f 75 74 69 6e 65 73 0a 2a  ation Routines.*
10e60 2a 0a 2a 2a 20 41 6e 20 69 6e 73 74 61 6e 63 65  *.** An instance
10e70 20 6f 66 20 74 68 69 73 20 6f 62 6a 65 63 74 20   of this object 
10e80 64 65 66 69 6e 65 73 20 74 68 65 20 69 6e 74 65  defines the inte
10e90 72 66 61 63 65 20 62 65 74 77 65 65 6e 20 53 51  rface between SQ
10ea0 4c 69 74 65 0a 2a 2a 20 61 6e 64 20 6c 6f 77 2d  Lite.** and low-
10eb0 6c 65 76 65 6c 20 6d 65 6d 6f 72 79 20 61 6c 6c  level memory all
10ec0 6f 63 61 74 69 6f 6e 20 72 6f 75 74 69 6e 65 73  ocation routines
10ed0 2e 0a 2a 2a 0a 2a 2a 20 54 68 69 73 20 6f 62 6a  ..**.** This obj
10ee0 65 63 74 20 69 73 20 75 73 65 64 20 69 6e 20 6f  ect is used in o
10ef0 6e 6c 79 20 6f 6e 65 20 70 6c 61 63 65 20 69 6e  nly one place in
10f00 20 74 68 65 20 53 51 4c 69 74 65 20 69 6e 74 65   the SQLite inte
10f10 72 66 61 63 65 2e 0a 2a 2a 20 41 20 70 6f 69 6e  rface..** A poin
10f20 74 65 72 20 74 6f 20 61 6e 20 69 6e 73 74 61 6e  ter to an instan
10f30 63 65 20 6f 66 20 74 68 69 73 20 6f 62 6a 65 63  ce of this objec
10f40 74 20 69 73 20 74 68 65 20 61 72 67 75 6d 65 6e  t is the argumen
10f50 74 20 74 6f 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  t to.** [sqlite3
10f60 5f 63 6f 6e 66 69 67 28 29 5d 20 77 68 65 6e 20  _config()] when 
10f70 74 68 65 20 63 6f 6e 66 69 67 75 72 61 74 69 6f  the configuratio
10f80 6e 20 6f 70 74 69 6f 6e 20 69 73 0a 2a 2a 20 5b  n option is.** [
10f90 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 41  SQLITE_CONFIG_MA
10fa0 4c 4c 4f 43 5d 20 6f 72 20 5b 53 51 4c 49 54 45  LLOC] or [SQLITE
10fb0 5f 43 4f 4e 46 49 47 5f 47 45 54 4d 41 4c 4c 4f  _CONFIG_GETMALLO
10fc0 43 5d 2e 20 20 0a 2a 2a 20 42 79 20 63 72 65 61  C].  .** By crea
10fd0 74 69 6e 67 20 61 6e 20 69 6e 73 74 61 6e 63 65  ting an instance
10fe0 20 6f 66 20 74 68 69 73 20 6f 62 6a 65 63 74 0a   of this object.
10ff0 2a 2a 20 61 6e 64 20 70 61 73 73 69 6e 67 20 69  ** and passing i
11000 74 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 63 6f  t to [sqlite3_co
11010 6e 66 69 67 5d 28 5b 53 51 4c 49 54 45 5f 43 4f  nfig]([SQLITE_CO
11020 4e 46 49 47 5f 4d 41 4c 4c 4f 43 5d 29 0a 2a 2a  NFIG_MALLOC]).**
11030 20 64 75 72 69 6e 67 20 63 6f 6e 66 69 67 75 72   during configur
11040 61 74 69 6f 6e 2c 20 61 6e 20 61 70 70 6c 69 63  ation, an applic
11050 61 74 69 6f 6e 20 63 61 6e 20 73 70 65 63 69 66  ation can specif
11060 79 20 61 6e 20 61 6c 74 65 72 6e 61 74 69 76 65  y an alternative
11070 0a 2a 2a 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63  .** memory alloc
11080 61 74 69 6f 6e 20 73 75 62 73 79 73 74 65 6d 20  ation subsystem 
11090 66 6f 72 20 53 51 4c 69 74 65 20 74 6f 20 75 73  for SQLite to us
110a0 65 20 66 6f 72 20 61 6c 6c 20 6f 66 20 69 74 73  e for all of its
110b0 0a 2a 2a 20 64 79 6e 61 6d 69 63 20 6d 65 6d 6f  .** dynamic memo
110c0 72 79 20 6e 65 65 64 73 2e 0a 2a 2a 0a 2a 2a 20  ry needs..**.** 
110d0 4e 6f 74 65 20 74 68 61 74 20 53 51 4c 69 74 65  Note that SQLite
110e0 20 63 6f 6d 65 73 20 77 69 74 68 20 73 65 76 65   comes with seve
110f0 72 61 6c 20 5b 62 75 69 6c 74 2d 69 6e 20 6d 65  ral [built-in me
11100 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72 73 5d  mory allocators]
11110 0a 2a 2a 20 74 68 61 74 20 61 72 65 20 70 65 72  .** that are per
11120 66 65 63 74 6c 79 20 61 64 65 71 75 61 74 65 20  fectly adequate 
11130 66 6f 72 20 74 68 65 20 6f 76 65 72 77 68 65 6c  for the overwhel
11140 6d 69 6e 67 20 6d 61 6a 6f 72 69 74 79 20 6f 66  ming majority of
11150 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 0a 2a 2a   applications.**
11160 20 61 6e 64 20 74 68 61 74 20 74 68 69 73 20 6f   and that this o
11170 62 6a 65 63 74 20 69 73 20 6f 6e 6c 79 20 75 73  bject is only us
11180 65 66 75 6c 20 74 6f 20 61 20 74 69 6e 79 20 6d  eful to a tiny m
11190 69 6e 6f 72 69 74 79 20 6f 66 20 61 70 70 6c 69  inority of appli
111a0 63 61 74 69 6f 6e 73 0a 2a 2a 20 77 69 74 68 20  cations.** with 
111b0 73 70 65 63 69 61 6c 69 7a 65 64 20 6d 65 6d 6f  specialized memo
111c0 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 72 65  ry allocation re
111d0 71 75 69 72 65 6d 65 6e 74 73 2e 20 20 54 68 69  quirements.  Thi
111e0 73 20 6f 62 6a 65 63 74 20 69 73 0a 2a 2a 20 61  s object is.** a
111f0 6c 73 6f 20 75 73 65 64 20 64 75 72 69 6e 67 20  lso used during 
11200 74 65 73 74 69 6e 67 20 6f 66 20 53 51 4c 69 74  testing of SQLit
11210 65 20 69 6e 20 6f 72 64 65 72 20 74 6f 20 73 70  e in order to sp
11220 65 63 69 66 79 20 61 6e 20 61 6c 74 65 72 6e 61  ecify an alterna
11230 74 69 76 65 0a 2a 2a 20 6d 65 6d 6f 72 79 20 61  tive.** memory a
11240 6c 6c 6f 63 61 74 6f 72 20 74 68 61 74 20 73 69  llocator that si
11250 6d 75 6c 61 74 65 73 20 6d 65 6d 6f 72 79 20 6f  mulates memory o
11260 75 74 2d 6f 66 2d 6d 65 6d 6f 72 79 20 63 6f 6e  ut-of-memory con
11270 64 69 74 69 6f 6e 73 20 69 6e 0a 2a 2a 20 6f 72  ditions in.** or
11280 64 65 72 20 74 6f 20 76 65 72 69 66 79 20 74 68  der to verify th
11290 61 74 20 53 51 4c 69 74 65 20 72 65 63 6f 76 65  at SQLite recove
112a0 72 73 20 67 72 61 63 65 66 75 6c 6c 79 20 66 72  rs gracefully fr
112b0 6f 6d 20 73 75 63 68 0a 2a 2a 20 63 6f 6e 64 69  om such.** condi
112c0 74 69 6f 6e 73 2e 0a 2a 2a 0a 2a 2a 20 54 68 65  tions..**.** The
112d0 20 78 4d 61 6c 6c 6f 63 2c 20 78 52 65 61 6c 6c   xMalloc, xReall
112e0 6f 63 2c 20 61 6e 64 20 78 46 72 65 65 20 6d 65  oc, and xFree me
112f0 74 68 6f 64 73 20 6d 75 73 74 20 77 6f 72 6b 20  thods must work 
11300 6c 69 6b 65 20 74 68 65 0a 2a 2a 20 6d 61 6c 6c  like the.** mall
11310 6f 63 28 29 2c 20 72 65 61 6c 6c 6f 63 28 29 20  oc(), realloc() 
11320 61 6e 64 20 66 72 65 65 28 29 20 66 75 6e 63 74  and free() funct
11330 69 6f 6e 73 20 66 72 6f 6d 20 74 68 65 20 73 74  ions from the st
11340 61 6e 64 61 72 64 20 43 20 6c 69 62 72 61 72 79  andard C library
11350 2e 0a 2a 2a 20 5e 53 51 4c 69 74 65 20 67 75 61  ..** ^SQLite gua
11360 72 61 6e 74 65 65 73 20 74 68 61 74 20 74 68 65  rantees that the
11370 20 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74   second argument
11380 20 74 6f 0a 2a 2a 20 78 52 65 61 6c 6c 6f 63 20   to.** xRealloc 
11390 69 73 20 61 6c 77 61 79 73 20 61 20 76 61 6c 75  is always a valu
113a0 65 20 72 65 74 75 72 6e 65 64 20 62 79 20 61 20  e returned by a 
113b0 70 72 69 6f 72 20 63 61 6c 6c 20 74 6f 20 78 52  prior call to xR
113c0 6f 75 6e 64 75 70 2e 0a 2a 2a 0a 2a 2a 20 78 53  oundup..**.** xS
113d0 69 7a 65 20 73 68 6f 75 6c 64 20 72 65 74 75 72  ize should retur
113e0 6e 20 74 68 65 20 61 6c 6c 6f 63 61 74 65 64 20  n the allocated 
113f0 73 69 7a 65 20 6f 66 20 61 20 6d 65 6d 6f 72 79  size of a memory
11400 20 61 6c 6c 6f 63 61 74 69 6f 6e 0a 2a 2a 20 70   allocation.** p
11410 72 65 76 69 6f 75 73 6c 79 20 6f 62 74 61 69 6e  reviously obtain
11420 65 64 20 66 72 6f 6d 20 78 4d 61 6c 6c 6f 63 20  ed from xMalloc 
11430 6f 72 20 78 52 65 61 6c 6c 6f 63 2e 20 20 54 68  or xRealloc.  Th
11440 65 20 61 6c 6c 6f 63 61 74 65 64 20 73 69 7a 65  e allocated size
11450 0a 2a 2a 20 69 73 20 61 6c 77 61 79 73 20 61 74  .** is always at
11460 20 6c 65 61 73 74 20 61 73 20 62 69 67 20 61 73   least as big as
11470 20 74 68 65 20 72 65 71 75 65 73 74 65 64 20 73   the requested s
11480 69 7a 65 20 62 75 74 20 6d 61 79 20 62 65 20 6c  ize but may be l
11490 61 72 67 65 72 2e 0a 2a 2a 0a 2a 2a 20 54 68 65  arger..**.** The
114a0 20 78 52 6f 75 6e 64 75 70 20 6d 65 74 68 6f 64   xRoundup method
114b0 20 72 65 74 75 72 6e 73 20 77 68 61 74 20 77 6f   returns what wo
114c0 75 6c 64 20 62 65 20 74 68 65 20 61 6c 6c 6f 63  uld be the alloc
114d0 61 74 65 64 20 73 69 7a 65 20 6f 66 0a 2a 2a 20  ated size of.** 
114e0 61 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74  a memory allocat
114f0 69 6f 6e 20 67 69 76 65 6e 20 61 20 70 61 72 74  ion given a part
11500 69 63 75 6c 61 72 20 72 65 71 75 65 73 74 65 64  icular requested
11510 20 73 69 7a 65 2e 20 20 4d 6f 73 74 20 6d 65 6d   size.  Most mem
11520 6f 72 79 0a 2a 2a 20 61 6c 6c 6f 63 61 74 6f 72  ory.** allocator
11530 73 20 72 6f 75 6e 64 20 75 70 20 6d 65 6d 6f 72  s round up memor
11540 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 73 20 61 74  y allocations at
11550 20 6c 65 61 73 74 20 74 6f 20 74 68 65 20 6e 65   least to the ne
11560 78 74 20 6d 75 6c 74 69 70 6c 65 0a 2a 2a 20 6f  xt multiple.** o
11570 66 20 38 2e 20 20 53 6f 6d 65 20 61 6c 6c 6f 63  f 8.  Some alloc
11580 61 74 6f 72 73 20 72 6f 75 6e 64 20 75 70 20 74  ators round up t
11590 6f 20 61 20 6c 61 72 67 65 72 20 6d 75 6c 74 69  o a larger multi
115a0 70 6c 65 20 6f 72 20 74 6f 20 61 20 70 6f 77 65  ple or to a powe
115b0 72 20 6f 66 20 32 2e 0a 2a 2a 20 45 76 65 72 79  r of 2..** Every
115c0 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69   memory allocati
115d0 6f 6e 20 72 65 71 75 65 73 74 20 63 6f 6d 69 6e  on request comin
115e0 67 20 69 6e 20 74 68 72 6f 75 67 68 20 5b 73 71  g in through [sq
115f0 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29 5d 0a  lite3_malloc()].
11600 2a 2a 20 6f 72 20 5b 73 71 6c 69 74 65 33 5f 72  ** or [sqlite3_r
11610 65 61 6c 6c 6f 63 28 29 5d 20 66 69 72 73 74 20  ealloc()] first 
11620 63 61 6c 6c 73 20 78 52 6f 75 6e 64 75 70 2e 20  calls xRoundup. 
11630 20 49 66 20 78 52 6f 75 6e 64 75 70 20 72 65 74   If xRoundup ret
11640 75 72 6e 73 20 30 2c 20 0a 2a 2a 20 74 68 61 74  urns 0, .** that
11650 20 63 61 75 73 65 73 20 74 68 65 20 63 6f 72 72   causes the corr
11660 65 73 70 6f 6e 64 69 6e 67 20 6d 65 6d 6f 72 79  esponding memory
11670 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 74 6f 20 66   allocation to f
11680 61 69 6c 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 78  ail..**.** The x
11690 49 6e 69 74 20 6d 65 74 68 6f 64 20 69 6e 69 74  Init method init
116a0 69 61 6c 69 7a 65 73 20 74 68 65 20 6d 65 6d 6f  ializes the memo
116b0 72 79 20 61 6c 6c 6f 63 61 74 6f 72 2e 20 20 46  ry allocator.  F
116c0 6f 72 20 65 78 61 6d 70 6c 65 2c 0a 2a 2a 20 69  or example,.** i
116d0 74 20 6d 69 67 68 74 20 61 6c 6c 6f 63 61 74 65  t might allocate
116e0 20 61 6e 79 20 72 65 71 75 69 72 65 20 6d 75 74   any require mut
116f0 65 78 65 73 20 6f 72 20 69 6e 69 74 69 61 6c 69  exes or initiali
11700 7a 65 20 69 6e 74 65 72 6e 61 6c 20 64 61 74 61  ze internal data
11710 0a 2a 2a 20 73 74 72 75 63 74 75 72 65 73 2e 20  .** structures. 
11720 20 54 68 65 20 78 53 68 75 74 64 6f 77 6e 20 6d   The xShutdown m
11730 65 74 68 6f 64 20 69 73 20 69 6e 76 6f 6b 65 64  ethod is invoked
11740 20 28 69 6e 64 69 72 65 63 74 6c 79 29 20 62 79   (indirectly) by
11750 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 73 68 75  .** [sqlite3_shu
11760 74 64 6f 77 6e 28 29 5d 20 61 6e 64 20 73 68 6f  tdown()] and sho
11770 75 6c 64 20 64 65 61 6c 6c 6f 63 61 74 65 20 61  uld deallocate a
11780 6e 79 20 72 65 73 6f 75 72 63 65 73 20 61 63 71  ny resources acq
11790 75 69 72 65 64 0a 2a 2a 20 62 79 20 78 49 6e 69  uired.** by xIni
117a0 74 2e 20 20 54 68 65 20 70 41 70 70 44 61 74 61  t.  The pAppData
117b0 20 70 6f 69 6e 74 65 72 20 69 73 20 75 73 65 64   pointer is used
117c0 20 61 73 20 74 68 65 20 6f 6e 6c 79 20 70 61 72   as the only par
117d0 61 6d 65 74 65 72 20 74 6f 0a 2a 2a 20 78 49 6e  ameter to.** xIn
117e0 69 74 20 61 6e 64 20 78 53 68 75 74 64 6f 77 6e  it and xShutdown
117f0 2e 0a 2a 2a 0a 2a 2a 20 53 51 4c 69 74 65 20 68  ..**.** SQLite h
11800 6f 6c 64 73 20 74 68 65 20 5b 53 51 4c 49 54 45  olds the [SQLITE
11810 5f 4d 55 54 45 58 5f 53 54 41 54 49 43 5f 4d 41  _MUTEX_STATIC_MA
11820 53 54 45 52 5d 20 6d 75 74 65 78 20 77 68 65 6e  STER] mutex when
11830 20 69 74 20 69 6e 76 6f 6b 65 73 0a 2a 2a 20 74   it invokes.** t
11840 68 65 20 78 49 6e 69 74 20 6d 65 74 68 6f 64 2c  he xInit method,
11850 20 73 6f 20 74 68 65 20 78 49 6e 69 74 20 6d 65   so the xInit me
11860 74 68 6f 64 20 6e 65 65 64 20 6e 6f 74 20 62 65  thod need not be
11870 20 74 68 72 65 61 64 73 61 66 65 2e 20 20 54 68   threadsafe.  Th
11880 65 0a 2a 2a 20 78 53 68 75 74 64 6f 77 6e 20 6d  e.** xShutdown m
11890 65 74 68 6f 64 20 69 73 20 6f 6e 6c 79 20 63 61  ethod is only ca
118a0 6c 6c 65 64 20 66 72 6f 6d 20 5b 73 71 6c 69 74  lled from [sqlit
118b0 65 33 5f 73 68 75 74 64 6f 77 6e 28 29 5d 20 73  e3_shutdown()] s
118c0 6f 20 69 74 20 64 6f 65 73 0a 2a 2a 20 6e 6f 74  o it does.** not
118d0 20 6e 65 65 64 20 74 6f 20 62 65 20 74 68 72 65   need to be thre
118e0 61 64 73 61 66 65 20 65 69 74 68 65 72 2e 20 20  adsafe either.  
118f0 46 6f 72 20 61 6c 6c 20 6f 74 68 65 72 20 6d 65  For all other me
11900 74 68 6f 64 73 2c 20 53 51 4c 69 74 65 0a 2a 2a  thods, SQLite.**
11910 20 68 6f 6c 64 73 20 74 68 65 20 5b 53 51 4c 49   holds the [SQLI
11920 54 45 5f 4d 55 54 45 58 5f 53 54 41 54 49 43 5f  TE_MUTEX_STATIC_
11930 4d 45 4d 5d 20 6d 75 74 65 78 20 61 73 20 6c 6f  MEM] mutex as lo
11940 6e 67 20 61 73 20 74 68 65 0a 2a 2a 20 5b 53 51  ng as the.** [SQ
11950 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 45 4d 53  LITE_CONFIG_MEMS
11960 54 41 54 55 53 5d 20 63 6f 6e 66 69 67 75 72 61  TATUS] configura
11970 74 69 6f 6e 20 6f 70 74 69 6f 6e 20 69 73 20 74  tion option is t
11980 75 72 6e 65 64 20 6f 6e 20 28 77 68 69 63 68 0a  urned on (which.
11990 2a 2a 20 69 74 20 69 73 20 62 79 20 64 65 66 61  ** it is by defa
119a0 75 6c 74 29 20 61 6e 64 20 73 6f 20 74 68 65 20  ult) and so the 
119b0 6d 65 74 68 6f 64 73 20 61 72 65 20 61 75 74 6f  methods are auto
119c0 6d 61 74 69 63 61 6c 6c 79 20 73 65 72 69 61 6c  matically serial
119d0 69 7a 65 64 2e 0a 2a 2a 20 48 6f 77 65 76 65 72  ized..** However
119e0 2c 20 69 66 20 5b 53 51 4c 49 54 45 5f 43 4f 4e  , if [SQLITE_CON
119f0 46 49 47 5f 4d 45 4d 53 54 41 54 55 53 5d 20 69  FIG_MEMSTATUS] i
11a00 73 20 64 69 73 61 62 6c 65 64 2c 20 74 68 65 6e  s disabled, then
11a10 20 74 68 65 20 6f 74 68 65 72 0a 2a 2a 20 6d 65   the other.** me
11a20 74 68 6f 64 73 20 6d 75 73 74 20 62 65 20 74 68  thods must be th
11a30 72 65 61 64 73 61 66 65 20 6f 72 20 65 6c 73 65  readsafe or else
11a40 20 6d 61 6b 65 20 74 68 65 69 72 20 6f 77 6e 20   make their own 
11a50 61 72 72 61 6e 67 65 6d 65 6e 74 73 20 66 6f 72  arrangements for
11a60 0a 2a 2a 20 73 65 72 69 61 6c 69 7a 61 74 69 6f  .** serializatio
11a70 6e 2e 0a 2a 2a 0a 2a 2a 20 53 51 4c 69 74 65 20  n..**.** SQLite 
11a80 77 69 6c 6c 20 6e 65 76 65 72 20 69 6e 76 6f 6b  will never invok
11a90 65 20 78 49 6e 69 74 28 29 20 6d 6f 72 65 20 74  e xInit() more t
11aa0 68 61 6e 20 6f 6e 63 65 20 77 69 74 68 6f 75 74  han once without
11ab0 20 61 6e 20 69 6e 74 65 72 76 65 6e 69 6e 67 0a   an intervening.
11ac0 2a 2a 20 63 61 6c 6c 20 74 6f 20 78 53 68 75 74  ** call to xShut
11ad0 64 6f 77 6e 28 29 2e 0a 2a 2f 0a 74 79 70 65 64  down()..*/.typed
11ae0 65 66 20 73 74 72 75 63 74 20 73 71 6c 69 74 65  ef struct sqlite
11af0 33 5f 6d 65 6d 5f 6d 65 74 68 6f 64 73 20 73 71  3_mem_methods sq
11b00 6c 69 74 65 33 5f 6d 65 6d 5f 6d 65 74 68 6f 64  lite3_mem_method
11b10 73 3b 0a 73 74 72 75 63 74 20 73 71 6c 69 74 65  s;.struct sqlite
11b20 33 5f 6d 65 6d 5f 6d 65 74 68 6f 64 73 20 7b 0a  3_mem_methods {.
11b30 20 20 76 6f 69 64 20 2a 28 2a 78 4d 61 6c 6c 6f    void *(*xMallo
11b40 63 29 28 69 6e 74 29 3b 20 20 20 20 20 20 20 20  c)(int);        
11b50 20 2f 2a 20 4d 65 6d 6f 72 79 20 61 6c 6c 6f 63   /* Memory alloc
11b60 61 74 69 6f 6e 20 66 75 6e 63 74 69 6f 6e 20 2a  ation function *
11b70 2f 0a 20 20 76 6f 69 64 20 28 2a 78 46 72 65 65  /.  void (*xFree
11b80 29 28 76 6f 69 64 2a 29 3b 20 20 20 20 20 20 20  )(void*);       
11b90 20 20 20 2f 2a 20 46 72 65 65 20 61 20 70 72 69     /* Free a pri
11ba0 6f 72 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 2a 2f  or allocation */
11bb0 0a 20 20 76 6f 69 64 20 2a 28 2a 78 52 65 61 6c  .  void *(*xReal
11bc0 6c 6f 63 29 28 76 6f 69 64 2a 2c 69 6e 74 29 3b  loc)(void*,int);
11bd0 20 20 2f 2a 20 52 65 73 69 7a 65 20 61 6e 20 61    /* Resize an a
11be0 6c 6c 6f 63 61 74 69 6f 6e 20 2a 2f 0a 20 20 69  llocation */.  i
11bf0 6e 74 20 28 2a 78 53 69 7a 65 29 28 76 6f 69 64  nt (*xSize)(void
11c00 2a 29 3b 20 20 20 20 20 20 20 20 20 20 20 2f 2a  *);           /*
11c10 20 52 65 74 75 72 6e 20 74 68 65 20 73 69 7a 65   Return the size
11c20 20 6f 66 20 61 6e 20 61 6c 6c 6f 63 61 74 69 6f   of an allocatio
11c30 6e 20 2a 2f 0a 20 20 69 6e 74 20 28 2a 78 52 6f  n */.  int (*xRo
11c40 75 6e 64 75 70 29 28 69 6e 74 29 3b 20 20 20 20  undup)(int);    
11c50 20 20 20 20 20 20 2f 2a 20 52 6f 75 6e 64 20 75        /* Round u
11c60 70 20 72 65 71 75 65 73 74 20 73 69 7a 65 20 74  p request size t
11c70 6f 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 73 69 7a  o allocation siz
11c80 65 20 2a 2f 0a 20 20 69 6e 74 20 28 2a 78 49 6e  e */.  int (*xIn
11c90 69 74 29 28 76 6f 69 64 2a 29 3b 20 20 20 20 20  it)(void*);     
11ca0 20 20 20 20 20 20 2f 2a 20 49 6e 69 74 69 61 6c        /* Initial
11cb0 69 7a 65 20 74 68 65 20 6d 65 6d 6f 72 79 20 61  ize the memory a
11cc0 6c 6c 6f 63 61 74 6f 72 20 2a 2f 0a 20 20 76 6f  llocator */.  vo
11cd0 69 64 20 28 2a 78 53 68 75 74 64 6f 77 6e 29 28  id (*xShutdown)(
11ce0 76 6f 69 64 2a 29 3b 20 20 20 20 20 20 2f 2a 20  void*);      /* 
11cf0 44 65 69 6e 69 74 69 61 6c 69 7a 65 20 74 68 65  Deinitialize the
11d00 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f   memory allocato
11d10 72 20 2a 2f 0a 20 20 76 6f 69 64 20 2a 70 41 70  r */.  void *pAp
11d20 70 44 61 74 61 3b 20 20 20 20 20 20 20 20 20 20  pData;          
11d30 20 20 20 20 20 20 2f 2a 20 41 72 67 75 6d 65 6e        /* Argumen
11d40 74 20 74 6f 20 78 49 6e 69 74 28 29 20 61 6e 64  t to xInit() and
11d50 20 78 53 68 75 74 64 6f 77 6e 28 29 20 2a 2f 0a   xShutdown() */.
11d60 7d 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  };../*.** CAPI3R
11d70 45 46 3a 20 43 6f 6e 66 69 67 75 72 61 74 69 6f  EF: Configuratio
11d80 6e 20 4f 70 74 69 6f 6e 73 0a 2a 2a 20 4b 45 59  n Options.** KEY
11d90 57 4f 52 44 53 3a 20 7b 63 6f 6e 66 69 67 75 72  WORDS: {configur
11da0 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 7d 0a 2a 2a  ation option}.**
11db0 0a 2a 2a 20 54 68 65 73 65 20 63 6f 6e 73 74 61  .** These consta
11dc0 6e 74 73 20 61 72 65 20 74 68 65 20 61 76 61 69  nts are the avai
11dd0 6c 61 62 6c 65 20 69 6e 74 65 67 65 72 20 63 6f  lable integer co
11de0 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f 70 74 69  nfiguration opti
11df0 6f 6e 73 20 74 68 61 74 0a 2a 2a 20 63 61 6e 20  ons that.** can 
11e00 62 65 20 70 61 73 73 65 64 20 61 73 20 74 68 65  be passed as the
11e10 20 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20   first argument 
11e20 74 6f 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  to the [sqlite3_
11e30 63 6f 6e 66 69 67 28 29 5d 20 69 6e 74 65 72 66  config()] interf
11e40 61 63 65 2e 0a 2a 2a 0a 2a 2a 20 4e 65 77 20 63  ace..**.** New c
11e50 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f 70 74  onfiguration opt
11e60 69 6f 6e 73 20 6d 61 79 20 62 65 20 61 64 64 65  ions may be adde
11e70 64 20 69 6e 20 66 75 74 75 72 65 20 72 65 6c 65  d in future rele
11e80 61 73 65 73 20 6f 66 20 53 51 4c 69 74 65 2e 0a  ases of SQLite..
11e90 2a 2a 20 45 78 69 73 74 69 6e 67 20 63 6f 6e 66  ** Existing conf
11ea0 69 67 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e  iguration option
11eb0 73 20 6d 69 67 68 74 20 62 65 20 64 69 73 63 6f  s might be disco
11ec0 6e 74 69 6e 75 65 64 2e 20 20 41 70 70 6c 69 63  ntinued.  Applic
11ed0 61 74 69 6f 6e 73 0a 2a 2a 20 73 68 6f 75 6c 64  ations.** should
11ee0 20 63 68 65 63 6b 20 74 68 65 20 72 65 74 75 72   check the retur
11ef0 6e 20 63 6f 64 65 20 66 72 6f 6d 20 5b 73 71 6c  n code from [sql
11f00 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 5d 20 74  ite3_config()] t
11f10 6f 20 6d 61 6b 65 20 73 75 72 65 20 74 68 61 74  o make sure that
11f20 0a 2a 2a 20 74 68 65 20 63 61 6c 6c 20 77 6f 72  .** the call wor
11f30 6b 65 64 2e 20 20 54 68 65 20 5b 73 71 6c 69 74  ked.  The [sqlit
11f40 65 33 5f 63 6f 6e 66 69 67 28 29 5d 20 69 6e 74  e3_config()] int
11f50 65 72 66 61 63 65 20 77 69 6c 6c 20 72 65 74 75  erface will retu
11f60 72 6e 20 61 0a 2a 2a 20 6e 6f 6e 2d 7a 65 72 6f  rn a.** non-zero
11f70 20 5b 65 72 72 6f 72 20 63 6f 64 65 5d 20 69 66   [error code] if
11f80 20 61 20 64 69 73 63 6f 6e 74 69 6e 75 65 64 20   a discontinued 
11f90 6f 72 20 75 6e 73 75 70 70 6f 72 74 65 64 20 63  or unsupported c
11fa0 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f 70 74  onfiguration opt
11fb0 69 6f 6e 0a 2a 2a 20 69 73 20 69 6e 76 6f 6b 65  ion.** is invoke
11fc0 64 2e 0a 2a 2a 0a 2a 2a 20 3c 64 6c 3e 0a 2a 2a  d..**.** <dl>.**
11fd0 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47   [[SQLITE_CONFIG
11fe0 5f 53 49 4e 47 4c 45 54 48 52 45 41 44 5d 5d 20  _SINGLETHREAD]] 
11ff0 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49  <dt>SQLITE_CONFI
12000 47 5f 53 49 4e 47 4c 45 54 48 52 45 41 44 3c 2f  G_SINGLETHREAD</
12010 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65 72 65  dt>.** <dd>There
12020 20 61 72 65 20 6e 6f 20 61 72 67 75 6d 65 6e 74   are no argument
12030 73 20 74 6f 20 74 68 69 73 20 6f 70 74 69 6f 6e  s to this option
12040 2e 20 20 5e 54 68 69 73 20 6f 70 74 69 6f 6e 20  .  ^This option 
12050 73 65 74 73 20 74 68 65 0a 2a 2a 20 5b 74 68 72  sets the.** [thr
12060 65 61 64 69 6e 67 20 6d 6f 64 65 5d 20 74 6f 20  eading mode] to 
12070 53 69 6e 67 6c 65 2d 74 68 72 65 61 64 2e 20 20  Single-thread.  
12080 49 6e 20 6f 74 68 65 72 20 77 6f 72 64 73 2c 20  In other words, 
12090 69 74 20 64 69 73 61 62 6c 65 73 0a 2a 2a 20 61  it disables.** a
120a0 6c 6c 20 6d 75 74 65 78 69 6e 67 20 61 6e 64 20  ll mutexing and 
120b0 70 75 74 73 20 53 51 4c 69 74 65 20 69 6e 74 6f  puts SQLite into
120c0 20 61 20 6d 6f 64 65 20 77 68 65 72 65 20 69 74   a mode where it
120d0 20 63 61 6e 20 6f 6e 6c 79 20 62 65 20 75 73 65   can only be use
120e0 64 0a 2a 2a 20 62 79 20 61 20 73 69 6e 67 6c 65  d.** by a single
120f0 20 74 68 72 65 61 64 2e 20 20 20 5e 49 66 20 53   thread.   ^If S
12100 51 4c 69 74 65 20 69 73 20 63 6f 6d 70 69 6c 65  QLite is compile
12110 64 20 77 69 74 68 0a 2a 2a 20 74 68 65 20 5b 53  d with.** the [S
12120 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46 45  QLITE_THREADSAFE
12130 20 7c 20 53 51 4c 49 54 45 5f 54 48 52 45 41 44   | SQLITE_THREAD
12140 53 41 46 45 3d 30 5d 20 63 6f 6d 70 69 6c 65 2d  SAFE=0] compile-
12150 74 69 6d 65 20 6f 70 74 69 6f 6e 20 74 68 65 6e  time option then
12160 0a 2a 2a 20 69 74 20 69 73 20 6e 6f 74 20 70 6f  .** it is not po
12170 73 73 69 62 6c 65 20 74 6f 20 63 68 61 6e 67 65  ssible to change
12180 20 74 68 65 20 5b 74 68 72 65 61 64 69 6e 67 20   the [threading 
12190 6d 6f 64 65 5d 20 66 72 6f 6d 20 69 74 73 20 64  mode] from its d
121a0 65 66 61 75 6c 74 0a 2a 2a 20 76 61 6c 75 65 20  efault.** value 
121b0 6f 66 20 53 69 6e 67 6c 65 2d 74 68 72 65 61 64  of Single-thread
121c0 20 61 6e 64 20 73 6f 20 5b 73 71 6c 69 74 65 33   and so [sqlite3
121d0 5f 63 6f 6e 66 69 67 28 29 5d 20 77 69 6c 6c 20  _config()] will 
121e0 72 65 74 75 72 6e 20 0a 2a 2a 20 5b 53 51 4c 49  return .** [SQLI
121f0 54 45 5f 45 52 52 4f 52 5d 20 69 66 20 63 61 6c  TE_ERROR] if cal
12200 6c 65 64 20 77 69 74 68 20 74 68 65 20 53 51 4c  led with the SQL
12210 49 54 45 5f 43 4f 4e 46 49 47 5f 53 49 4e 47 4c  ITE_CONFIG_SINGL
12220 45 54 48 52 45 41 44 0a 2a 2a 20 63 6f 6e 66 69  ETHREAD.** confi
12230 67 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 2e  guration option.
12240 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51  </dd>.**.** [[SQ
12250 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 55 4c 54  LITE_CONFIG_MULT
12260 49 54 48 52 45 41 44 5d 5d 20 3c 64 74 3e 53 51  ITHREAD]] <dt>SQ
12270 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 55 4c 54  LITE_CONFIG_MULT
12280 49 54 48 52 45 41 44 3c 2f 64 74 3e 0a 2a 2a 20  ITHREAD</dt>.** 
12290 3c 64 64 3e 54 68 65 72 65 20 61 72 65 20 6e 6f  <dd>There are no
122a0 20 61 72 67 75 6d 65 6e 74 73 20 74 6f 20 74 68   arguments to th
122b0 69 73 20 6f 70 74 69 6f 6e 2e 20 20 5e 54 68 69  is option.  ^Thi
122c0 73 20 6f 70 74 69 6f 6e 20 73 65 74 73 20 74 68  s option sets th
122d0 65 0a 2a 2a 20 5b 74 68 72 65 61 64 69 6e 67 20  e.** [threading 
122e0 6d 6f 64 65 5d 20 74 6f 20 4d 75 6c 74 69 2d 74  mode] to Multi-t
122f0 68 72 65 61 64 2e 20 20 49 6e 20 6f 74 68 65 72  hread.  In other
12300 20 77 6f 72 64 73 2c 20 69 74 20 64 69 73 61 62   words, it disab
12310 6c 65 73 0a 2a 2a 20 6d 75 74 65 78 69 6e 67 20  les.** mutexing 
12320 6f 6e 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e  on [database con
12330 6e 65 63 74 69 6f 6e 5d 20 61 6e 64 20 5b 70 72  nection] and [pr
12340 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
12350 5d 20 6f 62 6a 65 63 74 73 2e 0a 2a 2a 20 54 68  ] objects..** Th
12360 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 69 73  e application is
12370 20 72 65 73 70 6f 6e 73 69 62 6c 65 20 66 6f 72   responsible for
12380 20 73 65 72 69 61 6c 69 7a 69 6e 67 20 61 63 63   serializing acc
12390 65 73 73 20 74 6f 0a 2a 2a 20 5b 64 61 74 61 62  ess to.** [datab
123a0 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 73 5d  ase connections]
123b0 20 61 6e 64 20 5b 70 72 65 70 61 72 65 64 20 73   and [prepared s
123c0 74 61 74 65 6d 65 6e 74 73 5d 2e 20 20 42 75 74  tatements].  But
123d0 20 6f 74 68 65 72 20 6d 75 74 65 78 65 73 0a 2a   other mutexes.*
123e0 2a 20 61 72 65 20 65 6e 61 62 6c 65 64 20 73 6f  * are enabled so
123f0 20 74 68 61 74 20 53 51 4c 69 74 65 20 77 69 6c   that SQLite wil
12400 6c 20 62 65 20 73 61 66 65 20 74 6f 20 75 73 65  l be safe to use
12410 20 69 6e 20 61 20 6d 75 6c 74 69 2d 74 68 72 65   in a multi-thre
12420 61 64 65 64 0a 2a 2a 20 65 6e 76 69 72 6f 6e 6d  aded.** environm
12430 65 6e 74 20 61 73 20 6c 6f 6e 67 20 61 73 20 6e  ent as long as n
12440 6f 20 74 77 6f 20 74 68 72 65 61 64 73 20 61 74  o two threads at
12450 74 65 6d 70 74 20 74 6f 20 75 73 65 20 74 68 65  tempt to use the
12460 20 73 61 6d 65 0a 2a 2a 20 5b 64 61 74 61 62 61   same.** [databa
12470 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 61  se connection] a
12480 74 20 74 68 65 20 73 61 6d 65 20 74 69 6d 65 2e  t the same time.
12490 20 20 5e 49 66 20 53 51 4c 69 74 65 20 69 73 20    ^If SQLite is 
124a0 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 0a 2a 2a  compiled with.**
124b0 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 54 48 52   the [SQLITE_THR
124c0 45 41 44 53 41 46 45 20 7c 20 53 51 4c 49 54 45  EADSAFE | SQLITE
124d0 5f 54 48 52 45 41 44 53 41 46 45 3d 30 5d 20 63  _THREADSAFE=0] c
124e0 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69  ompile-time opti
124f0 6f 6e 20 74 68 65 6e 0a 2a 2a 20 69 74 20 69 73  on then.** it is
12500 20 6e 6f 74 20 70 6f 73 73 69 62 6c 65 20 74 6f   not possible to
12510 20 73 65 74 20 74 68 65 20 4d 75 6c 74 69 2d 74   set the Multi-t
12520 68 72 65 61 64 20 5b 74 68 72 65 61 64 69 6e 67  hread [threading
12530 20 6d 6f 64 65 5d 20 61 6e 64 0a 2a 2a 20 5b 73   mode] and.** [s
12540 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 5d  qlite3_config()]
12550 20 77 69 6c 6c 20 72 65 74 75 72 6e 20 5b 53 51   will return [SQ
12560 4c 49 54 45 5f 45 52 52 4f 52 5d 20 69 66 20 63  LITE_ERROR] if c
12570 61 6c 6c 65 64 20 77 69 74 68 20 74 68 65 0a 2a  alled with the.*
12580 2a 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  * SQLITE_CONFIG_
12590 4d 55 4c 54 49 54 48 52 45 41 44 20 63 6f 6e 66  MULTITHREAD conf
125a0 69 67 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e  iguration option
125b0 2e 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53  .</dd>.**.** [[S
125c0 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53 45 52  QLITE_CONFIG_SER
125d0 49 41 4c 49 5a 45 44 5d 5d 20 3c 64 74 3e 53 51  IALIZED]] <dt>SQ
125e0 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53 45 52 49  LITE_CONFIG_SERI
125f0 41 4c 49 5a 45 44 3c 2f 64 74 3e 0a 2a 2a 20 3c  ALIZED</dt>.** <
12600 64 64 3e 54 68 65 72 65 20 61 72 65 20 6e 6f 20  dd>There are no 
12610 61 72 67 75 6d 65 6e 74 73 20 74 6f 20 74 68 69  arguments to thi
12620 73 20 6f 70 74 69 6f 6e 2e 20 20 5e 54 68 69 73  s option.  ^This
12630 20 6f 70 74 69 6f 6e 20 73 65 74 73 20 74 68 65   option sets the
12640 0a 2a 2a 20 5b 74 68 72 65 61 64 69 6e 67 20 6d  .** [threading m
12650 6f 64 65 5d 20 74 6f 20 53 65 72 69 61 6c 69 7a  ode] to Serializ
12660 65 64 2e 20 49 6e 20 6f 74 68 65 72 20 77 6f 72  ed. In other wor
12670 64 73 2c 20 74 68 69 73 20 6f 70 74 69 6f 6e 20  ds, this option 
12680 65 6e 61 62 6c 65 73 0a 2a 2a 20 61 6c 6c 20 6d  enables.** all m
12690 75 74 65 78 65 73 20 69 6e 63 6c 75 64 69 6e 67  utexes including
126a0 20 74 68 65 20 72 65 63 75 72 73 69 76 65 0a 2a   the recursive.*
126b0 2a 20 6d 75 74 65 78 65 73 20 6f 6e 20 5b 64 61  * mutexes on [da
126c0 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
126d0 6e 5d 20 61 6e 64 20 5b 70 72 65 70 61 72 65 64  n] and [prepared
126e0 20 73 74 61 74 65 6d 65 6e 74 5d 20 6f 62 6a 65   statement] obje
126f0 63 74 73 2e 0a 2a 2a 20 49 6e 20 74 68 69 73 20  cts..** In this 
12700 6d 6f 64 65 20 28 77 68 69 63 68 20 69 73 20 74  mode (which is t
12710 68 65 20 64 65 66 61 75 6c 74 20 77 68 65 6e 20  he default when 
12720 53 51 4c 69 74 65 20 69 73 20 63 6f 6d 70 69 6c  SQLite is compil
12730 65 64 20 77 69 74 68 0a 2a 2a 20 5b 53 51 4c 49  ed with.** [SQLI
12740 54 45 5f 54 48 52 45 41 44 53 41 46 45 3d 31 5d  TE_THREADSAFE=1]
12750 29 20 74 68 65 20 53 51 4c 69 74 65 20 6c 69 62  ) the SQLite lib
12760 72 61 72 79 20 77 69 6c 6c 20 69 74 73 65 6c 66  rary will itself
12770 20 73 65 72 69 61 6c 69 7a 65 20 61 63 63 65 73   serialize acces
12780 73 0a 2a 2a 20 74 6f 20 5b 64 61 74 61 62 61 73  s.** to [databas
12790 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 73 5d 20 61  e connections] a
127a0 6e 64 20 5b 70 72 65 70 61 72 65 64 20 73 74 61  nd [prepared sta
127b0 74 65 6d 65 6e 74 73 5d 20 73 6f 20 74 68 61 74  tements] so that
127c0 20 74 68 65 0a 2a 2a 20 61 70 70 6c 69 63 61 74   the.** applicat
127d0 69 6f 6e 20 69 73 20 66 72 65 65 20 74 6f 20 75  ion is free to u
127e0 73 65 20 74 68 65 20 73 61 6d 65 20 5b 64 61 74  se the same [dat
127f0 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
12800 5d 20 6f 72 20 74 68 65 0a 2a 2a 20 73 61 6d 65  ] or the.** same
12810 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65   [prepared state
12820 6d 65 6e 74 5d 20 69 6e 20 64 69 66 66 65 72 65  ment] in differe
12830 6e 74 20 74 68 72 65 61 64 73 20 61 74 20 74 68  nt threads at th
12840 65 20 73 61 6d 65 20 74 69 6d 65 2e 0a 2a 2a 20  e same time..** 
12850 5e 49 66 20 53 51 4c 69 74 65 20 69 73 20 63 6f  ^If SQLite is co
12860 6d 70 69 6c 65 64 20 77 69 74 68 0a 2a 2a 20 74  mpiled with.** t
12870 68 65 20 5b 53 51 4c 49 54 45 5f 54 48 52 45 41  he [SQLITE_THREA
12880 44 53 41 46 45 20 7c 20 53 51 4c 49 54 45 5f 54  DSAFE | SQLITE_T
12890 48 52 45 41 44 53 41 46 45 3d 30 5d 20 63 6f 6d  HREADSAFE=0] com
128a0 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e  pile-time option
128b0 20 74 68 65 6e 0a 2a 2a 20 69 74 20 69 73 20 6e   then.** it is n
128c0 6f 74 20 70 6f 73 73 69 62 6c 65 20 74 6f 20 73  ot possible to s
128d0 65 74 20 74 68 65 20 53 65 72 69 61 6c 69 7a 65  et the Serialize
128e0 64 20 5b 74 68 72 65 61 64 69 6e 67 20 6d 6f 64  d [threading mod
128f0 65 5d 20 61 6e 64 0a 2a 2a 20 5b 73 71 6c 69 74  e] and.** [sqlit
12900 65 33 5f 63 6f 6e 66 69 67 28 29 5d 20 77 69 6c  e3_config()] wil
12910 6c 20 72 65 74 75 72 6e 20 5b 53 51 4c 49 54 45  l return [SQLITE
12920 5f 45 52 52 4f 52 5d 20 69 66 20 63 61 6c 6c 65  _ERROR] if calle
12930 64 20 77 69 74 68 20 74 68 65 0a 2a 2a 20 53 51  d with the.** SQ
12940 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53 45 52 49  LITE_CONFIG_SERI
12950 41 4c 49 5a 45 44 20 63 6f 6e 66 69 67 75 72 61  ALIZED configura
12960 74 69 6f 6e 20 6f 70 74 69 6f 6e 2e 3c 2f 64 64  tion option.</dd
12970 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45  >.**.** [[SQLITE
12980 5f 43 4f 4e 46 49 47 5f 4d 41 4c 4c 4f 43 5d 5d  _CONFIG_MALLOC]]
12990 20 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46   <dt>SQLITE_CONF
129a0 49 47 5f 4d 41 4c 4c 4f 43 3c 2f 64 74 3e 0a 2a  IG_MALLOC</dt>.*
129b0 2a 20 3c 64 64 3e 20 5e 28 54 68 65 20 53 51 4c  * <dd> ^(The SQL
129c0 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 41 4c 4c 4f  ITE_CONFIG_MALLO
129d0 43 20 6f 70 74 69 6f 6e 20 74 61 6b 65 73 20 61  C option takes a
129e0 20 73 69 6e 67 6c 65 20 61 72 67 75 6d 65 6e 74   single argument
129f0 20 77 68 69 63 68 20 69 73 20 0a 2a 2a 20 61 20   which is .** a 
12a00 70 6f 69 6e 74 65 72 20 74 6f 20 61 6e 20 69 6e  pointer to an in
12a10 73 74 61 6e 63 65 20 6f 66 20 74 68 65 20 5b 73  stance of the [s
12a20 71 6c 69 74 65 33 5f 6d 65 6d 5f 6d 65 74 68 6f  qlite3_mem_metho
12a30 64 73 5d 20 73 74 72 75 63 74 75 72 65 2e 0a 2a  ds] structure..*
12a40 2a 20 54 68 65 20 61 72 67 75 6d 65 6e 74 20 73  * The argument s
12a50 70 65 63 69 66 69 65 73 0a 2a 2a 20 61 6c 74 65  pecifies.** alte
12a60 72 6e 61 74 69 76 65 20 6c 6f 77 2d 6c 65 76 65  rnative low-leve
12a70 6c 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74  l memory allocat
12a80 69 6f 6e 20 72 6f 75 74 69 6e 65 73 20 74 6f 20  ion routines to 
12a90 62 65 20 75 73 65 64 20 69 6e 20 70 6c 61 63 65  be used in place
12aa0 20 6f 66 0a 2a 2a 20 74 68 65 20 6d 65 6d 6f 72   of.** the memor
12ab0 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 72 6f 75  y allocation rou
12ac0 74 69 6e 65 73 20 62 75 69 6c 74 20 69 6e 74 6f  tines built into
12ad0 20 53 51 4c 69 74 65 2e 29 5e 20 5e 53 51 4c 69   SQLite.)^ ^SQLi
12ae0 74 65 20 6d 61 6b 65 73 0a 2a 2a 20 69 74 73 20  te makes.** its 
12af0 6f 77 6e 20 70 72 69 76 61 74 65 20 63 6f 70 79  own private copy
12b00 20 6f 66 20 74 68 65 20 63 6f 6e 74 65 6e 74 20   of the content 
12b10 6f 66 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  of the [sqlite3_
12b20 6d 65 6d 5f 6d 65 74 68 6f 64 73 5d 20 73 74 72  mem_methods] str
12b30 75 63 74 75 72 65 0a 2a 2a 20 62 65 66 6f 72 65  ucture.** before
12b40 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 63 6f   the [sqlite3_co
12b50 6e 66 69 67 28 29 5d 20 63 61 6c 6c 20 72 65 74  nfig()] call ret
12b60 75 72 6e 73 2e 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a  urns.</dd>.**.**
12b70 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47   [[SQLITE_CONFIG
12b80 5f 47 45 54 4d 41 4c 4c 4f 43 5d 5d 20 3c 64 74  _GETMALLOC]] <dt
12b90 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 47  >SQLITE_CONFIG_G
12ba0 45 54 4d 41 4c 4c 4f 43 3c 2f 64 74 3e 0a 2a 2a  ETMALLOC</dt>.**
12bb0 20 3c 64 64 3e 20 5e 28 54 68 65 20 53 51 4c 49   <dd> ^(The SQLI
12bc0 54 45 5f 43 4f 4e 46 49 47 5f 47 45 54 4d 41 4c  TE_CONFIG_GETMAL
12bd0 4c 4f 43 20 6f 70 74 69 6f 6e 20 74 61 6b 65 73  LOC option takes
12be0 20 61 20 73 69 6e 67 6c 65 20 61 72 67 75 6d 65   a single argume
12bf0 6e 74 20 77 68 69 63 68 0a 2a 2a 20 69 73 20 61  nt which.** is a
12c00 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 6e 20 69   pointer to an i
12c10 6e 73 74 61 6e 63 65 20 6f 66 20 74 68 65 20 5b  nstance of the [
12c20 73 71 6c 69 74 65 33 5f 6d 65 6d 5f 6d 65 74 68  sqlite3_mem_meth
12c30 6f 64 73 5d 20 73 74 72 75 63 74 75 72 65 2e 0a  ods] structure..
12c40 2a 2a 20 54 68 65 20 5b 73 71 6c 69 74 65 33 5f  ** The [sqlite3_
12c50 6d 65 6d 5f 6d 65 74 68 6f 64 73 5d 0a 2a 2a 20  mem_methods].** 
12c60 73 74 72 75 63 74 75 72 65 20 69 73 20 66 69 6c  structure is fil
12c70 6c 65 64 20 77 69 74 68 20 74 68 65 20 63 75 72  led with the cur
12c80 72 65 6e 74 6c 79 20 64 65 66 69 6e 65 64 20 6d  rently defined m
12c90 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e  emory allocation
12ca0 20 72 6f 75 74 69 6e 65 73 2e 29 5e 0a 2a 2a 20   routines.)^.** 
12cb0 54 68 69 73 20 6f 70 74 69 6f 6e 20 63 61 6e 20  This option can 
12cc0 62 65 20 75 73 65 64 20 74 6f 20 6f 76 65 72 6c  be used to overl
12cd0 6f 61 64 20 74 68 65 20 64 65 66 61 75 6c 74 20  oad the default 
12ce0 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f  memory allocatio
12cf0 6e 0a 2a 2a 20 72 6f 75 74 69 6e 65 73 20 77 69  n.** routines wi
12d00 74 68 20 61 20 77 72 61 70 70 65 72 20 74 68 61  th a wrapper tha
12d10 74 20 73 69 6d 75 6c 61 74 69 6f 6e 73 20 6d 65  t simulations me
12d20 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20  mory allocation 
12d30 66 61 69 6c 75 72 65 20 6f 72 0a 2a 2a 20 74 72  failure or.** tr
12d40 61 63 6b 73 20 6d 65 6d 6f 72 79 20 75 73 61 67  acks memory usag
12d50 65 2c 20 66 6f 72 20 65 78 61 6d 70 6c 65 2e 20  e, for example. 
12d60 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51  </dd>.**.** [[SQ
12d70 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 45 4d 53  LITE_CONFIG_MEMS
12d80 54 41 54 55 53 5d 5d 20 3c 64 74 3e 53 51 4c 49  TATUS]] <dt>SQLI
12d90 54 45 5f 43 4f 4e 46 49 47 5f 4d 45 4d 53 54 41  TE_CONFIG_MEMSTA
12da0 54 55 53 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e  TUS</dt>.** <dd>
12db0 20 5e 54 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e   ^The SQLITE_CON
12dc0 46 49 47 5f 4d 45 4d 53 54 41 54 55 53 20 6f 70  FIG_MEMSTATUS op
12dd0 74 69 6f 6e 20 74 61 6b 65 73 20 73 69 6e 67 6c  tion takes singl
12de0 65 20 61 72 67 75 6d 65 6e 74 20 6f 66 20 74 79  e argument of ty
12df0 70 65 20 69 6e 74 2c 0a 2a 2a 20 69 6e 74 65 72  pe int,.** inter
12e00 70 72 65 74 65 64 20 61 73 20 61 20 62 6f 6f 6c  preted as a bool
12e10 65 61 6e 2c 20 77 68 69 63 68 20 65 6e 61 62 6c  ean, which enabl
12e20 65 73 20 6f 72 20 64 69 73 61 62 6c 65 73 20 74  es or disables t
12e30 68 65 20 63 6f 6c 6c 65 63 74 69 6f 6e 20 6f 66  he collection of
12e40 0a 2a 2a 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63  .** memory alloc
12e50 61 74 69 6f 6e 20 73 74 61 74 69 73 74 69 63 73  ation statistics
12e60 2e 20 5e 28 57 68 65 6e 20 6d 65 6d 6f 72 79 20  . ^(When memory 
12e70 61 6c 6c 6f 63 61 74 69 6f 6e 20 73 74 61 74 69  allocation stati
12e80 73 74 69 63 73 20 61 72 65 0a 2a 2a 20 64 69 73  stics are.** dis
12e90 61 62 6c 65 64 2c 20 74 68 65 20 66 6f 6c 6c 6f  abled, the follo
12ea0 77 69 6e 67 20 53 51 4c 69 74 65 20 69 6e 74 65  wing SQLite inte
12eb0 72 66 61 63 65 73 20 62 65 63 6f 6d 65 20 6e 6f  rfaces become no
12ec0 6e 2d 6f 70 65 72 61 74 69 6f 6e 61 6c 3a 0a 2a  n-operational:.*
12ed0 2a 20 20 20 3c 75 6c 3e 0a 2a 2a 20 20 20 3c 6c  *   <ul>.**   <l
12ee0 69 3e 20 5b 73 71 6c 69 74 65 33 5f 6d 65 6d 6f  i> [sqlite3_memo
12ef0 72 79 5f 75 73 65 64 28 29 5d 0a 2a 2a 20 20 20  ry_used()].**   
12f00 3c 6c 69 3e 20 5b 73 71 6c 69 74 65 33 5f 6d 65  <li> [sqlite3_me
12f10 6d 6f 72 79 5f 68 69 67 68 77 61 74 65 72 28 29  mory_highwater()
12f20 5d 0a 2a 2a 20 20 20 3c 6c 69 3e 20 5b 73 71 6c  ].**   <li> [sql
12f30 69 74 65 33 5f 73 6f 66 74 5f 68 65 61 70 5f 6c  ite3_soft_heap_l
12f40 69 6d 69 74 36 34 28 29 5d 0a 2a 2a 20 20 20 3c  imit64()].**   <
12f50 6c 69 3e 20 5b 73 71 6c 69 74 65 33 5f 73 74 61  li> [sqlite3_sta
12f60 74 75 73 36 34 28 29 5d 0a 2a 2a 20 20 20 3c 2f  tus64()].**   </
12f70 75 6c 3e 29 5e 0a 2a 2a 20 5e 4d 65 6d 6f 72 79  ul>)^.** ^Memory
12f80 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 73 74 61 74   allocation stat
12f90 69 73 74 69 63 73 20 61 72 65 20 65 6e 61 62 6c  istics are enabl
12fa0 65 64 20 62 79 20 64 65 66 61 75 6c 74 20 75 6e  ed by default un
12fb0 6c 65 73 73 20 53 51 4c 69 74 65 20 69 73 0a 2a  less SQLite is.*
12fc0 2a 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 20  * compiled with 
12fd0 5b 53 51 4c 49 54 45 5f 44 45 46 41 55 4c 54 5f  [SQLITE_DEFAULT_
12fe0 4d 45 4d 53 54 41 54 55 53 5d 3d 30 20 69 6e 20  MEMSTATUS]=0 in 
12ff0 77 68 69 63 68 20 63 61 73 65 20 6d 65 6d 6f 72  which case memor
13000 79 0a 2a 2a 20 61 6c 6c 6f 63 61 74 69 6f 6e 20  y.** allocation 
13010 73 74 61 74 69 73 74 69 63 73 20 61 72 65 20 64  statistics are d
13020 69 73 61 62 6c 65 64 20 62 79 20 64 65 66 61 75  isabled by defau
13030 6c 74 2e 0a 2a 2a 20 3c 2f 64 64 3e 0a 2a 2a 0a  lt..** </dd>.**.
13040 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46  ** [[SQLITE_CONF
13050 49 47 5f 53 43 52 41 54 43 48 5d 5d 20 3c 64 74  IG_SCRATCH]] <dt
13060 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53  >SQLITE_CONFIG_S
13070 43 52 41 54 43 48 3c 2f 64 74 3e 0a 2a 2a 20 3c  CRATCH</dt>.** <
13080 64 64 3e 20 5e 54 68 65 20 53 51 4c 49 54 45 5f  dd> ^The SQLITE_
13090 43 4f 4e 46 49 47 5f 53 43 52 41 54 43 48 20 6f  CONFIG_SCRATCH o
130a0 70 74 69 6f 6e 20 73 70 65 63 69 66 69 65 73 20  ption specifies 
130b0 61 20 73 74 61 74 69 63 20 6d 65 6d 6f 72 79 20  a static memory 
130c0 62 75 66 66 65 72 0a 2a 2a 20 74 68 61 74 20 53  buffer.** that S
130d0 51 4c 69 74 65 20 63 61 6e 20 75 73 65 20 66 6f  QLite can use fo
130e0 72 20 73 63 72 61 74 63 68 20 6d 65 6d 6f 72 79  r scratch memory
130f0 2e 20 20 5e 28 54 68 65 72 65 20 61 72 65 20 74  .  ^(There are t
13100 68 72 65 65 20 61 72 67 75 6d 65 6e 74 73 0a 2a  hree arguments.*
13110 2a 20 74 6f 20 53 51 4c 49 54 45 5f 43 4f 4e 46  * to SQLITE_CONF
13120 49 47 5f 53 43 52 41 54 43 48 3a 20 20 41 20 70  IG_SCRATCH:  A p
13130 6f 69 6e 74 65 72 20 61 6e 20 38 2d 62 79 74 65  ointer an 8-byte
13140 0a 2a 2a 20 61 6c 69 67 6e 65 64 20 6d 65 6d 6f  .** aligned memo
13150 72 79 20 62 75 66 66 65 72 20 66 72 6f 6d 20 77  ry buffer from w
13160 68 69 63 68 20 74 68 65 20 73 63 72 61 74 63 68  hich the scratch
13170 20 61 6c 6c 6f 63 61 74 69 6f 6e 73 20 77 69 6c   allocations wil
13180 6c 20 62 65 0a 2a 2a 20 64 72 61 77 6e 2c 20 74  l be.** drawn, t
13190 68 65 20 73 69 7a 65 20 6f 66 20 65 61 63 68 20  he size of each 
131a0 73 63 72 61 74 63 68 20 61 6c 6c 6f 63 61 74 69  scratch allocati
131b0 6f 6e 20 28 73 7a 29 2c 0a 2a 2a 20 61 6e 64 20  on (sz),.** and 
131c0 74 68 65 20 6d 61 78 69 6d 75 6d 20 6e 75 6d 62  the maximum numb
131d0 65 72 20 6f 66 20 73 63 72 61 74 63 68 20 61 6c  er of scratch al
131e0 6c 6f 63 61 74 69 6f 6e 73 20 28 4e 29 2e 29 5e  locations (N).)^
131f0 0a 2a 2a 20 54 68 65 20 66 69 72 73 74 20 61 72  .** The first ar
13200 67 75 6d 65 6e 74 20 6d 75 73 74 20 62 65 20 61  gument must be a
13210 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 6e 20 38   pointer to an 8
13220 2d 62 79 74 65 20 61 6c 69 67 6e 65 64 20 62 75  -byte aligned bu
13230 66 66 65 72 0a 2a 2a 20 6f 66 20 61 74 20 6c 65  ffer.** of at le
13240 61 73 74 20 73 7a 2a 4e 20 62 79 74 65 73 20 6f  ast sz*N bytes o
13250 66 20 6d 65 6d 6f 72 79 2e 0a 2a 2a 20 5e 53 51  f memory..** ^SQ
13260 4c 69 74 65 20 77 69 6c 6c 20 6e 6f 74 20 75 73  Lite will not us
13270 65 20 6d 6f 72 65 20 74 68 61 6e 20 6f 6e 65 20  e more than one 
13280 73 63 72 61 74 63 68 20 62 75 66 66 65 72 73 20  scratch buffers 
13290 70 65 72 20 74 68 72 65 61 64 2e 0a 2a 2a 20 5e  per thread..** ^
132a0 53 51 4c 69 74 65 20 77 69 6c 6c 20 6e 65 76 65  SQLite will neve
132b0 72 20 72 65 71 75 65 73 74 20 61 20 73 63 72 61  r request a scra
132c0 74 63 68 20 62 75 66 66 65 72 20 74 68 61 74 20  tch buffer that 
132d0 69 73 20 6d 6f 72 65 20 74 68 61 6e 20 36 0a 2a  is more than 6.*
132e0 2a 20 74 69 6d 65 73 20 74 68 65 20 64 61 74 61  * times the data
132f0 62 61 73 65 20 70 61 67 65 20 73 69 7a 65 2e 0a  base page size..
13300 2a 2a 20 5e 49 66 20 53 51 4c 69 74 65 20 6e 65  ** ^If SQLite ne
13310 65 64 73 20 6e 65 65 64 73 20 61 64 64 69 74 69  eds needs additi
13320 6f 6e 61 6c 0a 2a 2a 20 73 63 72 61 74 63 68 20  onal.** scratch 
13330 6d 65 6d 6f 72 79 20 62 65 79 6f 6e 64 20 77 68  memory beyond wh
13340 61 74 20 69 73 20 70 72 6f 76 69 64 65 64 20 62  at is provided b
13350 79 20 74 68 69 73 20 63 6f 6e 66 69 67 75 72 61  y this configura
13360 74 69 6f 6e 20 6f 70 74 69 6f 6e 2c 20 74 68 65  tion option, the
13370 6e 20 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 6d  n .** [sqlite3_m
13380 61 6c 6c 6f 63 28 29 5d 20 77 69 6c 6c 20 62 65  alloc()] will be
13390 20 75 73 65 64 20 74 6f 20 6f 62 74 61 69 6e 20   used to obtain 
133a0 74 68 65 20 6d 65 6d 6f 72 79 20 6e 65 65 64 65  the memory neede
133b0 64 2e 3c 70 3e 0a 2a 2a 20 5e 57 68 65 6e 20 74  d.<p>.** ^When t
133c0 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 70  he application p
133d0 72 6f 76 69 64 65 73 20 61 6e 79 20 61 6d 6f 75  rovides any amou
133e0 6e 74 20 6f 66 20 73 63 72 61 74 63 68 20 6d 65  nt of scratch me
133f0 6d 6f 72 79 20 75 73 69 6e 67 0a 2a 2a 20 53 51  mory using.** SQ
13400 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53 43 52 41  LITE_CONFIG_SCRA
13410 54 43 48 2c 20 53 51 4c 69 74 65 20 61 76 6f 69  TCH, SQLite avoi
13420 64 73 20 75 6e 6e 65 63 65 73 73 61 72 79 20 6c  ds unnecessary l
13430 61 72 67 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  arge.** [sqlite3
13440 5f 6d 61 6c 6c 6f 63 7c 68 65 61 70 20 61 6c 6c  _malloc|heap all
13450 6f 63 61 74 69 6f 6e 73 5d 2e 0a 2a 2a 20 54 68  ocations]..** Th
13460 69 73 20 63 61 6e 20 68 65 6c 70 20 5b 52 6f 62  is can help [Rob
13470 73 6f 6e 20 70 72 6f 6f 66 7c 70 72 65 76 65 6e  son proof|preven
13480 74 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74  t memory allocat
13490 69 6f 6e 20 66 61 69 6c 75 72 65 73 5d 20 64 75  ion failures] du
134a0 65 20 74 6f 20 68 65 61 70 0a 2a 2a 20 66 72 61  e to heap.** fra
134b0 67 6d 65 6e 74 61 74 69 6f 6e 20 69 6e 20 6c 6f  gmentation in lo
134c0 77 2d 6d 65 6d 6f 72 79 20 65 6d 62 65 64 64 65  w-memory embedde
134d0 64 20 73 79 73 74 65 6d 73 2e 0a 2a 2a 20 3c 2f  d systems..** </
134e0 64 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49  dd>.**.** [[SQLI
134f0 54 45 5f 43 4f 4e 46 49 47 5f 50 41 47 45 43 41  TE_CONFIG_PAGECA
13500 43 48 45 5d 5d 20 3c 64 74 3e 53 51 4c 49 54 45  CHE]] <dt>SQLITE
13510 5f 43 4f 4e 46 49 47 5f 50 41 47 45 43 41 43 48  _CONFIG_PAGECACH
13520 45 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20 5e  E</dt>.** <dd> ^
13530 54 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49  The SQLITE_CONFI
13540 47 5f 50 41 47 45 43 41 43 48 45 20 6f 70 74 69  G_PAGECACHE opti
13550 6f 6e 20 73 70 65 63 69 66 69 65 73 20 61 20 6d  on specifies a m
13560 65 6d 6f 72 79 20 70 6f 6f 6c 0a 2a 2a 20 74 68  emory pool.** th
13570 61 74 20 53 51 4c 69 74 65 20 63 61 6e 20 75 73  at SQLite can us
13580 65 20 66 6f 72 20 74 68 65 20 64 61 74 61 62 61  e for the databa
13590 73 65 20 70 61 67 65 20 63 61 63 68 65 20 77 69  se page cache wi
135a0 74 68 20 74 68 65 20 64 65 66 61 75 6c 74 20 70  th the default p
135b0 61 67 65 0a 2a 2a 20 63 61 63 68 65 20 69 6d 70  age.** cache imp
135c0 6c 65 6d 65 6e 74 61 74 69 6f 6e 2e 20 20 0a 2a  lementation.  .*
135d0 2a 20 54 68 69 73 20 63 6f 6e 66 69 67 75 72 61  * This configura
135e0 74 69 6f 6e 20 6f 70 74 69 6f 6e 20 69 73 20 61  tion option is a
135f0 20 6e 6f 2d 6f 70 20 69 66 20 61 6e 20 61 70 70   no-op if an app
13600 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 20  lication-define 
13610 70 61 67 65 0a 2a 2a 20 63 61 63 68 65 20 69 6d  page.** cache im
13620 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 69 73 20  plementation is 
13630 6c 6f 61 64 65 64 20 75 73 69 6e 67 20 74 68 65  loaded using the
13640 20 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f   [SQLITE_CONFIG_
13650 50 43 41 43 48 45 32 5d 2e 0a 2a 2a 20 5e 54 68  PCACHE2]..** ^Th
13660 65 72 65 20 61 72 65 20 74 68 72 65 65 20 61 72  ere are three ar
13670 67 75 6d 65 6e 74 73 20 74 6f 20 53 51 4c 49 54  guments to SQLIT
13680 45 5f 43 4f 4e 46 49 47 5f 50 41 47 45 43 41 43  E_CONFIG_PAGECAC
13690 48 45 3a 20 41 20 70 6f 69 6e 74 65 72 20 74 6f  HE: A pointer to
136a0 0a 2a 2a 20 38 2d 62 79 74 65 20 61 6c 69 67 6e  .** 8-byte align
136b0 65 64 20 6d 65 6d 6f 72 79 20 28 70 4d 65 6d 29  ed memory (pMem)
136c0 2c 20 74 68 65 20 73 69 7a 65 20 6f 66 20 65 61  , the size of ea
136d0 63 68 20 70 61 67 65 20 63 61 63 68 65 20 6c 69  ch page cache li
136e0 6e 65 20 28 73 7a 29 2c 0a 2a 2a 20 61 6e 64 20  ne (sz),.** and 
136f0 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 63 61  the number of ca
13700 63 68 65 20 6c 69 6e 65 73 20 28 4e 29 2e 0a 2a  che lines (N)..*
13710 2a 20 54 68 65 20 73 7a 20 61 72 67 75 6d 65 6e  * The sz argumen
13720 74 20 73 68 6f 75 6c 64 20 62 65 20 74 68 65 20  t should be the 
13730 73 69 7a 65 20 6f 66 20 74 68 65 20 6c 61 72 67  size of the larg
13740 65 73 74 20 64 61 74 61 62 61 73 65 20 70 61 67  est database pag
13750 65 0a 2a 2a 20 28 61 20 70 6f 77 65 72 20 6f 66  e.** (a power of
13760 20 74 77 6f 20 62 65 74 77 65 65 6e 20 35 31 32   two between 512
13770 20 61 6e 64 20 36 35 35 33 36 29 20 70 6c 75 73   and 65536) plus
13780 20 73 6f 6d 65 20 65 78 74 72 61 20 62 79 74 65   some extra byte
13790 73 20 66 6f 72 20 65 61 63 68 0a 2a 2a 20 70 61  s for each.** pa
137a0 67 65 20 68 65 61 64 65 72 2e 20 20 5e 54 68 65  ge header.  ^The
137b0 20 6e 75 6d 62 65 72 20 6f 66 20 65 78 74 72 61   number of extra
137c0 20 62 79 74 65 73 20 6e 65 65 64 65 64 20 62 79   bytes needed by
137d0 20 74 68 65 20 70 61 67 65 20 68 65 61 64 65 72   the page header
137e0 0a 2a 2a 20 63 61 6e 20 62 65 20 64 65 74 65 72  .** can be deter
137f0 6d 69 6e 65 64 20 75 73 69 6e 67 20 5b 53 51 4c  mined using [SQL
13800 49 54 45 5f 43 4f 4e 46 49 47 5f 50 43 41 43 48  ITE_CONFIG_PCACH
13810 45 5f 48 44 52 53 5a 5d 2e 0a 2a 2a 20 5e 49 74  E_HDRSZ]..** ^It
13820 20 69 73 20 68 61 72 6d 6c 65 73 73 2c 20 61 70   is harmless, ap
13830 61 72 74 20 66 72 6f 6d 20 74 68 65 20 77 61 73  art from the was
13840 74 65 64 20 6d 65 6d 6f 72 79 2c 0a 2a 2a 20 66  ted memory,.** f
13850 6f 72 20 74 68 65 20 73 7a 20 70 61 72 61 6d 65  or the sz parame
13860 74 65 72 20 74 6f 20 62 65 20 6c 61 72 67 65 72  ter to be larger
13870 20 74 68 61 6e 20 6e 65 63 65 73 73 61 72 79 2e   than necessary.
13880 20 20 54 68 65 20 70 4d 65 6d 0a 2a 2a 20 61 72    The pMem.** ar
13890 67 75 6d 65 6e 74 20 6d 75 73 74 20 62 65 20 65  gument must be e
138a0 69 74 68 65 72 20 61 20 4e 55 4c 4c 20 70 6f 69  ither a NULL poi
138b0 6e 74 65 72 20 6f 72 20 61 20 70 6f 69 6e 74 65  nter or a pointe
138c0 72 20 74 6f 20 61 6e 20 38 2d 62 79 74 65 0a 2a  r to an 8-byte.*
138d0 2a 20 61 6c 69 67 6e 65 64 20 62 6c 6f 63 6b 20  * aligned block 
138e0 6f 66 20 6d 65 6d 6f 72 79 20 6f 66 20 61 74 20  of memory of at 
138f0 6c 65 61 73 74 20 73 7a 2a 4e 20 62 79 74 65 73  least sz*N bytes
13900 2c 20 6f 74 68 65 72 77 69 73 65 0a 2a 2a 20 73  , otherwise.** s
13910 75 62 73 65 71 75 65 6e 74 20 62 65 68 61 76 69  ubsequent behavi
13920 6f 72 20 69 73 20 75 6e 64 65 66 69 6e 65 64 2e  or is undefined.
13930 0a 2a 2a 20 5e 57 68 65 6e 20 70 4d 65 6d 20 69  .** ^When pMem i
13940 73 20 6e 6f 74 20 4e 55 4c 4c 2c 20 53 51 4c 69  s not NULL, SQLi
13950 74 65 20 77 69 6c 6c 20 73 74 72 69 76 65 20 74  te will strive t
13960 6f 20 75 73 65 20 74 68 65 20 6d 65 6d 6f 72 79  o use the memory
13970 20 70 72 6f 76 69 64 65 64 0a 2a 2a 20 74 6f 20   provided.** to 
13980 73 61 74 69 73 66 79 20 70 61 67 65 20 63 61 63  satisfy page cac
13990 68 65 20 6e 65 65 64 73 2c 20 66 61 6c 6c 69 6e  he needs, fallin
139a0 67 20 62 61 63 6b 20 74 6f 20 5b 73 71 6c 69 74  g back to [sqlit
139b0 65 33 5f 6d 61 6c 6c 6f 63 28 29 5d 20 69 66 0a  e3_malloc()] if.
139c0 2a 2a 20 61 20 70 61 67 65 20 63 61 63 68 65 20  ** a page cache 
139d0 6c 69 6e 65 20 69 73 20 6c 61 72 67 65 72 20 74  line is larger t
139e0 68 61 6e 20 73 7a 20 62 79 74 65 73 20 6f 72 20  han sz bytes or 
139f0 69 66 20 61 6c 6c 20 6f 66 20 74 68 65 20 70 4d  if all of the pM
13a00 65 6d 20 62 75 66 66 65 72 0a 2a 2a 20 69 73 20  em buffer.** is 
13a10 65 78 68 61 75 73 74 65 64 2e 0a 2a 2a 20 5e 49  exhausted..** ^I
13a20 66 20 70 4d 65 6d 20 69 73 20 4e 55 4c 4c 20 61  f pMem is NULL a
13a30 6e 64 20 4e 20 69 73 20 6e 6f 6e 2d 7a 65 72 6f  nd N is non-zero
13a40 2c 20 74 68 65 6e 20 65 61 63 68 20 64 61 74 61  , then each data
13a50 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 0a  base connection.
13a60 2a 2a 20 64 6f 65 73 20 61 6e 20 69 6e 69 74 69  ** does an initi
13a70 61 6c 20 62 75 6c 6b 20 61 6c 6c 6f 63 61 74 69  al bulk allocati
13a80 6f 6e 20 66 6f 72 20 70 61 67 65 20 63 61 63 68  on for page cach
13a90 65 20 6d 65 6d 6f 72 79 0a 2a 2a 20 66 72 6f 6d  e memory.** from
13aa0 20 5b 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63   [sqlite3_malloc
13ab0 28 29 5d 20 73 75 66 66 69 63 69 65 6e 74 20 66  ()] sufficient f
13ac0 6f 72 20 4e 20 63 61 63 68 65 20 6c 69 6e 65 73  or N cache lines
13ad0 20 69 66 20 4e 20 69 73 20 70 6f 73 69 74 69 76   if N is positiv
13ae0 65 20 6f 72 0a 2a 2a 20 6f 66 20 2d 31 30 32 34  e or.** of -1024
13af0 2a 4e 20 62 79 74 65 73 20 69 66 20 4e 20 69 73  *N bytes if N is
13b00 20 6e 65 67 61 74 69 76 65 2c 20 2e 20 5e 49 66   negative, . ^If
13b10 20 61 64 64 69 74 69 6f 6e 61 6c 0a 2a 2a 20 70   additional.** p
13b20 61 67 65 20 63 61 63 68 65 20 6d 65 6d 6f 72 79  age cache memory
13b30 20 69 73 20 6e 65 65 64 65 64 20 62 65 79 6f 6e   is needed beyon
13b40 64 20 77 68 61 74 20 69 73 20 70 72 6f 76 69 64  d what is provid
13b50 65 64 20 62 79 20 74 68 65 20 69 6e 69 74 69 61  ed by the initia
13b60 6c 0a 2a 2a 20 61 6c 6c 6f 63 61 74 69 6f 6e 2c  l.** allocation,
13b70 20 74 68 65 6e 20 53 51 4c 69 74 65 20 67 6f 65   then SQLite goe
13b80 73 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 6d 61  s to [sqlite3_ma
13b90 6c 6c 6f 63 28 29 5d 20 73 65 70 61 72 61 74 65  lloc()] separate
13ba0 6c 79 20 66 6f 72 20 65 61 63 68 0a 2a 2a 20 61  ly for each.** a
13bb0 64 64 69 74 69 6f 6e 61 6c 20 63 61 63 68 65 20  dditional cache 
13bc0 6c 69 6e 65 2e 20 3c 2f 64 64 3e 0a 2a 2a 0a 2a  line. </dd>.**.*
13bd0 2a 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49  * [[SQLITE_CONFI
13be0 47 5f 48 45 41 50 5d 5d 20 3c 64 74 3e 53 51 4c  G_HEAP]] <dt>SQL
13bf0 49 54 45 5f 43 4f 4e 46 49 47 5f 48 45 41 50 3c  ITE_CONFIG_HEAP<
13c00 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 54 68  /dt>.** <dd> ^Th
13c10 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  e SQLITE_CONFIG_
13c20 48 45 41 50 20 6f 70 74 69 6f 6e 20 73 70 65 63  HEAP option spec
13c30 69 66 69 65 73 20 61 20 73 74 61 74 69 63 20 6d  ifies a static m
13c40 65 6d 6f 72 79 20 62 75 66 66 65 72 20 0a 2a 2a  emory buffer .**
13c50 20 74 68 61 74 20 53 51 4c 69 74 65 20 77 69 6c   that SQLite wil
13c60 6c 20 75 73 65 20 66 6f 72 20 61 6c 6c 20 6f 66  l use for all of
13c70 20 69 74 73 20 64 79 6e 61 6d 69 63 20 6d 65 6d   its dynamic mem
13c80 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 6e  ory allocation n
13c90 65 65 64 73 0a 2a 2a 20 62 65 79 6f 6e 64 20 74  eeds.** beyond t
13ca0 68 6f 73 65 20 70 72 6f 76 69 64 65 64 20 66 6f  hose provided fo
13cb0 72 20 62 79 20 5b 53 51 4c 49 54 45 5f 43 4f 4e  r by [SQLITE_CON
13cc0 46 49 47 5f 53 43 52 41 54 43 48 5d 20 61 6e 64  FIG_SCRATCH] and
13cd0 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 43 4f 4e 46  .** [SQLITE_CONF
13ce0 49 47 5f 50 41 47 45 43 41 43 48 45 5d 2e 0a 2a  IG_PAGECACHE]..*
13cf0 2a 20 5e 54 68 65 20 53 51 4c 49 54 45 5f 43 4f  * ^The SQLITE_CO
13d00 4e 46 49 47 5f 48 45 41 50 20 6f 70 74 69 6f 6e  NFIG_HEAP option
13d10 20 69 73 20 6f 6e 6c 79 20 61 76 61 69 6c 61 62   is only availab
13d20 6c 65 20 69 66 20 53 51 4c 69 74 65 20 69 73 20  le if SQLite is 
13d30 63 6f 6d 70 69 6c 65 64 0a 2a 2a 20 77 69 74 68  compiled.** with
13d40 20 65 69 74 68 65 72 20 5b 53 51 4c 49 54 45 5f   either [SQLITE_
13d50 45 4e 41 42 4c 45 5f 4d 45 4d 53 59 53 33 5d 20  ENABLE_MEMSYS3] 
13d60 6f 72 20 5b 53 51 4c 49 54 45 5f 45 4e 41 42 4c  or [SQLITE_ENABL
13d70 45 5f 4d 45 4d 53 59 53 35 5d 20 61 6e 64 20 72  E_MEMSYS5] and r
13d80 65 74 75 72 6e 73 0a 2a 2a 20 5b 53 51 4c 49 54  eturns.** [SQLIT
13d90 45 5f 45 52 52 4f 52 5d 20 69 66 20 69 6e 76 6f  E_ERROR] if invo
13da0 6b 65 64 20 6f 74 68 65 72 77 69 73 65 2e 0a 2a  ked otherwise..*
13db0 2a 20 5e 54 68 65 72 65 20 61 72 65 20 74 68 72  * ^There are thr
13dc0 65 65 20 61 72 67 75 6d 65 6e 74 73 20 74 6f 20  ee arguments to 
13dd0 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 48 45  SQLITE_CONFIG_HE
13de0 41 50 3a 0a 2a 2a 20 41 6e 20 38 2d 62 79 74 65  AP:.** An 8-byte
13df0 20 61 6c 69 67 6e 65 64 20 70 6f 69 6e 74 65 72   aligned pointer
13e00 20 74 6f 20 74 68 65 20 6d 65 6d 6f 72 79 2c 0a   to the memory,.
13e10 2a 2a 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66  ** the number of
13e20 20 62 79 74 65 73 20 69 6e 20 74 68 65 20 6d 65   bytes in the me
13e30 6d 6f 72 79 20 62 75 66 66 65 72 2c 20 61 6e 64  mory buffer, and
13e40 20 74 68 65 20 6d 69 6e 69 6d 75 6d 20 61 6c 6c   the minimum all
13e50 6f 63 61 74 69 6f 6e 20 73 69 7a 65 2e 0a 2a 2a  ocation size..**
13e60 20 5e 49 66 20 74 68 65 20 66 69 72 73 74 20 70   ^If the first p
13e70 6f 69 6e 74 65 72 20 28 74 68 65 20 6d 65 6d 6f  ointer (the memo
13e80 72 79 20 70 6f 69 6e 74 65 72 29 20 69 73 20 4e  ry pointer) is N
13e90 55 4c 4c 2c 20 74 68 65 6e 20 53 51 4c 69 74 65  ULL, then SQLite
13ea0 20 72 65 76 65 72 74 73 0a 2a 2a 20 74 6f 20 75   reverts.** to u
13eb0 73 69 6e 67 20 69 74 73 20 64 65 66 61 75 6c 74  sing its default
13ec0 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f   memory allocato
13ed0 72 20 28 74 68 65 20 73 79 73 74 65 6d 20 6d 61  r (the system ma
13ee0 6c 6c 6f 63 28 29 20 69 6d 70 6c 65 6d 65 6e 74  lloc() implement
13ef0 61 74 69 6f 6e 29 2c 0a 2a 2a 20 75 6e 64 6f 69  ation),.** undoi
13f00 6e 67 20 61 6e 79 20 70 72 69 6f 72 20 69 6e 76  ng any prior inv
13f10 6f 63 61 74 69 6f 6e 20 6f 66 20 5b 53 51 4c 49  ocation of [SQLI
13f20 54 45 5f 43 4f 4e 46 49 47 5f 4d 41 4c 4c 4f 43  TE_CONFIG_MALLOC
13f30 5d 2e 20 20 5e 49 66 20 74 68 65 0a 2a 2a 20 6d  ].  ^If the.** m
13f40 65 6d 6f 72 79 20 70 6f 69 6e 74 65 72 20 69 73  emory pointer is
13f50 20 6e 6f 74 20 4e 55 4c 4c 20 74 68 65 6e 20 74   not NULL then t
13f60 68 65 20 61 6c 74 65 72 6e 61 74 69 76 65 20 6d  he alternative m
13f70 65 6d 6f 72 79 0a 2a 2a 20 61 6c 6c 6f 63 61 74  emory.** allocat
13f80 6f 72 20 69 73 20 65 6e 67 61 67 65 64 20 74 6f  or is engaged to
13f90 20 68 61 6e 64 6c 65 20 61 6c 6c 20 6f 66 20 53   handle all of S
13fa0 51 4c 69 74 65 73 20 6d 65 6d 6f 72 79 20 61 6c  QLites memory al
13fb0 6c 6f 63 61 74 69 6f 6e 20 6e 65 65 64 73 2e 0a  location needs..
13fc0 2a 2a 20 54 68 65 20 66 69 72 73 74 20 70 6f 69  ** The first poi
13fd0 6e 74 65 72 20 28 74 68 65 20 6d 65 6d 6f 72 79  nter (the memory
13fe0 20 70 6f 69 6e 74 65 72 29 20 6d 75 73 74 20 62   pointer) must b
13ff0 65 20 61 6c 69 67 6e 65 64 20 74 6f 20 61 6e 20  e aligned to an 
14000 38 2d 62 79 74 65 0a 2a 2a 20 62 6f 75 6e 64 61  8-byte.** bounda
14010 72 79 20 6f 72 20 73 75 62 73 65 71 75 65 6e 74  ry or subsequent
14020 20 62 65 68 61 76 69 6f 72 20 6f 66 20 53 51 4c   behavior of SQL
14030 69 74 65 20 77 69 6c 6c 20 62 65 20 75 6e 64 65  ite will be unde
14040 66 69 6e 65 64 2e 0a 2a 2a 20 54 68 65 20 6d 69  fined..** The mi
14050 6e 69 6d 75 6d 20 61 6c 6c 6f 63 61 74 69 6f 6e  nimum allocation
14060 20 73 69 7a 65 20 69 73 20 63 61 70 70 65 64 20   size is capped 
14070 61 74 20 32 2a 2a 31 32 2e 20 52 65 61 73 6f 6e  at 2**12. Reason
14080 61 62 6c 65 20 76 61 6c 75 65 73 0a 2a 2a 20 66  able values.** f
14090 6f 72 20 74 68 65 20 6d 69 6e 69 6d 75 6d 20 61  or the minimum a
140a0 6c 6c 6f 63 61 74 69 6f 6e 20 73 69 7a 65 20 61  llocation size a
140b0 72 65 20 32 2a 2a 35 20 74 68 72 6f 75 67 68 20  re 2**5 through 
140c0 32 2a 2a 38 2e 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a  2**8.</dd>.**.**
140d0 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47   [[SQLITE_CONFIG
140e0 5f 4d 55 54 45 58 5d 5d 20 3c 64 74 3e 53 51 4c  _MUTEX]] <dt>SQL
140f0 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 55 54 45 58  ITE_CONFIG_MUTEX
14100 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 28  </dt>.** <dd> ^(
14110 54 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49  The SQLITE_CONFI
14120 47 5f 4d 55 54 45 58 20 6f 70 74 69 6f 6e 20 74  G_MUTEX option t
14130 61 6b 65 73 20 61 20 73 69 6e 67 6c 65 20 61 72  akes a single ar
14140 67 75 6d 65 6e 74 20 77 68 69 63 68 20 69 73 20  gument which is 
14150 61 0a 2a 2a 20 70 6f 69 6e 74 65 72 20 74 6f 20  a.** pointer to 
14160 61 6e 20 69 6e 73 74 61 6e 63 65 20 6f 66 20 74  an instance of t
14170 68 65 20 5b 73 71 6c 69 74 65 33 5f 6d 75 74 65  he [sqlite3_mute
14180 78 5f 6d 65 74 68 6f 64 73 5d 20 73 74 72 75 63  x_methods] struc
14190 74 75 72 65 2e 0a 2a 2a 20 54 68 65 20 61 72 67  ture..** The arg
141a0 75 6d 65 6e 74 20 73 70 65 63 69 66 69 65 73 20  ument specifies 
141b0 61 6c 74 65 72 6e 61 74 69 76 65 20 6c 6f 77 2d  alternative low-
141c0 6c 65 76 65 6c 20 6d 75 74 65 78 20 72 6f 75 74  level mutex rout
141d0 69 6e 65 73 20 74 6f 20 62 65 20 75 73 65 64 0a  ines to be used.
141e0 2a 2a 20 69 6e 20 70 6c 61 63 65 20 74 68 65 20  ** in place the 
141f0 6d 75 74 65 78 20 72 6f 75 74 69 6e 65 73 20 62  mutex routines b
14200 75 69 6c 74 20 69 6e 74 6f 20 53 51 4c 69 74 65  uilt into SQLite
14210 2e 29 5e 20 20 5e 53 51 4c 69 74 65 20 6d 61 6b  .)^  ^SQLite mak
14220 65 73 20 61 20 63 6f 70 79 20 6f 66 0a 2a 2a 20  es a copy of.** 
14230 74 68 65 20 63 6f 6e 74 65 6e 74 20 6f 66 20 74  the content of t
14240 68 65 20 5b 73 71 6c 69 74 65 33 5f 6d 75 74 65  he [sqlite3_mute
14250 78 5f 6d 65 74 68 6f 64 73 5d 20 73 74 72 75 63  x_methods] struc
14260 74 75 72 65 20 62 65 66 6f 72 65 20 74 68 65 20  ture before the 
14270 63 61 6c 6c 20 74 6f 0a 2a 2a 20 5b 73 71 6c 69  call to.** [sqli
14280 74 65 33 5f 63 6f 6e 66 69 67 28 29 5d 20 72 65  te3_config()] re
14290 74 75 72 6e 73 2e 20 5e 49 66 20 53 51 4c 69 74  turns. ^If SQLit
142a0 65 20 69 73 20 63 6f 6d 70 69 6c 65 64 20 77 69  e is compiled wi
142b0 74 68 0a 2a 2a 20 74 68 65 20 5b 53 51 4c 49 54  th.** the [SQLIT
142c0 45 5f 54 48 52 45 41 44 53 41 46 45 20 7c 20 53  E_THREADSAFE | S
142d0 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46 45  QLITE_THREADSAFE
142e0 3d 30 5d 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65  =0] compile-time
142f0 20 6f 70 74 69 6f 6e 20 74 68 65 6e 0a 2a 2a 20   option then.** 
14300 74 68 65 20 65 6e 74 69 72 65 20 6d 75 74 65 78  the entire mutex
14310 69 6e 67 20 73 75 62 73 79 73 74 65 6d 20 69 73  ing subsystem is
14320 20 6f 6d 69 74 74 65 64 20 66 72 6f 6d 20 74 68   omitted from th
14330 65 20 62 75 69 6c 64 20 61 6e 64 20 68 65 6e 63  e build and henc
14340 65 20 63 61 6c 6c 73 20 74 6f 0a 2a 2a 20 5b 73  e calls to.** [s
14350 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 5d  qlite3_config()]
14360 20 77 69 74 68 20 74 68 65 20 53 51 4c 49 54 45   with the SQLITE
14370 5f 43 4f 4e 46 49 47 5f 4d 55 54 45 58 20 63 6f  _CONFIG_MUTEX co
14380 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f 70 74 69  nfiguration opti
14390 6f 6e 20 77 69 6c 6c 0a 2a 2a 20 72 65 74 75 72  on will.** retur
143a0 6e 20 5b 53 51 4c 49 54 45 5f 45 52 52 4f 52 5d  n [SQLITE_ERROR]
143b0 2e 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53  .</dd>.**.** [[S
143c0 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 47 45 54  QLITE_CONFIG_GET
143d0 4d 55 54 45 58 5d 5d 20 3c 64 74 3e 53 51 4c 49  MUTEX]] <dt>SQLI
143e0 54 45 5f 43 4f 4e 46 49 47 5f 47 45 54 4d 55 54  TE_CONFIG_GETMUT
143f0 45 58 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20  EX</dt>.** <dd> 
14400 5e 28 54 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e  ^(The SQLITE_CON
14410 46 49 47 5f 47 45 54 4d 55 54 45 58 20 6f 70 74  FIG_GETMUTEX opt
14420 69 6f 6e 20 74 61 6b 65 73 20 61 20 73 69 6e 67  ion takes a sing
14430 6c 65 20 61 72 67 75 6d 65 6e 74 20 77 68 69 63  le argument whic
14440 68 0a 2a 2a 20 69 73 20 61 20 70 6f 69 6e 74 65  h.** is a pointe
14450 72 20 74 6f 20 61 6e 20 69 6e 73 74 61 6e 63 65  r to an instance
14460 20 6f 66 20 74 68 65 20 5b 73 71 6c 69 74 65 33   of the [sqlite3
14470 5f 6d 75 74 65 78 5f 6d 65 74 68 6f 64 73 5d 20  _mutex_methods] 
14480 73 74 72 75 63 74 75 72 65 2e 20 20 54 68 65 0a  structure.  The.
14490 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 6d 75 74 65  ** [sqlite3_mute
144a0 78 5f 6d 65 74 68 6f 64 73 5d 0a 2a 2a 20 73 74  x_methods].** st
144b0 72 75 63 74 75 72 65 20 69 73 20 66 69 6c 6c 65  ructure is fille
144c0 64 20 77 69 74 68 20 74 68 65 20 63 75 72 72 65  d with the curre
144d0 6e 74 6c 79 20 64 65 66 69 6e 65 64 20 6d 75 74  ntly defined mut
144e0 65 78 20 72 6f 75 74 69 6e 65 73 2e 29 5e 0a 2a  ex routines.)^.*
144f0 2a 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 63 61  * This option ca
14500 6e 20 62 65 20 75 73 65 64 20 74 6f 20 6f 76 65  n be used to ove
14510 72 6c 6f 61 64 20 74 68 65 20 64 65 66 61 75 6c  rload the defaul
14520 74 20 6d 75 74 65 78 20 61 6c 6c 6f 63 61 74 69  t mutex allocati
14530 6f 6e 0a 2a 2a 20 72 6f 75 74 69 6e 65 73 20 77  on.** routines w
14540 69 74 68 20 61 20 77 72 61 70 70 65 72 20 75 73  ith a wrapper us
14550 65 64 20 74 6f 20 74 72 61 63 6b 20 6d 75 74 65  ed to track mute
14560 78 20 75 73 61 67 65 20 66 6f 72 20 70 65 72 66  x usage for perf
14570 6f 72 6d 61 6e 63 65 0a 2a 2a 20 70 72 6f 66 69  ormance.** profi
14580 6c 69 6e 67 20 6f 72 20 74 65 73 74 69 6e 67 2c  ling or testing,
14590 20 66 6f 72 20 65 78 61 6d 70 6c 65 2e 20 20 20   for example.   
145a0 5e 49 66 20 53 51 4c 69 74 65 20 69 73 20 63 6f  ^If SQLite is co
145b0 6d 70 69 6c 65 64 20 77 69 74 68 0a 2a 2a 20 74  mpiled with.** t
145c0 68 65 20 5b 53 51 4c 49 54 45 5f 54 48 52 45 41  he [SQLITE_THREA
145d0 44 53 41 46 45 20 7c 20 53 51 4c 49 54 45 5f 54  DSAFE | SQLITE_T
145e0 48 52 45 41 44 53 41 46 45 3d 30 5d 20 63 6f 6d  HREADSAFE=0] com
145f0 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e  pile-time option
14600 20 74 68 65 6e 0a 2a 2a 20 74 68 65 20 65 6e 74   then.** the ent
14610 69 72 65 20 6d 75 74 65 78 69 6e 67 20 73 75 62  ire mutexing sub
14620 73 79 73 74 65 6d 20 69 73 20 6f 6d 69 74 74 65  system is omitte
14630 64 20 66 72 6f 6d 20 74 68 65 20 62 75 69 6c 64  d from the build
14640 20 61 6e 64 20 68 65 6e 63 65 20 63 61 6c 6c 73   and hence calls
14650 20 74 6f 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f   to.** [sqlite3_
14660 63 6f 6e 66 69 67 28 29 5d 20 77 69 74 68 20 74  config()] with t
14670 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47  he SQLITE_CONFIG
14680 5f 47 45 54 4d 55 54 45 58 20 63 6f 6e 66 69 67  _GETMUTEX config
14690 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 20 77  uration option w
146a0 69 6c 6c 0a 2a 2a 20 72 65 74 75 72 6e 20 5b 53  ill.** return [S
146b0 51 4c 49 54 45 5f 45 52 52 4f 52 5d 2e 3c 2f 64  QLITE_ERROR].</d
146c0 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54  d>.**.** [[SQLIT
146d0 45 5f 43 4f 4e 46 49 47 5f 4c 4f 4f 4b 41 53 49  E_CONFIG_LOOKASI
146e0 44 45 5d 5d 20 3c 64 74 3e 53 51 4c 49 54 45 5f  DE]] <dt>SQLITE_
146f0 43 4f 4e 46 49 47 5f 4c 4f 4f 4b 41 53 49 44 45  CONFIG_LOOKASIDE
14700 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 28  </dt>.** <dd> ^(
14710 54 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49  The SQLITE_CONFI
14720 47 5f 4c 4f 4f 4b 41 53 49 44 45 20 6f 70 74 69  G_LOOKASIDE opti
14730 6f 6e 20 74 61 6b 65 73 20 74 77 6f 20 61 72 67  on takes two arg
14740 75 6d 65 6e 74 73 20 74 68 61 74 20 64 65 74 65  uments that dete
14750 72 6d 69 6e 65 0a 2a 2a 20 74 68 65 20 64 65 66  rmine.** the def
14760 61 75 6c 74 20 73 69 7a 65 20 6f 66 20 6c 6f 6f  ault size of loo
14770 6b 61 73 69 64 65 20 6d 65 6d 6f 72 79 20 6f 6e  kaside memory on
14780 20 65 61 63 68 20 5b 64 61 74 61 62 61 73 65 20   each [database 
14790 63 6f 6e 6e 65 63 74 69 6f 6e 5d 2e 0a 2a 2a 20  connection]..** 
147a0 54 68 65 20 66 69 72 73 74 20 61 72 67 75 6d 65  The first argume
147b0 6e 74 20 69 73 20 74 68 65 0a 2a 2a 20 73 69 7a  nt is the.** siz
147c0 65 20 6f 66 20 65 61 63 68 20 6c 6f 6f 6b 61 73  e of each lookas
147d0 69 64 65 20 62 75 66 66 65 72 20 73 6c 6f 74 20  ide buffer slot 
147e0 61 6e 64 20 74 68 65 20 73 65 63 6f 6e 64 20 69  and the second i
147f0 73 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 0a  s the number of.
14800 2a 2a 20 73 6c 6f 74 73 20 61 6c 6c 6f 63 61 74  ** slots allocat
14810 65 64 20 74 6f 20 65 61 63 68 20 64 61 74 61 62  ed to each datab
14820 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 2e 29  ase connection.)
14830 5e 20 20 5e 28 53 51 4c 49 54 45 5f 43 4f 4e 46  ^  ^(SQLITE_CONF
14840 49 47 5f 4c 4f 4f 4b 41 53 49 44 45 0a 2a 2a 20  IG_LOOKASIDE.** 
14850 73 65 74 73 20 74 68 65 20 3c 69 3e 64 65 66 61  sets the <i>defa
14860 75 6c 74 3c 2f 69 3e 20 6c 6f 6f 6b 61 73 69 64  ult</i> lookasid
14870 65 20 73 69 7a 65 2e 20 54 68 65 20 5b 53 51 4c  e size. The [SQL
14880 49 54 45 5f 44 42 43 4f 4e 46 49 47 5f 4c 4f 4f  ITE_DBCONFIG_LOO
14890 4b 41 53 49 44 45 5d 0a 2a 2a 20 6f 70 74 69 6f  KASIDE].** optio
148a0 6e 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 64 62  n to [sqlite3_db
148b0 5f 63 6f 6e 66 69 67 28 29 5d 20 63 61 6e 20 62  _config()] can b
148c0 65 20 75 73 65 64 20 74 6f 20 63 68 61 6e 67 65  e used to change
148d0 20 74 68 65 20 6c 6f 6f 6b 61 73 69 64 65 0a 2a   the lookaside.*
148e0 2a 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20  * configuration 
148f0 6f 6e 20 69 6e 64 69 76 69 64 75 61 6c 20 63 6f  on individual co
14900 6e 6e 65 63 74 69 6f 6e 73 2e 29 5e 20 3c 2f 64  nnections.)^ </d
14910 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54  d>.**.** [[SQLIT
14920 45 5f 43 4f 4e 46 49 47 5f 50 43 41 43 48 45 32  E_CONFIG_PCACHE2
14930 5d 5d 20 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f  ]] <dt>SQLITE_CO
14940 4e 46 49 47 5f 50 43 41 43 48 45 32 3c 2f 64 74  NFIG_PCACHE2</dt
14950 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 28 54 68 65 20  >.** <dd> ^(The 
14960 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 50 43  SQLITE_CONFIG_PC
14970 41 43 48 45 32 20 6f 70 74 69 6f 6e 20 74 61 6b  ACHE2 option tak
14980 65 73 20 61 20 73 69 6e 67 6c 65 20 61 72 67 75  es a single argu
14990 6d 65 6e 74 20 77 68 69 63 68 20 69 73 20 0a 2a  ment which is .*
149a0 2a 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61  * a pointer to a
149b0 6e 20 5b 73 71 6c 69 74 65 33 5f 70 63 61 63 68  n [sqlite3_pcach
149c0 65 5f 6d 65 74 68 6f 64 73 32 5d 20 6f 62 6a 65  e_methods2] obje
149d0 63 74 2e 20 20 54 68 69 73 20 6f 62 6a 65 63 74  ct.  This object
149e0 20 73 70 65 63 69 66 69 65 73 0a 2a 2a 20 74 68   specifies.** th
149f0 65 20 69 6e 74 65 72 66 61 63 65 20 74 6f 20 61  e interface to a
14a00 20 63 75 73 74 6f 6d 20 70 61 67 65 20 63 61 63   custom page cac
14a10 68 65 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f  he implementatio
14a20 6e 2e 29 5e 0a 2a 2a 20 5e 53 51 4c 69 74 65 20  n.)^.** ^SQLite 
14a30 6d 61 6b 65 73 20 61 20 63 6f 70 79 20 6f 66 20  makes a copy of 
14a40 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 70 63 61  the [sqlite3_pca
14a50 63 68 65 5f 6d 65 74 68 6f 64 73 32 5d 20 6f 62  che_methods2] ob
14a60 6a 65 63 74 2e 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a  ject.</dd>.**.**
14a70 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47   [[SQLITE_CONFIG
14a80 5f 47 45 54 50 43 41 43 48 45 32 5d 5d 20 3c 64  _GETPCACHE2]] <d
14a90 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  t>SQLITE_CONFIG_
14aa0 47 45 54 50 43 41 43 48 45 32 3c 2f 64 74 3e 0a  GETPCACHE2</dt>.
14ab0 2a 2a 20 3c 64 64 3e 20 5e 28 54 68 65 20 53 51  ** <dd> ^(The SQ
14ac0 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 47 45 54 50  LITE_CONFIG_GETP
14ad0 43 41 43 48 45 32 20 6f 70 74 69 6f 6e 20 74 61  CACHE2 option ta
14ae0 6b 65 73 20 61 20 73 69 6e 67 6c 65 20 61 72 67  kes a single arg
14af0 75 6d 65 6e 74 20 77 68 69 63 68 0a 2a 2a 20 69  ument which.** i
14b00 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61  s a pointer to a
14b10 6e 20 5b 73 71 6c 69 74 65 33 5f 70 63 61 63 68  n [sqlite3_pcach
14b20 65 5f 6d 65 74 68 6f 64 73 32 5d 20 6f 62 6a 65  e_methods2] obje
14b30 63 74 2e 20 20 53 51 4c 69 74 65 20 63 6f 70 69  ct.  SQLite copi
14b40 65 73 20 6f 66 0a 2a 2a 20 74 68 65 20 63 75 72  es of.** the cur
14b50 72 65 6e 74 20 70 61 67 65 20 63 61 63 68 65 20  rent page cache 
14b60 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 69  implementation i
14b70 6e 74 6f 20 74 68 61 74 20 6f 62 6a 65 63 74 2e  nto that object.
14b80 29 5e 20 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 5b  )^ </dd>.**.** [
14b90 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4c  [SQLITE_CONFIG_L
14ba0 4f 47 5d 5d 20 3c 64 74 3e 53 51 4c 49 54 45 5f  OG]] <dt>SQLITE_
14bb0 43 4f 4e 46 49 47 5f 4c 4f 47 3c 2f 64 74 3e 0a  CONFIG_LOG</dt>.
14bc0 2a 2a 20 3c 64 64 3e 20 54 68 65 20 53 51 4c 49  ** <dd> The SQLI
14bd0 54 45 5f 43 4f 4e 46 49 47 5f 4c 4f 47 20 6f 70  TE_CONFIG_LOG op
14be0 74 69 6f 6e 20 69 73 20 75 73 65 64 20 74 6f 20  tion is used to 
14bf0 63 6f 6e 66 69 67 75 72 65 20 74 68 65 20 53 51  configure the SQ
14c00 4c 69 74 65 0a 2a 2a 20 67 6c 6f 62 61 6c 20 5b  Lite.** global [
14c10 65 72 72 6f 72 20 6c 6f 67 5d 2e 0a 2a 2a 20 28  error log]..** (
14c20 5e 54 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46  ^The SQLITE_CONF
14c30 49 47 5f 4c 4f 47 20 6f 70 74 69 6f 6e 20 74 61  IG_LOG option ta
14c40 6b 65 73 20 74 77 6f 20 61 72 67 75 6d 65 6e 74  kes two argument
14c50 73 3a 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20  s: a pointer to 
14c60 61 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 20 77 69  a.** function wi
14c70 74 68 20 61 20 63 61 6c 6c 20 73 69 67 6e 61 74  th a call signat
14c80 75 72 65 20 6f 66 20 76 6f 69 64 28 2a 29 28 76  ure of void(*)(v
14c90 6f 69 64 2a 2c 69 6e 74 2c 63 6f 6e 73 74 20 63  oid*,int,const c
14ca0 68 61 72 2a 29 2c 20 0a 2a 2a 20 61 6e 64 20 61  har*), .** and a
14cb0 20 70 6f 69 6e 74 65 72 20 74 6f 20 76 6f 69 64   pointer to void
14cc0 2e 20 5e 49 66 20 74 68 65 20 66 75 6e 63 74 69  . ^If the functi
14cd0 6f 6e 20 70 6f 69 6e 74 65 72 20 69 73 20 6e 6f  on pointer is no
14ce0 74 20 4e 55 4c 4c 2c 20 69 74 20 69 73 0a 2a 2a  t NULL, it is.**
14cf0 20 69 6e 76 6f 6b 65 64 20 62 79 20 5b 73 71 6c   invoked by [sql
14d00 69 74 65 33 5f 6c 6f 67 28 29 5d 20 74 6f 20 70  ite3_log()] to p
14d10 72 6f 63 65 73 73 20 65 61 63 68 20 6c 6f 67 67  rocess each logg
14d20 69 6e 67 20 65 76 65 6e 74 2e 20 20 5e 49 66 20  ing event.  ^If 
14d30 74 68 65 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 20  the.** function 
14d40 70 6f 69 6e 74 65 72 20 69 73 20 4e 55 4c 4c 2c  pointer is NULL,
14d50 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 6c 6f   the [sqlite3_lo
14d60 67 28 29 5d 20 69 6e 74 65 72 66 61 63 65 20 62  g()] interface b
14d70 65 63 6f 6d 65 73 20 61 20 6e 6f 2d 6f 70 2e 0a  ecomes a no-op..
14d80 2a 2a 20 5e 54 68 65 20 76 6f 69 64 20 70 6f 69  ** ^The void poi
14d90 6e 74 65 72 20 74 68 61 74 20 69 73 20 74 68 65  nter that is the
14da0 20 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74   second argument
14db0 20 74 6f 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49   to SQLITE_CONFI
14dc0 47 5f 4c 4f 47 20 69 73 0a 2a 2a 20 70 61 73 73  G_LOG is.** pass
14dd0 65 64 20 74 68 72 6f 75 67 68 20 61 73 20 74 68  ed through as th
14de0 65 20 66 69 72 73 74 20 70 61 72 61 6d 65 74 65  e first paramete
14df0 72 20 74 6f 20 74 68 65 20 61 70 70 6c 69 63 61  r to the applica
14e00 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 6c 6f 67  tion-defined log
14e10 67 65 72 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 20  ger.** function 
14e20 77 68 65 6e 65 76 65 72 20 74 68 61 74 20 66 75  whenever that fu
14e30 6e 63 74 69 6f 6e 20 69 73 20 69 6e 76 6f 6b 65  nction is invoke
14e40 64 2e 20 20 5e 54 68 65 20 73 65 63 6f 6e 64 20  d.  ^The second 
14e50 70 61 72 61 6d 65 74 65 72 20 74 6f 0a 2a 2a 20  parameter to.** 
14e60 74 68 65 20 6c 6f 67 67 65 72 20 66 75 6e 63 74  the logger funct
14e70 69 6f 6e 20 69 73 20 61 20 63 6f 70 79 20 6f 66  ion is a copy of
14e80 20 74 68 65 20 66 69 72 73 74 20 70 61 72 61 6d   the first param
14e90 65 74 65 72 20 74 6f 20 74 68 65 20 63 6f 72 72  eter to the corr
14ea0 65 73 70 6f 6e 64 69 6e 67 0a 2a 2a 20 5b 73 71  esponding.** [sq
14eb0 6c 69 74 65 33 5f 6c 6f 67 28 29 5d 20 63 61 6c  lite3_log()] cal
14ec0 6c 20 61 6e 64 20 69 73 20 69 6e 74 65 6e 64 65  l and is intende
14ed0 64 20 74 6f 20 62 65 20 61 20 5b 72 65 73 75 6c  d to be a [resul
14ee0 74 20 63 6f 64 65 5d 20 6f 72 20 61 6e 0a 2a 2a  t code] or an.**
14ef0 20 5b 65 78 74 65 6e 64 65 64 20 72 65 73 75 6c   [extended resul
14f00 74 20 63 6f 64 65 5d 2e 20 20 5e 54 68 65 20 74  t code].  ^The t
14f10 68 69 72 64 20 70 61 72 61 6d 65 74 65 72 20 70  hird parameter p
14f20 61 73 73 65 64 20 74 6f 20 74 68 65 20 6c 6f 67  assed to the log
14f30 67 65 72 20 69 73 0a 2a 2a 20 6c 6f 67 20 6d 65  ger is.** log me
14f40 73 73 61 67 65 20 61 66 74 65 72 20 66 6f 72 6d  ssage after form
14f50 61 74 74 69 6e 67 20 76 69 61 20 5b 73 71 6c 69  atting via [sqli
14f60 74 65 33 5f 73 6e 70 72 69 6e 74 66 28 29 5d 2e  te3_snprintf()].
14f70 0a 2a 2a 20 54 68 65 20 53 51 4c 69 74 65 20 6c  .** The SQLite l
14f80 6f 67 67 69 6e 67 20 69 6e 74 65 72 66 61 63 65  ogging interface
14f90 20 69 73 20 6e 6f 74 20 72 65 65 6e 74 72 61 6e   is not reentran
14fa0 74 3b 20 74 68 65 20 6c 6f 67 67 65 72 20 66 75  t; the logger fu
14fb0 6e 63 74 69 6f 6e 0a 2a 2a 20 73 75 70 70 6c 69  nction.** suppli
14fc0 65 64 20 62 79 20 74 68 65 20 61 70 70 6c 69 63  ed by the applic
14fd0 61 74 69 6f 6e 20 6d 75 73 74 20 6e 6f 74 20 69  ation must not i
14fe0 6e 76 6f 6b 65 20 61 6e 79 20 53 51 4c 69 74 65  nvoke any SQLite
14ff0 20 69 6e 74 65 72 66 61 63 65 2e 0a 2a 2a 20 49   interface..** I
15000 6e 20 61 20 6d 75 6c 74 69 2d 74 68 72 65 61 64  n a multi-thread
15010 65 64 20 61 70 70 6c 69 63 61 74 69 6f 6e 2c 20  ed application, 
15020 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 2d  the application-
15030 64 65 66 69 6e 65 64 20 6c 6f 67 67 65 72 0a 2a  defined logger.*
15040 2a 20 66 75 6e 63 74 69 6f 6e 20 6d 75 73 74 20  * function must 
15050 62 65 20 74 68 72 65 61 64 73 61 66 65 2e 20 3c  be threadsafe. <
15060 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c  /dd>.**.** [[SQL
15070 49 54 45 5f 43 4f 4e 46 49 47 5f 55 52 49 5d 5d  ITE_CONFIG_URI]]
15080 20 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46   <dt>SQLITE_CONF
15090 49 47 5f 55 52 49 0a 2a 2a 20 3c 64 64 3e 5e 28  IG_URI.** <dd>^(
150a0 54 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49  The SQLITE_CONFI
150b0 47 5f 55 52 49 20 6f 70 74 69 6f 6e 20 74 61 6b  G_URI option tak
150c0 65 73 20 61 20 73 69 6e 67 6c 65 20 61 72 67 75  es a single argu
150d0 6d 65 6e 74 20 6f 66 20 74 79 70 65 20 69 6e 74  ment of type int
150e0 2e 0a 2a 2a 20 49 66 20 6e 6f 6e 2d 7a 65 72 6f  ..** If non-zero
150f0 2c 20 74 68 65 6e 20 55 52 49 20 68 61 6e 64 6c  , then URI handl
15100 69 6e 67 20 69 73 20 67 6c 6f 62 61 6c 6c 79 20  ing is globally 
15110 65 6e 61 62 6c 65 64 2e 20 49 66 20 74 68 65 20  enabled. If the 
15120 70 61 72 61 6d 65 74 65 72 20 69 73 20 7a 65 72  parameter is zer
15130 6f 2c 0a 2a 2a 20 74 68 65 6e 20 55 52 49 20 68  o,.** then URI h
15140 61 6e 64 6c 69 6e 67 20 69 73 20 67 6c 6f 62 61  andling is globa
15150 6c 6c 79 20 64 69 73 61 62 6c 65 64 2e 29 5e 20  lly disabled.)^ 
15160 5e 49 66 20 55 52 49 20 68 61 6e 64 6c 69 6e 67  ^If URI handling
15170 20 69 73 20 67 6c 6f 62 61 6c 6c 79 0a 2a 2a 20   is globally.** 
15180 65 6e 61 62 6c 65 64 2c 20 61 6c 6c 20 66 69 6c  enabled, all fil
15190 65 6e 61 6d 65 73 20 70 61 73 73 65 64 20 74 6f  enames passed to
151a0 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29   [sqlite3_open()
151b0 5d 2c 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e  ], [sqlite3_open
151c0 5f 76 32 28 29 5d 2c 0a 2a 2a 20 5b 73 71 6c 69  _v2()],.** [sqli
151d0 74 65 33 5f 6f 70 65 6e 31 36 28 29 5d 20 6f 72  te3_open16()] or
151e0 0a 2a 2a 20 73 70 65 63 69 66 69 65 64 20 61 73  .** specified as
151f0 20 70 61 72 74 20 6f 66 20 5b 41 54 54 41 43 48   part of [ATTACH
15200 5d 20 63 6f 6d 6d 61 6e 64 73 20 61 72 65 20 69  ] commands are i
15210 6e 74 65 72 70 72 65 74 65 64 20 61 73 20 55 52  nterpreted as UR
15220 49 73 2c 20 72 65 67 61 72 64 6c 65 73 73 0a 2a  Is, regardless.*
15230 2a 20 6f 66 20 77 68 65 74 68 65 72 20 6f 72 20  * of whether or 
15240 6e 6f 74 20 74 68 65 20 5b 53 51 4c 49 54 45 5f  not the [SQLITE_
15250 4f 50 45 4e 5f 55 52 49 5d 20 66 6c 61 67 20 69  OPEN_URI] flag i
15260 73 20 73 65 74 20 77 68 65 6e 20 74 68 65 20 64  s set when the d
15270 61 74 61 62 61 73 65 0a 2a 2a 20 63 6f 6e 6e 65  atabase.** conne
15280 63 74 69 6f 6e 20 69 73 20 6f 70 65 6e 65 64 2e  ction is opened.
15290 20 5e 49 66 20 69 74 20 69 73 20 67 6c 6f 62 61   ^If it is globa
152a0 6c 6c 79 20 64 69 73 61 62 6c 65 64 2c 20 66 69  lly disabled, fi
152b0 6c 65 6e 61 6d 65 73 20 61 72 65 0a 2a 2a 20 6f  lenames are.** o
152c0 6e 6c 79 20 69 6e 74 65 72 70 72 65 74 65 64 20  nly interpreted 
152d0 61 73 20 55 52 49 73 20 69 66 20 74 68 65 20 53  as URIs if the S
152e0 51 4c 49 54 45 5f 4f 50 45 4e 5f 55 52 49 20 66  QLITE_OPEN_URI f
152f0 6c 61 67 20 69 73 20 73 65 74 20 77 68 65 6e 20  lag is set when 
15300 74 68 65 0a 2a 2a 20 64 61 74 61 62 61 73 65 20  the.** database 
15310 63 6f 6e 6e 65 63 74 69 6f 6e 20 69 73 20 6f 70  connection is op
15320 65 6e 65 64 2e 20 5e 28 42 79 20 64 65 66 61 75  ened. ^(By defau
15330 6c 74 2c 20 55 52 49 20 68 61 6e 64 6c 69 6e 67  lt, URI handling
15340 20 69 73 20 67 6c 6f 62 61 6c 6c 79 0a 2a 2a 20   is globally.** 
15350 64 69 73 61 62 6c 65 64 2e 20 54 68 65 20 64 65  disabled. The de
15360 66 61 75 6c 74 20 76 61 6c 75 65 20 6d 61 79 20  fault value may 
15370 62 65 20 63 68 61 6e 67 65 64 20 62 79 20 63 6f  be changed by co
15380 6d 70 69 6c 69 6e 67 20 77 69 74 68 20 74 68 65  mpiling with the
15390 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 55 53 45 5f  .** [SQLITE_USE_
153a0 55 52 49 5d 20 73 79 6d 62 6f 6c 20 64 65 66 69  URI] symbol defi
153b0 6e 65 64 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 53  ned.)^.**.** [[S
153c0 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 43 4f 56  QLITE_CONFIG_COV
153d0 45 52 49 4e 47 5f 49 4e 44 45 58 5f 53 43 41 4e  ERING_INDEX_SCAN
153e0 5d 5d 20 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f  ]] <dt>SQLITE_CO
153f0 4e 46 49 47 5f 43 4f 56 45 52 49 4e 47 5f 49 4e  NFIG_COVERING_IN
15400 44 45 58 5f 53 43 41 4e 0a 2a 2a 20 3c 64 64 3e  DEX_SCAN.** <dd>
15410 5e 54 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46  ^The SQLITE_CONF
15420 49 47 5f 43 4f 56 45 52 49 4e 47 5f 49 4e 44 45  IG_COVERING_INDE
15430 58 5f 53 43 41 4e 20 6f 70 74 69 6f 6e 20 74 61  X_SCAN option ta
15440 6b 65 73 20 61 20 73 69 6e 67 6c 65 20 69 6e 74  kes a single int
15450 65 67 65 72 0a 2a 2a 20 61 72 67 75 6d 65 6e 74  eger.** argument
15460 20 77 68 69 63 68 20 69 73 20 69 6e 74 65 72 70   which is interp
15470 72 65 74 65 64 20 61 73 20 61 20 62 6f 6f 6c 65  reted as a boole
15480 61 6e 20 69 6e 20 6f 72 64 65 72 20 74 6f 20 65  an in order to e
15490 6e 61 62 6c 65 20 6f 72 20 64 69 73 61 62 6c 65  nable or disable
154a0 0a 2a 2a 20 74 68 65 20 75 73 65 20 6f 66 20 63  .** the use of c
154b0 6f 76 65 72 69 6e 67 20 69 6e 64 69 63 65 73 20  overing indices 
154c0 66 6f 72 20 66 75 6c 6c 20 74 61 62 6c 65 20 73  for full table s
154d0 63 61 6e 73 20 69 6e 20 74 68 65 20 71 75 65 72  cans in the quer
154e0 79 20 6f 70 74 69 6d 69 7a 65 72 2e 0a 2a 2a 20  y optimizer..** 
154f0 5e 54 68 65 20 64 65 66 61 75 6c 74 20 73 65 74  ^The default set
15500 74 69 6e 67 20 69 73 20 64 65 74 65 72 6d 69 6e  ting is determin
15510 65 64 0a 2a 2a 20 62 79 20 74 68 65 20 5b 53 51  ed.** by the [SQ
15520 4c 49 54 45 5f 41 4c 4c 4f 57 5f 43 4f 56 45 52  LITE_ALLOW_COVER
15530 49 4e 47 5f 49 4e 44 45 58 5f 53 43 41 4e 5d 20  ING_INDEX_SCAN] 
15540 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74  compile-time opt
15550 69 6f 6e 2c 20 6f 72 20 69 73 20 22 6f 6e 22 0a  ion, or is "on".
15560 2a 2a 20 69 66 20 74 68 61 74 20 63 6f 6d 70 69  ** if that compi
15570 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 20 69  le-time option i
15580 73 20 6f 6d 69 74 74 65 64 2e 0a 2a 2a 20 54 68  s omitted..** Th
15590 65 20 61 62 69 6c 69 74 79 20 74 6f 20 64 69 73  e ability to dis
155a0 61 62 6c 65 20 74 68 65 20 75 73 65 20 6f 66 20  able the use of 
155b0 63 6f 76 65 72 69 6e 67 20 69 6e 64 69 63 65 73  covering indices
155c0 20 66 6f 72 20 66 75 6c 6c 20 74 61 62 6c 65 20   for full table 
155d0 73 63 61 6e 73 0a 2a 2a 20 69 73 20 62 65 63 61  scans.** is beca
155e0 75 73 65 20 73 6f 6d 65 20 69 6e 63 6f 72 72 65  use some incorre
155f0 63 74 6c 79 20 63 6f 64 65 64 20 6c 65 67 61 63  ctly coded legac
15600 79 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 6d  y applications m
15610 69 67 68 74 20 6d 61 6c 66 75 6e 63 74 69 6f 6e  ight malfunction
15620 0a 2a 2a 20 77 68 65 6e 20 74 68 65 20 6f 70 74  .** when the opt
15630 69 6d 69 7a 61 74 69 6f 6e 20 69 73 20 65 6e 61  imization is ena
15640 62 6c 65 64 2e 20 20 50 72 6f 76 69 64 69 6e 67  bled.  Providing
15650 20 74 68 65 20 61 62 69 6c 69 74 79 20 74 6f 0a   the ability to.
15660 2a 2a 20 64 69 73 61 62 6c 65 20 74 68 65 20 6f  ** disable the o
15670 70 74 69 6d 69 7a 61 74 69 6f 6e 20 61 6c 6c 6f  ptimization allo
15680 77 73 20 74 68 65 20 6f 6c 64 65 72 2c 20 62 75  ws the older, bu
15690 67 67 79 20 61 70 70 6c 69 63 61 74 69 6f 6e 20  ggy application 
156a0 63 6f 64 65 20 74 6f 20 77 6f 72 6b 0a 2a 2a 20  code to work.** 
156b0 77 69 74 68 6f 75 74 20 63 68 61 6e 67 65 20 65  without change e
156c0 76 65 6e 20 77 69 74 68 20 6e 65 77 65 72 20 76  ven with newer v
156d0 65 72 73 69 6f 6e 73 20 6f 66 20 53 51 4c 69 74  ersions of SQLit
156e0 65 2e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54  e..**.** [[SQLIT
156f0 45 5f 43 4f 4e 46 49 47 5f 50 43 41 43 48 45 5d  E_CONFIG_PCACHE]
15700 5d 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49  ] [[SQLITE_CONFI
15710 47 5f 47 45 54 50 43 41 43 48 45 5d 5d 0a 2a 2a  G_GETPCACHE]].**
15720 20 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46   <dt>SQLITE_CONF
15730 49 47 5f 50 43 41 43 48 45 20 61 6e 64 20 53 51  IG_PCACHE and SQ
15740 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 47 45 54 50  LITE_CONFIG_GETP
15750 43 41 43 48 45 0a 2a 2a 20 3c 64 64 3e 20 54 68  CACHE.** <dd> Th
15760 65 73 65 20 6f 70 74 69 6f 6e 73 20 61 72 65 20  ese options are 
15770 6f 62 73 6f 6c 65 74 65 20 61 6e 64 20 73 68 6f  obsolete and sho
15780 75 6c 64 20 6e 6f 74 20 62 65 20 75 73 65 64 20  uld not be used 
15790 62 79 20 6e 65 77 20 63 6f 64 65 2e 0a 2a 2a 20  by new code..** 
157a0 54 68 65 79 20 61 72 65 20 72 65 74 61 69 6e 65  They are retaine
157b0 64 20 66 6f 72 20 62 61 63 6b 77 61 72 64 73 20  d for backwards 
157c0 63 6f 6d 70 61 74 69 62 69 6c 69 74 79 20 62 75  compatibility bu
157d0 74 20 61 72 65 20 6e 6f 77 20 6e 6f 2d 6f 70 73  t are now no-ops
157e0 2e 0a 2a 2a 20 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a  ..** </dd>.**.**
157f0 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47   [[SQLITE_CONFIG
15800 5f 53 51 4c 4c 4f 47 5d 5d 0a 2a 2a 20 3c 64 74  _SQLLOG]].** <dt
15810 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53  >SQLITE_CONFIG_S
15820 51 4c 4c 4f 47 0a 2a 2a 20 3c 64 64 3e 54 68 69  QLLOG.** <dd>Thi
15830 73 20 6f 70 74 69 6f 6e 20 69 73 20 6f 6e 6c 79  s option is only
15840 20 61 76 61 69 6c 61 62 6c 65 20 69 66 20 73 71   available if sq
15850 6c 69 74 65 20 69 73 20 63 6f 6d 70 69 6c 65 64  lite is compiled
15860 20 77 69 74 68 20 74 68 65 0a 2a 2a 20 5b 53 51   with the.** [SQ
15870 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 53 51 4c 4c  LITE_ENABLE_SQLL
15880 4f 47 5d 20 70 72 65 2d 70 72 6f 63 65 73 73 6f  OG] pre-processo
15890 72 20 6d 61 63 72 6f 20 64 65 66 69 6e 65 64 2e  r macro defined.
158a0 20 54 68 65 20 66 69 72 73 74 20 61 72 67 75 6d   The first argum
158b0 65 6e 74 20 73 68 6f 75 6c 64 0a 2a 2a 20 62 65  ent should.** be
158c0 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 20   a pointer to a 
158d0 66 75 6e 63 74 69 6f 6e 20 6f 66 20 74 79 70 65  function of type
158e0 20 76 6f 69 64 28 2a 29 28 76 6f 69 64 2a 2c 73   void(*)(void*,s
158f0 71 6c 69 74 65 33 2a 2c 63 6f 6e 73 74 20 63 68  qlite3*,const ch
15900 61 72 2a 2c 20 69 6e 74 29 2e 0a 2a 2a 20 54 68  ar*, int)..** Th
15910 65 20 73 65 63 6f 6e 64 20 73 68 6f 75 6c 64 20  e second should 
15920 62 65 20 6f 66 20 74 79 70 65 20 28 76 6f 69 64  be of type (void
15930 2a 29 2e 20 54 68 65 20 63 61 6c 6c 62 61 63 6b  *). The callback
15940 20 69 73 20 69 6e 76 6f 6b 65 64 20 62 79 20 74   is invoked by t
15950 68 65 20 6c 69 62 72 61 72 79 0a 2a 2a 20 69 6e  he library.** in
15960 20 74 68 72 65 65 20 73 65 70 61 72 61 74 65 20   three separate 
15970 63 69 72 63 75 6d 73 74 61 6e 63 65 73 2c 20 69  circumstances, i
15980 64 65 6e 74 69 66 69 65 64 20 62 79 20 74 68 65  dentified by the
15990 20 76 61 6c 75 65 20 70 61 73 73 65 64 20 61 73   value passed as
159a0 20 74 68 65 0a 2a 2a 20 66 6f 75 72 74 68 20 70   the.** fourth p
159b0 61 72 61 6d 65 74 65 72 2e 20 49 66 20 74 68 65  arameter. If the
159c0 20 66 6f 75 72 74 68 20 70 61 72 61 6d 65 74 65   fourth paramete
159d0 72 20 69 73 20 30 2c 20 74 68 65 6e 20 74 68 65  r is 0, then the
159e0 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63   database connec
159f0 74 69 6f 6e 0a 2a 2a 20 70 61 73 73 65 64 20 61  tion.** passed a
15a00 73 20 74 68 65 20 73 65 63 6f 6e 64 20 61 72 67  s the second arg
15a10 75 6d 65 6e 74 20 68 61 73 20 6a 75 73 74 20 62  ument has just b
15a20 65 65 6e 20 6f 70 65 6e 65 64 2e 20 54 68 65 20  een opened. The 
15a30 74 68 69 72 64 20 61 72 67 75 6d 65 6e 74 0a 2a  third argument.*
15a40 2a 20 70 6f 69 6e 74 73 20 74 6f 20 61 20 62 75  * points to a bu
15a50 66 66 65 72 20 63 6f 6e 74 61 69 6e 69 6e 67 20  ffer containing 
15a60 74 68 65 20 6e 61 6d 65 20 6f 66 20 74 68 65 20  the name of the 
15a70 6d 61 69 6e 20 64 61 74 61 62 61 73 65 20 66 69  main database fi
15a80 6c 65 2e 20 49 66 20 74 68 65 0a 2a 2a 20 66 6f  le. If the.** fo
15a90 75 72 74 68 20 70 61 72 61 6d 65 74 65 72 20 69  urth parameter i
15aa0 73 20 31 2c 20 74 68 65 6e 20 74 68 65 20 53 51  s 1, then the SQ
15ab0 4c 20 73 74 61 74 65 6d 65 6e 74 20 74 68 61 74  L statement that
15ac0 20 74 68 65 20 74 68 69 72 64 20 70 61 72 61 6d   the third param
15ad0 65 74 65 72 0a 2a 2a 20 70 6f 69 6e 74 73 20 74  eter.** points t
15ae0 6f 20 68 61 73 20 6a 75 73 74 20 62 65 65 6e 20  o has just been 
15af0 65 78 65 63 75 74 65 64 2e 20 4f 72 2c 20 69 66  executed. Or, if
15b00 20 74 68 65 20 66 6f 75 72 74 68 20 70 61 72 61   the fourth para
15b10 6d 65 74 65 72 20 69 73 20 32 2c 20 74 68 65 6e  meter is 2, then
15b20 0a 2a 2a 20 74 68 65 20 63 6f 6e 6e 65 63 74 69  .** the connecti
15b30 6f 6e 20 62 65 69 6e 67 20 70 61 73 73 65 64 20  on being passed 
15b40 61 73 20 74 68 65 20 73 65 63 6f 6e 64 20 70 61  as the second pa
15b50 72 61 6d 65 74 65 72 20 69 73 20 62 65 69 6e 67  rameter is being
15b60 20 63 6c 6f 73 65 64 2e 20 54 68 65 0a 2a 2a 20   closed. The.** 
15b70 74 68 69 72 64 20 70 61 72 61 6d 65 74 65 72 20  third parameter 
15b80 69 73 20 70 61 73 73 65 64 20 4e 55 4c 4c 20 49  is passed NULL I
15b90 6e 20 74 68 69 73 20 63 61 73 65 2e 20 20 41 6e  n this case.  An
15ba0 20 65 78 61 6d 70 6c 65 20 6f 66 20 75 73 69 6e   example of usin
15bb0 67 20 74 68 69 73 0a 2a 2a 20 63 6f 6e 66 69 67  g this.** config
15bc0 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 20 63  uration option c
15bd0 61 6e 20 62 65 20 73 65 65 6e 20 69 6e 20 74 68  an be seen in th
15be0 65 20 22 74 65 73 74 5f 73 71 6c 6c 6f 67 2e 63  e "test_sqllog.c
15bf0 22 20 73 6f 75 72 63 65 20 66 69 6c 65 20 69 6e  " source file in
15c00 0a 2a 2a 20 74 68 65 20 63 61 6e 6f 6e 69 63 61  .** the canonica
15c10 6c 20 53 51 4c 69 74 65 20 73 6f 75 72 63 65 20  l SQLite source 
15c20 74 72 65 65 2e 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a  tree.</dd>.**.**
15c30 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47   [[SQLITE_CONFIG
15c40 5f 4d 4d 41 50 5f 53 49 5a 45 5d 5d 0a 2a 2a 20  _MMAP_SIZE]].** 
15c50 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49  <dt>SQLITE_CONFI
15c60 47 5f 4d 4d 41 50 5f 53 49 5a 45 0a 2a 2a 20 3c  G_MMAP_SIZE.** <
15c70 64 64 3e 5e 53 51 4c 49 54 45 5f 43 4f 4e 46 49  dd>^SQLITE_CONFI
15c80 47 5f 4d 4d 41 50 5f 53 49 5a 45 20 74 61 6b 65  G_MMAP_SIZE take
15c90 73 20 74 77 6f 20 36 34 2d 62 69 74 20 69 6e 74  s two 64-bit int
15ca0 65 67 65 72 20 28 73 71 6c 69 74 65 33 5f 69 6e  eger (sqlite3_in
15cb0 74 36 34 29 20 76 61 6c 75 65 73 0a 2a 2a 20 74  t64) values.** t
15cc0 68 61 74 20 61 72 65 20 74 68 65 20 64 65 66 61  hat are the defa
15cd0 75 6c 74 20 6d 6d 61 70 20 73 69 7a 65 20 6c 69  ult mmap size li
15ce0 6d 69 74 20 28 74 68 65 20 64 65 66 61 75 6c 74  mit (the default
15cf0 20 73 65 74 74 69 6e 67 20 66 6f 72 0a 2a 2a 20   setting for.** 
15d00 5b 50 52 41 47 4d 41 20 6d 6d 61 70 5f 73 69 7a  [PRAGMA mmap_siz
15d10 65 5d 29 20 61 6e 64 20 74 68 65 20 6d 61 78 69  e]) and the maxi
15d20 6d 75 6d 20 61 6c 6c 6f 77 65 64 20 6d 6d 61 70  mum allowed mmap
15d30 20 73 69 7a 65 20 6c 69 6d 69 74 2e 0a 2a 2a 20   size limit..** 
15d40 5e 54 68 65 20 64 65 66 61 75 6c 74 20 73 65 74  ^The default set
15d50 74 69 6e 67 20 63 61 6e 20 62 65 20 6f 76 65 72  ting can be over
15d60 72 69 64 64 65 6e 20 62 79 20 65 61 63 68 20 64  ridden by each d
15d70 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
15d80 6f 6e 20 75 73 69 6e 67 0a 2a 2a 20 65 69 74 68  on using.** eith
15d90 65 72 20 74 68 65 20 5b 50 52 41 47 4d 41 20 6d  er the [PRAGMA m
15da0 6d 61 70 5f 73 69 7a 65 5d 20 63 6f 6d 6d 61 6e  map_size] comman
15db0 64 2c 20 6f 72 20 62 79 20 75 73 69 6e 67 20 74  d, or by using t
15dc0 68 65 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 46 43  he.** [SQLITE_FC
15dd0 4e 54 4c 5f 4d 4d 41 50 5f 53 49 5a 45 5d 20 66  NTL_MMAP_SIZE] f
15de0 69 6c 65 20 63 6f 6e 74 72 6f 6c 2e 20 20 5e 28  ile control.  ^(
15df0 54 68 65 20 6d 61 78 69 6d 75 6d 20 61 6c 6c 6f  The maximum allo
15e00 77 65 64 20 6d 6d 61 70 20 73 69 7a 65 0a 2a 2a  wed mmap size.**
15e10 20 77 69 6c 6c 20 62 65 20 73 69 6c 65 6e 74 6c   will be silentl
15e20 79 20 74 72 75 6e 63 61 74 65 64 20 69 66 20 6e  y truncated if n
15e30 65 63 65 73 73 61 72 79 20 73 6f 20 74 68 61 74  ecessary so that
15e40 20 69 74 20 64 6f 65 73 20 6e 6f 74 20 65 78 63   it does not exc
15e50 65 65 64 20 74 68 65 0a 2a 2a 20 63 6f 6d 70 69  eed the.** compi
15e60 6c 65 2d 74 69 6d 65 20 6d 61 78 69 6d 75 6d 20  le-time maximum 
15e70 6d 6d 61 70 20 73 69 7a 65 20 73 65 74 20 62 79  mmap size set by
15e80 20 74 68 65 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f   the.** [SQLITE_
15e90 4d 41 58 5f 4d 4d 41 50 5f 53 49 5a 45 5d 20 63  MAX_MMAP_SIZE] c
15ea0 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69  ompile-time opti
15eb0 6f 6e 2e 29 5e 0a 2a 2a 20 5e 49 66 20 65 69 74  on.)^.** ^If eit
15ec0 68 65 72 20 61 72 67 75 6d 65 6e 74 20 74 6f 20  her argument to 
15ed0 74 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 6e  this option is n
15ee0 65 67 61 74 69 76 65 2c 20 74 68 65 6e 20 74 68  egative, then th
15ef0 61 74 20 61 72 67 75 6d 65 6e 74 20 69 73 0a 2a  at argument is.*
15f00 2a 20 63 68 61 6e 67 65 64 20 74 6f 20 69 74 73  * changed to its
15f10 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 64 65   compile-time de
15f20 66 61 75 6c 74 2e 0a 2a 2a 0a 2a 2a 20 5b 5b 53  fault..**.** [[S
15f30 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 57 49 4e  QLITE_CONFIG_WIN
15f40 33 32 5f 48 45 41 50 53 49 5a 45 5d 5d 0a 2a 2a  32_HEAPSIZE]].**
15f50 20 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46   <dt>SQLITE_CONF
15f60 49 47 5f 57 49 4e 33 32 5f 48 45 41 50 53 49 5a  IG_WIN32_HEAPSIZ
15f70 45 0a 2a 2a 20 3c 64 64 3e 5e 54 68 65 20 53 51  E.** <dd>^The SQ
15f80 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 57 49 4e 33  LITE_CONFIG_WIN3
15f90 32 5f 48 45 41 50 53 49 5a 45 20 6f 70 74 69 6f  2_HEAPSIZE optio
15fa0 6e 20 69 73 20 6f 6e 6c 79 20 61 76 61 69 6c 61  n is only availa
15fb0 62 6c 65 20 69 66 20 53 51 4c 69 74 65 20 69 73  ble if SQLite is
15fc0 0a 2a 2a 20 63 6f 6d 70 69 6c 65 64 20 66 6f 72  .** compiled for
15fd0 20 57 69 6e 64 6f 77 73 20 77 69 74 68 20 74 68   Windows with th
15fe0 65 20 5b 53 51 4c 49 54 45 5f 57 49 4e 33 32 5f  e [SQLITE_WIN32_
15ff0 4d 41 4c 4c 4f 43 5d 20 70 72 65 2d 70 72 6f 63  MALLOC] pre-proc
16000 65 73 73 6f 72 20 6d 61 63 72 6f 0a 2a 2a 20 64  essor macro.** d
16010 65 66 69 6e 65 64 2e 20 5e 53 51 4c 49 54 45 5f  efined. ^SQLITE_
16020 43 4f 4e 46 49 47 5f 57 49 4e 33 32 5f 48 45 41  CONFIG_WIN32_HEA
16030 50 53 49 5a 45 20 74 61 6b 65 73 20 61 20 33 32  PSIZE takes a 32
16040 2d 62 69 74 20 75 6e 73 69 67 6e 65 64 20 69 6e  -bit unsigned in
16050 74 65 67 65 72 20 76 61 6c 75 65 0a 2a 2a 20 74  teger value.** t
16060 68 61 74 20 73 70 65 63 69 66 69 65 73 20 74 68  hat specifies th
16070 65 20 6d 61 78 69 6d 75 6d 20 73 69 7a 65 20 6f  e maximum size o
16080 66 20 74 68 65 20 63 72 65 61 74 65 64 20 68 65  f the created he
16090 61 70 2e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49  ap..**.** [[SQLI
160a0 54 45 5f 43 4f 4e 46 49 47 5f 50 43 41 43 48 45  TE_CONFIG_PCACHE
160b0 5f 48 44 52 53 5a 5d 5d 0a 2a 2a 20 3c 64 74 3e  _HDRSZ]].** <dt>
160c0 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 50 43  SQLITE_CONFIG_PC
160d0 41 43 48 45 5f 48 44 52 53 5a 0a 2a 2a 20 3c 64  ACHE_HDRSZ.** <d
160e0 64 3e 5e 54 68 65 20 53 51 4c 49 54 45 5f 43 4f  d>^The SQLITE_CO
160f0 4e 46 49 47 5f 50 43 41 43 48 45 5f 48 44 52 53  NFIG_PCACHE_HDRS
16100 5a 20 6f 70 74 69 6f 6e 20 74 61 6b 65 73 20 61  Z option takes a
16110 20 73 69 6e 67 6c 65 20 70 61 72 61 6d 65 74 65   single paramete
16120 72 20 77 68 69 63 68 0a 2a 2a 20 69 73 20 61 20  r which.** is a 
16130 70 6f 69 6e 74 65 72 20 74 6f 20 61 6e 20 69 6e  pointer to an in
16140 74 65 67 65 72 20 61 6e 64 20 77 72 69 74 65 73  teger and writes
16150 20 69 6e 74 6f 20 74 68 61 74 20 69 6e 74 65 67   into that integ
16160 65 72 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66  er the number of
16170 20 65 78 74 72 61 0a 2a 2a 20 62 79 74 65 73 20   extra.** bytes 
16180 70 65 72 20 70 61 67 65 20 72 65 71 75 69 72 65  per page require
16190 64 20 66 6f 72 20 65 61 63 68 20 70 61 67 65 20  d for each page 
161a0 69 6e 20 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49  in [SQLITE_CONFI
161b0 47 5f 50 41 47 45 43 41 43 48 45 5d 2e 0a 2a 2a  G_PAGECACHE]..**
161c0 20 54 68 65 20 61 6d 6f 75 6e 74 20 6f 66 20 65   The amount of e
161d0 78 74 72 61 20 73 70 61 63 65 20 72 65 71 75 69  xtra space requi
161e0 72 65 64 20 63 61 6e 20 63 68 61 6e 67 65 20 64  red can change d
161f0 65 70 65 6e 64 69 6e 67 20 6f 6e 20 74 68 65 20  epending on the 
16200 63 6f 6d 70 69 6c 65 72 2c 0a 2a 2a 20 74 61 72  compiler,.** tar
16210 67 65 74 20 70 6c 61 74 66 6f 72 6d 2c 20 61 6e  get platform, an
16220 64 20 53 51 4c 69 74 65 20 76 65 72 73 69 6f 6e  d SQLite version
16230 2e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45  ..**.** [[SQLITE
16240 5f 43 4f 4e 46 49 47 5f 50 4d 41 53 5a 5d 5d 0a  _CONFIG_PMASZ]].
16250 2a 2a 20 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f  ** <dt>SQLITE_CO
16260 4e 46 49 47 5f 50 4d 41 53 5a 0a 2a 2a 20 3c 64  NFIG_PMASZ.** <d
16270 64 3e 5e 54 68 65 20 53 51 4c 49 54 45 5f 43 4f  d>^The SQLITE_CO
16280 4e 46 49 47 5f 50 4d 41 53 5a 20 6f 70 74 69 6f  NFIG_PMASZ optio
16290 6e 20 74 61 6b 65 73 20 61 20 73 69 6e 67 6c 65  n takes a single
162a0 20 70 61 72 61 6d 65 74 65 72 20 77 68 69 63 68   parameter which
162b0 0a 2a 2a 20 69 73 20 61 6e 20 75 6e 73 69 67 6e  .** is an unsign
162c0 65 64 20 69 6e 74 65 67 65 72 20 61 6e 64 20 73  ed integer and s
162d0 65 74 73 20 74 68 65 20 22 4d 69 6e 69 6d 75 6d  ets the "Minimum
162e0 20 50 4d 41 20 53 69 7a 65 22 20 66 6f 72 20 74   PMA Size" for t
162f0 68 65 20 6d 75 6c 74 69 74 68 72 65 61 64 65 64  he multithreaded
16300 0a 2a 2a 20 73 6f 72 74 65 72 20 74 6f 20 74 68  .** sorter to th
16310 61 74 20 69 6e 74 65 67 65 72 2e 20 20 54 68 65  at integer.  The
16320 20 64 65 66 61 75 6c 74 20 6d 69 6e 69 6d 75 6d   default minimum
16330 20 50 4d 41 20 53 69 7a 65 20 69 73 20 73 65 74   PMA Size is set
16340 20 62 79 20 74 68 65 0a 2a 2a 20 5b 53 51 4c 49   by the.** [SQLI
16350 54 45 5f 53 4f 52 54 45 52 5f 50 4d 41 53 5a 5d  TE_SORTER_PMASZ]
16360 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70   compile-time op
16370 74 69 6f 6e 2e 20 20 4e 65 77 20 74 68 72 65 61  tion.  New threa
16380 64 73 20 61 72 65 20 6c 61 75 6e 63 68 65 64 0a  ds are launched.
16390 2a 2a 20 74 6f 20 68 65 6c 70 20 77 69 74 68 20  ** to help with 
163a0 73 6f 72 74 20 6f 70 65 72 61 74 69 6f 6e 73 20  sort operations 
163b0 77 68 65 6e 20 6d 75 6c 74 69 74 68 72 65 61 64  when multithread
163c0 65 64 20 73 6f 72 74 69 6e 67 0a 2a 2a 20 69 73  ed sorting.** is
163d0 20 65 6e 61 62 6c 65 64 20 28 75 73 69 6e 67 20   enabled (using 
163e0 74 68 65 20 5b 50 52 41 47 4d 41 20 74 68 72 65  the [PRAGMA thre
163f0 61 64 73 5d 20 63 6f 6d 6d 61 6e 64 29 20 61 6e  ads] command) an
16400 64 20 74 68 65 20 61 6d 6f 75 6e 74 20 6f 66 20  d the amount of 
16410 63 6f 6e 74 65 6e 74 0a 2a 2a 20 74 6f 20 62 65  content.** to be
16420 20 73 6f 72 74 65 64 20 65 78 63 65 65 64 73 20   sorted exceeds 
16430 74 68 65 20 70 61 67 65 20 73 69 7a 65 20 74 69  the page size ti
16440 6d 65 73 20 74 68 65 20 6d 69 6e 69 6d 75 6d 20  mes the minimum 
16450 6f 66 20 74 68 65 0a 2a 2a 20 5b 50 52 41 47 4d  of the.** [PRAGM
16460 41 20 63 61 63 68 65 5f 73 69 7a 65 5d 20 73 65  A cache_size] se
16470 74 74 69 6e 67 20 61 6e 64 20 74 68 69 73 20 76  tting and this v
16480 61 6c 75 65 2e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51  alue..**.** [[SQ
16490 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53 54 4d 54  LITE_CONFIG_STMT
164a0 4a 52 4e 4c 5f 53 50 49 4c 4c 5d 5d 0a 2a 2a 20  JRNL_SPILL]].** 
164b0 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49  <dt>SQLITE_CONFI
164c0 47 5f 53 54 4d 54 4a 52 4e 4c 5f 53 50 49 4c 4c  G_STMTJRNL_SPILL
164d0 0a 2a 2a 20 3c 64 64 3e 5e 54 68 65 20 53 51 4c  .** <dd>^The SQL
164e0 49 54 45 5f 43 4f 4e 46 49 47 5f 53 54 4d 54 4a  ITE_CONFIG_STMTJ
164f0 52 4e 4c 5f 53 50 49 4c 4c 20 6f 70 74 69 6f 6e  RNL_SPILL option
16500 20 74 61 6b 65 73 20 61 20 73 69 6e 67 6c 65 20   takes a single 
16510 70 61 72 61 6d 65 74 65 72 20 77 68 69 63 68 0a  parameter which.
16520 2a 2a 20 62 65 63 6f 6d 65 73 20 74 68 65 20 5b  ** becomes the [
16530 73 74 61 74 65 6d 65 6e 74 20 6a 6f 75 72 6e 61  statement journa
16540 6c 5d 20 73 70 69 6c 6c 2d 74 6f 2d 64 69 73 6b  l] spill-to-disk
16550 20 74 68 72 65 73 68 6f 6c 64 2e 20 20 0a 2a 2a   threshold.  .**
16560 20 5b 53 74 61 74 65 6d 65 6e 74 20 6a 6f 75 72   [Statement jour
16570 6e 61 6c 73 5d 20 61 72 65 20 68 65 6c 64 20 69  nals] are held i
16580 6e 20 6d 65 6d 6f 72 79 20 75 6e 74 69 6c 20 74  n memory until t
16590 68 65 69 72 20 73 69 7a 65 20 28 69 6e 20 62 79  heir size (in by
165a0 74 65 73 29 0a 2a 2a 20 65 78 63 65 65 64 73 20  tes).** exceeds 
165b0 74 68 69 73 20 74 68 72 65 73 68 6f 6c 64 2c 20  this threshold, 
165c0 61 74 20 77 68 69 63 68 20 70 6f 69 6e 74 20 74  at which point t
165d0 68 65 79 20 61 72 65 20 77 72 69 74 74 65 6e 20  hey are written 
165e0 74 6f 20 64 69 73 6b 2e 0a 2a 2a 20 4f 72 20 69  to disk..** Or i
165f0 66 20 74 68 65 20 74 68 72 65 73 68 6f 6c 64 20  f the threshold 
16600 69 73 20 2d 31 2c 20 73 74 61 74 65 6d 65 6e 74  is -1, statement
16610 20 6a 6f 75 72 6e 61 6c 73 20 61 72 65 20 61 6c   journals are al
16620 77 61 79 73 20 68 65 6c 64 0a 2a 2a 20 65 78 63  ways held.** exc
16630 6c 75 73 69 76 65 6c 79 20 69 6e 20 6d 65 6d 6f  lusively in memo
16640 72 79 2e 0a 2a 2a 20 53 69 6e 63 65 20 6d 61 6e  ry..** Since man
16650 79 20 73 74 61 74 65 6d 65 6e 74 20 6a 6f 75 72  y statement jour
16660 6e 61 6c 73 20 6e 65 76 65 72 20 62 65 63 6f 6d  nals never becom
16670 65 20 6c 61 72 67 65 2c 20 73 65 74 74 69 6e 67  e large, setting
16680 20 74 68 65 20 73 70 69 6c 6c 0a 2a 2a 20 74 68   the spill.** th
16690 72 65 73 68 6f 6c 64 20 74 6f 20 61 20 76 61 6c  reshold to a val
166a0 75 65 20 73 75 63 68 20 61 73 20 36 34 4b 69 42  ue such as 64KiB
166b0 20 63 61 6e 20 67 72 65 61 74 6c 79 20 72 65 64   can greatly red
166c0 75 63 65 20 74 68 65 20 61 6d 6f 75 6e 74 20 6f  uce the amount o
166d0 66 0a 2a 2a 20 49 2f 4f 20 72 65 71 75 69 72 65  f.** I/O require
166e0 64 20 74 6f 20 73 75 70 70 6f 72 74 20 73 74 61  d to support sta
166f0 74 65 6d 65 6e 74 20 72 6f 6c 6c 62 61 63 6b 2e  tement rollback.
16700 0a 2a 2a 20 54 68 65 20 64 65 66 61 75 6c 74 20  .** The default 
16710 76 61 6c 75 65 20 66 6f 72 20 74 68 69 73 20 73  value for this s
16720 65 74 74 69 6e 67 20 69 73 20 63 6f 6e 74 72 6f  etting is contro
16730 6c 6c 65 64 20 62 79 20 74 68 65 0a 2a 2a 20 5b  lled by the.** [
16740 53 51 4c 49 54 45 5f 53 54 4d 54 4a 52 4e 4c 5f  SQLITE_STMTJRNL_
16750 53 50 49 4c 4c 5d 20 63 6f 6d 70 69 6c 65 2d 74  SPILL] compile-t
16760 69 6d 65 20 6f 70 74 69 6f 6e 2e 0a 2a 2a 20 3c  ime option..** <
16770 2f 64 6c 3e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20  /dl>.*/.#define 
16780 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53 49  SQLITE_CONFIG_SI
16790 4e 47 4c 45 54 48 52 45 41 44 20 20 31 20 20 2f  NGLETHREAD  1  /
167a0 2a 20 6e 69 6c 20 2a 2f 0a 23 64 65 66 69 6e 65  * nil */.#define
167b0 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d   SQLITE_CONFIG_M
167c0 55 4c 54 49 54 48 52 45 41 44 20 20 20 32 20 20  ULTITHREAD   2  
167d0 2f 2a 20 6e 69 6c 20 2a 2f 0a 23 64 65 66 69 6e  /* nil */.#defin
167e0 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  e SQLITE_CONFIG_
167f0 53 45 52 49 41 4c 49 5a 45 44 20 20 20 20 33 20  SERIALIZED    3 
16800 20 2f 2a 20 6e 69 6c 20 2a 2f 0a 23 64 65 66 69   /* nil */.#defi
16810 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47  ne SQLITE_CONFIG
16820 5f 4d 41 4c 4c 4f 43 20 20 20 20 20 20 20 20 34  _MALLOC        4
16830 20 20 2f 2a 20 73 71 6c 69 74 65 33 5f 6d 65 6d    /* sqlite3_mem
16840 5f 6d 65 74 68 6f 64 73 2a 20 2a 2f 0a 23 64 65  _methods* */.#de
16850 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46  fine SQLITE_CONF
16860 49 47 5f 47 45 54 4d 41 4c 4c 4f 43 20 20 20 20  IG_GETMALLOC    
16870 20 35 20 20 2f 2a 20 73 71 6c 69 74 65 33 5f 6d   5  /* sqlite3_m
16880 65 6d 5f 6d 65 74 68 6f 64 73 2a 20 2a 2f 0a 23  em_methods* */.#
16890 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f  define SQLITE_CO
168a0 4e 46 49 47 5f 53 43 52 41 54 43 48 20 20 20 20  NFIG_SCRATCH    
168b0 20 20 20 36 20 20 2f 2a 20 76 6f 69 64 2a 2c 20     6  /* void*, 
168c0 69 6e 74 20 73 7a 2c 20 69 6e 74 20 4e 20 2a 2f  int sz, int N */
168d0 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
168e0 43 4f 4e 46 49 47 5f 50 41 47 45 43 41 43 48 45  CONFIG_PAGECACHE
168f0 20 20 20 20 20 37 20 20 2f 2a 20 76 6f 69 64 2a       7  /* void*
16900 2c 20 69 6e 74 20 73 7a 2c 20 69 6e 74 20 4e 20  , int sz, int N 
16910 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
16920 45 5f 43 4f 4e 46 49 47 5f 48 45 41 50 20 20 20  E_CONFIG_HEAP   
16930 20 20 20 20 20 20 20 38 20 20 2f 2a 20 76 6f 69         8  /* voi
16940 64 2a 2c 20 69 6e 74 20 6e 42 79 74 65 2c 20 69  d*, int nByte, i
16950 6e 74 20 6d 69 6e 20 2a 2f 0a 23 64 65 66 69 6e  nt min */.#defin
16960 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  e SQLITE_CONFIG_
16970 4d 45 4d 53 54 41 54 55 53 20 20 20 20 20 39 20  MEMSTATUS     9 
16980 20 2f 2a 20 62 6f 6f 6c 65 61 6e 20 2a 2f 0a 23   /* boolean */.#
16990 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f  define SQLITE_CO
169a0 4e 46 49 47 5f 4d 55 54 45 58 20 20 20 20 20 20  NFIG_MUTEX      
169b0 20 20 31 30 20 20 2f 2a 20 73 71 6c 69 74 65 33    10  /* sqlite3
169c0 5f 6d 75 74 65 78 5f 6d 65 74 68 6f 64 73 2a 20  _mutex_methods* 
169d0 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
169e0 45 5f 43 4f 4e 46 49 47 5f 47 45 54 4d 55 54 45  E_CONFIG_GETMUTE
169f0 58 20 20 20 20 20 31 31 20 20 2f 2a 20 73 71 6c  X     11  /* sql
16a00 69 74 65 33 5f 6d 75 74 65 78 5f 6d 65 74 68 6f  ite3_mutex_metho
16a10 64 73 2a 20 2a 2f 0a 2f 2a 20 70 72 65 76 69 6f  ds* */./* previo
16a20 75 73 6c 79 20 53 51 4c 49 54 45 5f 43 4f 4e 46  usly SQLITE_CONF
16a30 49 47 5f 43 48 55 4e 4b 41 4c 4c 4f 43 20 31 32  IG_CHUNKALLOC 12
16a40 20 77 68 69 63 68 20 69 73 20 6e 6f 77 20 75 6e   which is now un
16a50 75 73 65 64 2e 20 2a 2f 20 0a 23 64 65 66 69 6e  used. */ .#defin
16a60 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  e SQLITE_CONFIG_
16a70 4c 4f 4f 4b 41 53 49 44 45 20 20 20 20 31 33 20  LOOKASIDE    13 
16a80 20 2f 2a 20 69 6e 74 20 69 6e 74 20 2a 2f 0a 23   /* int int */.#
16a90 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f  define SQLITE_CO
16aa0 4e 46 49 47 5f 50 43 41 43 48 45 20 20 20 20 20  NFIG_PCACHE     
16ab0 20 20 31 34 20 20 2f 2a 20 6e 6f 2d 6f 70 20 2a    14  /* no-op *
16ac0 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
16ad0 5f 43 4f 4e 46 49 47 5f 47 45 54 50 43 41 43 48  _CONFIG_GETPCACH
16ae0 45 20 20 20 20 31 35 20 20 2f 2a 20 6e 6f 2d 6f  E    15  /* no-o
16af0 70 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c  p */.#define SQL
16b00 49 54 45 5f 43 4f 4e 46 49 47 5f 4c 4f 47 20 20  ITE_CONFIG_LOG  
16b10 20 20 20 20 20 20 20 20 31 36 20 20 2f 2a 20 78          16  /* x
16b20 46 75 6e 63 2c 20 76 6f 69 64 2a 20 2a 2f 0a 23  Func, void* */.#
16b30 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f  define SQLITE_CO
16b40 4e 46 49 47 5f 55 52 49 20 20 20 20 20 20 20 20  NFIG_URI        
16b50 20 20 31 37 20 20 2f 2a 20 69 6e 74 20 2a 2f 0a    17  /* int */.
16b60 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43  #define SQLITE_C
16b70 4f 4e 46 49 47 5f 50 43 41 43 48 45 32 20 20 20  ONFIG_PCACHE2   
16b80 20 20 20 31 38 20 20 2f 2a 20 73 71 6c 69 74 65     18  /* sqlite
16b90 33 5f 70 63 61 63 68 65 5f 6d 65 74 68 6f 64 73  3_pcache_methods
16ba0 32 2a 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51  2* */.#define SQ
16bb0 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 47 45 54 50  LITE_CONFIG_GETP
16bc0 43 41 43 48 45 32 20 20 20 31 39 20 20 2f 2a 20  CACHE2   19  /* 
16bd0 73 71 6c 69 74 65 33 5f 70 63 61 63 68 65 5f 6d  sqlite3_pcache_m
16be0 65 74 68 6f 64 73 32 2a 20 2a 2f 0a 23 64 65 66  ethods2* */.#def
16bf0 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49  ine SQLITE_CONFI
16c00 47 5f 43 4f 56 45 52 49 4e 47 5f 49 4e 44 45 58  G_COVERING_INDEX
16c10 5f 53 43 41 4e 20 32 30 20 20 2f 2a 20 69 6e 74  _SCAN 20  /* int
16c20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
16c30 54 45 5f 43 4f 4e 46 49 47 5f 53 51 4c 4c 4f 47  TE_CONFIG_SQLLOG
16c40 20 20 20 20 20 20 20 32 31 20 20 2f 2a 20 78 53         21  /* xS
16c50 71 6c 6c 6f 67 2c 20 76 6f 69 64 2a 20 2a 2f 0a  qllog, void* */.
16c60 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43  #define SQLITE_C
16c70 4f 4e 46 49 47 5f 4d 4d 41 50 5f 53 49 5a 45 20  ONFIG_MMAP_SIZE 
16c80 20 20 20 32 32 20 20 2f 2a 20 73 71 6c 69 74 65     22  /* sqlite
16c90 33 5f 69 6e 74 36 34 2c 20 73 71 6c 69 74 65 33  3_int64, sqlite3
16ca0 5f 69 6e 74 36 34 20 2a 2f 0a 23 64 65 66 69 6e  _int64 */.#defin
16cb0 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  e SQLITE_CONFIG_
16cc0 57 49 4e 33 32 5f 48 45 41 50 53 49 5a 45 20 20  WIN32_HEAPSIZE  
16cd0 20 20 20 20 32 33 20 20 2f 2a 20 69 6e 74 20 6e      23  /* int n
16ce0 42 79 74 65 20 2a 2f 0a 23 64 65 66 69 6e 65 20  Byte */.#define 
16cf0 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 50 43  SQLITE_CONFIG_PC
16d00 41 43 48 45 5f 48 44 52 53 5a 20 20 20 20 20 20  ACHE_HDRSZ      
16d10 20 20 32 34 20 20 2f 2a 20 69 6e 74 20 2a 70 73    24  /* int *ps
16d20 7a 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c  z */.#define SQL
16d30 49 54 45 5f 43 4f 4e 46 49 47 5f 50 4d 41 53 5a  ITE_CONFIG_PMASZ
16d40 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 32                 2
16d50 35 20 20 2f 2a 20 75 6e 73 69 67 6e 65 64 20 69  5  /* unsigned i
16d60 6e 74 20 73 7a 50 6d 61 20 2a 2f 0a 23 64 65 66  nt szPma */.#def
16d70 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49  ine SQLITE_CONFI
16d80 47 5f 53 54 4d 54 4a 52 4e 4c 5f 53 50 49 4c 4c  G_STMTJRNL_SPILL
16d90 20 20 20 20 20 20 32 36 20 20 2f 2a 20 69 6e 74        26  /* int
16da0 20 6e 42 79 74 65 20 2a 2f 0a 0a 2f 2a 0a 2a 2a   nByte */../*.**
16db0 20 43 41 50 49 33 52 45 46 3a 20 44 61 74 61 62   CAPI3REF: Datab
16dc0 61 73 65 20 43 6f 6e 6e 65 63 74 69 6f 6e 20 43  ase Connection C
16dd0 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 4f 70 74  onfiguration Opt
16de0 69 6f 6e 73 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65  ions.**.** These
16df0 20 63 6f 6e 73 74 61 6e 74 73 20 61 72 65 20 74   constants are t
16e00 68 65 20 61 76 61 69 6c 61 62 6c 65 20 69 6e 74  he available int
16e10 65 67 65 72 20 63 6f 6e 66 69 67 75 72 61 74 69  eger configurati
16e20 6f 6e 20 6f 70 74 69 6f 6e 73 20 74 68 61 74 0a  on options that.
16e30 2a 2a 20 63 61 6e 20 62 65 20 70 61 73 73 65 64  ** can be passed
16e40 20 61 73 20 74 68 65 20 73 65 63 6f 6e 64 20 61   as the second a
16e50 72 67 75 6d 65 6e 74 20 74 6f 20 74 68 65 20 5b  rgument to the [
16e60 73 71 6c 69 74 65 33 5f 64 62 5f 63 6f 6e 66 69  sqlite3_db_confi
16e70 67 28 29 5d 20 69 6e 74 65 72 66 61 63 65 2e 0a  g()] interface..
16e80 2a 2a 0a 2a 2a 20 4e 65 77 20 63 6f 6e 66 69 67  **.** New config
16e90 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 73 20  uration options 
16ea0 6d 61 79 20 62 65 20 61 64 64 65 64 20 69 6e 20  may be added in 
16eb0 66 75 74 75 72 65 20 72 65 6c 65 61 73 65 73 20  future releases 
16ec0 6f 66 20 53 51 4c 69 74 65 2e 0a 2a 2a 20 45 78  of SQLite..** Ex
16ed0 69 73 74 69 6e 67 20 63 6f 6e 66 69 67 75 72 61  isting configura
16ee0 74 69 6f 6e 20 6f 70 74 69 6f 6e 73 20 6d 69 67  tion options mig
16ef0 68 74 20 62 65 20 64 69 73 63 6f 6e 74 69 6e 75  ht be discontinu
16f00 65 64 2e 20 20 41 70 70 6c 69 63 61 74 69 6f 6e  ed.  Application
16f10 73 0a 2a 2a 20 73 68 6f 75 6c 64 20 63 68 65 63  s.** should chec
16f20 6b 20 74 68 65 20 72 65 74 75 72 6e 20 63 6f 64  k the return cod
16f30 65 20 66 72 6f 6d 20 5b 73 71 6c 69 74 65 33 5f  e from [sqlite3_
16f40 64 62 5f 63 6f 6e 66 69 67 28 29 5d 20 74 6f 20  db_config()] to 
16f50 6d 61 6b 65 20 73 75 72 65 20 74 68 61 74 0a 2a  make sure that.*
16f60 2a 20 74 68 65 20 63 61 6c 6c 20 77 6f 72 6b 65  * the call worke
16f70 64 2e 20 20 5e 54 68 65 20 5b 73 71 6c 69 74 65  d.  ^The [sqlite
16f80 33 5f 64 62 5f 63 6f 6e 66 69 67 28 29 5d 20 69  3_db_config()] i
16f90 6e 74 65 72 66 61 63 65 20 77 69 6c 6c 20 72 65  nterface will re
16fa0 74 75 72 6e 20 61 0a 2a 2a 20 6e 6f 6e 2d 7a 65  turn a.** non-ze
16fb0 72 6f 20 5b 65 72 72 6f 72 20 63 6f 64 65 5d 20  ro [error code] 
16fc0 69 66 20 61 20 64 69 73 63 6f 6e 74 69 6e 75 65  if a discontinue
16fd0 64 20 6f 72 20 75 6e 73 75 70 70 6f 72 74 65 64  d or unsupported
16fe0 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f   configuration o
16ff0 70 74 69 6f 6e 0a 2a 2a 20 69 73 20 69 6e 76 6f  ption.** is invo
17000 6b 65 64 2e 0a 2a 2a 0a 2a 2a 20 3c 64 6c 3e 0a  ked..**.** <dl>.
17010 2a 2a 20 3c 64 74 3e 53 51 4c 49 54 45 5f 44 42  ** <dt>SQLITE_DB
17020 43 4f 4e 46 49 47 5f 4c 4f 4f 4b 41 53 49 44 45  CONFIG_LOOKASIDE
17030 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 54  </dt>.** <dd> ^T
17040 68 69 73 20 6f 70 74 69 6f 6e 20 74 61 6b 65 73  his option takes
17050 20 74 68 72 65 65 20 61 64 64 69 74 69 6f 6e 61   three additiona
17060 6c 20 61 72 67 75 6d 65 6e 74 73 20 74 68 61 74  l arguments that
17070 20 64 65 74 65 72 6d 69 6e 65 20 74 68 65 20 0a   determine the .
17080 2a 2a 20 5b 6c 6f 6f 6b 61 73 69 64 65 20 6d 65  ** [lookaside me
17090 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72 5d 20  mory allocator] 
170a0 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 66 6f  configuration fo
170b0 72 20 74 68 65 20 5b 64 61 74 61 62 61 73 65 20  r the [database 
170c0 63 6f 6e 6e 65 63 74 69 6f 6e 5d 2e 0a 2a 2a 20  connection]..** 
170d0 5e 54 68 65 20 66 69 72 73 74 20 61 72 67 75 6d  ^The first argum
170e0 65 6e 74 20 28 74 68 65 20 74 68 69 72 64 20 70  ent (the third p
170f0 61 72 61 6d 65 74 65 72 20 74 6f 20 5b 73 71 6c  arameter to [sql
17100 69 74 65 33 5f 64 62 5f 63 6f 6e 66 69 67 28 29  ite3_db_config()
17110 5d 20 69 73 20 61 0a 2a 2a 20 70 6f 69 6e 74 65  ] is a.** pointe
17120 72 20 74 6f 20 61 20 6d 65 6d 6f 72 79 20 62 75  r to a memory bu
17130 66 66 65 72 20 74 6f 20 75 73 65 20 66 6f 72 20  ffer to use for 
17140 6c 6f 6f 6b 61 73 69 64 65 20 6d 65 6d 6f 72 79  lookaside memory
17150 2e 0a 2a 2a 20 5e 54 68 65 20 66 69 72 73 74 20  ..** ^The first 
17160 61 72 67 75 6d 65 6e 74 20 61 66 74 65 72 20 74  argument after t
17170 68 65 20 53 51 4c 49 54 45 5f 44 42 43 4f 4e 46  he SQLITE_DBCONF
17180 49 47 5f 4c 4f 4f 4b 41 53 49 44 45 20 76 65 72  IG_LOOKASIDE ver
17190 62 0a 2a 2a 20 6d 61 79 20 62 65 20 4e 55 4c 4c  b.** may be NULL
171a0 20 69 6e 20 77 68 69 63 68 20 63 61 73 65 20 53   in which case S
171b0 51 4c 69 74 65 20 77 69 6c 6c 20 61 6c 6c 6f 63  QLite will alloc
171c0 61 74 65 20 74 68 65 0a 2a 2a 20 6c 6f 6f 6b 61  ate the.** looka
171d0 73 69 64 65 20 62 75 66 66 65 72 20 69 74 73 65  side buffer itse
171e0 6c 66 20 75 73 69 6e 67 20 5b 73 71 6c 69 74 65  lf using [sqlite
171f0 33 5f 6d 61 6c 6c 6f 63 28 29 5d 2e 20 5e 54 68  3_malloc()]. ^Th
17200 65 20 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e  e second argumen
17210 74 20 69 73 20 74 68 65 0a 2a 2a 20 73 69 7a 65  t is the.** size
17220 20 6f 66 20 65 61 63 68 20 6c 6f 6f 6b 61 73 69   of each lookasi
17230 64 65 20 62 75 66 66 65 72 20 73 6c 6f 74 2e 20  de buffer slot. 
17240 20 5e 54 68 65 20 74 68 69 72 64 20 61 72 67 75   ^The third argu
17250 6d 65 6e 74 20 69 73 20 74 68 65 20 6e 75 6d 62  ment is the numb
17260 65 72 20 6f 66 0a 2a 2a 20 73 6c 6f 74 73 2e 20  er of.** slots. 
17270 20 54 68 65 20 73 69 7a 65 20 6f 66 20 74 68 65   The size of the
17280 20 62 75 66 66 65 72 20 69 6e 20 74 68 65 20 66   buffer in the f
17290 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20 6d 75  irst argument mu
172a0 73 74 20 62 65 20 67 72 65 61 74 65 72 20 74 68  st be greater th
172b0 61 6e 0a 2a 2a 20 6f 72 20 65 71 75 61 6c 20 74  an.** or equal t
172c0 6f 20 74 68 65 20 70 72 6f 64 75 63 74 20 6f 66  o the product of
172d0 20 74 68 65 20 73 65 63 6f 6e 64 20 61 6e 64 20   the second and 
172e0 74 68 69 72 64 20 61 72 67 75 6d 65 6e 74 73 2e  third arguments.
172f0 20 20 54 68 65 20 62 75 66 66 65 72 0a 2a 2a 20    The buffer.** 
17300 6d 75 73 74 20 62 65 20 61 6c 69 67 6e 65 64 20  must be aligned 
17310 74 6f 20 61 6e 20 38 2d 62 79 74 65 20 62 6f 75  to an 8-byte bou
17320 6e 64 61 72 79 2e 20 20 5e 49 66 20 74 68 65 20  ndary.  ^If the 
17330 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74 20  second argument 
17340 74 6f 0a 2a 2a 20 53 51 4c 49 54 45 5f 44 42 43  to.** SQLITE_DBC
17350 4f 4e 46 49 47 5f 4c 4f 4f 4b 41 53 49 44 45 20  ONFIG_LOOKASIDE 
17360 69 73 20 6e 6f 74 20 61 20 6d 75 6c 74 69 70 6c  is not a multipl
17370 65 20 6f 66 20 38 2c 20 69 74 20 69 73 20 69 6e  e of 8, it is in
17380 74 65 72 6e 61 6c 6c 79 0a 2a 2a 20 72 6f 75 6e  ternally.** roun
17390 64 65 64 20 64 6f 77 6e 20 74 6f 20 74 68 65 20  ded down to the 
173a0 6e 65 78 74 20 73 6d 61 6c 6c 65 72 20 6d 75 6c  next smaller mul
173b0 74 69 70 6c 65 20 6f 66 20 38 2e 20 20 5e 28 54  tiple of 8.  ^(T
173c0 68 65 20 6c 6f 6f 6b 61 73 69 64 65 20 6d 65 6d  he lookaside mem
173d0 6f 72 79 0a 2a 2a 20 63 6f 6e 66 69 67 75 72 61  ory.** configura
173e0 74 69 6f 6e 20 66 6f 72 20 61 20 64 61 74 61 62  tion for a datab
173f0 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 63  ase connection c
17400 61 6e 20 6f 6e 6c 79 20 62 65 20 63 68 61 6e 67  an only be chang
17410 65 64 20 77 68 65 6e 20 74 68 61 74 0a 2a 2a 20  ed when that.** 
17420 63 6f 6e 6e 65 63 74 69 6f 6e 20 69 73 20 6e 6f  connection is no
17430 74 20 63 75 72 72 65 6e 74 6c 79 20 75 73 69 6e  t currently usin
17440 67 20 6c 6f 6f 6b 61 73 69 64 65 20 6d 65 6d 6f  g lookaside memo
17450 72 79 2c 20 6f 72 20 69 6e 20 6f 74 68 65 72 20  ry, or in other 
17460 77 6f 72 64 73 0a 2a 2a 20 77 68 65 6e 20 74 68  words.** when th
17470 65 20 22 63 75 72 72 65 6e 74 20 76 61 6c 75 65  e "current value
17480 22 20 72 65 74 75 72 6e 65 64 20 62 79 0a 2a 2a  " returned by.**
17490 20 5b 73 71 6c 69 74 65 33 5f 64 62 5f 73 74 61   [sqlite3_db_sta
174a0 74 75 73 5d 28 44 2c 5b 53 51 4c 49 54 45 5f 43  tus](D,[SQLITE_C
174b0 4f 4e 46 49 47 5f 4c 4f 4f 4b 41 53 49 44 45 5d  ONFIG_LOOKASIDE]
174c0 2c 2e 2e 2e 29 20 69 73 20 7a 65 72 6f 2e 0a 2a  ,...) is zero..*
174d0 2a 20 41 6e 79 20 61 74 74 65 6d 70 74 20 74 6f  * Any attempt to
174e0 20 63 68 61 6e 67 65 20 74 68 65 20 6c 6f 6f 6b   change the look
174f0 61 73 69 64 65 20 6d 65 6d 6f 72 79 20 63 6f 6e  aside memory con
17500 66 69 67 75 72 61 74 69 6f 6e 20 77 68 65 6e 20  figuration when 
17510 6c 6f 6f 6b 61 73 69 64 65 0a 2a 2a 20 6d 65 6d  lookaside.** mem
17520 6f 72 79 20 69 73 20 69 6e 20 75 73 65 20 6c 65  ory is in use le
17530 61 76 65 73 20 74 68 65 20 63 6f 6e 66 69 67 75  aves the configu
17540 72 61 74 69 6f 6e 20 75 6e 63 68 61 6e 67 65 64  ration unchanged
17550 20 61 6e 64 20 72 65 74 75 72 6e 73 20 0a 2a 2a   and returns .**
17560 20 5b 53 51 4c 49 54 45 5f 42 55 53 59 5d 2e 29   [SQLITE_BUSY].)
17570 5e 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 3c 64 74  ^</dd>.**.** <dt
17580 3e 53 51 4c 49 54 45 5f 44 42 43 4f 4e 46 49 47  >SQLITE_DBCONFIG
17590 5f 45 4e 41 42 4c 45 5f 46 4b 45 59 3c 2f 64 74  _ENABLE_FKEY</dt
175a0 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 54 68 69 73 20  >.** <dd> ^This 
175b0 6f 70 74 69 6f 6e 20 69 73 20 75 73 65 64 20 74  option is used t
175c0 6f 20 65 6e 61 62 6c 65 20 6f 72 20 64 69 73 61  o enable or disa
175d0 62 6c 65 20 74 68 65 20 65 6e 66 6f 72 63 65 6d  ble the enforcem
175e0 65 6e 74 20 6f 66 0a 2a 2a 20 5b 66 6f 72 65 69  ent of.** [forei
175f0 67 6e 20 6b 65 79 20 63 6f 6e 73 74 72 61 69 6e  gn key constrain
17600 74 73 5d 2e 20 20 54 68 65 72 65 20 73 68 6f 75  ts].  There shou
17610 6c 64 20 62 65 20 74 77 6f 20 61 64 64 69 74 69  ld be two additi
17620 6f 6e 61 6c 20 61 72 67 75 6d 65 6e 74 73 2e 0a  onal arguments..
17630 2a 2a 20 54 68 65 20 66 69 72 73 74 20 61 72 67  ** The first arg
17640 75 6d 65 6e 74 20 69 73 20 61 6e 20 69 6e 74 65  ument is an inte
17650 67 65 72 20 77 68 69 63 68 20 69 73 20 30 20 74  ger which is 0 t
17660 6f 20 64 69 73 61 62 6c 65 20 46 4b 20 65 6e 66  o disable FK enf
17670 6f 72 63 65 6d 65 6e 74 2c 0a 2a 2a 20 70 6f 73  orcement,.** pos
17680 69 74 69 76 65 20 74 6f 20 65 6e 61 62 6c 65 20  itive to enable 
17690 46 4b 20 65 6e 66 6f 72 63 65 6d 65 6e 74 20 6f  FK enforcement o
176a0 72 20 6e 65 67 61 74 69 76 65 20 74 6f 20 6c 65  r negative to le
176b0 61 76 65 20 46 4b 20 65 6e 66 6f 72 63 65 6d 65  ave FK enforceme
176c0 6e 74 0a 2a 2a 20 75 6e 63 68 61 6e 67 65 64 2e  nt.** unchanged.
176d0 20 20 54 68 65 20 73 65 63 6f 6e 64 20 70 61 72    The second par
176e0 61 6d 65 74 65 72 20 69 73 20 61 20 70 6f 69 6e  ameter is a poin
176f0 74 65 72 20 74 6f 20 61 6e 20 69 6e 74 65 67 65  ter to an intege
17700 72 20 69 6e 74 6f 20 77 68 69 63 68 0a 2a 2a 20  r into which.** 
17710 69 73 20 77 72 69 74 74 65 6e 20 30 20 6f 72 20  is written 0 or 
17720 31 20 74 6f 20 69 6e 64 69 63 61 74 65 20 77 68  1 to indicate wh
17730 65 74 68 65 72 20 46 4b 20 65 6e 66 6f 72 63 65  ether FK enforce
17740 6d 65 6e 74 20 69 73 20 6f 66 66 20 6f 72 20 6f  ment is off or o
17750 6e 0a 2a 2a 20 66 6f 6c 6c 6f 77 69 6e 67 20 74  n.** following t
17760 68 69 73 20 63 61 6c 6c 2e 20 20 54 68 65 20 73  his call.  The s
17770 65 63 6f 6e 64 20 70 61 72 61 6d 65 74 65 72 20  econd parameter 
17780 6d 61 79 20 62 65 20 61 20 4e 55 4c 4c 20 70 6f  may be a NULL po
17790 69 6e 74 65 72 2c 20 69 6e 0a 2a 2a 20 77 68 69  inter, in.** whi
177a0 63 68 20 63 61 73 65 20 74 68 65 20 46 4b 20 65  ch case the FK e
177b0 6e 66 6f 72 63 65 6d 65 6e 74 20 73 65 74 74 69  nforcement setti
177c0 6e 67 20 69 73 20 6e 6f 74 20 72 65 70 6f 72 74  ng is not report
177d0 65 64 20 62 61 63 6b 2e 20 3c 2f 64 64 3e 0a 2a  ed back. </dd>.*
177e0 2a 0a 2a 2a 20 3c 64 74 3e 53 51 4c 49 54 45 5f  *.** <dt>SQLITE_
177f0 44 42 43 4f 4e 46 49 47 5f 45 4e 41 42 4c 45 5f  DBCONFIG_ENABLE_
17800 54 52 49 47 47 45 52 3c 2f 64 74 3e 0a 2a 2a 20  TRIGGER</dt>.** 
17810 3c 64 64 3e 20 5e 54 68 69 73 20 6f 70 74 69 6f  <dd> ^This optio
17820 6e 20 69 73 20 75 73 65 64 20 74 6f 20 65 6e 61  n is used to ena
17830 62 6c 65 20 6f 72 20 64 69 73 61 62 6c 65 20 5b  ble or disable [
17840 43 52 45 41 54 45 20 54 52 49 47 47 45 52 20 7c  CREATE TRIGGER |
17850 20 74 72 69 67 67 65 72 73 5d 2e 0a 2a 2a 20 54   triggers]..** T
17860 68 65 72 65 20 73 68 6f 75 6c 64 20 62 65 20 74  here should be t
17870 77 6f 20 61 64 64 69 74 69 6f 6e 61 6c 20 61 72  wo additional ar
17880 67 75 6d 65 6e 74 73 2e 0a 2a 2a 20 54 68 65 20  guments..** The 
17890 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20 69  first argument i
178a0 73 20 61 6e 20 69 6e 74 65 67 65 72 20 77 68 69  s an integer whi
178b0 63 68 20 69 73 20 30 20 74 6f 20 64 69 73 61 62  ch is 0 to disab
178c0 6c 65 20 74 72 69 67 67 65 72 73 2c 0a 2a 2a 20  le triggers,.** 
178d0 70 6f 73 69 74 69 76 65 20 74 6f 20 65 6e 61 62  positive to enab
178e0 6c 65 20 74 72 69 67 67 65 72 73 20 6f 72 20 6e  le triggers or n
178f0 65 67 61 74 69 76 65 20 74 6f 20 6c 65 61 76 65  egative to leave
17900 20 74 68 65 20 73 65 74 74 69 6e 67 20 75 6e 63   the setting unc
17910 68 61 6e 67 65 64 2e 0a 2a 2a 20 54 68 65 20 73  hanged..** The s
17920 65 63 6f 6e 64 20 70 61 72 61 6d 65 74 65 72 20  econd parameter 
17930 69 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20  is a pointer to 
17940 61 6e 20 69 6e 74 65 67 65 72 20 69 6e 74 6f 20  an integer into 
17950 77 68 69 63 68 0a 2a 2a 20 69 73 20 77 72 69 74  which.** is writ
17960 74 65 6e 20 30 20 6f 72 20 31 20 74 6f 20 69 6e  ten 0 or 1 to in
17970 64 69 63 61 74 65 20 77 68 65 74 68 65 72 20 74  dicate whether t
17980 72 69 67 67 65 72 73 20 61 72 65 20 64 69 73 61  riggers are disa
17990 62 6c 65 64 20 6f 72 20 65 6e 61 62 6c 65 64 0a  bled or enabled.
179a0 2a 2a 20 66 6f 6c 6c 6f 77 69 6e 67 20 74 68 69  ** following thi
179b0 73 20 63 61 6c 6c 2e 20 20 54 68 65 20 73 65 63  s call.  The sec
179c0 6f 6e 64 20 70 61 72 61 6d 65 74 65 72 20 6d 61  ond parameter ma
179d0 79 20 62 65 20 61 20 4e 55 4c 4c 20 70 6f 69 6e  y be a NULL poin
179e0 74 65 72 2c 20 69 6e 0a 2a 2a 20 77 68 69 63 68  ter, in.** which
179f0 20 63 61 73 65 20 74 68 65 20 74 72 69 67 67 65   case the trigge
17a00 72 20 73 65 74 74 69 6e 67 20 69 73 20 6e 6f 74  r setting is not
17a10 20 72 65 70 6f 72 74 65 64 20 62 61 63 6b 2e 20   reported back. 
17a20 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 3c 64 74 3e  </dd>.**.** <dt>
17a30 53 51 4c 49 54 45 5f 44 42 43 4f 4e 46 49 47 5f  SQLITE_DBCONFIG_
17a40 45 4e 41 42 4c 45 5f 46 54 53 33 5f 54 4f 4b 45  ENABLE_FTS3_TOKE
17a50 4e 49 5a 45 52 3c 2f 64 74 3e 0a 2a 2a 20 3c 64  NIZER</dt>.** <d
17a60 64 3e 20 5e 54 68 69 73 20 6f 70 74 69 6f 6e 20  d> ^This option 
17a70 69 73 20 75 73 65 64 20 74 6f 20 65 6e 61 62 6c  is used to enabl
17a80 65 20 6f 72 20 64 69 73 61 62 6c 65 20 74 68 65  e or disable the
17a90 20 74 77 6f 2d 61 72 67 75 6d 65 6e 74 0a 2a 2a   two-argument.**
17aa0 20 76 65 72 73 69 6f 6e 20 6f 66 20 74 68 65 20   version of the 
17ab0 5b 66 74 73 33 5f 74 6f 6b 65 6e 69 7a 65 72 28  [fts3_tokenizer(
17ac0 29 5d 20 66 75 6e 63 74 69 6f 6e 20 77 68 69 63  )] function whic
17ad0 68 20 69 73 20 70 61 72 74 20 6f 66 20 74 68 65  h is part of the
17ae0 0a 2a 2a 20 5b 46 54 53 33 5d 20 66 75 6c 6c 2d  .** [FTS3] full-
17af0 74 65 78 74 20 73 65 61 72 63 68 20 65 6e 67 69  text search engi
17b00 6e 65 20 65 78 74 65 6e 73 69 6f 6e 2e 0a 2a 2a  ne extension..**
17b10 20 54 68 65 72 65 20 73 68 6f 75 6c 64 20 62 65   There should be
17b20 20 74 77 6f 20 61 64 64 69 74 69 6f 6e 61 6c 20   two additional 
17b30 61 72 67 75 6d 65 6e 74 73 2e 0a 2a 2a 20 54 68  arguments..** Th
17b40 65 20 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74  e first argument
17b50 20 69 73 20 61 6e 20 69 6e 74 65 67 65 72 20 77   is an integer w
17b60 68 69 63 68 20 69 73 20 30 20 74 6f 20 64 69 73  hich is 0 to dis
17b70 61 62 6c 65 20 66 74 73 33 5f 74 6f 6b 65 6e 69  able fts3_tokeni
17b80 7a 65 72 28 29 20 6f 72 0a 2a 2a 20 70 6f 73 69  zer() or.** posi
17b90 74 69 76 65 20 74 6f 20 65 6e 61 62 6c 65 20 66  tive to enable f
17ba0 74 73 33 5f 74 6f 6b 65 6e 69 7a 65 72 28 29 20  ts3_tokenizer() 
17bb0 6f 72 20 6e 65 67 61 74 69 76 65 20 74 6f 20 6c  or negative to l
17bc0 65 61 76 65 20 74 68 65 20 73 65 74 74 69 6e 67  eave the setting
17bd0 0a 2a 2a 20 75 6e 63 68 61 6e 67 65 64 2e 0a 2a  .** unchanged..*
17be0 2a 20 54 68 65 20 73 65 63 6f 6e 64 20 70 61 72  * The second par
17bf0 61 6d 65 74 65 72 20 69 73 20 61 20 70 6f 69 6e  ameter is a poin
17c00 74 65 72 20 74 6f 20 61 6e 20 69 6e 74 65 67 65  ter to an intege
17c10 72 20 69 6e 74 6f 20 77 68 69 63 68 0a 2a 2a 20  r into which.** 
17c20 69 73 20 77 72 69 74 74 65 6e 20 30 20 6f 72 20  is written 0 or 
17c30 31 20 74 6f 20 69 6e 64 69 63 61 74 65 20 77 68  1 to indicate wh
17c40 65 74 68 65 72 20 66 74 73 33 5f 74 6f 6b 65 6e  ether fts3_token
17c50 69 7a 65 72 20 69 73 20 64 69 73 61 62 6c 65 64  izer is disabled
17c60 20 6f 72 20 65 6e 61 62 6c 65 64 0a 2a 2a 20 66   or enabled.** f
17c70 6f 6c 6c 6f 77 69 6e 67 20 74 68 69 73 20 63 61  ollowing this ca
17c80 6c 6c 2e 20 20 54 68 65 20 73 65 63 6f 6e 64 20  ll.  The second 
17c90 70 61 72 61 6d 65 74 65 72 20 6d 61 79 20 62 65  parameter may be
17ca0 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 2c   a NULL pointer,
17cb0 20 69 6e 0a 2a 2a 20 77 68 69 63 68 20 63 61 73   in.** which cas
17cc0 65 20 74 68 65 20 6e 65 77 20 73 65 74 74 69 6e  e the new settin
17cd0 67 20 69 73 20 6e 6f 74 20 72 65 70 6f 72 74 65  g is not reporte
17ce0 64 20 62 61 63 6b 2e 20 3c 2f 64 64 3e 0a 2a 2a  d back. </dd>.**
17cf0 0a 2a 2a 20 3c 64 74 3e 53 51 4c 49 54 45 5f 44  .** <dt>SQLITE_D
17d00 42 43 4f 4e 46 49 47 5f 45 4e 41 42 4c 45 5f 4c  BCONFIG_ENABLE_L
17d10 4f 41 44 5f 45 58 54 45 4e 53 49 4f 4e 3c 2f 64  OAD_EXTENSION</d
17d20 74 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 54 68 69 73  t>.** <dd> ^This
17d30 20 6f 70 74 69 6f 6e 20 69 73 20 75 73 65 64 20   option is used 
17d40 74 6f 20 65 6e 61 62 6c 65 20 6f 72 20 64 69 73  to enable or dis
17d50 61 62 6c 65 20 74 68 65 20 5b 73 71 6c 69 74 65  able the [sqlite
17d60 33 5f 6c 6f 61 64 5f 65 78 74 65 6e 73 69 6f 6e  3_load_extension
17d70 28 29 5d 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65  ()].** interface
17d80 20 69 6e 64 65 70 65 6e 64 65 6e 74 6c 79 20 6f   independently o
17d90 66 20 74 68 65 20 5b 6c 6f 61 64 5f 65 78 74 65  f the [load_exte
17da0 6e 73 69 6f 6e 28 29 5d 20 53 51 4c 20 66 75 6e  nsion()] SQL fun
17db0 63 74 69 6f 6e 2e 0a 2a 2a 20 54 68 65 20 5b 73  ction..** The [s
17dc0 71 6c 69 74 65 33 5f 65 6e 61 62 6c 65 5f 6c 6f  qlite3_enable_lo
17dd0 61 64 5f 65 78 74 65 6e 73 69 6f 6e 28 29 5d 20  ad_extension()] 
17de0 41 50 49 20 65 6e 61 62 6c 65 73 20 6f 72 20 64  API enables or d
17df0 69 73 61 62 6c 65 73 20 62 6f 74 68 20 74 68 65  isables both the
17e00 0a 2a 2a 20 43 2d 41 50 49 20 5b 73 71 6c 69 74  .** C-API [sqlit
17e10 65 33 5f 6c 6f 61 64 5f 65 78 74 65 6e 73 69 6f  e3_load_extensio
17e20 6e 28 29 5d 20 61 6e 64 20 74 68 65 20 53 51 4c  n()] and the SQL
17e30 20 66 75 6e 63 74 69 6f 6e 20 5b 6c 6f 61 64 5f   function [load_
17e40 65 78 74 65 6e 73 69 6f 6e 28 29 5d 2e 0a 2a 2a  extension()]..**
17e50 20 54 68 65 72 65 20 73 68 6f 75 6c 64 20 62 65   There should be
17e60 20 74 77 6f 20 61 64 64 69 74 69 6f 6e 61 6c 20   two additional 
17e70 61 72 67 75 6d 65 6e 74 73 2e 0a 2a 2a 20 57 68  arguments..** Wh
17e80 65 6e 20 74 68 65 20 66 69 72 73 74 20 61 72 67  en the first arg
17e90 75 6d 65 6e 74 20 74 6f 20 74 68 69 73 20 69 6e  ument to this in
17ea0 74 65 72 66 61 63 65 20 69 73 20 31 2c 20 74 68  terface is 1, th
17eb0 65 6e 20 6f 6e 6c 79 20 74 68 65 20 43 2d 41 50  en only the C-AP
17ec0 49 20 69 73 0a 2a 2a 20 65 6e 61 62 6c 65 64 20  I is.** enabled 
17ed0 61 6e 64 20 74 68 65 20 53 51 4c 20 66 75 6e 63  and the SQL func
17ee0 74 69 6f 6e 20 72 65 6d 61 69 6e 73 20 64 69 73  tion remains dis
17ef0 61 62 6c 65 64 2e 20 20 49 66 20 74 68 65 20 66  abled.  If the f
17f00 69 72 73 74 20 61 72 67 6d 65 6e 74 20 74 6f 0a  irst argment to.
17f10 2a 2a 20 74 68 69 73 20 69 6e 74 65 72 66 61 63  ** this interfac
17f20 65 20 69 73 20 30 2c 20 74 68 65 6e 20 62 6f 74  e is 0, then bot
17f30 68 20 74 68 65 20 43 2d 41 50 49 20 61 6e 64 20  h the C-API and 
17f40 74 68 65 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e  the SQL function
17f50 20 61 72 65 20 64 69 73 61 62 6c 65 64 2e 0a 2a   are disabled..*
17f60 2a 20 49 66 20 74 68 65 20 66 69 72 73 74 20 61  * If the first a
17f70 72 67 75 6d 65 6e 74 20 69 73 20 2d 31 2c 20 74  rgument is -1, t
17f80 68 65 6e 20 6e 6f 20 63 68 61 6e 67 65 73 20 61  hen no changes a
17f90 72 65 20 6d 61 64 65 20 74 6f 20 73 74 61 74 65  re made to state
17fa0 20 6f 66 20 65 69 74 68 65 72 20 74 68 65 0a 2a   of either the.*
17fb0 2a 20 43 2d 41 50 49 20 6f 72 20 74 68 65 20 53  * C-API or the S
17fc0 51 4c 20 66 75 6e 63 74 69 6f 6e 2e 0a 2a 2a 20  QL function..** 
17fd0 54 68 65 20 73 65 63 6f 6e 64 20 70 61 72 61 6d  The second param
17fe0 65 74 65 72 20 69 73 20 61 20 70 6f 69 6e 74 65  eter is a pointe
17ff0 72 20 74 6f 20 61 6e 20 69 6e 74 65 67 65 72 20  r to an integer 
18000 69 6e 74 6f 20 77 68 69 63 68 0a 2a 2a 20 69 73  into which.** is
18010 20 77 72 69 74 74 65 6e 20 30 20 6f 72 20 31 20   written 0 or 1 
18020 74 6f 20 69 6e 64 69 63 61 74 65 20 77 68 65 74  to indicate whet
18030 68 65 72 20 5b 73 71 6c 69 74 65 33 5f 6c 6f 61  her [sqlite3_loa
18040 64 5f 65 78 74 65 6e 73 69 6f 6e 28 29 5d 20 69  d_extension()] i
18050 6e 74 65 72 66 61 63 65 0a 2a 2a 20 69 73 20 64  nterface.** is d
18060 69 73 61 62 6c 65 64 20 6f 72 20 65 6e 61 62 6c  isabled or enabl
18070 65 64 20 66 6f 6c 6c 6f 77 69 6e 67 20 74 68 69  ed following thi
18080 73 20 63 61 6c 6c 2e 20 20 54 68 65 20 73 65 63  s call.  The sec
18090 6f 6e 64 20 70 61 72 61 6d 65 74 65 72 20 6d 61  ond parameter ma
180a0 79 0a 2a 2a 20 62 65 20 61 20 4e 55 4c 4c 20 70  y.** be a NULL p
180b0 6f 69 6e 74 65 72 2c 20 69 6e 20 77 68 69 63 68  ointer, in which
180c0 20 63 61 73 65 20 74 68 65 20 6e 65 77 20 73 65   case the new se
180d0 74 74 69 6e 67 20 69 73 20 6e 6f 74 20 72 65 70  tting is not rep
180e0 6f 72 74 65 64 20 62 61 63 6b 2e 0a 2a 2a 20 3c  orted back..** <
180f0 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 3c 2f 64 6c 3e  /dd>.**.** </dl>
18100 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  .*/.#define SQLI
18110 54 45 5f 44 42 43 4f 4e 46 49 47 5f 4c 4f 4f 4b  TE_DBCONFIG_LOOK
18120 41 53 49 44 45 20 20 20 20 20 20 20 20 20 20 20  ASIDE           
18130 20 20 31 30 30 31 20 2f 2a 20 76 6f 69 64 2a 20    1001 /* void* 
18140 69 6e 74 20 69 6e 74 20 2a 2f 0a 23 64 65 66 69  int int */.#defi
18150 6e 65 20 53 51 4c 49 54 45 5f 44 42 43 4f 4e 46  ne SQLITE_DBCONF
18160 49 47 5f 45 4e 41 42 4c 45 5f 46 4b 45 59 20 20  IG_ENABLE_FKEY  
18170 20 20 20 20 20 20 20 20 20 31 30 30 32 20 2f 2a           1002 /*
18180 20 69 6e 74 20 69 6e 74 2a 20 2a 2f 0a 23 64 65   int int* */.#de
18190 66 69 6e 65 20 53 51 4c 49 54 45 5f 44 42 43 4f  fine SQLITE_DBCO
181a0 4e 46 49 47 5f 45 4e 41 42 4c 45 5f 54 52 49 47  NFIG_ENABLE_TRIG
181b0 47 45 52 20 20 20 20 20 20 20 20 31 30 30 33 20  GER        1003 
181c0 2f 2a 20 69 6e 74 20 69 6e 74 2a 20 2a 2f 0a 23  /* int int* */.#
181d0 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 44 42  define SQLITE_DB
181e0 43 4f 4e 46 49 47 5f 45 4e 41 42 4c 45 5f 46 54  CONFIG_ENABLE_FT
181f0 53 33 5f 54 4f 4b 45 4e 49 5a 45 52 20 31 30 30  S3_TOKENIZER 100
18200 34 20 2f 2a 20 69 6e 74 20 69 6e 74 2a 20 2a 2f  4 /* int int* */
18210 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
18220 44 42 43 4f 4e 46 49 47 5f 45 4e 41 42 4c 45 5f  DBCONFIG_ENABLE_
18230 4c 4f 41 44 5f 45 58 54 45 4e 53 49 4f 4e 20 31  LOAD_EXTENSION 1
18240 30 30 35 20 2f 2a 20 69 6e 74 20 69 6e 74 2a 20  005 /* int int* 
18250 2a 2f 0a 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33  */.../*.** CAPI3
18260 52 45 46 3a 20 45 6e 61 62 6c 65 20 4f 72 20 44  REF: Enable Or D
18270 69 73 61 62 6c 65 20 45 78 74 65 6e 64 65 64 20  isable Extended 
18280 52 65 73 75 6c 74 20 43 6f 64 65 73 0a 2a 2a 20  Result Codes.** 
18290 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 0a  METHOD: sqlite3.
182a0 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74  **.** ^The sqlit
182b0 65 33 5f 65 78 74 65 6e 64 65 64 5f 72 65 73 75  e3_extended_resu
182c0 6c 74 5f 63 6f 64 65 73 28 29 20 72 6f 75 74 69  lt_codes() routi
182d0 6e 65 20 65 6e 61 62 6c 65 73 20 6f 72 20 64 69  ne enables or di
182e0 73 61 62 6c 65 73 20 74 68 65 0a 2a 2a 20 5b 65  sables the.** [e
182f0 78 74 65 6e 64 65 64 20 72 65 73 75 6c 74 20 63  xtended result c
18300 6f 64 65 73 5d 20 66 65 61 74 75 72 65 20 6f 66  odes] feature of
18310 20 53 51 4c 69 74 65 2e 20 5e 54 68 65 20 65 78   SQLite. ^The ex
18320 74 65 6e 64 65 64 20 72 65 73 75 6c 74 0a 2a 2a  tended result.**
18330 20 63 6f 64 65 73 20 61 72 65 20 64 69 73 61 62   codes are disab
18340 6c 65 64 20 62 79 20 64 65 66 61 75 6c 74 20 66  led by default f
18350 6f 72 20 68 69 73 74 6f 72 69 63 61 6c 20 63 6f  or historical co
18360 6d 70 61 74 69 62 69 6c 69 74 79 2e 0a 2a 2f 0a  mpatibility..*/.
18370 69 6e 74 20 73 71 6c 69 74 65 33 5f 65 78 74 65  int sqlite3_exte
18380 6e 64 65 64 5f 72 65 73 75 6c 74 5f 63 6f 64 65  nded_result_code
18390 73 28 73 71 6c 69 74 65 33 2a 2c 20 69 6e 74 20  s(sqlite3*, int 
183a0 6f 6e 6f 66 66 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43  onoff);../*.** C
183b0 41 50 49 33 52 45 46 3a 20 4c 61 73 74 20 49 6e  API3REF: Last In
183c0 73 65 72 74 20 52 6f 77 69 64 0a 2a 2a 20 4d 45  sert Rowid.** ME
183d0 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 0a 2a 2a  THOD: sqlite3.**
183e0 0a 2a 2a 20 5e 45 61 63 68 20 65 6e 74 72 79 20  .** ^Each entry 
183f0 69 6e 20 6d 6f 73 74 20 53 51 4c 69 74 65 20 74  in most SQLite t
18400 61 62 6c 65 73 20 28 65 78 63 65 70 74 20 66 6f  ables (except fo
18410 72 20 5b 57 49 54 48 4f 55 54 20 52 4f 57 49 44  r [WITHOUT ROWID
18420 5d 20 74 61 62 6c 65 73 29 0a 2a 2a 20 68 61 73  ] tables).** has
18430 20 61 20 75 6e 69 71 75 65 20 36 34 2d 62 69 74   a unique 64-bit
18440 20 73 69 67 6e 65 64 0a 2a 2a 20 69 6e 74 65 67   signed.** integ
18450 65 72 20 6b 65 79 20 63 61 6c 6c 65 64 20 74 68  er key called th
18460 65 20 5b 52 4f 57 49 44 20 7c 20 22 72 6f 77 69  e [ROWID | "rowi
18470 64 22 5d 2e 20 5e 54 68 65 20 72 6f 77 69 64 20  d"]. ^The rowid 
18480 69 73 20 61 6c 77 61 79 73 20 61 76 61 69 6c 61  is always availa
18490 62 6c 65 0a 2a 2a 20 61 73 20 61 6e 20 75 6e 64  ble.** as an und
184a0 65 63 6c 61 72 65 64 20 63 6f 6c 75 6d 6e 20 6e  eclared column n
184b0 61 6d 65 64 20 52 4f 57 49 44 2c 20 4f 49 44 2c  amed ROWID, OID,
184c0 20 6f 72 20 5f 52 4f 57 49 44 5f 20 61 73 20 6c   or _ROWID_ as l
184d0 6f 6e 67 20 61 73 20 74 68 6f 73 65 0a 2a 2a 20  ong as those.** 
184e0 6e 61 6d 65 73 20 61 72 65 20 6e 6f 74 20 61 6c  names are not al
184f0 73 6f 20 75 73 65 64 20 62 79 20 65 78 70 6c 69  so used by expli
18500 63 69 74 6c 79 20 64 65 63 6c 61 72 65 64 20 63  citly declared c
18510 6f 6c 75 6d 6e 73 2e 20 5e 49 66 0a 2a 2a 20 74  olumns. ^If.** t
18520 68 65 20 74 61 62 6c 65 20 68 61 73 20 61 20 63  he table has a c
18530 6f 6c 75 6d 6e 20 6f 66 20 74 79 70 65 20 5b 49  olumn of type [I
18540 4e 54 45 47 45 52 20 50 52 49 4d 41 52 59 20 4b  NTEGER PRIMARY K
18550 45 59 5d 20 74 68 65 6e 20 74 68 61 74 20 63 6f  EY] then that co
18560 6c 75 6d 6e 0a 2a 2a 20 69 73 20 61 6e 6f 74 68  lumn.** is anoth
18570 65 72 20 61 6c 69 61 73 20 66 6f 72 20 74 68 65  er alias for the
18580 20 72 6f 77 69 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54   rowid..**.** ^T
18590 68 65 20 73 71 6c 69 74 65 33 5f 6c 61 73 74 5f  he sqlite3_last_
185a0 69 6e 73 65 72 74 5f 72 6f 77 69 64 28 44 29 20  insert_rowid(D) 
185b0 69 6e 74 65 72 66 61 63 65 20 72 65 74 75 72 6e  interface return
185c0 73 20 74 68 65 20 5b 72 6f 77 69 64 5d 20 6f 66  s the [rowid] of
185d0 20 74 68 65 20 0a 2a 2a 20 6d 6f 73 74 20 72 65   the .** most re
185e0 63 65 6e 74 20 73 75 63 63 65 73 73 66 75 6c 20  cent successful 
185f0 5b 49 4e 53 45 52 54 5d 20 69 6e 74 6f 20 61 20  [INSERT] into a 
18600 72 6f 77 69 64 20 74 61 62 6c 65 20 6f 72 20 5b  rowid table or [
18610 76 69 72 74 75 61 6c 20 74 61 62 6c 65 5d 0a 2a  virtual table].*
18620 2a 20 6f 6e 20 64 61 74 61 62 61 73 65 20 63 6f  * on database co
18630 6e 6e 65 63 74 69 6f 6e 20 44 2e 0a 2a 2a 20 5e  nnection D..** ^
18640 49 6e 73 65 72 74 73 20 69 6e 74 6f 20 5b 57 49  Inserts into [WI
18650 54 48 4f 55 54 20 52 4f 57 49 44 5d 20 74 61 62  THOUT ROWID] tab
18660 6c 65 73 20 61 72 65 20 6e 6f 74 20 72 65 63 6f  les are not reco
18670 72 64 65 64 2e 0a 2a 2a 20 5e 49 66 20 6e 6f 20  rded..** ^If no 
18680 73 75 63 63 65 73 73 66 75 6c 20 5b 49 4e 53 45  successful [INSE
18690 52 54 5d 73 20 69 6e 74 6f 20 72 6f 77 69 64 20  RT]s into rowid 
186a0 74 61 62 6c 65 73 0a 2a 2a 20 68 61 76 65 20 65  tables.** have e
186b0 76 65 72 20 6f 63 63 75 72 72 65 64 20 6f 6e 20  ver occurred on 
186c0 74 68 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e  the database con
186d0 6e 65 63 74 69 6f 6e 20 44 2c 20 0a 2a 2a 20 74  nection D, .** t
186e0 68 65 6e 20 73 71 6c 69 74 65 33 5f 6c 61 73 74  hen sqlite3_last
186f0 5f 69 6e 73 65 72 74 5f 72 6f 77 69 64 28 44 29  _insert_rowid(D)
18700 20 72 65 74 75 72 6e 73 20 7a 65 72 6f 2e 0a 2a   returns zero..*
18710 2a 0a 2a 2a 20 5e 28 49 66 20 61 6e 20 5b 49 4e  *.** ^(If an [IN
18720 53 45 52 54 5d 20 6f 63 63 75 72 73 20 77 69 74  SERT] occurs wit
18730 68 69 6e 20 61 20 74 72 69 67 67 65 72 20 6f 72  hin a trigger or
18740 20 77 69 74 68 69 6e 20 61 20 5b 76 69 72 74 75   within a [virtu
18750 61 6c 20 74 61 62 6c 65 5d 0a 2a 2a 20 6d 65 74  al table].** met
18760 68 6f 64 2c 20 74 68 65 6e 20 74 68 69 73 20 72  hod, then this r
18770 6f 75 74 69 6e 65 20 77 69 6c 6c 20 72 65 74 75  outine will retu
18780 72 6e 20 74 68 65 20 5b 72 6f 77 69 64 5d 20 6f  rn the [rowid] o
18790 66 20 74 68 65 20 69 6e 73 65 72 74 65 64 0a 2a  f the inserted.*
187a0 2a 20 72 6f 77 20 61 73 20 6c 6f 6e 67 20 61 73  * row as long as
187b0 20 74 68 65 20 74 72 69 67 67 65 72 20 6f 72 20   the trigger or 
187c0 76 69 72 74 75 61 6c 20 74 61 62 6c 65 20 6d 65  virtual table me
187d0 74 68 6f 64 20 69 73 20 72 75 6e 6e 69 6e 67 2e  thod is running.
187e0 0a 2a 2a 20 42 75 74 20 6f 6e 63 65 20 74 68 65  .** But once the
187f0 20 74 72 69 67 67 65 72 20 6f 72 20 76 69 72 74   trigger or virt
18800 75 61 6c 20 74 61 62 6c 65 20 6d 65 74 68 6f 64  ual table method
18810 20 65 6e 64 73 2c 20 74 68 65 20 76 61 6c 75 65   ends, the value
18820 20 72 65 74 75 72 6e 65 64 20 0a 2a 2a 20 62 79   returned .** by
18830 20 74 68 69 73 20 72 6f 75 74 69 6e 65 20 72 65   this routine re
18840 76 65 72 74 73 20 74 6f 20 77 68 61 74 20 69 74  verts to what it
18850 20 77 61 73 20 62 65 66 6f 72 65 20 74 68 65 20   was before the 
18860 74 72 69 67 67 65 72 20 6f 72 20 76 69 72 74 75  trigger or virtu
18870 61 6c 0a 2a 2a 20 74 61 62 6c 65 20 6d 65 74 68  al.** table meth
18880 6f 64 20 62 65 67 61 6e 2e 29 5e 0a 2a 2a 0a 2a  od began.)^.**.*
18890 2a 20 5e 41 6e 20 5b 49 4e 53 45 52 54 5d 20 74  * ^An [INSERT] t
188a0 68 61 74 20 66 61 69 6c 73 20 64 75 65 20 74 6f  hat fails due to
188b0 20 61 20 63 6f 6e 73 74 72 61 69 6e 74 20 76 69   a constraint vi
188c0 6f 6c 61 74 69 6f 6e 20 69 73 20 6e 6f 74 20 61  olation is not a
188d0 0a 2a 2a 20 73 75 63 63 65 73 73 66 75 6c 20 5b  .** successful [
188e0 49 4e 53 45 52 54 5d 20 61 6e 64 20 64 6f 65 73  INSERT] and does
188f0 20 6e 6f 74 20 63 68 61 6e 67 65 20 74 68 65 20   not change the 
18900 76 61 6c 75 65 20 72 65 74 75 72 6e 65 64 20 62  value returned b
18910 79 20 74 68 69 73 0a 2a 2a 20 72 6f 75 74 69 6e  y this.** routin
18920 65 2e 20 20 5e 54 68 75 73 20 49 4e 53 45 52 54  e.  ^Thus INSERT
18930 20 4f 52 20 46 41 49 4c 2c 20 49 4e 53 45 52 54   OR FAIL, INSERT
18940 20 4f 52 20 49 47 4e 4f 52 45 2c 20 49 4e 53 45   OR IGNORE, INSE
18950 52 54 20 4f 52 20 52 4f 4c 4c 42 41 43 4b 2c 0a  RT OR ROLLBACK,.
18960 2a 2a 20 61 6e 64 20 49 4e 53 45 52 54 20 4f 52  ** and INSERT OR
18970 20 41 42 4f 52 54 20 6d 61 6b 65 20 6e 6f 20 63   ABORT make no c
18980 68 61 6e 67 65 73 20 74 6f 20 74 68 65 20 72 65  hanges to the re
18990 74 75 72 6e 20 76 61 6c 75 65 20 6f 66 20 74 68  turn value of th
189a0 69 73 0a 2a 2a 20 72 6f 75 74 69 6e 65 20 77 68  is.** routine wh
189b0 65 6e 20 74 68 65 69 72 20 69 6e 73 65 72 74 69  en their inserti
189c0 6f 6e 20 66 61 69 6c 73 2e 20 20 5e 28 57 68 65  on fails.  ^(Whe
189d0 6e 20 49 4e 53 45 52 54 20 4f 52 20 52 45 50 4c  n INSERT OR REPL
189e0 41 43 45 0a 2a 2a 20 65 6e 63 6f 75 6e 74 65 72  ACE.** encounter
189f0 73 20 61 20 63 6f 6e 73 74 72 61 69 6e 74 20 76  s a constraint v
18a00 69 6f 6c 61 74 69 6f 6e 2c 20 69 74 20 64 6f 65  iolation, it doe
18a10 73 20 6e 6f 74 20 66 61 69 6c 2e 20 20 54 68 65  s not fail.  The
18a20 0a 2a 2a 20 49 4e 53 45 52 54 20 63 6f 6e 74 69  .** INSERT conti
18a30 6e 75 65 73 20 74 6f 20 63 6f 6d 70 6c 65 74 69  nues to completi
18a40 6f 6e 20 61 66 74 65 72 20 64 65 6c 65 74 69 6e  on after deletin
18a50 67 20 72 6f 77 73 20 74 68 61 74 20 63 61 75 73  g rows that caus
18a60 65 64 0a 2a 2a 20 74 68 65 20 63 6f 6e 73 74 72  ed.** the constr
18a70 61 69 6e 74 20 70 72 6f 62 6c 65 6d 20 73 6f 20  aint problem so 
18a80 49 4e 53 45 52 54 20 4f 52 20 52 45 50 4c 41 43  INSERT OR REPLAC
18a90 45 20 77 69 6c 6c 20 61 6c 77 61 79 73 20 63 68  E will always ch
18aa0 61 6e 67 65 0a 2a 2a 20 74 68 65 20 72 65 74 75  ange.** the retu
18ab0 72 6e 20 76 61 6c 75 65 20 6f 66 20 74 68 69 73  rn value of this
18ac0 20 69 6e 74 65 72 66 61 63 65 2e 29 5e 0a 2a 2a   interface.)^.**
18ad0 0a 2a 2a 20 5e 46 6f 72 20 74 68 65 20 70 75 72  .** ^For the pur
18ae0 70 6f 73 65 73 20 6f 66 20 74 68 69 73 20 72 6f  poses of this ro
18af0 75 74 69 6e 65 2c 20 61 6e 20 5b 49 4e 53 45 52  utine, an [INSER
18b00 54 5d 20 69 73 20 63 6f 6e 73 69 64 65 72 65 64  T] is considered
18b10 20 74 6f 0a 2a 2a 20 62 65 20 73 75 63 63 65 73   to.** be succes
18b20 73 66 75 6c 20 65 76 65 6e 20 69 66 20 69 74 20  sful even if it 
18b30 69 73 20 73 75 62 73 65 71 75 65 6e 74 6c 79 20  is subsequently 
18b40 72 6f 6c 6c 65 64 20 62 61 63 6b 2e 0a 2a 2a 0a  rolled back..**.
18b50 2a 2a 20 54 68 69 73 20 66 75 6e 63 74 69 6f 6e  ** This function
18b60 20 69 73 20 61 63 63 65 73 73 69 62 6c 65 20 74   is accessible t
18b70 6f 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73  o SQL statements
18b80 20 76 69 61 20 74 68 65 0a 2a 2a 20 5b 6c 61 73   via the.** [las
18b90 74 5f 69 6e 73 65 72 74 5f 72 6f 77 69 64 28 29  t_insert_rowid()
18ba0 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 5d 2e 0a   SQL function]..
18bb0 2a 2a 0a 2a 2a 20 49 66 20 61 20 73 65 70 61 72  **.** If a separ
18bc0 61 74 65 20 74 68 72 65 61 64 20 70 65 72 66 6f  ate thread perfo
18bd0 72 6d 73 20 61 20 6e 65 77 20 5b 49 4e 53 45 52  rms a new [INSER
18be0 54 5d 20 6f 6e 20 74 68 65 20 73 61 6d 65 0a 2a  T] on the same.*
18bf0 2a 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65  * database conne
18c00 63 74 69 6f 6e 20 77 68 69 6c 65 20 74 68 65 20  ction while the 
18c10 5b 73 71 6c 69 74 65 33 5f 6c 61 73 74 5f 69 6e  [sqlite3_last_in
18c20 73 65 72 74 5f 72 6f 77 69 64 28 29 5d 0a 2a 2a  sert_rowid()].**
18c30 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 72 75 6e   function is run
18c40 6e 69 6e 67 20 61 6e 64 20 74 68 75 73 20 63 68  ning and thus ch
18c50 61 6e 67 65 73 20 74 68 65 20 6c 61 73 74 20 69  anges the last i
18c60 6e 73 65 72 74 20 5b 72 6f 77 69 64 5d 2c 0a 2a  nsert [rowid],.*
18c70 2a 20 74 68 65 6e 20 74 68 65 20 76 61 6c 75 65  * then the value
18c80 20 72 65 74 75 72 6e 65 64 20 62 79 20 5b 73 71   returned by [sq
18c90 6c 69 74 65 33 5f 6c 61 73 74 5f 69 6e 73 65 72  lite3_last_inser
18ca0 74 5f 72 6f 77 69 64 28 29 5d 20 69 73 0a 2a 2a  t_rowid()] is.**
18cb0 20 75 6e 70 72 65 64 69 63 74 61 62 6c 65 20 61   unpredictable a
18cc0 6e 64 20 6d 69 67 68 74 20 6e 6f 74 20 65 71 75  nd might not equ
18cd0 61 6c 20 65 69 74 68 65 72 20 74 68 65 20 6f 6c  al either the ol
18ce0 64 20 6f 72 20 74 68 65 20 6e 65 77 0a 2a 2a 20  d or the new.** 
18cf0 6c 61 73 74 20 69 6e 73 65 72 74 20 5b 72 6f 77  last insert [row
18d00 69 64 5d 2e 0a 2a 2f 0a 73 71 6c 69 74 65 33 5f  id]..*/.sqlite3_
18d10 69 6e 74 36 34 20 73 71 6c 69 74 65 33 5f 6c 61  int64 sqlite3_la
18d20 73 74 5f 69 6e 73 65 72 74 5f 72 6f 77 69 64 28  st_insert_rowid(
18d30 73 71 6c 69 74 65 33 2a 29 3b 0a 0a 2f 2a 0a 2a  sqlite3*);../*.*
18d40 2a 20 43 41 50 49 33 52 45 46 3a 20 43 6f 75 6e  * CAPI3REF: Coun
18d50 74 20 54 68 65 20 4e 75 6d 62 65 72 20 4f 66 20  t The Number Of 
18d60 52 6f 77 73 20 4d 6f 64 69 66 69 65 64 0a 2a 2a  Rows Modified.**
18d70 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33   METHOD: sqlite3
18d80 0a 2a 2a 0a 2a 2a 20 5e 54 68 69 73 20 66 75 6e  .**.** ^This fun
18d90 63 74 69 6f 6e 20 72 65 74 75 72 6e 73 20 74 68  ction returns th
18da0 65 20 6e 75 6d 62 65 72 20 6f 66 20 72 6f 77 73  e number of rows
18db0 20 6d 6f 64 69 66 69 65 64 2c 20 69 6e 73 65 72   modified, inser
18dc0 74 65 64 20 6f 72 0a 2a 2a 20 64 65 6c 65 74 65  ted or.** delete
18dd0 64 20 62 79 20 74 68 65 20 6d 6f 73 74 20 72 65  d by the most re
18de0 63 65 6e 74 6c 79 20 63 6f 6d 70 6c 65 74 65 64  cently completed
18df0 20 49 4e 53 45 52 54 2c 20 55 50 44 41 54 45 20   INSERT, UPDATE 
18e00 6f 72 20 44 45 4c 45 54 45 0a 2a 2a 20 73 74 61  or DELETE.** sta
18e10 74 65 6d 65 6e 74 20 6f 6e 20 74 68 65 20 64 61  tement on the da
18e20 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
18e30 6e 20 73 70 65 63 69 66 69 65 64 20 62 79 20 74  n specified by t
18e40 68 65 20 6f 6e 6c 79 20 70 61 72 61 6d 65 74 65  he only paramete
18e50 72 2e 0a 2a 2a 20 5e 45 78 65 63 75 74 69 6e 67  r..** ^Executing
18e60 20 61 6e 79 20 6f 74 68 65 72 20 74 79 70 65 20   any other type 
18e70 6f 66 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  of SQL statement
18e80 20 64 6f 65 73 20 6e 6f 74 20 6d 6f 64 69 66 79   does not modify
18e90 20 74 68 65 20 76 61 6c 75 65 0a 2a 2a 20 72 65   the value.** re
18ea0 74 75 72 6e 65 64 20 62 79 20 74 68 69 73 20 66  turned by this f
18eb0 75 6e 63 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 5e  unction..**.** ^
18ec0 4f 6e 6c 79 20 63 68 61 6e 67 65 73 20 6d 61 64  Only changes mad
18ed0 65 20 64 69 72 65 63 74 6c 79 20 62 79 20 74 68  e directly by th
18ee0 65 20 49 4e 53 45 52 54 2c 20 55 50 44 41 54 45  e INSERT, UPDATE
18ef0 20 6f 72 20 44 45 4c 45 54 45 20 73 74 61 74 65   or DELETE state
18f00 6d 65 6e 74 20 61 72 65 0a 2a 2a 20 63 6f 6e 73  ment are.** cons
18f10 69 64 65 72 65 64 20 2d 20 61 75 78 69 6c 69 61  idered - auxilia
18f20 72 79 20 63 68 61 6e 67 65 73 20 63 61 75 73 65  ry changes cause
18f30 64 20 62 79 20 5b 43 52 45 41 54 45 20 54 52 49  d by [CREATE TRI
18f40 47 47 45 52 20 7c 20 74 72 69 67 67 65 72 73 5d  GGER | triggers]
18f50 2c 20 0a 2a 2a 20 5b 66 6f 72 65 69 67 6e 20 6b  , .** [foreign k
18f60 65 79 20 61 63 74 69 6f 6e 73 5d 20 6f 72 20 5b  ey actions] or [
18f70 52 45 50 4c 41 43 45 5d 20 63 6f 6e 73 74 72 61  REPLACE] constra
18f80 69 6e 74 20 72 65 73 6f 6c 75 74 69 6f 6e 20 61  int resolution a
18f90 72 65 20 6e 6f 74 20 63 6f 75 6e 74 65 64 2e 0a  re not counted..
18fa0 2a 2a 20 0a 2a 2a 20 43 68 61 6e 67 65 73 20 74  ** .** Changes t
18fb0 6f 20 61 20 76 69 65 77 20 74 68 61 74 20 61 72  o a view that ar
18fc0 65 20 69 6e 74 65 72 63 65 70 74 65 64 20 62 79  e intercepted by
18fd0 20 0a 2a 2a 20 5b 49 4e 53 54 45 41 44 20 4f 46   .** [INSTEAD OF
18fe0 20 74 72 69 67 67 65 72 20 7c 20 49 4e 53 54 45   trigger | INSTE
18ff0 41 44 20 4f 46 20 74 72 69 67 67 65 72 73 5d 20  AD OF triggers] 
19000 61 72 65 20 6e 6f 74 20 63 6f 75 6e 74 65 64 2e  are not counted.
19010 20 5e 54 68 65 20 76 61 6c 75 65 20 0a 2a 2a 20   ^The value .** 
19020 72 65 74 75 72 6e 65 64 20 62 79 20 73 71 6c 69  returned by sqli
19030 74 65 33 5f 63 68 61 6e 67 65 73 28 29 20 69 6d  te3_changes() im
19040 6d 65 64 69 61 74 65 6c 79 20 61 66 74 65 72 20  mediately after 
19050 61 6e 20 49 4e 53 45 52 54 2c 20 55 50 44 41 54  an INSERT, UPDAT
19060 45 20 6f 72 20 0a 2a 2a 20 44 45 4c 45 54 45 20  E or .** DELETE 
19070 73 74 61 74 65 6d 65 6e 74 20 72 75 6e 20 6f 6e  statement run on
19080 20 61 20 76 69 65 77 20 69 73 20 61 6c 77 61 79   a view is alway
19090 73 20 7a 65 72 6f 2e 20 4f 6e 6c 79 20 63 68 61  s zero. Only cha
190a0 6e 67 65 73 20 6d 61 64 65 20 74 6f 20 72 65 61  nges made to rea
190b0 6c 20 0a 2a 2a 20 74 61 62 6c 65 73 20 61 72 65  l .** tables are
190c0 20 63 6f 75 6e 74 65 64 2e 0a 2a 2a 0a 2a 2a 20   counted..**.** 
190d0 54 68 69 6e 67 73 20 61 72 65 20 6d 6f 72 65 20  Things are more 
190e0 63 6f 6d 70 6c 69 63 61 74 65 64 20 69 66 20 74  complicated if t
190f0 68 65 20 73 71 6c 69 74 65 33 5f 63 68 61 6e 67  he sqlite3_chang
19100 65 73 28 29 20 66 75 6e 63 74 69 6f 6e 20 69 73  es() function is
19110 0a 2a 2a 20 65 78 65 63 75 74 65 64 20 77 68 69  .** executed whi
19120 6c 65 20 61 20 74 72 69 67 67 65 72 20 70 72 6f  le a trigger pro
19130 67 72 61 6d 20 69 73 20 72 75 6e 6e 69 6e 67 2e  gram is running.
19140 20 54 68 69 73 20 6d 61 79 20 68 61 70 70 65 6e   This may happen
19150 20 69 66 20 74 68 65 0a 2a 2a 20 70 72 6f 67 72   if the.** progr
19160 61 6d 20 75 73 65 73 20 74 68 65 20 5b 63 68 61  am uses the [cha
19170 6e 67 65 73 28 29 20 53 51 4c 20 66 75 6e 63 74  nges() SQL funct
19180 69 6f 6e 5d 2c 20 6f 72 20 69 66 20 73 6f 6d 65  ion], or if some
19190 20 6f 74 68 65 72 20 63 61 6c 6c 62 61 63 6b 0a   other callback.
191a0 2a 2a 20 66 75 6e 63 74 69 6f 6e 20 69 6e 76 6f  ** function invo
191b0 6b 65 73 20 73 71 6c 69 74 65 33 5f 63 68 61 6e  kes sqlite3_chan
191c0 67 65 73 28 29 20 64 69 72 65 63 74 6c 79 2e 20  ges() directly. 
191d0 45 73 73 65 6e 74 69 61 6c 6c 79 3a 0a 2a 2a 20  Essentially:.** 
191e0 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a 20 20 20 3c 6c  .** <ul>.**   <l
191f0 69 3e 20 5e 28 42 65 66 6f 72 65 20 65 6e 74 65  i> ^(Before ente
19200 72 69 6e 67 20 61 20 74 72 69 67 67 65 72 20 70  ring a trigger p
19210 72 6f 67 72 61 6d 20 74 68 65 20 76 61 6c 75 65  rogram the value
19220 20 72 65 74 75 72 6e 65 64 20 62 79 0a 2a 2a 20   returned by.** 
19230 20 20 20 20 20 20 20 73 71 6c 69 74 65 33 5f 63         sqlite3_c
19240 68 61 6e 67 65 73 28 29 20 66 75 6e 63 74 69 6f  hanges() functio
19250 6e 20 69 73 20 73 61 76 65 64 2e 20 41 66 74 65  n is saved. Afte
19260 72 20 74 68 65 20 74 72 69 67 67 65 72 20 70 72  r the trigger pr
19270 6f 67 72 61 6d 20 0a 2a 2a 20 20 20 20 20 20 20  ogram .**       
19280 20 68 61 73 20 66 69 6e 69 73 68 65 64 2c 20 74   has finished, t
19290 68 65 20 6f 72 69 67 69 6e 61 6c 20 76 61 6c 75  he original valu
192a0 65 20 69 73 20 72 65 73 74 6f 72 65 64 2e 29 5e  e is restored.)^
192b0 0a 2a 2a 20 0a 2a 2a 20 20 20 3c 6c 69 3e 20 5e  .** .**   <li> ^
192c0 28 57 69 74 68 69 6e 20 61 20 74 72 69 67 67 65  (Within a trigge
192d0 72 20 70 72 6f 67 72 61 6d 20 65 61 63 68 20 49  r program each I
192e0 4e 53 45 52 54 2c 20 55 50 44 41 54 45 20 61 6e  NSERT, UPDATE an
192f0 64 20 44 45 4c 45 54 45 20 0a 2a 2a 20 20 20 20  d DELETE .**    
19300 20 20 20 20 73 74 61 74 65 6d 65 6e 74 20 73 65      statement se
19310 74 73 20 74 68 65 20 76 61 6c 75 65 20 72 65 74  ts the value ret
19320 75 72 6e 65 64 20 62 79 20 73 71 6c 69 74 65 33  urned by sqlite3
19330 5f 63 68 61 6e 67 65 73 28 29 20 0a 2a 2a 20 20  _changes() .**  
19340 20 20 20 20 20 20 75 70 6f 6e 20 63 6f 6d 70 6c        upon compl
19350 65 74 69 6f 6e 20 61 73 20 6e 6f 72 6d 61 6c 2e  etion as normal.
19360 20 4f 66 20 63 6f 75 72 73 65 2c 20 74 68 69 73   Of course, this
19370 20 76 61 6c 75 65 20 77 69 6c 6c 20 6e 6f 74 20   value will not 
19380 69 6e 63 6c 75 64 65 20 0a 2a 2a 20 20 20 20 20  include .**     
19390 20 20 20 61 6e 79 20 63 68 61 6e 67 65 73 20 70     any changes p
193a0 65 72 66 6f 72 6d 65 64 20 62 79 20 73 75 62 2d  erformed by sub-
193b0 74 72 69 67 67 65 72 73 2c 20 61 73 20 74 68 65  triggers, as the
193c0 20 73 71 6c 69 74 65 33 5f 63 68 61 6e 67 65 73   sqlite3_changes
193d0 28 29 20 0a 2a 2a 20 20 20 20 20 20 20 20 76 61  () .**        va
193e0 6c 75 65 20 77 69 6c 6c 20 62 65 20 73 61 76 65  lue will be save
193f0 64 20 61 6e 64 20 72 65 73 74 6f 72 65 64 20 61  d and restored a
19400 66 74 65 72 20 65 61 63 68 20 73 75 62 2d 74 72  fter each sub-tr
19410 69 67 67 65 72 20 68 61 73 20 72 75 6e 2e 29 5e  igger has run.)^
19420 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2a 20 0a 2a 2a  .** </ul>.** .**
19430 20 5e 54 68 69 73 20 6d 65 61 6e 73 20 74 68 61   ^This means tha
19440 74 20 69 66 20 74 68 65 20 63 68 61 6e 67 65 73  t if the changes
19450 28 29 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20  () SQL function 
19460 28 6f 72 20 73 69 6d 69 6c 61 72 29 20 69 73 20  (or similar) is 
19470 75 73 65 64 0a 2a 2a 20 62 79 20 74 68 65 20 66  used.** by the f
19480 69 72 73 74 20 49 4e 53 45 52 54 2c 20 55 50 44  irst INSERT, UPD
19490 41 54 45 20 6f 72 20 44 45 4c 45 54 45 20 73 74  ATE or DELETE st
194a0 61 74 65 6d 65 6e 74 20 77 69 74 68 69 6e 20 61  atement within a
194b0 20 74 72 69 67 67 65 72 2c 20 69 74 20 0a 2a 2a   trigger, it .**
194c0 20 72 65 74 75 72 6e 73 20 74 68 65 20 76 61 6c   returns the val
194d0 75 65 20 61 73 20 73 65 74 20 77 68 65 6e 20 74  ue as set when t
194e0 68 65 20 63 61 6c 6c 69 6e 67 20 73 74 61 74 65  he calling state
194f0 6d 65 6e 74 20 62 65 67 61 6e 20 65 78 65 63 75  ment began execu
19500 74 69 6e 67 2e 0a 2a 2a 20 5e 49 66 20 69 74 20  ting..** ^If it 
19510 69 73 20 75 73 65 64 20 62 79 20 74 68 65 20 73  is used by the s
19520 65 63 6f 6e 64 20 6f 72 20 73 75 62 73 65 71 75  econd or subsequ
19530 65 6e 74 20 73 75 63 68 20 73 74 61 74 65 6d 65  ent such stateme
19540 6e 74 20 77 69 74 68 69 6e 20 61 20 74 72 69 67  nt within a trig
19550 67 65 72 20 0a 2a 2a 20 70 72 6f 67 72 61 6d 2c  ger .** program,
19560 20 74 68 65 20 76 61 6c 75 65 20 72 65 74 75 72   the value retur
19570 6e 65 64 20 72 65 66 6c 65 63 74 73 20 74 68 65  ned reflects the
19580 20 6e 75 6d 62 65 72 20 6f 66 20 72 6f 77 73 20   number of rows 
19590 6d 6f 64 69 66 69 65 64 20 62 79 20 74 68 65 20  modified by the 
195a0 0a 2a 2a 20 70 72 65 76 69 6f 75 73 20 49 4e 53  .** previous INS
195b0 45 52 54 2c 20 55 50 44 41 54 45 20 6f 72 20 44  ERT, UPDATE or D
195c0 45 4c 45 54 45 20 73 74 61 74 65 6d 65 6e 74 20  ELETE statement 
195d0 77 69 74 68 69 6e 20 74 68 65 20 73 61 6d 65 20  within the same 
195e0 74 72 69 67 67 65 72 2e 0a 2a 2a 0a 2a 2a 20 53  trigger..**.** S
195f0 65 65 20 61 6c 73 6f 20 74 68 65 20 5b 73 71 6c  ee also the [sql
19600 69 74 65 33 5f 74 6f 74 61 6c 5f 63 68 61 6e 67  ite3_total_chang
19610 65 73 28 29 5d 20 69 6e 74 65 72 66 61 63 65 2c  es()] interface,
19620 20 74 68 65 0a 2a 2a 20 5b 63 6f 75 6e 74 5f 63   the.** [count_c
19630 68 61 6e 67 65 73 20 70 72 61 67 6d 61 5d 2c 20  hanges pragma], 
19640 61 6e 64 20 74 68 65 20 5b 63 68 61 6e 67 65 73  and the [changes
19650 28 29 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 5d  () SQL function]
19660 2e 0a 2a 2a 0a 2a 2a 20 49 66 20 61 20 73 65 70  ..**.** If a sep
19670 61 72 61 74 65 20 74 68 72 65 61 64 20 6d 61 6b  arate thread mak
19680 65 73 20 63 68 61 6e 67 65 73 20 6f 6e 20 74 68  es changes on th
19690 65 20 73 61 6d 65 20 64 61 74 61 62 61 73 65 20  e same database 
196a0 63 6f 6e 6e 65 63 74 69 6f 6e 0a 2a 2a 20 77 68  connection.** wh
196b0 69 6c 65 20 5b 73 71 6c 69 74 65 33 5f 63 68 61  ile [sqlite3_cha
196c0 6e 67 65 73 28 29 5d 20 69 73 20 72 75 6e 6e 69  nges()] is runni
196d0 6e 67 20 74 68 65 6e 20 74 68 65 20 76 61 6c 75  ng then the valu
196e0 65 20 72 65 74 75 72 6e 65 64 0a 2a 2a 20 69 73  e returned.** is
196f0 20 75 6e 70 72 65 64 69 63 74 61 62 6c 65 20 61   unpredictable a
19700 6e 64 20 6e 6f 74 20 6d 65 61 6e 69 6e 67 66 75  nd not meaningfu
19710 6c 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65  l..*/.int sqlite
19720 33 5f 63 68 61 6e 67 65 73 28 73 71 6c 69 74 65  3_changes(sqlite
19730 33 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49  3*);../*.** CAPI
19740 33 52 45 46 3a 20 54 6f 74 61 6c 20 4e 75 6d 62  3REF: Total Numb
19750 65 72 20 4f 66 20 52 6f 77 73 20 4d 6f 64 69 66  er Of Rows Modif
19760 69 65 64 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73  ied.** METHOD: s
19770 71 6c 69 74 65 33 0a 2a 2a 0a 2a 2a 20 5e 54 68  qlite3.**.** ^Th
19780 69 73 20 66 75 6e 63 74 69 6f 6e 20 72 65 74 75  is function retu
19790 72 6e 73 20 74 68 65 20 74 6f 74 61 6c 20 6e 75  rns the total nu
197a0 6d 62 65 72 20 6f 66 20 72 6f 77 73 20 69 6e 73  mber of rows ins
197b0 65 72 74 65 64 2c 20 6d 6f 64 69 66 69 65 64 20  erted, modified 
197c0 6f 72 0a 2a 2a 20 64 65 6c 65 74 65 64 20 62 79  or.** deleted by
197d0 20 61 6c 6c 20 5b 49 4e 53 45 52 54 5d 2c 20 5b   all [INSERT], [
197e0 55 50 44 41 54 45 5d 20 6f 72 20 5b 44 45 4c 45  UPDATE] or [DELE
197f0 54 45 5d 20 73 74 61 74 65 6d 65 6e 74 73 20 63  TE] statements c
19800 6f 6d 70 6c 65 74 65 64 0a 2a 2a 20 73 69 6e 63  ompleted.** sinc
19810 65 20 74 68 65 20 64 61 74 61 62 61 73 65 20 63  e the database c
19820 6f 6e 6e 65 63 74 69 6f 6e 20 77 61 73 20 6f 70  onnection was op
19830 65 6e 65 64 2c 20 69 6e 63 6c 75 64 69 6e 67 20  ened, including 
19840 74 68 6f 73 65 20 65 78 65 63 75 74 65 64 20 61  those executed a
19850 73 0a 2a 2a 20 70 61 72 74 20 6f 66 20 74 72 69  s.** part of tri
19860 67 67 65 72 20 70 72 6f 67 72 61 6d 73 2e 20 5e  gger programs. ^
19870 45 78 65 63 75 74 69 6e 67 20 61 6e 79 20 6f 74  Executing any ot
19880 68 65 72 20 74 79 70 65 20 6f 66 20 53 51 4c 20  her type of SQL 
19890 73 74 61 74 65 6d 65 6e 74 0a 2a 2a 20 64 6f 65  statement.** doe
198a0 73 20 6e 6f 74 20 61 66 66 65 63 74 20 74 68 65  s not affect the
198b0 20 76 61 6c 75 65 20 72 65 74 75 72 6e 65 64 20   value returned 
198c0 62 79 20 73 71 6c 69 74 65 33 5f 74 6f 74 61 6c  by sqlite3_total
198d0 5f 63 68 61 6e 67 65 73 28 29 2e 0a 2a 2a 20 0a  _changes()..** .
198e0 2a 2a 20 5e 43 68 61 6e 67 65 73 20 6d 61 64 65  ** ^Changes made
198f0 20 61 73 20 70 61 72 74 20 6f 66 20 5b 66 6f 72   as part of [for
19900 65 69 67 6e 20 6b 65 79 20 61 63 74 69 6f 6e 73  eign key actions
19910 5d 20 61 72 65 20 69 6e 63 6c 75 64 65 64 20 69  ] are included i
19920 6e 20 74 68 65 0a 2a 2a 20 63 6f 75 6e 74 2c 20  n the.** count, 
19930 62 75 74 20 74 68 6f 73 65 20 6d 61 64 65 20 61  but those made a
19940 73 20 70 61 72 74 20 6f 66 20 52 45 50 4c 41 43  s part of REPLAC
19950 45 20 63 6f 6e 73 74 72 61 69 6e 74 20 72 65 73  E constraint res
19960 6f 6c 75 74 69 6f 6e 20 61 72 65 0a 2a 2a 20 6e  olution are.** n
19970 6f 74 2e 20 5e 43 68 61 6e 67 65 73 20 74 6f 20  ot. ^Changes to 
19980 61 20 76 69 65 77 20 74 68 61 74 20 61 72 65 20  a view that are 
19990 69 6e 74 65 72 63 65 70 74 65 64 20 62 79 20 49  intercepted by I
199a0 4e 53 54 45 41 44 20 4f 46 20 74 72 69 67 67 65  NSTEAD OF trigge
199b0 72 73 20 0a 2a 2a 20 61 72 65 20 6e 6f 74 20 63  rs .** are not c
199c0 6f 75 6e 74 65 64 2e 0a 2a 2a 20 0a 2a 2a 20 53  ounted..** .** S
199d0 65 65 20 61 6c 73 6f 20 74 68 65 20 5b 73 71 6c  ee also the [sql
199e0 69 74 65 33 5f 63 68 61 6e 67 65 73 28 29 5d 20  ite3_changes()] 
199f0 69 6e 74 65 72 66 61 63 65 2c 20 74 68 65 0a 2a  interface, the.*
19a00 2a 20 5b 63 6f 75 6e 74 5f 63 68 61 6e 67 65 73  * [count_changes
19a10 20 70 72 61 67 6d 61 5d 2c 20 61 6e 64 20 74 68   pragma], and th
19a20 65 20 5b 74 6f 74 61 6c 5f 63 68 61 6e 67 65 73  e [total_changes
19a30 28 29 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 5d  () SQL function]
19a40 2e 0a 2a 2a 0a 2a 2a 20 49 66 20 61 20 73 65 70  ..**.** If a sep
19a50 61 72 61 74 65 20 74 68 72 65 61 64 20 6d 61 6b  arate thread mak
19a60 65 73 20 63 68 61 6e 67 65 73 20 6f 6e 20 74 68  es changes on th
19a70 65 20 73 61 6d 65 20 64 61 74 61 62 61 73 65 20  e same database 
19a80 63 6f 6e 6e 65 63 74 69 6f 6e 0a 2a 2a 20 77 68  connection.** wh
19a90 69 6c 65 20 5b 73 71 6c 69 74 65 33 5f 74 6f 74  ile [sqlite3_tot
19aa0 61 6c 5f 63 68 61 6e 67 65 73 28 29 5d 20 69 73  al_changes()] is
19ab0 20 72 75 6e 6e 69 6e 67 20 74 68 65 6e 20 74 68   running then th
19ac0 65 20 76 61 6c 75 65 0a 2a 2a 20 72 65 74 75 72  e value.** retur
19ad0 6e 65 64 20 69 73 20 75 6e 70 72 65 64 69 63 74  ned is unpredict
19ae0 61 62 6c 65 20 61 6e 64 20 6e 6f 74 20 6d 65 61  able and not mea
19af0 6e 69 6e 67 66 75 6c 2e 0a 2a 2f 0a 69 6e 74 20  ningful..*/.int 
19b00 73 71 6c 69 74 65 33 5f 74 6f 74 61 6c 5f 63 68  sqlite3_total_ch
19b10 61 6e 67 65 73 28 73 71 6c 69 74 65 33 2a 29 3b  anges(sqlite3*);
19b20 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46  ../*.** CAPI3REF
19b30 3a 20 49 6e 74 65 72 72 75 70 74 20 41 20 4c 6f  : Interrupt A Lo
19b40 6e 67 2d 52 75 6e 6e 69 6e 67 20 51 75 65 72 79  ng-Running Query
19b50 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69  .** METHOD: sqli
19b60 74 65 33 0a 2a 2a 0a 2a 2a 20 5e 54 68 69 73 20  te3.**.** ^This 
19b70 66 75 6e 63 74 69 6f 6e 20 63 61 75 73 65 73 20  function causes 
19b80 61 6e 79 20 70 65 6e 64 69 6e 67 20 64 61 74 61  any pending data
19b90 62 61 73 65 20 6f 70 65 72 61 74 69 6f 6e 20 74  base operation t
19ba0 6f 20 61 62 6f 72 74 20 61 6e 64 0a 2a 2a 20 72  o abort and.** r
19bb0 65 74 75 72 6e 20 61 74 20 69 74 73 20 65 61 72  eturn at its ear
19bc0 6c 69 65 73 74 20 6f 70 70 6f 72 74 75 6e 69 74  liest opportunit
19bd0 79 2e 20 54 68 69 73 20 72 6f 75 74 69 6e 65 20  y. This routine 
19be0 69 73 20 74 79 70 69 63 61 6c 6c 79 0a 2a 2a 20  is typically.** 
19bf0 63 61 6c 6c 65 64 20 69 6e 20 72 65 73 70 6f 6e  called in respon
19c00 73 65 20 74 6f 20 61 20 75 73 65 72 20 61 63 74  se to a user act
19c10 69 6f 6e 20 73 75 63 68 20 61 73 20 70 72 65 73  ion such as pres
19c20 73 69 6e 67 20 22 43 61 6e 63 65 6c 22 0a 2a 2a  sing "Cancel".**
19c30 20 6f 72 20 43 74 72 6c 2d 43 20 77 68 65 72 65   or Ctrl-C where
19c40 20 74 68 65 20 75 73 65 72 20 77 61 6e 74 73 20   the user wants 
19c50 61 20 6c 6f 6e 67 20 71 75 65 72 79 20 6f 70 65  a long query ope
19c60 72 61 74 69 6f 6e 20 74 6f 20 68 61 6c 74 0a 2a  ration to halt.*
19c70 2a 20 69 6d 6d 65 64 69 61 74 65 6c 79 2e 0a 2a  * immediately..*
19c80 2a 0a 2a 2a 20 5e 49 74 20 69 73 20 73 61 66 65  *.** ^It is safe
19c90 20 74 6f 20 63 61 6c 6c 20 74 68 69 73 20 72 6f   to call this ro
19ca0 75 74 69 6e 65 20 66 72 6f 6d 20 61 20 74 68 72  utine from a thr
19cb0 65 61 64 20 64 69 66 66 65 72 65 6e 74 20 66 72  ead different fr
19cc0 6f 6d 20 74 68 65 0a 2a 2a 20 74 68 72 65 61 64  om the.** thread
19cd0 20 74 68 61 74 20 69 73 20 63 75 72 72 65 6e 74   that is current
19ce0 6c 79 20 72 75 6e 6e 69 6e 67 20 74 68 65 20 64  ly running the d
19cf0 61 74 61 62 61 73 65 20 6f 70 65 72 61 74 69 6f  atabase operatio
19d00 6e 2e 20 20 42 75 74 20 69 74 0a 2a 2a 20 69 73  n.  But it.** is
19d10 20 6e 6f 74 20 73 61 66 65 20 74 6f 20 63 61 6c   not safe to cal
19d20 6c 20 74 68 69 73 20 72 6f 75 74 69 6e 65 20 77  l this routine w
19d30 69 74 68 20 61 20 5b 64 61 74 61 62 61 73 65 20  ith a [database 
19d40 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 74 68 61 74  connection] that
19d50 0a 2a 2a 20 69 73 20 63 6c 6f 73 65 64 20 6f 72  .** is closed or
19d60 20 6d 69 67 68 74 20 63 6c 6f 73 65 20 62 65 66   might close bef
19d70 6f 72 65 20 73 71 6c 69 74 65 33 5f 69 6e 74 65  ore sqlite3_inte
19d80 72 72 75 70 74 28 29 20 72 65 74 75 72 6e 73 2e  rrupt() returns.
19d90 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 61 6e 20 53 51  .**.** ^If an SQ
19da0 4c 20 6f 70 65 72 61 74 69 6f 6e 20 69 73 20 76  L operation is v
19db0 65 72 79 20 6e 65 61 72 6c 79 20 66 69 6e 69 73  ery nearly finis
19dc0 68 65 64 20 61 74 20 74 68 65 20 74 69 6d 65 20  hed at the time 
19dd0 77 68 65 6e 0a 2a 2a 20 73 71 6c 69 74 65 33 5f  when.** sqlite3_
19de0 69 6e 74 65 72 72 75 70 74 28 29 20 69 73 20 63  interrupt() is c
19df0 61 6c 6c 65 64 2c 20 74 68 65 6e 20 69 74 20 6d  alled, then it m
19e00 69 67 68 74 20 6e 6f 74 20 68 61 76 65 20 61 6e  ight not have an
19e10 20 6f 70 70 6f 72 74 75 6e 69 74 79 0a 2a 2a 20   opportunity.** 
19e20 74 6f 20 62 65 20 69 6e 74 65 72 72 75 70 74 65  to be interrupte
19e30 64 20 61 6e 64 20 6d 69 67 68 74 20 63 6f 6e 74  d and might cont
19e40 69 6e 75 65 20 74 6f 20 63 6f 6d 70 6c 65 74 69  inue to completi
19e50 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 5e 41 6e 20 53 51  on..**.** ^An SQ
19e60 4c 20 6f 70 65 72 61 74 69 6f 6e 20 74 68 61 74  L operation that
19e70 20 69 73 20 69 6e 74 65 72 72 75 70 74 65 64 20   is interrupted 
19e80 77 69 6c 6c 20 72 65 74 75 72 6e 20 5b 53 51 4c  will return [SQL
19e90 49 54 45 5f 49 4e 54 45 52 52 55 50 54 5d 2e 0a  ITE_INTERRUPT]..
19ea0 2a 2a 20 5e 49 66 20 74 68 65 20 69 6e 74 65 72  ** ^If the inter
19eb0 72 75 70 74 65 64 20 53 51 4c 20 6f 70 65 72 61  rupted SQL opera
19ec0 74 69 6f 6e 20 69 73 20 61 6e 20 49 4e 53 45 52  tion is an INSER
19ed0 54 2c 20 55 50 44 41 54 45 2c 20 6f 72 20 44 45  T, UPDATE, or DE
19ee0 4c 45 54 45 0a 2a 2a 20 74 68 61 74 20 69 73 20  LETE.** that is 
19ef0 69 6e 73 69 64 65 20 61 6e 20 65 78 70 6c 69 63  inside an explic
19f00 69 74 20 74 72 61 6e 73 61 63 74 69 6f 6e 2c 20  it transaction, 
19f10 74 68 65 6e 20 74 68 65 20 65 6e 74 69 72 65 20  then the entire 
19f20 74 72 61 6e 73 61 63 74 69 6f 6e 0a 2a 2a 20 77  transaction.** w
19f30 69 6c 6c 20 62 65 20 72 6f 6c 6c 65 64 20 62 61  ill be rolled ba
19f40 63 6b 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79  ck automatically
19f50 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c  ..**.** ^The sql
19f60 69 74 65 33 5f 69 6e 74 65 72 72 75 70 74 28 44  ite3_interrupt(D
19f70 29 20 63 61 6c 6c 20 69 73 20 69 6e 20 65 66 66  ) call is in eff
19f80 65 63 74 20 75 6e 74 69 6c 20 61 6c 6c 20 63 75  ect until all cu
19f90 72 72 65 6e 74 6c 79 20 72 75 6e 6e 69 6e 67 0a  rrently running.
19fa0 2a 2a 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  ** SQL statement
19fb0 73 20 6f 6e 20 5b 64 61 74 61 62 61 73 65 20 63  s on [database c
19fc0 6f 6e 6e 65 63 74 69 6f 6e 5d 20 44 20 63 6f 6d  onnection] D com
19fd0 70 6c 65 74 65 2e 20 20 5e 41 6e 79 20 6e 65 77  plete.  ^Any new
19fe0 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73 0a   SQL statements.
19ff0 2a 2a 20 74 68 61 74 20 61 72 65 20 73 74 61 72  ** that are star
1a000 74 65 64 20 61 66 74 65 72 20 74 68 65 20 73 71  ted after the sq
1a010 6c 69 74 65 33 5f 69 6e 74 65 72 72 75 70 74 28  lite3_interrupt(
1a020 29 20 63 61 6c 6c 20 61 6e 64 20 62 65 66 6f 72  ) call and befor
1a030 65 20 74 68 65 20 0a 2a 2a 20 72 75 6e 6e 69 6e  e the .** runnin
1a040 67 20 73 74 61 74 65 6d 65 6e 74 73 20 72 65 61  g statements rea
1a050 63 68 65 73 20 7a 65 72 6f 20 61 72 65 20 69 6e  ches zero are in
1a060 74 65 72 72 75 70 74 65 64 20 61 73 20 69 66 20  terrupted as if 
1a070 74 68 65 79 20 68 61 64 20 62 65 65 6e 0a 2a 2a  they had been.**
1a080 20 72 75 6e 6e 69 6e 67 20 70 72 69 6f 72 20 74   running prior t
1a090 6f 20 74 68 65 20 73 71 6c 69 74 65 33 5f 69 6e  o the sqlite3_in
1a0a0 74 65 72 72 75 70 74 28 29 20 63 61 6c 6c 2e 20  terrupt() call. 
1a0b0 20 5e 4e 65 77 20 53 51 4c 20 73 74 61 74 65 6d   ^New SQL statem
1a0c0 65 6e 74 73 0a 2a 2a 20 74 68 61 74 20 61 72 65  ents.** that are
1a0d0 20 73 74 61 72 74 65 64 20 61 66 74 65 72 20 74   started after t
1a0e0 68 65 20 72 75 6e 6e 69 6e 67 20 73 74 61 74 65  he running state
1a0f0 6d 65 6e 74 20 63 6f 75 6e 74 20 72 65 61 63 68  ment count reach
1a100 65 73 20 7a 65 72 6f 20 61 72 65 0a 2a 2a 20 6e  es zero are.** n
1a110 6f 74 20 65 66 66 65 63 74 65 64 20 62 79 20 74  ot effected by t
1a120 68 65 20 73 71 6c 69 74 65 33 5f 69 6e 74 65 72  he sqlite3_inter
1a130 72 75 70 74 28 29 2e 0a 2a 2a 20 5e 41 20 63 61  rupt()..** ^A ca
1a140 6c 6c 20 74 6f 20 73 71 6c 69 74 65 33 5f 69 6e  ll to sqlite3_in
1a150 74 65 72 72 75 70 74 28 44 29 20 74 68 61 74 20  terrupt(D) that 
1a160 6f 63 63 75 72 73 20 77 68 65 6e 20 74 68 65 72  occurs when ther
1a170 65 20 61 72 65 20 6e 6f 20 72 75 6e 6e 69 6e 67  e are no running
1a180 0a 2a 2a 20 53 51 4c 20 73 74 61 74 65 6d 65 6e  .** SQL statemen
1a190 74 73 20 69 73 20 61 20 6e 6f 2d 6f 70 20 61 6e  ts is a no-op an
1a1a0 64 20 68 61 73 20 6e 6f 20 65 66 66 65 63 74 20  d has no effect 
1a1b0 6f 6e 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  on SQL statement
1a1c0 73 0a 2a 2a 20 74 68 61 74 20 61 72 65 20 73 74  s.** that are st
1a1d0 61 72 74 65 64 20 61 66 74 65 72 20 74 68 65 20  arted after the 
1a1e0 73 71 6c 69 74 65 33 5f 69 6e 74 65 72 72 75 70  sqlite3_interrup
1a1f0 74 28 29 20 63 61 6c 6c 20 72 65 74 75 72 6e 73  t() call returns
1a200 2e 0a 2a 2a 0a 2a 2a 20 49 66 20 74 68 65 20 64  ..**.** If the d
1a210 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
1a220 6f 6e 20 63 6c 6f 73 65 73 20 77 68 69 6c 65 20  on closes while 
1a230 5b 73 71 6c 69 74 65 33 5f 69 6e 74 65 72 72 75  [sqlite3_interru
1a240 70 74 28 29 5d 0a 2a 2a 20 69 73 20 72 75 6e 6e  pt()].** is runn
1a250 69 6e 67 20 74 68 65 6e 20 62 61 64 20 74 68 69  ing then bad thi
1a260 6e 67 73 20 77 69 6c 6c 20 6c 69 6b 65 6c 79 20  ngs will likely 
1a270 68 61 70 70 65 6e 2e 0a 2a 2f 0a 76 6f 69 64 20  happen..*/.void 
1a280 73 71 6c 69 74 65 33 5f 69 6e 74 65 72 72 75 70  sqlite3_interrup
1a290 74 28 73 71 6c 69 74 65 33 2a 29 3b 0a 0a 2f 2a  t(sqlite3*);../*
1a2a0 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 44 65  .** CAPI3REF: De
1a2b0 74 65 72 6d 69 6e 65 20 49 66 20 41 6e 20 53 51  termine If An SQ
1a2c0 4c 20 53 74 61 74 65 6d 65 6e 74 20 49 73 20 43  L Statement Is C
1a2d0 6f 6d 70 6c 65 74 65 0a 2a 2a 0a 2a 2a 20 54 68  omplete.**.** Th
1a2e0 65 73 65 20 72 6f 75 74 69 6e 65 73 20 61 72 65  ese routines are
1a2f0 20 75 73 65 66 75 6c 20 64 75 72 69 6e 67 20 63   useful during c
1a300 6f 6d 6d 61 6e 64 2d 6c 69 6e 65 20 69 6e 70 75  ommand-line inpu
1a310 74 20 74 6f 20 64 65 74 65 72 6d 69 6e 65 20 69  t to determine i
1a320 66 20 74 68 65 0a 2a 2a 20 63 75 72 72 65 6e 74  f the.** current
1a330 6c 79 20 65 6e 74 65 72 65 64 20 74 65 78 74 20  ly entered text 
1a340 73 65 65 6d 73 20 74 6f 20 66 6f 72 6d 20 61 20  seems to form a 
1a350 63 6f 6d 70 6c 65 74 65 20 53 51 4c 20 73 74 61  complete SQL sta
1a360 74 65 6d 65 6e 74 20 6f 72 0a 2a 2a 20 69 66 20  tement or.** if 
1a370 61 64 64 69 74 69 6f 6e 61 6c 20 69 6e 70 75 74  additional input
1a380 20 69 73 20 6e 65 65 64 65 64 20 62 65 66 6f 72   is needed befor
1a390 65 20 73 65 6e 64 69 6e 67 20 74 68 65 20 74 65  e sending the te
1a3a0 78 74 20 69 6e 74 6f 0a 2a 2a 20 53 51 4c 69 74  xt into.** SQLit
1a3b0 65 20 66 6f 72 20 70 61 72 73 69 6e 67 2e 20 20  e for parsing.  
1a3c0 5e 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20  ^These routines 
1a3d0 72 65 74 75 72 6e 20 31 20 69 66 20 74 68 65 20  return 1 if the 
1a3e0 69 6e 70 75 74 20 73 74 72 69 6e 67 0a 2a 2a 20  input string.** 
1a3f0 61 70 70 65 61 72 73 20 74 6f 20 62 65 20 61 20  appears to be a 
1a400 63 6f 6d 70 6c 65 74 65 20 53 51 4c 20 73 74 61  complete SQL sta
1a410 74 65 6d 65 6e 74 2e 20 20 5e 41 20 73 74 61 74  tement.  ^A stat
1a420 65 6d 65 6e 74 20 69 73 20 6a 75 64 67 65 64 20  ement is judged 
1a430 74 6f 20 62 65 0a 2a 2a 20 63 6f 6d 70 6c 65 74  to be.** complet
1a440 65 20 69 66 20 69 74 20 65 6e 64 73 20 77 69 74  e if it ends wit
1a450 68 20 61 20 73 65 6d 69 63 6f 6c 6f 6e 20 74 6f  h a semicolon to
1a460 6b 65 6e 20 61 6e 64 20 69 73 20 6e 6f 74 20 61  ken and is not a
1a470 20 70 72 65 66 69 78 20 6f 66 20 61 0a 2a 2a 20   prefix of a.** 
1a480 77 65 6c 6c 2d 66 6f 72 6d 65 64 20 43 52 45 41  well-formed CREA
1a490 54 45 20 54 52 49 47 47 45 52 20 73 74 61 74 65  TE TRIGGER state
1a4a0 6d 65 6e 74 2e 20 20 5e 53 65 6d 69 63 6f 6c 6f  ment.  ^Semicolo
1a4b0 6e 73 20 74 68 61 74 20 61 72 65 20 65 6d 62 65  ns that are embe
1a4c0 64 64 65 64 20 77 69 74 68 69 6e 0a 2a 2a 20 73  dded within.** s
1a4d0 74 72 69 6e 67 20 6c 69 74 65 72 61 6c 73 20 6f  tring literals o
1a4e0 72 20 71 75 6f 74 65 64 20 69 64 65 6e 74 69 66  r quoted identif
1a4f0 69 65 72 20 6e 61 6d 65 73 20 6f 72 20 63 6f 6d  ier names or com
1a500 6d 65 6e 74 73 20 61 72 65 20 6e 6f 74 0a 2a 2a  ments are not.**
1a510 20 69 6e 64 65 70 65 6e 64 65 6e 74 20 74 6f 6b   independent tok
1a520 65 6e 73 20 28 74 68 65 79 20 61 72 65 20 70 61  ens (they are pa
1a530 72 74 20 6f 66 20 74 68 65 20 74 6f 6b 65 6e 20  rt of the token 
1a540 69 6e 20 77 68 69 63 68 20 74 68 65 79 20 61 72  in which they ar
1a550 65 0a 2a 2a 20 65 6d 62 65 64 64 65 64 29 20 61  e.** embedded) a
1a560 6e 64 20 74 68 75 73 20 64 6f 20 6e 6f 74 20 63  nd thus do not c
1a570 6f 75 6e 74 20 61 73 20 61 20 73 74 61 74 65 6d  ount as a statem
1a580 65 6e 74 20 74 65 72 6d 69 6e 61 74 6f 72 2e 20  ent terminator. 
1a590 20 5e 57 68 69 74 65 73 70 61 63 65 0a 2a 2a 20   ^Whitespace.** 
1a5a0 61 6e 64 20 63 6f 6d 6d 65 6e 74 73 20 74 68 61  and comments tha
1a5b0 74 20 66 6f 6c 6c 6f 77 20 74 68 65 20 66 69 6e  t follow the fin
1a5c0 61 6c 20 73 65 6d 69 63 6f 6c 6f 6e 20 61 72 65  al semicolon are
1a5d0 20 69 67 6e 6f 72 65 64 2e 0a 2a 2a 0a 2a 2a 20   ignored..**.** 
1a5e0 5e 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20  ^These routines 
1a5f0 72 65 74 75 72 6e 20 30 20 69 66 20 74 68 65 20  return 0 if the 
1a600 73 74 61 74 65 6d 65 6e 74 20 69 73 20 69 6e 63  statement is inc
1a610 6f 6d 70 6c 65 74 65 2e 20 20 5e 49 66 20 61 0a  omplete.  ^If a.
1a620 2a 2a 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61  ** memory alloca
1a630 74 69 6f 6e 20 66 61 69 6c 73 2c 20 74 68 65 6e  tion fails, then
1a640 20 53 51 4c 49 54 45 5f 4e 4f 4d 45 4d 20 69 73   SQLITE_NOMEM is
1a650 20 72 65 74 75 72 6e 65 64 2e 0a 2a 2a 0a 2a 2a   returned..**.**
1a660 20 5e 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73   ^These routines
1a670 20 64 6f 20 6e 6f 74 20 70 61 72 73 65 20 74 68   do not parse th
1a680 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73  e SQL statements
1a690 20 74 68 75 73 0a 2a 2a 20 77 69 6c 6c 20 6e 6f   thus.** will no
1a6a0 74 20 64 65 74 65 63 74 20 73 79 6e 74 61 63 74  t detect syntact
1a6b0 69 63 61 6c 6c 79 20 69 6e 63 6f 72 72 65 63 74  ically incorrect
1a6c0 20 53 51 4c 2e 0a 2a 2a 0a 2a 2a 20 5e 28 49 66   SQL..**.** ^(If
1a6d0 20 53 51 4c 69 74 65 20 68 61 73 20 6e 6f 74 20   SQLite has not 
1a6e0 62 65 65 6e 20 69 6e 69 74 69 61 6c 69 7a 65 64  been initialized
1a6f0 20 75 73 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f   using [sqlite3_
1a700 69 6e 69 74 69 61 6c 69 7a 65 28 29 5d 20 70 72  initialize()] pr
1a710 69 6f 72 20 0a 2a 2a 20 74 6f 20 69 6e 76 6f 6b  ior .** to invok
1a720 69 6e 67 20 73 71 6c 69 74 65 33 5f 63 6f 6d 70  ing sqlite3_comp
1a730 6c 65 74 65 31 36 28 29 20 74 68 65 6e 20 73 71  lete16() then sq
1a740 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65  lite3_initialize
1a750 28 29 20 69 73 20 69 6e 76 6f 6b 65 64 0a 2a 2a  () is invoked.**
1a760 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 62   automatically b
1a770 79 20 73 71 6c 69 74 65 33 5f 63 6f 6d 70 6c 65  y sqlite3_comple
1a780 74 65 31 36 28 29 2e 20 20 49 66 20 74 68 61 74  te16().  If that
1a790 20 69 6e 69 74 69 61 6c 69 7a 61 74 69 6f 6e 20   initialization 
1a7a0 66 61 69 6c 73 2c 0a 2a 2a 20 74 68 65 6e 20 74  fails,.** then t
1a7b0 68 65 20 72 65 74 75 72 6e 20 76 61 6c 75 65 20  he return value 
1a7c0 66 72 6f 6d 20 73 71 6c 69 74 65 33 5f 63 6f 6d  from sqlite3_com
1a7d0 70 6c 65 74 65 31 36 28 29 20 77 69 6c 6c 20 62  plete16() will b
1a7e0 65 20 6e 6f 6e 2d 7a 65 72 6f 0a 2a 2a 20 72 65  e non-zero.** re
1a7f0 67 61 72 64 6c 65 73 73 20 6f 66 20 77 68 65 74  gardless of whet
1a800 68 65 72 20 6f 72 20 6e 6f 74 20 74 68 65 20 69  her or not the i
1a810 6e 70 75 74 20 53 51 4c 20 69 73 20 63 6f 6d 70  nput SQL is comp
1a820 6c 65 74 65 2e 29 5e 0a 2a 2a 0a 2a 2a 20 54 68  lete.)^.**.** Th
1a830 65 20 69 6e 70 75 74 20 74 6f 20 5b 73 71 6c 69  e input to [sqli
1a840 74 65 33 5f 63 6f 6d 70 6c 65 74 65 28 29 5d 20  te3_complete()] 
1a850 6d 75 73 74 20 62 65 20 61 20 7a 65 72 6f 2d 74  must be a zero-t
1a860 65 72 6d 69 6e 61 74 65 64 0a 2a 2a 20 55 54 46  erminated.** UTF
1a870 2d 38 20 73 74 72 69 6e 67 2e 0a 2a 2a 0a 2a 2a  -8 string..**.**
1a880 20 54 68 65 20 69 6e 70 75 74 20 74 6f 20 5b 73   The input to [s
1a890 71 6c 69 74 65 33 5f 63 6f 6d 70 6c 65 74 65 31  qlite3_complete1
1a8a0 36 28 29 5d 20 6d 75 73 74 20 62 65 20 61 20 7a  6()] must be a z
1a8b0 65 72 6f 2d 74 65 72 6d 69 6e 61 74 65 64 0a 2a  ero-terminated.*
1a8c0 2a 20 55 54 46 2d 31 36 20 73 74 72 69 6e 67 20  * UTF-16 string 
1a8d0 69 6e 20 6e 61 74 69 76 65 20 62 79 74 65 20 6f  in native byte o
1a8e0 72 64 65 72 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c  rder..*/.int sql
1a8f0 69 74 65 33 5f 63 6f 6d 70 6c 65 74 65 28 63 6f  ite3_complete(co
1a900 6e 73 74 20 63 68 61 72 20 2a 73 71 6c 29 3b 0a  nst char *sql);.
1a910 69 6e 74 20 73 71 6c 69 74 65 33 5f 63 6f 6d 70  int sqlite3_comp
1a920 6c 65 74 65 31 36 28 63 6f 6e 73 74 20 76 6f 69  lete16(const voi
1a930 64 20 2a 73 71 6c 29 3b 0a 0a 2f 2a 0a 2a 2a 20  d *sql);../*.** 
1a940 43 41 50 49 33 52 45 46 3a 20 52 65 67 69 73 74  CAPI3REF: Regist
1a950 65 72 20 41 20 43 61 6c 6c 62 61 63 6b 20 54 6f  er A Callback To
1a960 20 48 61 6e 64 6c 65 20 53 51 4c 49 54 45 5f 42   Handle SQLITE_B
1a970 55 53 59 20 45 72 72 6f 72 73 0a 2a 2a 20 4b 45  USY Errors.** KE
1a980 59 57 4f 52 44 53 3a 20 7b 62 75 73 79 2d 68 61  YWORDS: {busy-ha
1a990 6e 64 6c 65 72 20 63 61 6c 6c 62 61 63 6b 7d 20  ndler callback} 
1a9a0 7b 62 75 73 79 20 68 61 6e 64 6c 65 72 7d 0a 2a  {busy handler}.*
1a9b0 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65  * METHOD: sqlite
1a9c0 33 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c  3.**.** ^The sql
1a9d0 69 74 65 33 5f 62 75 73 79 5f 68 61 6e 64 6c 65  ite3_busy_handle
1a9e0 72 28 44 2c 58 2c 50 29 20 72 6f 75 74 69 6e 65  r(D,X,P) routine
1a9f0 20 73 65 74 73 20 61 20 63 61 6c 6c 62 61 63 6b   sets a callback
1aa00 20 66 75 6e 63 74 69 6f 6e 20 58 0a 2a 2a 20 74   function X.** t
1aa10 68 61 74 20 6d 69 67 68 74 20 62 65 20 69 6e 76  hat might be inv
1aa20 6f 6b 65 64 20 77 69 74 68 20 61 72 67 75 6d 65  oked with argume
1aa30 6e 74 20 50 20 77 68 65 6e 65 76 65 72 0a 2a 2a  nt P whenever.**
1aa40 20 61 6e 20 61 74 74 65 6d 70 74 20 69 73 20 6d   an attempt is m
1aa50 61 64 65 20 74 6f 20 61 63 63 65 73 73 20 61 20  ade to access a 
1aa60 64 61 74 61 62 61 73 65 20 74 61 62 6c 65 20 61  database table a
1aa70 73 73 6f 63 69 61 74 65 64 20 77 69 74 68 0a 2a  ssociated with.*
1aa80 2a 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  * [database conn
1aa90 65 63 74 69 6f 6e 5d 20 44 20 77 68 65 6e 20 61  ection] D when a
1aaa0 6e 6f 74 68 65 72 20 74 68 72 65 61 64 0a 2a 2a  nother thread.**
1aab0 20 6f 72 20 70 72 6f 63 65 73 73 20 68 61 73 20   or process has 
1aac0 74 68 65 20 74 61 62 6c 65 20 6c 6f 63 6b 65 64  the table locked
1aad0 2e 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74 65 33  ..** The sqlite3
1aae0 5f 62 75 73 79 5f 68 61 6e 64 6c 65 72 28 29 20  _busy_handler() 
1aaf0 69 6e 74 65 72 66 61 63 65 20 69 73 20 75 73 65  interface is use
1ab00 64 20 74 6f 20 69 6d 70 6c 65 6d 65 6e 74 0a 2a  d to implement.*
1ab10 2a 20 5b 73 71 6c 69 74 65 33 5f 62 75 73 79 5f  * [sqlite3_busy_
1ab20 74 69 6d 65 6f 75 74 28 29 5d 20 61 6e 64 20 5b  timeout()] and [
1ab30 50 52 41 47 4d 41 20 62 75 73 79 5f 74 69 6d 65  PRAGMA busy_time
1ab40 6f 75 74 5d 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20  out]..**.** ^If 
1ab50 74 68 65 20 62 75 73 79 20 63 61 6c 6c 62 61 63  the busy callbac
1ab60 6b 20 69 73 20 4e 55 4c 4c 2c 20 74 68 65 6e 20  k is NULL, then 
1ab70 5b 53 51 4c 49 54 45 5f 42 55 53 59 5d 0a 2a 2a  [SQLITE_BUSY].**
1ab80 20 69 73 20 72 65 74 75 72 6e 65 64 20 69 6d 6d   is returned imm
1ab90 65 64 69 61 74 65 6c 79 20 75 70 6f 6e 20 65 6e  ediately upon en
1aba0 63 6f 75 6e 74 65 72 69 6e 67 20 74 68 65 20 6c  countering the l
1abb0 6f 63 6b 2e 20 20 5e 49 66 20 74 68 65 20 62 75  ock.  ^If the bu
1abc0 73 79 20 63 61 6c 6c 62 61 63 6b 0a 2a 2a 20 69  sy callback.** i
1abd0 73 20 6e 6f 74 20 4e 55 4c 4c 2c 20 74 68 65 6e  s not NULL, then
1abe0 20 74 68 65 20 63 61 6c 6c 62 61 63 6b 20 6d 69   the callback mi
1abf0 67 68 74 20 62 65 20 69 6e 76 6f 6b 65 64 20 77  ght be invoked w
1ac00 69 74 68 20 74 77 6f 20 61 72 67 75 6d 65 6e 74  ith two argument
1ac10 73 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 66 69  s..**.** ^The fi
1ac20 72 73 74 20 61 72 67 75 6d 65 6e 74 20 74 6f 20  rst argument to 
1ac30 74 68 65 20 62 75 73 79 20 68 61 6e 64 6c 65 72  the busy handler
1ac40 20 69 73 20 61 20 63 6f 70 79 20 6f 66 20 74 68   is a copy of th
1ac50 65 20 76 6f 69 64 2a 20 70 6f 69 6e 74 65 72 20  e void* pointer 
1ac60 77 68 69 63 68 0a 2a 2a 20 69 73 20 74 68 65 20  which.** is the 
1ac70 74 68 69 72 64 20 61 72 67 75 6d 65 6e 74 20 74  third argument t
1ac80 6f 20 73 71 6c 69 74 65 33 5f 62 75 73 79 5f 68  o sqlite3_busy_h
1ac90 61 6e 64 6c 65 72 28 29 2e 20 20 5e 54 68 65 20  andler().  ^The 
1aca0 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74 20  second argument 
1acb0 74 6f 0a 2a 2a 20 74 68 65 20 62 75 73 79 20 68  to.** the busy h
1acc0 61 6e 64 6c 65 72 20 63 61 6c 6c 62 61 63 6b 20  andler callback 
1acd0 69 73 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66  is the number of
1ace0 20 74 69 6d 65 73 20 74 68 61 74 20 74 68 65 20   times that the 
1acf0 62 75 73 79 20 68 61 6e 64 6c 65 72 20 68 61 73  busy handler has
1ad00 0a 2a 2a 20 62 65 65 6e 20 69 6e 76 6f 6b 65 64  .** been invoked
1ad10 20 70 72 65 76 69 6f 75 73 6c 79 20 66 6f 72 20   previously for 
1ad20 74 68 65 20 73 61 6d 65 20 6c 6f 63 6b 69 6e 67  the same locking
1ad30 20 65 76 65 6e 74 2e 20 20 5e 49 66 20 74 68 65   event.  ^If the
1ad40 0a 2a 2a 20 62 75 73 79 20 63 61 6c 6c 62 61 63  .** busy callbac
1ad50 6b 20 72 65 74 75 72 6e 73 20 30 2c 20 74 68 65  k returns 0, the
1ad60 6e 20 6e 6f 20 61 64 64 69 74 69 6f 6e 61 6c 20  n no additional 
1ad70 61 74 74 65 6d 70 74 73 20 61 72 65 20 6d 61 64  attempts are mad
1ad80 65 20 74 6f 0a 2a 2a 20 61 63 63 65 73 73 20 74  e to.** access t
1ad90 68 65 20 64 61 74 61 62 61 73 65 20 61 6e 64 20  he database and 
1ada0 5b 53 51 4c 49 54 45 5f 42 55 53 59 5d 20 69 73  [SQLITE_BUSY] is
1adb0 20 72 65 74 75 72 6e 65 64 0a 2a 2a 20 74 6f 20   returned.** to 
1adc0 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 2e  the application.
1add0 0a 2a 2a 20 5e 49 66 20 74 68 65 20 63 61 6c 6c  .** ^If the call
1ade0 62 61 63 6b 20 72 65 74 75 72 6e 73 20 6e 6f 6e  back returns non
1adf0 2d 7a 65 72 6f 2c 20 74 68 65 6e 20 61 6e 6f 74  -zero, then anot
1ae00 68 65 72 20 61 74 74 65 6d 70 74 0a 2a 2a 20 69  her attempt.** i
1ae10 73 20 6d 61 64 65 20 74 6f 20 61 63 63 65 73 73  s made to access
1ae20 20 74 68 65 20 64 61 74 61 62 61 73 65 20 61 6e   the database an
1ae30 64 20 74 68 65 20 63 79 63 6c 65 20 72 65 70 65  d the cycle repe
1ae40 61 74 73 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 70  ats..**.** The p
1ae50 72 65 73 65 6e 63 65 20 6f 66 20 61 20 62 75 73  resence of a bus
1ae60 79 20 68 61 6e 64 6c 65 72 20 64 6f 65 73 20 6e  y handler does n
1ae70 6f 74 20 67 75 61 72 61 6e 74 65 65 20 74 68 61  ot guarantee tha
1ae80 74 20 69 74 20 77 69 6c 6c 20 62 65 20 69 6e 76  t it will be inv
1ae90 6f 6b 65 64 0a 2a 2a 20 77 68 65 6e 20 74 68 65  oked.** when the
1aea0 72 65 20 69 73 20 6c 6f 63 6b 20 63 6f 6e 74 65  re is lock conte
1aeb0 6e 74 69 6f 6e 2e 20 5e 49 66 20 53 51 4c 69 74  ntion. ^If SQLit
1aec0 65 20 64 65 74 65 72 6d 69 6e 65 73 20 74 68 61  e determines tha
1aed0 74 20 69 6e 76 6f 6b 69 6e 67 20 74 68 65 20 62  t invoking the b
1aee0 75 73 79 0a 2a 2a 20 68 61 6e 64 6c 65 72 20 63  usy.** handler c
1aef0 6f 75 6c 64 20 72 65 73 75 6c 74 20 69 6e 20 61  ould result in a
1af00 20 64 65 61 64 6c 6f 63 6b 2c 20 69 74 20 77 69   deadlock, it wi
1af10 6c 6c 20 67 6f 20 61 68 65 61 64 20 61 6e 64 20  ll go ahead and 
1af20 72 65 74 75 72 6e 20 5b 53 51 4c 49 54 45 5f 42  return [SQLITE_B
1af30 55 53 59 5d 0a 2a 2a 20 74 6f 20 74 68 65 20 61  USY].** to the a
1af40 70 70 6c 69 63 61 74 69 6f 6e 20 69 6e 73 74 65  pplication inste
1af50 61 64 20 6f 66 20 69 6e 76 6f 6b 69 6e 67 20 74  ad of invoking t
1af60 68 65 20 0a 2a 2a 20 62 75 73 79 20 68 61 6e 64  he .** busy hand
1af70 6c 65 72 2e 0a 2a 2a 20 43 6f 6e 73 69 64 65 72  ler..** Consider
1af80 20 61 20 73 63 65 6e 61 72 69 6f 20 77 68 65 72   a scenario wher
1af90 65 20 6f 6e 65 20 70 72 6f 63 65 73 73 20 69 73  e one process is
1afa0 20 68 6f 6c 64 69 6e 67 20 61 20 72 65 61 64 20   holding a read 
1afb0 6c 6f 63 6b 20 74 68 61 74 0a 2a 2a 20 69 74 20  lock that.** it 
1afc0 69 73 20 74 72 79 69 6e 67 20 74 6f 20 70 72 6f  is trying to pro
1afd0 6d 6f 74 65 20 74 6f 20 61 20 72 65 73 65 72 76  mote to a reserv
1afe0 65 64 20 6c 6f 63 6b 20 61 6e 64 0a 2a 2a 20 61  ed lock and.** a
1aff0 20 73 65 63 6f 6e 64 20 70 72 6f 63 65 73 73 20   second process 
1b000 69 73 20 68 6f 6c 64 69 6e 67 20 61 20 72 65 73  is holding a res
1b010 65 72 76 65 64 20 6c 6f 63 6b 20 74 68 61 74 20  erved lock that 
1b020 69 74 20 69 73 20 74 72 79 69 6e 67 0a 2a 2a 20  it is trying.** 
1b030 74 6f 20 70 72 6f 6d 6f 74 65 20 74 6f 20 61 6e  to promote to an
1b040 20 65 78 63 6c 75 73 69 76 65 20 6c 6f 63 6b 2e   exclusive lock.
1b050 20 20 54 68 65 20 66 69 72 73 74 20 70 72 6f 63    The first proc
1b060 65 73 73 20 63 61 6e 6e 6f 74 20 70 72 6f 63 65  ess cannot proce
1b070 65 64 0a 2a 2a 20 62 65 63 61 75 73 65 20 69 74  ed.** because it
1b080 20 69 73 20 62 6c 6f 63 6b 65 64 20 62 79 20 74   is blocked by t
1b090 68 65 20 73 65 63 6f 6e 64 20 61 6e 64 20 74 68  he second and th
1b0a0 65 20 73 65 63 6f 6e 64 20 70 72 6f 63 65 73 73  e second process
1b0b0 20 63 61 6e 6e 6f 74 0a 2a 2a 20 70 72 6f 63 65   cannot.** proce
1b0c0 65 64 20 62 65 63 61 75 73 65 20 69 74 20 69 73  ed because it is
1b0d0 20 62 6c 6f 63 6b 65 64 20 62 79 20 74 68 65 20   blocked by the 
1b0e0 66 69 72 73 74 2e 20 20 49 66 20 62 6f 74 68 20  first.  If both 
1b0f0 70 72 6f 63 65 73 73 65 73 0a 2a 2a 20 69 6e 76  processes.** inv
1b100 6f 6b 65 20 74 68 65 20 62 75 73 79 20 68 61 6e  oke the busy han
1b110 64 6c 65 72 73 2c 20 6e 65 69 74 68 65 72 20 77  dlers, neither w
1b120 69 6c 6c 20 6d 61 6b 65 20 61 6e 79 20 70 72 6f  ill make any pro
1b130 67 72 65 73 73 2e 20 20 54 68 65 72 65 66 6f 72  gress.  Therefor
1b140 65 2c 0a 2a 2a 20 53 51 4c 69 74 65 20 72 65 74  e,.** SQLite ret
1b150 75 72 6e 73 20 5b 53 51 4c 49 54 45 5f 42 55 53  urns [SQLITE_BUS
1b160 59 5d 20 66 6f 72 20 74 68 65 20 66 69 72 73 74  Y] for the first
1b170 20 70 72 6f 63 65 73 73 2c 20 68 6f 70 69 6e 67   process, hoping
1b180 20 74 68 61 74 20 74 68 69 73 0a 2a 2a 20 77 69   that this.** wi
1b190 6c 6c 20 69 6e 64 75 63 65 20 74 68 65 20 66 69  ll induce the fi
1b1a0 72 73 74 20 70 72 6f 63 65 73 73 20 74 6f 20 72  rst process to r
1b1b0 65 6c 65 61 73 65 20 69 74 73 20 72 65 61 64 20  elease its read 
1b1c0 6c 6f 63 6b 20 61 6e 64 20 61 6c 6c 6f 77 0a 2a  lock and allow.*
1b1d0 2a 20 74 68 65 20 73 65 63 6f 6e 64 20 70 72 6f  * the second pro
1b1e0 63 65 73 73 20 74 6f 20 70 72 6f 63 65 65 64 2e  cess to proceed.
1b1f0 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 64 65 66 61  .**.** ^The defa
1b200 75 6c 74 20 62 75 73 79 20 63 61 6c 6c 62 61 63  ult busy callbac
1b210 6b 20 69 73 20 4e 55 4c 4c 2e 0a 2a 2a 0a 2a 2a  k is NULL..**.**
1b220 20 5e 28 54 68 65 72 65 20 63 61 6e 20 6f 6e 6c   ^(There can onl
1b230 79 20 62 65 20 61 20 73 69 6e 67 6c 65 20 62 75  y be a single bu
1b240 73 79 20 68 61 6e 64 6c 65 72 20 64 65 66 69 6e  sy handler defin
1b250 65 64 20 66 6f 72 20 65 61 63 68 0a 2a 2a 20 5b  ed for each.** [
1b260 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74  database connect
1b270 69 6f 6e 5d 2e 20 20 53 65 74 74 69 6e 67 20 61  ion].  Setting a
1b280 20 6e 65 77 20 62 75 73 79 20 68 61 6e 64 6c 65   new busy handle
1b290 72 20 63 6c 65 61 72 73 20 61 6e 79 0a 2a 2a 20  r clears any.** 
1b2a0 70 72 65 76 69 6f 75 73 6c 79 20 73 65 74 20 68  previously set h
1b2b0 61 6e 64 6c 65 72 2e 29 5e 20 20 5e 4e 6f 74 65  andler.)^  ^Note
1b2c0 20 74 68 61 74 20 63 61 6c 6c 69 6e 67 20 5b 73   that calling [s
1b2d0 71 6c 69 74 65 33 5f 62 75 73 79 5f 74 69 6d 65  qlite3_busy_time
1b2e0 6f 75 74 28 29 5d 0a 2a 2a 20 6f 72 20 65 76 61  out()].** or eva
1b2f0 6c 75 61 74 69 6e 67 20 5b 50 52 41 47 4d 41 20  luating [PRAGMA 
1b300 62 75 73 79 5f 74 69 6d 65 6f 75 74 3d 4e 5d 20  busy_timeout=N] 
1b310 77 69 6c 6c 20 63 68 61 6e 67 65 20 74 68 65 0a  will change the.
1b320 2a 2a 20 62 75 73 79 20 68 61 6e 64 6c 65 72 20  ** busy handler 
1b330 61 6e 64 20 74 68 75 73 20 63 6c 65 61 72 20 61  and thus clear a
1b340 6e 79 20 70 72 65 76 69 6f 75 73 6c 79 20 73 65  ny previously se
1b350 74 20 62 75 73 79 20 68 61 6e 64 6c 65 72 2e 0a  t busy handler..
1b360 2a 2a 0a 2a 2a 20 54 68 65 20 62 75 73 79 20 63  **.** The busy c
1b370 61 6c 6c 62 61 63 6b 20 73 68 6f 75 6c 64 20 6e  allback should n
1b380 6f 74 20 74 61 6b 65 20 61 6e 79 20 61 63 74 69  ot take any acti
1b390 6f 6e 73 20 77 68 69 63 68 20 6d 6f 64 69 66 79  ons which modify
1b3a0 20 74 68 65 0a 2a 2a 20 64 61 74 61 62 61 73 65   the.** database
1b3b0 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 74 68 61 74   connection that
1b3c0 20 69 6e 76 6f 6b 65 64 20 74 68 65 20 62 75 73   invoked the bus
1b3d0 79 20 68 61 6e 64 6c 65 72 2e 20 20 49 6e 20 6f  y handler.  In o
1b3e0 74 68 65 72 20 77 6f 72 64 73 2c 0a 2a 2a 20 74  ther words,.** t
1b3f0 68 65 20 62 75 73 79 20 68 61 6e 64 6c 65 72 20  he busy handler 
1b400 69 73 20 6e 6f 74 20 72 65 65 6e 74 72 61 6e 74  is not reentrant
1b410 2e 20 20 41 6e 79 20 73 75 63 68 20 61 63 74 69  .  Any such acti
1b420 6f 6e 73 0a 2a 2a 20 72 65 73 75 6c 74 20 69 6e  ons.** result in
1b430 20 75 6e 64 65 66 69 6e 65 64 20 62 65 68 61 76   undefined behav
1b440 69 6f 72 2e 0a 2a 2a 20 0a 2a 2a 20 41 20 62 75  ior..** .** A bu
1b450 73 79 20 68 61 6e 64 6c 65 72 20 6d 75 73 74 20  sy handler must 
1b460 6e 6f 74 20 63 6c 6f 73 65 20 74 68 65 20 64 61  not close the da
1b470 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
1b480 6e 0a 2a 2a 20 6f 72 20 5b 70 72 65 70 61 72 65  n.** or [prepare
1b490 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 74 68 61  d statement] tha
1b4a0 74 20 69 6e 76 6f 6b 65 64 20 74 68 65 20 62 75  t invoked the bu
1b4b0 73 79 20 68 61 6e 64 6c 65 72 2e 0a 2a 2f 0a 69  sy handler..*/.i
1b4c0 6e 74 20 73 71 6c 69 74 65 33 5f 62 75 73 79 5f  nt sqlite3_busy_
1b4d0 68 61 6e 64 6c 65 72 28 73 71 6c 69 74 65 33 2a  handler(sqlite3*
1b4e0 2c 20 69 6e 74 28 2a 29 28 76 6f 69 64 2a 2c 69  , int(*)(void*,i
1b4f0 6e 74 29 2c 20 76 6f 69 64 2a 29 3b 0a 0a 2f 2a  nt), void*);../*
1b500 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 53 65  .** CAPI3REF: Se
1b510 74 20 41 20 42 75 73 79 20 54 69 6d 65 6f 75 74  t A Busy Timeout
1b520 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69  .** METHOD: sqli
1b530 74 65 33 0a 2a 2a 0a 2a 2a 20 5e 54 68 69 73 20  te3.**.** ^This 
1b540 72 6f 75 74 69 6e 65 20 73 65 74 73 20 61 20 5b  routine sets a [
1b550 73 71 6c 69 74 65 33 5f 62 75 73 79 5f 68 61 6e  sqlite3_busy_han
1b560 64 6c 65 72 20 7c 20 62 75 73 79 20 68 61 6e 64  dler | busy hand
1b570 6c 65 72 5d 20 74 68 61 74 20 73 6c 65 65 70 73  ler] that sleeps
1b580 0a 2a 2a 20 66 6f 72 20 61 20 73 70 65 63 69 66  .** for a specif
1b590 69 65 64 20 61 6d 6f 75 6e 74 20 6f 66 20 74 69  ied amount of ti
1b5a0 6d 65 20 77 68 65 6e 20 61 20 74 61 62 6c 65 20  me when a table 
1b5b0 69 73 20 6c 6f 63 6b 65 64 2e 20 20 5e 54 68 65  is locked.  ^The
1b5c0 20 68 61 6e 64 6c 65 72 0a 2a 2a 20 77 69 6c 6c   handler.** will
1b5d0 20 73 6c 65 65 70 20 6d 75 6c 74 69 70 6c 65 20   sleep multiple 
1b5e0 74 69 6d 65 73 20 75 6e 74 69 6c 20 61 74 20 6c  times until at l
1b5f0 65 61 73 74 20 22 6d 73 22 20 6d 69 6c 6c 69 73  east "ms" millis
1b600 65 63 6f 6e 64 73 20 6f 66 20 73 6c 65 65 70 69  econds of sleepi
1b610 6e 67 0a 2a 2a 20 68 61 76 65 20 61 63 63 75 6d  ng.** have accum
1b620 75 6c 61 74 65 64 2e 20 20 5e 41 66 74 65 72 20  ulated.  ^After 
1b630 61 74 20 6c 65 61 73 74 20 22 6d 73 22 20 6d 69  at least "ms" mi
1b640 6c 6c 69 73 65 63 6f 6e 64 73 20 6f 66 20 73 6c  lliseconds of sl
1b650 65 65 70 69 6e 67 2c 0a 2a 2a 20 74 68 65 20 68  eeping,.** the h
1b660 61 6e 64 6c 65 72 20 72 65 74 75 72 6e 73 20 30  andler returns 0
1b670 20 77 68 69 63 68 20 63 61 75 73 65 73 20 5b 73   which causes [s
1b680 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20 74  qlite3_step()] t
1b690 6f 20 72 65 74 75 72 6e 0a 2a 2a 20 5b 53 51 4c  o return.** [SQL
1b6a0 49 54 45 5f 42 55 53 59 5d 2e 0a 2a 2a 0a 2a 2a  ITE_BUSY]..**.**
1b6b0 20 5e 43 61 6c 6c 69 6e 67 20 74 68 69 73 20 72   ^Calling this r
1b6c0 6f 75 74 69 6e 65 20 77 69 74 68 20 61 6e 20 61  outine with an a
1b6d0 72 67 75 6d 65 6e 74 20 6c 65 73 73 20 74 68 61  rgument less tha
1b6e0 6e 20 6f 72 20 65 71 75 61 6c 20 74 6f 20 7a 65  n or equal to ze
1b6f0 72 6f 0a 2a 2a 20 74 75 72 6e 73 20 6f 66 66 20  ro.** turns off 
1b700 61 6c 6c 20 62 75 73 79 20 68 61 6e 64 6c 65 72  all busy handler
1b710 73 2e 0a 2a 2a 0a 2a 2a 20 5e 28 54 68 65 72 65  s..**.** ^(There
1b720 20 63 61 6e 20 6f 6e 6c 79 20 62 65 20 61 20 73   can only be a s
1b730 69 6e 67 6c 65 20 62 75 73 79 20 68 61 6e 64 6c  ingle busy handl
1b740 65 72 20 66 6f 72 20 61 20 70 61 72 74 69 63 75  er for a particu
1b750 6c 61 72 0a 2a 2a 20 5b 64 61 74 61 62 61 73 65  lar.** [database
1b760 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 61 74 20   connection] at 
1b770 61 6e 79 20 67 69 76 65 6e 20 6d 6f 6d 65 6e 74  any given moment
1b780 2e 20 20 49 66 20 61 6e 6f 74 68 65 72 20 62 75  .  If another bu
1b790 73 79 20 68 61 6e 64 6c 65 72 0a 2a 2a 20 77 61  sy handler.** wa
1b7a0 73 20 64 65 66 69 6e 65 64 20 20 28 75 73 69 6e  s defined  (usin
1b7b0 67 20 5b 73 71 6c 69 74 65 33 5f 62 75 73 79 5f  g [sqlite3_busy_
1b7c0 68 61 6e 64 6c 65 72 28 29 5d 29 20 70 72 69 6f  handler()]) prio
1b7d0 72 20 74 6f 20 63 61 6c 6c 69 6e 67 0a 2a 2a 20  r to calling.** 
1b7e0 74 68 69 73 20 72 6f 75 74 69 6e 65 2c 20 74 68  this routine, th
1b7f0 61 74 20 6f 74 68 65 72 20 62 75 73 79 20 68 61  at other busy ha
1b800 6e 64 6c 65 72 20 69 73 20 63 6c 65 61 72 65 64  ndler is cleared
1b810 2e 29 5e 0a 2a 2a 0a 2a 2a 20 53 65 65 20 61 6c  .)^.**.** See al
1b820 73 6f 3a 20 20 5b 50 52 41 47 4d 41 20 62 75 73  so:  [PRAGMA bus
1b830 79 5f 74 69 6d 65 6f 75 74 5d 0a 2a 2f 0a 69 6e  y_timeout].*/.in
1b840 74 20 73 71 6c 69 74 65 33 5f 62 75 73 79 5f 74  t sqlite3_busy_t
1b850 69 6d 65 6f 75 74 28 73 71 6c 69 74 65 33 2a 2c  imeout(sqlite3*,
1b860 20 69 6e 74 20 6d 73 29 3b 0a 0a 2f 2a 0a 2a 2a   int ms);../*.**
1b870 20 43 41 50 49 33 52 45 46 3a 20 43 6f 6e 76 65   CAPI3REF: Conve
1b880 6e 69 65 6e 63 65 20 52 6f 75 74 69 6e 65 73 20  nience Routines 
1b890 46 6f 72 20 52 75 6e 6e 69 6e 67 20 51 75 65 72  For Running Quer
1b8a0 69 65 73 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73  ies.** METHOD: s
1b8b0 71 6c 69 74 65 33 0a 2a 2a 0a 2a 2a 20 54 68 69  qlite3.**.** Thi
1b8c0 73 20 69 73 20 61 20 6c 65 67 61 63 79 20 69 6e  s is a legacy in
1b8d0 74 65 72 66 61 63 65 20 74 68 61 74 20 69 73 20  terface that is 
1b8e0 70 72 65 73 65 72 76 65 64 20 66 6f 72 20 62 61  preserved for ba
1b8f0 63 6b 77 61 72 64 73 20 63 6f 6d 70 61 74 69 62  ckwards compatib
1b900 69 6c 69 74 79 2e 0a 2a 2a 20 55 73 65 20 6f 66  ility..** Use of
1b910 20 74 68 69 73 20 69 6e 74 65 72 66 61 63 65 20   this interface 
1b920 69 73 20 6e 6f 74 20 72 65 63 6f 6d 6d 65 6e 64  is not recommend
1b930 65 64 2e 0a 2a 2a 0a 2a 2a 20 44 65 66 69 6e 69  ed..**.** Defini
1b940 74 69 6f 6e 3a 20 41 20 3c 62 3e 72 65 73 75 6c  tion: A <b>resul
1b950 74 20 74 61 62 6c 65 3c 2f 62 3e 20 69 73 20 6d  t table</b> is m
1b960 65 6d 6f 72 79 20 64 61 74 61 20 73 74 72 75 63  emory data struc
1b970 74 75 72 65 20 63 72 65 61 74 65 64 20 62 79 20  ture created by 
1b980 74 68 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f  the.** [sqlite3_
1b990 67 65 74 5f 74 61 62 6c 65 28 29 5d 20 69 6e 74  get_table()] int
1b9a0 65 72 66 61 63 65 2e 20 20 41 20 72 65 73 75 6c  erface.  A resul
1b9b0 74 20 74 61 62 6c 65 20 72 65 63 6f 72 64 73 20  t table records 
1b9c0 74 68 65 0a 2a 2a 20 63 6f 6d 70 6c 65 74 65 20  the.** complete 
1b9d0 71 75 65 72 79 20 72 65 73 75 6c 74 73 20 66 72  query results fr
1b9e0 6f 6d 20 6f 6e 65 20 6f 72 20 6d 6f 72 65 20 71  om one or more q
1b9f0 75 65 72 69 65 73 2e 0a 2a 2a 0a 2a 2a 20 54 68  ueries..**.** Th
1ba00 65 20 74 61 62 6c 65 20 63 6f 6e 63 65 70 74 75  e table conceptu
1ba10 61 6c 6c 79 20 68 61 73 20 61 20 6e 75 6d 62 65  ally has a numbe
1ba20 72 20 6f 66 20 72 6f 77 73 20 61 6e 64 20 63 6f  r of rows and co
1ba30 6c 75 6d 6e 73 2e 20 20 42 75 74 0a 2a 2a 20 74  lumns.  But.** t
1ba40 68 65 73 65 20 6e 75 6d 62 65 72 73 20 61 72 65  hese numbers are
1ba50 20 6e 6f 74 20 70 61 72 74 20 6f 66 20 74 68 65   not part of the
1ba60 20 72 65 73 75 6c 74 20 74 61 62 6c 65 20 69 74   result table it
1ba70 73 65 6c 66 2e 20 20 54 68 65 73 65 0a 2a 2a 20  self.  These.** 
1ba80 6e 75 6d 62 65 72 73 20 61 72 65 20 6f 62 74 61  numbers are obta
1ba90 69 6e 65 64 20 73 65 70 61 72 61 74 65 6c 79 2e  ined separately.
1baa0 20 20 4c 65 74 20 4e 20 62 65 20 74 68 65 20 6e    Let N be the n
1bab0 75 6d 62 65 72 20 6f 66 20 72 6f 77 73 0a 2a 2a  umber of rows.**
1bac0 20 61 6e 64 20 4d 20 62 65 20 74 68 65 20 6e 75   and M be the nu
1bad0 6d 62 65 72 20 6f 66 20 63 6f 6c 75 6d 6e 73 2e  mber of columns.
1bae0 0a 2a 2a 0a 2a 2a 20 41 20 72 65 73 75 6c 74 20  .**.** A result 
1baf0 74 61 62 6c 65 20 69 73 20 61 6e 20 61 72 72 61  table is an arra
1bb00 79 20 6f 66 20 70 6f 69 6e 74 65 72 73 20 74 6f  y of pointers to
1bb10 20 7a 65 72 6f 2d 74 65 72 6d 69 6e 61 74 65 64   zero-terminated
1bb20 20 55 54 46 2d 38 20 73 74 72 69 6e 67 73 2e 0a   UTF-8 strings..
1bb30 2a 2a 20 54 68 65 72 65 20 61 72 65 20 28 4e 2b  ** There are (N+
1bb40 31 29 2a 4d 20 65 6c 65 6d 65 6e 74 73 20 69 6e  1)*M elements in
1bb50 20 74 68 65 20 61 72 72 61 79 2e 20 20 54 68 65   the array.  The
1bb60 20 66 69 72 73 74 20 4d 20 70 6f 69 6e 74 65 72   first M pointer
1bb70 73 20 70 6f 69 6e 74 0a 2a 2a 20 74 6f 20 7a 65  s point.** to ze
1bb80 72 6f 2d 74 65 72 6d 69 6e 61 74 65 64 20 73 74  ro-terminated st
1bb90 72 69 6e 67 73 20 74 68 61 74 20 20 63 6f 6e 74  rings that  cont
1bba0 61 69 6e 20 74 68 65 20 6e 61 6d 65 73 20 6f 66  ain the names of
1bbb0 20 74 68 65 20 63 6f 6c 75 6d 6e 73 2e 0a 2a 2a   the columns..**
1bbc0 20 54 68 65 20 72 65 6d 61 69 6e 69 6e 67 20 65   The remaining e
1bbd0 6e 74 72 69 65 73 20 61 6c 6c 20 70 6f 69 6e 74  ntries all point
1bbe0 20 74 6f 20 71 75 65 72 79 20 72 65 73 75 6c 74   to query result
1bbf0 73 2e 20 20 4e 55 4c 4c 20 76 61 6c 75 65 73 20  s.  NULL values 
1bc00 72 65 73 75 6c 74 0a 2a 2a 20 69 6e 20 4e 55 4c  result.** in NUL
1bc10 4c 20 70 6f 69 6e 74 65 72 73 2e 20 20 41 6c 6c  L pointers.  All
1bc20 20 6f 74 68 65 72 20 76 61 6c 75 65 73 20 61 72   other values ar
1bc30 65 20 69 6e 20 74 68 65 69 72 20 55 54 46 2d 38  e in their UTF-8
1bc40 20 7a 65 72 6f 2d 74 65 72 6d 69 6e 61 74 65 64   zero-terminated
1bc50 0a 2a 2a 20 73 74 72 69 6e 67 20 72 65 70 72 65  .** string repre
1bc60 73 65 6e 74 61 74 69 6f 6e 20 61 73 20 72 65 74  sentation as ret
1bc70 75 72 6e 65 64 20 62 79 20 5b 73 71 6c 69 74 65  urned by [sqlite
1bc80 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 28 29 5d  3_column_text()]
1bc90 2e 0a 2a 2a 0a 2a 2a 20 41 20 72 65 73 75 6c 74  ..**.** A result
1bca0 20 74 61 62 6c 65 20 6d 69 67 68 74 20 63 6f 6e   table might con
1bcb0 73 69 73 74 20 6f 66 20 6f 6e 65 20 6f 72 20 6d  sist of one or m
1bcc0 6f 72 65 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63  ore memory alloc
1bcd0 61 74 69 6f 6e 73 2e 0a 2a 2a 20 49 74 20 69 73  ations..** It is
1bce0 20 6e 6f 74 20 73 61 66 65 20 74 6f 20 70 61 73   not safe to pas
1bcf0 73 20 61 20 72 65 73 75 6c 74 20 74 61 62 6c 65  s a result table
1bd00 20 64 69 72 65 63 74 6c 79 20 74 6f 20 5b 73 71   directly to [sq
1bd10 6c 69 74 65 33 5f 66 72 65 65 28 29 5d 2e 0a 2a  lite3_free()]..*
1bd20 2a 20 41 20 72 65 73 75 6c 74 20 74 61 62 6c 65  * A result table
1bd30 20 73 68 6f 75 6c 64 20 62 65 20 64 65 61 6c 6c   should be deall
1bd40 6f 63 61 74 65 64 20 75 73 69 6e 67 20 5b 73 71  ocated using [sq
1bd50 6c 69 74 65 33 5f 66 72 65 65 5f 74 61 62 6c 65  lite3_free_table
1bd60 28 29 5d 2e 0a 2a 2a 0a 2a 2a 20 5e 28 41 73 20  ()]..**.** ^(As 
1bd70 61 6e 20 65 78 61 6d 70 6c 65 20 6f 66 20 74 68  an example of th
1bd80 65 20 72 65 73 75 6c 74 20 74 61 62 6c 65 20 66  e result table f
1bd90 6f 72 6d 61 74 2c 20 73 75 70 70 6f 73 65 20 61  ormat, suppose a
1bda0 20 71 75 65 72 79 20 72 65 73 75 6c 74 0a 2a 2a   query result.**
1bdb0 20 69 73 20 61 73 20 66 6f 6c 6c 6f 77 73 3a 0a   is as follows:.
1bdc0 2a 2a 0a 2a 2a 20 3c 62 6c 6f 63 6b 71 75 6f 74  **.** <blockquot
1bdd0 65 3e 3c 70 72 65 3e 0a 2a 2a 20 20 20 20 20 20  e><pre>.**      
1bde0 20 20 4e 61 6d 65 20 20 20 20 20 20 20 20 7c 20    Name        | 
1bdf0 41 67 65 0a 2a 2a 20 20 20 20 20 20 20 20 2d 2d  Age.**        --
1be00 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d  ----------------
1be10 2d 2d 2d 2d 2d 0a 2a 2a 20 20 20 20 20 20 20 20  -----.**        
1be20 41 6c 69 63 65 20 20 20 20 20 20 20 7c 20 34 33  Alice       | 43
1be30 0a 2a 2a 20 20 20 20 20 20 20 20 42 6f 62 20 20  .**        Bob  
1be40 20 20 20 20 20 20 20 7c 20 32 38 0a 2a 2a 20 20         | 28.**  
1be50 20 20 20 20 20 20 43 69 6e 64 79 20 20 20 20 20        Cindy     
1be60 20 20 7c 20 32 31 0a 2a 2a 20 3c 2f 70 72 65 3e    | 21.** </pre>
1be70 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 2a 2a  </blockquote>.**
1be80 0a 2a 2a 20 54 68 65 72 65 20 61 72 65 20 74 77  .** There are tw
1be90 6f 20 63 6f 6c 75 6d 6e 20 28 4d 3d 3d 32 29 20  o column (M==2) 
1bea0 61 6e 64 20 74 68 72 65 65 20 72 6f 77 73 20 28  and three rows (
1beb0 4e 3d 3d 33 29 2e 20 20 54 68 75 73 20 74 68 65  N==3).  Thus the
1bec0 0a 2a 2a 20 72 65 73 75 6c 74 20 74 61 62 6c 65  .** result table
1bed0 20 68 61 73 20 38 20 65 6e 74 72 69 65 73 2e 20   has 8 entries. 
1bee0 20 53 75 70 70 6f 73 65 20 74 68 65 20 72 65 73   Suppose the res
1bef0 75 6c 74 20 74 61 62 6c 65 20 69 73 20 73 74 6f  ult table is sto
1bf00 72 65 64 0a 2a 2a 20 69 6e 20 61 6e 20 61 72 72  red.** in an arr
1bf10 61 79 20 6e 61 6d 65 73 20 61 7a 52 65 73 75 6c  ay names azResul
1bf20 74 2e 20 20 54 68 65 6e 20 61 7a 52 65 73 75 6c  t.  Then azResul
1bf30 74 20 68 6f 6c 64 73 20 74 68 69 73 20 63 6f 6e  t holds this con
1bf40 74 65 6e 74 3a 0a 2a 2a 0a 2a 2a 20 3c 62 6c 6f  tent:.**.** <blo
1bf50 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a 2a 2a  ckquote><pre>.**
1bf60 20 20 20 20 20 20 20 20 61 7a 52 65 73 75 6c 74          azResult
1bf70 26 23 39 31 3b 30 5d 20 3d 20 22 4e 61 6d 65 22  &#91;0] = "Name"
1bf80 3b 0a 2a 2a 20 20 20 20 20 20 20 20 61 7a 52 65  ;.**        azRe
1bf90 73 75 6c 74 26 23 39 31 3b 31 5d 20 3d 20 22 41  sult&#91;1] = "A
1bfa0 67 65 22 3b 0a 2a 2a 20 20 20 20 20 20 20 20 61  ge";.**        a
1bfb0 7a 52 65 73 75 6c 74 26 23 39 31 3b 32 5d 20 3d  zResult&#91;2] =
1bfc0 20 22 41 6c 69 63 65 22 3b 0a 2a 2a 20 20 20 20   "Alice";.**    
1bfd0 20 20 20 20 61 7a 52 65 73 75 6c 74 26 23 39 31      azResult&#91
1bfe0 3b 33 5d 20 3d 20 22 34 33 22 3b 0a 2a 2a 20 20  ;3] = "43";.**  
1bff0 20 20 20 20 20 20 61 7a 52 65 73 75 6c 74 26 23        azResult&#
1c000 39 31 3b 34 5d 20 3d 20 22 42 6f 62 22 3b 0a 2a  91;4] = "Bob";.*
1c010 2a 20 20 20 20 20 20 20 20 61 7a 52 65 73 75 6c  *        azResul
1c020 74 26 23 39 31 3b 35 5d 20 3d 20 22 32 38 22 3b  t&#91;5] = "28";
1c030 0a 2a 2a 20 20 20 20 20 20 20 20 61 7a 52 65 73  .**        azRes
1c040 75 6c 74 26 23 39 31 3b 36 5d 20 3d 20 22 43 69  ult&#91;6] = "Ci
1c050 6e 64 79 22 3b 0a 2a 2a 20 20 20 20 20 20 20 20  ndy";.**        
1c060 61 7a 52 65 73 75 6c 74 26 23 39 31 3b 37 5d 20  azResult&#91;7] 
1c070 3d 20 22 32 31 22 3b 0a 2a 2a 20 3c 2f 70 72 65  = "21";.** </pre
1c080 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 29 5e  ></blockquote>)^
1c090 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69  .**.** ^The sqli
1c0a0 74 65 33 5f 67 65 74 5f 74 61 62 6c 65 28 29 20  te3_get_table() 
1c0b0 66 75 6e 63 74 69 6f 6e 20 65 76 61 6c 75 61 74  function evaluat
1c0c0 65 73 20 6f 6e 65 20 6f 72 20 6d 6f 72 65 0a 2a  es one or more.*
1c0d0 2a 20 73 65 6d 69 63 6f 6c 6f 6e 2d 73 65 70 61  * semicolon-sepa
1c0e0 72 61 74 65 64 20 53 51 4c 20 73 74 61 74 65 6d  rated SQL statem
1c0f0 65 6e 74 73 20 69 6e 20 74 68 65 20 7a 65 72 6f  ents in the zero
1c100 2d 74 65 72 6d 69 6e 61 74 65 64 20 55 54 46 2d  -terminated UTF-
1c110 38 0a 2a 2a 20 73 74 72 69 6e 67 20 6f 66 20 69  8.** string of i
1c120 74 73 20 32 6e 64 20 70 61 72 61 6d 65 74 65 72  ts 2nd parameter
1c130 20 61 6e 64 20 72 65 74 75 72 6e 73 20 61 20 72   and returns a r
1c140 65 73 75 6c 74 20 74 61 62 6c 65 20 74 6f 20 74  esult table to t
1c150 68 65 0a 2a 2a 20 70 6f 69 6e 74 65 72 20 67 69  he.** pointer gi
1c160 76 65 6e 20 69 6e 20 69 74 73 20 33 72 64 20 70  ven in its 3rd p
1c170 61 72 61 6d 65 74 65 72 2e 0a 2a 2a 0a 2a 2a 20  arameter..**.** 
1c180 41 66 74 65 72 20 74 68 65 20 61 70 70 6c 69 63  After the applic
1c190 61 74 69 6f 6e 20 68 61 73 20 66 69 6e 69 73 68  ation has finish
1c1a0 65 64 20 77 69 74 68 20 74 68 65 20 72 65 73 75  ed with the resu
1c1b0 6c 74 20 66 72 6f 6d 20 73 71 6c 69 74 65 33 5f  lt from sqlite3_
1c1c0 67 65 74 5f 74 61 62 6c 65 28 29 2c 0a 2a 2a 20  get_table(),.** 
1c1d0 69 74 20 6d 75 73 74 20 70 61 73 73 20 74 68 65  it must pass the
1c1e0 20 72 65 73 75 6c 74 20 74 61 62 6c 65 20 70 6f   result table po
1c1f0 69 6e 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33  inter to sqlite3
1c200 5f 66 72 65 65 5f 74 61 62 6c 65 28 29 20 69 6e  _free_table() in
1c210 20 6f 72 64 65 72 20 74 6f 0a 2a 2a 20 72 65 6c   order to.** rel
1c220 65 61 73 65 20 74 68 65 20 6d 65 6d 6f 72 79 20  ease the memory 
1c230 74 68 61 74 20 77 61 73 20 6d 61 6c 6c 6f 63 65  that was malloce
1c240 64 2e 20 20 42 65 63 61 75 73 65 20 6f 66 20 74  d.  Because of t
1c250 68 65 20 77 61 79 20 74 68 65 0a 2a 2a 20 5b 73  he way the.** [s
1c260 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29 5d  qlite3_malloc()]
1c270 20 68 61 70 70 65 6e 73 20 77 69 74 68 69 6e 20   happens within 
1c280 73 71 6c 69 74 65 33 5f 67 65 74 5f 74 61 62 6c  sqlite3_get_tabl
1c290 65 28 29 2c 20 74 68 65 20 63 61 6c 6c 69 6e 67  e(), the calling
1c2a0 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 20 6d 75 73  .** function mus
1c2b0 74 20 6e 6f 74 20 74 72 79 20 74 6f 20 63 61 6c  t not try to cal
1c2c0 6c 20 5b 73 71 6c 69 74 65 33 5f 66 72 65 65 28  l [sqlite3_free(
1c2d0 29 5d 20 64 69 72 65 63 74 6c 79 2e 20 20 4f 6e  )] directly.  On
1c2e0 6c 79 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 66  ly.** [sqlite3_f
1c2f0 72 65 65 5f 74 61 62 6c 65 28 29 5d 20 69 73 20  ree_table()] is 
1c300 61 62 6c 65 20 74 6f 20 72 65 6c 65 61 73 65 20  able to release 
1c310 74 68 65 20 6d 65 6d 6f 72 79 20 70 72 6f 70 65  the memory prope
1c320 72 6c 79 20 61 6e 64 20 73 61 66 65 6c 79 2e 0a  rly and safely..
1c330 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74 65  **.** The sqlite
1c340 33 5f 67 65 74 5f 74 61 62 6c 65 28 29 20 69 6e  3_get_table() in
1c350 74 65 72 66 61 63 65 20 69 73 20 69 6d 70 6c 65  terface is imple
1c360 6d 65 6e 74 65 64 20 61 73 20 61 20 77 72 61 70  mented as a wrap
1c370 70 65 72 20 61 72 6f 75 6e 64 0a 2a 2a 20 5b 73  per around.** [s
1c380 71 6c 69 74 65 33 5f 65 78 65 63 28 29 5d 2e 20  qlite3_exec()]. 
1c390 20 54 68 65 20 73 71 6c 69 74 65 33 5f 67 65 74   The sqlite3_get
1c3a0 5f 74 61 62 6c 65 28 29 20 72 6f 75 74 69 6e 65  _table() routine
1c3b0 20 64 6f 65 73 20 6e 6f 74 20 68 61 76 65 20 61   does not have a
1c3c0 63 63 65 73 73 0a 2a 2a 20 74 6f 20 61 6e 79 20  ccess.** to any 
1c3d0 69 6e 74 65 72 6e 61 6c 20 64 61 74 61 20 73 74  internal data st
1c3e0 72 75 63 74 75 72 65 73 20 6f 66 20 53 51 4c 69  ructures of SQLi
1c3f0 74 65 2e 20 20 49 74 20 75 73 65 73 20 6f 6e 6c  te.  It uses onl
1c400 79 20 74 68 65 20 70 75 62 6c 69 63 0a 2a 2a 20  y the public.** 
1c410 69 6e 74 65 72 66 61 63 65 20 64 65 66 69 6e 65  interface define
1c420 64 20 68 65 72 65 2e 20 20 41 73 20 61 20 63 6f  d here.  As a co
1c430 6e 73 65 71 75 65 6e 63 65 2c 20 65 72 72 6f 72  nsequence, error
1c440 73 20 74 68 61 74 20 6f 63 63 75 72 20 69 6e 20  s that occur in 
1c450 74 68 65 0a 2a 2a 20 77 72 61 70 70 65 72 20 6c  the.** wrapper l
1c460 61 79 65 72 20 6f 75 74 73 69 64 65 20 6f 66 20  ayer outside of 
1c470 74 68 65 20 69 6e 74 65 72 6e 61 6c 20 5b 73 71  the internal [sq
1c480 6c 69 74 65 33 5f 65 78 65 63 28 29 5d 20 63 61  lite3_exec()] ca
1c490 6c 6c 20 61 72 65 20 6e 6f 74 0a 2a 2a 20 72 65  ll are not.** re
1c4a0 66 6c 65 63 74 65 64 20 69 6e 20 73 75 62 73 65  flected in subse
1c4b0 71 75 65 6e 74 20 63 61 6c 6c 73 20 74 6f 20 5b  quent calls to [
1c4c0 73 71 6c 69 74 65 33 5f 65 72 72 63 6f 64 65 28  sqlite3_errcode(
1c4d0 29 5d 20 6f 72 0a 2a 2a 20 5b 73 71 6c 69 74 65  )] or.** [sqlite
1c4e0 33 5f 65 72 72 6d 73 67 28 29 5d 2e 0a 2a 2f 0a  3_errmsg()]..*/.
1c4f0 69 6e 74 20 73 71 6c 69 74 65 33 5f 67 65 74 5f  int sqlite3_get_
1c500 74 61 62 6c 65 28 0a 20 20 73 71 6c 69 74 65 33  table(.  sqlite3
1c510 20 2a 64 62 2c 20 20 20 20 20 20 20 20 20 20 2f   *db,          /
1c520 2a 20 41 6e 20 6f 70 65 6e 20 64 61 74 61 62 61  * An open databa
1c530 73 65 20 2a 2f 0a 20 20 63 6f 6e 73 74 20 63 68  se */.  const ch
1c540 61 72 20 2a 7a 53 71 6c 2c 20 20 20 20 20 2f 2a  ar *zSql,     /*
1c550 20 53 51 4c 20 74 6f 20 62 65 20 65 76 61 6c 75   SQL to be evalu
1c560 61 74 65 64 20 2a 2f 0a 20 20 63 68 61 72 20 2a  ated */.  char *
1c570 2a 2a 70 61 7a 52 65 73 75 6c 74 2c 20 20 20 20  **pazResult,    
1c580 2f 2a 20 52 65 73 75 6c 74 73 20 6f 66 20 74 68  /* Results of th
1c590 65 20 71 75 65 72 79 20 2a 2f 0a 20 20 69 6e 74  e query */.  int
1c5a0 20 2a 70 6e 52 6f 77 2c 20 20 20 20 20 20 20 20   *pnRow,        
1c5b0 20 20 20 2f 2a 20 4e 75 6d 62 65 72 20 6f 66 20     /* Number of 
1c5c0 72 65 73 75 6c 74 20 72 6f 77 73 20 77 72 69 74  result rows writ
1c5d0 74 65 6e 20 68 65 72 65 20 2a 2f 0a 20 20 69 6e  ten here */.  in
1c5e0 74 20 2a 70 6e 43 6f 6c 75 6d 6e 2c 20 20 20 20  t *pnColumn,    
1c5f0 20 20 20 20 2f 2a 20 4e 75 6d 62 65 72 20 6f 66      /* Number of
1c600 20 72 65 73 75 6c 74 20 63 6f 6c 75 6d 6e 73 20   result columns 
1c610 77 72 69 74 74 65 6e 20 68 65 72 65 20 2a 2f 0a  written here */.
1c620 20 20 63 68 61 72 20 2a 2a 70 7a 45 72 72 6d 73    char **pzErrms
1c630 67 20 20 20 20 20 20 20 2f 2a 20 45 72 72 6f 72  g       /* Error
1c640 20 6d 73 67 20 77 72 69 74 74 65 6e 20 68 65 72   msg written her
1c650 65 20 2a 2f 0a 29 3b 0a 76 6f 69 64 20 73 71 6c  e */.);.void sql
1c660 69 74 65 33 5f 66 72 65 65 5f 74 61 62 6c 65 28  ite3_free_table(
1c670 63 68 61 72 20 2a 2a 72 65 73 75 6c 74 29 3b 0a  char **result);.
1c680 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
1c690 20 46 6f 72 6d 61 74 74 65 64 20 53 74 72 69 6e   Formatted Strin
1c6a0 67 20 50 72 69 6e 74 69 6e 67 20 46 75 6e 63 74  g Printing Funct
1c6b0 69 6f 6e 73 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65  ions.**.** These
1c6c0 20 72 6f 75 74 69 6e 65 73 20 61 72 65 20 77 6f   routines are wo
1c6d0 72 6b 2d 61 6c 69 6b 65 73 20 6f 66 20 74 68 65  rk-alikes of the
1c6e0 20 22 70 72 69 6e 74 66 28 29 22 20 66 61 6d 69   "printf()" fami
1c6f0 6c 79 20 6f 66 20 66 75 6e 63 74 69 6f 6e 73 0a  ly of functions.
1c700 2a 2a 20 66 72 6f 6d 20 74 68 65 20 73 74 61 6e  ** from the stan
1c710 64 61 72 64 20 43 20 6c 69 62 72 61 72 79 2e 0a  dard C library..
1c720 2a 2a 20 54 68 65 73 65 20 72 6f 75 74 69 6e 65  ** These routine
1c730 73 20 75 6e 64 65 72 73 74 61 6e 64 20 6d 6f 73  s understand mos
1c740 74 20 6f 66 20 74 68 65 20 63 6f 6d 6d 6f 6e 20  t of the common 
1c750 4b 26 52 20 66 6f 72 6d 61 74 74 69 6e 67 20 6f  K&R formatting o
1c760 70 74 69 6f 6e 73 2c 0a 2a 2a 20 70 6c 75 73 20  ptions,.** plus 
1c770 73 6f 6d 65 20 61 64 64 69 74 69 6f 6e 61 6c 20  some additional 
1c780 6e 6f 6e 2d 73 74 61 6e 64 61 72 64 20 66 6f 72  non-standard for
1c790 6d 61 74 73 2c 20 64 65 74 61 69 6c 65 64 20 62  mats, detailed b
1c7a0 65 6c 6f 77 2e 0a 2a 2a 20 4e 6f 74 65 20 74 68  elow..** Note th
1c7b0 61 74 20 73 6f 6d 65 20 6f 66 20 74 68 65 20 6d  at some of the m
1c7c0 6f 72 65 20 6f 62 73 63 75 72 65 20 66 6f 72 6d  ore obscure form
1c7d0 61 74 74 69 6e 67 20 6f 70 74 69 6f 6e 73 20 66  atting options f
1c7e0 72 6f 6d 20 72 65 63 65 6e 74 0a 2a 2a 20 43 2d  rom recent.** C-
1c7f0 6c 69 62 72 61 72 79 20 73 74 61 6e 64 61 72 64  library standard
1c800 73 20 61 72 65 20 6f 6d 69 74 74 65 64 20 66 72  s are omitted fr
1c810 6f 6d 20 74 68 69 73 20 69 6d 70 6c 65 6d 65 6e  om this implemen
1c820 74 61 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 5e 54  tation..**.** ^T
1c830 68 65 20 73 71 6c 69 74 65 33 5f 6d 70 72 69 6e  he sqlite3_mprin
1c840 74 66 28 29 20 61 6e 64 20 73 71 6c 69 74 65 33  tf() and sqlite3
1c850 5f 76 6d 70 72 69 6e 74 66 28 29 20 72 6f 75 74  _vmprintf() rout
1c860 69 6e 65 73 20 77 72 69 74 65 20 74 68 65 69 72  ines write their
1c870 0a 2a 2a 20 72 65 73 75 6c 74 73 20 69 6e 74 6f  .** results into
1c880 20 6d 65 6d 6f 72 79 20 6f 62 74 61 69 6e 65 64   memory obtained
1c890 20 66 72 6f 6d 20 5b 73 71 6c 69 74 65 33 5f 6d   from [sqlite3_m
1c8a0 61 6c 6c 6f 63 28 29 5d 2e 0a 2a 2a 20 54 68 65  alloc()]..** The
1c8b0 20 73 74 72 69 6e 67 73 20 72 65 74 75 72 6e 65   strings returne
1c8c0 64 20 62 79 20 74 68 65 73 65 20 74 77 6f 20 72  d by these two r
1c8d0 6f 75 74 69 6e 65 73 20 73 68 6f 75 6c 64 20 62  outines should b
1c8e0 65 0a 2a 2a 20 72 65 6c 65 61 73 65 64 20 62 79  e.** released by
1c8f0 20 5b 73 71 6c 69 74 65 33 5f 66 72 65 65 28 29   [sqlite3_free()
1c900 5d 2e 20 20 5e 42 6f 74 68 20 72 6f 75 74 69 6e  ].  ^Both routin
1c910 65 73 20 72 65 74 75 72 6e 20 61 0a 2a 2a 20 4e  es return a.** N
1c920 55 4c 4c 20 70 6f 69 6e 74 65 72 20 69 66 20 5b  ULL pointer if [
1c930 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29  sqlite3_malloc()
1c940 5d 20 69 73 20 75 6e 61 62 6c 65 20 74 6f 20 61  ] is unable to a
1c950 6c 6c 6f 63 61 74 65 20 65 6e 6f 75 67 68 0a 2a  llocate enough.*
1c960 2a 20 6d 65 6d 6f 72 79 20 74 6f 20 68 6f 6c 64  * memory to hold
1c970 20 74 68 65 20 72 65 73 75 6c 74 69 6e 67 20 73   the resulting s
1c980 74 72 69 6e 67 2e 0a 2a 2a 0a 2a 2a 20 5e 28 54  tring..**.** ^(T
1c990 68 65 20 73 71 6c 69 74 65 33 5f 73 6e 70 72 69  he sqlite3_snpri
1c9a0 6e 74 66 28 29 20 72 6f 75 74 69 6e 65 20 69 73  ntf() routine is
1c9b0 20 73 69 6d 69 6c 61 72 20 74 6f 20 22 73 6e 70   similar to "snp
1c9c0 72 69 6e 74 66 28 29 22 20 66 72 6f 6d 0a 2a 2a  rintf()" from.**
1c9d0 20 74 68 65 20 73 74 61 6e 64 61 72 64 20 43 20   the standard C 
1c9e0 6c 69 62 72 61 72 79 2e 20 20 54 68 65 20 72 65  library.  The re
1c9f0 73 75 6c 74 20 69 73 20 77 72 69 74 74 65 6e 20  sult is written 
1ca00 69 6e 74 6f 20 74 68 65 0a 2a 2a 20 62 75 66 66  into the.** buff
1ca10 65 72 20 73 75 70 70 6c 69 65 64 20 61 73 20 74  er supplied as t
1ca20 68 65 20 73 65 63 6f 6e 64 20 70 61 72 61 6d 65  he second parame
1ca30 74 65 72 20 77 68 6f 73 65 20 73 69 7a 65 20 69  ter whose size i
1ca40 73 20 67 69 76 65 6e 20 62 79 0a 2a 2a 20 74 68  s given by.** th
1ca50 65 20 66 69 72 73 74 20 70 61 72 61 6d 65 74 65  e first paramete
1ca60 72 2e 20 4e 6f 74 65 20 74 68 61 74 20 74 68 65  r. Note that the
1ca70 20 6f 72 64 65 72 20 6f 66 20 74 68 65 0a 2a 2a   order of the.**
1ca80 20 66 69 72 73 74 20 74 77 6f 20 70 61 72 61 6d   first two param
1ca90 65 74 65 72 73 20 69 73 20 72 65 76 65 72 73 65  eters is reverse
1caa0 64 20 66 72 6f 6d 20 73 6e 70 72 69 6e 74 66 28  d from snprintf(
1cab0 29 2e 29 5e 20 20 54 68 69 73 20 69 73 20 61 6e  ).)^  This is an
1cac0 0a 2a 2a 20 68 69 73 74 6f 72 69 63 61 6c 20 61  .** historical a
1cad0 63 63 69 64 65 6e 74 20 74 68 61 74 20 63 61 6e  ccident that can
1cae0 6e 6f 74 20 62 65 20 66 69 78 65 64 20 77 69 74  not be fixed wit
1caf0 68 6f 75 74 20 62 72 65 61 6b 69 6e 67 0a 2a 2a  hout breaking.**
1cb00 20 62 61 63 6b 77 61 72 64 73 20 63 6f 6d 70 61   backwards compa
1cb10 74 69 62 69 6c 69 74 79 2e 20 20 5e 28 4e 6f 74  tibility.  ^(Not
1cb20 65 20 61 6c 73 6f 20 74 68 61 74 20 73 71 6c 69  e also that sqli
1cb30 74 65 33 5f 73 6e 70 72 69 6e 74 66 28 29 0a 2a  te3_snprintf().*
1cb40 2a 20 72 65 74 75 72 6e 73 20 61 20 70 6f 69 6e  * returns a poin
1cb50 74 65 72 20 74 6f 20 69 74 73 20 62 75 66 66 65  ter to its buffe
1cb60 72 20 69 6e 73 74 65 61 64 20 6f 66 20 74 68 65  r instead of the
1cb70 20 6e 75 6d 62 65 72 20 6f 66 0a 2a 2a 20 63 68   number of.** ch
1cb80 61 72 61 63 74 65 72 73 20 61 63 74 75 61 6c 6c  aracters actuall
1cb90 79 20 77 72 69 74 74 65 6e 20 69 6e 74 6f 20 74  y written into t
1cba0 68 65 20 62 75 66 66 65 72 2e 29 5e 20 20 57 65  he buffer.)^  We
1cbb0 20 61 64 6d 69 74 20 74 68 61 74 0a 2a 2a 20 74   admit that.** t
1cbc0 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 63 68 61  he number of cha
1cbd0 72 61 63 74 65 72 73 20 77 72 69 74 74 65 6e 20  racters written 
1cbe0 77 6f 75 6c 64 20 62 65 20 61 20 6d 6f 72 65 20  would be a more 
1cbf0 75 73 65 66 75 6c 20 72 65 74 75 72 6e 0a 2a 2a  useful return.**
1cc00 20 76 61 6c 75 65 20 62 75 74 20 77 65 20 63 61   value but we ca
1cc10 6e 6e 6f 74 20 63 68 61 6e 67 65 20 74 68 65 20  nnot change the 
1cc20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 6f  implementation o
1cc30 66 20 73 71 6c 69 74 65 33 5f 73 6e 70 72 69 6e  f sqlite3_snprin
1cc40 74 66 28 29 0a 2a 2a 20 6e 6f 77 20 77 69 74 68  tf().** now with
1cc50 6f 75 74 20 62 72 65 61 6b 69 6e 67 20 63 6f 6d  out breaking com
1cc60 70 61 74 69 62 69 6c 69 74 79 2e 0a 2a 2a 0a 2a  patibility..**.*
1cc70 2a 20 5e 41 73 20 6c 6f 6e 67 20 61 73 20 74 68  * ^As long as th
1cc80 65 20 62 75 66 66 65 72 20 73 69 7a 65 20 69 73  e buffer size is
1cc90 20 67 72 65 61 74 65 72 20 74 68 61 6e 20 7a 65   greater than ze
1cca0 72 6f 2c 20 73 71 6c 69 74 65 33 5f 73 6e 70 72  ro, sqlite3_snpr
1ccb0 69 6e 74 66 28 29 0a 2a 2a 20 67 75 61 72 61 6e  intf().** guaran
1ccc0 74 65 65 73 20 74 68 61 74 20 74 68 65 20 62 75  tees that the bu
1ccd0 66 66 65 72 20 69 73 20 61 6c 77 61 79 73 20 7a  ffer is always z
1cce0 65 72 6f 2d 74 65 72 6d 69 6e 61 74 65 64 2e 20  ero-terminated. 
1ccf0 20 5e 54 68 65 20 66 69 72 73 74 0a 2a 2a 20 70   ^The first.** p
1cd00 61 72 61 6d 65 74 65 72 20 22 6e 22 20 69 73 20  arameter "n" is 
1cd10 74 68 65 20 74 6f 74 61 6c 20 73 69 7a 65 20 6f  the total size o
1cd20 66 20 74 68 65 20 62 75 66 66 65 72 2c 20 69 6e  f the buffer, in
1cd30 63 6c 75 64 69 6e 67 20 73 70 61 63 65 20 66 6f  cluding space fo
1cd40 72 0a 2a 2a 20 74 68 65 20 7a 65 72 6f 20 74 65  r.** the zero te
1cd50 72 6d 69 6e 61 74 6f 72 2e 20 20 53 6f 20 74 68  rminator.  So th
1cd60 65 20 6c 6f 6e 67 65 73 74 20 73 74 72 69 6e 67  e longest string
1cd70 20 74 68 61 74 20 63 61 6e 20 62 65 20 63 6f 6d   that can be com
1cd80 70 6c 65 74 65 6c 79 0a 2a 2a 20 77 72 69 74 74  pletely.** writt
1cd90 65 6e 20 77 69 6c 6c 20 62 65 20 6e 2d 31 20 63  en will be n-1 c
1cda0 68 61 72 61 63 74 65 72 73 2e 0a 2a 2a 0a 2a 2a  haracters..**.**
1cdb0 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 76 73   ^The sqlite3_vs
1cdc0 6e 70 72 69 6e 74 66 28 29 20 72 6f 75 74 69 6e  nprintf() routin
1cdd0 65 20 69 73 20 61 20 76 61 72 61 72 67 73 20 76  e is a varargs v
1cde0 65 72 73 69 6f 6e 20 6f 66 20 73 71 6c 69 74 65  ersion of sqlite
1cdf0 33 5f 73 6e 70 72 69 6e 74 66 28 29 2e 0a 2a 2a  3_snprintf()..**
1ce00 0a 2a 2a 20 54 68 65 73 65 20 72 6f 75 74 69 6e  .** These routin
1ce10 65 73 20 61 6c 6c 20 69 6d 70 6c 65 6d 65 6e 74  es all implement
1ce20 20 73 6f 6d 65 20 61 64 64 69 74 69 6f 6e 61 6c   some additional
1ce30 20 66 6f 72 6d 61 74 74 69 6e 67 0a 2a 2a 20 6f   formatting.** o
1ce40 70 74 69 6f 6e 73 20 74 68 61 74 20 61 72 65 20  ptions that are 
1ce50 75 73 65 66 75 6c 20 66 6f 72 20 63 6f 6e 73 74  useful for const
1ce60 72 75 63 74 69 6e 67 20 53 51 4c 20 73 74 61 74  ructing SQL stat
1ce70 65 6d 65 6e 74 73 2e 0a 2a 2a 20 41 6c 6c 20 6f  ements..** All o
1ce80 66 20 74 68 65 20 75 73 75 61 6c 20 70 72 69 6e  f the usual prin
1ce90 74 66 28 29 20 66 6f 72 6d 61 74 74 69 6e 67 20  tf() formatting 
1cea0 6f 70 74 69 6f 6e 73 20 61 70 70 6c 79 2e 20 20  options apply.  
1ceb0 49 6e 20 61 64 64 69 74 69 6f 6e 2c 20 74 68 65  In addition, the
1cec0 72 65 0a 2a 2a 20 69 73 20 61 72 65 20 22 25 71  re.** is are "%q
1ced0 22 2c 20 22 25 51 22 2c 20 22 25 77 22 20 61 6e  ", "%Q", "%w" an
1cee0 64 20 22 25 7a 22 20 6f 70 74 69 6f 6e 73 2e 0a  d "%z" options..
1cef0 2a 2a 0a 2a 2a 20 5e 28 54 68 65 20 25 71 20 6f  **.** ^(The %q o
1cf00 70 74 69 6f 6e 20 77 6f 72 6b 73 20 6c 69 6b 65  ption works like
1cf10 20 25 73 20 69 6e 20 74 68 61 74 20 69 74 20 73   %s in that it s
1cf20 75 62 73 74 69 74 75 74 65 73 20 61 20 6e 75 6c  ubstitutes a nul
1cf30 2d 74 65 72 6d 69 6e 61 74 65 64 0a 2a 2a 20 73  -terminated.** s
1cf40 74 72 69 6e 67 20 66 72 6f 6d 20 74 68 65 20 61  tring from the a
1cf50 72 67 75 6d 65 6e 74 20 6c 69 73 74 2e 20 20 42  rgument list.  B
1cf60 75 74 20 25 71 20 61 6c 73 6f 20 64 6f 75 62 6c  ut %q also doubl
1cf70 65 73 20 65 76 65 72 79 20 27 5c 27 27 20 63 68  es every '\'' ch
1cf80 61 72 61 63 74 65 72 2e 0a 2a 2a 20 25 71 20 69  aracter..** %q i
1cf90 73 20 64 65 73 69 67 6e 65 64 20 66 6f 72 20 75  s designed for u
1cfa0 73 65 20 69 6e 73 69 64 65 20 61 20 73 74 72 69  se inside a stri
1cfb0 6e 67 20 6c 69 74 65 72 61 6c 2e 29 5e 20 20 42  ng literal.)^  B
1cfc0 79 20 64 6f 75 62 6c 69 6e 67 20 65 61 63 68 20  y doubling each 
1cfd0 27 5c 27 27 0a 2a 2a 20 63 68 61 72 61 63 74 65  '\''.** characte
1cfe0 72 20 69 74 20 65 73 63 61 70 65 73 20 74 68 61  r it escapes tha
1cff0 74 20 63 68 61 72 61 63 74 65 72 20 61 6e 64 20  t character and 
1d000 61 6c 6c 6f 77 73 20 69 74 20 74 6f 20 62 65 20  allows it to be 
1d010 69 6e 73 65 72 74 65 64 20 69 6e 74 6f 0a 2a 2a  inserted into.**
1d020 20 74 68 65 20 73 74 72 69 6e 67 2e 0a 2a 2a 0a   the string..**.
1d030 2a 2a 20 46 6f 72 20 65 78 61 6d 70 6c 65 2c 20  ** For example, 
1d040 61 73 73 75 6d 65 20 74 68 65 20 73 74 72 69 6e  assume the strin
1d050 67 20 76 61 72 69 61 62 6c 65 20 7a 54 65 78 74  g variable zText
1d060 20 63 6f 6e 74 61 69 6e 73 20 74 65 78 74 20 61   contains text a
1d070 73 20 66 6f 6c 6c 6f 77 73 3a 0a 2a 2a 0a 2a 2a  s follows:.**.**
1d080 20 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72   <blockquote><pr
1d090 65 3e 0a 2a 2a 20 20 63 68 61 72 20 2a 7a 54 65  e>.**  char *zTe
1d0a0 78 74 20 3d 20 22 49 74 27 73 20 61 20 68 61 70  xt = "It's a hap
1d0b0 70 79 20 64 61 79 21 22 3b 0a 2a 2a 20 3c 2f 70  py day!";.** </p
1d0c0 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e  re></blockquote>
1d0d0 0a 2a 2a 0a 2a 2a 20 4f 6e 65 20 63 61 6e 20 75  .**.** One can u
1d0e0 73 65 20 74 68 69 73 20 74 65 78 74 20 69 6e 20  se this text in 
1d0f0 61 6e 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  an SQL statement
1d100 20 61 73 20 66 6f 6c 6c 6f 77 73 3a 0a 2a 2a 0a   as follows:.**.
1d110 2a 2a 20 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c  ** <blockquote><
1d120 70 72 65 3e 0a 2a 2a 20 20 63 68 61 72 20 2a 7a  pre>.**  char *z
1d130 53 51 4c 20 3d 20 73 71 6c 69 74 65 33 5f 6d 70  SQL = sqlite3_mp
1d140 72 69 6e 74 66 28 22 49 4e 53 45 52 54 20 49 4e  rintf("INSERT IN
1d150 54 4f 20 74 61 62 6c 65 20 56 41 4c 55 45 53 28  TO table VALUES(
1d160 27 25 71 27 29 22 2c 20 7a 54 65 78 74 29 3b 0a  '%q')", zText);.
1d170 2a 2a 20 20 73 71 6c 69 74 65 33 5f 65 78 65 63  **  sqlite3_exec
1d180 28 64 62 2c 20 7a 53 51 4c 2c 20 30 2c 20 30 2c  (db, zSQL, 0, 0,
1d190 20 30 29 3b 0a 2a 2a 20 20 73 71 6c 69 74 65 33   0);.**  sqlite3
1d1a0 5f 66 72 65 65 28 7a 53 51 4c 29 3b 0a 2a 2a 20  _free(zSQL);.** 
1d1b0 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f  </pre></blockquo
1d1c0 74 65 3e 0a 2a 2a 0a 2a 2a 20 42 65 63 61 75 73  te>.**.** Becaus
1d1d0 65 20 74 68 65 20 25 71 20 66 6f 72 6d 61 74 20  e the %q format 
1d1e0 73 74 72 69 6e 67 20 69 73 20 75 73 65 64 2c 20  string is used, 
1d1f0 74 68 65 20 27 5c 27 27 20 63 68 61 72 61 63 74  the '\'' charact
1d200 65 72 20 69 6e 20 7a 54 65 78 74 0a 2a 2a 20 69  er in zText.** i
1d210 73 20 65 73 63 61 70 65 64 20 61 6e 64 20 74 68  s escaped and th
1d220 65 20 53 51 4c 20 67 65 6e 65 72 61 74 65 64 20  e SQL generated 
1d230 69 73 20 61 73 20 66 6f 6c 6c 6f 77 73 3a 0a 2a  is as follows:.*
1d240 2a 0a 2a 2a 20 3c 62 6c 6f 63 6b 71 75 6f 74 65  *.** <blockquote
1d250 3e 3c 70 72 65 3e 0a 2a 2a 20 20 49 4e 53 45 52  ><pre>.**  INSER
1d260 54 20 49 4e 54 4f 20 74 61 62 6c 65 31 20 56 41  T INTO table1 VA
1d270 4c 55 45 53 28 27 49 74 27 27 73 20 61 20 68 61  LUES('It''s a ha
1d280 70 70 79 20 64 61 79 21 27 29 0a 2a 2a 20 3c 2f  ppy day!').** </
1d290 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65  pre></blockquote
1d2a0 3e 0a 2a 2a 0a 2a 2a 20 54 68 69 73 20 69 73 20  >.**.** This is 
1d2b0 63 6f 72 72 65 63 74 2e 20 20 48 61 64 20 77 65  correct.  Had we
1d2c0 20 75 73 65 64 20 25 73 20 69 6e 73 74 65 61 64   used %s instead
1d2d0 20 6f 66 20 25 71 2c 20 74 68 65 20 67 65 6e 65   of %q, the gene
1d2e0 72 61 74 65 64 20 53 51 4c 0a 2a 2a 20 77 6f 75  rated SQL.** wou
1d2f0 6c 64 20 68 61 76 65 20 6c 6f 6f 6b 65 64 20 6c  ld have looked l
1d300 69 6b 65 20 74 68 69 73 3a 0a 2a 2a 0a 2a 2a 20  ike this:.**.** 
1d310 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65  <blockquote><pre
1d320 3e 0a 2a 2a 20 20 49 4e 53 45 52 54 20 49 4e 54  >.**  INSERT INT
1d330 4f 20 74 61 62 6c 65 31 20 56 41 4c 55 45 53 28  O table1 VALUES(
1d340 27 49 74 27 73 20 61 20 68 61 70 70 79 20 64 61  'It's a happy da
1d350 79 21 27 29 3b 0a 2a 2a 20 3c 2f 70 72 65 3e 3c  y!');.** </pre><
1d360 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 2a 2a 0a  /blockquote>.**.
1d370 2a 2a 20 54 68 69 73 20 73 65 63 6f 6e 64 20 65  ** This second e
1d380 78 61 6d 70 6c 65 20 69 73 20 61 6e 20 53 51 4c  xample is an SQL
1d390 20 73 79 6e 74 61 78 20 65 72 72 6f 72 2e 20 20   syntax error.  
1d3a0 41 73 20 61 20 67 65 6e 65 72 61 6c 20 72 75 6c  As a general rul
1d3b0 65 20 79 6f 75 20 73 68 6f 75 6c 64 0a 2a 2a 20  e you should.** 
1d3c0 61 6c 77 61 79 73 20 75 73 65 20 25 71 20 69 6e  always use %q in
1d3d0 73 74 65 61 64 20 6f 66 20 25 73 20 77 68 65 6e  stead of %s when
1d3e0 20 69 6e 73 65 72 74 69 6e 67 20 74 65 78 74 20   inserting text 
1d3f0 69 6e 74 6f 20 61 20 73 74 72 69 6e 67 20 6c 69  into a string li
1d400 74 65 72 61 6c 2e 0a 2a 2a 0a 2a 2a 20 5e 28 54  teral..**.** ^(T
1d410 68 65 20 25 51 20 6f 70 74 69 6f 6e 20 77 6f 72  he %Q option wor
1d420 6b 73 20 6c 69 6b 65 20 25 71 20 65 78 63 65 70  ks like %q excep
1d430 74 20 69 74 20 61 6c 73 6f 20 61 64 64 73 20 73  t it also adds s
1d440 69 6e 67 6c 65 20 71 75 6f 74 65 73 20 61 72 6f  ingle quotes aro
1d450 75 6e 64 0a 2a 2a 20 74 68 65 20 6f 75 74 73 69  und.** the outsi
1d460 64 65 20 6f 66 20 74 68 65 20 74 6f 74 61 6c 20  de of the total 
1d470 73 74 72 69 6e 67 2e 20 20 41 64 64 69 74 69 6f  string.  Additio
1d480 6e 61 6c 6c 79 2c 20 69 66 20 74 68 65 20 70 61  nally, if the pa
1d490 72 61 6d 65 74 65 72 20 69 6e 20 74 68 65 0a 2a  rameter in the.*
1d4a0 2a 20 61 72 67 75 6d 65 6e 74 20 6c 69 73 74 20  * argument list 
1d4b0 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  is a NULL pointe
1d4c0 72 2c 20 25 51 20 73 75 62 73 74 69 74 75 74 65  r, %Q substitute
1d4d0 73 20 74 68 65 20 74 65 78 74 20 22 4e 55 4c 4c  s the text "NULL
1d4e0 22 20 28 77 69 74 68 6f 75 74 0a 2a 2a 20 73 69  " (without.** si
1d4f0 6e 67 6c 65 20 71 75 6f 74 65 73 29 2e 29 5e 20  ngle quotes).)^ 
1d500 20 53 6f 2c 20 66 6f 72 20 65 78 61 6d 70 6c 65   So, for example
1d510 2c 20 6f 6e 65 20 63 6f 75 6c 64 20 73 61 79 3a  , one could say:
1d520 0a 2a 2a 0a 2a 2a 20 3c 62 6c 6f 63 6b 71 75 6f  .**.** <blockquo
1d530 74 65 3e 3c 70 72 65 3e 0a 2a 2a 20 20 63 68 61  te><pre>.**  cha
1d540 72 20 2a 7a 53 51 4c 20 3d 20 73 71 6c 69 74 65  r *zSQL = sqlite
1d550 33 5f 6d 70 72 69 6e 74 66 28 22 49 4e 53 45 52  3_mprintf("INSER
1d560 54 20 49 4e 54 4f 20 74 61 62 6c 65 20 56 41 4c  T INTO table VAL
1d570 55 45 53 28 25 51 29 22 2c 20 7a 54 65 78 74 29  UES(%Q)", zText)
1d580 3b 0a 2a 2a 20 20 73 71 6c 69 74 65 33 5f 65 78  ;.**  sqlite3_ex
1d590 65 63 28 64 62 2c 20 7a 53 51 4c 2c 20 30 2c 20  ec(db, zSQL, 0, 
1d5a0 30 2c 20 30 29 3b 0a 2a 2a 20 20 73 71 6c 69 74  0, 0);.**  sqlit
1d5b0 65 33 5f 66 72 65 65 28 7a 53 51 4c 29 3b 0a 2a  e3_free(zSQL);.*
1d5c0 2a 20 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71  * </pre></blockq
1d5d0 75 6f 74 65 3e 0a 2a 2a 0a 2a 2a 20 54 68 65 20  uote>.**.** The 
1d5e0 63 6f 64 65 20 61 62 6f 76 65 20 77 69 6c 6c 20  code above will 
1d5f0 72 65 6e 64 65 72 20 61 20 63 6f 72 72 65 63 74  render a correct
1d600 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 20 69   SQL statement i
1d610 6e 20 74 68 65 20 7a 53 51 4c 0a 2a 2a 20 76 61  n the zSQL.** va
1d620 72 69 61 62 6c 65 20 65 76 65 6e 20 69 66 20 74  riable even if t
1d630 68 65 20 7a 54 65 78 74 20 76 61 72 69 61 62 6c  he zText variabl
1d640 65 20 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e  e is a NULL poin
1d650 74 65 72 2e 0a 2a 2a 0a 2a 2a 20 5e 28 54 68 65  ter..**.** ^(The
1d660 20 22 25 77 22 20 66 6f 72 6d 61 74 74 69 6e 67   "%w" formatting
1d670 20 6f 70 74 69 6f 6e 20 69 73 20 6c 69 6b 65 20   option is like 
1d680 22 25 71 22 20 65 78 63 65 70 74 20 74 68 61 74  "%q" except that
1d690 20 69 74 20 65 78 70 65 63 74 73 20 74 6f 0a 2a   it expects to.*
1d6a0 2a 20 62 65 20 63 6f 6e 74 61 69 6e 65 64 20 77  * be contained w
1d6b0 69 74 68 69 6e 20 64 6f 75 62 6c 65 2d 71 75 6f  ithin double-quo
1d6c0 74 65 73 20 69 6e 73 74 65 61 64 20 6f 66 20 73  tes instead of s
1d6d0 69 6e 67 6c 65 20 71 75 6f 74 65 73 2c 20 61 6e  ingle quotes, an
1d6e0 64 20 69 74 0a 2a 2a 20 65 73 63 61 70 65 73 20  d it.** escapes 
1d6f0 74 68 65 20 64 6f 75 62 6c 65 2d 71 75 6f 74 65  the double-quote
1d700 20 63 68 61 72 61 63 74 65 72 20 69 6e 73 74 65   character inste
1d710 61 64 20 6f 66 20 74 68 65 20 73 69 6e 67 6c 65  ad of the single
1d720 2d 71 75 6f 74 65 0a 2a 2a 20 63 68 61 72 61 63  -quote.** charac
1d730 74 65 72 2e 29 5e 20 20 54 68 65 20 22 25 77 22  ter.)^  The "%w"
1d740 20 66 6f 72 6d 61 74 74 69 6e 67 20 6f 70 74 69   formatting opti
1d750 6f 6e 20 69 73 20 69 6e 74 65 6e 64 65 64 20 66  on is intended f
1d760 6f 72 20 73 61 66 65 6c 79 20 69 6e 73 65 72 74  or safely insert
1d770 69 6e 67 0a 2a 2a 20 74 61 62 6c 65 20 61 6e 64  ing.** table and
1d780 20 63 6f 6c 75 6d 6e 20 6e 61 6d 65 73 20 69 6e   column names in
1d790 74 6f 20 61 20 63 6f 6e 73 74 72 75 63 74 65 64  to a constructed
1d7a0 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 2e 0a   SQL statement..
1d7b0 2a 2a 0a 2a 2a 20 5e 28 54 68 65 20 22 25 7a 22  **.** ^(The "%z"
1d7c0 20 66 6f 72 6d 61 74 74 69 6e 67 20 6f 70 74 69   formatting opti
1d7d0 6f 6e 20 77 6f 72 6b 73 20 6c 69 6b 65 20 22 25  on works like "%
1d7e0 73 22 20 62 75 74 20 77 69 74 68 20 74 68 65 0a  s" but with the.
1d7f0 2a 2a 20 61 64 64 69 74 69 6f 6e 20 74 68 61 74  ** addition that
1d800 20 61 66 74 65 72 20 74 68 65 20 73 74 72 69 6e   after the strin
1d810 67 20 68 61 73 20 62 65 65 6e 20 72 65 61 64 20  g has been read 
1d820 61 6e 64 20 63 6f 70 69 65 64 20 69 6e 74 6f 0a  and copied into.
1d830 2a 2a 20 74 68 65 20 72 65 73 75 6c 74 2c 20 5b  ** the result, [
1d840 73 71 6c 69 74 65 33 5f 66 72 65 65 28 29 5d 20  sqlite3_free()] 
1d850 69 73 20 63 61 6c 6c 65 64 20 6f 6e 20 74 68 65  is called on the
1d860 20 69 6e 70 75 74 20 73 74 72 69 6e 67 2e 29 5e   input string.)^
1d870 0a 2a 2f 0a 63 68 61 72 20 2a 73 71 6c 69 74 65  .*/.char *sqlite
1d880 33 5f 6d 70 72 69 6e 74 66 28 63 6f 6e 73 74 20  3_mprintf(const 
1d890 63 68 61 72 2a 2c 2e 2e 2e 29 3b 0a 63 68 61 72  char*,...);.char
1d8a0 20 2a 73 71 6c 69 74 65 33 5f 76 6d 70 72 69 6e   *sqlite3_vmprin
1d8b0 74 66 28 63 6f 6e 73 74 20 63 68 61 72 2a 2c 20  tf(const char*, 
1d8c0 76 61 5f 6c 69 73 74 29 3b 0a 63 68 61 72 20 2a  va_list);.char *
1d8d0 73 71 6c 69 74 65 33 5f 73 6e 70 72 69 6e 74 66  sqlite3_snprintf
1d8e0 28 69 6e 74 2c 63 68 61 72 2a 2c 63 6f 6e 73 74  (int,char*,const
1d8f0 20 63 68 61 72 2a 2c 20 2e 2e 2e 29 3b 0a 63 68   char*, ...);.ch
1d900 61 72 20 2a 73 71 6c 69 74 65 33 5f 76 73 6e 70  ar *sqlite3_vsnp
1d910 72 69 6e 74 66 28 69 6e 74 2c 63 68 61 72 2a 2c  rintf(int,char*,
1d920 63 6f 6e 73 74 20 63 68 61 72 2a 2c 20 76 61 5f  const char*, va_
1d930 6c 69 73 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41  list);../*.** CA
1d940 50 49 33 52 45 46 3a 20 4d 65 6d 6f 72 79 20 41  PI3REF: Memory A
1d950 6c 6c 6f 63 61 74 69 6f 6e 20 53 75 62 73 79 73  llocation Subsys
1d960 74 65 6d 0a 2a 2a 0a 2a 2a 20 54 68 65 20 53 51  tem.**.** The SQ
1d970 4c 69 74 65 20 63 6f 72 65 20 75 73 65 73 20 74  Lite core uses t
1d980 68 65 73 65 20 74 68 72 65 65 20 72 6f 75 74 69  hese three routi
1d990 6e 65 73 20 66 6f 72 20 61 6c 6c 20 6f 66 20 69  nes for all of i
1d9a0 74 73 20 6f 77 6e 0a 2a 2a 20 69 6e 74 65 72 6e  ts own.** intern
1d9b0 61 6c 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61  al memory alloca
1d9c0 74 69 6f 6e 20 6e 65 65 64 73 2e 20 22 43 6f 72  tion needs. "Cor
1d9d0 65 22 20 69 6e 20 74 68 65 20 70 72 65 76 69 6f  e" in the previo
1d9e0 75 73 20 73 65 6e 74 65 6e 63 65 0a 2a 2a 20 64  us sentence.** d
1d9f0 6f 65 73 20 6e 6f 74 20 69 6e 63 6c 75 64 65 20  oes not include 
1da00 6f 70 65 72 61 74 69 6e 67 2d 73 79 73 74 65 6d  operating-system
1da10 20 73 70 65 63 69 66 69 63 20 56 46 53 20 69 6d   specific VFS im
1da20 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 2e 20 20 54  plementation.  T
1da30 68 65 0a 2a 2a 20 57 69 6e 64 6f 77 73 20 56 46  he.** Windows VF
1da40 53 20 75 73 65 73 20 6e 61 74 69 76 65 20 6d 61  S uses native ma
1da50 6c 6c 6f 63 28 29 20 61 6e 64 20 66 72 65 65 28  lloc() and free(
1da60 29 20 66 6f 72 20 73 6f 6d 65 20 6f 70 65 72 61  ) for some opera
1da70 74 69 6f 6e 73 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68  tions..**.** ^Th
1da80 65 20 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63  e sqlite3_malloc
1da90 28 29 20 72 6f 75 74 69 6e 65 20 72 65 74 75 72  () routine retur
1daa0 6e 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20  ns a pointer to 
1dab0 61 20 62 6c 6f 63 6b 0a 2a 2a 20 6f 66 20 6d 65  a block.** of me
1dac0 6d 6f 72 79 20 61 74 20 6c 65 61 73 74 20 4e 20  mory at least N 
1dad0 62 79 74 65 73 20 69 6e 20 6c 65 6e 67 74 68 2c  bytes in length,
1dae0 20 77 68 65 72 65 20 4e 20 69 73 20 74 68 65 20   where N is the 
1daf0 70 61 72 61 6d 65 74 65 72 2e 0a 2a 2a 20 5e 49  parameter..** ^I
1db00 66 20 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63  f sqlite3_malloc
1db10 28 29 20 69 73 20 75 6e 61 62 6c 65 20 74 6f 20  () is unable to 
1db20 6f 62 74 61 69 6e 20 73 75 66 66 69 63 69 65 6e  obtain sufficien
1db30 74 20 66 72 65 65 0a 2a 2a 20 6d 65 6d 6f 72 79  t free.** memory
1db40 2c 20 69 74 20 72 65 74 75 72 6e 73 20 61 20 4e  , it returns a N
1db50 55 4c 4c 20 70 6f 69 6e 74 65 72 2e 20 20 5e 49  ULL pointer.  ^I
1db60 66 20 74 68 65 20 70 61 72 61 6d 65 74 65 72 20  f the parameter 
1db70 4e 20 74 6f 0a 2a 2a 20 73 71 6c 69 74 65 33 5f  N to.** sqlite3_
1db80 6d 61 6c 6c 6f 63 28 29 20 69 73 20 7a 65 72 6f  malloc() is zero
1db90 20 6f 72 20 6e 65 67 61 74 69 76 65 20 74 68 65   or negative the
1dba0 6e 20 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63  n sqlite3_malloc
1dbb0 28 29 20 72 65 74 75 72 6e 73 0a 2a 2a 20 61 20  () returns.** a 
1dbc0 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 2e 0a 2a 2a  NULL pointer..**
1dbd0 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33  .** ^The sqlite3
1dbe0 5f 6d 61 6c 6c 6f 63 36 34 28 4e 29 20 72 6f 75  _malloc64(N) rou
1dbf0 74 69 6e 65 20 77 6f 72 6b 73 20 6a 75 73 74 20  tine works just 
1dc00 6c 69 6b 65 0a 2a 2a 20 73 71 6c 69 74 65 33 5f  like.** sqlite3_
1dc10 6d 61 6c 6c 6f 63 28 4e 29 20 65 78 63 65 70 74  malloc(N) except
1dc20 20 74 68 61 74 20 4e 20 69 73 20 61 6e 20 75 6e   that N is an un
1dc30 73 69 67 6e 65 64 20 36 34 2d 62 69 74 20 69 6e  signed 64-bit in
1dc40 74 65 67 65 72 20 69 6e 73 74 65 61 64 0a 2a 2a  teger instead.**
1dc50 20 6f 66 20 61 20 73 69 67 6e 65 64 20 33 32 2d   of a signed 32-
1dc60 62 69 74 20 69 6e 74 65 67 65 72 2e 0a 2a 2a 0a  bit integer..**.
1dc70 2a 2a 20 5e 43 61 6c 6c 69 6e 67 20 73 71 6c 69  ** ^Calling sqli
1dc80 74 65 33 5f 66 72 65 65 28 29 20 77 69 74 68 20  te3_free() with 
1dc90 61 20 70 6f 69 6e 74 65 72 20 70 72 65 76 69 6f  a pointer previo
1dca0 75 73 6c 79 20 72 65 74 75 72 6e 65 64 0a 2a 2a  usly returned.**
1dcb0 20 62 79 20 73 71 6c 69 74 65 33 5f 6d 61 6c 6c   by sqlite3_mall
1dcc0 6f 63 28 29 20 6f 72 20 73 71 6c 69 74 65 33 5f  oc() or sqlite3_
1dcd0 72 65 61 6c 6c 6f 63 28 29 20 72 65 6c 65 61 73  realloc() releas
1dce0 65 73 20 74 68 61 74 20 6d 65 6d 6f 72 79 20 73  es that memory s
1dcf0 6f 0a 2a 2a 20 74 68 61 74 20 69 74 20 6d 69 67  o.** that it mig
1dd00 68 74 20 62 65 20 72 65 75 73 65 64 2e 20 20 5e  ht be reused.  ^
1dd10 54 68 65 20 73 71 6c 69 74 65 33 5f 66 72 65 65  The sqlite3_free
1dd20 28 29 20 72 6f 75 74 69 6e 65 20 69 73 0a 2a 2a  () routine is.**
1dd30 20 61 20 6e 6f 2d 6f 70 20 69 66 20 69 73 20 63   a no-op if is c
1dd40 61 6c 6c 65 64 20 77 69 74 68 20 61 20 4e 55 4c  alled with a NUL
1dd50 4c 20 70 6f 69 6e 74 65 72 2e 20 20 50 61 73 73  L pointer.  Pass
1dd60 69 6e 67 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74  ing a NULL point
1dd70 65 72 0a 2a 2a 20 74 6f 20 73 71 6c 69 74 65 33  er.** to sqlite3
1dd80 5f 66 72 65 65 28 29 20 69 73 20 68 61 72 6d 6c  _free() is harml
1dd90 65 73 73 2e 20 20 41 66 74 65 72 20 62 65 69 6e  ess.  After bein
1dda0 67 20 66 72 65 65 64 2c 20 6d 65 6d 6f 72 79 0a  g freed, memory.
1ddb0 2a 2a 20 73 68 6f 75 6c 64 20 6e 65 69 74 68 65  ** should neithe
1ddc0 72 20 62 65 20 72 65 61 64 20 6e 6f 72 20 77 72  r be read nor wr
1ddd0 69 74 74 65 6e 2e 20 20 45 76 65 6e 20 72 65 61  itten.  Even rea
1dde0 64 69 6e 67 20 70 72 65 76 69 6f 75 73 6c 79 20  ding previously 
1ddf0 66 72 65 65 64 0a 2a 2a 20 6d 65 6d 6f 72 79 20  freed.** memory 
1de00 6d 69 67 68 74 20 72 65 73 75 6c 74 20 69 6e 20  might result in 
1de10 61 20 73 65 67 6d 65 6e 74 61 74 69 6f 6e 20 66  a segmentation f
1de20 61 75 6c 74 20 6f 72 20 6f 74 68 65 72 20 73 65  ault or other se
1de30 76 65 72 65 20 65 72 72 6f 72 2e 0a 2a 2a 20 4d  vere error..** M
1de40 65 6d 6f 72 79 20 63 6f 72 72 75 70 74 69 6f 6e  emory corruption
1de50 2c 20 61 20 73 65 67 6d 65 6e 74 61 74 69 6f 6e  , a segmentation
1de60 20 66 61 75 6c 74 2c 20 6f 72 20 6f 74 68 65 72   fault, or other
1de70 20 73 65 76 65 72 65 20 65 72 72 6f 72 0a 2a 2a   severe error.**
1de80 20 6d 69 67 68 74 20 72 65 73 75 6c 74 20 69 66   might result if
1de90 20 73 71 6c 69 74 65 33 5f 66 72 65 65 28 29 20   sqlite3_free() 
1dea0 69 73 20 63 61 6c 6c 65 64 20 77 69 74 68 20 61  is called with a
1deb0 20 6e 6f 6e 2d 4e 55 4c 4c 20 70 6f 69 6e 74 65   non-NULL pointe
1dec0 72 20 74 68 61 74 0a 2a 2a 20 77 61 73 20 6e 6f  r that.** was no
1ded0 74 20 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d 20  t obtained from 
1dee0 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29  sqlite3_malloc()
1def0 20 6f 72 20 73 71 6c 69 74 65 33 5f 72 65 61 6c   or sqlite3_real
1df00 6c 6f 63 28 29 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68  loc()..**.** ^Th
1df10 65 20 73 71 6c 69 74 65 33 5f 72 65 61 6c 6c 6f  e sqlite3_reallo
1df20 63 28 58 2c 4e 29 20 69 6e 74 65 72 66 61 63 65  c(X,N) interface
1df30 20 61 74 74 65 6d 70 74 73 20 74 6f 20 72 65 73   attempts to res
1df40 69 7a 65 20 61 0a 2a 2a 20 70 72 69 6f 72 20 6d  ize a.** prior m
1df50 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e  emory allocation
1df60 20 58 20 74 6f 20 62 65 20 61 74 20 6c 65 61 73   X to be at leas
1df70 74 20 4e 20 62 79 74 65 73 2e 0a 2a 2a 20 5e 49  t N bytes..** ^I
1df80 66 20 74 68 65 20 58 20 70 61 72 61 6d 65 74 65  f the X paramete
1df90 72 20 74 6f 20 73 71 6c 69 74 65 33 5f 72 65 61  r to sqlite3_rea
1dfa0 6c 6c 6f 63 28 58 2c 4e 29 0a 2a 2a 20 69 73 20  lloc(X,N).** is 
1dfb0 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 20 74  a NULL pointer t
1dfc0 68 65 6e 20 69 74 73 20 62 65 68 61 76 69 6f 72  hen its behavior
1dfd0 20 69 73 20 69 64 65 6e 74 69 63 61 6c 20 74 6f   is identical to
1dfe0 20 63 61 6c 6c 69 6e 67 0a 2a 2a 20 73 71 6c 69   calling.** sqli
1dff0 74 65 33 5f 6d 61 6c 6c 6f 63 28 4e 29 2e 0a 2a  te3_malloc(N)..*
1e000 2a 20 5e 49 66 20 74 68 65 20 4e 20 70 61 72 61  * ^If the N para
1e010 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33  meter to sqlite3
1e020 5f 72 65 61 6c 6c 6f 63 28 58 2c 4e 29 20 69 73  _realloc(X,N) is
1e030 20 7a 65 72 6f 20 6f 72 0a 2a 2a 20 6e 65 67 61   zero or.** nega
1e040 74 69 76 65 20 74 68 65 6e 20 74 68 65 20 62 65  tive then the be
1e050 68 61 76 69 6f 72 20 69 73 20 65 78 61 63 74 6c  havior is exactl
1e060 79 20 74 68 65 20 73 61 6d 65 20 61 73 20 63 61  y the same as ca
1e070 6c 6c 69 6e 67 0a 2a 2a 20 73 71 6c 69 74 65 33  lling.** sqlite3
1e080 5f 66 72 65 65 28 58 29 2e 0a 2a 2a 20 5e 73 71  _free(X)..** ^sq
1e090 6c 69 74 65 33 5f 72 65 61 6c 6c 6f 63 28 58 2c  lite3_realloc(X,
1e0a0 4e 29 20 72 65 74 75 72 6e 73 20 61 20 70 6f 69  N) returns a poi
1e0b0 6e 74 65 72 20 74 6f 20 61 20 6d 65 6d 6f 72 79  nter to a memory
1e0c0 20 61 6c 6c 6f 63 61 74 69 6f 6e 0a 2a 2a 20 6f   allocation.** o
1e0d0 66 20 61 74 20 6c 65 61 73 74 20 4e 20 62 79 74  f at least N byt
1e0e0 65 73 20 69 6e 20 73 69 7a 65 20 6f 72 20 4e 55  es in size or NU
1e0f0 4c 4c 20 69 66 20 69 6e 73 75 66 66 69 63 69 65  LL if insufficie
1e100 6e 74 20 6d 65 6d 6f 72 79 20 69 73 20 61 76 61  nt memory is ava
1e110 69 6c 61 62 6c 65 2e 0a 2a 2a 20 5e 49 66 20 4d  ilable..** ^If M
1e120 20 69 73 20 74 68 65 20 73 69 7a 65 20 6f 66 20   is the size of 
1e130 74 68 65 20 70 72 69 6f 72 20 61 6c 6c 6f 63 61  the prior alloca
1e140 74 69 6f 6e 2c 20 74 68 65 6e 20 6d 69 6e 28 4e  tion, then min(N
1e150 2c 4d 29 20 62 79 74 65 73 0a 2a 2a 20 6f 66 20  ,M) bytes.** of 
1e160 74 68 65 20 70 72 69 6f 72 20 61 6c 6c 6f 63 61  the prior alloca
1e170 74 69 6f 6e 20 61 72 65 20 63 6f 70 69 65 64 20  tion are copied 
1e180 69 6e 74 6f 20 74 68 65 20 62 65 67 69 6e 6e 69  into the beginni
1e190 6e 67 20 6f 66 20 62 75 66 66 65 72 20 72 65 74  ng of buffer ret
1e1a0 75 72 6e 65 64 0a 2a 2a 20 62 79 20 73 71 6c 69  urned.** by sqli
1e1b0 74 65 33 5f 72 65 61 6c 6c 6f 63 28 58 2c 4e 29  te3_realloc(X,N)
1e1c0 20 61 6e 64 20 74 68 65 20 70 72 69 6f 72 20 61   and the prior a
1e1d0 6c 6c 6f 63 61 74 69 6f 6e 20 69 73 20 66 72 65  llocation is fre
1e1e0 65 64 2e 0a 2a 2a 20 5e 49 66 20 73 71 6c 69 74  ed..** ^If sqlit
1e1f0 65 33 5f 72 65 61 6c 6c 6f 63 28 58 2c 4e 29 20  e3_realloc(X,N) 
1e200 72 65 74 75 72 6e 73 20 4e 55 4c 4c 20 61 6e 64  returns NULL and
1e210 20 4e 20 69 73 20 70 6f 73 69 74 69 76 65 2c 20   N is positive, 
1e220 74 68 65 6e 20 74 68 65 0a 2a 2a 20 70 72 69 6f  then the.** prio
1e230 72 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 69 73 20  r allocation is 
1e240 6e 6f 74 20 66 72 65 65 64 2e 0a 2a 2a 0a 2a 2a  not freed..**.**
1e250 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 72 65   ^The sqlite3_re
1e260 61 6c 6c 6f 63 36 34 28 58 2c 4e 29 20 69 6e 74  alloc64(X,N) int
1e270 65 72 66 61 63 65 73 20 77 6f 72 6b 73 20 74 68  erfaces works th
1e280 65 20 73 61 6d 65 20 61 73 0a 2a 2a 20 73 71 6c  e same as.** sql
1e290 69 74 65 33 5f 72 65 61 6c 6c 6f 63 28 58 2c 4e  ite3_realloc(X,N
1e2a0 29 20 65 78 63 65 70 74 20 74 68 61 74 20 4e 20  ) except that N 
1e2b0 69 73 20 61 20 36 34 2d 62 69 74 20 75 6e 73 69  is a 64-bit unsi
1e2c0 67 6e 65 64 20 69 6e 74 65 67 65 72 20 69 6e 73  gned integer ins
1e2d0 74 65 61 64 0a 2a 2a 20 6f 66 20 61 20 33 32 2d  tead.** of a 32-
1e2e0 62 69 74 20 73 69 67 6e 65 64 20 69 6e 74 65 67  bit signed integ
1e2f0 65 72 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 58 20  er..**.** ^If X 
1e300 69 73 20 61 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f  is a memory allo
1e310 63 61 74 69 6f 6e 20 70 72 65 76 69 6f 75 73 6c  cation previousl
1e320 79 20 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d 20  y obtained from 
1e330 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29  sqlite3_malloc()
1e340 2c 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 6d 61 6c  ,.** sqlite3_mal
1e350 6c 6f 63 36 34 28 29 2c 20 73 71 6c 69 74 65 33  loc64(), sqlite3
1e360 5f 72 65 61 6c 6c 6f 63 28 29 2c 20 6f 72 20 73  _realloc(), or s
1e370 71 6c 69 74 65 33 5f 72 65 61 6c 6c 6f 63 36 34  qlite3_realloc64
1e380 28 29 2c 20 74 68 65 6e 0a 2a 2a 20 73 71 6c 69  (), then.** sqli
1e390 74 65 33 5f 6d 73 69 7a 65 28 58 29 20 72 65 74  te3_msize(X) ret
1e3a0 75 72 6e 73 20 74 68 65 20 73 69 7a 65 20 6f 66  urns the size of
1e3b0 20 74 68 61 74 20 6d 65 6d 6f 72 79 20 61 6c 6c   that memory all
1e3c0 6f 63 61 74 69 6f 6e 20 69 6e 20 62 79 74 65 73  ocation in bytes
1e3d0 2e 0a 2a 2a 20 5e 54 68 65 20 76 61 6c 75 65 20  ..** ^The value 
1e3e0 72 65 74 75 72 6e 65 64 20 62 79 20 73 71 6c 69  returned by sqli
1e3f0 74 65 33 5f 6d 73 69 7a 65 28 58 29 20 6d 69 67  te3_msize(X) mig
1e400 68 74 20 62 65 20 6c 61 72 67 65 72 20 74 68 61  ht be larger tha
1e410 6e 20 74 68 65 20 6e 75 6d 62 65 72 0a 2a 2a 20  n the number.** 
1e420 6f 66 20 62 79 74 65 73 20 72 65 71 75 65 73 74  of bytes request
1e430 65 64 20 77 68 65 6e 20 58 20 77 61 73 20 61 6c  ed when X was al
1e440 6c 6f 63 61 74 65 64 2e 20 20 5e 49 66 20 58 20  located.  ^If X 
1e450 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  is a NULL pointe
1e460 72 20 74 68 65 6e 0a 2a 2a 20 73 71 6c 69 74 65  r then.** sqlite
1e470 33 5f 6d 73 69 7a 65 28 58 29 20 72 65 74 75 72  3_msize(X) retur
1e480 6e 73 20 7a 65 72 6f 2e 20 20 49 66 20 58 20 70  ns zero.  If X p
1e490 6f 69 6e 74 73 20 74 6f 20 73 6f 6d 65 74 68 69  oints to somethi
1e4a0 6e 67 20 74 68 61 74 20 69 73 20 6e 6f 74 0a 2a  ng that is not.*
1e4b0 2a 20 74 68 65 20 62 65 67 69 6e 6e 69 6e 67 20  * the beginning 
1e4c0 6f 66 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61  of memory alloca
1e4d0 74 69 6f 6e 2c 20 6f 72 20 69 66 20 69 74 20 70  tion, or if it p
1e4e0 6f 69 6e 74 73 20 74 6f 20 61 20 66 6f 72 6d 65  oints to a forme
1e4f0 72 6c 79 0a 2a 2a 20 76 61 6c 69 64 20 6d 65 6d  rly.** valid mem
1e500 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 74  ory allocation t
1e510 68 61 74 20 68 61 73 20 6e 6f 77 20 62 65 65 6e  hat has now been
1e520 20 66 72 65 65 64 2c 20 74 68 65 6e 20 74 68 65   freed, then the
1e530 20 62 65 68 61 76 69 6f 72 0a 2a 2a 20 6f 66 20   behavior.** of 
1e540 73 71 6c 69 74 65 33 5f 6d 73 69 7a 65 28 58 29  sqlite3_msize(X)
1e550 20 69 73 20 75 6e 64 65 66 69 6e 65 64 20 61 6e   is undefined an
1e560 64 20 70 6f 73 73 69 62 6c 79 20 68 61 72 6d 66  d possibly harmf
1e570 75 6c 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 6d  ul..**.** ^The m
1e580 65 6d 6f 72 79 20 72 65 74 75 72 6e 65 64 20 62  emory returned b
1e590 79 20 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63  y sqlite3_malloc
1e5a0 28 29 2c 20 73 71 6c 69 74 65 33 5f 72 65 61 6c  (), sqlite3_real
1e5b0 6c 6f 63 28 29 2c 0a 2a 2a 20 73 71 6c 69 74 65  loc(),.** sqlite
1e5c0 33 5f 6d 61 6c 6c 6f 63 36 34 28 29 2c 20 61 6e  3_malloc64(), an
1e5d0 64 20 73 71 6c 69 74 65 33 5f 72 65 61 6c 6c 6f  d sqlite3_reallo
1e5e0 63 36 34 28 29 0a 2a 2a 20 69 73 20 61 6c 77 61  c64().** is alwa
1e5f0 79 73 20 61 6c 69 67 6e 65 64 20 74 6f 20 61 74  ys aligned to at
1e600 20 6c 65 61 73 74 20 61 6e 20 38 20 62 79 74 65   least an 8 byte
1e610 20 62 6f 75 6e 64 61 72 79 2c 20 6f 72 20 74 6f   boundary, or to
1e620 20 61 0a 2a 2a 20 34 20 62 79 74 65 20 62 6f 75   a.** 4 byte bou
1e630 6e 64 61 72 79 20 69 66 20 74 68 65 20 5b 53 51  ndary if the [SQ
1e640 4c 49 54 45 5f 34 5f 42 59 54 45 5f 41 4c 49 47  LITE_4_BYTE_ALIG
1e650 4e 45 44 5f 4d 41 4c 4c 4f 43 5d 20 63 6f 6d 70  NED_MALLOC] comp
1e660 69 6c 65 2d 74 69 6d 65 0a 2a 2a 20 6f 70 74 69  ile-time.** opti
1e670 6f 6e 20 69 73 20 75 73 65 64 2e 0a 2a 2a 0a 2a  on is used..**.*
1e680 2a 20 49 6e 20 53 51 4c 69 74 65 20 76 65 72 73  * In SQLite vers
1e690 69 6f 6e 20 33 2e 35 2e 30 20 61 6e 64 20 33 2e  ion 3.5.0 and 3.
1e6a0 35 2e 31 2c 20 69 74 20 77 61 73 20 70 6f 73 73  5.1, it was poss
1e6b0 69 62 6c 65 20 74 6f 20 64 65 66 69 6e 65 0a 2a  ible to define.*
1e6c0 2a 20 74 68 65 20 53 51 4c 49 54 45 5f 4f 4d 49  * the SQLITE_OMI
1e6d0 54 5f 4d 45 4d 4f 52 59 5f 41 4c 4c 4f 43 41 54  T_MEMORY_ALLOCAT
1e6e0 49 4f 4e 20 77 68 69 63 68 20 77 6f 75 6c 64 20  ION which would 
1e6f0 63 61 75 73 65 20 74 68 65 20 62 75 69 6c 74 2d  cause the built-
1e700 69 6e 0a 2a 2a 20 69 6d 70 6c 65 6d 65 6e 74 61  in.** implementa
1e710 74 69 6f 6e 20 6f 66 20 74 68 65 73 65 20 72 6f  tion of these ro
1e720 75 74 69 6e 65 73 20 74 6f 20 62 65 20 6f 6d 69  utines to be omi
1e730 74 74 65 64 2e 20 20 54 68 61 74 20 63 61 70 61  tted.  That capa
1e740 62 69 6c 69 74 79 0a 2a 2a 20 69 73 20 6e 6f 20  bility.** is no 
1e750 6c 6f 6e 67 65 72 20 70 72 6f 76 69 64 65 64 2e  longer provided.
1e760 20 20 4f 6e 6c 79 20 62 75 69 6c 74 2d 69 6e 20    Only built-in 
1e770 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72  memory allocator
1e780 73 20 63 61 6e 20 62 65 20 75 73 65 64 2e 0a 2a  s can be used..*
1e790 2a 0a 2a 2a 20 50 72 69 6f 72 20 74 6f 20 53 51  *.** Prior to SQ
1e7a0 4c 69 74 65 20 76 65 72 73 69 6f 6e 20 33 2e 37  Lite version 3.7
1e7b0 2e 31 30 2c 20 74 68 65 20 57 69 6e 64 6f 77 73  .10, the Windows
1e7c0 20 4f 53 20 69 6e 74 65 72 66 61 63 65 20 6c 61   OS interface la
1e7d0 79 65 72 20 63 61 6c 6c 65 64 0a 2a 2a 20 74 68  yer called.** th
1e7e0 65 20 73 79 73 74 65 6d 20 6d 61 6c 6c 6f 63 28  e system malloc(
1e7f0 29 20 61 6e 64 20 66 72 65 65 28 29 20 64 69 72  ) and free() dir
1e800 65 63 74 6c 79 20 77 68 65 6e 20 63 6f 6e 76 65  ectly when conve
1e810 72 74 69 6e 67 0a 2a 2a 20 66 69 6c 65 6e 61 6d  rting.** filenam
1e820 65 73 20 62 65 74 77 65 65 6e 20 74 68 65 20 55  es between the U
1e830 54 46 2d 38 20 65 6e 63 6f 64 69 6e 67 20 75 73  TF-8 encoding us
1e840 65 64 20 62 79 20 53 51 4c 69 74 65 0a 2a 2a 20  ed by SQLite.** 
1e850 61 6e 64 20 77 68 61 74 65 76 65 72 20 66 69 6c  and whatever fil
1e860 65 6e 61 6d 65 20 65 6e 63 6f 64 69 6e 67 20 69  ename encoding i
1e870 73 20 75 73 65 64 20 62 79 20 74 68 65 20 70 61  s used by the pa
1e880 72 74 69 63 75 6c 61 72 20 57 69 6e 64 6f 77 73  rticular Windows
1e890 0a 2a 2a 20 69 6e 73 74 61 6c 6c 61 74 69 6f 6e  .** installation
1e8a0 2e 20 20 4d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61  .  Memory alloca
1e8b0 74 69 6f 6e 20 65 72 72 6f 72 73 20 77 65 72 65  tion errors were
1e8c0 20 64 65 74 65 63 74 65 64 2c 20 62 75 74 0a 2a   detected, but.*
1e8d0 2a 20 74 68 65 79 20 77 65 72 65 20 72 65 70 6f  * they were repo
1e8e0 72 74 65 64 20 62 61 63 6b 20 61 73 20 5b 53 51  rted back as [SQ
1e8f0 4c 49 54 45 5f 43 41 4e 54 4f 50 45 4e 5d 20 6f  LITE_CANTOPEN] o
1e900 72 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 49 4f 45  r.** [SQLITE_IOE
1e910 52 52 5d 20 72 61 74 68 65 72 20 74 68 61 6e 20  RR] rather than 
1e920 5b 53 51 4c 49 54 45 5f 4e 4f 4d 45 4d 5d 2e 0a  [SQLITE_NOMEM]..
1e930 2a 2a 0a 2a 2a 20 54 68 65 20 70 6f 69 6e 74 65  **.** The pointe
1e940 72 20 61 72 67 75 6d 65 6e 74 73 20 74 6f 20 5b  r arguments to [
1e950 73 71 6c 69 74 65 33 5f 66 72 65 65 28 29 5d 20  sqlite3_free()] 
1e960 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 72 65 61  and [sqlite3_rea
1e970 6c 6c 6f 63 28 29 5d 0a 2a 2a 20 6d 75 73 74 20  lloc()].** must 
1e980 62 65 20 65 69 74 68 65 72 20 4e 55 4c 4c 20 6f  be either NULL o
1e990 72 20 65 6c 73 65 20 70 6f 69 6e 74 65 72 73 20  r else pointers 
1e9a0 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d 20 61 20  obtained from a 
1e9b0 70 72 69 6f 72 0a 2a 2a 20 69 6e 76 6f 63 61 74  prior.** invocat
1e9c0 69 6f 6e 20 6f 66 20 5b 73 71 6c 69 74 65 33 5f  ion of [sqlite3_
1e9d0 6d 61 6c 6c 6f 63 28 29 5d 20 6f 72 20 5b 73 71  malloc()] or [sq
1e9e0 6c 69 74 65 33 5f 72 65 61 6c 6c 6f 63 28 29 5d  lite3_realloc()]
1e9f0 20 74 68 61 74 20 68 61 76 65 0a 2a 2a 20 6e 6f   that have.** no
1ea00 74 20 79 65 74 20 62 65 65 6e 20 72 65 6c 65 61  t yet been relea
1ea10 73 65 64 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 61  sed..**.** The a
1ea20 70 70 6c 69 63 61 74 69 6f 6e 20 6d 75 73 74 20  pplication must 
1ea30 6e 6f 74 20 72 65 61 64 20 6f 72 20 77 72 69 74  not read or writ
1ea40 65 20 61 6e 79 20 70 61 72 74 20 6f 66 0a 2a 2a  e any part of.**
1ea50 20 61 20 62 6c 6f 63 6b 20 6f 66 20 6d 65 6d 6f   a block of memo
1ea60 72 79 20 61 66 74 65 72 20 69 74 20 68 61 73 20  ry after it has 
1ea70 62 65 65 6e 20 72 65 6c 65 61 73 65 64 20 75 73  been released us
1ea80 69 6e 67 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f  ing.** [sqlite3_
1ea90 66 72 65 65 28 29 5d 20 6f 72 20 5b 73 71 6c 69  free()] or [sqli
1eaa0 74 65 33 5f 72 65 61 6c 6c 6f 63 28 29 5d 2e 0a  te3_realloc()]..
1eab0 2a 2f 0a 76 6f 69 64 20 2a 73 71 6c 69 74 65 33  */.void *sqlite3
1eac0 5f 6d 61 6c 6c 6f 63 28 69 6e 74 29 3b 0a 76 6f  _malloc(int);.vo
1ead0 69 64 20 2a 73 71 6c 69 74 65 33 5f 6d 61 6c 6c  id *sqlite3_mall
1eae0 6f 63 36 34 28 73 71 6c 69 74 65 33 5f 75 69 6e  oc64(sqlite3_uin
1eaf0 74 36 34 29 3b 0a 76 6f 69 64 20 2a 73 71 6c 69  t64);.void *sqli
1eb00 74 65 33 5f 72 65 61 6c 6c 6f 63 28 76 6f 69 64  te3_realloc(void
1eb10 2a 2c 20 69 6e 74 29 3b 0a 76 6f 69 64 20 2a 73  *, int);.void *s
1eb20 71 6c 69 74 65 33 5f 72 65 61 6c 6c 6f 63 36 34  qlite3_realloc64
1eb30 28 76 6f 69 64 2a 2c 20 73 71 6c 69 74 65 33 5f  (void*, sqlite3_
1eb40 75 69 6e 74 36 34 29 3b 0a 76 6f 69 64 20 73 71  uint64);.void sq
1eb50 6c 69 74 65 33 5f 66 72 65 65 28 76 6f 69 64 2a  lite3_free(void*
1eb60 29 3b 0a 73 71 6c 69 74 65 33 5f 75 69 6e 74 36  );.sqlite3_uint6
1eb70 34 20 73 71 6c 69 74 65 33 5f 6d 73 69 7a 65 28  4 sqlite3_msize(
1eb80 76 6f 69 64 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43  void*);../*.** C
1eb90 41 50 49 33 52 45 46 3a 20 4d 65 6d 6f 72 79 20  API3REF: Memory 
1eba0 41 6c 6c 6f 63 61 74 6f 72 20 53 74 61 74 69 73  Allocator Statis
1ebb0 74 69 63 73 0a 2a 2a 0a 2a 2a 20 53 51 4c 69 74  tics.**.** SQLit
1ebc0 65 20 70 72 6f 76 69 64 65 73 20 74 68 65 73 65  e provides these
1ebd0 20 74 77 6f 20 69 6e 74 65 72 66 61 63 65 73 20   two interfaces 
1ebe0 66 6f 72 20 72 65 70 6f 72 74 69 6e 67 20 6f 6e  for reporting on
1ebf0 20 74 68 65 20 73 74 61 74 75 73 0a 2a 2a 20 6f   the status.** o
1ec00 66 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 6d  f the [sqlite3_m
1ec10 61 6c 6c 6f 63 28 29 5d 2c 20 5b 73 71 6c 69 74  alloc()], [sqlit
1ec20 65 33 5f 66 72 65 65 28 29 5d 2c 20 61 6e 64 20  e3_free()], and 
1ec30 5b 73 71 6c 69 74 65 33 5f 72 65 61 6c 6c 6f 63  [sqlite3_realloc
1ec40 28 29 5d 0a 2a 2a 20 72 6f 75 74 69 6e 65 73 2c  ()].** routines,
1ec50 20 77 68 69 63 68 20 66 6f 72 6d 20 74 68 65 20   which form the 
1ec60 62 75 69 6c 74 2d 69 6e 20 6d 65 6d 6f 72 79 20  built-in memory 
1ec70 61 6c 6c 6f 63 61 74 69 6f 6e 20 73 75 62 73 79  allocation subsy
1ec80 73 74 65 6d 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65  stem..**.** ^The
1ec90 20 5b 73 71 6c 69 74 65 33 5f 6d 65 6d 6f 72 79   [sqlite3_memory
1eca0 5f 75 73 65 64 28 29 5d 20 72 6f 75 74 69 6e 65  _used()] routine
1ecb0 20 72 65 74 75 72 6e 73 20 74 68 65 20 6e 75 6d   returns the num
1ecc0 62 65 72 20 6f 66 20 62 79 74 65 73 0a 2a 2a 20  ber of bytes.** 
1ecd0 6f 66 20 6d 65 6d 6f 72 79 20 63 75 72 72 65 6e  of memory curren
1ece0 74 6c 79 20 6f 75 74 73 74 61 6e 64 69 6e 67 20  tly outstanding 
1ecf0 28 6d 61 6c 6c 6f 63 65 64 20 62 75 74 20 6e 6f  (malloced but no
1ed00 74 20 66 72 65 65 64 29 2e 0a 2a 2a 20 5e 54 68  t freed)..** ^Th
1ed10 65 20 5b 73 71 6c 69 74 65 33 5f 6d 65 6d 6f 72  e [sqlite3_memor
1ed20 79 5f 68 69 67 68 77 61 74 65 72 28 29 5d 20 72  y_highwater()] r
1ed30 6f 75 74 69 6e 65 20 72 65 74 75 72 6e 73 20 74  outine returns t
1ed40 68 65 20 6d 61 78 69 6d 75 6d 0a 2a 2a 20 76 61  he maximum.** va
1ed50 6c 75 65 20 6f 66 20 5b 73 71 6c 69 74 65 33 5f  lue of [sqlite3_
1ed60 6d 65 6d 6f 72 79 5f 75 73 65 64 28 29 5d 20 73  memory_used()] s
1ed70 69 6e 63 65 20 74 68 65 20 68 69 67 68 2d 77 61  ince the high-wa
1ed80 74 65 72 20 6d 61 72 6b 0a 2a 2a 20 77 61 73 20  ter mark.** was 
1ed90 6c 61 73 74 20 72 65 73 65 74 2e 20 20 5e 54 68  last reset.  ^Th
1eda0 65 20 76 61 6c 75 65 73 20 72 65 74 75 72 6e 65  e values returne
1edb0 64 20 62 79 20 5b 73 71 6c 69 74 65 33 5f 6d 65  d by [sqlite3_me
1edc0 6d 6f 72 79 5f 75 73 65 64 28 29 5d 20 61 6e 64  mory_used()] and
1edd0 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 6d 65 6d  .** [sqlite3_mem
1ede0 6f 72 79 5f 68 69 67 68 77 61 74 65 72 28 29 5d  ory_highwater()]
1edf0 20 69 6e 63 6c 75 64 65 20 61 6e 79 20 6f 76 65   include any ove
1ee00 72 68 65 61 64 0a 2a 2a 20 61 64 64 65 64 20 62  rhead.** added b
1ee10 79 20 53 51 4c 69 74 65 20 69 6e 20 69 74 73 20  y SQLite in its 
1ee20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 6f  implementation o
1ee30 66 20 5b 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f  f [sqlite3_mallo
1ee40 63 28 29 5d 2c 0a 2a 2a 20 62 75 74 20 6e 6f 74  c()],.** but not
1ee50 20 6f 76 65 72 68 65 61 64 20 61 64 64 65 64 20   overhead added 
1ee60 62 79 20 74 68 65 20 61 6e 79 20 75 6e 64 65 72  by the any under
1ee70 6c 79 69 6e 67 20 73 79 73 74 65 6d 20 6c 69 62  lying system lib
1ee80 72 61 72 79 0a 2a 2a 20 72 6f 75 74 69 6e 65 73  rary.** routines
1ee90 20 74 68 61 74 20 5b 73 71 6c 69 74 65 33 5f 6d   that [sqlite3_m
1eea0 61 6c 6c 6f 63 28 29 5d 20 6d 61 79 20 63 61 6c  alloc()] may cal
1eeb0 6c 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 6d 65  l..**.** ^The me
1eec0 6d 6f 72 79 20 68 69 67 68 2d 77 61 74 65 72 20  mory high-water 
1eed0 6d 61 72 6b 20 69 73 20 72 65 73 65 74 20 74 6f  mark is reset to
1eee0 20 74 68 65 20 63 75 72 72 65 6e 74 20 76 61 6c   the current val
1eef0 75 65 20 6f 66 0a 2a 2a 20 5b 73 71 6c 69 74 65  ue of.** [sqlite
1ef00 33 5f 6d 65 6d 6f 72 79 5f 75 73 65 64 28 29 5d  3_memory_used()]
1ef10 20 69 66 20 61 6e 64 20 6f 6e 6c 79 20 69 66 20   if and only if 
1ef20 74 68 65 20 70 61 72 61 6d 65 74 65 72 20 74 6f  the parameter to
1ef30 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 6d 65 6d  .** [sqlite3_mem
1ef40 6f 72 79 5f 68 69 67 68 77 61 74 65 72 28 29 5d  ory_highwater()]
1ef50 20 69 73 20 74 72 75 65 2e 20 20 5e 54 68 65 20   is true.  ^The 
1ef60 76 61 6c 75 65 20 72 65 74 75 72 6e 65 64 0a 2a  value returned.*
1ef70 2a 20 62 79 20 5b 73 71 6c 69 74 65 33 5f 6d 65  * by [sqlite3_me
1ef80 6d 6f 72 79 5f 68 69 67 68 77 61 74 65 72 28 31  mory_highwater(1
1ef90 29 5d 20 69 73 20 74 68 65 20 68 69 67 68 2d 77  )] is the high-w
1efa0 61 74 65 72 20 6d 61 72 6b 0a 2a 2a 20 70 72 69  ater mark.** pri
1efb0 6f 72 20 74 6f 20 74 68 65 20 72 65 73 65 74 2e  or to the reset.
1efc0 0a 2a 2f 0a 73 71 6c 69 74 65 33 5f 69 6e 74 36  .*/.sqlite3_int6
1efd0 34 20 73 71 6c 69 74 65 33 5f 6d 65 6d 6f 72 79  4 sqlite3_memory
1efe0 5f 75 73 65 64 28 76 6f 69 64 29 3b 0a 73 71 6c  _used(void);.sql
1eff0 69 74 65 33 5f 69 6e 74 36 34 20 73 71 6c 69 74  ite3_int64 sqlit
1f000 65 33 5f 6d 65 6d 6f 72 79 5f 68 69 67 68 77 61  e3_memory_highwa
1f010 74 65 72 28 69 6e 74 20 72 65 73 65 74 46 6c 61  ter(int resetFla
1f020 67 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33  g);../*.** CAPI3
1f030 52 45 46 3a 20 50 73 65 75 64 6f 2d 52 61 6e 64  REF: Pseudo-Rand
1f040 6f 6d 20 4e 75 6d 62 65 72 20 47 65 6e 65 72 61  om Number Genera
1f050 74 6f 72 0a 2a 2a 0a 2a 2a 20 53 51 4c 69 74 65  tor.**.** SQLite
1f060 20 63 6f 6e 74 61 69 6e 73 20 61 20 68 69 67 68   contains a high
1f070 2d 71 75 61 6c 69 74 79 20 70 73 65 75 64 6f 2d  -quality pseudo-
1f080 72 61 6e 64 6f 6d 20 6e 75 6d 62 65 72 20 67 65  random number ge
1f090 6e 65 72 61 74 6f 72 20 28 50 52 4e 47 29 20 75  nerator (PRNG) u
1f0a0 73 65 64 20 74 6f 0a 2a 2a 20 73 65 6c 65 63 74  sed to.** select
1f0b0 20 72 61 6e 64 6f 6d 20 5b 52 4f 57 49 44 20 7c   random [ROWID |
1f0c0 20 52 4f 57 49 44 73 5d 20 77 68 65 6e 20 69 6e   ROWIDs] when in
1f0d0 73 65 72 74 69 6e 67 20 6e 65 77 20 72 65 63 6f  serting new reco
1f0e0 72 64 73 20 69 6e 74 6f 20 61 20 74 61 62 6c 65  rds into a table
1f0f0 20 74 68 61 74 0a 2a 2a 20 61 6c 72 65 61 64 79   that.** already
1f100 20 75 73 65 73 20 74 68 65 20 6c 61 72 67 65 73   uses the larges
1f110 74 20 70 6f 73 73 69 62 6c 65 20 5b 52 4f 57 49  t possible [ROWI
1f120 44 5d 2e 20 20 54 68 65 20 50 52 4e 47 20 69 73  D].  The PRNG is
1f130 20 61 6c 73 6f 20 75 73 65 64 20 66 6f 72 0a 2a   also used for.*
1f140 2a 20 74 68 65 20 62 75 69 6c 64 2d 69 6e 20 72  * the build-in r
1f150 61 6e 64 6f 6d 28 29 20 61 6e 64 20 72 61 6e 64  andom() and rand
1f160 6f 6d 62 6c 6f 62 28 29 20 53 51 4c 20 66 75 6e  omblob() SQL fun
1f170 63 74 69 6f 6e 73 2e 20 20 54 68 69 73 20 69 6e  ctions.  This in
1f180 74 65 72 66 61 63 65 20 61 6c 6c 6f 77 73 0a 2a  terface allows.*
1f190 2a 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 74  * applications t
1f1a0 6f 20 61 63 63 65 73 73 20 74 68 65 20 73 61 6d  o access the sam
1f1b0 65 20 50 52 4e 47 20 66 6f 72 20 6f 74 68 65 72  e PRNG for other
1f1c0 20 70 75 72 70 6f 73 65 73 2e 0a 2a 2a 0a 2a 2a   purposes..**.**
1f1d0 20 5e 41 20 63 61 6c 6c 20 74 6f 20 74 68 69 73   ^A call to this
1f1e0 20 72 6f 75 74 69 6e 65 20 73 74 6f 72 65 73 20   routine stores 
1f1f0 4e 20 62 79 74 65 73 20 6f 66 20 72 61 6e 64 6f  N bytes of rando
1f200 6d 6e 65 73 73 20 69 6e 74 6f 20 62 75 66 66 65  mness into buffe
1f210 72 20 50 2e 0a 2a 2a 20 5e 54 68 65 20 50 20 70  r P..** ^The P p
1f220 61 72 61 6d 65 74 65 72 20 63 61 6e 20 62 65 20  arameter can be 
1f230 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 2e 0a  a NULL pointer..
1f240 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 69 73 20 72  **.** ^If this r
1f250 6f 75 74 69 6e 65 20 68 61 73 20 6e 6f 74 20 62  outine has not b
1f260 65 65 6e 20 70 72 65 76 69 6f 75 73 6c 79 20 63  een previously c
1f270 61 6c 6c 65 64 20 6f 72 20 69 66 20 74 68 65 20  alled or if the 
1f280 70 72 65 76 69 6f 75 73 0a 2a 2a 20 63 61 6c 6c  previous.** call
1f290 20 68 61 64 20 4e 20 6c 65 73 73 20 74 68 61 6e   had N less than
1f2a0 20 6f 6e 65 20 6f 72 20 61 20 4e 55 4c 4c 20 70   one or a NULL p
1f2b0 6f 69 6e 74 65 72 20 66 6f 72 20 50 2c 20 74 68  ointer for P, th
1f2c0 65 6e 20 74 68 65 20 50 52 4e 47 20 69 73 0a 2a  en the PRNG is.*
1f2d0 2a 20 73 65 65 64 65 64 20 75 73 69 6e 67 20 72  * seeded using r
1f2e0 61 6e 64 6f 6d 6e 65 73 73 20 6f 62 74 61 69 6e  andomness obtain
1f2f0 65 64 20 66 72 6f 6d 20 74 68 65 20 78 52 61 6e  ed from the xRan
1f300 64 6f 6d 6e 65 73 73 20 6d 65 74 68 6f 64 20 6f  domness method o
1f310 66 0a 2a 2a 20 74 68 65 20 64 65 66 61 75 6c 74  f.** the default
1f320 20 5b 73 71 6c 69 74 65 33 5f 76 66 73 5d 20 6f   [sqlite3_vfs] o
1f330 62 6a 65 63 74 2e 0a 2a 2a 20 5e 49 66 20 74 68  bject..** ^If th
1f340 65 20 70 72 65 76 69 6f 75 73 20 63 61 6c 6c 20  e previous call 
1f350 74 6f 20 74 68 69 73 20 72 6f 75 74 69 6e 65 20  to this routine 
1f360 68 61 64 20 61 6e 20 4e 20 6f 66 20 31 20 6f 72  had an N of 1 or
1f370 20 6d 6f 72 65 20 61 6e 64 20 61 0a 2a 2a 20 6e   more and a.** n
1f380 6f 6e 2d 4e 55 4c 4c 20 50 20 74 68 65 6e 20 74  on-NULL P then t
1f390 68 65 20 70 73 65 75 64 6f 2d 72 61 6e 64 6f 6d  he pseudo-random
1f3a0 6e 65 73 73 20 69 73 20 67 65 6e 65 72 61 74 65  ness is generate
1f3b0 64 0a 2a 2a 20 69 6e 74 65 72 6e 61 6c 6c 79 20  d.** internally 
1f3c0 61 6e 64 20 77 69 74 68 6f 75 74 20 72 65 63 6f  and without reco
1f3d0 75 72 73 65 20 74 6f 20 74 68 65 20 5b 73 71 6c  urse to the [sql
1f3e0 69 74 65 33 5f 76 66 73 5d 20 78 52 61 6e 64 6f  ite3_vfs] xRando
1f3f0 6d 6e 65 73 73 0a 2a 2a 20 6d 65 74 68 6f 64 2e  mness.** method.
1f400 0a 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33  .*/.void sqlite3
1f410 5f 72 61 6e 64 6f 6d 6e 65 73 73 28 69 6e 74 20  _randomness(int 
1f420 4e 2c 20 76 6f 69 64 20 2a 50 29 3b 0a 0a 2f 2a  N, void *P);../*
1f430 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 43 6f  .** CAPI3REF: Co
1f440 6d 70 69 6c 65 2d 54 69 6d 65 20 41 75 74 68 6f  mpile-Time Autho
1f450 72 69 7a 61 74 69 6f 6e 20 43 61 6c 6c 62 61 63  rization Callbac
1f460 6b 73 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71  ks.** METHOD: sq
1f470 6c 69 74 65 33 0a 2a 2a 0a 2a 2a 20 5e 54 68 69  lite3.**.** ^Thi
1f480 73 20 72 6f 75 74 69 6e 65 20 72 65 67 69 73 74  s routine regist
1f490 65 72 73 20 61 6e 20 61 75 74 68 6f 72 69 7a 65  ers an authorize
1f4a0 72 20 63 61 6c 6c 62 61 63 6b 20 77 69 74 68 20  r callback with 
1f4b0 61 20 70 61 72 74 69 63 75 6c 61 72 0a 2a 2a 20  a particular.** 
1f4c0 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63  [database connec
1f4d0 74 69 6f 6e 5d 2c 20 73 75 70 70 6c 69 65 64 20  tion], supplied 
1f4e0 69 6e 20 74 68 65 20 66 69 72 73 74 20 61 72 67  in the first arg
1f4f0 75 6d 65 6e 74 2e 0a 2a 2a 20 5e 54 68 65 20 61  ument..** ^The a
1f500 75 74 68 6f 72 69 7a 65 72 20 63 61 6c 6c 62 61  uthorizer callba
1f510 63 6b 20 69 73 20 69 6e 76 6f 6b 65 64 20 61 73  ck is invoked as
1f520 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73 20   SQL statements 
1f530 61 72 65 20 62 65 69 6e 67 20 63 6f 6d 70 69 6c  are being compil
1f540 65 64 0a 2a 2a 20 62 79 20 5b 73 71 6c 69 74 65  ed.** by [sqlite
1f550 33 5f 70 72 65 70 61 72 65 28 29 5d 20 6f 72 20  3_prepare()] or 
1f560 69 74 73 20 76 61 72 69 61 6e 74 73 20 5b 73 71  its variants [sq
1f570 6c 69 74 65 33 5f 70 72 65 70 61 72 65 5f 76 32  lite3_prepare_v2
1f580 28 29 5d 2c 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  ()],.** [sqlite3
1f590 5f 70 72 65 70 61 72 65 31 36 28 29 5d 20 61 6e  _prepare16()] an
1f5a0 64 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61  d [sqlite3_prepa
1f5b0 72 65 31 36 5f 76 32 28 29 5d 2e 20 20 5e 41 74  re16_v2()].  ^At
1f5c0 20 76 61 72 69 6f 75 73 0a 2a 2a 20 70 6f 69 6e   various.** poin
1f5d0 74 73 20 64 75 72 69 6e 67 20 74 68 65 20 63 6f  ts during the co
1f5e0 6d 70 69 6c 61 74 69 6f 6e 20 70 72 6f 63 65 73  mpilation proces
1f5f0 73 2c 20 61 73 20 6c 6f 67 69 63 20 69 73 20 62  s, as logic is b
1f600 65 69 6e 67 20 63 72 65 61 74 65 64 0a 2a 2a 20  eing created.** 
1f610 74 6f 20 70 65 72 66 6f 72 6d 20 76 61 72 69 6f  to perform vario
1f620 75 73 20 61 63 74 69 6f 6e 73 2c 20 74 68 65 20  us actions, the 
1f630 61 75 74 68 6f 72 69 7a 65 72 20 63 61 6c 6c 62  authorizer callb
1f640 61 63 6b 20 69 73 20 69 6e 76 6f 6b 65 64 20 74  ack is invoked t
1f650 6f 0a 2a 2a 20 73 65 65 20 69 66 20 74 68 6f 73  o.** see if thos
1f660 65 20 61 63 74 69 6f 6e 73 20 61 72 65 20 61 6c  e actions are al
1f670 6c 6f 77 65 64 2e 20 20 5e 54 68 65 20 61 75 74  lowed.  ^The aut
1f680 68 6f 72 69 7a 65 72 20 63 61 6c 6c 62 61 63 6b  horizer callback
1f690 20 73 68 6f 75 6c 64 0a 2a 2a 20 72 65 74 75 72   should.** retur
1f6a0 6e 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d 20 74 6f  n [SQLITE_OK] to
1f6b0 20 61 6c 6c 6f 77 20 74 68 65 20 61 63 74 69 6f   allow the actio
1f6c0 6e 2c 20 5b 53 51 4c 49 54 45 5f 49 47 4e 4f 52  n, [SQLITE_IGNOR
1f6d0 45 5d 20 74 6f 20 64 69 73 61 6c 6c 6f 77 20 74  E] to disallow t
1f6e0 68 65 0a 2a 2a 20 73 70 65 63 69 66 69 63 20 61  he.** specific a
1f6f0 63 74 69 6f 6e 20 62 75 74 20 61 6c 6c 6f 77 20  ction but allow 
1f700 74 68 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e  the SQL statemen
1f710 74 20 74 6f 20 63 6f 6e 74 69 6e 75 65 20 74 6f  t to continue to
1f720 20 62 65 0a 2a 2a 20 63 6f 6d 70 69 6c 65 64 2c   be.** compiled,
1f730 20 6f 72 20 5b 53 51 4c 49 54 45 5f 44 45 4e 59   or [SQLITE_DENY
1f740 5d 20 74 6f 20 63 61 75 73 65 20 74 68 65 20 65  ] to cause the e
1f750 6e 74 69 72 65 20 53 51 4c 20 73 74 61 74 65 6d  ntire SQL statem
1f760 65 6e 74 20 74 6f 20 62 65 0a 2a 2a 20 72 65 6a  ent to be.** rej
1f770 65 63 74 65 64 20 77 69 74 68 20 61 6e 20 65 72  ected with an er
1f780 72 6f 72 2e 20 20 5e 49 66 20 74 68 65 20 61 75  ror.  ^If the au
1f790 74 68 6f 72 69 7a 65 72 20 63 61 6c 6c 62 61 63  thorizer callbac
1f7a0 6b 20 72 65 74 75 72 6e 73 0a 2a 2a 20 61 6e 79  k returns.** any
1f7b0 20 76 61 6c 75 65 20 6f 74 68 65 72 20 74 68 61   value other tha
1f7c0 6e 20 5b 53 51 4c 49 54 45 5f 49 47 4e 4f 52 45  n [SQLITE_IGNORE
1f7d0 5d 2c 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d 2c 20  ], [SQLITE_OK], 
1f7e0 6f 72 20 5b 53 51 4c 49 54 45 5f 44 45 4e 59 5d  or [SQLITE_DENY]
1f7f0 0a 2a 2a 20 74 68 65 6e 20 74 68 65 20 5b 73 71  .** then the [sq
1f800 6c 69 74 65 33 5f 70 72 65 70 61 72 65 5f 76 32  lite3_prepare_v2
1f810 28 29 5d 20 6f 72 20 65 71 75 69 76 61 6c 65 6e  ()] or equivalen
1f820 74 20 63 61 6c 6c 20 74 68 61 74 20 74 72 69 67  t call that trig
1f830 67 65 72 65 64 0a 2a 2a 20 74 68 65 20 61 75 74  gered.** the aut
1f840 68 6f 72 69 7a 65 72 20 77 69 6c 6c 20 66 61 69  horizer will fai
1f850 6c 20 77 69 74 68 20 61 6e 20 65 72 72 6f 72 20  l with an error 
1f860 6d 65 73 73 61 67 65 2e 0a 2a 2a 0a 2a 2a 20 57  message..**.** W
1f870 68 65 6e 20 74 68 65 20 63 61 6c 6c 62 61 63 6b  hen the callback
1f880 20 72 65 74 75 72 6e 73 20 5b 53 51 4c 49 54 45   returns [SQLITE
1f890 5f 4f 4b 5d 2c 20 74 68 61 74 20 6d 65 61 6e 73  _OK], that means
1f8a0 20 74 68 65 20 6f 70 65 72 61 74 69 6f 6e 0a 2a   the operation.*
1f8b0 2a 20 72 65 71 75 65 73 74 65 64 20 69 73 20 6f  * requested is o
1f8c0 6b 2e 20 20 5e 57 68 65 6e 20 74 68 65 20 63 61  k.  ^When the ca
1f8d0 6c 6c 62 61 63 6b 20 72 65 74 75 72 6e 73 20 5b  llback returns [
1f8e0 53 51 4c 49 54 45 5f 44 45 4e 59 5d 2c 20 74 68  SQLITE_DENY], th
1f8f0 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 70 72  e.** [sqlite3_pr
1f900 65 70 61 72 65 5f 76 32 28 29 5d 20 6f 72 20 65  epare_v2()] or e
1f910 71 75 69 76 61 6c 65 6e 74 20 63 61 6c 6c 20 74  quivalent call t
1f920 68 61 74 20 74 72 69 67 67 65 72 65 64 20 74 68  hat triggered th
1f930 65 0a 2a 2a 20 61 75 74 68 6f 72 69 7a 65 72 20  e.** authorizer 
1f940 77 69 6c 6c 20 66 61 69 6c 20 77 69 74 68 20 61  will fail with a
1f950 6e 20 65 72 72 6f 72 20 6d 65 73 73 61 67 65 20  n error message 
1f960 65 78 70 6c 61 69 6e 69 6e 67 20 74 68 61 74 0a  explaining that.
1f970 2a 2a 20 61 63 63 65 73 73 20 69 73 20 64 65 6e  ** access is den
1f980 69 65 64 2e 20 0a 2a 2a 0a 2a 2a 20 5e 54 68 65  ied. .**.** ^The
1f990 20 66 69 72 73 74 20 70 61 72 61 6d 65 74 65 72   first parameter
1f9a0 20 74 6f 20 74 68 65 20 61 75 74 68 6f 72 69 7a   to the authoriz
1f9b0 65 72 20 63 61 6c 6c 62 61 63 6b 20 69 73 20 61  er callback is a
1f9c0 20 63 6f 70 79 20 6f 66 20 74 68 65 20 74 68 69   copy of the thi
1f9d0 72 64 0a 2a 2a 20 70 61 72 61 6d 65 74 65 72 20  rd.** parameter 
1f9e0 74 6f 20 74 68 65 20 73 71 6c 69 74 65 33 5f 73  to the sqlite3_s
1f9f0 65 74 5f 61 75 74 68 6f 72 69 7a 65 72 28 29 20  et_authorizer() 
1fa00 69 6e 74 65 72 66 61 63 65 2e 20 5e 54 68 65 20  interface. ^The 
1fa10 73 65 63 6f 6e 64 20 70 61 72 61 6d 65 74 65 72  second parameter
1fa20 0a 2a 2a 20 74 6f 20 74 68 65 20 63 61 6c 6c 62  .** to the callb
1fa30 61 63 6b 20 69 73 20 61 6e 20 69 6e 74 65 67 65  ack is an intege
1fa40 72 20 5b 53 51 4c 49 54 45 5f 43 4f 50 59 20 7c  r [SQLITE_COPY |
1fa50 20 61 63 74 69 6f 6e 20 63 6f 64 65 5d 20 74 68   action code] th
1fa60 61 74 20 73 70 65 63 69 66 69 65 73 0a 2a 2a 20  at specifies.** 
1fa70 74 68 65 20 70 61 72 74 69 63 75 6c 61 72 20 61  the particular a
1fa80 63 74 69 6f 6e 20 74 6f 20 62 65 20 61 75 74 68  ction to be auth
1fa90 6f 72 69 7a 65 64 2e 20 5e 54 68 65 20 74 68 69  orized. ^The thi
1faa0 72 64 20 74 68 72 6f 75 67 68 20 73 69 78 74 68  rd through sixth
1fab0 20 70 61 72 61 6d 65 74 65 72 73 0a 2a 2a 20 74   parameters.** t
1fac0 6f 20 74 68 65 20 63 61 6c 6c 62 61 63 6b 20 61  o the callback a
1fad0 72 65 20 7a 65 72 6f 2d 74 65 72 6d 69 6e 61 74  re zero-terminat
1fae0 65 64 20 73 74 72 69 6e 67 73 20 74 68 61 74 20  ed strings that 
1faf0 63 6f 6e 74 61 69 6e 20 61 64 64 69 74 69 6f 6e  contain addition
1fb00 61 6c 0a 2a 2a 20 64 65 74 61 69 6c 73 20 61 62  al.** details ab
1fb10 6f 75 74 20 74 68 65 20 61 63 74 69 6f 6e 20 74  out the action t
1fb20 6f 20 62 65 20 61 75 74 68 6f 72 69 7a 65 64 2e  o be authorized.
1fb30 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20 61  .**.** ^If the a
1fb40 63 74 69 6f 6e 20 63 6f 64 65 20 69 73 20 5b 53  ction code is [S
1fb50 51 4c 49 54 45 5f 52 45 41 44 5d 0a 2a 2a 20 61  QLITE_READ].** a
1fb60 6e 64 20 74 68 65 20 63 61 6c 6c 62 61 63 6b 20  nd the callback 
1fb70 72 65 74 75 72 6e 73 20 5b 53 51 4c 49 54 45 5f  returns [SQLITE_
1fb80 49 47 4e 4f 52 45 5d 20 74 68 65 6e 20 74 68 65  IGNORE] then the
1fb90 0a 2a 2a 20 5b 70 72 65 70 61 72 65 64 20 73 74  .** [prepared st
1fba0 61 74 65 6d 65 6e 74 5d 20 73 74 61 74 65 6d 65  atement] stateme
1fbb0 6e 74 20 69 73 20 63 6f 6e 73 74 72 75 63 74 65  nt is constructe
1fbc0 64 20 74 6f 20 73 75 62 73 74 69 74 75 74 65 0a  d to substitute.
1fbd0 2a 2a 20 61 20 4e 55 4c 4c 20 76 61 6c 75 65 20  ** a NULL value 
1fbe0 69 6e 20 70 6c 61 63 65 20 6f 66 20 74 68 65 20  in place of the 
1fbf0 74 61 62 6c 65 20 63 6f 6c 75 6d 6e 20 74 68 61  table column tha
1fc00 74 20 77 6f 75 6c 64 20 68 61 76 65 0a 2a 2a 20  t would have.** 
1fc10 62 65 65 6e 20 72 65 61 64 20 69 66 20 5b 53 51  been read if [SQ
1fc20 4c 49 54 45 5f 4f 4b 5d 20 68 61 64 20 62 65 65  LITE_OK] had bee
1fc30 6e 20 72 65 74 75 72 6e 65 64 2e 20 20 54 68 65  n returned.  The
1fc40 20 5b 53 51 4c 49 54 45 5f 49 47 4e 4f 52 45 5d   [SQLITE_IGNORE]
1fc50 0a 2a 2a 20 72 65 74 75 72 6e 20 63 61 6e 20 62  .** return can b
1fc60 65 20 75 73 65 64 20 74 6f 20 64 65 6e 79 20 61  e used to deny a
1fc70 6e 20 75 6e 74 72 75 73 74 65 64 20 75 73 65 72  n untrusted user
1fc80 20 61 63 63 65 73 73 20 74 6f 20 69 6e 64 69 76   access to indiv
1fc90 69 64 75 61 6c 0a 2a 2a 20 63 6f 6c 75 6d 6e 73  idual.** columns
1fca0 20 6f 66 20 61 20 74 61 62 6c 65 2e 0a 2a 2a 20   of a table..** 
1fcb0 5e 49 66 20 74 68 65 20 61 63 74 69 6f 6e 20 63  ^If the action c
1fcc0 6f 64 65 20 69 73 20 5b 53 51 4c 49 54 45 5f 44  ode is [SQLITE_D
1fcd0 45 4c 45 54 45 5d 20 61 6e 64 20 74 68 65 20 63  ELETE] and the c
1fce0 61 6c 6c 62 61 63 6b 20 72 65 74 75 72 6e 73 0a  allback returns.
1fcf0 2a 2a 20 5b 53 51 4c 49 54 45 5f 49 47 4e 4f 52  ** [SQLITE_IGNOR
1fd00 45 5d 20 74 68 65 6e 20 74 68 65 20 5b 44 45 4c  E] then the [DEL
1fd10 45 54 45 5d 20 6f 70 65 72 61 74 69 6f 6e 20 70  ETE] operation p
1fd20 72 6f 63 65 65 64 73 20 62 75 74 20 74 68 65 0a  roceeds but the.
1fd30 2a 2a 20 5b 74 72 75 6e 63 61 74 65 20 6f 70 74  ** [truncate opt
1fd40 69 6d 69 7a 61 74 69 6f 6e 5d 20 69 73 20 64 69  imization] is di
1fd50 73 61 62 6c 65 64 20 61 6e 64 20 61 6c 6c 20 72  sabled and all r
1fd60 6f 77 73 20 61 72 65 20 64 65 6c 65 74 65 64 20  ows are deleted 
1fd70 69 6e 64 69 76 69 64 75 61 6c 6c 79 2e 0a 2a 2a  individually..**
1fd80 0a 2a 2a 20 41 6e 20 61 75 74 68 6f 72 69 7a 65  .** An authorize
1fd90 72 20 69 73 20 75 73 65 64 20 77 68 65 6e 20 5b  r is used when [
1fda0 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 20  sqlite3_prepare 
1fdb0 7c 20 70 72 65 70 61 72 69 6e 67 5d 0a 2a 2a 20  | preparing].** 
1fdc0 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73 20 66  SQL statements f
1fdd0 72 6f 6d 20 61 6e 20 75 6e 74 72 75 73 74 65 64  rom an untrusted
1fde0 20 73 6f 75 72 63 65 2c 20 74 6f 20 65 6e 73 75   source, to ensu
1fdf0 72 65 20 74 68 61 74 20 74 68 65 20 53 51 4c 20  re that the SQL 
1fe00 73 74 61 74 65 6d 65 6e 74 73 0a 2a 2a 20 64 6f  statements.** do
1fe10 20 6e 6f 74 20 74 72 79 20 74 6f 20 61 63 63 65   not try to acce
1fe20 73 73 20 64 61 74 61 20 74 68 65 79 20 61 72 65  ss data they are
1fe30 20 6e 6f 74 20 61 6c 6c 6f 77 65 64 20 74 6f 20   not allowed to 
1fe40 73 65 65 2c 20 6f 72 20 74 68 61 74 20 74 68 65  see, or that the
1fe50 79 20 64 6f 20 6e 6f 74 0a 2a 2a 20 74 72 79 20  y do not.** try 
1fe60 74 6f 20 65 78 65 63 75 74 65 20 6d 61 6c 69 63  to execute malic
1fe70 69 6f 75 73 20 73 74 61 74 65 6d 65 6e 74 73 20  ious statements 
1fe80 74 68 61 74 20 64 61 6d 61 67 65 20 74 68 65 20  that damage the 
1fe90 64 61 74 61 62 61 73 65 2e 20 20 46 6f 72 0a 2a  database.  For.*
1fea0 2a 20 65 78 61 6d 70 6c 65 2c 20 61 6e 20 61 70  * example, an ap
1feb0 70 6c 69 63 61 74 69 6f 6e 20 6d 61 79 20 61 6c  plication may al
1fec0 6c 6f 77 20 61 20 75 73 65 72 20 74 6f 20 65 6e  low a user to en
1fed0 74 65 72 20 61 72 62 69 74 72 61 72 79 0a 2a 2a  ter arbitrary.**
1fee0 20 53 51 4c 20 71 75 65 72 69 65 73 20 66 6f 72   SQL queries for
1fef0 20 65 76 61 6c 75 61 74 69 6f 6e 20 62 79 20 61   evaluation by a
1ff00 20 64 61 74 61 62 61 73 65 2e 20 20 42 75 74 20   database.  But 
1ff10 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20  the application 
1ff20 64 6f 65 73 0a 2a 2a 20 6e 6f 74 20 77 61 6e 74  does.** not want
1ff30 20 74 68 65 20 75 73 65 72 20 74 6f 20 62 65 20   the user to be 
1ff40 61 62 6c 65 20 74 6f 20 6d 61 6b 65 20 61 72 62  able to make arb
1ff50 69 74 72 61 72 79 20 63 68 61 6e 67 65 73 20 74  itrary changes t
1ff60 6f 20 74 68 65 0a 2a 2a 20 64 61 74 61 62 61 73  o the.** databas
1ff70 65 2e 20 20 41 6e 20 61 75 74 68 6f 72 69 7a 65  e.  An authorize
1ff80 72 20 63 6f 75 6c 64 20 74 68 65 6e 20 62 65 20  r could then be 
1ff90 70 75 74 20 69 6e 20 70 6c 61 63 65 20 77 68 69  put in place whi
1ffa0 6c 65 20 74 68 65 0a 2a 2a 20 75 73 65 72 2d 65  le the.** user-e
1ffb0 6e 74 65 72 65 64 20 53 51 4c 20 69 73 20 62 65  ntered SQL is be
1ffc0 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 70 72 65  ing [sqlite3_pre
1ffd0 70 61 72 65 20 7c 20 70 72 65 70 61 72 65 64 5d  pare | prepared]
1ffe0 20 74 68 61 74 0a 2a 2a 20 64 69 73 61 6c 6c 6f   that.** disallo
1fff0 77 73 20 65 76 65 72 79 74 68 69 6e 67 20 65 78  ws everything ex
20000 63 65 70 74 20 5b 53 45 4c 45 43 54 5d 20 73 74  cept [SELECT] st
20010 61 74 65 6d 65 6e 74 73 2e 0a 2a 2a 0a 2a 2a 20  atements..**.** 
20020 41 70 70 6c 69 63 61 74 69 6f 6e 73 20 74 68 61  Applications tha
20030 74 20 6e 65 65 64 20 74 6f 20 70 72 6f 63 65 73  t need to proces
20040 73 20 53 51 4c 20 66 72 6f 6d 20 75 6e 74 72 75  s SQL from untru
20050 73 74 65 64 20 73 6f 75 72 63 65 73 0a 2a 2a 20  sted sources.** 
20060 6d 69 67 68 74 20 61 6c 73 6f 20 63 6f 6e 73 69  might also consi
20070 64 65 72 20 6c 6f 77 65 72 69 6e 67 20 72 65 73  der lowering res
20080 6f 75 72 63 65 20 6c 69 6d 69 74 73 20 75 73 69  ource limits usi
20090 6e 67 20 5b 73 71 6c 69 74 65 33 5f 6c 69 6d 69  ng [sqlite3_limi
200a0 74 28 29 5d 0a 2a 2a 20 61 6e 64 20 6c 69 6d 69  t()].** and limi
200b0 74 69 6e 67 20 64 61 74 61 62 61 73 65 20 73 69  ting database si
200c0 7a 65 20 75 73 69 6e 67 20 74 68 65 20 5b 6d 61  ze using the [ma
200d0 78 5f 70 61 67 65 5f 63 6f 75 6e 74 5d 20 5b 50  x_page_count] [P
200e0 52 41 47 4d 41 5d 0a 2a 2a 20 69 6e 20 61 64 64  RAGMA].** in add
200f0 69 74 69 6f 6e 20 74 6f 20 75 73 69 6e 67 20 61  ition to using a
20100 6e 20 61 75 74 68 6f 72 69 7a 65 72 2e 0a 2a 2a  n authorizer..**
20110 0a 2a 2a 20 5e 28 4f 6e 6c 79 20 61 20 73 69 6e  .** ^(Only a sin
20120 67 6c 65 20 61 75 74 68 6f 72 69 7a 65 72 20 63  gle authorizer c
20130 61 6e 20 62 65 20 69 6e 20 70 6c 61 63 65 20 6f  an be in place o
20140 6e 20 61 20 64 61 74 61 62 61 73 65 20 63 6f 6e  n a database con
20150 6e 65 63 74 69 6f 6e 0a 2a 2a 20 61 74 20 61 20  nection.** at a 
20160 74 69 6d 65 2e 20 20 45 61 63 68 20 63 61 6c 6c  time.  Each call
20170 20 74 6f 20 73 71 6c 69 74 65 33 5f 73 65 74 5f   to sqlite3_set_
20180 61 75 74 68 6f 72 69 7a 65 72 20 6f 76 65 72 72  authorizer overr
20190 69 64 65 73 20 74 68 65 0a 2a 2a 20 70 72 65 76  ides the.** prev
201a0 69 6f 75 73 20 63 61 6c 6c 2e 29 5e 20 20 5e 44  ious call.)^  ^D
201b0 69 73 61 62 6c 65 20 74 68 65 20 61 75 74 68 6f  isable the autho
201c0 72 69 7a 65 72 20 62 79 20 69 6e 73 74 61 6c 6c  rizer by install
201d0 69 6e 67 20 61 20 4e 55 4c 4c 20 63 61 6c 6c 62  ing a NULL callb
201e0 61 63 6b 2e 0a 2a 2a 20 54 68 65 20 61 75 74 68  ack..** The auth
201f0 6f 72 69 7a 65 72 20 69 73 20 64 69 73 61 62 6c  orizer is disabl
20200 65 64 20 62 79 20 64 65 66 61 75 6c 74 2e 0a 2a  ed by default..*
20210 2a 0a 2a 2a 20 54 68 65 20 61 75 74 68 6f 72 69  *.** The authori
20220 7a 65 72 20 63 61 6c 6c 62 61 63 6b 20 6d 75 73  zer callback mus
20230 74 20 6e 6f 74 20 64 6f 20 61 6e 79 74 68 69 6e  t not do anythin
20240 67 20 74 68 61 74 20 77 69 6c 6c 20 6d 6f 64 69  g that will modi
20250 66 79 0a 2a 2a 20 74 68 65 20 64 61 74 61 62 61  fy.** the databa
20260 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 74 68  se connection th
20270 61 74 20 69 6e 76 6f 6b 65 64 20 74 68 65 20 61  at invoked the a
20280 75 74 68 6f 72 69 7a 65 72 20 63 61 6c 6c 62 61  uthorizer callba
20290 63 6b 2e 0a 2a 2a 20 4e 6f 74 65 20 74 68 61 74  ck..** Note that
202a0 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72   [sqlite3_prepar
202b0 65 5f 76 32 28 29 5d 20 61 6e 64 20 5b 73 71 6c  e_v2()] and [sql
202c0 69 74 65 33 5f 73 74 65 70 28 29 5d 20 62 6f 74  ite3_step()] bot
202d0 68 20 6d 6f 64 69 66 79 20 74 68 65 69 72 0a 2a  h modify their.*
202e0 2a 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65  * database conne
202f0 63 74 69 6f 6e 73 20 66 6f 72 20 74 68 65 20 6d  ctions for the m
20300 65 61 6e 69 6e 67 20 6f 66 20 22 6d 6f 64 69 66  eaning of "modif
20310 79 22 20 69 6e 20 74 68 69 73 20 70 61 72 61 67  y" in this parag
20320 72 61 70 68 2e 0a 2a 2a 0a 2a 2a 20 5e 57 68 65  raph..**.** ^Whe
20330 6e 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61  n [sqlite3_prepa
20340 72 65 5f 76 32 28 29 5d 20 69 73 20 75 73 65 64  re_v2()] is used
20350 20 74 6f 20 70 72 65 70 61 72 65 20 61 20 73 74   to prepare a st
20360 61 74 65 6d 65 6e 74 2c 20 74 68 65 0a 2a 2a 20  atement, the.** 
20370 73 74 61 74 65 6d 65 6e 74 20 6d 69 67 68 74 20  statement might 
20380 62 65 20 72 65 2d 70 72 65 70 61 72 65 64 20 64  be re-prepared d
20390 75 72 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 73  uring [sqlite3_s
203a0 74 65 70 28 29 5d 20 64 75 65 20 74 6f 20 61 20  tep()] due to a 
203b0 0a 2a 2a 20 73 63 68 65 6d 61 20 63 68 61 6e 67  .** schema chang
203c0 65 2e 20 20 48 65 6e 63 65 2c 20 74 68 65 20 61  e.  Hence, the a
203d0 70 70 6c 69 63 61 74 69 6f 6e 20 73 68 6f 75 6c  pplication shoul
203e0 64 20 65 6e 73 75 72 65 20 74 68 61 74 20 74 68  d ensure that th
203f0 65 0a 2a 2a 20 63 6f 72 72 65 63 74 20 61 75 74  e.** correct aut
20400 68 6f 72 69 7a 65 72 20 63 61 6c 6c 62 61 63 6b  horizer callback
20410 20 72 65 6d 61 69 6e 73 20 69 6e 20 70 6c 61 63   remains in plac
20420 65 20 64 75 72 69 6e 67 20 74 68 65 20 5b 73 71  e during the [sq
20430 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 2e 0a 2a  lite3_step()]..*
20440 2a 0a 2a 2a 20 5e 4e 6f 74 65 20 74 68 61 74 20  *.** ^Note that 
20450 74 68 65 20 61 75 74 68 6f 72 69 7a 65 72 20 63  the authorizer c
20460 61 6c 6c 62 61 63 6b 20 69 73 20 69 6e 76 6f 6b  allback is invok
20470 65 64 20 6f 6e 6c 79 20 64 75 72 69 6e 67 0a 2a  ed only during.*
20480 2a 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61  * [sqlite3_prepa
20490 72 65 28 29 5d 20 6f 72 20 69 74 73 20 76 61 72  re()] or its var
204a0 69 61 6e 74 73 2e 20 20 41 75 74 68 6f 72 69 7a  iants.  Authoriz
204b0 61 74 69 6f 6e 20 69 73 20 6e 6f 74 0a 2a 2a 20  ation is not.** 
204c0 70 65 72 66 6f 72 6d 65 64 20 64 75 72 69 6e 67  performed during
204d0 20 73 74 61 74 65 6d 65 6e 74 20 65 76 61 6c 75   statement evalu
204e0 61 74 69 6f 6e 20 69 6e 20 5b 73 71 6c 69 74 65  ation in [sqlite
204f0 33 5f 73 74 65 70 28 29 5d 2c 20 75 6e 6c 65 73  3_step()], unles
20500 73 0a 2a 2a 20 61 73 20 73 74 61 74 65 64 20 69  s.** as stated i
20510 6e 20 74 68 65 20 70 72 65 76 69 6f 75 73 20 70  n the previous p
20520 61 72 61 67 72 61 70 68 2c 20 73 71 6c 69 74 65  aragraph, sqlite
20530 33 5f 73 74 65 70 28 29 20 69 6e 76 6f 6b 65 73  3_step() invokes
20540 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 70 72 65 70  .** sqlite3_prep
20550 61 72 65 5f 76 32 28 29 20 74 6f 20 72 65 70 72  are_v2() to repr
20560 65 70 61 72 65 20 61 20 73 74 61 74 65 6d 65 6e  epare a statemen
20570 74 20 61 66 74 65 72 20 61 20 73 63 68 65 6d 61  t after a schema
20580 20 63 68 61 6e 67 65 2e 0a 2a 2f 0a 69 6e 74 20   change..*/.int 
20590 73 71 6c 69 74 65 33 5f 73 65 74 5f 61 75 74 68  sqlite3_set_auth
205a0 6f 72 69 7a 65 72 28 0a 20 20 73 71 6c 69 74 65  orizer(.  sqlite
205b0 33 2a 2c 0a 20 20 69 6e 74 20 28 2a 78 41 75 74  3*,.  int (*xAut
205c0 68 29 28 76 6f 69 64 2a 2c 69 6e 74 2c 63 6f 6e  h)(void*,int,con
205d0 73 74 20 63 68 61 72 2a 2c 63 6f 6e 73 74 20 63  st char*,const c
205e0 68 61 72 2a 2c 63 6f 6e 73 74 20 63 68 61 72 2a  har*,const char*
205f0 2c 63 6f 6e 73 74 20 63 68 61 72 2a 29 2c 0a 20  ,const char*),. 
20600 20 76 6f 69 64 20 2a 70 55 73 65 72 44 61 74 61   void *pUserData
20610 0a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33  .);../*.** CAPI3
20620 52 45 46 3a 20 41 75 74 68 6f 72 69 7a 65 72 20  REF: Authorizer 
20630 52 65 74 75 72 6e 20 43 6f 64 65 73 0a 2a 2a 0a  Return Codes.**.
20640 2a 2a 20 54 68 65 20 5b 73 71 6c 69 74 65 33 5f  ** The [sqlite3_
20650 73 65 74 5f 61 75 74 68 6f 72 69 7a 65 72 20 7c  set_authorizer |
20660 20 61 75 74 68 6f 72 69 7a 65 72 20 63 61 6c 6c   authorizer call
20670 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e 5d 20 6d  back function] m
20680 75 73 74 0a 2a 2a 20 72 65 74 75 72 6e 20 65 69  ust.** return ei
20690 74 68 65 72 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d  ther [SQLITE_OK]
206a0 20 6f 72 20 6f 6e 65 20 6f 66 20 74 68 65 73 65   or one of these
206b0 20 74 77 6f 20 63 6f 6e 73 74 61 6e 74 73 20 69   two constants i
206c0 6e 20 6f 72 64 65 72 0a 2a 2a 20 74 6f 20 73 69  n order.** to si
206d0 67 6e 61 6c 20 53 51 4c 69 74 65 20 77 68 65 74  gnal SQLite whet
206e0 68 65 72 20 6f 72 20 6e 6f 74 20 74 68 65 20 61  her or not the a
206f0 63 74 69 6f 6e 20 69 73 20 70 65 72 6d 69 74 74  ction is permitt
20700 65 64 2e 20 20 53 65 65 20 74 68 65 0a 2a 2a 20  ed.  See the.** 
20710 5b 73 71 6c 69 74 65 33 5f 73 65 74 5f 61 75 74  [sqlite3_set_aut
20720 68 6f 72 69 7a 65 72 20 7c 20 61 75 74 68 6f 72  horizer | author
20730 69 7a 65 72 20 64 6f 63 75 6d 65 6e 74 61 74 69  izer documentati
20740 6f 6e 5d 20 66 6f 72 20 61 64 64 69 74 69 6f 6e  on] for addition
20750 61 6c 0a 2a 2a 20 69 6e 66 6f 72 6d 61 74 69 6f  al.** informatio
20760 6e 2e 0a 2a 2a 0a 2a 2a 20 4e 6f 74 65 20 74 68  n..**.** Note th
20770 61 74 20 53 51 4c 49 54 45 5f 49 47 4e 4f 52 45  at SQLITE_IGNORE
20780 20 69 73 20 61 6c 73 6f 20 75 73 65 64 20 61 73   is also used as
20790 20 61 20 5b 63 6f 6e 66 6c 69 63 74 20 72 65 73   a [conflict res
207a0 6f 6c 75 74 69 6f 6e 20 6d 6f 64 65 5d 0a 2a 2a  olution mode].**
207b0 20 72 65 74 75 72 6e 65 64 20 66 72 6f 6d 20 74   returned from t
207c0 68 65 20 5b 73 71 6c 69 74 65 33 5f 76 74 61 62  he [sqlite3_vtab
207d0 5f 6f 6e 5f 63 6f 6e 66 6c 69 63 74 28 29 5d 20  _on_conflict()] 
207e0 69 6e 74 65 72 66 61 63 65 2e 0a 2a 2f 0a 23 64  interface..*/.#d
207f0 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 44 45 4e  efine SQLITE_DEN
20800 59 20 20 20 31 20 20 20 2f 2a 20 41 62 6f 72 74  Y   1   /* Abort
20810 20 74 68 65 20 53 51 4c 20 73 74 61 74 65 6d 65   the SQL stateme
20820 6e 74 20 77 69 74 68 20 61 6e 20 65 72 72 6f 72  nt with an error
20830 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
20840 54 45 5f 49 47 4e 4f 52 45 20 32 20 20 20 2f 2a  TE_IGNORE 2   /*
20850 20 44 6f 6e 27 74 20 61 6c 6c 6f 77 20 61 63 63   Don't allow acc
20860 65 73 73 2c 20 62 75 74 20 64 6f 6e 27 74 20 67  ess, but don't g
20870 65 6e 65 72 61 74 65 20 61 6e 20 65 72 72 6f 72  enerate an error
20880 20 2a 2f 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33   */../*.** CAPI3
20890 52 45 46 3a 20 41 75 74 68 6f 72 69 7a 65 72 20  REF: Authorizer 
208a0 41 63 74 69 6f 6e 20 43 6f 64 65 73 0a 2a 2a 0a  Action Codes.**.
208b0 2a 2a 20 54 68 65 20 5b 73 71 6c 69 74 65 33 5f  ** The [sqlite3_
208c0 73 65 74 5f 61 75 74 68 6f 72 69 7a 65 72 28 29  set_authorizer()
208d0 5d 20 69 6e 74 65 72 66 61 63 65 20 72 65 67 69  ] interface regi
208e0 73 74 65 72 73 20 61 20 63 61 6c 6c 62 61 63 6b  sters a callback
208f0 20 66 75 6e 63 74 69 6f 6e 0a 2a 2a 20 74 68 61   function.** tha
20900 74 20 69 73 20 69 6e 76 6f 6b 65 64 20 74 6f 20  t is invoked to 
20910 61 75 74 68 6f 72 69 7a 65 20 63 65 72 74 61 69  authorize certai
20920 6e 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 20  n SQL statement 
20930 61 63 74 69 6f 6e 73 2e 20 20 54 68 65 0a 2a 2a  actions.  The.**
20940 20 73 65 63 6f 6e 64 20 70 61 72 61 6d 65 74 65   second paramete
20950 72 20 74 6f 20 74 68 65 20 63 61 6c 6c 62 61 63  r to the callbac
20960 6b 20 69 73 20 61 6e 20 69 6e 74 65 67 65 72 20  k is an integer 
20970 63 6f 64 65 20 74 68 61 74 20 73 70 65 63 69 66  code that specif
20980 69 65 73 0a 2a 2a 20 77 68 61 74 20 61 63 74 69  ies.** what acti
20990 6f 6e 20 69 73 20 62 65 69 6e 67 20 61 75 74 68  on is being auth
209a0 6f 72 69 7a 65 64 2e 20 20 54 68 65 73 65 20 61  orized.  These a
209b0 72 65 20 74 68 65 20 69 6e 74 65 67 65 72 20 61  re the integer a
209c0 63 74 69 6f 6e 20 63 6f 64 65 73 20 74 68 61 74  ction codes that
209d0 0a 2a 2a 20 74 68 65 20 61 75 74 68 6f 72 69 7a  .** the authoriz
209e0 65 72 20 63 61 6c 6c 62 61 63 6b 20 6d 61 79 20  er callback may 
209f0 62 65 20 70 61 73 73 65 64 2e 0a 2a 2a 0a 2a 2a  be passed..**.**
20a00 20 54 68 65 73 65 20 61 63 74 69 6f 6e 20 63 6f   These action co
20a10 64 65 20 76 61 6c 75 65 73 20 73 69 67 6e 69 66  de values signif
20a20 79 20 77 68 61 74 20 6b 69 6e 64 20 6f 66 20 6f  y what kind of o
20a30 70 65 72 61 74 69 6f 6e 20 69 73 20 74 6f 20 62  peration is to b
20a40 65 0a 2a 2a 20 61 75 74 68 6f 72 69 7a 65 64 2e  e.** authorized.
20a50 20 20 54 68 65 20 33 72 64 20 61 6e 64 20 34 74    The 3rd and 4t
20a60 68 20 70 61 72 61 6d 65 74 65 72 73 20 74 6f 20  h parameters to 
20a70 74 68 65 20 61 75 74 68 6f 72 69 7a 61 74 69 6f  the authorizatio
20a80 6e 0a 2a 2a 20 63 61 6c 6c 62 61 63 6b 20 66 75  n.** callback fu
20a90 6e 63 74 69 6f 6e 20 77 69 6c 6c 20 62 65 20 70  nction will be p
20aa0 61 72 61 6d 65 74 65 72 73 20 6f 72 20 4e 55 4c  arameters or NUL
20ab0 4c 20 64 65 70 65 6e 64 69 6e 67 20 6f 6e 20 77  L depending on w
20ac0 68 69 63 68 20 6f 66 20 74 68 65 73 65 0a 2a 2a  hich of these.**
20ad0 20 63 6f 64 65 73 20 69 73 20 75 73 65 64 20 61   codes is used a
20ae0 73 20 74 68 65 20 73 65 63 6f 6e 64 20 70 61 72  s the second par
20af0 61 6d 65 74 65 72 2e 20 20 5e 28 54 68 65 20 35  ameter.  ^(The 5
20b00 74 68 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20  th parameter to 
20b10 74 68 65 0a 2a 2a 20 61 75 74 68 6f 72 69 7a 65  the.** authorize
20b20 72 20 63 61 6c 6c 62 61 63 6b 20 69 73 20 74 68  r callback is th
20b30 65 20 6e 61 6d 65 20 6f 66 20 74 68 65 20 64 61  e name of the da
20b40 74 61 62 61 73 65 20 28 22 6d 61 69 6e 22 2c 20  tabase ("main", 
20b50 22 74 65 6d 70 22 2c 0a 2a 2a 20 65 74 63 2e 29  "temp",.** etc.)
20b60 20 69 66 20 61 70 70 6c 69 63 61 62 6c 65 2e 29   if applicable.)
20b70 5e 20 20 5e 54 68 65 20 36 74 68 20 70 61 72 61  ^  ^The 6th para
20b80 6d 65 74 65 72 20 74 6f 20 74 68 65 20 61 75 74  meter to the aut
20b90 68 6f 72 69 7a 65 72 20 63 61 6c 6c 62 61 63 6b  horizer callback
20ba0 0a 2a 2a 20 69 73 20 74 68 65 20 6e 61 6d 65 20  .** is the name 
20bb0 6f 66 20 74 68 65 20 69 6e 6e 65 72 2d 6d 6f 73  of the inner-mos
20bc0 74 20 74 72 69 67 67 65 72 20 6f 72 20 76 69 65  t trigger or vie
20bd0 77 20 74 68 61 74 20 69 73 20 72 65 73 70 6f 6e  w that is respon
20be0 73 69 62 6c 65 20 66 6f 72 0a 2a 2a 20 74 68 65  sible for.** the
20bf0 20 61 63 63 65 73 73 20 61 74 74 65 6d 70 74 20   access attempt 
20c00 6f 72 20 4e 55 4c 4c 20 69 66 20 74 68 69 73 20  or NULL if this 
20c10 61 63 63 65 73 73 20 61 74 74 65 6d 70 74 20 69  access attempt i
20c20 73 20 64 69 72 65 63 74 6c 79 20 66 72 6f 6d 0a  s directly from.
20c30 2a 2a 20 74 6f 70 2d 6c 65 76 65 6c 20 53 51 4c  ** top-level SQL
20c40 20 63 6f 64 65 2e 0a 2a 2f 0a 2f 2a 2a 2a 2a 2a   code..*/./*****
20c50 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
20c60 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
20c70 2a 2a 2a 2a 2a 2a 20 33 72 64 20 2a 2a 2a 2a 2a  ****** 3rd *****
20c80 2a 2a 2a 2a 2a 2a 2a 20 34 74 68 20 2a 2a 2a 2a  ******* 4th ****
20c90 2a 2a 2a 2a 2a 2a 2a 2f 0a 23 64 65 66 69 6e 65  *******/.#define
20ca0 20 53 51 4c 49 54 45 5f 43 52 45 41 54 45 5f 49   SQLITE_CREATE_I
20cb0 4e 44 45 58 20 20 20 20 20 20 20 20 20 20 31 20  NDEX          1 
20cc0 20 20 2f 2a 20 49 6e 64 65 78 20 4e 61 6d 65 20    /* Index Name 
20cd0 20 20 20 20 20 54 61 62 6c 65 20 4e 61 6d 65 20       Table Name 
20ce0 20 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20       */.#define 
20cf0 53 51 4c 49 54 45 5f 43 52 45 41 54 45 5f 54 41  SQLITE_CREATE_TA
20d00 42 4c 45 20 20 20 20 20 20 20 20 20 20 32 20 20  BLE          2  
20d10 20 2f 2a 20 54 61 62 6c 65 20 4e 61 6d 65 20 20   /* Table Name  
20d20 20 20 20 20 4e 55 4c 4c 20 20 20 20 20 20 20 20      NULL        
20d30 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53      */.#define S
20d40 51 4c 49 54 45 5f 43 52 45 41 54 45 5f 54 45 4d  QLITE_CREATE_TEM
20d50 50 5f 49 4e 44 45 58 20 20 20 20 20 33 20 20 20  P_INDEX     3   
20d60 2f 2a 20 49 6e 64 65 78 20 4e 61 6d 65 20 20 20  /* Index Name   
20d70 20 20 20 54 61 62 6c 65 20 4e 61 6d 65 20 20 20     Table Name   
20d80 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51     */.#define SQ
20d90 4c 49 54 45 5f 43 52 45 41 54 45 5f 54 45 4d 50  LITE_CREATE_TEMP
20da0 5f 54 41 42 4c 45 20 20 20 20 20 34 20 20 20 2f  _TABLE     4   /
20db0 2a 20 54 61 62 6c 65 20 4e 61 6d 65 20 20 20 20  * Table Name    
20dc0 20 20 4e 55 4c 4c 20 20 20 20 20 20 20 20 20 20    NULL          
20dd0 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c    */.#define SQL
20de0 49 54 45 5f 43 52 45 41 54 45 5f 54 45 4d 50 5f  ITE_CREATE_TEMP_
20df0 54 52 49 47 47 45 52 20 20 20 35 20 20 20 2f 2a  TRIGGER   5   /*
20e00 20 54 72 69 67 67 65 72 20 4e 61 6d 65 20 20 20   Trigger Name   
20e10 20 54 61 62 6c 65 20 4e 61 6d 65 20 20 20 20 20   Table Name     
20e20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
20e30 54 45 5f 43 52 45 41 54 45 5f 54 45 4d 50 5f 56  TE_CREATE_TEMP_V
20e40 49 45 57 20 20 20 20 20 20 36 20 20 20 2f 2a 20  IEW      6   /* 
20e50 56 69 65 77 20 4e 61 6d 65 20 20 20 20 20 20 20  View Name       
20e60 4e 55 4c 4c 20 20 20 20 20 20 20 20 20 20 20 20  NULL            
20e70 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
20e80 45 5f 43 52 45 41 54 45 5f 54 52 49 47 47 45 52  E_CREATE_TRIGGER
20e90 20 20 20 20 20 20 20 20 37 20 20 20 2f 2a 20 54          7   /* T
20ea0 72 69 67 67 65 72 20 4e 61 6d 65 20 20 20 20 54  rigger Name    T
20eb0 61 62 6c 65 20 4e 61 6d 65 20 20 20 20 20 20 2a  able Name      *
20ec0 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
20ed0 5f 43 52 45 41 54 45 5f 56 49 45 57 20 20 20 20  _CREATE_VIEW    
20ee0 20 20 20 20 20 20 20 38 20 20 20 2f 2a 20 56 69         8   /* Vi
20ef0 65 77 20 4e 61 6d 65 20 20 20 20 20 20 20 4e 55  ew Name       NU
20f00 4c 4c 20 20 20 20 20 20 20 20 20 20 20 20 2a 2f  LL            */
20f10 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
20f20 44 45 4c 45 54 45 20 20 20 20 20 20 20 20 20 20  DELETE          
20f30 20 20 20 20 20 20 39 20 20 20 2f 2a 20 54 61 62        9   /* Tab
20f40 6c 65 20 4e 61 6d 65 20 20 20 20 20 20 4e 55 4c  le Name      NUL
20f50 4c 20 20 20 20 20 20 20 20 20 20 20 20 2a 2f 0a  L            */.
20f60 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 44  #define SQLITE_D
20f70 52 4f 50 5f 49 4e 44 45 58 20 20 20 20 20 20 20  ROP_INDEX       
20f80 20 20 20 20 31 30 20 20 20 2f 2a 20 49 6e 64 65      10   /* Inde
20f90 78 20 4e 61 6d 65 20 20 20 20 20 20 54 61 62 6c  x Name      Tabl
20fa0 65 20 4e 61 6d 65 20 20 20 20 20 20 2a 2f 0a 23  e Name      */.#
20fb0 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 44 52  define SQLITE_DR
20fc0 4f 50 5f 54 41 42 4c 45 20 20 20 20 20 20 20 20  OP_TABLE        
20fd0 20 20 20 31 31 20 20 20 2f 2a 20 54 61 62 6c 65     11   /* Table
20fe0 20 4e 61 6d 65 20 20 20 20 20 20 4e 55 4c 4c 20   Name      NULL 
20ff0 20 20 20 20 20 20 20 20 20 20 20 2a 2f 0a 23 64             */.#d
21000 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 44 52 4f  efine SQLITE_DRO
21010 50 5f 54 45 4d 50 5f 49 4e 44 45 58 20 20 20 20  P_TEMP_INDEX    
21020 20 20 31 32 20 20 20 2f 2a 20 49 6e 64 65 78 20    12   /* Index 
21030 4e 61 6d 65 20 20 20 20 20 20 54 61 62 6c 65 20  Name      Table 
21040 4e 61 6d 65 20 20 20 20 20 20 2a 2f 0a 23 64 65  Name      */.#de
21050 66 69 6e 65 20 53 51 4c 49 54 45 5f 44 52 4f 50  fine SQLITE_DROP
21060 5f 54 45 4d 50 5f 54 41 42 4c 45 20 20 20 20 20  _TEMP_TABLE     
21070 20 31 33 20 20 20 2f 2a 20 54 61 62 6c 65 20 4e   13   /* Table N
21080 61 6d 65 20 20 20 20 20 20 4e 55 4c 4c 20 20 20  ame      NULL   
21090 20 20 20 20 20 20 20 20 20 2a 2f 0a 23 64 65 66           */.#def
210a0 69 6e 65 20 53 51 4c 49 54 45 5f 44 52 4f 50 5f  ine SQLITE_DROP_
210b0 54 45 4d 50 5f 54 52 49 47 47 45 52 20 20 20 20  TEMP_TRIGGER    
210c0 31 34 20 20 20 2f 2a 20 54 72 69 67 67 65 72 20  14   /* Trigger 
210d0 4e 61 6d 65 20 20 20 20 54 61 62 6c 65 20 4e 61  Name    Table Na
210e0 6d 65 20 20 20 20 20 20 2a 2f 0a 23 64 65 66 69  me      */.#defi
210f0 6e 65 20 53 51 4c 49 54 45 5f 44 52 4f 50 5f 54  ne SQLITE_DROP_T
21100 45 4d 50 5f 56 49 45 57 20 20 20 20 20 20 20 31  EMP_VIEW       1
21110 35 20 20 20 2f 2a 20 56 69 65 77 20 4e 61 6d 65  5   /* View Name
21120 20 20 20 20 20 20 20 4e 55 4c 4c 20 20 20 20 20         NULL     
21130 20 20 20 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e         */.#defin
21140 65 20 53 51 4c 49 54 45 5f 44 52 4f 50 5f 54 52  e SQLITE_DROP_TR
21150 49 47 47 45 52 20 20 20 20 20 20 20 20 20 31 36  IGGER         16
21160 20 20 20 2f 2a 20 54 72 69 67 67 65 72 20 4e 61     /* Trigger Na
21170 6d 65 20 20 20 20 54 61 62 6c 65 20 4e 61 6d 65  me    Table Name
21180 20 20 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65        */.#define
21190 20 53 51 4c 49 54 45 5f 44 52 4f 50 5f 56 49 45   SQLITE_DROP_VIE
211a0 57 20 20 20 20 20 20 20 20 20 20 20 20 31 37 20  W            17 
211b0 20 20 2f 2a 20 56 69 65 77 20 4e 61 6d 65 20 20    /* View Name  
211c0 20 20 20 20 20 4e 55 4c 4c 20 20 20 20 20 20 20       NULL       
211d0 20 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20       */.#define 
211e0 53 51 4c 49 54 45 5f 49 4e 53 45 52 54 20 20 20  SQLITE_INSERT   
211f0 20 20 20 20 20 20 20 20 20 20 20 20 31 38 20 20              18  
21200 20 2f 2a 20 54 61 62 6c 65 20 4e 61 6d 65 20 20   /* Table Name  
21210 20 20 20 20 4e 55 4c 4c 20 20 20 20 20 20 20 20      NULL        
21220 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53      */.#define S
21230 51 4c 49 54 45 5f 50 52 41 47 4d 41 20 20 20 20  QLITE_PRAGMA    
21240 20 20 20 20 20 20 20 20 20 20 20 31 39 20 20 20             19   
21250 2f 2a 20 50 72 61 67 6d 61 20 4e 61 6d 65 20 20  /* Pragma Name  
21260 20 20 20 31 73 74 20 61 72 67 20 6f 72 20 4e 55     1st arg or NU
21270 4c 4c 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51  LL */.#define SQ
21280 4c 49 54 45 5f 52 45 41 44 20 20 20 20 20 20 20  LITE_READ       
21290 20 20 20 20 20 20 20 20 20 20 32 30 20 20 20 2f            20   /
212a0 2a 20 54 61 62 6c 65 20 4e 61 6d 65 20 20 20 20  * Table Name    
212b0 20 20 43 6f 6c 75 6d 6e 20 4e 61 6d 65 20 20 20    Column Name   
212c0 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c    */.#define SQL
212d0 49 54 45 5f 53 45 4c 45 43 54 20 20 20 20 20 20  ITE_SELECT      
212e0 20 20 20 20 20 20 20 20 20 32 31 20 20 20 2f 2a           21   /*
212f0 20 4e 55 4c 4c 20 20 20 20 20 20 20 20 20 20 20   NULL           
21300 20 4e 55 4c 4c 20 20 20 20 20 20 20 20 20 20 20   NULL           
21310 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
21320 54 45 5f 54 52 41 4e 53 41 43 54 49 4f 4e 20 20  TE_TRANSACTION  
21330 20 20 20 20 20 20 20 20 32 32 20 20 20 2f 2a 20          22   /* 
21340 4f 70 65 72 61 74 69 6f 6e 20 20 20 20 20 20 20  Operation       
21350 4e 55 4c 4c 20 20 20 20 20 20 20 20 20 20 20 20  NULL            
21360 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
21370 45 5f 55 50 44 41 54 45 20 20 20 20 20 20 20 20  E_UPDATE        
21380 20 20 20 20 20 20 20 32 33 20 20 20 2f 2a 20 54         23   /* T
21390 61 62 6c 65 20 4e 61 6d 65 20 20 20 20 20 20 43  able Name      C
213a0 6f 6c 75 6d 6e 20 4e 61 6d 65 20 20 20 20 20 2a  olumn Name     *
213b0 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
213c0 5f 41 54 54 41 43 48 20 20 20 20 20 20 20 20 20  _ATTACH         
213d0 20 20 20 20 20 20 32 34 20 20 20 2f 2a 20 46 69        24   /* Fi
213e0 6c 65 6e 61 6d 65 20 20 20 20 20 20 20 20 4e 55  lename        NU
213f0 4c 4c 20 20 20 20 20 20 20 20 20 20 20 20 2a 2f  LL            */
21400 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
21410 44 45 54 41 43 48 20 20 20 20 20 20 20 20 20 20  DETACH          
21420 20 20 20 20 20 32 35 20 20 20 2f 2a 20 44 61 74       25   /* Dat
21430 61 62 61 73 65 20 4e 61 6d 65 20 20 20 4e 55 4c  abase Name   NUL
21440 4c 20 20 20 20 20 20 20 20 20 20 20 20 2a 2f 0a  L            */.
21450 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 41  #define SQLITE_A
21460 4c 54 45 52 5f 54 41 42 4c 45 20 20 20 20 20 20  LTER_TABLE      
21470 20 20 20 20 32 36 20 20 20 2f 2a 20 44 61 74 61      26   /* Data
21480 62 61 73 65 20 4e 61 6d 65 20 20 20 54 61 62 6c  base Name   Tabl
21490 65 20 4e 61 6d 65 20 20 20 20 20 20 2a 2f 0a 23  e Name      */.#
214a0 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 52 45  define SQLITE_RE
214b0 49 4e 44 45 58 20 20 20 20 20 20 20 20 20 20 20  INDEX           
214c0 20 20 20 32 37 20 20 20 2f 2a 20 49 6e 64 65 78     27   /* Index
214d0 20 4e 61 6d 65 20 20 20 20 20 20 4e 55 4c 4c 20   Name      NULL 
214e0 20 20 20 20 20 20 20 20 20 20 20 2a 2f 0a 23 64             */.#d
214f0 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 41 4e 41  efine SQLITE_ANA
21500 4c 59 5a 45 20 20 20 20 20 20 20 20 20 20 20 20  LYZE            
21510 20 20 32 38 20 20 20 2f 2a 20 54 61 62 6c 65 20    28   /* Table 
21520 4e 61 6d 65 20 20 20 20 20 20 4e 55 4c 4c 20 20  Name      NULL  
21530 20 20 20 20 20 20 20 20 20 20 2a 2f 0a 23 64 65            */.#de
21540 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 52 45 41  fine SQLITE_CREA
21550 54 45 5f 56 54 41 42 4c 45 20 20 20 20 20 20 20  TE_VTABLE       
21560 20 32 39 20 20 20 2f 2a 20 54 61 62 6c 65 20 4e   29   /* Table N
21570 61 6d 65 20 20 20 20 20 20 4d 6f 64 75 6c 65 20  ame      Module 
21580 4e 61 6d 65 20 20 20 20 20 2a 2f 0a 23 64 65 66  Name     */.#def
21590 69 6e 65 20 53 51 4c 49 54 45 5f 44 52 4f 50 5f  ine SQLITE_DROP_
215a0 56 54 41 42 4c 45 20 20 20 20 20 20 20 20 20 20  VTABLE          
215b0 33 30 20 20 20 2f 2a 20 54 61 62 6c 65 20 4e 61  30   /* Table Na
215c0 6d 65 20 20 20 20 20 20 4d 6f 64 75 6c 65 20 4e  me      Module N
215d0 61 6d 65 20 20 20 20 20 2a 2f 0a 23 64 65 66 69  ame     */.#defi
215e0 6e 65 20 53 51 4c 49 54 45 5f 46 55 4e 43 54 49  ne SQLITE_FUNCTI
215f0 4f 4e 20 20 20 20 20 20 20 20 20 20 20 20 20 33  ON             3
21600 31 20 20 20 2f 2a 20 4e 55 4c 4c 20 20 20 20 20  1   /* NULL     
21610 20 20 20 20 20 20 20 46 75 6e 63 74 69 6f 6e 20         Function 
21620 4e 61 6d 65 20 20 20 2a 2f 0a 23 64 65 66 69 6e  Name   */.#defin
21630 65 20 53 51 4c 49 54 45 5f 53 41 56 45 50 4f 49  e SQLITE_SAVEPOI
21640 4e 54 20 20 20 20 20 20 20 20 20 20 20 20 33 32  NT            32
21650 20 20 20 2f 2a 20 4f 70 65 72 61 74 69 6f 6e 20     /* Operation 
21660 20 20 20 20 20 20 53 61 76 65 70 6f 69 6e 74 20        Savepoint 
21670 4e 61 6d 65 20 20 2a 2f 0a 23 64 65 66 69 6e 65  Name  */.#define
21680 20 53 51 4c 49 54 45 5f 43 4f 50 59 20 20 20 20   SQLITE_COPY    
21690 20 20 20 20 20 20 20 20 20 20 20 20 20 20 30 20                0 
216a0 20 20 2f 2a 20 4e 6f 20 6c 6f 6e 67 65 72 20 75    /* No longer u
216b0 73 65 64 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53  sed */.#define S
216c0 51 4c 49 54 45 5f 52 45 43 55 52 53 49 56 45 20  QLITE_RECURSIVE 
216d0 20 20 20 20 20 20 20 20 20 20 20 33 33 20 20 20             33   
216e0 2f 2a 20 4e 55 4c 4c 20 20 20 20 20 20 20 20 20  /* NULL         
216f0 20 20 20 4e 55 4c 4c 20 20 20 20 20 20 20 20 20     NULL         
21700 20 20 20 2a 2f 0a 0a 2f 2a 0a 2a 2a 20 43 41 50     */../*.** CAP
21710 49 33 52 45 46 3a 20 54 72 61 63 69 6e 67 20 41  I3REF: Tracing A
21720 6e 64 20 50 72 6f 66 69 6c 69 6e 67 20 46 75 6e  nd Profiling Fun
21730 63 74 69 6f 6e 73 0a 2a 2a 20 4d 45 54 48 4f 44  ctions.** METHOD
21740 3a 20 73 71 6c 69 74 65 33 0a 2a 2a 0a 2a 2a 20  : sqlite3.**.** 
21750 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20 61  These routines a
21760 72 65 20 64 65 70 72 65 63 61 74 65 64 2e 20 55  re deprecated. U
21770 73 65 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  se the [sqlite3_
21780 74 72 61 63 65 5f 76 32 28 29 5d 20 69 6e 74 65  trace_v2()] inte
21790 72 66 61 63 65 0a 2a 2a 20 69 6e 73 74 65 61 64  rface.** instead
217a0 20 6f 66 20 74 68 65 20 72 6f 75 74 69 6e 65 73   of the routines
217b0 20 64 65 73 63 72 69 62 65 64 20 68 65 72 65 2e   described here.
217c0 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 72 6f 75  .**.** These rou
217d0 74 69 6e 65 73 20 72 65 67 69 73 74 65 72 20 63  tines register c
217e0 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e  allback function
217f0 73 20 74 68 61 74 20 63 61 6e 20 62 65 20 75 73  s that can be us
21800 65 64 20 66 6f 72 0a 2a 2a 20 74 72 61 63 69 6e  ed for.** tracin
21810 67 20 61 6e 64 20 70 72 6f 66 69 6c 69 6e 67 20  g and profiling 
21820 74 68 65 20 65 78 65 63 75 74 69 6f 6e 20 6f 66  the execution of
21830 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73 2e   SQL statements.
21840 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 63 61 6c 6c  .**.** ^The call
21850 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e 20 72 65  back function re
21860 67 69 73 74 65 72 65 64 20 62 79 20 73 71 6c 69  gistered by sqli
21870 74 65 33 5f 74 72 61 63 65 28 29 20 69 73 20 69  te3_trace() is i
21880 6e 76 6f 6b 65 64 20 61 74 0a 2a 2a 20 76 61 72  nvoked at.** var
21890 69 6f 75 73 20 74 69 6d 65 73 20 77 68 65 6e 20  ious times when 
218a0 61 6e 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  an SQL statement
218b0 20 69 73 20 62 65 69 6e 67 20 72 75 6e 20 62 79   is being run by
218c0 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29   [sqlite3_step()
218d0 5d 2e 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74  ]..** ^The sqlit
218e0 65 33 5f 74 72 61 63 65 28 29 20 63 61 6c 6c 62  e3_trace() callb
218f0 61 63 6b 20 69 73 20 69 6e 76 6f 6b 65 64 20 77  ack is invoked w
21900 69 74 68 20 61 20 55 54 46 2d 38 20 72 65 6e 64  ith a UTF-8 rend
21910 65 72 69 6e 67 20 6f 66 20 74 68 65 0a 2a 2a 20  ering of the.** 
21920 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 20 74 65  SQL statement te
21930 78 74 20 61 73 20 74 68 65 20 73 74 61 74 65 6d  xt as the statem
21940 65 6e 74 20 66 69 72 73 74 20 62 65 67 69 6e 73  ent first begins
21950 20 65 78 65 63 75 74 69 6e 67 2e 0a 2a 2a 20 5e   executing..** ^
21960 28 41 64 64 69 74 69 6f 6e 61 6c 20 73 71 6c 69  (Additional sqli
21970 74 65 33 5f 74 72 61 63 65 28 29 20 63 61 6c 6c  te3_trace() call
21980 62 61 63 6b 73 20 6d 69 67 68 74 20 6f 63 63 75  backs might occu
21990 72 0a 2a 2a 20 61 73 20 65 61 63 68 20 74 72 69  r.** as each tri
219a0 67 67 65 72 65 64 20 73 75 62 70 72 6f 67 72 61  ggered subprogra
219b0 6d 20 69 73 20 65 6e 74 65 72 65 64 2e 20 20 54  m is entered.  T
219c0 68 65 20 63 61 6c 6c 62 61 63 6b 73 20 66 6f 72  he callbacks for
219d0 20 74 72 69 67 67 65 72 73 0a 2a 2a 20 63 6f 6e   triggers.** con
219e0 74 61 69 6e 20 61 20 55 54 46 2d 38 20 53 51 4c  tain a UTF-8 SQL
219f0 20 63 6f 6d 6d 65 6e 74 20 74 68 61 74 20 69 64   comment that id
21a00 65 6e 74 69 66 69 65 73 20 74 68 65 20 74 72 69  entifies the tri
21a10 67 67 65 72 2e 29 5e 0a 2a 2a 0a 2a 2a 20 54 68  gger.)^.**.** Th
21a20 65 20 5b 53 51 4c 49 54 45 5f 54 52 41 43 45 5f  e [SQLITE_TRACE_
21a30 53 49 5a 45 5f 4c 49 4d 49 54 5d 20 63 6f 6d 70  SIZE_LIMIT] comp
21a40 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 20  ile-time option 
21a50 63 61 6e 20 62 65 20 75 73 65 64 20 74 6f 20 6c  can be used to l
21a60 69 6d 69 74 0a 2a 2a 20 74 68 65 20 6c 65 6e 67  imit.** the leng
21a70 74 68 20 6f 66 20 5b 62 6f 75 6e 64 20 70 61 72  th of [bound par
21a80 61 6d 65 74 65 72 5d 20 65 78 70 61 6e 73 69 6f  ameter] expansio
21a90 6e 20 69 6e 20 74 68 65 20 6f 75 74 70 75 74 20  n in the output 
21aa0 6f 66 20 73 71 6c 69 74 65 33 5f 74 72 61 63 65  of sqlite3_trace
21ab0 28 29 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 63  ()..**.** ^The c
21ac0 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e  allback function
21ad0 20 72 65 67 69 73 74 65 72 65 64 20 62 79 20 73   registered by s
21ae0 71 6c 69 74 65 33 5f 70 72 6f 66 69 6c 65 28 29  qlite3_profile()
21af0 20 69 73 20 69 6e 76 6f 6b 65 64 0a 2a 2a 20 61   is invoked.** a
21b00 73 20 65 61 63 68 20 53 51 4c 20 73 74 61 74 65  s each SQL state
21b10 6d 65 6e 74 20 66 69 6e 69 73 68 65 73 2e 20 20  ment finishes.  
21b20 5e 54 68 65 20 70 72 6f 66 69 6c 65 20 63 61 6c  ^The profile cal
21b30 6c 62 61 63 6b 20 63 6f 6e 74 61 69 6e 73 0a 2a  lback contains.*
21b40 2a 20 74 68 65 20 6f 72 69 67 69 6e 61 6c 20 73  * the original s
21b50 74 61 74 65 6d 65 6e 74 20 74 65 78 74 20 61 6e  tatement text an
21b60 64 20 61 6e 20 65 73 74 69 6d 61 74 65 20 6f 66  d an estimate of
21b70 20 77 61 6c 6c 2d 63 6c 6f 63 6b 20 74 69 6d 65   wall-clock time
21b80 0a 2a 2a 20 6f 66 20 68 6f 77 20 6c 6f 6e 67 20  .** of how long 
21b90 74 68 61 74 20 73 74 61 74 65 6d 65 6e 74 20 74  that statement t
21ba0 6f 6f 6b 20 74 6f 20 72 75 6e 2e 20 20 5e 54 68  ook to run.  ^Th
21bb0 65 20 70 72 6f 66 69 6c 65 20 63 61 6c 6c 62 61  e profile callba
21bc0 63 6b 0a 2a 2a 20 74 69 6d 65 20 69 73 20 69 6e  ck.** time is in
21bd0 20 75 6e 69 74 73 20 6f 66 20 6e 61 6e 6f 73 65   units of nanose
21be0 63 6f 6e 64 73 2c 20 68 6f 77 65 76 65 72 20 74  conds, however t
21bf0 68 65 20 63 75 72 72 65 6e 74 20 69 6d 70 6c 65  he current imple
21c00 6d 65 6e 74 61 74 69 6f 6e 0a 2a 2a 20 69 73 20  mentation.** is 
21c10 6f 6e 6c 79 20 63 61 70 61 62 6c 65 20 6f 66 20  only capable of 
21c20 6d 69 6c 6c 69 73 65 63 6f 6e 64 20 72 65 73 6f  millisecond reso
21c30 6c 75 74 69 6f 6e 20 73 6f 20 74 68 65 20 73 69  lution so the si
21c40 78 20 6c 65 61 73 74 20 73 69 67 6e 69 66 69 63  x least signific
21c50 61 6e 74 0a 2a 2a 20 64 69 67 69 74 73 20 69 6e  ant.** digits in
21c60 20 74 68 65 20 74 69 6d 65 20 61 72 65 20 6d 65   the time are me
21c70 61 6e 69 6e 67 6c 65 73 73 2e 20 20 46 75 74 75  aningless.  Futu
21c80 72 65 20 76 65 72 73 69 6f 6e 73 20 6f 66 20 53  re versions of S
21c90 51 4c 69 74 65 0a 2a 2a 20 6d 69 67 68 74 20 70  QLite.** might p
21ca0 72 6f 76 69 64 65 20 67 72 65 61 74 65 72 20 72  rovide greater r
21cb0 65 73 6f 6c 75 74 69 6f 6e 20 6f 6e 20 74 68 65  esolution on the
21cc0 20 70 72 6f 66 69 6c 65 72 20 63 61 6c 6c 62 61   profiler callba
21cd0 63 6b 2e 20 20 54 68 65 0a 2a 2a 20 73 71 6c 69  ck.  The.** sqli
21ce0 74 65 33 5f 70 72 6f 66 69 6c 65 28 29 20 66 75  te3_profile() fu
21cf0 6e 63 74 69 6f 6e 20 69 73 20 63 6f 6e 73 69 64  nction is consid
21d00 65 72 65 64 20 65 78 70 65 72 69 6d 65 6e 74 61  ered experimenta
21d10 6c 20 61 6e 64 20 69 73 0a 2a 2a 20 73 75 62 6a  l and is.** subj
21d20 65 63 74 20 74 6f 20 63 68 61 6e 67 65 20 69 6e  ect to change in
21d30 20 66 75 74 75 72 65 20 76 65 72 73 69 6f 6e 73   future versions
21d40 20 6f 66 20 53 51 4c 69 74 65 2e 0a 2a 2f 0a 53   of SQLite..*/.S
21d50 51 4c 49 54 45 5f 44 45 50 52 45 43 41 54 45 44  QLITE_DEPRECATED
21d60 20 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f 74   void *sqlite3_t
21d70 72 61 63 65 28 73 71 6c 69 74 65 33 2a 2c 0a 20  race(sqlite3*,. 
21d80 20 20 76 6f 69 64 28 2a 78 54 72 61 63 65 29 28    void(*xTrace)(
21d90 76 6f 69 64 2a 2c 63 6f 6e 73 74 20 63 68 61 72  void*,const char
21da0 2a 29 2c 20 76 6f 69 64 2a 29 3b 0a 53 51 4c 49  *), void*);.SQLI
21db0 54 45 5f 44 45 50 52 45 43 41 54 45 44 20 76 6f  TE_DEPRECATED vo
21dc0 69 64 20 2a 73 71 6c 69 74 65 33 5f 70 72 6f 66  id *sqlite3_prof
21dd0 69 6c 65 28 73 71 6c 69 74 65 33 2a 2c 0a 20 20  ile(sqlite3*,.  
21de0 20 76 6f 69 64 28 2a 78 50 72 6f 66 69 6c 65 29   void(*xProfile)
21df0 28 76 6f 69 64 2a 2c 63 6f 6e 73 74 20 63 68 61  (void*,const cha
21e00 72 2a 2c 73 71 6c 69 74 65 33 5f 75 69 6e 74 36  r*,sqlite3_uint6
21e10 34 29 2c 20 76 6f 69 64 2a 29 3b 0a 0a 2f 2a 0a  4), void*);../*.
21e20 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 53 51 4c  ** CAPI3REF: SQL
21e30 20 54 72 61 63 65 20 45 76 65 6e 74 20 43 6f 64   Trace Event Cod
21e40 65 73 0a 2a 2a 20 4b 45 59 57 4f 52 44 53 3a 20  es.** KEYWORDS: 
21e50 53 51 4c 49 54 45 5f 54 52 41 43 45 0a 2a 2a 0a  SQLITE_TRACE.**.
21e60 2a 2a 20 54 68 65 73 65 20 63 6f 6e 73 74 61 6e  ** These constan
21e70 74 73 20 69 64 65 6e 74 69 66 79 20 63 6c 61 73  ts identify clas
21e80 73 65 73 20 6f 66 20 65 76 65 6e 74 73 20 74 68  ses of events th
21e90 61 74 20 63 61 6e 20 62 65 20 6d 6f 6e 69 74 6f  at can be monito
21ea0 72 65 64 0a 2a 2a 20 75 73 69 6e 67 20 74 68 65  red.** using the
21eb0 20 5b 73 71 6c 69 74 65 33 5f 74 72 61 63 65 5f   [sqlite3_trace_
21ec0 76 32 28 29 5d 20 74 72 61 63 69 6e 67 20 6c 6f  v2()] tracing lo
21ed0 67 69 63 2e 20 20 54 68 65 20 74 68 69 72 64 20  gic.  The third 
21ee0 61 72 67 75 6d 65 6e 74 0a 2a 2a 20 74 6f 20 5b  argument.** to [
21ef0 73 71 6c 69 74 65 33 5f 74 72 61 63 65 5f 76 32  sqlite3_trace_v2
21f00 28 29 5d 20 69 73 20 61 6e 20 4f 52 2d 65 64 20  ()] is an OR-ed 
21f10 63 6f 6d 62 69 6e 61 74 69 6f 6e 20 6f 66 20 6f  combination of o
21f20 6e 65 20 6f 72 20 6d 6f 72 65 20 6f 66 0a 2a 2a  ne or more of.**
21f30 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 63   the following c
21f40 6f 6e 73 74 61 6e 74 73 2e 20 20 5e 54 68 65 20  onstants.  ^The 
21f50 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20 74  first argument t
21f60 6f 20 74 68 65 20 74 72 61 63 65 20 63 61 6c 6c  o the trace call
21f70 62 61 63 6b 0a 2a 2a 20 69 73 20 6f 6e 65 20 6f  back.** is one o
21f80 66 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20  f the following 
21f90 63 6f 6e 73 74 61 6e 74 73 2e 0a 2a 2a 0a 2a 2a  constants..**.**
21fa0 20 4e 65 77 20 74 72 61 63 69 6e 67 20 63 6f 6e   New tracing con
21fb0 73 74 61 6e 74 73 20 6d 61 79 20 62 65 20 61 64  stants may be ad
21fc0 64 65 64 20 69 6e 20 66 75 74 75 72 65 20 72 65  ded in future re
21fd0 6c 65 61 73 65 73 2e 0a 2a 2a 0a 2a 2a 20 5e 41  leases..**.** ^A
21fe0 20 74 72 61 63 65 20 63 61 6c 6c 62 61 63 6b 20   trace callback 
21ff0 68 61 73 20 66 6f 75 72 20 61 72 67 75 6d 65 6e  has four argumen
22000 74 73 3a 20 78 43 61 6c 6c 62 61 63 6b 28 54 2c  ts: xCallback(T,
22010 43 2c 50 2c 58 29 2e 0a 2a 2a 20 5e 54 68 65 20  C,P,X)..** ^The 
22020 54 20 61 72 67 75 6d 65 6e 74 20 69 73 20 6f 6e  T argument is on
22030 65 20 6f 66 20 74 68 65 20 69 6e 74 65 67 65 72  e of the integer
22040 20 74 79 70 65 20 63 6f 64 65 73 20 61 62 6f 76   type codes abov
22050 65 2e 0a 2a 2a 20 5e 54 68 65 20 43 20 61 72 67  e..** ^The C arg
22060 75 6d 65 6e 74 20 69 73 20 61 20 63 6f 70 79 20  ument is a copy 
22070 6f 66 20 74 68 65 20 63 6f 6e 74 65 78 74 20 70  of the context p
22080 6f 69 6e 74 65 72 20 70 61 73 73 65 64 20 69 6e  ointer passed in
22090 20 61 73 20 74 68 65 0a 2a 2a 20 66 6f 75 72 74   as the.** fourt
220a0 68 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 5b 73  h argument to [s
220b0 71 6c 69 74 65 33 5f 74 72 61 63 65 5f 76 32 28  qlite3_trace_v2(
220c0 29 5d 2e 0a 2a 2a 20 54 68 65 20 50 20 61 6e 64  )]..** The P and
220d0 20 58 20 61 72 67 75 6d 65 6e 74 73 20 61 72 65   X arguments are
220e0 20 70 6f 69 6e 74 65 72 73 20 77 68 6f 73 65 20   pointers whose 
220f0 6d 65 61 6e 69 6e 67 73 20 64 65 70 65 6e 64 20  meanings depend 
22100 6f 6e 20 54 2e 0a 2a 2a 0a 2a 2a 20 3c 64 6c 3e  on T..**.** <dl>
22110 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f 54 52 41  .** [[SQLITE_TRA
22120 43 45 5f 53 54 4d 54 5d 5d 20 3c 64 74 3e 53 51  CE_STMT]] <dt>SQ
22130 4c 49 54 45 5f 54 52 41 43 45 5f 53 54 4d 54 3c  LITE_TRACE_STMT<
22140 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 5e 41 6e 20  /dt>.** <dd>^An 
22150 53 51 4c 49 54 45 5f 54 52 41 43 45 5f 53 54 4d  SQLITE_TRACE_STM
22160 54 20 63 61 6c 6c 62 61 63 6b 20 69 73 20 69 6e  T callback is in
22170 76 6f 6b 65 64 20 77 68 65 6e 20 61 20 70 72 65  voked when a pre
22180 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 0a  pared statement.
22190 2a 2a 20 66 69 72 73 74 20 62 65 67 69 6e 73 20  ** first begins 
221a0 72 75 6e 6e 69 6e 67 20 61 6e 64 20 70 6f 73 73  running and poss
221b0 69 62 6c 79 20 61 74 20 6f 74 68 65 72 20 74 69  ibly at other ti
221c0 6d 65 73 20 64 75 72 69 6e 67 20 74 68 65 0a 2a  mes during the.*
221d0 2a 20 65 78 65 63 75 74 69 6f 6e 20 6f 66 20 74  * execution of t
221e0 68 65 20 70 72 65 70 61 72 65 64 20 73 74 61 74  he prepared stat
221f0 65 6d 65 6e 74 2c 20 73 75 63 68 20 61 73 20 61  ement, such as a
22200 74 20 74 68 65 20 73 74 61 72 74 20 6f 66 20 65  t the start of e
22210 61 63 68 0a 2a 2a 20 74 72 69 67 67 65 72 20 73  ach.** trigger s
22220 75 62 70 72 6f 67 72 61 6d 2e 20 5e 54 68 65 20  ubprogram. ^The 
22230 50 20 61 72 67 75 6d 65 6e 74 20 69 73 20 61 20  P argument is a 
22240 70 6f 69 6e 74 65 72 20 74 6f 20 74 68 65 0a 2a  pointer to the.*
22250 2a 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74  * [prepared stat
22260 65 6d 65 6e 74 5d 2e 20 5e 54 68 65 20 58 20 61  ement]. ^The X a
22270 72 67 75 6d 65 6e 74 20 69 73 20 61 20 70 6f 69  rgument is a poi
22280 6e 74 65 72 20 74 6f 20 61 20 73 74 72 69 6e 67  nter to a string
22290 20 77 68 69 63 68 0a 2a 2a 20 69 73 20 74 68 65   which.** is the
222a0 20 65 78 70 61 6e 64 65 64 20 53 51 4c 20 74 65   expanded SQL te
222b0 78 74 20 6f 66 20 74 68 65 20 70 72 65 70 61 72  xt of the prepar
222c0 65 64 20 73 74 61 74 65 6d 65 6e 74 20 6f 72 20  ed statement or 
222d0 61 20 63 6f 6d 6d 65 6e 74 20 74 68 61 74 0a 2a  a comment that.*
222e0 2a 20 69 6e 64 69 63 61 74 65 73 20 74 68 65 20  * indicates the 
222f0 69 6e 76 6f 63 61 74 69 6f 6e 20 6f 66 20 61 20  invocation of a 
22300 74 72 69 67 67 65 72 2e 0a 2a 2a 0a 2a 2a 20 5b  trigger..**.** [
22310 5b 53 51 4c 49 54 45 5f 54 52 41 43 45 5f 50 52  [SQLITE_TRACE_PR
22320 4f 46 49 4c 45 5d 5d 20 3c 64 74 3e 53 51 4c 49  OFILE]] <dt>SQLI
22330 54 45 5f 54 52 41 43 45 5f 50 52 4f 46 49 4c 45  TE_TRACE_PROFILE
22340 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 5e 41 6e  </dt>.** <dd>^An
22350 20 53 51 4c 49 54 45 5f 54 52 41 43 45 5f 50 52   SQLITE_TRACE_PR
22360 4f 46 49 4c 45 20 63 61 6c 6c 62 61 63 6b 20 70  OFILE callback p
22370 72 6f 76 69 64 65 73 20 61 70 70 72 6f 78 69 6d  rovides approxim
22380 61 74 65 6c 79 20 74 68 65 20 73 61 6d 65 0a 2a  ately the same.*
22390 2a 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 61 73  * information as
223a0 20 69 73 20 70 72 6f 76 69 64 65 64 20 62 79 20   is provided by 
223b0 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 70 72 6f  the [sqlite3_pro
223c0 66 69 6c 65 28 29 5d 20 63 61 6c 6c 62 61 63 6b  file()] callback
223d0 2e 0a 2a 2a 20 5e 54 68 65 20 50 20 61 72 67 75  ..** ^The P argu
223e0 6d 65 6e 74 20 69 73 20 61 20 70 6f 69 6e 74 65  ment is a pointe
223f0 72 20 74 6f 20 74 68 65 20 5b 70 72 65 70 61 72  r to the [prepar
22400 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 61 6e  ed statement] an
22410 64 20 74 68 65 0a 2a 2a 20 58 20 61 72 67 75 6d  d the.** X argum
22420 65 6e 74 20 70 6f 69 6e 74 73 20 74 6f 20 61 20  ent points to a 
22430 36 34 2d 62 69 74 20 69 6e 74 65 67 65 72 20 77  64-bit integer w
22440 68 69 63 68 20 69 73 20 74 68 65 20 65 73 74 69  hich is the esti
22450 6d 61 74 65 64 20 6f 66 0a 2a 2a 20 74 68 65 20  mated of.** the 
22460 6e 75 6d 62 65 72 20 6f 66 20 6e 61 6e 6f 73 65  number of nanose
22470 63 6f 6e 64 20 74 68 61 74 20 74 68 65 20 70 72  cond that the pr
22480 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
22490 20 74 6f 6f 6b 20 74 6f 20 72 75 6e 2e 0a 2a 2a   took to run..**
224a0 20 5e 54 68 65 20 53 51 4c 49 54 45 5f 54 52 41   ^The SQLITE_TRA
224b0 43 45 5f 50 52 4f 46 49 4c 45 20 63 61 6c 6c 62  CE_PROFILE callb
224c0 61 63 6b 20 69 73 20 69 6e 76 6f 6b 65 64 20 77  ack is invoked w
224d0 68 65 6e 20 74 68 65 20 73 74 61 74 65 6d 65 6e  hen the statemen
224e0 74 20 66 69 6e 69 73 68 65 73 2e 0a 2a 2a 0a 2a  t finishes..**.*
224f0 2a 20 5b 5b 53 51 4c 49 54 45 5f 54 52 41 43 45  * [[SQLITE_TRACE
22500 5f 52 4f 57 5d 5d 20 3c 64 74 3e 53 51 4c 49 54  _ROW]] <dt>SQLIT
22510 45 5f 54 52 41 43 45 5f 52 4f 57 3c 2f 64 74 3e  E_TRACE_ROW</dt>
22520 0a 2a 2a 20 3c 64 64 3e 5e 41 6e 20 53 51 4c 49  .** <dd>^An SQLI
22530 54 45 5f 54 52 41 43 45 5f 52 4f 57 20 63 61 6c  TE_TRACE_ROW cal
22540 6c 62 61 63 6b 20 69 73 20 69 6e 76 6f 6b 65 64  lback is invoked
22550 20 77 68 65 6e 65 76 65 72 20 61 20 70 72 65 70   whenever a prep
22560 61 72 65 64 0a 2a 2a 20 73 74 61 74 65 6d 65 6e  ared.** statemen
22570 74 20 67 65 6e 65 72 61 74 65 73 20 61 20 73 69  t generates a si
22580 6e 67 6c 65 20 72 6f 77 20 6f 66 20 72 65 73 75  ngle row of resu
22590 6c 74 2e 20 20 0a 2a 2a 20 5e 54 68 65 20 50 20  lt.  .** ^The P 
225a0 61 72 67 75 6d 65 6e 74 20 69 73 20 61 20 70 6f  argument is a po
225b0 69 6e 74 65 72 20 74 6f 20 74 68 65 20 5b 70 72  inter to the [pr
225c0 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
225d0 5d 20 61 6e 64 20 74 68 65 0a 2a 2a 20 58 20 61  ] and the.** X a
225e0 72 67 75 6d 65 6e 74 20 69 73 20 75 6e 75 73 65  rgument is unuse
225f0 64 2e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54  d..**.** [[SQLIT
22600 45 5f 54 52 41 43 45 5f 43 4c 4f 53 45 5d 5d 20  E_TRACE_CLOSE]] 
22610 3c 64 74 3e 53 51 4c 49 54 45 5f 54 52 41 43 45  <dt>SQLITE_TRACE
22620 5f 43 4c 4f 53 45 3c 2f 64 74 3e 0a 2a 2a 20 3c  _CLOSE</dt>.** <
22630 64 64 3e 5e 41 6e 20 53 51 4c 49 54 45 5f 54 52  dd>^An SQLITE_TR
22640 41 43 45 5f 43 4c 4f 53 45 20 63 61 6c 6c 62 61  ACE_CLOSE callba
22650 63 6b 20 69 73 20 69 6e 76 6f 6b 65 64 20 77 68  ck is invoked wh
22660 65 6e 20 61 20 64 61 74 61 62 61 73 65 0a 2a 2a  en a database.**
22670 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 63 6c 6f 73   connection clos
22680 65 73 2e 0a 2a 2a 20 5e 54 68 65 20 50 20 61 72  es..** ^The P ar
22690 67 75 6d 65 6e 74 20 69 73 20 61 20 70 6f 69 6e  gument is a poin
226a0 74 65 72 20 74 6f 20 74 68 65 20 5b 64 61 74 61  ter to the [data
226b0 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d  base connection]
226c0 20 6f 62 6a 65 63 74 0a 2a 2a 20 61 6e 64 20 74   object.** and t
226d0 68 65 20 58 20 61 72 67 75 6d 65 6e 74 20 69 73  he X argument is
226e0 20 75 6e 75 73 65 64 2e 0a 2a 2a 20 3c 2f 64 6c   unused..** </dl
226f0 3e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c  >.*/.#define SQL
22700 49 54 45 5f 54 52 41 43 45 5f 53 54 4d 54 20 20  ITE_TRACE_STMT  
22710 20 20 20 20 20 30 78 30 31 0a 23 64 65 66 69 6e       0x01.#defin
22720 65 20 53 51 4c 49 54 45 5f 54 52 41 43 45 5f 50  e SQLITE_TRACE_P
22730 52 4f 46 49 4c 45 20 20 20 20 30 78 30 32 0a 23  ROFILE    0x02.#
22740 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 54 52  define SQLITE_TR
22750 41 43 45 5f 52 4f 57 20 20 20 20 20 20 20 20 30  ACE_ROW        0
22760 78 30 34 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  x04.#define SQLI
22770 54 45 5f 54 52 41 43 45 5f 43 4c 4f 53 45 20 20  TE_TRACE_CLOSE  
22780 20 20 20 20 30 78 30 38 0a 0a 2f 2a 0a 2a 2a 20      0x08../*.** 
22790 43 41 50 49 33 52 45 46 3a 20 53 51 4c 20 54 72  CAPI3REF: SQL Tr
227a0 61 63 65 20 48 6f 6f 6b 0a 2a 2a 20 4d 45 54 48  ace Hook.** METH
227b0 4f 44 3a 20 73 71 6c 69 74 65 33 0a 2a 2a 0a 2a  OD: sqlite3.**.*
227c0 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 74  * ^The sqlite3_t
227d0 72 61 63 65 5f 76 32 28 44 2c 4d 2c 58 2c 50 29  race_v2(D,M,X,P)
227e0 20 69 6e 74 65 72 66 61 63 65 20 72 65 67 69 73   interface regis
227f0 74 65 72 73 20 61 20 74 72 61 63 65 20 63 61 6c  ters a trace cal
22800 6c 62 61 63 6b 0a 2a 2a 20 66 75 6e 63 74 69 6f  lback.** functio
22810 6e 20 58 20 61 67 61 69 6e 73 74 20 5b 64 61 74  n X against [dat
22820 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
22830 5d 20 44 2c 20 75 73 69 6e 67 20 70 72 6f 70 65  ] D, using prope
22840 72 74 79 20 6d 61 73 6b 20 4d 0a 2a 2a 20 61 6e  rty mask M.** an
22850 64 20 63 6f 6e 74 65 78 74 20 70 6f 69 6e 74 65  d context pointe
22860 72 20 50 2e 20 20 5e 49 66 20 74 68 65 20 58 20  r P.  ^If the X 
22870 63 61 6c 6c 62 61 63 6b 20 69 73 0a 2a 2a 20 4e  callback is.** N
22880 55 4c 4c 20 6f 72 20 69 66 20 74 68 65 20 4d 20  ULL or if the M 
22890 6d 61 73 6b 20 69 73 20 7a 65 72 6f 2c 20 74 68  mask is zero, th
228a0 65 6e 20 74 72 61 63 69 6e 67 20 69 73 20 64 69  en tracing is di
228b0 73 61 62 6c 65 64 2e 20 20 54 68 65 0a 2a 2a 20  sabled.  The.** 
228c0 4d 20 61 72 67 75 6d 65 6e 74 20 73 68 6f 75 6c  M argument shoul
228d0 64 20 62 65 20 74 68 65 20 62 69 74 77 69 73 65  d be the bitwise
228e0 20 4f 52 2d 65 64 20 63 6f 6d 62 69 6e 61 74 69   OR-ed combinati
228f0 6f 6e 20 6f 66 0a 2a 2a 20 7a 65 72 6f 20 6f 72  on of.** zero or
22900 20 6d 6f 72 65 20 5b 53 51 4c 49 54 45 5f 54 52   more [SQLITE_TR
22910 41 43 45 5d 20 63 6f 6e 73 74 61 6e 74 73 2e 0a  ACE] constants..
22920 2a 2a 0a 2a 2a 20 5e 45 61 63 68 20 63 61 6c 6c  **.** ^Each call
22930 20 74 6f 20 65 69 74 68 65 72 20 73 71 6c 69 74   to either sqlit
22940 65 33 5f 74 72 61 63 65 28 29 20 6f 72 20 73 71  e3_trace() or sq
22950 6c 69 74 65 33 5f 74 72 61 63 65 5f 76 32 28 29  lite3_trace_v2()
22960 20 6f 76 65 72 72 69 64 65 73 20 0a 2a 2a 20 28   overrides .** (
22970 63 61 6e 63 65 6c 73 29 20 61 6e 79 20 70 72 69  cancels) any pri
22980 6f 72 20 63 61 6c 6c 73 20 74 6f 20 73 71 6c 69  or calls to sqli
22990 74 65 33 5f 74 72 61 63 65 28 29 20 6f 72 20 73  te3_trace() or s
229a0 71 6c 69 74 65 33 5f 74 72 61 63 65 5f 76 32 28  qlite3_trace_v2(
229b0 29 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 58 20  )..**.** ^The X 
229c0 63 61 6c 6c 62 61 63 6b 20 69 73 20 69 6e 76 6f  callback is invo
229d0 6b 65 64 20 77 68 65 6e 65 76 65 72 20 61 6e 79  ked whenever any
229e0 20 6f 66 20 74 68 65 20 65 76 65 6e 74 73 20 69   of the events i
229f0 64 65 6e 74 69 66 69 65 64 20 62 79 20 0a 2a 2a  dentified by .**
22a00 20 6d 61 73 6b 20 4d 20 6f 63 63 75 72 2e 20 20   mask M occur.  
22a10 5e 54 68 65 20 69 6e 74 65 67 65 72 20 72 65 74  ^The integer ret
22a20 75 72 6e 20 76 61 6c 75 65 20 66 72 6f 6d 20 74  urn value from t
22a30 68 65 20 63 61 6c 6c 62 61 63 6b 20 69 73 20 63  he callback is c
22a40 75 72 72 65 6e 74 6c 79 0a 2a 2a 20 69 67 6e 6f  urrently.** igno
22a50 72 65 64 2c 20 74 68 6f 75 67 68 20 74 68 69 73  red, though this
22a60 20 6d 61 79 20 63 68 61 6e 67 65 20 69 6e 20 66   may change in f
22a70 75 74 75 72 65 20 72 65 6c 65 61 73 65 73 2e 20  uture releases. 
22a80 20 43 61 6c 6c 62 61 63 6b 0a 2a 2a 20 69 6d 70   Callback.** imp
22a90 6c 65 6d 65 6e 74 61 74 69 6f 6e 73 20 73 68 6f  lementations sho
22aa0 75 6c 64 20 72 65 74 75 72 6e 20 7a 65 72 6f 20  uld return zero 
22ab0 74 6f 20 65 6e 73 75 72 65 20 66 75 74 75 72 65  to ensure future
22ac0 20 63 6f 6d 70 61 74 69 62 69 6c 69 74 79 2e 0a   compatibility..
22ad0 2a 2a 0a 2a 2a 20 5e 41 20 74 72 61 63 65 20 63  **.** ^A trace c
22ae0 61 6c 6c 62 61 63 6b 20 69 73 20 69 6e 76 6f 6b  allback is invok
22af0 65 64 20 77 69 74 68 20 66 6f 75 72 20 61 72 67  ed with four arg
22b00 75 6d 65 6e 74 73 3a 20 63 61 6c 6c 62 61 63 6b  uments: callback
22b10 28 54 2c 43 2c 50 2c 58 29 2e 0a 2a 2a 20 5e 54  (T,C,P,X)..** ^T
22b20 68 65 20 54 20 61 72 67 75 6d 65 6e 74 20 69 73  he T argument is
22b30 20 6f 6e 65 20 6f 66 20 74 68 65 20 5b 53 51 4c   one of the [SQL
22b40 49 54 45 5f 54 52 41 43 45 5d 0a 2a 2a 20 63 6f  ITE_TRACE].** co
22b50 6e 73 74 61 6e 74 73 20 74 6f 20 69 6e 64 69 63  nstants to indic
22b60 61 74 65 20 77 68 79 20 74 68 65 20 63 61 6c 6c  ate why the call
22b70 62 61 63 6b 20 77 61 73 20 69 6e 76 6f 6b 65 64  back was invoked
22b80 2e 0a 2a 2a 20 5e 54 68 65 20 43 20 61 72 67 75  ..** ^The C argu
22b90 6d 65 6e 74 20 69 73 20 61 20 63 6f 70 79 20 6f  ment is a copy o
22ba0 66 20 74 68 65 20 63 6f 6e 74 65 78 74 20 70 6f  f the context po
22bb0 69 6e 74 65 72 2e 0a 2a 2a 20 54 68 65 20 50 20  inter..** The P 
22bc0 61 6e 64 20 58 20 61 72 67 75 6d 65 6e 74 73 20  and X arguments 
22bd0 61 72 65 20 70 6f 69 6e 74 65 72 73 20 77 68 6f  are pointers who
22be0 73 65 20 6d 65 61 6e 69 6e 67 73 20 64 65 70 65  se meanings depe
22bf0 6e 64 20 6f 6e 20 54 2e 0a 2a 2a 0a 2a 2a 20 54  nd on T..**.** T
22c00 68 65 20 73 71 6c 69 74 65 33 5f 74 72 61 63 65  he sqlite3_trace
22c10 5f 76 32 28 29 20 69 6e 74 65 72 66 61 63 65 20  _v2() interface 
22c20 69 73 20 69 6e 74 65 6e 64 65 64 20 74 6f 20 72  is intended to r
22c30 65 70 6c 61 63 65 20 74 68 65 20 6c 65 67 61 63  eplace the legac
22c40 79 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 73 20  y.** interfaces 
22c50 5b 73 71 6c 69 74 65 33 5f 74 72 61 63 65 28 29  [sqlite3_trace()
22c60 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 70  ] and [sqlite3_p
22c70 72 6f 66 69 6c 65 28 29 5d 2c 20 62 6f 74 68 20  rofile()], both 
22c80 6f 66 20 77 68 69 63 68 0a 2a 2a 20 61 72 65 20  of which.** are 
22c90 64 65 70 72 65 63 61 74 65 64 2e 0a 2a 2f 0a 69  deprecated..*/.i
22ca0 6e 74 20 73 71 6c 69 74 65 33 5f 74 72 61 63 65  nt sqlite3_trace
22cb0 5f 76 32 28 0a 20 20 73 71 6c 69 74 65 33 2a 2c  _v2(.  sqlite3*,
22cc0 0a 20 20 75 6e 73 69 67 6e 65 64 20 75 4d 61 73  .  unsigned uMas
22cd0 6b 2c 0a 20 20 69 6e 74 28 2a 78 43 61 6c 6c 62  k,.  int(*xCallb
22ce0 61 63 6b 29 28 75 6e 73 69 67 6e 65 64 2c 76 6f  ack)(unsigned,vo
22cf0 69 64 2a 2c 76 6f 69 64 2a 2c 76 6f 69 64 2a 29  id*,void*,void*)
22d00 2c 0a 20 20 76 6f 69 64 20 2a 70 43 74 78 0a 29  ,.  void *pCtx.)
22d10 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  ;../*.** CAPI3RE
22d20 46 3a 20 51 75 65 72 79 20 50 72 6f 67 72 65 73  F: Query Progres
22d30 73 20 43 61 6c 6c 62 61 63 6b 73 0a 2a 2a 20 4d  s Callbacks.** M
22d40 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 0a 2a  ETHOD: sqlite3.*
22d50 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65  *.** ^The sqlite
22d60 33 5f 70 72 6f 67 72 65 73 73 5f 68 61 6e 64 6c  3_progress_handl
22d70 65 72 28 44 2c 4e 2c 58 2c 50 29 20 69 6e 74 65  er(D,N,X,P) inte
22d80 72 66 61 63 65 20 63 61 75 73 65 73 20 74 68 65  rface causes the
22d90 20 63 61 6c 6c 62 61 63 6b 0a 2a 2a 20 66 75 6e   callback.** fun
22da0 63 74 69 6f 6e 20 58 20 74 6f 20 62 65 20 69 6e  ction X to be in
22db0 76 6f 6b 65 64 20 70 65 72 69 6f 64 69 63 61 6c  voked periodical
22dc0 6c 79 20 64 75 72 69 6e 67 20 6c 6f 6e 67 20 72  ly during long r
22dd0 75 6e 6e 69 6e 67 20 63 61 6c 6c 73 20 74 6f 0a  unning calls to.
22de0 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 65 78 65 63  ** [sqlite3_exec
22df0 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33 5f 73 74  ()], [sqlite3_st
22e00 65 70 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74  ep()] and [sqlit
22e10 65 33 5f 67 65 74 5f 74 61 62 6c 65 28 29 5d 20  e3_get_table()] 
22e20 66 6f 72 0a 2a 2a 20 64 61 74 61 62 61 73 65 20  for.** database 
22e30 63 6f 6e 6e 65 63 74 69 6f 6e 20 44 2e 20 20 41  connection D.  A
22e40 6e 20 65 78 61 6d 70 6c 65 20 75 73 65 20 66 6f  n example use fo
22e50 72 20 74 68 69 73 0a 2a 2a 20 69 6e 74 65 72 66  r this.** interf
22e60 61 63 65 20 69 73 20 74 6f 20 6b 65 65 70 20 61  ace is to keep a
22e70 20 47 55 49 20 75 70 64 61 74 65 64 20 64 75 72   GUI updated dur
22e80 69 6e 67 20 61 20 6c 61 72 67 65 20 71 75 65 72  ing a large quer
22e90 79 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 70 61  y..**.** ^The pa
22ea0 72 61 6d 65 74 65 72 20 50 20 69 73 20 70 61 73  rameter P is pas
22eb0 73 65 64 20 74 68 72 6f 75 67 68 20 61 73 20 74  sed through as t
22ec0 68 65 20 6f 6e 6c 79 20 70 61 72 61 6d 65 74 65  he only paramete
22ed0 72 20 74 6f 20 74 68 65 20 0a 2a 2a 20 63 61 6c  r to the .** cal
22ee0 6c 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e 20 58  lback function X
22ef0 2e 20 20 5e 54 68 65 20 70 61 72 61 6d 65 74 65  .  ^The paramete
22f00 72 20 4e 20 69 73 20 74 68 65 20 61 70 70 72 6f  r N is the appro
22f10 78 69 6d 61 74 65 20 6e 75 6d 62 65 72 20 6f 66  ximate number of
22f20 20 0a 2a 2a 20 5b 76 69 72 74 75 61 6c 20 6d 61   .** [virtual ma
22f30 63 68 69 6e 65 20 69 6e 73 74 72 75 63 74 69 6f  chine instructio
22f40 6e 73 5d 20 74 68 61 74 20 61 72 65 20 65 76 61  ns] that are eva
22f50 6c 75 61 74 65 64 20 62 65 74 77 65 65 6e 20 73  luated between s
22f60 75 63 63 65 73 73 69 76 65 0a 2a 2a 20 69 6e 76  uccessive.** inv
22f70 6f 63 61 74 69 6f 6e 73 20 6f 66 20 74 68 65 20  ocations of the 
22f80 63 61 6c 6c 62 61 63 6b 20 58 2e 20 20 5e 49 66  callback X.  ^If
22f90 20 4e 20 69 73 20 6c 65 73 73 20 74 68 61 6e 20   N is less than 
22fa0 6f 6e 65 20 74 68 65 6e 20 74 68 65 20 70 72 6f  one then the pro
22fb0 67 72 65 73 73 0a 2a 2a 20 68 61 6e 64 6c 65 72  gress.** handler
22fc0 20 69 73 20 64 69 73 61 62 6c 65 64 2e 0a 2a 2a   is disabled..**
22fd0 0a 2a 2a 20 5e 4f 6e 6c 79 20 61 20 73 69 6e 67  .** ^Only a sing
22fe0 6c 65 20 70 72 6f 67 72 65 73 73 20 68 61 6e 64  le progress hand
22ff0 6c 65 72 20 6d 61 79 20 62 65 20 64 65 66 69 6e  ler may be defin
23000 65 64 20 61 74 20 6f 6e 65 20 74 69 6d 65 20 70  ed at one time p
23010 65 72 0a 2a 2a 20 5b 64 61 74 61 62 61 73 65 20  er.** [database 
23020 63 6f 6e 6e 65 63 74 69 6f 6e 5d 3b 20 73 65 74  connection]; set
23030 74 69 6e 67 20 61 20 6e 65 77 20 70 72 6f 67 72  ting a new progr
23040 65 73 73 20 68 61 6e 64 6c 65 72 20 63 61 6e 63  ess handler canc
23050 65 6c 73 20 74 68 65 0a 2a 2a 20 6f 6c 64 20 6f  els the.** old o
23060 6e 65 2e 20 20 5e 53 65 74 74 69 6e 67 20 70 61  ne.  ^Setting pa
23070 72 61 6d 65 74 65 72 20 58 20 74 6f 20 4e 55 4c  rameter X to NUL
23080 4c 20 64 69 73 61 62 6c 65 73 20 74 68 65 20 70  L disables the p
23090 72 6f 67 72 65 73 73 20 68 61 6e 64 6c 65 72 2e  rogress handler.
230a0 0a 2a 2a 20 5e 54 68 65 20 70 72 6f 67 72 65 73  .** ^The progres
230b0 73 20 68 61 6e 64 6c 65 72 20 69 73 20 61 6c 73  s handler is als
230c0 6f 20 64 69 73 61 62 6c 65 64 20 62 79 20 73 65  o disabled by se
230d0 74 74 69 6e 67 20 4e 20 74 6f 20 61 20 76 61 6c  tting N to a val
230e0 75 65 20 6c 65 73 73 0a 2a 2a 20 74 68 61 6e 20  ue less.** than 
230f0 31 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65  1..**.** ^If the
23100 20 70 72 6f 67 72 65 73 73 20 63 61 6c 6c 62 61   progress callba
23110 63 6b 20 72 65 74 75 72 6e 73 20 6e 6f 6e 2d 7a  ck returns non-z
23120 65 72 6f 2c 20 74 68 65 20 6f 70 65 72 61 74 69  ero, the operati
23130 6f 6e 20 69 73 0a 2a 2a 20 69 6e 74 65 72 72 75  on is.** interru
23140 70 74 65 64 2e 20 20 54 68 69 73 20 66 65 61 74  pted.  This feat
23150 75 72 65 20 63 61 6e 20 62 65 20 75 73 65 64 20  ure can be used 
23160 74 6f 20 69 6d 70 6c 65 6d 65 6e 74 20 61 0a 2a  to implement a.*
23170 2a 20 22 43 61 6e 63 65 6c 22 20 62 75 74 74 6f  * "Cancel" butto
23180 6e 20 6f 6e 20 61 20 47 55 49 20 70 72 6f 67 72  n on a GUI progr
23190 65 73 73 20 64 69 61 6c 6f 67 20 62 6f 78 2e 0a  ess dialog box..
231a0 2a 2a 0a 2a 2a 20 54 68 65 20 70 72 6f 67 72 65  **.** The progre
231b0 73 73 20 68 61 6e 64 6c 65 72 20 63 61 6c 6c 62  ss handler callb
231c0 61 63 6b 20 6d 75 73 74 20 6e 6f 74 20 64 6f 20  ack must not do 
231d0 61 6e 79 74 68 69 6e 67 20 74 68 61 74 20 77 69  anything that wi
231e0 6c 6c 20 6d 6f 64 69 66 79 0a 2a 2a 20 74 68 65  ll modify.** the
231f0 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63   database connec
23200 74 69 6f 6e 20 74 68 61 74 20 69 6e 76 6f 6b 65  tion that invoke
23210 64 20 74 68 65 20 70 72 6f 67 72 65 73 73 20 68  d the progress h
23220 61 6e 64 6c 65 72 2e 0a 2a 2a 20 4e 6f 74 65 20  andler..** Note 
23230 74 68 61 74 20 5b 73 71 6c 69 74 65 33 5f 70 72  that [sqlite3_pr
23240 65 70 61 72 65 5f 76 32 28 29 5d 20 61 6e 64 20  epare_v2()] and 
23250 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d  [sqlite3_step()]
23260 20 62 6f 74 68 20 6d 6f 64 69 66 79 20 74 68 65   both modify the
23270 69 72 0a 2a 2a 20 64 61 74 61 62 61 73 65 20 63  ir.** database c
23280 6f 6e 6e 65 63 74 69 6f 6e 73 20 66 6f 72 20 74  onnections for t
23290 68 65 20 6d 65 61 6e 69 6e 67 20 6f 66 20 22 6d  he meaning of "m
232a0 6f 64 69 66 79 22 20 69 6e 20 74 68 69 73 20 70  odify" in this p
232b0 61 72 61 67 72 61 70 68 2e 0a 2a 2a 0a 2a 2f 0a  aragraph..**.*/.
232c0 76 6f 69 64 20 73 71 6c 69 74 65 33 5f 70 72 6f  void sqlite3_pro
232d0 67 72 65 73 73 5f 68 61 6e 64 6c 65 72 28 73 71  gress_handler(sq
232e0 6c 69 74 65 33 2a 2c 20 69 6e 74 2c 20 69 6e 74  lite3*, int, int
232f0 28 2a 29 28 76 6f 69 64 2a 29 2c 20 76 6f 69 64  (*)(void*), void
23300 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33  *);../*.** CAPI3
23310 52 45 46 3a 20 4f 70 65 6e 69 6e 67 20 41 20 4e  REF: Opening A N
23320 65 77 20 44 61 74 61 62 61 73 65 20 43 6f 6e 6e  ew Database Conn
23330 65 63 74 69 6f 6e 0a 2a 2a 20 43 4f 4e 53 54 52  ection.** CONSTR
23340 55 43 54 4f 52 3a 20 73 71 6c 69 74 65 33 0a 2a  UCTOR: sqlite3.*
23350 2a 0a 2a 2a 20 5e 54 68 65 73 65 20 72 6f 75 74  *.** ^These rout
23360 69 6e 65 73 20 6f 70 65 6e 20 61 6e 20 53 51 4c  ines open an SQL
23370 69 74 65 20 64 61 74 61 62 61 73 65 20 66 69 6c  ite database fil
23380 65 20 61 73 20 73 70 65 63 69 66 69 65 64 20 62  e as specified b
23390 79 20 74 68 65 20 0a 2a 2a 20 66 69 6c 65 6e 61  y the .** filena
233a0 6d 65 20 61 72 67 75 6d 65 6e 74 2e 20 5e 54 68  me argument. ^Th
233b0 65 20 66 69 6c 65 6e 61 6d 65 20 61 72 67 75 6d  e filename argum
233c0 65 6e 74 20 69 73 20 69 6e 74 65 72 70 72 65 74  ent is interpret
233d0 65 64 20 61 73 20 55 54 46 2d 38 20 66 6f 72 0a  ed as UTF-8 for.
233e0 2a 2a 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28  ** sqlite3_open(
233f0 29 20 61 6e 64 20 73 71 6c 69 74 65 33 5f 6f 70  ) and sqlite3_op
23400 65 6e 5f 76 32 28 29 20 61 6e 64 20 61 73 20 55  en_v2() and as U
23410 54 46 2d 31 36 20 69 6e 20 74 68 65 20 6e 61 74  TF-16 in the nat
23420 69 76 65 20 62 79 74 65 0a 2a 2a 20 6f 72 64 65  ive byte.** orde
23430 72 20 66 6f 72 20 73 71 6c 69 74 65 33 5f 6f 70  r for sqlite3_op
23440 65 6e 31 36 28 29 2e 20 5e 28 41 20 5b 64 61 74  en16(). ^(A [dat
23450 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
23460 5d 20 68 61 6e 64 6c 65 20 69 73 20 75 73 75 61  ] handle is usua
23470 6c 6c 79 0a 2a 2a 20 72 65 74 75 72 6e 65 64 20  lly.** returned 
23480 69 6e 20 2a 70 70 44 62 2c 20 65 76 65 6e 20 69  in *ppDb, even i
23490 66 20 61 6e 20 65 72 72 6f 72 20 6f 63 63 75 72  f an error occur
234a0 73 2e 20 20 54 68 65 20 6f 6e 6c 79 20 65 78 63  s.  The only exc
234b0 65 70 74 69 6f 6e 20 69 73 20 74 68 61 74 0a 2a  eption is that.*
234c0 2a 20 69 66 20 53 51 4c 69 74 65 20 69 73 20 75  * if SQLite is u
234d0 6e 61 62 6c 65 20 74 6f 20 61 6c 6c 6f 63 61 74  nable to allocat
234e0 65 20 6d 65 6d 6f 72 79 20 74 6f 20 68 6f 6c 64  e memory to hold
234f0 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5d 20 6f   the [sqlite3] o
23500 62 6a 65 63 74 2c 0a 2a 2a 20 61 20 4e 55 4c 4c  bject,.** a NULL
23510 20 77 69 6c 6c 20 62 65 20 77 72 69 74 74 65 6e   will be written
23520 20 69 6e 74 6f 20 2a 70 70 44 62 20 69 6e 73 74   into *ppDb inst
23530 65 61 64 20 6f 66 20 61 20 70 6f 69 6e 74 65 72  ead of a pointer
23540 20 74 6f 20 74 68 65 20 5b 73 71 6c 69 74 65 33   to the [sqlite3
23550 5d 0a 2a 2a 20 6f 62 6a 65 63 74 2e 29 5e 20 5e  ].** object.)^ ^
23560 28 49 66 20 74 68 65 20 64 61 74 61 62 61 73 65  (If the database
23570 20 69 73 20 6f 70 65 6e 65 64 20 28 61 6e 64 2f   is opened (and/
23580 6f 72 20 63 72 65 61 74 65 64 29 20 73 75 63 63  or created) succ
23590 65 73 73 66 75 6c 6c 79 2c 20 74 68 65 6e 0a 2a  essfully, then.*
235a0 2a 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d 20 69 73  * [SQLITE_OK] is
235b0 20 72 65 74 75 72 6e 65 64 2e 20 20 4f 74 68 65   returned.  Othe
235c0 72 77 69 73 65 20 61 6e 20 5b 65 72 72 6f 72 20  rwise an [error 
235d0 63 6f 64 65 5d 20 69 73 20 72 65 74 75 72 6e 65  code] is returne
235e0 64 2e 29 5e 20 5e 54 68 65 0a 2a 2a 20 5b 73 71  d.)^ ^The.** [sq
235f0 6c 69 74 65 33 5f 65 72 72 6d 73 67 28 29 5d 20  lite3_errmsg()] 
23600 6f 72 20 5b 73 71 6c 69 74 65 33 5f 65 72 72 6d  or [sqlite3_errm
23610 73 67 31 36 28 29 5d 20 72 6f 75 74 69 6e 65 73  sg16()] routines
23620 20 63 61 6e 20 62 65 20 75 73 65 64 20 74 6f 20   can be used to 
23630 6f 62 74 61 69 6e 0a 2a 2a 20 61 6e 20 45 6e 67  obtain.** an Eng
23640 6c 69 73 68 20 6c 61 6e 67 75 61 67 65 20 64 65  lish language de
23650 73 63 72 69 70 74 69 6f 6e 20 6f 66 20 74 68 65  scription of the
23660 20 65 72 72 6f 72 20 66 6f 6c 6c 6f 77 69 6e 67   error following
23670 20 61 20 66 61 69 6c 75 72 65 20 6f 66 20 61 6e   a failure of an
23680 79 0a 2a 2a 20 6f 66 20 74 68 65 20 73 71 6c 69  y.** of the sqli
23690 74 65 33 5f 6f 70 65 6e 28 29 20 72 6f 75 74 69  te3_open() routi
236a0 6e 65 73 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  nes..**.** ^The 
236b0 64 65 66 61 75 6c 74 20 65 6e 63 6f 64 69 6e 67  default encoding
236c0 20 77 69 6c 6c 20 62 65 20 55 54 46 2d 38 20 66   will be UTF-8 f
236d0 6f 72 20 64 61 74 61 62 61 73 65 73 20 63 72 65  or databases cre
236e0 61 74 65 64 20 75 73 69 6e 67 0a 2a 2a 20 73 71  ated using.** sq
236f0 6c 69 74 65 33 5f 6f 70 65 6e 28 29 20 6f 72 20  lite3_open() or 
23700 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28  sqlite3_open_v2(
23710 29 2e 20 20 5e 54 68 65 20 64 65 66 61 75 6c 74  ).  ^The default
23720 20 65 6e 63 6f 64 69 6e 67 20 66 6f 72 20 64 61   encoding for da
23730 74 61 62 61 73 65 73 0a 2a 2a 20 63 72 65 61 74  tabases.** creat
23740 65 64 20 75 73 69 6e 67 20 73 71 6c 69 74 65 33  ed using sqlite3
23750 5f 6f 70 65 6e 31 36 28 29 20 77 69 6c 6c 20 62  _open16() will b
23760 65 20 55 54 46 2d 31 36 20 69 6e 20 74 68 65 20  e UTF-16 in the 
23770 6e 61 74 69 76 65 20 62 79 74 65 20 6f 72 64 65  native byte orde
23780 72 2e 0a 2a 2a 0a 2a 2a 20 57 68 65 74 68 65 72  r..**.** Whether
23790 20 6f 72 20 6e 6f 74 20 61 6e 20 65 72 72 6f 72   or not an error
237a0 20 6f 63 63 75 72 73 20 77 68 65 6e 20 69 74 20   occurs when it 
237b0 69 73 20 6f 70 65 6e 65 64 2c 20 72 65 73 6f 75  is opened, resou
237c0 72 63 65 73 0a 2a 2a 20 61 73 73 6f 63 69 61 74  rces.** associat
237d0 65 64 20 77 69 74 68 20 74 68 65 20 5b 64 61 74  ed with the [dat
237e0 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
237f0 5d 20 68 61 6e 64 6c 65 20 73 68 6f 75 6c 64 20  ] handle should 
23800 62 65 20 72 65 6c 65 61 73 65 64 20 62 79 0a 2a  be released by.*
23810 2a 20 70 61 73 73 69 6e 67 20 69 74 20 74 6f 20  * passing it to 
23820 5b 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65 28 29  [sqlite3_close()
23830 5d 20 77 68 65 6e 20 69 74 20 69 73 20 6e 6f 20  ] when it is no 
23840 6c 6f 6e 67 65 72 20 72 65 71 75 69 72 65 64 2e  longer required.
23850 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74  .**.** The sqlit
23860 65 33 5f 6f 70 65 6e 5f 76 32 28 29 20 69 6e 74  e3_open_v2() int
23870 65 72 66 61 63 65 20 77 6f 72 6b 73 20 6c 69 6b  erface works lik
23880 65 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29  e sqlite3_open()
23890 0a 2a 2a 20 65 78 63 65 70 74 20 74 68 61 74 20  .** except that 
238a0 69 74 20 61 63 63 65 70 74 73 20 74 77 6f 20 61  it accepts two a
238b0 64 64 69 74 69 6f 6e 61 6c 20 70 61 72 61 6d 65  dditional parame
238c0 74 65 72 73 20 66 6f 72 20 61 64 64 69 74 69 6f  ters for additio
238d0 6e 61 6c 20 63 6f 6e 74 72 6f 6c 0a 2a 2a 20 6f  nal control.** o
238e0 76 65 72 20 74 68 65 20 6e 65 77 20 64 61 74 61  ver the new data
238f0 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 2e  base connection.
23900 20 20 5e 28 54 68 65 20 66 6c 61 67 73 20 70 61    ^(The flags pa
23910 72 61 6d 65 74 65 72 20 74 6f 0a 2a 2a 20 73 71  rameter to.** sq
23920 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29 20  lite3_open_v2() 
23930 63 61 6e 20 74 61 6b 65 20 6f 6e 65 20 6f 66 0a  can take one of.
23940 2a 2a 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67  ** the following
23950 20 74 68 72 65 65 20 76 61 6c 75 65 73 2c 20 6f   three values, o
23960 70 74 69 6f 6e 61 6c 6c 79 20 63 6f 6d 62 69 6e  ptionally combin
23970 65 64 20 77 69 74 68 20 74 68 65 20 0a 2a 2a 20  ed with the .** 
23980 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 4e 4f 4d  [SQLITE_OPEN_NOM
23990 55 54 45 58 5d 2c 20 5b 53 51 4c 49 54 45 5f 4f  UTEX], [SQLITE_O
239a0 50 45 4e 5f 46 55 4c 4c 4d 55 54 45 58 5d 2c 20  PEN_FULLMUTEX], 
239b0 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 53 48 41  [SQLITE_OPEN_SHA
239c0 52 45 44 43 41 43 48 45 5d 2c 0a 2a 2a 20 5b 53  REDCACHE],.** [S
239d0 51 4c 49 54 45 5f 4f 50 45 4e 5f 50 52 49 56 41  QLITE_OPEN_PRIVA
239e0 54 45 43 41 43 48 45 5d 2c 20 61 6e 64 2f 6f 72  TECACHE], and/or
239f0 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 55 52   [SQLITE_OPEN_UR
23a00 49 5d 20 66 6c 61 67 73 3a 29 5e 0a 2a 2a 0a 2a  I] flags:)^.**.*
23a10 2a 20 3c 64 6c 3e 0a 2a 2a 20 5e 28 3c 64 74 3e  * <dl>.** ^(<dt>
23a20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 52 45 41  [SQLITE_OPEN_REA
23a30 44 4f 4e 4c 59 5d 3c 2f 64 74 3e 0a 2a 2a 20 3c  DONLY]</dt>.** <
23a40 64 64 3e 54 68 65 20 64 61 74 61 62 61 73 65 20  dd>The database 
23a50 69 73 20 6f 70 65 6e 65 64 20 69 6e 20 72 65 61  is opened in rea
23a60 64 2d 6f 6e 6c 79 20 6d 6f 64 65 2e 20 20 49 66  d-only mode.  If
23a70 20 74 68 65 20 64 61 74 61 62 61 73 65 20 64 6f   the database do
23a80 65 73 20 6e 6f 74 0a 2a 2a 20 61 6c 72 65 61 64  es not.** alread
23a90 79 20 65 78 69 73 74 2c 20 61 6e 20 65 72 72 6f  y exist, an erro
23aa0 72 20 69 73 20 72 65 74 75 72 6e 65 64 2e 3c 2f  r is returned.</
23ab0 64 64 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 28 3c 64  dd>)^.**.** ^(<d
23ac0 74 3e 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 52  t>[SQLITE_OPEN_R
23ad0 45 41 44 57 52 49 54 45 5d 3c 2f 64 74 3e 0a 2a  EADWRITE]</dt>.*
23ae0 2a 20 3c 64 64 3e 54 68 65 20 64 61 74 61 62 61  * <dd>The databa
23af0 73 65 20 69 73 20 6f 70 65 6e 65 64 20 66 6f 72  se is opened for
23b00 20 72 65 61 64 69 6e 67 20 61 6e 64 20 77 72 69   reading and wri
23b10 74 69 6e 67 20 69 66 20 70 6f 73 73 69 62 6c 65  ting if possible
23b20 2c 20 6f 72 20 72 65 61 64 69 6e 67 0a 2a 2a 20  , or reading.** 
23b30 6f 6e 6c 79 20 69 66 20 74 68 65 20 66 69 6c 65  only if the file
23b40 20 69 73 20 77 72 69 74 65 20 70 72 6f 74 65 63   is write protec
23b50 74 65 64 20 62 79 20 74 68 65 20 6f 70 65 72 61  ted by the opera
23b60 74 69 6e 67 20 73 79 73 74 65 6d 2e 20 20 49 6e  ting system.  In
23b70 20 65 69 74 68 65 72 0a 2a 2a 20 63 61 73 65 20   either.** case 
23b80 74 68 65 20 64 61 74 61 62 61 73 65 20 6d 75 73  the database mus
23b90 74 20 61 6c 72 65 61 64 79 20 65 78 69 73 74 2c  t already exist,
23ba0 20 6f 74 68 65 72 77 69 73 65 20 61 6e 20 65 72   otherwise an er
23bb0 72 6f 72 20 69 73 20 72 65 74 75 72 6e 65 64 2e  ror is returned.
23bc0 3c 2f 64 64 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 28  </dd>)^.**.** ^(
23bd0 3c 64 74 3e 5b 53 51 4c 49 54 45 5f 4f 50 45 4e  <dt>[SQLITE_OPEN
23be0 5f 52 45 41 44 57 52 49 54 45 5d 20 7c 20 5b 53  _READWRITE] | [S
23bf0 51 4c 49 54 45 5f 4f 50 45 4e 5f 43 52 45 41 54  QLITE_OPEN_CREAT
23c00 45 5d 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54  E]</dt>.** <dd>T
23c10 68 65 20 64 61 74 61 62 61 73 65 20 69 73 20 6f  he database is o
23c20 70 65 6e 65 64 20 66 6f 72 20 72 65 61 64 69 6e  pened for readin
23c30 67 20 61 6e 64 20 77 72 69 74 69 6e 67 2c 20 61  g and writing, a
23c40 6e 64 20 69 73 20 63 72 65 61 74 65 64 20 69 66  nd is created if
23c50 0a 2a 2a 20 69 74 20 64 6f 65 73 20 6e 6f 74 20  .** it does not 
23c60 61 6c 72 65 61 64 79 20 65 78 69 73 74 2e 20 54  already exist. T
23c70 68 69 73 20 69 73 20 74 68 65 20 62 65 68 61 76  his is the behav
23c80 69 6f 72 20 74 68 61 74 20 69 73 20 61 6c 77 61  ior that is alwa
23c90 79 73 20 75 73 65 64 20 66 6f 72 0a 2a 2a 20 73  ys used for.** s
23ca0 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29 20 61 6e  qlite3_open() an
23cb0 64 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 31 36  d sqlite3_open16
23cc0 28 29 2e 3c 2f 64 64 3e 29 5e 0a 2a 2a 20 3c 2f  ().</dd>)^.** </
23cd0 64 6c 3e 0a 2a 2a 0a 2a 2a 20 49 66 20 74 68 65  dl>.**.** If the
23ce0 20 33 72 64 20 70 61 72 61 6d 65 74 65 72 20 74   3rd parameter t
23cf0 6f 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76  o sqlite3_open_v
23d00 32 28 29 20 69 73 20 6e 6f 74 20 6f 6e 65 20 6f  2() is not one o
23d10 66 20 74 68 65 0a 2a 2a 20 63 6f 6d 62 69 6e 61  f the.** combina
23d20 74 69 6f 6e 73 20 73 68 6f 77 6e 20 61 62 6f 76  tions shown abov
23d30 65 20 6f 70 74 69 6f 6e 61 6c 6c 79 20 63 6f 6d  e optionally com
23d40 62 69 6e 65 64 20 77 69 74 68 20 6f 74 68 65 72  bined with other
23d50 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e  .** [SQLITE_OPEN
23d60 5f 52 45 41 44 4f 4e 4c 59 20 7c 20 53 51 4c 49  _READONLY | SQLI
23d70 54 45 5f 4f 50 45 4e 5f 2a 20 62 69 74 73 5d 0a  TE_OPEN_* bits].
23d80 2a 2a 20 74 68 65 6e 20 74 68 65 20 62 65 68 61  ** then the beha
23d90 76 69 6f 72 20 69 73 20 75 6e 64 65 66 69 6e 65  vior is undefine
23da0 64 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65  d..**.** ^If the
23db0 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 4e 4f   [SQLITE_OPEN_NO
23dc0 4d 55 54 45 58 5d 20 66 6c 61 67 20 69 73 20 73  MUTEX] flag is s
23dd0 65 74 2c 20 74 68 65 6e 20 74 68 65 20 64 61 74  et, then the dat
23de0 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
23df0 0a 2a 2a 20 6f 70 65 6e 73 20 69 6e 20 74 68 65  .** opens in the
23e00 20 6d 75 6c 74 69 2d 74 68 72 65 61 64 20 5b 74   multi-thread [t
23e10 68 72 65 61 64 69 6e 67 20 6d 6f 64 65 5d 20 61  hreading mode] a
23e20 73 20 6c 6f 6e 67 20 61 73 20 74 68 65 20 73 69  s long as the si
23e30 6e 67 6c 65 2d 74 68 72 65 61 64 0a 2a 2a 20 6d  ngle-thread.** m
23e40 6f 64 65 20 68 61 73 20 6e 6f 74 20 62 65 65 6e  ode has not been
23e50 20 73 65 74 20 61 74 20 63 6f 6d 70 69 6c 65 2d   set at compile-
23e60 74 69 6d 65 20 6f 72 20 73 74 61 72 74 2d 74 69  time or start-ti
23e70 6d 65 2e 20 20 5e 49 66 20 74 68 65 0a 2a 2a 20  me.  ^If the.** 
23e80 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 46 55 4c  [SQLITE_OPEN_FUL
23e90 4c 4d 55 54 45 58 5d 20 66 6c 61 67 20 69 73 20  LMUTEX] flag is 
23ea0 73 65 74 20 74 68 65 6e 20 74 68 65 20 64 61 74  set then the dat
23eb0 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
23ec0 20 6f 70 65 6e 73 0a 2a 2a 20 69 6e 20 74 68 65   opens.** in the
23ed0 20 73 65 72 69 61 6c 69 7a 65 64 20 5b 74 68 72   serialized [thr
23ee0 65 61 64 69 6e 67 20 6d 6f 64 65 5d 20 75 6e 6c  eading mode] unl
23ef0 65 73 73 20 73 69 6e 67 6c 65 2d 74 68 72 65 61  ess single-threa
23f00 64 20 77 61 73 0a 2a 2a 20 70 72 65 76 69 6f 75  d was.** previou
23f10 73 6c 79 20 73 65 6c 65 63 74 65 64 20 61 74 20  sly selected at 
23f20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 72 20  compile-time or 
23f30 73 74 61 72 74 2d 74 69 6d 65 2e 0a 2a 2a 20 5e  start-time..** ^
23f40 54 68 65 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e  The [SQLITE_OPEN
23f50 5f 53 48 41 52 45 44 43 41 43 48 45 5d 20 66 6c  _SHAREDCACHE] fl
23f60 61 67 20 63 61 75 73 65 73 20 74 68 65 20 64 61  ag causes the da
23f70 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
23f80 6e 20 74 6f 20 62 65 0a 2a 2a 20 65 6c 69 67 69  n to be.** eligi
23f90 62 6c 65 20 74 6f 20 75 73 65 20 5b 73 68 61 72  ble to use [shar
23fa0 65 64 20 63 61 63 68 65 20 6d 6f 64 65 5d 2c 20  ed cache mode], 
23fb0 72 65 67 61 72 64 6c 65 73 73 20 6f 66 20 77 68  regardless of wh
23fc0 65 74 68 65 72 20 6f 72 20 6e 6f 74 20 73 68 61  ether or not sha
23fd0 72 65 64 0a 2a 2a 20 63 61 63 68 65 20 69 73 20  red.** cache is 
23fe0 65 6e 61 62 6c 65 64 20 75 73 69 6e 67 20 5b 73  enabled using [s
23ff0 71 6c 69 74 65 33 5f 65 6e 61 62 6c 65 5f 73 68  qlite3_enable_sh
24000 61 72 65 64 5f 63 61 63 68 65 28 29 5d 2e 20 20  ared_cache()].  
24010 5e 54 68 65 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f  ^The.** [SQLITE_
24020 4f 50 45 4e 5f 50 52 49 56 41 54 45 43 41 43 48  OPEN_PRIVATECACH
24030 45 5d 20 66 6c 61 67 20 63 61 75 73 65 73 20 74  E] flag causes t
24040 68 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  he database conn
24050 65 63 74 69 6f 6e 20 74 6f 20 6e 6f 74 0a 2a 2a  ection to not.**
24060 20 70 61 72 74 69 63 69 70 61 74 65 20 69 6e 20   participate in 
24070 5b 73 68 61 72 65 64 20 63 61 63 68 65 20 6d 6f  [shared cache mo
24080 64 65 5d 20 65 76 65 6e 20 69 66 20 69 74 20 69  de] even if it i
24090 73 20 65 6e 61 62 6c 65 64 2e 0a 2a 2a 0a 2a 2a  s enabled..**.**
240a0 20 5e 54 68 65 20 66 6f 75 72 74 68 20 70 61 72   ^The fourth par
240b0 61 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65  ameter to sqlite
240c0 33 5f 6f 70 65 6e 5f 76 32 28 29 20 69 73 20 74  3_open_v2() is t
240d0 68 65 20 6e 61 6d 65 20 6f 66 20 74 68 65 0a 2a  he name of the.*
240e0 2a 20 5b 73 71 6c 69 74 65 33 5f 76 66 73 5d 20  * [sqlite3_vfs] 
240f0 6f 62 6a 65 63 74 20 74 68 61 74 20 64 65 66 69  object that defi
24100 6e 65 73 20 74 68 65 20 6f 70 65 72 61 74 69 6e  nes the operatin
24110 67 20 73 79 73 74 65 6d 20 69 6e 74 65 72 66 61  g system interfa
24120 63 65 20 74 68 61 74 0a 2a 2a 20 74 68 65 20 6e  ce that.** the n
24130 65 77 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  ew database conn
24140 65 63 74 69 6f 6e 20 73 68 6f 75 6c 64 20 75 73  ection should us
24150 65 2e 20 20 5e 49 66 20 74 68 65 20 66 6f 75 72  e.  ^If the four
24160 74 68 20 70 61 72 61 6d 65 74 65 72 20 69 73 0a  th parameter is.
24170 2a 2a 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  ** a NULL pointe
24180 72 20 74 68 65 6e 20 74 68 65 20 64 65 66 61 75  r then the defau
24190 6c 74 20 5b 73 71 6c 69 74 65 33 5f 76 66 73 5d  lt [sqlite3_vfs]
241a0 20 6f 62 6a 65 63 74 20 69 73 20 75 73 65 64 2e   object is used.
241b0 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20 66  .**.** ^If the f
241c0 69 6c 65 6e 61 6d 65 20 69 73 20 22 3a 6d 65 6d  ilename is ":mem
241d0 6f 72 79 3a 22 2c 20 74 68 65 6e 20 61 20 70 72  ory:", then a pr
241e0 69 76 61 74 65 2c 20 74 65 6d 70 6f 72 61 72 79  ivate, temporary
241f0 20 69 6e 2d 6d 65 6d 6f 72 79 20 64 61 74 61 62   in-memory datab
24200 61 73 65 0a 2a 2a 20 69 73 20 63 72 65 61 74 65  ase.** is create
24210 64 20 66 6f 72 20 74 68 65 20 63 6f 6e 6e 65 63  d for the connec
24220 74 69 6f 6e 2e 20 20 5e 54 68 69 73 20 69 6e 2d  tion.  ^This in-
24230 6d 65 6d 6f 72 79 20 64 61 74 61 62 61 73 65 20  memory database 
24240 77 69 6c 6c 20 76 61 6e 69 73 68 20 77 68 65 6e  will vanish when
24250 0a 2a 2a 20 74 68 65 20 64 61 74 61 62 61 73 65  .** the database
24260 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 69 73 20 63   connection is c
24270 6c 6f 73 65 64 2e 20 20 46 75 74 75 72 65 20 76  losed.  Future v
24280 65 72 73 69 6f 6e 73 20 6f 66 20 53 51 4c 69 74  ersions of SQLit
24290 65 20 6d 69 67 68 74 0a 2a 2a 20 6d 61 6b 65 20  e might.** make 
242a0 75 73 65 20 6f 66 20 61 64 64 69 74 69 6f 6e 61  use of additiona
242b0 6c 20 73 70 65 63 69 61 6c 20 66 69 6c 65 6e 61  l special filena
242c0 6d 65 73 20 74 68 61 74 20 62 65 67 69 6e 20 77  mes that begin w
242d0 69 74 68 20 74 68 65 20 22 3a 22 20 63 68 61 72  ith the ":" char
242e0 61 63 74 65 72 2e 0a 2a 2a 20 49 74 20 69 73 20  acter..** It is 
242f0 72 65 63 6f 6d 6d 65 6e 64 65 64 20 74 68 61 74  recommended that
24300 20 77 68 65 6e 20 61 20 64 61 74 61 62 61 73 65   when a database
24310 20 66 69 6c 65 6e 61 6d 65 20 61 63 74 75 61 6c   filename actual
24320 6c 79 20 64 6f 65 73 20 62 65 67 69 6e 20 77 69  ly does begin wi
24330 74 68 0a 2a 2a 20 61 20 22 3a 22 20 63 68 61 72  th.** a ":" char
24340 61 63 74 65 72 20 79 6f 75 20 73 68 6f 75 6c 64  acter you should
24350 20 70 72 65 66 69 78 20 74 68 65 20 66 69 6c 65   prefix the file
24360 6e 61 6d 65 20 77 69 74 68 20 61 20 70 61 74 68  name with a path
24370 6e 61 6d 65 20 73 75 63 68 20 61 73 0a 2a 2a 20  name such as.** 
24380 22 2e 2f 22 20 74 6f 20 61 76 6f 69 64 20 61 6d  "./" to avoid am
24390 62 69 67 75 69 74 79 2e 0a 2a 2a 0a 2a 2a 20 5e  biguity..**.** ^
243a0 49 66 20 74 68 65 20 66 69 6c 65 6e 61 6d 65 20  If the filename 
243b0 69 73 20 61 6e 20 65 6d 70 74 79 20 73 74 72 69  is an empty stri
243c0 6e 67 2c 20 74 68 65 6e 20 61 20 70 72 69 76 61  ng, then a priva
243d0 74 65 2c 20 74 65 6d 70 6f 72 61 72 79 0a 2a 2a  te, temporary.**
243e0 20 6f 6e 2d 64 69 73 6b 20 64 61 74 61 62 61 73   on-disk databas
243f0 65 20 77 69 6c 6c 20 62 65 20 63 72 65 61 74 65  e will be create
24400 64 2e 20 20 5e 54 68 69 73 20 70 72 69 76 61 74  d.  ^This privat
24410 65 20 64 61 74 61 62 61 73 65 20 77 69 6c 6c 20  e database will 
24420 62 65 0a 2a 2a 20 61 75 74 6f 6d 61 74 69 63 61  be.** automatica
24430 6c 6c 79 20 64 65 6c 65 74 65 64 20 61 73 20 73  lly deleted as s
24440 6f 6f 6e 20 61 73 20 74 68 65 20 64 61 74 61 62  oon as the datab
24450 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 69  ase connection i
24460 73 20 63 6c 6f 73 65 64 2e 0a 2a 2a 0a 2a 2a 20  s closed..**.** 
24470 5b 5b 55 52 49 20 66 69 6c 65 6e 61 6d 65 73 20  [[URI filenames 
24480 69 6e 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28  in sqlite3_open(
24490 29 5d 5d 20 3c 68 33 3e 55 52 49 20 46 69 6c 65  )]] <h3>URI File
244a0 6e 61 6d 65 73 3c 2f 68 33 3e 0a 2a 2a 0a 2a 2a  names</h3>.**.**
244b0 20 5e 49 66 20 5b 55 52 49 20 66 69 6c 65 6e 61   ^If [URI filena
244c0 6d 65 5d 20 69 6e 74 65 72 70 72 65 74 61 74 69  me] interpretati
244d0 6f 6e 20 69 73 20 65 6e 61 62 6c 65 64 2c 20 61  on is enabled, a
244e0 6e 64 20 74 68 65 20 66 69 6c 65 6e 61 6d 65 20  nd the filename 
244f0 61 72 67 75 6d 65 6e 74 0a 2a 2a 20 62 65 67 69  argument.** begi
24500 6e 73 20 77 69 74 68 20 22 66 69 6c 65 3a 22 2c  ns with "file:",
24510 20 74 68 65 6e 20 74 68 65 20 66 69 6c 65 6e 61   then the filena
24520 6d 65 20 69 73 20 69 6e 74 65 72 70 72 65 74 65  me is interprete
24530 64 20 61 73 20 61 20 55 52 49 2e 20 5e 55 52 49  d as a URI. ^URI
24540 0a 2a 2a 20 66 69 6c 65 6e 61 6d 65 20 69 6e 74  .** filename int
24550 65 72 70 72 65 74 61 74 69 6f 6e 20 69 73 20 65  erpretation is e
24560 6e 61 62 6c 65 64 20 69 66 20 74 68 65 20 5b 53  nabled if the [S
24570 51 4c 49 54 45 5f 4f 50 45 4e 5f 55 52 49 5d 20  QLITE_OPEN_URI] 
24580 66 6c 61 67 20 69 73 0a 2a 2a 20 73 65 74 20 69  flag is.** set i
24590 6e 20 74 68 65 20 66 6f 75 72 74 68 20 61 72 67  n the fourth arg
245a0 75 6d 65 6e 74 20 74 6f 20 73 71 6c 69 74 65 33  ument to sqlite3
245b0 5f 6f 70 65 6e 5f 76 32 28 29 2c 20 6f 72 20 69  _open_v2(), or i
245c0 66 20 69 74 20 68 61 73 0a 2a 2a 20 62 65 65 6e  f it has.** been
245d0 20 65 6e 61 62 6c 65 64 20 67 6c 6f 62 61 6c 6c   enabled globall
245e0 79 20 75 73 69 6e 67 20 74 68 65 20 5b 53 51 4c  y using the [SQL
245f0 49 54 45 5f 43 4f 4e 46 49 47 5f 55 52 49 5d 20  ITE_CONFIG_URI] 
24600 6f 70 74 69 6f 6e 20 77 69 74 68 20 74 68 65 0a  option with the.
24610 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6e 66  ** [sqlite3_conf
24620 69 67 28 29 5d 20 6d 65 74 68 6f 64 20 6f 72 20  ig()] method or 
24630 62 79 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 55  by the [SQLITE_U
24640 53 45 5f 55 52 49 5d 20 63 6f 6d 70 69 6c 65 2d  SE_URI] compile-
24650 74 69 6d 65 20 6f 70 74 69 6f 6e 2e 0a 2a 2a 20  time option..** 
24660 41 73 20 6f 66 20 53 51 4c 69 74 65 20 76 65 72  As of SQLite ver
24670 73 69 6f 6e 20 33 2e 37 2e 37 2c 20 55 52 49 20  sion 3.7.7, URI 
24680 66 69 6c 65 6e 61 6d 65 20 69 6e 74 65 72 70 72  filename interpr
24690 65 74 61 74 69 6f 6e 20 69 73 20 74 75 72 6e 65  etation is turne
246a0 64 20 6f 66 66 0a 2a 2a 20 62 79 20 64 65 66 61  d off.** by defa
246b0 75 6c 74 2c 20 62 75 74 20 66 75 74 75 72 65 20  ult, but future 
246c0 72 65 6c 65 61 73 65 73 20 6f 66 20 53 51 4c 69  releases of SQLi
246d0 74 65 20 6d 69 67 68 74 20 65 6e 61 62 6c 65 20  te might enable 
246e0 55 52 49 20 66 69 6c 65 6e 61 6d 65 0a 2a 2a 20  URI filename.** 
246f0 69 6e 74 65 72 70 72 65 74 61 74 69 6f 6e 20 62  interpretation b
24700 79 20 64 65 66 61 75 6c 74 2e 20 20 53 65 65 20  y default.  See 
24710 22 5b 55 52 49 20 66 69 6c 65 6e 61 6d 65 73 5d  "[URI filenames]
24720 22 20 66 6f 72 20 61 64 64 69 74 69 6f 6e 61 6c  " for additional
24730 0a 2a 2a 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 2e  .** information.
24740 0a 2a 2a 0a 2a 2a 20 55 52 49 20 66 69 6c 65 6e  .**.** URI filen
24750 61 6d 65 73 20 61 72 65 20 70 61 72 73 65 64 20  ames are parsed 
24760 61 63 63 6f 72 64 69 6e 67 20 74 6f 20 52 46 43  according to RFC
24770 20 33 39 38 36 2e 20 5e 49 66 20 74 68 65 20 55   3986. ^If the U
24780 52 49 20 63 6f 6e 74 61 69 6e 73 20 61 6e 0a 2a  RI contains an.*
24790 2a 20 61 75 74 68 6f 72 69 74 79 2c 20 74 68 65  * authority, the
247a0 6e 20 69 74 20 6d 75 73 74 20 62 65 20 65 69 74  n it must be eit
247b0 68 65 72 20 61 6e 20 65 6d 70 74 79 20 73 74 72  her an empty str
247c0 69 6e 67 20 6f 72 20 74 68 65 20 73 74 72 69 6e  ing or the strin
247d0 67 20 0a 2a 2a 20 22 6c 6f 63 61 6c 68 6f 73 74  g .** "localhost
247e0 22 2e 20 5e 49 66 20 74 68 65 20 61 75 74 68 6f  ". ^If the autho
247f0 72 69 74 79 20 69 73 20 6e 6f 74 20 61 6e 20 65  rity is not an e
24800 6d 70 74 79 20 73 74 72 69 6e 67 20 6f 72 20 22  mpty string or "
24810 6c 6f 63 61 6c 68 6f 73 74 22 2c 20 61 6e 20 0a  localhost", an .
24820 2a 2a 20 65 72 72 6f 72 20 69 73 20 72 65 74 75  ** error is retu
24830 72 6e 65 64 20 74 6f 20 74 68 65 20 63 61 6c 6c  rned to the call
24840 65 72 2e 20 5e 54 68 65 20 66 72 61 67 6d 65 6e  er. ^The fragmen
24850 74 20 63 6f 6d 70 6f 6e 65 6e 74 20 6f 66 20 61  t component of a
24860 20 55 52 49 2c 20 69 66 20 0a 2a 2a 20 70 72 65   URI, if .** pre
24870 73 65 6e 74 2c 20 69 73 20 69 67 6e 6f 72 65 64  sent, is ignored
24880 2e 0a 2a 2a 0a 2a 2a 20 5e 53 51 4c 69 74 65 20  ..**.** ^SQLite 
24890 75 73 65 73 20 74 68 65 20 70 61 74 68 20 63 6f  uses the path co
248a0 6d 70 6f 6e 65 6e 74 20 6f 66 20 74 68 65 20 55  mponent of the U
248b0 52 49 20 61 73 20 74 68 65 20 6e 61 6d 65 20 6f  RI as the name o
248c0 66 20 74 68 65 20 64 69 73 6b 20 66 69 6c 65 0a  f the disk file.
248d0 2a 2a 20 77 68 69 63 68 20 63 6f 6e 74 61 69 6e  ** which contain
248e0 73 20 74 68 65 20 64 61 74 61 62 61 73 65 2e 20  s the database. 
248f0 5e 49 66 20 74 68 65 20 70 61 74 68 20 62 65 67  ^If the path beg
24900 69 6e 73 20 77 69 74 68 20 61 20 27 2f 27 20 63  ins with a '/' c
24910 68 61 72 61 63 74 65 72 2c 20 0a 2a 2a 20 74 68  haracter, .** th
24920 65 6e 20 69 74 20 69 73 20 69 6e 74 65 72 70 72  en it is interpr
24930 65 74 65 64 20 61 73 20 61 6e 20 61 62 73 6f 6c  eted as an absol
24940 75 74 65 20 70 61 74 68 2e 20 5e 49 66 20 74 68  ute path. ^If th
24950 65 20 70 61 74 68 20 64 6f 65 73 20 6e 6f 74 20  e path does not 
24960 62 65 67 69 6e 20 0a 2a 2a 20 77 69 74 68 20 61  begin .** with a
24970 20 27 2f 27 20 28 6d 65 61 6e 69 6e 67 20 74 68   '/' (meaning th
24980 61 74 20 74 68 65 20 61 75 74 68 6f 72 69 74 79  at the authority
24990 20 73 65 63 74 69 6f 6e 20 69 73 20 6f 6d 69 74   section is omit
249a0 74 65 64 20 66 72 6f 6d 20 74 68 65 20 55 52 49  ted from the URI
249b0 29 0a 2a 2a 20 74 68 65 6e 20 74 68 65 20 70 61  ).** then the pa
249c0 74 68 20 69 73 20 69 6e 74 65 72 70 72 65 74 65  th is interprete
249d0 64 20 61 73 20 61 20 72 65 6c 61 74 69 76 65 20  d as a relative 
249e0 70 61 74 68 2e 20 0a 2a 2a 20 5e 28 4f 6e 20 77  path. .** ^(On w
249f0 69 6e 64 6f 77 73 2c 20 74 68 65 20 66 69 72 73  indows, the firs
24a00 74 20 63 6f 6d 70 6f 6e 65 6e 74 20 6f 66 20 61  t component of a
24a10 6e 20 61 62 73 6f 6c 75 74 65 20 70 61 74 68 20  n absolute path 
24a20 0a 2a 2a 20 69 73 20 61 20 64 72 69 76 65 20 73  .** is a drive s
24a30 70 65 63 69 66 69 63 61 74 69 6f 6e 20 28 65 2e  pecification (e.
24a40 67 2e 20 22 43 3a 22 29 2e 29 5e 0a 2a 2a 0a 2a  g. "C:").)^.**.*
24a50 2a 20 5b 5b 63 6f 72 65 20 55 52 49 20 71 75 65  * [[core URI que
24a60 72 79 20 70 61 72 61 6d 65 74 65 72 73 5d 5d 0a  ry parameters]].
24a70 2a 2a 20 54 68 65 20 71 75 65 72 79 20 63 6f 6d  ** The query com
24a80 70 6f 6e 65 6e 74 20 6f 66 20 61 20 55 52 49 20  ponent of a URI 
24a90 6d 61 79 20 63 6f 6e 74 61 69 6e 20 70 61 72 61  may contain para
24aa0 6d 65 74 65 72 73 20 74 68 61 74 20 61 72 65 20  meters that are 
24ab0 69 6e 74 65 72 70 72 65 74 65 64 0a 2a 2a 20 65  interpreted.** e
24ac0 69 74 68 65 72 20 62 79 20 53 51 4c 69 74 65 20  ither by SQLite 
24ad0 69 74 73 65 6c 66 2c 20 6f 72 20 62 79 20 61 20  itself, or by a 
24ae0 5b 56 46 53 20 7c 20 63 75 73 74 6f 6d 20 56 46  [VFS | custom VF
24af0 53 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e  S implementation
24b00 5d 2e 0a 2a 2a 20 53 51 4c 69 74 65 20 61 6e 64  ]..** SQLite and
24b10 20 69 74 73 20 62 75 69 6c 74 2d 69 6e 20 5b 56   its built-in [V
24b20 46 53 65 73 5d 20 69 6e 74 65 72 70 72 65 74 20  FSes] interpret 
24b30 74 68 65 0a 2a 2a 20 66 6f 6c 6c 6f 77 69 6e 67  the.** following
24b40 20 71 75 65 72 79 20 70 61 72 61 6d 65 74 65 72   query parameter
24b50 73 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a  s:.**.** <ul>.**
24b60 20 20 20 3c 6c 69 3e 20 3c 62 3e 76 66 73 3c 2f     <li> <b>vfs</
24b70 62 3e 3a 20 5e 54 68 65 20 22 76 66 73 22 20 70  b>: ^The "vfs" p
24b80 61 72 61 6d 65 74 65 72 20 6d 61 79 20 62 65 20  arameter may be 
24b90 75 73 65 64 20 74 6f 20 73 70 65 63 69 66 79 20  used to specify 
24ba0 74 68 65 20 6e 61 6d 65 20 6f 66 0a 2a 2a 20 20  the name of.**  
24bb0 20 20 20 61 20 56 46 53 20 6f 62 6a 65 63 74 20     a VFS object 
24bc0 74 68 61 74 20 70 72 6f 76 69 64 65 73 20 74 68  that provides th
24bd0 65 20 6f 70 65 72 61 74 69 6e 67 20 73 79 73 74  e operating syst
24be0 65 6d 20 69 6e 74 65 72 66 61 63 65 20 74 68 61  em interface tha
24bf0 74 20 73 68 6f 75 6c 64 0a 2a 2a 20 20 20 20 20  t should.**     
24c00 62 65 20 75 73 65 64 20 74 6f 20 61 63 63 65 73  be used to acces
24c10 73 20 74 68 65 20 64 61 74 61 62 61 73 65 20 66  s the database f
24c20 69 6c 65 20 6f 6e 20 64 69 73 6b 2e 20 5e 49 66  ile on disk. ^If
24c30 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20   this option is 
24c40 73 65 74 20 74 6f 0a 2a 2a 20 20 20 20 20 61 6e  set to.**     an
24c50 20 65 6d 70 74 79 20 73 74 72 69 6e 67 20 74 68   empty string th
24c60 65 20 64 65 66 61 75 6c 74 20 56 46 53 20 6f 62  e default VFS ob
24c70 6a 65 63 74 20 69 73 20 75 73 65 64 2e 20 5e 53  ject is used. ^S
24c80 70 65 63 69 66 79 69 6e 67 20 61 6e 20 75 6e 6b  pecifying an unk
24c90 6e 6f 77 6e 0a 2a 2a 20 20 20 20 20 56 46 53 20  nown.**     VFS 
24ca0 69 73 20 61 6e 20 65 72 72 6f 72 2e 20 5e 49 66  is an error. ^If
24cb0 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32   sqlite3_open_v2
24cc0 28 29 20 69 73 20 75 73 65 64 20 61 6e 64 20 74  () is used and t
24cd0 68 65 20 76 66 73 20 6f 70 74 69 6f 6e 20 69 73  he vfs option is
24ce0 0a 2a 2a 20 20 20 20 20 70 72 65 73 65 6e 74 2c  .**     present,
24cf0 20 74 68 65 6e 20 74 68 65 20 56 46 53 20 73 70   then the VFS sp
24d00 65 63 69 66 69 65 64 20 62 79 20 74 68 65 20 6f  ecified by the o
24d10 70 74 69 6f 6e 20 74 61 6b 65 73 20 70 72 65 63  ption takes prec
24d20 65 64 65 6e 63 65 20 6f 76 65 72 0a 2a 2a 20 20  edence over.**  
24d30 20 20 20 74 68 65 20 76 61 6c 75 65 20 70 61 73     the value pas
24d40 73 65 64 20 61 73 20 74 68 65 20 66 6f 75 72 74  sed as the fourt
24d50 68 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 73  h parameter to s
24d60 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29  qlite3_open_v2()
24d70 2e 0a 2a 2a 0a 2a 2a 20 20 20 3c 6c 69 3e 20 3c  ..**.**   <li> <
24d80 62 3e 6d 6f 64 65 3c 2f 62 3e 3a 20 5e 28 54 68  b>mode</b>: ^(Th
24d90 65 20 6d 6f 64 65 20 70 61 72 61 6d 65 74 65 72  e mode parameter
24da0 20 6d 61 79 20 62 65 20 73 65 74 20 74 6f 20 65   may be set to e
24db0 69 74 68 65 72 20 22 72 6f 22 2c 20 22 72 77 22  ither "ro", "rw"
24dc0 2c 0a 2a 2a 20 20 20 20 20 22 72 77 63 22 2c 20  ,.**     "rwc", 
24dd0 6f 72 20 22 6d 65 6d 6f 72 79 22 2e 20 41 74 74  or "memory". Att
24de0 65 6d 70 74 69 6e 67 20 74 6f 20 73 65 74 20 69  empting to set i
24df0 74 20 74 6f 20 61 6e 79 20 6f 74 68 65 72 20 76  t to any other v
24e00 61 6c 75 65 20 69 73 0a 2a 2a 20 20 20 20 20 61  alue is.**     a
24e10 6e 20 65 72 72 6f 72 29 5e 2e 20 0a 2a 2a 20 20  n error)^. .**  
24e20 20 20 20 5e 49 66 20 22 72 6f 22 20 69 73 20 73     ^If "ro" is s
24e30 70 65 63 69 66 69 65 64 2c 20 74 68 65 6e 20 74  pecified, then t
24e40 68 65 20 64 61 74 61 62 61 73 65 20 69 73 20 6f  he database is o
24e50 70 65 6e 65 64 20 66 6f 72 20 72 65 61 64 2d 6f  pened for read-o
24e60 6e 6c 79 20 0a 2a 2a 20 20 20 20 20 61 63 63 65  nly .**     acce
24e70 73 73 2c 20 6a 75 73 74 20 61 73 20 69 66 20 74  ss, just as if t
24e80 68 65 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  he [SQLITE_OPEN_
24e90 52 45 41 44 4f 4e 4c 59 5d 20 66 6c 61 67 20 68  READONLY] flag h
24ea0 61 64 20 62 65 65 6e 20 73 65 74 20 69 6e 20 74  ad been set in t
24eb0 68 65 20 0a 2a 2a 20 20 20 20 20 74 68 69 72 64  he .**     third
24ec0 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 73 71 6c   argument to sql
24ed0 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29 2e 20  ite3_open_v2(). 
24ee0 5e 49 66 20 74 68 65 20 6d 6f 64 65 20 6f 70 74  ^If the mode opt
24ef0 69 6f 6e 20 69 73 20 73 65 74 20 74 6f 20 0a 2a  ion is set to .*
24f00 2a 20 20 20 20 20 22 72 77 22 2c 20 74 68 65 6e  *     "rw", then
24f10 20 74 68 65 20 64 61 74 61 62 61 73 65 20 69 73   the database is
24f20 20 6f 70 65 6e 65 64 20 66 6f 72 20 72 65 61 64   opened for read
24f30 2d 77 72 69 74 65 20 28 62 75 74 20 6e 6f 74 20  -write (but not 
24f40 63 72 65 61 74 65 29 20 0a 2a 2a 20 20 20 20 20  create) .**     
24f50 61 63 63 65 73 73 2c 20 61 73 20 69 66 20 53 51  access, as if SQ
24f60 4c 49 54 45 5f 4f 50 45 4e 5f 52 45 41 44 57 52  LITE_OPEN_READWR
24f70 49 54 45 20 28 62 75 74 20 6e 6f 74 20 53 51 4c  ITE (but not SQL
24f80 49 54 45 5f 4f 50 45 4e 5f 43 52 45 41 54 45 29  ITE_OPEN_CREATE)
24f90 20 68 61 64 20 0a 2a 2a 20 20 20 20 20 62 65 65   had .**     bee
24fa0 6e 20 73 65 74 2e 20 5e 56 61 6c 75 65 20 22 72  n set. ^Value "r
24fb0 77 63 22 20 69 73 20 65 71 75 69 76 61 6c 65 6e  wc" is equivalen
24fc0 74 20 74 6f 20 73 65 74 74 69 6e 67 20 62 6f 74  t to setting bot
24fd0 68 20 0a 2a 2a 20 20 20 20 20 53 51 4c 49 54 45  h .**     SQLITE
24fe0 5f 4f 50 45 4e 5f 52 45 41 44 57 52 49 54 45 20  _OPEN_READWRITE 
24ff0 61 6e 64 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  and SQLITE_OPEN_
25000 43 52 45 41 54 45 2e 20 20 5e 49 66 20 74 68 65  CREATE.  ^If the
25010 20 6d 6f 64 65 20 6f 70 74 69 6f 6e 20 69 73 0a   mode option is.
25020 2a 2a 20 20 20 20 20 73 65 74 20 74 6f 20 22 6d  **     set to "m
25030 65 6d 6f 72 79 22 20 74 68 65 6e 20 61 20 70 75  emory" then a pu
25040 72 65 20 5b 69 6e 2d 6d 65 6d 6f 72 79 20 64 61  re [in-memory da
25050 74 61 62 61 73 65 5d 20 74 68 61 74 20 6e 65 76  tabase] that nev
25060 65 72 20 72 65 61 64 73 0a 2a 2a 20 20 20 20 20  er reads.**     
25070 6f 72 20 77 72 69 74 65 73 20 66 72 6f 6d 20 64  or writes from d
25080 69 73 6b 20 69 73 20 75 73 65 64 2e 20 5e 49 74  isk is used. ^It
25090 20 69 73 20 61 6e 20 65 72 72 6f 72 20 74 6f 20   is an error to 
250a0 73 70 65 63 69 66 79 20 61 20 76 61 6c 75 65 20  specify a value 
250b0 66 6f 72 0a 2a 2a 20 20 20 20 20 74 68 65 20 6d  for.**     the m
250c0 6f 64 65 20 70 61 72 61 6d 65 74 65 72 20 74 68  ode parameter th
250d0 61 74 20 69 73 20 6c 65 73 73 20 72 65 73 74 72  at is less restr
250e0 69 63 74 69 76 65 20 74 68 61 6e 20 74 68 61 74  ictive than that
250f0 20 73 70 65 63 69 66 69 65 64 20 62 79 0a 2a 2a   specified by.**
25100 20 20 20 20 20 74 68 65 20 66 6c 61 67 73 20 70       the flags p
25110 61 73 73 65 64 20 69 6e 20 74 68 65 20 74 68 69  assed in the thi
25120 72 64 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20  rd parameter to 
25130 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28  sqlite3_open_v2(
25140 29 2e 0a 2a 2a 0a 2a 2a 20 20 20 3c 6c 69 3e 20  )..**.**   <li> 
25150 3c 62 3e 63 61 63 68 65 3c 2f 62 3e 3a 20 5e 54  <b>cache</b>: ^T
25160 68 65 20 63 61 63 68 65 20 70 61 72 61 6d 65 74  he cache paramet
25170 65 72 20 6d 61 79 20 62 65 20 73 65 74 20 74 6f  er may be set to
25180 20 65 69 74 68 65 72 20 22 73 68 61 72 65 64 22   either "shared"
25190 20 6f 72 0a 2a 2a 20 20 20 20 20 22 70 72 69 76   or.**     "priv
251a0 61 74 65 22 2e 20 5e 53 65 74 74 69 6e 67 20 69  ate". ^Setting i
251b0 74 20 74 6f 20 22 73 68 61 72 65 64 22 20 69 73  t to "shared" is
251c0 20 65 71 75 69 76 61 6c 65 6e 74 20 74 6f 20 73   equivalent to s
251d0 65 74 74 69 6e 67 20 74 68 65 0a 2a 2a 20 20 20  etting the.**   
251e0 20 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 53 48    SQLITE_OPEN_SH
251f0 41 52 45 44 43 41 43 48 45 20 62 69 74 20 69 6e  AREDCACHE bit in
25200 20 74 68 65 20 66 6c 61 67 73 20 61 72 67 75 6d   the flags argum
25210 65 6e 74 20 70 61 73 73 65 64 20 74 6f 0a 2a 2a  ent passed to.**
25220 20 20 20 20 20 73 71 6c 69 74 65 33 5f 6f 70 65       sqlite3_ope
25230 6e 5f 76 32 28 29 2e 20 5e 53 65 74 74 69 6e 67  n_v2(). ^Setting
25240 20 74 68 65 20 63 61 63 68 65 20 70 61 72 61 6d   the cache param
25250 65 74 65 72 20 74 6f 20 22 70 72 69 76 61 74 65  eter to "private
25260 22 20 69 73 20 0a 2a 2a 20 20 20 20 20 65 71 75  " is .**     equ
25270 69 76 61 6c 65 6e 74 20 74 6f 20 73 65 74 74 69  ivalent to setti
25280 6e 67 20 74 68 65 20 53 51 4c 49 54 45 5f 4f 50  ng the SQLITE_OP
25290 45 4e 5f 50 52 49 56 41 54 45 43 41 43 48 45 20  EN_PRIVATECACHE 
252a0 62 69 74 2e 0a 2a 2a 20 20 20 20 20 5e 49 66 20  bit..**     ^If 
252b0 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28  sqlite3_open_v2(
252c0 29 20 69 73 20 75 73 65 64 20 61 6e 64 20 74 68  ) is used and th
252d0 65 20 22 63 61 63 68 65 22 20 70 61 72 61 6d 65  e "cache" parame
252e0 74 65 72 20 69 73 20 70 72 65 73 65 6e 74 20 69  ter is present i
252f0 6e 0a 2a 2a 20 20 20 20 20 61 20 55 52 49 20 66  n.**     a URI f
25300 69 6c 65 6e 61 6d 65 2c 20 69 74 73 20 76 61 6c  ilename, its val
25310 75 65 20 6f 76 65 72 72 69 64 65 73 20 61 6e 79  ue overrides any
25320 20 62 65 68 61 76 69 6f 72 20 72 65 71 75 65 73   behavior reques
25330 74 65 64 20 62 79 20 73 65 74 74 69 6e 67 0a 2a  ted by setting.*
25340 2a 20 20 20 20 20 53 51 4c 49 54 45 5f 4f 50 45  *     SQLITE_OPE
25350 4e 5f 50 52 49 56 41 54 45 43 41 43 48 45 20 6f  N_PRIVATECACHE o
25360 72 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 53 48  r SQLITE_OPEN_SH
25370 41 52 45 44 43 41 43 48 45 20 66 6c 61 67 2e 0a  AREDCACHE flag..
25380 2a 2a 0a 2a 2a 20 20 3c 6c 69 3e 20 3c 62 3e 70  **.**  <li> <b>p
25390 73 6f 77 3c 2f 62 3e 3a 20 5e 54 68 65 20 70 73  sow</b>: ^The ps
253a0 6f 77 20 70 61 72 61 6d 65 74 65 72 20 69 6e 64  ow parameter ind
253b0 69 63 61 74 65 73 20 77 68 65 74 68 65 72 20 6f  icates whether o
253c0 72 20 6e 6f 74 20 74 68 65 0a 2a 2a 20 20 20 20  r not the.**    
253d0 20 5b 70 6f 77 65 72 73 61 66 65 20 6f 76 65 72   [powersafe over
253e0 77 72 69 74 65 5d 20 70 72 6f 70 65 72 74 79 20  write] property 
253f0 64 6f 65 73 20 6f 72 20 64 6f 65 73 20 6e 6f 74  does or does not
25400 20 61 70 70 6c 79 20 74 6f 20 74 68 65 0a 2a 2a   apply to the.**
25410 20 20 20 20 20 73 74 6f 72 61 67 65 20 6d 65 64       storage med
25420 69 61 20 6f 6e 20 77 68 69 63 68 20 74 68 65 20  ia on which the 
25430 64 61 74 61 62 61 73 65 20 66 69 6c 65 20 72 65  database file re
25440 73 69 64 65 73 2e 0a 2a 2a 0a 2a 2a 20 20 3c 6c  sides..**.**  <l
25450 69 3e 20 3c 62 3e 6e 6f 6c 6f 63 6b 3c 2f 62 3e  i> <b>nolock</b>
25460 3a 20 5e 54 68 65 20 6e 6f 6c 6f 63 6b 20 70 61  : ^The nolock pa
25470 72 61 6d 65 74 65 72 20 69 73 20 61 20 62 6f 6f  rameter is a boo
25480 6c 65 61 6e 20 71 75 65 72 79 20 70 61 72 61 6d  lean query param
25490 65 74 65 72 0a 2a 2a 20 20 20 20 20 77 68 69 63  eter.**     whic
254a0 68 20 69 66 20 73 65 74 20 64 69 73 61 62 6c 65  h if set disable
254b0 73 20 66 69 6c 65 20 6c 6f 63 6b 69 6e 67 20 69  s file locking i
254c0 6e 20 72 6f 6c 6c 62 61 63 6b 20 6a 6f 75 72 6e  n rollback journ
254d0 61 6c 20 6d 6f 64 65 73 2e 20 20 54 68 69 73 0a  al modes.  This.
254e0 2a 2a 20 20 20 20 20 69 73 20 75 73 65 66 75 6c  **     is useful
254f0 20 66 6f 72 20 61 63 63 65 73 73 69 6e 67 20 61   for accessing a
25500 20 64 61 74 61 62 61 73 65 20 6f 6e 20 61 20 66   database on a f
25510 69 6c 65 73 79 73 74 65 6d 20 74 68 61 74 20 64  ilesystem that d
25520 6f 65 73 20 6e 6f 74 0a 2a 2a 20 20 20 20 20 73  oes not.**     s
25530 75 70 70 6f 72 74 20 6c 6f 63 6b 69 6e 67 2e 20  upport locking. 
25540 20 43 61 75 74 69 6f 6e 3a 20 20 44 61 74 61 62   Caution:  Datab
25550 61 73 65 20 63 6f 72 72 75 70 74 69 6f 6e 20 6d  ase corruption m
25560 69 67 68 74 20 72 65 73 75 6c 74 20 69 66 20 74  ight result if t
25570 77 6f 0a 2a 2a 20 20 20 20 20 6f 72 20 6d 6f 72  wo.**     or mor
25580 65 20 70 72 6f 63 65 73 73 65 73 20 77 72 69 74  e processes writ
25590 65 20 74 6f 20 74 68 65 20 73 61 6d 65 20 64 61  e to the same da
255a0 74 61 62 61 73 65 20 61 6e 64 20 61 6e 79 20 6f  tabase and any o
255b0 6e 65 20 6f 66 20 74 68 6f 73 65 0a 2a 2a 20 20  ne of those.**  
255c0 20 20 20 70 72 6f 63 65 73 73 65 73 20 75 73 65     processes use
255d0 73 20 6e 6f 6c 6f 63 6b 3d 31 2e 0a 2a 2a 0a 2a  s nolock=1..**.*
255e0 2a 20 20 3c 6c 69 3e 20 3c 62 3e 69 6d 6d 75 74  *  <li> <b>immut
255f0 61 62 6c 65 3c 2f 62 3e 3a 20 5e 54 68 65 20 69  able</b>: ^The i
25600 6d 6d 75 74 61 62 6c 65 20 70 61 72 61 6d 65 74  mmutable paramet
25610 65 72 20 69 73 20 61 20 62 6f 6f 6c 65 61 6e 20  er is a boolean 
25620 71 75 65 72 79 0a 2a 2a 20 20 20 20 20 70 61 72  query.**     par
25630 61 6d 65 74 65 72 20 74 68 61 74 20 69 6e 64 69  ameter that indi
25640 63 61 74 65 73 20 74 68 61 74 20 74 68 65 20 64  cates that the d
25650 61 74 61 62 61 73 65 20 66 69 6c 65 20 69 73 20  atabase file is 
25660 73 74 6f 72 65 64 20 6f 6e 0a 2a 2a 20 20 20 20  stored on.**    
25670 20 72 65 61 64 2d 6f 6e 6c 79 20 6d 65 64 69 61   read-only media
25680 2e 20 20 5e 57 68 65 6e 20 69 6d 6d 75 74 61 62  .  ^When immutab
25690 6c 65 20 69 73 20 73 65 74 2c 20 53 51 4c 69 74  le is set, SQLit
256a0 65 20 61 73 73 75 6d 65 73 20 74 68 61 74 20 74  e assumes that t
256b0 68 65 0a 2a 2a 20 20 20 20 20 64 61 74 61 62 61  he.**     databa
256c0 73 65 20 66 69 6c 65 20 63 61 6e 6e 6f 74 20 62  se file cannot b
256d0 65 20 63 68 61 6e 67 65 64 2c 20 65 76 65 6e 20  e changed, even 
256e0 62 79 20 61 20 70 72 6f 63 65 73 73 20 77 69 74  by a process wit
256f0 68 20 68 69 67 68 65 72 0a 2a 2a 20 20 20 20 20  h higher.**     
25700 70 72 69 76 69 6c 65 67 65 2c 20 61 6e 64 20 73  privilege, and s
25710 6f 20 74 68 65 20 64 61 74 61 62 61 73 65 20 69  o the database i
25720 73 20 6f 70 65 6e 65 64 20 72 65 61 64 2d 6f 6e  s opened read-on
25730 6c 79 20 61 6e 64 20 61 6c 6c 20 6c 6f 63 6b 69  ly and all locki
25740 6e 67 0a 2a 2a 20 20 20 20 20 61 6e 64 20 63 68  ng.**     and ch
25750 61 6e 67 65 20 64 65 74 65 63 74 69 6f 6e 20 69  ange detection i
25760 73 20 64 69 73 61 62 6c 65 64 2e 20 20 43 61 75  s disabled.  Cau
25770 74 69 6f 6e 3a 20 53 65 74 74 69 6e 67 20 74 68  tion: Setting th
25780 65 20 69 6d 6d 75 74 61 62 6c 65 0a 2a 2a 20 20  e immutable.**  
25790 20 20 20 70 72 6f 70 65 72 74 79 20 6f 6e 20 61     property on a
257a0 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 20 74   database file t
257b0 68 61 74 20 64 6f 65 73 20 69 6e 20 66 61 63 74  hat does in fact
257c0 20 63 68 61 6e 67 65 20 63 61 6e 20 72 65 73 75   change can resu
257d0 6c 74 0a 2a 2a 20 20 20 20 20 69 6e 20 69 6e 63  lt.**     in inc
257e0 6f 72 72 65 63 74 20 71 75 65 72 79 20 72 65 73  orrect query res
257f0 75 6c 74 73 20 61 6e 64 2f 6f 72 20 5b 53 51 4c  ults and/or [SQL
25800 49 54 45 5f 43 4f 52 52 55 50 54 5d 20 65 72 72  ITE_CORRUPT] err
25810 6f 72 73 2e 0a 2a 2a 20 20 20 20 20 53 65 65 20  ors..**     See 
25820 61 6c 73 6f 3a 20 5b 53 51 4c 49 54 45 5f 49 4f  also: [SQLITE_IO
25830 43 41 50 5f 49 4d 4d 55 54 41 42 4c 45 5d 2e 0a  CAP_IMMUTABLE]..
25840 2a 2a 20 20 20 20 20 20 20 0a 2a 2a 20 3c 2f 75  **       .** </u
25850 6c 3e 0a 2a 2a 0a 2a 2a 20 5e 53 70 65 63 69 66  l>.**.** ^Specif
25860 79 69 6e 67 20 61 6e 20 75 6e 6b 6e 6f 77 6e 20  ying an unknown 
25870 70 61 72 61 6d 65 74 65 72 20 69 6e 20 74 68 65  parameter in the
25880 20 71 75 65 72 79 20 63 6f 6d 70 6f 6e 65 6e 74   query component
25890 20 6f 66 20 61 20 55 52 49 20 69 73 20 6e 6f 74   of a URI is not
258a0 20 61 6e 0a 2a 2a 20 65 72 72 6f 72 2e 20 20 46   an.** error.  F
258b0 75 74 75 72 65 20 76 65 72 73 69 6f 6e 73 20 6f  uture versions o
258c0 66 20 53 51 4c 69 74 65 20 6d 69 67 68 74 20 75  f SQLite might u
258d0 6e 64 65 72 73 74 61 6e 64 20 61 64 64 69 74 69  nderstand additi
258e0 6f 6e 61 6c 20 71 75 65 72 79 0a 2a 2a 20 70 61  onal query.** pa
258f0 72 61 6d 65 74 65 72 73 2e 20 20 53 65 65 20 22  rameters.  See "
25900 5b 71 75 65 72 79 20 70 61 72 61 6d 65 74 65 72  [query parameter
25910 73 20 77 69 74 68 20 73 70 65 63 69 61 6c 20 6d  s with special m
25920 65 61 6e 69 6e 67 20 74 6f 20 53 51 4c 69 74 65  eaning to SQLite
25930 5d 22 20 66 6f 72 0a 2a 2a 20 61 64 64 69 74 69  ]" for.** additi
25940 6f 6e 61 6c 20 69 6e 66 6f 72 6d 61 74 69 6f 6e  onal information
25950 2e 0a 2a 2a 0a 2a 2a 20 5b 5b 55 52 49 20 66 69  ..**.** [[URI fi
25960 6c 65 6e 61 6d 65 20 65 78 61 6d 70 6c 65 73 5d  lename examples]
25970 5d 20 3c 68 33 3e 55 52 49 20 66 69 6c 65 6e 61  ] <h3>URI filena
25980 6d 65 20 65 78 61 6d 70 6c 65 73 3c 2f 68 33 3e  me examples</h3>
25990 0a 2a 2a 0a 2a 2a 20 3c 74 61 62 6c 65 20 62 6f  .**.** <table bo
259a0 72 64 65 72 3d 22 31 22 20 61 6c 69 67 6e 3d 63  rder="1" align=c
259b0 65 6e 74 65 72 20 63 65 6c 6c 70 61 64 64 69 6e  enter cellpaddin
259c0 67 3d 35 3e 0a 2a 2a 20 3c 74 72 3e 3c 74 68 3e  g=5>.** <tr><th>
259d0 20 55 52 49 20 66 69 6c 65 6e 61 6d 65 73 20 3c   URI filenames <
259e0 74 68 3e 20 52 65 73 75 6c 74 73 0a 2a 2a 20 3c  th> Results.** <
259f0 74 72 3e 3c 74 64 3e 20 66 69 6c 65 3a 64 61 74  tr><td> file:dat
25a00 61 2e 64 62 20 3c 74 64 3e 20 0a 2a 2a 20 20 20  a.db <td> .**   
25a10 20 20 20 20 20 20 20 4f 70 65 6e 20 74 68 65 20         Open the 
25a20 66 69 6c 65 20 22 64 61 74 61 2e 64 62 22 20 69  file "data.db" i
25a30 6e 20 74 68 65 20 63 75 72 72 65 6e 74 20 64 69  n the current di
25a40 72 65 63 74 6f 72 79 2e 0a 2a 2a 20 3c 74 72 3e  rectory..** <tr>
25a50 3c 74 64 3e 20 66 69 6c 65 3a 2f 68 6f 6d 65 2f  <td> file:/home/
25a60 66 72 65 64 2f 64 61 74 61 2e 64 62 3c 62 72 3e  fred/data.db<br>
25a70 0a 2a 2a 20 20 20 20 20 20 20 20 20 20 66 69 6c  .**          fil
25a80 65 3a 2f 2f 2f 68 6f 6d 65 2f 66 72 65 64 2f 64  e:///home/fred/d
25a90 61 74 61 2e 64 62 20 3c 62 72 3e 20 0a 2a 2a 20  ata.db <br> .** 
25aa0 20 20 20 20 20 20 20 20 20 66 69 6c 65 3a 2f 2f           file://
25ab0 6c 6f 63 61 6c 68 6f 73 74 2f 68 6f 6d 65 2f 66  localhost/home/f
25ac0 72 65 64 2f 64 61 74 61 2e 64 62 20 3c 62 72 3e  red/data.db <br>
25ad0 20 3c 74 64 3e 20 0a 2a 2a 20 20 20 20 20 20 20   <td> .**       
25ae0 20 20 20 4f 70 65 6e 20 74 68 65 20 64 61 74 61     Open the data
25af0 62 61 73 65 20 66 69 6c 65 20 22 2f 68 6f 6d 65  base file "/home
25b00 2f 66 72 65 64 2f 64 61 74 61 2e 64 62 22 2e 0a  /fred/data.db"..
25b10 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 66 69 6c 65  ** <tr><td> file
25b20 3a 2f 2f 64 61 72 6b 73 74 61 72 2f 68 6f 6d 65  ://darkstar/home
25b30 2f 66 72 65 64 2f 64 61 74 61 2e 64 62 20 3c 74  /fred/data.db <t
25b40 64 3e 20 0a 2a 2a 20 20 20 20 20 20 20 20 20 20  d> .**          
25b50 41 6e 20 65 72 72 6f 72 2e 20 22 64 61 72 6b 73  An error. "darks
25b60 74 61 72 22 20 69 73 20 6e 6f 74 20 61 20 72 65  tar" is not a re
25b70 63 6f 67 6e 69 7a 65 64 20 61 75 74 68 6f 72 69  cognized authori
25b80 74 79 2e 0a 2a 2a 20 3c 74 72 3e 3c 74 64 20 73  ty..** <tr><td s
25b90 74 79 6c 65 3d 22 77 68 69 74 65 2d 73 70 61 63  tyle="white-spac
25ba0 65 3a 6e 6f 77 72 61 70 22 3e 20 0a 2a 2a 20 20  e:nowrap"> .**  
25bb0 20 20 20 20 20 20 20 20 66 69 6c 65 3a 2f 2f 2f          file:///
25bc0 43 3a 2f 44 6f 63 75 6d 65 6e 74 73 25 32 30 61  C:/Documents%20a
25bd0 6e 64 25 32 30 53 65 74 74 69 6e 67 73 2f 66 72  nd%20Settings/fr
25be0 65 64 2f 44 65 73 6b 74 6f 70 2f 64 61 74 61 2e  ed/Desktop/data.
25bf0 64 62 0a 2a 2a 20 20 20 20 20 3c 74 64 3e 20 57  db.**     <td> W
25c00 69 6e 64 6f 77 73 20 6f 6e 6c 79 3a 20 4f 70 65  indows only: Ope
25c10 6e 20 74 68 65 20 66 69 6c 65 20 22 64 61 74 61  n the file "data
25c20 2e 64 62 22 20 6f 6e 20 66 72 65 64 27 73 20 64  .db" on fred's d
25c30 65 73 6b 74 6f 70 20 6f 6e 20 64 72 69 76 65 0a  esktop on drive.
25c40 2a 2a 20 20 20 20 20 20 20 20 20 20 43 3a 2e 20  **          C:. 
25c50 4e 6f 74 65 20 74 68 61 74 20 74 68 65 20 25 32  Note that the %2
25c60 30 20 65 73 63 61 70 69 6e 67 20 69 6e 20 74 68  0 escaping in th
25c70 69 73 20 65 78 61 6d 70 6c 65 20 69 73 20 6e 6f  is example is no
25c80 74 20 73 74 72 69 63 74 6c 79 20 0a 2a 2a 20 20  t strictly .**  
25c90 20 20 20 20 20 20 20 20 6e 65 63 65 73 73 61 72          necessar
25ca0 79 20 2d 20 73 70 61 63 65 20 63 68 61 72 61 63  y - space charac
25cb0 74 65 72 73 20 63 61 6e 20 62 65 20 75 73 65 64  ters can be used
25cc0 20 6c 69 74 65 72 61 6c 6c 79 0a 2a 2a 20 20 20   literally.**   
25cd0 20 20 20 20 20 20 20 69 6e 20 55 52 49 20 66 69         in URI fi
25ce0 6c 65 6e 61 6d 65 73 2e 0a 2a 2a 20 3c 74 72 3e  lenames..** <tr>
25cf0 3c 74 64 3e 20 66 69 6c 65 3a 64 61 74 61 2e 64  <td> file:data.d
25d00 62 3f 6d 6f 64 65 3d 72 6f 26 63 61 63 68 65 3d  b?mode=ro&cache=
25d10 70 72 69 76 61 74 65 20 3c 74 64 3e 20 0a 2a 2a  private <td> .**
25d20 20 20 20 20 20 20 20 20 20 20 4f 70 65 6e 20 66            Open f
25d30 69 6c 65 20 22 64 61 74 61 2e 64 62 22 20 69 6e  ile "data.db" in
25d40 20 74 68 65 20 63 75 72 72 65 6e 74 20 64 69 72   the current dir
25d50 65 63 74 6f 72 79 20 66 6f 72 20 72 65 61 64 2d  ectory for read-
25d60 6f 6e 6c 79 20 61 63 63 65 73 73 2e 0a 2a 2a 20  only access..** 
25d70 20 20 20 20 20 20 20 20 20 52 65 67 61 72 64 6c           Regardl
25d80 65 73 73 20 6f 66 20 77 68 65 74 68 65 72 20 6f  ess of whether o
25d90 72 20 6e 6f 74 20 73 68 61 72 65 64 2d 63 61 63  r not shared-cac
25da0 68 65 20 6d 6f 64 65 20 69 73 20 65 6e 61 62 6c  he mode is enabl
25db0 65 64 20 62 79 0a 2a 2a 20 20 20 20 20 20 20 20  ed by.**        
25dc0 20 20 64 65 66 61 75 6c 74 2c 20 75 73 65 20 61    default, use a
25dd0 20 70 72 69 76 61 74 65 20 63 61 63 68 65 2e 0a   private cache..
25de0 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 66 69 6c 65  ** <tr><td> file
25df0 3a 2f 68 6f 6d 65 2f 66 72 65 64 2f 64 61 74 61  :/home/fred/data
25e00 2e 64 62 3f 76 66 73 3d 75 6e 69 78 2d 64 6f 74  .db?vfs=unix-dot
25e10 66 69 6c 65 20 3c 74 64 3e 0a 2a 2a 20 20 20 20  file <td>.**    
25e20 20 20 20 20 20 20 4f 70 65 6e 20 66 69 6c 65 20        Open file 
25e30 22 2f 68 6f 6d 65 2f 66 72 65 64 2f 64 61 74 61  "/home/fred/data
25e40 2e 64 62 22 2e 20 55 73 65 20 74 68 65 20 73 70  .db". Use the sp
25e50 65 63 69 61 6c 20 56 46 53 20 22 75 6e 69 78 2d  ecial VFS "unix-
25e60 64 6f 74 66 69 6c 65 22 0a 2a 2a 20 20 20 20 20  dotfile".**     
25e70 20 20 20 20 20 74 68 61 74 20 75 73 65 73 20 64       that uses d
25e80 6f 74 2d 66 69 6c 65 73 20 69 6e 20 70 6c 61 63  ot-files in plac
25e90 65 20 6f 66 20 70 6f 73 69 78 20 61 64 76 69 73  e of posix advis
25ea0 6f 72 79 20 6c 6f 63 6b 69 6e 67 2e 0a 2a 2a 20  ory locking..** 
25eb0 3c 74 72 3e 3c 74 64 3e 20 66 69 6c 65 3a 64 61  <tr><td> file:da
25ec0 74 61 2e 64 62 3f 6d 6f 64 65 3d 72 65 61 64 6f  ta.db?mode=reado
25ed0 6e 6c 79 20 3c 74 64 3e 20 0a 2a 2a 20 20 20 20  nly <td> .**    
25ee0 20 20 20 20 20 20 41 6e 20 65 72 72 6f 72 2e 20        An error. 
25ef0 22 72 65 61 64 6f 6e 6c 79 22 20 69 73 20 6e 6f  "readonly" is no
25f00 74 20 61 20 76 61 6c 69 64 20 6f 70 74 69 6f 6e  t a valid option
25f10 20 66 6f 72 20 74 68 65 20 22 6d 6f 64 65 22 20   for the "mode" 
25f20 70 61 72 61 6d 65 74 65 72 2e 0a 2a 2a 20 3c 2f  parameter..** </
25f30 74 61 62 6c 65 3e 0a 2a 2a 0a 2a 2a 20 5e 55 52  table>.**.** ^UR
25f40 49 20 68 65 78 61 64 65 63 69 6d 61 6c 20 65 73  I hexadecimal es
25f50 63 61 70 65 20 73 65 71 75 65 6e 63 65 73 20 28  cape sequences (
25f60 25 48 48 29 20 61 72 65 20 73 75 70 70 6f 72 74  %HH) are support
25f70 65 64 20 77 69 74 68 69 6e 20 74 68 65 20 70 61  ed within the pa
25f80 74 68 20 61 6e 64 0a 2a 2a 20 71 75 65 72 79 20  th and.** query 
25f90 63 6f 6d 70 6f 6e 65 6e 74 73 20 6f 66 20 61 20  components of a 
25fa0 55 52 49 2e 20 41 20 68 65 78 61 64 65 63 69 6d  URI. A hexadecim
25fb0 61 6c 20 65 73 63 61 70 65 20 73 65 71 75 65 6e  al escape sequen
25fc0 63 65 20 63 6f 6e 73 69 73 74 73 20 6f 66 20 61  ce consists of a
25fd0 0a 2a 2a 20 70 65 72 63 65 6e 74 20 73 69 67 6e  .** percent sign
25fe0 20 2d 20 22 25 22 20 2d 20 66 6f 6c 6c 6f 77 65   - "%" - followe
25ff0 64 20 62 79 20 65 78 61 63 74 6c 79 20 74 77 6f  d by exactly two
26000 20 68 65 78 61 64 65 63 69 6d 61 6c 20 64 69 67   hexadecimal dig
26010 69 74 73 20 0a 2a 2a 20 73 70 65 63 69 66 79 69  its .** specifyi
26020 6e 67 20 61 6e 20 6f 63 74 65 74 20 76 61 6c 75  ng an octet valu
26030 65 2e 20 5e 42 65 66 6f 72 65 20 74 68 65 20 70  e. ^Before the p
26040 61 74 68 20 6f 72 20 71 75 65 72 79 20 63 6f 6d  ath or query com
26050 70 6f 6e 65 6e 74 73 20 6f 66 20 61 0a 2a 2a 20  ponents of a.** 
26060 55 52 49 20 66 69 6c 65 6e 61 6d 65 20 61 72 65  URI filename are
26070 20 69 6e 74 65 72 70 72 65 74 65 64 2c 20 74 68   interpreted, th
26080 65 79 20 61 72 65 20 65 6e 63 6f 64 65 64 20 75  ey are encoded u
26090 73 69 6e 67 20 55 54 46 2d 38 20 61 6e 64 20 61  sing UTF-8 and a
260a0 6c 6c 20 0a 2a 2a 20 68 65 78 61 64 65 63 69 6d  ll .** hexadecim
260b0 61 6c 20 65 73 63 61 70 65 20 73 65 71 75 65 6e  al escape sequen
260c0 63 65 73 20 72 65 70 6c 61 63 65 64 20 62 79 20  ces replaced by 
260d0 61 20 73 69 6e 67 6c 65 20 62 79 74 65 20 63 6f  a single byte co
260e0 6e 74 61 69 6e 69 6e 67 20 74 68 65 0a 2a 2a 20  ntaining the.** 
260f0 63 6f 72 72 65 73 70 6f 6e 64 69 6e 67 20 6f 63  corresponding oc
26100 74 65 74 2e 20 49 66 20 74 68 69 73 20 70 72 6f  tet. If this pro
26110 63 65 73 73 20 67 65 6e 65 72 61 74 65 73 20 61  cess generates a
26120 6e 20 69 6e 76 61 6c 69 64 20 55 54 46 2d 38 20  n invalid UTF-8 
26130 65 6e 63 6f 64 69 6e 67 2c 0a 2a 2a 20 74 68 65  encoding,.** the
26140 20 72 65 73 75 6c 74 73 20 61 72 65 20 75 6e 64   results are und
26150 65 66 69 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 3c 62  efined..**.** <b
26160 3e 4e 6f 74 65 20 74 6f 20 57 69 6e 64 6f 77 73  >Note to Windows
26170 20 75 73 65 72 73 3a 3c 2f 62 3e 20 20 54 68 65   users:</b>  The
26180 20 65 6e 63 6f 64 69 6e 67 20 75 73 65 64 20 66   encoding used f
26190 6f 72 20 74 68 65 20 66 69 6c 65 6e 61 6d 65 20  or the filename 
261a0 61 72 67 75 6d 65 6e 74 0a 2a 2a 20 6f 66 20 73  argument.** of s
261b0 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29 20 61 6e  qlite3_open() an
261c0 64 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76  d sqlite3_open_v
261d0 32 28 29 20 6d 75 73 74 20 62 65 20 55 54 46 2d  2() must be UTF-
261e0 38 2c 20 6e 6f 74 20 77 68 61 74 65 76 65 72 0a  8, not whatever.
261f0 2a 2a 20 63 6f 64 65 70 61 67 65 20 69 73 20 63  ** codepage is c
26200 75 72 72 65 6e 74 6c 79 20 64 65 66 69 6e 65 64  urrently defined
26210 2e 20 20 46 69 6c 65 6e 61 6d 65 73 20 63 6f 6e  .  Filenames con
26220 74 61 69 6e 69 6e 67 20 69 6e 74 65 72 6e 61 74  taining internat
26230 69 6f 6e 61 6c 0a 2a 2a 20 63 68 61 72 61 63 74  ional.** charact
26240 65 72 73 20 6d 75 73 74 20 62 65 20 63 6f 6e 76  ers must be conv
26250 65 72 74 65 64 20 74 6f 20 55 54 46 2d 38 20 70  erted to UTF-8 p
26260 72 69 6f 72 20 74 6f 20 70 61 73 73 69 6e 67 20  rior to passing 
26270 74 68 65 6d 20 69 6e 74 6f 0a 2a 2a 20 73 71 6c  them into.** sql
26280 69 74 65 33 5f 6f 70 65 6e 28 29 20 6f 72 20 73  ite3_open() or s
26290 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29  qlite3_open_v2()
262a0 2e 0a 2a 2a 0a 2a 2a 20 3c 62 3e 4e 6f 74 65 20  ..**.** <b>Note 
262b0 74 6f 20 57 69 6e 64 6f 77 73 20 52 75 6e 74 69  to Windows Runti
262c0 6d 65 20 75 73 65 72 73 3a 3c 2f 62 3e 20 20 54  me users:</b>  T
262d0 68 65 20 74 65 6d 70 6f 72 61 72 79 20 64 69 72  he temporary dir
262e0 65 63 74 6f 72 79 20 6d 75 73 74 20 62 65 20 73  ectory must be s
262f0 65 74 0a 2a 2a 20 70 72 69 6f 72 20 74 6f 20 63  et.** prior to c
26300 61 6c 6c 69 6e 67 20 73 71 6c 69 74 65 33 5f 6f  alling sqlite3_o
26310 70 65 6e 28 29 20 6f 72 20 73 71 6c 69 74 65 33  pen() or sqlite3
26320 5f 6f 70 65 6e 5f 76 32 28 29 2e 20 20 4f 74 68  _open_v2().  Oth
26330 65 72 77 69 73 65 2c 20 76 61 72 69 6f 75 73 0a  erwise, various.
26340 2a 2a 20 66 65 61 74 75 72 65 73 20 74 68 61 74  ** features that
26350 20 72 65 71 75 69 72 65 20 74 68 65 20 75 73 65   require the use
26360 20 6f 66 20 74 65 6d 70 6f 72 61 72 79 20 66 69   of temporary fi
26370 6c 65 73 20 6d 61 79 20 66 61 69 6c 2e 0a 2a 2a  les may fail..**
26380 0a 2a 2a 20 53 65 65 20 61 6c 73 6f 3a 20 5b 73  .** See also: [s
26390 71 6c 69 74 65 33 5f 74 65 6d 70 5f 64 69 72 65  qlite3_temp_dire
263a0 63 74 6f 72 79 5d 0a 2a 2f 0a 69 6e 74 20 73 71  ctory].*/.int sq
263b0 6c 69 74 65 33 5f 6f 70 65 6e 28 0a 20 20 63 6f  lite3_open(.  co
263c0 6e 73 74 20 63 68 61 72 20 2a 66 69 6c 65 6e 61  nst char *filena
263d0 6d 65 2c 20 20 20 2f 2a 20 44 61 74 61 62 61 73  me,   /* Databas
263e0 65 20 66 69 6c 65 6e 61 6d 65 20 28 55 54 46 2d  e filename (UTF-
263f0 38 29 20 2a 2f 0a 20 20 73 71 6c 69 74 65 33 20  8) */.  sqlite3 
26400 2a 2a 70 70 44 62 20 20 20 20 20 20 20 20 20 20  **ppDb          
26410 2f 2a 20 4f 55 54 3a 20 53 51 4c 69 74 65 20 64  /* OUT: SQLite d
26420 62 20 68 61 6e 64 6c 65 20 2a 2f 0a 29 3b 0a 69  b handle */.);.i
26430 6e 74 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 31  nt sqlite3_open1
26440 36 28 0a 20 20 63 6f 6e 73 74 20 76 6f 69 64 20  6(.  const void 
26450 2a 66 69 6c 65 6e 61 6d 65 2c 20 20 20 2f 2a 20  *filename,   /* 
26460 44 61 74 61 62 61 73 65 20 66 69 6c 65 6e 61 6d  Database filenam
26470 65 20 28 55 54 46 2d 31 36 29 20 2a 2f 0a 20 20  e (UTF-16) */.  
26480 73 71 6c 69 74 65 33 20 2a 2a 70 70 44 62 20 20  sqlite3 **ppDb  
26490 20 20 20 20 20 20 20 20 2f 2a 20 4f 55 54 3a 20          /* OUT: 
264a0 53 51 4c 69 74 65 20 64 62 20 68 61 6e 64 6c 65  SQLite db handle
264b0 20 2a 2f 0a 29 3b 0a 69 6e 74 20 73 71 6c 69 74   */.);.int sqlit
264c0 65 33 5f 6f 70 65 6e 5f 76 32 28 0a 20 20 63 6f  e3_open_v2(.  co
264d0 6e 73 74 20 63 68 61 72 20 2a 66 69 6c 65 6e 61  nst char *filena
264e0 6d 65 2c 20 20 20 2f 2a 20 44 61 74 61 62 61 73  me,   /* Databas
264f0 65 20 66 69 6c 65 6e 61 6d 65 20 28 55 54 46 2d  e filename (UTF-
26500 38 29 20 2a 2f 0a 20 20 73 71 6c 69 74 65 33 20  8) */.  sqlite3 
26510 2a 2a 70 70 44 62 2c 20 20 20 20 20 20 20 20 20  **ppDb,         
26520 2f 2a 20 4f 55 54 3a 20 53 51 4c 69 74 65 20 64  /* OUT: SQLite d
26530 62 20 68 61 6e 64 6c 65 20 2a 2f 0a 20 20 69 6e  b handle */.  in
26540 74 20 66 6c 61 67 73 2c 20 20 20 20 20 20 20 20  t flags,        
26550 20 20 20 20 20 20 2f 2a 20 46 6c 61 67 73 20 2a        /* Flags *
26560 2f 0a 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a  /.  const char *
26570 7a 56 66 73 20 20 20 20 20 20 20 20 2f 2a 20 4e  zVfs        /* N
26580 61 6d 65 20 6f 66 20 56 46 53 20 6d 6f 64 75 6c  ame of VFS modul
26590 65 20 74 6f 20 75 73 65 20 2a 2f 0a 29 3b 0a 0a  e to use */.);..
265a0 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20  /*.** CAPI3REF: 
265b0 4f 62 74 61 69 6e 20 56 61 6c 75 65 73 20 46 6f  Obtain Values Fo
265c0 72 20 55 52 49 20 50 61 72 61 6d 65 74 65 72 73  r URI Parameters
265d0 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 61 72 65  .**.** These are
265e0 20 75 74 69 6c 69 74 79 20 72 6f 75 74 69 6e 65   utility routine
265f0 73 2c 20 75 73 65 66 75 6c 20 74 6f 20 56 46 53  s, useful to VFS
26600 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 73   implementations
26610 2c 20 74 68 61 74 20 63 68 65 63 6b 0a 2a 2a 20  , that check.** 
26620 74 6f 20 73 65 65 20 69 66 20 61 20 64 61 74 61  to see if a data
26630 62 61 73 65 20 66 69 6c 65 20 77 61 73 20 61 20  base file was a 
26640 55 52 49 20 74 68 61 74 20 63 6f 6e 74 61 69 6e  URI that contain
26650 65 64 20 61 20 73 70 65 63 69 66 69 63 20 71 75  ed a specific qu
26660 65 72 79 20 0a 2a 2a 20 70 61 72 61 6d 65 74 65  ery .** paramete
26670 72 2c 20 61 6e 64 20 69 66 20 73 6f 20 6f 62 74  r, and if so obt
26680 61 69 6e 73 20 74 68 65 20 76 61 6c 75 65 20 6f  ains the value o
26690 66 20 74 68 61 74 20 71 75 65 72 79 20 70 61 72  f that query par
266a0 61 6d 65 74 65 72 2e 0a 2a 2a 0a 2a 2a 20 49 66  ameter..**.** If
266b0 20 46 20 69 73 20 74 68 65 20 64 61 74 61 62 61   F is the databa
266c0 73 65 20 66 69 6c 65 6e 61 6d 65 20 70 6f 69 6e  se filename poin
266d0 74 65 72 20 70 61 73 73 65 64 20 69 6e 74 6f 20  ter passed into 
266e0 74 68 65 20 78 4f 70 65 6e 28 29 20 6d 65 74 68  the xOpen() meth
266f0 6f 64 20 6f 66 20 0a 2a 2a 20 61 20 56 46 53 20  od of .** a VFS 
26700 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 77  implementation w
26710 68 65 6e 20 74 68 65 20 66 6c 61 67 73 20 70 61  hen the flags pa
26720 72 61 6d 65 74 65 72 20 74 6f 20 78 4f 70 65 6e  rameter to xOpen
26730 28 29 20 68 61 73 20 6f 6e 65 20 6f 72 20 0a 2a  () has one or .*
26740 2a 20 6d 6f 72 65 20 6f 66 20 74 68 65 20 5b 53  * more of the [S
26750 51 4c 49 54 45 5f 4f 50 45 4e 5f 55 52 49 5d 20  QLITE_OPEN_URI] 
26760 6f 72 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  or [SQLITE_OPEN_
26770 4d 41 49 4e 5f 44 42 5d 20 62 69 74 73 20 73 65  MAIN_DB] bits se
26780 74 20 61 6e 64 0a 2a 2a 20 50 20 69 73 20 74 68  t and.** P is th
26790 65 20 6e 61 6d 65 20 6f 66 20 74 68 65 20 71 75  e name of the qu
267a0 65 72 79 20 70 61 72 61 6d 65 74 65 72 2c 20 74  ery parameter, t
267b0 68 65 6e 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 75  hen.** sqlite3_u
267c0 72 69 5f 70 61 72 61 6d 65 74 65 72 28 46 2c 50  ri_parameter(F,P
267d0 29 20 72 65 74 75 72 6e 73 20 74 68 65 20 76 61  ) returns the va
267e0 6c 75 65 20 6f 66 20 74 68 65 20 50 0a 2a 2a 20  lue of the P.** 
267f0 70 61 72 61 6d 65 74 65 72 20 69 66 20 69 74 20  parameter if it 
26800 65 78 69 73 74 73 20 6f 72 20 61 20 4e 55 4c 4c  exists or a NULL
26810 20 70 6f 69 6e 74 65 72 20 69 66 20 50 20 64 6f   pointer if P do
26820 65 73 20 6e 6f 74 20 61 70 70 65 61 72 20 61 73  es not appear as
26830 20 61 20 0a 2a 2a 20 71 75 65 72 79 20 70 61 72   a .** query par
26840 61 6d 65 74 65 72 20 6f 6e 20 46 2e 20 20 49 66  ameter on F.  If
26850 20 50 20 69 73 20 61 20 71 75 65 72 79 20 70 61   P is a query pa
26860 72 61 6d 65 74 65 72 20 6f 66 20 46 0a 2a 2a 20  rameter of F.** 
26870 68 61 73 20 6e 6f 20 65 78 70 6c 69 63 69 74 20  has no explicit 
26880 76 61 6c 75 65 2c 20 74 68 65 6e 20 73 71 6c 69  value, then sqli
26890 74 65 33 5f 75 72 69 5f 70 61 72 61 6d 65 74 65  te3_uri_paramete
268a0 72 28 46 2c 50 29 20 72 65 74 75 72 6e 73 0a 2a  r(F,P) returns.*
268b0 2a 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61  * a pointer to a
268c0 6e 20 65 6d 70 74 79 20 73 74 72 69 6e 67 2e 0a  n empty string..
268d0 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74 65  **.** The sqlite
268e0 33 5f 75 72 69 5f 62 6f 6f 6c 65 61 6e 28 46 2c  3_uri_boolean(F,
268f0 50 2c 42 29 20 72 6f 75 74 69 6e 65 20 61 73 73  P,B) routine ass
26900 75 6d 65 73 20 74 68 61 74 20 50 20 69 73 20 61  umes that P is a
26910 20 62 6f 6f 6c 65 61 6e 0a 2a 2a 20 70 61 72 61   boolean.** para
26920 6d 65 74 65 72 20 61 6e 64 20 72 65 74 75 72 6e  meter and return
26930 73 20 74 72 75 65 20 28 31 29 20 6f 72 20 66 61  s true (1) or fa
26940 6c 73 65 20 28 30 29 20 61 63 63 6f 72 64 69 6e  lse (0) accordin
26950 67 20 74 6f 20 74 68 65 20 76 61 6c 75 65 0a 2a  g to the value.*
26960 2a 20 6f 66 20 50 2e 20 20 54 68 65 20 73 71 6c  * of P.  The sql
26970 69 74 65 33 5f 75 72 69 5f 62 6f 6f 6c 65 61 6e  ite3_uri_boolean
26980 28 46 2c 50 2c 42 29 20 72 6f 75 74 69 6e 65 20  (F,P,B) routine 
26990 72 65 74 75 72 6e 73 20 74 72 75 65 20 28 31 29  returns true (1)
269a0 20 69 66 20 74 68 65 0a 2a 2a 20 76 61 6c 75 65   if the.** value
269b0 20 6f 66 20 71 75 65 72 79 20 70 61 72 61 6d 65   of query parame
269c0 74 65 72 20 50 20 69 73 20 6f 6e 65 20 6f 66 20  ter P is one of 
269d0 22 79 65 73 22 2c 20 22 74 72 75 65 22 2c 20 6f  "yes", "true", o
269e0 72 20 22 6f 6e 22 20 69 6e 20 61 6e 79 0a 2a 2a  r "on" in any.**
269f0 20 63 61 73 65 20 6f 72 20 69 66 20 74 68 65 20   case or if the 
26a00 76 61 6c 75 65 20 62 65 67 69 6e 73 20 77 69 74  value begins wit
26a10 68 20 61 20 6e 6f 6e 2d 7a 65 72 6f 20 6e 75 6d  h a non-zero num
26a20 62 65 72 2e 20 20 54 68 65 20 0a 2a 2a 20 73 71  ber.  The .** sq
26a30 6c 69 74 65 33 5f 75 72 69 5f 62 6f 6f 6c 65 61  lite3_uri_boolea
26a40 6e 28 46 2c 50 2c 42 29 20 72 6f 75 74 69 6e 65  n(F,P,B) routine
26a50 73 20 72 65 74 75 72 6e 73 20 66 61 6c 73 65 20  s returns false 
26a60 28 30 29 20 69 66 20 74 68 65 20 76 61 6c 75 65  (0) if the value
26a70 20 6f 66 0a 2a 2a 20 71 75 65 72 79 20 70 61 72   of.** query par
26a80 61 6d 65 74 65 72 20 50 20 69 73 20 6f 6e 65 20  ameter P is one 
26a90 6f 66 20 22 6e 6f 22 2c 20 22 66 61 6c 73 65 22  of "no", "false"
26aa0 2c 20 6f 72 20 22 6f 66 66 22 20 69 6e 20 61 6e  , or "off" in an
26ab0 79 20 63 61 73 65 20 6f 72 0a 2a 2a 20 69 66 20  y case or.** if 
26ac0 74 68 65 20 76 61 6c 75 65 20 62 65 67 69 6e 73  the value begins
26ad0 20 77 69 74 68 20 61 20 6e 75 6d 65 72 69 63 20   with a numeric 
26ae0 7a 65 72 6f 2e 20 20 49 66 20 50 20 69 73 20 6e  zero.  If P is n
26af0 6f 74 20 61 20 71 75 65 72 79 0a 2a 2a 20 70 61  ot a query.** pa
26b00 72 61 6d 65 74 65 72 20 6f 6e 20 46 20 6f 72 20  rameter on F or 
26b10 69 66 20 74 68 65 20 76 61 6c 75 65 20 6f 66 20  if the value of 
26b20 50 20 69 73 20 64 6f 65 73 20 6e 6f 74 20 6d 61  P is does not ma
26b30 74 63 68 20 61 6e 79 20 6f 66 20 74 68 65 0a 2a  tch any of the.*
26b40 2a 20 61 62 6f 76 65 2c 20 74 68 65 6e 20 73 71  * above, then sq
26b50 6c 69 74 65 33 5f 75 72 69 5f 62 6f 6f 6c 65 61  lite3_uri_boolea
26b60 6e 28 46 2c 50 2c 42 29 20 72 65 74 75 72 6e 73  n(F,P,B) returns
26b70 20 28 42 21 3d 30 29 2e 0a 2a 2a 0a 2a 2a 20 54   (B!=0)..**.** T
26b80 68 65 20 73 71 6c 69 74 65 33 5f 75 72 69 5f 69  he sqlite3_uri_i
26b90 6e 74 36 34 28 46 2c 50 2c 44 29 20 72 6f 75 74  nt64(F,P,D) rout
26ba0 69 6e 65 20 63 6f 6e 76 65 72 74 73 20 74 68 65  ine converts the
26bb0 20 76 61 6c 75 65 20 6f 66 20 50 20 69 6e 74 6f   value of P into
26bc0 20 61 0a 2a 2a 20 36 34 2d 62 69 74 20 73 69 67   a.** 64-bit sig
26bd0 6e 65 64 20 69 6e 74 65 67 65 72 20 61 6e 64 20  ned integer and 
26be0 72 65 74 75 72 6e 73 20 74 68 61 74 20 69 6e 74  returns that int
26bf0 65 67 65 72 2c 20 6f 72 20 44 20 69 66 20 50 20  eger, or D if P 
26c00 64 6f 65 73 20 6e 6f 74 0a 2a 2a 20 65 78 69 73  does not.** exis
26c10 74 2e 20 20 49 66 20 74 68 65 20 76 61 6c 75 65  t.  If the value
26c20 20 6f 66 20 50 20 69 73 20 73 6f 6d 65 74 68 69   of P is somethi
26c30 6e 67 20 6f 74 68 65 72 20 74 68 61 6e 20 61 6e  ng other than an
26c40 20 69 6e 74 65 67 65 72 2c 20 74 68 65 6e 0a 2a   integer, then.*
26c50 2a 20 7a 65 72 6f 20 69 73 20 72 65 74 75 72 6e  * zero is return
26c60 65 64 2e 0a 2a 2a 20 0a 2a 2a 20 49 66 20 46 20  ed..** .** If F 
26c70 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  is a NULL pointe
26c80 72 2c 20 74 68 65 6e 20 73 71 6c 69 74 65 33 5f  r, then sqlite3_
26c90 75 72 69 5f 70 61 72 61 6d 65 74 65 72 28 46 2c  uri_parameter(F,
26ca0 50 29 20 72 65 74 75 72 6e 73 20 4e 55 4c 4c 20  P) returns NULL 
26cb0 61 6e 64 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 75  and.** sqlite3_u
26cc0 72 69 5f 62 6f 6f 6c 65 61 6e 28 46 2c 50 2c 42  ri_boolean(F,P,B
26cd0 29 20 72 65 74 75 72 6e 73 20 42 2e 20 20 49 66  ) returns B.  If
26ce0 20 46 20 69 73 20 6e 6f 74 20 61 20 4e 55 4c 4c   F is not a NULL
26cf0 20 70 6f 69 6e 74 65 72 20 61 6e 64 0a 2a 2a 20   pointer and.** 
26d00 69 73 20 6e 6f 74 20 61 20 64 61 74 61 62 61 73  is not a databas
26d10 65 20 66 69 6c 65 20 70 61 74 68 6e 61 6d 65 20  e file pathname 
26d20 70 6f 69 6e 74 65 72 20 74 68 61 74 20 53 51 4c  pointer that SQL
26d30 69 74 65 20 70 61 73 73 65 64 20 69 6e 74 6f 20  ite passed into 
26d40 74 68 65 20 78 4f 70 65 6e 0a 2a 2a 20 56 46 53  the xOpen.** VFS
26d50 20 6d 65 74 68 6f 64 2c 20 74 68 65 6e 20 74 68   method, then th
26d60 65 20 62 65 68 61 76 69 6f 72 20 6f 66 20 74 68  e behavior of th
26d70 69 73 20 72 6f 75 74 69 6e 65 20 69 73 20 75 6e  is routine is un
26d80 64 65 66 69 6e 65 64 20 61 6e 64 20 70 72 6f 62  defined and prob
26d90 61 62 6c 79 0a 2a 2a 20 75 6e 64 65 73 69 72 61  ably.** undesira
26da0 62 6c 65 2e 0a 2a 2f 0a 63 6f 6e 73 74 20 63 68  ble..*/.const ch
26db0 61 72 20 2a 73 71 6c 69 74 65 33 5f 75 72 69 5f  ar *sqlite3_uri_
26dc0 70 61 72 61 6d 65 74 65 72 28 63 6f 6e 73 74 20  parameter(const 
26dd0 63 68 61 72 20 2a 7a 46 69 6c 65 6e 61 6d 65 2c  char *zFilename,
26de0 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 50 61   const char *zPa
26df0 72 61 6d 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  ram);.int sqlite
26e00 33 5f 75 72 69 5f 62 6f 6f 6c 65 61 6e 28 63 6f  3_uri_boolean(co
26e10 6e 73 74 20 63 68 61 72 20 2a 7a 46 69 6c 65 2c  nst char *zFile,
26e20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 50 61   const char *zPa
26e30 72 61 6d 2c 20 69 6e 74 20 62 44 65 66 61 75 6c  ram, int bDefaul
26e40 74 29 3b 0a 73 71 6c 69 74 65 33 5f 69 6e 74 36  t);.sqlite3_int6
26e50 34 20 73 71 6c 69 74 65 33 5f 75 72 69 5f 69 6e  4 sqlite3_uri_in
26e60 74 36 34 28 63 6f 6e 73 74 20 63 68 61 72 2a 2c  t64(const char*,
26e70 20 63 6f 6e 73 74 20 63 68 61 72 2a 2c 20 73 71   const char*, sq
26e80 6c 69 74 65 33 5f 69 6e 74 36 34 29 3b 0a 0a 0a  lite3_int64);...
26e90 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20  /*.** CAPI3REF: 
26ea0 45 72 72 6f 72 20 43 6f 64 65 73 20 41 6e 64 20  Error Codes And 
26eb0 4d 65 73 73 61 67 65 73 0a 2a 2a 20 4d 45 54 48  Messages.** METH
26ec0 4f 44 3a 20 73 71 6c 69 74 65 33 0a 2a 2a 0a 2a  OD: sqlite3.**.*
26ed0 2a 20 5e 49 66 20 74 68 65 20 6d 6f 73 74 20 72  * ^If the most r
26ee0 65 63 65 6e 74 20 73 71 6c 69 74 65 33 5f 2a 20  ecent sqlite3_* 
26ef0 41 50 49 20 63 61 6c 6c 20 61 73 73 6f 63 69 61  API call associa
26f00 74 65 64 20 77 69 74 68 20 0a 2a 2a 20 5b 64 61  ted with .** [da
26f10 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
26f20 6e 5d 20 44 20 66 61 69 6c 65 64 2c 20 74 68 65  n] D failed, the
26f30 6e 20 74 68 65 20 73 71 6c 69 74 65 33 5f 65 72  n the sqlite3_er
26f40 72 63 6f 64 65 28 44 29 20 69 6e 74 65 72 66 61  rcode(D) interfa
26f50 63 65 0a 2a 2a 20 72 65 74 75 72 6e 73 20 74 68  ce.** returns th
26f60 65 20 6e 75 6d 65 72 69 63 20 5b 72 65 73 75 6c  e numeric [resul
26f70 74 20 63 6f 64 65 5d 20 6f 72 20 5b 65 78 74 65  t code] or [exte
26f80 6e 64 65 64 20 72 65 73 75 6c 74 20 63 6f 64 65  nded result code
26f90 5d 20 66 6f 72 20 74 68 61 74 0a 2a 2a 20 41 50  ] for that.** AP
26fa0 49 20 63 61 6c 6c 2e 0a 2a 2a 20 49 66 20 74 68  I call..** If th
26fb0 65 20 6d 6f 73 74 20 72 65 63 65 6e 74 20 41 50  e most recent AP
26fc0 49 20 63 61 6c 6c 20 77 61 73 20 73 75 63 63 65  I call was succe
26fd0 73 73 66 75 6c 2c 0a 2a 2a 20 74 68 65 6e 20 74  ssful,.** then t
26fe0 68 65 20 72 65 74 75 72 6e 20 76 61 6c 75 65 20  he return value 
26ff0 66 72 6f 6d 20 73 71 6c 69 74 65 33 5f 65 72 72  from sqlite3_err
27000 63 6f 64 65 28 29 20 69 73 20 75 6e 64 65 66 69  code() is undefi
27010 6e 65 64 2e 0a 2a 2a 20 5e 54 68 65 20 73 71 6c  ned..** ^The sql
27020 69 74 65 33 5f 65 78 74 65 6e 64 65 64 5f 65 72  ite3_extended_er
27030 72 63 6f 64 65 28 29 0a 2a 2a 20 69 6e 74 65 72  rcode().** inter
27040 66 61 63 65 20 69 73 20 74 68 65 20 73 61 6d 65  face is the same
27050 20 65 78 63 65 70 74 20 74 68 61 74 20 69 74 20   except that it 
27060 61 6c 77 61 79 73 20 72 65 74 75 72 6e 73 20 74  always returns t
27070 68 65 20 0a 2a 2a 20 5b 65 78 74 65 6e 64 65 64  he .** [extended
27080 20 72 65 73 75 6c 74 20 63 6f 64 65 5d 20 65 76   result code] ev
27090 65 6e 20 77 68 65 6e 20 65 78 74 65 6e 64 65 64  en when extended
270a0 20 72 65 73 75 6c 74 20 63 6f 64 65 73 20 61 72   result codes ar
270b0 65 0a 2a 2a 20 64 69 73 61 62 6c 65 64 2e 0a 2a  e.** disabled..*
270c0 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65  *.** ^The sqlite
270d0 33 5f 65 72 72 6d 73 67 28 29 20 61 6e 64 20 73  3_errmsg() and s
270e0 71 6c 69 74 65 33 5f 65 72 72 6d 73 67 31 36 28  qlite3_errmsg16(
270f0 29 20 72 65 74 75 72 6e 20 45 6e 67 6c 69 73 68  ) return English
27100 2d 6c 61 6e 67 75 61 67 65 0a 2a 2a 20 74 65 78  -language.** tex
27110 74 20 74 68 61 74 20 64 65 73 63 72 69 62 65 73  t that describes
27120 20 74 68 65 20 65 72 72 6f 72 2c 20 61 73 20 65   the error, as e
27130 69 74 68 65 72 20 55 54 46 2d 38 20 6f 72 20 55  ither UTF-8 or U
27140 54 46 2d 31 36 20 72 65 73 70 65 63 74 69 76 65  TF-16 respective
27150 6c 79 2e 0a 2a 2a 20 5e 28 4d 65 6d 6f 72 79 20  ly..** ^(Memory 
27160 74 6f 20 68 6f 6c 64 20 74 68 65 20 65 72 72 6f  to hold the erro
27170 72 20 6d 65 73 73 61 67 65 20 73 74 72 69 6e 67  r message string
27180 20 69 73 20 6d 61 6e 61 67 65 64 20 69 6e 74 65   is managed inte
27190 72 6e 61 6c 6c 79 2e 0a 2a 2a 20 54 68 65 20 61  rnally..** The a
271a0 70 70 6c 69 63 61 74 69 6f 6e 20 64 6f 65 73 20  pplication does 
271b0 6e 6f 74 20 6e 65 65 64 20 74 6f 20 77 6f 72 72  not need to worr
271c0 79 20 61 62 6f 75 74 20 66 72 65 65 69 6e 67 20  y about freeing 
271d0 74 68 65 20 72 65 73 75 6c 74 2e 0a 2a 2a 20 48  the result..** H
271e0 6f 77 65 76 65 72 2c 20 74 68 65 20 65 72 72 6f  owever, the erro
271f0 72 20 73 74 72 69 6e 67 20 6d 69 67 68 74 20 62  r string might b
27200 65 20 6f 76 65 72 77 72 69 74 74 65 6e 20 6f 72  e overwritten or
27210 20 64 65 61 6c 6c 6f 63 61 74 65 64 20 62 79 0a   deallocated by.
27220 2a 2a 20 73 75 62 73 65 71 75 65 6e 74 20 63 61  ** subsequent ca
27230 6c 6c 73 20 74 6f 20 6f 74 68 65 72 20 53 51 4c  lls to other SQL
27240 69 74 65 20 69 6e 74 65 72 66 61 63 65 20 66 75  ite interface fu
27250 6e 63 74 69 6f 6e 73 2e 29 5e 0a 2a 2a 0a 2a 2a  nctions.)^.**.**
27260 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 65 72   ^The sqlite3_er
27270 72 73 74 72 28 29 20 69 6e 74 65 72 66 61 63 65  rstr() interface
27280 20 72 65 74 75 72 6e 73 20 74 68 65 20 45 6e 67   returns the Eng
27290 6c 69 73 68 2d 6c 61 6e 67 75 61 67 65 20 74 65  lish-language te
272a0 78 74 0a 2a 2a 20 74 68 61 74 20 64 65 73 63 72  xt.** that descr
272b0 69 62 65 73 20 74 68 65 20 5b 72 65 73 75 6c 74  ibes the [result
272c0 20 63 6f 64 65 5d 2c 20 61 73 20 55 54 46 2d 38   code], as UTF-8
272d0 2e 0a 2a 2a 20 5e 28 4d 65 6d 6f 72 79 20 74 6f  ..** ^(Memory to
272e0 20 68 6f 6c 64 20 74 68 65 20 65 72 72 6f 72 20   hold the error 
272f0 6d 65 73 73 61 67 65 20 73 74 72 69 6e 67 20 69  message string i
27300 73 20 6d 61 6e 61 67 65 64 20 69 6e 74 65 72 6e  s managed intern
27310 61 6c 6c 79 0a 2a 2a 20 61 6e 64 20 6d 75 73 74  ally.** and must
27320 20 6e 6f 74 20 62 65 20 66 72 65 65 64 20 62 79   not be freed by
27330 20 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e   the application
27340 29 5e 2e 0a 2a 2a 0a 2a 2a 20 57 68 65 6e 20 74  )^..**.** When t
27350 68 65 20 73 65 72 69 61 6c 69 7a 65 64 20 5b 74  he serialized [t
27360 68 72 65 61 64 69 6e 67 20 6d 6f 64 65 5d 20 69  hreading mode] i
27370 73 20 69 6e 20 75 73 65 2c 20 69 74 20 6d 69 67  s in use, it mig
27380 68 74 20 62 65 20 74 68 65 0a 2a 2a 20 63 61 73  ht be the.** cas
27390 65 20 74 68 61 74 20 61 20 73 65 63 6f 6e 64 20  e that a second 
273a0 65 72 72 6f 72 20 6f 63 63 75 72 73 20 6f 6e 20  error occurs on 
273b0 61 20 73 65 70 61 72 61 74 65 20 74 68 72 65 61  a separate threa
273c0 64 20 69 6e 20 62 65 74 77 65 65 6e 0a 2a 2a 20  d in between.** 
273d0 74 68 65 20 74 69 6d 65 20 6f 66 20 74 68 65 20  the time of the 
273e0 66 69 72 73 74 20 65 72 72 6f 72 20 61 6e 64 20  first error and 
273f0 74 68 65 20 63 61 6c 6c 20 74 6f 20 74 68 65 73  the call to thes
27400 65 20 69 6e 74 65 72 66 61 63 65 73 2e 0a 2a 2a  e interfaces..**
27410 20 57 68 65 6e 20 74 68 61 74 20 68 61 70 70 65   When that happe
27420 6e 73 2c 20 74 68 65 20 73 65 63 6f 6e 64 20 65  ns, the second e
27430 72 72 6f 72 20 77 69 6c 6c 20 62 65 20 72 65 70  rror will be rep
27440 6f 72 74 65 64 20 73 69 6e 63 65 20 74 68 65 73  orted since thes
27450 65 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 73 20  e.** interfaces 
27460 61 6c 77 61 79 73 20 72 65 70 6f 72 74 20 74 68  always report th
27470 65 20 6d 6f 73 74 20 72 65 63 65 6e 74 20 72 65  e most recent re
27480 73 75 6c 74 2e 20 20 54 6f 20 61 76 6f 69 64 0a  sult.  To avoid.
27490 2a 2a 20 74 68 69 73 2c 20 65 61 63 68 20 74 68  ** this, each th
274a0 72 65 61 64 20 63 61 6e 20 6f 62 74 61 69 6e 20  read can obtain 
274b0 65 78 63 6c 75 73 69 76 65 20 75 73 65 20 6f 66  exclusive use of
274c0 20 74 68 65 20 5b 64 61 74 61 62 61 73 65 20 63   the [database c
274d0 6f 6e 6e 65 63 74 69 6f 6e 5d 20 44 0a 2a 2a 20  onnection] D.** 
274e0 62 79 20 69 6e 76 6f 6b 69 6e 67 20 5b 73 71 6c  by invoking [sql
274f0 69 74 65 33 5f 6d 75 74 65 78 5f 65 6e 74 65 72  ite3_mutex_enter
27500 5d 28 5b 73 71 6c 69 74 65 33 5f 64 62 5f 6d 75  ]([sqlite3_db_mu
27510 74 65 78 5d 28 44 29 29 20 62 65 66 6f 72 65 20  tex](D)) before 
27520 62 65 67 69 6e 6e 69 6e 67 0a 2a 2a 20 74 6f 20  beginning.** to 
27530 75 73 65 20 44 20 61 6e 64 20 69 6e 76 6f 6b 69  use D and invoki
27540 6e 67 20 5b 73 71 6c 69 74 65 33 5f 6d 75 74 65  ng [sqlite3_mute
27550 78 5f 6c 65 61 76 65 5d 28 5b 73 71 6c 69 74 65  x_leave]([sqlite
27560 33 5f 64 62 5f 6d 75 74 65 78 5d 28 44 29 29 20  3_db_mutex](D)) 
27570 61 66 74 65 72 0a 2a 2a 20 61 6c 6c 20 63 61 6c  after.** all cal
27580 6c 73 20 74 6f 20 74 68 65 20 69 6e 74 65 72 66  ls to the interf
27590 61 63 65 73 20 6c 69 73 74 65 64 20 68 65 72 65  aces listed here
275a0 20 61 72 65 20 63 6f 6d 70 6c 65 74 65 64 2e 0a   are completed..
275b0 2a 2a 0a 2a 2a 20 49 66 20 61 6e 20 69 6e 74 65  **.** If an inte
275c0 72 66 61 63 65 20 66 61 69 6c 73 20 77 69 74 68  rface fails with
275d0 20 53 51 4c 49 54 45 5f 4d 49 53 55 53 45 2c 20   SQLITE_MISUSE, 
275e0 74 68 61 74 20 6d 65 61 6e 73 20 74 68 65 20 69  that means the i
275f0 6e 74 65 72 66 61 63 65 0a 2a 2a 20 77 61 73 20  nterface.** was 
27600 69 6e 76 6f 6b 65 64 20 69 6e 63 6f 72 72 65 63  invoked incorrec
27610 74 6c 79 20 62 79 20 74 68 65 20 61 70 70 6c 69  tly by the appli
27620 63 61 74 69 6f 6e 2e 20 20 49 6e 20 74 68 61 74  cation.  In that
27630 20 63 61 73 65 2c 20 74 68 65 0a 2a 2a 20 65 72   case, the.** er
27640 72 6f 72 20 63 6f 64 65 20 61 6e 64 20 6d 65 73  ror code and mes
27650 73 61 67 65 20 6d 61 79 20 6f 72 20 6d 61 79 20  sage may or may 
27660 6e 6f 74 20 62 65 20 73 65 74 2e 0a 2a 2f 0a 69  not be set..*/.i
27670 6e 74 20 73 71 6c 69 74 65 33 5f 65 72 72 63 6f  nt sqlite3_errco
27680 64 65 28 73 71 6c 69 74 65 33 20 2a 64 62 29 3b  de(sqlite3 *db);
27690 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 65 78 74  .int sqlite3_ext
276a0 65 6e 64 65 64 5f 65 72 72 63 6f 64 65 28 73 71  ended_errcode(sq
276b0 6c 69 74 65 33 20 2a 64 62 29 3b 0a 63 6f 6e 73  lite3 *db);.cons
276c0 74 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f  t char *sqlite3_
276d0 65 72 72 6d 73 67 28 73 71 6c 69 74 65 33 2a 29  errmsg(sqlite3*)
276e0 3b 0a 63 6f 6e 73 74 20 76 6f 69 64 20 2a 73 71  ;.const void *sq
276f0 6c 69 74 65 33 5f 65 72 72 6d 73 67 31 36 28 73  lite3_errmsg16(s
27700 71 6c 69 74 65 33 2a 29 3b 0a 63 6f 6e 73 74 20  qlite3*);.const 
27710 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f 65 72  char *sqlite3_er
27720 72 73 74 72 28 69 6e 74 29 3b 0a 0a 2f 2a 0a 2a  rstr(int);../*.*
27730 2a 20 43 41 50 49 33 52 45 46 3a 20 50 72 65 70  * CAPI3REF: Prep
27740 61 72 65 64 20 53 74 61 74 65 6d 65 6e 74 20 4f  ared Statement O
27750 62 6a 65 63 74 0a 2a 2a 20 4b 45 59 57 4f 52 44  bject.** KEYWORD
27760 53 3a 20 7b 70 72 65 70 61 72 65 64 20 73 74 61  S: {prepared sta
27770 74 65 6d 65 6e 74 7d 20 7b 70 72 65 70 61 72 65  tement} {prepare
27780 64 20 73 74 61 74 65 6d 65 6e 74 73 7d 0a 2a 2a  d statements}.**
27790 0a 2a 2a 20 41 6e 20 69 6e 73 74 61 6e 63 65 20  .** An instance 
277a0 6f 66 20 74 68 69 73 20 6f 62 6a 65 63 74 20 72  of this object r
277b0 65 70 72 65 73 65 6e 74 73 20 61 20 73 69 6e 67  epresents a sing
277c0 6c 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  le SQL statement
277d0 20 74 68 61 74 0a 2a 2a 20 68 61 73 20 62 65 65   that.** has bee
277e0 6e 20 63 6f 6d 70 69 6c 65 64 20 69 6e 74 6f 20  n compiled into 
277f0 62 69 6e 61 72 79 20 66 6f 72 6d 20 61 6e 64 20  binary form and 
27800 69 73 20 72 65 61 64 79 20 74 6f 20 62 65 20 65  is ready to be e
27810 76 61 6c 75 61 74 65 64 2e 0a 2a 2a 0a 2a 2a 20  valuated..**.** 
27820 54 68 69 6e 6b 20 6f 66 20 65 61 63 68 20 53 51  Think of each SQ
27830 4c 20 73 74 61 74 65 6d 65 6e 74 20 61 73 20 61  L statement as a
27840 20 73 65 70 61 72 61 74 65 20 63 6f 6d 70 75 74   separate comput
27850 65 72 20 70 72 6f 67 72 61 6d 2e 20 20 54 68 65  er program.  The
27860 0a 2a 2a 20 6f 72 69 67 69 6e 61 6c 20 53 51 4c  .** original SQL
27870 20 74 65 78 74 20 69 73 20 73 6f 75 72 63 65 20   text is source 
27880 63 6f 64 65 2e 20 20 41 20 70 72 65 70 61 72 65  code.  A prepare
27890 64 20 73 74 61 74 65 6d 65 6e 74 20 6f 62 6a 65  d statement obje
278a0 63 74 20 0a 2a 2a 20 69 73 20 74 68 65 20 63 6f  ct .** is the co
278b0 6d 70 69 6c 65 64 20 6f 62 6a 65 63 74 20 63 6f  mpiled object co
278c0 64 65 2e 20 20 41 6c 6c 20 53 51 4c 20 6d 75 73  de.  All SQL mus
278d0 74 20 62 65 20 63 6f 6e 76 65 72 74 65 64 20 69  t be converted i
278e0 6e 74 6f 20 61 0a 2a 2a 20 70 72 65 70 61 72 65  nto a.** prepare
278f0 64 20 73 74 61 74 65 6d 65 6e 74 20 62 65 66 6f  d statement befo
27900 72 65 20 69 74 20 63 61 6e 20 62 65 20 72 75 6e  re it can be run
27910 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 6c 69 66 65  ..**.** The life
27920 2d 63 79 63 6c 65 20 6f 66 20 61 20 70 72 65 70  -cycle of a prep
27930 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 20 6f  ared statement o
27940 62 6a 65 63 74 20 75 73 75 61 6c 6c 79 20 67 6f  bject usually go
27950 65 73 20 6c 69 6b 65 20 74 68 69 73 3a 0a 2a 2a  es like this:.**
27960 0a 2a 2a 20 3c 6f 6c 3e 0a 2a 2a 20 3c 6c 69 3e  .** <ol>.** <li>
27970 20 43 72 65 61 74 65 20 74 68 65 20 70 72 65 70   Create the prep
27980 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 20 6f  ared statement o
27990 62 6a 65 63 74 20 75 73 69 6e 67 20 5b 73 71 6c  bject using [sql
279a0 69 74 65 33 5f 70 72 65 70 61 72 65 5f 76 32 28  ite3_prepare_v2(
279b0 29 5d 2e 0a 2a 2a 20 3c 6c 69 3e 20 42 69 6e 64  )]..** <li> Bind
279c0 20 76 61 6c 75 65 73 20 74 6f 20 5b 70 61 72 61   values to [para
279d0 6d 65 74 65 72 73 5d 20 75 73 69 6e 67 20 74 68  meters] using th
279e0 65 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 2a  e sqlite3_bind_*
279f0 28 29 0a 2a 2a 20 20 20 20 20 20 69 6e 74 65 72  ().**      inter
27a00 66 61 63 65 73 2e 0a 2a 2a 20 3c 6c 69 3e 20 52  faces..** <li> R
27a10 75 6e 20 74 68 65 20 53 51 4c 20 62 79 20 63 61  un the SQL by ca
27a20 6c 6c 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 73  lling [sqlite3_s
27a30 74 65 70 28 29 5d 20 6f 6e 65 20 6f 72 20 6d 6f  tep()] one or mo
27a40 72 65 20 74 69 6d 65 73 2e 0a 2a 2a 20 3c 6c 69  re times..** <li
27a50 3e 20 52 65 73 65 74 20 74 68 65 20 70 72 65 70  > Reset the prep
27a60 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 20 75  ared statement u
27a70 73 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 72 65  sing [sqlite3_re
27a80 73 65 74 28 29 5d 20 74 68 65 6e 20 67 6f 20 62  set()] then go b
27a90 61 63 6b 0a 2a 2a 20 20 20 20 20 20 74 6f 20 73  ack.**      to s
27aa0 74 65 70 20 32 2e 20 20 44 6f 20 74 68 69 73 20  tep 2.  Do this 
27ab0 7a 65 72 6f 20 6f 72 20 6d 6f 72 65 20 74 69 6d  zero or more tim
27ac0 65 73 2e 0a 2a 2a 20 3c 6c 69 3e 20 44 65 73 74  es..** <li> Dest
27ad0 72 6f 79 20 74 68 65 20 6f 62 6a 65 63 74 20 75  roy the object u
27ae0 73 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 66 69  sing [sqlite3_fi
27af0 6e 61 6c 69 7a 65 28 29 5d 2e 0a 2a 2a 20 3c 2f  nalize()]..** </
27b00 6f 6c 3e 0a 2a 2f 0a 74 79 70 65 64 65 66 20 73  ol>.*/.typedef s
27b10 74 72 75 63 74 20 73 71 6c 69 74 65 33 5f 73 74  truct sqlite3_st
27b20 6d 74 20 73 71 6c 69 74 65 33 5f 73 74 6d 74 3b  mt sqlite3_stmt;
27b30 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46  ../*.** CAPI3REF
27b40 3a 20 52 75 6e 2d 74 69 6d 65 20 4c 69 6d 69 74  : Run-time Limit
27b50 73 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c  s.** METHOD: sql
27b60 69 74 65 33 0a 2a 2a 0a 2a 2a 20 5e 28 54 68 69  ite3.**.** ^(Thi
27b70 73 20 69 6e 74 65 72 66 61 63 65 20 61 6c 6c 6f  s interface allo
27b80 77 73 20 74 68 65 20 73 69 7a 65 20 6f 66 20 76  ws the size of v
27b90 61 72 69 6f 75 73 20 63 6f 6e 73 74 72 75 63 74  arious construct
27ba0 73 20 74 6f 20 62 65 20 6c 69 6d 69 74 65 64 0a  s to be limited.
27bb0 2a 2a 20 6f 6e 20 61 20 63 6f 6e 6e 65 63 74 69  ** on a connecti
27bc0 6f 6e 20 62 79 20 63 6f 6e 6e 65 63 74 69 6f 6e  on by connection
27bd0 20 62 61 73 69 73 2e 20 20 54 68 65 20 66 69 72   basis.  The fir
27be0 73 74 20 70 61 72 61 6d 65 74 65 72 20 69 73 20  st parameter is 
27bf0 74 68 65 0a 2a 2a 20 5b 64 61 74 61 62 61 73 65  the.** [database
27c00 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 77 68 6f   connection] who
27c10 73 65 20 6c 69 6d 69 74 20 69 73 20 74 6f 20 62  se limit is to b
27c20 65 20 73 65 74 20 6f 72 20 71 75 65 72 69 65 64  e set or queried
27c30 2e 20 20 54 68 65 0a 2a 2a 20 73 65 63 6f 6e 64  .  The.** second
27c40 20 70 61 72 61 6d 65 74 65 72 20 69 73 20 6f 6e   parameter is on
27c50 65 20 6f 66 20 74 68 65 20 5b 6c 69 6d 69 74 20  e of the [limit 
27c60 63 61 74 65 67 6f 72 69 65 73 5d 20 74 68 61 74  categories] that
27c70 20 64 65 66 69 6e 65 20 61 0a 2a 2a 20 63 6c 61   define a.** cla
27c80 73 73 20 6f 66 20 63 6f 6e 73 74 72 75 63 74 73  ss of constructs
27c90 20 74 6f 20 62 65 20 73 69 7a 65 20 6c 69 6d 69   to be size limi
27ca0 74 65 64 2e 20 20 54 68 65 20 74 68 69 72 64 20  ted.  The third 
27cb0 70 61 72 61 6d 65 74 65 72 20 69 73 20 74 68 65  parameter is the
27cc0 0a 2a 2a 20 6e 65 77 20 6c 69 6d 69 74 20 66 6f  .** new limit fo
27cd0 72 20 74 68 61 74 20 63 6f 6e 73 74 72 75 63 74  r that construct
27ce0 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68  .)^.**.** ^If th
27cf0 65 20 6e 65 77 20 6c 69 6d 69 74 20 69 73 20 61  e new limit is a
27d00 20 6e 65 67 61 74 69 76 65 20 6e 75 6d 62 65 72   negative number
27d10 2c 20 74 68 65 20 6c 69 6d 69 74 20 69 73 20 75  , the limit is u
27d20 6e 63 68 61 6e 67 65 64 2e 0a 2a 2a 20 5e 28 46  nchanged..** ^(F
27d30 6f 72 20 65 61 63 68 20 6c 69 6d 69 74 20 63 61  or each limit ca
27d40 74 65 67 6f 72 79 20 53 51 4c 49 54 45 5f 4c 49  tegory SQLITE_LI
27d50 4d 49 54 5f 3c 69 3e 4e 41 4d 45 3c 2f 69 3e 20  MIT_<i>NAME</i> 
27d60 74 68 65 72 65 20 69 73 20 61 20 0a 2a 2a 20 5b  there is a .** [
27d70 6c 69 6d 69 74 73 20 7c 20 68 61 72 64 20 75 70  limits | hard up
27d80 70 65 72 20 62 6f 75 6e 64 5d 0a 2a 2a 20 73 65  per bound].** se
27d90 74 20 61 74 20 63 6f 6d 70 69 6c 65 2d 74 69 6d  t at compile-tim
27da0 65 20 62 79 20 61 20 43 20 70 72 65 70 72 6f 63  e by a C preproc
27db0 65 73 73 6f 72 20 6d 61 63 72 6f 20 63 61 6c 6c  essor macro call
27dc0 65 64 0a 2a 2a 20 5b 6c 69 6d 69 74 73 20 7c 20  ed.** [limits | 
27dd0 53 51 4c 49 54 45 5f 4d 41 58 5f 3c 69 3e 4e 41  SQLITE_MAX_<i>NA
27de0 4d 45 3c 2f 69 3e 5d 2e 0a 2a 2a 20 28 54 68 65  ME</i>]..** (The
27df0 20 22 5f 4c 49 4d 49 54 5f 22 20 69 6e 20 74 68   "_LIMIT_" in th
27e00 65 20 6e 61 6d 65 20 69 73 20 63 68 61 6e 67 65  e name is change
27e10 64 20 74 6f 20 22 5f 4d 41 58 5f 22 2e 29 29 5e  d to "_MAX_".))^
27e20 0a 2a 2a 20 5e 41 74 74 65 6d 70 74 73 20 74 6f  .** ^Attempts to
27e30 20 69 6e 63 72 65 61 73 65 20 61 20 6c 69 6d 69   increase a limi
27e40 74 20 61 62 6f 76 65 20 69 74 73 20 68 61 72 64  t above its hard
27e50 20 75 70 70 65 72 20 62 6f 75 6e 64 20 61 72 65   upper bound are
27e60 0a 2a 2a 20 73 69 6c 65 6e 74 6c 79 20 74 72 75  .** silently tru
27e70 6e 63 61 74 65 64 20 74 6f 20 74 68 65 20 68 61  ncated to the ha
27e80 72 64 20 75 70 70 65 72 20 62 6f 75 6e 64 2e 0a  rd upper bound..
27e90 2a 2a 0a 2a 2a 20 5e 52 65 67 61 72 64 6c 65 73  **.** ^Regardles
27ea0 73 20 6f 66 20 77 68 65 74 68 65 72 20 6f 72 20  s of whether or 
27eb0 6e 6f 74 20 74 68 65 20 6c 69 6d 69 74 20 77 61  not the limit wa
27ec0 73 20 63 68 61 6e 67 65 64 2c 20 74 68 65 20 0a  s changed, the .
27ed0 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 6c 69 6d 69  ** [sqlite3_limi
27ee0 74 28 29 5d 20 69 6e 74 65 72 66 61 63 65 20 72  t()] interface r
27ef0 65 74 75 72 6e 73 20 74 68 65 20 70 72 69 6f 72  eturns the prior
27f00 20 76 61 6c 75 65 20 6f 66 20 74 68 65 20 6c 69   value of the li
27f10 6d 69 74 2e 0a 2a 2a 20 5e 48 65 6e 63 65 2c 20  mit..** ^Hence, 
27f20 74 6f 20 66 69 6e 64 20 74 68 65 20 63 75 72 72  to find the curr
27f30 65 6e 74 20 76 61 6c 75 65 20 6f 66 20 61 20 6c  ent value of a l
27f40 69 6d 69 74 20 77 69 74 68 6f 75 74 20 63 68 61  imit without cha
27f50 6e 67 69 6e 67 20 69 74 2c 0a 2a 2a 20 73 69 6d  nging it,.** sim
27f60 70 6c 79 20 69 6e 76 6f 6b 65 20 74 68 69 73 20  ply invoke this 
27f70 69 6e 74 65 72 66 61 63 65 20 77 69 74 68 20 74  interface with t
27f80 68 65 20 74 68 69 72 64 20 70 61 72 61 6d 65 74  he third paramet
27f90 65 72 20 73 65 74 20 74 6f 20 2d 31 2e 0a 2a 2a  er set to -1..**
27fa0 0a 2a 2a 20 52 75 6e 2d 74 69 6d 65 20 6c 69 6d  .** Run-time lim
27fb0 69 74 73 20 61 72 65 20 69 6e 74 65 6e 64 65 64  its are intended
27fc0 20 66 6f 72 20 75 73 65 20 69 6e 20 61 70 70 6c   for use in appl
27fd0 69 63 61 74 69 6f 6e 73 20 74 68 61 74 20 6d 61  ications that ma
27fe0 6e 61 67 65 0a 2a 2a 20 62 6f 74 68 20 74 68 65  nage.** both the
27ff0 69 72 20 6f 77 6e 20 69 6e 74 65 72 6e 61 6c 20  ir own internal 
28000 64 61 74 61 62 61 73 65 20 61 6e 64 20 61 6c 73  database and als
28010 6f 20 64 61 74 61 62 61 73 65 73 20 74 68 61 74  o databases that
28020 20 61 72 65 20 63 6f 6e 74 72 6f 6c 6c 65 64 0a   are controlled.
28030 2a 2a 20 62 79 20 75 6e 74 72 75 73 74 65 64 20  ** by untrusted 
28040 65 78 74 65 72 6e 61 6c 20 73 6f 75 72 63 65 73  external sources
28050 2e 20 20 41 6e 20 65 78 61 6d 70 6c 65 20 61 70  .  An example ap
28060 70 6c 69 63 61 74 69 6f 6e 20 6d 69 67 68 74 20  plication might 
28070 62 65 20 61 0a 2a 2a 20 77 65 62 20 62 72 6f 77  be a.** web brow
28080 73 65 72 20 74 68 61 74 20 68 61 73 20 69 74 73  ser that has its
28090 20 6f 77 6e 20 64 61 74 61 62 61 73 65 73 20 66   own databases f
280a0 6f 72 20 73 74 6f 72 69 6e 67 20 68 69 73 74 6f  or storing histo
280b0 72 79 20 61 6e 64 0a 2a 2a 20 73 65 70 61 72 61  ry and.** separa
280c0 74 65 20 64 61 74 61 62 61 73 65 73 20 63 6f 6e  te databases con
280d0 74 72 6f 6c 6c 65 64 20 62 79 20 4a 61 76 61 53  trolled by JavaS
280e0 63 72 69 70 74 20 61 70 70 6c 69 63 61 74 69 6f  cript applicatio
280f0 6e 73 20 64 6f 77 6e 6c 6f 61 64 65 64 0a 2a 2a  ns downloaded.**
28100 20 6f 66 66 20 74 68 65 20 49 6e 74 65 72 6e 65   off the Interne
28110 74 2e 20 20 54 68 65 20 69 6e 74 65 72 6e 61 6c  t.  The internal
28120 20 64 61 74 61 62 61 73 65 73 20 63 61 6e 20 62   databases can b
28130 65 20 67 69 76 65 6e 20 74 68 65 0a 2a 2a 20 6c  e given the.** l
28140 61 72 67 65 2c 20 64 65 66 61 75 6c 74 20 6c 69  arge, default li
28150 6d 69 74 73 2e 20 20 44 61 74 61 62 61 73 65 73  mits.  Databases
28160 20 6d 61 6e 61 67 65 64 20 62 79 20 65 78 74 65   managed by exte
28170 72 6e 61 6c 20 73 6f 75 72 63 65 73 20 63 61 6e  rnal sources can
28180 0a 2a 2a 20 62 65 20 67 69 76 65 6e 20 6d 75 63  .** be given muc
28190 68 20 73 6d 61 6c 6c 65 72 20 6c 69 6d 69 74 73  h smaller limits
281a0 20 64 65 73 69 67 6e 65 64 20 74 6f 20 70 72 65   designed to pre
281b0 76 65 6e 74 20 61 20 64 65 6e 69 61 6c 20 6f 66  vent a denial of
281c0 20 73 65 72 76 69 63 65 0a 2a 2a 20 61 74 74 61   service.** atta
281d0 63 6b 2e 20 20 44 65 76 65 6c 6f 70 65 72 73 20  ck.  Developers 
281e0 6d 69 67 68 74 20 61 6c 73 6f 20 77 61 6e 74 20  might also want 
281f0 74 6f 20 75 73 65 20 74 68 65 20 5b 73 71 6c 69  to use the [sqli
28200 74 65 33 5f 73 65 74 5f 61 75 74 68 6f 72 69 7a  te3_set_authoriz
28210 65 72 28 29 5d 0a 2a 2a 20 69 6e 74 65 72 66 61  er()].** interfa
28220 63 65 20 74 6f 20 66 75 72 74 68 65 72 20 63 6f  ce to further co
28230 6e 74 72 6f 6c 20 75 6e 74 72 75 73 74 65 64 20  ntrol untrusted 
28240 53 51 4c 2e 20 20 54 68 65 20 73 69 7a 65 20 6f  SQL.  The size o
28250 66 20 74 68 65 20 64 61 74 61 62 61 73 65 0a 2a  f the database.*
28260 2a 20 63 72 65 61 74 65 64 20 62 79 20 61 6e 20  * created by an 
28270 75 6e 74 72 75 73 74 65 64 20 73 63 72 69 70 74  untrusted script
28280 20 63 61 6e 20 62 65 20 63 6f 6e 74 61 69 6e 65   can be containe
28290 64 20 75 73 69 6e 67 20 74 68 65 0a 2a 2a 20 5b  d using the.** [
282a0 6d 61 78 5f 70 61 67 65 5f 63 6f 75 6e 74 5d 20  max_page_count] 
282b0 5b 50 52 41 47 4d 41 5d 2e 0a 2a 2a 0a 2a 2a 20  [PRAGMA]..**.** 
282c0 4e 65 77 20 72 75 6e 2d 74 69 6d 65 20 6c 69 6d  New run-time lim
282d0 69 74 20 63 61 74 65 67 6f 72 69 65 73 20 6d 61  it categories ma
282e0 79 20 62 65 20 61 64 64 65 64 20 69 6e 20 66 75  y be added in fu
282f0 74 75 72 65 20 72 65 6c 65 61 73 65 73 2e 0a 2a  ture releases..*
28300 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 6c 69  /.int sqlite3_li
28310 6d 69 74 28 73 71 6c 69 74 65 33 2a 2c 20 69 6e  mit(sqlite3*, in
28320 74 20 69 64 2c 20 69 6e 74 20 6e 65 77 56 61 6c  t id, int newVal
28330 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  );../*.** CAPI3R
28340 45 46 3a 20 52 75 6e 2d 54 69 6d 65 20 4c 69 6d  EF: Run-Time Lim
28350 69 74 20 43 61 74 65 67 6f 72 69 65 73 0a 2a 2a  it Categories.**
28360 20 4b 45 59 57 4f 52 44 53 3a 20 7b 6c 69 6d 69   KEYWORDS: {limi
28370 74 20 63 61 74 65 67 6f 72 79 7d 20 7b 2a 6c 69  t category} {*li
28380 6d 69 74 20 63 61 74 65 67 6f 72 69 65 73 7d 0a  mit categories}.
28390 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 63 6f 6e 73  **.** These cons
283a0 74 61 6e 74 73 20 64 65 66 69 6e 65 20 76 61 72  tants define var
283b0 69 6f 75 73 20 70 65 72 66 6f 72 6d 61 6e 63 65  ious performance
283c0 20 6c 69 6d 69 74 73 0a 2a 2a 20 74 68 61 74 20   limits.** that 
283d0 63 61 6e 20 62 65 20 6c 6f 77 65 72 65 64 20 61  can be lowered a
283e0 74 20 72 75 6e 2d 74 69 6d 65 20 75 73 69 6e 67  t run-time using
283f0 20 5b 73 71 6c 69 74 65 33 5f 6c 69 6d 69 74 28   [sqlite3_limit(
28400 29 5d 2e 0a 2a 2a 20 54 68 65 20 73 79 6e 6f 70  )]..** The synop
28410 73 69 73 20 6f 66 20 74 68 65 20 6d 65 61 6e 69  sis of the meani
28420 6e 67 73 20 6f 66 20 74 68 65 20 76 61 72 69 6f  ngs of the vario
28430 75 73 20 6c 69 6d 69 74 73 20 69 73 20 73 68 6f  us limits is sho
28440 77 6e 20 62 65 6c 6f 77 2e 0a 2a 2a 20 41 64 64  wn below..** Add
28450 69 74 69 6f 6e 61 6c 20 69 6e 66 6f 72 6d 61 74  itional informat
28460 69 6f 6e 20 69 73 20 61 76 61 69 6c 61 62 6c 65  ion is available
28470 20 61 74 20 5b 6c 69 6d 69 74 73 20 7c 20 4c 69   at [limits | Li
28480 6d 69 74 73 20 69 6e 20 53 51 4c 69 74 65 5d 2e  mits in SQLite].
28490 0a 2a 2a 0a 2a 2a 20 3c 64 6c 3e 0a 2a 2a 20 5b  .**.** <dl>.** [
284a0 5b 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 4c 45  [SQLITE_LIMIT_LE
284b0 4e 47 54 48 5d 5d 20 5e 28 3c 64 74 3e 53 51 4c  NGTH]] ^(<dt>SQL
284c0 49 54 45 5f 4c 49 4d 49 54 5f 4c 45 4e 47 54 48  ITE_LIMIT_LENGTH
284d0 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65  </dt>.** <dd>The
284e0 20 6d 61 78 69 6d 75 6d 20 73 69 7a 65 20 6f 66   maximum size of
284f0 20 61 6e 79 20 73 74 72 69 6e 67 20 6f 72 20 42   any string or B
28500 4c 4f 42 20 6f 72 20 74 61 62 6c 65 20 72 6f 77  LOB or table row
28510 2c 20 69 6e 20 62 79 74 65 73 2e 3c 64 64 3e 29  , in bytes.<dd>)
28520 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45  ^.**.** [[SQLITE
28530 5f 4c 49 4d 49 54 5f 53 51 4c 5f 4c 45 4e 47 54  _LIMIT_SQL_LENGT
28540 48 5d 5d 20 5e 28 3c 64 74 3e 53 51 4c 49 54 45  H]] ^(<dt>SQLITE
28550 5f 4c 49 4d 49 54 5f 53 51 4c 5f 4c 45 4e 47 54  _LIMIT_SQL_LENGT
28560 48 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68  H</dt>.** <dd>Th
28570 65 20 6d 61 78 69 6d 75 6d 20 6c 65 6e 67 74 68  e maximum length
28580 20 6f 66 20 61 6e 20 53 51 4c 20 73 74 61 74 65   of an SQL state
28590 6d 65 6e 74 2c 20 69 6e 20 62 79 74 65 73 2e 3c  ment, in bytes.<
285a0 2f 64 64 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 53  /dd>)^.**.** [[S
285b0 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 43 4f 4c 55  QLITE_LIMIT_COLU
285c0 4d 4e 5d 5d 20 5e 28 3c 64 74 3e 53 51 4c 49 54  MN]] ^(<dt>SQLIT
285d0 45 5f 4c 49 4d 49 54 5f 43 4f 4c 55 4d 4e 3c 2f  E_LIMIT_COLUMN</
285e0 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65 20 6d  dt>.** <dd>The m
285f0 61 78 69 6d 75 6d 20 6e 75 6d 62 65 72 20 6f 66  aximum number of
28600 20 63 6f 6c 75 6d 6e 73 20 69 6e 20 61 20 74 61   columns in a ta
28610 62 6c 65 20 64 65 66 69 6e 69 74 69 6f 6e 20 6f  ble definition o
28620 72 20 69 6e 20 74 68 65 0a 2a 2a 20 72 65 73 75  r in the.** resu
28630 6c 74 20 73 65 74 20 6f 66 20 61 20 5b 53 45 4c  lt set of a [SEL
28640 45 43 54 5d 20 6f 72 20 74 68 65 20 6d 61 78 69  ECT] or the maxi
28650 6d 75 6d 20 6e 75 6d 62 65 72 20 6f 66 20 63 6f  mum number of co
28660 6c 75 6d 6e 73 20 69 6e 20 61 6e 20 69 6e 64 65  lumns in an inde
28670 78 0a 2a 2a 20 6f 72 20 69 6e 20 61 6e 20 4f 52  x.** or in an OR
28680 44 45 52 20 42 59 20 6f 72 20 47 52 4f 55 50 20  DER BY or GROUP 
28690 42 59 20 63 6c 61 75 73 65 2e 3c 2f 64 64 3e 29  BY clause.</dd>)
286a0 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45  ^.**.** [[SQLITE
286b0 5f 4c 49 4d 49 54 5f 45 58 50 52 5f 44 45 50 54  _LIMIT_EXPR_DEPT
286c0 48 5d 5d 20 5e 28 3c 64 74 3e 53 51 4c 49 54 45  H]] ^(<dt>SQLITE
286d0 5f 4c 49 4d 49 54 5f 45 58 50 52 5f 44 45 50 54  _LIMIT_EXPR_DEPT
286e0 48 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68  H</dt>.** <dd>Th
286f0 65 20 6d 61 78 69 6d 75 6d 20 64 65 70 74 68 20  e maximum depth 
28700 6f 66 20 74 68 65 20 70 61 72 73 65 20 74 72 65  of the parse tre
28710 65 20 6f 6e 20 61 6e 79 20 65 78 70 72 65 73 73  e on any express
28720 69 6f 6e 2e 3c 2f 64 64 3e 29 5e 0a 2a 2a 0a 2a  ion.</dd>)^.**.*
28730 2a 20 5b 5b 53 51 4c 49 54 45 5f 4c 49 4d 49 54  * [[SQLITE_LIMIT
28740 5f 43 4f 4d 50 4f 55 4e 44 5f 53 45 4c 45 43 54  _COMPOUND_SELECT
28750 5d 5d 20 5e 28 3c 64 74 3e 53 51 4c 49 54 45 5f  ]] ^(<dt>SQLITE_
28760 4c 49 4d 49 54 5f 43 4f 4d 50 4f 55 4e 44 5f 53  LIMIT_COMPOUND_S
28770 45 4c 45 43 54 3c 2f 64 74 3e 0a 2a 2a 20 3c 64  ELECT</dt>.** <d
28780 64 3e 54 68 65 20 6d 61 78 69 6d 75 6d 20 6e 75  d>The maximum nu
28790 6d 62 65 72 20 6f 66 20 74 65 72 6d 73 20 69 6e  mber of terms in
287a0 20 61 20 63 6f 6d 70 6f 75 6e 64 20 53 45 4c 45   a compound SELE
287b0 43 54 20 73 74 61 74 65 6d 65 6e 74 2e 3c 2f 64  CT statement.</d
287c0 64 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c  d>)^.**.** [[SQL
287d0 49 54 45 5f 4c 49 4d 49 54 5f 56 44 42 45 5f 4f  ITE_LIMIT_VDBE_O
287e0 50 5d 5d 20 5e 28 3c 64 74 3e 53 51 4c 49 54 45  P]] ^(<dt>SQLITE
287f0 5f 4c 49 4d 49 54 5f 56 44 42 45 5f 4f 50 3c 2f  _LIMIT_VDBE_OP</
28800 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65 20 6d  dt>.** <dd>The m
28810 61 78 69 6d 75 6d 20 6e 75 6d 62 65 72 20 6f 66  aximum number of
28820 20 69 6e 73 74 72 75 63 74 69 6f 6e 73 20 69 6e   instructions in
28830 20 61 20 76 69 72 74 75 61 6c 20 6d 61 63 68 69   a virtual machi
28840 6e 65 20 70 72 6f 67 72 61 6d 0a 2a 2a 20 75 73  ne program.** us
28850 65 64 20 74 6f 20 69 6d 70 6c 65 6d 65 6e 74 20  ed to implement 
28860 61 6e 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  an SQL statement
28870 2e 20 20 54 68 69 73 20 6c 69 6d 69 74 20 69 73  .  This limit is
28880 20 6e 6f 74 20 63 75 72 72 65 6e 74 6c 79 0a 2a   not currently.*
28890 2a 20 65 6e 66 6f 72 63 65 64 2c 20 74 68 6f 75  * enforced, thou
288a0 67 68 20 74 68 61 74 20 6d 69 67 68 74 20 62 65  gh that might be
288b0 20 61 64 64 65 64 20 69 6e 20 73 6f 6d 65 20 66   added in some f
288c0 75 74 75 72 65 20 72 65 6c 65 61 73 65 20 6f 66  uture release of
288d0 0a 2a 2a 20 53 51 4c 69 74 65 2e 3c 2f 64 64 3e  .** SQLite.</dd>
288e0 29 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54  )^.**.** [[SQLIT
288f0 45 5f 4c 49 4d 49 54 5f 46 55 4e 43 54 49 4f 4e  E_LIMIT_FUNCTION
28900 5f 41 52 47 5d 5d 20 5e 28 3c 64 74 3e 53 51 4c  _ARG]] ^(<dt>SQL
28910 49 54 45 5f 4c 49 4d 49 54 5f 46 55 4e 43 54 49  ITE_LIMIT_FUNCTI
28920 4f 4e 5f 41 52 47 3c 2f 64 74 3e 0a 2a 2a 20 3c  ON_ARG</dt>.** <
28930 64 64 3e 54 68 65 20 6d 61 78 69 6d 75 6d 20 6e  dd>The maximum n
28940 75 6d 62 65 72 20 6f 66 20 61 72 67 75 6d 65 6e  umber of argumen
28950 74 73 20 6f 6e 20 61 20 66 75 6e 63 74 69 6f 6e  ts on a function
28960 2e 3c 2f 64 64 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5b  .</dd>)^.**.** [
28970 5b 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 41 54  [SQLITE_LIMIT_AT
28980 54 41 43 48 45 44 5d 5d 20 5e 28 3c 64 74 3e 53  TACHED]] ^(<dt>S
28990 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 41 54 54 41  QLITE_LIMIT_ATTA
289a0 43 48 45 44 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64  CHED</dt>.** <dd
289b0 3e 54 68 65 20 6d 61 78 69 6d 75 6d 20 6e 75 6d  >The maximum num
289c0 62 65 72 20 6f 66 20 5b 41 54 54 41 43 48 20 7c  ber of [ATTACH |
289d0 20 61 74 74 61 63 68 65 64 20 64 61 74 61 62 61   attached databa
289e0 73 65 73 5d 2e 29 5e 3c 2f 64 64 3e 0a 2a 2a 0a  ses].)^</dd>.**.
289f0 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f 4c 49 4d 49  ** [[SQLITE_LIMI
28a00 54 5f 4c 49 4b 45 5f 50 41 54 54 45 52 4e 5f 4c  T_LIKE_PATTERN_L
28a10 45 4e 47 54 48 5d 5d 0a 2a 2a 20 5e 28 3c 64 74  ENGTH]].** ^(<dt
28a20 3e 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 4c 49  >SQLITE_LIMIT_LI
28a30 4b 45 5f 50 41 54 54 45 52 4e 5f 4c 45 4e 47 54  KE_PATTERN_LENGT
28a40 48 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68  H</dt>.** <dd>Th
28a50 65 20 6d 61 78 69 6d 75 6d 20 6c 65 6e 67 74 68  e maximum length
28a60 20 6f 66 20 74 68 65 20 70 61 74 74 65 72 6e 20   of the pattern 
28a70 61 72 67 75 6d 65 6e 74 20 74 6f 20 74 68 65 20  argument to the 
28a80 5b 4c 49 4b 45 5d 20 6f 72 0a 2a 2a 20 5b 47 4c  [LIKE] or.** [GL
28a90 4f 42 5d 20 6f 70 65 72 61 74 6f 72 73 2e 3c 2f  OB] operators.</
28aa0 64 64 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51  dd>)^.**.** [[SQ
28ab0 4c 49 54 45 5f 4c 49 4d 49 54 5f 56 41 52 49 41  LITE_LIMIT_VARIA
28ac0 42 4c 45 5f 4e 55 4d 42 45 52 5d 5d 0a 2a 2a 20  BLE_NUMBER]].** 
28ad0 5e 28 3c 64 74 3e 53 51 4c 49 54 45 5f 4c 49 4d  ^(<dt>SQLITE_LIM
28ae0 49 54 5f 56 41 52 49 41 42 4c 45 5f 4e 55 4d 42  IT_VARIABLE_NUMB
28af0 45 52 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54  ER</dt>.** <dd>T
28b00 68 65 20 6d 61 78 69 6d 75 6d 20 69 6e 64 65 78  he maximum index
28b10 20 6e 75 6d 62 65 72 20 6f 66 20 61 6e 79 20 5b   number of any [
28b20 70 61 72 61 6d 65 74 65 72 5d 20 69 6e 20 61 6e  parameter] in an
28b30 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 2e 29   SQL statement.)
28b40 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45  ^.**.** [[SQLITE
28b50 5f 4c 49 4d 49 54 5f 54 52 49 47 47 45 52 5f 44  _LIMIT_TRIGGER_D
28b60 45 50 54 48 5d 5d 20 5e 28 3c 64 74 3e 53 51 4c  EPTH]] ^(<dt>SQL
28b70 49 54 45 5f 4c 49 4d 49 54 5f 54 52 49 47 47 45  ITE_LIMIT_TRIGGE
28b80 52 5f 44 45 50 54 48 3c 2f 64 74 3e 0a 2a 2a 20  R_DEPTH</dt>.** 
28b90 3c 64 64 3e 54 68 65 20 6d 61 78 69 6d 75 6d 20  <dd>The maximum 
28ba0 64 65 70 74 68 20 6f 66 20 72 65 63 75 72 73 69  depth of recursi
28bb0 6f 6e 20 66 6f 72 20 74 72 69 67 67 65 72 73 2e  on for triggers.
28bc0 3c 2f 64 64 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5b 5b  </dd>)^.**.** [[
28bd0 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 57 4f 52  SQLITE_LIMIT_WOR
28be0 4b 45 52 5f 54 48 52 45 41 44 53 5d 5d 20 5e 28  KER_THREADS]] ^(
28bf0 3c 64 74 3e 53 51 4c 49 54 45 5f 4c 49 4d 49 54  <dt>SQLITE_LIMIT
28c00 5f 57 4f 52 4b 45 52 5f 54 48 52 45 41 44 53 3c  _WORKER_THREADS<
28c10 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65 20  /dt>.** <dd>The 
28c20 6d 61 78 69 6d 75 6d 20 6e 75 6d 62 65 72 20 6f  maximum number o
28c30 66 20 61 75 78 69 6c 69 61 72 79 20 77 6f 72 6b  f auxiliary work
28c40 65 72 20 74 68 72 65 61 64 73 20 74 68 61 74 20  er threads that 
28c50 61 20 73 69 6e 67 6c 65 0a 2a 2a 20 5b 70 72 65  a single.** [pre
28c60 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d  pared statement]
28c70 20 6d 61 79 20 73 74 61 72 74 2e 3c 2f 64 64 3e   may start.</dd>
28c80 29 5e 0a 2a 2a 20 3c 2f 64 6c 3e 0a 2a 2f 0a 23  )^.** </dl>.*/.#
28c90 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c 49  define SQLITE_LI
28ca0 4d 49 54 5f 4c 45 4e 47 54 48 20 20 20 20 20 20  MIT_LENGTH      
28cb0 20 20 20 20 20 20 20 20 20 20 20 20 20 20 30 0a                0.
28cc0 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c  #define SQLITE_L
28cd0 49 4d 49 54 5f 53 51 4c 5f 4c 45 4e 47 54 48 20  IMIT_SQL_LENGTH 
28ce0 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 31                 1
28cf0 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
28d00 4c 49 4d 49 54 5f 43 4f 4c 55 4d 4e 20 20 20 20  LIMIT_COLUMN    
28d10 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
28d20 32 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  2.#define SQLITE
28d30 5f 4c 49 4d 49 54 5f 45 58 50 52 5f 44 45 50 54  _LIMIT_EXPR_DEPT
28d40 48 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  H               
28d50 20 33 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54   3.#define SQLIT
28d60 45 5f 4c 49 4d 49 54 5f 43 4f 4d 50 4f 55 4e 44  E_LIMIT_COMPOUND
28d70 5f 53 45 4c 45 43 54 20 20 20 20 20 20 20 20 20  _SELECT         
28d80 20 20 34 0a 23 64 65 66 69 6e 65 20 53 51 4c 49    4.#define SQLI
28d90 54 45 5f 4c 49 4d 49 54 5f 56 44 42 45 5f 4f 50  TE_LIMIT_VDBE_OP
28da0 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
28db0 20 20 20 35 0a 23 64 65 66 69 6e 65 20 53 51 4c     5.#define SQL
28dc0 49 54 45 5f 4c 49 4d 49 54 5f 46 55 4e 43 54 49  ITE_LIMIT_FUNCTI
28dd0 4f 4e 5f 41 52 47 20 20 20 20 20 20 20 20 20 20  ON_ARG          
28de0 20 20 20 20 36 0a 23 64 65 66 69 6e 65 20 53 51      6.#define SQ
28df0 4c 49 54 45 5f 4c 49 4d 49 54 5f 41 54 54 41 43  LITE_LIMIT_ATTAC
28e00 48 45 44 20 20 20 20 20 20 20 20 20 20 20 20 20  HED             
28e10 20 20 20 20 20 37 0a 23 64 65 66 69 6e 65 20 53       7.#define S
28e20 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 4c 49 4b 45  QLITE_LIMIT_LIKE
28e30 5f 50 41 54 54 45 52 4e 5f 4c 45 4e 47 54 48 20  _PATTERN_LENGTH 
28e40 20 20 20 20 20 20 38 0a 23 64 65 66 69 6e 65 20        8.#define 
28e50 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 56 41 52  SQLITE_LIMIT_VAR
28e60 49 41 42 4c 45 5f 4e 55 4d 42 45 52 20 20 20 20  IABLE_NUMBER    
28e70 20 20 20 20 20 20 20 39 0a 23 64 65 66 69 6e 65         9.#define
28e80 20 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 54 52   SQLITE_LIMIT_TR
28e90 49 47 47 45 52 5f 44 45 50 54 48 20 20 20 20 20  IGGER_DEPTH     
28ea0 20 20 20 20 20 20 20 31 30 0a 23 64 65 66 69 6e         10.#defin
28eb0 65 20 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 57  e SQLITE_LIMIT_W
28ec0 4f 52 4b 45 52 5f 54 48 52 45 41 44 53 20 20 20  ORKER_THREADS   
28ed0 20 20 20 20 20 20 20 20 31 31 0a 0a 2f 2a 0a 2a          11../*.*
28ee0 2a 20 43 41 50 49 33 52 45 46 3a 20 43 6f 6d 70  * CAPI3REF: Comp
28ef0 69 6c 69 6e 67 20 41 6e 20 53 51 4c 20 53 74 61  iling An SQL Sta
28f00 74 65 6d 65 6e 74 0a 2a 2a 20 4b 45 59 57 4f 52  tement.** KEYWOR
28f10 44 53 3a 20 7b 53 51 4c 20 73 74 61 74 65 6d 65  DS: {SQL stateme
28f20 6e 74 20 63 6f 6d 70 69 6c 65 72 7d 0a 2a 2a 20  nt compiler}.** 
28f30 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 0a  METHOD: sqlite3.
28f40 2a 2a 20 43 4f 4e 53 54 52 55 43 54 4f 52 3a 20  ** CONSTRUCTOR: 
28f50 73 71 6c 69 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a  sqlite3_stmt.**.
28f60 2a 2a 20 54 6f 20 65 78 65 63 75 74 65 20 61 6e  ** To execute an
28f70 20 53 51 4c 20 71 75 65 72 79 2c 20 69 74 20 6d   SQL query, it m
28f80 75 73 74 20 66 69 72 73 74 20 62 65 20 63 6f 6d  ust first be com
28f90 70 69 6c 65 64 20 69 6e 74 6f 20 61 20 62 79 74  piled into a byt
28fa0 65 2d 63 6f 64 65 0a 2a 2a 20 70 72 6f 67 72 61  e-code.** progra
28fb0 6d 20 75 73 69 6e 67 20 6f 6e 65 20 6f 66 20 74  m using one of t
28fc0 68 65 73 65 20 72 6f 75 74 69 6e 65 73 2e 0a 2a  hese routines..*
28fd0 2a 0a 2a 2a 20 54 68 65 20 66 69 72 73 74 20 61  *.** The first a
28fe0 72 67 75 6d 65 6e 74 2c 20 22 64 62 22 2c 20 69  rgument, "db", i
28ff0 73 20 61 20 5b 64 61 74 61 62 61 73 65 20 63 6f  s a [database co
29000 6e 6e 65 63 74 69 6f 6e 5d 20 6f 62 74 61 69 6e  nnection] obtain
29010 65 64 20 66 72 6f 6d 20 61 0a 2a 2a 20 70 72 69  ed from a.** pri
29020 6f 72 20 73 75 63 63 65 73 73 66 75 6c 20 63 61  or successful ca
29030 6c 6c 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 6f  ll to [sqlite3_o
29040 70 65 6e 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33  pen()], [sqlite3
29050 5f 6f 70 65 6e 5f 76 32 28 29 5d 20 6f 72 0a 2a  _open_v2()] or.*
29060 2a 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 31  * [sqlite3_open1
29070 36 28 29 5d 2e 20 20 54 68 65 20 64 61 74 61 62  6()].  The datab
29080 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 6d  ase connection m
29090 75 73 74 20 6e 6f 74 20 68 61 76 65 20 62 65 65  ust not have bee
290a0 6e 20 63 6c 6f 73 65 64 2e 0a 2a 2a 0a 2a 2a 20  n closed..**.** 
290b0 54 68 65 20 73 65 63 6f 6e 64 20 61 72 67 75 6d  The second argum
290c0 65 6e 74 2c 20 22 7a 53 71 6c 22 2c 20 69 73 20  ent, "zSql", is 
290d0 74 68 65 20 73 74 61 74 65 6d 65 6e 74 20 74 6f  the statement to
290e0 20 62 65 20 63 6f 6d 70 69 6c 65 64 2c 20 65 6e   be compiled, en
290f0 63 6f 64 65 64 0a 2a 2a 20 61 73 20 65 69 74 68  coded.** as eith
29100 65 72 20 55 54 46 2d 38 20 6f 72 20 55 54 46 2d  er UTF-8 or UTF-
29110 31 36 2e 20 20 54 68 65 20 73 71 6c 69 74 65 33  16.  The sqlite3
29120 5f 70 72 65 70 61 72 65 28 29 20 61 6e 64 20 73  _prepare() and s
29130 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 5f 76  qlite3_prepare_v
29140 32 28 29 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65  2().** interface
29150 73 20 75 73 65 20 55 54 46 2d 38 2c 20 61 6e 64  s use UTF-8, and
29160 20 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65   sqlite3_prepare
29170 31 36 28 29 20 61 6e 64 20 73 71 6c 69 74 65 33  16() and sqlite3
29180 5f 70 72 65 70 61 72 65 31 36 5f 76 32 28 29 0a  _prepare16_v2().
29190 2a 2a 20 75 73 65 20 55 54 46 2d 31 36 2e 0a 2a  ** use UTF-16..*
291a0 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20 6e 42 79  *.** ^If the nBy
291b0 74 65 20 61 72 67 75 6d 65 6e 74 20 69 73 20 6e  te argument is n
291c0 65 67 61 74 69 76 65 2c 20 74 68 65 6e 20 7a 53  egative, then zS
291d0 71 6c 20 69 73 20 72 65 61 64 20 75 70 20 74 6f  ql is read up to
291e0 20 74 68 65 0a 2a 2a 20 66 69 72 73 74 20 7a 65   the.** first ze
291f0 72 6f 20 74 65 72 6d 69 6e 61 74 6f 72 2e 20 5e  ro terminator. ^
29200 49 66 20 6e 42 79 74 65 20 69 73 20 70 6f 73 69  If nByte is posi
29210 74 69 76 65 2c 20 74 68 65 6e 20 69 74 20 69 73  tive, then it is
29220 20 74 68 65 0a 2a 2a 20 6e 75 6d 62 65 72 20 6f   the.** number o
29230 66 20 62 79 74 65 73 20 72 65 61 64 20 66 72 6f  f bytes read fro
29240 6d 20 7a 53 71 6c 2e 20 20 5e 49 66 20 6e 42 79  m zSql.  ^If nBy
29250 74 65 20 69 73 20 7a 65 72 6f 2c 20 74 68 65 6e  te is zero, then
29260 20 6e 6f 20 70 72 65 70 61 72 65 64 0a 2a 2a 20   no prepared.** 
29270 73 74 61 74 65 6d 65 6e 74 20 69 73 20 67 65 6e  statement is gen
29280 65 72 61 74 65 64 2e 0a 2a 2a 20 49 66 20 74 68  erated..** If th
29290 65 20 63 61 6c 6c 65 72 20 6b 6e 6f 77 73 20 74  e caller knows t
292a0 68 61 74 20 74 68 65 20 73 75 70 70 6c 69 65 64  hat the supplied
292b0 20 73 74 72 69 6e 67 20 69 73 20 6e 75 6c 2d 74   string is nul-t
292c0 65 72 6d 69 6e 61 74 65 64 2c 20 74 68 65 6e 0a  erminated, then.
292d0 2a 2a 20 74 68 65 72 65 20 69 73 20 61 20 73 6d  ** there is a sm
292e0 61 6c 6c 20 70 65 72 66 6f 72 6d 61 6e 63 65 20  all performance 
292f0 61 64 76 61 6e 74 61 67 65 20 74 6f 20 70 61 73  advantage to pas
29300 73 69 6e 67 20 61 6e 20 6e 42 79 74 65 20 70 61  sing an nByte pa
29310 72 61 6d 65 74 65 72 20 74 68 61 74 0a 2a 2a 20  rameter that.** 
29320 69 73 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66  is the number of
29330 20 62 79 74 65 73 20 69 6e 20 74 68 65 20 69 6e   bytes in the in
29340 70 75 74 20 73 74 72 69 6e 67 20 3c 69 3e 69 6e  put string <i>in
29350 63 6c 75 64 69 6e 67 3c 2f 69 3e 0a 2a 2a 20 74  cluding</i>.** t
29360 68 65 20 6e 75 6c 2d 74 65 72 6d 69 6e 61 74 6f  he nul-terminato
29370 72 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 70 7a 54  r..**.** ^If pzT
29380 61 69 6c 20 69 73 20 6e 6f 74 20 4e 55 4c 4c 20  ail is not NULL 
29390 74 68 65 6e 20 2a 70 7a 54 61 69 6c 20 69 73 20  then *pzTail is 
293a0 6d 61 64 65 20 74 6f 20 70 6f 69 6e 74 20 74 6f  made to point to
293b0 20 74 68 65 20 66 69 72 73 74 20 62 79 74 65 0a   the first byte.
293c0 2a 2a 20 70 61 73 74 20 74 68 65 20 65 6e 64 20  ** past the end 
293d0 6f 66 20 74 68 65 20 66 69 72 73 74 20 53 51 4c  of the first SQL
293e0 20 73 74 61 74 65 6d 65 6e 74 20 69 6e 20 7a 53   statement in zS
293f0 71 6c 2e 20 20 54 68 65 73 65 20 72 6f 75 74 69  ql.  These routi
29400 6e 65 73 20 6f 6e 6c 79 0a 2a 2a 20 63 6f 6d 70  nes only.** comp
29410 69 6c 65 20 74 68 65 20 66 69 72 73 74 20 73 74  ile the first st
29420 61 74 65 6d 65 6e 74 20 69 6e 20 7a 53 71 6c 2c  atement in zSql,
29430 20 73 6f 20 2a 70 7a 54 61 69 6c 20 69 73 20 6c   so *pzTail is l
29440 65 66 74 20 70 6f 69 6e 74 69 6e 67 20 74 6f 0a  eft pointing to.
29450 2a 2a 20 77 68 61 74 20 72 65 6d 61 69 6e 73 20  ** what remains 
29460 75 6e 63 6f 6d 70 69 6c 65 64 2e 0a 2a 2a 0a 2a  uncompiled..**.*
29470 2a 20 5e 2a 70 70 53 74 6d 74 20 69 73 20 6c 65  * ^*ppStmt is le
29480 66 74 20 70 6f 69 6e 74 69 6e 67 20 74 6f 20 61  ft pointing to a
29490 20 63 6f 6d 70 69 6c 65 64 20 5b 70 72 65 70 61   compiled [prepa
294a0 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 74  red statement] t
294b0 68 61 74 20 63 61 6e 20 62 65 0a 2a 2a 20 65 78  hat can be.** ex
294c0 65 63 75 74 65 64 20 75 73 69 6e 67 20 5b 73 71  ecuted using [sq
294d0 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 2e 20 20  lite3_step()].  
294e0 5e 49 66 20 74 68 65 72 65 20 69 73 20 61 6e 20  ^If there is an 
294f0 65 72 72 6f 72 2c 20 2a 70 70 53 74 6d 74 20 69  error, *ppStmt i
29500 73 20 73 65 74 0a 2a 2a 20 74 6f 20 4e 55 4c 4c  s set.** to NULL
29510 2e 20 20 5e 49 66 20 74 68 65 20 69 6e 70 75 74  .  ^If the input
29520 20 74 65 78 74 20 63 6f 6e 74 61 69 6e 73 20 6e   text contains n
29530 6f 20 53 51 4c 20 28 69 66 20 74 68 65 20 69 6e  o SQL (if the in
29540 70 75 74 20 69 73 20 61 6e 20 65 6d 70 74 79 0a  put is an empty.
29550 2a 2a 20 73 74 72 69 6e 67 20 6f 72 20 61 20 63  ** string or a c
29560 6f 6d 6d 65 6e 74 29 20 74 68 65 6e 20 2a 70 70  omment) then *pp
29570 53 74 6d 74 20 69 73 20 73 65 74 20 74 6f 20 4e  Stmt is set to N
29580 55 4c 4c 2e 0a 2a 2a 20 54 68 65 20 63 61 6c 6c  ULL..** The call
29590 69 6e 67 20 70 72 6f 63 65 64 75 72 65 20 69 73  ing procedure is
295a0 20 72 65 73 70 6f 6e 73 69 62 6c 65 20 66 6f 72   responsible for
295b0 20 64 65 6c 65 74 69 6e 67 20 74 68 65 20 63 6f   deleting the co
295c0 6d 70 69 6c 65 64 0a 2a 2a 20 53 51 4c 20 73 74  mpiled.** SQL st
295d0 61 74 65 6d 65 6e 74 20 75 73 69 6e 67 20 5b 73  atement using [s
295e0 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65 28  qlite3_finalize(
295f0 29 5d 20 61 66 74 65 72 20 69 74 20 68 61 73 20  )] after it has 
29600 66 69 6e 69 73 68 65 64 20 77 69 74 68 20 69 74  finished with it
29610 2e 0a 2a 2a 20 70 70 53 74 6d 74 20 6d 61 79 20  ..** ppStmt may 
29620 6e 6f 74 20 62 65 20 4e 55 4c 4c 2e 0a 2a 2a 0a  not be NULL..**.
29630 2a 2a 20 5e 4f 6e 20 73 75 63 63 65 73 73 2c 20  ** ^On success, 
29640 74 68 65 20 73 71 6c 69 74 65 33 5f 70 72 65 70  the sqlite3_prep
29650 61 72 65 28 29 20 66 61 6d 69 6c 79 20 6f 66 20  are() family of 
29660 72 6f 75 74 69 6e 65 73 20 72 65 74 75 72 6e 20  routines return 
29670 5b 53 51 4c 49 54 45 5f 4f 4b 5d 3b 0a 2a 2a 20  [SQLITE_OK];.** 
29680 6f 74 68 65 72 77 69 73 65 20 61 6e 20 5b 65 72  otherwise an [er
29690 72 6f 72 20 63 6f 64 65 5d 20 69 73 20 72 65 74  ror code] is ret
296a0 75 72 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 54 68 65  urned..**.** The
296b0 20 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65   sqlite3_prepare
296c0 5f 76 32 28 29 20 61 6e 64 20 73 71 6c 69 74 65  _v2() and sqlite
296d0 33 5f 70 72 65 70 61 72 65 31 36 5f 76 32 28 29  3_prepare16_v2()
296e0 20 69 6e 74 65 72 66 61 63 65 73 20 61 72 65 0a   interfaces are.
296f0 2a 2a 20 72 65 63 6f 6d 6d 65 6e 64 65 64 20 66  ** recommended f
29700 6f 72 20 61 6c 6c 20 6e 65 77 20 70 72 6f 67 72  or all new progr
29710 61 6d 73 2e 20 54 68 65 20 74 77 6f 20 6f 6c 64  ams. The two old
29720 65 72 20 69 6e 74 65 72 66 61 63 65 73 20 61 72  er interfaces ar
29730 65 20 72 65 74 61 69 6e 65 64 0a 2a 2a 20 66 6f  e retained.** fo
29740 72 20 62 61 63 6b 77 61 72 64 73 20 63 6f 6d 70  r backwards comp
29750 61 74 69 62 69 6c 69 74 79 2c 20 62 75 74 20 74  atibility, but t
29760 68 65 69 72 20 75 73 65 20 69 73 20 64 69 73 63  heir use is disc
29770 6f 75 72 61 67 65 64 2e 0a 2a 2a 20 5e 49 6e 20  ouraged..** ^In 
29780 74 68 65 20 22 76 32 22 20 69 6e 74 65 72 66 61  the "v2" interfa
29790 63 65 73 2c 20 74 68 65 20 70 72 65 70 61 72 65  ces, the prepare
297a0 64 20 73 74 61 74 65 6d 65 6e 74 0a 2a 2a 20 74  d statement.** t
297b0 68 61 74 20 69 73 20 72 65 74 75 72 6e 65 64 20  hat is returned 
297c0 28 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 73 74  (the [sqlite3_st
297d0 6d 74 5d 20 6f 62 6a 65 63 74 29 20 63 6f 6e 74  mt] object) cont
297e0 61 69 6e 73 20 61 20 63 6f 70 79 20 6f 66 20 74  ains a copy of t
297f0 68 65 0a 2a 2a 20 6f 72 69 67 69 6e 61 6c 20 53  he.** original S
29800 51 4c 20 74 65 78 74 2e 20 54 68 69 73 20 63 61  QL text. This ca
29810 75 73 65 73 20 74 68 65 20 5b 73 71 6c 69 74 65  uses the [sqlite
29820 33 5f 73 74 65 70 28 29 5d 20 69 6e 74 65 72 66  3_step()] interf
29830 61 63 65 20 74 6f 0a 2a 2a 20 62 65 68 61 76 65  ace to.** behave
29840 20 64 69 66 66 65 72 65 6e 74 6c 79 20 69 6e 20   differently in 
29850 74 68 72 65 65 20 77 61 79 73 3a 0a 2a 2a 0a 2a  three ways:.**.*
29860 2a 20 3c 6f 6c 3e 0a 2a 2a 20 3c 6c 69 3e 0a 2a  * <ol>.** <li>.*
29870 2a 20 5e 49 66 20 74 68 65 20 64 61 74 61 62 61  * ^If the databa
29880 73 65 20 73 63 68 65 6d 61 20 63 68 61 6e 67 65  se schema change
29890 73 2c 20 69 6e 73 74 65 61 64 20 6f 66 20 72 65  s, instead of re
298a0 74 75 72 6e 69 6e 67 20 5b 53 51 4c 49 54 45 5f  turning [SQLITE_
298b0 53 43 48 45 4d 41 5d 20 61 73 20 69 74 0a 2a 2a  SCHEMA] as it.**
298c0 20 61 6c 77 61 79 73 20 75 73 65 64 20 74 6f 20   always used to 
298d0 64 6f 2c 20 5b 73 71 6c 69 74 65 33 5f 73 74 65  do, [sqlite3_ste
298e0 70 28 29 5d 20 77 69 6c 6c 20 61 75 74 6f 6d 61  p()] will automa
298f0 74 69 63 61 6c 6c 79 20 72 65 63 6f 6d 70 69 6c  tically recompil
29900 65 20 74 68 65 20 53 51 4c 0a 2a 2a 20 73 74 61  e the SQL.** sta
29910 74 65 6d 65 6e 74 20 61 6e 64 20 74 72 79 20 74  tement and try t
29920 6f 20 72 75 6e 20 69 74 20 61 67 61 69 6e 2e 20  o run it again. 
29930 41 73 20 6d 61 6e 79 20 61 73 20 5b 53 51 4c 49  As many as [SQLI
29940 54 45 5f 4d 41 58 5f 53 43 48 45 4d 41 5f 52 45  TE_MAX_SCHEMA_RE
29950 54 52 59 5d 0a 2a 2a 20 72 65 74 72 69 65 73 20  TRY].** retries 
29960 77 69 6c 6c 20 6f 63 63 75 72 20 62 65 66 6f 72  will occur befor
29970 65 20 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29  e sqlite3_step()
29980 20 67 69 76 65 73 20 75 70 20 61 6e 64 20 72 65   gives up and re
29990 74 75 72 6e 73 20 61 6e 20 65 72 72 6f 72 2e 0a  turns an error..
299a0 2a 2a 20 3c 2f 6c 69 3e 0a 2a 2a 0a 2a 2a 20 3c  ** </li>.**.** <
299b0 6c 69 3e 0a 2a 2a 20 5e 57 68 65 6e 20 61 6e 20  li>.** ^When an 
299c0 65 72 72 6f 72 20 6f 63 63 75 72 73 2c 20 5b 73  error occurs, [s
299d0 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20 77  qlite3_step()] w
299e0 69 6c 6c 20 72 65 74 75 72 6e 20 6f 6e 65 20 6f  ill return one o
299f0 66 20 74 68 65 20 64 65 74 61 69 6c 65 64 0a 2a  f the detailed.*
29a00 2a 20 5b 65 72 72 6f 72 20 63 6f 64 65 73 5d 20  * [error codes] 
29a10 6f 72 20 5b 65 78 74 65 6e 64 65 64 20 65 72 72  or [extended err
29a20 6f 72 20 63 6f 64 65 73 5d 2e 20 20 5e 54 68 65  or codes].  ^The
29a30 20 6c 65 67 61 63 79 20 62 65 68 61 76 69 6f 72   legacy behavior
29a40 20 77 61 73 20 74 68 61 74 0a 2a 2a 20 5b 73 71   was that.** [sq
29a50 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20 77 6f  lite3_step()] wo
29a60 75 6c 64 20 6f 6e 6c 79 20 72 65 74 75 72 6e 20  uld only return 
29a70 61 20 67 65 6e 65 72 69 63 20 5b 53 51 4c 49 54  a generic [SQLIT
29a80 45 5f 45 52 52 4f 52 5d 20 72 65 73 75 6c 74 20  E_ERROR] result 
29a90 63 6f 64 65 0a 2a 2a 20 61 6e 64 20 74 68 65 20  code.** and the 
29aa0 61 70 70 6c 69 63 61 74 69 6f 6e 20 77 6f 75 6c  application woul
29ab0 64 20 68 61 76 65 20 74 6f 20 6d 61 6b 65 20 61  d have to make a
29ac0 20 73 65 63 6f 6e 64 20 63 61 6c 6c 20 74 6f 20   second call to 
29ad0 5b 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29  [sqlite3_reset()
29ae0 5d 0a 2a 2a 20 69 6e 20 6f 72 64 65 72 20 74 6f  ].** in order to
29af0 20 66 69 6e 64 20 74 68 65 20 75 6e 64 65 72 6c   find the underl
29b00 79 69 6e 67 20 63 61 75 73 65 20 6f 66 20 74 68  ying cause of th
29b10 65 20 70 72 6f 62 6c 65 6d 2e 20 57 69 74 68 20  e problem. With 
29b20 74 68 65 20 22 76 32 22 20 70 72 65 70 61 72 65  the "v2" prepare
29b30 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 73 2c 20  .** interfaces, 
29b40 74 68 65 20 75 6e 64 65 72 6c 79 69 6e 67 20 72  the underlying r
29b50 65 61 73 6f 6e 20 66 6f 72 20 74 68 65 20 65 72  eason for the er
29b60 72 6f 72 20 69 73 20 72 65 74 75 72 6e 65 64 20  ror is returned 
29b70 69 6d 6d 65 64 69 61 74 65 6c 79 2e 0a 2a 2a 20  immediately..** 
29b80 3c 2f 6c 69 3e 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e  </li>.**.** <li>
29b90 0a 2a 2a 20 5e 49 66 20 74 68 65 20 73 70 65 63  .** ^If the spec
29ba0 69 66 69 63 20 76 61 6c 75 65 20 62 6f 75 6e 64  ific value bound
29bb0 20 74 6f 20 5b 70 61 72 61 6d 65 74 65 72 20 7c   to [parameter |
29bc0 20 68 6f 73 74 20 70 61 72 61 6d 65 74 65 72 5d   host parameter]
29bd0 20 69 6e 20 74 68 65 20 0a 2a 2a 20 57 48 45 52   in the .** WHER
29be0 45 20 63 6c 61 75 73 65 20 6d 69 67 68 74 20 69  E clause might i
29bf0 6e 66 6c 75 65 6e 63 65 20 74 68 65 20 63 68 6f  nfluence the cho
29c00 69 63 65 20 6f 66 20 71 75 65 72 79 20 70 6c 61  ice of query pla
29c10 6e 20 66 6f 72 20 61 20 73 74 61 74 65 6d 65 6e  n for a statemen
29c20 74 2c 0a 2a 2a 20 74 68 65 6e 20 74 68 65 20 73  t,.** then the s
29c30 74 61 74 65 6d 65 6e 74 20 77 69 6c 6c 20 62 65  tatement will be
29c40 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 72   automatically r
29c50 65 63 6f 6d 70 69 6c 65 64 2c 20 61 73 20 69 66  ecompiled, as if
29c60 20 74 68 65 72 65 20 68 61 64 20 62 65 65 6e 20   there had been 
29c70 0a 2a 2a 20 61 20 73 63 68 65 6d 61 20 63 68 61  .** a schema cha
29c80 6e 67 65 2c 20 6f 6e 20 74 68 65 20 66 69 72 73  nge, on the firs
29c90 74 20 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70  t  [sqlite3_step
29ca0 28 29 5d 20 63 61 6c 6c 20 66 6f 6c 6c 6f 77 69  ()] call followi
29cb0 6e 67 20 61 6e 79 20 63 68 61 6e 67 65 0a 2a 2a  ng any change.**
29cc0 20 74 6f 20 74 68 65 20 5b 73 71 6c 69 74 65 33   to the [sqlite3
29cd0 5f 62 69 6e 64 5f 74 65 78 74 20 7c 20 62 69 6e  _bind_text | bin
29ce0 64 69 6e 67 73 5d 20 6f 66 20 74 68 61 74 20 5b  dings] of that [
29cf0 70 61 72 61 6d 65 74 65 72 5d 2e 20 0a 2a 2a 20  parameter]. .** 
29d00 5e 54 68 65 20 73 70 65 63 69 66 69 63 20 76 61  ^The specific va
29d10 6c 75 65 20 6f 66 20 57 48 45 52 45 2d 63 6c 61  lue of WHERE-cla
29d20 75 73 65 20 5b 70 61 72 61 6d 65 74 65 72 5d 20  use [parameter] 
29d30 6d 69 67 68 74 20 69 6e 66 6c 75 65 6e 63 65 20  might influence 
29d40 74 68 65 20 0a 2a 2a 20 63 68 6f 69 63 65 20 6f  the .** choice o
29d50 66 20 71 75 65 72 79 20 70 6c 61 6e 20 69 66 20  f query plan if 
29d60 74 68 65 20 70 61 72 61 6d 65 74 65 72 20 69 73  the parameter is
29d70 20 74 68 65 20 6c 65 66 74 2d 68 61 6e 64 20 73   the left-hand s
29d80 69 64 65 20 6f 66 20 61 20 5b 4c 49 4b 45 5d 0a  ide of a [LIKE].
29d90 2a 2a 20 6f 72 20 5b 47 4c 4f 42 5d 20 6f 70 65  ** or [GLOB] ope
29da0 72 61 74 6f 72 20 6f 72 20 69 66 20 74 68 65 20  rator or if the 
29db0 70 61 72 61 6d 65 74 65 72 20 69 73 20 63 6f 6d  parameter is com
29dc0 70 61 72 65 64 20 74 6f 20 61 6e 20 69 6e 64 65  pared to an inde
29dd0 78 65 64 20 63 6f 6c 75 6d 6e 0a 2a 2a 20 61 6e  xed column.** an
29de0 64 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 45 4e  d the [SQLITE_EN
29df0 41 42 4c 45 5f 53 54 41 54 33 5d 20 63 6f 6d 70  ABLE_STAT3] comp
29e00 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 20  ile-time option 
29e10 69 73 20 65 6e 61 62 6c 65 64 2e 0a 2a 2a 20 3c  is enabled..** <
29e20 2f 6c 69 3e 0a 2a 2a 20 3c 2f 6f 6c 3e 0a 2a 2f  /li>.** </ol>.*/
29e30 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 70 72 65  .int sqlite3_pre
29e40 70 61 72 65 28 0a 20 20 73 71 6c 69 74 65 33 20  pare(.  sqlite3 
29e50 2a 64 62 2c 20 20 20 20 20 20 20 20 20 20 20 20  *db,            
29e60 2f 2a 20 44 61 74 61 62 61 73 65 20 68 61 6e 64  /* Database hand
29e70 6c 65 20 2a 2f 0a 20 20 63 6f 6e 73 74 20 63 68  le */.  const ch
29e80 61 72 20 2a 7a 53 71 6c 2c 20 20 20 20 20 20 20  ar *zSql,       
29e90 2f 2a 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  /* SQL statement
29ea0 2c 20 55 54 46 2d 38 20 65 6e 63 6f 64 65 64 20  , UTF-8 encoded 
29eb0 2a 2f 0a 20 20 69 6e 74 20 6e 42 79 74 65 2c 20  */.  int nByte, 
29ec0 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20               /* 
29ed0 4d 61 78 69 6d 75 6d 20 6c 65 6e 67 74 68 20 6f  Maximum length o
29ee0 66 20 7a 53 71 6c 20 69 6e 20 62 79 74 65 73 2e  f zSql in bytes.
29ef0 20 2a 2f 0a 20 20 73 71 6c 69 74 65 33 5f 73 74   */.  sqlite3_st
29f00 6d 74 20 2a 2a 70 70 53 74 6d 74 2c 20 20 2f 2a  mt **ppStmt,  /*
29f10 20 4f 55 54 3a 20 53 74 61 74 65 6d 65 6e 74 20   OUT: Statement 
29f20 68 61 6e 64 6c 65 20 2a 2f 0a 20 20 63 6f 6e 73  handle */.  cons
29f30 74 20 63 68 61 72 20 2a 2a 70 7a 54 61 69 6c 20  t char **pzTail 
29f40 20 20 20 20 2f 2a 20 4f 55 54 3a 20 50 6f 69 6e      /* OUT: Poin
29f50 74 65 72 20 74 6f 20 75 6e 75 73 65 64 20 70 6f  ter to unused po
29f60 72 74 69 6f 6e 20 6f 66 20 7a 53 71 6c 20 2a 2f  rtion of zSql */
29f70 0a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  .);.int sqlite3_
29f80 70 72 65 70 61 72 65 5f 76 32 28 0a 20 20 73 71  prepare_v2(.  sq
29f90 6c 69 74 65 33 20 2a 64 62 2c 20 20 20 20 20 20  lite3 *db,      
29fa0 20 20 20 20 20 20 2f 2a 20 44 61 74 61 62 61 73        /* Databas
29fb0 65 20 68 61 6e 64 6c 65 20 2a 2f 0a 20 20 63 6f  e handle */.  co
29fc0 6e 73 74 20 63 68 61 72 20 2a 7a 53 71 6c 2c 20  nst char *zSql, 
29fd0 20 20 20 20 20 20 2f 2a 20 53 51 4c 20 73 74 61        /* SQL sta
29fe0 74 65 6d 65 6e 74 2c 20 55 54 46 2d 38 20 65 6e  tement, UTF-8 en
29ff0 63 6f 64 65 64 20 2a 2f 0a 20 20 69 6e 74 20 6e  coded */.  int n
2a000 42 79 74 65 2c 20 20 20 20 20 20 20 20 20 20 20  Byte,           
2a010 20 20 20 2f 2a 20 4d 61 78 69 6d 75 6d 20 6c 65     /* Maximum le
2a020 6e 67 74 68 20 6f 66 20 7a 53 71 6c 20 69 6e 20  ngth of zSql in 
2a030 62 79 74 65 73 2e 20 2a 2f 0a 20 20 73 71 6c 69  bytes. */.  sqli
2a040 74 65 33 5f 73 74 6d 74 20 2a 2a 70 70 53 74 6d  te3_stmt **ppStm
2a050 74 2c 20 20 2f 2a 20 4f 55 54 3a 20 53 74 61 74  t,  /* OUT: Stat
2a060 65 6d 65 6e 74 20 68 61 6e 64 6c 65 20 2a 2f 0a  ement handle */.
2a070 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 2a 70    const char **p
2a080 7a 54 61 69 6c 20 20 20 20 20 2f 2a 20 4f 55 54  zTail     /* OUT
2a090 3a 20 50 6f 69 6e 74 65 72 20 74 6f 20 75 6e 75  : Pointer to unu
2a0a0 73 65 64 20 70 6f 72 74 69 6f 6e 20 6f 66 20 7a  sed portion of z
2a0b0 53 71 6c 20 2a 2f 0a 29 3b 0a 69 6e 74 20 73 71  Sql */.);.int sq
2a0c0 6c 69 74 65 33 5f 70 72 65 70 61 72 65 31 36 28  lite3_prepare16(
2a0d0 0a 20 20 73 71 6c 69 74 65 33 20 2a 64 62 2c 20  .  sqlite3 *db, 
2a0e0 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 44 61             /* Da
2a0f0 74 61 62 61 73 65 20 68 61 6e 64 6c 65 20 2a 2f  tabase handle */
2a100 0a 20 20 63 6f 6e 73 74 20 76 6f 69 64 20 2a 7a  .  const void *z
2a110 53 71 6c 2c 20 20 20 20 20 20 20 2f 2a 20 53 51  Sql,       /* SQ
2a120 4c 20 73 74 61 74 65 6d 65 6e 74 2c 20 55 54 46  L statement, UTF
2a130 2d 31 36 20 65 6e 63 6f 64 65 64 20 2a 2f 0a 20  -16 encoded */. 
2a140 20 69 6e 74 20 6e 42 79 74 65 2c 20 20 20 20 20   int nByte,     
2a150 20 20 20 20 20 20 20 20 20 2f 2a 20 4d 61 78 69           /* Maxi
2a160 6d 75 6d 20 6c 65 6e 67 74 68 20 6f 66 20 7a 53  mum length of zS
2a170 71 6c 20 69 6e 20 62 79 74 65 73 2e 20 2a 2f 0a  ql in bytes. */.
2a180 20 20 73 71 6c 69 74 65 33 5f 73 74 6d 74 20 2a    sqlite3_stmt *
2a190 2a 70 70 53 74 6d 74 2c 20 20 2f 2a 20 4f 55 54  *ppStmt,  /* OUT
2a1a0 3a 20 53 74 61 74 65 6d 65 6e 74 20 68 61 6e 64  : Statement hand
2a1b0 6c 65 20 2a 2f 0a 20 20 63 6f 6e 73 74 20 76 6f  le */.  const vo
2a1c0 69 64 20 2a 2a 70 7a 54 61 69 6c 20 20 20 20 20  id **pzTail     
2a1d0 2f 2a 20 4f 55 54 3a 20 50 6f 69 6e 74 65 72 20  /* OUT: Pointer 
2a1e0 74 6f 20 75 6e 75 73 65 64 20 70 6f 72 74 69 6f  to unused portio
2a1f0 6e 20 6f 66 20 7a 53 71 6c 20 2a 2f 0a 29 3b 0a  n of zSql */.);.
2a200 69 6e 74 20 73 71 6c 69 74 65 33 5f 70 72 65 70  int sqlite3_prep
2a210 61 72 65 31 36 5f 76 32 28 0a 20 20 73 71 6c 69  are16_v2(.  sqli
2a220 74 65 33 20 2a 64 62 2c 20 20 20 20 20 20 20 20  te3 *db,        
2a230 20 20 20 20 2f 2a 20 44 61 74 61 62 61 73 65 20      /* Database 
2a240 68 61 6e 64 6c 65 20 2a 2f 0a 20 20 63 6f 6e 73  handle */.  cons
2a250 74 20 76 6f 69 64 20 2a 7a 53 71 6c 2c 20 20 20  t void *zSql,   
2a260 20 20 20 20 2f 2a 20 53 51 4c 20 73 74 61 74 65      /* SQL state
2a270 6d 65 6e 74 2c 20 55 54 46 2d 31 36 20 65 6e 63  ment, UTF-16 enc
2a280 6f 64 65 64 20 2a 2f 0a 20 20 69 6e 74 20 6e 42  oded */.  int nB
2a290 79 74 65 2c 20 20 20 20 20 20 20 20 20 20 20 20  yte,            
2a2a0 20 20 2f 2a 20 4d 61 78 69 6d 75 6d 20 6c 65 6e    /* Maximum len
2a2b0 67 74 68 20 6f 66 20 7a 53 71 6c 20 69 6e 20 62  gth of zSql in b
2a2c0 79 74 65 73 2e 20 2a 2f 0a 20 20 73 71 6c 69 74  ytes. */.  sqlit
2a2d0 65 33 5f 73 74 6d 74 20 2a 2a 70 70 53 74 6d 74  e3_stmt **ppStmt
2a2e0 2c 20 20 2f 2a 20 4f 55 54 3a 20 53 74 61 74 65  ,  /* OUT: State
2a2f0 6d 65 6e 74 20 68 61 6e 64 6c 65 20 2a 2f 0a 20  ment handle */. 
2a300 20 63 6f 6e 73 74 20 76 6f 69 64 20 2a 2a 70 7a   const void **pz
2a310 54 61 69 6c 20 20 20 20 20 2f 2a 20 4f 55 54 3a  Tail     /* OUT:
2a320 20 50 6f 69 6e 74 65 72 20 74 6f 20 75 6e 75 73   Pointer to unus
2a330 65 64 20 70 6f 72 74 69 6f 6e 20 6f 66 20 7a 53  ed portion of zS
2a340 71 6c 20 2a 2f 0a 29 3b 0a 0a 2f 2a 0a 2a 2a 20  ql */.);../*.** 
2a350 43 41 50 49 33 52 45 46 3a 20 52 65 74 72 69 65  CAPI3REF: Retrie
2a360 76 69 6e 67 20 53 74 61 74 65 6d 65 6e 74 20 53  ving Statement S
2a370 51 4c 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71  QL.** METHOD: sq
2a380 6c 69 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a  lite3_stmt.**.**
2a390 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 73 71   ^The sqlite3_sq
2a3a0 6c 28 50 29 20 69 6e 74 65 72 66 61 63 65 20 72  l(P) interface r
2a3b0 65 74 75 72 6e 73 20 61 20 70 6f 69 6e 74 65 72  eturns a pointer
2a3c0 20 74 6f 20 61 20 63 6f 70 79 20 6f 66 20 74 68   to a copy of th
2a3d0 65 20 55 54 46 2d 38 0a 2a 2a 20 53 51 4c 20 74  e UTF-8.** SQL t
2a3e0 65 78 74 20 75 73 65 64 20 74 6f 20 63 72 65 61  ext used to crea
2a3f0 74 65 20 5b 70 72 65 70 61 72 65 64 20 73 74 61  te [prepared sta
2a400 74 65 6d 65 6e 74 5d 20 50 20 69 66 20 50 20 77  tement] P if P w
2a410 61 73 0a 2a 2a 20 63 72 65 61 74 65 64 20 62 79  as.** created by
2a420 20 65 69 74 68 65 72 20 5b 73 71 6c 69 74 65 33   either [sqlite3
2a430 5f 70 72 65 70 61 72 65 5f 76 32 28 29 5d 20 6f  _prepare_v2()] o
2a440 72 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61  r [sqlite3_prepa
2a450 72 65 31 36 5f 76 32 28 29 5d 2e 0a 2a 2a 20 5e  re16_v2()]..** ^
2a460 54 68 65 20 73 71 6c 69 74 65 33 5f 65 78 70 61  The sqlite3_expa
2a470 6e 64 65 64 5f 73 71 6c 28 50 29 20 69 6e 74 65  nded_sql(P) inte
2a480 72 66 61 63 65 20 72 65 74 75 72 6e 73 20 61 20  rface returns a 
2a490 70 6f 69 6e 74 65 72 20 74 6f 20 61 20 55 54 46  pointer to a UTF
2a4a0 2d 38 0a 2a 2a 20 73 74 72 69 6e 67 20 63 6f 6e  -8.** string con
2a4b0 74 61 69 6e 69 6e 67 20 74 68 65 20 53 51 4c 20  taining the SQL 
2a4c0 74 65 78 74 20 6f 66 20 70 72 65 70 61 72 65 64  text of prepared
2a4d0 20 73 74 61 74 65 6d 65 6e 74 20 50 20 77 69 74   statement P wit
2a4e0 68 0a 2a 2a 20 5b 62 6f 75 6e 64 20 70 61 72 61  h.** [bound para
2a4f0 6d 65 74 65 72 73 5d 20 65 78 70 61 6e 64 65 64  meters] expanded
2a500 2e 0a 2a 2a 0a 2a 2a 20 5e 28 46 6f 72 20 65 78  ..**.** ^(For ex
2a510 61 6d 70 6c 65 2c 20 69 66 20 61 20 70 72 65 70  ample, if a prep
2a520 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 20 69  ared statement i
2a530 73 20 63 72 65 61 74 65 64 20 75 73 69 6e 67 20  s created using 
2a540 74 68 65 20 53 51 4c 0a 2a 2a 20 74 65 78 74 20  the SQL.** text 
2a550 22 53 45 4c 45 43 54 20 24 61 62 63 2c 3a 78 79  "SELECT $abc,:xy
2a560 7a 22 20 61 6e 64 20 69 66 20 70 61 72 61 6d 65  z" and if parame
2a570 74 65 72 20 24 61 62 63 20 69 73 20 62 6f 75 6e  ter $abc is boun
2a580 64 20 74 6f 20 69 6e 74 65 67 65 72 20 32 33 34  d to integer 234
2a590 35 0a 2a 2a 20 61 6e 64 20 70 61 72 61 6d 65 74  5.** and paramet
2a5a0 65 72 20 3a 78 79 7a 20 69 73 20 75 6e 62 6f 75  er :xyz is unbou
2a5b0 6e 64 2c 20 74 68 65 6e 20 73 71 6c 69 74 65 33  nd, then sqlite3
2a5c0 5f 73 71 6c 28 29 20 77 69 6c 6c 20 72 65 74 75  _sql() will retu
2a5d0 72 6e 0a 2a 2a 20 74 68 65 20 6f 72 69 67 69 6e  rn.** the origin
2a5e0 61 6c 20 73 74 72 69 6e 67 2c 20 22 53 45 4c 45  al string, "SELE
2a5f0 43 54 20 24 61 62 63 2c 3a 78 79 7a 22 20 62 75  CT $abc,:xyz" bu
2a600 74 20 73 71 6c 69 74 65 33 5f 65 78 70 61 6e 64  t sqlite3_expand
2a610 65 64 5f 73 71 6c 28 29 0a 2a 2a 20 77 69 6c 6c  ed_sql().** will
2a620 20 72 65 74 75 72 6e 20 22 53 45 4c 45 43 54 20   return "SELECT 
2a630 32 33 34 35 2c 4e 55 4c 4c 22 2e 29 5e 0a 2a 2a  2345,NULL".)^.**
2a640 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33  .** ^The sqlite3
2a650 5f 65 78 70 61 6e 64 65 64 5f 73 71 6c 28 29 20  _expanded_sql() 
2a660 69 6e 74 65 72 66 61 63 65 20 72 65 74 75 72 6e  interface return
2a670 73 20 4e 55 4c 4c 20 69 66 20 69 6e 73 75 66 66  s NULL if insuff
2a680 69 63 69 65 6e 74 20 6d 65 6d 6f 72 79 0a 2a 2a  icient memory.**
2a690 20 69 73 20 61 76 61 69 6c 61 62 6c 65 20 74 6f   is available to
2a6a0 20 68 6f 6c 64 20 74 68 65 20 72 65 73 75 6c 74   hold the result
2a6b0 2c 20 6f 72 20 69 66 20 74 68 65 20 72 65 73 75  , or if the resu
2a6c0 6c 74 20 77 6f 75 6c 64 20 65 78 63 65 65 64 20  lt would exceed 
2a6d0 74 68 65 0a 2a 2a 20 74 68 65 20 6d 61 78 69 6d  the.** the maxim
2a6e0 75 6d 20 73 74 72 69 6e 67 20 6c 65 6e 67 74 68  um string length
2a6f0 20 64 65 74 65 72 6d 69 6e 65 64 20 62 79 20 74   determined by t
2a700 68 65 20 5b 53 51 4c 49 54 45 5f 4c 49 4d 49 54  he [SQLITE_LIMIT
2a710 5f 4c 45 4e 47 54 48 5d 2e 0a 2a 2a 0a 2a 2a 20  _LENGTH]..**.** 
2a720 5e 54 68 65 20 5b 53 51 4c 49 54 45 5f 54 52 41  ^The [SQLITE_TRA
2a730 43 45 5f 53 49 5a 45 5f 4c 49 4d 49 54 5d 20 63  CE_SIZE_LIMIT] c
2a740 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69  ompile-time opti
2a750 6f 6e 20 6c 69 6d 69 74 73 20 74 68 65 20 73 69  on limits the si
2a760 7a 65 20 6f 66 0a 2a 2a 20 62 6f 75 6e 64 20 70  ze of.** bound p
2a770 61 72 61 6d 65 74 65 72 20 65 78 70 61 6e 73 69  arameter expansi
2a780 6f 6e 73 2e 20 20 5e 54 68 65 20 5b 53 51 4c 49  ons.  ^The [SQLI
2a790 54 45 5f 4f 4d 49 54 5f 54 52 41 43 45 5d 20 63  TE_OMIT_TRACE] c
2a7a0 6f 6d 70 69 6c 65 2d 74 69 6d 65 0a 2a 2a 20 6f  ompile-time.** o
2a7b0 70 74 69 6f 6e 20 63 61 75 73 65 73 20 73 71 6c  ption causes sql
2a7c0 69 74 65 33 5f 65 78 70 61 6e 64 65 64 5f 73 71  ite3_expanded_sq
2a7d0 6c 28 29 20 74 6f 20 61 6c 77 61 79 73 20 72 65  l() to always re
2a7e0 74 75 72 6e 20 4e 55 4c 4c 2e 0a 2a 2a 0a 2a 2a  turn NULL..**.**
2a7f0 20 5e 54 68 65 20 73 74 72 69 6e 67 20 72 65 74   ^The string ret
2a800 75 72 6e 65 64 20 62 79 20 73 71 6c 69 74 65 33  urned by sqlite3
2a810 5f 73 71 6c 28 50 29 20 69 73 20 6d 61 6e 61 67  _sql(P) is manag
2a820 65 64 20 62 79 20 53 51 4c 69 74 65 20 61 6e 64  ed by SQLite and
2a830 20 69 73 0a 2a 2a 20 61 75 74 6f 6d 61 74 69 63   is.** automatic
2a840 61 6c 6c 79 20 66 72 65 65 64 20 77 68 65 6e 20  ally freed when 
2a850 74 68 65 20 70 72 65 70 61 72 65 64 20 73 74 61  the prepared sta
2a860 74 65 6d 65 6e 74 20 69 73 20 66 69 6e 61 6c 69  tement is finali
2a870 7a 65 64 2e 0a 2a 2a 20 5e 54 68 65 20 73 74 72  zed..** ^The str
2a880 69 6e 67 20 72 65 74 75 72 6e 65 64 20 62 79 20  ing returned by 
2a890 73 71 6c 69 74 65 33 5f 65 78 70 61 6e 64 65 64  sqlite3_expanded
2a8a0 5f 73 71 6c 28 50 29 2c 20 6f 6e 20 74 68 65 20  _sql(P), on the 
2a8b0 6f 74 68 65 72 20 68 61 6e 64 2c 0a 2a 2a 20 69  other hand,.** i
2a8c0 73 20 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d 20  s obtained from 
2a8d0 5b 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28  [sqlite3_malloc(
2a8e0 29 5d 20 61 6e 64 20 6d 75 73 74 20 62 65 20 66  )] and must be f
2a8f0 72 65 65 20 62 79 20 74 68 65 20 61 70 70 6c 69  ree by the appli
2a900 63 61 74 69 6f 6e 0a 2a 2a 20 62 79 20 70 61 73  cation.** by pas
2a910 73 69 6e 67 20 69 74 20 74 6f 20 5b 73 71 6c 69  sing it to [sqli
2a920 74 65 33 5f 66 72 65 65 28 29 5d 2e 0a 2a 2f 0a  te3_free()]..*/.
2a930 63 6f 6e 73 74 20 63 68 61 72 20 2a 73 71 6c 69  const char *sqli
2a940 74 65 33 5f 73 71 6c 28 73 71 6c 69 74 65 33 5f  te3_sql(sqlite3_
2a950 73 74 6d 74 20 2a 70 53 74 6d 74 29 3b 0a 63 68  stmt *pStmt);.ch
2a960 61 72 20 2a 73 71 6c 69 74 65 33 5f 65 78 70 61  ar *sqlite3_expa
2a970 6e 64 65 64 5f 73 71 6c 28 73 71 6c 69 74 65 33  nded_sql(sqlite3
2a980 5f 73 74 6d 74 20 2a 70 53 74 6d 74 29 3b 0a 0a  _stmt *pStmt);..
2a990 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20  /*.** CAPI3REF: 
2a9a0 44 65 74 65 72 6d 69 6e 65 20 49 66 20 41 6e 20  Determine If An 
2a9b0 53 51 4c 20 53 74 61 74 65 6d 65 6e 74 20 57 72  SQL Statement Wr
2a9c0 69 74 65 73 20 54 68 65 20 44 61 74 61 62 61 73  ites The Databas
2a9d0 65 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c  e.** METHOD: sql
2a9e0 69 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20  ite3_stmt.**.** 
2a9f0 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 73 74 6d  ^The sqlite3_stm
2aa00 74 5f 72 65 61 64 6f 6e 6c 79 28 58 29 20 69 6e  t_readonly(X) in
2aa10 74 65 72 66 61 63 65 20 72 65 74 75 72 6e 73 20  terface returns 
2aa20 74 72 75 65 20 28 6e 6f 6e 2d 7a 65 72 6f 29 20  true (non-zero) 
2aa30 69 66 0a 2a 2a 20 61 6e 64 20 6f 6e 6c 79 20 69  if.** and only i
2aa40 66 20 74 68 65 20 5b 70 72 65 70 61 72 65 64 20  f the [prepared 
2aa50 73 74 61 74 65 6d 65 6e 74 5d 20 58 20 6d 61 6b  statement] X mak
2aa60 65 73 20 6e 6f 20 64 69 72 65 63 74 20 63 68 61  es no direct cha
2aa70 6e 67 65 73 20 74 6f 0a 2a 2a 20 74 68 65 20 63  nges to.** the c
2aa80 6f 6e 74 65 6e 74 20 6f 66 20 74 68 65 20 64 61  ontent of the da
2aa90 74 61 62 61 73 65 20 66 69 6c 65 2e 0a 2a 2a 0a  tabase file..**.
2aaa0 2a 2a 20 4e 6f 74 65 20 74 68 61 74 20 5b 61 70  ** Note that [ap
2aab0 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65  plication-define
2aac0 64 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 73 5d  d SQL functions]
2aad0 20 6f 72 0a 2a 2a 20 5b 76 69 72 74 75 61 6c 20   or.** [virtual 
2aae0 74 61 62 6c 65 73 5d 20 6d 69 67 68 74 20 63 68  tables] might ch
2aaf0 61 6e 67 65 20 74 68 65 20 64 61 74 61 62 61 73  ange the databas
2ab00 65 20 69 6e 64 69 72 65 63 74 6c 79 20 61 73 20  e indirectly as 
2ab10 61 20 73 69 64 65 20 65 66 66 65 63 74 2e 20 20  a side effect.  
2ab20 0a 2a 2a 20 5e 28 46 6f 72 20 65 78 61 6d 70 6c  .** ^(For exampl
2ab30 65 2c 20 69 66 20 61 6e 20 61 70 70 6c 69 63 61  e, if an applica
2ab40 74 69 6f 6e 20 64 65 66 69 6e 65 73 20 61 20 66  tion defines a f
2ab50 75 6e 63 74 69 6f 6e 20 22 65 76 61 6c 28 29 22  unction "eval()"
2ab60 20 74 68 61 74 20 0a 2a 2a 20 63 61 6c 6c 73 20   that .** calls 
2ab70 5b 73 71 6c 69 74 65 33 5f 65 78 65 63 28 29 5d  [sqlite3_exec()]
2ab80 2c 20 74 68 65 6e 20 74 68 65 20 66 6f 6c 6c 6f  , then the follo
2ab90 77 69 6e 67 20 53 51 4c 20 73 74 61 74 65 6d 65  wing SQL stateme
2aba0 6e 74 20 77 6f 75 6c 64 0a 2a 2a 20 63 68 61 6e  nt would.** chan
2abb0 67 65 20 74 68 65 20 64 61 74 61 62 61 73 65 20  ge the database 
2abc0 66 69 6c 65 20 74 68 72 6f 75 67 68 20 73 69 64  file through sid
2abd0 65 2d 65 66 66 65 63 74 73 3a 0a 2a 2a 0a 2a 2a  e-effects:.**.**
2abe0 20 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72   <blockquote><pr
2abf0 65 3e 0a 2a 2a 20 20 20 20 53 45 4c 45 43 54 20  e>.**    SELECT 
2ac00 65 76 61 6c 28 27 44 45 4c 45 54 45 20 46 52 4f  eval('DELETE FRO
2ac10 4d 20 74 31 27 29 20 46 52 4f 4d 20 74 32 3b 0a  M t1') FROM t2;.
2ac20 2a 2a 20 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b  ** </pre></block
2ac30 71 75 6f 74 65 3e 0a 2a 2a 0a 2a 2a 20 42 75 74  quote>.**.** But
2ac40 20 62 65 63 61 75 73 65 20 74 68 65 20 5b 53 45   because the [SE
2ac50 4c 45 43 54 5d 20 73 74 61 74 65 6d 65 6e 74 20  LECT] statement 
2ac60 64 6f 65 73 20 6e 6f 74 20 63 68 61 6e 67 65 20  does not change 
2ac70 74 68 65 20 64 61 74 61 62 61 73 65 20 66 69 6c  the database fil
2ac80 65 0a 2a 2a 20 64 69 72 65 63 74 6c 79 2c 20 73  e.** directly, s
2ac90 71 6c 69 74 65 33 5f 73 74 6d 74 5f 72 65 61 64  qlite3_stmt_read
2aca0 6f 6e 6c 79 28 29 20 77 6f 75 6c 64 20 73 74 69  only() would sti
2acb0 6c 6c 20 72 65 74 75 72 6e 20 74 72 75 65 2e 29  ll return true.)
2acc0 5e 0a 2a 2a 0a 2a 2a 20 5e 54 72 61 6e 73 61 63  ^.**.** ^Transac
2acd0 74 69 6f 6e 20 63 6f 6e 74 72 6f 6c 20 73 74 61  tion control sta
2ace0 74 65 6d 65 6e 74 73 20 73 75 63 68 20 61 73 20  tements such as 
2acf0 5b 42 45 47 49 4e 5d 2c 20 5b 43 4f 4d 4d 49 54  [BEGIN], [COMMIT
2ad00 5d 2c 20 5b 52 4f 4c 4c 42 41 43 4b 5d 2c 0a 2a  ], [ROLLBACK],.*
2ad10 2a 20 5b 53 41 56 45 50 4f 49 4e 54 5d 2c 20 61  * [SAVEPOINT], a
2ad20 6e 64 20 5b 52 45 4c 45 41 53 45 5d 20 63 61 75  nd [RELEASE] cau
2ad30 73 65 20 73 71 6c 69 74 65 33 5f 73 74 6d 74 5f  se sqlite3_stmt_
2ad40 72 65 61 64 6f 6e 6c 79 28 29 20 74 6f 20 72 65  readonly() to re
2ad50 74 75 72 6e 20 74 72 75 65 2c 0a 2a 2a 20 73 69  turn true,.** si
2ad60 6e 63 65 20 74 68 65 20 73 74 61 74 65 6d 65 6e  nce the statemen
2ad70 74 73 20 74 68 65 6d 73 65 6c 76 65 73 20 64 6f  ts themselves do
2ad80 20 6e 6f 74 20 61 63 74 75 61 6c 6c 79 20 6d 6f   not actually mo
2ad90 64 69 66 79 20 74 68 65 20 64 61 74 61 62 61 73  dify the databas
2ada0 65 20 62 75 74 0a 2a 2a 20 72 61 74 68 65 72 20  e but.** rather 
2adb0 74 68 65 79 20 63 6f 6e 74 72 6f 6c 20 74 68 65  they control the
2adc0 20 74 69 6d 69 6e 67 20 6f 66 20 77 68 65 6e 20   timing of when 
2add0 6f 74 68 65 72 20 73 74 61 74 65 6d 65 6e 74 73  other statements
2ade0 20 6d 6f 64 69 66 79 20 74 68 65 20 0a 2a 2a 20   modify the .** 
2adf0 64 61 74 61 62 61 73 65 2e 20 20 5e 54 68 65 20  database.  ^The 
2ae00 5b 41 54 54 41 43 48 5d 20 61 6e 64 20 5b 44 45  [ATTACH] and [DE
2ae10 54 41 43 48 5d 20 73 74 61 74 65 6d 65 6e 74 73  TACH] statements
2ae20 20 61 6c 73 6f 20 63 61 75 73 65 0a 2a 2a 20 73   also cause.** s
2ae30 71 6c 69 74 65 33 5f 73 74 6d 74 5f 72 65 61 64  qlite3_stmt_read
2ae40 6f 6e 6c 79 28 29 20 74 6f 20 72 65 74 75 72 6e  only() to return
2ae50 20 74 72 75 65 20 73 69 6e 63 65 2c 20 77 68 69   true since, whi
2ae60 6c 65 20 74 68 6f 73 65 20 73 74 61 74 65 6d 65  le those stateme
2ae70 6e 74 73 0a 2a 2a 20 63 68 61 6e 67 65 20 74 68  nts.** change th
2ae80 65 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20  e configuration 
2ae90 6f 66 20 61 20 64 61 74 61 62 61 73 65 20 63 6f  of a database co
2aea0 6e 6e 65 63 74 69 6f 6e 2c 20 74 68 65 79 20 64  nnection, they d
2aeb0 6f 20 6e 6f 74 20 6d 61 6b 65 20 0a 2a 2a 20 63  o not make .** c
2aec0 68 61 6e 67 65 73 20 74 6f 20 74 68 65 20 63 6f  hanges to the co
2aed0 6e 74 65 6e 74 20 6f 66 20 74 68 65 20 64 61 74  ntent of the dat
2aee0 61 62 61 73 65 20 66 69 6c 65 73 20 6f 6e 20 64  abase files on d
2aef0 69 73 6b 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69  isk..*/.int sqli
2af00 74 65 33 5f 73 74 6d 74 5f 72 65 61 64 6f 6e 6c  te3_stmt_readonl
2af10 79 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 20 2a  y(sqlite3_stmt *
2af20 70 53 74 6d 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43  pStmt);../*.** C
2af30 41 50 49 33 52 45 46 3a 20 44 65 74 65 72 6d 69  API3REF: Determi
2af40 6e 65 20 49 66 20 41 20 50 72 65 70 61 72 65 64  ne If A Prepared
2af50 20 53 74 61 74 65 6d 65 6e 74 20 48 61 73 20 42   Statement Has B
2af60 65 65 6e 20 52 65 73 65 74 0a 2a 2a 20 4d 45 54  een Reset.** MET
2af70 48 4f 44 3a 20 73 71 6c 69 74 65 33 5f 73 74 6d  HOD: sqlite3_stm
2af80 74 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c  t.**.** ^The sql
2af90 69 74 65 33 5f 73 74 6d 74 5f 62 75 73 79 28 53  ite3_stmt_busy(S
2afa0 29 20 69 6e 74 65 72 66 61 63 65 20 72 65 74 75  ) interface retu
2afb0 72 6e 73 20 74 72 75 65 20 28 6e 6f 6e 2d 7a 65  rns true (non-ze
2afc0 72 6f 29 20 69 66 20 74 68 65 0a 2a 2a 20 5b 70  ro) if the.** [p
2afd0 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e  repared statemen
2afe0 74 5d 20 53 20 68 61 73 20 62 65 65 6e 20 73 74  t] S has been st
2aff0 65 70 70 65 64 20 61 74 20 6c 65 61 73 74 20 6f  epped at least o
2b000 6e 63 65 20 75 73 69 6e 67 20 0a 2a 2a 20 5b 73  nce using .** [s
2b010 71 6c 69 74 65 33 5f 73 74 65 70 28 53 29 5d 20  qlite3_step(S)] 
2b020 62 75 74 20 68 61 73 20 6e 65 69 74 68 65 72 20  but has neither 
2b030 72 75 6e 20 74 6f 20 63 6f 6d 70 6c 65 74 69 6f  run to completio
2b040 6e 20 28 72 65 74 75 72 6e 65 64 0a 2a 2a 20 5b  n (returned.** [
2b050 53 51 4c 49 54 45 5f 44 4f 4e 45 5d 20 66 72 6f  SQLITE_DONE] fro
2b060 6d 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28  m [sqlite3_step(
2b070 53 29 5d 29 20 6e 6f 72 0a 2a 2a 20 62 65 65 6e  S)]) nor.** been
2b080 20 72 65 73 65 74 20 75 73 69 6e 67 20 5b 73 71   reset using [sq
2b090 6c 69 74 65 33 5f 72 65 73 65 74 28 53 29 5d 2e  lite3_reset(S)].
2b0a0 20 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 73    ^The sqlite3_s
2b0b0 74 6d 74 5f 62 75 73 79 28 53 29 0a 2a 2a 20 69  tmt_busy(S).** i
2b0c0 6e 74 65 72 66 61 63 65 20 72 65 74 75 72 6e 73  nterface returns
2b0d0 20 66 61 6c 73 65 20 69 66 20 53 20 69 73 20 61   false if S is a
2b0e0 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 2e 20 20   NULL pointer.  
2b0f0 49 66 20 53 20 69 73 20 6e 6f 74 20 61 20 0a 2a  If S is not a .*
2b100 2a 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 20 61  * NULL pointer a
2b110 6e 64 20 69 73 20 6e 6f 74 20 61 20 70 6f 69 6e  nd is not a poin
2b120 74 65 72 20 74 6f 20 61 20 76 61 6c 69 64 20 5b  ter to a valid [
2b130 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65  prepared stateme
2b140 6e 74 5d 0a 2a 2a 20 6f 62 6a 65 63 74 2c 20 74  nt].** object, t
2b150 68 65 6e 20 74 68 65 20 62 65 68 61 76 69 6f 72  hen the behavior
2b160 20 69 73 20 75 6e 64 65 66 69 6e 65 64 20 61 6e   is undefined an
2b170 64 20 70 72 6f 62 61 62 6c 79 20 75 6e 64 65 73  d probably undes
2b180 69 72 61 62 6c 65 2e 0a 2a 2a 0a 2a 2a 20 54 68  irable..**.** Th
2b190 69 73 20 69 6e 74 65 72 66 61 63 65 20 63 61 6e  is interface can
2b1a0 20 62 65 20 75 73 65 64 20 69 6e 20 63 6f 6d 62   be used in comb
2b1b0 69 6e 61 74 69 6f 6e 20 5b 73 71 6c 69 74 65 33  ination [sqlite3
2b1c0 5f 6e 65 78 74 5f 73 74 6d 74 28 29 5d 0a 2a 2a  _next_stmt()].**
2b1d0 20 74 6f 20 6c 6f 63 61 74 65 20 61 6c 6c 20 70   to locate all p
2b1e0 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e  repared statemen
2b1f0 74 73 20 61 73 73 6f 63 69 61 74 65 64 20 77 69  ts associated wi
2b200 74 68 20 61 20 64 61 74 61 62 61 73 65 20 0a 2a  th a database .*
2b210 2a 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 74 68 61  * connection tha
2b220 74 20 61 72 65 20 69 6e 20 6e 65 65 64 20 6f 66  t are in need of
2b230 20 62 65 69 6e 67 20 72 65 73 65 74 2e 20 20 54   being reset.  T
2b240 68 69 73 20 63 61 6e 20 62 65 20 75 73 65 64 2c  his can be used,
2b250 0a 2a 2a 20 66 6f 72 20 65 78 61 6d 70 6c 65 2c  .** for example,
2b260 20 69 6e 20 64 69 61 67 6e 6f 73 74 69 63 20 72   in diagnostic r
2b270 6f 75 74 69 6e 65 73 20 74 6f 20 73 65 61 72 63  outines to searc
2b280 68 20 66 6f 72 20 70 72 65 70 61 72 65 64 20 0a  h for prepared .
2b290 2a 2a 20 73 74 61 74 65 6d 65 6e 74 73 20 74 68  ** statements th
2b2a0 61 74 20 61 72 65 20 68 6f 6c 64 69 6e 67 20 61  at are holding a
2b2b0 20 74 72 61 6e 73 61 63 74 69 6f 6e 20 6f 70 65   transaction ope
2b2c0 6e 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65  n..*/.int sqlite
2b2d0 33 5f 73 74 6d 74 5f 62 75 73 79 28 73 71 6c 69  3_stmt_busy(sqli
2b2e0 74 65 33 5f 73 74 6d 74 2a 29 3b 0a 0a 2f 2a 0a  te3_stmt*);../*.
2b2f0 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 44 79 6e  ** CAPI3REF: Dyn
2b300 61 6d 69 63 61 6c 6c 79 20 54 79 70 65 64 20 56  amically Typed V
2b310 61 6c 75 65 20 4f 62 6a 65 63 74 0a 2a 2a 20 4b  alue Object.** K
2b320 45 59 57 4f 52 44 53 3a 20 7b 70 72 6f 74 65 63  EYWORDS: {protec
2b330 74 65 64 20 73 71 6c 69 74 65 33 5f 76 61 6c 75  ted sqlite3_valu
2b340 65 7d 20 7b 75 6e 70 72 6f 74 65 63 74 65 64 20  e} {unprotected 
2b350 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 7d 0a 2a  sqlite3_value}.*
2b360 2a 0a 2a 2a 20 53 51 4c 69 74 65 20 75 73 65 73  *.** SQLite uses
2b370 20 74 68 65 20 73 71 6c 69 74 65 33 5f 76 61 6c   the sqlite3_val
2b380 75 65 20 6f 62 6a 65 63 74 20 74 6f 20 72 65 70  ue object to rep
2b390 72 65 73 65 6e 74 20 61 6c 6c 20 76 61 6c 75 65  resent all value
2b3a0 73 0a 2a 2a 20 74 68 61 74 20 63 61 6e 20 62 65  s.** that can be
2b3b0 20 73 74 6f 72 65 64 20 69 6e 20 61 20 64 61 74   stored in a dat
2b3c0 61 62 61 73 65 20 74 61 62 6c 65 2e 20 53 51 4c  abase table. SQL
2b3d0 69 74 65 20 75 73 65 73 20 64 79 6e 61 6d 69 63  ite uses dynamic
2b3e0 20 74 79 70 69 6e 67 0a 2a 2a 20 66 6f 72 20 74   typing.** for t
2b3f0 68 65 20 76 61 6c 75 65 73 20 69 74 20 73 74 6f  he values it sto
2b400 72 65 73 2e 20 20 5e 56 61 6c 75 65 73 20 73 74  res.  ^Values st
2b410 6f 72 65 64 20 69 6e 20 73 71 6c 69 74 65 33 5f  ored in sqlite3_
2b420 76 61 6c 75 65 20 6f 62 6a 65 63 74 73 0a 2a 2a  value objects.**
2b430 20 63 61 6e 20 62 65 20 69 6e 74 65 67 65 72 73   can be integers
2b440 2c 20 66 6c 6f 61 74 69 6e 67 20 70 6f 69 6e 74  , floating point
2b450 20 76 61 6c 75 65 73 2c 20 73 74 72 69 6e 67 73   values, strings
2b460 2c 20 42 4c 4f 42 73 2c 20 6f 72 20 4e 55 4c 4c  , BLOBs, or NULL
2b470 2e 0a 2a 2a 0a 2a 2a 20 41 6e 20 73 71 6c 69 74  ..**.** An sqlit
2b480 65 33 5f 76 61 6c 75 65 20 6f 62 6a 65 63 74 20  e3_value object 
2b490 6d 61 79 20 62 65 20 65 69 74 68 65 72 20 22 70  may be either "p
2b4a0 72 6f 74 65 63 74 65 64 22 20 6f 72 20 22 75 6e  rotected" or "un
2b4b0 70 72 6f 74 65 63 74 65 64 22 2e 0a 2a 2a 20 53  protected"..** S
2b4c0 6f 6d 65 20 69 6e 74 65 72 66 61 63 65 73 20 72  ome interfaces r
2b4d0 65 71 75 69 72 65 20 61 20 70 72 6f 74 65 63 74  equire a protect
2b4e0 65 64 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  ed sqlite3_value
2b4f0 2e 20 20 4f 74 68 65 72 20 69 6e 74 65 72 66 61  .  Other interfa
2b500 63 65 73 0a 2a 2a 20 77 69 6c 6c 20 61 63 63 65  ces.** will acce
2b510 70 74 20 65 69 74 68 65 72 20 61 20 70 72 6f 74  pt either a prot
2b520 65 63 74 65 64 20 6f 72 20 61 6e 20 75 6e 70 72  ected or an unpr
2b530 6f 74 65 63 74 65 64 20 73 71 6c 69 74 65 33 5f  otected sqlite3_
2b540 76 61 6c 75 65 2e 0a 2a 2a 20 45 76 65 72 79 20  value..** Every 
2b550 69 6e 74 65 72 66 61 63 65 20 74 68 61 74 20 61  interface that a
2b560 63 63 65 70 74 73 20 73 71 6c 69 74 65 33 5f 76  ccepts sqlite3_v
2b570 61 6c 75 65 20 61 72 67 75 6d 65 6e 74 73 20 73  alue arguments s
2b580 70 65 63 69 66 69 65 73 0a 2a 2a 20 77 68 65 74  pecifies.** whet
2b590 68 65 72 20 6f 72 20 6e 6f 74 20 69 74 20 72 65  her or not it re
2b5a0 71 75 69 72 65 73 20 61 20 70 72 6f 74 65 63 74  quires a protect
2b5b0 65 64 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  ed sqlite3_value
2b5c0 2e 20 20 54 68 65 0a 2a 2a 20 5b 73 71 6c 69 74  .  The.** [sqlit
2b5d0 65 33 5f 76 61 6c 75 65 5f 64 75 70 28 29 5d 20  e3_value_dup()] 
2b5e0 69 6e 74 65 72 66 61 63 65 20 63 61 6e 20 62 65  interface can be
2b5f0 20 75 73 65 64 20 74 6f 20 63 6f 6e 73 74 72 75   used to constru
2b600 63 74 20 61 20 6e 65 77 20 0a 2a 2a 20 70 72 6f  ct a new .** pro
2b610 74 65 63 74 65 64 20 73 71 6c 69 74 65 33 5f 76  tected sqlite3_v
2b620 61 6c 75 65 20 66 72 6f 6d 20 61 6e 20 75 6e 70  alue from an unp
2b630 72 6f 74 65 63 74 65 64 20 73 71 6c 69 74 65 33  rotected sqlite3
2b640 5f 76 61 6c 75 65 2e 0a 2a 2a 0a 2a 2a 20 54 68  _value..**.** Th
2b650 65 20 74 65 72 6d 73 20 22 70 72 6f 74 65 63 74  e terms "protect
2b660 65 64 22 20 61 6e 64 20 22 75 6e 70 72 6f 74 65  ed" and "unprote
2b670 63 74 65 64 22 20 72 65 66 65 72 20 74 6f 20 77  cted" refer to w
2b680 68 65 74 68 65 72 20 6f 72 20 6e 6f 74 0a 2a 2a  hether or not.**
2b690 20 61 20 6d 75 74 65 78 20 69 73 20 68 65 6c 64   a mutex is held
2b6a0 2e 20 20 41 6e 20 69 6e 74 65 72 6e 61 6c 20 6d  .  An internal m
2b6b0 75 74 65 78 20 69 73 20 68 65 6c 64 20 66 6f 72  utex is held for
2b6c0 20 61 20 70 72 6f 74 65 63 74 65 64 0a 2a 2a 20   a protected.** 
2b6d0 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 20 6f 62  sqlite3_value ob
2b6e0 6a 65 63 74 20 62 75 74 20 6e 6f 20 6d 75 74 65  ject but no mute
2b6f0 78 20 69 73 20 68 65 6c 64 20 66 6f 72 20 61 6e  x is held for an
2b700 20 75 6e 70 72 6f 74 65 63 74 65 64 0a 2a 2a 20   unprotected.** 
2b710 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 20 6f 62  sqlite3_value ob
2b720 6a 65 63 74 2e 20 20 49 66 20 53 51 4c 69 74 65  ject.  If SQLite
2b730 20 69 73 20 63 6f 6d 70 69 6c 65 64 20 74 6f 20   is compiled to 
2b740 62 65 20 73 69 6e 67 6c 65 2d 74 68 72 65 61 64  be single-thread
2b750 65 64 0a 2a 2a 20 28 77 69 74 68 20 5b 53 51 4c  ed.** (with [SQL
2b760 49 54 45 5f 54 48 52 45 41 44 53 41 46 45 3d 30  ITE_THREADSAFE=0
2b770 5d 20 61 6e 64 20 77 69 74 68 20 5b 73 71 6c 69  ] and with [sqli
2b780 74 65 33 5f 74 68 72 65 61 64 73 61 66 65 28 29  te3_threadsafe()
2b790 5d 20 72 65 74 75 72 6e 69 6e 67 20 30 29 0a 2a  ] returning 0).*
2b7a0 2a 20 6f 72 20 69 66 20 53 51 4c 69 74 65 20 69  * or if SQLite i
2b7b0 73 20 72 75 6e 20 69 6e 20 6f 6e 65 20 6f 66 20  s run in one of 
2b7c0 72 65 64 75 63 65 64 20 6d 75 74 65 78 20 6d 6f  reduced mutex mo
2b7d0 64 65 73 20 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f  des .** [SQLITE_
2b7e0 43 4f 4e 46 49 47 5f 53 49 4e 47 4c 45 54 48 52  CONFIG_SINGLETHR
2b7f0 45 41 44 5d 20 6f 72 20 5b 53 51 4c 49 54 45 5f  EAD] or [SQLITE_
2b800 43 4f 4e 46 49 47 5f 4d 55 4c 54 49 54 48 52 45  CONFIG_MULTITHRE
2b810 41 44 5d 0a 2a 2a 20 74 68 65 6e 20 74 68 65 72  AD].** then ther
2b820 65 20 69 73 20 6e 6f 20 64 69 73 74 69 6e 63 74  e is no distinct
2b830 69 6f 6e 20 62 65 74 77 65 65 6e 20 70 72 6f 74  ion between prot
2b840 65 63 74 65 64 20 61 6e 64 20 75 6e 70 72 6f 74  ected and unprot
2b850 65 63 74 65 64 0a 2a 2a 20 73 71 6c 69 74 65 33  ected.** sqlite3
2b860 5f 76 61 6c 75 65 20 6f 62 6a 65 63 74 73 20 61  _value objects a
2b870 6e 64 20 74 68 65 79 20 63 61 6e 20 62 65 20 75  nd they can be u
2b880 73 65 64 20 69 6e 74 65 72 63 68 61 6e 67 65 61  sed interchangea
2b890 62 6c 79 2e 20 20 48 6f 77 65 76 65 72 2c 0a 2a  bly.  However,.*
2b8a0 2a 20 66 6f 72 20 6d 61 78 69 6d 75 6d 20 63 6f  * for maximum co
2b8b0 64 65 20 70 6f 72 74 61 62 69 6c 69 74 79 20 69  de portability i
2b8c0 74 20 69 73 20 72 65 63 6f 6d 6d 65 6e 64 65 64  t is recommended
2b8d0 20 74 68 61 74 20 61 70 70 6c 69 63 61 74 69 6f   that applicatio
2b8e0 6e 73 0a 2a 2a 20 73 74 69 6c 6c 20 6d 61 6b 65  ns.** still make
2b8f0 20 74 68 65 20 64 69 73 74 69 6e 63 74 69 6f 6e   the distinction
2b900 20 62 65 74 77 65 65 6e 20 70 72 6f 74 65 63 74   between protect
2b910 65 64 20 61 6e 64 20 75 6e 70 72 6f 74 65 63 74  ed and unprotect
2b920 65 64 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 76 61  ed.** sqlite3_va
2b930 6c 75 65 20 6f 62 6a 65 63 74 73 20 65 76 65 6e  lue objects even
2b940 20 77 68 65 6e 20 6e 6f 74 20 73 74 72 69 63 74   when not strict
2b950 6c 79 20 72 65 71 75 69 72 65 64 2e 0a 2a 2a 0a  ly required..**.
2b960 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f  ** ^The sqlite3_
2b970 76 61 6c 75 65 20 6f 62 6a 65 63 74 73 20 74 68  value objects th
2b980 61 74 20 61 72 65 20 70 61 73 73 65 64 20 61 73  at are passed as
2b990 20 70 61 72 61 6d 65 74 65 72 73 20 69 6e 74 6f   parameters into
2b9a0 20 74 68 65 0a 2a 2a 20 69 6d 70 6c 65 6d 65 6e   the.** implemen
2b9b0 74 61 74 69 6f 6e 20 6f 66 20 5b 61 70 70 6c 69  tation of [appli
2b9c0 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 53  cation-defined S
2b9d0 51 4c 20 66 75 6e 63 74 69 6f 6e 73 5d 20 61 72  QL functions] ar
2b9e0 65 20 70 72 6f 74 65 63 74 65 64 2e 0a 2a 2a 20  e protected..** 
2b9f0 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 76 61 6c  ^The sqlite3_val
2ba00 75 65 20 6f 62 6a 65 63 74 20 72 65 74 75 72 6e  ue object return
2ba10 65 64 20 62 79 0a 2a 2a 20 5b 73 71 6c 69 74 65  ed by.** [sqlite
2ba20 33 5f 63 6f 6c 75 6d 6e 5f 76 61 6c 75 65 28 29  3_column_value()
2ba30 5d 20 69 73 20 75 6e 70 72 6f 74 65 63 74 65 64  ] is unprotected
2ba40 2e 0a 2a 2a 20 55 6e 70 72 6f 74 65 63 74 65 64  ..** Unprotected
2ba50 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 20 6f   sqlite3_value o
2ba60 62 6a 65 63 74 73 20 6d 61 79 20 6f 6e 6c 79 20  bjects may only 
2ba70 62 65 20 75 73 65 64 20 77 69 74 68 0a 2a 2a 20  be used with.** 
2ba80 5b 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f  [sqlite3_result_
2ba90 76 61 6c 75 65 28 29 5d 20 61 6e 64 20 5b 73 71  value()] and [sq
2baa0 6c 69 74 65 33 5f 62 69 6e 64 5f 76 61 6c 75 65  lite3_bind_value
2bab0 28 29 5d 2e 0a 2a 2a 20 54 68 65 20 5b 73 71 6c  ()]..** The [sql
2bac0 69 74 65 33 5f 76 61 6c 75 65 5f 62 6c 6f 62 20  ite3_value_blob 
2bad0 7c 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f  | sqlite3_value_
2bae0 74 79 70 65 28 29 5d 20 66 61 6d 69 6c 79 20 6f  type()] family o
2baf0 66 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 73 20  f.** interfaces 
2bb00 72 65 71 75 69 72 65 20 70 72 6f 74 65 63 74 65  require protecte
2bb10 64 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 20  d sqlite3_value 
2bb20 6f 62 6a 65 63 74 73 2e 0a 2a 2f 0a 74 79 70 65  objects..*/.type
2bb30 64 65 66 20 73 74 72 75 63 74 20 4d 65 6d 20 73  def struct Mem s
2bb40 71 6c 69 74 65 33 5f 76 61 6c 75 65 3b 0a 0a 2f  qlite3_value;../
2bb50 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 53  *.** CAPI3REF: S
2bb60 51 4c 20 46 75 6e 63 74 69 6f 6e 20 43 6f 6e 74  QL Function Cont
2bb70 65 78 74 20 4f 62 6a 65 63 74 0a 2a 2a 0a 2a 2a  ext Object.**.**
2bb80 20 54 68 65 20 63 6f 6e 74 65 78 74 20 69 6e 20   The context in 
2bb90 77 68 69 63 68 20 61 6e 20 53 51 4c 20 66 75 6e  which an SQL fun
2bba0 63 74 69 6f 6e 20 65 78 65 63 75 74 65 73 20 69  ction executes i
2bbb0 73 20 73 74 6f 72 65 64 20 69 6e 20 61 6e 0a 2a  s stored in an.*
2bbc0 2a 20 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78  * sqlite3_contex
2bbd0 74 20 6f 62 6a 65 63 74 2e 20 20 5e 41 20 70 6f  t object.  ^A po
2bbe0 69 6e 74 65 72 20 74 6f 20 61 6e 20 73 71 6c 69  inter to an sqli
2bbf0 74 65 33 5f 63 6f 6e 74 65 78 74 20 6f 62 6a 65  te3_context obje
2bc00 63 74 0a 2a 2a 20 69 73 20 61 6c 77 61 79 73 20  ct.** is always 
2bc10 66 69 72 73 74 20 70 61 72 61 6d 65 74 65 72 20  first parameter 
2bc20 74 6f 20 5b 61 70 70 6c 69 63 61 74 69 6f 6e 2d  to [application-
2bc30 64 65 66 69 6e 65 64 20 53 51 4c 20 66 75 6e 63  defined SQL func
2bc40 74 69 6f 6e 73 5d 2e 0a 2a 2a 20 54 68 65 20 61  tions]..** The a
2bc50 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e  pplication-defin
2bc60 65 64 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20  ed SQL function 
2bc70 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 77  implementation w
2bc80 69 6c 6c 20 70 61 73 73 20 74 68 69 73 0a 2a 2a  ill pass this.**
2bc90 20 70 6f 69 6e 74 65 72 20 74 68 72 6f 75 67 68   pointer through
2bca0 20 69 6e 74 6f 20 63 61 6c 6c 73 20 74 6f 20 5b   into calls to [
2bcb0 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 69  sqlite3_result_i
2bcc0 6e 74 20 7c 20 73 71 6c 69 74 65 33 5f 72 65 73  nt | sqlite3_res
2bcd0 75 6c 74 28 29 5d 2c 0a 2a 2a 20 5b 73 71 6c 69  ult()],.** [sqli
2bce0 74 65 33 5f 61 67 67 72 65 67 61 74 65 5f 63 6f  te3_aggregate_co
2bcf0 6e 74 65 78 74 28 29 5d 2c 20 5b 73 71 6c 69 74  ntext()], [sqlit
2bd00 65 33 5f 75 73 65 72 5f 64 61 74 61 28 29 5d 2c  e3_user_data()],
2bd10 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6e  .** [sqlite3_con
2bd20 74 65 78 74 5f 64 62 5f 68 61 6e 64 6c 65 28 29  text_db_handle()
2bd30 5d 2c 20 5b 73 71 6c 69 74 65 33 5f 67 65 74 5f  ], [sqlite3_get_
2bd40 61 75 78 64 61 74 61 28 29 5d 2c 0a 2a 2a 20 61  auxdata()],.** a
2bd50 6e 64 2f 6f 72 20 5b 73 71 6c 69 74 65 33 5f 73  nd/or [sqlite3_s
2bd60 65 74 5f 61 75 78 64 61 74 61 28 29 5d 2e 0a 2a  et_auxdata()]..*
2bd70 2f 0a 74 79 70 65 64 65 66 20 73 74 72 75 63 74  /.typedef struct
2bd80 20 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74   sqlite3_context
2bd90 20 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74   sqlite3_context
2bda0 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  ;../*.** CAPI3RE
2bdb0 46 3a 20 42 69 6e 64 69 6e 67 20 56 61 6c 75 65  F: Binding Value
2bdc0 73 20 54 6f 20 50 72 65 70 61 72 65 64 20 53 74  s To Prepared St
2bdd0 61 74 65 6d 65 6e 74 73 0a 2a 2a 20 4b 45 59 57  atements.** KEYW
2bde0 4f 52 44 53 3a 20 7b 68 6f 73 74 20 70 61 72 61  ORDS: {host para
2bdf0 6d 65 74 65 72 7d 20 7b 68 6f 73 74 20 70 61 72  meter} {host par
2be00 61 6d 65 74 65 72 73 7d 20 7b 68 6f 73 74 20 70  ameters} {host p
2be10 61 72 61 6d 65 74 65 72 20 6e 61 6d 65 7d 0a 2a  arameter name}.*
2be20 2a 20 4b 45 59 57 4f 52 44 53 3a 20 7b 53 51 4c  * KEYWORDS: {SQL
2be30 20 70 61 72 61 6d 65 74 65 72 7d 20 7b 53 51 4c   parameter} {SQL
2be40 20 70 61 72 61 6d 65 74 65 72 73 7d 20 7b 70 61   parameters} {pa
2be50 72 61 6d 65 74 65 72 20 62 69 6e 64 69 6e 67 7d  rameter binding}
2be60 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69  .** METHOD: sqli
2be70 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e  te3_stmt.**.** ^
2be80 28 49 6e 20 74 68 65 20 53 51 4c 20 73 74 61 74  (In the SQL stat
2be90 65 6d 65 6e 74 20 74 65 78 74 20 69 6e 70 75 74  ement text input
2bea0 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 70 72 65   to [sqlite3_pre
2beb0 70 61 72 65 5f 76 32 28 29 5d 20 61 6e 64 20 69  pare_v2()] and i
2bec0 74 73 20 76 61 72 69 61 6e 74 73 2c 0a 2a 2a 20  ts variants,.** 
2bed0 6c 69 74 65 72 61 6c 73 20 6d 61 79 20 62 65 20  literals may be 
2bee0 72 65 70 6c 61 63 65 64 20 62 79 20 61 20 5b 70  replaced by a [p
2bef0 61 72 61 6d 65 74 65 72 5d 20 74 68 61 74 20 6d  arameter] that m
2bf00 61 74 63 68 65 73 20 6f 6e 65 20 6f 66 20 66 6f  atches one of fo
2bf10 6c 6c 6f 77 69 6e 67 0a 2a 2a 20 74 65 6d 70 6c  llowing.** templ
2bf20 61 74 65 73 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e  ates:.**.** <ul>
2bf30 0a 2a 2a 20 3c 6c 69 3e 20 20 3f 0a 2a 2a 20 3c  .** <li>  ?.** <
2bf40 6c 69 3e 20 20 3f 4e 4e 4e 0a 2a 2a 20 3c 6c 69  li>  ?NNN.** <li
2bf50 3e 20 20 3a 56 56 56 0a 2a 2a 20 3c 6c 69 3e 20  >  :VVV.** <li> 
2bf60 20 40 56 56 56 0a 2a 2a 20 3c 6c 69 3e 20 20 24   @VVV.** <li>  $
2bf70 56 56 56 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2a 0a  VVV.** </ul>.**.
2bf80 2a 2a 20 49 6e 20 74 68 65 20 74 65 6d 70 6c 61  ** In the templa
2bf90 74 65 73 20 61 62 6f 76 65 2c 20 4e 4e 4e 20 72  tes above, NNN r
2bfa0 65 70 72 65 73 65 6e 74 73 20 61 6e 20 69 6e 74  epresents an int
2bfb0 65 67 65 72 20 6c 69 74 65 72 61 6c 2c 0a 2a 2a  eger literal,.**
2bfc0 20 61 6e 64 20 56 56 56 20 72 65 70 72 65 73 65   and VVV represe
2bfd0 6e 74 73 20 61 6e 20 61 6c 70 68 61 6e 75 6d 65  nts an alphanume
2bfe0 72 69 63 20 69 64 65 6e 74 69 66 69 65 72 2e 29  ric identifier.)
2bff0 5e 20 20 5e 54 68 65 20 76 61 6c 75 65 73 20 6f  ^  ^The values o
2c000 66 20 74 68 65 73 65 0a 2a 2a 20 70 61 72 61 6d  f these.** param
2c010 65 74 65 72 73 20 28 61 6c 73 6f 20 63 61 6c 6c  eters (also call
2c020 65 64 20 22 68 6f 73 74 20 70 61 72 61 6d 65 74  ed "host paramet
2c030 65 72 20 6e 61 6d 65 73 22 20 6f 72 20 22 53 51  er names" or "SQ
2c040 4c 20 70 61 72 61 6d 65 74 65 72 73 22 29 0a 2a  L parameters").*
2c050 2a 20 63 61 6e 20 62 65 20 73 65 74 20 75 73 69  * can be set usi
2c060 6e 67 20 74 68 65 20 73 71 6c 69 74 65 33 5f 62  ng the sqlite3_b
2c070 69 6e 64 5f 2a 28 29 20 72 6f 75 74 69 6e 65 73  ind_*() routines
2c080 20 64 65 66 69 6e 65 64 20 68 65 72 65 2e 0a 2a   defined here..*
2c090 2a 0a 2a 2a 20 5e 54 68 65 20 66 69 72 73 74 20  *.** ^The first 
2c0a0 61 72 67 75 6d 65 6e 74 20 74 6f 20 74 68 65 20  argument to the 
2c0b0 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 2a 28 29  sqlite3_bind_*()
2c0c0 20 72 6f 75 74 69 6e 65 73 20 69 73 20 61 6c 77   routines is alw
2c0d0 61 79 73 0a 2a 2a 20 61 20 70 6f 69 6e 74 65 72  ays.** a pointer
2c0e0 20 74 6f 20 74 68 65 20 5b 73 71 6c 69 74 65 33   to the [sqlite3
2c0f0 5f 73 74 6d 74 5d 20 6f 62 6a 65 63 74 20 72 65  _stmt] object re
2c100 74 75 72 6e 65 64 20 66 72 6f 6d 0a 2a 2a 20 5b  turned from.** [
2c110 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 5f  sqlite3_prepare_
2c120 76 32 28 29 5d 20 6f 72 20 69 74 73 20 76 61 72  v2()] or its var
2c130 69 61 6e 74 73 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68  iants..**.** ^Th
2c140 65 20 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e  e second argumen
2c150 74 20 69 73 20 74 68 65 20 69 6e 64 65 78 20 6f  t is the index o
2c160 66 20 74 68 65 20 53 51 4c 20 70 61 72 61 6d 65  f the SQL parame
2c170 74 65 72 20 74 6f 20 62 65 20 73 65 74 2e 0a 2a  ter to be set..*
2c180 2a 20 5e 54 68 65 20 6c 65 66 74 6d 6f 73 74 20  * ^The leftmost 
2c190 53 51 4c 20 70 61 72 61 6d 65 74 65 72 20 68 61  SQL parameter ha
2c1a0 73 20 61 6e 20 69 6e 64 65 78 20 6f 66 20 31 2e  s an index of 1.
2c1b0 20 20 5e 57 68 65 6e 20 74 68 65 20 73 61 6d 65    ^When the same
2c1c0 20 6e 61 6d 65 64 0a 2a 2a 20 53 51 4c 20 70 61   named.** SQL pa
2c1d0 72 61 6d 65 74 65 72 20 69 73 20 75 73 65 64 20  rameter is used 
2c1e0 6d 6f 72 65 20 74 68 61 6e 20 6f 6e 63 65 2c 20  more than once, 
2c1f0 73 65 63 6f 6e 64 20 61 6e 64 20 73 75 62 73 65  second and subse
2c200 71 75 65 6e 74 0a 2a 2a 20 6f 63 63 75 72 72 65  quent.** occurre
2c210 6e 63 65 73 20 68 61 76 65 20 74 68 65 20 73 61  nces have the sa
2c220 6d 65 20 69 6e 64 65 78 20 61 73 20 74 68 65 20  me index as the 
2c230 66 69 72 73 74 20 6f 63 63 75 72 72 65 6e 63 65  first occurrence
2c240 2e 0a 2a 2a 20 5e 54 68 65 20 69 6e 64 65 78 20  ..** ^The index 
2c250 66 6f 72 20 6e 61 6d 65 64 20 70 61 72 61 6d 65  for named parame
2c260 74 65 72 73 20 63 61 6e 20 62 65 20 6c 6f 6f 6b  ters can be look
2c270 65 64 20 75 70 20 75 73 69 6e 67 20 74 68 65 0a  ed up using the.
2c280 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64  ** [sqlite3_bind
2c290 5f 70 61 72 61 6d 65 74 65 72 5f 69 6e 64 65 78  _parameter_index
2c2a0 28 29 5d 20 41 50 49 20 69 66 20 64 65 73 69 72  ()] API if desir
2c2b0 65 64 2e 20 20 5e 54 68 65 20 69 6e 64 65 78 0a  ed.  ^The index.
2c2c0 2a 2a 20 66 6f 72 20 22 3f 4e 4e 4e 22 20 70 61  ** for "?NNN" pa
2c2d0 72 61 6d 65 74 65 72 73 20 69 73 20 74 68 65 20  rameters is the 
2c2e0 76 61 6c 75 65 20 6f 66 20 4e 4e 4e 2e 0a 2a 2a  value of NNN..**
2c2f0 20 5e 54 68 65 20 4e 4e 4e 20 76 61 6c 75 65 20   ^The NNN value 
2c300 6d 75 73 74 20 62 65 20 62 65 74 77 65 65 6e 20  must be between 
2c310 31 20 61 6e 64 20 74 68 65 20 5b 73 71 6c 69 74  1 and the [sqlit
2c320 65 33 5f 6c 69 6d 69 74 28 29 5d 0a 2a 2a 20 70  e3_limit()].** p
2c330 61 72 61 6d 65 74 65 72 20 5b 53 51 4c 49 54 45  arameter [SQLITE
2c340 5f 4c 49 4d 49 54 5f 56 41 52 49 41 42 4c 45 5f  _LIMIT_VARIABLE_
2c350 4e 55 4d 42 45 52 5d 20 28 64 65 66 61 75 6c 74  NUMBER] (default
2c360 20 76 61 6c 75 65 3a 20 39 39 39 29 2e 0a 2a 2a   value: 999)..**
2c370 0a 2a 2a 20 5e 54 68 65 20 74 68 69 72 64 20 61  .** ^The third a
2c380 72 67 75 6d 65 6e 74 20 69 73 20 74 68 65 20 76  rgument is the v
2c390 61 6c 75 65 20 74 6f 20 62 69 6e 64 20 74 6f 20  alue to bind to 
2c3a0 74 68 65 20 70 61 72 61 6d 65 74 65 72 2e 0a 2a  the parameter..*
2c3b0 2a 20 5e 49 66 20 74 68 65 20 74 68 69 72 64 20  * ^If the third 
2c3c0 70 61 72 61 6d 65 74 65 72 20 74 6f 20 73 71 6c  parameter to sql
2c3d0 69 74 65 33 5f 62 69 6e 64 5f 74 65 78 74 28 29  ite3_bind_text()
2c3e0 20 6f 72 20 73 71 6c 69 74 65 33 5f 62 69 6e 64   or sqlite3_bind
2c3f0 5f 74 65 78 74 31 36 28 29 0a 2a 2a 20 6f 72 20  _text16().** or 
2c400 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 62 6c 6f  sqlite3_bind_blo
2c410 62 28 29 20 69 73 20 61 20 4e 55 4c 4c 20 70 6f  b() is a NULL po
2c420 69 6e 74 65 72 20 74 68 65 6e 20 74 68 65 20 66  inter then the f
2c430 6f 75 72 74 68 20 70 61 72 61 6d 65 74 65 72 0a  ourth parameter.
2c440 2a 2a 20 69 73 20 69 67 6e 6f 72 65 64 20 61 6e  ** is ignored an
2c450 64 20 74 68 65 20 65 6e 64 20 72 65 73 75 6c 74  d the end result
2c460 20 69 73 20 74 68 65 20 73 61 6d 65 20 61 73 20   is the same as 
2c470 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 6e 75 6c  sqlite3_bind_nul
2c480 6c 28 29 2e 0a 2a 2a 0a 2a 2a 20 5e 28 49 6e 20  l()..**.** ^(In 
2c490 74 68 6f 73 65 20 72 6f 75 74 69 6e 65 73 20 74  those routines t
2c4a0 68 61 74 20 68 61 76 65 20 61 20 66 6f 75 72 74  hat have a fourt
2c4b0 68 20 61 72 67 75 6d 65 6e 74 2c 20 69 74 73 20  h argument, its 
2c4c0 76 61 6c 75 65 20 69 73 20 74 68 65 0a 2a 2a 20  value is the.** 
2c4d0 6e 75 6d 62 65 72 20 6f 66 20 62 79 74 65 73 20  number of bytes 
2c4e0 69 6e 20 74 68 65 20 70 61 72 61 6d 65 74 65 72  in the parameter
2c4f0 2e 20 20 54 6f 20 62 65 20 63 6c 65 61 72 3a 20  .  To be clear: 
2c500 74 68 65 20 76 61 6c 75 65 20 69 73 20 74 68 65  the value is the
2c510 0a 2a 2a 20 6e 75 6d 62 65 72 20 6f 66 20 3c 75  .** number of <u
2c520 3e 62 79 74 65 73 3c 2f 75 3e 20 69 6e 20 74 68  >bytes</u> in th
2c530 65 20 76 61 6c 75 65 2c 20 6e 6f 74 20 74 68 65  e value, not the
2c540 20 6e 75 6d 62 65 72 20 6f 66 20 63 68 61 72 61   number of chara
2c550 63 74 65 72 73 2e 29 5e 0a 2a 2a 20 5e 49 66 20  cters.)^.** ^If 
2c560 74 68 65 20 66 6f 75 72 74 68 20 70 61 72 61 6d  the fourth param
2c570 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33 5f  eter to sqlite3_
2c580 62 69 6e 64 5f 74 65 78 74 28 29 20 6f 72 20 73  bind_text() or s
2c590 71 6c 69 74 65 33 5f 62 69 6e 64 5f 74 65 78 74  qlite3_bind_text
2c5a0 31 36 28 29 0a 2a 2a 20 69 73 20 6e 65 67 61 74  16().** is negat
2c5b0 69 76 65 2c 20 74 68 65 6e 20 74 68 65 20 6c 65  ive, then the le
2c5c0 6e 67 74 68 20 6f 66 20 74 68 65 20 73 74 72 69  ngth of the stri
2c5d0 6e 67 20 69 73 0a 2a 2a 20 74 68 65 20 6e 75 6d  ng is.** the num
2c5e0 62 65 72 20 6f 66 20 62 79 74 65 73 20 75 70 20  ber of bytes up 
2c5f0 74 6f 20 74 68 65 20 66 69 72 73 74 20 7a 65 72  to the first zer
2c600 6f 20 74 65 72 6d 69 6e 61 74 6f 72 2e 0a 2a 2a  o terminator..**
2c610 20 49 66 20 74 68 65 20 66 6f 75 72 74 68 20 70   If the fourth p
2c620 61 72 61 6d 65 74 65 72 20 74 6f 20 73 71 6c 69  arameter to sqli
2c630 74 65 33 5f 62 69 6e 64 5f 62 6c 6f 62 28 29 20  te3_bind_blob() 
2c640 69 73 20 6e 65 67 61 74 69 76 65 2c 20 74 68 65  is negative, the
2c650 6e 0a 2a 2a 20 74 68 65 20 62 65 68 61 76 69 6f  n.** the behavio
2c660 72 20 69 73 20 75 6e 64 65 66 69 6e 65 64 2e 0a  r is undefined..
2c670 2a 2a 20 49 66 20 61 20 6e 6f 6e 2d 6e 65 67 61  ** If a non-nega
2c680 74 69 76 65 20 66 6f 75 72 74 68 20 70 61 72 61  tive fourth para
2c690 6d 65 74 65 72 20 69 73 20 70 72 6f 76 69 64 65  meter is provide
2c6a0 64 20 74 6f 20 73 71 6c 69 74 65 33 5f 62 69 6e  d to sqlite3_bin
2c6b0 64 5f 74 65 78 74 28 29 0a 2a 2a 20 6f 72 20 73  d_text().** or s
2c6c0 71 6c 69 74 65 33 5f 62 69 6e 64 5f 74 65 78 74  qlite3_bind_text
2c6d0 31 36 28 29 20 6f 72 20 73 71 6c 69 74 65 33 5f  16() or sqlite3_
2c6e0 62 69 6e 64 5f 74 65 78 74 36 34 28 29 20 74 68  bind_text64() th
2c6f0 65 6e 0a 2a 2a 20 74 68 61 74 20 70 61 72 61 6d  en.** that param
2c700 65 74 65 72 20 6d 75 73 74 20 62 65 20 74 68 65  eter must be the
2c710 20 62 79 74 65 20 6f 66 66 73 65 74 0a 2a 2a 20   byte offset.** 
2c720 77 68 65 72 65 20 74 68 65 20 4e 55 4c 20 74 65  where the NUL te
2c730 72 6d 69 6e 61 74 6f 72 20 77 6f 75 6c 64 20 6f  rminator would o
2c740 63 63 75 72 20 61 73 73 75 6d 69 6e 67 20 74 68  ccur assuming th
2c750 65 20 73 74 72 69 6e 67 20 77 65 72 65 20 4e 55  e string were NU
2c760 4c 0a 2a 2a 20 74 65 72 6d 69 6e 61 74 65 64 2e  L.** terminated.
2c770 20 20 49 66 20 61 6e 79 20 4e 55 4c 20 63 68 61    If any NUL cha
2c780 72 61 63 74 65 72 73 20 6f 63 63 75 72 20 61 74  racters occur at
2c790 20 62 79 74 65 20 6f 66 66 73 65 74 73 20 6c 65   byte offsets le
2c7a0 73 73 20 74 68 61 6e 20 0a 2a 2a 20 74 68 65 20  ss than .** the 
2c7b0 76 61 6c 75 65 20 6f 66 20 74 68 65 20 66 6f 75  value of the fou
2c7c0 72 74 68 20 70 61 72 61 6d 65 74 65 72 20 74 68  rth parameter th
2c7d0 65 6e 20 74 68 65 20 72 65 73 75 6c 74 69 6e 67  en the resulting
2c7e0 20 73 74 72 69 6e 67 20 76 61 6c 75 65 20 77 69   string value wi
2c7f0 6c 6c 0a 2a 2a 20 63 6f 6e 74 61 69 6e 20 65 6d  ll.** contain em
2c800 62 65 64 64 65 64 20 4e 55 4c 73 2e 20 20 54 68  bedded NULs.  Th
2c810 65 20 72 65 73 75 6c 74 20 6f 66 20 65 78 70 72  e result of expr
2c820 65 73 73 69 6f 6e 73 20 69 6e 76 6f 6c 76 69 6e  essions involvin
2c830 67 20 73 74 72 69 6e 67 73 0a 2a 2a 20 77 69 74  g strings.** wit
2c840 68 20 65 6d 62 65 64 64 65 64 20 4e 55 4c 73 20  h embedded NULs 
2c850 69 73 20 75 6e 64 65 66 69 6e 65 64 2e 0a 2a 2a  is undefined..**
2c860 0a 2a 2a 20 5e 54 68 65 20 66 69 66 74 68 20 61  .** ^The fifth a
2c870 72 67 75 6d 65 6e 74 20 74 6f 20 74 68 65 20 42  rgument to the B
2c880 4c 4f 42 20 61 6e 64 20 73 74 72 69 6e 67 20 62  LOB and string b
2c890 69 6e 64 69 6e 67 20 69 6e 74 65 72 66 61 63 65  inding interface
2c8a0 73 0a 2a 2a 20 69 73 20 61 20 64 65 73 74 72 75  s.** is a destru
2c8b0 63 74 6f 72 20 75 73 65 64 20 74 6f 20 64 69 73  ctor used to dis
2c8c0 70 6f 73 65 20 6f 66 20 74 68 65 20 42 4c 4f 42  pose of the BLOB
2c8d0 20 6f 72 0a 2a 2a 20 73 74 72 69 6e 67 20 61 66   or.** string af
2c8e0 74 65 72 20 53 51 4c 69 74 65 20 68 61 73 20 66  ter SQLite has f
2c8f0 69 6e 69 73 68 65 64 20 77 69 74 68 20 69 74 2e  inished with it.
2c900 20 20 5e 54 68 65 20 64 65 73 74 72 75 63 74 6f    ^The destructo
2c910 72 20 69 73 20 63 61 6c 6c 65 64 0a 2a 2a 20 74  r is called.** t
2c920 6f 20 64 69 73 70 6f 73 65 20 6f 66 20 74 68 65  o dispose of the
2c930 20 42 4c 4f 42 20 6f 72 20 73 74 72 69 6e 67 20   BLOB or string 
2c940 65 76 65 6e 20 69 66 20 74 68 65 20 63 61 6c 6c  even if the call
2c950 20 74 6f 20 62 69 6e 64 20 41 50 49 20 66 61 69   to bind API fai
2c960 6c 73 2e 0a 2a 2a 20 5e 49 66 20 74 68 65 20 66  ls..** ^If the f
2c970 69 66 74 68 20 61 72 67 75 6d 65 6e 74 20 69 73  ifth argument is
2c980 0a 2a 2a 20 74 68 65 20 73 70 65 63 69 61 6c 20  .** the special 
2c990 76 61 6c 75 65 20 5b 53 51 4c 49 54 45 5f 53 54  value [SQLITE_ST
2c9a0 41 54 49 43 5d 2c 20 74 68 65 6e 20 53 51 4c 69  ATIC], then SQLi
2c9b0 74 65 20 61 73 73 75 6d 65 73 20 74 68 61 74 20  te assumes that 
2c9c0 74 68 65 0a 2a 2a 20 69 6e 66 6f 72 6d 61 74 69  the.** informati
2c9d0 6f 6e 20 69 73 20 69 6e 20 73 74 61 74 69 63 2c  on is in static,
2c9e0 20 75 6e 6d 61 6e 61 67 65 64 20 73 70 61 63 65   unmanaged space
2c9f0 20 61 6e 64 20 64 6f 65 73 20 6e 6f 74 20 6e 65   and does not ne
2ca00 65 64 20 74 6f 20 62 65 20 66 72 65 65 64 2e 0a  ed to be freed..
2ca10 2a 2a 20 5e 49 66 20 74 68 65 20 66 69 66 74 68  ** ^If the fifth
2ca20 20 61 72 67 75 6d 65 6e 74 20 68 61 73 20 74 68   argument has th
2ca30 65 20 76 61 6c 75 65 20 5b 53 51 4c 49 54 45 5f  e value [SQLITE_
2ca40 54 52 41 4e 53 49 45 4e 54 5d 2c 20 74 68 65 6e  TRANSIENT], then
2ca50 0a 2a 2a 20 53 51 4c 69 74 65 20 6d 61 6b 65 73  .** SQLite makes
2ca60 20 69 74 73 20 6f 77 6e 20 70 72 69 76 61 74 65   its own private
2ca70 20 63 6f 70 79 20 6f 66 20 74 68 65 20 64 61 74   copy of the dat
2ca80 61 20 69 6d 6d 65 64 69 61 74 65 6c 79 2c 20 62  a immediately, b
2ca90 65 66 6f 72 65 0a 2a 2a 20 74 68 65 20 73 71 6c  efore.** the sql
2caa0 69 74 65 33 5f 62 69 6e 64 5f 2a 28 29 20 72 6f  ite3_bind_*() ro
2cab0 75 74 69 6e 65 20 72 65 74 75 72 6e 73 2e 0a 2a  utine returns..*
2cac0 2a 0a 2a 2a 20 5e 54 68 65 20 73 69 78 74 68 20  *.** ^The sixth 
2cad0 61 72 67 75 6d 65 6e 74 20 74 6f 20 73 71 6c 69  argument to sqli
2cae0 74 65 33 5f 62 69 6e 64 5f 74 65 78 74 36 34 28  te3_bind_text64(
2caf0 29 20 6d 75 73 74 20 62 65 20 6f 6e 65 20 6f 66  ) must be one of
2cb00 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 55 54 46 38  .** [SQLITE_UTF8
2cb10 5d 2c 20 5b 53 51 4c 49 54 45 5f 55 54 46 31 36  ], [SQLITE_UTF16
2cb20 5d 2c 20 5b 53 51 4c 49 54 45 5f 55 54 46 31 36  ], [SQLITE_UTF16
2cb30 42 45 5d 2c 20 6f 72 20 5b 53 51 4c 49 54 45 5f  BE], or [SQLITE_
2cb40 55 54 46 31 36 4c 45 5d 0a 2a 2a 20 74 6f 20 73  UTF16LE].** to s
2cb50 70 65 63 69 66 79 20 74 68 65 20 65 6e 63 6f 64  pecify the encod
2cb60 69 6e 67 20 6f 66 20 74 68 65 20 74 65 78 74 20  ing of the text 
2cb70 69 6e 20 74 68 65 20 74 68 69 72 64 20 70 61 72  in the third par
2cb80 61 6d 65 74 65 72 2e 20 20 49 66 0a 2a 2a 20 74  ameter.  If.** t
2cb90 68 65 20 73 69 78 74 68 20 61 72 67 75 6d 65 6e  he sixth argumen
2cba0 74 20 74 6f 20 73 71 6c 69 74 65 33 5f 62 69 6e  t to sqlite3_bin
2cbb0 64 5f 74 65 78 74 36 34 28 29 20 69 73 20 6e 6f  d_text64() is no
2cbc0 74 20 6f 6e 65 20 6f 66 20 74 68 65 0a 2a 2a 20  t one of the.** 
2cbd0 61 6c 6c 6f 77 65 64 20 76 61 6c 75 65 73 20 73  allowed values s
2cbe0 68 6f 77 6e 20 61 62 6f 76 65 2c 20 6f 72 20 69  hown above, or i
2cbf0 66 20 74 68 65 20 74 65 78 74 20 65 6e 63 6f 64  f the text encod
2cc00 69 6e 67 20 69 73 20 64 69 66 66 65 72 65 6e 74  ing is different
2cc10 0a 2a 2a 20 66 72 6f 6d 20 74 68 65 20 65 6e 63  .** from the enc
2cc20 6f 64 69 6e 67 20 73 70 65 63 69 66 69 65 64 20  oding specified 
2cc30 62 79 20 74 68 65 20 73 69 78 74 68 20 70 61 72  by the sixth par
2cc40 61 6d 65 74 65 72 2c 20 74 68 65 6e 20 74 68 65  ameter, then the
2cc50 20 62 65 68 61 76 69 6f 72 0a 2a 2a 20 69 73 20   behavior.** is 
2cc60 75 6e 64 65 66 69 6e 65 64 2e 0a 2a 2a 0a 2a 2a  undefined..**.**
2cc70 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 62 69   ^The sqlite3_bi
2cc80 6e 64 5f 7a 65 72 6f 62 6c 6f 62 28 29 20 72 6f  nd_zeroblob() ro
2cc90 75 74 69 6e 65 20 62 69 6e 64 73 20 61 20 42 4c  utine binds a BL
2cca0 4f 42 20 6f 66 20 6c 65 6e 67 74 68 20 4e 20 74  OB of length N t
2ccb0 68 61 74 0a 2a 2a 20 69 73 20 66 69 6c 6c 65 64  hat.** is filled
2ccc0 20 77 69 74 68 20 7a 65 72 6f 65 73 2e 20 20 5e   with zeroes.  ^
2ccd0 41 20 7a 65 72 6f 62 6c 6f 62 20 75 73 65 73 20  A zeroblob uses 
2cce0 61 20 66 69 78 65 64 20 61 6d 6f 75 6e 74 20 6f  a fixed amount o
2ccf0 66 20 6d 65 6d 6f 72 79 0a 2a 2a 20 28 6a 75 73  f memory.** (jus
2cd00 74 20 61 6e 20 69 6e 74 65 67 65 72 20 74 6f 20  t an integer to 
2cd10 68 6f 6c 64 20 69 74 73 20 73 69 7a 65 29 20 77  hold its size) w
2cd20 68 69 6c 65 20 69 74 20 69 73 20 62 65 69 6e 67  hile it is being
2cd30 20 70 72 6f 63 65 73 73 65 64 2e 0a 2a 2a 20 5a   processed..** Z
2cd40 65 72 6f 62 6c 6f 62 73 20 61 72 65 20 69 6e 74  eroblobs are int
2cd50 65 6e 64 65 64 20 74 6f 20 73 65 72 76 65 20 61  ended to serve a
2cd60 73 20 70 6c 61 63 65 68 6f 6c 64 65 72 73 20 66  s placeholders f
2cd70 6f 72 20 42 4c 4f 42 73 20 77 68 6f 73 65 0a 2a  or BLOBs whose.*
2cd80 2a 20 63 6f 6e 74 65 6e 74 20 69 73 20 6c 61 74  * content is lat
2cd90 65 72 20 77 72 69 74 74 65 6e 20 75 73 69 6e 67  er written using
2cda0 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 62 6c 6f  .** [sqlite3_blo
2cdb0 62 5f 6f 70 65 6e 20 7c 20 69 6e 63 72 65 6d 65  b_open | increme
2cdc0 6e 74 61 6c 20 42 4c 4f 42 20 49 2f 4f 5d 20 72  ntal BLOB I/O] r
2cdd0 6f 75 74 69 6e 65 73 2e 0a 2a 2a 20 5e 41 20 6e  outines..** ^A n
2cde0 65 67 61 74 69 76 65 20 76 61 6c 75 65 20 66 6f  egative value fo
2cdf0 72 20 74 68 65 20 7a 65 72 6f 62 6c 6f 62 20 72  r the zeroblob r
2ce00 65 73 75 6c 74 73 20 69 6e 20 61 20 7a 65 72 6f  esults in a zero
2ce10 2d 6c 65 6e 67 74 68 20 42 4c 4f 42 2e 0a 2a 2a  -length BLOB..**
2ce20 0a 2a 2a 20 5e 49 66 20 61 6e 79 20 6f 66 20 74  .** ^If any of t
2ce30 68 65 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f  he sqlite3_bind_
2ce40 2a 28 29 20 72 6f 75 74 69 6e 65 73 20 61 72 65  *() routines are
2ce50 20 63 61 6c 6c 65 64 20 77 69 74 68 20 61 20 4e   called with a N
2ce60 55 4c 4c 20 70 6f 69 6e 74 65 72 0a 2a 2a 20 66  ULL pointer.** f
2ce70 6f 72 20 74 68 65 20 5b 70 72 65 70 61 72 65 64  or the [prepared
2ce80 20 73 74 61 74 65 6d 65 6e 74 5d 20 6f 72 20 77   statement] or w
2ce90 69 74 68 20 61 20 70 72 65 70 61 72 65 64 20 73  ith a prepared s
2cea0 74 61 74 65 6d 65 6e 74 20 66 6f 72 20 77 68 69  tatement for whi
2ceb0 63 68 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 73  ch.** [sqlite3_s
2cec0 74 65 70 28 29 5d 20 68 61 73 20 62 65 65 6e 20  tep()] has been 
2ced0 63 61 6c 6c 65 64 20 6d 6f 72 65 20 72 65 63 65  called more rece
2cee0 6e 74 6c 79 20 74 68 61 6e 20 5b 73 71 6c 69 74  ntly than [sqlit
2cef0 65 33 5f 72 65 73 65 74 28 29 5d 2c 0a 2a 2a 20  e3_reset()],.** 
2cf00 74 68 65 6e 20 74 68 65 20 63 61 6c 6c 20 77 69  then the call wi
2cf10 6c 6c 20 72 65 74 75 72 6e 20 5b 53 51 4c 49 54  ll return [SQLIT
2cf20 45 5f 4d 49 53 55 53 45 5d 2e 20 20 49 66 20 61  E_MISUSE].  If a
2cf30 6e 79 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f  ny sqlite3_bind_
2cf40 28 29 0a 2a 2a 20 72 6f 75 74 69 6e 65 20 69 73  ().** routine is
2cf50 20 70 61 73 73 65 64 20 61 20 5b 70 72 65 70 61   passed a [prepa
2cf60 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 74  red statement] t
2cf70 68 61 74 20 68 61 73 20 62 65 65 6e 20 66 69 6e  hat has been fin
2cf80 61 6c 69 7a 65 64 2c 20 74 68 65 0a 2a 2a 20 72  alized, the.** r
2cf90 65 73 75 6c 74 20 69 73 20 75 6e 64 65 66 69 6e  esult is undefin
2cfa0 65 64 20 61 6e 64 20 70 72 6f 62 61 62 6c 79 20  ed and probably 
2cfb0 68 61 72 6d 66 75 6c 2e 0a 2a 2a 0a 2a 2a 20 5e  harmful..**.** ^
2cfc0 42 69 6e 64 69 6e 67 73 20 61 72 65 20 6e 6f 74  Bindings are not
2cfd0 20 63 6c 65 61 72 65 64 20 62 79 20 74 68 65 20   cleared by the 
2cfe0 5b 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29  [sqlite3_reset()
2cff0 5d 20 72 6f 75 74 69 6e 65 2e 0a 2a 2a 20 5e 55  ] routine..** ^U
2d000 6e 62 6f 75 6e 64 20 70 61 72 61 6d 65 74 65 72  nbound parameter
2d010 73 20 61 72 65 20 69 6e 74 65 72 70 72 65 74 65  s are interprete
2d020 64 20 61 73 20 4e 55 4c 4c 2e 0a 2a 2a 0a 2a 2a  d as NULL..**.**
2d030 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 62 69   ^The sqlite3_bi
2d040 6e 64 5f 2a 20 72 6f 75 74 69 6e 65 73 20 72 65  nd_* routines re
2d050 74 75 72 6e 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d  turn [SQLITE_OK]
2d060 20 6f 6e 20 73 75 63 63 65 73 73 20 6f 72 20 61   on success or a
2d070 6e 0a 2a 2a 20 5b 65 72 72 6f 72 20 63 6f 64 65  n.** [error code
2d080 5d 20 69 66 20 61 6e 79 74 68 69 6e 67 20 67 6f  ] if anything go
2d090 65 73 20 77 72 6f 6e 67 2e 0a 2a 2a 20 5e 5b 53  es wrong..** ^[S
2d0a0 51 4c 49 54 45 5f 54 4f 4f 42 49 47 5d 20 6d 69  QLITE_TOOBIG] mi
2d0b0 67 68 74 20 62 65 20 72 65 74 75 72 6e 65 64 20  ght be returned 
2d0c0 69 66 20 74 68 65 20 73 69 7a 65 20 6f 66 20 61  if the size of a
2d0d0 20 73 74 72 69 6e 67 20 6f 72 20 42 4c 4f 42 0a   string or BLOB.
2d0e0 2a 2a 20 65 78 63 65 65 64 73 20 6c 69 6d 69 74  ** exceeds limit
2d0f0 73 20 69 6d 70 6f 73 65 64 20 62 79 20 5b 73 71  s imposed by [sq
2d100 6c 69 74 65 33 5f 6c 69 6d 69 74 5d 28 5b 53 51  lite3_limit]([SQ
2d110 4c 49 54 45 5f 4c 49 4d 49 54 5f 4c 45 4e 47 54  LITE_LIMIT_LENGT
2d120 48 5d 29 20 6f 72 0a 2a 2a 20 5b 53 51 4c 49 54  H]) or.** [SQLIT
2d130 45 5f 4d 41 58 5f 4c 45 4e 47 54 48 5d 2e 0a 2a  E_MAX_LENGTH]..*
2d140 2a 20 5e 5b 53 51 4c 49 54 45 5f 52 41 4e 47 45  * ^[SQLITE_RANGE
2d150 5d 20 69 73 20 72 65 74 75 72 6e 65 64 20 69 66  ] is returned if
2d160 20 74 68 65 20 70 61 72 61 6d 65 74 65 72 0a 2a   the parameter.*
2d170 2a 20 69 6e 64 65 78 20 69 73 20 6f 75 74 20 6f  * index is out o
2d180 66 20 72 61 6e 67 65 2e 20 20 5e 5b 53 51 4c 49  f range.  ^[SQLI
2d190 54 45 5f 4e 4f 4d 45 4d 5d 20 69 73 20 72 65 74  TE_NOMEM] is ret
2d1a0 75 72 6e 65 64 20 69 66 20 6d 61 6c 6c 6f 63 28  urned if malloc(
2d1b0 29 20 66 61 69 6c 73 2e 0a 2a 2a 0a 2a 2a 20 53  ) fails..**.** S
2d1c0 65 65 20 61 6c 73 6f 3a 20 5b 73 71 6c 69 74 65  ee also: [sqlite
2d1d0 33 5f 62 69 6e 64 5f 70 61 72 61 6d 65 74 65 72  3_bind_parameter
2d1e0 5f 63 6f 75 6e 74 28 29 5d 2c 0a 2a 2a 20 5b 73  _count()],.** [s
2d1f0 71 6c 69 74 65 33 5f 62 69 6e 64 5f 70 61 72 61  qlite3_bind_para
2d200 6d 65 74 65 72 5f 6e 61 6d 65 28 29 5d 2c 20 61  meter_name()], a
2d210 6e 64 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64  nd [sqlite3_bind
2d220 5f 70 61 72 61 6d 65 74 65 72 5f 69 6e 64 65 78  _parameter_index
2d230 28 29 5d 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69  ()]..*/.int sqli
2d240 74 65 33 5f 62 69 6e 64 5f 62 6c 6f 62 28 73 71  te3_bind_blob(sq
2d250 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74  lite3_stmt*, int
2d260 2c 20 63 6f 6e 73 74 20 76 6f 69 64 2a 2c 20 69  , const void*, i
2d270 6e 74 20 6e 2c 20 76 6f 69 64 28 2a 29 28 76 6f  nt n, void(*)(vo
2d280 69 64 2a 29 29 3b 0a 69 6e 74 20 73 71 6c 69 74  id*));.int sqlit
2d290 65 33 5f 62 69 6e 64 5f 62 6c 6f 62 36 34 28 73  e3_bind_blob64(s
2d2a0 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e  qlite3_stmt*, in
2d2b0 74 2c 20 63 6f 6e 73 74 20 76 6f 69 64 2a 2c 20  t, const void*, 
2d2c0 73 71 6c 69 74 65 33 5f 75 69 6e 74 36 34 2c 0a  sqlite3_uint64,.
2d2d0 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
2d2e0 20 20 20 20 20 20 20 20 76 6f 69 64 28 2a 29 28          void(*)(
2d2f0 76 6f 69 64 2a 29 29 3b 0a 69 6e 74 20 73 71 6c  void*));.int sql
2d300 69 74 65 33 5f 62 69 6e 64 5f 64 6f 75 62 6c 65  ite3_bind_double
2d310 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20  (sqlite3_stmt*, 
2d320 69 6e 74 2c 20 64 6f 75 62 6c 65 29 3b 0a 69 6e  int, double);.in
2d330 74 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 69  t sqlite3_bind_i
2d340 6e 74 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a  nt(sqlite3_stmt*
2d350 2c 20 69 6e 74 2c 20 69 6e 74 29 3b 0a 69 6e 74  , int, int);.int
2d360 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 69 6e   sqlite3_bind_in
2d370 74 36 34 28 73 71 6c 69 74 65 33 5f 73 74 6d 74  t64(sqlite3_stmt
2d380 2a 2c 20 69 6e 74 2c 20 73 71 6c 69 74 65 33 5f  *, int, sqlite3_
2d390 69 6e 74 36 34 29 3b 0a 69 6e 74 20 73 71 6c 69  int64);.int sqli
2d3a0 74 65 33 5f 62 69 6e 64 5f 6e 75 6c 6c 28 73 71  te3_bind_null(sq
2d3b0 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74  lite3_stmt*, int
2d3c0 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 62  );.int sqlite3_b
2d3d0 69 6e 64 5f 74 65 78 74 28 73 71 6c 69 74 65 33  ind_text(sqlite3
2d3e0 5f 73 74 6d 74 2a 2c 69 6e 74 2c 63 6f 6e 73 74  _stmt*,int,const
2d3f0 20 63 68 61 72 2a 2c 69 6e 74 2c 76 6f 69 64 28   char*,int,void(
2d400 2a 29 28 76 6f 69 64 2a 29 29 3b 0a 69 6e 74 20  *)(void*));.int 
2d410 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 74 65 78  sqlite3_bind_tex
2d420 74 31 36 28 73 71 6c 69 74 65 33 5f 73 74 6d 74  t16(sqlite3_stmt
2d430 2a 2c 20 69 6e 74 2c 20 63 6f 6e 73 74 20 76 6f  *, int, const vo
2d440 69 64 2a 2c 20 69 6e 74 2c 20 76 6f 69 64 28 2a  id*, int, void(*
2d450 29 28 76 6f 69 64 2a 29 29 3b 0a 69 6e 74 20 73  )(void*));.int s
2d460 71 6c 69 74 65 33 5f 62 69 6e 64 5f 74 65 78 74  qlite3_bind_text
2d470 36 34 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a  64(sqlite3_stmt*
2d480 2c 20 69 6e 74 2c 20 63 6f 6e 73 74 20 63 68 61  , int, const cha
2d490 72 2a 2c 20 73 71 6c 69 74 65 33 5f 75 69 6e 74  r*, sqlite3_uint
2d4a0 36 34 2c 0a 20 20 20 20 20 20 20 20 20 20 20 20  64,.            
2d4b0 20 20 20 20 20 20 20 20 20 20 20 20 20 76 6f 69               voi
2d4c0 64 28 2a 29 28 76 6f 69 64 2a 29 2c 20 75 6e 73  d(*)(void*), uns
2d4d0 69 67 6e 65 64 20 63 68 61 72 20 65 6e 63 6f 64  igned char encod
2d4e0 69 6e 67 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  ing);.int sqlite
2d4f0 33 5f 62 69 6e 64 5f 76 61 6c 75 65 28 73 71 6c  3_bind_value(sql
2d500 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 2c  ite3_stmt*, int,
2d510 20 63 6f 6e 73 74 20 73 71 6c 69 74 65 33 5f 76   const sqlite3_v
2d520 61 6c 75 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69  alue*);.int sqli
2d530 74 65 33 5f 62 69 6e 64 5f 7a 65 72 6f 62 6c 6f  te3_bind_zeroblo
2d540 62 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c  b(sqlite3_stmt*,
2d550 20 69 6e 74 2c 20 69 6e 74 20 6e 29 3b 0a 69 6e   int, int n);.in
2d560 74 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 7a  t sqlite3_bind_z
2d570 65 72 6f 62 6c 6f 62 36 34 28 73 71 6c 69 74 65  eroblob64(sqlite
2d580 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 2c 20 73 71  3_stmt*, int, sq
2d590 6c 69 74 65 33 5f 75 69 6e 74 36 34 29 3b 0a 0a  lite3_uint64);..
2d5a0 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20  /*.** CAPI3REF: 
2d5b0 4e 75 6d 62 65 72 20 4f 66 20 53 51 4c 20 50 61  Number Of SQL Pa
2d5c0 72 61 6d 65 74 65 72 73 0a 2a 2a 20 4d 45 54 48  rameters.** METH
2d5d0 4f 44 3a 20 73 71 6c 69 74 65 33 5f 73 74 6d 74  OD: sqlite3_stmt
2d5e0 0a 2a 2a 0a 2a 2a 20 5e 54 68 69 73 20 72 6f 75  .**.** ^This rou
2d5f0 74 69 6e 65 20 63 61 6e 20 62 65 20 75 73 65 64  tine can be used
2d600 20 74 6f 20 66 69 6e 64 20 74 68 65 20 6e 75 6d   to find the num
2d610 62 65 72 20 6f 66 20 5b 53 51 4c 20 70 61 72 61  ber of [SQL para
2d620 6d 65 74 65 72 73 5d 0a 2a 2a 20 69 6e 20 61 20  meters].** in a 
2d630 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d  [prepared statem
2d640 65 6e 74 5d 2e 20 20 53 51 4c 20 70 61 72 61 6d  ent].  SQL param
2d650 65 74 65 72 73 20 61 72 65 20 74 6f 6b 65 6e 73  eters are tokens
2d660 20 6f 66 20 74 68 65 0a 2a 2a 20 66 6f 72 6d 20   of the.** form 
2d670 22 3f 22 2c 20 22 3f 4e 4e 4e 22 2c 20 22 3a 41  "?", "?NNN", ":A
2d680 41 41 22 2c 20 22 24 41 41 41 22 2c 20 6f 72 20  AA", "$AAA", or 
2d690 22 40 41 41 41 22 20 74 68 61 74 20 73 65 72 76  "@AAA" that serv
2d6a0 65 20 61 73 0a 2a 2a 20 70 6c 61 63 65 68 6f 6c  e as.** placehol
2d6b0 64 65 72 73 20 66 6f 72 20 76 61 6c 75 65 73 20  ders for values 
2d6c0 74 68 61 74 20 61 72 65 20 5b 73 71 6c 69 74 65  that are [sqlite
2d6d0 33 5f 62 69 6e 64 5f 62 6c 6f 62 20 7c 20 62 6f  3_bind_blob | bo
2d6e0 75 6e 64 5d 0a 2a 2a 20 74 6f 20 74 68 65 20 70  und].** to the p
2d6f0 61 72 61 6d 65 74 65 72 73 20 61 74 20 61 20 6c  arameters at a l
2d700 61 74 65 72 20 74 69 6d 65 2e 0a 2a 2a 0a 2a 2a  ater time..**.**
2d710 20 5e 28 54 68 69 73 20 72 6f 75 74 69 6e 65 20   ^(This routine 
2d720 61 63 74 75 61 6c 6c 79 20 72 65 74 75 72 6e 73  actually returns
2d730 20 74 68 65 20 69 6e 64 65 78 20 6f 66 20 74 68   the index of th
2d740 65 20 6c 61 72 67 65 73 74 20 28 72 69 67 68 74  e largest (right
2d750 6d 6f 73 74 29 0a 2a 2a 20 70 61 72 61 6d 65 74  most).** paramet
2d760 65 72 2e 20 46 6f 72 20 61 6c 6c 20 66 6f 72 6d  er. For all form
2d770 73 20 65 78 63 65 70 74 20 3f 4e 4e 4e 2c 20 74  s except ?NNN, t
2d780 68 69 73 20 77 69 6c 6c 20 63 6f 72 72 65 73 70  his will corresp
2d790 6f 6e 64 20 74 6f 20 74 68 65 0a 2a 2a 20 6e 75  ond to the.** nu
2d7a0 6d 62 65 72 20 6f 66 20 75 6e 69 71 75 65 20 70  mber of unique p
2d7b0 61 72 61 6d 65 74 65 72 73 2e 20 20 49 66 20 70  arameters.  If p
2d7c0 61 72 61 6d 65 74 65 72 73 20 6f 66 20 74 68 65  arameters of the
2d7d0 20 3f 4e 4e 4e 20 66 6f 72 6d 20 61 72 65 20 75   ?NNN form are u
2d7e0 73 65 64 2c 0a 2a 2a 20 74 68 65 72 65 20 6d 61  sed,.** there ma
2d7f0 79 20 62 65 20 67 61 70 73 20 69 6e 20 74 68 65  y be gaps in the
2d800 20 6c 69 73 74 2e 29 5e 0a 2a 2a 0a 2a 2a 20 53   list.)^.**.** S
2d810 65 65 20 61 6c 73 6f 3a 20 5b 73 71 6c 69 74 65  ee also: [sqlite
2d820 33 5f 62 69 6e 64 5f 62 6c 6f 62 7c 73 71 6c 69  3_bind_blob|sqli
2d830 74 65 33 5f 62 69 6e 64 28 29 5d 2c 0a 2a 2a 20  te3_bind()],.** 
2d840 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 70 61  [sqlite3_bind_pa
2d850 72 61 6d 65 74 65 72 5f 6e 61 6d 65 28 29 5d 2c  rameter_name()],
2d860 20 61 6e 64 0a 2a 2a 20 5b 73 71 6c 69 74 65 33   and.** [sqlite3
2d870 5f 62 69 6e 64 5f 70 61 72 61 6d 65 74 65 72 5f  _bind_parameter_
2d880 69 6e 64 65 78 28 29 5d 2e 0a 2a 2f 0a 69 6e 74  index()]..*/.int
2d890 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 70 61   sqlite3_bind_pa
2d8a0 72 61 6d 65 74 65 72 5f 63 6f 75 6e 74 28 73 71  rameter_count(sq
2d8b0 6c 69 74 65 33 5f 73 74 6d 74 2a 29 3b 0a 0a 2f  lite3_stmt*);../
2d8c0 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 4e  *.** CAPI3REF: N
2d8d0 61 6d 65 20 4f 66 20 41 20 48 6f 73 74 20 50 61  ame Of A Host Pa
2d8e0 72 61 6d 65 74 65 72 0a 2a 2a 20 4d 45 54 48 4f  rameter.** METHO
2d8f0 44 3a 20 73 71 6c 69 74 65 33 5f 73 74 6d 74 0a  D: sqlite3_stmt.
2d900 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74  **.** ^The sqlit
2d910 65 33 5f 62 69 6e 64 5f 70 61 72 61 6d 65 74 65  e3_bind_paramete
2d920 72 5f 6e 61 6d 65 28 50 2c 4e 29 20 69 6e 74 65  r_name(P,N) inte
2d930 72 66 61 63 65 20 72 65 74 75 72 6e 73 0a 2a 2a  rface returns.**
2d940 20 74 68 65 20 6e 61 6d 65 20 6f 66 20 74 68 65   the name of the
2d950 20 4e 2d 74 68 20 5b 53 51 4c 20 70 61 72 61 6d   N-th [SQL param
2d960 65 74 65 72 5d 20 69 6e 20 74 68 65 20 5b 70 72  eter] in the [pr
2d970 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
2d980 5d 20 50 2e 0a 2a 2a 20 5e 28 53 51 4c 20 70 61  ] P..** ^(SQL pa
2d990 72 61 6d 65 74 65 72 73 20 6f 66 20 74 68 65 20  rameters of the 
2d9a0 66 6f 72 6d 20 22 3f 4e 4e 4e 22 20 6f 72 20 22  form "?NNN" or "
2d9b0 3a 41 41 41 22 20 6f 72 20 22 40 41 41 41 22 20  :AAA" or "@AAA" 
2d9c0 6f 72 20 22 24 41 41 41 22 0a 2a 2a 20 68 61 76  or "$AAA".** hav
2d9d0 65 20 61 20 6e 61 6d 65 20 77 68 69 63 68 20 69  e a name which i
2d9e0 73 20 74 68 65 20 73 74 72 69 6e 67 20 22 3f 4e  s the string "?N
2d9f0 4e 4e 22 20 6f 72 20 22 3a 41 41 41 22 20 6f 72  NN" or ":AAA" or
2da00 20 22 40 41 41 41 22 20 6f 72 20 22 24 41 41 41   "@AAA" or "$AAA
2da10 22 0a 2a 2a 20 72 65 73 70 65 63 74 69 76 65 6c  ".** respectivel
2da20 79 2e 0a 2a 2a 20 49 6e 20 6f 74 68 65 72 20 77  y..** In other w
2da30 6f 72 64 73 2c 20 74 68 65 20 69 6e 69 74 69 61  ords, the initia
2da40 6c 20 22 3a 22 20 6f 72 20 22 24 22 20 6f 72 20  l ":" or "$" or 
2da50 22 40 22 20 6f 72 20 22 3f 22 0a 2a 2a 20 69 73  "@" or "?".** is
2da60 20 69 6e 63 6c 75 64 65 64 20 61 73 20 70 61 72   included as par
2da70 74 20 6f 66 20 74 68 65 20 6e 61 6d 65 2e 29 5e  t of the name.)^
2da80 0a 2a 2a 20 5e 50 61 72 61 6d 65 74 65 72 73 20  .** ^Parameters 
2da90 6f 66 20 74 68 65 20 66 6f 72 6d 20 22 3f 22 20  of the form "?" 
2daa0 77 69 74 68 6f 75 74 20 61 20 66 6f 6c 6c 6f 77  without a follow
2dab0 69 6e 67 20 69 6e 74 65 67 65 72 20 68 61 76 65  ing integer have
2dac0 20 6e 6f 20 6e 61 6d 65 0a 2a 2a 20 61 6e 64 20   no name.** and 
2dad0 61 72 65 20 72 65 66 65 72 72 65 64 20 74 6f 20  are referred to 
2dae0 61 73 20 22 6e 61 6d 65 6c 65 73 73 22 20 6f 72  as "nameless" or
2daf0 20 22 61 6e 6f 6e 79 6d 6f 75 73 20 70 61 72 61   "anonymous para
2db00 6d 65 74 65 72 73 22 2e 0a 2a 2a 0a 2a 2a 20 5e  meters"..**.** ^
2db10 54 68 65 20 66 69 72 73 74 20 68 6f 73 74 20 70  The first host p
2db20 61 72 61 6d 65 74 65 72 20 68 61 73 20 61 6e 20  arameter has an 
2db30 69 6e 64 65 78 20 6f 66 20 31 2c 20 6e 6f 74 20  index of 1, not 
2db40 30 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65  0..**.** ^If the
2db50 20 76 61 6c 75 65 20 4e 20 69 73 20 6f 75 74 20   value N is out 
2db60 6f 66 20 72 61 6e 67 65 20 6f 72 20 69 66 20 74  of range or if t
2db70 68 65 20 4e 2d 74 68 20 70 61 72 61 6d 65 74 65  he N-th paramete
2db80 72 20 69 73 0a 2a 2a 20 6e 61 6d 65 6c 65 73 73  r is.** nameless
2db90 2c 20 74 68 65 6e 20 4e 55 4c 4c 20 69 73 20 72  , then NULL is r
2dba0 65 74 75 72 6e 65 64 2e 20 20 5e 54 68 65 20 72  eturned.  ^The r
2dbb0 65 74 75 72 6e 65 64 20 73 74 72 69 6e 67 20 69  eturned string i
2dbc0 73 0a 2a 2a 20 61 6c 77 61 79 73 20 69 6e 20 55  s.** always in U
2dbd0 54 46 2d 38 20 65 6e 63 6f 64 69 6e 67 20 65 76  TF-8 encoding ev
2dbe0 65 6e 20 69 66 20 74 68 65 20 6e 61 6d 65 64 20  en if the named 
2dbf0 70 61 72 61 6d 65 74 65 72 20 77 61 73 0a 2a 2a  parameter was.**
2dc00 20 6f 72 69 67 69 6e 61 6c 6c 79 20 73 70 65 63   originally spec
2dc10 69 66 69 65 64 20 61 73 20 55 54 46 2d 31 36 20  ified as UTF-16 
2dc20 69 6e 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70  in [sqlite3_prep
2dc30 61 72 65 31 36 28 29 5d 20 6f 72 0a 2a 2a 20 5b  are16()] or.** [
2dc40 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 31  sqlite3_prepare1
2dc50 36 5f 76 32 28 29 5d 2e 0a 2a 2a 0a 2a 2a 20 53  6_v2()]..**.** S
2dc60 65 65 20 61 6c 73 6f 3a 20 5b 73 71 6c 69 74 65  ee also: [sqlite
2dc70 33 5f 62 69 6e 64 5f 62 6c 6f 62 7c 73 71 6c 69  3_bind_blob|sqli
2dc80 74 65 33 5f 62 69 6e 64 28 29 5d 2c 0a 2a 2a 20  te3_bind()],.** 
2dc90 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 70 61  [sqlite3_bind_pa
2dca0 72 61 6d 65 74 65 72 5f 63 6f 75 6e 74 28 29 5d  rameter_count()]
2dcb0 2c 20 61 6e 64 0a 2a 2a 20 5b 73 71 6c 69 74 65  , and.** [sqlite
2dcc0 33 5f 62 69 6e 64 5f 70 61 72 61 6d 65 74 65 72  3_bind_parameter
2dcd0 5f 69 6e 64 65 78 28 29 5d 2e 0a 2a 2f 0a 63 6f  _index()]..*/.co
2dce0 6e 73 74 20 63 68 61 72 20 2a 73 71 6c 69 74 65  nst char *sqlite
2dcf0 33 5f 62 69 6e 64 5f 70 61 72 61 6d 65 74 65 72  3_bind_parameter
2dd00 5f 6e 61 6d 65 28 73 71 6c 69 74 65 33 5f 73 74  _name(sqlite3_st
2dd10 6d 74 2a 2c 20 69 6e 74 29 3b 0a 0a 2f 2a 0a 2a  mt*, int);../*.*
2dd20 2a 20 43 41 50 49 33 52 45 46 3a 20 49 6e 64 65  * CAPI3REF: Inde
2dd30 78 20 4f 66 20 41 20 50 61 72 61 6d 65 74 65 72  x Of A Parameter
2dd40 20 57 69 74 68 20 41 20 47 69 76 65 6e 20 4e 61   With A Given Na
2dd50 6d 65 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71  me.** METHOD: sq
2dd60 6c 69 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a  lite3_stmt.**.**
2dd70 20 5e 52 65 74 75 72 6e 20 74 68 65 20 69 6e 64   ^Return the ind
2dd80 65 78 20 6f 66 20 61 6e 20 53 51 4c 20 70 61 72  ex of an SQL par
2dd90 61 6d 65 74 65 72 20 67 69 76 65 6e 20 69 74 73  ameter given its
2dda0 20 6e 61 6d 65 2e 20 20 5e 54 68 65 0a 2a 2a 20   name.  ^The.** 
2ddb0 69 6e 64 65 78 20 76 61 6c 75 65 20 72 65 74 75  index value retu
2ddc0 72 6e 65 64 20 69 73 20 73 75 69 74 61 62 6c 65  rned is suitable
2ddd0 20 66 6f 72 20 75 73 65 20 61 73 20 74 68 65 20   for use as the 
2dde0 73 65 63 6f 6e 64 0a 2a 2a 20 70 61 72 61 6d 65  second.** parame
2ddf0 74 65 72 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f  ter to [sqlite3_
2de00 62 69 6e 64 5f 62 6c 6f 62 7c 73 71 6c 69 74 65  bind_blob|sqlite
2de10 33 5f 62 69 6e 64 28 29 5d 2e 20 20 5e 41 20 7a  3_bind()].  ^A z
2de20 65 72 6f 0a 2a 2a 20 69 73 20 72 65 74 75 72 6e  ero.** is return
2de30 65 64 20 69 66 20 6e 6f 20 6d 61 74 63 68 69 6e  ed if no matchin
2de40 67 20 70 61 72 61 6d 65 74 65 72 20 69 73 20 66  g parameter is f
2de50 6f 75 6e 64 2e 20 20 5e 54 68 65 20 70 61 72 61  ound.  ^The para
2de60 6d 65 74 65 72 0a 2a 2a 20 6e 61 6d 65 20 6d 75  meter.** name mu
2de70 73 74 20 62 65 20 67 69 76 65 6e 20 69 6e 20 55  st be given in U
2de80 54 46 2d 38 20 65 76 65 6e 20 69 66 20 74 68 65  TF-8 even if the
2de90 20 6f 72 69 67 69 6e 61 6c 20 73 74 61 74 65 6d   original statem
2dea0 65 6e 74 0a 2a 2a 20 77 61 73 20 70 72 65 70 61  ent.** was prepa
2deb0 72 65 64 20 66 72 6f 6d 20 55 54 46 2d 31 36 20  red from UTF-16 
2dec0 74 65 78 74 20 75 73 69 6e 67 20 5b 73 71 6c 69  text using [sqli
2ded0 74 65 33 5f 70 72 65 70 61 72 65 31 36 5f 76 32  te3_prepare16_v2
2dee0 28 29 5d 2e 0a 2a 2a 0a 2a 2a 20 53 65 65 20 61  ()]..**.** See a
2def0 6c 73 6f 3a 20 5b 73 71 6c 69 74 65 33 5f 62 69  lso: [sqlite3_bi
2df00 6e 64 5f 62 6c 6f 62 7c 73 71 6c 69 74 65 33 5f  nd_blob|sqlite3_
2df10 62 69 6e 64 28 29 5d 2c 0a 2a 2a 20 5b 73 71 6c  bind()],.** [sql
2df20 69 74 65 33 5f 62 69 6e 64 5f 70 61 72 61 6d 65  ite3_bind_parame
2df30 74 65 72 5f 63 6f 75 6e 74 28 29 5d 2c 20 61 6e  ter_count()], an
2df40 64 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 62 69  d.** [sqlite3_bi
2df50 6e 64 5f 70 61 72 61 6d 65 74 65 72 5f 6e 61 6d  nd_parameter_nam
2df60 65 28 29 5d 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c  e()]..*/.int sql
2df70 69 74 65 33 5f 62 69 6e 64 5f 70 61 72 61 6d 65  ite3_bind_parame
2df80 74 65 72 5f 69 6e 64 65 78 28 73 71 6c 69 74 65  ter_index(sqlite
2df90 33 5f 73 74 6d 74 2a 2c 20 63 6f 6e 73 74 20 63  3_stmt*, const c
2dfa0 68 61 72 20 2a 7a 4e 61 6d 65 29 3b 0a 0a 2f 2a  har *zName);../*
2dfb0 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 52 65  .** CAPI3REF: Re
2dfc0 73 65 74 20 41 6c 6c 20 42 69 6e 64 69 6e 67 73  set All Bindings
2dfd0 20 4f 6e 20 41 20 50 72 65 70 61 72 65 64 20 53   On A Prepared S
2dfe0 74 61 74 65 6d 65 6e 74 0a 2a 2a 20 4d 45 54 48  tatement.** METH
2dff0 4f 44 3a 20 73 71 6c 69 74 65 33 5f 73 74 6d 74  OD: sqlite3_stmt
2e000 0a 2a 2a 0a 2a 2a 20 5e 43 6f 6e 74 72 61 72 79  .**.** ^Contrary
2e010 20 74 6f 20 74 68 65 20 69 6e 74 75 69 74 69 6f   to the intuitio
2e020 6e 20 6f 66 20 6d 61 6e 79 2c 20 5b 73 71 6c 69  n of many, [sqli
2e030 74 65 33 5f 72 65 73 65 74 28 29 5d 20 64 6f 65  te3_reset()] doe
2e040 73 20 6e 6f 74 20 72 65 73 65 74 0a 2a 2a 20 74  s not reset.** t
2e050 68 65 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64  he [sqlite3_bind
2e060 5f 62 6c 6f 62 20 7c 20 62 69 6e 64 69 6e 67 73  _blob | bindings
2e070 5d 20 6f 6e 20 61 20 5b 70 72 65 70 61 72 65 64  ] on a [prepared
2e080 20 73 74 61 74 65 6d 65 6e 74 5d 2e 0a 2a 2a 20   statement]..** 
2e090 5e 55 73 65 20 74 68 69 73 20 72 6f 75 74 69 6e  ^Use this routin
2e0a0 65 20 74 6f 20 72 65 73 65 74 20 61 6c 6c 20 68  e to reset all h
2e0b0 6f 73 74 20 70 61 72 61 6d 65 74 65 72 73 20 74  ost parameters t
2e0c0 6f 20 4e 55 4c 4c 2e 0a 2a 2f 0a 69 6e 74 20 73  o NULL..*/.int s
2e0d0 71 6c 69 74 65 33 5f 63 6c 65 61 72 5f 62 69 6e  qlite3_clear_bin
2e0e0 64 69 6e 67 73 28 73 71 6c 69 74 65 33 5f 73 74  dings(sqlite3_st
2e0f0 6d 74 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50  mt*);../*.** CAP
2e100 49 33 52 45 46 3a 20 4e 75 6d 62 65 72 20 4f 66  I3REF: Number Of
2e110 20 43 6f 6c 75 6d 6e 73 20 49 6e 20 41 20 52 65   Columns In A Re
2e120 73 75 6c 74 20 53 65 74 0a 2a 2a 20 4d 45 54 48  sult Set.** METH
2e130 4f 44 3a 20 73 71 6c 69 74 65 33 5f 73 74 6d 74  OD: sqlite3_stmt
2e140 0a 2a 2a 0a 2a 2a 20 5e 52 65 74 75 72 6e 20 74  .**.** ^Return t
2e150 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 63 6f 6c  he number of col
2e160 75 6d 6e 73 20 69 6e 20 74 68 65 20 72 65 73 75  umns in the resu
2e170 6c 74 20 73 65 74 20 72 65 74 75 72 6e 65 64 20  lt set returned 
2e180 62 79 20 74 68 65 0a 2a 2a 20 5b 70 72 65 70 61  by the.** [prepa
2e190 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 2e 20  red statement]. 
2e1a0 5e 54 68 69 73 20 72 6f 75 74 69 6e 65 20 72 65  ^This routine re
2e1b0 74 75 72 6e 73 20 30 20 69 66 20 70 53 74 6d 74  turns 0 if pStmt
2e1c0 20 69 73 20 61 6e 20 53 51 4c 0a 2a 2a 20 73 74   is an SQL.** st
2e1d0 61 74 65 6d 65 6e 74 20 74 68 61 74 20 64 6f 65  atement that doe
2e1e0 73 20 6e 6f 74 20 72 65 74 75 72 6e 20 64 61 74  s not return dat
2e1f0 61 20 28 66 6f 72 20 65 78 61 6d 70 6c 65 20 61  a (for example a
2e200 6e 20 5b 55 50 44 41 54 45 5d 29 2e 0a 2a 2a 0a  n [UPDATE])..**.
2e210 2a 2a 20 53 65 65 20 61 6c 73 6f 3a 20 5b 73 71  ** See also: [sq
2e220 6c 69 74 65 33 5f 64 61 74 61 5f 63 6f 75 6e 74  lite3_data_count
2e230 28 29 5d 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74  ()].*/.int sqlit
2e240 65 33 5f 63 6f 6c 75 6d 6e 5f 63 6f 75 6e 74 28  e3_column_count(
2e250 73 71 6c 69 74 65 33 5f 73 74 6d 74 20 2a 70 53  sqlite3_stmt *pS
2e260 74 6d 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50  tmt);../*.** CAP
2e270 49 33 52 45 46 3a 20 43 6f 6c 75 6d 6e 20 4e 61  I3REF: Column Na
2e280 6d 65 73 20 49 6e 20 41 20 52 65 73 75 6c 74 20  mes In A Result 
2e290 53 65 74 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73  Set.** METHOD: s
2e2a0 71 6c 69 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a 2a  qlite3_stmt.**.*
2e2b0 2a 20 5e 54 68 65 73 65 20 72 6f 75 74 69 6e 65  * ^These routine
2e2c0 73 20 72 65 74 75 72 6e 20 74 68 65 20 6e 61 6d  s return the nam
2e2d0 65 20 61 73 73 69 67 6e 65 64 20 74 6f 20 61 20  e assigned to a 
2e2e0 70 61 72 74 69 63 75 6c 61 72 20 63 6f 6c 75 6d  particular colum
2e2f0 6e 0a 2a 2a 20 69 6e 20 74 68 65 20 72 65 73 75  n.** in the resu
2e300 6c 74 20 73 65 74 20 6f 66 20 61 20 5b 53 45 4c  lt set of a [SEL
2e310 45 43 54 5d 20 73 74 61 74 65 6d 65 6e 74 2e 20  ECT] statement. 
2e320 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 63 6f   ^The sqlite3_co
2e330 6c 75 6d 6e 5f 6e 61 6d 65 28 29 0a 2a 2a 20 69  lumn_name().** i
2e340 6e 74 65 72 66 61 63 65 20 72 65 74 75 72 6e 73  nterface returns
2e350 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 20   a pointer to a 
2e360 7a 65 72 6f 2d 74 65 72 6d 69 6e 61 74 65 64 20  zero-terminated 
2e370 55 54 46 2d 38 20 73 74 72 69 6e 67 0a 2a 2a 20  UTF-8 string.** 
2e380 61 6e 64 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75  and sqlite3_colu
2e390 6d 6e 5f 6e 61 6d 65 31 36 28 29 20 72 65 74 75  mn_name16() retu
2e3a0 72 6e 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f  rns a pointer to
2e3b0 20 61 20 7a 65 72 6f 2d 74 65 72 6d 69 6e 61 74   a zero-terminat
2e3c0 65 64 0a 2a 2a 20 55 54 46 2d 31 36 20 73 74 72  ed.** UTF-16 str
2e3d0 69 6e 67 2e 20 20 5e 54 68 65 20 66 69 72 73 74  ing.  ^The first
2e3e0 20 70 61 72 61 6d 65 74 65 72 20 69 73 20 74 68   parameter is th
2e3f0 65 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74  e [prepared stat
2e400 65 6d 65 6e 74 5d 0a 2a 2a 20 74 68 61 74 20 69  ement].** that i
2e410 6d 70 6c 65 6d 65 6e 74 73 20 74 68 65 20 5b 53  mplements the [S
2e420 45 4c 45 43 54 5d 20 73 74 61 74 65 6d 65 6e 74  ELECT] statement
2e430 2e 20 5e 54 68 65 20 73 65 63 6f 6e 64 20 70 61  . ^The second pa
2e440 72 61 6d 65 74 65 72 20 69 73 20 74 68 65 0a 2a  rameter is the.*
2e450 2a 20 63 6f 6c 75 6d 6e 20 6e 75 6d 62 65 72 2e  * column number.
2e460 20 20 5e 54 68 65 20 6c 65 66 74 6d 6f 73 74 20    ^The leftmost 
2e470 63 6f 6c 75 6d 6e 20 69 73 20 6e 75 6d 62 65 72  column is number
2e480 20 30 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 72   0..**.** ^The r
2e490 65 74 75 72 6e 65 64 20 73 74 72 69 6e 67 20 70  eturned string p
2e4a0 6f 69 6e 74 65 72 20 69 73 20 76 61 6c 69 64 20  ointer is valid 
2e4b0 75 6e 74 69 6c 20 65 69 74 68 65 72 20 74 68 65  until either the
2e4c0 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65   [prepared state
2e4d0 6d 65 6e 74 5d 0a 2a 2a 20 69 73 20 64 65 73 74  ment].** is dest
2e4e0 72 6f 79 65 64 20 62 79 20 5b 73 71 6c 69 74 65  royed by [sqlite
2e4f0 33 5f 66 69 6e 61 6c 69 7a 65 28 29 5d 20 6f 72  3_finalize()] or
2e500 20 75 6e 74 69 6c 20 74 68 65 20 73 74 61 74 65   until the state
2e510 6d 65 6e 74 20 69 73 20 61 75 74 6f 6d 61 74 69  ment is automati
2e520 63 61 6c 6c 79 0a 2a 2a 20 72 65 70 72 65 70 61  cally.** reprepa
2e530 72 65 64 20 62 79 20 74 68 65 20 66 69 72 73 74  red by the first
2e540 20 63 61 6c 6c 20 74 6f 20 5b 73 71 6c 69 74 65   call to [sqlite
2e550 33 5f 73 74 65 70 28 29 5d 20 66 6f 72 20 61 20  3_step()] for a 
2e560 70 61 72 74 69 63 75 6c 61 72 20 72 75 6e 0a 2a  particular run.*
2e570 2a 20 6f 72 20 75 6e 74 69 6c 20 74 68 65 20 6e  * or until the n
2e580 65 78 74 20 63 61 6c 6c 20 74 6f 0a 2a 2a 20 73  ext call to.** s
2e590 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 6e 61  qlite3_column_na
2e5a0 6d 65 28 29 20 6f 72 20 73 71 6c 69 74 65 33 5f  me() or sqlite3_
2e5b0 63 6f 6c 75 6d 6e 5f 6e 61 6d 65 31 36 28 29 20  column_name16() 
2e5c0 6f 6e 20 74 68 65 20 73 61 6d 65 20 63 6f 6c 75  on the same colu
2e5d0 6d 6e 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 73 71  mn..**.** ^If sq
2e5e0 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29 20 66  lite3_malloc() f
2e5f0 61 69 6c 73 20 64 75 72 69 6e 67 20 74 68 65 20  ails during the 
2e600 70 72 6f 63 65 73 73 69 6e 67 20 6f 66 20 65 69  processing of ei
2e610 74 68 65 72 20 72 6f 75 74 69 6e 65 0a 2a 2a 20  ther routine.** 
2e620 28 66 6f 72 20 65 78 61 6d 70 6c 65 20 64 75 72  (for example dur
2e630 69 6e 67 20 61 20 63 6f 6e 76 65 72 73 69 6f 6e  ing a conversion
2e640 20 66 72 6f 6d 20 55 54 46 2d 38 20 74 6f 20 55   from UTF-8 to U
2e650 54 46 2d 31 36 29 20 74 68 65 6e 20 61 0a 2a 2a  TF-16) then a.**
2e660 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 20 69 73   NULL pointer is
2e670 20 72 65 74 75 72 6e 65 64 2e 0a 2a 2a 0a 2a 2a   returned..**.**
2e680 20 5e 54 68 65 20 6e 61 6d 65 20 6f 66 20 61 20   ^The name of a 
2e690 72 65 73 75 6c 74 20 63 6f 6c 75 6d 6e 20 69 73  result column is
2e6a0 20 74 68 65 20 76 61 6c 75 65 20 6f 66 20 74 68   the value of th
2e6b0 65 20 22 41 53 22 20 63 6c 61 75 73 65 20 66 6f  e "AS" clause fo
2e6c0 72 0a 2a 2a 20 74 68 61 74 20 63 6f 6c 75 6d 6e  r.** that column
2e6d0 2c 20 69 66 20 74 68 65 72 65 20 69 73 20 61 6e  , if there is an
2e6e0 20 41 53 20 63 6c 61 75 73 65 2e 20 20 49 66 20   AS clause.  If 
2e6f0 74 68 65 72 65 20 69 73 20 6e 6f 20 41 53 20 63  there is no AS c
2e700 6c 61 75 73 65 0a 2a 2a 20 74 68 65 6e 20 74 68  lause.** then th
2e710 65 20 6e 61 6d 65 20 6f 66 20 74 68 65 20 63 6f  e name of the co
2e720 6c 75 6d 6e 20 69 73 20 75 6e 73 70 65 63 69 66  lumn is unspecif
2e730 69 65 64 20 61 6e 64 20 6d 61 79 20 63 68 61 6e  ied and may chan
2e740 67 65 20 66 72 6f 6d 0a 2a 2a 20 6f 6e 65 20 72  ge from.** one r
2e750 65 6c 65 61 73 65 20 6f 66 20 53 51 4c 69 74 65  elease of SQLite
2e760 20 74 6f 20 74 68 65 20 6e 65 78 74 2e 0a 2a 2f   to the next..*/
2e770 0a 63 6f 6e 73 74 20 63 68 61 72 20 2a 73 71 6c  .const char *sql
2e780 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 6e 61 6d 65  ite3_column_name
2e790 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20  (sqlite3_stmt*, 
2e7a0 69 6e 74 20 4e 29 3b 0a 63 6f 6e 73 74 20 76 6f  int N);.const vo
2e7b0 69 64 20 2a 73 71 6c 69 74 65 33 5f 63 6f 6c 75  id *sqlite3_colu
2e7c0 6d 6e 5f 6e 61 6d 65 31 36 28 73 71 6c 69 74 65  mn_name16(sqlite
2e7d0 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 20 4e 29 3b  3_stmt*, int N);
2e7e0 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46  ../*.** CAPI3REF
2e7f0 3a 20 53 6f 75 72 63 65 20 4f 66 20 44 61 74 61  : Source Of Data
2e800 20 49 6e 20 41 20 51 75 65 72 79 20 52 65 73 75   In A Query Resu
2e810 6c 74 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71  lt.** METHOD: sq
2e820 6c 69 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a  lite3_stmt.**.**
2e830 20 5e 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73   ^These routines
2e840 20 70 72 6f 76 69 64 65 20 61 20 6d 65 61 6e 73   provide a means
2e850 20 74 6f 20 64 65 74 65 72 6d 69 6e 65 20 74 68   to determine th
2e860 65 20 64 61 74 61 62 61 73 65 2c 20 74 61 62 6c  e database, tabl
2e870 65 2c 20 61 6e 64 0a 2a 2a 20 74 61 62 6c 65 20  e, and.** table 
2e880 63 6f 6c 75 6d 6e 20 74 68 61 74 20 69 73 20 74  column that is t
2e890 68 65 20 6f 72 69 67 69 6e 20 6f 66 20 61 20 70  he origin of a p
2e8a0 61 72 74 69 63 75 6c 61 72 20 72 65 73 75 6c 74  articular result
2e8b0 20 63 6f 6c 75 6d 6e 20 69 6e 0a 2a 2a 20 5b 53   column in.** [S
2e8c0 45 4c 45 43 54 5d 20 73 74 61 74 65 6d 65 6e 74  ELECT] statement
2e8d0 2e 0a 2a 2a 20 5e 54 68 65 20 6e 61 6d 65 20 6f  ..** ^The name o
2e8e0 66 20 74 68 65 20 64 61 74 61 62 61 73 65 20 6f  f the database o
2e8f0 72 20 74 61 62 6c 65 20 6f 72 20 63 6f 6c 75 6d  r table or colum
2e900 6e 20 63 61 6e 20 62 65 20 72 65 74 75 72 6e 65  n can be returne
2e910 64 20 61 73 0a 2a 2a 20 65 69 74 68 65 72 20 61  d as.** either a
2e920 20 55 54 46 2d 38 20 6f 72 20 55 54 46 2d 31 36   UTF-8 or UTF-16
2e930 20 73 74 72 69 6e 67 2e 20 20 5e 54 68 65 20 5f   string.  ^The _
2e940 64 61 74 61 62 61 73 65 5f 20 72 6f 75 74 69 6e  database_ routin
2e950 65 73 20 72 65 74 75 72 6e 0a 2a 2a 20 74 68 65  es return.** the
2e960 20 64 61 74 61 62 61 73 65 20 6e 61 6d 65 2c 20   database name, 
2e970 74 68 65 20 5f 74 61 62 6c 65 5f 20 72 6f 75 74  the _table_ rout
2e980 69 6e 65 73 20 72 65 74 75 72 6e 20 74 68 65 20  ines return the 
2e990 74 61 62 6c 65 20 6e 61 6d 65 2c 20 61 6e 64 0a  table name, and.
2e9a0 2a 2a 20 74 68 65 20 6f 72 69 67 69 6e 5f 20 72  ** the origin_ r
2e9b0 6f 75 74 69 6e 65 73 20 72 65 74 75 72 6e 20 74  outines return t
2e9c0 68 65 20 63 6f 6c 75 6d 6e 20 6e 61 6d 65 2e 0a  he column name..
2e9d0 2a 2a 20 5e 54 68 65 20 72 65 74 75 72 6e 65 64  ** ^The returned
2e9e0 20 73 74 72 69 6e 67 20 69 73 20 76 61 6c 69 64   string is valid
2e9f0 20 75 6e 74 69 6c 20 74 68 65 20 5b 70 72 65 70   until the [prep
2ea00 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20  ared statement] 
2ea10 69 73 20 64 65 73 74 72 6f 79 65 64 0a 2a 2a 20  is destroyed.** 
2ea20 75 73 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 66  using [sqlite3_f
2ea30 69 6e 61 6c 69 7a 65 28 29 5d 20 6f 72 20 75 6e  inalize()] or un
2ea40 74 69 6c 20 74 68 65 20 73 74 61 74 65 6d 65 6e  til the statemen
2ea50 74 20 69 73 20 61 75 74 6f 6d 61 74 69 63 61 6c  t is automatical
2ea60 6c 79 0a 2a 2a 20 72 65 70 72 65 70 61 72 65 64  ly.** reprepared
2ea70 20 62 79 20 74 68 65 20 66 69 72 73 74 20 63 61   by the first ca
2ea80 6c 6c 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 73  ll to [sqlite3_s
2ea90 74 65 70 28 29 5d 20 66 6f 72 20 61 20 70 61 72  tep()] for a par
2eaa0 74 69 63 75 6c 61 72 20 72 75 6e 0a 2a 2a 20 6f  ticular run.** o
2eab0 72 20 75 6e 74 69 6c 20 74 68 65 20 73 61 6d 65  r until the same
2eac0 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 69 73 20   information is 
2ead0 72 65 71 75 65 73 74 65 64 0a 2a 2a 20 61 67 61  requested.** aga
2eae0 69 6e 20 69 6e 20 61 20 64 69 66 66 65 72 65 6e  in in a differen
2eaf0 74 20 65 6e 63 6f 64 69 6e 67 2e 0a 2a 2a 0a 2a  t encoding..**.*
2eb00 2a 20 5e 54 68 65 20 6e 61 6d 65 73 20 72 65 74  * ^The names ret
2eb10 75 72 6e 65 64 20 61 72 65 20 74 68 65 20 6f 72  urned are the or
2eb20 69 67 69 6e 61 6c 20 75 6e 2d 61 6c 69 61 73 65  iginal un-aliase
2eb30 64 20 6e 61 6d 65 73 20 6f 66 20 74 68 65 0a 2a  d names of the.*
2eb40 2a 20 64 61 74 61 62 61 73 65 2c 20 74 61 62 6c  * database, tabl
2eb50 65 2c 20 61 6e 64 20 63 6f 6c 75 6d 6e 2e 0a 2a  e, and column..*
2eb60 2a 0a 2a 2a 20 5e 54 68 65 20 66 69 72 73 74 20  *.** ^The first 
2eb70 61 72 67 75 6d 65 6e 74 20 74 6f 20 74 68 65 73  argument to thes
2eb80 65 20 69 6e 74 65 72 66 61 63 65 73 20 69 73 20  e interfaces is 
2eb90 61 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74  a [prepared stat
2eba0 65 6d 65 6e 74 5d 2e 0a 2a 2a 20 5e 54 68 65 73  ement]..** ^Thes
2ebb0 65 20 66 75 6e 63 74 69 6f 6e 73 20 72 65 74 75  e functions retu
2ebc0 72 6e 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 61  rn information a
2ebd0 62 6f 75 74 20 74 68 65 20 4e 74 68 20 72 65 73  bout the Nth res
2ebe0 75 6c 74 20 63 6f 6c 75 6d 6e 20 72 65 74 75 72  ult column retur
2ebf0 6e 65 64 20 62 79 0a 2a 2a 20 74 68 65 20 73 74  ned by.** the st
2ec00 61 74 65 6d 65 6e 74 2c 20 77 68 65 72 65 20 4e  atement, where N
2ec10 20 69 73 20 74 68 65 20 73 65 63 6f 6e 64 20 66   is the second f
2ec20 75 6e 63 74 69 6f 6e 20 61 72 67 75 6d 65 6e 74  unction argument
2ec30 2e 0a 2a 2a 20 5e 54 68 65 20 6c 65 66 74 2d 6d  ..** ^The left-m
2ec40 6f 73 74 20 63 6f 6c 75 6d 6e 20 69 73 20 63 6f  ost column is co
2ec50 6c 75 6d 6e 20 30 20 66 6f 72 20 74 68 65 73 65  lumn 0 for these
2ec60 20 72 6f 75 74 69 6e 65 73 2e 0a 2a 2a 0a 2a 2a   routines..**.**
2ec70 20 5e 49 66 20 74 68 65 20 4e 74 68 20 63 6f 6c   ^If the Nth col
2ec80 75 6d 6e 20 72 65 74 75 72 6e 65 64 20 62 79 20  umn returned by 
2ec90 74 68 65 20 73 74 61 74 65 6d 65 6e 74 20 69 73  the statement is
2eca0 20 61 6e 20 65 78 70 72 65 73 73 69 6f 6e 20 6f   an expression o
2ecb0 72 0a 2a 2a 20 73 75 62 71 75 65 72 79 20 61 6e  r.** subquery an
2ecc0 64 20 69 73 20 6e 6f 74 20 61 20 63 6f 6c 75 6d  d is not a colum
2ecd0 6e 20 76 61 6c 75 65 2c 20 74 68 65 6e 20 61 6c  n value, then al
2ece0 6c 20 6f 66 20 74 68 65 73 65 20 66 75 6e 63 74  l of these funct
2ecf0 69 6f 6e 73 20 72 65 74 75 72 6e 0a 2a 2a 20 4e  ions return.** N
2ed00 55 4c 4c 2e 20 20 5e 54 68 65 73 65 20 72 6f 75  ULL.  ^These rou
2ed10 74 69 6e 65 20 6d 69 67 68 74 20 61 6c 73 6f 20  tine might also 
2ed20 72 65 74 75 72 6e 20 4e 55 4c 4c 20 69 66 20 61  return NULL if a
2ed30 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69   memory allocati
2ed40 6f 6e 20 65 72 72 6f 72 0a 2a 2a 20 6f 63 63 75  on error.** occu
2ed50 72 73 2e 20 20 5e 4f 74 68 65 72 77 69 73 65 2c  rs.  ^Otherwise,
2ed60 20 74 68 65 79 20 72 65 74 75 72 6e 20 74 68 65   they return the
2ed70 20 6e 61 6d 65 20 6f 66 20 74 68 65 20 61 74 74   name of the att
2ed80 61 63 68 65 64 20 64 61 74 61 62 61 73 65 2c 20  ached database, 
2ed90 74 61 62 6c 65 2c 0a 2a 2a 20 6f 72 20 63 6f 6c  table,.** or col
2eda0 75 6d 6e 20 74 68 61 74 20 71 75 65 72 79 20 72  umn that query r
2edb0 65 73 75 6c 74 20 63 6f 6c 75 6d 6e 20 77 61 73  esult column was
2edc0 20 65 78 74 72 61 63 74 65 64 20 66 72 6f 6d 2e   extracted from.
2edd0 0a 2a 2a 0a 2a 2a 20 5e 41 73 20 77 69 74 68 20  .**.** ^As with 
2ede0 61 6c 6c 20 6f 74 68 65 72 20 53 51 4c 69 74 65  all other SQLite
2edf0 20 41 50 49 73 2c 20 74 68 6f 73 65 20 77 68 6f   APIs, those who
2ee00 73 65 20 6e 61 6d 65 73 20 65 6e 64 20 77 69 74  se names end wit
2ee10 68 20 22 31 36 22 20 72 65 74 75 72 6e 0a 2a 2a  h "16" return.**
2ee20 20 55 54 46 2d 31 36 20 65 6e 63 6f 64 65 64 20   UTF-16 encoded 
2ee30 73 74 72 69 6e 67 73 20 61 6e 64 20 74 68 65 20  strings and the 
2ee40 6f 74 68 65 72 20 66 75 6e 63 74 69 6f 6e 73 20  other functions 
2ee50 72 65 74 75 72 6e 20 55 54 46 2d 38 2e 0a 2a 2a  return UTF-8..**
2ee60 0a 2a 2a 20 5e 54 68 65 73 65 20 41 50 49 73 20  .** ^These APIs 
2ee70 61 72 65 20 6f 6e 6c 79 20 61 76 61 69 6c 61 62  are only availab
2ee80 6c 65 20 69 66 20 74 68 65 20 6c 69 62 72 61 72  le if the librar
2ee90 79 20 77 61 73 20 63 6f 6d 70 69 6c 65 64 20 77  y was compiled w
2eea0 69 74 68 20 74 68 65 0a 2a 2a 20 5b 53 51 4c 49  ith the.** [SQLI
2eeb0 54 45 5f 45 4e 41 42 4c 45 5f 43 4f 4c 55 4d 4e  TE_ENABLE_COLUMN
2eec0 5f 4d 45 54 41 44 41 54 41 5d 20 43 2d 70 72 65  _METADATA] C-pre
2eed0 70 72 6f 63 65 73 73 6f 72 20 73 79 6d 62 6f 6c  processor symbol
2eee0 2e 0a 2a 2a 0a 2a 2a 20 49 66 20 74 77 6f 20 6f  ..**.** If two o
2eef0 72 20 6d 6f 72 65 20 74 68 72 65 61 64 73 20 63  r more threads c
2ef00 61 6c 6c 20 6f 6e 65 20 6f 72 20 6d 6f 72 65 20  all one or more 
2ef10 6f 66 20 74 68 65 73 65 20 72 6f 75 74 69 6e 65  of these routine
2ef20 73 20 61 67 61 69 6e 73 74 20 74 68 65 20 73 61  s against the sa
2ef30 6d 65 0a 2a 2a 20 70 72 65 70 61 72 65 64 20 73  me.** prepared s
2ef40 74 61 74 65 6d 65 6e 74 20 61 6e 64 20 63 6f 6c  tatement and col
2ef50 75 6d 6e 20 61 74 20 74 68 65 20 73 61 6d 65 20  umn at the same 
2ef60 74 69 6d 65 20 74 68 65 6e 20 74 68 65 20 72 65  time then the re
2ef70 73 75 6c 74 73 20 61 72 65 0a 2a 2a 20 75 6e 64  sults are.** und
2ef80 65 66 69 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 49 66  efined..**.** If
2ef90 20 74 77 6f 20 6f 72 20 6d 6f 72 65 20 74 68 72   two or more thr
2efa0 65 61 64 73 20 63 61 6c 6c 20 6f 6e 65 20 6f 72  eads call one or
2efb0 20 6d 6f 72 65 0a 2a 2a 20 5b 73 71 6c 69 74 65   more.** [sqlite
2efc0 33 5f 63 6f 6c 75 6d 6e 5f 64 61 74 61 62 61 73  3_column_databas
2efd0 65 5f 6e 61 6d 65 20 7c 20 63 6f 6c 75 6d 6e 20  e_name | column 
2efe0 6d 65 74 61 64 61 74 61 20 69 6e 74 65 72 66 61  metadata interfa
2eff0 63 65 73 5d 0a 2a 2a 20 66 6f 72 20 74 68 65 20  ces].** for the 
2f000 73 61 6d 65 20 5b 70 72 65 70 61 72 65 64 20 73  same [prepared s
2f010 74 61 74 65 6d 65 6e 74 5d 20 61 6e 64 20 72 65  tatement] and re
2f020 73 75 6c 74 20 63 6f 6c 75 6d 6e 0a 2a 2a 20 61  sult column.** a
2f030 74 20 74 68 65 20 73 61 6d 65 20 74 69 6d 65 20  t the same time 
2f040 74 68 65 6e 20 74 68 65 20 72 65 73 75 6c 74 73  then the results
2f050 20 61 72 65 20 75 6e 64 65 66 69 6e 65 64 2e 0a   are undefined..
2f060 2a 2f 0a 63 6f 6e 73 74 20 63 68 61 72 20 2a 73  */.const char *s
2f070 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 64 61  qlite3_column_da
2f080 74 61 62 61 73 65 5f 6e 61 6d 65 28 73 71 6c 69  tabase_name(sqli
2f090 74 65 33 5f 73 74 6d 74 2a 2c 69 6e 74 29 3b 0a  te3_stmt*,int);.
2f0a0 63 6f 6e 73 74 20 76 6f 69 64 20 2a 73 71 6c 69  const void *sqli
2f0b0 74 65 33 5f 63 6f 6c 75 6d 6e 5f 64 61 74 61 62  te3_column_datab
2f0c0 61 73 65 5f 6e 61 6d 65 31 36 28 73 71 6c 69 74  ase_name16(sqlit
2f0d0 65 33 5f 73 74 6d 74 2a 2c 69 6e 74 29 3b 0a 63  e3_stmt*,int);.c
2f0e0 6f 6e 73 74 20 63 68 61 72 20 2a 73 71 6c 69 74  onst char *sqlit
2f0f0 65 33 5f 63 6f 6c 75 6d 6e 5f 74 61 62 6c 65 5f  e3_column_table_
2f100 6e 61 6d 65 28 73 71 6c 69 74 65 33 5f 73 74 6d  name(sqlite3_stm
2f110 74 2a 2c 69 6e 74 29 3b 0a 63 6f 6e 73 74 20 76  t*,int);.const v
2f120 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f 63 6f 6c  oid *sqlite3_col
2f130 75 6d 6e 5f 74 61 62 6c 65 5f 6e 61 6d 65 31 36  umn_table_name16
2f140 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 69  (sqlite3_stmt*,i
2f150 6e 74 29 3b 0a 63 6f 6e 73 74 20 63 68 61 72 20  nt);.const char 
2f160 2a 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f  *sqlite3_column_
2f170 6f 72 69 67 69 6e 5f 6e 61 6d 65 28 73 71 6c 69  origin_name(sqli
2f180 74 65 33 5f 73 74 6d 74 2a 2c 69 6e 74 29 3b 0a  te3_stmt*,int);.
2f190 63 6f 6e 73 74 20 76 6f 69 64 20 2a 73 71 6c 69  const void *sqli
2f1a0 74 65 33 5f 63 6f 6c 75 6d 6e 5f 6f 72 69 67 69  te3_column_origi
2f1b0 6e 5f 6e 61 6d 65 31 36 28 73 71 6c 69 74 65 33  n_name16(sqlite3
2f1c0 5f 73 74 6d 74 2a 2c 69 6e 74 29 3b 0a 0a 2f 2a  _stmt*,int);../*
2f1d0 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 44 65  .** CAPI3REF: De
2f1e0 63 6c 61 72 65 64 20 44 61 74 61 74 79 70 65 20  clared Datatype 
2f1f0 4f 66 20 41 20 51 75 65 72 79 20 52 65 73 75 6c  Of A Query Resul
2f200 74 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c  t.** METHOD: sql
2f210 69 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20  ite3_stmt.**.** 
2f220 5e 28 54 68 65 20 66 69 72 73 74 20 70 61 72 61  ^(The first para
2f230 6d 65 74 65 72 20 69 73 20 61 20 5b 70 72 65 70  meter is a [prep
2f240 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 2e  ared statement].
2f250 0a 2a 2a 20 49 66 20 74 68 69 73 20 73 74 61 74  .** If this stat
2f260 65 6d 65 6e 74 20 69 73 20 61 20 5b 53 45 4c 45  ement is a [SELE
2f270 43 54 5d 20 73 74 61 74 65 6d 65 6e 74 20 61 6e  CT] statement an
2f280 64 20 74 68 65 20 4e 74 68 20 63 6f 6c 75 6d 6e  d the Nth column
2f290 20 6f 66 20 74 68 65 0a 2a 2a 20 72 65 74 75 72   of the.** retur
2f2a0 6e 65 64 20 72 65 73 75 6c 74 20 73 65 74 20 6f  ned result set o
2f2b0 66 20 74 68 61 74 20 5b 53 45 4c 45 43 54 5d 20  f that [SELECT] 
2f2c0 69 73 20 61 20 74 61 62 6c 65 20 63 6f 6c 75 6d  is a table colum
2f2d0 6e 20 28 6e 6f 74 20 61 6e 0a 2a 2a 20 65 78 70  n (not an.** exp
2f2e0 72 65 73 73 69 6f 6e 20 6f 72 20 73 75 62 71 75  ression or subqu
2f2f0 65 72 79 29 20 74 68 65 6e 20 74 68 65 20 64 65  ery) then the de
2f300 63 6c 61 72 65 64 20 74 79 70 65 20 6f 66 20 74  clared type of t
2f310 68 65 20 74 61 62 6c 65 0a 2a 2a 20 63 6f 6c 75  he table.** colu
2f320 6d 6e 20 69 73 20 72 65 74 75 72 6e 65 64 2e 29  mn is returned.)
2f330 5e 20 20 5e 49 66 20 74 68 65 20 4e 74 68 20 63  ^  ^If the Nth c
2f340 6f 6c 75 6d 6e 20 6f 66 20 74 68 65 20 72 65 73  olumn of the res
2f350 75 6c 74 20 73 65 74 20 69 73 20 61 6e 0a 2a 2a  ult set is an.**
2f360 20 65 78 70 72 65 73 73 69 6f 6e 20 6f 72 20 73   expression or s
2f370 75 62 71 75 65 72 79 2c 20 74 68 65 6e 20 61 20  ubquery, then a 
2f380 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 20 69 73 20  NULL pointer is 
2f390 72 65 74 75 72 6e 65 64 2e 0a 2a 2a 20 5e 54 68  returned..** ^Th
2f3a0 65 20 72 65 74 75 72 6e 65 64 20 73 74 72 69 6e  e returned strin
2f3b0 67 20 69 73 20 61 6c 77 61 79 73 20 55 54 46 2d  g is always UTF-
2f3c0 38 20 65 6e 63 6f 64 65 64 2e 0a 2a 2a 0a 2a 2a  8 encoded..**.**
2f3d0 20 5e 28 46 6f 72 20 65 78 61 6d 70 6c 65 2c 20   ^(For example, 
2f3e0 67 69 76 65 6e 20 74 68 65 20 64 61 74 61 62 61  given the databa
2f3f0 73 65 20 73 63 68 65 6d 61 3a 0a 2a 2a 0a 2a 2a  se schema:.**.**
2f400 20 43 52 45 41 54 45 20 54 41 42 4c 45 20 74 31   CREATE TABLE t1
2f410 28 63 31 20 56 41 52 49 41 4e 54 29 3b 0a 2a 2a  (c1 VARIANT);.**
2f420 0a 2a 2a 20 61 6e 64 20 74 68 65 20 66 6f 6c 6c  .** and the foll
2f430 6f 77 69 6e 67 20 73 74 61 74 65 6d 65 6e 74 20  owing statement 
2f440 74 6f 20 62 65 20 63 6f 6d 70 69 6c 65 64 3a 0a  to be compiled:.
2f450 2a 2a 0a 2a 2a 20 53 45 4c 45 43 54 20 63 31 20  **.** SELECT c1 
2f460 2b 20 31 2c 20 63 31 20 46 52 4f 4d 20 74 31 3b  + 1, c1 FROM t1;
2f470 0a 2a 2a 0a 2a 2a 20 74 68 69 73 20 72 6f 75 74  .**.** this rout
2f480 69 6e 65 20 77 6f 75 6c 64 20 72 65 74 75 72 6e  ine would return
2f490 20 74 68 65 20 73 74 72 69 6e 67 20 22 56 41 52   the string "VAR
2f4a0 49 41 4e 54 22 20 66 6f 72 20 74 68 65 20 73 65  IANT" for the se
2f4b0 63 6f 6e 64 20 72 65 73 75 6c 74 0a 2a 2a 20 63  cond result.** c
2f4c0 6f 6c 75 6d 6e 20 28 69 3d 3d 31 29 2c 20 61 6e  olumn (i==1), an
2f4d0 64 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72  d a NULL pointer
2f4e0 20 66 6f 72 20 74 68 65 20 66 69 72 73 74 20 72   for the first r
2f4f0 65 73 75 6c 74 20 63 6f 6c 75 6d 6e 20 28 69 3d  esult column (i=
2f500 3d 30 29 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 53 51  =0).)^.**.** ^SQ
2f510 4c 69 74 65 20 75 73 65 73 20 64 79 6e 61 6d 69  Lite uses dynami
2f520 63 20 72 75 6e 2d 74 69 6d 65 20 74 79 70 69 6e  c run-time typin
2f530 67 2e 20 20 5e 53 6f 20 6a 75 73 74 20 62 65 63  g.  ^So just bec
2f540 61 75 73 65 20 61 20 63 6f 6c 75 6d 6e 0a 2a 2a  ause a column.**
2f550 20 69 73 20 64 65 63 6c 61 72 65 64 20 74 6f 20   is declared to 
2f560 63 6f 6e 74 61 69 6e 20 61 20 70 61 72 74 69 63  contain a partic
2f570 75 6c 61 72 20 74 79 70 65 20 64 6f 65 73 20 6e  ular type does n
2f580 6f 74 20 6d 65 61 6e 20 74 68 61 74 20 74 68 65  ot mean that the
2f590 0a 2a 2a 20 64 61 74 61 20 73 74 6f 72 65 64 20  .** data stored 
2f5a0 69 6e 20 74 68 61 74 20 63 6f 6c 75 6d 6e 20 69  in that column i
2f5b0 73 20 6f 66 20 74 68 65 20 64 65 63 6c 61 72 65  s of the declare
2f5c0 64 20 74 79 70 65 2e 20 20 53 51 4c 69 74 65 20  d type.  SQLite 
2f5d0 69 73 0a 2a 2a 20 73 74 72 6f 6e 67 6c 79 20 74  is.** strongly t
2f5e0 79 70 65 64 2c 20 62 75 74 20 74 68 65 20 74 79  yped, but the ty
2f5f0 70 69 6e 67 20 69 73 20 64 79 6e 61 6d 69 63 20  ping is dynamic 
2f600 6e 6f 74 20 73 74 61 74 69 63 2e 20 20 5e 54 79  not static.  ^Ty
2f610 70 65 0a 2a 2a 20 69 73 20 61 73 73 6f 63 69 61  pe.** is associa
2f620 74 65 64 20 77 69 74 68 20 69 6e 64 69 76 69 64  ted with individ
2f630 75 61 6c 20 76 61 6c 75 65 73 2c 20 6e 6f 74 20  ual values, not 
2f640 77 69 74 68 20 74 68 65 20 63 6f 6e 74 61 69 6e  with the contain
2f650 65 72 73 0a 2a 2a 20 75 73 65 64 20 74 6f 20 68  ers.** used to h
2f660 6f 6c 64 20 74 68 6f 73 65 20 76 61 6c 75 65 73  old those values
2f670 2e 0a 2a 2f 0a 63 6f 6e 73 74 20 63 68 61 72 20  ..*/.const char 
2f680 2a 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f  *sqlite3_column_
2f690 64 65 63 6c 74 79 70 65 28 73 71 6c 69 74 65 33  decltype(sqlite3
2f6a0 5f 73 74 6d 74 2a 2c 69 6e 74 29 3b 0a 63 6f 6e  _stmt*,int);.con
2f6b0 73 74 20 76 6f 69 64 20 2a 73 71 6c 69 74 65 33  st void *sqlite3
2f6c0 5f 63 6f 6c 75 6d 6e 5f 64 65 63 6c 74 79 70 65  _column_decltype
2f6d0 31 36 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a  16(sqlite3_stmt*
2f6e0 2c 69 6e 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41  ,int);../*.** CA
2f6f0 50 49 33 52 45 46 3a 20 45 76 61 6c 75 61 74 65  PI3REF: Evaluate
2f700 20 41 6e 20 53 51 4c 20 53 74 61 74 65 6d 65 6e   An SQL Statemen
2f710 74 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c  t.** METHOD: sql
2f720 69 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20  ite3_stmt.**.** 
2f730 41 66 74 65 72 20 61 20 5b 70 72 65 70 61 72 65  After a [prepare
2f740 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 68 61 73  d statement] has
2f750 20 62 65 65 6e 20 70 72 65 70 61 72 65 64 20 75   been prepared u
2f760 73 69 6e 67 20 65 69 74 68 65 72 0a 2a 2a 20 5b  sing either.** [
2f770 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 5f  sqlite3_prepare_
2f780 76 32 28 29 5d 20 6f 72 20 5b 73 71 6c 69 74 65  v2()] or [sqlite
2f790 33 5f 70 72 65 70 61 72 65 31 36 5f 76 32 28 29  3_prepare16_v2()
2f7a0 5d 20 6f 72 20 6f 6e 65 20 6f 66 20 74 68 65 20  ] or one of the 
2f7b0 6c 65 67 61 63 79 0a 2a 2a 20 69 6e 74 65 72 66  legacy.** interf
2f7c0 61 63 65 73 20 5b 73 71 6c 69 74 65 33 5f 70 72  aces [sqlite3_pr
2f7d0 65 70 61 72 65 28 29 5d 20 6f 72 20 5b 73 71 6c  epare()] or [sql
2f7e0 69 74 65 33 5f 70 72 65 70 61 72 65 31 36 28 29  ite3_prepare16()
2f7f0 5d 2c 20 74 68 69 73 20 66 75 6e 63 74 69 6f 6e  ], this function
2f800 0a 2a 2a 20 6d 75 73 74 20 62 65 20 63 61 6c 6c  .** must be call
2f810 65 64 20 6f 6e 65 20 6f 72 20 6d 6f 72 65 20 74  ed one or more t
2f820 69 6d 65 73 20 74 6f 20 65 76 61 6c 75 61 74 65  imes to evaluate
2f830 20 74 68 65 20 73 74 61 74 65 6d 65 6e 74 2e 0a   the statement..
2f840 2a 2a 0a 2a 2a 20 54 68 65 20 64 65 74 61 69 6c  **.** The detail
2f850 73 20 6f 66 20 74 68 65 20 62 65 68 61 76 69 6f  s of the behavio
2f860 72 20 6f 66 20 74 68 65 20 73 71 6c 69 74 65 33  r of the sqlite3
2f870 5f 73 74 65 70 28 29 20 69 6e 74 65 72 66 61 63  _step() interfac
2f880 65 20 64 65 70 65 6e 64 0a 2a 2a 20 6f 6e 20 77  e depend.** on w
2f890 68 65 74 68 65 72 20 74 68 65 20 73 74 61 74 65  hether the state
2f8a0 6d 65 6e 74 20 77 61 73 20 70 72 65 70 61 72 65  ment was prepare
2f8b0 64 20 75 73 69 6e 67 20 74 68 65 20 6e 65 77 65  d using the newe
2f8c0 72 20 22 76 32 22 20 69 6e 74 65 72 66 61 63 65  r "v2" interface
2f8d0 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 70 72 65  .** [sqlite3_pre
2f8e0 70 61 72 65 5f 76 32 28 29 5d 20 61 6e 64 20 5b  pare_v2()] and [
2f8f0 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 31  sqlite3_prepare1
2f900 36 5f 76 32 28 29 5d 20 6f 72 20 74 68 65 20 6f  6_v2()] or the o
2f910 6c 64 65 72 20 6c 65 67 61 63 79 0a 2a 2a 20 69  lder legacy.** i
2f920 6e 74 65 72 66 61 63 65 20 5b 73 71 6c 69 74 65  nterface [sqlite
2f930 33 5f 70 72 65 70 61 72 65 28 29 5d 20 61 6e 64  3_prepare()] and
2f940 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72   [sqlite3_prepar
2f950 65 31 36 28 29 5d 2e 20 20 54 68 65 20 75 73 65  e16()].  The use
2f960 20 6f 66 20 74 68 65 0a 2a 2a 20 6e 65 77 20 22   of the.** new "
2f970 76 32 22 20 69 6e 74 65 72 66 61 63 65 20 69 73  v2" interface is
2f980 20 72 65 63 6f 6d 6d 65 6e 64 65 64 20 66 6f 72   recommended for
2f990 20 6e 65 77 20 61 70 70 6c 69 63 61 74 69 6f 6e   new application
2f9a0 73 20 62 75 74 20 74 68 65 20 6c 65 67 61 63 79  s but the legacy
2f9b0 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 20 77 69  .** interface wi
2f9c0 6c 6c 20 63 6f 6e 74 69 6e 75 65 20 74 6f 20 62  ll continue to b
2f9d0 65 20 73 75 70 70 6f 72 74 65 64 2e 0a 2a 2a 0a  e supported..**.
2f9e0 2a 2a 20 5e 49 6e 20 74 68 65 20 6c 65 67 61 63  ** ^In the legac
2f9f0 79 20 69 6e 74 65 72 66 61 63 65 2c 20 74 68 65  y interface, the
2fa00 20 72 65 74 75 72 6e 20 76 61 6c 75 65 20 77 69   return value wi
2fa10 6c 6c 20 62 65 20 65 69 74 68 65 72 20 5b 53 51  ll be either [SQ
2fa20 4c 49 54 45 5f 42 55 53 59 5d 2c 0a 2a 2a 20 5b  LITE_BUSY],.** [
2fa30 53 51 4c 49 54 45 5f 44 4f 4e 45 5d 2c 20 5b 53  SQLITE_DONE], [S
2fa40 51 4c 49 54 45 5f 52 4f 57 5d 2c 20 5b 53 51 4c  QLITE_ROW], [SQL
2fa50 49 54 45 5f 45 52 52 4f 52 5d 2c 20 6f 72 20 5b  ITE_ERROR], or [
2fa60 53 51 4c 49 54 45 5f 4d 49 53 55 53 45 5d 2e 0a  SQLITE_MISUSE]..
2fa70 2a 2a 20 5e 57 69 74 68 20 74 68 65 20 22 76 32  ** ^With the "v2
2fa80 22 20 69 6e 74 65 72 66 61 63 65 2c 20 61 6e 79  " interface, any
2fa90 20 6f 66 20 74 68 65 20 6f 74 68 65 72 20 5b 72   of the other [r
2faa0 65 73 75 6c 74 20 63 6f 64 65 73 5d 20 6f 72 0a  esult codes] or.
2fab0 2a 2a 20 5b 65 78 74 65 6e 64 65 64 20 72 65 73  ** [extended res
2fac0 75 6c 74 20 63 6f 64 65 73 5d 20 6d 69 67 68 74  ult codes] might
2fad0 20 62 65 20 72 65 74 75 72 6e 65 64 20 61 73 20   be returned as 
2fae0 77 65 6c 6c 2e 0a 2a 2a 0a 2a 2a 20 5e 5b 53 51  well..**.** ^[SQ
2faf0 4c 49 54 45 5f 42 55 53 59 5d 20 6d 65 61 6e 73  LITE_BUSY] means
2fb00 20 74 68 61 74 20 74 68 65 20 64 61 74 61 62 61   that the databa
2fb10 73 65 20 65 6e 67 69 6e 65 20 77 61 73 20 75 6e  se engine was un
2fb20 61 62 6c 65 20 74 6f 20 61 63 71 75 69 72 65 20  able to acquire 
2fb30 74 68 65 0a 2a 2a 20 64 61 74 61 62 61 73 65 20  the.** database 
2fb40 6c 6f 63 6b 73 20 69 74 20 6e 65 65 64 73 20 74  locks it needs t
2fb50 6f 20 64 6f 20 69 74 73 20 6a 6f 62 2e 20 20 5e  o do its job.  ^
2fb60 49 66 20 74 68 65 20 73 74 61 74 65 6d 65 6e 74  If the statement
2fb70 20 69 73 20 61 20 5b 43 4f 4d 4d 49 54 5d 0a 2a   is a [COMMIT].*
2fb80 2a 20 6f 72 20 6f 63 63 75 72 73 20 6f 75 74 73  * or occurs outs
2fb90 69 64 65 20 6f 66 20 61 6e 20 65 78 70 6c 69 63  ide of an explic
2fba0 69 74 20 74 72 61 6e 73 61 63 74 69 6f 6e 2c 20  it transaction, 
2fbb0 74 68 65 6e 20 79 6f 75 20 63 61 6e 20 72 65 74  then you can ret
2fbc0 72 79 20 74 68 65 0a 2a 2a 20 73 74 61 74 65 6d  ry the.** statem
2fbd0 65 6e 74 2e 20 20 49 66 20 74 68 65 20 73 74 61  ent.  If the sta
2fbe0 74 65 6d 65 6e 74 20 69 73 20 6e 6f 74 20 61 20  tement is not a 
2fbf0 5b 43 4f 4d 4d 49 54 5d 20 61 6e 64 20 6f 63 63  [COMMIT] and occ
2fc00 75 72 73 20 77 69 74 68 69 6e 20 61 6e 0a 2a 2a  urs within an.**
2fc10 20 65 78 70 6c 69 63 69 74 20 74 72 61 6e 73 61   explicit transa
2fc20 63 74 69 6f 6e 20 74 68 65 6e 20 79 6f 75 20 73  ction then you s
2fc30 68 6f 75 6c 64 20 72 6f 6c 6c 62 61 63 6b 20 74  hould rollback t
2fc40 68 65 20 74 72 61 6e 73 61 63 74 69 6f 6e 20 62  he transaction b
2fc50 65 66 6f 72 65 0a 2a 2a 20 63 6f 6e 74 69 6e 75  efore.** continu
2fc60 69 6e 67 2e 0a 2a 2a 0a 2a 2a 20 5e 5b 53 51 4c  ing..**.** ^[SQL
2fc70 49 54 45 5f 44 4f 4e 45 5d 20 6d 65 61 6e 73 20  ITE_DONE] means 
2fc80 74 68 61 74 20 74 68 65 20 73 74 61 74 65 6d 65  that the stateme
2fc90 6e 74 20 68 61 73 20 66 69 6e 69 73 68 65 64 20  nt has finished 
2fca0 65 78 65 63 75 74 69 6e 67 0a 2a 2a 20 73 75 63  executing.** suc
2fcb0 63 65 73 73 66 75 6c 6c 79 2e 20 20 73 71 6c 69  cessfully.  sqli
2fcc0 74 65 33 5f 73 74 65 70 28 29 20 73 68 6f 75 6c  te3_step() shoul
2fcd0 64 20 6e 6f 74 20 62 65 20 63 61 6c 6c 65 64 20  d not be called 
2fce0 61 67 61 69 6e 20 6f 6e 20 74 68 69 73 20 76 69  again on this vi
2fcf0 72 74 75 61 6c 0a 2a 2a 20 6d 61 63 68 69 6e 65  rtual.** machine
2fd00 20 77 69 74 68 6f 75 74 20 66 69 72 73 74 20 63   without first c
2fd10 61 6c 6c 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f  alling [sqlite3_
2fd20 72 65 73 65 74 28 29 5d 20 74 6f 20 72 65 73 65  reset()] to rese
2fd30 74 20 74 68 65 20 76 69 72 74 75 61 6c 0a 2a 2a  t the virtual.**
2fd40 20 6d 61 63 68 69 6e 65 20 62 61 63 6b 20 74 6f   machine back to
2fd50 20 69 74 73 20 69 6e 69 74 69 61 6c 20 73 74 61   its initial sta
2fd60 74 65 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68  te..**.** ^If th
2fd70 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 20  e SQL statement 
2fd80 62 65 69 6e 67 20 65 78 65 63 75 74 65 64 20 72  being executed r
2fd90 65 74 75 72 6e 73 20 61 6e 79 20 64 61 74 61 2c  eturns any data,
2fda0 20 74 68 65 6e 20 5b 53 51 4c 49 54 45 5f 52 4f   then [SQLITE_RO
2fdb0 57 5d 0a 2a 2a 20 69 73 20 72 65 74 75 72 6e 65  W].** is returne
2fdc0 64 20 65 61 63 68 20 74 69 6d 65 20 61 20 6e 65  d each time a ne
2fdd0 77 20 72 6f 77 20 6f 66 20 64 61 74 61 20 69 73  w row of data is
2fde0 20 72 65 61 64 79 20 66 6f 72 20 70 72 6f 63 65   ready for proce
2fdf0 73 73 69 6e 67 20 62 79 20 74 68 65 0a 2a 2a 20  ssing by the.** 
2fe00 63 61 6c 6c 65 72 2e 20 54 68 65 20 76 61 6c 75  caller. The valu
2fe10 65 73 20 6d 61 79 20 62 65 20 61 63 63 65 73 73  es may be access
2fe20 65 64 20 75 73 69 6e 67 20 74 68 65 20 5b 63 6f  ed using the [co
2fe30 6c 75 6d 6e 20 61 63 63 65 73 73 20 66 75 6e 63  lumn access func
2fe40 74 69 6f 6e 73 5d 2e 0a 2a 2a 20 73 71 6c 69 74  tions]..** sqlit
2fe50 65 33 5f 73 74 65 70 28 29 20 69 73 20 63 61 6c  e3_step() is cal
2fe60 6c 65 64 20 61 67 61 69 6e 20 74 6f 20 72 65 74  led again to ret
2fe70 72 69 65 76 65 20 74 68 65 20 6e 65 78 74 20 72  rieve the next r
2fe80 6f 77 20 6f 66 20 64 61 74 61 2e 0a 2a 2a 0a 2a  ow of data..**.*
2fe90 2a 20 5e 5b 53 51 4c 49 54 45 5f 45 52 52 4f 52  * ^[SQLITE_ERROR
2fea0 5d 20 6d 65 61 6e 73 20 74 68 61 74 20 61 20 72  ] means that a r
2feb0 75 6e 2d 74 69 6d 65 20 65 72 72 6f 72 20 28 73  un-time error (s
2fec0 75 63 68 20 61 73 20 61 20 63 6f 6e 73 74 72 61  uch as a constra
2fed0 69 6e 74 0a 2a 2a 20 76 69 6f 6c 61 74 69 6f 6e  int.** violation
2fee0 29 20 68 61 73 20 6f 63 63 75 72 72 65 64 2e 20  ) has occurred. 
2fef0 20 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 20   sqlite3_step() 
2ff00 73 68 6f 75 6c 64 20 6e 6f 74 20 62 65 20 63 61  should not be ca
2ff10 6c 6c 65 64 20 61 67 61 69 6e 20 6f 6e 0a 2a 2a  lled again on.**
2ff20 20 74 68 65 20 56 4d 2e 20 4d 6f 72 65 20 69 6e   the VM. More in
2ff30 66 6f 72 6d 61 74 69 6f 6e 20 6d 61 79 20 62 65  formation may be
2ff40 20 66 6f 75 6e 64 20 62 79 20 63 61 6c 6c 69 6e   found by callin
2ff50 67 20 5b 73 71 6c 69 74 65 33 5f 65 72 72 6d 73  g [sqlite3_errms
2ff60 67 28 29 5d 2e 0a 2a 2a 20 5e 57 69 74 68 20 74  g()]..** ^With t
2ff70 68 65 20 6c 65 67 61 63 79 20 69 6e 74 65 72 66  he legacy interf
2ff80 61 63 65 2c 20 61 20 6d 6f 72 65 20 73 70 65 63  ace, a more spec
2ff90 69 66 69 63 20 65 72 72 6f 72 20 63 6f 64 65 20  ific error code 
2ffa0 28 66 6f 72 20 65 78 61 6d 70 6c 65 2c 0a 2a 2a  (for example,.**
2ffb0 20 5b 53 51 4c 49 54 45 5f 49 4e 54 45 52 52 55   [SQLITE_INTERRU
2ffc0 50 54 5d 2c 20 5b 53 51 4c 49 54 45 5f 53 43 48  PT], [SQLITE_SCH
2ffd0 45 4d 41 5d 2c 20 5b 53 51 4c 49 54 45 5f 43 4f  EMA], [SQLITE_CO
2ffe0 52 52 55 50 54 5d 2c 20 61 6e 64 20 73 6f 20 66  RRUPT], and so f
2fff0 6f 72 74 68 29 0a 2a 2a 20 63 61 6e 20 62 65 20  orth).** can be 
30000 6f 62 74 61 69 6e 65 64 20 62 79 20 63 61 6c 6c  obtained by call
30010 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 72 65 73  ing [sqlite3_res
30020 65 74 28 29 5d 20 6f 6e 20 74 68 65 0a 2a 2a 20  et()] on the.** 
30030 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d  [prepared statem
30040 65 6e 74 5d 2e 20 20 5e 49 6e 20 74 68 65 20 22  ent].  ^In the "
30050 76 32 22 20 69 6e 74 65 72 66 61 63 65 2c 0a 2a  v2" interface,.*
30060 2a 20 74 68 65 20 6d 6f 72 65 20 73 70 65 63 69  * the more speci
30070 66 69 63 20 65 72 72 6f 72 20 63 6f 64 65 20 69  fic error code i
30080 73 20 72 65 74 75 72 6e 65 64 20 64 69 72 65 63  s returned direc
30090 74 6c 79 20 62 79 20 73 71 6c 69 74 65 33 5f 73  tly by sqlite3_s
300a0 74 65 70 28 29 2e 0a 2a 2a 0a 2a 2a 20 5b 53 51  tep()..**.** [SQ
300b0 4c 49 54 45 5f 4d 49 53 55 53 45 5d 20 6d 65 61  LITE_MISUSE] mea
300c0 6e 73 20 74 68 61 74 20 74 68 65 20 74 68 69 73  ns that the this
300d0 20 72 6f 75 74 69 6e 65 20 77 61 73 20 63 61 6c   routine was cal
300e0 6c 65 64 20 69 6e 61 70 70 72 6f 70 72 69 61 74  led inappropriat
300f0 65 6c 79 2e 0a 2a 2a 20 50 65 72 68 61 70 73 20  ely..** Perhaps 
30100 69 74 20 77 61 73 20 63 61 6c 6c 65 64 20 6f 6e  it was called on
30110 20 61 20 5b 70 72 65 70 61 72 65 64 20 73 74 61   a [prepared sta
30120 74 65 6d 65 6e 74 5d 20 74 68 61 74 20 68 61 73  tement] that has
30130 0a 2a 2a 20 61 6c 72 65 61 64 79 20 62 65 65 6e  .** already been
30140 20 5b 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69   [sqlite3_finali
30150 7a 65 20 7c 20 66 69 6e 61 6c 69 7a 65 64 5d 20  ze | finalized] 
30160 6f 72 20 6f 6e 20 6f 6e 65 20 74 68 61 74 20 68  or on one that h
30170 61 64 0a 2a 2a 20 70 72 65 76 69 6f 75 73 6c 79  ad.** previously
30180 20 72 65 74 75 72 6e 65 64 20 5b 53 51 4c 49 54   returned [SQLIT
30190 45 5f 45 52 52 4f 52 5d 20 6f 72 20 5b 53 51 4c  E_ERROR] or [SQL
301a0 49 54 45 5f 44 4f 4e 45 5d 2e 20 20 4f 72 20 69  ITE_DONE].  Or i
301b0 74 20 63 6f 75 6c 64 0a 2a 2a 20 62 65 20 74 68  t could.** be th
301c0 65 20 63 61 73 65 20 74 68 61 74 20 74 68 65 20  e case that the 
301d0 73 61 6d 65 20 64 61 74 61 62 61 73 65 20 63 6f  same database co
301e0 6e 6e 65 63 74 69 6f 6e 20 69 73 20 62 65 69 6e  nnection is bein
301f0 67 20 75 73 65 64 20 62 79 20 74 77 6f 20 6f 72  g used by two or
30200 0a 2a 2a 20 6d 6f 72 65 20 74 68 72 65 61 64 73  .** more threads
30210 20 61 74 20 74 68 65 20 73 61 6d 65 20 6d 6f 6d   at the same mom
30220 65 6e 74 20 69 6e 20 74 69 6d 65 2e 0a 2a 2a 0a  ent in time..**.
30230 2a 2a 20 46 6f 72 20 61 6c 6c 20 76 65 72 73 69  ** For all versi
30240 6f 6e 73 20 6f 66 20 53 51 4c 69 74 65 20 75 70  ons of SQLite up
30250 20 74 6f 20 61 6e 64 20 69 6e 63 6c 75 64 69 6e   to and includin
30260 67 20 33 2e 36 2e 32 33 2e 31 2c 20 61 20 63 61  g 3.6.23.1, a ca
30270 6c 6c 20 74 6f 0a 2a 2a 20 5b 73 71 6c 69 74 65  ll to.** [sqlite
30280 33 5f 72 65 73 65 74 28 29 5d 20 77 61 73 20 72  3_reset()] was r
30290 65 71 75 69 72 65 64 20 61 66 74 65 72 20 73 71  equired after sq
302a0 6c 69 74 65 33 5f 73 74 65 70 28 29 20 72 65 74  lite3_step() ret
302b0 75 72 6e 65 64 20 61 6e 79 74 68 69 6e 67 0a 2a  urned anything.*
302c0 2a 20 6f 74 68 65 72 20 74 68 61 6e 20 5b 53 51  * other than [SQ
302d0 4c 49 54 45 5f 52 4f 57 5d 20 62 65 66 6f 72 65  LITE_ROW] before
302e0 20 61 6e 79 20 73 75 62 73 65 71 75 65 6e 74 20   any subsequent 
302f0 69 6e 76 6f 63 61 74 69 6f 6e 20 6f 66 0a 2a 2a  invocation of.**
30300 20 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 2e   sqlite3_step().
30310 20 20 46 61 69 6c 75 72 65 20 74 6f 20 72 65 73    Failure to res
30320 65 74 20 74 68 65 20 70 72 65 70 61 72 65 64 20  et the prepared 
30330 73 74 61 74 65 6d 65 6e 74 20 75 73 69 6e 67 20  statement using 
30340 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 72 65 73  .** [sqlite3_res
30350 65 74 28 29 5d 20 77 6f 75 6c 64 20 72 65 73 75  et()] would resu
30360 6c 74 20 69 6e 20 61 6e 20 5b 53 51 4c 49 54 45  lt in an [SQLITE
30370 5f 4d 49 53 55 53 45 5d 20 72 65 74 75 72 6e 20  _MISUSE] return 
30380 66 72 6f 6d 0a 2a 2a 20 73 71 6c 69 74 65 33 5f  from.** sqlite3_
30390 73 74 65 70 28 29 2e 20 20 42 75 74 20 61 66 74  step().  But aft
303a0 65 72 20 76 65 72 73 69 6f 6e 20 33 2e 36 2e 32  er version 3.6.2
303b0 33 2e 31 2c 20 73 71 6c 69 74 65 33 5f 73 74 65  3.1, sqlite3_ste
303c0 70 28 29 20 62 65 67 61 6e 0a 2a 2a 20 63 61 6c  p() began.** cal
303d0 6c 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 72 65  ling [sqlite3_re
303e0 73 65 74 28 29 5d 20 61 75 74 6f 6d 61 74 69 63  set()] automatic
303f0 61 6c 6c 79 20 69 6e 20 74 68 69 73 20 63 69 72  ally in this cir
30400 63 75 6d 73 74 61 6e 63 65 20 72 61 74 68 65 72  cumstance rather
30410 0a 2a 2a 20 74 68 61 6e 20 72 65 74 75 72 6e 69  .** than returni
30420 6e 67 20 5b 53 51 4c 49 54 45 5f 4d 49 53 55 53  ng [SQLITE_MISUS
30430 45 5d 2e 20 20 54 68 69 73 20 69 73 20 6e 6f 74  E].  This is not
30440 20 63 6f 6e 73 69 64 65 72 65 64 20 61 20 63 6f   considered a co
30450 6d 70 61 74 69 62 69 6c 69 74 79 0a 2a 2a 20 62  mpatibility.** b
30460 72 65 61 6b 20 62 65 63 61 75 73 65 20 61 6e 79  reak because any
30470 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 74 68 61   application tha
30480 74 20 65 76 65 72 20 72 65 63 65 69 76 65 73 20  t ever receives 
30490 61 6e 20 53 51 4c 49 54 45 5f 4d 49 53 55 53 45  an SQLITE_MISUSE
304a0 20 65 72 72 6f 72 0a 2a 2a 20 69 73 20 62 72 6f   error.** is bro
304b0 6b 65 6e 20 62 79 20 64 65 66 69 6e 69 74 69 6f  ken by definitio
304c0 6e 2e 20 20 54 68 65 20 5b 53 51 4c 49 54 45 5f  n.  The [SQLITE_
304d0 4f 4d 49 54 5f 41 55 54 4f 52 45 53 45 54 5d 20  OMIT_AUTORESET] 
304e0 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74  compile-time opt
304f0 69 6f 6e 0a 2a 2a 20 63 61 6e 20 62 65 20 75 73  ion.** can be us
30500 65 64 20 74 6f 20 72 65 73 74 6f 72 65 20 74 68  ed to restore th
30510 65 20 6c 65 67 61 63 79 20 62 65 68 61 76 69 6f  e legacy behavio
30520 72 2e 0a 2a 2a 0a 2a 2a 20 3c 62 3e 47 6f 6f 66  r..**.** <b>Goof
30530 79 20 49 6e 74 65 72 66 61 63 65 20 41 6c 65 72  y Interface Aler
30540 74 3a 3c 2f 62 3e 20 49 6e 20 74 68 65 20 6c 65  t:</b> In the le
30550 67 61 63 79 20 69 6e 74 65 72 66 61 63 65 2c 20  gacy interface, 
30560 74 68 65 20 73 71 6c 69 74 65 33 5f 73 74 65 70  the sqlite3_step
30570 28 29 0a 2a 2a 20 41 50 49 20 61 6c 77 61 79 73  ().** API always
30580 20 72 65 74 75 72 6e 73 20 61 20 67 65 6e 65 72   returns a gener
30590 69 63 20 65 72 72 6f 72 20 63 6f 64 65 2c 20 5b  ic error code, [
305a0 53 51 4c 49 54 45 5f 45 52 52 4f 52 5d 2c 20 66  SQLITE_ERROR], f
305b0 6f 6c 6c 6f 77 69 6e 67 20 61 6e 79 0a 2a 2a 20  ollowing any.** 
305c0 65 72 72 6f 72 20 6f 74 68 65 72 20 74 68 61 6e  error other than
305d0 20 5b 53 51 4c 49 54 45 5f 42 55 53 59 5d 20 61   [SQLITE_BUSY] a
305e0 6e 64 20 5b 53 51 4c 49 54 45 5f 4d 49 53 55 53  nd [SQLITE_MISUS
305f0 45 5d 2e 20 20 59 6f 75 20 6d 75 73 74 20 63 61  E].  You must ca
30600 6c 6c 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 72  ll.** [sqlite3_r
30610 65 73 65 74 28 29 5d 20 6f 72 20 5b 73 71 6c 69  eset()] or [sqli
30620 74 65 33 5f 66 69 6e 61 6c 69 7a 65 28 29 5d 20  te3_finalize()] 
30630 69 6e 20 6f 72 64 65 72 20 74 6f 20 66 69 6e 64  in order to find
30640 20 6f 6e 65 20 6f 66 20 74 68 65 0a 2a 2a 20 73   one of the.** s
30650 70 65 63 69 66 69 63 20 5b 65 72 72 6f 72 20 63  pecific [error c
30660 6f 64 65 73 5d 20 74 68 61 74 20 62 65 74 74 65  odes] that bette
30670 72 20 64 65 73 63 72 69 62 65 73 20 74 68 65 20  r describes the 
30680 65 72 72 6f 72 2e 0a 2a 2a 20 57 65 20 61 64 6d  error..** We adm
30690 69 74 20 74 68 61 74 20 74 68 69 73 20 69 73 20  it that this is 
306a0 61 20 67 6f 6f 66 79 20 64 65 73 69 67 6e 2e 20  a goofy design. 
306b0 20 54 68 65 20 70 72 6f 62 6c 65 6d 20 68 61 73   The problem has
306c0 20 62 65 65 6e 20 66 69 78 65 64 0a 2a 2a 20 77   been fixed.** w
306d0 69 74 68 20 74 68 65 20 22 76 32 22 20 69 6e 74  ith the "v2" int
306e0 65 72 66 61 63 65 2e 20 20 49 66 20 79 6f 75 20  erface.  If you 
306f0 70 72 65 70 61 72 65 20 61 6c 6c 20 6f 66 20 79  prepare all of y
30700 6f 75 72 20 53 51 4c 20 73 74 61 74 65 6d 65 6e  our SQL statemen
30710 74 73 0a 2a 2a 20 75 73 69 6e 67 20 65 69 74 68  ts.** using eith
30720 65 72 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70  er [sqlite3_prep
30730 61 72 65 5f 76 32 28 29 5d 20 6f 72 20 5b 73 71  are_v2()] or [sq
30740 6c 69 74 65 33 5f 70 72 65 70 61 72 65 31 36 5f  lite3_prepare16_
30750 76 32 28 29 5d 20 69 6e 73 74 65 61 64 0a 2a 2a  v2()] instead.**
30760 20 6f 66 20 74 68 65 20 6c 65 67 61 63 79 20 5b   of the legacy [
30770 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 28  sqlite3_prepare(
30780 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f  )] and [sqlite3_
30790 70 72 65 70 61 72 65 31 36 28 29 5d 20 69 6e 74  prepare16()] int
307a0 65 72 66 61 63 65 73 2c 0a 2a 2a 20 74 68 65 6e  erfaces,.** then
307b0 20 74 68 65 20 6d 6f 72 65 20 73 70 65 63 69 66   the more specif
307c0 69 63 20 5b 65 72 72 6f 72 20 63 6f 64 65 73 5d  ic [error codes]
307d0 20 61 72 65 20 72 65 74 75 72 6e 65 64 20 64 69   are returned di
307e0 72 65 63 74 6c 79 0a 2a 2a 20 62 79 20 73 71 6c  rectly.** by sql
307f0 69 74 65 33 5f 73 74 65 70 28 29 2e 20 20 54 68  ite3_step().  Th
30800 65 20 75 73 65 20 6f 66 20 74 68 65 20 22 76 32  e use of the "v2
30810 22 20 69 6e 74 65 72 66 61 63 65 20 69 73 20 72  " interface is r
30820 65 63 6f 6d 6d 65 6e 64 65 64 2e 0a 2a 2f 0a 69  ecommended..*/.i
30830 6e 74 20 73 71 6c 69 74 65 33 5f 73 74 65 70 28  nt sqlite3_step(
30840 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 29 3b 0a  sqlite3_stmt*);.
30850 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
30860 20 4e 75 6d 62 65 72 20 6f 66 20 63 6f 6c 75 6d   Number of colum
30870 6e 73 20 69 6e 20 61 20 72 65 73 75 6c 74 20 73  ns in a result s
30880 65 74 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71  et.** METHOD: sq
30890 6c 69 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a  lite3_stmt.**.**
308a0 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 64 61   ^The sqlite3_da
308b0 74 61 5f 63 6f 75 6e 74 28 50 29 20 69 6e 74 65  ta_count(P) inte
308c0 72 66 61 63 65 20 72 65 74 75 72 6e 73 20 74 68  rface returns th
308d0 65 20 6e 75 6d 62 65 72 20 6f 66 20 63 6f 6c 75  e number of colu
308e0 6d 6e 73 20 69 6e 20 74 68 65 0a 2a 2a 20 63 75  mns in the.** cu
308f0 72 72 65 6e 74 20 72 6f 77 20 6f 66 20 74 68 65  rrent row of the
30900 20 72 65 73 75 6c 74 20 73 65 74 20 6f 66 20 5b   result set of [
30910 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65  prepared stateme
30920 6e 74 5d 20 50 2e 0a 2a 2a 20 5e 49 66 20 70 72  nt] P..** ^If pr
30930 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
30940 20 50 20 64 6f 65 73 20 6e 6f 74 20 68 61 76 65   P does not have
30950 20 72 65 73 75 6c 74 73 20 72 65 61 64 79 20 74   results ready t
30960 6f 20 72 65 74 75 72 6e 0a 2a 2a 20 28 76 69 61  o return.** (via
30970 20 63 61 6c 6c 73 20 74 6f 20 74 68 65 20 5b 73   calls to the [s
30980 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 69 6e  qlite3_column_in
30990 74 20 7c 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75  t | sqlite3_colu
309a0 6d 6e 5f 2a 28 29 5d 20 6f 66 0a 2a 2a 20 69 6e  mn_*()] of.** in
309b0 74 65 72 66 61 63 65 73 29 20 74 68 65 6e 20 73  terfaces) then s
309c0 71 6c 69 74 65 33 5f 64 61 74 61 5f 63 6f 75 6e  qlite3_data_coun
309d0 74 28 50 29 20 72 65 74 75 72 6e 73 20 30 2e 0a  t(P) returns 0..
309e0 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f  ** ^The sqlite3_
309f0 64 61 74 61 5f 63 6f 75 6e 74 28 50 29 20 72 6f  data_count(P) ro
30a00 75 74 69 6e 65 20 61 6c 73 6f 20 72 65 74 75 72  utine also retur
30a10 6e 73 20 30 20 69 66 20 50 20 69 73 20 61 20 4e  ns 0 if P is a N
30a20 55 4c 4c 20 70 6f 69 6e 74 65 72 2e 0a 2a 2a 20  ULL pointer..** 
30a30 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 64 61 74  ^The sqlite3_dat
30a40 61 5f 63 6f 75 6e 74 28 50 29 20 72 6f 75 74 69  a_count(P) routi
30a50 6e 65 20 72 65 74 75 72 6e 73 20 30 20 69 66 20  ne returns 0 if 
30a60 74 68 65 20 70 72 65 76 69 6f 75 73 20 63 61 6c  the previous cal
30a70 6c 20 74 6f 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  l to.** [sqlite3
30a80 5f 73 74 65 70 5d 28 50 29 20 72 65 74 75 72 6e  _step](P) return
30a90 65 64 20 5b 53 51 4c 49 54 45 5f 44 4f 4e 45 5d  ed [SQLITE_DONE]
30aa0 2e 20 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f  .  ^The sqlite3_
30ab0 64 61 74 61 5f 63 6f 75 6e 74 28 50 29 0a 2a 2a  data_count(P).**
30ac0 20 77 69 6c 6c 20 72 65 74 75 72 6e 20 6e 6f 6e   will return non
30ad0 2d 7a 65 72 6f 20 69 66 20 70 72 65 76 69 6f 75  -zero if previou
30ae0 73 20 63 61 6c 6c 20 74 6f 20 5b 73 71 6c 69 74  s call to [sqlit
30af0 65 33 5f 73 74 65 70 5d 28 50 29 20 72 65 74 75  e3_step](P) retu
30b00 72 6e 65 64 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f  rned.** [SQLITE_
30b10 52 4f 57 5d 2c 20 65 78 63 65 70 74 20 69 6e 20  ROW], except in 
30b20 74 68 65 20 63 61 73 65 20 6f 66 20 74 68 65 20  the case of the 
30b30 5b 50 52 41 47 4d 41 20 69 6e 63 72 65 6d 65 6e  [PRAGMA incremen
30b40 74 61 6c 5f 76 61 63 75 75 6d 5d 0a 2a 2a 20 77  tal_vacuum].** w
30b50 68 65 72 65 20 69 74 20 61 6c 77 61 79 73 20 72  here it always r
30b60 65 74 75 72 6e 73 20 7a 65 72 6f 20 73 69 6e 63  eturns zero sinc
30b70 65 20 65 61 63 68 20 73 74 65 70 20 6f 66 20 74  e each step of t
30b80 68 61 74 20 6d 75 6c 74 69 2d 73 74 65 70 0a 2a  hat multi-step.*
30b90 2a 20 70 72 61 67 6d 61 20 72 65 74 75 72 6e 73  * pragma returns
30ba0 20 30 20 63 6f 6c 75 6d 6e 73 20 6f 66 20 64 61   0 columns of da
30bb0 74 61 2e 0a 2a 2a 0a 2a 2a 20 53 65 65 20 61 6c  ta..**.** See al
30bc0 73 6f 3a 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c  so: [sqlite3_col
30bd0 75 6d 6e 5f 63 6f 75 6e 74 28 29 5d 0a 2a 2f 0a  umn_count()].*/.
30be0 69 6e 74 20 73 71 6c 69 74 65 33 5f 64 61 74 61  int sqlite3_data
30bf0 5f 63 6f 75 6e 74 28 73 71 6c 69 74 65 33 5f 73  _count(sqlite3_s
30c00 74 6d 74 20 2a 70 53 74 6d 74 29 3b 0a 0a 2f 2a  tmt *pStmt);../*
30c10 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 46 75  .** CAPI3REF: Fu
30c20 6e 64 61 6d 65 6e 74 61 6c 20 44 61 74 61 74 79  ndamental Dataty
30c30 70 65 73 0a 2a 2a 20 4b 45 59 57 4f 52 44 53 3a  pes.** KEYWORDS:
30c40 20 53 51 4c 49 54 45 5f 54 45 58 54 0a 2a 2a 0a   SQLITE_TEXT.**.
30c50 2a 2a 20 5e 28 45 76 65 72 79 20 76 61 6c 75 65  ** ^(Every value
30c60 20 69 6e 20 53 51 4c 69 74 65 20 68 61 73 20 6f   in SQLite has o
30c70 6e 65 20 6f 66 20 66 69 76 65 20 66 75 6e 64 61  ne of five funda
30c80 6d 65 6e 74 61 6c 20 64 61 74 61 74 79 70 65 73  mental datatypes
30c90 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a 20  :.**.** <ul>.** 
30ca0 3c 6c 69 3e 20 36 34 2d 62 69 74 20 73 69 67 6e  <li> 64-bit sign
30cb0 65 64 20 69 6e 74 65 67 65 72 0a 2a 2a 20 3c 6c  ed integer.** <l
30cc0 69 3e 20 36 34 2d 62 69 74 20 49 45 45 45 20 66  i> 64-bit IEEE f
30cd0 6c 6f 61 74 69 6e 67 20 70 6f 69 6e 74 20 6e 75  loating point nu
30ce0 6d 62 65 72 0a 2a 2a 20 3c 6c 69 3e 20 73 74 72  mber.** <li> str
30cf0 69 6e 67 0a 2a 2a 20 3c 6c 69 3e 20 42 4c 4f 42  ing.** <li> BLOB
30d00 0a 2a 2a 20 3c 6c 69 3e 20 4e 55 4c 4c 0a 2a 2a  .** <li> NULL.**
30d10 20 3c 2f 75 6c 3e 29 5e 0a 2a 2a 0a 2a 2a 20 54   </ul>)^.**.** T
30d20 68 65 73 65 20 63 6f 6e 73 74 61 6e 74 73 20 61  hese constants a
30d30 72 65 20 63 6f 64 65 73 20 66 6f 72 20 65 61 63  re codes for eac
30d40 68 20 6f 66 20 74 68 6f 73 65 20 74 79 70 65 73  h of those types
30d50 2e 0a 2a 2a 0a 2a 2a 20 4e 6f 74 65 20 74 68 61  ..**.** Note tha
30d60 74 20 74 68 65 20 53 51 4c 49 54 45 5f 54 45 58  t the SQLITE_TEX
30d70 54 20 63 6f 6e 73 74 61 6e 74 20 77 61 73 20 61  T constant was a
30d80 6c 73 6f 20 75 73 65 64 20 69 6e 20 53 51 4c 69  lso used in SQLi
30d90 74 65 20 76 65 72 73 69 6f 6e 20 32 0a 2a 2a 20  te version 2.** 
30da0 66 6f 72 20 61 20 63 6f 6d 70 6c 65 74 65 6c 79  for a completely
30db0 20 64 69 66 66 65 72 65 6e 74 20 6d 65 61 6e 69   different meani
30dc0 6e 67 2e 20 20 53 6f 66 74 77 61 72 65 20 74 68  ng.  Software th
30dd0 61 74 20 6c 69 6e 6b 73 20 61 67 61 69 6e 73 74  at links against
30de0 20 62 6f 74 68 0a 2a 2a 20 53 51 4c 69 74 65 20   both.** SQLite 
30df0 76 65 72 73 69 6f 6e 20 32 20 61 6e 64 20 53 51  version 2 and SQ
30e00 4c 69 74 65 20 76 65 72 73 69 6f 6e 20 33 20 73  Lite version 3 s
30e10 68 6f 75 6c 64 20 75 73 65 20 53 51 4c 49 54 45  hould use SQLITE
30e20 33 5f 54 45 58 54 2c 20 6e 6f 74 0a 2a 2a 20 53  3_TEXT, not.** S
30e30 51 4c 49 54 45 5f 54 45 58 54 2e 0a 2a 2f 0a 23  QLITE_TEXT..*/.#
30e40 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4e  define SQLITE_IN
30e50 54 45 47 45 52 20 20 31 0a 23 64 65 66 69 6e 65  TEGER  1.#define
30e60 20 53 51 4c 49 54 45 5f 46 4c 4f 41 54 20 20 20   SQLITE_FLOAT   
30e70 20 32 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54   2.#define SQLIT
30e80 45 5f 42 4c 4f 42 20 20 20 20 20 34 0a 23 64 65  E_BLOB     4.#de
30e90 66 69 6e 65 20 53 51 4c 49 54 45 5f 4e 55 4c 4c  fine SQLITE_NULL
30ea0 20 20 20 20 20 35 0a 23 69 66 64 65 66 20 53 51       5.#ifdef SQ
30eb0 4c 49 54 45 5f 54 45 58 54 0a 23 20 75 6e 64 65  LITE_TEXT.# unde
30ec0 66 20 53 51 4c 49 54 45 5f 54 45 58 54 0a 23 65  f SQLITE_TEXT.#e
30ed0 6c 73 65 0a 23 20 64 65 66 69 6e 65 20 53 51 4c  lse.# define SQL
30ee0 49 54 45 5f 54 45 58 54 20 20 20 20 20 33 0a 23  ITE_TEXT     3.#
30ef0 65 6e 64 69 66 0a 23 64 65 66 69 6e 65 20 53 51  endif.#define SQ
30f00 4c 49 54 45 33 5f 54 45 58 54 20 20 20 20 20 33  LITE3_TEXT     3
30f10 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46  ../*.** CAPI3REF
30f20 3a 20 52 65 73 75 6c 74 20 56 61 6c 75 65 73 20  : Result Values 
30f30 46 72 6f 6d 20 41 20 51 75 65 72 79 0a 2a 2a 20  From A Query.** 
30f40 4b 45 59 57 4f 52 44 53 3a 20 7b 63 6f 6c 75 6d  KEYWORDS: {colum
30f50 6e 20 61 63 63 65 73 73 20 66 75 6e 63 74 69 6f  n access functio
30f60 6e 73 7d 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73  ns}.** METHOD: s
30f70 71 6c 69 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a 2a  qlite3_stmt.**.*
30f80 2a 20 5e 54 68 65 73 65 20 72 6f 75 74 69 6e 65  * ^These routine
30f90 73 20 72 65 74 75 72 6e 20 69 6e 66 6f 72 6d 61  s return informa
30fa0 74 69 6f 6e 20 61 62 6f 75 74 20 61 20 73 69 6e  tion about a sin
30fb0 67 6c 65 20 63 6f 6c 75 6d 6e 20 6f 66 20 74 68  gle column of th
30fc0 65 20 63 75 72 72 65 6e 74 0a 2a 2a 20 72 65 73  e current.** res
30fd0 75 6c 74 20 72 6f 77 20 6f 66 20 61 20 71 75 65  ult row of a que
30fe0 72 79 2e 20 20 5e 49 6e 20 65 76 65 72 79 20 63  ry.  ^In every c
30ff0 61 73 65 20 74 68 65 20 66 69 72 73 74 20 61 72  ase the first ar
31000 67 75 6d 65 6e 74 20 69 73 20 61 20 70 6f 69 6e  gument is a poin
31010 74 65 72 0a 2a 2a 20 74 6f 20 74 68 65 20 5b 70  ter.** to the [p
31020 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e  repared statemen
31030 74 5d 20 74 68 61 74 20 69 73 20 62 65 69 6e 67  t] that is being
31040 20 65 76 61 6c 75 61 74 65 64 20 28 74 68 65 20   evaluated (the 
31050 5b 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 5d 0a  [sqlite3_stmt*].
31060 2a 2a 20 74 68 61 74 20 77 61 73 20 72 65 74 75  ** that was retu
31070 72 6e 65 64 20 66 72 6f 6d 20 5b 73 71 6c 69 74  rned from [sqlit
31080 65 33 5f 70 72 65 70 61 72 65 5f 76 32 28 29 5d  e3_prepare_v2()]
31090 20 6f 72 20 6f 6e 65 20 6f 66 20 69 74 73 20 76   or one of its v
310a0 61 72 69 61 6e 74 73 29 0a 2a 2a 20 61 6e 64 20  ariants).** and 
310b0 74 68 65 20 73 65 63 6f 6e 64 20 61 72 67 75 6d  the second argum
310c0 65 6e 74 20 69 73 20 74 68 65 20 69 6e 64 65 78  ent is the index
310d0 20 6f 66 20 74 68 65 20 63 6f 6c 75 6d 6e 20 66   of the column f
310e0 6f 72 20 77 68 69 63 68 20 69 6e 66 6f 72 6d 61  or which informa
310f0 74 69 6f 6e 0a 2a 2a 20 73 68 6f 75 6c 64 20 62  tion.** should b
31100 65 20 72 65 74 75 72 6e 65 64 2e 20 5e 54 68 65  e returned. ^The
31110 20 6c 65 66 74 6d 6f 73 74 20 63 6f 6c 75 6d 6e   leftmost column
31120 20 6f 66 20 74 68 65 20 72 65 73 75 6c 74 20 73   of the result s
31130 65 74 20 68 61 73 20 74 68 65 20 69 6e 64 65 78  et has the index
31140 20 30 2e 0a 2a 2a 20 5e 54 68 65 20 6e 75 6d 62   0..** ^The numb
31150 65 72 20 6f 66 20 63 6f 6c 75 6d 6e 73 20 69 6e  er of columns in
31160 20 74 68 65 20 72 65 73 75 6c 74 20 63 61 6e 20   the result can 
31170 62 65 20 64 65 74 65 72 6d 69 6e 65 64 20 75 73  be determined us
31180 69 6e 67 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f  ing.** [sqlite3_
31190 63 6f 6c 75 6d 6e 5f 63 6f 75 6e 74 28 29 5d 2e  column_count()].
311a0 0a 2a 2a 0a 2a 2a 20 49 66 20 74 68 65 20 53 51  .**.** If the SQ
311b0 4c 20 73 74 61 74 65 6d 65 6e 74 20 64 6f 65 73  L statement does
311c0 20 6e 6f 74 20 63 75 72 72 65 6e 74 6c 79 20 70   not currently p
311d0 6f 69 6e 74 20 74 6f 20 61 20 76 61 6c 69 64 20  oint to a valid 
311e0 72 6f 77 2c 20 6f 72 20 69 66 20 74 68 65 0a 2a  row, or if the.*
311f0 2a 20 63 6f 6c 75 6d 6e 20 69 6e 64 65 78 20 69  * column index i
31200 73 20 6f 75 74 20 6f 66 20 72 61 6e 67 65 2c 20  s out of range, 
31210 74 68 65 20 72 65 73 75 6c 74 20 69 73 20 75 6e  the result is un
31220 64 65 66 69 6e 65 64 2e 0a 2a 2a 20 54 68 65 73  defined..** Thes
31230 65 20 72 6f 75 74 69 6e 65 73 20 6d 61 79 20 6f  e routines may o
31240 6e 6c 79 20 62 65 20 63 61 6c 6c 65 64 20 77 68  nly be called wh
31250 65 6e 20 74 68 65 20 6d 6f 73 74 20 72 65 63 65  en the most rece
31260 6e 74 20 63 61 6c 6c 20 74 6f 0a 2a 2a 20 5b 73  nt call to.** [s
31270 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20 68  qlite3_step()] h
31280 61 73 20 72 65 74 75 72 6e 65 64 20 5b 53 51 4c  as returned [SQL
31290 49 54 45 5f 52 4f 57 5d 20 61 6e 64 20 6e 65 69  ITE_ROW] and nei
312a0 74 68 65 72 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  ther.** [sqlite3
312b0 5f 72 65 73 65 74 28 29 5d 20 6e 6f 72 20 5b 73  _reset()] nor [s
312c0 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65 28  qlite3_finalize(
312d0 29 5d 20 68 61 76 65 20 62 65 65 6e 20 63 61 6c  )] have been cal
312e0 6c 65 64 20 73 75 62 73 65 71 75 65 6e 74 6c 79  led subsequently
312f0 2e 0a 2a 2a 20 49 66 20 61 6e 79 20 6f 66 20 74  ..** If any of t
31300 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20 61 72  hese routines ar
31310 65 20 63 61 6c 6c 65 64 20 61 66 74 65 72 20 5b  e called after [
31320 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29 5d  sqlite3_reset()]
31330 20 6f 72 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f   or.** [sqlite3_
31340 66 69 6e 61 6c 69 7a 65 28 29 5d 20 6f 72 20 61  finalize()] or a
31350 66 74 65 72 20 5b 73 71 6c 69 74 65 33 5f 73 74  fter [sqlite3_st
31360 65 70 28 29 5d 20 68 61 73 20 72 65 74 75 72 6e  ep()] has return
31370 65 64 0a 2a 2a 20 73 6f 6d 65 74 68 69 6e 67 20  ed.** something 
31380 6f 74 68 65 72 20 74 68 61 6e 20 5b 53 51 4c 49  other than [SQLI
31390 54 45 5f 52 4f 57 5d 2c 20 74 68 65 20 72 65 73  TE_ROW], the res
313a0 75 6c 74 73 20 61 72 65 20 75 6e 64 65 66 69 6e  ults are undefin
313b0 65 64 2e 0a 2a 2a 20 49 66 20 5b 73 71 6c 69 74  ed..** If [sqlit
313c0 65 33 5f 73 74 65 70 28 29 5d 20 6f 72 20 5b 73  e3_step()] or [s
313d0 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29 5d 20  qlite3_reset()] 
313e0 6f 72 20 5b 73 71 6c 69 74 65 33 5f 66 69 6e 61  or [sqlite3_fina
313f0 6c 69 7a 65 28 29 5d 0a 2a 2a 20 61 72 65 20 63  lize()].** are c
31400 61 6c 6c 65 64 20 66 72 6f 6d 20 61 20 64 69 66  alled from a dif
31410 66 65 72 65 6e 74 20 74 68 72 65 61 64 20 77 68  ferent thread wh
31420 69 6c 65 20 61 6e 79 20 6f 66 20 74 68 65 73 65  ile any of these
31430 20 72 6f 75 74 69 6e 65 73 0a 2a 2a 20 61 72 65   routines.** are
31440 20 70 65 6e 64 69 6e 67 2c 20 74 68 65 6e 20 74   pending, then t
31450 68 65 20 72 65 73 75 6c 74 73 20 61 72 65 20 75  he results are u
31460 6e 64 65 66 69 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20  ndefined..**.** 
31470 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 63 6f 6c  ^The sqlite3_col
31480 75 6d 6e 5f 74 79 70 65 28 29 20 72 6f 75 74 69  umn_type() routi
31490 6e 65 20 72 65 74 75 72 6e 73 20 74 68 65 0a 2a  ne returns the.*
314a0 2a 20 5b 53 51 4c 49 54 45 5f 49 4e 54 45 47 45  * [SQLITE_INTEGE
314b0 52 20 7c 20 64 61 74 61 74 79 70 65 20 63 6f 64  R | datatype cod
314c0 65 5d 20 66 6f 72 20 74 68 65 20 69 6e 69 74 69  e] for the initi
314d0 61 6c 20 64 61 74 61 20 74 79 70 65 0a 2a 2a 20  al data type.** 
314e0 6f 66 20 74 68 65 20 72 65 73 75 6c 74 20 63 6f  of the result co
314f0 6c 75 6d 6e 2e 20 20 5e 54 68 65 20 72 65 74 75  lumn.  ^The retu
31500 72 6e 65 64 20 76 61 6c 75 65 20 69 73 20 6f 6e  rned value is on
31510 65 20 6f 66 20 5b 53 51 4c 49 54 45 5f 49 4e 54  e of [SQLITE_INT
31520 45 47 45 52 5d 2c 0a 2a 2a 20 5b 53 51 4c 49 54  EGER],.** [SQLIT
31530 45 5f 46 4c 4f 41 54 5d 2c 20 5b 53 51 4c 49 54  E_FLOAT], [SQLIT
31540 45 5f 54 45 58 54 5d 2c 20 5b 53 51 4c 49 54 45  E_TEXT], [SQLITE
31550 5f 42 4c 4f 42 5d 2c 20 6f 72 20 5b 53 51 4c 49  _BLOB], or [SQLI
31560 54 45 5f 4e 55 4c 4c 5d 2e 20 20 54 68 65 20 76  TE_NULL].  The v
31570 61 6c 75 65 0a 2a 2a 20 72 65 74 75 72 6e 65 64  alue.** returned
31580 20 62 79 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75   by sqlite3_colu
31590 6d 6e 5f 74 79 70 65 28 29 20 69 73 20 6f 6e 6c  mn_type() is onl
315a0 79 20 6d 65 61 6e 69 6e 67 66 75 6c 20 69 66 20  y meaningful if 
315b0 6e 6f 20 74 79 70 65 0a 2a 2a 20 63 6f 6e 76 65  no type.** conve
315c0 72 73 69 6f 6e 73 20 68 61 76 65 20 6f 63 63 75  rsions have occu
315d0 72 72 65 64 20 61 73 20 64 65 73 63 72 69 62 65  rred as describe
315e0 64 20 62 65 6c 6f 77 2e 20 20 41 66 74 65 72 20  d below.  After 
315f0 61 20 74 79 70 65 20 63 6f 6e 76 65 72 73 69 6f  a type conversio
31600 6e 2c 0a 2a 2a 20 74 68 65 20 76 61 6c 75 65 20  n,.** the value 
31610 72 65 74 75 72 6e 65 64 20 62 79 20 73 71 6c 69  returned by sqli
31620 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 79 70 65 28  te3_column_type(
31630 29 20 69 73 20 75 6e 64 65 66 69 6e 65 64 2e 20  ) is undefined. 
31640 20 46 75 74 75 72 65 0a 2a 2a 20 76 65 72 73 69   Future.** versi
31650 6f 6e 73 20 6f 66 20 53 51 4c 69 74 65 20 6d 61  ons of SQLite ma
31660 79 20 63 68 61 6e 67 65 20 74 68 65 20 62 65 68  y change the beh
31670 61 76 69 6f 72 20 6f 66 20 73 71 6c 69 74 65 33  avior of sqlite3
31680 5f 63 6f 6c 75 6d 6e 5f 74 79 70 65 28 29 0a 2a  _column_type().*
31690 2a 20 66 6f 6c 6c 6f 77 69 6e 67 20 61 20 74 79  * following a ty
316a0 70 65 20 63 6f 6e 76 65 72 73 69 6f 6e 2e 0a 2a  pe conversion..*
316b0 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20 72 65 73  *.** ^If the res
316c0 75 6c 74 20 69 73 20 61 20 42 4c 4f 42 20 6f 72  ult is a BLOB or
316d0 20 55 54 46 2d 38 20 73 74 72 69 6e 67 20 74 68   UTF-8 string th
316e0 65 6e 20 74 68 65 20 73 71 6c 69 74 65 33 5f 63  en the sqlite3_c
316f0 6f 6c 75 6d 6e 5f 62 79 74 65 73 28 29 0a 2a 2a  olumn_bytes().**
31700 20 72 6f 75 74 69 6e 65 20 72 65 74 75 72 6e 73   routine returns
31710 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 62   the number of b
31720 79 74 65 73 20 69 6e 20 74 68 61 74 20 42 4c 4f  ytes in that BLO
31730 42 20 6f 72 20 73 74 72 69 6e 67 2e 0a 2a 2a 20  B or string..** 
31740 5e 49 66 20 74 68 65 20 72 65 73 75 6c 74 20 69  ^If the result i
31750 73 20 61 20 55 54 46 2d 31 36 20 73 74 72 69 6e  s a UTF-16 strin
31760 67 2c 20 74 68 65 6e 20 73 71 6c 69 74 65 33 5f  g, then sqlite3_
31770 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 28 29 20 63  column_bytes() c
31780 6f 6e 76 65 72 74 73 0a 2a 2a 20 74 68 65 20 73  onverts.** the s
31790 74 72 69 6e 67 20 74 6f 20 55 54 46 2d 38 20 61  tring to UTF-8 a
317a0 6e 64 20 74 68 65 6e 20 72 65 74 75 72 6e 73 20  nd then returns 
317b0 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 62 79  the number of by
317c0 74 65 73 2e 0a 2a 2a 20 5e 49 66 20 74 68 65 20  tes..** ^If the 
317d0 72 65 73 75 6c 74 20 69 73 20 61 20 6e 75 6d 65  result is a nume
317e0 72 69 63 20 76 61 6c 75 65 20 74 68 65 6e 20 73  ric value then s
317f0 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79  qlite3_column_by
31800 74 65 73 28 29 20 75 73 65 73 0a 2a 2a 20 5b 73  tes() uses.** [s
31810 71 6c 69 74 65 33 5f 73 6e 70 72 69 6e 74 66 28  qlite3_snprintf(
31820 29 5d 20 74 6f 20 63 6f 6e 76 65 72 74 20 74 68  )] to convert th
31830 61 74 20 76 61 6c 75 65 20 74 6f 20 61 20 55 54  at value to a UT
31840 46 2d 38 20 73 74 72 69 6e 67 20 61 6e 64 20 72  F-8 string and r
31850 65 74 75 72 6e 73 0a 2a 2a 20 74 68 65 20 6e 75  eturns.** the nu
31860 6d 62 65 72 20 6f 66 20 62 79 74 65 73 20 69 6e  mber of bytes in
31870 20 74 68 61 74 20 73 74 72 69 6e 67 2e 0a 2a 2a   that string..**
31880 20 5e 49 66 20 74 68 65 20 72 65 73 75 6c 74 20   ^If the result 
31890 69 73 20 4e 55 4c 4c 2c 20 74 68 65 6e 20 73 71  is NULL, then sq
318a0 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74  lite3_column_byt
318b0 65 73 28 29 20 72 65 74 75 72 6e 73 20 7a 65 72  es() returns zer
318c0 6f 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65  o..**.** ^If the
318d0 20 72 65 73 75 6c 74 20 69 73 20 61 20 42 4c 4f   result is a BLO
318e0 42 20 6f 72 20 55 54 46 2d 31 36 20 73 74 72 69  B or UTF-16 stri
318f0 6e 67 20 74 68 65 6e 20 74 68 65 20 73 71 6c 69  ng then the sqli
31900 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73  te3_column_bytes
31910 31 36 28 29 0a 2a 2a 20 72 6f 75 74 69 6e 65 20  16().** routine 
31920 72 65 74 75 72 6e 73 20 74 68 65 20 6e 75 6d 62  returns the numb
31930 65 72 20 6f 66 20 62 79 74 65 73 20 69 6e 20 74  er of bytes in t
31940 68 61 74 20 42 4c 4f 42 20 6f 72 20 73 74 72 69  hat BLOB or stri
31950 6e 67 2e 0a 2a 2a 20 5e 49 66 20 74 68 65 20 72  ng..** ^If the r
31960 65 73 75 6c 74 20 69 73 20 61 20 55 54 46 2d 38  esult is a UTF-8
31970 20 73 74 72 69 6e 67 2c 20 74 68 65 6e 20 73 71   string, then sq
31980 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74  lite3_column_byt
31990 65 73 31 36 28 29 20 63 6f 6e 76 65 72 74 73 0a  es16() converts.
319a0 2a 2a 20 74 68 65 20 73 74 72 69 6e 67 20 74 6f  ** the string to
319b0 20 55 54 46 2d 31 36 20 61 6e 64 20 74 68 65 6e   UTF-16 and then
319c0 20 72 65 74 75 72 6e 73 20 74 68 65 20 6e 75 6d   returns the num
319d0 62 65 72 20 6f 66 20 62 79 74 65 73 2e 0a 2a 2a  ber of bytes..**
319e0 20 5e 49 66 20 74 68 65 20 72 65 73 75 6c 74 20   ^If the result 
319f0 69 73 20 61 20 6e 75 6d 65 72 69 63 20 76 61 6c  is a numeric val
31a00 75 65 20 74 68 65 6e 20 73 71 6c 69 74 65 33 5f  ue then sqlite3_
31a10 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 31 36 28 29  column_bytes16()
31a20 20 75 73 65 73 0a 2a 2a 20 5b 73 71 6c 69 74 65   uses.** [sqlite
31a30 33 5f 73 6e 70 72 69 6e 74 66 28 29 5d 20 74 6f  3_snprintf()] to
31a40 20 63 6f 6e 76 65 72 74 20 74 68 61 74 20 76 61   convert that va
31a50 6c 75 65 20 74 6f 20 61 20 55 54 46 2d 31 36 20  lue to a UTF-16 
31a60 73 74 72 69 6e 67 20 61 6e 64 20 72 65 74 75 72  string and retur
31a70 6e 73 0a 2a 2a 20 74 68 65 20 6e 75 6d 62 65 72  ns.** the number
31a80 20 6f 66 20 62 79 74 65 73 20 69 6e 20 74 68 61   of bytes in tha
31a90 74 20 73 74 72 69 6e 67 2e 0a 2a 2a 20 5e 49 66  t string..** ^If
31aa0 20 74 68 65 20 72 65 73 75 6c 74 20 69 73 20 4e   the result is N
31ab0 55 4c 4c 2c 20 74 68 65 6e 20 73 71 6c 69 74 65  ULL, then sqlite
31ac0 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 31 36  3_column_bytes16
31ad0 28 29 20 72 65 74 75 72 6e 73 20 7a 65 72 6f 2e  () returns zero.
31ae0 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 76 61 6c 75  .**.** ^The valu
31af0 65 73 20 72 65 74 75 72 6e 65 64 20 62 79 20 5b  es returned by [
31b00 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62  sqlite3_column_b
31b10 79 74 65 73 28 29 5d 20 61 6e 64 20 0a 2a 2a 20  ytes()] and .** 
31b20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f  [sqlite3_column_
31b30 62 79 74 65 73 31 36 28 29 5d 20 64 6f 20 6e 6f  bytes16()] do no
31b40 74 20 69 6e 63 6c 75 64 65 20 74 68 65 20 7a 65  t include the ze
31b50 72 6f 20 74 65 72 6d 69 6e 61 74 6f 72 73 20 61  ro terminators a
31b60 74 20 74 68 65 20 65 6e 64 0a 2a 2a 20 6f 66 20  t the end.** of 
31b70 74 68 65 20 73 74 72 69 6e 67 2e 20 20 5e 46 6f  the string.  ^Fo
31b80 72 20 63 6c 61 72 69 74 79 3a 20 74 68 65 20 76  r clarity: the v
31b90 61 6c 75 65 73 20 72 65 74 75 72 6e 65 64 20 62  alues returned b
31ba0 79 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63 6f  y.** [sqlite3_co
31bb0 6c 75 6d 6e 5f 62 79 74 65 73 28 29 5d 20 61 6e  lumn_bytes()] an
31bc0 64 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d  d [sqlite3_colum
31bd0 6e 5f 62 79 74 65 73 31 36 28 29 5d 20 61 72 65  n_bytes16()] are
31be0 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 0a 2a   the number of.*
31bf0 2a 20 62 79 74 65 73 20 69 6e 20 74 68 65 20 73  * bytes in the s
31c00 74 72 69 6e 67 2c 20 6e 6f 74 20 74 68 65 20 6e  tring, not the n
31c10 75 6d 62 65 72 20 6f 66 20 63 68 61 72 61 63 74  umber of charact
31c20 65 72 73 2e 0a 2a 2a 0a 2a 2a 20 5e 53 74 72 69  ers..**.** ^Stri
31c30 6e 67 73 20 72 65 74 75 72 6e 65 64 20 62 79 20  ngs returned by 
31c40 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74  sqlite3_column_t
31c50 65 78 74 28 29 20 61 6e 64 20 73 71 6c 69 74 65  ext() and sqlite
31c60 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 31 36 28  3_column_text16(
31c70 29 2c 0a 2a 2a 20 65 76 65 6e 20 65 6d 70 74 79  ),.** even empty
31c80 20 73 74 72 69 6e 67 73 2c 20 61 72 65 20 61 6c   strings, are al
31c90 77 61 79 73 20 7a 65 72 6f 2d 74 65 72 6d 69 6e  ways zero-termin
31ca0 61 74 65 64 2e 20 20 5e 54 68 65 20 72 65 74 75  ated.  ^The retu
31cb0 72 6e 0a 2a 2a 20 76 61 6c 75 65 20 66 72 6f 6d  rn.** value from
31cc0 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f   sqlite3_column_
31cd0 62 6c 6f 62 28 29 20 66 6f 72 20 61 20 7a 65 72  blob() for a zer
31ce0 6f 2d 6c 65 6e 67 74 68 20 42 4c 4f 42 20 69 73  o-length BLOB is
31cf0 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 2e   a NULL pointer.
31d00 0a 2a 2a 0a 2a 2a 20 3c 62 3e 57 61 72 6e 69 6e  .**.** <b>Warnin
31d10 67 3a 3c 2f 62 3e 20 5e 54 68 65 20 6f 62 6a 65  g:</b> ^The obje
31d20 63 74 20 72 65 74 75 72 6e 65 64 20 62 79 20 5b  ct returned by [
31d30 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 76  sqlite3_column_v
31d40 61 6c 75 65 28 29 5d 20 69 73 20 61 6e 0a 2a 2a  alue()] is an.**
31d50 20 5b 75 6e 70 72 6f 74 65 63 74 65 64 20 73 71   [unprotected sq
31d60 6c 69 74 65 33 5f 76 61 6c 75 65 5d 20 6f 62 6a  lite3_value] obj
31d70 65 63 74 2e 20 20 49 6e 20 61 20 6d 75 6c 74 69  ect.  In a multi
31d80 74 68 72 65 61 64 65 64 20 65 6e 76 69 72 6f 6e  threaded environ
31d90 6d 65 6e 74 2c 0a 2a 2a 20 61 6e 20 75 6e 70 72  ment,.** an unpr
31da0 6f 74 65 63 74 65 64 20 73 71 6c 69 74 65 33 5f  otected sqlite3_
31db0 76 61 6c 75 65 20 6f 62 6a 65 63 74 20 6d 61 79  value object may
31dc0 20 6f 6e 6c 79 20 62 65 20 75 73 65 64 20 73 61   only be used sa
31dd0 66 65 6c 79 20 77 69 74 68 0a 2a 2a 20 5b 73 71  fely with.** [sq
31de0 6c 69 74 65 33 5f 62 69 6e 64 5f 76 61 6c 75 65  lite3_bind_value
31df0 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65 33  ()] and [sqlite3
31e00 5f 72 65 73 75 6c 74 5f 76 61 6c 75 65 28 29 5d  _result_value()]
31e10 2e 0a 2a 2a 20 49 66 20 74 68 65 20 5b 75 6e 70  ..** If the [unp
31e20 72 6f 74 65 63 74 65 64 20 73 71 6c 69 74 65 33  rotected sqlite3
31e30 5f 76 61 6c 75 65 5d 20 6f 62 6a 65 63 74 20 72  _value] object r
31e40 65 74 75 72 6e 65 64 20 62 79 0a 2a 2a 20 5b 73  eturned by.** [s
31e50 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 76 61  qlite3_column_va
31e60 6c 75 65 28 29 5d 20 69 73 20 75 73 65 64 20 69  lue()] is used i
31e70 6e 20 61 6e 79 20 6f 74 68 65 72 20 77 61 79 2c  n any other way,
31e80 20 69 6e 63 6c 75 64 69 6e 67 20 63 61 6c 6c 73   including calls
31e90 0a 2a 2a 20 74 6f 20 72 6f 75 74 69 6e 65 73 20  .** to routines 
31ea0 6c 69 6b 65 20 5b 73 71 6c 69 74 65 33 5f 76 61  like [sqlite3_va
31eb0 6c 75 65 5f 69 6e 74 28 29 5d 2c 20 5b 73 71 6c  lue_int()], [sql
31ec0 69 74 65 33 5f 76 61 6c 75 65 5f 74 65 78 74 28  ite3_value_text(
31ed0 29 5d 2c 0a 2a 2a 20 6f 72 20 5b 73 71 6c 69 74  )],.** or [sqlit
31ee0 65 33 5f 76 61 6c 75 65 5f 62 79 74 65 73 28 29  e3_value_bytes()
31ef0 5d 2c 20 74 68 65 20 62 65 68 61 76 69 6f 72 20  ], the behavior 
31f00 69 73 20 6e 6f 74 20 74 68 72 65 61 64 73 61 66  is not threadsaf
31f10 65 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 72  e..**.** These r
31f20 6f 75 74 69 6e 65 73 20 61 74 74 65 6d 70 74 20  outines attempt 
31f30 74 6f 20 63 6f 6e 76 65 72 74 20 74 68 65 20 76  to convert the v
31f40 61 6c 75 65 20 77 68 65 72 65 20 61 70 70 72 6f  alue where appro
31f50 70 72 69 61 74 65 2e 20 20 5e 46 6f 72 0a 2a 2a  priate.  ^For.**
31f60 20 65 78 61 6d 70 6c 65 2c 20 69 66 20 74 68 65   example, if the
31f70 20 69 6e 74 65 72 6e 61 6c 20 72 65 70 72 65 73   internal repres
31f80 65 6e 74 61 74 69 6f 6e 20 69 73 20 46 4c 4f 41  entation is FLOA
31f90 54 20 61 6e 64 20 61 20 74 65 78 74 20 72 65 73  T and a text res
31fa0 75 6c 74 0a 2a 2a 20 69 73 20 72 65 71 75 65 73  ult.** is reques
31fb0 74 65 64 2c 20 5b 73 71 6c 69 74 65 33 5f 73 6e  ted, [sqlite3_sn
31fc0 70 72 69 6e 74 66 28 29 5d 20 69 73 20 75 73 65  printf()] is use
31fd0 64 20 69 6e 74 65 72 6e 61 6c 6c 79 20 74 6f 20  d internally to 
31fe0 70 65 72 66 6f 72 6d 20 74 68 65 0a 2a 2a 20 63  perform the.** c
31ff0 6f 6e 76 65 72 73 69 6f 6e 20 61 75 74 6f 6d 61  onversion automa
32000 74 69 63 61 6c 6c 79 2e 20 20 5e 28 54 68 65 20  tically.  ^(The 
32010 66 6f 6c 6c 6f 77 69 6e 67 20 74 61 62 6c 65 20  following table 
32020 64 65 74 61 69 6c 73 20 74 68 65 20 63 6f 6e 76  details the conv
32030 65 72 73 69 6f 6e 73 0a 2a 2a 20 74 68 61 74 20  ersions.** that 
32040 61 72 65 20 61 70 70 6c 69 65 64 3a 0a 2a 2a 0a  are applied:.**.
32050 2a 2a 20 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a  ** <blockquote>.
32060 2a 2a 20 3c 74 61 62 6c 65 20 62 6f 72 64 65 72  ** <table border
32070 3d 22 31 22 3e 0a 2a 2a 20 3c 74 72 3e 3c 74 68  ="1">.** <tr><th
32080 3e 20 49 6e 74 65 72 6e 61 6c 3c 62 72 3e 54 79  > Internal<br>Ty
32090 70 65 20 3c 74 68 3e 20 52 65 71 75 65 73 74 65  pe <th> Requeste
320a0 64 3c 62 72 3e 54 79 70 65 20 3c 74 68 3e 20 20  d<br>Type <th>  
320b0 43 6f 6e 76 65 72 73 69 6f 6e 0a 2a 2a 0a 2a 2a  Conversion.**.**
320c0 20 3c 74 72 3e 3c 74 64 3e 20 20 4e 55 4c 4c 20   <tr><td>  NULL 
320d0 20 20 20 3c 74 64 3e 20 49 4e 54 45 47 45 52 20     <td> INTEGER 
320e0 20 20 3c 74 64 3e 20 52 65 73 75 6c 74 20 69 73    <td> Result is
320f0 20 30 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 20   0.** <tr><td>  
32100 4e 55 4c 4c 20 20 20 20 3c 74 64 3e 20 20 46 4c  NULL    <td>  FL
32110 4f 41 54 20 20 20 20 3c 74 64 3e 20 52 65 73 75  OAT    <td> Resu
32120 6c 74 20 69 73 20 30 2e 30 0a 2a 2a 20 3c 74 72  lt is 0.0.** <tr
32130 3e 3c 74 64 3e 20 20 4e 55 4c 4c 20 20 20 20 3c  ><td>  NULL    <
32140 74 64 3e 20 20 20 54 45 58 54 20 20 20 20 3c 74  td>   TEXT    <t
32150 64 3e 20 52 65 73 75 6c 74 20 69 73 20 61 20 4e  d> Result is a N
32160 55 4c 4c 20 70 6f 69 6e 74 65 72 0a 2a 2a 20 3c  ULL pointer.** <
32170 74 72 3e 3c 74 64 3e 20 20 4e 55 4c 4c 20 20 20  tr><td>  NULL   
32180 20 3c 74 64 3e 20 20 20 42 4c 4f 42 20 20 20 20   <td>   BLOB    
32190 3c 74 64 3e 20 52 65 73 75 6c 74 20 69 73 20 61  <td> Result is a
321a0 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 0a 2a 2a   NULL pointer.**
321b0 20 3c 74 72 3e 3c 74 64 3e 20 49 4e 54 45 47 45   <tr><td> INTEGE
321c0 52 20 20 3c 74 64 3e 20 20 46 4c 4f 41 54 20 20  R  <td>  FLOAT  
321d0 20 20 3c 74 64 3e 20 43 6f 6e 76 65 72 74 20 66    <td> Convert f
321e0 72 6f 6d 20 69 6e 74 65 67 65 72 20 74 6f 20 66  rom integer to f
321f0 6c 6f 61 74 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e  loat.** <tr><td>
32200 20 49 4e 54 45 47 45 52 20 20 3c 74 64 3e 20 20   INTEGER  <td>  
32210 20 54 45 58 54 20 20 20 20 3c 74 64 3e 20 41 53   TEXT    <td> AS
32220 43 49 49 20 72 65 6e 64 65 72 69 6e 67 20 6f 66  CII rendering of
32230 20 74 68 65 20 69 6e 74 65 67 65 72 0a 2a 2a 20   the integer.** 
32240 3c 74 72 3e 3c 74 64 3e 20 49 4e 54 45 47 45 52  <tr><td> INTEGER
32250 20 20 3c 74 64 3e 20 20 20 42 4c 4f 42 20 20 20    <td>   BLOB   
32260 20 3c 74 64 3e 20 53 61 6d 65 20 61 73 20 49 4e   <td> Same as IN
32270 54 45 47 45 52 2d 3e 54 45 58 54 0a 2a 2a 20 3c  TEGER->TEXT.** <
32280 74 72 3e 3c 74 64 3e 20 20 46 4c 4f 41 54 20 20  tr><td>  FLOAT  
32290 20 3c 74 64 3e 20 49 4e 54 45 47 45 52 20 20 20   <td> INTEGER   
322a0 3c 74 64 3e 20 5b 43 41 53 54 5d 20 74 6f 20 49  <td> [CAST] to I
322b0 4e 54 45 47 45 52 0a 2a 2a 20 3c 74 72 3e 3c 74  NTEGER.** <tr><t
322c0 64 3e 20 20 46 4c 4f 41 54 20 20 20 3c 74 64 3e  d>  FLOAT   <td>
322d0 20 20 20 54 45 58 54 20 20 20 20 3c 74 64 3e 20     TEXT    <td> 
322e0 41 53 43 49 49 20 72 65 6e 64 65 72 69 6e 67 20  ASCII rendering 
322f0 6f 66 20 74 68 65 20 66 6c 6f 61 74 0a 2a 2a 20  of the float.** 
32300 3c 74 72 3e 3c 74 64 3e 20 20 46 4c 4f 41 54 20  <tr><td>  FLOAT 
32310 20 20 3c 74 64 3e 20 20 20 42 4c 4f 42 20 20 20    <td>   BLOB   
32320 20 3c 74 64 3e 20 5b 43 41 53 54 5d 20 74 6f 20   <td> [CAST] to 
32330 42 4c 4f 42 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e  BLOB.** <tr><td>
32340 20 20 54 45 58 54 20 20 20 20 3c 74 64 3e 20 49    TEXT    <td> I
32350 4e 54 45 47 45 52 20 20 20 3c 74 64 3e 20 5b 43  NTEGER   <td> [C
32360 41 53 54 5d 20 74 6f 20 49 4e 54 45 47 45 52 0a  AST] to INTEGER.
32370 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 20 54 45 58  ** <tr><td>  TEX
32380 54 20 20 20 20 3c 74 64 3e 20 20 46 4c 4f 41 54  T    <td>  FLOAT
32390 20 20 20 20 3c 74 64 3e 20 5b 43 41 53 54 5d 20      <td> [CAST] 
323a0 74 6f 20 52 45 41 4c 0a 2a 2a 20 3c 74 72 3e 3c  to REAL.** <tr><
323b0 74 64 3e 20 20 54 45 58 54 20 20 20 20 3c 74 64  td>  TEXT    <td
323c0 3e 20 20 20 42 4c 4f 42 20 20 20 20 3c 74 64 3e  >   BLOB    <td>
323d0 20 4e 6f 20 63 68 61 6e 67 65 0a 2a 2a 20 3c 74   No change.** <t
323e0 72 3e 3c 74 64 3e 20 20 42 4c 4f 42 20 20 20 20  r><td>  BLOB    
323f0 3c 74 64 3e 20 49 4e 54 45 47 45 52 20 20 20 3c  <td> INTEGER   <
32400 74 64 3e 20 5b 43 41 53 54 5d 20 74 6f 20 49 4e  td> [CAST] to IN
32410 54 45 47 45 52 0a 2a 2a 20 3c 74 72 3e 3c 74 64  TEGER.** <tr><td
32420 3e 20 20 42 4c 4f 42 20 20 20 20 3c 74 64 3e 20  >  BLOB    <td> 
32430 20 46 4c 4f 41 54 20 20 20 20 3c 74 64 3e 20 5b   FLOAT    <td> [
32440 43 41 53 54 5d 20 74 6f 20 52 45 41 4c 0a 2a 2a  CAST] to REAL.**
32450 20 3c 74 72 3e 3c 74 64 3e 20 20 42 4c 4f 42 20   <tr><td>  BLOB 
32460 20 20 20 3c 74 64 3e 20 20 20 54 45 58 54 20 20     <td>   TEXT  
32470 20 20 3c 74 64 3e 20 41 64 64 20 61 20 7a 65 72    <td> Add a zer
32480 6f 20 74 65 72 6d 69 6e 61 74 6f 72 20 69 66 20  o terminator if 
32490 6e 65 65 64 65 64 0a 2a 2a 20 3c 2f 74 61 62 6c  needed.** </tabl
324a0 65 3e 0a 2a 2a 20 3c 2f 62 6c 6f 63 6b 71 75 6f  e>.** </blockquo
324b0 74 65 3e 29 5e 0a 2a 2a 0a 2a 2a 20 4e 6f 74 65  te>)^.**.** Note
324c0 20 74 68 61 74 20 77 68 65 6e 20 74 79 70 65 20   that when type 
324d0 63 6f 6e 76 65 72 73 69 6f 6e 73 20 6f 63 63 75  conversions occu
324e0 72 2c 20 70 6f 69 6e 74 65 72 73 20 72 65 74 75  r, pointers retu
324f0 72 6e 65 64 20 62 79 20 70 72 69 6f 72 0a 2a 2a  rned by prior.**
32500 20 63 61 6c 6c 73 20 74 6f 20 73 71 6c 69 74 65   calls to sqlite
32510 33 5f 63 6f 6c 75 6d 6e 5f 62 6c 6f 62 28 29 2c  3_column_blob(),
32520 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f   sqlite3_column_
32530 74 65 78 74 28 29 2c 20 61 6e 64 2f 6f 72 0a 2a  text(), and/or.*
32540 2a 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e  * sqlite3_column
32550 5f 74 65 78 74 31 36 28 29 20 6d 61 79 20 62 65  _text16() may be
32560 20 69 6e 76 61 6c 69 64 61 74 65 64 2e 0a 2a 2a   invalidated..**
32570 20 54 79 70 65 20 63 6f 6e 76 65 72 73 69 6f 6e   Type conversion
32580 73 20 61 6e 64 20 70 6f 69 6e 74 65 72 20 69 6e  s and pointer in
32590 76 61 6c 69 64 61 74 69 6f 6e 73 20 6d 69 67 68  validations migh
325a0 74 20 6f 63 63 75 72 0a 2a 2a 20 69 6e 20 74 68  t occur.** in th
325b0 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 63 61 73 65  e following case
325c0 73 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a  s:.**.** <ul>.**
325d0 20 3c 6c 69 3e 20 54 68 65 20 69 6e 69 74 69 61   <li> The initia
325e0 6c 20 63 6f 6e 74 65 6e 74 20 69 73 20 61 20 42  l content is a B
325f0 4c 4f 42 20 61 6e 64 20 73 71 6c 69 74 65 33 5f  LOB and sqlite3_
32600 63 6f 6c 75 6d 6e 5f 74 65 78 74 28 29 20 6f 72  column_text() or
32610 0a 2a 2a 20 20 20 20 20 20 73 71 6c 69 74 65 33  .**      sqlite3
32620 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 31 36 28 29  _column_text16()
32630 20 69 73 20 63 61 6c 6c 65 64 2e 20 20 41 20 7a   is called.  A z
32640 65 72 6f 2d 74 65 72 6d 69 6e 61 74 6f 72 20 6d  ero-terminator m
32650 69 67 68 74 0a 2a 2a 20 20 20 20 20 20 6e 65 65  ight.**      nee
32660 64 20 74 6f 20 62 65 20 61 64 64 65 64 20 74 6f  d to be added to
32670 20 74 68 65 20 73 74 72 69 6e 67 2e 3c 2f 6c 69   the string.</li
32680 3e 0a 2a 2a 20 3c 6c 69 3e 20 54 68 65 20 69 6e  >.** <li> The in
32690 69 74 69 61 6c 20 63 6f 6e 74 65 6e 74 20 69 73  itial content is
326a0 20 55 54 46 2d 38 20 74 65 78 74 20 61 6e 64 20   UTF-8 text and 
326b0 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62  sqlite3_column_b
326c0 79 74 65 73 31 36 28 29 20 6f 72 0a 2a 2a 20 20  ytes16() or.**  
326d0 20 20 20 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75      sqlite3_colu
326e0 6d 6e 5f 74 65 78 74 31 36 28 29 20 69 73 20 63  mn_text16() is c
326f0 61 6c 6c 65 64 2e 20 20 54 68 65 20 63 6f 6e 74  alled.  The cont
32700 65 6e 74 20 6d 75 73 74 20 62 65 20 63 6f 6e 76  ent must be conv
32710 65 72 74 65 64 0a 2a 2a 20 20 20 20 20 20 74 6f  erted.**      to
32720 20 55 54 46 2d 31 36 2e 3c 2f 6c 69 3e 0a 2a 2a   UTF-16.</li>.**
32730 20 3c 6c 69 3e 20 54 68 65 20 69 6e 69 74 69 61   <li> The initia
32740 6c 20 63 6f 6e 74 65 6e 74 20 69 73 20 55 54 46  l content is UTF
32750 2d 31 36 20 74 65 78 74 20 61 6e 64 20 73 71 6c  -16 text and sql
32760 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65  ite3_column_byte
32770 73 28 29 20 6f 72 0a 2a 2a 20 20 20 20 20 20 73  s() or.**      s
32780 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65  qlite3_column_te
32790 78 74 28 29 20 69 73 20 63 61 6c 6c 65 64 2e 20  xt() is called. 
327a0 20 54 68 65 20 63 6f 6e 74 65 6e 74 20 6d 75 73   The content mus
327b0 74 20 62 65 20 63 6f 6e 76 65 72 74 65 64 0a 2a  t be converted.*
327c0 2a 20 20 20 20 20 20 74 6f 20 55 54 46 2d 38 2e  *      to UTF-8.
327d0 3c 2f 6c 69 3e 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a  </li>.** </ul>.*
327e0 2a 0a 2a 2a 20 5e 43 6f 6e 76 65 72 73 69 6f 6e  *.** ^Conversion
327f0 73 20 62 65 74 77 65 65 6e 20 55 54 46 2d 31 36  s between UTF-16
32800 62 65 20 61 6e 64 20 55 54 46 2d 31 36 6c 65 20  be and UTF-16le 
32810 61 72 65 20 61 6c 77 61 79 73 20 64 6f 6e 65 20  are always done 
32820 69 6e 20 70 6c 61 63 65 20 61 6e 64 20 64 6f 0a  in place and do.
32830 2a 2a 20 6e 6f 74 20 69 6e 76 61 6c 69 64 61 74  ** not invalidat
32840 65 20 61 20 70 72 69 6f 72 20 70 6f 69 6e 74 65  e a prior pointe
32850 72 2c 20 74 68 6f 75 67 68 20 6f 66 20 63 6f 75  r, though of cou
32860 72 73 65 20 74 68 65 20 63 6f 6e 74 65 6e 74 20  rse the content 
32870 6f 66 20 74 68 65 20 62 75 66 66 65 72 0a 2a 2a  of the buffer.**
32880 20 74 68 61 74 20 74 68 65 20 70 72 69 6f 72 20   that the prior 
32890 70 6f 69 6e 74 65 72 20 72 65 66 65 72 65 6e 63  pointer referenc
328a0 65 73 20 77 69 6c 6c 20 68 61 76 65 20 62 65 65  es will have bee
328b0 6e 20 6d 6f 64 69 66 69 65 64 2e 20 20 4f 74 68  n modified.  Oth
328c0 65 72 20 6b 69 6e 64 73 0a 2a 2a 20 6f 66 20 63  er kinds.** of c
328d0 6f 6e 76 65 72 73 69 6f 6e 20 61 72 65 20 64 6f  onversion are do
328e0 6e 65 20 69 6e 20 70 6c 61 63 65 20 77 68 65 6e  ne in place when
328f0 20 69 74 20 69 73 20 70 6f 73 73 69 62 6c 65 2c   it is possible,
32900 20 62 75 74 20 73 6f 6d 65 74 69 6d 65 73 20 74   but sometimes t
32910 68 65 79 0a 2a 2a 20 61 72 65 20 6e 6f 74 20 70  hey.** are not p
32920 6f 73 73 69 62 6c 65 20 61 6e 64 20 69 6e 20 74  ossible and in t
32930 68 6f 73 65 20 63 61 73 65 73 20 70 72 69 6f 72  hose cases prior
32940 20 70 6f 69 6e 74 65 72 73 20 61 72 65 20 69 6e   pointers are in
32950 76 61 6c 69 64 61 74 65 64 2e 0a 2a 2a 0a 2a 2a  validated..**.**
32960 20 54 68 65 20 73 61 66 65 73 74 20 70 6f 6c 69   The safest poli
32970 63 79 20 69 73 20 74 6f 20 69 6e 76 6f 6b 65 20  cy is to invoke 
32980 74 68 65 73 65 20 72 6f 75 74 69 6e 65 73 0a 2a  these routines.*
32990 2a 20 69 6e 20 6f 6e 65 20 6f 66 20 74 68 65 20  * in one of the 
329a0 66 6f 6c 6c 6f 77 69 6e 67 20 77 61 79 73 3a 0a  following ways:.
329b0 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a 20 20 3c  **.** <ul>.**  <
329c0 6c 69 3e 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d  li>sqlite3_colum
329d0 6e 5f 74 65 78 74 28 29 20 66 6f 6c 6c 6f 77 65  n_text() followe
329e0 64 20 62 79 20 73 71 6c 69 74 65 33 5f 63 6f 6c  d by sqlite3_col
329f0 75 6d 6e 5f 62 79 74 65 73 28 29 3c 2f 6c 69 3e  umn_bytes()</li>
32a00 0a 2a 2a 20 20 3c 6c 69 3e 73 71 6c 69 74 65 33  .**  <li>sqlite3
32a10 5f 63 6f 6c 75 6d 6e 5f 62 6c 6f 62 28 29 20 66  _column_blob() f
32a20 6f 6c 6c 6f 77 65 64 20 62 79 20 73 71 6c 69 74  ollowed by sqlit
32a30 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 28  e3_column_bytes(
32a40 29 3c 2f 6c 69 3e 0a 2a 2a 20 20 3c 6c 69 3e 73  )</li>.**  <li>s
32a50 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65  qlite3_column_te
32a60 78 74 31 36 28 29 20 66 6f 6c 6c 6f 77 65 64 20  xt16() followed 
32a70 62 79 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d  by sqlite3_colum
32a80 6e 5f 62 79 74 65 73 31 36 28 29 3c 2f 6c 69 3e  n_bytes16()</li>
32a90 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2a 0a 2a 2a 20  .** </ul>.**.** 
32aa0 49 6e 20 6f 74 68 65 72 20 77 6f 72 64 73 2c 20  In other words, 
32ab0 79 6f 75 20 73 68 6f 75 6c 64 20 63 61 6c 6c 20  you should call 
32ac0 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74  sqlite3_column_t
32ad0 65 78 74 28 29 2c 0a 2a 2a 20 73 71 6c 69 74 65  ext(),.** sqlite
32ae0 33 5f 63 6f 6c 75 6d 6e 5f 62 6c 6f 62 28 29 2c  3_column_blob(),
32af0 20 6f 72 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75   or sqlite3_colu
32b00 6d 6e 5f 74 65 78 74 31 36 28 29 20 66 69 72 73  mn_text16() firs
32b10 74 20 74 6f 20 66 6f 72 63 65 20 74 68 65 20 72  t to force the r
32b20 65 73 75 6c 74 0a 2a 2a 20 69 6e 74 6f 20 74 68  esult.** into th
32b30 65 20 64 65 73 69 72 65 64 20 66 6f 72 6d 61 74  e desired format
32b40 2c 20 74 68 65 6e 20 69 6e 76 6f 6b 65 20 73 71  , then invoke sq
32b50 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74  lite3_column_byt
32b60 65 73 28 29 20 6f 72 0a 2a 2a 20 73 71 6c 69 74  es() or.** sqlit
32b70 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 31  e3_column_bytes1
32b80 36 28 29 20 74 6f 20 66 69 6e 64 20 74 68 65 20  6() to find the 
32b90 73 69 7a 65 20 6f 66 20 74 68 65 20 72 65 73 75  size of the resu
32ba0 6c 74 2e 20 20 44 6f 20 6e 6f 74 20 6d 69 78 20  lt.  Do not mix 
32bb0 63 61 6c 6c 73 0a 2a 2a 20 74 6f 20 73 71 6c 69  calls.** to sqli
32bc0 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 28  te3_column_text(
32bd0 29 20 6f 72 20 73 71 6c 69 74 65 33 5f 63 6f 6c  ) or sqlite3_col
32be0 75 6d 6e 5f 62 6c 6f 62 28 29 20 77 69 74 68 20  umn_blob() with 
32bf0 63 61 6c 6c 73 20 74 6f 0a 2a 2a 20 73 71 6c 69  calls to.** sqli
32c00 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73  te3_column_bytes
32c10 31 36 28 29 2c 20 61 6e 64 20 64 6f 20 6e 6f 74  16(), and do not
32c20 20 6d 69 78 20 63 61 6c 6c 73 20 74 6f 20 73 71   mix calls to sq
32c30 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78  lite3_column_tex
32c40 74 31 36 28 29 0a 2a 2a 20 77 69 74 68 20 63 61  t16().** with ca
32c50 6c 6c 73 20 74 6f 20 73 71 6c 69 74 65 33 5f 63  lls to sqlite3_c
32c60 6f 6c 75 6d 6e 5f 62 79 74 65 73 28 29 2e 0a 2a  olumn_bytes()..*
32c70 2a 0a 2a 2a 20 5e 54 68 65 20 70 6f 69 6e 74 65  *.** ^The pointe
32c80 72 73 20 72 65 74 75 72 6e 65 64 20 61 72 65 20  rs returned are 
32c90 76 61 6c 69 64 20 75 6e 74 69 6c 20 61 20 74 79  valid until a ty
32ca0 70 65 20 63 6f 6e 76 65 72 73 69 6f 6e 20 6f 63  pe conversion oc
32cb0 63 75 72 73 20 61 73 0a 2a 2a 20 64 65 73 63 72  curs as.** descr
32cc0 69 62 65 64 20 61 62 6f 76 65 2c 20 6f 72 20 75  ibed above, or u
32cd0 6e 74 69 6c 20 5b 73 71 6c 69 74 65 33 5f 73 74  ntil [sqlite3_st
32ce0 65 70 28 29 5d 20 6f 72 20 5b 73 71 6c 69 74 65  ep()] or [sqlite
32cf0 33 5f 72 65 73 65 74 28 29 5d 20 6f 72 0a 2a 2a  3_reset()] or.**
32d00 20 5b 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69   [sqlite3_finali
32d10 7a 65 28 29 5d 20 69 73 20 63 61 6c 6c 65 64 2e  ze()] is called.
32d20 20 20 5e 54 68 65 20 6d 65 6d 6f 72 79 20 73 70    ^The memory sp
32d30 61 63 65 20 75 73 65 64 20 74 6f 20 68 6f 6c 64  ace used to hold
32d40 20 73 74 72 69 6e 67 73 0a 2a 2a 20 61 6e 64 20   strings.** and 
32d50 42 4c 4f 42 73 20 69 73 20 66 72 65 65 64 20 61  BLOBs is freed a
32d60 75 74 6f 6d 61 74 69 63 61 6c 6c 79 2e 20 20 44  utomatically.  D
32d70 6f 20 3c 65 6d 3e 6e 6f 74 3c 2f 65 6d 3e 20 70  o <em>not</em> p
32d80 61 73 73 20 74 68 65 20 70 6f 69 6e 74 65 72 73  ass the pointers
32d90 20 72 65 74 75 72 6e 65 64 0a 2a 2a 20 66 72 6f   returned.** fro
32da0 6d 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d  m [sqlite3_colum
32db0 6e 5f 62 6c 6f 62 28 29 5d 2c 20 5b 73 71 6c 69  n_blob()], [sqli
32dc0 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 28  te3_column_text(
32dd0 29 5d 2c 20 65 74 63 2e 20 69 6e 74 6f 0a 2a 2a  )], etc. into.**
32de0 20 5b 73 71 6c 69 74 65 33 5f 66 72 65 65 28 29   [sqlite3_free()
32df0 5d 2e 0a 2a 2a 0a 2a 2a 20 5e 28 49 66 20 61 20  ]..**.** ^(If a 
32e00 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f  memory allocatio
32e10 6e 20 65 72 72 6f 72 20 6f 63 63 75 72 73 20 64  n error occurs d
32e20 75 72 69 6e 67 20 74 68 65 20 65 76 61 6c 75 61  uring the evalua
32e30 74 69 6f 6e 20 6f 66 20 61 6e 79 0a 2a 2a 20 6f  tion of any.** o
32e40 66 20 74 68 65 73 65 20 72 6f 75 74 69 6e 65 73  f these routines
32e50 2c 20 61 20 64 65 66 61 75 6c 74 20 76 61 6c 75  , a default valu
32e60 65 20 69 73 20 72 65 74 75 72 6e 65 64 2e 20 20  e is returned.  
32e70 54 68 65 20 64 65 66 61 75 6c 74 20 76 61 6c 75  The default valu
32e80 65 0a 2a 2a 20 69 73 20 65 69 74 68 65 72 20 74  e.** is either t
32e90 68 65 20 69 6e 74 65 67 65 72 20 30 2c 20 74 68  he integer 0, th
32ea0 65 20 66 6c 6f 61 74 69 6e 67 20 70 6f 69 6e 74  e floating point
32eb0 20 6e 75 6d 62 65 72 20 30 2e 30 2c 20 6f 72 20   number 0.0, or 
32ec0 61 20 4e 55 4c 4c 0a 2a 2a 20 70 6f 69 6e 74 65  a NULL.** pointe
32ed0 72 2e 20 20 53 75 62 73 65 71 75 65 6e 74 20 63  r.  Subsequent c
32ee0 61 6c 6c 73 20 74 6f 20 5b 73 71 6c 69 74 65 33  alls to [sqlite3
32ef0 5f 65 72 72 63 6f 64 65 28 29 5d 20 77 69 6c 6c  _errcode()] will
32f00 20 72 65 74 75 72 6e 0a 2a 2a 20 5b 53 51 4c 49   return.** [SQLI
32f10 54 45 5f 4e 4f 4d 45 4d 5d 2e 29 5e 0a 2a 2f 0a  TE_NOMEM].)^.*/.
32f20 63 6f 6e 73 74 20 76 6f 69 64 20 2a 73 71 6c 69  const void *sqli
32f30 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 6c 6f 62 28  te3_column_blob(
32f40 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69  sqlite3_stmt*, i
32f50 6e 74 20 69 43 6f 6c 29 3b 0a 69 6e 74 20 73 71  nt iCol);.int sq
32f60 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74  lite3_column_byt
32f70 65 73 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a  es(sqlite3_stmt*
32f80 2c 20 69 6e 74 20 69 43 6f 6c 29 3b 0a 69 6e 74  , int iCol);.int
32f90 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f   sqlite3_column_
32fa0 62 79 74 65 73 31 36 28 73 71 6c 69 74 65 33 5f  bytes16(sqlite3_
32fb0 73 74 6d 74 2a 2c 20 69 6e 74 20 69 43 6f 6c 29  stmt*, int iCol)
32fc0 3b 0a 64 6f 75 62 6c 65 20 73 71 6c 69 74 65 33  ;.double sqlite3
32fd0 5f 63 6f 6c 75 6d 6e 5f 64 6f 75 62 6c 65 28 73  _column_double(s
32fe0 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e  qlite3_stmt*, in
32ff0 74 20 69 43 6f 6c 29 3b 0a 69 6e 74 20 73 71 6c  t iCol);.int sql
33000 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 69 6e 74 28  ite3_column_int(
33010 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69  sqlite3_stmt*, i
33020 6e 74 20 69 43 6f 6c 29 3b 0a 73 71 6c 69 74 65  nt iCol);.sqlite
33030 33 5f 69 6e 74 36 34 20 73 71 6c 69 74 65 33 5f  3_int64 sqlite3_
33040 63 6f 6c 75 6d 6e 5f 69 6e 74 36 34 28 73 71 6c  column_int64(sql
33050 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 20  ite3_stmt*, int 
33060 69 43 6f 6c 29 3b 0a 63 6f 6e 73 74 20 75 6e 73  iCol);.const uns
33070 69 67 6e 65 64 20 63 68 61 72 20 2a 73 71 6c 69  igned char *sqli
33080 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 28  te3_column_text(
33090 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69  sqlite3_stmt*, i
330a0 6e 74 20 69 43 6f 6c 29 3b 0a 63 6f 6e 73 74 20  nt iCol);.const 
330b0 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f 63 6f  void *sqlite3_co
330c0 6c 75 6d 6e 5f 74 65 78 74 31 36 28 73 71 6c 69  lumn_text16(sqli
330d0 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 20 69  te3_stmt*, int i
330e0 43 6f 6c 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  Col);.int sqlite
330f0 33 5f 63 6f 6c 75 6d 6e 5f 74 79 70 65 28 73 71  3_column_type(sq
33100 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74  lite3_stmt*, int
33110 20 69 43 6f 6c 29 3b 0a 73 71 6c 69 74 65 33 5f   iCol);.sqlite3_
33120 76 61 6c 75 65 20 2a 73 71 6c 69 74 65 33 5f 63  value *sqlite3_c
33130 6f 6c 75 6d 6e 5f 76 61 6c 75 65 28 73 71 6c 69  olumn_value(sqli
33140 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 20 69  te3_stmt*, int i
33150 43 6f 6c 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50  Col);../*.** CAP
33160 49 33 52 45 46 3a 20 44 65 73 74 72 6f 79 20 41  I3REF: Destroy A
33170 20 50 72 65 70 61 72 65 64 20 53 74 61 74 65 6d   Prepared Statem
33180 65 6e 74 20 4f 62 6a 65 63 74 0a 2a 2a 20 44 45  ent Object.** DE
33190 53 54 52 55 43 54 4f 52 3a 20 73 71 6c 69 74 65  STRUCTOR: sqlite
331a0 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e 54 68  3_stmt.**.** ^Th
331b0 65 20 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69  e sqlite3_finali
331c0 7a 65 28 29 20 66 75 6e 63 74 69 6f 6e 20 69 73  ze() function is
331d0 20 63 61 6c 6c 65 64 20 74 6f 20 64 65 6c 65 74   called to delet
331e0 65 20 61 20 5b 70 72 65 70 61 72 65 64 20 73 74  e a [prepared st
331f0 61 74 65 6d 65 6e 74 5d 2e 0a 2a 2a 20 5e 49 66  atement]..** ^If
33200 20 74 68 65 20 6d 6f 73 74 20 72 65 63 65 6e 74   the most recent
33210 20 65 76 61 6c 75 61 74 69 6f 6e 20 6f 66 20 74   evaluation of t
33220 68 65 20 73 74 61 74 65 6d 65 6e 74 20 65 6e 63  he statement enc
33230 6f 75 6e 74 65 72 65 64 20 6e 6f 20 65 72 72 6f  ountered no erro
33240 72 73 0a 2a 2a 20 6f 72 20 69 66 20 74 68 65 20  rs.** or if the 
33250 73 74 61 74 65 6d 65 6e 74 20 69 73 20 6e 65 76  statement is nev
33260 65 72 20 62 65 65 6e 20 65 76 61 6c 75 61 74 65  er been evaluate
33270 64 2c 20 74 68 65 6e 20 73 71 6c 69 74 65 33 5f  d, then sqlite3_
33280 66 69 6e 61 6c 69 7a 65 28 29 20 72 65 74 75 72  finalize() retur
33290 6e 73 0a 2a 2a 20 53 51 4c 49 54 45 5f 4f 4b 2e  ns.** SQLITE_OK.
332a0 20 20 5e 49 66 20 74 68 65 20 6d 6f 73 74 20 72    ^If the most r
332b0 65 63 65 6e 74 20 65 76 61 6c 75 61 74 69 6f 6e  ecent evaluation
332c0 20 6f 66 20 73 74 61 74 65 6d 65 6e 74 20 53 20   of statement S 
332d0 66 61 69 6c 65 64 2c 20 74 68 65 6e 0a 2a 2a 20  failed, then.** 
332e0 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65  sqlite3_finalize
332f0 28 53 29 20 72 65 74 75 72 6e 73 20 74 68 65 20  (S) returns the 
33300 61 70 70 72 6f 70 72 69 61 74 65 20 5b 65 72 72  appropriate [err
33310 6f 72 20 63 6f 64 65 5d 20 6f 72 0a 2a 2a 20 5b  or code] or.** [
33320 65 78 74 65 6e 64 65 64 20 65 72 72 6f 72 20 63  extended error c
33330 6f 64 65 5d 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65  ode]..**.** ^The
33340 20 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a   sqlite3_finaliz
33350 65 28 53 29 20 72 6f 75 74 69 6e 65 20 63 61 6e  e(S) routine can
33360 20 62 65 20 63 61 6c 6c 65 64 20 61 74 20 61 6e   be called at an
33370 79 20 70 6f 69 6e 74 20 64 75 72 69 6e 67 0a 2a  y point during.*
33380 2a 20 74 68 65 20 6c 69 66 65 20 63 79 63 6c 65  * the life cycle
33390 20 6f 66 20 5b 70 72 65 70 61 72 65 64 20 73 74   of [prepared st
333a0 61 74 65 6d 65 6e 74 5d 20 53 3a 0a 2a 2a 20 62  atement] S:.** b
333b0 65 66 6f 72 65 20 73 74 61 74 65 6d 65 6e 74 20  efore statement 
333c0 53 20 69 73 20 65 76 65 72 20 65 76 61 6c 75 61  S is ever evalua
333d0 74 65 64 2c 20 61 66 74 65 72 0a 2a 2a 20 6f 6e  ted, after.** on
333e0 65 20 6f 72 20 6d 6f 72 65 20 63 61 6c 6c 73 20  e or more calls 
333f0 74 6f 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 65  to [sqlite3_rese
33400 74 28 29 5d 2c 20 6f 72 20 61 66 74 65 72 20 61  t()], or after a
33410 6e 79 20 63 61 6c 6c 0a 2a 2a 20 74 6f 20 5b 73  ny call.** to [s
33420 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20 72  qlite3_step()] r
33430 65 67 61 72 64 6c 65 73 73 20 6f 66 20 77 68 65  egardless of whe
33440 74 68 65 72 20 6f 72 20 6e 6f 74 20 74 68 65 20  ther or not the 
33450 73 74 61 74 65 6d 65 6e 74 20 68 61 73 0a 2a 2a  statement has.**
33460 20 63 6f 6d 70 6c 65 74 65 64 20 65 78 65 63 75   completed execu
33470 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 5e 49 6e 76  tion..**.** ^Inv
33480 6f 6b 69 6e 67 20 73 71 6c 69 74 65 33 5f 66 69  oking sqlite3_fi
33490 6e 61 6c 69 7a 65 28 29 20 6f 6e 20 61 20 4e 55  nalize() on a NU
334a0 4c 4c 20 70 6f 69 6e 74 65 72 20 69 73 20 61 20  LL pointer is a 
334b0 68 61 72 6d 6c 65 73 73 20 6e 6f 2d 6f 70 2e 0a  harmless no-op..
334c0 2a 2a 0a 2a 2a 20 54 68 65 20 61 70 70 6c 69 63  **.** The applic
334d0 61 74 69 6f 6e 20 6d 75 73 74 20 66 69 6e 61 6c  ation must final
334e0 69 7a 65 20 65 76 65 72 79 20 5b 70 72 65 70 61  ize every [prepa
334f0 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 69  red statement] i
33500 6e 20 6f 72 64 65 72 20 74 6f 20 61 76 6f 69 64  n order to avoid
33510 0a 2a 2a 20 72 65 73 6f 75 72 63 65 20 6c 65 61  .** resource lea
33520 6b 73 2e 20 20 49 74 20 69 73 20 61 20 67 72 69  ks.  It is a gri
33530 65 76 6f 75 73 20 65 72 72 6f 72 20 66 6f 72 20  evous error for 
33540 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20  the application 
33550 74 6f 20 74 72 79 20 74 6f 20 75 73 65 0a 2a 2a  to try to use.**
33560 20 61 20 70 72 65 70 61 72 65 64 20 73 74 61 74   a prepared stat
33570 65 6d 65 6e 74 20 61 66 74 65 72 20 69 74 20 68  ement after it h
33580 61 73 20 62 65 65 6e 20 66 69 6e 61 6c 69 7a 65  as been finalize
33590 64 2e 20 20 41 6e 79 20 75 73 65 20 6f 66 20 61  d.  Any use of a
335a0 20 70 72 65 70 61 72 65 64 0a 2a 2a 20 73 74 61   prepared.** sta
335b0 74 65 6d 65 6e 74 20 61 66 74 65 72 20 69 74 20  tement after it 
335c0 68 61 73 20 62 65 65 6e 20 66 69 6e 61 6c 69 7a  has been finaliz
335d0 65 64 20 63 61 6e 20 72 65 73 75 6c 74 20 69 6e  ed can result in
335e0 20 75 6e 64 65 66 69 6e 65 64 20 61 6e 64 0a 2a   undefined and.*
335f0 2a 20 75 6e 64 65 73 69 72 61 62 6c 65 20 62 65  * undesirable be
33600 68 61 76 69 6f 72 20 73 75 63 68 20 61 73 20 73  havior such as s
33610 65 67 66 61 75 6c 74 73 20 61 6e 64 20 68 65 61  egfaults and hea
33620 70 20 63 6f 72 72 75 70 74 69 6f 6e 2e 0a 2a 2f  p corruption..*/
33630 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 66 69 6e  .int sqlite3_fin
33640 61 6c 69 7a 65 28 73 71 6c 69 74 65 33 5f 73 74  alize(sqlite3_st
33650 6d 74 20 2a 70 53 74 6d 74 29 3b 0a 0a 2f 2a 0a  mt *pStmt);../*.
33660 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 52 65 73  ** CAPI3REF: Res
33670 65 74 20 41 20 50 72 65 70 61 72 65 64 20 53 74  et A Prepared St
33680 61 74 65 6d 65 6e 74 20 4f 62 6a 65 63 74 0a 2a  atement Object.*
33690 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65  * METHOD: sqlite
336a0 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 54 68 65  3_stmt.**.** The
336b0 20 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29   sqlite3_reset()
336c0 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 63 61 6c   function is cal
336d0 6c 65 64 20 74 6f 20 72 65 73 65 74 20 61 20 5b  led to reset a [
336e0 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65  prepared stateme
336f0 6e 74 5d 0a 2a 2a 20 6f 62 6a 65 63 74 20 62 61  nt].** object ba
33700 63 6b 20 74 6f 20 69 74 73 20 69 6e 69 74 69 61  ck to its initia
33710 6c 20 73 74 61 74 65 2c 20 72 65 61 64 79 20 74  l state, ready t
33720 6f 20 62 65 20 72 65 2d 65 78 65 63 75 74 65 64  o be re-executed
33730 2e 0a 2a 2a 20 5e 41 6e 79 20 53 51 4c 20 73 74  ..** ^Any SQL st
33740 61 74 65 6d 65 6e 74 20 76 61 72 69 61 62 6c 65  atement variable
33750 73 20 74 68 61 74 20 68 61 64 20 76 61 6c 75 65  s that had value
33760 73 20 62 6f 75 6e 64 20 74 6f 20 74 68 65 6d 20  s bound to them 
33770 75 73 69 6e 67 0a 2a 2a 20 74 68 65 20 5b 73 71  using.** the [sq
33780 6c 69 74 65 33 5f 62 69 6e 64 5f 62 6c 6f 62 20  lite3_bind_blob 
33790 7c 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 2a  | sqlite3_bind_*
337a0 28 29 20 41 50 49 5d 20 72 65 74 61 69 6e 20 74  () API] retain t
337b0 68 65 69 72 20 76 61 6c 75 65 73 2e 0a 2a 2a 20  heir values..** 
337c0 55 73 65 20 5b 73 71 6c 69 74 65 33 5f 63 6c 65  Use [sqlite3_cle
337d0 61 72 5f 62 69 6e 64 69 6e 67 73 28 29 5d 20 74  ar_bindings()] t
337e0 6f 20 72 65 73 65 74 20 74 68 65 20 62 69 6e 64  o reset the bind
337f0 69 6e 67 73 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65  ings..**.** ^The
33800 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28   [sqlite3_reset(
33810 53 29 5d 20 69 6e 74 65 72 66 61 63 65 20 72 65  S)] interface re
33820 73 65 74 73 20 74 68 65 20 5b 70 72 65 70 61 72  sets the [prepar
33830 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 53 0a  ed statement] S.
33840 2a 2a 20 62 61 63 6b 20 74 6f 20 74 68 65 20 62  ** back to the b
33850 65 67 69 6e 6e 69 6e 67 20 6f 66 20 69 74 73 20  eginning of its 
33860 70 72 6f 67 72 61 6d 2e 0a 2a 2a 0a 2a 2a 20 5e  program..**.** ^
33870 49 66 20 74 68 65 20 6d 6f 73 74 20 72 65 63 65  If the most rece
33880 6e 74 20 63 61 6c 6c 20 74 6f 20 5b 73 71 6c 69  nt call to [sqli
33890 74 65 33 5f 73 74 65 70 28 53 29 5d 20 66 6f 72  te3_step(S)] for
338a0 20 74 68 65 0a 2a 2a 20 5b 70 72 65 70 61 72 65   the.** [prepare
338b0 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 53 20 72  d statement] S r
338c0 65 74 75 72 6e 65 64 20 5b 53 51 4c 49 54 45 5f  eturned [SQLITE_
338d0 52 4f 57 5d 20 6f 72 20 5b 53 51 4c 49 54 45 5f  ROW] or [SQLITE_
338e0 44 4f 4e 45 5d 2c 0a 2a 2a 20 6f 72 20 69 66 20  DONE],.** or if 
338f0 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28 53 29  [sqlite3_step(S)
33900 5d 20 68 61 73 20 6e 65 76 65 72 20 62 65 66 6f  ] has never befo
33910 72 65 20 62 65 65 6e 20 63 61 6c 6c 65 64 20 6f  re been called o
33920 6e 20 53 2c 0a 2a 2a 20 74 68 65 6e 20 5b 73 71  n S,.** then [sq
33930 6c 69 74 65 33 5f 72 65 73 65 74 28 53 29 5d 20  lite3_reset(S)] 
33940 72 65 74 75 72 6e 73 20 5b 53 51 4c 49 54 45 5f  returns [SQLITE_
33950 4f 4b 5d 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74  OK]..**.** ^If t
33960 68 65 20 6d 6f 73 74 20 72 65 63 65 6e 74 20 63  he most recent c
33970 61 6c 6c 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f  all to [sqlite3_
33980 73 74 65 70 28 53 29 5d 20 66 6f 72 20 74 68 65  step(S)] for the
33990 0a 2a 2a 20 5b 70 72 65 70 61 72 65 64 20 73 74  .** [prepared st
339a0 61 74 65 6d 65 6e 74 5d 20 53 20 69 6e 64 69 63  atement] S indic
339b0 61 74 65 64 20 61 6e 20 65 72 72 6f 72 2c 20 74  ated an error, t
339c0 68 65 6e 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f  hen.** [sqlite3_
339d0 72 65 73 65 74 28 53 29 5d 20 72 65 74 75 72 6e  reset(S)] return
339e0 73 20 61 6e 20 61 70 70 72 6f 70 72 69 61 74 65  s an appropriate
339f0 20 5b 65 72 72 6f 72 20 63 6f 64 65 5d 2e 0a 2a   [error code]..*
33a00 2a 0a 2a 2a 20 5e 54 68 65 20 5b 73 71 6c 69 74  *.** ^The [sqlit
33a10 65 33 5f 72 65 73 65 74 28 53 29 5d 20 69 6e 74  e3_reset(S)] int
33a20 65 72 66 61 63 65 20 64 6f 65 73 20 6e 6f 74 20  erface does not 
33a30 63 68 61 6e 67 65 20 74 68 65 20 76 61 6c 75 65  change the value
33a40 73 0a 2a 2a 20 6f 66 20 61 6e 79 20 5b 73 71 6c  s.** of any [sql
33a50 69 74 65 33 5f 62 69 6e 64 5f 62 6c 6f 62 7c 62  ite3_bind_blob|b
33a60 69 6e 64 69 6e 67 73 5d 20 6f 6e 20 74 68 65 20  indings] on the 
33a70 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d  [prepared statem
33a80 65 6e 74 5d 20 53 2e 0a 2a 2f 0a 69 6e 74 20 73  ent] S..*/.int s
33a90 71 6c 69 74 65 33 5f 72 65 73 65 74 28 73 71 6c  qlite3_reset(sql
33aa0 69 74 65 33 5f 73 74 6d 74 20 2a 70 53 74 6d 74  ite3_stmt *pStmt
33ab0 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  );../*.** CAPI3R
33ac0 45 46 3a 20 43 72 65 61 74 65 20 4f 72 20 52 65  EF: Create Or Re
33ad0 64 65 66 69 6e 65 20 53 51 4c 20 46 75 6e 63 74  define SQL Funct
33ae0 69 6f 6e 73 0a 2a 2a 20 4b 45 59 57 4f 52 44 53  ions.** KEYWORDS
33af0 3a 20 7b 66 75 6e 63 74 69 6f 6e 20 63 72 65 61  : {function crea
33b00 74 69 6f 6e 20 72 6f 75 74 69 6e 65 73 7d 0a 2a  tion routines}.*
33b10 2a 20 4b 45 59 57 4f 52 44 53 3a 20 7b 61 70 70  * KEYWORDS: {app
33b20 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64  lication-defined
33b30 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 7d 0a 2a   SQL function}.*
33b40 2a 20 4b 45 59 57 4f 52 44 53 3a 20 7b 61 70 70  * KEYWORDS: {app
33b50 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64  lication-defined
33b60 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 73 7d 0a   SQL functions}.
33b70 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74  ** METHOD: sqlit
33b80 65 33 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 73 65 20  e3.**.** ^These 
33b90 66 75 6e 63 74 69 6f 6e 73 20 28 63 6f 6c 6c 65  functions (colle
33ba0 63 74 69 76 65 6c 79 20 6b 6e 6f 77 6e 20 61 73  ctively known as
33bb0 20 22 66 75 6e 63 74 69 6f 6e 20 63 72 65 61 74   "function creat
33bc0 69 6f 6e 20 72 6f 75 74 69 6e 65 73 22 29 0a 2a  ion routines").*
33bd0 2a 20 61 72 65 20 75 73 65 64 20 74 6f 20 61 64  * are used to ad
33be0 64 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 73 20  d SQL functions 
33bf0 6f 72 20 61 67 67 72 65 67 61 74 65 73 20 6f 72  or aggregates or
33c00 20 74 6f 20 72 65 64 65 66 69 6e 65 20 74 68 65   to redefine the
33c10 20 62 65 68 61 76 69 6f 72 0a 2a 2a 20 6f 66 20   behavior.** of 
33c20 65 78 69 73 74 69 6e 67 20 53 51 4c 20 66 75 6e  existing SQL fun
33c30 63 74 69 6f 6e 73 20 6f 72 20 61 67 67 72 65 67  ctions or aggreg
33c40 61 74 65 73 2e 20 20 54 68 65 20 6f 6e 6c 79 20  ates.  The only 
33c50 64 69 66 66 65 72 65 6e 63 65 73 20 62 65 74 77  differences betw
33c60 65 65 6e 0a 2a 2a 20 74 68 65 73 65 20 72 6f 75  een.** these rou
33c70 74 69 6e 65 73 20 61 72 65 20 74 68 65 20 74 65  tines are the te
33c80 78 74 20 65 6e 63 6f 64 69 6e 67 20 65 78 70 65  xt encoding expe
33c90 63 74 65 64 20 66 6f 72 0a 2a 2a 20 74 68 65 20  cted for.** the 
33ca0 73 65 63 6f 6e 64 20 70 61 72 61 6d 65 74 65 72  second parameter
33cb0 20 28 74 68 65 20 6e 61 6d 65 20 6f 66 20 74 68   (the name of th
33cc0 65 20 66 75 6e 63 74 69 6f 6e 20 62 65 69 6e 67  e function being
33cd0 20 63 72 65 61 74 65 64 29 0a 2a 2a 20 61 6e 64   created).** and
33ce0 20 74 68 65 20 70 72 65 73 65 6e 63 65 20 6f 72   the presence or
33cf0 20 61 62 73 65 6e 63 65 20 6f 66 20 61 20 64 65   absence of a de
33d00 73 74 72 75 63 74 6f 72 20 63 61 6c 6c 62 61 63  structor callbac
33d10 6b 20 66 6f 72 0a 2a 2a 20 74 68 65 20 61 70 70  k for.** the app
33d20 6c 69 63 61 74 69 6f 6e 20 64 61 74 61 20 70 6f  lication data po
33d30 69 6e 74 65 72 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68  inter..**.** ^Th
33d40 65 20 66 69 72 73 74 20 70 61 72 61 6d 65 74 65  e first paramete
33d50 72 20 69 73 20 74 68 65 20 5b 64 61 74 61 62 61  r is the [databa
33d60 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 74  se connection] t
33d70 6f 20 77 68 69 63 68 20 74 68 65 20 53 51 4c 0a  o which the SQL.
33d80 2a 2a 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 74  ** function is t
33d90 6f 20 62 65 20 61 64 64 65 64 2e 20 20 5e 49 66  o be added.  ^If
33da0 20 61 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e 20   an application 
33db0 75 73 65 73 20 6d 6f 72 65 20 74 68 61 6e 20 6f  uses more than o
33dc0 6e 65 20 64 61 74 61 62 61 73 65 0a 2a 2a 20 63  ne database.** c
33dd0 6f 6e 6e 65 63 74 69 6f 6e 20 74 68 65 6e 20 61  onnection then a
33de0 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e  pplication-defin
33df0 65 64 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 73  ed SQL functions
33e00 20 6d 75 73 74 20 62 65 20 61 64 64 65 64 0a 2a   must be added.*
33e10 2a 20 74 6f 20 65 61 63 68 20 64 61 74 61 62 61  * to each databa
33e20 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 73 65  se connection se
33e30 70 61 72 61 74 65 6c 79 2e 0a 2a 2a 0a 2a 2a 20  parately..**.** 
33e40 5e 54 68 65 20 73 65 63 6f 6e 64 20 70 61 72 61  ^The second para
33e50 6d 65 74 65 72 20 69 73 20 74 68 65 20 6e 61 6d  meter is the nam
33e60 65 20 6f 66 20 74 68 65 20 53 51 4c 20 66 75 6e  e of the SQL fun
33e70 63 74 69 6f 6e 20 74 6f 20 62 65 20 63 72 65 61  ction to be crea
33e80 74 65 64 20 6f 72 0a 2a 2a 20 72 65 64 65 66 69  ted or.** redefi
33e90 6e 65 64 2e 20 20 5e 54 68 65 20 6c 65 6e 67 74  ned.  ^The lengt
33ea0 68 20 6f 66 20 74 68 65 20 6e 61 6d 65 20 69 73  h of the name is
33eb0 20 6c 69 6d 69 74 65 64 20 74 6f 20 32 35 35 20   limited to 255 
33ec0 62 79 74 65 73 20 69 6e 20 61 20 55 54 46 2d 38  bytes in a UTF-8
33ed0 0a 2a 2a 20 72 65 70 72 65 73 65 6e 74 61 74 69  .** representati
33ee0 6f 6e 2c 20 65 78 63 6c 75 73 69 76 65 20 6f 66  on, exclusive of
33ef0 20 74 68 65 20 7a 65 72 6f 2d 74 65 72 6d 69 6e   the zero-termin
33f00 61 74 6f 72 2e 20 20 5e 4e 6f 74 65 20 74 68 61  ator.  ^Note tha
33f10 74 20 74 68 65 20 6e 61 6d 65 0a 2a 2a 20 6c 65  t the name.** le
33f20 6e 67 74 68 20 6c 69 6d 69 74 20 69 73 20 69 6e  ngth limit is in
33f30 20 55 54 46 2d 38 20 62 79 74 65 73 2c 20 6e 6f   UTF-8 bytes, no
33f40 74 20 63 68 61 72 61 63 74 65 72 73 20 6e 6f 72  t characters nor
33f50 20 55 54 46 2d 31 36 20 62 79 74 65 73 2e 20 20   UTF-16 bytes.  
33f60 0a 2a 2a 20 5e 41 6e 79 20 61 74 74 65 6d 70 74  .** ^Any attempt
33f70 20 74 6f 20 63 72 65 61 74 65 20 61 20 66 75 6e   to create a fun
33f80 63 74 69 6f 6e 20 77 69 74 68 20 61 20 6c 6f 6e  ction with a lon
33f90 67 65 72 20 6e 61 6d 65 0a 2a 2a 20 77 69 6c 6c  ger name.** will
33fa0 20 72 65 73 75 6c 74 20 69 6e 20 5b 53 51 4c 49   result in [SQLI
33fb0 54 45 5f 4d 49 53 55 53 45 5d 20 62 65 69 6e 67  TE_MISUSE] being
33fc0 20 72 65 74 75 72 6e 65 64 2e 0a 2a 2a 0a 2a 2a   returned..**.**
33fd0 20 5e 54 68 65 20 74 68 69 72 64 20 70 61 72 61   ^The third para
33fe0 6d 65 74 65 72 20 28 6e 41 72 67 29 0a 2a 2a 20  meter (nArg).** 
33ff0 69 73 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66  is the number of
34000 20 61 72 67 75 6d 65 6e 74 73 20 74 68 61 74 20   arguments that 
34010 74 68 65 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e  the SQL function
34020 20 6f 72 0a 2a 2a 20 61 67 67 72 65 67 61 74 65   or.** aggregate
34030 20 74 61 6b 65 73 2e 20 5e 49 66 20 74 68 69 73   takes. ^If this
34040 20 70 61 72 61 6d 65 74 65 72 20 69 73 20 2d 31   parameter is -1
34050 2c 20 74 68 65 6e 20 74 68 65 20 53 51 4c 20 66  , then the SQL f
34060 75 6e 63 74 69 6f 6e 20 6f 72 0a 2a 2a 20 61 67  unction or.** ag
34070 67 72 65 67 61 74 65 20 6d 61 79 20 74 61 6b 65  gregate may take
34080 20 61 6e 79 20 6e 75 6d 62 65 72 20 6f 66 20 61   any number of a
34090 72 67 75 6d 65 6e 74 73 20 62 65 74 77 65 65 6e  rguments between
340a0 20 30 20 61 6e 64 20 74 68 65 20 6c 69 6d 69 74   0 and the limit
340b0 0a 2a 2a 20 73 65 74 20 62 79 20 5b 73 71 6c 69  .** set by [sqli
340c0 74 65 33 5f 6c 69 6d 69 74 5d 28 5b 53 51 4c 49  te3_limit]([SQLI
340d0 54 45 5f 4c 49 4d 49 54 5f 46 55 4e 43 54 49 4f  TE_LIMIT_FUNCTIO
340e0 4e 5f 41 52 47 5d 29 2e 20 20 49 66 20 74 68 65  N_ARG]).  If the
340f0 20 74 68 69 72 64 0a 2a 2a 20 70 61 72 61 6d 65   third.** parame
34100 74 65 72 20 69 73 20 6c 65 73 73 20 74 68 61 6e  ter is less than
34110 20 2d 31 20 6f 72 20 67 72 65 61 74 65 72 20 74   -1 or greater t
34120 68 61 6e 20 31 32 37 20 74 68 65 6e 20 74 68 65  han 127 then the
34130 20 62 65 68 61 76 69 6f 72 20 69 73 0a 2a 2a 20   behavior is.** 
34140 75 6e 64 65 66 69 6e 65 64 2e 0a 2a 2a 0a 2a 2a  undefined..**.**
34150 20 5e 54 68 65 20 66 6f 75 72 74 68 20 70 61 72   ^The fourth par
34160 61 6d 65 74 65 72 2c 20 65 54 65 78 74 52 65 70  ameter, eTextRep
34170 2c 20 73 70 65 63 69 66 69 65 73 20 77 68 61 74  , specifies what
34180 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 55 54 46 38  .** [SQLITE_UTF8
34190 20 7c 20 74 65 78 74 20 65 6e 63 6f 64 69 6e 67   | text encoding
341a0 5d 20 74 68 69 73 20 53 51 4c 20 66 75 6e 63 74  ] this SQL funct
341b0 69 6f 6e 20 70 72 65 66 65 72 73 20 66 6f 72 0a  ion prefers for.
341c0 2a 2a 20 69 74 73 20 70 61 72 61 6d 65 74 65 72  ** its parameter
341d0 73 2e 20 20 54 68 65 20 61 70 70 6c 69 63 61 74  s.  The applicat
341e0 69 6f 6e 20 73 68 6f 75 6c 64 20 73 65 74 20 74  ion should set t
341f0 68 69 73 20 70 61 72 61 6d 65 74 65 72 20 74 6f  his parameter to
34200 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 55 54 46 31  .** [SQLITE_UTF1
34210 36 4c 45 5d 20 69 66 20 74 68 65 20 66 75 6e 63  6LE] if the func
34220 74 69 6f 6e 20 69 6d 70 6c 65 6d 65 6e 74 61 74  tion implementat
34230 69 6f 6e 20 69 6e 76 6f 6b 65 73 20 0a 2a 2a 20  ion invokes .** 
34240 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 74  [sqlite3_value_t
34250 65 78 74 31 36 6c 65 28 29 5d 20 6f 6e 20 61 6e  ext16le()] on an
34260 20 69 6e 70 75 74 2c 20 6f 72 20 5b 53 51 4c 49   input, or [SQLI
34270 54 45 5f 55 54 46 31 36 42 45 5d 20 69 66 20 74  TE_UTF16BE] if t
34280 68 65 0a 2a 2a 20 69 6d 70 6c 65 6d 65 6e 74 61  he.** implementa
34290 74 69 6f 6e 20 69 6e 76 6f 6b 65 73 20 5b 73 71  tion invokes [sq
342a0 6c 69 74 65 33 5f 76 61 6c 75 65 5f 74 65 78 74  lite3_value_text
342b0 31 36 62 65 28 29 5d 20 6f 6e 20 61 6e 20 69 6e  16be()] on an in
342c0 70 75 74 2c 20 6f 72 0a 2a 2a 20 5b 53 51 4c 49  put, or.** [SQLI
342d0 54 45 5f 55 54 46 31 36 5d 20 69 66 20 5b 73 71  TE_UTF16] if [sq
342e0 6c 69 74 65 33 5f 76 61 6c 75 65 5f 74 65 78 74  lite3_value_text
342f0 31 36 28 29 5d 20 69 73 20 75 73 65 64 2c 20 6f  16()] is used, o
34300 72 20 5b 53 51 4c 49 54 45 5f 55 54 46 38 5d 0a  r [SQLITE_UTF8].
34310 2a 2a 20 6f 74 68 65 72 77 69 73 65 2e 20 20 5e  ** otherwise.  ^
34320 54 68 65 20 73 61 6d 65 20 53 51 4c 20 66 75 6e  The same SQL fun
34330 63 74 69 6f 6e 20 6d 61 79 20 62 65 20 72 65 67  ction may be reg
34340 69 73 74 65 72 65 64 20 6d 75 6c 74 69 70 6c 65  istered multiple
34350 20 74 69 6d 65 73 20 75 73 69 6e 67 0a 2a 2a 20   times using.** 
34360 64 69 66 66 65 72 65 6e 74 20 70 72 65 66 65 72  different prefer
34370 72 65 64 20 74 65 78 74 20 65 6e 63 6f 64 69 6e  red text encodin
34380 67 73 2c 20 77 69 74 68 20 64 69 66 66 65 72 65  gs, with differe
34390 6e 74 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f  nt implementatio
343a0 6e 73 20 66 6f 72 0a 2a 2a 20 65 61 63 68 20 65  ns for.** each e
343b0 6e 63 6f 64 69 6e 67 2e 0a 2a 2a 20 5e 57 68 65  ncoding..** ^Whe
343c0 6e 20 6d 75 6c 74 69 70 6c 65 20 69 6d 70 6c 65  n multiple imple
343d0 6d 65 6e 74 61 74 69 6f 6e 73 20 6f 66 20 74 68  mentations of th
343e0 65 20 73 61 6d 65 20 66 75 6e 63 74 69 6f 6e 20  e same function 
343f0 61 72 65 20 61 76 61 69 6c 61 62 6c 65 2c 20 53  are available, S
34400 51 4c 69 74 65 0a 2a 2a 20 77 69 6c 6c 20 70 69  QLite.** will pi
34410 63 6b 20 74 68 65 20 6f 6e 65 20 74 68 61 74 20  ck the one that 
34420 69 6e 76 6f 6c 76 65 73 20 74 68 65 20 6c 65 61  involves the lea
34430 73 74 20 61 6d 6f 75 6e 74 20 6f 66 20 64 61 74  st amount of dat
34440 61 20 63 6f 6e 76 65 72 73 69 6f 6e 2e 0a 2a 2a  a conversion..**
34450 0a 2a 2a 20 5e 54 68 65 20 66 6f 75 72 74 68 20  .** ^The fourth 
34460 70 61 72 61 6d 65 74 65 72 20 6d 61 79 20 6f 70  parameter may op
34470 74 69 6f 6e 61 6c 6c 79 20 62 65 20 4f 52 65 64  tionally be ORed
34480 20 77 69 74 68 20 5b 53 51 4c 49 54 45 5f 44 45   with [SQLITE_DE
34490 54 45 52 4d 49 4e 49 53 54 49 43 5d 0a 2a 2a 20  TERMINISTIC].** 
344a0 74 6f 20 73 69 67 6e 61 6c 20 74 68 61 74 20 74  to signal that t
344b0 68 65 20 66 75 6e 63 74 69 6f 6e 20 77 69 6c 6c  he function will
344c0 20 61 6c 77 61 79 73 20 72 65 74 75 72 6e 20 74   always return t
344d0 68 65 20 73 61 6d 65 20 72 65 73 75 6c 74 20 67  he same result g
344e0 69 76 65 6e 0a 2a 2a 20 74 68 65 20 73 61 6d 65  iven.** the same
344f0 20 69 6e 70 75 74 73 20 77 69 74 68 69 6e 20 61   inputs within a
34500 20 73 69 6e 67 6c 65 20 53 51 4c 20 73 74 61 74   single SQL stat
34510 65 6d 65 6e 74 2e 20 20 4d 6f 73 74 20 53 51 4c  ement.  Most SQL
34520 20 66 75 6e 63 74 69 6f 6e 73 20 61 72 65 0a 2a   functions are.*
34530 2a 20 64 65 74 65 72 6d 69 6e 69 73 74 69 63 2e  * deterministic.
34540 20 20 54 68 65 20 62 75 69 6c 74 2d 69 6e 20 5b    The built-in [
34550 72 61 6e 64 6f 6d 28 29 5d 20 53 51 4c 20 66 75  random()] SQL fu
34560 6e 63 74 69 6f 6e 20 69 73 20 61 6e 20 65 78 61  nction is an exa
34570 6d 70 6c 65 20 6f 66 20 61 0a 2a 2a 20 66 75 6e  mple of a.** fun
34580 63 74 69 6f 6e 20 74 68 61 74 20 69 73 20 6e 6f  ction that is no
34590 74 20 64 65 74 65 72 6d 69 6e 69 73 74 69 63 2e  t deterministic.
345a0 20 20 54 68 65 20 53 51 4c 69 74 65 20 71 75 65    The SQLite que
345b0 72 79 20 70 6c 61 6e 6e 65 72 20 69 73 20 61 62  ry planner is ab
345c0 6c 65 20 74 6f 0a 2a 2a 20 70 65 72 66 6f 72 6d  le to.** perform
345d0 20 61 64 64 69 74 69 6f 6e 61 6c 20 6f 70 74 69   additional opti
345e0 6d 69 7a 61 74 69 6f 6e 73 20 6f 6e 20 64 65 74  mizations on det
345f0 65 72 6d 69 6e 69 73 74 69 63 20 66 75 6e 63 74  erministic funct
34600 69 6f 6e 73 2c 20 73 6f 20 75 73 65 0a 2a 2a 20  ions, so use.** 
34610 6f 66 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 44  of the [SQLITE_D
34620 45 54 45 52 4d 49 4e 49 53 54 49 43 5d 20 66 6c  ETERMINISTIC] fl
34630 61 67 20 69 73 20 72 65 63 6f 6d 6d 65 6e 64 65  ag is recommende
34640 64 20 77 68 65 72 65 20 70 6f 73 73 69 62 6c 65  d where possible
34650 2e 0a 2a 2a 0a 2a 2a 20 5e 28 54 68 65 20 66 69  ..**.** ^(The fi
34660 66 74 68 20 70 61 72 61 6d 65 74 65 72 20 69 73  fth parameter is
34670 20 61 6e 20 61 72 62 69 74 72 61 72 79 20 70 6f   an arbitrary po
34680 69 6e 74 65 72 2e 20 20 54 68 65 20 69 6d 70 6c  inter.  The impl
34690 65 6d 65 6e 74 61 74 69 6f 6e 20 6f 66 20 74 68  ementation of th
346a0 65 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 20 63 61  e.** function ca
346b0 6e 20 67 61 69 6e 20 61 63 63 65 73 73 20 74 6f  n gain access to
346c0 20 74 68 69 73 20 70 6f 69 6e 74 65 72 20 75 73   this pointer us
346d0 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 75 73 65  ing [sqlite3_use
346e0 72 5f 64 61 74 61 28 29 5d 2e 29 5e 0a 2a 2a 0a  r_data()].)^.**.
346f0 2a 2a 20 5e 54 68 65 20 73 69 78 74 68 2c 20 73  ** ^The sixth, s
34700 65 76 65 6e 74 68 20 61 6e 64 20 65 69 67 68 74  eventh and eight
34710 68 20 70 61 72 61 6d 65 74 65 72 73 2c 20 78 46  h parameters, xF
34720 75 6e 63 2c 20 78 53 74 65 70 20 61 6e 64 20 78  unc, xStep and x
34730 46 69 6e 61 6c 2c 20 61 72 65 0a 2a 2a 20 70 6f  Final, are.** po
34740 69 6e 74 65 72 73 20 74 6f 20 43 2d 6c 61 6e 67  inters to C-lang
34750 75 61 67 65 20 66 75 6e 63 74 69 6f 6e 73 20 74  uage functions t
34760 68 61 74 20 69 6d 70 6c 65 6d 65 6e 74 20 74 68  hat implement th
34770 65 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20 6f  e SQL function o
34780 72 0a 2a 2a 20 61 67 67 72 65 67 61 74 65 2e 20  r.** aggregate. 
34790 5e 41 20 73 63 61 6c 61 72 20 53 51 4c 20 66 75  ^A scalar SQL fu
347a0 6e 63 74 69 6f 6e 20 72 65 71 75 69 72 65 73 20  nction requires 
347b0 61 6e 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f  an implementatio
347c0 6e 20 6f 66 20 74 68 65 20 78 46 75 6e 63 0a 2a  n of the xFunc.*
347d0 2a 20 63 61 6c 6c 62 61 63 6b 20 6f 6e 6c 79 3b  * callback only;
347e0 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 73 20 6d   NULL pointers m
347f0 75 73 74 20 62 65 20 70 61 73 73 65 64 20 61 73  ust be passed as
34800 20 74 68 65 20 78 53 74 65 70 20 61 6e 64 20 78   the xStep and x
34810 46 69 6e 61 6c 0a 2a 2a 20 70 61 72 61 6d 65 74  Final.** paramet
34820 65 72 73 2e 20 5e 41 6e 20 61 67 67 72 65 67 61  ers. ^An aggrega
34830 74 65 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20  te SQL function 
34840 72 65 71 75 69 72 65 73 20 61 6e 20 69 6d 70 6c  requires an impl
34850 65 6d 65 6e 74 61 74 69 6f 6e 20 6f 66 20 78 53  ementation of xS
34860 74 65 70 0a 2a 2a 20 61 6e 64 20 78 46 69 6e 61  tep.** and xFina
34870 6c 20 61 6e 64 20 4e 55 4c 4c 20 70 6f 69 6e 74  l and NULL point
34880 65 72 20 6d 75 73 74 20 62 65 20 70 61 73 73 65  er must be passe
34890 64 20 66 6f 72 20 78 46 75 6e 63 2e 20 5e 54 6f  d for xFunc. ^To
348a0 20 64 65 6c 65 74 65 20 61 6e 20 65 78 69 73 74   delete an exist
348b0 69 6e 67 0a 2a 2a 20 53 51 4c 20 66 75 6e 63 74  ing.** SQL funct
348c0 69 6f 6e 20 6f 72 20 61 67 67 72 65 67 61 74 65  ion or aggregate
348d0 2c 20 70 61 73 73 20 4e 55 4c 4c 20 70 6f 69 6e  , pass NULL poin
348e0 74 65 72 73 20 66 6f 72 20 61 6c 6c 20 74 68 72  ters for all thr
348f0 65 65 20 66 75 6e 63 74 69 6f 6e 0a 2a 2a 20 63  ee function.** c
34900 61 6c 6c 62 61 63 6b 73 2e 0a 2a 2a 0a 2a 2a 20  allbacks..**.** 
34910 5e 28 49 66 20 74 68 65 20 6e 69 6e 74 68 20 70  ^(If the ninth p
34920 61 72 61 6d 65 74 65 72 20 74 6f 20 73 71 6c 69  arameter to sqli
34930 74 65 33 5f 63 72 65 61 74 65 5f 66 75 6e 63 74  te3_create_funct
34940 69 6f 6e 5f 76 32 28 29 20 69 73 20 6e 6f 74 20  ion_v2() is not 
34950 4e 55 4c 4c 2c 0a 2a 2a 20 74 68 65 6e 20 69 74  NULL,.** then it
34960 20 69 73 20 64 65 73 74 72 75 63 74 6f 72 20 66   is destructor f
34970 6f 72 20 74 68 65 20 61 70 70 6c 69 63 61 74 69  or the applicati
34980 6f 6e 20 64 61 74 61 20 70 6f 69 6e 74 65 72 2e  on data pointer.
34990 20 0a 2a 2a 20 54 68 65 20 64 65 73 74 72 75 63   .** The destruc
349a0 74 6f 72 20 69 73 20 69 6e 76 6f 6b 65 64 20 77  tor is invoked w
349b0 68 65 6e 20 74 68 65 20 66 75 6e 63 74 69 6f 6e  hen the function
349c0 20 69 73 20 64 65 6c 65 74 65 64 2c 20 65 69 74   is deleted, eit
349d0 68 65 72 20 62 79 20 62 65 69 6e 67 0a 2a 2a 20  her by being.** 
349e0 6f 76 65 72 6c 6f 61 64 65 64 20 6f 72 20 77 68  overloaded or wh
349f0 65 6e 20 74 68 65 20 64 61 74 61 62 61 73 65 20  en the database 
34a00 63 6f 6e 6e 65 63 74 69 6f 6e 20 63 6c 6f 73 65  connection close
34a10 73 2e 29 5e 0a 2a 2a 20 5e 54 68 65 20 64 65 73  s.)^.** ^The des
34a20 74 72 75 63 74 6f 72 20 69 73 20 61 6c 73 6f 20  tructor is also 
34a30 69 6e 76 6f 6b 65 64 20 69 66 20 74 68 65 20 63  invoked if the c
34a40 61 6c 6c 20 74 6f 0a 2a 2a 20 73 71 6c 69 74 65  all to.** sqlite
34a50 33 5f 63 72 65 61 74 65 5f 66 75 6e 63 74 69 6f  3_create_functio
34a60 6e 5f 76 32 28 29 20 66 61 69 6c 73 2e 0a 2a 2a  n_v2() fails..**
34a70 20 5e 57 68 65 6e 20 74 68 65 20 64 65 73 74 72   ^When the destr
34a80 75 63 74 6f 72 20 63 61 6c 6c 62 61 63 6b 20 6f  uctor callback o
34a90 66 20 74 68 65 20 74 65 6e 74 68 20 70 61 72 61  f the tenth para
34aa0 6d 65 74 65 72 20 69 73 20 69 6e 76 6f 6b 65 64  meter is invoked
34ab0 2c 20 69 74 0a 2a 2a 20 69 73 20 70 61 73 73 65  , it.** is passe
34ac0 64 20 61 20 73 69 6e 67 6c 65 20 61 72 67 75 6d  d a single argum
34ad0 65 6e 74 20 77 68 69 63 68 20 69 73 20 61 20 63  ent which is a c
34ae0 6f 70 79 20 6f 66 20 74 68 65 20 61 70 70 6c 69  opy of the appli
34af0 63 61 74 69 6f 6e 20 64 61 74 61 20 0a 2a 2a 20  cation data .** 
34b00 70 6f 69 6e 74 65 72 20 77 68 69 63 68 20 77 61  pointer which wa
34b10 73 20 74 68 65 20 66 69 66 74 68 20 70 61 72 61  s the fifth para
34b20 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33  meter to sqlite3
34b30 5f 63 72 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e  _create_function
34b40 5f 76 32 28 29 2e 0a 2a 2a 0a 2a 2a 20 5e 49 74  _v2()..**.** ^It
34b50 20 69 73 20 70 65 72 6d 69 74 74 65 64 20 74 6f   is permitted to
34b60 20 72 65 67 69 73 74 65 72 20 6d 75 6c 74 69 70   register multip
34b70 6c 65 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f  le implementatio
34b80 6e 73 20 6f 66 20 74 68 65 20 73 61 6d 65 0a 2a  ns of the same.*
34b90 2a 20 66 75 6e 63 74 69 6f 6e 73 20 77 69 74 68  * functions with
34ba0 20 74 68 65 20 73 61 6d 65 20 6e 61 6d 65 20 62   the same name b
34bb0 75 74 20 77 69 74 68 20 65 69 74 68 65 72 20 64  ut with either d
34bc0 69 66 66 65 72 69 6e 67 20 6e 75 6d 62 65 72 73  iffering numbers
34bd0 20 6f 66 0a 2a 2a 20 61 72 67 75 6d 65 6e 74 73   of.** arguments
34be0 20 6f 72 20 64 69 66 66 65 72 69 6e 67 20 70 72   or differing pr
34bf0 65 66 65 72 72 65 64 20 74 65 78 74 20 65 6e 63  eferred text enc
34c00 6f 64 69 6e 67 73 2e 20 20 5e 53 51 4c 69 74 65  odings.  ^SQLite
34c10 20 77 69 6c 6c 20 75 73 65 0a 2a 2a 20 74 68 65   will use.** the
34c20 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20   implementation 
34c30 74 68 61 74 20 6d 6f 73 74 20 63 6c 6f 73 65 6c  that most closel
34c40 79 20 6d 61 74 63 68 65 73 20 74 68 65 20 77 61  y matches the wa
34c50 79 20 69 6e 20 77 68 69 63 68 20 74 68 65 0a 2a  y in which the.*
34c60 2a 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20 69  * SQL function i
34c70 73 20 75 73 65 64 2e 20 20 5e 41 20 66 75 6e 63  s used.  ^A func
34c80 74 69 6f 6e 20 69 6d 70 6c 65 6d 65 6e 74 61 74  tion implementat
34c90 69 6f 6e 20 77 69 74 68 20 61 20 6e 6f 6e 2d 6e  ion with a non-n
34ca0 65 67 61 74 69 76 65 0a 2a 2a 20 6e 41 72 67 20  egative.** nArg 
34cb0 70 61 72 61 6d 65 74 65 72 20 69 73 20 61 20 62  parameter is a b
34cc0 65 74 74 65 72 20 6d 61 74 63 68 20 74 68 61 6e  etter match than
34cd0 20 61 20 66 75 6e 63 74 69 6f 6e 20 69 6d 70 6c   a function impl
34ce0 65 6d 65 6e 74 61 74 69 6f 6e 20 77 69 74 68 0a  ementation with.
34cf0 2a 2a 20 61 20 6e 65 67 61 74 69 76 65 20 6e 41  ** a negative nA
34d00 72 67 2e 20 20 5e 41 20 66 75 6e 63 74 69 6f 6e  rg.  ^A function
34d10 20 77 68 65 72 65 20 74 68 65 20 70 72 65 66 65   where the prefe
34d20 72 72 65 64 20 74 65 78 74 20 65 6e 63 6f 64 69  rred text encodi
34d30 6e 67 0a 2a 2a 20 6d 61 74 63 68 65 73 20 74 68  ng.** matches th
34d40 65 20 64 61 74 61 62 61 73 65 20 65 6e 63 6f 64  e database encod
34d50 69 6e 67 20 69 73 20 61 20 62 65 74 74 65 72 0a  ing is a better.
34d60 2a 2a 20 6d 61 74 63 68 20 74 68 61 6e 20 61 20  ** match than a 
34d70 66 75 6e 63 74 69 6f 6e 20 77 68 65 72 65 20 74  function where t
34d80 68 65 20 65 6e 63 6f 64 69 6e 67 20 69 73 20 64  he encoding is d
34d90 69 66 66 65 72 65 6e 74 2e 20 20 0a 2a 2a 20 5e  ifferent.  .** ^
34da0 41 20 66 75 6e 63 74 69 6f 6e 20 77 68 65 72 65  A function where
34db0 20 74 68 65 20 65 6e 63 6f 64 69 6e 67 20 64 69   the encoding di
34dc0 66 66 65 72 65 6e 63 65 20 69 73 20 62 65 74 77  fference is betw
34dd0 65 65 6e 20 55 54 46 31 36 6c 65 20 61 6e 64 20  een UTF16le and 
34de0 55 54 46 31 36 62 65 0a 2a 2a 20 69 73 20 61 20  UTF16be.** is a 
34df0 63 6c 6f 73 65 72 20 6d 61 74 63 68 20 74 68 61  closer match tha
34e00 6e 20 61 20 66 75 6e 63 74 69 6f 6e 20 77 68 65  n a function whe
34e10 72 65 20 74 68 65 20 65 6e 63 6f 64 69 6e 67 20  re the encoding 
34e20 64 69 66 66 65 72 65 6e 63 65 20 69 73 0a 2a 2a  difference is.**
34e30 20 62 65 74 77 65 65 6e 20 55 54 46 38 20 61 6e   between UTF8 an
34e40 64 20 55 54 46 31 36 2e 0a 2a 2a 0a 2a 2a 20 5e  d UTF16..**.** ^
34e50 42 75 69 6c 74 2d 69 6e 20 66 75 6e 63 74 69 6f  Built-in functio
34e60 6e 73 20 6d 61 79 20 62 65 20 6f 76 65 72 6c 6f  ns may be overlo
34e70 61 64 65 64 20 62 79 20 6e 65 77 20 61 70 70 6c  aded by new appl
34e80 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20  ication-defined 
34e90 66 75 6e 63 74 69 6f 6e 73 2e 0a 2a 2a 0a 2a 2a  functions..**.**
34ea0 20 5e 41 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e   ^An application
34eb0 2d 64 65 66 69 6e 65 64 20 66 75 6e 63 74 69 6f  -defined functio
34ec0 6e 20 69 73 20 70 65 72 6d 69 74 74 65 64 20 74  n is permitted t
34ed0 6f 20 63 61 6c 6c 20 6f 74 68 65 72 0a 2a 2a 20  o call other.** 
34ee0 53 51 4c 69 74 65 20 69 6e 74 65 72 66 61 63 65  SQLite interface
34ef0 73 2e 20 20 48 6f 77 65 76 65 72 2c 20 73 75 63  s.  However, suc
34f00 68 20 63 61 6c 6c 73 20 6d 75 73 74 20 6e 6f 74  h calls must not
34f10 0a 2a 2a 20 63 6c 6f 73 65 20 74 68 65 20 64 61  .** close the da
34f20 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
34f30 6e 20 6e 6f 72 20 66 69 6e 61 6c 69 7a 65 20 6f  n nor finalize o
34f40 72 20 72 65 73 65 74 20 74 68 65 20 70 72 65 70  r reset the prep
34f50 61 72 65 64 0a 2a 2a 20 73 74 61 74 65 6d 65 6e  ared.** statemen
34f60 74 20 69 6e 20 77 68 69 63 68 20 74 68 65 20 66  t in which the f
34f70 75 6e 63 74 69 6f 6e 20 69 73 20 72 75 6e 6e 69  unction is runni
34f80 6e 67 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74  ng..*/.int sqlit
34f90 65 33 5f 63 72 65 61 74 65 5f 66 75 6e 63 74 69  e3_create_functi
34fa0 6f 6e 28 0a 20 20 73 71 6c 69 74 65 33 20 2a 64  on(.  sqlite3 *d
34fb0 62 2c 0a 20 20 63 6f 6e 73 74 20 63 68 61 72 20  b,.  const char 
34fc0 2a 7a 46 75 6e 63 74 69 6f 6e 4e 61 6d 65 2c 0a  *zFunctionName,.
34fd0 20 20 69 6e 74 20 6e 41 72 67 2c 0a 20 20 69 6e    int nArg,.  in
34fe0 74 20 65 54 65 78 74 52 65 70 2c 0a 20 20 76 6f  t eTextRep,.  vo
34ff0 69 64 20 2a 70 41 70 70 2c 0a 20 20 76 6f 69 64  id *pApp,.  void
35000 20 28 2a 78 46 75 6e 63 29 28 73 71 6c 69 74 65   (*xFunc)(sqlite
35010 33 5f 63 6f 6e 74 65 78 74 2a 2c 69 6e 74 2c 73  3_context*,int,s
35020 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 2a 29 2c  qlite3_value**),
35030 0a 20 20 76 6f 69 64 20 28 2a 78 53 74 65 70 29  .  void (*xStep)
35040 28 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74  (sqlite3_context
35050 2a 2c 69 6e 74 2c 73 71 6c 69 74 65 33 5f 76 61  *,int,sqlite3_va
35060 6c 75 65 2a 2a 29 2c 0a 20 20 76 6f 69 64 20 28  lue**),.  void (
35070 2a 78 46 69 6e 61 6c 29 28 73 71 6c 69 74 65 33  *xFinal)(sqlite3
35080 5f 63 6f 6e 74 65 78 74 2a 29 0a 29 3b 0a 69 6e  _context*).);.in
35090 74 20 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65  t sqlite3_create
350a0 5f 66 75 6e 63 74 69 6f 6e 31 36 28 0a 20 20 73  _function16(.  s
350b0 71 6c 69 74 65 33 20 2a 64 62 2c 0a 20 20 63 6f  qlite3 *db,.  co
350c0 6e 73 74 20 76 6f 69 64 20 2a 7a 46 75 6e 63 74  nst void *zFunct
350d0 69 6f 6e 4e 61 6d 65 2c 0a 20 20 69 6e 74 20 6e  ionName,.  int n
350e0 41 72 67 2c 0a 20 20 69 6e 74 20 65 54 65 78 74  Arg,.  int eText
350f0 52 65 70 2c 0a 20 20 76 6f 69 64 20 2a 70 41 70  Rep,.  void *pAp
35100 70 2c 0a 20 20 76 6f 69 64 20 28 2a 78 46 75 6e  p,.  void (*xFun
35110 63 29 28 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65  c)(sqlite3_conte
35120 78 74 2a 2c 69 6e 74 2c 73 71 6c 69 74 65 33 5f  xt*,int,sqlite3_
35130 76 61 6c 75 65 2a 2a 29 2c 0a 20 20 76 6f 69 64  value**),.  void
35140 20 28 2a 78 53 74 65 70 29 28 73 71 6c 69 74 65   (*xStep)(sqlite
35150 33 5f 63 6f 6e 74 65 78 74 2a 2c 69 6e 74 2c 73  3_context*,int,s
35160 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 2a 29 2c  qlite3_value**),
35170 0a 20 20 76 6f 69 64 20 28 2a 78 46 69 6e 61 6c  .  void (*xFinal
35180 29 28 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78  )(sqlite3_contex
35190 74 2a 29 0a 29 3b 0a 69 6e 74 20 73 71 6c 69 74  t*).);.int sqlit
351a0 65 33 5f 63 72 65 61 74 65 5f 66 75 6e 63 74 69  e3_create_functi
351b0 6f 6e 5f 76 32 28 0a 20 20 73 71 6c 69 74 65 33  on_v2(.  sqlite3
351c0 20 2a 64 62 2c 0a 20 20 63 6f 6e 73 74 20 63 68   *db,.  const ch
351d0 61 72 20 2a 7a 46 75 6e 63 74 69 6f 6e 4e 61 6d  ar *zFunctionNam
351e0 65 2c 0a 20 20 69 6e 74 20 6e 41 72 67 2c 0a 20  e,.  int nArg,. 
351f0 20 69 6e 74 20 65 54 65 78 74 52 65 70 2c 0a 20   int eTextRep,. 
35200 20 76 6f 69 64 20 2a 70 41 70 70 2c 0a 20 20 76   void *pApp,.  v
35210 6f 69 64 20 28 2a 78 46 75 6e 63 29 28 73 71 6c  oid (*xFunc)(sql
35220 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a 2c 69 6e  ite3_context*,in
35230 74 2c 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a  t,sqlite3_value*
35240 2a 29 2c 0a 20 20 76 6f 69 64 20 28 2a 78 53 74  *),.  void (*xSt
35250 65 70 29 28 73 71 6c 69 74 65 33 5f 63 6f 6e 74  ep)(sqlite3_cont
35260 65 78 74 2a 2c 69 6e 74 2c 73 71 6c 69 74 65 33  ext*,int,sqlite3
35270 5f 76 61 6c 75 65 2a 2a 29 2c 0a 20 20 76 6f 69  _value**),.  voi
35280 64 20 28 2a 78 46 69 6e 61 6c 29 28 73 71 6c 69  d (*xFinal)(sqli
35290 74 65 33 5f 63 6f 6e 74 65 78 74 2a 29 2c 0a 20  te3_context*),. 
352a0 20 76 6f 69 64 28 2a 78 44 65 73 74 72 6f 79 29   void(*xDestroy)
352b0 28 76 6f 69 64 2a 29 0a 29 3b 0a 0a 2f 2a 0a 2a  (void*).);../*.*
352c0 2a 20 43 41 50 49 33 52 45 46 3a 20 54 65 78 74  * CAPI3REF: Text
352d0 20 45 6e 63 6f 64 69 6e 67 73 0a 2a 2a 0a 2a 2a   Encodings.**.**
352e0 20 54 68 65 73 65 20 63 6f 6e 73 74 61 6e 74 20   These constant 
352f0 64 65 66 69 6e 65 20 69 6e 74 65 67 65 72 20 63  define integer c
35300 6f 64 65 73 20 74 68 61 74 20 72 65 70 72 65 73  odes that repres
35310 65 6e 74 20 74 68 65 20 76 61 72 69 6f 75 73 0a  ent the various.
35320 2a 2a 20 74 65 78 74 20 65 6e 63 6f 64 69 6e 67  ** text encoding
35330 73 20 73 75 70 70 6f 72 74 65 64 20 62 79 20 53  s supported by S
35340 51 4c 69 74 65 2e 0a 2a 2f 0a 23 64 65 66 69 6e  QLite..*/.#defin
35350 65 20 53 51 4c 49 54 45 5f 55 54 46 38 20 20 20  e SQLITE_UTF8   
35360 20 20 20 20 20 20 20 20 31 20 20 20 20 2f 2a 20          1    /* 
35370 49 4d 50 3a 20 52 2d 33 37 35 31 34 2d 33 35 35  IMP: R-37514-355
35380 36 36 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51  66 */.#define SQ
35390 4c 49 54 45 5f 55 54 46 31 36 4c 45 20 20 20 20  LITE_UTF16LE    
353a0 20 20 20 20 32 20 20 20 20 2f 2a 20 49 4d 50 3a      2    /* IMP:
353b0 20 52 2d 30 33 33 37 31 2d 33 37 36 33 37 20 2a   R-03371-37637 *
353c0 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
353d0 5f 55 54 46 31 36 42 45 20 20 20 20 20 20 20 20  _UTF16BE        
353e0 33 20 20 20 20 2f 2a 20 49 4d 50 3a 20 52 2d 35  3    /* IMP: R-5
353f0 31 39 37 31 2d 33 34 31 35 34 20 2a 2f 0a 23 64  1971-34154 */.#d
35400 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 55 54 46  efine SQLITE_UTF
35410 31 36 20 20 20 20 20 20 20 20 20 20 34 20 20 20  16          4   
35420 20 2f 2a 20 55 73 65 20 6e 61 74 69 76 65 20 62   /* Use native b
35430 79 74 65 20 6f 72 64 65 72 20 2a 2f 0a 23 64 65  yte order */.#de
35440 66 69 6e 65 20 53 51 4c 49 54 45 5f 41 4e 59 20  fine SQLITE_ANY 
35450 20 20 20 20 20 20 20 20 20 20 20 35 20 20 20 20             5    
35460 2f 2a 20 44 65 70 72 65 63 61 74 65 64 20 2a 2f  /* Deprecated */
35470 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
35480 55 54 46 31 36 5f 41 4c 49 47 4e 45 44 20 20 38  UTF16_ALIGNED  8
35490 20 20 20 20 2f 2a 20 73 71 6c 69 74 65 33 5f 63      /* sqlite3_c
354a0 72 65 61 74 65 5f 63 6f 6c 6c 61 74 69 6f 6e 20  reate_collation 
354b0 6f 6e 6c 79 20 2a 2f 0a 0a 2f 2a 0a 2a 2a 20 43  only */../*.** C
354c0 41 50 49 33 52 45 46 3a 20 46 75 6e 63 74 69 6f  API3REF: Functio
354d0 6e 20 46 6c 61 67 73 0a 2a 2a 0a 2a 2a 20 54 68  n Flags.**.** Th
354e0 65 73 65 20 63 6f 6e 73 74 61 6e 74 73 20 6d 61  ese constants ma
354f0 79 20 62 65 20 4f 52 65 64 20 74 6f 67 65 74 68  y be ORed togeth
35500 65 72 20 77 69 74 68 20 74 68 65 20 0a 2a 2a 20  er with the .** 
35510 5b 53 51 4c 49 54 45 5f 55 54 46 38 20 7c 20 70  [SQLITE_UTF8 | p
35520 72 65 66 65 72 72 65 64 20 74 65 78 74 20 65 6e  referred text en
35530 63 6f 64 69 6e 67 5d 20 61 73 20 74 68 65 20 66  coding] as the f
35540 6f 75 72 74 68 20 61 72 67 75 6d 65 6e 74 0a 2a  ourth argument.*
35550 2a 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 63 72  * to [sqlite3_cr
35560 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e 28 29 5d  eate_function()]
35570 2c 20 5b 73 71 6c 69 74 65 33 5f 63 72 65 61 74  , [sqlite3_creat
35580 65 5f 66 75 6e 63 74 69 6f 6e 31 36 28 29 5d 2c  e_function16()],
35590 20 6f 72 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f   or.** [sqlite3_
355a0 63 72 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e 5f  create_function_
355b0 76 32 28 29 5d 2e 0a 2a 2f 0a 23 64 65 66 69 6e  v2()]..*/.#defin
355c0 65 20 53 51 4c 49 54 45 5f 44 45 54 45 52 4d 49  e SQLITE_DETERMI
355d0 4e 49 53 54 49 43 20 20 20 20 30 78 38 30 30 0a  NISTIC    0x800.
355e0 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
355f0 20 44 65 70 72 65 63 61 74 65 64 20 46 75 6e 63   Deprecated Func
35600 74 69 6f 6e 73 0a 2a 2a 20 44 45 50 52 45 43 41  tions.** DEPRECA
35610 54 45 44 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20  TED.**.** These 
35620 66 75 6e 63 74 69 6f 6e 73 20 61 72 65 20 5b 64  functions are [d
35630 65 70 72 65 63 61 74 65 64 5d 2e 20 20 49 6e 20  eprecated].  In 
35640 6f 72 64 65 72 20 74 6f 20 6d 61 69 6e 74 61 69  order to maintai
35650 6e 0a 2a 2a 20 62 61 63 6b 77 61 72 64 73 20 63  n.** backwards c
35660 6f 6d 70 61 74 69 62 69 6c 69 74 79 20 77 69 74  ompatibility wit
35670 68 20 6f 6c 64 65 72 20 63 6f 64 65 2c 20 74 68  h older code, th
35680 65 73 65 20 66 75 6e 63 74 69 6f 6e 73 20 63 6f  ese functions co
35690 6e 74 69 6e 75 65 20 0a 2a 2a 20 74 6f 20 62 65  ntinue .** to be
356a0 20 73 75 70 70 6f 72 74 65 64 2e 20 20 48 6f 77   supported.  How
356b0 65 76 65 72 2c 20 6e 65 77 20 61 70 70 6c 69 63  ever, new applic
356c0 61 74 69 6f 6e 73 20 73 68 6f 75 6c 64 20 61 76  ations should av
356d0 6f 69 64 0a 2a 2a 20 74 68 65 20 75 73 65 20 6f  oid.** the use o
356e0 66 20 74 68 65 73 65 20 66 75 6e 63 74 69 6f 6e  f these function
356f0 73 2e 20 20 54 6f 20 65 6e 63 6f 75 72 61 67 65  s.  To encourage
35700 20 70 72 6f 67 72 61 6d 6d 65 72 73 20 74 6f 20   programmers to 
35710 61 76 6f 69 64 0a 2a 2a 20 74 68 65 73 65 20 66  avoid.** these f
35720 75 6e 63 74 69 6f 6e 73 2c 20 77 65 20 77 69 6c  unctions, we wil
35730 6c 20 6e 6f 74 20 65 78 70 6c 61 69 6e 20 77 68  l not explain wh
35740 61 74 20 74 68 65 79 20 64 6f 2e 0a 2a 2f 0a 23  at they do..*/.#
35750 69 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 4f 4d  ifndef SQLITE_OM
35760 49 54 5f 44 45 50 52 45 43 41 54 45 44 0a 53 51  IT_DEPRECATED.SQ
35770 4c 49 54 45 5f 44 45 50 52 45 43 41 54 45 44 20  LITE_DEPRECATED 
35780 69 6e 74 20 73 71 6c 69 74 65 33 5f 61 67 67 72  int sqlite3_aggr
35790 65 67 61 74 65 5f 63 6f 75 6e 74 28 73 71 6c 69  egate_count(sqli
357a0 74 65 33 5f 63 6f 6e 74 65 78 74 2a 29 3b 0a 53  te3_context*);.S
357b0 51 4c 49 54 45 5f 44 45 50 52 45 43 41 54 45 44  QLITE_DEPRECATED
357c0 20 69 6e 74 20 73 71 6c 69 74 65 33 5f 65 78 70   int sqlite3_exp
357d0 69 72 65 64 28 73 71 6c 69 74 65 33 5f 73 74 6d  ired(sqlite3_stm
357e0 74 2a 29 3b 0a 53 51 4c 49 54 45 5f 44 45 50 52  t*);.SQLITE_DEPR
357f0 45 43 41 54 45 44 20 69 6e 74 20 73 71 6c 69 74  ECATED int sqlit
35800 65 33 5f 74 72 61 6e 73 66 65 72 5f 62 69 6e 64  e3_transfer_bind
35810 69 6e 67 73 28 73 71 6c 69 74 65 33 5f 73 74 6d  ings(sqlite3_stm
35820 74 2a 2c 20 73 71 6c 69 74 65 33 5f 73 74 6d 74  t*, sqlite3_stmt
35830 2a 29 3b 0a 53 51 4c 49 54 45 5f 44 45 50 52 45  *);.SQLITE_DEPRE
35840 43 41 54 45 44 20 69 6e 74 20 73 71 6c 69 74 65  CATED int sqlite
35850 33 5f 67 6c 6f 62 61 6c 5f 72 65 63 6f 76 65 72  3_global_recover
35860 28 76 6f 69 64 29 3b 0a 53 51 4c 49 54 45 5f 44  (void);.SQLITE_D
35870 45 50 52 45 43 41 54 45 44 20 76 6f 69 64 20 73  EPRECATED void s
35880 71 6c 69 74 65 33 5f 74 68 72 65 61 64 5f 63 6c  qlite3_thread_cl
35890 65 61 6e 75 70 28 76 6f 69 64 29 3b 0a 53 51 4c  eanup(void);.SQL
358a0 49 54 45 5f 44 45 50 52 45 43 41 54 45 44 20 69  ITE_DEPRECATED i
358b0 6e 74 20 73 71 6c 69 74 65 33 5f 6d 65 6d 6f 72  nt sqlite3_memor
358c0 79 5f 61 6c 61 72 6d 28 76 6f 69 64 28 2a 29 28  y_alarm(void(*)(
358d0 76 6f 69 64 2a 2c 73 71 6c 69 74 65 33 5f 69 6e  void*,sqlite3_in
358e0 74 36 34 2c 69 6e 74 29 2c 0a 20 20 20 20 20 20  t64,int),.      
358f0 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
35900 76 6f 69 64 2a 2c 73 71 6c 69 74 65 33 5f 69 6e  void*,sqlite3_in
35910 74 36 34 29 3b 0a 23 65 6e 64 69 66 0a 0a 2f 2a  t64);.#endif../*
35920 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 4f 62  .** CAPI3REF: Ob
35930 74 61 69 6e 69 6e 67 20 53 51 4c 20 56 61 6c 75  taining SQL Valu
35940 65 73 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71  es.** METHOD: sq
35950 6c 69 74 65 33 5f 76 61 6c 75 65 0a 2a 2a 0a 2a  lite3_value.**.*
35960 2a 20 54 68 65 20 43 2d 6c 61 6e 67 75 61 67 65  * The C-language
35970 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20   implementation 
35980 6f 66 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 73  of SQL functions
35990 20 61 6e 64 20 61 67 67 72 65 67 61 74 65 73 20   and aggregates 
359a0 75 73 65 73 0a 2a 2a 20 74 68 69 73 20 73 65 74  uses.** this set
359b0 20 6f 66 20 69 6e 74 65 72 66 61 63 65 20 72 6f   of interface ro
359c0 75 74 69 6e 65 73 20 74 6f 20 61 63 63 65 73 73  utines to access
359d0 20 74 68 65 20 70 61 72 61 6d 65 74 65 72 20 76   the parameter v
359e0 61 6c 75 65 73 20 6f 6e 0a 2a 2a 20 74 68 65 20  alues on.** the 
359f0 66 75 6e 63 74 69 6f 6e 20 6f 72 20 61 67 67 72  function or aggr
35a00 65 67 61 74 65 2e 20 20 0a 2a 2a 0a 2a 2a 20 54  egate.  .**.** T
35a10 68 65 20 78 46 75 6e 63 20 28 66 6f 72 20 73 63  he xFunc (for sc
35a20 61 6c 61 72 20 66 75 6e 63 74 69 6f 6e 73 29 20  alar functions) 
35a30 6f 72 20 78 53 74 65 70 20 28 66 6f 72 20 61 67  or xStep (for ag
35a40 67 72 65 67 61 74 65 73 29 20 70 61 72 61 6d 65  gregates) parame
35a50 74 65 72 73 0a 2a 2a 20 74 6f 20 5b 73 71 6c 69  ters.** to [sqli
35a60 74 65 33 5f 63 72 65 61 74 65 5f 66 75 6e 63 74  te3_create_funct
35a70 69 6f 6e 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69  ion()] and [sqli
35a80 74 65 33 5f 63 72 65 61 74 65 5f 66 75 6e 63 74  te3_create_funct
35a90 69 6f 6e 31 36 28 29 5d 0a 2a 2a 20 64 65 66 69  ion16()].** defi
35aa0 6e 65 20 63 61 6c 6c 62 61 63 6b 73 20 74 68 61  ne callbacks tha
35ab0 74 20 69 6d 70 6c 65 6d 65 6e 74 20 74 68 65 20  t implement the 
35ac0 53 51 4c 20 66 75 6e 63 74 69 6f 6e 73 20 61 6e  SQL functions an
35ad0 64 20 61 67 67 72 65 67 61 74 65 73 2e 0a 2a 2a  d aggregates..**
35ae0 20 54 68 65 20 33 72 64 20 70 61 72 61 6d 65 74   The 3rd paramet
35af0 65 72 20 74 6f 20 74 68 65 73 65 20 63 61 6c 6c  er to these call
35b00 62 61 63 6b 73 20 69 73 20 61 6e 20 61 72 72 61  backs is an arra
35b10 79 20 6f 66 20 70 6f 69 6e 74 65 72 73 20 74 6f  y of pointers to
35b20 0a 2a 2a 20 5b 70 72 6f 74 65 63 74 65 64 20 73  .** [protected s
35b30 71 6c 69 74 65 33 5f 76 61 6c 75 65 5d 20 6f 62  qlite3_value] ob
35b40 6a 65 63 74 73 2e 20 20 54 68 65 72 65 20 69 73  jects.  There is
35b50 20 6f 6e 65 20 5b 73 71 6c 69 74 65 33 5f 76 61   one [sqlite3_va
35b60 6c 75 65 5d 20 6f 62 6a 65 63 74 20 66 6f 72 0a  lue] object for.
35b70 2a 2a 20 65 61 63 68 20 70 61 72 61 6d 65 74 65  ** each paramete
35b80 72 20 74 6f 20 74 68 65 20 53 51 4c 20 66 75 6e  r to the SQL fun
35b90 63 74 69 6f 6e 2e 20 20 54 68 65 73 65 20 72 6f  ction.  These ro
35ba0 75 74 69 6e 65 73 20 61 72 65 20 75 73 65 64 20  utines are used 
35bb0 74 6f 0a 2a 2a 20 65 78 74 72 61 63 74 20 76 61  to.** extract va
35bc0 6c 75 65 73 20 66 72 6f 6d 20 74 68 65 20 5b 73  lues from the [s
35bd0 71 6c 69 74 65 33 5f 76 61 6c 75 65 5d 20 6f 62  qlite3_value] ob
35be0 6a 65 63 74 73 2e 0a 2a 2a 0a 2a 2a 20 54 68 65  jects..**.** The
35bf0 73 65 20 72 6f 75 74 69 6e 65 73 20 77 6f 72 6b  se routines work
35c00 20 6f 6e 6c 79 20 77 69 74 68 20 5b 70 72 6f 74   only with [prot
35c10 65 63 74 65 64 20 73 71 6c 69 74 65 33 5f 76 61  ected sqlite3_va
35c20 6c 75 65 5d 20 6f 62 6a 65 63 74 73 2e 0a 2a 2a  lue] objects..**
35c30 20 41 6e 79 20 61 74 74 65 6d 70 74 20 74 6f 20   Any attempt to 
35c40 75 73 65 20 74 68 65 73 65 20 72 6f 75 74 69 6e  use these routin
35c50 65 73 20 6f 6e 20 61 6e 20 5b 75 6e 70 72 6f 74  es on an [unprot
35c60 65 63 74 65 64 20 73 71 6c 69 74 65 33 5f 76 61  ected sqlite3_va
35c70 6c 75 65 5d 0a 2a 2a 20 6f 62 6a 65 63 74 20 72  lue].** object r
35c80 65 73 75 6c 74 73 20 69 6e 20 75 6e 64 65 66 69  esults in undefi
35c90 6e 65 64 20 62 65 68 61 76 69 6f 72 2e 0a 2a 2a  ned behavior..**
35ca0 0a 2a 2a 20 5e 54 68 65 73 65 20 72 6f 75 74 69  .** ^These routi
35cb0 6e 65 73 20 77 6f 72 6b 20 6a 75 73 74 20 6c 69  nes work just li
35cc0 6b 65 20 74 68 65 20 63 6f 72 72 65 73 70 6f 6e  ke the correspon
35cd0 64 69 6e 67 20 5b 63 6f 6c 75 6d 6e 20 61 63 63  ding [column acc
35ce0 65 73 73 20 66 75 6e 63 74 69 6f 6e 73 5d 0a 2a  ess functions].*
35cf0 2a 20 65 78 63 65 70 74 20 74 68 61 74 20 74 68  * except that th
35d00 65 73 65 20 72 6f 75 74 69 6e 65 73 20 74 61 6b  ese routines tak
35d10 65 20 61 20 73 69 6e 67 6c 65 20 5b 70 72 6f 74  e a single [prot
35d20 65 63 74 65 64 20 73 71 6c 69 74 65 33 5f 76 61  ected sqlite3_va
35d30 6c 75 65 5d 20 6f 62 6a 65 63 74 0a 2a 2a 20 70  lue] object.** p
35d40 6f 69 6e 74 65 72 20 69 6e 73 74 65 61 64 20 6f  ointer instead o
35d50 66 20 61 20 5b 73 71 6c 69 74 65 33 5f 73 74 6d  f a [sqlite3_stm
35d60 74 2a 5d 20 70 6f 69 6e 74 65 72 20 61 6e 64 20  t*] pointer and 
35d70 61 6e 20 69 6e 74 65 67 65 72 20 63 6f 6c 75 6d  an integer colum
35d80 6e 20 6e 75 6d 62 65 72 2e 0a 2a 2a 0a 2a 2a 20  n number..**.** 
35d90 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 76 61 6c  ^The sqlite3_val
35da0 75 65 5f 74 65 78 74 31 36 28 29 20 69 6e 74 65  ue_text16() inte
35db0 72 66 61 63 65 20 65 78 74 72 61 63 74 73 20 61  rface extracts a
35dc0 20 55 54 46 2d 31 36 20 73 74 72 69 6e 67 0a 2a   UTF-16 string.*
35dd0 2a 20 69 6e 20 74 68 65 20 6e 61 74 69 76 65 20  * in the native 
35de0 62 79 74 65 2d 6f 72 64 65 72 20 6f 66 20 74 68  byte-order of th
35df0 65 20 68 6f 73 74 20 6d 61 63 68 69 6e 65 2e 20  e host machine. 
35e00 20 5e 54 68 65 0a 2a 2a 20 73 71 6c 69 74 65 33   ^The.** sqlite3
35e10 5f 76 61 6c 75 65 5f 74 65 78 74 31 36 62 65 28  _value_text16be(
35e20 29 20 61 6e 64 20 73 71 6c 69 74 65 33 5f 76 61  ) and sqlite3_va
35e30 6c 75 65 5f 74 65 78 74 31 36 6c 65 28 29 20 69  lue_text16le() i
35e40 6e 74 65 72 66 61 63 65 73 0a 2a 2a 20 65 78 74  nterfaces.** ext
35e50 72 61 63 74 20 55 54 46 2d 31 36 20 73 74 72 69  ract UTF-16 stri
35e60 6e 67 73 20 61 73 20 62 69 67 2d 65 6e 64 69 61  ngs as big-endia
35e70 6e 20 61 6e 64 20 6c 69 74 74 6c 65 2d 65 6e 64  n and little-end
35e80 69 61 6e 20 72 65 73 70 65 63 74 69 76 65 6c 79  ian respectively
35e90 2e 0a 2a 2a 0a 2a 2a 20 5e 28 54 68 65 20 73 71  ..**.** ^(The sq
35ea0 6c 69 74 65 33 5f 76 61 6c 75 65 5f 6e 75 6d 65  lite3_value_nume
35eb0 72 69 63 5f 74 79 70 65 28 29 20 69 6e 74 65 72  ric_type() inter
35ec0 66 61 63 65 20 61 74 74 65 6d 70 74 73 20 74 6f  face attempts to
35ed0 20 61 70 70 6c 79 0a 2a 2a 20 6e 75 6d 65 72 69   apply.** numeri
35ee0 63 20 61 66 66 69 6e 69 74 79 20 74 6f 20 74 68  c affinity to th
35ef0 65 20 76 61 6c 75 65 2e 20 20 54 68 69 73 20 6d  e value.  This m
35f00 65 61 6e 73 20 74 68 61 74 20 61 6e 20 61 74 74  eans that an att
35f10 65 6d 70 74 20 69 73 0a 2a 2a 20 6d 61 64 65 20  empt is.** made 
35f20 74 6f 20 63 6f 6e 76 65 72 74 20 74 68 65 20 76  to convert the v
35f30 61 6c 75 65 20 74 6f 20 61 6e 20 69 6e 74 65 67  alue to an integ
35f40 65 72 20 6f 72 20 66 6c 6f 61 74 69 6e 67 20 70  er or floating p
35f50 6f 69 6e 74 2e 20 20 49 66 0a 2a 2a 20 73 75 63  oint.  If.** suc
35f60 68 20 61 20 63 6f 6e 76 65 72 73 69 6f 6e 20 69  h a conversion i
35f70 73 20 70 6f 73 73 69 62 6c 65 20 77 69 74 68 6f  s possible witho
35f80 75 74 20 6c 6f 73 73 20 6f 66 20 69 6e 66 6f 72  ut loss of infor
35f90 6d 61 74 69 6f 6e 20 28 69 6e 20 6f 74 68 65 72  mation (in other
35fa0 0a 2a 2a 20 77 6f 72 64 73 2c 20 69 66 20 74 68  .** words, if th
35fb0 65 20 76 61 6c 75 65 20 69 73 20 61 20 73 74 72  e value is a str
35fc0 69 6e 67 20 74 68 61 74 20 6c 6f 6f 6b 73 20 6c  ing that looks l
35fd0 69 6b 65 20 61 20 6e 75 6d 62 65 72 29 0a 2a 2a  ike a number).**
35fe0 20 74 68 65 6e 20 74 68 65 20 63 6f 6e 76 65 72   then the conver
35ff0 73 69 6f 6e 20 69 73 20 70 65 72 66 6f 72 6d 65  sion is performe
36000 64 2e 20 20 4f 74 68 65 72 77 69 73 65 20 6e 6f  d.  Otherwise no
36010 20 63 6f 6e 76 65 72 73 69 6f 6e 20 6f 63 63 75   conversion occu
36020 72 73 2e 0a 2a 2a 20 54 68 65 20 5b 53 51 4c 49  rs..** The [SQLI
36030 54 45 5f 49 4e 54 45 47 45 52 20 7c 20 64 61 74  TE_INTEGER | dat
36040 61 74 79 70 65 5d 20 61 66 74 65 72 20 63 6f 6e  atype] after con
36050 76 65 72 73 69 6f 6e 20 69 73 20 72 65 74 75 72  version is retur
36060 6e 65 64 2e 29 5e 0a 2a 2a 0a 2a 2a 20 50 6c 65  ned.)^.**.** Ple
36070 61 73 65 20 70 61 79 20 70 61 72 74 69 63 75 6c  ase pay particul
36080 61 72 20 61 74 74 65 6e 74 69 6f 6e 20 74 6f 20  ar attention to 
36090 74 68 65 20 66 61 63 74 20 74 68 61 74 20 74 68  the fact that th
360a0 65 20 70 6f 69 6e 74 65 72 20 72 65 74 75 72 6e  e pointer return
360b0 65 64 0a 2a 2a 20 66 72 6f 6d 20 5b 73 71 6c 69  ed.** from [sqli
360c0 74 65 33 5f 76 61 6c 75 65 5f 62 6c 6f 62 28 29  te3_value_blob()
360d0 5d 2c 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75  ], [sqlite3_valu
360e0 65 5f 74 65 78 74 28 29 5d 2c 20 6f 72 0a 2a 2a  e_text()], or.**
360f0 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f   [sqlite3_value_
36100 74 65 78 74 31 36 28 29 5d 20 63 61 6e 20 62 65  text16()] can be
36110 20 69 6e 76 61 6c 69 64 61 74 65 64 20 62 79 20   invalidated by 
36120 61 20 73 75 62 73 65 71 75 65 6e 74 20 63 61 6c  a subsequent cal
36130 6c 20 74 6f 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  l to.** [sqlite3
36140 5f 76 61 6c 75 65 5f 62 79 74 65 73 28 29 5d 2c  _value_bytes()],
36150 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f   [sqlite3_value_
36160 62 79 74 65 73 31 36 28 29 5d 2c 20 5b 73 71 6c  bytes16()], [sql
36170 69 74 65 33 5f 76 61 6c 75 65 5f 74 65 78 74 28  ite3_value_text(
36180 29 5d 2c 0a 2a 2a 20 6f 72 20 5b 73 71 6c 69 74  )],.** or [sqlit
36190 65 33 5f 76 61 6c 75 65 5f 74 65 78 74 31 36 28  e3_value_text16(
361a0 29 5d 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20  )]..**.** These 
361b0 72 6f 75 74 69 6e 65 73 20 6d 75 73 74 20 62 65  routines must be
361c0 20 63 61 6c 6c 65 64 20 66 72 6f 6d 20 74 68 65   called from the
361d0 20 73 61 6d 65 20 74 68 72 65 61 64 20 61 73 0a   same thread as.
361e0 2a 2a 20 74 68 65 20 53 51 4c 20 66 75 6e 63 74  ** the SQL funct
361f0 69 6f 6e 20 74 68 61 74 20 73 75 70 70 6c 69 65  ion that supplie
36200 64 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 76  d the [sqlite3_v
36210 61 6c 75 65 2a 5d 20 70 61 72 61 6d 65 74 65 72  alue*] parameter
36220 73 2e 0a 2a 2f 0a 63 6f 6e 73 74 20 76 6f 69 64  s..*/.const void
36230 20 2a 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f   *sqlite3_value_
36240 62 6c 6f 62 28 73 71 6c 69 74 65 33 5f 76 61 6c  blob(sqlite3_val
36250 75 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  ue*);.int sqlite
36260 33 5f 76 61 6c 75 65 5f 62 79 74 65 73 28 73 71  3_value_bytes(sq
36270 6c 69 74 65 33 5f 76 61 6c 75 65 2a 29 3b 0a 69  lite3_value*);.i
36280 6e 74 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  nt sqlite3_value
36290 5f 62 79 74 65 73 31 36 28 73 71 6c 69 74 65 33  _bytes16(sqlite3
362a0 5f 76 61 6c 75 65 2a 29 3b 0a 64 6f 75 62 6c 65  _value*);.double
362b0 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 64   sqlite3_value_d
362c0 6f 75 62 6c 65 28 73 71 6c 69 74 65 33 5f 76 61  ouble(sqlite3_va
362d0 6c 75 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74  lue*);.int sqlit
362e0 65 33 5f 76 61 6c 75 65 5f 69 6e 74 28 73 71 6c  e3_value_int(sql
362f0 69 74 65 33 5f 76 61 6c 75 65 2a 29 3b 0a 73 71  ite3_value*);.sq
36300 6c 69 74 65 33 5f 69 6e 74 36 34 20 73 71 6c 69  lite3_int64 sqli
36310 74 65 33 5f 76 61 6c 75 65 5f 69 6e 74 36 34 28  te3_value_int64(
36320 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 29 3b  sqlite3_value*);
36330 0a 63 6f 6e 73 74 20 75 6e 73 69 67 6e 65 64 20  .const unsigned 
36340 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f 76 61  char *sqlite3_va
36350 6c 75 65 5f 74 65 78 74 28 73 71 6c 69 74 65 33  lue_text(sqlite3
36360 5f 76 61 6c 75 65 2a 29 3b 0a 63 6f 6e 73 74 20  _value*);.const 
36370 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f 76 61  void *sqlite3_va
36380 6c 75 65 5f 74 65 78 74 31 36 28 73 71 6c 69 74  lue_text16(sqlit
36390 65 33 5f 76 61 6c 75 65 2a 29 3b 0a 63 6f 6e 73  e3_value*);.cons
363a0 74 20 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f  t void *sqlite3_
363b0 76 61 6c 75 65 5f 74 65 78 74 31 36 6c 65 28 73  value_text16le(s
363c0 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 29 3b 0a  qlite3_value*);.
363d0 63 6f 6e 73 74 20 76 6f 69 64 20 2a 73 71 6c 69  const void *sqli
363e0 74 65 33 5f 76 61 6c 75 65 5f 74 65 78 74 31 36  te3_value_text16
363f0 62 65 28 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  be(sqlite3_value
36400 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  *);.int sqlite3_
36410 76 61 6c 75 65 5f 74 79 70 65 28 73 71 6c 69 74  value_type(sqlit
36420 65 33 5f 76 61 6c 75 65 2a 29 3b 0a 69 6e 74 20  e3_value*);.int 
36430 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 6e 75  sqlite3_value_nu
36440 6d 65 72 69 63 5f 74 79 70 65 28 73 71 6c 69 74  meric_type(sqlit
36450 65 33 5f 76 61 6c 75 65 2a 29 3b 0a 0a 2f 2a 0a  e3_value*);../*.
36460 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 46 69 6e  ** CAPI3REF: Fin
36470 64 69 6e 67 20 54 68 65 20 53 75 62 74 79 70 65  ding The Subtype
36480 20 4f 66 20 53 51 4c 20 56 61 6c 75 65 73 0a 2a   Of SQL Values.*
36490 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65  * METHOD: sqlite
364a0 33 5f 76 61 6c 75 65 0a 2a 2a 0a 2a 2a 20 54 68  3_value.**.** Th
364b0 65 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f  e sqlite3_value_
364c0 73 75 62 74 79 70 65 28 56 29 20 66 75 6e 63 74  subtype(V) funct
364d0 69 6f 6e 20 72 65 74 75 72 6e 73 20 74 68 65 20  ion returns the 
364e0 73 75 62 74 79 70 65 20 66 6f 72 0a 2a 2a 20 61  subtype for.** a
364f0 6e 20 5b 61 70 70 6c 69 63 61 74 69 6f 6e 2d 64  n [application-d
36500 65 66 69 6e 65 64 20 53 51 4c 20 66 75 6e 63 74  efined SQL funct
36510 69 6f 6e 5d 20 61 72 67 75 6d 65 6e 74 20 56 2e  ion] argument V.
36520 20 20 54 68 65 20 73 75 62 74 79 70 65 0a 2a 2a    The subtype.**
36530 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 63 61 6e   information can
36540 20 62 65 20 75 73 65 64 20 74 6f 20 70 61 73 73   be used to pass
36550 20 61 20 6c 69 6d 69 74 65 64 20 61 6d 6f 75 6e   a limited amoun
36560 74 20 6f 66 20 63 6f 6e 74 65 78 74 20 66 72 6f  t of context fro
36570 6d 0a 2a 2a 20 6f 6e 65 20 53 51 4c 20 66 75 6e  m.** one SQL fun
36580 63 74 69 6f 6e 20 74 6f 20 61 6e 6f 74 68 65 72  ction to another
36590 2e 20 20 55 73 65 20 74 68 65 20 5b 73 71 6c 69  .  Use the [sqli
365a0 74 65 33 5f 72 65 73 75 6c 74 5f 73 75 62 74 79  te3_result_subty
365b0 70 65 28 29 5d 0a 2a 2a 20 72 6f 75 74 69 6e 65  pe()].** routine
365c0 20 74 6f 20 73 65 74 20 74 68 65 20 73 75 62 74   to set the subt
365d0 79 70 65 20 66 6f 72 20 74 68 65 20 72 65 74 75  ype for the retu
365e0 72 6e 20 76 61 6c 75 65 20 6f 66 20 61 6e 20 53  rn value of an S
365f0 51 4c 20 66 75 6e 63 74 69 6f 6e 2e 0a 2a 2a 0a  QL function..**.
36600 2a 2a 20 53 51 4c 69 74 65 20 6d 61 6b 65 73 20  ** SQLite makes 
36610 6e 6f 20 75 73 65 20 6f 66 20 73 75 62 74 79 70  no use of subtyp
36620 65 20 69 74 73 65 6c 66 2e 20 20 49 74 20 6d 65  e itself.  It me
36630 72 65 6c 79 20 70 61 73 73 65 73 20 74 68 65 20  rely passes the 
36640 73 75 62 74 79 70 65 0a 2a 2a 20 66 72 6f 6d 20  subtype.** from 
36650 74 68 65 20 72 65 73 75 6c 74 20 6f 66 20 6f 6e  the result of on
36660 65 20 5b 61 70 70 6c 69 63 61 74 69 6f 6e 2d 64  e [application-d
36670 65 66 69 6e 65 64 20 53 51 4c 20 66 75 6e 63 74  efined SQL funct
36680 69 6f 6e 5d 20 69 6e 74 6f 20 74 68 65 0a 2a 2a  ion] into the.**
36690 20 69 6e 70 75 74 20 6f 66 20 61 6e 6f 74 68 65   input of anothe
366a0 72 2e 0a 2a 2f 0a 75 6e 73 69 67 6e 65 64 20 69  r..*/.unsigned i
366b0 6e 74 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  nt sqlite3_value
366c0 5f 73 75 62 74 79 70 65 28 73 71 6c 69 74 65 33  _subtype(sqlite3
366d0 5f 76 61 6c 75 65 2a 29 3b 0a 0a 2f 2a 0a 2a 2a  _value*);../*.**
366e0 20 43 41 50 49 33 52 45 46 3a 20 43 6f 70 79 20   CAPI3REF: Copy 
366f0 41 6e 64 20 46 72 65 65 20 53 51 4c 20 56 61 6c  And Free SQL Val
36700 75 65 73 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73  ues.** METHOD: s
36710 71 6c 69 74 65 33 5f 76 61 6c 75 65 0a 2a 2a 0a  qlite3_value.**.
36720 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f  ** ^The sqlite3_
36730 76 61 6c 75 65 5f 64 75 70 28 56 29 20 69 6e 74  value_dup(V) int
36740 65 72 66 61 63 65 20 6d 61 6b 65 73 20 61 20 63  erface makes a c
36750 6f 70 79 20 6f 66 20 74 68 65 20 5b 73 71 6c 69  opy of the [sqli
36760 74 65 33 5f 76 61 6c 75 65 5d 0a 2a 2a 20 6f 62  te3_value].** ob
36770 6a 65 63 74 20 44 20 61 6e 64 20 72 65 74 75 72  ject D and retur
36780 6e 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20  ns a pointer to 
36790 74 68 61 74 20 63 6f 70 79 2e 20 20 5e 54 68 65  that copy.  ^The
367a0 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5d   [sqlite3_value]
367b0 20 72 65 74 75 72 6e 65 64 0a 2a 2a 20 69 73 20   returned.** is 
367c0 61 20 5b 70 72 6f 74 65 63 74 65 64 20 73 71 6c  a [protected sql
367d0 69 74 65 33 5f 76 61 6c 75 65 5d 20 6f 62 6a 65  ite3_value] obje
367e0 63 74 20 65 76 65 6e 20 69 66 20 74 68 65 20 69  ct even if the i
367f0 6e 70 75 74 20 69 73 20 6e 6f 74 2e 0a 2a 2a 20  nput is not..** 
36800 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 76 61 6c  ^The sqlite3_val
36810 75 65 5f 64 75 70 28 56 29 20 69 6e 74 65 72 66  ue_dup(V) interf
36820 61 63 65 20 72 65 74 75 72 6e 73 20 4e 55 4c 4c  ace returns NULL
36830 20 69 66 20 56 20 69 73 20 4e 55 4c 4c 20 6f 72   if V is NULL or
36840 20 69 66 20 61 0a 2a 2a 20 6d 65 6d 6f 72 79 20   if a.** memory 
36850 61 6c 6c 6f 63 61 74 69 6f 6e 20 66 61 69 6c 73  allocation fails
36860 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c  ..**.** ^The sql
36870 69 74 65 33 5f 76 61 6c 75 65 5f 66 72 65 65 28  ite3_value_free(
36880 56 29 20 69 6e 74 65 72 66 61 63 65 20 66 72 65  V) interface fre
36890 65 73 20 61 6e 20 5b 73 71 6c 69 74 65 33 5f 76  es an [sqlite3_v
368a0 61 6c 75 65 5d 20 6f 62 6a 65 63 74 0a 2a 2a 20  alue] object.** 
368b0 70 72 65 76 69 6f 75 73 6c 79 20 6f 62 74 61 69  previously obtai
368c0 6e 65 64 20 66 72 6f 6d 20 5b 73 71 6c 69 74 65  ned from [sqlite
368d0 33 5f 76 61 6c 75 65 5f 64 75 70 28 29 5d 2e 20  3_value_dup()]. 
368e0 20 5e 49 66 20 56 20 69 73 20 61 20 4e 55 4c 4c   ^If V is a NULL
368f0 20 70 6f 69 6e 74 65 72 0a 2a 2a 20 74 68 65 6e   pointer.** then
36900 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 66   sqlite3_value_f
36910 72 65 65 28 56 29 20 69 73 20 61 20 68 61 72 6d  ree(V) is a harm
36920 6c 65 73 73 20 6e 6f 2d 6f 70 2e 0a 2a 2f 0a 73  less no-op..*/.s
36930 71 6c 69 74 65 33 5f 76 61 6c 75 65 20 2a 73 71  qlite3_value *sq
36940 6c 69 74 65 33 5f 76 61 6c 75 65 5f 64 75 70 28  lite3_value_dup(
36950 63 6f 6e 73 74 20 73 71 6c 69 74 65 33 5f 76 61  const sqlite3_va
36960 6c 75 65 2a 29 3b 0a 76 6f 69 64 20 73 71 6c 69  lue*);.void sqli
36970 74 65 33 5f 76 61 6c 75 65 5f 66 72 65 65 28 73  te3_value_free(s
36980 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 29 3b 0a  qlite3_value*);.
36990 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
369a0 20 4f 62 74 61 69 6e 20 41 67 67 72 65 67 61 74   Obtain Aggregat
369b0 65 20 46 75 6e 63 74 69 6f 6e 20 43 6f 6e 74 65  e Function Conte
369c0 78 74 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71  xt.** METHOD: sq
369d0 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 0a 2a 2a  lite3_context.**
369e0 0a 2a 2a 20 49 6d 70 6c 65 6d 65 6e 74 61 74 69  .** Implementati
369f0 6f 6e 73 20 6f 66 20 61 67 67 72 65 67 61 74 65  ons of aggregate
36a00 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 73 20 75   SQL functions u
36a10 73 65 20 74 68 69 73 0a 2a 2a 20 72 6f 75 74 69  se this.** routi
36a20 6e 65 20 74 6f 20 61 6c 6c 6f 63 61 74 65 20 6d  ne to allocate m
36a30 65 6d 6f 72 79 20 66 6f 72 20 73 74 6f 72 69 6e  emory for storin
36a40 67 20 74 68 65 69 72 20 73 74 61 74 65 2e 0a 2a  g their state..*
36a50 2a 0a 2a 2a 20 5e 54 68 65 20 66 69 72 73 74 20  *.** ^The first 
36a60 74 69 6d 65 20 74 68 65 20 73 71 6c 69 74 65 33  time the sqlite3
36a70 5f 61 67 67 72 65 67 61 74 65 5f 63 6f 6e 74 65  _aggregate_conte
36a80 78 74 28 43 2c 4e 29 20 72 6f 75 74 69 6e 65 20  xt(C,N) routine 
36a90 69 73 20 63 61 6c 6c 65 64 20 0a 2a 2a 20 66 6f  is called .** fo
36aa0 72 20 61 20 70 61 72 74 69 63 75 6c 61 72 20 61  r a particular a
36ab0 67 67 72 65 67 61 74 65 20 66 75 6e 63 74 69 6f  ggregate functio
36ac0 6e 2c 20 53 51 4c 69 74 65 0a 2a 2a 20 61 6c 6c  n, SQLite.** all
36ad0 6f 63 61 74 65 73 20 4e 20 6f 66 20 6d 65 6d 6f  ocates N of memo
36ae0 72 79 2c 20 7a 65 72 6f 65 73 20 6f 75 74 20 74  ry, zeroes out t
36af0 68 61 74 20 6d 65 6d 6f 72 79 2c 20 61 6e 64 20  hat memory, and 
36b00 72 65 74 75 72 6e 73 20 61 20 70 6f 69 6e 74 65  returns a pointe
36b10 72 0a 2a 2a 20 74 6f 20 74 68 65 20 6e 65 77 20  r.** to the new 
36b20 6d 65 6d 6f 72 79 2e 20 5e 4f 6e 20 73 65 63 6f  memory. ^On seco
36b30 6e 64 20 61 6e 64 20 73 75 62 73 65 71 75 65 6e  nd and subsequen
36b40 74 20 63 61 6c 6c 73 20 74 6f 0a 2a 2a 20 73 71  t calls to.** sq
36b50 6c 69 74 65 33 5f 61 67 67 72 65 67 61 74 65 5f  lite3_aggregate_
36b60 63 6f 6e 74 65 78 74 28 29 20 66 6f 72 20 74 68  context() for th
36b70 65 20 73 61 6d 65 20 61 67 67 72 65 67 61 74 65  e same aggregate
36b80 20 66 75 6e 63 74 69 6f 6e 20 69 6e 73 74 61 6e   function instan
36b90 63 65 2c 0a 2a 2a 20 74 68 65 20 73 61 6d 65 20  ce,.** the same 
36ba0 62 75 66 66 65 72 20 69 73 20 72 65 74 75 72 6e  buffer is return
36bb0 65 64 2e 20 20 53 71 6c 69 74 65 33 5f 61 67 67  ed.  Sqlite3_agg
36bc0 72 65 67 61 74 65 5f 63 6f 6e 74 65 78 74 28 29  regate_context()
36bd0 20 69 73 20 6e 6f 72 6d 61 6c 6c 79 0a 2a 2a 20   is normally.** 
36be0 63 61 6c 6c 65 64 20 6f 6e 63 65 20 66 6f 72 20  called once for 
36bf0 65 61 63 68 20 69 6e 76 6f 63 61 74 69 6f 6e 20  each invocation 
36c00 6f 66 20 74 68 65 20 78 53 74 65 70 20 63 61 6c  of the xStep cal
36c10 6c 62 61 63 6b 20 61 6e 64 20 74 68 65 6e 20 6f  lback and then o
36c20 6e 65 0a 2a 2a 20 6c 61 73 74 20 74 69 6d 65 20  ne.** last time 
36c30 77 68 65 6e 20 74 68 65 20 78 46 69 6e 61 6c 20  when the xFinal 
36c40 63 61 6c 6c 62 61 63 6b 20 69 73 20 69 6e 76 6f  callback is invo
36c50 6b 65 64 2e 20 20 5e 28 57 68 65 6e 20 6e 6f 20  ked.  ^(When no 
36c60 72 6f 77 73 20 6d 61 74 63 68 0a 2a 2a 20 61 6e  rows match.** an
36c70 20 61 67 67 72 65 67 61 74 65 20 71 75 65 72 79   aggregate query
36c80 2c 20 74 68 65 20 78 53 74 65 70 28 29 20 63 61  , the xStep() ca
36c90 6c 6c 62 61 63 6b 20 6f 66 20 74 68 65 20 61 67  llback of the ag
36ca0 67 72 65 67 61 74 65 20 66 75 6e 63 74 69 6f 6e  gregate function
36cb0 0a 2a 2a 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69  .** implementati
36cc0 6f 6e 20 69 73 20 6e 65 76 65 72 20 63 61 6c 6c  on is never call
36cd0 65 64 20 61 6e 64 20 78 46 69 6e 61 6c 28 29 20  ed and xFinal() 
36ce0 69 73 20 63 61 6c 6c 65 64 20 65 78 61 63 74 6c  is called exactl
36cf0 79 20 6f 6e 63 65 2e 0a 2a 2a 20 49 6e 20 74 68  y once..** In th
36d00 6f 73 65 20 63 61 73 65 73 2c 20 73 71 6c 69 74  ose cases, sqlit
36d10 65 33 5f 61 67 67 72 65 67 61 74 65 5f 63 6f 6e  e3_aggregate_con
36d20 74 65 78 74 28 29 20 6d 69 67 68 74 20 62 65 20  text() might be 
36d30 63 61 6c 6c 65 64 20 66 6f 72 20 74 68 65 0a 2a  called for the.*
36d40 2a 20 66 69 72 73 74 20 74 69 6d 65 20 66 72 6f  * first time fro
36d50 6d 20 77 69 74 68 69 6e 20 78 46 69 6e 61 6c 28  m within xFinal(
36d60 29 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  ).)^.**.** ^The 
36d70 73 71 6c 69 74 65 33 5f 61 67 67 72 65 67 61 74  sqlite3_aggregat
36d80 65 5f 63 6f 6e 74 65 78 74 28 43 2c 4e 29 20 72  e_context(C,N) r
36d90 6f 75 74 69 6e 65 20 72 65 74 75 72 6e 73 20 61  outine returns a
36da0 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 20 0a 2a   NULL pointer .*
36db0 2a 20 77 68 65 6e 20 66 69 72 73 74 20 63 61 6c  * when first cal
36dc0 6c 65 64 20 69 66 20 4e 20 69 73 20 6c 65 73 73  led if N is less
36dd0 20 74 68 61 6e 20 6f 72 20 65 71 75 61 6c 20 74   than or equal t
36de0 6f 20 7a 65 72 6f 20 6f 72 20 69 66 20 61 20 6d  o zero or if a m
36df0 65 6d 6f 72 79 0a 2a 2a 20 61 6c 6c 6f 63 61 74  emory.** allocat
36e00 65 20 65 72 72 6f 72 20 6f 63 63 75 72 73 2e 0a  e error occurs..
36e10 2a 2a 0a 2a 2a 20 5e 28 54 68 65 20 61 6d 6f 75  **.** ^(The amou
36e20 6e 74 20 6f 66 20 73 70 61 63 65 20 61 6c 6c 6f  nt of space allo
36e30 63 61 74 65 64 20 62 79 20 73 71 6c 69 74 65 33  cated by sqlite3
36e40 5f 61 67 67 72 65 67 61 74 65 5f 63 6f 6e 74 65  _aggregate_conte
36e50 78 74 28 43 2c 4e 29 20 69 73 0a 2a 2a 20 64 65  xt(C,N) is.** de
36e60 74 65 72 6d 69 6e 65 64 20 62 79 20 74 68 65 20  termined by the 
36e70 4e 20 70 61 72 61 6d 65 74 65 72 20 6f 6e 20 66  N parameter on f
36e80 69 72 73 74 20 73 75 63 63 65 73 73 66 75 6c 20  irst successful 
36e90 63 61 6c 6c 2e 20 20 43 68 61 6e 67 69 6e 67 20  call.  Changing 
36ea0 74 68 65 0a 2a 2a 20 76 61 6c 75 65 20 6f 66 20  the.** value of 
36eb0 4e 20 69 6e 20 73 75 62 73 65 71 75 65 6e 74 20  N in subsequent 
36ec0 63 61 6c 6c 20 74 6f 20 73 71 6c 69 74 65 33 5f  call to sqlite3_
36ed0 61 67 67 72 65 67 61 74 65 5f 63 6f 6e 74 65 78  aggregate_contex
36ee0 74 28 29 20 77 69 74 68 69 6e 0a 2a 2a 20 74 68  t() within.** th
36ef0 65 20 73 61 6d 65 20 61 67 67 72 65 67 61 74 65  e same aggregate
36f00 20 66 75 6e 63 74 69 6f 6e 20 69 6e 73 74 61 6e   function instan
36f10 63 65 20 77 69 6c 6c 20 6e 6f 74 20 72 65 73 69  ce will not resi
36f20 7a 65 20 74 68 65 20 6d 65 6d 6f 72 79 0a 2a 2a  ze the memory.**
36f30 20 61 6c 6c 6f 63 61 74 69 6f 6e 2e 29 5e 20 20   allocation.)^  
36f40 57 69 74 68 69 6e 20 74 68 65 20 78 46 69 6e 61  Within the xFina
36f50 6c 20 63 61 6c 6c 62 61 63 6b 2c 20 69 74 20 69  l callback, it i
36f60 73 20 63 75 73 74 6f 6d 61 72 79 20 74 6f 20 73  s customary to s
36f70 65 74 0a 2a 2a 20 4e 3d 30 20 69 6e 20 63 61 6c  et.** N=0 in cal
36f80 6c 73 20 74 6f 20 73 71 6c 69 74 65 33 5f 61 67  ls to sqlite3_ag
36f90 67 72 65 67 61 74 65 5f 63 6f 6e 74 65 78 74 28  gregate_context(
36fa0 43 2c 4e 29 20 73 6f 20 74 68 61 74 20 6e 6f 20  C,N) so that no 
36fb0 0a 2a 2a 20 70 6f 69 6e 74 6c 65 73 73 20 6d 65  .** pointless me
36fc0 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 73  mory allocations
36fd0 20 6f 63 63 75 72 2e 0a 2a 2a 0a 2a 2a 20 5e 53   occur..**.** ^S
36fe0 51 4c 69 74 65 20 61 75 74 6f 6d 61 74 69 63 61  QLite automatica
36ff0 6c 6c 79 20 66 72 65 65 73 20 74 68 65 20 6d 65  lly frees the me
37000 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 65 64 20 62  mory allocated b
37010 79 20 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 61 67  y .** sqlite3_ag
37020 67 72 65 67 61 74 65 5f 63 6f 6e 74 65 78 74 28  gregate_context(
37030 29 20 77 68 65 6e 20 74 68 65 20 61 67 67 72 65  ) when the aggre
37040 67 61 74 65 20 71 75 65 72 79 20 63 6f 6e 63 6c  gate query concl
37050 75 64 65 73 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20  udes..**.** The 
37060 66 69 72 73 74 20 70 61 72 61 6d 65 74 65 72 20  first parameter 
37070 6d 75 73 74 20 62 65 20 61 20 63 6f 70 79 20 6f  must be a copy o
37080 66 20 74 68 65 0a 2a 2a 20 5b 73 71 6c 69 74 65  f the.** [sqlite
37090 33 5f 63 6f 6e 74 65 78 74 20 7c 20 53 51 4c 20  3_context | SQL 
370a0 66 75 6e 63 74 69 6f 6e 20 63 6f 6e 74 65 78 74  function context
370b0 5d 20 74 68 61 74 20 69 73 20 74 68 65 20 66 69  ] that is the fi
370c0 72 73 74 20 70 61 72 61 6d 65 74 65 72 0a 2a 2a  rst parameter.**
370d0 20 74 6f 20 74 68 65 20 78 53 74 65 70 20 6f 72   to the xStep or
370e0 20 78 46 69 6e 61 6c 20 63 61 6c 6c 62 61 63 6b   xFinal callback
370f0 20 72 6f 75 74 69 6e 65 20 74 68 61 74 20 69 6d   routine that im
37100 70 6c 65 6d 65 6e 74 73 20 74 68 65 20 61 67 67  plements the agg
37110 72 65 67 61 74 65 0a 2a 2a 20 66 75 6e 63 74 69  regate.** functi
37120 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 54 68 69 73 20 72  on..**.** This r
37130 6f 75 74 69 6e 65 20 6d 75 73 74 20 62 65 20 63  outine must be c
37140 61 6c 6c 65 64 20 66 72 6f 6d 20 74 68 65 20 73  alled from the s
37150 61 6d 65 20 74 68 72 65 61 64 20 69 6e 20 77 68  ame thread in wh
37160 69 63 68 0a 2a 2a 20 74 68 65 20 61 67 67 72 65  ich.** the aggre
37170 67 61 74 65 20 53 51 4c 20 66 75 6e 63 74 69 6f  gate SQL functio
37180 6e 20 69 73 20 72 75 6e 6e 69 6e 67 2e 0a 2a 2f  n is running..*/
37190 0a 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f 61  .void *sqlite3_a
371a0 67 67 72 65 67 61 74 65 5f 63 6f 6e 74 65 78 74  ggregate_context
371b0 28 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74  (sqlite3_context
371c0 2a 2c 20 69 6e 74 20 6e 42 79 74 65 73 29 3b 0a  *, int nBytes);.
371d0 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
371e0 20 55 73 65 72 20 44 61 74 61 20 46 6f 72 20 46   User Data For F
371f0 75 6e 63 74 69 6f 6e 73 0a 2a 2a 20 4d 45 54 48  unctions.** METH
37200 4f 44 3a 20 73 71 6c 69 74 65 33 5f 63 6f 6e 74  OD: sqlite3_cont
37210 65 78 74 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73  ext.**.** ^The s
37220 71 6c 69 74 65 33 5f 75 73 65 72 5f 64 61 74 61  qlite3_user_data
37230 28 29 20 69 6e 74 65 72 66 61 63 65 20 72 65 74  () interface ret
37240 75 72 6e 73 20 61 20 63 6f 70 79 20 6f 66 0a 2a  urns a copy of.*
37250 2a 20 74 68 65 20 70 6f 69 6e 74 65 72 20 74 68  * the pointer th
37260 61 74 20 77 61 73 20 74 68 65 20 70 55 73 65 72  at was the pUser
37270 44 61 74 61 20 70 61 72 61 6d 65 74 65 72 20 28  Data parameter (
37280 74 68 65 20 35 74 68 20 70 61 72 61 6d 65 74 65  the 5th paramete
37290 72 29 0a 2a 2a 20 6f 66 20 74 68 65 20 5b 73 71  r).** of the [sq
372a0 6c 69 74 65 33 5f 63 72 65 61 74 65 5f 66 75 6e  lite3_create_fun
372b0 63 74 69 6f 6e 28 29 5d 0a 2a 2a 20 61 6e 64 20  ction()].** and 
372c0 5b 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65 5f  [sqlite3_create_
372d0 66 75 6e 63 74 69 6f 6e 31 36 28 29 5d 20 72 6f  function16()] ro
372e0 75 74 69 6e 65 73 20 74 68 61 74 20 6f 72 69 67  utines that orig
372f0 69 6e 61 6c 6c 79 0a 2a 2a 20 72 65 67 69 73 74  inally.** regist
37300 65 72 65 64 20 74 68 65 20 61 70 70 6c 69 63 61  ered the applica
37310 74 69 6f 6e 20 64 65 66 69 6e 65 64 20 66 75 6e  tion defined fun
37320 63 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 54 68 69  ction..**.** Thi
37330 73 20 72 6f 75 74 69 6e 65 20 6d 75 73 74 20 62  s routine must b
37340 65 20 63 61 6c 6c 65 64 20 66 72 6f 6d 20 74 68  e called from th
37350 65 20 73 61 6d 65 20 74 68 72 65 61 64 20 69 6e  e same thread in
37360 20 77 68 69 63 68 0a 2a 2a 20 74 68 65 20 61 70   which.** the ap
37370 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65  plication-define
37380 64 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 72 75  d function is ru
37390 6e 6e 69 6e 67 2e 0a 2a 2f 0a 76 6f 69 64 20 2a  nning..*/.void *
373a0 73 71 6c 69 74 65 33 5f 75 73 65 72 5f 64 61 74  sqlite3_user_dat
373b0 61 28 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78  a(sqlite3_contex
373c0 74 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49  t*);../*.** CAPI
373d0 33 52 45 46 3a 20 44 61 74 61 62 61 73 65 20 43  3REF: Database C
373e0 6f 6e 6e 65 63 74 69 6f 6e 20 46 6f 72 20 46 75  onnection For Fu
373f0 6e 63 74 69 6f 6e 73 0a 2a 2a 20 4d 45 54 48 4f  nctions.** METHO
37400 44 3a 20 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65  D: sqlite3_conte
37410 78 74 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71  xt.**.** ^The sq
37420 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 5f 64 62  lite3_context_db
37430 5f 68 61 6e 64 6c 65 28 29 20 69 6e 74 65 72 66  _handle() interf
37440 61 63 65 20 72 65 74 75 72 6e 73 20 61 20 63 6f  ace returns a co
37450 70 79 20 6f 66 0a 2a 2a 20 74 68 65 20 70 6f 69  py of.** the poi
37460 6e 74 65 72 20 74 6f 20 74 68 65 20 5b 64 61 74  nter to the [dat
37470 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
37480 5d 20 28 74 68 65 20 31 73 74 20 70 61 72 61 6d  ] (the 1st param
37490 65 74 65 72 29 0a 2a 2a 20 6f 66 20 74 68 65 20  eter).** of the 
374a0 5b 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65 5f  [sqlite3_create_
374b0 66 75 6e 63 74 69 6f 6e 28 29 5d 0a 2a 2a 20 61  function()].** a
374c0 6e 64 20 5b 73 71 6c 69 74 65 33 5f 63 72 65 61  nd [sqlite3_crea
374d0 74 65 5f 66 75 6e 63 74 69 6f 6e 31 36 28 29 5d  te_function16()]
374e0 20 72 6f 75 74 69 6e 65 73 20 74 68 61 74 20 6f   routines that o
374f0 72 69 67 69 6e 61 6c 6c 79 0a 2a 2a 20 72 65 67  riginally.** reg
37500 69 73 74 65 72 65 64 20 74 68 65 20 61 70 70 6c  istered the appl
37510 69 63 61 74 69 6f 6e 20 64 65 66 69 6e 65 64 20  ication defined 
37520 66 75 6e 63 74 69 6f 6e 2e 0a 2a 2f 0a 73 71 6c  function..*/.sql
37530 69 74 65 33 20 2a 73 71 6c 69 74 65 33 5f 63 6f  ite3 *sqlite3_co
37540 6e 74 65 78 74 5f 64 62 5f 68 61 6e 64 6c 65 28  ntext_db_handle(
37550 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a  sqlite3_context*
37560 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  );../*.** CAPI3R
37570 45 46 3a 20 46 75 6e 63 74 69 6f 6e 20 41 75 78  EF: Function Aux
37580 69 6c 69 61 72 79 20 44 61 74 61 0a 2a 2a 20 4d  iliary Data.** M
37590 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 5f 63  ETHOD: sqlite3_c
375a0 6f 6e 74 65 78 74 0a 2a 2a 0a 2a 2a 20 54 68 65  ontext.**.** The
375b0 73 65 20 66 75 6e 63 74 69 6f 6e 73 20 6d 61 79  se functions may
375c0 20 62 65 20 75 73 65 64 20 62 79 20 28 6e 6f 6e   be used by (non
375d0 2d 61 67 67 72 65 67 61 74 65 29 20 53 51 4c 20  -aggregate) SQL 
375e0 66 75 6e 63 74 69 6f 6e 73 20 74 6f 0a 2a 2a 20  functions to.** 
375f0 61 73 73 6f 63 69 61 74 65 20 6d 65 74 61 64 61  associate metada
37600 74 61 20 77 69 74 68 20 61 72 67 75 6d 65 6e 74  ta with argument
37610 20 76 61 6c 75 65 73 2e 20 49 66 20 74 68 65 20   values. If the 
37620 73 61 6d 65 20 76 61 6c 75 65 20 69 73 20 70 61  same value is pa
37630 73 73 65 64 20 74 6f 0a 2a 2a 20 6d 75 6c 74 69  ssed to.** multi
37640 70 6c 65 20 69 6e 76 6f 63 61 74 69 6f 6e 73 20  ple invocations 
37650 6f 66 20 74 68 65 20 73 61 6d 65 20 53 51 4c 20  of the same SQL 
37660 66 75 6e 63 74 69 6f 6e 20 64 75 72 69 6e 67 20  function during 
37670 71 75 65 72 79 20 65 78 65 63 75 74 69 6f 6e 2c  query execution,
37680 20 75 6e 64 65 72 0a 2a 2a 20 73 6f 6d 65 20 63   under.** some c
37690 69 72 63 75 6d 73 74 61 6e 63 65 73 20 74 68 65  ircumstances the
376a0 20 61 73 73 6f 63 69 61 74 65 64 20 6d 65 74 61   associated meta
376b0 64 61 74 61 20 6d 61 79 20 62 65 20 70 72 65 73  data may be pres
376c0 65 72 76 65 64 2e 20 20 41 6e 20 65 78 61 6d 70  erved.  An examp
376d0 6c 65 0a 2a 2a 20 6f 66 20 77 68 65 72 65 20 74  le.** of where t
376e0 68 69 73 20 6d 69 67 68 74 20 62 65 20 75 73 65  his might be use
376f0 66 75 6c 20 69 73 20 69 6e 20 61 20 72 65 67 75  ful is in a regu
37700 6c 61 72 2d 65 78 70 72 65 73 73 69 6f 6e 20 6d  lar-expression m
37710 61 74 63 68 69 6e 67 0a 2a 2a 20 66 75 6e 63 74  atching.** funct
37720 69 6f 6e 2e 20 54 68 65 20 63 6f 6d 70 69 6c 65  ion. The compile
37730 64 20 76 65 72 73 69 6f 6e 20 6f 66 20 74 68 65  d version of the
37740 20 72 65 67 75 6c 61 72 20 65 78 70 72 65 73 73   regular express
37750 69 6f 6e 20 63 61 6e 20 62 65 20 73 74 6f 72 65  ion can be store
37760 64 20 61 73 0a 2a 2a 20 6d 65 74 61 64 61 74 61  d as.** metadata
37770 20 61 73 73 6f 63 69 61 74 65 64 20 77 69 74 68   associated with
37780 20 74 68 65 20 70 61 74 74 65 72 6e 20 73 74 72   the pattern str
37790 69 6e 67 2e 20 20 0a 2a 2a 20 54 68 65 6e 20 61  ing.  .** Then a
377a0 73 20 6c 6f 6e 67 20 61 73 20 74 68 65 20 70 61  s long as the pa
377b0 74 74 65 72 6e 20 73 74 72 69 6e 67 20 72 65 6d  ttern string rem
377c0 61 69 6e 73 20 74 68 65 20 73 61 6d 65 2c 0a 2a  ains the same,.*
377d0 2a 20 74 68 65 20 63 6f 6d 70 69 6c 65 64 20 72  * the compiled r
377e0 65 67 75 6c 61 72 20 65 78 70 72 65 73 73 69 6f  egular expressio
377f0 6e 20 63 61 6e 20 62 65 20 72 65 75 73 65 64 20  n can be reused 
37800 6f 6e 20 6d 75 6c 74 69 70 6c 65 0a 2a 2a 20 69  on multiple.** i
37810 6e 76 6f 63 61 74 69 6f 6e 73 20 6f 66 20 74 68  nvocations of th
37820 65 20 73 61 6d 65 20 66 75 6e 63 74 69 6f 6e 2e  e same function.
37830 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69  .**.** ^The sqli
37840 74 65 33 5f 67 65 74 5f 61 75 78 64 61 74 61 28  te3_get_auxdata(
37850 29 20 69 6e 74 65 72 66 61 63 65 20 72 65 74 75  ) interface retu
37860 72 6e 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f  rns a pointer to
37870 20 74 68 65 20 6d 65 74 61 64 61 74 61 0a 2a 2a   the metadata.**
37880 20 61 73 73 6f 63 69 61 74 65 64 20 62 79 20 74   associated by t
37890 68 65 20 73 71 6c 69 74 65 33 5f 73 65 74 5f 61  he sqlite3_set_a
378a0 75 78 64 61 74 61 28 29 20 66 75 6e 63 74 69 6f  uxdata() functio
378b0 6e 20 77 69 74 68 20 74 68 65 20 4e 74 68 20 61  n with the Nth a
378c0 72 67 75 6d 65 6e 74 0a 2a 2a 20 76 61 6c 75 65  rgument.** value
378d0 20 74 6f 20 74 68 65 20 61 70 70 6c 69 63 61 74   to the applicat
378e0 69 6f 6e 2d 64 65 66 69 6e 65 64 20 66 75 6e 63  ion-defined func
378f0 74 69 6f 6e 2e 20 5e 49 66 20 74 68 65 72 65 20  tion. ^If there 
37900 69 73 20 6e 6f 20 6d 65 74 61 64 61 74 61 0a 2a  is no metadata.*
37910 2a 20 61 73 73 6f 63 69 61 74 65 64 20 77 69 74  * associated wit
37920 68 20 74 68 65 20 66 75 6e 63 74 69 6f 6e 20 61  h the function a
37930 72 67 75 6d 65 6e 74 2c 20 74 68 69 73 20 73 71  rgument, this sq
37940 6c 69 74 65 33 5f 67 65 74 5f 61 75 78 64 61 74  lite3_get_auxdat
37950 61 28 29 20 69 6e 74 65 72 66 61 63 65 0a 2a 2a  a() interface.**
37960 20 72 65 74 75 72 6e 73 20 61 20 4e 55 4c 4c 20   returns a NULL 
37970 70 6f 69 6e 74 65 72 2e 0a 2a 2a 0a 2a 2a 20 5e  pointer..**.** ^
37980 54 68 65 20 73 71 6c 69 74 65 33 5f 73 65 74 5f  The sqlite3_set_
37990 61 75 78 64 61 74 61 28 43 2c 4e 2c 50 2c 58 29  auxdata(C,N,P,X)
379a0 20 69 6e 74 65 72 66 61 63 65 20 73 61 76 65 73   interface saves
379b0 20 50 20 61 73 20 6d 65 74 61 64 61 74 61 20 66   P as metadata f
379c0 6f 72 20 74 68 65 20 4e 2d 74 68 0a 2a 2a 20 61  or the N-th.** a
379d0 72 67 75 6d 65 6e 74 20 6f 66 20 74 68 65 20 61  rgument of the a
379e0 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e  pplication-defin
379f0 65 64 20 66 75 6e 63 74 69 6f 6e 2e 20 20 5e 53  ed function.  ^S
37a00 75 62 73 65 71 75 65 6e 74 0a 2a 2a 20 63 61 6c  ubsequent.** cal
37a10 6c 73 20 74 6f 20 73 71 6c 69 74 65 33 5f 67 65  ls to sqlite3_ge
37a20 74 5f 61 75 78 64 61 74 61 28 43 2c 4e 29 20 72  t_auxdata(C,N) r
37a30 65 74 75 72 6e 20 50 20 66 72 6f 6d 20 74 68 65  eturn P from the
37a40 20 6d 6f 73 74 20 72 65 63 65 6e 74 0a 2a 2a 20   most recent.** 
37a50 73 71 6c 69 74 65 33 5f 73 65 74 5f 61 75 78 64  sqlite3_set_auxd
37a60 61 74 61 28 43 2c 4e 2c 50 2c 58 29 20 63 61 6c  ata(C,N,P,X) cal
37a70 6c 20 69 66 20 74 68 65 20 6d 65 74 61 64 61 74  l if the metadat
37a80 61 20 69 73 20 73 74 69 6c 6c 20 76 61 6c 69 64  a is still valid
37a90 20 6f 72 0a 2a 2a 20 4e 55 4c 4c 20 69 66 20 74   or.** NULL if t
37aa0 68 65 20 6d 65 74 61 64 61 74 61 20 68 61 73 20  he metadata has 
37ab0 62 65 65 6e 20 64 69 73 63 61 72 64 65 64 2e 0a  been discarded..
37ac0 2a 2a 20 5e 41 66 74 65 72 20 65 61 63 68 20 63  ** ^After each c
37ad0 61 6c 6c 20 74 6f 20 73 71 6c 69 74 65 33 5f 73  all to sqlite3_s
37ae0 65 74 5f 61 75 78 64 61 74 61 28 43 2c 4e 2c 50  et_auxdata(C,N,P
37af0 2c 58 29 20 77 68 65 72 65 20 58 20 69 73 20 6e  ,X) where X is n
37b00 6f 74 20 4e 55 4c 4c 2c 0a 2a 2a 20 53 51 4c 69  ot NULL,.** SQLi
37b10 74 65 20 77 69 6c 6c 20 69 6e 76 6f 6b 65 20 74  te will invoke t
37b20 68 65 20 64 65 73 74 72 75 63 74 6f 72 20 66 75  he destructor fu
37b30 6e 63 74 69 6f 6e 20 58 20 77 69 74 68 20 70 61  nction X with pa
37b40 72 61 6d 65 74 65 72 20 50 20 65 78 61 63 74 6c  rameter P exactl
37b50 79 0a 2a 2a 20 6f 6e 63 65 2c 20 77 68 65 6e 20  y.** once, when 
37b60 74 68 65 20 6d 65 74 61 64 61 74 61 20 69 73 20  the metadata is 
37b70 64 69 73 63 61 72 64 65 64 2e 0a 2a 2a 20 53 51  discarded..** SQ
37b80 4c 69 74 65 20 69 73 20 66 72 65 65 20 74 6f 20  Lite is free to 
37b90 64 69 73 63 61 72 64 20 74 68 65 20 6d 65 74 61  discard the meta
37ba0 64 61 74 61 20 61 74 20 61 6e 79 20 74 69 6d 65  data at any time
37bb0 2c 20 69 6e 63 6c 75 64 69 6e 67 3a 20 3c 75 6c  , including: <ul
37bc0 3e 0a 2a 2a 20 3c 6c 69 3e 20 77 68 65 6e 20 74  >.** <li> when t
37bd0 68 65 20 63 6f 72 72 65 73 70 6f 6e 64 69 6e 67  he corresponding
37be0 20 66 75 6e 63 74 69 6f 6e 20 70 61 72 61 6d 65   function parame
37bf0 74 65 72 20 63 68 61 6e 67 65 73 2c 20 6f 72 0a  ter changes, or.
37c00 2a 2a 20 3c 6c 69 3e 20 77 68 65 6e 20 5b 73 71  ** <li> when [sq
37c10 6c 69 74 65 33 5f 72 65 73 65 74 28 29 5d 20 6f  lite3_reset()] o
37c20 72 20 5b 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c  r [sqlite3_final
37c30 69 7a 65 28 29 5d 20 69 73 20 63 61 6c 6c 65 64  ize()] is called
37c40 20 66 6f 72 20 74 68 65 0a 2a 2a 20 20 20 20 20   for the.**     
37c50 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 2c 20   SQL statement, 
37c60 6f 72 0a 2a 2a 20 3c 6c 69 3e 20 77 68 65 6e 20  or.** <li> when 
37c70 73 71 6c 69 74 65 33 5f 73 65 74 5f 61 75 78 64  sqlite3_set_auxd
37c80 61 74 61 28 29 20 69 73 20 69 6e 76 6f 6b 65 64  ata() is invoked
37c90 20 61 67 61 69 6e 20 6f 6e 20 74 68 65 20 73 61   again on the sa
37ca0 6d 65 20 70 61 72 61 6d 65 74 65 72 2c 20 6f 72  me parameter, or
37cb0 0a 2a 2a 20 3c 6c 69 3e 20 64 75 72 69 6e 67 20  .** <li> during 
37cc0 74 68 65 20 6f 72 69 67 69 6e 61 6c 20 73 71 6c  the original sql
37cd0 69 74 65 33 5f 73 65 74 5f 61 75 78 64 61 74 61  ite3_set_auxdata
37ce0 28 29 20 63 61 6c 6c 20 77 68 65 6e 20 61 20 6d  () call when a m
37cf0 65 6d 6f 72 79 20 0a 2a 2a 20 20 20 20 20 20 61  emory .**      a
37d00 6c 6c 6f 63 61 74 69 6f 6e 20 65 72 72 6f 72 20  llocation error 
37d10 6f 63 63 75 72 73 2e 20 3c 2f 75 6c 3e 29 5e 0a  occurs. </ul>)^.
37d20 2a 2a 0a 2a 2a 20 4e 6f 74 65 20 74 68 65 20 6c  **.** Note the l
37d30 61 73 74 20 62 75 6c 6c 65 74 20 69 6e 20 70 61  ast bullet in pa
37d40 72 74 69 63 75 6c 61 72 2e 20 20 54 68 65 20 64  rticular.  The d
37d50 65 73 74 72 75 63 74 6f 72 20 58 20 69 6e 20 0a  estructor X in .
37d60 2a 2a 20 73 71 6c 69 74 65 33 5f 73 65 74 5f 61  ** sqlite3_set_a
37d70 75 78 64 61 74 61 28 43 2c 4e 2c 50 2c 58 29 20  uxdata(C,N,P,X) 
37d80 6d 69 67 68 74 20 62 65 20 63 61 6c 6c 65 64 20  might be called 
37d90 69 6d 6d 65 64 69 61 74 65 6c 79 2c 20 62 65 66  immediately, bef
37da0 6f 72 65 20 74 68 65 0a 2a 2a 20 73 71 6c 69 74  ore the.** sqlit
37db0 65 33 5f 73 65 74 5f 61 75 78 64 61 74 61 28 29  e3_set_auxdata()
37dc0 20 69 6e 74 65 72 66 61 63 65 20 65 76 65 6e 20   interface even 
37dd0 72 65 74 75 72 6e 73 2e 20 20 48 65 6e 63 65 20  returns.  Hence 
37de0 73 71 6c 69 74 65 33 5f 73 65 74 5f 61 75 78 64  sqlite3_set_auxd
37df0 61 74 61 28 29 0a 2a 2a 20 73 68 6f 75 6c 64 20  ata().** should 
37e00 62 65 20 63 61 6c 6c 65 64 20 6e 65 61 72 20 74  be called near t
37e10 68 65 20 65 6e 64 20 6f 66 20 74 68 65 20 66 75  he end of the fu
37e20 6e 63 74 69 6f 6e 20 69 6d 70 6c 65 6d 65 6e 74  nction implement
37e30 61 74 69 6f 6e 20 61 6e 64 20 74 68 65 0a 2a 2a  ation and the.**
37e40 20 66 75 6e 63 74 69 6f 6e 20 69 6d 70 6c 65 6d   function implem
37e50 65 6e 74 61 74 69 6f 6e 20 73 68 6f 75 6c 64 20  entation should 
37e60 6e 6f 74 20 6d 61 6b 65 20 61 6e 79 20 75 73 65  not make any use
37e70 20 6f 66 20 50 20 61 66 74 65 72 0a 2a 2a 20 73   of P after.** s
37e80 71 6c 69 74 65 33 5f 73 65 74 5f 61 75 78 64 61  qlite3_set_auxda
37e90 74 61 28 29 20 68 61 73 20 62 65 65 6e 20 63 61  ta() has been ca
37ea0 6c 6c 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 28 49 6e  lled..**.** ^(In
37eb0 20 70 72 61 63 74 69 63 65 2c 20 6d 65 74 61 64   practice, metad
37ec0 61 74 61 20 69 73 20 70 72 65 73 65 72 76 65 64  ata is preserved
37ed0 20 62 65 74 77 65 65 6e 20 66 75 6e 63 74 69 6f   between functio
37ee0 6e 20 63 61 6c 6c 73 20 66 6f 72 0a 2a 2a 20 66  n calls for.** f
37ef0 75 6e 63 74 69 6f 6e 20 70 61 72 61 6d 65 74 65  unction paramete
37f00 72 73 20 74 68 61 74 20 61 72 65 20 63 6f 6d 70  rs that are comp
37f10 69 6c 65 2d 74 69 6d 65 20 63 6f 6e 73 74 61 6e  ile-time constan
37f20 74 73 2c 20 69 6e 63 6c 75 64 69 6e 67 20 6c 69  ts, including li
37f30 74 65 72 61 6c 0a 2a 2a 20 76 61 6c 75 65 73 20  teral.** values 
37f40 61 6e 64 20 5b 70 61 72 61 6d 65 74 65 72 73 5d  and [parameters]
37f50 20 61 6e 64 20 65 78 70 72 65 73 73 69 6f 6e 73   and expressions
37f60 20 63 6f 6d 70 6f 73 65 64 20 66 72 6f 6d 20 74   composed from t
37f70 68 65 20 73 61 6d 65 2e 29 5e 0a 2a 2a 0a 2a 2a  he same.)^.**.**
37f80 20 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20   These routines 
37f90 6d 75 73 74 20 62 65 20 63 61 6c 6c 65 64 20 66  must be called f
37fa0 72 6f 6d 20 74 68 65 20 73 61 6d 65 20 74 68 72  rom the same thr
37fb0 65 61 64 20 69 6e 20 77 68 69 63 68 0a 2a 2a 20  ead in which.** 
37fc0 74 68 65 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e  the SQL function
37fd0 20 69 73 20 72 75 6e 6e 69 6e 67 2e 0a 2a 2f 0a   is running..*/.
37fe0 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f 67 65  void *sqlite3_ge
37ff0 74 5f 61 75 78 64 61 74 61 28 73 71 6c 69 74 65  t_auxdata(sqlite
38000 33 5f 63 6f 6e 74 65 78 74 2a 2c 20 69 6e 74 20  3_context*, int 
38010 4e 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33  N);.void sqlite3
38020 5f 73 65 74 5f 61 75 78 64 61 74 61 28 73 71 6c  _set_auxdata(sql
38030 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a 2c 20 69  ite3_context*, i
38040 6e 74 20 4e 2c 20 76 6f 69 64 2a 2c 20 76 6f 69  nt N, void*, voi
38050 64 20 28 2a 29 28 76 6f 69 64 2a 29 29 3b 0a 0a  d (*)(void*));..
38060 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
38070 20 43 6f 6e 73 74 61 6e 74 73 20 44 65 66 69 6e   Constants Defin
38080 69 6e 67 20 53 70 65 63 69 61 6c 20 44 65 73 74  ing Special Dest
38090 72 75 63 74 6f 72 20 42 65 68 61 76 69 6f 72 0a  ructor Behavior.
380a0 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 61 72 65 20  **.** These are 
380b0 73 70 65 63 69 61 6c 20 76 61 6c 75 65 73 20 66  special values f
380c0 6f 72 20 74 68 65 20 64 65 73 74 72 75 63 74 6f  or the destructo
380d0 72 20 74 68 61 74 20 69 73 20 70 61 73 73 65 64  r that is passed
380e0 20 69 6e 20 61 73 20 74 68 65 0a 2a 2a 20 66 69   in as the.** fi
380f0 6e 61 6c 20 61 72 67 75 6d 65 6e 74 20 74 6f 20  nal argument to 
38100 72 6f 75 74 69 6e 65 73 20 6c 69 6b 65 20 5b 73  routines like [s
38110 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 62 6c  qlite3_result_bl
38120 6f 62 28 29 5d 2e 20 20 5e 49 66 20 74 68 65 20  ob()].  ^If the 
38130 64 65 73 74 72 75 63 74 6f 72 0a 2a 2a 20 61 72  destructor.** ar
38140 67 75 6d 65 6e 74 20 69 73 20 53 51 4c 49 54 45  gument is SQLITE
38150 5f 53 54 41 54 49 43 2c 20 69 74 20 6d 65 61 6e  _STATIC, it mean
38160 73 20 74 68 61 74 20 74 68 65 20 63 6f 6e 74 65  s that the conte
38170 6e 74 20 70 6f 69 6e 74 65 72 20 69 73 20 63 6f  nt pointer is co
38180 6e 73 74 61 6e 74 0a 2a 2a 20 61 6e 64 20 77 69  nstant.** and wi
38190 6c 6c 20 6e 65 76 65 72 20 63 68 61 6e 67 65 2e  ll never change.
381a0 20 20 49 74 20 64 6f 65 73 20 6e 6f 74 20 6e 65    It does not ne
381b0 65 64 20 74 6f 20 62 65 20 64 65 73 74 72 6f 79  ed to be destroy
381c0 65 64 2e 20 20 5e 54 68 65 0a 2a 2a 20 53 51 4c  ed.  ^The.** SQL
381d0 49 54 45 5f 54 52 41 4e 53 49 45 4e 54 20 76 61  ITE_TRANSIENT va
381e0 6c 75 65 20 6d 65 61 6e 73 20 74 68 61 74 20 74  lue means that t
381f0 68 65 20 63 6f 6e 74 65 6e 74 20 77 69 6c 6c 20  he content will 
38200 6c 69 6b 65 6c 79 20 63 68 61 6e 67 65 20 69 6e  likely change in
38210 0a 2a 2a 20 74 68 65 20 6e 65 61 72 20 66 75 74  .** the near fut
38220 75 72 65 20 61 6e 64 20 74 68 61 74 20 53 51 4c  ure and that SQL
38230 69 74 65 20 73 68 6f 75 6c 64 20 6d 61 6b 65 20  ite should make 
38240 69 74 73 20 6f 77 6e 20 70 72 69 76 61 74 65 20  its own private 
38250 63 6f 70 79 20 6f 66 0a 2a 2a 20 74 68 65 20 63  copy of.** the c
38260 6f 6e 74 65 6e 74 20 62 65 66 6f 72 65 20 72 65  ontent before re
38270 74 75 72 6e 69 6e 67 2e 0a 2a 2a 0a 2a 2a 20 54  turning..**.** T
38280 68 65 20 74 79 70 65 64 65 66 20 69 73 20 6e 65  he typedef is ne
38290 63 65 73 73 61 72 79 20 74 6f 20 77 6f 72 6b 20  cessary to work 
382a0 61 72 6f 75 6e 64 20 70 72 6f 62 6c 65 6d 73 20  around problems 
382b0 69 6e 20 63 65 72 74 61 69 6e 0a 2a 2a 20 43 2b  in certain.** C+
382c0 2b 20 63 6f 6d 70 69 6c 65 72 73 2e 0a 2a 2f 0a  + compilers..*/.
382d0 74 79 70 65 64 65 66 20 76 6f 69 64 20 28 2a 73  typedef void (*s
382e0 71 6c 69 74 65 33 5f 64 65 73 74 72 75 63 74 6f  qlite3_destructo
382f0 72 5f 74 79 70 65 29 28 76 6f 69 64 2a 29 3b 0a  r_type)(void*);.
38300 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 53  #define SQLITE_S
38310 54 41 54 49 43 20 20 20 20 20 20 28 28 73 71 6c  TATIC      ((sql
38320 69 74 65 33 5f 64 65 73 74 72 75 63 74 6f 72 5f  ite3_destructor_
38330 74 79 70 65 29 30 29 0a 23 64 65 66 69 6e 65 20  type)0).#define 
38340 53 51 4c 49 54 45 5f 54 52 41 4e 53 49 45 4e 54  SQLITE_TRANSIENT
38350 20 20 20 28 28 73 71 6c 69 74 65 33 5f 64 65 73     ((sqlite3_des
38360 74 72 75 63 74 6f 72 5f 74 79 70 65 29 2d 31 29  tructor_type)-1)
38370 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46  ../*.** CAPI3REF
38380 3a 20 53 65 74 74 69 6e 67 20 54 68 65 20 52 65  : Setting The Re
38390 73 75 6c 74 20 4f 66 20 41 6e 20 53 51 4c 20 46  sult Of An SQL F
383a0 75 6e 63 74 69 6f 6e 0a 2a 2a 20 4d 45 54 48 4f  unction.** METHO
383b0 44 3a 20 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65  D: sqlite3_conte
383c0 78 74 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 72  xt.**.** These r
383d0 6f 75 74 69 6e 65 73 20 61 72 65 20 75 73 65 64  outines are used
383e0 20 62 79 20 74 68 65 20 78 46 75 6e 63 20 6f 72   by the xFunc or
383f0 20 78 46 69 6e 61 6c 20 63 61 6c 6c 62 61 63 6b   xFinal callback
38400 73 20 74 68 61 74 0a 2a 2a 20 69 6d 70 6c 65 6d  s that.** implem
38410 65 6e 74 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e  ent SQL function
38420 73 20 61 6e 64 20 61 67 67 72 65 67 61 74 65 73  s and aggregates
38430 2e 20 20 53 65 65 0a 2a 2a 20 5b 73 71 6c 69 74  .  See.** [sqlit
38440 65 33 5f 63 72 65 61 74 65 5f 66 75 6e 63 74 69  e3_create_functi
38450 6f 6e 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74  on()] and [sqlit
38460 65 33 5f 63 72 65 61 74 65 5f 66 75 6e 63 74 69  e3_create_functi
38470 6f 6e 31 36 28 29 5d 0a 2a 2a 20 66 6f 72 20 61  on16()].** for a
38480 64 64 69 74 69 6f 6e 61 6c 20 69 6e 66 6f 72 6d  dditional inform
38490 61 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 54 68 65  ation..**.** The
384a0 73 65 20 66 75 6e 63 74 69 6f 6e 73 20 77 6f 72  se functions wor
384b0 6b 20 76 65 72 79 20 6d 75 63 68 20 6c 69 6b 65  k very much like
384c0 20 74 68 65 20 5b 70 61 72 61 6d 65 74 65 72 20   the [parameter 
384d0 62 69 6e 64 69 6e 67 5d 20 66 61 6d 69 6c 79 20  binding] family 
384e0 6f 66 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 73 20  of.** functions 
384f0 75 73 65 64 20 74 6f 20 62 69 6e 64 20 76 61 6c  used to bind val
38500 75 65 73 20 74 6f 20 68 6f 73 74 20 70 61 72 61  ues to host para
38510 6d 65 74 65 72 73 20 69 6e 20 70 72 65 70 61 72  meters in prepar
38520 65 64 20 73 74 61 74 65 6d 65 6e 74 73 2e 0a 2a  ed statements..*
38530 2a 20 52 65 66 65 72 20 74 6f 20 74 68 65 20 5b  * Refer to the [
38540 53 51 4c 20 70 61 72 61 6d 65 74 65 72 5d 20 64  SQL parameter] d
38550 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 66 6f 72  ocumentation for
38560 20 61 64 64 69 74 69 6f 6e 61 6c 20 69 6e 66 6f   additional info
38570 72 6d 61 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 5e  rmation..**.** ^
38580 54 68 65 20 73 71 6c 69 74 65 33 5f 72 65 73 75  The sqlite3_resu
38590 6c 74 5f 62 6c 6f 62 28 29 20 69 6e 74 65 72 66  lt_blob() interf
385a0 61 63 65 20 73 65 74 73 20 74 68 65 20 72 65 73  ace sets the res
385b0 75 6c 74 20 66 72 6f 6d 0a 2a 2a 20 61 6e 20 61  ult from.** an a
385c0 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e  pplication-defin
385d0 65 64 20 66 75 6e 63 74 69 6f 6e 20 74 6f 20 62  ed function to b
385e0 65 20 74 68 65 20 42 4c 4f 42 20 77 68 6f 73 65  e the BLOB whose
385f0 20 63 6f 6e 74 65 6e 74 20 69 73 20 70 6f 69 6e   content is poin
38600 74 65 64 0a 2a 2a 20 74 6f 20 62 79 20 74 68 65  ted.** to by the
38610 20 73 65 63 6f 6e 64 20 70 61 72 61 6d 65 74 65   second paramete
38620 72 20 61 6e 64 20 77 68 69 63 68 20 69 73 20 4e  r and which is N
38630 20 62 79 74 65 73 20 6c 6f 6e 67 20 77 68 65 72   bytes long wher
38640 65 20 4e 20 69 73 20 74 68 65 0a 2a 2a 20 74 68  e N is the.** th
38650 69 72 64 20 70 61 72 61 6d 65 74 65 72 2e 0a 2a  ird parameter..*
38660 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65  *.** ^The sqlite
38670 33 5f 72 65 73 75 6c 74 5f 7a 65 72 6f 62 6c 6f  3_result_zeroblo
38680 62 28 43 2c 4e 29 20 61 6e 64 20 73 71 6c 69 74  b(C,N) and sqlit
38690 65 33 5f 72 65 73 75 6c 74 5f 7a 65 72 6f 62 6c  e3_result_zerobl
386a0 6f 62 36 34 28 43 2c 4e 29 0a 2a 2a 20 69 6e 74  ob64(C,N).** int
386b0 65 72 66 61 63 65 73 20 73 65 74 20 74 68 65 20  erfaces set the 
386c0 72 65 73 75 6c 74 20 6f 66 20 74 68 65 20 61 70  result of the ap
386d0 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65  plication-define
386e0 64 20 66 75 6e 63 74 69 6f 6e 20 74 6f 20 62 65  d function to be
386f0 0a 2a 2a 20 61 20 42 4c 4f 42 20 63 6f 6e 74 61  .** a BLOB conta
38700 69 6e 69 6e 67 20 61 6c 6c 20 7a 65 72 6f 20 62  ining all zero b
38710 79 74 65 73 20 61 6e 64 20 4e 20 62 79 74 65 73  ytes and N bytes
38720 20 69 6e 20 73 69 7a 65 2e 0a 2a 2a 0a 2a 2a 20   in size..**.** 
38730 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 72 65 73  ^The sqlite3_res
38740 75 6c 74 5f 64 6f 75 62 6c 65 28 29 20 69 6e 74  ult_double() int
38750 65 72 66 61 63 65 20 73 65 74 73 20 74 68 65 20  erface sets the 
38760 72 65 73 75 6c 74 20 66 72 6f 6d 0a 2a 2a 20 61  result from.** a
38770 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65  n application-de
38780 66 69 6e 65 64 20 66 75 6e 63 74 69 6f 6e 20 74  fined function t
38790 6f 20 62 65 20